@inertiajs/core 2.3.2 → 2.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inertiajs/core",
-  "version": "2.3.2",
+  "version": "2.3.3",
   "license": "MIT",
   "description": "A framework for creating server-driven single page apps.",
   "contributors": [

package/types/events.d.ts

@@ -11,3 +11,4 @@ export declare const fireStartEvent: GlobalEventTrigger<'start'>;
 export declare const fireSuccessEvent: GlobalEventTrigger<'success'>;
 export declare const firePrefetchedEvent: GlobalEventTrigger<'prefetched'>;
 export declare const firePrefetchingEvent: GlobalEventTrigger<'prefetching'>;
+export declare const fireFlashEvent: GlobalEventTrigger<'flash'>;

package/types/page.d.ts

@@ -1,8 +1,9 @@
-import { Component, Page, PageEvent, PageHandler, PageResolver, RouterInitParams, Visit } from './types';
+import { Component, FlashData, Page, PageEvent, PageHandler, PageResolver, RouterInitParams, Visit } from './types';
 declare class CurrentPage {
     protected page: Page;
     protected swapComponent: PageHandler<any>;
     protected resolveComponent: PageResolver;
+    protected onFlashCallback?: (flash: Page['flash']) => void;
     protected componentId: {};
     protected listeners: {
         event: PageEvent;
@@ -11,7 +12,7 @@ declare class CurrentPage {
     protected isFirstPageLoad: boolean;
     protected cleared: boolean;
     protected pendingDeferredProps: Pick<Page, 'deferredProps' | 'url' | 'component'> | null;
-    init<ComponentType = Component>({ initialPage, swapComponent, resolveComponent, }: RouterInitParams<ComponentType>): this;
+    init<ComponentType = Component>({ initialPage, swapComponent, resolveComponent, onFlash, }: RouterInitParams<ComponentType>): this;
     set(page: Page, { replace, preserveScroll, preserveState, viewTransition, }?: {
         replace?: boolean;
         preserveScroll?: boolean;
@@ -24,8 +25,10 @@ declare class CurrentPage {
     clear(): void;
     isCleared(): boolean;
     get(): Page;
+    getWithoutFlashData(): Page;
     hasOnceProps(): boolean;
     merge(data: Partial<Page>): void;
+    setFlash(flash: FlashData): void;
     setUrlHash(hash: string): void;
     remember(data: Page['rememberedState']): void;
     swap({ component, page, preserveState, viewTransition, }: {

package/types/router.d.ts

@@ -1,11 +1,11 @@
 import Queue from './queue';
 import { RequestStream } from './requestStream';
-import { ActiveVisit, ClientSideVisitOptions, Component, GlobalEvent, GlobalEventNames, GlobalEventResult, InFlightPrefetch, Page, PendingVisit, PendingVisitOptions, PollOptions, PrefetchedResponse, PrefetchOptions, ReloadOptions, RequestPayload, RouterInitParams, UrlMethodPair, VisitCallbacks, VisitHelperOptions, VisitOptions } from './types';
+import { ActiveVisit, ClientSideVisitOptions, Component, FlashData, GlobalEvent, GlobalEventNames, GlobalEventResult, InFlightPrefetch, Page, PageFlashData, PendingVisit, PendingVisitOptions, PollOptions, PrefetchedResponse, PrefetchOptions, ReloadOptions, RequestPayload, RouterInitParams, UrlMethodPair, VisitCallbacks, VisitHelperOptions, VisitOptions } from './types';
 export declare class Router {
     protected syncRequestStream: RequestStream;
     protected asyncRequestStream: RequestStream;
     protected clientVisitQueue: Queue<Promise<void>>;
-    init<ComponentType = Component>({ initialPage, resolveComponent, swapComponent, }: RouterInitParams<ComponentType>): void;
+    init<ComponentType = Component>({ initialPage, resolveComponent, swapComponent, onFlash, }: 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;
@@ -39,6 +39,7 @@ export declare class Router {
     appendToProp<TProps = Page['props']>(name: string, value: unknown | unknown[] | ((oldValue: unknown, props: TProps) => unknown | unknown[]), options?: Pick<ClientSideVisitOptions, 'onError' | 'onFinish' | 'onSuccess'>): void;
     prependToProp<TProps = Page['props']>(name: string, value: unknown | unknown[] | ((oldValue: unknown, props: TProps) => unknown | unknown[]), options?: Pick<ClientSideVisitOptions, 'onError' | 'onFinish' | 'onSuccess'>): void;
     push<TProps = Page['props']>(params: ClientSideVisitOptions<TProps>): void;
+    flash<TFlash extends PageFlashData = PageFlashData>(keyOrData: string | ((flash: FlashData) => TFlash) | TFlash, value?: unknown): void;
     protected clientVisit<TProps = Page['props']>(params: ClientSideVisitOptions<TProps>, { replace }?: {
         replace?: boolean;
     }): void;

package/types/types.d.ts

@@ -6,8 +6,12 @@ declare module 'axios' {
         percentage: number | undefined;
     }
 }
+export interface PageFlashData {
+    [key: string]: unknown;
+}
 export type DefaultInertiaConfig = {
     errorValueType: string;
+    flashDataType: PageFlashData;
     sharedPageProps: PageProps;
 };
 /**
@@ -20,9 +24,11 @@ export type DefaultInertiaConfig = {
  * declare module '@inertiajs/core' {
  *   export interface InertiaConfig {
  *     errorValueType: string[]
+ *     flashDataType: {
+ *       toast?: { type: 'success' | 'error', message: string }
+ *     }
  *     sharedPageProps: {
  *       auth: { user: User | null }
- *       flash: { success?: string; error?: string }
  *     }
  *   }
  * }
@@ -32,6 +38,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 FlashData = InertiaConfigFor<'flashDataType'>;
 export type SharedPageProps = InertiaConfigFor<'sharedPageProps'>;
 export type Errors = Record<string, ErrorValue>;
 export type ErrorBag = Record<string, Errors>;
@@ -94,6 +101,7 @@ export interface Page<SharedProps extends PageProps = PageProps> {
     deepMergeProps?: string[];
     matchPropsOn?: string[];
     scrollProps?: Record<keyof PageProps, ScrollProp>;
+    flash: FlashData;
     onceProps?: Record<string, {
         prop: keyof PageProps;
         expiresAt?: number | null;
@@ -109,6 +117,7 @@ export interface ClientSideVisitOptions<TProps = Page['props']> {
     component?: Page['component'];
     url?: Page['url'];
     props?: ((props: TProps) => PageProps) | PageProps;
+    flash?: ((flash: FlashData) => PageFlashData) | PageFlashData;
     clearHistory?: Page['clearHistory'];
     encryptHistory?: Page['encryptHistory'];
     preserveScroll?: VisitOptions['preserveScroll'];
@@ -117,6 +126,7 @@ export interface ClientSideVisitOptions<TProps = Page['props']> {
     viewTransition?: VisitOptions['viewTransition'];
     onError?: (errors: Errors) => void;
     onFinish?: (visit: ClientSideVisitOptions<TProps>) => void;
+    onFlash?: (flash: FlashData) => void;
     onSuccess?: (page: Page) => void;
 }
 export type PageResolver = (name: string) => Component;
@@ -248,6 +258,13 @@ export type GlobalEventsMap<T extends RequestPayload = RequestPayload> = {
         };
         result: void;
     };
+    flash: {
+        parameters: [Page['flash']];
+        details: {
+            flash: Page['flash'];
+        };
+        result: void;
+    };
 };
 export type PageEvent = 'newComponent' | 'firstLoad';
 export type GlobalEventNames<T extends RequestPayload = RequestPayload> = keyof GlobalEventsMap<T>;
@@ -268,6 +285,7 @@ export type VisitCallbacks<T extends RequestPayload = RequestPayload> = {
     onCancel: GlobalEventCallback<'cancel', T>;
     onSuccess: GlobalEventCallback<'success', T>;
     onError: GlobalEventCallback<'error', T>;
+    onFlash: GlobalEventCallback<'flash', T>;
     onPrefetched: GlobalEventCallback<'prefetched', T>;
     onPrefetching: GlobalEventCallback<'prefetching', T>;
 };
@@ -282,6 +300,7 @@ export type RouterInitParams<ComponentType = Component> = {
     initialPage: Page;
     resolveComponent: PageResolver;
     swapComponent: PageHandler<ComponentType>;
+    onFlash?: (flash: Page['flash']) => void;
 };
 export type PendingVisitOptions = {
     url: URL;
@@ -554,6 +573,7 @@ declare global {
         'inertia:finish': GlobalEvent<'finish'>;
         'inertia:beforeUpdate': GlobalEvent<'beforeUpdate'>;
         'inertia:navigate': GlobalEvent<'navigate'>;
+        'inertia:flash': GlobalEvent<'flash'>;
     }
 }
 export {};