@cyberismo/assets 0.0.6

package/src/schema/cardsConfigSchema.json

@@ -0,0 +1,49 @@
+{
+  "title": "CardsConfig",
+  "$id": "cardsConfigSchema",
+  "description": "General configuration settings for the card tree.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "cardKeyPrefix": {
+      "type": "string",
+      "description": "The prefix or the fist component of the card key. For example, ABC",
+      "pattern": "^[a-z]+$",
+      "minLength": 3,
+      "maxLength": 10
+    },
+    "name": {
+      "description": "Name of the project",
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[A-Za-z ._-]+$"
+    },
+    "modules": {
+      "description": "List of modules that have been included in the project",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "description": "Module name (project prefix). Must be unique.",
+            "type": "string"
+          },
+          "location": {
+            "description": "URI that is either a git URL with HTTPS, or relative file reference",
+            "type": "string"
+          },
+          "branch": {
+            "description": "If using git URL in 'location' defines git branch. If empty, assumed to be 'main'. ",
+            "type": "string"
+          },
+          "private": {
+            "description": "If true, the module is private and requires credentials (CYBERISMO_GIT_USER / CYBERISMO_GIT_TOKEN)",
+            "type": "boolean"
+          }
+        },
+        "required": ["name", "location"]
+      }
+    }
+  },
+  "required": ["cardKeyPrefix"]
+}

package/src/schema/csvSchema.json

@@ -0,0 +1,30 @@
+{
+  "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,
+    "properties": {
+      "title": {
+        "type": "string",
+        "minLength": 1,
+        "description": "The title of the card"
+      },
+      "template": {
+        "type": "string",
+        "minLength": 1,
+        "description": "the name of the template for creating the card. Notice that the template must have exactly one card"
+      },
+      "description": {
+        "type": "string",
+        "description": "The AsciiDoc contents of the card"
+      },
+      "labels": {
+        "type": "string"
+      }
+    },
+    "required": ["title", "template"]
+  }
+}

package/src/schema/dotSchema.json

@@ -0,0 +1,25 @@
+{
+  "title": "Dot Schema",
+  "$id": "dotSchema",
+  "description": "Schema of the .schema ",
+  "type": "array",
+  "items": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "version": {
+        "description": "Version of the schema",
+        "type": "number"
+      },
+      "file": {
+        "description": "File that is being validated. If empty, validates all json using the schema in the directory.",
+        "type": "string"
+      },
+      "id": {
+        "description": "Id of the schema that is used to validate the given file",
+        "type": "string"
+      }
+    },
+    "required": ["version", "id"]
+  }
+}

package/src/schema/macros/createCardsMacroSchema.json

@@ -0,0 +1,39 @@
+{
+  "type": "object",
+  "$id": "createCardsMacroSchema",
+  "properties": {
+    "buttonLabel": {
+      "type": "string",
+      "description": "The label of the button to create from this template. For example, 'Create a New Decision'."
+    },
+    "template": {
+      "type": "string",
+      "description": "The name of the template"
+    },
+    "cardKey": {
+      "type": "string",
+      "description": "The card key of the parent under which the template should be instantiated. If not given, the template will be instantiated under the card that includes this macro."
+    },
+    "link": {
+      "type": "object",
+      "properties": {
+        "linkType": {
+          "type": "string",
+          "description": "Name of the link type to create"
+        },
+        "direction": {
+          "type": "string",
+          "description": "Direction of the link. Can be 'inbound' or 'outbound'."
+        },
+        "cardKey": {
+          "type": "string",
+          "description": "Either the source of an inbound link or the target of an outbound link"
+        }
+      },
+      "additionalProperties": false,
+      "required": ["linkType", "direction", "cardKey"]
+    }
+  },
+  "additionalProperties": false,
+  "required": ["buttonLabel", "template"]
+}

package/src/schema/macros/graphMacroBaseSchema.json

@@ -0,0 +1,17 @@
+{
+  "title": "Graph",
+  "$id": "graphMacroBaseSchema",
+  "description": "A graph object provides supplemental information about a graph",
+  "type": "object",
+  "properties": {
+    "model": {
+      "description": "Model",
+      "type": "string"
+    },
+    "view": {
+      "description": "View",
+      "type": "string"
+    }
+  },
+  "required": ["model", "view"]
+}

package/src/schema/macros/reportMacroBaseSchema.json

@@ -0,0 +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"]
+}

package/src/schema/macros/scoreCardMacroSchema.json

