@openvtc/trust-tasks 0.26.17 → 0.26.19

package/dist/vtc/directory/card/present/0.1/payload.js

@@ -0,0 +1,297 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/directory/card/present/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/directory/card/present/0.1";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/directory/card/present/0.1#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/vtc/directory/card/present/0.1",
+    "title": "VTC Directory — Card — Present — payload",
+    "description": "A member presents a credential so the community can fill credential-sourced directory fields with the disclosed claims, badged with their issuer; the community keeps the claims, never the presentation. The outer document members are owned by the framework — SPEC §6.3.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "fields",
+        "presentation"
+    ],
+    "properties": {
+        "fields": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 16,
+            "uniqueItems": true,
+            "items": {
+                "$ref": "#/$defs/FieldKey"
+            },
+            "description": "The `credential`-sourced fields this presentation answers."
+        },
+        "presentation": {
+            "anyOf": [
+                {
+                    "type": "object",
+                    "description": "A W3C Verifiable Presentation with a Data Integrity proof whose `challenge` is this document's `id` and whose `domain` is the community's DID."
+                },
+                {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 65536,
+                    "description": "A compact presentation (an SD-JWT with a key-binding JWT whose `nonce` is this document's `id` and `aud` the community's DID)."
+                }
+            ]
+        },
+        "clear": {
+            "type": "boolean",
+            "description": "Optional: also clear any named field the presentation does not answer. Absent: false."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTC Directory — Card — Present — response payload",
+            "description": "The success response to a vtc/directory/card/present/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/card/present/0.1#response.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "verified",
+                "revision"
+            ],
+            "properties": {
+                "verified": {
+                    "type": "object",
+                    "maxProperties": 16,
+                    "propertyNames": {
+                        "$ref": "#/$defs/FieldKey"
+                    },
+                    "additionalProperties": {
+                        "$ref": "#/$defs/VerifiedValue"
+                    },
+                    "description": "The values now on the card, keyed by field."
+                },
+                "revision": {
+                    "type": "integer",
+                    "minimum": 0
+                },
+                "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-]+)+$"
+            }
+        },
+        "VerifiedValue": {
+            "title": "VerifiedValue",
+            "description": "The value of a `credential`-sourced field: a claim the member disclosed from a credential they presented, with the issuer that attests it. A verified value always names its issuer, and a self-asserted value is never shaped as one. The community keeps only the disclosed claim and these facts about it — never the presentation.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "value",
+                "issuer",
+                "verifiedAt"
+            ],
+            "properties": {
+                "value": {
+                    "anyOf": [
+                        {
+                            "type": "string",
+                            "maxLength": 2000
+                        },
+                        {
+                            "type": "boolean"
+                        },
+                        {
+                            "type": "number"
+                        }
+                    ],
+                    "description": "The disclosed claim value."
+                },
+                "issuer": {
+                    "type": "string",
+                    "pattern": "^did:",
+                    "maxLength": 2048,
+                    "description": "DID of the credential's issuer, shown as the field's verification badge."
+                },
+                "credentialType": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128,
+                    "description": "The most specific `type` of the credential the claim came from."
+                },
+                "verifiedAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the community verified the presentation."
+                },
+                "validUntil": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the credential expires, where it does. The community withdraws the value once it passes."
+                }
+            }
+        },
+        "FieldKey": {
+            "title": "FieldKey",
+            "description": "Identifier of a directory field. A key with no `.` is a BASE field, the same in every community: `displayName`, `nickname`, `avatar`, `pronouns`, `bio`, `links` (written by the member) and `role`, `joinedAt`, `did`, `personhood` (derived from the community's own records, never stored on a card). A community-defined field MUST use a reverse-DNS key (`org.example.employer`), so a base key never collides with one, and a key is never reused with a different meaning once defined.",
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128,
+            "pattern": "^([a-z][a-z0-9-]*\\.)*[a-z][a-zA-Z0-9]{0,63}$"
+        }
+    }
+};
+/** 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": "VTC Directory — Card — Present — response payload",
+            "description": "The success response to a vtc/directory/card/present/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/card/present/0.1#response.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "verified",
+                "revision"
+            ],
+            "properties": {
+                "verified": {
+                    "type": "object",
+                    "maxProperties": 16,
+                    "propertyNames": {
+                        "$ref": "#/$defs/FieldKey"
+                    },
+                    "additionalProperties": {
+                        "$ref": "#/$defs/VerifiedValue"
+                    },
+                    "description": "The values now on the card, keyed by field."
+                },
+                "revision": {
+                    "type": "integer",
+                    "minimum": 0
+                },
+                "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-]+)+$"
+            }
+        },
+        "VerifiedValue": {
+            "title": "VerifiedValue",
+            "description": "The value of a `credential`-sourced field: a claim the member disclosed from a credential they presented, with the issuer that attests it. A verified value always names its issuer, and a self-asserted value is never shaped as one. The community keeps only the disclosed claim and these facts about it — never the presentation.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "value",
+                "issuer",
+                "verifiedAt"
+            ],
+            "properties": {
+                "value": {
+                    "anyOf": [
+                        {
+                            "type": "string",
+                            "maxLength": 2000
+                        },
+                        {
+                            "type": "boolean"
+                        },
+                        {
+                            "type": "number"
+                        }
+                    ],
+                    "description": "The disclosed claim value."
+                },
+                "issuer": {
+                    "type": "string",
+                    "pattern": "^did:",
+                    "maxLength": 2048,
+                    "description": "DID of the credential's issuer, shown as the field's verification badge."
+                },
+                "credentialType": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128,
+                    "description": "The most specific `type` of the credential the claim came from."
+                },
+                "verifiedAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the community verified the presentation."
+                },
+                "validUntil": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the credential expires, where it does. The community withdraws the value once it passes."
+                }
+            }
+        },
+        "FieldKey": {
+            "title": "FieldKey",
+            "description": "Identifier of a directory field. A key with no `.` is a BASE field, the same in every community: `displayName`, `nickname`, `avatar`, `pronouns`, `bio`, `links` (written by the member) and `role`, `joinedAt`, `did`, `personhood` (derived from the community's own records, never stored on a card). A community-defined field MUST use a reverse-DNS key (`org.example.employer`), so a base key never collides with one, and a key is never reused with a different meaning once defined.",
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128,
+            "pattern": "^([a-z][a-z0-9-]*\\.)*[a-z][a-zA-Z0-9]{0,63}$"
+        }
+    }
+};
+/**
+ * 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,
+};
+/**
+ * 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,
+};
+//# sourceMappingURL=payload.js.map

package/dist/vtc/directory/card/present/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vtc/directory/card/present/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAmIH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,4DAAqE,CAAC;AAK9F,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,qEAA8E,CAAC;AAKhH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,4DAA4D;IACnE,OAAO,EAAE,0CAA0C;IACnD,aAAa,EAAE,8QAA8Q;IAC7R,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,QAAQ;QACR,cAAc;KACf;IACD,YAAY,EAAE;QACZ,QAAQ,EAAE;YACR,MAAM,EAAE,OAAO;YACf,UAAU,EAAE,CAAC;YACb,UAAU,EAAE,EAAE;YACd,aAAa,EAAE,IAAI;YACnB,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;aAC3B;YACD,aAAa,EAAE,4DAA4D;SAC5E;QACD,cAAc,EAAE;YACd,OAAO,EAAE;gBACP;oBACE,MAAM,EAAE,QAAQ;oBAChB,aAAa,EAAE,gJAAgJ;iBAChK;gBACD;oBACE,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,KAAK;oBAClB,aAAa,EAAE,gIAAgI;iBAChJ;aACF;SACF;QACD,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;YACjB,aAAa,EAAE,uFAAuF;SACvG;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,mDAAmD;YAC5D,aAAa,EAAE,uLAAuL;YACtM,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;gBACV,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,eAAe,EAAE,EAAE;oBACnB,eAAe,EAAE;wBACf,MAAM,EAAE,kBAAkB;qBAC3B;oBACD,sBAAsB,EAAE;wBACtB,MAAM,EAAE,uBAAuB;qBAChC;oBACD,aAAa,EAAE,6CAA6C;iBAC7D;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;iBACb;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,eAAe,EAAE;YACf,OAAO,EAAE,eAAe;YACxB,aAAa,EAAE,wUAAwU;YACvV,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,OAAO;gBACP,QAAQ;gBACR,YAAY;aACb;YACD,YAAY,EAAE;gBACZ,OAAO,EAAE;oBACP,OAAO,EAAE;wBACP;4BACE,MAAM,EAAE,QAAQ;4BAChB,WAAW,EAAE,IAAI;yBAClB;wBACD;4BACE,MAAM,EAAE,SAAS;yBAClB;wBACD;4BACE,MAAM,EAAE,QAAQ;yBACjB;qBACF;oBACD,aAAa,EAAE,4BAA4B;iBAC5C;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,OAAO;oBAClB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,0EAA0E;iBAC1F;gBACD,gBAAgB,EAAE;oBAChB,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,iEAAiE;iBACjF;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,+CAA+C;iBAC/D;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,+FAA+F;iBAC/G;aACF;SACF;QACD,UAAU,EAAE;YACV,OAAO,EAAE,UAAU;YACnB,aAAa,EAAE,ieAAie;YAChf,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,SAAS,EAAE,+CAA+C;SAC3D;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,mDAAmD;YAC5D,aAAa,EAAE,uLAAuL;YACtM,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,UAAU;gBACV,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,eAAe,EAAE,EAAE;oBACnB,eAAe,EAAE;wBACf,MAAM,EAAE,kBAAkB;qBAC3B;oBACD,sBAAsB,EAAE;wBACtB,MAAM,EAAE,uBAAuB;qBAChC;oBACD,aAAa,EAAE,6CAA6C;iBAC7D;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,CAAC;iBACb;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,eAAe,EAAE;YACf,OAAO,EAAE,eAAe;YACxB,aAAa,EAAE,wUAAwU;YACvV,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,OAAO;gBACP,QAAQ;gBACR,YAAY;aACb;YACD,YAAY,EAAE;gBACZ,OAAO,EAAE;oBACP,OAAO,EAAE;wBACP;4BACE,MAAM,EAAE,QAAQ;4BAChB,WAAW,EAAE,IAAI;yBAClB;wBACD;4BACE,MAAM,EAAE,SAAS;yBAClB;wBACD;4BACE,MAAM,EAAE,QAAQ;yBACjB;qBACF;oBACD,aAAa,EAAE,4BAA4B;iBAC5C;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,OAAO;oBAClB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,0EAA0E;iBAC1F;gBACD,gBAAgB,EAAE;oBAChB,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,iEAAiE;iBACjF;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,+CAA+C;iBAC/D;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,+FAA+F;iBAC/G;aACF;SACF;QACD,UAAU,EAAE;YACV,OAAO,EAAE,UAAU;YACnB,aAAa,EAAE,ieAAie;YAChf,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,SAAS,EAAE,+CAA+C;SAC3D;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,IAAI;IACxB,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,IAAI;IACxB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}