bpmn-js 13.0.0 → 13.0.2

package/lib/BaseViewer.d.ts

@@ -1,160 +1,160 @@
-/**
- * A base viewer for BPMN 2.0 diagrams.
- *
- * Have a look at {@link Viewer}, {@link NavigatedViewer} or {@link Modeler} for
- * bundles that include actual features.
- *
- */
-export default class BaseViewer extends Diagram {
-  /**
-   * @param options The options to configure the viewer.
-   */
-  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>;
-
-  /**
-   * Return modules to instantiate with.
-   *
-   * @return The modules.
-   */
-  getModules(): ModuleDeclaration[];
-
-  /**
-   * Register an event listener.
-   *
-   * Remove an event listener via {@link BaseViewer#off}.
-   *
-   *
-   * @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;
-
-  /**
-   * Register an event listener.
-   *
-   * Remove an event listener via {@link BaseViewer#off}.
-   *
-   *
-   * @param events The event(s) to listen to.
-   * @param priority The priority with which to listen.
-   * @param callback The callback.
-   * @param that Value of `this` the callback will be called with.
-   */
-  on<T>(
-    events: string | string[],
-    priority: number,
-    callback: EventBusEventCallback<T>,
-    that?: any
-  ): any;
-
-  /**
-   * Remove an event listener.
-   *
-   * @param events The event(s).
-   * @param callback The callback.
-   */
-  off(events: string | string[], callback?: Function): void;
-
-  /**
-   * Attach the viewer to an HTML element.
-   *
-   * @param parentNode The parent node to attach to.
-   */
-  attachTo(parentNode: HTMLElement): void;
-
-  /**
-   * Get the definitions model element.
-   *
-   * @return The definitions model element.
-   */
-  getDefinitions(): ModdleElement;
-
-  /**
-   * Detach the viewer.
-   *
-   * @fires BaseViewer#DetachEvent
-   */
-  detach(): void;
-}
-
-type EventBusEventCallback<T> = import('diagram-js/lib/core/EventBus').EventBusEventCallback<T>;
-type ModuleDeclaration = import('didi').ModuleDeclaration;
-type Moddle = import('./model/Types').Moddle;
-type ModdleElement = import('./model/Types').ModdleElement;
-type ModdleExtension = import('./model/Types').ModdleExtension;
-
-export type BaseViewerOptions = {
-    width?: number | string;
-    height?: number | string;
-    position?: string;
-    container?: string | HTMLElement;
-    moddleExtensions?: ModdleExtensions;
-    additionalModules?: ModuleDeclaration[];
-} & Record<string, any>;
-
-export type ModdleElementsById = Record<string, ModdleElement>;
-
-export type ModdleExtensions = {
-    [key: string]: import("./model/Types").ModdleExtension;
-};
-
-export type ImportXMLResult = {
-    warnings: string[];
-};
-
-export type ImportXMLError = ImportXMLResult & Error;
-export type ImportDefinitionsResult = ImportXMLResult;
-export type ImportDefinitionsError = ImportXMLError;
-export type OpenResult = ImportXMLResult;
-export type OpenError = ImportXMLError;
-
-export type SaveXMLOptions = {
-    format?: boolean;
-    preamble?: boolean;
-};
-
-export type SaveXMLResult = {
-    xml?: string;
-    error?: Error;
-};
-
-export type SaveSVGResult = {
-    svg: string;
-};
-
-export type ImportParseStartEvent = {
-    xml: string;
-};
-
-export type ImportParseCompleteEvent = {
-    error?: ImportXMLError;
-    definitions?: ModdleElement;
-    elementsById?: ModdleElementsById;
-    references?: ModdleElement[];
-    warnings: string[];
-};
-
-export type ImportDoneEvent = {
-    error?: ImportXMLError;
-    warnings: string[];
-};
-
-export type SaveXMLStartEvent = {
-    definitions: ModdleElement;
-};
-
-export type SaveXMLDoneEvent = SaveXMLResult;
-
-export type SaveSVGDoneEvent = {
-    error?: Error;
-    svg: string;
-};
-
-import Diagram from 'diagram-js';
+/**
+ * A base viewer for BPMN 2.0 diagrams.
+ *
+ * Have a look at {@link Viewer}, {@link NavigatedViewer} or {@link Modeler} for
+ * bundles that include actual features.
+ *
+ */
+export default class BaseViewer extends Diagram {
+  /**
+   * @param options The options to configure the viewer.
+   */
+  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>;
+
+  /**
+   * Return modules to instantiate with.
+   *
+   * @return The modules.
+   */
+  getModules(): ModuleDeclaration[];
+
+  /**
+   * Register an event listener.
+   *
+   * Remove an event listener via {@link BaseViewer#off}.
+   *
+   *
+   * @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;
+
+  /**
+   * Register an event listener.
+   *
+   * Remove an event listener via {@link BaseViewer#off}.
+   *
+   *
+   * @param events The event(s) to listen to.
+   * @param priority The priority with which to listen.
+   * @param callback The callback.
+   * @param that Value of `this` the callback will be called with.
+   */
+  on<T>(
+    events: string | string[],
+    priority: number,
+    callback: EventBusEventCallback<T>,
+    that?: any
+  ): any;
+
+  /**
+   * Remove an event listener.
+   *
+   * @param events The event(s).
+   * @param callback The callback.
+   */
+  off(events: string | string[], callback?: Function): void;
+
+  /**
+   * Attach the viewer to an HTML element.
+   *
+   * @param parentNode The parent node to attach to.
+   */
+  attachTo(parentNode: HTMLElement): void;
+
+  /**
+   * Get the definitions model element.
+   *
+   * @return The definitions model element.
+   */
+  getDefinitions(): ModdleElement;
+
+  /**
+   * Detach the viewer.
+   *
+   * @fires BaseViewer#DetachEvent
+   */
+  detach(): void;
+}
+
+type EventBusEventCallback<T> = import('diagram-js/lib/core/EventBus').EventBusEventCallback<T>;
+type ModuleDeclaration = import('didi').ModuleDeclaration;
+type Moddle = import('./model/Types').Moddle;
+type ModdleElement = import('./model/Types').ModdleElement;
+type ModdleExtension = import('./model/Types').ModdleExtension;
+
+export type BaseViewerOptions = {
+    width?: number | string;
+    height?: number | string;
+    position?: string;
+    container?: string | HTMLElement;
+    moddleExtensions?: ModdleExtensions;
+    additionalModules?: ModuleDeclaration[];
+} & Record<string, any>;
+
+export type ModdleElementsById = Record<string, ModdleElement>;
+
+export type ModdleExtensions = {
+    [key: string]: import("./model/Types").ModdleExtension;
+};
+
+export type ImportXMLResult = {
+    warnings: string[];
+};
+
+export type ImportXMLError = ImportXMLResult & Error;
+export type ImportDefinitionsResult = ImportXMLResult;
+export type ImportDefinitionsError = ImportXMLError;
+export type OpenResult = ImportXMLResult;
+export type OpenError = ImportXMLError;
+
+export type SaveXMLOptions = {
+    format?: boolean;
+    preamble?: boolean;
+};
+
+export type SaveXMLResult = {
+    xml?: string;
+    error?: Error;
+};
+
+export type SaveSVGResult = {
+    svg: string;
+};
+
+export type ImportParseStartEvent = {
+    xml: string;
+};
+
+export type ImportParseCompleteEvent = {
+    error?: ImportXMLError;
+    definitions?: ModdleElement;
+    elementsById?: ModdleElementsById;
+    references?: ModdleElement[];
+    warnings: string[];
+};
+
+export type ImportDoneEvent = {
+    error?: ImportXMLError;
+    warnings: string[];
+};
+
+export type SaveXMLStartEvent = {
+    definitions: ModdleElement;
+};
+
+export type SaveXMLDoneEvent = SaveXMLResult;
+
+export type SaveSVGDoneEvent = {
+    error?: Error;
+    svg: string;
+};
+
+import Diagram from 'diagram-js';