@@ -0,0 +1,24 @@
+{
+  "type": "object",
+  "$id": "scoreCardMacroSchema",
+  "properties": {
+    "title": {
+      "type": "string",
+      "description": "Title text on top of the card (optional)"
+    },
+    "value": {
+      "type": "number",
+      "description": "Value shown as content of the card"
+    },
+    "unit": {
+      "type": "string",
+      "description": "Unit shown after the value (optional)"
+    },
+    "legend": {
+      "type": "string",
+      "description": "Description text shown below the value (optional)"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["value"]
+}

package/src/schema/resources/cardTypeSchema.json

@@ -0,0 +1,65 @@
+{
+  "title": "Cardtype",
+  "$id": "cardTypeSchema",
+  "description": "Card type defines the workflow and optional additional fields for the cards.",
+  "type": "object",
+  "additionalProperties": false,
+  "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]*$"
+    },
+    "description": {
+      "description": "A description that describes the card type",
+      "type": "string"
+    },
+    "displayName": {
+      "description": "A name by which the card type is referred to in the user interface",
+      "type": "string"
+    },
+    "workflow": {
+      "description": "The name of the workflow",
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[A-Za-z0-9]*/?[A-Za-z0-9]*/?[A-Za-z-_]+[.json]*$"
+    },
+    "customFields": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "name": {
+            "description": "The technical name by which the field is referred to in JSON files.",
+            "type": "string"
+          },
+          "displayName": {
+            "description": "A name by which the field is referred to in the user interface.",
+            "type": "string"
+          },
+          "isCalculated": {
+            "description": "Defines if field value is a calculated field.",
+            "type": "boolean",
+            "default": true
+          }
+        },
+        "required": ["name"]
+      }
+    },
+    "alwaysVisibleFields": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "optionallyVisibleFields": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": ["displayName", "name", "workflow"]
+}

package/src/schema/resources/fieldTypeSchema.json

@@ -0,0 +1,47 @@
+{
+  "title": "FieldType",
+  "$id": "fieldTypeSchema",
+  "description": "Field type defines the workflow and optional additional fields for the cards.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The technical name by which the field is referred to in JSON files."
+    },
+    "displayName": {
+      "type": "string",
+      "description": "A name by which the field is referred to in the user interface."
+    },
+    "description": {
+      "type": "string",
+      "description": "A description that describes the field type"
+    },
+    "dataType": {
+      "type": "string",
+      "description": "",
+      "pattern": "^shortText$|^longText$|^number$|^integer$|^boolean$|^enum$|^list$|^date$|^dateTime$|^person$"
+    },
+    "enumValues": {
+      "description": "An array of available enum values. Used for the enum fieldType only.",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "enumValue": {
+            "type": "string"
+          },
+          "enumDisplayValue": {
+            "type": "string"
+          },
+          "enumDescription": {
+            "type": "string"
+          }
+        },
+        "required": ["enumValue"]
+      }
+    }
+  },
+  "required": ["displayName", "name", "dataType"]
+}

package/src/schema/resources/graphModelSchema.json

@@ -0,0 +1,28 @@
+{
+  "title": "GraphModel",
+  "$id": "graphModelSchema",
+  "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,
+      "pattern": "^[A-Za-z0-9/._-]+$"
+    },
+    "displayName": {
+      "description": "The name of the graph model as it should be displayed in the user interface. For example, 'Workflow data'.",
+      "type": "string"
+    },
+    "description": {
+      "description": "A description of the graph model. For example, 'Workflow data defines necessary data elements to show workflow graphically.'.",
+      "type": "string"
+    },
+    "category": {
+      "description": "The category of the graph model. For example, 'UserModels'.",
+      "type": "string"
+    }
+  },
+  "required": ["displayName", "name", "displayName"],
+  "additionalProperties": false
+}

package/src/schema/resources/graphViewSchema.json

@@ -0,0 +1,28 @@
+{
+  "title": "GraphView",
+  "$id": "graphViewSchema",
+  "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/._-]+$"
+    },
+    "displayName": {
+      "description": "The name of the graph view as it should be displayed in the user interface. For example, 'Workflow view'.",
+      "type": "string"
+    },
+    "description": {
+      "description": "A description of the graph view. For example, 'Workflow view defines ways how to show workflow data to the user'.",
+      "type": "string"
+    },
+    "category": {
+      "description": "The category of the graph view. For example, 'UserViews'.",
+      "type": "string"
+    }
+  },
+  "required": ["displayName", "name", "displayName"],
+  "additionalProperties": false
+}

package/src/schema/resources/linkTypeSchema.json

