@j2inn/fin5-ui-utils 6.0.4 → 6.0.5-beta.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 (212) 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 +66 -61
  14. package/dist/fantomProps/readFantomPropsFile.js.map +1 -1
  15. package/dist/fin5Top/fin5FileUpload.d.ts +24 -24
  16. package/dist/fin5Top/fin5FileUpload.js +51 -51
  17. package/dist/fin5Top/fin5Top.d.ts +124 -124
  18. package/dist/fin5Top/fin5Top.js +53 -53
  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 +102 -102
  35. package/dist/react/app/Fin5AppRootStore.d.ts +40 -40
  36. package/dist/react/app/Fin5AppRootStore.js +69 -69
  37. package/dist/react/components/ErrorBoundary.d.ts +57 -57
  38. package/dist/react/components/ErrorBoundary.js +150 -150
  39. package/dist/react/components/ErrorDisplayer.d.ts +19 -19
  40. package/dist/react/components/ErrorDisplayer.js +36 -36
  41. package/dist/react/components/Loader.d.ts +9 -9
  42. package/dist/react/components/Loader.js +17 -17
  43. package/dist/react/components/LoadingSpinner.d.ts +2 -2
  44. package/dist/react/components/LoadingSpinner.js +27 -27
  45. package/dist/react/components/RecordImage.d.ts +20 -20
  46. package/dist/react/components/RecordImage.js +51 -51
  47. package/dist/react/components/charts/QRCode.d.ts +25 -25
  48. package/dist/react/components/charts/QRCode.js +82 -82
  49. package/dist/react/components/charts/line-bar/Chart.d.ts +166 -166
  50. package/dist/react/components/charts/line-bar/Chart.js +442 -442
  51. package/dist/react/components/charts/line-bar/HGridChart.d.ts +58 -58
  52. package/dist/react/components/charts/line-bar/HGridChart.js +285 -285
  53. package/dist/react/components/charts/pie/PieChart.d.ts +94 -94
  54. package/dist/react/components/charts/pie/PieChart.js +204 -204
  55. package/dist/react/components/charts/pie/SimplePieChart.d.ts +21 -21
  56. package/dist/react/components/charts/pie/SimplePieChart.js +55 -55
  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/makeCustomElement.d.ts +16 -16
  62. package/dist/react/components/makeCustomElement.js +150 -150
  63. package/dist/react/components/navigation/BasicLayout.d.ts +41 -41
  64. package/dist/react/components/navigation/BasicLayout.js +155 -155
  65. package/dist/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  66. package/dist/react/components/navigation/HeaderSiderLayout.js +110 -110
  67. package/dist/react/components/navigation/MenuPage.d.ts +37 -37
  68. package/dist/react/components/navigation/MenuPage.js +36 -36
  69. package/dist/react/components/navigation/MenuTrigger.d.ts +9 -9
  70. package/dist/react/components/navigation/MenuTrigger.js +33 -33
  71. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  72. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.js +25 -25
  73. package/dist/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  74. package/dist/react/components/navigation/ReactRouterLayout.js +132 -132
  75. package/dist/react/components/navigation/customRouting/Router.d.ts +12 -12
  76. package/dist/react/components/navigation/customRouting/Router.js +45 -45
  77. package/dist/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  78. package/dist/react/components/navigation/customRouting/RouterLayout.js +61 -61
  79. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  80. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.js +95 -95
  81. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  82. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +88 -88
  83. package/dist/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  84. package/dist/react/components/resolvable/configurationForm/getSectionDefault.js +99 -99
  85. package/dist/react/hooks/useFin5BinUrl.d.ts +6 -6
  86. package/dist/react/hooks/useFin5BinUrl.js +15 -15
  87. package/dist/react/hooks/useFin5ColorScheme.d.ts +2 -2
  88. package/dist/react/hooks/useFin5ColorScheme.js +49 -49
  89. package/dist/react/hooks/useScreenSize.d.ts +7 -7
  90. package/dist/react/hooks/useScreenSize.js +31 -31
  91. package/dist_es/fantomProps/createFin5Props/index.d.ts +12 -12
  92. package/dist_es/fantomProps/createFin5Props/index.js +140 -140
  93. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.d.ts +2 -2
  94. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.js +11 -11
  95. package/dist_es/fantomProps/fantomPropsToObject.d.ts +8 -8
  96. package/dist_es/fantomProps/fantomPropsToObject.js +178 -178
  97. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.d.ts +4 -4
  98. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.js +12 -12
  99. package/dist_es/fantomProps/localePropsToJson.d.ts +1 -1
  100. package/dist_es/fantomProps/localePropsToJson.js +21 -21
  101. package/dist_es/fantomProps/readFantomPropsFile.d.ts +5 -5
  102. package/dist_es/fantomProps/readFantomPropsFile.js +40 -35
  103. package/dist_es/fantomProps/readFantomPropsFile.js.map +1 -1
  104. package/dist_es/fin5Top/fin5FileUpload.d.ts +24 -24
  105. package/dist_es/fin5Top/fin5FileUpload.js +47 -47
  106. package/dist_es/fin5Top/fin5Top.d.ts +124 -124
  107. package/dist_es/fin5Top/fin5Top.js +49 -49
  108. package/dist_es/fin5Top/finEdge2Cloud.d.ts +6 -6
  109. package/dist_es/fin5Top/finEdge2Cloud.js +11 -11
  110. package/dist_es/fin5Top/getFin5BinUrl.d.ts +2 -2
  111. package/dist_es/fin5Top/getFin5BinUrl.js +5 -5
  112. package/dist_es/fin5Top/openFin5Alarm.d.ts +22 -22
  113. package/dist_es/fin5Top/openFin5Alarm.js +19 -19
  114. package/dist_es/fin5Top/openFin5Historian.d.ts +3 -3
  115. package/dist_es/fin5Top/openFin5Historian.js +15 -15
  116. package/dist_es/fin5Top/useFin5AppURLHashParameter.d.ts +18 -18
  117. package/dist_es/fin5Top/useFin5AppURLHashParameter.js +124 -124
  118. package/dist_es/index.d.ts +35 -35
  119. package/dist_es/index.js +53 -53
  120. package/dist_es/jobs/jobUtils.d.ts +14 -14
  121. package/dist_es/jobs/jobUtils.js +9 -9
  122. package/dist_es/react/app/Fin5AppContainer.d.ts +36 -36
  123. package/dist_es/react/app/Fin5AppContainer.js +73 -73
  124. package/dist_es/react/app/Fin5AppContainer.jsx +82 -0
  125. package/dist_es/react/app/Fin5AppContainer.jsx.map +1 -0
  126. package/dist_es/react/app/Fin5AppRootStore.d.ts +40 -40
  127. package/dist_es/react/app/Fin5AppRootStore.js +65 -65
  128. package/dist_es/react/components/ErrorBoundary.d.ts +57 -57
  129. package/dist_es/react/components/ErrorBoundary.js +123 -123
  130. package/dist_es/react/components/ErrorBoundary.jsx +150 -0
  131. package/dist_es/react/components/ErrorBoundary.jsx.map +1 -0
  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/ErrorDisplayer.jsx +36 -0
  135. package/dist_es/react/components/ErrorDisplayer.jsx.map +1 -0
  136. package/dist_es/react/components/Loader.d.ts +9 -9
  137. package/dist_es/react/components/Loader.js +12 -12
  138. package/dist_es/react/components/Loader.jsx +13 -0
  139. package/dist_es/react/components/Loader.jsx.map +1 -0
  140. package/dist_es/react/components/LoadingSpinner.d.ts +2 -2
  141. package/dist_es/react/components/LoadingSpinner.js +20 -20
  142. package/dist_es/react/components/LoadingSpinner.jsx +22 -0
  143. package/dist_es/react/components/LoadingSpinner.jsx.map +1 -0
  144. package/dist_es/react/components/RecordImage.d.ts +20 -20
  145. package/dist_es/react/components/RecordImage.js +24 -24
  146. package/dist_es/react/components/charts/QRCode.d.ts +25 -25
  147. package/dist_es/react/components/charts/QRCode.js +52 -52
  148. package/dist_es/react/components/charts/line-bar/Chart.d.ts +166 -166
  149. package/dist_es/react/components/charts/line-bar/Chart.js +415 -415
  150. package/dist_es/react/components/charts/line-bar/HGridChart.d.ts +58 -58
  151. package/dist_es/react/components/charts/line-bar/HGridChart.js +250 -250
  152. package/dist_es/react/components/charts/line-bar/ZincGridChart.d.ts +12 -0
  153. package/dist_es/react/components/charts/line-bar/ZincGridChart.js +17 -0
  154. package/dist_es/react/components/charts/line-bar/ZincGridChart.js.map +1 -0
  155. package/dist_es/react/components/charts/pie/PieChart.d.ts +94 -94
  156. package/dist_es/react/components/charts/pie/PieChart.js +177 -177
  157. package/dist_es/react/components/charts/pie/SimplePieChart.d.ts +21 -21
  158. package/dist_es/react/components/charts/pie/SimplePieChart.js +25 -25
  159. package/dist_es/react/components/graphics/GraphicViewer.d.ts +10 -10
  160. package/dist_es/react/components/graphics/GraphicViewer.js +22 -22
  161. package/dist_es/react/components/graphics/GraphicViewer.jsx +23 -0
  162. package/dist_es/react/components/graphics/GraphicViewer.jsx.map +1 -0
  163. package/dist_es/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  164. package/dist_es/react/components/graphics/GraphicsTabViewer.js +60 -60
  165. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx +63 -0
  166. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx.map +1 -0
  167. package/dist_es/react/components/makeCustomElement.d.ts +16 -16
  168. package/dist_es/react/components/makeCustomElement.js +142 -142
  169. package/dist_es/react/components/navigation/BasicLayout.d.ts +41 -41
  170. package/dist_es/react/components/navigation/BasicLayout.js +124 -124
  171. package/dist_es/react/components/navigation/BasicLayout.jsx +133 -0
  172. package/dist_es/react/components/navigation/BasicLayout.jsx.map +1 -0
  173. package/dist_es/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  174. package/dist_es/react/components/navigation/HeaderSiderLayout.js +80 -80
  175. package/dist_es/react/components/navigation/MenuPage.d.ts +37 -37
  176. package/dist_es/react/components/navigation/MenuPage.js +30 -30
  177. package/dist_es/react/components/navigation/MenuPage.jsx +31 -0
  178. package/dist_es/react/components/navigation/MenuPage.jsx.map +1 -0
  179. package/dist_es/react/components/navigation/MenuTrigger.d.ts +9 -9
  180. package/dist_es/react/components/navigation/MenuTrigger.js +28 -28
  181. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  182. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.js +18 -18
  183. package/dist_es/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  184. package/dist_es/react/components/navigation/ReactRouterLayout.js +99 -99
  185. package/dist_es/react/components/navigation/Router.d.ts +12 -0
  186. package/dist_es/react/components/navigation/Router.js +19 -0
  187. package/dist_es/react/components/navigation/Router.js.map +1 -0
  188. package/dist_es/react/components/navigation/Router.jsx +19 -0
  189. package/dist_es/react/components/navigation/Router.jsx.map +1 -0
  190. package/dist_es/react/components/navigation/customRouting/Router.d.ts +12 -12
  191. package/dist_es/react/components/navigation/customRouting/Router.js +18 -18
  192. package/dist_es/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  193. package/dist_es/react/components/navigation/customRouting/RouterLayout.js +34 -34
  194. package/dist_es/react/components/navigation/react-router/BasicLayout.d.ts +23 -0
  195. package/dist_es/react/components/navigation/react-router/BasicLayout.js +82 -0
  196. package/dist_es/react/components/navigation/react-router/BasicLayout.js.map +1 -0
  197. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.d.ts +24 -0
  198. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js +82 -0
  199. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js.map +1 -0
  200. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  201. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.js +64 -64
  202. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  203. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +58 -58
  204. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  205. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.js +94 -94
  206. package/dist_es/react/hooks/useFin5BinUrl.d.ts +6 -6
  207. package/dist_es/react/hooks/useFin5BinUrl.js +11 -11
  208. package/dist_es/react/hooks/useFin5ColorScheme.d.ts +2 -2
  209. package/dist_es/react/hooks/useFin5ColorScheme.js +45 -45
  210. package/dist_es/react/hooks/useScreenSize.d.ts +7 -7
  211. package/dist_es/react/hooks/useScreenSize.js +27 -27
  212. package/package.json +1 -1