package/lib/Modeler.d.ts

@@ -1,76 +1,76 @@
-/**
- * A modeler for BPMN 2.0 diagrams.
- *
- *
- * ## Extending the Modeler
- *
- * In order to extend the viewer pass extension modules to bootstrap via the
- * `additionalModules` option. An extension module is an object that exposes
- * named services.
- *
- * The following example depicts the integration of a simple
- * logging component that integrates with interaction events:
- *
- *
- * ```javascript
- *
- * // logging component
- * function InteractionLogger(eventBus) {
- *   eventBus.on('element.hover', function(event) {
- *     console.log()
- *   })
- * }
- *
- * InteractionLogger.$inject = [ 'eventBus' ]; // minification save
- *
- * // extension module
- * var extensionModule = {
- *   __init__: [ 'interactionLogger' ],
- *   interactionLogger: [ 'type', InteractionLogger ]
- * };
- *
- * // extend the viewer
- * var bpmnModeler = new Modeler({ additionalModules: [ extensionModule ] });
- * bpmnModeler.importXML(...);
- * ```
- *
- *
- * ## Customizing / Replacing Components
- *
- * You can replace individual diagram components by redefining them in override modules.
- * This works for all components, including those defined in the core.
- *
- * Pass in override modules via the `options.additionalModules` flag like this:
- *
- * ```javascript
- * function CustomContextPadProvider(contextPad) {
- *
- *   contextPad.registerProvider(this);
- *
- *   this.getContextPadEntries = function(element) {
- *     // no entries, effectively disable the context pad
- *     return {};
- *   };
- * }
- *
- * CustomContextPadProvider.$inject = [ 'contextPad' ];
- *
- * var overrideModule = {
- *   contextPadProvider: [ 'type', CustomContextPadProvider ]
- * };
- *
- * var bpmnModeler = new Modeler({ additionalModules: [ overrideModule ]});
- * ```
- *
- */
-export default class Modeler extends BaseModeler {
-  static Viewer: typeof Viewer;
-  static NavigatedViewer: typeof NavigatedViewer;
-  createDiagram: () => Promise<ImportXMLResult>;
-}
-
-type BaseViewerOptions = import('./BaseViewer').BaseViewerOptions;
-type ImportXMLResult = import('./BaseViewer').ImportXMLResult;
-import BaseModeler from './BaseModeler';
-import Viewer from './Viewer';
-import NavigatedViewer from './NavigatedViewer';
+/**
+ * A modeler for BPMN 2.0 diagrams.
+ *
+ *
+ * ## Extending the Modeler
+ *
+ * In order to extend the viewer pass extension modules to bootstrap via the
+ * `additionalModules` option. An extension module is an object that exposes
+ * named services.
+ *
+ * The following example depicts the integration of a simple
+ * logging component that integrates with interaction events:
+ *
+ *
+ * ```javascript
+ *
+ * // logging component
+ * function InteractionLogger(eventBus) {
+ *   eventBus.on('element.hover', function(event) {
+ *     console.log()
+ *   })
+ * }
+ *
+ * InteractionLogger.$inject = [ 'eventBus' ]; // minification save
+ *
+ * // extension module
+ * var extensionModule = {
+ *   __init__: [ 'interactionLogger' ],
+ *   interactionLogger: [ 'type', InteractionLogger ]
+ * };
+ *
+ * // extend the viewer
+ * var bpmnModeler = new Modeler({ additionalModules: [ extensionModule ] });
+ * bpmnModeler.importXML(...);
+ * ```
+ *
+ *
+ * ## Customizing / Replacing Components
+ *
+ * You can replace individual diagram components by redefining them in override modules.
+ * This works for all components, including those defined in the core.
+ *
+ * Pass in override modules via the `options.additionalModules` flag like this:
+ *
+ * ```javascript
+ * function CustomContextPadProvider(contextPad) {
+ *
+ *   contextPad.registerProvider(this);
+ *
+ *   this.getContextPadEntries = function(element) {
+ *     // no entries, effectively disable the context pad
+ *     return {};
+ *   };
+ * }
+ *
+ * CustomContextPadProvider.$inject = [ 'contextPad' ];
+ *
+ * var overrideModule = {
+ *   contextPadProvider: [ 'type', CustomContextPadProvider ]
+ * };
+ *
+ * var bpmnModeler = new Modeler({ additionalModules: [ overrideModule ]});
+ * ```
+ *
+ */
+export default class Modeler extends BaseModeler {
+  static Viewer: typeof Viewer;
+  static NavigatedViewer: typeof NavigatedViewer;
+  createDiagram: () => Promise<ImportXMLResult>;
+}
+
+type BaseViewerOptions = import('./BaseViewer').BaseViewerOptions;
+type ImportXMLResult = import('./BaseViewer').ImportXMLResult;
+import BaseModeler from './BaseModeler';
+import Viewer from './Viewer';
+import NavigatedViewer from './NavigatedViewer';

