@kitbag/router 0.24.2 → 0.25.0

package/dist/utilities/components.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utilities/guards.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utilities/isBrowser.browser.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utilities/isBrowser.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/{src/utilities → utilities}/isNamedRoute.d.ts

@@ -1,4 +1,4 @@
-import { Route } from '../../types/route';
+import { Route } from '../types/route';
 export declare function isNamedRoute(route: Route): route is Route & {
     name: string;
 };

package/dist/{src/utilities → utilities}/prefetch.d.ts

@@ -1,4 +1,4 @@
-import { PrefetchConfig, PrefetchConfigOptions, PrefetchConfigs, PrefetchStrategy } from '../../types/prefetch';
+import { PrefetchConfig, PrefetchConfigOptions, PrefetchConfigs, PrefetchStrategy } from '../types/prefetch';
 export declare const DEFAULT_PREFETCH_STRATEGY: PrefetchStrategy;
-export declare function getPrefetchOption({ routerPrefetch, routePrefetch, linkPrefetch }: PrefetchConfigs, setting: keyof PrefetchConfigOptions): false | PrefetchStrategy;
+export declare function getPrefetchOption({ routerPrefetch, routePrefetch, viewPrefetch, linkPrefetch }: PrefetchConfigs, setting: keyof PrefetchConfigOptions): false | PrefetchStrategy;
 export declare function getPrefetchConfigValue(prefetch: PrefetchConfig | undefined, setting: keyof PrefetchConfigOptions): boolean | PrefetchStrategy | undefined;

package/dist/utilities/prefetch.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utilities/props.d.ts

@@ -0,0 +1,16 @@
+import { MaybePromise } from '../types/utilities';
+/**
+ * How a props getter settled. Tagged so that a getter returning `undefined` or an `Error` stays a value.
+ */
+export type PropsResult = {
+    kind: 'value';
+    value: unknown;
+} | {
+    kind: 'error';
+    error: unknown;
+};
+/**
+ * Runs a props callback and captures how it settled rather than letting it throw, so that navigation can
+ * tell a push or rejection apart from a genuine failure. Sync getters settle synchronously.
+ */
+export declare function getPropsValue(callback: () => unknown): MaybePromise<PropsResult>;

package/dist/{src/utilities → utilities}/setDocumentTitle.d.ts

@@ -1,2 +1,2 @@
-import { ResolvedRoute } from '../../types/resolved';
+import { ResolvedRoute } from '../types/resolved';
 export declare function setDocumentTitle(to: ResolvedRoute | null): void;

package/dist/utilities/testHelpers.d.ts

