feat: support custom category (#168)

Related to camunda/camunda-modeler#5036

Author: marcellobarile

packages/zeebe-element-templates-json-schema/src/defs/category.json

@@ -0,0 +1,26 @@
+{
+  "$id": "#/category",
+  "type": "object",
+  "description": "A custom category to semantically group element templates",
+  "default": {},
+  "example": {
+    "id": "custom-category",
+    "name": "Custom Category"
+  },
+  "properties": {
+    "id": {
+      "$id": "#/category/id",
+      "type": "string",
+      "description": "The unique identifier of the category."
+    },
+    "name": {
+      "$id": "#/category/name",
+      "type": "string",
+      "description": "The name of the category."
+    }
+  },
+  "required": [
+    "id",
+    "name"
+  ]
+}

packages/zeebe-element-templates-json-schema/src/schema.json

@@ -31,6 +31,9 @@
         "engines": {
           "$ref": "src/defs/engines.json"
         },
+        "category": {
+          "$ref": "src/defs/category.json"
+        },
         "icon": {
           "$ref": "src/defs/icon.json"
         },
@@ -42,7 +45,7 @@
           ]
         },
         "groups": {
-          "$ref": "src/defs/groups.json"  
+          "$ref": "src/defs/groups.json"
         }
       }
     }

packages/zeebe-element-templates-json-schema/test/fixtures/category-only-id.js

@@ -0,0 +1,41 @@
+export const template = {
+  name: 'Category',
+  id: 'example.com.category',
+  appliesTo: [
+    'bpmn:Task'
+  ],
+  properties: [],
+  category: {
+    id: 'my-task'
+  }
+};
+
+export const errors = [
+  {
+    'keyword': 'required',
+    'dataPath': '/category',
+    'schemaPath': '#/properties/category/required',
+    'params': {
+      'missingProperty': 'name'
+    },
+    'message': "should have required property 'name'"
+  },
+  {
+    'keyword': 'type',
+    'dataPath': '',
+    'schemaPath': '#/oneOf/1/type',
+    'params': {
+      'type': 'array'
+    },
+    'message': 'should be array'
+  },
+  {
+    'keyword': 'oneOf',
+    'dataPath': '',
+    'schemaPath': '#/oneOf',
+    'params': {
+      'passingSchemas': null
+    },
+    'message': 'should match exactly one schema in oneOf'
+  }
+];

packages/zeebe-element-templates-json-schema/test/fixtures/category-only-name.js

@@ -0,0 +1,41 @@
+export const template = {
+  name: 'Category',
+  id: 'example.com.category',
+  appliesTo: [
+    'bpmn:Task'
+  ],
+  properties: [],
+  category: {
+    name:  'My task'
+  }
+};
+
+export const errors = [
+  {
+    'keyword': 'required',
+    'dataPath': '/category',
+    'schemaPath': '#/properties/category/required',
+    'params': {
+      'missingProperty': 'id'
+    },
+    'message': "should have required property 'id'"
+  },
+  {
+    'keyword': 'type',
+    'dataPath': '',
+    'schemaPath': '#/oneOf/1/type',
+    'params': {
+      'type': 'array'
+    },
+    'message': 'should be array'
+  },
+  {
+    'keyword': 'oneOf',
+    'dataPath': '',
+    'schemaPath': '#/oneOf',
+    'params': {
+      'passingSchemas': null
+    },
+    'message': 'should match exactly one schema in oneOf'
+  }
+];

packages/zeebe-element-templates-json-schema/test/fixtures/category.js

@@ -0,0 +1,14 @@
+export const template = {
+  name: 'Category',
+  id: 'example.com.category',
+  appliesTo: [
+    'bpmn:Task'
+  ],
+  properties: [],
+  category: {
+    id: 'my-task',
+    name: 'My task'
+  }
+};
+
+export const errors = null;

packages/zeebe-element-templates-json-schema/test/spec/validationSpec.js

@@ -253,6 +253,16 @@ describe('validation', function() {
     });
 
 
+    describe('categories', function() {
+
+      it('category');
+
+      it('category-only-id');
+
+      it('category-only-name');
+    });
+
+
     describe('icons', function() {
 
       it('icon');