@openvtc/trust-tasks 0.9.0 → 0.11.0

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

@@ -0,0 +1,548 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/webvh/dids/create/1.0/payload.schema.json
+ */
+
+/**
+ * How the path under the host is chosen. Absent means `autoAssign`.
+ */
+export type WebvhPathMode =
+  | {
+      mode: "wellKnown";
+    }
+  | {
+      mode: "explicit";
+      path: string;
+    }
+  | {
+      mode: "autoAssign";
+    };
+
+/**
+ * Mint a did:webvh: the VTA generates the keys, writes the log's first entry, and either hands it to a hosting server or returns it for the caller to serve.
+ */
+export interface VTAWebVHDIDsCreatePayload {
+  /**
+   * Context the DID belongs to. Its keys are minted here, and deleting the context destroys the DID.
+   */
+  contextId: string;
+  /**
+   * Hosting server to publish through. Absent means **serverless**: the caller serves the log itself at `url`, and the VTA holds no hosting registration for it.
+   */
+  serverId?: string;
+  /**
+   * Where the log will be served, for the serverless case. The DID's identity derives from this location, so changing it later is only possible for a `portable` DID.
+   */
+  url?: string;
+  /**
+   * Explicit path label under the host. Shorthand for pathMode `explicit`; supplying both is an error.
+   */
+  path?: string;
+  pathMode?: WebvhPathMode;
+  /**
+   * Hosting domain to publish under, when the server serves more than one.
+   */
+  domain?: string;
+  label?: string;
+  /**
+   * Whether this DID may later move to another domain and keep its identity. **Fixed at creation** — portability is committed in the first log entry and cannot be added afterwards. A DID created non-portable is tied to where it was published for its whole life.
+   */
+  portable?: boolean;
+  /**
+   * Add a DIDComm mediator service entry to the document.
+   */
+  addMediatorService?: boolean;
+  /**
+   * Add a TSP transport service entry to the document.
+   */
+  addTspService?: boolean;
+  /**
+   * Further service entries, verbatim.
+   */
+  additionalServices?: {}[];
+  /**
+   * How many successor keys to commit in advance. **`0` disables pre-rotation**, which means a compromise of the current key cannot be recovered from by rotating: the successor was never committed, so a thief can rotate to their own key as convincingly as the owner can.
+   */
+  preRotationCount?: number;
+  /**
+   * A DID document to publish rather than one the VTA composes.
+   */
+  didDocument?: {};
+  /**
+   * An existing log to adopt, for importing a DID minted elsewhere.
+   */
+  didLog?: string;
+  /**
+   * Make this the context's primary DID.
+   */
+  setPrimary?: boolean;
+  /**
+   * Existing key to sign log entries with. Absent mints a new one.
+   */
+  signingKeyId?: string;
+  /**
+   * Existing key-agreement key to publish. Absent mints a new one.
+   */
+  kaKeyId?: string;
+  /**
+   * DID template to render the document from (see vta/did-templates/*).
+   */
+  template?: string;
+  /**
+   * Context whose templates to resolve `template` against. Absent uses the global scope, which is a different namespace and may hold a different template of the same name.
+   */
+  templateContext?: string;
+  /**
+   * Variables for the template's placeholders.
+   */
+  templateVars?: {
+    [k: string]: string | undefined;
+  };
+  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/create. Type https://trusttasks.org/spec/vta/webvh/dids/create/1.0#response.
+ */
+export interface VTAWebVHDIDsCreateResponsePayload {
+  did: string;
+  contextId: string;
+  serverId?: string;
+  /**
+   * The hosting server's handle for the record. Absent for a serverless DID.
+   */
+  mnemonic?: string;
+  /**
+   * Self-certifying identifier committing to the log's first entry.
+   */
+  scid: string;
+  portable: boolean;
+  signingKeyId: string;
+  kaKeyId: string;
+  /**
+   * Successor keys committed. `0` means pre-rotation is off for this DID.
+   */
+  preRotationKeyCount: number;
+  createdAt: string;
+  /**
+   * The published document, when the VTA composed one.
+   */
+  didDocument?: {};
+  /**
+   * The log's first entry. For a serverless DID this is what the caller must serve — the DID does not resolve until they do.
+   */
+  logEntry?: string;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/create/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAWebVHDIDsCreatePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/webvh/dids/create/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAWebVHDIDsCreateResponsePayload;
+
+/**
+ * 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/create/1.0",
+  "title": "VTA WebVH DIDs Create — payload",
+  "description": "Mint a did:webvh: the VTA generates the keys, writes the log's first entry, and either hands it to a hosting server or returns it for the caller to serve.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contextId"
+  ],
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Context the DID belongs to. Its keys are minted here, and deleting the context destroys the DID."
+    },
+    "serverId": {
+      "type": "string",
+      "description": "Hosting server to publish through. Absent means **serverless**: the caller serves the log itself at `url`, and the VTA holds no hosting registration for it."
+    },
+    "url": {
+      "type": "string",
+      "description": "Where the log will be served, for the serverless case. The DID's identity derives from this location, so changing it later is only possible for a `portable` DID."
+    },
+    "path": {
+      "type": "string",
+      "description": "Explicit path label under the host. Shorthand for pathMode `explicit`; supplying both is an error."
+    },
+    "pathMode": {
+      "$ref": "#/$defs/WebvhPathMode",
+      "description": "How the path under the host is chosen. Absent means `autoAssign`."
+    },
+    "domain": {
+      "type": "string",
+      "description": "Hosting domain to publish under, when the server serves more than one."
+    },
+    "label": {
+      "type": "string"
+    },
+    "portable": {
+      "type": "boolean",
+      "default": false,
+      "description": "Whether this DID may later move to another domain and keep its identity. **Fixed at creation** — portability is committed in the first log entry and cannot be added afterwards. A DID created non-portable is tied to where it was published for its whole life."
+    },
+    "addMediatorService": {
+      "type": "boolean",
+      "description": "Add a DIDComm mediator service entry to the document."
+    },
+    "addTspService": {
+      "type": "boolean",
+      "description": "Add a TSP transport service entry to the document."
+    },
+    "additionalServices": {
+      "type": "array",
+      "items": {
+        "type": "object"
+      },
+      "description": "Further service entries, verbatim."
+    },
+    "preRotationCount": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "How many successor keys to commit in advance. **`0` disables pre-rotation**, which means a compromise of the current key cannot be recovered from by rotating: the successor was never committed, so a thief can rotate to their own key as convincingly as the owner can."
+    },
+    "didDocument": {
+      "type": "object",
+      "description": "A DID document to publish rather than one the VTA composes."
+    },
+    "didLog": {
+      "type": "string",
+      "description": "An existing log to adopt, for importing a DID minted elsewhere."
+    },
+    "setPrimary": {
+      "type": "boolean",
+      "description": "Make this the context's primary DID."
+    },
+    "signingKeyId": {
+      "type": "string",
+      "description": "Existing key to sign log entries with. Absent mints a new one."
+    },
+    "kaKeyId": {
+      "type": "string",
+      "description": "Existing key-agreement key to publish. Absent mints a new one."
+    },
+    "template": {
+      "type": "string",
+      "description": "DID template to render the document from (see vta/did-templates/*)."
+    },
+    "templateContext": {
+      "type": "string",
+      "description": "Context whose templates to resolve `template` against. Absent uses the global scope, which is a different namespace and may hold a different template of the same name."
+    },
+    "templateVars": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      },
+      "description": "Variables for the template's placeholders."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "WebvhPathMode": {
+      "title": "WebvhPathMode",
+      "description": "Where under the host the DID is served. `wellKnown` puts it at the host root (`/.well-known/did.jsonl`) — at most one DID per host can hold that. `explicit` names the path. `autoAssign` lets the server allocate one.",
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "mode"
+          ],
+          "properties": {
+            "mode": {
+              "const": "wellKnown"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "mode",
+            "path"
+          ],
+          "properties": {
+            "mode": {
+              "const": "explicit"
+            },
+            "path": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "mode"
+          ],
+          "properties": {
+            "mode": {
+              "const": "autoAssign"
+            }
+          }
+        }
+      ]
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA WebVH DIDs Create — response payload",
+      "description": "Success response to vta/webvh/dids/create. Type https://trusttasks.org/spec/vta/webvh/dids/create/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "contextId",
+        "scid",
+        "portable",
+        "signingKeyId",
+        "kaKeyId",
+        "preRotationKeyCount",
+        "createdAt"
+      ],
+      "properties": {
+        "did": {
+          "type": "string"
+        },
+        "contextId": {
+          "type": "string"
+        },
+        "serverId": {
+          "type": "string"
+        },
+        "mnemonic": {
+          "type": "string",
+          "description": "The hosting server's handle for the record. Absent for a serverless DID."
+        },
+        "scid": {
+          "type": "string",
+          "description": "Self-certifying identifier committing to the log's first entry."
+        },
+        "portable": {
+          "type": "boolean"
+        },
+        "signingKeyId": {
+          "type": "string"
+        },
+        "kaKeyId": {
+          "type": "string"
+        },
+        "preRotationKeyCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Successor keys committed. `0` means pre-rotation is off for this DID."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "didDocument": {
+          "type": "object",
+          "description": "The published document, when the VTA composed one."
+        },
+        "logEntry": {
+          "type": "string",
+          "description": "The log's first entry. For a serverless DID this is what the caller must serve — the DID does not resolve until they do."
+        },
+        "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": {
+    "WebvhPathMode": {
+      "title": "WebvhPathMode",
+      "description": "Where under the host the DID is served. `wellKnown` puts it at the host root (`/.well-known/did.jsonl`) — at most one DID per host can hold that. `explicit` names the path. `autoAssign` lets the server allocate one.",
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "mode"
+          ],
+          "properties": {
+            "mode": {
+              "const": "wellKnown"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "mode",
+            "path"
+          ],
+          "properties": {
+            "mode": {
+              "const": "explicit"
+            },
+            "path": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "mode"
+          ],
+          "properties": {
+            "mode": {
+              "const": "autoAssign"
+            }
+          }
+        }
+      ]
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA WebVH DIDs Create — response payload",
+      "description": "Success response to vta/webvh/dids/create. Type https://trusttasks.org/spec/vta/webvh/dids/create/1.0#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "contextId",
+        "scid",
+        "portable",
+        "signingKeyId",
+        "kaKeyId",
+        "preRotationKeyCount",
+        "createdAt"
+      ],
+      "properties": {
+        "did": {
+          "type": "string"
+        },
+        "contextId": {
+          "type": "string"
+        },
+        "serverId": {
+          "type": "string"
+        },
+        "mnemonic": {
+          "type": "string",
+          "description": "The hosting server's handle for the record. Absent for a serverless DID."
+        },
+        "scid": {
+          "type": "string",
+          "description": "Self-certifying identifier committing to the log's first entry."
+        },
+        "portable": {
+          "type": "boolean"
+        },
+        "signingKeyId": {
+          "type": "string"
+        },
+        "kaKeyId": {
+          "type": "string"
+        },
+        "preRotationKeyCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Successor keys committed. `0` means pre-rotation is off for this DID."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "didDocument": {
+          "type": "object",
+          "description": "The published document, when the VTA composed one."
+        },
+        "logEntry": {
+          "type": "string",
+          "description": "The log's first entry. For a serverless DID this is what the caller must serve — the DID does not resolve until they do."
+        },
+        "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;