@@ -0,0 +1,242 @@
+export declare const random: {
+    number(options?: {
+        min?: number;
+        max?: number;
+    }): number;
+};
+export declare function getError(callback: () => any): unknown;
+export declare const component: {
+    template: string;
+};
+export declare const routes: readonly [import('../types/routeWithMethods').RouteWithMethods<import('../types/url').ToUrl<{
+    readonly name: "parentA";
+    readonly path: "/parentA/[paramA]";
+}>, [Omit<{
+    readonly name: "parentA";
+    readonly path: "/parentA/[paramA]";
+}, "meta" | "component" | "components" | "name" | "parent"> & {
+    id: string;
+    name: "parentA";
+    meta: Readonly<{}>;
+    views: {};
+    loaders: {};
+}]>, import('../types/routeWithMethods').RouteWithMethods<import('../main').Url<{
+    paramA: {
+        param: StringConstructor;
+        isOptional: false;
+        isGreedy: false;
+    };
+    paramB: {
+        param: StringConstructor;
+        isOptional: true;
+        isGreedy: false;
+    };
+}>, [Omit<{
+    readonly name: "parentA";
+    readonly path: "/parentA/[paramA]";
+}, "meta" | "component" | "components" | "name" | "parent"> & {
+    id: string;
+    name: "parentA";
+    meta: Readonly<{}>;
+    views: {};
+    loaders: {};
+}, Omit<{
+    readonly parent: import('../types/routeWithMethods').RouteWithMethods<import('../types/url').ToUrl<{
+        readonly name: "parentA";
+        readonly path: "/parentA/[paramA]";
+    }>, [Omit<{
+        readonly name: "parentA";
+        readonly path: "/parentA/[paramA]";
+    }, "meta" | "component" | "components" | "name" | "parent"> & {
+        id: string;
+        name: "parentA";
+        meta: Readonly<{}>;
+        views: {};
+        loaders: {};
+    }]>;
+    readonly name: "parentA.childA";
+    readonly path: "/childA/[?paramB]";
+}, "meta" | "component" | "components" | "name" | "parent"> & {
+    id: string;
+    name: "parentA.childA";
+    meta: Readonly<{}>;
+    views: {};
+    loaders: {};
+}]>, import('../types/routeWithMethods').RouteWithMethods<import('../main').Url<{
+    paramA: {
+        param: StringConstructor;
+        isOptional: false;
+        isGreedy: false;
+    };
+    paramD: {
+        param: StringConstructor;
+        isOptional: false;
+        isGreedy: false;
+    };
+}>, [Omit<{
+    readonly name: "parentA";
+    readonly path: "/parentA/[paramA]";
+}, "meta" | "component" | "components" | "name" | "parent"> & {
+    id: string;
+    name: "parentA";
+    meta: Readonly<{}>;
+    views: {};
+    loaders: {};
+}, Omit<{
+    readonly parent: import('../types/routeWithMethods').RouteWithMethods<import('../types/url').ToUrl<{
+        readonly name: "parentA";
+        readonly path: "/parentA/[paramA]";
+    }>, [Omit<{
+        readonly name: "parentA";
+        readonly path: "/parentA/[paramA]";
+    }, "meta" | "component" | "components" | "name" | "parent"> & {
+        id: string;
+        name: "parentA";
+        meta: Readonly<{}>;
+        views: {};
+        loaders: {};
+    }]>;
+    readonly name: "parentA.childB";
+    readonly path: "/childB/[paramD]";
+    readonly component: {
+        template: string;
+    };
+}, "meta" | "component" | "components" | "name" | "parent"> & {
+    id: string;
+    name: "parentA.childB";
+    meta: Readonly<{}>;
+    views: {};
+    loaders: {};
+}]>, import('../types/routeWithMethods').RouteWithMethods<import('../main').Url<{
+    paramA: {
+        param: StringConstructor;
+        isOptional: false;
+        isGreedy: false;
+    };
+    paramB: {
+        param: StringConstructor;
+        isOptional: true;
+        isGreedy: false;
+    };
+    paramC: {
+        param: StringConstructor;
+        isOptional: false;
+        isGreedy: false;
+    };
+}>, [Omit<{
+    readonly name: "parentA";
+    readonly path: "/parentA/[paramA]";
+}, "meta" | "component" | "components" | "name" | "parent"> & {
+    id: string;
+    name: "parentA";
+    meta: Readonly<{}>;
+    views: {};
+    loaders: {};
+}, Omit<{
+    readonly parent: import('../types/routeWithMethods').RouteWithMethods<import('../types/url').ToUrl<{
+        readonly name: "parentA";
+        readonly path: "/parentA/[paramA]";
+    }>, [Omit<{
+        readonly name: "parentA";
+        readonly path: "/parentA/[paramA]";
+    }, "meta" | "component" | "components" | "name" | "parent"> & {
+        id: string;
+        name: "parentA";
+        meta: Readonly<{}>;
+        views: {};
+        loaders: {};
+    }]>;
+    readonly name: "parentA.childA";
+    readonly path: "/childA/[?paramB]";
+}, "meta" | "component" | "components" | "name" | "parent"> & {
+    id: string;
+    name: "parentA.childA";
+    meta: Readonly<{}>;
+    views: {};
+    loaders: {};
+}, Omit<{
+    readonly parent: import('../types/routeWithMethods').RouteWithMethods<import('../main').Url<{
+        paramA: {
+            param: StringConstructor;
+            isOptional: false;
+            isGreedy: false;
+        };
+        paramB: {
+            param: StringConstructor;
+            isOptional: true;
+            isGreedy: false;
+        };
+    }>, [Omit<{
+        readonly name: "parentA";
+        readonly path: "/parentA/[paramA]";
+    }, "meta" | "component" | "components" | "name" | "parent"> & {
+        id: string;
+        name: "parentA";
+        meta: Readonly<{}>;
+        views: {};
+        loaders: {};
+    }, Omit<{
+        readonly parent: import('../types/routeWithMethods').RouteWithMethods<import('../types/url').ToUrl<{
+            readonly name: "parentA";
+            readonly path: "/parentA/[paramA]";
+        }>, [Omit<{
+            readonly name: "parentA";
+            readonly path: "/parentA/[paramA]";
+        }, "meta" | "component" | "components" | "name" | "parent"> & {
+            id: string;
+            name: "parentA";
+            meta: Readonly<{}>;
+            views: {};
+            loaders: {};
+        }]>;
+        readonly name: "parentA.childA";
+        readonly path: "/childA/[?paramB]";
+    }, "meta" | "component" | "components" | "name" | "parent"> & {
+        id: string;
+        name: "parentA.childA";
+        meta: Readonly<{}>;
+        views: {};
+        loaders: {};
+    }]>;
+    readonly name: "parentA.childA.grandChildA";
+    readonly path: "/[paramC]";
+    readonly component: {
+        template: string;
+    };
+}, "meta" | "component" | "components" | "name" | "parent"> & {
+    id: string;
+    name: "parentA.childA.grandChildA";
+    meta: Readonly<{}>;
+    views: {};
+    loaders: {};
+}]>, import('../types/routeWithMethods').RouteWithMethods<import('../types/url').ToUrl<{
+    readonly name: "parentB";
+    readonly path: "/parentB";
+}>, [Omit<{
+    readonly name: "parentB";
+    readonly path: "/parentB";
+    readonly component: {
+        template: string;
+    };
+}, "meta" | "component" | "components" | "name" | "parent"> & {
+    id: string;
+    name: "parentB";
+    meta: Readonly<{}>;
+    views: {};
+    loaders: {};
+}]>, import('../types/routeWithMethods').RouteWithMethods<import('../types/url').ToUrl<{
+    readonly name: "parentC";
+    readonly path: "/";
+}>, [Omit<{
+    readonly name: "parentC";
+    readonly path: "/";
+    readonly component: {
+        template: string;
+    };
+}, "meta" | "component" | "components" | "name" | "parent"> & {
+    id: string;
+    name: "parentC";
+    meta: Readonly<{}>;
+    views: {};
+    loaders: {};
+}]>];

