@openvtc/trust-tasks 0.28.21 → 0.28.22

package/src/vtc/badges/claims/create/0.1/payload.ts

@@ -0,0 +1,395 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/badges/claims/create/0.1/payload.schema.json
+ */
+
+import type { BadgeId, ClaimCode, ClaimId, ClaimSecret, EntryId, Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * Issue a claim code for a community badge: the community answers the code, once. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCBadgesClaimsCreatePayload {
+  badgeId: BadgeId;
+  /**
+   * What the code is for — the event, say.
+   */
+  label: string;
+  /**
+   * After this the code admits no one. At most 90 days ahead.
+   */
+  validUntil: string;
+  /**
+   * How many claims the code admits.
+   */
+  limit: number;
+  ext?: Ext;
+}
+/**
+ * The success response to a vtc/badges/claims/create/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/claims/create/0.1#response.
+ */
+export interface VTCBadgesClaimsCreateResponsePayload {
+  claim: ClaimCode;
+  /**
+   * The code, answered this once. The community keeps only its digest.
+   */
+  code: ClaimSecret;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { BadgeId, ClaimCode, ClaimId, ClaimSecret, EntryId, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/badges/claims/create/0.1" as const;
+
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS: string | null = null;
+
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCBadgesClaimsCreatePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/badges/claims/create/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCBadgesClaimsCreateResponsePayload;
+
+/**
+ * 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/badges/claims/create/0.1",
+  "title": "VTC Badges — Claims — Create — payload",
+  "description": "Issue a claim code for a community badge: the community answers the code, once. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "badgeId",
+    "label",
+    "validUntil",
+    "limit"
+  ],
+  "properties": {
+    "badgeId": {
+      "$ref": "#/$defs/BadgeId"
+    },
+    "label": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 120,
+      "description": "What the code is for — the event, say."
+    },
+    "validUntil": {
+      "type": "string",
+      "format": "date-time",
+      "description": "After this the code admits no one. At most 90 days ahead."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 10000,
+      "description": "How many claims the code admits."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Badges — Claims — Create — response payload",
+      "description": "The success response to a vtc/badges/claims/create/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/claims/create/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "claim",
+        "code"
+      ],
+      "properties": {
+        "claim": {
+          "$ref": "#/$defs/ClaimCode"
+        },
+        "code": {
+          "$ref": "#/$defs/ClaimSecret",
+          "description": "The code, answered this once. The community keeps only its digest."
+        },
+        "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-]+)+$"
+      }
+    },
+    "ClaimSecret": {
+      "title": "ClaimSecret",
+      "description": "A claim code itself: at least 128 random bits the community generated, base64url (22 to 64 characters). A bearer secret: shown to its issuer once, redeemed by a member, never stored or answered again (VTI-BDG-025).",
+      "type": "string",
+      "pattern": "^[A-Za-z0-9_-]{22,64}$"
+    },
+    "ClaimCode": {
+      "title": "ClaimCode",
+      "description": "A claim code's record, as the badge's owners and administrators see it: never the code (VTI-BDG-027).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "claimId",
+        "badgeId",
+        "label",
+        "validUntil",
+        "limit",
+        "claims",
+        "state",
+        "createdAt"
+      ],
+      "properties": {
+        "claimId": {
+          "$ref": "#/$defs/ClaimId"
+        },
+        "badgeId": {
+          "$ref": "#/$defs/BadgeId"
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 120,
+          "description": "What the code is for — the event, say — shown to the badge's owners. Never shown to whoever redeems it."
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "After this the code admits no one."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 10000,
+          "description": "How many claims the code admits."
+        },
+        "claims": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many members have redeemed it."
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "active",
+            "withdrawn"
+          ],
+          "description": "`withdrawn` once its issuer withdrew it or the badge was retired. A code past `validUntil` or out of claims stays `active` and admits no one."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "createdBy": {
+          "$ref": "#/$defs/EntryId",
+          "description": "The issuer's entry, where they have one; the giver of every award the code admits."
+        }
+      }
+    },
+    "BadgeId": {
+      "title": "BadgeId",
+      "description": "Opaque identifier of a badge: `bdg_` followed by 16 to 64 base64url characters. Random, community-scoped, never reused (VTI-BDG-001).",
+      "type": "string",
+      "pattern": "^bdg_[A-Za-z0-9_-]{16,64}$"
+    },
+    "ClaimId": {
+      "title": "ClaimId",
+      "description": "Opaque identifier of a claim code's record: `bcl_` followed by 16 to 64 base64url characters. Random; never the code itself, which the community keeps only as a digest (VTI-BDG-025).",
+      "type": "string",
+      "pattern": "^bcl_[A-Za-z0-9_-]{16,64}$"
+    },
+    "EntryId": {
+      "title": "EntryId",
+      "description": "Opaque identifier of one directory entry: `dir_` followed by 16 to 64 base64url characters. Random, scoped to one community, and stable for the life of the membership — it survives a rotation of the member's DID, which is why groups, notes and cards are keyed by it. It MUST NOT be derived from, and MUST NOT reveal, any DID of the member, and the same person's entries in two communities MUST NOT share one. Compared by exact string equality.",
+      "type": "string",
+      "pattern": "^dir_[A-Za-z0-9_-]{16,64}$"
+    }
+  }
+} 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 Badges — Claims — Create — response payload",
+      "description": "The success response to a vtc/badges/claims/create/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/claims/create/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "claim",
+        "code"
+      ],
+      "properties": {
+        "claim": {
+          "$ref": "#/$defs/ClaimCode"
+        },
+        "code": {
+          "$ref": "#/$defs/ClaimSecret",
+          "description": "The code, answered this once. The community keeps only its digest."
+        },
+        "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-]+)+$"
+      }
+    },
+    "ClaimSecret": {
+      "title": "ClaimSecret",
+      "description": "A claim code itself: at least 128 random bits the community generated, base64url (22 to 64 characters). A bearer secret: shown to its issuer once, redeemed by a member, never stored or answered again (VTI-BDG-025).",
+      "type": "string",
+      "pattern": "^[A-Za-z0-9_-]{22,64}$"
+    },
+    "ClaimCode": {
+      "title": "ClaimCode",
+      "description": "A claim code's record, as the badge's owners and administrators see it: never the code (VTI-BDG-027).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "claimId",
+        "badgeId",
+        "label",
+        "validUntil",
+        "limit",
+        "claims",
+        "state",
+        "createdAt"
+      ],
+      "properties": {
+        "claimId": {
+          "$ref": "#/$defs/ClaimId"
+        },
+        "badgeId": {
+          "$ref": "#/$defs/BadgeId"
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 120,
+          "description": "What the code is for — the event, say — shown to the badge's owners. Never shown to whoever redeems it."
+        },
+        "validUntil": {
+          "type": "string",
+          "format": "date-time",
+          "description": "After this the code admits no one."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 10000,
+          "description": "How many claims the code admits."
+        },
+        "claims": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many members have redeemed it."
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "active",
+            "withdrawn"
+          ],
+          "description": "`withdrawn` once its issuer withdrew it or the badge was retired. A code past `validUntil` or out of claims stays `active` and admits no one."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "createdBy": {
+          "$ref": "#/$defs/EntryId",
+          "description": "The issuer's entry, where they have one; the giver of every award the code admits."
+        }
+      }
+    },
+    "BadgeId": {
+      "title": "BadgeId",
+      "description": "Opaque identifier of a badge: `bdg_` followed by 16 to 64 base64url characters. Random, community-scoped, never reused (VTI-BDG-001).",
+      "type": "string",
+      "pattern": "^bdg_[A-Za-z0-9_-]{16,64}$"
+    },
+    "ClaimId": {
+      "title": "ClaimId",
+      "description": "Opaque identifier of a claim code's record: `bcl_` followed by 16 to 64 base64url characters. Random; never the code itself, which the community keeps only as a digest (VTI-BDG-025).",
+      "type": "string",
+      "pattern": "^bcl_[A-Za-z0-9_-]{16,64}$"
+    },
+    "EntryId": {
+      "title": "EntryId",
+      "description": "Opaque identifier of one directory entry: `dir_` followed by 16 to 64 base64url characters. Random, scoped to one community, and stable for the life of the membership — it survives a rotation of the member's DID, which is why groups, notes and cards are keyed by it. It MUST NOT be derived from, and MUST NOT reveal, any DID of the member, and the same person's entries in two communities MUST NOT share one. Compared by exact string equality.",
+      "type": "string",
+      "pattern": "^dir_[A-Za-z0-9_-]{16,64}$"
+    }
+  }
+} 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;