@openvtc/trust-tasks 0.16.3 → 0.16.5

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

@@ -0,0 +1,217 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vault/credentials/unarchive/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Return an archived credential to the active state.
+ */
+export interface VaultCredentialsUnarchive {
+  /**
+   * 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 VaultCredentialsUnarchiveResponsePayload {
+  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/unarchive/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VaultCredentialsUnarchive;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vault/credentials/unarchive/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VaultCredentialsUnarchiveResponsePayload;
+
+/**
+ * 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/unarchive/0.1",
+  "title": "Vault Credentials — Unarchive",
+  "description": "Return an archived credential to the active state.",
+  "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 Unarchive — 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 Unarchive — 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;

package/src/vta/credentials/list/0.1/payload.ts

@@ -0,0 +1,420 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/credentials/list/0.1/payload.schema.json
+ */
+
+import type { CredentialId, Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Derived at read time. `revoked` takes precedence over `expired`: a credential revoked before its window closed is revoked, and reporting it as merely expired would hide that somebody acted.
+ */
+export type IssuedCredentialStatus = "active" | "expired" | "revoked";
+
+/**
+ * Enumerate the credentials an agent has issued, as metadata. Every filter is optional and those present are AND-combined.
+ */
+export interface VTACredentialsList {
+  /**
+   * Only credentials issued to this DID.
+   */
+  holder?: string;
+  /**
+   * Only credentials carrying this type tag beyond `VerifiableCredential`.
+   */
+  credentialType?: string;
+  /**
+   * Only credentials in this state. Derived by the agent at read time, never stored.
+   */
+  status?: "active" | "expired" | "revoked";
+  /**
+   * Maximum records to return. The agent MAY return fewer and caps this value.
+   */
+  pageSize?: number;
+  /**
+   * Continue a previous page. Opaque — consumers must not construct or parse one.
+   */
+  cursor?: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+export interface VTACredentialsListResponsePayload {
+  /**
+   * One summary per matching credential. Empty when nothing matched — a successful answer, not an error.
+   */
+  credentials: IssuedCredentialSummary[];
+  /**
+   * The agent stopped early. A consumer must not read a truncated page as a complete account of what was issued.
+   */
+  truncated: boolean;
+  /**
+   * Pass to the next request to continue. Absent when the page is the last.
+   */
+  cursor?: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * A body-free projection of an issuance record. Carries no claim content by construction — see the specification's rationale for why a list does not return credentials.
+ */
+export interface IssuedCredentialSummary {
+  /**
+   * The id `vta/credentials/revoke` is keyed on.
+   */
+  credentialId: CredentialId;
+  /**
+   * Who the credential was issued to.
+   */
+  holder: string;
+  /**
+   * The type tag beyond `VerifiableCredential`, when the credential carries one.
+   */
+  credentialType?: string;
+  issuedAt: string;
+  expiresAt: string;
+  status: IssuedCredentialStatus;
+  /**
+   * Present iff `status` is `revoked`.
+   */
+  revokedAt?: string;
+  /**
+   * Free text recorded at revocation. Disclosed to every caller entitled to this list — see Security & Privacy.
+   */
+  revocationReason?: string;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CredentialId, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/credentials/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTACredentialsList;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/credentials/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTACredentialsListResponsePayload;
+
+/**
+ * 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/credentials/list/0.1",
+  "title": "VTA Credentials — List",
+  "description": "Enumerate the credentials an agent has issued, as metadata. Every filter is optional and those present are AND-combined.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "holder": {
+      "$ref": "#/$defs/Did",
+      "description": "Only credentials issued to this DID."
+    },
+    "credentialType": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "Only credentials carrying this type tag beyond `VerifiableCredential`."
+    },
+    "status": {
+      "$ref": "#/$defs/IssuedCredentialStatus",
+      "description": "Only credentials in this state. Derived by the agent at read time, never stored."
+    },
+    "pageSize": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 1000,
+      "description": "Maximum records to return. The agent MAY return fewer and caps this value."
+    },
+    "cursor": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 4096,
+      "description": "Continue a previous page. Opaque — consumers must not construct or parse one."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Credentials List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credentials",
+        "truncated"
+      ],
+      "properties": {
+        "credentials": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/IssuedCredentialSummary"
+          },
+          "description": "One summary per matching credential. Empty when nothing matched — a successful answer, not an error."
+        },
+        "truncated": {
+          "type": "boolean",
+          "description": "The agent stopped early. A consumer must not read a truncated page as a complete account of what was issued."
+        },
+        "cursor": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 4096,
+          "description": "Pass to the next request to continue. Absent when the page is the last."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "IssuedCredentialSummary": {
+      "title": "IssuedCredentialSummary",
+      "description": "A body-free projection of an issuance record. Carries no claim content by construction — see the specification's rationale for why a list does not return credentials.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credentialId",
+        "holder",
+        "issuedAt",
+        "expiresAt",
+        "status"
+      ],
+      "properties": {
+        "credentialId": {
+          "$ref": "#/$defs/CredentialId",
+          "description": "The id `vta/credentials/revoke` is keyed on."
+        },
+        "holder": {
+          "$ref": "#/$defs/Did",
+          "description": "Who the credential was issued to."
+        },
+        "credentialType": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The type tag beyond `VerifiableCredential`, when the credential carries one."
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "status": {
+          "$ref": "#/$defs/IssuedCredentialStatus"
+        },
+        "revokedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present iff `status` is `revoked`."
+        },
+        "revocationReason": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Free text recorded at revocation. Disclosed to every caller entitled to this list — see Security & Privacy."
+        }
+      }
+    },
+    "IssuedCredentialStatus": {
+      "type": "string",
+      "enum": [
+        "active",
+        "expired",
+        "revoked"
+      ],
+      "description": "Derived at read time. `revoked` takes precedence over `expired`: a credential revoked before its window closed is revoked, and reporting it as merely expired would hide that somebody acted."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048
+    },
+    "CredentialId": {
+      "$anchor": "credentialId",
+      "title": "CredentialId",
+      "description": "Stable identifier for an issued credential — the handle for revocation and audit. Opaque to the holder: it MUST be echoed verbatim when revoking and MUST NOT be parsed.",
+      "type": "string",
+      "minLength": 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": "VTA Credentials List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credentials",
+        "truncated"
+      ],
+      "properties": {
+        "credentials": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/IssuedCredentialSummary"
+          },
+          "description": "One summary per matching credential. Empty when nothing matched — a successful answer, not an error."
+        },
+        "truncated": {
+          "type": "boolean",
+          "description": "The agent stopped early. A consumer must not read a truncated page as a complete account of what was issued."
+        },
+        "cursor": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 4096,
+          "description": "Pass to the next request to continue. Absent when the page is the last."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "IssuedCredentialSummary": {
+      "title": "IssuedCredentialSummary",
+      "description": "A body-free projection of an issuance record. Carries no claim content by construction — see the specification's rationale for why a list does not return credentials.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credentialId",
+        "holder",
+        "issuedAt",
+        "expiresAt",
+        "status"
+      ],
+      "properties": {
+        "credentialId": {
+          "$ref": "#/$defs/CredentialId",
+          "description": "The id `vta/credentials/revoke` is keyed on."
+        },
+        "holder": {
+          "$ref": "#/$defs/Did",
+          "description": "Who the credential was issued to."
+        },
+        "credentialType": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The type tag beyond `VerifiableCredential`, when the credential carries one."
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "status": {
+          "$ref": "#/$defs/IssuedCredentialStatus"
+        },
+        "revokedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present iff `status` is `revoked`."
+        },
+        "revocationReason": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Free text recorded at revocation. Disclosed to every caller entitled to this list — see Security & Privacy."
+        }
+      }
+    },
+    "IssuedCredentialStatus": {
+      "type": "string",
+      "enum": [
+        "active",
+        "expired",
+        "revoked"
+      ],
+      "description": "Derived at read time. `revoked` takes precedence over `expired`: a credential revoked before its window closed is revoked, and reporting it as merely expired would hide that somebody acted."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048
+    },
+    "CredentialId": {
+      "$anchor": "credentialId",
+      "title": "CredentialId",
+      "description": "Stable identifier for an issued credential — the handle for revocation and audit. Opaque to the holder: it MUST be echoed verbatim when revoking and MUST NOT be parsed.",
+      "type": "string",
+      "minLength": 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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  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,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;