remix-validated-form 4.6.5 → 4.6.7

package/dist/types/internal/getInputProps.d.ts

@@ -1,29 +0,0 @@
-export declare type ValidationBehavior = "onBlur" | "onChange" | "onSubmit";
-export declare type ValidationBehaviorOptions = {
-    initial: ValidationBehavior;
-    whenTouched: ValidationBehavior;
-    whenSubmitted: ValidationBehavior;
-};
-export declare type CreateGetInputPropsOptions = {
-    clearError: () => void;
-    validate: () => void;
-    defaultValue?: any;
-    touched: boolean;
-    setTouched: (touched: boolean) => void;
-    hasBeenSubmitted: boolean;
-    validationBehavior?: Partial<ValidationBehaviorOptions>;
-    name: string;
-};
-declare type HandledProps = "name" | "defaultValue" | "defaultChecked";
-declare type Callbacks = "onChange" | "onBlur";
-declare type MinimalInputProps = {
-    onChange?: (...args: any[]) => void;
-    onBlur?: (...args: any[]) => void;
-    defaultValue?: any;
-    defaultChecked?: boolean;
-    name?: string;
-    type?: string;
-};
-export declare type GetInputProps = <T extends MinimalInputProps>(props?: Omit<T, HandledProps | Callbacks> & Partial<Pick<T, Callbacks>>) => T;
-export declare const createGetInputProps: ({ clearError, validate, defaultValue, touched, setTouched, hasBeenSubmitted, validationBehavior, name, }: CreateGetInputPropsOptions) => GetInputProps;
-export {};

package/dist/types/internal/hooks.d.ts

@@ -1,35 +0,0 @@
-import { FieldErrors, ValidationErrorResponseData } from "..";
-import { InternalFormContextValue } from "./formContext";
-import { Hydratable } from "./hydratable";
-import { InternalFormId } from "./state/types";
-export declare const useInternalFormContext: (formId?: string | symbol, hookName?: string) => 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: (field: string, { formId }: InternalFormContextValue) => readonly [boolean, (touched: boolean) => void];
-export declare const useFieldError: (name: string, context: InternalFormContextValue) => string | undefined;
-export declare const useClearError: (context: InternalFormContextValue) => (field: string) => void;
-export declare const useCurrentDefaultValueForField: (formId: InternalFormId, field: string) => any;
-export declare const useFieldDefaultValue: (name: string, context: InternalFormContextValue) => any;
-export declare const useInternalIsSubmitting: (formId: InternalFormId) => boolean;
-export declare const useInternalIsValid: (formId: InternalFormId) => boolean;
-export declare const useInternalHasBeenSubmitted: (formId: InternalFormId) => boolean;
-export declare const useValidateField: (formId: InternalFormId) => (fieldName: string) => Promise<string | null>;
-export declare const useValidate: (formId: InternalFormId) => () => Promise<import("..").ValidationResult<unknown>>;
-export declare const useRegisterReceiveFocus: (formId: InternalFormId) => (fieldName: string, handler: () => void) => () => void;
-export declare const useSyncedDefaultValues: (formId: InternalFormId) => {
-    [fieldName: string]: any;
-};
-export declare const useSetTouched: ({ formId }: InternalFormContextValue) => (field: string, touched: boolean) => void;
-export declare const useTouchedFields: (formId: InternalFormId) => import("..").TouchedFields;
-export declare const useFieldErrors: (formId: InternalFormId) => FieldErrors;
-export declare const useSetFieldErrors: (formId: InternalFormId) => (errors: FieldErrors) => void;
-export declare const useResetFormElement: (formId: InternalFormId) => () => void;
-export declare const useSubmitForm: (formId: InternalFormId) => () => void;
-export declare const useFormActionProp: (formId: InternalFormId) => string | undefined;
-export declare const useFormSubactionProp: (formId: InternalFormId) => string | undefined;
-export declare const useFormValues: (formId: InternalFormId) => () => FormData;

package/dist/types/internal/hydratable.d.ts

