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

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

@@ -1,22 +0,0 @@
-import { type AgnosticRouteObject, type Path, type To } from '@remix-run/router';
-import { BaseModuleProvider, type BaseModuleProviderCtorArgs } from '@equinor/fusion-framework-module/provider';
-import type { INavigationProvider } from './INavigationProvider';
-import type { INavigationConfigurator } from '../../configurator';
-import { type INavigator } from '../../navigator';
-export declare class NavigationProvider extends BaseModuleProvider<INavigationConfigurator> implements INavigationProvider {
-    #private;
-    get state$(): import("rxjs").Observable<{
-        action: import("@remix-run/router").Action;
-        location: Path;
-    }>;
-    get navigator(): INavigator;
-    get path(): Path;
-    constructor(args: BaseModuleProviderCtorArgs<INavigationConfigurator>);
-    createRouter(routes: AgnosticRouteObject[]): import("@remix-run/router").Router;
-    createHref(to?: To): string;
-    createURL(to?: To): URL;
-    push(to: To, state?: unknown): void;
-    replace(to: To, state?: unknown): void;
-    protected _localizePath(location: Path): Path;
-    protected _createToPath(to: To): Partial<Path>;
-}

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

@@ -1,2 +0,0 @@
-export { INavigationProvider } from './INavigationProvider';
-export { NavigationProvider } from './NavigationProvider';

package/dist/types/navigator.d.ts

@@ -1,105 +0,0 @@
-import type { History, To, Path, Location } from '@remix-run/router';
-import { Observable } from 'rxjs';
-import type { NavigationUpdate, NavigationListener } from './types';
-/**
- * Interface representing a navigator that extends both an observable of navigation updates and the History interface.
- */
-export interface INavigator<T extends NavigationUpdate = NavigationUpdate> extends Observable<T>, History {
-    readonly basename?: string;
-    readonly origin?: string;
-    readonly value: NavigationUpdate;
-    readonly location: NavigationUpdate['location'];
-    dispose: VoidFunction;
-    listen(listener: NavigationListener): VoidFunction;
-}
-/**
- * Class representing a navigator that manages navigation and history state.
- */
-export declare class Navigator<T extends NavigationUpdate = NavigationUpdate> extends Observable<T> implements INavigator<T> {
-    #private;
-    /**
-     * Gets the basename of the navigator.
-     */
-    get basename(): string | undefined;
-    /**
-     * Gets the origin of the navigator.
-     */
-    get origin(): string | undefined;
-    /**
-     * Gets the current navigation state as an observable.
-     */
-    get state(): Observable<T>;
-    /**
-     * Gets the current navigation state value.
-     */
-    get value(): T;
-    /**
-     * Gets the current location from the navigation state.
-     */
-    get location(): T['location'];
-    /**
-     * Gets the current action from the navigation state.
-     */
-    get action(): T['action'];
-    /**
-     * Navigator constructor.
-     * @param args - Configuration options for the navigator.
-     */
-    constructor(args: {
-        basename?: string;
-        history: History;
-        logger?: any;
-        mode?: 'MASTER' | 'SLAVE';
-    });
-    /**
-     * Encodes a location into a path string.
-     * @param to - The location to encode.
-     * @returns The encoded path string.
-     */
-    encodeLocation(to: To): Path;
-    /**
-     * Subscribes to navigation updates.
-     * @param listener - The listener function to receive updates.
-     * @returns A function to unsubscribe the listener.
-     */
-    listen(listener: NavigationListener): VoidFunction;
-    /**
-     * Creates a URL string for a given location.
-     * @param to - The location to create a URL for.
-     * @returns The created URL string.
-     */
-    createHref(to: To): string;
-    /**
-     * 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: number): void;
-    /**
-     * 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: To, state?: unknown): void;
-    /**
-     * 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: To, state?: unknown): void;
-    /**
-     * Creates a full URL for a given location.
-     * @param to - The location to create a URL for.
-     * @returns The created URL object.
-     */
-    createURL(to: To): URL;
-    /**
-     * 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.
-     */
-    protected _isDuplicateLocation(location: Location): boolean;
-    /**
-     * Disposes of the navigator by unsubscribing from all subscriptions.
-     */
-    dispose(): void;
-}

package/dist/types/types.d.ts

@@ -1,3 +0,0 @@
-import type { History } from '@remix-run/router';
-export type NavigationListener = Parameters<History['listen']>[0];
-export type NavigationUpdate = Parameters<NavigationListener>[0];

package/src/configurator.ts

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

package/src/createHistory.ts

@@ -1,21 +0,0 @@
-import { createBrowserHistory, createHashHistory, createMemoryHistory } from '@remix-run/router';
-import type { History } from '@remix-run/router';
-
-type HistoryType = 'browser' | 'hash' | 'memory';
-
-export const createHistory = (type?: HistoryType): History => {
-  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');
-    }
-  }
-};

package/src/lib/provider/INavigationProvider.ts

@@ -1,46 +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;
-
-  // TODO - create own router object type, too many mismatch on type
-  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;
-}

package/src/lib/provider/NavigationProvider.ts

