@openvtc/trust-tasks 0.28.16 → 0.28.18

package/dist/vtn/registry/check/0.1/payload.d.ts

@@ -0,0 +1,528 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/registry/check/0.1/payload.schema.json
+ */
+import type { Did_VtnV0_1 as Did, Ext } from "../../../../_shared/components.js";
+/**
+ * Ask the network to ask its trust registry about one party. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNRegistryCheckPayload {
+    /**
+     * The party asked about.
+     */
+    did: Did;
+    ext?: Ext;
+}
+/**
+ * What the registry answered, and its own answer document.
+ */
+export interface VTNRegistryCheckResponsePayload {
+    /**
+     * The trust registry asked.
+     */
+    registry: Did;
+    /**
+     * The network's DID: the authority of its records.
+     */
+    authority: Did;
+    /**
+     * The TRQP resource the network's records are published under.
+     */
+    resource: string;
+    actions: Actions;
+    /**
+     * The party asked about.
+     */
+    did: Did;
+    /**
+     * Whether the registry answered. `false` is indeterminate, never "not a member".
+     */
+    reachable: boolean;
+    /**
+     * Whether the registry holds an authorised member record for the party. Absent when not reachable.
+     */
+    member?: boolean;
+    /**
+     * Whether the registry holds an authorised listed record for the party. Absent when not reachable.
+     */
+    listed?: boolean;
+    /**
+     * The registry's answer document, verbatim and signed by the registry.
+     */
+    answer?: {};
+    /**
+     * Why the registry could not be asked, when not reachable.
+     */
+    reason?: string;
+    ext?: Ext;
+}
+export interface Actions {
+    /**
+     * The action acknowledged members are published under.
+     */
+    member: string;
+    /**
+     * The action listed parties are published under, where the network publishes them.
+     */
+    listed: string;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Did, Ext };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vtn/registry/check/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 = VTNRegistryCheckPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtn/registry/check/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNRegistryCheckResponsePayload;
+/**
+ * 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/registry/check/0.1";
+    readonly title: "VTN Registry — Check — payload";
+    readonly description: "Ask the network to ask its trust registry about one party. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["did"];
+    readonly properties: {
+        readonly did: {
+            readonly $ref: "#/$defs/Did";
+            readonly description: "The party asked about.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Actions: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["member", "listed"];
+            readonly properties: {
+                readonly member: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The action acknowledged members are published under.";
+                };
+                readonly listed: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The action listed parties are published under, where the network publishes them.";
+                };
+            };
+        };
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTN Registry — Check — response payload";
+            readonly description: "What the registry answered, and its own answer document.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["registry", "authority", "resource", "actions", "did", "reachable"];
+            readonly properties: {
+                readonly registry: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The trust registry asked.";
+                };
+                readonly authority: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The network's DID: the authority of its records.";
+                };
+                readonly resource: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The TRQP resource the network's records are published under.";
+                };
+                readonly actions: {
+                    readonly $ref: "#/$defs/Actions";
+                };
+                readonly did: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The party asked about.";
+                };
+                readonly reachable: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the registry answered. `false` is indeterminate, never \"not a member\".";
+                };
+                readonly member: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the registry holds an authorised member record for the party. Absent when not reachable.";
+                };
+                readonly listed: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the registry holds an authorised listed record for the party. Absent when not reachable.";
+                };
+                readonly answer: {
+                    readonly type: "object";
+                    readonly description: "The registry's answer document, verbatim and signed by the registry.";
+                };
+                readonly reason: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                    readonly description: "Why the registry could not be asked, when not reachable.";
+                };
+                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 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 Actions: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["member", "listed"];
+            readonly properties: {
+                readonly member: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The action acknowledged members are published under.";
+                };
+                readonly listed: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The action listed parties are published under, where the network publishes them.";
+                };
+            };
+        };
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTN Registry — Check — response payload";
+            readonly description: "What the registry answered, and its own answer document.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["registry", "authority", "resource", "actions", "did", "reachable"];
+            readonly properties: {
+                readonly registry: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The trust registry asked.";
+                };
+                readonly authority: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The network's DID: the authority of its records.";
+                };
+                readonly resource: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "The TRQP resource the network's records are published under.";
+                };
+                readonly actions: {
+                    readonly $ref: "#/$defs/Actions";
+                };
+                readonly did: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The party asked about.";
+                };
+                readonly reachable: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the registry answered. `false` is indeterminate, never \"not a member\".";
+                };
+                readonly member: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the registry holds an authorised member record for the party. Absent when not reachable.";
+                };
+                readonly listed: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the registry holds an authorised listed record for the party. Absent when not reachable.";
+                };
+                readonly answer: {
+                    readonly type: "object";
+                    readonly description: "The registry's answer document, verbatim and signed by the registry.";
+                };
+                readonly reason: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                    readonly description: "Why the registry could not be asked, when not reachable.";
+                };
+                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 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/registry/check/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    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/registry/check/0.1";
+        readonly title: "VTN Registry — Check — payload";
+        readonly description: "Ask the network to ask its trust registry about one party. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["did"];
+        readonly properties: {
+            readonly did: {
+                readonly $ref: "#/$defs/Did";
+                readonly description: "The party asked about.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Actions: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["member", "listed"];
+                readonly properties: {
+                    readonly member: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The action acknowledged members are published under.";
+                    };
+                    readonly listed: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The action listed parties are published under, where the network publishes them.";
+                    };
+                };
+            };
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTN Registry — Check — response payload";
+                readonly description: "What the registry answered, and its own answer document.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["registry", "authority", "resource", "actions", "did", "reachable"];
+                readonly properties: {
+                    readonly registry: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The trust registry asked.";
+                    };
+                    readonly authority: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The network's DID: the authority of its records.";
+                    };
+                    readonly resource: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The TRQP resource the network's records are published under.";
+                    };
+                    readonly actions: {
+                        readonly $ref: "#/$defs/Actions";
+                    };
+                    readonly did: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The party asked about.";
+                    };
+                    readonly reachable: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the registry answered. `false` is indeterminate, never \"not a member\".";
+                    };
+                    readonly member: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the registry holds an authorised member record for the party. Absent when not reachable.";
+                    };
+                    readonly listed: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the registry holds an authorised listed record for the party. Absent when not reachable.";
+                    };
+                    readonly answer: {
+                        readonly type: "object";
+                        readonly description: "The registry's answer document, verbatim and signed by the registry.";
+                    };
+                    readonly reason: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                        readonly description: "Why the registry could not be asked, when not reachable.";
+                    };
+                    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 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/registry/check/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    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 Actions: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["member", "listed"];
+                readonly properties: {
+                    readonly member: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The action acknowledged members are published under.";
+                    };
+                    readonly listed: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The action listed parties are published under, where the network publishes them.";
+                    };
+                };
+            };
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTN Registry — Check — response payload";
+                readonly description: "What the registry answered, and its own answer document.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["registry", "authority", "resource", "actions", "did", "reachable"];
+                readonly properties: {
+                    readonly registry: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The trust registry asked.";
+                    };
+                    readonly authority: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The network's DID: the authority of its records.";
+                    };
+                    readonly resource: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "The TRQP resource the network's records are published under.";
+                    };
+                    readonly actions: {
+                        readonly $ref: "#/$defs/Actions";
+                    };
+                    readonly did: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The party asked about.";
+                    };
+                    readonly reachable: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the registry answered. `false` is indeterminate, never \"not a member\".";
+                    };
+                    readonly member: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the registry holds an authorised member record for the party. Absent when not reachable.";
+                    };
+                    readonly listed: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the registry holds an authorised listed record for the party. Absent when not reachable.";
+                    };
+                    readonly answer: {
+                        readonly type: "object";
+                        readonly description: "The registry's answer document, verbatim and signed by the registry.";
+                    };
+                    readonly reason: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                        readonly description: "Why the registry could not be asked, when not reachable.";
+                    };
+                    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 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/registry/check/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/vtn/registry/check/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,IAAI,GAAG,EAAE,GAAG,EAAE,MAAM,mCAAmC,CAAC;AAGjF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;IACT,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,GAAG,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;IACT;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAEzB,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,oDAA6D,CAAC;AAEtF;;;;;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,uBAAuB,CAAC;AAE9C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,6DAAsE,CAAC;AAExG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,+BAA+B,CAAC;AAEvD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsHjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsG1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}