@openvtc/trust-tasks 0.28.17 → 0.28.19

package/src/vtc/badges/images/get/0.1/payload.ts

@@ -0,0 +1,311 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/badges/images/get/0.1/payload.schema.json
+ */
+
+import type { BadgeId, CardBlobRef, Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * Read the bytes of a badge's picture, where the caller is an active member who may see the badge. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCBadgesImagesGetPayload {
+  badgeId: BadgeId;
+  /**
+   * The picture the caller expects, from the `CardBlobRef` it was shown on the badge. Where the badge now holds another, the answer is `notFound`, so a reader never shows a picture under a badge it did not come from.
+   */
+  sha256?: string;
+  ext?: Ext;
+}
+/**
+ * The success response to a vtc/badges/images/get/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/images/get/0.1#response.
+ */
+export interface VTCBadgesImagesGetResponsePayload {
+  /**
+   * The picture as stored, without `url` or `urlExpiresAt`.
+   */
+  image: CardBlobRef;
+  /**
+   * The stored bytes, base64url without padding. Their SHA-256 is `image.sha256`.
+   */
+  data: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { BadgeId, CardBlobRef, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/badges/images/get/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 = VTCBadgesImagesGetPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/badges/images/get/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCBadgesImagesGetResponsePayload;
+
+/**
+ * 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/images/get/0.1",
+  "title": "VTC Badges — Images — Get — payload",
+  "description": "Read the bytes of a badge's picture, where the caller is an active member who may see the badge. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "badgeId"
+  ],
+  "properties": {
+    "badgeId": {
+      "$ref": "#/$defs/BadgeId"
+    },
+    "sha256": {
+      "type": "string",
+      "pattern": "^[0-9a-f]{64}$",
+      "description": "The picture the caller expects, from the `CardBlobRef` it was shown on the badge. Where the badge now holds another, the answer is `notFound`, so a reader never shows a picture under a badge it did not come from."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Badges — Images — Get — response payload",
+      "description": "The success response to a vtc/badges/images/get/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/images/get/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "image",
+        "data"
+      ],
+      "properties": {
+        "image": {
+          "$ref": "#/$defs/CardBlobRef",
+          "description": "The picture as stored, without `url` or `urlExpiresAt`."
+        },
+        "data": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 349526,
+          "pattern": "^[A-Za-z0-9_-]+$",
+          "description": "The stored bytes, base64url without padding. Their SHA-256 is `image.sha256`."
+        },
+        "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-]+)+$"
+      }
+    },
+    "CardBlobRef": {
+      "title": "CardBlobRef",
+      "description": "A content-addressed image held in the community's blob store — an avatar or an `image` field. At most 256 KiB, images only, re-encoded by the community on upload (vtc/directory/images/upload: metadata stripped, dimensions capped) so its digest does not link the member across communities. A viewer reads the bytes with vtc/directory/images/get, which answers only where the same projection shows the value. `url` and `urlExpiresAt` MAY appear in a projection: a short-lived URL the community checks against the same projection, so a member-only image is never a public URL. A community that does not offer one leaves both out.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sha256",
+        "mediaType"
+      ],
+      "properties": {
+        "sha256": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{64}$",
+          "description": "Lowercase hex SHA-256 of the stored, re-encoded bytes."
+        },
+        "mediaType": {
+          "type": "string",
+          "enum": [
+            "image/png",
+            "image/jpeg",
+            "image/webp",
+            "image/avif"
+          ],
+          "description": "Media type of the stored bytes."
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 262144,
+          "description": "Size in bytes of the stored bytes."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Projection only: a URL the viewer can fetch the image from until `urlExpiresAt`."
+        },
+        "urlExpiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Projection only: when `url` stops working."
+        }
+      }
+    },
+    "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}$"
+    }
+  }
+} 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 — Images — Get — response payload",
+      "description": "The success response to a vtc/badges/images/get/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/images/get/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "image",
+        "data"
+      ],
+      "properties": {
+        "image": {
+          "$ref": "#/$defs/CardBlobRef",
+          "description": "The picture as stored, without `url` or `urlExpiresAt`."
+        },
+        "data": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 349526,
+          "pattern": "^[A-Za-z0-9_-]+$",
+          "description": "The stored bytes, base64url without padding. Their SHA-256 is `image.sha256`."
+        },
+        "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-]+)+$"
+      }
+    },
+    "CardBlobRef": {
+      "title": "CardBlobRef",
+      "description": "A content-addressed image held in the community's blob store — an avatar or an `image` field. At most 256 KiB, images only, re-encoded by the community on upload (vtc/directory/images/upload: metadata stripped, dimensions capped) so its digest does not link the member across communities. A viewer reads the bytes with vtc/directory/images/get, which answers only where the same projection shows the value. `url` and `urlExpiresAt` MAY appear in a projection: a short-lived URL the community checks against the same projection, so a member-only image is never a public URL. A community that does not offer one leaves both out.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sha256",
+        "mediaType"
+      ],
+      "properties": {
+        "sha256": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{64}$",
+          "description": "Lowercase hex SHA-256 of the stored, re-encoded bytes."
+        },
+        "mediaType": {
+          "type": "string",
+          "enum": [
+            "image/png",
+            "image/jpeg",
+            "image/webp",
+            "image/avif"
+          ],
+          "description": "Media type of the stored bytes."
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 262144,
+          "description": "Size in bytes of the stored bytes."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Projection only: a URL the viewer can fetch the image from until `urlExpiresAt`."
+        },
+        "urlExpiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Projection only: when `url` stops working."
+        }
+      }
+    },
+    "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}$"
+    }
+  }
+} 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/vtc/badges/images/upload/0.1/payload.ts

@@ -0,0 +1,324 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/badges/images/upload/0.1/payload.schema.json
+ */
+
+import type { CardBlobRef, Ext, ImageMediaType } from "../../../../../_shared/components.js";
+
+
+/**
+ * A badge administrator, owner or member hands the community the picture for a badge. The community re-encodes it and answers the reference a badge holds. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCBadgesImagesUploadPayload {
+  /**
+   * The media type of `data` as sent. The community may store another: it re-encodes.
+   */
+  mediaType: ImageMediaType;
+  /**
+   * The image, base64url without padding (RFC 4648 §5). At most 262144 bytes decoded.
+   */
+  data: string;
+  ext?: Ext;
+}
+/**
+ * The success response to a vtc/badges/images/upload/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/images/upload/0.1#response.
+ */
+export interface VTCBadgesImagesUploadResponsePayload {
+  /**
+   * The stored, re-encoded image, without `url` or `urlExpiresAt`. A badge holds this as its picture; the signer names its `sha256` in vtc/badges/create, update or promote.
+   */
+  image: CardBlobRef;
+  /**
+   * When the community erases the image if no badge holds it by then.
+   */
+  expiresAt: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CardBlobRef, Ext, ImageMediaType };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/badges/images/upload/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 = VTCBadgesImagesUploadPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/badges/images/upload/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCBadgesImagesUploadResponsePayload;
+
+/**
+ * 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/images/upload/0.1",
+  "title": "VTC Badges — Images — Upload — payload",
+  "description": "A badge administrator, owner or member hands the community the picture for a badge. The community re-encodes it and answers the reference a badge holds. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "mediaType",
+    "data"
+  ],
+  "properties": {
+    "mediaType": {
+      "$ref": "#/$defs/ImageMediaType",
+      "description": "The media type of `data` as sent. The community may store another: it re-encodes."
+    },
+    "data": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 349526,
+      "pattern": "^[A-Za-z0-9_-]+$",
+      "description": "The image, base64url without padding (RFC 4648 §5). At most 262144 bytes decoded."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Badges — Images — Upload — response payload",
+      "description": "The success response to a vtc/badges/images/upload/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/images/upload/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "image",
+        "expiresAt"
+      ],
+      "properties": {
+        "image": {
+          "$ref": "#/$defs/CardBlobRef",
+          "description": "The stored, re-encoded image, without `url` or `urlExpiresAt`. A badge holds this as its picture; the signer names its `sha256` in vtc/badges/create, update or promote."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community erases the image if no badge holds it by then."
+        },
+        "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-]+)+$"
+      }
+    },
+    "CardBlobRef": {
+      "title": "CardBlobRef",
+      "description": "A content-addressed image held in the community's blob store — an avatar or an `image` field. At most 256 KiB, images only, re-encoded by the community on upload (vtc/directory/images/upload: metadata stripped, dimensions capped) so its digest does not link the member across communities. A viewer reads the bytes with vtc/directory/images/get, which answers only where the same projection shows the value. `url` and `urlExpiresAt` MAY appear in a projection: a short-lived URL the community checks against the same projection, so a member-only image is never a public URL. A community that does not offer one leaves both out.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sha256",
+        "mediaType"
+      ],
+      "properties": {
+        "sha256": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{64}$",
+          "description": "Lowercase hex SHA-256 of the stored, re-encoded bytes."
+        },
+        "mediaType": {
+          "type": "string",
+          "enum": [
+            "image/png",
+            "image/jpeg",
+            "image/webp",
+            "image/avif"
+          ],
+          "description": "Media type of the stored bytes."
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 262144,
+          "description": "Size in bytes of the stored bytes."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Projection only: a URL the viewer can fetch the image from until `urlExpiresAt`."
+        },
+        "urlExpiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Projection only: when `url` stops working."
+        }
+      }
+    },
+    "ImageMediaType": {
+      "title": "ImageMediaType",
+      "description": "The media types a directory image may have — those a `CardBlobRef` admits.",
+      "type": "string",
+      "enum": [
+        "image/png",
+        "image/jpeg",
+        "image/webp",
+        "image/avif"
+      ]
+    }
+  }
+} 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 — Images — Upload — response payload",
+      "description": "The success response to a vtc/badges/images/upload/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/badges/images/upload/0.1#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "image",
+        "expiresAt"
+      ],
+      "properties": {
+        "image": {
+          "$ref": "#/$defs/CardBlobRef",
+          "description": "The stored, re-encoded image, without `url` or `urlExpiresAt`. A badge holds this as its picture; the signer names its `sha256` in vtc/badges/create, update or promote."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the community erases the image if no badge holds it by then."
+        },
+        "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-]+)+$"
+      }
+    },
+    "CardBlobRef": {
+      "title": "CardBlobRef",
+      "description": "A content-addressed image held in the community's blob store — an avatar or an `image` field. At most 256 KiB, images only, re-encoded by the community on upload (vtc/directory/images/upload: metadata stripped, dimensions capped) so its digest does not link the member across communities. A viewer reads the bytes with vtc/directory/images/get, which answers only where the same projection shows the value. `url` and `urlExpiresAt` MAY appear in a projection: a short-lived URL the community checks against the same projection, so a member-only image is never a public URL. A community that does not offer one leaves both out.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "sha256",
+        "mediaType"
+      ],
+      "properties": {
+        "sha256": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{64}$",
+          "description": "Lowercase hex SHA-256 of the stored, re-encoded bytes."
+        },
+        "mediaType": {
+          "type": "string",
+          "enum": [
+            "image/png",
+            "image/jpeg",
+            "image/webp",
+            "image/avif"
+          ],
+          "description": "Media type of the stored bytes."
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 262144,
+          "description": "Size in bytes of the stored bytes."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048,
+          "description": "Projection only: a URL the viewer can fetch the image from until `urlExpiresAt`."
+        },
+        "urlExpiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Projection only: when `url` stops working."
+        }
+      }
+    },
+    "ImageMediaType": {
+      "title": "ImageMediaType",
+      "description": "The media types a directory image may have — those a `CardBlobRef` admits.",
+      "type": "string",
+      "enum": [
+        "image/png",
+        "image/jpeg",
+        "image/webp",
+        "image/avif"
+      ]
+    }
+  }
+} 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;