bpmn-js 17.5.0 → 17.6.0

package/dist/bpmn-viewer.development.js

@@ -1,5 +1,5 @@
 /*!
- * bpmn-js - bpmn-viewer v17.5.0
+ * bpmn-js - bpmn-viewer v17.6.0
  *
  * Copyright (c) 2014-present, camunda Services GmbH
  *
@@ -8,7 +8,7 @@
  *
  * Source Code: https://github.com/bpmn-io/bpmn-js
  *
- * Date: 2024-04-26
+ * Date: 2024-04-30
  */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
@@ -22127,7 +22127,7 @@
       // avoid multiple rendering of elements
       if (gfx) {
         throw new Error(
-          'already rendered ${ elementToString(element) }'
+          `already rendered ${ elementToString(element) }`
         );
       }
 
@@ -22803,6 +22803,12 @@
    * @see http://bpmn.io/license for more information.
    */
 
+  /**
+   * @template T
+   *
+   * @typedef { import('diagram-js/lib/core/EventBus').default<T> } EventBus
+   */
+
   /**
    * @template T
    *
@@ -22888,12 +22894,22 @@
    * } } 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.
    */
   function BaseViewer(options) {
@@ -23314,9 +23330,18 @@
   };
 
   /**
-   * Register an event listener.
+   * @overlord
+   *
+   * Register an event listener for events with the given name.
    *
-   * Remove an event listener via {@link BaseViewer#off}.
+   * 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
    *
@@ -23325,6 +23350,25 @@
    * @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);
   };
@@ -23578,7 +23622,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.
    *
    *
@@ -23614,6 +23658,10 @@
    * bpmnViewer.importXML(...);
    * ```
    *
+   * @template [ServiceMap=null]
+   *
+   * @extends BaseViewer<ServiceMap>
+   *
    * @param {BaseViewerOptions} [options] The options to configure the viewer.
    */
   function Viewer(options) {