@openvtc/trust-tasks 0.27.3 → 0.27.4

package/src/did-management/did/list/0.2/payload.ts

@@ -0,0 +1,327 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/did/list/0.2/payload.schema.json
+ */
+
+import type { DidRecord, Ext } from "../../../../_shared/components.js";
+
+
+export interface DIDManagementListPayload {
+  /**
+   * Admin-only filter — list slots owned by this VID.
+   */
+  owner?: string;
+  domain?: string;
+  /**
+   * An opaque continuation token from a previous response's `nextCursor`; a responder MUST NOT accept a cursor it did not issue.
+   */
+  cursor?: string;
+  /**
+   * The most items to return; the responder chooses a default and MAY return fewer.
+   */
+  limit?: number;
+  ext?: Ext;
+}
+export interface DIDManagementListResponsePayload {
+  records: DidRecord[];
+  /**
+   * Opaque continuation token for the next page; pass it back as the request's `cursor`. Absent on the last page.
+   */
+  nextCursor?: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { DidRecord, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/did-management/did/list/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = DIDManagementListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/did-management/did/list/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = DIDManagementListResponsePayload;
+
+/**
+ * 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/did-management/did/list/0.2",
+  "title": "DID Management List — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "owner": {
+      "type": "string",
+      "description": "Admin-only filter — list slots owned by this VID."
+    },
+    "domain": {
+      "type": "string"
+    },
+    "cursor": {
+      "type": "string",
+      "description": "An opaque continuation token from a previous response's `nextCursor`; a responder MUST NOT accept a cursor it did not issue."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 1000,
+      "description": "The most items to return; the responder chooses a default and MAY return fewer."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "DID Management List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "records"
+      ],
+      "properties": {
+        "records": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/DidRecord"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "description": "Opaque continuation token for the next page; pass it back as the request's `cursor`. Absent on the last page."
+        },
+        "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-]+)+$"
+      }
+    },
+    "DidRecord": {
+      "title": "DidRecord",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mnemonic",
+        "owner",
+        "createdAt",
+        "updatedAt",
+        "versionCount"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string",
+          "description": "Local path under which the DID is hosted (e.g. `alice`, `tenant/staff/alice`, `.well-known`). Compared by exact string equality (SPEC.md §4.8); producers SHOULD emit canonical form."
+        },
+        "owner": {
+          "type": "string",
+          "description": "VID of the party that currently owns the record. Authorization to mutate the record is anchored on this field."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC3339 timestamp of initial reservation."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC3339 timestamp of the most recent record mutation."
+        },
+        "versionCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of log entries the host currently holds for the DID. `0` indicates a reservation with no published log yet."
+        },
+        "didId": {
+          "type": "string",
+          "description": "Fully-qualified DID identifier resolved from the most recent log entry (e.g. `did:webvh:<scid>:host:path`). Absent when `versionCount === 0`."
+        },
+        "didUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "Resolvable URL of the DID's log document (e.g. `https://did.example.com/alice/did.jsonl`). Stable across the record's lifetime: present from the initial reservation (`versionCount === 0`), it tells the owner where to publish the signed log and where resolvers fetch it. Distinct from `didId`, which only exists once a log entry has been published."
+        },
+        "method": {
+          "type": "string",
+          "description": "DID method this record was registered under (e.g. `webvh`, `web`). When omitted, consumers MAY treat the record as legacy; SHOULD default to `webvh` only if their host predates the multi-method era."
+        },
+        "domain": {
+          "type": "string",
+          "description": "Hosting domain (hostname) under which the DID resolves. Matches the host segment of the embedded DID identifier."
+        },
+        "disabled": {
+          "type": "boolean",
+          "description": "When `true`, the DID is administratively disabled — the host serves a deactivation marker but retains content for recovery within the host's retention policy."
+        },
+        "totalResolves": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Lifetime resolve counter, when the host exposes per-DID statistics."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    }
+  }
+} 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": "DID Management List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "records"
+      ],
+      "properties": {
+        "records": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/DidRecord"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "description": "Opaque continuation token for the next page; pass it back as the request's `cursor`. Absent on the last page."
+        },
+        "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-]+)+$"
+      }
+    },
+    "DidRecord": {
+      "title": "DidRecord",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mnemonic",
+        "owner",
+        "createdAt",
+        "updatedAt",
+        "versionCount"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string",
+          "description": "Local path under which the DID is hosted (e.g. `alice`, `tenant/staff/alice`, `.well-known`). Compared by exact string equality (SPEC.md §4.8); producers SHOULD emit canonical form."
+        },
+        "owner": {
+          "type": "string",
+          "description": "VID of the party that currently owns the record. Authorization to mutate the record is anchored on this field."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC3339 timestamp of initial reservation."
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "RFC3339 timestamp of the most recent record mutation."
+        },
+        "versionCount": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of log entries the host currently holds for the DID. `0` indicates a reservation with no published log yet."
+        },
+        "didId": {
+          "type": "string",
+          "description": "Fully-qualified DID identifier resolved from the most recent log entry (e.g. `did:webvh:<scid>:host:path`). Absent when `versionCount === 0`."
+        },
+        "didUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "Resolvable URL of the DID's log document (e.g. `https://did.example.com/alice/did.jsonl`). Stable across the record's lifetime: present from the initial reservation (`versionCount === 0`), it tells the owner where to publish the signed log and where resolvers fetch it. Distinct from `didId`, which only exists once a log entry has been published."
+        },
+        "method": {
+          "type": "string",
+          "description": "DID method this record was registered under (e.g. `webvh`, `web`). When omitted, consumers MAY treat the record as legacy; SHOULD default to `webvh` only if their host predates the multi-method era."
+        },
+        "domain": {
+          "type": "string",
+          "description": "Hosting domain (hostname) under which the DID resolves. Matches the host segment of the embedded DID identifier."
+        },
+        "disabled": {
+          "type": "boolean",
+          "description": "When `true`, the DID is administratively disabled — the host serves a deactivation marker but retains content for recovery within the host's retention policy."
+        },
+        "totalResolves": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Lifetime resolve counter, when the host exposes per-DID statistics."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    }
+  }
+} 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,
+  isIssuedAtRequired: false,
+  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: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;