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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (216) hide show
  1. package/README.md +5 -5
  2. package/dist/fantomProps/createFin5Props/index.d.ts +12 -12
  3. package/dist/fantomProps/createFin5Props/index.js +146 -146
  4. package/dist/fantomProps/createFin5Props/runCreateFin5Props.d.ts +2 -2
  5. package/dist/fantomProps/createFin5Props/runCreateFin5Props.js +20 -20
  6. package/dist/fantomProps/fantomPropsToObject.d.ts +8 -8
  7. package/dist/fantomProps/fantomPropsToObject.js +183 -183
  8. package/dist/fantomProps/generateJsonFromFantomPropsFile.d.ts +4 -4
  9. package/dist/fantomProps/generateJsonFromFantomPropsFile.js +41 -41
  10. package/dist/fantomProps/localePropsToJson.d.ts +1 -1
  11. package/dist/fantomProps/localePropsToJson.js +50 -50
  12. package/dist/fantomProps/readFantomPropsFile.d.ts +5 -5
  13. package/dist/fantomProps/readFantomPropsFile.js +65 -65
  14. package/dist/fin5Top/fin5FileUpload.d.ts +24 -24
  15. package/dist/fin5Top/fin5FileUpload.js +51 -51
  16. package/dist/fin5Top/fin5Top.d.ts +165 -124
  17. package/dist/fin5Top/fin5Top.js +61 -53
  18. package/dist/fin5Top/fin5Top.js.map +1 -1
  19. package/dist/fin5Top/finEdge2Cloud.d.ts +6 -6
  20. package/dist/fin5Top/finEdge2Cloud.js +15 -15
  21. package/dist/fin5Top/getFin5BinUrl.d.ts +2 -2
  22. package/dist/fin5Top/getFin5BinUrl.js +9 -9
  23. package/dist/fin5Top/openFin5Alarm.d.ts +22 -22
  24. package/dist/fin5Top/openFin5Alarm.js +23 -23
  25. package/dist/fin5Top/openFin5Historian.d.ts +3 -3
  26. package/dist/fin5Top/openFin5Historian.js +19 -19
  27. package/dist/fin5Top/useFin5AppURLHashParameter.d.ts +18 -18
  28. package/dist/fin5Top/useFin5AppURLHashParameter.js +133 -133
  29. package/dist/index.d.ts +35 -35
  30. package/dist/index.js +69 -69
  31. package/dist/jobs/jobUtils.d.ts +14 -14
  32. package/dist/jobs/jobUtils.js +15 -15
  33. package/dist/react/app/Fin5AppContainer.d.ts +36 -36
  34. package/dist/react/app/Fin5AppContainer.js +145 -161
  35. package/dist/react/app/Fin5AppContainer.js.map +1 -1
  36. package/dist/react/app/Fin5AppRootStore.d.ts +40 -42
  37. package/dist/react/app/Fin5AppRootStore.js +90 -114
  38. package/dist/react/app/Fin5AppRootStore.js.map +1 -1
  39. package/dist/react/components/ErrorBoundary.d.ts +57 -57
  40. package/dist/react/components/ErrorBoundary.js +150 -150
  41. package/dist/react/components/ErrorDisplayer.d.ts +19 -19
  42. package/dist/react/components/ErrorDisplayer.js +36 -36
  43. package/dist/react/components/Loader.d.ts +9 -9
  44. package/dist/react/components/Loader.js +17 -17
  45. package/dist/react/components/LoadingSpinner.d.ts +2 -2
  46. package/dist/react/components/LoadingSpinner.js +27 -27
  47. package/dist/react/components/RecordImage.d.ts +20 -20
  48. package/dist/react/components/RecordImage.js +51 -51
  49. package/dist/react/components/charts/QRCode.d.ts +25 -25
  50. package/dist/react/components/charts/QRCode.js +82 -82
  51. package/dist/react/components/charts/line-bar/Chart.d.ts +166 -166
  52. package/dist/react/components/charts/line-bar/Chart.js +442 -442
  53. package/dist/react/components/charts/line-bar/HGridChart.d.ts +58 -58
  54. package/dist/react/components/charts/line-bar/HGridChart.js +285 -285
  55. package/dist/react/components/charts/pie/PieChart.d.ts +94 -94
  56. package/dist/react/components/charts/pie/PieChart.js +204 -204
  57. package/dist/react/components/charts/pie/SimplePieChart.d.ts +21 -21
  58. package/dist/react/components/charts/pie/SimplePieChart.js +55 -55
  59. package/dist/react/components/graphics/GraphicViewer.d.ts +10 -10
  60. package/dist/react/components/graphics/GraphicViewer.js +29 -29
  61. package/dist/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  62. package/dist/react/components/graphics/GraphicsTabViewer.js +90 -90
  63. package/dist/react/components/makeCustomElement.d.ts +16 -16
  64. package/dist/react/components/makeCustomElement.js +150 -150
  65. package/dist/react/components/navigation/BasicLayout.d.ts +41 -41
  66. package/dist/react/components/navigation/BasicLayout.js +155 -155
  67. package/dist/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  68. package/dist/react/components/navigation/HeaderSiderLayout.js +110 -110
  69. package/dist/react/components/navigation/MenuPage.d.ts +37 -37
  70. package/dist/react/components/navigation/MenuPage.js +36 -36
  71. package/dist/react/components/navigation/MenuTrigger.d.ts +9 -9
  72. package/dist/react/components/navigation/MenuTrigger.js +33 -33
  73. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  74. package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.js +25 -25
  75. package/dist/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  76. package/dist/react/components/navigation/ReactRouterLayout.js +132 -132
  77. package/dist/react/components/navigation/customRouting/Router.d.ts +12 -12
  78. package/dist/react/components/navigation/customRouting/Router.js +45 -45
  79. package/dist/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  80. package/dist/react/components/navigation/customRouting/RouterLayout.js +61 -61
  81. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  82. package/dist/react/components/resolvable/configurationForm/ConfigurationForm.js +95 -95
  83. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  84. package/dist/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +88 -88
  85. package/dist/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  86. package/dist/react/components/resolvable/configurationForm/getSectionDefault.js +99 -99
  87. package/dist/react/hooks/useFin5BinUrl.d.ts +6 -6
  88. package/dist/react/hooks/useFin5BinUrl.js +15 -15
  89. package/dist/react/hooks/useFin5ColorScheme.d.ts +2 -2
  90. package/dist/react/hooks/useFin5ColorScheme.js +56 -56
  91. package/dist/react/hooks/useScreenSize.d.ts +7 -7
  92. package/dist/react/hooks/useScreenSize.js +31 -31
  93. package/dist_es/fantomProps/createFin5Props/index.d.ts +12 -12
  94. package/dist_es/fantomProps/createFin5Props/index.js +140 -140
  95. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.d.ts +2 -2
  96. package/dist_es/fantomProps/createFin5Props/runCreateFin5Props.js +15 -15
  97. package/dist_es/fantomProps/fantomPropsToObject.d.ts +8 -8
  98. package/dist_es/fantomProps/fantomPropsToObject.js +178 -178
  99. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.d.ts +4 -4
  100. package/dist_es/fantomProps/generateJsonFromFantomPropsFile.js +12 -12
  101. package/dist_es/fantomProps/localePropsToJson.d.ts +1 -1
  102. package/dist_es/fantomProps/localePropsToJson.js +21 -21
  103. package/dist_es/fantomProps/readFantomPropsFile.d.ts +5 -5
  104. package/dist_es/fantomProps/readFantomPropsFile.js +39 -39
  105. package/dist_es/fin5Top/fin5FileUpload.d.ts +24 -24
  106. package/dist_es/fin5Top/fin5FileUpload.js +47 -47
  107. package/dist_es/fin5Top/fin5Top.d.ts +165 -124
  108. package/dist_es/fin5Top/fin5Top.js +57 -49
  109. package/dist_es/fin5Top/fin5Top.js.map +1 -1
  110. package/dist_es/fin5Top/finEdge2Cloud.d.ts +6 -6
  111. package/dist_es/fin5Top/finEdge2Cloud.js +11 -11
  112. package/dist_es/fin5Top/getFin5BinUrl.d.ts +2 -2
  113. package/dist_es/fin5Top/getFin5BinUrl.js +5 -5
  114. package/dist_es/fin5Top/openFin5Alarm.d.ts +22 -22
  115. package/dist_es/fin5Top/openFin5Alarm.js +19 -19
  116. package/dist_es/fin5Top/openFin5Historian.d.ts +3 -3
  117. package/dist_es/fin5Top/openFin5Historian.js +15 -15
  118. package/dist_es/fin5Top/useFin5AppURLHashParameter.d.ts +18 -18
  119. package/dist_es/fin5Top/useFin5AppURLHashParameter.js +124 -124
  120. package/dist_es/index.d.ts +35 -35
  121. package/dist_es/index.js +53 -53
  122. package/dist_es/jobs/jobUtils.d.ts +14 -14
  123. package/dist_es/jobs/jobUtils.js +9 -9
  124. package/dist_es/react/app/Fin5AppContainer.d.ts +36 -36
  125. package/dist_es/react/app/Fin5AppContainer.js +116 -132
  126. package/dist_es/react/app/Fin5AppContainer.js.map +1 -1
  127. package/dist_es/react/app/Fin5AppContainer.jsx +82 -0
  128. package/dist_es/react/app/Fin5AppContainer.jsx.map +1 -0
  129. package/dist_es/react/app/Fin5AppRootStore.d.ts +40 -42
  130. package/dist_es/react/app/Fin5AppRootStore.js +86 -110
  131. package/dist_es/react/app/Fin5AppRootStore.js.map +1 -1
  132. package/dist_es/react/components/ErrorBoundary.d.ts +57 -57
  133. package/dist_es/react/components/ErrorBoundary.js +123 -123
  134. package/dist_es/react/components/ErrorBoundary.jsx +150 -0
  135. package/dist_es/react/components/ErrorBoundary.jsx.map +1 -0
  136. package/dist_es/react/components/ErrorDisplayer.d.ts +19 -19
  137. package/dist_es/react/components/ErrorDisplayer.js +28 -28
  138. package/dist_es/react/components/ErrorDisplayer.jsx +36 -0
  139. package/dist_es/react/components/ErrorDisplayer.jsx.map +1 -0
  140. package/dist_es/react/components/Loader.d.ts +9 -9
  141. package/dist_es/react/components/Loader.js +12 -12
  142. package/dist_es/react/components/Loader.jsx +13 -0
  143. package/dist_es/react/components/Loader.jsx.map +1 -0
  144. package/dist_es/react/components/LoadingSpinner.d.ts +2 -2
  145. package/dist_es/react/components/LoadingSpinner.js +20 -20
  146. package/dist_es/react/components/LoadingSpinner.jsx +22 -0
  147. package/dist_es/react/components/LoadingSpinner.jsx.map +1 -0
  148. package/dist_es/react/components/RecordImage.d.ts +20 -20
  149. package/dist_es/react/components/RecordImage.js +24 -24
  150. package/dist_es/react/components/charts/QRCode.d.ts +25 -25
  151. package/dist_es/react/components/charts/QRCode.js +52 -52
  152. package/dist_es/react/components/charts/line-bar/Chart.d.ts +166 -166
  153. package/dist_es/react/components/charts/line-bar/Chart.js +415 -415
  154. package/dist_es/react/components/charts/line-bar/HGridChart.d.ts +58 -58
  155. package/dist_es/react/components/charts/line-bar/HGridChart.js +250 -250
  156. package/dist_es/react/components/charts/line-bar/ZincGridChart.d.ts +12 -0
  157. package/dist_es/react/components/charts/line-bar/ZincGridChart.js +17 -0
  158. package/dist_es/react/components/charts/line-bar/ZincGridChart.js.map +1 -0
  159. package/dist_es/react/components/charts/pie/PieChart.d.ts +94 -94
  160. package/dist_es/react/components/charts/pie/PieChart.js +177 -177
  161. package/dist_es/react/components/charts/pie/SimplePieChart.d.ts +21 -21
  162. package/dist_es/react/components/charts/pie/SimplePieChart.js +25 -25
  163. package/dist_es/react/components/graphics/GraphicViewer.d.ts +10 -10
  164. package/dist_es/react/components/graphics/GraphicViewer.js +22 -22
  165. package/dist_es/react/components/graphics/GraphicViewer.jsx +23 -0
  166. package/dist_es/react/components/graphics/GraphicViewer.jsx.map +1 -0
  167. package/dist_es/react/components/graphics/GraphicsTabViewer.d.ts +17 -17
  168. package/dist_es/react/components/graphics/GraphicsTabViewer.js +60 -60
  169. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx +63 -0
  170. package/dist_es/react/components/graphics/GraphicsTabViewer.jsx.map +1 -0
  171. package/dist_es/react/components/makeCustomElement.d.ts +16 -16
  172. package/dist_es/react/components/makeCustomElement.js +142 -142
  173. package/dist_es/react/components/navigation/BasicLayout.d.ts +41 -41
  174. package/dist_es/react/components/navigation/BasicLayout.js +124 -124
  175. package/dist_es/react/components/navigation/BasicLayout.jsx +133 -0
  176. package/dist_es/react/components/navigation/BasicLayout.jsx.map +1 -0
  177. package/dist_es/react/components/navigation/HeaderSiderLayout.d.ts +13 -13
  178. package/dist_es/react/components/navigation/HeaderSiderLayout.js +80 -80
  179. package/dist_es/react/components/navigation/MenuPage.d.ts +37 -37
  180. package/dist_es/react/components/navigation/MenuPage.js +30 -30
  181. package/dist_es/react/components/navigation/MenuPage.jsx +31 -0
  182. package/dist_es/react/components/navigation/MenuPage.jsx.map +1 -0
  183. package/dist_es/react/components/navigation/MenuTrigger.d.ts +9 -9
  184. package/dist_es/react/components/navigation/MenuTrigger.js +28 -28
  185. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts +11 -11
  186. package/dist_es/react/components/navigation/ReactRouterHeaderSiderLayout.js +18 -18
  187. package/dist_es/react/components/navigation/ReactRouterLayout.d.ts +46 -46
  188. package/dist_es/react/components/navigation/ReactRouterLayout.js +99 -99
  189. package/dist_es/react/components/navigation/Router.d.ts +12 -0
  190. package/dist_es/react/components/navigation/Router.js +19 -0
  191. package/dist_es/react/components/navigation/Router.js.map +1 -0
  192. package/dist_es/react/components/navigation/Router.jsx +19 -0
  193. package/dist_es/react/components/navigation/Router.jsx.map +1 -0
  194. package/dist_es/react/components/navigation/customRouting/Router.d.ts +12 -12
  195. package/dist_es/react/components/navigation/customRouting/Router.js +18 -18
  196. package/dist_es/react/components/navigation/customRouting/RouterLayout.d.ts +11 -11
  197. package/dist_es/react/components/navigation/customRouting/RouterLayout.js +34 -34
  198. package/dist_es/react/components/navigation/react-router/BasicLayout.d.ts +23 -0
  199. package/dist_es/react/components/navigation/react-router/BasicLayout.js +82 -0
  200. package/dist_es/react/components/navigation/react-router/BasicLayout.js.map +1 -0
  201. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.d.ts +24 -0
  202. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js +82 -0
  203. package/dist_es/react/components/navigation/react-router/ReactRouterBasicLayout.js.map +1 -0
  204. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.d.ts +27 -27
  205. package/dist_es/react/components/resolvable/configurationForm/ConfigurationForm.js +64 -64
  206. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.d.ts +16 -16
  207. package/dist_es/react/components/resolvable/configurationForm/ConfigurationFormEntry.js +58 -58
  208. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.d.ts +16 -16
  209. package/dist_es/react/components/resolvable/configurationForm/getSectionDefault.js +94 -94
  210. package/dist_es/react/hooks/useFin5BinUrl.d.ts +6 -6
  211. package/dist_es/react/hooks/useFin5BinUrl.js +11 -11
  212. package/dist_es/react/hooks/useFin5ColorScheme.d.ts +2 -2
  213. package/dist_es/react/hooks/useFin5ColorScheme.js +52 -52
  214. package/dist_es/react/hooks/useScreenSize.d.ts +7 -7
  215. package/dist_es/react/hooks/useScreenSize.js +27 -27
  216. package/package.json +1 -1
