@equinor/fusion-framework-react-app 4.3.6 → 4.3.7

package/dist/types/useAppModule.d.ts

@@ -1,4 +1,4 @@
 import type { AppModules, AppModulesInstance } from '@equinor/fusion-framework-app';
-import { AnyModule, ModuleKey, ModuleType, ModuleTypes } from '@equinor/fusion-framework-module';
-export declare const useAppModule: <TType extends unknown = unknown, TKey extends string = ModuleKey<ModuleTypes<AppModules<[TType]>>>>(module: TKey) => TType extends AnyModule ? ModuleType<TType> : AppModulesInstance[Extract<"event", TKey> | Extract<"http", TKey> | Extract<"auth", TKey> | Extract<"dispose", TKey>];
+import type { AnyModule, ModuleKey, ModuleType, ModuleTypes } from '@equinor/fusion-framework-module';
+export declare function useAppModule<TType extends AnyModule | unknown = unknown, TKey extends string = ModuleKey<ModuleTypes<AppModules<[TType]>>>>(module: TKey): TType extends AnyModule ? ModuleType<TType> : AppModulesInstance[Extract<keyof AppModulesInstance, TKey>];
 export default useAppModule;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "4.3.6";
+export declare const version = "4.3.7";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-react-app",
-  "version": "4.3.6",
+  "version": "4.3.7",
   "description": "",
   "main": "dist/esm/index.js",
   "exports": {
@@ -55,12 +55,12 @@
     "directory": "packages/react"
   },
   "dependencies": {
-    "@equinor/fusion-framework-app": "^8.1.2",
-    "@equinor/fusion-framework-module-app": "^5.2.13",
+    "@equinor/fusion-framework-app": "^8.1.3",
     "@equinor/fusion-framework-module": "^4.2.7",
-    "@equinor/fusion-framework-react": "^6.0.3",
+    "@equinor/fusion-framework-module-app": "^5.2.14",
     "@equinor/fusion-framework-module-navigation": "^3.1.4",
     "@equinor/fusion-framework-react-module": "^3.0.8",
+    "@equinor/fusion-framework-react": "^6.0.4",
     "@equinor/fusion-framework-react-module-http": "^4.0.6"
   },
   "devDependencies": {
@@ -73,9 +73,9 @@
     "@equinor/fusion-framework-module-event": "^4.0.8",
     "@equinor/fusion-framework-module-feature-flag": "^1.0.2",
     "@equinor/fusion-framework-module-msal": "^3.0.10",
-    "@equinor/fusion-framework-react-module-bookmark": "^2.0.33",
-    "@equinor/fusion-framework-react-widget": "^1.0.1",
-    "@equinor/fusion-framework-react-module-context": "^6.1.0",
+    "@equinor/fusion-framework-react-widget": "^1.0.2",
+    "@equinor/fusion-framework-react-module-bookmark": "^2.0.34",
+    "@equinor/fusion-framework-react-module-context": "^6.1.1",
     "@equinor/fusion-observable": "^8.1.5"
   },
   "peerDependencies": {

package/src/useAppModule.ts

@@ -1,31 +1,36 @@
 import type { AppModules, AppModulesInstance } from '@equinor/fusion-framework-app';
-import { AnyModule, ModuleKey, ModuleType, ModuleTypes } from '@equinor/fusion-framework-module';
+import type {
+    AnyModule,
+    ModuleKey,
+    ModuleType,
+    ModuleTypes,
+} from '@equinor/fusion-framework-module';
+
 import { useAppModules } from './useAppModules';
 
 /**
- * hook for getting a module from the application scope
- *
- * @template TType type of the module
- *
- * @param module name of the module, provide TType if not registered
+ * Retrieves the specified app module from the app scope.
  *
- * @returns provider of the module
+ * @template TType - The type of the app module.
+ * @template TKey - The key of the app module.
+ * @param module - The key of the app module to retrieve.
+ * @returns The app module instance if found, otherwise throws an error.
  */
-export const useAppModule = <
+export function useAppModule<
     TType extends AnyModule | unknown = unknown,
     TKey extends string = ModuleKey<ModuleTypes<AppModules<[TType]>>>,
 >(
     module: TKey,
 ): TType extends AnyModule
     ? ModuleType<TType>
-    : AppModulesInstance[Extract<keyof AppModulesInstance, TKey>] => {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    const appModule = useAppModules()[module];
+    : AppModulesInstance[Extract<keyof AppModulesInstance, TKey>] {
+    const appModule = useAppModules()[module as keyof AppModulesInstance];
     if (!appModule) {
         throw Error(`the requested module [${module}] is not included in the app scope`);
     }
-    return appModule;
-};
+    return appModule as TType extends AnyModule
+        ? ModuleType<TType>
+        : AppModulesInstance[Extract<keyof AppModulesInstance, TKey>];
+}
 
 export default useAppModule;

package/src/useAppModules.ts

@@ -2,6 +2,12 @@ import type { AppModulesInstance } from '@equinor/fusion-framework-app';
 import type { AnyModule } from '@equinor/fusion-framework-module';
 import { useModules } from '@equinor/fusion-framework-react-module';
 
+/**
+ * Custom hook that returns an instance of the app modules.
+ *
+ * @template T - The type of the app modules.
+ * @returns An instance of the app modules.
+ */
 export const useAppModules = <
     T extends Array<AnyModule> | unknown = unknown,
 >(): AppModulesInstance<T> => useModules<AppModulesInstance<T>>();

package/src/version.ts

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