bpmnlint-plugin-camunda-compat 0.15.2 → 0.17.0

package/index.js

@@ -1,7 +1,7 @@
 const { omit } = require('min-dash');
 
 const camundaCloud10Rules = {
-  'called-decision-or-task-definition': [ 'error', { version: '1.0' } ],
+  'implementation': [ 'error', { version: '1.0' } ],
   'called-element': 'error',
   'collapsed-subprocess': 'error',
   'duplicate-task-headers': 'error',
@@ -21,35 +21,35 @@ const camundaCloud10Rules = {
 
 const camundaCloud11Rules = {
   ...camundaCloud10Rules,
-  'called-decision-or-task-definition': [ 'error', { version: '1.1' } ],
+  'implementation': [ 'error', { version: '1.1' } ],
   'element-type': [ 'error', { version: '1.1' } ],
   'timer': [ 'error', { version: '1.1' } ]
 };
 
 const camundaCloud12Rules = {
   ...camundaCloud11Rules,
-  'called-decision-or-task-definition': [ 'error', { version: '1.2' } ],
+  'implementation': [ 'error', { version: '1.2' } ],
   'element-type': [ 'error', { version: '1.2' } ],
   'timer': [ 'error', { version: '1.2' } ]
 };
 
 const camundaCloud13Rules = {
   ...camundaCloud12Rules,
-  'called-decision-or-task-definition': [ 'error', { version: '1.3' } ],
+  'implementation': [ 'error', { version: '1.3' } ],
   'element-type': [ 'error', { version: '1.3' } ],
   'timer': [ 'error', { version: '1.3' } ]
 };
 
 const camundaCloud80Rules = {
   ...omit(camundaCloud13Rules, 'no-template'),
-  'called-decision-or-task-definition': [ 'error', { version: '8.0' } ],
+  'implementation': [ 'error', { version: '8.0' } ],
   'element-type': [ 'error', { version: '8.0' } ],
   'timer': [ 'error', { version: '8.0' } ]
 };
 
 const camundaCloud81Rules = {
   ...omit(camundaCloud80Rules, 'no-zeebe-properties'),
-  'called-decision-or-task-definition': [ 'error', { version: '8.1' } ],
+  'implementation': [ 'error', { version: '8.1' } ],
   'element-type': [ 'error', { version: '8.1' } ],
   'inclusive-gateway': 'error',
   'timer': [ 'error', { version: '8.1' } ]
@@ -57,7 +57,7 @@ const camundaCloud81Rules = {
 
 const camundaCloud82Rules = {
   ...camundaCloud81Rules,
-  'called-decision-or-task-definition': [ 'error', { version: '8.2' } ],
+  'implementation': [ 'error', { version: '8.2' } ],
   'element-type': [ 'error', { version: '8.2' } ],
   'timer': [ 'error', { version: '8.2' } ]
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "0.15.2",
+  "version": "0.17.0",
   "description": "A bpmnlint plug-in for Camunda Platform compatibility",
   "main": "index.js",
   "scripts": {
@@ -33,10 +33,10 @@
     "modeler-moddle": "^0.1.0",
     "sinon": "^14.0.0",
     "sinon-chai": "^3.7.0",
-    "zeebe-bpmn-moddle": "^0.14.0"
+    "zeebe-bpmn-moddle": "^0.17.0"
   },
   "dependencies": {
-    "@bpmn-io/feel-lint": "^0.1.0",
+    "@bpmn-io/feel-lint": "^0.1.1",
     "@bpmn-io/moddle-utils": "^0.1.0",
     "bpmnlint-utils": "^1.0.2",
     "min-dash": "^3.8.1",

package/rules/element-type/config.js

@@ -24,11 +24,13 @@ module.exports = {
   'bpmn:InclusiveGateway': '8.1',
   'bpmn:IntermediateCatchEvent': {
     'bpmn:MessageEventDefinition': '1.0',
-    'bpmn:TimerEventDefinition': '1.0'
+    'bpmn:TimerEventDefinition': '1.0',
+    'bpmn:LinkEventDefinition': '8.2'
   },
   'bpmn:IntermediateThrowEvent': {
     '_': '1.1',
-    'bpmn:MessageEventDefinition': '1.2'
+    'bpmn:MessageEventDefinition': '1.2',
+    'bpmn:LinkEventDefinition': '8.2'
   },
   'bpmn:ManualTask': '1.1',
   'bpmn:MessageFlow': '1.0',

package/rules/{called-decision-or-task-definition → implementation}/config.js

@@ -4,9 +4,14 @@ module.exports = {
   },
   taskDefinition: {
     'bpmn:BusinessRuleTask': '1.1',
-    'bpmn:IntermediateThrowEvent': '1.2',
+    'bpmn:IntermediateThrowEvent': {
+      'bpmn:MessageEventDefinition': '1.2'
+    },
     'bpmn:ScriptTask': '1.1',
     'bpmn:SendTask': '1.1',
     'bpmn:ServiceTask': '1.0'
+  },
+  script: {
+    'bpmn:ScriptTask': '8.2'
   }
 };

package/rules/implementation/index.js

@@ -0,0 +1,216 @@
+const { is } = require('bpmnlint-utils');
+
+const { getPath } = require('@bpmn-io/moddle-utils');
+
+const { isString } = require('min-dash');
+
+const config = require('./config');
+
+const { greaterOrEqual } = require('../utils/version');
+
+const {
+  findExtensionElement,
+  getEventDefinition,
+  hasExtensionElement,
+  hasProperties
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { ERROR_TYPES } = require('../utils/error-types');
+
+module.exports = function({ version }) {
+  function check(node, reporter) {
+    const calledDecisionConfig = config.calledDecision[ node.$type ];
+    const scriptConfig = config.script[ node.$type ];
+    const taskDefinitionConfig = config.taskDefinition[ node.$type ];
+
+    if (
+      (!calledDecisionConfig || (isString(calledDecisionConfig) && !greaterOrEqual(version, calledDecisionConfig)))
+      && (!scriptConfig || (isString(scriptConfig) && !greaterOrEqual(version, scriptConfig)))
+      && (!taskDefinitionConfig || (isString(taskDefinitionConfig) && !greaterOrEqual(version, taskDefinitionConfig)))) {
+      return;
+    }
+
+    if (is(node, 'bpmn:ThrowEvent') && !getEventDefinition(node)) {
+      return;
+    }
+
+    let errors;
+
+    const calledDecision = findExtensionElement(node, 'zeebe:CalledDecision'),
+          script = findExtensionElement(node, 'zeebe:Script'),
+          taskDefinition = findExtensionElement(node, 'zeebe:TaskDefinition');
+
+    if (calledDecision && !script && !taskDefinition) {
+
+      if (!isCalledDecisionAllowed(node, version)) {
+        const allowedVersion = getAllowedVersion(calledDecisionConfig, node);
+
+        reportErrors(node, reporter, {
+          message: allowedVersion
+            ? `Extension element of type <zeebe:CalledDecision> only allowed by Camunda Platform ${ allowedVersion } or newer`
+            : 'Extension element of type <zeebe:CalledDecision> not allowed',
+          path: getPath(calledDecision, node),
+          data: {
+            type: ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED,
+            node,
+            parentNode: null,
+            extensionElement: calledDecision,
+            allowedVersion
+          }
+        });
+
+        return;
+      }
+
+      errors = hasProperties(calledDecision, {
+        decisionId: {
+          required: true
+        },
+        resultVariable: {
+          required: true
+        }
+      }, node);
+
+      if (errors && errors.length) {
+        reportErrors(node, reporter, errors);
+
+        return;
+      }
+    }
+
+    if (!calledDecision && script && !taskDefinition) {
+
+      if (!isScriptAllowed(node, version)) {
+        const allowedVersion = getAllowedVersion(scriptConfig, node);
+
+        reportErrors(node, reporter, {
+          message: allowedVersion
+            ? `Extension element of type <zeebe:Script> only allowed by Camunda Platform ${ allowedVersion } or newer`
+            : 'Extension element of type <zeebe:Script> not allowed',
+          path: getPath(script, node),
+          data: {
+            type: ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED,
+            node,
+            parentNode: null,
+            extensionElement: script,
+            allowedVersion
+          }
+        });
+
+        return;
+      }
+
+      errors = hasProperties(script, {
+        expression: {
+          required: true
+        },
+        resultVariable: {
+          required: true
+        }
+      }, node);
+
+      if (errors && errors.length) {
+        reportErrors(node, reporter, errors);
+
+        return;
+      }
+    }
+
+    if (!calledDecision && !script && taskDefinition) {
+
+      if (!isTaskDefinitionAllowed(node, version)) {
+        const allowedVersion = getAllowedVersion(taskDefinitionConfig, node);
+
+        reportErrors(node, reporter, {
+          message: allowedVersion
+            ? `Extension element of type <zeebe:TaskDefinition> only allowed by Camunda Platform ${ allowedVersion } or newer`
+            : 'Extension element of type <zeebe:TaskDefinition> not allowed',
+          path: getPath(taskDefinition, node),
+          data: {
+            type: ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED,
+            node,
+            parentNode: null,
+            extensionElement: taskDefinition,
+            allowedVersion
+          }
+        });
+
+        return;
+      }
+
+      errors = hasProperties(taskDefinition, {
+        type: {
+          required: true
+        }
+      }, node);
+
+      if (errors && errors.length) {
+        reportErrors(node, reporter, errors);
+      }
+    }
+
+    const allowedTypes = [
+      isCalledDecisionAllowed(node, version) ? 'zeebe:CalledDecision' : false,
+      isScriptAllowed(node, version) ? 'zeebe:Script' : false,
+      isTaskDefinitionAllowed(node, version) ? 'zeebe:TaskDefinition' : false
+    ].filter(isAllowed => isAllowed);
+
+    if (allowedTypes.length === 0) {
+      return;
+    } else if (allowedTypes.length === 1) {
+      errors = hasExtensionElement(node, allowedTypes[0], node);
+    } else {
+      errors = hasExtensionElement(node, allowedTypes, node);
+    }
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+
+      return;
+    }
+  }
+
+  return {
+    check
+  };
+};
+
+function isCalledDecisionAllowed(node, version) {
+  const { calledDecision } = config;
+
+  const allowedVersion = getAllowedVersion(calledDecision[ node.$type ], node);
+
+  return calledDecision[ node.$type ] && greaterOrEqual(version, allowedVersion);
+}
+
+function isScriptAllowed(node, version) {
+  const { script } = config;
+
+  const allowedVersion = getAllowedVersion(script[ node.$type ], node);
+
+  return allowedVersion && greaterOrEqual(version, allowedVersion);
+}
+
+function isTaskDefinitionAllowed(node, version) {
+  const { taskDefinition } = config;
+
+  const allowedVersion = getAllowedVersion(taskDefinition[ node.$type ], node);
+
+  return allowedVersion && greaterOrEqual(version, allowedVersion);
+}
+
+function getAllowedVersion(config, node) {
+  if (!config) {
+    return null;
+  }
+
+  if (isString(config)) {
+    return config;
+  }
+
+  const eventDefinition = getEventDefinition(node);
+
+  return eventDefinition && config[ eventDefinition.$type ];
+}

package/rules/called-decision-or-task-definition/index.js

@@ -1,141 +0,0 @@
-const { is } = require('bpmnlint-utils');
-
-const { getPath } = require('@bpmn-io/moddle-utils');
-
-const config = require('./config');
-
-const { greaterOrEqual } = require('../utils/version');
-
-const {
-  findExtensionElement,
-  getEventDefinition,
-  hasExtensionElement,
-  hasProperties
-} = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { ERROR_TYPES } = require('../utils/error-types');
-
-module.exports = function({ version }) {
-  function check(node, reporter) {
-    if (
-      (!config.calledDecision[ node.$type ] || !greaterOrEqual(version, config.calledDecision[ node.$type ]))
-      && (!config.taskDefinition[ node.$type ] || !greaterOrEqual(version, config.taskDefinition[ node.$type ]))) {
-      return;
-    }
-
-    if (is(node, 'bpmn:ThrowEvent') && !getEventDefinition(node)) {
-      return;
-    }
-
-    let errors;
-
-    const calledDecision = findExtensionElement(node, 'zeebe:CalledDecision'),
-          taskDefinition = findExtensionElement(node, 'zeebe:TaskDefinition');
-
-    if (calledDecision && !taskDefinition) {
-
-      if (!isCalledDecisionAllowed(node, version)) {
-        const allowedVersion = config.calledDecision[ node.$type ] || null;
-
-        reportErrors(node, reporter, {
-          message: allowedVersion
-            ? `Extension element of type <zeebe:CalledDecision> only allowed by Camunda Platform ${ allowedVersion } or newer`
-            : 'Extension element of type <zeebe:CalledDecision> not allowed',
-          path: getPath(calledDecision, node),
-          data: {
-            type: ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED,
-            node,
-            parentNode: null,
-            extensionElement: calledDecision,
-            allowedVersion
-          }
-        });
-
-        return;
-      }
-
-      errors = hasProperties(calledDecision, {
-        decisionId: {
-          required: true
-        },
-        resultVariable: {
-          required: true
-        }
-      }, node);
-
-      if (errors && errors.length) {
-        reportErrors(node, reporter, errors);
-
-        return;
-      }
-    }
-
-    if (!calledDecision && taskDefinition) {
-
-      if (!isTaskDefinitionAllowed(node, version)) {
-        const allowedVersion = config.taskDefinition[ node.$type ] || null;
-
-        reportErrors(node, reporter, {
-          message: allowedVersion
-            ? `Extension element of type <zeebe:TaskDefinition> only allowed by Camunda Platform ${ allowedVersion } or newer`
-            : 'Extension element of type <zeebe:TaskDefinition> not allowed',
-          path: getPath(taskDefinition, node),
-          data: {
-            type: ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED,
-            node,
-            parentNode: null,
-            extensionElement: taskDefinition,
-            allowedVersion
-          }
-        });
-
-        return;
-      }
-
-      errors = hasProperties(taskDefinition, {
-        type: {
-          required: true
-        }
-      }, node);
-
-      if (errors && errors.length) {
-        reportErrors(node, reporter, errors);
-      }
-    }
-
-    if (isCalledDecisionAllowed(node, version) && isTaskDefinitionAllowed(node, version)) {
-      errors = hasExtensionElement(node, [
-        'zeebe:CalledDecision',
-        'zeebe:TaskDefinition'
-      ], node);
-    } else if (isCalledDecisionAllowed(node, version)) {
-      errors = hasExtensionElement(node, 'zeebe:CalledDecision', node);
-    } else {
-      errors = hasExtensionElement(node, 'zeebe:TaskDefinition', node);
-    }
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
-
-      return;
-    }
-  }
-
-  return {
-    check
-  };
-};
-
-function isCalledDecisionAllowed(node, version) {
-  const { calledDecision } = config;
-
-  return calledDecision[ node.$type ] && greaterOrEqual(version, calledDecision[ node.$type ]);
-}
-
-function isTaskDefinitionAllowed(node, version) {
-  const { taskDefinition } = config;
-
-  return taskDefinition[ node.$type ] && greaterOrEqual(version, taskDefinition[ node.$type ]);
-}