@openvtc/trust-tasks 0.9.0 → 0.11.0

package/src/vta/contexts/preview-delete/1.0/payload.ts

@@ -0,0 +1,267 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/contexts/preview-delete/1.0/payload.schema.json
+ */
+
+/**
+ * Request payload for vta/contexts/preview-delete: what deleting this context would destroy, computed without destroying it.
+ */
+export interface VTAContextsPreviewDeletePayload {
+  /**
+   * Context to preview the deletion of.
+   */
+  id: string;
+  ext?: Ext;
+}
+/**
+ * Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Success response to vta/contexts/preview-delete. Every array is what WOULD be affected; nothing has been. Type https://trusttasks.org/spec/vta/contexts/preview-delete/1.0#response.
+ */
+export interface VTAContextsPreviewDeleteResponsePayload {
+  /**
+   * The context previewed.
+   */
+  id: string;
+  /**
+   * Key ids that would be destroyed. A derived key can be re-derived from the seed; an internally-generated one cannot be recovered by any means, and this list does not distinguish them — a consumer rendering it for a human SHOULD resolve each key before presenting the choice.
+   */
+  keys: string[];
+  /**
+   * did:webvh DIDs that would stop being served. Anything that recorded one as an issuer or subject is left pointing at nothing.
+   */
+  webvhDids: string[];
+  /**
+   * Subjects whose ACL entry would be removed outright, because this context was its only scope.
+   */
+  aclEntriesRemoved: string[];
+  /**
+   * Subjects whose ACL entry would be narrowed — they hold other scopes and keep them.
+   */
+  aclEntriesUpdated: string[];
+  /**
+   * DID templates scoped to this context that would be removed.
+   */
+  didTemplates?: string[];
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/contexts/preview-delete/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAContextsPreviewDeletePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/contexts/preview-delete/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAContextsPreviewDeleteResponsePayload;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/vta/contexts/preview-delete/1.0",
+  "title": "VTA Contexts Preview-Delete — payload",
+  "description": "Request payload for vta/contexts/preview-delete: what deleting this context would destroy, computed without destroying it.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Context to preview the deletion of."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Contexts Preview-Delete — response payload",
+      "description": "Success response to vta/contexts/preview-delete. Every array is what WOULD be affected; nothing has been. Type https://trusttasks.org/spec/vta/contexts/preview-delete/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "keys",
+        "webvhDids",
+        "aclEntriesRemoved",
+        "aclEntriesUpdated"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "The context previewed."
+        },
+        "keys": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Key ids that would be destroyed. A derived key can be re-derived from the seed; an internally-generated one cannot be recovered by any means, and this list does not distinguish them — a consumer rendering it for a human SHOULD resolve each key before presenting the choice."
+        },
+        "webvhDids": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "did:webvh DIDs that would stop being served. Anything that recorded one as an issuer or subject is left pointing at nothing."
+        },
+        "aclEntriesRemoved": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Subjects whose ACL entry would be removed outright, because this context was its only scope."
+        },
+        "aclEntriesUpdated": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Subjects whose ACL entry would be narrowed — they hold other scopes and keep them."
+        },
+        "didTemplates": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "DID templates scoped to this context that would be removed."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Contexts Preview-Delete — response payload",
+      "description": "Success response to vta/contexts/preview-delete. Every array is what WOULD be affected; nothing has been. Type https://trusttasks.org/spec/vta/contexts/preview-delete/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "keys",
+        "webvhDids",
+        "aclEntriesRemoved",
+        "aclEntriesUpdated"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "The context previewed."
+        },
+        "keys": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Key ids that would be destroyed. A derived key can be re-derived from the seed; an internally-generated one cannot be recovered by any means, and this list does not distinguish them — a consumer rendering it for a human SHOULD resolve each key before presenting the choice."
+        },
+        "webvhDids": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "did:webvh DIDs that would stop being served. Anything that recorded one as an issuer or subject is left pointing at nothing."
+        },
+        "aclEntriesRemoved": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Subjects whose ACL entry would be removed outright, because this context was its only scope."
+        },
+        "aclEntriesUpdated": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Subjects whose ACL entry would be narrowed — they hold other scopes and keep them."
+        },
+        "didTemplates": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "DID templates scoped to this context that would be removed."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: false,
+  isRecipientRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: false,
+  isRecipientRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vta/contexts/update/1.0/payload.ts

