@openvtc/trust-tasks 0.17.8 → 0.17.10

package/src/persona/facet/list/1.0/payload.ts

@@ -0,0 +1,402 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/facet/list/1.0/payload.schema.json
+ */
+
+import type { Ext, FacetColour, Ulid, Version_PersonaV0_1 as Version } from "../../../../_shared/components.js";
+
+
+/**
+ * List the holder's facets, with their membership. Cursor-paginated like every other persona listing.
+ */
+export interface PersonaFacetListPayload {
+  /**
+   * The page size to ask for — never a cap on the result. A consumer that wants every facet follows `nextCursor` to the end; one that treats this as a limit will silently draw a partial picture.
+   */
+  limit?: number;
+  /**
+   * Continue a prior listing. Opaque: a producer echoes what it was given and MUST NOT construct one.
+   */
+  cursor?: string;
+  ext?: Ext;
+}
+/**
+ * Success response to persona/facet/list. Type https://trusttasks.org/spec/persona/facet/list/1.0#response.
+ */
+export interface PersonaFacetListResponsePayload {
+  /**
+   * @maxItems 250
+   */
+  facets: Facet[];
+  /**
+   * Present when more facets remain. **Its absence is the only signal that a listing is complete** — a consumer MUST NOT infer exhaustion from a short page, because a maintainer may return fewer than `limit` for reasons of its own.
+   */
+  nextCursor?: string;
+  ext?: Ext;
+}
+/**
+ * One named part of the holder's life, and what belongs to it. Agent-scoped, like the attribute pool and the profiles it groups — a facet names records that sit above every trust context, so it cannot itself live inside one.
+ */
+export interface Facet {
+  facetId: Ulid;
+  name: string;
+  colour: FacetColour;
+  icon?: string;
+  /**
+   * Profiles belonging to this facet. A maintainer MUST NOT prune an id whose profile has been deleted: a dangling member is how a consumer can offer to tidy, and silently dropping it turns a deletion the holder may not have intended into one they cannot see.
+   *
+   * @maxItems 256
+   */
+  faceIds: Ulid[];
+  /**
+   * Attributes belonging to this facet, with the same rule about dangling ids as `faceIds`.
+   *
+   * @maxItems 1024
+   */
+  attributeIds: Ulid[];
+  version: Version;
+  createdAt?: string;
+  updatedAt: string;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, FacetColour, Ulid, Version };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/persona/facet/list/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaFacetListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/facet/list/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaFacetListResponsePayload;
+
+/**
+ * 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/facet/list/1.0",
+  "title": "Persona — Facet List — payload",
+  "description": "List the holder's facets, with their membership. Cursor-paginated like every other persona listing.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [],
+  "properties": {
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 250,
+      "default": 100,
+      "description": "The page size to ask for — never a cap on the result. A consumer that wants every facet follows `nextCursor` to the end; one that treats this as a limit will silently draw a partial picture."
+    },
+    "cursor": {
+      "type": "string",
+      "maxLength": 4096,
+      "description": "Continue a prior listing. Opaque: a producer echoes what it was given and MUST NOT construct one."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Persona Facet List — response payload",
+      "description": "Success response to persona/facet/list. Type https://trusttasks.org/spec/persona/facet/list/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "facets"
+      ],
+      "properties": {
+        "facets": {
+          "type": "array",
+          "maxItems": 250,
+          "items": {
+            "$ref": "#/$defs/Facet"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "maxLength": 4096,
+          "description": "Present when more facets remain. **Its absence is the only signal that a listing is complete** — a consumer MUST NOT infer exhaustion from a short page, because a maintainer may return fewer than `limit` for reasons of its own."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Facet": {
+      "title": "Facet",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "facetId",
+        "name",
+        "colour",
+        "faceIds",
+        "attributeIds",
+        "version",
+        "updatedAt"
+      ],
+      "description": "One named part of the holder's life, and what belongs to it. Agent-scoped, like the attribute pool and the profiles it groups — a facet names records that sit above every trust context, so it cannot itself live inside one.",
+      "properties": {
+        "facetId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64
+        },
+        "colour": {
+          "$ref": "#/$defs/FacetColour"
+        },
+        "icon": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 8
+        },
+        "faceIds": {
+          "type": "array",
+          "maxItems": 256,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Ulid"
+          },
+          "description": "Profiles belonging to this facet. A maintainer MUST NOT prune an id whose profile has been deleted: a dangling member is how a consumer can offer to tidy, and silently dropping it turns a deletion the holder may not have intended into one they cannot see."
+        },
+        "attributeIds": {
+          "type": "array",
+          "maxItems": 1024,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Ulid"
+          },
+          "description": "Attributes belonging to this facet, with the same rule about dangling ids as `faceIds`."
+        },
+        "version": {
+          "$ref": "#/$defs/Version"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "Version": {
+      "title": "Version",
+      "description": "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "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}$"
+    },
+    "FacetColour": {
+      "title": "FacetColour",
+      "description": "A colour **name**, resolved by each consumer against its own palette — never a hex value or any other literal. Two reasons, and both are about the consumer rather than the holder. A literal cannot be legible in a terminal, in a light theme and in a dark one at once, so a stored `#8B0000` is a colour that is wrong somewhere and the holder has no way to know where. And a consumer that reserves colours to mean something — an error, a warning, an irreversible act — must be able to keep a holder's decorative choice out of that channel; it cannot do that with an arbitrary value, and it can do it trivially with a closed set it maps itself. The eight members are chosen to be distinguishable from one another and deliberately carry no status connotation: none is named for success, warning or danger.",
+      "type": "string",
+      "enum": [
+        "slate",
+        "indigo",
+        "teal",
+        "moss",
+        "sand",
+        "clay",
+        "rose",
+        "plum"
+      ]
+    },
+    "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": "Persona Facet List — response payload",
+      "description": "Success response to persona/facet/list. Type https://trusttasks.org/spec/persona/facet/list/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "facets"
+      ],
+      "properties": {
+        "facets": {
+          "type": "array",
+          "maxItems": 250,
+          "items": {
+            "$ref": "#/$defs/Facet"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "maxLength": 4096,
+          "description": "Present when more facets remain. **Its absence is the only signal that a listing is complete** — a consumer MUST NOT infer exhaustion from a short page, because a maintainer may return fewer than `limit` for reasons of its own."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Facet": {
+      "title": "Facet",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "facetId",
+        "name",
+        "colour",
+        "faceIds",
+        "attributeIds",
+        "version",
+        "updatedAt"
+      ],
+      "description": "One named part of the holder's life, and what belongs to it. Agent-scoped, like the attribute pool and the profiles it groups — a facet names records that sit above every trust context, so it cannot itself live inside one.",
+      "properties": {
+        "facetId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64
+        },
+        "colour": {
+          "$ref": "#/$defs/FacetColour"
+        },
+        "icon": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 8
+        },
+        "faceIds": {
+          "type": "array",
+          "maxItems": 256,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Ulid"
+          },
+          "description": "Profiles belonging to this facet. A maintainer MUST NOT prune an id whose profile has been deleted: a dangling member is how a consumer can offer to tidy, and silently dropping it turns a deletion the holder may not have intended into one they cannot see."
+        },
+        "attributeIds": {
+          "type": "array",
+          "maxItems": 1024,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Ulid"
+          },
+          "description": "Attributes belonging to this facet, with the same rule about dangling ids as `faceIds`."
+        },
+        "version": {
+          "$ref": "#/$defs/Version"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "Version": {
+      "title": "Version",
+      "description": "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "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}$"
+    },
+    "FacetColour": {
+      "title": "FacetColour",
+      "description": "A colour **name**, resolved by each consumer against its own palette — never a hex value or any other literal. Two reasons, and both are about the consumer rather than the holder. A literal cannot be legible in a terminal, in a light theme and in a dark one at once, so a stored `#8B0000` is a colour that is wrong somewhere and the holder has no way to know where. And a consumer that reserves colours to mean something — an error, a warning, an irreversible act — must be able to keep a holder's decorative choice out of that channel; it cannot do that with an arbitrary value, and it can do it trivially with a closed set it maps itself. The eight members are chosen to be distinguishable from one another and deliberately carry no status connotation: none is named for success, warning or danger.",
+      "type": "string",
+      "enum": [
+        "slate",
+        "indigo",
+        "teal",
+        "moss",
+        "sand",
+        "clay",
+        "rose",
+        "plum"
+      ]
+    },
+    "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;