@equinor/fusion-framework-module-context 6.0.7-next.0 → 7.0.1

package/src/configurator.ts

@@ -86,13 +86,12 @@ export class ContextModuleConfigurator implements IContextModuleConfigurator {
   ): Promise<IApiProvider> {
     if (init.hasModule('services')) {
       return init.requireInstance('services');
-    } else {
-      const parentServiceModule = (init.ref as ModulesInstanceType<[ServicesModule]>)?.services;
-      if (parentServiceModule) {
-        return parentServiceModule;
-      }
+    }
+    const parentServiceModule = (init.ref as ModulesInstanceType<[ServicesModule]>)?.services;
+    if (!parentServiceModule) {
       throw Error('no service services provider configures [ServicesModule]');
     }
+    return parentServiceModule;
   }
 
   public async createConfig(

package/src/errors.ts

@@ -1,5 +1,16 @@
 /**
- * Represents an error that occurs during a search in the Fusion Context.
+ * Represents an error that occurs during a Fusion context search operation.
+ *
+ * This error provides a title and an optional description to give more context
+ * about the failure. It extends the built-in `Error` class and sets the error
+ * name to `'FusionContextSearchError'`.
+ *
+ * @example
+ * ```typescript
+ * throw new FusionContextSearchError({ title: 'Search failed', description: 'No results found.' });
+ * ```
+ *
+ * @public
  */
 export class FusionContextSearchError extends Error {
   #details;

package/src/module.ts

@@ -14,6 +14,16 @@ export type ContextModuleKey = 'context';
 
 export const moduleKey: ContextModuleKey = 'context';
 
+/**
+ * Represents a module for managing context within the framework.
+ *
+ * @typeParam ContextModuleKey - The unique key identifying the context module.
+ * @typeParam IContextProvider - The provider interface for context-related services.
+ * @typeParam IContextModuleConfigurator - The configurator interface for customizing the context module.
+ * @typeParam [ServicesModule, EventModule, NavigationModule] - The tuple of dependent modules required by the context module.
+ *
+ * @see Module
+ */
 export type ContextModule = Module<
   ContextModuleKey,
   IContextProvider,
@@ -21,6 +31,27 @@ export type ContextModule = Module<
   [ServicesModule, EventModule, NavigationModule]
 >;
 
+/**
+ * The `module` object implements the `ContextModule` interface and provides the configuration,
+ * initialization, and lifecycle management for the context module within the Fusion Framework.
+ *
+ * @remarks
+ * - The `configure` method returns a new `ContextModuleConfigurator` for module configuration.
+ * - The `initialize` method asynchronously creates a `ContextProvider` using the provided configuration,
+ *   optional event module, and optional parent context provider. It also sets up resource disposal and
+ *   post-initialization logic.
+ * - The `postInitialize` function (attached during initialization) resolves the initial context if available,
+ *   sets it as the current context, and connects to the parent context provider if configured to do so.
+ * - The `dispose` function ensures proper cleanup by unsubscribing from the provider's subscription.
+ *
+ * @property {string} name - The unique key identifying the module.
+ * @method configure - Returns a new instance of `ContextModuleConfigurator` for configuring the module.
+ * @method initialize - Asynchronously initializes the context provider, sets up context resolution,
+ *   and manages lifecycle hooks.
+ * @see ContextModule
+ * @see ContextModuleConfigurator
+ * @see ContextProvider
+ */
 export const module: ContextModule = {
   name: moduleKey,
   configure: () => new ContextModuleConfigurator(),

package/src/types.ts

@@ -1,3 +1,23 @@
+/**
+ * Represents a contextual item with associated metadata, value, and optional graphical or meta content.
+ *
+ * @typeParam TType - The type of the value property, defaults to a generic record.
+ * @property id - Unique identifier for the context item.
+ * @property externalId - Optional external identifier.
+ * @property source - Optional source of the context item.
+ * @property type - The type of the context item.
+ * @property value - The value associated with the context item.
+ * @property title - Optional title for display purposes.
+ * @property subTitle - Optional subtitle for display purposes.
+ * @property isActive - Optional flag indicating if the item is active.
+ * @property isDeleted - Optional flag indicating if the item is deleted.
+ * @property created - Optional creation date.
+ * @property updated - Optional last updated date.
+ * @property graphic - Optional graphical representation, either as a string or an object containing type and content.
+ * @property meta - Optional meta information, either as a string or an object containing type and content.
+ *
+ * @todo - convert to Zod schema for validation and type safety.
+ */
 export type ContextItem<TType extends Record<string, unknown> = Record<string, unknown>> = {
   id: string;
   externalId?: string;
@@ -38,6 +58,19 @@ export type QueryContextParameters = {
   };
 };
 
+/**
+ * Parameters for retrieving related context items.
+ *
+ * @property item - The context item to find relations for.
+ * @property filter - Optional filter criteria.
+ * @property filter.type - Optional array of types to filter related items by.
+ */
 export type RelatedContextParameters = { item: ContextItem; filter?: { type?: string[] } };
 
+/**
+ * A function type that filters an array of `ContextItem` objects.
+ *
+ * @param items - The array of `ContextItem` objects to be filtered.
+ * @returns A new array of `ContextItem` objects after applying the filter.
+ */
 export type ContextFilterFn = (items: ContextItem[]) => ContextItem[];

package/src/utils/enable-context.ts

@@ -9,11 +9,27 @@ import type { ContextConfigBuilder } from '../ContextConfigBuilder';
 import { module } from '../module';
 
 /**
- * Method for enabling the Service module
- * @param configurator - configuration object
+ * Enables context configuration for a given modules configurator.
+ *
+ * @param configurator - The modules configurator instance to which the context module will be added.
+ * @param builder - An optional function that receives a context configuration builder. This function can be used to further configure the context module. It can be asynchronous.
+ *
+ * @remarks
+ * This utility function adds the context module to the provided configurator and optionally applies additional configuration using the provided builder function.
+ *
+ * @example
+ * ```ts
+ * import { enableContext } from '@equinor/fusion-framework-module-context';
+ *
+ * const configure = (configurator: IModulesConfigurator<any, any>) => {
+ *   enableContext(configurator, (builder) => {
+ *     // configure the context module here
+ *   });
+ * };
+ * ```
  */
 export const enableContext = (
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  // biome-ignore lint/suspicious/noExplicitAny: must be any to support all module types
   configurator: IModulesConfigurator<any, any>,
   builder?: <TDeps extends Array<AnyModule> = []>(
     builder: ContextConfigBuilder<TDeps, ModuleInitializerArgs<IContextModuleConfigurator, TDeps>>,

package/src/version.ts

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