@@ -1,48 +1,48 @@
1
- import { ZincReader } from 'haystack-core';
2
- import { finCsrfFetch } from 'haystack-nclient';
3
- /**
4
- * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
5
- * @param projectName The name of the project where the files will be uploaded
6
- * @param file The File to upload
7
- * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
8
- * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
9
- * @returns the file record as an HDict
10
- * @example
11
- * <input type='file' onChange={async (e) => {
12
- * const file = e.target.files?.[0]
13
- * if (file) {
14
- * const params = new URLSearchParams()
15
- * params.set('myMarker', 'true')
16
- * params.set('myStrTag', 'abc')
17
- * const rec = await fin5FileUpload(
18
- * 'myprojectname',
19
- * file,
20
- * params
21
- * )
22
- * }
23
- * }} />
24
- */
25
- export const fin5FileUpload = async (projectName, file, additionalTags = new URLSearchParams()) => {
26
- if (!additionalTags.has('dis')) {
27
- additionalTags.set('dis', file.name);
28
- }
29
- // URL base (http://localhost) will be ignored, it's just needed to build the URL
30
- const url = new URL(`/api/${projectName}/ext/finstack/fileUpload`, 'http://localhost');
31
- additionalTags.forEach((value, name) => url.searchParams.set(name, value));
32
- const content = await file.arrayBuffer();
33
- const response = await finCsrfFetch(`${url.pathname}${url.search}`, {
34
- method: 'POST',
35
- headers: {
36
- 'Content-Type': 'application/octet-stream',
37
- },
38
- body: new Uint8Array(content),
39
- });
40
- const zincReader = new ZincReader(await response.text());
41
- const grid = zincReader.readValue();
42
- const dict = grid.first;
43
- if (!dict) {
44
- throw new Error('Unexpected response, no record found');
45
- }
46
- return dict;
47
- };
1
+ import { ZincReader } from 'haystack-core';
2
+ import { finCsrfFetch } from 'haystack-nclient';
3
+ /**
4
+ * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
5
+ * @param projectName The name of the project where the files will be uploaded
6
+ * @param file The File to upload
7
+ * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
8
+ * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
9
+ * @returns the file record as an HDict
10
+ * @example
11
+ * <input type='file' onChange={async (e) => {
12
+ * const file = e.target.files?.[0]
13
+ * if (file) {
14
+ * const params = new URLSearchParams()
15
+ * params.set('myMarker', 'true')
16
+ * params.set('myStrTag', 'abc')
17
+ * const rec = await fin5FileUpload(
18
+ * 'myprojectname',
19
+ * file,
20
+ * params
21
+ * )
22
+ * }
23
+ * }} />
24
+ */
25
+ export const fin5FileUpload = async (projectName, file, additionalTags = new URLSearchParams()) => {
26
+ if (!additionalTags.has('dis')) {
27
+ additionalTags.set('dis', file.name);
28
+ }
29
+ // URL base (http://localhost) will be ignored, it's just needed to build the URL
30
+ const url = new URL(`/api/${projectName}/ext/finstack/fileUpload`, 'http://localhost');
31
+ additionalTags.forEach((value, name) => url.searchParams.set(name, value));
32
+ const content = await file.arrayBuffer();
33
+ const response = await finCsrfFetch(`${url.pathname}${url.search}`, {
34
+ method: 'POST',
35
+ headers: {
36
+ 'Content-Type': 'application/octet-stream',
37
+ },
38
+ body: new Uint8Array(content),
39
+ });
40
+ const zincReader = new ZincReader(await response.text());
41
+ const grid = zincReader.readValue();
42
+ const dict = grid.first;
43
+ if (!dict) {
44
+ throw new Error('Unexpected response, no record found');
45
+ }
46
+ return dict;
47
+ };
48
48
  //# sourceMappingURL=fin5FileUpload.js.map
