bpmnlint-plugin-camunda-compat 2.18.0 → 2.20.0

package/package.json

@@ -1,53 +1,53 @@
-{
-  "name": "bpmnlint-plugin-camunda-compat",
-  "version": "2.18.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": "^8.1.0",
-    "bpmnlint": "^10.2.0",
-    "camunda-bpmn-moddle": "^7.0.1",
-    "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": "^17.0.1",
-    "sinon-chai": "^3.7.0",
-    "zeebe-bpmn-moddle": "^1.1.0"
-  },
-  "dependencies": {
-    "@bpmn-io/feel-lint": "^1.2.0",
-    "@bpmn-io/moddle-utils": "^0.2.1",
-    "bpmnlint-utils": "^1.0.2",
-    "min-dash": "^4.1.1",
-    "semver-compare": "^1.0.0"
-  },
-  "files": [
-    "rules",
-    "index.js"
-  ],
-  "engines": {
-    "node": "*"
-  }
-}
+{
+  "name": "bpmnlint-plugin-camunda-compat",
+  "version": "2.20.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": "^8.1.0",
+    "bpmnlint": "^10.2.0",
+    "camunda-bpmn-moddle": "^7.0.1",
+    "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": "^17.0.1",
+    "sinon-chai": "^3.7.0",
+    "zeebe-bpmn-moddle": "^1.1.0"
+  },
+  "dependencies": {
+    "@bpmn-io/feel-lint": "^1.2.0",
+    "@bpmn-io/moddle-utils": "^0.2.1",
+    "bpmnlint-utils": "^1.0.2",
+    "min-dash": "^4.1.1",
+    "semver-compare": "^1.0.0"
+  },
+  "files": [
+    "rules",
+    "index.js"
+  ],
+  "engines": {
+    "node": "*"
+  }
+}

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

@@ -1,43 +1,43 @@
-const { is } = require('bpmnlint-utils');
-
-const {
-  findExtensionElement,
-  hasExtensionElement,
-  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;
-    }
-
-    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 {
-    check
-  };
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  hasExtensionElement,
+  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;
+    }
+
+    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 {
+    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

@@ -0,0 +1,93 @@
+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',
+      connectorProperty: {
+        type: connectorProperty,
+        properties: {
+          name: connectorProperty.get('name'),
+          value: connectorProperty.get('value')
+        }
+      }
+    }
+  };
+}

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

@@ -0,0 +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
+  };
+});

package/rules/camunda-cloud/duplicate-task-headers.js

@@ -1,59 +1,59 @@
-const {
-  is,
-  isAny
-} = require('bpmnlint-utils');
-
-const {
-  findExtensionElement,
-  getMessageEventDefinition,
-  hasDuplicatedPropertyValues
-} = 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') && !isZeebeServiceTask(node)) {
-      return;
-    }
-
-    const taskHeaders = findExtensionElement(node, 'zeebe:TaskHeaders');
-
-    if (!taskHeaders) {
-      return;
-    }
-
-    const errors = hasDuplicatedPropertyValues(taskHeaders, 'values', 'key', node);
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
-});
-
-// helpers //////////
-
-function isZeebeServiceTask(element) {
-  if (is(element, 'zeebe:ZeebeServiceTask')) {
-    return true;
-  }
-
-  if (isAny(element, [
-    'bpmn:EndEvent',
-    'bpmn:IntermediateThrowEvent'
-  ])) {
-    return getMessageEventDefinition(element);
-  }
-
-  if (is(element, 'bpmn:BusinessRuleTask')) {
-    return findExtensionElement(element, 'zeebe:TaskDefinition');
-  }
-
-  return false;
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  getMessageEventDefinition,
+  hasDuplicatedPropertyValues
+} = 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') && !isZeebeServiceTask(node)) {
+      return;
+    }
+
+    const taskHeaders = findExtensionElement(node, 'zeebe:TaskHeaders');
+
+    if (!taskHeaders) {
+      return;
+    }
+
+    const errors = hasDuplicatedPropertyValues(taskHeaders, 'values', 'key', node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});
+
+// helpers //////////
+
+function isZeebeServiceTask(element) {
+  if (is(element, 'zeebe:ZeebeServiceTask')) {
+    return true;
+  }
+
+  if (isAny(element, [
+    'bpmn:EndEvent',
+    'bpmn:IntermediateThrowEvent'
+  ])) {
+    return getMessageEventDefinition(element);
+  }
+
+  if (is(element, 'bpmn:BusinessRuleTask')) {
+    return findExtensionElement(element, 'zeebe:TaskDefinition');
+  }
+
+  return false;
 }

package/rules/camunda-cloud/element-type/config.js

