@simonbackx/vue-app-navigation 2.14.0 → 2.15.0

package/dist/index.js

@@ -384,7 +384,11 @@ class HistoryManagerStatic {
       state.title = title;
     } else {
       const state = this.states[index];
-      if (!state || state.index !== index) {
+      if (!state) {
+        console.error("Search state with index ", index, "not found");
+        return;
+      }
+      if (state.index !== index) {
         console.error("Search state with index ", index, "but received state with index", state.index);
         return;
       }
@@ -1846,13 +1850,21 @@ function addCheckRoutesMountedHandler() {
     return;
   }
   instance._didAddCheckRoutesMountedHandler = true;
+  let doDeactivate = false;
+  onBeforeUnmount(() => {
+    if (component && doDeactivate) {
+      component.checkRoutes = false;
+    }
+  });
   onMounted(async () => {
     if (component && component.checkRoutes) {
-      component.checkRoutes = false;
+      doDeactivate = true;
       if ("_navigationCheckRoutesHandlers" in instance && Array.isArray(instance._navigationCheckRoutesHandlers)) {
         for (const handler of instance._navigationCheckRoutesHandlers) {
           if (typeof handler === "function") {
-            await handler();
+            if (await handler() === true) {
+              return;
+            }
           } else {
             console.error("Invalid checkRoutes handler", handler);
           }
@@ -1862,7 +1874,9 @@ function addCheckRoutesMountedHandler() {
       if ("_navigationNotCheckRoutesHandlers" in instance && Array.isArray(instance._navigationNotCheckRoutesHandlers)) {
         for (const handler of instance._navigationNotCheckRoutesHandlers) {
           if (typeof handler === "function") {
-            await handler();
+            if (await handler() === true) {
+              return;
+            }
           } else {
             console.error("Invalid not checkRoutes handler", handler);
           }

package/dist/src/utils/navigationHooks.d.ts

@@ -67,7 +67,10 @@ export type NavigationOptions<T> = {
 export declare function usePop(): (options?: PopOptions) => Promise<void> | undefined;
 export declare function useNavigate(): <Params extends Record<string, unknown>>(prop1: string | Route<Params>, prop2?: RouteNavigationOptions<Params>) => Promise<void>;
 export type DefaultRouteHandler = () => Promise<boolean>;
-export type OnCheckRoutesHandler = () => Promise<void> | void;
+/**
+ * Return true when the route has been handled and other route checks should not be executed.
+ */
+export type OnCheckRoutesHandler = () => Promise<void | boolean> | void | boolean;
 export declare function onCheckRoutes(handler: OnCheckRoutesHandler): void;
 export declare function onNotCheckRoutes(handler: OnCheckRoutesHandler): void;
 export declare function defineRoutes(routes: (Route<any>[]) | (() => Promise<boolean | (Route<any>[])>)): void;

package/package.json

@@ -2,7 +2,7 @@
     "name": "@simonbackx/vue-app-navigation",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
-    "version": "2.14.0",
+    "version": "2.15.0",
     "exports": {
         ".": {
             "import": "./dist/index.js",