@j2inn/fin5-ui-utils 8.1.2-beta.2 → 8.1.2

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 (216) 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 -175
  17. package/dist/fin5Top/fin5Top.js +61 -61
  18. package/dist/fin5Top/fin5Top.js.map +1 -1
  19. package/dist/fin5Top/finEdge2Cloud.d.ts +6 -6
  20. package/dist/fin5Top/finEdge2Cloud.js +15 -15
  21. package/dist/fin5Top/getFin5BinUrl.d.ts +2 -2
  22. package/dist/fin5Top/getFin5BinUrl.js +9 -9
  23. package/dist/fin5Top/openFin5Alarm.d.ts +22 -22
  24. package/dist/fin5Top/openFin5Alarm.js +23 -23
  25. package/dist/fin5Top/openFin5Historian.d.ts +3 -3
  26. package/dist/fin5Top/openFin5Historian.js +19 -19
  27. package/dist/fin5Top/useFin5AppURLHashParameter.d.ts +18 -18
  28. package/dist/fin5Top/useFin5AppURLHashParameter.js +133 -133
  29. package/dist/index.d.ts +35 -35
  30. package/dist/index.js +69 -69
  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 +161 -145
  35. package/dist/react/app/Fin5AppContainer.js.map +1 -1
  36. package/dist/react/app/Fin5AppRootStore.d.ts +42 -40
  37. package/dist/react/app/Fin5AppRootStore.js +114 -90
  38. package/dist/react/app/Fin5AppRootStore.js.map +1 -1
  39. package/dist/react/components/ErrorBoundary.d.ts +57 -57
  40. package/dist/react/components/ErrorBoundary.js +150 -150
  41. package/dist/react/components/ErrorDisplayer.d.ts +19 -19
  42. package/dist/react/components/ErrorDisplayer.js +36 -36
  43. package/dist/react/components/Loader.d.ts +9 -9
  44. package/dist/react/components/Loader.js +17 -17
  45. package/dist/react/components/LoadingSpinner.d.ts +2 -2
  46. package/dist/react/components/LoadingSpinner.js +27 -27
  47. package/dist/react/components/RecordImage.d.ts +20 -20
  48. package/dist/react/components/RecordImage.js +51 -51
  49. package/dist/react/components/charts/QRCode.d.ts +25 -25
  50. package/dist/react/components/charts/QRCode.js +82 -82
  51. package/dist/react/components/charts/line-bar/Chart.d.ts +166 -166
  52. package/dist/react/components/charts/line-bar/Chart.js +442 -442
  53. package/dist/react/components/charts/line-bar/HGridChart.d.ts +58 -58
  54. package/dist/react/components/charts/line-bar/HGridChart.js +285 -285
  55. package/dist/react/components/charts/pie/PieChart.d.ts +94 -94
  56. package/dist/react/components/charts/pie/PieChart.js +204 -204
  57. package/dist/react/components/charts/pie/SimplePieChart.d.ts +21 -21
  58. package/dist/react/components/charts/pie/SimplePieChart.js +55 -55
  59. package/dist/react/components/graphics/GraphicViewer.d.ts +10 -10
  60. package/dist/react/components/graphics/GraphicViewer.js +29 -29
  61. package/dist/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  62. package/dist/react/components/graphics/GraphicsTabViewer.js +90 -90
  63. package/dist/react/components/makeCustomElement.d.ts +16 -16
  64. package/dist/react/components/makeCustomElement.js +150 -150
  65. package/dist/react/components/navigation/BasicLayout.d.ts +41 -41
  66. package/dist/react/components/navigation/BasicLayout.js +155 -155
  67. package/dist/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  68. package/dist/react/components/navigation/HeaderSiderLayout.js +110 -110
  69. package/dist/react/components/navigation/MenuPage.d.ts +37 -37
  70. package/dist/react/components/navigation/MenuPage.js +36 -36
  71. package/dist/react/components/navigation/MenuTrigger.d.ts +9 -9
  72. package/dist/react/components/navigation/MenuTrigger.js +33 -33
  73. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  74. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.js +25 -25
  75. package/dist/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  76. package/dist/react/components/navigation/ReactRouterLayout.js +132 -132
  77. package/dist/react/components/navigation/customRouting/Router.d.ts +12 -12
  78. package/dist/react/components/navigation/customRouting/Router.js +45 -45
  79. package/dist/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  80. package/dist/react/components/navigation/customRouting/RouterLayout.js +61 -61
  81. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  82. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.js +95 -95
  83. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  84. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +88 -88
  85. package/dist/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  86. package/dist/react/components/resolvable/configurationForm/getSectionDefault.js +99 -99
  87. package/dist/react/hooks/useFin5BinUrl.d.ts +6 -6
  88. package/dist/react/hooks/useFin5BinUrl.js +15 -15
  89. package/dist/react/hooks/useFin5ColorScheme.d.ts +2 -2
  90. package/dist/react/hooks/useFin5ColorScheme.js +56 -56
  91. package/dist/react/hooks/useScreenSize.d.ts +7 -7
  92. package/dist/react/hooks/useScreenSize.js +31 -31
  93. package/dist_es/fantomProps/createFin5Props/index.d.ts +12 -12
  94. package/dist_es/fantomProps/createFin5Props/index.js +140 -140
  95. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.d.ts +2 -2
  96. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.js +15 -15
  97. package/dist_es/fantomProps/fantomPropsToObject.d.ts +8 -8
  98. package/dist_es/fantomProps/fantomPropsToObject.js +178 -178
  99. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.d.ts +4 -4
  100. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.js +12 -12
  101. package/dist_es/fantomProps/localePropsToJson.d.ts +1 -1
  102. package/dist_es/fantomProps/localePropsToJson.js +21 -21
  103. package/dist_es/fantomProps/readFantomPropsFile.d.ts +5 -5
  104. package/dist_es/fantomProps/readFantomPropsFile.js +39 -39
  105. package/dist_es/fin5Top/fin5FileUpload.d.ts +24 -24
  106. package/dist_es/fin5Top/fin5FileUpload.js +47 -47
  107. package/dist_es/fin5Top/fin5Top.d.ts +165 -175
  108. package/dist_es/fin5Top/fin5Top.js +57 -57
  109. package/dist_es/fin5Top/fin5Top.js.map +1 -1
  110. package/dist_es/fin5Top/finEdge2Cloud.d.ts +6 -6
  111. package/dist_es/fin5Top/finEdge2Cloud.js +11 -11
  112. package/dist_es/fin5Top/getFin5BinUrl.d.ts +2 -2
  113. package/dist_es/fin5Top/getFin5BinUrl.js +5 -5
  114. package/dist_es/fin5Top/openFin5Alarm.d.ts +22 -22
  115. package/dist_es/fin5Top/openFin5Alarm.js +19 -19
  116. package/dist_es/fin5Top/openFin5Historian.d.ts +3 -3
  117. package/dist_es/fin5Top/openFin5Historian.js +15 -15
  118. package/dist_es/fin5Top/useFin5AppURLHashParameter.d.ts +18 -18
  119. package/dist_es/fin5Top/useFin5AppURLHashParameter.js +124 -124
  120. package/dist_es/index.d.ts +35 -35
  121. package/dist_es/index.js +53 -53
  122. package/dist_es/jobs/jobUtils.d.ts +14 -14
  123. package/dist_es/jobs/jobUtils.js +9 -9
  124. package/dist_es/react/app/Fin5AppContainer.d.ts +36 -36
  125. package/dist_es/react/app/Fin5AppContainer.js +132 -116
  126. package/dist_es/react/app/Fin5AppContainer.js.map +1 -1
  127. package/dist_es/react/app/Fin5AppRootStore.d.ts +42 -40
  128. package/dist_es/react/app/Fin5AppRootStore.js +110 -86
  129. package/dist_es/react/app/Fin5AppRootStore.js.map +1 -1
  130. package/dist_es/react/components/ErrorBoundary.d.ts +57 -57
  131. package/dist_es/react/components/ErrorBoundary.js +123 -123
  132. package/dist_es/react/components/ErrorDisplayer.d.ts +19 -19
  133. package/dist_es/react/components/ErrorDisplayer.js +28 -28
  134. package/dist_es/react/components/Loader.d.ts +9 -9
  135. package/dist_es/react/components/Loader.js +12 -12
  136. package/dist_es/react/components/LoadingSpinner.d.ts +2 -2
  137. package/dist_es/react/components/LoadingSpinner.js +20 -20
  138. package/dist_es/react/components/RecordImage.d.ts +20 -20
  139. package/dist_es/react/components/RecordImage.js +24 -24
  140. package/dist_es/react/components/charts/QRCode.d.ts +25 -25
  141. package/dist_es/react/components/charts/QRCode.js +52 -52
  142. package/dist_es/react/components/charts/line-bar/Chart.d.ts +166 -166
  143. package/dist_es/react/components/charts/line-bar/Chart.js +415 -415
  144. package/dist_es/react/components/charts/line-bar/HGridChart.d.ts +58 -58
  145. package/dist_es/react/components/charts/line-bar/HGridChart.js +250 -250
  146. package/dist_es/react/components/charts/pie/PieChart.d.ts +94 -94
  147. package/dist_es/react/components/charts/pie/PieChart.js +177 -177
  148. package/dist_es/react/components/charts/pie/SimplePieChart.d.ts +21 -21
  149. package/dist_es/react/components/charts/pie/SimplePieChart.js +25 -25
  150. package/dist_es/react/components/graphics/GraphicViewer.d.ts +10 -10
  151. package/dist_es/react/components/graphics/GraphicViewer.js +22 -22
  152. package/dist_es/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  153. package/dist_es/react/components/graphics/GraphicsTabViewer.js +60 -60
  154. package/dist_es/react/components/makeCustomElement.d.ts +16 -16
  155. package/dist_es/react/components/makeCustomElement.js +142 -142
  156. package/dist_es/react/components/navigation/BasicLayout.d.ts +41 -41
  157. package/dist_es/react/components/navigation/BasicLayout.js +124 -124
  158. package/dist_es/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  159. package/dist_es/react/components/navigation/HeaderSiderLayout.js +80 -80
  160. package/dist_es/react/components/navigation/MenuPage.d.ts +37 -37
  161. package/dist_es/react/components/navigation/MenuPage.js +30 -30
  162. package/dist_es/react/components/navigation/MenuTrigger.d.ts +9 -9
  163. package/dist_es/react/components/navigation/MenuTrigger.js +28 -28
  164. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  165. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.js +18 -18
  166. package/dist_es/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  167. package/dist_es/react/components/navigation/ReactRouterLayout.js +99 -99
  168. package/dist_es/react/components/navigation/customRouting/Router.d.ts +12 -12
  169. package/dist_es/react/components/navigation/customRouting/Router.js +18 -18
  170. package/dist_es/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  171. package/dist_es/react/components/navigation/customRouting/RouterLayout.js +34 -34
  172. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  173. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.js +64 -64
  174. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  175. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +58 -58
  176. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  177. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.js +94 -94
  178. package/dist_es/react/hooks/useFin5BinUrl.d.ts +6 -6
  179. package/dist_es/react/hooks/useFin5BinUrl.js +11 -11
  180. package/dist_es/react/hooks/useFin5ColorScheme.d.ts +2 -2
  181. package/dist_es/react/hooks/useFin5ColorScheme.js +52 -52
  182. package/dist_es/react/hooks/useScreenSize.d.ts +7 -7
  183. package/dist_es/react/hooks/useScreenSize.js +27 -27
  184. package/package.json +2 -2
  185. package/dist_es/react/app/Fin5AppContainer.jsx +0 -82
  186. package/dist_es/react/app/Fin5AppContainer.jsx.map +0 -1
  187. package/dist_es/react/components/ErrorBoundary.jsx +0 -150
  188. package/dist_es/react/components/ErrorBoundary.jsx.map +0 -1
  189. package/dist_es/react/components/ErrorDisplayer.jsx +0 -36
  190. package/dist_es/react/components/ErrorDisplayer.jsx.map +0 -1
  191. package/dist_es/react/components/Loader.jsx +0 -13
  192. package/dist_es/react/components/Loader.jsx.map +0 -1
  193. package/dist_es/react/components/LoadingSpinner.jsx +0 -22
  194. package/dist_es/react/components/LoadingSpinner.jsx.map +0 -1
  195. package/dist_es/react/components/charts/line-bar/ZincGridChart.d.ts +0 -12
  196. package/dist_es/react/components/charts/line-bar/ZincGridChart.js +0 -17
  197. package/dist_es/react/components/charts/line-bar/ZincGridChart.js.map +0 -1
  198. package/dist_es/react/components/graphics/GraphicViewer.jsx +0 -23
  199. package/dist_es/react/components/graphics/GraphicViewer.jsx.map +0 -1
  200. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx +0 -63
  201. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx.map +0 -1
  202. package/dist_es/react/components/navigation/BasicLayout.jsx +0 -133
  203. package/dist_es/react/components/navigation/BasicLayout.jsx.map +0 -1
  204. package/dist_es/react/components/navigation/MenuPage.jsx +0 -31
  205. package/dist_es/react/components/navigation/MenuPage.jsx.map +0 -1
  206. package/dist_es/react/components/navigation/Router.d.ts +0 -12
  207. package/dist_es/react/components/navigation/Router.js +0 -19
  208. package/dist_es/react/components/navigation/Router.js.map +0 -1
  209. package/dist_es/react/components/navigation/Router.jsx +0 -19
  210. package/dist_es/react/components/navigation/Router.jsx.map +0 -1
  211. package/dist_es/react/components/navigation/react-router/BasicLayout.d.ts +0 -23
  212. package/dist_es/react/components/navigation/react-router/BasicLayout.js +0 -82
  213. package/dist_es/react/components/navigation/react-router/BasicLayout.js.map +0 -1
  214. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.d.ts +0 -24
  215. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js +0 -82
  216. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js.map +0 -1
