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

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

@@ -4,6 +4,9 @@ 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.
@@ -23,37 +26,10 @@ export type ContextPathResolveArgs = {
   validate?: (contextId: string) => boolean;
 };
 
-// GUID pattern
+// 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})$/;
 
-/**
- * Method will try to extract a context id from a path.
- * The default matcher is a GUID pattern.
- * Will iterate over the path and return the first match.
- *
- * @example
- * ```ts
- * const path = '/apps/context/7fd97952-7fe6-409b-a6dc-292dbf0e50d7?dsadasdas#example';
- * const contextId = extractContextIdFromPath(path); // '7fd97952-7fe6-409b-a6dc-292dbf0e50d7'
- * ```
- *
- * @param path string - the path to extract the context id from
- * @param matcher RegExp - the pattern to match against
- * @returns string | undefined - the context id or undefined
- */
-export const extractContextIdFromPath = (
-  path: string,
-  matcher: RegExp = matchGUID,
-): string | undefined =>
-  path
-    // remove leading slashes
-    .replace(/^\/+/, '')
-    // split path by slashes
-    .split('/')
-    // find the first path fragment that matches the matcher
-    .find((x) => x.match(matcher));
-
 const validateContextId = (contextId: string): boolean => !!contextId.match(matchGUID);
 
 /**
@@ -75,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>,
@@ -98,12 +78,23 @@ 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>,
   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,
@@ -111,9 +102,11 @@ export function resolveContextFromPath(
   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);
     }

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,28 +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.0';
+export const version = '8.0.2';

package/dist/esm/errors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IACjD,QAAQ,CAAC;IAET;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,YACE,OASC,EACD,OAAsB;QAEtB,KAAK,CAAC,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACrD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;IACzC,CAAC;CACF"}

package/dist/esm/selectors.js

@@ -1,58 +0,0 @@
-/**
- * Parses the context type from the response of the GetContext API.
- *
- * @param type The type property from the GetContext response.
- * @returns The parsed context item type.
- */
-const parseContextType = (type) => ({
-    id: type.id,
-    isChildType: type.isChildType,
-    parentTypeIds: type.parentTypeIds ?? [],
-});
-/**
- * Parses an ApiContextEntity object into a ContextItem object.
- * @param item The ApiContextEntity object to parse.
- * @returns The parsed ContextItem object.
- */
-const parseContextItem = (item) => {
-    return {
-        id: item.id,
-        externalId: item.externalId ?? undefined,
-        isActive: item.isActive,
-        isDeleted: item.isDeleted,
-        created: new Date(item.created),
-        source: item.source ?? undefined,
-        title: item.title ?? undefined,
-        type: parseContextType(item.type),
-        // TODO
-        value: item.value ?? {},
-    };
-};
-/**
- * Parse the response from the GetContext API into a context item.
- * @param response The response object containing the context item.
- * @returns A promise that resolves to the context item.
- */
-export const getContextSelector = async (response) => {
-    const result = (await response.json());
-    return parseContextItem(result);
-};
-/**
- * Parse the response from the QueryContext API into an array of context items.
- * @param response The response object.
- * @returns A promise that resolves to an array of context items.
- */
-export const queryContextSelector = async (response) => {
-    const result = (await response.json());
-    return result.map(parseContextItem);
-};
-/**
- * Parse the response from the RelatedContext API into an array of context items.
- * @param response The response object containing the related context items.
- * @returns A promise that resolves to an array of ContextItem objects.
- */
-export const relatedContextSelector = async (response) => {
-    const result = (await response.json());
-    return result.map(parseContextItem);
-};
-//# sourceMappingURL=selectors.js.map

