@flamingo-stack/openframe-frontend-core 0.0.672 → 0.0.673-2406.7239.1

package/dist/hooks/index.js

@@ -5,6 +5,7 @@ import {
   batchFetchAuthenticatedImages,
   clearParams,
   coerceValue,
+  completeFormRescue,
   configureAuthenticatedImage,
   configureBatchImageFetch,
   extractVariablesFromQuery,
@@ -32,6 +33,7 @@ import {
   useDeferredError,
   useDragAndDropEnabled,
   useFocusTrap,
+  useFormRescue,
   useHorizontalScrollbar,
   useHumanitySignals,
   useKeyboardCollisionPadding,
@@ -44,6 +46,7 @@ import {
   usePlatformConfig,
   usePreventScroll,
   useQueryParams,
+  useRescuedForm,
   useScrollToHash,
   useSearch,
   useTablePagination,
@@ -54,8 +57,8 @@ import {
   validateSchema,
   validateVariables,
   variablesToUrlParams
-} from "../chunk-3PVOF3IB.js";
-import "../chunk-ZRIVCLPR.js";
+} from "../chunk-SGK4Q2W2.js";
+import "../chunk-JD5TKRCU.js";
 import {
   createSearchParams,
   shouldIncludeInUrl
@@ -104,6 +107,7 @@ export {
   clearAuthedImageCache,
   clearParams as clearVariablesParams,
   coerceValue,
+  completeFormRescue,
   configureAuthenticatedImage,
   configureBatchImageFetch,
   createSearchParams,
@@ -136,6 +140,7 @@ export {
   useDeferredError,
   useDragAndDropEnabled,
   useFocusTrap,
+  useFormRescue,
   useHeaderHeight,
   useHorizontalScrollbar,
   useHumanitySignals,
@@ -158,6 +163,7 @@ export {
   usePlatformConfig,
   usePreventScroll,
   useQueryParams,
+  useRescuedForm,
   useResetOnPageHidden,
   useScrollToHash,
   useSearch,

package/dist/hooks/use-form-rescue.d.ts

@@ -0,0 +1,43 @@
+import { type FormRescueDefinition } from '../utils/form-rescue';
+export interface UseFormRescueOptions {
+    /** Which form this is (`defineRescueForm`); `null` turns rescue off. */
+    form: FormRescueDefinition | null;
+    /** Every field the visitor can see. Hidden fields are never listed, so never sent. */
+    fieldNames: readonly string[];
+    /** Called once after mount with values from a resume link, else from this device's local draft. */
+    onRestore?: (values: Record<string, string>) => void;
+    /** The form's humanity signals, so the draft endpoint can run the same bot gate as the submit. */
+    getSignals?: () => Record<string, string | number>;
+}
+export interface FormRescueHandle {
+    /** Report the form's current values after a change (`lastField` = the field just edited). */
+    track: (values: Record<string, unknown>, lastField?: string | null) => void;
+    /** Keys to spread into the SUBMIT body so the host closes this attempt's draft. */
+    submitFields: () => Record<string, string>;
+    /** Call after a successful submit: clears the local draft and starts a fresh attempt. */
+    complete: () => void;
+}
+/**
+ * Close a rescue attempt after a successful submit, for a form that has already
+ * unmounted by then (the meeting scheduler's details-first flow): clears this
+ * device's draft and reports the submit. The hook's `complete` calls it too.
+ */
+export declare function completeFormRescue(form: FormRescueDefinition | null, attemptId?: unknown): void;
+/**
+ * useFormRescue — saves a public form's progress so a visitor who leaves
+ * before submitting can be followed up with, and restores it when they return.
+ *
+ * Every public lead form calls it the same way (next to `useHumanitySignals`):
+ *
+ *   const rescue = useFormRescue({ form: RESCUE_FORMS.waitlist, fieldNames, onRestore, getSignals })
+ *   // on change: rescue.track(values, changedField)
+ *   // submit:    body = { ...data, ...getSignals(), ...rescue.submitFields() }
+ *   // success:   rescue.complete()
+ *
+ * Saves go to the host's `EndpointsRuntime.formDraftsUrl` (debounced, plus one
+ * final keepalive save when the tab is hidden). A host that does not provide
+ * the url gets the local draft only. Nothing here can block or delay a submit:
+ * every network and storage call is fire-and-forget and swallows its errors.
+ */
+export declare function useFormRescue({ form, fieldNames, onRestore, getSignals }: UseFormRescueOptions): FormRescueHandle;
+//# sourceMappingURL=use-form-rescue.d.ts.map

package/dist/hooks/use-form-rescue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-form-rescue.d.ts","sourceRoot":"","sources":["../../src/hooks/use-form-rescue.ts"],"names":[],"mappings":"AAKA,OAAO,EAgBL,KAAK,oBAAoB,EAC1B,MAAM,sBAAsB,CAAC;AAa9B,MAAM,WAAW,oBAAoB;IACnC,wEAAwE;IACxE,IAAI,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAClC,sFAAsF;IACtF,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B,mGAAmG;IACnG,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;IACrD,kGAAkG;IAClG,UAAU,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,gBAAgB;IAC/B,6FAA6F;IAC7F,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IAC5E,mFAAmF;IACnF,YAAY,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,yFAAyF;IACzF,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB;AA0CD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,oBAAoB,GAAG,IAAI,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAQ/F;AAgBD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,oBAAoB,GAAG,gBAAgB,CA6LjH"}

package/dist/hooks/use-rescued-form.d.ts

@@ -0,0 +1,28 @@
+import type { FieldValues, Path, UseFormReturn } from 'react-hook-form';
+import type { FormRescueDefinition } from '../utils/form-rescue';
+import { type FormRescueHandle } from './use-form-rescue';
+export interface UseRescuedFormOptions<T extends FieldValues> {
+    /** The form's definition (`defineRescueForm` / `RESCUE_FORMS`); `null` turns rescue off. */
+    rescue: FormRescueDefinition | null;
+    /** The fields the visitor can see, by the name a draft stores them under. Hidden fields are never listed. */
+    fields: readonly string[];
+    /** The form's humanity signals, so draft saves pass the same bot gate as the submit. */
+    getSignals?: () => Record<string, string | number>;
+    /** Where a stored field lives in the form, when it is nested (`company` → `formFields.company`). Default: the same name. */
+    fieldPath?: (name: string) => Path<T>;
+}
+/**
+ * useRescuedForm — form rescue for ANY react-hook-form form, in one call.
+ *
+ * Wires what every rescued form needs so no form hand-rolls it: every edit is
+ * tracked (`watch`), a resume link or this device's draft fills the empty
+ * fields (`setValue`), and the handle's `submitFields()` / `complete()` close
+ * the attempt on submit. A form that is not react-hook-form uses
+ * `useFormRescue` directly.
+ *
+ *   const rescue = useRescuedForm(form, { rescue: RESCUE_FORMS.contact, fields, getSignals })
+ *   // submit:  body = { ...data, ...getSignals(), ...rescue.submitFields() }
+ *   // success: rescue.complete()
+ */
+export declare function useRescuedForm<T extends FieldValues>(form: Pick<UseFormReturn<T>, 'watch' | 'getValues' | 'setValue'>, { rescue, fields, getSignals, fieldPath }: UseRescuedFormOptions<T>): FormRescueHandle;
+//# sourceMappingURL=use-rescued-form.d.ts.map

package/dist/hooks/use-rescued-form.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-rescued-form.d.ts","sourceRoot":"","sources":["../../src/hooks/use-rescued-form.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,IAAI,EAAa,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACnF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAiB,KAAK,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAEzE,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,WAAW;IAC1D,4FAA4F;IAC5F,MAAM,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACpC,6GAA6G;IAC7G,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,wFAAwF;IACxF,UAAU,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IACnD,4HAA4H;IAC5H,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC;CACvC;AAYD;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,WAAW,EAClD,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,WAAW,GAAG,UAAU,CAAC,EAChE,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAClE,gBAAgB,CA0BlB"}