@openvtc/trust-tasks 0.16.2 → 0.16.4

package/src/vault/credentials/receive/0.1/payload.ts

@@ -0,0 +1,298 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vault/credentials/receive/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Verify and store a W3C verifiable credential. Exactly one of `credential` or `credentialBase64` must be present.
+ */
+export type VaultCredentialsReceive = {
+  /**
+   * The verifiable credential as a JSON object.
+   */
+  credential?: {};
+  /**
+   * The credential base64url-encoded without padding, for formats whose canonical form is not JSON.
+   */
+  credentialBase64?: string;
+  /**
+   * Credential format, when not evident from the body. An unimplemented format is refused, not stored.
+   */
+  format?: string;
+  /**
+   * Local handle to store under. Absent, derived from the credential's own id. A handle, not a description — see Data carried.
+   */
+  id?: string;
+  /**
+   * Context to hold the credential in. Absent, the consumer's own.
+   */
+  contextId?: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+} & {
+  [k: string]: unknown | undefined;
+};
+
+export interface VaultCredentialsReceiveResponsePayload {
+  /**
+   * The handle the credential can now be fetched by.
+   */
+  id: string;
+  /**
+   * VC `type` tags the maintainer read.
+   */
+  types: string[];
+  /**
+   * Classification the maintainer derived. Never supplied by the consumer.
+   */
+  purpose?: string;
+  /**
+   * Validity the maintainer computed at storage time.
+   */
+  status: "valid" | "expired" | "revoked" | "unknown";
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vault/credentials/receive/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VaultCredentialsReceive;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vault/credentials/receive/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VaultCredentialsReceiveResponsePayload;
+
+/**
+ * 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/vault/credentials/receive/0.1",
+  "title": "Vault Credentials — Receive",
+  "description": "Verify and store a W3C verifiable credential. Exactly one of `credential` or `credentialBase64` must be present.",
+  "type": "object",
+  "additionalProperties": false,
+  "oneOf": [
+    {
+      "required": [
+        "credential"
+      ]
+    },
+    {
+      "required": [
+        "credentialBase64"
+      ]
+    }
+  ],
+  "properties": {
+    "credential": {
+      "type": "object",
+      "minProperties": 1,
+      "description": "The verifiable credential as a JSON object."
+    },
+    "credentialBase64": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1048576,
+      "pattern": "^[A-Za-z0-9_-]+$",
+      "description": "The credential base64url-encoded without padding, for formats whose canonical form is not JSON."
+    },
+    "format": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Credential format, when not evident from the body. An unimplemented format is refused, not stored."
+    },
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "Local handle to store under. Absent, derived from the credential's own id. A handle, not a description — see Data carried."
+    },
+    "contextId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "Context to hold the credential in. Absent, the consumer's own."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Vault Credentials Receive — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "types",
+        "status"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The handle the credential can now be fetched by."
+        },
+        "types": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256
+          },
+          "description": "VC `type` tags the maintainer read."
+        },
+        "purpose": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "Classification the maintainer derived. Never supplied by the consumer."
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "valid",
+            "expired",
+            "revoked",
+            "unknown"
+          ],
+          "description": "Validity the maintainer computed at storage time."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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": "Vault Credentials Receive — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "types",
+        "status"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The handle the credential can now be fetched by."
+        },
+        "types": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256
+          },
+          "description": "VC `type` tags the maintainer read."
+        },
+        "purpose": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "Classification the maintainer derived. Never supplied by the consumer."
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "valid",
+            "expired",
+            "revoked",
+            "unknown"
+          ],
+          "description": "Validity the maintainer computed at storage time."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: 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,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vault/credentials/restore/0.1/payload.ts

@@ -0,0 +1,217 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vault/credentials/restore/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Return a soft-deleted credential to the active state, while its grace window lasts.
+ */
+export interface VaultCredentialsRestore {
+  /**
+   * Local handle from a query descriptor. Opaque; consumers must not derive or guess one.
+   */
+  id: string;
+  /**
+   * Free text recorded with the transition. Must not carry credential contents.
+   */
+  reason?: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+export interface VaultCredentialsRestoreResponsePayload {
+  id: string;
+  /**
+   * State after the transition, echoed rather than left to be inferred from the verb.
+   */
+  lifecycle: "active" | "archived" | "deleted";
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vault/credentials/restore/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VaultCredentialsRestore;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vault/credentials/restore/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VaultCredentialsRestoreResponsePayload;
+
+/**
+ * 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/vault/credentials/restore/0.1",
+  "title": "Vault Credentials — Restore",
+  "description": "Return a soft-deleted credential to the active state, while its grace window lasts.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "Local handle from a query descriptor. Opaque; consumers must not derive or guess one."
+    },
+    "reason": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "Free text recorded with the transition. Must not carry credential contents."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Vault Credentials Restore — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "lifecycle"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "lifecycle": {
+          "$ref": "#/$defs/VaultLifecycle",
+          "description": "State after the transition, echoed rather than left to be inferred from the verb."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "VaultLifecycle": {
+      "type": "string",
+      "enum": [
+        "active",
+        "archived",
+        "deleted"
+      ],
+      "description": "Archival state. Orthogonal to validity."
+    },
+    "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": "Vault Credentials Restore — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "lifecycle"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "lifecycle": {
+          "$ref": "#/$defs/VaultLifecycle",
+          "description": "State after the transition, echoed rather than left to be inferred from the verb."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "VaultLifecycle": {
+      "type": "string",
+      "enum": [
+        "active",
+        "archived",
+        "deleted"
+      ],
+      "description": "Archival state. Orthogonal to validity."
+    },
+    "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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: 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,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;