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

package/dist/esm/NavigationConfigurator.js

@@ -0,0 +1,144 @@
+import { z } from 'zod';
+import { of } from 'rxjs';
+import { BaseConfigBuilder, } from '@equinor/fusion-framework-module';
+import { createHistory } from './lib/create-history';
+/**
+ * Zod schema for navigation module configuration validation.
+ *
+ * @internal
+ */
+const navigationConfigSchema = z
+    .object({
+    basename: z
+        .string()
+        .optional()
+        .describe('Base pathname for the application (e.g., "/app"). Must match the URL path prefix where your app is served. The router requires the pathname to start with this basename.'),
+    history: z
+        .custom()
+        .describe('Custom history instance implementing the History interface. Defaults to browser history if not provided. Use createHistory("browser"|"hash"|"memory") to create instances.'),
+    telemetry: z
+        .custom()
+        .optional()
+        .describe('Telemetry provider for tracking navigation events. Used to log navigation actions, location changes, and errors for monitoring and debugging.'),
+    eventProvider: z
+        .custom()
+        .optional()
+        .describe('Event provider for dispatching navigation events (NavigateEvent, NavigatedEvent). Allows other modules to listen for navigation changes and block navigation attempts.'),
+})
+    .describe('Validates navigation module configuration settings for routing and navigation capabilities.');
+/**
+ * Parses and validates a navigation configuration object.
+ *
+ * @param config - The configuration object to parse
+ * @returns Validated navigation configuration
+ * @throws {z.ZodError} If the configuration is invalid
+ */
+const parseNavigationConfig = (config) => {
+    return navigationConfigSchema.parse(config);
+};
+/**
+ * Configurator class for navigation module settings.
+ * Extends BaseConfigBuilder to provide fluent configuration API with Zod validation.
+ */
+export class NavigationConfigurator extends BaseConfigBuilder {
+    constructor() {
+        super();
+        this.setEventProvider(async (args) => {
+            if (args.hasModule('event')) {
+                return await args.requireInstance('event');
+            }
+        });
+        this.setHistory(async (args) => {
+            const history = args.ref?.navigation?.history;
+            if (history) {
+                return history;
+            }
+            if (typeof window !== 'undefined') {
+                return createHistory('browser');
+            }
+            return createHistory('memory');
+        });
+    }
+    /**
+     * @deprecated Use `setBasename()` method instead
+     */
+    set basename(value) {
+        if (process.env.NODE_ENV === 'development') {
+            console.warn('NavigationConfigurator.basename', 'use setBasename() method instead');
+        }
+        this.setBasename(value);
+    }
+    /**
+     * @deprecated Use `setHistory()` method instead
+     */
+    set history(value) {
+        if (process.env.NODE_ENV === 'development') {
+            console.warn('NavigationConfigurator.history', 'use setHistory() method instead');
+        }
+        this.setHistory(value);
+    }
+    /**
+     * Sets the basename for the application.
+     *
+     * @param basenameOrCallback - Basename string or configuration callback
+     * @returns The configurator instance for method chaining
+     */
+    setBasename(basenameOrCallback) {
+        const fn = typeof basenameOrCallback === 'function'
+            ? basenameOrCallback
+            : async () => basenameOrCallback;
+        this._set('basename', fn);
+        return this;
+    }
+    /**
+     * Sets a custom history instance for the navigation module.
+     *
+     * @param historyOrCallback - History instance or configuration callback
+     * @returns The configurator instance for method chaining
+     */
+    setHistory(historyOrCallback) {
+        const fn = typeof historyOrCallback === 'function' ? historyOrCallback : async () => historyOrCallback;
+        this._set('history', fn);
+        return this;
+    }
+    /**
+     * Sets telemetry configuration for navigation-specific events.
+     *
+     * @param telemetryOrCallback - Telemetry provider instance or configuration callback
+     * @returns The configurator instance for method chaining
+     */
+    setTelemetry(telemetryOrCallback) {
+        const fn = typeof telemetryOrCallback === 'function'
+            ? telemetryOrCallback
+            : async () => telemetryOrCallback;
+        this._set('telemetry', fn);
+        return this;
+    }
+    /**
+     * Sets event provider for dispatching navigation events.
+     *
+     * @param eventProviderOrCallback - Event provider instance or configuration callback
+     * @returns The configurator instance for method chaining
+     */
+    setEventProvider(eventProviderOrCallback) {
+        const fn = typeof eventProviderOrCallback === 'function'
+            ? eventProviderOrCallback
+            : async () => eventProviderOrCallback;
+        this._set('eventProvider', fn);
+        return this;
+    }
+    /**
+     * Processes and validates the configuration using Zod schema.
+     *
+     * @param config - Raw configuration object from builder
+     * @param _init - Configuration builder callback arguments (unused)
+     * @returns Observable that emits validated and processed configuration object
+     * @throws {z.ZodError} If the configuration is invalid
+     *
+     * @protected
+     */
+    _processConfig(config, _init) {
+        return of(parseNavigationConfig(config));
+    }
+}
+//# sourceMappingURL=NavigationConfigurator.js.map

