@true-sight/model-schema 1.0.0

package/manifest.schema.json

@@ -0,0 +1,207 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://truesight.dev/schemas/model-manifest/1.1",
+  "title": "ModelManifest",
+  "type": "object",
+  "required": ["schemaVersion", "generatedAt", "models"],
+  "additionalProperties": false,
+  "properties": {
+    "schemaVersion": { "type": "string", "const": "1.1" },
+    "generatedAt": { "type": "string", "minLength": 1 },
+    "sourceCommit": { "type": "string" },
+    "models": {
+      "type": "array",
+      "items": { "$ref": "#/definitions/Model" }
+    }
+  },
+  "definitions": {
+    "RefString": {
+      "type": "string",
+      "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*\\.[a-zA-Z_][a-zA-Z0-9_]*$"
+    },
+    "DimensionType": {
+      "type": "string",
+      "enum": ["integer", "string", "date", "datetime", "boolean"]
+    },
+    "AggregateType": {
+      "type": "string",
+      "enum": ["sum", "count", "min", "max"]
+    },
+    "JoinType": {
+      "type": "string",
+      "enum": ["inner", "left", "right", "full"]
+    },
+    "JoinRelationship": {
+      "type": "string",
+      "enum": ["one_to_one", "one_to_many", "many_to_one", "many_to_many"]
+    },
+    "ManifestExpr": {
+      "oneOf": [
+        { "$ref": "#/definitions/RefString" },
+        { "$ref": "#/definitions/ManifestExprObject" }
+      ]
+    },
+    "ManifestExprObject": {
+      "type": "object",
+      "required": ["kind"],
+      "additionalProperties": false,
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "raw",
+            "eq",
+            "neq",
+            "gt",
+            "gte",
+            "lt",
+            "lte",
+            "and",
+            "or",
+            "not",
+            "aggregate"
+          ]
+        },
+        "sql": { "type": "string" },
+        "left": { "$ref": "#/definitions/ManifestExpr" },
+        "right": { "$ref": "#/definitions/ManifestExpr" },
+        "operand": { "$ref": "#/definitions/ManifestExpr" },
+        "fn": { "$ref": "#/definitions/AggregateType" }
+      },
+      "allOf": [
+        {
+          "if": { "properties": { "kind": { "const": "raw" } }, "required": ["kind"] },
+          "then": { "required": ["sql"] }
+        },
+        {
+          "if": {
+            "properties": {
+              "kind": { "enum": ["eq", "neq", "gt", "gte", "lt", "lte", "and", "or"] }
+            },
+            "required": ["kind"]
+          },
+          "then": { "required": ["left", "right"] }
+        },
+        {
+          "if": { "properties": { "kind": { "const": "not" } }, "required": ["kind"] },
+          "then": { "required": ["operand"] }
+        },
+        {
+          "if": { "properties": { "kind": { "const": "aggregate" } }, "required": ["kind"] },
+          "then": { "required": ["fn", "operand"] }
+        }
+      ]
+    },
+    "JoinOn": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": ["pair"],
+          "additionalProperties": false,
+          "properties": {
+            "pair": {
+              "type": "array",
+              "minItems": 2,
+              "maxItems": 2,
+              "items": { "type": "string", "minLength": 1 }
+            }
+          }
+        },
+        { "$ref": "#/definitions/ManifestExpr" }
+      ]
+    },
+    "DimensionDefinition": {
+      "type": "object",
+      "required": ["groupLabel", "name", "label", "type", "expression"],
+      "additionalProperties": false,
+      "properties": {
+        "groupLabel": { "type": "string" },
+        "name": { "type": "string", "minLength": 1 },
+        "label": { "type": "string" },
+        "type": { "$ref": "#/definitions/DimensionType" },
+        "expression": { "$ref": "#/definitions/ManifestExpr" }
+      }
+    },
+    "MeasurementDefinition": {
+      "type": "object",
+      "required": ["groupLabel", "name", "label", "type", "expression"],
+      "additionalProperties": false,
+      "properties": {
+        "groupLabel": { "type": "string" },
+        "name": { "type": "string", "minLength": 1 },
+        "label": { "type": "string" },
+        "type": { "$ref": "#/definitions/AggregateType" },
+        "expression": { "$ref": "#/definitions/ManifestExpr" }
+      }
+    },
+    "ViewDefinition": {
+      "type": "object",
+      "required": ["name", "label", "sql", "dimensions", "measurements"],
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "label": { "type": "string" },
+        "sql": {
+          "type": "object",
+          "required": ["tableName"],
+          "additionalProperties": false,
+          "properties": {
+            "tableName": { "type": "string", "minLength": 1 }
+          }
+        },
+        "dimensions": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/DimensionDefinition" }
+        },
+        "measurements": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/MeasurementDefinition" }
+        }
+      }
+    },
+    "ExploreJoin": {
+      "type": "object",
+      "required": ["name", "fromView", "on", "type", "relationship"],
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "fromView": { "type": "string", "minLength": 1 },
+        "on": { "$ref": "#/definitions/JoinOn" },
+        "type": { "$ref": "#/definitions/JoinType" },
+        "relationship": { "$ref": "#/definitions/JoinRelationship" }
+      }
+    },
+    "Explore": {
+      "type": "object",
+      "required": ["name", "label", "from", "joins", "views"],
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "label": { "type": "string" },
+        "from": { "type": "string", "minLength": 1 },
+        "joins": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/ExploreJoin" }
+        },
+        "views": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/ViewDefinition" }
+        }
+      }
+    },
+    "Model": {
+      "type": "object",
+      "required": ["name", "label", "connectionName", "explores"],
+      "additionalProperties": false,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "label": { "type": "string" },
+        "connectionName": { "type": "string" },
+        "explores": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/Explore" }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@true-sight/model-schema",
+  "version": "1.0.0",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "manifest.schema.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./manifest.schema.json": "./manifest.schema.json"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "typecheck": "tsc -p test/dsl/typecheck/tsconfig.json --noEmit"
+  },
+  "dependencies": {
+    "ajv": "^8.17.1",
+    "reflect-metadata": "^0.2.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "jest": "^30.0.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.3"
+  },
+  "jest": {
+    "moduleFileExtensions": ["js", "json", "ts"],
+    "rootDir": ".",
+    "testMatch": ["**/test/**/*.spec.ts"],
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.js$": "$1"
+    },
+    "testEnvironment": "node"
+  }
+}