@empire-builder-kit/nx 1.0.0-beta.9 → 1.0.0-rc.2

package/src/schemas/data-lifecycle-policy-v1.json

@@ -0,0 +1,517 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://empirebuilderkit.dev/schemas/data-lifecycle-policy-v1.json",
+  "$comment": "Structural interchange schema only. Semantic references, classification inheritance, review dates, backup coverage, restore behavior, and production coverage require normalizeDataLifecycleDescriptor from @empire-builder-kit/nx/data-lifecycle.",
+  "title": "Empire Builder Kit data lifecycle policy v1 structural schema",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "backups",
+    "categories",
+    "copies",
+    "governance",
+    "holds",
+    "kind",
+    "lineage",
+    "policyVersion",
+    "restorePlans",
+    "schemaVersion",
+    "slice",
+    "stores"
+  ],
+  "properties": {
+    "backups": {
+      "type": "array",
+      "maxItems": 1000,
+      "items": { "$ref": "#/$defs/backup" }
+    },
+    "categories": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 1000,
+      "items": { "$ref": "#/$defs/category" }
+    },
+    "copies": {
+      "type": "array",
+      "maxItems": 1000,
+      "items": { "$ref": "#/$defs/copy" }
+    },
+    "governance": { "$ref": "#/$defs/governance" },
+    "holds": {
+      "type": "array",
+      "maxItems": 1000,
+      "items": { "$ref": "#/$defs/hold" }
+    },
+    "kind": { "const": "ebk-data-lifecycle-policy" },
+    "ledger": { "$ref": "#/$defs/ledger" },
+    "lineage": {
+      "type": "array",
+      "maxItems": 1000,
+      "items": { "$ref": "#/$defs/lineage" }
+    },
+    "policyVersion": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)$"
+    },
+    "restorePlans": {
+      "type": "array",
+      "maxItems": 1000,
+      "items": { "$ref": "#/$defs/restorePlan" }
+    },
+    "schemaVersion": { "const": 1 },
+    "slice": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]{0,62}$"
+    },
+    "stores": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 1000,
+      "items": { "$ref": "#/$defs/store" }
+    }
+  },
+  "$defs": {
+    "action": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]{0,62}:[a-z][a-z0-9-]{0,62}$"
+    },
+    "backup": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "backupStoreId",
+        "categoryIds",
+        "developmentCopy",
+        "disasterRecoveryUse",
+        "id",
+        "restoreOnly",
+        "restorePlanId",
+        "retention",
+        "sourceStoreId"
+      ],
+      "properties": {
+        "backupStoreId": { "$ref": "#/$defs/id" },
+        "categoryIds": { "$ref": "#/$defs/idList" },
+        "developmentCopy": { "const": "prohibited" },
+        "disasterRecoveryUse": { "const": "only" },
+        "id": { "$ref": "#/$defs/id" },
+        "restoreOnly": { "const": true },
+        "restorePlanId": { "$ref": "#/$defs/id" },
+        "retention": { "$ref": "#/$defs/retention" },
+        "sourceStoreId": { "$ref": "#/$defs/id" }
+      }
+    },
+    "category": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "allowedUses",
+        "classification",
+        "description",
+        "evidenceRefs",
+        "id",
+        "ingress",
+        "owner",
+        "primaryStoreIds",
+        "provenance",
+        "purpose",
+        "rights",
+        "runbookRefs",
+        "sensitiveTypes",
+        "steward",
+        "subject"
+      ],
+      "properties": {
+        "allowedUses": { "$ref": "#/$defs/tokenList" },
+        "classification": { "$ref": "#/$defs/classification" },
+        "description": { "$ref": "#/$defs/text" },
+        "evidenceRefs": { "$ref": "#/$defs/optionalTokenList" },
+        "id": { "$ref": "#/$defs/id" },
+        "ingress": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 1000,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["authorizationAction", "contractRef", "validationRef"],
+            "properties": {
+              "authorizationAction": { "$ref": "#/$defs/action" },
+              "contractRef": { "$ref": "#/$defs/token" },
+              "validationRef": { "$ref": "#/$defs/token" }
+            }
+          }
+        },
+        "owner": { "$ref": "#/$defs/token" },
+        "primaryStoreIds": { "$ref": "#/$defs/idList" },
+        "provenance": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 1000,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind", "sourceRef"],
+            "properties": {
+              "kind": {
+                "enum": [
+                  "subject",
+                  "operator",
+                  "product-agent",
+                  "slice",
+                  "external-provider",
+                  "derived"
+                ]
+              },
+              "sourceRef": { "$ref": "#/$defs/token" }
+            }
+          }
+        },
+        "purpose": { "$ref": "#/$defs/text" },
+        "rights": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["correction", "deletion", "export", "rationale"],
+          "properties": {
+            "correction": {
+              "enum": ["supported", "not-applicable"]
+            },
+            "deletion": {
+              "enum": ["supported", "not-applicable"]
+            },
+            "export": {
+              "enum": ["supported", "not-applicable"]
+            },
+            "rationale": { "$ref": "#/$defs/text" }
+          }
+        },
+        "runbookRefs": { "$ref": "#/$defs/optionalTokenList" },
+        "sensitiveTypes": { "$ref": "#/$defs/optionalTokenList" },
+        "steward": { "$ref": "#/$defs/token" },
+        "subject": { "$ref": "#/$defs/text" }
+      }
+    },
+    "classification": {
+      "enum": ["public", "internal", "confidential", "regulated"]
+    },
+    "copy": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "categoryIds",
+        "deletionPropagation",
+        "handling",
+        "id",
+        "kind",
+        "purpose",
+        "retention",
+        "sourceStoreIds",
+        "storeId"
+      ],
+      "properties": {
+        "categoryIds": { "$ref": "#/$defs/idList" },
+        "deletionPropagation": {
+          "enum": ["local", "contract-event", "recipient-owned"]
+        },
+        "handling": {
+          "enum": ["raw", "pseudonymous", "redacted", "aggregated"]
+        },
+        "id": { "$ref": "#/$defs/id" },
+        "kind": {
+          "enum": [
+            "index",
+            "materialized-view",
+            "cache",
+            "search",
+            "event",
+            "queue",
+            "dlq",
+            "replay-archive",
+            "log",
+            "trace",
+            "metric",
+            "browser-cookie",
+            "browser-storage",
+            "client-cache",
+            "export",
+            "backup",
+            "test-fixture",
+            "derived",
+            "downstream"
+          ]
+        },
+        "purpose": { "$ref": "#/$defs/text" },
+        "recipient": { "$ref": "#/$defs/token" },
+        "retention": { "$ref": "#/$defs/retention" },
+        "sourceStoreIds": { "$ref": "#/$defs/idList" },
+        "storeId": { "$ref": "#/$defs/id" }
+      }
+    },
+    "governance": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["owner", "reviewDueAt", "reviewedAt", "steward"],
+      "properties": {
+        "owner": { "$ref": "#/$defs/token" },
+        "reviewDueAt": { "type": "string", "format": "date-time" },
+        "reviewedAt": { "type": "string", "format": "date-time" },
+        "steward": { "$ref": "#/$defs/token" }
+      }
+    },
+    "hold": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "categoryIds",
+        "effects",
+        "expiresAt",
+        "id",
+        "issuerRef",
+        "purpose",
+        "reviewAt",
+        "scopeRef",
+        "startsAt",
+        "status"
+      ],
+      "properties": {
+        "categoryIds": { "$ref": "#/$defs/idList" },
+        "effects": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "enum": ["block-deletion", "block-export"]
+          }
+        },
+        "expiresAt": { "type": "string", "format": "date-time" },
+        "id": { "$ref": "#/$defs/id" },
+        "issuerRef": { "$ref": "#/$defs/token" },
+        "purpose": {
+          "enum": ["legal", "security", "fraud", "support", "incident"]
+        },
+        "releasedAt": { "type": "string", "format": "date-time" },
+        "reviewAt": { "type": "string", "format": "date-time" },
+        "scopeRef": { "$ref": "#/$defs/token" },
+        "startsAt": { "type": "string", "format": "date-time" },
+        "status": { "enum": ["active", "released"] }
+      }
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:[.-][a-z0-9]+){0,15}$"
+    },
+    "idList": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 1000,
+      "uniqueItems": true,
+      "items": { "$ref": "#/$defs/id" }
+    },
+    "ledger": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "actions",
+        "backupIdsCovered",
+        "classification",
+        "keyMaterial",
+        "retention",
+        "storeId"
+      ],
+      "properties": {
+        "actions": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": { "enum": ["correction", "deletion"] }
+        },
+        "backupIdsCovered": { "$ref": "#/$defs/idList" },
+        "classification": { "const": "confidential" },
+        "keyMaterial": { "const": "pseudonymous-only" },
+        "retention": { "$ref": "#/$defs/retention" },
+        "storeId": { "$ref": "#/$defs/id" }
+      }
+    },
+    "lineage": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "categoryIds",
+        "from",
+        "id",
+        "minimization",
+        "purpose",
+        "to",
+        "transport"
+      ],
+      "properties": {
+        "categoryIds": { "$ref": "#/$defs/idList" },
+        "from": { "$ref": "#/$defs/lineageEndpoint" },
+        "id": { "$ref": "#/$defs/id" },
+        "minimization": { "$ref": "#/$defs/text" },
+        "purpose": { "$ref": "#/$defs/text" },
+        "recipient": { "$ref": "#/$defs/token" },
+        "to": { "$ref": "#/$defs/lineageEndpoint" },
+        "transport": {
+          "enum": ["api", "event", "derived", "backup", "export"]
+        }
+      }
+    },
+    "lineageEndpoint": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "kind"],
+      "properties": {
+        "id": { "$ref": "#/$defs/id" },
+        "kind": { "enum": ["category", "store", "copy"] }
+      }
+    },
+    "optionalTokenList": {
+      "type": "array",
+      "maxItems": 1000,
+      "uniqueItems": true,
+      "items": { "$ref": "#/$defs/token" }
+    },
+    "restorePlan": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "authorization",
+        "backupId",
+        "deletionCorrectionReplay",
+        "downstreamReconciliation",
+        "id",
+        "integrityValidation",
+        "isolatedTarget",
+        "retentionJobs",
+        "runbookRef"
+      ],
+      "properties": {
+        "authorization": { "const": "required" },
+        "backupId": { "$ref": "#/$defs/id" },
+        "deletionCorrectionReplay": {
+          "const": "required-before-service"
+        },
+        "downstreamReconciliation": {
+          "const": "required-before-service"
+        },
+        "id": { "$ref": "#/$defs/id" },
+        "integrityValidation": { "const": "required" },
+        "isolatedTarget": { "const": "required" },
+        "retentionJobs": { "const": "required-before-service" },
+        "runbookRef": { "$ref": "#/$defs/token" }
+      }
+    },
+    "retention": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["deletionMethod", "durationDays", "reason", "trigger"],
+      "properties": {
+        "deletionMethod": {
+          "enum": [
+            "hard-delete",
+            "lifecycle-expiry",
+            "cryptographic-erasure",
+            "tombstone-then-delete"
+          ]
+        },
+        "durationDays": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 36500
+        },
+        "reason": { "$ref": "#/$defs/text" },
+        "trigger": {
+          "enum": [
+            "collection",
+            "last-activity",
+            "contract-end",
+            "event-completion",
+            "copy-created"
+          ]
+        }
+      }
+    },
+    "store": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "accessPurposes",
+        "categoryIds",
+        "classification",
+        "encryption",
+        "id",
+        "kind",
+        "locationRef",
+        "owner",
+        "production",
+        "residency",
+        "retention"
+      ],
+      "properties": {
+        "accessPurposes": { "$ref": "#/$defs/tokenList" },
+        "categoryIds": { "$ref": "#/$defs/idList" },
+        "classification": { "$ref": "#/$defs/classification" },
+        "encryption": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["atRest", "inTransit", "keyOwner"],
+          "properties": {
+            "atRest": { "const": "required" },
+            "inTransit": { "const": "required" },
+            "keyOwner": { "$ref": "#/$defs/token" }
+          }
+        },
+        "id": { "$ref": "#/$defs/id" },
+        "kind": {
+          "enum": [
+            "database",
+            "object-store",
+            "cache",
+            "search",
+            "audit",
+            "log",
+            "trace",
+            "event-archive",
+            "queue",
+            "dlq",
+            "browser",
+            "client",
+            "export",
+            "backup",
+            "test-fixture"
+          ]
+        },
+        "locationRef": { "$ref": "#/$defs/token" },
+        "owner": { "$ref": "#/$defs/token" },
+        "production": { "type": "boolean" },
+        "residency": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "pattern": "^[a-z]{2}(-gov)?-[a-z]+-[0-9]$"
+          }
+        },
+        "retention": { "$ref": "#/$defs/retention" }
+      }
+    },
+    "text": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512
+    },
+    "token": {
+      "type": "string",
+      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/@#-]{0,255}$"
+    },
+    "tokenList": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 1000,
+      "uniqueItems": true,
+      "items": { "$ref": "#/$defs/token" }
+    }
+  }
+}

package/src/schemas/generated-ownership-v2.json

@@ -12,6 +12,25 @@
       "required": ["name", "version"],
       "type": "object"
     },
+    "compositions": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "feature": {
+            "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$",
+            "type": "string"
+          },
+          "kind": { "enum": ["function", "job", "service"] },
+          "name": {
+            "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$",
+            "type": "string"
+          }
+        },
+        "required": ["feature", "kind", "name"],
+        "type": "object"
+      },
+      "type": "array"
+    },
     "contracts": {
       "additionalProperties": false,
       "properties": {
@@ -98,6 +117,8 @@
     "slice": { "minLength": 1, "type": "string" },
     "verification": {
       "items": { "minLength": 1, "type": "string" },
+      "maxItems": 1,
+      "minItems": 1,
       "type": "array"
     }
   },
@@ -105,6 +126,7 @@
     "schemaVersion",
     "slice",
     "blueprint",
+    "compositions",
     "foundation",
     "inputs",
     "paths",