@openvtc/trust-tasks 0.20.7 → 0.21.0

package/src/backup/put-chunk/0.1/payload.ts

@@ -0,0 +1,331 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/backup/put-chunk/0.1/payload.schema.json
+ */
+
+import type { BundleId, ChunkData, ChunkIndex, DigestMultibase, ExpiresAt, Ext } from "../../../_shared/components.js";
+
+
+/**
+ * Writes one chunk of a `chunkedTrustTask` import bundle, by index, into a slot opened by initiate-import. Idempotent for identical bytes; bytes that do not match the pre-committed manifest are refused. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface BackupPutChunkPayload {
+  /**
+   * Handle from the initiate-import descriptor. Opaque: a producer quotes what it was given and must not derive, guess or enumerate one.
+   */
+  bundleId: BundleId;
+  /**
+   * Which chunk. Zero-based, below the manifest's chunkCount.
+   */
+  index: ChunkIndex;
+  /**
+   * Digest of this chunk's raw bytes, restating the manifest entry for `index`. Restated so that a chunk sent to the wrong index is refused as a mismatch against the manifest at the index it names, rather than surviving until reassembly — the recipient checks this member against the manifest and `data` against both.
+   */
+  digestMultibase: DigestMultibase;
+  data: ChunkData;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+export interface BackupPutChunkResponsePayload {
+  /**
+   * Echoed so the response stands alone as the acknowledgement of one write.
+   */
+  bundleId: BundleId;
+  /**
+   * Echoed, so an acknowledgement arriving out of order is attributable to its write.
+   */
+  index: ChunkIndex;
+  /**
+   * Whether this request is what stored the chunk. False means the recipient already held identical bytes at this index — a success, not a failure, and the reason a write can be retried safely. Required rather than optional: an absent member on an idempotent repeat would be indistinguishable from a first write.
+   */
+  stored: boolean;
+  /**
+   * How many indices the slot still lacks after this write. Zero means the upload is complete and finalize-import can be sent.
+   */
+  remainingCount: number;
+  /**
+   * The slot's current expiry, after any extension this write earned.
+   */
+  expiresAt: ExpiresAt;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { BundleId, ChunkData, ChunkIndex, DigestMultibase, ExpiresAt, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/backup/put-chunk/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = BackupPutChunkPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/backup/put-chunk/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = BackupPutChunkResponsePayload;
+
+/**
+ * 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/backup/put-chunk/0.1",
+  "title": "Backup — Put Chunk — payload",
+  "description": "Writes one chunk of a `chunkedTrustTask` import bundle, by index, into a slot opened by initiate-import. Idempotent for identical bytes; bytes that do not match the pre-committed manifest are refused. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "bundleId",
+    "index",
+    "digestMultibase",
+    "data"
+  ],
+  "properties": {
+    "bundleId": {
+      "$ref": "#/$defs/BundleId",
+      "description": "Handle from the initiate-import descriptor. Opaque: a producer quotes what it was given and must not derive, guess or enumerate one."
+    },
+    "index": {
+      "$ref": "#/$defs/ChunkIndex",
+      "description": "Which chunk. Zero-based, below the manifest's chunkCount."
+    },
+    "digestMultibase": {
+      "$ref": "#/$defs/DigestMultibase",
+      "description": "Digest of this chunk's raw bytes, restating the manifest entry for `index`. Restated so that a chunk sent to the wrong index is refused as a mismatch against the manifest at the index it names, rather than surviving until reassembly — the recipient checks this member against the manifest and `data` against both."
+    },
+    "data": {
+      "$ref": "#/$defs/ChunkData"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Backup — Put Chunk — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "bundleId",
+        "index",
+        "stored",
+        "remainingCount",
+        "expiresAt"
+      ],
+      "properties": {
+        "bundleId": {
+          "$ref": "#/$defs/BundleId",
+          "description": "Echoed so the response stands alone as the acknowledgement of one write."
+        },
+        "index": {
+          "$ref": "#/$defs/ChunkIndex",
+          "description": "Echoed, so an acknowledgement arriving out of order is attributable to its write."
+        },
+        "stored": {
+          "type": "boolean",
+          "description": "Whether this request is what stored the chunk. False means the recipient already held identical bytes at this index — a success, not a failure, and the reason a write can be retried safely. Required rather than optional: an absent member on an idempotent repeat would be indistinguishable from a first write."
+        },
+        "remainingCount": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 4095,
+          "description": "How many indices the slot still lacks after this write. Zero means the upload is complete and finalize-import can be sent."
+        },
+        "expiresAt": {
+          "$ref": "#/$defs/ExpiresAt",
+          "description": "The slot's current expiry, after any extension this write earned."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "ExpiresAt": {
+      "title": "ExpiresAt",
+      "description": "After which the bundle is collected: staged bytes discarded, tokens and chunk requests refused. Short by design. For a chunked transfer a recipient may move it later as chunks are exchanged, never past its own ceiling — each chunk response reports the current value.",
+      "type": "string",
+      "format": "date-time"
+    },
+    "ChunkIndex": {
+      "title": "ChunkIndex",
+      "description": "Zero-based position of a chunk within its bundle. Valid values are 0 to chunkCount − 1; an index outside that range is refused with chunkOutOfRange rather than validated here, because the bound depends on the bundle.",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 4095
+    },
+    "BundleId": {
+      "title": "BundleId",
+      "description": "Handle for a bundle across its whole lifecycle. Recipient-generated and unguessable, which is what lets an unauthorized reference be answered as not-found without confirming existence. Opaque: a producer quotes what it was given and must not derive, guess or enumerate one.",
+      "type": "string",
+      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+    },
+    "ChunkData": {
+      "title": "ChunkData",
+      "description": "The chunk's bytes, base64url-encoded without padding (RFC 4648 §5). Bounded at 349526 characters, the unpadded encoding of a 262144-byte chunk. These are bytes of the encrypted bundle, so a chunk read in isolation reveals nothing of the agent's state — but a complete set of chunks is the export, and is to be handled as such.",
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 349526,
+      "pattern": "^[A-Za-z0-9_-]+$"
+    },
+    "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"
+      ]
+    }
+  }
+} 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": "Backup — Put Chunk — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "bundleId",
+        "index",
+        "stored",
+        "remainingCount",
+        "expiresAt"
+      ],
+      "properties": {
+        "bundleId": {
+          "$ref": "#/$defs/BundleId",
+          "description": "Echoed so the response stands alone as the acknowledgement of one write."
+        },
+        "index": {
+          "$ref": "#/$defs/ChunkIndex",
+          "description": "Echoed, so an acknowledgement arriving out of order is attributable to its write."
+        },
+        "stored": {
+          "type": "boolean",
+          "description": "Whether this request is what stored the chunk. False means the recipient already held identical bytes at this index — a success, not a failure, and the reason a write can be retried safely. Required rather than optional: an absent member on an idempotent repeat would be indistinguishable from a first write."
+        },
+        "remainingCount": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 4095,
+          "description": "How many indices the slot still lacks after this write. Zero means the upload is complete and finalize-import can be sent."
+        },
+        "expiresAt": {
+          "$ref": "#/$defs/ExpiresAt",
+          "description": "The slot's current expiry, after any extension this write earned."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "ExpiresAt": {
+      "title": "ExpiresAt",
+      "description": "After which the bundle is collected: staged bytes discarded, tokens and chunk requests refused. Short by design. For a chunked transfer a recipient may move it later as chunks are exchanged, never past its own ceiling — each chunk response reports the current value.",
+      "type": "string",
+      "format": "date-time"
+    },
+    "ChunkIndex": {
+      "title": "ChunkIndex",
+      "description": "Zero-based position of a chunk within its bundle. Valid values are 0 to chunkCount − 1; an index outside that range is refused with chunkOutOfRange rather than validated here, because the bound depends on the bundle.",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 4095
+    },
+    "BundleId": {
+      "title": "BundleId",
+      "description": "Handle for a bundle across its whole lifecycle. Recipient-generated and unguessable, which is what lets an unauthorized reference be answered as not-found without confirming existence. Opaque: a producer quotes what it was given and must not derive, guess or enumerate one.",
+      "type": "string",
+      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+    },
+    "ChunkData": {
+      "title": "ChunkData",
+      "description": "The chunk's bytes, base64url-encoded without padding (RFC 4648 §5). Bounded at 349526 characters, the unpadded encoding of a 262144-byte chunk. These are bytes of the encrypted bundle, so a chunk read in isolation reveals nothing of the agent's state — but a complete set of chunks is the export, and is to be handled as such.",
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 349526,
+      "pattern": "^[A-Za-z0-9_-]+$"
+    },
+    "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"
+      ]
+    }
+  }
+} 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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/device/list/0.1/payload.ts

@@ -247,7 +247,8 @@ export const PAYLOAD_SCHEMA = {
         "memory-read",
         "memory-write",
         "room-present",
-        "room-open"
+        "room-open",
+        "key-export"
       ],
       "description": "Fine-grained capability flag scoped to the device's allowed contexts. See SPEC.md for the full semantics of each. Capability values are additive: a consumer MUST ignore a value it does not recognise rather than reject the binding, and MUST NOT treat an unrecognised value as conferring anything."
     },
@@ -585,7 +586,8 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "memory-read",
         "memory-write",
         "room-present",
-        "room-open"
+        "room-open",
+        "key-export"
       ],
       "description": "Fine-grained capability flag scoped to the device's allowed contexts. See SPEC.md for the full semantics of each. Capability values are additive: a consumer MUST ignore a value it does not recognise rather than reject the binding, and MUST NOT treat an unrecognised value as conferring anything."
     },

package/src/device/list/0.2/payload.ts

@@ -247,7 +247,8 @@ export const PAYLOAD_SCHEMA = {
         "memoryRead",
         "memoryWrite",
         "roomPresent",
-        "roomOpen"
+        "roomOpen",
+        "keyExport"
       ],
       "description": "Fine-grained capability flag scoped to the device's allowed contexts. See SPEC.md for the full semantics of each. Capability values are additive: a consumer MUST ignore a value it does not recognise rather than reject the binding, and MUST NOT treat an unrecognised value as conferring anything."
     },
@@ -585,7 +586,8 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "memoryRead",
         "memoryWrite",
         "roomPresent",
-        "roomOpen"
+        "roomOpen",
+        "keyExport"
       ],
       "description": "Fine-grained capability flag scoped to the device's allowed contexts. See SPEC.md for the full semantics of each. Capability values are additive: a consumer MUST ignore a value it does not recognise rather than reject the binding, and MUST NOT treat an unrecognised value as conferring anything."
     },

package/src/device/register/0.1/payload.ts

@@ -215,7 +215,8 @@ export const PAYLOAD_SCHEMA = {
         "memory-read",
         "memory-write",
         "room-present",
-        "room-open"
+        "room-open",
+        "key-export"
       ],
       "description": "Fine-grained capability flag scoped to the device's allowed contexts. See SPEC.md for the full semantics of each. Capability values are additive: a consumer MUST ignore a value it does not recognise rather than reject the binding, and MUST NOT treat an unrecognised value as conferring anything."
     },
@@ -543,7 +544,8 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "memory-read",
         "memory-write",
         "room-present",
-        "room-open"
+        "room-open",
+        "key-export"
       ],
       "description": "Fine-grained capability flag scoped to the device's allowed contexts. See SPEC.md for the full semantics of each. Capability values are additive: a consumer MUST ignore a value it does not recognise rather than reject the binding, and MUST NOT treat an unrecognised value as conferring anything."
     },

package/src/device/register/0.2/payload.ts

@@ -215,7 +215,8 @@ export const PAYLOAD_SCHEMA = {
         "memoryRead",
         "memoryWrite",
         "roomPresent",
-        "roomOpen"
+        "roomOpen",
+        "keyExport"
       ],
       "description": "Fine-grained capability flag scoped to the device's allowed contexts. See SPEC.md for the full semantics of each. Capability values are additive: a consumer MUST ignore a value it does not recognise rather than reject the binding, and MUST NOT treat an unrecognised value as conferring anything."
     },
@@ -543,7 +544,8 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         "memoryRead",
         "memoryWrite",
         "roomPresent",
-        "roomOpen"
+        "roomOpen",
+        "keyExport"
       ],
       "description": "Fine-grained capability flag scoped to the device's allowed contexts. See SPEC.md for the full semantics of each. Capability values are additive: a consumer MUST ignore a value it does not recognise rather than reject the binding, and MUST NOT treat an unrecognised value as conferring anything."
     },

package/src/git-ns/_shared/0.4/git-ns.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/git-ns/_shared/0.4/git-ns.schema.json
+ */
+
+/**
+ * Shapes used by more than one git-ns/* task: forge-qualified resources, the five git rights, namespaces, repositories, rights records, forge accounts and drift. 0.4 adds `BreakGlass` and the optional `breakGlass` member of `RightRecord`: a record an actor gave themselves through git-ns/right/break-glass carries who, when and why, and — once another administrator has ratified it with git-ns/right/ratify — who ratified it and when. It also adds `ElevatedRight`, the three rights no actor may grant themselves through git-ns/right/grant. Every other definition is unchanged from 0.3. Not itself a Trust Task specification. A VTC is the source of truth for all of these; the Trust Registry and the forge are projections of them.
+ */
+export interface GitNamespacesSharedDefinitionsForTheGitNsSpecFamily {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { Bootstrap, BreakGlass, Did_GitNsV0_3 as Did, DriftItem, ElevatedRight, ForgeAccount, ForgeHost, ForgeId, GitNamespace, NamespaceId, RepoResource, RepoSummary_GitNsV0_3 as RepoSummary, RepoVisibility, Resource, Right, RightRecord_GitNsV0_4 as RightRecord, Segment, Sync } from "../../../_shared/components.js";

package/src/git-ns/account/link-status/0.1/payload.ts

@@ -255,7 +255,7 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
 export const SPEC = {
   typeUri: TYPE_URI,
   isBearer: false,
-  isProofRequired: false,
+  isProofRequired: true,
   isRecipientRequired: true,
   isIssuedAtRequired: false,
   payloadSchema: PAYLOAD_SCHEMA,
@@ -269,7 +269,7 @@ export const SPEC = {
 export const RESPONSE_SPEC = {
   typeUri: RESPONSE_TYPE_URI,
   isBearer: false,
-  isProofRequired: false,
+  isProofRequired: true,
   isRecipientRequired: true,
   isIssuedAtRequired: false,
   payloadSchema: RESPONSE_PAYLOAD_SCHEMA,