@vertigis/workflow 5.35.1 → 5.37.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 (526) hide show
  1. package/Activator.d.ts +25 -25
  2. package/Collections.d.ts +83 -91
  3. package/EnumUtils.d.ts +28 -28
  4. package/Errors.d.ts +155 -155
  5. package/Hooks.d.ts +32 -32
  6. package/IActivityHandler.d.ts +101 -106
  7. package/LanguageStringUtils.d.ts +16 -17
  8. package/LanguageStringUtils.js +1 -1
  9. package/ProgramInspectorFacility.d.ts +23 -24
  10. package/Task.d.ts +56 -56
  11. package/TemplateUtils.d.ts +28 -28
  12. package/Validation.d.ts +151 -26
  13. package/Validation.js +1 -1
  14. package/activities/app/GetApplicationData.d.ts +15 -12
  15. package/activities/app/GetApplicationData.js +1 -1
  16. package/activities/app/GetApplicationInfo.d.ts +15 -15
  17. package/activities/app/GetUserInfo.d.ts +15 -15
  18. package/activities/app/PublishEvent.d.ts +14 -14
  19. package/activities/app/RemoveApplicationData.d.ts +14 -11
  20. package/activities/app/RemoveApplicationData.js +1 -1
  21. package/activities/app/RunCommand.d.ts +17 -17
  22. package/activities/app/RunOperation.d.ts +25 -25
  23. package/activities/app/SetApplicationData.d.ts +13 -10
  24. package/activities/app/SetApplicationData.js +1 -1
  25. package/activities/app/applicationData.d.ts +12 -0
  26. package/activities/app/applicationData.js +1 -0
  27. package/activities/arcgis/AddAttachment.d.ts +22 -22
  28. package/activities/arcgis/AddAttachment.js +1 -1
  29. package/activities/arcgis/AddFeatureLayer.d.ts +23 -23
  30. package/activities/arcgis/AddFeatureLayer.js +1 -1
  31. package/activities/arcgis/AddFeatures.d.ts +27 -27
  32. package/activities/arcgis/AddFeatures.js +1 -1
  33. package/activities/arcgis/AddGraphics.d.ts +27 -27
  34. package/activities/arcgis/AddGraphics.js +1 -1
  35. package/activities/arcgis/ArcadeScript.d.ts +17 -18
  36. package/activities/arcgis/ArcadeScript.js +1 -1
  37. package/activities/arcgis/AreaEngineTask.d.ts +20 -20
  38. package/activities/arcgis/AreaEngineTask.js +1 -1
  39. package/activities/arcgis/BufferEngineTask.d.ts +27 -27
  40. package/activities/arcgis/BufferEngineTask.js +1 -1
  41. package/activities/arcgis/BufferServiceTask.d.ts +33 -33
  42. package/activities/arcgis/BufferServiceTask.js +1 -1
  43. package/activities/arcgis/CastGeometry.d.ts +23 -23
  44. package/activities/arcgis/ClearGraphics.d.ts +12 -12
  45. package/activities/arcgis/ClearGraphics.js +1 -1
  46. package/activities/arcgis/ClipEngineTask.d.ts +18 -18
  47. package/activities/arcgis/ClipEngineTask.js +1 -1
  48. package/activities/arcgis/ClosestFacilityTask.d.ts +90 -90
  49. package/activities/arcgis/ClosestFacilityTask.js +1 -1
  50. package/activities/arcgis/CompareGeometries.d.ts +19 -19
  51. package/activities/arcgis/CompareGeometries.js +1 -1
  52. package/activities/arcgis/ConvertValueToArcGisFieldType.d.ts +13 -0
  53. package/activities/arcgis/ConvertValueToArcGisFieldType.js +1 -0
  54. package/activities/arcgis/CreateFeatureSet.d.ts +16 -16
  55. package/activities/arcgis/CreateFeatureSet.js +1 -1
  56. package/activities/arcgis/CreateGraphic.d.ts +17 -17
  57. package/activities/arcgis/CreateGraphic.js +1 -1
  58. package/activities/arcgis/CreatePoint.d.ts +17 -17
  59. package/activities/arcgis/CutEngineTask.d.ts +18 -18
  60. package/activities/arcgis/CutEngineTask.js +1 -1
  61. package/activities/arcgis/DeleteAttachments.d.ts +22 -22
  62. package/activities/arcgis/DeleteAttachments.js +1 -1
  63. package/activities/arcgis/DeleteFeatures.d.ts +30 -30
  64. package/activities/arcgis/DeleteFeatures.js +1 -1
  65. package/activities/arcgis/DensifyEngineTask.d.ts +20 -20
  66. package/activities/arcgis/DensifyEngineTask.js +1 -1
  67. package/activities/arcgis/DifferenceEngineTask.d.ts +23 -23
  68. package/activities/arcgis/DifferenceEngineTask.js +1 -1
  69. package/activities/arcgis/DistanceEngineTask.d.ts +20 -20
  70. package/activities/arcgis/DistanceEngineTask.js +1 -1
  71. package/activities/arcgis/DistanceServiceTask.d.ts +24 -24
  72. package/activities/arcgis/DistanceServiceTask.js +1 -1
  73. package/activities/arcgis/ExtendedSpatialReferenceInfoEngineTask.d.ts +17 -17
  74. package/activities/arcgis/FeatureSetFromJson.d.ts +16 -16
  75. package/activities/arcgis/FeatureTableMap.d.ts +12 -12
  76. package/activities/arcgis/FlipEngineTask.d.ts +21 -21
  77. package/activities/arcgis/FlipEngineTask.js +1 -1
  78. package/activities/arcgis/FromGeoCoordinateStringServiceTask.d.ts +24 -24
  79. package/activities/arcgis/GeneralizeEngineTask.d.ts +22 -22
  80. package/activities/arcgis/GeneralizeEngineTask.js +1 -1
  81. package/activities/arcgis/GenerateArcGisToken.d.ts +23 -23
  82. package/activities/arcgis/GenerateWebmapForReport.d.ts +20 -20
  83. package/activities/arcgis/GenerateWebmapForReport.js +1 -1
  84. package/activities/arcgis/Geocode.d.ts +37 -38
  85. package/activities/arcgis/Geocode.js +1 -1
  86. package/activities/arcgis/GeometryFromJson.d.ts +16 -16
  87. package/activities/arcgis/Geoprocessing.d.ts +25 -26
  88. package/activities/arcgis/Geoprocessing.js +1 -1
  89. package/activities/arcgis/GeoprocessingAsync.d.ts +36 -37
  90. package/activities/arcgis/GeoprocessingAsync.js +1 -1
  91. package/activities/arcgis/GetAttributeValue.d.ts +22 -22
  92. package/activities/arcgis/GetAttributeValues.d.ts +20 -20
  93. package/activities/arcgis/GetCentroid.d.ts +16 -16
  94. package/activities/arcgis/GetCodedValueDomain.d.ts +29 -29
  95. package/activities/arcgis/GetCodedValueDomain.js +1 -1
  96. package/activities/arcgis/GetCurrentPosition.d.ts +46 -46
  97. package/activities/arcgis/GetFeatureGeometries.d.ts +20 -20
  98. package/activities/arcgis/GetFeatureGeometry.d.ts +18 -18
  99. package/activities/arcgis/GetFeatureLayerInfo.d.ts +22 -22
  100. package/activities/arcgis/GetFeatureLayerInfo.js +1 -1
  101. package/activities/arcgis/GetFeatureSetExtent.d.ts +18 -18
  102. package/activities/arcgis/GetFeatureSetObjectIds.d.ts +20 -20
  103. package/activities/arcgis/GetFormElementItemsFromFeatures.d.ts +49 -50
  104. package/activities/arcgis/GetFormElementItemsFromFeatures.js +1 -1
  105. package/activities/arcgis/GetGeometryExtent.d.ts +17 -17
  106. package/activities/arcgis/GetGraphics.d.ts +19 -19
  107. package/activities/arcgis/GetGraphics.js +1 -1
  108. package/activities/arcgis/GetLayer.d.ts +21 -21
  109. package/activities/arcgis/GetLayer.js +1 -1
  110. package/activities/arcgis/GetLayerDefinitionExpression.d.ts +18 -18
  111. package/activities/arcgis/GetLayerDefinitionExpression.js +1 -1
  112. package/activities/arcgis/GetLayerProperty.d.ts +18 -18
  113. package/activities/arcgis/GetLayerProperty.js +1 -1
  114. package/activities/arcgis/GetLayerVisibility.d.ts +18 -18
  115. package/activities/arcgis/GetLayerVisibility.js +1 -1
  116. package/activities/arcgis/GetMap.d.ts +11 -11
  117. package/activities/arcgis/GetMap.js +1 -1
  118. package/activities/arcgis/GetMapScreenshot.d.ts +18 -18
  119. package/activities/arcgis/GetPortalUser.d.ts +20 -20
  120. package/activities/arcgis/GetTable.d.ts +18 -18
  121. package/activities/arcgis/GetTable.js +1 -1
  122. package/activities/arcgis/GetViewExtent.d.ts +16 -16
  123. package/activities/arcgis/GetViewExtent.js +1 -1
  124. package/activities/arcgis/GetViewpoint.d.ts +12 -12
  125. package/activities/arcgis/GetViewpoint.js +1 -1
  126. package/activities/arcgis/IntersectEngineTask.d.ts +20 -20
  127. package/activities/arcgis/IntersectEngineTask.js +1 -1
  128. package/activities/arcgis/LabelPointsServiceTask.d.ts +18 -18
  129. package/activities/arcgis/LengthEngineTask.d.ts +20 -20
  130. package/activities/arcgis/LengthEngineTask.js +1 -1
  131. package/activities/arcgis/MapProvider.d.ts +133 -132
  132. package/activities/arcgis/MapProvider.js +1 -1
  133. package/activities/arcgis/NearestCoordinateEngineTask.d.ts +26 -26
  134. package/activities/arcgis/NearestVertexEngineTask.d.ts +26 -26
  135. package/activities/arcgis/NearestVertexEngineTask.js +1 -1
  136. package/activities/arcgis/NearestVerticesEngineTask.d.ts +34 -34
  137. package/activities/arcgis/NearestVerticesEngineTask.js +1 -1
  138. package/activities/arcgis/OffsetEngineTask.d.ts +25 -25
  139. package/activities/arcgis/OffsetEngineTask.js +1 -1
  140. package/activities/arcgis/ProjectServiceTask.d.ts +27 -27
  141. package/activities/arcgis/ProjectServiceTask.js +1 -1
  142. package/activities/arcgis/QueryAttachmentInfos.d.ts +21 -21
  143. package/activities/arcgis/QueryAttachmentInfos.js +1 -1
  144. package/activities/arcgis/QueryTask.d.ts +77 -77
  145. package/activities/arcgis/QueryTask.js +1 -1
  146. package/activities/arcgis/RefreshLayer.d.ts +12 -12
  147. package/activities/arcgis/RegisterCorsUrl.d.ts +21 -21
  148. package/activities/arcgis/RelateEngineTask.d.ts +22 -22
  149. package/activities/arcgis/RelateEngineTask.js +1 -1
  150. package/activities/arcgis/RelationServiceTask.d.ts +29 -29
  151. package/activities/arcgis/RelationServiceTask.js +1 -1
  152. package/activities/arcgis/RelationshipQueryTask.d.ts +37 -38
  153. package/activities/arcgis/RelationshipQueryTask.js +1 -1
  154. package/activities/arcgis/RemoveFeatureSetFields.d.ts +22 -22
  155. package/activities/arcgis/RemoveFeatureSetFields.js +1 -1
  156. package/activities/arcgis/RemoveGraphics.d.ts +14 -14
  157. package/activities/arcgis/RemoveGraphics.js +1 -1
  158. package/activities/arcgis/RemoveLayer.d.ts +16 -16
  159. package/activities/arcgis/RemoveLayer.js +1 -1
  160. package/activities/arcgis/RendererFromJson.d.ts +16 -16
  161. package/activities/arcgis/ReshapeServiceTask.d.ts +20 -20
  162. package/activities/arcgis/ReverseGeocode.d.ts +31 -31
  163. package/activities/arcgis/ReverseGeocode.js +1 -1
  164. package/activities/arcgis/RotateEngineTask.d.ts +20 -20
  165. package/activities/arcgis/RotateEngineTask.js +1 -1
  166. package/activities/arcgis/RouteTask.d.ts +91 -91
  167. package/activities/arcgis/RouteTask.js +1 -1
  168. package/activities/arcgis/RunPrint.d.ts +33 -34
  169. package/activities/arcgis/RunPrint.js +1 -1
  170. package/activities/arcgis/RunReport.d.ts +37 -38
  171. package/activities/arcgis/RunReport.js +1 -1
  172. package/activities/arcgis/RunWorkflow.d.ts +51 -52
  173. package/activities/arcgis/SendLayerToAttributeTable.d.ts +10 -10
  174. package/activities/arcgis/ServiceAreaTask.d.ts +87 -87
  175. package/activities/arcgis/ServiceAreaTask.js +1 -1
  176. package/activities/arcgis/SetFeatureAttribute.d.ts +15 -15
  177. package/activities/arcgis/SetFeatureGeometry.d.ts +13 -13
  178. package/activities/arcgis/SetFeaturePopup.d.ts +12 -12
  179. package/activities/arcgis/SetFeatureSymbol.d.ts +13 -13
  180. package/activities/arcgis/SetImageryLayerOptions.d.ts +27 -27
  181. package/activities/arcgis/SetImageryLayerOptions.js +1 -1
  182. package/activities/arcgis/SetLayerDefinitionExpression.d.ts +21 -21
  183. package/activities/arcgis/SetLayerDefinitionExpression.js +1 -1
  184. package/activities/arcgis/SetLayerPopup.d.ts +12 -12
  185. package/activities/arcgis/SetLayerPopup.js +1 -1
  186. package/activities/arcgis/SetLayerProperty.d.ts +23 -23
  187. package/activities/arcgis/SetLayerProperty.js +1 -1
  188. package/activities/arcgis/SetLayerVisibility.d.ts +23 -23
  189. package/activities/arcgis/SetLayerVisibility.js +1 -1
  190. package/activities/arcgis/SetMap.d.ts +14 -14
  191. package/activities/arcgis/SetViewExtent.d.ts +27 -27
  192. package/activities/arcgis/SetViewExtent.js +1 -1
  193. package/activities/arcgis/SetViewpoint.d.ts +23 -23
  194. package/activities/arcgis/SetViewpoint.js +1 -1
  195. package/activities/arcgis/ShowFeaturePopup.d.ts +11 -11
  196. package/activities/arcgis/ShowFeaturePopup.js +1 -1
  197. package/activities/arcgis/ShowResults.d.ts +51 -51
  198. package/activities/arcgis/SimplifyEngineTask.d.ts +15 -15
  199. package/activities/arcgis/SimplifyEngineTask.js +1 -1
  200. package/activities/arcgis/SortFeatureSet.d.ts +20 -20
  201. package/activities/arcgis/SymbolFromJson.d.ts +16 -16
  202. package/activities/arcgis/ToGeoCoordinateStringServiceTask.d.ts +30 -30
  203. package/activities/arcgis/TypeChecking.d.ts +46 -46
  204. package/activities/arcgis/UnionEngineTask.d.ts +19 -19
  205. package/activities/arcgis/UnionEngineTask.js +1 -1
  206. package/activities/arcgis/UnionServiceTask.d.ts +20 -20
  207. package/activities/arcgis/UpdateAttachment.d.ts +29 -29
  208. package/activities/arcgis/UpdateAttachment.js +1 -1
  209. package/activities/arcgis/UpdateFeatures.d.ts +27 -27
  210. package/activities/arcgis/UpdateFeatures.js +1 -1
  211. package/activities/arcgis/libs/arcGisRestApi.d.ts +18 -25
  212. package/activities/arcgis/runUtils.d.ts +93 -93
  213. package/activities/arcgis/shared.d.ts +61 -61
  214. package/activities/arcgis/tools.d.ts +42 -49
  215. package/activities/arcgis/tools.js +1 -1
  216. package/activities/browser/GetBrowserInfo.d.ts +13 -13
  217. package/activities/browser/InjectCss.d.ts +11 -11
  218. package/activities/constants.d.ts +19 -19
  219. package/activities/core/AddItem.d.ts +12 -12
  220. package/activities/core/AddItems.d.ts +12 -12
  221. package/activities/core/Annotation.d.ts +8 -8
  222. package/activities/core/Cast.d.ts +16 -16
  223. package/activities/core/ChannelProvider.d.ts +89 -90
  224. package/activities/core/ChannelProvider.js +1 -1
  225. package/activities/core/ClearItems.d.ts +10 -10
  226. package/activities/core/Container.d.ts +7 -7
  227. package/activities/core/ConvertBytesToText.d.ts +14 -14
  228. package/activities/core/ConvertDataTableToFeatureSet.d.ts +12 -12
  229. package/activities/core/ConvertTextToBytes.d.ts +14 -14
  230. package/activities/core/ConvertToJson.d.ts +16 -16
  231. package/activities/core/ConvertToJson.js +1 -1
  232. package/activities/core/CreateFile.d.ts +18 -18
  233. package/activities/core/CreateValue.d.ts +21 -21
  234. package/activities/core/DecodeUriComponent.d.ts +14 -14
  235. package/activities/core/Delay.d.ts +18 -18
  236. package/activities/core/EncodeUriComponent.d.ts +14 -14
  237. package/activities/core/Evaluate.d.ts +18 -18
  238. package/activities/core/EvaluateAsync.d.ts +18 -18
  239. package/activities/core/Exit.d.ts +7 -7
  240. package/activities/core/ForEach.d.ts +25 -26
  241. package/activities/core/FormatDate.d.ts +23 -23
  242. package/activities/core/GetBase64StringFromBytes.d.ts +15 -15
  243. package/activities/core/GetBase64StringFromFile.d.ts +15 -15
  244. package/activities/core/GetBytesFromBase64String.d.ts +15 -15
  245. package/activities/core/GetFirstItem.d.ts +14 -14
  246. package/activities/core/GetItemAtIndex.d.ts +15 -15
  247. package/activities/core/GetLastItem.d.ts +14 -14
  248. package/activities/core/GetLogLevel.d.ts +9 -9
  249. package/activities/core/GetTextFromFile.d.ts +16 -16
  250. package/activities/core/GetWorkflowInputs.d.ts +12 -12
  251. package/activities/core/If.d.ts +18 -18
  252. package/activities/core/Log.d.ts +14 -14
  253. package/activities/core/Log.js +1 -1
  254. package/activities/core/Loop.d.ts +27 -27
  255. package/activities/core/Loop.js +1 -1
  256. package/activities/core/ParseJson.d.ts +16 -16
  257. package/activities/core/ParseNumber.d.ts +12 -12
  258. package/activities/core/ParseUrl.d.ts +24 -25
  259. package/activities/core/ParseUrl.js +1 -1
  260. package/activities/core/Placeholder.d.ts +6 -6
  261. package/activities/core/RegexMatches.d.ts +17 -17
  262. package/activities/core/RegexReplace.d.ts +18 -18
  263. package/activities/core/RemoveItem.d.ts +14 -14
  264. package/activities/core/RunActivity.d.ts +12 -13
  265. package/activities/core/RunSubworkflow.d.ts +14 -15
  266. package/activities/core/SetLogLevel.d.ts +9 -9
  267. package/activities/core/SetProperty.d.ts +15 -15
  268. package/activities/core/SetWorkflowOutput.d.ts +12 -12
  269. package/activities/core/Subworkflow.d.ts +14 -15
  270. package/activities/core/Switch.d.ts +19 -19
  271. package/activities/core/TextReplace.d.ts +16 -16
  272. package/activities/core/Throw.d.ts +12 -12
  273. package/activities/core/TryCatch.d.ts +12 -12
  274. package/activities/core/WebRequest.d.ts +49 -50
  275. package/activities/core/WebRequest.js +1 -1
  276. package/activities/core/converters.d.ts +10 -10
  277. package/activities/csv/ConvertCsvToDataTable.d.ts +15 -15
  278. package/activities/csv/ConvertDataTableToCsv.d.ts +15 -15
  279. package/activities/essentials/GetEssentialsSite.d.ts +225 -225
  280. package/activities/essentials/RunEssentialsWorkflow.d.ts +25 -26
  281. package/activities/essentials/RunEssentialsWorkflow.js +1 -1
  282. package/activities/essentials/RunEssentialsWorkflowActivity.d.ts +17 -18
  283. package/activities/forms/ActivateFormElement.d.ts +13 -13
  284. package/activities/forms/ActivateFormElement.js +1 -1
  285. package/activities/forms/AddFormElement.d.ts +18 -18
  286. package/activities/forms/ClearFormElementError.d.ts +13 -13
  287. package/activities/forms/ClearFormElementError.js +1 -1
  288. package/activities/forms/CompleteForm.d.ts +11 -11
  289. package/activities/forms/DisplayForm.d.ts +48 -49
  290. package/activities/forms/DisplayForm.js +1 -1
  291. package/activities/forms/Errors.d.ts +18 -18
  292. package/activities/forms/FilterFormElementItems.d.ts +16 -16
  293. package/activities/forms/FormElementMap.d.ts +13 -13
  294. package/activities/forms/FormRenderer.d.ts +139 -134
  295. package/activities/forms/FormRenderer.js +1 -1
  296. package/activities/forms/GetFormElementItemsFromCollection.d.ts +49 -50
  297. package/activities/forms/GetFormElementItemsFromCollection.js +1 -1
  298. package/activities/forms/GetFormElementProperty.d.ts +19 -19
  299. package/activities/forms/GetFormElementValue.d.ts +17 -17
  300. package/activities/forms/GetFormEventData.d.ts +17 -17
  301. package/activities/forms/HideFormElement.d.ts +13 -13
  302. package/activities/forms/HideFormElement.js +1 -1
  303. package/activities/forms/PropagateFormEvent.d.ts +10 -10
  304. package/activities/forms/SetCurrentFormElementItem.d.ts +18 -18
  305. package/activities/forms/SetCurrentFormElementItem.js +1 -1
  306. package/activities/forms/SetFormElementError.d.ts +17 -17
  307. package/activities/forms/SetFormElementError.js +1 -1
  308. package/activities/forms/SetFormElementEvent.d.ts +18 -18
  309. package/activities/forms/SetFormElementItemProperty.d.ts +34 -21
  310. package/activities/forms/SetFormElementItemProperty.js +1 -1
  311. package/activities/forms/SetFormElementItems.d.ts +18 -19
  312. package/activities/forms/SetFormElementItems.js +1 -1
  313. package/activities/forms/SetFormElementProperty.d.ts +32 -19
  314. package/activities/forms/SetFormElementProperty.js +1 -1
  315. package/activities/forms/ShowFormElement.d.ts +15 -15
  316. package/activities/forms/ShowFormElement.js +1 -1
  317. package/activities/image/GetImageMetadata.d.ts +16 -16
  318. package/activities/image/RotateImage.d.ts +15 -15
  319. package/activities/index.d.ts +4 -2
  320. package/activities/index.js +1 -1
  321. package/activities/main.d.ts +1 -1
  322. package/activities/math/Abs.d.ts +14 -14
  323. package/activities/math/Cos.d.ts +14 -14
  324. package/activities/math/Max.d.ts +16 -16
  325. package/activities/math/Min.d.ts +16 -16
  326. package/activities/math/Pow.d.ts +15 -15
  327. package/activities/math/Random.d.ts +10 -10
  328. package/activities/math/Sin.d.ts +14 -14
  329. package/activities/math/Sqrt.d.ts +14 -14
  330. package/activities/math/Tan.d.ts +14 -14
  331. package/activities/pdf/AddGeoreferenceToPdf.d.ts +19 -19
  332. package/activities/pdf/AddImageToPdf.d.ts +63 -0
  333. package/activities/pdf/AddImageToPdf.js +1 -0
  334. package/activities/pdf/AddTextToPdf.d.ts +59 -0
  335. package/activities/pdf/AddTextToPdf.js +1 -0
  336. package/activities/pdf/CreatePdf.d.ts +49 -0
  337. package/activities/pdf/CreatePdf.js +1 -0
  338. package/activities/pdf/ExtractPdfPages.d.ts +17 -17
  339. package/activities/pdf/MergePdfs.d.ts +15 -15
  340. package/activities/server/CopyFile.d.ts +10 -10
  341. package/activities/server/CreateDirectory.d.ts +9 -9
  342. package/activities/server/CreateDownload.d.ts +18 -18
  343. package/activities/server/CreateEmailAttachment.d.ts +16 -16
  344. package/activities/server/CreateZipFromDirectory.d.ts +12 -12
  345. package/activities/server/DeleteDirectory.d.ts +9 -9
  346. package/activities/server/DeleteFile.d.ts +9 -9
  347. package/activities/server/DirectoryExists.d.ts +13 -13
  348. package/activities/server/ExtractZipToDirectory.d.ts +11 -11
  349. package/activities/server/FileExists.d.ts +13 -13
  350. package/activities/server/GetDirectoriesInDirectory.d.ts +14 -14
  351. package/activities/server/GetFilesInDirectory.d.ts +14 -14
  352. package/activities/server/MoveFile.d.ts +10 -10
  353. package/activities/server/ReadFile.d.ts +14 -14
  354. package/activities/server/ReadFileBytes.d.ts +13 -13
  355. package/activities/server/RunApplication.d.ts +22 -22
  356. package/activities/server/RunPython.d.ts +23 -23
  357. package/activities/server/SendEmail.d.ts +16 -16
  358. package/activities/server/SqlNonQuery.d.ts +18 -18
  359. package/activities/server/SqlQuery.d.ts +18 -18
  360. package/activities/server/SqlQueryUnsafe.d.ts +18 -18
  361. package/activities/server/WriteFile.d.ts +11 -11
  362. package/activities/server/WriteFileBytes.d.ts +10 -10
  363. package/activities/ui/Alert.d.ts +17 -17
  364. package/activities/ui/Confirm.d.ts +24 -24
  365. package/activities/ui/Prompt.d.ts +26 -26
  366. package/activities/wab/OpenWidget.d.ts +10 -10
  367. package/activities/wab/PublishWidgetData.d.ts +11 -11
  368. package/activities/xlsx/ConvertDataTableToXlsx.d.ts +15 -15
  369. package/activities/xlsx/ConvertXlsxToDataSet.d.ts +15 -15
  370. package/constants.d.ts +2 -2
  371. package/definition/Activity.d.ts +12 -13
  372. package/definition/ActivityInput.d.ts +31 -31
  373. package/definition/Component.d.ts +10 -10
  374. package/definition/DeploymentConfig.d.ts +4 -5
  375. package/definition/Form.d.ts +5 -5
  376. package/definition/Program.d.ts +29 -30
  377. package/definition/ProgramInspector.d.ts +290 -288
  378. package/definition/ProgramInspector.js +1 -1
  379. package/definition/Reference.d.ts +11 -11
  380. package/definition/Resource.d.ts +26 -26
  381. package/definition/Step.d.ts +9 -9
  382. package/definition/Transition.d.ts +17 -17
  383. package/diagnostics/ConsoleDebugLogger.d.ts +10 -10
  384. package/diagnostics/logging.d.ts +5 -5
  385. package/execution/ActivityLoader.d.ts +23 -24
  386. package/execution/ActivityLoader.js +1 -1
  387. package/execution/Engine.d.ts +84 -85
  388. package/execution/Engine.js +1 -1
  389. package/execution/IDebugSession.d.ts +43 -44
  390. package/execution/ModuleLoader.d.ts +42 -42
  391. package/execution/ModuleLoader.js +1 -1
  392. package/execution/ProgramRunner.d.ts +1 -1
  393. package/execution/ProgramRunner.js +1 -1
  394. package/forms/Calendar.d.ts +89 -89
  395. package/forms/ExclusiveTimer.d.ts +13 -13
  396. package/forms/FormComponent.d.ts +47 -30
  397. package/forms/FormComponent.js +1 -1
  398. package/forms/FormDefinition.d.ts +451 -457
  399. package/forms/FormElement.d.ts +24 -59
  400. package/forms/FormElement.js +1 -1
  401. package/forms/FormHost.d.ts +225 -233
  402. package/forms/FormHost.js +1 -1
  403. package/forms/FormPresenterHost.d.ts +62 -76
  404. package/forms/MutuallyExclusiveSectionGroup.d.ts +41 -41
  405. package/forms/NumberParser.d.ts +27 -25
  406. package/forms/NumberParser.js +1 -1
  407. package/forms/common.d.ts +67 -62
  408. package/forms/common.js +1 -1
  409. package/forms/components/AccordionGroup.d.ts +15 -15
  410. package/forms/components/AutoComplete.d.ts +8 -7
  411. package/forms/components/AutoComplete.js +1 -1
  412. package/forms/components/ButtonBar.d.ts +8 -13
  413. package/forms/components/ButtonBar.js +1 -1
  414. package/forms/components/CheckBox.d.ts +7 -7
  415. package/forms/components/CheckBox.js +1 -1
  416. package/forms/components/CheckGroup.d.ts +8 -7
  417. package/forms/components/CheckGroup.js +1 -1
  418. package/forms/components/Custom.d.ts +7 -7
  419. package/forms/components/Custom.js +1 -1
  420. package/forms/components/DatePicker.d.ts +8 -7
  421. package/forms/components/DatePicker.js +1 -1
  422. package/forms/components/DateRangePicker.d.ts +12 -11
  423. package/forms/components/DateRangePicker.js +1 -1
  424. package/forms/components/DateTimePicker.d.ts +8 -7
  425. package/forms/components/DateTimePicker.js +1 -1
  426. package/forms/components/DropDownList.d.ts +8 -7
  427. package/forms/components/DropDownList.js +1 -1
  428. package/forms/components/FilePicker.d.ts +10 -9
  429. package/forms/components/FilePicker.js +1 -1
  430. package/forms/components/Form.d.ts +23 -23
  431. package/forms/components/Form.js +1 -1
  432. package/forms/components/FormLabelNumberField.d.ts +17 -15
  433. package/forms/components/FormLabelNumberField.js +1 -1
  434. package/forms/components/GeometryPicker.d.ts +5 -4
  435. package/forms/components/GeometryPicker.js +1 -1
  436. package/forms/components/GeometryPickerListItem.d.ts +23 -23
  437. package/forms/components/HorizontalRule.d.ts +7 -7
  438. package/forms/components/Image.d.ts +7 -7
  439. package/forms/components/Image.js +1 -1
  440. package/forms/components/ItemPicker.d.ts +15 -17
  441. package/forms/components/ItemPicker.js +1 -1
  442. package/forms/components/ListBox.d.ts +8 -7
  443. package/forms/components/ListBox.js +1 -1
  444. package/forms/components/Markdown.d.ts +14 -15
  445. package/forms/components/Markdown.js +1 -1
  446. package/forms/components/Number.d.ts +8 -7
  447. package/forms/components/Number.js +1 -1
  448. package/forms/components/NumberRangeSlider.d.ts +12 -12
  449. package/forms/components/NumberRangeSlider.js +1 -1
  450. package/forms/components/NumberSlider.d.ts +11 -10
  451. package/forms/components/NumberSlider.js +1 -1
  452. package/forms/components/RadioGroup.d.ts +8 -7
  453. package/forms/components/RadioGroup.js +1 -1
  454. package/forms/components/Scanner.d.ts +11 -9
  455. package/forms/components/Scanner.js +1 -1
  456. package/forms/components/Section.d.ts +14 -14
  457. package/forms/components/Section.js +1 -1
  458. package/forms/components/Signature.d.ts +12 -11
  459. package/forms/components/Signature.js +1 -1
  460. package/forms/components/SignatureDialog.d.ts +22 -22
  461. package/forms/components/SignatureDialog.js +1 -1
  462. package/forms/components/Text.d.ts +8 -8
  463. package/forms/components/TextArea.d.ts +7 -7
  464. package/forms/components/TextArea.js +1 -1
  465. package/forms/components/TextBox.d.ts +7 -21
  466. package/forms/components/TextBox.js +1 -1
  467. package/forms/components/TimePicker.d.ts +8 -7
  468. package/forms/components/TimePicker.js +1 -1
  469. package/forms/constants.d.ts +81 -81
  470. package/forms/dateUtilities.d.ts +102 -117
  471. package/forms/dateUtilities.js +1 -1
  472. package/forms/elements/AutoComplete.d.ts +13 -13
  473. package/forms/elements/ButtonBar.d.ts +9 -9
  474. package/forms/elements/CheckBox.d.ts +7 -7
  475. package/forms/elements/CheckGroup.d.ts +11 -11
  476. package/forms/elements/Custom.d.ts +7 -7
  477. package/forms/elements/DatePicker.d.ts +6 -6
  478. package/forms/elements/DateRangePicker.d.ts +6 -6
  479. package/forms/elements/DateTimePicker.d.ts +6 -6
  480. package/forms/elements/DropDownList.d.ts +6 -6
  481. package/forms/elements/FilePicker.d.ts +8 -8
  482. package/forms/elements/GeometryPicker.d.ts +18 -18
  483. package/forms/elements/Header.d.ts +10 -10
  484. package/forms/elements/HorizontalRule.d.ts +2 -2
  485. package/forms/elements/Image.d.ts +2 -2
  486. package/forms/elements/ItemPicker.d.ts +13 -13
  487. package/forms/elements/ListBox.d.ts +11 -11
  488. package/forms/elements/Number.d.ts +11 -11
  489. package/forms/elements/NumberRangeSlider.d.ts +10 -10
  490. package/forms/elements/NumberSlider.d.ts +6 -6
  491. package/forms/elements/PasswordBox.d.ts +5 -5
  492. package/forms/elements/RadioGroup.d.ts +6 -6
  493. package/forms/elements/Scanner.d.ts +19 -19
  494. package/forms/elements/Section.d.ts +2 -2
  495. package/forms/elements/Signature.d.ts +16 -16
  496. package/forms/elements/Text.d.ts +2 -2
  497. package/forms/elements/TextArea.d.ts +7 -7
  498. package/forms/elements/TextBox.d.ts +5 -5
  499. package/forms/elements/TimePicker.d.ts +6 -6
  500. package/forms/elements/types.d.ts +83 -83
  501. package/forms/index.d.ts +124 -72
  502. package/forms/keyboard.d.ts +9 -9
  503. package/forms/listUtilities.d.ts +3 -0
  504. package/forms/listUtilities.js +1 -0
  505. package/forms/manifest.d.ts +3 -0
  506. package/forms/manifest.js +1 -0
  507. package/forms/numberFormatter.d.ts +90 -94
  508. package/forms/numberFormatter.js +1 -1
  509. package/forms/numberUtilities.d.ts +150 -113
  510. package/forms/numberUtilities.js +1 -1
  511. package/forms/presenter.d.ts +21 -21
  512. package/forms/presenter.js +1 -1
  513. package/forms/renderers.d.ts +5 -8
  514. package/forms/renderers.js +1 -1
  515. package/forms/textUtilities.d.ts +33 -23
  516. package/forms/textUtilities.js +1 -1
  517. package/forms/utils.d.ts +177 -132
  518. package/forms/utils.js +1 -1
  519. package/index.d.ts +2 -2
  520. package/libs/version.d.ts +1 -1
  521. package/libs/version.js +1 -1
  522. package/licensing/LicenseChecker.d.ts +1 -1
  523. package/licensing/Watermark.d.ts +7 -7
  524. package/package.json +9 -11
  525. package/activities/app/constants.d.ts +0 -1
  526. package/activities/app/constants.js +0 -1
