@hybridly/core 0.4.2 → 0.4.4

package/dist/index.cjs

@@ -1,16 +1,14 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
+const qs = require('qs');
 const utils = require('@hybridly/utils');
 const axios = require('axios');
 const superjson = require('superjson');
-const qs = require('qs');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
-const axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
-const qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
+const qs__default = /*#__PURE__*/_interopDefaultCompat(qs);
+const axios__default = /*#__PURE__*/_interopDefaultCompat(axios);
 
 const STORAGE_EXTERNAL_KEY = "hybridly:external";
 const HYBRIDLY_HEADER = "x-hybrid";
@@ -27,18 +25,18 @@ const SCROLL_REGION_ATTRIBUTE = "scroll-region";
 
 const constants = {
 	__proto__: null,
-	STORAGE_EXTERNAL_KEY: STORAGE_EXTERNAL_KEY,
-	HYBRIDLY_HEADER: HYBRIDLY_HEADER,
-	EXTERNAL_NAVIGATION_HEADER: EXTERNAL_NAVIGATION_HEADER,
-	PARTIAL_COMPONENT_HEADER: PARTIAL_COMPONENT_HEADER,
-	ONLY_DATA_HEADER: ONLY_DATA_HEADER,
+	CONTEXT_HEADER: CONTEXT_HEADER,
 	DIALOG_KEY_HEADER: DIALOG_KEY_HEADER,
 	DIALOG_REDIRECT_HEADER: DIALOG_REDIRECT_HEADER,
-	EXCEPT_DATA_HEADER: EXCEPT_DATA_HEADER,
-	CONTEXT_HEADER: CONTEXT_HEADER,
-	VERSION_HEADER: VERSION_HEADER,
 	ERROR_BAG_HEADER: ERROR_BAG_HEADER,
-	SCROLL_REGION_ATTRIBUTE: SCROLL_REGION_ATTRIBUTE
+	EXCEPT_DATA_HEADER: EXCEPT_DATA_HEADER,
+	EXTERNAL_NAVIGATION_HEADER: EXTERNAL_NAVIGATION_HEADER,
+	HYBRIDLY_HEADER: HYBRIDLY_HEADER,
+	ONLY_DATA_HEADER: ONLY_DATA_HEADER,
+	PARTIAL_COMPONENT_HEADER: PARTIAL_COMPONENT_HEADER,
+	SCROLL_REGION_ATTRIBUTE: SCROLL_REGION_ATTRIBUTE,
+	STORAGE_EXTERNAL_KEY: STORAGE_EXTERNAL_KEY,
+	VERSION_HEADER: VERSION_HEADER
 };
 
 class NotAHybridResponseError extends Error {
@@ -245,6 +243,7 @@ function setHistoryState(options = {}) {
   utils.debug.history("Setting history state:", {
     method,
     context
+    // serialized,
   });
   try {
     window.history[method](serialized, "", context.url);
@@ -912,6 +911,9 @@ async function navigate(options) {
     utils.debug.router(`Target URL is ${context.url}, current window URL is ${window.location.href}.`, { shouldReplaceHistory });
     setHistoryState({ replace: shouldReplaceHistory });
   }
+  context.adapter.executeOnMounted(() => {
+    runHooks("mounted", {}, context);
+  });
   const viewComponent = await context.adapter.resolveComponent(context.view.component);
   utils.debug.router(`Component [${context.view.component}] resolved to:`, viewComponent);
   await context.adapter.onViewSwap({
@@ -926,9 +928,6 @@ async function navigate(options) {
     resetScrollPositions();
   }
   await runHooks("navigated", {}, options, context);
-  context.adapter.executeOnMounted(() => {
-    runHooks("mounted", {}, context);
-  });
 }
 async function performHybridRequest(targetUrl, options, abortController) {
   const context = getInternalRouterContext();
@@ -980,6 +979,7 @@ async function initializeRouter() {
       url: makeUrl(context.url, { hash: window.location.hash }).toString()
     });
     await navigate({
+      isInitial: true,
       preserveState: true,
       replace: sameUrls(context.url, window.location.href)
     });

package/dist/index.d.cts

@@ -0,0 +1,495 @@
+import { RequestData } from '@hybridly/utils';
+import { AxiosResponse, AxiosProgressEvent, Axios } from 'axios';
+
+type MaybePromise<T> = T | Promise<T>;
+
+interface RequestHooks {
+    /**
+         * Called before a navigation request is going to happen.
+         */
+    before: (options: HybridRequestOptions, context: InternalRouterContext) => MaybePromise<any | boolean>;
+    /**
+     * Called before the request of a navigation is going to happen.
+     */
+    start: (context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when progress on the request is being made.
+     */
+    progress: (progress: Progress, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when data is received after a request for a navigation.
+     */
+    data: (response: AxiosResponse, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a request is successful and there is no error.
+     */
+    success: (payload: HybridPayload, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a request is successful but there were errors.
+     */
+    error: (errors: Errors, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a request has been aborted.
+     */
+    abort: (context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a response to a request is not a valid hybrid response.
+     */
+    invalid: (response: AxiosResponse, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when an unknowne exception was triggered.
+     */
+    exception: (error: Error, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called whenever the request failed, for any reason, in addition to other hooks.
+     */
+    fail: (context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called after a request has been made, even if it didn't succeed.
+     */
+    after: (context: InternalRouterContext) => MaybePromise<any>;
+}
+interface Hooks extends RequestHooks {
+    /**
+         * Called when Hybridly's context is initialized.
+         */
+    initialized: (context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called after Hybridly's initial page load.
+     */
+    ready: (context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a back-forward navigation occurs.
+     */
+    backForward: (state: any, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a component navigation is being made.
+     */
+    navigating: (options: NavigationOptions, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a component has been navigated to.
+     */
+    navigated: (options: NavigationOptions, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a component has been navigated to and was mounted by the adapter.
+     */
+    mounted: (context: InternalRouterContext) => MaybePromise<any>;
+}
+interface HookOptions {
+    /** Executes the hook only once. */
+    once?: boolean;
+}
+/**
+ * Registers a global hook.
+ */
+declare function registerHook<T extends keyof Hooks>(hook: T, fn: Hooks[T], options?: HookOptions): () => void;
+
+interface Plugin extends Partial<Hooks> {
+    /** Identifier of the plugin. */
+    name: string;
+}
+declare function definePlugin(plugin: Plugin): Plugin;
+
+interface CloseDialogOptions extends HybridRequestOptions {
+    /**
+     * Close the dialog without a round-trip to the server.
+     * @default false
+     */
+    local?: boolean;
+}
+
+type UrlResolvable = string | URL | Location;
+type UrlTransformable = BaseUrlTransformable | ((string: URL) => BaseUrlTransformable);
+type BaseUrlTransformable = Partial<Omit<URL, 'searchParams' | 'toJSON' | 'toString'>> & {
+    query?: any;
+    trailingSlash?: boolean;
+};
+/**
+ * Converts an input to an URL, optionally changing its properties after initialization.
+ */
+declare function makeUrl(href: UrlResolvable, transformations?: UrlTransformable): URL;
+/**
+ * Checks if the given URLs have the same origin and path.
+ */
+declare function sameUrls(...hrefs: UrlResolvable[]): boolean;
+
+type ConditionalNavigationOption<T extends boolean | string> = T | ((payload: NavigationOptions) => T);
+interface ComponentNavigationOptions {
+    /** Dialog data. */
+    dialog?: Dialog | false;
+    /** Name of the component to use. */
+    component?: string;
+    /** Properties to apply to the component. */
+    properties?: Properties;
+    /**
+     * Whether to replace the current history state instead of adding
+     * one. This affects the browser's "back" and "forward" features.
+     */
+    replace?: ConditionalNavigationOption<boolean>;
+    /** Whether to preserve the current scrollbar position. */
+    preserveScroll?: ConditionalNavigationOption<boolean>;
+    /** Whether to preserve the current page component state. */
+    preserveState?: ConditionalNavigationOption<boolean>;
+}
+interface NavigationOptions {
+    /** View to navigate to. */
+    payload?: HybridPayload;
+    /**
+     * Whether to replace the current history state instead of adding
+     * one. This affects the browser's "back" and "forward" features.
+     */
+    replace?: ConditionalNavigationOption<boolean>;
+    /** Whether to preserve the scrollbars positions on the page. */
+    preserveScroll?: ConditionalNavigationOption<boolean>;
+    /** Whether to preserve the current page component's state. */
+    preserveState?: ConditionalNavigationOption<boolean>;
+    /** Whether to preserve the current URL. */
+    preserveUrl?: ConditionalNavigationOption<boolean>;
+    /**
+     * Properties of the given URL to override.
+     * @example
+     * ```ts
+     * router.get('/login?redirect=/', {
+     * 	transformUrl: { search: '' }
+     * }
+     * ```
+     */
+    transformUrl?: UrlTransformable;
+    /**
+     * Defines whether the history state should be updated.
+     * @internal This is an advanced property meant to be used internally.
+     */
+    updateHistoryState?: boolean;
+    /**
+     * Defines whether this navigation is a back/forward navigation from the popstate event.
+     * @internal This is an advanced property meant to be used internally.
+     */
+    isBackForward?: boolean;
+    /**
+     * Defines whether this navigation is the first to happen after a direct page load.
+     * @internal This is an advanced property meant to be used internally.
+     */
+    isInitial?: boolean;
+}
+type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+interface HybridRequestOptions extends Omit<NavigationOptions, 'payload'> {
+    /** The URL to navigation. */
+    url?: UrlResolvable;
+    /** HTTP verb to use for the request. */
+    method?: Method | Lowercase<Method>;
+    /** Body of the request. */
+    data?: RequestData;
+    /** Which properties to update for this navigation. Other properties will be ignored. */
+    only?: string | string[];
+    /** Which properties not to update for this navigation. Other properties will be updated. */
+    except?: string | string[];
+    /** Specific headers to add to the request. */
+    headers?: Record<string, string>;
+    /** The bag in which to put potential errors. */
+    errorBag?: string;
+    /** Hooks for this navigation. */
+    hooks?: Partial<RequestHooks>;
+    /** If `true`, force the usage of a `FormData` object. */
+    useFormData?: boolean;
+    /**
+     * If `false`, disable automatic form spoofing.
+     * @see https://laravel.com/docs/9.x/routing#form-method-spoofing
+     */
+    spoof?: boolean;
+    /**
+     * If `false`, does not trigger the progress bar for this request.
+     */
+    progress?: boolean;
+}
+interface NavigationResponse {
+    response?: AxiosResponse;
+    error?: {
+        type: string;
+        actual: Error;
+    };
+}
+interface DialogRouter {
+    /** Closes the current dialog. */
+    close: (options?: CloseDialogOptions) => void;
+}
+interface Router {
+    /** Aborts the currently pending navigate, if any. */
+    abort: () => Promise<void>;
+    /** Checks if there is an active navigate. */
+    active: () => boolean;
+    /** Makes a navigate with the given options. */
+    navigate: (options: HybridRequestOptions) => Promise<NavigationResponse>;
+    /** Reloads the current page. */
+    reload: (options?: HybridRequestOptions) => Promise<NavigationResponse>;
+    /** Makes a request to given named route. The HTTP verb is determined automatically but can be overriden. */
+    to: <T extends RouteName>(name: T, parameters?: RouteParameters<T>, options?: Omit<HybridRequestOptions, 'url'>) => Promise<NavigationResponse>;
+    /** Makes a GET request to the given URL. */
+    get: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<NavigationResponse>;
+    /** Makes a POST request to the given URL. */
+    post: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<NavigationResponse>;
+    /** Makes a PUT request to the given URL. */
+    put: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<NavigationResponse>;
+    /** Makes a PATCH request to the given URL. */
+    patch: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<NavigationResponse>;
+    /** Makes a DELETE request to the given URL. */
+    delete: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<NavigationResponse>;
+    /** Navigates to the given external URL. Convenience method using `document.location.href`. */
+    external: (url: UrlResolvable, data?: HybridRequestOptions['data']) => void;
+    /** Navigates to the given URL without a server round-trip. */
+    local: (url: UrlResolvable, options: ComponentNavigationOptions) => Promise<void>;
+    /** Preloads the given URL. The next time this URL is navigated to, it will be loaded from the cache. */
+    preload: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<boolean>;
+    /** Determines if the given route name and parameters matches the current route. */
+    matches: <T extends RouteName>(name: T, parameters?: RouteParameters<T>) => boolean;
+    /** Gets the current route name. Returns `undefined` is unknown. */
+    current: () => string | undefined;
+    /** Access the dialog router. */
+    dialog: DialogRouter;
+    /** Access the history state. */
+    history: {
+        /** Remembers a value for the given route. */
+        remember: (key: string, value: any) => void;
+        /** Gets a remembered value. */
+        get: <T = any>(key: string) => T | undefined;
+    };
+}
+/** A navigation being made. */
+interface PendingNavigation {
+    /** The URL to which the request is being made. */
+    url: URL;
+    /** Abort controller associated to this request. */
+    controller: AbortController;
+    /** Options for the associated hybrid request. */
+    options: HybridRequestOptions;
+    /** Navigation identifier. */
+    id: string;
+    /** Current status. */
+    status: 'pending' | 'success' | 'error';
+}
+/** A page or dialog component. */
+interface View {
+    /** Name of the component to use. */
+    component: string;
+    /** Properties to apply to the component. */
+    properties: Properties;
+}
+interface Dialog extends View {
+    /** URL that is the base background page when navigating to the dialog directly. */
+    baseUrl: string;
+    /** URL to which the dialog should redirect when closed. */
+    redirectUrl: string;
+    /** Unique identifier for this modal's lifecycle. */
+    key: string;
+}
+type Property = null | string | number | boolean | Property[] | {
+    [name: string]: Property;
+};
+type Properties = Record<string | number, Property>;
+interface SwapOptions<T> {
+    /** The new component. */
+    component: T;
+    /** The new properties. */
+    properties?: any;
+    /** Whether to preserve the state of the component. */
+    preserveState?: boolean;
+    /** Current dialog. */
+    dialog?: Dialog;
+}
+type ViewComponent = any;
+type ResolveComponent = (name: string) => Promise<ViewComponent>;
+type SwapView = (options: SwapOptions<ViewComponent>) => Promise<void>;
+/** The payload of a navigation request from the server. */
+interface HybridPayload {
+    /** The view to use in this request. */
+    view: View;
+    /** An optional dialog. */
+    dialog?: Dialog;
+    /** The current page URL. */
+    url: string;
+    /** The current asset version. */
+    version: string;
+}
+interface Progress {
+    /** Base event. */
+    event: AxiosProgressEvent;
+    /** Computed percentage. */
+    percentage: Readonly<number>;
+}
+type Errors = any;
+
+interface RoutingConfiguration {
+    url: string;
+    port?: number;
+    defaults: Record<string, any>;
+    routes: Record<string, RouteDefinition>;
+}
+interface RouteDefinition {
+    uri: string;
+    method: Method[];
+    bindings: Record<string, string>;
+    domain?: string;
+    wheres?: Record<string, string>;
+    name: string;
+}
+interface GlobalRouteCollection extends RoutingConfiguration {
+}
+type RouteName = keyof GlobalRouteCollection['routes'];
+type RouteParameters<T extends RouteName> = Record<keyof GlobalRouteCollection['routes'][T]['bindings'], any> & Record<string, any>;
+
+/** Options for creating a router context. */
+interface RouterContextOptions {
+    /** The initial payload served by the browser. */
+    payload: HybridPayload;
+    /** Adapter-specific functions. */
+    adapter: Adapter;
+    /** History state serializer. */
+    serializer?: Serializer;
+    /** List of plugins. */
+    plugins?: Plugin[];
+    /** The Axios instance. */
+    axios?: Axios;
+    /** Initial routing configuration. */
+    routing?: RoutingConfiguration;
+    /** Whether to display response error modals. */
+    responseErrorModals?: boolean;
+}
+/** Router context. */
+interface InternalRouterContext {
+    /** The current, normalized URL. */
+    url: string;
+    /** The current view. */
+    view: View;
+    /** The current, optional dialog. */
+    dialog?: Dialog;
+    /** The current local asset version. */
+    version: string;
+    /** The current adapter's functions. */
+    adapter: ResolvedAdapter;
+    /** Scroll positions of the current page's DOM elements. */
+    scrollRegions: ScrollRegion[];
+    /** Arbitrary state. */
+    memo: Record<string, any>;
+    /** Currently pending navigation. */
+    pendingNavigation?: PendingNavigation;
+    /** History state serializer. */
+    serializer: Serializer;
+    /** List of plugins. */
+    plugins: Plugin[];
+    /** Global hooks. */
+    hooks: Partial<Record<keyof Hooks, Array<Function>>>;
+    /** The Axios instance. */
+    axios: Axios;
+    /** Routing configuration. */
+    routing?: RoutingConfiguration;
+    /** Whether to display response error modals. */
+    responseErrorModals?: boolean;
+    /** Cache of preload requests. */
+    preloadCache: Map<string, AxiosResponse>;
+}
+/** Router context. */
+type RouterContext = Readonly<InternalRouterContext>;
+/** Adapter-specific functions. */
+interface Adapter {
+    /** Resolves a component from the given name. */
+    resolveComponent: ResolveComponent;
+    /** Called when the view is swapped. */
+    onViewSwap: SwapView;
+    /** Called when the context is updated. */
+    onContextUpdate?: (context: InternalRouterContext) => void;
+    /** Called when a dialog is closed. */
+    onDialogClose?: (context: InternalRouterContext) => void;
+    /** Called when Hybridly is waiting for a component to be mounted. The given callback should be executed after the view component is mounted. */
+    executeOnMounted: (callback: Function) => void;
+}
+interface ResolvedAdapter extends Adapter {
+    updateRoutingConfiguration: (routing?: RoutingConfiguration) => void;
+}
+interface ScrollRegion {
+    top: number;
+    left: number;
+}
+/** Provides methods to serialize the state into the history state. */
+interface Serializer {
+    serialize: <T>(view: T) => string;
+    unserialize: <T>(state?: string) => T | undefined;
+}
+
+/** Gets the current context. */
+declare function getRouterContext(): RouterContext;
+
+/**
+ * The hybridly router.
+ * This is the core function that you can use to navigate in
+ * your application. Make sure the routes you call return a
+ * hybrid response, otherwise you need to call `external`.
+ *
+ * @example
+ * router.get('/posts/edit', { post })
+ */
+declare const router: Router;
+/** Creates the hybridly router. */
+declare function createRouter(options: RouterContextOptions): Promise<InternalRouterContext>;
+
+interface Authorizable<Authorizations extends Record<string, boolean>> {
+    authorization: Authorizations;
+}
+/**
+ * Checks whether the given data has the authorization for the given action.
+ * If the data object has no authorization definition corresponding to the given action, this method will return `false`.
+ */
+declare function can<Authorizations extends Record<string, boolean>, Data extends Authorizable<Authorizations>, Action extends keyof Data['authorization']>(resource: Data, action: Action): Authorizations[Action];
+
+/**
+ * Generates a route from the given route name.
+ */
+declare function route<T extends RouteName>(name: T, parameters?: RouteParameters<T>, absolute?: boolean): string;
+
+interface DynamicConfiguration {
+    architecture: {
+        root: string;
+    };
+    components: {
+        eager?: boolean;
+        directories: string[];
+        views: Component[];
+        layouts: Component[];
+        components: Component[];
+    };
+    routing: RoutingConfiguration;
+}
+interface Component {
+    path: string;
+    identifier: string;
+    namespace: string;
+}
+
+declare const STORAGE_EXTERNAL_KEY = "hybridly:external";
+declare const HYBRIDLY_HEADER = "x-hybrid";
+declare const EXTERNAL_NAVIGATION_HEADER = "x-hybrid-external";
+declare const PARTIAL_COMPONENT_HEADER = "x-hybrid-partial-component";
+declare const ONLY_DATA_HEADER = "x-hybrid-only-data";
+declare const DIALOG_KEY_HEADER = "x-hybrid-dialog-key";
+declare const DIALOG_REDIRECT_HEADER = "x-hybrid-dialog-redirect";
+declare const EXCEPT_DATA_HEADER = "x-hybrid-except-data";
+declare const CONTEXT_HEADER = "x-hybrid-context";
+declare const VERSION_HEADER = "x-hybrid-version";
+declare const ERROR_BAG_HEADER = "x-hybrid-error-bag";
+declare const SCROLL_REGION_ATTRIBUTE = "scroll-region";
+
+declare const constants_CONTEXT_HEADER: typeof CONTEXT_HEADER;
+declare const constants_DIALOG_KEY_HEADER: typeof DIALOG_KEY_HEADER;
+declare const constants_DIALOG_REDIRECT_HEADER: typeof DIALOG_REDIRECT_HEADER;
+declare const constants_ERROR_BAG_HEADER: typeof ERROR_BAG_HEADER;
+declare const constants_EXCEPT_DATA_HEADER: typeof EXCEPT_DATA_HEADER;
+declare const constants_EXTERNAL_NAVIGATION_HEADER: typeof EXTERNAL_NAVIGATION_HEADER;
+declare const constants_HYBRIDLY_HEADER: typeof HYBRIDLY_HEADER;
+declare const constants_ONLY_DATA_HEADER: typeof ONLY_DATA_HEADER;
+declare const constants_PARTIAL_COMPONENT_HEADER: typeof PARTIAL_COMPONENT_HEADER;
+declare const constants_SCROLL_REGION_ATTRIBUTE: typeof SCROLL_REGION_ATTRIBUTE;
+declare const constants_STORAGE_EXTERNAL_KEY: typeof STORAGE_EXTERNAL_KEY;
+declare const constants_VERSION_HEADER: typeof VERSION_HEADER;
+declare namespace constants {
+  export { constants_CONTEXT_HEADER as CONTEXT_HEADER, constants_DIALOG_KEY_HEADER as DIALOG_KEY_HEADER, constants_DIALOG_REDIRECT_HEADER as DIALOG_REDIRECT_HEADER, constants_ERROR_BAG_HEADER as ERROR_BAG_HEADER, constants_EXCEPT_DATA_HEADER as EXCEPT_DATA_HEADER, constants_EXTERNAL_NAVIGATION_HEADER as EXTERNAL_NAVIGATION_HEADER, constants_HYBRIDLY_HEADER as HYBRIDLY_HEADER, constants_ONLY_DATA_HEADER as ONLY_DATA_HEADER, constants_PARTIAL_COMPONENT_HEADER as PARTIAL_COMPONENT_HEADER, constants_SCROLL_REGION_ATTRIBUTE as SCROLL_REGION_ATTRIBUTE, constants_STORAGE_EXTERNAL_KEY as STORAGE_EXTERNAL_KEY, constants_VERSION_HEADER as VERSION_HEADER };
+}
+
+export { type Authorizable, type DynamicConfiguration, type GlobalRouteCollection, type HybridPayload, type HybridRequestOptions, type MaybePromise, type Method, type NavigationResponse, type Plugin, type Progress, type ResolveComponent, type RouteDefinition, type RouteName, type RouteParameters, type Router, type RouterContext, type RouterContextOptions, type RoutingConfiguration, type UrlResolvable, can, constants, createRouter, definePlugin, getRouterContext, makeUrl, registerHook, route, router, sameUrls };

package/dist/index.d.mts

@@ -0,0 +1,495 @@
+import { RequestData } from '@hybridly/utils';
+import { AxiosResponse, AxiosProgressEvent, Axios } from 'axios';
+
+type MaybePromise<T> = T | Promise<T>;
+
+interface RequestHooks {
+    /**
+         * Called before a navigation request is going to happen.
+         */
+    before: (options: HybridRequestOptions, context: InternalRouterContext) => MaybePromise<any | boolean>;
+    /**
+     * Called before the request of a navigation is going to happen.
+     */
+    start: (context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when progress on the request is being made.
+     */
+    progress: (progress: Progress, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when data is received after a request for a navigation.
+     */
+    data: (response: AxiosResponse, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a request is successful and there is no error.
+     */
+    success: (payload: HybridPayload, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a request is successful but there were errors.
+     */
+    error: (errors: Errors, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a request has been aborted.
+     */
+    abort: (context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a response to a request is not a valid hybrid response.
+     */
+    invalid: (response: AxiosResponse, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when an unknowne exception was triggered.
+     */
+    exception: (error: Error, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called whenever the request failed, for any reason, in addition to other hooks.
+     */
+    fail: (context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called after a request has been made, even if it didn't succeed.
+     */
+    after: (context: InternalRouterContext) => MaybePromise<any>;
+}
+interface Hooks extends RequestHooks {
+    /**
+         * Called when Hybridly's context is initialized.
+         */
+    initialized: (context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called after Hybridly's initial page load.
+     */
+    ready: (context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a back-forward navigation occurs.
+     */
+    backForward: (state: any, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a component navigation is being made.
+     */
+    navigating: (options: NavigationOptions, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a component has been navigated to.
+     */
+    navigated: (options: NavigationOptions, context: InternalRouterContext) => MaybePromise<any>;
+    /**
+     * Called when a component has been navigated to and was mounted by the adapter.
+     */
+    mounted: (context: InternalRouterContext) => MaybePromise<any>;
+}
+interface HookOptions {
+    /** Executes the hook only once. */
+    once?: boolean;
+}
+/**
+ * Registers a global hook.
+ */
+declare function registerHook<T extends keyof Hooks>(hook: T, fn: Hooks[T], options?: HookOptions): () => void;
+
+interface Plugin extends Partial<Hooks> {
+    /** Identifier of the plugin. */
+    name: string;
+}
+declare function definePlugin(plugin: Plugin): Plugin;
+
+interface CloseDialogOptions extends HybridRequestOptions {
+    /**
+     * Close the dialog without a round-trip to the server.
+     * @default false
+     */
+    local?: boolean;
+}
+
+type UrlResolvable = string | URL | Location;
+type UrlTransformable = BaseUrlTransformable | ((string: URL) => BaseUrlTransformable);
+type BaseUrlTransformable = Partial<Omit<URL, 'searchParams' | 'toJSON' | 'toString'>> & {
+    query?: any;
+    trailingSlash?: boolean;
+};
+/**
+ * Converts an input to an URL, optionally changing its properties after initialization.
+ */
+declare function makeUrl(href: UrlResolvable, transformations?: UrlTransformable): URL;
+/**
+ * Checks if the given URLs have the same origin and path.
+ */
+declare function sameUrls(...hrefs: UrlResolvable[]): boolean;
+
+type ConditionalNavigationOption<T extends boolean | string> = T | ((payload: NavigationOptions) => T);
+interface ComponentNavigationOptions {
+    /** Dialog data. */
+    dialog?: Dialog | false;
+    /** Name of the component to use. */
+    component?: string;
+    /** Properties to apply to the component. */
+    properties?: Properties;
+    /**
+     * Whether to replace the current history state instead of adding
+     * one. This affects the browser's "back" and "forward" features.
+     */
+    replace?: ConditionalNavigationOption<boolean>;
+    /** Whether to preserve the current scrollbar position. */
+    preserveScroll?: ConditionalNavigationOption<boolean>;
+    /** Whether to preserve the current page component state. */
+    preserveState?: ConditionalNavigationOption<boolean>;
+}
+interface NavigationOptions {
+    /** View to navigate to. */
+    payload?: HybridPayload;
+    /**
+     * Whether to replace the current history state instead of adding
+     * one. This affects the browser's "back" and "forward" features.
+     */
+    replace?: ConditionalNavigationOption<boolean>;
+    /** Whether to preserve the scrollbars positions on the page. */
+    preserveScroll?: ConditionalNavigationOption<boolean>;
+    /** Whether to preserve the current page component's state. */
+    preserveState?: ConditionalNavigationOption<boolean>;
+    /** Whether to preserve the current URL. */
+    preserveUrl?: ConditionalNavigationOption<boolean>;
+    /**
+     * Properties of the given URL to override.
+     * @example
+     * ```ts
+     * router.get('/login?redirect=/', {
+     * 	transformUrl: { search: '' }
+     * }
+     * ```
+     */
+    transformUrl?: UrlTransformable;
+    /**
+     * Defines whether the history state should be updated.
+     * @internal This is an advanced property meant to be used internally.
+     */
+    updateHistoryState?: boolean;
+    /**
+     * Defines whether this navigation is a back/forward navigation from the popstate event.
+     * @internal This is an advanced property meant to be used internally.
+     */
+    isBackForward?: boolean;
+    /**
+     * Defines whether this navigation is the first to happen after a direct page load.
+     * @internal This is an advanced property meant to be used internally.
+     */
+    isInitial?: boolean;
+}
+type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+interface HybridRequestOptions extends Omit<NavigationOptions, 'payload'> {
+    /** The URL to navigation. */
+    url?: UrlResolvable;
+    /** HTTP verb to use for the request. */
+    method?: Method | Lowercase<Method>;
+    /** Body of the request. */
+    data?: RequestData;
+    /** Which properties to update for this navigation. Other properties will be ignored. */
+    only?: string | string[];
+    /** Which properties not to update for this navigation. Other properties will be updated. */
+    except?: string | string[];
+    /** Specific headers to add to the request. */
+    headers?: Record<string, string>;
+    /** The bag in which to put potential errors. */
+    errorBag?: string;
+    /** Hooks for this navigation. */
+    hooks?: Partial<RequestHooks>;
+    /** If `true`, force the usage of a `FormData` object. */
+    useFormData?: boolean;
+    /**
+     * If `false`, disable automatic form spoofing.
+     * @see https://laravel.com/docs/9.x/routing#form-method-spoofing
+     */
+    spoof?: boolean;
+    /**
+     * If `false`, does not trigger the progress bar for this request.
+     */
+    progress?: boolean;
+}
+interface NavigationResponse {
+    response?: AxiosResponse;
+    error?: {
+        type: string;
+        actual: Error;
+    };
+}
+interface DialogRouter {
+    /** Closes the current dialog. */
+    close: (options?: CloseDialogOptions) => void;
+}
+interface Router {
+    /** Aborts the currently pending navigate, if any. */
+    abort: () => Promise<void>;
+    /** Checks if there is an active navigate. */
+    active: () => boolean;
+    /** Makes a navigate with the given options. */
+    navigate: (options: HybridRequestOptions) => Promise<NavigationResponse>;
+    /** Reloads the current page. */
+    reload: (options?: HybridRequestOptions) => Promise<NavigationResponse>;
+    /** Makes a request to given named route. The HTTP verb is determined automatically but can be overriden. */
+    to: <T extends RouteName>(name: T, parameters?: RouteParameters<T>, options?: Omit<HybridRequestOptions, 'url'>) => Promise<NavigationResponse>;
+    /** Makes a GET request to the given URL. */
+    get: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<NavigationResponse>;
+    /** Makes a POST request to the given URL. */
+    post: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<NavigationResponse>;
+    /** Makes a PUT request to the given URL. */
+    put: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<NavigationResponse>;
+    /** Makes a PATCH request to the given URL. */
+    patch: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<NavigationResponse>;
+    /** Makes a DELETE request to the given URL. */
+    delete: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<NavigationResponse>;
+    /** Navigates to the given external URL. Convenience method using `document.location.href`. */
+    external: (url: UrlResolvable, data?: HybridRequestOptions['data']) => void;
+    /** Navigates to the given URL without a server round-trip. */
+    local: (url: UrlResolvable, options: ComponentNavigationOptions) => Promise<void>;
+    /** Preloads the given URL. The next time this URL is navigated to, it will be loaded from the cache. */
+    preload: (url: UrlResolvable, options?: Omit<HybridRequestOptions, 'method' | 'url'>) => Promise<boolean>;
+    /** Determines if the given route name and parameters matches the current route. */
+    matches: <T extends RouteName>(name: T, parameters?: RouteParameters<T>) => boolean;
+    /** Gets the current route name. Returns `undefined` is unknown. */
+    current: () => string | undefined;
+    /** Access the dialog router. */
+    dialog: DialogRouter;
+    /** Access the history state. */
+    history: {
+        /** Remembers a value for the given route. */
+        remember: (key: string, value: any) => void;
+        /** Gets a remembered value. */
+        get: <T = any>(key: string) => T | undefined;
+    };
+}
+/** A navigation being made. */
+interface PendingNavigation {
+    /** The URL to which the request is being made. */
+    url: URL;
+    /** Abort controller associated to this request. */
+    controller: AbortController;
+    /** Options for the associated hybrid request. */
+    options: HybridRequestOptions;
+    /** Navigation identifier. */
+    id: string;
+    /** Current status. */
+    status: 'pending' | 'success' | 'error';
+}
+/** A page or dialog component. */
+interface View {
+    /** Name of the component to use. */
+    component: string;
+    /** Properties to apply to the component. */
+    properties: Properties;
+}
+interface Dialog extends View {
+    /** URL that is the base background page when navigating to the dialog directly. */
+    baseUrl: string;
+    /** URL to which the dialog should redirect when closed. */
+    redirectUrl: string;
+    /** Unique identifier for this modal's lifecycle. */
+    key: string;
+}
+type Property = null | string | number | boolean | Property[] | {
+    [name: string]: Property;
+};
+type Properties = Record<string | number, Property>;
+interface SwapOptions<T> {
+    /** The new component. */
+    component: T;
+    /** The new properties. */
+    properties?: any;
+    /** Whether to preserve the state of the component. */
+    preserveState?: boolean;
+    /** Current dialog. */
+    dialog?: Dialog;
+}
+type ViewComponent = any;
+type ResolveComponent = (name: string) => Promise<ViewComponent>;
+type SwapView = (options: SwapOptions<ViewComponent>) => Promise<void>;
+/** The payload of a navigation request from the server. */
+interface HybridPayload {
+    /** The view to use in this request. */
+    view: View;
+    /** An optional dialog. */
+    dialog?: Dialog;
+    /** The current page URL. */
+    url: string;
+    /** The current asset version. */
+    version: string;
+}
+interface Progress {
+    /** Base event. */
+    event: AxiosProgressEvent;
+    /** Computed percentage. */
+    percentage: Readonly<number>;
+}
+type Errors = any;
+
+interface RoutingConfiguration {
+    url: string;
+    port?: number;
+    defaults: Record<string, any>;
+    routes: Record<string, RouteDefinition>;
+}
+interface RouteDefinition {
+    uri: string;
+    method: Method[];
+    bindings: Record<string, string>;
+    domain?: string;
+    wheres?: Record<string, string>;
+    name: string;
+}
+interface GlobalRouteCollection extends RoutingConfiguration {
+}
+type RouteName = keyof GlobalRouteCollection['routes'];
+type RouteParameters<T extends RouteName> = Record<keyof GlobalRouteCollection['routes'][T]['bindings'], any> & Record<string, any>;
+
+/** Options for creating a router context. */
+interface RouterContextOptions {
+    /** The initial payload served by the browser. */
+    payload: HybridPayload;
+    /** Adapter-specific functions. */
+    adapter: Adapter;
+    /** History state serializer. */
+    serializer?: Serializer;
+    /** List of plugins. */
+    plugins?: Plugin[];
+    /** The Axios instance. */
+    axios?: Axios;
+    /** Initial routing configuration. */
+    routing?: RoutingConfiguration;
+    /** Whether to display response error modals. */
+    responseErrorModals?: boolean;
+}
+/** Router context. */
+interface InternalRouterContext {
+    /** The current, normalized URL. */
+    url: string;
+    /** The current view. */
+    view: View;
+    /** The current, optional dialog. */
+    dialog?: Dialog;
+    /** The current local asset version. */
+    version: string;
+    /** The current adapter's functions. */
+    adapter: ResolvedAdapter;
+    /** Scroll positions of the current page's DOM elements. */
+    scrollRegions: ScrollRegion[];
+    /** Arbitrary state. */
+    memo: Record<string, any>;
+    /** Currently pending navigation. */
+    pendingNavigation?: PendingNavigation;
+    /** History state serializer. */
+    serializer: Serializer;
+    /** List of plugins. */
+    plugins: Plugin[];
+    /** Global hooks. */
+    hooks: Partial<Record<keyof Hooks, Array<Function>>>;
+    /** The Axios instance. */
+    axios: Axios;
+    /** Routing configuration. */
+    routing?: RoutingConfiguration;
+    /** Whether to display response error modals. */
+    responseErrorModals?: boolean;
+    /** Cache of preload requests. */
+    preloadCache: Map<string, AxiosResponse>;
+}
+/** Router context. */
+type RouterContext = Readonly<InternalRouterContext>;
+/** Adapter-specific functions. */
+interface Adapter {
+    /** Resolves a component from the given name. */
+    resolveComponent: ResolveComponent;
+    /** Called when the view is swapped. */
+    onViewSwap: SwapView;
+    /** Called when the context is updated. */
+    onContextUpdate?: (context: InternalRouterContext) => void;
+    /** Called when a dialog is closed. */
+    onDialogClose?: (context: InternalRouterContext) => void;
+    /** Called when Hybridly is waiting for a component to be mounted. The given callback should be executed after the view component is mounted. */
+    executeOnMounted: (callback: Function) => void;
+}
+interface ResolvedAdapter extends Adapter {
+    updateRoutingConfiguration: (routing?: RoutingConfiguration) => void;
+}
+interface ScrollRegion {
+    top: number;
+    left: number;
+}
+/** Provides methods to serialize the state into the history state. */
+interface Serializer {
+    serialize: <T>(view: T) => string;
+    unserialize: <T>(state?: string) => T | undefined;
+}
+
+/** Gets the current context. */
+declare function getRouterContext(): RouterContext;
+
+/**
+ * The hybridly router.
+ * This is the core function that you can use to navigate in
+ * your application. Make sure the routes you call return a
+ * hybrid response, otherwise you need to call `external`.
+ *
+ * @example
+ * router.get('/posts/edit', { post })
+ */
+declare const router: Router;
+/** Creates the hybridly router. */
+declare function createRouter(options: RouterContextOptions): Promise<InternalRouterContext>;
+
+interface Authorizable<Authorizations extends Record<string, boolean>> {
+    authorization: Authorizations;
+}
+/**
+ * Checks whether the given data has the authorization for the given action.
+ * If the data object has no authorization definition corresponding to the given action, this method will return `false`.
+ */
+declare function can<Authorizations extends Record<string, boolean>, Data extends Authorizable<Authorizations>, Action extends keyof Data['authorization']>(resource: Data, action: Action): Authorizations[Action];
+
+/**
+ * Generates a route from the given route name.
+ */
+declare function route<T extends RouteName>(name: T, parameters?: RouteParameters<T>, absolute?: boolean): string;
+
+interface DynamicConfiguration {
+    architecture: {
+        root: string;
+    };
+    components: {
+        eager?: boolean;
+        directories: string[];
+        views: Component[];
+        layouts: Component[];
+        components: Component[];
+    };
+    routing: RoutingConfiguration;
+}
+interface Component {
+    path: string;
+    identifier: string;
+    namespace: string;
+}
+
+declare const STORAGE_EXTERNAL_KEY = "hybridly:external";
+declare const HYBRIDLY_HEADER = "x-hybrid";
+declare const EXTERNAL_NAVIGATION_HEADER = "x-hybrid-external";
+declare const PARTIAL_COMPONENT_HEADER = "x-hybrid-partial-component";
+declare const ONLY_DATA_HEADER = "x-hybrid-only-data";
+declare const DIALOG_KEY_HEADER = "x-hybrid-dialog-key";
+declare const DIALOG_REDIRECT_HEADER = "x-hybrid-dialog-redirect";
+declare const EXCEPT_DATA_HEADER = "x-hybrid-except-data";
+declare const CONTEXT_HEADER = "x-hybrid-context";
+declare const VERSION_HEADER = "x-hybrid-version";
+declare const ERROR_BAG_HEADER = "x-hybrid-error-bag";
+declare const SCROLL_REGION_ATTRIBUTE = "scroll-region";
+
+declare const constants_CONTEXT_HEADER: typeof CONTEXT_HEADER;
+declare const constants_DIALOG_KEY_HEADER: typeof DIALOG_KEY_HEADER;
+declare const constants_DIALOG_REDIRECT_HEADER: typeof DIALOG_REDIRECT_HEADER;
+declare const constants_ERROR_BAG_HEADER: typeof ERROR_BAG_HEADER;
+declare const constants_EXCEPT_DATA_HEADER: typeof EXCEPT_DATA_HEADER;
+declare const constants_EXTERNAL_NAVIGATION_HEADER: typeof EXTERNAL_NAVIGATION_HEADER;
+declare const constants_HYBRIDLY_HEADER: typeof HYBRIDLY_HEADER;
+declare const constants_ONLY_DATA_HEADER: typeof ONLY_DATA_HEADER;
+declare const constants_PARTIAL_COMPONENT_HEADER: typeof PARTIAL_COMPONENT_HEADER;
+declare const constants_SCROLL_REGION_ATTRIBUTE: typeof SCROLL_REGION_ATTRIBUTE;
+declare const constants_STORAGE_EXTERNAL_KEY: typeof STORAGE_EXTERNAL_KEY;
+declare const constants_VERSION_HEADER: typeof VERSION_HEADER;
+declare namespace constants {
+  export { constants_CONTEXT_HEADER as CONTEXT_HEADER, constants_DIALOG_KEY_HEADER as DIALOG_KEY_HEADER, constants_DIALOG_REDIRECT_HEADER as DIALOG_REDIRECT_HEADER, constants_ERROR_BAG_HEADER as ERROR_BAG_HEADER, constants_EXCEPT_DATA_HEADER as EXCEPT_DATA_HEADER, constants_EXTERNAL_NAVIGATION_HEADER as EXTERNAL_NAVIGATION_HEADER, constants_HYBRIDLY_HEADER as HYBRIDLY_HEADER, constants_ONLY_DATA_HEADER as ONLY_DATA_HEADER, constants_PARTIAL_COMPONENT_HEADER as PARTIAL_COMPONENT_HEADER, constants_SCROLL_REGION_ATTRIBUTE as SCROLL_REGION_ATTRIBUTE, constants_STORAGE_EXTERNAL_KEY as STORAGE_EXTERNAL_KEY, constants_VERSION_HEADER as VERSION_HEADER };
+}
+
+export { type Authorizable, type DynamicConfiguration, type GlobalRouteCollection, type HybridPayload, type HybridRequestOptions, type MaybePromise, type Method, type NavigationResponse, type Plugin, type Progress, type ResolveComponent, type RouteDefinition, type RouteName, type RouteParameters, type Router, type RouterContext, type RouterContextOptions, type RoutingConfiguration, type UrlResolvable, can, constants, createRouter, definePlugin, getRouterContext, makeUrl, registerHook, route, router, sameUrls };

package/dist/index.d.ts

@@ -165,6 +165,11 @@ interface NavigationOptions {
      * @internal This is an advanced property meant to be used internally.
      */
     isBackForward?: boolean;
+    /**
+     * Defines whether this navigation is the first to happen after a direct page load.
+     * @internal This is an advanced property meant to be used internally.
+     */
+    isInitial?: boolean;
 }
 type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
 interface HybridRequestOptions extends Omit<NavigationOptions, 'payload'> {
@@ -460,44 +465,31 @@ interface Component {
 
 declare const STORAGE_EXTERNAL_KEY = "hybridly:external";
 declare const HYBRIDLY_HEADER = "x-hybrid";
-declare const EXTERNAL_NAVIGATION_HEADER: string;
-declare const PARTIAL_COMPONENT_HEADER: string;
-declare const ONLY_DATA_HEADER: string;
-declare const DIALOG_KEY_HEADER: string;
-declare const DIALOG_REDIRECT_HEADER: string;
-declare const EXCEPT_DATA_HEADER: string;
-declare const CONTEXT_HEADER: string;
-declare const VERSION_HEADER: string;
-declare const ERROR_BAG_HEADER: string;
+declare const EXTERNAL_NAVIGATION_HEADER = "x-hybrid-external";
+declare const PARTIAL_COMPONENT_HEADER = "x-hybrid-partial-component";
+declare const ONLY_DATA_HEADER = "x-hybrid-only-data";
+declare const DIALOG_KEY_HEADER = "x-hybrid-dialog-key";
+declare const DIALOG_REDIRECT_HEADER = "x-hybrid-dialog-redirect";
+declare const EXCEPT_DATA_HEADER = "x-hybrid-except-data";
+declare const CONTEXT_HEADER = "x-hybrid-context";
+declare const VERSION_HEADER = "x-hybrid-version";
+declare const ERROR_BAG_HEADER = "x-hybrid-error-bag";
 declare const SCROLL_REGION_ATTRIBUTE = "scroll-region";
 
-declare const constants_STORAGE_EXTERNAL_KEY: typeof STORAGE_EXTERNAL_KEY;
-declare const constants_HYBRIDLY_HEADER: typeof HYBRIDLY_HEADER;
-declare const constants_EXTERNAL_NAVIGATION_HEADER: typeof EXTERNAL_NAVIGATION_HEADER;
-declare const constants_PARTIAL_COMPONENT_HEADER: typeof PARTIAL_COMPONENT_HEADER;
-declare const constants_ONLY_DATA_HEADER: typeof ONLY_DATA_HEADER;
+declare const constants_CONTEXT_HEADER: typeof CONTEXT_HEADER;
 declare const constants_DIALOG_KEY_HEADER: typeof DIALOG_KEY_HEADER;
 declare const constants_DIALOG_REDIRECT_HEADER: typeof DIALOG_REDIRECT_HEADER;
-declare const constants_EXCEPT_DATA_HEADER: typeof EXCEPT_DATA_HEADER;
-declare const constants_CONTEXT_HEADER: typeof CONTEXT_HEADER;
-declare const constants_VERSION_HEADER: typeof VERSION_HEADER;
 declare const constants_ERROR_BAG_HEADER: typeof ERROR_BAG_HEADER;
+declare const constants_EXCEPT_DATA_HEADER: typeof EXCEPT_DATA_HEADER;
+declare const constants_EXTERNAL_NAVIGATION_HEADER: typeof EXTERNAL_NAVIGATION_HEADER;
+declare const constants_HYBRIDLY_HEADER: typeof HYBRIDLY_HEADER;
+declare const constants_ONLY_DATA_HEADER: typeof ONLY_DATA_HEADER;
+declare const constants_PARTIAL_COMPONENT_HEADER: typeof PARTIAL_COMPONENT_HEADER;
 declare const constants_SCROLL_REGION_ATTRIBUTE: typeof SCROLL_REGION_ATTRIBUTE;
+declare const constants_STORAGE_EXTERNAL_KEY: typeof STORAGE_EXTERNAL_KEY;
+declare const constants_VERSION_HEADER: typeof VERSION_HEADER;
 declare namespace constants {
-  export {
-    constants_STORAGE_EXTERNAL_KEY as STORAGE_EXTERNAL_KEY,
-    constants_HYBRIDLY_HEADER as HYBRIDLY_HEADER,
-    constants_EXTERNAL_NAVIGATION_HEADER as EXTERNAL_NAVIGATION_HEADER,
-    constants_PARTIAL_COMPONENT_HEADER as PARTIAL_COMPONENT_HEADER,
-    constants_ONLY_DATA_HEADER as ONLY_DATA_HEADER,
-    constants_DIALOG_KEY_HEADER as DIALOG_KEY_HEADER,
-    constants_DIALOG_REDIRECT_HEADER as DIALOG_REDIRECT_HEADER,
-    constants_EXCEPT_DATA_HEADER as EXCEPT_DATA_HEADER,
-    constants_CONTEXT_HEADER as CONTEXT_HEADER,
-    constants_VERSION_HEADER as VERSION_HEADER,
-    constants_ERROR_BAG_HEADER as ERROR_BAG_HEADER,
-    constants_SCROLL_REGION_ATTRIBUTE as SCROLL_REGION_ATTRIBUTE,
-  };
+  export { constants_CONTEXT_HEADER as CONTEXT_HEADER, constants_DIALOG_KEY_HEADER as DIALOG_KEY_HEADER, constants_DIALOG_REDIRECT_HEADER as DIALOG_REDIRECT_HEADER, constants_ERROR_BAG_HEADER as ERROR_BAG_HEADER, constants_EXCEPT_DATA_HEADER as EXCEPT_DATA_HEADER, constants_EXTERNAL_NAVIGATION_HEADER as EXTERNAL_NAVIGATION_HEADER, constants_HYBRIDLY_HEADER as HYBRIDLY_HEADER, constants_ONLY_DATA_HEADER as ONLY_DATA_HEADER, constants_PARTIAL_COMPONENT_HEADER as PARTIAL_COMPONENT_HEADER, constants_SCROLL_REGION_ATTRIBUTE as SCROLL_REGION_ATTRIBUTE, constants_STORAGE_EXTERNAL_KEY as STORAGE_EXTERNAL_KEY, constants_VERSION_HEADER as VERSION_HEADER };
 }
 
-export { Authorizable, DynamicConfiguration, GlobalRouteCollection, HybridPayload, HybridRequestOptions, MaybePromise, Method, NavigationResponse, Plugin, Progress, ResolveComponent, RouteDefinition, RouteName, RouteParameters, Router, RouterContext, RouterContextOptions, RoutingConfiguration, UrlResolvable, can, constants, createRouter, definePlugin, getRouterContext, makeUrl, registerHook, route, router, sameUrls };
+export { type Authorizable, type DynamicConfiguration, type GlobalRouteCollection, type HybridPayload, type HybridRequestOptions, type MaybePromise, type Method, type NavigationResponse, type Plugin, type Progress, type ResolveComponent, type RouteDefinition, type RouteName, type RouteParameters, type Router, type RouterContext, type RouterContextOptions, type RoutingConfiguration, type UrlResolvable, can, constants, createRouter, definePlugin, getRouterContext, makeUrl, registerHook, route, router, sameUrls };

package/dist/index.mjs

@@ -1,7 +1,7 @@
+import qs from 'qs';
 import { debug, merge, removeTrailingSlash, debounce, random, hasFiles, objectToFormData, match, showResponseErrorModal, when } from '@hybridly/utils';
 import axios from 'axios';
 import { stringify, parse } from 'superjson';
-import qs from 'qs';
 
 const STORAGE_EXTERNAL_KEY = "hybridly:external";
 const HYBRIDLY_HEADER = "x-hybrid";
@@ -18,18 +18,18 @@ const SCROLL_REGION_ATTRIBUTE = "scroll-region";
 
 const constants = {
 	__proto__: null,
-	STORAGE_EXTERNAL_KEY: STORAGE_EXTERNAL_KEY,
-	HYBRIDLY_HEADER: HYBRIDLY_HEADER,
-	EXTERNAL_NAVIGATION_HEADER: EXTERNAL_NAVIGATION_HEADER,
-	PARTIAL_COMPONENT_HEADER: PARTIAL_COMPONENT_HEADER,
-	ONLY_DATA_HEADER: ONLY_DATA_HEADER,
+	CONTEXT_HEADER: CONTEXT_HEADER,
 	DIALOG_KEY_HEADER: DIALOG_KEY_HEADER,
 	DIALOG_REDIRECT_HEADER: DIALOG_REDIRECT_HEADER,
-	EXCEPT_DATA_HEADER: EXCEPT_DATA_HEADER,
-	CONTEXT_HEADER: CONTEXT_HEADER,
-	VERSION_HEADER: VERSION_HEADER,
 	ERROR_BAG_HEADER: ERROR_BAG_HEADER,
-	SCROLL_REGION_ATTRIBUTE: SCROLL_REGION_ATTRIBUTE
+	EXCEPT_DATA_HEADER: EXCEPT_DATA_HEADER,
+	EXTERNAL_NAVIGATION_HEADER: EXTERNAL_NAVIGATION_HEADER,
+	HYBRIDLY_HEADER: HYBRIDLY_HEADER,
+	ONLY_DATA_HEADER: ONLY_DATA_HEADER,
+	PARTIAL_COMPONENT_HEADER: PARTIAL_COMPONENT_HEADER,
+	SCROLL_REGION_ATTRIBUTE: SCROLL_REGION_ATTRIBUTE,
+	STORAGE_EXTERNAL_KEY: STORAGE_EXTERNAL_KEY,
+	VERSION_HEADER: VERSION_HEADER
 };
 
 class NotAHybridResponseError extends Error {
@@ -236,6 +236,7 @@ function setHistoryState(options = {}) {
   debug.history("Setting history state:", {
     method,
     context
+    // serialized,
   });
   try {
     window.history[method](serialized, "", context.url);
@@ -903,6 +904,9 @@ async function navigate(options) {
     debug.router(`Target URL is ${context.url}, current window URL is ${window.location.href}.`, { shouldReplaceHistory });
     setHistoryState({ replace: shouldReplaceHistory });
   }
+  context.adapter.executeOnMounted(() => {
+    runHooks("mounted", {}, context);
+  });
   const viewComponent = await context.adapter.resolveComponent(context.view.component);
   debug.router(`Component [${context.view.component}] resolved to:`, viewComponent);
   await context.adapter.onViewSwap({
@@ -917,9 +921,6 @@ async function navigate(options) {
     resetScrollPositions();
   }
   await runHooks("navigated", {}, options, context);
-  context.adapter.executeOnMounted(() => {
-    runHooks("mounted", {}, context);
-  });
 }
 async function performHybridRequest(targetUrl, options, abortController) {
   const context = getInternalRouterContext();
@@ -971,6 +972,7 @@ async function initializeRouter() {
       url: makeUrl(context.url, { hash: window.location.hash }).toString()
     });
     await navigate({
+      isInitial: true,
       preserveState: true,
       replace: sameUrls(context.url, window.location.href)
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hybridly/core",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "description": "Core functionality of Hybridly",
   "keywords": [
     "hybridly",
@@ -37,8 +37,8 @@
   },
   "dependencies": {
     "qs": "^6.11.2",
-    "superjson": "^1.12.4",
-    "@hybridly/utils": "0.4.2"
+    "superjson": "^1.13.1",
+    "@hybridly/utils": "0.4.4"
   },
   "devDependencies": {
     "defu": "^6.1.2"