@openvtc/trust-tasks 0.28.10 → 0.28.12

package/dist/vtn/groups/list/0.1/payload.d.ts

@@ -0,0 +1,489 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/groups/list/0.1/payload.schema.json
+ */
+import type { Credential, Did_VtnV0_1 as Did, Ext, RegisteredGroup_VtnV0_1 as RegisteredGroup, RoleName_VtnV0_1 as RoleName, SignedTask } from "../../../../_shared/components.js";
+/**
+ * An administrator's request for the network's group registrations. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNGroupsListPayload {
+    /**
+     * Only groups registered for this role.
+     */
+    role?: RoleName;
+    ext?: Ext;
+}
+/**
+ * The matching group registrations.
+ */
+export interface VTNGroupsListResponsePayload {
+    /**
+     * The registrations, each with its signed request and response.
+     */
+    groups: RegisteredGroup[];
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Credential, Did, Ext, RegisteredGroup, RoleName, SignedTask };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vtn/groups/list/0.1";
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export declare const EXTENDS: string | null;
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export declare const DEPRECATION: string | null;
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTNGroupsListPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtn/groups/list/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNGroupsListResponsePayload;
+/**
+ * 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/vtn/groups/list/0.1";
+    readonly title: "VTN Groups — List — payload";
+    readonly description: "An administrator's request for the network's group registrations. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly [];
+    readonly properties: {
+        readonly role: {
+            readonly $ref: "#/$defs/RoleName";
+            readonly description: "Only groups registered for this role.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTN Groups — List — response payload";
+            readonly description: "The matching group registrations.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["groups"];
+            readonly properties: {
+                readonly groups: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/RegisteredGroup";
+                    };
+                    readonly description: "The registrations, each with its signed request and response.";
+                };
+                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 RegisteredGroup: {
+            readonly description: "A group serving a role: the member's signed registration and the network's groupRegistered credential accepting it.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["member", "role", "group", "endpoint", "registration", "acceptance", "registeredAt"];
+            readonly properties: {
+                readonly member: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The member that registered the group.";
+                };
+                readonly role: {
+                    readonly $ref: "#/$defs/RoleName";
+                };
+                readonly group: {
+                    readonly type: "string";
+                    readonly maxLength: 2048;
+                    readonly description: "The group: a DID, or for a network group a DID URL on the network's DID (`<did>#role-<name>`).";
+                };
+                readonly endpoint: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "Where the network delivers broadcasts for the group.";
+                };
+                readonly registration: {
+                    readonly $ref: "#/$defs/SignedTask";
+                    readonly description: "The member's signed vtn/groups/register request.";
+                };
+                readonly acceptance: {
+                    readonly $ref: "#/$defs/Credential";
+                    readonly description: "The network's groupRegistered credential: a statement (`https://openvtc.org/vtn/vsc/groupRegistered/1`) issued by the accepting network, subject the group, `object.digestMultibase` the digest of `registration`, with a `credentialStatus` on the network's revocation list.";
+                };
+                readonly registeredAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the network accepted the registration.";
+                };
+            };
+        };
+        readonly SignedTask: {
+            readonly type: "object";
+            readonly description: "A complete Trust Task document, with its proof, exactly as signed and received. Verified as a document in its own right; open so its proof still covers every member, and so its digest can be recomputed.";
+        };
+        readonly RoleName: {
+            readonly type: "string";
+            readonly pattern: "^[a-z0-9_-]{1,64}$";
+            readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
+        };
+        readonly Credential: {
+            readonly type: "object";
+            readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
+        };
+        readonly Did: {
+            readonly type: "string";
+            readonly pattern: "^did:[a-z0-9]+:.+$";
+            readonly maxLength: 2048;
+            readonly description: "A DID.";
+        };
+    };
+};
+/** 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: "VTN Groups — List — response payload";
+            readonly description: "The matching group registrations.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["groups"];
+            readonly properties: {
+                readonly groups: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/RegisteredGroup";
+                    };
+                    readonly description: "The registrations, each with its signed request and response.";
+                };
+                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 RegisteredGroup: {
+            readonly description: "A group serving a role: the member's signed registration and the network's groupRegistered credential accepting it.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["member", "role", "group", "endpoint", "registration", "acceptance", "registeredAt"];
+            readonly properties: {
+                readonly member: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The member that registered the group.";
+                };
+                readonly role: {
+                    readonly $ref: "#/$defs/RoleName";
+                };
+                readonly group: {
+                    readonly type: "string";
+                    readonly maxLength: 2048;
+                    readonly description: "The group: a DID, or for a network group a DID URL on the network's DID (`<did>#role-<name>`).";
+                };
+                readonly endpoint: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "Where the network delivers broadcasts for the group.";
+                };
+                readonly registration: {
+                    readonly $ref: "#/$defs/SignedTask";
+                    readonly description: "The member's signed vtn/groups/register request.";
+                };
+                readonly acceptance: {
+                    readonly $ref: "#/$defs/Credential";
+                    readonly description: "The network's groupRegistered credential: a statement (`https://openvtc.org/vtn/vsc/groupRegistered/1`) issued by the accepting network, subject the group, `object.digestMultibase` the digest of `registration`, with a `credentialStatus` on the network's revocation list.";
+                };
+                readonly registeredAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the network accepted the registration.";
+                };
+            };
+        };
+        readonly SignedTask: {
+            readonly type: "object";
+            readonly description: "A complete Trust Task document, with its proof, exactly as signed and received. Verified as a document in its own right; open so its proof still covers every member, and so its digest can be recomputed.";
+        };
+        readonly RoleName: {
+            readonly type: "string";
+            readonly pattern: "^[a-z0-9_-]{1,64}$";
+            readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
+        };
+        readonly Credential: {
+            readonly type: "object";
+            readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
+        };
+        readonly Did: {
+            readonly type: "string";
+            readonly pattern: "^did:[a-z0-9]+:.+$";
+            readonly maxLength: 2048;
+            readonly description: "A DID.";
+        };
+    };
+};
+/**
+ * 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/vtn/groups/list/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vtn/groups/list/0.1";
+        readonly title: "VTN Groups — List — payload";
+        readonly description: "An administrator's request for the network's group registrations. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly [];
+        readonly properties: {
+            readonly role: {
+                readonly $ref: "#/$defs/RoleName";
+                readonly description: "Only groups registered for this role.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTN Groups — List — response payload";
+                readonly description: "The matching group registrations.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["groups"];
+                readonly properties: {
+                    readonly groups: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/RegisteredGroup";
+                        };
+                        readonly description: "The registrations, each with its signed request and response.";
+                    };
+                    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 RegisteredGroup: {
+                readonly description: "A group serving a role: the member's signed registration and the network's groupRegistered credential accepting it.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["member", "role", "group", "endpoint", "registration", "acceptance", "registeredAt"];
+                readonly properties: {
+                    readonly member: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The member that registered the group.";
+                    };
+                    readonly role: {
+                        readonly $ref: "#/$defs/RoleName";
+                    };
+                    readonly group: {
+                        readonly type: "string";
+                        readonly maxLength: 2048;
+                        readonly description: "The group: a DID, or for a network group a DID URL on the network's DID (`<did>#role-<name>`).";
+                    };
+                    readonly endpoint: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "Where the network delivers broadcasts for the group.";
+                    };
+                    readonly registration: {
+                        readonly $ref: "#/$defs/SignedTask";
+                        readonly description: "The member's signed vtn/groups/register request.";
+                    };
+                    readonly acceptance: {
+                        readonly $ref: "#/$defs/Credential";
+                        readonly description: "The network's groupRegistered credential: a statement (`https://openvtc.org/vtn/vsc/groupRegistered/1`) issued by the accepting network, subject the group, `object.digestMultibase` the digest of `registration`, with a `credentialStatus` on the network's revocation list.";
+                    };
+                    readonly registeredAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the network accepted the registration.";
+                    };
+                };
+            };
+            readonly SignedTask: {
+                readonly type: "object";
+                readonly description: "A complete Trust Task document, with its proof, exactly as signed and received. Verified as a document in its own right; open so its proof still covers every member, and so its digest can be recomputed.";
+            };
+            readonly RoleName: {
+                readonly type: "string";
+                readonly pattern: "^[a-z0-9_-]{1,64}$";
+                readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
+            };
+            readonly Credential: {
+                readonly type: "object";
+                readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
+            };
+            readonly Did: {
+                readonly type: "string";
+                readonly pattern: "^did:[a-z0-9]+:.+$";
+                readonly maxLength: 2048;
+                readonly description: "A DID.";
+            };
+        };
+    };
+};
+/**
+ * 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/vtn/groups/list/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    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: "VTN Groups — List — response payload";
+                readonly description: "The matching group registrations.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["groups"];
+                readonly properties: {
+                    readonly groups: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/RegisteredGroup";
+                        };
+                        readonly description: "The registrations, each with its signed request and response.";
+                    };
+                    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 RegisteredGroup: {
+                readonly description: "A group serving a role: the member's signed registration and the network's groupRegistered credential accepting it.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["member", "role", "group", "endpoint", "registration", "acceptance", "registeredAt"];
+                readonly properties: {
+                    readonly member: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The member that registered the group.";
+                    };
+                    readonly role: {
+                        readonly $ref: "#/$defs/RoleName";
+                    };
+                    readonly group: {
+                        readonly type: "string";
+                        readonly maxLength: 2048;
+                        readonly description: "The group: a DID, or for a network group a DID URL on the network's DID (`<did>#role-<name>`).";
+                    };
+                    readonly endpoint: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "Where the network delivers broadcasts for the group.";
+                    };
+                    readonly registration: {
+                        readonly $ref: "#/$defs/SignedTask";
+                        readonly description: "The member's signed vtn/groups/register request.";
+                    };
+                    readonly acceptance: {
+                        readonly $ref: "#/$defs/Credential";
+                        readonly description: "The network's groupRegistered credential: a statement (`https://openvtc.org/vtn/vsc/groupRegistered/1`) issued by the accepting network, subject the group, `object.digestMultibase` the digest of `registration`, with a `credentialStatus` on the network's revocation list.";
+                    };
+                    readonly registeredAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the network accepted the registration.";
+                    };
+                };
+            };
+            readonly SignedTask: {
+                readonly type: "object";
+                readonly description: "A complete Trust Task document, with its proof, exactly as signed and received. Verified as a document in its own right; open so its proof still covers every member, and so its digest can be recomputed.";
+            };
+            readonly RoleName: {
+                readonly type: "string";
+                readonly pattern: "^[a-z0-9_-]{1,64}$";
+                readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
+            };
+            readonly Credential: {
+                readonly type: "object";
+                readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
+            };
+            readonly Did: {
+                readonly type: "string";
+                readonly pattern: "^did:[a-z0-9]+:.+$";
+                readonly maxLength: 2048;
+                readonly description: "A DID.";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vtn/groups/list/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vtn/groups/list/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,IAAI,GAAG,EAAE,GAAG,EAAE,uBAAuB,IAAI,eAAe,EAAE,gBAAgB,IAAI,QAAQ,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAGnL;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;AAE5E,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,iDAA0D,CAAC;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,GAAG,IAAW,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,GAAG,IAAW,CAAC;AAE/C,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,oBAAoB,CAAC;AAE3C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,0DAAmE,CAAC;AAErG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,4BAA4B,CAAC;AAEpD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqHjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuG1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}