@openvtc/trust-tasks 0.16.9 → 0.16.11

package/src/persona/disclosure/present/1.0/payload.ts

@@ -0,0 +1,274 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/disclosure/present/1.0/payload.schema.json
+ */
+
+import type { Ext, Ulid } from "../../../../_shared/components.js";
+
+
+/**
+ * Produce the signed disclosure a preview described. Consumes a previewId, which is what makes the two calls uncollapsible.
+ */
+export interface PersonaDisclosurePresentPayload {
+  contextId: string;
+  /**
+   * From a prior preview. Single-use: presenting consumes it. A producer that wants to disclose twice previews twice, which is correct — the second disclosure is a second decision.
+   */
+  previewId: Ulid;
+  /**
+   * The verifier's nonce, bound into the proof for freshness so the artifact cannot be replayed to another verifier or at another time.
+   */
+  challenge?: string;
+  /**
+   * Optionally mint a durable, revocable self-issued credential instead of an ephemeral artifact. Off by default: a presented disclosure is read once and revoking it afterwards is meaningless, so status machinery would be maintenance with no benefit. A holder who wants a counterparty to be able to re-verify — and themselves to be able to revoke — asks for it here and takes on a credential they must now maintain.
+   */
+  mint?: {
+    durable?: boolean;
+    validUntil?: string;
+  };
+  ext?: Ext;
+}
+/**
+ * Success response to persona/disclosure/present. Type https://trusttasks.org/spec/persona/disclosure/present/1.0#response.
+ */
+export interface PersonaDisclosurePresentResponsePayload {
+  /**
+   * Names the append-only record this disclosure wrote, so the holder can find it again in their history.
+   */
+  disclosureId: Ulid;
+  /**
+   * The signed disclosure, in the renderer's format. Opaque to this task: the maintainer signs it, the producer relays it, and neither the schema nor the maintainer reinterprets it once formed.
+   */
+  artifact: string;
+  /**
+   * The identifier the artifact was issued under — pairwise by default, so this disclosure cannot be joined to another by subject alone.
+   */
+  subject: string;
+  /**
+   * Present only when a durable credential was minted. It is in the holder's own vault, appears in their credential list, and can be revoked — which is the obligation they took on by asking for it.
+   */
+  credentialId?: string;
+  disclosedAt: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, Ulid };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/persona/disclosure/present/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaDisclosurePresentPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/disclosure/present/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaDisclosurePresentResponsePayload;
+
+/**
+ * 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/persona/disclosure/present/1.0",
+  "title": "Persona Disclosure Present — payload",
+  "description": "Produce the signed disclosure a preview described. Consumes a previewId, which is what makes the two calls uncollapsible.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId",
+    "previewId"
+  ],
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "previewId": {
+      "$ref": "#/$defs/Ulid",
+      "description": "From a prior preview. Single-use: presenting consumes it. A producer that wants to disclose twice previews twice, which is correct — the second disclosure is a second decision."
+    },
+    "challenge": {
+      "type": "string",
+      "maxLength": 512,
+      "description": "The verifier's nonce, bound into the proof for freshness so the artifact cannot be replayed to another verifier or at another time."
+    },
+    "mint": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Optionally mint a durable, revocable self-issued credential instead of an ephemeral artifact. Off by default: a presented disclosure is read once and revoking it afterwards is meaningless, so status machinery would be maintenance with no benefit. A holder who wants a counterparty to be able to re-verify — and themselves to be able to revoke — asks for it here and takes on a credential they must now maintain.",
+      "properties": {
+        "durable": {
+          "type": "boolean",
+          "default": false
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Persona Disclosure Present — response payload",
+      "description": "Success response to persona/disclosure/present. Type https://trusttasks.org/spec/persona/disclosure/present/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "disclosureId",
+        "artifact",
+        "subject",
+        "disclosedAt"
+      ],
+      "properties": {
+        "disclosureId": {
+          "$ref": "#/$defs/Ulid",
+          "description": "Names the append-only record this disclosure wrote, so the holder can find it again in their history."
+        },
+        "artifact": {
+          "type": "string",
+          "description": "The signed disclosure, in the renderer's format. Opaque to this task: the maintainer signs it, the producer relays it, and neither the schema nor the maintainer reinterprets it once formed."
+        },
+        "subject": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The identifier the artifact was issued under — pairwise by default, so this disclosure cannot be joined to another by subject alone."
+        },
+        "credentialId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Present only when a durable credential was minted. It is in the holder's own vault, appears in their credential list, and can be revoked — which is the obligation they took on by asking for it."
+        },
+        "disclosedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "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-]+)+$"
+      }
+    },
+    "Ulid": {
+      "title": "Ulid",
+      "description": "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.",
+      "type": "string",
+      "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+    }
+  }
+} 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": "Persona Disclosure Present — response payload",
+      "description": "Success response to persona/disclosure/present. Type https://trusttasks.org/spec/persona/disclosure/present/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "disclosureId",
+        "artifact",
+        "subject",
+        "disclosedAt"
+      ],
+      "properties": {
+        "disclosureId": {
+          "$ref": "#/$defs/Ulid",
+          "description": "Names the append-only record this disclosure wrote, so the holder can find it again in their history."
+        },
+        "artifact": {
+          "type": "string",
+          "description": "The signed disclosure, in the renderer's format. Opaque to this task: the maintainer signs it, the producer relays it, and neither the schema nor the maintainer reinterprets it once formed."
+        },
+        "subject": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The identifier the artifact was issued under — pairwise by default, so this disclosure cannot be joined to another by subject alone."
+        },
+        "credentialId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Present only when a durable credential was minted. It is in the holder's own vault, appears in their credential list, and can be revoked — which is the obligation they took on by asking for it."
+        },
+        "disclosedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "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-]+)+$"
+      }
+    },
+    "Ulid": {
+      "title": "Ulid",
+      "description": "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.",
+      "type": "string",
+      "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+    }
+  }
+} 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;