@openvtc/trust-tasks 0.19.18 → 0.19.20

package/src/persona/profile/timeline/1.0/payload.ts

@@ -0,0 +1,402 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/profile/timeline/1.0/payload.schema.json
+ */
+
+import type { ClaimType, Ext, Ulid, Version_PersonaV0_1 as Version } from "../../../../_shared/components.js";
+
+
+/**
+ * What one face has done, in order: composed, worn and taken off, what it told whom, when a value it shows changed, retired and reinstated. Types, versions, contexts and parties — never a value, never one of the holder's private labels.
+ */
+export interface PersonaProfileTimelinePayload {
+  profileId: Ulid;
+  /**
+   * The context of a context-local face. Omit for a pool face.
+   */
+  contextId?: string;
+  /**
+   * Only events at or after this time.
+   */
+  since?: string;
+  /**
+   * Opaque continuation token from a prior response. A producer MUST NOT construct or parse one.
+   */
+  cursor?: string;
+  limit?: number;
+  ext?: Ext;
+}
+/**
+ * Success response to persona/profile/timeline. Type https://trusttasks.org/spec/persona/profile/timeline/1.0#response. Oldest first.
+ */
+export interface PersonaProfileTimelineResponsePayload {
+  profileId: Ulid;
+  /**
+   * @maxItems 500
+   */
+  events: TimelineEvent[];
+  /**
+   * Present when more events follow. Absent at the end — a producer MUST NOT infer the end from a short page.
+   */
+  nextCursor?: string;
+  ext?: Ext;
+}
+/**
+ * One thing that happened to a face. Which members are present depends on `kind`; none carries a value or a private label.
+ */
+export interface TimelineEvent {
+  at: string;
+  /**
+   * `composed` — the face was made. `worn` / `unworn` — a persona began or stopped wearing it in a context. `expired` — a binding's `until` passed. `disclosed` — it told a party something (`verifierDid`, `claimTypes`). `valueChanged` — a value it shows changed (`claimTypes`, `version`). `promoted` — it moved from one context into the pool. `retired` / `reinstated`.
+   */
+  kind:
+    | "composed"
+    | "worn"
+    | "unworn"
+    | "expired"
+    | "disclosed"
+    | "valueChanged"
+    | "promoted"
+    | "retired"
+    | "reinstated";
+  contextId?: string;
+  personaDid?: string;
+  verifierDid?: string;
+  /**
+   * @maxItems 64
+   */
+  claimTypes?: ClaimType[];
+  version?: Version;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ClaimType, Ext, Ulid, Version };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/persona/profile/timeline/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaProfileTimelinePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/profile/timeline/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaProfileTimelineResponsePayload;
+
+/**
+ * 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/profile/timeline/1.0",
+  "title": "Persona Profile Timeline — payload",
+  "description": "What one face has done, in order: composed, worn and taken off, what it told whom, when a value it shows changed, retired and reinstated. Types, versions, contexts and parties — never a value, never one of the holder's private labels.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "profileId"
+  ],
+  "properties": {
+    "profileId": {
+      "$ref": "#/$defs/Ulid"
+    },
+    "contextId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The context of a context-local face. Omit for a pool face."
+    },
+    "since": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Only events at or after this time."
+    },
+    "cursor": {
+      "type": "string",
+      "maxLength": 4096,
+      "description": "Opaque continuation token from a prior response. A producer MUST NOT construct or parse one."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 500,
+      "default": 100
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "TimelineEvent": {
+      "title": "TimelineEvent",
+      "description": "One thing that happened to a face. Which members are present depends on `kind`; none carries a value or a private label.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "at",
+        "kind"
+      ],
+      "properties": {
+        "at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "composed",
+            "worn",
+            "unworn",
+            "expired",
+            "disclosed",
+            "valueChanged",
+            "promoted",
+            "retired",
+            "reinstated"
+          ],
+          "description": "`composed` — the face was made. `worn` / `unworn` — a persona began or stopped wearing it in a context. `expired` — a binding's `until` passed. `disclosed` — it told a party something (`verifierDid`, `claimTypes`). `valueChanged` — a value it shows changed (`claimTypes`, `version`). `promoted` — it moved from one context into the pool. `retired` / `reinstated`."
+        },
+        "contextId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "personaDid": {
+          "type": "string",
+          "minLength": 1
+        },
+        "verifierDid": {
+          "type": "string",
+          "minLength": 1
+        },
+        "claimTypes": {
+          "type": "array",
+          "maxItems": 64,
+          "items": {
+            "$ref": "#/$defs/ClaimType"
+          }
+        },
+        "version": {
+          "$ref": "#/$defs/Version"
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "Persona Profile Timeline — response payload",
+      "description": "Success response to persona/profile/timeline. Type https://trusttasks.org/spec/persona/profile/timeline/1.0#response. Oldest first.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "profileId",
+        "events"
+      ],
+      "properties": {
+        "profileId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "events": {
+          "type": "array",
+          "maxItems": 500,
+          "items": {
+            "$ref": "#/$defs/TimelineEvent"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "maxLength": 4096,
+          "description": "Present when more events follow. Absent at the end — a producer MUST NOT infer the end from a short page."
+        },
+        "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}$"
+    },
+    "Version": {
+      "title": "Version",
+      "description": "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "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]*)*$"
+    }
+  }
+} 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": {
+    "TimelineEvent": {
+      "title": "TimelineEvent",
+      "description": "One thing that happened to a face. Which members are present depends on `kind`; none carries a value or a private label.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "at",
+        "kind"
+      ],
+      "properties": {
+        "at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "composed",
+            "worn",
+            "unworn",
+            "expired",
+            "disclosed",
+            "valueChanged",
+            "promoted",
+            "retired",
+            "reinstated"
+          ],
+          "description": "`composed` — the face was made. `worn` / `unworn` — a persona began or stopped wearing it in a context. `expired` — a binding's `until` passed. `disclosed` — it told a party something (`verifierDid`, `claimTypes`). `valueChanged` — a value it shows changed (`claimTypes`, `version`). `promoted` — it moved from one context into the pool. `retired` / `reinstated`."
+        },
+        "contextId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "personaDid": {
+          "type": "string",
+          "minLength": 1
+        },
+        "verifierDid": {
+          "type": "string",
+          "minLength": 1
+        },
+        "claimTypes": {
+          "type": "array",
+          "maxItems": 64,
+          "items": {
+            "$ref": "#/$defs/ClaimType"
+          }
+        },
+        "version": {
+          "$ref": "#/$defs/Version"
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "Persona Profile Timeline — response payload",
+      "description": "Success response to persona/profile/timeline. Type https://trusttasks.org/spec/persona/profile/timeline/1.0#response. Oldest first.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "profileId",
+        "events"
+      ],
+      "properties": {
+        "profileId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "events": {
+          "type": "array",
+          "maxItems": 500,
+          "items": {
+            "$ref": "#/$defs/TimelineEvent"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "maxLength": 4096,
+          "description": "Present when more events follow. Absent at the end — a producer MUST NOT infer the end from a short page."
+        },
+        "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}$"
+    },
+    "Version": {
+      "title": "Version",
+      "description": "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "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]*)*$"
+    }
+  }
+} 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;