@openvtc/trust-tasks 0.19.17 → 0.19.18

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

@@ -27,6 +27,13 @@ export interface PersonaProfileDeleteResponsePayload {
    * False when no live profile was present. A repeat delete returns false and deliberately takes no new version, so watchers never observe a change that did not happen.
    */
   existed: boolean;
+  /**
+   * How many distinct parties this face has disclosed to, across how many contexts, from the holder's disclosure history. Counts, not identifiers; persona/disclosure/history names them. Returned on the delete because the delete does not un-tell anyone: the history, and what those parties hold, remain.
+   */
+  disclosedTo?: {
+    partyCount: number;
+    contextCount: number;
+  };
   /**
    * Persona DIDs whose bindings were cleared. Present only when `unbind` was true and something was cleared — a holder is owed the list of which personas their one action left presenting nothing.
    *
@@ -105,6 +112,25 @@ export const PAYLOAD_SCHEMA = {
           "type": "boolean",
           "description": "False when no live profile was present. A repeat delete returns false and deliberately takes no new version, so watchers never observe a change that did not happen."
         },
+        "disclosedTo": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "partyCount",
+            "contextCount"
+          ],
+          "description": "How many distinct parties this face has disclosed to, across how many contexts, from the holder's disclosure history. Counts, not identifiers; persona/disclosure/history names them. Returned on the delete because the delete does not un-tell anyone: the history, and what those parties hold, remain.",
+          "properties": {
+            "partyCount": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "contextCount": {
+              "type": "integer",
+              "minimum": 0
+            }
+          }
+        },
         "unboundPersonas": {
           "type": "array",
           "maxItems": 256,
@@ -167,6 +193,25 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
           "type": "boolean",
           "description": "False when no live profile was present. A repeat delete returns false and deliberately takes no new version, so watchers never observe a change that did not happen."
         },
+        "disclosedTo": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "partyCount",
+            "contextCount"
+          ],
+          "description": "How many distinct parties this face has disclosed to, across how many contexts, from the holder's disclosure history. Counts, not identifiers; persona/disclosure/history names them. Returned on the delete because the delete does not un-tell anyone: the history, and what those parties hold, remain.",
+          "properties": {
+            "partyCount": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "contextCount": {
+              "type": "integer",
+              "minimum": 0
+            }
+          }
+        },
         "unboundPersonas": {
           "type": "array",
           "maxItems": 256,

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

@@ -22,6 +22,13 @@ export interface PersonaProfileGetPayload {
  */
 export interface PersonaProfileGetResponsePayload {
   profile: Profile;
+  /**
+   * How many distinct parties this face has disclosed to, across how many contexts, from the holder's disclosure history. Counts, not identifiers; persona/disclosure/history names them. A producer shows this before a delete: deleting a face does not un-tell anyone what it told them.
+   */
+  disclosedTo?: {
+    partyCount: number;
+    contextCount: number;
+  };
   /**
    * Present only when `resolve` was true: the claims this profile would present, in entry order, with overrides applied and pinned versions honoured. A credential-backed claim whose backing could not be re-derived appears carrying `stale`, because a holder inspecting a profile needs to see that it has stopped being fully presentable.
    *
@@ -94,6 +101,25 @@ export const PAYLOAD_SCHEMA = {
         "profile": {
           "$ref": "#/$defs/Profile"
         },
+        "disclosedTo": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "partyCount",
+            "contextCount"
+          ],
+          "description": "How many distinct parties this face has disclosed to, across how many contexts, from the holder's disclosure history. Counts, not identifiers; persona/disclosure/history names them. A producer shows this before a delete: deleting a face does not un-tell anyone what it told them.",
+          "properties": {
+            "partyCount": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "contextCount": {
+              "type": "integer",
+              "minimum": 0
+            }
+          }
+        },
         "resolved": {
           "type": "array",
           "maxItems": 256,
@@ -333,6 +359,20 @@ export const PAYLOAD_SCHEMA = {
             "$ref": "#/$defs/ProfileEntry"
           }
         },
+        "status": {
+          "type": "string",
+          "enum": [
+            "active",
+            "retired"
+          ],
+          "default": "active",
+          "description": "`retired`: the face is worn nowhere, is left out of pickers and default listings, and cannot be worn until reinstated (persona/profile/retire, persona/profile/reinstate). Its disclosure history and every value it carries are kept — retiring is 'stop being this', not 'forget this'. Absent reads as `active`."
+        },
+        "retiredAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the face was retired. Present exactly when `status` is `retired`."
+        },
         "credentialRefs": {
           "type": "array",
           "maxItems": 256,
@@ -482,6 +522,25 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "profile": {
           "$ref": "#/$defs/Profile"
         },
+        "disclosedTo": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "partyCount",
+            "contextCount"
+          ],
+          "description": "How many distinct parties this face has disclosed to, across how many contexts, from the holder's disclosure history. Counts, not identifiers; persona/disclosure/history names them. A producer shows this before a delete: deleting a face does not un-tell anyone what it told them.",
+          "properties": {
+            "partyCount": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "contextCount": {
+              "type": "integer",
+              "minimum": 0
+            }
+          }
+        },
         "resolved": {
           "type": "array",
           "maxItems": 256,
@@ -721,6 +780,20 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
             "$ref": "#/$defs/ProfileEntry"
           }
         },
+        "status": {
+          "type": "string",
+          "enum": [
+            "active",
+            "retired"
+          ],
+          "default": "active",
+          "description": "`retired`: the face is worn nowhere, is left out of pickers and default listings, and cannot be worn until reinstated (persona/profile/retire, persona/profile/reinstate). Its disclosure history and every value it carries are kept — retiring is 'stop being this', not 'forget this'. Absent reads as `active`."
+        },
+        "retiredAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the face was retired. Present exactly when `status` is `retired`."
+        },
         "credentialRefs": {
           "type": "array",
           "maxItems": 256,

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

@@ -15,6 +15,10 @@ export interface PersonaProfileListPayload {
    */
   cursor?: string;
   limit?: number;
+  /**
+   * Include retired faces. Off by default: a retired face is one the holder has stopped being, and a picker that offered it back would undo the decision by accident.
+   */
+  includeRetired?: boolean;
   ext?: Ext;
 }
 /**
@@ -75,6 +79,11 @@ export const PAYLOAD_SCHEMA = {
       "maximum": 500,
       "default": 100
     },
+    "includeRetired": {
+      "type": "boolean",
+      "default": false,
+      "description": "Include retired faces. Off by default: a retired face is one the holder has stopped being, and a picker that offered it back would undo the decision by accident."
+    },
     "ext": {
       "$ref": "#/$defs/Ext"
     }
@@ -146,6 +155,20 @@ export const PAYLOAD_SCHEMA = {
             "$ref": "#/$defs/ProfileEntry"
           }
         },
+        "status": {
+          "type": "string",
+          "enum": [
+            "active",
+            "retired"
+          ],
+          "default": "active",
+          "description": "`retired`: the face is worn nowhere, is left out of pickers and default listings, and cannot be worn until reinstated (persona/profile/retire, persona/profile/reinstate). Its disclosure history and every value it carries are kept — retiring is 'stop being this', not 'forget this'. Absent reads as `active`."
+        },
+        "retiredAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the face was retired. Present exactly when `status` is `retired`."
+        },
         "credentialRefs": {
           "type": "array",
           "maxItems": 256,
@@ -473,6 +496,20 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
             "$ref": "#/$defs/ProfileEntry"
           }
         },
+        "status": {
+          "type": "string",
+          "enum": [
+            "active",
+            "retired"
+          ],
+          "default": "active",
+          "description": "`retired`: the face is worn nowhere, is left out of pickers and default listings, and cannot be worn until reinstated (persona/profile/retire, persona/profile/reinstate). Its disclosure history and every value it carries are kept — retiring is 'stop being this', not 'forget this'. Absent reads as `active`."
+        },
+        "retiredAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the face was retired. Present exactly when `status` is `retired`."
+        },
         "credentialRefs": {
           "type": "array",
           "maxItems": 256,

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

@@ -0,0 +1,219 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/profile/reinstate/1.0/payload.schema.json
+ */
+
+import type { ExpectedVersion_PersonaV0_1 as ExpectedVersion, Ext, Ulid, Version_PersonaV0_1 as Version } from "../../../../_shared/components.js";
+
+
+/**
+ * Make a retired face wearable again. It is worn nowhere afterwards: the bindings retiring cleared are not restored, because wearing a face in a context is a decision about that context, taken when it is taken.
+ */
+export interface PersonaProfileReinstatePayload {
+  profileId: Ulid;
+  /**
+   * The context a context-local face lives in. Omit for a pool face.
+   */
+  contextId?: string;
+  expectedVersion?: ExpectedVersion;
+  ext?: Ext;
+}
+/**
+ * Success response to persona/profile/reinstate. Type https://trusttasks.org/spec/persona/profile/reinstate/1.0#response. Reinstating an active face is a success that changes nothing and takes no new version.
+ */
+export interface PersonaProfileReinstateResponsePayload {
+  profileId: Ulid;
+  version: Version;
+  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/profile/reinstate/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaProfileReinstatePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/profile/reinstate/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaProfileReinstateResponsePayload;
+
+/**
+ * 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/reinstate/1.0",
+  "title": "Persona Profile Reinstate — payload",
+  "description": "Make a retired face wearable again. It is worn nowhere afterwards: the bindings retiring cleared are not restored, because wearing a face in a context is a decision about that context, taken when it is taken.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "profileId"
+  ],
+  "properties": {
+    "profileId": {
+      "$ref": "#/$defs/Ulid"
+    },
+    "contextId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The context a context-local face lives in. Omit for a pool face."
+    },
+    "expectedVersion": {
+      "$ref": "#/$defs/ExpectedVersion"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Persona Profile Reinstate — response payload",
+      "description": "Success response to persona/profile/reinstate. Type https://trusttasks.org/spec/persona/profile/reinstate/1.0#response. Reinstating an active face is a success that changes nothing and takes no new version.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "profileId",
+        "version"
+      ],
+      "properties": {
+        "profileId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "version": {
+          "$ref": "#/$defs/Version"
+        },
+        "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 Profile Reinstate — response payload",
+      "description": "Success response to persona/profile/reinstate. Type https://trusttasks.org/spec/persona/profile/reinstate/1.0#response. Reinstating an active face is a success that changes nothing and takes no new version.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "profileId",
+        "version"
+      ],
+      "properties": {
+        "profileId": {
+          "$ref": "#/$defs/Ulid"
+        },
+        "version": {
+          "$ref": "#/$defs/Version"
+        },
+        "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;