@openvtc/trust-tasks 0.16.9 → 0.16.10

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

@@ -0,0 +1,238 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/attribute/delete/1.0/payload.schema.json
+ */
+
+import type { ExpectedVersion_PersonaV0_1 as ExpectedVersion, Ext, Ulid } from "../../../../_shared/components.js";
+
+
+/**
+ * Remove one attribute from the holder's pool. Refused by default while any profile still references it, because a silent removal would change what those profiles present without the holder having said so.
+ */
+export interface PersonaAttributeDeletePayload {
+  attributeId: Ulid;
+  /**
+   * When false (the default) a referenced attribute is refused, and the error names the referring profiles so the holder can decide. When true the attribute is removed and every referring profile entry is removed with it. Cascade is the destructive option and is therefore never the default: deleting one fact and silently changing what three profiles disclose is exactly the surprise this family exists to prevent.
+   */
+  cascade?: boolean;
+  /**
+   * Optional precondition, so a delete cannot race a concurrent edit the holder has not seen.
+   */
+  expectedVersion?: ExpectedVersion;
+  ext?: Ext;
+}
+/**
+ * Success response to persona/attribute/delete. Type https://trusttasks.org/spec/persona/attribute/delete/1.0#response. Deleting an attribute that is already absent is a success carrying `existed: false`, which is what makes a repeated delete converge.
+ */
+export interface PersonaAttributeDeleteResponsePayload {
+  attributeId: Ulid;
+  /**
+   * False when no live attribute was present. A repeat delete returns false and deliberately does NOT take a new counter value — had it done so, every consumer watching the store would see a change that did not happen, and delete could not be safely retried.
+   */
+  existed: boolean;
+  /**
+   * Profiles whose entries were removed by a cascading delete. Present only when `cascade` was true and something was removed; a holder is owed the list of what their one action changed.
+   *
+   * @maxItems 256
+   */
+  removedFromProfiles?: Ulid[];
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ExpectedVersion, Ext, Ulid };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/persona/attribute/delete/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaAttributeDeletePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/attribute/delete/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaAttributeDeleteResponsePayload;
+
+/**
+ * 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/delete/1.0",
+  "title": "Persona Attribute Delete — payload",
+  "description": "Remove one attribute from the holder's pool. Refused by default while any profile still references it, because a silent removal would change what those profiles present without the holder having said so.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "attributeId"
+  ],
+  "properties": {
+    "attributeId": {
+      "$ref": "#/$defs/Ulid"
+    },
+    "cascade": {
+      "type": "boolean",
+      "default": false,
+      "description": "When false (the default) a referenced attribute is refused, and the error names the referring profiles so the holder can decide. When true the attribute is removed and every referring profile entry is removed with it. Cascade is the destructive option and is therefore never the default: deleting one fact and silently changing what three profiles disclose is exactly the surprise this family exists to prevent."
+    },
+    "expectedVersion": {
+      "$ref": "#/$defs/ExpectedVersion",
+      "description": "Optional precondition, so a delete cannot race a concurrent edit the holder has not seen."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Persona Attribute Delete — response payload",
+      "description": "Success response to persona/attribute/delete. Type https://trusttasks.org/spec/persona/attribute/delete/1.0#response. Deleting an attribute that is already absent is a success carrying `existed: false`, which is what makes a repeated delete converge.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "attributeId",
+        "existed"
+      ],
+      "properties": {
+        "attributeId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "existed": {
+          "type": "boolean",
+          "description": "False when no live attribute was present. A repeat delete returns false and deliberately does NOT take a new counter value — had it done so, every consumer watching the store would see a change that did not happen, and delete could not be safely retried."
+        },
+        "removedFromProfiles": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "$ref": "#/$defs/Ulid"
+          },
+          "description": "Profiles whose entries were removed by a cascading delete. Present only when `cascade` was true and something was removed; a holder is owed the list of what their one action changed."
+        },
+        "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}$"
+    },
+    "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 Attribute Delete — response payload",
+      "description": "Success response to persona/attribute/delete. Type https://trusttasks.org/spec/persona/attribute/delete/1.0#response. Deleting an attribute that is already absent is a success carrying `existed: false`, which is what makes a repeated delete converge.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "attributeId",
+        "existed"
+      ],
+      "properties": {
+        "attributeId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "existed": {
+          "type": "boolean",
+          "description": "False when no live attribute was present. A repeat delete returns false and deliberately does NOT take a new counter value — had it done so, every consumer watching the store would see a change that did not happen, and delete could not be safely retried."
+        },
+        "removedFromProfiles": {
+          "type": "array",
+          "maxItems": 256,
+          "items": {
+            "$ref": "#/$defs/Ulid"
+          },
+          "description": "Profiles whose entries were removed by a cascading delete. Present only when `cascade` was true and something was removed; a holder is owed the list of what their one action changed."
+        },
+        "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}$"
+    },
+    "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;