@openvtc/trust-tasks 0.16.9 → 0.16.10

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

@@ -0,0 +1,415 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/disclosure/history/1.0/payload.schema.json
+ */
+
+import type { ClaimType, Ext, ProofRung, Ulid } from "../../../../_shared/components.js";
+
+
+/**
+ * What the holder has shared, with whom, when, and — because the pool sits above the context boundary — which contexts a given attribute has reached.
+ */
+export interface PersonaDisclosureHistoryPayload {
+  /**
+   * Narrow to one context. Omit to query across all of them, which only the holder can do and which is the whole reason this task is holder-authorized.
+   */
+  contextId?: string;
+  /**
+   * Narrow to one verifier — 'what does this site have of mine'.
+   */
+  verifierDid?: string;
+  /**
+   * Narrow to one claim type — 'where has my home address gone'. Answering this is the obligation the agent-scoped pool takes on: having put the holder's facts above the context boundary, it owes them an account of which contexts each fact has reached.
+   */
+  attributeType?: ClaimType;
+  since?: string;
+  cursor?: string;
+  limit?: number;
+  ext?: Ext;
+}
+/**
+ * Success response to persona/disclosure/history. Type https://trusttasks.org/spec/persona/disclosure/history/1.0#response. Records name claim TYPES and never values: the history says what kind of thing went where, and re-storing the values would double the exposure it exists to describe.
+ */
+export interface PersonaDisclosureHistoryResponsePayload {
+  /**
+   * @maxItems 500
+   */
+  disclosures: {
+    disclosureId: Ulid;
+    contextId: string;
+    verifierDid: string;
+    personaDid: string;
+    /**
+     * The pairwise identifier the disclosure was made under, so a holder can tell two disclosures to the same verifier apart.
+     */
+    subject?: string;
+    /**
+     * @maxItems 128
+     */
+    claimTypes: ClaimType[];
+    /**
+     * Positionally aligned with claimTypes. A holder reviewing history needs to know not only what went but how strongly it was hidden — the same claim type at two rungs is two very different disclosures.
+     *
+     * @maxItems 128
+     */
+    rungs?: ProofRung[];
+    purpose?: string;
+    renderer?: string;
+    /**
+     * Present when the disclosure minted a durable credential — the one kind of disclosure that is still live and still revocable, which is why the history names it.
+     */
+    durableCredentialId?: string;
+    disclosedAt: string;
+  }[];
+  nextCursor?: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ClaimType, Ext, ProofRung, Ulid };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/persona/disclosure/history/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaDisclosureHistoryPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/disclosure/history/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaDisclosureHistoryResponsePayload;
+
+/**
+ * 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/history/1.0",
+  "title": "Persona Disclosure History — payload",
+  "description": "What the holder has shared, with whom, when, and — because the pool sits above the context boundary — which contexts a given attribute has reached.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Narrow to one context. Omit to query across all of them, which only the holder can do and which is the whole reason this task is holder-authorized."
+    },
+    "verifierDid": {
+      "type": "string",
+      "maxLength": 2048,
+      "description": "Narrow to one verifier — 'what does this site have of mine'."
+    },
+    "attributeType": {
+      "$ref": "#/$defs/ClaimType",
+      "description": "Narrow to one claim type — 'where has my home address gone'. Answering this is the obligation the agent-scoped pool takes on: having put the holder's facts above the context boundary, it owes them an account of which contexts each fact has reached."
+    },
+    "since": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "cursor": {
+      "type": "string",
+      "maxLength": 4096
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 500,
+      "default": 100
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Persona Disclosure History — response payload",
+      "description": "Success response to persona/disclosure/history. Type https://trusttasks.org/spec/persona/disclosure/history/1.0#response. Records name claim TYPES and never values: the history says what kind of thing went where, and re-storing the values would double the exposure it exists to describe.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "disclosures"
+      ],
+      "properties": {
+        "disclosures": {
+          "type": "array",
+          "maxItems": 500,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "disclosureId",
+              "contextId",
+              "verifierDid",
+              "personaDid",
+              "claimTypes",
+              "disclosedAt"
+            ],
+            "properties": {
+              "disclosureId": {
+                "$ref": "#/$defs/Ulid"
+              },
+              "contextId": {
+                "type": "string",
+                "minLength": 1
+              },
+              "verifierDid": {
+                "type": "string",
+                "minLength": 1
+              },
+              "personaDid": {
+                "type": "string",
+                "minLength": 1
+              },
+              "subject": {
+                "type": "string",
+                "description": "The pairwise identifier the disclosure was made under, so a holder can tell two disclosures to the same verifier apart."
+              },
+              "claimTypes": {
+                "type": "array",
+                "maxItems": 128,
+                "items": {
+                  "$ref": "#/$defs/ClaimType"
+                }
+              },
+              "rungs": {
+                "type": "array",
+                "maxItems": 128,
+                "items": {
+                  "$ref": "#/$defs/ProofRung"
+                },
+                "description": "Positionally aligned with claimTypes. A holder reviewing history needs to know not only what went but how strongly it was hidden — the same claim type at two rungs is two very different disclosures."
+              },
+              "purpose": {
+                "type": "string",
+                "maxLength": 512
+              },
+              "renderer": {
+                "type": "string",
+                "maxLength": 64
+              },
+              "durableCredentialId": {
+                "type": "string",
+                "description": "Present when the disclosure minted a durable credential — the one kind of disclosure that is still live and still revocable, which is why the history names it."
+              },
+              "disclosedAt": {
+                "type": "string",
+                "format": "date-time"
+              }
+            }
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "maxLength": 4096
+        },
+        "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-]+)+$"
+      }
+    },
+    "ProofRung": {
+      "title": "ProofRung",
+      "description": "How strongly a credential-backed claim is hidden when presented, ordered most private first. `predicate` proves a statement over a claim without disclosing the claim. `derived` discloses exactly the claims needed via an unlinkable derived proof, so two presentations cannot be joined. `selectiveDisclosure` discloses exactly the claims needed but carries the issuer's signature unchanged, so two presentations ARE linkable. `whole` discloses the entire credential.\n\nThe distinction between the first two and the last two is of kind, not degree: only `predicate` and `derived` avoid handing two verifiers a join key. A maintainer MUST default to the highest rung the credential's format supports, and MUST NOT silently fall to a lower one — a request that cannot be satisfied at the rung a producer asked for is refused, because a silent privacy downgrade discloses material the holder believed was hidden.",
+      "type": "string",
+      "enum": [
+        "predicate",
+        "derived",
+        "selectiveDisclosure",
+        "whole"
+      ]
+    },
+    "ClaimType": {
+      "title": "ClaimType",
+      "description": "The vocabulary token naming what a value IS — `name.legal`, `phone.mobile`, `address.postal`, `person.birthDate`. Dotted, most-general segment first, so that a consumer with no knowledge of the specific token can still group by its prefix.\n\nThe token is the maintainer's own; no external vocabulary is primary. External vocabularies (vCard/jCard, OIDC standard claims, schema.org) are mappings applied at PRESENTATION by a renderer, not at rest, so that a query written in any of them can be matched without the store having to live inside any one of them.\n\nThe `x:` prefix is an open extension namespace and is not decoration. The closest prior art — Windows CardSpace's self-issued card — supported exactly fifteen predefined claim types with no extensibility, and that is the specific way it failed the requirement a holder actually has. An `x:` attribute stores, composes, binds and discloses exactly like a known one; it renders generically and matches only an explicit query.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-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 History — response payload",
+      "description": "Success response to persona/disclosure/history. Type https://trusttasks.org/spec/persona/disclosure/history/1.0#response. Records name claim TYPES and never values: the history says what kind of thing went where, and re-storing the values would double the exposure it exists to describe.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "disclosures"
+      ],
+      "properties": {
+        "disclosures": {
+          "type": "array",
+          "maxItems": 500,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "disclosureId",
+              "contextId",
+              "verifierDid",
+              "personaDid",
+              "claimTypes",
+              "disclosedAt"
+            ],
+            "properties": {
+              "disclosureId": {
+                "$ref": "#/$defs/Ulid"
+              },
+              "contextId": {
+                "type": "string",
+                "minLength": 1
+              },
+              "verifierDid": {
+                "type": "string",
+                "minLength": 1
+              },
+              "personaDid": {
+                "type": "string",
+                "minLength": 1
+              },
+              "subject": {
+                "type": "string",
+                "description": "The pairwise identifier the disclosure was made under, so a holder can tell two disclosures to the same verifier apart."
+              },
+              "claimTypes": {
+                "type": "array",
+                "maxItems": 128,
+                "items": {
+                  "$ref": "#/$defs/ClaimType"
+                }
+              },
+              "rungs": {
+                "type": "array",
+                "maxItems": 128,
+                "items": {
+                  "$ref": "#/$defs/ProofRung"
+                },
+                "description": "Positionally aligned with claimTypes. A holder reviewing history needs to know not only what went but how strongly it was hidden — the same claim type at two rungs is two very different disclosures."
+              },
+              "purpose": {
+                "type": "string",
+                "maxLength": 512
+              },
+              "renderer": {
+                "type": "string",
+                "maxLength": 64
+              },
+              "durableCredentialId": {
+                "type": "string",
+                "description": "Present when the disclosure minted a durable credential — the one kind of disclosure that is still live and still revocable, which is why the history names it."
+              },
+              "disclosedAt": {
+                "type": "string",
+                "format": "date-time"
+              }
+            }
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "maxLength": 4096
+        },
+        "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-]+)+$"
+      }
+    },
+    "ProofRung": {
+      "title": "ProofRung",
+      "description": "How strongly a credential-backed claim is hidden when presented, ordered most private first. `predicate` proves a statement over a claim without disclosing the claim. `derived` discloses exactly the claims needed via an unlinkable derived proof, so two presentations cannot be joined. `selectiveDisclosure` discloses exactly the claims needed but carries the issuer's signature unchanged, so two presentations ARE linkable. `whole` discloses the entire credential.\n\nThe distinction between the first two and the last two is of kind, not degree: only `predicate` and `derived` avoid handing two verifiers a join key. A maintainer MUST default to the highest rung the credential's format supports, and MUST NOT silently fall to a lower one — a request that cannot be satisfied at the rung a producer asked for is refused, because a silent privacy downgrade discloses material the holder believed was hidden.",
+      "type": "string",
+      "enum": [
+        "predicate",
+        "derived",
+        "selectiveDisclosure",
+        "whole"
+      ]
+    },
+    "ClaimType": {
+      "title": "ClaimType",
+      "description": "The vocabulary token naming what a value IS — `name.legal`, `phone.mobile`, `address.postal`, `person.birthDate`. Dotted, most-general segment first, so that a consumer with no knowledge of the specific token can still group by its prefix.\n\nThe token is the maintainer's own; no external vocabulary is primary. External vocabularies (vCard/jCard, OIDC standard claims, schema.org) are mappings applied at PRESENTATION by a renderer, not at rest, so that a query written in any of them can be matched without the store having to live inside any one of them.\n\nThe `x:` prefix is an open extension namespace and is not decoration. The closest prior art — Windows CardSpace's self-issued card — supported exactly fifteen predefined claim types with no extensibility, and that is the specific way it failed the requirement a holder actually has. An `x:` attribute stores, composes, binds and discloses exactly like a known one; it renders generically and matches only an explicit query.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^(x:)?[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-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: 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;