@@ -0,0 +1,56 @@
+{
+  "title": "LinkType",
+  "$id": "linkTypeSchema",
+  "description": "Link types defined different ways to link cards together.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "description": {
+      "description": "A description that describes the link type",
+      "type": "string"
+    },
+    "displayName": {
+      "description": "A name by which the link type is referred to in the user interface",
+      "type": "string"
+    },
+    "name": {
+      "type": "string",
+      "description": "The technical name by which the field is referred to in JSON files."
+    },
+    "outboundDisplayName": {
+      "type": "string",
+      "description": "A name by which the field is referred to in the user interface(from-to)."
+    },
+    "inboundDisplayName": {
+      "type": "string",
+      "description": "A name by which the field is referred to in the user interface(to-from)."
+    },
+    "sourceCardTypes": {
+      "type": "array",
+      "description": "The card types that can be the source of this link type. If empty, all card types are allowed.",
+      "items": {
+        "type": "string"
+      }
+    },
+    "destinationCardTypes": {
+      "type": "array",
+      "description": "The card types that can be the target of this link type. If empty, all card types are allowed.",
+      "items": {
+        "type": "string"
+      }
+    },
+    "enableLinkDescription": {
+      "type": "boolean",
+      "description": "If true, the user can add a description to the link."
+    }
+  },
+  "required": [
+    "displayName",
+    "name",
+    "outboundDisplayName",
+    "inboundDisplayName",
+    "sourceCardTypes",
+    "destinationCardTypes",
+    "enableLinkDescription"
+  ]
+}

package/src/schema/resources/reportSchema.json

@@ -0,0 +1,28 @@
+{
+  "title": "Report",
+  "$id": "reportSchema",
+  "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/._-]+$"
+    },
+    "displayName": {
+      "description": "The name of the report as it should be displayed in the user interface. For example, 'Children list'.",
+      "type": "string"
+    },
+    "description": {
+      "description": "A description of the report. For example, 'A Children list shows the child cards as an unordered list.'.",
+      "type": "string"
+    },
+    "category": {
+      "description": "The category of the report. For example, 'Architecture'.",
+      "type": "string"
+    }
+  },
+  "required": ["name", "displayName", "category"],
+  "additionalProperties": false
+}

package/src/schema/resources/templateSchema.json

@@ -0,0 +1,28 @@
+{
+  "title": "Template",
+  "$id": "templateSchema",
+  "description": "A template object provides supplemental information about a template directory structure ",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "name": {
+      "description": "The name of this template",
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[A-Za-z0-9/._-]+$"
+    },
+    "displayName": {
+      "description": "The name of the template as it should be displayed in the user interface. For example, 'Decision'.",
+      "type": "string"
+    },
+    "description": {
+      "description": "A description of the template. For example, 'A decision is a choice between two or more options.'.",
+      "type": "string"
+    },
+    "category": {
+      "description": "The category of the template. For example, 'Decision'.",
+      "type": "string"
+    }
+  },
+  "required": ["displayName", "name"]
+}

package/src/schema/resources/workflowSchema.json

@@ -0,0 +1,75 @@
+{
+  "title": "Workflow",
+  "$id": "workflowSchema",
+  "description": "A state machine for the workflow of cards",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "description": {
+      "description": "A description that describes the workflow",
+      "type": "string"
+    },
+    "displayName": {
+      "description": "A name by which the workflow is referred to in the user interface",
+      "type": "string"
+    },
+    "name": {
+      "description": "The name of this workflow",
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[A-Za-z0-9/._-]+$"
+    },
+    "states": {
+      "description": "The states of the workflow",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "name": {
+            "description": "The name of a workflow state",
+            "type": "string",
+            "minLength": 1,
+            "pattern": "^[A-Za-z ._-]+$"
+          },
+          "category": {
+            "description": "The category of a workflow state",
+            "enum": ["none", "initial", "active", "closed"]
+          }
+        },
+        "required": ["name", "category"]
+      }
+    },
+    "transitions": {
+      "description": "The state transitions of the workflow",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "pattern": "^[A-Za-z. _-]+$"
+          },
+          "fromState": {
+            "description": "List of states where state transition can start from",
+            "type": "array",
+            "items": {
+              "description": "The name of the starting state of the transition. The wildcard '*' denotes any state and and empty value denotes the transition to create a new card with this workflow.",
+              "type": "string",
+              "pattern": "^[*]|^$|^[A-Za-z ._-]+$"
+            }
+          },
+          "toState": {
+            "description": "The name of the end state of the transition",
+            "type": "string",
+            "pattern": "^[*]|^$|^[A-Za-z ._-]+$"
+          }
+        },
+        "required": ["name", "fromState", "toState"]
+      }
+    }
+  },
+  "required": ["displayName", "name", "states", "transitions"]
+}