bpmn-js 9.0.0-subprocesses.0 → 9.0.0

package/lib/import/Importer.js

@@ -1,5 +1,13 @@
+import {
+  find,
+  forEach,
+  map
+} from 'min-dash';
+
 import BpmnTreeWalker from './BpmnTreeWalker';
 
+import { is } from '../util/ModelUtil';
+
 
 /**
  * The importBpmnDiagram result.
@@ -50,12 +58,12 @@ export function importBpmnDiagram(diagram, definitions, bpmnDiagram) {
 
     var visitor = {
 
-      root: function(element) {
-        return importer.add(element);
+      root: function(element, di) {
+        return importer.add(element, di);
       },
 
-      element: function(element, parentShape) {
-        return importer.add(element, parentShape);
+      element: function(element, di, parentShape) {
+        return importer.add(element, di, parentShape);
       },
 
       error: function(message, context) {
@@ -65,18 +73,29 @@ export function importBpmnDiagram(diagram, definitions, bpmnDiagram) {
 
     var walker = new BpmnTreeWalker(visitor, translate);
 
-    // traverse BPMN 2.0 document model,
-    // starting at definitions
-    if (!bpmnDiagram && definitions.diagrams) {
-      for (var i = 0; i < definitions.diagrams.length; i++) {
-        walker.handleDefinitions(definitions, definitions.diagrams[i]);
-      }
-    } else {
-      walker.handleDefinitions(definitions, bpmnDiagram);
+
+    bpmnDiagram = bpmnDiagram || (definitions.diagrams && definitions.diagrams[0]);
+
+    var diagramsToImport = getDiagramsToImport(definitions, bpmnDiagram);
+
+    if (!diagramsToImport) {
+      throw new Error(translate('no diagram to display'));
     }
 
-    var mainDiagram = bpmnDiagram || definitions.diagrams[0];
-    canvas.setActivePlane(mainDiagram.plane.bpmnElement.id);
+    // traverse BPMN 2.0 document model,
+    // starting at definitions
+    forEach(diagramsToImport, function(diagram) {
+      walker.handleDefinitions(definitions, diagram);
+    });
+
+    var rootId = bpmnDiagram.plane.bpmnElement.id;
+
+    // we do need to account for different ways we create root elements
+    // each nested imported <root> do have the `_plane` suffix, while
+    // the root <root> is found under the business object ID
+    canvas.setRootElement(
+      canvas.findRoot(rootId + '_plane') || canvas.findRoot(rootId)
+    );
   }
 
   return new Promise(function(resolve, reject) {
@@ -103,3 +122,104 @@ export function importBpmnDiagram(diagram, definitions, bpmnDiagram) {
     }
   });
 }
+
+/**
+ * Returns all diagrams in the same hirarchy as the requested diagram.
+ * Includes all parent and sub process diagrams.
+ *
+ * @param {Array} definitions
+ * @param {Object} bpmnDiagram
+ *
+ * @returns {Array<Object>}
+ */
+function getDiagramsToImport(definitions, bpmnDiagram) {
+  if (!bpmnDiagram) {
+    return;
+  }
+
+  var bpmnElement = bpmnDiagram.plane.bpmnElement,
+      rootElement = bpmnElement;
+
+  if (!is(bpmnElement, 'bpmn:Process') && !is(bpmnElement, 'bpmn:Collaboration')) {
+    rootElement = findRootProcess(bpmnElement);
+  }
+
+  // in case the process is part of a collaboration, the plane references the
+  // collaboration, not the process
+  var collaboration;
+
+  if (is(rootElement, 'bpmn:Collaboration')) {
+    collaboration = rootElement;
+  } else {
+    collaboration = find(definitions.rootElements, function(element) {
+      if (!is(element, 'bpmn:Collaboration')) {
+        return;
+      }
+
+      return find(element.participants, function(participant) {
+        return participant.processRef === rootElement;
+      });
+    });
+  }
+
+  var rootElements = [ rootElement ];
+
+  // all collaboration processes can contain sub-diagrams
+  if (collaboration) {
+    rootElements = map(collaboration.participants, function(participant) {
+      return participant.processRef;
+    });
+
+    rootElements.push(collaboration);
+  }
+
+  var allChildren = selfAndAllFlowElements(rootElements);
+
+  // if we have multiple diagrams referencing the same element, we
+  // use the first in the file
+  var diagramsToImport = [ bpmnDiagram ];
+  var handledElements = [ bpmnElement ];
+
+  forEach(definitions.diagrams, function(diagram) {
+    var businessObject = diagram.plane.bpmnElement;
+
+    if (
+      allChildren.indexOf(businessObject) !== -1 &&
+      handledElements.indexOf(businessObject) === -1
+    ) {
+      diagramsToImport.push(diagram);
+      handledElements.push(businessObject);
+    }
+  });
+
+
+  return diagramsToImport;
+}
+
+function selfAndAllFlowElements(elements) {
+  var result = [];
+
+  forEach(elements, function(element) {
+    if (!element) {
+      return;
+    }
+
+    result.push(element);
+
+    result = result.concat(selfAndAllFlowElements(element.flowElements));
+  });
+
+  return result;
+}
+
+function findRootProcess(element) {
+  var parent = element;
+
+  while (parent) {
+    if (is(parent, 'bpmn:Process')) {
+      return parent;
+    }
+
+    parent = parent.$parent;
+  }
+}

