@equinor/fusion-framework-module-context 4.0.10 → 4.0.12

package/dist/types/version.d.ts

@@ -0,0 +1 @@
+export declare const version = "4.0.12";

package/package.json

@@ -1,53 +1,52 @@
 {
-    "name": "@equinor/fusion-framework-module-context",
-    "version": "4.0.10",
-    "description": "",
-    "main": "./dist/esm/index.js",
-    "exports": {
-        ".": "./dist/esm/index.js",
-        "./package.json": "./package.json",
-        "./utils": "./dist/esm/utils/index.js"
-    },
-    "types": "index.d.ts",
-    "typesVersions": {
-        ">=4.2": {
-            "*": [
-                "dist/types/*"
-            ],
-            "utils": [
-                "dist/types/utils/index.d.ts"
-            ]
-        }
-    },
-    "scripts": {
-        "build": "tsc -b",
-        "prepack": "yarn build"
-    },
-    "keywords": [],
-    "author": "",
-    "license": "ISC",
-    "publishConfig": {
-        "access": "public"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/equinor/fusion-framework.git",
-        "directory": "packages/modules/context"
-    },
-    "dependencies": {
-        "@equinor/fusion-query": "^3.0.2",
-        "fast-deep-equal": "^3.1.3"
-    },
-    "devDependencies": {
-        "@equinor/fusion-framework-module": "^4.2.1",
-        "@equinor/fusion-framework-module-event": "^4.0.2",
-        "@equinor/fusion-framework-module-navigation": "^3.0.1",
-        "@equinor/fusion-framework-module-services": "^3.1.3",
-        "rxjs": "^7.5.7",
-        "typescript": "^5.1.3"
-    },
-    "peerDependencies": {
-        "@equinor/fusion-framework-module": ">=1.2.5",
-        "rxjs": "^7.5.7"
+  "name": "@equinor/fusion-framework-module-context",
+  "version": "4.0.12",
+  "description": "",
+  "main": "./dist/esm/index.js",
+  "exports": {
+    ".": "./dist/esm/index.js",
+    "./package.json": "./package.json",
+    "./utils": "./dist/esm/utils/index.js"
+  },
+  "types": "index.d.ts",
+  "typesVersions": {
+    ">=4.2": {
+      "*": [
+        "dist/types/*"
+      ],
+      "utils": [
+        "dist/types/utils/index.d.ts"
+      ]
     }
-}
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/equinor/fusion-framework.git",
+    "directory": "packages/modules/context"
+  },
+  "dependencies": {
+    "fast-deep-equal": "^3.1.3",
+    "@equinor/fusion-query": "^3.0.6"
+  },
+  "devDependencies": {
+    "rxjs": "^7.8.1",
+    "typescript": "^5.1.3",
+    "@equinor/fusion-framework-module": "^4.2.3",
+    "@equinor/fusion-framework-module-event": "^4.0.4",
+    "@equinor/fusion-framework-module-navigation": "^3.0.4",
+    "@equinor/fusion-framework-module-services": "^3.1.4"
+  },
+  "peerDependencies": {
+    "rxjs": "^7.8.1",
+    "@equinor/fusion-framework-module": "^4.2.3"
+  },
+  "scripts": {
+    "build": "tsc -b"
+  }
+}

package/src/ContextConfigBuilder.ts

