@inertiajs/core 2.2.21 → 2.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inertiajs/core",
-  "version": "2.2.21",
+  "version": "2.3.1",
   "license": "MIT",
   "description": "A framework for creating server-driven single page apps.",
   "contributors": [
@@ -45,6 +45,7 @@
   },
   "dependencies": {
     "@types/lodash-es": "^4.17.12",
+    "laravel-precognition": "^1.0.0",
     "axios": "^1.13.2",
     "lodash-es": "^4.17.21",
     "qs": "^6.14.0"

package/types/index.d.ts

@@ -1,5 +1,6 @@
 import { Config } from './config';
 import { Router } from './router';
+export { UseFormUtils } from './useFormUtils';
 export { config } from './config';
 export { getInitialPageFromDOM, getScrollableParent } from './domUtils';
 export { objectToFormData } from './formData';

package/types/scroll.d.ts

@@ -1,6 +1,7 @@
 import { ScrollRegion } from './types';
 export declare class Scroll {
     static save(): void;
+    static getScrollRegions(): ScrollRegion[];
     protected static regions(): NodeListOf<Element>;
     static reset(): void;
     static scrollToAnchor(): void;

package/types/types.d.ts

@@ -1,4 +1,5 @@
 import { AxiosProgressEvent, AxiosResponse } from 'axios';
+import { NamedInputEvent, ValidationConfig, Validator } from 'laravel-precognition';
 import { Response } from './response';
 declare module 'axios' {
     interface AxiosProgressEvent {
@@ -415,6 +416,13 @@ export type UrlMethodPair = {
     url: string;
     method: Method;
 };
+export type UseFormTransformCallback<TForm> = (data: TForm) => object;
+export type UseFormWithPrecognitionArguments = [Method | (() => Method), string | (() => string)] | [UrlMethodPair | (() => UrlMethodPair)];
+type UseFormInertiaArguments<TForm> = [data: TForm | (() => TForm)] | [rememberKey: string, data: TForm | (() => TForm)];
+type UseFormPrecognitionArguments<TForm> = [urlMethodPair: UrlMethodPair | (() => UrlMethodPair), data: TForm | (() => TForm)] | [method: Method | (() => Method), url: string | (() => string), data: TForm | (() => TForm)];
+export type UseFormArguments<TForm> = UseFormInertiaArguments<TForm> | UseFormPrecognitionArguments<TForm>;
+export type UseFormSubmitOptions = Omit<VisitOptions, 'data'>;
+export type UseFormSubmitArguments = [Method, string, UseFormSubmitOptions?] | [UrlMethodPair, UseFormSubmitOptions?] | [UseFormSubmitOptions?];
 export type FormComponentOptions = Pick<VisitOptions, 'preserveScroll' | 'preserveState' | 'preserveUrl' | 'replace' | 'only' | 'except' | 'reset' | 'viewTransition'>;
 export type FormComponentProps = Partial<Pick<Visit, 'headers' | 'queryStringArrayFormat' | 'errorBag' | 'showProgress' | 'invalidateCacheTags'> & Omit<VisitCallbacks, 'onPrefetched' | 'onPrefetching'>> & {
     method?: Method | Uppercase<Method>;
@@ -426,6 +434,9 @@ export type FormComponentProps = Partial<Pick<Visit, 'headers' | 'queryStringArr
     resetOnSuccess?: boolean | string[];
     resetOnError?: boolean | string[];
     setDefaultsOnSuccess?: boolean;
+    validateFiles?: boolean;
+    validationTimeout?: number;
+    withAllErrors?: boolean;
 };
 export type FormComponentMethods = {
     clearErrors: (...fields: string[]) => void;
@@ -437,6 +448,12 @@ export type FormComponentMethods = {
     defaults: () => void;
     getData: () => Record<string, FormDataConvertible>;
     getFormData: () => FormData;
+    valid: (field: string) => boolean;
+    invalid: (field: string) => boolean;
+    validate(field?: string | NamedInputEvent | ValidationConfig, config?: ValidationConfig): void;
+    touch: (...fields: string[]) => void;
+    touched(field?: string): boolean;
+    validator: () => Validator;
 };
 export type FormComponentonSubmitCompleteArguments = Pick<FormComponentMethods, 'reset' | 'defaults'>;
 export type FormComponentState = {
@@ -447,6 +464,7 @@ export type FormComponentState = {
     wasSuccessful: boolean;
     recentlySuccessful: boolean;
     isDirty: boolean;
+    validating: boolean;
 };
 export type FormComponentSlotProps = FormComponentMethods & FormComponentState;
 export type FormComponentRef = FormComponentSlotProps;

package/types/useFormUtils.d.ts

@@ -0,0 +1,47 @@
+import { NamedInputEvent, ValidationConfig } from 'laravel-precognition';
+import { FormDataType, Method, UrlMethodPair, UseFormArguments, UseFormSubmitArguments, UseFormSubmitOptions } from './types';
+export declare class UseFormUtils {
+    /**
+     * Creates a callback that returns a UrlMethodPair.
+     *
+     * createWayfinderCallback(urlMethodPair)
+     * createWayfinderCallback(method, url)
+     * createWayfinderCallback(() => urlMethodPair)
+     * createWayfinderCallback(() => method, () => url)
+     */
+    static createWayfinderCallback(...args: [UrlMethodPair | (() => UrlMethodPair)] | [Method | (() => Method), string | (() => string)]): () => UrlMethodPair;
+    /**
+     * Parses all useForm() arguments into { rememberKey, data, precognitionEndpoint }.
+     *
+     * useForm(data)
+     * useForm(rememberKey, data)
+     * useForm(method, url, data)
+     * useForm(urlMethodPair, data)
+     *
+     */
+    static parseUseFormArguments<TForm extends FormDataType<TForm>>(...args: UseFormArguments<TForm>): {
+        rememberKey: string | null;
+        data: TForm | (() => TForm);
+        precognitionEndpoint: (() => UrlMethodPair) | null;
+    };
+    /**
+     * Parses all submission arguments into { method, url, options }.
+     * It uses the Precognition endpoint if no explicit method/url are provided.
+     *
+     * form.submit(method, url)
+     * form.submit(method, url, options)
+     * form.submit(urlMethodPair)
+     * form.submit(urlMethodPair, options)
+     * form.submit()
+     * form.submit(options)
+     */
+    static parseSubmitArguments(args: UseFormSubmitArguments, precognitionEndpoint: (() => UrlMethodPair) | null): {
+        method: Method;
+        url: string;
+        options: UseFormSubmitOptions;
+    };
+    /**
+     * Merges headers into the Precognition validate() arguments.
+     */
+    static mergeHeadersForValidation(field?: string | NamedInputEvent | ValidationConfig, config?: ValidationConfig, headers?: Record<string, string>): [string | NamedInputEvent | ValidationConfig | undefined, ValidationConfig | undefined];
+}