@@ -1,124 +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
- findComponent: (name: string) => Fin5AppComponent;
84
- /**
85
- * @see https://ractive.js.org/api/#ractiveobserve
86
- */
87
- observe: (keypath: string, callback: (newValue: unknown, oldValue: unknown, keypath: string) => void) => {
88
- cancel: () => void;
89
- };
90
- set: (name: string, value: unknown) => Promise<undefined>;
91
- get: (name: string) => Promise<unknown>;
92
- APP_NAMES: typeof Fin5AppNames;
93
- }
94
- export declare enum Fin5AppNames {
95
- EQUIP = "equip",
96
- GRAPHICS = "graphics",
97
- POINTS = "points",
98
- ALARMS = "alarms",
99
- NOTES = "notes",
100
- SUMMARY = "summary",
101
- SUMMARY_TOPICS = "summaryList",
102
- TOOLS = "tools",
103
- SCHEDULES = "schedules",
104
- SCHEDULE_LIST = "scheduleList",
105
- HISTORIAN = "trends",
106
- TREND_LIST = "trendList",
107
- SEARCH = "search",
108
- LOGOUT = "logout",
109
- GENERIC = "generic",
110
- REPORTS = "reports"
111
- }
112
- interface LanguageManager {
113
- currentLang: string;
114
- }
115
- interface Fin5AppComponent {
116
- set: (value: unknown) => Promise<undefined>;
117
- }
118
- export type TargetRef = string | null | undefined;
119
- export interface ColorScheme {
120
- primary: string;
121
- bodyBackground: string;
122
- sidebarBackground: string;
123
- }
124
- 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 {};
@@ -1,50 +1,58 @@
1
- /*
2
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
- */
4
- class Fin5TopRetriever {
5
- static _fin5Top;
6
- static get fin5Top() {
7
- return this.getFin5top();
8
- }
9
- static getFin5top = (notifyFailure) => {
10
- if (this._fin5Top === undefined) {
11
- this._fin5Top = isWindowTopFin5(notifyFailure)
12
- ? window.top // Cast to unknown to obscure properties from Window to simplify usage.
13
- : null;
14
- }
15
- return this._fin5Top;
16
- };
17
- }
18
- export const getFin5top = Fin5TopRetriever.getFin5top;
19
- export const fin5Top = Fin5TopRetriever.fin5Top;
20
- export function isWindowTopFin5(notifyFailure) {
21
- try {
22
- window?.top?.origin;
23
- if (window.top.finstack) {
24
- return true;
25
- }
26
- }
27
- catch { }
28
- notifyFailure?.();
29
- return false;
30
- }
31
- export var Fin5AppNames;
32
- (function (Fin5AppNames) {
33
- Fin5AppNames["EQUIP"] = "equip";
34
- Fin5AppNames["GRAPHICS"] = "graphics";
35
- Fin5AppNames["POINTS"] = "points";
36
- Fin5AppNames["ALARMS"] = "alarms";
37
- Fin5AppNames["NOTES"] = "notes";
38
- Fin5AppNames["SUMMARY"] = "summary";
39
- Fin5AppNames["SUMMARY_TOPICS"] = "summaryList";
40
- Fin5AppNames["TOOLS"] = "tools";
41
- Fin5AppNames["SCHEDULES"] = "schedules";
42
- Fin5AppNames["SCHEDULE_LIST"] = "scheduleList";
43
- Fin5AppNames["HISTORIAN"] = "trends";
44
- Fin5AppNames["TREND_LIST"] = "trendList";
45
- Fin5AppNames["SEARCH"] = "search";
46
- Fin5AppNames["LOGOUT"] = "logout";
47
- Fin5AppNames["GENERIC"] = "generic";
48
- Fin5AppNames["REPORTS"] = "reports";
49
- })(Fin5AppNames || (Fin5AppNames = {}));
1
+ /*
2
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
+ */
4
+ class Fin5TopRetriever {
5
+ static _fin5Top;
6
+ static get fin5Top() {
7
+ return this.getFin5top();
8
+ }
9
+ static getFin5top = (notifyFailure) => {
10
+ if (this._fin5Top === undefined) {
11
+ this._fin5Top = isWindowTopFin5(notifyFailure)
12
+ ? window.top // Cast to unknown to obscure properties from Window to simplify usage.
13
+ : null;
14
+ }
15
+ return this._fin5Top;
16
+ };
17
+ }
18
+ export const getFin5top = Fin5TopRetriever.getFin5top;
19
+ export const fin5Top = Fin5TopRetriever.fin5Top;
20
+ export function isWindowTopFin5(notifyFailure) {
21
+ try {
22
+ window?.top?.origin;
23
+ if (window.top.finstack) {
24
+ return true;
25
+ }
26
+ }
27
+ catch { }
28
+ notifyFailure?.();
29
+ return false;
30
+ }
31
+ export var Fin5AppNames;
32
+ (function (Fin5AppNames) {
33
+ Fin5AppNames["EQUIP"] = "equip";
34
+ Fin5AppNames["GRAPHICS"] = "graphics";
35
+ Fin5AppNames["POINTS"] = "points";
36
+ Fin5AppNames["ALARMS"] = "alarms";
37
+ Fin5AppNames["NOTES"] = "notes";
38
+ Fin5AppNames["SUMMARY"] = "summary";
39
+ Fin5AppNames["SUMMARY_TOPICS"] = "summaryList";
40
+ Fin5AppNames["TOOLS"] = "tools";
41
+ Fin5AppNames["SCHEDULES"] = "schedules";
42
+ Fin5AppNames["SCHEDULE_LIST"] = "scheduleList";
43
+ Fin5AppNames["HISTORIAN"] = "trends";
44
+ Fin5AppNames["TREND_LIST"] = "trendList";
45
+ Fin5AppNames["CHARTS"] = "charts";
46
+ Fin5AppNames["CHART_LIST"] = "chartList";
47
+ Fin5AppNames["SEARCH"] = "search";
48
+ Fin5AppNames["LOGOUT"] = "logout";
49
+ Fin5AppNames["GENERIC"] = "generic";
50
+ Fin5AppNames["REPORTS"] = "reports";
51
+ Fin5AppNames["FLOOR"] = "floor";
52
+ Fin5AppNames["BUILDER"] = "builder";
53
+ Fin5AppNames["FILES"] = "files";
54
+ Fin5AppNames["HOME"] = "home";
55
+ Fin5AppNames["DASHBOARD"] = "dashboard";
56
+ Fin5AppNames["SETTINGS"] = "settings";
57
+ })(Fin5AppNames || (Fin5AppNames = {}));
50
58
  //# sourceMappingURL=fin5Top.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"fin5Top.js","sourceRoot":"","sources":["../../src/fin5Top/fin5Top.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,MAAM,gBAAgB;IACb,MAAM,CAAC,QAAQ,CAAgB;IAEvC,MAAM,KAAK,OAAO;QACjB,OAAO,IAAI,CAAC,UAAU,EAAE,CAAA;IACzB,CAAC;IACD,MAAM,CAAC,UAAU,GAAG,CAAC,aAA0B,EAAkB,EAAE;QAClE,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAC,aAAa,CAAC;gBAC7C,CAAC,CAAE,MAAM,CAAC,GAA0B,CAAC,uEAAuE;gBAC5G,CAAC,CAAC,IAAI,CAAA;SACP;QACD,OAAO,IAAI,CAAC,QAAQ,CAAA;IACrB,CAAC,CAAA;;AAGF,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAA;AAErD,MAAM,CAAC,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAA;AAE/C,MAAM,UAAU,eAAe,CAAC,aAA0B;IACzD,IAAI;QACH,MAAM,EAAE,GAAG,EAAE,MAAM,CAAA;QACnB,IAAK,MAAM,CAAC,GAA0B,CAAC,QAAQ,EAAE;YAChD,OAAO,IAAI,CAAA;SACX;KACD;IAAC,MAAM,GAAE;IACV,aAAa,EAAE,EAAE,CAAA;IACjB,OAAO,KAAK,CAAA;AACb,CAAC;AAwHD,MAAM,CAAN,IAAY,YAiBX;AAjBD,WAAY,YAAY;IACvB,+BAAe,CAAA;IACf,qCAAqB,CAAA;IACrB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,8CAA8B,CAAA;IAC9B,+BAAe,CAAA;IACf,uCAAuB,CAAA;IACvB,8CAA8B,CAAA;IAC9B,oCAAoB,CAAA;IACpB,wCAAwB,CAAA;IACxB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,mCAAmB,CAAA;AACpB,CAAC,EAjBW,YAAY,KAAZ,YAAY,QAiBvB"}
