remix-validated-form 4.1.1 → 4.1.4

package/build/internal/state-valtio.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setFieldErrors = exports.reset = exports.setTouched = exports.addError = exports.clearError = exports.sync = exports.endSubmit = exports.startSubmit = exports.useFormData = exports.unregisterFormSlice = exports.registerFormSlice = exports.state = void 0;
+const valtio_1 = require("valtio");
+exports.state = (0, valtio_1.proxy)({ forms: {} });
+const registerFormSlice = (formId, { registerReceiveFocus, setFieldValueForForm, validateField, action, defaultValues, subaction, }) => {
+    exports.state.forms[formId] = {
+        hydrated: true,
+        defaultValues: defaultValues !== null && defaultValues !== void 0 ? defaultValues : {},
+        fieldErrors: {},
+        hasBeenSubmitted: false,
+        isSubmitting: false,
+        touchedFields: {},
+        registerReceiveFocus,
+        setFieldValue: setFieldValueForForm,
+        validateField,
+        action,
+        subaction,
+    };
+};
+exports.registerFormSlice = registerFormSlice;
+const unregisterFormSlice = (formId) => {
+    delete exports.state.forms[formId];
+};
+exports.unregisterFormSlice = unregisterFormSlice;
+const unhydratedFormState = {
+    hydrated: false,
+    fieldErrors: {},
+    isSubmitting: false,
+    hasBeenSubmitted: false,
+    touchedFields: {},
+    defaultValues: {},
+    validateField: () => Promise.resolve(null),
+    registerReceiveFocus: () => () => { },
+    setFieldValue: () => { },
+};
+const useFormData = (formId) => {
+    var _a;
+    const snapshot = (0, valtio_1.useSnapshot)(exports.state);
+    return (_a = snapshot.forms[formId]) !== null && _a !== void 0 ? _a : unhydratedFormState;
+};
+exports.useFormData = useFormData;
+const startSubmit = (formId) => {
+    exports.state.forms[formId].isSubmitting = true;
+    exports.state.forms[formId].hasBeenSubmitted = true;
+};
+exports.startSubmit = startSubmit;
+const endSubmit = (formId) => {
+    exports.state.forms[formId].isSubmitting = false;
+};
+exports.endSubmit = endSubmit;
+const sync = (formId, { defaultValues, action, subaction, registerReceiveFocus, validateField, setFieldValueForForm, }) => {
+    exports.state.forms[formId].defaultValues = defaultValues !== null && defaultValues !== void 0 ? defaultValues : {};
+    exports.state.forms[formId].action = action;
+    exports.state.forms[formId].subaction = subaction;
+    exports.state.forms[formId].registerReceiveFocus = registerReceiveFocus;
+    exports.state.forms[formId].validateField = validateField;
+    exports.state.forms[formId].hydrated = true;
+    exports.state.forms[formId].setFieldValue = setFieldValueForForm;
+};
+exports.sync = sync;
+const clearError = (formId, fieldName) => {
+    delete exports.state.forms[formId].fieldErrors[fieldName];
+};
+exports.clearError = clearError;
+const addError = (formId, fieldName, error) => {
+    exports.state.forms[formId].fieldErrors[fieldName] = error;
+};
+exports.addError = addError;
+const setTouched = (formId, fieldName, touched) => {
+    exports.state.forms[formId].touchedFields[fieldName] = touched;
+};
+exports.setTouched = setTouched;
+const reset = (formId) => {
+    exports.state.forms[formId].fieldErrors = {};
+    exports.state.forms[formId].touchedFields = {};
+    exports.state.forms[formId].hasBeenSubmitted = false;
+};
+exports.reset = reset;
+const setFieldErrors = (formId, fieldErrors) => {
+    exports.state.forms[formId].fieldErrors = fieldErrors;
+};
+exports.setFieldErrors = setFieldErrors;

package/build/internal/state-zustand.d.ts

