@openvtc/trust-tasks 0.12.11 → 0.12.12

package/src/vtc/join-requests/submit/0.2/payload.ts

@@ -0,0 +1,409 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/join-requests/submit/0.2/payload.schema.json
+ */
+
+/**
+ * What the policy decided.
+ *
+ * `allow` — admitted. `deny` — refused, terminally for this submission. `refer` — parked for a human or quorum decision; the applicant is neither in nor out. `requestMore` — the policy cannot decide yet and names what further evidence it needs.
+ *
+ * The four are not reducible to a pending/decided pair. `refer` and `requestMore` are both 'not decided', but they place the next action with different parties: `refer` waits on the community, `requestMore` waits on the applicant. A consumer that cannot tell them apart cannot tell a user whether to wait or to act.
+ */
+export type VerdictEffect = "allow" | "deny" | "refer" | "requestMore";
+
+export interface VTCJoinRequestsSubmitPayload {
+  /**
+   * The applicant's W3C Verifiable Presentation (opaque here), satisfying the community's join policy. The applicant DID is the document proof's signer — not a payload field.
+   */
+  vp: {};
+  /**
+   * Whether the applicant consents to trust-registry publication.
+   */
+  registryConsent?: boolean;
+  /**
+   * Opaque applicant-supplied extension bag.
+   */
+  extensions?: {};
+  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;
+}
+export interface VTCJoinRequestsSubmitResponsePayload {
+  /**
+   * Id of the created join request (a UUID).
+   */
+  requestId: string;
+  verdict: Verdict;
+  ext?: Ext;
+}
+/**
+ * What the community decided about this submission.
+ *
+ * `0.1` returned `status: "pending"` — a constant, which could express only one of the four outcomes a submission actually has. A policy that admits outright, refuses outright, or asks for more evidence had to be reported as 'pending' or not at all.
+ */
+export interface Verdict {
+  effect: VerdictEffect;
+  with: VerdictWith;
+}
+/**
+ * The effect-dependent detail of a verdict.
+ *
+ * Every member is optional at the schema level and which ones are meaningful depends on `effect`: `role` / `obligations` / `bundleRef` on `allow`, `code` / `reason` on `deny`, `queue` / `reason` on `refer`, `needs` / `presentationDefinition` on `requestMore`. The dependency is stated here rather than enforced by `if`/`then` per effect, so that the shape stays a single flat object a generated type can carry without a discriminated union per family — a deliberate trade of schema strictness for implementability, and the reason a consumer MUST branch on `effect` rather than on which members happen to be present.
+ */
+export interface VerdictWith {
+  /**
+   * The granted local role. `allow` only.
+   */
+  role?: string;
+  /**
+   * Conditions attached to the grant. `allow` only.
+   */
+  obligations?: {};
+  /**
+   * Pointer to a sealed credential bundle, added by the community where issuance occurred rather than emitted by the policy. `allow` only.
+   */
+  bundleRef?: {};
+  /**
+   * Stable refusal code, safe to branch on. `deny` only.
+   */
+  code?: string;
+  /**
+   * Elaboration in prose, when the decider gave one. `deny` and `refer`.
+   */
+  reason?: string | null;
+  /**
+   * Which review queue the decision was parked in, so an applicant can be told who now holds it. `refer` only.
+   */
+  queue?: string;
+  /**
+   * What further evidence is required, named so the applicant can act without a support conversation. `requestMore` only.
+   */
+  needs?: string[];
+  /**
+   * A machine-readable statement of the same request, so a wallet can satisfy it without a human reading `needs`. `requestMore` only.
+   */
+  presentationDefinition?: {};
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/submit/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCJoinRequestsSubmitPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/join-requests/submit/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCJoinRequestsSubmitResponsePayload;
+
+/**
+ * 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/join-requests/submit/0.2",
+  "title": "VTC Join-Requests Submit — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "vp"
+  ],
+  "properties": {
+    "vp": {
+      "type": "object",
+      "description": "The applicant's W3C Verifiable Presentation (opaque here), satisfying the community's join policy. The applicant DID is the document proof's signer — not a payload field."
+    },
+    "registryConsent": {
+      "type": "boolean",
+      "description": "Whether the applicant consents to trust-registry publication."
+    },
+    "extensions": {
+      "type": "object",
+      "description": "Opaque applicant-supplied extension bag."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Join-Requests Submit — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requestId",
+        "verdict"
+      ],
+      "properties": {
+        "requestId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Id of the created join request (a UUID)."
+        },
+        "verdict": {
+          "$ref": "#/$defs/Verdict",
+          "description": "What the community decided about this submission.\n\n`0.1` returned `status: \"pending\"` — a constant, which could express only one of the four outcomes a submission actually has. A policy that admits outright, refuses outright, or asks for more evidence had to be reported as 'pending' or not at all."
+        },
+        "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-]+)+$"
+      }
+    },
+    "Verdict": {
+      "$anchor": "verdict",
+      "title": "Verdict",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "effect",
+        "with"
+      ],
+      "description": "A ceremony decision: the effect, plus its effect-dependent detail.",
+      "properties": {
+        "effect": {
+          "$ref": "#/$defs/VerdictEffect"
+        },
+        "with": {
+          "$ref": "#/$defs/VerdictWith"
+        }
+      }
+    },
+    "VerdictWith": {
+      "$anchor": "verdictWith",
+      "title": "VerdictWith",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "The effect-dependent detail of a verdict.\n\nEvery member is optional at the schema level and which ones are meaningful depends on `effect`: `role` / `obligations` / `bundleRef` on `allow`, `code` / `reason` on `deny`, `queue` / `reason` on `refer`, `needs` / `presentationDefinition` on `requestMore`. The dependency is stated here rather than enforced by `if`/`then` per effect, so that the shape stays a single flat object a generated type can carry without a discriminated union per family — a deliberate trade of schema strictness for implementability, and the reason a consumer MUST branch on `effect` rather than on which members happen to be present.",
+      "properties": {
+        "role": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The granted local role. `allow` only."
+        },
+        "obligations": {
+          "type": "object",
+          "description": "Conditions attached to the grant. `allow` only."
+        },
+        "bundleRef": {
+          "type": "object",
+          "description": "Pointer to a sealed credential bundle, added by the community where issuance occurred rather than emitted by the policy. `allow` only."
+        },
+        "code": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Stable refusal code, safe to branch on. `deny` only."
+        },
+        "reason": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Elaboration in prose, when the decider gave one. `deny` and `refer`."
+        },
+        "queue": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Which review queue the decision was parked in, so an applicant can be told who now holds it. `refer` only."
+        },
+        "needs": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "What further evidence is required, named so the applicant can act without a support conversation. `requestMore` only."
+        },
+        "presentationDefinition": {
+          "type": "object",
+          "description": "A machine-readable statement of the same request, so a wallet can satisfy it without a human reading `needs`. `requestMore` only."
+        }
+      }
+    },
+    "VerdictEffect": {
+      "$anchor": "verdictEffect",
+      "title": "VerdictEffect",
+      "type": "string",
+      "enum": [
+        "allow",
+        "deny",
+        "refer",
+        "requestMore"
+      ],
+      "description": "What the policy decided.\n\n`allow` — admitted. `deny` — refused, terminally for this submission. `refer` — parked for a human or quorum decision; the applicant is neither in nor out. `requestMore` — the policy cannot decide yet and names what further evidence it needs.\n\nThe four are not reducible to a pending/decided pair. `refer` and `requestMore` are both 'not decided', but they place the next action with different parties: `refer` waits on the community, `requestMore` waits on the applicant. A consumer that cannot tell them apart cannot tell a user whether to wait or to act."
+    }
+  }
+} 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 Join-Requests Submit — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requestId",
+        "verdict"
+      ],
+      "properties": {
+        "requestId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Id of the created join request (a UUID)."
+        },
+        "verdict": {
+          "$ref": "#/$defs/Verdict",
+          "description": "What the community decided about this submission.\n\n`0.1` returned `status: \"pending\"` — a constant, which could express only one of the four outcomes a submission actually has. A policy that admits outright, refuses outright, or asks for more evidence had to be reported as 'pending' or not at all."
+        },
+        "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-]+)+$"
+      }
+    },
+    "Verdict": {
+      "$anchor": "verdict",
+      "title": "Verdict",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "effect",
+        "with"
+      ],
+      "description": "A ceremony decision: the effect, plus its effect-dependent detail.",
+      "properties": {
+        "effect": {
+          "$ref": "#/$defs/VerdictEffect"
+        },
+        "with": {
+          "$ref": "#/$defs/VerdictWith"
+        }
+      }
+    },
+    "VerdictWith": {
+      "$anchor": "verdictWith",
+      "title": "VerdictWith",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "The effect-dependent detail of a verdict.\n\nEvery member is optional at the schema level and which ones are meaningful depends on `effect`: `role` / `obligations` / `bundleRef` on `allow`, `code` / `reason` on `deny`, `queue` / `reason` on `refer`, `needs` / `presentationDefinition` on `requestMore`. The dependency is stated here rather than enforced by `if`/`then` per effect, so that the shape stays a single flat object a generated type can carry without a discriminated union per family — a deliberate trade of schema strictness for implementability, and the reason a consumer MUST branch on `effect` rather than on which members happen to be present.",
+      "properties": {
+        "role": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The granted local role. `allow` only."
+        },
+        "obligations": {
+          "type": "object",
+          "description": "Conditions attached to the grant. `allow` only."
+        },
+        "bundleRef": {
+          "type": "object",
+          "description": "Pointer to a sealed credential bundle, added by the community where issuance occurred rather than emitted by the policy. `allow` only."
+        },
+        "code": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Stable refusal code, safe to branch on. `deny` only."
+        },
+        "reason": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Elaboration in prose, when the decider gave one. `deny` and `refer`."
+        },
+        "queue": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Which review queue the decision was parked in, so an applicant can be told who now holds it. `refer` only."
+        },
+        "needs": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "What further evidence is required, named so the applicant can act without a support conversation. `requestMore` only."
+        },
+        "presentationDefinition": {
+          "type": "object",
+          "description": "A machine-readable statement of the same request, so a wallet can satisfy it without a human reading `needs`. `requestMore` only."
+        }
+      }
+    },
+    "VerdictEffect": {
+      "$anchor": "verdictEffect",
+      "title": "VerdictEffect",
+      "type": "string",
+      "enum": [
+        "allow",
+        "deny",
+        "refer",
+        "requestMore"
+      ],
+      "description": "What the policy decided.\n\n`allow` — admitted. `deny` — refused, terminally for this submission. `refer` — parked for a human or quorum decision; the applicant is neither in nor out. `requestMore` — the policy cannot decide yet and names what further evidence it needs.\n\nThe four are not reducible to a pending/decided pair. `refer` and `requestMore` are both 'not decided', but they place the next action with different parties: `refer` waits on the community, `requestMore` waits on the applicant. A consumer that cannot tell them apart cannot tell a user whether to wait or to act."
+    }
+  }
+} 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;