@marktiderman/genesis-forms 0.8.0 → 0.9.1

package/dist/{validate-irIPubxc.d.cts → validate-U5LoW3eR.d.cts}

@@ -1,146 +1,32 @@
-import { J as Json, g as Operator, a as FieldBlock, B as Block, O as OptionsSource, F as FormDefinition, e as FormEvent } from './types-jqDKcmP4.cjs';
+import { J as Json, e as FormEvent, F as FormDefinition, a as FieldBlock, b as ContentBlock, g as Operator, B as Block, O as OptionsSource } from './types-C0pUfew3.cjs';
 
 /**
- * A field type, without any UI. Renderers are registered separately per
- * platform (`genesis-forms-react`), so a manifest runs anywhere.
+ * Checking a block's `props` for `parseForm`: the shared helpers every content and field kind's
+ * `checkProps` uses, so each kind states its own settings once and they are reported the same way.
  */
-interface FieldTypeManifest {
-    type: string;
-    label: string;
-    category: "text" | "choice" | "scale" | "date" | "media" | "advanced";
-    /** `json: false` types must convert, so drafts and server replay never lose an answer. */
-    value: {
-        json: true;
-    } | {
-        json: false;
-        serialize: (value: unknown) => Json;
-        deserialize: (json: Json) => unknown;
-    };
-    operators: Operator[];
-    a11y: {
-        semantics: "control" | "group";
-        /** The HTML `autocomplete` token, such as `"email"` or `"tel"`. */
-        autocomplete?: string;
-        /** The HTML `inputmode` hint for on-screen keyboards, such as `"email"` or `"tel"`. */
-        inputMode?: "text" | "email" | "tel" | "numeric" | "decimal" | "url" | "search";
-    };
-    isEmpty?: (value: Json | undefined) => boolean;
-    /** Return an error message, or null when the (non-empty) value is valid. */
-    validate?: (value: Json, field: FieldBlock) => string | null;
-    /** Plain text for recall, exports and emails. */
-    summarize?: (value: Json, field: FieldBlock) => string;
-    /**
-     * The form a (valid, non-empty) value is stored in, such as an email
-     * without surrounding spaces. Applied by `engine.answers()` and the server.
-     */
-    normalize?: (value: Json, field: FieldBlock) => Json;
-    /** Valid example answers, used by `coverage()` and other test tools to explore a path. */
-    samples?: (field: FieldBlock) => Json[];
-}
-declare function registerFieldType(manifest: FieldTypeManifest): void;
-declare function getFieldType(type: string): FieldTypeManifest | undefined;
-declare function listFieldTypes(): FieldTypeManifest[];
-declare function isEmptyValue(value: Json | undefined, field?: FieldBlock): boolean;
-/** A value in its stored form (see `FieldTypeManifest.normalize`). */
-declare function normalizeValue(value: Json, field: FieldBlock): Json;
-/** Whether a block holds personal or secret data: `sensitive: true`, or the `props.sensitive: true` alias. */
-declare function isSensitive(block: Block): boolean;
-declare function summarizeValue(value: Json | undefined, field: FieldBlock): string;
-interface ChoiceOption {
-    value: string;
-    label?: string;
-    /** A muted line under the label, such as a location's address. At most `OPTION_LIMITS.description` characters. */
-    description?: string;
-    /** A small picture beside the label: an `https://` URL, at most `OPTION_LIMITS.image` characters. */
-    image?: string;
-    /**
-     * Facts about the option for filtering and recall, such as `{ location: ["riverside", "hilltop"] }`
-     * for a coach who works at two locations (see `props.optionsFrom.filter`). Names and values are
-     * text; a value is one text or a list of them.
-     */
-    attributes?: Record<string, string | string[]>;
-}
-/** Bounds on an option's extra details. A longer or malformed detail is dropped when options are read. */
-declare const OPTION_LIMITS: {
-    /** Characters in a description. */
-    readonly description: 500;
-    /** Characters in an image URL. */
-    readonly image: 2048;
-    /** Attributes on one option. */
-    readonly attributes: 20;
-    /** Characters in an attribute's name. */
-    readonly attributeName: 64;
-    /** Characters in one attribute value. */
-    readonly attributeValue: 200;
-    /** Values in one attribute's list. */
-    readonly attributeItems: 50;
-};
 /**
- * Whether `url` is an `https://` link with a host and no spaces or control characters, within
- * `OPTION_LIMITS.image`. A pattern rather than `new URL`, so it behaves the same in React Native.
+ * A kind's check of its `props` (an object, `{}` when the block has none). Report through
+ * `check`, with paths under `props` (`"max"`, `"columns[0].key"`); `parseForm` prefixes each
+ * with the block's (`blocks[3].props.`).
  */
