@openvtc/trust-tasks 0.28.13 → 0.28.15

package/src/process-attestation/0.1/payload.ts

@@ -3,7 +3,7 @@
  * Source: specs/process-attestation/0.1/payload.schema.json
  */
 
-import type { Ext } from "../../_shared/components.js";
+import type { DigestMultibase, Ext } from "../../_shared/components.js";
 
 
 /**
@@ -22,6 +22,10 @@ export type ReceiptReference =
       type: "uri";
       uri: string;
       mediaType?: string;
+      /**
+       * Digest of the exact receipt bytes the URI serves. The response's proof covers the URI and not what it serves, so this is what lets a retained response show which receipt it referred to; a Verifier that dereferences the URI compares before relying on the bytes (Verifier rule 6).
+       */
+      digestMultibase?: DigestMultibase;
     }
   | {
       type: "inline";
@@ -102,13 +106,19 @@ export interface Disclosed {
     endedAt?: string;
     checkpointCount?: number;
   };
+  /**
+   * The Holder's own report of its receipt's state. It is not verification: a Verifier relies on its own verification of the receipt (Verifier rules 4 and 7).
+   */
   integrity?: {
     chainValid?: boolean;
     signatureValid?: boolean;
     keyCustody?: "software" | "tpm" | "secureEnclave";
   };
   anchors?: {
-    kind: "rfc3161" | "opentimestamps" | "roughtime";
+    /**
+     * The anchoring mechanism. `rfc3161` is a timestamp-authority response, `opentimestamps` an OpenTimestamps proof, `roughtime` a Roughtime sample, `blockchain` a direct chain anchor. Appended values are additive; a reader passes an unrecognised one through.
+     */
+    kind: "rfc3161" | "opentimestamps" | "roughtime" | "blockchain";
     anchoredAt?: string;
   }[];
 }
@@ -123,7 +133,7 @@ export interface Unavailable {
 }
 
 /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
-export type { Ext };
+export type { DigestMultibase, Ext };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/process-attestation/0.1" as const;
@@ -350,6 +360,10 @@ export const PAYLOAD_SCHEMA = {
             "mediaType": {
               "type": "string",
               "maxLength": 255
+            },
+            "digestMultibase": {
+              "$ref": "#/$defs/DigestMultibase",
+              "description": "Digest of the exact receipt bytes the URI serves. The response's proof covers the URI and not what it serves, so this is what lets a retained response show which receipt it referred to; a Verifier that dereferences the URI compares before relying on the bytes (Verifier rule 6)."
             }
           }
         },
@@ -440,7 +454,8 @@ export const PAYLOAD_SCHEMA = {
                 "secureEnclave"
               ]
             }
-          }
+          },
+          "description": "The Holder's own report of its receipt's state. It is not verification: a Verifier relies on its own verification of the receipt (Verifier rules 4 and 7)."
         },
         "anchors": {
           "type": "array",
@@ -456,8 +471,10 @@ export const PAYLOAD_SCHEMA = {
                 "enum": [
                   "rfc3161",
                   "opentimestamps",
-                  "roughtime"
-                ]
+                  "roughtime",
+                  "blockchain"
+                ],
+                "description": "The anchoring mechanism. `rfc3161` is a timestamp-authority response, `opentimestamps` an OpenTimestamps proof, `roughtime` a Roughtime sample, `blockchain` a direct chain anchor. Appended values are additive; a reader passes an unrecognised one through."
               },
               "anchoredAt": {
                 "type": "string",
@@ -468,6 +485,16 @@ export const PAYLOAD_SCHEMA = {
         }
       }
     },
+    "DigestMultibase": {
+      "title": "DigestMultibase",
+      "description": "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.",
+      "type": "string",
+      "minLength": 16,
+      "pattern": "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$",
+      "examples": [
+        "zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"
+      ]
+    },
     "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.",
@@ -640,6 +667,10 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
             "mediaType": {
               "type": "string",
               "maxLength": 255
+            },
+            "digestMultibase": {
+              "$ref": "#/$defs/DigestMultibase",
+              "description": "Digest of the exact receipt bytes the URI serves. The response's proof covers the URI and not what it serves, so this is what lets a retained response show which receipt it referred to; a Verifier that dereferences the URI compares before relying on the bytes (Verifier rule 6)."
             }
           }
         },
