@j2inn/fin5-ui-utils 8.1.1-beta.6 → 8.1.1

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 (210) hide show
  1. package/README.md +5 -5
  2. package/dist/fantomProps/createFin5Props/index.d.ts +12 -12
  3. package/dist/fantomProps/createFin5Props/index.js +146 -146
  4. package/dist/fantomProps/createFin5Props/runCreateFin5Props.d.ts +2 -2
  5. package/dist/fantomProps/createFin5Props/runCreateFin5Props.js +20 -20
  6. package/dist/fantomProps/fantomPropsToObject.d.ts +8 -8
  7. package/dist/fantomProps/fantomPropsToObject.js +183 -183
  8. package/dist/fantomProps/generateJsonFromFantomPropsFile.d.ts +4 -4
  9. package/dist/fantomProps/generateJsonFromFantomPropsFile.js +41 -41
  10. package/dist/fantomProps/localePropsToJson.d.ts +1 -1
  11. package/dist/fantomProps/localePropsToJson.js +50 -50
  12. package/dist/fantomProps/readFantomPropsFile.d.ts +5 -5
  13. package/dist/fantomProps/readFantomPropsFile.js +65 -65
  14. package/dist/fin5Top/fin5FileUpload.d.ts +24 -24
  15. package/dist/fin5Top/fin5FileUpload.js +51 -51
  16. package/dist/fin5Top/fin5Top.d.ts +165 -165
  17. package/dist/fin5Top/fin5Top.js +61 -61
  18. package/dist/fin5Top/finEdge2Cloud.d.ts +6 -6
  19. package/dist/fin5Top/finEdge2Cloud.js +15 -15
  20. package/dist/fin5Top/getFin5BinUrl.d.ts +2 -2
  21. package/dist/fin5Top/getFin5BinUrl.js +9 -9
  22. package/dist/fin5Top/openFin5Alarm.d.ts +22 -22
  23. package/dist/fin5Top/openFin5Alarm.js +23 -23
  24. package/dist/fin5Top/openFin5Historian.d.ts +3 -3
  25. package/dist/fin5Top/openFin5Historian.js +19 -19
  26. package/dist/fin5Top/useFin5AppURLHashParameter.d.ts +18 -18
  27. package/dist/fin5Top/useFin5AppURLHashParameter.js +133 -133
  28. package/dist/index.d.ts +35 -35
  29. package/dist/index.js +69 -69
  30. package/dist/jobs/jobUtils.d.ts +14 -14
  31. package/dist/jobs/jobUtils.js +15 -15
  32. package/dist/react/app/Fin5AppContainer.d.ts +36 -36
  33. package/dist/react/app/Fin5AppContainer.js +145 -145
  34. package/dist/react/app/Fin5AppRootStore.d.ts +40 -40
  35. package/dist/react/app/Fin5AppRootStore.js +90 -90
  36. package/dist/react/components/ErrorBoundary.d.ts +57 -57
  37. package/dist/react/components/ErrorBoundary.js +150 -150
  38. package/dist/react/components/ErrorDisplayer.d.ts +19 -19
  39. package/dist/react/components/ErrorDisplayer.js +36 -36
  40. package/dist/react/components/Loader.d.ts +9 -9
  41. package/dist/react/components/Loader.js +17 -17
  42. package/dist/react/components/LoadingSpinner.d.ts +2 -2
  43. package/dist/react/components/LoadingSpinner.js +27 -27
  44. package/dist/react/components/RecordImage.d.ts +20 -20
  45. package/dist/react/components/RecordImage.js +51 -51
  46. package/dist/react/components/charts/QRCode.d.ts +25 -25
  47. package/dist/react/components/charts/QRCode.js +82 -82
  48. package/dist/react/components/charts/line-bar/Chart.d.ts +166 -166
  49. package/dist/react/components/charts/line-bar/Chart.js +442 -442
  50. package/dist/react/components/charts/line-bar/HGridChart.d.ts +58 -58
  51. package/dist/react/components/charts/line-bar/HGridChart.js +285 -285
  52. package/dist/react/components/charts/pie/PieChart.d.ts +94 -94
  53. package/dist/react/components/charts/pie/PieChart.js +204 -204
  54. package/dist/react/components/charts/pie/SimplePieChart.d.ts +21 -21
  55. package/dist/react/components/charts/pie/SimplePieChart.js +55 -55
  56. package/dist/react/components/graphics/GraphicViewer.d.ts +10 -10
  57. package/dist/react/components/graphics/GraphicViewer.js +29 -29
  58. package/dist/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  59. package/dist/react/components/graphics/GraphicsTabViewer.js +90 -90
  60. package/dist/react/components/makeCustomElement.d.ts +16 -16
  61. package/dist/react/components/makeCustomElement.js +150 -150
  62. package/dist/react/components/navigation/BasicLayout.d.ts +41 -41
  63. package/dist/react/components/navigation/BasicLayout.js +155 -155
  64. package/dist/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  65. package/dist/react/components/navigation/HeaderSiderLayout.js +110 -110
  66. package/dist/react/components/navigation/MenuPage.d.ts +37 -37
  67. package/dist/react/components/navigation/MenuPage.js +36 -36
  68. package/dist/react/components/navigation/MenuTrigger.d.ts +9 -9
  69. package/dist/react/components/navigation/MenuTrigger.js +33 -33
  70. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  71. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.js +25 -25
  72. package/dist/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  73. package/dist/react/components/navigation/ReactRouterLayout.js +132 -132
  74. package/dist/react/components/navigation/customRouting/Router.d.ts +12 -12
  75. package/dist/react/components/navigation/customRouting/Router.js +45 -45
  76. package/dist/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  77. package/dist/react/components/navigation/customRouting/RouterLayout.js +61 -61
  78. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  79. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.js +95 -95
  80. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  81. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +88 -88
  82. package/dist/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  83. package/dist/react/components/resolvable/configurationForm/getSectionDefault.js +99 -99
  84. package/dist/react/hooks/useFin5BinUrl.d.ts +6 -6
  85. package/dist/react/hooks/useFin5BinUrl.js +15 -15
  86. package/dist/react/hooks/useFin5ColorScheme.d.ts +2 -2
  87. package/dist/react/hooks/useFin5ColorScheme.js +56 -56
  88. package/dist/react/hooks/useScreenSize.d.ts +7 -7
  89. package/dist/react/hooks/useScreenSize.js +31 -31
  90. package/dist_es/fantomProps/createFin5Props/index.d.ts +12 -12
  91. package/dist_es/fantomProps/createFin5Props/index.js +140 -140
  92. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.d.ts +2 -2
  93. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.js +15 -15
  94. package/dist_es/fantomProps/fantomPropsToObject.d.ts +8 -8
  95. package/dist_es/fantomProps/fantomPropsToObject.js +178 -178
  96. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.d.ts +4 -4
  97. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.js +12 -12
  98. package/dist_es/fantomProps/localePropsToJson.d.ts +1 -1
  99. package/dist_es/fantomProps/localePropsToJson.js +21 -21
  100. package/dist_es/fantomProps/readFantomPropsFile.d.ts +5 -5
  101. package/dist_es/fantomProps/readFantomPropsFile.js +39 -39
  102. package/dist_es/fin5Top/fin5FileUpload.d.ts +24 -24
  103. package/dist_es/fin5Top/fin5FileUpload.js +47 -47
  104. package/dist_es/fin5Top/fin5Top.d.ts +165 -165
  105. package/dist_es/fin5Top/fin5Top.js +57 -57
  106. package/dist_es/fin5Top/finEdge2Cloud.d.ts +6 -6
  107. package/dist_es/fin5Top/finEdge2Cloud.js +11 -11
  108. package/dist_es/fin5Top/getFin5BinUrl.d.ts +2 -2
  109. package/dist_es/fin5Top/getFin5BinUrl.js +5 -5
  110. package/dist_es/fin5Top/openFin5Alarm.d.ts +22 -22
  111. package/dist_es/fin5Top/openFin5Alarm.js +19 -19
  112. package/dist_es/fin5Top/openFin5Historian.d.ts +3 -3
  113. package/dist_es/fin5Top/openFin5Historian.js +15 -15
  114. package/dist_es/fin5Top/useFin5AppURLHashParameter.d.ts +18 -18
  115. package/dist_es/fin5Top/useFin5AppURLHashParameter.js +124 -124
  116. package/dist_es/index.d.ts +35 -35
  117. package/dist_es/index.js +53 -53
  118. package/dist_es/jobs/jobUtils.d.ts +14 -14
  119. package/dist_es/jobs/jobUtils.js +9 -9
  120. package/dist_es/react/app/Fin5AppContainer.d.ts +36 -36
  121. package/dist_es/react/app/Fin5AppContainer.js +116 -116
  122. package/dist_es/react/app/Fin5AppRootStore.d.ts +40 -40
  123. package/dist_es/react/app/Fin5AppRootStore.js +86 -86
  124. package/dist_es/react/components/ErrorBoundary.d.ts +57 -57
  125. package/dist_es/react/components/ErrorBoundary.js +123 -123
  126. package/dist_es/react/components/ErrorDisplayer.d.ts +19 -19
  127. package/dist_es/react/components/ErrorDisplayer.js +28 -28
  128. package/dist_es/react/components/Loader.d.ts +9 -9
  129. package/dist_es/react/components/Loader.js +12 -12
  130. package/dist_es/react/components/LoadingSpinner.d.ts +2 -2
  131. package/dist_es/react/components/LoadingSpinner.js +20 -20
  132. package/dist_es/react/components/RecordImage.d.ts +20 -20
  133. package/dist_es/react/components/RecordImage.js +24 -24
  134. package/dist_es/react/components/charts/QRCode.d.ts +25 -25
  135. package/dist_es/react/components/charts/QRCode.js +52 -52
  136. package/dist_es/react/components/charts/line-bar/Chart.d.ts +166 -166
  137. package/dist_es/react/components/charts/line-bar/Chart.js +415 -415
  138. package/dist_es/react/components/charts/line-bar/HGridChart.d.ts +58 -58
  139. package/dist_es/react/components/charts/line-bar/HGridChart.js +250 -250
  140. package/dist_es/react/components/charts/pie/PieChart.d.ts +94 -94
  141. package/dist_es/react/components/charts/pie/PieChart.js +177 -177
  142. package/dist_es/react/components/charts/pie/SimplePieChart.d.ts +21 -21
  143. package/dist_es/react/components/charts/pie/SimplePieChart.js +25 -25
  144. package/dist_es/react/components/graphics/GraphicViewer.d.ts +10 -10
  145. package/dist_es/react/components/graphics/GraphicViewer.js +22 -22
  146. package/dist_es/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  147. package/dist_es/react/components/graphics/GraphicsTabViewer.js +60 -60
  148. package/dist_es/react/components/makeCustomElement.d.ts +16 -16
  149. package/dist_es/react/components/makeCustomElement.js +142 -142
  150. package/dist_es/react/components/navigation/BasicLayout.d.ts +41 -41
  151. package/dist_es/react/components/navigation/BasicLayout.js +124 -124
  152. package/dist_es/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  153. package/dist_es/react/components/navigation/HeaderSiderLayout.js +80 -80
  154. package/dist_es/react/components/navigation/MenuPage.d.ts +37 -37
  155. package/dist_es/react/components/navigation/MenuPage.js +30 -30
  156. package/dist_es/react/components/navigation/MenuTrigger.d.ts +9 -9
  157. package/dist_es/react/components/navigation/MenuTrigger.js +28 -28
  158. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  159. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.js +18 -18
  160. package/dist_es/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  161. package/dist_es/react/components/navigation/ReactRouterLayout.js +99 -99
  162. package/dist_es/react/components/navigation/customRouting/Router.d.ts +12 -12
  163. package/dist_es/react/components/navigation/customRouting/Router.js +18 -18
  164. package/dist_es/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  165. package/dist_es/react/components/navigation/customRouting/RouterLayout.js +34 -34
  166. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  167. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.js +64 -64
  168. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  169. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +58 -58
  170. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  171. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.js +94 -94
  172. package/dist_es/react/hooks/useFin5BinUrl.d.ts +6 -6
  173. package/dist_es/react/hooks/useFin5BinUrl.js +11 -11
  174. package/dist_es/react/hooks/useFin5ColorScheme.d.ts +2 -2
  175. package/dist_es/react/hooks/useFin5ColorScheme.js +52 -52
  176. package/dist_es/react/hooks/useScreenSize.d.ts +7 -7
  177. package/dist_es/react/hooks/useScreenSize.js +27 -27
  178. package/package.json +1 -1
  179. package/dist_es/react/app/Fin5AppContainer.jsx +0 -82
  180. package/dist_es/react/app/Fin5AppContainer.jsx.map +0 -1
  181. package/dist_es/react/components/ErrorBoundary.jsx +0 -150
  182. package/dist_es/react/components/ErrorBoundary.jsx.map +0 -1
  183. package/dist_es/react/components/ErrorDisplayer.jsx +0 -36
  184. package/dist_es/react/components/ErrorDisplayer.jsx.map +0 -1
  185. package/dist_es/react/components/Loader.jsx +0 -13
  186. package/dist_es/react/components/Loader.jsx.map +0 -1
  187. package/dist_es/react/components/LoadingSpinner.jsx +0 -22
  188. package/dist_es/react/components/LoadingSpinner.jsx.map +0 -1
  189. package/dist_es/react/components/charts/line-bar/ZincGridChart.d.ts +0 -12
  190. package/dist_es/react/components/charts/line-bar/ZincGridChart.js +0 -17
  191. package/dist_es/react/components/charts/line-bar/ZincGridChart.js.map +0 -1
  192. package/dist_es/react/components/graphics/GraphicViewer.jsx +0 -23
  193. package/dist_es/react/components/graphics/GraphicViewer.jsx.map +0 -1
  194. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx +0 -63
  195. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx.map +0 -1
  196. package/dist_es/react/components/navigation/BasicLayout.jsx +0 -133
  197. package/dist_es/react/components/navigation/BasicLayout.jsx.map +0 -1
  198. package/dist_es/react/components/navigation/MenuPage.jsx +0 -31
  199. package/dist_es/react/components/navigation/MenuPage.jsx.map +0 -1
  200. package/dist_es/react/components/navigation/Router.d.ts +0 -12
  201. package/dist_es/react/components/navigation/Router.js +0 -19
  202. package/dist_es/react/components/navigation/Router.js.map +0 -1
  203. package/dist_es/react/components/navigation/Router.jsx +0 -19
  204. package/dist_es/react/components/navigation/Router.jsx.map +0 -1
  205. package/dist_es/react/components/navigation/react-router/BasicLayout.d.ts +0 -23
  206. package/dist_es/react/components/navigation/react-router/BasicLayout.js +0 -82
  207. package/dist_es/react/components/navigation/react-router/BasicLayout.js.map +0 -1
  208. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.d.ts +0 -24
  209. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js +0 -82
  210. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js.map +0 -1
