solid-hook-form 1.6.2 → 1.6.3

package/dist/main.d.ts

@@ -1,4 +1,74 @@
-export { useForm } from './use_form';
-export { FormProvider } from './form_provider';
-export { useFormContext } from './use_form_context';
-export type { FieldError, FieldErrors } from './types/errors';
+import { Path, LiteralUnion, FieldPath, FieldPathValue, Resolver } from 'react-hook-form';
+import * as solid_js from 'solid-js';
+import { Accessor, ParentProps } from 'solid-js';
+
+type Message = string;
+type FieldError = {
+    type: LiteralUnion<keyof Rules, string>;
+    ref?: HTMLElement;
+    message?: Message;
+};
+type FieldErrors<F extends FormValues = FormValues> = Partial<Record<Path<F>, FieldError>>;
+
+type ValidateResult = Message | boolean | undefined;
+type Validate<V, F> = (value: V, formValues: F) => ValidateResult | Promise<ValidateResult>;
+type ValidationValue = boolean | number | string | RegExp;
+type ValidationRule<V extends ValidationValue = ValidationValue> = V | ValidationValueMessage<V>;
+type ValidationValueMessage<V extends ValidationValue = ValidationValue> = {
+    value: V;
+    message: Message;
+};
+type Rules<F extends FormValues = FormValues, N extends FieldPath<F> = FieldPath<F>> = {
+    required?: Message | ValidationRule<boolean>;
+    min?: ValidationRule<number | string>;
+    max?: ValidationRule<number | string>;
+    maxLength?: ValidationRule<number>;
+    minLength?: ValidationRule<number>;
+    pattern?: ValidationRule<RegExp>;
+    valueAsNumber?: boolean;
+    validate?: Validate<FieldPathValue<F, N>, F>;
+};
+
+type FormValues = Record<string, any>;
+type Ref = HTMLElement | null;
+type RegisterReturn<F extends FormValues> = {
+    name: Path<F>;
+    ref(ref: Ref): void;
+    onInput(event: Event): void;
+    onChange(event: Event): void;
+};
+type Register<T extends FormValues> = (name: Path<T>, options?: Rules<T, Path<T>>) => RegisterReturn<T>;
+type GetValues<F extends FormValues> = {
+    (): F;
+    <N extends FieldPath<F>>(name: N): FieldPathValue<F, N>;
+};
+type SetValue<F extends FormValues> = (name: Path<F>, value: FieldPathValue<F, Path<F>>) => void;
+type SubmitCallback<F extends FormValues> = (values: F) => void;
+type OnSubmit<F extends FormValues> = (submit: SubmitCallback<F>) => (event: SubmitEvent) => void;
+type Reset<F extends FormValues> = (newDefaultValues?: Partial<F>) => void;
+type UseFormReturn<F extends FormValues = FormValues> = {
+    values: Accessor<F>;
+    errors: Accessor<FieldErrors<F>>;
+    isValid: Accessor<boolean>;
+    register: Register<F>;
+    getValues: GetValues<F>;
+    setValue: SetValue<F>;
+    onSubmit: OnSubmit<F>;
+    reset: Reset<F>;
+};
+
+type UseFormArg<F extends FormValues> = {
+    defaultValues: F;
+    mode?: "onChange" | "onSubmit";
+    resolver?: Resolver<F>;
+};
+declare const useForm: <F extends FormValues>(arg?: UseFormArg<F>) => UseFormReturn<F>;
+
+type FormProviderProps<T extends FormValues> = ParentProps & {
+    form: UseFormReturn<T>;
+};
+declare const FormProvider: <T extends FormValues>(props: FormProviderProps<T>) => solid_js.JSX.Element;
+
+declare const useFormContext: <T extends FormValues>() => UseFormReturn<T>;
+
+export { type FieldError, type FieldErrors, FormProvider, useForm, useFormContext };