@@ -1,14 +0,0 @@
-/**
- * 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/dist/types/internal/logic/getCheckboxChecked.d.ts

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

package/dist/types/internal/logic/getRadioChecked.d.ts

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

package/dist/types/internal/logic/requestSubmit.d.ts

@@ -1,5 +0,0 @@
-/**
- * Ponyfill of the HTMLFormElement.requestSubmit() method.
- * Based on polyfill from: https://github.com/javan/form-request-submit-polyfill/blob/main/form-request-submit-polyfill.js
- */
-export declare const requestSubmit: (element: HTMLFormElement, submitter?: HTMLElement) => void;

package/dist/types/internal/state/arrayUtil.d.ts

@@ -1,12 +0,0 @@
-export declare const getArray: (values: any, field: string) => unknown[];
-export declare const swap: (array: unknown[], indexA: number, indexB: number) => void;
-export declare const move: (array: unknown[], from: number, to: number) => void;
-export declare const insert: (array: unknown[], index: number, value: unknown) => void;
-export declare const remove: (array: unknown[], index: number) => void;
-export declare const replace: (array: unknown[], index: number, value: unknown) => void;
-/**
- * The purpose of this helper is to make it easier to update `fieldErrors` and `touchedFields`.
- * We key those objects by full paths to the fields.
- * When we're doing array mutations, that makes it difficult to update those objects.
- */
-export declare const mutateAsArray: (field: string, obj: Record<string, any>, mutate: (arr: any[]) => void) => void;

package/dist/types/internal/state/controlledFields.d.ts

@@ -1,7 +0,0 @@
-import { InternalFormContextValue } from "../formContext";
-import { InternalFormId } from "./types";
-export declare const useControlledFieldValue: (context: InternalFormContextValue, field: string) => any;
-export declare const useRegisterControlledField: (context: InternalFormContextValue, field: string) => void;
-export declare const useControllableValue: (context: InternalFormContextValue, field: string) => readonly [any, (value: unknown) => void];
-export declare const useUpdateControllableValue: (formId: InternalFormId) => (field: string, value: unknown) => void;
-export declare const useAwaitValue: (formId: InternalFormId) => (field: string) => Promise<void>;

package/dist/types/internal/state/createFormStore.d.ts

@@ -1,79 +0,0 @@
-import { WritableDraft } from "immer/dist/internal";
-import { FieldErrors, TouchedFields, ValidationResult, Validator } from "../../validation/types";
-import { InternalFormId } from "./types";
-export declare type SyncedFormProps = {
-    formId?: string;
-    action?: string;
-    subaction?: string;
-    defaultValues: {
-        [fieldName: string]: any;
-    };
-    registerReceiveFocus: (fieldName: string, handler: () => void) => () => void;
-    validator: Validator<unknown>;
-};
-export declare type FormStoreState = {
-    forms: {
-        [formId: InternalFormId]: FormState;
-    };
-    form: (formId: InternalFormId) => FormState;
-    registerForm: (formId: InternalFormId) => void;
-    cleanupForm: (formId: InternalFormId) => void;
-};
-export declare type FormState = {
-    isHydrated: boolean;
-    isSubmitting: boolean;
-    hasBeenSubmitted: boolean;
-    fieldErrors: FieldErrors;
-    touchedFields: TouchedFields;
-    formProps?: SyncedFormProps;
-    formElement: HTMLFormElement | null;
-    currentDefaultValues: Record<string, any>;
-    isValid: () => boolean;
-    startSubmit: () => void;
-    endSubmit: () => void;
-    setTouched: (field: string, touched: boolean) => void;
-    setFieldError: (field: string, error: string) => void;
-    setFieldErrors: (errors: FieldErrors) => void;
-    clearFieldError: (field: string) => void;
-    reset: () => void;
-    syncFormProps: (props: SyncedFormProps) => void;
-    setFormElement: (formElement: HTMLFormElement | null) => void;
-    validateField: (fieldName: string) => Promise<string | null>;
-    validate: () => Promise<ValidationResult<unknown>>;
-    resetFormElement: () => void;
-    submit: () => void;
-    getValues: () => FormData;
-    controlledFields: {
-        values: {
-            [fieldName: string]: any;
-        };
-        refCounts: {
-            [fieldName: string]: number;
-        };
-        valueUpdatePromises: {
-            [fieldName: string]: Promise<void>;
-        };
-        valueUpdateResolvers: {
-            [fieldName: string]: () => void;
-        };
-        register: (fieldName: string) => void;
-        unregister: (fieldName: string) => void;
-        setValue: (fieldName: string, value: unknown) => void;
-        kickoffValueUpdate: (fieldName: string) => void;
-        getValue: (fieldName: string) => unknown;
-        awaitValueUpdate: (fieldName: string) => Promise<void>;
-        array: {
-            push: (fieldName: string, value: unknown) => void;
-            swap: (fieldName: string, indexA: number, indexB: number) => void;
-            move: (fieldName: string, fromIndex: number, toIndex: number) => void;
-            insert: (fieldName: string, index: number, value: unknown) => void;
-            unshift: (fieldName: string, value: unknown) => void;
-            remove: (fieldName: string, index: number) => void;
-            pop: (fieldName: string) => void;
-            replace: (fieldName: string, index: number, value: unknown) => void;
-        };
-    };
-};
-export declare const useRootFormStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<FormStoreState>, "setState"> & {
-    setState(nextStateOrUpdater: FormStoreState | Partial<FormStoreState> | ((state: WritableDraft<FormStoreState>) => void), shouldReplace?: boolean | undefined): void;
-}>;