@@ -1,59 +1,24 @@
1
- import { ReactNode } from "react";
2
- import * as React from "react";
3
- import { FormComponent } from "./FormComponent";
4
- import { defs } from "./FormHost";
5
- /**
6
- * Properties common to all Form Elements.
7
- */
8
- export interface BaseFormElementProps {
9
- /** The CSS class name of the root element. */
10
- className?: string;
11
- /**
12
- * The `FormComponent` being used to render the Form Element within this Component.
13
- */
14
- component: FormComponent;
15
- /**
16
- * The Form Element to be rendered within this Component.
17
- */
18
- element: defs.Element;
19
- }
20
- interface FormElementProps extends BaseFormElementProps {
21
- /**
22
- * The id of the default input to be associated with the title.
23
- */
24
- inputId?: string;
25
- /**
26
- * Callback for when the Form Element receives focus.
27
- * @param event The focus event.
28
- */
29
- onFocusCapture?: (event: React.FocusEvent<HTMLElement>) => void;
30
- /**
31
- * Callback for when the Form Element loses focus.
32
- * @param event The blur event.
33
- */
34
- onBlurCapture?: (event: React.FocusEvent<HTMLElement>) => void;
35
- /**
36
- * Callback for when the Form Element's input changes.
37
- * @param event The change event.
38
- */
39
- onChangeCapture?: (event: React.FormEvent<HTMLElement>) => void;
40
- /**
41
- * Callback for when a key is pressed while the Form Element has focus.
42
- * @param event The keydown event.
43
- */
44
- onKeyDownCapture?: (event: React.KeyboardEvent<HTMLElement>) => void;
45
- /**
46
- * Callback for when the mouse is pressed inside the Form Element.
47
- * @param event The mousedown event.
48
- */
49
- onMouseDown?: (event: React.MouseEvent<HTMLElement>) => void;
50
- /**
51
- * Callback for when one or more touch points are placed on the Form Element.
52
- * @param event The touchstart event.
53
- */
54
- onTouchStart?: (event: React.TouchEvent<HTMLElement>) => void;
55
- }
56
- declare const _default: React.ForwardRefExoticComponent<FormElementProps & {
57
- children?: ReactNode;
58
- } & React.RefAttributes<HTMLDivElement>>;
59
- export default _default;
1
+ import { ReactNode } from "react";
2
+ import * as React from "react";
3
+ import { FormComponent } from "./FormComponent";
4
+ import { defs } from "./FormHost";
5
+ interface FormElementProps {
6
+ /** The CSS class name of the root element. */
7
+ className?: string;
8
+ /**
9
+ * The `FormComponent` being used to render the Form Element within this Component.
10
+ */
11
+ component: FormComponent;
12
+ /**
13
+ * The Form Element to be rendered within this Component.
14
+ */
15
+ element: defs.Element;
16
+ /**
17
+ * The id of the default input to be associated with the title.
18
+ */
19
+ inputId?: string;
20
+ }
21
+ declare const _default: React.ForwardRefExoticComponent<FormElementProps & {
22
+ children?: ReactNode;
23
+ } & React.RefAttributes<HTMLDivElement>>;
24
+ export default _default;
@@ -1 +1 @@
1
- import FormControl from"@vertigis/react-ui/FormControl";import clsx from"clsx";import{forwardRef}from"react";import*as React from"react";import{renderAccessibleDescription,renderDescription,renderError,renderTitle}from"./common.js";import{formClasses}from"./components/Form.js";import{TitleLocation}from"./constants.js";import{makeSafeClassName,makeUniqueId}from"./utils.js";export default forwardRef((e,r)=>{const{children:o,className:t,component:s,element:a,inputId:i,...m}=e;var n=s.props.host,l=makeUniqueId(s.props.name),p=renderTitle(n,a,l,i),c=renderDescription(n,a,l),e=renderAccessibleDescription(n,a,l),n=renderError(n,a),r={"aria-labelledby":p?.props?.id,"aria-details":c?.props?.id,"aria-describedby":e?.props?.id,className:clsx(t,a.type,{[formClasses.formElementWithTitleBeside]:a.titleLocation===TitleLocation.BESIDE,[makeSafeClassName(s.props.name)]:!!s.props.name,[makeSafeClassName(a.styleName)]:!!a.styleName}),error:!!n,id:l,ref:r,required:a.require,...m};let d=[p];return a.titleLocation===TitleLocation.BESIDE?d.push(React.createElement("div",{className:formClasses.formElementContent},c,e,n,o)):(d.push(c),d.push(e),d.push(n),d.push(o)),React.createElement(FormControl,{fullWidth:!0,...r},...d)});
1
+ import FormControl from"@vertigis/react-ui/FormControl";import clsx from"clsx";import{forwardRef}from"react";import*as React from"react";import{renderAccessibleDescription,renderDescription,renderError,renderTitle}from"./common.js";import{formClasses}from"./components/Form.js";import{TitleLocation}from"./constants.js";import{makeSafeClassName,makeUniqueId}from"./utils.js";export default forwardRef((e,r)=>{var{children:t,className:o,component:i,element:s,inputId:a}=e;const{host:m,name:n}=i.props;var l=makeUniqueId(n),c=m.translateText.bind(m),e=renderTitle(l,s.require,s.title,c,a),i=renderDescription(s.description,l,s.enabled,c),a=renderAccessibleDescription(s.accessibleDescription,s.description,l,c),c=renderError(s.error,c),r={"aria-labelledby":e?.props?.id,"aria-details":i?.props?.id,"aria-describedby":a?.props?.id,className:clsx(o,s.type,{[formClasses.formElementWithTitleBeside]:s.titleLocation===TitleLocation.BESIDE,[makeSafeClassName(n)]:!!n,[makeSafeClassName(s.styleName)]:!!s.styleName}),error:!!c,id:l,ref:r,required:s.require};let p=[e];return s.titleLocation===TitleLocation.BESIDE?p.push(React.createElement("div",{className:formClasses.formElementContent},i,a,c,t)):(p.push(i),p.push(a),p.push(c),p.push(t)),React.createElement(FormControl,{fullWidth:!0,...r},...p)});
@@ -1,233 +1,225 @@
1
- import Bluebird from "bluebird";
2
- import { Lookup } from "../Collections";
3
- import { FormComponent } from "./FormComponent";
4
- import * as defs from "./FormDefinition";
5
- import { FormPresenterHost } from "./FormPresenterHost";
6
- import { FormatOptions } from "./numberFormatter";
7
- import type { ComponentType, ReactNode } from "react";
8
- export { defs };
9
- export interface FormEventSubscription {
10
- (): boolean;
11
- active: boolean;
12
- }
13
- export interface FormEventHandler {
14
- (event: defs.Event): void;
15
- }
16
- /** Exposes functionality for driving a form. */
17
- export declare abstract class FormHost implements FormPresenterHost {
18
- /** Indicates the overall state of the form. */
19
- form: defs.Form;
20
- deriveLocale(): string;
21
- /** Indicates all errors to be assigned. */
22
- errors: Lookup<defs.Text>;
23
- /** Indicates any reference information relevant to components. */
24
- refs: {
25
- [name: string]: FormComponent | undefined;
26
- };
27
- /** Indicates if the form is enabled. */
28
- enabled: boolean;
29
- /** Indicates if the form is visible. */
30
- visible: boolean;
31
- /** Indicates if the form should be dismissed. */
32
- dismiss: boolean;
33
- /** Indicates if the form is a custom form. */
34
- custom: boolean;
35
- /** The DOM container node. */
36
- container: HTMLElement;
37
- /** The next event index. */
38
- protected eventIndex: number;
39
- /** The event queue. */
40
- protected eventQueue: defs.Event[];
41
- /** The event promise, for when the consumer is waiting. */
42
- private eventTask;
43
- /**
44
- * All elements of type "Section" with a format that is considered mutually exclusive, grouped based on continuity.
45
- * If there is another element of type "Section" with a different format in between, two of the same mutually exclusive type,
46
- * this represents the boundary between two different sets of mutually exclusive sections.
47
- *
48
- * IMPORTANT: Do not reference this directly. Instead use, `getMutuallyExclusiveSectionGroup(string)` which populates it.
49
- */
50
- private mutuallyExclusiveSections;
51
- private resolveEvent;
52
- /** The timer handler for idle/busy handling. */
53
- protected timerHandle: () => void;
54
- /** Indicates a method to restore the last focus. */
55
- protected lastFocus: {
56
- target: HTMLElement;
57
- name?: string;
58
- rowIndex?: number;
59
- rowNumber?: number;
60
- };
61
- /** Indicates the next element that should receive focus. */
62
- protected nextFocus: boolean | string;
63
- /** Indicates the next element that should receive a refresh. */
64
- protected nextRefresh: boolean | Lookup<boolean>;
65
- /** Indicates the focus observer. */
66
- protected focusObserver: (event: FocusEvent) => void;
67
- /** Indicates the style o */
68
- protected style: HTMLStyleElement;
69
- /** Mounts the form into the DOM. */
70
- protected mount(): void;
71
- /** Removes the form from the DOM. */
72
- protected unmount(): void;
73
- /** Intelligently tracks the last focus, */
74
- protected observeFocus(target: EventTarget): void;
75
- /** Focuses the form. */
76
- focus(): void;
77
- /** Focuses the form optionally focusing the initial element. */
78
- focus(initial: boolean): void;
79
- /** Focuses the form focusing the named element. */
80
- focus(name: string): void;
81
- /** Shows the form. */
82
- show(): boolean;
83
- private isInvalid;
84
- private getInvalidElements;
85
- hasInvalidChild(element: defs.Element): boolean;
86
- /** Shows the form in a disabled state. */
87
- spin(): boolean;
88
- /** Hides the form in a disabled state. */
89
- hide(): boolean;
90
- /** Disposes the form. */
91
- dispose(): boolean;
92
- /** Renders focus for just rendered elements. */
93
- renderFocus(target: HTMLElement, name?: string): boolean;
94
- /** Renders form text as HTML. */
95
- renderHtml(content: defs.Text, htmlContentCategory?: defs.HTMLContentCategory): string;
96
- /** Renders form text as plain text. */
97
- renderText(content: defs.Text | undefined): string;
98
- /**
99
- * Translates the text. This is a bit of a no-op as we only have access to the language strings
100
- * in FormRenderer.
101
- * @param content
102
- * @returns The original text
103
- */
104
- translateText(content: defs.Text | undefined): string | defs.MarkdownRef;
105
- /** Renders the form component. */
106
- renderVisual(component: {}): any;
107
- /** Qualifies an event with defaults. */
108
- protected qualifyDefault(event: defs.Event): string;
109
- /** Qualifies an event. */
110
- protected qualify(type: defs.EventType, event?: defs.Event): defs.Event;
111
- /** Posts an event. */
112
- post(type: defs.EventType, event?: defs.Event): void;
113
- /** Subscribes to all posted events (this does not capture enqueued events). */
114
- subscribe(action: FormEventHandler): FormEventSubscription;
115
- /** Forcefully refresh the form (use this with care). */
116
- refresh(name?: string): void;
117
- /** Invalidates the form with a full refresh. */
118
- invalidate(): void;
119
- /** Invalidates the form with optionally a full refresh. */
120
- invalidate(full: boolean): void;
121
- /** Invalidates the form refreshing a single element. */
122
- invalidate(name: string): void;
123
- /** Updates the form if appropriate. */
124
- update(): void;
125
- /** Clears the busy timer. */
126
- idle(): void;
127
- /** Starts the busy timer. */
128
- busy(): void;
129
- /** Publishes an event (used by post()). */
130
- publish(type: defs.EventType, event?: defs.Event): defs.Event;
131
- /** Enqueues an event (used by publish()). */
132
- enqueue(type: defs.EventType, event?: defs.Event): defs.Event;
133
- /** Dequeues the next event (used by observe()). */
134
- dequeue(): defs.Event;
135
- /** Observes the form. */
136
- observe(): Bluebird<defs.Event>;
137
- /** Loads the form. */
138
- load(): boolean;
139
- /** Loads the form with a new definition. */
140
- load(form: defs.Form, template?: defs.Form): boolean;
141
- /** Routes an event to achieve default behavior. */
142
- route(event: defs.Event): boolean;
143
- /** Generates a new changed event given the source event. */
144
- protected changed(event: defs.Event): boolean;
145
- /**
146
- * Returns true if the supplied element is considered valid, false otherwise.
147
- * @param element The element to be tested.
148
- * @param isInvisibleValid True if the element should be considered valid when not visible, false otherwise. Defaults to true.
149
- * @param result An optional object which can be passed in to capture the error status, if any.
150
- */
151
- protected isElementValid(element: defs.Element, isInvisibleValid?: boolean, result?: defs.StatusRef): boolean;
152
- /**
153
- * Returns true if the supplied element is effectively visible (i.e. has parent
154
- * section - if it exists - visible) as well as itself, false otherwise.
155
- * @param element The element to be tested.
156
- */
157
- protected isElementEffectivelyVisible(element: defs.Element): boolean;
158
- /**
159
- * Returns true if the element has a value defined. False otherwise.
160
- * @param element The element to be tested.
161
- */
162
- protected isElementValueDefined(element: defs.Element): boolean;
163
- /**
164
- * Attempts to trap the event. This is relevant during cascading behavior which affects
165
- * other elements but afterwards.
166
- */
167
- trap(event: defs.Event): boolean;
168
- /**
169
- * Cascade the form by clearing the value of any elements downstream of the specified one
170
- * and triggering the "populate" event for any elements that depend on it directly.
171
- * @param elementName The name of an elements which has just changed.
172
- * @returns True if the operation was a success, false otherwise.
173
- */
174
- protected cascade(elementName: string): boolean;
175
- /** Routes a click event. */
176
- protected click(event: defs.Event): boolean;
177
- /**
178
- * Checks the specified element to determine if it has a selection,
179
- * which would justify a dependent being populated at this time.
180
- *
181
- * This function is only interested in _initial_ selection defined in the designer
182
- * rather than changes made in an element's `load` event. Those are handled separately.
183
- * @param elementName The name of the element being depended upon.
184
- * @returns True if the element has a selection at this time.
185
- */
186
- hasInitialSelectionToDependOn(elementName: string): boolean;
187
- /** Routes a prepare event. */
188
- protected hydrate(event: defs.Event): boolean;
189
- /** Determines if the event origin is a submit button. */
190
- protected shouldTriggerValidation(event: defs.Event): boolean | void;
191
- /** Routes a validate event. */
192
- protected validate(event: defs.Event): boolean;
193
- /** Verifies the element given the event. */
194
- protected verify(event: defs.Event): boolean;
195
- /** Routes a suggest event. */
196
- protected suggest(event: defs.Event): boolean;
197
- /** Routes a submit event. */
198
- protected submit(event: defs.Event): boolean;
199
- /** Checks the form's validity. */
200
- hasErrors(): boolean;
201
- /** Finds an element. */
202
- find(name: string | {
203
- name: string;
204
- }): defs.Element;
205
- /** Finds the name of an element. */
206
- findName(element: defs.Element): string;
207
- /** Coerces a number. */
208
- coerceNumber(value: string): number;
209
- /** Formats a number. */
210
- formatNumber(value: number, options?: FormatOptions): string;
211
- /** Renders a custom element. */
212
- renderCustom(component: {}, element: defs.Element): JSX.Element;
213
- /** Renders a component's state. */
214
- renderState(name: string, type: "geometry", state?: defs.GeometryState[]): boolean;
215
- /** Renders a component's state. */
216
- renderState(name: string, type: string, state?: {}): boolean;
217
- private getParentSection;
218
- private isSectionCollapsed;
219
- private isElementPositionBeforeLastFocused;
220
- private setLastFocus;
221
- private isSection;
222
- isAccordionSection(element?: defs.Element): boolean;
223
- isCollapsibleSection(element?: defs.Element): boolean;
224
- private getAllSectionElements;
225
- private getMutuallyExclusiveSectionGroup;
226
- /**
227
- * Collapses all neighbouring accordion sections except the one specified.
228
- * @param expandedAccordionSectionName The name of the accordion section to be expanded. All others in the group will be collapsed.
229
- */
230
- updateAccordionSections(expandedAccordionSectionName: string): void;
231
- private enforceAccordionConstraints;
232
- displayDialog(children: (closeDialog: () => void) => ReactNode, DialogComponent: ComponentType<any>): Promise<void>;
233
- }
1
+ import Bluebird from "bluebird";
2
+ import { FormComponent } from "./FormComponent";
3
+ import * as defs from "./FormDefinition";
4
+ import { FormPresenterHost } from "./FormPresenterHost";
5
+ import { FormatOptions } from "./numberFormatter";
6
+ import type { ComponentType, ReactNode } from "react";
7
+ export { defs };
8
+ export interface FormEventSubscription {
9
+ (): boolean;
10
+ active: boolean;
11
+ }
12
+ export interface FormEventHandler {
13
+ (event: defs.Event): void;
14
+ }
15
+ /** Exposes functionality for driving a form. */
16
+ export declare abstract class FormHost implements FormPresenterHost {
17
+ /** Indicates the overall state of the form. */
18
+ form: defs.Form;
19
+ deriveLocale(): string;
20
+ /** Indicates all errors to be assigned. */
21
+ errors: Record<string, defs.Text | undefined>;
22
+ /** Indicates any reference information relevant to components. */
23
+ refs: {
24
+ [name: string]: FormComponent | undefined;
25
+ };
26
+ /** Indicates if the form is enabled. */
27
+ enabled: boolean;
28
+ /** Indicates if the form is visible. */
29
+ visible: boolean;
30
+ /** Indicates if the form should be dismissed. */
31
+ dismiss: boolean;
32
+ /** Indicates if the form is a custom form. */
33
+ custom: boolean;
34
+ /** The DOM container node. */
35
+ container: HTMLElement | undefined;
36
+ /** The next event index. */
37
+ protected eventIndex: number;
38
+ /** The event queue. */
39
+ protected eventQueue: defs.Event[];
40
+ /** The event promise, for when the consumer is waiting. */
41
+ private eventTask;
42
+ /**
43
+ * All elements of type "Section" with a format that is considered mutually exclusive, grouped based on continuity.
44
+ * If there is another element of type "Section" with a different format in between, two of the same mutually exclusive type,
45
+ * this represents the boundary between two different sets of mutually exclusive sections.
46
+ *
47
+ * IMPORTANT: Do not reference this directly. Instead use, `getMutuallyExclusiveSectionGroup(string)` which populates it.
48
+ */
49
+ private mutuallyExclusiveSections;
50
+ private resolveEvent;
51
+ /** The timer handler for idle/busy handling. */
52
+ protected timerHandle: (() => void) | undefined;
53
+ /** Indicates a method to restore the last focus. */
54
+ protected lastFocus: {
55
+ target: HTMLElement;
56
+ name?: string;
57
+ rowIndex?: number;
58
+ rowNumber?: number;
59
+ } | undefined;
60
+ /** Indicates the next element that should receive focus. */
61
+ protected nextFocus: boolean | string;
62
+ /** Indicates the next element that should receive a refresh. */
63
+ protected nextRefresh: boolean | Record<string, boolean>;
64
+ /** Indicates the focus observer. */
65
+ protected focusObserver: ((event: FocusEvent) => void) | undefined;
66
+ /** Indicates the style o */
67
+ protected style: HTMLStyleElement | undefined;
68
+ /** Mounts the form into the DOM. */
69
+ protected mount(): void;
70
+ /** Removes the form from the DOM. */
71
+ protected unmount(): void;
72
+ /** Intelligently tracks the last focus, */
73
+ protected observeFocus(target: EventTarget): void;
74
+ /** Focuses the form. */
75
+ focus(): void;
76
+ /** Focuses the form optionally focusing the initial element. */
77
+ focus(initial: boolean): void;
78
+ /** Focuses the form focusing the named element. */
79
+ focus(name: string): void;
80
+ /** Shows the form. */
81
+ show(): boolean;
82
+ private isInvalid;
83
+ private getInvalidElements;
84
+ hasInvalidChild(element: defs.Element): boolean;
85
+ /** Shows the form in a disabled state. */
86
+ spin(): boolean;
87
+ /** Hides the form in a disabled state. */
88
+ hide(): boolean;
89
+ /** Disposes the form. */
90
+ dispose(): boolean;
91
+ /** Renders focus for just rendered elements. */
92
+ renderFocus(target: HTMLElement, name?: string): boolean;
93
+ /** Renders form text as HTML. */
94
+ renderHtml(content: defs.Text | undefined, htmlContentCategory?: defs.HTMLContentCategory): string;
95
+ /** Renders form text as plain text. */
96
+ renderText(content: defs.Text | undefined): string;
97
+ /**
98
+ * Translates the text. This is a bit of a no-op as we only have access to
99
+ * the language strings in FormRenderer.
100
+ * @param content
101
+ * @returns The underlying text.
102
+ */
103
+ translateText(content: defs.Text | undefined): string | defs.MarkdownRef | undefined;
104
+ /** Renders the form component. */
105
+ renderVisual(component: {}): any;
106
+ /** Qualifies an event with defaults. */
107
+ protected qualifyDefault(event: defs.Event): string | undefined;
108
+ /** Qualifies an event. */
109
+ protected qualify(type: defs.EventType, event?: defs.Event): defs.Event;
110
+ /** Posts an event. */
111
+ post(type: defs.EventType, event?: defs.Event): void;
112
+ /** Subscribes to all posted events (this does not capture enqueued events). */
113
+ subscribe(action: FormEventHandler): FormEventSubscription;
114
+ /** Forcefully refresh the form (use this with care). */
115
+ refresh(name?: string): void;
116
+ /** Invalidates the form with a full refresh. */
117
+ invalidate(): void;
118
+ /** Invalidates the form with optionally a full refresh. */
119
+ invalidate(full: boolean): void;
120
+ /** Invalidates the form refreshing a single element. */
121
+ invalidate(name: string | undefined): void;
122
+ /** Updates the form if appropriate. */
123
+ update(): void;
124
+ /** Clears the busy timer. */
125
+ idle(): void;
126
+ /** Starts the busy timer. */
127
+ busy(): void;
128
+ /** Publishes an event (used by post()). */
129
+ publish(type: defs.EventType, event?: defs.Event): defs.Event;
130
+ /** Enqueues an event (used by publish()). */
131
+ enqueue(type: defs.EventType, event?: defs.Event): defs.Event;
132
+ /** Dequeues the next event (used by observe()). */
133
+ dequeue(): defs.Event | undefined;
134
+ /** Observes the form. */
135
+ observe(): Bluebird<any>;
136
+ /** Loads the form. */
137
+ load(form?: defs.Form, template?: defs.Form): boolean;
138
+ /** Routes an event to achieve default behavior. */
139
+ route(event: defs.Event): boolean;
140
+ /** Generates a new changed event given the source event. */
141
+ protected changed(event: defs.Event): boolean;
142
+ /**
143
+ * Returns true if the supplied element is considered valid, false otherwise.
144
+ * @param element The element to be tested.
145
+ * @param isInvisibleValid True if the element should be considered valid when not visible, false otherwise. Defaults to true.
146
+ * @param result An optional object which can be passed in to capture the error status, if any.
147
+ */
148
+ protected isElementValid(element: defs.Element, isInvisibleValid?: boolean, result?: Partial<defs.StatusRef>): boolean;
149
+ /**
150
+ * Returns true if the supplied element is effectively visible (i.e. has parent
151
+ * section - if it exists - visible) as well as itself, false otherwise.
152
+ * @param element The element to be tested.
153
+ */
154
+ protected isElementEffectivelyVisible(element: defs.Element | undefined): boolean;
155
+ /**
156
+ * Returns true if the element has a value defined. False otherwise.
157
+ * @param element The element to be tested.
158
+ */
159
+ protected isElementValueDefined(element: defs.Element | undefined): boolean;
160
+ /**
161
+ * Attempts to trap the event. This is relevant during cascading behavior which affects
162
+ * other elements but afterwards.
163
+ */
164
+ trap(event: defs.Event): boolean;
165
+ /**
166
+ * Cascade the form by clearing the value of any elements downstream of the specified one
167
+ * and triggering the "populate" event for any elements that depend on it directly.
168
+ * @param elementName The name of an elements which has just changed.
169
+ * @returns True if the operation was a success, false otherwise.
170
+ */
171
+ protected cascade(elementName: string): boolean;
172
+ /** Routes a click event. */
173
+ protected click(event: defs.Event): boolean;
174
+ /**
175
+ * Checks the specified element to determine if it has a selection,
176
+ * which would justify a dependent being populated at this time.
177
+ *
178
+ * This function is only interested in _initial_ selection defined in the designer
179
+ * rather than changes made in an element's `load` event. Those are handled separately.
180
+ * @param elementName The name of the element being depended upon.
181
+ * @returns True if the element has a selection at this time.
182
+ */
183
+ hasInitialSelectionToDependOn(elementName: string): boolean;
184
+ /** Routes a prepare event. */
185
+ protected hydrate(event: defs.Event): boolean;
186
+ /** Determines if the event origin is a submit button. */
187
+ protected shouldTriggerValidation(event: defs.Event): boolean | void;
188
+ /** Routes a validate event. */
189
+ protected validate(event: defs.Event): boolean;
190
+ /** Verifies the element given the event. */
191
+ protected verify(event: defs.Event): boolean;
192
+ /** Routes a suggest event. */
193
+ protected suggest(event: defs.Event): boolean;
194
+ /** Routes a submit event. */
195
+ protected submit(event: defs.Event): boolean;
196
+ /** Checks the form's validity. */
197
+ hasErrors(): boolean;
198
+ /** Finds an element. */
199
+ find(name: string | {
200
+ name: string;
201
+ } | undefined): defs.Element | undefined;
202
+ /** Finds the name of an element. */
203
+ findName(element: defs.Element | undefined): string | undefined;
204
+ /** Coerces a number. */
205
+ coerceNumber(value: string): number;
206
+ /** Formats a number. */
207
+ formatNumber(value: number, options?: FormatOptions): string;
208
+ /** Renders a component's state. */
209
+ renderState(name: string, type: "geometry", state?: defs.GeometryState[]): boolean;
210
+ /** Renders a component's state. */
211
+ renderState(name: string, type: string, state?: {}): boolean;
212
+ private getParentSection;
213
+ private isSectionCollapsed;
214
+ private isElementPositionBeforeLastFocused;
215
+ private setLastFocus;
216
+ private getAllSectionElements;
217
+ private getMutuallyExclusiveSectionGroup;
218
+ /**
219
+ * Collapses all neighbouring accordion sections except the one specified.
220
+ * @param expandedAccordionSectionName The name of the accordion section to be expanded. All others in the group will be collapsed.
221
+ */
222
+ updateAccordionSections(expandedAccordionSectionName: string): void;
223
+ private enforceAccordionConstraints;
224
+ displayDialog(children: (closeDialog: () => void) => ReactNode, DialogComponent: ComponentType<any>): Promise<void>;
225
+ }