@redrockswebdevelopment/formstack-form-testing 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -3,7 +3,10 @@ export interface PlaywrightLikeLocator {
     locator(selector: string): PlaywrightLikeLocator;
     first(): PlaywrightLikeLocator;
     fill(value: string): Promise<void>;
-    click(): Promise<void>;
+    click(options?: {
+        readonly timeout?: number;
+        readonly force?: boolean;
+    }): Promise<void>;
     check(): Promise<void>;
     uncheck(): Promise<void>;
     selectOption(value: string | readonly string[]): Promise<void>;
@@ -27,6 +30,9 @@ export interface PlaywrightResponseLike {
     status(): number;
     request(): PlaywrightRequestLike;
 }
+export interface PlaywrightEvaluateLikePage {
+    evaluate<ReturnValue, Arg>(pageFunction: (arg: Arg) => ReturnValue | Promise<ReturnValue>, arg: Arg): Promise<ReturnValue>;
+}
 export interface PlaywrightLikePage {
     goto(url: string): Promise<unknown>;
     locator(selector: string): PlaywrightLikeLocator;
@@ -40,6 +46,327 @@ export interface PlaywrightLikePage {
     off?(event: "response", handler: (response: PlaywrightResponseLike) => void): void;
     waitForLoadState?(state?: "domcontentloaded" | "load" | "networkidle"): Promise<void>;
 }
+export type LiveFormProbeEventKind = "probe-installed" | "fs-api-ready" | "fs-api-timeout" | "dom-event" | "form-event" | "api-action" | "quiet-wait" | "field-snapshot" | "validation-result" | "validation-error" | "submit-invoked" | "submit-error";
+export interface LiveFormProbeEvent {
+    readonly kind: LiveFormProbeEventKind;
+    readonly at: number;
+    readonly elapsedMs: number;
+    readonly detail: Record<string, unknown>;
+}
+export interface LiveFormFieldProbeTarget {
+    readonly fieldId?: FormstackFieldRef;
+    readonly internalLabel?: string;
+    readonly label?: string;
+}
+export interface LiveFormFieldReadinessTarget extends LiveFormFieldProbeTarget {
+    readonly required?: boolean;
+    readonly requiredValuePaths?: readonly string[];
+}
+export interface LiveFormLifecycleProbeOptions {
+    readonly waitForApiTimeoutMs?: number;
+    readonly postRunSettleMs?: number;
+    readonly postRunQuietMs?: number;
+    readonly postRunQuietTimeoutMs?: number;
+    readonly eventTypes?: readonly string[];
+    readonly formEventTypes?: readonly string[];
+    readonly fieldTargets?: readonly LiveFormFieldProbeTarget[];
+    readonly includeAllFields?: boolean;
+    readonly validate?: boolean;
+    readonly submit?: boolean;
+}
+export interface LiveFormLifecycleProbeReport {
+    readonly apiAvailable: boolean;
+    readonly events: readonly LiveFormProbeEvent[];
+    readonly fieldSnapshots: readonly LiveFormProbeEvent[];
+    readonly validation?: LiveFormProbeEvent;
+    readonly submit?: LiveFormProbeEvent;
+}
+export interface RunWithLiveFormLifecycleProbeResult<T> {
+    readonly result: T;
+    readonly report: LiveFormLifecycleProbeReport;
+}
+export interface WaitForLiveFormEventOptions {
+    readonly eventTypes: readonly string[];
+    readonly target?: LiveFormFieldProbeTarget;
+    readonly dataType?: string;
+    readonly timeoutMs?: number;
+}
+export interface WaitForLiveFormEventReport {
+    readonly matched: boolean;
+    readonly timedOut: boolean;
+    readonly elapsedMs: number;
+    readonly targetFieldId?: string | number | null;
+    readonly event?: {
+        readonly type: string;
+        readonly formId: unknown;
+        readonly data: unknown;
+        readonly hasPreventDefault: boolean;
+    };
+}
+export interface LiveFormReadinessOptions {
+    readonly waitForApiTimeoutMs?: number;
+    readonly fieldTargets?: readonly LiveFormFieldReadinessTarget[];
+    readonly includeAllFields?: boolean;
+}
+export interface ReadLiveFormFieldValueOptions {
+    readonly target: LiveFormFieldProbeTarget;
+    readonly waitForApiTimeoutMs?: number;
+    readonly valuePath?: string;
+    readonly expectedValue?: unknown;
+}
+export interface LiveFormFieldValueReport {
+    readonly apiAvailable: boolean;
+    readonly fieldAvailable: boolean;
+    readonly id: string | number | null;
+    readonly value: unknown;
+    readonly selectedValue: unknown;
+    readonly valuePath?: string;
+    readonly expectedValue?: unknown;
+    readonly valueMatched?: boolean;
+    readonly isEmpty: boolean;
+}
+export interface WaitForLiveFormFieldValueOptions extends ReadLiveFormFieldValueOptions {
+    readonly timeoutMs?: number;
+    readonly intervalMs?: number;
+}
+export interface LiveFormReadinessField {
+    readonly target: LiveFormFieldReadinessTarget;
+    readonly available: boolean;
+    readonly id: string | number | null;
+    readonly value: unknown;
+    readonly required: boolean;
+    readonly apiHidden: boolean;
+    readonly hidden: boolean;
+    readonly domVisible: boolean | null;
+    readonly requiredValuePaths: readonly string[];
+    readonly missingValuePaths: readonly string[];
+    readonly isComplete: boolean;
+    readonly isBlocking: boolean;
+}
+export interface LiveFormReadinessReport {
+    readonly apiAvailable: boolean;
+    readonly fields: readonly LiveFormReadinessField[];
+    readonly blockingFieldCount: number;
+    readonly isReady: boolean;
+}
+export interface WaitForLiveFormReadinessOptions extends LiveFormReadinessOptions {
+    readonly timeoutMs?: number;
+    readonly intervalMs?: number;
+}
+export interface WaitForLiveFormQuietOptions {
+    readonly waitForApiTimeoutMs?: number;
+    readonly quietMs?: number;
+    readonly timeoutMs?: number;
+    readonly eventTypes?: readonly string[];
+    readonly formEventTypes?: readonly string[];
+    readonly includeEvents?: boolean;
+}
+export interface LiveFormQuietEvent {
+    readonly kind: "dom-event" | "form-event";
+    readonly type: string;
+    readonly elapsedMs: number;
+    readonly detail: Record<string, unknown>;
+}
+export interface WaitForLiveFormQuietReport {
+    readonly apiAvailable: boolean;
+    readonly quiet: boolean;
+    readonly timedOut: boolean;
+    readonly elapsedMs: number;
+    readonly quietForMs: number;
+    readonly eventCount: number;
+    readonly events?: readonly LiveFormQuietEvent[];
+}
+export interface LiveFormValidationGuardTarget extends LiveFormFieldProbeTarget {
+    readonly controlIds?: readonly string[];
+    readonly controlSelectors?: readonly string[];
+}
+export interface InstallLiveFormInitialValidationGuardOptions {
+    readonly waitForApiTimeoutMs?: number;
+    readonly restoreDelayMs?: number;
+    readonly restoreOnFirstFocusout?: boolean;
+    readonly targets: readonly LiveFormValidationGuardTarget[];
+}
+export interface InstallLiveFormInitialValidationGuardReport {
+    readonly apiAvailable: boolean;
+    readonly installed: boolean;
+    readonly guardedFieldCount: number;
+    readonly missingTargets: readonly LiveFormValidationGuardTarget[];
+}
+export interface SetLiveFormFieldValueOptions {
+    readonly target: LiveFormFieldProbeTarget;
+    readonly value: unknown;
+    readonly notify?: boolean;
+    readonly waitForValue?: boolean;
+    readonly timeoutMs?: number;
+    readonly intervalMs?: number;
+    readonly settleMs?: number;
+}
+export interface DispatchLiveFormFieldDomEventsOptions {
+    readonly target: LiveFormFieldProbeTarget;
+    readonly eventTypes?: readonly string[];
+    readonly onlyCheckedChoices?: boolean;
+}
+export interface DispatchLiveFormFieldDomEventsReport {
+    readonly matchedControlCount: number;
+    readonly dispatchedEventCount: number;
+    readonly controls: readonly LiveFormDomControlSnapshot[];
+}
+export interface SetLiveFormFieldValueReport {
+    readonly apiAvailable: boolean;
+    readonly fieldAvailable: boolean;
+    readonly id: string | number | null;
+    readonly previousValue: unknown;
+    readonly expectedValue: unknown;
+    readonly finalValue: unknown;
+    readonly valueMatched: boolean;
+    readonly notified: boolean;
+    readonly notifyResult?: unknown;
+}
+export interface SetLiveFormFieldValueTransactionOptions {
+    readonly write: SetLiveFormFieldValueOptions;
+    readonly waitForEvent?: boolean | WaitForLiveFormEventOptions;
+    readonly dispatchDomEvents?: boolean | Omit<DispatchLiveFormFieldDomEventsOptions, "target">;
+    readonly readiness?: WaitForLiveFormReadinessOptions;
+    readonly snapshot?: boolean | SnapshotLiveFormDomFieldsOptions;
+}
+export interface SetLiveFormFieldValueTransactionReport {
+    readonly write: SetLiveFormFieldValueReport;
+    readonly event?: WaitForLiveFormEventReport;
+    readonly domDispatch?: DispatchLiveFormFieldDomEventsReport;
+    readonly readiness?: LiveFormReadinessReport;
+    readonly domFields?: readonly LiveFormDomFieldSnapshot[];
+}
+export interface SetLiveFormFieldValuesTransactionOptions {
+    readonly writes: readonly SetLiveFormFieldValueOptions[];
+    readonly waitForEvents?: boolean;
+    readonly dispatchDomEvents?: boolean | Omit<DispatchLiveFormFieldDomEventsOptions, "target">;
+    readonly readiness?: WaitForLiveFormReadinessOptions;
+    readonly snapshot?: boolean | SnapshotLiveFormDomFieldsOptions;
+}
+export interface SetLiveFormFieldValuesTransactionReport {
+    readonly writes: readonly SetLiveFormFieldValueReport[];
+    readonly events: readonly WaitForLiveFormEventReport[];
+    readonly domDispatches: readonly DispatchLiveFormFieldDomEventsReport[];
+    readonly readiness?: LiveFormReadinessReport;
+    readonly domFields?: readonly LiveFormDomFieldSnapshot[];
+}
+export interface LiveFormDomControlSnapshot {
+    readonly tagName: string;
+    readonly type: string | null;
+    readonly id: string | null;
+    readonly name: string | null;
+    readonly value: string | null;
+    readonly currentValue: string | null;
+    readonly checked: boolean | null;
+}
+export interface LiveFormDomFieldSnapshot {
+    readonly internalLabel: string | null;
+    readonly id: string;
+    readonly text: string;
+    readonly controls: readonly LiveFormDomControlSnapshot[];
+}
+export interface SnapshotLiveFormDomFieldsOptions {
+    readonly selector?: string;
+    readonly textMaxLength?: number;
+}
+export interface ReadLiveFormDomFieldStateOptions extends LiveFormFieldProbeTarget {
+    readonly selector?: string;
+    readonly controlSelector?: string;
+    readonly expectedValue?: string;
+    readonly expectedChecked?: boolean;
+}
+export interface LiveFormDomFieldStateReport {
+    readonly matched: boolean;
+    readonly fieldMatched: boolean;
+    readonly controlMatched: boolean;
+    readonly field: LiveFormDomFieldSnapshot | null;
+    readonly controls: readonly LiveFormDomControlSnapshot[];
+    readonly expectedValue?: string;
+    readonly expectedChecked?: boolean;
+}
+export interface WaitForLiveFormDomFieldStateOptions extends ReadLiveFormDomFieldStateOptions {
+    readonly timeoutMs?: number;
+    readonly intervalMs?: number;
+}
+export interface WindowMessageRecord {
+    readonly origin: string;
+    readonly data: unknown;
+}
+export interface InstallWindowMessageRecorderOptions {
+    readonly propertyName?: string;
+    readonly allowedOrigins?: readonly string[];
+}
+export interface InstallWindowMessageRecorderReport {
+    readonly installed: boolean;
+    readonly propertyName: string;
+}
+export interface PostMessageToIframeOptions {
+    readonly iframeSelector: string;
+    readonly message: unknown;
+    readonly targetOrigin: string;
+}
+export interface FormstackIframeBridgeMessage<Payload = unknown> {
+    readonly channel: string;
+    readonly requestId: string;
+    readonly type: string;
+    readonly payload?: Payload;
+}
+export interface WaitForWindowMessageOptions {
+    readonly propertyName?: string;
+    readonly channel?: string;
+    readonly requestId?: string;
+    readonly type?: string;
+    readonly timeoutMs?: number;
+}
+export interface WaitForWindowMessageReport {
+    readonly matched: boolean;
+    readonly timedOut: boolean;
+    readonly elapsedMs: number;
+    readonly record?: WindowMessageRecord;
+}
+export interface SendFormstackIframeBridgeMessageOptions<Payload = unknown> {
+    readonly iframeSelector: string;
+    readonly targetOrigin: string;
+    readonly channel: string;
+    readonly requestId: string;
+    readonly type: string;
+    readonly payload?: Payload;
+    readonly responseType?: string;
+    readonly propertyName?: string;
+    readonly allowedOrigins?: readonly string[];
+    readonly timeoutMs?: number;
+}
+export interface SendFormstackIframeBridgeMessageReport {
+    readonly posted: boolean;
+    readonly response: WaitForWindowMessageReport;
+}
+export interface WaitForConsoleMessageOptions {
+    readonly type?: PlaywrightConsoleType;
+    readonly text?: string | RegExp;
+    readonly timeoutMs?: number;
+}
+export interface WaitForConsoleMessageReport {
+    readonly matched: boolean;
+    readonly timedOut: boolean;
+    readonly elapsedMs: number;
+    readonly message?: {
+        readonly type: PlaywrightConsoleType;
+        readonly text: string;
+    };
+}
+export interface WaitForWindowFlagOptions {
+    readonly path: string;
+    readonly expectedValue?: unknown;
+    readonly timeoutMs?: number;
+    readonly intervalMs?: number;
+}
+export interface WaitForWindowFlagReport {
+    readonly matched: boolean;
+    readonly timedOut: boolean;
+    readonly elapsedMs: number;
+    readonly path: string;
+    readonly value: unknown;
+}
 export interface ConsoleDiagnostic {
     readonly kind: "console";
     readonly level: PlaywrightConsoleType;
@@ -105,10 +432,39 @@ export interface DateTimeFieldValue {
     readonly seconds?: string;
     readonly ampm?: string;
 }
+export interface LiveFormDateTimeValue {
+    readonly M?: string;
+    readonly D?: string;
+    readonly Y?: string;
+    readonly H?: string;
+    readonly I?: string;
+    readonly S?: string;
+    readonly A?: string;
+}
 export interface ProductFieldValue {
     readonly fixedAmount?: string;
     readonly quantity?: string;
 }
+export interface LiveFormProductValue {
+    readonly fixedAmount?: string;
+    readonly quantity?: string;
+    readonly value?: string;
+}
+export interface ChoiceFieldValue {
+    readonly value: string;
+    readonly otherValue?: string;
+}
+export type CheckboxFieldValue = Record<string, string | null>;
+export interface MatrixFieldSelection {
+    readonly row: string | number;
+    readonly column: string | number;
+}
+export interface LiveFormMatrixValue {
+    readonly value: readonly string[];
+}
+export interface LiveFormRatingValue {
+    readonly value: string;
+}
 export interface FormTestHarness {
     readonly page: PlaywrightLikePage;
     readonly options: FormTestHarnessOptions;
@@ -147,6 +503,12 @@ export interface FormScenarioStepObject {
     readonly run: FormScenarioStepRun;
 }
 export type FormScenarioStep = FormScenarioStepRun | FormScenarioStepObject;
+export interface LiveFormApiRecipeOptions {
+    readonly notify?: boolean;
+    readonly dispatchDomEvents?: boolean | Omit<DispatchLiveFormFieldDomEventsOptions, "target">;
+    readonly waitForEvent?: boolean | WaitForLiveFormEventOptions;
+    readonly waitForQuiet?: boolean | WaitForLiveFormQuietOptions;
+}
 export interface FormTestScenario {
     readonly name: string;
     readonly url?: string;
@@ -157,21 +519,211 @@ export interface RunFormScenarioOptions extends FormTestHarnessOptions {
     readonly diagnostics?: FormBrowserDiagnosticsOptions;
     readonly throwOnDiagnostics?: boolean;
     readonly waitForLoadState?: "domcontentloaded" | "load" | "networkidle";
+    readonly artifacts?: readonly FormScenarioArtifact[];
 }
 export interface FormScenarioStepResult {
     readonly name: string;
+    readonly status?: "passed" | "failed";
+    readonly startedAt?: string;
+    readonly endedAt?: string;
+    readonly durationMs?: number;
+    readonly error?: {
+        readonly name: string;
+        readonly message: string;
+        readonly stack?: string;
+    };
+}
+export interface FormScenarioArtifact {
+    readonly kind: "json" | "har" | "screenshot" | "video" | "trace" | "other";
+    readonly path: string;
+    readonly label?: string;
 }
 export interface FormScenarioResult {
     readonly name: string;
+    readonly status?: "passed" | "failed";
+    readonly startedAt?: string;
+    readonly endedAt?: string;
+    readonly durationMs?: number;
     readonly steps: readonly FormScenarioStepResult[];
     readonly diagnostics: FormBrowserDiagnosticsReport;
+    readonly artifacts?: readonly FormScenarioArtifact[];
+}
+export declare class FormScenarioRunError extends Error {
+    readonly result: FormScenarioResult;
+    constructor(result: FormScenarioResult);
+}
+export interface ReadLiveFormValidationStateOptions {
+    readonly validate?: boolean;
+    readonly includeEmptyErrors?: boolean;
+    readonly includeHiddenErrors?: boolean;
+}
+export interface LiveFormValidationStateReport {
+    readonly apiAvailable: boolean;
+    readonly validated: boolean;
+    readonly result: unknown;
+    readonly inlineErrors: readonly {
+        readonly id: string | null;
+        readonly text: string;
+    }[];
+}
+export interface WaitForLiveFormValidationStateOptions extends ReadLiveFormValidationStateOptions {
+    readonly expectedErrorCount?: number;
+    readonly errorText?: string | RegExp;
+    readonly expectNoErrors?: boolean;
+    readonly timeoutMs?: number;
+    readonly intervalMs?: number;
+}
+export interface WaitForLiveFormVisibilityTarget extends LiveFormFieldProbeTarget {
+    readonly selector?: string;
+    readonly visible: boolean;
+}
+export interface WaitForLiveFormVisibilityOptions {
+    readonly targets: readonly WaitForLiveFormVisibilityTarget[];
+    readonly timeoutMs?: number;
+    readonly intervalMs?: number;
+}
+export interface LiveFormVisibilityField {
+    readonly target: WaitForLiveFormVisibilityTarget;
+    readonly id: string | number | null;
+    readonly visible: boolean | null;
+    readonly matched: boolean;
+}
+export interface WaitForLiveFormVisibilityReport {
+    readonly matched: boolean;
+    readonly timedOut: boolean;
+    readonly fields: readonly LiveFormVisibilityField[];
+}
+export interface LiveFormStateDriftIssue {
+    readonly internalLabel: string | null;
+    readonly fieldId: string | number | null;
+    readonly kind: "visibility" | "missing-dom" | "missing-api";
+    readonly message: string;
+}
+export interface LiveFormStateDriftReport {
+    readonly readiness: LiveFormReadinessReport;
+    readonly domFields: readonly LiveFormDomFieldSnapshot[];
+    readonly issues: readonly LiveFormStateDriftIssue[];
+    readonly hasDrift: boolean;
+}
+export interface DiscoverLiveFormFieldShapesOptions {
+    readonly selector?: string;
+    readonly includeValues?: boolean;
+}
+export interface LiveFormFieldShape {
+    readonly internalLabel: string | null;
+    readonly fieldId: string | number | null;
+    readonly domId: string;
+    readonly labelText: string;
+    readonly apiAvailable: boolean;
+    readonly apiValue?: unknown;
+    readonly apiHidden?: boolean;
+    readonly domVisible: boolean;
+    readonly controlCount: number;
+    readonly controlTypes: readonly string[];
+    readonly inferredKind: "address" | "checkbox" | "date" | "embed" | "email" | "file" | "matrix" | "name" | "number" | "phone" | "product" | "radio" | "rating" | "section" | "select" | "signature" | "textarea" | "text" | "unknown";
+    readonly controls: readonly LiveFormDomControlSnapshot[];
+}
+export interface DiscoverLiveFormFieldShapesReport {
+    readonly apiAvailable: boolean;
+    readonly fields: readonly LiveFormFieldShape[];
+}
+export interface SubmitWithLiveFormLifecycleProbeOptions extends LiveFormLifecycleProbeOptions {
+    readonly submitSelector?: string;
+    readonly throwOnClickFailure?: boolean;
+    readonly clickTimeoutMs?: number;
+}
+export interface SubmitWithLiveFormLifecycleProbeActionReport {
+    readonly clicked: boolean;
+    readonly error?: string;
 }
 export declare function createFormBrowserMonitor(page: PlaywrightLikePage, options?: FormBrowserDiagnosticsOptions): {
     readonly report: () => FormBrowserDiagnosticsReport;
     readonly assertNoErrors: () => void;
     readonly detach: () => void;
 };
+export declare function readValuePath(value: unknown, path: string): unknown;
+export declare function isLiveFormFieldValueEmpty(value: unknown): boolean;
+export declare function buildLiveFormNameValue(value: NameFieldValue, current?: unknown): NameFieldValue;
+export declare function buildLiveFormAddressValue(value: AddressFieldValue, current?: unknown): AddressFieldValue;
+export declare function buildLiveFormChoiceValue(value: string, otherValue?: string): ChoiceFieldValue;
+export declare function buildLiveFormSelectValue(value: string): Pick<ChoiceFieldValue, "value">;
+export declare function buildLiveFormCheckboxValue(values: readonly string[], otherValue?: string | null): CheckboxFieldValue;
+export declare function buildLiveFormDateTimeValue(value: DateTimeFieldValue, current?: unknown): LiveFormDateTimeValue;
+export declare function buildLiveFormProductValue(value: ProductFieldValue, current?: unknown): LiveFormProductValue;
+export declare function buildLiveFormRatingValue(value: string | number): LiveFormRatingValue;
+export declare function buildLiveFormMatrixValue(selections: readonly (string | MatrixFieldSelection)[]): LiveFormMatrixValue;
+export declare function readLiveFormFieldValue(page: PlaywrightLikePage, options: ReadLiveFormFieldValueOptions): Promise<LiveFormFieldValueReport>;
+export declare function waitForLiveFormFieldValue(page: PlaywrightLikePage, options: WaitForLiveFormFieldValueOptions): Promise<LiveFormFieldValueReport>;
+export declare function readLiveFormReadiness(page: PlaywrightLikePage, options?: LiveFormReadinessOptions): Promise<LiveFormReadinessReport>;
+export declare function waitForLiveFormReadiness(page: PlaywrightLikePage, options?: WaitForLiveFormReadinessOptions): Promise<LiveFormReadinessReport>;
+export declare function waitForLiveFormQuiet(page: PlaywrightLikePage, options?: WaitForLiveFormQuietOptions): Promise<WaitForLiveFormQuietReport>;
+export declare function installLiveFormInitialValidationGuard(page: PlaywrightLikePage, options: InstallLiveFormInitialValidationGuardOptions): Promise<InstallLiveFormInitialValidationGuardReport>;
+export declare function setLiveFormFieldValue(page: PlaywrightLikePage, options: SetLiveFormFieldValueOptions): Promise<SetLiveFormFieldValueReport>;
+export declare function snapshotLiveFormDomFields(page: PlaywrightLikePage, options?: SnapshotLiveFormDomFieldsOptions): Promise<readonly LiveFormDomFieldSnapshot[]>;
+export declare function readLiveFormDomFieldState(page: PlaywrightLikePage, options: ReadLiveFormDomFieldStateOptions): Promise<LiveFormDomFieldStateReport>;
+export declare function waitForLiveFormDomFieldState(page: PlaywrightLikePage, options: WaitForLiveFormDomFieldStateOptions): Promise<LiveFormDomFieldStateReport>;
+export declare function dispatchLiveFormFieldDomEvents(page: PlaywrightLikePage, options: DispatchLiveFormFieldDomEventsOptions): Promise<DispatchLiveFormFieldDomEventsReport>;
+export declare function installWindowMessageRecorder(page: PlaywrightLikePage, options?: InstallWindowMessageRecorderOptions): Promise<InstallWindowMessageRecorderReport>;
+export declare function readWindowMessageRecords(page: PlaywrightLikePage, propertyName?: string): Promise<readonly WindowMessageRecord[]>;
+export declare function clearWindowMessageRecords(page: PlaywrightLikePage, propertyName?: string): Promise<void>;
+export declare function postMessageToIframe(page: PlaywrightLikePage, options: PostMessageToIframeOptions): Promise<boolean>;
+export declare function buildFormstackIframeBridgeMessage<Payload = unknown>(message: FormstackIframeBridgeMessage<Payload>): FormstackIframeBridgeMessage<Payload>;
+export declare function waitForWindowMessage(page: PlaywrightLikePage, options?: WaitForWindowMessageOptions): Promise<WaitForWindowMessageReport>;
+export declare function sendFormstackIframeBridgeMessage<Payload = unknown>(page: PlaywrightLikePage, options: SendFormstackIframeBridgeMessageOptions<Payload>): Promise<SendFormstackIframeBridgeMessageReport>;
+export declare function waitForConsoleMessage(page: PlaywrightLikePage, options?: WaitForConsoleMessageOptions): Promise<WaitForConsoleMessageReport>;
+export declare function waitForWindowFlag(page: PlaywrightLikePage, options: WaitForWindowFlagOptions): Promise<WaitForWindowFlagReport>;
+export declare function readLiveFormValidationState(page: PlaywrightLikePage, options?: ReadLiveFormValidationStateOptions): Promise<LiveFormValidationStateReport>;
+export declare function waitForLiveFormValidationState(page: PlaywrightLikePage, options?: WaitForLiveFormValidationStateOptions): Promise<LiveFormValidationStateReport>;
+export declare function waitForLiveFormVisibility(page: PlaywrightLikePage, options: WaitForLiveFormVisibilityOptions): Promise<WaitForLiveFormVisibilityReport>;
+export declare function readLiveFormStateDrift(page: PlaywrightLikePage, options?: LiveFormReadinessOptions & {
+    readonly snapshot?: SnapshotLiveFormDomFieldsOptions;
+}): Promise<LiveFormStateDriftReport>;
+export declare function discoverLiveFormFieldShapes(page: PlaywrightLikePage, options?: DiscoverLiveFormFieldShapesOptions): Promise<DiscoverLiveFormFieldShapesReport>;
+export declare function submitWithLiveFormLifecycleProbe(page: PlaywrightLikePage, options?: SubmitWithLiveFormLifecycleProbeOptions): Promise<RunWithLiveFormLifecycleProbeResult<SubmitWithLiveFormLifecycleProbeActionReport>>;
+export declare function probeLiveFormLifecycle(page: PlaywrightLikePage, options?: LiveFormLifecycleProbeOptions): Promise<LiveFormLifecycleProbeReport>;
+export declare function runWithLiveFormLifecycleProbe<T>(page: PlaywrightLikePage, options: LiveFormLifecycleProbeOptions, run: () => Promise<T> | T): Promise<RunWithLiveFormLifecycleProbeResult<T>>;
+export declare function waitForLiveFormEvent(page: PlaywrightLikePage, options: WaitForLiveFormEventOptions): Promise<WaitForLiveFormEventReport>;
+export declare function setLiveFormFieldValueTransaction(page: PlaywrightLikePage, options: SetLiveFormFieldValueTransactionOptions): Promise<SetLiveFormFieldValueTransactionReport>;
+export declare function setLiveFormFieldValuesTransaction(page: PlaywrightLikePage, options: SetLiveFormFieldValuesTransactionOptions): Promise<SetLiveFormFieldValuesTransactionReport>;
 export declare function createFormTestHarness(page: PlaywrightLikePage, options?: FormTestHarnessOptions): FormTestHarness;
 export declare function runFormScenario(page: PlaywrightLikePage, scenario: FormTestScenario, options?: RunFormScenarioOptions): Promise<FormScenarioResult>;
 export declare function defineFormScenario<const Scenario extends FormTestScenario>(scenario: Scenario): Scenario;
+export declare const liveFormScenarioSteps: {
+    writeField: (name: string, options: SetLiveFormFieldValueTransactionOptions) => FormScenarioStepObject;
+    writeFields: (name: string, options: SetLiveFormFieldValuesTransactionOptions) => FormScenarioStepObject;
+    expectReady: (name: string, options: WaitForLiveFormReadinessOptions) => FormScenarioStepObject;
+    waitForQuiet: (name: string, options?: WaitForLiveFormQuietOptions) => FormScenarioStepObject;
+    expectFieldValue: (name: string, options: WaitForLiveFormFieldValueOptions) => FormScenarioStepObject;
+    expectDomFieldState: (name: string, options: WaitForLiveFormDomFieldStateOptions) => FormScenarioStepObject;
+    expectValidationErrors: (name: string, options?: WaitForLiveFormValidationStateOptions) => FormScenarioStepObject;
+    expectNoValidationErrors: (name: string, options?: Omit<WaitForLiveFormValidationStateOptions, "expectNoErrors">) => FormScenarioStepObject;
+    expectConsoleMessage: (name: string, options?: WaitForConsoleMessageOptions) => FormScenarioStepObject;
+    expectWindowFlag: (name: string, options: WaitForWindowFlagOptions) => FormScenarioStepObject;
+    expectVisibility: (name: string, options: WaitForLiveFormVisibilityOptions) => FormScenarioStepObject;
+    expectNoStateDrift: (name: string, options: LiveFormReadinessOptions & {
+        readonly snapshot?: SnapshotLiveFormDomFieldsOptions;
+    }) => FormScenarioStepObject;
+    submitAndProbe: (name: string, options?: SubmitWithLiveFormLifecycleProbeOptions) => FormScenarioStepObject;
+};
+export declare const liveFormFieldRecipes: {
+    fillTextDom: (name: string, internalLabel: string, value: string) => FormScenarioStepObject;
+    fillNameDom: (name: string, internalLabel: string, value: NameFieldValue) => FormScenarioStepObject;
+    fillAddressDom: (name: string, internalLabel: string, value: AddressFieldValue) => FormScenarioStepObject;
+    chooseRadioDom: (name: string, internalLabel: string, value: string | number) => FormScenarioStepObject;
+    setCheckboxDom: (name: string, internalLabel: string, value: string | number, checked: boolean) => FormScenarioStepObject;
+    selectMatrixCellDom: (name: string, fieldId: FormstackFieldRef, row: number, column: number) => FormScenarioStepObject;
+    setRatingDom: (name: string, fieldId: FormstackFieldRef, zeroBasedIndex: number) => FormScenarioStepObject;
+    uploadFileDom: (name: string, internalLabel: string, files: string | readonly string[]) => FormScenarioStepObject;
+    setNameApi: (name: string, internalLabel: string, value: NameFieldValue, options?: LiveFormApiRecipeOptions) => FormScenarioStepObject;
+    setAddressApi: (name: string, internalLabel: string, value: AddressFieldValue, options?: LiveFormApiRecipeOptions) => FormScenarioStepObject;
+    setChoiceApi: (name: string, internalLabel: string, value: string, options?: LiveFormApiRecipeOptions) => FormScenarioStepObject;
+    setSelectApi: (name: string, internalLabel: string, value: string, options?: LiveFormApiRecipeOptions) => FormScenarioStepObject;
+    setCheckboxesApi: (name: string, internalLabel: string, values: readonly string[], options?: LiveFormApiRecipeOptions) => FormScenarioStepObject;
+    setDateTimeApi: (name: string, internalLabel: string, value: DateTimeFieldValue, options?: LiveFormApiRecipeOptions) => FormScenarioStepObject;
+    setMatrixApi: (name: string, internalLabel: string, selections: readonly (string | MatrixFieldSelection)[], options?: LiveFormApiRecipeOptions) => FormScenarioStepObject;
+    setRatingApi: (name: string, internalLabel: string, value: string | number, options?: LiveFormApiRecipeOptions) => FormScenarioStepObject;
+    setProductApi: (name: string, internalLabel: string, value: ProductFieldValue, options?: LiveFormApiRecipeOptions) => FormScenarioStepObject;
+    setNameApiAndDispatch: (name: string, internalLabel: string, value: NameFieldValue, options?: Omit<LiveFormApiRecipeOptions, "dispatchDomEvents">) => FormScenarioStepObject;
+    setChoiceApiAndDispatch: (name: string, internalLabel: string, value: string, options?: Omit<LiveFormApiRecipeOptions, "dispatchDomEvents">) => FormScenarioStepObject;
+};
 //# sourceMappingURL=index.d.ts.map