package/dist/types/internal/state/fieldArray.d.ts

@@ -1,28 +0,0 @@
-import React from "react";
-export declare type FieldArrayValidationBehavior = "onChange" | "onSubmit";
-export declare type FieldArrayValidationBehaviorOptions = {
-    initial: FieldArrayValidationBehavior;
-    whenSubmitted: FieldArrayValidationBehavior;
-};
-export declare type FieldArrayHelpers<Item = any> = {
-    push: (item: Item) => void;
-    swap: (indexA: number, indexB: number) => void;
-    move: (from: number, to: number) => void;
-    insert: (index: number, value: Item) => void;
-    unshift: (value: Item) => void;
-    remove: (index: number) => void;
-    pop: () => void;
-    replace: (index: number, value: Item) => void;
-};
-export declare type UseFieldArrayOptions = {
-    formId?: string;
-    validationBehavior?: Partial<FieldArrayValidationBehaviorOptions>;
-};
-export declare function useFieldArray<Item = any>(name: string, { formId, validationBehavior }?: UseFieldArrayOptions): [itemDefaults: Item[], helpers: FieldArrayHelpers<any>, error: string | undefined];
-export declare type FieldArrayProps = {
-    name: string;
-    children: (itemDefaults: any[], helpers: FieldArrayHelpers, error: string | undefined) => React.ReactNode;
-    formId?: string;
-    validationBehavior?: FieldArrayValidationBehaviorOptions;
-};
-export declare const FieldArray: ({ name, children, formId, validationBehavior, }: FieldArrayProps) => JSX.Element;

package/dist/types/internal/state/storeHooks.d.ts

@@ -1,3 +0,0 @@
-import { FormState } from "./createFormStore";
-import { InternalFormId } from "./types";
-export declare const useFormStore: <T>(formId: InternalFormId, selector: (state: FormState) => T) => T;

package/dist/types/internal/state/types.d.ts

@@ -1 +0,0 @@
-export declare type InternalFormId = string | symbol;

package/dist/types/internal/submissionCallbacks.d.ts

@@ -1 +0,0 @@
-export declare function useSubmitComplete(isSubmitting: boolean, callback: () => void): void;

package/dist/types/internal/util.d.ts

@@ -1,5 +0,0 @@
-import type React from "react";
-export declare const omit: (obj: any, ...keys: string[]) => any;
-export declare const mergeRefs: <T = any>(refs: (React.MutableRefObject<T> | React.LegacyRef<T> | undefined)[]) => (instance: T | null) => void;
-export declare const useIsomorphicLayoutEffect: typeof React.useEffect;
-export declare const useDeepEqualsMemo: <T>(item: T) => T;

package/dist/types/server.d.ts

