bpmn-js 0.13.1 → 0.14.1

package/lib/import/Importer.js

@@ -15,12 +15,19 @@ var BpmnTreeWalker = require('./BpmnTreeWalker');
 function importBpmnDiagram(diagram, definitions, done) {
 
   var importer = diagram.get('bpmnImporter'),
-      eventBus = diagram.get('eventBus');
+      eventBus = diagram.get('eventBus'),
+      translate = diagram.get('translate');
 
   var error,
       warnings = [];
 
-  function parse(definitions) {
+  /**
+   * Walk the diagram semantically, importing (=drawing)
+   * all elements you encounter.
+   *
+   * @param {ModdleElement} definitions
+   */
+  function render(definitions) {
 
     var visitor = {
 
@@ -37,21 +44,26 @@ function importBpmnDiagram(diagram, definitions, done) {
       }
     };
 
-    var walker = new BpmnTreeWalker(visitor);
+    var walker = new BpmnTreeWalker(visitor, translate);
 
-    // import
+    // traverse BPMN 2.0 document model,
+    // starting at definitions
     walker.handleDefinitions(definitions);
   }
 
-  eventBus.fire('import.start', { definitions: definitions });
+  eventBus.fire('import.render.start', { definitions: definitions });
 
   try {
-    parse(definitions);
+    render(definitions);
   } catch (e) {
     error = e;
   }
 
-  eventBus.fire(error ? 'import.error' : 'import.success', { error: error, warnings: warnings });
+  eventBus.fire('import.render.complete', {
+    error: error,
+    warnings: warnings
+  });
+
   done(error, warnings);
 }
 

package/lib/import/index.js

@@ -1,3 +1,6 @@
 module.exports = {
+  __depends__: [
+    require('diagram-js/lib/i18n/translate')
+  ],
   bpmnImporter: [ 'type', require('./BpmnImporter') ]
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmn-js",
-  "version": "0.13.1",
+  "version": "0.14.1",
   "description": "A bpmn 2.0 toolkit and web modeler",
   "scripts": {
     "test": "grunt test"
@@ -35,6 +35,7 @@
     "bundle-collapser": "^1.1.1",
     "chai": "~2.2.0",
     "grunt": "^0.4.4",
+    "grunt-cli": "^0.1.13",
     "grunt-contrib-copy": "^0.7.0",
     "grunt-contrib-jshint": "^0.7.2",
     "grunt-karma": "^0.12.0",
@@ -46,8 +47,8 @@
     "karma-chrome-launcher": "^0.2.2",
     "karma-firefox-launcher": "^0.1.3",
     "karma-ie-launcher": "^0.2.0",
-    "karma-phantomjs-launcher": "^0.2.0",
     "karma-mocha": "~0.1.0",
+    "karma-phantomjs-launcher": "^0.2.0",
     "karma-safari-launcher": "^0.1.1",
     "karma-sinon-chai": "~0.3.0",
     "load-grunt-tasks": "^0.3.0",
@@ -63,11 +64,11 @@
     "watchify": "^3.7.0"
   },
   "dependencies": {
-    "bpmn-moddle": "^0.10.4",
-    "diagram-js": "^0.13.1",
-    "diagram-js-direct-editing": "^0.13.0",
-    "didi": "^0.0.4",
-    "ids": "^0.1.1",
+    "bpmn-moddle": "^0.11.0",
+    "diagram-js": "^0.14.0",
+    "diagram-js-direct-editing": "^0.14.0",
+    "diagram-js-origin": "^0.13.0",
+    "ids": "^0.2.0",
     "inherits": "^2.0.1",
     "lodash": "^3.0.1",
     "min-dom": "^0.2.0",

package/test/fixtures/bpmn/extension/custom-override.bpmn

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<bpmn2:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn2="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:camunda="http://activiti.org/bpmn" xmlns:custom="http://customdescriptor.com/bpmn2" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xsi:schemaLocation="http://www.omg.org/spec/BPMN/20100524/MODEL BPMN20.xsd" id="_FVEpwO_VEeOtYvXzz5ksgw" exporter="camunda modeler" exporterVersion="2.5.0" targetNamespace="http://activiti.org/bpmn">
+  <bpmn2:process id="testProcess" isExecutable="true">
+    <bpmn2:startEvent id="StartEvent_1">
+      <bpmn2:outgoing>SequenceFlow_1</bpmn2:outgoing>
+    </bpmn2:startEvent>
+    <bpmn2:sendTask id="send" name="send">
+      <bpmn2:extensionElements>
+        <camunda:inputOutput>
+          <camunda:inputParameter name="var1">
+            <camunda:map>
+              <camunda:entry key="a">
+                <camunda:list>
+                  <camunda:value>stringInListNestedInMap</camunda:value>
+                  <camunda:value>${ 'b' }</camunda:value>
+                </camunda:list>
+              </camunda:entry>
+            </camunda:map>
+          </camunda:inputParameter>
+          <camunda:inputParameter name="var2">stringConstantValue</camunda:inputParameter>
+        </camunda:inputOutput>
+        <custom:CustomSendElementOverride name="custom" value="1" />
+      </bpmn2:extensionElements>
+      <bpmn2:incoming>SequenceFlow_1</bpmn2:incoming>
+      <bpmn2:outgoing>SequenceFlow_2</bpmn2:outgoing>
+    </bpmn2:sendTask>
+    <bpmn2:sequenceFlow id="SequenceFlow_1" name="" sourceRef="StartEvent_1" targetRef="send"/>
+    <bpmn2:endEvent id="EndEvent_1">
+      <bpmn2:incoming>SequenceFlow_2</bpmn2:incoming>
+    </bpmn2:endEvent>
+    <bpmn2:sequenceFlow id="SequenceFlow_2" name="" sourceRef="send" targetRef="EndEvent_1"/>
+  </bpmn2:process>
+  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="testProcess">
+      <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1">
+        <dc:Bounds height="36.0" width="36.0" x="128.0" y="178.0"/>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="_BPMNShape_UserTask_2" bpmnElement="send">
+        <dc:Bounds height="80.0" width="100.0" x="214.0" y="156.0"/>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNEdge id="BPMNEdge_SequenceFlow_1" bpmnElement="SequenceFlow_1" sourceElement="_BPMNShape_StartEvent_2" targetElement="_BPMNShape_UserTask_2">
+        <di:waypoint xsi:type="dc:Point" x="164.0" y="196.0"/>
+        <di:waypoint xsi:type="dc:Point" x="214.0" y="196.0"/>
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNShape id="_BPMNShape_EndEvent_2" bpmnElement="EndEvent_1">
+        <dc:Bounds height="36.0" width="36.0" x="364.0" y="178.0"/>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNEdge id="BPMNEdge_SequenceFlow_2" bpmnElement="SequenceFlow_2" sourceElement="_BPMNShape_UserTask_2" targetElement="_BPMNShape_EndEvent_2">
+        <di:waypoint xsi:type="dc:Point" x="314.0" y="196.0"/>
+        <di:waypoint xsi:type="dc:Point" x="364.0" y="196.0"/>
+      </bpmndi:BPMNEdge>
+    </bpmndi:BPMNPlane>
+  </bpmndi:BPMNDiagram>
+</bpmn2:definitions>

package/test/fixtures/bpmn/extension/custom.bpmn

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<bpmn2:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn2="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:camunda="http://activiti.org/bpmn" xmlns:custom="http://customdescriptor.com/bpmn2" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xsi:schemaLocation="http://www.omg.org/spec/BPMN/20100524/MODEL BPMN20.xsd" id="_FVEpwO_VEeOtYvXzz5ksgw" exporter="camunda modeler" exporterVersion="2.5.0" targetNamespace="http://activiti.org/bpmn">
+  <bpmn2:process id="testProcess" isExecutable="true">
+    <bpmn2:startEvent id="StartEvent_1">
+      <bpmn2:outgoing>SequenceFlow_1</bpmn2:outgoing>
+    </bpmn2:startEvent>
+    <bpmn2:sendTask id="send" name="send">
+      <bpmn2:extensionElements>
+        <camunda:inputOutput>
+          <camunda:inputParameter name="var1">
+            <camunda:map>
+              <camunda:entry key="a">
+                <camunda:list>
+                  <camunda:value>stringInListNestedInMap</camunda:value>
+                  <camunda:value>${ 'b' }</camunda:value>
+                </camunda:list>
+              </camunda:entry>
+            </camunda:map>
+          </camunda:inputParameter>
+          <camunda:inputParameter name="var2">stringConstantValue</camunda:inputParameter>
+        </camunda:inputOutput>
+        <custom:customSendElement name="custom" value="1" />
+      </bpmn2:extensionElements>
+      <bpmn2:incoming>SequenceFlow_1</bpmn2:incoming>
+      <bpmn2:outgoing>SequenceFlow_2</bpmn2:outgoing>
+    </bpmn2:sendTask>
+    <bpmn2:sequenceFlow id="SequenceFlow_1" name="" sourceRef="StartEvent_1" targetRef="send"/>
+    <bpmn2:endEvent id="EndEvent_1">
+      <bpmn2:incoming>SequenceFlow_2</bpmn2:incoming>
+    </bpmn2:endEvent>
+    <bpmn2:sequenceFlow id="SequenceFlow_2" name="" sourceRef="send" targetRef="EndEvent_1"/>
+  </bpmn2:process>
+  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="testProcess">
+      <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1">
+        <dc:Bounds height="36.0" width="36.0" x="128.0" y="178.0"/>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="_BPMNShape_UserTask_2" bpmnElement="send">
+        <dc:Bounds height="80.0" width="100.0" x="214.0" y="156.0"/>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNEdge id="BPMNEdge_SequenceFlow_1" bpmnElement="SequenceFlow_1" sourceElement="_BPMNShape_StartEvent_2" targetElement="_BPMNShape_UserTask_2">
+        <di:waypoint xsi:type="dc:Point" x="164.0" y="196.0"/>
+        <di:waypoint xsi:type="dc:Point" x="214.0" y="196.0"/>
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNShape id="_BPMNShape_EndEvent_2" bpmnElement="EndEvent_1">
+        <dc:Bounds height="36.0" width="36.0" x="364.0" y="178.0"/>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNEdge id="BPMNEdge_SequenceFlow_2" bpmnElement="SequenceFlow_2" sourceElement="_BPMNShape_UserTask_2" targetElement="_BPMNShape_EndEvent_2">
+        <di:waypoint xsi:type="dc:Point" x="314.0" y="196.0"/>
+        <di:waypoint xsi:type="dc:Point" x="364.0" y="196.0"/>
+      </bpmndi:BPMNEdge>
+    </bpmndi:BPMNPlane>
+  </bpmndi:BPMNDiagram>
+</bpmn2:definitions>

package/test/fixtures/bpmn/features/modeling/update-label.bpmn

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="Definitions_1" targetNamespace="http://bpmn.io/schema/bpmn">
+  <bpmn:process id="Process_1" isExecutable="false">
+    <bpmn:startEvent id="StartEvent_1" name="Foo" />
+    <bpmn:startEvent id="StartEvent_2" />
+    <bpmn:task id="Task_1" />
+  </bpmn:process>
+  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1">
+      <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1">
+        <dc:Bounds x="173" y="102" width="36" height="36" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="StartEvent_1peicoz_di" bpmnElement="StartEvent_2">
+        <dc:Bounds x="255" y="102" width="36" height="36" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="228" y="138" width="90" height="20" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Task_16agoun_di" bpmnElement="Task_1">
+        <dc:Bounds x="339" y="80" width="100" height="80" />
+      </bpmndi:BPMNShape>
+    </bpmndi:BPMNPlane>
+  </bpmndi:BPMNDiagram>
+</bpmn:definitions>

package/test/fixtures/json/model/custom-override.json

@@ -0,0 +1,39 @@
+{
+  "name": "Custom descriptor Override",
+  "uri": "http://customdescriptor.com/bpmn2",
+  "prefix": "custom",
+  "xml": {
+    "tagAlias": "lowerCase"
+  },
+  "associations": [],
+  "types": [
+    {
+      "name": "CustomSendElementOverride",
+      "superClass": [
+        "Element"
+      ],
+      "properties": [
+        {
+          "name": "name",
+          "isAttr": true,
+          "type": "String"
+        },
+        {
+          "name": "value",
+          "isAttr": true,
+          "type": "String"
+        }
+      ]
+    },
+    {
+      "name": "ServiceTaskGroupOverride",
+      "extends": [
+        "bpmn:ServiceTask",
+        "bpmn:BusinessRuleTask",
+        "bpmn:SendTask",
+        "bpmn:MessageEventDefinition"
+      ]
+    }
+  ],
+  "emumerations": [ ]
+}

package/test/fixtures/json/model/custom.json

@@ -0,0 +1,39 @@
+{
+  "name": "Custom descriptor",
+  "uri": "http://customdescriptor.com/bpmn2",
+  "prefix": "custom",
+  "xml": {
+    "tagAlias": "lowerCase"
+  },
+  "associations": [],
+  "types": [
+    {
+      "name": "CustomSendElement",
+      "superClass": [
+        "Element"
+      ],
+      "properties": [
+        {
+          "name": "name",
+          "isAttr": true,
+          "type": "String"
+        },
+        {
+          "name": "value",
+          "isAttr": true,
+          "type": "String"
+        }
+      ]
+    },
+    {
+      "name": "ServiceTaskGroup",
+      "extends": [
+        "bpmn:ServiceTask",
+        "bpmn:BusinessRuleTask",
+        "bpmn:SendTask",
+        "bpmn:MessageEventDefinition"
+      ]
+    }
+  ],
+  "emumerations": [ ]
+}

package/test/helper/index.js

@@ -76,7 +76,12 @@ function bootstrapBpmnJS(BpmnJS, diagram, options, locals) {
       _locals = _locals();
     }
 
-    _options = merge({ container: testContainer }, OPTIONS, _options);
+    _options = merge({
+      container: testContainer,
+      canvas: {
+        deferUpdate: false
+      }
+    }, OPTIONS, _options);
 
     if (_locals) {
       var mockModule = {};

package/test/integration/ReimportSpec.js

@@ -0,0 +1,89 @@
+'use strict';
+
+var Modeler = require('../../lib/Modeler');
+
+var TestContainer = require('mocha-test-container-support');
+
+function delay(fn) {
+  setTimeout(fn, 10);
+}
+
+
+describe.skip('scenario - successive reopening', function() {
+
+  var container;
+
+  beforeEach(function() {
+    container = TestContainer.get(this);
+  });
+
+
+  var boundaryXML = require('../fixtures/bpmn/boundary-events.bpmn'),
+      containersXML = require('../fixtures/bpmn/containers.bpmn'),
+      flowMarkersXML = require('../fixtures/bpmn/flow-markers.bpmn'),
+      simpleXML = require('../fixtures/bpmn/simple.bpmn');
+
+  var allDiagrams = [
+    boundaryXML,
+    containersXML,
+    flowMarkersXML,
+    simpleXML
+  ];
+
+  it('should import 100 diagrams', function(done) {
+
+    // this test needs time
+    this.timeout(30000);
+
+    var count = 0;
+
+    // given
+    var modeler = new Modeler({ container: container });
+
+    modeler.on('import.done', function(event) {
+
+      console.log('imported #' + count);
+
+      if (event.error) {
+        console.error('ERROR', event.error);
+      }
+
+      if (event.warnings && event.warnings.length) {
+        console.warn('WARNINGS', event.warnings );
+      }
+    });
+
+    function finish(err) {
+      modeler.destroy();
+
+      done(err);
+    }
+
+    function importNext() {
+
+      if (count === 100) {
+        return finish();
+      }
+
+      var i = count % allDiagrams.length;
+
+      var xml = allDiagrams[i];
+
+      // when
+      modeler.importXML(xml, function(err) {
+
+        count++;
+
+        if (err) {
+          return finish(err);
+        }
+
+        delay(importNext);
+      });
+    }
+
+    // when
+    importNext();
+  });
+
+});

package/test/spec/ModelerSpec.js

@@ -107,17 +107,45 @@ describe('Modeler', function() {
   });
 
 
+  describe('translate support', function() {
+
+    var xml = require('../fixtures/bpmn/simple.bpmn');
+
+    it('should allow translation of multi-lingual strings', function(done) {
+
+      createModeler(xml, function(err, warnings, modeler) {
+
+        // given
+        var translate = modeler.get('translate');
+
+        // assume
+        expect(translate).to.exist;
+
+        // when
+        var interpolatedString = translate('HELLO {you}!', { you: 'WALT' });
+
+        // then
+        expect(interpolatedString).to.eql('HELLO WALT!');
+
+        done(err);
+      });
+
+    });
+
+  });
+
+
   describe('overlay support', function() {
 
     it('should allow to add overlays', function(done) {
 
       var xml = require('../fixtures/bpmn/simple.bpmn');
 
-      createModeler(xml, function(err, warnings, viewer) {
+      createModeler(xml, function(err, warnings, modeler) {
 
         // given
-        var overlays = viewer.get('overlays'),
-            elementRegistry = viewer.get('elementRegistry');
+        var overlays = modeler.get('overlays'),
+            elementRegistry = modeler.get('elementRegistry');
 
         // assume
         expect(overlays).to.exist;
@@ -162,13 +190,13 @@ describe('Modeler', function() {
 
       var xml = require('../fixtures/bpmn/simple.bpmn');
 
-      createModeler(xml, function(err, warnings, viewer) {
+      createModeler(xml, function(err, warnings, modeler) {
 
         // given
-        var bendpointMove = viewer.get('bendpointMove'),
-            dragging = viewer.get('dragging'),
-            elementRegistry = viewer.get('elementRegistry'),
-            canvas = viewer.get('canvas');
+        var bendpointMove = modeler.get('bendpointMove'),
+            dragging = modeler.get('dragging'),
+            elementRegistry = modeler.get('elementRegistry'),
+            canvas = modeler.get('canvas');
 
         // assume
         expect(bendpointMove).to.exist;
@@ -216,6 +244,81 @@ describe('Modeler', function() {
   });
 
 
+  describe('ids', function() {
+
+    it('should provide ids with moddle', function() {
+
+      // given
+      var modeler = new Modeler({ container: container });
+
+      // when
+      var moddle = modeler.get('moddle');
+
+      // then
+      expect(moddle.ids).to.exist;
+    });
+
+
+    it('should populate ids on import', function(done) {
+
+      // given
+      var xml = require('../fixtures/bpmn/simple.bpmn');
+
+      var modeler = new Modeler({ container: container });
+
+      var moddle = modeler.get('moddle');
+      var elementRegistry = modeler.get('elementRegistry');
+
+      // when
+      modeler.importXML(xml, function(err) {
+
+        var subProcess = elementRegistry.get('SubProcess_1').businessObject;
+        var bpmnEdge = elementRegistry.get('SequenceFlow_3').businessObject.di;
+
+        // then
+        expect(moddle.ids.assigned('SubProcess_1')).to.eql(subProcess);
+        expect(moddle.ids.assigned('BPMNEdge_SequenceFlow_3')).to.eql(bpmnEdge);
+
+        done();
+      });
+
+    });
+
+
+    it('should clear ids before re-import', function(done) {
+
+      // given
+      var someXML = require('../fixtures/bpmn/simple.bpmn'),
+          otherXML = require('../fixtures/bpmn/basic.bpmn');
+
+      var modeler = new Modeler({ container: container });
+
+      var moddle = modeler.get('moddle');
+      var elementRegistry = modeler.get('elementRegistry');
+
+      // when
+      modeler.importXML(someXML, function() {
+
+        modeler.importXML(otherXML, function() {
+
+          var task = elementRegistry.get('Task_1').businessObject;
+
+          // then
+          // not in other.bpmn
+          expect(moddle.ids.assigned('SubProcess_1')).to.be.false;
+
+          // in other.bpmn
+          expect(moddle.ids.assigned('Task_1')).to.eql(task);
+
+          done();
+        });
+      });
+
+    });
+
+  });
+
+
   it('should handle errors', function(done) {
 
     var xml = 'invalid stuff';
@@ -239,7 +342,7 @@ describe('Modeler', function() {
 
   describe('dependency injection', function() {
 
-    it('should be available via di as <bpmnjs>', function(done) {
+    it('should provide self as <bpmnjs>', function(done) {
 
       var xml = require('../fixtures/bpmn/simple.bpmn');
 
@@ -251,6 +354,49 @@ describe('Modeler', function() {
       });
     });
 
+
+    it('should allow Diagram#get before import', function() {
+
+      // when
+      var modeler = new Modeler({ container: container });
+
+      // then
+      var eventBus = modeler.get('eventBus');
+
+      expect(eventBus).to.exist;
+    });
+
+
+    it('should keep references to services across re-import', function(done) {
+
+      // given
+      var someXML = require('../fixtures/bpmn/simple.bpmn'),
+          otherXML = require('../fixtures/bpmn/basic.bpmn');
+
+      var modeler = new Modeler({ container: container });
+
+      var eventBus = modeler.get('eventBus'),
+          canvas = modeler.get('canvas');
+
+      // when
+      modeler.importXML(someXML, function() {
+
+        // then
+        expect(modeler.get('canvas')).to.equal(canvas);
+        expect(modeler.get('eventBus')).to.equal(eventBus);
+
+        modeler.importXML(otherXML, function() {
+
+          // then
+          expect(modeler.get('canvas')).to.equal(canvas);
+          expect(modeler.get('eventBus')).to.equal(eventBus);
+
+          done();
+        });
+      });
+
+    });
+
   });
 
 });