@cyberismo/assets 0.0.6

package/src/schema/cardTreeDirectorySchema.json

@@ -0,0 +1,663 @@
+{
+  "title": "Card directory tree schema",
+  "$id": "cardTreeDirectorySchema",
+  "description": "This schema represents the directory structure of a card tree, using the format of https://github.com/jpoehnelt/directory-schema-validator",
+  "type": "object",
+  "properties": {
+    "directories": {
+      "type": "object",
+      "properties": {
+        ".cards": {
+          "description": "Configuration for the card tree",
+          "type": "object",
+          "properties": {
+            "files": {
+              "type": "object",
+              "additionalProperties": false
+            },
+            "directories": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "modules": {
+                  "$ref": "#/$defs/cardModuleSchema"
+                },
+                "local": {
+                  "type": "object",
+                  "properties": {
+                    "files": {
+                      "type": "object",
+                      "additionalProperties": false,
+                      "properties": {
+                        ".schema": {},
+                        "cardsConfig.json": {}
+                      },
+                      "required": [".schema", "cardsConfig.json"]
+                    },
+                    "directories": {
+                      "type": "object",
+                      "additionalProperties": false,
+                      "properties": {
+                        "calculations": {
+                          "$ref": "#/$defs/calculationResourceSchema"
+                        },
+                        "cardTypes": {
+                          "$ref": "#/$defs/cardTypeResourceSchema"
+                        },
+                        "fieldTypes": {
+                          "$ref": "#/$defs/fieldTypeResourceSchema"
+                        },
+                        "graphViews": {
+                          "$ref": "#/$defs/graphViewResourceSchema"
+                        },
+                        "graphModels": {
+                          "$ref": "#/$defs/graphModelResourceSchema"
+                        },
+                        "linkTypes": {
+                          "$ref": "#/$defs/linkTypeResourceSchema"
+                        },
+                        "reports": {
+                          "$ref": "#/$defs/reportResourceSchema"
+                        },
+                        "templates": {
+                          "$ref": "#/$defs/templatesResourceSchema"
+                        },
+                        "workflows": {
+                          "$ref": "#/$defs/workflowResourceSchema"
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              "required": ["local"]
+            }
+          }
+        },
+        "cardRoot": {
+          "description": "The contents of the card tree. Each subdirectory contains a top level card. The name of the directory is the card key.",
+          "type": "object",
+          "properties": {
+            "files": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                ".gitkeep": {},
+                ".schema": {}
+              }
+            },
+            "directories": {
+              "type": "object",
+              "additionalProperties": false,
+              "patternProperties": {
+                "^[a-z]+_[0-9a-z]+$": {
+                  "$ref": "#/$defs/cardDirectorySchema#"
+                }
+              }
+            }
+          }
+        },
+        ".calc": {
+          "description": "Temporary files for calculations.",
+          "type": "object",
+          "properties": {
+            "directories": {
+              "type": "object",
+              "properties": {
+                "resources": {
+                  "description": "Schema of the .calc resource folder",
+                  "type": "object",
+                  "properties": {
+                    "files": {
+                      "type": "object",
+                      "additionalProperties": false,
+                      "patternProperties": {
+                        "^.+\\.lp$": {
+                          "type": "object"
+                        }
+                      }
+                    }
+                  }
+                },
+                "cards": {
+                  "description": "Directory that contains separate logic program files for each card",
+                  "type": "object",
+                  "properties": {
+                    "files": {
+                      "type": "object",
+                      "additionalProperties": false,
+                      "patternProperties": {
+                        "^.+\\.lp$": {
+                          "type": "object"
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              "additionalProperties": false
+            },
+            "files": {
+              "type": "object",
+              "properties": {
+                "base.lp": {
+                  "description": "A logic program that contains basic common definitions that are the same in all cards projects",
+                  "type": "object"
+                },
+                "calculations.lp": {
+                  "description": "A logic program that only includes all the logic programs from modules, including the calculations from the local content",
+                  "type": "object"
+                },
+                "cardTree.lp": {
+                  "description": "A logic program that only includes all the card-specific logic programs",
+                  "type": "object"
+                },
+                "resourceImports.lp": {
+                  "description": "A logic program that only includes all the logic programs generated from resources",
+                  "type": "object"
+                },
+                "main.lp": {
+                  "description": "The main logic program",
+                  "type": "object"
+                },
+                "modules.lp": {
+                  "description": "",
+                  "type": "object"
+                },
+                "queryLanguage.lp": {
+                  "description": "A logic program that defines the Cyberismo query language",
+                  "type": "object"
+                }
+              },
+              "additionalProperties": true
+            }
+          }
+        }
+      },
+      "required": [".cards", "cardRoot"]
+    }
+  },
+  "$defs": {
+    "cardModuleSchema": {
+      "description": "The schema for modules. Each module is in a named directory containing 'cardTypes', 'templates' and 'workflows'. ",
+      "type": "object",
+      "properties": {
+        "directories": {
+          "type": "object",
+          "patternProperties": {
+            "^[A-Za-z ._-]+$": {
+              "type": "object",
+              "properties": {
+                "directories": {
+                  "type": "object",
+                  "properties": {
+                    "calculations": {
+                      "$ref": "#/$defs/calculationResourceSchema"
+                    },
+                    "cardTypes": {
+                      "$ref": "#/$defs/cardTypeResourceSchema"
+                    },
+                    "fieldTypes": {
+                      "$ref": "#/$defs/fieldTypeResourceSchema"
+                    },
+                    "graphViews": {
+                      "$ref": "#/$defs/graphViewResourceSchema"
+                    },
+                    "graphModels": {
+                      "$ref": "#/$defs/graphModelResourceSchema"
+                    },
+                    "linkTypes": {
+                      "$ref": "#/$defs/linkTypeResourceSchema"
+                    },
+                    "reports": {
+                      "$ref": "#/$defs/reportResourceSchema"
+                    },
+                    "templates": {
+                      "$ref": "#/$defs/templatesResourceSchema"
+                    },
+                    "workflows": {
+                      "$ref": "#/$defs/workflowResourceSchema"
+                    }
+                  }
+                },
+                "files": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "properties": {
+                    ".schema": {},
+                    "cardsConfig.json": {
+                      "type": "object"
+                    }
+                  },
+                  "required": ["cardsConfig.json", ".schema"]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "cardDirectorySchema": {
+      "description": "The directory schema of a card, using the format of https://github.com/jpoehnelt/directory-schema-validator",
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The name of the card directory is the card key",
+          "type": "string",
+          "minLength": 5,
+          "maxLength": 20,
+          "pattern": "^[a-z]+_[0-9a-z]+$"
+        },
+        "files": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            ".schema": {},
+            "index.json": {
+              "description": "The fields of the card. This file must validate against both the cardBaseSchema.json and the custom fields of its card type",
+              "type": "object",
+              "$comment": "Each file needs to be separately validated against 'contentSchema'",
+              "contentSchema": "cardBaseSchema.json"
+            },
+            "index.adoc": {
+              "description": "The description field of the card as an Asciidoc file",
+              "type": "object"
+            },
+            "index.lp": {
+              "description": "Calculations specific to the card",
+              "type": "object"
+            }
+          },
+          "required": ["index.json", "index.adoc"]
+        },
+        "directories": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "a": {
+              "description": "A directory for file attachments of the card",
+              "type": "object",
+              "properties": {
+                "directories": {
+                  "type": "object",
+                  "additionalProperties": false
+                }
+              }
+            },
+            "c": {
+              "description": "A directory for child cards",
+              "type": "object",
+              "properties": {
+                "directories": {
+                  "$ref": "#/$defs/cardDirectorySchema#"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "calculationResourceSchema": {
+      "type": "object",
+      "properties": {
+        "directories": {
+          "type": "object",
+          "additionalProperties": false
+        },
+        "files": {
+          "type": "object",
+          "$comment": "Each file must be a logic program file",
+          "additionalProperties": false,
+          "patternProperties": {
+            "^.+\\.lp$": {
+              "type": "object"
+            }
+          },
+          "properties": {
+            ".gitkeep": {}
+          }
+        }
+      }
+    },
+    "cardTypeResourceSchema": {
+      "type": "object",
+      "allOf": [
+        {
+          "properties": {
+            "directories": {
+              "type": "object",
+              "additionalProperties": false
+            }
+          }
+        },
+        {
+          "properties": {
+            "files": {
+              "type": "object",
+              "$comment": "Each file needs to be separately validated against 'contentSchema'",
+              "contentSchema": "cardTypeSchema.json"
+            }
+          }
+        },
+        {
+          "properties": {
+            "files": {
+              "type": "object",
+              "properties": {
+                ".schema": {},
+                ".gitkeep": {}
+              },
+              "required": [".schema"]
+            }
+          }
+        }
+      ]
+    },
+    "fieldTypeResourceSchema": {
+      "type": "object",
+      "allOf": [
+        {
+          "properties": {
+            "directories": {
+              "type": "object",
+              "additionalProperties": false
+            }
+          }
+        },
+        {
+          "properties": {
+            "files": {
+              "type": "object",
+              "$comment": "Each file needs to be separately validated against 'contentSchema'",
+              "contentSchema": "cardTypeSchema.json"
+            }
+          }
+        },
+        {
+          "properties": {
+            "files": {
+              "type": "object",
+              "properties": {
+                ".schema": {},
+                ".gitkeep": {}
+              },
+              "required": [".schema"]
+            }
+          }
+        }
+      ]
+    },
+    "graphViewResourceSchema": {
+      "type": "object",
+      "properties": {
+        "additionalProperties": false,
+        "directories": {
+          "type": "object",
+          "additionalProperties": false,
+          "patternProperties": {
+            ".+": {
+              "type": "object",
+              "properties": {
+                "files": {
+                  "type": "object",
+                  "properties": {
+                    "view.lp.hbs": {
+                      "type": "object"
+                    },
+                    "parameterSchema.json": {
+                      "type": "object"
+                    }
+                  },
+                  "required": ["view.lp.hbs"]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "graphModelResourceSchema": {
+      "type": "object",
+      "properties": {
+        "additionalProperties": false,
+        "directories": {
+          "type": "object",
+          "additionalProperties": false,
+          "patternProperties": {
+            ".+": {
+              "type": "object",
+              "properties": {
+                "files": {
+                  "type": "object",
+                  "properties": {
+                    "model.lp": {
+                      "type": "object"
+                    }
+                  },
+                  "required": ["model.lp"]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "linkTypeResourceSchema": {
+      "type": "object",
+      "allOf": [
+        {
+          "properties": {
+            "directories": {
+              "type": "object",
+              "additionalProperties": false
+            }
+          }
+        },
+        {
+          "properties": {
+            "files": {
+              "type": "object",
+              "$comment": "Each file needs to be separately validated against 'contentSchema'",
+              "contentSchema": "linkTypeSchema.json"
+            }
+          }
+        },
+        {
+          "properties": {
+            "files": {
+              "type": "object",
+              "properties": {
+                ".schema": {},
+                ".gitkeep": {}
+              },
+              "required": [".schema"]
+            }
+          }
+        }
+      ]
+    },
+    "reportResourceSchema": {
+      "type": "object",
+      "properties": {
+        "additionalProperties": false,
+        "files": {
+          "$comment": "reports folder can contain report configuration files (<name>.json), or .gitkeep",
+          "type": "object",
+          "additionalProperties": false,
+          "patternProperties": {
+            "^[A-Za-z0-9-_]+.json$": {
+              "type": "object"
+            },
+            "^.schema$": {
+              "type": "object"
+            },
+            "^.gitkeep$": {
+              "type": "object"
+            }
+          }
+        },
+        "directories": {
+          "type": "object",
+          "additionalProperties": false,
+          "patternProperties": {
+            ".+": {
+              "type": "object",
+              "properties": {
+                "files": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "properties": {
+                    "index.adoc.hbs": {
+                      "type": "object"
+                    },
+                    "query.lp.hbs": {
+                      "type": "object"
+                    },
+                    "parameterSchema.json": {
+                      "type": "object"
+                    },
+                    ".schema": {
+                      "type": "object"
+                    }
+                  },
+                  "required": [".schema", "index.adoc.hbs", "query.lp.hbs"]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "workflowResourceSchema": {
+      "type": "object",
+      "allOf": [
+        {
+          "properties": {
+            "directories": {
+              "type": "object",
+              "additionalProperties": false
+            }
+          }
+        },
+        {
+          "properties": {
+            "files": {
+              "type": "object",
+              "$comment": "Each file needs to be separately validated against 'contentSchema'",
+              "contentSchema": "workflowSchema.json"
+            }
+          }
+        },
+        {
+          "properties": {
+            "files": {
+              "type": "object",
+              "properties": {
+                ".schema": {},
+                ".gitkeep": {}
+              },
+              "required": [".schema"]
+            }
+          }
+        }
+      ]
+    },
+    "templatesResourceSchema": {
+      "type": "object",
+      "allOf": [
+        {
+          "properties": {
+            "directories": {
+              "type": "object",
+              "additionalProperties": false,
+              "patternProperties": {
+                ".+": {
+                  "type": "object",
+                  "allOf": [
+                    {
+                      "properties": {
+                        "directories": {
+                          "type": "object",
+                          "additionalProperties": false,
+                          "properties": {
+                            "c": {
+                              "description": "Each subdirectory is a card.",
+                              "type": "object",
+                              "properties": {
+                                "directories": {
+                                  "type": "object",
+                                  "additionalProperties": false,
+                                  "patternProperties": {
+                                    "^[a-z]+_[0-9a-z]+$": {
+                                      "$ref": "#/$defs/cardDirectorySchema#"
+                                    }
+                                  }
+                                },
+                                "files": {
+                                  "type": "object",
+                                  "additionalProperties": false,
+                                  "properties": {
+                                    ".schema": {}
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    {
+                      "properties": {
+                        "files": {
+                          "type": "object",
+                          "additionalProperties": false,
+                          "properties": {
+                            ".gitkeep": {}
+                          }
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        },
+        {
+          "properties": {
+            "files": {
+              "$comment": "templates folder can contain template configuration files (<name>.json), content schema files (.schema) or .gitkeep",
+              "type": "object",
+              "additionalProperties": false,
+              "patternProperties": {
+                "^[A-Za-z0-9-_]+.json$": {
+                  "type": "object",
+                  "$comment": "Each file needs to be separately validated against 'contentSchema'",
+                  "contentSchema": "templateSchema.json"
+                },
+                "^.schema$": {
+                  "type": "object"
+                },
+                "^.gitkeep$": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        {
+          "properties": {
+            "files": {
+              "type": "object",
+              "properties": {
+                ".schema": {},
+                ".gitkeep": {}
+              },
+              "required": [".schema"]
+            }
+          }
+        }
+      ]
+    }
+  }
+}