@openvtc/trust-tasks 0.27.2 → 0.27.4

package/src/persona/attribute/promote/1.1/payload.ts

@@ -0,0 +1,344 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/attribute/promote/1.1/payload.schema.json
+ */
+
+import type { Ext, Ulid, Version_PersonaV0_1 as Version } from "../../../../_shared/components.js";
+
+
+/**
+ * Make values a context-local face carries reusable: each named entry's value becomes a pool attribute, and the face — which can no longer live inside one context once it references the pool — moves above contexts, keeping its id and staying worn wherever it was. One-way.
+ */
+export interface PersonaAttributePromotePayload {
+  /**
+   * The context the local face lives in.
+   */
+  contextId: string;
+  /**
+   * The context-local face.
+   */
+  profileId: Ulid;
+  /**
+   * Zero-based positions, in the face's `entries`, of the values to promote. Positions are meaningful only against the version the producer read, which is why `expectedVersion` is required.
+   *
+   * @minItems 1
+   * @maxItems 64
+   */
+  entries: [number, ...number[]];
+  /**
+   * The local face's version as the producer read it. Required: a position into a face edited since would promote a different value than the holder chose.
+   */
+  expectedVersion: Version;
+  ext?: Ext;
+}
+/**
+ * Success response to persona/attribute/promote. Type https://trusttasks.org/spec/persona/attribute/promote/1.1#response.
+ */
+export interface PersonaAttributePromoteResponsePayload {
+  /**
+   * Unchanged: the face keeps its id. It is now read through persona/profile/get.
+   */
+  profileId: Ulid;
+  /**
+   * The face's version in the pool.
+   */
+  version: Version;
+  /**
+   * For each promoted position, in request order, the pool attribute the entry now references and whether this promote created it. `wasCreated: false` means the holder already kept exactly this value, and the face now shares it with whatever else presents it.
+   *
+   * @minItems 1
+   * @maxItems 64
+   */
+  promoted: [
+    {
+      entry: number;
+      attributeId: Ulid;
+      wasCreated: boolean;
+    },
+    ...{
+      entry: number;
+      attributeId: Ulid;
+      wasCreated: boolean;
+    }[]
+  ];
+  /**
+   * Personas in `contextId` that wore the local face and now wear it from the pool. What they present is unchanged. Absent when none did.
+   *
+   * @maxItems 256
+   */
+  reboundPersonaDids?: string[];
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, Ulid, Version };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/persona/attribute/promote/1.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaAttributePromotePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/attribute/promote/1.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaAttributePromoteResponsePayload;
+
+/**
+ * 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/attribute/promote/1.1",
+  "title": "Persona Attribute Promote — payload",
+  "description": "Make values a context-local face carries reusable: each named entry's value becomes a pool attribute, and the face — which can no longer live inside one context once it references the pool — moves above contexts, keeping its id and staying worn wherever it was. One-way.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId",
+    "profileId",
+    "entries",
+    "expectedVersion"
+  ],
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The context the local face lives in."
+    },
+    "profileId": {
+      "$ref": "#/$defs/Ulid",
+      "description": "The context-local face."
+    },
+    "entries": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 64,
+      "uniqueItems": true,
+      "items": {
+        "type": "integer",
+        "minimum": 0
+      },
+      "description": "Zero-based positions, in the face's `entries`, of the values to promote. Positions are meaningful only against the version the producer read, which is why `expectedVersion` is required."
+    },
+    "expectedVersion": {
+      "$ref": "#/$defs/Version",
+      "description": "The local face's version as the producer read it. Required: a position into a face edited since would promote a different value than the holder chose."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Persona Attribute Promote — response payload",
+      "description": "Success response to persona/attribute/promote. Type https://trusttasks.org/spec/persona/attribute/promote/1.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "profileId",
+        "version",
+        "promoted"
+      ],
+      "properties": {
+        "profileId": {
+          "$ref": "#/$defs/Ulid",
+          "description": "Unchanged: the face keeps its id. It is now read through persona/profile/get."
+        },
+        "version": {
+          "$ref": "#/$defs/Version",
+          "description": "The face's version in the pool."
+        },
+        "promoted": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 64,
+          "description": "For each promoted position, in request order, the pool attribute the entry now references and whether this promote created it. `wasCreated: false` means the holder already kept exactly this value, and the face now shares it with whatever else presents it.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "entry",
+              "attributeId",
+              "wasCreated"
+            ],
+            "properties": {
+              "entry": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "attributeId": {
+                "$ref": "#/$defs/Ulid"
+              },
+              "wasCreated": {
+                "type": "boolean"
+              }
+            }
+          }
+        },
+        "reboundPersonaDids": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Personas in `contextId` that wore the local face and now wear it from the pool. What they present is unchanged. Absent when none did."
+        },
+        "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
+    }
+  }
+} 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 Attribute Promote — response payload",
+      "description": "Success response to persona/attribute/promote. Type https://trusttasks.org/spec/persona/attribute/promote/1.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "profileId",
+        "version",
+        "promoted"
+      ],
+      "properties": {
+        "profileId": {
+          "$ref": "#/$defs/Ulid",
+          "description": "Unchanged: the face keeps its id. It is now read through persona/profile/get."
+        },
+        "version": {
+          "$ref": "#/$defs/Version",
+          "description": "The face's version in the pool."
+        },
+        "promoted": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 64,
+          "description": "For each promoted position, in request order, the pool attribute the entry now references and whether this promote created it. `wasCreated: false` means the holder already kept exactly this value, and the face now shares it with whatever else presents it.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "entry",
+              "attributeId",
+              "wasCreated"
+            ],
+            "properties": {
+              "entry": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "attributeId": {
+                "$ref": "#/$defs/Ulid"
+              },
+              "wasCreated": {
+                "type": "boolean"
+              }
+            }
+          }
+        },
+        "reboundPersonaDids": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Personas in `contextId` that wore the local face and now wear it from the pool. What they present is unchanged. Absent when none did."
+        },
+        "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
+    }
+  }
+} 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;