@openvtc/trust-tasks 0.16.8 → 0.16.10

package/src/persona/binding/set/1.0/payload.ts

@@ -0,0 +1,370 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/binding/set/1.0/payload.schema.json
+ */
+
+import type { ExpectedVersion_PersonaV0_1 as ExpectedVersion, Ext, Ulid, Version_PersonaV0_1 as Version } from "../../../../_shared/components.js";
+
+
+/**
+ * Assign a profile to a persona DID within a context, or clear the assignment. This is the step that pushes a composition across the context boundary: the maintainer materialises the profile into the context, and a context never reaches back the other way.
+ */
+export interface PersonaBindingSetPayload {
+  /**
+   * The context the persona lives in. The binding is context-scoped even though the profile it names is not.
+   */
+  contextId: string;
+  /**
+   * The persona being bound.
+   */
+  personaDid: string;
+  /**
+   * The profile to bind, or null to clear. Null is a first-class value and not an omission: a persona with no profile is a legitimate, common state — a throwaway identity that presents nothing — and the schema says so rather than leaving a consumer to infer it from an absent member.
+   */
+  profileId?: Ulid | null;
+  /**
+   * Attributes the holder opts into publishing on the persona's own DID document or equivalent public surface. Empty by default and MUST remain empty unless explicitly set: everything else is a per-verifier projection, and a published value is one document every relying party sees identically — a permanent correlation point the rest of this family exists to avoid.
+   *
+   * @maxItems 32
+   */
+  publicEntries?: Ulid[];
+  expectedVersion?: ExpectedVersion;
+  ext?: Ext;
+}
+/**
+ * Success response to persona/binding/set. Type https://trusttasks.org/spec/persona/binding/set/1.0#response.
+ */
+export interface PersonaBindingSetResponsePayload {
+  contextId: string;
+  personaDid: string;
+  profileId?: Ulid | null;
+  version: Version;
+  /**
+   * How many claims were materialised into the context by this binding. A count, so the holder can see that a push happened and how large it was without the response restating the values.
+   */
+  materialisedClaimCount?: number;
+  /**
+   * Advisory. Correlation is scored HERE as well as at composition, because composing is hypothetical and binding is when a value actually crosses into a context. Binding one profile to a second persona is reported at `high` unconditionally: that act makes the two personas the same person by construction.
+   */
+  correlation?: {
+    severity: "none" | "low" | "high";
+    /**
+     * How many other personas are bound to this same profile. A count, not identifiers.
+     */
+    alsoBoundPersonaCount?: number;
+  };
+  boundAt: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ExpectedVersion, Ext, Ulid, Version };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/persona/binding/set/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaBindingSetPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/binding/set/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaBindingSetResponsePayload;
+
+/**
+ * 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/binding/set/1.0",
+  "title": "Persona Binding Set — payload",
+  "description": "Assign a profile to a persona DID within a context, or clear the assignment. This is the step that pushes a composition across the context boundary: the maintainer materialises the profile into the context, and a context never reaches back the other way.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId",
+    "personaDid"
+  ],
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The context the persona lives in. The binding is context-scoped even though the profile it names is not."
+    },
+    "personaDid": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2048,
+      "description": "The persona being bound."
+    },
+    "profileId": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/Ulid"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The profile to bind, or null to clear. Null is a first-class value and not an omission: a persona with no profile is a legitimate, common state — a throwaway identity that presents nothing — and the schema says so rather than leaving a consumer to infer it from an absent member."
+    },
+    "publicEntries": {
+      "type": "array",
+      "maxItems": 32,
+      "items": {
+        "$ref": "#/$defs/Ulid"
+      },
+      "description": "Attributes the holder opts into publishing on the persona's own DID document or equivalent public surface. Empty by default and MUST remain empty unless explicitly set: everything else is a per-verifier projection, and a published value is one document every relying party sees identically — a permanent correlation point the rest of this family exists to avoid."
+    },
+    "expectedVersion": {
+      "$ref": "#/$defs/ExpectedVersion"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Persona Binding Set — response payload",
+      "description": "Success response to persona/binding/set. Type https://trusttasks.org/spec/persona/binding/set/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contextId",
+        "personaDid",
+        "version",
+        "boundAt"
+      ],
+      "properties": {
+        "contextId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "personaDid": {
+          "type": "string",
+          "minLength": 1
+        },
+        "profileId": {
+          "oneOf": [
+            {
+              "$ref": "#/$defs/Ulid"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "version": {
+          "$ref": "#/$defs/Version"
+        },
+        "materialisedClaimCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many claims were materialised into the context by this binding. A count, so the holder can see that a push happened and how large it was without the response restating the values."
+        },
+        "correlation": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "severity"
+          ],
+          "description": "Advisory. Correlation is scored HERE as well as at composition, because composing is hypothetical and binding is when a value actually crosses into a context. Binding one profile to a second persona is reported at `high` unconditionally: that act makes the two personas the same person by construction.",
+          "properties": {
+            "severity": {
+              "type": "string",
+              "enum": [
+                "none",
+                "low",
+                "high"
+              ]
+            },
+            "alsoBoundPersonaCount": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "How many other personas are bound to this same profile. A count, not identifiers."
+            }
+          }
+        },
+        "boundAt": {
+          "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-]+)+$"
+      }
+    },
+    "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}$"
+    },
+    "ExpectedVersion": {
+      "title": "ExpectedVersion",
+      "description": "Optimistic-concurrency precondition. A positive value requires the record's current `version` to equal it exactly; zero means create-only and applies only when no live record exists at the address.",
+      "type": "integer",
+      "minimum": 0
+    }
+  }
+} 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 Binding Set — response payload",
+      "description": "Success response to persona/binding/set. Type https://trusttasks.org/spec/persona/binding/set/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contextId",
+        "personaDid",
+        "version",
+        "boundAt"
+      ],
+      "properties": {
+        "contextId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "personaDid": {
+          "type": "string",
+          "minLength": 1
+        },
+        "profileId": {
+          "oneOf": [
+            {
+              "$ref": "#/$defs/Ulid"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "version": {
+          "$ref": "#/$defs/Version"
+        },
+        "materialisedClaimCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many claims were materialised into the context by this binding. A count, so the holder can see that a push happened and how large it was without the response restating the values."
+        },
+        "correlation": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "severity"
+          ],
+          "description": "Advisory. Correlation is scored HERE as well as at composition, because composing is hypothetical and binding is when a value actually crosses into a context. Binding one profile to a second persona is reported at `high` unconditionally: that act makes the two personas the same person by construction.",
+          "properties": {
+            "severity": {
+              "type": "string",
+              "enum": [
+                "none",
+                "low",
+                "high"
+              ]
+            },
+            "alsoBoundPersonaCount": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "How many other personas are bound to this same profile. A count, not identifiers."
+            }
+          }
+        },
+        "boundAt": {
+          "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-]+)+$"
+      }
+    },
+    "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}$"
+    },
+    "ExpectedVersion": {
+      "title": "ExpectedVersion",
+      "description": "Optimistic-concurrency precondition. A positive value requires the record's current `version` to equal it exactly; zero means create-only and applies only when no live record exists at the address.",
+      "type": "integer",
+      "minimum": 0
+    }
+  }
+} 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;

package/src/persona/contact/delete/1.0/payload.ts

@@ -0,0 +1,216 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/contact/delete/1.0/payload.schema.json
+ */
+
+import type { Ext, Ulid } from "../../../../_shared/components.js";
+
+
+/**
+ * Remove a contact and every revision of it.
+ */
+export interface PersonaContactDeletePayload {
+  contextId: string;
+  contactId: Ulid;
+  ext?: Ext;
+}
+/**
+ * Success response to persona/contact/delete. Type https://trusttasks.org/spec/persona/contact/delete/1.0#response. Deleting an absent contact is a success carrying existed: false, which is what makes a repeated delete converge.
+ */
+export interface PersonaContactDeleteResponsePayload {
+  contactId: Ulid;
+  existed: boolean;
+  /**
+   * How many revisions went with it, so a holder deleting a long history is told the size of what they removed.
+   */
+  revisionsRemoved?: number;
+  /**
+   * Revisions NOT removed because a disclosure record still references them. A maintainer that keeps such revisions MUST report the count rather than let the holder believe the deletion was total — an incomplete erasure the holder thinks is complete is worse than one they know about.
+   */
+  retainedForDisclosure?: number;
+  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/contact/delete/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaContactDeletePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/contact/delete/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaContactDeleteResponsePayload;
+
+/**
+ * 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/contact/delete/1.0",
+  "title": "Persona Contact Delete — payload",
+  "description": "Remove a contact and every revision of it.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId",
+    "contactId"
+  ],
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "contactId": {
+      "$ref": "#/$defs/Ulid"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Persona Contact Delete — response payload",
+      "description": "Success response to persona/contact/delete. Type https://trusttasks.org/spec/persona/contact/delete/1.0#response. Deleting an absent contact is a success carrying existed: false, which is what makes a repeated delete converge.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contactId",
+        "existed"
+      ],
+      "properties": {
+        "contactId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "existed": {
+          "type": "boolean"
+        },
+        "revisionsRemoved": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many revisions went with it, so a holder deleting a long history is told the size of what they removed."
+        },
+        "retainedForDisclosure": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Revisions NOT removed because a disclosure record still references them. A maintainer that keeps such revisions MUST report the count rather than let the holder believe the deletion was total — an incomplete erasure the holder thinks is complete is worse than one they know about."
+        },
+        "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 Contact Delete — response payload",
+      "description": "Success response to persona/contact/delete. Type https://trusttasks.org/spec/persona/contact/delete/1.0#response. Deleting an absent contact is a success carrying existed: false, which is what makes a repeated delete converge.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contactId",
+        "existed"
+      ],
+      "properties": {
+        "contactId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "existed": {
+          "type": "boolean"
+        },
+        "revisionsRemoved": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many revisions went with it, so a holder deleting a long history is told the size of what they removed."
+        },
+        "retainedForDisclosure": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Revisions NOT removed because a disclosure record still references them. A maintainer that keeps such revisions MUST report the count rather than let the holder believe the deletion was total — an incomplete erasure the holder thinks is complete is worse than one they know about."
+        },
+        "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;