@simonbackx/vue-app-navigation 2.4.1 → 2.5.0

package/dist/index.js

@@ -705,6 +705,10 @@ const _ComponentWithProperties = class _ComponentWithProperties {
   ownsHistoryIndex() {
     return this.historyIndex !== null && _ComponentWithProperties.historyIndexOwners.get(this.historyIndex) === this;
   }
+  overrideUrl(url, title) {
+    this.provide.reactive_navigation_url = url;
+    this.setUrl(url, title);
+  }
   setUrl(url, title) {
     if (this.historyIndex === null) {
       if (_ComponentWithProperties.debug)
@@ -1817,6 +1821,44 @@ function getCurrentRoutes() {
 function onCheckRoutes(handler) {
   const instance = getCurrentInstance();
   instance._navigationCheckRoutesHandlers = [...instance._navigationCheckRoutes ?? [], handler];
+  addCheckRoutesMountedHandler();
+}
+function onNotCheckRoutes(handler) {
+  const instance = getCurrentInstance();
+  instance._navigationNotCheckRoutesHandlers = [...instance._navigationNotCheckRoutesHandlers ?? [], handler];
+  addCheckRoutesMountedHandler();
+}
+function addCheckRoutesMountedHandler() {
+  const instance = getCurrentInstance();
+  const component = useCurrentComponent();
+  if (instance._didAddCheckRoutesMountedHandler) {
+    return;
+  }
+  instance._didAddCheckRoutesMountedHandler = true;
+  onMounted(async () => {
+    if (component && component.checkRoutes) {
+      component.checkRoutes = false;
+      if ("_navigationCheckRoutesHandlers" in instance && Array.isArray(instance._navigationCheckRoutesHandlers)) {
+        for (const handler of instance._navigationCheckRoutesHandlers) {
+          if (typeof handler === "function") {
+            await handler();
+          } else {
+            console.error("Invalid checkRoutes handler", handler);
+          }
+        }
+      }
+    } else {
+      if ("_navigationNotCheckRoutesHandlers" in instance && Array.isArray(instance._navigationNotCheckRoutesHandlers)) {
+        for (const handler of instance._navigationNotCheckRoutesHandlers) {
+          if (typeof handler === "function") {
+            await handler();
+          } else {
+            console.error("Invalid not checkRoutes handler", handler);
+          }
+        }
+      }
+    }
+  });
 }
 function defineRoutes(routes) {
   const component = useCurrentComponent();
@@ -1887,42 +1929,32 @@ function defineRoutes(routes) {
       }
     }
   };
-  onMounted(async () => {
-    if (component && component.checkRoutes) {
-      component.checkRoutes = false;
-      if ("_navigationCheckRoutesHandlers" in component && Array.isArray(component._navigationCheckRoutesHandlers)) {
-        for (const handler of component._navigationCheckRoutesHandlers) {
-          if (typeof handler === "function") {
-            await handler();
-          } else {
-            console.error("Invalid checkRoutes handler", handler);
-          }
-        }
+  onCheckRoutes(async () => {
+    if (Array.isArray(routes)) {
+      if (await handleRoutes(routes)) {
+        setDefaultHandler();
+        return;
       }
-      if (Array.isArray(routes)) {
-        if (await handleRoutes(routes)) {
+    } else {
+      const extraRoutes = await routes();
+      if (Array.isArray(extraRoutes)) {
+        if (await handleRoutes(extraRoutes)) {
           setDefaultHandler();
           return;
         }
       } else {
-        const extraRoutes = await routes();
-        if (Array.isArray(extraRoutes)) {
-          if (await handleRoutes(extraRoutes)) {
-            setDefaultHandler();
-            return;
-          }
-        } else {
-          if (extraRoutes) {
-            setDefaultHandler();
-            return;
-          }
+        if (extraRoutes) {
+          setDefaultHandler();
+          return;
         }
       }
-    } else {
-      await defaultHandler({ allowDetail: false });
     }
     setDefaultHandler();
   });
+  onNotCheckRoutes(async () => {
+    await defaultHandler({ allowDetail: false });
+    setDefaultHandler();
+  });
 }
 const checkRouteCache = {
   lastUrl: null,
@@ -2118,6 +2150,12 @@ function setTitle(title) {
     urlHelpers.setTitle(title);
   });
 }
+function setUrl(url, title) {
+  const urlHelpers = useUrl();
+  onMounted(() => {
+    urlHelpers.overrideUrl(url, title);
+  });
+}
 function useUrl() {
   const currentComponent = useCurrentComponent();
   const navigationUrl = inject("reactive_navigation_url", null);
@@ -2156,6 +2194,16 @@ function useUrl() {
     matchCurrent(template, params) {
       const helper = new UrlHelper(void 0, this.getUrl());
       return helper.match(template, params);
+    },
+    overrideUrl(url, title) {
+      if (!currentComponent) {
+        console.error("No current component while setting title", title);
+        return;
+      }
+      if (unref(disableUrl)) {
+        return;
+      }
+      currentComponent == null ? void 0 : currentComponent.overrideUrl(url, title);
     }
   };
 }
@@ -2915,8 +2963,10 @@ export {
   matchQuery,
   normalizePushOptions,
   onCheckRoutes,
+  onNotCheckRoutes,
   setTitle,
   setTitleSuffix,
+  setUrl,
   templateToUrl,
   useCanDismiss,
   useCanPop,

package/dist/src/ComponentWithProperties.d.ts

@@ -46,6 +46,7 @@ export declare class ComponentWithProperties {
     assignHistoryIndex(): void;
     inheritHistoryIndex(index: number): void;
     ownsHistoryIndex(): boolean;
+    overrideUrl(url: string, title?: string): void;
     setUrl(url: string, title?: string): void;
     setTitle(title: string): void;
     /**

package/dist/src/ModalMixin.d.ts

@@ -66,6 +66,7 @@ export declare const ModalMixin: import('vue').DefineComponent<{}, {}, {}, {}, {
                 assignHistoryIndex: () => void;
                 inheritHistoryIndex: (index: number) => void;
                 ownsHistoryIndex: () => boolean;
+                overrideUrl: (url: string, title?: string | undefined) => void;
                 setUrl: (url: string, title?: string | undefined) => void;
                 setTitle: (title: string) => void;
                 returnToHistoryIndex: () => boolean;
@@ -136,6 +137,7 @@ export declare const ModalMixin: import('vue').DefineComponent<{}, {}, {}, {}, {
                 assignHistoryIndex: () => void;
                 inheritHistoryIndex: (index: number) => void;
                 ownsHistoryIndex: () => boolean;
+                overrideUrl: (url: string, title?: string | undefined) => void;
                 setUrl: (url: string, title?: string | undefined) => void;
                 setTitle: (title: string) => void;
                 returnToHistoryIndex: () => boolean;
@@ -440,6 +442,7 @@ export declare const ModalMixin: import('vue').DefineComponent<{}, {}, {}, {}, {
                 assignHistoryIndex: () => void;
                 inheritHistoryIndex: (index: number) => void;
                 ownsHistoryIndex: () => boolean;
+                overrideUrl: (url: string, title?: string | undefined) => void;
                 setUrl: (url: string, title?: string | undefined) => void;
                 setTitle: (title: string) => void;
                 returnToHistoryIndex: () => boolean;
@@ -510,6 +513,7 @@ export declare const ModalMixin: import('vue').DefineComponent<{}, {}, {}, {}, {
                 assignHistoryIndex: () => void;
                 inheritHistoryIndex: (index: number) => void;
                 ownsHistoryIndex: () => boolean;
+                overrideUrl: (url: string, title?: string | undefined) => void;
                 setUrl: (url: string, title?: string | undefined) => void;
                 setTitle: (title: string) => void;
                 returnToHistoryIndex: () => boolean;

package/dist/src/ModalStackComponent.vue.d.ts

@@ -65,6 +65,7 @@ declare const ModalStackComponent: import('vue').DefineComponent<{
             assignHistoryIndex: () => void;
             inheritHistoryIndex: (index: number) => void;
             ownsHistoryIndex: () => boolean;
+            overrideUrl: (url: string, title?: string | undefined) => void;
             setUrl: (url: string, title?: string | undefined) => void;
             setTitle: (title: string) => void;
             returnToHistoryIndex: () => boolean;
@@ -135,6 +136,7 @@ declare const ModalStackComponent: import('vue').DefineComponent<{
             assignHistoryIndex: () => void;
             inheritHistoryIndex: (index: number) => void;
             ownsHistoryIndex: () => boolean;
+            overrideUrl: (url: string, title?: string | undefined) => void;
             setUrl: (url: string, title?: string | undefined) => void;
             setTitle: (title: string) => void;
             returnToHistoryIndex: () => boolean;

package/dist/src/StackComponent.vue.d.ts

@@ -45,6 +45,7 @@ declare const StackComponent: import('vue').DefineComponent<{}, {}, {
         assignHistoryIndex: () => void;
         inheritHistoryIndex: (index: number) => void;
         ownsHistoryIndex: () => boolean;
+        overrideUrl: (url: string, title?: string | undefined) => void;
         setUrl: (url: string, title?: string | undefined) => void;
         setTitle: (title: string) => void;
         returnToHistoryIndex: () => boolean;

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

@@ -68,6 +68,7 @@ export declare function useNavigate(): <Params extends Record<string, unknown>>(
 export type DefaultRouteHandler = () => Promise<boolean>;
 export type OnCheckRoutesHandler = () => Promise<void> | void;
 export declare function onCheckRoutes(handler: OnCheckRoutesHandler): void;
+export declare function onNotCheckRoutes(handler: OnCheckRoutesHandler): void;
 export declare function defineRoutes(routes: (Route<any, undefined>[]) | (() => Promise<boolean | (Route<any, undefined>[])>)): void;
 export declare function useCurrentHref(): Ref<string>;
 export declare function useCheckRoute(): <Params extends Record<string, unknown>>(prop1: string | Route<Params, unknown>, prop2?: RouteNavigationOptions<Params>) => boolean;
@@ -85,6 +86,7 @@ export declare function useFocused(): boolean | Ref<boolean>;
 export declare function extendUrl(url: string | Ref<string>): void;
 export declare function setTitleSuffix(title: string): void;
 export declare function setTitle(title: string): void;
+export declare function setUrl(url: string, title?: string): void;
 export declare function useUrl(): {
     getUrl(): string;
     /**
@@ -94,4 +96,5 @@ export declare function useUrl(): {
     extendUrl(url: string): string;
     match<Params>(template: string, params?: UrlParamsConstructors<Params>): UrlMatchResult<Params> | undefined;
     matchCurrent<Params_1>(template: string, params?: UrlParamsConstructors<Params_1> | undefined): UrlMatchResult<Params_1> | undefined;
+    overrideUrl(url: string, title?: string): void;
 };

package/dist/test/EditWebshopMixin.d.ts

@@ -129,6 +129,7 @@ declare const EditWebshopMixin_base: new (...args: any) => import('../src/class-
                 assignHistoryIndex: () => void;
                 inheritHistoryIndex: (index: number) => void;
                 ownsHistoryIndex: () => boolean;
+                overrideUrl: (url: string, title?: string | undefined) => void;
                 setUrl: (url: string, title?: string | undefined) => void;
                 setTitle: (title: string) => void;
                 returnToHistoryIndex: () => boolean;
@@ -199,6 +200,7 @@ declare const EditWebshopMixin_base: new (...args: any) => import('../src/class-
                 assignHistoryIndex: () => void;
                 inheritHistoryIndex: (index: number) => void;
                 ownsHistoryIndex: () => boolean;
+                overrideUrl: (url: string, title?: string | undefined) => void;
                 setUrl: (url: string, title?: string | undefined) => void;
                 setTitle: (title: string) => void;
                 returnToHistoryIndex: () => boolean;
@@ -503,6 +505,7 @@ declare const EditWebshopMixin_base: new (...args: any) => import('../src/class-
                 assignHistoryIndex: () => void;
                 inheritHistoryIndex: (index: number) => void;
                 ownsHistoryIndex: () => boolean;
+                overrideUrl: (url: string, title?: string | undefined) => void;
                 setUrl: (url: string, title?: string | undefined) => void;
                 setTitle: (title: string) => void;
                 returnToHistoryIndex: () => boolean;
@@ -573,6 +576,7 @@ declare const EditWebshopMixin_base: new (...args: any) => import('../src/class-
                 assignHistoryIndex: () => void;
                 inheritHistoryIndex: (index: number) => void;
                 ownsHistoryIndex: () => boolean;
+                overrideUrl: (url: string, title?: string | undefined) => void;
                 setUrl: (url: string, title?: string | undefined) => void;
                 setTitle: (title: string) => void;
                 returnToHistoryIndex: () => boolean;
@@ -1533,6 +1537,7 @@ declare const EditWebshopMixin_base: new (...args: any) => import('../src/class-
         extendUrl(url: string): string;
         match<Params>(template: string, params?: import('..').UrlParamsConstructors<Params> | undefined): import('..').UrlMatchResult<Params> | undefined;
         matchCurrent<Params_1>(template: string, params?: import('..').UrlParamsConstructors<Params_1> | undefined): import('..').UrlMatchResult<Params_1> | undefined;
+        overrideUrl(url: string, title?: string | undefined): void;
     };
     $navigate: <Params_2 extends Record<string, unknown>>(prop1: string | import('..').Route<Params_2, unknown>, prop2?: import('..').RouteNavigationOptions<Params_2> | undefined) => Promise<void>;
 }, {}, {

package/package.json

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