bpmnlint-plugin-camunda-compat 2.51.0 → 2.52.0

package/index.js

@@ -113,7 +113,8 @@ const camundaCloud88Rules = withConfig({
 }, { version: '8.8' });
 
 const camundaCloud89Rules = withConfig({
-  ...camundaCloud88Rules
+  ...camundaCloud88Rules,
+  'start-event-form-embedded': 'warn'
 }, { version: '8.9' });
 
 const camundaCloud810Rules = withConfig({
@@ -213,6 +214,7 @@ const rules = {
   'sequence-flow-condition': './rules/camunda-cloud/sequence-flow-condition',
   'signal-reference': './rules/camunda-cloud/signal-reference',
   'start-event-form': './rules/camunda-cloud/start-event-form',
+  'start-event-form-embedded': './rules/camunda-cloud/start-event-form-embedded',
   'subscription': './rules/camunda-cloud/subscription',
   'task-listener': './rules/camunda-cloud/task-listener',
   'task-schedule': './rules/camunda-cloud/task-schedule',

package/package.json

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

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

@@ -0,0 +1,50 @@
+const { is } = require('bpmnlint-utils');
+
+const { findExtensionElement } = require('../utils/element');
+
+const { getPath } = require('@bpmn-io/moddle-utils');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+const { ERROR_TYPES } = require('../utils/error-types');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!node || !is(node, 'bpmn:StartEvent')) {
+      return;
+    }
+
+    const formDefinition = findExtensionElement(node, 'zeebe:FormDefinition');
+
+    if (!formDefinition) {
+      return;
+    }
+
+    const formKey = formDefinition.get('formKey');
+
+    if (!formKey || !formKey.startsWith('camunda-forms:bpmn:')) {
+      return;
+    }
+
+    const errors = [
+      {
+        message: 'Embedded forms on start events are deprecated; use a linked form instead',
+        path: getPath(formDefinition, node),
+        data: {
+          type: ERROR_TYPES.PROPERTY_DEPRECATED,
+          node: formDefinition,
+          parentNode: node,
+          property: 'formKey'
+        }
+      }
+    ];
+
+    reportErrors(node, reporter, errors);
+  }
+
+  return {
+    check
+  };
+});

package/rules/utils/error-types.js

@@ -17,6 +17,7 @@ module.exports.ERROR_TYPES = Object.freeze({
   ATTACHED_TO_REF_ELEMENT_TYPE_NOT_ALLOWED: 'camunda.attachedToRefElementTypeNotAllowed',
   PROPERTY_DEPENDENT_REQUIRED: 'camunda.propertyDependentRequired',
   PROPERTY_NOT_ALLOWED: 'camunda.propertyNotAllowed',
+  PROPERTY_DEPRECATED: 'camunda.propertyDeprecated',
   PROPERTY_REQUIRED: 'camunda.propertyRequired',
   PROPERTY_TYPE_NOT_ALLOWED: 'camunda.propertyTypeNotAllowed',
   PROPERTY_VALUE_DUPLICATED: 'camunda.propertyValueDuplicated',