bpmn-js 17.4.0 → 17.6.0

package/lib/BaseModeler.d.ts

@@ -1,10 +1,13 @@
 /**
  * A base modeler for BPMN 2.0 diagrams.
  *
- * See {@link Modeler} for a fully-featured modeler.
+ * See {@link bpmn-js/lib/Modeler} for a fully-featured modeler.
+ *
+ *
+ * @extends BaseViewer<ServiceMap>
  *
  */
-export default class BaseModeler extends BaseViewer {}
+export default class BaseModeler<ServiceMap = null> extends BaseViewer<ServiceMap> {}
 
 type BaseViewerOptions = import('./BaseViewer').BaseViewerOptions;
 type ModdleElementsById = import('./BaseViewer').ModdleElementsById;

package/lib/BaseModeler.js

@@ -15,7 +15,11 @@ import BaseViewer from './BaseViewer';
 /**
  * A base modeler for BPMN 2.0 diagrams.
  *
- * See {@link Modeler} for a fully-featured modeler.
+ * See {@link bpmn-js/lib/Modeler} for a fully-featured modeler.
+ *
+ * @template [ServiceMap=null]
+ *
+ * @extends BaseViewer<ServiceMap>
  *
  * @param {BaseViewerOptions} [options] The options to configure the modeler.
  */

package/lib/BaseViewer.d.ts

@@ -1,11 +1,14 @@
 /**
  * A base viewer for BPMN 2.0 diagrams.
  *
- * Have a look at {@link Viewer}, {@link NavigatedViewer} or {@link Modeler} for
+ * Have a look at {@link bpmn-js/lib/Viewer}, {@link bpmn-js/lib/NavigatedViewer} or {@link bpmn-js/lib/Modeler} for
  * bundles that include actual features.
  *
+ *
+ * @extends Diagram<ServiceMap>
+ *
  */