@@ -1,6 +1,6 @@
1
- /**
2
- * Get the URI to register the FIN instance to Edge2Cloud.
3
- * The URI can be used to provide a link, or to create the registration QR code.
4
- * @returns the URI as a string
5
- */
6
- export declare const getEdge2CloudRegistrationUri: () => Promise<string>;
1
+ /**
2
+ * Get the URI to register the FIN instance to Edge2Cloud.
3
+ * The URI can be used to provide a link, or to create the registration QR code.
4
+ * @returns the URI as a string
5
+ */
6
+ export declare const getEdge2CloudRegistrationUri: () => Promise<string>;
@@ -1,16 +1,16 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getEdge2CloudRegistrationUri = void 0;
4
- const haystack_nclient_1 = require("haystack-nclient");
5
- /**
6
- * Get the URI to register the FIN instance to Edge2Cloud.
7
- * The URI can be used to provide a link, or to create the registration QR code.
8
- * @returns the URI as a string
9
- */
10
- const getEdge2CloudRegistrationUri = async () => {
11
- const response = await (0, haystack_nclient_1.finCsrfFetch)('/finEdge2Cloud/devreg');
12
- const json = await response.json();
13
- return json.uri;
14
- };
15
- exports.getEdge2CloudRegistrationUri = getEdge2CloudRegistrationUri;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getEdge2CloudRegistrationUri = void 0;
4
+ const haystack_nclient_1 = require("haystack-nclient");
5
+ /**
6
+ * Get the URI to register the FIN instance to Edge2Cloud.
7
+ * The URI can be used to provide a link, or to create the registration QR code.
8
+ * @returns the URI as a string
9
+ */
10
+ const getEdge2CloudRegistrationUri = async () => {
11
+ const response = await (0, haystack_nclient_1.finCsrfFetch)('/finEdge2Cloud/devreg');
12
+ const json = await response.json();
13
+ return json.uri;
14
+ };
15
+ exports.getEdge2CloudRegistrationUri = getEdge2CloudRegistrationUri;
16
16
  //# sourceMappingURL=finEdge2Cloud.js.map
