@openvtc/trust-tasks 0.28.14 → 0.28.16

package/dist/rooms/keys/watch/0.1/payload.d.ts

@@ -0,0 +1,652 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/rooms/keys/watch/0.1/payload.schema.json
+ */
+import type { Ext } from "../../../../_shared/components.js";
+/**
+ * A member's own client asks the member's key holder to arm, re-arm or cancel rooms/watch at one host for one or more rooms, as the member, with an address the key holder controls; the key holder passes each signal on to the client with rooms/keys/changed. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface RoomsKeysWatchPayload {
+    /**
+     * The member to watch as: a DID the recipient holds keys for and the caller may act as. Always named — the recipient never picks a member for the caller. This task's subject.
+     */
+    member: string;
+    /**
+     * The host to arm the watches at, as a DID. Named by the caller for the reason it is on rooms/keys/browse: nothing maps a room to its host.
+     */
+    host: string;
+    /**
+     * The rooms to watch at this host, each at most once. Each is armed at the host with its own rooms/watch request, presentation and address; the host never sees them together.
+     *
+     * @minItems 1
+     * @maxItems 64
+     */
+    rooms: [RoomToWatch, ...RoomToWatch[]];
+    /**
+     * How long the caller asks each watch to last if it does not fire, in seconds, up to 30 days. Passed to the host as rooms/watch's leaseSeconds; the host and the recipient MAY grant less. Absent means the host's default. Ignored on a cancel.
+     */
+    leaseSeconds?: number;
+    /**
+     * End the watches on the named rooms. Only `true` is meaningful, so only `true` is accepted. A cancel of a watch the recipient does not hold succeeds with `armed: false`.
+     */
+    cancel?: true;
+    /**
+     * Ecosystem-defined extension members per SPEC.md §4.5.1.
+     */
+    ext?: Ext;
+}
+/**
+ * One room of the request, with the version the caller has read it to.
+ */
+export interface RoomToWatch {
+    /**
+     * The room.
+     */
+    roomId: string;
+    /**
+     * The highest version of the room the caller has read to, passed to the host as rooms/watch's sinceVersion: the host signals as soon as the room is above it, at once if it already is. Absent means the room's latest version when the host arms the watch. Ignored on a cancel.
+     */
+    sinceVersion?: number;
+}
+/**
+ * Success response to rooms/keys/watch: one outcome per room requested, in the order requested. Type https://trusttasks.org/spec/rooms/keys/watch/0.1#response.
+ */
+export interface RoomsKeysWatchResponsePayload {
+    /**
+     * The member, echoed.
+     */
+    member: string;
+    /**
+     * The host, echoed.
+     */
+    host: string;
+    /**
+     * @minItems 1
+     * @maxItems 64
+     */
+    watches: [OutcomeForOneRoom, ...OutcomeForOneRoom[]];
+    ext?: Ext;
+}
+/**
+ * What became of one room of the request.
+ */
+export interface OutcomeForOneRoom {
+    /**
+     * The room, echoed.
+     */
+    roomId: string;
+    /**
+     * `true`: the host holds the watch armed and the recipient will pass on its signal with rooms/keys/changed. `false`: the watch was cancelled, there was none to cancel, or it was refused (`refused` says why).
+     */
+    armed: boolean;
+    /**
+     * Present when `armed` is `true`: when the watch lapses if it has not fired — the expiresAt the host answered, or earlier where the recipient bounds it. The caller re-arms before then if it still wants a signal.
+     */
+    expiresAt?: string;
+    /**
+     * Present when this room's watch was not armed or cancelled because of a refusal. `notAMember`: the recipient holds no credential the room issued to `member`. `actionNotHeld`: the member's credentials do not confer `read`. `limitReached`: the recipient holds as many watches as it allows — the caller polls this room. `hostUnreachable`: the host could not be resolved, advertises no transport the recipient speaks, or did not answer — a retry may succeed. `hostRefused`: the host answered with a trust-task-error, whose code is in `hostCode`.
+     */
+    refused?: "notAMember" | "actionNotHeld" | "limitReached" | "hostUnreachable" | "hostRefused";
+    /**
+     * Present when `refused` is `hostRefused`: the code of the host's trust-task-error, unaltered — for instance `rooms/watch:limitReached` or the standard `permissionDenied`.
+     */
+    hostCode?: string;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/rooms/keys/watch/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 = RoomsKeysWatchPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/rooms/keys/watch/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RoomsKeysWatchResponsePayload;
+/**
+ * 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/rooms/keys/watch/0.1";
+    readonly title: "Rooms Keys — Watch — payload";
+    readonly description: "A member's own client asks the member's key holder to arm, re-arm or cancel rooms/watch at one host for one or more rooms, as the member, with an address the key holder controls; the key holder passes each signal on to the client with rooms/keys/changed. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["member", "host", "rooms"];
+    readonly properties: {
+        readonly member: {
+            readonly type: "string";
+            readonly pattern: "^did:";
+            readonly maxLength: 2048;
+            readonly description: "The member to watch as: a DID the recipient holds keys for and the caller may act as. Always named — the recipient never picks a member for the caller. This task's subject.";
+        };
+        readonly host: {
+            readonly type: "string";
+            readonly pattern: "^did:";
+            readonly maxLength: 2048;
+            readonly description: "The host to arm the watches at, as a DID. Named by the caller for the reason it is on rooms/keys/browse: nothing maps a room to its host.";
+        };
+        readonly rooms: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly maxItems: 64;
+            readonly description: "The rooms to watch at this host, each at most once. Each is armed at the host with its own rooms/watch request, presentation and address; the host never sees them together.";
+            readonly items: {
+                readonly $ref: "#/$defs/RoomWatchRequest";
+            };
+        };
+        readonly leaseSeconds: {
+            readonly type: "integer";
+            readonly minimum: 60;
+            readonly maximum: 2592000;
+            readonly description: "How long the caller asks each watch to last if it does not fire, in seconds, up to 30 days. Passed to the host as rooms/watch's leaseSeconds; the host and the recipient MAY grant less. Absent means the host's default. Ignored on a cancel.";
+        };
+        readonly cancel: {
+            readonly type: "boolean";
+            readonly const: true;
+            readonly description: "End the watches on the named rooms. Only `true` is meaningful, so only `true` is accepted. A cancel of a watch the recipient does not hold succeeds with `armed: false`.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+            readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+        };
+    };
+    readonly $defs: {
+        readonly RoomWatchRequest: {
+            readonly title: "Room to watch";
+            readonly description: "One room of the request, with the version the caller has read it to.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["roomId"];
+            readonly properties: {
+                readonly roomId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 2048;
+                    readonly description: "The room.";
+                };
+                readonly sinceVersion: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "The highest version of the room the caller has read to, passed to the host as rooms/watch's sinceVersion: the host signals as soon as the room is above it, at once if it already is. Absent means the room's latest version when the host arms the watch. Ignored on a cancel.";
+                };
+            };
+        };
+        readonly RoomWatchOutcome: {
+            readonly title: "Outcome for one room";
+            readonly description: "What became of one room of the request.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["roomId", "armed"];
+            readonly properties: {
+                readonly roomId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 2048;
+                    readonly description: "The room, echoed.";
+                };
+                readonly armed: {
+                    readonly type: "boolean";
+                    readonly description: "`true`: the host holds the watch armed and the recipient will pass on its signal with rooms/keys/changed. `false`: the watch was cancelled, there was none to cancel, or it was refused (`refused` says why).";
+                };
+                readonly expiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present when `armed` is `true`: when the watch lapses if it has not fired — the expiresAt the host answered, or earlier where the recipient bounds it. The caller re-arms before then if it still wants a signal.";
+                };
+                readonly refused: {
+                    readonly type: "string";
+                    readonly enum: readonly ["notAMember", "actionNotHeld", "limitReached", "hostUnreachable", "hostRefused"];
+                    readonly description: "Present when this room's watch was not armed or cancelled because of a refusal. `notAMember`: the recipient holds no credential the room issued to `member`. `actionNotHeld`: the member's credentials do not confer `read`. `limitReached`: the recipient holds as many watches as it allows — the caller polls this room. `hostUnreachable`: the host could not be resolved, advertises no transport the recipient speaks, or did not answer — a retry may succeed. `hostRefused`: the host answered with a trust-task-error, whose code is in `hostCode`.";
+                };
+                readonly hostCode: {
+                    readonly type: "string";
+                    readonly maxLength: 256;
+                    readonly description: "Present when `refused` is `hostRefused`: the code of the host's trust-task-error, unaltered — for instance `rooms/watch:limitReached` or the standard `permissionDenied`.";
+                };
+            };
+        };
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Rooms Keys — Watch — response payload";
+            readonly description: "Success response to rooms/keys/watch: one outcome per room requested, in the order requested. Type https://trusttasks.org/spec/rooms/keys/watch/0.1#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["member", "host", "watches"];
+            readonly properties: {
+                readonly member: {
+                    readonly type: "string";
+                    readonly pattern: "^did:";
+                    readonly maxLength: 2048;
+                    readonly description: "The member, echoed.";
+                };
+                readonly host: {
+                    readonly type: "string";
+                    readonly pattern: "^did:";
+                    readonly maxLength: 2048;
+                    readonly description: "The host, echoed.";
+                };
+                readonly watches: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 64;
+                    readonly items: {
+                        readonly $ref: "#/$defs/RoomWatchOutcome";
+                    };
+                };
+                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-]+)+$";
+            };
+        };
+    };
+};
+/** 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 RoomWatchRequest: {
+            readonly title: "Room to watch";
+            readonly description: "One room of the request, with the version the caller has read it to.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["roomId"];
+            readonly properties: {
+                readonly roomId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 2048;
+                    readonly description: "The room.";
+                };
+                readonly sinceVersion: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "The highest version of the room the caller has read to, passed to the host as rooms/watch's sinceVersion: the host signals as soon as the room is above it, at once if it already is. Absent means the room's latest version when the host arms the watch. Ignored on a cancel.";
+                };
+            };
+        };
+        readonly RoomWatchOutcome: {
+            readonly title: "Outcome for one room";
+            readonly description: "What became of one room of the request.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["roomId", "armed"];
+            readonly properties: {
+                readonly roomId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 2048;
+                    readonly description: "The room, echoed.";
+                };
+                readonly armed: {
+                    readonly type: "boolean";
+                    readonly description: "`true`: the host holds the watch armed and the recipient will pass on its signal with rooms/keys/changed. `false`: the watch was cancelled, there was none to cancel, or it was refused (`refused` says why).";
+                };
+                readonly expiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Present when `armed` is `true`: when the watch lapses if it has not fired — the expiresAt the host answered, or earlier where the recipient bounds it. The caller re-arms before then if it still wants a signal.";
+                };
+                readonly refused: {
+                    readonly type: "string";
+                    readonly enum: readonly ["notAMember", "actionNotHeld", "limitReached", "hostUnreachable", "hostRefused"];
+                    readonly description: "Present when this room's watch was not armed or cancelled because of a refusal. `notAMember`: the recipient holds no credential the room issued to `member`. `actionNotHeld`: the member's credentials do not confer `read`. `limitReached`: the recipient holds as many watches as it allows — the caller polls this room. `hostUnreachable`: the host could not be resolved, advertises no transport the recipient speaks, or did not answer — a retry may succeed. `hostRefused`: the host answered with a trust-task-error, whose code is in `hostCode`.";
+                };
+                readonly hostCode: {
+                    readonly type: "string";
+                    readonly maxLength: 256;
+                    readonly description: "Present when `refused` is `hostRefused`: the code of the host's trust-task-error, unaltered — for instance `rooms/watch:limitReached` or the standard `permissionDenied`.";
+                };
+            };
+        };
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Rooms Keys — Watch — response payload";
+            readonly description: "Success response to rooms/keys/watch: one outcome per room requested, in the order requested. Type https://trusttasks.org/spec/rooms/keys/watch/0.1#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["member", "host", "watches"];
+            readonly properties: {
+                readonly member: {
+                    readonly type: "string";
+                    readonly pattern: "^did:";
+                    readonly maxLength: 2048;
+                    readonly description: "The member, echoed.";
+                };
+                readonly host: {
+                    readonly type: "string";
+                    readonly pattern: "^did:";
+                    readonly maxLength: 2048;
+                    readonly description: "The host, echoed.";
+                };
+                readonly watches: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 64;
+                    readonly items: {
+                        readonly $ref: "#/$defs/RoomWatchOutcome";
+                    };
+                };
+                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-]+)+$";
+            };
+        };
+    };
+};
+/**
+ * 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/rooms/keys/watch/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/rooms/keys/watch/0.1";
+        readonly title: "Rooms Keys — Watch — payload";
+        readonly description: "A member's own client asks the member's key holder to arm, re-arm or cancel rooms/watch at one host for one or more rooms, as the member, with an address the key holder controls; the key holder passes each signal on to the client with rooms/keys/changed. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["member", "host", "rooms"];
+        readonly properties: {
+            readonly member: {
+                readonly type: "string";
+                readonly pattern: "^did:";
+                readonly maxLength: 2048;
+                readonly description: "The member to watch as: a DID the recipient holds keys for and the caller may act as. Always named — the recipient never picks a member for the caller. This task's subject.";
+            };
+            readonly host: {
+                readonly type: "string";
+                readonly pattern: "^did:";
+                readonly maxLength: 2048;
+                readonly description: "The host to arm the watches at, as a DID. Named by the caller for the reason it is on rooms/keys/browse: nothing maps a room to its host.";
+            };
+            readonly rooms: {
+                readonly type: "array";
+                readonly minItems: 1;
+                readonly maxItems: 64;
+                readonly description: "The rooms to watch at this host, each at most once. Each is armed at the host with its own rooms/watch request, presentation and address; the host never sees them together.";
+                readonly items: {
+                    readonly $ref: "#/$defs/RoomWatchRequest";
+                };
+            };
+            readonly leaseSeconds: {
+                readonly type: "integer";
+                readonly minimum: 60;
+                readonly maximum: 2592000;
+                readonly description: "How long the caller asks each watch to last if it does not fire, in seconds, up to 30 days. Passed to the host as rooms/watch's leaseSeconds; the host and the recipient MAY grant less. Absent means the host's default. Ignored on a cancel.";
+            };
+            readonly cancel: {
+                readonly type: "boolean";
+                readonly const: true;
+                readonly description: "End the watches on the named rooms. Only `true` is meaningful, so only `true` is accepted. A cancel of a watch the recipient does not hold succeeds with `armed: false`.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+                readonly description: "Ecosystem-defined extension members per SPEC.md §4.5.1.";
+            };
+        };
+        readonly $defs: {
+            readonly RoomWatchRequest: {
+                readonly title: "Room to watch";
+                readonly description: "One room of the request, with the version the caller has read it to.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["roomId"];
+                readonly properties: {
+                    readonly roomId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 2048;
+                        readonly description: "The room.";
+                    };
+                    readonly sinceVersion: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "The highest version of the room the caller has read to, passed to the host as rooms/watch's sinceVersion: the host signals as soon as the room is above it, at once if it already is. Absent means the room's latest version when the host arms the watch. Ignored on a cancel.";
+                    };
+                };
+            };
+            readonly RoomWatchOutcome: {
+                readonly title: "Outcome for one room";
+                readonly description: "What became of one room of the request.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["roomId", "armed"];
+                readonly properties: {
+                    readonly roomId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 2048;
+                        readonly description: "The room, echoed.";
+                    };
+                    readonly armed: {
+                        readonly type: "boolean";
+                        readonly description: "`true`: the host holds the watch armed and the recipient will pass on its signal with rooms/keys/changed. `false`: the watch was cancelled, there was none to cancel, or it was refused (`refused` says why).";
+                    };
+                    readonly expiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present when `armed` is `true`: when the watch lapses if it has not fired — the expiresAt the host answered, or earlier where the recipient bounds it. The caller re-arms before then if it still wants a signal.";
+                    };
+                    readonly refused: {
+                        readonly type: "string";
+                        readonly enum: readonly ["notAMember", "actionNotHeld", "limitReached", "hostUnreachable", "hostRefused"];
+                        readonly description: "Present when this room's watch was not armed or cancelled because of a refusal. `notAMember`: the recipient holds no credential the room issued to `member`. `actionNotHeld`: the member's credentials do not confer `read`. `limitReached`: the recipient holds as many watches as it allows — the caller polls this room. `hostUnreachable`: the host could not be resolved, advertises no transport the recipient speaks, or did not answer — a retry may succeed. `hostRefused`: the host answered with a trust-task-error, whose code is in `hostCode`.";
+                    };
+                    readonly hostCode: {
+                        readonly type: "string";
+                        readonly maxLength: 256;
+                        readonly description: "Present when `refused` is `hostRefused`: the code of the host's trust-task-error, unaltered — for instance `rooms/watch:limitReached` or the standard `permissionDenied`.";
+                    };
+                };
+            };
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Rooms Keys — Watch — response payload";
+                readonly description: "Success response to rooms/keys/watch: one outcome per room requested, in the order requested. Type https://trusttasks.org/spec/rooms/keys/watch/0.1#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["member", "host", "watches"];
+                readonly properties: {
+                    readonly member: {
+                        readonly type: "string";
+                        readonly pattern: "^did:";
+                        readonly maxLength: 2048;
+                        readonly description: "The member, echoed.";
+                    };
+                    readonly host: {
+                        readonly type: "string";
+                        readonly pattern: "^did:";
+                        readonly maxLength: 2048;
+                        readonly description: "The host, echoed.";
+                    };
+                    readonly watches: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly maxItems: 64;
+                        readonly items: {
+                            readonly $ref: "#/$defs/RoomWatchOutcome";
+                        };
+                    };
+                    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-]+)+$";
+                };
+            };
+        };
+    };
+};
+/**
+ * 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/rooms/keys/watch/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly RoomWatchRequest: {
+                readonly title: "Room to watch";
+                readonly description: "One room of the request, with the version the caller has read it to.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["roomId"];
+                readonly properties: {
+                    readonly roomId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 2048;
+                        readonly description: "The room.";
+                    };
+                    readonly sinceVersion: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "The highest version of the room the caller has read to, passed to the host as rooms/watch's sinceVersion: the host signals as soon as the room is above it, at once if it already is. Absent means the room's latest version when the host arms the watch. Ignored on a cancel.";
+                    };
+                };
+            };
+            readonly RoomWatchOutcome: {
+                readonly title: "Outcome for one room";
+                readonly description: "What became of one room of the request.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["roomId", "armed"];
+                readonly properties: {
+                    readonly roomId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 2048;
+                        readonly description: "The room, echoed.";
+                    };
+                    readonly armed: {
+                        readonly type: "boolean";
+                        readonly description: "`true`: the host holds the watch armed and the recipient will pass on its signal with rooms/keys/changed. `false`: the watch was cancelled, there was none to cancel, or it was refused (`refused` says why).";
+                    };
+                    readonly expiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Present when `armed` is `true`: when the watch lapses if it has not fired — the expiresAt the host answered, or earlier where the recipient bounds it. The caller re-arms before then if it still wants a signal.";
+                    };
+                    readonly refused: {
+                        readonly type: "string";
+                        readonly enum: readonly ["notAMember", "actionNotHeld", "limitReached", "hostUnreachable", "hostRefused"];
+                        readonly description: "Present when this room's watch was not armed or cancelled because of a refusal. `notAMember`: the recipient holds no credential the room issued to `member`. `actionNotHeld`: the member's credentials do not confer `read`. `limitReached`: the recipient holds as many watches as it allows — the caller polls this room. `hostUnreachable`: the host could not be resolved, advertises no transport the recipient speaks, or did not answer — a retry may succeed. `hostRefused`: the host answered with a trust-task-error, whose code is in `hostCode`.";
+                    };
+                    readonly hostCode: {
+                        readonly type: "string";
+                        readonly maxLength: 256;
+                        readonly description: "Present when `refused` is `hostRefused`: the code of the host's trust-task-error, unaltered — for instance `rooms/watch:limitReached` or the standard `permissionDenied`.";
+                    };
+                };
+            };
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Rooms Keys — Watch — response payload";
+                readonly description: "Success response to rooms/keys/watch: one outcome per room requested, in the order requested. Type https://trusttasks.org/spec/rooms/keys/watch/0.1#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["member", "host", "watches"];
+                readonly properties: {
+                    readonly member: {
+                        readonly type: "string";
+                        readonly pattern: "^did:";
+                        readonly maxLength: 2048;
+                        readonly description: "The member, echoed.";
+                    };
+                    readonly host: {
+                        readonly type: "string";
+                        readonly pattern: "^did:";
+                        readonly maxLength: 2048;
+                        readonly description: "The host, echoed.";
+                    };
+                    readonly watches: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly maxItems: 64;
+                        readonly items: {
+                            readonly $ref: "#/$defs/RoomWatchOutcome";
+                        };
+                    };
+                    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-]+)+$";
+                };
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/rooms/keys/watch/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/rooms/keys/watch/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mCAAmC,CAAC;AAG7D;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,KAAK,EAAE,CAAC,WAAW,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC;IACvC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,OAAO,EAAE,CAAC,iBAAiB,EAAE,GAAG,iBAAiB,EAAE,CAAC,CAAC;IACrD,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,GAAG,eAAe,GAAG,cAAc,GAAG,iBAAiB,GAAG,aAAa,CAAC;IAC9F;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,CAAC;AAEpB,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,kDAA2D,CAAC;AAEpF;;;;;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,qBAAqB,CAAC;AAE5C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,2DAAoE,CAAC;AAEtG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,6BAA6B,CAAC;AAErD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoKjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqH1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}