@jylups/cmmn-js 0.0.0-stage → 0.21.0

package/lib/import/Importer.js

@@ -0,0 +1,73 @@
+'use strict';
+
+var CmmnTreeWalker = require('./CmmnTreeWalker');
+
+
+/**
+ * Import the definitions into a diagram.
+ *
+ * Errors and warnings are reported through the specified callback.
+ *
+ * @param  {Diagram} diagram
+ * @param  {ModdleElement} definitions
+ * @param  {Function} done the callback, invoked with (err, [ warning ]) once the import is done
+ */
+function importCmmnDiagram(diagram, definitions, done) {
+
+  var importer = diagram.get('cmmnImporter'),
+      eventBus = diagram.get('eventBus'),
+      itemRegistry = diagram.get('itemRegistry');
+
+  var error,
+      warnings = [];
+
+  /**
+   * Walk the diagram semantically, importing (=drawing)
+   * all elements you encounter.
+   *
+   * @param {ModdleElement} definitions
+   */
+  function render(definitions) {
+
+    var visitor = {
+
+      root: function(element) {
+        return importer.root(element);
+      },
+
+      element: function(element, parentShape) {
+        return importer.add(element, parentShape);
+      },
+
+      error: function(message, context) {
+        warnings.push({ message: message, context: context });
+      },
+
+      addItem: function(item) {
+        itemRegistry.add(item);
+      }
+    };
+
+    var walker = new CmmnTreeWalker(visitor);
+
+    // import
+    walker.handleDefinitions(definitions);
+  }
+
+  eventBus.fire('import.render.start', { definitions: definitions });
+
+  try {
+    render(definitions);
+  } catch (e) {
+    error = e;
+  }
+
+  eventBus.fire('import.render.complete', {
+    error: error,
+    warnings: warnings
+  });
+
+  done(error, warnings);
+}
+
+module.exports.importCmmnDiagram = importCmmnDiagram;

package/lib/import/Util.js

@@ -0,0 +1,9 @@
+'use strict';
+
+module.exports.elementToString = function(e) {
+  if (!e) {
+    return '<null>';
+  }
+
+  return '<' + e.$type + (e.id ? ' id="' + e.id : '') + '" />';
+};

package/lib/import/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  cmmnImporter: [ 'type', require('./CmmnImporter') ]
+};

package/lib/util/DiUtil.js

@@ -0,0 +1,39 @@
+'use strict';
+
+var is = require('./ModelUtil').is,
+    getBusinessObject = require('./ModelUtil').getBusinessObject,
+    isCasePlanModel = require('./ModelUtil').isCasePlanModel;
+
+module.exports.isCollapsed = function(element) {
+
+  if (!isCasePlanModel(element)) {
+
+    element = getBusinessObject(element);
+
+    var definition = element.definitionRef;
+    if (is(definition, 'cmmn:PlanFragment')) {
+      return !!(element && element.di && element.di.isCollapsed);
+    }
+  }
+
+  return false;
+};
+
+module.exports.isPlanningTableCollapsed = function(element) {
+
+  element = getBusinessObject(element);
+
+  if (is(element, 'cmmn:Stage') ||
+     (element.definitionRef && (is(element.definitionRef, 'cmmn:Stage') ||
+      is(element.definitionRef, 'cmmn:HumanTask')))) {
+    return element.di && element.di.isPlanningTableCollapsed;
+  }
+
+  return false;
+};
+
+module.exports.isStandardEventVisible = function(element) {
+  element = getBusinessObject(element);
+  var cmmnElement = element.cmmnElementRef;
+  return !!(is(cmmnElement, 'cmmn:OnPart') && element.isStandardEventVisible);
+};

package/lib/util/LabelUtil.js

