camunda-bpmn-js 0.12.0 → 0.13.0-alpha.1

package/lib/base/Modeler.js

@@ -13,8 +13,10 @@ import signavioCompatModule from 'bpmn-js-signavio-compat';
 
 import disableCollapsedSubprocessModule from 'bpmn-js-disable-collapsed-subprocess';
 
-import propertiesPanelModule from 'bpmn-js-properties-panel';
-import propertiesProviderModule from 'bpmn-js-properties-panel/lib/provider/bpmn';
+import {
+  BpmnPropertiesPanelModule as propertiesPanelModule,
+  BpmnPropertiesProviderModule as bpmnPropertiesProviderModule
+} from 'bpmn-js-properties-panel';
 
 /**
  *
@@ -42,7 +44,7 @@ Modeler.prototype._extensionModules = [
   signavioCompatModule,
   disableCollapsedSubprocessModule,
   propertiesPanelModule,
-  propertiesProviderModule
+  bpmnPropertiesProviderModule
 ];
 
 Modeler.prototype._modules = [].concat(

package/lib/camunda-cloud/Modeler.js

@@ -12,7 +12,10 @@ import popupMenuModule from './features/popup-menu';
 
 import rulesModule from './features/rules';
 
-import propertiesProviderModule from './features/properties-provider';
+import {
+  ZeebePropertiesProviderModule as zeebePropertiesProviderModule,
+  ZeebeDescriptionProvider
+} from 'bpmn-js-properties-panel';
 
 import zeebeModdle from 'zeebe-bpmn-moddle/resources/zeebe.json';
 
@@ -30,6 +33,10 @@ export default function Modeler(options = {}) {
     moddleExtensions: {
       zeebe: zeebeModdle,
       ...options.moddleExtensions
+    },
+    propertiesPanel: {
+      description: ZeebeDescriptionProvider,
+      ...options.propertiesPanel
     }
   };
 
@@ -44,11 +51,11 @@ Modeler.prototype._camundaCloudModules = [
   paletteModule,
   popupMenuModule,
   rulesModule,
-  propertiesProviderModule,
+  zeebePropertiesProviderModule,
   zeebeModdleExtension
 ];
 
 Modeler.prototype._modules = [].concat(
   BaseModeler.prototype._modules,
   Modeler.prototype._camundaCloudModules
-);
+);

package/lib/camunda-cloud/features/modeling/behavior/CleanUpAssignmentDefinitionBehavior.js

@@ -0,0 +1,78 @@
+import {
+  is
+} from 'bpmn-js/lib/util/ModelUtil';
+
+import {
+  getBusinessObject
+} from 'bpmn-js/lib/util/ModelUtil';
+
+import CommandInterceptor from 'diagram-js/lib/command/CommandInterceptor';
+
+const HIGH_PRIORITY = 5000;
+
+
+/**
+ * Zeebe BPMN behavior for ensuring that there are not empty (ie. without properties)
+ * zeebe:assignmentDefinitions after modeling operations. Will also remove related
+ * extensionElements, if they remain empty afterwards (could be a seperate
+ * behavior in the future, if needed)
+ */
+export default class CleanUpBusinessRuleTaskBehavior extends CommandInterceptor {
+  constructor(eventBus, modeling) {
+    super(eventBus);
+
+    /**
+     * Remove zeebe:assignmentDefinition when it has no defined properties left after the operation
+     */
+    this.postExecuted([
+      'properties-panel.update-businessobject',
+      'element.updateModdleProperties'
+    ] , HIGH_PRIORITY, function(context) {
+      const {
+        element,
+        businessObject,
+        moddleElement
+      } = context;
+
+      // (1) harmonize property names from commands
+      const assignmentDefintion = businessObject || moddleElement;
+
+      if (
+        is(element, 'bpmn:UserTask')
+        && assignmentDefintion
+        && is(assignmentDefintion, 'zeebe:AssignmentDefinition')
+        && assignmentDefintion.assignee === undefined
+        && assignmentDefintion.candidateGroups === undefined
+      ) {
+        const extensionElements = getBusinessObject(element).extensionElements;
+
+        // (2) remove zeebe:assignmentDefintion
+        removeFromExtensionElements(element, extensionElements, modeling,
+          (ele) => !is(ele, 'zeebe:AssignmentDefinition'));
+
+        // (3) if extensionElements are empty afterwards, remove them as well
+        if (extensionElements.values.length === 0) {
+          modeling.updateModdleProperties(element, getBusinessObject(element),
+            { extensionElements: undefined });
+        }
+      }
+    }, true);
+
+  }
+}
+
+CleanUpBusinessRuleTaskBehavior.$inject = [
+  'eventBus',
+  'modeling'
+];
+
+
+// helper ////////////////////
+
+function removeFromExtensionElements(element, extensionElements, modeling, filterFun) {
+  const values = extensionElements.get('values').filter(filterFun);
+
+  modeling.updateModdleProperties(element, extensionElements, {
+    values
+  });
+}

