@j2inn/fin5-ui-utils 8.2.0 → 8.3.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 (214) 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 +188 -188
  17. package/dist/fin5Top/fin5Top.js +86 -86
  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 +161 -161
  34. package/dist/react/app/Fin5AppRootStore.d.ts +42 -42
  35. package/dist/react/app/Fin5AppRootStore.js +114 -114
  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/ReactRouterHeaderSiderLayout.js.map +1 -1
  73. package/dist/react/components/navigation/ReactRouterLayout.d.ts +45 -46
  74. package/dist/react/components/navigation/ReactRouterLayout.js +132 -132
  75. package/dist/react/components/navigation/ReactRouterLayout.js.map +1 -1
  76. package/dist/react/components/navigation/customRouting/Router.d.ts +12 -12
  77. package/dist/react/components/navigation/customRouting/Router.js +45 -45
  78. package/dist/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  79. package/dist/react/components/navigation/customRouting/RouterLayout.js +61 -61
  80. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  81. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.js +95 -95
  82. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  83. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +88 -88
  84. package/dist/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  85. package/dist/react/components/resolvable/configurationForm/getSectionDefault.js +99 -99
  86. package/dist/react/hooks/useFin5BinUrl.d.ts +6 -6
  87. package/dist/react/hooks/useFin5BinUrl.js +15 -15
  88. package/dist/react/hooks/useFin5ColorScheme.d.ts +2 -2
  89. package/dist/react/hooks/useFin5ColorScheme.js +56 -56
  90. package/dist/react/hooks/useScreenSize.d.ts +7 -7
  91. package/dist/react/hooks/useScreenSize.js +31 -31
  92. package/dist_es/fantomProps/createFin5Props/index.d.ts +12 -12
  93. package/dist_es/fantomProps/createFin5Props/index.js +140 -140
  94. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.d.ts +2 -2
  95. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.js +15 -15
  96. package/dist_es/fantomProps/fantomPropsToObject.d.ts +8 -8
  97. package/dist_es/fantomProps/fantomPropsToObject.js +178 -178
  98. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.d.ts +4 -4
  99. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.js +12 -12
  100. package/dist_es/fantomProps/localePropsToJson.d.ts +1 -1
  101. package/dist_es/fantomProps/localePropsToJson.js +21 -21
  102. package/dist_es/fantomProps/readFantomPropsFile.d.ts +5 -5
  103. package/dist_es/fantomProps/readFantomPropsFile.js +39 -39
  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 +188 -188
  107. package/dist_es/fin5Top/fin5Top.js +81 -81
  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 +132 -132
  124. package/dist_es/react/app/Fin5AppRootStore.d.ts +42 -42
  125. package/dist_es/react/app/Fin5AppRootStore.js +110 -110
  126. package/dist_es/react/components/ErrorBoundary.d.ts +57 -57
  127. package/dist_es/react/components/ErrorBoundary.js +123 -123
  128. package/dist_es/react/components/ErrorDisplayer.d.ts +19 -19
  129. package/dist_es/react/components/ErrorDisplayer.js +28 -28
  130. package/dist_es/react/components/Loader.d.ts +9 -9
  131. package/dist_es/react/components/Loader.js +12 -12
  132. package/dist_es/react/components/LoadingSpinner.d.ts +2 -2
  133. package/dist_es/react/components/LoadingSpinner.js +20 -20
  134. package/dist_es/react/components/RecordImage.d.ts +20 -20
  135. package/dist_es/react/components/RecordImage.js +24 -24
  136. package/dist_es/react/components/charts/QRCode.d.ts +25 -25
  137. package/dist_es/react/components/charts/QRCode.js +52 -52
  138. package/dist_es/react/components/charts/line-bar/Chart.d.ts +166 -166
  139. package/dist_es/react/components/charts/line-bar/Chart.js +415 -415
  140. package/dist_es/react/components/charts/line-bar/HGridChart.d.ts +58 -58
  141. package/dist_es/react/components/charts/line-bar/HGridChart.js +250 -250
  142. package/dist_es/react/components/charts/pie/PieChart.d.ts +94 -94
  143. package/dist_es/react/components/charts/pie/PieChart.js +177 -177
  144. package/dist_es/react/components/charts/pie/SimplePieChart.d.ts +21 -21
  145. package/dist_es/react/components/charts/pie/SimplePieChart.js +25 -25
  146. package/dist_es/react/components/graphics/GraphicViewer.d.ts +10 -10
  147. package/dist_es/react/components/graphics/GraphicViewer.js +22 -22
  148. package/dist_es/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  149. package/dist_es/react/components/graphics/GraphicsTabViewer.js +60 -60
  150. package/dist_es/react/components/makeCustomElement.d.ts +16 -16
  151. package/dist_es/react/components/makeCustomElement.js +142 -142
  152. package/dist_es/react/components/navigation/BasicLayout.d.ts +41 -41
  153. package/dist_es/react/components/navigation/BasicLayout.js +124 -124
  154. package/dist_es/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  155. package/dist_es/react/components/navigation/HeaderSiderLayout.js +80 -80
  156. package/dist_es/react/components/navigation/MenuPage.d.ts +37 -37
  157. package/dist_es/react/components/navigation/MenuPage.js +30 -30
  158. package/dist_es/react/components/navigation/MenuTrigger.d.ts +9 -9
  159. package/dist_es/react/components/navigation/MenuTrigger.js +28 -28
  160. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  161. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.js +18 -18
  162. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.js.map +1 -1
  163. package/dist_es/react/components/navigation/ReactRouterLayout.d.ts +45 -46
  164. package/dist_es/react/components/navigation/ReactRouterLayout.js +99 -99
  165. package/dist_es/react/components/navigation/ReactRouterLayout.js.map +1 -1
  166. package/dist_es/react/components/navigation/customRouting/Router.d.ts +12 -12
  167. package/dist_es/react/components/navigation/customRouting/Router.js +18 -18
  168. package/dist_es/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  169. package/dist_es/react/components/navigation/customRouting/RouterLayout.js +34 -34
  170. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  171. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.js +64 -64
  172. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  173. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +58 -58
  174. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  175. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.js +94 -94
  176. package/dist_es/react/hooks/useFin5BinUrl.d.ts +6 -6
  177. package/dist_es/react/hooks/useFin5BinUrl.js +11 -11
  178. package/dist_es/react/hooks/useFin5ColorScheme.d.ts +2 -2
  179. package/dist_es/react/hooks/useFin5ColorScheme.js +52 -52
  180. package/dist_es/react/hooks/useScreenSize.d.ts +7 -7
  181. package/dist_es/react/hooks/useScreenSize.js +27 -27
  182. package/package.json +5 -3
  183. package/dist_es/react/app/Fin5AppContainer.jsx +0 -82
  184. package/dist_es/react/app/Fin5AppContainer.jsx.map +0 -1
  185. package/dist_es/react/components/ErrorBoundary.jsx +0 -150
  186. package/dist_es/react/components/ErrorBoundary.jsx.map +0 -1
  187. package/dist_es/react/components/ErrorDisplayer.jsx +0 -36
  188. package/dist_es/react/components/ErrorDisplayer.jsx.map +0 -1
  189. package/dist_es/react/components/Loader.jsx +0 -13
  190. package/dist_es/react/components/Loader.jsx.map +0 -1
  191. package/dist_es/react/components/LoadingSpinner.jsx +0 -22
  192. package/dist_es/react/components/LoadingSpinner.jsx.map +0 -1
  193. package/dist_es/react/components/charts/line-bar/ZincGridChart.d.ts +0 -12
  194. package/dist_es/react/components/charts/line-bar/ZincGridChart.js +0 -17
  195. package/dist_es/react/components/charts/line-bar/ZincGridChart.js.map +0 -1
  196. package/dist_es/react/components/graphics/GraphicViewer.jsx +0 -23
  197. package/dist_es/react/components/graphics/GraphicViewer.jsx.map +0 -1
  198. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx +0 -63
  199. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx.map +0 -1
  200. package/dist_es/react/components/navigation/BasicLayout.jsx +0 -133
  201. package/dist_es/react/components/navigation/BasicLayout.jsx.map +0 -1
  202. package/dist_es/react/components/navigation/MenuPage.jsx +0 -31
  203. package/dist_es/react/components/navigation/MenuPage.jsx.map +0 -1
  204. package/dist_es/react/components/navigation/Router.d.ts +0 -12
  205. package/dist_es/react/components/navigation/Router.js +0 -19
  206. package/dist_es/react/components/navigation/Router.js.map +0 -1
  207. package/dist_es/react/components/navigation/Router.jsx +0 -19
  208. package/dist_es/react/components/navigation/Router.jsx.map +0 -1
  209. package/dist_es/react/components/navigation/react-router/BasicLayout.d.ts +0 -23
  210. package/dist_es/react/components/navigation/react-router/BasicLayout.js +0 -82
  211. package/dist_es/react/components/navigation/react-router/BasicLayout.js.map +0 -1
  212. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.d.ts +0 -24
  213. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js +0 -82
  214. 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