package/dist/esm/NavigationConfigurator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigationConfigurator.js","sourceRoot":"","sources":["../../src/NavigationConfigurator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,EAAE,EAAwB,MAAM,MAAM,CAAC;AAChD,OAAO,EACL,iBAAiB,GAIlB,MAAM,kCAAkC,CAAC;AAM1C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAGrD;;;;GAIG;AACH,MAAM,sBAAsB,GAAG,CAAC;KAC7B,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,0KAA0K,CAC3K;IACH,OAAO,EAAE,CAAC;SACP,MAAM,EAAW;SACjB,QAAQ,CACP,4KAA4K,CAC7K;IACH,SAAS,EAAE,CAAC;SACT,MAAM,EAAsB;SAC5B,QAAQ,EAAE;SACV,QAAQ,CACP,+IAA+I,CAChJ;IACH,aAAa,EAAE,CAAC;SACb,MAAM,EAAwB;SAC9B,QAAQ,EAAE;SACV,QAAQ,CACP,wKAAwK,CACzK;CACJ,CAAC;KACD,QAAQ,CACP,6FAA6F,CAC9F,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,qBAAqB,GAAG,CAAC,MAAe,EAA2B,EAAE;IACzE,OAAO,sBAAsB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC9C,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,iBAA0C;IACpF;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACnC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5B,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAC7B,MAAM,OAAO,GAAI,IAAI,CAAC,GAA2C,EAAE,UAAU,EAAE,OAAO,CAAC;YACvF,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,OAAO,CAAC;YACjB,CAAC;YACD,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;gBAClC,OAAO,aAAa,CAAC,SAAS,CAAC,CAAC;YAClC,CAAC;YACD,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IACD;;OAEG;IACH,IAAW,QAAQ,CAAC,KAAyB;QAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;YAC3C,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,kCAAkC,CAAC,CAAC;QACtF,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAW,OAAO,CAAC,KAA0B;QAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;YAC3C,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,iCAAiC,CAAC,CAAC;QACpF,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,kBAA2D;QAC5E,MAAM,EAAE,GACN,OAAO,kBAAkB,KAAK,UAAU;YACtC,CAAC,CAAC,kBAAkB;YACpB,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,kBAAkB,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,iBAA4D;QAC5E,MAAM,EAAE,GACN,OAAO,iBAAiB,KAAK,UAAU,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,iBAAiB,CAAC;QAC9F,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,YAAY,CACjB,mBAAmF;QAEnF,MAAM,EAAE,GACN,OAAO,mBAAmB,KAAK,UAAU;YACvC,CAAC,CAAC,mBAAmB;YACrB,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,mBAAmB,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CACrB,uBAA2F;QAE3F,MAAM,EAAE,GACN,OAAO,uBAAuB,KAAK,UAAU;YAC3C,CAAC,CAAC,uBAAuB;YACzB,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,uBAAuB,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACO,cAAc,CACtB,MAAwC,EACxC,KAAgC;QAEhC,OAAO,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/dist/esm/NavigationProvider.interface.js

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

