@cyberismo/assets 0.0.11 → 0.0.13

package/src/schema/csvSchema.json

@@ -1,8 +1,6 @@
 {
-  "title": "Csv content",
   "$id": "csvSchema",
   "description": "Contains the content of a CSV file as an array of objects. Each object represents a row in the CSV file.",
-  "type": "array",
   "items": {
     "type": "object",
     "additionalProperties": true,
@@ -14,7 +12,7 @@
       },
       "template": {
         "type": "string",
-        "minLength": 1,
+        "minLength": 7,
         "description": "the name of the template for creating the card. Notice that the template must have exactly one card"
       },
       "description": {
@@ -26,5 +24,7 @@
       }
     },
     "required": ["title", "template"]
-  }
+  },
+  "title": "Csv content",
+  "type": "array"
 }

package/src/schema/dotSchema.json

@@ -1,8 +1,6 @@
 {
-  "title": "Dot Schema",
   "$id": "dotSchema",
   "description": "Schema of the .schema ",
-  "type": "array",
   "items": {
     "type": "object",
     "additionalProperties": false,
@@ -21,5 +19,7 @@
       }
     },
     "required": ["version", "id"]
-  }
+  },
+  "title": "Dot Schema",
+  "type": "array"
 }

package/src/schema/hubSchema.json

@@ -0,0 +1,58 @@
+{
+  "$id": "hubSchema",
+  "additionalProperties": false,
+  "description": "The contents of a Cyberismo hub.",
+  "properties": {
+    "displayName": {
+      "description": "Display name of the hub",
+      "type": "string",
+      "minLength": 1
+    },
+    "description": {
+      "description": "Description of the hub",
+      "type": "string",
+      "minLength": 1
+    },
+    "modules": {
+      "description": "List of modules that are available in the hub",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "description": "Module name (project prefix). Must be unique globally.",
+            "type": "string"
+          },
+          "displayName": {
+            "description": "Display name of the module",
+            "type": "string"
+          },
+          "category": {
+            "description": "Category of the module",
+            "type": "string"
+          },
+          "location": {
+            "description": "Git remote URL, or relative file reference.",
+            "type": "string"
+          },
+          "documentationLocation": {
+            "description": "URI to the documentation of the module",
+            "type": "string"
+          },
+          "branch": {
+            "description": "If using git remote URL in 'location' defines git branch. If empty, uses repository default branch'.",
+            "type": "string"
+          },
+          "private": {
+            "description": "If true, the module is private and requires credentials (CYBERISMO_GIT_USER / CYBERISMO_GIT_TOKEN) or SSH. Does not apply for local file modules.",
+            "type": "boolean"
+          }
+        },
+        "required": ["name", "location"]
+      }
+    }
+  },
+  "required": ["displayName", "description"],
+  "title": "Hub",
+  "type": "object"
+}

package/src/schema/macros/createCardsMacroSchema.json

@@ -1,6 +1,6 @@
 {
-  "type": "object",
   "$id": "createCardsMacroSchema",
+  "additionalProperties": false,
   "properties": {
     "buttonLabel": {
       "type": "string",
@@ -34,6 +34,6 @@
       "required": ["linkType", "direction", "cardKey"]
     }
   },
-  "additionalProperties": false,
-  "required": ["buttonLabel", "template"]
+  "required": ["buttonLabel", "template"],
+  "type": "object"
 }

package/src/schema/macros/graphMacroBaseSchema.json

@@ -1,8 +1,6 @@
 {
-  "title": "Graph",
   "$id": "graphMacroBaseSchema",
   "description": "A graph object provides supplemental information about a graph",
-  "type": "object",
   "properties": {
     "model": {
       "description": "Model",
@@ -13,5 +11,7 @@
       "type": "string"
     }
   },
-  "required": ["model", "view"]
+  "required": ["model", "view"],
+  "title": "Graph",
+  "type": "object"
 }

package/src/schema/macros/imageMacroSchema.json

