@equinor/fusion-framework-module-navigation 7.0.9 → 7.0.10

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

@@ -1,52 +0,0 @@
-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

@@ -1 +0,0 @@
-export { resolveWindowLocation } from './resolve-window-location';

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

@@ -1,26 +0,0 @@
-import type { Location } from '../types';
-import { resolvePath } from './resolve-path';
-import { resolveWindowLocation } from './resolve-window-location';
-
-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.hash.
- * @param window - The window object to extract location from.
- * @param target - Optional target object with state.
- * @returns The current hash-based navigation location.
- */
-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, unstable_mask: undefined };
-};

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

@@ -1,22 +0,0 @@
-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/lib/utils/resolve-window-location.ts

@@ -1,24 +0,0 @@
-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 browser navigation location.
- */
-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, unstable_mask: undefined };
-};

package/src/module.ts

@@ -1,80 +0,0 @@
-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,
-  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,
-  /**
-   * Creates a new {@link NavigationConfigurator} for the module.
-   *
-   * @returns A fresh {@link NavigationConfigurator} instance with default settings
-   */
-  configure: () => new NavigationConfigurator(),
-  /**
-   * Initializes the navigation module with validated configuration.
-   *
-   * @param init - Module initialization arguments containing config and refs
-   * @returns A promise that resolves to a configured {@link NavigationProvider}
-   */
-  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 default module;
-
-declare module '@equinor/fusion-framework-module' {
-  interface Modules {
-    navigation: NavigationModule;
-  }
-}

package/src/version.ts

@@ -1,2 +0,0 @@
-// Generated by genversion.
-export const version = '7.0.9';

package/tsconfig.json

@@ -1,24 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "dist/esm",
-    "rootDir": "src",
-    "declarationDir": "./dist/types"
-  },
-  "references": [
-    {
-      "path": "../module"
-    },
-    {
-      "path": "../telemetry"
-    },
-    {
-      "path": "../event"
-    },
-    {
-      "path": "../../utils/observable"
-    }
-  ],
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "lib", "src/__tests__/**/*"]
-}

package/vitest.config.ts

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