@10x-media/form-builder 0.1.0-beta.3 → 0.1.0-beta.4

package/dist/poll/definePollOptionSource.d.ts

@@ -0,0 +1,35 @@
+import { Field, Payload, PayloadRequest } from "payload";
+
+//#region src/poll/definePollOptionSource.d.ts
+/** One selectable poll choice. `value` is the host's stable identifier contract: it is stored in submissions and later matched against `outcome.winningValue`, so it must never change once votes exist. */
+type PollOption = {
+  label: string;
+  value: string;
+};
+type PollOptionResolveArgs<TConfig extends Record<string, unknown> = Record<string, unknown>> = {
+  config: TConfig;
+  form: {
+    id: number | string;
+    title?: string;
+  };
+  payload: Payload;
+  req?: PayloadRequest;
+};
+/**
+ * A poll option source type, authored once by the host: `config` is the admin `Field[]` an author
+ * fills per form (e.g. an event id); `resolve` maps that config to the current options from host
+ * domain data. Called at render time (via `resolvePollOptions`) and again at submission time, where
+ * the resolved values are the only accepted answers (fail closed).
+ */
+type PollOptionSource<TConfig extends Record<string, unknown> = Record<string, unknown>> = {
+  type: string;
+  label: string;
+  config?: Field[];
+  resolve: (args: PollOptionResolveArgs<TConfig>) => Promise<PollOption[]> | PollOption[];
+};
+/** Erased shape stored in the registry; config re-narrows per matched type at resolution. */
+type AnyPollOptionSource = PollOptionSource<Record<string, unknown>>;
+declare const definePollOptionSource: <TConfig extends Record<string, unknown> = Record<string, unknown>>(source: PollOptionSource<TConfig>) => PollOptionSource<TConfig>;
+//#endregion
+export { AnyPollOptionSource, PollOption, PollOptionResolveArgs, PollOptionSource, definePollOptionSource };
+//# sourceMappingURL=definePollOptionSource.d.ts.map

package/dist/poll/definePollOptionSource.js

@@ -0,0 +1,6 @@
+//#region src/poll/definePollOptionSource.ts
+const definePollOptionSource = (source) => source;
+//#endregion
+export { definePollOptionSource };
+
+//# sourceMappingURL=definePollOptionSource.js.map

package/dist/poll/definePollOptionSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definePollOptionSource.js","names":[],"sources":["../../src/poll/definePollOptionSource.ts"],"sourcesContent":["import type { Field, Payload, PayloadRequest } from 'payload'\n\n/** One selectable poll choice. `value` is the host's stable identifier contract: it is stored in submissions and later matched against `outcome.winningValue`, so it must never change once votes exist. */\nexport type PollOption = { label: string; value: string }\n\nexport type PollOptionResolveArgs<\n\tTConfig extends Record<string, unknown> = Record<string, unknown>,\n> = {\n\tconfig: TConfig\n\tform: { id: number | string; title?: string }\n\tpayload: Payload\n\treq?: PayloadRequest\n}\n\n/**\n * A poll option source type, authored once by the host: `config` is the admin `Field[]` an author\n * fills per form (e.g. an event id); `resolve` maps that config to the current options from host\n * domain data. Called at render time (via `resolvePollOptions`) and again at submission time, where\n * the resolved values are the only accepted answers (fail closed).\n */\nexport type PollOptionSource<TConfig extends Record<string, unknown> = Record<string, unknown>> = {\n\ttype: string\n\tlabel: string\n\tconfig?: Field[]\n\tresolve: (args: PollOptionResolveArgs<TConfig>) => Promise<PollOption[]> | PollOption[]\n}\n\n/** Erased shape stored in the registry; config re-narrows per matched type at resolution. */\nexport type AnyPollOptionSource = PollOptionSource<Record<string, unknown>>\n\nexport const definePollOptionSource = <\n\tTConfig extends Record<string, unknown> = Record<string, unknown>,\n>(\n\tsource: PollOptionSource<TConfig>\n): PollOptionSource<TConfig> => source\n"],"mappings":";AA8BA,MAAa,0BAGZ,WAC+B"}

package/dist/poll/registry.d.ts

@@ -0,0 +1,16 @@
+import { AnyPollOptionSource } from "./definePollOptionSource.js";
+
+//#region src/poll/registry.d.ts
+type PollOptionSourceRegistry = Map<string, AnyPollOptionSource>;
+/** `false` removes a source, `true` keeps it (no-op: there are no built-ins), a definition adds or replaces one. */
+type PollOptionSourceOption = boolean | AnyPollOptionSource;
+type PollOptionSourcesConfig = Record<string, PollOptionSourceOption>;
+/**
+ * Resolve the active poll option-source registry from a consumer map. Unlike the consent and
+ * action registries there are no built-in defaults: the registry starts empty and only host
+ * definitions populate it, so `true`/`false` entries are accepted but change nothing.
+ */
+declare const resolvePollOptionSources: (config?: PollOptionSourcesConfig) => PollOptionSourceRegistry;
+//#endregion
+export { PollOptionSourceOption, PollOptionSourceRegistry, PollOptionSourcesConfig, resolvePollOptionSources };
+//# sourceMappingURL=registry.d.ts.map

