@wise/dynamic-flow-client 5.8.1 → 5.9.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 (420) hide show
  1. package/build/DynamicFlowCore.js +5 -0
  2. package/build/common/errorBoundary/ErrorBoundary.js +26 -0
  3. package/build/common/errorBoundary/ErrorBoundary.test.js +29 -0
  4. package/build/common/errorBoundary/ErrorBoundaryAlert.js +11 -0
  5. package/build/common/makeHttpClient/api-utils.js +3 -0
  6. package/build/common/makeHttpClient/index.js +1 -0
  7. package/build/common/makeHttpClient/makeHttpClient.js +10 -0
  8. package/build/common/makeHttpClient/makeHttpClient.test.js +186 -0
  9. package/build/common/messages/external-confirmation.messages.js +23 -0
  10. package/build/common/messages/file-upload.messages.js +13 -0
  11. package/build/common/messages/generic-error.messages.js +18 -0
  12. package/build/common/messages/help.messages.js +8 -0
  13. package/build/common/messages/multi-file-upload.messages.js +18 -0
  14. package/build/common/messages/multi-select.messages.js +8 -0
  15. package/build/common/messages/paragraph.messages.js +13 -0
  16. package/build/common/messages/repeatable.messages.js +23 -0
  17. package/build/common/messages/search.messages.js +8 -0
  18. package/build/common/messages/validation.array.messages.js +13 -0
  19. package/build/common/messages/validation.messages.js +53 -0
  20. package/build/controller/FlowController.js +368 -0
  21. package/build/controller/executePoll.js +49 -0
  22. package/build/controller/executeRefresh.js +39 -0
  23. package/build/controller/executeRequest.js +77 -0
  24. package/build/controller/executeSubmission.js +69 -0
  25. package/build/controller/getErrorMessage.js +7 -0
  26. package/build/controller/getRequestAbortController.js +13 -0
  27. package/build/controller/getResponseType.js +35 -0
  28. package/build/controller/getSafeHttpClient.js +8 -0
  29. package/build/controller/getStepCounter.js +16 -0
  30. package/build/controller/handleErrorResponse.js +26 -0
  31. package/build/controller/makeSafeHttpClient.js +8 -0
  32. package/build/controller/response-utils.js +72 -0
  33. package/build/domain/components/AlertComponent.js +1 -0
  34. package/build/domain/components/AllOfComponent.js +40 -0
  35. package/build/domain/components/BooleanInputComponent.js +50 -0
  36. package/build/domain/components/BoxComponent.js +3 -0
  37. package/build/domain/components/ButtonComponent.js +1 -0
  38. package/build/domain/components/ColumnsComponent.js +3 -0
  39. package/build/domain/components/ConstComponent.js +18 -0
  40. package/build/domain/components/ContainerComponent.js +3 -0
  41. package/build/domain/components/DateInputComponent.js +75 -0
  42. package/build/domain/components/DecisionComponent.js +1 -0
  43. package/build/domain/components/DividerComponent.js +1 -0
  44. package/build/domain/components/FormComponent.js +3 -0
  45. package/build/domain/components/FormattedValueComponent.js +44 -0
  46. package/build/domain/components/HeadingComponent.js +1 -0
  47. package/build/domain/components/ImageComponent.js +1 -0
  48. package/build/domain/components/InstructionsComponent.js +1 -0
  49. package/build/domain/components/IntegerInputComponent.js +74 -0
  50. package/build/domain/components/ListComponent.js +1 -0
  51. package/build/domain/components/LoadingIndicatorComponent.js +1 -0
  52. package/build/domain/components/MarkdownComponent.js +1 -0
  53. package/build/domain/components/MediaComponent.js +1 -0
  54. package/build/domain/components/ModalComponent.js +16 -0
  55. package/build/domain/components/ModalLayoutComponent.js +3 -0
  56. package/build/domain/components/MoneyInputComponent.js +57 -0
  57. package/build/domain/components/MultiSelectInputComponent.js +81 -0
  58. package/build/domain/components/MultiUploadInputComponent.js +88 -0
  59. package/build/domain/components/NumberInputComponent.js +73 -0
  60. package/build/domain/components/ObjectComponent.js +45 -0
  61. package/build/domain/components/ParagraphComponent.js +1 -0
  62. package/build/domain/components/PersistAsyncComponent.js +92 -0
  63. package/build/domain/components/ProgressComponent.js +1 -0
  64. package/build/domain/components/RepeatableComponent.js +103 -0
  65. package/build/domain/components/ReviewComponent.js +1 -0
  66. package/build/domain/components/RootDomainComponent.js +173 -0
  67. package/build/domain/components/SectionComponent.js +5 -0
  68. package/build/domain/components/SelectInputComponent.js +88 -0
  69. package/build/domain/components/StatusListComponent.js +1 -0
  70. package/build/domain/components/SubflowDomainComponent.js +9 -0
  71. package/build/domain/components/TabsComponent.js +1 -0
  72. package/build/domain/components/TextInputComponent.js +76 -0
  73. package/build/domain/components/TupleComponent.js +41 -0
  74. package/build/domain/components/UploadInputComponent.js +83 -0
  75. package/build/domain/components/UpsellComponent.js +25 -0
  76. package/build/domain/components/searchComponent/SearchComponent.js +92 -0
  77. package/build/domain/components/searchComponent/SearchComponent.test.js +190 -0
  78. package/build/domain/components/step/ExternalConfirmationComponent.js +28 -0
  79. package/build/domain/components/step/StepDomainComponent.js +73 -0
  80. package/build/domain/components/step/ToolbarComponent.js +1 -0
  81. package/build/domain/components/utils/WithUpdate.js +1 -0
  82. package/build/domain/components/utils/component-utils.js +12 -0
  83. package/build/domain/components/utils/debounce.js +34 -0
  84. package/build/domain/components/utils/debounce.test.js +67 -0
  85. package/build/domain/components/utils/file-utils.js +21 -0
  86. package/build/domain/components/utils/file-utils.test.js +27 -0
  87. package/build/domain/components/utils/getRandomId.js +1 -0
  88. package/build/domain/components/utils/isExactLocalValueMatch.js +14 -0
  89. package/build/domain/components/utils/isOrWasValid.js +5 -0
  90. package/build/domain/components/utils/isPartialModelMatch.js +18 -0
  91. package/build/domain/components/utils/isPartialModelMatch.test.js +74 -0
  92. package/build/domain/features/eventNames.js +24 -0
  93. package/build/domain/features/events.js +1 -0
  94. package/build/domain/features/persistAsync/getComponentMultiPersistAsync.js +50 -0
  95. package/build/domain/features/persistAsync/getInitialPersistedState.js +7 -0
  96. package/build/domain/features/persistAsync/getPerformPersistAsync.js +43 -0
  97. package/build/domain/features/persistAsync/getPerformPersistAsync.test.js +139 -0
  98. package/build/domain/features/polling/getStepPolling.js +43 -0
  99. package/build/domain/features/polling/getStepPolling.test.js +90 -0
  100. package/build/domain/features/prefetch/getStepPrefetch.js +43 -0
  101. package/build/domain/features/prefetch/request-cache.js +49 -0
  102. package/build/domain/features/prefetch/request-cache.test.js +70 -0
  103. package/build/domain/features/refreshAfter/getStepRefreshAfter.js +24 -0
  104. package/build/domain/features/refreshAfter/getStepRefreshAfter.test.js +40 -0
  105. package/build/domain/features/schema-on-change/getDebouncedSchemaOnChange.js +50 -0
  106. package/build/domain/features/schema-on-change/getSchemaOnChange.js +34 -0
  107. package/build/domain/features/search/getPerformSearchFunction.js +75 -0
  108. package/build/domain/features/search/getPerformSearchFunction.test.js +301 -0
  109. package/build/domain/features/summary/summary-utils.js +40 -0
  110. package/build/domain/features/summary/summary-utils.test.js +125 -0
  111. package/build/domain/features/utils/http-utils.js +21 -0
  112. package/build/domain/features/utils/response-utils.js +9 -0
  113. package/build/domain/features/validation/spec-utils.js +19 -0
  114. package/build/domain/features/validation/validateStringPattern.js +24 -0
  115. package/build/domain/features/validation/validation-functions.js +6 -0
  116. package/build/domain/features/validation/validation-functions.test.js +108 -0
  117. package/build/domain/features/validation/value-checks.js +125 -0
  118. package/build/domain/features/validation/value-checks.test.js +262 -0
  119. package/build/domain/features/validationAsync/getComponentValidationAsync.js +53 -0
  120. package/build/domain/features/validationAsync/getComponentValidationAsync.test.js +67 -0
  121. package/build/domain/features/validationAsync/getInitialValidationAsyncState.js +5 -0
  122. package/build/domain/features/validationAsync/getPerformValidationAsync.js +45 -0
  123. package/build/domain/features/validationAsync/getPerformValidationAsync.test.js +143 -0
  124. package/build/domain/mappers/layout/alertLayoutToComponent.js +16 -0
  125. package/build/domain/mappers/layout/boxLayoutToComponent.js +13 -0
  126. package/build/domain/mappers/layout/buttonLayoutToComponent.js +77 -0
  127. package/build/domain/mappers/layout/columnsLayoutToComponent.js +13 -0
  128. package/build/domain/mappers/layout/decisionLayoutToComponent.js +22 -0
  129. package/build/domain/mappers/layout/deprecatedListLayoutToComponent.js +30 -0
  130. package/build/domain/mappers/layout/dividerLayoutToComponent.js +2 -0
  131. package/build/domain/mappers/layout/formLayoutToComponent.js +19 -0
  132. package/build/domain/mappers/layout/headingLayoutToComponent.js +12 -0
  133. package/build/domain/mappers/layout/imageLayoutToComponent.js +20 -0
  134. package/build/domain/mappers/layout/infoLayoutToComponent.js +12 -0
  135. package/build/domain/mappers/layout/instructionsLayoutToComponent.js +12 -0
  136. package/build/domain/mappers/layout/listLayoutToComponent.js +39 -0
  137. package/build/domain/mappers/layout/loadingIndicatorLayoutToComponent.js +9 -0
  138. package/build/domain/mappers/layout/markdownLayoutToComponent.js +12 -0
  139. package/build/domain/mappers/layout/mediaLayoutToComponent.js +12 -0
  140. package/build/domain/mappers/layout/modalLayoutToComponent.js +17 -0
  141. package/build/domain/mappers/layout/modalToComponent.js +8 -0
  142. package/build/domain/mappers/layout/paragraphLayoutToComponent.js +12 -0
  143. package/build/domain/mappers/layout/progressLayoutToComponent.js +15 -0
  144. package/build/domain/mappers/layout/reviewLayoutToComponent.js +48 -0
  145. package/build/domain/mappers/layout/searchLayoutToComponent.js +44 -0
  146. package/build/domain/mappers/layout/sectionLayoutToComponent.js +15 -0
  147. package/build/domain/mappers/layout/statusListLayoutToComponent.js +15 -0
  148. package/build/domain/mappers/layout/tabsLayoutToComponent.js +16 -0
  149. package/build/domain/mappers/layout/upsellLayoutToComponent.js +25 -0
  150. package/build/domain/mappers/mapLayoutToComponent.js +81 -0
  151. package/build/domain/mappers/mapSchemaToComponent.js +61 -0
  152. package/build/domain/mappers/mapSchemaToComponent.test.js +112 -0
  153. package/build/domain/mappers/mapStepSchemas.js +17 -0
  154. package/build/domain/mappers/mapStepToComponent.js +132 -0
  155. package/build/domain/mappers/mapStepToComponent.test.js +221 -0
  156. package/build/domain/mappers/mapToolbarToComponent.js +15 -0
  157. package/build/domain/mappers/schema/allOfSchemaToComponent.js +16 -0
  158. package/build/domain/mappers/schema/arraySchemaToComponent/arraySchemaToComponent.js +26 -0
  159. package/build/domain/mappers/schema/arraySchemaToComponent/arraySchemaToMultiSelectComponent.js +55 -0
  160. package/build/domain/mappers/schema/arraySchemaToComponent/arraySchemaToMultiUploadComponent.js +67 -0
  161. package/build/domain/mappers/schema/arraySchemaToComponent/arraySchemaToRepeatableComponent.js +57 -0
  162. package/build/domain/mappers/schema/arraySchemaToComponent/arraySchemaToTupleComponent.js +20 -0
  163. package/build/domain/mappers/schema/blobSchemaToComponent.js +15 -0
  164. package/build/domain/mappers/schema/booleanSchemaToComponent.js +29 -0
  165. package/build/domain/mappers/schema/constSchemaToComponent.js +23 -0
  166. package/build/domain/mappers/schema/integerSchemaToComponent.js +28 -0
  167. package/build/domain/mappers/schema/numberSchemaToComponent.js +26 -0
  168. package/build/domain/mappers/schema/objectSchemaToComponent/assertDisplayOrder.js +23 -0
  169. package/build/domain/mappers/schema/objectSchemaToComponent/objectSchemaToFormattedValueComponent.js +9 -0
  170. package/build/domain/mappers/schema/objectSchemaToComponent/objectSchemaToMoneyInputComponent.js +119 -0
  171. package/build/domain/mappers/schema/objectSchemaToComponent/objectSchemaToMoneyInputComponent.test.js +96 -0
  172. package/build/domain/mappers/schema/objectSchemaToComponent/objectSchemaToObjectComponent.js +31 -0
  173. package/build/domain/mappers/schema/objectSchemaToComponent/objectSchemaToObjectComponent.test.js +99 -0
  174. package/build/domain/mappers/schema/oneOfSchemaToComponent/oneOfSchemaToComponent.js +76 -0
  175. package/build/domain/mappers/schema/oneOfSchemaToComponent/oneOfSchemaToComponent.test.js +265 -0
  176. package/build/domain/mappers/schema/persistAsyncSchemaToComponent.js +29 -0
  177. package/build/domain/mappers/schema/stringSchemaToComponent/stringSchemaToComponent.js +18 -0
  178. package/build/domain/mappers/schema/stringSchemaToComponent/stringSchemaToComponent.test.js +133 -0
  179. package/build/domain/mappers/schema/stringSchemaToComponent/stringSchemaToDateInputComponent.js +48 -0
  180. package/build/domain/mappers/schema/stringSchemaToComponent/stringSchemaToTextInputComponent.js +37 -0
  181. package/build/domain/mappers/schema/stringSchemaToComponent/stringSchemaToUploadInputComponent.js +28 -0
  182. package/build/domain/mappers/schema/tests/test-utils.js +16 -0
  183. package/build/domain/mappers/schema/types.js +1 -0
  184. package/build/domain/mappers/schema/utils/getPerformPersistAsyncFn.js +19 -0
  185. package/build/domain/mappers/schema/utils/getValidationAsyncInitialState.js +23 -0
  186. package/build/domain/mappers/schema/utils/mapCommonSchemaProps.js +16 -0
  187. package/build/domain/mappers/types.js +1 -0
  188. package/build/domain/mappers/utils/FeatureFlags.js +22 -0
  189. package/build/domain/mappers/utils/behavior-utils.js +44 -0
  190. package/build/domain/mappers/utils/call-to-action-utils.js +21 -0
  191. package/build/domain/mappers/utils/getAutocompleteString.js +76 -0
  192. package/build/domain/mappers/utils/getAutocompleteString.test.js +21 -0
  193. package/build/domain/mappers/utils/groupLayoutByPinned.js +38 -0
  194. package/build/domain/mappers/utils/groupLayoutByPinned.test.js +166 -0
  195. package/build/domain/mappers/utils/image.js +9 -0
  196. package/build/domain/mappers/utils/layout-utils.js +11 -0
  197. package/build/domain/mappers/utils/legacy-utils.js +49 -0
  198. package/build/domain/mappers/utils/media-utils.js +14 -0
  199. package/build/domain/mappers/utils/suggestions-utils.js +26 -0
  200. package/build/domain/mappers/utils/suggestions-utils.test.js +36 -0
  201. package/build/domain/mappers/utils/tags-utils.js +1 -0
  202. package/build/domain/mappers/utils/utils.js +35 -0
  203. package/build/domain/types.js +1 -0
  204. package/build/getSubflowCallbacks.js +38 -0
  205. package/build/i18n/index.js +40 -0
  206. package/build/index.js +8 -0
  207. package/build/main.js +112 -54
  208. package/build/main.mjs +111 -53
  209. package/build/renderers/CoreContainerRenderer.js +5 -0
  210. package/build/renderers/CoreRootRenderer.js +12 -0
  211. package/build/renderers/EmptyLoadingStateRenderer.js +5 -0
  212. package/build/renderers/getRenderFunction.js +24 -0
  213. package/build/renderers/getSchemaErrorMessageFunction.js +97 -0
  214. package/build/renderers/mappers/alertComponentToProps.js +2 -0
  215. package/build/renderers/mappers/allOfComponentToProps.js +6 -0
  216. package/build/renderers/mappers/booleanInputComponentToProps.js +5 -0
  217. package/build/renderers/mappers/boxComponentToProps.js +13 -0
  218. package/build/renderers/mappers/buttonComponentToProps.js +4 -0
  219. package/build/renderers/mappers/columnsComponentToProps.js +11 -0
  220. package/build/renderers/mappers/componentToRendererProps.js +164 -0
  221. package/build/renderers/mappers/constComponentToProps.js +5 -0
  222. package/build/renderers/mappers/containerComponentToProps.js +7 -0
  223. package/build/renderers/mappers/dateInputComponentToProps.js +2 -0
  224. package/build/renderers/mappers/decisionComponentToProps.js +16 -0
  225. package/build/renderers/mappers/dividerComponentToProps.js +2 -0
  226. package/build/renderers/mappers/externalComponentToProps.js +3 -0
  227. package/build/renderers/mappers/formComponentToProps.js +12 -0
  228. package/build/renderers/mappers/formattedValueComponentToProps.js +5 -0
  229. package/build/renderers/mappers/headingComponentToProps.js +2 -0
  230. package/build/renderers/mappers/hiddenComponentToProps.js +4 -0
  231. package/build/renderers/mappers/imageComponentToProps.js +2 -0
  232. package/build/renderers/mappers/instructionsComponentToProps.js +2 -0
  233. package/build/renderers/mappers/integerInputComponentToProps.js +2 -0
  234. package/build/renderers/mappers/listComponentToProps.js +2 -0
  235. package/build/renderers/mappers/loadingIndicatorComponentToProps.js +2 -0
  236. package/build/renderers/mappers/markdownComponentToProps.js +2 -0
  237. package/build/renderers/mappers/mediaComponentToProps.js +2 -0
  238. package/build/renderers/mappers/modalComponentToProps.js +11 -0
  239. package/build/renderers/mappers/modalLayoutComponentToProps.js +16 -0
  240. package/build/renderers/mappers/moneyInputComponentToProps.js +36 -0
  241. package/build/renderers/mappers/multiSelectComponentToProps.js +23 -0
  242. package/build/renderers/mappers/multiUploadInputComponentToProps.js +12 -0
  243. package/build/renderers/mappers/numberInputComponentToProps.js +2 -0
  244. package/build/renderers/mappers/objectComponentToProps.js +8 -0
  245. package/build/renderers/mappers/paragraphComponentToProps.js +2 -0
  246. package/build/renderers/mappers/persistAsyncComponentToProps.js +8 -0
  247. package/build/renderers/mappers/progressComponentToProps.js +2 -0
  248. package/build/renderers/mappers/repeatableComponentToProps.js +30 -0
  249. package/build/renderers/mappers/reviewComponentToProps.js +2 -0
  250. package/build/renderers/mappers/rootComponentToProps.js +21 -0
  251. package/build/renderers/mappers/searchComponentToProps.js +57 -0
  252. package/build/renderers/mappers/sectionComponentToProps.js +6 -0
  253. package/build/renderers/mappers/selectInputComponentToProps.js +26 -0
  254. package/build/renderers/mappers/statusListComponentToProps.js +2 -0
  255. package/build/renderers/mappers/subflowComponentToRendererProps.js +4 -0
  256. package/build/renderers/mappers/tabsComponentToProps.js +14 -0
  257. package/build/renderers/mappers/textInputComponentToProps.js +2 -0
  258. package/build/renderers/mappers/tupleComponentToProps.js +8 -0
  259. package/build/renderers/mappers/uploadInputComponentToProps.js +8 -0
  260. package/build/renderers/mappers/upsellComponentToProps.js +2 -0
  261. package/build/renderers/mappers/utils/getValidationState.js +12 -0
  262. package/build/renderers/mappers/utils/inputComponentToProps.js +26 -0
  263. package/build/renderers/mappers/utils/mapErrorsToValidationState.js +9 -0
  264. package/build/renderers/mappers/utils/pick.js +8 -0
  265. package/build/renderers/mappers/utils/selectInputOptionsToProps.js +11 -0
  266. package/build/renderers/stepComponentToProps.js +32 -0
  267. package/build/renderers/utils.js +69 -0
  268. package/build/renderers/utils.test.js +70 -0
  269. package/build/stories/dev-tools/ContainerQueries.story.js +66 -0
  270. package/build/stories/dev-tools/Debugger.story.js +38 -0
  271. package/build/stories/dev-tools/FixtureSelect.story.js +23 -0
  272. package/build/stories/dev-tools/TestServer.story.js +32 -0
  273. package/build/stories/examples/NativeFlow.story.js +80 -0
  274. package/build/stories/examples/Recipients.story.js +568 -0
  275. package/build/stories/spec/behavior/Copy.story.js +59 -0
  276. package/build/stories/spec/behavior/Modal.story.js +76 -0
  277. package/build/stories/spec/behavior/Subflow.story.js +267 -0
  278. package/build/stories/spec/layouts/Decision.story.js +241 -0
  279. package/build/stories/spec/layouts/Image.story.js +42 -0
  280. package/build/stories/spec/layouts/Modal.story.js +81 -0
  281. package/build/stories/spec/layouts/Search.story.js +325 -0
  282. package/build/stories/spec/layouts/Upsell.story.js +55 -0
  283. package/build/stories/spec/layouts/button/Button.story.js +100 -0
  284. package/build/stories/spec/layouts/button/PinnedButton.story.js +81 -0
  285. package/build/stories/spec/response/ActionResponse.story.js +66 -0
  286. package/build/stories/spec/schemas/MultiSelect.story.js +148 -0
  287. package/build/stories/spec/schemas/Upload.story.js +168 -0
  288. package/build/stories/spec/schemas/const/ConstLayout.story.js +159 -0
  289. package/build/stories/spec/schemas/const/ObjectConst.story.js +94 -0
  290. package/build/stories/spec/schemas/features/PersistAsync.story.js +176 -0
  291. package/build/stories/spec/schemas/features/ValidationAsync.story.js +103 -0
  292. package/build/stories/spec/schemas/object/FormattedValue.story.js +92 -0
  293. package/build/stories/spec/schemas/object/MoneyInput.story.js +240 -0
  294. package/build/stories/spec/schemas/oneOf/OneOfInitialisation.story.js +55 -0
  295. package/build/stories/spec/step/Controls.story.js +109 -0
  296. package/build/stories/spec/step/DFModal.story.js +58 -0
  297. package/build/stories/spec/step/Footer.story.js +70 -0
  298. package/build/stories/spec/step/Navigation.story.js +20 -0
  299. package/build/stories/spec/step/Tags.story.js +39 -0
  300. package/build/stories/spec/step/ToolBar.story.js +60 -0
  301. package/build/stories/spec/step/features/ErrorHandling.story.js +92 -0
  302. package/build/stories/spec/step/features/External.story.js +44 -0
  303. package/build/stories/spec/step/features/Polling.story.js +108 -0
  304. package/build/stories/spec/step/features/RefreshAfter.story.js +92 -0
  305. package/build/stories/spec/step/features/refresh/Refresh.story.js +258 -0
  306. package/build/stories/spec/step/features/refresh/RefreshWithPersistAsync.story.js +958 -0
  307. package/build/stories/types.js +1 -0
  308. package/build/stories/utils/fixtureHttpClient.js +70 -0
  309. package/build/stories/utils/getBasicStep.js +223 -0
  310. package/build/stories/utils/mockSearchHandler.js +71 -0
  311. package/build/stories/utils/render-utils.js +41 -0
  312. package/build/stories/visual-tests/layouts/NotUsingListItem.story.js +17 -0
  313. package/build/test-utils/DynamicFlowWise.js +32 -0
  314. package/build/test-utils/DynamicFlowWiseModal.js +34 -0
  315. package/build/test-utils/NeptuneProviders.js +11 -0
  316. package/build/test-utils/component-utils.js +5 -0
  317. package/build/test-utils/fetch-utils.js +45 -0
  318. package/build/test-utils/getMergedTestRenderers.js +34 -0
  319. package/build/test-utils/getRandomId.js +1 -0
  320. package/build/test-utils/index.js +3 -0
  321. package/build/test-utils/rtl-utils.js +7 -0
  322. package/build/test-utils/step-utils.js +6 -0
  323. package/build/test-utils/wait.js +3 -0
  324. package/build/tests/AlertLayout.test.js +78 -0
  325. package/build/tests/ArrayTuple.test.js +118 -0
  326. package/build/tests/ButtonLayout.test.js +308 -0
  327. package/build/tests/ConstLayout.test.js +95 -0
  328. package/build/tests/DateInput.test.js +163 -0
  329. package/build/tests/DecisionLayout.test.js +146 -0
  330. package/build/tests/DynamicFlow.test.js +147 -0
  331. package/build/tests/External.test.js +169 -0
  332. package/build/tests/Flow.test.js +328 -0
  333. package/build/tests/FormLayout.test.js +28 -0
  334. package/build/tests/FormattedValue.test.js +107 -0
  335. package/build/tests/ImageRenderer.test.js +78 -0
  336. package/build/tests/InitialAction.test.js +179 -0
  337. package/build/tests/InitialStep.test.js +168 -0
  338. package/build/tests/InstructionsLayout.test.js +45 -0
  339. package/build/tests/ListLayout.test.js +145 -0
  340. package/build/tests/Logging.test.js +53 -0
  341. package/build/tests/ModalBehavior.test.js +149 -0
  342. package/build/tests/MoneyInput.test.js +316 -0
  343. package/build/tests/MultiUpload.test.js +293 -0
  344. package/build/tests/NativeBack.test.js +267 -0
  345. package/build/tests/OneOfInitialisation.test.js +571 -0
  346. package/build/tests/PersistAsync.test.js +653 -0
  347. package/build/tests/Polling.test.js +617 -0
  348. package/build/tests/Prefetching.test.js +230 -0
  349. package/build/tests/RefreshAfter.test.js +63 -0
  350. package/build/tests/RefreshOnChange.ResponseHandling.test.js +205 -0
  351. package/build/tests/RefreshOnChange.test.js +233 -0
  352. package/build/tests/RefreshOnChange.with.Segmented.test.js +348 -0
  353. package/build/tests/RefreshOnChange.with.Tabs.test.js +358 -0
  354. package/build/tests/RefreshOnChangePreserve.test.js +224 -0
  355. package/build/tests/RendererProps.test.js +342 -0
  356. package/build/tests/Repeatable.test.js +107 -0
  357. package/build/tests/Rerendering.test.js +67 -0
  358. package/build/tests/ReviewLayout.test.js +274 -0
  359. package/build/tests/SchemaOnChange.test.js +133 -0
  360. package/build/tests/ScrollToError.test.js +217 -0
  361. package/build/tests/SegmentedControl.test.js +49 -0
  362. package/build/tests/SingleFileUpload.test.js +88 -0
  363. package/build/tests/StatusList.test.js +85 -0
  364. package/build/tests/Subflow.test.js +710 -0
  365. package/build/tests/Submission.ResponseHandling.test.js +557 -0
  366. package/build/tests/Submission.merging.test.js +202 -0
  367. package/build/tests/Submission.test.js +523 -0
  368. package/build/tests/Tags.test.js +475 -0
  369. package/build/tests/Upsell.test.js +126 -0
  370. package/build/tests/ValidationAsync.test.js +295 -0
  371. package/build/tests/legacy/Actions.test.js +158 -0
  372. package/build/tests/legacy/BackButton.test.js +114 -0
  373. package/build/tests/legacy/HiddenSchemas.test.js +246 -0
  374. package/build/tests/legacy/MultiSelect.test.js +497 -0
  375. package/build/tests/legacy/MultipleFileUploadSchema.test.js +341 -0
  376. package/build/tests/legacy/PersistAsync.blob-schema.test.js +224 -0
  377. package/build/tests/legacy/PersistAsync.string-schema.test.js +211 -0
  378. package/build/tests/legacy/RefreshStepOnChange.debouncing.test.js +209 -0
  379. package/build/tests/legacy/RefreshStepOnChange.test.js +424 -0
  380. package/build/tests/legacy/Search.test.js +437 -0
  381. package/build/tests/renderers/MultiSelectInputRendererProps.test.js +58 -0
  382. package/build/tests/renderers/SelectInputRendererProps.test.js +42 -0
  383. package/build/tests/renderers/TextInputRenderer.test.js +51 -0
  384. package/build/types/domain/components/UpsellComponent.d.ts +2 -3
  385. package/build/types/domain/components/UpsellComponent.d.ts.map +1 -1
  386. package/build/types/domain/components/searchComponent/SearchComponent.d.ts +5 -4
  387. package/build/types/domain/components/searchComponent/SearchComponent.d.ts.map +1 -1
  388. package/build/types/domain/features/search/getPerformSearchFunction.d.ts +1 -1
  389. package/build/types/domain/features/search/getPerformSearchFunction.d.ts.map +1 -1
  390. package/build/types/domain/mappers/layout/searchLayoutToComponent.d.ts +2 -1
  391. package/build/types/domain/mappers/layout/searchLayoutToComponent.d.ts.map +1 -1
  392. package/build/types/domain/mappers/layout/upsellLayoutToComponent.d.ts +1 -1
  393. package/build/types/domain/mappers/layout/upsellLayoutToComponent.d.ts.map +1 -1
  394. package/build/types/renderers/EmptyLoadingStateRenderer.d.ts +3 -0
  395. package/build/types/renderers/EmptyLoadingStateRenderer.d.ts.map +1 -0
  396. package/build/types/renderers/mappers/rootComponentToProps.d.ts.map +1 -1
  397. package/build/types/renderers/mappers/searchComponentToProps.d.ts +1 -1
  398. package/build/types/renderers/mappers/searchComponentToProps.d.ts.map +1 -1
  399. package/build/types/renderers/mappers/upsellComponentToProps.d.ts +2 -2
  400. package/build/types/renderers/mappers/upsellComponentToProps.d.ts.map +1 -1
  401. package/build/types/test-utils/getMergedTestRenderers.d.ts +1 -1
  402. package/build/types/test-utils/getMergedTestRenderers.d.ts.map +1 -1
  403. package/build/types/useDynamicFlow.d.ts.map +1 -1
  404. package/build/types.js +1 -0
  405. package/build/useDynamicFlow.js +104 -0
  406. package/build/useDynamicFlowModal.js +58 -0
  407. package/build/utils/analyse-step.js +14 -0
  408. package/build/utils/component-utils.js +8 -0
  409. package/build/utils/component-utils.test.js +113 -0
  410. package/build/utils/getScrollToTop.js +12 -0
  411. package/build/utils/normalise-flow-id.js +1 -0
  412. package/build/utils/normalise-flow-id.test.js +24 -0
  413. package/build/utils/openLinkInNewTab.js +10 -0
  414. package/build/utils/recursiveMerge.js +40 -0
  415. package/build/utils/recursiveMerge.test.js +93 -0
  416. package/build/utils/type-utils.js +21 -0
  417. package/build/utils/type-validators.js +11 -0
  418. package/build/utils/type-validators.test.js +180 -0
  419. package/build/utils/useStableCallback.js +15 -0
  420. package/package.json +4 -4
