@openvtc/trust-tasks 0.26.17 → 0.26.19

package/dist/vtc/directory/images/upload/0.1/payload.d.ts

@@ -0,0 +1,441 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/directory/images/upload/0.1/payload.schema.json
+ */
+import type { CardBlobRef, Ext, ImageMediaType } from "../../../../../_shared/components.js";
+/**
+ * A member, or a directory administrator, hands the community an image for a directory card — an avatar or an `image` field. The community re-encodes it and answers the reference a card holds. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCDirectoryImagesUploadPayload {
+    /**
+     * 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/directory/images/upload/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/images/upload/0.1#response.
+ */
+export interface VTCDirectoryImagesUploadResponsePayload {
+    /**
+     * The stored, re-encoded image, without `url` or `urlExpiresAt`. A card holds this as the field's value.
+     */
+    image: CardBlobRef;
+    /**
+     * When the community erases the image if no card 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 declare const TYPE_URI: "https://trusttasks.org/spec/vtc/directory/images/upload/0.1";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCDirectoryImagesUploadPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtc/directory/images/upload/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCDirectoryImagesUploadResponsePayload;
+/**
+ * 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/vtc/directory/images/upload/0.1";
+    readonly title: "VTC Directory — Images — Upload — payload";
+    readonly description: "A member, or a directory administrator, hands the community an image for a directory card — an avatar or an `image` field. The community re-encodes it and answers the reference a card holds. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["mediaType", "data"];
+    readonly properties: {
+        readonly mediaType: {
+            readonly $ref: "#/$defs/ImageMediaType";
+            readonly description: "The media type of `data` as sent. The community may store another: it re-encodes.";
+        };
+        readonly data: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 349526;
+            readonly pattern: "^[A-Za-z0-9_-]+$";
+            readonly description: "The image, base64url without padding (RFC 4648 §5). At most 262144 bytes decoded.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Directory — Images — Upload — response payload";
+            readonly description: "The success response to a vtc/directory/images/upload/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/images/upload/0.1#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["image", "expiresAt"];
+            readonly properties: {
+                readonly image: {
+                    readonly $ref: "#/$defs/CardBlobRef";
+                    readonly description: "The stored, re-encoded image, without `url` or `urlExpiresAt`. A card holds this as the field's value.";
+                };
+                readonly expiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the community erases the image if no card holds it by then.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly CardBlobRef: {
+            readonly title: "CardBlobRef";
+            readonly 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.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["sha256", "mediaType"];
+            readonly properties: {
+                readonly sha256: {
+                    readonly type: "string";
+                    readonly pattern: "^[0-9a-f]{64}$";
+                    readonly description: "Lowercase hex SHA-256 of the stored, re-encoded bytes.";
+                };
+                readonly mediaType: {
+                    readonly type: "string";
+                    readonly enum: readonly ["image/png", "image/jpeg", "image/webp", "image/avif"];
+                    readonly description: "Media type of the stored bytes.";
+                };
+                readonly size: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly maximum: 262144;
+                    readonly description: "Size in bytes of the stored bytes.";
+                };
+                readonly url: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "Projection only: a URL the viewer can fetch the image from until `urlExpiresAt`.";
+                };
+                readonly urlExpiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Projection only: when `url` stops working.";
+                };
+            };
+        };
+        readonly ImageMediaType: {
+            readonly title: "ImageMediaType";
+            readonly description: "The media types a directory image may have — those a `CardBlobRef` admits.";
+            readonly type: "string";
+            readonly enum: readonly ["image/png", "image/jpeg", "image/webp", "image/avif"];
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTC Directory — Images — Upload — response payload";
+            readonly description: "The success response to a vtc/directory/images/upload/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/images/upload/0.1#response.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["image", "expiresAt"];
+            readonly properties: {
+                readonly image: {
+                    readonly $ref: "#/$defs/CardBlobRef";
+                    readonly description: "The stored, re-encoded image, without `url` or `urlExpiresAt`. A card holds this as the field's value.";
+                };
+                readonly expiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When the community erases the image if no card holds it by then.";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly CardBlobRef: {
+            readonly title: "CardBlobRef";
+            readonly 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.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["sha256", "mediaType"];
+            readonly properties: {
+                readonly sha256: {
+                    readonly type: "string";
+                    readonly pattern: "^[0-9a-f]{64}$";
+                    readonly description: "Lowercase hex SHA-256 of the stored, re-encoded bytes.";
+                };
+                readonly mediaType: {
+                    readonly type: "string";
+                    readonly enum: readonly ["image/png", "image/jpeg", "image/webp", "image/avif"];
+                    readonly description: "Media type of the stored bytes.";
+                };
+                readonly size: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                    readonly maximum: 262144;
+                    readonly description: "Size in bytes of the stored bytes.";
+                };
+                readonly url: {
+                    readonly type: "string";
+                    readonly format: "uri";
+                    readonly maxLength: 2048;
+                    readonly description: "Projection only: a URL the viewer can fetch the image from until `urlExpiresAt`.";
+                };
+                readonly urlExpiresAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Projection only: when `url` stops working.";
+                };
+            };
+        };
+        readonly ImageMediaType: {
+            readonly title: "ImageMediaType";
+            readonly description: "The media types a directory image may have — those a `CardBlobRef` admits.";
+            readonly type: "string";
+            readonly enum: readonly ["image/png", "image/jpeg", "image/webp", "image/avif"];
+        };
+    };
+};
+/**
+ * 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 declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtc/directory/images/upload/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vtc/directory/images/upload/0.1";
+        readonly title: "VTC Directory — Images — Upload — payload";
+        readonly description: "A member, or a directory administrator, hands the community an image for a directory card — an avatar or an `image` field. The community re-encodes it and answers the reference a card holds. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["mediaType", "data"];
+        readonly properties: {
+            readonly mediaType: {
+                readonly $ref: "#/$defs/ImageMediaType";
+                readonly description: "The media type of `data` as sent. The community may store another: it re-encodes.";
+            };
+            readonly data: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 349526;
+                readonly pattern: "^[A-Za-z0-9_-]+$";
+                readonly description: "The image, base64url without padding (RFC 4648 §5). At most 262144 bytes decoded.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Directory — Images — Upload — response payload";
+                readonly description: "The success response to a vtc/directory/images/upload/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/images/upload/0.1#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["image", "expiresAt"];
+                readonly properties: {
+                    readonly image: {
+                        readonly $ref: "#/$defs/CardBlobRef";
+                        readonly description: "The stored, re-encoded image, without `url` or `urlExpiresAt`. A card holds this as the field's value.";
+                    };
+                    readonly expiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the community erases the image if no card holds it by then.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly CardBlobRef: {
+                readonly title: "CardBlobRef";
+                readonly 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.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["sha256", "mediaType"];
+                readonly properties: {
+                    readonly sha256: {
+                        readonly type: "string";
+                        readonly pattern: "^[0-9a-f]{64}$";
+                        readonly description: "Lowercase hex SHA-256 of the stored, re-encoded bytes.";
+                    };
+                    readonly mediaType: {
+                        readonly type: "string";
+                        readonly enum: readonly ["image/png", "image/jpeg", "image/webp", "image/avif"];
+                        readonly description: "Media type of the stored bytes.";
+                    };
+                    readonly size: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly maximum: 262144;
+                        readonly description: "Size in bytes of the stored bytes.";
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "Projection only: a URL the viewer can fetch the image from until `urlExpiresAt`.";
+                    };
+                    readonly urlExpiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Projection only: when `url` stops working.";
+                    };
+                };
+            };
+            readonly ImageMediaType: {
+                readonly title: "ImageMediaType";
+                readonly description: "The media types a directory image may have — those a `CardBlobRef` admits.";
+                readonly type: "string";
+                readonly enum: readonly ["image/png", "image/jpeg", "image/webp", "image/avif"];
+            };
+        };
+    };
+};
+/**
+ * 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 declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtc/directory/images/upload/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTC Directory — Images — Upload — response payload";
+                readonly description: "The success response to a vtc/directory/images/upload/0.1 request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vtc/directory/images/upload/0.1#response.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["image", "expiresAt"];
+                readonly properties: {
+                    readonly image: {
+                        readonly $ref: "#/$defs/CardBlobRef";
+                        readonly description: "The stored, re-encoded image, without `url` or `urlExpiresAt`. A card holds this as the field's value.";
+                    };
+                    readonly expiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the community erases the image if no card holds it by then.";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly CardBlobRef: {
+                readonly title: "CardBlobRef";
+                readonly 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.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["sha256", "mediaType"];
+                readonly properties: {
+                    readonly sha256: {
+                        readonly type: "string";
+                        readonly pattern: "^[0-9a-f]{64}$";
+                        readonly description: "Lowercase hex SHA-256 of the stored, re-encoded bytes.";
+                    };
+                    readonly mediaType: {
+                        readonly type: "string";
+                        readonly enum: readonly ["image/png", "image/jpeg", "image/webp", "image/avif"];
+                        readonly description: "Media type of the stored bytes.";
+                    };
+                    readonly size: {
+                        readonly type: "integer";
+                        readonly minimum: 1;
+                        readonly maximum: 262144;
+                        readonly description: "Size in bytes of the stored bytes.";
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                        readonly format: "uri";
+                        readonly maxLength: 2048;
+                        readonly description: "Projection only: a URL the viewer can fetch the image from until `urlExpiresAt`.";
+                    };
+                    readonly urlExpiresAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Projection only: when `url` stops working.";
+                    };
+                };
+            };
+            readonly ImageMediaType: {
+                readonly title: "ImageMediaType";
+                readonly description: "The media types a directory image may have — those a `CardBlobRef` admits.";
+                readonly type: "string";
+                readonly enum: readonly ["image/png", "image/jpeg", "image/webp", "image/avif"];
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/vtc/directory/images/upload/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../../src/vtc/directory/images/upload/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAG7F;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,SAAS,EAAE,cAAc,CAAC;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,KAAK,EAAE,WAAW,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,WAAW,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC;AAEjD,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,6DAAsE,CAAC;AAE/F,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,+BAA+B,CAAC;AAEtD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,sEAA+E,CAAC;AAEjH,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,uCAAuC,CAAC;AAE/D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuHjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+F1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}