@openvtc/trust-tasks 0.26.10 → 0.26.12

package/src/vtc/members/registry-consent/0.1/payload.ts

@@ -0,0 +1,231 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/members/registry-consent/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface VTCMembersRegistryConsentPayload {
+  /**
+   * The member's own decision on trust-registry publication: `true` consents to the community publishing their membership in its trust registry, `false` withdraws that consent. Applies to the member who signed the document, and to no one else.
+   */
+  publishConsent: boolean;
+  ext?: Ext;
+}
+export interface VTCMembersRegistryConsentResponsePayload {
+  /**
+   * The member whose consent this is: the document's signer.
+   */
+  did: string;
+  /**
+   * The consent now recorded on the member record.
+   */
+  publishConsent: boolean;
+  /**
+   * Whether this document changed the recorded consent. `false` when the member restated the value already recorded.
+   */
+  changed: boolean;
+  /**
+   * What the community did about its trust registry. `queued`: a registry sync job carrying the change is queued (publication on a grant, removal on a withdrawal). `notConfigured`: the community publishes to no trust registry at present; the consent is recorded and governs any registry configured later. `unchanged`: nothing to sync, because the consent did not change, or because the community does not publish this member on other grounds (consent permits publication; it does not oblige it).
+   */
+  registrySync: "queued" | "notConfigured" | "unchanged";
+  /**
+   * When the community recorded the consent now in force — this document's execution when `changed` is `true`, the earlier change otherwise.
+   */
+  effectiveAt: 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/vtc/members/registry-consent/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCMembersRegistryConsentPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/members/registry-consent/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCMembersRegistryConsentResponsePayload;
+
+/**
+ * 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/vtc/members/registry-consent/0.1",
+  "title": "VTC Members Registry Consent — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "publishConsent"
+  ],
+  "properties": {
+    "publishConsent": {
+      "type": "boolean",
+      "description": "The member's own decision on trust-registry publication: `true` consents to the community publishing their membership in its trust registry, `false` withdraws that consent. Applies to the member who signed the document, and to no one else."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Members Registry Consent — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "publishConsent",
+        "changed",
+        "registrySync",
+        "effectiveAt"
+      ],
+      "properties": {
+        "did": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The member whose consent this is: the document's signer."
+        },
+        "publishConsent": {
+          "type": "boolean",
+          "description": "The consent now recorded on the member record."
+        },
+        "changed": {
+          "type": "boolean",
+          "description": "Whether this document changed the recorded consent. `false` when the member restated the value already recorded."
+        },
+        "registrySync": {
+          "type": "string",
+          "enum": [
+            "queued",
+            "notConfigured",
+            "unchanged"
+          ],
+          "description": "What the community did about its trust registry. `queued`: a registry sync job carrying the change is queued (publication on a grant, removal on a withdrawal). `notConfigured`: the community publishes to no trust registry at present; the consent is recorded and governs any registry configured later. `unchanged`: nothing to sync, because the consent did not change, or because the community does not publish this member on other grounds (consent permits publication; it does not oblige it)."
+        },
+        "effectiveAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community recorded the consent now in force — this document's execution when `changed` is `true`, the earlier change otherwise."
+        },
+        "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": "VTC Members Registry Consent — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "publishConsent",
+        "changed",
+        "registrySync",
+        "effectiveAt"
+      ],
+      "properties": {
+        "did": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The member whose consent this is: the document's signer."
+        },
+        "publishConsent": {
+          "type": "boolean",
+          "description": "The consent now recorded on the member record."
+        },
+        "changed": {
+          "type": "boolean",
+          "description": "Whether this document changed the recorded consent. `false` when the member restated the value already recorded."
+        },
+        "registrySync": {
+          "type": "string",
+          "enum": [
+            "queued",
+            "notConfigured",
+            "unchanged"
+          ],
+          "description": "What the community did about its trust registry. `queued`: a registry sync job carrying the change is queued (publication on a grant, removal on a withdrawal). `notConfigured`: the community publishes to no trust registry at present; the consent is recorded and governs any registry configured later. `unchanged`: nothing to sync, because the consent did not change, or because the community does not publish this member on other grounds (consent permits publication; it does not oblige it)."
+        },
+        "effectiveAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community recorded the consent now in force — this document's execution when `changed` is `true`, the earlier change otherwise."
+        },
+        "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;

package/src/vtc/members/update/0.1/payload.ts

@@ -20,7 +20,7 @@ export interface VTCMembersUpdatePayload {
    */
   label?: string | null;
   /**
-   * New directory-publish consent.
+   * New directory-publish consent. May only withdraw consent (`true` → `false`) or restate the current value; `true` for a member whose record does not already carry it is refused with `consentGrantForbidden`. Consent is the member's own, given by `registryConsent` on `vtc/join-requests/submit`.
    */
   publishConsent?: boolean;
   departurePreference?: "purge" | "tombstone" | "historical" | "policydefault";
@@ -89,7 +89,7 @@ export const PAYLOAD_SCHEMA = {
     },
     "publishConsent": {
       "type": "boolean",
-      "description": "New directory-publish consent."
+      "description": "New directory-publish consent. May only withdraw consent (`true` → `false`) or restate the current value; `true` for a member whose record does not already carry it is refused with `consentGrantForbidden`. Consent is the member's own, given by `registryConsent` on `vtc/join-requests/submit`."
     },
     "departurePreference": {
       "type": "string",

package/src/witness/_shared/0.1/outcome-evidence.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/witness/_shared/0.1/outcome-evidence.schema.json
+ */
+
+/**
+ * The outcome evidence of one witnessing session (SPEC §4.9.4): the witness/session document that opened it and the witness/session/submit #response that closed it, which together let a party outside the exchange pair a Verifiable Witness Credential with the session it cites. Defined once because more than one task carries it: the VTA that stores a VWC returns it (vta/witness/accept), and a holder presenting a VWC ships it beside the presentation (vtc/members/personhood/assert). Not itself a Trust Task specification: the `_shared` folder is skipped by the registry build and the codegen.
+ */
+export interface WitnessingOutcomeEvidenceSharedDefinitions {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { EvidenceDocument, OutcomeEvidence } from "../../../_shared/components.js";

package/src/witness/session/0.2/payload.ts

@@ -0,0 +1,197 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/witness/session/0.2/payload.schema.json
+ */
+
+import type { Ext } from "../../../_shared/components.js";
+
+
+/**
+ * Opens one participating party's witness session as its own exchange, nested in a relationship exchange via parentThreadId. A session is bilateral — a witnessed exchange between two parties runs two sessions with the same witness, each naming the same parties pair. The response issues the session challenge; the request document's id is the value that party's VWC later carries as taskContext.
+ */
+export interface WitnessSessionPayload {
+  /**
+   * The relationship DIDs of the exchange to be witnessed — the pairwise values the relationship proposal exchanged, in either order.
+   *
+   * @minItems 2
+   * @maxItems 2
+   */
+  parties: [string, string];
+  ext?: Ext;
+}
+/**
+ * The session challenge, issued under the REQUIRED proof. The presentation under witness/session/submit binds to {challenge, domain}. It reaches only the party that opened this session — which is why each party opens its own.
+ */
+export interface WitnessSessionResponsePayload {
+  /**
+   * A fresh, unpredictable, single-use value this session's presentation binds to. A witness MUST NOT reuse a challenge across sessions — including across the two sessions of one witnessed exchange, where a shared value would let either party's presentation satisfy the other's session.
+   */
+  challenge: string;
+  /**
+   * The domain the presentations bind alongside the challenge, identifying this witness's verification context.
+   */
+  domain: 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/witness/session/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = WitnessSessionPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/witness/session/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = WitnessSessionResponsePayload;
+
+/**
+ * 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/witness/session/0.2",
+  "title": "Witness Session — payload",
+  "description": "Opens one participating party's witness session as its own exchange, nested in a relationship exchange via parentThreadId. A session is bilateral — a witnessed exchange between two parties runs two sessions with the same witness, each naming the same parties pair. The response issues the session challenge; the request document's id is the value that party's VWC later carries as taskContext.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "parties"
+  ],
+  "properties": {
+    "parties": {
+      "type": "array",
+      "minItems": 2,
+      "maxItems": 2,
+      "items": {
+        "type": "string",
+        "pattern": "^did:"
+      },
+      "description": "The relationship DIDs of the exchange to be witnessed — the pairwise values the relationship proposal exchanged, in either order."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Witness Session — response payload",
+      "description": "The session challenge, issued under the REQUIRED proof. The presentation under witness/session/submit binds to {challenge, domain}. It reaches only the party that opened this session — which is why each party opens its own.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "challenge",
+        "domain"
+      ],
+      "properties": {
+        "challenge": {
+          "type": "string",
+          "minLength": 16,
+          "description": "A fresh, unpredictable, single-use value this session's presentation binds to. A witness MUST NOT reuse a challenge across sessions — including across the two sessions of one witnessed exchange, where a shared value would let either party's presentation satisfy the other's session."
+        },
+        "domain": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The domain the presentations bind alongside the challenge, identifying this witness's verification context."
+        },
+        "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": "Witness Session — response payload",
+      "description": "The session challenge, issued under the REQUIRED proof. The presentation under witness/session/submit binds to {challenge, domain}. It reaches only the party that opened this session — which is why each party opens its own.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "challenge",
+        "domain"
+      ],
+      "properties": {
+        "challenge": {
+          "type": "string",
+          "minLength": 16,
+          "description": "A fresh, unpredictable, single-use value this session's presentation binds to. A witness MUST NOT reuse a challenge across sessions — including across the two sessions of one witnessed exchange, where a shared value would let either party's presentation satisfy the other's session."
+        },
+        "domain": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The domain the presentations bind alongside the challenge, identifying this witness's verification context."
+        },
+        "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: false,
+  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;