@@ -1,22 +1,22 @@
1
- import { TargetRef } from './fin5Top';
2
- export interface AlarmFilterTypes {
3
- alarms: boolean;
4
- events: boolean;
5
- acks: boolean;
6
- }
7
- export interface AlarmFilter {
8
- range?: string;
9
- priorityThreshold?: string;
10
- acked?: boolean;
11
- unacked?: boolean;
12
- inAlarm?: boolean;
13
- notInAlarm?: boolean;
14
- search?: string;
15
- types?: AlarmFilterTypes;
16
- }
17
- export declare type AlarmOptions = {
18
- targetRef?: TargetRef;
19
- filter: AlarmFilter;
20
- historical?: boolean;
21
- };
22
- export declare const openFin5AlarmsApp: ({ targetRef, filter, historical, }: AlarmOptions) => Promise<void>;
1
+ import { TargetRef } from './fin5Top';
2
+ export interface AlarmFilterTypes {
3
+ alarms: boolean;
4
+ events: boolean;
5
+ acks: boolean;
6
+ }
7
+ export interface AlarmFilter {
8
+ range?: string;
9
+ priorityThreshold?: string;
10
+ acked?: boolean;
11
+ unacked?: boolean;
12
+ inAlarm?: boolean;
13
+ notInAlarm?: boolean;
14
+ search?: string;
15
+ types?: AlarmFilterTypes;
16
+ }
17
+ export declare type AlarmOptions = {
18
+ targetRef?: TargetRef;
19
+ filter: AlarmFilter;
20
+ historical?: boolean;
21
+ };
22
+ export declare const openFin5AlarmsApp: ({ targetRef, filter, historical, }: AlarmOptions) => Promise<void>;
@@ -1,20 +1,20 @@
1
- /*
2
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
- */
4
- //////////////////////////////////////////////////////////////////////////
5
- // Alarms
6
- //////////////////////////////////////////////////////////////////////////
7
- import { fin5Top } from './fin5Top';
8
- export const openFin5AlarmsApp = async ({ targetRef, filter, historical = false, }) => {
9
- await fin5Top?.app.NavigateToApp(fin5Top?.app?.APP_NAMES?.ALARMS, targetRef);
10
- fin5Top?.app.ToggleCollapse(false);
11
- let alarmFilters = fin5Top?.app?.GetAlarmFilters() ?? {};
12
- if (filter) {
13
- alarmFilters = {
14
- ...alarmFilters,
15
- ...filter,
16
- };
17
- }
18
- fin5Top?.app?.SetAlarmFilters(alarmFilters, historical);
19
- };
1
+ /*
2
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
+ */
4
+ //////////////////////////////////////////////////////////////////////////
5
+ // Alarms
6
+ //////////////////////////////////////////////////////////////////////////
7
+ import { fin5Top } from './fin5Top';
8
+ export const openFin5AlarmsApp = async ({ targetRef, filter, historical = false, }) => {
9
+ await fin5Top?.app.NavigateToApp(fin5Top?.app?.APP_NAMES?.ALARMS, targetRef);
10
+ fin5Top?.app.ToggleCollapse(false);
11
+ let alarmFilters = fin5Top?.app?.GetAlarmFilters() ?? {};
12
+ if (filter) {
13
+ alarmFilters = {
14
+ ...alarmFilters,
15
+ ...filter,
16
+ };
17
+ }
18
+ fin5Top?.app?.SetAlarmFilters(alarmFilters, historical);
19
+ };
20
20
  //# sourceMappingURL=openFin5Alarm.js.map
