diff --git a/docs/support-window.svg b/docs/support-window.svg index 47a1cef00ee36f..a18b27c5044ef3 100644 --- a/docs/support-window.svg +++ b/docs/support-window.svg @@ -2,4 +2,4 @@ #gh-dark-mode-only:target { color: #ffffff; } -2025202620275.45.55.65.75.85.95.45.55.65.75.85.92024-032024-062024-092024-112025-022025-072026-032026-062026-092026-112027-022027-07 \ No newline at end of file +2025202620275.55.65.75.85.95.55.65.75.85.92024-062024-092024-112025-022025-072026-062026-092026-112027-022027-07 \ No newline at end of file diff --git a/types/bpmn-moddle/.npmignore b/types/bpmn-moddle/.npmignore index 93e307400a5456..0238896503deda 100644 --- a/types/bpmn-moddle/.npmignore +++ b/types/bpmn-moddle/.npmignore @@ -3,3 +3,4 @@ !**/*.d.cts !**/*.d.mts !**/*.d.*.ts +/v9/ diff --git a/types/bpmn-moddle/bpmn-moddle-tests.ts b/types/bpmn-moddle/bpmn-moddle-tests.ts index 00d12a140973d6..469ddb72570d73 100644 --- a/types/bpmn-moddle/bpmn-moddle-tests.ts +++ b/types/bpmn-moddle/bpmn-moddle-tests.ts @@ -1,18 +1,18 @@ -import BPMNModdle from "bpmn-moddle"; +import { type BPMNModdle, BpmnModdle, type Definitions, type Moddle, type Process } from "bpmn-moddle"; -const moddle: BPMNModdle.Moddle = {} as any; +const moddle: Moddle = new BpmnModdle(); const element1 = moddle.create("bpmn:UserTask"); // Expect type User Task element1.$type = "bpmn:UserTask"; // Expect to check against type correctly -const bpmnModdle: BPMNModdle.BPMNModdle = {} as any; +const bpmnModdle: BPMNModdle = new BpmnModdle(); bpmnModdle.fromXML(""); -const definition: BPMNModdle.Definitions = {} as any; +const definition: Definitions = bpmnModdle.create("bpmn:Definitions"); // Expect type of process or undefined const maybeProcess = definition.rootElements.find(i => i.$type === "bpmn:Process"); // Expect process to have additional typings to base element1 -const process = maybeProcess as BPMNModdle.Process; +const process = maybeProcess as Process; diff --git a/types/bpmn-moddle/index.d.ts b/types/bpmn-moddle/index.d.ts index 21ce5f84191a7b..444989fbd73b0f 100644 --- a/types/bpmn-moddle/index.d.ts +++ b/types/bpmn-moddle/index.d.ts @@ -1,1046 +1,1073 @@ -/* eslint-disable @typescript-eslint/no-empty-interface */ -declare namespace BPMNModdle { - type AdHocOrdering = "Parallel" | "Sequential"; - type AssociationDirection = "None" | "One" | "Both"; - type ChoreographyLoopType = "None" | "Standard" | "MultiInstanceSequential" | "MultiInstanceParallel"; - type EventBasedGatewayType = "Parallel" | "Exclusive"; - type GatewayDirection = "Unspecified" | "Converging" | "Diverging" | "Mixed"; - type ItemKind = "Physical" | "Information"; - type MultiInstanceBehavior = "None" | "One" | "All" | "Complex"; - type RelationshipDirection = "None" | "Forward" | "Backward" | "Both"; - type ParticipantBandKind = - | "top_initiating" - | "middle_initiating" - | "bottom_initiating" - | "top_non_initiating" - | "middle_ non_initiating" - | "bottom_ non_initiating"; +export type AdHocOrdering = "Parallel" | "Sequential"; +export type AssociationDirection = "None" | "One" | "Both"; +export type ChoreographyLoopType = "None" | "Standard" | "MultiInstanceSequential" | "MultiInstanceParallel"; +export type EventBasedGatewayType = "Parallel" | "Exclusive"; +export type GatewayDirection = "Unspecified" | "Converging" | "Diverging" | "Mixed"; +export type ItemKind = "Physical" | "Information"; +export type MultiInstanceBehavior = "None" | "One" | "All" | "Complex"; +export type RelationshipDirection = "None" | "Forward" | "Backward" | "Both"; +export type ParticipantBandKind = + | "top_initiating" + | "middle_initiating" + | "bottom_initiating" + | "top_non_initiating" + | "middle_non_initiating" + | "bottom_non_initiating"; - type MessageVisibleKind = "initiating" | "non_initiating"; +export type MessageVisibleKind = "initiating" | "non_initiating"; - interface TypeDerived { - $type: ElementType; - $parent?: TypeDerived; - } - interface BaseElement extends TypeDerived { - /** - * Is the primary Id of the element - */ - id: string; +export interface TypeDerived { + $type: ElementType; + $parent?: TypeDerived; +} +export interface BaseElement extends TypeDerived { + /** + * Is the primary Id of the element + */ + id: string; - /** - * Documentation for the element - */ - documentation?: Documentation[] | undefined; + /** + * Documentation for the element + */ + documentation?: Documentation[] | undefined; - /** - * Reference to the extension definitions for this element - */ - extensionDefinitions?: ExtensionDefinition[] | undefined; + /** + * Reference to the extension definitions for this element + */ + extensionDefinitions?: ExtensionDefinition[] | undefined; - /** - * Extension Elements - */ - extensionElements?: ExtensionElements | undefined; + /** + * Extension Elements + */ + extensionElements?: ExtensionElements | undefined; - /** - * Attributes that aren't defined by the BPMN Spec such - * as Camunda properties - */ - $attrs?: Record | undefined; - } + /** + * Attributes that aren't defined by the BPMN Spec such + * as Camunda properties + */ + $attrs?: Record | undefined; +} - interface RootElement extends BaseElement {} - interface Interface extends RootElement { - name: string; - operations: Operation[]; - implementationRef: string; - } +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface RootElement extends BaseElement {} +export interface Interface extends RootElement { + name: string; + operations: Operation[]; + implementationRef: string; +} - interface Operation extends BaseElement { - name: string; - inMessageRef: Message; - outMessageRef: Message; - errorRef: ErrorElement; - implementationRef: string; - } +export interface Operation extends BaseElement { + name: string; + inMessageRef: Message; + outMessageRef: Message; + errorRef: ErrorElement; + implementationRef: string; +} - interface EndPoint extends RootElement {} - interface Auditing extends BaseElement {} - interface CallableElement extends RootElement { - name: string; - ioSpecification: InputOutputSpecification; - supportedInterfaceRef: Interface; - ioBinding: InputOutputBinding; - } - interface ResourceRole extends BaseElement { - name: string; - resourceRef: Resource; - ResourceParameterBindings: ResourceParameterBinding[]; - resourceAssignmentExpression: ResourceAssignmentExpression; - } - interface GlobalTask extends CallableElement { - resources: ResourceRole; - } - interface Monitoring extends BaseElement {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface EndPoint extends RootElement {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface Auditing extends BaseElement {} +export interface CallableElement extends RootElement { + name: string; + ioSpecification: InputOutputSpecification; + supportedInterfaceRef: Interface; + ioBinding: InputOutputBinding; +} +export interface ResourceRole extends BaseElement { + name: string; + resourceRef: Resource; + ResourceParameterBindings: ResourceParameterBinding[]; + resourceAssignmentExpression: ResourceAssignmentExpression; +} +export interface GlobalTask extends CallableElement { + resources: ResourceRole; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface Monitoring extends BaseElement {} - interface Performer extends ResourceRole {} - interface Process extends FlowElementsContainer, CallableElement { - processType: string; - isClosed: boolean; - auditing: Auditing; - monitoring: Monitoring; - properties: Property[]; - laneSets: LaneSet[]; - flowElements: FlowElement[]; - artifacts: Artifact[]; - resources: ResourceRole[]; - correlationSubscriptions: CorrelationSubscription[]; - supports: Process[]; - definitionalCollaborationRef: Collaboration; - isExecutable: boolean; - } - interface LaneSet extends BaseElement { - lanes: Lane[]; - name: string; - } - interface Lane extends BaseElement { - name: string; - partitionElementRef: BaseElement; - partitionElement: BaseElement; - flowNodeRef: FlowNode[]; - childLaneSet: LaneSet; - } - interface GlobalManualTask extends GlobalTask {} - interface ManualTask extends Task {} - interface UserTask extends Task { - renderings: Rendering[]; - implementation: string; - } - interface Rendering extends BaseElement {} - interface HumanPerformer extends Performer {} - interface PotentialOwner extends Performer {} - interface GlobalUserTask extends GlobalTask { - implementation: string; - renderings: Rendering; - } - interface Gateway extends FlowNode { - /** - * @default Unspecified - */ - gatewayDirection: GatewayDirection; - } - interface EventBasedGateway extends Gateway { - instantiate: boolean; - /** - * @default Exclusive - */ - eventGatewayType: EventBasedGatewayType; - } - interface ComplexGateway extends Gateway { - activationCondition: Expression; - default: SequenceFlow; - } - interface ExclusiveGateway extends Gateway { - default: SequenceFlow; - } - interface InclusiveGateway extends Gateway { - default: SequenceFlow; - } - interface ParallelGateway extends Gateway {} - interface Relationship extends BaseElement { - type: string; - direction: RelationshipDirection; - source: BaseElement[]; - target: BaseElement[]; - } - interface Extension extends TypeDerived { - /** - * @default false - */ - mustUnderstand: boolean; - definition: ExtensionDefinition; - } - interface ExtensionDefinition extends TypeDerived { - name: string; - extensionAttributeDefinitions: ExtensionAttributeDefinition[]; - } - interface ExtensionAttributeDefinition extends TypeDerived { - name: string; - type: string; - /** - * @default false - */ - isReference: boolean; - } - interface ExtensionElements extends TypeDerived { - valueRef: BaseElement; - values: BaseElement[]; - extensionAttributeDefinition: ExtensionAttributeDefinition; - [key: string]: any; - } - interface Documentation extends BaseElement { - text: string; - /** - * @default "text/plain" - */ - textFormat: string; - } - interface Event extends FlowNode, InteractionNode { - properties: Property[]; - } - interface IntermediateCatchEvent extends CatchEvent {} - interface IntermediateThrowEvent extends ThrowEvent {} - interface EndEvent extends ThrowEvent {} - interface StartEvent extends CatchEvent { - /** - * @default true - */ - isInterrupting: boolean; - } - interface ThrowEvent extends Event { - dataInputs: DataInput[]; - dataInputAssociations: DataInputAssociation[]; - inputSet: InputSet; - eventDefinitions: EventDefinition[]; - eventDefinitionRef: EventDefinition[]; - } - interface CatchEvent extends Event { - /** - * @default false - */ - parallelMultiple: boolean; - dataOutputs: DataOutput[]; - dataOutputAssociations: DataOutputAssociation[]; - outputSet: OutputSet; - eventDefinitions: EventDefinition[]; - } - interface BoundaryEvent extends CatchEvent { - /** - * @default true - */ - cancelActivity: boolean; - attachedToRef: Activity; - } +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface Performer extends ResourceRole {} +export interface Process extends FlowElementsContainer, CallableElement { + processType: string; + isClosed: boolean; + auditing: Auditing; + monitoring: Monitoring; + properties: Property[]; + laneSets: LaneSet[]; + flowElements: FlowElement[]; + artifacts: Artifact[]; + resources: ResourceRole[]; + correlationSubscriptions: CorrelationSubscription[]; + supports: Process[]; + definitionalCollaborationRef: Collaboration; + isExecutable: boolean; +} +export interface LaneSet extends BaseElement { + lanes: Lane[]; + name: string; +} +export interface Lane extends BaseElement { + name: string; + partitionElementRef: BaseElement; + partitionElement: BaseElement; + flowNodeRef: FlowNode[]; + childLaneSet: LaneSet; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface GlobalManualTask extends GlobalTask {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface ManualTask extends Task {} +export interface UserTask extends Task { + renderings: Rendering[]; + implementation: string; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface Rendering extends BaseElement {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface HumanPerformer extends Performer {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface PotentialOwner extends Performer {} +export interface GlobalUserTask extends GlobalTask { + implementation: string; + renderings: Rendering; +} +export interface Gateway extends FlowNode { + /** + * @default Unspecified + */ + gatewayDirection: GatewayDirection; +} +export interface EventBasedGateway extends Gateway { + instantiate: boolean; + /** + * @default Exclusive + */ + eventGatewayType: EventBasedGatewayType; +} +export interface ComplexGateway extends Gateway { + activationCondition: Expression; + default: SequenceFlow; +} +export interface ExclusiveGateway extends Gateway { + default: SequenceFlow; +} +export interface InclusiveGateway extends Gateway { + default: SequenceFlow; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface ParallelGateway extends Gateway {} +export interface Relationship extends BaseElement { + type: string; + direction: RelationshipDirection; + source: BaseElement[]; + target: BaseElement[]; +} +export interface Extension extends TypeDerived { + /** + * @default false + */ + mustUnderstand: boolean; + definition: ExtensionDefinition; +} +export interface ExtensionDefinition extends TypeDerived { + name: string; + extensionAttributeDefinitions: ExtensionAttributeDefinition[]; +} +export interface ExtensionAttributeDefinition extends TypeDerived { + name: string; + type: string; + /** + * @default false + */ + isReference: boolean; +} +export interface ExtensionElements extends TypeDerived { + valueRef: BaseElement; + values: BaseElement[]; + extensionAttributeDefinition: ExtensionAttributeDefinition; + [key: string]: any; +} +export interface Documentation extends BaseElement { + text: string; + /** + * @default "text/plain" + */ + textFormat: string; +} +export interface Event extends FlowNode, InteractionNode { + properties: Property[]; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface IntermediateCatchEvent extends CatchEvent {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface IntermediateThrowEvent extends ThrowEvent {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface EndEvent extends ThrowEvent {} +export interface StartEvent extends CatchEvent { + /** + * @default true + */ + isInterrupting: boolean; +} +export interface ThrowEvent extends Event { + dataInputs: DataInput[]; + dataInputAssociations: DataInputAssociation[]; + inputSet: InputSet; + eventDefinitions: EventDefinition[]; + eventDefinitionRef: EventDefinition[]; +} +export interface CatchEvent extends Event { + /** + * @default false + */ + parallelMultiple: boolean; + dataOutputs: DataOutput[]; + dataOutputAssociations: DataOutputAssociation[]; + outputSet: OutputSet; + eventDefinitions: EventDefinition[]; +} +export interface BoundaryEvent extends CatchEvent { + /** + * @default true + */ + cancelActivity: boolean; + attachedToRef: Activity; +} - interface EventDefinition extends RootElement {} - interface CancelEventDefinition extends EventDefinition {} - interface ErrorEventDefinition extends EventDefinition { - errorRef: ErrorElement; - } - interface TerminateEventDefinition extends EventDefinition {} - interface EscalationEventDefinition extends EventDefinition { - escalationRef: Escalation; - } - interface Escalation extends RootElement { - structureRef: ItemDefinition; - name: string; - escalationCode: string; - } - interface CompensateEventDefinition extends EventDefinition { - waitForCompletion: boolean; - activityRef: Activity; - } - interface TimerEventDefinition extends EventDefinition { - timeDate: Expression; - timeCycle: Expression; - timeDuration: Expression; - } - interface LinkEventDefinition extends EventDefinition { - name: string; - target: LinkEventDefinition; - source: LinkEventDefinition; - } - interface MessageEventDefinition extends EventDefinition { - messageRef: Message; - operationRef: Operation; - } - interface ConditionalEventDefinition extends EventDefinition { - condition: Expression; - } - interface SignalEventDefinition extends EventDefinition { - signalRef: Signal; - } - interface Signal extends RootElement { - structureRef: ItemDefinition; - name: string; - } - interface ImplicitThrowEvent extends ThrowEvent {} - interface DataState extends BaseElement { - name: string; - } - interface ItemAwareElement extends BaseElement { - itemSubjectRef: ItemDefinition; - dataState: DataState; - } - interface DataAssociation extends BaseElement { - assignment: Assignment; - sourceRef: ItemAwareElement; - targetRef: ItemAwareElement; - transformation: FormalExpression; - } - interface DataInput extends ItemAwareElement { - name: string; - /** @default false */ - isCollection: boolean; - inputSetRef: InputSet; - inputSetWithOptional: InputSet; - inputSetWithWhileExecuting: InputSet; - } - interface DataOutput extends ItemAwareElement { - name: string; - /** - * @default false - */ - isCollection: boolean; - outputSetRef: InputSet[]; - outputSetWithOptional: InputSet[]; - outputSetWithWhileExecuting: InputSet[]; - } - interface InputSet extends BaseElement { - name: string; - dataInputRefs: DataInput[]; - optionalInputRefs: DataInput[]; - whileExecutingInputsRefs: DataInput[]; - outputSetRefs: OutputSet[]; - } - interface OutputSet extends BaseElement { - dataOutputRefs: DataOutput[]; - name: string; - inputSetRefs: InputSet[]; - optionalOutputRefs: DataOutput[]; - whileExecutingOutputREfs: DataOutput[]; - } - interface Property extends ItemAwareElement { - name: string; - } - interface DataInputAssociation extends DataAssociation {} - interface DataOutputAssociation extends DataAssociation {} - interface InputOutputSpecification extends BaseElement { - dataInputs: DataInput[]; - dataOutputs: DataOutput[]; - inputSets: InputSet[]; - outputSets: OutputSet[]; - } - interface DataObject extends FlowElement, ItemAwareElement { - /** @default false */ - isCollection: boolean; - } - interface InputOutputBinding extends TypeDerived { - inputDataRef: InputSet; - outputDataRef: OutputSet; - operationRef: Operation; - } - interface Assignment extends BaseElement { - from: Expression; - to: Expression; - } - interface DataStore extends RootElement, ItemAwareElement { - name: string; - capacity: number; - isUnlimited: boolean; - } - interface DataStoreReference extends FlowElement, ItemAwareElement { - dataStoreRef: DataStore; - } - interface DataObjectReference extends ItemAwareElement, FlowElement { - dataObjectRef: DataObject; - } - interface ConversationLink extends BaseElement { - sourceRef: InteractionNode; - targetRef: InteractionNode; - name: string; - } +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface EventDefinition extends RootElement {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface CancelEventDefinition extends EventDefinition {} +export interface ErrorEventDefinition extends EventDefinition { + errorRef: ErrorElement; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface TerminateEventDefinition extends EventDefinition {} +export interface EscalationEventDefinition extends EventDefinition { + escalationRef: Escalation; +} +export interface Escalation extends RootElement { + structureRef: ItemDefinition; + name: string; + escalationCode: string; +} +export interface CompensateEventDefinition extends EventDefinition { + waitForCompletion: boolean; + activityRef: Activity; +} +export interface TimerEventDefinition extends EventDefinition { + timeDate: Expression; + timeCycle: Expression; + timeDuration: Expression; +} +export interface LinkEventDefinition extends EventDefinition { + name: string; + target: LinkEventDefinition; + source: LinkEventDefinition; +} +export interface MessageEventDefinition extends EventDefinition { + messageRef: Message; + operationRef: Operation; +} +export interface ConditionalEventDefinition extends EventDefinition { + condition: Expression; +} +export interface SignalEventDefinition extends EventDefinition { + signalRef: Signal; +} +export interface Signal extends RootElement { + structureRef: ItemDefinition; + name: string; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface ImplicitThrowEvent extends ThrowEvent {} +export interface DataState extends BaseElement { + name: string; +} +export interface ItemAwareElement extends BaseElement { + itemSubjectRef: ItemDefinition; + dataState: DataState; +} +export interface DataAssociation extends BaseElement { + assignment: Assignment; + sourceRef: ItemAwareElement; + targetRef: ItemAwareElement; + transformation: FormalExpression; +} +export interface DataInput extends ItemAwareElement { + name: string; + /** @default false */ + isCollection: boolean; + inputSetRef: InputSet; + inputSetWithOptional: InputSet; + inputSetWithWhileExecuting: InputSet; +} +export interface DataOutput extends ItemAwareElement { + name: string; + /** + * @default false + */ + isCollection: boolean; + outputSetRef: InputSet[]; + outputSetWithOptional: InputSet[]; + outputSetWithWhileExecuting: InputSet[]; +} +export interface InputSet extends BaseElement { + name: string; + dataInputRefs: DataInput[]; + optionalInputRefs: DataInput[]; + whileExecutingInputsRefs: DataInput[]; + outputSetRefs: OutputSet[]; +} +export interface OutputSet extends BaseElement { + dataOutputRefs: DataOutput[]; + name: string; + inputSetRefs: InputSet[]; + optionalOutputRefs: DataOutput[]; + whileExecutingOutputREfs: DataOutput[]; +} +export interface Property extends ItemAwareElement { + name: string; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface DataInputAssociation extends DataAssociation {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface DataOutputAssociation extends DataAssociation {} +export interface InputOutputSpecification extends BaseElement { + dataInputs: DataInput[]; + dataOutputs: DataOutput[]; + inputSets: InputSet[]; + outputSets: OutputSet[]; +} +export interface DataObject extends FlowElement, ItemAwareElement { + /** @default false */ + isCollection: boolean; +} +export interface InputOutputBinding extends TypeDerived { + inputDataRef: InputSet; + outputDataRef: OutputSet; + operationRef: Operation; +} +export interface Assignment extends BaseElement { + from: Expression; + to: Expression; +} +export interface DataStore extends RootElement, ItemAwareElement { + name: string; + capacity: number; + isUnlimited: boolean; +} +export interface DataStoreReference extends FlowElement, ItemAwareElement { + dataStoreRef: DataStore; +} +export interface DataObjectReference extends ItemAwareElement, FlowElement { + dataObjectRef: DataObject; +} +export interface ConversationLink extends BaseElement { + sourceRef: InteractionNode; + targetRef: InteractionNode; + name: string; +} - interface ConversationAssociation extends ConversationNode { - innerConversationNodeRef: ConversationNode; - outerConversationNodeRef: ConversationNode; - } - interface CallConversation extends ConversationNode { - calledCollaborationRef: Collaboration; - participantAssociations: ParticipantAssociation[]; - } - interface Conversation extends ConversationNode {} - interface SubConversation extends ConversationNode { - conversationNodes: ConversationNode[]; - } - interface ConversationNode extends InteractionNode, BaseElement { - name: string; - participantRefs: Participant[]; - messageFlowRefs: MessageFlow[]; - correlationKeys: CorrelationKey[]; - } - interface GlobalConversation extends Collaboration {} - interface PartnerEntity extends RootElement { - name: string; - participantRef: Participant[]; - } - interface PartnerRole extends RootElement { - name: string; - participantRef: Participant[]; - } +export interface ConversationAssociation extends ConversationNode { + innerConversationNodeRef: ConversationNode; + outerConversationNodeRef: ConversationNode; +} +export interface CallConversation extends ConversationNode { + calledCollaborationRef: Collaboration; + participantAssociations: ParticipantAssociation[]; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface Conversation extends ConversationNode {} +export interface SubConversation extends ConversationNode { + conversationNodes: ConversationNode[]; +} +export interface ConversationNode extends InteractionNode, BaseElement { + name: string; + participantRefs: Participant[]; + messageFlowRefs: MessageFlow[]; + correlationKeys: CorrelationKey[]; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface GlobalConversation extends Collaboration {} +export interface PartnerEntity extends RootElement { + name: string; + participantRef: Participant[]; +} +export interface PartnerRole extends RootElement { + name: string; + participantRef: Participant[]; +} - interface CorrelationProperty extends RootElement { - correlationPropertyRetrievalExpression: CorrelationPropertyRetrievalExpression; - name: string; - type: ItemDefinition; - } - interface ErrorElement extends RootElement { - structureRef: ItemDefinition; - name: string; - errorCode: string; - } - interface CorrelationKey extends BaseElement { - correlationPropertyRef: CorrelationProperty; - name: string; - } - interface Expression extends BaseElement { - body: string; - } - interface FormalExpression extends Expression { - language: string; - evaluatesToTypeRef: ItemDefinition; - } - interface Message extends RootElement { - name: string; - itemRef: ItemDefinition; - } - interface ItemDefinition extends RootElement { - itemKind: ItemKind; - structureRef: string; - /** @default false */ - isCollection: boolean; - import: Import; - } - interface FlowElement extends RootElement { - name?: string | undefined; - auditing: Auditing; - monitoring: Monitoring; - categoryValueRef: CategoryValue[]; - } - interface SequenceFlow extends FlowElement { - isImmediate: boolean; - conditionExpression: Expression; - sourceRef: FlowNode; - targetRef: FlowNode; - } - interface FlowElementsContainer extends BaseElement { - laneSets: LaneSet[]; - flowElements: FlowElement[]; - } - interface FlowNode extends FlowElement { - incoming: SequenceFlow[]; - outgoing: SequenceFlow[]; - lanes: Lane[]; - } - interface CorrelationPropertyRetrievalExpression extends BaseElement { - messagePath: FormalExpression; - messageRef: Message; - } - interface CorrelationPropertyBinding extends BaseElement { - dataPath: FormalExpression; - correlationPropertyRef: CorrelationProperty; - } - interface Resource extends RootElement { - name: string; - resourceParameters: ResourceParameter[]; - } - interface ResourceParameter extends BaseElement { - name: string; - isRequired: boolean; - type: ItemDefinition; - } - interface CorrelationSubscription extends BaseElement { - correlationKeyRef: CorrelationKey; - correlationPropertyBinding: CorrelationKey[]; - } - interface MessageFlow extends BaseElement { - name: string; - sourceRef: InteractionNode; - targetRef: InteractionNode; - messageRef: Message; - } - interface MessageFlowAssociation extends BaseElement { - innerMessageFlowRef: MessageFlow; - outerMessageFlowRef: MessageFlow; - } - interface InteractionNode extends TypeDerived { - incomingConversationLinks: ConversationLink[]; - outgoingConversationLinks: ConversationLink[]; - } - interface Participant extends InteractionNode, BaseElement { - name: string; - interfaceRef: Interface[]; - participantMultiplicity: ParticipantMultiplicity; - endPointRefs: EndPoint[]; - processRef: Process; - } - interface ParticipantAssociation extends BaseElement { - innerParticipantRef: Participant; - outerParticipantRef: Participant; - } - interface ParticipantMultiplicity extends BaseElement { - minimum: number; - maximum: number; - } - interface Collaboration extends RootElement { - name: string; - isClosed: boolean; - participants: Participant[]; - messageFlows: MessageFlow[]; - artifacts: Artifact[]; - conversations: ConversationNode[]; - conversationAssociations: ConversationAssociation[]; - participantAssociations: ParticipantAssociation[]; - messageFlowAssociations: MessageFlowAssociation[]; - correlationKeys: CorrelationKey[]; - choreographyRef: Choreography[]; - conversationLinks: ConversationLink[]; - } - interface ChoreographyActivity extends FlowNode { - participantRef: Participant[]; - initiatingParticipantRef: Participant; - correlationKeys: CorrelationKey[]; - loopType: ChoreographyLoopType; - } - interface CallChoreography extends ChoreographyActivity { - calledChoreographyRef: Choreography; - participantAssociations: ParticipantAssociation[]; - } - interface SubChoreography extends ChoreographyActivity, FlowElementsContainer { - artifacts: Artifact[]; - } - interface ChoreographyTask extends ChoreographyActivity { - messageFlowRef: MessageFlow[]; - } - interface Choreography extends FlowElementsContainer, Collaboration {} - interface GlobalChoreographyTask extends Choreography { - initiatingParticipantRef: Participant; - } - interface TextAnnotation extends Artifact { - text: string; - textFormat: string; - } - interface Group extends Artifact { - categoryValueRef: CategoryValue; - } - interface Association extends Artifact { - associationDirection: AssociationDirection; - sourceRef: BaseElement; - targetRef: BaseElement; - } - interface Category extends RootElement { - categoryValue: CategoryValue; - name: string; - } - interface Artifact extends BaseElement {} - interface CategoryValue extends BaseElement { - categorizedFlowElements: FlowElement[]; - value: string; - } - interface Activity extends FlowNode { - isForCompensation: boolean; - default: SequenceFlow; - ioSpecification: InputOutputSpecification; - boundaryEventRefs: BoundaryEvent[]; - properties: Property[]; - dataInputAssociations: DataInputAssociation[]; - dataOutputAssociations: DataOutputAssociation[]; - startQuantity: number; - resources: ResourceRole; - completionQuantity: number; - loopCharacteristics: LoopCharacteristics; - } - interface ServiceTask extends Task { - implementation: string; - operationRef: Operation; - } - interface SubProcess extends Activity, FlowElementsContainer, InteractionNode { - triggeredByEvent: boolean; - artifacts: Artifact[]; - } - interface LoopCharacteristics extends BaseElement {} - interface MultiInstanceLoopCharacteristics extends LoopCharacteristics { - isSequential: boolean; - behavior: MultiInstanceBehavior; - loopCardinality: Expression; - loopDataInputRef: ItemAwareElement; - loopDataOutputRef: ItemAwareElement; - inputDataItem: DataInput; - outputDataItem: DataOutput; - complexBehaviorDefinition: ComplexBehaviorDefinition; - completionCondition: Expression; - oneBehaviorEventRef: EventDefinition; - noneBehaviorEventRef: EventDefinition; - } - interface StandardLoopCharacteristics extends LoopCharacteristics { - testBefore: boolean; - loopCondition: Expression; - loopMaximum: Expression; - } - interface CallActivity extends Activity { - calledElement: string; - } - interface Task extends Activity, InteractionNode {} - interface SendTask extends Task { - implementation: string; - operationRef: Operation; - messageRef: Message; - } - interface ReceiveTask extends Task { - implementation: string; - instantiate: boolean; - operationRef: Operation; - messageRef: Message; - } - interface ScriptTask extends Task { - scriptFormat: string; - script: string; - } - interface BusinessRuleTask extends Task { - implementation: string; - } - interface AdHocSubProcess extends SubProcess { - completionCondition: Expression; - ordering: AdHocOrdering; - cancelRemainingInstances: boolean; - } - interface Transaction extends SubProcess { - protocol: string; - method: string; - } - interface GlobalScriptTask extends GlobalTask { - scriptLanguage: string; - script: string; - } - interface GlobalBusinessRuleTask extends GlobalTask { - implementation: string; - } - interface ComplexBehaviorDefinition extends BaseElement { - condition: FormalExpression; - event: ImplicitThrowEvent; - } - interface ResourceParameterBinding extends TypeDerived { - expression: Expression; - parameterRef: ResourceParameter; - } - interface ResourceAssignmentExpression extends BaseElement { - expression: Expression; - } - interface Import extends TypeDerived { - importType: string; - location: string; - namespace: string; - } - interface Definitions extends BaseElement { - name: string; - targetNamespace: string; - expressionLanguage: string; - typeLanguage: string; - imports: Import[]; - extensions: Extension[]; - rootElements: RootElement[]; - diagrams: BPMNDiagram[]; - er: string; - relationship: Relationship[]; - erVersion: string; - } - interface BPMNDiagram extends Diagram { - plane: BPMNPlane; - labelStyle: BPMNLabelStyle[]; - } - interface BPMNPlane extends Plane { - bpmnElement?: BaseElement; - planeElement: (BPMNShape | BPMNEdge)[]; - } - interface BPMNShape extends LabeledShape { - isHorizontal?: boolean; - isExpanded?: boolean; - isMarkerVisible?: boolean; - participantBandKind?: ParticipantBandKind; - isMessageVisible?: boolean; - choreographyActivityShape?: BPMNShape; - bpmnElement?: BaseElement; - label?: BPMNLabel; - } +export interface CorrelationProperty extends RootElement { + correlationPropertyRetrievalExpression: CorrelationPropertyRetrievalExpression; + name: string; + type: ItemDefinition; +} +export interface ErrorElement extends RootElement { + structureRef: ItemDefinition; + name: string; + errorCode: string; +} +export interface CorrelationKey extends BaseElement { + correlationPropertyRef: CorrelationProperty; + name: string; +} +export interface Expression extends BaseElement { + body: string; +} +export interface FormalExpression extends Expression { + language: string; + evaluatesToTypeRef: ItemDefinition; +} +export interface Message extends RootElement { + name: string; + itemRef: ItemDefinition; +} +export interface ItemDefinition extends RootElement { + itemKind: ItemKind; + structureRef: string; + /** @default false */ + isCollection: boolean; + import: Import; +} +export interface FlowElement extends RootElement { + name?: string | undefined; + auditing: Auditing; + monitoring: Monitoring; + categoryValueRef: CategoryValue[]; +} +export interface SequenceFlow extends FlowElement { + isImmediate: boolean; + conditionExpression: Expression; + sourceRef: FlowNode; + targetRef: FlowNode; +} +export interface FlowElementsContainer extends BaseElement { + laneSets: LaneSet[]; + flowElements: FlowElement[]; +} +export interface FlowNode extends FlowElement { + incoming: SequenceFlow[]; + outgoing: SequenceFlow[]; + lanes: Lane[]; +} +export interface CorrelationPropertyRetrievalExpression extends BaseElement { + messagePath: FormalExpression; + messageRef: Message; +} +export interface CorrelationPropertyBinding extends BaseElement { + dataPath: FormalExpression; + correlationPropertyRef: CorrelationProperty; +} +export interface Resource extends RootElement { + name: string; + resourceParameters: ResourceParameter[]; +} +export interface ResourceParameter extends BaseElement { + name: string; + isRequired: boolean; + type: ItemDefinition; +} +export interface CorrelationSubscription extends BaseElement { + correlationKeyRef: CorrelationKey; + correlationPropertyBinding: CorrelationKey[]; +} +export interface MessageFlow extends BaseElement { + name: string; + sourceRef: InteractionNode; + targetRef: InteractionNode; + messageRef: Message; +} +export interface MessageFlowAssociation extends BaseElement { + innerMessageFlowRef: MessageFlow; + outerMessageFlowRef: MessageFlow; +} +export interface InteractionNode extends TypeDerived { + incomingConversationLinks: ConversationLink[]; + outgoingConversationLinks: ConversationLink[]; +} +export interface Participant extends InteractionNode, BaseElement { + name: string; + interfaceRef: Interface[]; + participantMultiplicity: ParticipantMultiplicity; + endPointRefs: EndPoint[]; + processRef: Process; +} +export interface ParticipantAssociation extends BaseElement { + innerParticipantRef: Participant; + outerParticipantRef: Participant; +} +export interface ParticipantMultiplicity extends BaseElement { + minimum: number; + maximum: number; +} +export interface Collaboration extends RootElement { + name: string; + isClosed: boolean; + participants: Participant[]; + messageFlows: MessageFlow[]; + artifacts: Artifact[]; + conversations: ConversationNode[]; + conversationAssociations: ConversationAssociation[]; + participantAssociations: ParticipantAssociation[]; + messageFlowAssociations: MessageFlowAssociation[]; + correlationKeys: CorrelationKey[]; + choreographyRef: Choreography[]; + conversationLinks: ConversationLink[]; +} +export interface ChoreographyActivity extends FlowNode { + participantRef: Participant[]; + initiatingParticipantRef: Participant; + correlationKeys: CorrelationKey[]; + loopType: ChoreographyLoopType; +} +export interface CallChoreography extends ChoreographyActivity { + calledChoreographyRef: Choreography; + participantAssociations: ParticipantAssociation[]; +} +export interface SubChoreography extends ChoreographyActivity, FlowElementsContainer { + artifacts: Artifact[]; +} +export interface ChoreographyTask extends ChoreographyActivity { + messageFlowRef: MessageFlow[]; +} +export interface Choreography extends FlowElementsContainer, Collaboration {} +export interface GlobalChoreographyTask extends Choreography { + initiatingParticipantRef: Participant; +} +export interface TextAnnotation extends Artifact { + text: string; + textFormat: string; +} +export interface Group extends Artifact { + categoryValueRef: CategoryValue; +} +export interface Association extends Artifact { + associationDirection: AssociationDirection; + sourceRef: BaseElement; + targetRef: BaseElement; +} +export interface Category extends RootElement { + categoryValue: CategoryValue; + name: string; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface Artifact extends BaseElement {} +export interface CategoryValue extends BaseElement { + categorizedFlowElements: FlowElement[]; + value: string; +} +export interface Activity extends FlowNode { + isForCompensation: boolean; + default: SequenceFlow; + ioSpecification: InputOutputSpecification; + boundaryEventRefs: BoundaryEvent[]; + properties: Property[]; + dataInputAssociations: DataInputAssociation[]; + dataOutputAssociations: DataOutputAssociation[]; + startQuantity: number; + resources: ResourceRole; + completionQuantity: number; + loopCharacteristics: LoopCharacteristics; +} +export interface ServiceTask extends Task { + implementation: string; + operationRef: Operation; +} +export interface SubProcess extends Activity, FlowElementsContainer, InteractionNode { + triggeredByEvent: boolean; + artifacts: Artifact[]; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface LoopCharacteristics extends BaseElement {} +export interface MultiInstanceLoopCharacteristics extends LoopCharacteristics { + isSequential: boolean; + behavior: MultiInstanceBehavior; + loopCardinality: Expression; + loopDataInputRef: ItemAwareElement; + loopDataOutputRef: ItemAwareElement; + inputDataItem: DataInput; + outputDataItem: DataOutput; + complexBehaviorDefinition: ComplexBehaviorDefinition; + completionCondition: Expression; + oneBehaviorEventRef: EventDefinition; + noneBehaviorEventRef: EventDefinition; +} +export interface StandardLoopCharacteristics extends LoopCharacteristics { + testBefore: boolean; + loopCondition: Expression; + loopMaximum: Expression; +} +export interface CallActivity extends Activity { + calledElement: string; +} +export interface Task extends Activity, InteractionNode {} +export interface SendTask extends Task { + implementation: string; + operationRef: Operation; + messageRef: Message; +} +export interface ReceiveTask extends Task { + implementation: string; + instantiate: boolean; + operationRef: Operation; + messageRef: Message; +} +export interface ScriptTask extends Task { + scriptFormat: string; + script: string; +} +export interface BusinessRuleTask extends Task { + implementation: string; +} +export interface AdHocSubProcess extends SubProcess { + completionCondition: Expression; + ordering: AdHocOrdering; + cancelRemainingInstances: boolean; +} +export interface Transaction extends SubProcess { + protocol: string; + method: string; +} +export interface GlobalScriptTask extends GlobalTask { + scriptLanguage: string; + script: string; +} +export interface GlobalBusinessRuleTask extends GlobalTask { + implementation: string; +} +export interface ComplexBehaviorDefinition extends BaseElement { + condition: FormalExpression; + event: ImplicitThrowEvent; +} +export interface ResourceParameterBinding extends TypeDerived { + expression: Expression; + parameterRef: ResourceParameter; +} +export interface ResourceAssignmentExpression extends BaseElement { + expression: Expression; +} +export interface Import extends TypeDerived { + importType: string; + location: string; + namespace: string; +} +export interface Definitions extends BaseElement { + name: string; + targetNamespace: string; + expressionLanguage: string; + typeLanguage: string; + imports: Import[]; + extensions: Extension[]; + rootElements: RootElement[]; + diagrams: BPMNDiagram[]; + er: string; + relationship: Relationship[]; + erVersion: string; +} +export interface BPMNDiagram extends Diagram { + plane: BPMNPlane; + labelStyle: BPMNLabelStyle[]; +} +export interface BPMNPlane extends Plane { + bpmnElement?: BaseElement; + planeElement: (BPMNShape | BPMNEdge)[]; +} +export interface BPMNShape extends LabeledShape { + isHorizontal?: boolean; + isExpanded?: boolean; + isMarkerVisible?: boolean; + participantBandKind?: ParticipantBandKind; + isMessageVisible?: boolean; + choreographyActivityShape?: BPMNShape; + bpmnElement?: BaseElement; + label?: BPMNLabel; +} - interface BPMNEdge extends LabeledEdge { - label?: BPMNLabel; - bpmnElement?: BaseElement; - sourceElement?: BPMNShape | BPMNEdge; - targetElement?: BPMNShape | BPMNEdge; - messageVisibleKind?: MessageVisibleKind; - } +export interface BPMNEdge extends LabeledEdge { + label?: BPMNLabel; + bpmnElement?: BaseElement; + sourceElement?: BPMNShape | BPMNEdge; + targetElement?: BPMNShape | BPMNEdge; + messageVisibleKind?: MessageVisibleKind; +} - interface BPMNLabel extends Label { - labelStyle?: BPMNLabelStyle; - } +export interface BPMNLabel extends Label { + labelStyle?: BPMNLabelStyle; +} - interface BPMNLabelStyle extends Style { - font: Font; - } - interface Font extends TypeDerived { - name?: string; - size?: number; - isBold?: boolean; - isItalic?: boolean; - isUnderline?: boolean; - isStrikeThrough?: boolean; - } - interface Point extends TypeDerived { - /** - * @default 0 - */ - x: number; - /** - * @default 0 - */ - y: number; - } - interface Bounds extends TypeDerived { - /** - * @default 0 - */ - x: number; - /** - * @default Unspecified - */ - y: number; - width: number; - height: number; - } - interface DiagramElement extends TypeDerived {} - interface Node extends DiagramElement {} - interface Edge extends DiagramElement { - waypoint: Point[]; - } - interface Diagram extends TypeDerived { - name?: string; - documentation?: string; - resolution?: number; - } - interface Shape extends Node { - bounds: Bounds; - } - interface Plane extends Node { - planeElement: DiagramElement[]; - } - interface LabeledEdge extends Edge {} - interface LabeledShape extends Shape {} - interface Label extends Node { - bounds: Bounds; - } - interface Style extends TypeDerived {} - interface ColoredShape extends TypeDerived {} - interface ColoredEdge extends TypeDerived {} +export interface BPMNLabelStyle extends Style { + font: Font; +} +export interface Font extends TypeDerived { + name?: string; + size?: number; + isBold?: boolean; + isItalic?: boolean; + isUnderline?: boolean; + isStrikeThrough?: boolean; +} +export interface Point extends TypeDerived { + /** + * @default 0 + */ + x: number; + /** + * @default 0 + */ + y: number; +} +export interface Bounds extends TypeDerived { + /** + * @default 0 + */ + x: number; + /** + * @default Unspecified + */ + y: number; + width: number; + height: number; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface DiagramElement extends TypeDerived {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface Node extends DiagramElement {} +export interface Edge extends DiagramElement { + waypoint: Point[]; +} +export interface Diagram extends TypeDerived { + name?: string; + documentation?: string; + resolution?: number; +} +export interface Shape extends Node { + bounds: Bounds; +} +export interface Plane extends Node { + planeElement: DiagramElement[]; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface LabeledEdge extends Edge {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface LabeledShape extends Shape {} +export interface Label extends Node { + bounds: Bounds; +} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface Style extends TypeDerived {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface ColoredShape extends TypeDerived {} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface ColoredEdge extends TypeDerived {} - interface ElementTypes { - "bpmn:Interface": Interface; - "bpmn:Operation": Operation; - "bpmn:EndPoint": EndPoint; - "bpmn:Auditing": Auditing; - "bpmn:GlobalTask": GlobalTask; - "bpmn:Monitoring": Monitoring; - "bpmn:Performer": Performer; - "bpmn:Process": Process; - "bpmn:LaneSet": LaneSet; - "bpmn:Lane": Lane; - "bpmn:GlobalManualTask": GlobalManualTask; - "bpmn:ManualTask": ManualTask; - "bpmn:UserTask": UserTask; - "bpmn:Rendering": Rendering; - "bpmn:HumanPerformer": HumanPerformer; - "bpmn:PotentialOwner": PotentialOwner; - "bpmn:GlobalUserTask": GlobalUserTask; - "bpmn:Gateway": Gateway; - "bpmn:EventBasedGateway": EventBasedGateway; - "bpmn:ComplexGateway": ComplexGateway; - "bpmn:ExclusiveGateway": ExclusiveGateway; - "bpmn:InclusiveGateway": InclusiveGateway; - "bpmn:ParallelGateway": ParallelGateway; - "bpmn:RootElement": RootElement; - "bpmn:Relationship": Relationship; - "bpmn:BaseElement": BaseElement; - "bpmn:Extension": Extension; - "bpmn:ExtensionDefinition": ExtensionDefinition; - "bpmn:ExtensionAttributeDefinition": ExtensionAttributeDefinition; - "bpmn:ExtensionElements": ExtensionElements; - "bpmn:Documentation": Documentation; - "bpmn:Event": Event; - "bpmn:IntermediateCatchEvent": IntermediateCatchEvent; - "bpmn:IntermediateThrowEvent": IntermediateThrowEvent; - "bpmn:EndEvent": EndEvent; - "bpmn:StartEvent": StartEvent; - "bpmn:ThrowEvent": ThrowEvent; - "bpmn:CatchEvent": CatchEvent; - "bpmn:BoundaryEvent": BoundaryEvent; - "bpmn:EventDefinition": EventDefinition; - "bpmn:CancelEventDefinition": CancelEventDefinition; - "bpmn:ErrorEventDefinition": ErrorEventDefinition; - "bpmn:TerminateEventDefinition": TerminateEventDefinition; - "bpmn:EscalationEventDefinition": EscalationEventDefinition; - "bpmn:Escalation": Escalation; - "bpmn:CompensateEventDefinition": CompensateEventDefinition; - "bpmn:TimerEventDefinition": TimerEventDefinition; - "bpmn:LinkEventDefinition": LinkEventDefinition; - "bpmn:MessageEventDefinition": MessageEventDefinition; - "bpmn:ConditionalEventDefinition": ConditionalEventDefinition; - "bpmn:SignalEventDefinition": SignalEventDefinition; - "bpmn:Signal": Signal; - "bpmn:ImplicitThrowEvent": ImplicitThrowEvent; - "bpmn:DataState": DataState; - "bpmn:ItemAwareElement": ItemAwareElement; - "bpmn:DataAssociation": DataAssociation; - "bpmn:DataInput": DataInput; - "bpmn:DataOutput": DataOutput; - "bpmn:InputSet": InputSet; - "bpmn:OutputSet": OutputSet; - "bpmn:Property": Property; - "bpmn:DataInputAssociation": DataInputAssociation; - "bpmn:DataOutputAssociation": DataOutputAssociation; - "bpmn:InputOutputSpecification": InputOutputSpecification; - "bpmn:DataObject": DataObject; - "bpmn:InputOutputBinding": InputOutputBinding; - "bpmn:Assignment": Assignment; - "bpmn:DataStore": DataStore; - "bpmn:DataStoreReference": DataStoreReference; - "bpmn:DataObjectReference": DataObjectReference; - "bpmn:ConversationLink": ConversationLink; - "bpmn:ConversationAssociation": ConversationAssociation; - "bpmn:CallConversation": CallConversation; - "bpmn:Conversation": Conversation; - "bpmn:SubConversation": SubConversation; - "bpmn:ConversationNode": ConversationNode; - "bpmn:GlobalConversation": GlobalConversation; - "bpmn:PartnerEntity": PartnerEntity; - "bpmn:PartnerRole": PartnerRole; - "bpmn:CorrelationProperty": CorrelationProperty; - "bpmn:Error": ErrorElement; - "bpmn:CorrelationKey": CorrelationKey; - "bpmn:Expression": Expression; - "bpmn:FormalExpression": FormalExpression; - "bpmn:Message": Message; - "bpmn:ItemDefinition": ItemDefinition; - "bpmn:FlowElement": FlowElement; - "bpmn:SequenceFlow": SequenceFlow; - "bpmn:FlowElementsContainer": FlowElementsContainer; - "bpmn:CallableElement": CallableElement; - "bpmn:FlowNode": FlowNode; - "bpmn:CorrelationPropertyRetrievalExpression": CorrelationPropertyRetrievalExpression; - "bpmn:CorrelationPropertyBinding": CorrelationPropertyBinding; - "bpmn:Resource": Resource; - "bpmn:ResourceParameter": ResourceParameter; - "bpmn:CorrelationSubscription": CorrelationSubscription; - "bpmn:MessageFlow": MessageFlow; - "bpmn:MessageFlowAssociation": MessageFlowAssociation; - "bpmn:InteractionNode": InteractionNode; - "bpmn:Participant": Participant; - "bpmn:ParticipantAssociation": ParticipantAssociation; - "bpmn:ParticipantMultiplicity": ParticipantMultiplicity; - "bpmn:Collaboration": Collaboration; - "bpmn:ChoreographyActivity": ChoreographyActivity; - "bpmn:CallChoreography": CallChoreography; - "bpmn:SubChoreography": SubChoreography; - "bpmn:ChoreographyTask": ChoreographyTask; - "bpmn:Choreography": Choreography; - "bpmn:GlobalChoreographyTask": GlobalChoreographyTask; - "bpmn:TextAnnotation": TextAnnotation; - "bpmn:Group": Group; - "bpmn:Association": Association; - "bpmn:Category": Category; - "bpmn:Artifact": Artifact; - "bpmn:CategoryValue": CategoryValue; - "bpmn:Activity": Activity; - "bpmn:ServiceTask": ServiceTask; - "bpmn:SubProcess": SubProcess; - "bpmn:LoopCharacteristics": LoopCharacteristics; - "bpmn:MultiInstanceLoopCharacteristics": MultiInstanceLoopCharacteristics; - "bpmn:StandardLoopCharacteristics": StandardLoopCharacteristics; - "bpmn:CallActivity": CallActivity; - "bpmn:Task": Task; - "bpmn:SendTask": SendTask; - "bpmn:ReceiveTask": ReceiveTask; - "bpmn:ScriptTask": ScriptTask; - "bpmn:BusinessRuleTask": BusinessRuleTask; - "bpmn:AdHocSubProcess": AdHocSubProcess; - "bpmn:Transaction": Transaction; - "bpmn:GlobalScriptTask": GlobalScriptTask; - "bpmn:GlobalBusinessRuleTask": GlobalBusinessRuleTask; - "bpmn:ComplexBehaviorDefinition": ComplexBehaviorDefinition; - "bpmn:ResourceRole": ResourceRole; - "bpmn:ResourceParameterBinding": ResourceParameterBinding; - "bpmn:ResourceAssignmentExpression": ResourceAssignmentExpression; - "bpmn:Import": Import; - "bpmn:Definitions": Definitions; - "bpmndi:BPMNDiagram": BPMNDiagram; - "bpmndi:BPMNPlane": BPMNPlane; - "bpmndi:BPMNShape": BPMNShape; - "bpmndi:BPMNEdge": BPMNEdge; - "bpmndi:BPMNLabel": BPMNLabel; - "bpmndi:BPMNLabelStyle": BPMNLabelStyle; - "dc:boolean": boolean; - "dc:number": number; - "dc:Real": any; - "dc:string": string; - "dc:Font": Font; - "dc:Point": Point; - "dc:Bounds": Bounds; - "di:DiagramElement": DiagramElement; - "di:Node": Node; - "di:Edge": Edge; - "di:Diagram": Diagram; - "di:Shape": Shape; - "di:Plane": Plane; - "di:LabeledEdge": LabeledEdge; - "di:LabeledShape": LabeledShape; - "di:Label": Label; - "di:Style": Style; - "di:Extension": Extension; - "bioc:ColoredShape": ColoredShape; - "bioc:ColoredEdge": ColoredEdge; - } +export interface ElementTypes { + "bpmn:Interface": Interface; + "bpmn:Operation": Operation; + "bpmn:EndPoint": EndPoint; + "bpmn:Auditing": Auditing; + "bpmn:GlobalTask": GlobalTask; + "bpmn:Monitoring": Monitoring; + "bpmn:Performer": Performer; + "bpmn:Process": Process; + "bpmn:LaneSet": LaneSet; + "bpmn:Lane": Lane; + "bpmn:GlobalManualTask": GlobalManualTask; + "bpmn:ManualTask": ManualTask; + "bpmn:UserTask": UserTask; + "bpmn:Rendering": Rendering; + "bpmn:HumanPerformer": HumanPerformer; + "bpmn:PotentialOwner": PotentialOwner; + "bpmn:GlobalUserTask": GlobalUserTask; + "bpmn:Gateway": Gateway; + "bpmn:EventBasedGateway": EventBasedGateway; + "bpmn:ComplexGateway": ComplexGateway; + "bpmn:ExclusiveGateway": ExclusiveGateway; + "bpmn:InclusiveGateway": InclusiveGateway; + "bpmn:ParallelGateway": ParallelGateway; + "bpmn:RootElement": RootElement; + "bpmn:Relationship": Relationship; + "bpmn:BaseElement": BaseElement; + "bpmn:Extension": Extension; + "bpmn:ExtensionDefinition": ExtensionDefinition; + "bpmn:ExtensionAttributeDefinition": ExtensionAttributeDefinition; + "bpmn:ExtensionElements": ExtensionElements; + "bpmn:Documentation": Documentation; + "bpmn:Event": Event; + "bpmn:IntermediateCatchEvent": IntermediateCatchEvent; + "bpmn:IntermediateThrowEvent": IntermediateThrowEvent; + "bpmn:EndEvent": EndEvent; + "bpmn:StartEvent": StartEvent; + "bpmn:ThrowEvent": ThrowEvent; + "bpmn:CatchEvent": CatchEvent; + "bpmn:BoundaryEvent": BoundaryEvent; + "bpmn:EventDefinition": EventDefinition; + "bpmn:CancelEventDefinition": CancelEventDefinition; + "bpmn:ErrorEventDefinition": ErrorEventDefinition; + "bpmn:TerminateEventDefinition": TerminateEventDefinition; + "bpmn:EscalationEventDefinition": EscalationEventDefinition; + "bpmn:Escalation": Escalation; + "bpmn:CompensateEventDefinition": CompensateEventDefinition; + "bpmn:TimerEventDefinition": TimerEventDefinition; + "bpmn:LinkEventDefinition": LinkEventDefinition; + "bpmn:MessageEventDefinition": MessageEventDefinition; + "bpmn:ConditionalEventDefinition": ConditionalEventDefinition; + "bpmn:SignalEventDefinition": SignalEventDefinition; + "bpmn:Signal": Signal; + "bpmn:ImplicitThrowEvent": ImplicitThrowEvent; + "bpmn:DataState": DataState; + "bpmn:ItemAwareElement": ItemAwareElement; + "bpmn:DataAssociation": DataAssociation; + "bpmn:DataInput": DataInput; + "bpmn:DataOutput": DataOutput; + "bpmn:InputSet": InputSet; + "bpmn:OutputSet": OutputSet; + "bpmn:Property": Property; + "bpmn:DataInputAssociation": DataInputAssociation; + "bpmn:DataOutputAssociation": DataOutputAssociation; + "bpmn:InputOutputSpecification": InputOutputSpecification; + "bpmn:DataObject": DataObject; + "bpmn:InputOutputBinding": InputOutputBinding; + "bpmn:Assignment": Assignment; + "bpmn:DataStore": DataStore; + "bpmn:DataStoreReference": DataStoreReference; + "bpmn:DataObjectReference": DataObjectReference; + "bpmn:ConversationLink": ConversationLink; + "bpmn:ConversationAssociation": ConversationAssociation; + "bpmn:CallConversation": CallConversation; + "bpmn:Conversation": Conversation; + "bpmn:SubConversation": SubConversation; + "bpmn:ConversationNode": ConversationNode; + "bpmn:GlobalConversation": GlobalConversation; + "bpmn:PartnerEntity": PartnerEntity; + "bpmn:PartnerRole": PartnerRole; + "bpmn:CorrelationProperty": CorrelationProperty; + "bpmn:Error": ErrorElement; + "bpmn:CorrelationKey": CorrelationKey; + "bpmn:Expression": Expression; + "bpmn:FormalExpression": FormalExpression; + "bpmn:Message": Message; + "bpmn:ItemDefinition": ItemDefinition; + "bpmn:FlowElement": FlowElement; + "bpmn:SequenceFlow": SequenceFlow; + "bpmn:FlowElementsContainer": FlowElementsContainer; + "bpmn:CallableElement": CallableElement; + "bpmn:FlowNode": FlowNode; + "bpmn:CorrelationPropertyRetrievalExpression": CorrelationPropertyRetrievalExpression; + "bpmn:CorrelationPropertyBinding": CorrelationPropertyBinding; + "bpmn:Resource": Resource; + "bpmn:ResourceParameter": ResourceParameter; + "bpmn:CorrelationSubscription": CorrelationSubscription; + "bpmn:MessageFlow": MessageFlow; + "bpmn:MessageFlowAssociation": MessageFlowAssociation; + "bpmn:InteractionNode": InteractionNode; + "bpmn:Participant": Participant; + "bpmn:ParticipantAssociation": ParticipantAssociation; + "bpmn:ParticipantMultiplicity": ParticipantMultiplicity; + "bpmn:Collaboration": Collaboration; + "bpmn:ChoreographyActivity": ChoreographyActivity; + "bpmn:CallChoreography": CallChoreography; + "bpmn:SubChoreography": SubChoreography; + "bpmn:ChoreographyTask": ChoreographyTask; + "bpmn:Choreography": Choreography; + "bpmn:GlobalChoreographyTask": GlobalChoreographyTask; + "bpmn:TextAnnotation": TextAnnotation; + "bpmn:Group": Group; + "bpmn:Association": Association; + "bpmn:Category": Category; + "bpmn:Artifact": Artifact; + "bpmn:CategoryValue": CategoryValue; + "bpmn:Activity": Activity; + "bpmn:ServiceTask": ServiceTask; + "bpmn:SubProcess": SubProcess; + "bpmn:LoopCharacteristics": LoopCharacteristics; + "bpmn:MultiInstanceLoopCharacteristics": MultiInstanceLoopCharacteristics; + "bpmn:StandardLoopCharacteristics": StandardLoopCharacteristics; + "bpmn:CallActivity": CallActivity; + "bpmn:Task": Task; + "bpmn:SendTask": SendTask; + "bpmn:ReceiveTask": ReceiveTask; + "bpmn:ScriptTask": ScriptTask; + "bpmn:BusinessRuleTask": BusinessRuleTask; + "bpmn:AdHocSubProcess": AdHocSubProcess; + "bpmn:Transaction": Transaction; + "bpmn:GlobalScriptTask": GlobalScriptTask; + "bpmn:GlobalBusinessRuleTask": GlobalBusinessRuleTask; + "bpmn:ComplexBehaviorDefinition": ComplexBehaviorDefinition; + "bpmn:ResourceRole": ResourceRole; + "bpmn:ResourceParameterBinding": ResourceParameterBinding; + "bpmn:ResourceAssignmentExpression": ResourceAssignmentExpression; + "bpmn:Import": Import; + "bpmn:Definitions": Definitions; + "bpmndi:BPMNDiagram": BPMNDiagram; + "bpmndi:BPMNPlane": BPMNPlane; + "bpmndi:BPMNShape": BPMNShape; + "bpmndi:BPMNEdge": BPMNEdge; + "bpmndi:BPMNLabel": BPMNLabel; + "bpmndi:BPMNLabelStyle": BPMNLabelStyle; + "dc:boolean": boolean; + "dc:number": number; + "dc:Real": any; + "dc:string": string; + "dc:Font": Font; + "dc:Point": Point; + "dc:Bounds": Bounds; + "di:DiagramElement": DiagramElement; + "di:Node": Node; + "di:Edge": Edge; + "di:Diagram": Diagram; + "di:Shape": Shape; + "di:Plane": Plane; + "di:LabeledEdge": LabeledEdge; + "di:LabeledShape": LabeledShape; + "di:Label": Label; + "di:Style": Style; + "di:Extension": Extension; + "bioc:ColoredShape": ColoredShape; + "bioc:ColoredEdge": ColoredEdge; +} - type ElementType = keyof ElementTypes; +export type ElementType = keyof ElementTypes; - type Option = Record; +export type Option = Record; - interface BPMNModdleConstructor { - new(packages?: any, options?: Option): BPMNModdle; - } +export interface BPMNModdleConstructor { + new(packages?: any, options?: Option): BPMNModdle; +} - interface Moddle { - /** - * Create an instance of the specified type. - * - * @example - * - * var foo = moddle.create('my:Foo'); - * var bar = moddle.create('my:Bar', { id: 'BAR_1' }); - * - * @param descriptor the type descriptor or name know to the model - * @param attrs a number of attributes to initialize the model instance with - * @return model instance - */ - create(descriptor: K, attrs?: any): T[K]; - create(descriptor: any, attrs?: any): BaseElement; +export interface Moddle { + /** + * Create an instance of the specified type. + * + * @example + * + * var foo = moddle.create('my:Foo'); + * var bar = moddle.create('my:Bar', { id: 'BAR_1' }); + * + * @param descriptor the type descriptor or name know to the model + * @param attrs a number of attributes to initialize the model instance with + * @return model instance + */ + create(descriptor: K, attrs?: any): T[K]; + create(descriptor: any, attrs?: any): BaseElement; - /** - * Returns the type representing a given descriptor - * - * @example - * - * var Foo = moddle.getType('my:Foo'); - * var foo = new Foo({ 'id' : 'FOO_1' }); - * - * @param descriptor the type descriptor or name know to the model - * @return the type representing the descriptor - */ - getType(descriptor: any): any; + /** + * Returns the type representing a given descriptor + * + * @example + * + * var Foo = moddle.getType('my:Foo'); + * var foo = new Foo({ 'id' : 'FOO_1' }); + * + * @param descriptor the type descriptor or name know to the model + * @return the type representing the descriptor + */ + getType(descriptor: any): any; - /** - * Creates an any-element type to be used within model instances. - * - * This can be used to create custom elements that lie outside the meta-model. - * The created element contains all the meta-data required to serialize it - * as part of meta-model elements. - * - * @example - * - * var foo = moddle.createAny('vendor:Foo', 'http://vendor', { - * value: 'bar' - * }); - * - * var container = moddle.create('my:Container', 'http://my', { - * any: [ foo ] - * }); - * - * // go ahead and serialize the stuff - * - * @param name the name of the element - * @param nsUri the namespace uri of the element - * @param [properties] a map of properties to initialize the instance with - * @return the any type instance - */ - createAny(name: string, nsUri: string, properties: any): any; + /** + * Creates an any-element type to be used within model instances. + * + * This can be used to create custom elements that lie outside the meta-model. + * The created element contains all the meta-data required to serialize it + * as part of meta-model elements. + * + * @example + * + * var foo = moddle.createAny('vendor:Foo', 'http://vendor', { + * value: 'bar' + * }); + * + * var container = moddle.create('my:Container', 'http://my', { + * any: [ foo ] + * }); + * + * // go ahead and serialize the stuff + * + * @param name the name of the element + * @param nsUri the namespace uri of the element + * @param [properties] a map of properties to initialize the instance with + * @return the any type instance + */ + createAny(name: string, nsUri: string, properties: any): any; - /** - * Returns a registered package by uri or prefix - * - * @return the package - */ - getPackage(uriOrPrefix: any): any; + /** + * Returns a registered package by uri or prefix + * + * @return the package + */ + getPackage(uriOrPrefix: any): any; - /** - * Returns a snapshot of all known packages - * - * @return the package - */ - getPackages(): any; - /** - * Returns the descriptor for an element - */ - getElementDescriptor(element: any): any; + /** + * Returns a snapshot of all known packages + * + * @return the package + */ + getPackages(): any; + /** + * Returns the descriptor for an element + */ + getElementDescriptor(element: any): any; - /** - * Returns true if the given descriptor or instance - * represents the given type. - * - * May be applied to this, if element is omitted. - */ - hasType(element: any, type: string): any; + /** + * Returns true if the given descriptor or instance + * represents the given type. + * + * May be applied to this, if element is omitted. + */ + hasType(element: any, type: string): any; - /** - * Returns the descriptor of an elements named property - */ - getPropertyDescriptor(element: any, property: any): any; - /** - * Returns a mapped type's descriptor - */ - getTypeDescriptor(type: string): any; - } + /** + * Returns the descriptor of an elements named property + */ + getPropertyDescriptor(element: any, property: any): any; + /** + * Returns a mapped type's descriptor + */ + getTypeDescriptor(type: string): any; +} - interface BPMNModel { - rootElement: RootElement; - elementsById: Record; - references: BaseElement[]; - warnings: string[]; - } +export interface BPMNModel { + rootElement: RootElement; + elementsById: Record; + references: BaseElement[]; + warnings: string[]; +} - interface BPMNModdle extends Moddle { - /** - * Instantiates a BPMN model tree from a given xml string. - * - * @param xmlStr xml string - * @param typeName name of the root element - * @param options options to pass to the underlying reader - * - * @throws ParseError - * @returns BPMNModel - */ - fromXML(xmlStr: string, typeName: string, options: Option): Promise; +export interface BPMNModdle extends Moddle { + /** + * Instantiates a BPMN model tree from a given xml string. + * + * @param xmlStr xml string + * @param typeName name of the root element + * @param options options to pass to the underlying reader + * + * @throws ParseError + * @returns BPMNModel + */ + fromXML(xmlStr: string, typeName: string, options: Option): Promise; - /** - * Instantiates a BPMN model tree from a given xml string. - * - * @param xmlStr - * @param typeNameOrOptions name of the root element or options to pass to the underlying reader - * - * @throws ParseError - * @returns BPMNModel - */ - fromXML(xmlStr: string, typeNameOrOptions?: Option | string): Promise; + /** + * Instantiates a BPMN model tree from a given xml string. + * + * @param xmlStr + * @param typeNameOrOptions name of the root element or options to pass to the underlying reader + * + * @throws ParseError + * @returns BPMNModel + */ + fromXML(xmlStr: string, typeNameOrOptions?: Option | string): Promise; - /** - * Serializes a BPMN 2.0 object tree to XML. - * - * @param element The root element, typically an instance of `bpmn:Definitions` - * @param option Options to pass to the underlying writer - * - * @returns {Promise} - */ - toXML(element: RootElement, options?: Option): Promise<{ xml: string }>; - } + /** + * Serializes a BPMN 2.0 object tree to XML. + * + * @param element The root element, typically an instance of `bpmn:Definitions` + * @param option Options to pass to the underlying writer + * + * @returns {Promise} + */ + toXML(element: RootElement, options?: Option): Promise<{ xml: string }>; } -declare const BPMNModdle: BPMNModdle.BPMNModdleConstructor; -export default BPMNModdle; +export const BpmnModdle: BPMNModdleConstructor; diff --git a/types/bpmn-moddle/package.json b/types/bpmn-moddle/package.json index 06274c74d84041..3607738e574eaa 100644 --- a/types/bpmn-moddle/package.json +++ b/types/bpmn-moddle/package.json @@ -1,13 +1,10 @@ { "private": true, "name": "@types/bpmn-moddle", - "version": "9.0.9999", + "version": "10.0.9999", "type": "module", "exports": { - ".": { - "import": "./index.d.ts", - "require": "./index.d.cts" - } + ".": "./index.d.ts" }, "projects": [ "https://github.com/bpmn-io/bpmn-moddle" diff --git a/types/bpmn-moddle/tsconfig.json b/types/bpmn-moddle/tsconfig.json index 2e82b7b24c031e..d61ca58998960f 100644 --- a/types/bpmn-moddle/tsconfig.json +++ b/types/bpmn-moddle/tsconfig.json @@ -14,7 +14,6 @@ }, "files": [ "index.d.ts", - "index.d.cts", "bpmn-moddle-tests.ts" ] } diff --git a/types/bpmn-moddle/v9/.npmignore b/types/bpmn-moddle/v9/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/bpmn-moddle/v9/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/bpmn-moddle/v9/bpmn-moddle-tests.ts b/types/bpmn-moddle/v9/bpmn-moddle-tests.ts new file mode 100644 index 00000000000000..00d12a140973d6 --- /dev/null +++ b/types/bpmn-moddle/v9/bpmn-moddle-tests.ts @@ -0,0 +1,18 @@ +import BPMNModdle from "bpmn-moddle"; + +const moddle: BPMNModdle.Moddle = {} as any; + +const element1 = moddle.create("bpmn:UserTask"); // Expect type User Task +element1.$type = "bpmn:UserTask"; // Expect to check against type correctly + +const bpmnModdle: BPMNModdle.BPMNModdle = {} as any; + +bpmnModdle.fromXML(""); + +const definition: BPMNModdle.Definitions = {} as any; + +// Expect type of process or undefined +const maybeProcess = definition.rootElements.find(i => i.$type === "bpmn:Process"); + +// Expect process to have additional typings to base element1 +const process = maybeProcess as BPMNModdle.Process; diff --git a/types/bpmn-moddle/index.d.cts b/types/bpmn-moddle/v9/index.d.cts similarity index 99% rename from types/bpmn-moddle/index.d.cts rename to types/bpmn-moddle/v9/index.d.cts index 2395f535a98547..12d801cd6a577e 100644 --- a/types/bpmn-moddle/index.d.cts +++ b/types/bpmn-moddle/v9/index.d.cts @@ -13,8 +13,8 @@ declare namespace BPMNModdle { | "middle_initiating" | "bottom_initiating" | "top_non_initiating" - | "middle_ non_initiating" - | "bottom_ non_initiating"; + | "middle_non_initiating" + | "bottom_non_initiating"; type MessageVisibleKind = "initiating" | "non_initiating"; diff --git a/types/bpmn-moddle/v9/index.d.ts b/types/bpmn-moddle/v9/index.d.ts new file mode 100644 index 00000000000000..8ba7ba4d79af55 --- /dev/null +++ b/types/bpmn-moddle/v9/index.d.ts @@ -0,0 +1,1046 @@ +/* eslint-disable @typescript-eslint/no-empty-interface */ +declare namespace BPMNModdle { + type AdHocOrdering = "Parallel" | "Sequential"; + type AssociationDirection = "None" | "One" | "Both"; + type ChoreographyLoopType = "None" | "Standard" | "MultiInstanceSequential" | "MultiInstanceParallel"; + type EventBasedGatewayType = "Parallel" | "Exclusive"; + type GatewayDirection = "Unspecified" | "Converging" | "Diverging" | "Mixed"; + type ItemKind = "Physical" | "Information"; + type MultiInstanceBehavior = "None" | "One" | "All" | "Complex"; + type RelationshipDirection = "None" | "Forward" | "Backward" | "Both"; + type ParticipantBandKind = + | "top_initiating" + | "middle_initiating" + | "bottom_initiating" + | "top_non_initiating" + | "middle_non_initiating" + | "bottom_non_initiating"; + + type MessageVisibleKind = "initiating" | "non_initiating"; + + interface TypeDerived { + $type: ElementType; + $parent?: TypeDerived; + } + interface BaseElement extends TypeDerived { + /** + * Is the primary Id of the element + */ + id: string; + + /** + * Documentation for the element + */ + documentation?: Documentation[] | undefined; + + /** + * Reference to the extension definitions for this element + */ + extensionDefinitions?: ExtensionDefinition[] | undefined; + + /** + * Extension Elements + */ + extensionElements?: ExtensionElements | undefined; + + /** + * Attributes that aren't defined by the BPMN Spec such + * as Camunda properties + */ + $attrs?: Record | undefined; + } + + interface RootElement extends BaseElement {} + interface Interface extends RootElement { + name: string; + operations: Operation[]; + implementationRef: string; + } + + interface Operation extends BaseElement { + name: string; + inMessageRef: Message; + outMessageRef: Message; + errorRef: ErrorElement; + implementationRef: string; + } + + interface EndPoint extends RootElement {} + interface Auditing extends BaseElement {} + interface CallableElement extends RootElement { + name: string; + ioSpecification: InputOutputSpecification; + supportedInterfaceRef: Interface; + ioBinding: InputOutputBinding; + } + interface ResourceRole extends BaseElement { + name: string; + resourceRef: Resource; + ResourceParameterBindings: ResourceParameterBinding[]; + resourceAssignmentExpression: ResourceAssignmentExpression; + } + interface GlobalTask extends CallableElement { + resources: ResourceRole; + } + interface Monitoring extends BaseElement {} + + interface Performer extends ResourceRole {} + interface Process extends FlowElementsContainer, CallableElement { + processType: string; + isClosed: boolean; + auditing: Auditing; + monitoring: Monitoring; + properties: Property[]; + laneSets: LaneSet[]; + flowElements: FlowElement[]; + artifacts: Artifact[]; + resources: ResourceRole[]; + correlationSubscriptions: CorrelationSubscription[]; + supports: Process[]; + definitionalCollaborationRef: Collaboration; + isExecutable: boolean; + } + interface LaneSet extends BaseElement { + lanes: Lane[]; + name: string; + } + interface Lane extends BaseElement { + name: string; + partitionElementRef: BaseElement; + partitionElement: BaseElement; + flowNodeRef: FlowNode[]; + childLaneSet: LaneSet; + } + interface GlobalManualTask extends GlobalTask {} + interface ManualTask extends Task {} + interface UserTask extends Task { + renderings: Rendering[]; + implementation: string; + } + interface Rendering extends BaseElement {} + interface HumanPerformer extends Performer {} + interface PotentialOwner extends Performer {} + interface GlobalUserTask extends GlobalTask { + implementation: string; + renderings: Rendering; + } + interface Gateway extends FlowNode { + /** + * @default Unspecified + */ + gatewayDirection: GatewayDirection; + } + interface EventBasedGateway extends Gateway { + instantiate: boolean; + /** + * @default Exclusive + */ + eventGatewayType: EventBasedGatewayType; + } + interface ComplexGateway extends Gateway { + activationCondition: Expression; + default: SequenceFlow; + } + interface ExclusiveGateway extends Gateway { + default: SequenceFlow; + } + interface InclusiveGateway extends Gateway { + default: SequenceFlow; + } + interface ParallelGateway extends Gateway {} + interface Relationship extends BaseElement { + type: string; + direction: RelationshipDirection; + source: BaseElement[]; + target: BaseElement[]; + } + interface Extension extends TypeDerived { + /** + * @default false + */ + mustUnderstand: boolean; + definition: ExtensionDefinition; + } + interface ExtensionDefinition extends TypeDerived { + name: string; + extensionAttributeDefinitions: ExtensionAttributeDefinition[]; + } + interface ExtensionAttributeDefinition extends TypeDerived { + name: string; + type: string; + /** + * @default false + */ + isReference: boolean; + } + interface ExtensionElements extends TypeDerived { + valueRef: BaseElement; + values: BaseElement[]; + extensionAttributeDefinition: ExtensionAttributeDefinition; + [key: string]: any; + } + interface Documentation extends BaseElement { + text: string; + /** + * @default "text/plain" + */ + textFormat: string; + } + interface Event extends FlowNode, InteractionNode { + properties: Property[]; + } + interface IntermediateCatchEvent extends CatchEvent {} + interface IntermediateThrowEvent extends ThrowEvent {} + interface EndEvent extends ThrowEvent {} + interface StartEvent extends CatchEvent { + /** + * @default true + */ + isInterrupting: boolean; + } + interface ThrowEvent extends Event { + dataInputs: DataInput[]; + dataInputAssociations: DataInputAssociation[]; + inputSet: InputSet; + eventDefinitions: EventDefinition[]; + eventDefinitionRef: EventDefinition[]; + } + interface CatchEvent extends Event { + /** + * @default false + */ + parallelMultiple: boolean; + dataOutputs: DataOutput[]; + dataOutputAssociations: DataOutputAssociation[]; + outputSet: OutputSet; + eventDefinitions: EventDefinition[]; + } + interface BoundaryEvent extends CatchEvent { + /** + * @default true + */ + cancelActivity: boolean; + attachedToRef: Activity; + } + + interface EventDefinition extends RootElement {} + interface CancelEventDefinition extends EventDefinition {} + interface ErrorEventDefinition extends EventDefinition { + errorRef: ErrorElement; + } + interface TerminateEventDefinition extends EventDefinition {} + interface EscalationEventDefinition extends EventDefinition { + escalationRef: Escalation; + } + interface Escalation extends RootElement { + structureRef: ItemDefinition; + name: string; + escalationCode: string; + } + interface CompensateEventDefinition extends EventDefinition { + waitForCompletion: boolean; + activityRef: Activity; + } + interface TimerEventDefinition extends EventDefinition { + timeDate: Expression; + timeCycle: Expression; + timeDuration: Expression; + } + interface LinkEventDefinition extends EventDefinition { + name: string; + target: LinkEventDefinition; + source: LinkEventDefinition; + } + interface MessageEventDefinition extends EventDefinition { + messageRef: Message; + operationRef: Operation; + } + interface ConditionalEventDefinition extends EventDefinition { + condition: Expression; + } + interface SignalEventDefinition extends EventDefinition { + signalRef: Signal; + } + interface Signal extends RootElement { + structureRef: ItemDefinition; + name: string; + } + interface ImplicitThrowEvent extends ThrowEvent {} + interface DataState extends BaseElement { + name: string; + } + interface ItemAwareElement extends BaseElement { + itemSubjectRef: ItemDefinition; + dataState: DataState; + } + interface DataAssociation extends BaseElement { + assignment: Assignment; + sourceRef: ItemAwareElement; + targetRef: ItemAwareElement; + transformation: FormalExpression; + } + interface DataInput extends ItemAwareElement { + name: string; + /** @default false */ + isCollection: boolean; + inputSetRef: InputSet; + inputSetWithOptional: InputSet; + inputSetWithWhileExecuting: InputSet; + } + interface DataOutput extends ItemAwareElement { + name: string; + /** + * @default false + */ + isCollection: boolean; + outputSetRef: InputSet[]; + outputSetWithOptional: InputSet[]; + outputSetWithWhileExecuting: InputSet[]; + } + interface InputSet extends BaseElement { + name: string; + dataInputRefs: DataInput[]; + optionalInputRefs: DataInput[]; + whileExecutingInputsRefs: DataInput[]; + outputSetRefs: OutputSet[]; + } + interface OutputSet extends BaseElement { + dataOutputRefs: DataOutput[]; + name: string; + inputSetRefs: InputSet[]; + optionalOutputRefs: DataOutput[]; + whileExecutingOutputREfs: DataOutput[]; + } + interface Property extends ItemAwareElement { + name: string; + } + interface DataInputAssociation extends DataAssociation {} + interface DataOutputAssociation extends DataAssociation {} + interface InputOutputSpecification extends BaseElement { + dataInputs: DataInput[]; + dataOutputs: DataOutput[]; + inputSets: InputSet[]; + outputSets: OutputSet[]; + } + interface DataObject extends FlowElement, ItemAwareElement { + /** @default false */ + isCollection: boolean; + } + interface InputOutputBinding extends TypeDerived { + inputDataRef: InputSet; + outputDataRef: OutputSet; + operationRef: Operation; + } + interface Assignment extends BaseElement { + from: Expression; + to: Expression; + } + interface DataStore extends RootElement, ItemAwareElement { + name: string; + capacity: number; + isUnlimited: boolean; + } + interface DataStoreReference extends FlowElement, ItemAwareElement { + dataStoreRef: DataStore; + } + interface DataObjectReference extends ItemAwareElement, FlowElement { + dataObjectRef: DataObject; + } + interface ConversationLink extends BaseElement { + sourceRef: InteractionNode; + targetRef: InteractionNode; + name: string; + } + + interface ConversationAssociation extends ConversationNode { + innerConversationNodeRef: ConversationNode; + outerConversationNodeRef: ConversationNode; + } + interface CallConversation extends ConversationNode { + calledCollaborationRef: Collaboration; + participantAssociations: ParticipantAssociation[]; + } + interface Conversation extends ConversationNode {} + interface SubConversation extends ConversationNode { + conversationNodes: ConversationNode[]; + } + interface ConversationNode extends InteractionNode, BaseElement { + name: string; + participantRefs: Participant[]; + messageFlowRefs: MessageFlow[]; + correlationKeys: CorrelationKey[]; + } + interface GlobalConversation extends Collaboration {} + interface PartnerEntity extends RootElement { + name: string; + participantRef: Participant[]; + } + interface PartnerRole extends RootElement { + name: string; + participantRef: Participant[]; + } + + interface CorrelationProperty extends RootElement { + correlationPropertyRetrievalExpression: CorrelationPropertyRetrievalExpression; + name: string; + type: ItemDefinition; + } + interface ErrorElement extends RootElement { + structureRef: ItemDefinition; + name: string; + errorCode: string; + } + interface CorrelationKey extends BaseElement { + correlationPropertyRef: CorrelationProperty; + name: string; + } + interface Expression extends BaseElement { + body: string; + } + interface FormalExpression extends Expression { + language: string; + evaluatesToTypeRef: ItemDefinition; + } + interface Message extends RootElement { + name: string; + itemRef: ItemDefinition; + } + interface ItemDefinition extends RootElement { + itemKind: ItemKind; + structureRef: string; + /** @default false */ + isCollection: boolean; + import: Import; + } + interface FlowElement extends RootElement { + name?: string | undefined; + auditing: Auditing; + monitoring: Monitoring; + categoryValueRef: CategoryValue[]; + } + interface SequenceFlow extends FlowElement { + isImmediate: boolean; + conditionExpression: Expression; + sourceRef: FlowNode; + targetRef: FlowNode; + } + interface FlowElementsContainer extends BaseElement { + laneSets: LaneSet[]; + flowElements: FlowElement[]; + } + interface FlowNode extends FlowElement { + incoming: SequenceFlow[]; + outgoing: SequenceFlow[]; + lanes: Lane[]; + } + interface CorrelationPropertyRetrievalExpression extends BaseElement { + messagePath: FormalExpression; + messageRef: Message; + } + interface CorrelationPropertyBinding extends BaseElement { + dataPath: FormalExpression; + correlationPropertyRef: CorrelationProperty; + } + interface Resource extends RootElement { + name: string; + resourceParameters: ResourceParameter[]; + } + interface ResourceParameter extends BaseElement { + name: string; + isRequired: boolean; + type: ItemDefinition; + } + interface CorrelationSubscription extends BaseElement { + correlationKeyRef: CorrelationKey; + correlationPropertyBinding: CorrelationKey[]; + } + interface MessageFlow extends BaseElement { + name: string; + sourceRef: InteractionNode; + targetRef: InteractionNode; + messageRef: Message; + } + interface MessageFlowAssociation extends BaseElement { + innerMessageFlowRef: MessageFlow; + outerMessageFlowRef: MessageFlow; + } + interface InteractionNode extends TypeDerived { + incomingConversationLinks: ConversationLink[]; + outgoingConversationLinks: ConversationLink[]; + } + interface Participant extends InteractionNode, BaseElement { + name: string; + interfaceRef: Interface[]; + participantMultiplicity: ParticipantMultiplicity; + endPointRefs: EndPoint[]; + processRef: Process; + } + interface ParticipantAssociation extends BaseElement { + innerParticipantRef: Participant; + outerParticipantRef: Participant; + } + interface ParticipantMultiplicity extends BaseElement { + minimum: number; + maximum: number; + } + interface Collaboration extends RootElement { + name: string; + isClosed: boolean; + participants: Participant[]; + messageFlows: MessageFlow[]; + artifacts: Artifact[]; + conversations: ConversationNode[]; + conversationAssociations: ConversationAssociation[]; + participantAssociations: ParticipantAssociation[]; + messageFlowAssociations: MessageFlowAssociation[]; + correlationKeys: CorrelationKey[]; + choreographyRef: Choreography[]; + conversationLinks: ConversationLink[]; + } + interface ChoreographyActivity extends FlowNode { + participantRef: Participant[]; + initiatingParticipantRef: Participant; + correlationKeys: CorrelationKey[]; + loopType: ChoreographyLoopType; + } + interface CallChoreography extends ChoreographyActivity { + calledChoreographyRef: Choreography; + participantAssociations: ParticipantAssociation[]; + } + interface SubChoreography extends ChoreographyActivity, FlowElementsContainer { + artifacts: Artifact[]; + } + interface ChoreographyTask extends ChoreographyActivity { + messageFlowRef: MessageFlow[]; + } + interface Choreography extends FlowElementsContainer, Collaboration {} + interface GlobalChoreographyTask extends Choreography { + initiatingParticipantRef: Participant; + } + interface TextAnnotation extends Artifact { + text: string; + textFormat: string; + } + interface Group extends Artifact { + categoryValueRef: CategoryValue; + } + interface Association extends Artifact { + associationDirection: AssociationDirection; + sourceRef: BaseElement; + targetRef: BaseElement; + } + interface Category extends RootElement { + categoryValue: CategoryValue; + name: string; + } + interface Artifact extends BaseElement {} + interface CategoryValue extends BaseElement { + categorizedFlowElements: FlowElement[]; + value: string; + } + interface Activity extends FlowNode { + isForCompensation: boolean; + default: SequenceFlow; + ioSpecification: InputOutputSpecification; + boundaryEventRefs: BoundaryEvent[]; + properties: Property[]; + dataInputAssociations: DataInputAssociation[]; + dataOutputAssociations: DataOutputAssociation[]; + startQuantity: number; + resources: ResourceRole; + completionQuantity: number; + loopCharacteristics: LoopCharacteristics; + } + interface ServiceTask extends Task { + implementation: string; + operationRef: Operation; + } + interface SubProcess extends Activity, FlowElementsContainer, InteractionNode { + triggeredByEvent: boolean; + artifacts: Artifact[]; + } + interface LoopCharacteristics extends BaseElement {} + interface MultiInstanceLoopCharacteristics extends LoopCharacteristics { + isSequential: boolean; + behavior: MultiInstanceBehavior; + loopCardinality: Expression; + loopDataInputRef: ItemAwareElement; + loopDataOutputRef: ItemAwareElement; + inputDataItem: DataInput; + outputDataItem: DataOutput; + complexBehaviorDefinition: ComplexBehaviorDefinition; + completionCondition: Expression; + oneBehaviorEventRef: EventDefinition; + noneBehaviorEventRef: EventDefinition; + } + interface StandardLoopCharacteristics extends LoopCharacteristics { + testBefore: boolean; + loopCondition: Expression; + loopMaximum: Expression; + } + interface CallActivity extends Activity { + calledElement: string; + } + interface Task extends Activity, InteractionNode {} + interface SendTask extends Task { + implementation: string; + operationRef: Operation; + messageRef: Message; + } + interface ReceiveTask extends Task { + implementation: string; + instantiate: boolean; + operationRef: Operation; + messageRef: Message; + } + interface ScriptTask extends Task { + scriptFormat: string; + script: string; + } + interface BusinessRuleTask extends Task { + implementation: string; + } + interface AdHocSubProcess extends SubProcess { + completionCondition: Expression; + ordering: AdHocOrdering; + cancelRemainingInstances: boolean; + } + interface Transaction extends SubProcess { + protocol: string; + method: string; + } + interface GlobalScriptTask extends GlobalTask { + scriptLanguage: string; + script: string; + } + interface GlobalBusinessRuleTask extends GlobalTask { + implementation: string; + } + interface ComplexBehaviorDefinition extends BaseElement { + condition: FormalExpression; + event: ImplicitThrowEvent; + } + interface ResourceParameterBinding extends TypeDerived { + expression: Expression; + parameterRef: ResourceParameter; + } + interface ResourceAssignmentExpression extends BaseElement { + expression: Expression; + } + interface Import extends TypeDerived { + importType: string; + location: string; + namespace: string; + } + interface Definitions extends BaseElement { + name: string; + targetNamespace: string; + expressionLanguage: string; + typeLanguage: string; + imports: Import[]; + extensions: Extension[]; + rootElements: RootElement[]; + diagrams: BPMNDiagram[]; + er: string; + relationship: Relationship[]; + erVersion: string; + } + interface BPMNDiagram extends Diagram { + plane: BPMNPlane; + labelStyle: BPMNLabelStyle[]; + } + interface BPMNPlane extends Plane { + bpmnElement?: BaseElement; + planeElement: (BPMNShape | BPMNEdge)[]; + } + interface BPMNShape extends LabeledShape { + isHorizontal?: boolean; + isExpanded?: boolean; + isMarkerVisible?: boolean; + participantBandKind?: ParticipantBandKind; + isMessageVisible?: boolean; + choreographyActivityShape?: BPMNShape; + bpmnElement?: BaseElement; + label?: BPMNLabel; + } + + interface BPMNEdge extends LabeledEdge { + label?: BPMNLabel; + bpmnElement?: BaseElement; + sourceElement?: BPMNShape | BPMNEdge; + targetElement?: BPMNShape | BPMNEdge; + messageVisibleKind?: MessageVisibleKind; + } + + interface BPMNLabel extends Label { + labelStyle?: BPMNLabelStyle; + } + + interface BPMNLabelStyle extends Style { + font: Font; + } + interface Font extends TypeDerived { + name?: string; + size?: number; + isBold?: boolean; + isItalic?: boolean; + isUnderline?: boolean; + isStrikeThrough?: boolean; + } + interface Point extends TypeDerived { + /** + * @default 0 + */ + x: number; + /** + * @default 0 + */ + y: number; + } + interface Bounds extends TypeDerived { + /** + * @default 0 + */ + x: number; + /** + * @default Unspecified + */ + y: number; + width: number; + height: number; + } + interface DiagramElement extends TypeDerived {} + interface Node extends DiagramElement {} + interface Edge extends DiagramElement { + waypoint: Point[]; + } + interface Diagram extends TypeDerived { + name?: string; + documentation?: string; + resolution?: number; + } + interface Shape extends Node { + bounds: Bounds; + } + interface Plane extends Node { + planeElement: DiagramElement[]; + } + interface LabeledEdge extends Edge {} + interface LabeledShape extends Shape {} + interface Label extends Node { + bounds: Bounds; + } + interface Style extends TypeDerived {} + interface ColoredShape extends TypeDerived {} + interface ColoredEdge extends TypeDerived {} + + interface ElementTypes { + "bpmn:Interface": Interface; + "bpmn:Operation": Operation; + "bpmn:EndPoint": EndPoint; + "bpmn:Auditing": Auditing; + "bpmn:GlobalTask": GlobalTask; + "bpmn:Monitoring": Monitoring; + "bpmn:Performer": Performer; + "bpmn:Process": Process; + "bpmn:LaneSet": LaneSet; + "bpmn:Lane": Lane; + "bpmn:GlobalManualTask": GlobalManualTask; + "bpmn:ManualTask": ManualTask; + "bpmn:UserTask": UserTask; + "bpmn:Rendering": Rendering; + "bpmn:HumanPerformer": HumanPerformer; + "bpmn:PotentialOwner": PotentialOwner; + "bpmn:GlobalUserTask": GlobalUserTask; + "bpmn:Gateway": Gateway; + "bpmn:EventBasedGateway": EventBasedGateway; + "bpmn:ComplexGateway": ComplexGateway; + "bpmn:ExclusiveGateway": ExclusiveGateway; + "bpmn:InclusiveGateway": InclusiveGateway; + "bpmn:ParallelGateway": ParallelGateway; + "bpmn:RootElement": RootElement; + "bpmn:Relationship": Relationship; + "bpmn:BaseElement": BaseElement; + "bpmn:Extension": Extension; + "bpmn:ExtensionDefinition": ExtensionDefinition; + "bpmn:ExtensionAttributeDefinition": ExtensionAttributeDefinition; + "bpmn:ExtensionElements": ExtensionElements; + "bpmn:Documentation": Documentation; + "bpmn:Event": Event; + "bpmn:IntermediateCatchEvent": IntermediateCatchEvent; + "bpmn:IntermediateThrowEvent": IntermediateThrowEvent; + "bpmn:EndEvent": EndEvent; + "bpmn:StartEvent": StartEvent; + "bpmn:ThrowEvent": ThrowEvent; + "bpmn:CatchEvent": CatchEvent; + "bpmn:BoundaryEvent": BoundaryEvent; + "bpmn:EventDefinition": EventDefinition; + "bpmn:CancelEventDefinition": CancelEventDefinition; + "bpmn:ErrorEventDefinition": ErrorEventDefinition; + "bpmn:TerminateEventDefinition": TerminateEventDefinition; + "bpmn:EscalationEventDefinition": EscalationEventDefinition; + "bpmn:Escalation": Escalation; + "bpmn:CompensateEventDefinition": CompensateEventDefinition; + "bpmn:TimerEventDefinition": TimerEventDefinition; + "bpmn:LinkEventDefinition": LinkEventDefinition; + "bpmn:MessageEventDefinition": MessageEventDefinition; + "bpmn:ConditionalEventDefinition": ConditionalEventDefinition; + "bpmn:SignalEventDefinition": SignalEventDefinition; + "bpmn:Signal": Signal; + "bpmn:ImplicitThrowEvent": ImplicitThrowEvent; + "bpmn:DataState": DataState; + "bpmn:ItemAwareElement": ItemAwareElement; + "bpmn:DataAssociation": DataAssociation; + "bpmn:DataInput": DataInput; + "bpmn:DataOutput": DataOutput; + "bpmn:InputSet": InputSet; + "bpmn:OutputSet": OutputSet; + "bpmn:Property": Property; + "bpmn:DataInputAssociation": DataInputAssociation; + "bpmn:DataOutputAssociation": DataOutputAssociation; + "bpmn:InputOutputSpecification": InputOutputSpecification; + "bpmn:DataObject": DataObject; + "bpmn:InputOutputBinding": InputOutputBinding; + "bpmn:Assignment": Assignment; + "bpmn:DataStore": DataStore; + "bpmn:DataStoreReference": DataStoreReference; + "bpmn:DataObjectReference": DataObjectReference; + "bpmn:ConversationLink": ConversationLink; + "bpmn:ConversationAssociation": ConversationAssociation; + "bpmn:CallConversation": CallConversation; + "bpmn:Conversation": Conversation; + "bpmn:SubConversation": SubConversation; + "bpmn:ConversationNode": ConversationNode; + "bpmn:GlobalConversation": GlobalConversation; + "bpmn:PartnerEntity": PartnerEntity; + "bpmn:PartnerRole": PartnerRole; + "bpmn:CorrelationProperty": CorrelationProperty; + "bpmn:Error": ErrorElement; + "bpmn:CorrelationKey": CorrelationKey; + "bpmn:Expression": Expression; + "bpmn:FormalExpression": FormalExpression; + "bpmn:Message": Message; + "bpmn:ItemDefinition": ItemDefinition; + "bpmn:FlowElement": FlowElement; + "bpmn:SequenceFlow": SequenceFlow; + "bpmn:FlowElementsContainer": FlowElementsContainer; + "bpmn:CallableElement": CallableElement; + "bpmn:FlowNode": FlowNode; + "bpmn:CorrelationPropertyRetrievalExpression": CorrelationPropertyRetrievalExpression; + "bpmn:CorrelationPropertyBinding": CorrelationPropertyBinding; + "bpmn:Resource": Resource; + "bpmn:ResourceParameter": ResourceParameter; + "bpmn:CorrelationSubscription": CorrelationSubscription; + "bpmn:MessageFlow": MessageFlow; + "bpmn:MessageFlowAssociation": MessageFlowAssociation; + "bpmn:InteractionNode": InteractionNode; + "bpmn:Participant": Participant; + "bpmn:ParticipantAssociation": ParticipantAssociation; + "bpmn:ParticipantMultiplicity": ParticipantMultiplicity; + "bpmn:Collaboration": Collaboration; + "bpmn:ChoreographyActivity": ChoreographyActivity; + "bpmn:CallChoreography": CallChoreography; + "bpmn:SubChoreography": SubChoreography; + "bpmn:ChoreographyTask": ChoreographyTask; + "bpmn:Choreography": Choreography; + "bpmn:GlobalChoreographyTask": GlobalChoreographyTask; + "bpmn:TextAnnotation": TextAnnotation; + "bpmn:Group": Group; + "bpmn:Association": Association; + "bpmn:Category": Category; + "bpmn:Artifact": Artifact; + "bpmn:CategoryValue": CategoryValue; + "bpmn:Activity": Activity; + "bpmn:ServiceTask": ServiceTask; + "bpmn:SubProcess": SubProcess; + "bpmn:LoopCharacteristics": LoopCharacteristics; + "bpmn:MultiInstanceLoopCharacteristics": MultiInstanceLoopCharacteristics; + "bpmn:StandardLoopCharacteristics": StandardLoopCharacteristics; + "bpmn:CallActivity": CallActivity; + "bpmn:Task": Task; + "bpmn:SendTask": SendTask; + "bpmn:ReceiveTask": ReceiveTask; + "bpmn:ScriptTask": ScriptTask; + "bpmn:BusinessRuleTask": BusinessRuleTask; + "bpmn:AdHocSubProcess": AdHocSubProcess; + "bpmn:Transaction": Transaction; + "bpmn:GlobalScriptTask": GlobalScriptTask; + "bpmn:GlobalBusinessRuleTask": GlobalBusinessRuleTask; + "bpmn:ComplexBehaviorDefinition": ComplexBehaviorDefinition; + "bpmn:ResourceRole": ResourceRole; + "bpmn:ResourceParameterBinding": ResourceParameterBinding; + "bpmn:ResourceAssignmentExpression": ResourceAssignmentExpression; + "bpmn:Import": Import; + "bpmn:Definitions": Definitions; + "bpmndi:BPMNDiagram": BPMNDiagram; + "bpmndi:BPMNPlane": BPMNPlane; + "bpmndi:BPMNShape": BPMNShape; + "bpmndi:BPMNEdge": BPMNEdge; + "bpmndi:BPMNLabel": BPMNLabel; + "bpmndi:BPMNLabelStyle": BPMNLabelStyle; + "dc:boolean": boolean; + "dc:number": number; + "dc:Real": any; + "dc:string": string; + "dc:Font": Font; + "dc:Point": Point; + "dc:Bounds": Bounds; + "di:DiagramElement": DiagramElement; + "di:Node": Node; + "di:Edge": Edge; + "di:Diagram": Diagram; + "di:Shape": Shape; + "di:Plane": Plane; + "di:LabeledEdge": LabeledEdge; + "di:LabeledShape": LabeledShape; + "di:Label": Label; + "di:Style": Style; + "di:Extension": Extension; + "bioc:ColoredShape": ColoredShape; + "bioc:ColoredEdge": ColoredEdge; + } + + type ElementType = keyof ElementTypes; + + type Option = Record; + + interface BPMNModdleConstructor { + new(packages?: any, options?: Option): BPMNModdle; + } + + interface Moddle { + /** + * Create an instance of the specified type. + * + * @example + * + * var foo = moddle.create('my:Foo'); + * var bar = moddle.create('my:Bar', { id: 'BAR_1' }); + * + * @param descriptor the type descriptor or name know to the model + * @param attrs a number of attributes to initialize the model instance with + * @return model instance + */ + create(descriptor: K, attrs?: any): T[K]; + create(descriptor: any, attrs?: any): BaseElement; + + /** + * Returns the type representing a given descriptor + * + * @example + * + * var Foo = moddle.getType('my:Foo'); + * var foo = new Foo({ 'id' : 'FOO_1' }); + * + * @param descriptor the type descriptor or name know to the model + * @return the type representing the descriptor + */ + getType(descriptor: any): any; + + /** + * Creates an any-element type to be used within model instances. + * + * This can be used to create custom elements that lie outside the meta-model. + * The created element contains all the meta-data required to serialize it + * as part of meta-model elements. + * + * @example + * + * var foo = moddle.createAny('vendor:Foo', 'http://vendor', { + * value: 'bar' + * }); + * + * var container = moddle.create('my:Container', 'http://my', { + * any: [ foo ] + * }); + * + * // go ahead and serialize the stuff + * + * @param name the name of the element + * @param nsUri the namespace uri of the element + * @param [properties] a map of properties to initialize the instance with + * @return the any type instance + */ + createAny(name: string, nsUri: string, properties: any): any; + + /** + * Returns a registered package by uri or prefix + * + * @return the package + */ + getPackage(uriOrPrefix: any): any; + + /** + * Returns a snapshot of all known packages + * + * @return the package + */ + getPackages(): any; + /** + * Returns the descriptor for an element + */ + getElementDescriptor(element: any): any; + + /** + * Returns true if the given descriptor or instance + * represents the given type. + * + * May be applied to this, if element is omitted. + */ + hasType(element: any, type: string): any; + + /** + * Returns the descriptor of an elements named property + */ + getPropertyDescriptor(element: any, property: any): any; + /** + * Returns a mapped type's descriptor + */ + getTypeDescriptor(type: string): any; + } + + interface BPMNModel { + rootElement: RootElement; + elementsById: Record; + references: BaseElement[]; + warnings: string[]; + } + + interface BPMNModdle extends Moddle { + /** + * Instantiates a BPMN model tree from a given xml string. + * + * @param xmlStr xml string + * @param typeName name of the root element + * @param options options to pass to the underlying reader + * + * @throws ParseError + * @returns BPMNModel + */ + fromXML(xmlStr: string, typeName: string, options: Option): Promise; + + /** + * Instantiates a BPMN model tree from a given xml string. + * + * @param xmlStr + * @param typeNameOrOptions name of the root element or options to pass to the underlying reader + * + * @throws ParseError + * @returns BPMNModel + */ + fromXML(xmlStr: string, typeNameOrOptions?: Option | string): Promise; + + /** + * Serializes a BPMN 2.0 object tree to XML. + * + * @param element The root element, typically an instance of `bpmn:Definitions` + * @param option Options to pass to the underlying writer + * + * @returns {Promise} + */ + toXML(element: RootElement, options?: Option): Promise<{ xml: string }>; + } +} + +declare const BPMNModdle: BPMNModdle.BPMNModdleConstructor; +export default BPMNModdle; diff --git a/types/bpmn-moddle/v9/package.json b/types/bpmn-moddle/v9/package.json new file mode 100644 index 00000000000000..06274c74d84041 --- /dev/null +++ b/types/bpmn-moddle/v9/package.json @@ -0,0 +1,19 @@ +{ + "private": true, + "name": "@types/bpmn-moddle", + "version": "9.0.9999", + "type": "module", + "exports": { + ".": { + "import": "./index.d.ts", + "require": "./index.d.cts" + } + }, + "projects": [ + "https://github.com/bpmn-io/bpmn-moddle" + ], + "devDependencies": { + "@types/bpmn-moddle": "workspace:." + }, + "owners": [] +} diff --git a/types/bpmn-moddle/v9/tsconfig.json b/types/bpmn-moddle/v9/tsconfig.json new file mode 100644 index 00000000000000..2e82b7b24c031e --- /dev/null +++ b/types/bpmn-moddle/v9/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "index.d.cts", + "bpmn-moddle-tests.ts" + ] +}