bpmn-js 13.2.2 → 14.0.0

package/lib/BaseViewer.d.ts

@@ -11,11 +11,131 @@ export default class BaseViewer extends Diagram {
    */
   constructor(options?: BaseViewerOptions);
 
-  importXML: (xml: string, bpmnDiagram?: ModdleElement | string) => Promise<ImportXMLResult>;
-  importDefinitions: (definitions: ModdleElement, bpmnDiagram?: ModdleElement | string) => Promise<ImportDefinitionsResult>;
-  open: (bpmnDiagramOrId: ModdleElement | string) => Promise<OpenResult>;
-  saveXML: (options?: SaveXMLOptions) => Promise<SaveXMLResult>;
-  saveSVG: () => Promise<SaveSVGResult>;
+  /**
+   * Parse and render a BPMN 2.0 diagram.
+   *
+   * Once finished the viewer reports back the result to the
+   * provided callback function with (err, warnings).
+   *
+   * ## Life-Cycle Events
+   *
+   * During import the viewer will fire life-cycle events:
+   *
+   *   * import.parse.start (about to read model from XML)
+   *   * import.parse.complete (model read; may have worked or not)
+   *   * import.render.start (graphical import start)
+   *   * import.render.complete (graphical import finished)
+   *   * import.done (everything done)
+   *
+   * You can use these events to hook into the life-cycle.
+   *
+   * @throws {ImportXMLError} An error thrown during the import of the XML.
+   *
+   * @fires BaseViewer#ImportParseStartEvent
+   * @fires BaseViewer#ImportParseCompleteEvent
+   * @fires Importer#ImportRenderStartEvent
+   * @fires Importer#ImportRenderCompleteEvent
+   * @fires BaseViewer#ImportDoneEvent
+   *
+   * @param xml The BPMN 2.0 XML to be imported.
+   * @param bpmnDiagram The optional diagram or Id of the BPMN diagram to open.
+   *
+   * @return A promise resolving with warnings that were produced during the import.
+   */
+  importXML(xml: string, bpmnDiagram?: ModdleElement | string): Promise<ImportXMLResult>;
+
+  /**
+   * Import parsed definitions and render a BPMN 2.0 diagram.
+   *
+   * Once finished the viewer reports back the result to the
+   * provided callback function with (err, warnings).
+   *
+   * ## Life-Cycle Events
+   *
+   * During import the viewer will fire life-cycle events:
+   *
+   *   * import.render.start (graphical import start)
+   *   * import.render.complete (graphical import finished)
+   *
+   * You can use these events to hook into the life-cycle.
+   *
+   * @throws {ImportDefinitionsError} An error thrown during the import of the definitions.
+   *
+   * @param definitions The definitions.
+   * @param bpmnDiagram The optional diagram or ID of the BPMN diagram to open.
+   *
+   * @return A promise resolving with warnings that were produced during the import.
+   */
+  importDefinitions(definitions: ModdleElement, bpmnDiagram?: ModdleElement | string): Promise<ImportDefinitionsResult>;
+
+  /**
+   * Open diagram of previously imported XML.
+   *
+   * Once finished the viewer reports back the result to the
+   * provided callback function with (err, warnings).
+   *
+   * ## Life-Cycle Events
+   *
+   * During switch the viewer will fire life-cycle events:
+   *
+   *   * import.render.start (graphical import start)
+   *   * import.render.complete (graphical import finished)
+   *
+   * You can use these events to hook into the life-cycle.
+   *
+   * @throws {OpenError} An error thrown during opening.
+   *
+   * @param bpmnDiagramOrId The diagram or Id of the BPMN diagram to open.
+   *
+   * @return A promise resolving with warnings that were produced during opening.
+   */
+  open(bpmnDiagramOrId: ModdleElement | string): Promise<OpenResult>;
+
+  /**
+   * Export the currently displayed BPMN 2.0 diagram as
+   * a BPMN 2.0 XML document.
+   *
+   * ## Life-Cycle Events
+   *
+   * During XML saving the viewer will fire life-cycle events:
+   *
+   *   * saveXML.start (before serialization)
+   *   * saveXML.serialized (after xml generation)
+   *   * saveXML.done (everything done)
+   *
+   * You can use these events to hook into the life-cycle.
+   *
+   * @throws {Error} An error thrown during export.
+   *
+   * @fires BaseViewer#SaveXMLStart
+   * @fires BaseViewer#SaveXMLDone
+   *
+   * @param options The options.
+   *
+   * @return A promise resolving with the XML.
+   */
+  saveXML(options?: SaveXMLOptions): Promise<SaveXMLResult>;
+
+  /**
+   * Export the currently displayed BPMN 2.0 diagram as
+   * an SVG image.
+   *
+   * ## Life-Cycle Events
+   *
+   * During SVG saving the viewer will fire life-cycle events:
+   *
+   *   * saveSVG.start (before serialization)
+   *   * saveSVG.done (everything done)
+   *
+   * You can use these events to hook into the life-cycle.
+   *
+   * @throws {Error} An error thrown during export.
+   *
+   * @fires BaseViewer#SaveSVGDone
+   *
+   * @return A promise resolving with the SVG.
+   */
+  saveSVG(): Promise<SaveSVGResult>;
 
   /**
    * Return modules to instantiate with.

package/lib/BaseViewer.js

@@ -31,10 +31,6 @@ import {
   importBpmnDiagram
 } from './import/Importer';
 
-import {
-  wrapForCompatibility
-} from './util/CompatibilityUtil';
-
 /**
  * @template T
  *
@@ -192,28 +188,7 @@ BaseViewer.prototype.importXML = async function importXML(xml, bpmnDiagram) {
   const self = this;
 
   function ParseCompleteEvent(data) {
-
-    const event = self.get('eventBus').createEvent(data);
-
-    // TODO(nikku): remove with future bpmn-js version
-    Object.defineProperty(event, 'context', {
-      enumerable: true,
-      get: function() {
-
-        console.warn(new Error(
-          'import.parse.complete <context> is deprecated ' +
-          'and will be removed in future library versions'
-        ));
-
-        return {
-          warnings: data.warnings,
-          references: data.references,
-          elementsById: data.elementsById
-        };
-      }
-    });
-
-    return event;
+    return self.get('eventBus').createEvent(data);
   }
 
   let aggregatedWarnings = [];
@@ -291,8 +266,6 @@ BaseViewer.prototype.importXML = async function importXML(xml, bpmnDiagram) {
   }
 };
 
-BaseViewer.prototype.importXML = wrapForCompatibility(BaseViewer.prototype.importXML);
-
 
 /**
  * Import parsed definitions and render a BPMN 2.0 diagram.
@@ -323,8 +296,6 @@ BaseViewer.prototype.importDefinitions = async function importDefinitions(defini
   return { warnings: result.warnings };
 };
 
-BaseViewer.prototype.importDefinitions = wrapForCompatibility(BaseViewer.prototype.importDefinitions);
-
 
 /**
  * Open diagram of previously imported XML.
@@ -386,8 +357,6 @@ BaseViewer.prototype.open = async function open(bpmnDiagramOrId) {
   return { warnings };
 };
 
-BaseViewer.prototype.open = wrapForCompatibility(BaseViewer.prototype.open);
-
 /**
  * Export the currently displayed BPMN 2.0 diagram as
  * a BPMN 2.0 XML document.
@@ -462,8 +431,6 @@ BaseViewer.prototype.saveXML = async function saveXML(options) {
   return result;
 };
 
-BaseViewer.prototype.saveXML = wrapForCompatibility(BaseViewer.prototype.saveXML);
-
 
 /**
  * Export the currently displayed BPMN 2.0 diagram as
@@ -531,40 +498,6 @@ BaseViewer.prototype.saveSVG = async function saveSVG() {
   return { svg };
 };
 
-BaseViewer.prototype.saveSVG = wrapForCompatibility(BaseViewer.prototype.saveSVG);
-
-/**
- * Get a named diagram service.
- *
- * @example
- *
- * const elementRegistry = viewer.get('elementRegistry');
- * const startEventShape = elementRegistry.get('StartEvent_1');
- *
- * @param {string} name
- *
- * @return {Object} diagram service instance
- *
- * @method BaseViewer#get
- */
-
-/**
- * Invoke a function in the context of this viewer.
- *
- * @example
- *
- * viewer.invoke(function(elementRegistry) {
- *   const startEventShape = elementRegistry.get('StartEvent_1');
- * });
- *
- * @param {Function} fn to be invoked
- *
- * @return {Object} the functions return value
- *
- * @method BaseViewer#invoke
- */
-
-
 BaseViewer.prototype._setDefinitions = function(definitions) {
   this._definitions = definitions;
 };

package/lib/Modeler.d.ts

@@ -66,7 +66,15 @@
 export default class Modeler extends BaseModeler {
   static Viewer: typeof Viewer;
   static NavigatedViewer: typeof NavigatedViewer;
-  createDiagram: () => Promise<ImportXMLResult>;
+
+  /**
+   * Create a new diagram to start modeling.
+   *
+   * @throws {ImportXMLError} An error thrown during the import of the XML.
+   *
+   * @return A promise resolving with warnings that were produced during the import.
+   */
+  createDiagram(): Promise<ImportXMLResult>;
 }
 
 type BaseViewerOptions = import('./BaseViewer').BaseViewerOptions;

package/lib/Modeler.js

@@ -28,6 +28,7 @@ import KeyboardModule from './features/keyboard';
 import KeyboardMoveSelectionModule from 'diagram-js/lib/features/keyboard-move-selection';
 import LabelEditingModule from './features/label-editing';
 import ModelingModule from './features/modeling';
+import ModelingFeedbackModule from './features/modeling-feedback';
 import MoveModule from 'diagram-js/lib/features/move';
 import PaletteModule from './features/palette';
 import ReplacePreviewModule from './features/replace-preview';
@@ -35,10 +36,6 @@ import ResizeModule from 'diagram-js/lib/features/resize';
 import SnappingModule from './features/snapping';
 import SearchModule from './features/search';
 
-import {
-  wrapForCompatibility
-} from './util/CompatibilityUtil';
-
 var initialDiagram =
   '<?xml version="1.0" encoding="UTF-8"?>' +
   '<bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ' +
@@ -152,8 +149,6 @@ Modeler.prototype.createDiagram = function createDiagram() {
   return this.importXML(initialDiagram);
 };
 
-Modeler.prototype.createDiagram = wrapForCompatibility(Modeler.prototype.createDiagram);
-
 
 Modeler.prototype._interactionModules = [
 
@@ -185,6 +180,7 @@ Modeler.prototype._modelingModules = [
   KeyboardMoveSelectionModule,
   LabelEditingModule,
   ModelingModule,
+  ModelingFeedbackModule,
   MoveModule,
   PaletteModule,
   ReplacePreviewModule,

package/lib/features/context-pad/ContextPadProvider.js

@@ -452,7 +452,8 @@ ContextPadProvider.prototype.getContextPadEntries = function(element) {
     assign(actions, {
       'append.text-annotation': appendAction(
         'bpmn:TextAnnotation',
-        'bpmn-icon-text-annotation'
+        'bpmn-icon-text-annotation',
+        translate('Append TextAnnotation')
       )
     });
   }
@@ -468,7 +469,8 @@ ContextPadProvider.prototype.getContextPadEntries = function(element) {
     assign(actions, {
       'append.text-annotation': appendAction(
         'bpmn:TextAnnotation',
-        'bpmn-icon-text-annotation'
+        'bpmn-icon-text-annotation',
+        translate('Append TextAnnotation')
       ),
 
       'connect': {
@@ -519,7 +521,11 @@ ContextPadProvider.prototype.getContextPadEntries = function(element) {
 
   if (is(businessObject, 'bpmn:Group')) {
     assign(actions, {
-      'append.text-annotation': appendAction('bpmn:TextAnnotation', 'bpmn-icon-text-annotation')
+      'append.text-annotation': appendAction(
+        'bpmn:TextAnnotation',
+        'bpmn-icon-text-annotation',
+        translate('Append TextAnnotation')
+      )
     });
   }
 

package/lib/features/copy-paste/BpmnCopyPaste.js

@@ -108,7 +108,7 @@ export default function BpmnCopyPaste(bpmnFactory, eventBus, moddleCopy) {
           property = reference.property;
 
       if (key === descriptor.id) {
-        element[ property ] = businessObject;
+        element.set(property, businessObject);
 
         array.push(descriptor.id);
       }

package/lib/features/modeling/behavior/EventBasedGatewayBehavior.js

@@ -43,12 +43,18 @@ export default function EventBasedGatewayBehavior(eventBus, modeling) {
     var sequenceFlows = [];
 
     if (is(source, 'bpmn:EventBasedGateway')) {
-      sequenceFlows = target.incoming.filter(isSequenceFlow);
+      sequenceFlows = target.incoming
+        .filter(flow =>
+          flow !== connection &&
+          isSequenceFlow(flow)
+        );
     } else {
-      sequenceFlows = target.incoming.filter(function(connection) {
-        return isSequenceFlow(connection)
-          && is(connection.source, 'bpmn:EventBasedGateway');
-      });
+      sequenceFlows = target.incoming
+        .filter(flow =>
+          flow !== connection &&
+          isSequenceFlow(flow) &&
+          is(flow.source, 'bpmn:EventBasedGateway')
+        );
     }
 
     sequenceFlows.forEach(function(sequenceFlow) {

package/lib/features/modeling/behavior/index.js

@@ -19,7 +19,6 @@ import IsHorizontalFix from './IsHorizontalFix';
 import LabelBehavior from './LabelBehavior';
 import LayoutConnectionBehavior from './LayoutConnectionBehavior';
 import MessageFlowBehavior from './MessageFlowBehavior';
-import ModelingFeedback from './ModelingFeedback';
 import RemoveEmbeddedLabelBoundsBehavior from './RemoveEmbeddedLabelBoundsBehavior';
 import RemoveElementBehavior from './RemoveElementBehavior';
 import RemoveParticipantBehavior from './RemoveParticipantBehavior';
@@ -63,7 +62,6 @@ export default {
     'labelBehavior',
     'layoutConnectionBehavior',
     'messageFlowBehavior',
-    'modelingFeedback',
     'removeElementBehavior',
     'removeEmbeddedLabelBoundsBehavior',
     'removeParticipantBehavior',
@@ -102,7 +100,6 @@ export default {
   labelBehavior: [ 'type', LabelBehavior ],
   layoutConnectionBehavior: [ 'type', LayoutConnectionBehavior ],
   messageFlowBehavior: [ 'type', MessageFlowBehavior ],
-  modelingFeedback: [ 'type', ModelingFeedback ],
   removeElementBehavior: [ 'type', RemoveElementBehavior ],
   removeEmbeddedLabelBoundsBehavior: [ 'type', RemoveEmbeddedLabelBoundsBehavior ],
   removeParticipantBehavior: [ 'type', RemoveParticipantBehavior ],

package/lib/features/modeling/index.js

@@ -6,7 +6,6 @@ import ReplaceModule from '../replace';
 import SpaceToolModule from '../space-tool';
 
 import CommandModule from 'diagram-js/lib/command';
-import TooltipsModule from 'diagram-js/lib/features/tooltips';
 import LabelSupportModule from 'diagram-js/lib/features/label-support';
 import AttachSupportModule from 'diagram-js/lib/features/attach-support';
 import SelectionModule from 'diagram-js/lib/features/selection';
@@ -32,7 +31,6 @@ export default {
     OrderingModule,
     ReplaceModule,
     CommandModule,
-    TooltipsModule,
     LabelSupportModule,
     AttachSupportModule,
     SelectionModule,

package/lib/features/{modeling/behavior → modeling-feedback}/ModelingFeedback.js

@@ -1,4 +1,4 @@
-import { is } from '../../../util/ModelUtil';
+import { is } from '../../util/ModelUtil';
 
 /**
  * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus

package/lib/features/modeling-feedback/index.d.ts

@@ -0,0 +1,7 @@
+declare namespace _default {
+    const __depends__: import("didi").ModuleDeclaration[];
+    const __init__: string[];
+    const modelingFeedback: (string | typeof ModelingFeedback)[];
+}
+export default _default;
+import ModelingFeedback from './ModelingFeedback';

package/lib/features/modeling-feedback/index.js

@@ -0,0 +1,13 @@
+import TooltipsModule from 'diagram-js/lib/features/tooltips';
+
+import ModelingFeedback from './ModelingFeedback';
+
+export default {
+  __depends__: [
+    TooltipsModule
+  ],
+  __init__: [
+    'modelingFeedback'
+  ],
+  modelingFeedback: [ 'type', ModelingFeedback ]
+};

package/lib/util/CompatibilityUtil.d.ts

@@ -1,17 +1,3 @@
-/**
- * Wraps APIs to check:
- *
- * 1) If a callback is passed -> Warn users about callback deprecation.
- * 2) If Promise class is implemented in current environment.
- *
- * @private
- *
- * @param api
- *
- * @return
- */
-export function wrapForCompatibility(api: Function): Function;
-
 /**
  * @private
  *

package/lib/util/CompatibilityUtil.js

@@ -1,68 +1,11 @@
 import {
-  has,
-  isFunction
+  has
 } from 'min-dash';
 
 /**
  * @typedef {import('../model/Types').ModdleElement} ModdleElement
  */
 
-// TODO(nikku): remove with future bpmn-js version
-
-/**
- * Wraps APIs to check:
- *
- * 1) If a callback is passed -> Warn users about callback deprecation.
- * 2) If Promise class is implemented in current environment.
- *
- * @private
- *
- * @param {Function} api
- *
- * @return {Function}
- */
-export function wrapForCompatibility(api) {
-
-  return function() {
-
-    if (!window.Promise) {
-      throw new Error('Promises is not supported in this environment. Please polyfill Promise.');
-    }
-
-    var argLen = arguments.length;
-    if (argLen >= 1 && isFunction(arguments[argLen - 1])) {
-
-      var callback = arguments[argLen - 1];
-
-      console.warn(new Error(
-        'Passing callbacks to ' + api.name + ' is deprecated and will be removed in a future major release. ' +
-        'Please switch to promises: https://bpmn.io/l/moving-to-promises.html'
-      ));
-
-      var argsWithoutCallback = Array.prototype.slice.call(arguments, 0, -1);
-
-      api.apply(this, argsWithoutCallback).then(function(result) {
-
-        var firstKey = Object.keys(result)[0];
-
-        // The APIs we are wrapping all resolve a single item depending on the API.
-        // For instance, importXML resolves { warnings } and saveXML returns { xml }.
-        // That's why we can call the callback with the first item of result.
-        return callback(null, result[firstKey]);
-
-        // Passing a second paramter instead of catch because we don't want to
-        // catch errors thrown by callback().
-      }, function(err) {
-
-        return callback(err, err.warnings);
-      });
-    } else {
-
-      return api.apply(this, arguments);
-    }
-  };
-}
-
 
 // TODO(nikku): remove with future bpmn-js version
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-js",
-  "version": "13.2.2",
+  "version": "14.0.0",
   "description": "A bpmn 2.0 toolkit and web modeler",
   "main": "index.js",
   "files": [
@@ -22,12 +22,12 @@
     "start:navigated-viewer": "cross-env SINGLE_START=navigated-viewer npm run dev",
     "dev": "npm test -- --auto-watch --no-single-run",
     "test": "karma start test/config/karma.unit.js",
-    "distro": "node tasks/build-distro.js",
+    "distro": "node tasks/build-distro.mjs",
     "collect-translations": "cross-env COLLECT_TRANSLATIONS=1 npm test",
     "generate-types": "run-s generate-types:*",
     "generate-types:generate": "del-cli \"lib/**/*.d.ts\" && npx bio-dts -r lib",
     "generate-types:test": "tsc --noEmit --noImplicitAny",
-    "test:distro": "node tasks/test-distro.js",
+    "test:distro": "node tasks/test-distro.mjs",
     "postversion": "run-s distro test:distro",
     "prepare": "run-s distro",
     "prepublishOnly": "run-s generate-types"
@@ -69,7 +69,7 @@
     "babel-loader": "^9.1.0",
     "babel-plugin-istanbul": "^6.1.1",
     "bio-dts": "^0.8.1",
-    "bpmn-font": "^0.12.0",
+    "bpmn-font": "^0.12.1",
     "camunda-bpmn-moddle": "^4.0.1",
     "chai": "4.1.2",
     "chai-match": "^1.1.1",
@@ -80,7 +80,7 @@
     "eslint": "^8.22.0",
     "eslint-plugin-bpmn-io": "^1.0.0",
     "eslint-plugin-import": "^2.26.0",
-    "execa": "^5.1.1",
+    "execa": "^8.0.0",
     "file-drops": "^0.5.0",
     "karma": "^6.4.1",
     "karma-chrome-launcher": "^3.1.1",
@@ -92,11 +92,10 @@
     "karma-safari-launcher": "^1.0.0",
     "karma-sinon-chai": "^2.0.2",
     "karma-webpack": "^5.0.0",
-    "mkdirp": "^2.0.0",
     "mocha": "^10.1.0",
     "mocha-test-container-support": "0.2.0",
     "npm-run-all": "^4.1.2",
-    "puppeteer": "^20.8.0",
+    "puppeteer": "^21.0.0",
     "remark-cli": "^11.0.0",
     "remark-preset-bpmn-io": "^0.2.1",
     "rollup": "^3.19.1",
@@ -108,10 +107,10 @@
     "webpack": "^5.74.0"
   },
   "dependencies": {
-    "bpmn-moddle": "^8.0.0",
-    "diagram-js": "^12.2.0",
+    "bpmn-moddle": "^8.0.1",
+    "diagram-js": "^12.3.0",
     "diagram-js-direct-editing": "^2.0.0",
-    "ids": "^1.0.0",
+    "ids": "^1.0.3",
     "inherits-browser": "^0.1.0",
     "min-dash": "^4.0.0",
     "min-dom": "^4.0.3",