chore(BaseViewer): inline events

bpmn-io · Apr 3, 2023 · 461a2fc · 461a2fc
1 parent c57ccb7
commit 461a2fc
Showing 1 changed file with 45 additions and 30 deletions.
diff --git a/lib/BaseViewer.js b/lib/BaseViewer.js
@@ -90,6 +90,34 @@ import {
  * @typedef { {
  *   svg: string;
  * } } SaveSVGResult
+ *
+ * @typedef { {
+ *   xml: string;
+ * } } ImportParseStartEvent
+ *
+ * @typedef { {
+ *   error?: ImportXMLError;
+ *   definitions?: ModdleElement;
+ *   elementsById?: ModdleElementsById;
+ *   references?: ModdleElement[];
+ *   warnings: string[];
+ * } } ImportParseCompleteEvent
+ *
+ * @typedef { {
+ *   error?: ImportXMLError;
+ *   warnings: string[];
+ * } } ImportDoneEvent
+ *
+ * @typedef { {
+ *   definitions: ModdleElement;
+ * } } SaveXMLStartEvent
+ *
+ * @typedef {SaveXMLResult} SaveXMLDoneEvent
+ *
+ * @typedef { {
+ *   error?: Error;
+ *   svg: string;
+ * } } SaveSVGDoneEvent
  */
 
 /**
@@ -145,11 +173,11 @@ inherits(BaseViewer, Diagram);
  *
  * @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
+ * @fires BaseViewer#ImportParseStartEvent
+ * @fires BaseViewer#ImportParseCompleteEvent
+ * @fires Importer#ImportRenderStartEvent
+ * @fires Importer#ImportRenderCompleteEvent
+ * @fires BaseViewer#ImportDoneEvent
  *
  * @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.
@@ -194,9 +222,8 @@ BaseViewer.prototype.importXML = async function importXML(xml, bpmnDiagram) {
     /**
      * A `import.parse.start` event.
      *
-     * @event BaseViewer#ImportParseStart
-     * @type {Object}
-     * @property {string} xml The XML that is to be parsed.
+     * @event BaseViewer#ImportParseStartEvent
+     * @type {ImportParseStartEvent}
      */
     xml = this._emit('import.parse.start', { xml: xml }) || xml;
 
@@ -224,13 +251,8 @@ BaseViewer.prototype.importXML = async function importXML(xml, bpmnDiagram) {
     /**
      * 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.
+     * @event BaseViewer#ImportParseCompleteEvent
+     * @type {ImportParseCompleteEvent}
      */
     definitions = this._emit('import.parse.complete', ParseCompleteEvent({
       error: null,
@@ -247,10 +269,8 @@ BaseViewer.prototype.importXML = async function importXML(xml, bpmnDiagram) {
     /**
      * A `import.parse.complete` event.
      *
-     * @event BaseViewer#ImportDone
-     * @type {Object}
-     * @property {ImportXMLError|null} error An error thrown during import.
-     * @property {string[]} warnings The warnings.
+     * @event BaseViewer#ImportDoneEvent
+     * @type {ImportDoneEvent}
      */
     this._emit('import.done', { error: null, warnings: aggregatedWarnings });
 
@@ -405,9 +425,8 @@ BaseViewer.prototype.saveXML = async function saveXML(options) {
     /**
      * A `saveXML.start` event.
      *
-     * @event BaseViewer#SaveXMLStart
-     * @type {Object}
-     * @property {ModdleElement} definitions The definitions model element.
+     * @event BaseViewer#SaveXMLStartEvent
+     * @type {SaveXMLStartEvent}
      */
     definitions = this._emit('saveXML.start', {
       definitions
@@ -428,10 +447,8 @@ BaseViewer.prototype.saveXML = async function saveXML(options) {
   /**
    * 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.
+   * @event BaseViewer#SaveXMLDoneEvent
+   * @type {SaveXMLDoneEvent}
    */
   this._emit('saveXML.done', result);
 
@@ -496,10 +513,8 @@ BaseViewer.prototype.saveSVG = async function saveSVG() {
   /**
    * 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.
+   * @event BaseViewer#SaveSVGDoneEvent
+   * @type {SaveSVGDoneEvent}
    */
   this._emit('saveSVG.done', {
     error: err,