@openvtc/trust-tasks 0.16.4 → 0.16.6

package/dist/vta/credentials/list/0.1/payload.js

@@ -0,0 +1,322 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/credentials/list/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/credentials/list/0.1";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/credentials/list/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/vta/credentials/list/0.1",
+    "title": "VTA Credentials — List",
+    "description": "Enumerate the credentials an agent has issued, as metadata. Every filter is optional and those present are AND-combined.",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "holder": {
+            "$ref": "#/$defs/Did",
+            "description": "Only credentials issued to this DID."
+        },
+        "credentialType": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256,
+            "description": "Only credentials carrying this type tag beyond `VerifiableCredential`."
+        },
+        "status": {
+            "$ref": "#/$defs/IssuedCredentialStatus",
+            "description": "Only credentials in this state. Derived by the agent at read time, never stored."
+        },
+        "pageSize": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 1000,
+            "description": "Maximum records to return. The agent MAY return fewer and caps this value."
+        },
+        "cursor": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 4096,
+            "description": "Continue a previous page. Opaque — consumers must not construct or parse one."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext",
+            "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA Credentials List — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "credentials",
+                "truncated"
+            ],
+            "properties": {
+                "credentials": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/IssuedCredentialSummary"
+                    },
+                    "description": "One summary per matching credential. Empty when nothing matched — a successful answer, not an error."
+                },
+                "truncated": {
+                    "type": "boolean",
+                    "description": "The agent stopped early. A consumer must not read a truncated page as a complete account of what was issued."
+                },
+                "cursor": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 4096,
+                    "description": "Pass to the next request to continue. Absent when the page is the last."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext",
+                    "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+                }
+            }
+        },
+        "IssuedCredentialSummary": {
+            "title": "IssuedCredentialSummary",
+            "description": "A body-free projection of an issuance record. Carries no claim content by construction — see the specification's rationale for why a list does not return credentials.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "credentialId",
+                "holder",
+                "issuedAt",
+                "expiresAt",
+                "status"
+            ],
+            "properties": {
+                "credentialId": {
+                    "$ref": "#/$defs/CredentialId",
+                    "description": "The id `vta/credentials/revoke` is keyed on."
+                },
+                "holder": {
+                    "$ref": "#/$defs/Did",
+                    "description": "Who the credential was issued to."
+                },
+                "credentialType": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256,
+                    "description": "The type tag beyond `VerifiableCredential`, when the credential carries one."
+                },
+                "issuedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "status": {
+                    "$ref": "#/$defs/IssuedCredentialStatus"
+                },
+                "revokedAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "Present iff `status` is `revoked`."
+                },
+                "revocationReason": {
+                    "type": "string",
+                    "maxLength": 1024,
+                    "description": "Free text recorded at revocation. Disclosed to every caller entitled to this list — see Security & Privacy."
+                }
+            }
+        },
+        "IssuedCredentialStatus": {
+            "type": "string",
+            "enum": [
+                "active",
+                "expired",
+                "revoked"
+            ],
+            "description": "Derived at read time. `revoked` takes precedence over `expired`: a credential revoked before its window closed is revoked, and reporting it as merely expired would hide that somebody acted."
+        },
+        "Did": {
+            "type": "string",
+            "pattern": "^did:[a-z0-9]+:.+$",
+            "maxLength": 2048
+        },
+        "CredentialId": {
+            "$anchor": "credentialId",
+            "title": "CredentialId",
+            "description": "Stable identifier for an issued credential — the handle for revocation and audit. Opaque to the holder: it MUST be echoed verbatim when revoking and MUST NOT be parsed.",
+            "type": "string",
+            "minLength": 1
+        },
+        "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-]+)+$"
+            }
+        }
+    }
+};
+/** 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": "VTA Credentials List — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "credentials",
+                "truncated"
+            ],
+            "properties": {
+                "credentials": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/IssuedCredentialSummary"
+                    },
+                    "description": "One summary per matching credential. Empty when nothing matched — a successful answer, not an error."
+                },
+                "truncated": {
+                    "type": "boolean",
+                    "description": "The agent stopped early. A consumer must not read a truncated page as a complete account of what was issued."
+                },
+                "cursor": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 4096,
+                    "description": "Pass to the next request to continue. Absent when the page is the last."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext",
+                    "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+                }
+            }
+        },
+        "IssuedCredentialSummary": {
+            "title": "IssuedCredentialSummary",
+            "description": "A body-free projection of an issuance record. Carries no claim content by construction — see the specification's rationale for why a list does not return credentials.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "credentialId",
+                "holder",
+                "issuedAt",
+                "expiresAt",
+                "status"
+            ],
+            "properties": {
+                "credentialId": {
+                    "$ref": "#/$defs/CredentialId",
+                    "description": "The id `vta/credentials/revoke` is keyed on."
+                },
+                "holder": {
+                    "$ref": "#/$defs/Did",
+                    "description": "Who the credential was issued to."
+                },
+                "credentialType": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256,
+                    "description": "The type tag beyond `VerifiableCredential`, when the credential carries one."
+                },
+                "issuedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "status": {
+                    "$ref": "#/$defs/IssuedCredentialStatus"
+                },
+                "revokedAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "Present iff `status` is `revoked`."
+                },
+                "revocationReason": {
+                    "type": "string",
+                    "maxLength": 1024,
+                    "description": "Free text recorded at revocation. Disclosed to every caller entitled to this list — see Security & Privacy."
+                }
+            }
+        },
+        "IssuedCredentialStatus": {
+            "type": "string",
+            "enum": [
+                "active",
+                "expired",
+                "revoked"
+            ],
+            "description": "Derived at read time. `revoked` takes precedence over `expired`: a credential revoked before its window closed is revoked, and reporting it as merely expired would hide that somebody acted."
+        },
+        "Did": {
+            "type": "string",
+            "pattern": "^did:[a-z0-9]+:.+$",
+            "maxLength": 2048
+        },
+        "CredentialId": {
+            "$anchor": "credentialId",
+            "title": "CredentialId",
+            "description": "Stable identifier for an issued credential — the handle for revocation and audit. Opaque to the holder: it MUST be echoed verbatim when revoking and MUST NOT be parsed.",
+            "type": "string",
+            "minLength": 1
+        },
+        "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-]+)+$"
+            }
+        }
+    }
+};
+/**
+ * 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: false,
+    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: false,
+    isRecipientRequired: true,
+    isIssuedAtRequired: false,
+    payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+};
+//# sourceMappingURL=payload.js.map

package/dist/vta/credentials/list/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/vta/credentials/list/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAyFH,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,wBAAwB;IACjC,aAAa,EAAE,0HAA0H;IACzI,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,YAAY,EAAE;QACZ,QAAQ,EAAE;YACR,MAAM,EAAE,aAAa;YACrB,aAAa,EAAE,sCAAsC;SACtD;QACD,gBAAgB,EAAE;YAChB,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,wEAAwE;SACxF;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,gCAAgC;YACxC,aAAa,EAAE,kFAAkF;SAClG;QACD,UAAU,EAAE;YACV,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,IAAI;YACf,aAAa,EAAE,4EAA4E;SAC5F;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,+EAA+E;SAC/F;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;YACrB,aAAa,EAAE,yDAAyD;SACzE;KACF;IACD,OAAO,EAAE;QACP,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,yCAAyC;YAClD,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,aAAa;gBACb,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,aAAa,EAAE;oBACb,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,iCAAiC;qBAC1C;oBACD,aAAa,EAAE,sGAAsG;iBACtH;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,8GAA8G;iBAC9H;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,yEAAyE;iBACzF;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,yDAAyD;iBACzE;aACF;SACF;QACD,yBAAyB,EAAE;YACzB,OAAO,EAAE,yBAAyB;YAClC,aAAa,EAAE,wKAAwK;YACvL,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,cAAc;gBACd,QAAQ;gBACR,UAAU;gBACV,WAAW;gBACX,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,cAAc,EAAE;oBACd,MAAM,EAAE,sBAAsB;oBAC9B,aAAa,EAAE,8CAA8C;iBAC9D;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,mCAAmC;iBACnD;gBACD,gBAAgB,EAAE;oBAChB,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,8EAA8E;iBAC9F;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;iBACtB;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;iBACtB;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,gCAAgC;iBACzC;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,oCAAoC;iBACpD;gBACD,kBAAkB,EAAE;oBAClB,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,6GAA6G;iBAC7H;aACF;SACF;QACD,wBAAwB,EAAE;YACxB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,QAAQ;gBACR,SAAS;gBACT,SAAS;aACV;YACD,aAAa,EAAE,+LAA+L;SAC/M;QACD,KAAK,EAAE;YACL,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,oBAAoB;YAC/B,WAAW,EAAE,IAAI;SAClB;QACD,cAAc,EAAE;YACd,SAAS,EAAE,cAAc;YACzB,OAAO,EAAE,cAAc;YACvB,aAAa,EAAE,0KAA0K;YACzL,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;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;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,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,aAAa;gBACb,WAAW;aACZ;YACD,YAAY,EAAE;gBACZ,aAAa,EAAE;oBACb,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE;wBACP,MAAM,EAAE,iCAAiC;qBAC1C;oBACD,aAAa,EAAE,sGAAsG;iBACtH;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,8GAA8G;iBAC9H;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,yEAAyE;iBACzF;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,yDAAyD;iBACzE;aACF;SACF;QACD,yBAAyB,EAAE;YACzB,OAAO,EAAE,yBAAyB;YAClC,aAAa,EAAE,wKAAwK;YACvL,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,cAAc;gBACd,QAAQ;gBACR,UAAU;gBACV,WAAW;gBACX,QAAQ;aACT;YACD,YAAY,EAAE;gBACZ,cAAc,EAAE;oBACd,MAAM,EAAE,sBAAsB;oBAC9B,aAAa,EAAE,8CAA8C;iBAC9D;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,mCAAmC;iBACnD;gBACD,gBAAgB,EAAE;oBAChB,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,8EAA8E;iBAC9F;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;iBACtB;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;iBACtB;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,gCAAgC;iBACzC;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,WAAW;oBACrB,aAAa,EAAE,oCAAoC;iBACpD;gBACD,kBAAkB,EAAE;oBAClB,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,6GAA6G;iBAC7H;aACF;SACF;QACD,wBAAwB,EAAE;YACxB,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,QAAQ;gBACR,SAAS;gBACT,SAAS;aACV;YACD,aAAa,EAAE,+LAA+L;SAC/M;QACD,KAAK,EAAE;YACL,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,oBAAoB;YAC/B,WAAW,EAAE,IAAI;SAClB;QACD,cAAc,EAAE;YACd,SAAS,EAAE,cAAc;YACzB,OAAO,EAAE,cAAc;YACvB,aAAa,EAAE,0KAA0K;YACzL,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;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;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,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,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,KAAK;IACzB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}