@equinor/fusion-framework-react-app 9.0.8 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/CHANGELOG.md +85 -14
  2. package/README.md +176 -99
  3. package/dist/esm/ag-grid/useTheme.js +7 -0
  4. package/dist/esm/ag-grid/useTheme.js.map +1 -1
  5. package/dist/esm/analytics/index.js +8 -0
  6. package/dist/esm/analytics/index.js.map +1 -1
  7. package/dist/esm/analytics/useTrackFeature.js +17 -1
  8. package/dist/esm/analytics/useTrackFeature.js.map +1 -1
  9. package/dist/esm/apploader/Apploader.js +1 -1
  10. package/dist/esm/apploader/Apploader.js.map +1 -1
  11. package/dist/esm/apploader/index.js +8 -0
  12. package/dist/esm/apploader/index.js.map +1 -1
  13. package/dist/esm/bookmark/index.js +8 -0
  14. package/dist/esm/bookmark/index.js.map +1 -1
  15. package/dist/esm/context/index.js +8 -0
  16. package/dist/esm/context/index.js.map +1 -1
  17. package/dist/esm/context/useContextProvider.js +6 -0
  18. package/dist/esm/context/useContextProvider.js.map +1 -1
  19. package/dist/esm/context/useCurrentContext.js +14 -0
  20. package/dist/esm/context/useCurrentContext.js.map +1 -1
  21. package/dist/esm/create-legacy-app.js +13 -0
  22. package/dist/esm/create-legacy-app.js.map +1 -1
  23. package/dist/esm/feature-flag/index.js.map +1 -1
  24. package/dist/esm/feature-flag/useFeature.js +20 -4
  25. package/dist/esm/feature-flag/useFeature.js.map +1 -1
  26. package/dist/esm/framework/index.js +8 -1
  27. package/dist/esm/framework/index.js.map +1 -1
  28. package/dist/esm/framework/useFrameworkCurrentContext.js +9 -0
  29. package/dist/esm/framework/useFrameworkCurrentContext.js.map +1 -1
  30. package/dist/esm/help-center/useHelpCenter.js +12 -1
  31. package/dist/esm/help-center/useHelpCenter.js.map +1 -1
  32. package/dist/esm/http/index.js +9 -0
  33. package/dist/esm/http/index.js.map +1 -1
  34. package/dist/esm/http/selectors.js +10 -0
  35. package/dist/esm/http/selectors.js.map +1 -0
  36. package/dist/esm/index.js +16 -2
  37. package/dist/esm/index.js.map +1 -1
  38. package/dist/esm/make-component.js +1 -1
  39. package/dist/esm/make-component.js.map +1 -1
  40. package/dist/esm/msal/index.js +13 -0
  41. package/dist/esm/msal/index.js.map +1 -1
  42. package/dist/esm/msal/useAccessToken.js +15 -3
  43. package/dist/esm/msal/useAccessToken.js.map +1 -1
  44. package/dist/esm/msal/useCurrentAccount.js +12 -2
  45. package/dist/esm/msal/useCurrentAccount.js.map +1 -1
  46. package/dist/esm/msal/useToken.js +19 -3
  47. package/dist/esm/msal/useToken.js.map +1 -1
  48. package/dist/esm/navigation/index.js +8 -0
  49. package/dist/esm/navigation/index.js.map +1 -1
  50. package/dist/esm/navigation/useNavigationModule.js +6 -1
  51. package/dist/esm/navigation/useNavigationModule.js.map +1 -1
  52. package/dist/esm/navigation/useRouter.js +23 -4
  53. package/dist/esm/navigation/useRouter.js.map +1 -1
  54. package/dist/esm/render-app.js +22 -1
  55. package/dist/esm/render-app.js.map +1 -1
  56. package/dist/esm/render-component.js +30 -23
  57. package/dist/esm/render-component.js.map +1 -1
  58. package/dist/esm/settings/index.js +8 -0
  59. package/dist/esm/settings/index.js.map +1 -1
  60. package/dist/esm/useAppModule.js +13 -5
  61. package/dist/esm/useAppModule.js.map +1 -1
  62. package/dist/esm/useAppModules.js +9 -3
  63. package/dist/esm/useAppModules.js.map +1 -1
  64. package/dist/esm/version.js +1 -1
  65. package/dist/esm/version.js.map +1 -1
  66. package/dist/tsconfig.tsbuildinfo +1 -1
  67. package/dist/types/ag-grid/useTheme.d.ts +7 -0
  68. package/dist/types/analytics/index.d.ts +8 -0
  69. package/dist/types/analytics/useTrackFeature.d.ts +17 -1
  70. package/dist/types/apploader/Apploader.d.ts +3 -2
  71. package/dist/types/apploader/index.d.ts +8 -0
  72. package/dist/types/bookmark/index.d.ts +8 -0
  73. package/dist/types/context/index.d.ts +8 -0
  74. package/dist/types/context/useContextProvider.d.ts +6 -0
  75. package/dist/types/context/useCurrentContext.d.ts +14 -0
  76. package/dist/types/create-legacy-app.d.ts +13 -0
  77. package/dist/types/feature-flag/index.d.ts +8 -0
  78. package/dist/types/feature-flag/useFeature.d.ts +20 -4
  79. package/dist/types/framework/index.d.ts +8 -0
  80. package/dist/types/framework/useFrameworkCurrentContext.d.ts +9 -0
  81. package/dist/types/help-center/useHelpCenter.d.ts +12 -1
  82. package/dist/types/http/index.d.ts +9 -0
  83. package/dist/types/http/selectors.d.ts +9 -0
  84. package/dist/types/index.d.ts +18 -1
  85. package/dist/types/make-component.d.ts +15 -0
  86. package/dist/types/msal/index.d.ts +13 -0
  87. package/dist/types/msal/useAccessToken.d.ts +15 -3
  88. package/dist/types/msal/useCurrentAccount.d.ts +12 -2
  89. package/dist/types/msal/useToken.d.ts +19 -3
  90. package/dist/types/navigation/index.d.ts +8 -0
  91. package/dist/types/navigation/useNavigationModule.d.ts +6 -1
  92. package/dist/types/navigation/useRouter.d.ts +23 -4
  93. package/dist/types/render-app.d.ts +22 -1
  94. package/dist/types/render-component.d.ts +16 -1
  95. package/dist/types/settings/index.d.ts +8 -0
  96. package/dist/types/useAppModule.d.ts +13 -5
  97. package/dist/types/useAppModules.d.ts +9 -3
  98. package/dist/types/version.d.ts +1 -1
  99. package/package.json +35 -27
  100. package/src/__tests__/render-app.test.tsx +113 -0
  101. package/src/ag-grid/useTheme.ts +7 -0
  102. package/src/analytics/index.ts +8 -0
  103. package/src/analytics/useTrackFeature.ts +17 -1
  104. package/src/apploader/Apploader.tsx +3 -3
  105. package/src/apploader/index.ts +8 -0
  106. package/src/bookmark/index.ts +8 -0
  107. package/src/context/index.ts +8 -0
  108. package/src/context/useContextProvider.ts +6 -0
  109. package/src/context/useCurrentContext.ts +14 -0
  110. package/src/create-legacy-app.tsx +13 -0
  111. package/src/feature-flag/index.ts +8 -0
  112. package/src/feature-flag/useFeature.ts +20 -4
  113. package/src/framework/index.ts +8 -1
  114. package/src/framework/useFrameworkCurrentContext.ts +9 -0
  115. package/src/help-center/useHelpCenter.ts +12 -1
  116. package/src/http/index.ts +9 -0
  117. package/src/http/selectors.ts +9 -0
  118. package/src/index.ts +20 -2
  119. package/src/make-component.tsx +16 -1
  120. package/src/msal/index.ts +13 -0
  121. package/src/msal/useAccessToken.ts +15 -3
  122. package/src/msal/useCurrentAccount.ts +12 -2
  123. package/src/msal/useToken.ts +19 -3
  124. package/src/navigation/index.ts +8 -0
  125. package/src/navigation/useNavigationModule.ts +6 -1
  126. package/src/navigation/useRouter.ts +23 -4
  127. package/src/render-app.ts +22 -1
  128. package/src/render-component.tsx +36 -27
  129. package/src/settings/index.ts +8 -0
  130. package/src/useAppModule.ts +13 -5
  131. package/src/useAppModules.ts +11 -5
  132. package/src/version.ts +1 -1
  133. package/tsconfig.json +1 -1
  134. package/vitest.config.ts +15 -0