@@ -0,0 +1,124 @@
+'use strict';
+
+var is = require('../util/ModelUtil').is;
+var assign = require('min-dash').assign;
+
+var DEFAULT_LABEL_SIZE = module.exports.DEFAULT_LABEL_SIZE = {
+  width: 90,
+  height: 20
+};
+
+
+/**
+ * Returns true if the given semantic has an external label
+ *
+ * @param {CmmnElement} semantic
+ * @return {Boolean} true if has label
+ */
+module.exports.hasExternalLabel = function(semantic) {
+
+  if (is(semantic, 'cmmn:PlanItem') || is(semantic, 'cmmn:DiscretionaryItem')) {
+    semantic = semantic.definitionRef;
+  }
+
+  if (is(semantic, 'cmmndi:CMMNEdge') && semantic.cmmnElementRef) {
+
+    if (is(semantic.cmmnElementRef, 'cmmn:OnPart')) {
+      semantic = semantic.cmmnElementRef;
+    }
+
+  }
+
+  return is(semantic, 'cmmn:EventListener') ||
+         is(semantic, 'cmmn:OnPart') ||
+         is(semantic, 'cmmn:CaseFileItem');
+};
+
+/**
+ * Get the middle of a number of waypoints
+ *
+ * @param  {Array<Point>} waypoints
+ * @return {Point} the mid point
+ */
+var getWaypointsMid = module.exports.getWaypointsMid = function(waypoints) {
+
+  var mid = waypoints.length / 2 - 1;
+
+  var first = waypoints[Math.floor(mid)];
+  var second = waypoints[Math.ceil(mid + 0.01)];
+
+  return {
+    x: first.x + (second.x - first.x) / 2,
+    y: first.y + (second.y - first.y) / 2
+  };
+};
+
+
+var getExternalLabelMid = module.exports.getExternalLabelMid = function(element) {
+
+  var bo = element.businessObject,
+      di = bo.di;
+
+  if (!di && is(bo, 'cmmndi:CMMNEdge') && bo.cmmnElementRef) {
+    di = bo;
+  }
+
+  if (bo && di && di.waypoint) {
+    return getWaypointsMid(di.waypoint);
+  } else {
+    return {
+      x: element.x + element.width / 2,
+      y: element.y + element.height + DEFAULT_LABEL_SIZE.height / 2
+    };
+  }
+};
+
+/**
+ * Returns the bounds of an elements label, parsed from the elements DI or
+ * generated from its bounds.
+ *
+ * @param {CmmnElement} semantic
+ * @param {djs.model.Base} element
+ */
+module.exports.getExternalLabelBounds = function(semantic, element) {
+
+  var mid,
+      size,
+      bounds,
+      di = semantic.di || semantic,
+      label = di.label;
+
+  if (label && label.bounds) {
+    bounds = label.bounds;
+
+    size = {
+      width: Math.max(DEFAULT_LABEL_SIZE.width, bounds.width),
+      height: bounds.height
+    };
+
+    mid = {
+      x: bounds.x + bounds.width / 2,
+      y: bounds.y + bounds.height / 2
+    };
+  } else {
+
+    mid = getExternalLabelMid(element);
+
+    size = DEFAULT_LABEL_SIZE;
+  }
+
+  return assign({
+    x: mid.x - size.width / 2,
+    y: mid.y - size.height / 2
+  }, size);
+};
+
+var hasLabelBounds = module.exports.hasLabelBounds = function(semantic) {
+  return semantic && semantic.di && semantic.di.label && semantic.di.label.bounds;
+};
+
+module.exports.getLabelBounds = function(semantic) {
+  if (hasLabelBounds(semantic)) {
+    return semantic.di.label.bounds;
+  }
+};

package/lib/util/ModelUtil.js

