@equinor/fusion-framework-module-navigation 6.0.1 → 7.0.0-next.2

package/src/lib/utils/path-to-url.ts

@@ -0,0 +1,52 @@
+import type { To } from '../types';
+import { encodeTrailingWhitespace } from './encode-trailing-whitespace';
+import { hasProtocol } from './has-protocol';
+import { pathToString } from './path-to-string';
+
+/**
+ * Converts a path to a URL object.
+ *
+ * This utility handles various path formats and converts them to standard URL objects.
+ * It supports absolute URLs, relative paths, and path objects with pathname/search/hash.
+ *
+ * @param path - The target path (string, Path object, or Location object)
+ * @param origin - Optional origin URL. Defaults to `window.location.origin` in browser environments,
+ *                 or 'http://localhost' in Node.js environments
+ * @returns A URL object for the given path
+ *
+ * @example
+ * ```ts
+ * // Absolute URL with custom origin
+ * pathToUrl('/users?id=1', 'https://example.com')
+ * // URL { href: 'https://example.com/users?id=1', ... }
+ *
+ * // Complete URL with protocol
+ * pathToUrl('https://example.com/users')
+ * // URL { href: 'https://example.com/users', ... }
+ *
+ * // Path object
+ * pathToUrl({ pathname: '/users', search: '?id=1' })
+ * // URL { href: 'http://localhost/users?id=1', ... }
+ *
+ * // Browser environment (uses window.location.origin)
+ * pathToUrl('/dashboard')
+ * // URL { href: 'https://current-site.com/dashboard', ... }
+ * ```
+ */
+export const pathToUrl = (path: To, origin?: string): URL => {
+  // Convert path to string representation
+  const pathString = typeof path === 'string' ? encodeTrailingWhitespace(path) : pathToString(path);
+
+  // If path already has a protocol, it's a complete URL
+  if (hasProtocol(pathString)) {
+    return new URL(pathString);
+  }
+
+  // Determine the origin to use for relative paths
+  const resolvedOrigin =
+    origin ??
+    (typeof window !== 'undefined' ? window.location?.origin : undefined) ??
+    'http://localhost';
+
+  return new URL(pathString, resolvedOrigin);
+};

package/src/lib/utils/resolve-browser-location.ts

@@ -0,0 +1,60 @@
+import type { Location } from '../types';
+import { resolvePath } from './resolve-path';
+
+const resolveState = (target?: { state: unknown }): { state: unknown; key: string } => {
+  const { value, key = 'unknown' } =
+    (target ?? window.history).state ??
+    ({} as {
+      value: unknown;
+      key?: string;
+    });
+  return { state: value, key };
+};
+
+/**
+ * Resolves the current location from window.location.
+ *
+ * @param window - The window object to extract location from
+ * @param target - Optional target object with state
+ * @returns The current location with pathname, search, hash, state, and key
+ *
+ * @example
+ * ```ts
+ * // If window.location is 'https://example.com/users?id=1#section'
+ * resolveWindowLocation(window)
+ * // { pathname: '/users', search: '?id=1', hash: '#section', state: undefined, key: 'unknown' }
+ *
+ * resolveWindowLocation(window, { state: { userId: 123 } })
+ * // { pathname: '/users', search: '?id=1', hash: '#section', state: { userId: 123 }, key: 'abc123' }
+ * ```
+ */
+export const resolveWindowLocation = (window: Window, target?: { state: unknown }): Location => {
+  const { pathname, search, hash } = resolvePath(window.location);
+  const { state, key } = resolveState(target);
+  return { pathname, search, hash, state, key };
+};
+
+/**
+ * Resolves the current location from window.location.hash.
+ *
+ * @param window - The window object to extract location from
+ * @param target - Optional target object with state
+ * @returns The current location with pathname, search, hash, state, and key
+ *
+ * @example
+ * ```ts
+ * // If window.location.hash is '#/users?id=1#section'
+ * resolveHashLocation(window)
+ * // { pathname: '/users', search: '?id=1', hash: '#section', state: undefined, key: 'unknown' }
+ *
+ * // If window.location.hash is '#/dashboard'
+ * resolveHashLocation(window)
+ * // { pathname: '/dashboard', search: '', hash: '', state: undefined, key: 'unknown' }
+ * ```
+ */
+export const resolveHashLocation = (window: Window, target?: { state: unknown }): Location => {
+  const location = resolveWindowLocation(window, target);
+  const { pathname, search, hash } = resolvePath(location.hash?.replace('#', '') ?? '');
+  const { state, key } = resolveState(target);
+  return { pathname, search, hash, state, key };
+};