package/dist/utilities/trailingSlashes.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/{src/utilities → utilities}/urlSearchParams.d.ts

@@ -1,2 +1,2 @@
-import { QuerySource } from '../../types/querySource';
+import { QuerySource } from '../types/querySource';
 export declare function combineUrlSearchParams(...paramGroups: (URLSearchParams | QuerySource)[]): URLSearchParams;

package/dist/utilities/urlSearchParams.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kitbag/router",
   "private": false,
-  "version": "0.24.2",
+  "version": "0.25.0",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/kitbagjs/router/issues"
@@ -17,6 +17,7 @@
   "homepage": "https://github.com/kitbagjs/router#readme",
   "scripts": {
     "build": "vite build",
+    "prepublishOnly": "npm run build",
     "build:watch": "vite build --watch --minify=false",
     "dev": "vite build --watch --minify=false",
     "test": "vitest",
@@ -42,22 +43,23 @@
     }
   },
   "devDependencies": {
-    "@kitbag/eslint-config": "1.0.2",
-    "@vitejs/plugin-vue": "^6.0.5",
-    "@vue/test-utils": "^2.4.10",
-    "eslint": "^9.39.4",
-    "globals": "^17.5.0",
-    "happy-dom": "^20.9.0",
-    "typedoc": "^0.28.19",
-    "typedoc-plugin-markdown": "^4.11.0",
-    "typedoc-vitepress-theme": "^1.1.2",
-    "typescript": "^6.0.2",
+    "@kitbag/eslint-config": "1.0.6",
+    "@vitejs/plugin-vue": "^6.0.8",
+    "@vue/language-core": "^3.3.9",
+    "@vue/test-utils": "^2.4.11",
+    "eslint": "^9.39.5",
+    "globals": "^17.9.0",
+    "happy-dom": "^20.11.2",
+    "typedoc": "^0.28.20",
+    "typedoc-plugin-markdown": "^4.12.0",
+    "typedoc-vitepress-theme": "^1.1.3",
+    "typescript": "^6.0.3",
     "valibot": "^1.0.0",
-    "vite": "^8.0.3",
-    "vite-plugin-dts": "^4.5.4",
+    "vite": "^8.2.0",
+    "vite-plugin-dts": "^5.0.3",
     "vitepress": "^1.6.4",
-    "vitest": "^4.1.5",
-    "vue-tsc": "^3.2.6",
+    "vitest": "^4.1.10",
+    "vue-tsc": "^3.3.8",
     "zod": "4.0.0"
   },
   "peerDependencies": {
@@ -71,6 +73,6 @@
   },
   "dependencies": {
     "@standard-schema/spec": "^1.0.0",
-    "@vue/devtools-api": "^8.1.1"
+    "@vue/devtools-api": "^8.2.1"
   }
 }