@@ -1,6 +1,6 @@
 {
-  "type": "object",
   "$id": "imageMacroSchema",
+  "additionalProperties": false,
   "properties": {
     "fileName": {
       "type": "string",
@@ -19,6 +19,6 @@
       "description": "Title attribute for the image"
     }
   },
-  "additionalProperties": false,
-  "required": ["fileName"]
+  "required": ["fileName"],
+  "type": "object"
 }

package/src/schema/macros/includeMacroSchema.json

@@ -1,6 +1,6 @@
 {
-  "type": "object",
   "$id": "includeMacroSchema",
+  "additionalProperties": false,
   "properties": {
     "cardKey": {
       "type": "string",
@@ -11,16 +11,16 @@
       "description": "Optional offset to adjust the heading levels of the included content. Should be a number as string (e.g., '+1', '+2' or '-1')."
     },
     "title": {
-      "type": "enum",
+      "type": "string",
       "description": "Whether to include the title of the card in the included content. If 'only' is selected, the title will be the only content included.",
       "enum": ["include", "exclude", "only"]
     },
     "pageTitles": {
-      "type": "enum",
+      "type": "string",
       "description": "If discrete, page titles will be included as discrete headings(read asciidoctor docs for more info). If normal, page titles will be included as normal headings.",
       "enum": ["normal", "discrete"]
     }
   },
-  "additionalProperties": false,
-  "required": ["cardKey"]
+  "required": ["cardKey"],
+  "type": "object"
 }

package/src/schema/macros/percentageMacroSchema.json

@@ -1,6 +1,6 @@
 {
-  "type": "object",
   "$id": "percentageMacroSchema",
+  "additionalProperties": false,
   "properties": {
     "title": {
       "type": "string",
@@ -20,6 +20,6 @@
       "description": "Colour of the progress arc (optional)"
     }
   },
-  "additionalProperties": false,
-  "required": ["title", "value", "legend"]
+  "required": ["title", "value", "legend"],
+  "type": "object"
 }

package/src/schema/macros/reportMacroBaseSchema.json

@@ -1,13 +1,13 @@
 {
-  "title": "Report",
   "$id": "reportMacroBaseSchema",
   "description": "A report object provides supplemental information about a report",
-  "type": "object",
   "properties": {
     "name": {
       "description": "The name of the report",
       "type": "string"
     }
   },
-  "required": ["name"]
+  "required": ["name"],
+  "title": "Report",
+  "type": "object"
 }

package/src/schema/macros/scoreCardMacroSchema.json

@@ -1,6 +1,6 @@
 {
-  "type": "object",
   "$id": "scoreCardMacroSchema",
+  "additionalProperties": false,
   "properties": {
     "title": {
       "type": "string",
@@ -19,6 +19,6 @@
       "description": "Description text shown below the value (optional)"
     }
   },
-  "additionalProperties": false,
-  "required": ["value"]
+  "required": ["value"],
+  "type": "object"
 }

package/src/schema/macros/vegaLiteMacroSchema.json

@@ -1,13 +1,6 @@
 {
   "$id": "vegaLiteMacroSchema",
-  "type": "object",
-  "properties": {
-    "spec": {
-      "$ref": "#/definitions/TopLevelSpec"
-    }
-  },
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "required": ["spec"],
   "definitions": {
     "Aggregate": {
       "anyOf": [
@@ -31707,5 +31700,12 @@
       "required": ["window"],
       "type": "object"
     }
-  }
+  },
+  "properties": {
+    "spec": {
+      "$ref": "#/definitions/TopLevelSpec"
+    }
+  },
+  "required": ["spec"],
+  "type": "object"
 }

package/src/schema/macros/vegaMacroSchema.json

@@ -1,14 +1,6 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Vega Visualization Specification Language",
   "$id": "vegaMacroSchema",
-  "type": "object",
-  "properties": {
-    "spec": {
-      "$ref": "#/definitions/TopLevelSpec"
-    }
-  },
-  "required": ["spec"],
+  "$schema": "http://json-schema.org/draft-07/schema#",
   "definitions": {
     "autosize": {
       "oneOf": [
@@ -14927,5 +14919,13 @@
         }
       ]
     }