package/dist/esm/selectors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../src/selectors.ts"],"names":[],"mappings":"AASA;;;;;GAKG;AACH,MAAM,gBAAgB,GAAG,CAAC,IAAsC,EAAmB,EAAE,CAAC,CAAC;IACrF,EAAE,EAAE,IAAI,CAAC,EAAE;IACX,WAAW,EAAE,IAAI,CAAC,WAAW;IAC7B,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,EAAE;CACxC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,gBAAgB,GAAG,CAAC,IAAqC,EAAe,EAAE;IAC9E,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,SAAS;QACxC,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,OAAO,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;QAC/B,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,SAAS;QAChC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,SAAS;QAC9B,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;QACjC,OAAO;QACP,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;KACxB,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EAAE,QAAkB,EAAwB,EAAE;IACnF,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA6B,CAAC;IACnE,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EAAE,QAAkB,EAA0B,EAAE;IACvF,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA+B,CAAC;IACrE,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,KAAK,EAAE,QAAkB,EAA0B,EAAE;IACzF,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAiC,CAAC;IACvE,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;AACtC,CAAC,CAAC"}

package/dist/types/selectors.d.ts

@@ -1,19 +0,0 @@
-import type { ContextItem } from './types';
-/**
- * Parse the response from the GetContext API into a context item.
- * @param response The response object containing the context item.
- * @returns A promise that resolves to the context item.
- */
-export declare const getContextSelector: (response: Response) => Promise<ContextItem>;
-/**
- * Parse the response from the QueryContext API into an array of context items.
- * @param response The response object.
- * @returns A promise that resolves to an array of context items.
- */
-export declare const queryContextSelector: (response: Response) => Promise<ContextItem[]>;
-/**
- * Parse the response from the RelatedContext API into an array of context items.
- * @param response The response object containing the related context items.
- * @returns A promise that resolves to an array of ContextItem objects.
- */
-export declare const relatedContextSelector: (response: Response) => Promise<ContextItem[]>;

package/src/selectors.ts

@@ -1,70 +0,0 @@
-import type {
-  ApiVersion,
-  ApiContextEntity,
-} from '@equinor/fusion-framework-module-services/context';
-import type { GetContextResponse } from '@equinor/fusion-framework-module-services/context/get';
-import type { QueryContextResponse } from '@equinor/fusion-framework-module-services/context/query';
-import type { RelatedContextResponse } from '@equinor/fusion-framework-module-services/context/related';
-import type { ContextItem, ContextItemType } from './types';
-
-/**
- * Parses the context type from the response of the GetContext API.
- *
- * @param type The type property from the GetContext response.
- * @returns The parsed context item type.
- */
-const parseContextType = (type: GetContextResponse<'v1'>['type']): ContextItemType => ({
-  id: type.id,
-  isChildType: type.isChildType,
-  parentTypeIds: type.parentTypeIds ?? [],
-});
-
-/**
- * Parses an ApiContextEntity object into a ContextItem object.
- * @param item The ApiContextEntity object to parse.
- * @returns The parsed ContextItem object.
- */
-const parseContextItem = (item: ApiContextEntity<ApiVersion.v1>): ContextItem => {
-  return {
-    id: item.id,
-    externalId: item.externalId ?? undefined,
-    isActive: item.isActive,
-    isDeleted: item.isDeleted,
-    created: new Date(item.created),
-    source: item.source ?? undefined,
-    title: item.title ?? undefined,
-    type: parseContextType(item.type),
-    // TODO
-    value: item.value ?? {},
-  };
-};
-
-/**
- * Parse the response from the GetContext API into a context item.
- * @param response The response object containing the context item.
- * @returns A promise that resolves to the context item.
- */
-export const getContextSelector = async (response: Response): Promise<ContextItem> => {
-  const result = (await response.json()) as GetContextResponse<'v1'>;
-  return parseContextItem(result);
-};
-
-/**
- * Parse the response from the QueryContext API into an array of context items.
- * @param response The response object.
- * @returns A promise that resolves to an array of context items.
- */
-export const queryContextSelector = async (response: Response): Promise<ContextItem[]> => {
-  const result = (await response.json()) as QueryContextResponse<'v1'>;
-  return result.map(parseContextItem);
-};
-
-/**
- * Parse the response from the RelatedContext API into an array of context items.
- * @param response The response object containing the related context items.
- * @returns A promise that resolves to an array of ContextItem objects.
- */
-export const relatedContextSelector = async (response: Response): Promise<ContextItem[]> => {
-  const result = (await response.json()) as RelatedContextResponse<'v1'>;
-  return result.map(parseContextItem);
-};