@openvtc/trust-tasks 0.21.4 → 0.21.5

package/src/webvh/witness/key/list/0.1/payload.ts

@@ -0,0 +1,232 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/webvh/witness/key/list/0.1/payload.schema.json
+ */
+
+import type { Ext, WitnessKey } from "../../../../../_shared/components.js";
+
+
+export interface WebVHWitnessKeyListPayload {
+  ext?: Ext;
+}
+export interface WebVHWitnessKeyListResponsePayload {
+  /**
+   * Every witness identity the service holds, ordered by createdAt. Empty when it holds none.
+   */
+  keys: WitnessKey[];
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, WitnessKey };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/webvh/witness/key/list/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = WebVHWitnessKeyListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/webvh/witness/key/list/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = WebVHWitnessKeyListResponsePayload;
+
+/**
+ * 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/witness/key/list/0.1",
+  "title": "WebVH Witness Key List — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "WebVH Witness Key List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "keys"
+      ],
+      "properties": {
+        "keys": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/WitnessKey"
+          },
+          "description": "Every witness identity the service holds, ordered by createdAt. Empty when it holds none."
+        },
+        "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-]+)+$"
+      }
+    },
+    "WitnessKey": {
+      "title": "WitnessKey",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "witnessId",
+        "did",
+        "createdAt",
+        "proofsSigned"
+      ],
+      "properties": {
+        "witnessId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The witness service's identifier for this identity. Opaque to the requester."
+        },
+        "did": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The witness identity's DID (for example a `did:key`) — the value a did:webvh log names in its `witness` parameter, and the controller of the key that signs its proofs."
+        },
+        "label": {
+          "type": "string",
+          "maxLength": 256,
+          "description": "Operator-chosen display label. Untrusted free text. Absent when none was given."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "proofsSigned": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many witness proofs this identity has signed."
+        }
+      }
+    }
+  }
+} 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 Witness Key List — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "keys"
+      ],
+      "properties": {
+        "keys": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/WitnessKey"
+          },
+          "description": "Every witness identity the service holds, ordered by createdAt. Empty when it holds none."
+        },
+        "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-]+)+$"
+      }
+    },
+    "WitnessKey": {
+      "title": "WitnessKey",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "witnessId",
+        "did",
+        "createdAt",
+        "proofsSigned"
+      ],
+      "properties": {
+        "witnessId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "The witness service's identifier for this identity. Opaque to the requester."
+        },
+        "did": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The witness identity's DID (for example a `did:key`) — the value a did:webvh log names in its `witness` parameter, and the controller of the key that signs its proofs."
+        },
+        "label": {
+          "type": "string",
+          "maxLength": 256,
+          "description": "Operator-chosen display label. Untrusted free text. Absent when none was given."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "proofsSigned": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many witness proofs this identity has signed."
+        }
+      }
+    }
+  }
+} 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/webvh/witness/sign/0.1/payload.ts

@@ -0,0 +1,279 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/webvh/witness/sign/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface WebVHWitnessSignPayload {
+  /**
+   * The witness identity to sign with, as webvh/witness/key/list reports it.
+   */
+  witnessId: string;
+  /**
+   * The versionId of the log entry to witness. MUST be the last entry of `logContent`.
+   */
+  versionId: string;
+  /**
+   * The did.jsonl up to and including the entry to witness, so the witness can verify what it signs.
+   */
+  logContent: string;
+  ext?: Ext;
+}
+export interface WebVHWitnessSignResponsePayload {
+  witnessId: string;
+  versionId: string;
+  /**
+   * The W3C Data Integrity proof over {versionId}, by the witness identity's key. Carried verbatim into the DID's did-witness.json; further Data Integrity members are permitted.
+   */
+  proof: {
+    type: "DataIntegrityProof";
+    cryptosuite: string;
+    verificationMethod: string;
+    proofPurpose: string;
+    proofValue: string;
+    created?: string;
+    [k: string]: unknown | undefined;
+  };
+  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/witness/sign/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = WebVHWitnessSignPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/webvh/witness/sign/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = WebVHWitnessSignResponsePayload;
+
+/**
+ * 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/witness/sign/0.1",
+  "title": "WebVH Witness Sign — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "witnessId",
+    "versionId",
+    "logContent"
+  ],
+  "properties": {
+    "witnessId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "The witness identity to sign with, as webvh/witness/key/list reports it."
+    },
+    "versionId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The versionId of the log entry to witness. MUST be the last entry of `logContent`."
+    },
+    "logContent": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The did.jsonl up to and including the entry to witness, so the witness can verify what it signs."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "WebVH Witness Sign — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "witnessId",
+        "versionId",
+        "proof"
+      ],
+      "properties": {
+        "witnessId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "versionId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "proof": {
+          "type": "object",
+          "description": "The W3C Data Integrity proof over {versionId}, by the witness identity's key. Carried verbatim into the DID's did-witness.json; further Data Integrity members are permitted.",
+          "additionalProperties": true,
+          "required": [
+            "type",
+            "cryptosuite",
+            "verificationMethod",
+            "proofPurpose",
+            "proofValue"
+          ],
+          "properties": {
+            "type": {
+              "const": "DataIntegrityProof"
+            },
+            "cryptosuite": {
+              "type": "string",
+              "minLength": 1
+            },
+            "verificationMethod": {
+              "type": "string",
+              "minLength": 1
+            },
+            "proofPurpose": {
+              "type": "string",
+              "minLength": 1
+            },
+            "proofValue": {
+              "type": "string",
+              "minLength": 1
+            },
+            "created": {
+              "type": "string",
+              "format": "date-time"
+            }
+          }
+        },
+        "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 Witness Sign — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "witnessId",
+        "versionId",
+        "proof"
+      ],
+      "properties": {
+        "witnessId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "versionId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "proof": {
+          "type": "object",
+          "description": "The W3C Data Integrity proof over {versionId}, by the witness identity's key. Carried verbatim into the DID's did-witness.json; further Data Integrity members are permitted.",
+          "additionalProperties": true,
+          "required": [
+            "type",
+            "cryptosuite",
+            "verificationMethod",
+            "proofPurpose",
+            "proofValue"
+          ],
+          "properties": {
+            "type": {
+              "const": "DataIntegrityProof"
+            },
+            "cryptosuite": {
+              "type": "string",
+              "minLength": 1
+            },
+            "verificationMethod": {
+              "type": "string",
+              "minLength": 1
+            },
+            "proofPurpose": {
+              "type": "string",
+              "minLength": 1
+            },
+            "proofValue": {
+              "type": "string",
+              "minLength": 1
+            },
+            "created": {
+              "type": "string",
+              "format": "date-time"
+            }
+          }
+        },
+        "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;