@@ -1,11 +1,11 @@
1
- import type { Location } from '@remix-run/router';
2
- import React from 'react';
3
- import { HeaderSiderLayoutProps } from './HeaderSiderLayout';
4
- import { ReactRouterMenuPage } from './ReactRouterLayout';
5
- export interface ReactRouterHeaderSiderLayoutProps extends HeaderSiderLayoutProps<ReactRouterMenuPage> {
6
- isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
7
- }
8
- /**
9
- * Header/Sider layout that uses React Router.
10
- */
11
- export declare const ReactRouterHeaderSiderLayout: React.FC<ReactRouterHeaderSiderLayoutProps>;
1
+ import type { Location } from '@remix-run/router';
2
+ import React from 'react';
3
+ import { HeaderSiderLayoutProps } from './HeaderSiderLayout';
4
+ import { ReactRouterMenuPage } from './ReactRouterLayout';
5
+ export interface ReactRouterHeaderSiderLayoutProps extends HeaderSiderLayoutProps<ReactRouterMenuPage> {
6
+ isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
7
+ }
8
+ /**
9
+ * Header/Sider layout that uses React Router.
10
+ */
11
+ export declare const ReactRouterHeaderSiderLayout: React.FC<ReactRouterHeaderSiderLayoutProps>;
@@ -1,19 +1,19 @@
1
- /*
2
- * Copyright (c) 2024, J2 Innovations. All Rights Reserved
3
- */
4
- import React from 'react';
5
- import { Outlet, useNavigate } from 'react-router';
6
- import { HeaderSiderLayout } from './HeaderSiderLayout';
7
- import { useDefaultOnSelect, useGetPageKeyRouteMap, useSelectedRoutes, } from './ReactRouterLayout';
8
- /**
9
- * Header/Sider layout that uses React Router.
10
- */
11
- export const ReactRouterHeaderSiderLayout = ({ isSelectedRoute, pages = [], onSelect, ...otherProps }) => {
12
- const navigate = useNavigate();
13
- const selectedRoutes = useSelectedRoutes(pages, isSelectedRoute);
14
- const pageKeyRouteMap = useGetPageKeyRouteMap(pages);
15
- const defaultOnSelect = useDefaultOnSelect(navigate, pageKeyRouteMap, pages);
16
- return (React.createElement(HeaderSiderLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
17
- React.createElement(Outlet, null)));
18
- };
1
+ /*
2
+ * Copyright (c) 2024, J2 Innovations. All Rights Reserved
3
+ */
4
+ import React from 'react';
5
+ import { Outlet, useNavigate } from 'react-router';
6
+ import { HeaderSiderLayout } from './HeaderSiderLayout';
7
+ import { useDefaultOnSelect, useGetPageKeyRouteMap, useSelectedRoutes, } from './ReactRouterLayout';
8
+ /**
9
+ * Header/Sider layout that uses React Router.
10
+ */
11
+ export const ReactRouterHeaderSiderLayout = ({ isSelectedRoute, pages = [], onSelect, ...otherProps }) => {
12
+ const navigate = useNavigate();
13
+ const selectedRoutes = useSelectedRoutes(pages, isSelectedRoute);
14
+ const pageKeyRouteMap = useGetPageKeyRouteMap(pages);
15
+ const defaultOnSelect = useDefaultOnSelect(navigate, pageKeyRouteMap, pages);
16
+ return (React.createElement(HeaderSiderLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
17
+ React.createElement(Outlet, null)));
18
+ };
19
19
  //# sourceMappingURL=ReactRouterHeaderSiderLayout.js.map
