@openvtc/trust-tasks 0.16.9 → 0.16.11

package/dist/persona/contact/list/1.0/payload.js

@@ -0,0 +1,262 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/contact/list/1.0/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/persona/contact/list/1.0";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/contact/list/1.0#response";
+/**
+ * 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/list/1.0",
+    "title": "Persona Contact List — payload",
+    "description": "Enumerate contacts in a context, optionally narrowed to those known by one persona. Summaries only; documents are fetched one at a time.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "contextId"
+    ],
+    "properties": {
+        "contextId": {
+            "type": "string",
+            "minLength": 1
+        },
+        "knownByPersona": {
+            "type": "string",
+            "maxLength": 2048,
+            "description": "Narrow to contacts known by this persona. Omitting it lists the context's contacts across every persona in it, which a producer SHOULD offer deliberately rather than by default — the unfiltered view is the one that shows the holder's personas side by side."
+        },
+        "changedSince": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Return only contacts whose current revision was received after this instant. The cheap way to answer \"what changed while I was away\", which is the question the revision history exists to make answerable."
+        },
+        "cursor": {
+            "type": "string",
+            "maxLength": 4096
+        },
+        "limit": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 500,
+            "default": 100
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "Persona Contact List — response payload",
+            "description": "Success response to persona/contact/list. Type https://trusttasks.org/spec/persona/contact/list/1.0#response. Summaries carry no claim values: a list is for finding a contact, and finding one does not require disclosing every contact's details.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "contacts"
+            ],
+            "properties": {
+                "contacts": {
+                    "type": "array",
+                    "maxItems": 500,
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "required": [
+                            "contactId",
+                            "subjectDid",
+                            "knownByPersona",
+                            "rev",
+                            "receivedAt"
+                        ],
+                        "properties": {
+                            "contactId": {
+                                "$ref": "#/$defs/Ulid"
+                            },
+                            "subjectDid": {
+                                "type": "string",
+                                "minLength": 1
+                            },
+                            "knownByPersona": {
+                                "type": "string",
+                                "minLength": 1
+                            },
+                            "rev": {
+                                "type": "integer",
+                                "minimum": 1
+                            },
+                            "displayName": {
+                                "type": "string",
+                                "maxLength": 256,
+                                "description": "A rendering hint drawn from the contact's own disclosed display-name claim, so a list is legible. Absent when they disclosed none; a producer MUST NOT substitute the DID silently as though it were a name."
+                            },
+                            "claimCount": {
+                                "type": "integer",
+                                "minimum": 0
+                            },
+                            "receivedAt": {
+                                "type": "string",
+                                "format": "date-time"
+                            },
+                            "hasUnreviewedChange": {
+                                "type": "boolean",
+                                "description": "True when the current revision superseded another and the holder has not yet acknowledged the difference. This is what lets a producer badge a contact whose payment address moved — the whole point of keeping revisions."
+                            }
+                        }
+                    }
+                },
+                "nextCursor": {
+                    "type": "string",
+                    "maxLength": 4096
+                },
+                "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 {@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 List — response payload",
+            "description": "Success response to persona/contact/list. Type https://trusttasks.org/spec/persona/contact/list/1.0#response. Summaries carry no claim values: a list is for finding a contact, and finding one does not require disclosing every contact's details.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "contacts"
+            ],
+            "properties": {
+                "contacts": {
+                    "type": "array",
+                    "maxItems": 500,
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "required": [
+                            "contactId",
+                            "subjectDid",
+                            "knownByPersona",
+                            "rev",
+                            "receivedAt"
+                        ],
+                        "properties": {
+                            "contactId": {
+                                "$ref": "#/$defs/Ulid"
+                            },
+                            "subjectDid": {
+                                "type": "string",
+                                "minLength": 1
+                            },
+                            "knownByPersona": {
+                                "type": "string",
+                                "minLength": 1
+                            },
+                            "rev": {
+                                "type": "integer",
+                                "minimum": 1
+                            },
+                            "displayName": {
+                                "type": "string",
+                                "maxLength": 256,
+                                "description": "A rendering hint drawn from the contact's own disclosed display-name claim, so a list is legible. Absent when they disclosed none; a producer MUST NOT substitute the DID silently as though it were a name."
+                            },
+                            "claimCount": {
+                                "type": "integer",
+                                "minimum": 0
+                            },
+                            "receivedAt": {
+                                "type": "string",
+                                "format": "date-time"
+                            },
+                            "hasUnreviewedChange": {
+                                "type": "boolean",
+                                "description": "True when the current revision superseded another and the holder has not yet acknowledged the difference. This is what lets a producer badge a contact whose payment address moved — the whole point of keeping revisions."
+                            }
+                        }
+                    }
+                },
+                "nextCursor": {
+                    "type": "string",
+                    "maxLength": 4096
+                },
+                "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}$"
+        }
+    }
+};
+/**
+ * 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: false,
+    payloadSchema: PAYLOAD_SCHEMA,
+};
+/**
+ * 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: false,
+    payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+};
+//# sourceMappingURL=payload.js.map

package/dist/persona/contact/list/1.0/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/persona/contact/list/1.0/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAoDH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,sDAA+D,CAAC;AAKxF,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,+DAAwE,CAAC;AAK1G;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,sDAAsD;IAC7D,OAAO,EAAE,gCAAgC;IACzC,aAAa,EAAE,0IAA0I;IACzJ,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,WAAW;KACZ;IACD,YAAY,EAAE;QACZ,WAAW,EAAE;YACX,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;SACf;QACD,gBAAgB,EAAE;YAChB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,kQAAkQ;SAClR;QACD,cAAc,EAAE;YACd,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,WAAW;YACrB,aAAa,EAAE,+MAA+M;SAC/N;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,IAAI;SAClB;QACD,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,GAAG;YACd,SAAS,EAAE,GAAG;SACf;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,yCAAyC;YAClD,aAAa,EAAE,sPAAsP;YACrQ,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,QAAQ;wBAChB,sBAAsB,EAAE,KAAK;wBAC7B,UAAU,EAAE;4BACV,WAAW;4BACX,YAAY;4BACZ,gBAAgB;4BAChB,KAAK;4BACL,YAAY;yBACb;wBACD,YAAY,EAAE;4BACZ,WAAW,EAAE;gCACX,MAAM,EAAE,cAAc;6BACvB;4BACD,YAAY,EAAE;gCACZ,MAAM,EAAE,QAAQ;gCAChB,WAAW,EAAE,CAAC;6BACf;4BACD,gBAAgB,EAAE;gCAChB,MAAM,EAAE,QAAQ;gCAChB,WAAW,EAAE,CAAC;6BACf;4BACD,KAAK,EAAE;gCACL,MAAM,EAAE,SAAS;gCACjB,SAAS,EAAE,CAAC;6BACb;4BACD,aAAa,EAAE;gCACb,MAAM,EAAE,QAAQ;gCAChB,WAAW,EAAE,GAAG;gCAChB,aAAa,EAAE,8MAA8M;6BAC9N;4BACD,YAAY,EAAE;gCACZ,MAAM,EAAE,SAAS;gCACjB,SAAS,EAAE,CAAC;6BACb;4BACD,YAAY,EAAE;gCACZ,MAAM,EAAE,QAAQ;gCAChB,QAAQ,EAAE,WAAW;6BACtB;4BACD,qBAAqB,EAAE;gCACrB,MAAM,EAAE,SAAS;gCACjB,aAAa,EAAE,4NAA4N;6BAC5O;yBACF;qBACF;iBACF;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,IAAI;iBAClB;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,MAAM,EAAE;YACN,OAAO,EAAE,MAAM;YACf,aAAa,EAAE,waAAwa;YACvb,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,0BAA0B;SACtC;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,yCAAyC;YAClD,aAAa,EAAE,sPAAsP;YACrQ,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,QAAQ;wBAChB,sBAAsB,EAAE,KAAK;wBAC7B,UAAU,EAAE;4BACV,WAAW;4BACX,YAAY;4BACZ,gBAAgB;4BAChB,KAAK;4BACL,YAAY;yBACb;wBACD,YAAY,EAAE;4BACZ,WAAW,EAAE;gCACX,MAAM,EAAE,cAAc;6BACvB;4BACD,YAAY,EAAE;gCACZ,MAAM,EAAE,QAAQ;gCAChB,WAAW,EAAE,CAAC;6BACf;4BACD,gBAAgB,EAAE;gCAChB,MAAM,EAAE,QAAQ;gCAChB,WAAW,EAAE,CAAC;6BACf;4BACD,KAAK,EAAE;gCACL,MAAM,EAAE,SAAS;gCACjB,SAAS,EAAE,CAAC;6BACb;4BACD,aAAa,EAAE;gCACb,MAAM,EAAE,QAAQ;gCAChB,WAAW,EAAE,GAAG;gCAChB,aAAa,EAAE,8MAA8M;6BAC9N;4BACD,YAAY,EAAE;gCACZ,MAAM,EAAE,SAAS;gCACjB,SAAS,EAAE,CAAC;6BACb;4BACD,YAAY,EAAE;gCACZ,MAAM,EAAE,QAAQ;gCAChB,QAAQ,EAAE,WAAW;6BACtB;4BACD,qBAAqB,EAAE;gCACrB,MAAM,EAAE,SAAS;gCACjB,aAAa,EAAE,4NAA4N;6BAC5O;yBACF;qBACF;iBACF;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,IAAI;iBAClB;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;iBACtB;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,MAAM,EAAE;YACN,OAAO,EAAE,MAAM;YACf,aAAa,EAAE,waAAwa;YACvb,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,0BAA0B;SACtC;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,KAAK;IACzB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,KAAK;IACzB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}