-  }
+  },
+  "properties": {
+    "spec": {
+      "$ref": "#/definitions/TopLevelSpec"
+    }
+  },
+  "required": ["spec"],
+  "title": "Vega Visualization Specification Language",
+  "type": "object"
 }

package/src/schema/macros/xrefMacroSchema.json

@@ -1,12 +1,12 @@
 {
-  "type": "object",
   "$id": "xrefMacroSchema",
+  "additionalProperties": false,
   "properties": {
     "cardKey": {
       "type": "string",
       "description": "The key of the card to create a cross-reference to"
     }
   },
-  "additionalProperties": false,
-  "required": ["cardKey"]
+  "required": ["cardKey"],
+  "type": "object"
 }

package/src/schema/resources/cardTypeSchema.json

@@ -1,15 +1,13 @@
 {
-  "title": "Cardtype",
   "$id": "cardTypeSchema",
-  "description": "Card type defines the workflow and optional additional fields for the cards.",
-  "type": "object",
   "additionalProperties": false,
+  "description": "Card type defines the workflow and optional additional fields for the cards.",
   "properties": {
     "name": {
       "description": "The name of the card type",
       "type": "string",
-      "minLength": 1,
-      "pattern": "^[A-Za-z0-9]*/?[A-Za-z]*/?[A-Za-z-_]+[.json]*$"
+      "minLength": 7,
+      "pattern": "^[A-Za-z0-9/._-]+$"
     },
     "description": {
       "description": "A description that describes the card type",
@@ -22,8 +20,8 @@
     "workflow": {
       "description": "The name of the workflow",
       "type": "string",
-      "minLength": 1,
-      "pattern": "^[A-Za-z0-9]*/?[A-Za-z0-9]*/?[A-Za-z-_]+[.json]*$"
+      "minLength": 7,
+      "pattern": "^[A-Za-z0-9/._-]+$"
     },
     "customFields": {
       "type": "array",
@@ -61,5 +59,7 @@
       }
     }
   },
-  "required": ["displayName", "name", "workflow"]
+  "required": ["displayName", "name", "workflow"],
+  "title": "Cardtype",
+  "type": "object"
 }

package/src/schema/resources/fieldTypeSchema.json

@@ -1,14 +1,13 @@
 {
-  "title": "FieldType",
   "$id": "fieldTypeSchema",
-  "description": "Field type defines the workflow and optional additional fields for the cards.",
-  "type": "object",
   "additionalProperties": false,
+  "description": "Field type defines the workflow and optional additional fields for the cards.",
   "properties": {
     "name": {
       "type": "string",
       "description": "The technical name by which the field is referred to in JSON files.",
-      "pattern": "^[A-Za-z0-9/._-]+$"
+      "pattern": "^[A-Za-z0-9/._-]+$",
+      "minLength": 7
     },
     "displayName": {
       "type": "string",
@@ -44,5 +43,7 @@
       }
     }
   },
-  "required": ["displayName", "name", "dataType"]
+  "required": ["displayName", "name", "dataType"],
+  "title": "FieldType",
+  "type": "object"
 }

package/src/schema/resources/graphModelSchema.json

@@ -1,13 +1,12 @@
 {
-  "title": "GraphModel",
   "$id": "graphModelSchema",
+  "additionalProperties": false,
   "description": "A graph model object provides data for graph views",
-  "type": "object",
   "properties": {
     "name": {
       "description": "The name of this graph model",
       "type": "string",
-      "minLength": 1,
+      "minLength": 7,
       "pattern": "^[A-Za-z0-9/._-]+$"
     },
     "displayName": {
@@ -23,6 +22,7 @@
       "type": "string"
     }
   },
-  "required": ["displayName", "name", "displayName"],
-  "additionalProperties": false
+  "required": ["displayName", "name"],
+  "title": "GraphModel",
+  "type": "object"
 }