package/dist/src/compositions/usePropStore.d.ts

@@ -1,7 +0,0 @@
-import { InjectionKey } from 'vue';
-import { PropStore } from '../../services/createPropStore';
-import { Router } from '../../types/router';
-export declare const getPropStoreInjectionKey: (routerKey: InjectionKey<Router>) => InjectionKey<PropStore>;
-type UsePropStore = () => PropStore;
-export declare function createUsePropStore<TRouter extends Router>(routerKey: InjectionKey<TRouter>): UsePropStore;
-export {};

package/dist/src/services/createCurrentRoute.d.ts

@@ -1,13 +0,0 @@
-import { InjectionKey } from 'vue';
-import { Router, RouterRouteUnion } from '../../types/router';
-import { ResolvedRoute } from '../../types/resolved';
-import { Routes } from '../../types/route';
-import { RouterPush } from '../../types/routerPush';
-type ResolvedRouteUpdate = (route: ResolvedRoute) => void;
-type CurrentRouteContext<TRoutes extends Routes = Routes> = {
-    currentRoute: ResolvedRoute;
-    routerRoute: RouterRouteUnion<TRoutes>;
-    updateRoute: ResolvedRouteUpdate;
-};
-export declare function createCurrentRoute<TRoutes extends Routes>(routerKey: InjectionKey<Router>, fallbackRoute: ResolvedRoute, push: RouterPush): CurrentRouteContext<TRoutes>;
-export {};

package/dist/src/services/createPropStore.d.ts

@@ -1,13 +0,0 @@
-import { PrefetchConfigs, PrefetchStrategy } from '../../types/prefetch';
-import { ResolvedRoute } from '../../types/resolved';
-import { HasVueAppStore } from './createVueAppStore';
-import { CallbackContextPush, CallbackContextReject, CallbackContextSuccess } from '../../types/callbackContext';
-type SetPropsResponse = CallbackContextSuccess | CallbackContextPush | CallbackContextReject;
-export type PropStore = HasVueAppStore & {
-    getPrefetchProps: (strategy: PrefetchStrategy, route: ResolvedRoute, configs: PrefetchConfigs) => Record<string, unknown>;
-    setPrefetchProps: (props: Record<string, unknown>) => void;
-    setProps: (route: ResolvedRoute) => Promise<SetPropsResponse>;
-    getProps: (id: string, name: string, route: ResolvedRoute) => unknown;
-};
-export declare function createPropStore(): PropStore;
-export {};

package/dist/src/services/createResolvedRoute.d.ts

@@ -1,4 +0,0 @@
-import { RouterResolveOptions } from '../../types/routerResolve';
-import { ResolvedRoute } from '../../types/resolved';
-import { Route } from '../../types/route';
-export declare function createResolvedRoute(route: Route, params?: Record<string, unknown>, options?: RouterResolveOptions): ResolvedRoute;

package/dist/src/services/createRouterRoute.d.ts

@@ -1,7 +0,0 @@
-import { InjectionKey } from 'vue';
-import { ResolvedRoute } from '../../types/resolved';
-import { RouterRoute } from '../../types/routerRoute';
-import { RouterPush } from '../../types/routerPush';
-import { Router } from '../../types/router';
-export declare function isRouterRoute(routerKey: InjectionKey<Router>, value: unknown): value is RouterRoute;
-export declare function createRouterRoute<TRoute extends ResolvedRoute>(routerKey: InjectionKey<Router>, route: TRoute, push: RouterPush): RouterRoute<TRoute>;

package/dist/src/services/getGlobalHooksForRouter.d.ts

@@ -1,3 +0,0 @@
-import { Hooks } from '../../models/hooks';
-import { RouterPlugin } from '../../types/routerPlugin';
-export declare function getGlobalHooksForRouter(plugins?: RouterPlugin[]): Hooks;

