camunda-bpmn-js 2.0.2 → 2.1.0

package/dist/base-viewer.development.js

@@ -11021,7 +11021,11 @@
     }
   };
 
-  var objectRefs = {exports: {}};
+  var objectRefsExports = {};
+  var objectRefs = {
+    get exports(){ return objectRefsExports; },
+    set exports(v){ objectRefsExports = v; },
+  };
 
   var collection = {};
 
@@ -11341,7 +11345,7 @@
   	module.exports.Collection = collection;
   } (objectRefs));
 
-  var Refs = /*@__PURE__*/getDefaultExportFromCjs(objectRefs.exports);
+  var Refs = /*@__PURE__*/getDefaultExportFromCjs(objectRefsExports);
 
   var parentRefs = new Refs({ name: 'children', enumerable: true, collection: true }, { name: 'parent' }),
       labelRefs = new Refs({ name: 'labels', enumerable: true, collection: true }, { name: 'labelTarget' }),
@@ -21055,7 +21059,20 @@
 
 
   /**
-   * @typedef { import('didi').ModuleDeclaration } Module
+   * @typedef {import('didi').ModuleDeclaration} ModuleDeclaration
+   *
+   * @typedef {import('./BaseViewer').BaseModelerOptions} BaseModelerOptions
+   * @typedef {import('./BaseViewer').ModdleElement} ModdleElement
+   * @typedef {import('./BaseViewer').ImportXMLResult} ImportXMLResult
+   * @typedef {import('./BaseViewer').ImportXMLError} ImportXMLError
+   * @typedef {import('./BaseViewer').ImportDefinitionsResult} ImportDefinitionsResult
+   * @typedef {import('./BaseViewer').ImportDefinitionsError} ImportDefinitionsError
+   * @typedef {import('./BaseViewer').ModdleElement} ModdleElement
+   * @typedef {import('./BaseViewer').ModdleElementsById} ModdleElementsById
+   * @typedef {import('./BaseViewer').OpenResult} OpenResult
+   * @typedef {import('./BaseViewer').OpenError} OpenError
+   * @typedef {import('./BaseViewer').SaveXMLOptions} SaveXMLOptions
+   * @typedef {import('./BaseViewer').SaveXMLResult} SaveXMLResult
    */
 
   /**
@@ -21064,20 +21081,20 @@
    * Have a look at {@link Viewer}, {@link NavigatedViewer} or {@link Modeler} for
    * bundles that include actual features.
    *
-   * @param {Object} [options] configuration options to pass to the viewer
-   * @param {DOMElement} [options.container] the container to render the viewer in, defaults to body.
-   * @param {string|number} [options.width] the width of the viewer
-   * @param {string|number} [options.height] the height of the viewer
-   * @param {Object} [options.moddleExtensions] extension packages to provide
-   * @param {Module[]} [options.modules] a list of modules to override the default modules
-   * @param {Module[]} [options.additionalModules] a list of modules to use with the default modules
+   * @param {BaseModelerOptions} [options] The options to configure the viewer.
    */
   function BaseViewer(options) {
 
+    /**
+     * @type {BaseModelerOptions}
+     */
     options = assign$1({}, DEFAULT_OPTIONS, options);
 
     this._moddle = this._createModdle(options);
 
+    /**
+     * @type {HTMLElement}
+     */
     this._container = this._createContainer(options);
 
     /* <project-logo> */
@@ -21091,22 +21108,6 @@
 
   e(BaseViewer, Diagram);
 
-  /**
-  * The importXML result.
-  *
-  * @typedef {Object} ImportXMLResult
-  *
-  * @property {Array<string>} warnings
-  */
-
-  /**
-  * The importXML error.
-  *
-  * @typedef {Error} ImportXMLError
-  *
-  * @property {Array<string>} warnings
-  */
-
   /**
    * Parse and render a BPMN 2.0 diagram.
    *
@@ -21117,7 +21118,7 @@
    *
    * During import the viewer will fire life-cycle events:
    *
-   *   * import.parse.start (about to read model from xml)
+   *   * 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)
@@ -21125,10 +21126,18 @@
    *
    * You can use these events to hook into the life-cycle.
    *
-   * @param {string} xml the BPMN 2.0 xml
-   * @param {ModdleElement<BPMNDiagram>|string} [bpmnDiagram] BPMN diagram or id of diagram to render (if not provided, the first one will be rendered)
+   * @throws {ImportXMLError} An error thrown during the import of the XML.
+   *
+   * @fires BaseViewer#ImportParseStart
+   * @fires BaseViewer#ImportParseComplete
+   * @fires Importer#ImportRenderStart
+   * @fires Importer#ImportRenderComplete
+   * @fires BaseViewer#ImportDone
    *
-   * Returns {Promise<ImportXMLResult, ImportXMLError>}
+   * @param {string} xml The BPMN 2.0 XML to be imported.
+   * @param {ModdleElement|string} [bpmnDiagram] The optional diagram or Id of the BPMN diagram to open.
+   *
+   * @return {Promise<ImportXMLResult>} A promise resolving with warnings that were produced during the import.
    */
   BaseViewer.prototype.importXML = wrapForCompatibility(async function importXML(xml, bpmnDiagram) {
 
@@ -21164,6 +21173,14 @@
 
       // hook in pre-parse listeners +
       // allow xml manipulation
+
+      /**
+       * A `import.parse.start` event.
+       *
+       * @event BaseViewer#ImportParseStart
+       * @type {Object}
+       * @property {string} xml The XML that is to be parsed.
+       */
       xml = this._emit('import.parse.start', { xml: xml }) || xml;
 
       let parseResult;
@@ -21186,6 +21203,18 @@
 
       // hook in post parse listeners +
       // allow definitions manipulation
+
+      /**
+       * A `import.parse.complete` event.
+       *
+       * @event BaseViewer#ImportParseComplete
+       * @type {Object}
+       * @property {Error|null} error An error thrown when parsing the XML.
+       * @property {ModdleElement} definitions The definitions model element.
+       * @property {ModdleElementsById} elementsById The model elements by ID.
+       * @property {ModdleElement[]} references The referenced model elements.
+       * @property {string[]} warnings The warnings produced when parsing the XML.
+       */
       definitions = this._emit('import.parse.complete', ParseCompleteEvent({
         error: null,
         definitions: definitions,
@@ -21198,6 +21227,14 @@
 
       aggregatedWarnings = aggregatedWarnings.concat(importResult.warnings);
 
+      /**
+       * A `import.parse.complete` event.
+       *
+       * @event BaseViewer#ImportDone
+       * @type {Object}
+       * @property {ImportXMLError|null} error An error thrown during import.
+       * @property {string[]} warnings The warnings.
+       */
       this._emit('import.done', { error: null, warnings: aggregatedWarnings });
 
       return { warnings: aggregatedWarnings };
@@ -21214,21 +21251,6 @@
     }
   });
 
-  /**
-  * The importDefinitions result.
-  *
-  * @typedef {Object} ImportDefinitionsResult
-  *
-  * @property {Array<string>} warnings
-  */
-
-  /**
-  * The importDefinitions error.
-  *
-  * @typedef {Error} ImportDefinitionsError
-  *
-  * @property {Array<string>} warnings
-  */
 
   /**
    * Import parsed definitions and render a BPMN 2.0 diagram.
@@ -21245,10 +21267,12 @@
    *
    * You can use these events to hook into the life-cycle.
    *
-   * @param {ModdleElement<Definitions>} definitions parsed BPMN 2.0 definitions
-   * @param {ModdleElement<BPMNDiagram>|string} [bpmnDiagram] BPMN diagram or id of diagram to render (if not provided, the first one will be rendered)
+   * @throws {ImportDefinitionsError} An error thrown during the import of the definitions.
    *
-   * Returns {Promise<ImportDefinitionsResult, ImportDefinitionsError>}
+   * @param {ModdleElement} definitions The definitions.
+   * @param {ModdleElement|string} [bpmnDiagram] The optional diagram or ID of the BPMN diagram to open.
+   *
+   * @return {Promise<ImportDefinitionsResult>} A promise resolving with warnings that were produced during the import.
    */
   BaseViewer.prototype.importDefinitions = wrapForCompatibility(async function importDefinitions(definitions, bpmnDiagram) {
     this._setDefinitions(definitions);
@@ -21257,21 +21281,6 @@
     return { warnings: result.warnings };
   });
 
-  /**
-   * The open result.
-   *
-   * @typedef {Object} OpenResult
-   *
-   * @property {Array<string>} warnings
-   */
-
-  /**
-  * The open error.
-  *
-  * @typedef {Error} OpenError
-  *
-  * @property {Array<string>} warnings
-  */
 
   /**
    * Open diagram of previously imported XML.
@@ -21288,9 +21297,11 @@
    *
    * You can use these events to hook into the life-cycle.
    *
-   * @param {string|ModdleElement<BPMNDiagram>} [bpmnDiagramOrId] id or the diagram to open
+   * @throws {OpenError} An error thrown during opening.
+   *
+   * @param {ModdleElement|string} bpmnDiagramOrId The diagram or Id of the BPMN diagram to open.
    *
-   * Returns {Promise<OpenResult, OpenError>}
+   * @return {Promise<OpenResult>} A promise resolving with warnings that were produced during opening.
    */
   BaseViewer.prototype.open = wrapForCompatibility(async function open(bpmnDiagramOrId) {
 
@@ -21331,14 +21342,6 @@
     return { warnings };
   });
 
-  /**
-   * The saveXML result.
-   *
-   * @typedef {Object} SaveXMLResult
-   *
-   * @property {string} xml
-   */
-
   /**
    * Export the currently displayed BPMN 2.0 diagram as
    * a BPMN 2.0 XML document.
@@ -21353,11 +21356,14 @@
    *
    * You can use these events to hook into the life-cycle.
    *
-   * @param {Object} [options] export options
-   * @param {boolean} [options.format=false] output formatted XML
-   * @param {boolean} [options.preamble=true] output preamble
+   * @throws {Error} An error thrown during export.
+   *
+   * @fires BaseViewer#SaveXMLStart
+   * @fires BaseViewer#SaveXMLDone
    *
-   * Returns {Promise<SaveXMLResult, Error>}
+   * @param {SaveXMLOptions} [options] The options.
+   *
+   * @return {Promise<SaveXMLResult>} A promise resolving with the XML.
    */
   BaseViewer.prototype.saveXML = wrapForCompatibility(async function saveXML(options) {
 
@@ -21372,6 +21378,14 @@
       }
 
       // allow to fiddle around with definitions
+
+      /**
+       * A `saveXML.start` event.
+       *
+       * @event BaseViewer#SaveXMLStart
+       * @type {Object}
+       * @property {ModdleElement} definitions The definitions model element.
+       */
       definitions = this._emit('saveXML.start', {
         definitions
       }) || definitions;
@@ -21388,6 +21402,14 @@
 
     const result = error ? { error } : { xml };
 
+    /**
+     * A `saveXML.done` event.
+     *
+     * @event BaseViewer#SaveXMLDone
+     * @type {Object}
+     * @property {Error} [error] An error thrown when saving the XML.
+     * @property {string} [xml] The saved XML.
+     */
     this._emit('saveXML.done', result);
 
     if (error) {
@@ -21397,13 +21419,6 @@
     return result;
   });
 
-  /**
-   * The saveSVG result.
-   *
-   * @typedef {Object} SaveSVGResult
-   *
-   * @property {string} svg
-   */
 
   /**
    * Export the currently displayed BPMN 2.0 diagram as
@@ -21418,11 +21433,13 @@
    *
    * You can use these events to hook into the life-cycle.
    *
-   * @param {Object} [options]
+   * @throws {Error} An error thrown during export.
+   *
+   * @fires BaseViewer#SaveSVGDone
    *
-   * Returns {Promise<SaveSVGResult, Error>}
+   * @return {Promise<SaveSVGResult>} A promise resolving with the SVG.
    */
-  BaseViewer.prototype.saveSVG = wrapForCompatibility(async function saveSVG(options = {}) {
+  BaseViewer.prototype.saveSVG = wrapForCompatibility(async function saveSVG() {
     this._emit('saveSVG.start');
 
     let svg, err;
@@ -21451,6 +21468,14 @@
       err = e;
     }
 
+    /**
+     * A `saveSVG.done` event.
+     *
+     * @event BaseViewer#SaveSVGDone
+     * @type {Object}
+     * @property {Error} [error] An error thrown when saving the SVG.
+     * @property {string} [svg] The saved SVG.
+     */
     this._emit('saveSVG.done', {
       error: err,
       svg: svg
@@ -21502,21 +21527,17 @@
   /**
    * Return modules to instantiate with.
    *
-   * @param {any} options the instance got created with
-   *
-   * @return {Module[]}
+   * @return {ModuleDeclaration[]} The modules.
    */
-  BaseViewer.prototype.getModules = function(options) {
+  BaseViewer.prototype.getModules = function() {
     return this._modules;
   };
 
   /**
    * Remove all drawn elements from the viewer.
    *
-   * After calling this method the viewer can still
-   * be reused for opening another diagram.
-   *
-   * @method BaseViewer#clear
+   * After calling this method the viewer can still be reused for opening another
+   * diagram.
    */
   BaseViewer.prototype.clear = function() {
     if (!this.getDefinitions()) {
@@ -21530,8 +21551,8 @@
   };
 
   /**
-   * Destroy the viewer instance and remove all its
-   * remainders from the document tree.
+   * Destroy the viewer instance and remove all its remainders from the document
+   * tree.
    */
   BaseViewer.prototype.destroy = function() {
 
@@ -21543,29 +21564,34 @@
   };
 
   /**
-   * Register an event listener
+   * Register an event listener.
    *
-   * Remove a previously added listener via {@link #off(event, callback)}.
+   * Remove an event listener via {@link BaseViewer#off}.
    *
-   * @param {string} event
-   * @param {number} [priority]
-   * @param {Function} callback
-   * @param {Object} [that]
+   * @param {string|string[]} events The event(s) to listen to.
+   * @param {number} [priority] The priority with which to listen.
+   * @param {EventCallback} callback The callback.
+   * @param {*} [that] Value of `this` the callback will be called with.
    */
-  BaseViewer.prototype.on = function(event, priority, callback, target) {
-    return this.get('eventBus').on(event, priority, callback, target);
+  BaseViewer.prototype.on = function(events, priority, callback, that) {
+    return this.get('eventBus').on(events, priority, callback, that);
   };
 
   /**
-   * De-register an event listener
+   * Remove an event listener.
    *
-   * @param {string} event
-   * @param {Function} callback
+   * @param {string|string[]} events The event(s).
+   * @param {Function} [callback] The callback.
    */
-  BaseViewer.prototype.off = function(event, callback) {
-    this.get('eventBus').off(event, callback);
+  BaseViewer.prototype.off = function(events, callback) {
+    this.get('eventBus').off(events, callback);
   };
 
+  /**
+   * Attach the viewer to an HTML element.
+   *
+   * @param {HTMLElement} parentNode The parent node to attach to.
+   */
   BaseViewer.prototype.attachTo = function(parentNode) {
 
     if (!parentNode) {
@@ -21592,10 +21618,20 @@
     this.get('canvas').resized();
   };
 
+  /**
+   * Get the definitions model element.
+   *
+   * @returns {ModdleElement} The definitions model element.
+   */
   BaseViewer.prototype.getDefinitions = function() {
     return this._definitions;
   };
 
+  /**
+   * Detach the viewer.
+   *
+   * @fires BaseViewer#DetachEvent
+   */
   BaseViewer.prototype.detach = function() {
 
     const container = this._container,
@@ -21605,6 +21641,12 @@
       return;
     }
 
+    /**
+     * A `detach` event.
+     *
+     * @event BaseViewer#DetachEvent
+     * @type {Object}
+     */
     this._emit('detach', {});
 
     parentNode.removeChild(container);
@@ -21642,7 +21684,7 @@
    * @param  {string} type
    * @param  {Object} event
    *
-   * @return {Object} event processing result (if any)
+   * @return {Object} The return value after calling all event listeners.
    */
   BaseViewer.prototype._emit = function(type, event) {
     return this.get('eventBus').fire(type, event);
@@ -21768,7 +21810,7 @@
   /* </project-logo> */
 
   /**
-   * @typedef { import('didi').ModuleDeclaration } Module
+   * @typedef { import('./BaseViewer').BaseViewerOptions } BaseViewerOptions
    */
 
   /**
@@ -21810,13 +21852,7 @@
    * bpmnViewer.importXML(...);
    * ```
    *
-   * @param {Object} [options] configuration options to pass to the viewer
-   * @param {DOMElement} [options.container] the container to render the viewer in, defaults to body.
-   * @param {string|number} [options.width] the width of the viewer
-   * @param {string|number} [options.height] the height of the viewer
-   * @param {Object} [options.moddleExtensions] extension packages to provide
-   * @param {Module[]} [options.modules] a list of modules to override the default modules
-   * @param {Module[]} [options.additionalModules] a list of modules to use with the default modules
+   * @param {BaseViewerOptions} [options] The options to configure the viewer.
    */
   function Viewer(options) {
     BaseViewer.call(this, options);