@openvtc/trust-tasks 0.26.0 → 0.26.2

package/dist/vtc/admin/events/subscribe/0.2/payload.d.ts

@@ -0,0 +1,409 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/admin/events/subscribe/0.2/payload.schema.json
+ */
+import type { Ext, ResumeToken, Topic_VtcAdminEventsV0_2 as Topic } from "../../../../../_shared/components.js";
+/**
+ * Open an administrator console's live channel of hint-only events. The success response is the first document on a stream that then carries vtc/admin/events/event/0.2 documents; over HTTPS that stream is the streamed response of bindings/https/0.3 §2.1. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTCAdminEventsSubscribePayload {
+    /**
+     * The topics the console renders. The community narrows this to the topics the caller may read and reports the result as the response's `topics`.
+     *
+     * @minItems 1
+     * @maxItems 7
+     */
+    topics: [Topic] | [Topic, Topic] | [Topic, Topic, Topic] | [Topic, Topic, Topic, Topic] | [Topic, Topic, Topic, Topic, Topic] | [Topic, Topic, Topic, Topic, Topic, Topic] | [Topic, Topic, Topic, Topic, Topic, Topic, Topic];
+    /**
+     * The last `resumeToken` the console received on an earlier stream, to resume from. A token the community does not recognise, has expired, or minted for another caller is not an error: the stream starts fresh and the response says `resumed: false`.
+     */
+    since?: ResumeToken;
+    ext?: Ext;
+}
+/**
+ * The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.
+ */
+export interface VTCAdminEventsSubscribeResponsePayload {
+    /**
+     * The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live.
+     *
+     * @minItems 1
+     * @maxItems 7
+     */
+    topics: [Topic] | [Topic, Topic] | [Topic, Topic, Topic] | [Topic, Topic, Topic, Topic] | [Topic, Topic, Topic, Topic, Topic] | [Topic, Topic, Topic, Topic, Topic, Topic] | [Topic, Topic, Topic, Topic, Topic, Topic, Topic];
+    /**
+     * The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead.
+     */
+    heartbeatSeconds: number;
+    /**
+     * `true` when the community recognised `since` and will send a hint for every effective topic that changed after it. `false` when no `since` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes.
+     */
+    resumed: boolean;
+    /**
+     * The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from.
+     */
+    resumeToken: ResumeToken;
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, ResumeToken, Topic };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vtc/admin/events/subscribe/0.2";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCAdminEventsSubscribePayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/admin/events/subscribe/0.2#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCAdminEventsSubscribeResponsePayload;
+/**
+ * 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/vtc/admin/events/subscribe/0.2";
+    readonly title: "VTC Admin Events — Subscribe — payload";
+    readonly description: "Open an administrator console's live channel of hint-only events. The success response is the first document on a stream that then carries vtc/admin/events/event/0.2 documents; over HTTPS that stream is the streamed response of bindings/https/0.3 §2.1. 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 ["topics"];
+    readonly properties: {
+        readonly topics: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly maxItems: 7;
+            readonly uniqueItems: true;
+            readonly items: {
+                readonly $ref: "#/$defs/Topic";
+            };
+            readonly description: "The topics the console renders. The community narrows this to the topics the caller may read and reports the result as the response's `topics`.";
+        };
+        readonly since: {
+            readonly $ref: "#/$defs/ResumeToken";
+            readonly description: "The last `resumeToken` the console received on an earlier stream, to resume from. A token the community does not recognise, has expired, or minted for another caller is not an error: the stream starts fresh and the response says `resumed: false`.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Admin Events — Subscribe — response payload";
+            readonly description: "The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["topics", "heartbeatSeconds", "resumed", "resumeToken"];
+            readonly properties: {
+                readonly topics: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 7;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/Topic";
+                    };
+                    readonly description: "The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live.";
+                };
+                readonly heartbeatSeconds: {
+                    readonly type: "integer";
+                    readonly minimum: 5;
+                    readonly maximum: 60;
+                    readonly description: "The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead.";
+                };
+                readonly resumed: {
+                    readonly type: "boolean";
+                    readonly description: "`true` when the community recognised `since` and will send a hint for every effective topic that changed after it. `false` when no `since` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes.";
+                };
+                readonly resumeToken: {
+                    readonly $ref: "#/$defs/ResumeToken";
+                    readonly description: "The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from.";
+                };
+                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 ResumeToken: {
+            readonly title: "ResumeToken";
+            readonly description: "Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+            readonly pattern: "^[A-Za-z0-9._~-]+$";
+        };
+        readonly Topic: {
+            readonly title: "Topic";
+            readonly description: "One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.";
+            readonly type: "string";
+            readonly enum: readonly ["actions", "acknowledgements", "joinRequests", "members", "singleAdminMode", "config", "rooms"];
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Admin Events — Subscribe — response payload";
+            readonly description: "The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["topics", "heartbeatSeconds", "resumed", "resumeToken"];
+            readonly properties: {
+                readonly topics: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly maxItems: 7;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly $ref: "#/$defs/Topic";
+                    };
+                    readonly description: "The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live.";
+                };
+                readonly heartbeatSeconds: {
+                    readonly type: "integer";
+                    readonly minimum: 5;
+                    readonly maximum: 60;
+                    readonly description: "The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead.";
+                };
+                readonly resumed: {
+                    readonly type: "boolean";
+                    readonly description: "`true` when the community recognised `since` and will send a hint for every effective topic that changed after it. `false` when no `since` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes.";
+                };
+                readonly resumeToken: {
+                    readonly $ref: "#/$defs/ResumeToken";
+                    readonly description: "The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from.";
+                };
+                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 ResumeToken: {
+            readonly title: "ResumeToken";
+            readonly description: "Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 256;
+            readonly pattern: "^[A-Za-z0-9._~-]+$";
+        };
+        readonly Topic: {
+            readonly title: "Topic";
+            readonly description: "One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.";
+            readonly type: "string";
+            readonly enum: readonly ["actions", "acknowledgements", "joinRequests", "members", "singleAdminMode", "config", "rooms"];
+        };
+    };
+};
+/**
+ * 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/vtc/admin/events/subscribe/0.2";
+    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/vtc/admin/events/subscribe/0.2";
+        readonly title: "VTC Admin Events — Subscribe — payload";
+        readonly description: "Open an administrator console's live channel of hint-only events. The success response is the first document on a stream that then carries vtc/admin/events/event/0.2 documents; over HTTPS that stream is the streamed response of bindings/https/0.3 §2.1. 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 ["topics"];
+        readonly properties: {
+            readonly topics: {
+                readonly type: "array";
+                readonly minItems: 1;
+                readonly maxItems: 7;
+                readonly uniqueItems: true;
+                readonly items: {
+                    readonly $ref: "#/$defs/Topic";
+                };
+                readonly description: "The topics the console renders. The community narrows this to the topics the caller may read and reports the result as the response's `topics`.";
+            };
+            readonly since: {
+                readonly $ref: "#/$defs/ResumeToken";
+                readonly description: "The last `resumeToken` the console received on an earlier stream, to resume from. A token the community does not recognise, has expired, or minted for another caller is not an error: the stream starts fresh and the response says `resumed: false`.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Admin Events — Subscribe — response payload";
+                readonly description: "The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["topics", "heartbeatSeconds", "resumed", "resumeToken"];
+                readonly properties: {
+                    readonly topics: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly maxItems: 7;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/Topic";
+                        };
+                        readonly description: "The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live.";
+                    };
+                    readonly heartbeatSeconds: {
+                        readonly type: "integer";
+                        readonly minimum: 5;
+                        readonly maximum: 60;
+                        readonly description: "The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead.";
+                    };
+                    readonly resumed: {
+                        readonly type: "boolean";
+                        readonly description: "`true` when the community recognised `since` and will send a hint for every effective topic that changed after it. `false` when no `since` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes.";
+                    };
+                    readonly resumeToken: {
+                        readonly $ref: "#/$defs/ResumeToken";
+                        readonly description: "The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from.";
+                    };
+                    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 ResumeToken: {
+                readonly title: "ResumeToken";
+                readonly description: "Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+                readonly pattern: "^[A-Za-z0-9._~-]+$";
+            };
+            readonly Topic: {
+                readonly title: "Topic";
+                readonly description: "One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.";
+                readonly type: "string";
+                readonly enum: readonly ["actions", "acknowledgements", "joinRequests", "members", "singleAdminMode", "config", "rooms"];
+            };
+        };
+    };
+};
+/**
+ * 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/vtc/admin/events/subscribe/0.2#response";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    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 Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Admin Events — Subscribe — response payload";
+                readonly description: "The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["topics", "heartbeatSeconds", "resumed", "resumeToken"];
+                readonly properties: {
+                    readonly topics: {
+                        readonly type: "array";
+                        readonly minItems: 1;
+                        readonly maxItems: 7;
+                        readonly uniqueItems: true;
+                        readonly items: {
+                            readonly $ref: "#/$defs/Topic";
+                        };
+                        readonly description: "The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live.";
+                    };
+                    readonly heartbeatSeconds: {
+                        readonly type: "integer";
+                        readonly minimum: 5;
+                        readonly maximum: 60;
+                        readonly description: "The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead.";
+                    };
+                    readonly resumed: {
+                        readonly type: "boolean";
+                        readonly description: "`true` when the community recognised `since` and will send a hint for every effective topic that changed after it. `false` when no `since` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes.";
+                    };
+                    readonly resumeToken: {
+                        readonly $ref: "#/$defs/ResumeToken";
+                        readonly description: "The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from.";
+                    };
+                    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 ResumeToken: {
+                readonly title: "ResumeToken";
+                readonly description: "Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 256;
+                readonly pattern: "^[A-Za-z0-9._~-]+$";
+            };
+            readonly Topic: {
+                readonly title: "Topic";
+                readonly description: "One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.";
+                readonly type: "string";
+                readonly enum: readonly ["actions", "acknowledgements", "joinRequests", "members", "singleAdminMode", "config", "rooms"];
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vtc/admin/events/subscribe/0.2/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vtc/admin/events/subscribe/0.2/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,wBAAwB,IAAI,KAAK,EAAE,MAAM,sCAAsC,CAAC;AAGhH;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;;OAKG;IACH,MAAM,EACF,CAAC,KAAK,CAAC,GACP,CAAC,KAAK,EAAE,KAAK,CAAC,GACd,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,GACrB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,GAC5B,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,GACnC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,GAC1C,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACtD;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD;;;;;OAKG;IACH,MAAM,EACF,CAAC,KAAK,CAAC,GACP,CAAC,KAAK,EAAE,KAAK,CAAC,GACd,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,GACrB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,GAC5B,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,GACnC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,GAC1C,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACtD;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;AAExC,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,4DAAqE,CAAC;AAE9F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,8BAA8B,CAAC;AAErD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,qEAA8E,CAAC;AAEhH,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,sCAAsC,CAAC;AAE9D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyGjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+E1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}

package/dist/vtc/admin/events/subscribe/0.2/payload.js

@@ -0,0 +1,232 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/admin/events/subscribe/0.2/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/admin/events/subscribe/0.2";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/admin/events/subscribe/0.2#response";
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://trusttasks.org/spec/vtc/admin/events/subscribe/0.2",
+    "title": "VTC Admin Events — Subscribe — payload",
+    "description": "Open an administrator console's live channel of hint-only events. The success response is the first document on a stream that then carries vtc/admin/events/event/0.2 documents; over HTTPS that stream is the streamed response of bindings/https/0.3 §2.1. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "topics"
+    ],
+    "properties": {
+        "topics": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 7,
+            "uniqueItems": true,
+            "items": {
+                "$ref": "#/$defs/Topic"
+            },
+            "description": "The topics the console renders. The community narrows this to the topics the caller may read and reports the result as the response's `topics`."
+        },
+        "since": {
+            "$ref": "#/$defs/ResumeToken",
+            "description": "The last `resumeToken` the console received on an earlier stream, to resume from. A token the community does not recognise, has expired, or minted for another caller is not an error: the stream starts fresh and the response says `resumed: false`."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTC Admin Events — Subscribe — response payload",
+            "description": "The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "topics",
+                "heartbeatSeconds",
+                "resumed",
+                "resumeToken"
+            ],
+            "properties": {
+                "topics": {
+                    "type": "array",
+                    "minItems": 1,
+                    "maxItems": 7,
+                    "uniqueItems": true,
+                    "items": {
+                        "$ref": "#/$defs/Topic"
+                    },
+                    "description": "The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live."
+                },
+                "heartbeatSeconds": {
+                    "type": "integer",
+                    "minimum": 5,
+                    "maximum": 60,
+                    "description": "The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead."
+                },
+                "resumed": {
+                    "type": "boolean",
+                    "description": "`true` when the community recognised `since` and will send a hint for every effective topic that changed after it. `false` when no `since` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes."
+                },
+                "resumeToken": {
+                    "$ref": "#/$defs/ResumeToken",
+                    "description": "The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "Ext": {
+            "title": "Ext",
+            "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": true,
+            "propertyNames": {
+                "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+            }
+        },
+        "ResumeToken": {
+            "title": "ResumeToken",
+            "description": "Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.",
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256,
+            "pattern": "^[A-Za-z0-9._~-]+$"
+        },
+        "Topic": {
+            "title": "Topic",
+            "description": "One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.",
+            "type": "string",
+            "enum": [
+                "actions",
+                "acknowledgements",
+                "joinRequests",
+                "members",
+                "singleAdminMode",
+                "config",
+                "rooms"
+            ]
+        }
+    }
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$ref": "#/$defs/Response",
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTC Admin Events — Subscribe — response payload",
+            "description": "The subscription as granted, sent as the first document on the stream. Failures use trust-task-error and open no stream.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "topics",
+                "heartbeatSeconds",
+                "resumed",
+                "resumeToken"
+            ],
+            "properties": {
+                "topics": {
+                    "type": "array",
+                    "minItems": 1,
+                    "maxItems": 7,
+                    "uniqueItems": true,
+                    "items": {
+                        "$ref": "#/$defs/Topic"
+                    },
+                    "description": "The effective topics: those requested that the caller may read. The community sends events for these and no others. A requested topic missing here is one the caller may not read, and the console MUST NOT present it as live."
+                },
+                "heartbeatSeconds": {
+                    "type": "integer",
+                    "minimum": 5,
+                    "maximum": 60,
+                    "description": "The longest the community lets the stream go without sending anything. Over HTTPS the heartbeat is an SSE comment. A console that receives nothing for twice this interval MUST treat the stream as dead."
+                },
+                "resumed": {
+                    "type": "boolean",
+                    "description": "`true` when the community recognised `since` and will send a hint for every effective topic that changed after it. `false` when no `since` was given or it could not be honoured; the console MUST then re-fetch every effective topic, because it may have missed changes."
+                },
+                "resumeToken": {
+                    "$ref": "#/$defs/ResumeToken",
+                    "description": "The stream position as of this response, so that a console that disconnects before its first event still has a token to resume from."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "Ext": {
+            "title": "Ext",
+            "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": true,
+            "propertyNames": {
+                "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+            }
+        },
+        "ResumeToken": {
+            "title": "ResumeToken",
+            "description": "Opaque, community-minted position in one caller's event stream. A console MUST NOT parse, construct or order it; it only hands the latest one back as `since` when it re-subscribes. A community binds it to the caller it was minted for and treats a token minted for anyone else as unknown.",
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256,
+            "pattern": "^[A-Za-z0-9._~-]+$"
+        },
+        "Topic": {
+            "title": "Topic",
+            "description": "One kind of change a console can be told about. A closed set: a topic not listed here is a new MINOR version of this component, not an `ext` member, because each topic is bound to the read that authorizes it.",
+            "type": "string",
+            "enum": [
+                "actions",
+                "acknowledgements",
+                "joinRequests",
+                "members",
+                "singleAdminMode",
+                "config",
+                "rooms"
+            ]
+        }
+    }
+};
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+    typeUri: TYPE_URI,
+    isBearer: false,
+    isProofRequired: true,
+    isRecipientRequired: true,
+    isIssuedAtRequired: true,
+    payloadSchema: PAYLOAD_SCHEMA,
+};
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+    typeUri: RESPONSE_TYPE_URI,
+    isBearer: false,
+    isProofRequired: false,
+    isRecipientRequired: true,
+    isIssuedAtRequired: true,
+    payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+};
+//# sourceMappingURL=payload.js.map