package/lib/util/DiUtil.js

@@ -10,6 +10,7 @@ import {
 
 
 export function isExpanded(element, di) {
+
   if (is(element, 'bpmn:CallActivity')) {
     return false;
   }

package/lib/util/DrilldownUtil.js

@@ -0,0 +1,66 @@
+import { getDi, is } from './ModelUtil';
+
+
+export var planeSuffix = '_plane';
+
+/**
+ * Get primary shape ID for a plane.
+ *
+ * @param  {djs.model.Base|ModdleElement} element
+ *
+ * @returns {String}
+ */
+export function getShapeIdFromPlane(element) {
+  var id = element.id;
+
+  return removePlaneSuffix(id);
+}
+
+/**
+ * Get plane ID for a primary shape.
+ *
+ * @param  {djs.model.Base|ModdleElement} element
+ *
+ * @returns {String}
+ */
+export function getPlaneIdFromShape(element) {
+  var id = element.id;
+
+  if (is(element, 'bpmn:SubProcess')) {
+    return addPlaneSuffix(id);
+  }
+
+  return id;
+}
+
+/**
+ * Get plane ID for primary shape ID.
+ *
+ * @param {String} id
+ *
+ * @returns {String}
+ */
+export function toPlaneId(id) {
+  return addPlaneSuffix(id);
+}
+
+/**
+ * Check wether element is plane.
+ *
+ * @param  {djs.model.Base|ModdleElement} element
+ *
+ * @returns {Boolean}
+ */
+export function isPlane(element) {
+  var di = getDi(element);
+
+  return is(di, 'bpmndi:BPMNPlane');
+}
+
+function addPlaneSuffix(id) {
+  return id + planeSuffix;
+}
+
+function removePlaneSuffix(id) {
+  return id.replace(new RegExp(planeSuffix + '$'), '');
+}

package/lib/util/ModelUtil.js

@@ -1,3 +1,8 @@
+import {
+  some
+} from 'min-dash';
+
+
 /**
  * Is an element of the given BPMN type?
  *
@@ -13,6 +18,20 @@ export function is(element, type) {
 }
 
 
+/**
+ * Return true if element has any of the given types.
+ *
+ * @param {djs.model.Base} element
+ * @param {Array<string>} types
+ *
+ * @return {boolean}
+ */
+export function isAny(element, types) {
+  return some(types, function(t) {
+    return is(element, t);
+  });
+}
+
 /**
  * Return the business object for a given element.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-js",
-  "version": "9.0.0-subprocesses.0",
+  "version": "9.0.0",
   "description": "A bpmn 2.0 toolkit and web modeler",
   "main": "index.js",
   "files": [
@@ -100,7 +100,7 @@
   "dependencies": {
     "bpmn-moddle": "^7.1.2",
     "css.escape": "^1.5.1",
-    "diagram-js": "7.4.0-subprocesses.0",
+    "diagram-js": "^8.1.1",
     "diagram-js-direct-editing": "^1.6.3",
     "ids": "^1.0.0",
     "inherits": "^2.0.4",

package/test/util/MockEvents.js

@@ -13,7 +13,7 @@ import {
  * specified canvas local coordinates.
  *
  * @param {Point} point of the event local the canvas (closure)
- * @param {Object} data
+ * @param {Object} [data]
  *
  * @return {Event} event, scoped to the given canvas
  */
@@ -34,7 +34,15 @@ export function createCanvasEvent(position, data) {
   });
 }
 
