@camunda/element-templates-json-schema 0.3.0 → 0.6.0

package/.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Report a problem and help us fix it.
+labels: "bug"
+---
+
+
+__Describe the Bug__
+
+<!-- A clear and concise description of what the bug is. -->
+
+
+__Steps to Reproduce__
+
+<!-- Clear steps that allow us to reproduce the error. -->
+
+1. do this
+2. do that
+3. now this happens
+
+
+__Expected Behavior__
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+
+__Environment__
+
+- Host (Browser/Node version), if applicable: [e.g. MS Edge 18, Chrome 69, Node 10 LTS]
+- OS: [e.g. Windows 7]
+- Library version: [e.g. 0.3.0]

package/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,25 @@
+---
+name: Feature request
+about: Suggest an idea or general improvement.
+labels: "enhancement"
+---
+
+
+__Is your feature request related to a problem? Please describe__
+
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --->
+
+
+__Describe the solution you'd like__
+
+<!-- A clear and concise description of what you want to happen. -->
+
+
+__Describe alternatives you've considered__
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+
+__Additional context__
+
+<!-- Add any other context or screenshots about the feature request here. -->

package/.github/ISSUE_TEMPLATE/TASK.md

@@ -0,0 +1,14 @@
+---
+name: Task
+about: Describe a generic activity we should carry out.
+---
+
+
+__What should we do?__
+
+<!-- Clearly describe the activity we should carry out. -->
+
+
+__Why should we do it?__
+
+<!-- Argue why doing it is a healthy investment of our time. -->

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question
+    url: https://forum.camunda.org/c/modeler
+    about: Head over to our community forum to ask questions and get answers.

package/CHANGELOG.md