package/lib/camunda-cloud/features/modeling/behavior/CreateZeebeCallActivityBehavior.js

@@ -1,6 +1,6 @@
 import { has } from 'min-dash';
 
-import elementHelper from 'bpmn-js-properties-panel/lib/helper/ElementHelper';
+import { createElement } from '../../../helper/ElementHelper';
 
 import { getCalledElement } from '../../../helper/CalledElementHelper';
 
@@ -44,7 +44,7 @@ export default class CreateZeebeCallActivityBehavior extends CommandInterceptor
         let extensionElements = businessObject.get('extensionElements');
 
         if (!extensionElements) {
-          extensionElements = elementHelper.createElement('bpmn:ExtensionElements', { values: [] }, businessObject, bpmnFactory);
+          extensionElements = createElement('bpmn:ExtensionElements', { values: [] }, businessObject, bpmnFactory);
 
           modeling.updateProperties(shape, { extensionElements });
         }

package/lib/camunda-cloud/features/modeling/behavior/FormDefinitionBehavior.js

@@ -1,7 +1,7 @@
 
 import CommandInterceptor from 'diagram-js/lib/command/CommandInterceptor';
 
-import elementHelper from 'bpmn-js-properties-panel/lib/helper/ElementHelper';
+import { createElement } from '../../../helper/ElementHelper';
 
 import {
   getBusinessObject,
@@ -76,7 +76,7 @@ export default class FormDefinitionBehavior extends CommandInterceptor {
 
       // (1) ensure extension elements exists
       if (!rootExtensionElements) {
-        rootExtensionElements = elementHelper.createElement('bpmn:ExtensionElements', { values: [] }, rootElement, bpmnFactory);
+        rootExtensionElements = createElement('bpmn:ExtensionElements', { values: [] }, rootElement, bpmnFactory);
 
         modeling.updateModdleProperties(shape, rootElement, { extensionElements: rootExtensionElements });
       }

package/lib/camunda-cloud/features/modeling/behavior/index.js

@@ -1,3 +1,4 @@
+import CleanUpAssignmentDefinitionBehavior from './CleanUpAssignmentDefinitionBehavior';
 import CleanUpBusinessRuleTaskBehavior from './CleanUpBusinessRuleTaskBehavior';
 import CreateZeebeBoundaryEventBehavior from './CreateZeebeBoundaryEventBehavior';
 import CreateZeebeCallActivityBehavior from './CreateZeebeCallActivityBehavior';
@@ -7,12 +8,14 @@ import FormDefinitionBehavior from './FormDefinitionBehavior';
 
 export default {
   __init__: [
+    'cleanUpAssignmentDefinitionBehavior',
     'cleanUpBusinessRuleTaskBehavior',
     'createZeebeBoundaryEventBehavior',
     'createZeebeCallActivityBehavior',
     'updatePropagateAllChildVariablesBehavior',
     'formDefinitionBehavior'
   ],
+  cleanUpAssignmentDefinitionBehavior: [ 'type', CleanUpAssignmentDefinitionBehavior ],
   cleanUpBusinessRuleTaskBehavior: [ 'type', CleanUpBusinessRuleTaskBehavior ],
   createZeebeBoundaryEventBehavior: [ 'type', CreateZeebeBoundaryEventBehavior ],
   createZeebeCallActivityBehavior: [ 'type', CreateZeebeCallActivityBehavior ],

package/lib/camunda-cloud/helper/CalledElementHelper.js

@@ -2,7 +2,7 @@ import { has } from 'min-dash';
 
 import { getOutputParameters } from './InputOutputHelper';
 
-import { getExtensionElements } from 'bpmn-js-properties-panel/lib/helper/ExtensionElementsHelper';
+import { getExtensionElements } from './ExtensionElementsHelper';
 
 import {
   getBusinessObject,

package/lib/camunda-cloud/helper/ElementHelper.js

@@ -0,0 +1,18 @@
+/**
+ * Creates a new element and set the parent to it
+ *
+ * @method ElementHelper#createElement
+ *
+ * @param {String} elementType of the new element
+ * @param {Object} properties of the new element in key-value pairs
+ * @param {moddle.object} parent of the new element
+ * @param {BpmnFactory} factory which creates the new element
+ *
+ * @returns {djs.model.Base} element which is created
+ */
+export function createElement(elementType, properties, parent, factory) {
+  var element = factory.create(elementType, properties);
+  element.$parent = parent;
+
+  return element;
+}

package/lib/camunda-cloud/helper/ExtensionElementsHelper.js

@@ -0,0 +1,17 @@
+import { is } from 'bpmn-js/lib/util/ModelUtil';
+
+export function getExtensionElements(bo, type) {
+  let elements = [];
+  const extensionElements = bo.get('extensionElements');
+
+  if (typeof extensionElements !== 'undefined') {
+    const extensionValues = extensionElements.get('values');
+    if (typeof extensionValues !== 'undefined') {
+      elements = extensionValues.filter(function(value) {
+        return is(value, type);
+      });
+    }
+  }
+
+  return elements;
+}

package/lib/camunda-cloud/helper/FormsHelper.js

@@ -1,13 +1,13 @@
-import { getExtensionElements } from 'bpmn-js-properties-panel/lib/helper/ExtensionElementsHelper';
+import { getExtensionElements } from './ExtensionElementsHelper';
 
-import elementHelper from 'bpmn-js-properties-panel/lib/helper/ElementHelper';
+import { createElement } from './ElementHelper';
 
 import {
   getBusinessObject,
   is
 } from 'bpmn-js/lib/util/ModelUtil';
 
-import { nextId } from 'bpmn-js-properties-panel/lib/Utils';
+import { nextId } from './Utils';
 
 import { find } from 'min-dash';
 
@@ -15,7 +15,7 @@ const USER_TASK_FORM_PREFIX = 'UserTaskForm_';
 
 
 export function createFormDefinition(properties, extensionElements, bpmnFactory) {
-  return elementHelper.createElement(
+  return createElement(
     'zeebe:FormDefinition',
     properties,
     extensionElements,
@@ -32,7 +32,7 @@ export function createFormKey(formId) {
 }
 
 export function createUserTaskForm(properties, extensionElements, bpmnFactory) {
-  return elementHelper.createElement(
+  return createElement(
     'zeebe:UserTaskForm',
     properties,
     extensionElements,

package/lib/camunda-cloud/helper/InputOutputHelper.js

@@ -5,7 +5,7 @@ import {
 
 import { isAny } from 'bpmn-js/lib/features/modeling/util/ModelingUtil';
 
-import elementHelper from 'bpmn-js-properties-panel/lib/helper/ElementHelper';
+import { createElement } from './ElementHelper';
 
 import { isZeebeServiceTask } from './ZeebeServiceTaskHelper';
 
@@ -133,10 +133,6 @@ export function areOutputParametersSupported(element) {
   ]);
 }
 
-export function createElement(type, parent, factory, properties) {
-  return elementHelper.createElement(type, properties, parent, factory);
-}
-
 export function createIoMapping(parent, bpmnFactory, properties) {
-  return createElement('zeebe:IoMapping', parent, bpmnFactory, properties);
+  return createElement('zeebe:IoMapping', properties, parent, bpmnFactory);
 }

package/lib/camunda-cloud/helper/Utils.js

@@ -0,0 +1,10 @@
+import Ids from 'ids';
+
+/**
+ * generate a semantic id with given prefix
+ */
+export function nextId(prefix) {
+  const ids = new Ids([ 32,32,1 ]);
+
+  return ids.nextPrefixed(prefix);
+}

package/lib/camunda-cloud/helper/ZeebeServiceTaskHelper.js

@@ -1,24 +1,41 @@
 import {
+  getBusinessObject,
   is
 } from 'bpmn-js/lib/util/ModelUtil';
 
-import eventDefinitionHelper from 'bpmn-js-properties-panel/lib/helper/EventDefinitionHelper';
+import { forEach } from 'min-dash';
 
 
 export function isZeebeServiceTask(element) {
   if (!is(element, 'zeebe:ZeebeServiceTask')) return false;
 
   if (is(element, 'bpmn:EndEvent') || is(element, 'bpmn:IntermediateThrowEvent')) {
-    return !!eventDefinitionHelper.getMessageEventDefinition(element);
+    return !!getMessageEventDefinition(element);
   }
 
   return true;
 }
 
 export function isMessageEndEvent(element) {
-  return is(element, 'bpmn:EndEvent') && !!eventDefinitionHelper.getMessageEventDefinition(element);
+  return is(element, 'bpmn:EndEvent') && !!getMessageEventDefinition(element);
 }
 
 export function isMessageThrowEvent(element) {
-  return is(element, 'bpmn:IntermediateThrowEvent') && !!eventDefinitionHelper.getMessageEventDefinition(element);
-}
+  return is(element, 'bpmn:IntermediateThrowEvent') && !!getMessageEventDefinition(element);
+}
+
+function getMessageEventDefinition(element) {
+
+  var bo = getBusinessObject(element),
+      eventDefinition = null;
+
+  if (bo.eventDefinitions) {
+    forEach(bo.eventDefinitions, function(event) {
+      if (is(event, 'bpmn:MessageEventDefinition')) {
+        eventDefinition = event;
+      }
+    });
+  }
+
+  return eventDefinition;
+}

package/lib/camunda-platform/Modeler.js

@@ -4,12 +4,15 @@ import BaseModeler from '../base/Modeler';
 
 import modelingModule from './features/modeling';
 
-import propertiesProviderModule from 'bpmn-js-properties-panel/lib/provider/camunda';
-
 import camundaModdle from 'camunda-bpmn-moddle/resources/camunda.json';
 
 import camundaModdleExtension from 'camunda-bpmn-moddle/lib';
 
+import {
+  CamundaPlatformPropertiesProviderModule,
+  ElementTemplatesPropertiesProviderModule
+} from 'bpmn-js-properties-panel';
+
 
 /**
  *
@@ -33,7 +36,8 @@ inherits(Modeler, BaseModeler);
 Modeler.prototype._camundaPlatformModules = [
   camundaModdleExtension,
   modelingModule,
-  propertiesProviderModule
+  CamundaPlatformPropertiesProviderModule,
+  ElementTemplatesPropertiesProviderModule
 ];
 
 Modeler.prototype._modules = [].concat(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "camunda-bpmn-js",
-  "version": "0.12.0",
+  "version": "0.13.0-alpha.1",
   "description": "Embeddable Camunda modeling distributions based on bpmn-js",
   "main": "lib/index.js",
   "scripts": {
@@ -40,18 +40,19 @@
   "license": "MIT",
   "dependencies": {
     "@bpmn-io/align-to-origin": "^0.7.0",
-    "bpmn-js": "^8.8.2",
+    "@bpmn-io/properties-panel": "^0.10.2",
+    "bpmn-js": "^8.9.1",
     "bpmn-js-disable-collapsed-subprocess": "^0.1.3",
     "bpmn-js-executable-fix": "^0.1.3",
-    "bpmn-js-properties-panel": "^0.46.0",
+    "bpmn-js-properties-panel": "~1.0.0-alpha.1",
     "bpmn-js-signavio-compat": "^1.2.3",
     "camunda-bpmn-moddle": "^6.1.1",
-    "diagram-js": "^7.5.0",
+    "diagram-js": "^7.8.2",
     "diagram-js-minimap": "^2.0.4",
     "diagram-js-origin": "^1.3.2",
     "inherits": "^2.0.4",
     "min-dash": "^3.7.0",
-    "zeebe-bpmn-moddle": "^0.9.0"
+    "zeebe-bpmn-moddle": "^0.10.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^17.1.0",
@@ -59,8 +60,8 @@
     "@rollup/plugin-node-resolve": "^11.1.1",
     "chai": "^4.2.0",
     "cross-env": "^7.0.3",
-    "eslint": "^7.19.0",
-    "eslint-plugin-bpmn-io": "^0.12.0",
+    "eslint": "^7.32.0",
+    "eslint-plugin-bpmn-io": "^0.13.0",
     "execa": "^5.0.0",
     "istanbul-instrumenter-loader": "^3.0.1",
     "karma": "^6.3.0",
@@ -75,7 +76,7 @@
     "karma-sinon-chai": "^2.0.2",
     "karma-webpack": "^5.0.0",
     "min-dom": "^3.1.3",
-    "mocha": "^8.2.1",
+    "mocha": "^9.2.0",
     "mocha-test-container-support": "^0.2.0",
     "npm-run-all": "^4.1.5",
     "puppeteer": "^8.0.0",

package/styles/base-modeler.css

@@ -1,4 +1,4 @@
 @import './diagram-js.css';
 @import './bpmn-font/css/bpmn-embedded.css';
 @import './diagram-js-minimap.css';
-@import './bpmn-js-properties-panel.css';
+@import './properties-panel.css';

package/styles/camunda-platform-modeler.css

@@ -1 +1,2 @@
-@import './base-modeler.css';
+@import './base-modeler.css';
+@import './element-templates.css';