remix-validated-form 4.1.0 → 4.1.4-beta.0

package/build/ValidatedForm.js

@@ -124,10 +124,11 @@ const useFormAtom = (formId) => {
 /**
  * The primary form component of `remix-validated-form`.
  */
-function ValidatedForm({ validator, onSubmit, children, fetcher, action, defaultValues: providedDefaultValues, formRef: formRefProp, onReset, subaction, resetAfterSubmit = false, disableFocusOnError, method, replace, id, ...rest }) {
+function ValidatedForm({ validator, onSubmit, children, fetcher, action, defaultValues: unMemoizedDefaults, formRef: formRefProp, onReset, subaction, resetAfterSubmit = false, disableFocusOnError, method, replace, id, ...rest }) {
     var _a;
     const formId = useFormId(id);
     const formAtom = useFormAtom(formId);
+    const providedDefaultValues = (0, util_1.useDeepEqualsMemo)(unMemoizedDefaults);
     const contextValue = (0, react_2.useMemo)(() => ({
         formId,
         action,
@@ -211,9 +212,9 @@ function ValidatedForm({ validator, onSubmit, children, fetcher, action, default
                 clickedButtonRef.current = submitButton;
             }
         }
-        window.addEventListener("click", handleClick);
+        window.addEventListener("click", handleClick, { capture: true });
         return () => {
-            window.removeEventListener("click", handleClick);
+            window.removeEventListener("click", handleClick, { capture: true });
         };
     }, []);
     const handleSubmit = async (e) => {
@@ -233,10 +234,15 @@ function ValidatedForm({ validator, onSubmit, children, fetcher, action, default
                 endSubmit({ formAtom });
                 return;
             }
+            // 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 || e.currentTarget);
+                fetcher.submit(clickedButtonRef.current || formRef.current);
             else
-                submit(clickedButtonRef.current || e.currentTarget, {
+                submit(clickedButtonRef.current || formRef.current, {
                     method,
                     replace,
                 });

package/build/internal/MultiValueMap.js

@@ -34,11 +34,11 @@ class MultiValueMap {
 exports.MultiValueMap = MultiValueMap;
 const useMultiValueMap = () => {
     const ref = (0, react_1.useRef)(null);
-    return () => {
+    return (0, react_1.useCallback)(() => {
         if (ref.current)
             return ref.current;
         ref.current = new MultiValueMap();
         return ref.current;
-    };
+    }, []);
 };
 exports.useMultiValueMap = useMultiValueMap;

package/build/internal/hooks-valtio.d.ts

@@ -0,0 +1,18 @@
+import { useUpdateAtom } from "jotai/utils";
+import { FieldErrors, ValidationErrorResponseData } from "..";
+import { InternalFormContextValue } from "./formContext";
+import { Hydratable } from "./hydratable";
+export declare const useInternalFormContext: (formId?: string | symbol | undefined, hookName?: string | undefined) => InternalFormContextValue;
+export declare function useErrorResponseForForm({ fetcher, subaction, formId, }: InternalFormContextValue): ValidationErrorResponseData | null;
+export declare const useFieldErrorsForForm: (context: InternalFormContextValue) => Hydratable<FieldErrors | undefined>;
+export declare const useDefaultValuesFromLoader: ({ formId, }: InternalFormContextValue) => any;
+export declare const useDefaultValuesForForm: (context: InternalFormContextValue) => Hydratable<{
+    [fieldName: string]: any;
+}>;
+export declare const useHasActiveFormSubmit: ({ fetcher, }: InternalFormContextValue) => boolean;
+export declare const useFieldTouched: (name: string, { formId }: InternalFormContextValue) => boolean;
+export declare const useFieldError: (name: string, context: InternalFormContextValue) => string | undefined;
+export declare const useFieldDefaultValue: (name: string, context: InternalFormContextValue) => any;
+export declare const useFormUpdateAtom: typeof useUpdateAtom;
+export declare const useClearError: (context: InternalFormContextValue) => (name: string) => void;
+export declare const useSetTouched: (context: InternalFormContextValue) => (name: string, touched: boolean) => void;

package/build/internal/hooks-valtio.js

@@ -0,0 +1,128 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSetTouched = exports.useClearError = exports.useFormUpdateAtom = exports.useFieldDefaultValue = exports.useFieldError = exports.useFieldTouched = exports.useHasActiveFormSubmit = exports.useDefaultValuesForForm = exports.useDefaultValuesFromLoader = exports.useFieldErrorsForForm = exports.useErrorResponseForForm = exports.useInternalFormContext = void 0;
+const react_1 = require("@remix-run/react");
+const utils_1 = require("jotai/utils");
+const get_1 = __importDefault(require("lodash/get"));
+const react_2 = require("react");
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+const constants_1 = require("./constants");
+const formContext_1 = require("./formContext");
+const hydratable_1 = require("./hydratable");
+const state_1 = require("./state");
+const state_valtio_1 = require("./state-valtio");
+const useInternalFormContext = (formId, hookName) => {
+    const formContext = (0, react_2.useContext)(formContext_1.InternalFormContext);
+    if (formId)
+        return { formId };
+    if (formContext)
+        return formContext;
+    throw new Error(`Unable to determine form for ${hookName}. Please use it inside a form or pass a 'formId'.`);
+};
+exports.useInternalFormContext = useInternalFormContext;
+function useErrorResponseForForm({ fetcher, subaction, formId, }) {
+    var _a;
+    const actionData = (0, react_1.useActionData)();
+    if (fetcher) {
+        if ((_a = fetcher.data) === null || _a === void 0 ? void 0 : _a.fieldErrors)
+            return fetcher.data;
+        return null;
+    }
+    if (!(actionData === null || actionData === void 0 ? void 0 : actionData.fieldErrors))
+        return null;
+    // If there's an explicit id, we should ignore data that has the wrong id
+    if (typeof formId === "string" && actionData.formId)
+        return actionData.formId === formId ? actionData : null;
+    if ((!subaction && !actionData.subaction) ||
+        actionData.subaction === subaction)
+        return actionData;
+    return null;
+}
+exports.useErrorResponseForForm = useErrorResponseForForm;
+const useFieldErrorsForForm = (context) => {
+    const response = useErrorResponseForForm(context);
+    const form = (0, state_valtio_1.useFormData)(context.formId);
+    return hydratable_1.hydratable.from(response === null || response === void 0 ? void 0 : response.fieldErrors, form.hydrated);
+};
+exports.useFieldErrorsForForm = useFieldErrorsForForm;
+const useDefaultValuesFromLoader = ({ formId, }) => {
+    const matches = (0, react_1.useMatches)();
+    if (typeof formId === "string") {
+        const dataKey = (0, constants_1.formDefaultValuesKey)(formId);
+        // If multiple loaders declare the same default values,
+        // we should use the data from the deepest route.
+        const match = matches
+            .reverse()
+            .find((match) => match.data && dataKey in match.data);
+        return match === null || match === void 0 ? void 0 : match.data[dataKey];
+    }
+    return null;
+};
+exports.useDefaultValuesFromLoader = useDefaultValuesFromLoader;
+const useDefaultValuesForForm = (context) => {
+    const { formId, defaultValuesProp } = context;
+    const form = (0, state_valtio_1.useFormData)(formId);
+    const errorResponse = useErrorResponseForForm(context);
+    const defaultValuesFromLoader = (0, exports.useDefaultValuesFromLoader)(context);
+    // Typical flow is:
+    // - Default values only available from props or server
+    //   - Props have a higher priority than server
+    // - State gets hydrated with default values
+    // - After submit, we may need to use values from the error
+    if (form.hydrated)
+        return hydratable_1.hydratable.hydratedData();
+    if (errorResponse === null || errorResponse === void 0 ? void 0 : errorResponse.repopulateFields) {
+        (0, tiny_invariant_1.default)(typeof errorResponse.repopulateFields === "object", "repopulateFields returned something other than an object");
+        return hydratable_1.hydratable.serverData(errorResponse.repopulateFields);
+    }
+    if (defaultValuesProp)
+        return hydratable_1.hydratable.serverData(defaultValuesProp);
+    return hydratable_1.hydratable.serverData(defaultValuesFromLoader);
+};
+exports.useDefaultValuesForForm = useDefaultValuesForForm;
+const useHasActiveFormSubmit = ({ fetcher, }) => {
+    const transition = (0, react_1.useTransition)();
+    const hasActiveSubmission = fetcher
+        ? fetcher.state === "submitting"
+        : !!transition.submission;
+    return hasActiveSubmission;
+};
+exports.useHasActiveFormSubmit = useHasActiveFormSubmit;
+const useFieldTouched = (name, { formId }) => {
+    const form = (0, state_valtio_1.useFormData)(formId);
+    return form.touchedFields[name];
+};
+exports.useFieldTouched = useFieldTouched;
+const useFieldError = (name, context) => {
+    const fieldErrors = (0, exports.useFieldErrorsForForm)(context);
+    const form = (0, state_valtio_1.useFormData)(context.formId);
+    return fieldErrors
+        .map((fieldErrors) => fieldErrors === null || fieldErrors === void 0 ? void 0 : fieldErrors[name])
+        .hydrateTo(form.fieldErrors[name]);
+};
+exports.useFieldError = useFieldError;
+const useFieldDefaultValue = (name, context) => {
+    const defaultValues = (0, exports.useDefaultValuesForForm)(context);
+    const state = (0, state_valtio_1.useFormData)(context.formId);
+    return defaultValues.map((val) => (0, get_1.default)(val, name)).hydrateTo(state);
+};
+exports.useFieldDefaultValue = useFieldDefaultValue;
+const useFormUpdateAtom = (atom) => (0, utils_1.useUpdateAtom)(atom, state_1.ATOM_SCOPE);
+exports.useFormUpdateAtom = useFormUpdateAtom;
+const useClearError = (context) => {
+    const clearError = (0, exports.useFormUpdateAtom)(state_1.clearErrorAtom);
+    return (0, react_2.useCallback)((name) => {
+        clearError({ name, formAtom: (0, state_1.formRegistry)(context.formId) });
+    }, [clearError, context.formId]);
+};
+exports.useClearError = useClearError;
+const useSetTouched = (context) => {
+    const setTouched = (0, exports.useFormUpdateAtom)(state_1.setTouchedAtom);
+    return (0, react_2.useCallback)((name, touched) => {
+        setTouched({ name, formAtom: (0, state_1.formRegistry)(context.formId), touched });
+    }, [setTouched, context.formId]);
+};
+exports.useSetTouched = useSetTouched;

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

@@ -0,0 +1,16 @@
+import { FieldErrors, ValidationErrorResponseData } from "..";
+import { InternalFormContextValue } from "./formContext";
+import { Hydratable } from "./hydratable";
+export declare const useInternalFormContext: (formId?: string | symbol | undefined, hookName?: string | undefined) => InternalFormContextValue;
+export declare function useErrorResponseForForm({ fetcher, subaction, formId, }: InternalFormContextValue): ValidationErrorResponseData | null;
+export declare const useFieldErrorsForForm: (context: InternalFormContextValue) => Hydratable<FieldErrors | undefined>;
+export declare const useDefaultValuesFromLoader: ({ formId, }: InternalFormContextValue) => any;
+export declare const useDefaultValuesForForm: (context: InternalFormContextValue) => Hydratable<{
+    [fieldName: string]: any;
+}>;
+export declare const useHasActiveFormSubmit: ({ fetcher, }: InternalFormContextValue) => boolean;
+export declare const useFieldTouched: (name: string, { formId }: InternalFormContextValue) => boolean;
+export declare const useFieldError: (name: string, context: InternalFormContextValue) => string | undefined;
+export declare const useFieldDefaultValue: (name: string, context: InternalFormContextValue) => any;
+export declare const useClearError: (context: InternalFormContextValue) => (name: string) => void;
+export declare const useSetTouched: (context: InternalFormContextValue) => (name: string, touched: boolean) => void;

package/build/internal/hooks-zustand.js

@@ -0,0 +1,117 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSetTouched = exports.useClearError = exports.useFieldDefaultValue = exports.useFieldError = exports.useFieldTouched = exports.useHasActiveFormSubmit = exports.useDefaultValuesForForm = exports.useDefaultValuesFromLoader = exports.useFieldErrorsForForm = exports.useErrorResponseForForm = exports.useInternalFormContext = void 0;
+const react_1 = require("@remix-run/react");
+const get_1 = __importDefault(require("lodash/get"));
+const react_2 = require("react");
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+const constants_1 = require("./constants");
+const formContext_1 = require("./formContext");
+const hydratable_1 = require("./hydratable");
+const state_zustand_1 = require("./state-zustand");
+const useInternalFormContext = (formId, hookName) => {
+    const formContext = (0, react_2.useContext)(formContext_1.InternalFormContext);
+    if (formId)
+        return { formId };
+    if (formContext)
+        return formContext;
+    throw new Error(`Unable to determine form for ${hookName}. Please use it inside a form or pass a 'formId'.`);
+};
+exports.useInternalFormContext = useInternalFormContext;
+function useErrorResponseForForm({ fetcher, subaction, formId, }) {
+    var _a;
+    const actionData = (0, react_1.useActionData)();
+    if (fetcher) {
+        if ((_a = fetcher.data) === null || _a === void 0 ? void 0 : _a.fieldErrors)
+            return fetcher.data;
+        return null;
+    }
+    if (!(actionData === null || actionData === void 0 ? void 0 : actionData.fieldErrors))
+        return null;
+    // If there's an explicit id, we should ignore data that has the wrong id
+    if (typeof formId === "string" && actionData.formId)
+        return actionData.formId === formId ? actionData : null;
+    if ((!subaction && !actionData.subaction) ||
+        actionData.subaction === subaction)
+        return actionData;
+    return null;
+}
+exports.useErrorResponseForForm = useErrorResponseForForm;
+const useFieldErrorsForForm = (context) => {
+    const response = useErrorResponseForForm(context);
+    const hydrated = (0, state_zustand_1.useStore)((state) => state.form(context.formId).hydrated);
+    return hydratable_1.hydratable.from(response === null || response === void 0 ? void 0 : response.fieldErrors, hydrated);
+};
+exports.useFieldErrorsForForm = useFieldErrorsForForm;
+const useDefaultValuesFromLoader = ({ formId, }) => {
+    const matches = (0, react_1.useMatches)();
+    if (typeof formId === "string") {
+        const dataKey = (0, constants_1.formDefaultValuesKey)(formId);
+        // If multiple loaders declare the same default values,
+        // we should use the data from the deepest route.
+        const match = matches
+            .reverse()
+            .find((match) => match.data && dataKey in match.data);
+        return match === null || match === void 0 ? void 0 : match.data[dataKey];
+    }
+    return null;
+};
+exports.useDefaultValuesFromLoader = useDefaultValuesFromLoader;
+const useDefaultValuesForForm = (context) => {
+    const { formId, defaultValuesProp } = context;
+    const hydrated = (0, state_zustand_1.useStore)((state) => state.form(formId).hydrated);
+    const errorResponse = useErrorResponseForForm(context);
+    const defaultValuesFromLoader = (0, exports.useDefaultValuesFromLoader)(context);
+    // Typical flow is:
+    // - Default values only available from props or server
+    //   - Props have a higher priority than server
+    // - State gets hydrated with default values
+    // - After submit, we may need to use values from the error
+    if (hydrated)
+        return hydratable_1.hydratable.hydratedData();
+    if (errorResponse === null || errorResponse === void 0 ? void 0 : errorResponse.repopulateFields) {
+        (0, tiny_invariant_1.default)(typeof errorResponse.repopulateFields === "object", "repopulateFields returned something other than an object");
+        return hydratable_1.hydratable.serverData(errorResponse.repopulateFields);
+    }
+    if (defaultValuesProp)
+        return hydratable_1.hydratable.serverData(defaultValuesProp);
+    return hydratable_1.hydratable.serverData(defaultValuesFromLoader);
+};
+exports.useDefaultValuesForForm = useDefaultValuesForForm;
+const useHasActiveFormSubmit = ({ fetcher, }) => {
+    const transition = (0, react_1.useTransition)();
+    const hasActiveSubmission = fetcher
+        ? fetcher.state === "submitting"
+        : !!transition.submission;
+    return hasActiveSubmission;
+};
+exports.useHasActiveFormSubmit = useHasActiveFormSubmit;
+const useFieldTouched = (name, { formId }) => {
+    return (0, state_zustand_1.useStore)((state) => state.form(formId).touchedFields[name]);
+};
+exports.useFieldTouched = useFieldTouched;
+const useFieldError = (name, context) => {
+    const state = (0, state_zustand_1.useStore)((state) => state.form(context.formId).fieldErrors[name]);
+    return (0, exports.useFieldErrorsForForm)(context)
+        .map((fieldErrors) => fieldErrors === null || fieldErrors === void 0 ? void 0 : fieldErrors[name])
+        .hydrateTo(state);
+};
+exports.useFieldError = useFieldError;
+const useFieldDefaultValue = (name, context) => {
+    const state = (0, state_zustand_1.useStore)((state) => state.form(context.formId).defaultValues[name]);
+    return (0, exports.useDefaultValuesForForm)(context)
+        .map((val) => (0, get_1.default)(val, name))
+        .hydrateTo(state);
+};
+exports.useFieldDefaultValue = useFieldDefaultValue;
+const useClearError = (context) => {
+    return (0, state_zustand_1.useStore)((state) => state.helpers(context.formId).clearError);
+};
+exports.useClearError = useClearError;
+const useSetTouched = (context) => {
+    return (0, state_zustand_1.useStore)((state) => state.helpers(context.formId).setTouched);
+};
+exports.useSetTouched = useSetTouched;

package/build/internal/hydratable.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The purpose of this type is to simplify the logic
+ * around data that needs to come from the server initially,
+ * but from the internal state after hydration.
+ */
+export declare type Hydratable<T> = {
+    hydrateTo: (data: T) => T;
+    map: <U>(fn: (data: T) => U) => Hydratable<U>;
+};
+export declare const hydratable: {
+    serverData: <T>(data: T) => Hydratable<T>;
+    hydratedData: <T_1>() => Hydratable<T_1>;
+    from: <T_2>(data: T_2, hydrated: boolean) => Hydratable<T_2>;
+};

package/build/internal/hydratable.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hydratable = void 0;
+const serverData = (data) => ({
+    hydrateTo: () => data,
+    map: (fn) => serverData(fn(data)),
+});
+const hydratedData = () => ({
+    hydrateTo: (hydratedData) => hydratedData,
+    map: () => hydratedData(),
+});
+const from = (data, hydrated) => hydrated ? hydratedData() : serverData(data);
+exports.hydratable = {
+    serverData,
+    hydratedData,
+    from,
+};

package/build/internal/immerMiddleware.d.ts

@@ -0,0 +1,6 @@
+import { Draft } from "immer";
+import { State, StateCreator } from "zustand";
+declare type TImmerConfigFn<T extends State> = (partial: ((draft: Draft<T>) => void) | T, replace?: boolean) => void;
+declare type TImmerConfig<T extends State> = StateCreator<T, TImmerConfigFn<T>>;
+export declare const immer: <T extends object>(config: TImmerConfig<T>) => StateCreator<T, import("zustand").SetState<T>, import("zustand").GetState<T>, import("zustand").StoreApi<T>>;
+export {};

package/build/internal/immerMiddleware.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.immer = void 0;
+const immer_1 = __importDefault(require("immer"));
+const immer = (config) => (set, get, api) => config((partial, replace) => {
+    const nextState = typeof partial === "function"
+        ? (0, immer_1.default)(partial)
+        : partial;
+    return set(nextState, replace);
+}, get, api);
+exports.immer = immer;

package/build/internal/logic/getCheckboxChecked.d.ts

@@ -0,0 +1 @@
+export declare const getCheckboxChecked: (checkboxValue: string | undefined, newValue: unknown) => boolean | undefined;

package/build/internal/logic/getCheckboxChecked.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCheckboxChecked = void 0;
+const getCheckboxChecked = (checkboxValue = "on", newValue) => {
+    if (Array.isArray(newValue))
+        return newValue.some((val) => val === true || val === checkboxValue);
+    if (typeof newValue === "boolean")
+        return newValue;
+    if (typeof newValue === "string")
+        return newValue === checkboxValue;
+    return undefined;
+};
+exports.getCheckboxChecked = getCheckboxChecked;

package/build/internal/logic/getRadioChecked.d.ts

@@ -0,0 +1 @@
+export declare const getRadioChecked: (radioValue: string | undefined, newValue: unknown) => boolean | undefined;

package/build/internal/logic/getRadioChecked.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRadioChecked = void 0;
+const getRadioChecked = (radioValue = "on", newValue) => {
+    if (typeof newValue === "string")
+        return newValue === radioValue;
+    return undefined;
+};
+exports.getRadioChecked = getRadioChecked;

package/build/internal/logic/setFieldValue.d.ts

@@ -0,0 +1 @@
+export declare const setFieldValue: (formElement: HTMLFormElement, name: string, value: unknown) => void;

package/build/internal/logic/setFieldValue.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setFieldValue = void 0;
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+const getCheckboxChecked_1 = require("./getCheckboxChecked");
+const getRadioChecked_1 = require("./getRadioChecked");
+const setElementValue = (element, value, name) => {
+    if (element instanceof HTMLSelectElement && element.multiple) {
+        (0, tiny_invariant_1.default)(Array.isArray(value), "Must specify an array to set the value for a multi-select");
+        for (const option of element.options) {
+            option.selected = value.includes(option.value);
+        }
+        return;
+    }
+    if (element instanceof HTMLInputElement && element.type === "checkbox") {
+        const newChecked = (0, getCheckboxChecked_1.getCheckboxChecked)(element.value, value);
+        (0, tiny_invariant_1.default)(newChecked !== undefined, `Unable to determine if checkbox should be checked. Provided value was ${value} for checkbox ${name}.`);
+        element.checked = newChecked;
+        return;
+    }
+    if (element instanceof HTMLInputElement && element.type === "radio") {
+        const newChecked = (0, getRadioChecked_1.getRadioChecked)(element.value, value);
+        (0, tiny_invariant_1.default)(newChecked !== undefined, `Unable to determine if radio should be checked. Provided value was ${value} for radio ${name}.`);
+        element.checked = newChecked;
+        return;
+    }
+    (0, tiny_invariant_1.default)(typeof value === "string", `Invalid value for field "${name}" which is an ${element.constructor.name}. Expected string but received ${typeof value}`);
+    const input = element;
+    input.value = value;
+};
+const setFieldValue = (formElement, name, value) => {
+    const controlElement = formElement.elements.namedItem(name);
+    if (!controlElement)
+        return;
+    if (controlElement instanceof RadioNodeList) {
+        for (const element of controlElement) {
+            setElementValue(element, value, name);
+        }
+    }
+    else {
+        setElementValue(controlElement, value, name);
+    }
+};
+exports.setFieldValue = setFieldValue;

package/build/internal/logic/setInputValueInForm.d.ts

@@ -0,0 +1 @@
+export declare const setInputValueInForm: (formElement: HTMLFormElement, name: string, value: unknown[]) => void;

package/build/internal/logic/setInputValueInForm.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setInputValueInForm = void 0;
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+const getCheckboxChecked_1 = require("./getCheckboxChecked");
+/**
+ * Helper class to track the values being set on uncontrolled fields.
+ * HTML is super permissive with inputs that all share the same `name`.
+ *
+ * This class is strict in the sense that, if the user provides an array value,
+ * the values inside the array must be in the same order as the elements in the DOM.
+ * Doing this allows us to be flexible with what types of form controls the user is using.
+ *
+ * This is how HTML tracks inputs of the same name as well.
+ * `new FormData(formElement).getAll('myField')` will return values in DOM order.
+ */
+class Values {
+    constructor(values) {
+        this.hasSetRadioValue = false;
+        this.bool = (value) => {
+            if ((0, getCheckboxChecked_1.getCheckboxChecked)(value, this.values[0])) {
+                this.values.shift();
+                return true;
+            }
+            return false;
+        };
+        this.radio = (value) => {
+            if (this.hasSetRadioValue)
+                return false;
+            const result = this.bool(value);
+            if (result)
+                this.hasSetRadioValue = true;
+            return result;
+        };
+        this.str = () => { var _a; return String((_a = this.values.pop()) !== null && _a !== void 0 ? _a : ""); };
+        this.allValues = () => this.values;
+        this.warnIfLeftovers = (field) => {
+            if (this.values.length > 0) {
+                console.warn(`Could not determine how to use the value for the field ${field}. ` +
+                    `Leftover values were: ${this.values.join(", ")}.`);
+            }
+        };
+        const unknownValues = Array.isArray(values) ? values : [values];
+        this.values = unknownValues;
+    }
+}
+/**
+ * This subclass is order-permissive, meaning the user doesn't have to worry about
+ * the order in which the inputs occur in the DOM.
+ * This is useful for multiselects and checkbox groups and provides a better DX than
+ * the order-strict version.
+ */
+class PermissiveValues extends Values {
+    constructor() {
+        super(...arguments);
+        this.remove = (value) => {
+            const index = this.values.indexOf(value);
+            const deleted = this.values.splice(index, 1);
+            return deleted.length > 0;
+        };
+        this.bool = (value) => {
+            if ((0, getCheckboxChecked_1.getCheckboxChecked)(value, this.values)) {
+                this.remove(value) || this.remove(true);
+                return true;
+            }
+            return false;
+        };
+    }
+}
+const isMultiselect = (node) => node instanceof HTMLSelectElement && node.multiple;
+const isCheckbox = (node) => node instanceof HTMLInputElement && node.type === "checkbox";
+const isRadio = (node) => node instanceof HTMLInputElement && node.type === "radio";
+const setElementValue = (element, values, field) => {
+    if (isMultiselect(element)) {
+        for (const option of element.options) {
+            option.selected = values.bool(option.value);
+        }
+        return;
+    }
+    if (isCheckbox(element)) {
+        element.checked = values.bool(element.value);
+        return;
+    }
+    if (isRadio(element)) {
+        element.checked = values.radio(element.value);
+        return;
+    }
+    const input = element;
+    (0, tiny_invariant_1.default)(input.type !== "hidden", `Cannot set value on hidden input if it is not a controlled field. Field being updated was ${field}.`);
+    input.value = values.str();
+};
+const areElementsTheSameType = (nodes) => {
+    const getType = (node) => {
+        if (node instanceof HTMLInputElement)
+            return node.type;
+        if (node instanceof HTMLSelectElement)
+            return node.multiple ? "select" : "multiselect";
+        return null;
+    };
+    const firstElementInstance = nodes[0].constructor;
+    const firstElementType = getType(nodes[0]);
+    return nodes.every((element) => element.constructor === firstElementInstance &&
+        getType(element) === firstElementType);
+};
+const setInputValueInForm = (formElement, name, value) => {
+    const controlElement = formElement.elements.namedItem(name);
+    if (!controlElement)
+        return;
+    if (controlElement instanceof RadioNodeList) {
+        const values = areElementsTheSameType([...controlElement])
+            ? new PermissiveValues(value)
+            : new Values(value);
+        for (const element of controlElement) {
+            setElementValue(element, values, name);
+        }
+        values.warnIfLeftovers(name);
+    }
+    else {
+        const values = new PermissiveValues(value);
+        setElementValue(controlElement, values, name);
+        values.warnIfLeftovers(name);
+    }
+};
+exports.setInputValueInForm = setInputValueInForm;

package/build/internal/setFormValues.d.ts

@@ -0,0 +1,2 @@
+import { InternalFormId } from "./state/atomUtils";
+export declare const useSetFormValues: (formId: InternalFormId) => (arg: Record<string, unknown>) => Promise<void>;

package/build/internal/setFormValues.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSetFormValues = void 0;
+const utils_1 = require("jotai/utils");
+const react_1 = require("react");
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+const setInputValueInForm_1 = require("./logic/setInputValueInForm");
+const state_1 = require("./state");
+const controlledFields_1 = require("./state/controlledFields");
+const useSetFormValues = (formId) => (0, utils_1.useAtomCallback)((0, react_1.useCallback)(async (get, set, updatedValues) => {
+    const form = get((0, state_1.formElementAtom)(formId));
+    (0, tiny_invariant_1.default)(form, "Unable to access form element when setting field value. This is likely a bug in remix-validated-form.");
+    const controlledFields = get((0, controlledFields_1.controlledFieldsAtom)(formId));
+    const updatePromises = [];
+    for (const [field, value] of Object.entries(updatedValues)) {
+        const isControlled = !!controlledFields[field];
+        if (isControlled) {
+            updatePromises.push(set(controlledFields_1.setControlledFieldValueAtom, {
+                field,
+                formId,
+                value,
+            }));
+        }
+        else {
+            (0, setInputValueInForm_1.setInputValueInForm)(form, field, Array.isArray(value) ? value : [value]);
+        }
+    }
+    await Promise.all(updatePromises);
+}, [formId]), state_1.ATOM_SCOPE);
+exports.useSetFormValues = useSetFormValues;