bpmnlint-plugin-camunda-compat 2.35.0 → 2.36.0

package/rules/camunda-cloud/feel.js

@@ -1,87 +1,87 @@
-const { isString } = require('min-dash');
-
-const {
-  is,
-  isAny
-} = require('bpmnlint-utils');
-
-const { lintExpression } = require('@bpmn-io/feel-lint');
-
-const { getPath } = require('@bpmn-io/moddle-utils');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { ERROR_TYPES } = require('../utils/error-types');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-const { annotateRule } = require('../helper');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (is(node, 'bpmn:Expression')) {
-      return;
-    }
-
-    const parentNode = findParentNode(node);
-
-    if (!parentNode) {
-      return;
-    }
-
-    const errors = [];
-
-    Object.entries(node).forEach(([ propertyName, propertyValue ]) => {
-      if (propertyValue && is(propertyValue, 'bpmn:Expression')) {
-        propertyValue = propertyValue.get('body');
-      }
-
-      if (isFeelProperty([ propertyName, propertyValue ])) {
-        const lintErrors = lintExpression(propertyValue.substring(1));
-
-        // syntax error
-        if (lintErrors.find(({ type }) => type === 'Syntax Error')) {
-          const path = getPath(node, parentNode);
-
-          errors.push(
-            {
-              message: `Property <${ propertyName }> is not a valid FEEL expression`,
-              path: path
-                ? [ ...path, propertyName ]
-                : [ propertyName ],
-              data: {
-                type: ERROR_TYPES.FEEL_EXPRESSION_INVALID,
-                node,
-                parentNode,
-                property: propertyName
-              }
-            }
-          );
-        }
-      }
-    });
-
-    if (errors && errors.length) {
-      reportErrors(parentNode, reporter, errors);
-    }
-  }
-
-  return annotateRule('feel', {
-    check
-  });
-});
-
-const isFeelProperty = ([ propertyName, value ]) => {
-  return !isIgnoredProperty(propertyName) && isString(value) && value.startsWith('=');
-};
-
-const isIgnoredProperty = propertyName => {
-  return propertyName.startsWith('$');
-};
-
-const findParentNode = node => {
-  while (node && !isAny(node, [ 'bpmn:FlowElement', 'bpmn:FlowElementsContainer' ])) {
-    node = node.$parent;
-  }
-
-  return node;
+const { isString } = require('min-dash');
+
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+const { lintExpression } = require('@bpmn-io/feel-lint');
+
+const { getPath } = require('@bpmn-io/moddle-utils');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { ERROR_TYPES } = require('../utils/error-types');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+const { annotateRule } = require('../helper');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (is(node, 'bpmn:Expression')) {
+      return;
+    }
+
+    const parentNode = findParentNode(node);
+
+    if (!parentNode) {
+      return;
+    }
+
+    const errors = [];
+
+    Object.entries(node).forEach(([ propertyName, propertyValue ]) => {
+      if (propertyValue && is(propertyValue, 'bpmn:Expression')) {
+        propertyValue = propertyValue.get('body');
+      }
+
+      if (isFeelProperty([ propertyName, propertyValue ])) {
+        const lintErrors = lintExpression(propertyValue.substring(1));
+
+        // syntax error
+        if (lintErrors.find(({ type }) => type === 'Syntax Error')) {
+          const path = getPath(node, parentNode);
+
+          errors.push(
+            {
+              message: `Property <${ propertyName }> is not a valid FEEL expression`,
+              path: path
+                ? [ ...path, propertyName ]
+                : [ propertyName ],
+              data: {
+                type: ERROR_TYPES.FEEL_EXPRESSION_INVALID,
+                node,
+                parentNode,
+                property: propertyName
+              }
+            }
+          );
+        }
+      }
+    });
+
+    if (errors && errors.length) {
+      reportErrors(parentNode, reporter, errors);
+    }
+  }
+
+  return annotateRule('feel', {
+    check
+  });
+});
+
+const isFeelProperty = ([ propertyName, value ]) => {
+  return !isIgnoredProperty(propertyName) && isString(value) && value.startsWith('=');
+};
+
+const isIgnoredProperty = propertyName => {
+  return propertyName.startsWith('$');
+};
+
+const findParentNode = node => {
+  while (node && !isAny(node, [ 'bpmn:FlowElement', 'bpmn:FlowElementsContainer' ])) {
+    node = node.$parent;
+  }
+
+  return node;
 };

package/rules/camunda-cloud/implementation/config.js

@@ -1,20 +1,20 @@
-module.exports = {
-  calledDecision: {
-    'bpmn:BusinessRuleTask': '1.3'
-  },
-  taskDefinition: {
-    'bpmn:BusinessRuleTask': '1.1',
-    'bpmn:IntermediateThrowEvent': {
-      'bpmn:MessageEventDefinition': '1.2'
-    },
-    'bpmn:EndEvent': {
-      'bpmn:MessageEventDefinition': '1.2'
-    },
-    'bpmn:ScriptTask': '1.1',
-    'bpmn:SendTask': '1.1',
-    'bpmn:ServiceTask': '1.0'
-  },
-  script: {
-    'bpmn:ScriptTask': '8.2'
-  }
+module.exports = {
+  calledDecision: {
+    'bpmn:BusinessRuleTask': '1.3'
+  },
+  taskDefinition: {
+    'bpmn:BusinessRuleTask': '1.1',
+    'bpmn:IntermediateThrowEvent': {
+      'bpmn:MessageEventDefinition': '1.2'
+    },
+    'bpmn:EndEvent': {
+      'bpmn:MessageEventDefinition': '1.2'
+    },
+    'bpmn:ScriptTask': '1.1',
+    'bpmn:SendTask': '1.1',
+    'bpmn:ServiceTask': '1.0'
+  },
+  script: {
+    'bpmn:ScriptTask': '8.2'
+  }
 };

package/rules/camunda-cloud/implementation/index.js

@@ -1,218 +1,218 @@
-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');
-
-const { skipInNonExecutableProcess } = require('../../utils/rule');
-
-module.exports = skipInNonExecutableProcess(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 ${ 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 ${ 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 ${ 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 ];
-}
+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');
+
+const { skipInNonExecutableProcess } = require('../../utils/rule');
+
+module.exports = skipInNonExecutableProcess(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 ${ 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 ${ 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 ${ 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 ];
+}