@@ -1,3 +1,3 @@
1
- export declare type HistorianType = 'point' | 'query' | 'string';
2
- export declare type HistorianArgs = string | (string | undefined)[];
3
- export declare const openFin5HistorianApp: (queryType?: HistorianType, args?: HistorianArgs) => Promise<void>;
1
+ export declare type HistorianType = 'point' | 'query' | 'string';
2
+ export declare type HistorianArgs = string | (string | undefined)[];
3
+ export declare const openFin5HistorianApp: (queryType?: HistorianType, args?: HistorianArgs) => Promise<void>;
@@ -1,16 +1,16 @@
1
- /*
2
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
- */
4
- //////////////////////////////////////////////////////////////////////////
5
- // Historian
6
- //////////////////////////////////////////////////////////////////////////
7
- import { fin5Top } from './fin5Top';
8
- export const openFin5HistorianApp = async (queryType, args) => {
9
- if (fin5Top) {
10
- queryType && args
11
- ? fin5Top.app.OpenHistorianWithOptions(queryType, args)
12
- : fin5Top.app.NavigateToApp(fin5Top.app.APP_NAMES.TREND_LIST);
13
- fin5Top?.app.ToggleCollapse(false);
14
- }
15
- };
1
+ /*
2
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
+ */
4
+ //////////////////////////////////////////////////////////////////////////
5
+ // Historian
6
+ //////////////////////////////////////////////////////////////////////////
7
+ import { fin5Top } from './fin5Top';
8
+ export const openFin5HistorianApp = async (queryType, args) => {
9
+ if (fin5Top) {
10
+ queryType && args
11
+ ? fin5Top.app.OpenHistorianWithOptions(queryType, args)
12
+ : fin5Top.app.NavigateToApp(fin5Top.app.APP_NAMES.TREND_LIST);
13
+ fin5Top?.app.ToggleCollapse(false);
14
+ }
15
+ };
16
16
  //# sourceMappingURL=openFin5Historian.js.map
