@openvtc/trust-tasks 0.21.4 → 0.21.5

package/src/webvh/sync/batch/0.1/payload.ts

@@ -0,0 +1,336 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/webvh/sync/batch/0.1/payload.schema.json
+ */
+
+import type { Ext, SyncUpdate } from "../../../../_shared/components.js";
+
+
+export interface WebVHSyncBatchPayload {
+  /**
+   * Complete slot states, each applied exactly as a webvh/sync/update/0.2 carrying it would be. A mnemonic appears at most once.
+   *
+   * @minItems 1
+   * @maxItems 50
+   */
+  updates: [SyncUpdate, ...SyncUpdate[]];
+  ext?: Ext;
+}
+export interface WebVHSyncBatchResponsePayload {
+  /**
+   * One result per entry of `updates`, in request order.
+   */
+  results: EntryResult[];
+  ext?: Ext;
+}
+export interface EntryResult {
+  mnemonic: string;
+  /**
+   * `applied` and `unchanged` as in webvh/sync/update/0.2. `refused` — the entry was permanently refused; see `code`.
+   */
+  status: "applied" | "unchanged" | "refused";
+  /**
+   * Present if and only if `status` is `refused`: the webvh/sync/update/0.2 error code the entry would have received on its own (e.g. `webvh/sync/update:historyRewrite`).
+   */
+  code?: string;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, SyncUpdate };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/webvh/sync/batch/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = WebVHSyncBatchPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/webvh/sync/batch/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = WebVHSyncBatchResponsePayload;
+
+/**
+ * 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/webvh/sync/batch/0.1",
+  "title": "WebVH Sync Batch — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "updates"
+  ],
+  "properties": {
+    "updates": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 50,
+      "items": {
+        "$ref": "#/$defs/SyncUpdate"
+      },
+      "description": "Complete slot states, each applied exactly as a webvh/sync/update/0.2 carrying it would be. A mnemonic appears at most once."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "WebVH Sync Batch — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "results"
+      ],
+      "properties": {
+        "results": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/EntryResult"
+          },
+          "description": "One result per entry of `updates`, in request order."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "EntryResult": {
+      "title": "EntryResult",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mnemonic",
+        "status"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string",
+          "minLength": 1
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "applied",
+            "unchanged",
+            "refused"
+          ],
+          "description": "`applied` and `unchanged` as in webvh/sync/update/0.2. `refused` — the entry was permanently refused; see `code`."
+        },
+        "code": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Present if and only if `status` is `refused`: the webvh/sync/update/0.2 error code the entry would have received on its own (e.g. `webvh/sync/update:historyRewrite`)."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "SyncUpdate": {
+      "title": "SyncUpdate",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mnemonic",
+        "didId",
+        "logContent",
+        "versionCount",
+        "disabled"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The slot path on its hosting domain (e.g. `alice`, `people/alice`, or `.well-known` for a root DID)."
+        },
+        "didId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The DID the log establishes. A replica MUST refuse a log that does not establish exactly this DID."
+        },
+        "logContent": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The slot's complete did.jsonl — one log entry per line — not a delta."
+        },
+        "witnessContent": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The slot's did-witness.json. ABSENT means the slot holds no witness proofs: the replica MUST drop any witness proofs it holds for the slot. Absence never means \"unchanged\"."
+        },
+        "versionCount": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Number of entries in `logContent`, as the source counts them. A replica MUST refuse an update whose `logContent` does not contain exactly this many entries."
+        },
+        "disabled": {
+          "type": "boolean",
+          "description": "Whether the source has disabled the slot. A replica MUST stop serving a disabled slot and MUST resume only on an update carrying `false`."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    }
+  }
+} 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": "WebVH Sync Batch — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "results"
+      ],
+      "properties": {
+        "results": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/EntryResult"
+          },
+          "description": "One result per entry of `updates`, in request order."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "EntryResult": {
+      "title": "EntryResult",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mnemonic",
+        "status"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string",
+          "minLength": 1
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "applied",
+            "unchanged",
+            "refused"
+          ],
+          "description": "`applied` and `unchanged` as in webvh/sync/update/0.2. `refused` — the entry was permanently refused; see `code`."
+        },
+        "code": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Present if and only if `status` is `refused`: the webvh/sync/update/0.2 error code the entry would have received on its own (e.g. `webvh/sync/update:historyRewrite`)."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "SyncUpdate": {
+      "title": "SyncUpdate",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mnemonic",
+        "didId",
+        "logContent",
+        "versionCount",
+        "disabled"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The slot path on its hosting domain (e.g. `alice`, `people/alice`, or `.well-known` for a root DID)."
+        },
+        "didId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The DID the log establishes. A replica MUST refuse a log that does not establish exactly this DID."
+        },
+        "logContent": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The slot's complete did.jsonl — one log entry per line — not a delta."
+        },
+        "witnessContent": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The slot's did-witness.json. ABSENT means the slot holds no witness proofs: the replica MUST drop any witness proofs it holds for the slot. Absence never means \"unchanged\"."
+        },
+        "versionCount": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Number of entries in `logContent`, as the source counts them. A replica MUST refuse an update whose `logContent` does not contain exactly this many entries."
+        },
+        "disabled": {
+          "type": "boolean",
+          "description": "Whether the source has disabled the slot. A replica MUST stop serving a disabled slot and MUST resume only on an update carrying `false`."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    }
+  }
+} 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/webvh/sync/delete/0.2/payload.ts

@@ -0,0 +1,181 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/webvh/sync/delete/0.2/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface WebVHSyncDeletePayload {
+  /**
+   * The slot path the source no longer publishes.
+   */
+  mnemonic: string;
+  ext?: Ext;
+}
+export interface WebVHSyncDeleteResponsePayload {
+  mnemonic: string;
+  /**
+   * `deleted` — the replica held the slot and has removed it. `absent` — it held nothing for the slot; the delete is idempotent.
+   */
+  status: "deleted" | "absent";
+  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/webvh/sync/delete/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = WebVHSyncDeletePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/webvh/sync/delete/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = WebVHSyncDeleteResponsePayload;
+
+/**
+ * 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/webvh/sync/delete/0.2",
+  "title": "WebVH Sync Delete — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "mnemonic"
+  ],
+  "properties": {
+    "mnemonic": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The slot path the source no longer publishes."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "WebVH Sync Delete — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mnemonic",
+        "status"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string",
+          "minLength": 1
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "deleted",
+            "absent"
+          ],
+          "description": "`deleted` — the replica held the slot and has removed it. `absent` — it held nothing for the slot; the delete is idempotent."
+        },
+        "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": {
+    "Response": {
+      "$anchor": "response",
+      "title": "WebVH Sync Delete — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mnemonic",
+        "status"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string",
+          "minLength": 1
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "deleted",
+            "absent"
+          ],
+          "description": "`deleted` — the replica held the slot and has removed it. `absent` — it held nothing for the slot; the delete is idempotent."
+        },
+        "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;