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

package/dist/hooks/index.js

@@ -32,6 +32,7 @@ import {
   useDeferredError,
   useDragAndDropEnabled,
   useFocusTrap,
+  useFormRescue,
   useHorizontalScrollbar,
   useHumanitySignals,
   useKeyboardCollisionPadding,
@@ -54,8 +55,8 @@ import {
   validateSchema,
   validateVariables,
   variablesToUrlParams
-} from "../chunk-3PVOF3IB.js";
-import "../chunk-ZRIVCLPR.js";
+} from "../chunk-UTHZ7DLN.js";
+import "../chunk-JD5TKRCU.js";
 import {
   createSearchParams,
   shouldIncludeInUrl
@@ -136,6 +137,7 @@ export {
   useDeferredError,
   useDragAndDropEnabled,
   useFocusTrap,
+  useFormRescue,
   useHeaderHeight,
   useHorizontalScrollbar,
   useHumanitySignals,

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

@@ -0,0 +1,37 @@
+import { type FormRescueFormId } from '../utils/form-rescue';
+export interface UseFormRescueOptions {
+    /** Which form this is; `null` turns rescue off (e.g. a signed-in ticket form). */
+    formId: FormRescueFormId | 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;
+}
+/**
+ * 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({ formId: 'contact', 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({ formId, 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,gBAAgB,EACtB,MAAM,sBAAsB,CAAC;AAa9B,MAAM,WAAW,oBAAoB;IACnC,kFAAkF;IAClF,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAChC,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;AAwDD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,oBAAoB,GAAG,gBAAgB,CA6LnH"}