@@ -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,35 +1,35 @@
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/pie/PieChart';
29
- export * from './react/components/charts/pie/SimplePieChart';
30
- export * from './react/components/makeCustomElement';
31
- export * from './react/hooks/useFin5BinUrl';
32
- export * from './react/hooks/useFin5ColorScheme';
33
- export * from './react/hooks/useScreenSize';
34
- export * from './react/app/Fin5AppContainer';
35
- 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/line-bar/Chart';
27
+ export * from './react/components/charts/line-bar/HGridChart';
28
+ export * from './react/components/charts/pie/PieChart';
29
+ export * from './react/components/charts/pie/SimplePieChart';
30
+ export * from './react/components/makeCustomElement';
31
+ export * from './react/hooks/useFin5BinUrl';
32
+ export * from './react/hooks/useFin5ColorScheme';
33
+ export * from './react/hooks/useScreenSize';
34
+ export * from './react/app/Fin5AppContainer';
35
+ export * from './react/app/Fin5AppRootStore';
package/dist_es/index.js CHANGED
@@ -1,54 +1,54 @@
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/pie/PieChart';
41
- export * from './react/components/charts/pie/SimplePieChart';
42
- export * from './react/components/makeCustomElement';
43
- //////////////////////////////////////////////////////////////////////////
44
- // React hooks
45
- //////////////////////////////////////////////////////////////////////////
46
- export * from './react/hooks/useFin5BinUrl';
47
- export * from './react/hooks/useFin5ColorScheme';
48
- export * from './react/hooks/useScreenSize';
49
- //////////////////////////////////////////////////////////////////////////
50
- // j2inn/app support for FIN5
51
- //////////////////////////////////////////////////////////////////////////
52
- export * from './react/app/Fin5AppContainer';
53
- 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/line-bar/Chart';
39
+ export * from './react/components/charts/line-bar/HGridChart';
40
+ export * from './react/components/charts/pie/PieChart';
41
+ export * from './react/components/charts/pie/SimplePieChart';
42
+ export * from './react/components/makeCustomElement';
43
+ //////////////////////////////////////////////////////////////////////////
44
+ // React hooks
45
+ //////////////////////////////////////////////////////////////////////////
46
+ export * from './react/hooks/useFin5BinUrl';
47
+ export * from './react/hooks/useFin5ColorScheme';
48
+ export * from './react/hooks/useScreenSize';
49
+ //////////////////////////////////////////////////////////////////////////
50
+ // j2inn/app support for FIN5
51
+ //////////////////////////////////////////////////////////////////////////
52
+ export * from './react/app/Fin5AppContainer';
53
+ export * from './react/app/Fin5AppRootStore';
54
54
  //# sourceMappingURL=index.js.map