@j2inn/fin5-ui-utils 5.2.2-beta.9 → 6.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 (231) 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 +16 -16
  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 +61 -61
  14. package/dist/fin5Top/fin5FileUpload.d.ts +24 -24
  15. package/dist/fin5Top/fin5FileUpload.js +51 -51
  16. package/dist/fin5Top/fin5Top.d.ts +124 -124
  17. package/dist/fin5Top/fin5Top.js +58 -58
  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 +31 -36
  29. package/dist/index.js +65 -70
  30. package/dist/index.js.map +1 -1
  31. package/dist/jobs/jobUtils.d.ts +14 -14
  32. package/dist/jobs/jobUtils.js +15 -15
  33. package/dist/react/app/Fin5AppContainer.d.ts +36 -36
  34. package/dist/react/app/Fin5AppContainer.js +102 -102
  35. package/dist/react/app/Fin5AppRootStore.d.ts +38 -39
  36. package/dist/react/app/Fin5AppRootStore.js +68 -69
  37. package/dist/react/app/Fin5AppRootStore.js.map +1 -1
  38. package/dist/react/components/ErrorBoundary.d.ts +57 -57
  39. package/dist/react/components/ErrorBoundary.js +150 -150
  40. package/dist/react/components/ErrorDisplayer.d.ts +19 -19
  41. package/dist/react/components/ErrorDisplayer.js +36 -36
  42. package/dist/react/components/Loader.d.ts +9 -9
  43. package/dist/react/components/Loader.js +17 -17
  44. package/dist/react/components/LoadingSpinner.d.ts +2 -2
  45. package/dist/react/components/LoadingSpinner.js +27 -27
  46. package/dist/react/components/RecordImage.d.ts +20 -20
  47. package/dist/react/components/RecordImage.js +51 -51
  48. package/dist/react/components/charts/QRCode.d.ts +25 -25
  49. package/dist/react/components/charts/QRCode.js +81 -82
  50. package/dist/react/components/charts/QRCode.js.map +1 -1
  51. package/dist/react/components/charts/pie/PieChart.d.ts +93 -94
  52. package/dist/react/components/charts/pie/PieChart.js +202 -204
  53. package/dist/react/components/charts/pie/PieChart.js.map +1 -1
  54. package/dist/react/components/charts/pie/SimplePieChart.d.ts +20 -21
  55. package/dist/react/components/charts/pie/SimplePieChart.js +55 -55
  56. package/dist/react/components/charts/pie/SimplePieChart.js.map +1 -1
  57. package/dist/react/components/graphics/GraphicViewer.d.ts +10 -10
  58. package/dist/react/components/graphics/GraphicViewer.js +29 -29
  59. package/dist/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  60. package/dist/react/components/graphics/GraphicsTabViewer.js +90 -90
  61. package/dist/react/components/navigation/BasicLayout.d.ts +41 -41
  62. package/dist/react/components/navigation/BasicLayout.js +155 -155
  63. package/dist/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  64. package/dist/react/components/navigation/HeaderSiderLayout.js +110 -110
  65. package/dist/react/components/navigation/MenuPage.d.ts +37 -37
  66. package/dist/react/components/navigation/MenuPage.js +36 -36
  67. package/dist/react/components/navigation/MenuTrigger.d.ts +9 -9
  68. package/dist/react/components/navigation/MenuTrigger.js +33 -33
  69. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  70. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.js +25 -25
  71. package/dist/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  72. package/dist/react/components/navigation/ReactRouterLayout.js +132 -132
  73. package/dist/react/components/navigation/customRouting/Router.d.ts +12 -12
  74. package/dist/react/components/navigation/customRouting/Router.js +45 -45
  75. package/dist/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  76. package/dist/react/components/navigation/customRouting/RouterLayout.js +61 -61
  77. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  78. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.js +95 -95
  79. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  80. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +88 -88
  81. package/dist/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  82. package/dist/react/components/resolvable/configurationForm/getSectionDefault.js +99 -99
  83. package/dist/react/hooks/useFin5BinUrl.d.ts +6 -6
  84. package/dist/react/hooks/useFin5BinUrl.js +15 -15
  85. package/dist/react/hooks/useFin5ColorScheme.d.ts +2 -2
  86. package/dist/react/hooks/useFin5ColorScheme.js +42 -42
  87. package/dist_es/fantomProps/createFin5Props/index.d.ts +12 -12
  88. package/dist_es/fantomProps/createFin5Props/index.js +140 -140
  89. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.d.ts +2 -2
  90. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.js +11 -11
  91. package/dist_es/fantomProps/fantomPropsToObject.d.ts +8 -8
  92. package/dist_es/fantomProps/fantomPropsToObject.js +178 -178
  93. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.d.ts +4 -4
  94. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.js +12 -12
  95. package/dist_es/fantomProps/localePropsToJson.d.ts +1 -1
  96. package/dist_es/fantomProps/localePropsToJson.js +21 -21
  97. package/dist_es/fantomProps/readFantomPropsFile.d.ts +5 -5
  98. package/dist_es/fantomProps/readFantomPropsFile.js +35 -35
  99. package/dist_es/fin5Top/fin5FileUpload.d.ts +24 -24
  100. package/dist_es/fin5Top/fin5FileUpload.js +47 -47
  101. package/dist_es/fin5Top/fin5Top.d.ts +124 -124
  102. package/dist_es/fin5Top/fin5Top.js +54 -54
  103. package/dist_es/fin5Top/finEdge2Cloud.d.ts +6 -6
  104. package/dist_es/fin5Top/finEdge2Cloud.js +11 -11
  105. package/dist_es/fin5Top/getFin5BinUrl.d.ts +2 -2
  106. package/dist_es/fin5Top/getFin5BinUrl.js +5 -5
  107. package/dist_es/fin5Top/openFin5Alarm.d.ts +22 -22
  108. package/dist_es/fin5Top/openFin5Alarm.js +19 -19
  109. package/dist_es/fin5Top/openFin5Historian.d.ts +3 -3
  110. package/dist_es/fin5Top/openFin5Historian.js +15 -15
  111. package/dist_es/fin5Top/useFin5AppURLHashParameter.d.ts +18 -18
  112. package/dist_es/fin5Top/useFin5AppURLHashParameter.js +124 -124
  113. package/dist_es/index.d.ts +31 -36
  114. package/dist_es/index.js +49 -54
  115. package/dist_es/index.js.map +1 -1
  116. package/dist_es/jobs/jobUtils.d.ts +14 -14
  117. package/dist_es/jobs/jobUtils.js +9 -9
  118. package/dist_es/react/app/Fin5AppContainer.d.ts +36 -36
  119. package/dist_es/react/app/Fin5AppContainer.js +73 -73
  120. package/dist_es/react/app/Fin5AppRootStore.d.ts +38 -39
  121. package/dist_es/react/app/Fin5AppRootStore.js +64 -65
  122. package/dist_es/react/app/Fin5AppRootStore.js.map +1 -1
  123. package/dist_es/react/components/ErrorBoundary.d.ts +57 -57
  124. package/dist_es/react/components/ErrorBoundary.js +123 -123
  125. package/dist_es/react/components/ErrorDisplayer.d.ts +19 -19
  126. package/dist_es/react/components/ErrorDisplayer.js +28 -28
  127. package/dist_es/react/components/Loader.d.ts +9 -9
  128. package/dist_es/react/components/Loader.js +12 -12
  129. package/dist_es/react/components/LoadingSpinner.d.ts +2 -2
  130. package/dist_es/react/components/LoadingSpinner.js +20 -20
  131. package/dist_es/react/components/RecordImage.d.ts +20 -20
  132. package/dist_es/react/components/RecordImage.js +24 -24
  133. package/dist_es/react/components/charts/QRCode.d.ts +25 -25
  134. package/dist_es/react/components/charts/QRCode.js +53 -52
  135. package/dist_es/react/components/charts/QRCode.js.map +1 -1
  136. package/dist_es/react/components/charts/pie/PieChart.d.ts +93 -94
  137. package/dist_es/react/components/charts/pie/PieChart.js +175 -177
  138. package/dist_es/react/components/charts/pie/PieChart.js.map +1 -1
  139. package/dist_es/react/components/charts/pie/SimplePieChart.d.ts +20 -21
  140. package/dist_es/react/components/charts/pie/SimplePieChart.js +25 -25
  141. package/dist_es/react/components/charts/pie/SimplePieChart.js.map +1 -1
  142. package/dist_es/react/components/graphics/GraphicViewer.d.ts +10 -10
  143. package/dist_es/react/components/graphics/GraphicViewer.js +22 -22
  144. package/dist_es/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  145. package/dist_es/react/components/graphics/GraphicsTabViewer.js +60 -60
  146. package/dist_es/react/components/navigation/BasicLayout.d.ts +41 -41
  147. package/dist_es/react/components/navigation/BasicLayout.js +124 -124
  148. package/dist_es/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  149. package/dist_es/react/components/navigation/HeaderSiderLayout.js +80 -80
  150. package/dist_es/react/components/navigation/MenuPage.d.ts +37 -37
  151. package/dist_es/react/components/navigation/MenuPage.js +30 -30
  152. package/dist_es/react/components/navigation/MenuTrigger.d.ts +9 -9
  153. package/dist_es/react/components/navigation/MenuTrigger.js +28 -28
  154. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  155. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.js +18 -18
  156. package/dist_es/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  157. package/dist_es/react/components/navigation/ReactRouterLayout.js +99 -99
  158. package/dist_es/react/components/navigation/customRouting/Router.d.ts +12 -12
  159. package/dist_es/react/components/navigation/customRouting/Router.js +18 -18
  160. package/dist_es/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  161. package/dist_es/react/components/navigation/customRouting/RouterLayout.js +34 -34
  162. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  163. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.js +64 -64
  164. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  165. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +58 -58
  166. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  167. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.js +94 -94
  168. package/dist_es/react/hooks/useFin5BinUrl.d.ts +6 -6
  169. package/dist_es/react/hooks/useFin5BinUrl.js +11 -11
  170. package/dist_es/react/hooks/useFin5ColorScheme.d.ts +2 -2
  171. package/dist_es/react/hooks/useFin5ColorScheme.js +38 -38
  172. package/package.json +8 -11
  173. package/dist/react/components/charts/line-bar/Chart.d.ts +0 -166
  174. package/dist/react/components/charts/line-bar/Chart.js +0 -443
  175. package/dist/react/components/charts/line-bar/Chart.js.map +0 -1
  176. package/dist/react/components/charts/line-bar/HGridChart.d.ts +0 -58
  177. package/dist/react/components/charts/line-bar/HGridChart.js +0 -289
  178. package/dist/react/components/charts/line-bar/HGridChart.js.map +0 -1
  179. package/dist/react/components/charts/line-bar/ZincGridChart.d.ts +0 -12
  180. package/dist/react/components/charts/line-bar/ZincGridChart.js +0 -24
  181. package/dist/react/components/charts/line-bar/ZincGridChart.js.map +0 -1
  182. package/dist/react/components/makeCustomElement.d.ts +0 -12
  183. package/dist/react/components/makeCustomElement.js +0 -140
  184. package/dist/react/components/makeCustomElement.js.map +0 -1
  185. package/dist/react/hooks/useScreenSize.d.ts +0 -8
  186. package/dist/react/hooks/useScreenSize.js +0 -31
  187. package/dist/react/hooks/useScreenSize.js.map +0 -1
  188. package/dist_es/react/app/Fin5AppContainer.jsx +0 -82
  189. package/dist_es/react/app/Fin5AppContainer.jsx.map +0 -1
  190. package/dist_es/react/components/ErrorBoundary.jsx +0 -150
  191. package/dist_es/react/components/ErrorBoundary.jsx.map +0 -1
  192. package/dist_es/react/components/ErrorDisplayer.jsx +0 -36
  193. package/dist_es/react/components/ErrorDisplayer.jsx.map +0 -1
  194. package/dist_es/react/components/Loader.jsx +0 -13
  195. package/dist_es/react/components/Loader.jsx.map +0 -1
  196. package/dist_es/react/components/LoadingSpinner.jsx +0 -22
  197. package/dist_es/react/components/LoadingSpinner.jsx.map +0 -1
  198. package/dist_es/react/components/charts/line-bar/Chart.d.ts +0 -166
  199. package/dist_es/react/components/charts/line-bar/Chart.js +0 -416
  200. package/dist_es/react/components/charts/line-bar/Chart.js.map +0 -1
  201. package/dist_es/react/components/charts/line-bar/HGridChart.d.ts +0 -58
  202. package/dist_es/react/components/charts/line-bar/HGridChart.js +0 -251
  203. package/dist_es/react/components/charts/line-bar/HGridChart.js.map +0 -1
  204. package/dist_es/react/components/charts/line-bar/ZincGridChart.d.ts +0 -12
  205. package/dist_es/react/components/charts/line-bar/ZincGridChart.js +0 -17
  206. package/dist_es/react/components/charts/line-bar/ZincGridChart.js.map +0 -1
  207. package/dist_es/react/components/graphics/GraphicViewer.jsx +0 -23
  208. package/dist_es/react/components/graphics/GraphicViewer.jsx.map +0 -1
  209. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx +0 -63
  210. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx.map +0 -1
  211. package/dist_es/react/components/makeCustomElement.d.ts +0 -12
  212. package/dist_es/react/components/makeCustomElement.js +0 -132
  213. package/dist_es/react/components/makeCustomElement.js.map +0 -1
  214. package/dist_es/react/components/navigation/BasicLayout.jsx +0 -133
  215. package/dist_es/react/components/navigation/BasicLayout.jsx.map +0 -1
  216. package/dist_es/react/components/navigation/MenuPage.jsx +0 -31
  217. package/dist_es/react/components/navigation/MenuPage.jsx.map +0 -1
  218. package/dist_es/react/components/navigation/Router.d.ts +0 -12
  219. package/dist_es/react/components/navigation/Router.js +0 -19
  220. package/dist_es/react/components/navigation/Router.js.map +0 -1
  221. package/dist_es/react/components/navigation/Router.jsx +0 -19
  222. package/dist_es/react/components/navigation/Router.jsx.map +0 -1
  223. package/dist_es/react/components/navigation/react-router/BasicLayout.d.ts +0 -23
  224. package/dist_es/react/components/navigation/react-router/BasicLayout.js +0 -82
  225. package/dist_es/react/components/navigation/react-router/BasicLayout.js.map +0 -1
  226. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.d.ts +0 -24
  227. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js +0 -82
  228. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js.map +0 -1
  229. package/dist_es/react/hooks/useScreenSize.d.ts +0 -8
  230. package/dist_es/react/hooks/useScreenSize.js +0 -29
  231. package/dist_es/react/hooks/useScreenSize.js.map +0 -1