@@ -730,7 +761,8 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
                 "secureEnclave"
               ]
             }
-          }
+          },
+          "description": "The Holder's own report of its receipt's state. It is not verification: a Verifier relies on its own verification of the receipt (Verifier rules 4 and 7)."
         },
         "anchors": {
           "type": "array",
@@ -746,8 +778,10 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
                 "enum": [
                   "rfc3161",
                   "opentimestamps",
-                  "roughtime"
-                ]
+                  "roughtime",
+                  "blockchain"
+                ],
+                "description": "The anchoring mechanism. `rfc3161` is a timestamp-authority response, `opentimestamps` an OpenTimestamps proof, `roughtime` a Roughtime sample, `blockchain` a direct chain anchor. Appended values are additive; a reader passes an unrecognised one through."
               },
               "anchoredAt": {
                 "type": "string",
@@ -758,6 +792,16 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         }
       }
     },
+    "DigestMultibase": {
+      "title": "DigestMultibase",
+      "description": "A cryptographic digest as a multibase-encoded multihash — the encoding the W3C Verifiable Credentials Data Model 2.0 defines for `digestMultibase`, and the one `did:webvh` uses for its SCID and entry hashes.\n\nMultihash carries the hash algorithm in-band, so the value is self-describing and the wire format survives an algorithm change without a schema revision; multibase does the same for the base encoding, so a verifier never infers base58 from base64url by context. A bare hex string or a `sha-256:`-style prefix hard-codes one algorithm into the wire contract and is non-conforming here.\n\nThis definition constrains the *encoding only*. What the digest is computed over is stated by each referencing field, because it differs legitimately: a digest over a JSON document is taken over its RFC 8785 (JCS) canonicalization, while a digest over an opaque artifact is taken over its bytes. A field whose input is a JSON document and which does not name a canonicalization is not reproducible.\n\nRestricted to the two multibase headers W3C Controlled Identifiers 1.0 §2.4 normatively requires — `z` (base58btc) and `u` (base64url-no-pad). CID permits others but states that \"interoperability is not guaranteed between implementations using such values\", and a registry whose purpose is interoperability should not mint digests a conforming verifier may be unable to read. The alphabets are enforced rather than assumed: base58btc excludes 0, O, I and l, and an earlier permissive pattern let three published examples carry digests that were not valid base58 at all. base58btc is RECOMMENDED, for consistency with `did:key` and `did:webvh`.",
+      "type": "string",
+      "minLength": 16,
+      "pattern": "^(z[1-9A-HJ-NP-Za-km-z]+|u[A-Za-z0-9_-]+)$",
+      "examples": [
+        "zQmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR"
+      ]
+    },
     "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.",

package/src/rooms/_shared/0.1/room.ts