package/dist/src/services/getRejectionHooks.d.ts

@@ -1,3 +0,0 @@
-import { Hooks } from '../../models/hooks';
-import { Rejection } from '../../types/rejection';
-export declare function getRejectionHooksFromRejection(rejection: Rejection): Hooks;

package/dist/src/services/unionOf.d.ts

@@ -1,3 +0,0 @@
-import { Param, ParamGetSet } from '../../types/paramTypes';
-import { ExtractParamType } from '../../types/params';
-export declare function unionOf<const T extends Param[]>(params: T): ParamGetSet<ExtractParamType<T[number]>>;

package/dist/src/types/route.d.ts

@@ -1,80 +0,0 @@
-import { Param } from '../../types/paramTypes';
-import { PrefetchConfig } from '../../types/prefetch';
-import { RouteMeta } from '../../types/register';
-import { LastInArray } from '../../types/utilities';
-import { CreateRouteOptions } from '../../types/createRouteOptions';
-import { RouteContext } from '../../types/routeContext';
-import { Url } from '../../types/url';
-import { GetRouteTitle } from '../../types/routeTitle';
-import { Hooks } from '../../models/hooks';
-import { RouteRedirect } from './redirects';
-export declare const IS_ROUTE_SYMBOL: unique symbol;
-export declare function isRoute(value: unknown): value is Route & RouteInternal;
-export type RouteInternal = {
-    [IS_ROUTE_SYMBOL]: true;
-    depth: number;
-    hooks: Hooks[];
-    redirect: RouteRedirect;
-    getTitle: GetRouteTitle;
-};
-/**
- * Represents an immutable array of Route instances. Return value of `createRoute`, expected param for `createRouter`.
- */
-export type Routes = readonly Route[];
-/**
- * The Route properties originally provided to `createRoute`. The only change is normalizing meta to always default to an empty object.
- */
-export type CreatedRouteOptions = Omit<CreateRouteOptions, 'props'> & {
-    id: string;
-    props?: unknown;
-};
-/**
- * Represents the structure of a route within the application. Return value of `createRoute`
- * @template TName - Represents the unique name identifying the route, typically a string.
- * @template TPath - The type or structure of the route's path.
- * @template TQuery - The type or structure of the query parameters associated with the route.
- */
-export type Route<TName extends string = string, TUrl extends Url = Url, TMeta extends RouteMeta = RouteMeta, TState extends Record<string, Param> = Record<string, Param>, TMatches extends CreatedRouteOptions[] = CreatedRouteOptions[], TContext extends RouteContext[] = RouteContext[]> = TUrl & {
-    /**
-     * Unique identifier for the route, generated by router.
-    */
-    id: string;
-    /**
-     * The specific route properties that were matched in the current route.
-    */
-    matched: LastInArray<TMatches, CreatedRouteOptions>;
-    /**
-     * The specific route properties that were matched in the current route, including any ancestors.
-     * Order of routes will be from greatest ancestor to narrowest matched.
-    */
-    matches: TMatches;
-    /**
-     * Identifier for the route as defined by user. Name must be unique among named routes. Name is used for routing and for matching.
-    */
-    name: TName;
-    /**
-     * Represents additional metadata associated with a route, combined with any parents.
-    */
-    meta: TMeta;
-    /**
-     * Represents the schema of the route state, combined with any parents.
-    */
-    state: TState;
-    /**
-     * Determines what assets are prefetched when router-link is rendered for this route. Overrides router level prefetch.
-    */
-    prefetch?: PrefetchConfig;
-    /**
-     * Related routes and rejections for the route. The context is exposed to the hooks and props callback functions for this route.
-     */
-    context: TContext;
-};
-export type GenericRoute = Url & {
-    id: string;
-    name: string;
-    matched: CreatedRouteOptions;
-    matches: CreatedRouteOptions[];
-    meta: RouteMeta;
-    state: Record<string, Param>;
-    prefetch?: PrefetchConfig;
-};

package/dist/src/utilities/props.d.ts

@@ -1,6 +0,0 @@
-/**
- * Takes a props callback and returns a value
- * For sync props, this will return the props value or an error.
- * For async props, this will return a promise that resolves to the props value or an error.
- */
-export declare function getPropsValue(callback: () => unknown): unknown;