@openvtc/trust-tasks 0.21.11 → 0.21.13

package/src/vtc/join-requests/query/0.1/payload.ts

@@ -0,0 +1,285 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/join-requests/query/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * An administrator asks the community to open a credential exchange with a prospective member: to issue a presentation challenge, build the credential-exchange/query for a registered Accepts criterion, and deliver it. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCJoinRequestsQueryPayload {
+  /**
+   * The holder the query is for — the prospective member whose agent will answer it.
+   */
+  holderDid: string;
+  /**
+   * The registered Accepts criterion (vtc/schemas/accepts/register) whose DCQL query to send.
+   */
+  criterionId: string;
+  ext?: Ext;
+}
+export interface VTCJoinRequestsQueryResponsePayload {
+  /**
+   * The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it.
+   */
+  threadId: string;
+  /**
+   * Echoed.
+   */
+  holderDid: string;
+  query: CredentialQuery;
+  /**
+   * Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself.
+   */
+  delivered: boolean;
+  ext?: Ext;
+}
+/**
+ * The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.
+ */
+export interface CredentialQuery {
+  dcql_query: {};
+  nonce: string;
+  purpose: string;
+  [k: string]: unknown | undefined;
+}
+
+/** 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/vtc/join-requests/query/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsQueryPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/query/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsQueryResponsePayload;
+
+/**
+ * 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/vtc/join-requests/query/0.1",
+  "title": "VTC Join Requests — Query — payload",
+  "description": "An administrator asks the community to open a credential exchange with a prospective member: to issue a presentation challenge, build the credential-exchange/query for a registered Accepts criterion, and deliver it. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "holderDid",
+    "criterionId"
+  ],
+  "properties": {
+    "holderDid": {
+      "type": "string",
+      "pattern": "^did:",
+      "minLength": 5,
+      "maxLength": 2048,
+      "description": "The holder the query is for — the prospective member whose agent will answer it."
+    },
+    "criterionId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "The registered Accepts criterion (vtc/schemas/accepts/register) whose DCQL query to send."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "CredentialQuery": {
+      "title": "CredentialQuery",
+      "type": "object",
+      "additionalProperties": true,
+      "required": [
+        "dcql_query",
+        "nonce",
+        "purpose"
+      ],
+      "description": "The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.",
+      "properties": {
+        "dcql_query": {
+          "type": "object"
+        },
+        "nonce": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
+        },
+        "purpose": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 500
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Join Requests — Query — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "threadId",
+        "holderDid",
+        "query",
+        "delivered"
+      ],
+      "properties": {
+        "threadId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it."
+        },
+        "holderDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "Echoed."
+        },
+        "query": {
+          "$ref": "#/$defs/CredentialQuery"
+        },
+        "delivered": {
+          "type": "boolean",
+          "description": "Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself."
+        },
+        "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": {
+    "CredentialQuery": {
+      "title": "CredentialQuery",
+      "type": "object",
+      "additionalProperties": true,
+      "required": [
+        "dcql_query",
+        "nonce",
+        "purpose"
+      ],
+      "description": "The payload of the credential-exchange/query/0.1 document the community built for the holder — the DCQL query, the freshness nonce it bound to its own DID and the returned thread, and the purpose shown to the holder. A community MUST emit a value that validates against the credential-exchange/query/0.1 payload schema; its members are that specification's, and are not restated here. snake_case member names are DCQL's own.",
+      "properties": {
+        "dcql_query": {
+          "type": "object"
+        },
+        "nonce": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
+        },
+        "purpose": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 500
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Join Requests — Query — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "threadId",
+        "holderDid",
+        "query",
+        "delivered"
+      ],
+      "properties": {
+        "threadId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The exchange's thread: the `id` of the credential-exchange/query document, and the `threadId` the holder's credential-exchange/present must carry. The presentation challenge is keyed by it."
+        },
+        "holderDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "Echoed."
+        },
+        "query": {
+          "$ref": "#/$defs/CredentialQuery"
+        },
+        "delivered": {
+          "type": "boolean",
+          "description": "Whether the community accepted the query for delivery — queued to its outbox, which sends and retries it. Not a confirmation of receipt. False when it has no route to the holder or could not queue it; the caller can then relay `query` itself."
+        },
+        "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: 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;