bpmnlint-plugin-camunda-compat 2.15.0 → 2.17.0

package/index.js

@@ -19,10 +19,12 @@ const camundaCloud10Rules = withConfig({
   'no-task-schedule': 'error',
   'no-template': 'error',
   'no-zeebe-properties': 'error',
+  'no-zeebe-user-task': 'error',
   'sequence-flow-condition': 'error',
   'start-event-form': 'error',
   'subscription': 'error',
   'timer': 'error',
+  'user-task-definition': 'warn',
   'user-task-form': 'error',
   'feel': 'error'
 }, { version: '1.0' });
@@ -64,8 +66,14 @@ const camundaCloud83Rules = withConfig({
 const camundaCloud84Rules = withConfig(
   omit(camundaCloud83Rules, 'collapsed-subprocess'), { version: '8.4' });
 
+const camundaCloud85Rules = withConfig(
+  omit(camundaCloud83Rules, [
+    'collapsed-subprocess',
+    'no-zeebe-user-task'
+  ]), { version: '8.5' });
+
 const camundaPlatform719Rules = withConfig({
-  'history-time-to-live': 'error'
+  'history-time-to-live': 'info'
 }, {
   platform: 'camunda-platform',
   version: '7.19'
@@ -107,6 +115,7 @@ const rules = {
   'no-task-schedule': './rules/camunda-cloud/no-task-schedule',
   'no-template': './rules/camunda-cloud/no-template',
   'no-zeebe-properties': './rules/camunda-cloud/no-zeebe-properties',
+  'no-zeebe-user-task': './rules/camunda-cloud/no-zeebe-user-task',
   'secrets': './rules/camunda-cloud/secrets',
   'sequence-flow-condition': './rules/camunda-cloud/sequence-flow-condition',
   'signal-reference': './rules/camunda-cloud/signal-reference',
@@ -114,52 +123,70 @@ const rules = {
   'subscription': './rules/camunda-cloud/subscription',
   'task-schedule': './rules/camunda-cloud/task-schedule',
   'timer': './rules/camunda-cloud/timer',
+  'user-task-definition': './rules/camunda-cloud/user-task-definition',
   'user-task-form': './rules/camunda-cloud/user-task-form'
 };
 
+const configs = {
+  'camunda-cloud-1-0': {
+    rules: camundaCloud10Rules
+  },
+  'camunda-cloud-1-1': {
+    rules: camundaCloud11Rules
+  },
+  'camunda-cloud-1-2': {
+    rules: camundaCloud12Rules
+  },
+  'camunda-cloud-1-3': {
+    rules: camundaCloud13Rules
+  },
+  'camunda-cloud-8-0': {
+    rules: camundaCloud80Rules
+  },
+  'camunda-cloud-8-1': {
+    rules: camundaCloud81Rules
+  },
+  'camunda-cloud-8-2': {
+    rules: camundaCloud82Rules
+  },
+  'camunda-cloud-8-3': {
+    rules: camundaCloud83Rules
+  },
+  'camunda-cloud-8-4': {
+    rules: camundaCloud84Rules
+  },
+  'camunda-cloud-8-5': {
+    rules: camundaCloud85Rules
+  },
+  'camunda-platform-7-19': {
+    rules: camundaPlatform719Rules
+  },
+  'camunda-platform-7-20': {
+    rules: camundaPlatform720Rules
+  },
+  'camunda-platform-7-21': {
+    rules: camundaPlatform721Rules
+  }
+};
+
 module.exports = {
   configs: {
-    'camunda-cloud-1-0': {
-      rules: camundaCloud10Rules
-    },
-    'camunda-cloud-1-1': {
-      rules: camundaCloud11Rules
-    },
-    'camunda-cloud-1-2': {
-      rules: camundaCloud12Rules
-    },
-    'camunda-cloud-1-3': {
-      rules: camundaCloud13Rules
-    },
-    'camunda-cloud-8-0': {
-      rules: camundaCloud80Rules
-    },
-    'camunda-cloud-8-1': {
-      rules: camundaCloud81Rules
-    },
-    'camunda-cloud-8-2': {
-      rules: camundaCloud82Rules
-    },
-    'camunda-cloud-8-3': {
-      rules: camundaCloud83Rules
-    },
-    'camunda-cloud-8-4': {
-      rules: camundaCloud84Rules
-    },
-    'camunda-platform-7-19': {
-      rules: camundaPlatform719Rules
-    },
-    'camunda-platform-7-20': {
-      rules: camundaPlatform720Rules
-    },
-    'camunda-platform-7-21': {
-      rules: camundaPlatform721Rules
-    },
+    ...configs,
     'all': {
       rules: Object.keys(rules).reduce((allRules, rule) => {
         return {
           ...allRules,
-          [ rule ]: 'error'
+          [ rule ]: Object.values(configs).reduce((type, { rules }) => {
+            if (type) {
+              return type;
+            }
+
+            if (rules[ rule ]) {
+              return Array.isArray(rules[ rule ]) ? rules[ rule ][0] : rules[ rule ];
+            }
+
+            return type;
+          }, null)
         };
       }, {})
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "2.15.0",
+  "version": "2.17.0",
   "description": "A bpmnlint plug-in for Camunda compatibility",
   "main": "index.js",
   "scripts": {
@@ -24,17 +24,17 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "bpmn-moddle": "^8.0.1",
-    "bpmnlint": "^9.2.0",
+    "bpmn-moddle": "^8.1.0",
+    "bpmnlint": "^10.2.0",
     "camunda-bpmn-moddle": "^7.0.1",
-    "chai": "^4.3.10",
-    "eslint": "^8.51.0",
+    "chai": "^4.4.1",
+    "eslint": "^8.56.0",
     "eslint-plugin-bpmn-io": "^1.0.0",
     "mocha": "^10.2.0",
     "modeler-moddle": "^0.2.0",
-    "sinon": "^16.1.0",
+    "sinon": "^17.0.1",
     "sinon-chai": "^3.7.0",
-    "zeebe-bpmn-moddle": "^1.0.0"
+    "zeebe-bpmn-moddle": "^1.1.0"
   },
   "dependencies": {
     "@bpmn-io/feel-lint": "^1.2.0",

package/rules/camunda-cloud/escalation-reference.js

@@ -62,6 +62,6 @@ module.exports = skipInNonExecutableProcess(function() {
   };
 });
 
-function isNoEscalationRefAllowed(node, version) {
-  return is(node, 'bpmn:BoundaryEvent');
+function isNoEscalationRefAllowed(node) {
+  return isAny(node, [ 'bpmn:CatchEvent', 'bpmn:BoundaryEvent' ]);
 }

package/rules/camunda-cloud/no-zeebe-user-task.js

@@ -0,0 +1,27 @@
+const { is } = require('bpmnlint-utils');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+const { hasNoExtensionElement } = require('../utils/element');
+
+const ALLOWED_VERSION = '8.5';
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:UserTask')) {
+      return;
+    }
+
+    const errors = hasNoExtensionElement(node, 'zeebe:UserTask', node, ALLOWED_VERSION);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});

package/rules/camunda-cloud/user-task-definition.js

@@ -0,0 +1,25 @@
+const { is } = require('bpmnlint-utils');
+
+const { hasExtensionElement } = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:UserTask')) {
+      return;
+    }
+
+    let errors = hasExtensionElement(node, 'zeebe:FormDefinition', node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});

package/rules/camunda-cloud/user-task-form.js

@@ -5,8 +5,7 @@ const {
   findExtensionElements,
   findParent,
   hasProperties,
-  hasProperty,
-  hasExtensionElement
+  hasProperty
 } = require('../utils/element');
 
 const { reportErrors } = require('../utils/reporter');
@@ -20,23 +19,41 @@ const formIdAllowedVersions = {
   web: '8.0'
 };
 
+const ZEEBE_USER_TASK_VERSION = '8.5';
+
 module.exports = skipInNonExecutableProcess(function({ modeler = 'desktop', version }) {
   function check(node, reporter) {
     if (!is(node, 'bpmn:UserTask')) {
       return;
     }
 
-    let errors = hasExtensionElement(node, 'zeebe:FormDefinition', node);
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
+    const formDefinition = findExtensionElement(node, 'zeebe:FormDefinition');
 
+    if (!formDefinition) {
       return;
     }
 
-    const formDefinition = findExtensionElement(node, 'zeebe:FormDefinition');
+    // handle Zebee User Task
+    if (isZeebeUserTask(node)) {
+
+      // handled by no-zeebe-user-task rule
+      if (!greaterOrEqual(version, ZEEBE_USER_TASK_VERSION)) {
+        return;
+      }
+
+      const errors = hasProperty(formDefinition, [
+        'externalReference',
+        'formId'
+      ], node) || [];
 
-    errors = [];
+      if (errors.length) {
+        reportErrors(node, reporter, errors);
+      }
+
+      return;
+    }
+
+    let errors;
 
     const formIdAllowedVersion = formIdAllowedVersions[ modeler ];
 
@@ -118,4 +135,8 @@ function findUserTaskForm(node, formKey) {
 
 function isFormIdAllowed(version, formIdAllowedVersion) {
   return greaterOrEqual(version, formIdAllowedVersion);
-}
+}
+
+function isZeebeUserTask(node) {
+  return !!findExtensionElement(node, 'zeebe:UserTask');
+}

package/rules/camunda-platform/history-time-to-live.js

@@ -1,9 +1,5 @@
 const { is } = require('bpmnlint-utils');
 
-const { hasProperties } = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
 const { skipInNonExecutableProcess } = require('../utils/rule');
 
 module.exports = skipInNonExecutableProcess(function() {
@@ -13,16 +9,9 @@ module.exports = skipInNonExecutableProcess(function() {
       return;
     }
 
-    let errors = hasProperties(node, {
-      'historyTimeToLive': {
-        required: true
-      }
-    }, node);
-
-    if (errors) {
-      reportErrors(node, reporter, errors);
+    if (!node.get('camunda:historyTimeToLive')) {
+      reporter.report(node.id, 'Property <historyTimeToLive> should be configured on <bpmn:Process> or engine level.', [ 'historyTimeToLive' ]);
     }
-    return;
   }
 
   return {