@@ -0,0 +1,421 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/contexts/update/1.0/payload.schema.json
+ */
+
+/**
+ * Request payload for vta/contexts/update. Every member except `id` is optional and omitting one leaves that field unchanged — this is a patch, not a replacement.
+ */
+export interface VTAContextsUpdatePayload {
+  /**
+   * Context to update. Not itself changeable: an id is what ACL scopes name, so renaming one would silently unhook every grant that referenced it.
+   */
+  id: string;
+  /**
+   * New human-readable name.
+   */
+  name?: string;
+  /**
+   * DID this context acts as. Prefer vta/contexts/update-did, which is the task named and audited for this change; setting it here is permitted for a maintainer that treats the two as one write.
+   */
+  did?: string;
+  /**
+   * New description.
+   */
+  description?: string;
+  contextPolicy?: ContextPolicy;
+  ext?: Ext;
+}
+/**
+ * Replacement policy for the context. Supplied whole: the members present in the new policy are the policy, and one omitted from it becomes unrestricted rather than retaining its previous value.
+ */
+export interface ContextPolicy {
+  /**
+   * VIDs permitted to receive presentations from this context. Absent: any verifier. Present-but-empty: none.
+   */
+  trustedVerifiers?: string[];
+  /**
+   * Credential types that may be presented from this context. Absent: any type. Present-but-empty: none.
+   */
+  presentableTypes?: string[];
+  /**
+   * Key ids the signing oracle may be invoked on within this context. Absent: every key the context holds. Present-but-empty: no keys.
+   */
+  signableKeys?: string[];
+  /**
+   * Whether material in this context may leave it through an export. Defaults to true; set it to false for a context whose contents must not be extractable.
+   */
+  exportAllowed?: boolean;
+  /**
+   * Resource limits for the context. Shape is maintainer-defined.
+   */
+  quotas?: {
+    [k: string]: unknown | undefined;
+  };
+  ext?: Ext;
+}
+/**
+ * Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+/**
+ * A context as the VTA holds it.
+ */
+export interface ContextRecord {
+  /**
+   * Context id. For a nested context this is the full path (`parent/leaf`), not the leaf alone — an ACL scope naming this context must use this value verbatim.
+   */
+  id: string;
+  /**
+   * Human-readable name. Operator-facing only; carries no authorization meaning, and two contexts may share a name.
+   */
+  name: string;
+  /**
+   * DID this context acts as, when one has been assigned. Absent means the context has no identity of its own yet — not that it has been denied one.
+   */
+  did?: string;
+  /**
+   * Free-form description.
+   */
+  description?: string;
+  /**
+   * Id of the context this one nests under. Absent for a top-level context. Authority granted at a parent reaches its children, so this member is load-bearing for anyone reasoning about scope.
+   */
+  parent?: string;
+  /**
+   * Resolved path from the root context, as the VTA derives it from the parent chain. Consumers MUST treat this as derived state: it is recomputed by the maintainer and is not independently settable.
+   */
+  basePath: string;
+  /**
+   * RFC 3339.
+   */
+  createdAt: string;
+  /**
+   * RFC 3339.
+   */
+  updatedAt: string;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/contexts/update/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAContextsUpdatePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/contexts/update/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = ContextRecord;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/vta/contexts/update/1.0",
+  "title": "VTA Contexts Update — payload",
+  "description": "Request payload for vta/contexts/update. Every member except `id` is optional and omitting one leaves that field unchanged — this is a patch, not a replacement.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Context to update. Not itself changeable: an id is what ACL scopes name, so renaming one would silently unhook every grant that referenced it."
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "description": "New human-readable name."
+    },
+    "did": {
+      "type": "string",
+      "description": "DID this context acts as. Prefer vta/contexts/update-did, which is the task named and audited for this change; setting it here is permitted for a maintainer that treats the two as one write."
+    },
+    "description": {
+      "type": "string",
+      "description": "New description."
+    },
+    "contextPolicy": {
+      "$ref": "#/$defs/ContextPolicy",
+      "description": "Replacement policy for the context. Supplied whole: the members present in the new policy are the policy, and one omitted from it becomes unrestricted rather than retaining its previous value."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Contexts Update — response payload",
+      "description": "Success response to vta/contexts/update: the context as it now stands. Type https://trusttasks.org/spec/vta/contexts/update/1.0#response.",
+      "$ref": "#/$defs/ContextRecord"
+    },
+    "ContextRecord": {
+      "title": "ContextRecord",
+      "description": "A context as the VTA holds it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "basePath",
+        "createdAt",
+        "updatedAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Context id. For a nested context this is the full path (`parent/leaf`), not the leaf alone — an ACL scope naming this context must use this value verbatim."
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Human-readable name. Operator-facing only; carries no authorization meaning, and two contexts may share a name."
+        },
+        "did": {
+          "type": "string",
+          "description": "DID this context acts as, when one has been assigned. Absent means the context has no identity of its own yet — not that it has been denied one."
+        },
+        "description": {
+          "type": "string",
+          "description": "Free-form description."
+        },
+        "parent": {
+          "type": "string",
+          "description": "Id of the context this one nests under. Absent for a top-level context. Authority granted at a parent reaches its children, so this member is load-bearing for anyone reasoning about scope."
+        },
+        "basePath": {
+          "type": "string",
+          "description": "Resolved path from the root context, as the VTA derives it from the parent chain. Consumers MUST treat this as derived state: it is recomputed by the maintainer and is not independently settable."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "ContextPolicy": {
+      "title": "ContextPolicy",
+      "description": "Per-context restrictions the VTA enforces. Every member is optional, and **absence means unrestricted, not empty** — a policy that omits `presentableTypes` permits every type, while one that sets it to `[]` permits none. The two are opposite instructions and a consumer MUST NOT collapse them.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "trustedVerifiers": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "VIDs permitted to receive presentations from this context. Absent: any verifier. Present-but-empty: none."
+        },
+        "presentableTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Credential types that may be presented from this context. Absent: any type. Present-but-empty: none."
+        },
+        "signableKeys": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Key ids the signing oracle may be invoked on within this context. Absent: every key the context holds. Present-but-empty: no keys."
+        },
+        "exportAllowed": {
+          "type": "boolean",
+          "default": true,
+          "description": "Whether material in this context may leave it through an export. Defaults to true; set it to false for a context whose contents must not be extractable."
+        },
+        "quotas": {
+          "type": "object",
+          "description": "Resource limits for the context. Shape is maintainer-defined.",
+          "additionalProperties": true
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Contexts Update — response payload",
+      "description": "Success response to vta/contexts/update: the context as it now stands. Type https://trusttasks.org/spec/vta/contexts/update/1.0#response.",
+      "$ref": "#/$defs/ContextRecord"
+    },
+    "ContextRecord": {
+      "title": "ContextRecord",
+      "description": "A context as the VTA holds it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "basePath",
+        "createdAt",
+        "updatedAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Context id. For a nested context this is the full path (`parent/leaf`), not the leaf alone — an ACL scope naming this context must use this value verbatim."
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Human-readable name. Operator-facing only; carries no authorization meaning, and two contexts may share a name."
+        },
+        "did": {
+          "type": "string",
+          "description": "DID this context acts as, when one has been assigned. Absent means the context has no identity of its own yet — not that it has been denied one."
+        },
+        "description": {
+          "type": "string",
+          "description": "Free-form description."
+        },
+        "parent": {
+          "type": "string",
+          "description": "Id of the context this one nests under. Absent for a top-level context. Authority granted at a parent reaches its children, so this member is load-bearing for anyone reasoning about scope."
+        },
+        "basePath": {
+          "type": "string",
+          "description": "Resolved path from the root context, as the VTA derives it from the parent chain. Consumers MUST treat this as derived state: it is recomputed by the maintainer and is not independently settable."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC 3339."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "ContextPolicy": {
+      "title": "ContextPolicy",
+      "description": "Per-context restrictions the VTA enforces. Every member is optional, and **absence means unrestricted, not empty** — a policy that omits `presentableTypes` permits every type, while one that sets it to `[]` permits none. The two are opposite instructions and a consumer MUST NOT collapse them.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "trustedVerifiers": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "VIDs permitted to receive presentations from this context. Absent: any verifier. Present-but-empty: none."
+        },
+        "presentableTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Credential types that may be presented from this context. Absent: any type. Present-but-empty: none."
+        },
+        "signableKeys": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Key ids the signing oracle may be invoked on within this context. Absent: every key the context holds. Present-but-empty: no keys."
+        },
+        "exportAllowed": {
+          "type": "boolean",
+          "default": true,
+          "description": "Whether material in this context may leave it through an export. Defaults to true; set it to false for a context whose contents must not be extractable."
+        },
+        "quotas": {
+          "type": "object",
+          "description": "Resource limits for the context. Shape is maintainer-defined.",
+          "additionalProperties": true
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;