bpmn-js 12.1.0 → 13.0.0

package/lib/BaseModeler.d.ts

@@ -1,5 +1,12 @@
-import BaseViewer from "./BaseViewer";
-
-export type Moddle = Object;
-
-export default class BaseModeler extends BaseViewer {}
+/**
+ * A base modeler for BPMN 2.0 diagrams.
+ *
+ * See {@link Modeler} for a fully-featured modeler.
+ *
+ */
+export default class BaseModeler extends BaseViewer {}
+
+type BaseViewerOptions = import('./BaseViewer').BaseViewerOptions;
+type ModdleElementsById = import('./BaseViewer').ModdleElementsById;
+type ModdleElement = import('./model/Types').ModdleElement;
+import BaseViewer from './BaseViewer';

package/lib/BaseModeler.js

@@ -6,11 +6,10 @@ import BaseViewer from './BaseViewer';
 
 
 /**
- * @typedef {import('./BaseViewer').BaseModelerOptions} BaseModelerOptions
- * @typedef {import('./BaseViewer').ModdleElement} ModdleElement
+ * @typedef {import('./BaseViewer').BaseViewerOptions} BaseViewerOptions
  * @typedef {import('./BaseViewer').ModdleElementsById} ModdleElementsById
  *
- * @typedef {import('.').Moddle} Moddle
+ * @typedef {import('./model/Types').ModdleElement} ModdleElement
  */
 
 /**
@@ -18,7 +17,7 @@ import BaseViewer from './BaseViewer';
  *
  * See {@link Modeler} for a fully-featured modeler.
  *
- * @param {BaseModelerOptions} [options] The options to configure the modeler.
+ * @param {BaseViewerOptions} [options] The options to configure the modeler.
  */
 export default function BaseModeler(options) {
   BaseViewer.call(this, options);
@@ -41,7 +40,7 @@ inherits(BaseModeler, BaseViewer);
 /**
  * Create a moddle instance, attaching IDs to it.
  *
- * @param {BaseModelerOptions} options
+ * @param {BaseViewerOptions} options
  *
  * @return {Moddle}
  */

package/lib/BaseViewer.d.ts

@@ -1,366 +1,160 @@
-import { ModuleDeclaration } from "didi";
-
-import Diagram from 'diagram-js/lib/Diagram';
-
-import {
-  Event,
-  EventCallback
-} from 'diagram-js/lib/core/EventBus';
-
-export type ModdleExtension = Object;
-
-export type ModdleExtensions = {
-  [key: string]: ModdleExtension;
-};
-
-export type BaseViewerOptions = {
-  width?: number|string;
-  height?: number|string;
-  position?: string;
-  container?: string|HTMLElement;
-  moddleExtensions?: ModdleExtensions;
-  additionalModules?: ModuleDeclaration[];
-} & Record<string, any>;
-
-export type ModdleElement = Object;
-
-export type ModdleElementsById = {
-  [id: string]: ModdleElement;
-};
-
-export type ImportXMLResult = {
-
-  /**
-   * The warnings produced when parsing the XML.
-   */
-  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 = {
-
-  /**
-   * Whether to format the XML. Defaults to `false`.
-   */
-  format?: boolean;
-
-  /**
-   * Whether to include the preamble. Defaults to `true`.
-   */
-  preamble?: boolean;
-};
-
-export type SaveXMLResult = {
-
-  /**
-   * The saved XML.
-   */
-  xml?: string;
-
-  /**
-   * An error thrown when saving the XML.
-   */
-  error?: Error;
-};
-
-export type SaveSVGResult = {
-  svg: string;
-};
-
-declare namespace Events {
-
-  /**
-   * A `import.parse.start` event.
-   */
-  export type ImportParseStart = {
-  
-    /**
-     * The XML that is to be parsed.
-     */
-    xml: string;
-  } & Event;
-
-  /**
-   * A `import.parse.complete` event.
-   */
-  export type ImportParseComplete = {
-  
-    /**
-     * An error thrown when parsing the XML.
-     */
-    error?: ImportXMLError;
-
-    /**
-     * The definitions model element.
-     */
-    definitions?: ModdleElement;
-
-    /**
-     * The model elements by ID.
-     */
-    elementsById?: ModdleElementsById;
-
-    /**
-     * The referenced model elements.
-     */
-    references?: ModdleElement[];
-
-    /**
-     * The warnings produced when parsing the XML.
-     */
-    warnings: string[];
-  } & Event;
-
-  /**
-   * A `import.done` event.
-   */
-  export type ImportDone = {
-
-    /**
-     * An error thrown when parsing the XML.
-     */
-    error?: ImportXMLError;
-
-    /**
-     * The warnings produced when parsing the XML.
-     */
-    warnings: string[];
-  } & Event;
-
-  /**
-   * A `saveXML.start` event.
-   */
-  export type SaveXMLStart = {
-
-    /**
-     * The definitions model element.
-     */
-    definitions: ModdleElement;
-  } & Event;
-
-  /**
-   * A `saveXML.done` event.
-   */
-  export type SaveXMLDone = SaveXMLResult & Event;
-  
-  /**
-   * A `saveSVG.done` event.
-   */
-  export type SaveSVGDone = {
-
-    /**
-     * An error thrown when saving the SVG.
-     */
-    error?: Error;
-
-    /**
-     * The saved SVG.
-     */
-    svg: string;
-  } & Event;
-}
-
-export default class BaseViewer extends Diagram {
-
-  /**
-   * The constructor.
-   *
-   * @param options The options to configure the viewer.
-   */
-  constructor(options?: BaseViewerOptions);
-
-  /**
-   * Parse and render a BPMN 2.0 diagram.
-   *
-   * Once finished the viewer reports back the result to the
-   * provided callback function with (err, warnings).
-   *
-   * ## Life-Cycle Events
-   *
-   * During import the viewer will fire life-cycle events:
-   *
-   *   * 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)
-   *   * import.done (everything done)
-   *
-   * You can use these events to hook into the life-cycle.
-   *
-   * @throws An error thrown during the import of the XML.
-   *
-   * @param xml The BPMN 2.0 XML to be imported.
-   * @param bpmnDiagram The optional diagram or Id of the BPMN diagram to open.
-   *
-   * @return A promise resolving with warnings that were produced during the import.
-   */
-  importXML(xml: string, bpmnDiagram?: ModdleElement | string): Promise<ImportXMLResult>;
-
-  /**
-   * Import parsed definitions and render a BPMN 2.0 diagram.
-   *
-   * Once finished the viewer reports back the result to the
-   * provided callback function with (err, warnings).
-   *
-   * ## Life-Cycle Events
-   *
-   * During import the viewer will fire life-cycle events:
-   *
-   *   * import.render.start (graphical import start)
-   *   * import.render.complete (graphical import finished)
-   *
-   * You can use these events to hook into the life-cycle.
-   *
-   * @throws An error thrown during the import of the definitions.
-   *
-   * @param definitions The definitions.
-   * @param bpmnDiagram The optional diagram or ID of the BPMN diagram to open.
-   *
-   * @return A promise resolving with warnings that were produced during the import.
-   */
-  importDefinitions(definitions: ModdleElement, bpmnDiagram?: ModdleElement | string): Promise<ImportDefinitionsResult>;
-
-  /**
-   * Open diagram of previously imported XML.
-   *
-   * Once finished the viewer reports back the result to the
-   * provided callback function with (err, warnings).
-   *
-   * ## Life-Cycle Events
-   *
-   * During switch the viewer will fire life-cycle events:
-   *
-   *   * import.render.start (graphical import start)
-   *   * import.render.complete (graphical import finished)
-   *
-   * You can use these events to hook into the life-cycle.
-   *
-   * @throws An error thrown during opening.
-   *
-   * @param bpmnDiagramOrId The diagram or Id of the BPMN diagram to open.
-   *
-   * @return A promise resolving with warnings that were produced during opening.
-   */
-  open(bpmnDiagramOrId: ModdleElement | string): Promise<OpenResult>;
-
-  /**
-   * Export the currently displayed BPMN 2.0 diagram as
-   * a BPMN 2.0 XML document.
-   *
-   * ## Life-Cycle Events
-   *
-   * During XML saving the viewer will fire life-cycle events:
-   *
-   *   * saveXML.start (before serialization)
-   *   * saveXML.serialized (after xml generation)
-   *   * saveXML.done (everything done)
-   *
-   * You can use these events to hook into the life-cycle.
-   *
-   * @throws An error thrown during export.
-   *
-   * @param options The options.
-   *
-   * @return A promise resolving with the XML.
-   */
-  saveXML(options?: SaveXMLOptions): Promise<SaveXMLResult>;
-
-  /**
-   * Export the currently displayed BPMN 2.0 diagram as
-   * an SVG image.
-   *
-   * ## Life-Cycle Events
-   *
-   * During SVG saving the viewer will fire life-cycle events:
-   *
-   *   * saveSVG.start (before serialization)
-   *   * saveSVG.done (everything done)
-   *
-   * You can use these events to hook into the life-cycle.
-   *
-   * @throws An error thrown during export.
-   *
-   * @return A promise resolving with the SVG.
-   */
-  saveSVG(): Promise<SaveSVGResult>;
-
-  /**
-   * Return modules to instantiate with.
-   *
-   * @return The modules.
-   */
-  getModules(): ModuleDeclaration[];
-
-  /**
-   * Remove all drawn elements from the viewer.
-   *
-   * After calling this method the viewer can still be reused for opening another
-   * diagram.
-   */
-  clear(): void;
-
-  /**
-   * Destroy the viewer instance and remove all its remainders from the document
-   * tree.
-   */
-  destroy(): void;
-
-  /**
-   * Register an event listener.
-   *
-   * Remove a previously added 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 extends Event>(events: string | string[], callback: EventCallback<T>, that?: any): void;
-
-  /**
-   * Register an event listener.
-   *
-   * Remove a previously added 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 extends Event>(events: string | string[], priority: number, callback: EventCallback<T>, that?: any): void;
-
-  /**
-   * Remove an event listener.
-   *
-   * @param events The event(s).
-   * @param callback The callback.
-   */
-  off(events: string | string[], callback?: EventCallback<any>): 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.
-   *
-   * @returns The definitions model element.
-   */
-  getDefinitions(): ModdleElement | undefined;
-
-  /**
-   * Detach the viewer.
-   */
-  detach(): void;
-}
+/**
+ * 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';