bpmnlint-plugin-camunda-compat 2.26.1 → 2.27.0

package/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2021-present bpmn.io Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+The MIT License (MIT)
+
+Copyright (c) 2021-present bpmn.io Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.

package/README.md

@@ -1,39 +1,39 @@
-# bpmnlint-plugin-camunda-compat
-
-[![CI](https://github.com/camunda/bpmnlint-plugin-camunda-compat/workflows/CI/badge.svg)](https://github.com/camunda/bpmnlint-plugin-camunda-compat/actions?query=workflow%3ACI)
-
-A [bpmnlint](https://github.com/bpmn-io/bpmnlint) plug-in that checks whether a given BPMN process can be executed with [Camunda](https://camunda.com/).
-
-
-## Usage
-
-Add configuration corresponding to your execution platform and version to your [`.bpmnlintrc` configuration](https://github.com/bpmn-io/bpmnlint#configuration):
-
-```json
-{
-  "extends": [
-    "bpmnlint:recommended",
-    "plugin:camunda-compat/camunda-cloud-8-0"
-  ],
-  "rules": {
-    "camunda-compat/timer": "off"
-  }
-}
-```
-
-Use [`@camunda/linting`](https://github.com/camunda/linting) to configure the linter dynamically based on the [execution platform and version](https://github.com/camunda/modeler-moddle).
-
-
-## Resources
-
-* [Issues](https://github.com/camunda/bpmnlint-plugin-camunda-compat/issues)
-
-
-## Related
-
-* BPMN coverage for [Camunda 8](https://docs.camunda.io/docs/reference/bpmn-processes/bpmn-coverage/) and [Camunda 7](https://docs.camunda.org/manual/latest/reference/bpmn20/)
-
-
-## License
-
-MIT
+# bpmnlint-plugin-camunda-compat
+
+[![CI](https://github.com/camunda/bpmnlint-plugin-camunda-compat/workflows/CI/badge.svg)](https://github.com/camunda/bpmnlint-plugin-camunda-compat/actions?query=workflow%3ACI)
+
+A [bpmnlint](https://github.com/bpmn-io/bpmnlint) plug-in that checks whether a given BPMN process can be executed with [Camunda](https://camunda.com/).
+
+
+## Usage
+
+Add configuration corresponding to your execution platform and version to your [`.bpmnlintrc` configuration](https://github.com/bpmn-io/bpmnlint#configuration):
+
+```json
+{
+  "extends": [
+    "bpmnlint:recommended",
+    "plugin:camunda-compat/camunda-cloud-8-0"
+  ],
+  "rules": {
+    "camunda-compat/timer": "off"
+  }
+}
+```
+
+Use [`@camunda/linting`](https://github.com/camunda/linting) to configure the linter dynamically based on the [execution platform and version](https://github.com/camunda/modeler-moddle).
+
+
+## Resources
+
+* [Issues](https://github.com/camunda/bpmnlint-plugin-camunda-compat/issues)
+
+
+## Related
+
+* BPMN coverage for [Camunda 8](https://docs.camunda.io/docs/reference/bpmn-processes/bpmn-coverage/) and [Camunda 7](https://docs.camunda.org/manual/latest/reference/bpmn20/)
+
+
+## License
+
+MIT

package/index.js

@@ -93,6 +93,11 @@ const camundaCloud86Rules = withConfig({
   'version-tag': 'error'
 }, { version: '8.6' });
 
+const camundaCloud87Rules = withConfig({
+  ...camundaCloud86Rules,
+  'zeebe-user-task': 'error'
+}, { version: '8.7' });
+
 const camundaPlatform719Rules = withConfig({
   'history-time-to-live': 'info'
 }, {
@@ -115,6 +120,11 @@ const camundaPlatform722Rules = withConfig(camundaPlatform721Rules, {
   version: '7.22'
 });
 
+const camundaPlatform723Rules = withConfig(camundaPlatform721Rules, {
+  platform: 'camunda-platform',
+  version: '7.23'
+});
+
 const rules = {
   'element-type': './rules/camunda-cloud/element-type',
   'called-element': './rules/camunda-cloud/called-element',
@@ -160,7 +170,8 @@ const rules = {
   'user-task-definition': './rules/camunda-cloud/user-task-definition',
   'user-task-form': './rules/camunda-cloud/user-task-form',
   'version-tag': './rules/camunda-cloud/version-tag',
-  'wait-for-completion': './rules/camunda-cloud/wait-for-completion'
+  'wait-for-completion': './rules/camunda-cloud/wait-for-completion',
+  'zeebe-user-task': './rules/camunda-cloud/zeebe-user-task'
 };
 
 const configs = {
@@ -197,6 +208,9 @@ const configs = {
   'camunda-cloud-8-6': {
     rules: camundaCloud86Rules
   },
+  'camunda-cloud-8-7': {
+    rules: camundaCloud87Rules
+  },
   'camunda-platform-7-19': {
     rules: camundaPlatform719Rules
   },
@@ -208,6 +222,9 @@ const configs = {
   },
   'camunda-platform-7-22': {
     rules: camundaPlatform722Rules
+  },
+  'camunda-platform-7-23': {
+    rules: camundaPlatform723Rules
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "2.26.1",
+  "version": "2.27.0",
   "description": "A bpmnlint plug-in for Camunda compatibility",
   "main": "index.js",
   "scripts": {

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

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