@openvtc/trust-tasks 0.28.8 → 0.28.9

package/src/vta/notifications/_shared/0.1/held-notification.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/notifications/_shared/0.1/held-notification.schema.json
+ */
+
+/**
+ * Shared shapes for the notifications a VTA holds for its principal: each a notifications/notify notification the VTA accepted for a DID it holds keys of, directly or by notifications/relay, filed in the trust context that DID belongs to (VTI-NTF-050). A VTA holds at most one record per originator and notificationId, replaced by a higher revision (VTI-NTF-022). Its principal's client lists them with vta/notifications/list, reads one whole with vta/notifications/show, and dismisses one with vta/notifications/dismiss. Holding a notification tells nobody anything: the VTA sends nothing to the originator, a relayer or the thing's holder because of it, and opens the thing only at the principal's choice (VTI-NTF-053).
+ */
+export interface VTANotificationsSharedDefinitions {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../../_shared/components.js".
+ */
+export type { ContextId, HeldNotification, RecordId, State } from "../../../../_shared/components.js";

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

@@ -0,0 +1,214 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/notifications/dismiss/0.1/payload.schema.json
+ */
+
+import type { ContextId, Ext, RecordId } from "../../../../_shared/components.js";
+
+
+/**
+ * A client with standing in a trust context dismisses one notification its VTA holds there, so that it leaves the principal's default list. Dismissal is the principal's alone and changes nothing outside the VTA: the originator, any relayer and the thing's holder are told nothing, and the notification stays readable, and listable when asked for, until it lapses (VTI-NTF-052). The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTANotificationsDismissPayload {
+  contextId: ContextId;
+  recordId: RecordId;
+  ext?: Ext;
+}
+export interface VTANotificationsDismissResponsePayload {
+  recordId: RecordId;
+  /**
+   * Whether this request dismissed it: false when it was already dismissed.
+   */
+  changed: boolean;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { ContextId, Ext, RecordId };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/notifications/dismiss/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 = VTANotificationsDismissPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/notifications/dismiss/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTANotificationsDismissResponsePayload;
+
+/**
+ * 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/dismiss/0.1",
+  "title": "VTA Notifications — Dismiss — payload",
+  "description": "A client with standing in a trust context dismisses one notification its VTA holds there, so that it leaves the principal's default list. Dismissal is the principal's alone and changes nothing outside the VTA: the originator, any relayer and the thing's holder are told nothing, and the notification stays readable, and listable when asked for, until it lapses (VTI-NTF-052). 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",
+    "recordId"
+  ],
+  "properties": {
+    "contextId": {
+      "$ref": "#/$defs/ContextId"
+    },
+    "recordId": {
+      "$ref": "#/$defs/RecordId"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Notifications — Dismiss — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "recordId",
+        "changed"
+      ],
+      "properties": {
+        "recordId": {
+          "$ref": "#/$defs/RecordId"
+        },
+        "changed": {
+          "type": "boolean",
+          "description": "Whether this request dismissed it: false when it was already dismissed."
+        }
+      }
+    },
+    "RecordId": {
+      "title": "RecordId",
+      "description": "The VTA's own identifier for one held notification, stable across the revisions that replace it. Opaque and compared for equality only; unguessable, because a show of a record in a context the caller may not read is refused and an enumerable identifier would turn the refusal into an oracle.",
+      "type": "string",
+      "minLength": 16,
+      "maxLength": 128,
+      "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": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Notifications — Dismiss — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "recordId",
+        "changed"
+      ],
+      "properties": {
+        "recordId": {
+          "$ref": "#/$defs/RecordId"
+        },
+        "changed": {
+          "type": "boolean",
+          "description": "Whether this request dismissed it: false when it was already dismissed."
+        }
+      }
+    },
+    "RecordId": {
+      "title": "RecordId",
+      "description": "The VTA's own identifier for one held notification, stable across the revisions that replace it. Opaque and compared for equality only; unguessable, because a show of a record in a context the caller may not read is refused and an enumerable identifier would turn the refusal into an oracle.",
+      "type": "string",
+      "minLength": 16,
+      "maxLength": 128,
+      "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;