@@ -0,0 +1,257 @@
+'use strict';
+
+function isInstanceOf(bo, type) {
+  return !!(bo && ((typeof bo.$instanceOf === 'function') && bo.$instanceOf(type)));
+}
+
+/**
+ * Is an element of the given CMMN type?
+ *
+ * @param  {djs.model.Base|ModdleElement} element
+ * @param  {String} type
+ *
+ * @return {Boolean}
+ */
+function is(element, type) {
+  return isInstanceOf(getBusinessObject(element), type);
+}
+
+module.exports.is = is;
+
+
+/**
+ * Return the business object for a given element.
+ *
+ * @param  {djs.model.Base|ModdleElement} element
+ *
+ * @return {ModdleElement}
+ */
+function getBusinessObject(element) {
+  return element && element.businessObject ? element.businessObject : element;
+}
+
+module.exports.getBusinessObject = getBusinessObject;
+
+function isCasePlanModel(element) {
+  element = getBusinessObject(element);
+  return is(element, 'cmmn:Stage') && element.$parent && is(element.$parent, 'cmmn:Case');
+}
+
+module.exports.isCasePlanModel = isCasePlanModel;
+
+function getDefinition(element) {
+  var bo = getBusinessObject(element);
+
+  if (is(element, 'cmmn:PlanItemDefinition') || is(element, 'cmmn:CaseFileItemDefinition')) {
+    return bo;
+  }
+
+  return bo && bo.definitionRef;
+}
+
+module.exports.getDefinition = getDefinition;
+
+function getDefaultControl(element) {
+  var definition = getDefinition(element);
+  return definition && definition.defaultControl;
+}
+
+module.exports.getDefaultControl = getDefaultControl;
+
+function getItemControl(element) {
+  element = getBusinessObject(element);
+  return element && element.itemControl;
+}
+
+module.exports.getItemControl = getItemControl;
+
+
+function getRule(element, rule) {
+  var itemControl = getItemControl(element),
+      defaultControl = getDefaultControl(element);
+
+  if (itemControl && itemControl[rule]) {
+    return itemControl[rule];
+  }
+
+  return defaultControl && defaultControl[rule];
+}
+
+function isRequired(element) {
+  return !!getRule(element, 'requiredRule');
+}
+
+module.exports.isRequired = isRequired;
+
+function isRepeatable(element) {
+  return !!getRule(element, 'repetitionRule');
+}
+
+module.exports.isRepeatable = isRepeatable;
+
+function isManualActivation(element) {
+  return !!getRule(element, 'manualActivationRule');
+}
+
+module.exports.isManualActivation = isManualActivation;
+
+function isAutoComplete(element) {
+  element = getBusinessObject(element);
+  var definition = getDefinition(element);
+  return element.autoComplete || (definition && definition.autoComplete);
+}
+
+module.exports.isAutoComplete = isAutoComplete;
+
+function hasPlanningTable(element) {
+  element = getBusinessObject(element);
+  return element.planningTable || (getDefinition(element) && getDefinition(element).planningTable);
+}
+
+module.exports.hasPlanningTable = hasPlanningTable;
+
+function getName(element) {
+  element = getBusinessObject(element);
+
+  if (is(element, 'cmmndi:CMMNEdge') && element.cmmnElementRef) {
+    element = element.cmmnElementRef;
+  }
+
+  var name = element.name;
+  if (!name) {
+
+    if (element.definitionRef) {
+      name = element.definitionRef.name;
+    }
+  }
+
+  return name;
+}
+
+module.exports.getName = getName;
+
+
+/**
+ * Returns the referenced sentry, if present.
+ *
+ * @param {djs.model.Base} criterion
+ *
+ * @result {ModdleElement} referenced sentry
+ */
+function getSentry(element) {
+  var bo = getBusinessObject(element);
+
+  if (is(bo, 'cmmn:Sentry')) {
+    return bo;
+  }
+
+  return bo && bo.sentryRef;
+}
+
+module.exports.getSentry = getSentry;
+
+
+function getStandardEvent(element) {
+  element = getBusinessObject(element);
+  return element.cmmnElementRef && element.cmmnElementRef.standardEvent;
+}
+
+module.exports.getStandardEvent = getStandardEvent;
+
+function getStandardEvents(element) {
+
+  if (is(element, 'cmmndi:CMMNEdge')) {
+    element = getBusinessObject(element).cmmnElementRef;
+  }
+
+  if (is(element, 'cmmn:OnPart')) {
+
+    if (is(element.exitCriterionRef, 'cmmn:ExitCriterion')) {
+      return [ 'exit' ];
+    }
+
+    return getTransitions(element.sourceRef);
+
+  }
+
+  return [];
+
+}
+
+module.exports.getStandardEvents = getStandardEvents;
+
+
+function getTransitions(element) {
+
+  element = getBusinessObject(element);
+
+  if (is(element, 'cmmn:CaseFileItem')) {
+
+    return [
+      'addChild',
+      'addReference',
+      'create',
+      'delete',
+      'removeChild',
+      'removeReference',
+      'replace',
+      'update'
+    ];
+
+  }
+
+  if (is(element, 'cmmn:PlanItem') || is(element, 'cmmn:DiscretionaryItem')) {
+
+    var definition = getDefinition(element);
+
+    if (is(definition, 'cmmn:EventListener') || is(definition, 'cmmn:Milestone')) {
+
+      return [
+        'create',
+        'occur',
+        'resume',
+        'suspend',
+        'terminate'
+      ];
+
+    }
+
+    return [
+      'complete',
+      'create',
+      'disable',
+      'enable',
+      'exit',
+      'fault',
+      'manualStart',
+      'parentResume',
+      'parentSuspend',
+      'reactivate',
+      'reenable',
+      'resume',
+      'start',
+      'suspend',
+      'terminate'
+    ];
+
+  }
+
+  if (isCasePlanModel(element)) {
+
+    return [
+      'close',
+      'complete',
+      'create',
+      'fault',
+      'reactivate',
+      'suspend',
+      'terminate'
+    ];
+
+  }
+
+  return [];
+
+}
+
+module.exports.getTransitions = getTransitions;

