@hitachivantara/app-shell-navigation 1.0.0 → 1.2.0

package/dist/dts/index.d.ts

@@ -1,5 +1,25 @@
+import { HvAppShellViewsConfig } from '@hitachivantara/app-shell-shared';
+import { Location as Location_2 } from 'react-router-dom';
 import { Path } from 'react-router-dom';
 
+declare interface GetViewRouteOptions {
+    mode?: ViewSearchMode;
+}
+
+declare class LocationWithViews<State = unknown> implements Location_2<State> {
+    #private;
+    state: State;
+    key: string;
+    pathname: string;
+    search: string;
+    hash: string;
+    private matches;
+    constructor(location: Location_2<State>, views: HvAppShellViewsConfig[] | undefined | null);
+    get views(): HvAppShellViewsConfig[];
+}
+
+declare type NavigateOptions = GetViewRouteOptions & Partial<NavigationOptions>;
+
 export declare interface NavigationOptions {
     /**
      * Whether a history replace action should be performed instead of the default history push.
@@ -18,9 +38,11 @@ export declare const useHvCurrentNavigationPath: () => {
     path: string | undefined;
 }[];
 
+export declare const useHvLocation: () => LocationWithViews<any>;
+
 export declare const useHvNavigation: () => {
-    getViewRoute: (viewBundleDir: string | ViewDestination) => string | undefined;
-    navigate: (to: To, options?: Partial<NavigationOptions>) => void;
+    getViewRoute: (viewBundleDir: string | ViewDestination, { mode }?: GetViewRouteOptions) => string | undefined;
+    navigate: (to: To, options?: NavigateOptions) => void;
 };
 
 export declare type ViewDestination = {
@@ -42,4 +64,6 @@ export declare type ViewDestination = {
     hash?: string;
 };
 
+declare type ViewSearchMode = "auto" | "top";
+
 export { }

package/dist/esm/index.js

@@ -1,7 +1,9 @@
 import { default as e } from "./lib/hooks/useNavigation.js";
 import { default as r } from "./lib/hooks/useCurrentNavigationPath.js";
+import { default as f } from "./lib/hooks/useLocation.js";
 export {
   r as useHvCurrentNavigationPath,
+  f as useHvLocation,
   e as useHvNavigation
 };
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/dist/esm/lib/hooks/useLocation.js

@@ -0,0 +1,61 @@
+var l = Object.defineProperty;
+var p = (s, t, e) => t in s ? l(s, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : s[t] = e;
+var i = (s, t, e) => (p(s, typeof t != "symbol" ? t + "" : t, e), e), o = (s, t, e) => {
+  if (!t.has(s))
+    throw TypeError("Cannot " + e);
+};
+var r = (s, t, e) => (o(s, t, "read from private field"), e ? e.call(s) : t.get(s)), c = (s, t, e) => {
+  if (t.has(s))
+    throw TypeError("Cannot add the same private member more than once");
+  t instanceof WeakSet ? t.add(s) : t.set(s, e);
+}, u = (s, t, e, n) => (o(s, t, "write to private field"), n ? n.call(s, e) : t.set(s, e), e);
+import { useMemo as f } from "react";
+import { useLocation as d, matchRoutes as w } from "react-router-dom";
+import { useHvAppShellConfig as g } from "@hitachivantara/app-shell-shared";
+function m(s) {
+  return s.map((t) => {
+    const e = t.route.slice(1);
+    return e === "" && (t.views == null || t.views.length === 0) ? {
+      path: e,
+      view: t
+    } : {
+      path: e,
+      view: t,
+      children: t.views ? m(t.views) : void 0
+    };
+  });
+}
+var a;
+class v {
+  constructor(t, e) {
+    i(this, "state");
+    i(this, "key");
+    i(this, "pathname");
+    i(this, "search");
+    i(this, "hash");
+    c(this, a, void 0);
+    i(this, "matches", null);
+    this.state = t.state, this.key = t.key, this.pathname = t.pathname, this.search = t.search, this.hash = t.hash, u(this, a, e ?? []);
+  }
+  get views() {
+    var t;
+    if (this.matches == null) {
+      const e = m(r(this, a));
+      this.matches = ((t = w(e, this)) == null ? void 0 : t.map((n) => n.route.view)) ?? [];
+    }
+    return this.matches;
+  }
+}
+a = new WeakMap();
+const x = () => {
+  var n;
+  const s = d(), t = g();
+  return f(() => {
+    var h;
+    return new v(s, (h = t.mainPanel) == null ? void 0 : h.views);
+  }, [s, (n = t.mainPanel) == null ? void 0 : n.views]);
+}, R = x;
+export {
+  R as default
+};
+//# sourceMappingURL=useLocation.js.map

package/dist/esm/lib/hooks/useLocation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLocation.js","sources":["../../../../src/lib/hooks/useLocation.tsx"],"sourcesContent":["import { useMemo } from \"react\";\nimport {\n  matchRoutes,\n  useLocation as useLocationReactRouter,\n  Location\n} from \"react-router-dom\";\n\nimport {\n  HvAppShellViewsConfig,\n  useHvAppShellConfig\n} from \"@hitachivantara/app-shell-shared\";\n\ninterface IndexedView {\n  path: string;\n  children?: IndexedView[];\n  view: HvAppShellViewsConfig;\n}\n\nfunction indexViews(views: HvAppShellViewsConfig[]): IndexedView[] {\n  return views.map(view => {\n    // remove prefix slash from view.route\n    const path = view.route.slice(1);\n    const isIndex =\n      path === \"\" && (view.views == null || view.views.length === 0);\n\n    if (isIndex) {\n      return {\n        path,\n        view\n      };\n    }\n\n    return {\n      path,\n      view,\n      children: view.views ? indexViews(view.views) : undefined\n    };\n  });\n}\n\nclass LocationWithViews<State = unknown> implements Location<State> {\n  state: State;\n\n  key: string;\n\n  pathname: string;\n\n  search: string;\n\n  hash: string;\n\n  #configViews: HvAppShellViewsConfig[];\n\n  private matches: HvAppShellViewsConfig[] | null = null;\n\n  constructor(\n    location: Location<State>,\n    views: HvAppShellViewsConfig[] | undefined | null\n  ) {\n    this.state = location.state;\n    this.key = location.key;\n    this.pathname = location.pathname;\n    this.search = location.search;\n    this.hash = location.hash;\n\n    this.#configViews = views ?? [];\n  }\n\n  get views() {\n    if (this.matches == null) {\n      const indexedViews = indexViews(this.#configViews);\n      this.matches =\n        matchRoutes(indexedViews, this)?.map(match => match.route.view) ?? [];\n    }\n\n    return this.matches;\n  }\n}\n\nconst useLocation = () => {\n  const location = useLocationReactRouter();\n  const config = useHvAppShellConfig();\n  const toReturn = useMemo(() => {\n    return new LocationWithViews(location, config.mainPanel?.views);\n  }, [location, config.mainPanel?.views]);\n\n  return toReturn;\n};\nexport default useLocation;\n"],"names":["indexViews","views","map","view","path","route","slice","length","children","undefined","LocationWithViews","constructor","location","state","key","pathname","search","hash","__privateAdd","_configViews","matches","__privateSet","indexedViews","__privateGet","matchRoutes","match","useLocation","useLocationReactRouter","config","useHvAppShellConfig","toReturn","useMemo","mainPanel","useHvLocation"],"mappings":";;;;;;;;;;;;;;AAkBA,SAASA,EAAWC,GAA+C;AAC1DA,SAAAA,EAAMC,IAAIC,CAAQA,MAAA;AAEvB,UAAMC,IAAOD,EAAKE,MAAMC,MAAM,CAAC;AAI/B,WAFEF,MAAS,OAAOD,EAAKF,SAAS,QAAQE,EAAKF,MAAMM,WAAW,KAGrD;AAAA,MACLH,MAAAA;AAAAA,MACAD,MAAAA;AAAAA,IAAAA,IAIG;AAAA,MACLC,MAAAA;AAAAA,MACAD,MAAAA;AAAAA,MACAK,UAAUL,EAAKF,QAAQD,EAAWG,EAAKF,KAAK,IAAIQ;AAAAA,IAAAA;AAAAA,EAClD,CACD;AACH;;AAEA,MAAMC,EAA8D;AAAA,EAelEC,YACEC,GACAX,GACA;AAjBFY,IAAAA,EAAAA;AAEAC,IAAAA,EAAAA;AAEAC,IAAAA,EAAAA;AAEAC,IAAAA,EAAAA;AAEAC,IAAAA,EAAAA;AAEA,IAAAC,EAAA,MAAAC,GAAA;AAEQC,IAAAA,EAAAA,iBAA0C;AAMhD,SAAKP,QAAQD,EAASC,OACtB,KAAKC,MAAMF,EAASE,KACpB,KAAKC,WAAWH,EAASG,UACzB,KAAKC,SAASJ,EAASI,QACvB,KAAKC,OAAOL,EAASK,MAEhBI,EAAA,MAAAF,GAAelB,KAAS;EAC/B;AAAA,EAEA,IAAIA,QAAQ;;AACN,QAAA,KAAKmB,WAAW,MAAM;AAClBE,YAAAA,IAAetB,EAAWuB,EAAA,MAAKJ,EAAY;AAC5CC,WAAAA,YACHI,IAAAA,EAAYF,GAAc,IAAI,MAA9BE,gBAAAA,EAAiCtB,IAAIuB,CAAAA,MAASA,EAAMpB,MAAMF,UAAS,CAAA;AAAA,IACvE;AAEA,WAAO,KAAKiB;AAAAA,EACd;AACF;AA1BED,IAAA;AA4BF,MAAMO,IAAcA,MAAM;;AACxB,QAAMd,IAAWe,KACXC,IAASC;AAKRC,SAJUC,EAAQ,MAAM;;AAC7B,WAAO,IAAIrB,EAAkBE,IAAUgB,IAAAA,EAAOI,cAAPJ,gBAAAA,EAAkB3B,KAAK;AAAA,KAC7D,CAACW,IAAUgB,IAAAA,EAAOI,cAAPJ,gBAAAA,EAAkB3B,KAAK,CAAC;AAGxC,GACAgC,IAAeP;"}

package/dist/esm/lib/hooks/useNavigation.js

@@ -1,46 +1,92 @@
-import { useContext as v, useCallback as $ } from "react";
-import { useNavigate as N } from "react-router-dom";
-import { useHvAppShellConfig as P, HvAppShellViewContext as R } from "@hitachivantara/app-shell-shared";
-import H from "../utils/navigationUtil.js";
-const m = (t) => t.viewBundle !== void 0, S = (t) => typeof t != "string" && !m(t), V = () => {
-  const t = P(), s = v(R), d = N(), u = $((e) => {
-    var g, h;
-    let a, n, l, f;
-    m(e) ? {
-      viewBundle: a,
-      pathParams: n,
-      search: l,
-      hash: f
-    } = e : a = e;
-    const c = a.replace(/\$/, "_");
-    let p, i;
-    c.startsWith("/") ? (p = s == null ? void 0 : s.id, i = c.substring(1)) : i = c;
-    const o = (h = (g = t.mainPanel) == null ? void 0 : g.views) == null ? void 0 : h.find((r) => r.bundle === `${i}` || r.bundle === `${i}.js` || r.bundle === `${p}/${i}.js` || r.bundle === `${p}/src/${i}`);
-    return o != null && o.route ? `${H(o.route, n)}${l ?? ""}${f ?? ""}` : void 0;
-  }, [t, s == null ? void 0 : s.id]), b = $((e, a) => {
-    let n;
-    if (S(e))
-      n = e;
+import { useMemo as N, useContext as y, useRef as A, useCallback as j } from "react";
+import { useNavigate as C } from "react-router-dom";
+import { useHvAppShellConfig as W, HvAppShellViewContext as B } from "@hitachivantara/app-shell-shared";
+import O from "../utils/navigationUtil.js";
+import q from "./useLocation.js";
+const k = (e) => e.viewBundle !== void 0, x = (e) => typeof e != "string" && !k(e);
+function L(e, r) {
+  return `/${e.map((n) => n.route.substring(1)).slice(0, r ?? e.length).filter((n) => n !== "").join("/")}`;
+}
+function M(e, r, n) {
+  return e.bundle === `${r}` || e.bundle === `${r}.js` || e.bundle === `${n}/${r}.js` || e.bundle === `${n}/${r}`;
+}
+const _ = () => {
+  var R;
+  const e = W(), r = N(() => {
+    var t;
+    const i = (l, s = "") => l.reduce((o, u) => {
+      const a = `${s}${u.route}`;
+      return o.push({
+        ...u,
+        route: a
+      }), u.views != null && o.push(...i(u.views, a)), o;
+    }, []);
+    return i(((t = e.mainPanel) == null ? void 0 : t.views) ?? []);
+  }, [(R = e.mainPanel) == null ? void 0 : R.views]), n = y(B), v = C(), w = q(), b = A(w);
+  b.current = w;
+  const m = j((i, {
+    mode: t = "auto"
+  } = {}) => {
+    var S;
+    let l, s, o, u;
+    k(i) ? {
+      viewBundle: l,
+      pathParams: s,
+      search: o,
+      hash: u
+    } = i : l = i;
+    const a = l.replace(/\$/, "_");
+    let V, p;
+    a.startsWith("/") ? (V = n == null ? void 0 : n.id, p = a.substring(1)) : p = a;
+    let P = [];
+    t !== "top" && (P = b.current.views);
+    let f;
+    const h = r.filter((g) => M(g, p, V)).sort((g, c) => {
+      const d = (g.route.match(/\//g) ?? []).length, $ = (c.route.match(/\//g) ?? []).length;
+      return d - $;
+    });
+    if (h.length > 0) {
+      if (t === "top" || h.length === 1)
+        f = h[0].route;
+      else if (t === "auto") {
+        let c = `${L(P)}/`;
+        for (; f == null; ) {
+          const d = c;
+          if (f = (S = h.find(($) => $.route.startsWith(d))) == null ? void 0 : S.route, c = c.replace(/\/[^/]*\/?$/, "/"), c === "")
+            break;
+        }
+      }
+    }
+    return f ? `${O(f, s)}${o ?? ""}${u ?? ""}` : void 0;
+  }, [r, n == null ? void 0 : n.id]), H = j((i, t) => {
+    let l;
+    if (x(i))
+      l = i;
     else {
-      const l = u(e);
-      if (l == null)
-        if (typeof e == "string")
-          n = e;
+      const o = m(i, {
+        mode: t == null ? void 0 : t.mode
+      });
+      if (o == null)
+        if (typeof i == "string")
+          l = i;
         else {
-          console.warn(`Navigate request to a non existing path [${e.viewBundle}]. Skipping`);
+          console.warn(`Navigate request to a non existing path [${i.viewBundle}]. Skipping`);
           return;
         }
       else
-        n = l;
+        l = o;
     }
-    d(n, a);
-  }, [u, d]);
+    let s;
+    t != null && (t.mode == null ? s = t : (s = {
+      ...t
+    }, delete s.mode, Object.keys(s).length === 0 && (s = void 0))), v(l, s);
+  }, [m, v]);
   return {
-    getViewRoute: u,
-    navigate: b
+    getViewRoute: m,
+    navigate: H
   };
-}, A = V;
+}, I = _;
 export {
-  A as default
+  I as default
 };
 //# sourceMappingURL=useNavigation.js.map

package/dist/esm/lib/hooks/useNavigation.js.map

@@ -1 +1 @@
-{"version":3,"file":"useNavigation.js","sources":["../../../../src/lib/hooks/useNavigation.tsx"],"sourcesContent":["import { useCallback, useContext } from \"react\";\nimport { Path, useNavigate } from \"react-router-dom\";\n\nimport {\n  HvAppShellViewContext,\n  useHvAppShellConfig\n} from \"@hitachivantara/app-shell-shared\";\n\nimport { NavigationOptions, To, ViewDestination } from \"../types\";\nimport compileHref from \"../utils/navigationUtil\";\n\nconst isViewDestination = (to: To): to is ViewDestination => {\n  return (to as ViewDestination).viewBundle !== undefined;\n};\n\nconst isPathDestination = (to: To): to is Partial<Path> => {\n  return typeof to !== \"string\" && !isViewDestination(to);\n};\n\nconst useNavigation = () => {\n  const config = useHvAppShellConfig();\n  const viewContext = useContext(HvAppShellViewContext);\n  const navigateReactRouter = useNavigate();\n\n  /**\n   * Utility to search for the route of an application view bundle directory on the App Shell configuration file.\n   *\n   * @param viewBundleDir The application view bundle directory name and optional route parameters.\n   *\n   * @returns The compiled route or undefined if none was found.\n   */\n  const getViewRoute = useCallback(\n    (viewBundleDir: string | ViewDestination): string | undefined => {\n      let viewBundle;\n      let pathParams;\n      let search;\n      let hash;\n\n      if (isViewDestination(viewBundleDir)) {\n        ({ viewBundle, pathParams, search, hash } = viewBundleDir);\n      } else {\n        viewBundle = viewBundleDir;\n      }\n      const bundleWithReplacedPlaceholders = viewBundle.replace(/\\$/, \"_\");\n\n      let appId: string | undefined;\n      let bundle: string;\n\n      // local navigation\n      if (bundleWithReplacedPlaceholders.startsWith(\"/\")) {\n        appId = viewContext?.id;\n        bundle = bundleWithReplacedPlaceholders.substring(1);\n      } else {\n        bundle = bundleWithReplacedPlaceholders;\n      }\n\n      const view = config.mainPanel?.views?.find(\n        v =>\n          v.bundle === `${bundle}` ||\n          v.bundle === `${bundle}.js` ||\n          v.bundle === `${appId}/${bundle}.js` ||\n          v.bundle === `${appId}/src/${bundle}`\n      );\n\n      return view?.route\n        ? `${compileHref(view.route, pathParams)}${search ?? \"\"}${hash ?? \"\"}`\n        : undefined;\n    },\n    [config, viewContext?.id]\n  );\n\n  /**\n   * Performs navigation, through 'history.push' or 'history.replace', for the given destination with the passed navigation options.\n   * @see https://reactrouter.com/hooks/use-navigate\n   *\n   * @param to The destination of the navigation. For ViewDestination type see {@link ViewDestination}.\n   * @param options The navigation options.\n   */\n  const navigate = useCallback(\n    (to: To, options?: Partial<NavigationOptions>) => {\n      let path;\n      if (isPathDestination(to)) {\n        path = to;\n      } else {\n        const route = getViewRoute(to);\n\n        if (route == null) {\n          if (typeof to === \"string\") {\n            path = to;\n          } else {\n            // If route for given module is not found on the App Shell configuration file, do nothing.\n            console.warn(\n              `Navigate request to a non existing path [${to.viewBundle}]. Skipping`\n            );\n            return;\n          }\n        } else {\n          path = route;\n        }\n      }\n\n      navigateReactRouter(path, options);\n    },\n    [getViewRoute, navigateReactRouter]\n  );\n\n  return { getViewRoute, navigate };\n};\nexport default useNavigation;\n"],"names":["isViewDestination","to","viewBundle","undefined","isPathDestination","useNavigation","config","useHvAppShellConfig","viewContext","useContext","HvAppShellViewContext","navigateReactRouter","useNavigate","getViewRoute","useCallback","viewBundleDir","pathParams","search","hash","bundleWithReplacedPlaceholders","replace","appId","bundle","startsWith","id","substring","view","mainPanel","views","find","v","route","compileHref","navigate","options","path","console","warn","useNavigation$1"],"mappings":";;;;AAWA,MAAMA,IAAoBA,CAACC,MACjBA,EAAuBC,eAAeC,QAG1CC,IAAoBA,CAACH,MAClB,OAAOA,KAAO,YAAY,CAACD,EAAkBC,CAAE,GAGlDI,IAAgBA,MAAM;AAC1B,QAAMC,IAASC,KACTC,IAAcC,EAAWC,CAAqB,GAC9CC,IAAsBC,KAStBC,IAAeC,EACnB,CAACC,MAAgE;;AAC3Db,QAAAA,GACAc,GACAC,GACAC;AAEAlB,IAAAA,EAAkBe,CAAa,IAChC;AAAA,MAAEb,YAAAA;AAAAA,MAAYc,YAAAA;AAAAA,MAAYC,QAAAA;AAAAA,MAAQC,MAAAA;AAAAA,IAASH,IAAAA,IAE/BA,IAAAA;AAEf,UAAMI,IAAiCjB,EAAWkB,QAAQ,MAAM,GAAG;AAE/DC,QAAAA,GACAC;AAGAH,IAAAA,EAA+BI,WAAW,GAAG,KAC/CF,IAAQb,KAAAA,gBAAAA,EAAagB,IACZL,IAAAA,EAA+BM,UAAU,CAAC,KAE1CN,IAAAA;AAGX,UAAMO,KAAOpB,KAAAA,IAAAA,EAAOqB,cAAPrB,gBAAAA,EAAkBsB,UAAlBtB,gBAAAA,EAAyBuB,KACpCC,CAAAA,MACEA,EAAER,WAAY,GAAEA,CAAO,MACvBQ,EAAER,WAAY,GAAEA,CAAO,SACvBQ,EAAER,WAAY,GAAED,CAAM,IAAGC,CAAO,SAChCQ,EAAER,WAAY,GAAED,CAAM,QAAOC,CAAO;AAGxC,WAAOI,KAAAA,QAAAA,EAAMK,QACR,GAAEC,EAAYN,EAAKK,OAAOf,CAAU,CAAE,GAAEC,KAAU,EAAG,GAAEC,KAAQ,EAAG,KACnEf;AAAAA,EAEN,GAAA,CAACG,GAAQE,KAAAA,gBAAAA,EAAagB,EAAE,CAC1B,GASMS,IAAWnB,EACf,CAACb,GAAQiC,MAAyC;AAC5CC,QAAAA;AACA/B,QAAAA,EAAkBH,CAAE;AACfA,MAAAA,IAAAA;AAAAA,SACF;AACC8B,YAAAA,IAAQlB,EAAaZ,CAAE;AAE7B,UAAI8B,KAAS;AACP,YAAA,OAAO9B,KAAO;AACTA,UAAAA,IAAAA;AAAAA,aACF;AAELmC,kBAAQC,KACL,4CAA2CpC,EAAGC,UAAW,aAC5D;AACA;AAAA,QACF;AAAA;AAEO6B,QAAAA,IAAAA;AAAAA,IAEX;AAEApB,IAAAA,EAAoBwB,GAAMD,CAAO;AAAA,EAAA,GAEnC,CAACrB,GAAcF,CAAmB,CACpC;AAEO,SAAA;AAAA,IAAEE,cAAAA;AAAAA,IAAcoB,UAAAA;AAAAA,EAAAA;AACzB,GACAK,IAAejC;"}
+{"version":3,"file":"useNavigation.js","sources":["../../../../src/lib/hooks/useNavigation.tsx"],"sourcesContent":["import { useCallback, useContext, useMemo, useRef } from \"react\";\nimport { Path, useNavigate } from \"react-router-dom\";\n\nimport {\n  HvAppShellViewContext,\n  HvAppShellViewsConfig,\n  useHvAppShellConfig\n} from \"@hitachivantara/app-shell-shared\";\n\nimport { NavigationOptions, To, ViewDestination } from \"../types\";\nimport compileHref from \"../utils/navigationUtil\";\nimport useHvLocation from \"./useLocation\";\n\nconst isViewDestination = (to: To): to is ViewDestination => {\n  return (to as ViewDestination).viewBundle !== undefined;\n};\n\nconst isPathDestination = (to: To): to is Partial<Path> => {\n  return typeof to !== \"string\" && !isViewDestination(to);\n};\n\ntype ViewSearchMode = \"auto\" | \"top\";\n\ninterface GetViewRouteOptions {\n  mode?: ViewSearchMode;\n}\n\ntype NavigateOptions = GetViewRouteOptions & Partial<NavigationOptions>;\n\nfunction getActiveViewRoute(\n  activeViews: HvAppShellViewsConfig[],\n  depth?: number\n): string {\n  return `/${activeViews\n    .map(view => view.route.substring(1))\n    .slice(0, depth ?? activeViews.length)\n    .filter(route => route !== \"\") // remove index routes\n    .join(\"/\")}`;\n}\n\nfunction isSameBundle(\n  v: HvAppShellViewsConfig,\n  bundle: string,\n  appId: string | undefined\n) {\n  return (\n    v.bundle === `${bundle}` ||\n    v.bundle === `${bundle}.js` ||\n    v.bundle === `${appId}/${bundle}.js` ||\n    v.bundle === `${appId}/${bundle}`\n  );\n}\n\nconst useNavigation = () => {\n  const config = useHvAppShellConfig();\n  const flattenViews = useMemo(() => {\n    const flatten = (views: HvAppShellViewsConfig[], base = \"\") => {\n      return views.reduce<HvAppShellViewsConfig[]>((acc, view) => {\n        // concatenate base with view route\n        const route = `${base}${view.route}` as HvAppShellViewsConfig[\"route\"];\n        acc.push({ ...view, route });\n        if (view.views != null) {\n          acc.push(...flatten(view.views, route));\n        }\n        return acc;\n      }, []);\n    };\n    return flatten(config.mainPanel?.views ?? []);\n  }, [config.mainPanel?.views]);\n\n  const viewContext = useContext(HvAppShellViewContext);\n  const navigateReactRouter = useNavigate();\n\n  // the returned navigate and getViewRoute functions need to be stable\n  // regardless of the location change, but we need to use the most recent location\n  // in the getViewRoute algorithm, so we use a ref to store the location\n  const location = useHvLocation();\n  const locationRef = useRef(location);\n  locationRef.current = location;\n\n  /**\n   * Utility to search for the route of a View on the App Shell configuration.\n   *\n   * The search can be performed in different modes:\n   * - \"auto\": Searches within views whose route is a subpath of the current active view, progressively going up path segments until a match is found.\n   * - \"top\": Finds the view closest to the root, i.e. with the least number of path segments.\n   *\n   * If multiple views match the search criteria, the function returns the one that appears first in the App Shell configuration.\n   *\n   * @param viewBundleDir The application view bundle directory name and optional route parameters.\n   * @param mode The search mode to use. Defaults to \"auto\".\n   *\n   * @returns The compiled route or undefined if none was found.\n   */\n  const getViewRoute = useCallback(\n    (\n      viewBundleDir: string | ViewDestination,\n      { mode = \"auto\" }: GetViewRouteOptions = {}\n    ): string | undefined => {\n      let viewBundle;\n      let pathParams;\n      let search;\n      let hash;\n\n      if (isViewDestination(viewBundleDir)) {\n        ({ viewBundle, pathParams, search, hash } = viewBundleDir);\n      } else {\n        viewBundle = viewBundleDir;\n      }\n      const bundleWithReplacedPlaceholders = viewBundle.replace(/\\$/, \"_\");\n\n      let appId: string | undefined;\n      let bundle: string;\n\n      // local navigation\n      if (bundleWithReplacedPlaceholders.startsWith(\"/\")) {\n        appId = viewContext?.id;\n        bundle = bundleWithReplacedPlaceholders.substring(1);\n      } else {\n        bundle = bundleWithReplacedPlaceholders;\n      }\n\n      let activeViews: HvAppShellViewsConfig[] = [];\n      if (mode !== \"top\") {\n        activeViews = locationRef.current.views;\n      }\n\n      let route: string | undefined;\n\n      const matchingViews = flattenViews\n        .filter(v => isSameBundle(v, bundle, appId))\n        .sort((a, b) => {\n          const aSlashCount = (a.route.match(/\\//g) ?? []).length;\n          const bSlashCount = (b.route.match(/\\//g) ?? []).length;\n          return aSlashCount - bSlashCount;\n        });\n\n      if (matchingViews.length > 0) {\n        if (mode === \"top\" || matchingViews.length === 1) {\n          // no need for search algorithms if there is only one matching view\n          route = matchingViews[0].route;\n        } else if (mode === \"auto\") {\n          const activeViewRoute = getActiveViewRoute(activeViews);\n\n          let path = `${activeViewRoute}/`;\n          while (route == null) {\n            const innerPath = path;\n            route = matchingViews.find(v => v.route.startsWith(innerPath))\n              ?.route;\n\n            // remove last path segment, e.g. /path/segment/ -> /path/ -> /\n            path = path.replace(/\\/[^/]*\\/?$/, \"/\");\n\n            if (path === \"\") {\n              break;\n            }\n          }\n        }\n      }\n\n      return route\n        ? `${compileHref(route, pathParams)}${search ?? \"\"}${hash ?? \"\"}`\n        : undefined;\n    },\n    [flattenViews, viewContext?.id]\n  );\n\n  /**\n   * Performs navigation, through 'history.push' or 'history.replace', for the given destination with the passed navigation options.\n   * @see https://reactrouter.com/hooks/use-navigate\n   *\n   * @param to The destination of the navigation. For ViewDestination type see {@link ViewDestination}.\n   * @param options The navigation options:\n   * - mode: The search mode to use when searching for the route of a View on the App Shell configuration. Defaults to \"auto\".\n   * - replace: If true, the navigation will replace the current entry in the history stack instead of adding a new one.\n   * - state: State to associate to the location.\n   */\n  const navigate = useCallback(\n    (to: To, options?: NavigateOptions) => {\n      let path;\n      if (isPathDestination(to)) {\n        path = to;\n      } else {\n        const route = getViewRoute(to, { mode: options?.mode });\n\n        if (route == null) {\n          if (typeof to === \"string\") {\n            path = to;\n          } else {\n            // If route for given module is not found on the App Shell configuration file, do nothing.\n            console.warn(\n              `Navigate request to a non existing path [${to.viewBundle}]. Skipping`\n            );\n            return;\n          }\n        } else {\n          path = route;\n        }\n      }\n\n      let navigateOptions: NavigateOptions | undefined;\n      if (options != null) {\n        if (options.mode == null) {\n          navigateOptions = options;\n        } else {\n          navigateOptions = { ...options };\n          delete navigateOptions.mode;\n          if (Object.keys(navigateOptions).length === 0) {\n            navigateOptions = undefined;\n          }\n        }\n      }\n\n      navigateReactRouter(path, navigateOptions);\n    },\n    [getViewRoute, navigateReactRouter]\n  );\n\n  return { getViewRoute, navigate };\n};\n\nexport default useNavigation;\n"],"names":["isViewDestination","to","viewBundle","undefined","isPathDestination","getActiveViewRoute","activeViews","depth","map","view","route","substring","slice","length","filter","join","isSameBundle","v","bundle","appId","useNavigation","config","useHvAppShellConfig","flattenViews","useMemo","flatten","views","base","reduce","acc","push","mainPanel","viewContext","useContext","HvAppShellViewContext","navigateReactRouter","useNavigate","location","useHvLocation","locationRef","useRef","current","getViewRoute","useCallback","viewBundleDir","mode","pathParams","search","hash","bundleWithReplacedPlaceholders","replace","startsWith","id","matchingViews","sort","a","b","aSlashCount","match","bSlashCount","path","innerPath","find","compileHref","navigate","options","console","warn","navigateOptions","Object","keys","useNavigation$1"],"mappings":";;;;;AAaA,MAAMA,IAAoBA,CAACC,MACjBA,EAAuBC,eAAeC,QAG1CC,IAAoBA,CAACH,MAClB,OAAOA,KAAO,YAAY,CAACD,EAAkBC,CAAE;AAWxD,SAASI,EACPC,GACAC,GACQ;AACA,SAAA,IAAGD,EACRE,IAAIC,CAAAA,MAAQA,EAAKC,MAAMC,UAAU,CAAC,CAAC,EACnCC,MAAM,GAAGL,KAASD,EAAYO,MAAM,EACpCC,OAAOJ,CAAAA,MAASA,MAAU,EAAE,EAC5BK,KAAK,GAAG,CAAE;AACf;AAEA,SAASC,EACPC,GACAC,GACAC,GACA;AAEEF,SAAAA,EAAEC,WAAY,GAAEA,CAAO,MACvBD,EAAEC,WAAY,GAAEA,CAAO,SACvBD,EAAEC,WAAY,GAAEC,CAAM,IAAGD,CAAO,SAChCD,EAAEC,WAAY,GAAEC,CAAM,IAAGD,CAAO;AAEpC;AAEA,MAAME,IAAgBA,MAAM;;AAC1B,QAAMC,IAASC,KACTC,IAAeC,EAAQ,MAAM;;AACjC,UAAMC,IAAUA,CAACC,GAAgCC,IAAO,OAC/CD,EAAME,OAAgC,CAACC,GAAKpB,MAAS;AAE1D,YAAMC,IAAS,GAAEiB,CAAK,GAAElB,EAAKC,KAAM;AACnCmB,aAAAA,EAAIC,KAAK;AAAA,QAAE,GAAGrB;AAAAA,QAAMC,OAAAA;AAAAA,MAAAA,CAAO,GACvBD,EAAKiB,SAAS,QAChBG,EAAIC,KAAK,GAAGL,EAAQhB,EAAKiB,OAAOhB,CAAK,CAAC,GAEjCmB;AAAAA,IACT,GAAG,CAAE,CAAA;AAEP,WAAOJ,IAAQJ,IAAAA,EAAOU,cAAPV,gBAAAA,EAAkBK,UAAS,CAAE,CAAA;AAAA,EAC3C,GAAA,EAACL,IAAAA,EAAOU,cAAPV,gBAAAA,EAAkBK,KAAK,CAAC,GAEtBM,IAAcC,EAAWC,CAAqB,GAC9CC,IAAsBC,KAKtBC,IAAWC,KACXC,IAAcC,EAAOH,CAAQ;AACnCE,EAAAA,EAAYE,UAAUJ;AAgBhBK,QAAAA,IAAeC,EACnB,CACEC,GACA;AAAA,IAAEC,MAAAA,IAAO;AAAA,EAA4B,IAAI,OAClB;;AACnB3C,QAAAA,GACA4C,GACAC,GACAC;AAEAhD,IAAAA,EAAkB4C,CAAa,IAChC;AAAA,MAAE1C,YAAAA;AAAAA,MAAY4C,YAAAA;AAAAA,MAAYC,QAAAA;AAAAA,MAAQC,MAAAA;AAAAA,IAASJ,IAAAA,IAE/BA,IAAAA;AAEf,UAAMK,IAAiC/C,EAAWgD,QAAQ,MAAM,GAAG;AAE/D/B,QAAAA,GACAD;AAGA+B,IAAAA,EAA+BE,WAAW,GAAG,KAC/ChC,IAAQa,KAAAA,gBAAAA,EAAaoB,IACZH,IAAAA,EAA+BtC,UAAU,CAAC,KAE1CsC,IAAAA;AAGX,QAAI3C,IAAuC,CAAA;AAC3C,IAAIuC,MAAS,UACXvC,IAAciC,EAAYE,QAAQf;AAGhChB,QAAAA;AAEJ,UAAM2C,IAAgB9B,EACnBT,OAAOG,CAAAA,MAAKD,EAAaC,GAAGC,GAAQC,CAAK,CAAC,EAC1CmC,KAAK,CAACC,GAAGC,MAAM;AACd,YAAMC,KAAeF,EAAE7C,MAAMgD,MAAM,KAAK,KAAK,CAAI7C,GAAAA,QAC3C8C,KAAeH,EAAE9C,MAAMgD,MAAM,KAAK,KAAK,CAAI7C,GAAAA;AACjD,aAAO4C,IAAcE;AAAAA,IAAAA,CACtB;AAECN,QAAAA,EAAcxC,SAAS;AACzB,UAAIgC,MAAS,SAASQ,EAAcxC,WAAW;AAErCwC,QAAAA,IAAAA,EAAc,CAAC,EAAE3C;AAAAA,eAChBmC,MAAS,QAAQ;AAGtBe,YAAAA,IAAQ,GAFYvD,EAAmBC,CAAW,CAExB;AAC9B,eAAOI,KAAS,QAAM;AACpB,gBAAMmD,IAAYD;AAOlB,cANQP,KAAAA,IAAAA,EAAcS,KAAK7C,CAAKA,MAAAA,EAAEP,MAAMyC,WAAWU,CAAS,CAAC,MAArDR,gBAAAA,EACJ3C,OAGGkD,IAAAA,EAAKV,QAAQ,eAAe,GAAG,GAElCU,MAAS;AACX;AAAA,QAEJ;AAAA,MACF;AAAA;AAGF,WAAOlD,IACF,GAAEqD,EAAYrD,GAAOoC,CAAU,CAAE,GAAEC,KAAU,EAAG,GAAEC,KAAQ,EAAG,KAC9D7C;AAAAA,EAEN,GAAA,CAACoB,GAAcS,KAAAA,gBAAAA,EAAaoB,EAAE,CAChC,GAYMY,IAAWrB,EACf,CAAC1C,GAAQgE,MAA8B;AACjCL,QAAAA;AACAxD,QAAAA,EAAkBH,CAAE;AACfA,MAAAA,IAAAA;AAAAA,SACF;AACCS,YAAAA,IAAQgC,EAAazC,GAAI;AAAA,QAAE4C,MAAMoB,KAAAA,gBAAAA,EAASpB;AAAAA,MAAAA,CAAM;AAEtD,UAAInC,KAAS;AACP,YAAA,OAAOT,KAAO;AACTA,UAAAA,IAAAA;AAAAA,aACF;AAELiE,kBAAQC,KACL,4CAA2ClE,EAAGC,UAAW,aAC5D;AACA;AAAA,QACF;AAAA;AAEOQ,QAAAA,IAAAA;AAAAA,IAEX;AAEI0D,QAAAA;AACJ,IAAIH,KAAW,SACTA,EAAQpB,QAAQ,OACAoB,IAAAA,KAEAG,IAAA;AAAA,MAAE,GAAGH;AAAAA,IAAAA,GACvB,OAAOG,EAAgBvB,MACnBwB,OAAOC,KAAKF,CAAe,EAAEvD,WAAW,MACxBV,IAAAA,WAKxBgC,EAAoByB,GAAMQ,CAAe;AAAA,EAAA,GAE3C,CAAC1B,GAAcP,CAAmB,CACpC;AAEO,SAAA;AAAA,IAAEO,cAAAA;AAAAA,IAAcsB,UAAAA;AAAAA,EAAAA;AACzB,GAEAO,IAAenD;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hitachivantara/app-shell-navigation",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "AppShell Navigation",
   "author": "Hitachi Vantara - Boba Fett Team",
   "license": "Apache-2.0",
@@ -35,7 +35,7 @@
     "coverage": "vitest run --coverage"
   },
   "dependencies": {
-    "@hitachivantara/app-shell-shared": "1.0.0",
+    "@hitachivantara/app-shell-shared": "1.1.0",
     "path-to-regexp": "^6.2.1"
   },
   "peerDependencies": {
@@ -56,5 +56,5 @@
     "vite-plugin-dts": "^3.6.4",
     "vite-tsconfig-paths": "^4.0.5"
   },
-  "gitHead": "eccbbda7fa0fa5cdb38c2665d9d6233dd9fc2eb5"
+  "gitHead": "6140d2027f6c2d215f1d3c015a9adafd0cf00de6"
 }