package/src/schema/resources/graphViewSchema.json

@@ -1,14 +1,13 @@
 {
-  "title": "GraphView",
   "$id": "graphViewSchema",
+  "additionalProperties": false,
   "description": "A graph view object provides means to show graph model data to users",
-  "type": "object",
   "properties": {
     "name": {
       "description": "The name of this graph view",
-      "type": "string",
-      "minLength": 1,
-      "pattern": "^[A-Za-z0-9/._-]+$"
+      "minLength": 7,
+      "pattern": "^[A-Za-z0-9/._-]+$",
+      "type": "string"
     },
     "displayName": {
       "description": "The name of the graph view as it should be displayed in the user interface. For example, 'Workflow view'.",
@@ -23,6 +22,7 @@
       "type": "string"
     }
   },
-  "required": ["displayName", "name", "displayName"],
-  "additionalProperties": false
+  "required": ["displayName", "name"],
+  "title": "GraphView",
+  "type": "object"
 }

package/src/schema/resources/linkTypeSchema.json

@@ -1,9 +1,7 @@
 {
-  "title": "LinkType",
   "$id": "linkTypeSchema",
-  "description": "Link types defined different ways to link cards together.",
-  "type": "object",
   "additionalProperties": false,
+  "description": "Link types defined different ways to link cards together.",
   "properties": {
     "description": {
       "description": "A description that describes the link type",
@@ -14,9 +12,10 @@
       "type": "string"
     },
     "name": {
-      "type": "string",
       "description": "The technical name by which the field is referred to in JSON files.",
-      "pattern": "^[A-Za-z0-9/._-]+$"
+      "minLength": 7,
+      "pattern": "^[A-Za-z0-9/._-]+$",
+      "type": "string"
     },
     "outboundDisplayName": {
       "type": "string",
@@ -53,5 +52,7 @@
     "sourceCardTypes",
     "destinationCardTypes",
     "enableLinkDescription"
-  ]
+  ],
+  "title": "LinkType",
+  "type": "object"
 }

package/src/schema/resources/reportSchema.json

@@ -1,14 +1,13 @@
 {
-  "title": "Report",
   "$id": "reportSchema",
+  "additionalProperties": false,
   "description": "A report object provides supplemental information about a report",
-  "type": "object",
   "properties": {
     "name": {
       "description": "The name of this report",
-      "type": "string",
-      "minLength": 1,
-      "pattern": "^[A-Za-z0-9/._-]+$"
+      "minLength": 7,
+      "pattern": "^[A-Za-z0-9/._-]+$",
+      "type": "string"
     },
     "displayName": {
       "description": "The name of the report as it should be displayed in the user interface. For example, 'Children list'.",
@@ -24,5 +23,6 @@
     }
   },
   "required": ["name", "displayName", "category"],
-  "additionalProperties": false
+  "title": "Report",
+  "type": "object"
 }

package/src/schema/resources/templateSchema.json

@@ -1,15 +1,13 @@
 {
-  "title": "Template",
   "$id": "templateSchema",
-  "description": "A template object provides supplemental information about a template directory structure ",
-  "type": "object",
   "additionalProperties": false,
+  "description": "A template object provides supplemental information about a template directory structure ",
   "properties": {
     "name": {
       "description": "The name of this template",
-      "type": "string",
-      "minLength": 1,
-      "pattern": "^[A-Za-z0-9/._-]+$"
+      "minLength": 7,
+      "pattern": "^[A-Za-z0-9/._-]+$",
+      "type": "string"
     },
     "displayName": {
       "description": "The name of the template as it should be displayed in the user interface. For example, 'Decision'.",
@@ -24,5 +22,7 @@
       "type": "string"
     }
   },
-  "required": ["displayName", "name"]
+  "required": ["displayName", "name"],
+  "title": "Template",
+  "type": "object"
 }

package/src/schema/resources/workflowSchema.json