package/src/lib/utils/resolve-path.ts

@@ -0,0 +1,22 @@
+import type { Path, To } from '../types';
+import { pathToUrl } from './path-to-url';
+
+/**
+ * Resolves a 'to' value into a Path object.
+ *
+ * @param to - The target path (string, Path object, or Location object)
+ * @returns A Path object with the pathname, search, and hash components
+ *
+ * @example
+ * ```ts
+ * resolvePath('/users?id=1#section')
+ * // { pathname: '/users', search: '?id=1', hash: '#section' }
+ *
+ * resolvePath({ pathname: '/users', search: 'id=1', hash: 'section' })
+ * // { pathname: '/users', search: '?id=1', hash: '#section' }
+ * ```
+ */
+export const resolvePath = (to: To): Path => {
+  const { pathname, search, hash } = pathToUrl(to);
+  return { pathname, search, hash };
+};

package/src/module.ts

@@ -1,60 +1,76 @@
-import {
-  type IModuleConfigurator,
-  type IModulesConfigurator,
-  type Module,
-  type ModuleConfigType,
-  type ModuleInstance,
-  SemanticVersion,
-} from '@equinor/fusion-framework-module';
-import { type INavigationConfigurator, NavigationConfigurator } from './configurator';
-import { createHistory } from './createHistory';
-import { type INavigationProvider, NavigationProvider } from './lib';
+import { type Module, SemanticVersion } from '@equinor/fusion-framework-module';
+import { NavigationConfigurator } from './NavigationConfigurator';
+import type { INavigationProvider } from './NavigationProvider.interface';
+import { NavigationProvider } from './NavigationProvider';
 
 import { version } from './version';
 
+/**
+ * Module key identifier for the navigation module.
+ */
 export const moduleKey = 'navigation';
 
+/**
+ * Type definition for the navigation module.
+ *
+ * This is the main type definition for the navigation module. It represents the complete
+ * module structure with its key identifier, provider interface, and configurator class.
+ *
+ * The navigation module provides routing and navigation capabilities compatible with
+ * industry-standard routers (Remix/React Router), with support for browser history,
+ * hash routing, and memory history. It integrates with the Fusion Framework module
+ * system and provides a {@link INavigationProvider} instance that can be used to
+ * access navigation functionality.
+ *
+ * @see {@link INavigationProvider} - The provider interface for accessing navigation
+ * @see {@link NavigationConfigurator} - The configurator class for setting up navigation
+ * @see {@link enableNavigation} - Helper function to enable the navigation module
+ * @see {@link module} - The module implementation instance
+ */
 export type NavigationModule = Module<
   typeof moduleKey,
   INavigationProvider,
-  INavigationConfigurator
+  NavigationConfigurator
 >;
 
