@openvtc/trust-tasks 0.28.17 → 0.28.18

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

@@ -0,0 +1,736 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/registry/status/0.1/payload.schema.json
+ */
+import type { Did_VtnV0_1 as Did, Ext } from "../../../../_shared/components.js";
+/**
+ * An administrator's request for how the network's membership stands in its trust registry. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNRegistryStatusPayload {
+    ext?: Ext;
+}
+export interface VTNRegistryStatusResponsePayload {
+    registry: Did;
+    authority: Did;
+    resource: string;
+    actions: {
+        member: string;
+        listed: string;
+    };
+    publishes: "members" | "membersAndListed";
+    writer: string;
+    connected: boolean;
+    lastSync?: Sync;
+    reachable: boolean;
+    records?: Row[];
+    reason?: string;
+    ext?: Ext;
+}
+export interface Sync {
+    /**
+     * When the reconcile ran.
+     */
+    reconciledAt?: string;
+    /**
+     * Records the entries project.
+     */
+    expected: number;
+    /**
+     * Records written, by party.
+     */
+    put: string[];
+    /**
+     * Records deleted, as `party action`.
+     */
+    deleted: string[];
+    /**
+     * Writes that failed, as `party: why`.
+     */
+    failed: string[];
+    /**
+     * Why nothing could be written at all, when so.
+     */
+    blocked?: string;
+}
+export interface Row {
+    did: Did;
+    /**
+     * The action the entries project, if any.
+     */
+    projected?: string;
+    /**
+     * The action the registry holds, if any.
+     */
+    held?: string;
+    result: "ok" | "missing" | "stale" | "wrong";
+}
+/** 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/status/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 = VTNRegistryStatusPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtn/registry/status/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNRegistryStatusResponsePayload;
+/**
+ * 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/status/0.1";
+    readonly title: "VTN Registry — Status — payload";
+    readonly description: "An administrator's request for how the network's membership stands in its trust registry. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Sync: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["expected", "put", "deleted", "failed"];
+            readonly properties: {
+                readonly reconciledAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the reconcile ran.";
+                };
+                readonly expected: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Records the entries project.";
+                };
+                readonly put: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Records written, by party.";
+                };
+                readonly deleted: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Records deleted, as `party action`.";
+                };
+                readonly failed: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Writes that failed, as `party: why`.";
+                };
+                readonly blocked: {
+                    readonly type: "string";
+                    readonly description: "Why nothing could be written at all, when so.";
+                };
+            };
+        };
+        readonly Row: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["did", "result"];
+            readonly properties: {
+                readonly did: {
+                    readonly $ref: "#/$defs/Did";
+                };
+                readonly projected: {
+                    readonly type: "string";
+                    readonly description: "The action the entries project, if any.";
+                };
+                readonly held: {
+                    readonly type: "string";
+                    readonly description: "The action the registry holds, if any.";
+                };
+                readonly result: {
+                    readonly enum: readonly ["ok", "missing", "stale", "wrong"];
+                };
+            };
+        };
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTN Registry — Status — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["registry", "authority", "resource", "actions", "publishes", "writer", "connected", "reachable"];
+            readonly properties: {
+                readonly registry: {
+                    readonly $ref: "#/$defs/Did";
+                };
+                readonly authority: {
+                    readonly $ref: "#/$defs/Did";
+                };
+                readonly resource: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly actions: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["member", "listed"];
+                    readonly properties: {
+                        readonly member: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                        readonly listed: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                    };
+                };
+                readonly publishes: {
+                    readonly enum: readonly ["members", "membersAndListed"];
+                };
+                readonly writer: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                };
+                readonly connected: {
+                    readonly type: "boolean";
+                };
+                readonly lastSync: {
+                    readonly $ref: "#/$defs/Sync";
+                };
+                readonly reachable: {
+                    readonly type: "boolean";
+                };
+                readonly records: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/Row";
+                    };
+                };
+                readonly reason: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                };
+                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 Sync: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["expected", "put", "deleted", "failed"];
+            readonly properties: {
+                readonly reconciledAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the reconcile ran.";
+                };
+                readonly expected: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Records the entries project.";
+                };
+                readonly put: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Records written, by party.";
+                };
+                readonly deleted: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Records deleted, as `party action`.";
+                };
+                readonly failed: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "Writes that failed, as `party: why`.";
+                };
+                readonly blocked: {
+                    readonly type: "string";
+                    readonly description: "Why nothing could be written at all, when so.";
+                };
+            };
+        };
+        readonly Row: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["did", "result"];
+            readonly properties: {
+                readonly did: {
+                    readonly $ref: "#/$defs/Did";
+                };
+                readonly projected: {
+                    readonly type: "string";
+                    readonly description: "The action the entries project, if any.";
+                };
+                readonly held: {
+                    readonly type: "string";
+                    readonly description: "The action the registry holds, if any.";
+                };
+                readonly result: {
+                    readonly enum: readonly ["ok", "missing", "stale", "wrong"];
+                };
+            };
+        };
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTN Registry — Status — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["registry", "authority", "resource", "actions", "publishes", "writer", "connected", "reachable"];
+            readonly properties: {
+                readonly registry: {
+                    readonly $ref: "#/$defs/Did";
+                };
+                readonly authority: {
+                    readonly $ref: "#/$defs/Did";
+                };
+                readonly resource: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly actions: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["member", "listed"];
+                    readonly properties: {
+                        readonly member: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                        readonly listed: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                        };
+                    };
+                };
+                readonly publishes: {
+                    readonly enum: readonly ["members", "membersAndListed"];
+                };
+                readonly writer: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                };
+                readonly connected: {
+                    readonly type: "boolean";
+                };
+                readonly lastSync: {
+                    readonly $ref: "#/$defs/Sync";
+                };
+                readonly reachable: {
+                    readonly type: "boolean";
+                };
+                readonly records: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/Row";
+                    };
+                };
+                readonly reason: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                };
+                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/status/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/registry/status/0.1";
+        readonly title: "VTN Registry — Status — payload";
+        readonly description: "An administrator's request for how the network's membership stands in its trust registry. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly properties: {
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Sync: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["expected", "put", "deleted", "failed"];
+                readonly properties: {
+                    readonly reconciledAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the reconcile ran.";
+                    };
+                    readonly expected: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Records the entries project.";
+                    };
+                    readonly put: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly description: "Records written, by party.";
+                    };
+                    readonly deleted: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly description: "Records deleted, as `party action`.";
+                    };
+                    readonly failed: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly description: "Writes that failed, as `party: why`.";
+                    };
+                    readonly blocked: {
+                        readonly type: "string";
+                        readonly description: "Why nothing could be written at all, when so.";
+                    };
+                };
+            };
+            readonly Row: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["did", "result"];
+                readonly properties: {
+                    readonly did: {
+                        readonly $ref: "#/$defs/Did";
+                    };
+                    readonly projected: {
+                        readonly type: "string";
+                        readonly description: "The action the entries project, if any.";
+                    };
+                    readonly held: {
+                        readonly type: "string";
+                        readonly description: "The action the registry holds, if any.";
+                    };
+                    readonly result: {
+                        readonly enum: readonly ["ok", "missing", "stale", "wrong"];
+                    };
+                };
+            };
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTN Registry — Status — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["registry", "authority", "resource", "actions", "publishes", "writer", "connected", "reachable"];
+                readonly properties: {
+                    readonly registry: {
+                        readonly $ref: "#/$defs/Did";
+                    };
+                    readonly authority: {
+                        readonly $ref: "#/$defs/Did";
+                    };
+                    readonly resource: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly actions: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["member", "listed"];
+                        readonly properties: {
+                            readonly member: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly listed: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                    };
+                    readonly publishes: {
+                        readonly enum: readonly ["members", "membersAndListed"];
+                    };
+                    readonly writer: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                    };
+                    readonly connected: {
+                        readonly type: "boolean";
+                    };
+                    readonly lastSync: {
+                        readonly $ref: "#/$defs/Sync";
+                    };
+                    readonly reachable: {
+                        readonly type: "boolean";
+                    };
+                    readonly records: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/Row";
+                        };
+                    };
+                    readonly reason: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                    };
+                    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/status/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 Sync: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["expected", "put", "deleted", "failed"];
+                readonly properties: {
+                    readonly reconciledAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the reconcile ran.";
+                    };
+                    readonly expected: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Records the entries project.";
+                    };
+                    readonly put: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly description: "Records written, by party.";
+                    };
+                    readonly deleted: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly description: "Records deleted, as `party action`.";
+                    };
+                    readonly failed: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly description: "Writes that failed, as `party: why`.";
+                    };
+                    readonly blocked: {
+                        readonly type: "string";
+                        readonly description: "Why nothing could be written at all, when so.";
+                    };
+                };
+            };
+            readonly Row: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["did", "result"];
+                readonly properties: {
+                    readonly did: {
+                        readonly $ref: "#/$defs/Did";
+                    };
+                    readonly projected: {
+                        readonly type: "string";
+                        readonly description: "The action the entries project, if any.";
+                    };
+                    readonly held: {
+                        readonly type: "string";
+                        readonly description: "The action the registry holds, if any.";
+                    };
+                    readonly result: {
+                        readonly enum: readonly ["ok", "missing", "stale", "wrong"];
+                    };
+                };
+            };
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTN Registry — Status — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["registry", "authority", "resource", "actions", "publishes", "writer", "connected", "reachable"];
+                readonly properties: {
+                    readonly registry: {
+                        readonly $ref: "#/$defs/Did";
+                    };
+                    readonly authority: {
+                        readonly $ref: "#/$defs/Did";
+                    };
+                    readonly resource: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly actions: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["member", "listed"];
+                        readonly properties: {
+                            readonly member: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                            readonly listed: {
+                                readonly type: "string";
+                                readonly minLength: 1;
+                            };
+                        };
+                    };
+                    readonly publishes: {
+                        readonly enum: readonly ["members", "membersAndListed"];
+                    };
+                    readonly writer: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                    };
+                    readonly connected: {
+                        readonly type: "boolean";
+                    };
+                    readonly lastSync: {
+                        readonly $ref: "#/$defs/Sync";
+                    };
+                    readonly reachable: {
+                        readonly type: "boolean";
+                    };
+                    readonly records: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/Row";
+                        };
+                    };
+                    readonly reason: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                    };
+                    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