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

package/dist/flow/types.d.ts

@@ -9,9 +9,18 @@ type FlowTransition = {
 /** A flow step: a named group of fields, ordered transitions, and a default next edge. */
 type FlowStep = {
   id: string;
-  title?: string; /** Field machine names rendered in this step (a subset of the form's fields). */
-  fields: string[]; /** Default next step id when no transition matches. Absent -> this step is terminal. */
-  next?: string; /** Ordered conditional edges; the first whose `when` matches the answers wins. */
+  title?: string;
+  /**
+   * Field keys rendered in this step (a subset of the form's fields): machine names for named
+   * fields, block row ids for bare (nameless) blocks. See `fieldKey`.
+   */
+  fields: string[];
+  /**
+   * Default next edge when no transition matches. Absent -> fall through to the next step in
+   * array order (the last step ends the form). `null` -> explicit end of form regardless of
+   * position. A step id -> jump to that step.
+   */
+  next?: string | null; /** Ordered conditional edges; the first whose `when` matches the answers wins. */
   transitions?: FlowTransition[];
 };
 /** A serializable multi-step flow layered over the form's flat field list. */

package/dist/flow/types.js

@@ -0,0 +1,11 @@
+//#region src/flow/types.ts
+/**
+* Reserved value the flow builder's next select maps to `next: null` (explicit end of form).
+* Builder-generated step ids are UUIDs (hex digits + dashes) and can never equal it;
+* `validateFlow` rejects API-authored steps claiming it as an id so the mapping stays unambiguous.
+*/
+const END_OF_FORM = "__end__";
+//#endregion
+export { END_OF_FORM };
+
+//# sourceMappingURL=types.js.map

package/dist/flow/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../src/flow/types.ts"],"sourcesContent":["import type { Where } from 'payload'\n\n/** A conditional edge: when `when` matches the answers, route to step `to`. */\nexport type FlowTransition = { when: Where; to: string }\n\n/** A flow step: a named group of fields, ordered transitions, and a default next edge. */\nexport type FlowStep = {\n\tid: string\n\ttitle?: string\n\t/**\n\t * Field keys rendered in this step (a subset of the form's fields): machine names for named\n\t * fields, block row ids for bare (nameless) blocks. See `fieldKey`.\n\t */\n\tfields: string[]\n\t/**\n\t * Default next edge when no transition matches. Absent -> fall through to the next step in\n\t * array order (the last step ends the form). `null` -> explicit end of form regardless of\n\t * position. A step id -> jump to that step.\n\t */\n\tnext?: string | null\n\t/** Ordered conditional edges; the first whose `when` matches the answers wins. */\n\ttransitions?: FlowTransition[]\n}\n\n/** A serializable multi-step flow layered over the form's flat field list. */\nexport type FormFlow = { steps: FlowStep[] }\n\n/**\n * Reserved value the flow builder's next select maps to `next: null` (explicit end of form).\n * Builder-generated step ids are UUIDs (hex digits + dashes) and can never equal it;\n * `validateFlow` rejects API-authored steps claiming it as an id so the mapping stays unambiguous.\n */\nexport const END_OF_FORM = '__end__'\n"],"mappings":";;;;;;AAgCA,MAAa,cAAc"}

package/dist/form/pollState.d.ts

@@ -1,14 +1,14 @@
 //#region src/form/pollState.d.ts
 /** Poll settings as loaded from a forms document (server) or a `FormDocument` (client). */
 type PollConfigLike = {
-  enabled?: boolean | null;
   resultsField?: string | null;
   resultsVisibility?: string | null;
-  closesAt?: string | null;
+  closesAt?: string | null; /** The outcome-resolution strategy slug (`poll.types` registry). Absent is treated as `manual`. */
+  type?: string | null;
   optionSource?: string | null;
   sourceConfig?: Record<string, unknown> | null;
   outcome?: {
-    winningValue?: string | null;
+    winningValues?: (string | null)[] | null;
     resolvedAt?: string | null;
   } | null;
 };
@@ -18,5 +18,5 @@ type PollConfigLike = {
  */
 declare const isPollClosed: (poll: PollConfigLike | null | undefined, now?: number) => boolean;
 //#endregion
-export { isPollClosed };
+export { PollConfigLike, isPollClosed };
 //# sourceMappingURL=pollState.d.ts.map

package/dist/form/pollState.js.map

@@ -1 +1 @@
-{"version":3,"file":"pollState.js","names":[],"sources":["../../src/form/pollState.ts"],"sourcesContent":["/** Poll settings as loaded from a forms document (server) or a `FormDocument` (client). */\nexport type PollConfigLike = {\n\tenabled?: boolean | null\n\tresultsField?: string | null\n\tresultsVisibility?: string | null\n\tclosesAt?: string | null\n\toptionSource?: string | null\n\tsourceConfig?: Record<string, unknown> | null\n\toutcome?: { winningValue?: string | null; resolvedAt?: string | null } | null\n}\n\n/** Narrow a forms document's untyped `poll` member. */\nexport const pollConfigOf = (poll: unknown): PollConfigLike | undefined =>\n\tpoll != null && typeof poll === 'object' ? (poll as PollConfigLike) : undefined\n\n/**\n * Whether the poll's `closesAt` has passed. An unset or unparseable `closesAt` never closes;\n * framework-agnostic so the server guard, the results gate, and the client `<Poll>` agree.\n */\nexport const isPollClosed = (\n\tpoll: PollConfigLike | null | undefined,\n\tnow: number = Date.now()\n): boolean => {\n\tconst closesAt = poll?.closesAt\n\tif (typeof closesAt !== 'string' || closesAt.length === 0) {\n\t\treturn false\n\t}\n\tconst ts = Date.parse(closesAt)\n\treturn Number.isFinite(ts) && ts <= now\n}\n"],"mappings":";;AAYA,MAAa,gBAAgB,SAC5B,QAAQ,QAAQ,OAAO,SAAS,WAAY,OAA0B,KAAA;;;;;AAMvE,MAAa,gBACZ,MACA,MAAc,KAAK,IAAI,MACV;CACb,MAAM,WAAW,MAAM;CACvB,IAAI,OAAO,aAAa,YAAY,SAAS,WAAW,GACvD,OAAO;CAER,MAAM,KAAK,KAAK,MAAM,QAAQ;CAC9B,OAAO,OAAO,SAAS,EAAE,KAAK,MAAM;AACrC"}
+{"version":3,"file":"pollState.js","names":[],"sources":["../../src/form/pollState.ts"],"sourcesContent":["/** Poll settings as loaded from a forms document (server) or a `FormDocument` (client). */\nexport type PollConfigLike = {\n\tresultsField?: string | null\n\tresultsVisibility?: string | null\n\tclosesAt?: string | null\n\t/** The outcome-resolution strategy slug (`poll.types` registry). Absent is treated as `manual`. */\n\ttype?: string | null\n\toptionSource?: string | null\n\tsourceConfig?: Record<string, unknown> | null\n\toutcome?: { winningValues?: (string | null)[] | null; resolvedAt?: string | null } | null\n}\n\n/** Narrow a forms document's untyped `poll` member. */\nexport const pollConfigOf = (poll: unknown): PollConfigLike | undefined =>\n\tpoll != null && typeof poll === 'object' ? (poll as PollConfigLike) : undefined\n\n/**\n * Whether the poll's `closesAt` has passed. An unset or unparseable `closesAt` never closes;\n * framework-agnostic so the server guard, the results gate, and the client `<Poll>` agree.\n */\nexport const isPollClosed = (\n\tpoll: PollConfigLike | null | undefined,\n\tnow: number = Date.now()\n): boolean => {\n\tconst closesAt = poll?.closesAt\n\tif (typeof closesAt !== 'string' || closesAt.length === 0) {\n\t\treturn false\n\t}\n\tconst ts = Date.parse(closesAt)\n\treturn Number.isFinite(ts) && ts <= now\n}\n"],"mappings":";;AAaA,MAAa,gBAAgB,SAC5B,QAAQ,QAAQ,OAAO,SAAS,WAAY,OAA0B,KAAA;;;;;AAMvE,MAAa,gBACZ,MACA,MAAc,KAAK,IAAI,MACV;CACb,MAAM,WAAW,MAAM;CACvB,IAAI,OAAO,aAAa,YAAY,SAAS,WAAW,GACvD,OAAO;CAER,MAAM,KAAK,KAAK,MAAM,QAAQ;CAC9B,OAAO,OAAO,SAAS,EAAE,KAAK,MAAM;AACrC"}

package/dist/form/toFormDocument.d.ts

@@ -1,4 +1,5 @@
 import { PollOption } from "../poll/definePollOptionSource.js";
+import { ConsentStatements } from "../consent/resolveConsentStatements.js";
 import { FormDocument } from "./types.js";
 
 //#region src/form/toFormDocument.d.ts
@@ -9,17 +10,38 @@ type ToFormDocumentOptions = {
    * current choices instead of hand-authored ones.
    */
   pollOptions?: PollOption[];
+  /**
+   * Source-resolved consent statements (from `resolveConsentStatements`), injected into the
+   * consent field instances they name. A form stores only a source id, so without these its
+   * consent fields render with no statement at all.
+   */
+  consentStatements?: ConsentStatements;
 };
 /**
  * Narrows a Payload-generated form document (from `getPayload().findByID()` or `fetch`) to
  * `FormDocument` without an unsafe `as` cast. Handles the small structural mismatches between
  * the auto-generated collection types and what `<Form>` expects:
  * - `fields` may be a typed blocks-union array or null; normalized to `FormFieldInstance[]`
+ *   (nameless bare rows, e.g. message blocks, pass through with their row `id` intact)
  * - `flow` is stored as opaque JSON; typed as `FormFlow | undefined`
- * - `response` may be null; coerced to `undefined`
- * - `display` may be null; coerced to `undefined`
+ * - `response` may be null; coerced to `undefined`, otherwise passed through wholesale, which
+ *   includes `response.redirect.reference` (present only when the plugin's `redirectRelationships`
+ *   option is set): read the form at `depth: 0` to get Payload's raw `{ relationTo, value }` pair
+ *   rather than a populated document, since the host is the one who resolves it to a URL
+ * - the button labels (`submitLabel`/`prevLabel`/`nextLabel`) live at the document root now (there
+ *   is no `buttons` group); the non-empty ones are reassembled into `FormDocument.buttons`
+ * - `title` may be null; coerced to `undefined`
+ * - `multistep`/`pollEnabled` are the two top-level form-type flags, coerced to strict booleans
  * - `poll` may be null; coerced to `undefined` (`resultsField`, `optionSource`, and
- *   `sourceConfig` are dropped: server-side only; `outcome` passes through `winningValue` only)
+ *   `sourceConfig` are dropped: server-side only; `outcome` passes through `winningValues` only)
+ *
+ * Unknown keys survive on `response` but not on `poll`, which is deliberate rather than incidental.
+ * `response` is a visitor-facing group a host is meant to extend (`overrides.forms.fields`) and read
+ * back off `FormDocument` in custom chrome, so it is cast wholesale. `poll` is plugin-owned config
+ * that is split between
+ * client-safe lifecycle state and server-only members, so it is rebuilt from an allowlist: a
+ * passthrough would ship whatever a host put in `sourceConfig` (domain config, ids, credentials)
+ * to every anonymous visitor. Adding a client-visible poll member means naming it here.
  *
  * Pure and framework-agnostic (no 'use client'): safe to call from a Server Component or any
  * other server-side code before handing the result to the client `<Form>`.
@@ -28,7 +50,7 @@ declare function toFormDocument(form: {
   id: number | string;
   fields?: {
     blockType: string;
-    name: string;
+    name?: string;
     [key: string]: unknown;
   }[] | null;
   flow?: unknown;
@@ -37,21 +59,24 @@ declare function toFormDocument(form: {
     message?: unknown;
     redirect?: {
       url?: string | null;
+      reference?: {
+        relationTo?: string | null;
+        value?: number | string | null;
+      } | null;
     } | null;
-    submitLabel?: string | null;
-  } | null;
-  display?: {
-    showTitle?: boolean | null;
-    title?: string | null;
-    intro?: unknown;
   } | null;
+  submitLabel?: string | null;
+  prevLabel?: string | null;
+  nextLabel?: string | null;
+  title?: string | null;
+  multistep?: boolean | null;
+  pollEnabled?: boolean | null;
   poll?: {
-    enabled?: boolean | null;
     resultsField?: string | null;
     resultsVisibility?: string | null;
     closesAt?: string | null;
     outcome?: {
-      winningValue?: string | null;
+      winningValues?: (string | null)[] | null;
     } | null;
   } | null;
 }, options?: ToFormDocumentOptions): FormDocument;

package/dist/form/toFormDocument.js

@@ -1,35 +1,71 @@
 import { applyPollOptions } from "../poll/applyPollOptions.js";
+import { applyConsentStatements } from "../consent/applyConsentStatements.js";
 //#region src/form/toFormDocument.ts
 /**
+* Reassemble the client button labels from the document's top-level `submitLabel`/`prevLabel`/
+* `nextLabel` fields, keeping only non-empty strings (mirroring the client's own `storedLabel`
+* fallback). Returns `undefined` when the author set no label, so the client uses its defaults.
+*/
+const buttonSettingsOf = (form) => {
+	const label = (value) => typeof value === "string" && value.length > 0 ? value : void 0;
+	const settings = {};
+	const submitLabel = label(form.submitLabel);
+	const prevLabel = label(form.prevLabel);
+	const nextLabel = label(form.nextLabel);
+	if (submitLabel !== void 0) settings.submitLabel = submitLabel;
+	if (prevLabel !== void 0) settings.prevLabel = prevLabel;
+	if (nextLabel !== void 0) settings.nextLabel = nextLabel;
+	return Object.keys(settings).length > 0 ? settings : void 0;
+};
+/**
 * Narrows a Payload-generated form document (from `getPayload().findByID()` or `fetch`) to
 * `FormDocument` without an unsafe `as` cast. Handles the small structural mismatches between
 * the auto-generated collection types and what `<Form>` expects:
 * - `fields` may be a typed blocks-union array or null; normalized to `FormFieldInstance[]`
+*   (nameless bare rows, e.g. message blocks, pass through with their row `id` intact)
 * - `flow` is stored as opaque JSON; typed as `FormFlow | undefined`
-* - `response` may be null; coerced to `undefined`
-* - `display` may be null; coerced to `undefined`
+* - `response` may be null; coerced to `undefined`, otherwise passed through wholesale, which
+*   includes `response.redirect.reference` (present only when the plugin's `redirectRelationships`
+*   option is set): read the form at `depth: 0` to get Payload's raw `{ relationTo, value }` pair
+*   rather than a populated document, since the host is the one who resolves it to a URL
+* - the button labels (`submitLabel`/`prevLabel`/`nextLabel`) live at the document root now (there
+*   is no `buttons` group); the non-empty ones are reassembled into `FormDocument.buttons`
+* - `title` may be null; coerced to `undefined`
+* - `multistep`/`pollEnabled` are the two top-level form-type flags, coerced to strict booleans
 * - `poll` may be null; coerced to `undefined` (`resultsField`, `optionSource`, and
-*   `sourceConfig` are dropped: server-side only; `outcome` passes through `winningValue` only)
+*   `sourceConfig` are dropped: server-side only; `outcome` passes through `winningValues` only)
+*
+* Unknown keys survive on `response` but not on `poll`, which is deliberate rather than incidental.
+* `response` is a visitor-facing group a host is meant to extend (`overrides.forms.fields`) and read
+* back off `FormDocument` in custom chrome, so it is cast wholesale. `poll` is plugin-owned config
+* that is split between
+* client-safe lifecycle state and server-only members, so it is rebuilt from an allowlist: a
+* passthrough would ship whatever a host put in `sourceConfig` (domain config, ids, credentials)
+* to every anonymous visitor. Adding a client-visible poll member means naming it here.
 *
 * Pure and framework-agnostic (no 'use client'): safe to call from a Server Component or any
 * other server-side code before handing the result to the client `<Form>`.
 */
 function toFormDocument(form, options) {
-	const winningValue = form.poll?.outcome?.winningValue;
+	const rawWinningValues = form.poll?.outcome?.winningValues;
+	const winningValues = Array.isArray(rawWinningValues) ? rawWinningValues.filter((value) => typeof value === "string" && value.length > 0) : [];
 	const poll = form.poll ? {
-		enabled: form.poll.enabled ?? void 0,
 		resultsVisibility: form.poll.resultsVisibility ?? void 0,
 		closesAt: form.poll.closesAt ?? void 0,
-		...typeof winningValue === "string" && winningValue.length > 0 ? { outcome: { winningValue } } : {}
+		...winningValues.length > 0 ? { outcome: { winningValues } } : {}
 	} : void 0;
 	let fields = form.fields ?? [];
 	if (options?.pollOptions) fields = applyPollOptions(fields, form.poll?.resultsField, options.pollOptions);
+	if (options?.consentStatements) fields = applyConsentStatements(fields, options.consentStatements);
 	return {
 		id: form.id,
 		fields,
 		flow: form.flow,
 		response: form.response ?? void 0,
-		display: form.display ?? void 0,
+		buttons: buttonSettingsOf(form),
+		title: form.title ?? void 0,
+		multistep: form.multistep === true,
+		pollEnabled: form.pollEnabled === true,
 		poll
 	};
 }

package/dist/form/toFormDocument.js.map

@@ -1 +1 @@
-{"version":3,"file":"toFormDocument.js","names":[],"sources":["../../src/form/toFormDocument.ts"],"sourcesContent":["import type { FormFlow } from '../flow/types'\nimport { applyPollOptions } from '../poll/applyPollOptions'\nimport type { PollOption } from '../poll/definePollOptionSource'\nimport type { FormFieldInstance } from '../submissions/types'\nimport type { FormDisplaySettings, FormDocument, FormResponseSettings } from './types'\n\nexport type ToFormDocumentOptions = {\n\t/**\n\t * Source-resolved poll options (from `resolvePollOptions`), injected as the options of the\n\t * field instance named by the form's `poll.resultsField` so the client renders the host's\n\t * current choices instead of hand-authored ones.\n\t */\n\tpollOptions?: PollOption[]\n}\n\n/**\n * Narrows a Payload-generated form document (from `getPayload().findByID()` or `fetch`) to\n * `FormDocument` without an unsafe `as` cast. Handles the small structural mismatches between\n * the auto-generated collection types and what `<Form>` expects:\n * - `fields` may be a typed blocks-union array or null; normalized to `FormFieldInstance[]`\n * - `flow` is stored as opaque JSON; typed as `FormFlow | undefined`\n * - `response` may be null; coerced to `undefined`\n * - `display` may be null; coerced to `undefined`\n * - `poll` may be null; coerced to `undefined` (`resultsField`, `optionSource`, and\n *   `sourceConfig` are dropped: server-side only; `outcome` passes through `winningValue` only)\n *\n * Pure and framework-agnostic (no 'use client'): safe to call from a Server Component or any\n * other server-side code before handing the result to the client `<Form>`.\n */\nexport function toFormDocument(\n\tform: {\n\t\tid: number | string\n\t\tfields?: { blockType: string; name: string; [key: string]: unknown }[] | null\n\t\tflow?: unknown\n\t\tresponse?: {\n\t\t\ttype?: string | null\n\t\t\tmessage?: unknown\n\t\t\tredirect?: { url?: string | null } | null\n\t\t\tsubmitLabel?: string | null\n\t\t} | null\n\t\tdisplay?: {\n\t\t\tshowTitle?: boolean | null\n\t\t\ttitle?: string | null\n\t\t\tintro?: unknown\n\t\t} | null\n\t\tpoll?: {\n\t\t\tenabled?: boolean | null\n\t\t\tresultsField?: string | null\n\t\t\tresultsVisibility?: string | null\n\t\t\tclosesAt?: string | null\n\t\t\toutcome?: { winningValue?: string | null } | null\n\t\t} | null\n\t},\n\toptions?: ToFormDocumentOptions\n): FormDocument {\n\tconst winningValue = form.poll?.outcome?.winningValue\n\tconst poll = form.poll\n\t\t? {\n\t\t\t\tenabled: form.poll.enabled ?? undefined,\n\t\t\t\tresultsVisibility: (form.poll.resultsVisibility ?? undefined) as\n\t\t\t\t\t| 'afterVote'\n\t\t\t\t\t| 'afterClose'\n\t\t\t\t\t| undefined,\n\t\t\t\tclosesAt: form.poll.closesAt ?? undefined,\n\t\t\t\t...(typeof winningValue === 'string' && winningValue.length > 0\n\t\t\t\t\t? { outcome: { winningValue } }\n\t\t\t\t\t: {}),\n\t\t\t}\n\t\t: undefined\n\tlet fields = (form.fields ?? []) as FormFieldInstance[]\n\tif (options?.pollOptions) {\n\t\tfields = applyPollOptions(fields, form.poll?.resultsField, options.pollOptions)\n\t}\n\treturn {\n\t\tid: form.id,\n\t\tfields,\n\t\tflow: form.flow as FormFlow | undefined,\n\t\tresponse: (form.response as FormResponseSettings | null | undefined) ?? undefined,\n\t\tdisplay: (form.display as FormDisplaySettings | null | undefined) ?? undefined,\n\t\tpoll,\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;;AA6BA,SAAgB,eACf,MAuBA,SACe;CACf,MAAM,eAAe,KAAK,MAAM,SAAS;CACzC,MAAM,OAAO,KAAK,OACf;EACA,SAAS,KAAK,KAAK,WAAW,KAAA;EAC9B,mBAAoB,KAAK,KAAK,qBAAqB,KAAA;EAInD,UAAU,KAAK,KAAK,YAAY,KAAA;EAChC,GAAI,OAAO,iBAAiB,YAAY,aAAa,SAAS,IAC3D,EAAE,SAAS,EAAE,aAAa,EAAE,IAC5B,CAAC;CACL,IACC,KAAA;CACH,IAAI,SAAU,KAAK,UAAU,CAAC;CAC9B,IAAI,SAAS,aACZ,SAAS,iBAAiB,QAAQ,KAAK,MAAM,cAAc,QAAQ,WAAW;CAE/E,OAAO;EACN,IAAI,KAAK;EACT;EACA,MAAM,KAAK;EACX,UAAW,KAAK,YAAwD,KAAA;EACxE,SAAU,KAAK,WAAsD,KAAA;EACrE;CACD;AACD"}
+{"version":3,"file":"toFormDocument.js","names":[],"sources":["../../src/form/toFormDocument.ts"],"sourcesContent":["import { applyConsentStatements } from '../consent/applyConsentStatements'\nimport type { ConsentStatements } from '../consent/resolveConsentStatements'\nimport type { FormFlow } from '../flow/types'\nimport { applyPollOptions } from '../poll/applyPollOptions'\nimport type { PollOption } from '../poll/definePollOptionSource'\nimport type { FormFieldInstance } from '../submissions/types'\nimport type { FormButtonSettings, FormDocument, FormResponseSettings } from './types'\n\nexport type ToFormDocumentOptions = {\n\t/**\n\t * Source-resolved poll options (from `resolvePollOptions`), injected as the options of the\n\t * field instance named by the form's `poll.resultsField` so the client renders the host's\n\t * current choices instead of hand-authored ones.\n\t */\n\tpollOptions?: PollOption[]\n\t/**\n\t * Source-resolved consent statements (from `resolveConsentStatements`), injected into the\n\t * consent field instances they name. A form stores only a source id, so without these its\n\t * consent fields render with no statement at all.\n\t */\n\tconsentStatements?: ConsentStatements\n}\n\n/**\n * Reassemble the client button labels from the document's top-level `submitLabel`/`prevLabel`/\n * `nextLabel` fields, keeping only non-empty strings (mirroring the client's own `storedLabel`\n * fallback). Returns `undefined` when the author set no label, so the client uses its defaults.\n */\nconst buttonSettingsOf = (form: {\n\tsubmitLabel?: string | null\n\tprevLabel?: string | null\n\tnextLabel?: string | null\n}): FormButtonSettings | undefined => {\n\tconst label = (value: unknown): string | undefined =>\n\t\ttypeof value === 'string' && value.length > 0 ? value : undefined\n\tconst settings: FormButtonSettings = {}\n\tconst submitLabel = label(form.submitLabel)\n\tconst prevLabel = label(form.prevLabel)\n\tconst nextLabel = label(form.nextLabel)\n\tif (submitLabel !== undefined) settings.submitLabel = submitLabel\n\tif (prevLabel !== undefined) settings.prevLabel = prevLabel\n\tif (nextLabel !== undefined) settings.nextLabel = nextLabel\n\treturn Object.keys(settings).length > 0 ? settings : undefined\n}\n\n/**\n * Narrows a Payload-generated form document (from `getPayload().findByID()` or `fetch`) to\n * `FormDocument` without an unsafe `as` cast. Handles the small structural mismatches between\n * the auto-generated collection types and what `<Form>` expects:\n * - `fields` may be a typed blocks-union array or null; normalized to `FormFieldInstance[]`\n *   (nameless bare rows, e.g. message blocks, pass through with their row `id` intact)\n * - `flow` is stored as opaque JSON; typed as `FormFlow | undefined`\n * - `response` may be null; coerced to `undefined`, otherwise passed through wholesale, which\n *   includes `response.redirect.reference` (present only when the plugin's `redirectRelationships`\n *   option is set): read the form at `depth: 0` to get Payload's raw `{ relationTo, value }` pair\n *   rather than a populated document, since the host is the one who resolves it to a URL\n * - the button labels (`submitLabel`/`prevLabel`/`nextLabel`) live at the document root now (there\n *   is no `buttons` group); the non-empty ones are reassembled into `FormDocument.buttons`\n * - `title` may be null; coerced to `undefined`\n * - `multistep`/`pollEnabled` are the two top-level form-type flags, coerced to strict booleans\n * - `poll` may be null; coerced to `undefined` (`resultsField`, `optionSource`, and\n *   `sourceConfig` are dropped: server-side only; `outcome` passes through `winningValues` only)\n *\n * Unknown keys survive on `response` but not on `poll`, which is deliberate rather than incidental.\n * `response` is a visitor-facing group a host is meant to extend (`overrides.forms.fields`) and read\n * back off `FormDocument` in custom chrome, so it is cast wholesale. `poll` is plugin-owned config\n * that is split between\n * client-safe lifecycle state and server-only members, so it is rebuilt from an allowlist: a\n * passthrough would ship whatever a host put in `sourceConfig` (domain config, ids, credentials)\n * to every anonymous visitor. Adding a client-visible poll member means naming it here.\n *\n * Pure and framework-agnostic (no 'use client'): safe to call from a Server Component or any\n * other server-side code before handing the result to the client `<Form>`.\n */\nexport function toFormDocument(\n\tform: {\n\t\tid: number | string\n\t\tfields?: { blockType: string; name?: string; [key: string]: unknown }[] | null\n\t\tflow?: unknown\n\t\tresponse?: {\n\t\t\ttype?: string | null\n\t\t\tmessage?: unknown\n\t\t\tredirect?: {\n\t\t\t\turl?: string | null\n\t\t\t\treference?: { relationTo?: string | null; value?: number | string | null } | null\n\t\t\t} | null\n\t\t} | null\n\t\tsubmitLabel?: string | null\n\t\tprevLabel?: string | null\n\t\tnextLabel?: string | null\n\t\ttitle?: string | null\n\t\tmultistep?: boolean | null\n\t\tpollEnabled?: boolean | null\n\t\tpoll?: {\n\t\t\tresultsField?: string | null\n\t\t\tresultsVisibility?: string | null\n\t\t\tclosesAt?: string | null\n\t\t\toutcome?: { winningValues?: (string | null)[] | null } | null\n\t\t} | null\n\t},\n\toptions?: ToFormDocumentOptions\n): FormDocument {\n\tconst rawWinningValues = form.poll?.outcome?.winningValues\n\tconst winningValues = Array.isArray(rawWinningValues)\n\t\t? rawWinningValues.filter(\n\t\t\t\t(value): value is string => typeof value === 'string' && value.length > 0\n\t\t\t)\n\t\t: []\n\tconst poll = form.poll\n\t\t? {\n\t\t\t\tresultsVisibility: (form.poll.resultsVisibility ?? undefined) as\n\t\t\t\t\t| 'afterVote'\n\t\t\t\t\t| 'afterClose'\n\t\t\t\t\t| undefined,\n\t\t\t\tclosesAt: form.poll.closesAt ?? undefined,\n\t\t\t\t...(winningValues.length > 0 ? { outcome: { winningValues } } : {}),\n\t\t\t}\n\t\t: undefined\n\tlet fields = (form.fields ?? []) as FormFieldInstance[]\n\tif (options?.pollOptions) {\n\t\tfields = applyPollOptions(fields, form.poll?.resultsField, options.pollOptions)\n\t}\n\tif (options?.consentStatements) {\n\t\tfields = applyConsentStatements(fields, options.consentStatements)\n\t}\n\treturn {\n\t\tid: form.id,\n\t\tfields,\n\t\tflow: form.flow as FormFlow | undefined,\n\t\tresponse: (form.response as FormResponseSettings | null | undefined) ?? undefined,\n\t\tbuttons: buttonSettingsOf(form),\n\t\ttitle: form.title ?? undefined,\n\t\tmultistep: form.multistep === true,\n\t\tpollEnabled: form.pollEnabled === true,\n\t\tpoll,\n\t}\n}\n"],"mappings":";;;;;;;;AA4BA,MAAM,oBAAoB,SAIY;CACrC,MAAM,SAAS,UACd,OAAO,UAAU,YAAY,MAAM,SAAS,IAAI,QAAQ,KAAA;CACzD,MAAM,WAA+B,CAAC;CACtC,MAAM,cAAc,MAAM,KAAK,WAAW;CAC1C,MAAM,YAAY,MAAM,KAAK,SAAS;CACtC,MAAM,YAAY,MAAM,KAAK,SAAS;CACtC,IAAI,gBAAgB,KAAA,GAAW,SAAS,cAAc;CACtD,IAAI,cAAc,KAAA,GAAW,SAAS,YAAY;CAClD,IAAI,cAAc,KAAA,GAAW,SAAS,YAAY;CAClD,OAAO,OAAO,KAAK,QAAQ,EAAE,SAAS,IAAI,WAAW,KAAA;AACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,SAAgB,eACf,MAyBA,SACe;CACf,MAAM,mBAAmB,KAAK,MAAM,SAAS;CAC7C,MAAM,gBAAgB,MAAM,QAAQ,gBAAgB,IACjD,iBAAiB,QAChB,UAA2B,OAAO,UAAU,YAAY,MAAM,SAAS,CACzE,IACC,CAAC;CACJ,MAAM,OAAO,KAAK,OACf;EACA,mBAAoB,KAAK,KAAK,qBAAqB,KAAA;EAInD,UAAU,KAAK,KAAK,YAAY,KAAA;EAChC,GAAI,cAAc,SAAS,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,IAAI,CAAC;CAClE,IACC,KAAA;CACH,IAAI,SAAU,KAAK,UAAU,CAAC;CAC9B,IAAI,SAAS,aACZ,SAAS,iBAAiB,QAAQ,KAAK,MAAM,cAAc,QAAQ,WAAW;CAE/E,IAAI,SAAS,mBACZ,SAAS,uBAAuB,QAAQ,QAAQ,iBAAiB;CAElE,OAAO;EACN,IAAI,KAAK;EACT;EACA,MAAM,KAAK;EACX,UAAW,KAAK,YAAwD,KAAA;EACxE,SAAS,iBAAiB,IAAI;EAC9B,OAAO,KAAK,SAAS,KAAA;EACrB,WAAW,KAAK,cAAc;EAC9B,aAAa,KAAK,gBAAgB;EAClC;CACD;AACD"}

package/dist/form/types.d.ts

@@ -5,17 +5,32 @@ import { FormFlow } from "../flow/types.js";
 /** Serializable per-form response settings: what the visitor gets after a successful submit. */
 type FormResponseSettings = {
   type?: 'message' | 'redirect' | null; /** Rich text state serialized via `serializeBody`; shown instead of the plain `successMessage`. */
-  message?: unknown; /** Applies on the custom-`children` path too (part of submit handling); `message`/`submitLabel` only affect default rendering. */
+  message?: unknown; /** Applies on the custom-`children` path too (part of submit handling); `message` only affects default rendering. */
   redirect?: {
     url?: string | null;
+    /**
+     * Present when the plugin's `redirectRelationships` option is set and the author picked an
+     * internal document. Mirrors Payload's depth-0 polymorphic relationship shape (`value` is
+     * the bare id, never populated): the HOST resolves this to a URL itself (e.g. by looking up
+     * the referenced document's own route), since the plugin has no notion of the host's
+     * routing, matching the model of Payload's native `plugin-form-builder` redirect relationship.
+     */
+    reference?: {
+      relationTo: string;
+      value: number | string;
+    } | null;
   } | null;
-  submitLabel?: string | null;
 };
-/** Serializable per-form display settings: what the visitor sees above the fields, before submit. */
-type FormDisplaySettings = {
-  showTitle?: boolean;
-  title?: string; /** Rich text state serialized via `serializeBody`; rendered above the fields when non-empty. */
-  intro?: unknown;
+/**
+ * Serializable per-form button labels. `toFormDocument` reassembles these from the document's
+ * top-level `submitLabel`/`prevLabel`/`nextLabel` fields (there is no longer a `buttons` group).
+ * The index signature lets custom chrome read any extra label a host threads on itself.
+ */
+type FormButtonSettings = {
+  submitLabel?: string | null;
+  nextLabel?: string | null;
+  prevLabel?: string | null;
+  [key: string]: unknown;
 };
 /**
  * Serializable per-form poll settings the client needs for lifecycle rendering (open/voted/closed).
@@ -23,11 +38,10 @@ type FormDisplaySettings = {
  * itself, so the client never needs it from the document.
  */
 type FormPollSettings = {
-  enabled?: boolean; /** When anonymous callers may read aggregate results. Default 'afterVote'. */
-  resultsVisibility?: 'afterVote' | 'afterClose' | null; /** ISO date after which submissions are rejected and the poll renders as closed. */
-  closesAt?: string | null; /** Present once the host recorded a final outcome via `resolvePollOutcome`; `<Poll>` renders the final state. */
+  /** When anonymous callers may read aggregate results. Default 'afterVote'. */resultsVisibility?: 'afterVote' | 'afterClose' | null; /** ISO date after which submissions are rejected and the poll renders as closed. */
+  closesAt?: string | null; /** Present once the host recorded a final outcome via `resolvePollOutcome`; `<Poll>` renders the final state. A tie carries more than one value. */
   outcome?: {
-    winningValue?: string;
+    winningValues?: string[];
   };
 };
 /**
@@ -39,10 +53,13 @@ type FormDocument = {
   id: number | string;
   fields: FormFieldInstance[];
   flow?: FormFlow;
-  response?: FormResponseSettings;
-  display?: FormDisplaySettings;
+  response?: FormResponseSettings; /** Button labels (and any host-added button settings). Label precedence: `<Form>` prop, then this, then the translated default. */
+  buttons?: FormButtonSettings; /** The form's admin title (the collection's `useAsTitle` field). Render it, or not: the host decides. */
+  title?: string; /** Whether the form uses multi-step (flow) navigation. Drives client step rendering; flow data may still exist when false. */
+  multistep: boolean; /** Whether this form is a poll. Gates poll rendering and results; the poll config lives under `poll`. */
+  pollEnabled: boolean;
   poll?: FormPollSettings;
 };
 //#endregion
-export { FormDisplaySettings, FormDocument, FormPollSettings, FormResponseSettings };
+export { FormButtonSettings, FormDocument, FormPollSettings, FormResponseSettings };
 //# sourceMappingURL=types.d.ts.map