-export default class BaseViewer extends Diagram<null> {
+export default class BaseViewer<ServiceMap = null> extends Diagram<ServiceMap> {
   /**
    * @param options The options to configure the viewer.
    */
@@ -145,21 +148,85 @@ export default class BaseViewer extends Diagram<null> {
   getModules(): ModuleDeclaration[];
 
   /**
-   * Register an event listener.
+   * Register an event listener for events with the given name.
+   *
+   * The callback will be invoked with `event, ...additionalArguments`
+   * that have been passed to {@link EventBus#fire}.
+   *
+   * Returning false from a listener will prevent the events default action
+   * (if any is specified). To stop an event from being processed further in
+   * other listeners execute {@link Event#stopPropagation}.
+   *
+   * Returning anything but `undefined` from a listener will stop the listener propagation.
+   *
+   *
+   * @param events to subscribe to
+   * @param callback
+   * @param that callback context
+   */
+  on<EventName extends keyof EventMap<ServiceMap>>(
+    events: EventName,
+    callback: EventBusEventCallback<(EventMap<ServiceMap>)[EventName]>,
+    that?: any
+  ): void;
+
+  /**
+   * Register an event listener for events with the given name.
+   *
+   * The callback will be invoked with `event, ...additionalArguments`
+   * that have been passed to {@link EventBus#fire}.
+   *
+   * Returning false from a listener will prevent the events default action
+   * (if any is specified). To stop an event from being processed further in
+   * other listeners execute {@link Event#stopPropagation}.
+   *
+   * Returning anything but `undefined` from a listener will stop the listener propagation.
+   *
+   *
+   * @param events to subscribe to
+   * @param priority listen priority
+   * @param callback
+   * @param that callback context
+   */
+  on<EventName extends keyof EventMap<ServiceMap>>(
+    events: EventName,
+    priority: number,
+    callback: EventBusEventCallback<(EventMap<ServiceMap>)[EventName]>,
+    that?: any
+  ): void;
+
+  /**
    *
-   * Remove an event listener via {@link BaseViewer#off}.
+   * Register an event listener for events with the given name.
+   *
+   * The callback will be invoked with `event, ...additionalArguments`
+   * that have been passed to {@link EventBus#fire}.
+   *
+   * Returning false from a listener will prevent the events default action
+   * (if any is specified). To stop an event from being processed further in
+   * other listeners execute {@link Event#stopPropagation}.
+   *
+   * Returning anything but `undefined` from a listener will stop the listener propagation.
    *
    *
    * @param events The event(s) to listen to.
    * @param callback The callback.
    * @param that Value of `this` the callback will be called with.
    */
-  on<T>(events: string | string[], callback: EventBusEventCallback<T>, that?: any): any;
+  on<T>(events: string|string[], callback: EventBusEventCallback<T>, that?: any): void;
 
   /**
-   * Register an event listener.
    *
-   * Remove an event listener via {@link BaseViewer#off}.
+   * Register an event listener for events with the given name.
+   *
+   * The callback will be invoked with `event, ...additionalArguments`
+   * that have been passed to {@link EventBus#fire}.
+   *
+   * Returning false from a listener will prevent the events default action
+   * (if any is specified). To stop an event from being processed further in
+   * other listeners execute {@link Event#stopPropagation}.
+   *
+   * Returning anything but `undefined` from a listener will stop the listener propagation.
    *
    *
    * @param events The event(s) to listen to.
@@ -168,11 +235,11 @@ export default class BaseViewer extends Diagram<null> {
    * @param that Value of `this` the callback will be called with.
    */
   on<T>(
-    events: string | string[],
+    events: string|string[],
     priority: number,
     callback: EventBusEventCallback<T>,
     that?: any
-  ): any;
+  ): void;
 
   /**
    * Remove an event listener.
@@ -204,6 +271,7 @@ export default class BaseViewer extends Diagram<null> {
   detach(): void;
 }
 
+type EventBus<T> = import('diagram-js/lib/core/EventBus').default<T>;
 type EventBusEventCallback<T> = import('diagram-js/lib/core/EventBus').EventBusEventCallback<T>;
 type ModuleDeclaration = import('didi').ModuleDeclaration;
 type Moddle = import('./model/Types').Moddle;
@@ -277,4 +345,8 @@ export type SaveSVGDoneEvent = {
     svg: string;
 };
 
+export type EventMap<Type> = Type extends {
+    eventBus: import("diagram-js/lib/core/EventBus").default<infer X>;
+} ? X : never;
+
 import Diagram from 'diagram-js';

package/lib/BaseViewer.js

@@ -31,6 +31,12 @@ import {
   importBpmnDiagram
 } from './import/Importer';
 
+/**
+ * @template T
+ *
+ * @typedef { import('diagram-js/lib/core/EventBus').default<T> } EventBus
+ */
+
 /**
  * @template T
  *
@@ -116,12 +122,22 @@ import {
  * } } SaveSVGDoneEvent
  */
 
+/**
+ * @template Type
+ *
+ * @typedef { Type extends { eventBus: EventBus<infer X> } ? X : never } EventMap
+ */
+
 /**
  * A base viewer for BPMN 2.0 diagrams.
  *
- * Have a look at {@link Viewer}, {@link NavigatedViewer} or {@link Modeler} for
+ * Have a look at {@link bpmn-js/lib/Viewer}, {@link bpmn-js/lib/NavigatedViewer} or {@link bpmn-js/lib/Modeler} for
  * bundles that include actual features.
  *
+ * @template [ServiceMap=null]
+ *
+ * @extends Diagram<ServiceMap>
+ *
  * @param {BaseViewerOptions} [options] The options to configure the viewer.
  */
 export default function BaseViewer(options) {
@@ -542,9 +558,18 @@ BaseViewer.prototype.destroy = function() {
 };
 
 /**
- * Register an event listener.
+ * @overlord
  *
- * Remove an event listener via {@link BaseViewer#off}.
+ * Register an event listener for events with the given name.
+ *
+ * The callback will be invoked with `event, ...additionalArguments`
+ * that have been passed to {@link EventBus#fire}.
+ *
+ * Returning false from a listener will prevent the events default action
+ * (if any is specified). To stop an event from being processed further in
+ * other listeners execute {@link Event#stopPropagation}.
+ *
+ * Returning anything but `undefined` from a listener will stop the listener propagation.
  *
  * @template T
  *
@@ -553,6 +578,25 @@ BaseViewer.prototype.destroy = function() {
  * @param {EventBusEventCallback<T>} callback The callback.
  * @param {any} [that] Value of `this` the callback will be called with.
  */
+/**
+ * Register an event listener for events with the given name.
+ *
+ * The callback will be invoked with `event, ...additionalArguments`
+ * that have been passed to {@link EventBus#fire}.
+ *
+ * Returning false from a listener will prevent the events default action
+ * (if any is specified). To stop an event from being processed further in
+ * other listeners execute {@link Event#stopPropagation}.
+ *
+ * Returning anything but `undefined` from a listener will stop the listener propagation.
+ *
+ * @template {keyof EventMap<ServiceMap>} EventName
+ *
+ * @param {EventName} events to subscribe to
+ * @param {number} [priority=1000] listen priority
+ * @param {EventBusEventCallback<(EventMap<ServiceMap>)[EventName]>} callback
+ * @param {any} [that] callback context
+ */
 BaseViewer.prototype.on = function(events, priority, callback, that) {
   return this.get('eventBus').on(events, priority, callback, that);
 };

package/lib/Modeler.d.ts

@@ -1,7 +1,6 @@
 /**
  * A modeler for BPMN 2.0 diagrams.
  *
- *
  * ## Extending the Modeler
  *
  * In order to extend the viewer pass extension modules to bootstrap via the
@@ -62,8 +61,11 @@
  * var bpmnModeler = new Modeler({ additionalModules: [ overrideModule ]});
  * ```
  *
+ *
+ * @extends BaseModeler<ServiceMap>
+ *
  */
-export default class Modeler extends BaseModeler {
+export default class Modeler<ServiceMap = null> extends BaseModeler<ServiceMap> {
   static Viewer: typeof Viewer;
   static NavigatedViewer: typeof NavigatedViewer;
 

package/lib/Modeler.js

@@ -64,7 +64,6 @@ var initialDiagram =
 /**
  * A modeler for BPMN 2.0 diagrams.
  *
- *
  * ## Extending the Modeler
  *
  * In order to extend the viewer pass extension modules to bootstrap via the
@@ -125,6 +124,10 @@ var initialDiagram =
  * var bpmnModeler = new Modeler({ additionalModules: [ overrideModule ]});
  * ```
  *
+ * @template [ServiceMap=null]
+ *
+ * @extends BaseModeler<ServiceMap>
+ *
  * @param {BaseViewerOptions} [options] The options to configure the modeler.
  */
 export default function Modeler(options) {

package/lib/NavigatedViewer.d.ts

@@ -1,8 +1,11 @@
 /**
  * A viewer with mouse and keyboard navigation features.
  *
+ *
+ * @extends Viewer<ServiceMap>
+ *
  */
-export default class NavigatedViewer extends Viewer {}
+export default class NavigatedViewer<ServiceMap = null> extends Viewer<ServiceMap> {}
 
 type BaseViewerOptions = import('./BaseViewer').BaseViewerOptions;
 import Viewer from './Viewer';

package/lib/NavigatedViewer.js

@@ -13,6 +13,10 @@ import ZoomScrollModule from 'diagram-js/lib/navigation/zoomscroll';
 /**
  * A viewer with mouse and keyboard navigation features.
  *
+ * @template [ServiceMap=null]
+ *
+ * @extends Viewer<ServiceMap>
+ *
  * @param {BaseViewerOptions} [options]
  */
 export default function NavigatedViewer(options) {

package/lib/Viewer.d.ts

@@ -1,7 +1,7 @@
 /**
  * A viewer for BPMN 2.0 diagrams.
  *
- * Have a look at {@link NavigatedViewer} or {@link Modeler} for bundles that include
+ * Have a look at {@link bpmn-js/lib/NavigatedViewer} or {@link bpmn-js/lib/Modeler} for bundles that include
  * additional features.
  *
  *
@@ -37,8 +37,11 @@
  * bpmnViewer.importXML(...);
  * ```
  *
+ *
+ * @extends BaseViewer<ServiceMap>
+ *
  */
-export default class Viewer extends BaseViewer {}
+export default class Viewer<ServiceMap = null> extends BaseViewer<ServiceMap> {}
 
 type BaseViewerOptions = import('./BaseViewer').BaseViewerOptions;
 import BaseViewer from './BaseViewer';

package/lib/Viewer.js

@@ -17,7 +17,7 @@ import BaseViewer from './BaseViewer';
 /**
  * A viewer for BPMN 2.0 diagrams.
  *
- * Have a look at {@link NavigatedViewer} or {@link Modeler} for bundles that include
+ * Have a look at {@link bpmn-js/lib/NavigatedViewer} or {@link bpmn-js/lib/Modeler} for bundles that include
  * additional features.
  *
  *
@@ -53,6 +53,10 @@ import BaseViewer from './BaseViewer';
  * bpmnViewer.importXML(...);
  * ```
  *
+ * @template [ServiceMap=null]
+ *
+ * @extends BaseViewer<ServiceMap>
+ *
  * @param {BaseViewerOptions} [options] The options to configure the viewer.
  */
 export default function Viewer(options) {

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

@@ -110,6 +110,10 @@ export default function ContextPadProvider(
       entries.replace.action.click(event, shape);
     }
   });
+
+  eventBus.on('contextPad.close', function() {
+    appendPreview.cleanUp();
+  });
 }
 
 ContextPadProvider.$inject = [
@@ -244,16 +248,12 @@ ContextPadProvider.prototype.getContextPadEntries = function(element) {
       create.start(event, shape, {
         source: element
       });
-
-      appendPreview.cleanUp();
     }
 
     var append = autoPlace ? function(_, element) {
       var shape = elementFactory.createShape(assign({ type: type }, options));
 
       autoPlace.append(element, shape);
-
-      appendPreview.cleanUp();
     } : appendStart;
 
     var previewAppend = autoPlace ? function(_, element) {
@@ -487,7 +487,6 @@ ContextPadProvider.prototype.getContextPadEntries = function(element) {
         'bpmn-icon-text-annotation',
         translate('Add text annotation')
       ),
-
       'connect': {
         group: 'connect',
         className: 'bpmn-icon-connection-multi',

package/lib/features/label-editing/LabelEditingProvider.js

@@ -202,6 +202,13 @@ LabelEditingProvider.prototype.activate = function(element) {
   assign(context, bounds);
 
   var options = {};
+  var style = context.style || {};
+
+  // Remove background and border
+  assign(style, {
+    backgroundColor: null,
+    border: null
+  });
 
   // tasks
   if (
@@ -223,6 +230,12 @@ LabelEditingProvider.prototype.activate = function(element) {
     assign(options, {
       autoResize: true
     });
+
+    // keep background and border for external labels
+    assign(style, {
+      backgroundColor: '#ffffff',
+      border: '1px solid #ccc'
+    });
   }
 
   // text annotations
@@ -231,10 +244,17 @@ LabelEditingProvider.prototype.activate = function(element) {
       resizable: true,
       autoResize: true
     });
+
+    // keep background and border for text annotations
+    assign(style, {
+      backgroundColor: '#ffffff',
+      border: '1px solid #ccc'
+    });
   }
 
   assign(context, {
-    options: options
+    options: options,
+    style: style
   });
 
   return context;

package/lib/features/modeling/BpmnUpdater.d.ts

@@ -8,9 +8,8 @@ export default class BpmnUpdater extends CommandInterceptor {
    * @param eventBus
    * @param bpmnFactory
    * @param connectionDocking
-   * @param translate
    */
-  constructor(eventBus: EventBus, bpmnFactory: BpmnFactory, connectionDocking: CroppingConnectionDocking, translate: Translate);
+  constructor(eventBus: EventBus, bpmnFactory: BpmnFactory, connectionDocking: CroppingConnectionDocking);
 
   /**
    * @param context
@@ -83,7 +82,6 @@ export default class BpmnUpdater extends CommandInterceptor {
 type EventBus = import('diagram-js/lib/core/EventBus').default;
 type BpmnFactory = import('./BpmnFactory').default;
 type CroppingConnectionDocking = import('diagram-js/lib/layout/CroppingConnectionDocking').default;
-export type Translate = typeof import("diagram-js/lib/i18n/translate/translate").default;
 type Connection = import('../../model/Types').Connection;
 type Element = import('../../model/Types').Element;
 type Shape = import('../../model/Types').Shape;

package/lib/features/modeling/BpmnUpdater.js

@@ -34,7 +34,6 @@ import CommandInterceptor from 'diagram-js/lib/command/CommandInterceptor';
  * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus
  * @typedef {import('./BpmnFactory').default} BpmnFactory
  * @typedef {import('diagram-js/lib/layout/CroppingConnectionDocking').default} CroppingConnectionDocking
- * @typedef {import('diagram-js/lib/i18n/translate/translate').default} Translate
  *
  * @typedef {import('../../model/Types').Connection} Connection
  * @typedef {import('../../model/Types').Element} Element
@@ -50,24 +49,20 @@ import CommandInterceptor from 'diagram-js/lib/command/CommandInterceptor';
  * @param {EventBus} eventBus
  * @param {BpmnFactory} bpmnFactory
  * @param {CroppingConnectionDocking} connectionDocking
- * @param {Translate} translate
  */
 export default function BpmnUpdater(
     eventBus,
     bpmnFactory,
-    connectionDocking,
-    translate
+    connectionDocking
 ) {
 
   CommandInterceptor.call(this, eventBus);
 
   this._bpmnFactory = bpmnFactory;
-  this._translate = translate;
 
   var self = this;
 
 
-
   // connection cropping //////////////////////
 
   // crop connection ends during create/update
@@ -322,8 +317,7 @@ inherits(BpmnUpdater, CommandInterceptor);
 BpmnUpdater.$inject = [
   'eventBus',
   'bpmnFactory',
-  'connectionDocking',
-  'translate'
+  'connectionDocking'
 ];
 
 
@@ -562,8 +556,7 @@ BpmnUpdater.prototype.getLaneSet = function(container) {
  */
 BpmnUpdater.prototype.updateSemanticParent = function(businessObject, newParent, visualParent) {
 
-  var containment,
-      translate = this._translate;
+  var containment;
 
   if (businessObject.$parent === newParent) {
     return;
@@ -668,13 +661,7 @@ BpmnUpdater.prototype.updateSemanticParent = function(businessObject, newParent,
   }
 
   if (!containment) {
-    throw new Error(translate(
-      'no parent for {element} in {parent}',
-      {
-        element: businessObject.id,
-        parent: newParent.id
-      }
-    ));
+    throw new Error(`no parent for <${ businessObject.id }> in <${ newParent.id }>`);
   }
 
   var children;

package/lib/features/modeling/ElementFactory.d.ts

@@ -11,9 +11,8 @@ export default class ElementFactory<T extends import("../../model/Types").Connec
   /**
    * @param bpmnFactory
    * @param moddle
-   * @param translate
    */
-  constructor(bpmnFactory: BpmnFactory, moddle: Moddle, translate: Translate);
+  constructor(bpmnFactory: BpmnFactory, moddle: Moddle);
 
   /**
    * Create a label.
@@ -105,7 +104,6 @@ export default class ElementFactory<T extends import("../../model/Types").Connec
   createParticipantShape(attrs?: boolean | (Partial<Shape> & Partial<BpmnAttributes>)): W;
 }
 
-export type Translate = typeof import("diagram-js/lib/i18n/translate/translate").default;
 type Dimensions = import('diagram-js/lib/util/Types').Dimensions;
 type BpmnFactory = import('./BpmnFactory').default;
 type BpmnAttributes = import('../../model/Types').BpmnAttributes;

package/lib/features/modeling/ElementFactory.js

@@ -34,8 +34,6 @@ import {
 } from '../../util/CompatibilityUtil';
 
 /**
- * @typedef {import('diagram-js/lib/i18n/translate/translate').default} Translate
- *
  * @typedef {import('diagram-js/lib/util/Types').Dimensions} Dimensions
  *
  * @typedef {import('./BpmnFactory').default} BpmnFactory
@@ -62,22 +60,19 @@ import {
  *
  * @param {BpmnFactory} bpmnFactory
  * @param {Moddle} moddle
- * @param {Translate} translate
  */
-export default function ElementFactory(bpmnFactory, moddle, translate) {
+export default function ElementFactory(bpmnFactory, moddle) {
   BaseElementFactory.call(this);
 
   this._bpmnFactory = bpmnFactory;
   this._moddle = moddle;
-  this._translate = translate;
 }
 
 inherits(ElementFactory, BaseElementFactory);
 
 ElementFactory.$inject = [
   'bpmnFactory',
-  'moddle',
-  'translate'
+  'moddle'
 ];
 
 ElementFactory.prototype._baseCreate = BaseElementFactory.prototype.create;
@@ -155,17 +150,17 @@ ElementFactory.prototype.create = function(elementType, attrs) {
  * @return {T}
  */
 ElementFactory.prototype.createElement = function(elementType, attrs) {
-  var size,
-      translate = this._translate;
 
   attrs = assign({}, attrs || {});
 
+  var size;
+
   var businessObject = attrs.businessObject,
       di = attrs.di;
 
   if (!businessObject) {
     if (!attrs.type) {
-      throw new Error(translate('no shape type specified'));
+      throw new Error('no shape type specified');
     }
 
     businessObject = this._bpmnFactory.create(attrs.type);

package/lib/features/modeling/behavior/UpdateFlowNodeRefsBehavior.d.ts

@@ -6,12 +6,10 @@ export default class UpdateFlowNodeRefsBehavior extends CommandInterceptor {
     /**
      * @param eventBus
      * @param modeling
-     * @param translate
      */
-    constructor(eventBus: EventBus, modeling: Modeling, translate: Translate);
+    constructor(eventBus: EventBus, modeling: Modeling);
 }
 
 type EventBus = import('diagram-js/lib/core/EventBus').default;
 type Modeling = import('../Modeling').default;
-export type Translate = typeof import("diagram-js/lib/i18n/translate/translate").default;
 import CommandInterceptor from 'diagram-js/lib/command/CommandInterceptor';

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

@@ -9,7 +9,6 @@ import {
 /**
  * @typedef {import('diagram-js/lib/core/EventBus').default} EventBus
  * @typedef {import('../Modeling').default} Modeling
- * @typedef {import('diagram-js/lib/i18n/translate/translate').default} Translate
  */
 
 var LOW_PRIORITY = 500,
@@ -21,9 +20,8 @@ var LOW_PRIORITY = 500,
  *
  * @param {EventBus} eventBus
  * @param {Modeling} modeling
- * @param {Translate} translate
  */
-export default function UpdateFlowNodeRefsBehavior(eventBus, modeling, translate) {
+export default function UpdateFlowNodeRefsBehavior(eventBus, modeling) {
 
   CommandInterceptor.call(this, eventBus);
 
@@ -46,7 +44,7 @@ export default function UpdateFlowNodeRefsBehavior(eventBus, modeling, translate
 
   function getContext() {
     if (!context) {
-      throw new Error(translate('out of bounds release'));
+      throw new Error('out of bounds release');
     }
 
     return context;
@@ -55,7 +53,7 @@ export default function UpdateFlowNodeRefsBehavior(eventBus, modeling, translate
   function releaseContext() {
 
     if (!context) {
-      throw new Error(translate('out of bounds release'));
+      throw new Error('out of bounds release');
     }
 
     var triggerUpdate = context.leave();
@@ -127,8 +125,7 @@ export default function UpdateFlowNodeRefsBehavior(eventBus, modeling, translate
 
 UpdateFlowNodeRefsBehavior.$inject = [
   'eventBus',
-  'modeling' ,
-  'translate'
+  'modeling'
 ];
 
 inherits(UpdateFlowNodeRefsBehavior, CommandInterceptor);

package/lib/features/modeling/cmd/SetColorHandler.js

@@ -52,7 +52,7 @@ export default function SetColorHandler(commandStack) {
       }
     }
 
-    throw new Error('invalid color value: ' + color);
+    throw new Error(`invalid color value: ${ color }`);
   };
 }