inertiax-core 5.0.20 → 5.0.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inertiax-core",
-  "version": "5.0.20",
+  "version": "5.0.21",
   "license": "MIT",
   "description": "A framework for creating server-driven single page apps.",
   "contributors": [

package/types/history.d.ts

@@ -4,11 +4,12 @@ export declare class History {
     scrollRegions: "scrollRegions";
     preserveUrl: boolean;
     static encryptHistory: boolean;
+    lastUpdatedFrame?: string;
     protected current: Partial<Page>;
     protected queue: (() => Promise<void>)[];
     remember(frame: string, data: unknown, key: string): void;
     restore(frame: string, key: string): unknown;
-    pushState(page: Page): void;
+    pushState(page: Page, updatedFrame?: string): void;
     protected getPageData(page: Page): Promise<Page | ArrayBuffer>;
     processQueue(): Promise<void>;
     decrypt(page?: Page | null): Promise<Page>;

package/types/page.d.ts

@@ -1,4 +1,4 @@
-import { Frame, Component, Page, PageEvent, FrameHandler, PreserveStateOption, RouterInitParams, VisitOptions } from './types';
+import { Frame, Component, Page, PageEvent, FrameHandler, ForgetStateOption, RouterInitParams, VisitOptions } from './types';
 declare class CurrentPage {
     protected page: Page;
     protected swappers: {
@@ -12,10 +12,10 @@ declare class CurrentPage {
     protected isFirstPageLoad: boolean;
     protected cleared: boolean;
     initFrame({ frame, initialState, swapComponent }: RouterInitParams): Frame<import("./types").PageProps>;
-    set(page: Page, { replace, useHistory, preserveScroll, preserveState, frame }?: Partial<VisitOptions>): Promise<void>;
+    set(page: Page, { replace, skipHistory, forgetScroll, forgetState, frame }?: Partial<VisitOptions>): Promise<void>;
     destroy(frame: string): void;
-    setQuietly(page: Page, { preserveState, }?: {
-        preserveState?: PreserveStateOption;
+    setQuietly(page: Page, { forgetState, }?: {
+        forgetState?: ForgetStateOption;
     }): Promise<unknown>;
     setFrame(name: string, frame: Frame, options?: Partial<VisitOptions>): Promise<void>;
     clear(): void;
@@ -26,12 +26,12 @@ declare class CurrentPage {
     setUrlHash(hash: string): void;
     remember(frame: string, data: Frame['rememberedState']): void;
     scrollRegions(regions: Page['scrollRegions']): void;
-    swap({ components, page, preserveState, frame }: {
+    swap({ components, page, forgetState, frame }: {
         components: {
             [name: string]: Component;
         };
         page: Page;
-        preserveState: PreserveStateOption;
+        forgetState: ForgetStateOption;
         frame?: string;
     }): Promise<unknown>;
     resolve(frames: {

package/types/requestParams.d.ts

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig } from 'axios';
 import { Response } from './response';
-import { ActiveVisit, InternalActiveVisit, Page, PreserveStateOption, VisitCallbacks } from './types';
+import { ActiveVisit, InternalActiveVisit, Page, ForgetStateOption, VisitCallbacks } from './types';
 export declare class RequestParams {
     protected callbacks: {
         name: keyof VisitCallbacks;
@@ -30,5 +30,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;
+    protected resolvePreserveOption(value: ForgetStateOption, page: Page): boolean | string;
 }

package/types/router.d.ts

@@ -3,10 +3,10 @@ import { ActiveVisit, GlobalEvent, GlobalEventNames, GlobalEventResult, InFlight
 export declare class Router {
     static resolveComponent: PageResolver;
     protected frame: string;
-    protected useHistory: boolean;
+    protected skipHistory: boolean;
     protected syncRequestStream: RequestStream;
     protected asyncRequestStream: RequestStream;
-    init(useHistory: boolean, { frame, initialState, swapComponent }: RouterInitParams): import("./types").Frame<import("./types").PageProps> | undefined;
+    init(skipHistory: boolean, { frame, initialState, swapComponent }: RouterInitParams): import("./types").Frame<import("./types").PageProps> | undefined;
     destroy(): void;
     get(url: URL | string, data?: RequestPayload, options?: VisitHelperOptions): void;
     post(url: URL | string, data?: RequestPayload, options?: VisitHelperOptions): void;

package/types/types.d.ts

@@ -40,22 +40,22 @@ export interface Page {
     }>;
 }
 export type PageResolver = (name: string) => Component;
-export type FrameHandler = ({ component, frame, preserveState, }: {
+export type FrameHandler = ({ component, frame, forgetState, }: {
     component: Component;
     frame: Frame;
-    preserveState: PreserveStateOption;
+    forgetState: ForgetStateOption;
 }) => Promise<unknown>;
-export type PreserveStateOption = boolean | 'errors' | ((page: Page) => boolean);
+export type ForgetStateOption = boolean | string | ((page: Page) => boolean);
 export type Progress = AxiosProgressEvent;
 export type LocationVisit = {
-    preserveScroll: boolean;
+    forgetScroll: boolean;
 };
 export type Visit = {
     method: Method;
     data: RequestPayload;
     replace: boolean;
-    preserveScroll: PreserveStateOption;
-    preserveState: PreserveStateOption;
+    forgetScroll: ForgetStateOption;
+    forgetState: ForgetStateOption;
     only: Array<string>;
     except: Array<string>;
     headers: Record<string, string>;
@@ -69,7 +69,7 @@ export type Visit = {
     reset: string[];
     preserveUrl: boolean;
     frame: string;
-    useHistory: boolean;
+    skipHistory: boolean;
 };
 export type GlobalEventsMap = {
     before: {
@@ -183,7 +183,7 @@ export type VisitCallbacks = {
     onPrefetching: GlobalEventCallback<'prefetching'>;
 };
 export type VisitOptions = Partial<Visit & VisitCallbacks>;
-export type ReloadOptions = Omit<VisitOptions, 'preserveScroll' | 'preserveState'>;
+export type ReloadOptions = Omit<VisitOptions, 'forgetScroll' | 'forgetState'>;
 export type PollOptions = {
     keepAlive?: boolean;
     autoStart?: boolean;