package/lib/NavigatedViewer.d.ts

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

package/lib/Viewer.d.ts

@@ -1,44 +1,44 @@
-/**
- * A viewer for BPMN 2.0 diagrams.
- *
- * Have a look at {@link NavigatedViewer} or {@link Modeler} for bundles that include
- * additional features.
- *
- *
- * ## Extending the Viewer
- *
- * In order to extend the viewer pass extension modules to bootstrap via the
- * `additionalModules` option. An extension module is an object that exposes
- * named services.
- *
- * The following example depicts the integration of a simple
- * logging component that integrates with interaction events:
- *
- *
- * ```javascript
- *
- * // logging component
- * function InteractionLogger(eventBus) {
- *   eventBus.on('element.hover', function(event) {
- *     console.log()
- *   })
- * }
- *
- * InteractionLogger.$inject = [ 'eventBus' ]; // minification save
- *
- * // extension module
- * var extensionModule = {
- *   __init__: [ 'interactionLogger' ],
- *   interactionLogger: [ 'type', InteractionLogger ]
- * };
- *
- * // extend the viewer
- * var bpmnViewer = new Viewer({ additionalModules: [ extensionModule ] });
- * bpmnViewer.importXML(...);
- * ```
- *
- */
-export default class Viewer extends BaseViewer {}
-
-type BaseViewerOptions = import('./BaseViewer').BaseViewerOptions;
-import BaseViewer from './BaseViewer';
+/**
+ * A viewer for BPMN 2.0 diagrams.
+ *
+ * Have a look at {@link NavigatedViewer} or {@link Modeler} for bundles that include
+ * additional features.
+ *
+ *
+ * ## Extending the Viewer
+ *
+ * In order to extend the viewer pass extension modules to bootstrap via the
+ * `additionalModules` option. An extension module is an object that exposes
+ * named services.
+ *
+ * The following example depicts the integration of a simple
+ * logging component that integrates with interaction events:
+ *
+ *
+ * ```javascript
+ *
+ * // logging component
+ * function InteractionLogger(eventBus) {
+ *   eventBus.on('element.hover', function(event) {
+ *     console.log()
+ *   })
+ * }
+ *
+ * InteractionLogger.$inject = [ 'eventBus' ]; // minification save
+ *
+ * // extension module
+ * var extensionModule = {
+ *   __init__: [ 'interactionLogger' ],
+ *   interactionLogger: [ 'type', InteractionLogger ]
+ * };
+ *
+ * // extend the viewer
+ * var bpmnViewer = new Viewer({ additionalModules: [ extensionModule ] });
+ * bpmnViewer.importXML(...);
+ * ```
+ *
+ */
+export default class Viewer extends BaseViewer {}
+
+type BaseViewerOptions = import('./BaseViewer').BaseViewerOptions;
+import BaseViewer from './BaseViewer';

package/lib/core/index.d.ts

@@ -1,10 +1,10 @@
-declare namespace _default {
-    const __depends__: ({
-      bpmnRenderer: (string | typeof import("../draw/BpmnRenderer").default)[];
-      textRenderer: (string | typeof import("../draw/TextRenderer").default)[];
-      pathMap: (string | typeof import("../draw/PathMap").default)[];
-    } | {
-      bpmnImporter: (string | typeof import("../import/BpmnImporter").default)[];
-    })[];
-}
-export default _default;
+declare namespace _default {
+    const __depends__: ({
+      bpmnRenderer: (string | typeof import("../draw/BpmnRenderer").default)[];
+      textRenderer: (string | typeof import("../draw/TextRenderer").default)[];
+      pathMap: (string | typeof import("../draw/PathMap").default)[];
+    } | {
+      bpmnImporter: (string | typeof import("../import/BpmnImporter").default)[];
+    })[];
+}
+export default _default;