@camunda/linting 3.16.0 → 3.18.0

package/lib/compiled-config.js

@@ -54,6 +54,7 @@ const rules = {
   "camunda-compat/no-task-schedule": "error",
   "camunda-compat/no-template": "error",
   "camunda-compat/no-zeebe-properties": "error",
+  "camunda-compat/no-zeebe-user-task": "error",
   "camunda-compat/secrets": "warn",
   "camunda-compat/sequence-flow-condition": "error",
   "camunda-compat/signal-reference": "error",
@@ -62,7 +63,8 @@ const rules = {
   "camunda-compat/task-schedule": "error",
   "camunda-compat/timer": "error",
   "camunda-compat/user-task-definition": "warn",
-  "camunda-compat/user-task-form": "error"
+  "camunda-compat/user-task-form": "error",
+  "camunda-compat/wait-for-completion": "error"
 };
 
 const config = {
@@ -178,38 +180,46 @@ import rule_24 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-zeebe
 
 cache['bpmnlint-plugin-camunda-compat/no-zeebe-properties'] = rule_24;
 
-import rule_25 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/secrets';
+import rule_25 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-zeebe-user-task';
 
-cache['bpmnlint-plugin-camunda-compat/secrets'] = rule_25;
+cache['bpmnlint-plugin-camunda-compat/no-zeebe-user-task'] = rule_25;
 
-import rule_26 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/sequence-flow-condition';
+import rule_26 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/secrets';
 
-cache['bpmnlint-plugin-camunda-compat/sequence-flow-condition'] = rule_26;
+cache['bpmnlint-plugin-camunda-compat/secrets'] = rule_26;
 
-import rule_27 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/signal-reference';
+import rule_27 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/sequence-flow-condition';
 
-cache['bpmnlint-plugin-camunda-compat/signal-reference'] = rule_27;
+cache['bpmnlint-plugin-camunda-compat/sequence-flow-condition'] = rule_27;
 
-import rule_28 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/start-event-form';
+import rule_28 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/signal-reference';
 
-cache['bpmnlint-plugin-camunda-compat/start-event-form'] = rule_28;
+cache['bpmnlint-plugin-camunda-compat/signal-reference'] = rule_28;
 
-import rule_29 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/subscription';
+import rule_29 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/start-event-form';
 
-cache['bpmnlint-plugin-camunda-compat/subscription'] = rule_29;
+cache['bpmnlint-plugin-camunda-compat/start-event-form'] = rule_29;
 
-import rule_30 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/task-schedule';
+import rule_30 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/subscription';
 
-cache['bpmnlint-plugin-camunda-compat/task-schedule'] = rule_30;
+cache['bpmnlint-plugin-camunda-compat/subscription'] = rule_30;
 
-import rule_31 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/timer';
+import rule_31 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/task-schedule';
 
-cache['bpmnlint-plugin-camunda-compat/timer'] = rule_31;
+cache['bpmnlint-plugin-camunda-compat/task-schedule'] = rule_31;
 
-import rule_32 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/user-task-definition';
+import rule_32 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/timer';
 
-cache['bpmnlint-plugin-camunda-compat/user-task-definition'] = rule_32;
+cache['bpmnlint-plugin-camunda-compat/timer'] = rule_32;
 
-import rule_33 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/user-task-form';
+import rule_33 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/user-task-definition';
 
-cache['bpmnlint-plugin-camunda-compat/user-task-form'] = rule_33;
+cache['bpmnlint-plugin-camunda-compat/user-task-definition'] = rule_33;
+
+import rule_34 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/user-task-form';
+
+cache['bpmnlint-plugin-camunda-compat/user-task-form'] = rule_34;
+
+import rule_35 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/wait-for-completion';
+
+cache['bpmnlint-plugin-camunda-compat/wait-for-completion'] = rule_35;

package/lib/utils/error-messages.js

@@ -126,7 +126,7 @@ export function getErrorMessage(report, executionPlatform, executionPlatformVers
   }
 
   if (type === ERROR_TYPES.PROPERTY_VALUE_REQUIRED) {
-    return getPropertyValueRequiredErrorMessage(report);
+    return getPropertyValueRequiredErrorMessage(report, executionPlatform, executionPlatformVersion);
   }
 
   if (type === ERROR_TYPES.EXPRESSION_REQUIRED) {
@@ -228,13 +228,14 @@ function getPropertyValueDuplicatedErrorMessage(report) {
   return message;
 }
 
-function getPropertyValueRequiredErrorMessage(report) {
+function getPropertyValueRequiredErrorMessage(report, executionPlatform, executionPlatformVersion) {
   const {
     data,
     message
   } = report;
 
   const {
+    allowedVersion,
     node,
     property,
     parentNode
@@ -248,6 +249,12 @@ function getPropertyValueRequiredErrorMessage(report) {
     }
   }
 
+  const typeString = getTypeString(parentNode || node);
+
+  if (is(node, 'bpmn:CompensateEventDefinition') && property === 'waitForCompletion') {
+    return getSupportedMessage(`${ getIndefiniteArticle(typeString) } <${ typeString }> with <Wait for completion> disabled`, executionPlatform, executionPlatformVersion, allowedVersion);
+  }
+
   return message;
 }
 
@@ -274,6 +281,10 @@ function getExtensionElementNotAllowedErrorMessage(report, executionPlatform, ex
     return getSupportedMessage(`${ getIndefiniteArticle(typeString) } <${ typeString }> with <Extension properties>`, executionPlatform, executionPlatformVersion, allowedVersion);
   }
 
+  if (is(extensionElement, 'zeebe:UserTask')) {
+    return getSupportedMessage('A <User Task> with <Implementation: Zeebe user task>', executionPlatform, executionPlatformVersion, allowedVersion);
+  }
+
   if (is(node, 'bpmn:ScriptTask') && is(extensionElement, 'zeebe:Script')) {
     return getSupportedMessage('A <Script Task> with <Implementation: FEEL expression>', executionPlatform, executionPlatformVersion, allowedVersion);
   }
@@ -500,6 +511,15 @@ function getPropertyRequiredErrorMessage(report, executionPlatform, executionPla
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Form type: Custom form key> must have a defined <Form key>`;
   }
 
+  // Zeebe User Task
+  if (is(node, 'zeebe:FormDefinition') && isZeebeUserTask(parentNode)) {
+    if (isEmptyString(node.get('externalReference'))) {
+      return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Form type: External reference> must have a defined <External reference>`;
+    } else if (isEmptyString(node.get('formId'))) {
+      return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Form type: Camunda Form> must have a defined <Form ID>`;
+    }
+  }
+
   if (is(node, 'zeebe:FormDefinition') && isArray(requiredProperty) && requiredProperty.includes('formId') && isEmptyString(node.get('formId'))) {
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Form type: Camunda form (linked)> must have a defined <Form ID>`;
   }
@@ -693,4 +713,10 @@ function getLoopNotAllowedErrorMessage(report) {
 
 function isEmptyString(value) {
   return isString(value) && value.trim() === '';
-}
+}
+
+function isZeebeUserTask(node) {
+  return node.get('extensionElements').get('values').some(extensionElement => {
+    return is(extensionElement, 'zeebe:UserTask');
+  });
+}

package/lib/utils/properties-panel.js

@@ -168,10 +168,14 @@ export function getEntryIds(report) {
       requiredProperty
     } = data;
 
-    if (isArray(requiredProperty) && requiredProperty.includes('formKey') && isEmptyString(node.get('formKey'))) {
-      return [ 'customFormKey' ];
-    } else if (isArray(requiredProperty) && requiredProperty.includes('formId') && isEmptyString(node.get('formId'))) {
-      return [ 'formId' ];
+    if (isArray(requiredProperty)) {
+      if (requiredProperty.includes('formKey') && isEmptyString(node.get('formKey'))) {
+        return [ 'customFormKey' ];
+      } else if (requiredProperty.includes('formId') && isEmptyString(node.get('formId'))) {
+        return [ 'formId' ];
+      } else if (requiredProperty.includes('externalReference') && isEmptyString(node.get('externalReference'))) {
+        return [ 'externalReference' ];
+      }
     }
   }
 
@@ -205,6 +209,10 @@ export function getEntryIds(report) {
     });
   }
 
+  if (isExtensionElementNotAllowedError(data, 'zeebe:UserTask')) {
+    return [ 'userTaskImplementation' ];
+  }
+
   if (isExtensionElementNotAllowedError(data, 'zeebe:FormDefinition', 'bpmn:StartEvent')) {
     return [ 'formType' ];
   }
@@ -304,6 +312,10 @@ export function getEntryIds(report) {
     return [ 'linkName' ];
   }
 
+  if (isPropertyError(data, 'waitForCompletion', 'bpmn:CompensateEventDefinition')) {
+    return [ 'waitForCompletion' ];
+  }
+
   return [];
 }
 
@@ -424,6 +436,10 @@ export function getErrorMessage(id, report) {
     }
   }
 