@@ -0,0 +1,47 @@
+import { FieldErrors, TouchedFields } from "..";
+export declare type InternalFormState = {
+    hydrated: boolean;
+    fieldErrors: FieldErrors;
+    isSubmitting: boolean;
+    hasBeenSubmitted: boolean;
+    touchedFields: TouchedFields;
+    action?: string;
+    subaction?: string;
+    defaultValues: {
+        [fieldName: string]: any;
+    };
+    validateField: (fieldName: string) => Promise<string | null>;
+    registerReceiveFocus: (fieldName: string, handler: () => void) => () => void;
+    setFieldValue: (fieldName: string, value: unknown) => void;
+};
+declare type Helpers = {
+    startSubmit: () => void;
+    endSubmit: () => void;
+    sync: (args: SyncFormArgs) => void;
+    clearError: (name: string) => void;
+    addError: (name: string, error: string) => void;
+    setTouched: (name: string, touched: boolean) => void;
+    reset: () => void;
+    setFieldErrors: (fieldErrors: FieldErrors) => void;
+    register: (init: SyncFormArgs) => void;
+    unregister: () => void;
+};
+declare type SyncFormArgs = {
+    defaultValues?: {
+        [fieldName: string]: any;
+    };
+    action?: string;
+    subaction?: string;
+    validateField: InternalFormState["validateField"];
+    registerReceiveFocus: InternalFormState["registerReceiveFocus"];
+    setFieldValueForForm: InternalFormState["setFieldValue"];
+};
+declare type StoreState = {
+    forms: {
+        [formId: string | symbol]: InternalFormState;
+    };
+    form: (formId: string | symbol) => InternalFormState;
+    helpers: (formId: string | symbol) => Helpers;
+};
+export declare const useStore: import("zustand").UseBoundStore<StoreState, import("zustand").StoreApi<StoreState>>;
+export {};

package/build/internal/state-zustand.js

@@ -0,0 +1,91 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useStore = void 0;
+const zustand_1 = __importDefault(require("zustand"));
+const immerMiddleware_1 = require("./immerMiddleware");
+const unhydratedFormState = {
+    hydrated: false,
+    fieldErrors: {},
+    isSubmitting: false,
+    hasBeenSubmitted: false,
+    touchedFields: {},
+    defaultValues: {},
+    validateField: () => Promise.resolve(null),
+    registerReceiveFocus: () => () => { },
+    setFieldValue: () => { },
+    // clearError: () => {},
+    // addError: () => {},
+    // setTouched: () => {},
+    // reset: () => {},
+    // startSubmit: () => {},
+    // endSubmit: () => {},
+    // sync: () => {},
+    // setFieldErrors: () => {},
+};
+exports.useStore = (0, zustand_1.default)((0, immerMiddleware_1.immer)((set, get) => ({
+    forms: {},
+    form: (formId) => { var _a; return (_a = get().forms[formId]) !== null && _a !== void 0 ? _a : unhydratedFormState; },
+    helpers: (formId) => ({
+        clearError: (name) => set((state) => {
+            delete state.forms[formId].fieldErrors[name];
+        }),
+        addError: (name, error) => set((state) => {
+            state.forms[formId].fieldErrors[name] = error;
+        }),
+        setTouched: (name, touched) => set((state) => {
+            state.forms[formId].touchedFields[name] = touched;
+        }),
+        reset: () => set((state) => {
+            state.forms[formId].fieldErrors = {};
+            state.forms[formId].touchedFields = {};
+            state.forms[formId].hasBeenSubmitted = false;
+        }),
+        startSubmit: () => set((state) => {
+            state.forms[formId].hasBeenSubmitted = true;
+            state.forms[formId].isSubmitting = true;
+        }),
+        endSubmit: () => set((state) => {
+            state.forms[formId].isSubmitting = false;
+        }),
+        setFieldErrors: (fieldErrors) => {
+            set((state) => {
+                state.forms[formId].fieldErrors = fieldErrors;
+            });
+        },
+        sync: ({ defaultValues, action, subaction, validateField, registerReceiveFocus, setFieldValueForForm, }) => set((state) => {
+            state.forms[formId].defaultValues = defaultValues !== null && defaultValues !== void 0 ? defaultValues : {};
+            state.forms[formId].action = action;
+            state.forms[formId].subaction = subaction;
+            state.forms[formId].registerReceiveFocus = registerReceiveFocus;
+            state.forms[formId].validateField = validateField;
+            state.forms[formId].hydrated = true;
+            state.forms[formId].setFieldValue = setFieldValueForForm;
+        }),
+        unregister: () => {
+            set((state) => {
+                delete state.forms[formId];
+            });
+        },
+        register: ({ defaultValues, action, subaction, validateField, registerReceiveFocus, setFieldValueForForm, }) => {
+            set((state) => {
+                state.forms[formId] = {
+                    defaultValues: defaultValues !== null && defaultValues !== void 0 ? defaultValues : {},
+                    setFieldValue: setFieldValueForForm,
+                    registerReceiveFocus,
+                    validateField,
+                    action,
+                    subaction,
+                    hydrated: true,
+                    fieldErrors: {},
+                    isSubmitting: false,
+                    hasBeenSubmitted: false,
+                    touchedFields: {},
+                    // helpers
+                };
+            });
+        },
+    }),
+})));