+/**
+ * Navigation module implementation.
+ * Provides routing and navigation capabilities compatible with industry-standard routers (Remix/React Router).
+ *
+ * @remarks
+ * - Uses BaseConfigBuilder pattern with Zod validation
+ * - Basename must match the URL path prefix where your app is served
+ * - The router requires URL pathname to start with the basename
+ */
 export const module: NavigationModule = {
   version: new SemanticVersion(version),
   name: moduleKey,
-  configure: (ref?: ModuleInstance) => {
-    const configurator = new NavigationConfigurator();
-    if (ref?.navigation) {
-      configurator.history = ref.navigation.navigator;
-    }
-    return configurator;
-  },
-  initialize: ({ config }) => {
-    config.history ??= createHistory();
+  /**
+   * Configures the navigation module.
+   *
+   * @returns A new NavigationConfigurator instance
+   */
+  configure: () => new NavigationConfigurator(),
+  /**
+   * Initializes the navigation module with validated configuration.
+   *
+   * @param init - Module initialization arguments
+   * @returns A Promise that resolves to a new NavigationProvider instance
+   */
+  initialize: async (init) => {
+    const config = await init.config.createConfigAsync(init);
     return new NavigationProvider({ version, config });
   },
+  /**
+   * Disposes of the navigation module instance.
+   *
+   * @param instance - The NavigationProvider instance to dispose
+   */
   dispose({ instance }) {
     instance.dispose();
   },
 };
 
-export const enableNavigation = <TRef = unknown>(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  configurator: IModulesConfigurator<any, any>,
-  basenameOrOptions?: string | Omit<IModuleConfigurator<NavigationModule, TRef>, 'module'>,
-): void => {
-  const options =
-    typeof basenameOrOptions === 'string'
-      ? {
-          configure: (config: ModuleConfigType<NavigationModule>) => {
-            config.basename = basenameOrOptions;
-          },
-        }
-      : basenameOrOptions;
-  configurator.addConfig({ module, ...options });
-};
-
 export default module;
 
 declare module '@equinor/fusion-framework-module' {

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '6.0.1';
+export const version = '7.0.0-next.2';

package/tsconfig.json

@@ -8,8 +8,17 @@
   "references": [
     {
       "path": "../module"
+    },
+    {
+      "path": "../telemetry"
+    },
+    {
+      "path": "../event"
+    },
+    {
+      "path": "../../utils/observable"
     }
   ],
   "include": ["src/**/*"],
-  "exclude": ["node_modules", "lib"]
+  "exclude": ["node_modules", "lib", "src/__tests__/**/*"]
 }

package/vitest.config.ts

@@ -0,0 +1,14 @@
+import { defineProject } from 'vitest/config';
+
+import { name, version } from './package.json';
+
+export default defineProject({
+  test: {
+    include: ['src/__tests__/**/*.test.ts'],
+    name: `${name}@${version}`,
+    environment: 'jsdom',
+    globals: true,
+    setupFiles: ['./src/__tests__/setup.ts'],
+    testTimeout: 1000,
+  },
+});

package/dist/esm/configurator.js

@@ -1,5 +0,0 @@
-export class NavigationConfigurator {
-    history;
-    basename;
-}
-//# sourceMappingURL=configurator.js.map

package/dist/esm/configurator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"configurator.js","sourceRoot":"","sources":["../../src/configurator.ts"],"names":[],"mappings":"AAOA,MAAM,OAAO,sBAAsB;IAC1B,OAAO,CAAW;IAClB,QAAQ,CAAU;CAC1B"}

package/dist/esm/createHistory.js

@@ -1,18 +0,0 @@
-import { createBrowserHistory, createHashHistory, createMemoryHistory } from '@remix-run/router';
-export const createHistory = (type) => {
-    switch (type) {
-        case 'hash':
-            return createHashHistory({ v5Compat: true });
-        case 'memory':
-            return createMemoryHistory({ v5Compat: true });
-        case 'browser':
-            return createBrowserHistory({
-                v5Compat: true,
-            });
-        default: {
-            console.warn(`Unknown history type: ${type}. Using browser history as default.`);
-            return createHistory('browser');
-        }
-    }
-};
-//# sourceMappingURL=createHistory.js.map

package/dist/esm/createHistory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createHistory.js","sourceRoot":"","sources":["../../src/createHistory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAKjG,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAkB,EAAW,EAAE;IAC3D,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,MAAM;YACT,OAAO,iBAAiB,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,KAAK,QAAQ;YACX,OAAO,mBAAmB,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACjD,KAAK,SAAS;YACZ,OAAO,oBAAoB,CAAC;gBAC1B,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;QACL,OAAO,CAAC,CAAC,CAAC;YACR,OAAO,CAAC,IAAI,CAAC,yBAAyB,IAAI,qCAAqC,CAAC,CAAC;YACjF,OAAO,aAAa,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;AACH,CAAC,CAAC"}

package/dist/esm/lib/provider/INavigationProvider.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=INavigationProvider.js.map

package/dist/esm/lib/provider/INavigationProvider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"INavigationProvider.js","sourceRoot":"","sources":["../../../../src/lib/provider/INavigationProvider.ts"],"names":[],"mappings":""}

package/dist/esm/lib/provider/NavigationProvider.js

