bpmn-js 11.5.0 → 12.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-js",
-  "version": "11.5.0",
+  "version": "12.0.0",
   "description": "A bpmn 2.0 toolkit and web modeler",
   "main": "index.js",
   "files": [
@@ -9,10 +9,11 @@
     "test/util",
     "test/helper",
     "test/matchers",
-    "!.eslintrc"
+    "!.eslintrc",
+    "!lib/**/*.spec.ts"
   ],
   "scripts": {
-    "all": "run-s lint test distro test:distro",
+    "all": "run-s lint test test:types distro test:distro",
     "lint": "eslint .",
     "format": "run-s format:markdown 'lint -- --fix'",
     "format:markdown": "remark . -qo",
@@ -24,6 +25,7 @@
     "distro": "node tasks/build-distro.js",
     "collect-translations": "cross-env COLLECT_TRANSLATIONS=1 npm test",
     "test:distro": "node tasks/test-distro.js",
+    "test:types": "tsc",
     "postversion": "run-s distro test:distro",
     "prepare": "run-s distro"
   },
@@ -56,11 +58,11 @@
   ],
   "devDependencies": {
     "@babel/core": "^7.20.2",
-    "@rollup/plugin-commonjs": "^23.0.2",
-    "@rollup/plugin-json": "^5.0.1",
+    "@rollup/plugin-commonjs": "^24.0.1",
+    "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
-    "@rollup/plugin-replace": "^5.0.1",
-    "@rollup/plugin-terser": "^0.1.0",
+    "@rollup/plugin-replace": "^5.0.2",
+    "@rollup/plugin-terser": "^0.4.0",
     "babel-loader": "^9.1.0",
     "babel-plugin-istanbul": "^6.1.1",
     "bpmn-font": "^0.12.0",
@@ -92,15 +94,16 @@
     "puppeteer": "^19.4.1",
     "remark-cli": "^11.0.0",
     "remark-preset-bpmn-io": "^0.2.1",
-    "rollup": "^2.79.1",
-    "rollup-plugin-license": "^2.9.1",
+    "rollup": "^3.19.1",
+    "rollup-plugin-license": "^3.0.0",
     "sinon": "^15.0.0",
     "sinon-chai": "^3.7.0",
+    "typescript": "^5.0.0",
     "webpack": "^5.74.0"
   },
   "dependencies": {
     "bpmn-moddle": "^8.0.0",
-    "diagram-js": "^11.9.1",
+    "diagram-js": "^11.12.0",
     "diagram-js-direct-editing": "^2.0.0",
     "ids": "^1.0.0",
     "inherits-browser": "^0.1.0",

package/lib/features/create-append-anything/AppendContextPadProvider.js

@@ -1,77 +0,0 @@
-import {
-  assign
-} from 'min-dash';
-
-import {
-  appendIcon
-} from '../../icons/Icons';
-
-var LOW_PRIORITY = 900;
-
-/**
- * A provider for align elements context pad button
- */
-export default function AppendContextPadProvider(contextPad, popupMenu, translate, canvas) {
-  contextPad.registerProvider(LOW_PRIORITY, this);
-
-  this._contextPad = contextPad;
-  this._popupMenu = popupMenu;
-  this._translate = translate;
-  this._canvas = canvas;
-}
-
-AppendContextPadProvider.$inject = [
-  'contextPad',
-  'popupMenu',
-  'translate',
-  'canvas'
-];
-
-AppendContextPadProvider.prototype.getContextPadEntries = function(element) {
-  const popupMenu = this._popupMenu;
-  const translate = this._translate;
-  const getAppendMenuPosition = this._getAppendMenuPosition.bind(this);
-
-  if (!popupMenu.isEmpty(element, 'bpmn-append')) {
-
-    // append menu entry
-    return {
-      'append': {
-        group: 'model',
-        imageUrl: appendIcon,
-        title: translate('Append element'),
-        action: {
-          click: function(event, element) {
-
-            var position = assign(getAppendMenuPosition(element), {
-              cursor: { x: event.x, y: event.y }
-            });
-
-            popupMenu.open(element, 'bpmn-append', position, {
-              title: translate('Append element'),
-              width: 300,
-              search: true
-            });
-          }
-        }
-      }
-    };
-  }
-};
-
-AppendContextPadProvider.prototype._getAppendMenuPosition = function(element) {
-  const contextPad = this._contextPad;
-
-  const X_OFFSET = 5;
-
-  const pad = contextPad.getPad(element).html;
-
-  const padRect = pad.getBoundingClientRect();
-
-  const pos = {
-    x: padRect.right + X_OFFSET,
-    y: padRect.top
-  };
-
-  return pos;
-};

package/lib/features/create-append-anything/AppendMenuProvider.js

@@ -1,187 +0,0 @@
-import { isUndefined } from 'min-dash';
-import { CREATE_OPTIONS } from './util/OptionsUtil';
-
-/**
- * This module is an append menu provider for the popup menu.
- */
-export default function AppendMenuProvider(
-    elementFactory,
-    popupMenu,
-    create,
-    autoPlace,
-    rules,
-    mouse,
-    translate
-) {
-  this._elementFactory = elementFactory;
-  this._popupMenu = popupMenu;
-  this._create = create;
-  this._autoPlace = autoPlace;
-  this._rules = rules;
-  this._create = create;
-  this._mouse = mouse;
-  this._translate = translate;
-
-  this.register();
-}
-
-AppendMenuProvider.$inject = [
-  'elementFactory',
-  'popupMenu',
-  'create',
-  'autoPlace',
-  'rules',
-  'mouse',
-  'translate'
-];
-
-/**
- * Register append menu provider in the popup menu
- */
-AppendMenuProvider.prototype.register = function() {
-  this._popupMenu.registerProvider('bpmn-append', this);
-};
-
-/**
- * Get all entries from createOptions for the given element.
- *
- * @param {djs.model.Base} element
- *
- * @return {Array<Object>} a list of menu entry items
- */
-AppendMenuProvider.prototype.getPopupMenuEntries = function(element) {
-  const rules = this._rules;
-  const translate = this._translate;
-
-  const entries = {};
-
-  if (!rules.allowed('shape.append', { element: element })) {
-    return [];
-  }
-
-  // filter out elements with no incoming connections
-  const appendOptions = this._filterEntries(CREATE_OPTIONS);
-
-  // map options to menu entries
-  appendOptions.forEach(option => {
-    const {
-      actionName,
-      className,
-      label,
-      target,
-      description,
-      group,
-      search,
-      rank
-    } = option;
-
-    entries[`append-${actionName}`] = {
-      label: label && translate(label),
-      className,
-      description,
-      group: group && {
-        ...group,
-        name: translate(group.name)
-      },
-      search,
-      rank,
-      action: this._createEntryAction(element, target)
-    };
-  });
-
-  return entries;
-};
-
-/**
- * Filter out entries from the options.
- *
- * @param {Array<Object>} entries
- *
- * @return {Array<Object>} filtered entries
- */
-AppendMenuProvider.prototype._filterEntries = function(entries) {
-  return entries.filter(option => {
-
-    const target = option.target;
-    const {
-      type,
-      eventDefinitionType
-    } = target;
-
-    if ([
-      'bpmn:StartEvent',
-      'bpmn:Participant'
-    ].includes(type)) {
-      return false;
-    }
-
-    if (type === 'bpmn:BoundaryEvent' && isUndefined(eventDefinitionType)) {
-      return false;
-    }
-
-    return true;
-  });
-};
-
-/**
- * Create an action for a given target.
- *
- * @param {djs.model.Base} element
- * @param {Object} target
- *
- * @return {Object}
- */
-AppendMenuProvider.prototype._createEntryAction = function(element, target) {
-  const elementFactory = this._elementFactory;
-  const autoPlace = this._autoPlace;
-  const create = this._create;
-  const mouse = this._mouse;
-
-
-  const autoPlaceElement = () => {
-    const newElement = elementFactory.create('shape', target);
-    autoPlace.append(element, newElement);
-  };
-
-  const manualPlaceElement = (event) => {
-    const newElement = elementFactory.create('shape', target);
-
-    if (event instanceof KeyboardEvent) {
-      event = mouse.getLastMoveEvent();
-    }
-
-    return create.start(event, newElement, {
-      source: element
-    });
-  };
-
-  return {
-    click: this._canAutoPlaceElement(target) ? autoPlaceElement : manualPlaceElement,
-    dragstart: manualPlaceElement
-  };
-};
-
-/**
- * Check if the element should be auto placed.
- *
- * @param {Object} target
- *
- * @return {Boolean}
- */
-AppendMenuProvider.prototype._canAutoPlaceElement = (target) => {
-  const { type } = target;
-
-  if (type === 'bpmn:BoundaryEvent') {
-    return false;
-  }
-
-  if (type === 'bpmn:SubProcess' && target.triggeredByEvent) {
-    return false;
-  }
-
-  if (type === 'bpmn:IntermediateCatchEvent' && target.eventDefinitionType === 'bpmn:LinkEventDefinition') {
-    return false;
-  }
-
-  return true;
-};

package/lib/features/create-append-anything/AppendRules.js

@@ -1,83 +0,0 @@
-import {
-  find,
-} from 'min-dash';
-
-import inherits from 'inherits-browser';
-
-import {
-  is,
-  isAny,
-  getBusinessObject
-} from '../../util/ModelUtil';
-
-import {
-  isLabel
-} from '../../util/LabelUtil';
-
-import RuleProvider from 'diagram-js/lib/features/rules/RuleProvider';
-
-
-/**
- * Append anything modeling rules
- */
-export default function AppendRules(eventBus) {
-  RuleProvider.call(this, eventBus);
-}
-
-inherits(AppendRules, RuleProvider);
-
-AppendRules.$inject = [
-  'eventBus'
-];
-
-AppendRules.prototype.init = function() {
-  this.addRule('shape.append', function(context) {
-
-    var source = context.element;
-
-    const businessObject = getBusinessObject(source);
-
-    if (isLabel(source)) {
-      return false;
-    }
-
-    if (isAny(source, [
-      'bpmn:EndEvent',
-      'bpmn:Group',
-      'bpmn:TextAnnotation',
-      'bpmn:Lane',
-      'bpmn:Participant',
-      'bpmn:DataStoreReference',
-      'bpmn:DataObjectReference'
-    ])) {
-      return false;
-    }
-
-    if (isConnection(source)) {
-      return false;
-    }
-
-    if (is(source, 'bpmn:IntermediateThrowEvent') && hasEventDefinition(source, 'bpmn:LinkEventDefinition')) {
-      return false;
-    }
-
-    if (is(source, 'bpmn:SubProcess') && businessObject.triggeredByEvent) {
-      return false;
-    }
-  });
-
-};
-
-
-// helpers //////////////
-function hasEventDefinition(element, eventDefinition) {
-  var bo = getBusinessObject(element);
-
-  return !!find(bo.eventDefinitions || [], function(definition) {
-    return is(definition, eventDefinition);
-  });
-}
-
-function isConnection(element) {
-  return element.waypoints;
-}

package/lib/features/create-append-anything/CreateAppendEditorActions.js

@@ -1,58 +0,0 @@
-import { assign } from 'min-dash';
-
-/**
- * Registers and executes BPMN specific editor actions.
- *
- * @param {Injector} injector
- */
-export default function CreateAppendEditorActions(injector) {
-  this._injector = injector;
-
-  this.registerActions();
-}
-
-CreateAppendEditorActions.$inject = [
-  'injector'
-];
-
-/**
- * Register actions.
- *
- * @param {Injector} injector
- */
-CreateAppendEditorActions.prototype.registerActions = function() {
-  var editorActions = this._injector.get('editorActions', false);
-  var selection = this._injector.get('selection', false);
-  var contextPad = this._injector.get('contextPad', false);
-  var palette = this._injector.get('palette', false);
-  var popupMenu = this._injector.get('popupMenu', false);
-
-  const actions = {};
-
-  // append
-  if (selection && contextPad && palette && popupMenu && palette) {
-    assign(actions, {
-      'appendElement': function(event) {
-        const selected = selection && selection.get();
-
-        if (selected.length == 1 && !popupMenu.isEmpty(selected[0], 'bpmn-append')) {
-          contextPad.triggerEntry('append', 'click', event);
-        } else {
-          palette.triggerEntry('create', 'click', event);
-        }
-      }
-    });
-  }
-
-  // create
-  if (palette) {
-    assign(actions, {
-      'createElement': function(event) {
-        palette.triggerEntry('create', 'click', event);
-      } }
-    );
-  }
-
-  editorActions && editorActions.register(actions);
-
-};

package/lib/features/create-append-anything/CreateAppendKeyboardBindings.js

@@ -1,90 +0,0 @@
-import inherits from 'inherits-browser';
-
-import KeyboardBindings from 'diagram-js/lib/features/keyboard/KeyboardBindings';
-
-
-/**
- * BPMN 2.0 specific keyboard bindings.
- *
- * @param {Injector} injector
- */
-export default function CreateAppendKeyboardBindings(injector) {
-
-  this._injector = injector;
-  this._keyboard = this._injector.get('keyboard', false);
-  this._editorActions = this._injector.get('editorActions', false);
-
-  if (this._keyboard) {
-    this._injector.invoke(KeyboardBindings, this);
-  }
-}
-
-inherits(CreateAppendKeyboardBindings, KeyboardBindings);
-
-CreateAppendKeyboardBindings.$inject = [
-  'injector'
-];
-
-
-/**
- * Register available keyboard bindings.
- *
- * @param {Keyboard} keyboard
- * @param {EditorActions} editorActions
- */
-CreateAppendKeyboardBindings.prototype.registerBindings = function() {
-
-  var keyboard = this._keyboard;
-  var editorActions = this._editorActions;
-
-  // inherit default bindings
-  KeyboardBindings.prototype.registerBindings.call(this, keyboard, editorActions);
-
-  /**
-   * Add keyboard binding if respective editor action
-   * is registered.
-   *
-   * @param {string} action name
-   * @param {Function} fn that implements the key binding
-   */
-  function addListener(action, fn) {
-
-    if (editorActions && editorActions.isRegistered(action)) {
-      keyboard && keyboard.addListener(fn);
-    }
-  }
-
-  // activate append/create element
-  // A
-  addListener('appendElement', function(context) {
-
-    var event = context.keyEvent;
-
-    if (keyboard && keyboard.hasModifier(event)) {
-      return;
-    }
-
-    if (keyboard && keyboard.isKey([ 'a', 'A' ], event)) {
-
-      editorActions && editorActions.trigger('appendElement', event);
-      return true;
-    }
-  });
-
-  // N
-  addListener('createElement', function(context) {
-
-    var event = context.keyEvent;
-
-    if (keyboard && keyboard.hasModifier(event)) {
-      return;
-    }
-
-    if (keyboard && keyboard.isKey([ 'n', 'N' ], event)) {
-      editorActions && editorActions.trigger('createElement', event);
-
-      return true;
-    }
-  });
-
-};

package/lib/features/create-append-anything/CreateMenuProvider.js

@@ -1,114 +0,0 @@
-import { CREATE_OPTIONS } from './util/OptionsUtil';
-
-/**
- * This module is a create menu provider for the popup menu.
- */
-export default function CreateMenuProvider(
-    elementFactory, popupMenu, create,
-    autoPlace, mouse, translate
-) {
-  this._elementFactory = elementFactory;
-  this._popupMenu = popupMenu;
-  this._create = create;
-  this._autoPlace = autoPlace;
-  this._mouse = mouse;
-  this._translate = translate;
-
-  this.register();
-}
-
-CreateMenuProvider.$inject = [
-  'elementFactory',
-  'popupMenu',
-  'create',
-  'autoPlace',
-  'mouse',
-  'translate'
-];
-
-/**
- * Register create menu provider in the popup menu
- */
-CreateMenuProvider.prototype.register = function() {
-  this._popupMenu.registerProvider('bpmn-create', this);
-};
-
-/**
- * Get all entries
- *
- * @param {djs.model.Base} element
- *
- * @return {Array<Object>} a list of menu entry items
- */
-CreateMenuProvider.prototype.getPopupMenuEntries = function() {
-
-  const entries = {};
-
-  // map options to menu entries
-  CREATE_OPTIONS.forEach(option => {
-    const {
-      actionName,
-      className,
-      label,
-      target,
-      description,
-      group,
-      search,
-      rank
-    } = option;
-
-    const targetAction = this._createEntryAction(target);
-
-    entries[`create-${actionName}`] = {
-      label: label && this._translate(label),
-      className,
-      description,
-      group: group && {
-        ...group,
-        name: this._translate(group.name)
-      },
-      search,
-      rank,
-      action: {
-        click: targetAction,
-        dragstart: targetAction
-      }
-    };
-  });
-
-  return entries;
-};
-
-/**
- * Create an action for a given target
- *
- * @param {Object} target
- * @returns {Object}
- */
-CreateMenuProvider.prototype._createEntryAction = function(target) {
-
-  const create = this._create;
-  const mouse = this._mouse;
-  const popupMenu = this._popupMenu;
-  const elementFactory = this._elementFactory;
-
-  let newElement;
-
-  return (event) => {
-    popupMenu.close();
-
-    // create the new element
-    if (target.type === 'bpmn:Participant') {
-      newElement = elementFactory.createParticipantShape(target);
-    } else {
-      newElement = elementFactory.create('shape', target);
-    }
-
-    // use last mouse event if triggered via keyboard
-    if (event instanceof KeyboardEvent) {
-      event = mouse.getLastMoveEvent();
-    }
-
-    return create.start(event, newElement);
-  };
-};