@equinor/fusion-framework-module-context 4.1.0 → 4.1.1

package/src/module.ts

@@ -25,27 +25,41 @@ export const module: ContextModule = {
     name: moduleKey,
     configure: () => new ContextModuleConfigurator(),
     initialize: async function (args) {
+        // create config from configurator
         const config = await (args.config as ContextModuleConfigurator).createConfig(args);
+
+        // get event module if available
         const event = args.hasModule('event') ? await args.requireInstance('event') : undefined;
+
+        // get parent context provider if available
         const parentProvider = (args.ref as ModulesInstance<[ContextModule]>)?.context;
+
+        // create context provider
         const provider = new ContextProvider({ config, event, parentContext: parentProvider });
 
+        // create subscription for disposing the provider
         const subscription = new Subscription(() => provider.dispose());
 
+        // setup post initialize to module
         this.postInitialize = (args) =>
+            // create observable for resolving initial context
             new Observable((subscriber) => {
+                // resolve initial context if available from config if available
                 const resolveInitialContext$ = config.resolveInitialContext
                     ? from(config.resolveInitialContext(args)).pipe(
+                          // filter out invalid context items
                           filter((item): item is ContextItem => !!item),
                           switchMap((item) =>
+                              // set current context with validation and resolution
                               args.modules.context.setCurrentContext(item, {
                                   validate: true,
                                   resolve: true,
                               }),
                           ),
                       )
-                    : EMPTY;
+                    : EMPTY; // if no initial context is available, complete immediately
 
+                // add teardown to resolve initial context
                 subscriber.add(
                     resolveInitialContext$
                         .pipe(
@@ -55,6 +69,7 @@ export const module: ContextModule = {
                                     'failed to resolve initial context',
                                     err,
                                 );
+                                // failed to resolve initial context, complete immediately
                                 return EMPTY;
                             }),
                         )
@@ -67,6 +82,7 @@ export const module: ContextModule = {
                                 );
                             },
                             complete: () => {
+                                // connect parent context if available when stream completes
                                 if (config.connectParentContext !== false && parentProvider) {
                                     provider.connectParentContext(parentProvider);
                                 }
@@ -76,6 +92,7 @@ export const module: ContextModule = {
                 );
             });
 
+        // add teardown to module
         this.dispose = () => subscription.unsubscribe();
 
         return provider;

package/src/selectors.ts

@@ -4,12 +4,23 @@ import type { QueryContextResponse } from '@equinor/fusion-framework-module-serv
 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,
@@ -25,16 +36,31 @@ const parseContextItem = (item: ApiContextEntity<ApiVersion.v1>): ContextItem =>
     };
 };
 
+/**
+ * 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);

package/src/version.ts

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