@@ -1,9 +1,7 @@
 {
-  "title": "Workflow",
   "$id": "workflowSchema",
-  "description": "A state machine for the workflow of cards",
-  "type": "object",
   "additionalProperties": false,
+  "description": "A state machine for the workflow of cards",
   "properties": {
     "description": {
       "description": "A description that describes the workflow",
@@ -15,9 +13,9 @@
     },
     "name": {
       "description": "The name of this workflow",
-      "type": "string",
-      "minLength": 1,
-      "pattern": "^[A-Za-z0-9/._-]+$"
+      "minLength": 7,
+      "pattern": "^[A-Za-z0-9/._-]+$",
+      "type": "string"
     },
     "states": {
       "description": "The states of the workflow",
@@ -71,5 +69,7 @@
       }
     }
   },
-  "required": ["displayName", "name", "states", "transitions"]
+  "required": ["displayName", "name", "states", "transitions"],
+  "title": "Workflow",
+  "type": "object"
 }

package/src/schema/schema.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "jsonSchema",
-  "title": "Core schema meta-schema",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "default": true,
   "definitions": {
     "schemaArray": {
       "type": "array",
@@ -36,7 +36,6 @@
       "default": []
     }
   },
-  "type": ["object", "boolean"],
   "properties": {
     "$id": {
       "type": "string",
@@ -162,5 +161,6 @@
     "oneOf": { "$ref": "#/definitions/schemaArray" },
     "not": { "$ref": "#" }
   },
-  "default": true
+  "title": "Core schema meta-schema",
+  "type": ["object", "boolean"]
 }

package/src/schemas.ts

@@ -22,6 +22,7 @@ import fieldTypeSchema from './schema/resources/fieldTypeSchema.json' with { typ
 import graphMacroBaseSchema from './schema/macros/graphMacroBaseSchema.json' with { type: 'json' };
 import graphModelSchema from './schema/resources/graphModelSchema.json' with { type: 'json' };
 import graphViewSchema from './schema/resources/graphViewSchema.json' with { type: 'json' };
+import hubSchema from './schema/hubSchema.json' with { type: 'json' };
 import imageMacroSchema from './schema/macros/imageMacroSchema.json' with { type: 'json' };
 import includeMacroSchema from './schema/macros/includeMacroSchema.json' with { type: 'json' };
 import linkTypeSchema from './schema/resources/linkTypeSchema.json' with { type: 'json' };
@@ -48,6 +49,7 @@ export const schemas = [
   graphMacroBaseSchema,
   graphModelSchema,
   graphViewSchema,
+  hubSchema,
   imageMacroSchema,
   includeMacroSchema,
   linkTypeSchema,

package/src/static/defaultGraphView/.schema

@@ -0,0 +1,7 @@
+[
+  {
+    "version": 1,
+    "id": "jsonSchema",
+    "file": "parameterSchema.json"
+  }
+]

package/src/static/defaultGraphView/parameterSchema.json

@@ -0,0 +1,22 @@
+{
+  "$id": "myGraphMacroSchema",
+  "additionalProperties": false,
+  "description": "Parameters for the graph macro",
+  "properties": {
+    "model": {
+      "description": "The name of the graph model",
+      "type": "string"
+    },
+    "view": {
+      "description": "The name of the graph view",
+      "type": "string"
+    },
+    "cardKey": {
+      "description": "Override default cardKey of the macro with another cardKey. Default cardKey is the card where the macro is defined in.",
+      "type": "string"
+    }
+  },
+  "required": ["model", "view"],
+  "title": "Graph view",
+  "type": "object"
+}

package/src/static/defaultReport/parameterSchema.json

@@ -1,8 +1,7 @@
 {
-  "title": "Report",
   "$id": "reportMacroDefaultSchema",
+  "additionalProperties": false,
   "description": "A report object provides supplemental information about a report",
-  "type": "object",
   "properties": {
     "name": {
       "description": "The name of the report",
@@ -13,6 +12,7 @@
       "type": "string"
     }
   },
-  "additionalProperties": false,
-  "required": ["name"]
+  "required": ["name"],
+  "title": "Report",
+  "type": "object"
 }