package/build/internal/util.js

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useDeepEqualsMemo = exports.useIsomorphicLayoutEffect = exports.mergeRefs = exports.omit = void 0;
-const lodash_1 = require("lodash");
+const isEqual_1 = __importDefault(require("lodash/isEqual"));
 const react_1 = require("react");
 const omit = (obj, ...keys) => {
     const result = { ...obj };
@@ -27,7 +30,7 @@ exports.mergeRefs = mergeRefs;
 exports.useIsomorphicLayoutEffect = typeof window !== "undefined" ? react_1.useLayoutEffect : react_1.useEffect;
 const useDeepEqualsMemo = (item) => {
     const ref = (0, react_1.useRef)(item);
-    const areEqual = ref.current === item || (0, lodash_1.isEqual)(ref.current, item);
+    const areEqual = ref.current === item || (0, isEqual_1.default)(ref.current, item);
     (0, react_1.useEffect)(() => {
         if (!areEqual) {
             ref.current = item;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remix-validated-form",
-  "version": "4.1.1",
+  "version": "4.1.4",
   "description": "Form component and utils for easy form validation in remix",
   "browser": "./browser/index.js",
   "main": "./build/index.js",
@@ -33,13 +33,13 @@
     "validation"
   ],
   "peerDependencies": {
-    "@remix-run/react": "^1.0.6",
-    "@remix-run/server-runtime": "^1.0.6",
+    "@remix-run/react": "1.x",
+    "@remix-run/server-runtime": "1.x",
     "react": "^17.0.2"
   },
   "devDependencies": {
-    "@remix-run/react": "^1.0.6",
-    "@remix-run/server-runtime": "^1.0.6",
+    "@remix-run/react": "^1.2.1",
+    "@remix-run/server-runtime": "^1.2.1",
     "@types/lodash": "^4.14.178",
     "@types/react": "^17.0.37",
     "fetch-blob": "^3.1.3",

package/src/ValidatedForm.tsx

@@ -327,9 +327,9 @@ export function ValidatedForm<DataType>({
       }
     }
 
-    window.addEventListener("click", handleClick);
+    window.addEventListener("click", handleClick, { capture: true });
     return () => {
-      window.removeEventListener("click", handleClick);
+      window.removeEventListener("click", handleClick, { capture: true });
     };
   }, []);
 
@@ -354,12 +354,18 @@ export function ValidatedForm<DataType>({
         return;
       }
 
-      if (fetcher) fetcher.submit(clickedButtonRef.current || e.currentTarget);
+      // We deviate from the remix code here a bit because of our async submit.
+      // In remix's `FormImpl`, they use `event.currentTarget` to get the form,
+      // but we already have the form in `formRef.current` so we can just use that.
+      // If we use `event.currentTarget` here, it will break because `currentTarget`
+      // will have changed since the start of the submission.
+      if (fetcher) fetcher.submit(clickedButtonRef.current || formRef.current);
       else
-        submit(clickedButtonRef.current || e.currentTarget, {
+        submit(clickedButtonRef.current || formRef.current, {
           method,
           replace,
         });
+
       clickedButtonRef.current = null;
     }
   };

package/src/internal/util.ts

@@ -1,4 +1,4 @@
-import { isEqual } from "lodash";
+import isEqual from "lodash/isEqual";
 import type React from "react";
 import { useEffect, useLayoutEffect, useRef } from "react";