@kitbag/router 0.20.9 → 0.20.11

package/dist/types/routerRoute.d.ts

@@ -2,12 +2,39 @@ import { RouteUpdate } from './routeUpdate';
 import { ResolvedRoute } from './resolved';
 import { QuerySource } from './querySource';
 export type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = {
+    /**
+     * Unique identifier for the route, generated by router.
+     */
     readonly id: TRoute['id'];
+    /**
+     * Identifier for the route as defined by user. Name must be unique among named routes. Name is used for routing and for matching.
+     */
     readonly name: TRoute['name'];
+    /**
+     * The specific route properties that were matched in the current route.
+     */
     readonly matched: TRoute['matched'];
+    /**
+     * 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.
+     */
     readonly matches: TRoute['matches'];
+    /**
+     * The stores for routes including ancestors.
+     * @internal
+     */
+    readonly hooks: TRoute['hooks'];
+    /**
+     * Hash value of the route.
+     */
     readonly hash: TRoute['hash'];
+    /**
+     * Update the route.
+     */
     readonly update: RouteUpdate<TRoute>;
+    /**
+     * String value of the resolved URL.
+     */
     readonly href: TRoute['href'];
     params: TRoute['params'];
     state: TRoute['state'];

package/dist/types/utilities.d.ts

@@ -15,8 +15,4 @@ export type AllPropertiesAreOptional<T> = Record<string, unknown> extends T ? tr
  * rather than string | number | symbol.
  */
 export type AsString<T> = T extends string ? T : never;
-/**
- * Extracts the keys of a union type.
- */
-export type KeysOfUnion<T> = T extends T ? keyof T : never;
 export {};

package/dist/utilities/checkMissingContext.d.ts

@@ -0,0 +1,2 @@
+import { Routes } from '../types/route';
+export declare function checkMissingContext(routes: Routes): void;

package/dist/utilities/checkMissingContext.spec copy.d.ts

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

package/dist/utilities/testHelpers.d.ts

@@ -1,4 +1,3 @@
-import { ResolvedRoute } from '../types/resolved';
 export declare const random: {
     number(options?: {
         min?: number;
@@ -9,136 +8,150 @@ export declare function getError(callback: () => any): unknown;
 export declare const component: {
     template: string;
 };
-export declare const routes: readonly [import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+export declare const routes: readonly [import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, Readonly<{}>, {}, [Omit<{
     readonly name: "parentA";
     readonly path: "/parentA/[paramA]";
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
-}]>, import('../main').Route<"parentA.childA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]/childA/[?paramB]", {
+    meta: Readonly<{}>;
+}], []> & import('../main').InternalRouteHooks<unknown>, import('../main').Route<"parentA.childA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]/childA/[?paramB]", {
     paramA: StringConstructor;
 } & {
     paramB: StringConstructor;
-}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, Readonly<{}>, {}, [Omit<{
     readonly name: "parentA";
     readonly path: "/parentA/[paramA]";
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
+    meta: Readonly<{}>;
 }, Omit<{
-    readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, Readonly<{}>, {}, [Omit<{
         readonly name: "parentA";
         readonly path: "/parentA/[paramA]";
-    }, "props"> & {
+    }, "meta" | "props"> & {
         id: string;
         props: undefined;
-    }]>;
+        meta: Readonly<{}>;
+    }], []> & import('../main').InternalRouteHooks<unknown>;
     readonly name: "parentA.childA";
     readonly path: "/childA/[?paramB]";
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
-}]>, import('../main').Route<"parentA.childB", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]/childB/[paramD]", {
+    meta: Readonly<{}>;
+}], []> & import('../main').InternalRouteHooks<unknown>, import('../main').Route<"parentA.childB", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]/childB/[paramD]", {
     paramA: StringConstructor;
 } & {
     paramD: StringConstructor;
-}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, Readonly<{}>, {}, [Omit<{
     readonly name: "parentA";
     readonly path: "/parentA/[paramA]";
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
+    meta: Readonly<{}>;
 }, Omit<{
-    readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, Readonly<{}>, {}, [Omit<{
         readonly name: "parentA";
         readonly path: "/parentA/[paramA]";
-    }, "props"> & {
+    }, "meta" | "props"> & {
         id: string;
         props: undefined;
-    }]>;
+        meta: Readonly<{}>;
+    }], []> & import('../main').InternalRouteHooks<unknown>;
     readonly name: "parentA.childB";
     readonly path: "/childB/[paramD]";
     readonly component: {
         template: string;
     };
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
-}]>, import('../main').Route<"parentA.childA.grandChildA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]/childA/[?paramB]/[paramC]", {
+    meta: Readonly<{}>;
+}], []> & import('../main').InternalRouteHooks<unknown>, import('../main').Route<"parentA.childA.grandChildA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]/childA/[?paramB]/[paramC]", {
     paramA: StringConstructor;
     paramB: StringConstructor;
 } & {
     paramC: StringConstructor;
-}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, Readonly<{}>, {}, [Omit<{
     readonly name: "parentA";
     readonly path: "/parentA/[paramA]";
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
+    meta: Readonly<{}>;
 }, Omit<{
-    readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, Readonly<{}>, {}, [Omit<{
         readonly name: "parentA";
         readonly path: "/parentA/[paramA]";
-    }, "props"> & {
+    }, "meta" | "props"> & {
         id: string;
         props: undefined;
-    }]>;
+        meta: Readonly<{}>;
+    }], []> & import('../main').InternalRouteHooks<unknown>;
     readonly name: "parentA.childA";
     readonly path: "/childA/[?paramB]";
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
+    meta: Readonly<{}>;
 }, Omit<{
     readonly parent: import('../main').Route<"parentA.childA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]/childA/[?paramB]", {
         paramA: StringConstructor;
     } & {
         paramB: StringConstructor;
-    }>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    }>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, Readonly<{}>, {}, [Omit<{
         readonly name: "parentA";
         readonly path: "/parentA/[paramA]";
-    }, "props"> & {
+    }, "meta" | "props"> & {
         id: string;
         props: undefined;
+        meta: Readonly<{}>;
     }, Omit<{
-        readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+        readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, Readonly<{}>, {}, [Omit<{
             readonly name: "parentA";
             readonly path: "/parentA/[paramA]";
-        }, "props"> & {
+        }, "meta" | "props"> & {
             id: string;
             props: undefined;
-        }]>;
+            meta: Readonly<{}>;
+        }], []> & import('../main').InternalRouteHooks<unknown>;
         readonly name: "parentA.childA";
         readonly path: "/childA/[?paramB]";