@@ -1,11 +1,19 @@
1
1
  import { useAppModules } from './useAppModules';
2
2
  /**
3
- * Retrieves the specified app module from the app scope.
3
+ * React hook that retrieves a single module instance from the application scope.
4
4
  *
5
- * @template TType - The type of the app module.
6
- * @template TKey - The key of the app module.
7
- * @param module - The key of the app module to retrieve.
8
- * @returns The app module instance if found, otherwise throws an error.
5
+ * @template TType - The concrete module type (e.g. `ContextModule`). Pass
6
+ * `unknown` to infer the type from the key.
7
+ * @template TKey - The string key used to look up the module.
8
+ * @param module - The key identifying the module to retrieve.
9
+ * @returns The resolved module instance.
10
+ * @throws If the requested module is not registered in the application scope.
11
+ *
12
+ * @example
13
+ * ```tsx
14
+ * const auth = useAppModule('auth');
15
+ * auth.acquireAccessToken().then(console.log);
16
+ * ```
9
17
  */
10
18
  export function useAppModule(module) {
11
19
  const appModule = useAppModules()[module];
@@ -1 +1 @@
1
- {"version":3,"file":"useAppModule.js","sourceRoot":"","sources":["../../src/useAppModule.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAI1B,MAAY;IAIZ,MAAM,SAAS,GAAG,aAAa,EAAE,CAAC,MAAkC,CAAC,CAAC;IACtE,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,KAAK,CAAC,yBAAyB,MAAM,oCAAoC,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,SAEwD,CAAC;AAClE,CAAC;AAED,eAAe,YAAY,CAAC"}
1
+ {"version":3,"file":"useAppModule.js","sourceRoot":"","sources":["../../src/useAppModule.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,YAAY,CAI1B,MAAY;IAIZ,MAAM,SAAS,GAAG,aAAa,EAAE,CAAC,MAAkC,CAAC,CAAC;IACtE,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,KAAK,CAAC,yBAAyB,MAAM,oCAAoC,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,SAEwD,CAAC;AAClE,CAAC;AAED,eAAe,YAAY,CAAC"}
@@ -1,9 +1,15 @@
1
1
  import { useModules } from '@equinor/fusion-framework-react-module';
2
2
  /**
3
- * Custom hook that returns an instance of the app modules.
3
+ * React hook that returns the full set of initialised application-scoped modules.
4
4
  *
5
- * @template T - The type of the app modules.
6
- * @returns An instance of the app modules.
5
+ * @template T - Optional array of additional module types beyond the defaults.
6
+ * @returns The {@link AppModulesInstance} containing all registered modules.
7
+ *
8
+ * @example
9
+ * ```tsx
10
+ * const modules = useAppModules();
11
+ * console.log(Object.keys(modules));
12
+ * ```
7
13
  */
8
14
  export const useAppModules = () => useModules();
9
15
  export default useAppModules;
@@ -1 +1 @@
1
- {"version":3,"file":"useAppModules.js","sourceRoot":"","sources":["../../src/useAppModules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,GAEF,EAAE,CAAC,UAAU,EAAyB,CAAC;AAElE,eAAe,aAAa,CAAC"}
1
+ {"version":3,"file":"useAppModules.js","sourceRoot":"","sources":["../../src/useAppModules.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AAEpE;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,GAEF,EAAE,CAAC,UAAU,EAA0C,CAAC;AAEnF,eAAe,aAAa,CAAC"}
@@ -1,3 +1,3 @@
1
1
  // Generated by genversion.
2
- export const version = '9.0.8';
2
+ export const version = '10.0.0';
3
3
  //# sourceMappingURL=version.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}
1
+ {"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC"}