-declare function isHttpsUrl(url: unknown): url is string;
-/**
- * An option from untrusted JSON (a definition, the host's list): its string `value`, and its
- * `label`, `description`, `image` and `attributes` when each is well formed and within
- * `OPTION_LIMITS`; anything else is left out. Null when there is no string value.
- */
-declare function readOption(raw: unknown): ChoiceOption | null;
-/** An option as JSON, with only the details it has. */
-declare function optionJson(option: ChoiceOption): Json;
-/** The longest answer an "Other" option takes. */
-declare const OTHER_MAX_LENGTH = 200;
-/**
- * A choice question's "Other" option (`props.other: true` or `{ label }`): the respondent types
- * their own answer, stored as the answer's value itself (single choice, dropdown) or as one more
- * item (multiple choice). Null when the question has none.
- */
-declare function otherOption(field: FieldBlock): {
-    label: string;
-} | null;
-/** Whether a value is a typed "Other" answer: text that isn't one of the question's options. */
-declare function isOtherValue(field: FieldBlock, value: unknown): value is string;
-declare function choiceOptions(field: FieldBlock): ChoiceOption[];
-/**
- * Option lists the app showing a form supplies, by key (`OptionsSource.key`):
- * `{ coaches: [{ value: "8c1…", label: "Ada Lovelace" }] }`.
- */
-type HostOptions = Readonly<Record<string, readonly ChoiceOption[]>>;
-/**
- * A choice field's `props.optionsFrom`, when it is a well-formed `{ source: "host", key }`, with its
- * `filter` when that is well formed too (`{ attribute, field }`, both non-empty text).
- */
-declare function optionsSource(field: FieldBlock): OptionsSource | undefined;
-/**
- * The definition with each `optionsFrom: { source: "host" }` field's options
- * filled in from `hostOptions`: its own `props.options` first, then the host's
- * list for its key (a value the field already has is not added twice). A key
- * the host does not supply adds nothing, so the field offers its own options
- * only. `createForm` and `validateSubmission` call it with their `hostOptions`,
- * so a respondent sees, and a submit accepts, exactly these. Returns
- * `definition` itself when no field takes options from the host.
- */
-declare function withHostOptions(definition: FormDefinition, hostOptions: HostOptions | undefined): FormDefinition;
-/** The optional words under the ends of a rating or NPS scale ("Poor", "Great"). */
-declare function scaleLabels(field: FieldBlock): {
-    low?: string;
-    high?: string;
-};
-/** How a rating is drawn: `"numbers"` (default) or `"stars"`. */
-declare function ratingDisplay(field: FieldBlock): "numbers" | "stars";
-/** A `number` field's limits: `min`, `max` and `step` (each optional; `step` is above 0). */
-declare function numberLimits(field: FieldBlock): {
-    min?: number;
-    max?: number;
-    step?: number;
-};
-/** `YYYY-MM-DD`, a real calendar day (no 2026-02-30), years 0001 to 9999. */
-declare function isIsoDate(value: string): boolean;
-/** A `date` field's earliest and latest days (`YYYY-MM-DD`), when set. */
-declare function dateLimits(field: FieldBlock): {
-    min?: string;
-    max?: string;
-};
+type PropsCheck = (props: Readonly<Record<string, unknown>>, check: PropsChecker) => void;
+/** The helpers a `PropsCheck` reports through. Paths are relative to `props`. */
+interface PropsChecker {
+    /** Report a problem with the setting at `path`. */
+    issue(path: string, message: string): void;
+    /** A required string (non-empty with `nonEmpty`). */
+    text(v: unknown, path: string, nonEmpty?: boolean): void;
+    /** An optional string. */
+    optionalText(v: unknown, path: string): void;
+    /** An optional true or false. */
+    optionalBoolean(v: unknown, path: string): void;
+    /** An optional whole number of at least `floor`. */
+    optionalInt(v: unknown, path: string, floor: number): void;
+    /** `low` may not exceed `high` when both are whole numbers. */
+    ordered(low: unknown, high: unknown, path: string, what: string): void;
+    /** An identifier: a non-empty string that is not an `Object.prototype` name. */
+    name(v: unknown, path: string, what: string): v is string;
+}
 
 /**
  * Which options a choice question shows, and how they are picked: lists filtered by another
@@ -149,7 +35,10 @@ declare function dateLimits(field: FieldBlock): {
  * decide the same way.
  */
 
