@equinor/fusion-framework-module-context 5.0.19 → 5.1.0

package/dist/types/ContextConfigBuilder.d.ts

@@ -16,6 +16,19 @@ export declare class ContextConfigBuilder<TModules extends Array<AnyModule> = []
     setContextParameterFn(fn: ContextModuleConfig['contextParameterFn']): void;
     setValidateContext(fn: ContextModuleConfig['validateContext']): void;
     setResolveContext(fn: ContextModuleConfig['resolveContext']): void;
+    /**
+     * Sets the function responsible for extracting the context ID from a given path.
+     *
+     * @param fn - A function that defines how to extract the context ID from a path.
+     *             This function should match the type defined in `ContextModuleConfig['extractContextIdFromPath']`.
+     */
+    setContextPathExtractor(fn: ContextModuleConfig['extractContextIdFromPath']): void;
+    /**
+     * Sets the function responsible for generating a path from the context.
+     *
+     * @param fn - A function that takes a context and generates a corresponding path.
+     */
+    setContextPathGenerator(fn: ContextModuleConfig['generatePathFromContext']): void;
     setResolveInitialContext(fn: ContextModuleConfig['resolveInitialContext']): void;
     setContextClient(client: {
         get: QueryFn<ContextItem, GetContextParameters> | QueryCtorOptions<ContextItem, GetContextParameters>;

package/dist/types/ContextProvider.d.ts

@@ -101,6 +101,21 @@ export interface IContextProvider {
         validate?: boolean;
         resolve?: boolean;
     }): Promise<ContextItem<Record<string, unknown>> | null>;
+    /**
+     * Method for extracting context id from a path.
+     *
+     * @param path path to resolve context from
+     * @returns the resolved context item id
+     */
+    extractContextIdFromPath?: (path: string) => string | undefined;
+    /**
+     * Method for generating path from a context item.
+     *
+     * @param context context item to generate path from
+     * @param path current path
+     * @returns path for the context item
+     */
+    generatePathFromContext?: (context: ContextItem, path: string) => string | undefined;
 }
 export declare class ContextProvider implements IContextProvider {
     #private;

package/dist/types/configurator.d.ts

@@ -23,6 +23,8 @@ export interface ContextModuleConfig {
     connectParentContext?: boolean;
     /** set initial context from parent, will await resolve */
     skipInitialContext?: boolean;
+    extractContextIdFromPath?: (path: string) => string | undefined;
+    generatePathFromContext?: (context: ContextItem, path: string) => string | undefined;
     /**
      * Method for generating context query parameters.
      */

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.0.19";
+export declare const version = "5.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-context",
-  "version": "5.0.19",
+  "version": "5.1.0",
   "description": "",
   "main": "./dist/esm/index.js",
   "exports": {
@@ -50,9 +50,9 @@
   "devDependencies": {
     "rxjs": "^7.8.1",
     "typescript": "^5.8.2",
-    "@equinor/fusion-framework-module": "^4.3.7",
     "@equinor/fusion-framework-module-event": "^4.3.2",
     "@equinor/fusion-framework-module-navigation": "^4.0.9",
+    "@equinor/fusion-framework-module": "^4.3.7",
     "@equinor/fusion-framework-module-services": "^5.1.2"
   },
   "peerDependencies": {

package/src/ContextConfigBuilder.ts

@@ -74,6 +74,25 @@ export class ContextConfigBuilder<
     this.config.resolveContext = fn;
   }
 
+  /**
+   * Sets the function responsible for extracting the context ID from a given path.
+   *
+   * @param fn - A function that defines how to extract the context ID from a path.
+   *             This function should match the type defined in `ContextModuleConfig['extractContextIdFromPath']`.
+   */
+  setContextPathExtractor(fn: ContextModuleConfig['extractContextIdFromPath']) {
+    this.config.extractContextIdFromPath = fn;
+  }
+
+  /**
+   * Sets the function responsible for generating a path from the context.
+   *
+   * @param fn - A function that takes a context and generates a corresponding path.
+   */
+  setContextPathGenerator(fn: ContextModuleConfig['generatePathFromContext']) {
+    this.config.generatePathFromContext = fn;
+  }
+
   setResolveInitialContext(fn: ContextModuleConfig['resolveInitialContext']) {
     this.config.resolveInitialContext = fn;
   }

package/src/ContextProvider.ts

@@ -138,6 +138,23 @@ export interface IContextProvider {
     context: ContextItem<Record<string, unknown>> | null,
     opt?: { validate?: boolean; resolve?: boolean },
   ): Promise<ContextItem<Record<string, unknown>> | null>;
+
+  /**
+   * Method for extracting context id from a path.
+   *
+   * @param path path to resolve context from
+   * @returns the resolved context item id
+   */
+  extractContextIdFromPath?: (path: string) => string | undefined;
+
+  /**
+   * Method for generating path from a context item.
+   *
+   * @param context context item to generate path from
+   * @param path current path
+   * @returns path for the context item
+   */
+  generatePathFromContext?: (context: ContextItem, path: string) => string | undefined;
 }
 
 export class ContextProvider implements IContextProvider {
@@ -205,6 +222,15 @@ export class ContextProvider implements IContextProvider {
     config.resolveContext && (this.resolveContext = config.resolveContext?.bind(this));
     config.validateContext && (this.validateContext = config.validateContext?.bind(this));
 
+    if (config.extractContextIdFromPath) {
+      // @ts-ignore
+      this.extractContextIdFromPath = config.extractContextIdFromPath;
+    }
+    if (config.generatePathFromContext) {
+      // @ts-ignore
+      this.generatePathFromContext = config.generatePathFromContext;
+    }
+
     this.#contextType = config.contextType;
     this.#contextFilter = config.contextFilter;
 

package/src/configurator.ts

@@ -40,6 +40,9 @@ export interface ContextModuleConfig {
   /** set initial context from parent, will await resolve */
   skipInitialContext?: boolean;
 
+  extractContextIdFromPath?: (path: string) => string | undefined;
+  generatePathFromContext?: (context: ContextItem, path: string) => string | undefined;
+
   /**
    * Method for generating context query parameters.
    */
@@ -105,7 +108,12 @@ export class ContextModuleConfigurator implements IContextModuleConfigurator {
       Promise.resolve({} as Partial<ContextModuleConfig>),
     );
 
-    config.resolveInitialContext ??= resolveInitialContext();
+    config.resolveInitialContext ??= resolveInitialContext({
+      path: {
+        extract: config.extractContextIdFromPath,
+        validate: config.extractContextIdFromPath ? () => true : undefined,
+      },
+    });
 
     // TODO - make less lazy
     config.client ??= await (async (): Promise<ContextModuleConfig['client']> => {

package/src/version.ts

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