bpmnlint-plugin-camunda-compat 2.35.0 → 2.36.0

package/package.json

@@ -1,53 +1,53 @@
-{
-  "name": "bpmnlint-plugin-camunda-compat",
-  "version": "2.35.0",
-  "description": "A bpmnlint plug-in for Camunda compatibility",
-  "main": "index.js",
-  "scripts": {
-    "all": "npm run lint && npm test",
-    "dev": "npm run test:watch",
-    "lint": "eslint .",
-    "test": "mocha 'test/**/*.spec.js'",
-    "test:watch": "npm run test -- --watch"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/camunda/bpmnlint-plugin-camunda-compat"
-  },
-  "keywords": [
-    "bpmnlint",
-    "plugin"
-  ],
-  "author": {
-    "name": "Philipp Fromme",
-    "url": "https://github.com/philippfromme"
-  },
-  "license": "MIT",
-  "devDependencies": {
-    "bpmn-moddle": "^9.0.1",
-    "bpmnlint": "^11.2.0",
-    "camunda-bpmn-moddle": "^7.0.1",
-    "chai": "^4.4.1",
-    "eslint": "^9.20.1",
-    "eslint-plugin-bpmn-io": "^2.2.0",
-    "mocha": "^10.2.0",
-    "modeler-moddle": "^0.2.0",
-    "sinon": "^17.0.1",
-    "sinon-chai": "^3.7.0",
-    "zeebe-bpmn-moddle": "^1.9.0"
-  },
-  "dependencies": {
-    "@bpmn-io/feel-lint": "^1.4.0",
-    "@bpmn-io/moddle-utils": "^0.2.1",
-    "bpmnlint-utils": "^1.1.1",
-    "min-dash": "^4.1.1",
-    "semver-compare": "^1.0.0"
-  },
-  "files": [
-    "rules",
-    "index.js"
-  ],
-  "engines": {
-    "node": ">= 20"
-  }
-}
+{
+  "name": "bpmnlint-plugin-camunda-compat",
+  "version": "2.36.0",
+  "description": "A bpmnlint plug-in for Camunda compatibility",
+  "main": "index.js",
+  "scripts": {
+    "all": "npm run lint && npm test",
+    "dev": "npm run test:watch",
+    "lint": "eslint .",
+    "test": "mocha 'test/**/*.spec.js'",
+    "test:watch": "npm run test -- --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/camunda/bpmnlint-plugin-camunda-compat"
+  },
+  "keywords": [
+    "bpmnlint",
+    "plugin"
+  ],
+  "author": {
+    "name": "Philipp Fromme",
+    "url": "https://github.com/philippfromme"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "bpmn-moddle": "^9.0.1",
+    "bpmnlint": "^11.6.0",
+    "camunda-bpmn-moddle": "^7.0.1",
+    "chai": "^4.4.1",
+    "eslint": "^9.20.1",
+    "eslint-plugin-bpmn-io": "^2.2.0",
+    "mocha": "^10.2.0",
+    "modeler-moddle": "^0.2.0",
+    "sinon": "^17.0.1",
+    "sinon-chai": "^3.7.0",
+    "zeebe-bpmn-moddle": "^1.9.0"
+  },
+  "dependencies": {
+    "@bpmn-io/feel-lint": "^1.4.0",
+    "@bpmn-io/moddle-utils": "^0.2.1",
+    "bpmnlint-utils": "^1.1.1",
+    "min-dash": "^4.1.1",
+    "semver-compare": "^1.0.0"
+  },
+  "files": [
+    "rules",
+    "index.js"
+  ],
+  "engines": {
+    "node": ">= 20"
+  }
+}

package/rules/camunda-cloud/ad-hoc-sub-process.js