@@ -1,82 +0,0 @@
-import { createRouter } from '@remix-run/router';
-import { filter, map } from 'rxjs/operators';
-import { BaseModuleProvider, } from '@equinor/fusion-framework-module/provider';
-import { Navigator } from '../../navigator';
-const normalizePathname = (path) => path.replace(/\/+/g, '/');
-export class NavigationProvider extends BaseModuleProvider {
-    #navigator;
-    #basePathname;
-    get state$() {
-        return this.#navigator.pipe(
-        /** only push navigation state if the path is within the basename scope */
-        filter((event) => this.#basePathname ? event.location.pathname.startsWith(this.#basePathname) : true), 
-        /** map path to localized path */
-        map(({ action, location }) => ({
-            action,
-            location: this._localizePath(location),
-        })));
-    }
-    get navigator() {
-        return this.#navigator;
-    }
-    get path() {
-        return this._localizePath(this.navigator.location);
-    }
-    constructor(args) {
-        super(args);
-        const { basename, history } = args.config;
-        this.#basePathname = basename;
-        if (!history) {
-            throw Error('no history provided!');
-        }
-        this.#navigator = new Navigator({
-            basename,
-            history,
-        });
-        this._addTeardown(() => this.#navigator.dispose());
-    }
-    createRouter(routes) {
-        const history = this.#navigator;
-        console.debug('NavigationProvider::createRouter', routes);
-        const router = createRouter({
-            basename: history.basename,
-            history,
-            routes,
-            future: {
-                v7_prependBasename: true,
-            },
-        });
-        router.initialize();
-        return router;
-    }
-    createHref(to) {
-        return this.#navigator.createHref(this._createToPath(to ?? this.path));
-    }
-    createURL(to) {
-        return this.#navigator.createURL(this._createToPath(to ?? this.path));
-    }
-    push(to, state) {
-        this.#navigator.push(this._createToPath(to), state);
-    }
-    replace(to, state) {
-        this.#navigator.replace(this._createToPath(to), state);
-    }
-    _localizePath(location) {
-        const { pathname, search, hash } = location;
-        return {
-            // TODO make better check
-            pathname: normalizePathname(pathname.replace(this.#basePathname ?? '', '')),
-            search,
-            hash,
-        };
-    }
-    _createToPath(to) {
-        const { pathname, search, hash } = typeof to === 'string' ? { pathname: to, search: undefined, hash: undefined } : to;
-        return {
-            pathname: normalizePathname([this.#basePathname, pathname === '/' ? undefined : pathname].filter((x) => !!x).join('/')),
-            search,
-            hash,
-        };
-    }
-}
-//# sourceMappingURL=NavigationProvider.js.map

package/dist/esm/lib/provider/NavigationProvider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"NavigationProvider.js","sourceRoot":"","sources":["../../../../src/lib/provider/NavigationProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,YAAY,EAAsB,MAAM,mBAAmB,CAAC;AAE/F,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EACL,kBAAkB,GAEnB,MAAM,2CAA2C,CAAC;AAKnD,OAAO,EAAE,SAAS,EAAmB,MAAM,iBAAiB,CAAC;AAE7D,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEtE,MAAM,OAAO,kBACX,SAAQ,kBAA2C;IAGnD,UAAU,CAAa;IACvB,aAAa,CAAU;IAEvB,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI;QACzB,0EAA0E;QAC1E,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CACf,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CACnF;QACD,iCAAiC;QACjC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;YAC7B,MAAM;YACN,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;SACvC,CAAC,CAAC,CACJ,CAAC;IACJ,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,YAAY,IAAyD;QACnE,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAE1C,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC;QAE9B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,KAAK,CAAC,sBAAsB,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,IAAI,SAAS,CAAC;YAC9B,QAAQ;YACR,OAAO;SACR,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;IACrD,CAAC;IAEM,YAAY,CAAC,MAA6B;QAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC;QAChC,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,YAAY,CAAC;YAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,OAAO;YACP,MAAM;YACN,MAAM,EAAE;gBACN,kBAAkB,EAAE,IAAI;aACzB;SACF,CAAC,CAAC;QACH,MAAM,CAAC,UAAU,EAAE,CAAC;QACpB,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,UAAU,CAAC,EAAO;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzE,CAAC;IAEM,SAAS,CAAC,EAAO;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACxE,CAAC;IAEM,IAAI,CAAC,EAAM,EAAE,KAAe;QACjC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAEM,OAAO,CAAC,EAAM,EAAE,KAAe;QACpC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IACzD,CAAC;IAES,aAAa,CAAC,QAAc;QACpC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC;QAC5C,OAAO;YACL,yBAAyB;YACzB,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;YAC3E,MAAM;YACN,IAAI;SACL,CAAC;IACJ,CAAC;IAES,aAAa,CAAC,EAAM;QAC5B,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAC9B,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrF,OAAO;YACL,QAAQ,EAAE,iBAAiB,CACzB,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3F;YACD,MAAM;YACN,IAAI;SACL,CAAC;IACJ,CAAC;CACF"}

package/dist/esm/lib/provider/index.js

@@ -1,2 +0,0 @@
-export { NavigationProvider } from './NavigationProvider';
-//# sourceMappingURL=index.js.map

package/dist/esm/lib/provider/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/provider/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/esm/navigator.js

@@ -1,158 +0,0 @@
-import { BehaviorSubject, Observable, Subscription } from 'rxjs';
-/**
- * Type guard to check if a given 'to' parameter is a Location object.
- * @param to - The object to check.
- * @returns True if 'to' is a Location object, false otherwise.
- */
-const isLocation = (to) => typeof to === 'object' && 'key' in to;
-/**
- * Class representing a navigator that manages navigation and history state.
- */
-export class Navigator extends Observable {
-    #history;
-    #baseName;
-    #origin = window.location.origin;
-    #subscriptions = new Subscription();
-    #state;
-    #logger;
-    /**
-     * Gets the basename of the navigator.
-     */
-    get basename() {
-        return this.#baseName;
-    }
-    /**
-     * Gets the origin of the navigator.
-     */
-    get origin() {
-        return this.#origin;
-    }
-    /**
-     * Gets the current navigation state as an observable.
-     */
-    get state() {
-        return this.#state.asObservable();
-    }
-    /**
-     * Gets the current navigation state value.
-     */
-    get value() {
-        return this.#state.value;
-    }
-    /**
-     * Gets the current location from the navigation state.
-     */
-    get location() {
-        return this.value.location;
-    }
-    /**
-     * Gets the current action from the navigation state.
-     */
-    get action() {
-        return this.value.action;
-    }
-    /**
-     * Navigator constructor.
-     * @param args - Configuration options for the navigator.
-     */
-    constructor(args) {
-        super((subscriber) => this.#state.subscribe(subscriber));
-        const { basename, history } = args;
-        this.#logger = args.logger || console;
-        this.#baseName = basename;
-        this.#history = history;
-        this.#state = new BehaviorSubject({
-            action: this.#history.action,
-            location: this.#history.location,
-            delta: null,
-        });
-        this.#subscriptions.add(this.#history.listen((update) => {
-            // Prevent duplicate state updates.
-            if (update.location.key !== this.#state.value.location.key) {
-                this.#state.next(update);
-            }
-        }));
-    }
-    /**
-     * Encodes a location into a path string.
-     * @param to - The location to encode.
-     * @returns The encoded path string.
-     */
-    encodeLocation(to) {
-        return this.#history.encodeLocation(to);
-    }
-    /**
-     * Subscribes to navigation updates.
-     * @param listener - The listener function to receive updates.
-     * @returns A function to unsubscribe the listener.
-     */
-    listen(listener) {
-        const subscription = this.#state.subscribe(listener);
-        this.#logger.debug('Navigator::listen', listener);
-        return () => {
-            this.#logger.debug('Navigator::listen[unsubscribe]', listener);
-            return subscription.unsubscribe();
-        };
-    }
-    /**
-     * Creates a URL string for a given location.
-     * @param to - The location to create a URL for.
-     * @returns The created URL string.
-     */
-    createHref(to) {
-        return this.#history.createHref(to);
-    }
-    /**
-     * Navigates to a specific history entry by its relative position to the current entry.
-     * @param delta - The relative position to move in the history stack.
-     */
-    go(delta) {
-        this.#history.go(delta);
-    }
-    /**
-     * Pushes a new entry onto the history stack.
-     * @param to - The location or URL to navigate to.
-     * @param state - Optional state to associate with the navigation.
-     */
-    push(to, state) {
-        const skip = isLocation(to) && this._isDuplicateLocation(to);
-        if (!skip) {
-            this.#history.push(to, state);
-        }
-    }
-    /**
-     * Replaces the current history entry with a new one.
-     * @param to - The location or URL to navigate to.
-     * @param state - Optional state to associate with the navigation.
-     */
-    replace(to, state) {
-        const skip = isLocation(to) && this._isDuplicateLocation(to);
-        if (!skip) {
-            this.#history.replace(to, state);
-        }
-    }
-    /**
-     * Creates a full URL for a given location.
-     * @param to - The location to create a URL for.
-     * @returns The created URL object.
-     */
-    createURL(to) {
-        return this.#history.createURL(to);
-    }
-    /**
-     * Checks if a given location is a duplicate of the current location.
-     * @param location - The location to check.
-     * @returns True if the location is a duplicate, false otherwise.
-     */
-    _isDuplicateLocation(location) {
-        // TODO: might check if there are changes in the URL compared to the current location.
-        return location.key === this.#state.value.location.key;
-    }
-    /**
-     * Disposes of the navigator by unsubscribing from all subscriptions.
-     */
-    dispose() {
-        this.#subscriptions.unsubscribe();
-    }
-}
-//# sourceMappingURL=navigator.js.map

