@openvtc/trust-tasks 0.28.10 → 0.28.12

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

@@ -0,0 +1,223 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/collection/release/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 releases the collection claim for an identifier there. Released by its claimant, which has already stopped collecting, the claim ends at once and the VTA collects for the identifier again. Released by any other party, the claim becomes unrenewable and still ends at its end, because its claimant is still connected until then (VTI-NTF-083, VTI-NTF-084). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTACollectionReleasePayload {
+  contextId: ContextId;
+  /**
+   * The identifier whose claim to release.
+   */
+  identifier: Did;
+  ext?: Ext;
+}
+/**
+ * The outcome. `endsAt` is present when a claim was in force: the instant the claim ends — the release itself, for the claimant's own release, and the claim's stated end otherwise. Absent, no claim was in force, and nothing changed.
+ */
+export interface VTACollectionReleaseResponsePayload {
+  identifier: Did;
+  /**
+   * When the released claim ends. The VTA resumes collecting for the identifier then, plus its clock-skew tolerance where the release was not the claimant's.
+   */
+  endsAt?: string;
+}
+
+/** 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/release/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 = VTACollectionReleasePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/collection/release/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTACollectionReleaseResponsePayload;
+
+/**
+ * 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/release/0.1",
+  "title": "VTA Collection — Release — payload",
+  "description": "A client with standing in a trust context releases the collection claim for an identifier there. Released by its claimant, which has already stopped collecting, the claim ends at once and the VTA collects for the identifier again. Released by any other party, the claim becomes unrenewable and still ends at its end, because its claimant is still connected until then (VTI-NTF-083, VTI-NTF-084). 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 whose claim to release."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Collection — Release — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "identifier"
+      ],
+      "description": "The outcome. `endsAt` is present when a claim was in force: the instant the claim ends — the release itself, for the claimant's own release, and the claim's stated end otherwise. Absent, no claim was in force, and nothing changed.",
+      "properties": {
+        "identifier": {
+          "$ref": "#/$defs/Did"
+        },
+        "endsAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the released claim ends. The VTA resumes collecting for the identifier then, plus its clock-skew tolerance where the release was not the claimant's."
+        }
+      }
+    },
+    "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 — Release — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "identifier"
+      ],
+      "description": "The outcome. `endsAt` is present when a claim was in force: the instant the claim ends — the release itself, for the claimant's own release, and the claim's stated end otherwise. Absent, no claim was in force, and nothing changed.",
+      "properties": {
+        "identifier": {
+          "$ref": "#/$defs/Did"
+        },
+        "endsAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the released claim ends. The VTA resumes collecting for the identifier then, plus its clock-skew tolerance where the release was not the claimant's."
+        }
+      }
+    },
+    "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;

package/src/vta/notifications/deposit/0.1/payload.ts

@@ -0,0 +1,243 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/notifications/deposit/0.1/payload.schema.json
+ */
+
+import type { ContextId, Ext, NotificationId } from "../../../../_shared/components.js";
+
+
+/**
+ * A client with standing in a trust context hands its VTA a notifications/notify or notifications/relay document it received for a DID the VTA holds keys of in that context — a persona DID whose mediator socket the client holds — exactly as received, proof included. The VTA verifies and holds it exactly as if the document had been delivered to it directly: the same layer-by-layer verification, the same acceptance policy counting the party that delivered the document and never the depositing client, the same one record per originator and notificationId, and the same receipt whatever it did (VTI-NTF-054 – VTI-NTF-056). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTANotificationsDepositPayload {
+  /**
+   * The trust context the addressed DID belongs to, in which the VTA holds the notification if it accepts it.
+   */
+  contextId: ContextId;
+  document: DepositedDocument;
+  ext?: Ext;
+}
+/**
+ * The notifications/notify/0.1 or notifications/relay/0.1 document the client received, kept whole and exactly as received — proof included — never restated, re-serialised from a typed form, or re-signed. Deliberately an opaque object, so that every member its issuer signed survives byte for byte for the VTA, and later the principal's client through vta/notifications/show, to verify. Its `recipient` MUST be a DID the VTA holds keys of in `contextId`.
+ */
+export interface DepositedDocument {}
+/**
+ * Receipt of a deposited document the VTA verified, naming the innermost notification. The same whether the VTA held it, declined it under its acceptance policy, or already held the revision, and never saying which (VTI-NTF-023, VTI-NTF-055).
+ */
+export interface VTANotificationsDepositResponsePayload {
+  notificationId: NotificationId;
+  /**
+   * The revision of the innermost notification, echoed.
+   */
+  revision: number;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ContextId, Ext, NotificationId };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/notifications/deposit/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 = VTANotificationsDepositPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/notifications/deposit/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTANotificationsDepositResponsePayload;
+
+/**
+ * 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/notifications/deposit/0.1",
+  "title": "VTA Notifications — Deposit — payload",
+  "description": "A client with standing in a trust context hands its VTA a notifications/notify or notifications/relay document it received for a DID the VTA holds keys of in that context — a persona DID whose mediator socket the client holds — exactly as received, proof included. The VTA verifies and holds it exactly as if the document had been delivered to it directly: the same layer-by-layer verification, the same acceptance policy counting the party that delivered the document and never the depositing client, the same one record per originator and notificationId, and the same receipt whatever it did (VTI-NTF-054 – VTI-NTF-056). 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",
+    "document"
+  ],
+  "properties": {
+    "contextId": {
+      "$ref": "#/$defs/ContextId",
+      "description": "The trust context the addressed DID belongs to, in which the VTA holds the notification if it accepts it."
+    },
+    "document": {
+      "$ref": "#/$defs/DepositedDocument"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "DepositedDocument": {
+      "title": "DepositedDocument",
+      "description": "The notifications/notify/0.1 or notifications/relay/0.1 document the client received, kept whole and exactly as received — proof included — never restated, re-serialised from a typed form, or re-signed. Deliberately an opaque object, so that every member its issuer signed survives byte for byte for the VTA, and later the principal's client through vta/notifications/show, to verify. Its `recipient` MUST be a DID the VTA holds keys of in `contextId`.",
+      "type": "object",
+      "minProperties": 1
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Notifications — Deposit — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "notificationId",
+        "revision"
+      ],
+      "description": "Receipt of a deposited document the VTA verified, naming the innermost notification. The same whether the VTA held it, declined it under its acceptance policy, or already held the revision, and never saying which (VTI-NTF-023, VTI-NTF-055).",
+      "properties": {
+        "notificationId": {
+          "$ref": "#/$defs/NotificationId"
+        },
+        "revision": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 1000000,
+          "description": "The revision of the innermost notification, echoed."
+        }
+      }
+    },
+    "NotificationId": {
+      "title": "NotificationId",
+      "description": "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "^[A-Za-z0-9._~:-]+$"
+    },
+    "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 notification is held in: the one the addressed DID 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": {
+    "DepositedDocument": {
+      "title": "DepositedDocument",
+      "description": "The notifications/notify/0.1 or notifications/relay/0.1 document the client received, kept whole and exactly as received — proof included — never restated, re-serialised from a typed form, or re-signed. Deliberately an opaque object, so that every member its issuer signed survives byte for byte for the VTA, and later the principal's client through vta/notifications/show, to verify. Its `recipient` MUST be a DID the VTA holds keys of in `contextId`.",
+      "type": "object",
+      "minProperties": 1
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Notifications — Deposit — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "notificationId",
+        "revision"
+      ],
+      "description": "Receipt of a deposited document the VTA verified, naming the innermost notification. The same whether the VTA held it, declined it under its acceptance policy, or already held the revision, and never saying which (VTI-NTF-023, VTI-NTF-055).",
+      "properties": {
+        "notificationId": {
+          "$ref": "#/$defs/NotificationId"
+        },
+        "revision": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 1000000,
+          "description": "The revision of the innermost notification, echoed."
+        }
+      }
+    },
+    "NotificationId": {
+      "title": "NotificationId",
+      "description": "The originator's identifier for one notification, unique among the notifications that originator issues and the same in every document that carries it — retries, re-issued documents and relayed copies alike. It is the notification's idempotency key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it unguessable and SHOULD NOT make it descriptive: it travels as far as the notification does.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "^[A-Za-z0-9._~:-]+$"
+    },
+    "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 notification is held in: the one the addressed DID 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;