@@ -1,21 +0,0 @@
-import { FORM_DEFAULTS_FIELD } from "./internal/constants";
-import { ValidatorError, ValidationErrorResponseData } from "./validation/types";
-/**
- * Takes the errors from a `Validator` and returns a `Response`.
- * When you return this from your action, `ValidatedForm` on the frontend will automatically
- * display the errors on the correct fields on the correct form.
- *
- * You can also provide a second argument to `validationError`
- * to specify how to repopulate the form when JS is disabled.
- *
- * @example
- * ```ts
- * const result = validator.validate(await request.formData());
- * if (result.error) return validationError(result.error, result.submittedData);
- * ```
- */
-export declare function validationError(error: ValidatorError, repopulateFields?: unknown, init?: ResponseInit): import("@remix-run/server-runtime").TypedResponse<ValidationErrorResponseData>;
-export declare type FormDefaults = {
-    [formDefaultsKey: `${typeof FORM_DEFAULTS_FIELD}_${string}`]: any;
-};
-export declare const setFormDefaults: <DataType = any>(formId: string, defaultValues: Partial<DataType>) => FormDefaults;

package/dist/types/unreleased/formStateHooks.d.ts

@@ -1,64 +0,0 @@
-import { FieldErrors, TouchedFields, ValidationResult } from "../validation/types";
-export declare type FormState = {
-    fieldErrors: FieldErrors;
-    isSubmitting: boolean;
-    hasBeenSubmitted: boolean;
-    touchedFields: TouchedFields;
-    defaultValues: {
-        [fieldName: string]: any;
-    };
-    action?: string;
-    subaction?: string;
-    isValid: boolean;
-};
-/**
- * Returns information about the form.
- *
- * @param formId the id of the form. Only necessary if being used outside a ValidatedForm.
- */
-export declare const useFormState: (formId?: string) => FormState;
-export declare type FormHelpers = {
-    /**
-     * Clear the error of the specified field.
-     */
-    clearError: (fieldName: string) => void;
-    /**
-     * Validate the specified field.
-     */
-    validateField: (fieldName: string) => Promise<string | null>;
-    /**
-     * Change the touched state of the specified field.
-     */
-    setTouched: (fieldName: string, touched: boolean) => void;
-    /**
-     * Validate the whole form and populate any errors.
-     */
-    validate: () => Promise<ValidationResult<unknown>>;
-    /**
-     * Clears all errors on the form.
-     */
-    clearAllErrors: () => void;
-    /**
-     * Resets the form.
-     *
-     * _Note_: The equivalent behavior can be achieved by calling formElement.reset()
-     * or clicking a button element with `type="reset"`.
-     */
-    reset: () => void;
-    /**
-     * Submits the form, running all validations first.
-     *
-     * _Note_: This is equivalent to clicking a button element with `type="submit"` or calling formElement.submit().
-     */
-    submit: () => void;
-    /**
-     * Returns the current form values as FormData
-     */
-    getValues: () => FormData;
-};
-/**
- * Returns helpers that can be used to update the form state.
- *
- * @param formId the id of the form. Only necessary if being used outside a ValidatedForm.
- */
-export declare const useFormHelpers: (formId?: string) => FormHelpers;

package/dist/types/userFacingFormContext.d.ts

