@inertiajs/core 2.2.7 → 2.2.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inertiajs/core",
-  "version": "2.2.7",
+  "version": "2.2.9",
   "license": "MIT",
   "description": "A framework for creating server-driven single page apps.",
   "contributors": [
@@ -51,13 +51,13 @@
   },
   "devDependencies": {
     "@types/deepmerge": "^2.2.3",
-    "@types/node": "^18.19.127",
+    "@types/node": "^18.19.130",
     "@types/nprogress": "^0.2.3",
     "@types/qs": "^6.14.0",
-    "es-check": "^9.3.1",
-    "esbuild": "^0.25.10",
+    "es-check": "^9.4.4",
+    "esbuild": "^0.25.11",
     "esbuild-node-externals": "^1.18.0",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.3"
   },
   "scripts": {
     "build": "pnpm clean && ./build.js && tsc",

package/types/debug.d.ts

@@ -1 +1 @@
-export declare const stackTrace: (autolog?: boolean) => any;
+export declare const stackTrace: (autolog?: boolean) => string | undefined;

package/types/head.d.ts

@@ -1,7 +1,2 @@
-export default function createHeadManager(isServer: boolean, titleCallback: (title: string) => string, onUpdate: (elements: string[]) => void): {
-    forceUpdate: () => void;
-    createProvider: () => {
-        update: (elements: string[]) => void;
-        disconnect: () => void;
-    };
-};
+import { HeadManager, HeadManagerOnUpdateCallback, HeadManagerTitleCallback } from '.';
+export default function createHeadManager(isServer: boolean, titleCallback: HeadManagerTitleCallback, onUpdate: HeadManagerOnUpdateCallback): HeadManager;

package/types/navigationEvents.d.ts

@@ -1,12 +1,15 @@
+type MouseNavigationEvent = Pick<MouseEvent, 'altKey' | 'ctrlKey' | 'shiftKey' | 'metaKey' | 'button' | 'currentTarget' | 'defaultPrevented' | 'target'>;
+type KeyboardNavigationEvent = Pick<KeyboardEvent, 'currentTarget' | 'defaultPrevented' | 'key' | 'target'>;
 /**
  * Determine if this mouse event should be intercepted for navigation purposes.
  * Links with modifier keys or non-left clicks should not be intercepted.
  * Content editable elements and prevented events are ignored.
  */
-export declare function shouldIntercept(event: Pick<MouseEvent, 'altKey' | 'ctrlKey' | 'defaultPrevented' | 'target' | 'currentTarget' | 'metaKey' | 'shiftKey' | 'button'>): boolean;
+export declare function shouldIntercept(event: MouseNavigationEvent): boolean;
 /**
  * Determine if this keyboard event should trigger a navigation request.
  * Enter triggers navigation for both links and buttons currently.
  * Space only triggers navigation for buttons specifically.
  */
-export declare function shouldNavigate(event: Pick<KeyboardEvent, 'key' | 'currentTarget'>): boolean;
+export declare function shouldNavigate(event: KeyboardNavigationEvent): boolean;
+export {};

package/types/page.d.ts

@@ -1,7 +1,7 @@
-import { Component, Page, PageEvent, PageHandler, PageResolver, PreserveStateOption, RouterInitParams, VisitOptions } from './types';
+import { Component, Page, PageEvent, PageHandler, PageResolver, RouterInitParams } from './types';
 declare class CurrentPage {
     protected page: Page;
-    protected swapComponent: PageHandler;
+    protected swapComponent: PageHandler<any>;
     protected resolveComponent: PageResolver;
     protected componentId: {};
     protected listeners: {
@@ -11,10 +11,14 @@ declare class CurrentPage {
     protected isFirstPageLoad: boolean;
     protected cleared: boolean;
     protected pendingDeferredProps: Pick<Page, 'deferredProps' | 'url' | 'component'> | null;
-    init({ initialPage, swapComponent, resolveComponent }: RouterInitParams): this;
-    set(page: Page, { replace, preserveScroll, preserveState, }?: Partial<Pick<VisitOptions, 'replace' | 'preserveScroll' | 'preserveState'>>): Promise<void>;
+    init<ComponentType = Component>({ initialPage, swapComponent, resolveComponent, }: RouterInitParams<ComponentType>): this;
+    set(page: Page, { replace, preserveScroll, preserveState, }?: {
+        replace?: boolean;
+        preserveScroll?: boolean;
+        preserveState?: boolean;
+    }): Promise<void>;
     setQuietly(page: Page, { preserveState, }?: {
-        preserveState?: PreserveStateOption;
+        preserveState?: boolean;
     }): Promise<unknown>;
     clear(): void;
     isCleared(): boolean;
@@ -25,7 +29,7 @@ declare class CurrentPage {
     swap({ component, page, preserveState, }: {
         component: Component;
         page: Page;
-        preserveState: PreserveStateOption;
+        preserveState: boolean;
     }): Promise<unknown>;
     resolve(component: string): Promise<Component>;
     isTheSame(page: Page): boolean;

package/types/requestParams.d.ts

@@ -31,5 +31,5 @@ export declare class RequestParams {
     merge(toMerge: Partial<ActiveVisit>): void;
     protected wrapCallback(params: ActiveVisit, name: keyof VisitCallbacks): (...args: any[]) => void;
     protected recordCallback(name: keyof VisitCallbacks, args: any[]): void;
-    protected resolvePreserveOption(value: PreserveStateOption, page: Page): boolean;
+    static resolvePreserveOption(value: PreserveStateOption, page: Page): boolean;
 }

package/types/router.d.ts

@@ -3,7 +3,7 @@ import { ActiveVisit, ClientSideVisitOptions, Component, GlobalEvent, GlobalEven
 export declare class Router {
     protected syncRequestStream: RequestStream;
     protected asyncRequestStream: RequestStream;
-    init({ initialPage, resolveComponent, swapComponent }: RouterInitParams): void;
+    init<ComponentType = Component>({ initialPage, resolveComponent, swapComponent, }: RouterInitParams<ComponentType>): void;
     get<T extends RequestPayload = RequestPayload>(url: URL | string | UrlMethodPair, data?: T, options?: VisitHelperOptions<T>): void;
     post<T extends RequestPayload = RequestPayload>(url: URL | string | UrlMethodPair, data?: T, options?: VisitHelperOptions<T>): void;
     put<T extends RequestPayload = RequestPayload>(url: URL | string | UrlMethodPair, data?: T, options?: VisitHelperOptions<T>): void;

package/types/scroll.d.ts

@@ -4,6 +4,7 @@ export declare class Scroll {
     protected static regions(): NodeListOf<Element>;
     static reset(): void;
     static restore(scrollRegions: ScrollRegion[]): void;
+    static restoreScrollRegions(scrollRegions: ScrollRegion[]): void;
     static restoreDocument(): void;
     static onScroll(event: Event): void;
     static onWindowScroll(): void;

package/types/types.d.ts

@@ -7,6 +7,7 @@ declare module 'axios' {
 }
 export type DefaultInertiaConfig = {
     errorValueType: string;
+    sharedPageProps: PageProps;
 };
 /**
  * Designed to allow overriding of some core types using TypeScript
@@ -18,6 +19,10 @@ export type DefaultInertiaConfig = {
  * declare module '@inertiajs/core' {
  *   export interface InertiaConfig {
  *     errorValueType: string[]
+ *     sharedPageProps: {
+ *       auth: { user: User | null }
+ *       flash: { success?: string; error?: string }
+ *     }
  *   }
  * }
  * ```
@@ -26,6 +31,7 @@ export interface InertiaConfig {
 }
 export type InertiaConfigFor<Key extends keyof DefaultInertiaConfig> = Key extends keyof InertiaConfig ? InertiaConfig[Key] : DefaultInertiaConfig[Key];
 export type ErrorValue = InertiaConfigFor<'errorValueType'>;
+export type SharedPageProps = InertiaConfigFor<'sharedPageProps'>;
 export type Errors = Record<string, ErrorValue>;
 export type ErrorBag = Record<string, Errors>;
 export type FormDataConvertibleValue = Blob | FormDataEntryValue | Date | boolean | number | null | undefined;
@@ -97,16 +103,20 @@ export interface ClientSideVisitOptions<TProps = Page['props']> {
     onSuccess?: (page: Page) => void;
 }
 export type PageResolver = (name: string) => Component;
-export type PageHandler = ({ component, page, preserveState, }: {
-    component: Component;
+export type PageHandler<ComponentType = Component> = ({ component, page, preserveState, }: {
+    component: ComponentType;
     page: Page;
-    preserveState: PreserveStateOption;
+    preserveState: boolean;
 }) => Promise<unknown>;
 export type PreserveStateOption = boolean | 'errors' | ((page: Page) => boolean);
 export type Progress = AxiosProgressEvent;
 export type LocationVisit = {
     preserveScroll: boolean;
 };
+export type CancelToken = {
+    cancel: VoidFunction;
+};
+export type CancelTokenCallback = (cancelToken: CancelToken) => void;
 export type Visit<T extends RequestPayload = RequestPayload> = {
     method: Method;
     data: T;
@@ -230,11 +240,7 @@ export type GlobalEventTrigger<TEventName extends GlobalEventNames<T>, T extends
 export type GlobalEventCallback<TEventName extends GlobalEventNames<T>, T extends RequestPayload = RequestPayload> = (...params: GlobalEventParameters<TEventName, T>) => GlobalEventResult<TEventName, T>;
 export type InternalEvent = 'missingHistoryItem' | 'loadDeferredProps';
 export type VisitCallbacks<T extends RequestPayload = RequestPayload> = {
-    onCancelToken: {
-        ({ cancel }: {
-            cancel: VoidFunction;
-        }): void;
-    };
+    onCancelToken: CancelTokenCallback;
     onBefore: GlobalEventCallback<'before', T>;
     onBeforeUpdate: GlobalEventCallback<'beforeUpdate', T>;
     onStart: GlobalEventCallback<'start', T>;
@@ -253,10 +259,10 @@ export type PollOptions = {
     autoStart?: boolean;
 };
 export type VisitHelperOptions<T extends RequestPayload = RequestPayload> = Omit<VisitOptions<T>, 'method' | 'data'>;
-export type RouterInitParams = {
+export type RouterInitParams<ComponentType = Component> = {
     initialPage: Page;
     resolveComponent: PageResolver;
-    swapComponent: PageHandler;
+    swapComponent: PageHandler<ComponentType>;
 };
 export type PendingVisitOptions = {
     url: URL;
@@ -272,19 +278,51 @@ export type InternalActiveVisit = ActiveVisit & {
 };
 export type VisitId = unknown;
 export type Component = unknown;
-export type InertiaAppResponse = Promise<{
+interface CreateInertiaAppOptions<TComponentResolver, TSetupOptions, TSetupReturn> {
+    resolve: TComponentResolver;
+    setup: (options: TSetupOptions) => TSetupReturn;
+    title?: HeadManagerTitleCallback;
+}
+export interface CreateInertiaAppOptionsForCSR<SharedProps extends PageProps, TComponentResolver, TSetupOptions, TSetupReturn> extends CreateInertiaAppOptions<TComponentResolver, TSetupOptions, TSetupReturn> {
+    id?: string;
+    page?: Page<SharedProps>;
+    progress?: false | {
+        delay?: number;
+        color?: string;
+        includeCSS?: boolean;
+        showSpinner?: boolean;
+    };
+    render?: undefined;
+}
+export interface CreateInertiaAppOptionsForSSR<SharedProps extends PageProps, TComponentResolver, TSetupOptions, TSetupReturn> extends CreateInertiaAppOptions<TComponentResolver, TSetupOptions, TSetupReturn> {
+    id?: undefined;
+    page: Page<SharedProps>;
+    progress?: undefined;
+    render: unknown;
+}
+export type InertiaAppSSRResponse = {
     head: string[];
     body: string;
-} | void>;
+};
+export type InertiaAppResponse = Promise<InertiaAppSSRResponse | void>;
+export type HeadManagerTitleCallback = (title: string) => string;
+export type HeadManagerOnUpdateCallback = (elements: string[]) => void;
+export type HeadManager = {
+    forceUpdate: () => void;
+    createProvider: () => {
+        reconnect: () => void;
+        update: HeadManagerOnUpdateCallback;
+        disconnect: () => void;
+    };
+};
 export type LinkPrefetchOption = 'mount' | 'hover' | 'click';
 export type CacheForOption = number | string;
 export type PrefetchOptions = {
     cacheFor: CacheForOption | CacheForOption[];
     cacheTags: string | string[];
 };
-export interface LinkComponentBaseProps extends Partial<Pick<Visit<RequestPayload>, 'data' | 'method' | 'replace' | 'preserveScroll' | 'preserveState' | 'preserveUrl' | 'only' | 'except' | 'headers' | 'queryStringArrayFormat' | 'async'> & Omit<VisitCallbacks, 'onCancelToken'> & {
+export interface LinkComponentBaseProps extends Partial<Pick<Visit<RequestPayload>, 'data' | 'method' | 'replace' | 'preserveScroll' | 'preserveState' | 'preserveUrl' | 'only' | 'except' | 'headers' | 'queryStringArrayFormat' | 'async'> & VisitCallbacks & {
     href: string | UrlMethodPair;
-    onCancelToken: (cancelToken: import('axios').CancelTokenSource) => void;
     prefetch: boolean | LinkPrefetchOption | LinkPrefetchOption[];
     cacheFor: CacheForOption | CacheForOption[];
     cacheTags: string | string[];
@@ -428,7 +466,7 @@ export interface InfiniteScrollRef {
     hasNext: () => boolean;
 }
 export interface InfiniteScrollComponentBaseProps {
-    data?: string;
+    data: string;
     buffer?: number;
     as?: string;
     manual?: boolean;