@vertigis/workflow 5.36.0 → 5.37.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (453) 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 -101
  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/AddFeatureLayer.d.ts +23 -23
  29. package/activities/arcgis/AddFeatureLayer.js +1 -1
  30. package/activities/arcgis/AddFeatures.d.ts +27 -27
  31. package/activities/arcgis/AddGraphics.d.ts +27 -27
  32. package/activities/arcgis/ArcadeScript.d.ts +17 -18
  33. package/activities/arcgis/AreaEngineTask.d.ts +20 -20
  34. package/activities/arcgis/BufferEngineTask.d.ts +27 -27
  35. package/activities/arcgis/BufferServiceTask.d.ts +33 -33
  36. package/activities/arcgis/BufferServiceTask.js +1 -1
  37. package/activities/arcgis/CastGeometry.d.ts +23 -23
  38. package/activities/arcgis/ClearGraphics.d.ts +12 -12
  39. package/activities/arcgis/ClearGraphics.js +1 -1
  40. package/activities/arcgis/ClipEngineTask.d.ts +18 -18
  41. package/activities/arcgis/ClosestFacilityTask.d.ts +90 -90
  42. package/activities/arcgis/ClosestFacilityTask.js +1 -1
  43. package/activities/arcgis/CompareGeometries.d.ts +19 -19
  44. package/activities/arcgis/ConvertValueToArcGisFieldType.d.ts +13 -0
  45. package/activities/arcgis/ConvertValueToArcGisFieldType.js +1 -0
  46. package/activities/arcgis/CreateFeatureSet.d.ts +16 -16
  47. package/activities/arcgis/CreateFeatureSet.js +1 -1
  48. package/activities/arcgis/CreateGraphic.d.ts +17 -17
  49. package/activities/arcgis/CreateGraphic.js +1 -1
  50. package/activities/arcgis/CreatePoint.d.ts +17 -17
  51. package/activities/arcgis/CutEngineTask.d.ts +18 -18
  52. package/activities/arcgis/DeleteAttachments.d.ts +22 -22
  53. package/activities/arcgis/DeleteFeatures.d.ts +30 -30
  54. package/activities/arcgis/DensifyEngineTask.d.ts +20 -20
  55. package/activities/arcgis/DifferenceEngineTask.d.ts +23 -23
  56. package/activities/arcgis/DistanceEngineTask.d.ts +20 -20
  57. package/activities/arcgis/DistanceServiceTask.d.ts +24 -24
  58. package/activities/arcgis/DistanceServiceTask.js +1 -1
  59. package/activities/arcgis/ExtendedSpatialReferenceInfoEngineTask.d.ts +17 -17
  60. package/activities/arcgis/FeatureSetFromJson.d.ts +16 -16
  61. package/activities/arcgis/FeatureTableMap.d.ts +12 -12
  62. package/activities/arcgis/FlipEngineTask.d.ts +21 -21
  63. package/activities/arcgis/FromGeoCoordinateStringServiceTask.d.ts +24 -24
  64. package/activities/arcgis/GeneralizeEngineTask.d.ts +22 -22
  65. package/activities/arcgis/GenerateArcGisToken.d.ts +23 -23
  66. package/activities/arcgis/GenerateWebmapForReport.d.ts +20 -20
  67. package/activities/arcgis/GenerateWebmapForReport.js +1 -1
  68. package/activities/arcgis/Geocode.d.ts +37 -38
  69. package/activities/arcgis/Geocode.js +1 -1
  70. package/activities/arcgis/GeometryFromJson.d.ts +16 -16
  71. package/activities/arcgis/Geoprocessing.d.ts +25 -26
  72. package/activities/arcgis/Geoprocessing.js +1 -1
  73. package/activities/arcgis/GeoprocessingAsync.d.ts +36 -37
  74. package/activities/arcgis/GeoprocessingAsync.js +1 -1
  75. package/activities/arcgis/GetAttributeValue.d.ts +22 -22
  76. package/activities/arcgis/GetAttributeValues.d.ts +20 -20
  77. package/activities/arcgis/GetCentroid.d.ts +16 -16
  78. package/activities/arcgis/GetCodedValueDomain.d.ts +29 -29
  79. package/activities/arcgis/GetCodedValueDomain.js +1 -1
  80. package/activities/arcgis/GetCurrentPosition.d.ts +46 -46
  81. package/activities/arcgis/GetFeatureGeometries.d.ts +20 -20
  82. package/activities/arcgis/GetFeatureGeometry.d.ts +18 -18
  83. package/activities/arcgis/GetFeatureLayerInfo.d.ts +22 -22
  84. package/activities/arcgis/GetFeatureSetExtent.d.ts +18 -18
  85. package/activities/arcgis/GetFeatureSetObjectIds.d.ts +20 -20
  86. package/activities/arcgis/GetFormElementItemsFromFeatures.d.ts +49 -50
  87. package/activities/arcgis/GetFormElementItemsFromFeatures.js +1 -1
  88. package/activities/arcgis/GetGeometryExtent.d.ts +17 -17
  89. package/activities/arcgis/GetGraphics.d.ts +19 -19
  90. package/activities/arcgis/GetLayer.d.ts +21 -21
  91. package/activities/arcgis/GetLayerDefinitionExpression.d.ts +18 -18
  92. package/activities/arcgis/GetLayerProperty.d.ts +18 -18
  93. package/activities/arcgis/GetLayerVisibility.d.ts +18 -18
  94. package/activities/arcgis/GetMap.d.ts +11 -11
  95. package/activities/arcgis/GetMapScreenshot.d.ts +18 -18
  96. package/activities/arcgis/GetPortalUser.d.ts +20 -20
  97. package/activities/arcgis/GetTable.d.ts +18 -18
  98. package/activities/arcgis/GetViewExtent.d.ts +16 -16
  99. package/activities/arcgis/GetViewpoint.d.ts +12 -12
  100. package/activities/arcgis/IntersectEngineTask.d.ts +20 -20
  101. package/activities/arcgis/LabelPointsServiceTask.d.ts +18 -18
  102. package/activities/arcgis/LengthEngineTask.d.ts +20 -20
  103. package/activities/arcgis/MapProvider.d.ts +133 -132
  104. package/activities/arcgis/MapProvider.js +1 -1
  105. package/activities/arcgis/NearestCoordinateEngineTask.d.ts +26 -26
  106. package/activities/arcgis/NearestVertexEngineTask.d.ts +26 -26
  107. package/activities/arcgis/NearestVerticesEngineTask.d.ts +34 -34
  108. package/activities/arcgis/OffsetEngineTask.d.ts +25 -25
  109. package/activities/arcgis/ProjectServiceTask.d.ts +27 -27
  110. package/activities/arcgis/ProjectServiceTask.js +1 -1
  111. package/activities/arcgis/QueryAttachmentInfos.d.ts +21 -21
  112. package/activities/arcgis/QueryTask.d.ts +77 -77
  113. package/activities/arcgis/QueryTask.js +1 -1
  114. package/activities/arcgis/RefreshLayer.d.ts +12 -12
  115. package/activities/arcgis/RegisterCorsUrl.d.ts +21 -21
  116. package/activities/arcgis/RelateEngineTask.d.ts +22 -22
  117. package/activities/arcgis/RelationServiceTask.d.ts +29 -29
  118. package/activities/arcgis/RelationServiceTask.js +1 -1
  119. package/activities/arcgis/RelationshipQueryTask.d.ts +37 -38
  120. package/activities/arcgis/RelationshipQueryTask.js +1 -1
  121. package/activities/arcgis/RemoveFeatureSetFields.d.ts +22 -22
  122. package/activities/arcgis/RemoveFeatureSetFields.js +1 -1
  123. package/activities/arcgis/RemoveGraphics.d.ts +14 -14
  124. package/activities/arcgis/RemoveGraphics.js +1 -1
  125. package/activities/arcgis/RemoveLayer.d.ts +16 -16
  126. package/activities/arcgis/RendererFromJson.d.ts +16 -16
  127. package/activities/arcgis/ReshapeServiceTask.d.ts +20 -20
  128. package/activities/arcgis/ReverseGeocode.d.ts +31 -31
  129. package/activities/arcgis/ReverseGeocode.js +1 -1
  130. package/activities/arcgis/RotateEngineTask.d.ts +20 -20
  131. package/activities/arcgis/RouteTask.d.ts +91 -91
  132. package/activities/arcgis/RouteTask.js +1 -1
  133. package/activities/arcgis/RunPrint.d.ts +33 -34
  134. package/activities/arcgis/RunPrint.js +1 -1
  135. package/activities/arcgis/RunReport.d.ts +37 -38
  136. package/activities/arcgis/RunReport.js +1 -1
  137. package/activities/arcgis/RunWorkflow.d.ts +51 -52
  138. package/activities/arcgis/SendLayerToAttributeTable.d.ts +10 -10
  139. package/activities/arcgis/ServiceAreaTask.d.ts +87 -87
  140. package/activities/arcgis/ServiceAreaTask.js +1 -1
  141. package/activities/arcgis/SetFeatureAttribute.d.ts +15 -15
  142. package/activities/arcgis/SetFeatureGeometry.d.ts +13 -13
  143. package/activities/arcgis/SetFeaturePopup.d.ts +12 -12
  144. package/activities/arcgis/SetFeatureSymbol.d.ts +13 -13
  145. package/activities/arcgis/SetImageryLayerOptions.d.ts +27 -27
  146. package/activities/arcgis/SetLayerDefinitionExpression.d.ts +21 -21
  147. package/activities/arcgis/SetLayerDefinitionExpression.js +1 -1
  148. package/activities/arcgis/SetLayerPopup.d.ts +12 -12
  149. package/activities/arcgis/SetLayerProperty.d.ts +23 -23
  150. package/activities/arcgis/SetLayerVisibility.d.ts +23 -23
  151. package/activities/arcgis/SetMap.d.ts +14 -14
  152. package/activities/arcgis/SetViewExtent.d.ts +27 -27
  153. package/activities/arcgis/SetViewpoint.d.ts +23 -23
  154. package/activities/arcgis/ShowFeaturePopup.d.ts +11 -11
  155. package/activities/arcgis/ShowResults.d.ts +51 -51
  156. package/activities/arcgis/SimplifyEngineTask.d.ts +15 -15
  157. package/activities/arcgis/SortFeatureSet.d.ts +20 -20
  158. package/activities/arcgis/SymbolFromJson.d.ts +16 -16
  159. package/activities/arcgis/ToGeoCoordinateStringServiceTask.d.ts +30 -30
  160. package/activities/arcgis/TypeChecking.d.ts +46 -46
  161. package/activities/arcgis/UnionEngineTask.d.ts +19 -19
  162. package/activities/arcgis/UnionServiceTask.d.ts +20 -20
  163. package/activities/arcgis/UpdateAttachment.d.ts +29 -29
  164. package/activities/arcgis/UpdateFeatures.d.ts +27 -27
  165. package/activities/arcgis/libs/arcGisRestApi.d.ts +18 -18
  166. package/activities/arcgis/runUtils.d.ts +93 -93
  167. package/activities/arcgis/shared.d.ts +61 -61
  168. package/activities/arcgis/tools.d.ts +42 -40
  169. package/activities/arcgis/tools.js +1 -1
  170. package/activities/browser/GetBrowserInfo.d.ts +13 -13
  171. package/activities/browser/InjectCss.d.ts +11 -11
  172. package/activities/constants.d.ts +19 -19
  173. package/activities/core/AddItem.d.ts +12 -12
  174. package/activities/core/AddItems.d.ts +12 -12
  175. package/activities/core/Annotation.d.ts +8 -8
  176. package/activities/core/Cast.d.ts +16 -16
  177. package/activities/core/ChannelProvider.d.ts +89 -90
  178. package/activities/core/ChannelProvider.js +1 -1
  179. package/activities/core/ClearItems.d.ts +10 -10
  180. package/activities/core/Container.d.ts +7 -7
  181. package/activities/core/ConvertBytesToText.d.ts +14 -14
  182. package/activities/core/ConvertDataTableToFeatureSet.d.ts +12 -12
  183. package/activities/core/ConvertTextToBytes.d.ts +14 -14
  184. package/activities/core/ConvertToJson.d.ts +16 -16
  185. package/activities/core/ConvertToJson.js +1 -1
  186. package/activities/core/CreateFile.d.ts +18 -18
  187. package/activities/core/CreateValue.d.ts +21 -21
  188. package/activities/core/DecodeUriComponent.d.ts +14 -14
  189. package/activities/core/Delay.d.ts +18 -18
  190. package/activities/core/EncodeUriComponent.d.ts +14 -14
  191. package/activities/core/Evaluate.d.ts +18 -18
  192. package/activities/core/EvaluateAsync.d.ts +18 -18
  193. package/activities/core/Exit.d.ts +7 -7
  194. package/activities/core/ForEach.d.ts +25 -26
  195. package/activities/core/FormatDate.d.ts +23 -23
  196. package/activities/core/GetBase64StringFromBytes.d.ts +15 -15
  197. package/activities/core/GetBase64StringFromFile.d.ts +15 -15
  198. package/activities/core/GetBytesFromBase64String.d.ts +15 -15
  199. package/activities/core/GetFirstItem.d.ts +14 -14
  200. package/activities/core/GetItemAtIndex.d.ts +15 -15
  201. package/activities/core/GetLastItem.d.ts +14 -14
  202. package/activities/core/GetLogLevel.d.ts +9 -9
  203. package/activities/core/GetTextFromFile.d.ts +16 -16
  204. package/activities/core/GetWorkflowInputs.d.ts +12 -12
  205. package/activities/core/If.d.ts +18 -18
  206. package/activities/core/Log.d.ts +14 -14
  207. package/activities/core/Log.js +1 -1
  208. package/activities/core/Loop.d.ts +27 -27
  209. package/activities/core/Loop.js +1 -1
  210. package/activities/core/ParseJson.d.ts +16 -16
  211. package/activities/core/ParseNumber.d.ts +12 -12
  212. package/activities/core/ParseUrl.d.ts +24 -25
  213. package/activities/core/ParseUrl.js +1 -1
  214. package/activities/core/Placeholder.d.ts +6 -6
  215. package/activities/core/RegexMatches.d.ts +17 -17
  216. package/activities/core/RegexReplace.d.ts +18 -18
  217. package/activities/core/RemoveItem.d.ts +14 -14
  218. package/activities/core/RunActivity.d.ts +12 -13
  219. package/activities/core/RunSubworkflow.d.ts +14 -15
  220. package/activities/core/SetLogLevel.d.ts +9 -9
  221. package/activities/core/SetProperty.d.ts +15 -15
  222. package/activities/core/SetWorkflowOutput.d.ts +12 -12
  223. package/activities/core/Subworkflow.d.ts +14 -15
  224. package/activities/core/Switch.d.ts +19 -19
  225. package/activities/core/TextReplace.d.ts +16 -16
  226. package/activities/core/Throw.d.ts +12 -12
  227. package/activities/core/TryCatch.d.ts +12 -12
  228. package/activities/core/WebRequest.d.ts +49 -50
  229. package/activities/core/converters.d.ts +10 -10
  230. package/activities/csv/ConvertCsvToDataTable.d.ts +15 -15
  231. package/activities/csv/ConvertDataTableToCsv.d.ts +15 -15
  232. package/activities/essentials/GetEssentialsSite.d.ts +225 -225
  233. package/activities/essentials/RunEssentialsWorkflow.d.ts +25 -26
  234. package/activities/essentials/RunEssentialsWorkflowActivity.d.ts +17 -18
  235. package/activities/forms/ActivateFormElement.d.ts +13 -13
  236. package/activities/forms/ActivateFormElement.js +1 -1
  237. package/activities/forms/AddFormElement.d.ts +18 -18
  238. package/activities/forms/ClearFormElementError.d.ts +13 -13
  239. package/activities/forms/CompleteForm.d.ts +11 -11
  240. package/activities/forms/DisplayForm.d.ts +48 -49
  241. package/activities/forms/Errors.d.ts +18 -18
  242. package/activities/forms/FilterFormElementItems.d.ts +16 -16
  243. package/activities/forms/FormElementMap.d.ts +13 -13
  244. package/activities/forms/FormRenderer.d.ts +139 -140
  245. package/activities/forms/FormRenderer.js +1 -1
  246. package/activities/forms/GetFormElementItemsFromCollection.d.ts +49 -50
  247. package/activities/forms/GetFormElementItemsFromCollection.js +1 -1
  248. package/activities/forms/GetFormElementProperty.d.ts +19 -19
  249. package/activities/forms/GetFormElementValue.d.ts +17 -17
  250. package/activities/forms/GetFormEventData.d.ts +17 -17
  251. package/activities/forms/HideFormElement.d.ts +13 -13
  252. package/activities/forms/PropagateFormEvent.d.ts +10 -10
  253. package/activities/forms/SetCurrentFormElementItem.d.ts +18 -18
  254. package/activities/forms/SetCurrentFormElementItem.js +1 -1
  255. package/activities/forms/SetFormElementError.d.ts +17 -17
  256. package/activities/forms/SetFormElementEvent.d.ts +18 -18
  257. package/activities/forms/SetFormElementItemProperty.d.ts +34 -21
  258. package/activities/forms/SetFormElementItemProperty.js +1 -1
  259. package/activities/forms/SetFormElementItems.d.ts +18 -19
  260. package/activities/forms/SetFormElementProperty.d.ts +32 -19
  261. package/activities/forms/SetFormElementProperty.js +1 -1
  262. package/activities/forms/ShowFormElement.d.ts +15 -15
  263. package/activities/image/GetImageMetadata.d.ts +16 -16
  264. package/activities/image/RotateImage.d.ts +15 -15
  265. package/activities/index.d.ts +4 -2
  266. package/activities/index.js +1 -1
  267. package/activities/main.d.ts +1 -1
  268. package/activities/math/Abs.d.ts +14 -14
  269. package/activities/math/Cos.d.ts +14 -14
  270. package/activities/math/Max.d.ts +16 -16
  271. package/activities/math/Min.d.ts +16 -16
  272. package/activities/math/Pow.d.ts +15 -15
  273. package/activities/math/Random.d.ts +10 -10
  274. package/activities/math/Sin.d.ts +14 -14
  275. package/activities/math/Sqrt.d.ts +14 -14
  276. package/activities/math/Tan.d.ts +14 -14
  277. package/activities/pdf/AddGeoreferenceToPdf.d.ts +19 -19
  278. package/activities/pdf/AddImageToPdf.d.ts +63 -0
  279. package/activities/pdf/AddImageToPdf.js +1 -0
  280. package/activities/pdf/AddTextToPdf.d.ts +59 -0
  281. package/activities/pdf/AddTextToPdf.js +1 -0
  282. package/activities/pdf/CreatePdf.d.ts +49 -0
  283. package/activities/pdf/CreatePdf.js +1 -0
  284. package/activities/pdf/ExtractPdfPages.d.ts +17 -17
  285. package/activities/pdf/MergePdfs.d.ts +15 -15
  286. package/activities/server/CopyFile.d.ts +10 -10
  287. package/activities/server/CreateDirectory.d.ts +9 -9
  288. package/activities/server/CreateDownload.d.ts +18 -18
  289. package/activities/server/CreateEmailAttachment.d.ts +16 -16
  290. package/activities/server/CreateZipFromDirectory.d.ts +12 -12
  291. package/activities/server/DeleteDirectory.d.ts +9 -9
  292. package/activities/server/DeleteFile.d.ts +9 -9
  293. package/activities/server/DirectoryExists.d.ts +13 -13
  294. package/activities/server/ExtractZipToDirectory.d.ts +11 -11
  295. package/activities/server/FileExists.d.ts +13 -13
  296. package/activities/server/GetDirectoriesInDirectory.d.ts +14 -14
  297. package/activities/server/GetFilesInDirectory.d.ts +14 -14
  298. package/activities/server/MoveFile.d.ts +10 -10
  299. package/activities/server/ReadFile.d.ts +14 -14
  300. package/activities/server/ReadFileBytes.d.ts +13 -13
  301. package/activities/server/RunApplication.d.ts +22 -22
  302. package/activities/server/RunPython.d.ts +23 -23
  303. package/activities/server/SendEmail.d.ts +16 -16
  304. package/activities/server/SqlNonQuery.d.ts +18 -18
  305. package/activities/server/SqlQuery.d.ts +18 -18
  306. package/activities/server/SqlQueryUnsafe.d.ts +18 -18
  307. package/activities/server/WriteFile.d.ts +11 -11
  308. package/activities/server/WriteFileBytes.d.ts +10 -10
  309. package/activities/ui/Alert.d.ts +17 -17
  310. package/activities/ui/Confirm.d.ts +24 -24
  311. package/activities/ui/Prompt.d.ts +26 -26
  312. package/activities/wab/OpenWidget.d.ts +10 -10
  313. package/activities/wab/PublishWidgetData.d.ts +11 -11
  314. package/activities/xlsx/ConvertDataTableToXlsx.d.ts +15 -15
  315. package/activities/xlsx/ConvertXlsxToDataSet.d.ts +15 -15
  316. package/constants.d.ts +2 -2
  317. package/definition/Activity.d.ts +12 -13
  318. package/definition/ActivityInput.d.ts +31 -31
  319. package/definition/Component.d.ts +10 -10
  320. package/definition/DeploymentConfig.d.ts +4 -5
  321. package/definition/Form.d.ts +5 -5
  322. package/definition/Program.d.ts +29 -30
  323. package/definition/ProgramInspector.d.ts +290 -288
  324. package/definition/ProgramInspector.js +1 -1
  325. package/definition/Reference.d.ts +11 -11
  326. package/definition/Resource.d.ts +26 -26
  327. package/definition/Step.d.ts +9 -9
  328. package/definition/Transition.d.ts +17 -17
  329. package/diagnostics/ConsoleDebugLogger.d.ts +10 -10
  330. package/diagnostics/logging.d.ts +5 -5
  331. package/execution/ActivityLoader.d.ts +23 -24
  332. package/execution/Engine.d.ts +84 -85
  333. package/execution/IDebugSession.d.ts +43 -44
  334. package/execution/ModuleLoader.d.ts +42 -42
  335. package/execution/ProgramRunner.d.ts +1 -1
  336. package/execution/ProgramRunner.js +1 -1
  337. package/forms/Calendar.d.ts +89 -89
  338. package/forms/ExclusiveTimer.d.ts +13 -13
  339. package/forms/FormComponent.d.ts +47 -47
  340. package/forms/FormComponent.js +1 -1
  341. package/forms/FormDefinition.d.ts +451 -452
  342. package/forms/FormElement.d.ts +24 -59
  343. package/forms/FormElement.js +1 -1
  344. package/forms/FormHost.d.ts +225 -231
  345. package/forms/FormHost.js +1 -1
  346. package/forms/FormPresenterHost.d.ts +62 -74
  347. package/forms/MutuallyExclusiveSectionGroup.d.ts +41 -41
  348. package/forms/NumberParser.d.ts +27 -26
  349. package/forms/NumberParser.js +1 -1
  350. package/forms/common.d.ts +67 -62
  351. package/forms/common.js +1 -1
  352. package/forms/components/AccordionGroup.d.ts +15 -15
  353. package/forms/components/AutoComplete.d.ts +8 -8
  354. package/forms/components/ButtonBar.d.ts +8 -8
  355. package/forms/components/CheckBox.d.ts +7 -7
  356. package/forms/components/CheckGroup.d.ts +8 -8
  357. package/forms/components/Custom.d.ts +7 -7
  358. package/forms/components/DatePicker.d.ts +8 -8
  359. package/forms/components/DatePicker.js +1 -1
  360. package/forms/components/DateRangePicker.d.ts +12 -12
  361. package/forms/components/DateRangePicker.js +1 -1
  362. package/forms/components/DateTimePicker.d.ts +8 -8
  363. package/forms/components/DateTimePicker.js +1 -1
  364. package/forms/components/DropDownList.d.ts +8 -7
  365. package/forms/components/DropDownList.js +1 -1
  366. package/forms/components/FilePicker.d.ts +10 -9
  367. package/forms/components/FilePicker.js +1 -1
  368. package/forms/components/Form.d.ts +23 -23
  369. package/forms/components/Form.js +1 -1
  370. package/forms/components/FormLabelNumberField.d.ts +17 -17
  371. package/forms/components/GeometryPicker.d.ts +5 -4
  372. package/forms/components/GeometryPicker.js +1 -1
  373. package/forms/components/GeometryPickerListItem.d.ts +23 -23
  374. package/forms/components/HorizontalRule.d.ts +7 -7
  375. package/forms/components/Image.d.ts +7 -7
  376. package/forms/components/ItemPicker.d.ts +15 -17
  377. package/forms/components/ItemPicker.js +1 -1
  378. package/forms/components/ListBox.d.ts +8 -8
  379. package/forms/components/Markdown.d.ts +14 -14
  380. package/forms/components/Number.d.ts +8 -8
  381. package/forms/components/Number.js +1 -1
  382. package/forms/components/NumberRangeSlider.d.ts +12 -12
  383. package/forms/components/NumberSlider.d.ts +11 -11
  384. package/forms/components/RadioGroup.d.ts +8 -8
  385. package/forms/components/Scanner.d.ts +11 -9
  386. package/forms/components/Scanner.js +1 -1
  387. package/forms/components/Section.d.ts +14 -14
  388. package/forms/components/Section.js +1 -1
  389. package/forms/components/Signature.d.ts +12 -11
  390. package/forms/components/Signature.js +1 -1
  391. package/forms/components/SignatureDialog.d.ts +22 -22
  392. package/forms/components/Text.d.ts +8 -8
  393. package/forms/components/TextArea.d.ts +7 -7
  394. package/forms/components/TextBox.d.ts +7 -7
  395. package/forms/components/TimePicker.d.ts +8 -8
  396. package/forms/components/TimePicker.js +1 -1
  397. package/forms/constants.d.ts +81 -81
  398. package/forms/dateUtilities.d.ts +102 -103
  399. package/forms/dateUtilities.js +1 -1
  400. package/forms/elements/AutoComplete.d.ts +13 -13
  401. package/forms/elements/ButtonBar.d.ts +9 -9
  402. package/forms/elements/CheckBox.d.ts +7 -7
  403. package/forms/elements/CheckGroup.d.ts +11 -11
  404. package/forms/elements/Custom.d.ts +7 -7
  405. package/forms/elements/DatePicker.d.ts +6 -6
  406. package/forms/elements/DateRangePicker.d.ts +6 -6
  407. package/forms/elements/DateTimePicker.d.ts +6 -6
  408. package/forms/elements/DropDownList.d.ts +6 -6
  409. package/forms/elements/FilePicker.d.ts +8 -8
  410. package/forms/elements/GeometryPicker.d.ts +18 -18
  411. package/forms/elements/Header.d.ts +10 -10
  412. package/forms/elements/HorizontalRule.d.ts +2 -2
  413. package/forms/elements/Image.d.ts +2 -2
  414. package/forms/elements/ItemPicker.d.ts +13 -13
  415. package/forms/elements/ListBox.d.ts +11 -11
  416. package/forms/elements/Number.d.ts +11 -11
  417. package/forms/elements/NumberRangeSlider.d.ts +10 -10
  418. package/forms/elements/NumberSlider.d.ts +6 -6
  419. package/forms/elements/PasswordBox.d.ts +5 -5
  420. package/forms/elements/RadioGroup.d.ts +6 -6
  421. package/forms/elements/Scanner.d.ts +19 -19
  422. package/forms/elements/Section.d.ts +2 -2
  423. package/forms/elements/Signature.d.ts +16 -16
  424. package/forms/elements/Text.d.ts +2 -2
  425. package/forms/elements/TextArea.d.ts +7 -7
  426. package/forms/elements/TextBox.d.ts +5 -5
  427. package/forms/elements/TimePicker.d.ts +6 -6
  428. package/forms/elements/types.d.ts +83 -83
  429. package/forms/index.d.ts +124 -108
  430. package/forms/keyboard.d.ts +9 -9
  431. package/forms/listUtilities.d.ts +3 -3
  432. package/forms/manifest.d.ts +3 -3
  433. package/forms/manifest.js +1 -1
  434. package/forms/numberFormatter.d.ts +90 -94
  435. package/forms/numberFormatter.js +1 -1
  436. package/forms/numberUtilities.d.ts +150 -150
  437. package/forms/numberUtilities.js +1 -1
  438. package/forms/presenter.d.ts +21 -21
  439. package/forms/presenter.js +1 -1
  440. package/forms/renderers.d.ts +5 -8
  441. package/forms/renderers.js +1 -1
  442. package/forms/textUtilities.d.ts +33 -23
  443. package/forms/textUtilities.js +1 -1
  444. package/forms/utils.d.ts +177 -146
  445. package/forms/utils.js +1 -1
  446. package/index.d.ts +2 -2
  447. package/libs/version.d.ts +1 -1
  448. package/libs/version.js +1 -1
  449. package/licensing/LicenseChecker.d.ts +1 -1
  450. package/licensing/Watermark.d.ts +7 -7
  451. package/package.json +9 -11
  452. package/activities/app/constants.d.ts +0 -1
  453. package/activities/app/constants.js +0 -1
