@openvtc/trust-tasks 0.28.25 → 0.28.26

package/src/rooms/owner/issue-authority/0.2/payload.ts

@@ -6,6 +6,7 @@
 import type { Ext } from "../../../../_shared/components.js";
 
 
+/** @deprecated superseded by rooms/owner/issue-authority/0.3 */
 export interface RoomsOwnerIssueAuthorityPayload {
   /**
    * The room whose identity issues this credential. The recipient MUST hold a signing key for it — it is signing AS the room, not as itself.
@@ -36,6 +37,8 @@ export interface RoomsOwnerIssueAuthorityPayload {
 }
 /**
  * Success response to rooms/owner/issue-authority. Type https://trusttasks.org/spec/rooms/owner/issue-authority/0.2#response. The signed VAC, a chain root at the room's scope.
+ *
+ * @deprecated superseded by rooms/owner/issue-authority/0.3
  */
 export interface RoomsOwnerIssueAuthorityResponsePayload {
   /**
@@ -69,15 +72,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/owner/issue-authority/0.3";
 
-/** Stable alias for this specification's request payload shape. */
+/**
+ * Stable alias for this specification's request payload shape.
+ *
+ * @deprecated superseded by rooms/owner/issue-authority/0.3
+ */
 export type Payload = RoomsOwnerIssueAuthorityPayload;
 
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/owner/issue-authority/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/owner/issue-authority/0.3
+ */
 export type Response = RoomsOwnerIssueAuthorityResponsePayload;
 
 /**

package/src/rooms/owner/issue-authority/0.3/payload.ts

@@ -0,0 +1,388 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/rooms/owner/issue-authority/0.3/payload.schema.json
+ */
+
+import type { Ext, Purpose_AclV0_3 as Purpose, Purpose_AclV0_31, Purpose_AclV0_32, PurposeScope, PurposeScopeAny, PurposeScopeListed } from "../../../../_shared/components.js";
+
+
+export interface RoomsOwnerIssueAuthorityPayload {
+  /**
+   * The room whose identity issues this credential. The recipient MUST hold a signing key for it — it is signing AS the room, not as itself.
+   */
+  roomId: string;
+  /**
+   * Which held key signs. Named explicitly rather than looked up from `roomId`, because nothing maps a DID to a key it was minted with and inventing that mapping would add a lifecycle to get wrong. A key that is not the room's produces a credential that fails to verify against the room's DID document — loud, and at the first use rather than later.
+   */
+  signingKeyId: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+  /**
+   * The party this grants to. A chain ROOT: the room is the governing party, so this is the grant everything else descends from. A holder narrows their own grant with attenuation instead, which needs no issuer.
+   */
+  subject: string;
+  /**
+   * What the subject may do. MUST NOT be empty — an empty list confers nothing rather than everything, and a schema that allowed it would make the more dangerous reading available to a careless consumer. `curate` is not implied by `write`: pinning, deprecating and retracting are judgements over shared knowledge, not writes.
+   *
+   * @minItems 1
+   */
+  actions: ["read" | "write" | "curate" | "admin", ...("read" | "write" | "curate" | "admin")[]];
+  /**
+   * When the grant lapses. REQUIRED, and not merely recommended: nothing about the subject's current standing is consulted when an authority credential is verified, so a grant that never expires is authority nobody can withdraw by waiting. A verifier refuses a chain link carrying none, so a grant minted without one could not have been used. Changing what a party may do reissues this one small credential and leaves the membership edge alone, which is why the two are separate credentials.
+   */
+  validUntil: string;
+  /**
+   * OPTIONAL. What the subject may use the content it reads under this grant for (VTI-ACL-110): `{"scope": "any"}` or a non-empty list. Stated in the credential exactly as given; absent, the credential states none, which grants `any` — never `modelTraining`, which a grant must name.
+   */
+  purposes?: PurposeScope;
+}
+/**
+ * Success response to rooms/owner/issue-authority. Type https://trusttasks.org/spec/rooms/owner/issue-authority/0.2#response. The signed VAC, a chain root at the room's scope.
+ */
+export interface RoomsOwnerIssueAuthorityResponsePayload {
+  /**
+   * The signed Verifiable Authority Credential, serialised.
+   */
+  credential: string;
+  /**
+   * Its `id`.
+   */
+  credentialId: 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, PurposeScope, PurposeScopeAny, PurposeScopeListed };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/rooms/owner/issue-authority/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 = RoomsOwnerIssueAuthorityPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/owner/issue-authority/0.3#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RoomsOwnerIssueAuthorityResponsePayload;
+
+/**
+ * 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/owner/issue-authority/0.3",
+  "title": "Rooms Owner Issue Authority — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "roomId",
+    "signingKeyId",
+    "subject",
+    "actions",
+    "validUntil"
+  ],
+  "properties": {
+    "roomId": {
+      "type": "string",
+      "description": "The room whose identity issues this credential. The recipient MUST hold a signing key for it — it is signing AS the room, not as itself."
+    },
+    "signingKeyId": {
+      "type": "string",
+      "maxLength": 256,
+      "description": "Which held key signs. Named explicitly rather than looked up from `roomId`, because nothing maps a DID to a key it was minted with and inventing that mapping would add a lifecycle to get wrong. A key that is not the room's produces a credential that fails to verify against the room's DID document — loud, and at the first use rather than later."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    },
+    "subject": {
+      "type": "string",
+      "description": "The party this grants to. A chain ROOT: the room is the governing party, so this is the grant everything else descends from. A holder narrows their own grant with attenuation instead, which needs no issuer."
+    },
+    "actions": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "string",
+        "enum": [
+          "read",
+          "write",
+          "curate",
+          "admin"
+        ]
+      },
+      "description": "What the subject may do. MUST NOT be empty — an empty list confers nothing rather than everything, and a schema that allowed it would make the more dangerous reading available to a careless consumer. `curate` is not implied by `write`: pinning, deprecating and retracting are judgements over shared knowledge, not writes."
+    },
+    "validUntil": {
+      "type": "string",
+      "format": "date-time",
+      "description": "When the grant lapses. REQUIRED, and not merely recommended: nothing about the subject's current standing is consulted when an authority credential is verified, so a grant that never expires is authority nobody can withdraw by waiting. A verifier refuses a chain link carrying none, so a grant minted without one could not have been used. Changing what a party may do reissues this one small credential and leaves the membership edge alone, which is why the two are separate credentials."
+    },
+    "purposes": {
+      "$ref": "#/$defs/PurposeScope",
+      "description": "OPTIONAL. What the subject may use the content it reads under this grant for (VTI-ACL-110): `{\"scope\": \"any\"}` or a non-empty list. Stated in the credential exactly as given; absent, the credential states none, which grants `any` — never `modelTraining`, which a grant must name."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Rooms Owner Issue Authority — response payload",
+      "description": "Success response to rooms/owner/issue-authority. Type https://trusttasks.org/spec/rooms/owner/issue-authority/0.2#response. The signed VAC, a chain root at the room's scope.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credential",
+        "credentialId"
+      ],
+      "properties": {
+        "credential": {
+          "type": "string",
+          "description": "The signed Verifiable Authority Credential, serialised."
+        },
+        "credentialId": {
+          "type": "string",
+          "description": "Its `id`."
+        },
+        "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-]+)+$"
+      }
+    },
+    "PurposeScope": {
+      "title": "PurposeScope",
+      "description": "An explicit purpose scope. Exactly one of two shapes, discriminated by `scope`: `any`, or `listed` with a NON-EMPTY list of purposes. The empty list is invalid, not a third shape.",
+      "oneOf": [
+        {
+          "$ref": "#/$defs/PurposeScopeAny"
+        },
+        {
+          "$ref": "#/$defs/PurposeScopeListed"
+        }
+      ]
+    },
+    "PurposeScopeListed": {
+      "title": "PurposeScopeListed",
+      "description": "Exactly the listed purposes. A request naming any other purpose is refused.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "scope",
+        "purposes"
+      ],
+      "properties": {
+        "scope": {
+          "const": "listed"
+        },
+        "purposes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Purpose"
+          },
+          "description": "Non-empty set of purposes. An empty array is invalid (it is not `any`)."
+        }
+      }
+    },
+    "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]+$"
+        }
+      ]
+    },
+    "PurposeScopeAny": {
+      "title": "PurposeScopeAny",
+      "description": "Any purpose except `modelTraining` (training, fine-tuning or evaluating a machine-learning model on the content), which `any` never grants (VTI-ACL-105).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "scope"
+      ],
+      "properties": {
+        "scope": {
+          "const": "any"
+        }
+      }
+    }
+  }
+} 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 Owner Issue Authority — response payload",
+      "description": "Success response to rooms/owner/issue-authority. Type https://trusttasks.org/spec/rooms/owner/issue-authority/0.2#response. The signed VAC, a chain root at the room's scope.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credential",
+        "credentialId"
+      ],
+      "properties": {
+        "credential": {
+          "type": "string",
+          "description": "The signed Verifiable Authority Credential, serialised."
+        },
+        "credentialId": {
+          "type": "string",
+          "description": "Its `id`."
+        },
+        "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-]+)+$"
+      }
+    },
+    "PurposeScope": {
+      "title": "PurposeScope",
+      "description": "An explicit purpose scope. Exactly one of two shapes, discriminated by `scope`: `any`, or `listed` with a NON-EMPTY list of purposes. The empty list is invalid, not a third shape.",
+      "oneOf": [
+        {
+          "$ref": "#/$defs/PurposeScopeAny"
+        },
+        {
+          "$ref": "#/$defs/PurposeScopeListed"
+        }
+      ]
+    },
+    "PurposeScopeListed": {
+      "title": "PurposeScopeListed",
+      "description": "Exactly the listed purposes. A request naming any other purpose is refused.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "scope",
+        "purposes"
+      ],
+      "properties": {
+        "scope": {
+          "const": "listed"
+        },
+        "purposes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/Purpose"
+          },
+          "description": "Non-empty set of purposes. An empty array is invalid (it is not `any`)."
+        }
+      }
+    },
+    "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]+$"
+        }
+      ]
+    },
+    "PurposeScopeAny": {
+      "title": "PurposeScopeAny",
+      "description": "Any purpose except `modelTraining` (training, fine-tuning or evaluating a machine-learning model on the content), which `any` never grants (VTI-ACL-105).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "scope"
+      ],
+      "properties": {
+        "scope": {
+          "const": "any"
+        }
+      }
+    }
+  }
+} 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/records/get/0.1/payload.ts

@@ -6,7 +6,7 @@
 import type { AuthorityPresentation, DataCommitment, DigestMultibase, Ext, HeadVersion, RecordCount, RecordTrace, SealedRecord } from "../../../../_shared/components.js";
 
 
-/** @deprecated superseded by rooms/records/get/0.3 */
+/** @deprecated superseded by rooms/records/get/0.4 */
 export interface RoomsRecordsGetPayload {
   /**
    * The room's identifier.
@@ -28,7 +28,7 @@ export interface RoomsRecordsGetPayload {
 /**
  * Success response to rooms/records/get. Type https://trusttasks.org/spec/rooms/records/get/0.1#response.
  *
- * @deprecated superseded by rooms/records/get/0.3
+ * @deprecated superseded by rooms/records/get/0.4
  */
 export interface RoomsRecordsGetResponsePayload {
   key: string;
@@ -104,12 +104,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/records/get/0.3";
+export const DEPRECATION: string | null = "superseded by rooms/records/get/0.4";
 
 /**
  * Stable alias for this specification's request payload shape.
  *
- * @deprecated superseded by rooms/records/get/0.3
+ * @deprecated superseded by rooms/records/get/0.4
  */
 export type Payload = RoomsRecordsGetPayload;
 
@@ -119,7 +119,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/records/get/
 /**
  * Stable alias for this specification's success-response payload shape.
  *
- * @deprecated superseded by rooms/records/get/0.3
+ * @deprecated superseded by rooms/records/get/0.4
  */
 export type Response = RoomsRecordsGetResponsePayload;
 

package/src/rooms/records/get/0.2/payload.ts

@@ -6,7 +6,7 @@
 import type { AuthorityPresentation, BlobRef, DataCommitment, DigestMultibase, Ext, HeadVersion, RecordCount, RecordTrace, SealedRecord } from "../../../../_shared/components.js";
 
 
-/** @deprecated superseded by rooms/records/get/0.3 */
+/** @deprecated superseded by rooms/records/get/0.4 */
 export interface RoomsRecordsGetPayload {
   /**
    * The room's identifier.
@@ -28,7 +28,7 @@ export interface RoomsRecordsGetPayload {
 /**
  * Success response to rooms/records/get. Type https://trusttasks.org/spec/rooms/records/get/0.2#response.
  *
- * @deprecated superseded by rooms/records/get/0.3
+ * @deprecated superseded by rooms/records/get/0.4
  */
 export interface RoomsRecordsGetResponsePayload {
   key: string;
@@ -111,12 +111,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/records/get/0.3";
+export const DEPRECATION: string | null = "superseded by rooms/records/get/0.4";
 
 /**
  * Stable alias for this specification's request payload shape.
  *
- * @deprecated superseded by rooms/records/get/0.3
+ * @deprecated superseded by rooms/records/get/0.4
  */
 export type Payload = RoomsRecordsGetPayload;
 
@@ -126,7 +126,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/records/get/
 /**
  * Stable alias for this specification's success-response payload shape.
  *
- * @deprecated superseded by rooms/records/get/0.3
+ * @deprecated superseded by rooms/records/get/0.4
  */
 export type Response = RoomsRecordsGetResponsePayload;
 

package/src/rooms/records/get/0.3/payload.ts

@@ -6,6 +6,7 @@
 import type { AuthorityPresentation, BlobRef, DataCommitment, DigestMultibase, Ext, HeadVersion, RecordCount, RecordTrace, SealedRecord } from "../../../../_shared/components.js";
 
 
+/** @deprecated superseded by rooms/records/get/0.4 */
 export interface RoomsRecordsGetPayload {
   /**
    * The room's identifier.
@@ -26,6 +27,8 @@ export interface RoomsRecordsGetPayload {
 }
 /**
  * Success response to rooms/records/get. Type https://trusttasks.org/spec/rooms/records/get/0.3#response.
+ *
+ * @deprecated superseded by rooms/records/get/0.4
  */
 export interface RoomsRecordsGetResponsePayload {
   key: string;
@@ -120,15 +123,23 @@ export const EXTENDS: string | null = "0.2";
  * 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/records/get/0.4";
 
-/** Stable alias for this specification's request payload shape. */
+/**
+ * Stable alias for this specification's request payload shape.
+ *
+ * @deprecated superseded by rooms/records/get/0.4
+ */
 export type Payload = RoomsRecordsGetPayload;
 
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/rooms/records/get/0.3#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/records/get/0.4
+ */
 export type Response = RoomsRecordsGetResponsePayload;
 
 /**