@inertiajs/react 2.3.16 → 3.0.0-beta.1

package/types/useForm.d.ts

@@ -1,13 +1,11 @@
-import { ErrorValue, FormDataErrors, FormDataKeys, FormDataType, FormDataValues, Method, Progress, UrlMethodPair, UseFormSubmitArguments, UseFormSubmitOptions, UseFormTransformCallback, UseFormWithPrecognitionArguments } from '@inertiajs/core';
-import { NamedInputEvent, PrecognitionPath, ValidationConfig, Validator } from 'laravel-precognition';
-export type SetDataByObject<TForm> = (data: Partial<TForm>) => void;
-export type SetDataByMethod<TForm> = (data: (previousData: TForm) => TForm) => void;
-export type SetDataByKeyValuePair<TForm> = <K extends FormDataKeys<TForm>>(key: K, value: FormDataValues<TForm, K>) => void;
-export type SetDataAction<TForm extends Record<any, any>> = SetDataByObject<TForm> & SetDataByMethod<TForm> & SetDataByKeyValuePair<TForm>;
+import { ErrorValue, FormDataErrors, FormDataKeys, FormDataType, FormDataValues, Method, OptimisticCallback, Progress, UrlMethodPair, UseFormSubmitArguments, UseFormSubmitOptions, UseFormTransformCallback, UseFormWithPrecognitionArguments } from '@inertiajs/core';
+import type { NamedInputEvent, PrecognitionPath, ValidationConfig, Validator } from 'laravel-precognition';
+import { SetDataAction, SetDataByKeyValuePair, SetDataByMethod, SetDataByObject } from './useFormState';
+export { SetDataAction, SetDataByKeyValuePair, SetDataByMethod, SetDataByObject };
 type PrecognitionValidationConfig<TKeys> = ValidationConfig & {
     only?: TKeys[] | Iterable<TKeys> | ArrayLike<TKeys>;
 };
