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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (210) hide show
  1. package/README.md +5 -5
  2. package/dist/fantomProps/createFin5Props/index.d.ts +12 -12
  3. package/dist/fantomProps/createFin5Props/index.js +146 -146
  4. package/dist/fantomProps/createFin5Props/runCreateFin5Props.d.ts +2 -2
  5. package/dist/fantomProps/createFin5Props/runCreateFin5Props.js +20 -20
  6. package/dist/fantomProps/fantomPropsToObject.d.ts +8 -8
  7. package/dist/fantomProps/fantomPropsToObject.js +183 -183
  8. package/dist/fantomProps/generateJsonFromFantomPropsFile.d.ts +4 -4
  9. package/dist/fantomProps/generateJsonFromFantomPropsFile.js +41 -41
  10. package/dist/fantomProps/localePropsToJson.d.ts +1 -1
  11. package/dist/fantomProps/localePropsToJson.js +50 -50
  12. package/dist/fantomProps/readFantomPropsFile.d.ts +5 -5
  13. package/dist/fantomProps/readFantomPropsFile.js +65 -65
  14. package/dist/fin5Top/fin5FileUpload.d.ts +24 -24
  15. package/dist/fin5Top/fin5FileUpload.js +51 -51
  16. package/dist/fin5Top/fin5Top.d.ts +165 -165
  17. package/dist/fin5Top/fin5Top.js +61 -61
  18. package/dist/fin5Top/finEdge2Cloud.d.ts +6 -6
  19. package/dist/fin5Top/finEdge2Cloud.js +15 -15
  20. package/dist/fin5Top/getFin5BinUrl.d.ts +2 -2
  21. package/dist/fin5Top/getFin5BinUrl.js +9 -9
  22. package/dist/fin5Top/openFin5Alarm.d.ts +22 -22
  23. package/dist/fin5Top/openFin5Alarm.js +23 -23
  24. package/dist/fin5Top/openFin5Historian.d.ts +3 -3
  25. package/dist/fin5Top/openFin5Historian.js +19 -19
  26. package/dist/fin5Top/useFin5AppURLHashParameter.d.ts +18 -18
  27. package/dist/fin5Top/useFin5AppURLHashParameter.js +133 -133
  28. package/dist/index.d.ts +35 -35
  29. package/dist/index.js +69 -69
  30. package/dist/jobs/jobUtils.d.ts +14 -14
  31. package/dist/jobs/jobUtils.js +15 -15
  32. package/dist/react/app/Fin5AppContainer.d.ts +36 -36
  33. package/dist/react/app/Fin5AppContainer.js +145 -145
  34. package/dist/react/app/Fin5AppRootStore.d.ts +40 -40
  35. package/dist/react/app/Fin5AppRootStore.js +90 -90
  36. package/dist/react/components/ErrorBoundary.d.ts +57 -57
  37. package/dist/react/components/ErrorBoundary.js +150 -150
  38. package/dist/react/components/ErrorDisplayer.d.ts +19 -19
  39. package/dist/react/components/ErrorDisplayer.js +36 -36
  40. package/dist/react/components/Loader.d.ts +9 -9
  41. package/dist/react/components/Loader.js +17 -17
  42. package/dist/react/components/LoadingSpinner.d.ts +2 -2
  43. package/dist/react/components/LoadingSpinner.js +27 -27
  44. package/dist/react/components/RecordImage.d.ts +20 -20
  45. package/dist/react/components/RecordImage.js +51 -51
  46. package/dist/react/components/charts/QRCode.d.ts +25 -25
  47. package/dist/react/components/charts/QRCode.js +82 -82
  48. package/dist/react/components/charts/line-bar/Chart.d.ts +166 -166
  49. package/dist/react/components/charts/line-bar/Chart.js +442 -442
  50. package/dist/react/components/charts/line-bar/HGridChart.d.ts +58 -58
  51. package/dist/react/components/charts/line-bar/HGridChart.js +285 -285
  52. package/dist/react/components/charts/pie/PieChart.d.ts +94 -94
  53. package/dist/react/components/charts/pie/PieChart.js +204 -204
  54. package/dist/react/components/charts/pie/SimplePieChart.d.ts +21 -21
  55. package/dist/react/components/charts/pie/SimplePieChart.js +55 -55
  56. package/dist/react/components/graphics/GraphicViewer.d.ts +10 -10
  57. package/dist/react/components/graphics/GraphicViewer.js +29 -29
  58. package/dist/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  59. package/dist/react/components/graphics/GraphicsTabViewer.js +90 -90
  60. package/dist/react/components/makeCustomElement.d.ts +16 -16
  61. package/dist/react/components/makeCustomElement.js +150 -150
  62. package/dist/react/components/navigation/BasicLayout.d.ts +41 -41
  63. package/dist/react/components/navigation/BasicLayout.js +155 -155
  64. package/dist/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  65. package/dist/react/components/navigation/HeaderSiderLayout.js +110 -110
  66. package/dist/react/components/navigation/MenuPage.d.ts +37 -37
  67. package/dist/react/components/navigation/MenuPage.js +36 -36
  68. package/dist/react/components/navigation/MenuTrigger.d.ts +9 -9
  69. package/dist/react/components/navigation/MenuTrigger.js +33 -33
  70. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  71. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.js +25 -25
  72. package/dist/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  73. package/dist/react/components/navigation/ReactRouterLayout.js +132 -132
  74. package/dist/react/components/navigation/customRouting/Router.d.ts +12 -12
  75. package/dist/react/components/navigation/customRouting/Router.js +45 -45
  76. package/dist/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  77. package/dist/react/components/navigation/customRouting/RouterLayout.js +61 -61
  78. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  79. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.js +95 -95
  80. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  81. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +88 -88
  82. package/dist/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  83. package/dist/react/components/resolvable/configurationForm/getSectionDefault.js +99 -99
  84. package/dist/react/hooks/useFin5BinUrl.d.ts +6 -6
  85. package/dist/react/hooks/useFin5BinUrl.js +15 -15
  86. package/dist/react/hooks/useFin5ColorScheme.d.ts +2 -2
  87. package/dist/react/hooks/useFin5ColorScheme.js +56 -56
  88. package/dist/react/hooks/useScreenSize.d.ts +7 -7
  89. package/dist/react/hooks/useScreenSize.js +31 -31
  90. package/dist_es/fantomProps/createFin5Props/index.d.ts +12 -12
  91. package/dist_es/fantomProps/createFin5Props/index.js +140 -140
  92. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.d.ts +2 -2
  93. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.js +15 -15
  94. package/dist_es/fantomProps/fantomPropsToObject.d.ts +8 -8
  95. package/dist_es/fantomProps/fantomPropsToObject.js +178 -178
  96. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.d.ts +4 -4
  97. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.js +12 -12
  98. package/dist_es/fantomProps/localePropsToJson.d.ts +1 -1
  99. package/dist_es/fantomProps/localePropsToJson.js +21 -21
  100. package/dist_es/fantomProps/readFantomPropsFile.d.ts +5 -5
  101. package/dist_es/fantomProps/readFantomPropsFile.js +39 -39
  102. package/dist_es/fin5Top/fin5FileUpload.d.ts +24 -24
  103. package/dist_es/fin5Top/fin5FileUpload.js +47 -47
  104. package/dist_es/fin5Top/fin5Top.d.ts +165 -165
  105. package/dist_es/fin5Top/fin5Top.js +57 -57
  106. package/dist_es/fin5Top/finEdge2Cloud.d.ts +6 -6
  107. package/dist_es/fin5Top/finEdge2Cloud.js +11 -11
  108. package/dist_es/fin5Top/getFin5BinUrl.d.ts +2 -2
  109. package/dist_es/fin5Top/getFin5BinUrl.js +5 -5
  110. package/dist_es/fin5Top/openFin5Alarm.d.ts +22 -22
  111. package/dist_es/fin5Top/openFin5Alarm.js +19 -19
  112. package/dist_es/fin5Top/openFin5Historian.d.ts +3 -3
  113. package/dist_es/fin5Top/openFin5Historian.js +15 -15
  114. package/dist_es/fin5Top/useFin5AppURLHashParameter.d.ts +18 -18
  115. package/dist_es/fin5Top/useFin5AppURLHashParameter.js +124 -124
  116. package/dist_es/index.d.ts +35 -35
  117. package/dist_es/index.js +53 -53
  118. package/dist_es/jobs/jobUtils.d.ts +14 -14
  119. package/dist_es/jobs/jobUtils.js +9 -9
  120. package/dist_es/react/app/Fin5AppContainer.d.ts +36 -36
  121. package/dist_es/react/app/Fin5AppContainer.js +116 -116
  122. package/dist_es/react/app/Fin5AppRootStore.d.ts +40 -40
  123. package/dist_es/react/app/Fin5AppRootStore.js +86 -86
  124. package/dist_es/react/components/ErrorBoundary.d.ts +57 -57
  125. package/dist_es/react/components/ErrorBoundary.js +123 -123
  126. package/dist_es/react/components/ErrorDisplayer.d.ts +19 -19
  127. package/dist_es/react/components/ErrorDisplayer.js +28 -28
  128. package/dist_es/react/components/Loader.d.ts +9 -9
  129. package/dist_es/react/components/Loader.js +12 -12
  130. package/dist_es/react/components/LoadingSpinner.d.ts +2 -2
  131. package/dist_es/react/components/LoadingSpinner.js +20 -20
  132. package/dist_es/react/components/RecordImage.d.ts +20 -20
  133. package/dist_es/react/components/RecordImage.js +24 -24
  134. package/dist_es/react/components/charts/QRCode.d.ts +25 -25
  135. package/dist_es/react/components/charts/QRCode.js +52 -52
  136. package/dist_es/react/components/charts/line-bar/Chart.d.ts +166 -166
  137. package/dist_es/react/components/charts/line-bar/Chart.js +415 -415
  138. package/dist_es/react/components/charts/line-bar/HGridChart.d.ts +58 -58
  139. package/dist_es/react/components/charts/line-bar/HGridChart.js +250 -250
  140. package/dist_es/react/components/charts/pie/PieChart.d.ts +94 -94
  141. package/dist_es/react/components/charts/pie/PieChart.js +177 -177
  142. package/dist_es/react/components/charts/pie/SimplePieChart.d.ts +21 -21
  143. package/dist_es/react/components/charts/pie/SimplePieChart.js +25 -25
  144. package/dist_es/react/components/graphics/GraphicViewer.d.ts +10 -10
  145. package/dist_es/react/components/graphics/GraphicViewer.js +22 -22
  146. package/dist_es/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  147. package/dist_es/react/components/graphics/GraphicsTabViewer.js +60 -60
  148. package/dist_es/react/components/makeCustomElement.d.ts +16 -16
  149. package/dist_es/react/components/makeCustomElement.js +142 -142
  150. package/dist_es/react/components/navigation/BasicLayout.d.ts +41 -41
  151. package/dist_es/react/components/navigation/BasicLayout.js +124 -124
  152. package/dist_es/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  153. package/dist_es/react/components/navigation/HeaderSiderLayout.js +80 -80
  154. package/dist_es/react/components/navigation/MenuPage.d.ts +37 -37
  155. package/dist_es/react/components/navigation/MenuPage.js +30 -30
  156. package/dist_es/react/components/navigation/MenuTrigger.d.ts +9 -9
  157. package/dist_es/react/components/navigation/MenuTrigger.js +28 -28
  158. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  159. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.js +18 -18
  160. package/dist_es/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  161. package/dist_es/react/components/navigation/ReactRouterLayout.js +99 -99
  162. package/dist_es/react/components/navigation/customRouting/Router.d.ts +12 -12
  163. package/dist_es/react/components/navigation/customRouting/Router.js +18 -18
  164. package/dist_es/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  165. package/dist_es/react/components/navigation/customRouting/RouterLayout.js +34 -34
  166. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  167. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.js +64 -64
  168. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  169. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +58 -58
  170. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  171. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.js +94 -94
  172. package/dist_es/react/hooks/useFin5BinUrl.d.ts +6 -6
  173. package/dist_es/react/hooks/useFin5BinUrl.js +11 -11
  174. package/dist_es/react/hooks/useFin5ColorScheme.d.ts +2 -2
  175. package/dist_es/react/hooks/useFin5ColorScheme.js +52 -52
  176. package/dist_es/react/hooks/useScreenSize.d.ts +7 -7
  177. package/dist_es/react/hooks/useScreenSize.js +27 -27
  178. package/package.json +1 -1
  179. package/dist_es/react/app/Fin5AppContainer.jsx +0 -82
  180. package/dist_es/react/app/Fin5AppContainer.jsx.map +0 -1
  181. package/dist_es/react/components/ErrorBoundary.jsx +0 -150
  182. package/dist_es/react/components/ErrorBoundary.jsx.map +0 -1
  183. package/dist_es/react/components/ErrorDisplayer.jsx +0 -36
  184. package/dist_es/react/components/ErrorDisplayer.jsx.map +0 -1
  185. package/dist_es/react/components/Loader.jsx +0 -13
  186. package/dist_es/react/components/Loader.jsx.map +0 -1
  187. package/dist_es/react/components/LoadingSpinner.jsx +0 -22
  188. package/dist_es/react/components/LoadingSpinner.jsx.map +0 -1
  189. package/dist_es/react/components/charts/line-bar/ZincGridChart.d.ts +0 -12
  190. package/dist_es/react/components/charts/line-bar/ZincGridChart.js +0 -17
  191. package/dist_es/react/components/charts/line-bar/ZincGridChart.js.map +0 -1
  192. package/dist_es/react/components/graphics/GraphicViewer.jsx +0 -23
  193. package/dist_es/react/components/graphics/GraphicViewer.jsx.map +0 -1
  194. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx +0 -63
  195. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx.map +0 -1
  196. package/dist_es/react/components/navigation/BasicLayout.jsx +0 -133
  197. package/dist_es/react/components/navigation/BasicLayout.jsx.map +0 -1
  198. package/dist_es/react/components/navigation/MenuPage.jsx +0 -31
  199. package/dist_es/react/components/navigation/MenuPage.jsx.map +0 -1
  200. package/dist_es/react/components/navigation/Router.d.ts +0 -12
  201. package/dist_es/react/components/navigation/Router.js +0 -19
  202. package/dist_es/react/components/navigation/Router.js.map +0 -1
  203. package/dist_es/react/components/navigation/Router.jsx +0 -19
  204. package/dist_es/react/components/navigation/Router.jsx.map +0 -1
  205. package/dist_es/react/components/navigation/react-router/BasicLayout.d.ts +0 -23
  206. package/dist_es/react/components/navigation/react-router/BasicLayout.js +0 -82
  207. package/dist_es/react/components/navigation/react-router/BasicLayout.js.map +0 -1
  208. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.d.ts +0 -24
  209. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js +0 -82
  210. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js.map +0 -1