+  if (id === 'externalReference') {
+    return 'External reference must be defined.';
+  }
+
   if (id === 'formConfiguration') {
     return 'Form JSON configuration must be defined.';
   }
@@ -436,6 +452,10 @@ export function getErrorMessage(id, report) {
     return 'Not supported.';
   }
 
+  if (id === 'userTaskImplementation') {
+    return 'Supported only in Camunda 8.5 or newer.';
+  }
+
   if (id === 'conditionExpression') {
     return 'Condition expression must be defined.';
   }
@@ -499,6 +519,10 @@ export function getErrorMessage(id, report) {
       return 'Must be defined.';
     }
   }
+
+  if (id === 'waitForCompletion') {
+    return 'Must wait for completion.';
+  }
 }
 
 function isExtensionElementNotAllowedError(data, extensionElement, type) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camunda/linting",
-  "version": "3.16.0",
+  "version": "3.18.0",
   "description": "Linting for Camunda",
   "main": "index.js",
   "scripts": {
@@ -32,7 +32,7 @@
     "@bpmn-io/diagram-js-ui": "^0.2.2",
     "bpmn-moddle": "^8.1.0",
     "bpmnlint": "^10.2.0",
-    "bpmnlint-plugin-camunda-compat": "^2.16.0",
+    "bpmnlint-plugin-camunda-compat": "^2.18.0",
     "bpmnlint-utils": "^1.0.2",
     "camunda-bpmn-moddle": "^7.0.1",
     "clsx": "^2.0.0",
@@ -40,13 +40,13 @@
     "min-dom": "^4.1.0",
     "modeler-moddle": "^0.2.0",
     "semver-compare": "^1.0.0",
-    "zeebe-bpmn-moddle": "^1.0.0"
+    "zeebe-bpmn-moddle": "^1.1.0"
   },
   "devDependencies": {
     "bpmn-js": "^16.5.0",
     "bpmn-js-element-templates": "^1.13.1",
-    "bpmn-js-properties-panel": "^5.11.1",
-    "camunda-bpmn-js-behaviors": "^1.2.3",
+    "bpmn-js-properties-panel": "^5.13.0",
+    "camunda-bpmn-js-behaviors": "^1.3.0",
     "chai": "^4.4.1",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",