@@ -1,2 +1,2 @@
1
- import { HRef } from 'haystack-core';
2
- export declare const getFin5BinUrl: (id: HRef, projectName?: string | undefined) => string;
1
+ import { HRef } from 'haystack-core';
2
+ export declare const getFin5BinUrl: (id: HRef, projectName?: string | undefined) => string;
@@ -1,10 +1,10 @@
1
- "use strict";
2
- /*
3
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
4
- */
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.getFin5BinUrl = void 0;
7
- const fin5Top_1 = require("./fin5Top");
8
- const getFin5BinUrl = (id, projectName = fin5Top_1.fin5Top?.finstack?.projectName) => `/finGetFile/${projectName}?fileRef=${id?.toAxon()}`;
9
- exports.getFin5BinUrl = getFin5BinUrl;
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.getFin5BinUrl = void 0;
7
+ const fin5Top_1 = require("./fin5Top");
8
+ const getFin5BinUrl = (id, projectName = fin5Top_1.fin5Top?.finstack?.projectName) => `/finGetFile/${projectName}?fileRef=${id?.toAxon()}`;
9
+ exports.getFin5BinUrl = getFin5BinUrl;
10
10
  //# sourceMappingURL=getFin5BinUrl.js.map
@@ -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,24 +1,24 @@
1
- "use strict";
2
- /*
3
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
4
- */
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.openFin5AlarmsApp = void 0;
7
- //////////////////////////////////////////////////////////////////////////
8
- // Alarms
9
- //////////////////////////////////////////////////////////////////////////
10
- const fin5Top_1 = require("./fin5Top");
11
- const openFin5AlarmsApp = async ({ targetRef, filter, historical = false, }) => {
12
- await fin5Top_1.fin5Top?.app.NavigateToApp(fin5Top_1.fin5Top?.app?.APP_NAMES?.ALARMS, targetRef);
13
- fin5Top_1.fin5Top?.app.ToggleCollapse(false);
14
- let alarmFilters = fin5Top_1.fin5Top?.app?.GetAlarmFilters() ?? {};
15
- if (filter) {
16
- alarmFilters = {
17
- ...alarmFilters,
18
- ...filter,
19
- };
20
- }
21
- fin5Top_1.fin5Top?.app?.SetAlarmFilters(alarmFilters, historical);
22
- };
23
- exports.openFin5AlarmsApp = openFin5AlarmsApp;
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.openFin5AlarmsApp = void 0;
7
+ //////////////////////////////////////////////////////////////////////////
8
+ // Alarms
9
+ //////////////////////////////////////////////////////////////////////////
10
+ const fin5Top_1 = require("./fin5Top");
11
+ const openFin5AlarmsApp = async ({ targetRef, filter, historical = false, }) => {
12
+ await fin5Top_1.fin5Top?.app.NavigateToApp(fin5Top_1.fin5Top?.app?.APP_NAMES?.ALARMS, targetRef);
13
+ fin5Top_1.fin5Top?.app.ToggleCollapse(false);
14
+ let alarmFilters = fin5Top_1.fin5Top?.app?.GetAlarmFilters() ?? {};
15
+ if (filter) {
16
+ alarmFilters = {
17
+ ...alarmFilters,
18
+ ...filter,
19
+ };
20
+ }
21
+ fin5Top_1.fin5Top?.app?.SetAlarmFilters(alarmFilters, historical);
22
+ };
23
+ exports.openFin5AlarmsApp = openFin5AlarmsApp;
24
24
  //# 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,20 +1,20 @@