@@ -1,85 +0,0 @@
-import { FieldErrors, TouchedFields, ValidationResult } from "./validation/types";
-export declare type FormContextValue = {
-    /**
-     * All the errors in all the fields in the form.
-     */
-    fieldErrors: FieldErrors;
-    /**
-     * Clear the errors of the specified fields.
-     */
-    clearError: (...names: string[]) => void;
-    /**
-     * Validate the specified field.
-     */
-    validateField: (fieldName: string) => Promise<string | null>;
-    /**
-     * The `action` prop of the form.
-     */
-    action?: string;
-    /**
-     * The `subaction` prop of the form.
-     */
-    subaction?: string;
-    /**
-     * Whether or not the form is submitting.
-     */
-    isSubmitting: boolean;
-    /**
-     * Whether or not a submission has been attempted.
-     * This is true once the form has been submitted, even if there were validation errors.
-     * Resets to false when the form is reset.
-     */
-    hasBeenSubmitted: boolean;
-    /**
-     * Whether or not the form is valid.
-     */
-    isValid: boolean;
-    /**
-     * The default values of the form.
-     */
-    defaultValues?: {
-        [fieldName: string]: any;
-    };
-    /**
-     * Register a custom focus handler to be used when
-     * the field needs to receive focus due to a validation error.
-     */
-    registerReceiveFocus: (fieldName: string, handler: () => void) => () => void;
-    /**
-     * Any fields that have been touched by the user.
-     */
-    touchedFields: TouchedFields;
-    /**
-     * Change the touched state of the specified field.
-     */
-    setFieldTouched: (fieldName: string, touched: boolean) => void;
-    /**
-     * Validate the whole form and populate any errors.
-     */
-    validate: () => Promise<ValidationResult<unknown>>;
-    /**
-     * Clears all errors on the form.
-     */
-    clearAllErrors: () => void;
-    /**
-     * Resets the form.
-     *
-     * _Note_: The equivalent behavior can be achieved by calling formElement.reset()
-     * or clicking a button element with `type="reset"`.
-     */
-    reset: () => void;
-    /**
-     * Submits the form, running all validations first.
-     *
-     * _Note_: This is equivalent to clicking a button element with `type="submit"` or calling formElement.submit().
-     */
-    submit: () => void;
-    /**
-     * Returns the current form values as FormData
-     */
-    getValues: () => FormData;
-};
-/**
- * Provides access to some of the internal state of the form.
- */
-export declare const useFormContext: (formId?: string) => FormContextValue;

package/dist/types/validation/createValidator.d.ts

@@ -1,7 +0,0 @@
-import { CreateValidatorArg, Validator } from "..";
-/**
- * Used to create a validator for a form.
- * It provides built-in handling for unflattening nested objects and
- * extracting the values from FormData.
- */
-export declare function createValidator<T>(validator: CreateValidatorArg<T>): Validator<T>;

package/dist/types/validation/types.d.ts

@@ -1,58 +0,0 @@
-export declare type FieldErrors = Record<string, string>;
-export declare type TouchedFields = Record<string, boolean>;
-export declare type GenericObject = {
-    [key: string]: any;
-};
-export declare type ValidatorError = {
-    subaction?: string;
-    formId?: string;
-    fieldErrors: FieldErrors;
-};
-export declare type ValidationErrorResponseData = {
-    subaction?: string;
-    formId?: string;
-    fieldErrors: FieldErrors;
-    repopulateFields?: unknown;
-};
-export declare type BaseResult = {
-    submittedData: GenericObject;
-    formId?: string;
-};
-export declare type ErrorResult = BaseResult & {
-    error: ValidatorError;
-    data: undefined;
-};
-export declare type SuccessResult<DataType> = BaseResult & {
-    data: DataType;
-    error: undefined;
-};
-/**
- * The result when validating a form.
- */
-export declare type ValidationResult<DataType> = SuccessResult<DataType> | ErrorResult;
-/**
- * The result when validating an individual field in a form.
- */
-export declare type ValidateFieldResult = {
-    error?: string;
-};
-/**
- * A `Validator` can be passed to the `validator` prop of a `ValidatedForm`.
- */
-export declare type Validator<DataType> = {
-    validate: (unvalidatedData: GenericObject) => Promise<ValidationResult<DataType>>;
-    validateField: (unvalidatedData: GenericObject, field: string) => Promise<ValidateFieldResult>;
-};
-export declare type Valid<DataType> = {
-    data: DataType;
-    error: undefined;
-};
-export declare type Invalid = {
-    error: FieldErrors;
-    data: undefined;
-};
-export declare type CreateValidatorArg<DataType> = {
-    validate: (unvalidatedData: GenericObject) => Promise<Valid<DataType> | Invalid>;
-    validateField: (unvalidatedData: GenericObject, field: string) => Promise<ValidateFieldResult>;
-};
-export declare type ValidatorData<T extends Validator<any>> = T extends Validator<infer U> ? U : never;

package/vite.config.ts

@@ -1,7 +0,0 @@
-import { makeConfig } from "vite-config";
-
-export default makeConfig({
-  lib: "remix-validated-form",
-  external: ["react", "@remix-run/react"],
-  dir: __dirname,
-});