bpmnlint-plugin-camunda-compat 2.23.0 → 2.24.0

package/rules/camunda-cloud/no-multiple-none-start-events.js

@@ -1,41 +1,41 @@
-const { is } = require('bpmnlint-utils');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { ERROR_TYPES } = require('../utils/element');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:Process')) {
-      return;
-    }
-
-    const flowElements = node.get('flowElements') || [];
-
-    const noneStartEvents = flowElements.filter(flowElement => {
-      return is(flowElement, 'bpmn:StartEvent') && !flowElement.get('eventDefinitions').length;
-    });
-
-    if (noneStartEvents.length <= 1) {
-      return;
-    }
-
-    noneStartEvents.forEach(startEvent => {
-      reportErrors(startEvent, reporter, {
-        message: 'Multiple elements of type <bpmn:StartEvent> with no event definition not allowed as children of <bpmn:Process>',
-        path: null,
-        data: {
-          type: ERROR_TYPES.ELEMENT_MULTIPLE_NOT_ALLOWED,
-          node: startEvent,
-          parent: null
-        }
-      });
-    });
-  }
-
-  return {
-    check
-  };
-});
+const { is } = require('bpmnlint-utils');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { ERROR_TYPES } = require('../utils/element');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:Process')) {
+      return;
+    }
+
+    const flowElements = node.get('flowElements') || [];
+
+    const noneStartEvents = flowElements.filter(flowElement => {
+      return is(flowElement, 'bpmn:StartEvent') && !flowElement.get('eventDefinitions').length;
+    });
+
+    if (noneStartEvents.length <= 1) {
+      return;
+    }
+
+    noneStartEvents.forEach(startEvent => {
+      reportErrors(startEvent, reporter, {
+        message: 'Multiple elements of type <bpmn:StartEvent> with no event definition not allowed as children of <bpmn:Process>',
+        path: null,
+        data: {
+          type: ERROR_TYPES.ELEMENT_MULTIPLE_NOT_ALLOWED,
+          node: startEvent,
+          parent: null
+        }
+      });
+    });
+  }
+
+  return {
+    check
+  };
+});

package/rules/camunda-cloud/no-priority-definition.js

@@ -0,0 +1,19 @@
+const { hasNoExtensionElement } = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    const errors = hasNoExtensionElement(node, 'zeebe:PriorityDefinition', node, '8.6');
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});

package/rules/camunda-cloud/no-propagate-all-parent-variables.js

