@marktiderman/genesis-forms 0.8.0 → 0.9.0

package/dist/upload-protocol-BUO74WkS.d.ts

@@ -1,122 +0,0 @@
-import { a as FieldBlock, J as Json } from './types-jqDKcmP4.js';
-
-/**
- * The `photo` field type: a respondent attaches up to a few photos, such as a
- * picture of broken equipment. The answer holds references the host's storage
- * handed back (`PhotoRef`), never the bytes: the renderer uploads through the
- * host (`onUpload` on genesis-forms-web's `Form`), so the engine and the
- * server stay storage-agnostic. A host's server should check that each
- * reference is a file it stored for this respondent before saving.
- *
- * Opt-in in a builder palette (`UPLOAD_FIELD_TYPES`), since a host must be
- * able to store the files.
- */
-declare const PHOTO_TYPE = "photo";
-/** Field types that need the host to store files; a builder offers them only when the host names them. */
-declare const UPLOAD_FIELD_TYPES: readonly ["photo"];
-/** One stored photo, as the host's upload returned it. */
-type PhotoRef = {
-    /** The host's id for the stored file. */
-    id: string;
-    /** The file's name on the respondent's device. */
-    name: string;
-    /** Its MIME type, such as `image/jpeg`. */
-    type: string;
-    /** Bytes. */
-    size: number;
-};
-type PhotoFormat = "jpeg" | "png" | "heic" | "webp";
-/** The MIME types each format covers. */
-declare const PHOTO_FORMATS: Record<PhotoFormat, readonly string[]>;
-declare const DEFAULT_PHOTO_FILES = 3;
-declare const MAX_PHOTO_FILES = 5;
-declare const DEFAULT_PHOTO_SIZE_MB = 10;
-declare const MAX_PHOTO_SIZE_MB = 25;
-/** The longest reference id and file name a photo answer may carry. */
-declare const MAX_PHOTO_ID_LENGTH = 200;
-declare const MAX_PHOTO_NAME_LENGTH = 255;
-declare const isPhotoFormat: (v: unknown) => v is PhotoFormat;
-interface PhotoLimits {
-    maxFiles: number;
-    maxSizeMb: number;
-    maxBytes: number;
-    formats: PhotoFormat[];
-    /** Every MIME type the formats cover. */
-    mimeTypes: string[];
-}
-/** A photo field's limits; a prop that is missing or out of range uses its default. */
-declare function photoLimits(field: FieldBlock): PhotoLimits;
-/** Whether `v` has a photo reference's shape (any type and size). */
-declare function isPhotoRef(v: unknown): v is PhotoRef;
-/** The well-formed references in a photo answer, as `{ id, name, type, size }` only. */
-declare function photoRefs(value: Json | undefined): PhotoRef[];
-/** "JPEG, PNG or WebP". */
-declare function photoFormatList(formats: readonly PhotoFormat[]): string;
-/** The message for a file of a type the field doesn't take. */
-declare const photoTypeMessage: (field: FieldBlock) => string;
-/** The message for a file over the field's size limit. */
-declare const photoSizeMessage: (field: FieldBlock) => string;
-/** The message for more photos than the field takes. */
-declare const photoCountMessage: (field: FieldBlock) => string;
-
-/**
- * The upload handshake's JSON, shared by the server (`createUploadHandler` in
- * `/server`) and the browser (genesis-forms-web's `signedUploadHost`). A
- * respondent's browser asks the app's server for one signed upload per file,
- * then sends the bytes straight to storage with it; the answer keeps only the
- * reference the server handed back.
- *
- * Moved up from the host app's feedback photo uploads; the field names and
- * status codes are the ones it used, so its browsers and server keep talking.
- */
-
-/**
- * What the browser POSTs (`content-type: application/json`, at most
- * `MAX_UPLOAD_REQUEST_BYTES`). Exactly one of `attemptId` (a new response: the
- * visit's attempt id, a UUID) and `edit` (an edit link's token, while changing
- * a sent response).
- */
-interface UploadRequest {
-    /** The upload field's id. */
-    fieldId: string;
-    /** The file's name on the respondent's device. */
-    name: string;
-    /** Its MIME type. */
-    type: string;
-    /** Bytes. */
-    size: number;
-    attemptId?: string | undefined;
-    edit?: string | undefined;
-}
-/**
- * Where the browser sends the bytes, as the app's storage signed it. Supabase
- * Storage hands back `path` and `token` (with `bucket`, for
- * `uploadToSignedUrl`); a store that signs a plain URL sets `url`, which
- * `signedUploadHost` PUTs the file to when no `send` is given.
- */
-interface SignedUpload {
-    path: string;
-    token: string;
-    bucket?: string | undefined;
-    url?: string | undefined;
-}
-/** 200: the reference the answer keeps, and where to send the bytes. */
-interface UploadGrant {
-    ref: PhotoRef;
-    upload: SignedUpload;
-}
-/**
- * Any other status: words to show the respondent, and for some a `code`:
- * `closed` (409, an edit while the form takes no changes), `bad_link` (403, an
- * edit link that doesn't check out) or `too_many_photos` (429, the attempt or
- * edit has as many uploads as the store allows; the name the host app's
- * browsers already know, kept for every upload field type).
- */
-interface UploadRefusal {
-    error: string;
-    code?: string | undefined;
-}
-/** The longest upload request body: a few fields of JSON. */
-declare const MAX_UPLOAD_REQUEST_BYTES = 4000;
-
-export { DEFAULT_PHOTO_FILES as D, MAX_PHOTO_FILES as M, type PhotoFormat as P, type SignedUpload as S, UPLOAD_FIELD_TYPES as U, type PhotoRef as a, DEFAULT_PHOTO_SIZE_MB as b, MAX_PHOTO_ID_LENGTH as c, MAX_PHOTO_NAME_LENGTH as d, MAX_PHOTO_SIZE_MB as e, MAX_UPLOAD_REQUEST_BYTES as f, PHOTO_FORMATS as g, PHOTO_TYPE as h, type PhotoLimits as i, type UploadGrant as j, type UploadRefusal as k, type UploadRequest as l, isPhotoFormat as m, isPhotoRef as n, photoFormatList as o, photoCountMessage as p, photoLimits as q, photoRefs as r, photoSizeMessage as s, photoTypeMessage as t };