camunda-bpmn-js 2.1.0 → 2.2.0

package/lib/base/Modeler.d.ts

@@ -0,0 +1,15 @@
+export default class Modeler extends BpmnModeler {
+  /**
+   * @param options
+   *
+   * @returns
+   */
+  getModules(options?: {
+      disableAdjustOrigin?: boolean;
+      disableGrid?: boolean;
+  }): ModuleDeclaration[];
+}
+
+type BaseViewerOptions = import('bpmn-js/lib/BaseViewer').BaseViewerOptions;
+type ModuleDeclaration = import('didi').ModuleDeclaration;
+import BpmnModeler from 'bpmn-js/lib/Modeler';

package/lib/base/Modeler.js

@@ -16,8 +16,14 @@ import {
 } from 'bpmn-js-properties-panel';
 
 /**
+ * @typedef {import('bpmn-js/lib/BaseViewer').BaseViewerOptions} BaseViewerOptions
  *
- * @param {Object} options
+ * @typedef {import('didi').ModuleDeclaration} ModuleDeclaration
+ */
+
+/**
+ *
+ * @param {BaseViewerOptions} options
  */
 export default function Modeler(options = {}) {
   BpmnModeler.call(this, options);
@@ -25,7 +31,15 @@ export default function Modeler(options = {}) {
 
 inherits(Modeler, BpmnModeler);
 
-Modeler.prototype.getModules = function(options) {
+/**
+ * @param { {
+ *  disableAdjustOrigin?: boolean;
+ *  disableGrid?: boolean;
+ * } } [options]
+ *
+ * @returns {ModuleDeclaration[]}
+ */
+Modeler.prototype.getModules = function(options = {}) {
   const modules = BpmnModeler.prototype.getModules.call(this, options);
 
   return [

package/lib/base/NavigatedViewer.d.ts

@@ -0,0 +1,2 @@
+export default NavigatedViewer;
+import NavigatedViewer from 'bpmn-js/lib/NavigatedViewer';

package/lib/base/Viewer.d.ts

@@ -0,0 +1,2 @@
+export default Viewer;
+import Viewer from 'bpmn-js/lib/Viewer';

package/lib/camunda-cloud/ElementTemplatesValidator.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/camunda-cloud/Modeler.d.ts

@@ -0,0 +1,3 @@
+export default class Modeler extends BaseModeler {}
+type BaseViewerOptions = import('bpmn-js/lib/BaseViewer').BaseViewerOptions;
+import BaseModeler from '../base/Modeler';

package/lib/camunda-cloud/Modeler.js

@@ -28,8 +28,11 @@ import {
 } from 'bpmn-js-create-append-anything';
 
 /**
- *
- * @param {Object} options
+ * @typedef {import('bpmn-js/lib/BaseViewer').BaseViewerOptions} BaseViewerOptions
+ */
+
+/**
+ * @param {BaseViewerOptions} options
  */
 export default function Modeler(options = {}) {
 

package/lib/camunda-cloud/NavigatedViewer.d.ts

@@ -0,0 +1,3 @@
+export default class NavigatedViewer extends BaseViewer {}
+type BaseViewerOptions = import('bpmn-js/lib/BaseViewer').BaseViewerOptions;
+import BaseViewer from '../base/NavigatedViewer';

package/lib/camunda-cloud/NavigatedViewer.js

@@ -4,10 +4,12 @@ import BaseViewer from '../base/NavigatedViewer';
 
 import { commonModdleExtensions, commonModules } from './util/commonModules';
 
+/**
+ * @typedef {import('bpmn-js/lib/BaseViewer').BaseViewerOptions} BaseViewerOptions
+ */
 
 /**
- *
- * @param {Object} options
+ * @param {BaseViewerOptions} options
  */
 export default function NavigatedViewer(options = {}) {
 

package/lib/camunda-cloud/Viewer.d.ts

@@ -0,0 +1,3 @@
+export default class Viewer extends BaseViewer {}
+type BaseViewerOptions = import('bpmn-js/lib/BaseViewer').BaseViewerOptions;
+import BaseViewer from '../base/Viewer';

package/lib/camunda-cloud/Viewer.js

@@ -4,10 +4,12 @@ import BaseViewer from '../base/Viewer';
 
 import { commonModdleExtensions, commonModules } from './util/commonModules';
 
+/**
+ * @typedef {import('bpmn-js/lib/BaseViewer').BaseViewerOptions} BaseViewerOptions
+ */
 
 /**
- *
- * @param {Object} options
+ * @param {BaseViewerOptions} options
  */
 export default function Viewer(options = {}) {
 

package/lib/camunda-cloud/features/rules/BpmnRules.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Zeebe rule provider that allows to create boundary events with catch events
+ *
+ * See {@link CustomRules} for the default implementation
+ * of BPMN 2.0 modeling rules provided by bpmn-js.
+ */
+declare class CustomRules extends BpmnRules {
+}
+
+declare namespace CustomRules {
+    export const $inject: string[];
+    export { canAttach };
+}
+
+export default CustomRules;
+type EventBus = import('diagram-js/lib/core/EventBus').default;
+type Element = import('bpmn-js/lib/model/Types').Element;
+type Shape = import('bpmn-js/lib/model/Types').Shape;
+type Point = import('diagram-js/lib/util/Types').Point;
+import BpmnRules from 'bpmn-js/lib/features/rules/BpmnRules';
+
+/**
+ * Zeebe-specific rule that allows attaching intermediate events.
+ *
+ * @param elements
+ * @param target
+ * @param source
+ * @param position
+ *
+ * @return
+ */
+declare function canAttach(elements: Element, target: Shape, source: Element, position: Point): boolean | 'attach';

package/lib/camunda-cloud/features/rules/BpmnRules.js

@@ -22,6 +22,15 @@ import {
   getBoundaryAttachment as isBoundaryAttachment
 } from 'bpmn-js/lib/features/snapping/BpmnSnappingUtil';
 
+/**
+ * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus
+ *
+ * @typedef {import('bpmn-js/lib/model/Types').Element} Element
+ * @typedef {import('bpmn-js/lib/model/Types').Shape} Shape
+ *
+ * @typedef {import('diagram-js/lib/util/Types').Point} Point
+ */
+
 const HIGH_PRIORITY = 5000;
 
 /**
@@ -29,110 +38,124 @@ const HIGH_PRIORITY = 5000;
  *
  * See {@link CustomRules} for the default implementation
  * of BPMN 2.0 modeling rules provided by bpmn-js.
- *
- * @param {EventBus} eventBus
  */
 export default class CustomRules extends BpmnRules {
 
+  /**
+   * @param {EventBus} eventBus
+   */
   constructor(eventBus) {
     super(eventBus);
   }
 
   init() {
     super.init();
+
     this.addRule('shape.attach', HIGH_PRIORITY,(context) => {
-      return this.canAttach(
+      return canAttach(
         context.shape,
         context.target,
         null,
         context.position);
     });
   }
+}
+
+CustomRules.$inject = [ 'eventBus' ];
+
+/**
+ * Zeebe-specific rule that allows attaching intermediate events.
+ *
+ * @param {Element} elements
+ * @param {Shape} target
+ * @param {Element} source
+ * @param {Point} position
+ *
+ * @return {boolean|'attach'}
+ */
+function canAttach(elements, target, source, position) {
+  function isBoundaryEvent(element) {
+    return !isLabel(element) && is(element, 'bpmn:BoundaryEvent');
+  }
+
+  /**
+   * In Zeebe we treat IntermediateCatchEvents as boundary events too,
+   * this must be reflected in the rules.
+   */
+  function isBoundaryCandidate(element) {
+    return isBoundaryEvent(element) || (
+      (
+        is(element, 'bpmn:IntermediateCatchEvent') ||
+        is(element, 'bpmn:IntermediateThrowEvent')
+      ) && !element.parent
+    );
+  }
+
+  function isForCompensation(e) {
+    return getBusinessObject(e).isForCompensation;
+  }
+
+  function isReceiveTaskAfterEventBasedGateway(element) {
+    return (
+      is(element, 'bpmn:ReceiveTask') &&
+      find(element.incoming, function(incoming) {
+        return is(incoming.source, 'bpmn:EventBasedGateway');
+      })
+    );
+  }
 
-  canAttach(elements, target, source, position) {
-    function isBoundaryEvent(element) {
-      return !isLabel(element) && is(element, 'bpmn:BoundaryEvent');
-    }
-
-    /**
-     * In Zeebe we treat IntermediateCatchEvents as boundary events too,
-     * this must be reflected in the rules.
-     */
-    function isBoundaryCandidate(element) {
-      return isBoundaryEvent(element) || (
-        (
-          is(element, 'bpmn:IntermediateCatchEvent') ||
-          is(element, 'bpmn:IntermediateThrowEvent')
-        ) && !element.parent
-      );
-    }
-
-    function isForCompensation(e) {
-      return getBusinessObject(e).isForCompensation;
-    }
-
-    function isReceiveTaskAfterEventBasedGateway(element) {
-      return (
-        is(element, 'bpmn:ReceiveTask') &&
-        find(element.incoming, function(incoming) {
-          return is(incoming.source, 'bpmn:EventBasedGateway');
-        })
-      );
-    }
-
-    if (!Array.isArray(elements)) {
-      elements = [ elements ];
-    }
-
-    // disallow appending as boundary event
-    if (source) {
-      return false;
-    }
-
-    // only (re-)attach one element at a time
-    if (elements.length !== 1) {
-      return false;
-    }
-
-    const element = elements[0];
-
-    // do not attach labels
-    if (isLabel(element)) {
-      return false;
-    }
-
-    // only handle boundary events
-    if (!isBoundaryCandidate(element)) {
-      return false;
-    }
-
-    // allow default move operation
-    if (!target) {
-      return true;
-    }
-
-    // disallow drop on event sub processes
-    if (isEventSubProcess(target)) {
-      return false;
-    }
-
-    // only allow drop on non compensation activities
-    if (!is(target, 'bpmn:Activity') || isForCompensation(target)) {
-      return false;
-    }
-
-    // only attach to subprocess border
-    if (position && !isBoundaryAttachment(position, target)) {
-      return false;
-    }
-
-    // do not attach on receive tasks after event based gateways
-    if (isReceiveTaskAfterEventBasedGateway(target)) {
-      return false;
-    }
-
-    return 'attach';
+  if (!Array.isArray(elements)) {
+    elements = [ elements ];
   }
+
+  // disallow appending as boundary event
+  if (source) {
+    return false;
+  }
+
+  // only (re-)attach one element at a time
+  if (elements.length !== 1) {
+    return false;
+  }
+
+  const element = elements[0];
+
+  // do not attach labels
+  if (isLabel(element)) {
+    return false;
+  }
+
+  // only handle boundary events
+  if (!isBoundaryCandidate(element)) {
+    return false;
+  }
+
+  // allow default move operation
+  if (!target) {
+    return true;
+  }
+
+  // disallow drop on event sub processes
+  if (isEventSubProcess(target)) {
+    return false;
+  }
+
+  // only allow drop on non compensation activities
+  if (!is(target, 'bpmn:Activity') || isForCompensation(target)) {
+    return false;
+  }
+
+  // only attach to subprocess border
+  if (position && !isBoundaryAttachment(position, target)) {
+    return false;
+  }
+
+  // do not attach on receive tasks after event based gateways
+  if (isReceiveTaskAfterEventBasedGateway(target)) {
+    return false;
+  }
+
+  return 'attach';
 }
 
-CustomRules.$inject = [ 'eventBus' ];
+CustomRules.canAttach = canAttach;

package/lib/camunda-cloud/features/rules/index.d.ts

@@ -0,0 +1,6 @@
+declare namespace _default {
+    const __init__: string[];
+    const bpmnRules: (string | typeof BpmnRules)[];
+}
+export default _default;
+import BpmnRules from './BpmnRules';

package/lib/camunda-cloud/util/commonModules.d.ts

@@ -0,0 +1,9 @@
+export const commonModules: any[];
+/**
+ * @type { {
+ *   zeebe: any
+ * } }
+ */
+export const commonModdleExtensions: {
+    zeebe: any;
+};

package/lib/camunda-cloud/util/commonModules.js

@@ -6,6 +6,11 @@ export const commonModules = [
   iconRendererModule
 ];
 
+/**
+ * @type { {
+ *   zeebe: any
+ * } }
+ */
 export const commonModdleExtensions = {
   zeebe: zeebeModdle
 };

package/lib/camunda-platform/Modeler.d.ts

@@ -0,0 +1,3 @@
+export default class Modeler extends BaseModeler {}
+type BaseViewerOptions = import('bpmn-js/lib/BaseViewer').BaseViewerOptions;
+import BaseModeler from '../base/Modeler';

package/lib/camunda-platform/Modeler.js

@@ -18,13 +18,16 @@ import { commonModdleExtensions } from './util/commonModules';
 import colorPickerModule from 'bpmn-js-color-picker';
 
 import {
+  CreateAppendAnythingModule as createAppendAnythingModule,
   UnlinkTemplatesModule as unlinkTemplatesModule
 } from 'bpmn-js-create-append-anything';
 
+/**
+ * @typedef {import('bpmn-js/lib/BaseViewer').BaseViewerOptions} BaseViewerOptions
+ */
 
 /**
- *
- * @param {Object} options
+ * @param {BaseViewerOptions} options
  */
 export default function Modeler(options = {}) {
 
@@ -46,6 +49,7 @@ Modeler.prototype._camundaPlatformModules = [
   CamundaPlatformPropertiesProviderModule,
   ElementTemplatesPropertiesProviderModule,
   colorPickerModule,
+  createAppendAnythingModule,
   variableResolverModule,
   unlinkTemplatesModule
 ];

package/lib/camunda-platform/NavigatedViewer.d.ts

@@ -0,0 +1,5 @@
+export default class NavigatedViewer extends BaseViewer {
+}
+
+type BaseViewerOptions = import('bpmn-js/lib/BaseViewer').BaseViewerOptions;
+import BaseViewer from '../base/NavigatedViewer';

package/lib/camunda-platform/NavigatedViewer.js

@@ -4,10 +4,12 @@ import BaseViewer from '../base/NavigatedViewer';
 
 import { commonModdleExtensions } from './util/commonModules';
 
+/**
+ * @typedef {import('bpmn-js/lib/BaseViewer').BaseViewerOptions} BaseViewerOptions
+ */
 
 /**
- *
- * @param {Object} options
+ * @param {BaseViewerOptions} options
  */
 export default function NavigatedViewer(options = {}) {
 

package/lib/camunda-platform/Viewer.d.ts

@@ -0,0 +1,5 @@
+export default class Viewer extends BaseViewer {
+}
+
+type BaseViewerOptions = import('bpmn-js/lib/BaseViewer').BaseViewerOptions;
+import BaseViewer from '../base/Viewer';

package/lib/camunda-platform/Viewer.js

@@ -5,8 +5,11 @@ import BaseViewer from '../base/Viewer';
 import { commonModdleExtensions } from './util/commonModules';
 
 /**
- *
- * @param {Object} options
+ * @typedef {import('bpmn-js/lib/BaseViewer').BaseViewerOptions} BaseViewerOptions
+ */
+
+/**
+ * @param {BaseViewerOptions} options
  */
 export default function Viewer(options = {}) {
 

package/lib/camunda-platform/util/commonModules.d.ts

@@ -0,0 +1,9 @@
+export const commonModules: any[];
+/**
+ * @type { {
+ *   camunda: any
+ * } }
+ */
+export const commonModdleExtensions: {
+    camunda: any;
+};

package/lib/camunda-platform/util/commonModules.js

@@ -2,6 +2,11 @@ import camundaModdle from 'camunda-bpmn-moddle/resources/camunda.json';
 
 export const commonModules = [];
 
+/**
+ * @type { {
+ *   camunda: any
+ * } }
+ */
 export const commonModdleExtensions = {
   camunda: camundaModdle
 };

package/lib/util/ExtensionElementsUtil.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Get extension elements of element. Optionally filter by type.
+ *
+ * @param  element
+ * @param  type
+ *
+ * @return
+ */
+export function getExtensionElementsList(element: Element | ModdleElement, type?: string): ModdleElement[];
+
+/**
+ * Remove one or more extension elements. Remove bpmn:ExtensionElements
+ * afterwards if it's empty.
+ *
+ * @param element
+ * @param businessObject
+ * @param extensionElementsToRemove
+ * @param commandStack
+ */
+export function removeExtensionElements(element: Element, businessObject: ModdleElement, extensionElementsToRemove: ModdleElement | ModdleElement[], commandStack: CommandStack): void;
+
+type CommandStack = import('diagram-js/lib/command/CommandStack').default;
+type Element = import('bpmn-js/lib/model/Types').Element;
+type ModdleElement = import('bpmn-js/lib/model/Types').ModdleElement;

package/lib/util/ExtensionElementsUtil.js

@@ -6,13 +6,21 @@ import {
 import { isArray } from 'min-dash';
 
 /**
- * Get extension elements of business object. Optionally filter by type.
+ * @typedef {import('diagram-js/lib/command/CommandStack').default} CommandStack
  *
- * @param  {djs.model.Base|ModdleElement} element
- * @param  {String} [type=undefined]
- * @returns {Array<ModdleElement>}
+ * @typedef {import('bpmn-js/lib/model/Types').Element} Element
+ * @typedef {import('bpmn-js/lib/model/Types').ModdleElement} ModdleElement
  */
-export function getExtensionElementsList(element, type = undefined) {
+
+/**
+ * Get extension elements of element. Optionally filter by type.
+ *
+ * @param  {Element|ModdleElement} element
+ * @param  {string} [type]
+ *
+ * @return {ModdleElement[]}
+ */
+export function getExtensionElementsList(element, type) {
   const businessObject = getBusinessObject(element),
         extensionElements = businessObject.get('extensionElements');
 
@@ -34,11 +42,12 @@ export function getExtensionElementsList(element, type = undefined) {
 }
 
 /**
- * Remove one or more extension elements. Remove bpmn:ExtensionElements afterwards if it's empty.
+ * Remove one or more extension elements. Remove bpmn:ExtensionElements
+ * afterwards if it's empty.
  *
- * @param {ModdleElement} element
+ * @param {Element} element
  * @param {ModdleElement} businessObject
- * @param {ModdleElement|Array<ModdleElement>} extensionElementsToRemove
+ * @param {ModdleElement|ModdleElement[]} extensionElementsToRemove
  * @param {CommandStack} commandStack
  */
 export function removeExtensionElements(element, businessObject, extensionElementsToRemove, commandStack) {

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "camunda-bpmn-js",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Embeddable Camunda modeling distributions based on bpmn-js",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
-    "all": "run-s clean lint test distro test:distro",
+    "all": "run-s clean lint test generate-types distro test:distro",
     "lint": "eslint .",
     "dev": "npm test -- --auto-watch --no-single-run",
     "test": "karma start karma.config.js",
@@ -20,8 +21,11 @@
     "start:cloud-viewer": "cross-env SINGLE_START=camunda-cloud-viewer npm run dev",
     "start:platform-navigated-viewer": "cross-env SINGLE_START=camunda-platform-navigated-viewer npm run dev",
     "start:cloud-navigated-viewer": "cross-env SINGLE_START=camunda-cloud-navigated-viewer npm run dev",
-    "prepublishOnly": "run-s test:distro",
-    "prepare": "run-s clean distro"
+    "prepublishOnly": "run-s generate-types test:distro",
+    "prepare": "run-s clean distro",
+    "generate-types": "run-s generate-types:*",
+    "generate-types:generate": "del-cli \"lib/**/*.d.ts\" && bio-dts -r --resolveJsonModule --esModuleInterop lib",
+    "generate-types:test": "tsc --noEmit"
   },
   "repository": {
     "type": "git",
@@ -52,18 +56,19 @@
     "@bpmn-io/element-templates-icons-renderer": "^0.3.0",
     "@bpmn-io/variable-resolver": "^0.1.0",
     "@camunda/example-data-properties-provider": "^1.0.1",
-    "bpmn-js": "^12.0.0",
+    "bpmn-js": "^13.0.4",
     "bpmn-js-color-picker": "^0.5.0",
     "bpmn-js-create-append-anything": "^0.1.0",
     "bpmn-js-executable-fix": "^0.2.0",
     "camunda-bpmn-js-behaviors": "^0.5.0",
     "camunda-bpmn-moddle": "^7.0.1",
-    "diagram-js": "^11.12.0",
+    "diagram-js": "^12.0.2",
     "diagram-js-grid": "^0.2.0",
     "diagram-js-minimap": "^4.0.1",
     "diagram-js-origin": "^1.4.0",
     "inherits-browser": "^0.1.0",
     "min-dash": "^4.0.0",
+    "typescript": "^5.0.4",
     "zeebe-bpmn-moddle": "^0.18.0"
   },
   "devDependencies": {
@@ -75,6 +80,7 @@
     "@rollup/plugin-terser": "^0.4.0",
     "babel-loader": "^9.0.0",
     "babel-plugin-istanbul": "^6.1.1",
+    "bio-dts": "^0.8.0",
     "bpmn-js-connectors-extension": "^0.4.6",
     "bpmn-js-properties-panel": "^1.20.3",
     "chai": "^4.3.7",
@@ -117,7 +123,8 @@
     "dist",
     "lib",
     "styles",
-    "util"
+    "util",
+    "!lib/**/*.spec.ts"
   ],
   "remarkConfig": {
     "plugins": [