@camunda/element-templates-json-schema-shared 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to [@camunda/element-templates-json-schema-shared](https://github.com/camunda/element-templates-json-schema/packages/element-templates-json-schema-shared) are documented here. We use [semantic versioning](http://semver.org/) for releases.
+
+## Unreleased
+
+___Note:__ Yet to be released changes appear here._
+
+
+## 0.1.0
+
+* `FEAT`: initial version :tada:

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 camunda Services GmbH
+
+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

@@ -0,0 +1,8 @@
+# @camunda/element-templates-json-schema-shared
+
+Shared schema definitions used within [element-templates-json-schema](https://github.com/camunda/element-templates-json-schema).
+
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@camunda/element-templates-json-schema-shared",
+  "version": "0.1.0",
+  "description": "Shared schema definitions used within element-templates-json-schema",
+  "files": [
+    "src"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/camunda/element-templates-json-schema.git",
+    "directory": "packages/element-templates-json-schema-shared"
+  },
+  "keywords": [
+    "json-schema",
+    "element-templates",
+    "camunda"
+  ],
+  "license": "MIT"
+}

package/src/defs/base-properties.json

@@ -0,0 +1,155 @@
+{
+  "type": "array",
+  "title": "element template properties",
+  "description": "The properties of the element template",
+  "default": [],
+  "items": {
+    "type": "object",
+    "title": "element template property",
+    "description": "A property defined for the element template",
+    "default": {},
+    "allOf": [
+      {
+        "if": {
+          "properties": {
+            "type": {
+              "const": "Dropdown"
+            }
+          },
+          "required": [
+            "type"
+          ]
+        },
+        "then": {
+          "required": [
+            "choices"
+          ],
+          "errorMessage": "must provide choices=[] with \"Dropdown\" type"
+        }
+      }
+    ],
+    "properties": {
+      "value": {
+        "$id": "#/properties/property/value",
+        "type": [
+          "string",
+          "boolean"
+        ],
+        "title": "property value",
+        "description": "The value of the control field for the property"
+      },
+      "description": {
+        "$id": "#/properties/property/description",
+        "type": "string",
+        "title": "property description",
+        "description": "The description of the control field"
+      },
+      "label": {
+        "$id": "#/properties/property/label",
+        "type": "string",
+        "title": "property label",
+        "description": "The label of the control field for the property"
+      },
+      "type": {
+        "$id": "#/properties/property/type",
+        "type": "string",
+        "title": "property type",
+        "description": "The type of the control field"
+      },
+      "editable": {
+        "$id": "#/properties/property/editable",
+        "type": "boolean",
+        "title": "property editable",
+        "description": "Indicates whether the property is editable or not"
+      },
+      "choices": {
+        "$id": "#/properties/property/choices",
+        "type": "array",
+        "title": "property choices",
+        "description": "The choices for dropdown properties",
+        "items": {
+          "$id": "#/properties/property/choices/item",
+          "type": "object",
+          "properties": {
+            "name": {
+              "$id": "#/properties/property/choices/item/name",
+              "type": "string",
+              "title": "choice name",
+              "description": "The name of the choice"
+            },
+            "value": {
+              "$id": "#/properties/property/choices/item/value",
+              "type": "string",
+              "title": "choice value",
+              "description": "The value of the choice"
+            }
+          },
+          "required": [
+            "value",
+            "name"
+          ],
+          "errorMessage": "{ name, value } must be specified for \"Dropdown\" choices"
+        }
+      },
+      "constraints": {
+        "$id": "#/properties/property/constraints",
+        "type": "object",
+        "title": "property constraints",
+        "description": "The validation constraints",
+        "properties": {
+          "notEmpty": {
+            "$id": "#/properties/property/constraints/notEmpty",
+            "type": "boolean",
+            "title": "property constraints not empty",
+            "description": "The control field must not be empty"
+          },
+          "minLength": {
+            "$id": "#/properties/property/constraints/minLength",
+            "type": "number",
+            "title": "property constraints min length",
+            "description": "The minimal length for the control field value"
+          },
+          "maxLength": {
+            "$id": "#/properties/property/constraints/maxLength",
+            "type": "number",
+            "title": "property constraints max length",
+            "description": "The maximal length for the control field value"
+          },
+          "pattern": {
+            "$id": "#/properties/property/constraints/pattern",
+            "title": "property constraints pattern",
+            "description": "A regular expression pattern for the constraints",
+            "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"
+                  }
+                }
+              },
+              {
+                "type": "string"
+              }
+            ]
+          }
+        }
+      },
+      "group": {
+        "$id": "#/properties/property/group",
+        "type": "string",
+        "title": "property group",
+        "description": "The custom group of the control field for the property"
+      }
+    }
+  }
+}

package/src/defs/base.json

@@ -0,0 +1,78 @@
+{
+  "required": [
+    "name",
+    "id",
+    "appliesTo",
+    "properties"
+  ],
+  "properties": {
+    "name": {
+      "$id": "#/name",
+      "type": "string",
+      "title": "element template name",
+      "description": "The name of the element template"
+    },
+    "id": {
+      "$id": "#/id",
+      "type": "string",
+      "title": "element template id",
+      "description": "The identifier of the element template"
+    },
+    "description": {
+      "$id": "#/description",
+      "type": "string",
+      "title": "element template description",
+      "description": "The description of the element template"
+    },
+    "version": {
+      "$id": "#/version",
+      "type": "number",
+      "title": "element template version",
+      "description": "The version of the element template"
+    },
+    "isDefault": {
+      "$id": "#/isDefault",
+      "type": "boolean",
+      "title": "element template is default",
+      "description": "Indicates whether the element template is a default template"
+    },
+    "appliesTo": {
+      "$id": "#/appliesTo",
+      "type": "array",
+      "title": "element template applies to",
+      "description": "The definition for which element types the element template can be applied",
+      "default": [],
+      "items": {
+        "$id": "#/appliesTo/items",
+        "type": "string",
+        "pattern": "^(.*?:)",
+        "errorMessage": {
+          "pattern": "invalid item for \"appliesTo\", should contain namespaced property, example: \"bpmn:Task\""
+        }
+      }
+    },
+    "metadata": {
+      "$id": "#/metadata",
+      "type": "object",
+      "title": "element template metadata",
+      "description": "Some metadata for further configuration"
+    },
+    "entriesVisible": {
+      "$id": "#/entriesVisible",
+      "type": "boolean",
+      "title": "element template entries visible",
+      "description": "Select whether non-template entries are visible in the properties panel"
+    },
+    "groups": {
+      "$ref": "groups.json"
+    }
+  },
+  "errorMessage": {
+    "required": {
+      "name": "missing template name",
+      "id": "missing template id",
+      "appliesTo": "missing appliesTo=[]",
+      "properties": "missing properties=[]"
+    }
+  }
+}

package/src/defs/groups.json

@@ -0,0 +1,38 @@
+{
+  "$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"
+      }
+    }
+  }
+}