@openvtc/trust-tasks 0.21.4 → 0.21.5

package/src/did-management/did/log/0.1/payload.ts

@@ -0,0 +1,295 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/did/log/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface DIDLogPayload {
+  mnemonic: string;
+  /**
+   * Disambiguates `mnemonic` per the category conventions. Absent means the domain is resolved by the category's chain.
+   */
+  domain?: string;
+  /**
+   * When true, the response also carries the stored artifacts verbatim. Absent or false means parsed entries only.
+   */
+  raw?: boolean;
+  ext?: Ext;
+}
+export interface DIDLogResponsePayload {
+  mnemonic: string;
+  /**
+   * The slot's DID method (`webvh`, `web`, `webs`, …). Determines what an entry is.
+   */
+  method: string;
+  /**
+   * The slot's history, oldest first. For did:webvh, one per log line; for a method with no log (did:web) a single entry for the current document; for did:webs one per establishment event that changed the document.
+   */
+  entries: {
+    /**
+     * The entry's version identifier. Absent for a method that has none.
+     */
+    versionId?: string;
+    /**
+     * When the entry was made, as the entry states it. Absent for a method that records none.
+     */
+    versionTime?: string;
+    /**
+     * The DID document as of this entry.
+     */
+    state: {};
+    /**
+     * The method's parameters as of this entry (did:webvh log parameters). Absent for a method that has none.
+     */
+    parameters?: {};
+  }[];
+  /**
+   * The stored primary artifact verbatim — did.jsonl for did:webvh, the key event stream for did:webs, did.json for did:web. Present iff the request set raw: true.
+   */
+  logContent?: string;
+  /**
+   * The stored did-witness.json verbatim. Present iff the request set raw: true and the slot holds witness proofs.
+   */
+  witnessContent?: string;
+  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/did-management/did/log/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = DIDLogPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/did-management/did/log/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = DIDLogResponsePayload;
+
+/**
+ * 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/log/0.1",
+  "title": "DID Log — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "mnemonic"
+  ],
+  "properties": {
+    "mnemonic": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512
+    },
+    "domain": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 253,
+      "description": "Disambiguates `mnemonic` per the category conventions. Absent means the domain is resolved by the category's chain."
+    },
+    "raw": {
+      "type": "boolean",
+      "description": "When true, the response also carries the stored artifacts verbatim. Absent or false means parsed entries only."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "DID Log — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mnemonic",
+        "method",
+        "entries"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string"
+        },
+        "method": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The slot's DID method (`webvh`, `web`, `webs`, …). Determines what an entry is."
+        },
+        "entries": {
+          "type": "array",
+          "description": "The slot's history, oldest first. For did:webvh, one per log line; for a method with no log (did:web) a single entry for the current document; for did:webs one per establishment event that changed the document.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "state"
+            ],
+            "properties": {
+              "versionId": {
+                "type": "string",
+                "description": "The entry's version identifier. Absent for a method that has none."
+              },
+              "versionTime": {
+                "type": "string",
+                "format": "date-time",
+                "description": "When the entry was made, as the entry states it. Absent for a method that records none."
+              },
+              "state": {
+                "type": "object",
+                "description": "The DID document as of this entry."
+              },
+              "parameters": {
+                "type": "object",
+                "description": "The method's parameters as of this entry (did:webvh log parameters). Absent for a method that has none."
+              }
+            }
+          }
+        },
+        "logContent": {
+          "type": "string",
+          "description": "The stored primary artifact verbatim — did.jsonl for did:webvh, the key event stream for did:webs, did.json for did:web. Present iff the request set raw: true."
+        },
+        "witnessContent": {
+          "type": "string",
+          "description": "The stored did-witness.json verbatim. Present iff the request set raw: true and the slot holds witness proofs."
+        },
+        "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": "DID Log — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "mnemonic",
+        "method",
+        "entries"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string"
+        },
+        "method": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The slot's DID method (`webvh`, `web`, `webs`, …). Determines what an entry is."
+        },
+        "entries": {
+          "type": "array",
+          "description": "The slot's history, oldest first. For did:webvh, one per log line; for a method with no log (did:web) a single entry for the current document; for did:webs one per establishment event that changed the document.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "state"
+            ],
+            "properties": {
+              "versionId": {
+                "type": "string",
+                "description": "The entry's version identifier. Absent for a method that has none."
+              },
+              "versionTime": {
+                "type": "string",
+                "format": "date-time",
+                "description": "When the entry was made, as the entry states it. Absent for a method that records none."
+              },
+              "state": {
+                "type": "object",
+                "description": "The DID document as of this entry."
+              },
+              "parameters": {
+                "type": "object",
+                "description": "The method's parameters as of this entry (did:webvh log parameters). Absent for a method that has none."
+              }
+            }
+          }
+        },
+        "logContent": {
+          "type": "string",
+          "description": "The stored primary artifact verbatim — did.jsonl for did:webvh, the key event stream for did:webs, did.json for did:web. Present iff the request set raw: true."
+        },
+        "witnessContent": {
+          "type": "string",
+          "description": "The stored did-witness.json verbatim. Present iff the request set raw: true and the slot holds witness proofs."
+        },
+        "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: 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/did-management/domain/list/0.1/payload.ts

@@ -0,0 +1,280 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/domain/list/0.1/payload.schema.json
+ */
+
+import type { DomainEntry, Ext } from "../../../../_shared/components.js";
+
+
+export interface DomainListPayload {
+  /**
+   * Only domains in this state. Absent means every state.
+   */
+  status?: "active" | "disabled";
+  ext?: Ext;
+}
+export interface DomainListResponsePayload {
+  /**
+   * Every matching hosting domain, ordered by name.
+   */
+  domains: DomainEntry[];
+  /**
+   * The service's system-default domain. Absent when none is set.
+   */
+  default?: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { DomainEntry, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/did-management/domain/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = DomainListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/did-management/domain/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = DomainListResponsePayload;
+
+/**
+ * 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/domain/list/0.1",
+  "title": "Domain List — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "status": {
+      "type": "string",
+      "enum": [
+        "active",
+        "disabled"
+      ],
+      "description": "Only domains in this state. Absent means every state."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Domain List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "domains"
+      ],
+      "properties": {
+        "domains": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/DomainEntry"
+          },
+          "description": "Every matching hosting domain, ordered by name."
+        },
+        "default": {
+          "type": "string",
+          "description": "The service's system-default domain. Absent when none is set."
+        },
+        "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-]+)+$"
+      }
+    },
+    "DomainEntry": {
+      "title": "DomainEntry",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "status",
+        "createdAt"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Hosting domain name (e.g. `did.example.com`). Compared case-insensitively; producers SHOULD emit lowercase canonical form."
+        },
+        "label": {
+          "type": "string",
+          "description": "Optional human-readable label."
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "active",
+            "disabled"
+          ],
+          "description": "Domain lifecycle state. A `disabled` domain still serves existing DIDs in read-only mode for the host's configured grace period before purge becomes eligible."
+        },
+        "defaultDomain": {
+          "type": "boolean",
+          "description": "When `true`, this domain is the host's default — new DIDs created without an explicit domain are hosted here. Exactly one entry SHOULD carry `defaultDomain: true`."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "disabledAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present iff `status === \"disabled\"`."
+        },
+        "purgeAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Earliest RFC3339 timestamp at which the host's background sweep is allowed to purge content for a disabled domain. Operators with administrative authority MAY override the wait via `domain/purge`."
+        },
+        "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": "Domain List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "domains"
+      ],
+      "properties": {
+        "domains": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/DomainEntry"
+          },
+          "description": "Every matching hosting domain, ordered by name."
+        },
+        "default": {
+          "type": "string",
+          "description": "The service's system-default domain. Absent when none is set."
+        },
+        "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-]+)+$"
+      }
+    },
+    "DomainEntry": {
+      "title": "DomainEntry",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "status",
+        "createdAt"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Hosting domain name (e.g. `did.example.com`). Compared case-insensitively; producers SHOULD emit lowercase canonical form."
+        },
+        "label": {
+          "type": "string",
+          "description": "Optional human-readable label."
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "active",
+            "disabled"
+          ],
+          "description": "Domain lifecycle state. A `disabled` domain still serves existing DIDs in read-only mode for the host's configured grace period before purge becomes eligible."
+        },
+        "defaultDomain": {
+          "type": "boolean",
+          "description": "When `true`, this domain is the host's default — new DIDs created without an explicit domain are hosted here. Exactly one entry SHOULD carry `defaultDomain: true`."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "disabledAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Present iff `status === \"disabled\"`."
+        },
+        "purgeAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Earliest RFC3339 timestamp at which the host's background sweep is allowed to purge content for a disabled domain. Operators with administrative authority MAY override the wait via `domain/purge`."
+        },
+        "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: true,
+  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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;