@@ -1,18 +1,18 @@
1
- export declare const IN_IFRAME: boolean;
2
- export declare const getTopLocation: () => Location;
3
- export declare const getFin5HashFrameParameters: () => URLSearchParams;
4
- export declare const fin5SkipHashUpdate: () => Promise<undefined> | undefined;
5
- export declare const getHashParameters: () => URLSearchParams;
6
- /**
7
- * Use a parameter in the hash of a custom app running in FIN 5 as state.
8
- * @param name parameter name.
9
- * @param initialState initial state used if the parameter is not defined.
10
- * @returns the parameter value and a function to update it.
11
- */
12
- export declare const useFin5AppURLHashParameter: (name: string, initialState?: string) => [string | undefined, (newValue: string) => Promise<void>];
13
- /**
14
- * Use all the parameters in the hash of a custom app running in FIN 5 as state.
15
- * @param parameters the initial (optional) values for the parameters
16
- * @returns the URL parameters and a function to patch the parameters.
17
- */
18
- export declare const useFin5AppURLHashParameters: (parameters?: URLSearchParams) => [URLSearchParams, (newValues: URLSearchParams) => Promise<void>];
1
+ export declare const IN_IFRAME: boolean;
2
+ export declare const getTopLocation: () => Location;
3
+ export declare const getFin5HashFrameParameters: () => URLSearchParams;
4
+ export declare const fin5SkipHashUpdate: () => Promise<undefined> | undefined;
5
+ export declare const getHashParameters: () => URLSearchParams;
6
+ /**
7
+ * Use a parameter in the hash of a custom app running in FIN 5 as state.
8
+ * @param name parameter name.
9
+ * @param initialState initial state used if the parameter is not defined.
10
+ * @returns the parameter value and a function to update it.
11
+ */
12
+ export declare const useFin5AppURLHashParameter: (name: string, initialState?: string) => [string | undefined, (newValue: string) => Promise<void>];
13
+ /**
14
+ * Use all the parameters in the hash of a custom app running in FIN 5 as state.
15
+ * @param parameters the initial (optional) values for the parameters
16
+ * @returns the URL parameters and a function to patch the parameters.
17
+ */
18
+ export declare const useFin5AppURLHashParameters: (parameters?: URLSearchParams) => [URLSearchParams, (newValues: URLSearchParams) => Promise<void>];
@@ -1,125 +1,125 @@
1
- /*
2
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
- */
4
- import { useEffect, useState } from 'react';
5
- import { isWindowTopFin5 } from './fin5Top';
6
- export const IN_IFRAME = window !== top && isWindowTopFin5();
7
- const getTop = () => window.top ?? window;
8
- const getApp = () => getTop()?.app;
9
- export const getTopLocation = () => getTop().location;
10
- export const getFin5HashFrameParameters = () => new URLSearchParams(getTopLocation().hash.slice(1).split('?')[1]);
11
- const getFin5FrameURL = () => getFin5HashFrameParameters().get('url');
12
- const getPartialURLHashFragment = (url) => `#${url?.split('#')[1] ?? ''}`;
13
- const getHash = () => {
14
- return IN_IFRAME
15
- ? getPartialURLHashFragment(getFin5FrameURL())
16
- : window.location.hash;
17
- };
18
- export const fin5SkipHashUpdate = () => getApp()?.set('skipHashUpdate', true);
19
- const setHash = (hash) => {
20
- if (IN_IFRAME) {
21
- return fin5SkipHashUpdate()?.then(() => {
22
- const frameParameters = getFin5HashFrameParameters();
23
- frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash);
24
- getTopLocation().hash = `#${getTopLocation().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
25
- });
26
- }
27
- else {
28
- window.location.hash = hash;
29
- return Promise.resolve();
30
- }
31
- };
32
- export const getHashParameters = () => new URLSearchParams(getHash().slice(1));
33
- /**
34
- * Use a parameter in the hash of a custom app running in FIN 5 as state.
35
- * @param name parameter name.
36
- * @param initialState initial state used if the parameter is not defined.
37
- * @returns the parameter value and a function to update it.
38
- */
39
- export const useFin5AppURLHashParameter = (name, initialState) => {
40
- const [paramValue, setParamValue] = useState(getHashParameters()?.get(name) ?? undefined);
41
- const setHashParameter = async (value) => {
42
- const params = getHashParameters();
43
- if (params.get(name) !== value) {
44
- if (value === '' || value == null) {
45
- params.delete(name);
46
- }
47
- else {
48
- params?.set(name, value);
49
- }
50
- await setHash(params?.toString());
51
- setParamValue(value);
52
- }
53
- };
54
- useEffect(() => {
55
- if (!getHashParameters()?.has(name) && initialState) {
56
- setHashParameter(initialState);
57
- }
58
- }, []);
59
- useEffect(() => {
60
- const onHashChange = () => {
61
- setParamValue(getHashParameters()?.get(name) ?? undefined);
62
- };
63
- if (IN_IFRAME) {
64
- getTop().addEventListener('hashchange', onHashChange);
65
- return () => {
66
- getTop().removeEventListener('hashchange', onHashChange);
67
- };
68
- }
69
- return () => {
70
- return;
71
- };
72
- }, []);
73
- return [paramValue, setHashParameter];
74
- };
75
- /**
76
- * Use all the parameters in the hash of a custom app running in FIN 5 as state.
77
- * @param parameters the initial (optional) values for the parameters
78
- * @returns the URL parameters and a function to patch the parameters.
79
- */
80
- export const useFin5AppURLHashParameters = (parameters) => {
81
- const [paramValues, setParamValues] = useState(getHashParameters());
82
- // Patch the parameters: this updates just the URL parameters passed.
83
- // If there is a parameter in the hash and not in the function arg, that is left untouched.
84
- // To remove a parameter in the hash, set it to null or empty string.
85
- const setHashParameters = async (paramsToUpdate) => {
86
- const params = getHashParameters();
87
- Array.from(paramsToUpdate.entries()).forEach(([paramKey, newParamValue]) => {
88
- if (newParamValue !== params.get(paramKey)) {
89
- if (newParamValue == null || newParamValue === '') {
90
- params.delete(paramKey);
91
- }
92
- else {
93
- params.set(paramKey, newParamValue);
94
- }
95
- }
96
- });
97
- await setHash(params.toString());
98
- setParamValues(params);
99
- };
100
- // Initial setup.
101
- useEffect(() => {
102
- const hashParameters = getHashParameters();
103
- if (parameters) {
104
- Array.from(parameters.entries()).forEach(([paramKey, paramValue]) => {
105
- if (!hashParameters.has(paramKey) &&
106
- paramValue != null &&
107
- paramValue !== '') {
108
- hashParameters.set(paramKey, paramValue);
109
- }
110
- });
111
- setHashParameters(hashParameters);
112
- }
113
- }, []);
114
- useEffect(() => {
115
- const onHashChange = () => {
116
- setParamValues(getHashParameters());
117
- };
118
- getTop().addEventListener('hashchange', onHashChange);
119
- return () => {
120
- getTop().removeEventListener('hashchange', onHashChange);
121
- };
122
- }, []);
123
- return [paramValues, setHashParameters];
124
- };
1
+ /*
2
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
+ */
4
+ import { useEffect, useState } from 'react';
5
+ import { isWindowTopFin5 } from './fin5Top';
6
+ export const IN_IFRAME = window !== top && isWindowTopFin5();
7
+ const getTop = () => window.top ?? window;
8
+ const getApp = () => getTop()?.app;
9
+ export const getTopLocation = () => getTop().location;
10
+ export const getFin5HashFrameParameters = () => new URLSearchParams(getTopLocation().hash.slice(1).split('?')[1]);
11
+ const getFin5FrameURL = () => getFin5HashFrameParameters().get('url');
12
+ const getPartialURLHashFragment = (url) => `#${url?.split('#')[1] ?? ''}`;
13
+ const getHash = () => {
14
+ return IN_IFRAME
15
+ ? getPartialURLHashFragment(getFin5FrameURL())
16
+ : window.location.hash;
17
+ };
18
+ export const fin5SkipHashUpdate = () => getApp()?.set('skipHashUpdate', true);
19
+ const setHash = (hash) => {
20
+ if (IN_IFRAME) {
21
+ return fin5SkipHashUpdate()?.then(() => {
22
+ const frameParameters = getFin5HashFrameParameters();
23
+ frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash);
24
+ getTopLocation().hash = `#${getTopLocation().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
25
+ });
26
+ }
27
+ else {
28
+ window.location.hash = hash;
29
+ return Promise.resolve();
30
+ }
31
+ };
32
+ export const getHashParameters = () => new URLSearchParams(getHash().slice(1));
33
+ /**
34
+ * Use a parameter in the hash of a custom app running in FIN 5 as state.
35
+ * @param name parameter name.
36
+ * @param initialState initial state used if the parameter is not defined.
37
+ * @returns the parameter value and a function to update it.
38
+ */
39
+ export const useFin5AppURLHashParameter = (name, initialState) => {
40
+ const [paramValue, setParamValue] = useState(getHashParameters()?.get(name) ?? undefined);
41
+ const setHashParameter = async (value) => {
42
+ const params = getHashParameters();
43
+ if (params.get(name) !== value) {
44
+ if (value === '' || value == null) {
45
+ params.delete(name);
46
+ }
47
+ else {
48
+ params?.set(name, value);
49
+ }
50
+ await setHash(params?.toString());
51
+ setParamValue(value);
52
+ }
53
+ };
54
+ useEffect(() => {
55
+ if (!getHashParameters()?.has(name) && initialState) {
56
+ setHashParameter(initialState);
57
+ }
58
+ }, []);
59
+ useEffect(() => {
60
+ const onHashChange = () => {
61
+ setParamValue(getHashParameters()?.get(name) ?? undefined);
62
+ };
63
+ if (IN_IFRAME) {
64
+ getTop().addEventListener('hashchange', onHashChange);
65
+ return () => {
66
+ getTop().removeEventListener('hashchange', onHashChange);
67
+ };
68
+ }
69
+ return () => {
70
+ return;
71
+ };
72
+ }, []);
73
+ return [paramValue, setHashParameter];
74
+ };
75
+ /**
76
+ * Use all the parameters in the hash of a custom app running in FIN 5 as state.
77
+ * @param parameters the initial (optional) values for the parameters
78
+ * @returns the URL parameters and a function to patch the parameters.
79
+ */
80
+ export const useFin5AppURLHashParameters = (parameters) => {
81
+ const [paramValues, setParamValues] = useState(getHashParameters());
82
+ // Patch the parameters: this updates just the URL parameters passed.
83
+ // If there is a parameter in the hash and not in the function arg, that is left untouched.
84
+ // To remove a parameter in the hash, set it to null or empty string.
85
+ const setHashParameters = async (paramsToUpdate) => {
86
+ const params = getHashParameters();
87
+ Array.from(paramsToUpdate.entries()).forEach(([paramKey, newParamValue]) => {
88
+ if (newParamValue !== params.get(paramKey)) {
89
+ if (newParamValue == null || newParamValue === '') {
90
+ params.delete(paramKey);
91
+ }
92
+ else {
93
+ params.set(paramKey, newParamValue);
94
+ }
95
+ }
96
+ });
97
+ await setHash(params.toString());
98
+ setParamValues(params);
99
+ };
100
+ // Initial setup.
101
+ useEffect(() => {
102
+ const hashParameters = getHashParameters();
103
+ if (parameters) {
104
+ Array.from(parameters.entries()).forEach(([paramKey, paramValue]) => {
105
+ if (!hashParameters.has(paramKey) &&
106
+ paramValue != null &&
107
+ paramValue !== '') {
108
+ hashParameters.set(paramKey, paramValue);
109
+ }
110
+ });
111
+ setHashParameters(hashParameters);
112
+ }
113
+ }, []);
114
+ useEffect(() => {
115
+ const onHashChange = () => {
116
+ setParamValues(getHashParameters());
117
+ };
118
+ getTop().addEventListener('hashchange', onHashChange);
119
+ return () => {
120
+ getTop().removeEventListener('hashchange', onHashChange);
121
+ };
122
+ }, []);
123
+ return [paramValues, setHashParameters];
124
+ };
125
125
  //# sourceMappingURL=useFin5AppURLHashParameter.js.map
@@ -1,36 +1,31 @@
1
- export * from './fin5Top/fin5FileUpload';
2
- export * from './fin5Top/fin5Top';
3
- export * from './fin5Top/finEdge2Cloud';
4
- export * from './fin5Top/getFin5BinUrl';
5
- export * from './fin5Top/openFin5Alarm';
6
- export * from './fin5Top/openFin5Historian';
7
- export * from './fin5Top/useFin5AppURLHashParameter';
8
- export * from './jobs/jobUtils';
9
- export * from './react/components/ErrorBoundary';
10
- export * from './react/components/ErrorDisplayer';
11
- export * from './react/components/Loader';
12
- export * from './react/components/LoadingSpinner';
13
- export * from './react/components/graphics/GraphicViewer';
14
- export * from './react/components/graphics/GraphicsTabViewer';
15
- export * from './react/components/navigation/BasicLayout';
16
- export * from './react/components/navigation/MenuPage';
17
- export * from './react/components/navigation/ReactRouterLayout';
18
- export * from './react/components/navigation/ReactRouterHeaderSiderLayout';
19
- export * from './react/components/navigation/customRouting/RouterLayout';
20
- export * from './react/components/navigation/customRouting/Router';
21
- export * from './react/components/resolvable/configurationForm/ConfigurationForm';
22
- export * from './react/components/resolvable/configurationForm/ConfigurationFormEntry';
23
- export * from './react/components/resolvable/configurationForm/getSectionDefault';
24
- export * from './react/components/RecordImage';
25
- export * from './react/components/charts/QRCode';
26
- export * from './react/components/charts/line-bar/Chart';
27
- export * from './react/components/charts/line-bar/HGridChart';
28
- export * from './react/components/charts/line-bar/ZincGridChart';
29
- export * from './react/components/charts/pie/PieChart';
30
- export * from './react/components/charts/pie/SimplePieChart';
31
- export * from './react/components/makeCustomElement';
32
- export * from './react/hooks/useFin5BinUrl';
33
- export * from './react/hooks/useFin5ColorScheme';
34
- export * from './react/hooks/useScreenSize';
35
- export * from './react/app/Fin5AppContainer';
36
- export * from './react/app/Fin5AppRootStore';
1
+ export * from './fin5Top/fin5FileUpload';
2
+ export * from './fin5Top/fin5Top';
3
+ export * from './fin5Top/finEdge2Cloud';
4
+ export * from './fin5Top/getFin5BinUrl';
5
+ export * from './fin5Top/openFin5Alarm';
6
+ export * from './fin5Top/openFin5Historian';
7
+ export * from './fin5Top/useFin5AppURLHashParameter';
8
+ export * from './jobs/jobUtils';
9
+ export * from './react/components/ErrorBoundary';
10
+ export * from './react/components/ErrorDisplayer';
11
+ export * from './react/components/Loader';
12
+ export * from './react/components/LoadingSpinner';
13
+ export * from './react/components/graphics/GraphicViewer';
14
+ export * from './react/components/graphics/GraphicsTabViewer';
15
+ export * from './react/components/navigation/BasicLayout';
16
+ export * from './react/components/navigation/MenuPage';
17
+ export * from './react/components/navigation/ReactRouterLayout';
18
+ export * from './react/components/navigation/ReactRouterHeaderSiderLayout';
19
+ export * from './react/components/navigation/customRouting/RouterLayout';
20
+ export * from './react/components/navigation/customRouting/Router';
21
+ export * from './react/components/resolvable/configurationForm/ConfigurationForm';
22
+ export * from './react/components/resolvable/configurationForm/ConfigurationFormEntry';
23
+ export * from './react/components/resolvable/configurationForm/getSectionDefault';
24
+ export * from './react/components/RecordImage';
25
+ export * from './react/components/charts/QRCode';
26
+ export * from './react/components/charts/pie/PieChart';
27
+ export * from './react/components/charts/pie/SimplePieChart';
28
+ export * from './react/hooks/useFin5BinUrl';
29
+ export * from './react/hooks/useFin5ColorScheme';
30
+ export * from './react/app/Fin5AppContainer';
31
+ export * from './react/app/Fin5AppRootStore';
package/dist_es/index.js CHANGED
@@ -1,55 +1,50 @@
1
- /*
2
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
- */
4
- //////////////////////////////////////////////////////////////////////////
5
- // Fin5 APIs related modules
6
- //////////////////////////////////////////////////////////////////////////
7
- export * from './fin5Top/fin5FileUpload';
8
- export * from './fin5Top/fin5Top';
9
- export * from './fin5Top/finEdge2Cloud';
10
- export * from './fin5Top/getFin5BinUrl';
11
- export * from './fin5Top/openFin5Alarm';
12
- export * from './fin5Top/openFin5Historian';
13
- export * from './fin5Top/useFin5AppURLHashParameter';
14
- //////////////////////////////////////////////////////////////////////////
15
- // Fin5 features related modules
16
- //////////////////////////////////////////////////////////////////////////
17
- export * from './jobs/jobUtils';
18
- //////////////////////////////////////////////////////////////////////////
19
- // React components
20
- //////////////////////////////////////////////////////////////////////////
21
- export * from './react/components/ErrorBoundary';
22
- export * from './react/components/ErrorDisplayer';
23
- export * from './react/components/Loader';
24
- export * from './react/components/LoadingSpinner';
25
- export * from './react/components/graphics/GraphicViewer';
26
- export * from './react/components/graphics/GraphicsTabViewer';
27
- export * from './react/components/navigation/BasicLayout';
28
- export * from './react/components/navigation/MenuPage';
29
- export * from './react/components/navigation/ReactRouterLayout';
30
- export * from './react/components/navigation/ReactRouterHeaderSiderLayout';
31
- export * from './react/components/navigation/customRouting/RouterLayout';
32
- export * from './react/components/navigation/customRouting/Router';
33
- export * from './react/components/resolvable/configurationForm/ConfigurationForm';
34
- export * from './react/components/resolvable/configurationForm/ConfigurationFormEntry';
35
- export * from './react/components/resolvable/configurationForm/getSectionDefault';
36
- export * from './react/components/RecordImage';
37
- export * from './react/components/charts/QRCode';
38
- export * from './react/components/charts/line-bar/Chart';
39
- export * from './react/components/charts/line-bar/HGridChart';
40
- export * from './react/components/charts/line-bar/ZincGridChart';
41
- export * from './react/components/charts/pie/PieChart';
42
- export * from './react/components/charts/pie/SimplePieChart';
43
- export * from './react/components/makeCustomElement';
44
- //////////////////////////////////////////////////////////////////////////
45
- // React hooks
46
- //////////////////////////////////////////////////////////////////////////
47
- export * from './react/hooks/useFin5BinUrl';
48
- export * from './react/hooks/useFin5ColorScheme';
49
- export * from './react/hooks/useScreenSize';
50
- //////////////////////////////////////////////////////////////////////////
51
- // j2inn/app support for FIN5
52
- //////////////////////////////////////////////////////////////////////////
53
- export * from './react/app/Fin5AppContainer';
54
- export * from './react/app/Fin5AppRootStore';
1
+ /*
2
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
+ */
4
+ //////////////////////////////////////////////////////////////////////////
5
+ // Fin5 APIs related modules
6
+ //////////////////////////////////////////////////////////////////////////
7
+ export * from './fin5Top/fin5FileUpload';
8
+ export * from './fin5Top/fin5Top';
9
+ export * from './fin5Top/finEdge2Cloud';
10
+ export * from './fin5Top/getFin5BinUrl';
11
+ export * from './fin5Top/openFin5Alarm';
12
+ export * from './fin5Top/openFin5Historian';
13
+ export * from './fin5Top/useFin5AppURLHashParameter';
14
+ //////////////////////////////////////////////////////////////////////////
15
+ // Fin5 features related modules
16
+ //////////////////////////////////////////////////////////////////////////
17
+ export * from './jobs/jobUtils';
18
+ //////////////////////////////////////////////////////////////////////////
19
+ // React components
20
+ //////////////////////////////////////////////////////////////////////////
21
+ export * from './react/components/ErrorBoundary';
22
+ export * from './react/components/ErrorDisplayer';
23
+ export * from './react/components/Loader';
24
+ export * from './react/components/LoadingSpinner';
25
+ export * from './react/components/graphics/GraphicViewer';
26
+ export * from './react/components/graphics/GraphicsTabViewer';
27
+ export * from './react/components/navigation/BasicLayout';
28
+ export * from './react/components/navigation/MenuPage';
29
+ export * from './react/components/navigation/ReactRouterLayout';
30
+ export * from './react/components/navigation/ReactRouterHeaderSiderLayout';
31
+ export * from './react/components/navigation/customRouting/RouterLayout';
32
+ export * from './react/components/navigation/customRouting/Router';
33
+ export * from './react/components/resolvable/configurationForm/ConfigurationForm';
34
+ export * from './react/components/resolvable/configurationForm/ConfigurationFormEntry';
35
+ export * from './react/components/resolvable/configurationForm/getSectionDefault';
36
+ export * from './react/components/RecordImage';
37
+ export * from './react/components/charts/QRCode';
38
+ export * from './react/components/charts/pie/PieChart';
39
+ export * from './react/components/charts/pie/SimplePieChart';
40
+ //////////////////////////////////////////////////////////////////////////
41
+ // React hooks
42
+ //////////////////////////////////////////////////////////////////////////
43
+ export * from './react/hooks/useFin5BinUrl';
44
+ export * from './react/hooks/useFin5ColorScheme';
45
+ //////////////////////////////////////////////////////////////////////////
46
+ // j2inn/app support for FIN5
47
+ //////////////////////////////////////////////////////////////////////////
48
+ export * from './react/app/Fin5AppContainer';
49
+ export * from './react/app/Fin5AppRootStore';
55
50
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,0EAA0E;AAC1E,4BAA4B;AAC5B,0EAA0E;AAE1E,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sCAAsC,CAAA;AAEpD,0EAA0E;AAC1E,gCAAgC;AAChC,0EAA0E;AAE1E,cAAc,iBAAiB,CAAA;AAE/B,0EAA0E;AAC1E,mBAAmB;AACnB,0EAA0E;AAE1E,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,2BAA2B,CAAA;AACzC,cAAc,mCAAmC,CAAA;AACjD,cAAc,2CAA2C,CAAA;AACzD,cAAc,+CAA+C,CAAA;AAC7D,cAAc,2CAA2C,CAAA;AACzD,cAAc,wCAAwC,CAAA;AACtD,cAAc,iDAAiD,CAAA;AAC/D,cAAc,4DAA4D,CAAA;AAC1E,cAAc,0DAA0D,CAAA;AACxE,cAAc,oDAAoD,CAAA;AAClE,cAAc,mEAAmE,CAAA;AACjF,cAAc,wEAAwE,CAAA;AACtF,cAAc,mEAAmE,CAAA;AACjF,cAAc,gCAAgC,CAAA;AAC9C,cAAc,kCAAkC,CAAA;AAChD,cAAc,0CAA0C,CAAA;AACxD,cAAc,+CAA+C,CAAA;AAC7D,cAAc,kDAAkD,CAAA;AAChE,cAAc,wCAAwC,CAAA;AACtD,cAAc,8CAA8C,CAAA;AAC5D,cAAc,sCAAsC,CAAA;AAEpD,0EAA0E;AAC1E,cAAc;AACd,0EAA0E;AAE1E,cAAc,6BAA6B,CAAA;AAC3C,cAAc,kCAAkC,CAAA;AAChD,cAAc,6BAA6B,CAAA;AAE3C,0EAA0E;AAC1E,6BAA6B;AAC7B,0EAA0E;AAE1E,cAAc,8BAA8B,CAAA;AAC5C,cAAc,8BAA8B,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,0EAA0E;AAC1E,4BAA4B;AAC5B,0EAA0E;AAE1E,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sCAAsC,CAAA;AAEpD,0EAA0E;AAC1E,gCAAgC;AAChC,0EAA0E;AAE1E,cAAc,iBAAiB,CAAA;AAE/B,0EAA0E;AAC1E,mBAAmB;AACnB,0EAA0E;AAE1E,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,2BAA2B,CAAA;AACzC,cAAc,mCAAmC,CAAA;AACjD,cAAc,2CAA2C,CAAA;AACzD,cAAc,+CAA+C,CAAA;AAC7D,cAAc,2CAA2C,CAAA;AACzD,cAAc,wCAAwC,CAAA;AACtD,cAAc,iDAAiD,CAAA;AAC/D,cAAc,4DAA4D,CAAA;AAC1E,cAAc,0DAA0D,CAAA;AACxE,cAAc,oDAAoD,CAAA;AAClE,cAAc,mEAAmE,CAAA;AACjF,cAAc,wEAAwE,CAAA;AACtF,cAAc,mEAAmE,CAAA;AACjF,cAAc,gCAAgC,CAAA;AAC9C,cAAc,kCAAkC,CAAA;AAChD,cAAc,wCAAwC,CAAA;AACtD,cAAc,8CAA8C,CAAA;AAE5D,0EAA0E;AAC1E,cAAc;AACd,0EAA0E;AAE1E,cAAc,6BAA6B,CAAA;AAC3C,cAAc,kCAAkC,CAAA;AAEhD,0EAA0E;AAC1E,6BAA6B;AAC7B,0EAA0E;AAE1E,cAAc,8BAA8B,CAAA;AAC5C,cAAc,8BAA8B,CAAA"}
@@ -1,14 +1,14 @@
1
- import { HDict, HNum, HStr } from 'haystack-core';
2
- export declare enum JobStatus {
3
- doneOk = "doneOk",
4
- doneErr = "doneErr",
5
- running = "running"
6
- }
7
- export interface JobStatusDict extends HDict {
8
- jobStatus: HStr;
9
- progress: HNum;
10
- progressMsg: HStr;
11
- }
12
- export declare const isJobSuccessful: (jobStatus: JobStatusDict) => boolean;
13
- export declare const isJobError: (jobStatus: JobStatusDict) => boolean;
14
- export declare const isJobRunning: (jobStatus: JobStatusDict) => boolean;
1
+ import { HDict, HNum, HStr } from 'haystack-core';
2
+ export declare enum JobStatus {
3
+ doneOk = "doneOk",
4
+ doneErr = "doneErr",
5
+ running = "running"
6
+ }
7
+ export interface JobStatusDict extends HDict {
8
+ jobStatus: HStr;
9
+ progress: HNum;
10
+ progressMsg: HStr;
11
+ }
12
+ export declare const isJobSuccessful: (jobStatus: JobStatusDict) => boolean;
13
+ export declare const isJobError: (jobStatus: JobStatusDict) => boolean;
14
+ export declare const isJobRunning: (jobStatus: JobStatusDict) => boolean;
@@ -1,10 +1,10 @@
1
- export var JobStatus;
2
- (function (JobStatus) {
3
- JobStatus["doneOk"] = "doneOk";
4
- JobStatus["doneErr"] = "doneErr";
5
- JobStatus["running"] = "running";
6
- })(JobStatus || (JobStatus = {}));
7
- export const isJobSuccessful = (jobStatus) => jobStatus.jobStatus.value === JobStatus.doneOk;
8
- export const isJobError = (jobStatus) => jobStatus.jobStatus.value === JobStatus.doneErr;
9
- export const isJobRunning = (jobStatus) => jobStatus.jobStatus.value === JobStatus.running;
1
+ export var JobStatus;
2
+ (function (JobStatus) {
3
+ JobStatus["doneOk"] = "doneOk";
4
+ JobStatus["doneErr"] = "doneErr";
5
+ JobStatus["running"] = "running";
6
+ })(JobStatus || (JobStatus = {}));
7
+ export const isJobSuccessful = (jobStatus) => jobStatus.jobStatus.value === JobStatus.doneOk;
8
+ export const isJobError = (jobStatus) => jobStatus.jobStatus.value === JobStatus.doneErr;
9
+ export const isJobRunning = (jobStatus) => jobStatus.jobStatus.value === JobStatus.running;
10
10
  //# sourceMappingURL=jobUtils.js.map
@@ -1,36 +1,36 @@
1
- import React from 'react';
2
- import { AppStore } from '@j2inn/app';
3
- import { Client } from 'haystack-nclient';
4
- import { ThemeDef } from '@j2inn/ui';
5
- /**
6
- * Properties for the dev application container component.
7
- */
8
- export interface Fin5AppContainerProps {
9
- /**
10
- * The children to render.
11
- */
12
- children?: React.ReactNode;
13
- /**
14
- * The app store.
15
- */
16
- appStore?: AppStore;
17
- /**
18
- * The network client object.
19
- */
20
- client?: Client;
21
- /**
22
- * Optional project name. Typically this is only specified
23
- * in development mode. It's typically picked up from the URL.
24
- */
25
- project?: string;
26
- /**
27
- * The optional theme to use.
28
- */
29
- theme?: ThemeDef;
30
- }
31
- /**
32
- * Creates a basic application container environment to run a view in FIN5.
33
- */
34
- export declare const Fin5AppContainer: (({ children, appStore, client, project, theme, }: Fin5AppContainerProps) => JSX.Element) & {
35
- displayName: string;
36
- };
1
+ import React from 'react';
2
+ import { AppStore } from '@j2inn/app';
3
+ import { Client } from 'haystack-nclient';
4
+ import { ThemeDef } from '@j2inn/ui';
5
+ /**
6
+ * Properties for the dev application container component.
7
+ */
8
+ export interface Fin5AppContainerProps {
9
+ /**
10
+ * The children to render.
11
+ */
12
+ children?: React.ReactNode;
13
+ /**
14
+ * The app store.
15
+ */
16
+ appStore?: AppStore;
17
+ /**
18
+ * The network client object.
19
+ */
20
+ client?: Client;
21
+ /**
22
+ * Optional project name. Typically this is only specified
23
+ * in development mode. It's typically picked up from the URL.
24
+ */
25
+ project?: string;
26
+ /**
27
+ * The optional theme to use.
28
+ */
29
+ theme?: ThemeDef;
30
+ }
31
+ /**
32
+ * Creates a basic application container environment to run a view in FIN5.
33
+ */
34
+ export declare const Fin5AppContainer: (({ children, appStore, client, project, theme, }: Fin5AppContainerProps) => JSX.Element) & {
35
+ displayName: string;
36
+ };