@equinor/fusion-framework-module-context 4.0.0-next.12 → 4.0.0-next.13

package/dist/types/ContextProvider.d.ts

@@ -8,8 +8,8 @@ import Query from '@equinor/fusion-query';
 export interface IContextProvider {
     readonly contextClient: ContextClient;
     readonly queryClient: Query<ContextItem[], QueryContextParameters>;
-    readonly currentContext$: Observable<ContextItem | undefined>;
-    currentContext: ContextItem | undefined;
+    readonly currentContext$: Observable<ContextItem | null | undefined>;
+    currentContext: ContextItem | null | undefined;
     queryContext(search: string): Observable<Array<ContextItem>>;
     queryContextAsync(search: string): Promise<Array<ContextItem>>;
     validateContext(item: ContextItem<Record<string, unknown>>): boolean;
@@ -20,22 +20,22 @@ export interface IContextProvider {
     clearCurrentContext: VoidFunction;
     setCurrentContextById(id: string): Observable<ContextItem<Record<string, unknown>>>;
     setCurrentContextByIdAsync(id: string): Promise<ContextItem<Record<string, unknown>>>;
-    setCurrentContext(context: ContextItem<Record<string, unknown>>, opt?: {
+    setCurrentContext(context: ContextItem<Record<string, unknown>> | null, opt?: {
         validate?: boolean;
         resolve?: boolean;
-    }): Observable<ContextItem<Record<string, unknown>>>;
-    setCurrentContextAsync(context: ContextItem<Record<string, unknown>>, opt?: {
+    }): Observable<ContextItem<Record<string, unknown>> | null>;
+    setCurrentContextAsync(context: ContextItem<Record<string, unknown>> | null, opt?: {
         validate?: boolean;
         resolve?: boolean;
-    }): Promise<ContextItem<Record<string, unknown>>>;
+    }): Promise<ContextItem<Record<string, unknown>> | null>;
 }
 export declare class ContextProvider implements IContextProvider {
     #private;
     get contextClient(): ContextClient;
     get queryClient(): Query<ContextItem<Record<string, unknown>>[], QueryContextParameters>;
-    get currentContext$(): Observable<ContextItem | undefined>;
-    get currentContext(): ContextItem | undefined;
-    set currentContext(context: ContextItem | undefined);
+    get currentContext$(): Observable<ContextItem | null | undefined>;
+    get currentContext(): ContextItem | undefined | null;
+    set currentContext(context: ContextItem | null | undefined);
     constructor(args: {
         config: ContextModuleConfig;
         event?: ModuleType<EventModule>;
@@ -46,14 +46,14 @@ export declare class ContextProvider implements IContextProvider {
     }): Subscription;
     setCurrentContextById(id: string): Observable<ContextItem<Record<string, unknown>>>;
     setCurrentContextByIdAsync(id: string): Promise<ContextItem<Record<string, unknown>>>;
-    setCurrentContext(context: ContextItem<Record<string, unknown>>, opt?: {
+    setCurrentContext<T extends ContextItem<Record<string, unknown>> | null>(context: T, opt?: {
         validate?: boolean;
         resolve?: boolean;
-    }): Observable<ContextItem<Record<string, unknown>>>;
-    setCurrentContextAsync(context: ContextItem<Record<string, unknown>>, opt?: {
+    }): Observable<T>;
+    setCurrentContextAsync<T extends ContextItem<Record<string, unknown>> | null>(context: T, opt?: {
         validate?: boolean;
         resolve?: boolean;
-    }): Promise<ContextItem<Record<string, unknown>>>;
+    }): Promise<T>;
     queryContext(search: string): Observable<Array<ContextItem>>;
     queryContextAsync(search: string): Promise<Array<ContextItem>>;
     validateContext(item: ContextItem<Record<string, unknown>>): boolean;
@@ -68,14 +68,14 @@ export default ContextProvider;
 declare module '@equinor/fusion-framework-module-event' {
     interface FrameworkEventMap {
         onCurrentContextChange: FrameworkEvent<FrameworkEventInit<{
-            context: ContextItem | undefined;
+            context: ContextItem | null;
         }, IContextProvider>>;
         onCurrentContextChanged: FrameworkEvent<FrameworkEventInit<{
-            next: ContextItem | undefined;
-            previous: ContextItem | undefined;
+            next: ContextItem | null;
+            previous?: ContextItem | null;
         }, IContextProvider>>;
         onParentContextChanged: FrameworkEvent<FrameworkEventInit<{
-            context: ContextItem | undefined;
+            context: ContextItem | null;
         }, IContextProvider>>;
         onSetContextResolve: FrameworkEvent<FrameworkEventInit<{
             context: ContextItem;

package/dist/types/client/ContextClient.d.ts

@@ -4,15 +4,15 @@ import { ContextItem } from '../types';
 export type GetContextParameters = {
     id: string;
 };
-export declare class ContextClient extends Observable<ContextItem> {
+export declare class ContextClient extends Observable<ContextItem | null> {
     #private;
-    get currentContext(): ContextItem | undefined;
-    get currentContext$(): Observable<ContextItem | undefined>;
+    get currentContext(): ContextItem | null | undefined;
+    get currentContext$(): Observable<ContextItem | null | undefined>;
     get client(): Query<ContextItem, {
         id: string;
     }>;
     constructor(options: QueryCtorOptions<ContextItem, GetContextParameters>);
-    setCurrentContext(idOrItem?: string | ContextItem): void;
+    setCurrentContext(idOrItem?: string | ContextItem | null): void;
     resolveContext(id: string): Observable<ContextItem>;
     resolveContextAsync(id: string, opt?: {
         awaitResolve: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@equinor/fusion-framework-module-context",
-    "version": "4.0.0-next.12",
+    "version": "4.0.0-next.13",
     "description": "",
     "main": "./dist/esm/index.js",
     "exports": {
@@ -35,19 +35,19 @@
         "directory": "packages/modules/context"
     },
     "dependencies": {
-        "@equinor/fusion-query": "^3.0.1-next.3",
+        "@equinor/fusion-query": "^3.0.1-next.4",
         "fast-deep-equal": "^3.1.3"
     },
     "devDependencies": {
-        "@equinor/fusion-framework-module": "^4.0.0-next.0",
-        "@equinor/fusion-framework-module-event": "^4.0.0-next.0",
-        "@equinor/fusion-framework-module-navigation": "^2.1.0-next.0",
-        "@equinor/fusion-framework-module-services": "^3.1.0-next.4",
+        "@equinor/fusion-framework-module": "^4.0.0-next.1",
+        "@equinor/fusion-framework-module-event": "^4.0.0-next.1",
+        "@equinor/fusion-framework-module-navigation": "^2.1.0-next.1",
+        "@equinor/fusion-framework-module-services": "^3.1.0-next.5",
         "rxjs": "^7.5.7"
     },
     "peerDependencies": {
         "@equinor/fusion-framework-module": ">=1.2.5",
         "rxjs": "^7.5.7"
     },
-    "gitHead": "a2d5050515d375c7546b321aba27d11239869d97"
+    "gitHead": "4e9c1d4fffaf455043b1fcf40a48744092f0cc71"
 }

package/src/ContextProvider.ts

@@ -31,8 +31,8 @@ export interface IContextProvider {
     /** DANGER */
     readonly queryClient: Query<ContextItem[], QueryContextParameters>;
 
-    readonly currentContext$: Observable<ContextItem | undefined>;
-    currentContext: ContextItem | undefined;
+    readonly currentContext$: Observable<ContextItem | null | undefined>;
+    currentContext: ContextItem | null | undefined;
     queryContext(search: string): Observable<Array<ContextItem>>;
     queryContextAsync(search: string): Promise<Array<ContextItem>>;
     validateContext(item: ContextItem<Record<string, unknown>>): boolean;
@@ -50,14 +50,14 @@ export interface IContextProvider {
     setCurrentContextByIdAsync(id: string): Promise<ContextItem<Record<string, unknown>>>;
 
     setCurrentContext(
-        context: ContextItem<Record<string, unknown>>,
+        context: ContextItem<Record<string, unknown>> | null,
         opt?: { validate?: boolean; resolve?: boolean }
-    ): Observable<ContextItem<Record<string, unknown>>>;
+    ): Observable<ContextItem<Record<string, unknown>> | null>;
 
     setCurrentContextAsync(
-        context: ContextItem<Record<string, unknown>>,
+        context: ContextItem<Record<string, unknown>> | null,
         opt?: { validate?: boolean; resolve?: boolean }
-    ): Promise<ContextItem<Record<string, unknown>>>;
+    ): Promise<ContextItem<Record<string, unknown>> | null>;
 }
 
 export class ContextProvider implements IContextProvider {
@@ -81,22 +81,25 @@ export class ContextProvider implements IContextProvider {
         return this.#contextQuery;
     }
 
-    get currentContext$(): Observable<ContextItem | undefined> {
+    get currentContext$(): Observable<ContextItem | null | undefined> {
         return this.#contextClient.currentContext$;
     }
 
-    get currentContext(): ContextItem | undefined {
+    get currentContext(): ContextItem | undefined | null {
         return this.#contextClient.currentContext;
     }
 
     /** @deprecated do not use, will be removed */
-    set currentContext(context: ContextItem | undefined) {
+    set currentContext(context: ContextItem | null | undefined) {
         console.warn(
             '@deprecated',
             'ContextProvider.currentContext',
             'use setCurrentContextById|setCurrentContext|clearCurrentContext'
         );
-        context ? this.setCurrentContextAsync(context) : this.clearCurrentContext();
+        if (context === undefined) {
+            throw Error('not allowed to set current context as undefined undefined!');
+        }
+        this.setCurrentContextAsync(context);
     }
 
     constructor(args: {
@@ -150,8 +153,8 @@ export class ContextProvider implements IContextProvider {
                 /** observe event from child modules */
                 this.#event.addEventListener('onCurrentContextChanged', (e) => {
                     /** loop prevention */
-                    if (e.source !== this) {
-                        this.currentContext = e.detail.next;
+                    if (e.source !== this && e.detail.next !== undefined) {
+                        this.setCurrentContext(e.detail.next);
                     }
                 })
             );
@@ -224,7 +227,10 @@ export class ContextProvider implements IContextProvider {
             try {
                 this.#contextClient
                     .resolveContext(id)
-                    .pipe(switchMap((item) => this.setCurrentContext(item)))
+                    .pipe(
+                        filter((item): item is ContextItem => !!item),
+                        switchMap((item) => this.setCurrentContext(item))
+                    )
                     .subscribe(subscriber);
             } catch (err) {
                 subscriber.error(err);
@@ -236,16 +242,16 @@ export class ContextProvider implements IContextProvider {
         return firstValueFrom(this.setCurrentContextById(id));
     }
 
-    public setCurrentContext(
-        context: ContextItem<Record<string, unknown>>,
+    public setCurrentContext<T extends ContextItem<Record<string, unknown>> | null>(
+        context: T,
         opt?: { validate?: boolean; resolve?: boolean }
-    ): Observable<ContextItem<Record<string, unknown>>> {
+    ): Observable<T> {
         return new Observable((subscriber) => {
             if (context === this.currentContext) {
                 subscriber.next(context);
                 return subscriber.complete();
             }
-            if (opt?.validate && !this.validateContext(context)) {
+            if (context && opt?.validate && !this.validateContext(context)) {
                 if (!opt.resolve) {
                     /** cannot resolve context, and provided is invalid  */
                     this.#event?.dispatchEvent('onSetContextValidationFailed', {
@@ -297,7 +303,9 @@ export class ContextProvider implements IContextProvider {
                                 return resolved;
                             }),
                             /** recursive set current context without validation and resolve */
-                            switchMap((resolved) => this.setCurrentContext(resolved))
+                            switchMap((resolved) =>
+                                this.setCurrentContext(resolved as unknown as T)
+                            )
                         )
                         .subscribe(subscriber);
                 }
@@ -321,17 +329,17 @@ export class ContextProvider implements IContextProvider {
                     })
                 )
                 .subscribe((context) => {
-                    this.#contextClient.setCurrentContext(context);
+                    this.#contextClient.setCurrentContext(context ?? null);
                     subscriber.next(context);
                     subscriber.complete();
                 });
         });
     }
 
-    public async setCurrentContextAsync(
-        context: ContextItem<Record<string, unknown>>,
+    public async setCurrentContextAsync<T extends ContextItem<Record<string, unknown>> | null>(
+        context: T,
         opt?: { validate?: boolean; resolve?: boolean }
-    ): Promise<ContextItem<Record<string, unknown>>> {
+    ): Promise<T> {
         return firstValueFrom(this.setCurrentContext(context, opt));
     }
 
@@ -413,7 +421,7 @@ export class ContextProvider implements IContextProvider {
     }
 
     public clearCurrentContext() {
-        this.#contextClient.setCurrentContext(undefined);
+        this.setCurrentContextAsync(null);
     }
 
     dispose() {
@@ -430,7 +438,7 @@ declare module '@equinor/fusion-framework-module-event' {
         onCurrentContextChange: FrameworkEvent<
             FrameworkEventInit<
                 {
-                    context: ContextItem | undefined;
+                    context: ContextItem | null;
                 },
                 IContextProvider
             >
@@ -439,8 +447,8 @@ declare module '@equinor/fusion-framework-module-event' {
         onCurrentContextChanged: FrameworkEvent<
             FrameworkEventInit<
                 {
-                    next: ContextItem | undefined;
-                    previous: ContextItem | undefined;
+                    next: ContextItem | null;
+                    previous?: ContextItem | null;
                 },
                 IContextProvider
             >
@@ -448,7 +456,7 @@ declare module '@equinor/fusion-framework-module-event' {
         onParentContextChanged: FrameworkEvent<
             FrameworkEventInit<
                 {
-                    context: ContextItem | undefined;
+                    context: ContextItem | null;
                 },
                 IContextProvider
             >

package/src/client/ContextClient.ts

@@ -9,16 +9,16 @@ import { ContextItem } from '../types';
 
 export type GetContextParameters = { id: string };
 
-export class ContextClient extends Observable<ContextItem> {
+export class ContextClient extends Observable<ContextItem | null> {
     #client: Query<ContextItem, { id: string }>;
     /** might change to reactive state, for comparing state with reducer */
-    #currentContext$: BehaviorSubject<ContextItem | undefined>;
+    #currentContext$: BehaviorSubject<ContextItem | null | undefined>;
 
-    get currentContext(): ContextItem | undefined {
+    get currentContext(): ContextItem | null | undefined {
         return this.#currentContext$.value;
     }
 
-    get currentContext$(): Observable<ContextItem | undefined> {
+    get currentContext$(): Observable<ContextItem | null | undefined> {
         return this.#currentContext$.asObservable();
     }
 
@@ -29,10 +29,10 @@ export class ContextClient extends Observable<ContextItem> {
     constructor(options: QueryCtorOptions<ContextItem, GetContextParameters>) {
         super((observer) => this.#currentContext$.subscribe(observer));
         this.#client = new Query(options);
-        this.#currentContext$ = new BehaviorSubject<ContextItem | undefined>(undefined);
+        this.#currentContext$ = new BehaviorSubject<ContextItem | null | undefined>(undefined);
     }
 
-    public setCurrentContext(idOrItem?: string | ContextItem) {
+    public setCurrentContext(idOrItem?: string | ContextItem | null) {
         if (typeof idOrItem === 'string') {
             // TODO - compare context
             this.resolveContext(idOrItem)

package/src/module.ts

@@ -1,3 +1,5 @@
+import { catchError, EMPTY, from, Observable, switchMap, filter, Subscription } from 'rxjs';
+
 import { Module, ModulesInstance } from '@equinor/fusion-framework-module';
 
 import { EventModule } from '@equinor/fusion-framework-module-event';
@@ -6,7 +8,6 @@ import { NavigationModule } from '@equinor/fusion-framework-module-navigation';
 
 import { IContextModuleConfigurator, ContextModuleConfigurator } from './configurator';
 import { IContextProvider, ContextProvider } from './ContextProvider';
-import { catchError, EMPTY, from, Observable, switchMap, filter, Subscription } from 'rxjs';
 import { ContextItem } from 'types';
 
 export type ContextModuleKey = 'context';
@@ -61,7 +62,7 @@ export const module: ContextModule = {
                             next: (item) => {
                                 console.debug(
                                     'ContextModule.postInitialize',
-                                    `initial context was resolved to [${item.id}]`,
+                                    `initial context was resolved to [${item ? item.id : 'none'}]`,
                                     item
                                 );
                             },
@@ -71,25 +72,6 @@ export const module: ContextModule = {
                             },
                         })
                 );
-
-                if (args.modules.navigation) {
-                    subscription.add(
-                        provider.currentContext$.subscribe((item) => {
-                            if (!item) {
-                                return args.modules.navigation.replace('/');
-                            }
-                            const { path } = args.modules.navigation;
-                            const partial = path.pathname.split('/') ?? [];
-                            if (partial[0] !== item.id) {
-                                partial[0] = item?.id;
-                                args.modules.navigation.replace({
-                                    ...path,
-                                    pathname: partial.join('/'),
-                                });
-                            }
-                        })
-                    );
-                }
             });
 
         this.dispose = () => subscription.unsubscribe();

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

@@ -12,7 +12,8 @@ export type ContextPathResolveArgs = {
 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 extractContextIdFromPath = (path: string): string | undefined => path.split('/')[0];
+const extractContextIdFromPath = (path: string): string | undefined =>
+    path.replace(/^\/+/, '').split('/').shift();
 
 const validateContextId = (contextId: string): boolean => !!contextId.match(matchGUID);
 

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)
+            resolveContextFromParent({ ref, modules })
         ).pipe(first());
     };