bpmnlint-plugin-camunda-compat 2.23.0 → 2.24.0

package/rules/camunda-cloud/secrets.js

@@ -1,119 +1,119 @@
-const { isString } = require('min-dash');
-
-const { is } = require('bpmnlint-utils');
-
-const { getPath } = require('@bpmn-io/moddle-utils');
-
-const {
-  findExtensionElement,
-  getEventDefinition
-} = require('../utils/element');
-
-const { ERROR_TYPES } = require('../utils/error-types');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    const errors = [
-      validateIoMapping,
-      validateProperties,
-      validateSubscription
-    ].reduce((errors, validationFunction) => {
-      return [
-        ...errors,
-        ...validationFunction(node)
-      ];
-    }, []);
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
-});
-
-function validateIoMapping(node) {
-  const ioMapping = findExtensionElement(node, 'zeebe:IoMapping');
-
-  if (!ioMapping) {
-    return [];
-  }
-
-  return ioMapping.get('inputParameters')
-    .filter(inputParameter => !isValidSecret(inputParameter.get('source')))
-    .map(inputParameter => getReport('source', inputParameter, node));
-}
-
-function validateProperties(node) {
-  const properties = findExtensionElement(node, 'zeebe:Properties');
-
-  if (!properties) {
-    return [];
-  }
-
-  return (properties.get('properties'))
-    .filter(property => !isValidSecret(property.get('value')))
-    .map(property => getReport('value', property, node));
-}
-
-function validateSubscription(node) {
-  let message;
-
-  if (is(node, 'bpmn:ReceiveTask')) {
-    message = node.get('messageRef');
-  } else {
-    const messageEventDefinition = getEventDefinition(node, 'bpmn:MessageEventDefinition');
-
-    if (!messageEventDefinition) {
-      return [];
-    }
-
-    message = messageEventDefinition.get('messageRef');
-  }
-
-  if (!message) {
-    return [];
-  }
-
-  const subscription = findExtensionElement(message, 'zeebe:Subscription');
-
-  if (!subscription) {
-    return [];
-  }
-
-  const correlationKey = subscription.get('correlationKey');
-
-  return isValidSecret(correlationKey)
-    ? []
-    : [ getReport('correlationKey', subscription, node) ];
-}
-
-function getReport(propertyName, node, parentNode) {
-  const path = getPath(node, parentNode);
-
-  return {
-    message: `Property <${ propertyName }> uses deprecated secret expression format`,
-    path: path
-      ? [ ...getPath(node, parentNode), propertyName ]
-      : [ propertyName ],
-    data: {
-      type: ERROR_TYPES.SECRET_EXPRESSION_FORMAT_DEPRECATED,
-      node,
-      parentNode: parentNode,
-      property: propertyName
-    }
-  };
-}
-
-function isValidSecret(value) {
-  return !value
-    || !isString(value)
-    || !value.includes('secrets.')
-    || /{{\s*secrets\.[\w-]+\s*}}/.test(value);
-}
+const { isString } = require('min-dash');
+
+const { is } = require('bpmnlint-utils');
+
+const { getPath } = require('@bpmn-io/moddle-utils');
+
+const {
+  findExtensionElement,
+  getEventDefinition
+} = require('../utils/element');
+
+const { ERROR_TYPES } = require('../utils/error-types');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    const errors = [
+      validateIoMapping,
+      validateProperties,
+      validateSubscription
+    ].reduce((errors, validationFunction) => {
+      return [
+        ...errors,
+        ...validationFunction(node)
+      ];
+    }, []);
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});
+
+function validateIoMapping(node) {
+  const ioMapping = findExtensionElement(node, 'zeebe:IoMapping');
+
+  if (!ioMapping) {
+    return [];
+  }
+
+  return ioMapping.get('inputParameters')
+    .filter(inputParameter => !isValidSecret(inputParameter.get('source')))
+    .map(inputParameter => getReport('source', inputParameter, node));
+}
+
+function validateProperties(node) {
+  const properties = findExtensionElement(node, 'zeebe:Properties');
+
+  if (!properties) {
+    return [];
+  }
+
+  return (properties.get('properties'))
+    .filter(property => !isValidSecret(property.get('value')))
+    .map(property => getReport('value', property, node));
+}
+
+function validateSubscription(node) {
+  let message;
+
+  if (is(node, 'bpmn:ReceiveTask')) {
+    message = node.get('messageRef');
+  } else {
+    const messageEventDefinition = getEventDefinition(node, 'bpmn:MessageEventDefinition');
+
+    if (!messageEventDefinition) {
+      return [];
+    }
+
+    message = messageEventDefinition.get('messageRef');
+  }
+
+  if (!message) {
+    return [];
+  }
+
+  const subscription = findExtensionElement(message, 'zeebe:Subscription');
+
+  if (!subscription) {
+    return [];
+  }
+
+  const correlationKey = subscription.get('correlationKey');
+
+  return isValidSecret(correlationKey)
+    ? []
+    : [ getReport('correlationKey', subscription, node) ];
+}
+
+function getReport(propertyName, node, parentNode) {
+  const path = getPath(node, parentNode);
+
+  return {
+    message: `Property <${ propertyName }> uses deprecated secret expression format`,
+    path: path
+      ? [ ...getPath(node, parentNode), propertyName ]
+      : [ propertyName ],
+    data: {
+      type: ERROR_TYPES.SECRET_EXPRESSION_FORMAT_DEPRECATED,
+      node,
+      parentNode: parentNode,
+      property: propertyName
+    }
+  };
+}
+
+function isValidSecret(value) {
+  return !value
+    || !isString(value)
+    || !value.includes('secrets.')
+    || /{{\s*secrets\.[\w-]+\s*}}/.test(value);
+}