1
- "use strict";
2
- /*
3
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
4
- */
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.openFin5HistorianApp = void 0;
7
- //////////////////////////////////////////////////////////////////////////
8
- // Historian
9
- //////////////////////////////////////////////////////////////////////////
10
- const fin5Top_1 = require("./fin5Top");
11
- const openFin5HistorianApp = async (queryType, args) => {
12
- if (fin5Top_1.fin5Top) {
13
- queryType && args
14
- ? fin5Top_1.fin5Top.app.OpenHistorianWithOptions(queryType, args)
15
- : fin5Top_1.fin5Top.app.NavigateToApp(fin5Top_1.fin5Top.app.APP_NAMES.TREND_LIST);
16
- fin5Top_1.fin5Top?.app.ToggleCollapse(false);
17
- }
18
- };
19
- exports.openFin5HistorianApp = openFin5HistorianApp;
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.openFin5HistorianApp = void 0;
7
+ //////////////////////////////////////////////////////////////////////////
8
+ // Historian
9
+ //////////////////////////////////////////////////////////////////////////
10
+ const fin5Top_1 = require("./fin5Top");
11
+ const openFin5HistorianApp = async (queryType, args) => {
12
+ if (fin5Top_1.fin5Top) {
13
+ queryType && args
14
+ ? fin5Top_1.fin5Top.app.OpenHistorianWithOptions(queryType, args)
15
+ : fin5Top_1.fin5Top.app.NavigateToApp(fin5Top_1.fin5Top.app.APP_NAMES.TREND_LIST);
16
+ fin5Top_1.fin5Top?.app.ToggleCollapse(false);
17
+ }
18
+ };
19
+ exports.openFin5HistorianApp = openFin5HistorianApp;
20
20
  //# 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,134 +1,134 @@