-
+/**
+ * Create an Event
+ *
+ * @param  {Element} target
+ * @param  { { x: number, y: number } } position
+ * @param  {any} [data]
+ *
+ * @return {Event}
+ */
 export function createEvent(target, position, data) {
 
   return getBpmnJS().invoke(function(eventBus) {

package/lib/features/collapsed-subprocesses/DeleteBehaviour.js

@@ -1,65 +0,0 @@
-import inherits from 'inherits';
-
-import CommandInterceptor from 'diagram-js/lib/command/CommandInterceptor';
-
-import { is } from '../../util/ModelUtil';
-
-
-export default function RemoveDiagramBehavior(canvas, bpmnjs, injector, elementRegistry, commandStack) {
-
-  var removeNestedProcesses = function(process) {
-    var removedProcesses = [];
-
-    process.flowElements && process.flowElements.forEach(element => {
-      if (is(element, 'bpmn:SubProcess')) {
-        removedProcesses = removedProcesses.concat(removeNestedProcesses(element));
-      }
-    });
-
-    var removedDi = removeProcess(process.id);
-
-    if (removedDi) {
-      removedProcesses.push(removedDi);
-    }
-    return removedProcesses;
-  };
-
-  injector.invoke(CommandInterceptor, this);
-
-  this.executed('shape.delete', function(event) {
-    var context = event.context;
-
-    if (is(context.shape, 'bpmn:SubProcess')) {
-      var removedDi = removeNestedProcesses(context.shape.businessObject);
-      context.removedDiDiagrams = removedDi;
-    }
-  });
-
-  this.reverted('shape.delete', function(event) {
-    var context = event.context;
-
-    if (is(context.shape, 'bpmn:SubProcess') && context.removedDiDiagrams) {
-      var diagrams = bpmnjs.getDefinitions().diagrams;
-      Array.prototype.push.apply(diagrams, context.removedDiDiagrams);
-    }
-  });
-
-  // Util
-  var removeProcess = function(id) {
-    var diagrams = bpmnjs.getDefinitions().diagrams,
-        removedDiagram;
-    var diagramIndex = diagrams.findIndex(element => {
-      return element.plane.bpmnElement.id === id;
-    });
-
-    if (diagramIndex > -1) {
-      removedDiagram = diagrams[diagramIndex];
-      diagrams.splice(diagramIndex, 1);
-    }
-    return removedDiagram;
-  };
-}
-
-inherits(RemoveDiagramBehavior, CommandInterceptor);
-
-RemoveDiagramBehavior.$inject = [ 'canvas', 'bpmnjs', 'injector', 'elementRegistry', 'commandStack' ];

package/lib/features/collapsed-subprocesses/ToggleCollapseBehaviour.js

@@ -1,133 +0,0 @@
-import inherits from 'inherits';
-
-import CommandInterceptor from 'diagram-js/lib/command/CommandInterceptor';
-
-import {
-  find
-} from 'min-dash';
-
-import { getBusinessObject, getDi, is } from '../../util/ModelUtil';
-import { selfAndAllChildren } from '../../../../diagram-js/lib/util/Elements';
-
-var HIGH_PRIORITY = 5000;
-
-
-export default function ExpandBehaviour(commandStack, injector, canvas, bpmnImporter, bpmnUpdater, bpmnjs, elementRegistry, eventBus, modeling, bpmnFactory) {
-
-  injector.invoke(CommandInterceptor, this);
-
-  var handler = function(event) {
-    const shape = event.context.shape;
-    const diagrams = bpmnjs.getDefinitions().diagrams;
-
-    if (!is(shape, 'bpmn:SubProcess')) {
-      return;
-    }
-
-    if (!shape.collapsed) {
-
-      // expand
-      var oldDiagram = findDiagram(shape.id);
-      var newDiagram = findRootDiagram(getDi(shape));
-
-      // Add elements to parent diagram
-      oldDiagram.plane.planeElement.forEach(di => {
-        var childElement = elementRegistry.get(di.bpmnElement.id);
-        var bo = childElement.businessObject;
-        var parent = elementRegistry.get(bo.$parent.id);
-
-        if (parent === shape) {
-          childElement.parent = shape;
-          eventBus.fire('elements.changed', { elements: [childElement] });
-        }
-
-        // reorder di
-        newDiagram.plane.planeElement.push(di);
-      });
-
-      diagrams.splice(diagrams.indexOf(oldDiagram), 1);
-
-      // debugger;
-      canvas.setRootElementForPlane(null, shape.id, true);
-      elementRegistry.remove(shape.id + '_layer');
-    } else {
-
-      // Collapse
-      var bo = getBusinessObject(shape);
-      newDiagram = createDiagram(shape);
-      diagrams.push(newDiagram);
-      console.log(shape, bo, newDiagram.plane);
-      var newShape = bpmnImporter.add({ element: bo, di: newDiagram.plane });
-      var planeElements = newDiagram.plane.get('planeElement');
-
-      oldDiagram = findRootDiagram(getDi(shape));
-
-      selfAndAllChildren(shape).forEach(function(childShape) {
-        if (childShape === shape) {
-          return;
-        }
-
-        if (childShape.parent === shape) {
-          childShape.parent = newShape;
-        }
-        childShape.hidden = false;
-
-        var di = getDi(childShape);
-
-        // Remove DI from old Plane and add it to the new one
-        var parentPlaneElements = oldDiagram.plane.get('planeElement');
-        parentPlaneElements.splice(parentPlaneElements.indexOf(di), 1);
-        planeElements.push(di);
-
-        eventBus.fire('elements.changed', { elements: [childShape] });
-
-      });
-
-      bo.flowElements.forEach(el => {
-      });
-    }
-  };
-
-  this.executed([ 'shape.toggleCollapse' ], HIGH_PRIORITY, handler);
-
-
-  this.reverted([ 'shape.toggleCollapse' ], HIGH_PRIORITY, handler);
-
-  // Util
-
-  var findRootDiagram = function(element) {
-    if (is(element, 'bpmndi:BPMNDiagram')) {
-      return element;
-    } else {
-      return findRootDiagram(element.$parent);
-    }
-  };
-
-  var findDiagram = function(id) {
-    return find(bpmnjs.getDefinitions().diagrams, function(diagram) {
-      const plane = diagram.plane,
-            bpmnElement = plane.bpmnElement;
-
-      console.log(diagram, bpmnElement, id);
-      return bpmnElement.id === id;
-    });
-  };
-
-  var createDiagram = function(shape) {
-    var bo = getBusinessObject(shape);
-    var plane = bpmnFactory.createDiPlane(bo);
-    var diagram = bpmnFactory.create('bpmndi:BPMNDiagram', {
-      plane: plane
-    });
-
-    // shape.di = plane;
-    plane.$parent = diagram;
-    plane.bpmnElement = bo;
-    diagram.$parent = bpmnjs.getDefinitions();
-    return diagram;
-  };
-}
-
-inherits(ExpandBehaviour, CommandInterceptor);
-
-ExpandBehaviour.$inject = [ 'commandStack', 'injector', 'canvas', 'bpmnImporter', 'bpmnUpdater', 'bpmnjs', 'elementRegistry', 'eventBus', 'modeling', 'bpmnFactory' ];

package/lib/features/collapsed-subprocesses/diagramFactory.js

@@ -1,56 +0,0 @@
-import {
-  find
-} from 'min-dash';
-
-
-export default function DiagramRegistry(bpmnjs, bpmnFactory) {
-  this._bpmnjs = bpmnjs;
-  this._bpmnFactory = bpmnFactory;
-}
-
-DiagramRegistry.prototype.getDefinitions = function() {
-  return this._bpmnjs._definitions || [];
-};
-
-DiagramRegistry.prototype.getDiagrams = function() {
-  return this.getDefinitions().diagrams || [];
-};
-
-DiagramRegistry.prototype.findDiagram = function(id) {
-  return find(this._bpmnjs.getDefinitions().diagrams, function(diagram) {
-    const plane = diagram.plane,
-          bpmnElement = plane.bpmnElement;
-
-    return bpmnElement.id === id;
-  });
-};
-
-DiagramRegistry.prototype.createProcess = function() {
-  var process = this._bpmnFactory.create('bpmn:Process', {});
-  process.$parent = this.getDefinitions();
-  return process;
-};
-
-DiagramRegistry.prototype.createDiagram = function(rootElement) {
-  var plane = this._bpmnFactory.createDiPlane(rootElement);
-  var diagram = this._bpmnFactory.create('bpmndi:BPMNDiagram', {
-    plane: plane
-  });
-  rootElement.di = plane;
-  plane.$parent = diagram;
-  plane.bpmnElement = rootElement;
-  diagram.$parent = this.getDefinitions();
-  return diagram;
-};
-
-DiagramRegistry.prototype.removeProcess = function(id) {
-  let diagramIndex = this.getDiagrams().findIndex(element => {
-    return element.plane.bpmnElement.id === id;
-  });
-  if (diagramIndex > -1) {
-    this.getDiagrams().splice(diagramIndex, 1);
-  }
-};
-
-
-DiagramRegistry.$inject = ['bpmnjs', 'bpmnFactory'];

package/lib/features/collapsed-subprocesses/index.js

@@ -1,12 +0,0 @@
-import ExpandBehaviour from './ToggleCollapseBehaviour';
-import RemoveDiagramBehavior from './DeleteBehaviour';
-
-export default {
-  __depends__: [ ],
-  __init__: [
-    'removeDiagramBehavior',
-    'expandBehaviour'
-  ],
-  removeDiagramBehavior: ['type', RemoveDiagramBehavior],
-  expandBehaviour: ['type', ExpandBehaviour]
-};