@equinor/fusion-framework-module-context 8.0.1 → 8.0.2

package/dist/types/ContextProvider.d.ts

@@ -6,6 +6,7 @@ import type { ContextItem, QueryContextParameters, RelatedContextParameters } fr
 import type { ModuleType } from '@equinor/fusion-framework-module';
 import type { EventModule, FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-module-event';
 import Query from '@equinor/fusion-query';
+import type { SemVer } from 'semver';
 /**
  * Interface representing a provider for managing and interacting with context items within an application.
  *
@@ -257,6 +258,13 @@ export interface IContextProvider {
      * @returns path for the context item
      */
     generatePathFromContext?: (context: ContextItem, path: string) => string | undefined;
+    /**
+     * The version of the context provider.
+     *
+     * @remarks
+     * This property represents the version of the context provider, which can be a string or a SemVer object.
+     */
+    readonly version: string | SemVer;
 }
 /**
  * Provides context management functionality, including querying, setting, validating, and resolving context items.

package/dist/types/utils/extract-context-id-from-path.d.ts

@@ -7,6 +7,12 @@
  * ```ts
  * const path = '/apps/context/7fd97952-7fe6-409b-a6dc-292dbf0e50d7?dsadasdas#example';
  * const contextId = extractContextIdFromPath(path); // '7fd97952-7fe6-409b-a6dc-292dbf0e50d7'
+ *
+ * // Custom matcher for numeric IDs
+ * extractContextIdFromPath('/projects/42/details', /^\d+$/);  // '42'
+ *
+ * // No match
+ * extractContextIdFromPath('/apps/my-app/settings'); // undefined
  * ```
  *
  * @param path string - the path to extract the context id from

package/dist/types/utils/resolve-context-from-path.d.ts

@@ -39,6 +39,10 @@ export type ContextPathResolveArgs = {
  *
  * @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 declare function resolveContextFromPath(context: ModuleType<ContextModule>): (path: string) => Observable<ContextItem>;
 /**
@@ -59,6 +63,10 @@ export declare function resolveContextFromPath(context: ModuleType<ContextModule
  * @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 declare function resolveContextFromPath(context: ModuleType<ContextModule>, args?: ContextPathResolveArgs): (path: string) => Observable<ContextItem>;
 export default resolveContextFromPath;

package/dist/types/utils/resolve-initial-context.d.ts

@@ -1,5 +1,4 @@
 import type { ContextModuleConfig } from '../configurator';
-import { type ContextPathResolveArgs } from './resolve-context-from-path';
 /**
  * Resolves the initial context from the parent module.
  *
@@ -10,12 +9,10 @@ export declare const resolveContextFromParent: ContextModuleConfig['resolveIniti
 /**
  * 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.
+ * Attempts to resolve the initial context from the parent context provider.
+ * URL-based resolution is handled by the context-navigation plugin.
  *
- * @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.
  */
-export declare const resolveInitialContext: (options?: {
-    path?: ContextPathResolveArgs;
-}) => Required<ContextModuleConfig>['resolveInitialContext'];
+export declare const resolveInitialContext: () => Required<ContextModuleConfig>['resolveInitialContext'];
 export default resolveInitialContext;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.0.1";