@@ -1,46 +1,46 @@
1
- import type { Location } from '@remix-run/router';
2
- import React from 'react';
3
- import { NavigateFunction } from 'react-router';
4
- import { BasicLayoutProps } from './BasicLayout';
5
- import { MenuPage } from './MenuPage';
6
- export declare type ReactRouterMenuPage = MenuPage & {
7
- route: string;
8
- };
9
- export interface ReactRouterLayoutProps extends BasicLayoutProps<ReactRouterMenuPage> {
10
- isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
11
- }
12
- /**
13
- * This hook can be used with react-router/BasicLayout,
14
- * to ensure FIN5 URL is aligned with the internal frame URL.
15
- * This does not skip the hash update and should be used only with
16
- * FIN >= 5.1.7.92, otherwise FIN will reload the entire page.
17
- */
18
- export declare const useLocationUpdate: () => void;
19
- /**
20
- * This hook can be used with react-router/BasicLayout,
21
- * to ensure FIN5 URL is aligned with the internal frame URL.
22
- * This skips the hash update and should be used only with
23
- * FIN < 5.1.7.92.
24
- * @deprecated use only with FIN < 5.1.7.92
25
- * @see {@link useLocationUpdate} for FIN >= 5.1.7.92
26
- */
27
- export declare const useLocationUpdateSkippingHash: () => void;
28
- export declare const useSelectedRoutes: (pages: ReactRouterMenuPage[], isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean) => string[];
29
- /**
30
- * If we are inside a frame (FIN5), the route is left as is.
31
- * If we are outside FIN5 frame, the route needs to be prefixed with a segment containing the project name.
32
- * @param route
33
- * @returns the correct route for the environment
34
- */
35
- export declare const getRoute: (route: string) => string;
36
- /**
37
- * Create a map that holds the page key and its related route.
38
- * @param pages
39
- * @returns the map page key - route
40
- */
41
- export declare const useGetPageKeyRouteMap: (pages: ReactRouterMenuPage[]) => Map<string, string>;
42
- export declare const useDefaultOnSelect: (navigate: NavigateFunction, pageKeyRouteMap: Map<string, string>, pages: ReactRouterMenuPage[]) => (key: string) => void;
43
- /**
44
- * Basic layout that uses React Router.
45
- */
46
- export declare const ReactRouterLayout: React.FC<ReactRouterLayoutProps>;
1
+ import type { Location } from '@remix-run/router';
2
+ import React from 'react';
3
+ import { NavigateFunction } from 'react-router';
4
+ import { BasicLayoutProps } from './BasicLayout';
5
+ import { MenuPage } from './MenuPage';
6
+ export declare type ReactRouterMenuPage = MenuPage & {
7
+ route: string;
8
+ };
9
+ export interface ReactRouterLayoutProps extends BasicLayoutProps<ReactRouterMenuPage> {
10
+ isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
11
+ }
12
+ /**
13
+ * This hook can be used with react-router/BasicLayout,
14
+ * to ensure FIN5 URL is aligned with the internal frame URL.
15
+ * This does not skip the hash update and should be used only with
16
+ * FIN >= 5.1.7.92, otherwise FIN will reload the entire page.
17
+ */
18
+ export declare const useLocationUpdate: () => void;
19
+ /**
20
+ * This hook can be used with react-router/BasicLayout,
21
+ * to ensure FIN5 URL is aligned with the internal frame URL.
22
+ * This skips the hash update and should be used only with
23
+ * FIN < 5.1.7.92.
24
+ * @deprecated use only with FIN < 5.1.7.92
25
+ * @see {@link useLocationUpdate} for FIN >= 5.1.7.92
26
+ */
27
+ export declare const useLocationUpdateSkippingHash: () => void;
28
+ export declare const useSelectedRoutes: (pages: ReactRouterMenuPage[], isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean) => string[];
29
+ /**
30
+ * If we are inside a frame (FIN5), the route is left as is.
31
+ * If we are outside FIN5 frame, the route needs to be prefixed with a segment containing the project name.
32
+ * @param route
33
+ * @returns the correct route for the environment
34
+ */
35
+ export declare const getRoute: (route: string) => string;
36
+ /**
37
+ * Create a map that holds the page key and its related route.
38
+ * @param pages
39
+ * @returns the map page key - route
40
+ */
41
+ export declare const useGetPageKeyRouteMap: (pages: ReactRouterMenuPage[]) => Map<string, string>;
42
+ export declare const useDefaultOnSelect: (navigate: NavigateFunction, pageKeyRouteMap: Map<string, string>, pages: ReactRouterMenuPage[]) => (key: string) => void;
43
+ /**
44
+ * Basic layout that uses React Router.
45
+ */
46
+ export declare const ReactRouterLayout: React.FC<ReactRouterLayoutProps>;
@@ -1,100 +1,100 @@
1
- /*
2
- * Copyright (c) 2023, J2 Innovations. All Rights Reserved
3
- */
4
- import React, { useCallback, useEffect, useMemo } from 'react';
5
- import { Outlet, useLocation, useNavigate, } from 'react-router';
6
- import { IN_IFRAME, fin5SkipHashUpdate, getFin5HashFrameParameters, getTopLocation, } from '../../../fin5Top/useFin5AppURLHashParameter';
7
- import { BasicLayout } from './BasicLayout';
8
- import { pageTreeToPageList } from './MenuPage';
9
- /**
10
- * This hook can be used with react-router/BasicLayout,
11
- * to ensure FIN5 URL is aligned with the internal frame URL.
12
- * This does not skip the hash update and should be used only with
13
- * FIN >= 5.1.7.92, otherwise FIN will reload the entire page.
14
- */
15
- export const useLocationUpdate = () => {
16
- const location = useLocation();
17
- useEffect(() => {
18
- if (IN_IFRAME) {
19
- setHash(location);
20
- }
21
- }, [location]);
22
- };
23
- /**
24
- * This hook can be used with react-router/BasicLayout,
25
- * to ensure FIN5 URL is aligned with the internal frame URL.
26
- * This skips the hash update and should be used only with
27
- * FIN < 5.1.7.92.
28
- * @deprecated use only with FIN < 5.1.7.92
29
- * @see {@link useLocationUpdate} for FIN >= 5.1.7.92
30
- */
31
- export const useLocationUpdateSkippingHash = () => {
32
- const location = useLocation();
33
- useEffect(() => {
34
- if (IN_IFRAME) {
35
- fin5SkipHashUpdate()?.then(() => {
36
- setHash(location);
37
- });
38
- }
39
- }, [location]);
40
- };
41
- const setHash = (location) => {
42
- const hash = location.pathname;
43
- const queryParams = location.search;
44
- const frameParameters = getFin5HashFrameParameters();
45
- frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash + queryParams);
46
- getTopLocation().hash = `#${getTopLocation().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
47
- };
48
- export const useSelectedRoutes = (pages, isSelectedRoute = (page, location) => location.pathname.includes(page.route)) => {
49
- const location = useLocation();
50
- const flatPages = useMemo(() => pageTreeToPageList(pages), [pages]);
51
- return useMemo(() => {
52
- return flatPages
53
- .filter((page) => isSelectedRoute(page, location))
54
- .map((page) => page.key);
55
- }, [location, flatPages, isSelectedRoute]);
56
- };
57
- /**
58
- * If we are inside a frame (FIN5), the route is left as is.
59
- * If we are outside FIN5 frame, the route needs to be prefixed with a segment containing the project name.
60
- * @param route
61
- * @returns the correct route for the environment
62
- */
63
- export const getRoute = (route) => {
64
- const prefixedRoute = route.startsWith('/') ? route : `/${route}`;
65
- return !IN_IFRAME ? `/proj/:projectName${prefixedRoute}` : prefixedRoute;
66
- };
67
- /**
68
- * Create a map that holds the page key and its related route.
69
- * @param pages
70
- * @returns the map page key - route
71
- */
72
- export const useGetPageKeyRouteMap = (pages) => useMemo(() => {
73
- const flatPages = pageTreeToPageList(pages);
74
- const result = new Map();
75
- flatPages.forEach((page) => {
76
- result.set(page.key, page.route);
77
- });
78
- return result;
79
- }, [pages]);
80
- export const useDefaultOnSelect = (navigate, pageKeyRouteMap, pages) => useCallback((key) => {
81
- const route = pageKeyRouteMap.get(key);
82
- if (route) {
83
- navigate(route);
84
- }
85
- else {
86
- console.warn('Could not find route for page key', key, 'pages', pages);
87
- }
88
- }, [navigate, pageKeyRouteMap]);
89
- /**
90
- * Basic layout that uses React Router.
91
- */
92
- export const ReactRouterLayout = ({ isSelectedRoute, pages = [], onSelect, ...otherProps }) => {
93
- const navigate = useNavigate();
94
- const selectedRoutes = useSelectedRoutes(pages, isSelectedRoute);
95
- const pageKeyRouteMap = useGetPageKeyRouteMap(pages);
96
- const defaultOnSelect = useDefaultOnSelect(navigate, pageKeyRouteMap, pages);
97
- return (React.createElement(BasicLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
98
- React.createElement(Outlet, null)));
99
- };
1
+ /*
2
+ * Copyright (c) 2023, J2 Innovations. All Rights Reserved
3
+ */
4
+ import React, { useCallback, useEffect, useMemo } from 'react';
5
+ import { Outlet, useLocation, useNavigate, } from 'react-router';
6
+ import { IN_IFRAME, fin5SkipHashUpdate, getFin5HashFrameParameters, getTopLocation, } from '../../../fin5Top/useFin5AppURLHashParameter';
7
+ import { BasicLayout } from './BasicLayout';
8
+ import { pageTreeToPageList } from './MenuPage';
9
+ /**
10
+ * This hook can be used with react-router/BasicLayout,
11
+ * to ensure FIN5 URL is aligned with the internal frame URL.
12
+ * This does not skip the hash update and should be used only with
13
+ * FIN >= 5.1.7.92, otherwise FIN will reload the entire page.
14
+ */
15
+ export const useLocationUpdate = () => {
16
+ const location = useLocation();
17
+ useEffect(() => {
18
+ if (IN_IFRAME) {
19
+ setHash(location);
20
+ }
21
+ }, [location]);
22
+ };
23
+ /**
24
+ * This hook can be used with react-router/BasicLayout,
25
+ * to ensure FIN5 URL is aligned with the internal frame URL.
26
+ * This skips the hash update and should be used only with
27
+ * FIN < 5.1.7.92.
28
+ * @deprecated use only with FIN < 5.1.7.92
29
+ * @see {@link useLocationUpdate} for FIN >= 5.1.7.92
30
+ */
31
+ export const useLocationUpdateSkippingHash = () => {
32
+ const location = useLocation();
33
+ useEffect(() => {
34
+ if (IN_IFRAME) {
35
+ fin5SkipHashUpdate()?.then(() => {
36
+ setHash(location);
37
+ });
38
+ }
39
+ }, [location]);
40
+ };
41
+ const setHash = (location) => {
42
+ const hash = location.pathname;
43
+ const queryParams = location.search;
44
+ const frameParameters = getFin5HashFrameParameters();
45
+ frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash + queryParams);
46
+ getTopLocation().hash = `#${getTopLocation().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
47
+ };
48
+ export const useSelectedRoutes = (pages, isSelectedRoute = (page, location) => location.pathname.includes(page.route)) => {
49
+ const location = useLocation();
50
+ const flatPages = useMemo(() => pageTreeToPageList(pages), [pages]);
51
+ return useMemo(() => {
52
+ return flatPages
53
+ .filter((page) => isSelectedRoute(page, location))
54
+ .map((page) => page.key);
55
+ }, [location, flatPages, isSelectedRoute]);
56
+ };
57
+ /**
58
+ * If we are inside a frame (FIN5), the route is left as is.
59
+ * If we are outside FIN5 frame, the route needs to be prefixed with a segment containing the project name.
60
+ * @param route
61
+ * @returns the correct route for the environment
62
+ */
63
+ export const getRoute = (route) => {
64
+ const prefixedRoute = route.startsWith('/') ? route : `/${route}`;
65
+ return !IN_IFRAME ? `/proj/:projectName${prefixedRoute}` : prefixedRoute;
66
+ };
67
+ /**
68
+ * Create a map that holds the page key and its related route.
69
+ * @param pages
70
+ * @returns the map page key - route
71
+ */
72
+ export const useGetPageKeyRouteMap = (pages) => useMemo(() => {
73
+ const flatPages = pageTreeToPageList(pages);
74
+ const result = new Map();
75
+ flatPages.forEach((page) => {
76
+ result.set(page.key, page.route);
77
+ });
78
+ return result;
79
+ }, [pages]);
80
+ export const useDefaultOnSelect = (navigate, pageKeyRouteMap, pages) => useCallback((key) => {
81
+ const route = pageKeyRouteMap.get(key);
82
+ if (route) {
83
+ navigate(route);
84
+ }
85
+ else {
86
+ console.warn('Could not find route for page key', key, 'pages', pages);
87
+ }
88
+ }, [navigate, pageKeyRouteMap]);
89
+ /**
90
+ * Basic layout that uses React Router.
91
+ */
92
+ export const ReactRouterLayout = ({ isSelectedRoute, pages = [], onSelect, ...otherProps }) => {
93
+ const navigate = useNavigate();
94
+ const selectedRoutes = useSelectedRoutes(pages, isSelectedRoute);
95
+ const pageKeyRouteMap = useGetPageKeyRouteMap(pages);
96
+ const defaultOnSelect = useDefaultOnSelect(navigate, pageKeyRouteMap, pages);
97
+ return (React.createElement(BasicLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
98
+ React.createElement(Outlet, null)));
99
+ };
100
100
  //# sourceMappingURL=ReactRouterLayout.js.map
