remix-validated-form 5.1.4 → 5.1.6

package/browser/userFacingFormContext.d.ts

@@ -1,85 +0,0 @@
-import { FieldErrors, TouchedFields, ValidationResult } from "./validation/types";
-export 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/browser/userFacingFormContext.js

@@ -1,41 +0,0 @@
-import { useCallback, useMemo } from "react";
-import { useInternalFormContext, useRegisterReceiveFocus, } from "./internal/hooks";
-import { useFormHelpers, useFormState } from "./unreleased/formStateHooks";
-/**
- * Provides access to some of the internal state of the form.
- */
-export const useFormContext = (formId) => {
-    // Try to access context so we get our error specific to this hook if it's not there
-    const context = useInternalFormContext(formId, "useFormContext");
-    const state = useFormState(formId);
-    const { clearError: internalClearError, setTouched, validateField, clearAllErrors, validate, reset, submit, getValues, } = useFormHelpers(formId);
-    const registerReceiveFocus = useRegisterReceiveFocus(context.formId);
-    const clearError = useCallback((...names) => {
-        names.forEach((name) => {
-            internalClearError(name);
-        });
-    }, [internalClearError]);
-    return useMemo(() => ({
-        ...state,
-        setFieldTouched: setTouched,
-        validateField,
-        clearError,
-        registerReceiveFocus,
-        clearAllErrors,
-        validate,
-        reset,
-        submit,
-        getValues,
-    }), [
-        clearAllErrors,
-        clearError,
-        registerReceiveFocus,
-        reset,
-        setTouched,
-        state,
-        submit,
-        validate,
-        validateField,
-        getValues,
-    ]);
-};

package/browser/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/browser/validation/createValidator.js

@@ -1,43 +0,0 @@
-import * as R from "remeda";
-import { FORM_ID_FIELD } from "../internal/constants";
-import { objectFromPathEntries } from "../internal/flatten";
-const preprocessFormData = (data) => {
-    // A slightly janky way of determining if the data is a FormData object
-    // since node doesn't really have FormData
-    if ("entries" in data && typeof data.entries === "function")
-        return objectFromPathEntries([...data.entries()]);
-    return objectFromPathEntries(Object.entries(data));
-};
-const omitInternalFields = (data) => R.omit(data, [FORM_ID_FIELD]);
-/**
- * Used to create a validator for a form.
- * It provides built-in handling for unflattening nested objects and
- * extracting the values from FormData.
- */
-export function createValidator(validator) {
-    return {
-        validate: async (value) => {
-            const data = preprocessFormData(value);
-            const result = await validator.validate(omitInternalFields(data));
-            if (result.error) {
-                return {
-                    data: undefined,
-                    error: {
-                        fieldErrors: result.error,
-                        subaction: data.subaction,
-                        formId: data[FORM_ID_FIELD],
-                    },
-                    submittedData: data,
-                    formId: data[FORM_ID_FIELD],
-                };
-            }
-            return {
-                data: result.data,
-                error: undefined,
-                submittedData: data,
-                formId: data[FORM_ID_FIELD],
-            };
-        },
-        validateField: (data, field) => validator.validateField(preprocessFormData(data), field),
-    };
-}

package/browser/validation/types.d.ts

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

package/browser/validation/types.js

@@ -1 +0,0 @@
-export {};