@openvtc/trust-tasks 0.26.2 → 0.26.4

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

@@ -0,0 +1,380 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/rooms/keys/act/0.1/payload.schema.json
+ */
+
+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.
+ */
+export interface RoomsKeysActPayload {
+  document: UnsignedRoomRequest;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * The room request to complete, as the client will send it, minus its presentation and its proof.
+ */
+export interface UnsignedRoomRequest {
+  /**
+   * The request's identifier, set by the client. The host keys duplicate-execution protection on it.
+   */
+  id: string;
+  /**
+   * The room request's Type URI. Only the types in this task's table are completed; any other is `typeNotActable`.
+   */
+  type: string;
+  /**
+   * The member to act as. Optional where the caller may act as exactly one member of the room; REQUIRED where it may act as more. Never the client's own identifier.
+   */
+  issuer?: string;
+  /**
+   * The room's host, which the completed document is for. Covered by the member's proof.
+   */
+  recipient: string;
+  issuedAt: string;
+  expiresAt?: string;
+  threadId?: string;
+  /**
+   * The request's payload, as the named type's schema defines it but without `presentation`: the recipient inserts the member's own, narrowed to the table's action, and refuses a payload that already carries one.
+   */
+  payload: {};
+  ext?: Ext;
+}
+/**
+ * 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.
+ */
+export interface RoomsKeysActResponsePayload {
+  /**
+   * The member the recipient signed as: the completed document's `issuer`.
+   */
+  principal: string;
+  /**
+   * The supplied document with `issuer` set to the member, `payload.presentation` inserted where the type takes one, and the member's Data Integrity `proof` (`proofPurpose: authentication`). Every other member is unchanged.
+   */
+  document: {};
+  /**
+   * When the inserted presentation's leaf lapses. Absent when the type takes no presentation.
+   */
+  expiresAt?: string;
+  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/keys/act/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+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.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RoomsKeysActResponsePayload;
+
+/**
+ * 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/act/0.1",
+  "title": "Rooms Keys Act — payload",
+  "description": "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.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "document"
+  ],
+  "properties": {
+    "document": {
+      "$ref": "#/$defs/UnsignedRoomRequest",
+      "description": "The room request to complete, as the client will send it, minus its presentation and its proof."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "UnsignedRoomRequest": {
+      "$anchor": "unsigned-room-request",
+      "title": "Unsigned room request",
+      "description": "A Trust Task document of a type in the rooms/keys/act table, built by the member's client: no proof, and no presentation in its payload. The recipient validates the payload against the named type's own schema; this one fixes only the envelope.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "type",
+        "recipient",
+        "issuedAt",
+        "payload"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "The request's identifier, set by the client. The host keys duplicate-execution protection on it."
+        },
+        "type": {
+          "type": "string",
+          "pattern": "^https://trusttasks\\.org/spec/rooms/",
+          "maxLength": 2048,
+          "description": "The room request's Type URI. Only the types in this task's table are completed; any other is `typeNotActable`."
+        },
+        "issuer": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The member to act as. Optional where the caller may act as exactly one member of the room; REQUIRED where it may act as more. Never the client's own identifier."
+        },
+        "recipient": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The room's host, which the completed document is for. Covered by the member's proof."
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "threadId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
+        },
+        "payload": {
+          "type": "object",
+          "description": "The request's payload, as the named type's schema defines it but without `presentation`: the recipient inserts the member's own, narrowed to the table's action, and refuses a payload that already carries one."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      },
+      "not": {
+        "required": [
+          "proof"
+        ]
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "Rooms Keys Act — response payload",
+      "description": "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.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "principal",
+        "document"
+      ],
+      "properties": {
+        "principal": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The member the recipient signed as: the completed document's `issuer`."
+        },
+        "document": {
+          "type": "object",
+          "required": [
+            "id",
+            "type",
+            "issuer",
+            "recipient",
+            "issuedAt",
+            "payload",
+            "proof"
+          ],
+          "description": "The supplied document with `issuer` set to the member, `payload.presentation` inserted where the type takes one, and the member's Data Integrity `proof` (`proofPurpose: authentication`). Every other member is unchanged."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the inserted presentation's leaf lapses. Absent when the type takes no presentation."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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": {
+    "UnsignedRoomRequest": {
+      "$anchor": "unsigned-room-request",
+      "title": "Unsigned room request",
+      "description": "A Trust Task document of a type in the rooms/keys/act table, built by the member's client: no proof, and no presentation in its payload. The recipient validates the payload against the named type's own schema; this one fixes only the envelope.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "type",
+        "recipient",
+        "issuedAt",
+        "payload"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "The request's identifier, set by the client. The host keys duplicate-execution protection on it."
+        },
+        "type": {
+          "type": "string",
+          "pattern": "^https://trusttasks\\.org/spec/rooms/",
+          "maxLength": 2048,
+          "description": "The room request's Type URI. Only the types in this task's table are completed; any other is `typeNotActable`."
+        },
+        "issuer": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The member to act as. Optional where the caller may act as exactly one member of the room; REQUIRED where it may act as more. Never the client's own identifier."
+        },
+        "recipient": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The room's host, which the completed document is for. Covered by the member's proof."
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "threadId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
+        },
+        "payload": {
+          "type": "object",
+          "description": "The request's payload, as the named type's schema defines it but without `presentation`: the recipient inserts the member's own, narrowed to the table's action, and refuses a payload that already carries one."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      },
+      "not": {
+        "required": [
+          "proof"
+        ]
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "Rooms Keys Act — response payload",
+      "description": "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.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "principal",
+        "document"
+      ],
+      "properties": {
+        "principal": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The member the recipient signed as: the completed document's `issuer`."
+        },
+        "document": {
+          "type": "object",
+          "required": [
+            "id",
+            "type",
+            "issuer",
+            "recipient",
+            "issuedAt",
+            "payload",
+            "proof"
+          ],
+          "description": "The supplied document with `issuer` set to the member, `payload.presentation` inserted where the type takes one, and the member's Data Integrity `proof` (`proofPurpose: authentication`). Every other member is unchanged."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the inserted presentation's leaf lapses. Absent when the type takes no presentation."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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/seal/0.2/payload.ts

@@ -0,0 +1,256 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/rooms/keys/seal/0.2/payload.schema.json
+ */
+
+import type { Ext, SealedRecord } from "../../../../_shared/components.js";
+
+
+export interface RoomsKeysSealPayload {
+  /**
+   * The room to seal for. The recipient MUST hold group state for it.
+   */
+  roomId: string;
+  /**
+   * The record key this will be stored under. Bound into the associated data, so a record sealed for one key does not open under another. On a sealed tier keys MUST be opaque — a descriptive key defeats the encryption beside it, and structured naming belongs inside the sealed body.
+   */
+  key: string;
+  /**
+   * The version the writer INTENDS the record to take, bound into the associated data before the host assigns it. A caller that lets the host assign a different one will find the record does not open, which is the correct failure: accepting whatever came back would mean the binding commits to nothing. The shape that works is a create-only write (`expectedVersion: 0`) or a read of the current version before a rewrite.
+   */
+  version: number;
+  /**
+   * The record body to seal, base64url: a SealedRecordBody. Without `signAsPrincipal`, already signed by its author. With it, the same object without `proof`, which the recipient signs as its `author` before sealing. Sealed whole rather than field by field: splitting it would let a host learn the shape of the material from ciphertext lengths.
+   */
+  plaintext: string;
+  /**
+   * True asks the recipient to sign the body as its `author` — a member of this room the caller acts as — before sealing it. Only the principal's own client may set it; an agent under an attenuated chain signs its own body and never sets it. Absent means false: the recipient seals exactly the bytes it was given.
+   */
+  signAsPrincipal?: boolean;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1. MUST NOT carry record content.
+   */
+  ext?: Ext;
+}
+/**
+ * Success response to rooms/keys/seal. Type https://trusttasks.org/spec/rooms/keys/seal/0.2#response. The sealed record, ready to hand to a host with rooms/records/put.
+ */
+export interface RoomsKeysSealResponsePayload {
+  sealed: SealedRecord;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, SealedRecord };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/rooms/keys/seal/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = RoomsKeysSealPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/keys/seal/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RoomsKeysSealResponsePayload;
+
+/**
+ * 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/seal/0.2",
+  "title": "Rooms Keys Seal — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "roomId",
+    "key",
+    "version",
+    "plaintext"
+  ],
+  "properties": {
+    "roomId": {
+      "type": "string",
+      "description": "The room to seal for. The recipient MUST hold group state for it."
+    },
+    "key": {
+      "type": "string",
+      "maxLength": 512,
+      "description": "The record key this will be stored under. Bound into the associated data, so a record sealed for one key does not open under another. On a sealed tier keys MUST be opaque — a descriptive key defeats the encryption beside it, and structured naming belongs inside the sealed body."
+    },
+    "version": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "The version the writer INTENDS the record to take, bound into the associated data before the host assigns it. A caller that lets the host assign a different one will find the record does not open, which is the correct failure: accepting whatever came back would mean the binding commits to nothing. The shape that works is a create-only write (`expectedVersion: 0`) or a read of the current version before a rewrite."
+    },
+    "plaintext": {
+      "type": "string",
+      "description": "The record body to seal, base64url: a SealedRecordBody. Without `signAsPrincipal`, already signed by its author. With it, the same object without `proof`, which the recipient signs as its `author` before sealing. Sealed whole rather than field by field: splitting it would let a host learn the shape of the material from ciphertext lengths.",
+      "pattern": "^[A-Za-z0-9_-]+$",
+      "minLength": 1
+    },
+    "signAsPrincipal": {
+      "type": "boolean",
+      "description": "True asks the recipient to sign the body as its `author` — a member of this room the caller acts as — before sealing it. Only the principal's own client may set it; an agent under an attenuated chain signs its own body and never sets it. Absent means false: the recipient seals exactly the bytes it was given."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1. MUST NOT carry record content."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Rooms Keys Seal — response payload",
+      "description": "Success response to rooms/keys/seal. Type https://trusttasks.org/spec/rooms/keys/seal/0.2#response. The sealed record, ready to hand to a host with rooms/records/put.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sealed"
+      ],
+      "properties": {
+        "sealed": {
+          "$ref": "#/$defs/SealedRecord"
+        },
+        "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-]+)+$"
+      }
+    },
+    "SealedRecord": {
+      "title": "SealedRecord",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ciphertext",
+        "nonce",
+        "epoch"
+      ],
+      "description": "A record as a host stores it on an `attributed` or `private` room. Title, description, body, author and tags are sealed together in one blob rather than separately: splitting them would let a host learn the shape of the material from ciphertext lengths, for no benefit, since a reader decrypts the whole record either way.",
+      "properties": {
+        "ciphertext": {
+          "type": "string",
+          "description": "The sealed record, base64url. Bound by AEAD associated data to `roomId`, `key`, `version` and `epoch`, so a host that relocates it to another key, version, epoch or room produces a mismatch and the open fails. The record cannot be moved undetected even though the host holds every byte of it."
+        },
+        "nonce": {
+          "type": "string",
+          "description": "AEAD nonce, base64url."
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The key epoch this record was sealed under. Cleartext because the host must serve the right ciphertext, and bound into the associated data so that relabelling it fails authentication rather than causing a reader to try the wrong key."
+        }
+      }
+    }
+  }
+} 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 Seal — response payload",
+      "description": "Success response to rooms/keys/seal. Type https://trusttasks.org/spec/rooms/keys/seal/0.2#response. The sealed record, ready to hand to a host with rooms/records/put.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sealed"
+      ],
+      "properties": {
+        "sealed": {
+          "$ref": "#/$defs/SealedRecord"
+        },
+        "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-]+)+$"
+      }
+    },
+    "SealedRecord": {
+      "title": "SealedRecord",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ciphertext",
+        "nonce",
+        "epoch"
+      ],
+      "description": "A record as a host stores it on an `attributed` or `private` room. Title, description, body, author and tags are sealed together in one blob rather than separately: splitting them would let a host learn the shape of the material from ciphertext lengths, for no benefit, since a reader decrypts the whole record either way.",
+      "properties": {
+        "ciphertext": {
+          "type": "string",
+          "description": "The sealed record, base64url. Bound by AEAD associated data to `roomId`, `key`, `version` and `epoch`, so a host that relocates it to another key, version, epoch or room produces a mismatch and the open fails. The record cannot be moved undetected even though the host holds every byte of it."
+        },
+        "nonce": {
+          "type": "string",
+          "description": "AEAD nonce, base64url."
+        },
+        "epoch": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The key epoch this record was sealed under. Cleartext because the host must serve the right ciphertext, and bound into the associated data so that relabelling it fails authentication rather than causing a reader to try the wrong key."
+        }
+      }
+    }
+  }
+} 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;