+export declare const version = "8.0.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-context",
-  "version": "8.0.1",
+  "version": "8.0.2",
   "description": "",
   "main": "./dist/esm/index.js",
   "exports": {
@@ -45,19 +45,23 @@
   },
   "dependencies": {
     "fast-deep-equal": "^3.1.3",
-    "@equinor/fusion-query": "^7.0.2"
+    "@equinor/fusion-query": "^7.0.3"
   },
   "devDependencies": {
     "rxjs": "^7.8.1",
     "typescript": "^7.0.2",
-    "@equinor/fusion-framework-module-navigation": "^7.0.5",
-    "@equinor/fusion-framework-module": "^6.1.1",
-    "@equinor/fusion-framework-module-services": "^8.0.2",
-    "@equinor/fusion-framework-module-event": "^6.0.1"
+    "@types/semver": "^7.0.0",
+    "semver": "^7.0.0",
+    "@equinor/fusion-framework-module-event": "^6.0.1",
+    "@equinor/fusion-framework-module-navigation": "^7.0.7",
+    "@equinor/fusion-framework-module": "^6.1.2",
+    "@equinor/fusion-framework-module-services": "^8.0.3"
   },
   "peerDependencies": {
+    "@types/semver": "^7.0.0",
+    "semver": "^7.0.0",
     "rxjs": "^7.0.0",
-    "@equinor/fusion-framework-module": "^6.1.1"
+    "@equinor/fusion-framework-module": "^6.1.2"
   },
   "scripts": {
     "build": "tsc -b"

package/src/ContextProvider.ts

@@ -24,6 +24,7 @@ import type {
   FrameworkEventInit,
 } from '@equinor/fusion-framework-module-event';
 import Query from '@equinor/fusion-query';
+import type { SemVer } from 'semver';
 
 /**
  * Interface representing a provider for managing and interacting with context items within an application.
@@ -296,6 +297,13 @@ export interface IContextProvider {
    * @returns path for the context item
    */
   generatePathFromContext?: (context: ContextItem, path: string) => string | undefined;
+  /**
+   * The version of the context provider.
+   *
+   * @remarks
+   * This property represents the version of the context provider, which can be a string or a SemVer object.
+   */
+  readonly version: string | SemVer;
 }
 
 /**
@@ -435,12 +443,12 @@ export class ContextProvider
 
     // override extractContextIdFromPath if configured
     if (config.extractContextIdFromPath) {
-      // @ts-expect-error
+      // @ts-expect-error - this is to avoid breaking change, the signature will be updated in future major release
       this.extractContextIdFromPath = config.extractContextIdFromPath;
     }
     // override generatePathFromContext if configured
     if (config.generatePathFromContext) {
-      // @ts-expect-error
+      // @ts-expect-error - this is to avoid breaking change, the signature will be updated in future major release
       this.generatePathFromContext = config.generatePathFromContext;
     }
 

package/src/configurator.ts

@@ -249,12 +249,7 @@ export class ContextModuleConfigurator implements IContextModuleConfigurator {
       Promise.resolve({} as Partial<ContextModuleConfig>),
     );
 
-    config.resolveInitialContext ??= resolveInitialContext({
-      path: {
-        extract: config.extractContextIdFromPath,
-        validate: config.extractContextIdFromPath ? () => true : undefined,
-      },
-    });
+    config.resolveInitialContext ??= resolveInitialContext();
 
     // TODO(#5119) - make less lazy
     config.client ??= await (async (): Promise<ContextModuleConfig['client']> => {

package/src/utils/extract-context-id-from-path.ts

@@ -11,6 +11,12 @@ const matchGUID =
  * ```ts
  * const path = '/apps/context/7fd97952-7fe6-409b-a6dc-292dbf0e50d7?dsadasdas#example';
  * const contextId = extractContextIdFromPath(path); // '7fd97952-7fe6-409b-a6dc-292dbf0e50d7'
+ *
+ * // Custom matcher for numeric IDs
+ * extractContextIdFromPath('/projects/42/details', /^\d+$/);  // '42'
+ *
+ * // No match
+ * extractContextIdFromPath('/apps/my-app/settings'); // undefined
  * ```
  *
  * @param path string - the path to extract the context id from
@@ -21,7 +27,10 @@ export const extractContextIdFromPath = (
   path: string,
   matcher: RegExp = matchGUID,
 ): string | undefined =>
+  //
   path
+    // remove query-string and hash fragments before segment matching
+    .split(/[?#]/)[0]
     // remove leading slashes
     .replace(/^\/+/, '')
     // split path by slashes

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

@@ -51,6 +51,10 @@ const validateContextId = (contextId: string): boolean => !!contextId.match(matc
  *
  * @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>,
@@ -74,6 +78,10 @@ export function resolveContextFromPath(
  * @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>,

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

@@ -1,10 +1,7 @@
 import type { ModulesInstance } from '@equinor/fusion-framework-module';
 import type { ContextModule } from '../module';
 import type { ContextModuleConfig } from '../configurator';
-import { concat, EMPTY, first, of } from 'rxjs';
-
-import { type ContextPathResolveArgs, resolveContextFromPath } from './resolve-context-from-path';
-import type { NavigationModule } from '@equinor/fusion-framework-module-navigation';
+import { concat, EMPTY, of, take } from 'rxjs';
 
 /**
  * Resolves the initial context from the parent module.
@@ -14,9 +11,9 @@ import type { NavigationModule } from '@equinor/fusion-framework-module-navigati
  */
 export const resolveContextFromParent: ContextModuleConfig['resolveInitialContext'] = ({ ref }) => {
   const parentContext = (ref as ModulesInstance<[ContextModule]>)?.context;
-  // check if the parent has context module
   if (!parentContext) {
-    throw Error(['resolveContextFromNavigation', 'ref does not support context!'].join('\n'));
+    // 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;
@@ -25,30 +22,19 @@ export const resolveContextFromParent: ContextModuleConfig['resolveInitialContex
 /**
  * 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.
+ * Attempts to resolve the initial context from the parent context provider.
+ * URL-based resolution is handled by the context-navigation plugin.
  *
- * @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'] =>
+  (): 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(first());
+    // Resolve from parent context if available.
+    // URL-based resolution is handled by the context-navigation plugin.
+    return concat(resolveContextFromParent({ ref, modules })).pipe(take(1));
   };
 
 export default resolveInitialContext;

package/src/version.ts

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