@@ -0,0 +1,179 @@
1
+ import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
2
+ /* eslint-disable @typescript-eslint/no-unsafe-member-access */
3
+ import { screen, waitFor } from '@testing-library/react';
4
+ import userEvent from '@testing-library/user-event';
5
+ import { useState } from 'react';
6
+ import { renderWithProviders, respondWith } from '../test-utils';
7
+ import DynamicFlowWise from '../test-utils/DynamicFlowWise';
8
+ import { vi } from 'vitest';
9
+ const user = userEvent.setup({ advanceTimers: vi.advanceTimersByTime });
10
+ const getDefaultProps = () => ({
11
+ flowId: 'flow-id',
12
+ httpClient: vi.fn().mockResolvedValue(respondWith(getStep())),
13
+ initialAction: { url: '/initial', method: 'GET' },
14
+ onCompletion: vi.fn(),
15
+ onError: vi.fn(),
16
+ onEvent: vi.fn(),
17
+ onLog: vi.fn(),
18
+ onLink: vi.fn(),
19
+ });
20
+ const getStep = () => ({
21
+ id: 'step-id',
22
+ title: 'Initial Action Test',
23
+ analytics: { custom: 'analytics' },
24
+ layout: [
25
+ { type: 'paragraph', text: 'This is a test' },
26
+ {
27
+ type: 'button',
28
+ title: 'Submit',
29
+ action: { id: 'action-id', url: '/submit', method: 'POST' },
30
+ },
31
+ ],
32
+ schemas: [],
33
+ model: null,
34
+ });
35
+ describe('Initial action', () => {
36
+ describe('Given a DynamicFlow component with a "initialAction" prop', () => {
37
+ it('renders the step', async () => {
38
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, getDefaultProps())));
39
+ await waitFor(() => {
40
+ expect(screen.getByText('This is a test')).toBeInTheDocument();
41
+ });
42
+ });
43
+ it('triggers the "Initiated" tracking event with flowId', async () => {
44
+ const props = getDefaultProps();
45
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
46
+ await waitFor(() => {
47
+ expect(props.onEvent).toHaveBeenCalledWith('Dynamic Flow - Initiated', expect.objectContaining({
48
+ flowId: 'flow-id',
49
+ }));
50
+ });
51
+ });
52
+ it('does not trigger "Action Triggered" nor "Action Succeeded" tracking events', async () => {
53
+ const props = getDefaultProps();
54
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
55
+ await waitFor(() => {
56
+ expect(props.onEvent).toHaveBeenCalledWith('Dynamic Flow - Step Shown', expect.anything());
57
+ });
58
+ expect(props.onEvent).not.toHaveBeenCalledWith('Dynamic Flow - Action Triggered', expect.anything());
59
+ expect(props.onEvent).not.toHaveBeenCalledWith('Dynamic Flow - Action Succeeded', expect.anything());
60
+ });
61
+ it('triggers the "Step Shown" tracking event, with flowId, stepId, and step analytics', async () => {
62
+ const props = getDefaultProps();
63
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
64
+ await waitFor(() => {
65
+ expect(props.onEvent).toHaveBeenCalledWith('Dynamic Flow - Step Shown', expect.objectContaining({
66
+ flowId: 'flow-id',
67
+ stepId: 'step-id',
68
+ stepCount: 0,
69
+ custom: 'analytics',
70
+ isFirstStep: true,
71
+ }));
72
+ });
73
+ });
74
+ describe('when the initialAction is missing the method property', () => {
75
+ it('makes the GET request', async () => {
76
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialAction: { url: '/initial' } });
77
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
78
+ await waitFor(() => {
79
+ expect(props.httpClient).toHaveBeenCalledWith('/initial', expect.objectContaining({ method: 'GET' }));
80
+ });
81
+ });
82
+ });
83
+ describe('when the initialAction is a GET method', () => {
84
+ it('makes the GET request', async () => {
85
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialAction: { url: '/initial', method: 'GET' } });
86
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
87
+ await waitFor(() => {
88
+ expect(props.httpClient).toHaveBeenCalledWith('/initial', expect.objectContaining({ method: 'GET' }));
89
+ });
90
+ });
91
+ });
92
+ describe('when the initialAction is a POST method', () => {
93
+ it('makes the POST request', async () => {
94
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialAction: {
95
+ url: '/initial',
96
+ method: 'POST',
97
+ data: { custom: 'data' },
98
+ } });
99
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
100
+ await waitFor(() => {
101
+ expect(props.httpClient).toHaveBeenCalledWith('/initial', expect.objectContaining({ method: 'POST', body: '{"custom":"data"}' }));
102
+ });
103
+ });
104
+ });
105
+ describe('when the initial request fails with a generic "Initial request failed"', () => {
106
+ it('(the fetch promise rejects) calls the onError callback', async () => {
107
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { httpClient: vi.fn().mockRejectedValue(new Error('Failed')) });
108
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
109
+ await waitFor(() => {
110
+ expect(props.onError).toHaveBeenCalledWith(expect.any(Error), undefined);
111
+ });
112
+ expect(props.onError.mock.calls[0][0].message).toContain('Initial request failed');
113
+ });
114
+ it('(with status 500, and empty body) calls the onError callback with a generic "Initial request failed"', async () => {
115
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { httpClient: vi.fn().mockResolvedValue(respondWith(null, { status: 500 })) });
116
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
117
+ await waitFor(() => {
118
+ expect(props.onError).toHaveBeenCalledWith(expect.any(Error), 500);
119
+ });
120
+ expect(props.onError.mock.calls[0][0].message).toContain('Initial request failed');
121
+ });
122
+ it('(with status 504, and a string body) calls the onError callback with the specified string error', async () => {
123
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { httpClient: vi
124
+ .fn()
125
+ .mockResolvedValue(new Response('504 Gateway Time-out', { status: 504 })) });
126
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
127
+ await waitFor(() => {
128
+ expect(props.onError).toHaveBeenCalledWith(expect.any(Error), 504);
129
+ });
130
+ expect(props.onError.mock.calls[0][0].message).toContain('504 Gateway Time-out');
131
+ });
132
+ it('(with status 500, and global error) calls the onError callback with the error message specified in the response JSON body', async () => {
133
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { httpClient: vi
134
+ .fn()
135
+ .mockResolvedValue(respondWith({ error: 'This is a global error' }, { status: 500 })) });
136
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
137
+ await waitFor(() => {
138
+ expect(props.onError).toHaveBeenCalledWith(expect.any(Error), 500);
139
+ });
140
+ expect(props.onError.mock.calls[0][0].message).toContain('This is a global error');
141
+ });
142
+ it('(step without id/key) calls the onError callback', async () => {
143
+ const httpClient = vi.fn().mockResolvedValue({
144
+ title: 'Step without id nor key',
145
+ layout: [],
146
+ schemas: [],
147
+ });
148
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { httpClient, initialAction: { url: '/initial' } });
149
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
150
+ await waitFor(() => {
151
+ expect(props.onError).toHaveBeenCalledWith(expect.any(Error), undefined);
152
+ });
153
+ });
154
+ });
155
+ describe('when the DF component is re-rendered by its parent', () => {
156
+ function ContainerComponent(props) {
157
+ const [, setState] = useState({});
158
+ const rerender = () => setState({});
159
+ const newProps = Object.assign(Object.assign({}, props), { initialAction: {
160
+ url: '/initial',
161
+ method: 'POST',
162
+ data: { custom: 'data' },
163
+ } });
164
+ return (_jsxs(_Fragment, { children: [_jsx("button", { type: "button", onClick: () => rerender(), children: "rerender" }), _jsx(DynamicFlowWise, Object.assign({}, newProps))] }));
165
+ }
166
+ it('makes the initial request only once to fetch the first step', async () => {
167
+ const props = getDefaultProps();
168
+ renderWithProviders(_jsx(ContainerComponent, Object.assign({}, props)));
169
+ await waitFor(() => {
170
+ expect(props.httpClient).toHaveBeenCalledTimes(1);
171
+ });
172
+ await user.click(screen.getByText('rerender'));
173
+ await waitFor(() => {
174
+ expect(props.httpClient).toHaveBeenCalledTimes(1);
175
+ });
176
+ });
177
+ });
178
+ });
179
+ });
@@ -0,0 +1,168 @@
1
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
2
+ /* eslint-disable @typescript-eslint/no-unsafe-member-access */
3
+ import { screen, waitFor } from '@testing-library/react';
4
+ import { renderWithProviders } from '../test-utils';
5
+ import DynamicFlowWise from '../test-utils/DynamicFlowWise';
6
+ import { useState } from 'react';
7
+ import { vi } from 'vitest';
8
+ const getDefaultProps = () => ({
9
+ flowId: 'flow-id',
10
+ httpClient: vi.fn(),
11
+ onCompletion: vi.fn(),
12
+ onError: vi.fn(),
13
+ onEvent: vi.fn(),
14
+ onLog: vi.fn(),
15
+ });
16
+ describe('InitialStep', () => {
17
+ describe('when an initialStep is a valid Step', () => {
18
+ it('renders the step', async () => {
19
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialStep: {
20
+ id: 'step-id',
21
+ title: 'Step with id',
22
+ layout: [],
23
+ schemas: [],
24
+ } });
25
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
26
+ expect(screen.getByText('Step with id')).toBeInTheDocument();
27
+ });
28
+ });
29
+ describe('when an initialStep is missing id and key properties', () => {
30
+ it('triggers onError', async () => {
31
+ // This test causes an error during rendering.
32
+ // Even though the error is caught by the ErrorBoundary,
33
+ // the console.error function is still called.
34
+ // To avoid flooding the test logs with error messages,
35
+ // we temporarily replace the console.error function with a mock.
36
+ // eslint-disable-next-line no-console
37
+ const consoleError = console.error;
38
+ // eslint-disable-next-line no-console
39
+ console.error = vi.fn();
40
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialStep: {
41
+ title: 'Step without id nor key',
42
+ layout: [],
43
+ schemas: [],
44
+ } });
45
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
46
+ await waitFor(() => {
47
+ expect(props.onError).toHaveBeenCalledWith(expect.any(Error), undefined);
48
+ });
49
+ // eslint-disable-next-line require-atomic-updates
50
+ console.error = consoleError;
51
+ });
52
+ it('does not continuously try to re-initialise when parent state is updated', async () => {
53
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialStep: {
54
+ title: 'Step without id nor key',
55
+ layout: [],
56
+ schemas: [],
57
+ } });
58
+ const ParentComponent = () => {
59
+ const [state, setState] = useState(0);
60
+ return (_jsxs("div", { children: [_jsxs("p", { children: ["Parent state: ", state] }), _jsx(DynamicFlowWise, Object.assign({}, props, { onError: () => {
61
+ props.onError();
62
+ setState((prev) => prev + 1);
63
+ } })), ");"] }));
64
+ };
65
+ renderWithProviders(_jsx(ParentComponent, {}));
66
+ await waitFor(() => {
67
+ expect(props.onError).toHaveBeenCalledTimes(1);
68
+ });
69
+ });
70
+ });
71
+ describe('when a step has an object schema...', () => {
72
+ describe('...missing its displayOrder property', () => {
73
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialStep: {
74
+ id: 'step-id',
75
+ title: 'Invalid object schema',
76
+ layout: [{ type: 'form', schemaId: 'MY-OBJECT-SCHEMA' }],
77
+ schemas: [
78
+ {
79
+ $id: 'MY-OBJECT-SCHEMA',
80
+ type: 'object',
81
+ properties: {
82
+ prop1: { type: 'string' },
83
+ prop2: { type: 'string' },
84
+ },
85
+ },
86
+ ],
87
+ } });
88
+ it('triggers onError and logs an event', async () => {
89
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
90
+ await waitFor(() => {
91
+ expect(props.onError).toHaveBeenCalledWith(expect.any(Error), undefined);
92
+ });
93
+ expect(props.onError.mock.calls[0][0].message).toContain('Object schema MY-OBJECT-SCHEMA has no displayOrder property.');
94
+ expect(props.onLog).toHaveBeenCalledWith('info', 'The provided step does not conform to the specification.', // Zod
95
+ expect.anything());
96
+ expect(props.onLog).toHaveBeenCalledWith('error', 'Object schema MY-OBJECT-SCHEMA has no displayOrder property.', { flowId: 'flow-id', stepId: 'step-id', stepCount: 0 });
97
+ });
98
+ });
99
+ describe('...with a displayOrder array that is missing some properties', () => {
100
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialStep: {
101
+ id: 'step-id',
102
+ title: 'Title: Missing properties in displayOrder',
103
+ schemas: [
104
+ {
105
+ $id: 'MY-OBJECT-SCHEMA',
106
+ type: 'object',
107
+ displayOrder: ['prop1'],
108
+ properties: {
109
+ prop1: { type: 'string' },
110
+ prop2: { type: 'string' },
111
+ },
112
+ },
113
+ ],
114
+ layout: [
115
+ { type: 'form', schemaId: 'MY-OBJECT-SCHEMA' },
116
+ {
117
+ type: 'button',
118
+ title: 'Submit',
119
+ action: { url: '/submit', method: 'POST' },
120
+ },
121
+ ],
122
+ model: { prop1: 'value1', prop2: 'value2' },
123
+ } });
124
+ it('triggers onError and logs an event', async () => {
125
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
126
+ await waitFor(() => {
127
+ expect(props.onError).toHaveBeenCalledWith(expect.any(Error), undefined);
128
+ });
129
+ expect(props.onError.mock.calls[0][0].message).toContain('Object schema MY-OBJECT-SCHEMA has a "prop2" property which is missing in the displayOrder array.');
130
+ expect(props.onLog).toHaveBeenCalledWith('error', 'Object schema MY-OBJECT-SCHEMA has a "prop2" property which is missing in the displayOrder array.', { flowId: 'flow-id', stepId: 'step-id', stepCount: 0 });
131
+ });
132
+ });
133
+ describe('...with a displayOrder array that has some extra properties', () => {
134
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialStep: {
135
+ id: 'step-id',
136
+ title: 'Title: Missing properties in displayOrder',
137
+ schemas: [
138
+ {
139
+ $id: 'MY-OBJECT-SCHEMA',
140
+ type: 'object',
141
+ displayOrder: ['prop1', 'prop2', 'prop3'],
142
+ properties: {
143
+ prop1: { type: 'string' },
144
+ prop2: { type: 'string' },
145
+ },
146
+ },
147
+ ],
148
+ layout: [
149
+ { type: 'form', schemaId: 'MY-OBJECT-SCHEMA' },
150
+ {
151
+ type: 'button',
152
+ title: 'Submit',
153
+ action: { url: '/submit', method: 'POST' },
154
+ },
155
+ ],
156
+ model: { prop1: 'value1', prop2: 'value2' },
157
+ } });
158
+ it('triggers onError and logs an event', async () => {
159
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
160
+ await waitFor(() => {
161
+ expect(props.onError).toHaveBeenCalledWith(expect.any(Error), undefined);
162
+ });
163
+ expect(props.onError.mock.calls[0][0].message).toContain('Object schema MY-OBJECT-SCHEMA has no property named "prop3", but it is listed in the displayOrder array.');
164
+ expect(props.onLog).toHaveBeenCalledWith('error', 'Object schema MY-OBJECT-SCHEMA has no property named "prop3", but it is listed in the displayOrder array.', { flowId: 'flow-id', stepId: 'step-id', stepCount: 0 });
165
+ });
166
+ });
167
+ });
168
+ });
@@ -0,0 +1,45 @@
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { renderWithProviders } from '../test-utils';
3
+ import DynamicFlowWise from '../test-utils/DynamicFlowWise';
4
+ import { vi } from 'vitest';
5
+ describe('InstructionsLayout component', () => {
6
+ const getDefaultProps = () => ({
7
+ flowId: 'flow-id',
8
+ httpClient: vi.fn(),
9
+ onCompletion: vi.fn(),
10
+ onError: vi.fn(),
11
+ onEvent: vi.fn(),
12
+ onLog: vi.fn(),
13
+ });
14
+ const getInitialStep = () => ({
15
+ id: 'step-id',
16
+ title: 'Step with instructions',
17
+ layout: [
18
+ {
19
+ type: 'instructions',
20
+ title: 'Instructions Title',
21
+ items: [
22
+ { text: 'Item 1', context: 'neutral', tag: 'tag1' },
23
+ { text: 'Item 2', context: 'neutral', tag: 'tag2' },
24
+ ],
25
+ },
26
+ ],
27
+ schemas: [],
28
+ });
29
+ describe('Extra props', () => {
30
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialStep: getInitialStep() });
31
+ const customRenderer = {
32
+ canRenderType: 'instructions',
33
+ render: vi.fn(),
34
+ };
35
+ it('should pass the tag property to the renderer', async () => {
36
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props, { renderers: [customRenderer] })));
37
+ expect(customRenderer.render).toHaveBeenCalledWith(expect.objectContaining({
38
+ items: expect.arrayContaining([
39
+ expect.objectContaining({ text: 'Item 1', tag: 'tag1' }),
40
+ expect.objectContaining({ text: 'Item 2', tag: 'tag2' }),
41
+ ]),
42
+ }));
43
+ });
44
+ });
45
+ });
@@ -0,0 +1,145 @@
1
+ import { jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
2
+ /* eslint-disable @typescript-eslint/no-unsafe-assignment */
3
+ import { screen } from '@testing-library/react';
4
+ import userEvent from '@testing-library/user-event';
5
+ import { renderWithProviders } from '../test-utils';
6
+ import DynamicFlowWise from '../test-utils/DynamicFlowWise';
7
+ import { vi } from 'vitest';
8
+ const user = userEvent.setup({ advanceTimers: vi.advanceTimersByTime });
9
+ describe('ListLayout component', () => {
10
+ const getDefaultProps = () => ({
11
+ flowId: 'flow-id',
12
+ httpClient: vi.fn(),
13
+ onCompletion: vi.fn(),
14
+ onError: vi.fn(),
15
+ onEvent: vi.fn(),
16
+ onLog: vi.fn(),
17
+ });
18
+ const getInitialStep = () => ({
19
+ id: 'step-id',
20
+ title: 'Step with list',
21
+ layout: [
22
+ {
23
+ type: 'list',
24
+ analyticsId: 'list-layout-aid',
25
+ title: 'List Title',
26
+ items: [
27
+ {
28
+ analyticsId: 'item-1-aid',
29
+ title: 'Item 1',
30
+ tag: 'tag1',
31
+ supportingValues: { value: 'value1', subvalue: 'subvalue1' },
32
+ additionalInfo: {
33
+ text: 'Additional info 1',
34
+ behavior: { type: 'action', action: { url: '/additional-info', method: 'GET' } },
35
+ accessibilityDescription: 'Accessibility description for additional info 1',
36
+ },
37
+ },
38
+ {
39
+ analyticsId: 'item-2-aid',
40
+ title: 'Item 2',
41
+ tag: 'tag2',
42
+ supportingValues: { value: 'value2', subvalue: 'subvalue2' },
43
+ callToAction: {
44
+ title: 'Click me',
45
+ behavior: {
46
+ type: 'action',
47
+ action: { url: '/item-cta' },
48
+ },
49
+ },
50
+ additionalInfo: {
51
+ text: 'Additional info 2',
52
+ behavior: { type: 'action', action: { url: '/additional-info', method: 'GET' } },
53
+ accessibilityDescription: 'Accessibility description for additional info 2',
54
+ },
55
+ },
56
+ ],
57
+ },
58
+ ],
59
+ schemas: [],
60
+ });
61
+ describe('CallToAction', () => {
62
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialStep: getInitialStep() });
63
+ it('should render a button for the item that performs the behavior on click', async () => {
64
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
65
+ expect(screen.getByRole('button', { name: 'Click me' })).toBeInTheDocument();
66
+ await user.click(screen.getByRole('button', { name: 'Click me' }));
67
+ expect(props.httpClient).toHaveBeenCalledWith('/item-cta', expect.anything());
68
+ });
69
+ });
70
+ describe('Extra props', () => {
71
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialStep: getInitialStep() });
72
+ const customRenderer = {
73
+ canRenderType: 'list',
74
+ render: vi.fn(),
75
+ };
76
+ it('should pass the tag and analyticsId property to the renderer', async () => {
77
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props, { renderers: [customRenderer] })));
78
+ expect(customRenderer.render).toHaveBeenCalledWith(expect.objectContaining({
79
+ items: expect.arrayContaining([
80
+ expect.objectContaining({ title: 'Item 1', tag: 'tag1', analyticsId: 'item-1-aid' }),
81
+ expect.objectContaining({ title: 'Item 2', tag: 'tag2', analyticsId: 'item-2-aid' }),
82
+ ]),
83
+ }));
84
+ });
85
+ it('should pass the additionalInfo property to the renderer', async () => {
86
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props, { renderers: [customRenderer] })));
87
+ expect(customRenderer.render).toHaveBeenCalledWith(expect.objectContaining({
88
+ items: expect.arrayContaining([
89
+ expect.objectContaining({
90
+ title: 'Item 1',
91
+ tag: 'tag1',
92
+ additionalInfo: expect.objectContaining({
93
+ text: 'Additional info 1',
94
+ accessibilityDescription: 'Accessibility description for additional info 1',
95
+ }),
96
+ }),
97
+ ]),
98
+ }));
99
+ });
100
+ it('should trigger the specified behavior when the additionalInfo is clicked', async () => {
101
+ const localProps = Object.assign(Object.assign({}, getDefaultProps()), { initialStep: getInitialStep() });
102
+ const testListRenderer = {
103
+ canRenderType: 'list',
104
+ render: (list) => (_jsx(_Fragment, { children: list.items.map((item) => {
105
+ var _a, _b;
106
+ return (_jsx("button", { type: "button", onClick: (_a = item.additionalInfo) === null || _a === void 0 ? void 0 : _a.onClick, children: (_b = item.additionalInfo) === null || _b === void 0 ? void 0 : _b.text }, item.title));
107
+ }) })),
108
+ };
109
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, localProps, { renderers: [testListRenderer] })));
110
+ await user.click(screen.getByRole('button', { name: 'Additional info 1' }));
111
+ expect(localProps.httpClient).toHaveBeenCalledWith('/additional-info', expect.anything());
112
+ });
113
+ it('should pass subvalue, value and subvalue to the renderer, even though they are deprecated', () => {
114
+ const initialStep = {
115
+ id: 'step-id',
116
+ title: 'Step with list',
117
+ layout: [
118
+ {
119
+ type: 'list',
120
+ title: 'List Title',
121
+ items: [
122
+ {
123
+ title: 'Item 1',
124
+ subtitle: 'Item 1 subtitle',
125
+ value: 'value1',
126
+ subvalue: 'subvalue1',
127
+ },
128
+ ],
129
+ },
130
+ ],
131
+ schemas: [],
132
+ };
133
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, getDefaultProps(), { initialStep: initialStep, renderers: [customRenderer] })));
134
+ expect(customRenderer.render).toHaveBeenCalledWith(expect.objectContaining({
135
+ items: expect.arrayContaining([
136
+ expect.objectContaining({
137
+ title: 'Item 1',
138
+ description: 'Item 1 subtitle',
139
+ supportingValues: { value: 'value1', subvalue: 'subvalue1' },
140
+ }),
141
+ ]),
142
+ }));
143
+ });
144
+ });
145
+ });
@@ -0,0 +1,53 @@
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ /* eslint-disable @typescript-eslint/no-unsafe-assignment */
3
+ import { screen, waitFor } from '@testing-library/react';
4
+ import { renderWithProviders } from '../test-utils';
5
+ import DynamicFlowWise from '../test-utils/DynamicFlowWise';
6
+ import { vi } from 'vitest';
7
+ const getDefaultProps = () => ({
8
+ flowId: 'flow-id',
9
+ httpClient: vi.fn(),
10
+ onCompletion: vi.fn(),
11
+ onError: vi.fn(),
12
+ onEvent: vi.fn(),
13
+ onLog: vi.fn(),
14
+ });
15
+ describe('Logging Events', () => {
16
+ describe('when initialStep is missing an "id" property', () => {
17
+ it('renders the step, and logs an event', async () => {
18
+ const props = Object.assign(Object.assign({}, getDefaultProps()), { initialStep: {
19
+ key: 'step-key',
20
+ title: 'Step with key',
21
+ layout: [],
22
+ schemas: [],
23
+ } });
24
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props)));
25
+ expect(screen.getByText('Step with key')).toBeInTheDocument();
26
+ expect(props.onLog).toHaveBeenCalledWith('info', 'The provided step does not conform to the specification.', expect.objectContaining({
27
+ flowId: 'flow-id',
28
+ stepId: 'step-key',
29
+ errors: expect.any(String),
30
+ }));
31
+ });
32
+ });
33
+ describe('when loading a step missing an "id" property', () => {
34
+ it('renders the step, and logs an event', async () => {
35
+ const httpClient = vi.fn().mockResolvedValue(new Response(JSON.stringify({
36
+ key: 'step-key',
37
+ title: 'Step with key',
38
+ layout: [],
39
+ schemas: [],
40
+ }), { status: 200 }));
41
+ const props = getDefaultProps();
42
+ renderWithProviders(_jsx(DynamicFlowWise, Object.assign({}, props, { httpClient: httpClient, initialAction: { url: '/' } })));
43
+ await waitFor(() => {
44
+ expect(screen.getByText('Step with key')).toBeInTheDocument();
45
+ });
46
+ expect(props.onLog).toHaveBeenCalledWith('info', 'The provided step does not conform to the specification.', expect.objectContaining({
47
+ flowId: 'flow-id',
48
+ stepId: 'step-key',
49
+ errors: expect.any(String),
50
+ }));
51
+ });
52
+ });
53
+ });