@equinor/fusion-framework-module-context 9.0.0 → 9.0.1

package/src/utils/resolve-context-from-path.ts

@@ -1,118 +0,0 @@
-import { EMPTY, type Observable } from 'rxjs';
-
-import type { ModuleType } from '@equinor/fusion-framework-module';
-
-import type { ContextModule } from '../module';
-import type { ContextItem } from '../types';
-import { extractContextIdFromPath } from './extract-context-id-from-path';
-
-export { extractContextIdFromPath } from './extract-context-id-from-path';
-
-/**
- * Arguments for resolving a context from a path.
- */
-export type ContextPathResolveArgs = {
-  /**
-   * Callback to extract a context id from a path.
-   * @param path string - the path to extract the context id from
-   * @returns string | undefined - the context id or undefined
-   */
-  extract?: (path: string) => string | undefined;
-  /**
-   * Callback to validate a context id.
-   * @param contextId string - the context id to validate
-   * @returns boolean - true if the context id is valid
-   */
-  validate?: (contextId: string) => boolean;
-};
-
-// GUID pattern, used as the default context id validator
-const matchGUID =
-  /^(?:(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12})$/;
-
-const validateContextId = (contextId: string): boolean => !!contextId.match(matchGUID);
-
-/**
- * Method will try to resolve a context from a path.
- * The method will return a function that takes a path and returns an observable of the resolved context.
- * The method will use the context module to resolve the context.
- * The method will use the extract and validate methods from the args to extract and validate the context id.
- * If the context id is not valid, the method will throw an error.
- * If the context id is valid, the method will return an observable of the resolved context.
- * If the context id is not found, the method will return an empty observable.
- *
- * @example
- * ```ts
- * const resolve = resolveContextFromPath(modules.context);
- * resolve(
- *  '/apps/context/7fd97952-7fe6-409b-a6dc-292dbf0e50d7?foobar#example'
- * ).subscribe(console.log);
- * ```
- *
- * @param context The context module.
- * @returns A function that takes a path and returns an Observable of the resolved context item.
- * @deprecated Replaced by the context-navigation plugin which resolves
- * initial context from the URL via adapter `decode()` during module initialization.
- * Portal-level code should use `enableContextNavigation` which handles
- * URL-to-context resolution automatically. Will be removed in a future major version.
- */
-export function resolveContextFromPath(
-  context: ModuleType<ContextModule>,
-): (path: string) => Observable<ContextItem>;
-
-/**
- *
- * @example
- * ```ts
- * const resolve = resolveContextFromPath(
- *      modules.context,
- *       {
- *          extract: (path) => path.find(extractingContextFromPath),
- *          validate: (id) => isValidContextId(id)
- * });
- * resolve(
- *      '/apps/context/7fd97952-7fe6-409b-a6dc-292dbf0e50d7?foobar#example'
- * ).subscribe(console.log);
- * ```
- *
- * @param context The context module.
- * @param args The arguments for resolving the path.
- * @returns A function that takes a path and returns an Observable of the resolved context item.
- * @deprecated Replaced by the context-navigation plugin which resolves
- * initial context from the URL via adapter `decode()` during module initialization.
- * Portal-level code should use `enableContextNavigation` which handles
- * URL-to-context resolution automatically. Will be removed in a future major version.
- */
-export function resolveContextFromPath(
-  context: ModuleType<ContextModule>,
-  args?: ContextPathResolveArgs,
-): (path: string) => Observable<ContextItem>;
-
-/**
- * Resolves a context item from a path, using the provided extract/validate callbacks or the defaults.
- * @param context The context module.
- * @param args The arguments for resolving the path.
- * @returns A function that takes a path and returns an Observable of the resolved context item.
- * @throws Error if the extracted context id fails validation.
- */
-export function resolveContextFromPath(
-  context: ModuleType<ContextModule>,
-  args?: ContextPathResolveArgs,
-) {
-  return (path: string) => {
-    const { extract = extractContextIdFromPath, validate = validateContextId } = args ?? {};
-    const contextId = extract(path);
-    // no context id found in the path, nothing to resolve
-    if (!contextId) {
-      return EMPTY;
-    }
-    // only resolve the context if the extracted id passes validation
-    if (validate(contextId)) {
-      return context.contextClient.resolveContext(contextId);
-    }
-
-    throw Error(`Failed to validate context [${contextId}] from path [${path}]`);
-  };
-}
-
-export default resolveContextFromPath;

package/src/utils/resolve-initial-context.ts

@@ -1,58 +0,0 @@
-import type { ModulesInstance } from '@equinor/fusion-framework-module';
-import type { ContextModule } from '../module';
-import type { ContextModuleConfig } from '../ContextModuleConfig';
-import { concat, EMPTY, first, of } from 'rxjs';
-import resolveContextFromPath, { type ContextPathResolveArgs } from './resolve-context-from-path';
-import type { NavigationModule } from '@equinor/fusion-framework-module-navigation';
-
-/**
- * Resolves the initial context from the parent module.
- *
- * @param ref - parent modules.
- * @returns An Observable of the resolved initial context.
- */
-export const resolveContextFromParent: ContextModuleConfig['resolveInitialContext'] = ({ ref }) => {
-  const parentContext = (ref as ModulesInstance<[ContextModule]>)?.context;
-  // check if the parent has context module
-  if (!parentContext) {
-    // No parent context available — either portal level or parent lacks context module.
-    return EMPTY;
-  }
-  // return the current context from the parent or empty if the parent does not have a context
-  return parentContext.currentContext ? of(parentContext.currentContext) : EMPTY;
-};
-
-/**
- * Resolves the initial context for a Fusion Framework context module.
- *
- * will try to resolve the initial context from the path, and if that fails, it will try to resolve the context from the parent.
- *
- * @param options - Optional configuration for resolving the context path.
- * @returns A function that accepts the module's reference and modules, and returns an Observable of the resolved initial context.
- */
-
-// Deliberately co-located with resolveContextFromParent, which it composes with
-// fusion-lint-disable-next-line single-export-per-file
-export const resolveInitialContext =
-  (options?: {
-    path?: ContextPathResolveArgs;
-  }): Required<ContextModuleConfig>['resolveInitialContext'] =>
-  ({ ref, modules }) => {
-    const { context, navigation } = modules;
-    // create a path resolver from the context module
-    const pathResolver = resolveContextFromPath(context, options?.path);
-    // use the path from the navigation module, or the path from the parent navigation module
-    const pathname =
-      navigation?.path.pathname ??
-      (ref as Partial<ModulesInstance<[NavigationModule]>>).navigation?.path.pathname;
-    // try to resolve the context from the path, and if that fails, try to resolve the context from the parent
-    return concat(
-      pathname ? pathResolver(pathname) : EMPTY,
-      resolveContextFromParent({ ref, modules }),
-    ).pipe(
-      // having no initial context is valid; a default avoids first() throwing EmptyError for it
-      first(undefined, undefined),
-    );
-  };
-
-export default resolveInitialContext;

package/src/version.ts

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

package/tsconfig.json

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

package/vitest.config.ts

@@ -1,11 +0,0 @@
-import { defineProject } from 'vitest/config';
-
-import { name, version } from './package.json' with { type: 'json' };
-
-export default defineProject({
-  test: {
-    environment: 'node',
-    include: ['src/__tests__/**/*.test.ts'],
-    name: `${name}@${version}`,
-  },
-});