@marktiderman/genesis-forms 0.5.0 → 0.6.0

package/dist/{engine-BDq0XJ21.d.cts → engine-CpfOz8FN.d.ts}

@@ -1,5 +1,5 @@
-import { e as FormEvent, J as Json, F as FormDefinition, a as FieldBlock, B as Block } from './types-BhYUbLJ-.cjs';
-import { F as FieldValidator, H as HostOptions } from './validate-BsZ0YTQS.cjs';
+import { e as FormEvent, J as Json, F as FormDefinition, a as FieldBlock, B as Block } from './types-oAckGR_Z.js';
+import { F as FieldValidator, H as HostOptions, L as LinkParams } from './validate-GpTXPwyl.js';
 
 /** Guards and helpers for event logs and other untrusted JSON. No dependencies. */
 
@@ -65,6 +65,13 @@ interface CreateFormOptions {
      * Pass the same lists to `validateSubmission` on the server.
      */
     hostOptions?: HostOptions | undefined;
+    /**
+     * The query parameters of the link the form was opened from (a `URLSearchParams` or a record).
+     * Choice questions with `props.prefill: { param }` take their parameter's value when it is one
+     * of their options (`prefillFromLink`); `initialValues` win over the link. A question with
+     * `props.prefill.hideWhenPrefilled` is then stepped over (`hiddenByPrefill`).
+     */
+    linkParams?: LinkParams | undefined;
 }
 interface FormEngine {
     /** The definition being filled in, with `hostOptions` filled in (`withHostOptions`). */
@@ -95,6 +102,6 @@ interface FormEngine {
 }
 declare function createForm(definition: FormDefinition, options?: CreateFormOptions): FormEngine;
 /** Rebuild a form's state from its event log. Timestamps are ignored. */
-declare function replay(definition: FormDefinition, events: FormEvent[], options?: Omit<CreateFormOptions, "clock" | "initialValues">): FormEngine;
+declare function replay(definition: FormDefinition, events: FormEvent[], options?: Omit<CreateFormOptions, "clock" | "initialValues" | "linkParams">): FormEngine;
 
 export { type CreateFormOptions as C, type FormEngine as F, type FormState as a, isJson as b, createForm as c, compactEvents as d, isFormEvent as i, replay as r };

package/dist/{engine-Qzp6bX6O.d.ts → engine-DC4YTPdr.d.cts}

@@ -1,5 +1,5 @@
-import { e as FormEvent, J as Json, F as FormDefinition, a as FieldBlock, B as Block } from './types-BhYUbLJ-.js';
-import { F as FieldValidator, H as HostOptions } from './validate-Bs1lyoOl.js';
+import { e as FormEvent, J as Json, F as FormDefinition, a as FieldBlock, B as Block } from './types-oAckGR_Z.cjs';
+import { F as FieldValidator, H as HostOptions, L as LinkParams } from './validate-B5WKHbst.cjs';
 
 /** Guards and helpers for event logs and other untrusted JSON. No dependencies. */
 
@@ -65,6 +65,13 @@ interface CreateFormOptions {
      * Pass the same lists to `validateSubmission` on the server.
      */
     hostOptions?: HostOptions | undefined;
+    /**
+     * The query parameters of the link the form was opened from (a `URLSearchParams` or a record).
+     * Choice questions with `props.prefill: { param }` take their parameter's value when it is one
+     * of their options (`prefillFromLink`); `initialValues` win over the link. A question with
+     * `props.prefill.hideWhenPrefilled` is then stepped over (`hiddenByPrefill`).
+     */
+    linkParams?: LinkParams | undefined;
 }
 interface FormEngine {
     /** The definition being filled in, with `hostOptions` filled in (`withHostOptions`). */
@@ -95,6 +102,6 @@ interface FormEngine {
 }
 declare function createForm(definition: FormDefinition, options?: CreateFormOptions): FormEngine;
 /** Rebuild a form's state from its event log. Timestamps are ignored. */
-declare function replay(definition: FormDefinition, events: FormEvent[], options?: Omit<CreateFormOptions, "clock" | "initialValues">): FormEngine;
+declare function replay(definition: FormDefinition, events: FormEvent[], options?: Omit<CreateFormOptions, "clock" | "initialValues" | "linkParams">): FormEngine;
 
 export { type CreateFormOptions as C, type FormEngine as F, type FormState as a, isJson as b, createForm as c, compactEvents as d, isFormEvent as i, replay as r };