package/dist/esm/navigator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"navigator.js","sourceRoot":"","sources":["../../src/navigator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAkBjE;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAC,EAAM,EAAkB,EAAE,CAAC,OAAO,EAAE,KAAK,QAAQ,IAAI,KAAK,IAAI,EAAE,CAAC;AAErF;;GAEG;AACH,MAAM,OAAO,SACX,SAAQ,UAAa;IAGrB,QAAQ,CAAU;IAClB,SAAS,CAAU;IACnB,OAAO,GAAY,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC1C,cAAc,GAAG,IAAI,YAAY,EAAE,CAAC;IACpC,MAAM,CAAqB;IAE3B,OAAO,CAAiB;IAExB;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,YAAY,IAMX;QACC,KAAK,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;QACzD,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAI;YACnC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ;YAChC,KAAK,EAAE,IAAI;SACP,CAAC,CAAC;QACR,IAAI,CAAC,cAAc,CAAC,GAAG,CACrB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE;YAC9B,mCAAmC;YACnC,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;gBAC3D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAW,CAAC,CAAC;YAChC,CAAC;QACH,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,EAAM;QAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAA4B;QACxC,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QAClD,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,QAAQ,CAAC,CAAC;YAC/D,OAAO,YAAY,CAAC,WAAW,EAAE,CAAC;QACpC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,EAAM;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACI,EAAE,CAAC,KAAa;QACrB,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,EAAM,EAAE,KAAe;QACjC,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,EAAM,EAAE,KAAe;QACpC,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,EAAM;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACO,oBAAoB,CAAC,QAAkB;QAC/C,sFAAsF;QACtF,OAAO,QAAQ,CAAC,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC;IACpC,CAAC;CACF"}