@@ -18,7 +18,7 @@ import type {
 import type { ContextItem, QueryContextParameters, RelatedContextParameters } from './types';
 
 export type ContextConfigBuilderCallback = <TDeps extends Array<AnyModule> = []>(
-    builder: ContextConfigBuilder<TDeps, ModuleInitializerArgs<IContextModuleConfigurator, TDeps>>
+    builder: ContextConfigBuilder<TDeps, ModuleInitializerArgs<IContextModuleConfigurator, TDeps>>,
 ) => void | Promise<void>;
 
 export class ContextConfigBuilder<
@@ -27,15 +27,18 @@ export class ContextConfigBuilder<
     TInit extends ModuleInitializerArgs<any, any> = ModuleInitializerArgs<
         ContextModuleConfigurator,
         TModules
-    >
+    >,
 > {
     #init: TInit;
-    constructor(init: TInit, public config: Partial<ContextModuleConfig> = {}) {
+    constructor(
+        init: TInit,
+        public config: Partial<ContextModuleConfig> = {},
+    ) {
         this.#init = init;
     }
 
     requireInstance<TKey extends string = Extract<keyof Modules, string>>(
-        module: TKey
+        module: TKey,
     ): Promise<ModuleType<Modules[TKey]>>;
 
     requireInstance<T>(module: string): Promise<T>;
@@ -85,7 +88,7 @@ export class ContextConfigBuilder<
                 | QueryFn<ContextItem[], RelatedContextParameters>
                 | QueryCtorOptions<ContextItem[], RelatedContextParameters>;
         },
-        expire = 1 * 60 * 1000
+        expire = 1 * 60 * 1000,
     ): void {
         this.config.client = {
             get:

package/src/ContextProvider.ts

@@ -40,10 +40,10 @@ export interface IContextProvider {
     resolveContext: (current: ContextItem) => Observable<ContextItem>;
     resolveContextAsync: (current: ContextItem) => Promise<ContextItem>;
     relatedContexts: (
-        args: RelatedContextParameters
+        args: RelatedContextParameters,
     ) => Observable<Array<ContextItem<Record<string, unknown>>>>;
     relatedContextsAsync: (
-        args: RelatedContextParameters
+        args: RelatedContextParameters,
     ) => Promise<Array<ContextItem<Record<string, unknown>>>>;
     clearCurrentContext: VoidFunction;
 
@@ -52,12 +52,12 @@ export interface IContextProvider {
 
     setCurrentContext(
         context: ContextItem<Record<string, unknown>> | null,
-        opt?: { validate?: boolean; resolve?: boolean }
+        opt?: { validate?: boolean; resolve?: boolean },
     ): Observable<ContextItem<Record<string, unknown>> | null>;
 
     setCurrentContextAsync(
         context: ContextItem<Record<string, unknown>> | null,
-        opt?: { validate?: boolean; resolve?: boolean }
+        opt?: { validate?: boolean; resolve?: boolean },
     ): Promise<ContextItem<Record<string, unknown>> | null>;
 }
 
@@ -97,7 +97,7 @@ export class ContextProvider implements IContextProvider {
         console.warn(
             '@deprecated',
             'ContextProvider.currentContext',
-            'use setCurrentContextById|setCurrentContext|clearCurrentContext'
+            'use setCurrentContextById|setCurrentContext|clearCurrentContext',
         );
         if (context === undefined) {
             throw Error('not allowed to set current context as undefined undefined!');
@@ -116,7 +116,7 @@ export class ContextProvider implements IContextProvider {
         if (args.parentContext) {
             console.warn(
                 '@deprecated',
-                'parentContext as arg is deprecated, use ContextProvider.connectParentContext'
+                'parentContext as arg is deprecated, use ContextProvider.connectParentContext',
             );
         }
 
@@ -150,7 +150,7 @@ export class ContextProvider implements IContextProvider {
                         canBubble: true,
                         detail: { previous, next },
                     });
-                })
+                }),
             );
             this.#subscriptions.add(
                 /** observe event from child modules */
@@ -159,7 +159,7 @@ export class ContextProvider implements IContextProvider {
                     if (e.source !== this && e.detail.next !== undefined) {
                         this.setCurrentContext(e.detail.next);
                     }
-                })
+                }),
             );
         }
 