package/lib/util/PoweredByUtil.js

@@ -0,0 +1,91 @@
+/**
+ * This file must not be changed or exchanged.
+ *
+ * @see http://bpmn.io/license for more information.
+ */
+
+'use strict';
+
+var domify = require('min-dom').domify;
+
+var domDelegate = require('min-dom').delegate;
+
+
+// inlined ../../resources/logo.svg
+var BPMNIO_LOGO_SVG = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 14.02 5.57" width="53" height="21" style="vertical-align:middle"><path fill="currentColor" d="M1.88.92v.14c0 .41-.13.68-.4.8.33.14.46.44.46.86v.33c0 .61-.33.95-.95.95H0V0h.95c.65 0 .93.3.93.92zM.63.57v1.06h.24c.24 0 .38-.1.38-.43V.98c0-.28-.1-.4-.32-.4zm0 1.63v1.22h.36c.2 0 .32-.1.32-.39v-.35c0-.37-.12-.48-.4-.48H.63zM4.18.99v.52c0 .64-.31.98-.94.98h-.3V4h-.62V0h.92c.63 0 .94.35.94.99zM2.94.57v1.35h.3c.2 0 .3-.09.3-.37v-.6c0-.29-.1-.38-.3-.38h-.3zm2.89 2.27L6.25 0h.88v4h-.6V1.12L6.1 3.99h-.6l-.46-2.82v2.82h-.55V0h.87zM8.14 1.1V4h-.56V0h.79L9 2.4V0h.56v4h-.64zm2.49 2.29v.6h-.6v-.6zM12.12 1c0-.63.33-1 .95-1 .61 0 .95.37.95 1v2.04c0 .64-.34 1-.95 1-.62 0-.95-.37-.95-1zm.62 2.08c0 .28.13.39.33.39s.32-.1.32-.4V.98c0-.29-.12-.4-.32-.4s-.33.11-.33.4z"/><path fill="currentColor" d="M0 4.53h14.02v1.04H0zM11.08 0h.63v.62h-.63zm.63 4V1h-.63v2.98z"/></svg>';
+
+var BPMNIO_IMG = BPMNIO_LOGO_SVG;
+
+function css(attrs) {
+  return attrs.join(';');
+}
+
+var LINK_STYLES = css([
+  'color: #404040'
+]);
+
+var LIGHTBOX_STYLES = css([
+  'z-index: 1001',
+  'position: fixed',
+  'top: 0',
+  'left: 0',
+  'right: 0',
+  'bottom: 0'
+]);
+
+var BACKDROP_STYLES = css([
+  'width: 100%',
+  'height: 100%',
+  'background: rgba(40,40,40,0.2)'
+]);
+
+var NOTICE_STYLES = css([
+  'position: absolute',
+  'left: 50%',
+  'top: 40%',
+  'transform: translate(-50%)',
+  'width: 260px',
+  'padding: 10px',
+  'background: white',
+  'box-shadow: 0 1px 4px rgba(0,0,0,0.3)',
+  'font-family: Helvetica, Arial, sans-serif',
+  'font-size: 14px',
+  'display: flex',
+  'line-height: 1.3'
+]);
+
+var LIGHTBOX_MARKUP =
+  '<div class="bjs-powered-by-lightbox" style="' + LIGHTBOX_STYLES + '">' +
+    '<div class="backdrop" style="' + BACKDROP_STYLES + '"></div>' +
+    '<div class="notice" style="' + NOTICE_STYLES + '">' +
+      '<a href="https://bpmn.io" target="_blank" rel="noopener" style="margin: 15px 20px 15px 10px; align-self: center;' + LINK_STYLES + '">' +
+        BPMNIO_IMG +
+      '</a>' +
+      '<span>' +
+        'Web-based tooling for BPMN, DMN and CMMN diagrams ' +
+        'powered by <a href="https://bpmn.io" target="_blank" rel="noopener">bpmn.io</a>.' +
+      '</span>' +
+    '</div>' +
+  '</div>';
+
+
+var lightbox;
+
+function open() {
+
+  if (!lightbox) {
+    lightbox = domify(LIGHTBOX_MARKUP);
+
+    domDelegate.bind(lightbox, '.backdrop', 'click', function(event) {
+      document.body.removeChild(lightbox);
+    });
+  }
+
+  document.body.appendChild(lightbox);
+}
+
+module.exports.open = open;
+
+module.exports.BPMNIO_IMG = BPMNIO_IMG;
+
+module.exports.LINK_STYLES = LINK_STYLES;