@@ -1,117 +0,0 @@
-import { type AgnosticRouteObject, createRouter, type Path, type To } from '@remix-run/router';
-
-import { filter, map } from 'rxjs/operators';
-
-import {
-  BaseModuleProvider,
-  type BaseModuleProviderCtorArgs,
-} from '@equinor/fusion-framework-module/provider';
-
-import type { INavigationProvider } from './INavigationProvider';
-
-import type { INavigationConfigurator } from '../../configurator';
-import { Navigator, type INavigator } from '../../navigator';
-
-const normalizePathname = (path: string) => path.replace(/\/+/g, '/');
-
-export class NavigationProvider
-  extends BaseModuleProvider<INavigationConfigurator>
-  implements INavigationProvider
-{
-  #navigator: INavigator;
-  #basePathname?: string;
-
-  public 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),
-      })),
-    );
-  }
-
-  public get navigator(): INavigator {
-    return this.#navigator;
-  }
-
-  public get path(): Path {
-    return this._localizePath(this.navigator.location);
-  }
-
-  constructor(args: BaseModuleProviderCtorArgs<INavigationConfigurator>) {
-    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());
-  }
-
-  public createRouter(routes: AgnosticRouteObject[]) {
-    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;
-  }
-
-  public createHref(to?: To): string {
-    return this.#navigator.createHref(this._createToPath(to ?? this.path));
-  }
-
-  public createURL(to?: To): URL {
-    return this.#navigator.createURL(this._createToPath(to ?? this.path));
-  }
-
-  public push(to: To, state?: unknown): void {
-    this.#navigator.push(this._createToPath(to), state);
-  }
-
-  public replace(to: To, state?: unknown): void {
-    this.#navigator.replace(this._createToPath(to), state);
-  }
-
-  protected _localizePath(location: Path): Path {
-    const { pathname, search, hash } = location;
-    return {
-      // TODO make better check
-      pathname: normalizePathname(pathname.replace(this.#basePathname ?? '', '')),
-      search,
-      hash,
-    };
-  }
-
-  protected _createToPath(to: To): Partial<Path> {
-    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,
-    };
-  }
-}

package/src/lib/provider/index.ts

@@ -1,2 +0,0 @@
-export { INavigationProvider } from './INavigationProvider';
-export { NavigationProvider } from './NavigationProvider';

package/src/navigator.ts

@@ -1,204 +0,0 @@
-import type { History, To, Path, Location } from '@remix-run/router';
-import { BehaviorSubject, Observable, Subscription } from 'rxjs';
-
-import type { NavigationUpdate, NavigationListener } from './types';
-
-/**
- * Interface representing a navigator that extends both an observable of navigation updates and the History interface.
- */
-export interface INavigator<T extends NavigationUpdate = NavigationUpdate>
-  extends Observable<T>,
-    History {
-  readonly basename?: string;
-  readonly origin?: string;
-  readonly value: NavigationUpdate;
-  readonly location: NavigationUpdate['location'];
-  dispose: VoidFunction;
-  listen(listener: NavigationListener): VoidFunction;
-}
-
-/**
- * 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: To): to is Location => typeof to === 'object' && 'key' in to;
-
-/**
- * Class representing a navigator that manages navigation and history state.
- */
-export class Navigator<T extends NavigationUpdate = NavigationUpdate>
-  extends Observable<T>
-  implements INavigator<T>
-{
-  #history: History;
-  #baseName?: string;
-  #origin?: string = window.location.origin;
-  #subscriptions = new Subscription();
-  #state: BehaviorSubject<T>;
-
-  #logger: typeof console;
-
-  /**
-   * Gets the basename of the navigator.
-   */
-  get basename(): string | undefined {
-    return this.#baseName;
-  }
-
-  /**
-   * Gets the origin of the navigator.
-   */
-  get origin(): string | undefined {
-    return this.#origin;
-  }
-
-  /**
-   * Gets the current navigation state as an observable.
-   */
-  get state(): Observable<T> {
-    return this.#state.asObservable();
-  }
-
-  /**
-   * Gets the current navigation state value.
-   */
-  get value(): T {
-    return this.#state.value;
-  }
-
-  /**
-   * Gets the current location from the navigation state.
-   */
-  get location(): T['location'] {
-    return this.value.location;
-  }
-
-  /**
-   * Gets the current action from the navigation state.
-   */
-  get action(): T['action'] {
-    return this.value.action;
-  }
-
-  /**
-   * Navigator constructor.
-   * @param args - Configuration options for the navigator.
-   */
-  constructor(args: {
-    basename?: string;
-    history: History;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    logger?: any;
-    mode?: 'MASTER' | 'SLAVE';
-  }) {
-    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<T>({
-      action: this.#history.action,
-      location: this.#history.location,
-      delta: null,
-    } as T);
-    this.#subscriptions.add(
-      this.#history.listen((update) => {
-        // Prevent duplicate state updates.
-        if (update.location.key !== this.#state.value.location.key) {
-          this.#state.next(update as T);
-        }
-      }),
-    );
-  }
-
-  /**
-   * Encodes a location into a path string.
-   * @param to - The location to encode.
-   * @returns The encoded path string.
-   */
-  public encodeLocation(to: To): Path {
-    return this.#history.encodeLocation(to);
-  }
-
-  /**
-   * Subscribes to navigation updates.
-   * @param listener - The listener function to receive updates.
-   * @returns A function to unsubscribe the listener.
-   */
-  public listen(listener: NavigationListener): VoidFunction {
-    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.
-   */
-  public createHref(to: To): string {
-    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.
-   */
-  public go(delta: number): void {
-    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.
-   */
-  public push(to: To, state?: unknown): void {
-    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.
-   */
-  public replace(to: To, state?: unknown): void {
-    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.
-   */
-  public createURL(to: To): URL {
-    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.
-   */
-  protected _isDuplicateLocation(location: 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();
-  }
-}

package/src/types.ts

@@ -1,4 +0,0 @@
-import type { History } from '@remix-run/router';
-
-export type NavigationListener = Parameters<History['listen']>[0];
-export type NavigationUpdate = Parameters<NavigationListener>[0];