package/dist/esm/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/dist/types/configurator.d.ts

@@ -1,9 +0,0 @@
-import type { History } from '@remix-run/router';
-export interface INavigationConfigurator {
-    basename?: string;
-    history?: History;
-}
-export declare class NavigationConfigurator implements INavigationConfigurator {
-    history?: History;
-    basename?: string;
-}

package/dist/types/createHistory.d.ts

@@ -1,4 +0,0 @@
-import type { History } from '@remix-run/router';
-type HistoryType = 'browser' | 'hash' | 'memory';
-export declare const createHistory: (type?: HistoryType) => History;
-export {};

package/dist/types/lib/provider/INavigationProvider.d.ts

@@ -1,38 +0,0 @@
-import type { Action, AgnosticRouteObject, Path, Router, To } from '@remix-run/router';
-import type { INavigator } from '../../navigator';
-import type { Observable } from 'rxjs';
-import type { IModuleProvider } from '@equinor/fusion-framework-module';
-export interface INavigationProvider extends IModuleProvider {
-    /**
-     * Observer navigation changes, will return localized paths
-     */
-    readonly state$: Observable<{
-        action: Action;
-        location: Path;
-    }>;
-    /**
-     * Localized current path
-     */
-    readonly path: Path;
-    /**
-     * History controller
-     */
-    readonly navigator: INavigator;
-    createRouter(routes: AgnosticRouteObject[]): Router;
-    /**
-     * Create a localized pathname
-     */
-    createHref(to?: To): string;
-    /**
-     * Create a localized URL
-     */
-    createURL(to?: To): URL;
-    /**
-     * Execute a relative `push` navigation
-     */
-    push(to: To, state?: unknown): void;
-    /**
-     * Execute a relative `replace` navigation
-     */
-    replace(to: To, state?: unknown): void;
-}