@openvtc/trust-tasks 0.9.0 → 0.11.0

package/src/vta/webvh/dids/list/1.0/payload.ts

@@ -0,0 +1,361 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/webvh/dids/list/1.0/payload.schema.json
+ */
+
+export interface VTAWebVHDIDsListPayload {
+  /**
+   * Only DIDs in this context.
+   */
+  contextId?: string;
+  /**
+   * Only DIDs published through this hosting server.
+   */
+  serverId?: string;
+  ext?: Ext;
+}
+/**
+ * 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.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Success response to vta/webvh/dids/list. Type https://trusttasks.org/spec/vta/webvh/dids/list/1.0#response.
+ */
+export interface VTAWebVHDIDsListResponsePayload {
+  /**
+   * Matching DIDs the caller may see. An empty array is a successful answer and does not imply the VTA holds none.
+   */
+  dids: WebvhDidRecord[];
+  ext?: Ext;
+}
+/**
+ * A did:webvh DID as the VTA holds it. The DID document itself is not here — it lives in the log, which `vta/webvh/dids/get` returns on request.
+ */
+export interface WebvhDidRecord {
+  /**
+   * The DID, e.g. `did:webvh:<scid>:example.com:alice`.
+   */
+  did: string;
+  /**
+   * Id of the hosting server serving this DID's log. Empty for a serverless DID, whose location comes from the URL it was created with.
+   */
+  serverId: string;
+  /**
+   * The hosting server's handle for the record. Unrelated to a BIP-39 phrase; the collision of terms is historical.
+   */
+  mnemonic: string;
+  /**
+   * Self-certifying identifier: the hash committing to the log's first entry. It is what makes the DID's history tamper-evident, and it changes only when the log is re-created — never in place.
+   */
+  scid: string;
+  /**
+   * Context this DID belongs to. Deleting that context destroys this DID.
+   */
+  contextId: string;
+  /**
+   * Whether the DID may be moved to another domain without losing its identity. Fixed at creation: a DID created non-portable cannot be made portable later, because portability is a commitment recorded in the log's first entry.
+   */
+  portable: boolean;
+  /**
+   * Number of entries in the log.
+   */
+  logEntryCount: number;
+  /**
+   * Pre-rotation keys committed by the most recent entry. `0` means pre-rotation is disabled — a compromise of the current key is then unrecoverable by rotation, because the successor was never committed in advance.
+   */
+  preRotationCount?: number;
+  /**
+   * Next `#key-{n}` fragment id to mint. Monotonic and never decremented, so a fragment is never reused for a different key.
+   */
+  nextFragmentId?: number;
+  createdAt: string;
+  updatedAt: string;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/list/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAWebVHDIDsListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/list/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAWebVHDIDsListResponsePayload;
+
+/**
+ * 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/vta/webvh/dids/list/1.0",
+  "title": "VTA WebVH DIDs List — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "description": "Only DIDs in this context."
+    },
+    "serverId": {
+      "type": "string",
+      "description": "Only DIDs published through this hosting server."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA WebVH DIDs List — response payload",
+      "description": "Success response to vta/webvh/dids/list. Type https://trusttasks.org/spec/vta/webvh/dids/list/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "dids"
+      ],
+      "properties": {
+        "dids": {
+          "type": "array",
+          "description": "Matching DIDs the caller may see. An empty array is a successful answer and does not imply the VTA holds none.",
+          "items": {
+            "$ref": "#/$defs/WebvhDidRecord"
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "WebvhDidRecord": {
+      "title": "WebvhDidRecord",
+      "description": "A did:webvh DID as the VTA holds it. The DID document itself is not here — it lives in the log, which `vta/webvh/dids/get` returns on request.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "serverId",
+        "mnemonic",
+        "scid",
+        "contextId",
+        "portable",
+        "logEntryCount",
+        "createdAt",
+        "updatedAt"
+      ],
+      "properties": {
+        "did": {
+          "type": "string",
+          "description": "The DID, e.g. `did:webvh:<scid>:example.com:alice`."
+        },
+        "serverId": {
+          "type": "string",
+          "description": "Id of the hosting server serving this DID's log. Empty for a serverless DID, whose location comes from the URL it was created with."
+        },
+        "mnemonic": {
+          "type": "string",
+          "description": "The hosting server's handle for the record. Unrelated to a BIP-39 phrase; the collision of terms is historical."
+        },
+        "scid": {
+          "type": "string",
+          "description": "Self-certifying identifier: the hash committing to the log's first entry. It is what makes the DID's history tamper-evident, and it changes only when the log is re-created — never in place."
+        },
+        "contextId": {
+          "type": "string",
+          "description": "Context this DID belongs to. Deleting that context destroys this DID."
+        },
+        "portable": {
+          "type": "boolean",
+          "description": "Whether the DID may be moved to another domain without losing its identity. Fixed at creation: a DID created non-portable cannot be made portable later, because portability is a commitment recorded in the log's first entry."
+        },
+        "logEntryCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of entries in the log."
+        },
+        "preRotationCount": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0,
+          "description": "Pre-rotation keys committed by the most recent entry. `0` means pre-rotation is disabled — a compromise of the current key is then unrecoverable by rotation, because the successor was never committed in advance."
+        },
+        "nextFragmentId": {
+          "type": "integer",
+          "minimum": 1,
+          "default": 1,
+          "description": "Next `#key-{n}` fragment id to mint. Monotonic and never decremented, so a fragment is never reused for a different key."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "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": "VTA WebVH DIDs List — response payload",
+      "description": "Success response to vta/webvh/dids/list. Type https://trusttasks.org/spec/vta/webvh/dids/list/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "dids"
+      ],
+      "properties": {
+        "dids": {
+          "type": "array",
+          "description": "Matching DIDs the caller may see. An empty array is a successful answer and does not imply the VTA holds none.",
+          "items": {
+            "$ref": "#/$defs/WebvhDidRecord"
+          }
+        },
+        "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-]+)+$"
+      }
+    },
+    "WebvhDidRecord": {
+      "title": "WebvhDidRecord",
+      "description": "A did:webvh DID as the VTA holds it. The DID document itself is not here — it lives in the log, which `vta/webvh/dids/get` returns on request.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "serverId",
+        "mnemonic",
+        "scid",
+        "contextId",
+        "portable",
+        "logEntryCount",
+        "createdAt",
+        "updatedAt"
+      ],
+      "properties": {
+        "did": {
+          "type": "string",
+          "description": "The DID, e.g. `did:webvh:<scid>:example.com:alice`."
+        },
+        "serverId": {
+          "type": "string",
+          "description": "Id of the hosting server serving this DID's log. Empty for a serverless DID, whose location comes from the URL it was created with."
+        },
+        "mnemonic": {
+          "type": "string",
+          "description": "The hosting server's handle for the record. Unrelated to a BIP-39 phrase; the collision of terms is historical."
+        },
+        "scid": {
+          "type": "string",
+          "description": "Self-certifying identifier: the hash committing to the log's first entry. It is what makes the DID's history tamper-evident, and it changes only when the log is re-created — never in place."
+        },
+        "contextId": {
+          "type": "string",
+          "description": "Context this DID belongs to. Deleting that context destroys this DID."
+        },
+        "portable": {
+          "type": "boolean",
+          "description": "Whether the DID may be moved to another domain without losing its identity. Fixed at creation: a DID created non-portable cannot be made portable later, because portability is a commitment recorded in the log's first entry."
+        },
+        "logEntryCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of entries in the log."
+        },
+        "preRotationCount": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0,
+          "description": "Pre-rotation keys committed by the most recent entry. `0` means pre-rotation is disabled — a compromise of the current key is then unrecoverable by rotation, because the successor was never committed in advance."
+        },
+        "nextFragmentId": {
+          "type": "integer",
+          "minimum": 1,
+          "default": 1,
+          "description": "Next `#key-{n}` fragment id to mint. Monotonic and never decremented, so a fragment is never reused for a different key."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "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: false,
+  isRecipientRequired: 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,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vta/webvh/dids/register-with-server/1.0/payload.ts

@@ -0,0 +1,212 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/webvh/dids/register-with-server/1.0/payload.schema.json
+ */
+
+/**
+ * Hand an existing DID's log to a hosting server so it is served there.
+ */
+export interface VTAWebVHDIDsRegisterWithServerPayload {
+  did: string;
+  /**
+   * Hosting server to register with.
+   */
+  serverId: string;
+  /**
+   * Overwrite a registration the server already holds at this location. Default false: the location may be somebody else's identity.
+   */
+  force?: boolean;
+  /**
+   * Domain to publish under, when the server serves more than one.
+   */
+  domain?: string;
+  ext?: Ext;
+}
+/**
+ * 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.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Success response to vta/webvh/dids/register-with-server. Type https://trusttasks.org/spec/vta/webvh/dids/register-with-server/1.0#response.
+ */
+export interface VTAWebVHDIDsRegisterWithServerResponsePayload {
+  did: string;
+  serverId: string;
+  /**
+   * Entries the server accepted. Compare it with the DID's own log length: a shorter count means the server holds a truncated history and will resolve to an older document.
+   */
+  logEntryCount: number;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/register-with-server/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAWebVHDIDsRegisterWithServerPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/register-with-server/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAWebVHDIDsRegisterWithServerResponsePayload;
+
+/**
+ * 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/vta/webvh/dids/register-with-server/1.0",
+  "title": "VTA WebVH DIDs Register-With-Server — payload",
+  "description": "Hand an existing DID's log to a hosting server so it is served there.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "did",
+    "serverId"
+  ],
+  "properties": {
+    "did": {
+      "type": "string",
+      "minLength": 1
+    },
+    "serverId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Hosting server to register with."
+    },
+    "force": {
+      "type": "boolean",
+      "default": false,
+      "description": "Overwrite a registration the server already holds at this location. Default false: the location may be somebody else's identity."
+    },
+    "domain": {
+      "type": "string",
+      "description": "Domain to publish under, when the server serves more than one."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA WebVH DIDs Register-With-Server — response payload",
+      "description": "Success response to vta/webvh/dids/register-with-server. Type https://trusttasks.org/spec/vta/webvh/dids/register-with-server/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "serverId",
+        "logEntryCount"
+      ],
+      "properties": {
+        "did": {
+          "type": "string"
+        },
+        "serverId": {
+          "type": "string"
+        },
+        "logEntryCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Entries the server accepted. Compare it with the DID's own log length: a shorter count means the server holds a truncated history and will resolve to an older document."
+        },
+        "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": "VTA WebVH DIDs Register-With-Server — response payload",
+      "description": "Success response to vta/webvh/dids/register-with-server. Type https://trusttasks.org/spec/vta/webvh/dids/register-with-server/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "serverId",
+        "logEntryCount"
+      ],
+      "properties": {
+        "did": {
+          "type": "string"
+        },
+        "serverId": {
+          "type": "string"
+        },
+        "logEntryCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Entries the server accepted. Compare it with the DID's own log length: a shorter count means the server holds a truncated history and will resolve to an older document."
+        },
+        "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,
+  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,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;