@@ -1,60 +1,60 @@
-const { is } = require('bpmnlint-utils');
-
-const {
-  ERROR_TYPES,
-  hasProperties
-} = require('../utils/element');
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-const { greaterOrEqual } = require('../utils/version');
-
-const COMPLETION_ALLOWED_VERSION = '8.8';
-
-module.exports = skipInNonExecutableProcess(function({ version }) {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:AdHocSubProcess')) {
-      return;
-    }
-
-    const errors = [];
-
-    // ad-hoc sub-process must contain at least one activity
-    if (!node.get('flowElements').some(isActivity)) {
-      errors.push({
-        message: 'Element of type <bpmn:AdHocSubProcess> must contain at least one activity',
-        data: {
-          type: ERROR_TYPES.CHILD_ELEMENT_OF_TYPE_REQUIRED,
-          node,
-          parentNode: null,
-          requiredType: 'bpmn:Activity'
-        }
-      });
-    }
-
-    if (!greaterOrEqual(version, COMPLETION_ALLOWED_VERSION)) {
-      errors.push(...hasProperties(node, {
-        completionCondition: {
-          allowed: false,
-          allowedVersion: COMPLETION_ALLOWED_VERSION
-        },
-        cancelRemainingInstances: {
-          allowed: value => value !== false, // only allow true which is default value
-          allowedVersion: COMPLETION_ALLOWED_VERSION
-        }
-      }, node));
-    }
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
-});
-
-function isActivity(element) {
-  return is(element, 'bpmn:Activity');
-}
+const { is } = require('bpmnlint-utils');
+
+const {
+  ERROR_TYPES,
+  hasProperties
+} = require('../utils/element');
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+const { greaterOrEqual } = require('../utils/version');
+
+const COMPLETION_ALLOWED_VERSION = '8.8';
+
+module.exports = skipInNonExecutableProcess(function({ version }) {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:AdHocSubProcess')) {
+      return;
+    }
+
+    const errors = [];
+
+    // ad-hoc sub-process must contain at least one activity
+    if (!node.get('flowElements').some(isActivity)) {
+      errors.push({
+        message: 'Element of type <bpmn:AdHocSubProcess> must contain at least one activity',
+        data: {
+          type: ERROR_TYPES.CHILD_ELEMENT_OF_TYPE_REQUIRED,
+          node,
+          parentNode: null,
+          requiredType: 'bpmn:Activity'
+        }
+      });
+    }
+
+    if (!greaterOrEqual(version, COMPLETION_ALLOWED_VERSION)) {
+      errors.push(...hasProperties(node, {
+        completionCondition: {
+          allowed: false,
+          allowedVersion: COMPLETION_ALLOWED_VERSION
+        },
+        cancelRemainingInstances: {
+          allowed: value => value !== false, // only allow true which is default value
+          allowedVersion: COMPLETION_ALLOWED_VERSION
+        }
+      }, node));
+    }
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});
+
+function isActivity(element) {
+  return is(element, 'bpmn:Activity');
+}

package/rules/camunda-cloud/called-element.js