@@ -1,45 +1,45 @@
-const { is } = require('bpmnlint-utils');
-
-const {
-  findExtensionElement,
-  hasProperties
-} = 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:CallActivity')) {
-      return;
-    }
-
-    const calledElement = findExtensionElement(node, 'zeebe:CalledElement');
-
-    if (!calledElement) {
-      return;
-    }
-
-    const errors = hasProperties(calledElement, {
-      propagateAllParentVariables: {
-        allowed: function(value) {
-
-          // `propergateAllParentVariables` is not recognized by Camunda 8.1 and older
-          // setting it to `true` is therefore allowed for all versions
-          // setting it to `false` is only allowed for Camunda 8.2 and newer
-          return value;
-        },
-        allowedVersion: '8.2'
-      }
-    }, node);
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  hasProperties
+} = 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:CallActivity')) {
+      return;
+    }
+
+    const calledElement = findExtensionElement(node, 'zeebe:CalledElement');
+
+    if (!calledElement) {
+      return;
+    }
+
+    const errors = hasProperties(calledElement, {
+      propagateAllParentVariables: {
+        allowed: function(value) {
+
+          // `propergateAllParentVariables` is not recognized by Camunda 8.1 and older
+          // setting it to `true` is therefore allowed for all versions
+          // setting it to `false` is only allowed for Camunda 8.2 and newer
+          return value;
+        },
+        allowedVersion: '8.2'
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
 });

package/rules/camunda-cloud/no-signal-event-sub-process.js

@@ -1,46 +1,46 @@
-const { is } = require('bpmnlint-utils');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { getEventDefinition } = require('../utils/element');
-
-const { ERROR_TYPES } = require('../utils/error-types');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:StartEvent')) {
-      return;
-    }
-
-    const eventDefinition = getEventDefinition(node);
-
-    if (!eventDefinition || !is(eventDefinition, 'bpmn:SignalEventDefinition')) {
-      return;
-    }
-
-    const { $parent: parent } = node;
-
-    if (parent && is(parent, 'bpmn:SubProcess')) {
-      const error = {
-        message: 'Element of type <bpmn:StartEvent> with event definition of type <bpmn:SignalEventDefinition> not allowed as child of <bpmn:SubProcess>',
-        path: null,
-        data: {
-          type: ERROR_TYPES.CHILD_ELEMENT_TYPE_NOT_ALLOWED,
-          node,
-          parentNode: null,
-          eventDefinition,
-          parent,
-          allowedVersion: '8.3'
-        }
-      };
-
-      reportErrors(node, reporter, error);
-    }
-  }
-
-  return {
-    check
-  };
+const { is } = require('bpmnlint-utils');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { getEventDefinition } = require('../utils/element');
+
+const { ERROR_TYPES } = require('../utils/error-types');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:StartEvent')) {
+      return;
+    }
+
+    const eventDefinition = getEventDefinition(node);
+
+    if (!eventDefinition || !is(eventDefinition, 'bpmn:SignalEventDefinition')) {
+      return;
+    }
+
+    const { $parent: parent } = node;
+
+    if (parent && is(parent, 'bpmn:SubProcess')) {
+      const error = {
+        message: 'Element of type <bpmn:StartEvent> with event definition of type <bpmn:SignalEventDefinition> not allowed as child of <bpmn:SubProcess>',
+        path: null,
+        data: {
+          type: ERROR_TYPES.CHILD_ELEMENT_TYPE_NOT_ALLOWED,
+          node,
+          parentNode: null,
+          eventDefinition,
+          parent,
+          allowedVersion: '8.3'
+        }
+      };
+
+      reportErrors(node, reporter, error);
+    }
+  }
+
+  return {
+    check
+  };
 });

package/rules/camunda-cloud/no-task-schedule.js

@@ -1,19 +1,19 @@
-const { hasNoExtensionElement } = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    const errors = hasNoExtensionElement(node, 'zeebe:TaskSchedule', node, '8.2');
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
+const { hasNoExtensionElement } = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    const errors = hasNoExtensionElement(node, 'zeebe:TaskSchedule', node, '8.2');
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
 });

package/rules/camunda-cloud/no-template.js

@@ -1,24 +1,24 @@
-const { hasProperties } = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    const errors = hasProperties(node, {
-      modelerTemplate: {
-        allowed: false,
-        allowedVersion: '8.0'
-      }
-    }, node);
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
+const { hasProperties } = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    const errors = hasProperties(node, {
+      modelerTemplate: {
+        allowed: false,
+        allowedVersion: '8.0'
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
 });

package/rules/camunda-cloud/no-zeebe-properties.js

@@ -1,19 +1,19 @@
-const { hasNoExtensionElement } = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    const errors = hasNoExtensionElement(node, 'zeebe:Properties', node, '8.1');
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
+const { hasNoExtensionElement } = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    const errors = hasNoExtensionElement(node, 'zeebe:Properties', node, '8.1');
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
 });

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

@@ -1,27 +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
-  };
-});
+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/priority-definition.js

@@ -0,0 +1,62 @@
+const { is } = require('bpmnlint-utils');
+const { isDefined } = require('min-dash');
+
+const {
+  findExtensionElement,
+  hasExpression
+} = 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;
+    }
+
+    const priorityDefinition = findExtensionElement(node, 'zeebe:PriorityDefinition');
+
+    if (!priorityDefinition) {
+      return;
+    }
+
+    const priority = priorityDefinition.get('priority');
+
+    let errors = [];
+
+    if (isDefined(priority)) {
+      errors = [
+        ...errors,
+        ...hasExpression(priorityDefinition, 'priority', {
+          allowed: value => isValidPriority(value)
+        }, node)
+      ];
+    }
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});
+
+function isValidPriority(value) {
+  return isExpression(value) || isIntegerStringBetween(value, 0, 100);
+}
+
+function isExpression(value) {
+  return value.startsWith('=');
+}
+
+function isIntegerStringBetween(value, min, max) {
+  if (/^\d+$/.test(value)) {
+    const number = parseInt(value, 10);
+    return number >= min && number <= max;
+  }
+  return false;
+}