@inertiajs/vue3 2.2.21 → 2.3.1

package/types/useForm.d.ts

@@ -1,7 +1,5 @@
-import { ErrorValue, FormDataErrors, FormDataKeys, FormDataType, FormDataValues, Method, Progress, UrlMethodPair, VisitOptions } from '@inertiajs/core';
-type FormOptions = Omit<VisitOptions, 'data'>;
-type SubmitArgs = [Method, string, FormOptions?] | [UrlMethodPair, FormOptions?];
-type TransformCallback<TForm> = (data: TForm) => object;
+import { ErrorValue, FormDataErrors, FormDataKeys, FormDataType, FormDataValues, Method, Progress, UrlMethodPair, UseFormSubmitArguments, UseFormSubmitOptions, UseFormTransformCallback, UseFormWithPrecognitionArguments } from '@inertiajs/core';
+import { NamedInputEvent, ValidationConfig, Validator } from 'laravel-precognition';
 export interface InertiaFormProps<TForm extends object> {
     isDirty: boolean;
     errors: FormDataErrors<TForm>;
@@ -11,7 +9,7 @@ export interface InertiaFormProps<TForm extends object> {
     wasSuccessful: boolean;
     recentlySuccessful: boolean;
     data(): TForm;
-    transform(callback: TransformCallback<TForm>): this;
+    transform(callback: UseFormTransformCallback<TForm>): this;
     defaults(): this;
     defaults<T extends FormDataKeys<TForm>>(field: T, value: FormDataValues<TForm, T>): this;
     defaults(fields: Partial<TForm>): this;
@@ -20,15 +18,41 @@ export interface InertiaFormProps<TForm extends object> {
     resetAndClearErrors<K extends FormDataKeys<TForm>>(...fields: K[]): this;
     setError<K extends FormDataKeys<TForm>>(field: K, value: ErrorValue): this;
     setError(errors: FormDataErrors<TForm>): this;
-    submit: (...args: SubmitArgs) => void;
-    get(url: string, options?: FormOptions): void;
-    post(url: string, options?: FormOptions): void;
-    put(url: string, options?: FormOptions): void;
-    patch(url: string, options?: FormOptions): void;
-    delete(url: string, options?: FormOptions): void;
+    submit: (...args: UseFormSubmitArguments) => void;
+    get(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;
+    withPrecognition(...args: UseFormWithPrecognitionArguments): InertiaPrecognitiveForm<TForm>;
+}
+type PrecognitionValidationConfig<TKeys> = ValidationConfig & {
+    only?: TKeys[] | Iterable<TKeys> | ArrayLike<TKeys>;
+};
+export interface InertiaFormValidationProps<TForm extends object> {
+    invalid<K extends FormDataKeys<TForm>>(field: K): boolean;
+    setValidationTimeout(duration: number): this;
+    touch<K extends FormDataKeys<TForm>>(field: K | NamedInputEvent | Array<K>, ...fields: K[]): this;
+    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>): this;
+    validateFiles(): this;
+    validating: boolean;
+    validator: () => Validator;
+    withAllErrors(): this;
+    withoutFileValidation(): this;
+    setErrors(errors: FormDataErrors<TForm> | Record<string, string | string[]>): this;
+    forgetError<K extends FormDataKeys<TForm> | NamedInputEvent>(field: K): this;
+}
+interface InternalPrecognitionState {
+    __touched: string[];
+    __valid: string[];
 }
 export type InertiaForm<TForm extends object> = TForm & InertiaFormProps<TForm>;
-export default function useForm<TForm extends FormDataType<TForm>>(data: TForm | (() => TForm)): InertiaForm<TForm>;
+export type InertiaPrecognitiveForm<TForm extends object> = InertiaForm<TForm> & InertiaFormValidationProps<TForm> & InternalPrecognitionState;
+export default function useForm<TForm extends FormDataType<TForm>>(method: Method | (() => Method), url: string | (() => string), data: TForm | (() => TForm)): InertiaPrecognitiveForm<TForm>;
+export default function useForm<TForm extends FormDataType<TForm>>(urlMethodPair: UrlMethodPair | (() => UrlMethodPair), data: TForm | (() => TForm)): InertiaPrecognitiveForm<TForm>;
 export default function useForm<TForm extends FormDataType<TForm>>(rememberKey: string, data: TForm | (() => TForm)): InertiaForm<TForm>;
+export default function useForm<TForm extends FormDataType<TForm>>(data: TForm | (() => TForm)): InertiaForm<TForm>;
 export {};

package/types/whenVisible.d.ts

@@ -36,7 +36,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     loaded: boolean;
     fetching: boolean;
     observer: IntersectionObserver | null;
-}, {}, {
+}, {
+    keys(): string[];
+}, {
     registerObserver(): void;
     getReloadParams(): Partial<ReloadOptions>;
 }, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{