@@ -1,45 +1,45 @@
-const { is } = require('bpmnlint-utils');
-
-const {
-  findExtensionElement,
-  hasExtensionElement,
-  hasProperties
-} = require('../utils/element');
-
-const { annotateRule } = require('../helper');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:CallActivity')) {
-      return;
-    }
-
-    let errors = hasExtensionElement(node, 'zeebe:CalledElement', node);
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
-
-      return;
-    }
-
-    const calledElement = findExtensionElement(node, 'zeebe:CalledElement');
-
-    errors = hasProperties(calledElement, {
-      processId: {
-        required: true
-      }
-    }, node);
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return annotateRule('called-element', {
-    check
-  });
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  hasExtensionElement,
+  hasProperties
+} = require('../utils/element');
+
+const { annotateRule } = require('../helper');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:CallActivity')) {
+      return;
+    }
+
+    let errors = hasExtensionElement(node, 'zeebe:CalledElement', node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+
+      return;
+    }
+
+    const calledElement = findExtensionElement(node, 'zeebe:CalledElement');
+
+    errors = hasProperties(calledElement, {
+      processId: {
+        required: true
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return annotateRule('called-element', {
+    check
+  });
 });

package/rules/camunda-cloud/collapsed-subprocess.js

@@ -1,40 +1,40 @@
-const { is } = require('bpmnlint-utils');
-
-const { ERROR_TYPES } = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(di, reporter) {
-
-    if (!isCollapsedSubProcess(di)) {
-      return;
-    }
-
-    const node = di.bpmnElement;
-
-    const error = {
-      message: `A <${ node.$type }> must be expanded`,
-      data: {
-        type: ERROR_TYPES.ELEMENT_COLLAPSED_NOT_ALLOWED,
-        node: node,
-        parentNode: null,
-        allowedVersion: '8.4'
-      }
-    };
-
-    reportErrors(node, reporter, error);
-  }
-
-  return {
-    check
-  };
-});
-
-function isCollapsedSubProcess(di) {
-  return is(di, 'bpmndi:BPMNShape') &&
-         is(di.get('bpmnElement'), 'bpmn:SubProcess') &&
-         di.get('isExpanded') !== true;
-}
+const { is } = require('bpmnlint-utils');
+
+const { ERROR_TYPES } = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(di, reporter) {
+
+    if (!isCollapsedSubProcess(di)) {
+      return;
+    }
+
+    const node = di.bpmnElement;
+
+    const error = {
+      message: `A <${ node.$type }> must be expanded`,
+      data: {
+        type: ERROR_TYPES.ELEMENT_COLLAPSED_NOT_ALLOWED,
+        node: node,
+        parentNode: null,
+        allowedVersion: '8.4'
+      }
+    };
+
+    reportErrors(node, reporter, error);
+  }
+
+  return {
+    check
+  };
+});
+
+function isCollapsedSubProcess(di) {
+  return is(di, 'bpmndi:BPMNShape') &&
+         is(di.get('bpmnElement'), 'bpmn:SubProcess') &&
+         di.get('isExpanded') !== true;
+}

package/rules/camunda-cloud/connector-properties/config.js