@@ -1,12 +1,12 @@
1
- import { PropsWithChildren, ReactElement } from 'react';
2
- import { MenuPage } from '../MenuPage';
3
- export interface RouterProps<T extends MenuPage> {
4
- pages?: T[];
5
- currentPage: string;
6
- onPageChange?: (selectedPage?: T) => void;
7
- fallbackComponent?: ReactElement;
8
- }
9
- /**
10
- * Renders the currently selected page from a tree of pages
11
- */
12
- export declare function Router<T extends MenuPage>({ pages, currentPage, onPageChange, fallbackComponent, }: PropsWithChildren<RouterProps<T>>): JSX.Element;
1
+ import { PropsWithChildren, ReactElement } from 'react';
2
+ import { MenuPage } from '../MenuPage';
3
+ export interface RouterProps<T extends MenuPage> {
4
+ pages?: T[];
5
+ currentPage: string;
6
+ onPageChange?: (selectedPage?: T) => void;
7
+ fallbackComponent?: ReactElement;
8
+ }
9
+ /**
10
+ * Renders the currently selected page from a tree of pages
11
+ */
12
+ export declare function Router<T extends MenuPage>({ pages, currentPage, onPageChange, fallbackComponent, }: PropsWithChildren<RouterProps<T>>): JSX.Element;
@@ -1,19 +1,19 @@
1
- /*
2
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
- */
4
- import React, { Suspense, useEffect, useMemo, } from 'react';
5
- import { LoadingSpinner } from '../../LoadingSpinner';
6
- import { findPageByName } from '../MenuPage';
7
- /**
8
- * Renders the currently selected page from a tree of pages
9
- */
10
- export function Router({ pages = [], currentPage, onPageChange, fallbackComponent, }) {
11
- const page = useMemo(() => findPageByName(pages, currentPage), [pages, currentPage]);
12
- useEffect(() => {
13
- onPageChange?.(page);
14
- }, [page]);
15
- return page?.component ? (React.createElement(Suspense, { fallback: React.createElement(LoadingSpinner, null) }, React.createElement(page.component, page?.props))) : (fallbackComponent ?? React.createElement("div", null,
16
- currentPage,
17
- " page not found"));
18
- }
1
+ /*
2
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
+ */
4
+ import React, { Suspense, useEffect, useMemo, } from 'react';
5
+ import { LoadingSpinner } from '../../LoadingSpinner';
6
+ import { findPageByName } from '../MenuPage';
7
+ /**
8
+ * Renders the currently selected page from a tree of pages
9
+ */
10
+ export function Router({ pages = [], currentPage, onPageChange, fallbackComponent, }) {
11
+ const page = useMemo(() => findPageByName(pages, currentPage), [pages, currentPage]);
12
+ useEffect(() => {
13
+ onPageChange?.(page);
14
+ }, [page]);
15
+ return page?.component ? (React.createElement(Suspense, { fallback: React.createElement(LoadingSpinner, null) }, React.createElement(page.component, page?.props))) : (fallbackComponent ?? React.createElement("div", null,
16
+ currentPage,
17
+ " page not found"));
18
+ }
19
19
  //# sourceMappingURL=Router.js.map
