@kitbag/router 0.20.8 → 0.20.10

package/dist/types/router.d.ts

@@ -121,6 +121,11 @@ export type Router<TRoutes extends Routes = any, TOptions extends RouterOptions
      * Registers a hook to be called after a route is updated.
      */
     onAfterRouteUpdate: AddRouterAfterRouteHook<TRoutes | TPlugin['routes'], keyof TOptions['rejections'] | KeysOfUnion<TPlugin['rejections']>>;
+    /**
+     * Registers a hook to be called when an error occurs.
+     * If the hook returns true, the error is considered handled and the other hooks are not run. If all hooks return false the error is rethrown
+     */
+    onError: AddRouterErrorHook<TRoutes | TPlugin['routes'], keyof TOptions['rejections'] | KeysOfUnion<TPlugin['rejections']>>;
     /**
     * Given a URL, returns true if host does not match host stored on router instance
     */
@@ -168,6 +173,22 @@ export type RouterAfterRouteHook<TRoutes extends Routes, TRejections extends Pro
 export type AddRouterAfterRouteHook<TRoutes extends Routes, TRejections extends PropertyKey> = (hook: RouterAfterRouteHook<TRoutes, TRejections>) => RouteHookRemove;
 export type RouterRouteHookBeforeRunner<TRoutes extends Routes> = (context: HookContext<TRoutes>) => Promise<BeforeRouteHookResponse>;
 export type RouterRouteHookAfterRunner<TRoutes extends Routes> = (context: HookContext<TRoutes>) => Promise<AfterRouteHookResponse>;
+export type RouterErrorHookContext<TRoutes extends Routes, TRejections extends PropertyKey> = {
+    to: RouterResolvedRouteUnion<TRoutes>;
+    from: RouterResolvedRouteUnion<TRoutes> | null;
+    source: 'props' | 'hook' | 'component';
+    reject: RouterReject<TRejections>;
+    push: RouterPush<TRoutes>;
+    replace: RouterReplace<TRoutes>;
+};
+export type RouterErrorHook<TRoutes extends Routes, TRejections extends PropertyKey> = (error: unknown, context: RouterErrorHookContext<TRoutes, TRejections>) => void;
+export type AddRouterErrorHook<TRoutes extends Routes, TRejections extends PropertyKey> = (hook: RouterErrorHook<TRoutes, TRejections>) => RouteHookRemove;
+export type RouterRouteHookErrorRunnerContext<TRoutes extends Routes> = {
+    to: RouterResolvedRouteUnion<TRoutes>;
+    from: RouterResolvedRouteUnion<TRoutes> | null;
+    source: 'props' | 'hook';
+};
+export type RouterRouteHookErrorRunner<TRoutes extends Routes> = (error: unknown, context: RouterRouteHookErrorRunnerContext<TRoutes>) => void;
 /**
  * This type is the same as `RouterRoute<ResolvedRoute<TRoutes[number]>>` while remaining distributive
  */

package/dist/utilities/testHelpers.d.ts

@@ -9,136 +9,152 @@ 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;
+    meta: Readonly<{}>;
 }]>, 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<{}>;
     }]>;
     readonly name: "parentA.childA";
     readonly path: "/childA/[?paramB]";
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
+    meta: Readonly<{}>;
 }]>, 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<{}>;
     }]>;
     readonly name: "parentA.childB";
     readonly path: "/childB/[paramD]";
     readonly component: {
         template: string;
     };
-}, "props"> & {
+}, "meta" | "props"> & {
     id: string;
     props: undefined;
+    meta: Readonly<{}>;
 }]>, 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<{}>;
     }]>;
     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<{}>;
         }]>;
         readonly name: "parentA.childA";
         readonly path: "/childA/[?paramB]";
-    }, "props"> & {
+    }, "meta" | "props"> & {
         id: string;
         props: undefined;
+        meta: Readonly<{}>;
     }]>;
     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').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').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;
+    meta: Readonly<{}>;
 }]>];
 export declare function mockRoute(name: string): ResolvedRoute['matched'];
 export declare function mockResolvedRoute(matched: ResolvedRoute['matched'], matches: ResolvedRoute['matched'][]): ResolvedRoute;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kitbag/router",
   "private": false,
-  "version": "0.20.8",
+  "version": "0.20.10",
   "bugs": {
     "url": "https://github.com/kitbagjs/router/issues"
   },
@@ -17,7 +17,7 @@
   "scripts": {
     "build": "vite build",
     "build:watch": "vite build --watch --minify=false",
-    "test": "vitest --typecheck",
+    "test": "vitest",
     "lint": "eslint ./src",
     "lint:fix": "eslint ./src --fix",
     "types": "vue-tsc --noEmit",
@@ -41,21 +41,22 @@
   },
   "devDependencies": {
     "@kitbag/eslint-config": "1.0.2",
-    "@vitejs/plugin-vue": "^6.0.1",
+    "@vitejs/plugin-vue": "^6.0.2",
     "@vue/test-utils": "^2.4.6",
     "eslint": "^9.39.1",
     "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.2.4",
     "vite-plugin-dts": "^4.5.4",
     "vitepress": "^1.6.4",
-    "vitest": "^4.0.4",
-    "vue-tsc": "^3.1.2"
+    "vitest": "^4.0.15",
+    "vue-tsc": "^3.1.5",
+    "zod": "^3.24.1"
   },
   "peerDependencies": {
     "vue": "^3.5.0",