package/rules/camunda-cloud/sequence-flow-condition.js

@@ -1,57 +1,57 @@
-const {
-  is,
-  isAny
-} = require('bpmnlint-utils');
-
-const {
-  ERROR_TYPES,
-  hasProperties
-} = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (isAny(node, [ 'bpmn:ExclusiveGateway', 'bpmn:InclusiveGateway' ])) {
-      const outgoing = node.get('outgoing');
-
-      if (outgoing && outgoing.length > 1) {
-        for (let sequenceFlow of outgoing) {
-          if (node.get('default') !== sequenceFlow) {
-            const errors = hasProperties(sequenceFlow, {
-              conditionExpression: {
-                required: true
-              }
-            }, sequenceFlow);
-
-            if (errors.length) {
-              reportErrors(sequenceFlow, reporter, errors);
-            }
-          }
-        }
-      }
-    } else if (is(node, 'bpmn:SequenceFlow')) {
-      const source = node.get('sourceRef'),
-            conditionExpression = node.get('conditionExpression');
-
-      if (!isAny(source, [ 'bpmn:ExclusiveGateway', 'bpmn:InclusiveGateway' ]) && conditionExpression) {
-        reportErrors(node, reporter, {
-          message: 'Property <conditionExpression> only allowed if source is of type <bpmn:ExclusiveGateway> or <bpmn:InclusiveGateway>',
-          path: [ 'conditionExpression' ],
-          data: {
-            type: ERROR_TYPES.PROPERTY_NOT_ALLOWED,
-            node: node,
-            parentNode: null,
-            property: 'conditionExpression'
-          }
-        });
-      }
-    }
-  }
-
-  return {
-    check
-  };
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+const {
+  ERROR_TYPES,
+  hasProperties
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (isAny(node, [ 'bpmn:ExclusiveGateway', 'bpmn:InclusiveGateway' ])) {
+      const outgoing = node.get('outgoing');
+
+      if (outgoing && outgoing.length > 1) {
+        for (let sequenceFlow of outgoing) {
+          if (node.get('default') !== sequenceFlow) {
+            const errors = hasProperties(sequenceFlow, {
+              conditionExpression: {
+                required: true
+              }
+            }, sequenceFlow);
+
+            if (errors.length) {
+              reportErrors(sequenceFlow, reporter, errors);
+            }
+          }
+        }
+      }
+    } else if (is(node, 'bpmn:SequenceFlow')) {
+      const source = node.get('sourceRef'),
+            conditionExpression = node.get('conditionExpression');
+
+      if (!isAny(source, [ 'bpmn:ExclusiveGateway', 'bpmn:InclusiveGateway' ]) && conditionExpression) {
+        reportErrors(node, reporter, {
+          message: 'Property <conditionExpression> only allowed if source is of type <bpmn:ExclusiveGateway> or <bpmn:InclusiveGateway>',
+          path: [ 'conditionExpression' ],
+          data: {
+            type: ERROR_TYPES.PROPERTY_NOT_ALLOWED,
+            node: node,
+            parentNode: null,
+            property: 'conditionExpression'
+          }
+        });
+      }
+    }
+  }
+
+  return {
+    check
+  };
 });

package/rules/camunda-cloud/signal-reference.js

