@inertiajs/core 2.1.1 → 2.1.2

package/package.json

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

package/types/index.d.ts

@@ -6,6 +6,6 @@ export { default as createHeadManager } from './head';
 export { hide as hideProgress, reveal as revealProgress, default as setupProgress } from './progress';
 export { default as shouldIntercept } from './shouldIntercept';
 export * from './types';
-export { hrefToUrl, mergeDataIntoQueryString, urlWithoutHash } from './url';
+export { hrefToUrl, mergeDataIntoQueryString, urlWithoutHash, isUrlMethodPair } from './url';
 export { type Router };
 export declare const router: Router;

package/types/prefetched.d.ts

@@ -5,8 +5,9 @@ declare class PrefetchedRequests {
     protected inFlightRequests: InFlightPrefetch[];
     protected removalTimers: PrefetchRemovalTimer[];
     protected currentUseId: string | null;
-    add(params: ActiveVisit, sendFunc: (params: InternalActiveVisit) => void, { cacheFor }: PrefetchOptions): Promise<void> | Promise<Response>;
+    add(params: ActiveVisit, sendFunc: (params: InternalActiveVisit) => void, { cacheFor, cacheTags }: PrefetchOptions): Promise<void> | Promise<Response>;
     removeAll(): void;
+    removeByTags(tags: string[]): void;
     remove(params: ActiveVisit): void;
     protected removeFromInFlight(params: ActiveVisit): void;
     protected extractStaleValues(cacheFor: PrefetchOptions['cacheFor']): [number, number];

package/types/router.d.ts

@@ -1,14 +1,14 @@
 import { RequestStream } from './requestStream';
-import { ActiveVisit, ClientSideVisitOptions, Component, GlobalEvent, GlobalEventNames, GlobalEventResult, InFlightPrefetch, Page, PendingVisit, PendingVisitOptions, PollOptions, PrefetchedResponse, PrefetchOptions, ReloadOptions, RequestPayload, RouterInitParams, Visit, VisitCallbacks, VisitHelperOptions, VisitOptions } from './types';
+import { ActiveVisit, ClientSideVisitOptions, Component, GlobalEvent, GlobalEventNames, GlobalEventResult, InFlightPrefetch, Page, PendingVisit, PendingVisitOptions, PollOptions, PrefetchedResponse, PrefetchOptions, ReloadOptions, RequestPayload, RouterInitParams, UrlMethodPair, VisitCallbacks, VisitHelperOptions, VisitOptions } from './types';
 export declare class Router {
     protected syncRequestStream: RequestStream;
     protected asyncRequestStream: RequestStream;
     init({ initialPage, resolveComponent, swapComponent }: RouterInitParams): void;
-    get<T extends RequestPayload = RequestPayload>(url: URL | string, data?: T, options?: VisitHelperOptions<T>): void;
-    post<T extends RequestPayload = RequestPayload>(url: URL | string, data?: T, options?: VisitHelperOptions<T>): void;
-    put<T extends RequestPayload = RequestPayload>(url: URL | string, data?: T, options?: VisitHelperOptions<T>): void;
-    patch<T extends RequestPayload = RequestPayload>(url: URL | string, data?: T, options?: VisitHelperOptions<T>): void;
-    delete<T extends RequestPayload = RequestPayload>(url: URL | string, options?: Omit<VisitOptions<T>, 'method'>): 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;
+    patch<T extends RequestPayload = RequestPayload>(url: URL | string | UrlMethodPair, data?: T, options?: VisitHelperOptions<T>): void;
+    delete<T extends RequestPayload = RequestPayload>(url: URL | string | UrlMethodPair, options?: Omit<VisitOptions<T>, 'method'>): void;
     reload<T extends RequestPayload = RequestPayload>(options?: ReloadOptions<T>): void;
     remember(data: unknown, key?: string): void;
     restore(key?: string): unknown;
@@ -19,12 +19,13 @@ export declare class Router {
         stop: VoidFunction;
         start: VoidFunction;
     };
-    visit<T extends RequestPayload = RequestPayload>(href: string | URL, options?: VisitOptions<T>): void;
-    getCached(href: string | URL, options?: VisitOptions): InFlightPrefetch | PrefetchedResponse | null;
-    flush(href: string | URL, options?: VisitOptions): void;
+    visit<T extends RequestPayload = RequestPayload>(href: string | URL | UrlMethodPair, options?: VisitOptions<T>): void;
+    getCached(href: string | URL | UrlMethodPair, options?: VisitOptions): InFlightPrefetch | PrefetchedResponse | null;
+    flush(href: string | URL | UrlMethodPair, options?: VisitOptions): void;
     flushAll(): void;
-    getPrefetching(href: string | URL, options?: VisitOptions): InFlightPrefetch | PrefetchedResponse | null;
-    prefetch(href: string | URL, options: Partial<Visit<RequestPayload> & VisitCallbacks<RequestPayload>> | undefined, { cacheFor }: PrefetchOptions): void;
+    flushByCacheTags(tags: string | string[]): void;
+    getPrefetching(href: string | URL | UrlMethodPair, options?: VisitOptions): InFlightPrefetch | PrefetchedResponse | null;
+    prefetch(href: string | URL | UrlMethodPair, options?: VisitOptions, prefetchOptions?: Partial<PrefetchOptions>): void;
     clearHistory(): void;
     decryptHistory(): Promise<Page>;
     resolveComponent(component: string): Promise<Component>;
@@ -33,8 +34,8 @@ export declare class Router {
     protected clientVisit<TProps = Page['props']>(params: ClientSideVisitOptions<TProps>, { replace }?: {
         replace?: boolean;
     }): void;
-    protected getPrefetchParams(href: string | URL, options: VisitOptions): ActiveVisit;
-    protected getPendingVisit(href: string | URL, options: VisitOptions, pendingVisitOptions?: Partial<PendingVisitOptions>): PendingVisit;
+    protected getPrefetchParams(href: string | URL | UrlMethodPair, options: VisitOptions): ActiveVisit;
+    protected getPendingVisit(href: string | URL | UrlMethodPair, options: VisitOptions, pendingVisitOptions?: Partial<PendingVisitOptions>): PendingVisit;
     protected getVisitEvents(options: VisitOptions): VisitCallbacks;
     protected loadDeferredProps(): void;
 }

package/types/types.d.ts

@@ -116,6 +116,7 @@ export type Visit<T extends RequestPayload = RequestPayload> = {
     fresh: boolean;
     reset: string[];
     preserveUrl: boolean;
+    invalidateCacheTags: string | string[];
 };
 export type GlobalEventsMap<T extends RequestPayload = RequestPayload> = {
     before: {
@@ -262,15 +263,14 @@ 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' | 'only' | 'except' | 'headers' | 'queryStringArrayFormat' | 'async'> & Omit<VisitCallbacks, 'onCancelToken'> & {
-    href: string | {
-        url: string;
-        method: Method;
-    };
+    href: string | UrlMethodPair;
     onCancelToken: (cancelToken: import('axios').CancelTokenSource) => void;
     prefetch: boolean | LinkPrefetchOption | LinkPrefetchOption[];
     cacheFor: CacheForOption | CacheForOption[];
+    cacheTags: string | string[];
 }> {
 }
 type PrefetchObject = {
@@ -290,6 +290,7 @@ export type PrefetchedResponse = PrefetchObject & {
     timestamp: number;
     singleUse: boolean;
     inFlight: false;
+    tags: string[];
 };
 export type PrefetchRemovalTimer = {
     params: ActiveVisit;
@@ -310,17 +311,21 @@ export type ProgressSettings = {
     includeCSS: boolean;
     color: string;
 };
+export type UrlMethodPair = {
+    url: string;
+    method: Method;
+};
 export type FormComponentOptions = Pick<VisitOptions, 'preserveScroll' | 'preserveState' | 'preserveUrl' | 'replace' | 'only' | 'except' | 'reset'>;
-export type FormComponentProps = Partial<Pick<Visit, 'headers' | 'queryStringArrayFormat' | 'errorBag' | 'showProgress'> & Omit<VisitCallbacks, 'onPrefetched' | 'onPrefetching'>> & {
+export type FormComponentProps = Partial<Pick<Visit, 'headers' | 'queryStringArrayFormat' | 'errorBag' | 'showProgress' | 'invalidateCacheTags'> & Omit<VisitCallbacks, 'onPrefetched' | 'onPrefetching'>> & {
     method?: Method | Uppercase<Method>;
-    action?: string | {
-        url: string;
-        method: Method;
-    };
+    action?: string | UrlMethodPair;
     transform?: (data: Record<string, FormDataConvertible>) => Record<string, FormDataConvertible>;
     options?: FormComponentOptions;
     onSubmitComplete?: (props: FormComponentonSubmitCompleteArguments) => void;
     disableWhileProcessing?: boolean;
+    resetOnSuccess?: boolean | string[];
+    resetOnError?: boolean | string[];
+    setDefaultsOnSuccess?: boolean;
 };
 export type FormComponentMethods = {
     clearErrors: (...fields: string[]) => void;

package/types/url.d.ts

@@ -1,4 +1,4 @@
-import { FormDataConvertible, Method, RequestPayload, VisitOptions } from './types';
+import { FormDataConvertible, Method, RequestPayload, UrlMethodPair, VisitOptions } from './types';
 export declare function hrefToUrl(href: string | URL): URL;
 export declare const transformUrlAndData: (href: string | URL, data: RequestPayload, method: Method, forceFormData: VisitOptions['forceFormData'], queryStringArrayFormat: VisitOptions['queryStringArrayFormat']) => [URL, RequestPayload];
 type MergeDataIntoQueryStringDataReturnType<T extends RequestPayload> = T extends Record<string, FormDataConvertible> ? Record<string, FormDataConvertible> : RequestPayload;
@@ -6,4 +6,5 @@ export declare function mergeDataIntoQueryString<T extends RequestPayload>(metho
 export declare function urlWithoutHash(url: URL | Location): URL;
 export declare const setHashIfSameUrl: (originUrl: URL | Location, destinationUrl: URL | Location) => void;
 export declare const isSameUrlWithoutHash: (url1: URL | Location, url2: URL | Location) => boolean;
+export declare function isUrlMethodPair(href: unknown): href is UrlMethodPair;
 export {};