-    }, "props"> & {
+    }, "meta" | "props"> & {
         id: string;
         props: undefined;
-    }]>;
+        meta: Readonly<{}>;
+    }], []> & import('../main').InternalRouteHooks<unknown>;
     readonly name: "parentA.childA.grandChildA";
     readonly path: "/[paramC]";
     readonly component: {
         template: string;
     };
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
-}]>, import('../main').Route<"parentB", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentB", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    meta: Readonly<{}>;
+}], []> & import('../main').InternalRouteHooks<unknown>, import('../main').Route<"parentB", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentB", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, Readonly<{}>, {}, [Omit<{
     readonly name: "parentB";
     readonly path: "/parentB";
     readonly component: {
         template: string;
     };
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
-}]>, import('../main').Route<"parentC", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    meta: Readonly<{}>;
+}], []> & import('../main').InternalRouteHooks<unknown>, import('../main').Route<"parentC", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, Readonly<{}>, {}, [Omit<{
     readonly name: "parentC";
     readonly path: "/";
     readonly component: {
         template: string;
     };
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
-}]>];
-export declare function mockRoute(name: string): ResolvedRoute['matched'];
-export declare function mockResolvedRoute(matched: ResolvedRoute['matched'], matches: ResolvedRoute['matched'][]): ResolvedRoute;
+    meta: Readonly<{}>;
+}], []> & import('../main').InternalRouteHooks<unknown>];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kitbag/router",
   "private": false,
-  "version": "0.20.9",
+  "version": "0.20.11",
   "bugs": {
     "url": "https://github.com/kitbagjs/router/issues"
   },
@@ -41,25 +41,26 @@
   },
   "devDependencies": {
     "@kitbag/eslint-config": "1.0.2",
-    "@vitejs/plugin-vue": "^6.0.1",
+    "@vitejs/plugin-vue": "^6.0.3",
     "@vue/test-utils": "^2.4.6",
-    "eslint": "^9.39.1",
+    "eslint": "^9.39.2",
     "globals": "^16.5.0",
-    "happy-dom": "^20.0.8",
-    "typedoc": "^0.28.14",
+    "happy-dom": "^20.0.11",
+    "typedoc": "^0.28.15",
     "typedoc-plugin-markdown": "^4.9.0",
     "typedoc-vitepress-theme": "^1.1.2",
     "typescript": "^5.9.3",
     "valibot": "^1.0.0",
-    "vite": "^7.1.12",
+    "vite": "^7.3.0",
     "vite-plugin-dts": "^4.5.4",
     "vitepress": "^1.6.4",
-    "vitest": "^4.0.4",
-    "vue-tsc": "^3.1.2"
+    "vitest": "^4.0.16",
+    "vue-tsc": "^3.2.1",
+    "zod": "4.0.0"
   },
   "peerDependencies": {
     "vue": "^3.5.0",
-    "zod": "^3.24.1"
+    "zod": "4.0.0"
   },
   "peerDependenciesMeta": {
     "zod": {

package/dist/errors/callbackContextRejectionError.d.ts

@@ -1,6 +0,0 @@
-import { RegisteredRejectionType } from '../types/register';
-import { CallbackRejectResponse } from '../services/createCallbackContext';
-export declare class CallbackContextRejectionError extends Error {
-    response: CallbackRejectResponse;
-    constructor(type: RegisteredRejectionType);
-}