@rpcbase/form 0.54.0 → 0.56.0

package/dist/index.d.ts

@@ -1,3 +1,6 @@
 export * from 'react-hook-form';
+export { useForm, type UseFormPropsWithNavigationGuard } from './useForm';
+export { DEFAULT_FORM_NAVIGATION_GUARD_MESSAGE, useFormNavigationGuard, } from './useFormNavigationGuard';
+export { normalizeFormNavigationGuardOptions, shouldBlockFormNavigation, type FormNavigationGuardOptions, type NormalizedFormNavigationGuardOptions, } from './navigationGuard';
 export * from './zodResolver';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,OAAO,EAAE,OAAO,EAAE,KAAK,+BAA+B,EAAE,MAAM,WAAW,CAAA;AACzE,OAAO,EACL,qCAAqC,EACrC,sBAAsB,GACvB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,mCAAmC,EACnC,yBAAyB,EACzB,KAAK,0BAA0B,EAC/B,KAAK,oCAAoC,GAC1C,MAAM,mBAAmB,CAAA;AAC1B,cAAc,eAAe,CAAA"}

package/dist/index.js

@@ -1,6 +1,63 @@
-import { get, set, appendErrors } from "react-hook-form";
+import { useFormState, useForm as useForm$1, get, set, appendErrors } from "react-hook-form";
 export * from "react-hook-form";
+import { useId, useMemo, useCallback } from "react";
+import { useRegisterNavigationGuard } from "@rpcbase/router";
 import * as n$1 from "zod/v4/core";
