@openvtc/trust-tasks 0.28.25 → 0.28.26

package/src/rooms/keys/open/0.3/payload.ts

@@ -0,0 +1,299 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/rooms/keys/open/0.3/payload.schema.json
+ */
+
+import type { Ext, Purpose_AclV0_3 as Purpose, Purpose_AclV0_31, Purpose_AclV0_32, RecordPurpose } from "../../../../_shared/components.js";
+
+
+/**
+ * An agent asks the party holding its principal's room keys to open one sealed record. The key never crosses to the agent: this is a decryption oracle, not a key-release call.
+ */
+export interface RoomsKeysOpenPayload {
+  /**
+   * The room the record belongs to. Part of the record's associated data, so a caller naming the wrong room gets an authentication failure rather than someone else's plaintext.
+   */
+  roomId: string;
+  /**
+   * The record's key within the room.
+   */
+  key: string;
+  /**
+   * The record's version. Bound into the associated data, so a record served at a different version does not open.
+   */
+  version: number;
+  /**
+   * The sealed record exactly as the host returned it.
+   */
+  sealed: {
+    /**
+     * base64url.
+     */
+    ciphertext: string;
+    /**
+     * base64url.
+     */
+    nonce: string;
+    /**
+     * The epoch it was sealed under. The oracle refuses an epoch it holds no key for rather than guessing.
+     */
+    epoch: number;
+  };
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+  /**
+   * OPTIONAL. The one purpose the caller will use the content this request discloses for (VTI-ACL-103), as `RecordPurpose` defines it. A purpose not granted is refused with `purposeNotGranted`. May be omitted where exactly one purpose is granted, or `any`.
+   */
+  purpose?: RecordPurpose;
+}
+/**
+ * Success response to rooms/keys/open. Type https://trusttasks.org/spec/rooms/keys/open/0.2#response.
+ */
+export interface RoomsKeysOpenResponsePayload {
+  /**
+   * The opened record, base64url. The only thing that crosses back — never the key.
+   */
+  plaintext: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, Purpose, Purpose_AclV0_31, Purpose_AclV0_32, RecordPurpose };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/rooms/keys/open/0.3" 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 = "0.2";
+
+/**
+ * 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 = RoomsKeysOpenPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/keys/open/0.3#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RoomsKeysOpenResponsePayload;
+
+/**
+ * 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/keys/open/0.3",
+  "title": "Rooms Keys Open — payload",
+  "description": "An agent asks the party holding its principal's room keys to open one sealed record. The key never crosses to the agent: this is a decryption oracle, not a key-release call.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "roomId",
+    "key",
+    "version",
+    "sealed"
+  ],
+  "properties": {
+    "roomId": {
+      "type": "string",
+      "description": "The room the record belongs to. Part of the record's associated data, so a caller naming the wrong room gets an authentication failure rather than someone else's plaintext."
+    },
+    "key": {
+      "type": "string",
+      "maxLength": 512,
+      "description": "The record's key within the room."
+    },
+    "version": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "The record's version. Bound into the associated data, so a record served at a different version does not open."
+    },
+    "sealed": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ciphertext",
+        "nonce",
+        "epoch"
+      ],
+      "description": "The sealed record exactly as the host returned it.",
+      "properties": {
+        "ciphertext": {
+          "type": "string",
+          "description": "base64url."
+        },
+        "nonce": {
+          "type": "string",
+          "description": "base64url."
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The epoch it was sealed under. The oracle refuses an epoch it holds no key for rather than guessing."
+        }
+      }
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    },
+    "purpose": {
+      "$ref": "#/$defs/RecordPurpose",
+      "description": "OPTIONAL. The one purpose the caller will use the content this request discloses for (VTI-ACL-103), as `RecordPurpose` defines it. A purpose not granted is refused with `purposeNotGranted`. May be omitted where exactly one purpose is granted, or `any`."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Rooms Keys Open — response payload",
+      "description": "Success response to rooms/keys/open. Type https://trusttasks.org/spec/rooms/keys/open/0.2#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "plaintext"
+      ],
+      "properties": {
+        "plaintext": {
+          "type": "string",
+          "description": "The opened record, base64url. The only thing that crosses back — never the key."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "RecordPurpose": {
+      "title": "RecordPurpose",
+      "description": "The one purpose for which a caller will use room content a request discloses (VTI-ACL-103): a name registered in the VTI specification's purpose registry (`personalisation`, `taskExecution`, `analytics`, `modelTraining`) or an absolute IRI. Granted only as the caller's authority grants it — `any` grants every purpose but `modelTraining` — refused otherwise (`purposeNotGranted`), and recorded with the read. Distinct from `PermittedUse`, which is what a record's author permits and is a statement, not a grant.",
+      "$ref": "#/$defs/Purpose"
+    },
+    "Purpose": {
+      "title": "Purpose",
+      "description": "What content is used for: a lowerCamelCase name registered in the VTI specification's purpose registry (Appendix H) — `personalisation`, `taskExecution`, `analytics`, `modelTraining` at the time of writing — or an absolute IRI naming a purpose defined elsewhere, such as a purpose of the W3C Data Privacy Vocabulary (`https://w3id.org/dpv#ServicePersonalisation`). Compared by exact string equality: a consumer MUST NOT treat a purpose it does not recognise as equal to any other, and grants only a request naming exactly a listed purpose (VTI-ACL-109). A registered name is never an IRI, because it contains no `:`.",
+      "type": "string",
+      "maxLength": 2048,
+      "anyOf": [
+        {
+          "pattern": "^[a-z][a-zA-Z0-9]{0,63}$"
+        },
+        {
+          "pattern": "^[a-zA-Z][a-zA-Z0-9+.-]*:[^\\s]+$"
+        }
+      ]
+    }
+  }
+} 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": "Rooms Keys Open — response payload",
+      "description": "Success response to rooms/keys/open. Type https://trusttasks.org/spec/rooms/keys/open/0.2#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "plaintext"
+      ],
+      "properties": {
+        "plaintext": {
+          "type": "string",
+          "description": "The opened record, base64url. The only thing that crosses back — never the key."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "RecordPurpose": {
+      "title": "RecordPurpose",
+      "description": "The one purpose for which a caller will use room content a request discloses (VTI-ACL-103): a name registered in the VTI specification's purpose registry (`personalisation`, `taskExecution`, `analytics`, `modelTraining`) or an absolute IRI. Granted only as the caller's authority grants it — `any` grants every purpose but `modelTraining` — refused otherwise (`purposeNotGranted`), and recorded with the read. Distinct from `PermittedUse`, which is what a record's author permits and is a statement, not a grant.",
+      "$ref": "#/$defs/Purpose"
+    },
+    "Purpose": {
+      "title": "Purpose",
+      "description": "What content is used for: a lowerCamelCase name registered in the VTI specification's purpose registry (Appendix H) — `personalisation`, `taskExecution`, `analytics`, `modelTraining` at the time of writing — or an absolute IRI naming a purpose defined elsewhere, such as a purpose of the W3C Data Privacy Vocabulary (`https://w3id.org/dpv#ServicePersonalisation`). Compared by exact string equality: a consumer MUST NOT treat a purpose it does not recognise as equal to any other, and grants only a request naming exactly a listed purpose (VTI-ACL-109). A registered name is never an IRI, because it contains no `:`.",
+      "type": "string",
+      "maxLength": 2048,
+      "anyOf": [
+        {
+          "pattern": "^[a-z][a-zA-Z0-9]{0,63}$"
+        },
+        {
+          "pattern": "^[a-zA-Z][a-zA-Z0-9+.-]*:[^\\s]+$"
+        }
+      ]
+    }
+  }
+} 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: true,
+  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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

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

@@ -9,7 +9,7 @@ import type { DataCommitment, DigestMultibase, Ext, HeadVersion, ReadVerificatio
 /**
  * TODO: what the request payload of rooms/keys/read carries. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
  *
- * @deprecated superseded by rooms/keys/read/0.2
+ * @deprecated superseded by rooms/keys/read/0.3
  */
 export interface RoomsKeysReadPayload {
   /**
@@ -32,7 +32,7 @@ export interface RoomsKeysReadPayload {
 /**
  * Success response to rooms/keys/read. Type https://trusttasks.org/spec/rooms/keys/read/0.1#response.
  *
- * @deprecated superseded by rooms/keys/read/0.2
+ * @deprecated superseded by rooms/keys/read/0.3
  */
 export interface RoomsKeysReadResponsePayload {
   roomId: string;
@@ -87,12 +87,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/read/0.2";
+export const DEPRECATION: string | null = "superseded by rooms/keys/read/0.3";
 
 /**
  * Stable alias for this specification's request payload shape.
  *
- * @deprecated superseded by rooms/keys/read/0.2
+ * @deprecated superseded by rooms/keys/read/0.3
  */
 export type Payload = RoomsKeysReadPayload;
 
@@ -102,7 +102,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/keys/read/0.
 /**
  * Stable alias for this specification's success-response payload shape.
  *
- * @deprecated superseded by rooms/keys/read/0.2
+ * @deprecated superseded by rooms/keys/read/0.3
  */
 export type Response = RoomsKeysReadResponsePayload;
 

package/src/rooms/keys/read/0.2/payload.ts

@@ -8,6 +8,8 @@ import type { DataCommitment, DigestMultibase, Ext, HeadVersion, ReadVerificatio
 
 /**
  * What a member asks of their own key holder: one record of a room (`key`), or up to 32 (`keys`), read from the named host, checked and opened. Exactly one of `key` and `keys` is present. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ *
+ * @deprecated superseded by rooms/keys/read/0.3
  */
 export interface RoomsKeysReadPayload {
   /**
@@ -36,6 +38,8 @@ export interface RoomsKeysReadPayload {
 }
 /**
  * Success response to rooms/keys/read. Type https://trusttasks.org/spec/rooms/keys/read/0.2#response. For a request naming `key`, the record and its verdict, as in 0.1, with `createdAt` and `createdBy`. For a request naming `keys`, `results`: one entry per key, each its own success or error.
+ *
+ * @deprecated superseded by rooms/keys/read/0.3
  */
 export interface RoomsKeysReadResponsePayload {
   roomId: string;
@@ -173,15 +177,23 @@ export const EXTENDS: string | null = null;
  * 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/read/0.3";
 
-/** Stable alias for this specification's request payload shape. */
+/**
+ * Stable alias for this specification's request payload shape.
+ *
+ * @deprecated superseded by rooms/keys/read/0.3
+ */
 export type Payload = RoomsKeysReadPayload;
 
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/keys/read/0.2#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/read/0.3
+ */
 export type Response = RoomsKeysReadResponsePayload;
 
 /**