@openvtc/trust-tasks 0.28.11 → 0.28.13

package/src/index.ts

@@ -2339,6 +2339,18 @@ export import VtaBackupInitiateImport_v1_1 = _VtaBackupInitiateImport_v1_1;
 import * as _VtaBackupPutChunk_v1_0 from "./vta/backup/put-chunk/1.0/payload.js";
 /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
 export import VtaBackupPutChunk_v1_0 = _VtaBackupPutChunk_v1_0;
+import * as _CollectionShared_v0_1 from "./vta/collection/_shared/0.1/collection.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import CollectionShared_v0_1 = _CollectionShared_v0_1;
+import * as _VtaCollectionClaim_v0_1 from "./vta/collection/claim/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtaCollectionClaim_v0_1 = _VtaCollectionClaim_v0_1;
+import * as _VtaCollectionList_v0_1 from "./vta/collection/list/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtaCollectionList_v0_1 = _VtaCollectionList_v0_1;
+import * as _VtaCollectionRelease_v0_1 from "./vta/collection/release/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtaCollectionRelease_v0_1 = _VtaCollectionRelease_v0_1;
 import * as _VtaContextsCreate_v1_0 from "./vta/contexts/create/1.0/payload.js";
 /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
 export import VtaContextsCreate_v1_0 = _VtaContextsCreate_v1_0;
@@ -3134,6 +3146,48 @@ export import VtcBackupExport_v0_1 = _VtcBackupExport_v0_1;
 import * as _VtcBackupImport_v0_1 from "./vtc/backup/import/0.1/payload.js";
 /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
 export import VtcBackupImport_v0_1 = _VtcBackupImport_v0_1;
+import * as _BoardShared_v0_1 from "./vtc/boards/_shared/0.1/board.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import BoardShared_v0_1 = _BoardShared_v0_1;
+import * as _VtcBoardsCreate_v0_1 from "./vtc/boards/create/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsCreate_v0_1 = _VtcBoardsCreate_v0_1;
+import * as _VtcBoardsIdeasDecide_v0_1 from "./vtc/boards/ideas/decide/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsIdeasDecide_v0_1 = _VtcBoardsIdeasDecide_v0_1;
+import * as _VtcBoardsIdeasPropose_v0_1 from "./vtc/boards/ideas/propose/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsIdeasPropose_v0_1 = _VtcBoardsIdeasPropose_v0_1;
+import * as _VtcBoardsIdeasSelect_v0_1 from "./vtc/boards/ideas/select/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsIdeasSelect_v0_1 = _VtcBoardsIdeasSelect_v0_1;
+import * as _VtcBoardsIdeasUpdate_v0_1 from "./vtc/boards/ideas/update/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsIdeasUpdate_v0_1 = _VtcBoardsIdeasUpdate_v0_1;
+import * as _VtcBoardsIdeasWithdraw_v0_1 from "./vtc/boards/ideas/withdraw/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsIdeasWithdraw_v0_1 = _VtcBoardsIdeasWithdraw_v0_1;
+import * as _VtcBoardsList_v0_1 from "./vtc/boards/list/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsList_v0_1 = _VtcBoardsList_v0_1;
+import * as _VtcBoardsNotesAdd_v0_1 from "./vtc/boards/notes/add/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsNotesAdd_v0_1 = _VtcBoardsNotesAdd_v0_1;
+import * as _VtcBoardsNotesHide_v0_1 from "./vtc/boards/notes/hide/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsNotesHide_v0_1 = _VtcBoardsNotesHide_v0_1;
+import * as _VtcBoardsNotesList_v0_1 from "./vtc/boards/notes/list/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsNotesList_v0_1 = _VtcBoardsNotesList_v0_1;
+import * as _VtcBoardsNotesWithdraw_v0_1 from "./vtc/boards/notes/withdraw/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsNotesWithdraw_v0_1 = _VtcBoardsNotesWithdraw_v0_1;
+import * as _VtcBoardsShow_v0_1 from "./vtc/boards/show/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsShow_v0_1 = _VtcBoardsShow_v0_1;
+import * as _VtcBoardsUpdate_v0_1 from "./vtc/boards/update/0.1/payload.js";
+/** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
+export import VtcBoardsUpdate_v0_1 = _VtcBoardsUpdate_v0_1;
 import * as _VtcCeremoniesList_v0_1 from "./vtc/ceremonies/list/0.1/payload.js";
 /** @deprecated The prebuilt specification modules will be removed: pin the tasks you use with the `trust-tasks` CLI, generate them with `@openvtc/trust-tasks-gen`, and import the runtime from `@openvtc/trust-tasks/runtime` (GETTING-STARTED.md). */
 export import VtcCeremoniesList_v0_1 = _VtcCeremoniesList_v0_1;

