@equinor/fusion-framework-module-context 0.4.1 → 0.5.1

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

@@ -1,7 +1,7 @@
 import { Observable } from 'rxjs';
 import { Query, QueryCtorOptions } from '@equinor/fusion-observable/query';
 import { ContextItem } from '../types';
-export declare type ContextClientOptions = {
+export type ContextClientOptions = {
     query: QueryCtorOptions<ContextItem, {
         id: string;
     }>;

package/dist/types/configurator.d.ts

@@ -1,27 +1,26 @@
 import { AnyModule, ModuleInitializerArgs } from '@equinor/fusion-framework-module';
-import { ServicesModule } from '@equinor/fusion-framework-module-services';
+import { ServicesModule, IApiProvider } from '@equinor/fusion-framework-module-services';
 import { QueryCtorOptions } from '@equinor/fusion-observable/query';
 import { ContextClientOptions } from './client/ContextClient';
 import { ContextItem, QueryContextParameters } from './types';
 export interface IContextModuleConfig {
     getContext: ContextClientOptions;
     queryContext: QueryCtorOptions<ContextItem[], QueryContextParameters>;
+    contextType?: string[];
+    contextFilter?: (items: Array<ContextItem>) => Array<ContextItem>;
 }
 export interface IContextModuleConfigurator<TDeps extends Array<AnyModule> = [ServicesModule]> {
     createConfig: (args: ModuleInitializerArgs<IContextModuleConfigurator, TDeps>) => Promise<IContextModuleConfig>;
     processConfig: (config: IContextModuleConfig) => IContextModuleConfig;
-    createContextClientGet(init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>): Promise<QueryCtorOptions<ContextItem, {
-        id: string;
-    }>['client']>;
-    createContextClientQuery(init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>): Promise<QueryCtorOptions<ContextItem[], QueryContextParameters>['client']>;
 }
 export declare class ContextModuleConfigurator implements IContextModuleConfigurator<[ServicesModule]> {
     getContext?: Promise<ContextClientOptions['query']['client']>;
     defaultExpireTime: number;
-    createContextClientGet(init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>): Promise<QueryCtorOptions<ContextItem, {
+    protected _createContextClientGet(apiProvider: IApiProvider): Promise<QueryCtorOptions<ContextItem, {
         id: string;
     }>['client']>;
-    createContextClientQuery(init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>): Promise<QueryCtorOptions<ContextItem[], QueryContextParameters>['client']>;
+    protected _createContextClientQuery(apiProvider: IApiProvider): Promise<QueryCtorOptions<ContextItem[], QueryContextParameters>['client']>;
+    protected _getServiceProvider(init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>): Promise<IApiProvider>;
     createConfig(init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>): Promise<IContextModuleConfig>;
     processConfig(config: IContextModuleConfig): IContextModuleConfig;
 }

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 import { IModulesConfigurator } from '@equinor/fusion-framework-module';
-export declare const enableContext: (config: IModulesConfigurator) => void;
+import { IContextModuleConfig } from './configurator';
+export declare const enableContext: (configurator: IModulesConfigurator, options?: Pick<IContextModuleConfig, 'contextFilter' | 'contextType'>) => void;
 export { ContextModuleConfigurator, IContextModuleConfigurator, IContextModuleConfig, } from './configurator';
 export { IContextProvider, ContextProvider } from './provider';
 export { default, ContextModule, module as contextModule, moduleKey as contextModuleKey, } from './module';

package/dist/types/module.d.ts

@@ -3,9 +3,9 @@ import { EventModule } from '@equinor/fusion-framework-module-event';
 import { ServicesModule } from '@equinor/fusion-framework-module-services';
 import { IContextModuleConfigurator } from './configurator';
 import { IContextProvider } from './provider';
-export declare type ContextModuleKey = 'context';
+export type ContextModuleKey = 'context';
 export declare const moduleKey: ContextModuleKey;
-export declare type ContextModule = Module<ContextModuleKey, IContextProvider, IContextModuleConfigurator, [
+export type ContextModule = Module<ContextModuleKey, IContextProvider, IContextModuleConfigurator, [
     ServicesModule,
     EventModule
 ]>;

package/dist/types/provider.d.ts

@@ -15,6 +15,8 @@ export declare class ContextProvider implements IContextProvider {
     #private;
     get contextClient(): ContextClient;
     get queryClient(): Query<ContextItem<Record<string, unknown>>[], QueryContextParameters>;
+    queryContext(search: string): Observable<Array<ContextItem>>;
+    queryContextAsync(search: string): Promise<Array<ContextItem>>;
     get currentContext$(): Observable<ContextItem | undefined>;
     get currentContext(): ContextItem | undefined;
     set currentContext(context: ContextItem | undefined);

package/dist/types/types.d.ts

@@ -1,4 +1,4 @@
-export declare type ContextItem<TType extends Record<string, unknown> = Record<string, unknown>> = {
+export type ContextItem<TType extends Record<string, unknown> = Record<string, unknown>> = {
     id: string;
     externalId?: string;
     source?: string;
@@ -15,7 +15,7 @@ export interface ContextItemType {
     isChildType: boolean;
     parentTypeIds: string[];
 }
-export declare type QueryContextParameters = {
+export type QueryContextParameters = {
     search?: string;
     filter?: {
         type?: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@equinor/fusion-framework-module-context",
-    "version": "0.4.1",
+    "version": "0.5.1",
     "description": "",
     "main": "./dist/esm/index.js",
     "exports": {
@@ -33,7 +33,7 @@
     "devDependencies": {
         "@equinor/fusion-framework-module": "^1.2.9",
         "@equinor/fusion-framework-module-event": "^1.1.4",
-        "@equinor/fusion-framework-module-services": "^0.5.6",
+        "@equinor/fusion-framework-module-services": "^0.5.7",
         "@equinor/fusion-observable": "^1.4.1",
         "rxjs": "^7.5.7"
     },
@@ -42,5 +42,5 @@
         "@equinor/fusion-observable": "^1.2.1",
         "rxjs": "^7.5.7"
     },
-    "gitHead": "98a8a5c6f02ac739adda41bb26f43e3255d450bb"
+    "gitHead": "08348a63143c1fc0d62fd75e81271ffc2cab9be4"
 }

package/src/configurator.ts

@@ -1,5 +1,9 @@
-import { AnyModule, ModuleInitializerArgs } from '@equinor/fusion-framework-module';
-import { ServicesModule } from '@equinor/fusion-framework-module-services';
+import {
+    AnyModule,
+    ModuleInitializerArgs,
+    ModulesInstanceType,
+} from '@equinor/fusion-framework-module';
+import { ServicesModule, IApiProvider } from '@equinor/fusion-framework-module-services';
 import { QueryCtorOptions } from '@equinor/fusion-observable/query';
 import { ContextClientOptions } from './client/ContextClient';
 import { ContextItem, QueryContextParameters } from './types';
@@ -8,6 +12,8 @@ import { getContextSelector, queryContextSelector } from './selectors';
 export interface IContextModuleConfig {
     getContext: ContextClientOptions;
     queryContext: QueryCtorOptions<ContextItem[], QueryContextParameters>;
+    contextType?: string[];
+    contextFilter?: (items: Array<ContextItem>) => Array<ContextItem>;
 }
 
 export interface IContextModuleConfigurator<TDeps extends Array<AnyModule> = [ServicesModule]> {
@@ -15,17 +21,9 @@ export interface IContextModuleConfigurator<TDeps extends Array<AnyModule> = [Se
     createConfig: (
         args: ModuleInitializerArgs<IContextModuleConfigurator, TDeps>
     ) => Promise<IContextModuleConfig>;
-    processConfig: (config: IContextModuleConfig) => IContextModuleConfig;
-
-    /** fired on initialize of module */
-    createContextClientGet(
-        init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>
-    ): Promise<QueryCtorOptions<ContextItem, { id: string }>['client']>;
 
-    /** fired on initialize of module */
-    createContextClientQuery(
-        init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>
-    ): Promise<QueryCtorOptions<ContextItem[], QueryContextParameters>['client']>;
+    /** post process function for altering created config  */
+    processConfig: (config: IContextModuleConfig) => IContextModuleConfig;
 }
 
 export class ContextModuleConfigurator implements IContextModuleConfigurator<[ServicesModule]> {
@@ -33,11 +31,10 @@ export class ContextModuleConfigurator implements IContextModuleConfigurator<[Se
 
     defaultExpireTime = 1 * 60 * 1000;
 
-    public async createContextClientGet(
-        init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>
+    protected async _createContextClientGet(
+        apiProvider: IApiProvider
     ): Promise<QueryCtorOptions<ContextItem, { id: string }>['client']> {
-        const provider = await init.requireInstance('services');
-        const contextClient = await provider.createContextClient('json$');
+        const contextClient = await apiProvider.createContextClient('json$');
         return {
             fn: (args) => {
                 return contextClient.get('v1', args, { selector: getContextSelector });
@@ -45,11 +42,10 @@ export class ContextModuleConfigurator implements IContextModuleConfigurator<[Se
         };
     }
 
-    public async createContextClientQuery(
-        init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>
+    protected async _createContextClientQuery(
+        apiProvider: IApiProvider
     ): Promise<QueryCtorOptions<ContextItem[], QueryContextParameters>['client']> {
-        const provider = await init.requireInstance('services');
-        const contextClient = await provider.createContextClient('json$');
+        const contextClient = await apiProvider.createContextClient('json$');
         return {
             fn: (query) => {
                 return contextClient.query('v1', { query }, { selector: queryContextSelector });
@@ -57,19 +53,35 @@ export class ContextModuleConfigurator implements IContextModuleConfigurator<[Se
         };
     }
 
+    protected async _getServiceProvider(
+        init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>
+    ): Promise<IApiProvider> {
+        if (init.hasModule('services')) {
+            return init.requireInstance('services');
+        } else {
+            const parentServiceModule = (init.ref as ModulesInstanceType<[ServicesModule]>)
+                ?.services;
+            if (parentServiceModule) {
+                return parentServiceModule;
+            }
+            throw Error('no service services provider configures [ServicesModule]');
+        }
+    }
+
     public async createConfig(
         init: ModuleInitializerArgs<IContextModuleConfigurator, [ServicesModule]>
     ) {
+        const apiProvider = await this._getServiceProvider(init);
         const config: IContextModuleConfig = {
             getContext: {
                 query: {
-                    client: await this.createContextClientGet(init),
+                    client: await this._createContextClientGet(apiProvider),
                     key: ({ id }) => id,
                     expire: this.defaultExpireTime,
                 },
             },
             queryContext: {
-                client: await this.createContextClientQuery(init),
+                client: await this._createContextClientQuery(apiProvider),
                 key: (args) => JSON.stringify(args),
                 expire: this.defaultExpireTime,
             },

package/src/index.ts

@@ -1,12 +1,26 @@
 import { IModulesConfigurator } from '@equinor/fusion-framework-module';
+import { IContextModuleConfig } from './configurator';
 
 import { module } from './module';
 /**
  * Method for enabling the Service module
- * @param config - configuration object
+ * @param configurator - configuration object
  */
-export const enableContext = (config: IModulesConfigurator): void => {
-    config.addConfig({ module });
+export const enableContext = (
+    configurator: IModulesConfigurator,
+    options?: Pick<IContextModuleConfig, 'contextFilter' | 'contextType'>
+): void => {
+    configurator.addConfig({
+        module,
+        configure: (contextConfigurator) => {
+            contextConfigurator.processConfig = (config) => {
+                return {
+                    ...config,
+                    ...options,
+                };
+            };
+        },
+    });
 };
 
 export {

package/src/provider.ts

@@ -1,4 +1,5 @@
-import { Observable, pairwise, Subscription } from 'rxjs';
+import { lastValueFrom, Observable, Subscription } from 'rxjs';
+import { map, pairwise } from 'rxjs/operators';
 
 import { IContextModuleConfig } from './configurator';
 
@@ -28,12 +29,15 @@ export interface IContextProvider {
 
 export class ContextProvider implements IContextProvider {
     #contextClient: ContextClient;
-    #contextQuery: Query<ContextItem[], QueryContextParameters>;
+    #contextQuery: Query<Array<ContextItem>, QueryContextParameters>;
 
     #event?: ModuleType<EventModule>;
 
     #subscriptions = new Subscription();
 
+    #contextType?: IContextModuleConfig['contextType'];
+    #contextFilter: IContextModuleConfig['contextFilter'];
+
     public get contextClient() {
         return this.#contextClient;
     }
@@ -42,6 +46,23 @@ export class ContextProvider implements IContextProvider {
         return this.#contextQuery;
     }
 
+    public queryContext(search: string): Observable<Array<ContextItem>> {
+        const query$ = this.queryClient
+            .query({
+                search,
+                filter: {
+                    type: this.#contextType,
+                },
+            })
+            .pipe(map((x) => x.value));
+
+        return this.#contextFilter ? query$.pipe(map(this.#contextFilter)) : query$;
+    }
+
+    public queryContextAsync(search: string): Promise<Array<ContextItem>> {
+        return lastValueFrom(this.queryContext(search));
+    }
+
     get currentContext$(): Observable<ContextItem | undefined> {
         return this.#contextClient.currentContext$;
     }
@@ -77,6 +98,10 @@ export class ContextProvider implements IContextProvider {
         parentContext?: IContextProvider;
     }) {
         const { config, event, parentContext } = args;
+
+        this.#contextType = config.contextType;
+        this.#contextFilter = config.contextFilter;
+
         this.#contextClient = new ContextClient(config.getContext);
 
         this.#contextQuery = new Query(config.queryContext);