@openvtc/trust-tasks 0.19.17 → 0.19.19

package/dist/persona/profile/retire/1.0/payload.d.ts

@@ -0,0 +1,436 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/profile/retire/1.0/payload.schema.json
+ */
+import type { ExpectedVersion_PersonaV0_1 as ExpectedVersion, Ext, Ulid, Version_PersonaV0_1 as Version } from "../../../../_shared/components.js";
+/**
+ * Stop being a face everywhere, and keep it. The face is taken off every persona wearing it, left out of pickers and default listings, and cannot be worn until reinstated; its values and its disclosure history are kept. The reversible middle between 'not here' (a null persona/binding/set) and 'gone' (persona/profile/delete).
+ */
+export interface PersonaProfileRetirePayload {
+    /**
+     * A pool face, or a context-local one.
+     */
+    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/retire. Type https://trusttasks.org/spec/persona/profile/retire/1.0#response. Retiring a face already retired is a success that changes nothing and takes no new version, so a repeated retire converges.
+ */
+export interface PersonaProfileRetireResponsePayload {
+    profileId: Ulid;
+    version: Version;
+    retiredAt: string;
+    /**
+     * Where the face was worn and no longer is. Absent when it was worn nowhere.
+     *
+     * @maxItems 256
+     */
+    unbound?: {
+        contextId: string;
+        personaDid: 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 declare const TYPE_URI: "https://trusttasks.org/spec/persona/profile/retire/1.0";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaProfileRetirePayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/persona/profile/retire/1.0#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaProfileRetireResponsePayload;
+/**
+ * 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/persona/profile/retire/1.0";
+    readonly title: "Persona Profile Retire — payload";
+    readonly description: "Stop being a face everywhere, and keep it. The face is taken off every persona wearing it, left out of pickers and default listings, and cannot be worn until reinstated; its values and its disclosure history are kept. The reversible middle between 'not here' (a null persona/binding/set) and 'gone' (persona/profile/delete).";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["profileId"];
+    readonly properties: {
+        readonly profileId: {
+            readonly $ref: "#/$defs/Ulid";
+            readonly description: "A pool face, or a context-local one.";
+        };
+        readonly contextId: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "The context a context-local face lives in. Omit for a pool face.";
+        };
+        readonly expectedVersion: {
+            readonly $ref: "#/$defs/ExpectedVersion";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Persona Profile Retire — response payload";
+            readonly description: "Success response to persona/profile/retire. Type https://trusttasks.org/spec/persona/profile/retire/1.0#response. Retiring a face already retired is a success that changes nothing and takes no new version, so a repeated retire converges.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["profileId", "version", "retiredAt"];
+            readonly properties: {
+                readonly profileId: {
+                    readonly $ref: "#/$defs/Ulid";
+                };
+                readonly version: {
+                    readonly $ref: "#/$defs/Version";
+                };
+                readonly retiredAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly unbound: {
+                    readonly type: "array";
+                    readonly maxItems: 256;
+                    readonly description: "Where the face was worn and no longer is. Absent when it was worn nowhere.";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["contextId", "personaDid"];
+                        readonly properties: {
+                            readonly contextId: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly personaDid: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                    };
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly Version: {
+            readonly title: "Version";
+            readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
+            readonly type: "integer";
+            readonly minimum: 1;
+        };
+        readonly Ulid: {
+            readonly title: "Ulid";
+            readonly 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.";
+            readonly type: "string";
+            readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
+        };
+        readonly ExpectedVersion: {
+            readonly title: "ExpectedVersion";
+            readonly 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.";
+            readonly type: "integer";
+            readonly minimum: 0;
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Persona Profile Retire — response payload";
+            readonly description: "Success response to persona/profile/retire. Type https://trusttasks.org/spec/persona/profile/retire/1.0#response. Retiring a face already retired is a success that changes nothing and takes no new version, so a repeated retire converges.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["profileId", "version", "retiredAt"];
+            readonly properties: {
+                readonly profileId: {
+                    readonly $ref: "#/$defs/Ulid";
+                };
+                readonly version: {
+                    readonly $ref: "#/$defs/Version";
+                };
+                readonly retiredAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly unbound: {
+                    readonly type: "array";
+                    readonly maxItems: 256;
+                    readonly description: "Where the face was worn and no longer is. Absent when it was worn nowhere.";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["contextId", "personaDid"];
+                        readonly properties: {
+                            readonly contextId: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly personaDid: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                    };
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly Version: {
+            readonly title: "Version";
+            readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
+            readonly type: "integer";
+            readonly minimum: 1;
+        };
+        readonly Ulid: {
+            readonly title: "Ulid";
+            readonly 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.";
+            readonly type: "string";
+            readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
+        };
+        readonly ExpectedVersion: {
+            readonly title: "ExpectedVersion";
+            readonly 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.";
+            readonly type: "integer";
+            readonly minimum: 0;
+        };
+    };
+};
+/**
+ * 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 declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/persona/profile/retire/1.0";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/persona/profile/retire/1.0";
+        readonly title: "Persona Profile Retire — payload";
+        readonly description: "Stop being a face everywhere, and keep it. The face is taken off every persona wearing it, left out of pickers and default listings, and cannot be worn until reinstated; its values and its disclosure history are kept. The reversible middle between 'not here' (a null persona/binding/set) and 'gone' (persona/profile/delete).";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["profileId"];
+        readonly properties: {
+            readonly profileId: {
+                readonly $ref: "#/$defs/Ulid";
+                readonly description: "A pool face, or a context-local one.";
+            };
+            readonly contextId: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "The context a context-local face lives in. Omit for a pool face.";
+            };
+            readonly expectedVersion: {
+                readonly $ref: "#/$defs/ExpectedVersion";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Persona Profile Retire — response payload";
+                readonly description: "Success response to persona/profile/retire. Type https://trusttasks.org/spec/persona/profile/retire/1.0#response. Retiring a face already retired is a success that changes nothing and takes no new version, so a repeated retire converges.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["profileId", "version", "retiredAt"];
+                readonly properties: {
+                    readonly profileId: {
+                        readonly $ref: "#/$defs/Ulid";
+                    };
+                    readonly version: {
+                        readonly $ref: "#/$defs/Version";
+                    };
+                    readonly retiredAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly unbound: {
+                        readonly type: "array";
+                        readonly maxItems: 256;
+                        readonly description: "Where the face was worn and no longer is. Absent when it was worn nowhere.";
+                        readonly items: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["contextId", "personaDid"];
+                            readonly properties: {
+                                readonly contextId: {
+                                    readonly type: "string";
+                                    readonly minLength: 1;
+                                };
+                                readonly personaDid: {
+                                    readonly type: "string";
+                                    readonly minLength: 1;
+                                };
+                            };
+                        };
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly Version: {
+                readonly title: "Version";
+                readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
+                readonly type: "integer";
+                readonly minimum: 1;
+            };
+            readonly Ulid: {
+                readonly title: "Ulid";
+                readonly 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.";
+                readonly type: "string";
+                readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
+            };
+            readonly ExpectedVersion: {
+                readonly title: "ExpectedVersion";
+                readonly 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.";
+                readonly type: "integer";
+                readonly minimum: 0;
+            };
+        };
+    };
+};
+/**
+ * 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 declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/persona/profile/retire/1.0#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Persona Profile Retire — response payload";
+                readonly description: "Success response to persona/profile/retire. Type https://trusttasks.org/spec/persona/profile/retire/1.0#response. Retiring a face already retired is a success that changes nothing and takes no new version, so a repeated retire converges.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["profileId", "version", "retiredAt"];
+                readonly properties: {
+                    readonly profileId: {
+                        readonly $ref: "#/$defs/Ulid";
+                    };
+                    readonly version: {
+                        readonly $ref: "#/$defs/Version";
+                    };
+                    readonly retiredAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly unbound: {
+                        readonly type: "array";
+                        readonly maxItems: 256;
+                        readonly description: "Where the face was worn and no longer is. Absent when it was worn nowhere.";
+                        readonly items: {
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["contextId", "personaDid"];
+                            readonly properties: {
+                                readonly contextId: {
+                                    readonly type: "string";
+                                    readonly minLength: 1;
+                                };
+                                readonly personaDid: {
+                                    readonly type: "string";
+                                    readonly minLength: 1;
+                                };
+                            };
+                        };
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly Version: {
+                readonly title: "Version";
+                readonly description: "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.";
+                readonly type: "integer";
+                readonly minimum: 1;
+            };
+            readonly Ulid: {
+                readonly title: "Ulid";
+                readonly 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.";
+                readonly type: "string";
+                readonly pattern: "^[0-9A-HJKMNP-TV-Z]{26}$";
+            };
+            readonly ExpectedVersion: {
+                readonly title: "ExpectedVersion";
+                readonly 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.";
+                readonly type: "integer";
+                readonly minimum: 0;
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/persona/profile/retire/1.0/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/persona/profile/retire/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,2BAA2B,IAAI,eAAe,EAAE,GAAG,EAAE,IAAI,EAAE,mBAAmB,IAAI,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAGnJ;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,SAAS,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE;QACR,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;KACpB,EAAE,CAAC;IACJ,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,eAAe,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAEpD,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,wDAAiE,CAAC;AAE1F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,2BAA2B,CAAC;AAElD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,iEAA0E,CAAC;AAE5G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,mCAAmC,CAAC;AAE3D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2GjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmF1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}