package/src/vta/collection/_shared/0.1/collection.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/collection/_shared/0.1/collection.schema.json
+ */
+
+/**
+ * Shared shapes for the collection of messages for a principal's identifiers. A VTA collects, from the mediator each identifier's DID document advertises, the messages queued for every identifier whose messaging keys it holds in one of the principal's trust contexts — its personas — unless a client of the principal holds a collection claim for it: a lease, granted by vta/collection/claim and ended by vta/collection/release or at its end, under which that client is the identifier's one collector. The mediator permits one connection per identifier, so at most one party collects for an identifier at a time (VTI-NTF-080 – VTI-NTF-092).
+ */
+export interface VTACollectionSharedDefinitions {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../../_shared/components.js".
+ */
+export type { Claim, CollectionEntry, Collector, ContextId_VtaCollectionV0_1 as ContextId, Did_NotificationsV0_1 as Did, NotCollectedReason } from "../../../../_shared/components.js";

package/src/vta/collection/claim/0.1/payload.ts

@@ -0,0 +1,247 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/collection/claim/0.1/payload.schema.json
+ */
+
+import type { ContextId_VtaCollectionV0_1 as ContextId, Did_NotificationsV0_1 as Did, Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * A client with standing in a trust context asks its VTA to make it, until a stated end, the one collector of the messages queued at the mediator for an identifier whose keys the VTA holds there — a persona DID — or renews a claim it already holds. Before it grants, the VTA stops collecting for the identifier and closes every connection it holds for it; the client opens its own only once it holds the grant, and closes it before the claim ends unless it has renewed (VTI-NTF-081 – VTI-NTF-083). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTACollectionClaimPayload {
+  contextId: ContextId;
+  /**
+   * The identifier to collect for: one whose messaging keys the VTA holds in `contextId` and whose DID document advertises a transport through a mediator.
+   */
+  identifier: Did;
+  /**
+   * How long the client asks the claim to last from the grant. The VTA grants no longer than the maximum it states, and may grant less; absent, it grants its own default. The granted end is `endsAt` in the response.
+   */
+  durationSeconds?: number;
+  ext?: Ext;
+}
+/**
+ * The grant: the VTA has stopped collecting for `identifier` and closed every connection it held for it, and the caller is its collector until `endsAt`.
+ */
+export interface VTACollectionClaimResponsePayload {
+  identifier: Did;
+  /**
+   * When the claim ends unless renewed. The client stops collecting before this instant less its clock-skew tolerance (VTI-NTF-083).
+   */
+  endsAt: string;
+  /**
+   * True when the caller already held a claim for the identifier and this grant moved its end; absent or false for a new claim.
+   */
+  renewed?: boolean;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ContextId, Did, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/collection/claim/0.1" as const;
+
+/**
+ * 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 const EXTENDS: string | null = 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 const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTACollectionClaimPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/collection/claim/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTACollectionClaimResponsePayload;
+
+/**
+ * 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/vta/collection/claim/0.1",
+  "title": "VTA Collection — Claim — payload",
+  "description": "A client with standing in a trust context asks its VTA to make it, until a stated end, the one collector of the messages queued at the mediator for an identifier whose keys the VTA holds there — a persona DID — or renews a claim it already holds. Before it grants, the VTA stops collecting for the identifier and closes every connection it holds for it; the client opens its own only once it holds the grant, and closes it before the claim ends unless it has renewed (VTI-NTF-081 – VTI-NTF-083). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId",
+    "identifier"
+  ],
+  "properties": {
+    "contextId": {
+      "$ref": "#/$defs/ContextId"
+    },
+    "identifier": {
+      "$ref": "#/$defs/Did",
+      "description": "The identifier to collect for: one whose messaging keys the VTA holds in `contextId` and whose DID document advertises a transport through a mediator."
+    },
+    "durationSeconds": {
+      "type": "integer",
+      "minimum": 60,
+      "maximum": 2592000,
+      "description": "How long the client asks the claim to last from the grant. The VTA grants no longer than the maximum it states, and may grant less; absent, it grants its own default. The granted end is `endsAt` in the response."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Collection — Claim — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "identifier",
+        "endsAt"
+      ],
+      "description": "The grant: the VTA has stopped collecting for `identifier` and closed every connection it held for it, and the caller is its collector until `endsAt`.",
+      "properties": {
+        "identifier": {
+          "$ref": "#/$defs/Did"
+        },
+        "endsAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the claim ends unless renewed. The client stops collecting before this instant less its clock-skew tolerance (VTI-NTF-083)."
+        },
+        "renewed": {
+          "type": "boolean",
+          "description": "True when the caller already held a claim for the identifier and this grant moved its end; absent or false for a new claim."
+        }
+      }
+    },
+    "Did": {
+      "title": "Did",
+      "description": "A DID.",
+      "type": "string",
+      "minLength": 8,
+      "maxLength": 2048,
+      "pattern": "^did:[a-z0-9]+:\\S+$"
+    },
+    "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-]+)+$"
+      }
+    },
+    "ContextId": {
+      "title": "ContextId",
+      "description": "The trust context the identifier belongs to.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256
+    }
+  }
+} as const;
+
+/** 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": "VTA Collection — Claim — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "identifier",
+        "endsAt"
+      ],
+      "description": "The grant: the VTA has stopped collecting for `identifier` and closed every connection it held for it, and the caller is its collector until `endsAt`.",
+      "properties": {
+        "identifier": {
+          "$ref": "#/$defs/Did"
+        },
+        "endsAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the claim ends unless renewed. The client stops collecting before this instant less its clock-skew tolerance (VTI-NTF-083)."
+        },
+        "renewed": {
+          "type": "boolean",
+          "description": "True when the caller already held a claim for the identifier and this grant moved its end; absent or false for a new claim."
+        }
+      }
+    },
+    "Did": {
+      "title": "Did",
+      "description": "A DID.",
+      "type": "string",
+      "minLength": 8,
+      "maxLength": 2048,
+      "pattern": "^did:[a-z0-9]+:\\S+$"
+    },
+    "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-]+)+$"
+      }
+    },
+    "ContextId": {
+      "title": "ContextId",
+      "description": "The trust context the identifier belongs to.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256
+    }
+  }
+} as const;
+
+/**
+ * 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: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * 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,
+} as const;