@runfile-ai/schemas 0.1.0

package/generated/json-schema/manifest.json

@@ -0,0 +1,148 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema#",
+  "title": "manifest",
+  "description": "Runfile manifest schemas. Source: src/manifest.ts (Zod). Do not edit by hand.",
+  "$ref": "#/definitions/_RunfileBundle",
+  "definitions": {
+    "MerkleManifest": {
+      "type": "object",
+      "properties": {
+        "manifest_version": {
+          "type": "string",
+          "pattern": "^\\d+\\.\\d+\\.\\d+$"
+        },
+        "schema_version": {
+          "$ref": "#/definitions/MerkleManifest/properties/manifest_version"
+        },
+        "tenant_id": {
+          "type": "string",
+          "pattern": "^tnt_[0-9a-z]{12}$"
+        },
+        "day_utc": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+        },
+        "built_at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "leaf_count": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "merkle_root": {
+          "type": "string",
+          "pattern": "^sha256:[a-f0-9]{64}$"
+        },
+        "prev_manifest_root": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/MerkleManifest/properties/merkle_root"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "leaves": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "event_id": {
+                "type": "string",
+                "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+              },
+              "event_hash": {
+                "$ref": "#/definitions/MerkleManifest/properties/merkle_root"
+              },
+              "leaf_index": {
+                "type": "integer",
+                "minimum": 0
+              }
+            },
+            "required": [
+              "event_id",
+              "event_hash",
+              "leaf_index"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "kms_signature": {
+          "type": "object",
+          "properties": {
+            "kms_key_arn": {
+              "type": "string"
+            },
+            "signing_algorithm": {
+              "type": "string"
+            },
+            "signature_base64": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "kms_key_arn",
+            "signing_algorithm",
+            "signature_base64"
+          ],
+          "additionalProperties": false
+        },
+        "attestation_document": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "rekor_entry": {
+          "type": "object",
+          "properties": {
+            "log_index": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "log_id": {
+              "type": "string"
+            },
+            "inclusion_proof": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "log_index",
+            "log_id",
+            "inclusion_proof"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "manifest_version",
+        "schema_version",
+        "tenant_id",
+        "day_utc",
+        "built_at",
+        "leaf_count",
+        "merkle_root",
+        "prev_manifest_root",
+        "leaves",
+        "kms_signature",
+        "attestation_document"
+      ],
+      "additionalProperties": false
+    },
+    "_RunfileBundle": {
+      "type": "object",
+      "properties": {
+        "MerkleManifest": {
+          "$ref": "#/definitions/MerkleManifest"
+        }
+      },
+      "required": [
+        "MerkleManifest"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/generated/json-schema/vault.json

@@ -0,0 +1,468 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema#",
+  "title": "vault",
+  "description": "Runfile vault schemas. Source: src/vault.ts (Zod). Do not edit by hand.",
+  "$ref": "#/definitions/_RunfileBundle",
+  "definitions": {
+    "TokenizeRequest": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 4096
+        },
+        "classification": {
+          "type": "string",
+          "enum": [
+            "person_name",
+            "email",
+            "phone",
+            "address",
+            "dob",
+            "tax_id_partial",
+            "account_id",
+            "user_handle",
+            "other_identifier"
+          ]
+        },
+        "context": {
+          "type": "object",
+          "properties": {
+            "normalize": {
+              "type": "boolean",
+              "default": true
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "value",
+        "classification"
+      ],
+      "additionalProperties": false
+    },
+    "TokenizeResponse": {
+      "type": "object",
+      "properties": {
+        "token": {
+          "type": "string",
+          "pattern": "^tok_[A-Za-z0-9]{24}$"
+        },
+        "created": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "token",
+        "created"
+      ],
+      "additionalProperties": false
+    },
+    "TokenizeBatchRequest": {
+      "type": "object",
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TokenizeRequest"
+          },
+          "minItems": 1,
+          "maxItems": 100
+        }
+      },
+      "required": [
+        "items"
+      ],
+      "additionalProperties": false
+    },
+    "TokenizeBatchResponse": {
+      "type": "object",
+      "properties": {
+        "results": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TokenizeResponse"
+          }
+        }
+      },
+      "required": [
+        "results"
+      ],
+      "additionalProperties": false
+    },
+    "ResolveRequest": {
+      "type": "object",
+      "properties": {
+        "token": {
+          "$ref": "#/definitions/TokenizeResponse/properties/token"
+        },
+        "requester": {
+          "$ref": "#/definitions/RequesterContext"
+        },
+        "justification": {
+          "$ref": "#/definitions/Justification"
+        }
+      },
+      "required": [
+        "token",
+        "requester",
+        "justification"
+      ],
+      "additionalProperties": false
+    },
+    "ResolveResponse": {
+      "type": "object",
+      "properties": {
+        "token": {
+          "$ref": "#/definitions/TokenizeResponse/properties/token"
+        },
+        "value": {
+          "type": "string"
+        },
+        "classification": {
+          "type": "string"
+        },
+        "created_at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "audit_event_id": {
+          "type": "string",
+          "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+        }
+      },
+      "required": [
+        "token",
+        "value",
+        "classification",
+        "audit_event_id"
+      ],
+      "additionalProperties": false
+    },
+    "ResolveBatchRequest": {
+      "type": "object",
+      "properties": {
+        "tokens": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TokenizeResponse/properties/token"
+          },
+          "minItems": 1,
+          "maxItems": 100
+        },
+        "requester": {
+          "$ref": "#/definitions/RequesterContext"
+        },
+        "justification": {
+          "$ref": "#/definitions/Justification"
+        }
+      },
+      "required": [
+        "tokens",
+        "requester",
+        "justification"
+      ],
+      "additionalProperties": false
+    },
+    "ResolveBatchResponse": {
+      "type": "object",
+      "properties": {
+        "results": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ResolveBatchResult"
+          }
+        }
+      },
+      "required": [
+        "results"
+      ],
+      "additionalProperties": false
+    },
+    "ResolveBatchResult": {
+      "type": "object",
+      "properties": {
+        "token": {
+          "$ref": "#/definitions/TokenizeResponse/properties/token"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "resolved",
+            "not_found",
+            "tombstoned",
+            "denied"
+          ]
+        },
+        "value": {
+          "type": "string"
+        },
+        "tombstone_reason": {
+          "type": "string",
+          "enum": [
+            "retention_expired",
+            "rtbf_processed",
+            "tenant_offboarded"
+          ]
+        },
+        "denial_reason": {
+          "type": "string"
+        },
+        "audit_event_id": {
+          "$ref": "#/definitions/ResolveResponse/properties/audit_event_id"
+        }
+      },
+      "required": [
+        "token",
+        "status"
+      ],
+      "additionalProperties": false
+    },
+    "LifecycleRequest": {
+      "type": "object",
+      "properties": {
+        "action": {
+          "type": "string",
+          "enum": [
+            "tombstone_immediately",
+            "tombstone_at",
+            "place_on_legal_hold",
+            "release_legal_hold"
+          ]
+        },
+        "scheduled_at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "reason": {
+          "type": "string",
+          "minLength": 8,
+          "maxLength": 1024
+        },
+        "approver_member_id": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "action",
+        "reason"
+      ],
+      "additionalProperties": false
+    },
+    "LifecycleResponse": {
+      "type": "object",
+      "properties": {
+        "token": {
+          "$ref": "#/definitions/TokenizeResponse/properties/token"
+        },
+        "new_state": {
+          "type": "string",
+          "enum": [
+            "active",
+            "scheduled_for_tombstone",
+            "tombstoned",
+            "on_legal_hold"
+          ]
+        },
+        "scheduled_at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "audit_event_id": {
+          "$ref": "#/definitions/ResolveResponse/properties/audit_event_id"
+        }
+      },
+      "required": [
+        "token",
+        "new_state",
+        "audit_event_id"
+      ],
+      "additionalProperties": false
+    },
+    "RequesterContext": {
+      "type": "object",
+      "properties": {
+        "tenant_id": {
+          "type": "string",
+          "pattern": "^tnt_[0-9a-z]{12}$"
+        },
+        "member_id": {
+          "type": "string"
+        },
+        "role": {
+          "type": "string",
+          "enum": [
+            "compliance_officer",
+            "internal_auditor",
+            "external_auditor",
+            "workspace_admin",
+            "workspace_owner"
+          ]
+        },
+        "session_id": {
+          "type": "string"
+        },
+        "mfa_age_seconds": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "ip_address": {
+          "type": "string"
+        },
+        "user_agent": {
+          "type": "string",
+          "maxLength": 512
+        }
+      },
+      "required": [
+        "tenant_id",
+        "member_id",
+        "role",
+        "session_id",
+        "mfa_age_seconds"
+      ],
+      "additionalProperties": false
+    },
+    "Justification": {
+      "type": "object",
+      "properties": {
+        "engagement_id": {
+          "type": "string",
+          "pattern": "^eng_[0-9A-HJKMNP-TV-Z]{26}$"
+        },
+        "reason_code": {
+          "type": "string",
+          "enum": [
+            "sample_review",
+            "finding_investigation",
+            "escalation_workflow",
+            "rtbf_processing",
+            "regulatory_inquiry",
+            "other"
+          ]
+        },
+        "free_text": {
+          "type": "string",
+          "minLength": 8,
+          "maxLength": 1024
+        },
+        "approver_member_id": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "engagement_id",
+        "reason_code",
+        "free_text"
+      ],
+      "additionalProperties": false
+    },
+    "VaultError": {
+      "type": "object",
+      "properties": {
+        "error_code": {
+          "type": "string",
+          "enum": [
+            "unauthorized",
+            "forbidden",
+            "classification_not_vaultable",
+            "invalid_value",
+            "invalid_classification",
+            "rate_limited",
+            "mfa_too_old",
+            "engagement_not_active",
+            "engagement_scope_violation",
+            "approval_required",
+            "approval_invalid",
+            "token_not_found",
+            "token_tombstoned",
+            "lifecycle_conflict",
+            "internal_error"
+          ]
+        },
+        "error_message": {
+          "type": "string",
+          "maxLength": 1024
+        },
+        "request_id": {
+          "type": "string"
+        },
+        "retry_after_seconds": {
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "required": [
+        "error_code",
+        "error_message"
+      ],
+      "additionalProperties": false
+    },
+    "_RunfileBundle": {
+      "type": "object",
+      "properties": {
+        "TokenizeRequest": {
+          "$ref": "#/definitions/TokenizeRequest"
+        },
+        "TokenizeResponse": {
+          "$ref": "#/definitions/TokenizeResponse"
+        },
+        "TokenizeBatchRequest": {
+          "$ref": "#/definitions/TokenizeBatchRequest"
+        },
+        "TokenizeBatchResponse": {
+          "$ref": "#/definitions/TokenizeBatchResponse"
+        },
+        "ResolveRequest": {
+          "$ref": "#/definitions/ResolveRequest"
+        },
+        "ResolveResponse": {
+          "$ref": "#/definitions/ResolveResponse"
+        },
+        "ResolveBatchRequest": {
+          "$ref": "#/definitions/ResolveBatchRequest"
+        },
+        "ResolveBatchResponse": {
+          "$ref": "#/definitions/ResolveBatchResponse"
+        },
+        "ResolveBatchResult": {
+          "$ref": "#/definitions/ResolveBatchResult"
+        },
+        "LifecycleRequest": {
+          "$ref": "#/definitions/LifecycleRequest"
+        },
+        "LifecycleResponse": {
+          "$ref": "#/definitions/LifecycleResponse"
+        },
+        "RequesterContext": {
+          "$ref": "#/definitions/RequesterContext"
+        },
+        "Justification": {
+          "$ref": "#/definitions/Justification"
+        },
+        "VaultError": {
+          "$ref": "#/definitions/VaultError"
+        }
+      },
+      "required": [
+        "TokenizeRequest",
+        "TokenizeResponse",
+        "TokenizeBatchRequest",
+        "TokenizeBatchResponse",
+        "ResolveRequest",
+        "ResolveResponse",
+        "ResolveBatchRequest",
+        "ResolveBatchResponse",
+        "ResolveBatchResult",
+        "LifecycleRequest",
+        "LifecycleResponse",
+        "RequesterContext",
+        "Justification",
+        "VaultError"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@runfile-ai/schemas",
+  "version": "0.1.0",
+  "description": "Runfile event, ingest, vault, evidence, and manifest schemas. Source of truth in Zod; generates JSON Schema, Pydantic, and Go.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./event": "./dist/event.js",
+    "./ingest": "./dist/ingest.js",
+    "./vault": "./dist/vault.js",
+    "./evidence": "./dist/evidence.js",
+    "./manifest": "./dist/manifest.js",
+    "./control-mapping": "./dist/control-mapping.js",
+    "./canonical": "./dist/canonical.js",
+    "./json-schema/event.json": "./generated/json-schema/event.json",
+    "./json-schema/ingest.json": "./generated/json-schema/ingest.json",
+    "./json-schema/vault.json": "./generated/json-schema/vault.json"
+  },
+  "files": [
+    "dist",
+    "generated/json-schema"
+  ],
+  "dependencies": {
+    "canonicalize": "^2.0.0",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.7.0",
+    "@changesets/cli": "^2.31.0",
+    "@types/node": "^20.14.0",
+    "quicktype": "^23.2.6",
+    "tsx": "^4.16.2",
+    "typescript": "^5.5.3",
+    "vitest": "^2.0.0",
+    "zod-to-json-schema": "^3.23.1"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "generate": "tsx scripts/generate.ts",
+    "check-drift": "tsx scripts/check-drift.ts",
+    "publish-all": "tsx scripts/publish-all.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "tsc --noEmit",
+    "clean": "rm -rf dist generated/json-schema/*.json",
+    "changeset": "changeset",
+    "changeset:version": "changeset version",
+    "changeset:publish": "pnpm run build && changeset publish"
+  }
+}