@@ -1,65 +1,65 @@
-const {
-  is,
-  isAny
-} = require('bpmnlint-utils');
-
-const {
-  getEventDefinition,
-  hasProperties
-} = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (!isAny(node, [
-      'bpmn:StartEvent',
-      'bpmn:IntermediateThrowEvent',
-      'bpmn:IntermediateCatchEvent',
-      'bpmn:EndEvent',
-      'bpmn:BoundaryEvent'
-    ])) {
-      return;
-    }
-
-    const eventDefinition = getEventDefinition(node);
-
-    if (!eventDefinition || !is(eventDefinition, 'bpmn:SignalEventDefinition')) {
-      return;
-    }
-
-    let errors = hasProperties(eventDefinition, {
-      signalRef: {
-        required: true
-      }
-    }, node);
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-
-      return;
-    }
-
-    const signalRef = eventDefinition.get('signalRef');
-
-    if (!signalRef) {
-      return;
-    }
-
-    errors = hasProperties(signalRef, {
-      name: {
-        required: true
-      }
-    }, node);
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+const {
+  getEventDefinition,
+  hasProperties
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!isAny(node, [
+      'bpmn:StartEvent',
+      'bpmn:IntermediateThrowEvent',
+      'bpmn:IntermediateCatchEvent',
+      'bpmn:EndEvent',
+      'bpmn:BoundaryEvent'
+    ])) {
+      return;
+    }
+
+    const eventDefinition = getEventDefinition(node);
+
+    if (!eventDefinition || !is(eventDefinition, 'bpmn:SignalEventDefinition')) {
+      return;
+    }
+
+    let errors = hasProperties(eventDefinition, {
+      signalRef: {
+        required: true
+      }
+    }, node);
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+
+      return;
+    }
+
+    const signalRef = eventDefinition.get('signalRef');
+
+    if (!signalRef) {
+      return;
+    }
+
+    errors = hasProperties(signalRef, {
+      name: {
+        required: true
+      }
+    }, node);
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
 });

package/rules/camunda-cloud/start-event-form.js

@@ -1,98 +1,98 @@
-const { is } = require('bpmnlint-utils');
-
-const {
-  findExtensionElement,
-  findExtensionElements,
-  findParent,
-  hasProperties,
-  hasProperty
-} = require('../utils/element');
-
-const { hasNoExtensionElement } = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-const { greaterOrEqual } = require('../utils/version');
-
-const allowedVersion = '8.3';
-
-module.exports = skipInNonExecutableProcess(function({ version }) {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:StartEvent')) {
-      return;
-    }
-
-    // Camunda 8.2 and older
-    if (!greaterOrEqual(version, allowedVersion)) {
-      let errors = hasNoExtensionElement(node, 'zeebe:FormDefinition', node, allowedVersion);
-
-      if (errors.length) {
-        reportErrors(node, reporter, errors);
-      }
-
-      return;
-    }
-
-    // Camunda 8.3 and newer
-    const formDefinition = findExtensionElement(node, 'zeebe:FormDefinition');
-
-    if (!formDefinition) {
-      return;
-    }
-
-    let errors = hasProperty(formDefinition, [
-      'formKey',
-      'formId'
-    ], node);
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-
-      return;
-    }
-
-    const formKey = formDefinition.get('formKey');
-
-    const userTaskForm = findUserTaskForm(node, formKey);
-
-    if (!userTaskForm) {
-      return;
-    }
-
-    errors = hasProperties(userTaskForm, {
-      body: {
-        required: true
-      }
-    }, node);
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
-});
-
-// helpers //////////
-
-function findUserTaskForm(node, formKey) {
-  const process = findParent(node, 'bpmn:Process');
-
-  if (!process) {
-    return;
-  }
-
-  const userTaskForms = findExtensionElements(process, 'zeebe:UserTaskForm');
-
-  if (userTaskForms && userTaskForms.length) {
-    return userTaskForms.find(userTaskForm => {
-      const id = userTaskForm.get('id');
-
-      return `camunda-forms:bpmn:${ id }` === formKey;
-    });
-  }
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  findExtensionElements,
+  findParent,
+  hasProperties,
+  hasProperty
+} = require('../utils/element');
+
+const { hasNoExtensionElement } = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+const { greaterOrEqual } = require('../utils/version');
+
+const allowedVersion = '8.3';
+
+module.exports = skipInNonExecutableProcess(function({ version }) {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:StartEvent')) {
+      return;
+    }
+
+    // Camunda 8.2 and older
+    if (!greaterOrEqual(version, allowedVersion)) {
+      let errors = hasNoExtensionElement(node, 'zeebe:FormDefinition', node, allowedVersion);
+
+      if (errors.length) {
+        reportErrors(node, reporter, errors);
+      }
+
+      return;
+    }
+
+    // Camunda 8.3 and newer
+    const formDefinition = findExtensionElement(node, 'zeebe:FormDefinition');
+
+    if (!formDefinition) {
+      return;
+    }
+
+    let errors = hasProperty(formDefinition, [
+      'formKey',
+      'formId'
+    ], node);
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+
+      return;
+    }
+
+    const formKey = formDefinition.get('formKey');
+
+    const userTaskForm = findUserTaskForm(node, formKey);
+
+    if (!userTaskForm) {
+      return;
+    }
+
+    errors = hasProperties(userTaskForm, {
+      body: {
+        required: true
+      }
+    }, node);
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});
+
+// helpers //////////
+
+function findUserTaskForm(node, formKey) {
+  const process = findParent(node, 'bpmn:Process');
+
+  if (!process) {
+    return;
+  }
+
+  const userTaskForms = findExtensionElements(process, 'zeebe:UserTaskForm');
+
+  if (userTaskForms && userTaskForms.length) {
+    return userTaskForms.find(userTaskForm => {
+      const id = userTaskForm.get('id');
+
+      return `camunda-forms:bpmn:${ id }` === formKey;
+    });
+  }
 }