1
+ {"version":3,"file":"fin5Top.js","sourceRoot":"","sources":["../../src/fin5Top/fin5Top.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,MAAM,gBAAgB;IACb,MAAM,CAAC,QAAQ,CAAgB;IAEvC,MAAM,KAAK,OAAO;QACjB,OAAO,IAAI,CAAC,UAAU,EAAE,CAAA;IACzB,CAAC;IACD,MAAM,CAAC,UAAU,GAAG,CAAC,aAA0B,EAAkB,EAAE;QAClE,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAC,aAAa,CAAC;gBAC7C,CAAC,CAAE,MAAM,CAAC,GAA0B,CAAC,uEAAuE;gBAC5G,CAAC,CAAC,IAAI,CAAA;SACP;QACD,OAAO,IAAI,CAAC,QAAQ,CAAA;IACrB,CAAC,CAAA;;AAGF,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAA;AAErD,MAAM,CAAC,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAA;AAE/C,MAAM,UAAU,eAAe,CAAC,aAA0B;IACzD,IAAI;QACH,MAAM,EAAE,GAAG,EAAE,MAAM,CAAA;QACnB,IAAK,MAAM,CAAC,GAA0B,CAAC,QAAQ,EAAE;YAChD,OAAO,IAAI,CAAA;SACX;KACD;IAAC,MAAM,GAAE;IACV,aAAa,EAAE,EAAE,CAAA;IACjB,OAAO,KAAK,CAAA;AACb,CAAC;AA2JD,MAAM,CAAN,IAAY,YAyBX;AAzBD,WAAY,YAAY;IACvB,+BAAe,CAAA;IACf,qCAAqB,CAAA;IACrB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,8CAA8B,CAAA;IAC9B,+BAAe,CAAA;IACf,uCAAuB,CAAA;IACvB,8CAA8B,CAAA;IAC9B,oCAAoB,CAAA;IACpB,wCAAwB,CAAA;IACxB,iCAAiB,CAAA;IACjB,wCAAwB,CAAA;IACxB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;IACnB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,6BAAa,CAAA;IACb,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;AACtB,CAAC,EAzBW,YAAY,KAAZ,YAAY,QAyBvB"}
@@ -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,12 +1,12 @@
1
- import { finCsrfFetch } from 'haystack-nclient';
2
- /**
3
- * Get the URI to register the FIN instance to Edge2Cloud.
4
- * The URI can be used to provide a link, or to create the registration QR code.
5
- * @returns the URI as a string
6
- */
7
- export const getEdge2CloudRegistrationUri = async () => {
8
- const response = await finCsrfFetch('/finEdge2Cloud/devreg');
9
- const json = await response.json();
10
- return json.uri;
11
- };
1
+ import { finCsrfFetch } from 'haystack-nclient';
2
+ /**
3
+ * Get the URI to register the FIN instance to Edge2Cloud.
4
+ * The URI can be used to provide a link, or to create the registration QR code.
5
+ * @returns the URI as a string
6
+ */
7
+ export const getEdge2CloudRegistrationUri = async () => {
8
+ const response = await finCsrfFetch('/finEdge2Cloud/devreg');
9
+ const json = await response.json();
10
+ return json.uri;
11
+ };
12
12
  //# 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,6 +1,6 @@
1
- /*
2
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
- */
4
- import { fin5Top } from './fin5Top';
5
- export const getFin5BinUrl = (id, projectName = fin5Top?.finstack?.projectName) => `/finGetFile/${projectName}?fileRef=${id?.toAxon()}`;
1
+ /*
2
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
3
+ */
4
+ import { fin5Top } from './fin5Top';
5
+ export const getFin5BinUrl = (id, projectName = fin5Top?.finstack?.projectName) => `/finGetFile/${projectName}?fileRef=${id?.toAxon()}`;
6
6
  //# 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 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>;