@@ -1,11 +1,11 @@
1
- import React from 'react';
2
- import { BasicLayoutProps } from '../BasicLayout';
3
- import { MenuPage } from '../MenuPage';
4
- export interface RouterLayoutProps extends BasicLayoutProps<MenuPage> {
5
- page?: string;
6
- onPageChange?: (page: string) => void;
7
- }
8
- /**
9
- * Basic layout that uses a custom router.
10
- */
11
- export declare const RouterLayout: React.FC<RouterLayoutProps>;
1
+ import React from 'react';
2
+ import { BasicLayoutProps } from '../BasicLayout';
3
+ import { MenuPage } from '../MenuPage';
4
+ export interface RouterLayoutProps extends BasicLayoutProps<MenuPage> {
5
+ page?: string;
6
+ onPageChange?: (page: string) => void;
7
+ }
8
+ /**
9
+ * Basic layout that uses a custom router.
10
+ */
11
+ export declare const RouterLayout: React.FC<RouterLayoutProps>;
@@ -1,35 +1,35 @@
1
- /*
2
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
- */
4
- import { Button } from '@j2inn/ui';
5
- import React, { useCallback, useEffect, useState } from 'react';
6
- import { ErrorDisplayer } from '../../ErrorDisplayer';
7
- import { BasicLayout } from '../BasicLayout';
8
- import { findPageByName } from '../MenuPage';
9
- import { Router } from './Router';
10
- /**
11
- * Basic layout that uses a custom router.
12
- */
13
- export const RouterLayout = ({ pages = [], defaultPage = pages?.[0].key ?? '', onPageChange, page, ...otherProps }) => {
14
- const [currentPage, setCurrentPage] = useState(page ?? defaultPage);
15
- useEffect(() => {
16
- if (page) {
17
- setCurrentPage(page);
18
- }
19
- }, [page]);
20
- // Fire onChange
21
- useEffect(() => {
22
- onPageChange?.(currentPage);
23
- }, [currentPage]);
24
- const onSelect = useCallback((key) => {
25
- const page = findPageByName(pages, key);
26
- if (page?.component) {
27
- setCurrentPage(key);
28
- }
29
- }, [pages]);
30
- return (React.createElement(BasicLayout, { ...otherProps, pages: pages, defaultPage: defaultPage, onSelect: onSelect, selectedPages: [currentPage] },
31
- React.createElement(Router, { pages: pages, currentPage: currentPage, fallbackComponent: React.createElement(ErrorDisplayer, { error: new Error('Page Not Found'), extra: [
32
- React.createElement(Button, { type: 'primary', key: 'refresh', onClick: () => setCurrentPage(defaultPage) }, "Go Home"),
33
- ] }) })));
34
- };
1
+ /*
2
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
+ */
4
+ import { Button } from '@j2inn/ui';
5
+ import React, { useCallback, useEffect, useState } from 'react';
6
+ import { ErrorDisplayer } from '../../ErrorDisplayer';
7
+ import { BasicLayout } from '../BasicLayout';
8
+ import { findPageByName } from '../MenuPage';
9
+ import { Router } from './Router';
10
+ /**
11
+ * Basic layout that uses a custom router.
12
+ */
13
+ export const RouterLayout = ({ pages = [], defaultPage = pages?.[0].key ?? '', onPageChange, page, ...otherProps }) => {
14
+ const [currentPage, setCurrentPage] = useState(page ?? defaultPage);
15
+ useEffect(() => {
16
+ if (page) {
17
+ setCurrentPage(page);
18
+ }
19
+ }, [page]);
20
+ // Fire onChange
21
+ useEffect(() => {
22
+ onPageChange?.(currentPage);
23
+ }, [currentPage]);
24
+ const onSelect = useCallback((key) => {
25
+ const page = findPageByName(pages, key);
26
+ if (page?.component) {
27
+ setCurrentPage(key);
28
+ }
29
+ }, [pages]);
30
+ return (React.createElement(BasicLayout, { ...otherProps, pages: pages, defaultPage: defaultPage, onSelect: onSelect, selectedPages: [currentPage] },
31
+ React.createElement(Router, { pages: pages, currentPage: currentPage, fallbackComponent: React.createElement(ErrorDisplayer, { error: new Error('Page Not Found'), extra: [
32
+ React.createElement(Button, { type: 'primary', key: 'refresh', onClick: () => setCurrentPage(defaultPage) }, "Go Home"),
33
+ ] }) })));
34
+ };
35
35
  //# sourceMappingURL=RouterLayout.js.map