@@ -1,91 +1,91 @@
-const { getPath } = require('@bpmn-io/moddle-utils');
-
-const { findExtensionElement } = require('../../utils/element');
-
-const { ERROR_TYPES } = require('../../utils/error-types');
-
-const INBOUND_CONNECTOR_PROPERTY = 'inbound.type';
-
-module.exports = {
-  messageTtl: {
-    version: '8.6',
-    getError: (node) => getInboundConnectorError(node, 'messageTtl', '8.6'),
-    getProperty: (node) => getZeebeProperty(node, 'messageTtl'),
-    isConnector: (node) => isInboundConnector(node, [
-      'io.camunda:webhook:1',
-      'io.camunda:connector-rabbitmq-inbound:1',
-      'io.camunda:http-polling:1',
-      'io.camunda:connector-kafka-inbound:1',
-      'io.camunda:slack-webhook:1',
-      'io.camunda:aws-sqs-inbound:1',
-      'io.camunda:aws-sns-webhook:1'
-    ])
-  },
-  consumeUnmatchedEvents: {
-    version: '8.6',
-    getError: (node) => getInboundConnectorError(node, 'consumeUnmatchedEvents', '8.6'),
-    getProperty: (node) => getZeebeProperty(node, 'consumeUnmatchedEvents'),
-    isConnector: (node) => isInboundConnector(node, [
-      'io.camunda:webhook:1',
-      'io.camunda:connector-rabbitmq-inbound:1',
-      'io.camunda:http-polling:1',
-      'io.camunda:connector-kafka-inbound:1',
-      'io.camunda:slack-webhook:1',
-      'io.camunda:aws-sqs-inbound:1',
-      'io.camunda:aws-sns-webhook:1'
-    ])
-  },
-  deduplicationModeManualFlag: {
-    version: '8.6',
-    getError: (node) => getInboundConnectorError(node, 'deduplicationModeManualFlag', '8.6'),
-    getProperty: (node) => getZeebeProperty(node, 'deduplicationModeManualFlag'),
-    isConnector: (node) => isInboundConnector(node, [
-      'io.camunda:connector-rabbitmq-inbound:1',
-      'io.camunda:http-polling:1',
-      'io.camunda:connector-kafka-inbound:1',
-      'io.camunda:aws-sqs-inbound:1'
-    ])
-  }
-};
-
-function isInboundConnector(node, names) {
-  const zeebeProperty = getZeebeProperty(node, INBOUND_CONNECTOR_PROPERTY);
-
-  return zeebeProperty && names.includes(zeebeProperty.get('value'));
-}
-
-function getZeebeProperty(node, propertyName) {
-  const zeebeProperties = findExtensionElement(node, 'zeebe:Properties');
-
-  if (!zeebeProperties) {
-    return false;
-  }
-
-  return zeebeProperties.get('properties').find(property => {
-    return property.get('name') === propertyName;
-  });
-}
-
-function getInboundConnectorError(node, propertyName, allowedVersion) {
-  const property = getZeebeProperty(node, propertyName);
-
-  const connectorProperty = getZeebeProperty(node, INBOUND_CONNECTOR_PROPERTY);
-
-  const path = getPath(property, node);
-
-  return {
-    message: `Connector property <name> with value <${ propertyName }> only allowed by Camunda ${ allowedVersion } or newer.`,
-    path: path ? [ ...path, 'name' ] : [ 'name' ],
-    data: {
-      type: ERROR_TYPES.CONNECTORS_PROPERTY_VALUE_NOT_ALLOWED,
-      node: property,
-      parentNode: node,
-      property: 'name',
-      allowedVersion,
-      connectorProperty: {
-        node: connectorProperty,
-        properties: [ 'name', 'value' ]
-      }
-    }
-  };
+const { getPath } = require('@bpmn-io/moddle-utils');
+
+const { findExtensionElement } = require('../../utils/element');
+
+const { ERROR_TYPES } = require('../../utils/error-types');
+
+const INBOUND_CONNECTOR_PROPERTY = 'inbound.type';
+
+module.exports = {
+  messageTtl: {
+    version: '8.6',
+    getError: (node) => getInboundConnectorError(node, 'messageTtl', '8.6'),
+    getProperty: (node) => getZeebeProperty(node, 'messageTtl'),
+    isConnector: (node) => isInboundConnector(node, [
+      'io.camunda:webhook:1',
+      'io.camunda:connector-rabbitmq-inbound:1',
+      'io.camunda:http-polling:1',
+      'io.camunda:connector-kafka-inbound:1',
+      'io.camunda:slack-webhook:1',
+      'io.camunda:aws-sqs-inbound:1',
+      'io.camunda:aws-sns-webhook:1'
+    ])
+  },
+  consumeUnmatchedEvents: {
+    version: '8.6',
+    getError: (node) => getInboundConnectorError(node, 'consumeUnmatchedEvents', '8.6'),
+    getProperty: (node) => getZeebeProperty(node, 'consumeUnmatchedEvents'),
+    isConnector: (node) => isInboundConnector(node, [
+      'io.camunda:webhook:1',
+      'io.camunda:connector-rabbitmq-inbound:1',
+      'io.camunda:http-polling:1',
+      'io.camunda:connector-kafka-inbound:1',
+      'io.camunda:slack-webhook:1',
+      'io.camunda:aws-sqs-inbound:1',
+      'io.camunda:aws-sns-webhook:1'
+    ])
+  },
+  deduplicationModeManualFlag: {
+    version: '8.6',
+    getError: (node) => getInboundConnectorError(node, 'deduplicationModeManualFlag', '8.6'),
+    getProperty: (node) => getZeebeProperty(node, 'deduplicationModeManualFlag'),
+    isConnector: (node) => isInboundConnector(node, [
+      'io.camunda:connector-rabbitmq-inbound:1',
+      'io.camunda:http-polling:1',
+      'io.camunda:connector-kafka-inbound:1',
+      'io.camunda:aws-sqs-inbound:1'
+    ])
+  }
+};
+
+function isInboundConnector(node, names) {
+  const zeebeProperty = getZeebeProperty(node, INBOUND_CONNECTOR_PROPERTY);
+
+  return zeebeProperty && names.includes(zeebeProperty.get('value'));
+}
+
+function getZeebeProperty(node, propertyName) {
+  const zeebeProperties = findExtensionElement(node, 'zeebe:Properties');
+
+  if (!zeebeProperties) {
+    return false;
+  }
+
+  return zeebeProperties.get('properties').find(property => {
+    return property.get('name') === propertyName;
+  });
+}
+
+function getInboundConnectorError(node, propertyName, allowedVersion) {
+  const property = getZeebeProperty(node, propertyName);
+
+  const connectorProperty = getZeebeProperty(node, INBOUND_CONNECTOR_PROPERTY);
+
+  const path = getPath(property, node);
+
+  return {
+    message: `Connector property <name> with value <${ propertyName }> only allowed by Camunda ${ allowedVersion } or newer.`,
+    path: path ? [ ...path, 'name' ] : [ 'name' ],
+    data: {
+      type: ERROR_TYPES.CONNECTORS_PROPERTY_VALUE_NOT_ALLOWED,
+      node: property,
+      parentNode: node,
+      property: 'name',
+      allowedVersion,
+      connectorProperty: {
+        node: connectorProperty,
+        properties: [ 'name', 'value' ]
+      }
+    }
+  };
 }

package/rules/camunda-cloud/connector-properties/index.js

@@ -1,47 +1,47 @@
-const { isAny } = require('bpmnlint-utils');
-
-const config = require('./config');
-
-const { reportErrors } = require('../../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../../utils/rule');
-
-const { greaterOrEqual } = require('../../utils/version');
-
-module.exports = skipInNonExecutableProcess(function({ version }) {
-  function check(node, reporter) {
-    if (!isAny(node, [ 'bpmn:FlowElement', 'bpmn:FlowElementsContainer' ])) {
-      return;
-    }
-
-    const errors = Object.entries(config).reduce((errors, [ propertyName, {
-      getError,
-      getProperty,
-      isConnector,
-      version: allowedVersion
-    } ]) => {
-      if (greaterOrEqual(version, allowedVersion) || !isConnector(node)) {
-        return errors;
-      }
-
-      const property = getProperty(node);
-
-      if (property) {
-        return [
-          ...errors,
-          getError(node)
-        ];
-      }
-
-      return errors;
-    }, []);
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
-});
+const { isAny } = require('bpmnlint-utils');
+
+const config = require('./config');
+
+const { reportErrors } = require('../../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../../utils/rule');
+
+const { greaterOrEqual } = require('../../utils/version');
+
+module.exports = skipInNonExecutableProcess(function({ version }) {
+  function check(node, reporter) {
+    if (!isAny(node, [ 'bpmn:FlowElement', 'bpmn:FlowElementsContainer' ])) {
+      return;
+    }
+
+    const errors = Object.entries(config).reduce((errors, [ propertyName, {
+      getError,
+      getProperty,
+      isConnector,
+      version: allowedVersion
+    } ]) => {
+      if (greaterOrEqual(version, allowedVersion) || !isConnector(node)) {
+        return errors;
+      }
+
+      const property = getProperty(node);
+
+      if (property) {
+        return [
+          ...errors,
+          getError(node)
+        ];
+      }
+
+      return errors;
+    }, []);
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});