package/dist/esm/NavigationProvider.interface.js.map

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

package/dist/esm/NavigationProvider.js

@@ -0,0 +1,256 @@
+// TODO: Remove @remix-run/router dependency once all apps have migrated to @equinor/fusion-framework-react-router
+import { createRouter } from '@remix-run/router';
+import { filter, pairwise, shareReplay } from 'rxjs/operators';
+import { BaseModuleProvider, } from '@equinor/fusion-framework-module/provider';
+import { TelemetryLevel, TelemetryScope, } from '@equinor/fusion-framework-module-telemetry';
+import { NavigatedEvent } from './events';
+import { pathToString } from './lib/utils';
+/**
+ * Normalizes a pathname by:
+ * - Collapsing multiple consecutive slashes into a single slash
+ * - Removing trailing slashes
+ *
+ * @example
+ * normalizePathname("/app//users///profile/") // returns "/app/users/profile"
+ * normalizePathname("///multiple///slashes///") // returns "/multiple/slashes"
+ *
+ * @param path - The pathname to normalize
+ * @returns The normalized pathname without consecutive or trailing slashes
+ */
+const normalizePathname = (path) => path.replace(/\/+/g, '/').replace(/\/$/, '');
+/**
+ * Navigation provider implementation.
+ * Manages routing and navigation state with basename localization.
+ *
+ * @remarks
+ * This provider:
+ * - Wraps the Navigator to provide observable navigation state
+ * - Localizes paths by removing basename prefix
+ * - Creates routers compatible with industry-standard routers (Remix/React Router)
+ * - Handles navigation actions (push, replace, createHref, etc.)
+ *
+ * Path localization ensures that consumers receive paths relative to the basename,
+ * while internally we work with full paths including basename.
+ */
+export class NavigationProvider extends BaseModuleProvider {
+    #history;
+    #basename;
+    #state$;
+    #telemetry;
+    #event;
+    /**
+     * Observable stream of navigation state updates.
+     * Emits localized paths (with basename removed) for consumers.
+     */
+    get state$() {
+        return this.#state$;
+    }
+    /**
+     * Gets the basename.
+     */
+    get basename() {
+        return this.#basename ?? '';
+    }
+    /**
+     * @deprecated Use `history` instead
+     */
+    get navigator() {
+        this.#telemetry?.trackException({
+            name: 'Navigation::navigator.deprecated',
+            exception: new Error('navigator is deprecated, use history instead'),
+            level: TelemetryLevel.Warning,
+            scope: ['navigation', TelemetryScope.Framework],
+        });
+        return this.#history;
+    }
+    /**
+     * Gets the history instance.
+     */
+    get history() {
+        return this.#history;
+    }
+    /**
+     * Gets the current localized path (basename removed).
+     */
+    get path() {
+        return this._localizePath(this.#history.location);
+    }
+    /**
+     * @param args - Configuration arguments containing module config
+     * @throws {Error} If no history is provided in the configuration
+     */
+    constructor(args) {
+        super(args);
+        // Extract configuration values
+        const { basename, history, telemetry, eventProvider } = args.config;
+        this.#basename = basename;
+        this.#event = eventProvider;
+        this.#telemetry = telemetry;
+        // History is required - validate and track error if missing
+        if (!history) {
+            this.#telemetry?.trackException({
+                name: 'Navigation::history.required',
+                exception: new Error('no history provided!'),
+                level: TelemetryLevel.Error,
+                scope: ['navigation', TelemetryScope.Application],
+            });
+            throw Error('no history provided!');
+        }
+        this.#history = history;
+        // Create state$ observable that filters for paths within basename scope
+        // shareReplay ensures subscribers get the latest value and share the subscription
+        this.#state$ = this.#history.state$.pipe(filter((update) => this._isWithinBasenameScope(update.location.pathname)), shareReplay({ bufferSize: 1, refCount: true }));
+        this._initialize();
+    }
+    /**
+     * Sets up navigation subscriptions for events and telemetry.
+     *
+     * Configures subscriptions for:
+     * - NavigatedEvent dispatching when navigation changes
+     * - Telemetry tracking for navigation actions and events
+     * - History disposal cleanup
+     */
+    _initialize() {
+        // Dispatch NavigatedEvent and track telemetry when navigation changes
+        // pairwise() gives us [previous, current] pairs to compare navigation state
+        this._addTeardown(this.#state$.pipe(pairwise()).subscribe(([previous, current]) => {
+            // emit NavigatedEvent for other modules to listen to when navigation changes
+            this.#event?.dispatchEvent(new NavigatedEvent({
+                action: current.action,
+                current,
+                previous,
+            }, this));
+            // track telemetry for navigation changes
+            this.#telemetry?.trackEvent({
+                name: 'Navigation::navigated',
+                level: TelemetryLevel.Information,
+                scope: ['navigation', TelemetryScope.Application],
+                properties: {
+                    action: current.action,
+                    location: pathToString(current.location),
+                    previousLocation: pathToString(previous.location),
+                },
+            });
+        }));
+        // Track all navigation actions for debugging (if telemetry is enabled)
+        if (this.#telemetry) {
+            this._addTeardown(this.#history.action$.subscribe((action) => {
+                this.#telemetry?.trackEvent({
+                    name: `Navigation::action:${action.type}`,
+                    level: TelemetryLevel.Debug,
+                    scope: ['navigation', TelemetryScope.Framework],
+                    properties: {
+                        type: action.type,
+                        action: action,
+                    },
+                });
+            }));
+        }
+        // Clean up history instance when provider is disposed
+        this._addTeardown(() => this.#history[Symbol.dispose]());
+    }
+    /**
+     * Creates a router instance from route configuration.
+     *
+     * @deprecated Use `@equinor/fusion-framework-react-router` instead
+     *
+     * @param routes - Route configuration objects compatible with industry-standard routers (Remix/React Router)
+     * @returns A configured and initialized router instance
+     */
+    createRouter(routes) {
+        this.#telemetry?.trackEvent({
+            name: 'Navigation::createRouter',
+            level: TelemetryLevel.Warning,
+            scope: ['navigation', 'deprecated', TelemetryScope.Application],
+        });
+        const router = createRouter({
+            basename: this.#basename,
+            history: this.#history,
+            routes,
+            future: {
+                v7_prependBasename: true,
+            },
+        });
+        router.initialize();
+        return router;
+    }
+    /**
+     * Creates a localized href string for navigation.
+     *
+     * @param to - Optional path or location (defaults to current path)
+     */
+    createHref(to) {
+        return this.#history.createHref(this._createToPath(to ?? this.path));
+    }
+    /**
+     * Creates a full URL object for navigation.
+     *
+     * @param to - Optional path or location (defaults to current path)
+     */
+    createURL(to) {
+        return this.#history.createURL(this._createToPath(to ?? this.path));
+    }
+    /**
+     * Pushes a new navigation entry onto the history stack.
+     *
+     * @param to - Path or location to navigate to (relative to basename)
+     * @param state - Optional state to associate with the navigation
+     */
+    push(to, state) {
+        this.navigate(to, { state });
+    }
+    /**
+     * Replaces the current history entry with a new one.
+     *
+     * @param to - Path or location to navigate to (relative to basename)
+     * @param state - Optional state to associate with the navigation
+     */
+    replace(to, state) {
+        this.navigate(to, { replace: true, state });
+    }
+    /**
+     * Navigate to a location with explicit options.
+     *
+     * @param to - Optional path or location (defaults to current path)
+     * @param options - Optional navigation options
+     */
+    navigate(to, options) {
+        const { replace = false, state } = options ?? {};
+        this.#history.navigate(this._createToPath(to ?? this.path), { replace, state });
+        // we need to pop the history to update the notify history listeners
+        // Frameworks as react router have their internal state management,
+        // so we need to force a pop to notify the framework that the history has changed
+        this.#history.pop();
+    }
+    /**
+     * Checks if a pathname is within the basename scope.
+     */
+    _isWithinBasenameScope(pathname) {
+        return this.#basename ? pathname.startsWith(this.#basename) : true;
+    }
+    /**
+     * Localizes a path by removing the basename prefix.
+     */
+    _localizePath(location) {
+        const { pathname, search, hash } = location;
+        return {
+            pathname: normalizePathname(pathname.replace(this.#basename ?? '', '')),
+            search,
+            hash,
+        };
+    }
+    /**
+     * Creates a full path object from a target location, adding basename prefix.
+     */
+    _createToPath(to) {
+        // Parse the 'to' parameter into path components
+        const pathComponents = typeof to === 'string' ? { pathname: to } : to;
+        // Extract path parts, defaulting to current path values
+        const rawPathname = pathComponents.pathname ?? this.path.pathname;
+        const pathname = normalizePathname(`${this.#basename ?? ''}/${rawPathname}`);
+        const search = pathComponents.search ?? this.path.search;
+        const hash = pathComponents.hash ?? this.path.hash;
+        return { pathname, search, hash };
+    }
+}
+//# sourceMappingURL=NavigationProvider.js.map

package/dist/esm/NavigationProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavigationProvider.js","sourceRoot":"","sources":["../../src/NavigationProvider.ts"],"names":[],"mappings":"AAAA,kHAAkH;AAClH,OAAO,EAA4B,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE3E,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE/D,OAAO,EACL,kBAAkB,GAEnB,MAAM,2CAA2C,CAAC;AAKnD,OAAO,EACL,cAAc,EACd,cAAc,GAEf,MAAM,4CAA4C,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C;;;;;;;;;;;GAWG;AACH,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAEzF;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,kBACX,SAAQ,kBAA2C;IAGnD,QAAQ,CAAU;IAClB,SAAS,CAAU;IACnB,OAAO,CAA+B;IAEtC,UAAU,CAAsB;IAChC,MAAM,CAAwB;IAE9B;;;OAGG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAClB,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC;YAC9B,IAAI,EAAE,kCAAkC;YACxC,SAAS,EAAE,IAAI,KAAK,CAAC,8CAA8C,CAAC;YACpE,KAAK,EAAE,cAAc,CAAC,OAAO;YAC7B,KAAK,EAAE,CAAC,YAAY,EAAE,cAAc,CAAC,SAAS,CAAC;SAChD,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,YAAY,IAAyD;QACnE,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,+BAA+B;QAC/B,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAEpE,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,4DAA4D;QAC5D,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC;gBAC9B,IAAI,EAAE,8BAA8B;gBACpC,SAAS,EAAE,IAAI,KAAK,CAAC,sBAAsB,CAAC;gBAC5C,KAAK,EAAE,cAAc,CAAC,KAAK;gBAC3B,KAAK,EAAE,CAAC,YAAY,EAAE,cAAc,CAAC,WAAW,CAAC;aAClD,CAAC,CAAC;YACH,MAAM,KAAK,CAAC,sBAAsB,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,wEAAwE;QACxE,kFAAkF;QAClF,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CACtC,MAAM,CAAC,CAAC,MAAwB,EAAE,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAC3F,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAC/C,CAAC;QAEF,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;;OAOG;IACO,WAAW;QACnB,sEAAsE;QACtE,4EAA4E;QAC5E,IAAI,CAAC,YAAY,CACf,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,EAAE;YAC9D,6EAA6E;YAC7E,IAAI,CAAC,MAAM,EAAE,aAAa,CACxB,IAAI,cAAc,CAChB;gBACE,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,OAAO;gBACP,QAAQ;aACT,EACD,IAAI,CACL,CACF,CAAC;YACF,yCAAyC;YACzC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC;gBAC1B,IAAI,EAAE,uBAAuB;gBAC7B,KAAK,EAAE,cAAc,CAAC,WAAW;gBACjC,KAAK,EAAE,CAAC,YAAY,EAAE,cAAc,CAAC,WAAW,CAAC;gBACjD,UAAU,EAAE;oBACV,MAAM,EAAE,OAAO,CAAC,MAAM;oBACtB,QAAQ,EAAE,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC;oBACxC,gBAAgB,EAAE,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC;iBAClD;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CACH,CAAC;QAEF,uEAAuE;QACvE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC,YAAY,CACf,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE;gBACzC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC;oBAC1B,IAAI,EAAE,sBAAsB,MAAM,CAAC,IAAI,EAAE;oBACzC,KAAK,EAAE,cAAc,CAAC,KAAK;oBAC3B,KAAK,EAAE,CAAC,YAAY,EAAE,cAAc,CAAC,SAAS,CAAC;oBAC/C,UAAU,EAAE;wBACV,IAAI,EAAE,MAAM,CAAC,IAAI;wBACjB,MAAM,EAAE,MAAM;qBACf;iBACF,CAAC,CAAC;YACL,CAAC,CAAC,CACH,CAAC;QACJ,CAAC;QAED,sDAAsD;QACtD,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACI,YAAY,CAAC,MAA6B;QAC/C,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC;YAC1B,IAAI,EAAE,0BAA0B;YAChC,KAAK,EAAE,cAAc,CAAC,OAAO;YAC7B,KAAK,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,cAAc,CAAC,WAAW,CAAC;SAChE,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,YAAY,CAAC;YAC1B,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,OAAO,EAAE,IAAI,CAAC,QAA0D;YACxE,MAAM;YACN,MAAM,EAAE;gBACN,kBAAkB,EAAE,IAAI;aACzB;SACF,CAAC,CAAC;QACH,MAAM,CAAC,UAAU,EAAE,CAAC;QACpB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,EAAO;QACvB,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,EAAO;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,EAAM,EAAE,KAAe;QACjC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,EAAM,EAAE,KAAe;QACpC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,EAAO,EAAE,OAAkC;QACzD,MAAM,EAAE,OAAO,GAAG,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QACjD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAChF,oEAAoE;QACpE,mEAAmE;QACnE,iFAAiF;QAChF,IAAI,CAAC,QAAwB,CAAC,GAAG,EAAE,CAAC;IACvC,CAAC;IACD;;OAEG;IACO,sBAAsB,CAAC,QAAgB;QAC/C,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACrE,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,QAAc;QACpC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC;QAC5C,OAAO;YACL,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;YACvE,MAAM;YACN,IAAI;SACL,CAAC;IACJ,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,EAAM;QAC5B,gDAAgD;QAChD,MAAM,cAAc,GAAG,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEtE,wDAAwD;QACxD,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;QAClE,MAAM,QAAQ,GAAG,iBAAiB,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,EAAE,IAAI,WAAW,EAAE,CAAC,CAAC;QAC7E,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QACzD,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAEnD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACpC,CAAC;CACF"}

package/dist/esm/enable-navigation.js

@@ -0,0 +1,52 @@
+import { module } from './module';
+/**
+ * Helper function to enable the navigation module.
+ *
+ * This is the main entry point for consumers to add navigation capabilities to their
+ * framework configuration. It registers the navigation module and allows configuration
+ * of basename and other navigation settings.
+ *
+ * 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.
+ *
+ * @param configurator - The modules configurator to add navigation to
+ * @param basenameOrOptions - Optional basename string or configuration object
+ * @param basenameOrOptions.configure - Configuration callback for advanced setup
+ * @typeParam TRef - Reference type for module composition
+ *
+ * @example
+ * ```ts
+ * // Simple usage with basename
+ * enableNavigation(configurator, '/app');
+ *
+ * // Advanced configuration
+ * enableNavigation(configurator, {
+ *   configure(config, ref) {
+ *     config.setBasename('/app');
+ *     config.setHistory(createHistory('browser'));
+ *   }
+ * });
+ * ```
+ *
+ * @see {@link NavigationModule} - The navigation module type
+ * @see {@link INavigationConfigurator} - Configuration interface
+ * @see {@link INavigationProvider} - Provider interface for accessing navigation
+ */
+export const enableNavigation = (
+// biome-ignore lint/suspicious/noExplicitAny: must be any to support all module types
+configurator, basenameOrOptions) => {
+    configurator.addConfig({
+        module,
+        configure(config, ref) {
+            if (typeof basenameOrOptions === 'string') {
+                config.setBasename(basenameOrOptions);
+            }
+            else if (typeof basenameOrOptions === 'object' && 'configure' in basenameOrOptions) {
+                basenameOrOptions.configure(config, ref);
+            }
+        },
+    });
+};
+export default enableNavigation;
+//# sourceMappingURL=enable-navigation.js.map

package/dist/esm/enable-navigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enable-navigation.js","sourceRoot":"","sources":["../../src/enable-navigation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAyB,MAAM,UAAU,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;AAC9B,sFAAsF;AACtF,YAA4C,EAC5C,iBAIK,EACC,EAAE;IACR,YAAY,CAAC,SAAS,CAAC;QACrB,MAAM;QACN,SAAS,CAAC,MAAM,EAAE,GAAG;YACnB,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE,CAAC;gBAC1C,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;YACxC,CAAC;iBAAM,IAAI,OAAO,iBAAiB,KAAK,QAAQ,IAAI,WAAW,IAAI,iBAAiB,EAAE,CAAC;gBACrF,iBAAiB,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,eAAe,gBAAgB,CAAC"}

package/dist/esm/events.js

@@ -0,0 +1,23 @@
+import { FrameworkEvent } from '@equinor/fusion-framework-module-event';
+/**
+ * Event emitted before navigation occurs.
+ * Can be canceled by calling `preventDefault()`.
+ */
+export class NavigateEvent extends FrameworkEvent {
+    constructor(detail, source) {
+        super('onNavigate', {
+            detail,
+            source,
+        });
+    }
+}
+/**
+ * Event emitted after navigation occurs.
+ * Contains the navigation action and location details.
+ */
+export class NavigatedEvent extends FrameworkEvent {
+    constructor(detail, source) {
+        super('onNavigated', { detail, source });
+    }
+}
+//# sourceMappingURL=events.js.map

package/dist/esm/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAA2B,MAAM,wCAAwC,CAAC;AAejG;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,cAElC;IACC,YAAY,MAA2B,EAAE,MAA2B;QAClE,KAAK,CAAC,YAAY,EAAE;YAClB,MAAM;YACN,MAAM;SACP,CAAC,CAAC;IACL,CAAC;CACF;AAcD;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,cAEnC;IACC,YAAY,MAA4B,EAAE,MAA2B;QACnE,KAAK,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/dist/esm/index.js

@@ -1,6 +1,7 @@
-export { NavigationConfigurator } from './configurator';
-export { enableNavigation, module, moduleKey } from './module';
-export { createHistory } from './createHistory';
-export * from './lib';
-export * from './types';
+export { NavigationConfigurator } from './NavigationConfigurator';
+export { module, moduleKey } from './module';
+export { enableNavigation } from './enable-navigation';
+export { NavigationProvider } from './NavigationProvider';
+export { createHistory } from './lib/create-history';
+export { NavigateEvent, NavigatedEvent, } from './events';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAA2B,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAEjF,OAAO,EAAoB,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAEjF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAoB,MAAM,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,OAAO,EACL,aAAa,EACb,cAAc,GAGf,MAAM,UAAU,CAAC"}