fix(zeebe): require "feel":"optional/static" for Boolean/Number I/O

philippfromme · philippfromme · commit 703c30a75a9e · 2025-01-23T17:53:28.000+01:00
diff --git a/packages/zeebe-element-templates-json-schema/src/defs/properties.json b/packages/zeebe-element-templates-json-schema/src/defs/properties.json
@@ -340,7 +340,7 @@
               "required": ["feel"],
               "properties": {
                 "feel": {
-                  "const": "static"
+                  "enum": [ "optional", "static" ]
                 }
               }
             }
diff --git a/packages/zeebe-element-templates-json-schema/test/fixtures/invalid-zeebe-input-feel.js b/packages/zeebe-element-templates-json-schema/test/fixtures/invalid-zeebe-input-feel.js
@@ -6,20 +6,38 @@ export const template = {
   ],
   'properties': [
     {
-      'label': 'booleanValid',
+      'label': 'booleanValidOptional',
       'type': 'Boolean',
       'binding': {
         'type': 'zeebe:input',
-        'name': 'booleanValid'
+        'name': 'booleanValidOptional'
+      },
+      'feel': 'optional'
+    },
+    {
+      'label': 'numberValidOptional',
+      'type': 'Number',
+      'binding': {
+        'type': 'zeebe:input',
+        'name': 'numberValidOptional'
+      },
+      'feel': 'optional'
+    },
+    {
+      'label': 'booleanValidStatic',
+      'type': 'Boolean',
+      'binding': {
+        'type': 'zeebe:input',
+        'name': 'booleanValidStatic'
       },
       'feel': 'static'
     },
     {
-      'label': 'numberValid',
+      'label': 'numberValidStatic',
       'type': 'Number',
       'binding': {
         'type': 'zeebe:input',
-        'name': 'numberValid'
+        'name': 'numberValidStatic'
       },
       'feel': 'static'
     },
@@ -62,7 +80,7 @@ export const template = {
 
 export const errors = [
   {
-    'dataPath': '/properties/2',
+    'dataPath': '/properties/4',
     'keyword': 'required',
     'message': 'should have required property \'feel\'',
     'params': {
@@ -71,7 +89,7 @@ export const errors = [
     'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/required'
   },
   {
-    'dataPath': '/properties/2',
+    'dataPath': '/properties/4',
     'keyword': 'if',
     'message': 'should match "then" schema',
     'params': {
@@ -80,7 +98,7 @@ export const errors = [
     'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/if'
   },
   {
-    'dataPath': '/properties/3',
+    'dataPath': '/properties/5',
     'keyword': 'required',
     'message': 'should have required property \'feel\'',
     'params': {
@@ -89,7 +107,7 @@ export const errors = [
     'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/required'
   },
   {
-    'dataPath': '/properties/3',
+    'dataPath': '/properties/5',
     'keyword': 'if',
     'message': 'should match "then" schema',
     'params': {
@@ -98,16 +116,19 @@ export const errors = [
     'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/if'
   },
   {
-    'dataPath': '/properties/4/feel',
-    'keyword': 'const',
-    'message': 'should be equal to constant',
+    'dataPath': '/properties/6/feel',
+    'keyword': 'enum',
+    'message': 'should be equal to one of the allowed values',
     'params': {
-      'allowedValue': 'static'
+      'allowedValues': [
+        'optional',
+        'static'
+      ]
     },
-    'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/properties/feel/const'
+    'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/properties/feel/enum'
   },
   {
-    'dataPath': '/properties/4',
+    'dataPath': '/properties/6',
     'keyword': 'if',
     'message': 'should match "then" schema',
     'params': {
@@ -116,16 +137,19 @@ export const errors = [
     'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/if'
   },
   {
-    'dataPath': '/properties/5/feel',
-    'keyword': 'const',
-    'message': 'should be equal to constant',
+    'dataPath': '/properties/7/feel',
+    'keyword': 'enum',
+    'message': 'should be equal to one of the allowed values',
     'params': {
-      'allowedValue': 'static'
+      'allowedValues': [
+        'optional',
+        'static'
+      ]
     },
-    'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/properties/feel/const'
+    'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/properties/feel/enum'
   },
   {
-    'dataPath': '/properties/5',
+    'dataPath': '/properties/7',
     'keyword': 'if',
     'message': 'should match "then" schema',
     'params': {
diff --git a/packages/zeebe-element-templates-json-schema/test/fixtures/invalid-zeebe-output-feel.js b/packages/zeebe-element-templates-json-schema/test/fixtures/invalid-zeebe-output-feel.js
@@ -6,20 +6,38 @@ export const template = {
   ],
   'properties': [
     {
-      'label': 'booleanValid',
+      'label': 'booleanValidOptional',
       'type': 'Boolean',
       'binding': {
         'type': 'zeebe:output',
-        'source': 'booleanValid'
+        'source': 'booleanValidOptional'
+      },
+      'feel': 'optional'
+    },
+    {
+      'label': 'numberValidOptional',
+      'type': 'Number',
+      'binding': {
+        'type': 'zeebe:output',
+        'source': 'numberValidOptional'
+      },
+      'feel': 'optional'
+    },
+    {
+      'label': 'booleanValidStatic',
+      'type': 'Boolean',
+      'binding': {
+        'type': 'zeebe:output',
+        'source': 'booleanValidStatic'
       },
       'feel': 'static'
     },
     {
-      'label': 'numberValid',
+      'label': 'numberValidStatic',
       'type': 'Number',
       'binding': {
         'type': 'zeebe:output',
-        'source': 'numberValid'
+        'source': 'numberValidStatic'
       },
       'feel': 'static'
     },
@@ -62,7 +80,7 @@ export const template = {
 
 export const errors = [
   {
-    'dataPath': '/properties/2',
+    'dataPath': '/properties/4',
     'keyword': 'required',
     'message': 'should have required property \'feel\'',
     'params': {
@@ -71,7 +89,7 @@ export const errors = [
     'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/required'
   },
   {
-    'dataPath': '/properties/2',
+    'dataPath': '/properties/4',
     'keyword': 'if',
     'message': 'should match "then" schema',
     'params': {
@@ -80,7 +98,7 @@ export const errors = [
     'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/if'
   },
   {
-    'dataPath': '/properties/3',
+    'dataPath': '/properties/5',
     'keyword': 'required',
     'message': 'should have required property \'feel\'',
     'params': {
@@ -89,7 +107,7 @@ export const errors = [
     'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/required'
   },
   {
-    'dataPath': '/properties/3',
+    'dataPath': '/properties/5',
     'keyword': 'if',
     'message': 'should match "then" schema',
     'params': {
@@ -98,16 +116,19 @@ export const errors = [
     'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/if'
   },
   {
-    'dataPath': '/properties/4/feel',
-    'keyword': 'const',
-    'message': 'should be equal to constant',
+    'dataPath': '/properties/6/feel',
+    'keyword': 'enum',
+    'message': 'should be equal to one of the allowed values',
     'params': {
-      'allowedValue': 'static'
+      'allowedValues': [
+        'optional',
+        'static'
+      ]
     },
-    'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/properties/feel/const'
+    'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/properties/feel/enum'
   },
   {
-    'dataPath': '/properties/4',
+    'dataPath': '/properties/6',
     'keyword': 'if',
     'message': 'should match "then" schema',
     'params': {
@@ -116,16 +137,19 @@ export const errors = [
     'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/if'
   },
   {
-    'dataPath': '/properties/5/feel',
-    'keyword': 'const',
-    'message': 'should be equal to constant',
+    'dataPath': '/properties/7/feel',
+    'keyword': 'enum',
+    'message': 'should be equal to one of the allowed values',
     'params': {
-      'allowedValue': 'static'
+      'allowedValues': [
+        'optional',
+        'static'
+      ]
     },
-    'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/properties/feel/const'
+    'schemaPath': '#/allOf/1/items/allOf/11/allOf/0/then/properties/feel/enum'
   },
   {
-    'dataPath': '/properties/5',
+    'dataPath': '/properties/7',
     'keyword': 'if',
     'message': 'should match "then" schema',
     'params': {

Original file line number	Diff line number	Diff line change
`@@ -340,7 +340,7 @@`
`340`	`340`	`"required": ["feel"],`
`341`	`341`	`"properties": {`
`342`	`342`	`"feel": {`
`343`		`- "const": "static"`
	`343`	`+ "enum": [ "optional", "static" ]`
`344`	`344`	`}`
`345`	`345`	`}`
`346`	`346`	`}`