@defra/forms-engine-plugin 4.22.0 → 5.0.0-alpha

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 (309) hide show
  1. package/.server/server/forms/register-as-a-unicorn-breeder.yaml +0 -14
  2. package/.server/server/forms/simple-form.yaml +106 -3
  3. package/.server/server/plugins/engine/components/AutocompleteField.d.ts +11 -11
  4. package/.server/server/plugins/engine/components/AutocompleteField.js +2 -2
  5. package/.server/server/plugins/engine/components/AutocompleteField.js.map +1 -1
  6. package/.server/server/plugins/engine/components/CheckboxesField.d.ts +3 -2
  7. package/.server/server/plugins/engine/components/CheckboxesField.js +4 -9
  8. package/.server/server/plugins/engine/components/CheckboxesField.js.map +1 -1
  9. package/.server/server/plugins/engine/components/ComponentCollection.d.ts +8 -7
  10. package/.server/server/plugins/engine/components/ComponentCollection.js +106 -51
  11. package/.server/server/plugins/engine/components/ComponentCollection.js.map +1 -1
  12. package/.server/server/plugins/engine/components/DatePartsField.d.ts +8 -6
  13. package/.server/server/plugins/engine/components/DatePartsField.js +27 -9
  14. package/.server/server/plugins/engine/components/DatePartsField.js.map +1 -1
  15. package/.server/server/plugins/engine/components/DeclarationField.d.ts +13 -11
  16. package/.server/server/plugins/engine/components/DeclarationField.js +31 -9
  17. package/.server/server/plugins/engine/components/DeclarationField.js.map +1 -1
  18. package/.server/server/plugins/engine/components/EastingNorthingField.d.ts +6 -5
  19. package/.server/server/plugins/engine/components/EastingNorthingField.js +42 -22
  20. package/.server/server/plugins/engine/components/EastingNorthingField.js.map +1 -1
  21. package/.server/server/plugins/engine/components/EmailAddressField.d.ts +11 -14
  22. package/.server/server/plugins/engine/components/EmailAddressField.js +2 -2
  23. package/.server/server/plugins/engine/components/EmailAddressField.js.map +1 -1
  24. package/.server/server/plugins/engine/components/FileUploadField.d.ts +14 -12
  25. package/.server/server/plugins/engine/components/FileUploadField.js +22 -12
  26. package/.server/server/plugins/engine/components/FileUploadField.js.map +1 -1
  27. package/.server/server/plugins/engine/components/FormComponent.d.ts +21 -12
  28. package/.server/server/plugins/engine/components/FormComponent.js +33 -14
  29. package/.server/server/plugins/engine/components/FormComponent.js.map +1 -1
  30. package/.server/server/plugins/engine/components/GeospatialField.d.ts +14 -12
  31. package/.server/server/plugins/engine/components/GeospatialField.js +19 -13
  32. package/.server/server/plugins/engine/components/GeospatialField.js.map +1 -1
  33. package/.server/server/plugins/engine/components/LatLongField.d.ts +6 -5
  34. package/.server/server/plugins/engine/components/LatLongField.js +32 -20
  35. package/.server/server/plugins/engine/components/LatLongField.js.map +1 -1
  36. package/.server/server/plugins/engine/components/ListFormComponent.d.ts +7 -6
  37. package/.server/server/plugins/engine/components/ListFormComponent.js +19 -7
  38. package/.server/server/plugins/engine/components/ListFormComponent.js.map +1 -1
  39. package/.server/server/plugins/engine/components/LocationFieldBase.d.ts +17 -16
  40. package/.server/server/plugins/engine/components/LocationFieldBase.js +2 -2
  41. package/.server/server/plugins/engine/components/LocationFieldBase.js.map +1 -1
  42. package/.server/server/plugins/engine/components/LocationFieldHelpers.d.ts +3 -3
  43. package/.server/server/plugins/engine/components/LocationFieldHelpers.js +2 -2
  44. package/.server/server/plugins/engine/components/LocationFieldHelpers.js.map +1 -1
  45. package/.server/server/plugins/engine/components/Markdown.d.ts +8 -7
  46. package/.server/server/plugins/engine/components/Markdown.js +5 -2
  47. package/.server/server/plugins/engine/components/Markdown.js.map +1 -1
  48. package/.server/server/plugins/engine/components/MonthYearField.d.ts +9 -7
  49. package/.server/server/plugins/engine/components/MonthYearField.js +26 -8
  50. package/.server/server/plugins/engine/components/MonthYearField.js.map +1 -1
  51. package/.server/server/plugins/engine/components/MultilineTextField.d.ts +10 -9
  52. package/.server/server/plugins/engine/components/MultilineTextField.js +2 -2
  53. package/.server/server/plugins/engine/components/MultilineTextField.js.map +1 -1
  54. package/.server/server/plugins/engine/components/NationalGridFieldNumberField.d.ts +2 -1
  55. package/.server/server/plugins/engine/components/NationalGridFieldNumberField.js +14 -6
  56. package/.server/server/plugins/engine/components/NationalGridFieldNumberField.js.map +1 -1
  57. package/.server/server/plugins/engine/components/NumberField.d.ts +10 -9
  58. package/.server/server/plugins/engine/components/NumberField.js +2 -2
  59. package/.server/server/plugins/engine/components/NumberField.js.map +1 -1
  60. package/.server/server/plugins/engine/components/OsGridRefField.d.ts +2 -1
  61. package/.server/server/plugins/engine/components/OsGridRefField.js +14 -6
  62. package/.server/server/plugins/engine/components/OsGridRefField.js.map +1 -1
  63. package/.server/server/plugins/engine/components/PaymentField.d.ts +12 -10
  64. package/.server/server/plugins/engine/components/PaymentField.js +21 -8
  65. package/.server/server/plugins/engine/components/PaymentField.js.map +1 -1
  66. package/.server/server/plugins/engine/components/SelectField.d.ts +11 -11
  67. package/.server/server/plugins/engine/components/SelectField.js +2 -2
  68. package/.server/server/plugins/engine/components/SelectField.js.map +1 -1
  69. package/.server/server/plugins/engine/components/SelectionControlField.d.ts +4 -4
  70. package/.server/server/plugins/engine/components/SelectionControlField.js +2 -2
  71. package/.server/server/plugins/engine/components/SelectionControlField.js.map +1 -1
  72. package/.server/server/plugins/engine/components/TelephoneNumberField.d.ts +10 -9
  73. package/.server/server/plugins/engine/components/TelephoneNumberField.js +2 -2
  74. package/.server/server/plugins/engine/components/TelephoneNumberField.js.map +1 -1
  75. package/.server/server/plugins/engine/components/UkAddressField.d.ts +12 -10
  76. package/.server/server/plugins/engine/components/UkAddressField.js +29 -17
  77. package/.server/server/plugins/engine/components/UkAddressField.js.map +1 -1
  78. package/.server/server/plugins/engine/components/YesNoField.d.ts +3 -0
  79. package/.server/server/plugins/engine/components/YesNoField.js +9 -0
  80. package/.server/server/plugins/engine/components/YesNoField.js.map +1 -1
  81. package/.server/server/plugins/engine/components/helpers/components.d.ts +3 -2
  82. package/.server/server/plugins/engine/components/helpers/components.js +11 -8
  83. package/.server/server/plugins/engine/components/helpers/components.js.map +1 -1
  84. package/.server/server/plugins/engine/components/types.d.ts +8 -1
  85. package/.server/server/plugins/engine/components/types.js.map +1 -1
  86. package/.server/server/plugins/engine/configureEnginePlugin.js +8 -1
  87. package/.server/server/plugins/engine/configureEnginePlugin.js.map +1 -1
  88. package/.server/server/plugins/engine/form-context.d.ts +1 -0
  89. package/.server/server/plugins/engine/form-context.js +4 -2
  90. package/.server/server/plugins/engine/form-context.js.map +1 -1
  91. package/.server/server/plugins/engine/helpers.d.ts +1 -1
  92. package/.server/server/plugins/engine/helpers.js +8 -13
  93. package/.server/server/plugins/engine/helpers.js.map +1 -1
  94. package/.server/server/plugins/engine/i18n/buildValidationMessages.d.ts +39 -0
  95. package/.server/server/plugins/engine/i18n/buildValidationMessages.js +50 -0
  96. package/.server/server/plugins/engine/i18n/buildValidationMessages.js.map +1 -0
  97. package/.server/server/plugins/engine/i18n/createFormTranslator.d.ts +5 -0
  98. package/.server/server/plugins/engine/i18n/createFormTranslator.js +18 -0
  99. package/.server/server/plugins/engine/i18n/createFormTranslator.js.map +1 -0
  100. package/.server/server/plugins/engine/i18n/createTranslator.d.ts +9 -0
  101. package/.server/server/plugins/engine/i18n/createTranslator.js +51 -0
  102. package/.server/server/plugins/engine/i18n/createTranslator.js.map +1 -0
  103. package/.server/server/plugins/engine/i18n/extractBaseTranslations.d.ts +5 -0
  104. package/.server/server/plugins/engine/i18n/extractBaseTranslations.js +57 -0
  105. package/.server/server/plugins/engine/i18n/extractBaseTranslations.js.map +1 -0
  106. package/.server/server/plugins/engine/i18n/index.d.ts +18 -0
  107. package/.server/server/plugins/engine/i18n/index.js +71 -0
  108. package/.server/server/plugins/engine/i18n/index.js.map +1 -0
  109. package/.server/server/plugins/engine/i18n/translations/cy.json +271 -0
  110. package/.server/server/plugins/engine/i18n/translations/en-GB.json +271 -0
  111. package/.server/server/plugins/engine/i18n/types.d.ts +41 -0
  112. package/.server/server/plugins/engine/i18n/types.js +2 -0
  113. package/.server/server/plugins/engine/i18n/types.js.map +1 -0
  114. package/.server/server/plugins/engine/index.js +3 -2
  115. package/.server/server/plugins/engine/index.js.map +1 -1
  116. package/.server/server/plugins/engine/models/FormModel.d.ts +9 -1
  117. package/.server/server/plugins/engine/models/FormModel.js +44 -18
  118. package/.server/server/plugins/engine/models/FormModel.js.map +1 -1
  119. package/.server/server/plugins/engine/models/SummaryViewModel.d.ts +5 -2
  120. package/.server/server/plugins/engine/models/SummaryViewModel.js +44 -18
  121. package/.server/server/plugins/engine/models/SummaryViewModel.js.map +1 -1
  122. package/.server/server/plugins/engine/options.js +2 -1
  123. package/.server/server/plugins/engine/options.js.map +1 -1
  124. package/.server/server/plugins/engine/outputFormatters/adapter/v1.js +4 -0
  125. package/.server/server/plugins/engine/outputFormatters/adapter/v1.js.map +1 -1
  126. package/.server/server/plugins/engine/outputFormatters/human/v1.js +2 -1
  127. package/.server/server/plugins/engine/outputFormatters/human/v1.js.map +1 -1
  128. package/.server/server/plugins/engine/outputFormatters/machine/v1.js +7 -6
  129. package/.server/server/plugins/engine/outputFormatters/machine/v1.js.map +1 -1
  130. package/.server/server/plugins/engine/pageControllers/FileUploadPageController.d.ts +2 -1
  131. package/.server/server/plugins/engine/pageControllers/FileUploadPageController.js +6 -3
  132. package/.server/server/plugins/engine/pageControllers/FileUploadPageController.js.map +1 -1
  133. package/.server/server/plugins/engine/pageControllers/PageController.d.ts +3 -1
  134. package/.server/server/plugins/engine/pageControllers/PageController.js +11 -1
  135. package/.server/server/plugins/engine/pageControllers/PageController.js.map +1 -1
  136. package/.server/server/plugins/engine/pageControllers/QuestionPageController.d.ts +4 -2
  137. package/.server/server/plugins/engine/pageControllers/QuestionPageController.js +52 -21
  138. package/.server/server/plugins/engine/pageControllers/QuestionPageController.js.map +1 -1
  139. package/.server/server/plugins/engine/pageControllers/RepeatPageController.d.ts +3 -2
  140. package/.server/server/plugins/engine/pageControllers/RepeatPageController.js +63 -26
  141. package/.server/server/plugins/engine/pageControllers/RepeatPageController.js.map +1 -1
  142. package/.server/server/plugins/engine/pageControllers/StartPageController.d.ts +3 -1
  143. package/.server/server/plugins/engine/pageControllers/StartPageController.js +2 -2
  144. package/.server/server/plugins/engine/pageControllers/StartPageController.js.map +1 -1
  145. package/.server/server/plugins/engine/pageControllers/StatusPageController.js +12 -2
  146. package/.server/server/plugins/engine/pageControllers/StatusPageController.js.map +1 -1
  147. package/.server/server/plugins/engine/pageControllers/SummaryPageController.d.ts +4 -3
  148. package/.server/server/plugins/engine/pageControllers/SummaryPageController.js +45 -28
  149. package/.server/server/plugins/engine/pageControllers/SummaryPageController.js.map +1 -1
  150. package/.server/server/plugins/engine/pageControllers/__stubs__/translator.d.ts +2 -0
  151. package/.server/server/plugins/engine/pageControllers/__stubs__/translator.js +24 -0
  152. package/.server/server/plugins/engine/pageControllers/__stubs__/translator.js.map +1 -0
  153. package/.server/server/plugins/engine/pageControllers/errors.d.ts +1 -1
  154. package/.server/server/plugins/engine/pageControllers/errors.js +3 -2
  155. package/.server/server/plugins/engine/pageControllers/errors.js.map +1 -1
  156. package/.server/server/plugins/engine/pageControllers/helpers/submission.d.ts +3 -2
  157. package/.server/server/plugins/engine/pageControllers/helpers/submission.js +4 -4
  158. package/.server/server/plugins/engine/pageControllers/helpers/submission.js.map +1 -1
  159. package/.server/server/plugins/engine/pageControllers/validationOptions.d.ts +7 -3
  160. package/.server/server/plugins/engine/pageControllers/validationOptions.js +34 -33
  161. package/.server/server/plugins/engine/pageControllers/validationOptions.js.map +1 -1
  162. package/.server/server/plugins/engine/plugin.js +2 -0
  163. package/.server/server/plugins/engine/plugin.js.map +1 -1
  164. package/.server/server/plugins/engine/routes/index.js +4 -1
  165. package/.server/server/plugins/engine/routes/index.js.map +1 -1
  166. package/.server/server/plugins/engine/routes/questions.js +5 -2
  167. package/.server/server/plugins/engine/routes/questions.js.map +1 -1
  168. package/.server/server/plugins/engine/types/index.d.ts +1 -0
  169. package/.server/server/plugins/engine/types/index.js.map +1 -1
  170. package/.server/server/plugins/engine/types/schema.js +1 -0
  171. package/.server/server/plugins/engine/types/schema.js.map +1 -1
  172. package/.server/server/plugins/engine/types.d.ts +12 -1
  173. package/.server/server/plugins/engine/types.js.map +1 -1
  174. package/.server/server/plugins/engine/views/components/_location-field-base.html +1 -1
  175. package/.server/server/plugins/engine/views/components/fileuploadfield.html +3 -3
  176. package/.server/server/plugins/engine/views/components/nationalgridfieldnumberfield.html +1 -1
  177. package/.server/server/plugins/engine/views/components/osgridreffield.html +1 -1
  178. package/.server/server/plugins/engine/views/components/paymentfield.html +8 -8
  179. package/.server/server/plugins/engine/views/components/ukaddressfield.html +4 -4
  180. package/.server/server/plugins/engine/views/confirmation.html +4 -4
  181. package/.server/server/plugins/engine/views/exit.html +4 -4
  182. package/.server/server/plugins/engine/views/file-upload.html +3 -3
  183. package/.server/server/plugins/engine/views/index.html +3 -3
  184. package/.server/server/plugins/engine/views/item-delete.html +1 -1
  185. package/.server/server/plugins/engine/views/partials/form.html +3 -3
  186. package/.server/server/plugins/engine/views/partials/preview-banner.html +4 -4
  187. package/.server/server/plugins/engine/views/partials/warn-missing-notification-email.html +4 -5
  188. package/.server/server/plugins/engine/views/repeat-list-summary.html +4 -4
  189. package/.server/server/plugins/engine/views/summary.html +14 -7
  190. package/.server/server/plugins/nunjucks/enviroment.test.js +10 -0
  191. package/.server/server/plugins/nunjucks/enviroment.test.js.map +1 -1
  192. package/.server/server/plugins/nunjucks/environment.d.ts +8 -0
  193. package/.server/server/plugins/nunjucks/environment.js +13 -0
  194. package/.server/server/plugins/nunjucks/environment.js.map +1 -1
  195. package/.server/server/plugins/nunjucks/filters/answer.js +9 -1
  196. package/.server/server/plugins/nunjucks/filters/answer.js.map +1 -1
  197. package/.server/server/plugins/nunjucks/filters/answer.test.js +13 -2
  198. package/.server/server/plugins/nunjucks/filters/answer.test.js.map +1 -1
  199. package/.server/server/plugins/nunjucks/filters/field.d.ts +1 -1
  200. package/.server/server/plugins/postcode-lookup/models/index.d.ts +24 -19
  201. package/.server/server/plugins/postcode-lookup/models/index.js +83 -76
  202. package/.server/server/plugins/postcode-lookup/models/index.js.map +1 -1
  203. package/.server/server/plugins/postcode-lookup/routes/index.js +7 -13
  204. package/.server/server/plugins/postcode-lookup/routes/index.js.map +1 -1
  205. package/.server/server/plugins/postcode-lookup/types.d.ts +1 -0
  206. package/.server/server/plugins/postcode-lookup/types.js +1 -0
  207. package/.server/server/plugins/postcode-lookup/types.js.map +1 -1
  208. package/.server/server/plugins/postcode-lookup/views/postcode-lookup-details.html +3 -3
  209. package/.server/server/types.d.ts +2 -1
  210. package/.server/server/types.js.map +1 -1
  211. package/.server/server/utils/utils.d.ts +5 -0
  212. package/.server/server/utils/utils.js +16 -0
  213. package/.server/server/utils/utils.js.map +1 -1
  214. package/.server/typings/hapi/index.d.js.map +1 -1
  215. package/package.json +3 -2
  216. package/src/server/forms/register-as-a-unicorn-breeder.yaml +0 -14
  217. package/src/server/forms/simple-form.yaml +106 -3
  218. package/src/server/plugins/engine/components/AutocompleteField.ts +3 -6
  219. package/src/server/plugins/engine/components/CheckboxesField.ts +12 -11
  220. package/src/server/plugins/engine/components/ComponentCollection.ts +143 -61
  221. package/src/server/plugins/engine/components/DatePartsField.ts +33 -11
  222. package/src/server/plugins/engine/components/DeclarationField.ts +37 -14
  223. package/src/server/plugins/engine/components/EastingNorthingField.ts +83 -22
  224. package/src/server/plugins/engine/components/EmailAddressField.ts +4 -7
  225. package/src/server/plugins/engine/components/FileUploadField.ts +28 -22
  226. package/src/server/plugins/engine/components/FormComponent.ts +49 -12
  227. package/src/server/plugins/engine/components/GeospatialField.ts +36 -21
  228. package/src/server/plugins/engine/components/LatLongField.ts +52 -21
  229. package/src/server/plugins/engine/components/ListFormComponent.ts +26 -10
  230. package/src/server/plugins/engine/components/LocationFieldBase.ts +5 -8
  231. package/src/server/plugins/engine/components/LocationFieldHelpers.ts +3 -3
  232. package/src/server/plugins/engine/components/Markdown.ts +7 -3
  233. package/src/server/plugins/engine/components/MonthYearField.ts +32 -10
  234. package/src/server/plugins/engine/components/MultilineTextField.ts +5 -8
  235. package/src/server/plugins/engine/components/NationalGridFieldNumberField.ts +25 -11
  236. package/src/server/plugins/engine/components/NumberField.ts +3 -4
  237. package/src/server/plugins/engine/components/OsGridRefField.ts +25 -9
  238. package/src/server/plugins/engine/components/PaymentField.ts +22 -12
  239. package/src/server/plugins/engine/components/SelectField.ts +3 -6
  240. package/src/server/plugins/engine/components/SelectionControlField.ts +7 -8
  241. package/src/server/plugins/engine/components/TelephoneNumberField.ts +4 -7
  242. package/src/server/plugins/engine/components/UkAddressField.ts +33 -18
  243. package/src/server/plugins/engine/components/YesNoField.ts +10 -0
  244. package/src/server/plugins/engine/components/helpers/components.ts +13 -6
  245. package/src/server/plugins/engine/components/types.ts +9 -0
  246. package/src/server/plugins/engine/configureEnginePlugin.ts +12 -1
  247. package/src/server/plugins/engine/form-context.ts +8 -2
  248. package/src/server/plugins/engine/helpers.ts +10 -18
  249. package/src/server/plugins/engine/i18n/buildValidationMessages.ts +69 -0
  250. package/src/server/plugins/engine/i18n/createFormTranslator.ts +33 -0
  251. package/src/server/plugins/engine/i18n/createTranslator.ts +61 -0
  252. package/src/server/plugins/engine/i18n/extractBaseTranslations.ts +61 -0
  253. package/src/server/plugins/engine/i18n/index.ts +80 -0
  254. package/src/server/plugins/engine/i18n/translations/cy.json +271 -0
  255. package/src/server/plugins/engine/i18n/translations/en-GB.json +271 -0
  256. package/src/server/plugins/engine/i18n/types.ts +62 -0
  257. package/src/server/plugins/engine/index.ts +4 -2
  258. package/src/server/plugins/engine/models/FormModel.ts +59 -23
  259. package/src/server/plugins/engine/models/SummaryViewModel.ts +68 -25
  260. package/src/server/plugins/engine/options.js +2 -1
  261. package/src/server/plugins/engine/outputFormatters/adapter/v1.ts +5 -0
  262. package/src/server/plugins/engine/outputFormatters/human/v1.ts +2 -3
  263. package/src/server/plugins/engine/outputFormatters/machine/v1.ts +9 -8
  264. package/src/server/plugins/engine/pageControllers/FileUploadPageController.ts +7 -3
  265. package/src/server/plugins/engine/pageControllers/PageController.ts +12 -1
  266. package/src/server/plugins/engine/pageControllers/QuestionPageController.ts +53 -21
  267. package/src/server/plugins/engine/pageControllers/RepeatPageController.ts +66 -29
  268. package/src/server/plugins/engine/pageControllers/StartPageController.ts +7 -2
  269. package/src/server/plugins/engine/pageControllers/StatusPageController.ts +10 -2
  270. package/src/server/plugins/engine/pageControllers/SummaryPageController.ts +53 -24
  271. package/src/server/plugins/engine/pageControllers/__stubs__/translator.ts +28 -0
  272. package/src/server/plugins/engine/pageControllers/errors.ts +4 -2
  273. package/src/server/plugins/engine/pageControllers/helpers/submission.ts +11 -4
  274. package/src/server/plugins/engine/pageControllers/validationOptions.ts +43 -53
  275. package/src/server/plugins/engine/plugin.ts +2 -0
  276. package/src/server/plugins/engine/routes/index.ts +9 -1
  277. package/src/server/plugins/engine/routes/questions.ts +5 -1
  278. package/src/server/plugins/engine/types/index.ts +5 -0
  279. package/src/server/plugins/engine/types/schema.ts +1 -0
  280. package/src/server/plugins/engine/types.ts +10 -0
  281. package/src/server/plugins/engine/views/components/_location-field-base.html +1 -1
  282. package/src/server/plugins/engine/views/components/fileuploadfield.html +3 -3
  283. package/src/server/plugins/engine/views/components/nationalgridfieldnumberfield.html +1 -1
  284. package/src/server/plugins/engine/views/components/osgridreffield.html +1 -1
  285. package/src/server/plugins/engine/views/components/paymentfield.html +8 -8
  286. package/src/server/plugins/engine/views/components/ukaddressfield.html +4 -4
  287. package/src/server/plugins/engine/views/confirmation.html +4 -4
  288. package/src/server/plugins/engine/views/exit.html +4 -4
  289. package/src/server/plugins/engine/views/file-upload.html +3 -3
  290. package/src/server/plugins/engine/views/index.html +3 -3
  291. package/src/server/plugins/engine/views/item-delete.html +1 -1
  292. package/src/server/plugins/engine/views/partials/form.html +3 -3
  293. package/src/server/plugins/engine/views/partials/preview-banner.html +4 -4
  294. package/src/server/plugins/engine/views/partials/warn-missing-notification-email.html +4 -5
  295. package/src/server/plugins/engine/views/repeat-list-summary.html +4 -4
  296. package/src/server/plugins/engine/views/summary.html +14 -7
  297. package/src/server/plugins/nunjucks/environment.js +14 -0
  298. package/src/server/plugins/nunjucks/filters/answer.js +12 -1
  299. package/src/server/plugins/postcode-lookup/models/index.js +144 -87
  300. package/src/server/plugins/postcode-lookup/routes/index.js +13 -16
  301. package/src/server/plugins/postcode-lookup/types.js +1 -0
  302. package/src/server/plugins/postcode-lookup/views/postcode-lookup-details.html +3 -3
  303. package/src/server/types.ts +2 -0
  304. package/src/server/utils/utils.js +14 -0
  305. package/src/typings/hapi/index.d.ts +1 -0
  306. package/.server/server/plugins/engine/components/constants.d.ts +0 -1
  307. package/.server/server/plugins/engine/components/constants.js +0 -2
  308. package/.server/server/plugins/engine/components/constants.js.map +0 -1
  309. package/src/server/plugins/engine/components/constants.ts +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"form-context.js","names":["Boom","isEqual","PREVIEW_PATH_PREFIX","assertFormAvailable","checkEmailAddressForLiveFormSubmission","getCacheService","FormModel","TerminalPageController","defaultServices","FormStatus","getFormModel","slug","state","options","services","formsService","isPreview","isPreviewState","formState","resolveState","metadata","getFormMetadata","definition","getFormDefinition","id","notFound","basePath","buildBasePath","routePrefix","ordnanceSurveyApiKey","formId","controllers","getFormContext","server","yar","Live","formModel","resolveFormModel","cacheService","summaryRequest","app","method","params","path","query","url","URL","cachedState","getState","$$__referenceNumber","errors","stateMetadata","models","Map","cache","cacheKey","entry","get","updatedAt","notificationEmail","realm","modifiers","route","prefix","model","set","base","replace","startsWith","slice","getFirstJourneyPage","context","relevantPages","undefined","lastPageReached","at","penultimatePageReached"],"sources":["../../../../src/server/plugins/engine/form-context.ts"],"sourcesContent":["import Boom from '@hapi/boom'\nimport { type Request, type Server } from '@hapi/hapi'\nimport { isEqual } from 'date-fns'\n\nimport { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'\nimport { assertFormAvailable } from '~/src/server/plugins/engine/form-availability.js'\nimport {\n checkEmailAddressForLiveFormSubmission,\n getCacheService\n} from '~/src/server/plugins/engine/helpers.js'\nimport { FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { TerminalPageController } from '~/src/server/plugins/engine/pageControllers/index.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport {\n type AnyRequest,\n type FormContext,\n type FormContextRequest,\n type FormSubmissionError,\n type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { FormStatus } from '~/src/server/routes/types.js'\nimport { type Services } from '~/src/server/types.js'\n\ntype JourneyState = FormStatus | 'preview'\n\nexport interface FormModelOptions {\n services?: Services\n controllers?: Record<string, typeof PageController>\n basePath?: string\n ordnanceSurveyApiKey?: string\n formId?: string\n routePrefix?: string\n isPreview?: boolean\n}\n\nexport interface FormContextOptions extends FormModelOptions {\n errors?: FormSubmissionError[]\n}\n\ntype SummaryRequest = FormContextRequest & {\n yar: Request['yar']\n}\n\nexport async function getFormModel(\n slug: string,\n state: JourneyState,\n options: FormModelOptions = {}\n) {\n const services = options.services ?? defaultServices\n const { formsService } = services\n const isPreview = isPreviewState(state, options)\n const formState = resolveState(state)\n\n const metadata = await formsService.getFormMetadata(slug)\n assertFormAvailable(metadata, formState, isPreview)\n\n const definition = await formsService.getFormDefinition(\n metadata.id,\n formState\n )\n\n if (!definition) {\n throw Boom.notFound(\n `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n )\n }\n\n return new FormModel(\n definition,\n {\n basePath:\n options.basePath ??\n buildBasePath(options.routePrefix ?? '', slug, formState, isPreview),\n ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n formId: options.formId ?? metadata.id\n },\n services,\n options.controllers\n )\n}\n\nexport async function getFormContext(\n { server, yar }: Pick<Request, 'server' | 'yar'>,\n slug: string,\n state: JourneyState = FormStatus.Live,\n options: FormContextOptions = {}\n): Promise<FormContext> {\n const formModel = await resolveFormModel(server, slug, state, options)\n\n const cacheService = getCacheService(server)\n\n const summaryRequest: SummaryRequest = {\n app: {},\n method: 'get',\n params: {\n path: 'summary',\n slug,\n ...(isPreviewState(state, options) && {\n state: resolveState(state)\n })\n },\n path: `/${formModel.basePath}/summary`,\n query: {},\n url: new URL(\n `/${formModel.basePath}/summary`,\n 'https://form-context.local'\n ),\n server,\n yar\n }\n\n const cachedState = await cacheService.getState(\n summaryRequest as unknown as AnyRequest\n )\n\n const formState = {\n ...cachedState,\n $$__referenceNumber: cachedState.$$__referenceNumber\n } as unknown as FormSubmissionState\n\n return formModel.getFormContext(\n summaryRequest,\n formState,\n options.errors ?? []\n )\n}\n\nexport async function resolveFormModel(\n server: Server,\n slug: string,\n state: JourneyState,\n options: FormModelOptions = {}\n) {\n const services = options.services ?? defaultServices\n const { formsService } = services\n\n const metadata = await formsService.getFormMetadata(slug)\n const formState = resolveState(state)\n const isPreview = options.isPreview ?? isPreviewState(state, options)\n assertFormAvailable(metadata, formState, isPreview)\n const stateMetadata = metadata[formState]\n\n if (!stateMetadata) {\n throw Boom.notFound(\n `No '${formState}' state for form metadata ${metadata.id}`\n )\n }\n\n // The models cache is created lazily per server instance\n\n server.app.models ??= new Map<string, { model: FormModel; updatedAt: Date }>()\n\n const cache = server.app.models\n\n const cacheKey = `${metadata.id}_${formState}_${isPreview}`\n let entry = cache.get(cacheKey)\n\n if (!entry || !isEqual(entry.updatedAt, stateMetadata.updatedAt)) {\n const definition = await formsService.getFormDefinition(\n metadata.id,\n formState\n )\n\n if (!definition) {\n throw Boom.notFound(\n `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n )\n }\n\n checkEmailAddressForLiveFormSubmission(\n metadata.notificationEmail,\n isPreview\n )\n\n const routePrefix =\n options.routePrefix ?? server.realm.modifiers.route.prefix\n\n const model = new FormModel(\n definition,\n {\n basePath:\n options.basePath ??\n buildBasePath(routePrefix, slug, formState, isPreview),\n ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n formId: options.formId ?? metadata.id\n },\n services,\n options.controllers\n )\n\n entry = { model, updatedAt: stateMetadata.updatedAt }\n cache.set(cacheKey, entry)\n }\n\n return entry.model\n}\n\nfunction buildBasePath(\n routePrefix: string,\n slug: string,\n state: FormStatus,\n isPreview: boolean\n) {\n const base = (\n isPreview\n ? `${routePrefix}${PREVIEW_PATH_PREFIX}/${state}/${slug}`\n : `${routePrefix}/${slug}`\n ).replace(/\\/{2,}/g, '/')\n\n return base.startsWith('/') ? base.slice(1) : base\n}\n\nexport function getFirstJourneyPage(\n context?: Pick<FormContext, 'relevantPages'>\n) {\n if (!context?.relevantPages) {\n return undefined\n }\n\n const lastPageReached = context.relevantPages.at(-1)\n const penultimatePageReached = context.relevantPages.at(-2)\n\n if (\n lastPageReached instanceof TerminalPageController &&\n penultimatePageReached\n ) {\n return penultimatePageReached\n }\n\n return lastPageReached\n}\n\nfunction resolveState(state: JourneyState): FormStatus {\n return state === 'preview' ? FormStatus.Live : state\n}\n\nfunction isPreviewState(\n state: JourneyState,\n options: FormModelOptions = {}\n): boolean {\n return options.isPreview ?? state === 'preview'\n}\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAE7B,SAASC,OAAO,QAAQ,UAAU;AAElC,SAASC,mBAAmB;AAC5B,SAASC,mBAAmB;AAC5B,SACEC,sCAAsC,EACtCC,eAAe;AAEjB,SAASC,SAAS;AAElB,SAASC,sBAAsB;AAC/B,OAAO,KAAKC,eAAe;AAQ3B,SAASC,UAAU;AAuBnB,OAAO,eAAeC,YAAYA,CAChCC,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIN,eAAe;EACpD,MAAM;IAAEO;EAAa,CAAC,GAAGD,QAAQ;EACjC,MAAME,SAAS,GAAGC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EAChD,MAAMK,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EAErC,MAAMQ,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EACzDR,mBAAmB,CAACiB,QAAQ,EAAEF,SAAS,EAAEF,SAAS,CAAC;EAEnD,MAAMM,UAAU,GAAG,MAAMP,YAAY,CAACQ,iBAAiB,CACrDH,QAAQ,CAACI,EAAE,EACXN,SACF,CAAC;EAED,IAAI,CAACI,UAAU,EAAE;IACf,MAAMtB,IAAI,CAACyB,QAAQ,CACjB,yCAAyCL,QAAQ,CAACI,EAAE,KAAKb,IAAI,KAAKC,KAAK,EACzE,CAAC;EACH;EAEA,OAAO,IAAIN,SAAS,CAClBgB,UAAU,EACV;IACEI,QAAQ,EACNb,OAAO,CAACa,QAAQ,IAChBC,aAAa,CAACd,OAAO,CAACe,WAAW,IAAI,EAAE,EAAEjB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;IACtEa,oBAAoB,EAAEhB,OAAO,CAACgB,oBAAoB;IAClDC,MAAM,EAAEjB,OAAO,CAACiB,MAAM,IAAIV,QAAQ,CAACI;EACrC,CAAC,EACDV,QAAQ,EACRD,OAAO,CAACkB,WACV,CAAC;AACH;AAEA,OAAO,eAAeC,cAAcA,CAClC;EAAEC,MAAM;EAAEC;AAAqC,CAAC,EAChDvB,IAAY,EACZC,KAAmB,GAAGH,UAAU,CAAC0B,IAAI,EACrCtB,OAA2B,GAAG,CAAC,CAAC,EACV;EACtB,MAAMuB,SAAS,GAAG,MAAMC,gBAAgB,CAACJ,MAAM,EAAEtB,IAAI,EAAEC,KAAK,EAAEC,OAAO,CAAC;EAEtE,MAAMyB,YAAY,GAAGjC,eAAe,CAAC4B,MAAM,CAAC;EAE5C,MAAMM,cAA8B,GAAG;IACrCC,GAAG,EAAE,CAAC,CAAC;IACPC,MAAM,EAAE,KAAK;IACbC,MAAM,EAAE;MACNC,IAAI,EAAE,SAAS;MACfhC,IAAI;MACJ,IAAIM,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC,IAAI;QACpCD,KAAK,EAAEO,YAAY,CAACP,KAAK;MAC3B,CAAC;IACH,CAAC;IACD+B,IAAI,EAAE,IAAIP,SAAS,CAACV,QAAQ,UAAU;IACtCkB,KAAK,EAAE,CAAC,CAAC;IACTC,GAAG,EAAE,IAAIC,GAAG,CACV,IAAIV,SAAS,CAACV,QAAQ,UAAU,EAChC,4BACF,CAAC;IACDO,MAAM;IACNC;EACF,CAAC;EAED,MAAMa,WAAW,GAAG,MAAMT,YAAY,CAACU,QAAQ,CAC7CT,cACF,CAAC;EAED,MAAMrB,SAAS,GAAG;IAChB,GAAG6B,WAAW;IACdE,mBAAmB,EAAEF,WAAW,CAACE;EACnC,CAAmC;EAEnC,OAAOb,SAAS,CAACJ,cAAc,CAC7BO,cAAc,EACdrB,SAAS,EACTL,OAAO,CAACqC,MAAM,IAAI,EACpB,CAAC;AACH;AAEA,OAAO,eAAeb,gBAAgBA,CACpCJ,MAAc,EACdtB,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIN,eAAe;EACpD,MAAM;IAAEO;EAAa,CAAC,GAAGD,QAAQ;EAEjC,MAAMM,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EACzD,MAAMO,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EACrC,MAAMI,SAAS,GAAGH,OAAO,CAACG,SAAS,IAAIC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EACrEV,mBAAmB,CAACiB,QAAQ,EAAEF,SAAS,EAAEF,SAAS,CAAC;EACnD,MAAMmC,aAAa,GAAG/B,QAAQ,CAACF,SAAS,CAAC;EAEzC,IAAI,CAACiC,aAAa,EAAE;IAClB,MAAMnD,IAAI,CAACyB,QAAQ,CACjB,OAAOP,SAAS,6BAA6BE,QAAQ,CAACI,EAAE,EAC1D,CAAC;EACH;;EAEA;;EAEAS,MAAM,CAACO,GAAG,CAACY,MAAM,KAAK,IAAIC,GAAG,CAAgD,CAAC;EAE9E,MAAMC,KAAK,GAAGrB,MAAM,CAACO,GAAG,CAACY,MAAM;EAE/B,MAAMG,QAAQ,GAAG,GAAGnC,QAAQ,CAACI,EAAE,IAAIN,SAAS,IAAIF,SAAS,EAAE;EAC3D,IAAIwC,KAAK,GAAGF,KAAK,CAACG,GAAG,CAACF,QAAQ,CAAC;EAE/B,IAAI,CAACC,KAAK,IAAI,CAACvD,OAAO,CAACuD,KAAK,CAACE,SAAS,EAAEP,aAAa,CAACO,SAAS,CAAC,EAAE;IAChE,MAAMpC,UAAU,GAAG,MAAMP,YAAY,CAACQ,iBAAiB,CACrDH,QAAQ,CAACI,EAAE,EACXN,SACF,CAAC;IAED,IAAI,CAACI,UAAU,EAAE;MACf,MAAMtB,IAAI,CAACyB,QAAQ,CACjB,yCAAyCL,QAAQ,CAACI,EAAE,KAAKb,IAAI,KAAKC,KAAK,EACzE,CAAC;IACH;IAEAR,sCAAsC,CACpCgB,QAAQ,CAACuC,iBAAiB,EAC1B3C,SACF,CAAC;IAED,MAAMY,WAAW,GACff,OAAO,CAACe,WAAW,IAAIK,MAAM,CAAC2B,KAAK,CAACC,SAAS,CAACC,KAAK,CAACC,MAAM;IAE5D,MAAMC,KAAK,GAAG,IAAI1D,SAAS,CACzBgB,UAAU,EACV;MACEI,QAAQ,EACNb,OAAO,CAACa,QAAQ,IAChBC,aAAa,CAACC,WAAW,EAAEjB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;MACxDa,oBAAoB,EAAEhB,OAAO,CAACgB,oBAAoB;MAClDC,MAAM,EAAEjB,OAAO,CAACiB,MAAM,IAAIV,QAAQ,CAACI;IACrC,CAAC,EACDV,QAAQ,EACRD,OAAO,CAACkB,WACV,CAAC;IAEDyB,KAAK,GAAG;MAAEQ,KAAK;MAAEN,SAAS,EAAEP,aAAa,CAACO;IAAU,CAAC;IACrDJ,KAAK,CAACW,GAAG,CAACV,QAAQ,EAAEC,KAAK,CAAC;EAC5B;EAEA,OAAOA,KAAK,CAACQ,KAAK;AACpB;AAEA,SAASrC,aAAaA,CACpBC,WAAmB,EACnBjB,IAAY,EACZC,KAAiB,EACjBI,SAAkB,EAClB;EACA,MAAMkD,IAAI,GAAG,CACXlD,SAAS,GACL,GAAGY,WAAW,GAAG1B,mBAAmB,IAAIU,KAAK,IAAID,IAAI,EAAE,GACvD,GAAGiB,WAAW,IAAIjB,IAAI,EAAE,EAC5BwD,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;EAEzB,OAAOD,IAAI,CAACE,UAAU,CAAC,GAAG,CAAC,GAAGF,IAAI,CAACG,KAAK,CAAC,CAAC,CAAC,GAAGH,IAAI;AACpD;AAEA,OAAO,SAASI,mBAAmBA,CACjCC,OAA4C,EAC5C;EACA,IAAI,CAACA,OAAO,EAAEC,aAAa,EAAE;IAC3B,OAAOC,SAAS;EAClB;EAEA,MAAMC,eAAe,GAAGH,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EACpD,MAAMC,sBAAsB,GAAGL,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EAE3D,IACED,eAAe,YAAYnE,sBAAsB,IACjDqE,sBAAsB,EACtB;IACA,OAAOA,sBAAsB;EAC/B;EAEA,OAAOF,eAAe;AACxB;AAEA,SAASvD,YAAYA,CAACP,KAAmB,EAAc;EACrD,OAAOA,KAAK,KAAK,SAAS,GAAGH,UAAU,CAAC0B,IAAI,GAAGvB,KAAK;AACtD;AAEA,SAASK,cAAcA,CACrBL,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EACrB;EACT,OAAOA,OAAO,CAACG,SAAS,IAAIJ,KAAK,KAAK,SAAS;AACjD","ignoreList":[]}