package/package.json

@@ -1,6 +1,90 @@
 {
   "name": "@jylups/cmmn-js",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.21.0",
+  "description": "A cmmn 1.1 toolkit",
+  "scripts": {
+    "all": "run-s lint test distro test:distro",
+    "lint": "eslint .",
+    "dev": "npm test -- --auto-watch --no-single-run",
+    "test": "karma start test/config/karma.unit.js",
+    "distro": "node tasks/build-distro.js",
+    "test:distro": "node tasks/test-distro.js",
+    "prepublishOnly": "run-s distro test:distro"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jylups/cmmn-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jylups/cmmn-js-env/issues"
+  },
+  "keywords": [
+    "cmmn",
+    "cmmn-js",
+    "toolkit"
+  ],
+  "author": {
+    "name": "Roman Smirnov",
+    "url": "https://github.com/romansmirnov"
+  },
+  "contributors": [
+    {
+      "name": "bpmn.io contributors",
+      "url": "https://github.com/bpmn-io"
+    }
+  ],
+  "license": "SEE LICENSE IN LICENSE",
+  "devDependencies": {
+    "babel-core": "^6.26.0",
+    "babel-preset-env": "^1.6.1",
+    "babelify": "~8.0.0",
+    "browser-pack-flat": "~3.0.8",
+    "browserify": "~14.5.0",
+    "browserify-derequire": "~0.9.1",
+    "bundle-collapser": "~1.3.0",
+    "chai": "^4.1.2",
+    "common-shakeify": "~0.4.5",
+    "cpx": "^1.5.0",
+    "del": "^3.0.0",
+    "envify": "~4.1.0",
+    "eslint": "^4.17.0",
+    "eslint-plugin-bpmn-io": "^0.5.2",
+    "execa": "^0.9.0",
+    "jsondiffpatch": "^0.1.26",
+    "karma": "^4.1.0",
+    "karma-browserify": "^6.0.0",
+    "karma-chrome-launcher": "^2.2.0",
+    "karma-firefox-launcher": "^1.0.1",
+    "karma-mocha": "^1.3.0",
+    "karma-safari-launcher": "^1.0.0",
+    "karma-sinon-chai": "^1.3.3",
+    "karma-spec-reporter": "0.0.31",
+    "mkdirp": "^0.5.1",
+    "mocha": "^4.1.0",
+    "mocha-test-container-support": "~0.2.0",
+    "npm-run-all": "^4.1.2",
+    "sinon": "^4.2.2",
+    "sinon-chai": "^2.14.0",
+    "source-map-concat": "^1.0.0",
+    "stringify": "^5.1.0",
+    "uglify-es": "^3.3.10",
+    "unassertify": "~2.1.0",
+    "watchify": "^3.11.1"
+  },
+  "dependencies": {
+    "@jylups/cmmn-moddle": "^5.1.0",
+    "cmmn-font": "^0.5.0",
+    "css.escape": "^1.5.1",
+    "diagram-js": "^4.0.1",
+    "diagram-js-direct-editing": "^1.5.0",
+    "ids": "^0.2.0",
+    "inherits": "^2.0.1",
+    "min-dash": "^3.5.0",
+    "min-dom": "^3.0.0",
+    "object-refs": "^0.3.0",
+    "tiny-svg": "^2.2.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}