@murphai/contracts 0.1.1

package/generated/vault-metadata.schema.json

@@ -0,0 +1,324 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemaVersion": {
+      "type": "string",
+      "const": "murph.vault.v1"
+    },
+    "vaultId": {
+      "type": "string",
+      "pattern": "^vault_[0-9A-HJKMNP-TV-Z]{26}$"
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 120
+    },
+    "timezone": {
+      "type": "string",
+      "minLength": 3,
+      "maxLength": 64
+    },
+    "idPolicy": {
+      "type": "object",
+      "properties": {
+        "format": {
+          "type": "string",
+          "const": "prefix_ulid"
+        },
+        "prefixes": {
+          "type": "object",
+          "properties": {
+            "allergy": {
+              "type": "string",
+              "const": "alg"
+            },
+            "assessment": {
+              "type": "string",
+              "const": "asmt"
+            },
+            "audit": {
+              "type": "string",
+              "const": "aud"
+            },
+            "condition": {
+              "type": "string",
+              "const": "cond"
+            },
+            "document": {
+              "type": "string",
+              "const": "doc"
+            },
+            "event": {
+              "type": "string",
+              "const": "evt"
+            },
+            "experiment": {
+              "type": "string",
+              "const": "exp"
+            },
+            "family": {
+              "type": "string",
+              "const": "fam"
+            },
+            "food": {
+              "type": "string",
+              "const": "food"
+            },
+            "goal": {
+              "type": "string",
+              "const": "goal"
+            },
+            "meal": {
+              "type": "string",
+              "const": "meal"
+            },
+            "pack": {
+              "type": "string",
+              "const": "pack"
+            },
+            "profileSnapshot": {
+              "type": "string",
+              "const": "psnap"
+            },
+            "provider": {
+              "type": "string",
+              "const": "prov"
+            },
+            "recipe": {
+              "type": "string",
+              "const": "rcp"
+            },
+            "protocol": {
+              "type": "string",
+              "const": "prot"
+            },
+            "sample": {
+              "type": "string",
+              "const": "smp"
+            },
+            "transform": {
+              "type": "string",
+              "const": "xfm"
+            },
+            "variant": {
+              "type": "string",
+              "const": "var"
+            },
+            "vault": {
+              "type": "string",
+              "const": "vault"
+            },
+            "workoutFormat": {
+              "type": "string",
+              "const": "wfmt"
+            }
+          },
+          "required": [
+            "allergy",
+            "assessment",
+            "audit",
+            "condition",
+            "document",
+            "event",
+            "experiment",
+            "family",
+            "food",
+            "goal",
+            "meal",
+            "pack",
+            "profileSnapshot",
+            "provider",
+            "recipe",
+            "protocol",
+            "sample",
+            "transform",
+            "variant",
+            "vault",
+            "workoutFormat"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "format",
+        "prefixes"
+      ],
+      "additionalProperties": false
+    },
+    "paths": {
+      "type": "object",
+      "properties": {
+        "allergiesRoot": {
+          "type": "string",
+          "const": "bank/allergies"
+        },
+        "assessmentLedgerRoot": {
+          "type": "string",
+          "const": "ledger/assessments"
+        },
+        "conditionsRoot": {
+          "type": "string",
+          "const": "bank/conditions"
+        },
+        "coreDocument": {
+          "type": "string",
+          "const": "CORE.md"
+        },
+        "familyRoot": {
+          "type": "string",
+          "const": "bank/family"
+        },
+        "foodsRoot": {
+          "type": "string",
+          "const": "bank/foods"
+        },
+        "geneticsRoot": {
+          "type": "string",
+          "const": "bank/genetics"
+        },
+        "goalsRoot": {
+          "type": "string",
+          "const": "bank/goals"
+        },
+        "journalRoot": {
+          "type": "string",
+          "const": "journal"
+        },
+        "experimentsRoot": {
+          "type": "string",
+          "const": "bank/experiments"
+        },
+        "profileCurrentDocument": {
+          "type": "string",
+          "const": "bank/profile/current.md"
+        },
+        "profileRoot": {
+          "type": "string",
+          "const": "bank/profile"
+        },
+        "profileSnapshotsRoot": {
+          "type": "string",
+          "const": "ledger/profile-snapshots"
+        },
+        "providersRoot": {
+          "type": "string",
+          "const": "bank/providers"
+        },
+        "recipesRoot": {
+          "type": "string",
+          "const": "bank/recipes"
+        },
+        "workoutFormatsRoot": {
+          "type": "string",
+          "const": "bank/workout-formats"
+        },
+        "rawAssessmentsRoot": {
+          "type": "string",
+          "const": "raw/assessments"
+        },
+        "rawRoot": {
+          "type": "string",
+          "const": "raw"
+        },
+        "eventsRoot": {
+          "type": "string",
+          "const": "ledger/events"
+        },
+        "protocolsRoot": {
+          "type": "string",
+          "const": "bank/protocols"
+        },
+        "samplesRoot": {
+          "type": "string",
+          "const": "ledger/samples"
+        },
+        "auditRoot": {
+          "type": "string",
+          "const": "audit"
+        },
+        "exportsRoot": {
+          "type": "string",
+          "const": "exports"
+        }
+      },
+      "required": [
+        "allergiesRoot",
+        "assessmentLedgerRoot",
+        "conditionsRoot",
+        "coreDocument",
+        "familyRoot",
+        "foodsRoot",
+        "geneticsRoot",
+        "goalsRoot",
+        "journalRoot",
+        "experimentsRoot",
+        "profileCurrentDocument",
+        "profileRoot",
+        "profileSnapshotsRoot",
+        "providersRoot",
+        "recipesRoot",
+        "workoutFormatsRoot",
+        "rawAssessmentsRoot",
+        "rawRoot",
+        "eventsRoot",
+        "protocolsRoot",
+        "samplesRoot",
+        "auditRoot",
+        "exportsRoot"
+      ],
+      "additionalProperties": false
+    },
+    "shards": {
+      "type": "object",
+      "properties": {
+        "assessments": {
+          "type": "string",
+          "const": "ledger/assessments/YYYY/YYYY-MM.jsonl"
+        },
+        "events": {
+          "type": "string",
+          "const": "ledger/events/YYYY/YYYY-MM.jsonl"
+        },
+        "profileSnapshots": {
+          "type": "string",
+          "const": "ledger/profile-snapshots/YYYY/YYYY-MM.jsonl"
+        },
+        "samples": {
+          "type": "string",
+          "const": "ledger/samples/<stream>/YYYY/YYYY-MM.jsonl"
+        },
+        "audit": {
+          "type": "string",
+          "const": "audit/YYYY/YYYY-MM.jsonl"
+        }
+      },
+      "required": [
+        "assessments",
+        "events",
+        "profileSnapshots",
+        "samples",
+        "audit"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "schemaVersion",
+    "vaultId",
+    "createdAt",
+    "title",
+    "timezone",
+    "idPolicy",
+    "paths",
+    "shards"
+  ],
+  "additionalProperties": false,
+  "$id": "@murphai/contracts/vault-metadata.schema.json",
+  "title": "Murph Vault Metadata"
+}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@murphai/contracts",
+  "version": "0.1.1",
+  "private": false,
+  "type": "module",
+  "license": "GPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cobuildwithus/murph"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "README.md",
+    "generated",
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./constants": {
+      "types": "./dist/constants.d.ts",
+      "import": "./dist/constants.js",
+      "default": "./dist/constants.js"
+    },
+    "./examples": {
+      "types": "./dist/examples.d.ts",
+      "import": "./dist/examples.js",
+      "default": "./dist/examples.js"
+    },
+    "./health-entities": {
+      "types": "./dist/health-entities.d.ts",
+      "import": "./dist/health-entities.js",
+      "default": "./dist/health-entities.js"
+    },
+    "./ids": {
+      "types": "./dist/ids.d.ts",
+      "import": "./dist/ids.js",
+      "default": "./dist/ids.js"
+    },
+    "./schemas": {
+      "types": "./dist/schemas.d.ts",
+      "import": "./dist/schemas.js",
+      "default": "./dist/schemas.js"
+    },
+    "./validate": {
+      "types": "./dist/validate.d.ts",
+      "import": "./dist/validate.js",
+      "default": "./dist/validate.js"
+    },
+    "./generated/*": "./generated/*"
+  },
+  "dependencies": {
+    "zod": "^4.3.6"
+  },
+  "scripts": {
+    "build": "node ../../scripts/rm-paths.mjs dist && tsc -b tsconfig.build.json --force --pretty false && tsc -p tsconfig.scripts.json --pretty false",
+    "typecheck": "tsc -p tsconfig.json --pretty false",
+    "generate": "pnpm build && node ./dist/scripts/generate-json-schema.js",
+    "test": "pnpm build && node ./dist/scripts/verify.js",
+    "verify": "pnpm test"
+  }
+}