@@ -1,66 +1,66 @@
1
- "use strict";
2
- /*
3
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
4
- */
5
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
- if (k2 === undefined) k2 = k;
7
- var desc = Object.getOwnPropertyDescriptor(m, k);
8
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
- desc = { enumerable: true, get: function() { return m[k]; } };
10
- }
11
- Object.defineProperty(o, k2, desc);
12
- }) : (function(o, m, k, k2) {
13
- if (k2 === undefined) k2 = k;
14
- o[k2] = m[k];
15
- }));
16
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
- Object.defineProperty(o, "default", { enumerable: true, value: v });
18
- }) : function(o, v) {
19
- o["default"] = v;
20
- });
21
- var __importStar = (this && this.__importStar) || function (mod) {
22
- if (mod && mod.__esModule) return mod;
23
- var result = {};
24
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
- __setModuleDefault(result, mod);
26
- return result;
27
- };
28
- Object.defineProperty(exports, "__esModule", { value: true });
29
- const fs = __importStar(require("fs"));
30
- const fantomPropsToObject_1 = require("./fantomPropsToObject");
31
- /**
32
- * Synchronously read the given Fantom props file to JS object (@see https://fantom.org/doc/sys/InStream#readProps)
33
- */
34
- function readFantomPropsFile(path) {
35
- return new Promise((resolve, reject) => {
36
- fs.readFile(path, (err, fileBuffer) => {
37
- if (err) {
38
- return reject(err);
39
- }
40
- let bufferIndex = 0;
41
- const bufferLength = fileBuffer.length;
42
- const unreadBuffer = []; // Stack to handle unreadChar operations
43
- const readChar = () => {
44
- if (unreadBuffer.length > 0) {
45
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
46
- return unreadBuffer.pop();
47
- }
48
- if (bufferIndex < bufferLength) {
49
- return fileBuffer[bufferIndex++];
50
- }
51
- return -1;
52
- };
53
- const unreadChar = (char) => {
54
- unreadBuffer.push(char);
55
- };
56
- try {
57
- resolve((0, fantomPropsToObject_1.parseFantomProps)(readChar, unreadChar));
58
- }
59
- catch (error) {
60
- reject(error);
61
- }
62
- });
63
- });
64
- }
65
- exports.default = readFantomPropsFile;
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ const fs = __importStar(require("fs"));
30
+ const fantomPropsToObject_1 = require("./fantomPropsToObject");
31
+ /**
32
+ * Synchronously read the given Fantom props file to JS object (@see https://fantom.org/doc/sys/InStream#readProps)
33
+ */
34
+ function readFantomPropsFile(path) {
35
+ return new Promise((resolve, reject) => {
36
+ fs.readFile(path, (err, fileBuffer) => {
37
+ if (err) {
38
+ return reject(err);
39
+ }
40
+ let bufferIndex = 0;
41
+ const bufferLength = fileBuffer.length;
42
+ const unreadBuffer = []; // Stack to handle unreadChar operations
43
+ const readChar = () => {
44
+ if (unreadBuffer.length > 0) {
45
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
46
+ return unreadBuffer.pop();
47
+ }
48
+ if (bufferIndex < bufferLength) {
49
+ return fileBuffer[bufferIndex++];
50
+ }
51
+ return -1;
52
+ };
53
+ const unreadChar = (char) => {
54
+ unreadBuffer.push(char);
55
+ };
56
+ try {
57
+ resolve((0, fantomPropsToObject_1.parseFantomProps)(readChar, unreadChar));
58
+ }
59
+ catch (error) {
60
+ reject(error);
61
+ }
62
+ });
63
+ });
64
+ }
65
+ exports.default = readFantomPropsFile;
66
66
  //# sourceMappingURL=readFantomPropsFile.js.map
