Update documentation for 3.0.1 patch release

ls1intum · Oct 28, 2023 · 1a6af5d · 1a6af5d
1 parent 7bacfdc
commit 1a6af5d
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 11 deletions.
diff --git a/docs/source/dev/api/diagram-type.d.ts b/docs/source/dev/api/diagram-type.d.ts
@@ -11,4 +11,5 @@ export declare const UMLDiagramType: {
     readonly ReachabilityGraph: "ReachabilityGraph";
     readonly SyntaxTree: "SyntaxTree";
     readonly Flowchart: "Flowchart";
+    readonly BPMN: "BPMN";
 };
diff --git a/docs/source/user/api/typings.d.ts b/docs/source/user/api/typings.d.ts
@@ -8,6 +8,8 @@ import { ApollonMode, Locale } from './services/editor/editor-types';
 import { Direction } from './services/uml-element/uml-element-port';
 import { IBoundary } from './utils/geometry/boundary';
 import { IPath } from './utils/geometry/path';
+import { BPMNGatewayType } from './packages/bpmn/bpmn-gateway/bpmn-gateway';
+import { BPMNConversationType } from './packages/bpmn/bpmn-conversation/bpmn-conversation';
 export { UMLDiagramType, UMLElementType, UMLRelationshipType, ApollonMode, Locale };
 export type { Styles };
 export type ApollonOptions = {
@@ -23,20 +25,30 @@ export type ApollonOptions = {
     scale?: number;
 };
 export type Selection = {
-    elements: {[id: string]: boolean};
-    relationships: {[id: string]: boolean};
+    elements: {
+        [id: string]: boolean;
+    };
+    relationships: {
+        [id: string]: boolean;
+    };
 };
 export type UMLModel = {
-    version: string;
+    version: `3.${number}.${number}`;
     type: UMLDiagramType;
     size: {
         width: number;
         height: number;
     };
-    elements: {[id: string]: UMLElement};
+    elements: {
+        [id: string]: UMLElement;
+    };
     interactive: Selection;
-    relationships: {[id: string]: UMLRelationship};
-    assessments: {[id: string]: Assessment};
+    relationships: {
+        [id: string]: UMLRelationship;
+    };
+    assessments: {
+        [id: string]: Assessment;
+    };
 };
 export type UMLModelElementType = UMLElementType | UMLRelationshipType | UMLDiagramType;
 export type UMLModelElement = {
@@ -79,6 +91,15 @@ export type UMLPetriNetPlace = UMLElement & {
     amountOfTokens: number;
     capacity: number | string;
 };
+export type BPMNGateway = UMLElement & {
+    gatewayType: BPMNGatewayType;
+};
+export type BPMNConversation = UMLElement & {
+    conversationType: BPMNConversationType;
+};
+export type BPMNFlow = UMLRelationship & {
+    flowType: 'sequence' | 'message' | 'association';
+};
 export type UMLReachabilityGraphMarking = UMLElement & {
     isInitialMarking: boolean;
 };
@@ -94,10 +115,12 @@ export type UMLAssociation = UMLRelationship & {
 };
 export type UMLCommunicationLink = UMLRelationship & {
     messages: {
-        id: string;
-        name: string;
-        direction: 'source' | 'target';
-    }[];
+        [id: string]: {
+            id: string;
+            name: string;
+            direction: 'source' | 'target';
+        };
+    };
 };
 export type FeedbackCorrectionStatus = {
     description?: string;
@@ -123,7 +146,6 @@ export type ExportOptions = {
     keepOriginalSize?: boolean;
     include?: string[];
     exclude?: string[];
-    scale?: number;
 };
 export type SVG = {
     svg: string;