1
- "use strict";
2
- /*
3
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
4
- */
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.useFin5AppURLHashParameters = exports.useFin5AppURLHashParameter = exports.getHashParameters = exports.fin5SkipHashUpdate = exports.getFin5HashFrameParameters = exports.getTopLocation = exports.IN_IFRAME = void 0;
7
- const react_1 = require("react");
8
- const fin5Top_1 = require("./fin5Top");
9
- exports.IN_IFRAME = window !== top && (0, fin5Top_1.isWindowTopFin5)();
10
- const getTop = () => window.top ?? window;
11
- const getApp = () => getTop()?.app;
12
- const getTopLocation = () => getTop().location;
13
- exports.getTopLocation = getTopLocation;
14
- const getFin5HashFrameParameters = () => new URLSearchParams((0, exports.getTopLocation)().hash.slice(1).split('?')[1]);
15
- exports.getFin5HashFrameParameters = getFin5HashFrameParameters;
16
- const getFin5FrameURL = () => (0, exports.getFin5HashFrameParameters)().get('url');
17
- const getPartialURLHashFragment = (url) => `#${url?.split('#')[1] ?? ''}`;
18
- const getHash = () => {
19
- return exports.IN_IFRAME
20
- ? getPartialURLHashFragment(getFin5FrameURL())
21
- : window.location.hash;
22
- };
23
- const fin5SkipHashUpdate = () => getApp()?.set('skipHashUpdate', true);
24
- exports.fin5SkipHashUpdate = fin5SkipHashUpdate;
25
- const setHash = (hash) => {
26
- if (exports.IN_IFRAME) {
27
- return (0, exports.fin5SkipHashUpdate)()?.then(() => {
28
- const frameParameters = (0, exports.getFin5HashFrameParameters)();
29
- frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash);
30
- (0, exports.getTopLocation)().hash = `#${(0, exports.getTopLocation)().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
31
- });
32
- }
33
- else {
34
- window.location.hash = hash;
35
- return Promise.resolve();
36
- }
37
- };
38
- const getHashParameters = () => new URLSearchParams(getHash().slice(1));
39
- exports.getHashParameters = getHashParameters;
40
- /**
41
- * Use a parameter in the hash of a custom app running in FIN 5 as state.
42
- * @param name parameter name.
43
- * @param initialState initial state used if the parameter is not defined.
44
- * @returns the parameter value and a function to update it.
45
- */
46
- const useFin5AppURLHashParameter = (name, initialState) => {
47
- const [paramValue, setParamValue] = (0, react_1.useState)((0, exports.getHashParameters)()?.get(name) ?? undefined);
48
- const setHashParameter = async (value) => {
49
- const params = (0, exports.getHashParameters)();
50
- if (params.get(name) !== value) {
51
- if (value === '' || value == null) {
52
- params.delete(name);
53
- }
54
- else {
55
- params?.set(name, value);
56
- }
57
- await setHash(params?.toString());
58
- setParamValue(value);
59
- }
60
- };
61
- (0, react_1.useEffect)(() => {
62
- if (!(0, exports.getHashParameters)()?.has(name) && initialState) {
63
- setHashParameter(initialState);
64
- }
65
- }, []);
66
- (0, react_1.useEffect)(() => {
67
- const onHashChange = () => {
68
- setParamValue((0, exports.getHashParameters)()?.get(name) ?? undefined);
69
- };
70
- if (exports.IN_IFRAME) {
71
- getTop().addEventListener('hashchange', onHashChange);
72
- return () => {
73
- getTop().removeEventListener('hashchange', onHashChange);
74
- };
75
- }
76
- return () => {
77
- return;
78
- };
79
- }, []);
80
- return [paramValue, setHashParameter];
81
- };
82
- exports.useFin5AppURLHashParameter = useFin5AppURLHashParameter;
83
- /**
84
- * Use all the parameters in the hash of a custom app running in FIN 5 as state.
85
- * @param parameters the initial (optional) values for the parameters
86
- * @returns the URL parameters and a function to patch the parameters.
87
- */
88
- const useFin5AppURLHashParameters = (parameters) => {
89
- const [paramValues, setParamValues] = (0, react_1.useState)((0, exports.getHashParameters)());
90
- // Patch the parameters: this updates just the URL parameters passed.
91
- // If there is a parameter in the hash and not in the function arg, that is left untouched.
92
- // To remove a parameter in the hash, set it to null or empty string.
93
- const setHashParameters = async (paramsToUpdate) => {
94
- const params = (0, exports.getHashParameters)();
95
- Array.from(paramsToUpdate.entries()).forEach(([paramKey, newParamValue]) => {
96
- if (newParamValue !== params.get(paramKey)) {
97
- if (newParamValue == null || newParamValue === '') {
98
- params.delete(paramKey);
99
- }
100
- else {
101
- params.set(paramKey, newParamValue);
102
- }
103
- }
104
- });
105
- await setHash(params.toString());
106
- setParamValues(params);
107
- };
108
- // Initial setup.
109
- (0, react_1.useEffect)(() => {
110
- const hashParameters = (0, exports.getHashParameters)();
111
- if (parameters) {
112
- Array.from(parameters.entries()).forEach(([paramKey, paramValue]) => {
113
- if (!hashParameters.has(paramKey) &&
114
- paramValue != null &&
115
- paramValue !== '') {
116
- hashParameters.set(paramKey, paramValue);
117
- }
118
- });
119
- setHashParameters(hashParameters);
120
- }
121
- }, []);
122
- (0, react_1.useEffect)(() => {
123
- const onHashChange = () => {
124
- setParamValues((0, exports.getHashParameters)());
125
- };
126
- getTop().addEventListener('hashchange', onHashChange);
127
- return () => {
128
- getTop().removeEventListener('hashchange', onHashChange);
129
- };
130
- }, []);
131
- return [paramValues, setHashParameters];
132
- };
133
- exports.useFin5AppURLHashParameters = useFin5AppURLHashParameters;
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.useFin5AppURLHashParameters = exports.useFin5AppURLHashParameter = exports.getHashParameters = exports.fin5SkipHashUpdate = exports.getFin5HashFrameParameters = exports.getTopLocation = exports.IN_IFRAME = void 0;
7
+ const react_1 = require("react");
8
+ const fin5Top_1 = require("./fin5Top");
9
+ exports.IN_IFRAME = window !== top && (0, fin5Top_1.isWindowTopFin5)();
10
+ const getTop = () => window.top ?? window;
11
+ const getApp = () => getTop()?.app;
12
+ const getTopLocation = () => getTop().location;
13
+ exports.getTopLocation = getTopLocation;
14
+ const getFin5HashFrameParameters = () => new URLSearchParams((0, exports.getTopLocation)().hash.slice(1).split('?')[1]);
15
+ exports.getFin5HashFrameParameters = getFin5HashFrameParameters;
16
+ const getFin5FrameURL = () => (0, exports.getFin5HashFrameParameters)().get('url');
17
+ const getPartialURLHashFragment = (url) => `#${url?.split('#')[1] ?? ''}`;
18
+ const getHash = () => {
19
+ return exports.IN_IFRAME
20
+ ? getPartialURLHashFragment(getFin5FrameURL())
21
+ : window.location.hash;
22
+ };
23
+ const fin5SkipHashUpdate = () => getApp()?.set('skipHashUpdate', true);
24
+ exports.fin5SkipHashUpdate = fin5SkipHashUpdate;
25
+ const setHash = (hash) => {
26
+ if (exports.IN_IFRAME) {
27
+ return (0, exports.fin5SkipHashUpdate)()?.then(() => {
28
+ const frameParameters = (0, exports.getFin5HashFrameParameters)();
29
+ frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash);
30
+ (0, exports.getTopLocation)().hash = `#${(0, exports.getTopLocation)().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
31
+ });
32
+ }
33
+ else {
34
+ window.location.hash = hash;
35
+ return Promise.resolve();
36
+ }
37
+ };
38
+ const getHashParameters = () => new URLSearchParams(getHash().slice(1));
39
+ exports.getHashParameters = getHashParameters;
40
+ /**
41
+ * Use a parameter in the hash of a custom app running in FIN 5 as state.
42
+ * @param name parameter name.
43
+ * @param initialState initial state used if the parameter is not defined.
44
+ * @returns the parameter value and a function to update it.
45
+ */
46
+ const useFin5AppURLHashParameter = (name, initialState) => {
47
+ const [paramValue, setParamValue] = (0, react_1.useState)((0, exports.getHashParameters)()?.get(name) ?? undefined);
48
+ const setHashParameter = async (value) => {
49
+ const params = (0, exports.getHashParameters)();
50
+ if (params.get(name) !== value) {
51
+ if (value === '' || value == null) {
52
+ params.delete(name);
53
+ }
54
+ else {
55
+ params?.set(name, value);
56
+ }
57
+ await setHash(params?.toString());
58
+ setParamValue(value);
59
+ }
60
+ };
61
+ (0, react_1.useEffect)(() => {
62
+ if (!(0, exports.getHashParameters)()?.has(name) && initialState) {
63
+ setHashParameter(initialState);
64
+ }
65
+ }, []);
66
+ (0, react_1.useEffect)(() => {
67
+ const onHashChange = () => {
68
+ setParamValue((0, exports.getHashParameters)()?.get(name) ?? undefined);
69
+ };
70
+ if (exports.IN_IFRAME) {
71
+ getTop().addEventListener('hashchange', onHashChange);
72
+ return () => {
73
+ getTop().removeEventListener('hashchange', onHashChange);
74
+ };
75
+ }
76
+ return () => {
77
+ return;
78
+ };
79
+ }, []);
80
+ return [paramValue, setHashParameter];
81
+ };
82
+ exports.useFin5AppURLHashParameter = useFin5AppURLHashParameter;
83
+ /**
84
+ * Use all the parameters in the hash of a custom app running in FIN 5 as state.
85
+ * @param parameters the initial (optional) values for the parameters
86
+ * @returns the URL parameters and a function to patch the parameters.
87
+ */
88
+ const useFin5AppURLHashParameters = (parameters) => {
89
+ const [paramValues, setParamValues] = (0, react_1.useState)((0, exports.getHashParameters)());
90
+ // Patch the parameters: this updates just the URL parameters passed.
91
+ // If there is a parameter in the hash and not in the function arg, that is left untouched.
92
+ // To remove a parameter in the hash, set it to null or empty string.
93
+ const setHashParameters = async (paramsToUpdate) => {
94
+ const params = (0, exports.getHashParameters)();
95
+ Array.from(paramsToUpdate.entries()).forEach(([paramKey, newParamValue]) => {
96
+ if (newParamValue !== params.get(paramKey)) {
97
+ if (newParamValue == null || newParamValue === '') {
98
+ params.delete(paramKey);
99
+ }
100
+ else {
101
+ params.set(paramKey, newParamValue);
102
+ }
103
+ }
104
+ });
105
+ await setHash(params.toString());
106
+ setParamValues(params);
107
+ };
108
+ // Initial setup.
109
+ (0, react_1.useEffect)(() => {
110
+ const hashParameters = (0, exports.getHashParameters)();
111
+ if (parameters) {
112
+ Array.from(parameters.entries()).forEach(([paramKey, paramValue]) => {
113
+ if (!hashParameters.has(paramKey) &&
114
+ paramValue != null &&
115
+ paramValue !== '') {
116
+ hashParameters.set(paramKey, paramValue);
117
+ }
118
+ });
119
+ setHashParameters(hashParameters);
120
+ }
121
+ }, []);
122
+ (0, react_1.useEffect)(() => {
123
+ const onHashChange = () => {
124
+ setParamValues((0, exports.getHashParameters)());
125
+ };
126
+ getTop().addEventListener('hashchange', onHashChange);
127
+ return () => {
128
+ getTop().removeEventListener('hashchange', onHashChange);
129
+ };
130
+ }, []);
131
+ return [paramValues, setHashParameters];
132
+ };
133
+ exports.useFin5AppURLHashParameters = useFin5AppURLHashParameters;
134
134
  //# sourceMappingURL=useFin5AppURLHashParameter.js.map
package/dist/index.d.ts CHANGED
@@ -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';