@@ -1,6 +1,6 @@
1
- import * as types from "./types";
2
- export interface RadioGroup extends types.ElementBase, types.EditableElement, types.ElementWithItems<Item>, types.ElementWithCurrent, types.ElementWithRequire {
3
- /** Indicates the current value. */
4
- readonly value?: any;
5
- }
6
- export declare type Item = types.ElementItemBase<any>;
1
+ import * as types from "./types";
2
+ export interface RadioGroup extends types.ElementBase, types.EditableElement, types.ElementWithItems<Item>, types.ElementWithCurrent, types.ElementWithRequire {
3
+ /** Indicates the current value. */
4
+ readonly value?: any;
5
+ }
6
+ export type Item = types.ElementItemBase<any>;
@@ -1,19 +1,19 @@
1
- import { ScanRef } from "../FormDefinition";
2
- import { FormElementPropertyConstraints, PropertyConstraintsWithDefault, PropertyConstraintsWithMinimum } from "../utils";
3
- import * as types from "./types";
4
- export interface Scanner extends types.ElementBase, types.EditableElement, types.ElementWithAutoActivate, types.ElementWithRequire {
5
- /** True if this element should support manual user entry, false otherwise. */
6
- readonly manualEntry: boolean;
7
- /** Indicates whether to support barcode scanning, qrcode scanning or both. */
8
- readonly scanType: "barcode" | "qrcode" | "both";
9
- /** Indicates the current value. */
10
- readonly value: ScanRef;
11
- }
12
- interface ScannerConfiguration extends FormElementPropertyConstraints {
13
- rows: PropertyConstraintsWithDefault<number> & PropertyConstraintsWithMinimum<number>;
14
- }
15
- /**
16
- * Constraints that the Scanner enforces on the rows.
17
- */
18
- export declare const scannerConfiguration: ScannerConfiguration;
19
- export {};
1
+ import { ScanRef } from "../FormDefinition";
2
+ import { FormElementPropertyConstraints, PropertyConstraintsWithDefault, PropertyConstraintsWithMinimum } from "../utils";
3
+ import * as types from "./types";
4
+ export interface Scanner extends types.ElementBase, types.EditableElement, types.ElementWithAutoActivate, types.ElementWithRequire {
5
+ /** True if this element should support manual user entry, false otherwise. */
6
+ readonly manualEntry: boolean;
7
+ /** Indicates whether to support barcode scanning, qrcode scanning or both. */
8
+ readonly scanType: "barcode" | "qrcode" | "both";
9
+ /** Indicates the current value. */
10
+ readonly value: ScanRef;
11
+ }
12
+ interface ScannerConfiguration extends FormElementPropertyConstraints {
13
+ rows: PropertyConstraintsWithDefault<number> & PropertyConstraintsWithMinimum<number>;
14
+ }
15
+ /**
16
+ * Constraints that the Scanner enforces on the rows.
17
+ */
18
+ export declare const scannerConfiguration: ScannerConfiguration;
19
+ export {};
@@ -1,2 +1,2 @@
1
- import * as types from "./types";
2
- export declare type Section = types.ElementBase;
1
+ import * as types from "./types";
2
+ export type Section = types.ElementBase;
@@ -1,16 +1,16 @@
1
- import { SignatureRef } from "../FormDefinition";
2
- import { FormElementPropertyConstraints, PropertyConstraintsWithDefault, PropertyConstraintsWithMaximum, PropertyConstraintsWithMinimum } from "../utils";
3
- import * as types from "./types";
4
- export interface Signature extends types.ElementBase, types.EditableElement, types.ElementWithRequire {
5
- /** Indicates the current value. */
6
- readonly value: SignatureRef;
7
- }
8
- interface SignatureConfiguration extends FormElementPropertyConstraints {
9
- height: PropertyConstraintsWithDefault<number>;
10
- width: PropertyConstraintsWithDefault<number> & PropertyConstraintsWithMaximum<number> & PropertyConstraintsWithMinimum<number>;
11
- }
12
- /**
13
- * Constraints that the Signature enforces on the size.
14
- */
15
- export declare const signatureConfiguration: SignatureConfiguration;
16
- export {};
1
+ import { SignatureRef } from "../FormDefinition";
2
+ import { FormElementPropertyConstraints, PropertyConstraintsWithDefault, PropertyConstraintsWithMaximum, PropertyConstraintsWithMinimum } from "../utils";
3
+ import * as types from "./types";
4
+ export interface Signature extends types.ElementBase, types.EditableElement, types.ElementWithRequire {
5
+ /** Indicates the current value. */
6
+ readonly value: SignatureRef;
7
+ }
8
+ interface SignatureConfiguration extends FormElementPropertyConstraints {
9
+ height: PropertyConstraintsWithDefault<number>;
10
+ width: PropertyConstraintsWithDefault<number> & PropertyConstraintsWithMaximum<number> & PropertyConstraintsWithMinimum<number>;
11
+ }
12
+ /**
13
+ * Constraints that the Signature enforces on the size.
14
+ */
15
+ export declare const signatureConfiguration: SignatureConfiguration;
16
+ export {};
@@ -1,2 +1,2 @@
1
- import * as types from "./types";
2
- export declare type Text = types.ElementBase;
1
+ import * as types from "./types";
2
+ export type Text = types.ElementBase;
@@ -1,7 +1,7 @@
1
- import * as types from "./types";
2
- export interface TextArea extends types.ElementBase, types.EditableElement, types.ElementWithReadOnly, types.ElementWithRequire, types.ElementWithMaxLength {
3
- /** Indicates the current value. */
4
- readonly value: string;
5
- /** Indicates how the control wraps text. */
6
- readonly wrap?: "hard" | "soft" | "off";
7
- }
1
+ import * as types from "./types";
2
+ export interface TextArea extends types.ElementBase, types.EditableElement, types.ElementWithReadOnly, types.ElementWithRequire, types.ElementWithMaxLength {
3
+ /** Indicates the current value. */
4
+ readonly value: string;
5
+ /** Indicates how the control wraps text. */
6
+ readonly wrap?: "hard" | "soft" | "off";
7
+ }
@@ -1,5 +1,5 @@
1
- import * as types from "./types";
2
- export interface TextBox extends types.ElementBase, types.EditableElement, types.ElementWithReadOnly, types.ElementWithMaxLength, types.ElementWithRequire {
3
- /** Indicates the current value. */
4
- readonly value: string;
5
- }
1
+ import * as types from "./types";
2
+ export interface TextBox extends types.ElementBase, types.EditableElement, types.ElementWithReadOnly, types.ElementWithMaxLength, types.ElementWithRequire {
3
+ /** Indicates the current value. */
4
+ readonly value: string;
5
+ }
@@ -1,6 +1,6 @@
1
- import { DateTimeRef } from "../FormDefinition";
2
- import * as types from "./types";
3
- export interface TimePicker extends types.ElementBase, types.EditableElement, types.ElementWithRequire {
4
- /** Indicates the current value. */
5
- readonly value?: DateTimeRef;
6
- }
1
+ import { DateTimeRef } from "../FormDefinition";
2
+ import * as types from "./types";
3
+ export interface TimePicker extends types.ElementBase, types.EditableElement, types.ElementWithRequire {
4
+ /** Indicates the current value. */
5
+ readonly value?: DateTimeRef;
6
+ }
@@ -1,83 +1,83 @@
1
- import * as defs from "../FormDefinition";
2
- /**
3
- * We re-define Text here to hide defs.StatusRef from the end user.
4
- * It is only for internal use, and adds no value in this context.
5
- * @public
6
- */
7
- export declare type Text = string | defs.MarkdownRef;
8
- /** Properties common to all Elements, except the Header. */
9
- export interface ElementBase {
10
- /** Indicates the type of the element. */
11
- readonly type?: string;
12
- /** Indicates that the element is visible or not. */
13
- readonly visible?: boolean;
14
- /** Indicates the name of the style that will be applied to the element. */
15
- readonly styleName?: string;
16
- }
17
- /** Exposes the Element.enabled and Element.error properties. */
18
- export interface EditableElement {
19
- /** Indicates that the element is enabled or not. */
20
- readonly enabled?: boolean;
21
- /** Indicates the error for the element. */
22
- readonly error?: Text;
23
- }
24
- /** Exposes the Element.autoActivate property. */
25
- export interface ElementWithAutoActivate {
26
- /** True if this element should activate when shown, false otherwise. */
27
- readonly autoActivate?: boolean;
28
- }
29
- /** Exposes the Element.current property. */
30
- export interface ElementWithCurrent {
31
- /** Indicates the current item. */
32
- readonly current?: string;
33
- }
34
- /** Exposes the Element.items property. */
35
- export interface ElementWithItems<ElementItemBase> {
36
- /** The items contained within the element. */
37
- readonly items?: {
38
- [key: string]: ElementItemBase;
39
- };
40
- }
41
- /** Exposes the Element.label property as `Text`. */
42
- export interface ElementWithTextLabel {
43
- /** Indicates the label for the element. */
44
- readonly label?: Text;
45
- }
46
- /** Exposes the Element.label property as `string`. */
47
- export interface ElementWithStringLabel {
48
- /** Indicates the label for the element. */
49
- readonly label?: string;
50
- }
51
- /** Exposes the Element.readOnly property. */
52
- export interface ElementWithReadOnly {
53
- /** Indicates that the element is read only or not. */
54
- readonly readOnly?: boolean;
55
- }
56
- /** Exposes the Element.require property. */
57
- export interface ElementWithRequire {
58
- /** Instructs any validation that the element is required. */
59
- readonly require?: boolean;
60
- }
61
- /** Exposes the Element.maxLength property. */
62
- export interface ElementWithMaxLength {
63
- /** Indicates the maximum number of characters that can be entered in the field. */
64
- readonly maxLength?: number;
65
- }
66
- /** Properties common to all Element Items. */
67
- export interface ElementItemBase<T> {
68
- /** Indicates the enabled state for the item. */
69
- readonly enabled?: boolean;
70
- /** Indicates the label for the item. */
71
- readonly label?: Text;
72
- /** Indicates the name of the style that will be applied to the item. */
73
- readonly styleName?: string;
74
- /** Indicates the value for the item. */
75
- readonly value?: T;
76
- /** Indicates the visible state for the item. */
77
- readonly visible?: boolean;
78
- }
79
- /** Exposes the Item.checked property. */
80
- export interface ElementItemWithChecked {
81
- /** Indicates the checked state for the item. */
82
- readonly checked?: boolean;
83
- }
1
+ import * as defs from "../FormDefinition";
2
+ /**
3
+ * We re-define Text here to hide defs.StatusRef from the end user.
4
+ * It is only for internal use, and adds no value in this context.
5
+ * @public
6
+ */
7
+ export type Text = string | defs.MarkdownRef;
8
+ /** Properties common to all Elements, except the Header. */
9
+ export interface ElementBase {
10
+ /** Indicates the type of the element. */
11
+ readonly type?: string;
12
+ /** Indicates that the element is visible or not. */
13
+ readonly visible?: boolean;
14
+ /** Indicates the name of the style that will be applied to the element. */
15
+ readonly styleName?: string;
16
+ }
17
+ /** Exposes the Element.enabled and Element.error properties. */
18
+ export interface EditableElement {
19
+ /** Indicates that the element is enabled or not. */
20
+ readonly enabled?: boolean;
21
+ /** Indicates the error for the element. */
22
+ readonly error?: Text;
23
+ }
24
+ /** Exposes the Element.autoActivate property. */
25
+ export interface ElementWithAutoActivate {
26
+ /** True if this element should activate when shown, false otherwise. */
27
+ readonly autoActivate?: boolean;
28
+ }
29
+ /** Exposes the Element.current property. */
30
+ export interface ElementWithCurrent {
31
+ /** Indicates the current item. */
32
+ readonly current?: string;
33
+ }
34
+ /** Exposes the Element.items property. */
35
+ export interface ElementWithItems<ElementItemBase> {
36
+ /** The items contained within the element. */
37
+ readonly items?: {
38
+ [key: string]: ElementItemBase;
39
+ };
40
+ }
41
+ /** Exposes the Element.label property as `Text`. */
42
+ export interface ElementWithTextLabel {
43
+ /** Indicates the label for the element. */
44
+ readonly label?: Text;
45
+ }
46
+ /** Exposes the Element.label property as `string`. */
47
+ export interface ElementWithStringLabel {
48
+ /** Indicates the label for the element. */
49
+ readonly label?: string;
50
+ }
51
+ /** Exposes the Element.readOnly property. */
52
+ export interface ElementWithReadOnly {
53
+ /** Indicates that the element is read only or not. */
54
+ readonly readOnly?: boolean;
55
+ }
56
+ /** Exposes the Element.require property. */
57
+ export interface ElementWithRequire {
58
+ /** Instructs any validation that the element is required. */
59
+ readonly require?: boolean;
60
+ }
61
+ /** Exposes the Element.maxLength property. */
62
+ export interface ElementWithMaxLength {
63
+ /** Indicates the maximum number of characters that can be entered in the field. */
64
+ readonly maxLength?: number;
65
+ }
66
+ /** Properties common to all Element Items. */
67
+ export interface ElementItemBase<T> {
68
+ /** Indicates the enabled state for the item. */
69
+ readonly enabled?: boolean;
70
+ /** Indicates the label for the item. */
71
+ readonly label?: Text;
72
+ /** Indicates the name of the style that will be applied to the item. */
73
+ readonly styleName?: string;
74
+ /** Indicates the value for the item. */
75
+ readonly value?: T;
76
+ /** Indicates the visible state for the item. */
77
+ readonly visible?: boolean;
78
+ }
79
+ /** Exposes the Item.checked property. */
80
+ export interface ElementItemWithChecked {
81
+ /** Indicates the checked state for the item. */
82
+ readonly checked?: boolean;
83
+ }
package/forms/index.d.ts CHANGED
@@ -1,108 +1,124 @@
1
- /// <reference types="react" />
2
- import { EventArgumentTypes, EventValueTypes } from "./FormComponent";
3
- import { defs } from "./FormHost";
4
- import { FormatOptions } from "./numberFormatter";
5
- export { Orientation, TitleLocation } from "./constants";
6
- export type { Text } from "./elements/types";
7
- /**
8
- * Details about an event to be fired when the value property is updated.
9
- * If `false`, no event is fired.
10
- * If `true`, the event is fired with the event object just containing the element's value.
11
- * If an object containing `"argument"` or `"item" properties, the event is fired and those properties are included in the event object.
12
- */
13
- declare type EventOptions = Partial<Pick<defs.Event, "argument" | "item">> | boolean;
14
- /** @public */
15
- export interface FormElementProps<TValue = undefined> extends FormElementSettableProps<TValue>, Pick<defs.Element, "customType" | "description" | "delay" | "format" | "manualEntry" | "maxLength" | "minLength" | "orientation" | "prompt" | "readOnly" | "require" | "showMinMaxLabels" | "showTickMarks" | "size" | "title" | "tooltip" | "type" | "wrap"> {
16
- className?: string;
17
- /** Coerces a number from a value. */
18
- coerceNumber: (value: string) => number;
19
- /**
20
- * Derives the current locale set by the host application (or default if undefined) will be returned.
21
- */
22
- deriveLocale: () => string;
23
- enabled: boolean;
24
- /** Formats a value into a string. */
25
- formatNumber: (value: number, options?: FormatOptions) => string;
26
- id: string;
27
- name: string | undefined;
28
- /**
29
- * A callback function to raise an event. The `custom` event accepts any
30
- * value as the eventValue. Use the Get Form Event Data to access the event
31
- * data in a sub-workflow of the Display Form activity.
32
- * @param eventName The name of the event to raise. Currently only `custom`
33
- * is permitted.
34
- * @param eventValue The value of the event.
35
- */
36
- raiseEvent: <K extends keyof EventValueTypes>(eventName: K, eventValue: EventValueTypes[K], argument?: EventArgumentTypes[K], item?: string, cancellationToken?: PromiseLike<void>) => void;
37
- /** Renders the focus. */
38
- renderFocus: (target: Node, name?: string) => boolean;
39
- /**
40
- * Renders form text as a string.
41
- * If `text` is a reference to a language string (e.g. `"@my-language-string"`), it is translated.
42
- * If `text` is a `MarkdownRef`, it is converted to plain text.
43
- */
44
- renderText: (text: defs.Text | undefined) => string;
45
- /**
46
- * Set a property on an item in the element.
47
- * @param property The name of the property to set.
48
- * @param value The new value to set.
49
- */
50
- setItemProperty: <K extends keyof FormElementItemSettableProps>(item: string, property: K, value: FormElementItemProps[K]) => void;
51
- /**
52
- * Set a property on the element.
53
- * @param property The name of the property to set.
54
- * @param value The new value to set.
55
- */
56
- setProperty: <K extends keyof Omit<this, keyof FormElementProps<TValue>> | keyof FormElementSettableProps<TValue>>(property: K, value: this[K], event?: EventOptions) => void;
57
- /**
58
- * Sets the `value` property of the element. Equivalent to calling
59
- * `setProperty("value", value)`.
60
- *
61
- * Setting the value will raise the `change` event on the element.
62
- *
63
- * @param value The new value to set.
64
- */
65
- setValue: (value: this["value"], event?: EventOptions) => void;
66
- /** Translates the supplied value. */
67
- translateText: (content: defs.Text | undefined) => string | defs.MarkdownRef | undefined;
68
- }
69
- /** @public */
70
- export interface FormElementSettableProps<TValue = undefined> extends Pick<defs.Element, "items" | "checked" | "current" | "error" | "label"> {
71
- /** The value of the element. */
72
- value: TValue;
73
- }
74
- /** @public */
75
- export interface FormElementItemProps extends FormElementItemSettableProps, Pick<defs.Item, "default" | "enabled" | "index" | "label" | "styleName" | "tooltip" | "validates" | "value" | "visible"> {
76
- }
77
- /** @public */
78
- export interface FormElementItemSettableProps extends Pick<defs.Item, "checked"> {
79
- }
80
- declare type SettablePropsFromProps<TProps extends FormElementProps> = Omit<TProps, keyof FormElementProps> & FormElementSettableProps<TProps["value"]>;
81
- declare type Unionize<T> = T[keyof T];
82
- /** @public */
83
- export declare type PropertyChangeEvent<TSettableProps, TSetProperty> = Unionize<{
84
- [K in keyof Required<TSettableProps>]: {
85
- properties: Readonly<TSettableProps>;
86
- property: K;
87
- setProperty: TSetProperty;
88
- };
89
- }>;
90
- /** @public */
91
- export interface FormElementRegistration<TProps extends FormElementProps<any> = FormElementProps, TSettableProps extends SettablePropsFromProps<TProps> = SettablePropsFromProps<TProps>> {
92
- /** The React component definition of the form element. */
93
- component: React.ComponentType<TProps>;
94
- /** The unique identifier of the element. */
95
- id: string;
96
- /**
97
- * Generate the initial properties of the form element. This will be assigned to
98
- * the element properties before first render.
99
- */
100
- getInitialProperties?: () => Partial<TSettableProps>;
101
- /**
102
- * This function will be invoked prior to updating a property of the element
103
- * state. It will be invoked even if the element isn't currently visible.
104
- *
105
- * @returns Either a new value, an error message, or nothing.
106
- */
107
- onPropertyChange?: (event: PropertyChangeEvent<TSettableProps, TProps["setProperty"]>) => void;
108
- }
1
+ /// <reference types="react" />
2
+ import { EventArgumentTypes, EventValueTypes } from "./FormComponent";
3
+ import { defs } from "./FormHost";
4
+ import { FormatOptions } from "./numberFormatter";
5
+ export { Orientation, TitleLocation } from "./constants";
6
+ export type { Text } from "./elements/types";
7
+ /**
8
+ * Details about an event to be fired when the value property is updated.
9
+ * If `false`, no event is fired.
10
+ * If `true`, the event is fired with the event object just containing the element's value.
11
+ * If an object containing `"argument"` or `"item" properties, the event is fired and those properties are included in the event object.
12
+ */
13
+ type EventOptions = Partial<Pick<defs.Event, "argument" | "item">> | boolean;
14
+ export interface ITranslateTextFunction {
15
+ (content: string): string;
16
+ (content: defs.MarkdownRef | defs.StatusRef): defs.MarkdownRef;
17
+ (content: defs.Text | undefined): string | defs.MarkdownRef | undefined;
18
+ }
19
+ /** @public */
20
+ export interface FormElementProps<TValue = undefined> extends FormElementSettableProps<TValue>, FormElementGettableProps {
21
+ className?: string;
22
+ /** Coerces a number from a value. */
23
+ coerceNumber: (value: string) => number;
24
+ /**
25
+ * Derives the current locale set by the host application (or default if undefined) will be returned.
26
+ */
27
+ deriveLocale: () => string;
28
+ enabled: boolean;
29
+ /** Formats a value into a string. */
30
+ formatNumber: (value: number, options?: FormatOptions) => string;
31
+ id: string;
32
+ name: string | undefined;
33
+ /**
34
+ * A callback function to raise an event. The `custom` event accepts any
35
+ * value as the eventValue. Use the Get Form Event Data to access the event
36
+ * data in a sub-workflow of the Display Form activity.
37
+ * @param eventName The name of the event to raise. Currently only `custom`
38
+ * is permitted.
39
+ * @param eventValue The value of the event.
40
+ */
41
+ raiseEvent: <K extends keyof EventValueTypes>(eventName: K, eventValue: EventValueTypes[K], argument?: EventArgumentTypes[K], item?: string, cancellationToken?: PromiseLike<void>) => void;
42
+ /** Renders the focus. */
43
+ renderFocus: (target: Node, name?: string) => boolean;
44
+ /** Renders a component's state. */
45
+ renderState(name: string, type: string, state?: {}): boolean;
46
+ /**
47
+ * Renders form text as a string.
48
+ * If `text` is a reference to a language string (e.g. `"@my-language-string"`), it is translated.
49
+ * If `text` is a `MarkdownRef`, it is converted to plain text.
50
+ */
51
+ renderText: (text: defs.Text | undefined) => string;
52
+ /**
53
+ * Set a property on an item in the element.
54
+ * @param property The name of the property to set.
55
+ * @param value The new value to set.
56
+ */
57
+ setItemProperty: <K extends keyof FormElementItemSettableProps>(item: string, property: K, value: FormElementItemProps[K]) => void;
58
+ /**
59
+ * Set a property on the element.
60
+ * @param property The name of the property to set.
61
+ * @param value The new value to set.
62
+ */
63
+ setProperty: <K extends keyof FormElementSettableProps<TValue>>(property: K, value: this[K], event?: EventOptions) => void;
64
+ /**
65
+ * Sets the `value` property of the element. Equivalent to calling
66
+ * `setProperty("value", value)`.
67
+ *
68
+ * Setting the value will raise the `change` event on the element.
69
+ *
70
+ * @param value The new value to set.
71
+ */
72
+ setValue: (value: this["value"], event?: EventOptions) => void;
73
+ /** Translates the supplied value. */
74
+ translateText: ITranslateTextFunction;
75
+ }
76
+ /**
77
+ * Properties of a Form Element that can be read via the component's properties.
78
+ */
79
+ interface FormElementGettableProps extends Pick<defs.Element, "accessibleDescription" | "autoActivate" | "checked" | "collapsed" | "current" | "customType" | "delay" | "description" | "error" | "fileTypes" | "format" | "itemLabel" | "items" | "label" | "manualEntry" | "maxLength" | "minLength" | "orientation" | "prompt" | "readOnly" | "require" | "scanType" | "selectionMode" | "showFilter" | "showMinMaxLabels" | "showTickMarks" | "size" | "state" | "title" | "tooltip" | "type" | "wrap"> {
80
+ }
81
+ /**
82
+ * Properties of a Form Element that can be set using `SetProperty()`.
83
+ * Any properties defined here can also be read via the component's properties.
84
+ * @public
85
+ */
86
+ export interface FormElementSettableProps<TValue = undefined> extends Pick<defs.Element, "autoActivate" | "checked" | "collapsed" | "current" | "error" | "items" | "label" | "state"> {
87
+ /** The value of the element. */
88
+ value: TValue;
89
+ }
90
+ /** @public */
91
+ export interface FormElementItemProps extends FormElementItemSettableProps, Pick<defs.Item, "default" | "enabled" | "index" | "label" | "styleName" | "tooltip" | "validates" | "value" | "visible"> {
92
+ }
93
+ /** @public */
94
+ export interface FormElementItemSettableProps extends Pick<defs.Item, "checked"> {
95
+ }
96
+ type SettablePropsFromProps<TProps extends FormElementProps> = Omit<TProps, keyof FormElementProps> & FormElementSettableProps<TProps["value"]>;
97
+ type Unionize<T> = T[keyof T];
98
+ /** @public */
99
+ export type PropertyChangeEvent<TSettableProps, TSetProperty> = Unionize<{
100
+ [K in keyof Required<TSettableProps>]: {
101
+ properties: Readonly<TSettableProps>;
102
+ property: K;
103
+ setProperty: TSetProperty;
104
+ };
105
+ }>;
106
+ /** @public */
107
+ export interface FormElementRegistration<TProps extends FormElementProps<any> = FormElementProps, TSettableProps extends SettablePropsFromProps<TProps> = SettablePropsFromProps<TProps>> {
108
+ /** The React component definition of the form element. */
109
+ component: React.ComponentType<TProps>;
110
+ /** The unique identifier of the element. */
111
+ id: string;
112
+ /**
113
+ * Generate the initial properties of the form element. This will be assigned to
114
+ * the element properties before first render.
115
+ */
116
+ getInitialProperties?: () => Partial<TSettableProps>;
117
+ /**
118
+ * This function will be invoked prior to updating a property of the element
119
+ * state. It will be invoked even if the element isn't currently visible.
120
+ *
121
+ * @returns Either a new value, an error message, or nothing.
122
+ */
123
+ onPropertyChange?: (event: PropertyChangeEvent<TSettableProps, TProps["setProperty"]>) => void;
124
+ }
@@ -1,9 +1,9 @@
1
- export interface KeyboardEvent {
2
- altKey: boolean;
3
- ctrlKey: boolean;
4
- metaKey: boolean;
5
- shiftKey: boolean;
6
- key: string;
7
- }
8
- /** @product This is intended for internal use only within VertiGIS Studio products. */
9
- export declare function getKeyString(event: KeyboardEvent): string;
1
+ export interface KeyboardEvent {
2
+ altKey: boolean;
3
+ ctrlKey: boolean;
4
+ metaKey: boolean;
5
+ shiftKey: boolean;
6
+ key: string;
7
+ }
8
+ /** @product This is intended for internal use only within VertiGIS Studio products. */
9
+ export declare function getKeyString(event: KeyboardEvent): string | undefined;
@@ -1,3 +1,3 @@
1
- import { ItemsRef, Value } from "./FormDefinition";
2
- export declare function arrayEqual(arr1: string[], arr2: string[]): boolean;
3
- export declare function areValuesEqual(elementValue: Value | undefined, newValue: ItemsRef | undefined): boolean;
1
+ import { ItemsRef, Value } from "./FormDefinition";
2
+ export declare function arrayEqual(arr1: string[], arr2: string[]): boolean;
3
+ export declare function areValuesEqual(elementValue: Value | undefined, newValue: ItemsRef | undefined): boolean;
@@ -1,3 +1,3 @@
1
- import { Lookup } from "../Collections";
2
- import { FormElementRegistration } from ".";
3
- export declare const BuiltInFormElements: Lookup<FormElementRegistration<any>>;
1
+ import { FormElementRegistration } from ".";
2
+ /** @product This is intended for internal use only within VertiGIS Studio products. */
3
+ export declare const BuiltInFormElements: Record<string, FormElementRegistration<any>>;
package/forms/manifest.js CHANGED
@@ -1 +1 @@
1
- import AutoComplete from"./components/AutoComplete.js";import ButtonBar from"./components/ButtonBar.js";import CheckBox from"./components/CheckBox.js";import CheckGroup from"./components/CheckGroup.js";import Custom from"./components/Custom.js";import DatePicker from"./components/DatePicker.js";import DateRangePicker from"./components/DateRangePicker.js";import DateTimePicker from"./components/DateTimePicker.js";import HorizontalRule from"./components/HorizontalRule.js";import Image from"./components/Image.js";import ListBox from"./components/ListBox.js";import Number from"./components/Number.js";import NumberRangeSlider from"./components/NumberRangeSlider.js";import NumberSlider from"./components/NumberSlider.js";import RadioGroup from"./components/RadioGroup.js";import Text from"./components/Text.js";import TextArea from"./components/TextArea.js";import TextBox from"./components/TextBox.js";import TimePicker from"./components/TimePicker.js";import{FormElementTypes}from"./constants.js";const BuiltInFormElements={[FormElementTypes.AUTOCOMPLETE]:{id:FormElementTypes.AUTOCOMPLETE,component:AutoComplete},[FormElementTypes.BUTTONBAR]:{id:FormElementTypes.BUTTONBAR,component:ButtonBar},[FormElementTypes.CHECKBOX]:{id:FormElementTypes.CHECKBOX,component:CheckBox},[FormElementTypes.CHECKGROUP]:{id:FormElementTypes.CHECKGROUP,component:CheckGroup},[FormElementTypes.CUSTOM]:{id:FormElementTypes.CUSTOM,component:Custom},[FormElementTypes.DATEPICKER]:{id:FormElementTypes.DATEPICKER,component:DatePicker},[FormElementTypes.DATERANGEPICKER]:{id:FormElementTypes.DATERANGEPICKER,component:DateRangePicker},[FormElementTypes.DATETIMEPICKER]:{id:FormElementTypes.DATETIMEPICKER,component:DateTimePicker},[FormElementTypes.HORIZONTALRULE]:{id:FormElementTypes.HORIZONTALRULE,component:HorizontalRule},[FormElementTypes.IMAGE]:{id:FormElementTypes.IMAGE,component:Image},[FormElementTypes.LISTBOX]:{id:FormElementTypes.LISTBOX,component:ListBox},[FormElementTypes.NUMBER]:{id:FormElementTypes.NUMBER,component:Number},[FormElementTypes.NUMBERRANGESLIDER]:{id:FormElementTypes.NUMBERRANGESLIDER,component:NumberRangeSlider},[FormElementTypes.NUMBERSLIDER]:{id:FormElementTypes.NUMBERSLIDER,component:NumberSlider},[FormElementTypes.PASSWORDBOX]:{id:FormElementTypes.PASSWORDBOX,component:TextBox},[FormElementTypes.RADIOGROUP]:{id:FormElementTypes.RADIOGROUP,component:RadioGroup},[FormElementTypes.TEXT]:{id:FormElementTypes.TEXT,component:Text},[FormElementTypes.TEXTAREA]:{id:FormElementTypes.TEXTAREA,component:TextArea},[FormElementTypes.TEXTBOX]:{id:FormElementTypes.TEXTBOX,component:TextBox},[FormElementTypes.TIMEPICKER]:{id:FormElementTypes.TIMEPICKER,component:TimePicker}};export{BuiltInFormElements};
1
+ import AutoComplete from"./components/AutoComplete.js";import ButtonBar from"./components/ButtonBar.js";import CheckBox from"./components/CheckBox.js";import CheckGroup from"./components/CheckGroup.js";import Custom from"./components/Custom.js";import DatePicker from"./components/DatePicker.js";import DateRangePicker from"./components/DateRangePicker.js";import DateTimePicker from"./components/DateTimePicker.js";import DropDownList from"./components/DropDownList.js";import FilePicker from"./components/FilePicker.js";import GeometryPicker from"./components/GeometryPicker.js";import HorizontalRule from"./components/HorizontalRule.js";import Image from"./components/Image.js";import ItemPicker from"./components/ItemPicker.js";import ListBox from"./components/ListBox.js";import Number from"./components/Number.js";import NumberRangeSlider from"./components/NumberRangeSlider.js";import NumberSlider from"./components/NumberSlider.js";import RadioGroup from"./components/RadioGroup.js";import Scanner from"./components/Scanner.js";import Section from"./components/Section.js";import Signature from"./components/Signature.js";import Text from"./components/Text.js";import TextArea from"./components/TextArea.js";import TextBox from"./components/TextBox.js";import TimePicker from"./components/TimePicker.js";import{FormElementTypes}from"./constants.js";const BuiltInFormElements={[FormElementTypes.AUTOCOMPLETE]:{id:FormElementTypes.AUTOCOMPLETE,component:AutoComplete},[FormElementTypes.BUTTONBAR]:{id:FormElementTypes.BUTTONBAR,component:ButtonBar},[FormElementTypes.CHECKBOX]:{id:FormElementTypes.CHECKBOX,component:CheckBox},[FormElementTypes.CHECKGROUP]:{id:FormElementTypes.CHECKGROUP,component:CheckGroup},[FormElementTypes.CUSTOM]:{id:FormElementTypes.CUSTOM,component:Custom},[FormElementTypes.DATEPICKER]:{id:FormElementTypes.DATEPICKER,component:DatePicker},[FormElementTypes.DATERANGEPICKER]:{id:FormElementTypes.DATERANGEPICKER,component:DateRangePicker},[FormElementTypes.DATETIMEPICKER]:{id:FormElementTypes.DATETIMEPICKER,component:DateTimePicker},[FormElementTypes.DROPDOWNLIST]:{id:FormElementTypes.DROPDOWNLIST,component:DropDownList},[FormElementTypes.FILEPICKER]:{id:FormElementTypes.FILEPICKER,component:FilePicker},[FormElementTypes.GEOMETRYPICKER]:{id:FormElementTypes.GEOMETRYPICKER,component:GeometryPicker},[FormElementTypes.HORIZONTALRULE]:{id:FormElementTypes.HORIZONTALRULE,component:HorizontalRule},[FormElementTypes.IMAGE]:{id:FormElementTypes.IMAGE,component:Image},[FormElementTypes.ITEMPICKER]:{id:FormElementTypes.ITEMPICKER,component:ItemPicker},[FormElementTypes.LISTBOX]:{id:FormElementTypes.LISTBOX,component:ListBox},[FormElementTypes.NUMBER]:{id:FormElementTypes.NUMBER,component:Number},[FormElementTypes.NUMBERRANGESLIDER]:{id:FormElementTypes.NUMBERRANGESLIDER,component:NumberRangeSlider},[FormElementTypes.NUMBERSLIDER]:{id:FormElementTypes.NUMBERSLIDER,component:NumberSlider},[FormElementTypes.PASSWORDBOX]:{id:FormElementTypes.PASSWORDBOX,component:TextBox},[FormElementTypes.RADIOGROUP]:{id:FormElementTypes.RADIOGROUP,component:RadioGroup},[FormElementTypes.SCANNER]:{id:FormElementTypes.SCANNER,component:Scanner},[FormElementTypes.SECTION]:{id:FormElementTypes.SECTION,component:Section},[FormElementTypes.SIGNATURE]:{id:FormElementTypes.SIGNATURE,component:Signature},[FormElementTypes.TEXT]:{id:FormElementTypes.TEXT,component:Text},[FormElementTypes.TEXTAREA]:{id:FormElementTypes.TEXTAREA,component:TextArea},[FormElementTypes.TEXTBOX]:{id:FormElementTypes.TEXTBOX,component:TextBox},[FormElementTypes.TIMEPICKER]:{id:FormElementTypes.TIMEPICKER,component:TimePicker}};export{BuiltInFormElements};