@@ -14,4 +14,4 @@ export interface RoomsSharedTypes {
  * The definitions this shared schema publishes, hoisted to one declaration each.
  * See "../../../_shared/components.js".
  */
-export type { AnchorCadence, AuthorityPresentation, CredentialRevocation, DataCommitment, EpochAnchor, EpochFloor, EpochLink, HeadVersion, PermittedUse, ReadVerification, RecordBasis, RecordConfidence, RecordCount, RecordEvidence, RecordEvidenceCredential, RecordEvidenceList, RecordEvidenceRecord, RecordMetadata, RecordMetadataV2, RecordPrune_RoomsV0_1 as RecordPrune, RecordRetention, RecordTrace, RecordValidUntil, RetentionPolicy, RevocationEntry, RevocationHead, RevocationList, RoomProfile, RoomRevocation, SealedRecord, SubjectRevocation, Visibility } from "../../../_shared/components.js";
+export type { AnchorCadence, AuthorityPresentation, CredentialRevocation, DataCommitment, EpochAnchor, EpochFloor, EpochLink, HeadVersion, PermittedUse, ReadVerification, RecordBasis, RecordConfidence, RecordCount, RecordEditedAt, RecordEvidence, RecordEvidenceCredential, RecordEvidenceList, RecordEvidenceRecord, RecordKind, RecordMetadata, RecordMetadataV2, RecordPrune_RoomsV0_1 as RecordPrune, RecordReference, RecordRetention, RecordTrace, RecordValidUntil, RecordWrittenAt, RetentionPolicy, RevocationEntry, RevocationHead, RevocationList, RoomProfile, RoomRevocation, SealedRecord, SubjectRevocation, Visibility } from "../../../_shared/components.js";

package/src/rooms/_shared/0.2/room.ts

@@ -14,4 +14,4 @@ export interface RoomsSharedTypes {
  * The definitions this shared schema publishes, hoisted to one declaration each.
  * See "../../../_shared/components.js".
  */
-export type { AuthorityPresentation, DataCommitment, HeadVersion, ReadVerification, RecordCount, RecordMetadata, RecordMetadataV2, RecordPrune_RoomsV0_2 as RecordPrune, RecordRetention, RetentionPolicy, Visibility } from "../../../_shared/components.js";
+export type { AuthorityPresentation, DataCommitment, HeadVersion, PermittedUse, ReadVerification, RecordBasis, RecordConfidence, RecordCount, RecordEditedAt, RecordEvidence, RecordEvidenceCredential, RecordEvidenceList, RecordEvidenceRecord, RecordKind, RecordMetadata, RecordMetadataV2, RecordMetadataV3, RecordPrune_RoomsV0_2 as RecordPrune, RecordReference, RecordRetention, RecordValidUntil, RecordWrittenAt, RetentionPolicy, RoomProfile, RoomProfileStatement, SealedRecordBody, Visibility } from "../../../_shared/components.js";

package/src/rooms/_shared/0.3/member-profile.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/rooms/_shared/0.3/member-profile.schema.json
+ */
+
+/**
+ * How a member tells the other members of a room what to call them: a record of kind `memberProfile`, written by the member into the room like any other record, whose `title` is the name. A reader shows that name wherever it shows the member's DID — beside a message, on a quoted record, in the list of who reacted. It adds no task and changes no existing schema: the record is an ordinary `SealedRecordBody` on the sealed tiers and ordinary `cleartext` of `rooms/records/put` on an `open` room, using only members both already have, so a key holder that seals at `rooms/keys/seal/0.3` seals it unchanged and a host stores it like any other record. New in 0.3 of this family's shared types; `room.schema.json` stays at 0.2, and `blobs.schema.json` and `personal-label.schema.json` at 0.1. Plain text throughout: a reader renders the name as text, never as markup, and an agent reading it MUST NOT treat it as instructions. Not itself a Trust Task specification (the `_shared` folder is skipped by the registry build and the codegen).
+ */
+export interface RoomsAMemberSNameInARoom {
+  [k: string]: unknown | undefined;
+}

package/src/rooms/changed/0.1/payload.ts

@@ -0,0 +1,115 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/rooms/changed/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../_shared/components.js";
+
+
+/**
+ * One-way signal from a room's host to the address of an armed `rooms/watch`: the room has moved past the version the member had read to. The room and its latest version, and nothing about what changed. There is no #response form. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface RoomsChangedPayload {
+  /**
+   * The room the watch was armed on, exactly as the member named it.
+   */
+  roomId: string;
+  /**
+   * The highest version the room had taken when the host sent the signal: the version a `rooms/records/list` with the member's watermark as `sinceVersion` would at least reach. A hint for the reader, who learns what changed only by listing.
+   */
+  latestVersion: number;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1. A host MUST NOT put anything here about what changed.
+   */
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/rooms/changed/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 = RoomsChangedPayload;
+
+/**
+ * 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/rooms/changed/0.1",
+  "title": "Rooms — Changed — payload",
+  "description": "One-way signal from a room's host to the address of an armed `rooms/watch`: the room has moved past the version the member had read to. The room and its latest version, and nothing about what changed. There is no #response form. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "roomId",
+    "latestVersion"
+  ],
+  "properties": {
+    "roomId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The room the watch was armed on, exactly as the member named it."
+    },
+    "latestVersion": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "The highest version the room had taken when the host sent the signal: the version a `rooms/records/list` with the member's watermark as `sinceVersion` would at least reach. A hint for the reader, who learns what changed only by listing."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1. A host MUST NOT put anything here about what changed."
+    }
+  },
+  "$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-]+)+$"
+      }
+    }
+  }
+} 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: false,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;

package/src/rooms/keys/act/0.1/payload.ts

@@ -9,7 +9,7 @@ import type { Ext } from "../../../../_shared/components.js";
 /**
  * A member's own client asks the member's key holder to complete one host-bound room request as the member: the member's own authority narrowed to the one action the request's type needs, the member as issuer, and the member's signature. The outer document members are owned by the framework — SPEC §6.3.
  *
- * @deprecated superseded by rooms/keys/act/0.10
+ * @deprecated superseded by rooms/keys/act/0.12
  */
 export interface RoomsKeysActPayload {
   document: UnsignedRoomRequest;
@@ -50,7 +50,7 @@ export interface UnsignedRoomRequest {
 /**
  * Success response to rooms/keys/act. Type https://trusttasks.org/spec/rooms/keys/act/0.1#response. The request, completed as the member, for the caller to send to its recipient unaltered.
  *
- * @deprecated superseded by rooms/keys/act/0.10
+ * @deprecated superseded by rooms/keys/act/0.12
  */
 export interface RoomsKeysActResponsePayload {
   /**
@@ -88,12 +88,12 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = "superseded by rooms/keys/act/0.10";
+export const DEPRECATION: string | null = "superseded by rooms/keys/act/0.12";
 
 /**
  * Stable alias for this specification's request payload shape.
  *
- * @deprecated superseded by rooms/keys/act/0.10
+ * @deprecated superseded by rooms/keys/act/0.12
  */
 export type Payload = RoomsKeysActPayload;
 
@@ -103,7 +103,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/keys/act/0.1
 /**
  * Stable alias for this specification's success-response payload shape.
  *
- * @deprecated superseded by rooms/keys/act/0.10
+ * @deprecated superseded by rooms/keys/act/0.12
  */
 export type Response = RoomsKeysActResponsePayload;
 

package/src/rooms/keys/act/0.10/payload.ts

@@ -8,6 +8,8 @@ import type { Ext } from "../../../../_shared/components.js";
 
 /**
  * A member's own client asks the member's key holder to complete one host-bound room request — or one of the two requests by which a member takes up a community's offer of admission to a room — as the member: the member's own authority narrowed to the one action the request's type needs, the member as issuer, and the member's signature. The outer document members are owned by the framework — SPEC §6.3.
+ *
+ * @deprecated superseded by rooms/keys/act/0.12
  */
 export interface RoomsKeysActPayload {
   document: UnsignedRoomRequest;
@@ -47,6 +49,8 @@ export interface UnsignedRoomRequest {
 }
 /**
  * Success response to rooms/keys/act. Type https://trusttasks.org/spec/rooms/keys/act/0.10#response. The request, completed as the member, for the caller to send to its recipient unaltered.
+ *
+ * @deprecated superseded by rooms/keys/act/0.12
  */
 export interface RoomsKeysActResponsePayload {
   /**
@@ -84,15 +88,23 @@ export const EXTENDS: string | null = "0.9";
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = null;
+export const DEPRECATION: string | null = "superseded by rooms/keys/act/0.12";
 
-/** Stable alias for this specification's request payload shape. */
+/**
+ * Stable alias for this specification's request payload shape.
+ *
+ * @deprecated superseded by rooms/keys/act/0.12
+ */
 export type Payload = RoomsKeysActPayload;
 
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/keys/act/0.10#response" as const;
 
-/** Stable alias for this specification's success-response payload shape. */
+/**
+ * Stable alias for this specification's success-response payload shape.
+ *
+ * @deprecated superseded by rooms/keys/act/0.12
+ */
 export type Response = RoomsKeysActResponsePayload;
 
 /**