@@ -6,6 +6,32 @@ All notable changes to [element-templates-json-schema](https://github.com/camund
 
 ___Note:__ Yet to be released changes appear here._
 
+## 0.6.0
+
+* `FEAT`: add `groups` schema ([#39](https://github.com/camunda/element-templates-json-schema/pull/39))
+
+## 0.5.0
+
+* `FEAT`: remove deprecated `scopes_old`
+* `FEAT`: remove type `Object` from `template#entriesVisible`
+
+### BREAKING CHANGES
+
+* `template#scopes` takes an Array as the only valid type. Wrap your `scopes` object in an Array and add `type` to migrate.
+* `template#entriesVisible` can now be only of type `Boolean`. Make sure to adjust your templates.
+
+## 0.4.0
+
+* `FEAT`: support `camunda:in` and `camunda:out` bindings for specific `target`, `source` or `sourceExpression` given `local` scope ([d0e9d2b](https://github.com/camunda/element-templates-json-schema/commit/d0e9d2b5d75a9f36366125b08065db26ec409fa9))
+
+## 0.3.1
+
+* `FIX`: set `minLength` and `maxLength` properties as numbers ([#24](https://github.com/camunda/element-templates-json-schema/issues/24))
+* `FIX`: adjust various error messages to be more explicit ([#27](https://github.com/camunda/element-templates-json-schema/pull/27))
+* `FIX`: allow `entriesVisible` property to be boolean ([`81043941`](https://github.com/camunda/element-templates-json-schema/commit/81043941441b7e682b09ca99aabedadfba8f622f))
+* `FIX`: allow `pattern` property to be string ([`65370578`](https://github.com/camunda/element-templates-json-schema/commit/653705786c4b7499a1aa15c3e6463815f8744fa2))
+* `CHORE`: make schema compatible with `ajv@7` ([`5630ef53`](https://github.com/camunda/element-templates-json-schema/commit/5630ef5362857667adbdd43ab3fa15cd5d648406))
+
 ## 0.3.0
 
 * `FEAT`: support multiple templates as a single entity ([#15](https://github.com/camunda/element-templates-json-schema/issues/15))
@@ -22,4 +48,4 @@ ___Note:__ Yet to be released changes appear here._
 
 ## 0.1.0
 
-* `FEAT`: initial version :tada:
+* `FEAT`: initial version :tada:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camunda/element-templates-json-schema",
-  "version": "0.3.0",
+  "version": "0.6.0",
   "description": "JSON Schema for (Camunda) Element Templates",
   "scripts": {
     "lint": "eslint .",
@@ -24,13 +24,13 @@
   },
   "homepage": "https://github.com/camunda/element-templates-json-schema#readme",
   "devDependencies": {
-    "ajv": "^6.12.5",
-    "ajv-errors": "^1.0.1",
-    "chai": "^4.2.0",
-    "eslint": "^7.9.0",
-    "eslint-plugin-bpmn-io": "^0.11.0",
+    "ajv": "^7.2.3",
+    "ajv-errors": "^2.0.1",
+    "chai": "^4.3.4",
+    "eslint": "^7.22.0",
+    "eslint-plugin-bpmn-io": "^0.13.0",
     "esm": "^3.2.25",
-    "mocha": "^8.1.3",
+    "mocha": "^8.3.2",
     "npm-run-all": "^4.1.5"
   }
 }

package/resources/schema.json

@@ -18,6 +18,11 @@
         "required": [
           "binding"
         ],
+        "errorMessage": {
+          "required": {
+            "binding": "missing binding for property \"${0#}\""
+          }
+        },
         "allOf": [
           {
             "if": {
@@ -94,7 +99,7 @@
                   "enum": [
                     "Hidden"
                   ],
-                  "errorMessage": "invalid property type ${0} for binding type \"camunda:executionListener\"; must be \"Hidden\""
+                  "errorMessage": "invalid property type ${1/type} for binding type \"camunda:executionListener\"; must be \"Hidden\""
                 }
               }
             }
@@ -298,7 +303,7 @@
                   ]
                 },
                 "then": {
-                  "oneOf": [
+                  "anyOf": [
                     {
                       "required": [
                         "variables"
@@ -310,7 +315,7 @@
                       ]
                     }
                   ],
-                  "errorMessage": "property.binding ${0/type} requires variables or target"
+                  "errorMessage": "property.binding ${0/type} requires variables, target, or both"
                 }
               },
               {
@@ -329,20 +334,84 @@
                     {
                       "required": [
                         "variables"
-                      ]
+                      ],
+                      "not": {
+                        "anyOf": [
+                          {
+                            "required": [
+                              "source"
+                            ]
+                          },
+                          {
+                            "required": [
+                              "sourceExpression"
+                            ]
+                          }
+                        ]
+                      }
                     },
                     {
                       "required": [
                         "source"
-                      ]
+                      ],
+                      "not": {
+                        "anyOf": [
+                          {
+                            "required": [
+                              "variables"
+                            ]
+                          },
+                          {
+                            "required": [
+                              "sourceExpression"
+                            ]
+                          }
+                        ]
+                      }
                     },
                     {
                       "required": [
                         "sourceExpression"
-                      ]
+                      ],
+                      "not": {
+                        "anyOf": [
+                          {
+                            "required": [
+                              "variables"
+                            ]
+                          },
+                          {
+                            "required": [
+                              "source"
+                            ]
+                          }
+                        ]
+                      }
+                    },
+                    {
+                      "required": [
+                        "variables",
+                        "sourceExpression"
+                      ],
+                      "not": {
+                        "required": [
+                          "source"
+                        ]
+                      }
+                    },
+                    {
+                      "required": [
+                        "variables",
+                        "source"
+                      ],
+                      "not": {
+                        "required": [
+                          "sourceExpression"
+                        ]
+                      }
                     }
                   ],
-                  "errorMessage": "property.binding ${0/type} requires variables, sourceExpression or source"
+                  "errorMessage": "property.binding ${0/type} requires one of the following: variables, sourceExpression, source, (sourceExpression and variables), or (source and variables)"
                 }
               },
               {
@@ -385,7 +454,7 @@
                   "camunda:field",
                   "camunda:errorEventDefinition"
                 ],
-                "errorMessage": "invalid property.binding type ${0}; must be any of { property, camunda:property, camunda:inputParameter, camunda:outputParameter, camunda:in, camunda:out, camunda:in:businessKey, camunda:executionListener, camunda:field }",
+                "errorMessage": "invalid property.binding type ${0}; must be any of { property, camunda:property, camunda:inputParameter, camunda:outputParameter, camunda:in, camunda:out, camunda:in:businessKey, camunda:executionListener, camunda:field, camunda:errorEventDefinition }",
                 "description": "The type of the property binding"
               },
               "name": {
@@ -456,60 +525,50 @@
               },
               "minLength": {
                 "$id": "#/properties/property/constraints/minLength",
-                "type": "string",
+                "type": "number",
                 "title": "property constraints min length",
                 "description": "The minimal length for the control field value"
               },
               "maxLength": {
                 "$id": "#/properties/property/constraints/maxLength",
-                "type": "string",
+                "type": "number",
                 "title": "property constraints max length",
                 "description": "The maximal length for the control field value"
               },
               "pattern": {
                 "$id": "#/properties/property/constraints/pattern",
-                "type": "object",
                 "title": "property constraints pattern",
                 "description": "A regular expression pattern for the constraints",
-                "properties": {
-                  "value": {
-                    "$id": "#/properties/property/constraints/pattern/value",
-                    "type": "string",
-                    "title": "property constraints pattern value",
-                    "description": "The regular expression of the pattern constraint"
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "properties": {
+                      "value": {
+                        "$id": "#/properties/property/constraints/pattern/value",
+                        "type": "string",
+                        "title": "property constraints pattern value",
+                        "description": "The regular expression of the pattern constraint"
+                      },
+                      "message": {
+                        "$id": "#/properties/property/constraints/pattern/message",
+                        "type": "string",
+                        "title": "property constraints pattern message",
+                        "description": "The validation message of the pattern constraint"
+                      }
+                    }
                   },
-                  "message": {
-                    "$id": "#/properties/property/constraints/pattern/message",
-                    "type": "string",
-                    "title": "property constraints pattern message",
-                    "description": "The validation message of the pattern constraint"
+                  {
+                    "type": "string"
                   }
-                }
+                ]
               }
             }
-          }
-        }
-      }
-    },
-    "scopes_old":  {
-      "$id": "#/definitions/scopes_old",
-      "type": "object",
-      "title": "element template scope",
-      "deprecated": true,
-      "description": "@Deprecated - Special scoped bindings that allow you to configure nested elements",
-      "additionalProperties": false,
-      "errorMessage": {
-        "additionalProperties": "invalid scope, object descriptor is only supported for camunda:Connector"
-      },
-      "properties": {
-        "camunda:Connector": {
-          "type": "object",
-          "title": "element template scoped connector binding",
-          "description": "A scoped binding for a camunda connector inside the element",
-          "properties": {
-            "properties": {
-              "$ref": "#/definitions/properties"
-            }
+          },
+          "group": {
+            "$id": "#/properties/property/group",
+            "type": "string",
+            "title": "property group",
+            "description": "The custom group of the control field for the property"
           }
         }
       }
@@ -542,6 +601,12 @@
           "type",
           "properties"
         ],
+        "errorMessage": {
+          "required": {
+            "type": "invalid scope, missing type",
+            "properties": "invalid scope ${0/type}, missing properties=[]"
+          }
+        },
         "allOf": [
           {
             "if": {
@@ -560,7 +625,7 @@
               "required": [
                 "id"
               ],
-              "errorMessage": "scoped binding of type ${0/type} requires id"
+              "errorMessage": "invalid scope ${0/type}, missing id"
             }
           }
         ]
@@ -614,7 +679,10 @@
           "items": {
             "$id": "#/appliesTo/items",
             "type": "string",
-            "pattern": "^(bpmn:)"
+            "pattern": "^(.*?:)",
+            "errorMessage": {
+              "pattern": "invalid item for \"appliesTo\", should contain namespaced property, example: \"bpmn:Task\""
+            }
           }
         },
         "properties": {
@@ -628,21 +696,60 @@
           "description": "Some metadata for further configuration"
         },
         "scopes": {
-          "oneOf": [
-            {
-              "$ref": "#/definitions/scopes_old"
-            },
-            {
-              "$ref": "#/definitions/scopes"
-            }
-          ]
+          "$ref": "#/definitions/scopes",
+          "$id": "#/scopes"
         },
         "entriesVisible": {
           "$id": "#/entriesVisible",
-          "deprecated": true,
-          "type": "object",
+          "type": "boolean",
           "title": "element template entries visible",
-          "description": "@Deprecated - Select which entries are visible in the properties panel"
+          "description": "Select whether non-template entries are visible in the properties panel"
+        },
+        "groups": {
+          "$id": "#/groups",
+          "type": "array",
+          "title": "element template properties groups",
+          "description": "The custom defined groups of the element template",
+          "default": [],
+          "items": {
+            "$id": "#/groups/group",
+            "type": "object",
+            "title": "element template group",
+            "description": "A custom defined group for the element template",
+            "default": {},
+            "required": [
+              "id",
+              "label"
+            ],
+            "errorMessage": {
+              "required": {
+                "id": "missing id for group \"${0#}\"",
+                "label": "missing label for group \"${0#}\""
+              }
+            },
+            "properties": {
+              "id": {
+                "$id": "#/groups/group/id",
+                "type": "string",
+                "title": "group id",
+                "description": "The id of the custom group"
+              },
+              "label": {
+                "$id": "#/groups/group/label",
+                "type": "string",
+                "title": "group label",
+                "description": "The label of the custom group"
+              }
+            }
+          }
+        }
+      },
+      "errorMessage": {
+        "required": {
+          "name": "missing template name",
+          "id": "missing template id",
+          "appliesTo": "missing appliesTo=[]",
+          "properties": "missing properties=[]"
         }
       }
     }