+const normalizeFormNavigationGuardOptions = (input) => {
+  if (input === false) {
+    return { enabled: false, blockOnSearch: false };
+  }
+  return {
+    enabled: input?.enabled ?? true,
+    message: input?.message,
+    blockOnSearch: input?.blockOnSearch ?? false,
+    priority: input?.priority
+  };
+};
+const shouldBlockFormNavigation = ({
+  args,
+  shouldBlockUnload,
+  blockOnSearch
+}) => {
+  if (!shouldBlockUnload) return false;
+  if (args.currentLocation.pathname !== args.nextLocation.pathname) return true;
+  if (blockOnSearch && args.currentLocation.search !== args.nextLocation.search) return true;
+  return false;
+};
+const DEFAULT_FORM_NAVIGATION_GUARD_MESSAGE = "You have unsaved changes. Leave without saving?";
+const useFormNavigationGuard = (form, opts) => {
+  const { isDirty, isSubmitting } = useFormState({ control: form.control });
+  const normalized = normalizeFormNavigationGuardOptions(opts);
+  const reactId = useId();
+  const id = useMemo(() => `rpcbase:form:${reactId}`, [reactId]);
+  const shouldBlockUnload = normalized.enabled && isDirty && !isSubmitting;
+  const shouldBlockNavigation = useCallback(
+    (args) => shouldBlockFormNavigation({
+      args,
+      shouldBlockUnload,
+      blockOnSearch: normalized.blockOnSearch
+    }),
+    [normalized.blockOnSearch, shouldBlockUnload]
+  );
+  useRegisterNavigationGuard({
+    id,
+    enabled: normalized.enabled,
+    priority: normalized.priority,
+    message: normalized.message ?? DEFAULT_FORM_NAVIGATION_GUARD_MESSAGE,
+    blockOnSearch: normalized.blockOnSearch,
+    shouldBlockNavigation,
+    shouldBlockUnload
+  });
+};
+const useForm = (props) => {
+  const { navigationGuard, ...rhfProps } = props ?? {};
+  const form = useForm$1(
+    rhfProps
+  );
+  const normalized = normalizeFormNavigationGuardOptions(navigationGuard);
+  useFormNavigationGuard(form, normalized.enabled ? navigationGuard : { enabled: false });
+  return form;
+};
 const r = (t2, r2, o2) => {
   if (t2 && "reportValidity" in t2) {
     const s2 = get(o2, r2);
@@ -115,5 +172,10 @@ function a(o$1, a2, u) {
   throw new Error("Invalid input: not a Zod schema");
 }
 export {
+  DEFAULT_FORM_NAVIGATION_GUARD_MESSAGE,
+  normalizeFormNavigationGuardOptions,
+  shouldBlockFormNavigation,
+  useForm,
+  useFormNavigationGuard,
   a as zodResolver
 };

package/dist/navigationGuard.d.ts

@@ -0,0 +1,20 @@
+import { BlockerFunction } from '../../router/src';
+export type FormNavigationGuardOptions = false | {
+    enabled?: boolean;
+    message?: string;
+    blockOnSearch?: boolean;
+    priority?: number;
+};
+export type NormalizedFormNavigationGuardOptions = {
+    enabled: boolean;
+    message?: string;
+    blockOnSearch: boolean;
+    priority?: number;
+};
+export declare const normalizeFormNavigationGuardOptions: (input: FormNavigationGuardOptions | undefined) => NormalizedFormNavigationGuardOptions;
+export declare const shouldBlockFormNavigation: ({ args, shouldBlockUnload, blockOnSearch, }: {
+    args: Parameters<BlockerFunction>[0];
+    shouldBlockUnload: boolean;
+    blockOnSearch: boolean;
+}) => boolean;
+//# sourceMappingURL=navigationGuard.d.ts.map

package/dist/navigationGuard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigationGuard.d.ts","sourceRoot":"","sources":["../src/navigationGuard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAGtD,MAAM,MAAM,0BAA0B,GAClC,KAAK,GACL;IACA,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAEH,MAAM,MAAM,oCAAoC,GAAG;IACjD,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,OAAO,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,eAAO,MAAM,mCAAmC,GAC9C,OAAO,0BAA0B,GAAG,SAAS,KAC5C,oCAWF,CAAA;AAED,eAAO,MAAM,yBAAyB,GAAI,6CAIvC;IACD,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;IACpC,iBAAiB,EAAE,OAAO,CAAA;IAC1B,aAAa,EAAE,OAAO,CAAA;CACvB,KAAG,OAKH,CAAA"}

package/dist/useForm.d.ts

@@ -0,0 +1,7 @@
+import { FieldValues, UseFormProps, UseFormReturn } from 'react-hook-form';
+import { FormNavigationGuardOptions } from './navigationGuard';
+export type UseFormPropsWithNavigationGuard<TFieldValues extends FieldValues = FieldValues, TContext = any, TTransformedValues = TFieldValues> = UseFormProps<TFieldValues, TContext, TTransformedValues> & {
+    navigationGuard?: FormNavigationGuardOptions;
+};
+export declare const useForm: <TFieldValues extends FieldValues = FieldValues, TContext = any, TTransformedValues = TFieldValues>(props?: UseFormPropsWithNavigationGuard<TFieldValues, TContext, TTransformedValues>) => UseFormReturn<TFieldValues, TContext, TTransformedValues>;
+//# sourceMappingURL=useForm.d.ts.map

package/dist/useForm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useForm.d.ts","sourceRoot":"","sources":["../src/useForm.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAG/E,OAAO,EAEL,KAAK,0BAA0B,EAChC,MAAM,mBAAmB,CAAA;AAG1B,MAAM,MAAM,+BAA+B,CACzC,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,QAAQ,GAAG,GAAG,EACd,kBAAkB,GAAG,YAAY,IAC/B,YAAY,CAAC,YAAY,EAAE,QAAQ,EAAE,kBAAkB,CAAC,GAAG;IAC7D,eAAe,CAAC,EAAE,0BAA0B,CAAA;CAC7C,CAAA;AAED,eAAO,MAAM,OAAO,GAClB,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,QAAQ,GAAG,GAAG,EACd,kBAAkB,GAAG,YAAY,EAEjC,QAAQ,+BAA+B,CAAC,YAAY,EAAE,QAAQ,EAAE,kBAAkB,CAAC,KAClF,aAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,kBAAkB,CAW1D,CAAA"}

package/dist/useFormNavigationGuard.d.ts

@@ -0,0 +1,5 @@
+import { FieldValues, UseFormReturn } from 'react-hook-form';
+import { FormNavigationGuardOptions } from './navigationGuard';
+export declare const DEFAULT_FORM_NAVIGATION_GUARD_MESSAGE = "You have unsaved changes. Leave without saving?";
+export declare const useFormNavigationGuard: <TFieldValues extends FieldValues, TContext = any, TTransformedValues = TFieldValues>(form: UseFormReturn<TFieldValues, TContext, TTransformedValues>, opts?: FormNavigationGuardOptions) => void;
+//# sourceMappingURL=useFormNavigationGuard.d.ts.map

package/dist/useFormNavigationGuard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFormNavigationGuard.d.ts","sourceRoot":"","sources":["../src/useFormNavigationGuard.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAIjE,OAAO,EAGL,KAAK,0BAA0B,EAChC,MAAM,mBAAmB,CAAA;AAG1B,eAAO,MAAM,qCAAqC,oDACC,CAAA;AAEnD,eAAO,MAAM,sBAAsB,GACjC,YAAY,SAAS,WAAW,EAChC,QAAQ,GAAG,GAAG,EACd,kBAAkB,GAAG,YAAY,EAEjC,MAAM,aAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,kBAAkB,CAAC,EAC/D,OAAO,0BAA0B,KAChC,IA6BF,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rpcbase/form",
-  "version": "0.54.0",
+  "version": "0.56.0",
   "type": "module",
   "files": [
     "dist"