-/** Field types whose answer is one or more of their options. */
+/**
+ * The built-in field types whose answer is one or more of their options. A host's own choice
+ * kinds (`FieldTypeManifest.choice`) aren't in it: ask `isChoiceField` or `choiceKind`.
+ */
 declare const CHOICE_FIELD_TYPES: ReadonlySet<string>;
 /** A choice field's `props.optionsFrom.filter` (`{ attribute, field }`), when it is well formed. */
 declare function optionFilter(field: FieldBlock): {
@@ -292,6 +181,235 @@ interface RestoredAnswers {
  */
 declare function answersFromSnapshots(definition: FormDefinition, snapshots: Readonly<Record<string, unknown>>): RestoredAnswers;
 
+/** The JSON type a comparison literal must have to match an answer (`parseForm` warns otherwise). */
+type LiteralType = "string" | "number" | "boolean";
+/**
+ * A field kind, without any UI: the one definition the engine, `parseForm`, validation, the
+ * server and snapshots all read, so a kind is described once instead of in a switch in each.
+ * Renderers are registered separately per platform (`genesis-forms-react`), so a manifest runs
+ * anywhere. Every hook is optional except where noted; a missing one means "nothing special".
+ * `validate`, `checkProps`, `literal`, `snapshot` and `fromSnapshot` may throw (each fails safe,
+ * as its doc says); `isEmpty`, `normalize` and `summarize` must not.
+ */
+interface FieldTypeManifest {
+    type: string;
+    label: string;
+    category: "text" | "choice" | "scale" | "date" | "media" | "advanced";
+    /** `json: false` types must convert, so drafts and server replay never lose an answer. */
+    value: {
+        json: true;
+    } | {
+        json: false;
+        serialize: (value: unknown) => Json;
+        deserialize: (json: Json) => unknown;
+    };
+    operators: Operator[];
+    a11y: {
+        semantics: "control" | "group";
+        /** The HTML `autocomplete` token, such as `"email"` or `"tel"`. */
+        autocomplete?: string;
+        /** The HTML `inputmode` hint for on-screen keyboards, such as `"email"` or `"tel"`. */
+        inputMode?: "text" | "email" | "tel" | "numeric" | "decimal" | "url" | "search";
+    };
+    /**
+     * The props schema: `parseForm` calls it with the field's `props` (`{}` when it has none) and
+     * reports what it finds as issues at `blocks[i].props.<path>`. A check that throws is reported
+     * as one issue, never thrown.
+     */
+    checkProps?: PropsCheck;
+    /**
+     * The answer's shape. `choice`: the answer is one of `props.options` (`multiple: false`, a
+     * text) or several (`multiple: true`, a list of texts), so the field takes `optionsFrom`,
+     * `prefill`, `other` and filters, and its answers are snapshotted with their labels. Without
+     * its own `validate` (or `summarize`) it gets the built-in one for its shape, so an answer is
+     * always one of its options (or a typed "Other" when `props.other` allows it).
+     */
+    choice?: {
+        multiple: boolean;
+    };
+    /**
+     * The JSON type a logic literal compared with this field must have, or a function of its props
+     * (`undefined`: not known). `parseForm` warns about a literal that can never match.
+     */
+    literal?: LiteralType | ((props: Readonly<Record<string, unknown>>) => LiteralType | undefined);
+    /** The empty-check: whether a value counts as no answer. Default: nothing, null, blank text or `[]`. */
+    isEmpty?: (value: Json | undefined) => boolean;
+    /**
+     * The validator: an error message, or null when the (non-empty) value is valid. A validator
+     * that throws refuses the answer (`VALIDATOR_FAILED_MESSAGE`) rather than throwing.
+     */
+    validate?: (value: Json, field: FieldBlock) => string | null;
+    /** The display text: plain text for recall, exports and emails. */
+    summarize?: (value: Json, field: FieldBlock) => string;
+    /**
+     * The form a (valid, non-empty) value is stored in, such as an email
+     * without surrounding spaces. Applied by `engine.answers()` and the server.
+     */
+    normalize?: (value: Json, field: FieldBlock) => Json;
+    /**
+     * The snapshot of a (non-empty) answer as it was when stored, for `answerSnapshots`: the
+     * labels it showed, so history keeps them when the source changes. Choice kinds have one
+     * built in (for fields with `optionsFrom`); give another kind one here.
+     */
+    snapshot?: (value: Json, field: FieldBlock) => AnswerSnapshot | undefined;
+    /**
+     * The reverse of `snapshot`, for `answersFromSnapshots`: the answer to prefill from a stored
+     * snapshot (or none), and the picks that no longer exist.
+     */
+    fromSnapshot?: (snapshot: unknown, field: FieldBlock) => {
+        value?: Json;
+        missing: OptionSnapshot[];
+    };
+    /** Valid example answers, used by `coverage()` and other test tools to explore a path. */
+    samples?: (field: FieldBlock) => Json[];
+}
+/** The message an answer gets when its kind's validator throws. */
+declare const VALIDATOR_FAILED_MESSAGE = "This answer couldn't be checked.";
+interface RegisterOptions {
+    /**
+     * Replace a built-in kind (`email`, `single-choice`…). Off by default: the registry is shared
+     * by every form in the process, the server's checks included, so changing what a built-in
+     * accepts must be deliberate.
+     */
+    replace?: boolean;
+}
+/**
+ * Register a field kind, or replace one a host registered before (re-registering is allowed,
+ * so hot reload works). Throws on a malformed manifest, and on a built-in kind's name unless
+ * `{ replace: true }`. Registered kinds are frozen copies.
+ */
+declare function registerFieldType(manifest: FieldTypeManifest, options?: RegisterOptions): void;
+declare function getFieldType(type: string): FieldTypeManifest | undefined;
+declare function listFieldTypes(): FieldTypeManifest[];
+/** Whether `type` is one of the field kinds the package ships. */
+declare function isBuiltInFieldType(type: string): boolean;
+/** A choice kind's answer shape (`FieldTypeManifest.choice`), or undefined for any other kind. */
+declare function choiceKind(type: string): {
+    multiple: boolean;
+} | undefined;
+/** Whether a block is a field of a choice kind: its answer is one or more of its options. */
+declare function isChoiceField(block: unknown): block is FieldBlock;
+/**
+ * A content kind (a block that shows something and takes no answer): `heading` and `text` are
+ * built in; a host registers others (a message screen, a media block) with
+ * `registerContentType`, plus a renderer per platform.
+ */
+interface ContentTypeManifest {
+    type: string;
+    label: string;
+    /** The props schema, as for a field kind; the block's `props`, `{}` when it has none. */
+    checkProps?: PropsCheck;
+    /** The display text (recall, exports, a renderer with no special drawing). Default: `block.text`. */
+    text?: (block: ContentBlock) => string;
+}
+/** Register a content kind. Throws on a malformed manifest or a built-in kind's name (unless `{ replace: true }`). */
+declare function registerContentType(manifest: ContentTypeManifest, options?: RegisterOptions): void;
+declare function getContentType(type: string): ContentTypeManifest | undefined;
+declare function listContentTypes(): ContentTypeManifest[];
+/** A content block's display text: its kind's `text` (when it gives a string without throwing), or `block.text`. */
+declare function contentText(block: ContentBlock): string;
+declare function isEmptyValue(value: Json | undefined, field?: FieldBlock): boolean;
+/** A value in its stored form (see `FieldTypeManifest.normalize`). */
+declare function normalizeValue(value: Json, field: FieldBlock): Json;
+/** Whether a block holds personal or secret data: `sensitive: true`, or the `props.sensitive: true` alias. */
+declare function isSensitive(block: Block): boolean;
+declare function summarizeValue(value: Json | undefined, field: FieldBlock): string;
+interface ChoiceOption {
+    value: string;
+    label?: string;
+    /** A muted line under the label, such as a location's address. At most `OPTION_LIMITS.description` characters. */
+    description?: string;
+    /** A small picture beside the label: an `https://` URL, at most `OPTION_LIMITS.image` characters. */
+    image?: string;
+    /**
+     * Facts about the option for filtering and recall, such as `{ location: ["riverside", "hilltop"] }`
+     * for a coach who works at two locations (see `props.optionsFrom.filter`). Names and values are
+     * text; a value is one text or a list of them.
+     */
+    attributes?: Record<string, string | string[]>;
+}
+/** Bounds on an option's extra details. A longer or malformed detail is dropped when options are read. */
+declare const OPTION_LIMITS: {
+    /** Characters in a description. */
+    readonly description: 500;
+    /** Characters in an image URL. */
+    readonly image: 2048;
+    /** Attributes on one option. */
+    readonly attributes: 20;
+    /** Characters in an attribute's name. */
+    readonly attributeName: 64;
+    /** Characters in one attribute value. */
+    readonly attributeValue: 200;
+    /** Values in one attribute's list. */
+    readonly attributeItems: 50;
+};
+/**
+ * Whether `url` is an `https://` link with a host and no spaces or control characters, within
+ * `OPTION_LIMITS.image`. A pattern rather than `new URL`, so it behaves the same in React Native.
+ */
+declare function isHttpsUrl(url: unknown): url is string;
+/**
+ * An option from untrusted JSON (a definition, the host's list): its string `value`, and its
+ * `label`, `description`, `image` and `attributes` when each is well formed and within
+ * `OPTION_LIMITS`; anything else is left out. Null when there is no string value.
+ */
+declare function readOption(raw: unknown): ChoiceOption | null;
+/** An option as JSON, with only the details it has. */
+declare function optionJson(option: ChoiceOption): Json;
+/** The longest answer an "Other" option takes. */
+declare const OTHER_MAX_LENGTH = 200;
+/**
+ * A choice question's "Other" option (`props.other: true` or `{ label }`): the respondent types
+ * their own answer, stored as the answer's value itself (single choice, dropdown) or as one more
+ * item (multiple choice). Null when the question has none.
+ */
+declare function otherOption(field: FieldBlock): {
+    label: string;
+} | null;
+/** Whether a value is a typed "Other" answer: text that isn't one of the question's options. */
+declare function isOtherValue(field: FieldBlock, value: unknown): value is string;
+declare function choiceOptions(field: FieldBlock): ChoiceOption[];
+/**
+ * Option lists the app showing a form supplies, by key (`OptionsSource.key`):
+ * `{ coaches: [{ value: "8c1…", label: "Ada Lovelace" }] }`.
+ */
+type HostOptions = Readonly<Record<string, readonly ChoiceOption[]>>;
+/**
+ * A choice field's `props.optionsFrom`, when it is a well-formed `{ source: "host", key }`, with its
+ * `filter` when that is well formed too (`{ attribute, field }`, both non-empty text).
+ */
+declare function optionsSource(field: FieldBlock): OptionsSource | undefined;
+/**
+ * The definition with each `optionsFrom: { source: "host" }` field's options
+ * filled in from `hostOptions`: its own `props.options` first, then the host's
+ * list for its key (a value the field already has is not added twice). A key
+ * the host does not supply adds nothing, so the field offers its own options
+ * only. `createForm` and `validateSubmission` call it with their `hostOptions`,
+ * so a respondent sees, and a submit accepts, exactly these. Returns
+ * `definition` itself when no field takes options from the host.
+ */
+declare function withHostOptions(definition: FormDefinition, hostOptions: HostOptions | undefined): FormDefinition;
+/** The optional words under the ends of a rating or NPS scale ("Poor", "Great"). */
+declare function scaleLabels(field: FieldBlock): {
+    low?: string;
+    high?: string;
+};
+/** How a rating is drawn: `"numbers"` (default) or `"stars"`. */
+declare function ratingDisplay(field: FieldBlock): "numbers" | "stars";
+/** A `number` field's limits: `min`, `max` and `step` (each optional; `step` is above 0). */
+declare function numberLimits(field: FieldBlock): {
+    min?: number;
+    max?: number;
+    step?: number;
+};
+/** `YYYY-MM-DD`, a real calendar day (no 2026-02-30), years 0001 to 9999. */
+declare function isIsoDate(value: string): boolean;
+/** A `date` field's earliest and latest days (`YYYY-MM-DD`), when set. */
+declare function dateLimits(field: FieldBlock): {
+    min?: string;
+    max?: string;
+};
+
 /** The Standard Schema interface (standardschema.dev), as far as validation needs it. */
 interface StandardSchemaV1<T = unknown> {
     readonly "~standard": {
@@ -319,4 +437,4 @@ declare function validateField(field: FieldBlock, value: Json | undefined, optio
     custom?: FieldValidator;
 }): string | null;
 
-export { withHostOptions as $, type AnswerSnapshot as A, numberLimits as B, CHOICE_FIELD_TYPES as C, optionFilter as D, optionJson as E, type FieldValidator as F, optionMatches as G, type HostOptions as H, optionsSource as I, otherOption as J, prefillFromLink as K, type LinkParams as L, MAX_PREFILL_PARAM_LENGTH as M, prefillSetting as N, OPTION_LIMITS as O, type PrefillSetting as P, ratingDisplay as Q, REQUIRED_MESSAGE as R, SEARCHABLE_OPTION_COUNT as S, readOption as T, registerFieldType as U, respondentPath as V, scaleLabels as W, searchOptions as X, summarizeValue as Y, validateField as Z, visibleOptions as _, type ChoiceOption as a, type FieldTypeManifest as b, OTHER_MAX_LENGTH as c, type OptionSnapshot as d, type PrefillState as e, type RestoredAnswers as f, type StandardSchemaV1 as g, answerSnapshots as h, answersFromSnapshots as i, answersOnPath as j, choiceOptions as k, clearFilteredAnswers as l, dateLimits as m, filteredChoiceError as n, getFieldType as o, hasOptionFilters as p, hiddenByPrefill as q, isEmptyValue as r, isHttpsUrl as s, isIsoDate as t, isOtherValue as u, isPrefillParam as v, isSearchable as w, isSensitive as x, listFieldTypes as y, normalizeValue as z };
+export { otherOption as $, type AnswerSnapshot as A, isChoiceField as B, CHOICE_FIELD_TYPES as C, isEmptyValue as D, isHttpsUrl as E, type FieldValidator as F, isIsoDate as G, type HostOptions as H, isOtherValue as I, isPrefillParam as J, isSearchable as K, type LinkParams as L, MAX_PREFILL_PARAM_LENGTH as M, isSensitive as N, OPTION_LIMITS as O, type PrefillSetting as P, listContentTypes as Q, REQUIRED_MESSAGE as R, SEARCHABLE_OPTION_COUNT as S, listFieldTypes as T, normalizeValue as U, VALIDATOR_FAILED_MESSAGE as V, numberLimits as W, optionFilter as X, optionJson as Y, optionMatches as Z, optionsSource as _, type ChoiceOption as a, prefillFromLink as a0, prefillSetting as a1, ratingDisplay as a2, readOption as a3, registerContentType as a4, registerFieldType as a5, respondentPath as a6, scaleLabels as a7, searchOptions as a8, summarizeValue as a9, validateField as aa, visibleOptions as ab, withHostOptions as ac, type ContentTypeManifest as b, type FieldTypeManifest as c, type LiteralType as d, OTHER_MAX_LENGTH as e, type OptionSnapshot as f, type PrefillState as g, type PropsCheck as h, type PropsChecker as i, type RegisterOptions as j, type RestoredAnswers as k, type StandardSchemaV1 as l, answerSnapshots as m, answersFromSnapshots as n, answersOnPath as o, choiceKind as p, choiceOptions as q, clearFilteredAnswers as r, contentText as s, dateLimits as t, filteredChoiceError as u, getContentType as v, getFieldType as w, hasOptionFilters as x, hiddenByPrefill as y, isBuiltInFieldType as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marktiderman/genesis-forms",
-  "version": "0.8.0",
+  "version": "0.9.1",
   "private": false,
   "type": "module",
   "sideEffects": [
@@ -78,9 +78,10 @@
   ],
   "devDependencies": {
     "@fast-check/vitest": "^0.2.4",
+    "@marktiderman/genesis-notifications": "^0.1.1",
     "fast-check": "^4.10.2",
     "tsup": "^8.3.0",
-    "typescript": "^5.9.3",
+    "typescript": "~6.0.3",
     "vitest": "^4.1.12"
   },
   "scripts": {

package/dist/upload-protocol-BOe018kL.d.cts

@@ -1,122 +0,0 @@
-import { a as FieldBlock, J as Json } from './types-jqDKcmP4.cjs';
-
-/**
- * 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 };