@bpmnkit/core 0.1.1 → 0.2.0

package/dist/bpmn/bpmn-model.d.ts

@@ -90,7 +90,16 @@ export type BpmnEventDefinition = BpmnTimerEventDefinition | BpmnErrorEventDefin
 export interface BpmnMultiInstanceLoopCharacteristics {
     /** When true, iterations run one at a time (sequential). When false or absent, runs in parallel. */
     isSequential?: boolean;
+    /** How many instances to create. Losing this turns a bounded loop into an unbounded one. */
+    loopCardinality?: BpmnConditionExpression;
+    /** Stops the loop early once it evaluates true. */
+    completionCondition?: BpmnConditionExpression;
     extensionElements: XmlElement[];
+    /**
+     * Children the SDK does not model, kept verbatim and re-emitted after the
+     * modelled ones so a round trip cannot silently discard them.
+     */
+    unknownChildren?: XmlElement[];
 }
 /** A FEEL condition expression on a sequence flow outgoing from a gateway. */
 export interface BpmnConditionExpression {
@@ -106,6 +115,17 @@ interface BpmnFlowNodeBase {
     extensionElements: XmlElement[];
     unknownAttributes: Record<string, string>;
     isForCompensation?: boolean;
+    /** `bpmn:property` children — placeholders data input associations target. */
+    properties?: BpmnProperty[];
+    /** `bpmn:dataInputAssociation` children. */
+    dataInputAssociations?: BpmnDataAssociation[];
+    /** `bpmn:dataOutputAssociation` children. */
+    dataOutputAssociations?: BpmnDataAssociation[];
+    /**
+     * Children the SDK does not model, kept verbatim and re-emitted after the
+     * modelled ones so a round trip cannot silently discard them.
+     */
+    unknownChildren?: XmlElement[];
 }
 export interface BpmnStartEvent extends BpmnFlowNodeBase {
     type: "startEvent";
@@ -183,6 +203,10 @@ export interface BpmnReceiveTask extends BpmnFlowNodeBase {
 export interface BpmnAdHocSubProcess extends BpmnFlowNodeBase {
     type: "adHocSubProcess";
     loopCharacteristics?: BpmnMultiInstanceLoopCharacteristics;
+    /** FEEL expression evaluated after each tool activity completes; ends the ad-hoc scope when true. */
+    completionCondition?: BpmnConditionExpression;
+    /** Whether still-running inner activity instances are cancelled once the completion condition is met (default true). */
+    cancelRemainingInstances?: boolean;
     flowElements: BpmnFlowElement[];
     sequenceFlows: BpmnSequenceFlow[];
     textAnnotations: BpmnTextAnnotation[];
@@ -274,10 +298,39 @@ export interface BpmnSequenceFlow {
     extensionElements: XmlElement[];
     unknownAttributes: Record<string, string>;
 }
+/**
+ * A `bpmn:property` on a flow node. Modellers emit one per data input
+ * association as the association's `targetRef` placeholder.
+ */
+export interface BpmnProperty {
+    id?: string;
+    name?: string;
+    itemSubjectRef?: string;
+    unknownAttributes: Record<string, string>;
+}
+/**
+ * A `dataInputAssociation` or `dataOutputAssociation` — the wiring between a
+ * flow node and a data object, data store or property.
+ */
+export interface BpmnDataAssociation {
+    id?: string;
+    /** Ids named by `<bpmn:sourceRef>` child elements. */
+    sourceRefs: string[];
+    /** Id named by the `<bpmn:targetRef>` child element. */
+    targetRef?: string;
+    unknownAttributes: Record<string, string>;
+    /**
+     * Children the SDK does not model, kept verbatim and re-emitted after the
+     * modelled ones so a round trip cannot silently discard them.
+     */
+    unknownChildren?: XmlElement[];
+}
 /** A free-text annotation element attached to the diagram via an association. */
 export interface BpmnTextAnnotation {
     id: string;
     text?: string;
+    documentation?: string;
+    extensionElements?: XmlElement[];
     unknownAttributes: Record<string, string>;
 }
 /** A directed or undirected link between a flow element and a text annotation. */
@@ -286,6 +339,8 @@ export interface BpmnAssociation {
     sourceRef: string;
     targetRef: string;
     associationDirection?: string;
+    documentation?: string;
+    extensionElements?: XmlElement[];
     unknownAttributes: Record<string, string>;
 }
 /** A group artifact — a dashed rounded rectangle visually grouping elements. */
@@ -293,6 +348,21 @@ export interface BpmnGroup {
     id: string;
     /** Id of the `categoryValue` supplying the group's label, if any. */
     categoryValueRef?: string;
+    documentation?: string;
+    extensionElements?: XmlElement[];
+    unknownAttributes: Record<string, string>;
+}
+/** A label a {@link BpmnGroup} can point at through `categoryValueRef`. */
+export interface BpmnCategoryValue {
+    id: string;
+    value?: string;
+    unknownAttributes: Record<string, string>;
+}
+/** A root-level container of {@link BpmnCategoryValue}s — the source of group labels. */
+export interface BpmnCategory {
+    id?: string;
+    name?: string;
+    categoryValues: BpmnCategoryValue[];
     unknownAttributes: Record<string, string>;
 }
 /** A swim lane within a pool (organises flow nodes visually). */
@@ -301,12 +371,16 @@ export interface BpmnLane {
     name?: string;
     flowNodeRefs: string[];
     childLaneSet?: BpmnLaneSet;
+    documentation?: string;
+    extensionElements?: XmlElement[];
     unknownAttributes: Record<string, string>;
 }
 /** Container for lanes within a pool or sub-process. */
 export interface BpmnLaneSet {
     id?: string;
+    name?: string;
     lanes: BpmnLane[];
+    unknownAttributes?: Record<string, string>;
 }
 /**
  * A BPMN process definition containing flow elements and sequence flows.
@@ -320,6 +394,7 @@ export interface BpmnProcess {
     id: string;
     name?: string;
     isExecutable?: boolean;
+    documentation?: string;
     extensionElements: XmlElement[];
     flowElements: BpmnFlowElement[];
     sequenceFlows: BpmnSequenceFlow[];
@@ -328,12 +403,19 @@ export interface BpmnProcess {
     groups: BpmnGroup[];
     laneSet?: BpmnLaneSet;
     unknownAttributes: Record<string, string>;
+    /**
+     * Children the SDK does not model, kept verbatim and re-emitted after the
+     * modelled ones so a round trip cannot silently discard them.
+     */
+    unknownChildren?: XmlElement[];
 }
 /** A participant (pool) in a BPMN collaboration diagram. */
 export interface BpmnParticipant {
     id: string;
     name?: string;
     processRef?: string;
+    documentation?: string;
+    extensionElements?: XmlElement[];
     unknownAttributes: Record<string, string>;
 }
 /** A message flow between participants in a collaboration. */
@@ -342,6 +424,10 @@ export interface BpmnMessageFlow {
     name?: string;
     sourceRef: string;
     targetRef: string;
+    /** Id of the {@link BpmnMessage} carried by this flow. */
+    messageRef?: string;
+    documentation?: string;
+    extensionElements?: XmlElement[];
     unknownAttributes: Record<string, string>;
 }
 /** A BPMN collaboration element grouping multiple participants and their message flows. */
@@ -354,29 +440,49 @@ export interface BpmnCollaboration {
     groups: BpmnGroup[];
     extensionElements: XmlElement[];
     unknownAttributes: Record<string, string>;
+    /**
+     * Children the SDK does not model, kept verbatim and re-emitted after the
+     * modelled ones so a round trip cannot silently discard them.
+     */
+    unknownChildren?: XmlElement[];
 }
 /** A root-level BPMN error definition referenced by error boundary events. */
 export interface BpmnError {
     id: string;
     name?: string;
     errorCode?: string;
+    documentation?: string;
+    extensionElements?: XmlElement[];
+    unknownAttributes?: Record<string, string>;
 }
 /** A root-level BPMN escalation definition referenced by escalation events. */
 export interface BpmnEscalation {
     id: string;
     name?: string;
     escalationCode?: string;
+    documentation?: string;
+    extensionElements?: XmlElement[];
+    unknownAttributes?: Record<string, string>;
 }
 /** A root-level BPMN message definition referenced by message events. */
 export interface BpmnMessage {
     id: string;
     name?: string;
+    documentation?: string;
+    /**
+     * Carries `zeebe:subscription`, whose `correlationKey` is what Camunda 8
+     * correlates published messages on.
+     */
+    extensionElements?: XmlElement[];
     unknownAttributes: Record<string, string>;
 }
 /** A root-level BPMN signal definition referenced by signal catch/throw events. */
 export interface BpmnSignal {
     id: string;
     name?: string;
+    documentation?: string;
+    extensionElements?: XmlElement[];
+    unknownAttributes?: Record<string, string>;
 }
 /** Optional label positioning information for a BPMNDi shape or edge. */
 export interface BpmnDiLabel {
@@ -436,6 +542,9 @@ export interface BpmnDefinitions {
     namespaces: Record<string, string>;
     /** Namespace-qualified attributes not directly modeled */
     unknownAttributes: Record<string, string>;
+    documentation?: string;
+    /** Root-level category containers supplying {@link BpmnGroup} labels. */
+    categories?: BpmnCategory[];
     errors: BpmnError[];
     escalations: BpmnEscalation[];
     messages: BpmnMessage[];
@@ -443,6 +552,11 @@ export interface BpmnDefinitions {
     collaborations: BpmnCollaboration[];
     processes: BpmnProcess[];
     diagrams: BpmnDiagram[];
+    /**
+     * Children the SDK does not model, kept verbatim and re-emitted after the
+     * modelled ones so a round trip cannot silently discard them.
+     */
+    unknownChildren?: XmlElement[];
 }
 export {};
 //# sourceMappingURL=bpmn-model.d.ts.map