@@ -1,27 +1,27 @@
1
- /// <reference types="react" />
2
- import { ParametersOfSection, UiElementData } from '@j2inn/resolvable-ui-elements';
3
- import { HDict } from 'haystack-core';
4
- declare type Layout = 'horizontal' | 'vertical';
5
- interface ConfigurationFormProps<T extends UiElementData> {
6
- section: T;
7
- params: ParametersOfSection<T>;
8
- readOnlySection?: UiElementData;
9
- onSave: (config: HDict) => void | Promise<unknown>;
10
- saveText?: string;
11
- formatKey?: (key: string) => string;
12
- options?: HDict;
13
- layout?: Layout;
14
- className?: string;
15
- entryClassName?: string;
16
- saveBtnClassName?: string;
17
- animateSaveButton?: boolean;
18
- }
19
- export declare const ConfigurationForm: <T extends UiElementData<import("@j2inn/resolvable-ui-elements/dist/resolvableElements/elements/UiElement").UiElementMeta>>({ section, params, readOnlySection, onSave, formatKey, saveText, options, layout, className, entryClassName, saveBtnClassName, animateSaveButton, }: ConfigurationFormProps<T>) => JSX.Element;
20
- interface ConfigurationFormReadOnlyEntriesProps<T extends UiElementData> {
21
- params: ParametersOfSection<T>;
22
- readOnlySection: T;
23
- formatKey?: (key: string) => string;
24
- className?: string;
25
- }
26
- export declare const ConfigurationFormReadOnlyEntries: <T extends UiElementData<import("@j2inn/resolvable-ui-elements/dist/resolvableElements/elements/UiElement").UiElementMeta>>({ readOnlySection, params, formatKey, className, }: ConfigurationFormReadOnlyEntriesProps<T>) => JSX.Element;
27
- export {};
1
+ /// <reference types="react" />
2
+ import { ParametersOfSection, UiElementData } from '@j2inn/resolvable-ui-elements';
3
+ import { HDict } from 'haystack-core';
4
+ declare type Layout = 'horizontal' | 'vertical';
5
+ interface ConfigurationFormProps<T extends UiElementData> {
6
+ section: T;
7
+ params: ParametersOfSection<T>;
8
+ readOnlySection?: UiElementData;
9
+ onSave: (config: HDict) => void | Promise<unknown>;
10
+ saveText?: string;
11
+ formatKey?: (key: string) => string;
12
+ options?: HDict;
13
+ layout?: Layout;
14
+ className?: string;
15
+ entryClassName?: string;
16
+ saveBtnClassName?: string;
17
+ animateSaveButton?: boolean;
18
+ }
19
+ export declare const ConfigurationForm: <T extends UiElementData<import("@j2inn/resolvable-ui-elements/dist/resolvableElements/elements/UiElement").UiElementMeta>>({ section, params, readOnlySection, onSave, formatKey, saveText, options, layout, className, entryClassName, saveBtnClassName, animateSaveButton, }: ConfigurationFormProps<T>) => JSX.Element;
20
+ interface ConfigurationFormReadOnlyEntriesProps<T extends UiElementData> {
21
+ params: ParametersOfSection<T>;
22
+ readOnlySection: T;
23
+ formatKey?: (key: string) => string;
24
+ className?: string;
25
+ }
26
+ export declare const ConfigurationFormReadOnlyEntries: <T extends UiElementData<import("@j2inn/resolvable-ui-elements/dist/resolvableElements/elements/UiElement").UiElementMeta>>({ readOnlySection, params, formatKey, className, }: ConfigurationFormReadOnlyEntriesProps<T>) => JSX.Element;
27
+ export {};