@openvtc/trust-tasks 0.27.1 → 0.27.3

package/dist/vtc/admin/events/event/0.4/payload.d.ts

@@ -0,0 +1,172 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/admin/events/event/0.4/payload.schema.json
+ */
+import type { Ext, ResumeToken, Topic_VtcAdminEventsV0_4 as Topic } from "../../../../../_shared/components.js";
+/**
+ * One hint, sent by a Verifiable Trust Community down an administrator console's live channel: something under `topic` changed, re-read it. It never carries the record that changed. Fire-and-forget: there is no response. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTCAdminEventsEventPayload {
+    /**
+     * What changed. Always one of the effective topics the subscribe response named.
+     */
+    topic: Topic;
+    /**
+     * When the community observed the change. Where it coalesced several changes into this hint, the latest of them.
+     */
+    at: string;
+    /**
+     * Only on a count topic (`actions`, `acknowledgements`, `joinRequests`): the caller's current count for that topic as of `at` — what a console badge shows. Absent on every other topic. A console MAY show it until its re-fetch returns, and MUST prefer the read's own count once it does.
+     */
+    count?: number;
+    /**
+     * The stream position after this hint. A console keeps the latest one and passes it back as `since` when it re-subscribes.
+     */
+    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/event/0.4";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCAdminEventsEventPayload;
+/**
+ * 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/event/0.4";
+    readonly title: "VTC Admin Events — Event — payload";
+    readonly description: "One hint, sent by a Verifiable Trust Community down an administrator console's live channel: something under `topic` changed, re-read it. It never carries the record that changed. Fire-and-forget: there is no response. 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 ["topic", "at", "resumeToken"];
+    readonly properties: {
+        readonly topic: {
+            readonly $ref: "#/$defs/Topic";
+            readonly description: "What changed. Always one of the effective topics the subscribe response named.";
+        };
+        readonly at: {
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly description: "When the community observed the change. Where it coalesced several changes into this hint, the latest of them.";
+        };
+        readonly count: {
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly description: "Only on a count topic (`actions`, `acknowledgements`, `joinRequests`): the caller's current count for that topic as of `at` — what a console badge shows. Absent on every other topic. A console MAY show it until its re-fetch returns, and MUST prefer the read's own count once it does.";
+        };
+        readonly resumeToken: {
+            readonly $ref: "#/$defs/ResumeToken";
+            readonly description: "The stream position after this hint. A console keeps the latest one and passes it back as `since` when it re-subscribes.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        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", "directory", "groups", "communityRooms"];
+        };
+    };
+};
+/**
+ * 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/event/0.4";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vtc/admin/events/event/0.4";
+        readonly title: "VTC Admin Events — Event — payload";
+        readonly description: "One hint, sent by a Verifiable Trust Community down an administrator console's live channel: something under `topic` changed, re-read it. It never carries the record that changed. Fire-and-forget: there is no response. 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 ["topic", "at", "resumeToken"];
+        readonly properties: {
+            readonly topic: {
+                readonly $ref: "#/$defs/Topic";
+                readonly description: "What changed. Always one of the effective topics the subscribe response named.";
+            };
+            readonly at: {
+                readonly type: "string";
+                readonly format: "date-time";
+                readonly description: "When the community observed the change. Where it coalesced several changes into this hint, the latest of them.";
+            };
+            readonly count: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly description: "Only on a count topic (`actions`, `acknowledgements`, `joinRequests`): the caller's current count for that topic as of `at` — what a console badge shows. Absent on every other topic. A console MAY show it until its re-fetch returns, and MUST prefer the read's own count once it does.";
+            };
+            readonly resumeToken: {
+                readonly $ref: "#/$defs/ResumeToken";
+                readonly description: "The stream position after this hint. A console keeps the latest one and passes it back as `since` when it re-subscribes.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            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", "directory", "groups", "communityRooms"];
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vtc/admin/events/event/0.4/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vtc/admin/events/event/0.4/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,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IACb;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;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,wDAAiE,CAAC;AAE1F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAEjD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwEjB,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC"}

package/dist/vtc/admin/events/event/0.4/payload.js

@@ -0,0 +1,103 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/admin/events/event/0.4/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/admin/events/event/0.4";
+/**
+ * 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/event/0.4",
+    "title": "VTC Admin Events — Event — payload",
+    "description": "One hint, sent by a Verifiable Trust Community down an administrator console's live channel: something under `topic` changed, re-read it. It never carries the record that changed. Fire-and-forget: there is no response. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "topic",
+        "at",
+        "resumeToken"
+    ],
+    "properties": {
+        "topic": {
+            "$ref": "#/$defs/Topic",
+            "description": "What changed. Always one of the effective topics the subscribe response named."
+        },
+        "at": {
+            "type": "string",
+            "format": "date-time",
+            "description": "When the community observed the change. Where it coalesced several changes into this hint, the latest of them."
+        },
+        "count": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Only on a count topic (`actions`, `acknowledgements`, `joinRequests`): the caller's current count for that topic as of `at` — what a console badge shows. Absent on every other topic. A console MAY show it until its re-fetch returns, and MUST prefer the read's own count once it does."
+        },
+        "resumeToken": {
+            "$ref": "#/$defs/ResumeToken",
+            "description": "The stream position after this hint. A console keeps the latest one and passes it back as `since` when it re-subscribes."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "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",
+                "directory",
+                "groups",
+                "communityRooms"
+            ]
+        }
+    }
+};
+/**
+ * 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: false,
+    isRecipientRequired: true,
+    isIssuedAtRequired: false,
+    payloadSchema: PAYLOAD_SCHEMA,
+};
+//# sourceMappingURL=payload.js.map

package/dist/vtc/admin/events/event/0.4/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../../src/vtc/admin/events/event/0.4/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA+BH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,wDAAiE,CAAC;AAK1F;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,wDAAwD;IAC/D,OAAO,EAAE,oCAAoC;IAC7C,aAAa,EAAE,yVAAyV;IACxW,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,UAAU,EAAE;QACV,OAAO;QACP,IAAI;QACJ,aAAa;KACd;IACD,YAAY,EAAE;QACZ,OAAO,EAAE;YACP,MAAM,EAAE,eAAe;YACvB,aAAa,EAAE,gFAAgF;SAChG;QACD,IAAI,EAAE;YACJ,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,WAAW;YACrB,aAAa,EAAE,gHAAgH;SAChI;QACD,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,CAAC;YACZ,aAAa,EAAE,6RAA6R;SAC7S;QACD,aAAa,EAAE;YACb,MAAM,EAAE,qBAAqB;YAC7B,aAAa,EAAE,0HAA0H;SAC1I;QACD,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;SACtB;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;QACD,aAAa,EAAE;YACb,OAAO,EAAE,aAAa;YACtB,aAAa,EAAE,iSAAiS;YAChT,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,CAAC;YACd,WAAW,EAAE,GAAG;YAChB,SAAS,EAAE,oBAAoB;SAChC;QACD,OAAO,EAAE;YACP,OAAO,EAAE,OAAO;YAChB,aAAa,EAAE,kNAAkN;YACjO,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE;gBACN,SAAS;gBACT,kBAAkB;gBAClB,cAAc;gBACd,SAAS;gBACT,iBAAiB;gBACjB,QAAQ;gBACR,OAAO;gBACP,WAAW;gBACX,QAAQ;gBACR,gBAAgB;aACjB;SACF;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,KAAK;IACzB,aAAa,EAAE,cAAc;CACrB,CAAC"}