@@ -167,15 +167,15 @@ export class ContextProvider implements IContextProvider {
             this.#contextQueue
                 .pipe(
                     switchMap((next) => next),
-                    tap((x) => console.debug('ContextProvider::#contextQueue', x))
+                    tap((x) => console.debug('ContextProvider::#contextQueue', x)),
                 )
-                .subscribe((context) => this.#contextClient.setCurrentContext(context ?? null))
+                .subscribe((context) => this.#contextClient.setCurrentContext(context ?? null)),
         );
     }
 
     public connectParentContext(
         provider: IContextProvider,
-        opt?: { skipFirst: boolean }
+        opt?: { skipFirst: boolean },
     ): Subscription {
         const parentContext$ = provider.currentContext$.pipe(
             // do not set context if parent has not initialized
@@ -185,7 +185,7 @@ export class ContextProvider implements IContextProvider {
                     console.debug(
                         'ContextProvider::connectParentContext',
                         'skipping first item',
-                        next
+                        next,
                     );
                     return false;
                 }
@@ -199,7 +199,7 @@ export class ContextProvider implements IContextProvider {
                             source: this,
                             detail: next,
                             cancelable: true,
-                        }
+                        },
                     );
                     return { next, canceled: onParentContextChanged?.canceled };
                 }
@@ -215,16 +215,16 @@ export class ContextProvider implements IContextProvider {
                         console.warn(
                             'ContextProvider::onParentContextChanged',
                             'setCurrentContext',
-                            err
+                            err,
                         );
                         return EMPTY;
-                    })
+                    }),
                 );
             }),
             catchError((err) => {
                 console.warn('ContextProvider::onParentContextChanged', 'unhandled exception', err);
                 return EMPTY;
-            })
+            }),
         );
 
         const subscription = parentContext$.subscribe();
@@ -239,7 +239,7 @@ export class ContextProvider implements IContextProvider {
                     .resolveContext(id)
                     .pipe(
                         filter((item): item is ContextItem => !!item),
-                        switchMap((item) => this.setCurrentContext(item))
+                        switchMap((item) => this.setCurrentContext(item)),
                     )
                     .subscribe(subscriber);
             } catch (err) {
@@ -265,7 +265,7 @@ export class ContextProvider implements IContextProvider {
      */
     public setCurrentContext<T extends ContextItem<Record<string, unknown>> | null>(
         context: T,
-        opt?: { validate?: boolean; resolve?: boolean }
+        opt?: { validate?: boolean; resolve?: boolean },
     ): Observable<T> {
         /** signal for aborting the queue entry */
         const abort$ = new Subject();
@@ -286,7 +286,7 @@ export class ContextProvider implements IContextProvider {
                 subject$.error(err);
                 /** skip setting any context */
                 return EMPTY;
-            })
+            }),
         );
 
         /** add task to internal queue */
@@ -294,13 +294,13 @@ export class ContextProvider implements IContextProvider {
 
         return subject$.pipe(
             /** if caller subscribes, unsubscribe should abort queue entry */
-            finalize(() => abort$.next(true))
+            finalize(() => abort$.next(true)),
         );
     }
 
     protected _setCurrentContext<T extends ContextItem<Record<string, unknown>> | null>(
         context: T,
-        opt?: { validate?: boolean; resolve?: boolean }
+        opt?: { validate?: boolean; resolve?: boolean },
     ): Observable<T> {
         return new Observable((subscriber) => {
             if (context === this.currentContext) {
@@ -327,7 +327,7 @@ export class ContextProvider implements IContextProvider {
                                         source: this,
                                         cancelable: true,
                                         detail: { context },
-                                    }
+                                    },
                                 );
                                 if (event?.canceled) {
                                     throw Error('resolving of context was canceled');
@@ -340,8 +340,8 @@ export class ContextProvider implements IContextProvider {
                                     map((resolved) => ({
                                         context,
                                         resolved,
-                                    }))
-                                )
+                                    })),
+                                ),
                             ),
                             /** notify event observers that context was resolved */
                             switchMap(async ({ context, resolved }) => {
@@ -351,7 +351,7 @@ export class ContextProvider implements IContextProvider {
                                         source: this,
                                         cancelable: true,
                                         detail: { context, resolved },
-                                    }
+                                    },
                                 );
                                 if (event?.canceled) {
                                     throw Error('resolving of context was canceled');
@@ -360,8 +360,8 @@ export class ContextProvider implements IContextProvider {
                             }),
                             /** recursive set current context without validation and resolve */
                             switchMap((resolved) =>
-                                this._setCurrentContext(resolved as unknown as T)
-                            )
+                                this._setCurrentContext(resolved as unknown as T),
+                            ),
                         )
                         .subscribe(subscriber);
                 }