@@ -1,24 +1,24 @@
1
- import { HDict } from 'haystack-core';
2
- /**
3
- * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
4
- * @param projectName The name of the project where the files will be uploaded
5
- * @param file The File to upload
6
- * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
7
- * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
8
- * @returns the file record as an HDict
9
- * @example
10
- * <input type='file' onChange={async (e) => {
11
- * const file = e.target.files?.[0]
12
- * if (file) {
13
- * const params = new URLSearchParams()
14
- * params.set('myMarker', 'true')
15
- * params.set('myStrTag', 'abc')
16
- * const rec = await fin5FileUpload(
17
- * 'myprojectname',
18
- * file,
19
- * params
20
- * )
21
- * }
22
- * }} />
23
- */
24
- export declare const fin5FileUpload: (projectName: string, file: File, additionalTags?: URLSearchParams) => Promise<HDict>;
1
+ import { HDict } from 'haystack-core';
2
+ /**
3
+ * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
4
+ * @param projectName The name of the project where the files will be uploaded
5
+ * @param file The File to upload
6
+ * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
7
+ * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
8
+ * @returns the file record as an HDict
9
+ * @example
10
+ * <input type='file' onChange={async (e) => {
11
+ * const file = e.target.files?.[0]
12
+ * if (file) {
13
+ * const params = new URLSearchParams()
14
+ * params.set('myMarker', 'true')
15
+ * params.set('myStrTag', 'abc')
16
+ * const rec = await fin5FileUpload(
17
+ * 'myprojectname',
18
+ * file,
19
+ * params
20
+ * )
21
+ * }
22
+ * }} />
23
+ */
24
+ export declare const fin5FileUpload: (projectName: string, file: File, additionalTags?: URLSearchParams) => Promise<HDict>;
@@ -1,52 +1,52 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.fin5FileUpload = void 0;
4
- const haystack_core_1 = require("haystack-core");
5
- const haystack_nclient_1 = require("haystack-nclient");
6
- /**
7
- * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
8
- * @param projectName The name of the project where the files will be uploaded
9
- * @param file The File to upload
10
- * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
11
- * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
12
- * @returns the file record as an HDict
13
- * @example
14
- * <input type='file' onChange={async (e) => {
15
- * const file = e.target.files?.[0]
16
- * if (file) {
17
- * const params = new URLSearchParams()
18
- * params.set('myMarker', 'true')
19
- * params.set('myStrTag', 'abc')
20
- * const rec = await fin5FileUpload(
21
- * 'myprojectname',
22
- * file,
23
- * params
24
- * )
25
- * }
26
- * }} />
27
- */
28
- const fin5FileUpload = async (projectName, file, additionalTags = new URLSearchParams()) => {
29
- if (!additionalTags.has('dis')) {
30
- additionalTags.set('dis', file.name);
31
- }
32
- // URL base (http://localhost) will be ignored, it's just needed to build the URL
33
- const url = new URL(`/api/${projectName}/ext/finstack/fileUpload`, 'http://localhost');
34
- additionalTags.forEach((value, name) => url.searchParams.set(name, value));
35
- const content = await file.arrayBuffer();
36
- const response = await (0, haystack_nclient_1.finCsrfFetch)(`${url.pathname}${url.search}`, {
37
- method: 'POST',
38
- headers: {
39
- 'Content-Type': 'application/octet-stream',
40
- },
41
- body: new Uint8Array(content),
42
- });
43
- const zincReader = new haystack_core_1.ZincReader(await response.text());
44
- const grid = zincReader.readValue();
45
- const dict = grid.first;
46
- if (!dict) {
47
- throw new Error('Unexpected response, no record found');
48
- }
49
- return dict;
50
- };
51
- exports.fin5FileUpload = fin5FileUpload;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.fin5FileUpload = void 0;
4
+ const haystack_core_1 = require("haystack-core");
5
+ const haystack_nclient_1 = require("haystack-nclient");
6
+ /**
7
+ * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
8
+ * @param projectName The name of the project where the files will be uploaded
9
+ * @param file The File to upload
10
+ * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
11
+ * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
12
+ * @returns the file record as an HDict
13
+ * @example
14
+ * <input type='file' onChange={async (e) => {
15
+ * const file = e.target.files?.[0]
16
+ * if (file) {
17
+ * const params = new URLSearchParams()
18
+ * params.set('myMarker', 'true')
19
+ * params.set('myStrTag', 'abc')
20
+ * const rec = await fin5FileUpload(
21
+ * 'myprojectname',
22
+ * file,
23
+ * params
24
+ * )
25
+ * }
26
+ * }} />
27
+ */
28
+ const fin5FileUpload = async (projectName, file, additionalTags = new URLSearchParams()) => {
29
+ if (!additionalTags.has('dis')) {
30
+ additionalTags.set('dis', file.name);
31
+ }
32
+ // URL base (http://localhost) will be ignored, it's just needed to build the URL
33
+ const url = new URL(`/api/${projectName}/ext/finstack/fileUpload`, 'http://localhost');
34
+ additionalTags.forEach((value, name) => url.searchParams.set(name, value));
35
+ const content = await file.arrayBuffer();
36
+ const response = await (0, haystack_nclient_1.finCsrfFetch)(`${url.pathname}${url.search}`, {
37
+ method: 'POST',
38
+ headers: {
39
+ 'Content-Type': 'application/octet-stream',
40
+ },
41
+ body: new Uint8Array(content),
42
+ });
43
+ const zincReader = new haystack_core_1.ZincReader(await response.text());
44
+ const grid = zincReader.readValue();
45
+ const dict = grid.first;
46
+ if (!dict) {
47
+ throw new Error('Unexpected response, no record found');
48
+ }
49
+ return dict;
50
+ };
51
+ exports.fin5FileUpload = fin5FileUpload;
52
52
  //# sourceMappingURL=fin5FileUpload.js.map
