@openvtc/trust-tasks 0.16.2 → 0.16.4

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

@@ -0,0 +1,459 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vault/credentials/query/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export type Did = string;
+/**
+ * Semantic classification. `invite`, `membership`, `role`, `endorsement` and `personhood` are defined; a maintainer MAY use another token.
+ */
+export type CredentialPurpose = string;
+/**
+ * Validity, driven by the credential's own window and by status-list checks. Orthogonal to lifecycle.
+ */
+export type CredentialStatus = "valid" | "expired" | "revoked" | "unknown";
+
+/**
+ * A filtered, body-free search over stored credentials. At least one of `type`, `communityDid`, `issuerDid`, `purpose` or `status` MUST be present — see the specification; `includeArchived` and `includeDeleted` are modifiers and do not satisfy that requirement.
+ */
+export interface VaultCredentialsQuery {
+  /**
+   * Match credentials carrying this VC `type` tag.
+   */
+  type?: string;
+  /**
+   * Match credentials held for this community or context DID.
+   */
+  communityDid?: string;
+  /**
+   * Match credentials issued by this DID.
+   */
+  issuerDid?: string;
+  /**
+   * Match the maintainer's semantic classification of the credential.
+   */
+  purpose?: string;
+  /**
+   * Match the validity dimension.
+   */
+  status?: "valid" | "expired" | "revoked" | "unknown";
+  /**
+   * Modifier, not a filter: also return archived credentials matching the other constraints. Absent means false.
+   */
+  includeArchived?: boolean;
+  /**
+   * Modifier, not a filter: also return soft-deleted tombstones matching the other constraints. Absent means false.
+   */
+  includeDeleted?: boolean;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+export interface VaultCredentialsQueryResponsePayload {
+  /**
+   * Matching descriptors. Empty when nothing matched — a successful answer, not an error.
+   */
+  credentials: CredentialDescriptor[];
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * A body-free projection of a stored credential. Carries no claim content by construction.
+ */
+export interface CredentialDescriptor {
+  /**
+   * Local handle. Opaque to the consumer; the id `get`, `archive`, `delete` and the rest are keyed on.
+   */
+  id: string;
+  /**
+   * VC `type` tags carried by the credential.
+   */
+  types: string[];
+  issuerDid?: Did;
+  purpose?: CredentialPurpose;
+  status: CredentialStatus;
+  /**
+   * Omitted for active credentials, so an active-only result is unchanged by this member's existence.
+   */
+  lifecycle?: "active" | "archived" | "deleted";
+  validFrom?: string;
+  validUntil?: string;
+  /**
+   * Present iff `lifecycle` is `archived`.
+   */
+  archivedAt?: string;
+  /**
+   * Present iff `lifecycle` is `deleted`.
+   */
+  deletedAt?: string;
+  /**
+   * Present iff `lifecycle` is `deleted`. Restorable while now < graceUntil.
+   */
+  graceUntil?: string;
+}
+
+/** 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/query/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VaultCredentialsQuery;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vault/credentials/query/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VaultCredentialsQueryResponsePayload;
+
+/**
+ * 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/query/0.1",
+  "title": "Vault Credentials — Query",
+  "description": "A filtered, body-free search over stored credentials. At least one of `type`, `communityDid`, `issuerDid`, `purpose` or `status` MUST be present — see the specification; `includeArchived` and `includeDeleted` are modifiers and do not satisfy that requirement.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "type": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "Match credentials carrying this VC `type` tag."
+    },
+    "communityDid": {
+      "$ref": "#/$defs/Did",
+      "description": "Match credentials held for this community or context DID."
+    },
+    "issuerDid": {
+      "$ref": "#/$defs/Did",
+      "description": "Match credentials issued by this DID."
+    },
+    "purpose": {
+      "$ref": "#/$defs/CredentialPurpose",
+      "description": "Match the maintainer's semantic classification of the credential."
+    },
+    "status": {
+      "$ref": "#/$defs/CredentialStatus",
+      "description": "Match the validity dimension."
+    },
+    "includeArchived": {
+      "type": "boolean",
+      "description": "Modifier, not a filter: also return archived credentials matching the other constraints. Absent means false."
+    },
+    "includeDeleted": {
+      "type": "boolean",
+      "description": "Modifier, not a filter: also return soft-deleted tombstones matching the other constraints. Absent means false."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Vault Credentials Query — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credentials"
+      ],
+      "properties": {
+        "credentials": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/CredentialDescriptor"
+          },
+          "description": "Matching descriptors. Empty when nothing matched — a successful answer, not an error."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "CredentialDescriptor": {
+      "title": "Credential descriptor",
+      "description": "A body-free projection of a stored credential. Carries no claim content by construction.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "types",
+        "status"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "Local handle. Opaque to the consumer; the id `get`, `archive`, `delete` and the rest are keyed on."
+        },
+        "types": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256
+          },
+          "description": "VC `type` tags carried by the credential."
+        },
+        "issuerDid": {
+          "$ref": "#/$defs/Did"
+        },
+        "purpose": {
+          "$ref": "#/$defs/CredentialPurpose"
+        },
+        "status": {
+          "$ref": "#/$defs/CredentialStatus"
+        },
+        "lifecycle": {
+          "$ref": "#/$defs/VaultLifecycle",
+          "description": "Omitted for active credentials, so an active-only result is unchanged by this member's existence."
+        },
+        "validFrom": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "archivedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present iff `lifecycle` is `archived`."
+        },
+        "deletedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present iff `lifecycle` is `deleted`."
+        },
+        "graceUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present iff `lifecycle` is `deleted`. Restorable while now < graceUntil."
+        }
+      }
+    },
+    "CredentialStatus": {
+      "type": "string",
+      "enum": [
+        "valid",
+        "expired",
+        "revoked",
+        "unknown"
+      ],
+      "description": "Validity, driven by the credential's own window and by status-list checks. Orthogonal to lifecycle."
+    },
+    "CredentialPurpose": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Semantic classification. `invite`, `membership`, `role`, `endorsement` and `personhood` are defined; a maintainer MAY use another token."
+    },
+    "VaultLifecycle": {
+      "type": "string",
+      "enum": [
+        "active",
+        "archived",
+        "deleted"
+      ],
+      "description": "Archival state, chosen through this family. Orthogonal to validity."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048
+    },
+    "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 Query — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credentials"
+      ],
+      "properties": {
+        "credentials": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/CredentialDescriptor"
+          },
+          "description": "Matching descriptors. Empty when nothing matched — a successful answer, not an error."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "CredentialDescriptor": {
+      "title": "Credential descriptor",
+      "description": "A body-free projection of a stored credential. Carries no claim content by construction.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "types",
+        "status"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "Local handle. Opaque to the consumer; the id `get`, `archive`, `delete` and the rest are keyed on."
+        },
+        "types": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256
+          },
+          "description": "VC `type` tags carried by the credential."
+        },
+        "issuerDid": {
+          "$ref": "#/$defs/Did"
+        },
+        "purpose": {
+          "$ref": "#/$defs/CredentialPurpose"
+        },
+        "status": {
+          "$ref": "#/$defs/CredentialStatus"
+        },
+        "lifecycle": {
+          "$ref": "#/$defs/VaultLifecycle",
+          "description": "Omitted for active credentials, so an active-only result is unchanged by this member's existence."
+        },
+        "validFrom": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "archivedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present iff `lifecycle` is `archived`."
+        },
+        "deletedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present iff `lifecycle` is `deleted`."
+        },
+        "graceUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present iff `lifecycle` is `deleted`. Restorable while now < graceUntil."
+        }
+      }
+    },
+    "CredentialStatus": {
+      "type": "string",
+      "enum": [
+        "valid",
+        "expired",
+        "revoked",
+        "unknown"
+      ],
+      "description": "Validity, driven by the credential's own window and by status-list checks. Orthogonal to lifecycle."
+    },
+    "CredentialPurpose": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Semantic classification. `invite`, `membership`, `role`, `endorsement` and `personhood` are defined; a maintainer MAY use another token."
+    },
+    "VaultLifecycle": {
+      "type": "string",
+      "enum": [
+        "active",
+        "archived",
+        "deleted"
+      ],
+      "description": "Archival state, chosen through this family. Orthogonal to validity."
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048
+    },
+    "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;