@@ -382,7 +382,7 @@ export class ContextProvider implements IContextProvider {
                         }
 
                         return context;
-                    })
+                    }),
                 )
                 .subscribe((context) => {
                     subscriber.next(context);
@@ -393,7 +393,7 @@ export class ContextProvider implements IContextProvider {
 
     public async setCurrentContextAsync<T extends ContextItem<Record<string, unknown>> | null>(
         context: T,
-        opt?: { validate?: boolean; resolve?: boolean }
+        opt?: { validate?: boolean; resolve?: boolean },
     ): Promise<T> {
         return lastValueFrom(this.setCurrentContext(context, opt));
     }
@@ -404,7 +404,7 @@ export class ContextProvider implements IContextProvider {
                 // TODO
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 /* @ts-ignore */
-                this.#contextParameterFn({ search, type: this.#contextType })
+                this.#contextParameterFn({ search, type: this.#contextType }),
             )
             .pipe(map((x) => x.value));
 
@@ -421,7 +421,7 @@ export class ContextProvider implements IContextProvider {
     }
 
     public resolveContext(
-        item: ContextItem<Record<string, unknown>>
+        item: ContextItem<Record<string, unknown>>,
     ): Observable<ContextItem<Record<string, unknown>>> {
         return this.relatedContexts({ item, filter: { type: this.#contextType } }).pipe(
             map((x) => x.filter((item) => this.validateContext(item))),
@@ -434,28 +434,28 @@ export class ContextProvider implements IContextProvider {
                     console.warn(
                         'ContextProvider::relatedContext',
                         'multiple items found 🤣',
-                        values
+                        values,
                     );
                 }
                 return value;
-            })
+            }),
         );
     }
 
     public resolveContextAsync(
-        item: ContextItem<Record<string, unknown>>
+        item: ContextItem<Record<string, unknown>>,
     ): Promise<ContextItem<Record<string, unknown>>> {
         return lastValueFrom(this.resolveContext(item));
     }
 
     public relatedContexts(
-        args: RelatedContextParameters
+        args: RelatedContextParameters,
     ): Observable<Array<ContextItem<Record<string, unknown>>>> {
         if (!this.#contextRelated) {
             return throwError(() =>
                 Error(
-                    'ContextProvider::relatedContexts - no client defined for resolving related context'
-                )
+                    'ContextProvider::relatedContexts - no client defined for resolving related context',
+                ),
             );
         }
         return this.#contextRelated.query(args).pipe(
@@ -465,12 +465,12 @@ export class ContextProvider implements IContextProvider {
                     throw err.cause;
                 }
                 throw err;
-            })
+            }),
         );
     }
 
     public relatedContextsAsync(
-        args: RelatedContextParameters
+        args: RelatedContextParameters,
     ): Promise<Array<ContextItem<Record<string, unknown>>>> {
         return lastValueFrom(this.relatedContexts(args));
     }

package/src/client/ContextClient.ts

@@ -54,7 +54,7 @@ export class ContextClient extends Observable<ContextItem | null> {
                     throw err.cause;
                 }
                 throw err;
-            })
+            }),
         );
     }
 

package/src/configurator.ts