package/dist/poll/registry.js

@@ -0,0 +1,16 @@
+//#region src/poll/registry.ts
+/**
+* Resolve the active poll option-source registry from a consumer map. Unlike the consent and
+* action registries there are no built-in defaults: the registry starts empty and only host
+* definitions populate it, so `true`/`false` entries are accepted but change nothing.
+*/
+const resolvePollOptionSources = (config = {}) => {
+	const registry = /* @__PURE__ */ new Map();
+	for (const [type, option] of Object.entries(config)) if (option === false) registry.delete(type);
+	else if (option === true) {} else registry.set(type, option);
+	return registry;
+};
+//#endregion
+export { resolvePollOptionSources };
+
+//# sourceMappingURL=registry.js.map

package/dist/poll/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","names":[],"sources":["../../src/poll/registry.ts"],"sourcesContent":["import type { AnyPollOptionSource } from './definePollOptionSource'\n\nexport type PollOptionSourceRegistry = Map<string, AnyPollOptionSource>\n\n/** `false` removes a source, `true` keeps it (no-op: there are no built-ins), a definition adds or replaces one. */\nexport type PollOptionSourceOption = boolean | AnyPollOptionSource\n\nexport type PollOptionSourcesConfig = Record<string, PollOptionSourceOption>\n\n/**\n * Resolve the active poll option-source registry from a consumer map. Unlike the consent and\n * action registries there are no built-in defaults: the registry starts empty and only host\n * definitions populate it, so `true`/`false` entries are accepted but change nothing.\n */\nexport const resolvePollOptionSources = (\n\tconfig: PollOptionSourcesConfig = {}\n): PollOptionSourceRegistry => {\n\tconst registry: PollOptionSourceRegistry = new Map()\n\tfor (const [type, option] of Object.entries(config)) {\n\t\tif (option === false) {\n\t\t\tregistry.delete(type)\n\t\t} else if (option === true) {\n\t\t\t// keep the default; no-op because no built-in poll option sources exist\n\t\t} else {\n\t\t\tregistry.set(type, option)\n\t\t}\n\t}\n\treturn registry\n}\n"],"mappings":";;;;;;AAcA,MAAa,4BACZ,SAAkC,CAAC,MACL;CAC9B,MAAM,2BAAqC,IAAI,IAAI;CACnD,KAAK,MAAM,CAAC,MAAM,WAAW,OAAO,QAAQ,MAAM,GACjD,IAAI,WAAW,OACd,SAAS,OAAO,IAAI;MACd,IAAI,WAAW,MAAM,CAE5B,OACC,SAAS,IAAI,MAAM,MAAM;CAG3B,OAAO;AACR"}

package/dist/poll/resolvePollOptions.d.ts

@@ -0,0 +1,28 @@
+import { PollOption } from "./definePollOptionSource.js";
+import { PollOptionSourceRegistry } from "./registry.js";
+import { Payload, PayloadRequest } from "payload";
+
+//#region src/poll/resolvePollOptions.d.ts
+type ResolvePollOptionsArgs = {
+  payload: Payload;
+  req?: PayloadRequest; /** A loaded forms document (its `poll` group drives resolution). */
+  form: {
+    id: number | string;
+    title?: string | null;
+    poll?: unknown;
+  }; /** Registry override for plugin-internal callers; defaults to the registry the plugin stashed on the config. */
+  sources?: PollOptionSourceRegistry;
+};
+/**
+ * Resolve a poll-enabled form's choice options from its configured option source (plugin option
+ * `poll.sources`). Returns `undefined` when the form is not poll-enabled or has no `optionSource`
+ * set, so hand-authored options render unchanged. Hosts call this server-side and hand the result
+ * to `toFormDocument(doc, { pollOptions })`; submission validation calls it too, making the
+ * resolved values the only accepted answers. Throws when the configured source type is not
+ * registered or its `resolve` fails; results are cached per request (keyed by form id) when a
+ * `req` is provided.
+ */
+declare const resolvePollOptions: (args: ResolvePollOptionsArgs) => Promise<PollOption[] | undefined>;
+//#endregion
+export { ResolvePollOptionsArgs, resolvePollOptions };
+//# sourceMappingURL=resolvePollOptions.d.ts.map

package/dist/poll/resolvePollOptions.js

@@ -0,0 +1,64 @@
+import { pollConfigOf } from "../form/pollState.js";
+//#region src/poll/resolvePollOptions.ts
+/** Root key under `config.custom` where the plugin stashes runtime state for root-level helpers. */
+const CUSTOM_KEY = "@10x-media/form-builder";
+/** Store the resolved registry on the config so `resolvePollOptions` can find it via `payload.config`. */
+const stashPollOptionSources = (custom, registry) => {
+	const existing = custom?.[CUSTOM_KEY] != null && typeof custom[CUSTOM_KEY] === "object" ? custom[CUSTOM_KEY] : {};
+	return {
+		...custom ?? {},
+		[CUSTOM_KEY]: {
+			...existing,
+			pollOptionSources: registry
+		}
+	};
+};
+const pollOptionSourcesOf = (payload) => {
+	return (payload.config.custom?.[CUSTOM_KEY])?.pollOptionSources ?? /* @__PURE__ */ new Map();
+};
+const CACHE_KEY = "formBuilderPollOptionsCache";
+const cacheOf = (req) => {
+	if (!req?.context) return;
+	const existing = req.context[CACHE_KEY];
+	if (existing instanceof Map) return existing;
+	const created = /* @__PURE__ */ new Map();
+	req.context[CACHE_KEY] = created;
+	return created;
+};
+/**
+* Resolve a poll-enabled form's choice options from its configured option source (plugin option
+* `poll.sources`). Returns `undefined` when the form is not poll-enabled or has no `optionSource`
+* set, so hand-authored options render unchanged. Hosts call this server-side and hand the result
+* to `toFormDocument(doc, { pollOptions })`; submission validation calls it too, making the
+* resolved values the only accepted answers. Throws when the configured source type is not
+* registered or its `resolve` fails; results are cached per request (keyed by form id) when a
+* `req` is provided.
+*/
+const resolvePollOptions = async (args) => {
+	const { payload, req, form, sources } = args;
+	const poll = pollConfigOf(form.poll);
+	const optionSource = typeof poll?.optionSource === "string" ? poll.optionSource : void 0;
+	if (poll?.enabled !== true || !optionSource) return;
+	const source = (sources ?? pollOptionSourcesOf(payload)).get(optionSource);
+	if (!source) throw new Error(`Poll option source "${optionSource}" is not registered. Register it via the plugin's poll.sources option.`);
+	const cache = cacheOf(req);
+	const cacheKey = String(form.id);
+	const cached = cache?.get(cacheKey);
+	if (cached) return cached;
+	const config = poll.sourceConfig != null && typeof poll.sourceConfig === "object" ? poll.sourceConfig : {};
+	const options = await source.resolve({
+		config,
+		form: {
+			id: form.id,
+			title: typeof form.title === "string" ? form.title : void 0
+		},
+		payload,
+		req
+	});
+	cache?.set(cacheKey, options);
+	return options;
+};
+//#endregion
+export { resolvePollOptions, stashPollOptionSources };
+
+//# sourceMappingURL=resolvePollOptions.js.map

package/dist/poll/resolvePollOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePollOptions.js","names":[],"sources":["../../src/poll/resolvePollOptions.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport { pollConfigOf } from '../form/pollState'\nimport type { PollOption } from './definePollOptionSource'\nimport type { PollOptionSourceRegistry } from './registry'\n\n/** Root key under `config.custom` where the plugin stashes runtime state for root-level helpers. */\nconst CUSTOM_KEY = '@10x-media/form-builder'\n\n/** Store the resolved registry on the config so `resolvePollOptions` can find it via `payload.config`. */\nexport const stashPollOptionSources = (\n\tcustom: Record<string, unknown> | undefined,\n\tregistry: PollOptionSourceRegistry\n): Record<string, unknown> => {\n\tconst existing =\n\t\tcustom?.[CUSTOM_KEY] != null && typeof custom[CUSTOM_KEY] === 'object'\n\t\t\t? (custom[CUSTOM_KEY] as Record<string, unknown>)\n\t\t\t: {}\n\treturn { ...(custom ?? {}), [CUSTOM_KEY]: { ...existing, pollOptionSources: registry } }\n}\n\nexport const pollOptionSourcesOf = (payload: Payload): PollOptionSourceRegistry => {\n\tconst custom = payload.config.custom?.[CUSTOM_KEY] as\n\t\t| { pollOptionSources?: PollOptionSourceRegistry }\n\t\t| undefined\n\treturn custom?.pollOptionSources ?? new Map()\n}\n\nconst CACHE_KEY = 'formBuilderPollOptionsCache'\n\ntype OptionsCache = Map<string, PollOption[]>\n\nconst cacheOf = (req: PayloadRequest | undefined): OptionsCache | undefined => {\n\tif (!req?.context) {\n\t\treturn undefined\n\t}\n\tconst existing = req.context[CACHE_KEY]\n\tif (existing instanceof Map) {\n\t\treturn existing as OptionsCache\n\t}\n\tconst created: OptionsCache = new Map()\n\treq.context[CACHE_KEY] = created\n\treturn created\n}\n\nexport type ResolvePollOptionsArgs = {\n\tpayload: Payload\n\treq?: PayloadRequest\n\t/** A loaded forms document (its `poll` group drives resolution). */\n\tform: { id: number | string; title?: string | null; poll?: unknown }\n\t/** Registry override for plugin-internal callers; defaults to the registry the plugin stashed on the config. */\n\tsources?: PollOptionSourceRegistry\n}\n\n/**\n * Resolve a poll-enabled form's choice options from its configured option source (plugin option\n * `poll.sources`). Returns `undefined` when the form is not poll-enabled or has no `optionSource`\n * set, so hand-authored options render unchanged. Hosts call this server-side and hand the result\n * to `toFormDocument(doc, { pollOptions })`; submission validation calls it too, making the\n * resolved values the only accepted answers. Throws when the configured source type is not\n * registered or its `resolve` fails; results are cached per request (keyed by form id) when a\n * `req` is provided.\n */\nexport const resolvePollOptions = async (\n\targs: ResolvePollOptionsArgs\n): Promise<PollOption[] | undefined> => {\n\tconst { payload, req, form, sources } = args\n\tconst poll = pollConfigOf(form.poll)\n\tconst optionSource = typeof poll?.optionSource === 'string' ? poll.optionSource : undefined\n\tif (poll?.enabled !== true || !optionSource) {\n\t\treturn undefined\n\t}\n\tconst source = (sources ?? pollOptionSourcesOf(payload)).get(optionSource)\n\tif (!source) {\n\t\tthrow new Error(\n\t\t\t`Poll option source \"${optionSource}\" is not registered. Register it via the plugin's poll.sources option.`\n\t\t)\n\t}\n\tconst cache = cacheOf(req)\n\tconst cacheKey = String(form.id)\n\tconst cached = cache?.get(cacheKey)\n\tif (cached) {\n\t\treturn cached\n\t}\n\tconst config =\n\t\tpoll.sourceConfig != null && typeof poll.sourceConfig === 'object'\n\t\t\t? (poll.sourceConfig as Record<string, unknown>)\n\t\t\t: {}\n\tconst options = await source.resolve({\n\t\tconfig,\n\t\tform: { id: form.id, title: typeof form.title === 'string' ? form.title : undefined },\n\t\tpayload,\n\t\treq,\n\t})\n\tcache?.set(cacheKey, options)\n\treturn options\n}\n"],"mappings":";;;AAMA,MAAM,aAAa;;AAGnB,MAAa,0BACZ,QACA,aAC6B;CAC7B,MAAM,WACL,SAAS,eAAe,QAAQ,OAAO,OAAO,gBAAgB,WAC1D,OAAO,cACR,CAAC;CACL,OAAO;EAAE,GAAI,UAAU,CAAC;GAAK,aAAa;GAAE,GAAG;GAAU,mBAAmB;EAAS;CAAE;AACxF;AAEA,MAAa,uBAAuB,YAA+C;CAIlF,QAHe,QAAQ,OAAO,SAAS,cAGxB,qCAAqB,IAAI,IAAI;AAC7C;AAEA,MAAM,YAAY;AAIlB,MAAM,WAAW,QAA8D;CAC9E,IAAI,CAAC,KAAK,SACT;CAED,MAAM,WAAW,IAAI,QAAQ;CAC7B,IAAI,oBAAoB,KACvB,OAAO;CAER,MAAM,0BAAwB,IAAI,IAAI;CACtC,IAAI,QAAQ,aAAa;CACzB,OAAO;AACR;;;;;;;;;;AAoBA,MAAa,qBAAqB,OACjC,SACuC;CACvC,MAAM,EAAE,SAAS,KAAK,MAAM,YAAY;CACxC,MAAM,OAAO,aAAa,KAAK,IAAI;CACnC,MAAM,eAAe,OAAO,MAAM,iBAAiB,WAAW,KAAK,eAAe,KAAA;CAClF,IAAI,MAAM,YAAY,QAAQ,CAAC,cAC9B;CAED,MAAM,UAAU,WAAW,oBAAoB,OAAO,GAAG,IAAI,YAAY;CACzE,IAAI,CAAC,QACJ,MAAM,IAAI,MACT,uBAAuB,aAAa,uEACrC;CAED,MAAM,QAAQ,QAAQ,GAAG;CACzB,MAAM,WAAW,OAAO,KAAK,EAAE;CAC/B,MAAM,SAAS,OAAO,IAAI,QAAQ;CAClC,IAAI,QACH,OAAO;CAER,MAAM,SACL,KAAK,gBAAgB,QAAQ,OAAO,KAAK,iBAAiB,WACtD,KAAK,eACN,CAAC;CACL,MAAM,UAAU,MAAM,OAAO,QAAQ;EACpC;EACA,MAAM;GAAE,IAAI,KAAK;GAAI,OAAO,OAAO,KAAK,UAAU,WAAW,KAAK,QAAQ,KAAA;EAAU;EACpF;EACA;CACD,CAAC;CACD,OAAO,IAAI,UAAU,OAAO;CAC5B,OAAO;AACR"}

package/dist/poll/resolvePollOutcome.d.ts

@@ -0,0 +1,21 @@
+import { Payload, PayloadRequest } from "payload";
+
+//#region src/poll/resolvePollOutcome.d.ts
+type ResolvePollOutcomeArgs = {
+  payload: Payload;
+  formId: number | string; /** A stable option value, matching one of the poll's choice values (the host's contract with `PollOption.value`). */
+  winningValue: string;
+  req?: PayloadRequest;
+};
+/**
+ * Record a poll's final outcome from host domain logic (e.g. after the race is decided): writes
+ * `poll.outcome.winningValue` and stamps `resolvedAt` with the current time. The outcome fields are
+ * admin read-only with field-level `update: () => false`, so this server-side call (with
+ * `overrideAccess`) is the only write path. Throws when the form does not exist or is not
+ * poll-enabled. `<Poll>` treats a present `winningValue` as the final state and highlights the
+ * matching result bucket.
+ */
+declare const resolvePollOutcome: (args: ResolvePollOutcomeArgs) => Promise<void>;
+//#endregion
+export { ResolvePollOutcomeArgs, resolvePollOutcome };
+//# sourceMappingURL=resolvePollOutcome.d.ts.map

package/dist/poll/resolvePollOutcome.js

@@ -0,0 +1,36 @@
+import { pollConfigOf } from "../form/pollState.js";
+import { FORMS_SLUG } from "../collections/forms.js";
+//#region src/poll/resolvePollOutcome.ts
+/**
+* Record a poll's final outcome from host domain logic (e.g. after the race is decided): writes
+* `poll.outcome.winningValue` and stamps `resolvedAt` with the current time. The outcome fields are
+* admin read-only with field-level `update: () => false`, so this server-side call (with
+* `overrideAccess`) is the only write path. Throws when the form does not exist or is not
+* poll-enabled. `<Poll>` treats a present `winningValue` as the final state and highlights the
+* matching result bucket.
+*/
+const resolvePollOutcome = async (args) => {
+	const { payload, formId, winningValue, req } = args;
+	if (pollConfigOf((await payload.findByID({
+		collection: "forms",
+		id: formId,
+		depth: 0,
+		overrideAccess: true,
+		req
+	})).poll)?.enabled !== true) throw new Error(`Form ${String(formId)} is not poll-enabled; cannot record an outcome.`);
+	await payload.update({
+		collection: FORMS_SLUG,
+		id: formId,
+		data: { poll: { outcome: {
+			winningValue,
+			resolvedAt: (/* @__PURE__ */ new Date()).toISOString()
+		} } },
+		depth: 0,
+		overrideAccess: true,
+		req
+	});
+};
+//#endregion
+export { resolvePollOutcome };
+
+//# sourceMappingURL=resolvePollOutcome.js.map

package/dist/poll/resolvePollOutcome.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePollOutcome.js","names":[],"sources":["../../src/poll/resolvePollOutcome.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport { FORMS_SLUG } from '../collections/forms'\nimport { pollConfigOf } from '../form/pollState'\n\nexport type ResolvePollOutcomeArgs = {\n\tpayload: Payload\n\tformId: number | string\n\t/** A stable option value, matching one of the poll's choice values (the host's contract with `PollOption.value`). */\n\twinningValue: string\n\treq?: PayloadRequest\n}\n\n/**\n * Record a poll's final outcome from host domain logic (e.g. after the race is decided): writes\n * `poll.outcome.winningValue` and stamps `resolvedAt` with the current time. The outcome fields are\n * admin read-only with field-level `update: () => false`, so this server-side call (with\n * `overrideAccess`) is the only write path. Throws when the form does not exist or is not\n * poll-enabled. `<Poll>` treats a present `winningValue` as the final state and highlights the\n * matching result bucket.\n */\nexport const resolvePollOutcome = async (args: ResolvePollOutcomeArgs): Promise<void> => {\n\tconst { payload, formId, winningValue, req } = args\n\tconst form = await payload.findByID({\n\t\tcollection: FORMS_SLUG,\n\t\tid: formId,\n\t\tdepth: 0,\n\t\toverrideAccess: true,\n\t\treq,\n\t})\n\tconst poll = pollConfigOf(form.poll)\n\tif (poll?.enabled !== true) {\n\t\tthrow new Error(`Form ${String(formId)} is not poll-enabled; cannot record an outcome.`)\n\t}\n\tawait payload.update({\n\t\tcollection: FORMS_SLUG,\n\t\tid: formId,\n\t\tdata: { poll: { outcome: { winningValue, resolvedAt: new Date().toISOString() } } },\n\t\tdepth: 0,\n\t\toverrideAccess: true,\n\t\treq,\n\t})\n}\n"],"mappings":";;;;;;;;;;;AAoBA,MAAa,qBAAqB,OAAO,SAAgD;CACxF,MAAM,EAAE,SAAS,QAAQ,cAAc,QAAQ;CAS/C,IADa,cAAa,MAPP,QAAQ,SAAS;EACnC,YAAA;EACA,IAAI;EACJ,OAAO;EACP,gBAAgB;EAChB;CACD,CAAC,GAC8B,IACxB,GAAG,YAAY,MACrB,MAAM,IAAI,MAAM,QAAQ,OAAO,MAAM,EAAE,gDAAgD;CAExF,MAAM,QAAQ,OAAO;EACpB,YAAY;EACZ,IAAI;EACJ,MAAM,EAAE,MAAM,EAAE,SAAS;GAAE;GAAc,6BAAY,IAAI,KAAK,GAAE,YAAY;EAAE,EAAE,EAAE;EAClF,OAAO;EACP,gBAAgB;EAChB;CACD,CAAC;AACF"}

package/dist/prefill/valuesFromSearchParams.js

@@ -32,7 +32,7 @@ const valuesFromSearchParams = (params, fields, registry, options = {}) => {
 		if (options.deny?.includes(fieldName)) continue;
 		const field = byName.get(fieldName);
 		const definition = field && registry.get(field.blockType);
-		if (!field || !definition) continue;
+		if (!field || !definition || definition.value === "none") continue;
 		const all = isSearch ? params.getAll(param) : [params[param]];
 		const value = coerce(definition.value, all[0] ?? "", all);
 		if (value !== void 0) result[fieldName] = value;

package/dist/prefill/valuesFromSearchParams.js.map

@@ -1 +1 @@
-{"version":3,"file":"valuesFromSearchParams.js","names":[],"sources":["../../src/prefill/valuesFromSearchParams.ts"],"sourcesContent":["import type { FieldTypeRegistry } from '../fields/registry'\nimport type { FormFieldValueKind } from '../fields/types'\nimport type { FormFieldInstance } from '../submissions/types'\n\nexport type PrefillOptions = {\n\t/** Map a query-param name to a field name. Unmapped params use their own name. */\n\tmap?: Record<string, string>\n\t/** If set, only these field names may be prefilled. */\n\tallow?: string[]\n\t/** These field names may never be prefilled. */\n\tdeny?: string[]\n}\n\nconst TRUTHY = new Set(['true', '1', 'on', 'yes'])\n\nconst coerce = (kind: FormFieldValueKind, raw: string, all: string[]): unknown => {\n\tswitch (kind) {\n\t\tcase 'number': {\n\t\t\tconst n = Number(raw)\n\t\t\treturn Number.isNaN(n) ? undefined : n\n\t\t}\n\t\tcase 'boolean':\n\t\t\treturn TRUTHY.has(raw.toLowerCase())\n\t\tcase 'text[]':\n\t\t\treturn all\n\t\tdefault:\n\t\t\treturn raw\n\t}\n}\n\n/**\n * Map URL/query params to typed initial values for KNOWN fields only, coerced by each field's value\n * kind. Unknown, denied, or un-allowed params are ignored; invalid numbers are dropped. Prefilled\n * values are never trusted -- they still validate on submit. Pass the result to `<Form initialValues>`.\n */\n// biome-ignore lint/complexity/useMaxParams: four positional args are the minimal surface (params, fields, registry, options)\nexport const valuesFromSearchParams = (\n\tparams: URLSearchParams | Record<string, string>,\n\tfields: FormFieldInstance[],\n\tregistry: FieldTypeRegistry,\n\toptions: PrefillOptions = {}\n): Record<string, unknown> => {\n\tconst isSearch = params instanceof URLSearchParams\n\tconst paramKeys = isSearch ? [...new Set(params.keys())] : Object.keys(params)\n\tconst byName = new Map(fields.map((field) => [field.name, field]))\n\tconst result: Record<string, unknown> = {}\n\n\tfor (const param of paramKeys) {\n\t\tconst fieldName = options.map?.[param] ?? param\n\n\t\tif (options.allow && !options.allow.includes(fieldName)) {\n\t\t\tcontinue\n\t\t}\n\t\tif (options.deny?.includes(fieldName)) {\n\t\t\tcontinue\n\t\t}\n\n\t\tconst field = byName.get(fieldName)\n\t\tconst definition = field && registry.get(field.blockType)\n\t\tif (!field || !definition) {\n\t\t\tcontinue\n\t\t}\n\n\t\tconst all = isSearch ? params.getAll(param) : [params[param] as string]\n\t\tconst value = coerce(definition.value, all[0] ?? '', all)\n\t\tif (value !== undefined) {\n\t\t\tresult[fieldName] = value\n\t\t}\n\t}\n\n\treturn result\n}\n"],"mappings":";AAaA,MAAM,SAAS,IAAI,IAAI;CAAC;CAAQ;CAAK;CAAM;AAAK,CAAC;AAEjD,MAAM,UAAU,MAA0B,KAAa,QAA2B;CACjF,QAAQ,MAAR;EACC,KAAK,UAAU;GACd,MAAM,IAAI,OAAO,GAAG;GACpB,OAAO,OAAO,MAAM,CAAC,IAAI,KAAA,IAAY;EACtC;EACA,KAAK,WACJ,OAAO,OAAO,IAAI,IAAI,YAAY,CAAC;EACpC,KAAK,UACJ,OAAO;EACR,SACC,OAAO;CACT;AACD;;;;;;AAQA,MAAa,0BACZ,QACA,QACA,UACA,UAA0B,CAAC,MACE;CAC7B,MAAM,WAAW,kBAAkB;CACnC,MAAM,YAAY,WAAW,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,CAAC,CAAC,IAAI,OAAO,KAAK,MAAM;CAC7E,MAAM,SAAS,IAAI,IAAI,OAAO,KAAK,UAAU,CAAC,MAAM,MAAM,KAAK,CAAC,CAAC;CACjE,MAAM,SAAkC,CAAC;CAEzC,KAAK,MAAM,SAAS,WAAW;EAC9B,MAAM,YAAY,QAAQ,MAAM,UAAU;EAE1C,IAAI,QAAQ,SAAS,CAAC,QAAQ,MAAM,SAAS,SAAS,GACrD;EAED,IAAI,QAAQ,MAAM,SAAS,SAAS,GACnC;EAGD,MAAM,QAAQ,OAAO,IAAI,SAAS;EAClC,MAAM,aAAa,SAAS,SAAS,IAAI,MAAM,SAAS;EACxD,IAAI,CAAC,SAAS,CAAC,YACd;EAGD,MAAM,MAAM,WAAW,OAAO,OAAO,KAAK,IAAI,CAAC,OAAO,MAAgB;EACtE,MAAM,QAAQ,OAAO,WAAW,OAAO,IAAI,MAAM,IAAI,GAAG;EACxD,IAAI,UAAU,KAAA,GACb,OAAO,aAAa;CAEtB;CAEA,OAAO;AACR"}
+{"version":3,"file":"valuesFromSearchParams.js","names":[],"sources":["../../src/prefill/valuesFromSearchParams.ts"],"sourcesContent":["import type { FieldTypeRegistry } from '../fields/registry'\nimport type { FormFieldValueKind } from '../fields/types'\nimport type { FormFieldInstance } from '../submissions/types'\n\nexport type PrefillOptions = {\n\t/** Map a query-param name to a field name. Unmapped params use their own name. */\n\tmap?: Record<string, string>\n\t/** If set, only these field names may be prefilled. */\n\tallow?: string[]\n\t/** These field names may never be prefilled. */\n\tdeny?: string[]\n}\n\nconst TRUTHY = new Set(['true', '1', 'on', 'yes'])\n\nconst coerce = (kind: FormFieldValueKind, raw: string, all: string[]): unknown => {\n\tswitch (kind) {\n\t\tcase 'number': {\n\t\t\tconst n = Number(raw)\n\t\t\treturn Number.isNaN(n) ? undefined : n\n\t\t}\n\t\tcase 'boolean':\n\t\t\treturn TRUTHY.has(raw.toLowerCase())\n\t\tcase 'text[]':\n\t\t\treturn all\n\t\tdefault:\n\t\t\treturn raw\n\t}\n}\n\n/**\n * Map URL/query params to typed initial values for KNOWN fields only, coerced by each field's value\n * kind. Unknown, denied, or un-allowed params are ignored; invalid numbers are dropped. Prefilled\n * values are never trusted -- they still validate on submit. Pass the result to `<Form initialValues>`.\n */\n// biome-ignore lint/complexity/useMaxParams: four positional args are the minimal surface (params, fields, registry, options)\nexport const valuesFromSearchParams = (\n\tparams: URLSearchParams | Record<string, string>,\n\tfields: FormFieldInstance[],\n\tregistry: FieldTypeRegistry,\n\toptions: PrefillOptions = {}\n): Record<string, unknown> => {\n\tconst isSearch = params instanceof URLSearchParams\n\tconst paramKeys = isSearch ? [...new Set(params.keys())] : Object.keys(params)\n\tconst byName = new Map(fields.map((field) => [field.name, field]))\n\tconst result: Record<string, unknown> = {}\n\n\tfor (const param of paramKeys) {\n\t\tconst fieldName = options.map?.[param] ?? param\n\n\t\tif (options.allow && !options.allow.includes(fieldName)) {\n\t\t\tcontinue\n\t\t}\n\t\tif (options.deny?.includes(fieldName)) {\n\t\t\tcontinue\n\t\t}\n\n\t\tconst field = byName.get(fieldName)\n\t\tconst definition = field && registry.get(field.blockType)\n\t\t// 'none'-kind (display-only) fields carry no value, so a param under their name is ignored.\n\t\tif (!field || !definition || definition.value === 'none') {\n\t\t\tcontinue\n\t\t}\n\n\t\tconst all = isSearch ? params.getAll(param) : [params[param] as string]\n\t\tconst value = coerce(definition.value, all[0] ?? '', all)\n\t\tif (value !== undefined) {\n\t\t\tresult[fieldName] = value\n\t\t}\n\t}\n\n\treturn result\n}\n"],"mappings":";AAaA,MAAM,SAAS,IAAI,IAAI;CAAC;CAAQ;CAAK;CAAM;AAAK,CAAC;AAEjD,MAAM,UAAU,MAA0B,KAAa,QAA2B;CACjF,QAAQ,MAAR;EACC,KAAK,UAAU;GACd,MAAM,IAAI,OAAO,GAAG;GACpB,OAAO,OAAO,MAAM,CAAC,IAAI,KAAA,IAAY;EACtC;EACA,KAAK,WACJ,OAAO,OAAO,IAAI,IAAI,YAAY,CAAC;EACpC,KAAK,UACJ,OAAO;EACR,SACC,OAAO;CACT;AACD;;;;;;AAQA,MAAa,0BACZ,QACA,QACA,UACA,UAA0B,CAAC,MACE;CAC7B,MAAM,WAAW,kBAAkB;CACnC,MAAM,YAAY,WAAW,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,CAAC,CAAC,IAAI,OAAO,KAAK,MAAM;CAC7E,MAAM,SAAS,IAAI,IAAI,OAAO,KAAK,UAAU,CAAC,MAAM,MAAM,KAAK,CAAC,CAAC;CACjE,MAAM,SAAkC,CAAC;CAEzC,KAAK,MAAM,SAAS,WAAW;EAC9B,MAAM,YAAY,QAAQ,MAAM,UAAU;EAE1C,IAAI,QAAQ,SAAS,CAAC,QAAQ,MAAM,SAAS,SAAS,GACrD;EAED,IAAI,QAAQ,MAAM,SAAS,SAAS,GACnC;EAGD,MAAM,QAAQ,OAAO,IAAI,SAAS;EAClC,MAAM,aAAa,SAAS,SAAS,IAAI,MAAM,SAAS;EAExD,IAAI,CAAC,SAAS,CAAC,cAAc,WAAW,UAAU,QACjD;EAGD,MAAM,MAAM,WAAW,OAAO,OAAO,KAAK,IAAI,CAAC,OAAO,MAAgB;EACtE,MAAM,QAAQ,OAAO,WAAW,OAAO,IAAI,MAAM,IAAI,GAAG;EACxD,IAAI,UAAU,KAAA,GACb,OAAO,aAAa;CAEtB;CAEA,OAAO;AACR"}

package/dist/presentations/types.d.ts

@@ -3,8 +3,9 @@
 type PresentationSurface = 'inline' | 'page' | 'overlay';
 type PresentationDensity = 'comfortable' | 'compact';
 /**
- * Serializable, framework-agnostic description of a presentation. The admin select and the
- * stored `defaultPresentation` use only this; the React `Wrapper` is added in `./react`. No React here.
+ * Serializable, framework-agnostic description of a presentation. `presentations/defaults.ts`
+ * ships the built-ins the React presentation registry wraps with a `Wrapper` (see `./react`). No
+ * React here.
  */
 type PresentationDescriptor = {
   name: string; /** i18n key or literal shown in the admin select. */

package/dist/react/Form.d.ts

@@ -1,9 +1,9 @@
 import { AnyFormFieldDefinition } from "../fields/types.js";
-import { FormFieldInstance } from "../submissions/types.js";
-import { FormFlow } from "../flow/types.js";
+import { FormDisplaySettings, FormDocument, FormPollSettings, FormResponseSettings } from "../form/types.js";
 import { RendererTranslate } from "./contract.js";
 import { FormEventSink } from "../events/types.js";
 import { AnyValidationRuleDefinition } from "../validation/types.js";
+import { BackButtonRenderProps, NextButtonRenderProps, SubmitButtonRenderProps } from "./FormControls.js";
 import { FormPresentation } from "./presentation/types.js";
 import { PresentationsConfig } from "./presentation/registry.js";
 import { RenderersConfig } from "./registry.js";
@@ -11,29 +11,6 @@ import { SubmitHandler } from "./submitForm.js";
 import { ReactNode } from "react";
 
 //#region src/react/Form.d.ts
-type FormDocument = {
-  id: number | string;
-  fields: FormFieldInstance[];
-  flow?: FormFlow; /** Stored presentation name; overridden by the `presentation` prop. */
-  defaultPresentation?: string;
-};
-/** Props passed to `renderSubmit`. */
-type SubmitButtonRenderProps = {
-  label: string;
-  submitting: boolean;
-};
-/** Props passed to `renderNext`. */
-type NextButtonRenderProps = {
-  label: string;
-  submitting: boolean;
-  onClick: () => void;
-};
-/** Props passed to `renderBack`. */
-type BackButtonRenderProps = {
-  label: string;
-  submitting: boolean;
-  onClick: () => void;
-};
 type FormProps = {
   form: FormDocument;
   fieldTypes?: AnyFormFieldDefinition[];
@@ -46,15 +23,20 @@ type FormProps = {
   events?: FormEventSink;
   t?: RendererTranslate;
   locale?: string;
-  layout?: boolean;
-  submitLabel?: string;
-  nextLabel?: string;
+  layout?: boolean; /** Submit button label. Precedence: this prop, then the form's `response.submitLabel`, then the translated default. */
+  submitLabel?: string; /** "Next" button label for multi-step forms. Defaults to the translated `'Next'`. */
+  nextLabel?: string; /** "Back" button label for multi-step forms. Defaults to the translated `'Back'`. */
   backLabel?: string; /** Label for the overlay close control (modal/drawer). */
   closeLabel?: string;
-  successMessage?: string; /** Active presentation: a name into the registry or an inline presentation. Overrides the form's stored default. */
+  successMessage?: string; /** Active presentation: a name into the registry or an inline presentation. Defaults to `'page'` when omitted. */
   presentation?: string | FormPresentation; /** Per-render presentation overrides merged onto the defaults (add, replace, or `false` to remove). */
   presentations?: PresentationsConfig; /** Invoked when an overlay presentation dismisses (close button, Escape, outside click, or `dismissOnSuccess`). */
-  onClose?: () => void; /** Accessible name for an overlay surface. */
+  onClose?: () => void;
+  /**
+   * Accessible name for an overlay surface (modal/drawer). Hosts choosing between a trigger
+   * label and the form's own display title should prefer `form.display?.title` when
+   * `form.display?.showTitle` is set, falling back to their own label otherwise.
+   */
   title?: string; /** Seed initial field values (e.g. from `valuesFromSearchParams`). Still validated on submit. */
   initialValues?: Record<string, unknown>; /** Honeypot decoy (on by default). `false` removes it; `{ name }` matches a customized server `spam.honeypot.fieldName`. */
   honeypot?: false | {
@@ -106,5 +88,5 @@ declare const Form: ({
   backButtonClassName
 }: FormProps) => import("react/jsx-runtime").JSX.Element;
 //#endregion
-export { BackButtonRenderProps, Form, FormDocument, FormProps, NextButtonRenderProps, SubmitButtonRenderProps };
+export { Form, FormProps };
 //# sourceMappingURL=Form.d.ts.map