-export interface InertiaFormProps<TForm extends object> {
+export interface InertiaFormProps<TForm extends Record<string, any>> {
     data: TForm;
     isDirty: boolean;
     errors: FormDataErrors<TForm>;
@@ -32,15 +30,16 @@ export interface InertiaFormProps<TForm extends object> {
     };
     submit: (...args: UseFormSubmitArguments) => void;
     get: (url: string, options?: UseFormSubmitOptions) => void;
-    patch: (url: string, options?: UseFormSubmitOptions) => void;
     post: (url: string, options?: UseFormSubmitOptions) => void;
     put: (url: string, options?: UseFormSubmitOptions) => void;
+    patch: (url: string, options?: UseFormSubmitOptions) => void;
     delete: (url: string, options?: UseFormSubmitOptions) => void;
     cancel: () => void;
     dontRemember: <K extends FormDataKeys<TForm>>(...fields: K[]) => InertiaFormProps<TForm>;
+    optimistic: <TProps>(callback: OptimisticCallback<TProps>) => InertiaFormProps<TForm>;
     withPrecognition: (...args: UseFormWithPrecognitionArguments) => InertiaPrecognitiveFormProps<TForm>;
 }
-export interface InertiaFormValidationProps<TForm extends object> {
+export interface InertiaFormValidationProps<TForm extends Record<string, any>> {
     invalid: <K extends FormDataKeys<TForm>>(field: K) => boolean;
     setValidationTimeout: (duration: number) => InertiaPrecognitiveFormProps<TForm>;
     touch: <K extends FormDataKeys<TForm>>(field: K | NamedInputEvent | Array<K>, ...fields: K[]) => InertiaPrecognitiveFormProps<TForm>;
@@ -55,11 +54,10 @@ export interface InertiaFormValidationProps<TForm extends object> {
     setErrors: (errors: FormDataErrors<TForm>) => InertiaPrecognitiveFormProps<TForm>;
     forgetError: <K extends FormDataKeys<TForm> | NamedInputEvent>(field: K) => InertiaPrecognitiveFormProps<TForm>;
 }
-export type InertiaForm<TForm extends object> = InertiaFormProps<TForm>;
-export type InertiaPrecognitiveFormProps<TForm extends object> = InertiaFormProps<TForm> & InertiaFormValidationProps<TForm>;
+export type InertiaForm<TForm extends Record<string, any>> = InertiaFormProps<TForm>;
+export type InertiaPrecognitiveFormProps<TForm extends Record<string, any>> = InertiaFormProps<TForm> & InertiaFormValidationProps<TForm>;
 export default function useForm<TForm extends FormDataType<TForm>>(method: Method | (() => Method), url: string | (() => string), data: TForm | (() => TForm)): InertiaPrecognitiveFormProps<TForm>;
 export default function useForm<TForm extends FormDataType<TForm>>(urlMethodPair: UrlMethodPair | (() => UrlMethodPair), data: TForm | (() => TForm)): InertiaPrecognitiveFormProps<TForm>;
 export default function useForm<TForm extends FormDataType<TForm>>(rememberKey: string, data: TForm | (() => TForm)): InertiaFormProps<TForm>;
 export default function useForm<TForm extends FormDataType<TForm>>(data: TForm | (() => TForm)): InertiaFormProps<TForm>;
 export default function useForm<TForm extends FormDataType<TForm>>(): InertiaFormProps<TForm>;
-export {};

package/types/useFormState.d.ts

@@ -0,0 +1,79 @@
+import { ErrorValue, FormDataErrors, FormDataKeys, FormDataValues, Progress, UrlMethodPair, UseFormTransformCallback, UseFormWithPrecognitionArguments } from '@inertiajs/core';
+import { NamedInputEvent, ValidationConfig, Validator } from 'laravel-precognition';
+export type SetDataByObject<TForm> = (data: Partial<TForm>) => void;
+export type SetDataByMethod<TForm> = (data: (previousData: TForm) => TForm) => void;
+export type SetDataByKeyValuePair<TForm> = <K extends FormDataKeys<TForm>>(key: K, value: FormDataValues<TForm, K>) => void;
+export type SetDataAction<TForm extends Record<any, any>> = SetDataByObject<TForm> & SetDataByMethod<TForm> & SetDataByKeyValuePair<TForm>;
+type PrecognitionValidationConfig<TKeys> = ValidationConfig & {
+    only?: TKeys[] | Iterable<TKeys> | ArrayLike<TKeys>;
+};
+export interface FormStateProps<TForm extends object> {
+    data: TForm;
+    isDirty: boolean;
+    errors: FormDataErrors<TForm>;
+    hasErrors: boolean;
+    processing: boolean;
+    progress: Progress | null;
+    wasSuccessful: boolean;
+    recentlySuccessful: boolean;
+    setData: SetDataAction<TForm>;
+    transform: (callback: UseFormTransformCallback<TForm>) => void;
+    setDefaults: {
+        (): void;
+        <T extends FormDataKeys<TForm>>(field: T, value: FormDataValues<TForm, T>): void;
+        (fields: Partial<TForm>): void;
+    };
+    reset: <K extends FormDataKeys<TForm>>(...fields: K[]) => void;
+    clearErrors: <K extends FormDataKeys<TForm>>(...fields: K[]) => void;
+    resetAndClearErrors: <K extends FormDataKeys<TForm>>(...fields: K[]) => void;
+    setError: {
+        <K extends FormDataKeys<TForm>>(field: K, value: ErrorValue): void;
+        (errors: FormDataErrors<TForm>): void;
+    };
+    withPrecognition: (...args: UseFormWithPrecognitionArguments) => FormStateWithPrecognition<TForm>;
+}
+export interface FormStateValidationProps<TForm extends object> {
+    invalid: <K extends FormDataKeys<TForm>>(field: K) => boolean;
+    setValidationTimeout: (duration: number) => FormStateWithPrecognition<TForm>;
+    touch: <K extends FormDataKeys<TForm>>(field: K | NamedInputEvent | Array<K>, ...fields: K[]) => FormStateWithPrecognition<TForm>;
+    touched: <K extends FormDataKeys<TForm>>(field?: K) => boolean;
+    valid: <K extends FormDataKeys<TForm>>(field: K) => boolean;
+    validate: <K extends FormDataKeys<TForm>>(field?: K | NamedInputEvent | PrecognitionValidationConfig<K>, config?: PrecognitionValidationConfig<K>) => FormStateWithPrecognition<TForm>;
+    validateFiles: () => FormStateWithPrecognition<TForm>;
+    validating: boolean;
+    validator: () => Validator;
+    withAllErrors: () => FormStateWithPrecognition<TForm>;
+    withoutFileValidation: () => FormStateWithPrecognition<TForm>;
+    setErrors: (errors: FormDataErrors<TForm>) => FormStateWithPrecognition<TForm>;
+    forgetError: <K extends FormDataKeys<TForm> | NamedInputEvent>(field: K) => FormStateWithPrecognition<TForm>;
+}
+export type FormState<TForm extends object> = FormStateProps<TForm>;
+export type FormStateWithPrecognition<TForm extends object> = FormStateProps<TForm> & FormStateValidationProps<TForm>;
+export interface UseFormStateOptions<TForm extends object> {
+    data: TForm | (() => TForm);
+    precognitionEndpoint?: (() => UrlMethodPair) | null;
+    useDataState?: () => [TForm, React.Dispatch<React.SetStateAction<TForm>>];
+    useErrorsState?: () => [FormDataErrors<TForm>, React.Dispatch<React.SetStateAction<FormDataErrors<TForm>>>];
+}
+export interface UseFormStateReturn<TForm extends object> {
+    form: FormState<TForm>;
+    setDefaultsState: React.Dispatch<React.SetStateAction<TForm>>;
+    transformRef: React.MutableRefObject<UseFormTransformCallback<TForm>>;
+    precognitionEndpointRef: React.MutableRefObject<(() => UrlMethodPair) | null>;
+    dataRef: React.MutableRefObject<TForm>;
+    isMounted: React.MutableRefObject<boolean>;
+    setProcessing: React.Dispatch<React.SetStateAction<boolean>>;
+    setProgress: React.Dispatch<React.SetStateAction<Progress | null>>;
+    markAsSuccessful: () => void;
+    clearErrors: (...fields: string[]) => void;
+    setError: (fieldOrFields: FormDataKeys<TForm> | FormDataErrors<TForm>, maybeValue?: ErrorValue) => void;
+    defaultsCalledInOnSuccessRef: React.MutableRefObject<boolean>;
+    resetBeforeSubmit: () => void;
+    finishProcessing: () => void;
+    withAllErrors: {
+        enabled: () => boolean;
+        enable: () => void;
+    };
+}
+export default function useFormState<TForm extends object>(options: UseFormStateOptions<TForm>): UseFormStateReturn<TForm>;
+export {};

package/types/useHttp.d.ts

@@ -0,0 +1,65 @@
+import { ErrorValue, FormDataErrors, FormDataKeys, FormDataType, FormDataValues, Method, Progress, UrlMethodPair, UseFormTransformCallback, UseFormWithPrecognitionArguments, UseHttpSubmitArguments, UseHttpSubmitOptions } from '@inertiajs/core';
+import { NamedInputEvent, ValidationConfig, Validator } from 'laravel-precognition';
+import { SetDataAction } from './useFormState';
+type PrecognitionValidationConfig<TKeys> = ValidationConfig & {
+    only?: TKeys[] | Iterable<TKeys> | ArrayLike<TKeys>;
+};
+export interface UseHttpProps<TForm extends object, TResponse = unknown> {
+    data: TForm;
+    isDirty: boolean;
+    errors: FormDataErrors<TForm>;
+    hasErrors: boolean;
+    processing: boolean;
+    progress: Progress | null;
+    wasSuccessful: boolean;
+    recentlySuccessful: boolean;
+    response: TResponse | null;
+    setData: SetDataAction<TForm>;
+    transform: (callback: UseFormTransformCallback<TForm>) => void;
+    setDefaults: {
+        (): void;
+        <T extends FormDataKeys<TForm>>(field: T, value: FormDataValues<TForm, T>): void;
+        (fields: Partial<TForm>): void;
+    };
+    reset: <K extends FormDataKeys<TForm>>(...fields: K[]) => void;
+    clearErrors: <K extends FormDataKeys<TForm>>(...fields: K[]) => void;
+    resetAndClearErrors: <K extends FormDataKeys<TForm>>(...fields: K[]) => void;
+    setError: {
+        <K extends FormDataKeys<TForm>>(field: K, value: ErrorValue): void;
+        (errors: FormDataErrors<TForm>): void;
+    };
+    submit: (...args: UseHttpSubmitArguments<TResponse, TForm>) => Promise<TResponse>;
+    get: (url: string, options?: UseHttpSubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+    post: (url: string, options?: UseHttpSubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+    put: (url: string, options?: UseHttpSubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+    patch: (url: string, options?: UseHttpSubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+    delete: (url: string, options?: UseHttpSubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+    cancel: () => void;
+    dontRemember: <K extends FormDataKeys<TForm>>(...fields: K[]) => UseHttpProps<TForm, TResponse>;
+    optimistic: (callback: (currentData: TForm) => Partial<TForm>) => UseHttpProps<TForm, TResponse>;
+    withAllErrors: () => UseHttpProps<TForm, TResponse>;
+    withPrecognition: (...args: UseFormWithPrecognitionArguments) => UseHttpPrecognitiveProps<TForm, TResponse>;
+}
+export interface UseHttpValidationProps<TForm extends object, TResponse = unknown> {
+    invalid: <K extends FormDataKeys<TForm>>(field: K) => boolean;
+    setValidationTimeout: (duration: number) => UseHttpPrecognitiveProps<TForm, TResponse>;
+    touch: <K extends FormDataKeys<TForm>>(field: K | NamedInputEvent | Array<K>, ...fields: K[]) => UseHttpPrecognitiveProps<TForm, TResponse>;
+    touched: <K extends FormDataKeys<TForm>>(field?: K) => boolean;
+    valid: <K extends FormDataKeys<TForm>>(field: K) => boolean;
+    validate: <K extends FormDataKeys<TForm>>(field?: K | NamedInputEvent | PrecognitionValidationConfig<K>, config?: PrecognitionValidationConfig<K>) => UseHttpPrecognitiveProps<TForm, TResponse>;
+    validateFiles: () => UseHttpPrecognitiveProps<TForm, TResponse>;
+    validating: boolean;
+    validator: () => Validator;
+    withAllErrors: () => UseHttpPrecognitiveProps<TForm, TResponse>;
+    withoutFileValidation: () => UseHttpPrecognitiveProps<TForm, TResponse>;
+    setErrors: (errors: FormDataErrors<TForm>) => UseHttpPrecognitiveProps<TForm, TResponse>;
+    forgetError: <K extends FormDataKeys<TForm> | NamedInputEvent>(field: K) => UseHttpPrecognitiveProps<TForm, TResponse>;
+}
+export type UseHttp<TForm extends object, TResponse = unknown> = UseHttpProps<TForm, TResponse>;
+export type UseHttpPrecognitiveProps<TForm extends object, TResponse = unknown> = UseHttpProps<TForm, TResponse> & UseHttpValidationProps<TForm, TResponse>;
+export default function useHttp<TForm extends FormDataType<TForm>, TResponse = unknown>(method: Method | (() => Method), url: string | (() => string), data: TForm | (() => TForm)): UseHttpPrecognitiveProps<TForm, TResponse>;
+export default function useHttp<TForm extends FormDataType<TForm>, TResponse = unknown>(urlMethodPair: UrlMethodPair | (() => UrlMethodPair), data: TForm | (() => TForm)): UseHttpPrecognitiveProps<TForm, TResponse>;
+export default function useHttp<TForm extends FormDataType<TForm>, TResponse = unknown>(rememberKey: string, data: TForm | (() => TForm)): UseHttp<TForm, TResponse>;
+export default function useHttp<TForm extends FormDataType<TForm>, TResponse = unknown>(data: TForm | (() => TForm)): UseHttp<TForm, TResponse>;
+export default function useHttp<TForm extends FormDataType<TForm>, TResponse = unknown>(): UseHttp<TForm, TResponse>;
+export {};