@@ -50,12 +50,12 @@ export interface ContextModuleConfig {
 
     resolveContext?: (
         this: IContextProvider,
-        item: ContextItem | null
+        item: ContextItem | null,
     ) => ReturnType<IContextProvider['resolveContext']>;
 
     validateContext?: (
         this: IContextProvider,
-        item: ContextItem | null
+        item: ContextItem | null,
     ) => ReturnType<IContextProvider['validateContext']>;
 
     resolveInitialContext?: (args: {
@@ -79,7 +79,7 @@ export class ContextModuleConfigurator implements IContextModuleConfigurator {
     }
 
     protected async _getServiceProvider(
-        init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>
+        init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>,
     ): Promise<IApiProvider> {
         if (init.hasModule('services')) {
             return init.requireInstance('services');
@@ -94,14 +94,17 @@ export class ContextModuleConfigurator implements IContextModuleConfigurator {
     }
 
     public async createConfig(
-        init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule, NavigationModule]>
+        init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule, NavigationModule]>,
     ): Promise<ContextModuleConfig> {
-        const config = await this.#configBuilders.reduce(async (cur, cb) => {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const builder = new ContextConfigBuilder<any, any>(init, await cur);
-            await Promise.resolve(cb(builder));
-            return Object.assign(cur, builder.config);
-        }, Promise.resolve({} as Partial<ContextModuleConfig>));
+        const config = await this.#configBuilders.reduce(
+            async (cur, cb) => {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                const builder = new ContextConfigBuilder<any, any>(init, await cur);
+                await Promise.resolve(cb(builder));
+                return Object.assign(cur, builder.config);
+            },
+            Promise.resolve({} as Partial<ContextModuleConfig>),
+        );
 
         config.resolveInitialContext ??= resolveInitialContext();
 
@@ -124,7 +127,7 @@ export class ContextModuleConfigurator implements IContextModuleConfigurator {
                             contextClient.query(
                                 'v1',
                                 { query },
-                                { selector: queryContextSelector }
+                                { selector: queryContextSelector },
                             ),
                     },
                     // TODO - might cast to checksum
@@ -137,7 +140,7 @@ export class ContextModuleConfigurator implements IContextModuleConfigurator {
                             return contextClient.related(
                                 'v1',
                                 { id: args.item.id, query: { filter: args.filter } },
-                                { selector: relatedContextSelector }
+                                { selector: relatedContextSelector },
                             );
                         },
                     },

package/src/module.ts

@@ -8,7 +8,7 @@ import { NavigationModule } from '@equinor/fusion-framework-module-navigation';
 
 import { IContextModuleConfigurator, ContextModuleConfigurator } from './configurator';
 import { IContextProvider, ContextProvider } from './ContextProvider';
-import { ContextItem } from 'types';
+import { ContextItem } from './types';
 
 export type ContextModuleKey = 'context';
 
@@ -41,8 +41,8 @@ export const module: ContextModule = {
                               args.modules.context.setCurrentContext(item, {
                                   validate: true,
                                   resolve: true,
-                              })
-                          )
+                              }),
+                          ),
                       )
                     : EMPTY;
 
@@ -53,17 +53,17 @@ export const module: ContextModule = {
                                 console.warn(
                                     'ContextModule.postInitialize',
                                     'failed to resolve initial context',
-                                    err
+                                    err,
                                 );
                                 return EMPTY;
-                            })
+                            }),
                         )
                         .subscribe({
                             next: (item) => {
                                 console.debug(
                                     'ContextModule.postInitialize',
                                     `initial context was resolved to [${item ? item.id : 'none'}]`,
-                                    item
+                                    item,
                                 );
                             },
                             complete: () => {
@@ -72,7 +72,7 @@ export const module: ContextModule = {
                                 }
                                 subscriber.complete();
                             },
-                        })
+                        }),
                 );
             });
 

package/src/utils/enable-context.ts

@@ -19,8 +19,8 @@ export const enableContext = (
         builder: ContextConfigBuilder<
             TDeps,
             ModuleInitializerArgs<IContextModuleConfigurator, TDeps>
-        >
-    ) => void | Promise<void>
+        >,
+    ) => void | Promise<void>,
 ): void => {
     configurator.addConfig({
         module,

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

@@ -22,7 +22,7 @@ export const resolveInitialContext =
         const pathResolver = resolveContextFromPath(context, options?.path);
         return concat(
             navigation ? pathResolver(navigation.path.pathname) : EMPTY,
-            resolveContextFromParent({ ref, modules })
+            resolveContextFromParent({ ref, modules }),
         ).pipe(first());
     };
 

package/src/version.ts

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

package/tsconfig.json

@@ -4,7 +4,7 @@
     "outDir": "dist/esm",
     "rootDir": "src",
     "declarationDir": "./dist/types",
-    "baseUrl": "src",
+    
   },
   "references": [
     {