1
+ {"version":3,"file":"form-context.js","names":["Boom","isEqual","PREVIEW_PATH_PREFIX","assertFormAvailable","checkEmailAddressForLiveFormSubmission","getCacheService","FormModel","TerminalPageController","defaultServices","FormStatus","resolveLanguage","getFormModel","slug","state","options","services","formsService","isPreview","isPreviewState","formState","resolveState","metadata","getFormMetadata","definition","getFormDefinition","id","notFound","basePath","buildBasePath","routePrefix","ordnanceSurveyApiKey","formId","controllers","getFormContext","server","yar","Live","formModel","resolveFormModel","cacheService","summaryRequest","app","method","params","path","query","url","URL","cachedState","getState","$$__referenceNumber","language","translator","createTranslator","errors","stateMetadata","models","Map","cache","cacheKey","entry","get","updatedAt","notificationEmail","realm","modifiers","route","prefix","model","set","base","replace","startsWith","slice","getFirstJourneyPage","context","relevantPages","undefined","lastPageReached","at","penultimatePageReached"],"sources":["../../../../src/server/plugins/engine/form-context.ts"],"sourcesContent":["import Boom from '@hapi/boom'\nimport { type Request, type Server } from '@hapi/hapi'\nimport { isEqual } from 'date-fns'\n\nimport { PREVIEW_PATH_PREFIX } from '~/src/server/constants.js'\nimport { assertFormAvailable } from '~/src/server/plugins/engine/form-availability.js'\nimport {\n checkEmailAddressForLiveFormSubmission,\n getCacheService\n} from '~/src/server/plugins/engine/helpers.js'\nimport { FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { TerminalPageController } from '~/src/server/plugins/engine/pageControllers/index.js'\nimport * as defaultServices from '~/src/server/plugins/engine/services/index.js'\nimport {\n type AnyFormRequest,\n type AnyRequest,\n type FormContext,\n type FormContextRequest,\n type FormSubmissionError,\n type FormSubmissionState\n} from '~/src/server/plugins/engine/types.js'\nimport { FormStatus } from '~/src/server/routes/types.js'\nimport { type Services } from '~/src/server/types.js'\nimport { resolveLanguage } from '~/src/server/utils/utils.js'\n\ntype JourneyState = FormStatus | 'preview'\n\nexport interface FormModelOptions {\n services?: Services\n controllers?: Record<string, typeof PageController>\n basePath?: string\n ordnanceSurveyApiKey?: string\n formId?: string\n routePrefix?: string\n isPreview?: boolean\n}\n\nexport interface FormContextOptions extends FormModelOptions {\n errors?: FormSubmissionError[]\n language?: string\n}\n\ntype SummaryRequest = FormContextRequest & {\n yar: Request['yar']\n}\n\nexport async function getFormModel(\n slug: string,\n state: JourneyState,\n options: FormModelOptions = {}\n) {\n const services = options.services ?? defaultServices\n const { formsService } = services\n const isPreview = isPreviewState(state, options)\n const formState = resolveState(state)\n\n const metadata = await formsService.getFormMetadata(slug)\n assertFormAvailable(metadata, formState, isPreview)\n\n const definition = await formsService.getFormDefinition(\n metadata.id,\n formState\n )\n\n if (!definition) {\n throw Boom.notFound(\n `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n )\n }\n\n return new FormModel(\n definition,\n {\n basePath:\n options.basePath ??\n buildBasePath(options.routePrefix ?? '', slug, formState, isPreview),\n ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n formId: options.formId ?? metadata.id\n },\n services,\n options.controllers\n )\n}\n\nexport async function getFormContext(\n { server, yar }: Pick<Request, 'server' | 'yar'>,\n slug: string,\n state: JourneyState = FormStatus.Live,\n options: FormContextOptions = {}\n): Promise<FormContext> {\n const formModel = await resolveFormModel(server, slug, state, options)\n\n const cacheService = getCacheService(server)\n\n const summaryRequest: SummaryRequest = {\n app: {},\n method: 'get',\n params: {\n path: 'summary',\n slug,\n ...(isPreviewState(state, options) && {\n state: resolveState(state)\n })\n },\n path: `/${formModel.basePath}/summary`,\n query: {},\n url: new URL(\n `/${formModel.basePath}/summary`,\n 'https://form-context.local'\n ),\n server,\n yar\n }\n\n const cachedState = await cacheService.getState(\n summaryRequest as unknown as AnyRequest\n )\n\n const formState = {\n ...cachedState,\n $$__referenceNumber: cachedState.$$__referenceNumber\n } as unknown as FormSubmissionState\n\n const language = resolveLanguage(summaryRequest as unknown as AnyFormRequest)\n const translator = formModel.createTranslator(language)\n\n return formModel.getFormContext(\n summaryRequest,\n formState,\n options.errors ?? [],\n translator\n )\n}\n\nexport async function resolveFormModel(\n server: Server,\n slug: string,\n state: JourneyState,\n options: FormModelOptions = {}\n) {\n const services = options.services ?? defaultServices\n const { formsService } = services\n\n const metadata = await formsService.getFormMetadata(slug)\n const formState = resolveState(state)\n const isPreview = options.isPreview ?? isPreviewState(state, options)\n assertFormAvailable(metadata, formState, isPreview)\n const stateMetadata = metadata[formState]\n\n if (!stateMetadata) {\n throw Boom.notFound(\n `No '${formState}' state for form metadata ${metadata.id}`\n )\n }\n\n // The models cache is created lazily per server instance\n server.app.models ??= new Map<string, { model: FormModel; updatedAt: Date }>()\n\n const cache = server.app.models\n\n const cacheKey = `${metadata.id}_${formState}_${isPreview}`\n let entry = cache.get(cacheKey)\n\n if (!entry || !isEqual(entry.updatedAt, stateMetadata.updatedAt)) {\n const definition = await formsService.getFormDefinition(\n metadata.id,\n formState\n )\n\n if (!definition) {\n throw Boom.notFound(\n `No definition found for form metadata ${metadata.id} (${slug}) ${state}`\n )\n }\n\n checkEmailAddressForLiveFormSubmission(\n metadata.notificationEmail,\n isPreview\n )\n\n const routePrefix =\n options.routePrefix ?? server.realm.modifiers.route.prefix\n\n const model = new FormModel(\n definition,\n {\n basePath:\n options.basePath ??\n buildBasePath(routePrefix, slug, formState, isPreview),\n ordnanceSurveyApiKey: options.ordnanceSurveyApiKey,\n formId: options.formId ?? metadata.id\n },\n services,\n options.controllers\n )\n\n entry = { model, updatedAt: stateMetadata.updatedAt }\n cache.set(cacheKey, entry)\n }\n\n return entry.model\n}\n\nfunction buildBasePath(\n routePrefix: string,\n slug: string,\n state: FormStatus,\n isPreview: boolean\n) {\n const base = (\n isPreview\n ? `${routePrefix}${PREVIEW_PATH_PREFIX}/${state}/${slug}`\n : `${routePrefix}/${slug}`\n ).replace(/\\/{2,}/g, '/')\n\n return base.startsWith('/') ? base.slice(1) : base\n}\n\nexport function getFirstJourneyPage(\n context?: Pick<FormContext, 'relevantPages'>\n) {\n if (!context?.relevantPages) {\n return undefined\n }\n\n const lastPageReached = context.relevantPages.at(-1)\n const penultimatePageReached = context.relevantPages.at(-2)\n\n if (\n lastPageReached instanceof TerminalPageController &&\n penultimatePageReached\n ) {\n return penultimatePageReached\n }\n\n return lastPageReached\n}\n\nfunction resolveState(state: JourneyState): FormStatus {\n return state === 'preview' ? FormStatus.Live : state\n}\n\nfunction isPreviewState(\n state: JourneyState,\n options: FormModelOptions = {}\n): boolean {\n return options.isPreview ?? state === 'preview'\n}\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAE7B,SAASC,OAAO,QAAQ,UAAU;AAElC,SAASC,mBAAmB;AAC5B,SAASC,mBAAmB;AAC5B,SACEC,sCAAsC,EACtCC,eAAe;AAEjB,SAASC,SAAS;AAElB,SAASC,sBAAsB;AAC/B,OAAO,KAAKC,eAAe;AAS3B,SAASC,UAAU;AAEnB,SAASC,eAAe;AAuBxB,OAAO,eAAeC,YAAYA,CAChCC,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIP,eAAe;EACpD,MAAM;IAAEQ;EAAa,CAAC,GAAGD,QAAQ;EACjC,MAAME,SAAS,GAAGC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EAChD,MAAMK,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EAErC,MAAMQ,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EACzDT,mBAAmB,CAACkB,QAAQ,EAAEF,SAAS,EAAEF,SAAS,CAAC;EAEnD,MAAMM,UAAU,GAAG,MAAMP,YAAY,CAACQ,iBAAiB,CACrDH,QAAQ,CAACI,EAAE,EACXN,SACF,CAAC;EAED,IAAI,CAACI,UAAU,EAAE;IACf,MAAMvB,IAAI,CAAC0B,QAAQ,CACjB,yCAAyCL,QAAQ,CAACI,EAAE,KAAKb,IAAI,KAAKC,KAAK,EACzE,CAAC;EACH;EAEA,OAAO,IAAIP,SAAS,CAClBiB,UAAU,EACV;IACEI,QAAQ,EACNb,OAAO,CAACa,QAAQ,IAChBC,aAAa,CAACd,OAAO,CAACe,WAAW,IAAI,EAAE,EAAEjB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;IACtEa,oBAAoB,EAAEhB,OAAO,CAACgB,oBAAoB;IAClDC,MAAM,EAAEjB,OAAO,CAACiB,MAAM,IAAIV,QAAQ,CAACI;EACrC,CAAC,EACDV,QAAQ,EACRD,OAAO,CAACkB,WACV,CAAC;AACH;AAEA,OAAO,eAAeC,cAAcA,CAClC;EAAEC,MAAM;EAAEC;AAAqC,CAAC,EAChDvB,IAAY,EACZC,KAAmB,GAAGJ,UAAU,CAAC2B,IAAI,EACrCtB,OAA2B,GAAG,CAAC,CAAC,EACV;EACtB,MAAMuB,SAAS,GAAG,MAAMC,gBAAgB,CAACJ,MAAM,EAAEtB,IAAI,EAAEC,KAAK,EAAEC,OAAO,CAAC;EAEtE,MAAMyB,YAAY,GAAGlC,eAAe,CAAC6B,MAAM,CAAC;EAE5C,MAAMM,cAA8B,GAAG;IACrCC,GAAG,EAAE,CAAC,CAAC;IACPC,MAAM,EAAE,KAAK;IACbC,MAAM,EAAE;MACNC,IAAI,EAAE,SAAS;MACfhC,IAAI;MACJ,IAAIM,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC,IAAI;QACpCD,KAAK,EAAEO,YAAY,CAACP,KAAK;MAC3B,CAAC;IACH,CAAC;IACD+B,IAAI,EAAE,IAAIP,SAAS,CAACV,QAAQ,UAAU;IACtCkB,KAAK,EAAE,CAAC,CAAC;IACTC,GAAG,EAAE,IAAIC,GAAG,CACV,IAAIV,SAAS,CAACV,QAAQ,UAAU,EAChC,4BACF,CAAC;IACDO,MAAM;IACNC;EACF,CAAC;EAED,MAAMa,WAAW,GAAG,MAAMT,YAAY,CAACU,QAAQ,CAC7CT,cACF,CAAC;EAED,MAAMrB,SAAS,GAAG;IAChB,GAAG6B,WAAW;IACdE,mBAAmB,EAAEF,WAAW,CAACE;EACnC,CAAmC;EAEnC,MAAMC,QAAQ,GAAGzC,eAAe,CAAC8B,cAA2C,CAAC;EAC7E,MAAMY,UAAU,GAAGf,SAAS,CAACgB,gBAAgB,CAACF,QAAQ,CAAC;EAEvD,OAAOd,SAAS,CAACJ,cAAc,CAC7BO,cAAc,EACdrB,SAAS,EACTL,OAAO,CAACwC,MAAM,IAAI,EAAE,EACpBF,UACF,CAAC;AACH;AAEA,OAAO,eAAed,gBAAgBA,CACpCJ,MAAc,EACdtB,IAAY,EACZC,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EAC9B;EACA,MAAMC,QAAQ,GAAGD,OAAO,CAACC,QAAQ,IAAIP,eAAe;EACpD,MAAM;IAAEQ;EAAa,CAAC,GAAGD,QAAQ;EAEjC,MAAMM,QAAQ,GAAG,MAAML,YAAY,CAACM,eAAe,CAACV,IAAI,CAAC;EACzD,MAAMO,SAAS,GAAGC,YAAY,CAACP,KAAK,CAAC;EACrC,MAAMI,SAAS,GAAGH,OAAO,CAACG,SAAS,IAAIC,cAAc,CAACL,KAAK,EAAEC,OAAO,CAAC;EACrEX,mBAAmB,CAACkB,QAAQ,EAAEF,SAAS,EAAEF,SAAS,CAAC;EACnD,MAAMsC,aAAa,GAAGlC,QAAQ,CAACF,SAAS,CAAC;EAEzC,IAAI,CAACoC,aAAa,EAAE;IAClB,MAAMvD,IAAI,CAAC0B,QAAQ,CACjB,OAAOP,SAAS,6BAA6BE,QAAQ,CAACI,EAAE,EAC1D,CAAC;EACH;;EAEA;EACAS,MAAM,CAACO,GAAG,CAACe,MAAM,KAAK,IAAIC,GAAG,CAAgD,CAAC;EAE9E,MAAMC,KAAK,GAAGxB,MAAM,CAACO,GAAG,CAACe,MAAM;EAE/B,MAAMG,QAAQ,GAAG,GAAGtC,QAAQ,CAACI,EAAE,IAAIN,SAAS,IAAIF,SAAS,EAAE;EAC3D,IAAI2C,KAAK,GAAGF,KAAK,CAACG,GAAG,CAACF,QAAQ,CAAC;EAE/B,IAAI,CAACC,KAAK,IAAI,CAAC3D,OAAO,CAAC2D,KAAK,CAACE,SAAS,EAAEP,aAAa,CAACO,SAAS,CAAC,EAAE;IAChE,MAAMvC,UAAU,GAAG,MAAMP,YAAY,CAACQ,iBAAiB,CACrDH,QAAQ,CAACI,EAAE,EACXN,SACF,CAAC;IAED,IAAI,CAACI,UAAU,EAAE;MACf,MAAMvB,IAAI,CAAC0B,QAAQ,CACjB,yCAAyCL,QAAQ,CAACI,EAAE,KAAKb,IAAI,KAAKC,KAAK,EACzE,CAAC;IACH;IAEAT,sCAAsC,CACpCiB,QAAQ,CAAC0C,iBAAiB,EAC1B9C,SACF,CAAC;IAED,MAAMY,WAAW,GACff,OAAO,CAACe,WAAW,IAAIK,MAAM,CAAC8B,KAAK,CAACC,SAAS,CAACC,KAAK,CAACC,MAAM;IAE5D,MAAMC,KAAK,GAAG,IAAI9D,SAAS,CACzBiB,UAAU,EACV;MACEI,QAAQ,EACNb,OAAO,CAACa,QAAQ,IAChBC,aAAa,CAACC,WAAW,EAAEjB,IAAI,EAAEO,SAAS,EAAEF,SAAS,CAAC;MACxDa,oBAAoB,EAAEhB,OAAO,CAACgB,oBAAoB;MAClDC,MAAM,EAAEjB,OAAO,CAACiB,MAAM,IAAIV,QAAQ,CAACI;IACrC,CAAC,EACDV,QAAQ,EACRD,OAAO,CAACkB,WACV,CAAC;IAED4B,KAAK,GAAG;MAAEQ,KAAK;MAAEN,SAAS,EAAEP,aAAa,CAACO;IAAU,CAAC;IACrDJ,KAAK,CAACW,GAAG,CAACV,QAAQ,EAAEC,KAAK,CAAC;EAC5B;EAEA,OAAOA,KAAK,CAACQ,KAAK;AACpB;AAEA,SAASxC,aAAaA,CACpBC,WAAmB,EACnBjB,IAAY,EACZC,KAAiB,EACjBI,SAAkB,EAClB;EACA,MAAMqD,IAAI,GAAG,CACXrD,SAAS,GACL,GAAGY,WAAW,GAAG3B,mBAAmB,IAAIW,KAAK,IAAID,IAAI,EAAE,GACvD,GAAGiB,WAAW,IAAIjB,IAAI,EAAE,EAC5B2D,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;EAEzB,OAAOD,IAAI,CAACE,UAAU,CAAC,GAAG,CAAC,GAAGF,IAAI,CAACG,KAAK,CAAC,CAAC,CAAC,GAAGH,IAAI;AACpD;AAEA,OAAO,SAASI,mBAAmBA,CACjCC,OAA4C,EAC5C;EACA,IAAI,CAACA,OAAO,EAAEC,aAAa,EAAE;IAC3B,OAAOC,SAAS;EAClB;EAEA,MAAMC,eAAe,GAAGH,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EACpD,MAAMC,sBAAsB,GAAGL,OAAO,CAACC,aAAa,CAACG,EAAE,CAAC,CAAC,CAAC,CAAC;EAE3D,IACED,eAAe,YAAYvE,sBAAsB,IACjDyE,sBAAsB,EACtB;IACA,OAAOA,sBAAsB;EAC/B;EAEA,OAAOF,eAAe;AACxB;AAEA,SAAS1D,YAAYA,CAACP,KAAmB,EAAc;EACrD,OAAOA,KAAK,KAAK,SAAS,GAAGJ,UAAU,CAAC2B,IAAI,GAAGvB,KAAK;AACtD;AAEA,SAASK,cAAcA,CACrBL,KAAmB,EACnBC,OAAyB,GAAG,CAAC,CAAC,EACrB;EACT,OAAOA,OAAO,CAACG,SAAS,IAAIJ,KAAK,KAAK,SAAS;AACjD","ignoreList":[]}
@@ -65,6 +65,7 @@ export declare function getPluginOptions(server: Server): {
65
65
  cacheService: import("../../services/cacheService.js").CacheService;
66
66
  viewContext?: (request: import("../../../server/plugins/engine/types.js").AnyFormRequest | null) => Record<string, unknown> | Promise<Record<string, unknown>>;
67
67
  saveAndExit?: import("../../../server/plugins/engine/types.js").PluginOptions["saveAndExit"];
68
+ getLanguage?: import("../../../server/plugins/engine/types.js").PluginOptions["getLanguage"];
68
69
  baseUrl: string;
69
70
  services: import("../../../server/plugins/engine/types.js").PluginOptions["services"];
70
71
  };
@@ -87,4 +88,3 @@ export interface FormVersionMetadata {
87
88
  * Extracts form version metadata from a form definition
88
89
  */
89
90
  export declare function getFormVersion(definition: Pick<FormDefinition, 'metadata'>): FormVersionMetadata | undefined;
90
- export declare function setPageTitles(def: FormDefinition): void;
@@ -1,4 +1,4 @@
1
- import { ControllerPath, Engine, getErrorMessage, hasComponents, isFormType } from '@defra/forms-model';
1
+ import { ControllerPath, Engine, getErrorMessage } from '@defra/forms-model';
2
2
  import Boom from '@hapi/boom';
3
3
  import { format, parseISO } from 'date-fns';
4
4
  import { StatusCodes } from 'http-status-codes';
@@ -57,7 +57,13 @@ engine.registerFilter('answer', function (name) {
57
57
  if (!component?.isFormComponent) {
58
58
  return;
59
59
  }
60
- const answer = getAnswer(component, globals.context.relevantState);
60
+ const field = component;
61
+ const {
62
+ translator
63
+ } = globals.context;
64
+ const answer = getAnswer(field, globals.context.relevantState, translator ?? field.model.createTranslator(), {
65
+ format: 'summary'
66
+ });
61
67
  return answer;
62
68
  });
63
69
  export function proceed(request, h, nextUrl) {
@@ -276,15 +282,4 @@ export function handleLegacyRedirect(h, targetUrl) {
276
282
  export function getFormVersion(definition) {
277
283
  return definition.metadata?.[FORM_VERSION_METADATA_KEY];
278
284
  }
279
- export function setPageTitles(def) {
280
- def.pages.forEach(page => {
281
- if (!page.title) {
282
- if (hasComponents(page)) {
283
- // Set the page title from the first form component
284
- const firstFormComponent = page.components.find(component => isFormType(component.type));
285
- page.title = firstFormComponent?.title ?? '';
286
- }
287
- }
288
- });
289
- }
290
285
  //# sourceMappingURL=helpers.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"helpers.js","names":["ControllerPath","Engine","getErrorMessage","hasComponents","isFormType","Boom","format","parseISO","StatusCodes","Liquid","logger","FORM_VERSION_METADATA_KEY","getAnswer","stripParam","FormAction","FormStatus","engine","outputEscape","jsTruthy","ownPropertyOnly","registerFilter","template","globals","context","evaluated","evaluateTemplate","path","pageDef","pages","get","query","page","pageMap","undefined","getPageHref","name","componentDef","components","component","componentMap","isFormComponent","answer","relevantState","proceed","request","h","nextUrl","method","payload","returnUrl","isReturnAllowed","action","Continue","Validate","nextQuery","response","isPathRelative","redirect","redirectPath","code","SEE_OTHER","MOVED_TEMPORARILY","encodeUrl","link","URL","toString","err","error","pathOrQuery","queryOnly","Error","getHref","isRelative","params","Object","entries","filter","url","value","searchParams","set","pathname","search","href","startsWith","normalisePath","trim","replace","getPage","model","findPage","notFound","findPath","find","getStartPath","V2","startPath","def","at","Start","startPage","checkFormStatus","isPreview","state","Live","Draft","checkEmailAddressForLiveFormSubmission","emailAddress","internal","getErrors","details","length","map","getError","detail","message","key","text","createError","componentName","getExponentialBackoffDelay","depth","BASE_DELAY_MS","CAP_DELAY_MS","delay","Math","min","pageDefMap","componentDefMap","parseAndRenderSync","getCacheService","server","getPluginOptions","cacheService","getSaveAndExitHelpers","saveAndExit","plugins","handleLegacyRedirect","targetUrl","permanent","takeover","getFormVersion","definition","metadata","setPageTitles","forEach","title","firstFormComponent","type"],"sources":["../../../../src/server/plugins/engine/helpers.ts"],"sourcesContent":["import {\n ControllerPath,\n Engine,\n getErrorMessage,\n hasComponents,\n isFormType,\n type ComponentDef,\n type FormDefinition,\n type Page\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type ResponseToolkit, type Server } from '@hapi/hapi'\nimport { format, parseISO } from 'date-fns'\nimport { StatusCodes } from 'http-status-codes'\nimport { type Schema, type ValidationErrorItem } from 'joi'\nimport { Liquid } from 'liquidjs'\n\nimport { logger } from '~/src/server/common/helpers/logging/logger.js'\nimport { FORM_VERSION_METADATA_KEY } from '~/src/server/constants.js'\nimport {\n getAnswer,\n type Field\n} from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport { stripParam } from '~/src/server/plugins/engine/pageControllers/helpers/state.js'\nimport {\n type FormContext,\n type FormContextRequest,\n type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\nimport {\n FormAction,\n FormStatus,\n type FormParams,\n type FormQuery,\n type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nexport const engine = new Liquid({\n outputEscape: 'escape',\n jsTruthy: true,\n ownPropertyOnly: false\n})\n\nexport interface GlobalScope {\n context: FormContext\n pages: Map<string, Page>\n components: Map<string, ComponentDef>\n}\n\nengine.registerFilter('evaluate', function (template?: string) {\n if (typeof template !== 'string') {\n return template\n }\n\n const globals = this.context.globals as GlobalScope\n const evaluated = evaluateTemplate(template, globals.context)\n\n return evaluated\n})\n\nengine.registerFilter('page', function (path?: string) {\n if (typeof path !== 'string') {\n return\n }\n\n const globals = this.context.globals as GlobalScope\n const pageDef = globals.pages.get(path)\n\n return pageDef\n})\n\nengine.registerFilter('href', function (path: string, query?: FormQuery) {\n if (typeof path !== 'string') {\n return\n }\n\n const globals = this.context.globals as GlobalScope\n const page = globals.context.pageMap.get(path)\n\n if (page === undefined) {\n return\n }\n\n return getPageHref(page, query)\n})\n\nengine.registerFilter('field', function (name: string) {\n if (typeof name !== 'string') {\n return\n }\n\n const globals = this.context.globals as GlobalScope\n const componentDef = globals.components.get(name)\n\n return componentDef\n})\n\nengine.registerFilter('answer', function (name: string) {\n if (typeof name !== 'string') {\n return\n }\n\n const globals = this.context.globals as GlobalScope\n const component = globals.context.componentMap.get(name)\n\n if (!component?.isFormComponent) {\n return\n }\n\n const answer = getAnswer(component as Field, globals.context.relevantState)\n\n return answer\n})\n\nexport function proceed(\n request: Pick<FormContextRequest, 'method' | 'payload' | 'query'>,\n h: FormResponseToolkit,\n nextUrl: string\n) {\n const { method, payload, query } = request\n const { returnUrl } = query\n\n const isReturnAllowed =\n payload && 'action' in payload\n ? payload.action === FormAction.Continue ||\n payload.action === FormAction.Validate\n : false\n\n // On POST, strip all query params to prevent them persisting across pages.\n // On GET, forward params (minus returnUrl) so pre-population query params\n // survive dispatch redirects (e.g. ?formId= reaching the start page).\n const nextQuery =\n method === 'get' ? stripParam(query, 'returnUrl') : undefined\n\n // Redirect to return location (optional)\n const response =\n isReturnAllowed && isPathRelative(returnUrl)\n ? h.redirect(returnUrl)\n : h.redirect(redirectPath(nextUrl, nextQuery))\n\n // Redirect POST to GET to avoid resubmission\n return method === 'post'\n ? response.code(StatusCodes.SEE_OTHER)\n : response.code(StatusCodes.MOVED_TEMPORARILY)\n}\n\n/**\n * Encodes a URL, returning undefined if the process fails.\n */\nexport function encodeUrl(link?: string) {\n if (link) {\n try {\n return new URL(link).toString() // escape the search params without breaking the ? and & reserved characters in rfc2368\n } catch (err) {\n logger.error(\n err,\n `[urlEncodingFailed] Failed to encode URL: ${link} - ${getErrorMessage(err)}`\n )\n throw err\n }\n }\n}\n\n/**\n * Get page href\n */\nexport function getPageHref(\n page: PageControllerClass,\n query?: FormQuery\n): string\n\n/**\n * Get page href by path\n */\nexport function getPageHref(\n page: PageControllerClass,\n path: string,\n query?: FormQuery\n): string\n\nexport function getPageHref(\n page: PageControllerClass,\n pathOrQuery?: string | FormQuery,\n queryOnly: FormQuery = {}\n) {\n const path = typeof pathOrQuery === 'string' ? pathOrQuery : page.path\n const query = typeof pathOrQuery === 'object' ? pathOrQuery : queryOnly\n\n if (!isPathRelative(path)) {\n throw Error(`Only relative URLs are allowed: ${path}`)\n }\n\n // Return path with page href as base\n return redirectPath(page.getHref(path), query)\n}\n\n/**\n * Get redirect path with optional query params\n */\nexport function redirectPath(nextUrl: string, query: FormQuery = {}) {\n const isRelative = isPathRelative(nextUrl)\n\n // Filter string query params only\n const params = Object.entries(query).filter(\n (query): query is [string, string] => typeof query[1] === 'string'\n )\n\n // Build URL with relative path support\n const url = isRelative\n ? new URL(nextUrl, 'http://example.com')\n : new URL(nextUrl)\n\n // Append query params\n for (const [name, value] of params) {\n url.searchParams.set(name, value)\n }\n\n if (isRelative) {\n return `${url.pathname}${url.search}`\n }\n\n return url.href\n}\n\nexport function isPathRelative(path?: string) {\n return (path ?? '').startsWith('/')\n}\n\nexport function normalisePath(path = '') {\n return path\n .trim() // Trim empty spaces\n .replace(/^\\//, '') // Remove leading slash\n .replace(/\\/$/, '') // Remove trailing slash\n}\n\nexport function getPage(\n model: FormModel | undefined,\n request: FormContextRequest\n) {\n const { params } = request\n\n const page = findPage(model, `/${params.path}`)\n\n if (!page) {\n throw Boom.notFound(`No page found for /${params.path}`)\n }\n\n return page\n}\n\nexport function findPage(model: FormModel | undefined, path?: string) {\n const findPath = `/${normalisePath(path)}`\n return model?.pages.find(({ path }) => path === findPath)\n}\n\nexport function getStartPath(model?: FormModel) {\n if (model?.engine === Engine.V2) {\n const startPath = normalisePath(model.def.pages.at(0)?.path)\n return startPath ? `/${startPath}` : ControllerPath.Start\n }\n\n const startPath = normalisePath(model?.def.startPage)\n return startPath ? `/${startPath}` : ControllerPath.Start\n}\n\nexport function checkFormStatus(params?: FormParams) {\n const isPreview = !!params?.state\n\n let state = FormStatus.Live\n\n if (isPreview && params.state === FormStatus.Draft) {\n state = FormStatus.Draft\n }\n\n return {\n isPreview,\n state\n }\n}\n\nexport function checkEmailAddressForLiveFormSubmission(\n emailAddress: string | undefined,\n isPreview: boolean\n) {\n if (!emailAddress && !isPreview) {\n throw Boom.internal(\n 'An email address is required to complete the form submission'\n )\n }\n}\n\n/**\n * Parses the errors from {@link Schema.validate} so they can be rendered by govuk-frontend templates\n * @param [details] - provided by {@link Schema.validate}\n */\nexport function getErrors(\n details?: ValidationErrorItem[]\n): FormSubmissionError[] | undefined {\n if (!details?.length) {\n return\n }\n\n return details.map(getError)\n}\n\nexport function getError(detail: ValidationErrorItem): FormSubmissionError {\n const { context, message, path } = detail\n\n const name = context?.key ?? ''\n const href = `#${name}`\n\n const text = message.replace(\n /\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d\\.\\d+([+-][0-2]\\d:[0-5]\\d|Z)/,\n (text) => format(parseISO(text), 'd MMMM yyyy')\n )\n\n return {\n path,\n href,\n name,\n text,\n context\n }\n}\n\nexport function createError(componentName: string, message: string) {\n return {\n href: `#${componentName}`,\n name: componentName,\n text: message\n }\n}\n\n/**\n * Calculates an exponential backoff delay (in milliseconds) based on the current retry depth,\n * using a base delay of 2000ms (2 seconds) and doubling for each additional depth, while capping the delay at 25,000ms (25 seconds).\n * @param depth - The current retry depth (1, 2, 3, …)\n * @returns The calculated delay in milliseconds.\n */\nexport function getExponentialBackoffDelay(depth: number): number {\n const BASE_DELAY_MS = 2000 // 2 seconds initial delay\n const CAP_DELAY_MS = 25000 // cap each delay to 25 seconds\n const delay = BASE_DELAY_MS * 2 ** (depth - 1)\n return Math.min(delay, CAP_DELAY_MS)\n}\n\nexport function evaluateTemplate(\n template: string,\n context: FormContext\n): string {\n const globals: GlobalScope = {\n context,\n pages: context.pageDefMap,\n components: context.componentDefMap\n }\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return engine.parseAndRenderSync(template, context.relevantState, {\n globals\n })\n}\n\nexport function getCacheService(server: Server) {\n return getPluginOptions(server).cacheService\n}\n\nexport function getSaveAndExitHelpers(server: Server) {\n return getPluginOptions(server).saveAndExit\n}\n\nexport function getPluginOptions(server: Server) {\n return server.plugins['forms-engine-plugin']\n}\n\n/**\n * Handles logging and issuing a permanent redirect for legacy routes.\n * @param h - The Hapi response toolkit.\n * @param targetUrl - The URL to redirect to.\n * @returns The Hapi response object configured for permanent redirect.\n */\nexport function handleLegacyRedirect(h: ResponseToolkit, targetUrl: string) {\n return h.redirect(targetUrl).permanent().takeover()\n}\n\n/**\n * If the page doesn't have a title, set it from the title of the first form component\n * @param def - the form definition\n */\nexport interface FormVersionMetadata {\n versionNumber: number\n createdAt: Date\n}\n\n/**\n * Extracts form version metadata from a form definition\n */\nexport function getFormVersion(\n definition: Pick<FormDefinition, 'metadata'>\n): FormVersionMetadata | undefined {\n return definition.metadata?.[FORM_VERSION_METADATA_KEY] as\n | FormVersionMetadata\n | undefined\n}\n\nexport function setPageTitles(def: FormDefinition) {\n def.pages.forEach((page) => {\n if (!page.title) {\n if (hasComponents(page)) {\n // Set the page title from the first form component\n const firstFormComponent = page.components.find((component) =>\n isFormType(component.type)\n )\n\n page.title = firstFormComponent?.title ?? ''\n }\n }\n })\n}\n"],"mappings":"AAAA,SACEA,cAAc,EACdC,MAAM,EACNC,eAAe,EACfC,aAAa,EACbC,UAAU,QAIL,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAE7B,SAASC,MAAM,EAAEC,QAAQ,QAAQ,UAAU;AAC3C,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,MAAM,QAAQ,UAAU;AAEjC,SAASC,MAAM;AACf,SAASC,yBAAyB;AAClC,SACEC,SAAS;AAKX,SAASC,UAAU;AAMnB,SACEC,UAAU,EACVC,UAAU;AAMZ,OAAO,MAAMC,MAAM,GAAG,IAAIP,MAAM,CAAC;EAC/BQ,YAAY,EAAE,QAAQ;EACtBC,QAAQ,EAAE,IAAI;EACdC,eAAe,EAAE;AACnB,CAAC,CAAC;AAQFH,MAAM,CAACI,cAAc,CAAC,UAAU,EAAE,UAAUC,QAAiB,EAAE;EAC7D,IAAI,OAAOA,QAAQ,KAAK,QAAQ,EAAE;IAChC,OAAOA,QAAQ;EACjB;EAEA,MAAMC,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAME,SAAS,GAAGC,gBAAgB,CAACJ,QAAQ,EAAEC,OAAO,CAACC,OAAO,CAAC;EAE7D,OAAOC,SAAS;AAClB,CAAC,CAAC;AAEFR,MAAM,CAACI,cAAc,CAAC,MAAM,EAAE,UAAUM,IAAa,EAAE;EACrD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMJ,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMK,OAAO,GAAGL,OAAO,CAACM,KAAK,CAACC,GAAG,CAACH,IAAI,CAAC;EAEvC,OAAOC,OAAO;AAChB,CAAC,CAAC;AAEFX,MAAM,CAACI,cAAc,CAAC,MAAM,EAAE,UAAUM,IAAY,EAAEI,KAAiB,EAAE;EACvE,IAAI,OAAOJ,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMJ,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMS,IAAI,GAAGT,OAAO,CAACC,OAAO,CAACS,OAAO,CAACH,GAAG,CAACH,IAAI,CAAC;EAE9C,IAAIK,IAAI,KAAKE,SAAS,EAAE;IACtB;EACF;EAEA,OAAOC,WAAW,CAACH,IAAI,EAAED,KAAK,CAAC;AACjC,CAAC,CAAC;AAEFd,MAAM,CAACI,cAAc,CAAC,OAAO,EAAE,UAAUe,IAAY,EAAE;EACrD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMb,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMc,YAAY,GAAGd,OAAO,CAACe,UAAU,CAACR,GAAG,CAACM,IAAI,CAAC;EAEjD,OAAOC,YAAY;AACrB,CAAC,CAAC;AAEFpB,MAAM,CAACI,cAAc,CAAC,QAAQ,EAAE,UAAUe,IAAY,EAAE;EACtD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMb,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMgB,SAAS,GAAGhB,OAAO,CAACC,OAAO,CAACgB,YAAY,CAACV,GAAG,CAACM,IAAI,CAAC;EAExD,IAAI,CAACG,SAAS,EAAEE,eAAe,EAAE;IAC/B;EACF;EAEA,MAAMC,MAAM,GAAG7B,SAAS,CAAC0B,SAAS,EAAWhB,OAAO,CAACC,OAAO,CAACmB,aAAa,CAAC;EAE3E,OAAOD,MAAM;AACf,CAAC,CAAC;AAEF,OAAO,SAASE,OAAOA,CACrBC,OAAiE,EACjEC,CAAsB,EACtBC,OAAe,EACf;EACA,MAAM;IAAEC,MAAM;IAAEC,OAAO;IAAElB;EAAM,CAAC,GAAGc,OAAO;EAC1C,MAAM;IAAEK;EAAU,CAAC,GAAGnB,KAAK;EAE3B,MAAMoB,eAAe,GACnBF,OAAO,IAAI,QAAQ,IAAIA,OAAO,GAC1BA,OAAO,CAACG,MAAM,KAAKrC,UAAU,CAACsC,QAAQ,IACtCJ,OAAO,CAACG,MAAM,KAAKrC,UAAU,CAACuC,QAAQ,GACtC,KAAK;;EAEX;EACA;EACA;EACA,MAAMC,SAAS,GACbP,MAAM,KAAK,KAAK,GAAGlC,UAAU,CAACiB,KAAK,EAAE,WAAW,CAAC,GAAGG,SAAS;;EAE/D;EACA,MAAMsB,QAAQ,GACZL,eAAe,IAAIM,cAAc,CAACP,SAAS,CAAC,GACxCJ,CAAC,CAACY,QAAQ,CAACR,SAAS,CAAC,GACrBJ,CAAC,CAACY,QAAQ,CAACC,YAAY,CAACZ,OAAO,EAAEQ,SAAS,CAAC,CAAC;;EAElD;EACA,OAAOP,MAAM,KAAK,MAAM,GACpBQ,QAAQ,CAACI,IAAI,CAACnD,WAAW,CAACoD,SAAS,CAAC,GACpCL,QAAQ,CAACI,IAAI,CAACnD,WAAW,CAACqD,iBAAiB,CAAC;AAClD;;AAEA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACC,IAAa,EAAE;EACvC,IAAIA,IAAI,EAAE;IACR,IAAI;MACF,OAAO,IAAIC,GAAG,CAACD,IAAI,CAAC,CAACE,QAAQ,CAAC,CAAC,EAAC;IAClC,CAAC,CAAC,OAAOC,GAAG,EAAE;MACZxD,MAAM,CAACyD,KAAK,CACVD,GAAG,EACH,6CAA6CH,IAAI,MAAM7D,eAAe,CAACgE,GAAG,CAAC,EAC7E,CAAC;MACD,MAAMA,GAAG;IACX;EACF;AACF;;AAEA;AACA;AACA;;AAMA;AACA;AACA;;AAOA,OAAO,SAAShC,WAAWA,CACzBH,IAAyB,EACzBqC,WAAgC,EAChCC,SAAoB,GAAG,CAAC,CAAC,EACzB;EACA,MAAM3C,IAAI,GAAG,OAAO0C,WAAW,KAAK,QAAQ,GAAGA,WAAW,GAAGrC,IAAI,CAACL,IAAI;EACtE,MAAMI,KAAK,GAAG,OAAOsC,WAAW,KAAK,QAAQ,GAAGA,WAAW,GAAGC,SAAS;EAEvE,IAAI,CAACb,cAAc,CAAC9B,IAAI,CAAC,EAAE;IACzB,MAAM4C,KAAK,CAAC,mCAAmC5C,IAAI,EAAE,CAAC;EACxD;;EAEA;EACA,OAAOgC,YAAY,CAAC3B,IAAI,CAACwC,OAAO,CAAC7C,IAAI,CAAC,EAAEI,KAAK,CAAC;AAChD;;AAEA;AACA;AACA;AACA,OAAO,SAAS4B,YAAYA,CAACZ,OAAe,EAAEhB,KAAgB,GAAG,CAAC,CAAC,EAAE;EACnE,MAAM0C,UAAU,GAAGhB,cAAc,CAACV,OAAO,CAAC;;EAE1C;EACA,MAAM2B,MAAM,GAAGC,MAAM,CAACC,OAAO,CAAC7C,KAAK,CAAC,CAAC8C,MAAM,CACxC9C,KAAK,IAAgC,OAAOA,KAAK,CAAC,CAAC,CAAC,KAAK,QAC5D,CAAC;;EAED;EACA,MAAM+C,GAAG,GAAGL,UAAU,GAClB,IAAIR,GAAG,CAAClB,OAAO,EAAE,oBAAoB,CAAC,GACtC,IAAIkB,GAAG,CAAClB,OAAO,CAAC;;EAEpB;EACA,KAAK,MAAM,CAACX,IAAI,EAAE2C,KAAK,CAAC,IAAIL,MAAM,EAAE;IAClCI,GAAG,CAACE,YAAY,CAACC,GAAG,CAAC7C,IAAI,EAAE2C,KAAK,CAAC;EACnC;EAEA,IAAIN,UAAU,EAAE;IACd,OAAO,GAAGK,GAAG,CAACI,QAAQ,GAAGJ,GAAG,CAACK,MAAM,EAAE;EACvC;EAEA,OAAOL,GAAG,CAACM,IAAI;AACjB;AAEA,OAAO,SAAS3B,cAAcA,CAAC9B,IAAa,EAAE;EAC5C,OAAO,CAACA,IAAI,IAAI,EAAE,EAAE0D,UAAU,CAAC,GAAG,CAAC;AACrC;AAEA,OAAO,SAASC,aAAaA,CAAC3D,IAAI,GAAG,EAAE,EAAE;EACvC,OAAOA,IAAI,CACR4D,IAAI,CAAC,CAAC,CAAC;EAAA,CACPC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;EAAA,CACnBA,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAC;AACxB;AAEA,OAAO,SAASC,OAAOA,CACrBC,KAA4B,EAC5B7C,OAA2B,EAC3B;EACA,MAAM;IAAE6B;EAAO,CAAC,GAAG7B,OAAO;EAE1B,MAAMb,IAAI,GAAG2D,QAAQ,CAACD,KAAK,EAAE,IAAIhB,MAAM,CAAC/C,IAAI,EAAE,CAAC;EAE/C,IAAI,CAACK,IAAI,EAAE;IACT,MAAM1B,IAAI,CAACsF,QAAQ,CAAC,sBAAsBlB,MAAM,CAAC/C,IAAI,EAAE,CAAC;EAC1D;EAEA,OAAOK,IAAI;AACb;AAEA,OAAO,SAAS2D,QAAQA,CAACD,KAA4B,EAAE/D,IAAa,EAAE;EACpE,MAAMkE,QAAQ,GAAG,IAAIP,aAAa,CAAC3D,IAAI,CAAC,EAAE;EAC1C,OAAO+D,KAAK,EAAE7D,KAAK,CAACiE,IAAI,CAAC,CAAC;IAAEnE;EAAK,CAAC,KAAKA,IAAI,KAAKkE,QAAQ,CAAC;AAC3D;AAEA,OAAO,SAASE,YAAYA,CAACL,KAAiB,EAAE;EAC9C,IAAIA,KAAK,EAAEzE,MAAM,KAAKf,MAAM,CAAC8F,EAAE,EAAE;IAC/B,MAAMC,SAAS,GAAGX,aAAa,CAACI,KAAK,CAACQ,GAAG,CAACrE,KAAK,CAACsE,EAAE,CAAC,CAAC,CAAC,EAAExE,IAAI,CAAC;IAC5D,OAAOsE,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAGhG,cAAc,CAACmG,KAAK;EAC3D;EAEA,MAAMH,SAAS,GAAGX,aAAa,CAACI,KAAK,EAAEQ,GAAG,CAACG,SAAS,CAAC;EACrD,OAAOJ,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAGhG,cAAc,CAACmG,KAAK;AAC3D;AAEA,OAAO,SAASE,eAAeA,CAAC5B,MAAmB,EAAE;EACnD,MAAM6B,SAAS,GAAG,CAAC,CAAC7B,MAAM,EAAE8B,KAAK;EAEjC,IAAIA,KAAK,GAAGxF,UAAU,CAACyF,IAAI;EAE3B,IAAIF,SAAS,IAAI7B,MAAM,CAAC8B,KAAK,KAAKxF,UAAU,CAAC0F,KAAK,EAAE;IAClDF,KAAK,GAAGxF,UAAU,CAAC0F,KAAK;EAC1B;EAEA,OAAO;IACLH,SAAS;IACTC;EACF,CAAC;AACH;AAEA,OAAO,SAASG,sCAAsCA,CACpDC,YAAgC,EAChCL,SAAkB,EAClB;EACA,IAAI,CAACK,YAAY,IAAI,CAACL,SAAS,EAAE;IAC/B,MAAMjG,IAAI,CAACuG,QAAQ,CACjB,8DACF,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CACvBC,OAA+B,EACI;EACnC,IAAI,CAACA,OAAO,EAAEC,MAAM,EAAE;IACpB;EACF;EAEA,OAAOD,OAAO,CAACE,GAAG,CAACC,QAAQ,CAAC;AAC9B;AAEA,OAAO,SAASA,QAAQA,CAACC,MAA2B,EAAuB;EACzE,MAAM;IAAE3F,OAAO;IAAE4F,OAAO;IAAEzF;EAAK,CAAC,GAAGwF,MAAM;EAEzC,MAAM/E,IAAI,GAAGZ,OAAO,EAAE6F,GAAG,IAAI,EAAE;EAC/B,MAAMjC,IAAI,GAAG,IAAIhD,IAAI,EAAE;EAEvB,MAAMkF,IAAI,GAAGF,OAAO,CAAC5B,OAAO,CAC1B,0EAA0E,EACzE8B,IAAI,IAAK/G,MAAM,CAACC,QAAQ,CAAC8G,IAAI,CAAC,EAAE,aAAa,CAChD,CAAC;EAED,OAAO;IACL3F,IAAI;IACJyD,IAAI;IACJhD,IAAI;IACJkF,IAAI;IACJ9F;EACF,CAAC;AACH;AAEA,OAAO,SAAS+F,WAAWA,CAACC,aAAqB,EAAEJ,OAAe,EAAE;EAClE,OAAO;IACLhC,IAAI,EAAE,IAAIoC,aAAa,EAAE;IACzBpF,IAAI,EAAEoF,aAAa;IACnBF,IAAI,EAAEF;EACR,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASK,0BAA0BA,CAACC,KAAa,EAAU;EAChE,MAAMC,aAAa,GAAG,IAAI,EAAC;EAC3B,MAAMC,YAAY,GAAG,KAAK,EAAC;EAC3B,MAAMC,KAAK,GAAGF,aAAa,GAAG,CAAC,KAAKD,KAAK,GAAG,CAAC,CAAC;EAC9C,OAAOI,IAAI,CAACC,GAAG,CAACF,KAAK,EAAED,YAAY,CAAC;AACtC;AAEA,OAAO,SAASlG,gBAAgBA,CAC9BJ,QAAgB,EAChBE,OAAoB,EACZ;EACR,MAAMD,OAAoB,GAAG;IAC3BC,OAAO;IACPK,KAAK,EAAEL,OAAO,CAACwG,UAAU;IACzB1F,UAAU,EAAEd,OAAO,CAACyG;EACtB,CAAC;;EAED;EACA,OAAOhH,MAAM,CAACiH,kBAAkB,CAAC5G,QAAQ,EAAEE,OAAO,CAACmB,aAAa,EAAE;IAChEpB;EACF,CAAC,CAAC;AACJ;AAEA,OAAO,SAAS4G,eAAeA,CAACC,MAAc,EAAE;EAC9C,OAAOC,gBAAgB,CAACD,MAAM,CAAC,CAACE,YAAY;AAC9C;AAEA,OAAO,SAASC,qBAAqBA,CAACH,MAAc,EAAE;EACpD,OAAOC,gBAAgB,CAACD,MAAM,CAAC,CAACI,WAAW;AAC7C;AAEA,OAAO,SAASH,gBAAgBA,CAACD,MAAc,EAAE;EAC/C,OAAOA,MAAM,CAACK,OAAO,CAAC,qBAAqB,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAAC5F,CAAkB,EAAE6F,SAAiB,EAAE;EAC1E,OAAO7F,CAAC,CAACY,QAAQ,CAACiF,SAAS,CAAC,CAACC,SAAS,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;AACrD;;AAEA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAC5BC,UAA4C,EACX;EACjC,OAAOA,UAAU,CAACC,QAAQ,GAAGpI,yBAAyB,CAAC;AAGzD;AAEA,OAAO,SAASqI,aAAaA,CAAC/C,GAAmB,EAAE;EACjDA,GAAG,CAACrE,KAAK,CAACqH,OAAO,CAAElH,IAAI,IAAK;IAC1B,IAAI,CAACA,IAAI,CAACmH,KAAK,EAAE;MACf,IAAI/I,aAAa,CAAC4B,IAAI,CAAC,EAAE;QACvB;QACA,MAAMoH,kBAAkB,GAAGpH,IAAI,CAACM,UAAU,CAACwD,IAAI,CAAEvD,SAAS,IACxDlC,UAAU,CAACkC,SAAS,CAAC8G,IAAI,CAC3B,CAAC;QAEDrH,IAAI,CAACmH,KAAK,GAAGC,kBAAkB,EAAED,KAAK,IAAI,EAAE;MAC9C;IACF;EACF,CAAC,CAAC;AACJ","ignoreList":[]}
1
+ {"version":3,"file":"helpers.js","names":["ControllerPath","Engine","getErrorMessage","Boom","format","parseISO","StatusCodes","Liquid","logger","FORM_VERSION_METADATA_KEY","getAnswer","stripParam","FormAction","FormStatus","engine","outputEscape","jsTruthy","ownPropertyOnly","registerFilter","template","globals","context","evaluated","evaluateTemplate","path","pageDef","pages","get","query","page","pageMap","undefined","getPageHref","name","componentDef","components","component","componentMap","isFormComponent","field","translator","answer","relevantState","model","createTranslator","proceed","request","h","nextUrl","method","payload","returnUrl","isReturnAllowed","action","Continue","Validate","nextQuery","response","isPathRelative","redirect","redirectPath","code","SEE_OTHER","MOVED_TEMPORARILY","encodeUrl","link","URL","toString","err","error","pathOrQuery","queryOnly","Error","getHref","isRelative","params","Object","entries","filter","url","value","searchParams","set","pathname","search","href","startsWith","normalisePath","trim","replace","getPage","findPage","notFound","findPath","find","getStartPath","V2","startPath","def","at","Start","startPage","checkFormStatus","isPreview","state","Live","Draft","checkEmailAddressForLiveFormSubmission","emailAddress","internal","getErrors","details","length","map","getError","detail","message","key","text","createError","componentName","getExponentialBackoffDelay","depth","BASE_DELAY_MS","CAP_DELAY_MS","delay","Math","min","pageDefMap","componentDefMap","parseAndRenderSync","getCacheService","server","getPluginOptions","cacheService","getSaveAndExitHelpers","saveAndExit","plugins","handleLegacyRedirect","targetUrl","permanent","takeover","getFormVersion","definition","metadata"],"sources":["../../../../src/server/plugins/engine/helpers.ts"],"sourcesContent":["import {\n ControllerPath,\n Engine,\n getErrorMessage,\n type ComponentDef,\n type FormDefinition,\n type Page\n} from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { type ResponseToolkit, type Server } from '@hapi/hapi'\nimport { format, parseISO } from 'date-fns'\nimport { StatusCodes } from 'http-status-codes'\nimport { type Schema, type ValidationErrorItem } from 'joi'\nimport { Liquid } from 'liquidjs'\n\nimport { logger } from '~/src/server/common/helpers/logging/logger.js'\nimport { FORM_VERSION_METADATA_KEY } from '~/src/server/constants.js'\nimport {\n getAnswer,\n type Field\n} from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport { stripParam } from '~/src/server/plugins/engine/pageControllers/helpers/state.js'\nimport {\n type FormContext,\n type FormContextRequest,\n type FormSubmissionError\n} from '~/src/server/plugins/engine/types.js'\nimport {\n FormAction,\n FormStatus,\n type FormParams,\n type FormQuery,\n type FormResponseToolkit\n} from '~/src/server/routes/types.js'\n\nexport const engine = new Liquid({\n outputEscape: 'escape',\n jsTruthy: true,\n ownPropertyOnly: false\n})\n\nexport interface GlobalScope {\n context: FormContext\n pages: Map<string, Page>\n components: Map<string, ComponentDef>\n}\n\nengine.registerFilter('evaluate', function (template?: string) {\n if (typeof template !== 'string') {\n return template\n }\n\n const globals = this.context.globals as GlobalScope\n const evaluated = evaluateTemplate(template, globals.context)\n\n return evaluated\n})\n\nengine.registerFilter('page', function (path?: string) {\n if (typeof path !== 'string') {\n return\n }\n\n const globals = this.context.globals as GlobalScope\n const pageDef = globals.pages.get(path)\n\n return pageDef\n})\n\nengine.registerFilter('href', function (path: string, query?: FormQuery) {\n if (typeof path !== 'string') {\n return\n }\n\n const globals = this.context.globals as GlobalScope\n const page = globals.context.pageMap.get(path)\n\n if (page === undefined) {\n return\n }\n\n return getPageHref(page, query)\n})\n\nengine.registerFilter('field', function (name: string) {\n if (typeof name !== 'string') {\n return\n }\n\n const globals = this.context.globals as GlobalScope\n const componentDef = globals.components.get(name)\n\n return componentDef\n})\n\nengine.registerFilter('answer', function (name: string) {\n if (typeof name !== 'string') {\n return\n }\n\n const globals = this.context.globals as GlobalScope\n const component = globals.context.componentMap.get(name)\n\n if (!component?.isFormComponent) {\n return\n }\n\n const field = component as Field\n const { translator } = globals.context\n const answer = getAnswer(\n field,\n globals.context.relevantState,\n translator ?? field.model.createTranslator(),\n {\n format: 'summary'\n }\n )\n\n return answer\n})\n\nexport function proceed(\n request: Pick<FormContextRequest, 'method' | 'payload' | 'query'>,\n h: FormResponseToolkit,\n nextUrl: string\n) {\n const { method, payload, query } = request\n const { returnUrl } = query\n\n const isReturnAllowed =\n payload && 'action' in payload\n ? payload.action === FormAction.Continue ||\n payload.action === FormAction.Validate\n : false\n\n // On POST, strip all query params to prevent them persisting across pages.\n // On GET, forward params (minus returnUrl) so pre-population query params\n // survive dispatch redirects (e.g. ?formId= reaching the start page).\n const nextQuery =\n method === 'get' ? stripParam(query, 'returnUrl') : undefined\n\n // Redirect to return location (optional)\n const response =\n isReturnAllowed && isPathRelative(returnUrl)\n ? h.redirect(returnUrl)\n : h.redirect(redirectPath(nextUrl, nextQuery))\n\n // Redirect POST to GET to avoid resubmission\n return method === 'post'\n ? response.code(StatusCodes.SEE_OTHER)\n : response.code(StatusCodes.MOVED_TEMPORARILY)\n}\n\n/**\n * Encodes a URL, returning undefined if the process fails.\n */\nexport function encodeUrl(link?: string) {\n if (link) {\n try {\n return new URL(link).toString() // escape the search params without breaking the ? and & reserved characters in rfc2368\n } catch (err) {\n logger.error(\n err,\n `[urlEncodingFailed] Failed to encode URL: ${link} - ${getErrorMessage(err)}`\n )\n throw err\n }\n }\n}\n\n/**\n * Get page href\n */\nexport function getPageHref(\n page: PageControllerClass,\n query?: FormQuery\n): string\n\n/**\n * Get page href by path\n */\nexport function getPageHref(\n page: PageControllerClass,\n path: string,\n query?: FormQuery\n): string\n\nexport function getPageHref(\n page: PageControllerClass,\n pathOrQuery?: string | FormQuery,\n queryOnly: FormQuery = {}\n) {\n const path = typeof pathOrQuery === 'string' ? pathOrQuery : page.path\n const query = typeof pathOrQuery === 'object' ? pathOrQuery : queryOnly\n\n if (!isPathRelative(path)) {\n throw Error(`Only relative URLs are allowed: ${path}`)\n }\n\n // Return path with page href as base\n return redirectPath(page.getHref(path), query)\n}\n\n/**\n * Get redirect path with optional query params\n */\nexport function redirectPath(nextUrl: string, query: FormQuery = {}) {\n const isRelative = isPathRelative(nextUrl)\n\n // Filter string query params only\n const params = Object.entries(query).filter(\n (query): query is [string, string] => typeof query[1] === 'string'\n )\n\n // Build URL with relative path support\n const url = isRelative\n ? new URL(nextUrl, 'http://example.com')\n : new URL(nextUrl)\n\n // Append query params\n for (const [name, value] of params) {\n url.searchParams.set(name, value)\n }\n\n if (isRelative) {\n return `${url.pathname}${url.search}`\n }\n\n return url.href\n}\n\nexport function isPathRelative(path?: string) {\n return (path ?? '').startsWith('/')\n}\n\nexport function normalisePath(path = '') {\n return path\n .trim() // Trim empty spaces\n .replace(/^\\//, '') // Remove leading slash\n .replace(/\\/$/, '') // Remove trailing slash\n}\n\nexport function getPage(\n model: FormModel | undefined,\n request: FormContextRequest\n) {\n const { params } = request\n\n const page = findPage(model, `/${params.path}`)\n\n if (!page) {\n throw Boom.notFound(`No page found for /${params.path}`)\n }\n\n return page\n}\n\nexport function findPage(model: FormModel | undefined, path?: string) {\n const findPath = `/${normalisePath(path)}`\n return model?.pages.find(({ path }) => path === findPath)\n}\n\nexport function getStartPath(model?: FormModel) {\n if (model?.engine === Engine.V2) {\n const startPath = normalisePath(model.def.pages.at(0)?.path)\n return startPath ? `/${startPath}` : ControllerPath.Start\n }\n\n const startPath = normalisePath(model?.def.startPage)\n return startPath ? `/${startPath}` : ControllerPath.Start\n}\n\nexport function checkFormStatus(params?: FormParams) {\n const isPreview = !!params?.state\n\n let state = FormStatus.Live\n\n if (isPreview && params.state === FormStatus.Draft) {\n state = FormStatus.Draft\n }\n\n return {\n isPreview,\n state\n }\n}\n\nexport function checkEmailAddressForLiveFormSubmission(\n emailAddress: string | undefined,\n isPreview: boolean\n) {\n if (!emailAddress && !isPreview) {\n throw Boom.internal(\n 'An email address is required to complete the form submission'\n )\n }\n}\n\n/**\n * Parses the errors from {@link Schema.validate} so they can be rendered by govuk-frontend templates\n * @param [details] - provided by {@link Schema.validate}\n */\nexport function getErrors(\n details?: ValidationErrorItem[]\n): FormSubmissionError[] | undefined {\n if (!details?.length) {\n return\n }\n\n return details.map(getError)\n}\n\nexport function getError(detail: ValidationErrorItem): FormSubmissionError {\n const { context, message, path } = detail\n\n const name = context?.key ?? ''\n const href = `#${name}`\n\n const text = message.replace(\n /\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d\\.\\d+([+-][0-2]\\d:[0-5]\\d|Z)/,\n (text) => format(parseISO(text), 'd MMMM yyyy')\n )\n\n return {\n path,\n href,\n name,\n text,\n context\n }\n}\n\nexport function createError(componentName: string, message: string) {\n return {\n href: `#${componentName}`,\n name: componentName,\n text: message\n }\n}\n\n/**\n * Calculates an exponential backoff delay (in milliseconds) based on the current retry depth,\n * using a base delay of 2000ms (2 seconds) and doubling for each additional depth, while capping the delay at 25,000ms (25 seconds).\n * @param depth - The current retry depth (1, 2, 3, …)\n * @returns The calculated delay in milliseconds.\n */\nexport function getExponentialBackoffDelay(depth: number): number {\n const BASE_DELAY_MS = 2000 // 2 seconds initial delay\n const CAP_DELAY_MS = 25000 // cap each delay to 25 seconds\n const delay = BASE_DELAY_MS * 2 ** (depth - 1)\n return Math.min(delay, CAP_DELAY_MS)\n}\n\nexport function evaluateTemplate(\n template: string,\n context: FormContext\n): string {\n const globals: GlobalScope = {\n context,\n pages: context.pageDefMap,\n components: context.componentDefMap\n }\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return engine.parseAndRenderSync(template, context.relevantState, {\n globals\n })\n}\n\nexport function getCacheService(server: Server) {\n return getPluginOptions(server).cacheService\n}\n\nexport function getSaveAndExitHelpers(server: Server) {\n return getPluginOptions(server).saveAndExit\n}\n\nexport function getPluginOptions(server: Server) {\n return server.plugins['forms-engine-plugin']\n}\n\n/**\n * Handles logging and issuing a permanent redirect for legacy routes.\n * @param h - The Hapi response toolkit.\n * @param targetUrl - The URL to redirect to.\n * @returns The Hapi response object configured for permanent redirect.\n */\nexport function handleLegacyRedirect(h: ResponseToolkit, targetUrl: string) {\n return h.redirect(targetUrl).permanent().takeover()\n}\n\n/**\n * If the page doesn't have a title, set it from the title of the first form component\n * @param def - the form definition\n */\nexport interface FormVersionMetadata {\n versionNumber: number\n createdAt: Date\n}\n\n/**\n * Extracts form version metadata from a form definition\n */\nexport function getFormVersion(\n definition: Pick<FormDefinition, 'metadata'>\n): FormVersionMetadata | undefined {\n return definition.metadata?.[FORM_VERSION_METADATA_KEY] as\n | FormVersionMetadata\n | undefined\n}\n"],"mappings":"AAAA,SACEA,cAAc,EACdC,MAAM,EACNC,eAAe,QAIV,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAE7B,SAASC,MAAM,EAAEC,QAAQ,QAAQ,UAAU;AAC3C,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,MAAM,QAAQ,UAAU;AAEjC,SAASC,MAAM;AACf,SAASC,yBAAyB;AAClC,SACEC,SAAS;AAKX,SAASC,UAAU;AAMnB,SACEC,UAAU,EACVC,UAAU;AAMZ,OAAO,MAAMC,MAAM,GAAG,IAAIP,MAAM,CAAC;EAC/BQ,YAAY,EAAE,QAAQ;EACtBC,QAAQ,EAAE,IAAI;EACdC,eAAe,EAAE;AACnB,CAAC,CAAC;AAQFH,MAAM,CAACI,cAAc,CAAC,UAAU,EAAE,UAAUC,QAAiB,EAAE;EAC7D,IAAI,OAAOA,QAAQ,KAAK,QAAQ,EAAE;IAChC,OAAOA,QAAQ;EACjB;EAEA,MAAMC,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAME,SAAS,GAAGC,gBAAgB,CAACJ,QAAQ,EAAEC,OAAO,CAACC,OAAO,CAAC;EAE7D,OAAOC,SAAS;AAClB,CAAC,CAAC;AAEFR,MAAM,CAACI,cAAc,CAAC,MAAM,EAAE,UAAUM,IAAa,EAAE;EACrD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMJ,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMK,OAAO,GAAGL,OAAO,CAACM,KAAK,CAACC,GAAG,CAACH,IAAI,CAAC;EAEvC,OAAOC,OAAO;AAChB,CAAC,CAAC;AAEFX,MAAM,CAACI,cAAc,CAAC,MAAM,EAAE,UAAUM,IAAY,EAAEI,KAAiB,EAAE;EACvE,IAAI,OAAOJ,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMJ,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMS,IAAI,GAAGT,OAAO,CAACC,OAAO,CAACS,OAAO,CAACH,GAAG,CAACH,IAAI,CAAC;EAE9C,IAAIK,IAAI,KAAKE,SAAS,EAAE;IACtB;EACF;EAEA,OAAOC,WAAW,CAACH,IAAI,EAAED,KAAK,CAAC;AACjC,CAAC,CAAC;AAEFd,MAAM,CAACI,cAAc,CAAC,OAAO,EAAE,UAAUe,IAAY,EAAE;EACrD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMb,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMc,YAAY,GAAGd,OAAO,CAACe,UAAU,CAACR,GAAG,CAACM,IAAI,CAAC;EAEjD,OAAOC,YAAY;AACrB,CAAC,CAAC;AAEFpB,MAAM,CAACI,cAAc,CAAC,QAAQ,EAAE,UAAUe,IAAY,EAAE;EACtD,IAAI,OAAOA,IAAI,KAAK,QAAQ,EAAE;IAC5B;EACF;EAEA,MAAMb,OAAO,GAAG,IAAI,CAACC,OAAO,CAACD,OAAsB;EACnD,MAAMgB,SAAS,GAAGhB,OAAO,CAACC,OAAO,CAACgB,YAAY,CAACV,GAAG,CAACM,IAAI,CAAC;EAExD,IAAI,CAACG,SAAS,EAAEE,eAAe,EAAE;IAC/B;EACF;EAEA,MAAMC,KAAK,GAAGH,SAAkB;EAChC,MAAM;IAAEI;EAAW,CAAC,GAAGpB,OAAO,CAACC,OAAO;EACtC,MAAMoB,MAAM,GAAG/B,SAAS,CACtB6B,KAAK,EACLnB,OAAO,CAACC,OAAO,CAACqB,aAAa,EAC7BF,UAAU,IAAID,KAAK,CAACI,KAAK,CAACC,gBAAgB,CAAC,CAAC,EAC5C;IACExC,MAAM,EAAE;EACV,CACF,CAAC;EAED,OAAOqC,MAAM;AACf,CAAC,CAAC;AAEF,OAAO,SAASI,OAAOA,CACrBC,OAAiE,EACjEC,CAAsB,EACtBC,OAAe,EACf;EACA,MAAM;IAAEC,MAAM;IAAEC,OAAO;IAAEtB;EAAM,CAAC,GAAGkB,OAAO;EAC1C,MAAM;IAAEK;EAAU,CAAC,GAAGvB,KAAK;EAE3B,MAAMwB,eAAe,GACnBF,OAAO,IAAI,QAAQ,IAAIA,OAAO,GAC1BA,OAAO,CAACG,MAAM,KAAKzC,UAAU,CAAC0C,QAAQ,IACtCJ,OAAO,CAACG,MAAM,KAAKzC,UAAU,CAAC2C,QAAQ,GACtC,KAAK;;EAEX;EACA;EACA;EACA,MAAMC,SAAS,GACbP,MAAM,KAAK,KAAK,GAAGtC,UAAU,CAACiB,KAAK,EAAE,WAAW,CAAC,GAAGG,SAAS;;EAE/D;EACA,MAAM0B,QAAQ,GACZL,eAAe,IAAIM,cAAc,CAACP,SAAS,CAAC,GACxCJ,CAAC,CAACY,QAAQ,CAACR,SAAS,CAAC,GACrBJ,CAAC,CAACY,QAAQ,CAACC,YAAY,CAACZ,OAAO,EAAEQ,SAAS,CAAC,CAAC;;EAElD;EACA,OAAOP,MAAM,KAAK,MAAM,GACpBQ,QAAQ,CAACI,IAAI,CAACvD,WAAW,CAACwD,SAAS,CAAC,GACpCL,QAAQ,CAACI,IAAI,CAACvD,WAAW,CAACyD,iBAAiB,CAAC;AAClD;;AAEA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACC,IAAa,EAAE;EACvC,IAAIA,IAAI,EAAE;IACR,IAAI;MACF,OAAO,IAAIC,GAAG,CAACD,IAAI,CAAC,CAACE,QAAQ,CAAC,CAAC,EAAC;IAClC,CAAC,CAAC,OAAOC,GAAG,EAAE;MACZ5D,MAAM,CAAC6D,KAAK,CACVD,GAAG,EACH,6CAA6CH,IAAI,MAAM/D,eAAe,CAACkE,GAAG,CAAC,EAC7E,CAAC;MACD,MAAMA,GAAG;IACX;EACF;AACF;;AAEA;AACA;AACA;;AAMA;AACA;AACA;;AAOA,OAAO,SAASpC,WAAWA,CACzBH,IAAyB,EACzByC,WAAgC,EAChCC,SAAoB,GAAG,CAAC,CAAC,EACzB;EACA,MAAM/C,IAAI,GAAG,OAAO8C,WAAW,KAAK,QAAQ,GAAGA,WAAW,GAAGzC,IAAI,CAACL,IAAI;EACtE,MAAMI,KAAK,GAAG,OAAO0C,WAAW,KAAK,QAAQ,GAAGA,WAAW,GAAGC,SAAS;EAEvE,IAAI,CAACb,cAAc,CAAClC,IAAI,CAAC,EAAE;IACzB,MAAMgD,KAAK,CAAC,mCAAmChD,IAAI,EAAE,CAAC;EACxD;;EAEA;EACA,OAAOoC,YAAY,CAAC/B,IAAI,CAAC4C,OAAO,CAACjD,IAAI,CAAC,EAAEI,KAAK,CAAC;AAChD;;AAEA;AACA;AACA;AACA,OAAO,SAASgC,YAAYA,CAACZ,OAAe,EAAEpB,KAAgB,GAAG,CAAC,CAAC,EAAE;EACnE,MAAM8C,UAAU,GAAGhB,cAAc,CAACV,OAAO,CAAC;;EAE1C;EACA,MAAM2B,MAAM,GAAGC,MAAM,CAACC,OAAO,CAACjD,KAAK,CAAC,CAACkD,MAAM,CACxClD,KAAK,IAAgC,OAAOA,KAAK,CAAC,CAAC,CAAC,KAAK,QAC5D,CAAC;;EAED;EACA,MAAMmD,GAAG,GAAGL,UAAU,GAClB,IAAIR,GAAG,CAAClB,OAAO,EAAE,oBAAoB,CAAC,GACtC,IAAIkB,GAAG,CAAClB,OAAO,CAAC;;EAEpB;EACA,KAAK,MAAM,CAACf,IAAI,EAAE+C,KAAK,CAAC,IAAIL,MAAM,EAAE;IAClCI,GAAG,CAACE,YAAY,CAACC,GAAG,CAACjD,IAAI,EAAE+C,KAAK,CAAC;EACnC;EAEA,IAAIN,UAAU,EAAE;IACd,OAAO,GAAGK,GAAG,CAACI,QAAQ,GAAGJ,GAAG,CAACK,MAAM,EAAE;EACvC;EAEA,OAAOL,GAAG,CAACM,IAAI;AACjB;AAEA,OAAO,SAAS3B,cAAcA,CAAClC,IAAa,EAAE;EAC5C,OAAO,CAACA,IAAI,IAAI,EAAE,EAAE8D,UAAU,CAAC,GAAG,CAAC;AACrC;AAEA,OAAO,SAASC,aAAaA,CAAC/D,IAAI,GAAG,EAAE,EAAE;EACvC,OAAOA,IAAI,CACRgE,IAAI,CAAC,CAAC,CAAC;EAAA,CACPC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;EAAA,CACnBA,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAC;AACxB;AAEA,OAAO,SAASC,OAAOA,CACrB/C,KAA4B,EAC5BG,OAA2B,EAC3B;EACA,MAAM;IAAE6B;EAAO,CAAC,GAAG7B,OAAO;EAE1B,MAAMjB,IAAI,GAAG8D,QAAQ,CAAChD,KAAK,EAAE,IAAIgC,MAAM,CAACnD,IAAI,EAAE,CAAC;EAE/C,IAAI,CAACK,IAAI,EAAE;IACT,MAAM1B,IAAI,CAACyF,QAAQ,CAAC,sBAAsBjB,MAAM,CAACnD,IAAI,EAAE,CAAC;EAC1D;EAEA,OAAOK,IAAI;AACb;AAEA,OAAO,SAAS8D,QAAQA,CAAChD,KAA4B,EAAEnB,IAAa,EAAE;EACpE,MAAMqE,QAAQ,GAAG,IAAIN,aAAa,CAAC/D,IAAI,CAAC,EAAE;EAC1C,OAAOmB,KAAK,EAAEjB,KAAK,CAACoE,IAAI,CAAC,CAAC;IAAEtE;EAAK,CAAC,KAAKA,IAAI,KAAKqE,QAAQ,CAAC;AAC3D;AAEA,OAAO,SAASE,YAAYA,CAACpD,KAAiB,EAAE;EAC9C,IAAIA,KAAK,EAAE7B,MAAM,KAAKb,MAAM,CAAC+F,EAAE,EAAE;IAC/B,MAAMC,SAAS,GAAGV,aAAa,CAAC5C,KAAK,CAACuD,GAAG,CAACxE,KAAK,CAACyE,EAAE,CAAC,CAAC,CAAC,EAAE3E,IAAI,CAAC;IAC5D,OAAOyE,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAGjG,cAAc,CAACoG,KAAK;EAC3D;EAEA,MAAMH,SAAS,GAAGV,aAAa,CAAC5C,KAAK,EAAEuD,GAAG,CAACG,SAAS,CAAC;EACrD,OAAOJ,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAGjG,cAAc,CAACoG,KAAK;AAC3D;AAEA,OAAO,SAASE,eAAeA,CAAC3B,MAAmB,EAAE;EACnD,MAAM4B,SAAS,GAAG,CAAC,CAAC5B,MAAM,EAAE6B,KAAK;EAEjC,IAAIA,KAAK,GAAG3F,UAAU,CAAC4F,IAAI;EAE3B,IAAIF,SAAS,IAAI5B,MAAM,CAAC6B,KAAK,KAAK3F,UAAU,CAAC6F,KAAK,EAAE;IAClDF,KAAK,GAAG3F,UAAU,CAAC6F,KAAK;EAC1B;EAEA,OAAO;IACLH,SAAS;IACTC;EACF,CAAC;AACH;AAEA,OAAO,SAASG,sCAAsCA,CACpDC,YAAgC,EAChCL,SAAkB,EAClB;EACA,IAAI,CAACK,YAAY,IAAI,CAACL,SAAS,EAAE;IAC/B,MAAMpG,IAAI,CAAC0G,QAAQ,CACjB,8DACF,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CACvBC,OAA+B,EACI;EACnC,IAAI,CAACA,OAAO,EAAEC,MAAM,EAAE;IACpB;EACF;EAEA,OAAOD,OAAO,CAACE,GAAG,CAACC,QAAQ,CAAC;AAC9B;AAEA,OAAO,SAASA,QAAQA,CAACC,MAA2B,EAAuB;EACzE,MAAM;IAAE9F,OAAO;IAAE+F,OAAO;IAAE5F;EAAK,CAAC,GAAG2F,MAAM;EAEzC,MAAMlF,IAAI,GAAGZ,OAAO,EAAEgG,GAAG,IAAI,EAAE;EAC/B,MAAMhC,IAAI,GAAG,IAAIpD,IAAI,EAAE;EAEvB,MAAMqF,IAAI,GAAGF,OAAO,CAAC3B,OAAO,CAC1B,0EAA0E,EACzE6B,IAAI,IAAKlH,MAAM,CAACC,QAAQ,CAACiH,IAAI,CAAC,EAAE,aAAa,CAChD,CAAC;EAED,OAAO;IACL9F,IAAI;IACJ6D,IAAI;IACJpD,IAAI;IACJqF,IAAI;IACJjG;EACF,CAAC;AACH;AAEA,OAAO,SAASkG,WAAWA,CAACC,aAAqB,EAAEJ,OAAe,EAAE;EAClE,OAAO;IACL/B,IAAI,EAAE,IAAImC,aAAa,EAAE;IACzBvF,IAAI,EAAEuF,aAAa;IACnBF,IAAI,EAAEF;EACR,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASK,0BAA0BA,CAACC,KAAa,EAAU;EAChE,MAAMC,aAAa,GAAG,IAAI,EAAC;EAC3B,MAAMC,YAAY,GAAG,KAAK,EAAC;EAC3B,MAAMC,KAAK,GAAGF,aAAa,GAAG,CAAC,KAAKD,KAAK,GAAG,CAAC,CAAC;EAC9C,OAAOI,IAAI,CAACC,GAAG,CAACF,KAAK,EAAED,YAAY,CAAC;AACtC;AAEA,OAAO,SAASrG,gBAAgBA,CAC9BJ,QAAgB,EAChBE,OAAoB,EACZ;EACR,MAAMD,OAAoB,GAAG;IAC3BC,OAAO;IACPK,KAAK,EAAEL,OAAO,CAAC2G,UAAU;IACzB7F,UAAU,EAAEd,OAAO,CAAC4G;EACtB,CAAC;;EAED;EACA,OAAOnH,MAAM,CAACoH,kBAAkB,CAAC/G,QAAQ,EAAEE,OAAO,CAACqB,aAAa,EAAE;IAChEtB;EACF,CAAC,CAAC;AACJ;AAEA,OAAO,SAAS+G,eAAeA,CAACC,MAAc,EAAE;EAC9C,OAAOC,gBAAgB,CAACD,MAAM,CAAC,CAACE,YAAY;AAC9C;AAEA,OAAO,SAASC,qBAAqBA,CAACH,MAAc,EAAE;EACpD,OAAOC,gBAAgB,CAACD,MAAM,CAAC,CAACI,WAAW;AAC7C;AAEA,OAAO,SAASH,gBAAgBA,CAACD,MAAc,EAAE;EAC/C,OAAOA,MAAM,CAACK,OAAO,CAAC,qBAAqB,CAAC;AAC9C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,oBAAoBA,CAAC3F,CAAkB,EAAE4F,SAAiB,EAAE;EAC1E,OAAO5F,CAAC,CAACY,QAAQ,CAACgF,SAAS,CAAC,CAACC,SAAS,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;AACrD;;AAEA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAC5BC,UAA4C,EACX;EACjC,OAAOA,UAAU,CAACC,QAAQ,GAAGvI,yBAAyB,CAAC;AAGzD","ignoreList":[]}
@@ -0,0 +1,39 @@
1
+ import { type JoiExpression } from 'joi';
2
+ /**
3
+ * Builds a set of translated Joi message templates for a given language.
4
+ * Called once per FormModel at construction time.
5
+ *
6
+ * Strings containing {{lowerFirst(#label)}} must be wrapped in joi.expression()
7
+ * because Joi cannot resolve custom functions from a plain string.
8
+ * Plain strings with only built-in tokens ({{#label}}, {{#limit}}) work without wrapping.
9
+ */
10
+ export declare function buildValidationMessages(t: (key: string) => string): {
11
+ required: JoiExpression;
12
+ selectRequired: JoiExpression;
13
+ pattern: JoiExpression;
14
+ format: JoiExpression;
15
+ declarationRequired: JoiExpression;
16
+ objectRequired: JoiExpression;
17
+ objectMissing: JoiExpression;
18
+ selectYesNoRequired: string;
19
+ max: string;
20
+ min: string;
21
+ minMax: string;
22
+ number: string;
23
+ numberPrecision: string;
24
+ numberInteger: string;
25
+ numberMin: string;
26
+ numberMax: string;
27
+ maxWords: string;
28
+ dateFormat: string;
29
+ dateMin: string;
30
+ dateMax: string;
31
+ unicode: string;
32
+ arrayMin: string;
33
+ arrayMax: string;
34
+ arrayLength: string;
35
+ featuresMin: string;
36
+ featuresMax: string;
37
+ featuresLength: string;
38
+ };
39
+ export type ValidationMessages = ReturnType<typeof buildValidationMessages>;
@@ -0,0 +1,50 @@
1
+ import joi from 'joi';
2
+ import { lowerFirstPreserveProperNouns } from "../components/helpers/index.js";
3
+ const opts = {
4
+ functions: {
5
+ lowerFirst: lowerFirstPreserveProperNouns
6
+ }
7
+ };
8
+
9
+ /**
10
+ * Builds a set of translated Joi message templates for a given language.
11
+ * Called once per FormModel at construction time.
12
+ *
13
+ * Strings containing {{lowerFirst(#label)}} must be wrapped in joi.expression()
14
+ * because Joi cannot resolve custom functions from a plain string.
15
+ * Plain strings with only built-in tokens ({{#label}}, {{#limit}}) work without wrapping.
16
+ */
17
+ export function buildValidationMessages(t) {
18
+ return {
19
+ // Expressions — contain lowerFirst custom function
20
+ required: joi.expression(t('validation.required'), opts),
21
+ selectRequired: joi.expression(t('validation.selectRequired'), opts),
22
+ pattern: joi.expression(t('validation.pattern'), opts),
23
+ format: joi.expression(t('validation.format'), opts),
24
+ declarationRequired: joi.expression(t('components.declarationField.validation.declarationRequired'), opts),
25
+ objectRequired: joi.expression(t('validation.objectRequired'), opts),
26
+ objectMissing: joi.expression(t('validation.objectMissing'), opts),
27
+ // Plain Joi template strings — no lowerFirst
28
+ selectYesNoRequired: t('components.yesNoField.validation.selectYesNoRequired'),
29
+ max: t('validation.max'),
30
+ min: t('validation.min'),
31
+ minMax: t('validation.minMax'),
32
+ number: t('validation.number'),
33
+ numberPrecision: t('validation.numberPrecision'),
34
+ numberInteger: t('validation.numberInteger'),
35
+ numberMin: t('validation.numberMin'),
36
+ numberMax: t('validation.numberMax'),
37
+ maxWords: t('validation.maxWords'),
38
+ dateFormat: t('components.dateField.validation.dateFormat'),
39
+ dateMin: t('components.dateField.validation.dateMin'),
40
+ dateMax: t('components.dateField.validation.dateMax'),
41
+ unicode: 'validation.unicode',
42
+ arrayMin: 'validation.array.min',
43
+ arrayMax: 'validation.array.max',
44
+ arrayLength: 'validation.array.length',
45
+ featuresMin: 'validation.features.min',
46
+ featuresMax: 'validation.features.max',
47
+ featuresLength: 'validation.features.length'
48
+ };
49
+ }
50
+ //# sourceMappingURL=buildValidationMessages.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"buildValidationMessages.js","names":["joi","lowerFirstPreserveProperNouns","opts","functions","lowerFirst","buildValidationMessages","t","required","expression","selectRequired","pattern","format","declarationRequired","objectRequired","objectMissing","selectYesNoRequired","max","min","minMax","number","numberPrecision","numberInteger","numberMin","numberMax","maxWords","dateFormat","dateMin","dateMax","unicode","arrayMin","arrayMax","arrayLength","featuresMin","featuresMax","featuresLength"],"sources":["../../../../../src/server/plugins/engine/i18n/buildValidationMessages.ts"],"sourcesContent":["import joi, { type JoiExpression, type ReferenceOptions } from 'joi'\n\nimport { lowerFirstPreserveProperNouns } from '~/src/server/plugins/engine/components/helpers/index.js'\n\nconst opts = {\n functions: {\n lowerFirst: lowerFirstPreserveProperNouns\n }\n} as ReferenceOptions\n\n/**\n * Builds a set of translated Joi message templates for a given language.\n * Called once per FormModel at construction time.\n *\n * Strings containing {{lowerFirst(#label)}} must be wrapped in joi.expression()\n * because Joi cannot resolve custom functions from a plain string.\n * Plain strings with only built-in tokens ({{#label}}, {{#limit}}) work without wrapping.\n */\nexport function buildValidationMessages(t: (key: string) => string) {\n return {\n // Expressions — contain lowerFirst custom function\n required: joi.expression(t('validation.required'), opts) as JoiExpression,\n selectRequired: joi.expression(\n t('validation.selectRequired'),\n opts\n ) as JoiExpression,\n pattern: joi.expression(t('validation.pattern'), opts) as JoiExpression,\n format: joi.expression(t('validation.format'), opts) as JoiExpression,\n declarationRequired: joi.expression(\n t('components.declarationField.validation.declarationRequired'),\n opts\n ) as JoiExpression,\n objectRequired: joi.expression(\n t('validation.objectRequired'),\n opts\n ) as JoiExpression,\n objectMissing: joi.expression(\n t('validation.objectMissing'),\n opts\n ) as JoiExpression,\n\n // Plain Joi template strings — no lowerFirst\n selectYesNoRequired: t(\n 'components.yesNoField.validation.selectYesNoRequired'\n ),\n max: t('validation.max'),\n min: t('validation.min'),\n minMax: t('validation.minMax'),\n number: t('validation.number'),\n numberPrecision: t('validation.numberPrecision'),\n numberInteger: t('validation.numberInteger'),\n numberMin: t('validation.numberMin'),\n numberMax: t('validation.numberMax'),\n maxWords: t('validation.maxWords'),\n dateFormat: t('components.dateField.validation.dateFormat'),\n dateMin: t('components.dateField.validation.dateMin'),\n dateMax: t('components.dateField.validation.dateMax'),\n\n unicode: 'validation.unicode',\n arrayMin: 'validation.array.min',\n arrayMax: 'validation.array.max',\n arrayLength: 'validation.array.length',\n featuresMin: 'validation.features.min',\n featuresMax: 'validation.features.max',\n featuresLength: 'validation.features.length'\n }\n}\n\nexport type ValidationMessages = ReturnType<typeof buildValidationMessages>\n"],"mappings":"AAAA,OAAOA,GAAG,MAAqD,KAAK;AAEpE,SAASC,6BAA6B;AAEtC,MAAMC,IAAI,GAAG;EACXC,SAAS,EAAE;IACTC,UAAU,EAAEH;EACd;AACF,CAAqB;;AAErB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,uBAAuBA,CAACC,CAA0B,EAAE;EAClE,OAAO;IACL;IACAC,QAAQ,EAAEP,GAAG,CAACQ,UAAU,CAACF,CAAC,CAAC,qBAAqB,CAAC,EAAEJ,IAAI,CAAkB;IACzEO,cAAc,EAAET,GAAG,CAACQ,UAAU,CAC5BF,CAAC,CAAC,2BAA2B,CAAC,EAC9BJ,IACF,CAAkB;IAClBQ,OAAO,EAAEV,GAAG,CAACQ,UAAU,CAACF,CAAC,CAAC,oBAAoB,CAAC,EAAEJ,IAAI,CAAkB;IACvES,MAAM,EAAEX,GAAG,CAACQ,UAAU,CAACF,CAAC,CAAC,mBAAmB,CAAC,EAAEJ,IAAI,CAAkB;IACrEU,mBAAmB,EAAEZ,GAAG,CAACQ,UAAU,CACjCF,CAAC,CAAC,4DAA4D,CAAC,EAC/DJ,IACF,CAAkB;IAClBW,cAAc,EAAEb,GAAG,CAACQ,UAAU,CAC5BF,CAAC,CAAC,2BAA2B,CAAC,EAC9BJ,IACF,CAAkB;IAClBY,aAAa,EAAEd,GAAG,CAACQ,UAAU,CAC3BF,CAAC,CAAC,0BAA0B,CAAC,EAC7BJ,IACF,CAAkB;IAElB;IACAa,mBAAmB,EAAET,CAAC,CACpB,sDACF,CAAC;IACDU,GAAG,EAAEV,CAAC,CAAC,gBAAgB,CAAC;IACxBW,GAAG,EAAEX,CAAC,CAAC,gBAAgB,CAAC;IACxBY,MAAM,EAAEZ,CAAC,CAAC,mBAAmB,CAAC;IAC9Ba,MAAM,EAAEb,CAAC,CAAC,mBAAmB,CAAC;IAC9Bc,eAAe,EAAEd,CAAC,CAAC,4BAA4B,CAAC;IAChDe,aAAa,EAAEf,CAAC,CAAC,0BAA0B,CAAC;IAC5CgB,SAAS,EAAEhB,CAAC,CAAC,sBAAsB,CAAC;IACpCiB,SAAS,EAAEjB,CAAC,CAAC,sBAAsB,CAAC;IACpCkB,QAAQ,EAAElB,CAAC,CAAC,qBAAqB,CAAC;IAClCmB,UAAU,EAAEnB,CAAC,CAAC,4CAA4C,CAAC;IAC3DoB,OAAO,EAAEpB,CAAC,CAAC,yCAAyC,CAAC;IACrDqB,OAAO,EAAErB,CAAC,CAAC,yCAAyC,CAAC;IAErDsB,OAAO,EAAE,oBAAoB;IAC7BC,QAAQ,EAAE,sBAAsB;IAChCC,QAAQ,EAAE,sBAAsB;IAChCC,WAAW,EAAE,yBAAyB;IACtCC,WAAW,EAAE,yBAAyB;IACtCC,WAAW,EAAE,yBAAyB;IACtCC,cAAc,EAAE;EAClB,CAAC;AACH","ignoreList":[]}
@@ -0,0 +1,5 @@
1
+ import { type FormDefinition } from '@defra/forms-model';
2
+ import { type i18n } from 'i18next';
3
+ import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
4
+ export declare function createFormTranslator(def: FormDefinition, language: string): Translator;
5
+ export declare function loadFormTranslations(def: FormDefinition, i18nInstance: i18n): void;
@@ -0,0 +1,18 @@
1
+ import { createTranslator } from "./createTranslator.js";
2
+ import { extractBaseTranslations } from "./extractBaseTranslations.js";
3
+ import { createFormI18nInstance } from "./index.js";
4
+ export function createFormTranslator(def, language) {
5
+ const baseTranslations = extractBaseTranslations(def);
6
+ const i18nInstance = createFormI18nInstance(baseTranslations);
7
+ loadFormTranslations(def, i18nInstance);
8
+ return createTranslator(i18nInstance, language);
9
+ }
10
+ export function loadFormTranslations(def, i18nInstance) {
11
+ const formTranslations = def.metadata?.translations;
12
+ if (formTranslations) {
13
+ for (const [lng, resources] of Object.entries(formTranslations)) {
14
+ i18nInstance.addResourceBundle(lng, 'form', resources, true, true);
15
+ }
16
+ }
17
+ }
18
+ //# sourceMappingURL=createFormTranslator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createFormTranslator.js","names":["createTranslator","extractBaseTranslations","createFormI18nInstance","createFormTranslator","def","language","baseTranslations","i18nInstance","loadFormTranslations","formTranslations","metadata","translations","lng","resources","Object","entries","addResourceBundle"],"sources":["../../../../../src/server/plugins/engine/i18n/createFormTranslator.ts"],"sourcesContent":["import { type FormDefinition } from '@defra/forms-model'\nimport { type i18n } from 'i18next'\n\nimport { createTranslator } from '~/src/server/plugins/engine/i18n/createTranslator.js'\nimport { extractBaseTranslations } from '~/src/server/plugins/engine/i18n/extractBaseTranslations.js'\nimport { createFormI18nInstance } from '~/src/server/plugins/engine/i18n/index.js'\nimport {\n type FormDefinitionTranslations,\n type Translator\n} from '~/src/server/plugins/engine/i18n/types.js'\n\nexport function createFormTranslator(\n def: FormDefinition,\n language: string\n): Translator {\n const baseTranslations = extractBaseTranslations(def)\n const i18nInstance = createFormI18nInstance(baseTranslations)\n loadFormTranslations(def, i18nInstance)\n\n return createTranslator(i18nInstance, language)\n}\n\nexport function loadFormTranslations(def: FormDefinition, i18nInstance: i18n) {\n const formTranslations = def.metadata?.translations as\n | FormDefinitionTranslations\n | undefined\n\n if (formTranslations) {\n for (const [lng, resources] of Object.entries(formTranslations)) {\n i18nInstance.addResourceBundle(lng, 'form', resources, true, true)\n }\n }\n}\n"],"mappings":"AAGA,SAASA,gBAAgB;AACzB,SAASC,uBAAuB;AAChC,SAASC,sBAAsB;AAM/B,OAAO,SAASC,oBAAoBA,CAClCC,GAAmB,EACnBC,QAAgB,EACJ;EACZ,MAAMC,gBAAgB,GAAGL,uBAAuB,CAACG,GAAG,CAAC;EACrD,MAAMG,YAAY,GAAGL,sBAAsB,CAACI,gBAAgB,CAAC;EAC7DE,oBAAoB,CAACJ,GAAG,EAAEG,YAAY,CAAC;EAEvC,OAAOP,gBAAgB,CAACO,YAAY,EAAEF,QAAQ,CAAC;AACjD;AAEA,OAAO,SAASG,oBAAoBA,CAACJ,GAAmB,EAAEG,YAAkB,EAAE;EAC5E,MAAME,gBAAgB,GAAGL,GAAG,CAACM,QAAQ,EAAEC,YAE1B;EAEb,IAAIF,gBAAgB,EAAE;IACpB,KAAK,MAAM,CAACG,GAAG,EAAEC,SAAS,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACN,gBAAgB,CAAC,EAAE;MAC/DF,YAAY,CAACS,iBAAiB,CAACJ,GAAG,EAAE,MAAM,EAAEC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC;IACpE;EACF;AACF","ignoreList":[]}
@@ -0,0 +1,9 @@
1
+ import { type i18n } from 'i18next';
2
+ import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
3
+ /**
4
+ * Creates a translator for the specified language, decorated with utility functions
5
+ * for translating specific parts of the form definition.
6
+ * @param i18nInstance - instance of i18next which gets created on startup (reads the boilerplate files en-GB.json and cy.json)
7
+ * @param language - requested language
8
+ */
9
+ export declare function createTranslator(i18nInstance: i18n, language?: string): Translator;
@@ -0,0 +1,51 @@
1
+ /**
2
+ * Creates a translator for the specified language, decorated with utility functions
3
+ * for translating specific parts of the form definition.
4
+ * @param i18nInstance - instance of i18next which gets created on startup (reads the boilerplate files en-GB.json and cy.json)
5
+ * @param language - requested language
6
+ */
7
+ export function createTranslator(i18nInstance, language = 'en-GB') {
8
+ const t = (key, opts) => i18nInstance.t(key, {
9
+ lng: language,
10
+ ns: 'plugin',
11
+ ...opts
12
+ });
13
+ const resolveContent = (entity, entityType, prop) => {
14
+ if (!entity.id) {
15
+ const raw = entity[prop];
16
+ if (typeof raw !== 'string') return '';
17
+ // t() resolves i18next key constants (sub-field labels); returns raw string unchanged if not a key
18
+ return t(raw);
19
+ }
20
+ const key = `${entityType}.${entity.id}.${prop}`;
21
+ const result = i18nInstance.t(key, {
22
+ lng: language,
23
+ ns: 'form'
24
+ });
25
+ if (result === key) {
26
+ // No form translation found — fall through to t(raw) so plugin i18n
27
+ // key constants (e.g. 'components.yesNoField.yes') are still resolved.
28
+ const raw = entity[prop];
29
+ if (typeof raw !== 'string') return '';
30
+ return t(raw);
31
+ }
32
+ return result;
33
+ };
34
+ const resolveFormContent = prop => {
35
+ const key = `form.${prop}`;
36
+ return i18nInstance.t(key, {
37
+ lng: language,
38
+ ns: 'form'
39
+ });
40
+ };
41
+ return {
42
+ t,
43
+ tForm: prop => resolveFormContent(prop),
44
+ tPage: (entity, prop) => resolveContent(entity, 'pages', prop),
45
+ tComponent: (entity, prop) => resolveContent(entity, 'components', prop),
46
+ tSection: (entity, prop) => resolveContent(entity, 'sections', prop),
47
+ tListItem: (entity, prop) => resolveContent(entity, 'listItems', prop),
48
+ language
49
+ };
50
+ }
51
+ //# sourceMappingURL=createTranslator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createTranslator.js","names":["createTranslator","i18nInstance","language","t","key","opts","lng","ns","resolveContent","entity","entityType","prop","id","raw","result","resolveFormContent","tForm","tPage","tComponent","tSection","tListItem"],"sources":["../../../../../src/server/plugins/engine/i18n/createTranslator.ts"],"sourcesContent":["import { type i18n } from 'i18next'\n\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\n\n/**\n * Creates a translator for the specified language, decorated with utility functions\n * for translating specific parts of the form definition.\n * @param i18nInstance - instance of i18next which gets created on startup (reads the boilerplate files en-GB.json and cy.json)\n * @param language - requested language\n */\nexport function createTranslator(\n i18nInstance: i18n,\n language = 'en-GB'\n): Translator {\n const t = (key: string, opts?: Record<string, unknown>): string =>\n i18nInstance.t(key, { lng: language, ns: 'plugin', ...opts })\n\n const resolveContent = (\n entity: { id?: string },\n entityType: string,\n prop: string\n ): string => {\n if (!entity.id) {\n const raw = (entity as Record<string, unknown>)[prop]\n if (typeof raw !== 'string') return ''\n // t() resolves i18next key constants (sub-field labels); returns raw string unchanged if not a key\n return t(raw)\n }\n const key = `${entityType}.${entity.id}.${prop}`\n const result = i18nInstance.t(key, {\n lng: language,\n ns: 'form'\n })\n if (result === key) {\n // No form translation found — fall through to t(raw) so plugin i18n\n // key constants (e.g. 'components.yesNoField.yes') are still resolved.\n const raw = (entity as Record<string, unknown>)[prop]\n if (typeof raw !== 'string') return ''\n return t(raw)\n }\n return result\n }\n\n const resolveFormContent = (prop: string) => {\n const key = `form.${prop}`\n return i18nInstance.t(key, { lng: language, ns: 'form' })\n }\n\n return {\n t,\n tForm: (prop) => resolveFormContent(prop),\n tPage: (entity, prop) => resolveContent(entity, 'pages', prop as string),\n tComponent: (entity, prop) =>\n resolveContent(entity, 'components', prop as string),\n tSection: (entity, prop) =>\n resolveContent(entity, 'sections', prop as string),\n tListItem: (entity, prop) =>\n resolveContent(entity, 'listItems', prop as string),\n language\n }\n}\n"],"mappings":"AAIA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,gBAAgBA,CAC9BC,YAAkB,EAClBC,QAAQ,GAAG,OAAO,EACN;EACZ,MAAMC,CAAC,GAAGA,CAACC,GAAW,EAAEC,IAA8B,KACpDJ,YAAY,CAACE,CAAC,CAACC,GAAG,EAAE;IAAEE,GAAG,EAAEJ,QAAQ;IAAEK,EAAE,EAAE,QAAQ;IAAE,GAAGF;EAAK,CAAC,CAAC;EAE/D,MAAMG,cAAc,GAAGA,CACrBC,MAAuB,EACvBC,UAAkB,EAClBC,IAAY,KACD;IACX,IAAI,CAACF,MAAM,CAACG,EAAE,EAAE;MACd,MAAMC,GAAG,GAAIJ,MAAM,CAA6BE,IAAI,CAAC;MACrD,IAAI,OAAOE,GAAG,KAAK,QAAQ,EAAE,OAAO,EAAE;MACtC;MACA,OAAOV,CAAC,CAACU,GAAG,CAAC;IACf;IACA,MAAMT,GAAG,GAAG,GAAGM,UAAU,IAAID,MAAM,CAACG,EAAE,IAAID,IAAI,EAAE;IAChD,MAAMG,MAAM,GAAGb,YAAY,CAACE,CAAC,CAACC,GAAG,EAAE;MACjCE,GAAG,EAAEJ,QAAQ;MACbK,EAAE,EAAE;IACN,CAAC,CAAC;IACF,IAAIO,MAAM,KAAKV,GAAG,EAAE;MAClB;MACA;MACA,MAAMS,GAAG,GAAIJ,MAAM,CAA6BE,IAAI,CAAC;MACrD,IAAI,OAAOE,GAAG,KAAK,QAAQ,EAAE,OAAO,EAAE;MACtC,OAAOV,CAAC,CAACU,GAAG,CAAC;IACf;IACA,OAAOC,MAAM;EACf,CAAC;EAED,MAAMC,kBAAkB,GAAIJ,IAAY,IAAK;IAC3C,MAAMP,GAAG,GAAG,QAAQO,IAAI,EAAE;IAC1B,OAAOV,YAAY,CAACE,CAAC,CAACC,GAAG,EAAE;MAAEE,GAAG,EAAEJ,QAAQ;MAAEK,EAAE,EAAE;IAAO,CAAC,CAAC;EAC3D,CAAC;EAED,OAAO;IACLJ,CAAC;IACDa,KAAK,EAAGL,IAAI,IAAKI,kBAAkB,CAACJ,IAAI,CAAC;IACzCM,KAAK,EAAEA,CAACR,MAAM,EAAEE,IAAI,KAAKH,cAAc,CAACC,MAAM,EAAE,OAAO,EAAEE,IAAc,CAAC;IACxEO,UAAU,EAAEA,CAACT,MAAM,EAAEE,IAAI,KACvBH,cAAc,CAACC,MAAM,EAAE,YAAY,EAAEE,IAAc,CAAC;IACtDQ,QAAQ,EAAEA,CAACV,MAAM,EAAEE,IAAI,KACrBH,cAAc,CAACC,MAAM,EAAE,UAAU,EAAEE,IAAc,CAAC;IACpDS,SAAS,EAAEA,CAACX,MAAM,EAAEE,IAAI,KACtBH,cAAc,CAACC,MAAM,EAAE,WAAW,EAAEE,IAAc,CAAC;IACrDT;EACF,CAAC;AACH","ignoreList":[]}
@@ -0,0 +1,5 @@
1
+ import { type FormDefinition } from '@defra/forms-model';
2
+ import { type FormDefinitionTranslations } from '../../../../server/plugins/engine/i18n/types.js';
3
+ type BaseTranslations = FormDefinitionTranslations[string];
4
+ export declare function extractBaseTranslations(def: FormDefinition): BaseTranslations;
5
+ export {};
@@ -0,0 +1,57 @@
1
+ import { hasComponentsEvenIfNoNext } from '@defra/forms-model';
2
+ export function extractBaseTranslations(def) {
3
+ const pages = {};
4
+ const components = {};
5
+ const sections = {};
6
+ const listItems = {};
7
+ const form = {};
8
+ for (const page of def.pages) {
9
+ if (page.id && page.title) {
10
+ pages[page.id] = {
11
+ title: page.title
12
+ };
13
+ }
14
+ if (hasComponentsEvenIfNoNext(page)) {
15
+ for (const component of page.components) {
16
+ if (!component.id) continue;
17
+ const entry = {};
18
+ if (component.title) entry.title = component.title;
19
+ if ('hint' in component && component.hint) entry.hint = component.hint;
20
+ if ('content' in component && component.content) {
21
+ entry.content = component.content;
22
+ }
23
+ if ('shortDescription' in component && component.shortDescription) {
24
+ entry.shortDescription = component.shortDescription;
25
+ }
26
+ if (Object.keys(entry).length) {
27
+ components[component.id] = entry;
28
+ }
29
+ }
30
+ }
31
+ }
32
+ for (const section of def.sections) {
33
+ if (section.id && section.title) {
34
+ sections[section.id] = {
35
+ title: section.title
36
+ };
37
+ }
38
+ }
39
+ for (const list of def.lists) {
40
+ for (const item of list.items) {
41
+ if (item.id && item.text) {
42
+ listItems[item.id] = {
43
+ text: item.text
44
+ };
45
+ }
46
+ }
47
+ }
48
+ form.title = def.name ?? '';
49
+ return {
50
+ pages,
51
+ components,
52
+ sections,
53
+ listItems,
54
+ form
55
+ };
56
+ }
57
+ //# sourceMappingURL=extractBaseTranslations.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extractBaseTranslations.js","names":["hasComponentsEvenIfNoNext","extractBaseTranslations","def","pages","components","sections","listItems","form","page","id","title","component","entry","hint","content","shortDescription","Object","keys","length","section","list","lists","item","items","text","name"],"sources":["../../../../../src/server/plugins/engine/i18n/extractBaseTranslations.ts"],"sourcesContent":["import {\n hasComponentsEvenIfNoNext,\n type FormDefinition\n} from '@defra/forms-model'\n\nimport { type FormDefinitionTranslations } from '~/src/server/plugins/engine/i18n/types.js'\n\ntype BaseTranslations = FormDefinitionTranslations[string]\n\nexport function extractBaseTranslations(def: FormDefinition): BaseTranslations {\n const pages: BaseTranslations['pages'] = {}\n const components: BaseTranslations['components'] = {}\n const sections: BaseTranslations['sections'] = {}\n const listItems: BaseTranslations['listItems'] = {}\n const form: BaseTranslations['form'] = {}\n\n for (const page of def.pages) {\n if (page.id && page.title) {\n pages[page.id] = { title: page.title }\n }\n\n if (hasComponentsEvenIfNoNext(page)) {\n for (const component of page.components) {\n if (!component.id) continue\n\n const entry: BaseTranslations['components'][string] = {}\n\n if (component.title) entry.title = component.title\n if ('hint' in component && component.hint) entry.hint = component.hint\n if ('content' in component && component.content) {\n entry.content = component.content\n }\n if ('shortDescription' in component && component.shortDescription) {\n entry.shortDescription = component.shortDescription\n }\n\n if (Object.keys(entry).length) {\n components[component.id] = entry\n }\n }\n }\n }\n\n for (const section of def.sections) {\n if (section.id && section.title) {\n sections[section.id] = { title: section.title }\n }\n }\n\n for (const list of def.lists) {\n for (const item of list.items) {\n if (item.id && item.text) {\n listItems[item.id] = { text: item.text }\n }\n }\n }\n\n form.title = def.name ?? ''\n\n return { pages, components, sections, listItems, form }\n}\n"],"mappings":"AAAA,SACEA,yBAAyB,QAEpB,oBAAoB;AAM3B,OAAO,SAASC,uBAAuBA,CAACC,GAAmB,EAAoB;EAC7E,MAAMC,KAAgC,GAAG,CAAC,CAAC;EAC3C,MAAMC,UAA0C,GAAG,CAAC,CAAC;EACrD,MAAMC,QAAsC,GAAG,CAAC,CAAC;EACjD,MAAMC,SAAwC,GAAG,CAAC,CAAC;EACnD,MAAMC,IAA8B,GAAG,CAAC,CAAC;EAEzC,KAAK,MAAMC,IAAI,IAAIN,GAAG,CAACC,KAAK,EAAE;IAC5B,IAAIK,IAAI,CAACC,EAAE,IAAID,IAAI,CAACE,KAAK,EAAE;MACzBP,KAAK,CAACK,IAAI,CAACC,EAAE,CAAC,GAAG;QAAEC,KAAK,EAAEF,IAAI,CAACE;MAAM,CAAC;IACxC;IAEA,IAAIV,yBAAyB,CAACQ,IAAI,CAAC,EAAE;MACnC,KAAK,MAAMG,SAAS,IAAIH,IAAI,CAACJ,UAAU,EAAE;QACvC,IAAI,CAACO,SAAS,CAACF,EAAE,EAAE;QAEnB,MAAMG,KAA6C,GAAG,CAAC,CAAC;QAExD,IAAID,SAAS,CAACD,KAAK,EAAEE,KAAK,CAACF,KAAK,GAAGC,SAAS,CAACD,KAAK;QAClD,IAAI,MAAM,IAAIC,SAAS,IAAIA,SAAS,CAACE,IAAI,EAAED,KAAK,CAACC,IAAI,GAAGF,SAAS,CAACE,IAAI;QACtE,IAAI,SAAS,IAAIF,SAAS,IAAIA,SAAS,CAACG,OAAO,EAAE;UAC/CF,KAAK,CAACE,OAAO,GAAGH,SAAS,CAACG,OAAO;QACnC;QACA,IAAI,kBAAkB,IAAIH,SAAS,IAAIA,SAAS,CAACI,gBAAgB,EAAE;UACjEH,KAAK,CAACG,gBAAgB,GAAGJ,SAAS,CAACI,gBAAgB;QACrD;QAEA,IAAIC,MAAM,CAACC,IAAI,CAACL,KAAK,CAAC,CAACM,MAAM,EAAE;UAC7Bd,UAAU,CAACO,SAAS,CAACF,EAAE,CAAC,GAAGG,KAAK;QAClC;MACF;IACF;EACF;EAEA,KAAK,MAAMO,OAAO,IAAIjB,GAAG,CAACG,QAAQ,EAAE;IAClC,IAAIc,OAAO,CAACV,EAAE,IAAIU,OAAO,CAACT,KAAK,EAAE;MAC/BL,QAAQ,CAACc,OAAO,CAACV,EAAE,CAAC,GAAG;QAAEC,KAAK,EAAES,OAAO,CAACT;MAAM,CAAC;IACjD;EACF;EAEA,KAAK,MAAMU,IAAI,IAAIlB,GAAG,CAACmB,KAAK,EAAE;IAC5B,KAAK,MAAMC,IAAI,IAAIF,IAAI,CAACG,KAAK,EAAE;MAC7B,IAAID,IAAI,CAACb,EAAE,IAAIa,IAAI,CAACE,IAAI,EAAE;QACxBlB,SAAS,CAACgB,IAAI,CAACb,EAAE,CAAC,GAAG;UAAEe,IAAI,EAAEF,IAAI,CAACE;QAAK,CAAC;MAC1C;IACF;EACF;EAEAjB,IAAI,CAACG,KAAK,GAAGR,GAAG,CAACuB,IAAI,IAAI,EAAE;EAE3B,OAAO;IAAEtB,KAAK;IAAEC,UAAU;IAAEC,QAAQ;IAAEC,SAAS;IAAEC;EAAK,CAAC;AACzD","ignoreList":[]}
@@ -0,0 +1,18 @@
1
+ import { type FormDefinitionTranslations } from '../../../../server/plugins/engine/i18n/types.js';
2
+ type BaseTranslations = FormDefinitionTranslations[string];
3
+ /**
4
+ * Generic translation utility function
5
+ * @param key - key for lookup
6
+ * @param language - language requested
7
+ * @param options
8
+ * @returns {string}
9
+ */
10
+ export declare function t(key: string, language: string, options?: Record<string, unknown>): string;
11
+ /**
12
+ * Creates an instance of i18next with base (boilerplate) translation files loaded (en-GB.json and cy.json),
13
+ * and appropriate namespaces for loading of form-specific translations later
14
+ * @param formEnGb
15
+ * @returns
16
+ */
17
+ export declare function createFormI18nInstance(formEnGb: BaseTranslations): import("i18next", { with: { "resolution-mode": "require" } }).i18n;
18
+ export {};
@@ -0,0 +1,71 @@
1
+ import { getErrorMessage } from '@defra/forms-model';
2
+ import i18next, { createInstance } from 'i18next';
3
+ import { logger } from "../../../common/helpers/logging/logger.js";
4
+ import cy from "./translations/cy.json" with { type: 'json' };
5
+ import enGB from "./translations/en-GB.json" with { type: 'json' };
6
+ i18next.init({
7
+ resources: {
8
+ 'en-GB': {
9
+ translation: enGB
10
+ },
11
+ cy: {
12
+ translation: cy
13
+ }
14
+ },
15
+ fallbackLng: 'en-GB',
16
+ interpolation: {
17
+ prefix: '[[',
18
+ suffix: ']]',
19
+ escapeValue: false
20
+ }
21
+ }).catch(err => {
22
+ logger.error(`Fatal init for translator i18next: ${getErrorMessage(err)}`);
23
+ });
24
+
25
+ /**
26
+ * Generic translation utility function
27
+ * @param key - key for lookup
28
+ * @param language - language requested
29
+ * @param options
30
+ * @returns {string}
31
+ */
32
+ export function t(key, language, options) {
33
+ return i18next.t(key, {
34
+ lng: language,
35
+ ...options
36
+ });
37
+ }
38
+
39
+ /**
40
+ * Creates an instance of i18next with base (boilerplate) translation files loaded (en-GB.json and cy.json),
41
+ * and appropriate namespaces for loading of form-specific translations later
42
+ * @param formEnGb
43
+ * @returns
44
+ */
45
+ export function createFormI18nInstance(formEnGb) {
46
+ const instance = createInstance();
47
+ instance.init({
48
+ resources: {
49
+ 'en-GB': {
50
+ plugin: enGB,
51
+ form: formEnGb
52
+ },
53
+ cy: {
54
+ plugin: cy
55
+ }
56
+ },
57
+ fallbackLng: 'en-GB',
58
+ ns: ['plugin', 'form'],
59
+ defaultNS: 'plugin',
60
+ interpolation: {
61
+ prefix: '[[',
62
+ suffix: ']]',
63
+ escapeValue: false
64
+ }
65
+ }).catch(err => {
66
+ // init with inline resources completes synchronously — unreachable
67
+ logger.error(`Fatal init for translator instance: ${getErrorMessage(err)}`);
68
+ });
69
+ return instance;
70
+ }
71
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","names":["getErrorMessage","i18next","createInstance","logger","cy","type","enGB","init","resources","translation","fallbackLng","interpolation","prefix","suffix","escapeValue","catch","err","error","t","key","language","options","lng","createFormI18nInstance","formEnGb","instance","plugin","form","ns","defaultNS"],"sources":["../../../../../src/server/plugins/engine/i18n/index.ts"],"sourcesContent":["import { getErrorMessage } from '@defra/forms-model'\nimport i18next, { createInstance } from 'i18next'\n\nimport { logger } from '~/src/server/common/helpers/logging/logger.js'\nimport cy from '~/src/server/plugins/engine/i18n/translations/cy.json' with { type: 'json' }\nimport enGB from '~/src/server/plugins/engine/i18n/translations/en-GB.json' with { type: 'json' }\nimport { type FormDefinitionTranslations } from '~/src/server/plugins/engine/i18n/types.js'\n\ntype BaseTranslations = FormDefinitionTranslations[string]\n\ni18next\n .init({\n resources: {\n 'en-GB': { translation: enGB },\n cy: { translation: cy }\n },\n fallbackLng: 'en-GB',\n interpolation: {\n prefix: '[[',\n suffix: ']]',\n escapeValue: false\n }\n })\n .catch((err: unknown) => {\n logger.error(`Fatal init for translator i18next: ${getErrorMessage(err)}`)\n })\n\n/**\n * Generic translation utility function\n * @param key - key for lookup\n * @param language - language requested\n * @param options\n * @returns {string}\n */\nexport function t(\n key: string,\n language: string,\n options?: Record<string, unknown>\n): string {\n return i18next.t(key, { lng: language, ...options })\n}\n\n/**\n * Creates an instance of i18next with base (boilerplate) translation files loaded (en-GB.json and cy.json),\n * and appropriate namespaces for loading of form-specific translations later\n * @param formEnGb\n * @returns\n */\nexport function createFormI18nInstance(formEnGb: BaseTranslations) {\n const instance = createInstance()\n\n instance\n .init({\n resources: {\n 'en-GB': {\n plugin: enGB,\n form: formEnGb\n },\n cy: {\n plugin: cy\n }\n },\n fallbackLng: 'en-GB',\n ns: ['plugin', 'form'],\n defaultNS: 'plugin',\n interpolation: {\n prefix: '[[',\n suffix: ']]',\n escapeValue: false\n }\n })\n .catch((err: unknown) => {\n // init with inline resources completes synchronously — unreachable\n logger.error(\n `Fatal init for translator instance: ${getErrorMessage(err)}`\n )\n })\n\n return instance\n}\n"],"mappings":"AAAA,SAASA,eAAe,QAAQ,oBAAoB;AACpD,OAAOC,OAAO,IAAIC,cAAc,QAAQ,SAAS;AAEjD,SAASC,MAAM;AACf,OAAOC,EAAE,sCAAqEC,IAAI,EAAE,MAAM;AAC1F,OAAOC,IAAI,yCAAwED,IAAI,EAAE,MAAM;AAK/FJ,OAAO,CACJM,IAAI,CAAC;EACJC,SAAS,EAAE;IACT,OAAO,EAAE;MAAEC,WAAW,EAAEH;IAAK,CAAC;IAC9BF,EAAE,EAAE;MAAEK,WAAW,EAAEL;IAAG;EACxB,CAAC;EACDM,WAAW,EAAE,OAAO;EACpBC,aAAa,EAAE;IACbC,MAAM,EAAE,IAAI;IACZC,MAAM,EAAE,IAAI;IACZC,WAAW,EAAE;EACf;AACF,CAAC,CAAC,CACDC,KAAK,CAAEC,GAAY,IAAK;EACvBb,MAAM,CAACc,KAAK,CAAC,sCAAsCjB,eAAe,CAACgB,GAAG,CAAC,EAAE,CAAC;AAC5E,CAAC,CAAC;;AAEJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,CAACA,CACfC,GAAW,EACXC,QAAgB,EAChBC,OAAiC,EACzB;EACR,OAAOpB,OAAO,CAACiB,CAAC,CAACC,GAAG,EAAE;IAAEG,GAAG,EAAEF,QAAQ;IAAE,GAAGC;EAAQ,CAAC,CAAC;AACtD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,sBAAsBA,CAACC,QAA0B,EAAE;EACjE,MAAMC,QAAQ,GAAGvB,cAAc,CAAC,CAAC;EAEjCuB,QAAQ,CACLlB,IAAI,CAAC;IACJC,SAAS,EAAE;MACT,OAAO,EAAE;QACPkB,MAAM,EAAEpB,IAAI;QACZqB,IAAI,EAAEH;MACR,CAAC;MACDpB,EAAE,EAAE;QACFsB,MAAM,EAAEtB;MACV;IACF,CAAC;IACDM,WAAW,EAAE,OAAO;IACpBkB,EAAE,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;IACtBC,SAAS,EAAE,QAAQ;IACnBlB,aAAa,EAAE;MACbC,MAAM,EAAE,IAAI;MACZC,MAAM,EAAE,IAAI;MACZC,WAAW,EAAE;IACf;EACF,CAAC,CAAC,CACDC,KAAK,CAAEC,GAAY,IAAK;IACvB;IACAb,MAAM,CAACc,KAAK,CACV,uCAAuCjB,eAAe,CAACgB,GAAG,CAAC,EAC7D,CAAC;EACH,CAAC,CAAC;EAEJ,OAAOS,QAAQ;AACjB","ignoreList":[]}