@@ -1,165 +1,165 @@
1
- import { AlarmFilter } from './openFin5Alarm';
2
- import { HistorianArgs, HistorianType } from './openFin5Historian';
3
- export declare const getFin5top: (notifyFailure?: () => void) => Fin5Top | null;
4
- export declare const fin5Top: Fin5Top | null;
5
- export declare function isWindowTopFin5(notifyFailure?: () => void): boolean;
6
- export interface Fin5Top extends Window {
7
- app: Fin5App;
8
- languageManager: LanguageManager;
9
- finstack?: {
10
- projectName?: string;
11
- device?: {
12
- currentUser?: {
13
- toObj: () => unknown;
14
- };
15
- };
16
- };
17
- }
18
- export interface Fin5App {
19
- /**
20
- * Toggles FIN right side menu.
21
- * The forceTo parameter can be used to enforce a specific status instead of a toggling behaviour,
22
- * where: true -> menu closed, false -> menu open
23
- */
24
- ToggleCollapse: (forceTo: boolean) => void;
25
- /**
26
- * Returns current target record id.
27
- */
28
- TargetRef: () => TargetRef;
29
- /**
30
- * Updates the current target record id.
31
- * Navigates the current app to the specified
32
- * <code>targetRef</code>. Target Ref is the id of any equip/site etc..
33
- */
34
- NavigateToTargetRef: (targetRef: TargetRef, maintainView: boolean) => void;
35
- /**
36
- * Navigates to a particular application (trends, notes .. etc) under a specific target.
37
- * @param {Fin5AppNames} appName name of the application
38
- * @param {TargetRef} targetRef id of the target. Is the id of the equip/site.. etc to where the app should navigate
39
- * @param {boolean} skipRef is the flag indicating where to ignore the target ref if not mentioned. If this flag is true and the target ref is not provided, then the navigation will be made to the root target ref and will not be obtained from where the app already is
40
- */
41
- NavigateToApp: (appName: Fin5AppNames, targetRef?: TargetRef, skipRef?: boolean, params?: string[]) => Promise<void>;
42
- /**
43
- * Method to open a url on the application LHS. The LHS here is the <code>iframe</code> where all
44
- * the graphics etc are opened.
45
- *
46
- * @method LoadApplication
47
- * @param {string} url - Is the url which is to be loaded
48
- * @param {string} title - Specifies the title to be displayed on the iframe object
49
- * @param {string} targetId - Specifies the id of the equip (etc) to which the main navigation update.
50
- * @param {object} settings - extra settings that can be passed in when calling hte func
51
- * @param {boolean} settings.collapse - flag indicating the collapse state of the RHS app panel
52
- */
53
- LoadApplication: (url: string, title?: string, targetRef?: TargetRef, settings?: {
54
- collapse?: boolean;
55
- }) => Promise<void>;
56
- /**
57
- * As the name suggests, this method logs out the user and resets the current session.
58
- */
59
- Logout: () => void;
60
- /**
61
- * Get the currently active color scheme.
62
- */
63
- GetColorScheme: () => ColorScheme;
64
- /**
65
- * Get the filters object from the alarms application.
66
- */
67
- GetAlarmFilters: () => AlarmFilter;
68
- /**
69
- * Sets the filter settings for the alarms.
70
- * @param {AlarmFilter} filters Is the object that defines the filter properties.
71
- * @param {boolean} historical Flag indicating if the filter properties need to be applied to the historical alarms.
72
- */
73
- SetAlarmFilters: (filters: AlarmFilter, historical?: boolean) => void;
74
- /**
75
- * Navigates to the historian app and loads the graphs as per the passed arguments. The graph will be drawn for the passed "point" ids or for a "query" id or for a "string" query
76
- * @param {HistorianType} type is the type of graph arg. Available args are:
77
- * - point : the args will have point ids in an array
78
- * - query : the arg will be the id of a saved chart query
79
- * - string : the arg will be a query string
80
- * @param {HistorianArgs} args is the array/string for point ids, the query id or the raw query string
81
- */
82
- OpenHistorianWithOptions: (type: HistorianType, args: HistorianArgs) => void;
83
- /**
84
- * Removes the remove-content-popup from the screen identified by the id.
85
- * If the id is not specified, then removes the last popup added remote popup object.
86
- * @param {string} [id] - is the id/identifier of the popup. The <code>id</code> of the HTML element should give you the id
87
- */
88
- RemoveRemotePopup: (id?: string) => void;
89
- /**
90
- * Open the Alarms application with the specified targetRef.
91
- * @since FIN 5.2.0
92
- * @param {TargetRef} [targetRef] - id of the target to be shown in the alarms app. If not provided, it will open with the current target ref.
93
- */
94
- OpenAlarms: (targetRef?: TargetRef) => Promise<void>;
95
- /**
96
- * Open the Schedules application with the specified targetRef and params
97
- * @since FIN 5.2.0
98
- * @param {TargetRef} [targetRef] - id of the target to be shown in the schedules app. If not provided, it will open with the current target ref.
99
- * @param {ScheduleParams} [params] - additional parameters for the schedules app (id, appId, message).
100
- */
101
- OpenSchedules: (targetRef?: TargetRef, params?: SchedulesParams) => Promise<void>;
102
- /**
103
- * Navigates to the Charts App and loads the appropriate chart
104
- * based on the chart id parameter. Removes any previous charts
105
- * URL params.
106
- * @since FIN 5.2.0
107
- * @param {string} chartId - the id of the chart to be opened. If not provided, it will open the charts app without any chart loaded.
108
- * @param {TargetRef} targetRef - id of the target to be shown in the charts app. If not provided, it will open with the current target ref.
109
- */
110
- OpenCharts: (chartId?: string, targetRef?: TargetRef) => Promise<void>;
111
- findComponent: (name: string) => Fin5AppComponent;
112
- /**
113
- * @see https://ractive.js.org/api/#ractiveobserve
114
- */
115
- observe: (keypath: string, callback: (newValue: unknown, oldValue: unknown, keypath: string) => void) => {
116
- cancel: () => void;
117
- };
118
- set: (name: string, value: unknown) => Promise<undefined>;
119
- get: (name: string) => Promise<unknown>;
120
- APP_NAMES: typeof Fin5AppNames;
121
- }
122
- export declare enum Fin5AppNames {
123
- EQUIP = "equip",
124
- GRAPHICS = "graphics",
125
- POINTS = "points",
126
- ALARMS = "alarms",
127
- NOTES = "notes",
128
- SUMMARY = "summary",
129
- SUMMARY_TOPICS = "summaryList",
130
- TOOLS = "tools",
131
- SCHEDULES = "schedules",
132
- SCHEDULE_LIST = "scheduleList",
133
- HISTORIAN = "trends",
134
- TREND_LIST = "trendList",
135
- CHARTS = "charts",
136
- CHART_LIST = "chartList",
137
- SEARCH = "search",
138
- LOGOUT = "logout",
139
- GENERIC = "generic",
140
- REPORTS = "reports",
141
- FLOOR = "floor",
142
- BUILDER = "builder",
143
- FILES = "files",
144
- HOME = "home",
145
- DASHBOARD = "dashboard",
146
- SETTINGS = "settings"
147
- }
148
- interface LanguageManager {
149
- currentLang: string;
150
- }
151
- interface Fin5AppComponent {
152
- set: (value: unknown) => Promise<undefined>;
153
- }
154
- export declare type TargetRef = string | null | undefined;
155
- export interface SchedulesParams {
156
- id?: string;
157
- appId?: string;
158
- message?: string;
159
- }
160
- export interface ColorScheme {
161
- primary: string;
162
- bodyBackground: string;
163
- sidebarBackground: string;
164
- }
165
- export {};
1
+ import { AlarmFilter } from './openFin5Alarm';
2
+ import { HistorianArgs, HistorianType } from './openFin5Historian';
3
+ export declare const getFin5top: (notifyFailure?: () => void) => Fin5Top | null;
4
+ export declare const fin5Top: Fin5Top | null;
5
+ export declare function isWindowTopFin5(notifyFailure?: () => void): boolean;
6
+ export interface Fin5Top extends Window {
7
+ app: Fin5App;
8
+ languageManager: LanguageManager;
9
+ finstack?: {
10
+ projectName?: string;
11
+ device?: {
12
+ currentUser?: {
13
+ toObj: () => unknown;
14
+ };
15
+ };
16
+ };
17
+ }
18
+ export interface Fin5App {
19
+ /**
20
+ * Toggles FIN right side menu.
21
+ * The forceTo parameter can be used to enforce a specific status instead of a toggling behaviour,
22
+ * where: true -> menu closed, false -> menu open
23
+ */
24
+ ToggleCollapse: (forceTo: boolean) => void;
25
+ /**
26
+ * Returns current target record id.
27
+ */
28
+ TargetRef: () => TargetRef;
29
+ /**
30
+ * Updates the current target record id.
31
+ * Navigates the current app to the specified
32
+ * <code>targetRef</code>. Target Ref is the id of any equip/site etc..
33
+ */
34
+ NavigateToTargetRef: (targetRef: TargetRef, maintainView: boolean) => void;
35
+ /**
36
+ * Navigates to a particular application (trends, notes .. etc) under a specific target.
37
+ * @param {Fin5AppNames} appName name of the application
38
+ * @param {TargetRef} targetRef id of the target. Is the id of the equip/site.. etc to where the app should navigate
39
+ * @param {boolean} skipRef is the flag indicating where to ignore the target ref if not mentioned. If this flag is true and the target ref is not provided, then the navigation will be made to the root target ref and will not be obtained from where the app already is
40
+ */
41
+ NavigateToApp: (appName: Fin5AppNames, targetRef?: TargetRef, skipRef?: boolean, params?: string[]) => Promise<void>;
42
+ /**
43
+ * Method to open a url on the application LHS. The LHS here is the <code>iframe</code> where all
44
+ * the graphics etc are opened.
45
+ *
46
+ * @method LoadApplication
47
+ * @param {string} url - Is the url which is to be loaded
48
+ * @param {string} title - Specifies the title to be displayed on the iframe object
49
+ * @param {string} targetId - Specifies the id of the equip (etc) to which the main navigation update.
50
+ * @param {object} settings - extra settings that can be passed in when calling hte func
51
+ * @param {boolean} settings.collapse - flag indicating the collapse state of the RHS app panel
52
+ */
53
+ LoadApplication: (url: string, title?: string, targetRef?: TargetRef, settings?: {
54
+ collapse?: boolean;
55
+ }) => Promise<void>;
56
+ /**
57
+ * As the name suggests, this method logs out the user and resets the current session.
58
+ */
59
+ Logout: () => void;
60
+ /**
61
+ * Get the currently active color scheme.
62
+ */
63
+ GetColorScheme: () => ColorScheme;
64
+ /**
65
+ * Get the filters object from the alarms application.
66
+ */
67
+ GetAlarmFilters: () => AlarmFilter;
68
+ /**
69
+ * Sets the filter settings for the alarms.
70
+ * @param {AlarmFilter} filters Is the object that defines the filter properties.
71
+ * @param {boolean} historical Flag indicating if the filter properties need to be applied to the historical alarms.
72
+ */
73
+ SetAlarmFilters: (filters: AlarmFilter, historical?: boolean) => void;
74
+ /**
75
+ * Navigates to the historian app and loads the graphs as per the passed arguments. The graph will be drawn for the passed "point" ids or for a "query" id or for a "string" query
76
+ * @param {HistorianType} type is the type of graph arg. Available args are:
77
+ * - point : the args will have point ids in an array
78
+ * - query : the arg will be the id of a saved chart query
79
+ * - string : the arg will be a query string
80
+ * @param {HistorianArgs} args is the array/string for point ids, the query id or the raw query string
81
+ */
82
+ OpenHistorianWithOptions: (type: HistorianType, args: HistorianArgs) => void;
83
+ /**
84
+ * Removes the remove-content-popup from the screen identified by the id.
85
+ * If the id is not specified, then removes the last popup added remote popup object.
86
+ * @param {string} [id] - is the id/identifier of the popup. The <code>id</code> of the HTML element should give you the id
87
+ */
88
+ RemoveRemotePopup: (id?: string) => void;
89
+ /**
90
+ * Open the Alarms application with the specified targetRef.
91
+ * @since FIN 5.2.0
92
+ * @param {TargetRef} [targetRef] - id of the target to be shown in the alarms app. If not provided, it will open with the current target ref.
93
+ */
94
+ OpenAlarms: (targetRef?: TargetRef) => Promise<void>;
95
+ /**
96
+ * Open the Schedules application with the specified targetRef and params
97
+ * @since FIN 5.2.0
98
+ * @param {TargetRef} [targetRef] - id of the target to be shown in the schedules app. If not provided, it will open with the current target ref.
99
+ * @param {ScheduleParams} [params] - additional parameters for the schedules app (id, appId, message).
100
+ */
101
+ OpenSchedules: (targetRef?: TargetRef, params?: SchedulesParams) => Promise<void>;
102
+ /**
103
+ * Navigates to the Charts App and loads the appropriate chart
104
+ * based on the chart id parameter. Removes any previous charts
105
+ * URL params.
106
+ * @since FIN 5.2.0
107
+ * @param {string} chartId - the id of the chart to be opened. If not provided, it will open the charts app without any chart loaded.
108
+ * @param {TargetRef} targetRef - id of the target to be shown in the charts app. If not provided, it will open with the current target ref.
109
+ */
110
+ OpenCharts: (chartId?: string, targetRef?: TargetRef) => Promise<void>;
111
+ findComponent: (name: string) => Fin5AppComponent;
112
+ /**
113
+ * @see https://ractive.js.org/api/#ractiveobserve
114
+ */
115
+ observe: (keypath: string, callback: (newValue: unknown, oldValue: unknown, keypath: string) => void) => {
116
+ cancel: () => void;
117
+ };
118
+ set: (name: string, value: unknown) => Promise<undefined>;
119
+ get: (name: string) => Promise<unknown>;
120
+ APP_NAMES: typeof Fin5AppNames;
121
+ }
122
+ export declare enum Fin5AppNames {
123
+ EQUIP = "equip",
124
+ GRAPHICS = "graphics",
125
+ POINTS = "points",
126
+ ALARMS = "alarms",
127
+ NOTES = "notes",
128
+ SUMMARY = "summary",
129
+ SUMMARY_TOPICS = "summaryList",
130
+ TOOLS = "tools",
131
+ SCHEDULES = "schedules",
132
+ SCHEDULE_LIST = "scheduleList",
133
+ HISTORIAN = "trends",
134
+ TREND_LIST = "trendList",
135
+ CHARTS = "charts",
136
+ CHART_LIST = "chartList",
137
+ SEARCH = "search",
138
+ LOGOUT = "logout",
139
+ GENERIC = "generic",
140
+ REPORTS = "reports",
141
+ FLOOR = "floor",
142
+ BUILDER = "builder",
143
+ FILES = "files",
144
+ HOME = "home",
145
+ DASHBOARD = "dashboard",
146
+ SETTINGS = "settings"
147
+ }
148
+ interface LanguageManager {
149
+ currentLang: string;
150
+ }
151
+ interface Fin5AppComponent {
152
+ set: (value: unknown) => Promise<undefined>;
153
+ }
154
+ export declare type TargetRef = string | null | undefined;
155
+ export interface SchedulesParams {
156
+ id?: string;
157
+ appId?: string;
158
+ message?: string;
159
+ }
160
+ export interface ColorScheme {
161
+ primary: string;
162
+ bodyBackground: string;
163
+ sidebarBackground: string;
164
+ }
165
+ export {};