@@ -1,67 +1,67 @@
-module.exports = {
-  'bpmn:Association': '1.0',
-  'bpmn:BoundaryEvent': {
-    'bpmn:CompensateEventDefinition': '8.5',
-    'bpmn:ErrorEventDefinition': '1.0',
-    'bpmn:EscalationEventDefinition': '8.2',
-    'bpmn:MessageEventDefinition': '1.0',
-    'bpmn:TimerEventDefinition': '1.0',
-    'bpmn:SignalEventDefinition': '8.3',
-  },
-  'bpmn:BusinessRuleTask': '1.1',
-  'bpmn:CallActivity': '1.0',
-  'bpmn:Collaboration': '1.0',
-  'bpmn:DataObject': '8.0',
-  'bpmn:DataObjectReference': '8.0',
-  'bpmn:DataStoreReference': '8.0',
-  'bpmn:Definitions': '1.0',
-  'bpmn:EndEvent': {
-    '_': '1.0',
-    'bpmn:CompensateEventDefinition': '8.5',
-    'bpmn:ErrorEventDefinition': '1.0',
-    'bpmn:EscalationEventDefinition': '8.2',
-    'bpmn:MessageEventDefinition': '1.2',
-    'bpmn:SignalEventDefinition': '8.3',
-    'bpmn:TerminateEventDefinition': '8.1'
-  },
-  'bpmn:EventBasedGateway': '1.0',
-  'bpmn:ExclusiveGateway': '1.0',
-  'bpmn:Group': '1.0',
-  'bpmn:InclusiveGateway': '8.1',
-  'bpmn:IntermediateCatchEvent': {
-    'bpmn:MessageEventDefinition': '1.0',
-    'bpmn:LinkEventDefinition': '8.2',
-    'bpmn:TimerEventDefinition': '1.0',
-    'bpmn:SignalEventDefinition': '8.3'
-  },
-  'bpmn:IntermediateThrowEvent': {
-    '_': '1.1',
-    'bpmn:CompensateEventDefinition': '8.5',
-    'bpmn:EscalationEventDefinition': '8.2',
-    'bpmn:LinkEventDefinition': '8.2',
-    'bpmn:MessageEventDefinition': '1.2',
-    'bpmn:SignalEventDefinition': '8.3'
-  },
-  'bpmn:ManualTask': '1.1',
-  'bpmn:MessageFlow': '1.0',
-  'bpmn:ParallelGateway': '1.0',
-  'bpmn:Participant': '1.0',
-  'bpmn:Process': '1.0',
-  'bpmn:ReceiveTask': '1.0',
-  'bpmn:ScriptTask': '1.1',
-  'bpmn:SendTask': '1.1',
-  'bpmn:SequenceFlow': '1.0',
-  'bpmn:ServiceTask': '1.0',
-  'bpmn:StartEvent': {
-    '_': '1.0',
-    'bpmn:ErrorEventDefinition': '1.0',
-    'bpmn:EscalationEventDefinition': '8.2',
-    'bpmn:MessageEventDefinition': '1.0',
-    'bpmn:SignalEventDefinition': '8.2',
-    'bpmn:TimerEventDefinition': '1.0'
-  },
-  'bpmn:SubProcess': '1.0',
-  'bpmn:Task': '8.2',
-  'bpmn:TextAnnotation': '1.0',
-  'bpmn:UserTask': '1.0'
+module.exports = {
+  'bpmn:Association': '1.0',
+  'bpmn:BoundaryEvent': {
+    'bpmn:CompensateEventDefinition': '8.5',
+    'bpmn:ErrorEventDefinition': '1.0',
+    'bpmn:EscalationEventDefinition': '8.2',
+    'bpmn:MessageEventDefinition': '1.0',
+    'bpmn:TimerEventDefinition': '1.0',
+    'bpmn:SignalEventDefinition': '8.3',
+  },
+  'bpmn:BusinessRuleTask': '1.1',
+  'bpmn:CallActivity': '1.0',
+  'bpmn:Collaboration': '1.0',
+  'bpmn:DataObject': '8.0',
+  'bpmn:DataObjectReference': '8.0',
+  'bpmn:DataStoreReference': '8.0',
+  'bpmn:Definitions': '1.0',
+  'bpmn:EndEvent': {
+    '_': '1.0',
+    'bpmn:CompensateEventDefinition': '8.5',
+    'bpmn:ErrorEventDefinition': '1.0',
+    'bpmn:EscalationEventDefinition': '8.2',
+    'bpmn:MessageEventDefinition': '1.2',
+    'bpmn:SignalEventDefinition': '8.3',
+    'bpmn:TerminateEventDefinition': '8.1'
+  },
+  'bpmn:EventBasedGateway': '1.0',
+  'bpmn:ExclusiveGateway': '1.0',
+  'bpmn:Group': '1.0',
+  'bpmn:InclusiveGateway': '8.1',
+  'bpmn:IntermediateCatchEvent': {
+    'bpmn:MessageEventDefinition': '1.0',
+    'bpmn:LinkEventDefinition': '8.2',
+    'bpmn:TimerEventDefinition': '1.0',
+    'bpmn:SignalEventDefinition': '8.3'
+  },
+  'bpmn:IntermediateThrowEvent': {
+    '_': '1.1',
+    'bpmn:CompensateEventDefinition': '8.5',
+    'bpmn:EscalationEventDefinition': '8.2',
+    'bpmn:LinkEventDefinition': '8.2',
+    'bpmn:MessageEventDefinition': '1.2',
+    'bpmn:SignalEventDefinition': '8.3'
+  },
+  'bpmn:ManualTask': '1.1',
+  'bpmn:MessageFlow': '1.0',
+  'bpmn:ParallelGateway': '1.0',
+  'bpmn:Participant': '1.0',
+  'bpmn:Process': '1.0',
+  'bpmn:ReceiveTask': '1.0',
+  'bpmn:ScriptTask': '1.1',
+  'bpmn:SendTask': '1.1',
+  'bpmn:SequenceFlow': '1.0',
+  'bpmn:ServiceTask': '1.0',
+  'bpmn:StartEvent': {
+    '_': '1.0',
+    'bpmn:ErrorEventDefinition': '1.0',
+    'bpmn:EscalationEventDefinition': '8.2',
+    'bpmn:MessageEventDefinition': '1.0',
+    'bpmn:SignalEventDefinition': '8.2',
+    'bpmn:TimerEventDefinition': '1.0'
+  },
+  'bpmn:SubProcess': '1.0',
+  'bpmn:Task': '8.2',
+  'bpmn:TextAnnotation': '1.0',
+  'bpmn:UserTask': '1.0'
 };