@defra/forms-engine-plugin 5.0.0-alpha.2 → 5.0.0-alpha.21
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.
- package/.public/javascripts/application.min.js +1 -1
- package/.public/javascripts/application.min.js.LICENSE.txt +7 -0
- package/.public/javascripts/application.min.js.map +1 -1
- package/.public/javascripts/shared.min.js +1 -1
- package/.public/javascripts/shared.min.js.LICENSE.txt +7 -0
- package/.public/javascripts/shared.min.js.map +1 -1
- package/.public/stylesheets/application.min.css.map +1 -1
- package/.server/client/javascripts/file-upload.js +6 -3
- package/.server/client/javascripts/file-upload.js.map +1 -1
- package/.server/client/javascripts/geospatial-map.d.ts +153 -5
- package/.server/client/javascripts/geospatial-map.js +157 -77
- package/.server/client/javascripts/geospatial-map.js.map +1 -1
- package/.server/client/javascripts/govuk.js +2 -1
- package/.server/client/javascripts/govuk.js.map +1 -1
- package/.server/client/javascripts/location-map.d.ts +44 -0
- package/.server/client/javascripts/location-map.js +54 -5
- package/.server/client/javascripts/location-map.js.map +1 -1
- package/.server/client/javascripts/map-constants.d.ts +3 -0
- package/.server/client/javascripts/map-constants.js +4 -0
- package/.server/client/javascripts/map-constants.js.map +1 -0
- package/.server/client/javascripts/map.d.ts +10 -0
- package/.server/client/javascripts/map.js +42 -0
- package/.server/client/javascripts/map.js.map +1 -1
- package/.server/client/javascripts/maps.d.ts +5 -0
- package/.server/client/javascripts/maps.js +6 -0
- package/.server/client/javascripts/maps.js.map +1 -0
- package/.server/client/javascripts/shared.d.ts +1 -4
- package/.server/client/javascripts/shared.js +1 -4
- package/.server/client/javascripts/shared.js.map +1 -1
- package/.server/client/javascripts/sssi-dataset.d.ts +18 -20
- package/.server/client/javascripts/sssi-dataset.js +37 -39
- package/.server/client/javascripts/sssi-dataset.js.map +1 -1
- package/.server/client/stylesheets/maps.scss +4 -0
- package/.server/client/stylesheets/shared.scss +1 -5
- package/.server/server/constants.d.ts +2 -0
- package/.server/server/constants.js +2 -0
- package/.server/server/constants.js.map +1 -1
- package/.server/server/plugins/engine/__stubs__/definitions.d.ts +29 -0
- package/.server/server/plugins/engine/__stubs__/definitions.js +125 -0
- package/.server/server/plugins/engine/__stubs__/definitions.js.map +1 -0
- package/.server/server/plugins/engine/components/AutocompleteField.d.ts +9 -3
- package/.server/server/plugins/engine/components/AutocompleteField.js +12 -0
- package/.server/server/plugins/engine/components/AutocompleteField.js.map +1 -1
- package/.server/server/plugins/engine/components/CheckboxesField.d.ts +21 -0
- package/.server/server/plugins/engine/components/CheckboxesField.js +30 -5
- package/.server/server/plugins/engine/components/CheckboxesField.js.map +1 -1
- package/.server/server/plugins/engine/components/ComponentBase.d.ts +1 -0
- package/.server/server/plugins/engine/components/ComponentBase.js +2 -0
- package/.server/server/plugins/engine/components/ComponentBase.js.map +1 -1
- package/.server/server/plugins/engine/components/ComponentCollection.js +11 -6
- package/.server/server/plugins/engine/components/ComponentCollection.js.map +1 -1
- package/.server/server/plugins/engine/components/DatePartsField.d.ts +6 -3
- package/.server/server/plugins/engine/components/DatePartsField.js +12 -7
- package/.server/server/plugins/engine/components/DatePartsField.js.map +1 -1
- package/.server/server/plugins/engine/components/DeclarationField.d.ts +5 -2
- package/.server/server/plugins/engine/components/DeclarationField.js +6 -4
- package/.server/server/plugins/engine/components/DeclarationField.js.map +1 -1
- package/.server/server/plugins/engine/components/Details.d.ts +1 -0
- package/.server/server/plugins/engine/components/EastingNorthingField.d.ts +33 -2
- package/.server/server/plugins/engine/components/EastingNorthingField.js +110 -54
- package/.server/server/plugins/engine/components/EastingNorthingField.js.map +1 -1
- package/.server/server/plugins/engine/components/EmailAddressField.d.ts +4 -1
- package/.server/server/plugins/engine/components/EmailAddressField.js +2 -1
- package/.server/server/plugins/engine/components/EmailAddressField.js.map +1 -1
- package/.server/server/plugins/engine/components/FileUploadField.d.ts +21 -0
- package/.server/server/plugins/engine/components/FileUploadField.js +35 -3
- package/.server/server/plugins/engine/components/FileUploadField.js.map +1 -1
- package/.server/server/plugins/engine/components/FormComponent.d.ts +5 -1
- package/.server/server/plugins/engine/components/FormComponent.js +5 -2
- package/.server/server/plugins/engine/components/FormComponent.js.map +1 -1
- package/.server/server/plugins/engine/components/GeospatialField.d.ts +23 -0
- package/.server/server/plugins/engine/components/GeospatialField.js +33 -9
- package/.server/server/plugins/engine/components/GeospatialField.js.map +1 -1
- package/.server/server/plugins/engine/components/Html.d.ts +1 -0
- package/.server/server/plugins/engine/components/InsetText.d.ts +1 -0
- package/.server/server/plugins/engine/components/LatLongField.d.ts +32 -2
- package/.server/server/plugins/engine/components/LatLongField.js +85 -48
- package/.server/server/plugins/engine/components/LatLongField.js.map +1 -1
- package/.server/server/plugins/engine/components/List.d.ts +1 -0
- package/.server/server/plugins/engine/components/ListFormComponent.d.ts +1 -0
- package/.server/server/plugins/engine/components/LocationFieldBase.d.ts +8 -2
- package/.server/server/plugins/engine/components/LocationFieldBase.js +25 -6
- package/.server/server/plugins/engine/components/LocationFieldBase.js.map +1 -1
- package/.server/server/plugins/engine/components/LocationFieldHelpers.d.ts +12 -3
- package/.server/server/plugins/engine/components/LocationFieldHelpers.js +21 -13
- package/.server/server/plugins/engine/components/LocationFieldHelpers.js.map +1 -1
- package/.server/server/plugins/engine/components/Markdown.d.ts +1 -0
- package/.server/server/plugins/engine/components/Markdown.js +1 -1
- package/.server/server/plugins/engine/components/Markdown.js.map +1 -1
- package/.server/server/plugins/engine/components/MonthYearField.d.ts +5 -2
- package/.server/server/plugins/engine/components/MonthYearField.js +13 -9
- package/.server/server/plugins/engine/components/MonthYearField.js.map +1 -1
- package/.server/server/plugins/engine/components/MultilineTextField.d.ts +1 -0
- package/.server/server/plugins/engine/components/NationalGridFieldNumberField.d.ts +2 -1
- package/.server/server/plugins/engine/components/NationalGridFieldNumberField.js +4 -3
- package/.server/server/plugins/engine/components/NationalGridFieldNumberField.js.map +1 -1
- package/.server/server/plugins/engine/components/NotificationBanner.d.ts +1 -0
- package/.server/server/plugins/engine/components/NumberField.d.ts +5 -0
- package/.server/server/plugins/engine/components/NumberField.js +16 -0
- package/.server/server/plugins/engine/components/NumberField.js.map +1 -1
- package/.server/server/plugins/engine/components/OsGridRefField.d.ts +103 -1
- package/.server/server/plugins/engine/components/OsGridRefField.js +13 -3
- package/.server/server/plugins/engine/components/OsGridRefField.js.map +1 -1
- package/.server/server/plugins/engine/components/PaymentField.d.ts +3 -0
- package/.server/server/plugins/engine/components/PaymentField.js +17 -6
- package/.server/server/plugins/engine/components/PaymentField.js.map +1 -1
- package/.server/server/plugins/engine/components/SelectField.d.ts +1 -0
- package/.server/server/plugins/engine/components/SelectionControlField.d.ts +1 -0
- package/.server/server/plugins/engine/components/TelephoneNumberField.d.ts +1 -0
- package/.server/server/plugins/engine/components/UkAddressField.d.ts +1 -0
- package/.server/server/plugins/engine/components/UkAddressField.js +23 -8
- package/.server/server/plugins/engine/components/UkAddressField.js.map +1 -1
- package/.server/server/plugins/engine/components/YesNoField.d.ts +5 -2
- package/.server/server/plugins/engine/components/YesNoField.js +17 -8
- package/.server/server/plugins/engine/components/YesNoField.js.map +1 -1
- package/.server/server/plugins/engine/components/helpers/components.js +3 -3
- package/.server/server/plugins/engine/components/helpers/components.js.map +1 -1
- package/.server/server/plugins/engine/components/helpers/geospatial.d.ts +8 -1
- package/.server/server/plugins/engine/components/helpers/geospatial.js +56 -15
- package/.server/server/plugins/engine/components/helpers/geospatial.js.map +1 -1
- package/.server/server/plugins/engine/components/helpers/index.d.ts +7 -0
- package/.server/server/plugins/engine/components/helpers/index.js +13 -1
- package/.server/server/plugins/engine/components/helpers/index.js.map +1 -1
- package/.server/server/plugins/engine/components/types.d.ts +1 -0
- package/.server/server/plugins/engine/components/types.js.map +1 -1
- package/.server/server/plugins/engine/errors.d.ts +49 -0
- package/.server/server/plugins/engine/errors.js +75 -0
- package/.server/server/plugins/engine/errors.js.map +1 -0
- package/.server/server/plugins/engine/form-availability.d.ts +3 -2
- package/.server/server/plugins/engine/form-availability.js +3 -2
- package/.server/server/plugins/engine/form-availability.js.map +1 -1
- package/.server/server/plugins/engine/form-context.js +2 -2
- package/.server/server/plugins/engine/form-context.js.map +1 -1
- package/.server/server/plugins/engine/helpers.d.ts +22 -2
- package/.server/server/plugins/engine/helpers.js +44 -5
- package/.server/server/plugins/engine/helpers.js.map +1 -1
- package/.server/server/plugins/engine/i18n/buildValidationMessages.d.ts +4 -1
- package/.server/server/plugins/engine/i18n/buildValidationMessages.js +31 -7
- package/.server/server/plugins/engine/i18n/buildValidationMessages.js.map +1 -1
- package/.server/server/plugins/engine/i18n/createFormTranslator.d.ts +4 -4
- package/.server/server/plugins/engine/i18n/createFormTranslator.js +33 -4
- package/.server/server/plugins/engine/i18n/createFormTranslator.js.map +1 -1
- package/.server/server/plugins/engine/i18n/extractBaseTranslations.d.ts +1 -1
- package/.server/server/plugins/engine/i18n/extractBaseTranslations.js +9 -0
- package/.server/server/plugins/engine/i18n/extractBaseTranslations.js.map +1 -1
- package/.server/server/plugins/engine/i18n/form.d.ts +13 -0
- package/.server/server/plugins/engine/i18n/form.js +35 -0
- package/.server/server/plugins/engine/i18n/form.js.map +1 -0
- package/.server/server/plugins/engine/i18n/languages.d.ts +10 -0
- package/.server/server/plugins/engine/i18n/languages.js +19 -0
- package/.server/server/plugins/engine/i18n/languages.js.map +1 -0
- package/.server/server/plugins/engine/i18n/translations/cy.json +192 -9
- package/.server/server/plugins/engine/i18n/translations/en-GB.json +125 -7
- package/.server/server/plugins/engine/i18n/types.d.ts +3 -0
- package/.server/server/plugins/engine/i18n/types.js.map +1 -1
- package/.server/server/plugins/engine/index.d.ts +4 -0
- package/.server/server/plugins/engine/index.js +4 -0
- package/.server/server/plugins/engine/index.js.map +1 -1
- package/.server/server/plugins/engine/models/FormModel.d.ts +0 -4
- package/.server/server/plugins/engine/models/FormModel.js +35 -23
- package/.server/server/plugins/engine/models/FormModel.js.map +1 -1
- package/.server/server/plugins/engine/models/SummaryViewModel.js +9 -4
- package/.server/server/plugins/engine/models/SummaryViewModel.js.map +1 -1
- package/.server/server/plugins/engine/models/types.d.ts +28 -1
- package/.server/server/plugins/engine/models/types.js.map +1 -1
- package/.server/server/plugins/engine/models/unavailable-view-model.d.ts +11 -2
- package/.server/server/plugins/engine/models/unavailable-view-model.js +23 -4
- package/.server/server/plugins/engine/models/unavailable-view-model.js.map +1 -1
- package/.server/server/plugins/engine/outputFormatters/adapter/v1.js +14 -6
- package/.server/server/plugins/engine/outputFormatters/adapter/v1.js.map +1 -1
- package/.server/server/plugins/engine/outputFormatters/human/v1.js +2 -1
- package/.server/server/plugins/engine/outputFormatters/human/v1.js.map +1 -1
- package/.server/server/plugins/engine/outputFormatters/machine/v2.d.ts +2 -0
- package/.server/server/plugins/engine/outputFormatters/machine/v2.js +2 -0
- package/.server/server/plugins/engine/outputFormatters/machine/v2.js.map +1 -1
- package/.server/server/plugins/engine/pageControllers/FileUploadPageController.d.ts +7 -1
- package/.server/server/plugins/engine/pageControllers/FileUploadPageController.js +56 -10
- package/.server/server/plugins/engine/pageControllers/FileUploadPageController.js.map +1 -1
- package/.server/server/plugins/engine/pageControllers/QuestionPageController.d.ts +1 -1
- package/.server/server/plugins/engine/pageControllers/QuestionPageController.js +7 -3
- package/.server/server/plugins/engine/pageControllers/QuestionPageController.js.map +1 -1
- package/.server/server/plugins/engine/pageControllers/RepeatPageController.js +3 -4
- package/.server/server/plugins/engine/pageControllers/RepeatPageController.js.map +1 -1
- package/.server/server/plugins/engine/pageControllers/SummaryPageController.js +10 -4
- package/.server/server/plugins/engine/pageControllers/SummaryPageController.js.map +1 -1
- package/.server/server/plugins/engine/pageControllers/helpers/pages.js +2 -1
- package/.server/server/plugins/engine/pageControllers/helpers/pages.js.map +1 -1
- package/.server/server/plugins/engine/pageControllers/helpers/submission.d.ts +35 -2
- package/.server/server/plugins/engine/pageControllers/helpers/submission.js +100 -3
- package/.server/server/plugins/engine/pageControllers/helpers/submission.js.map +1 -1
- package/.server/server/plugins/engine/pageControllers/validationOptions.d.ts +1 -1
- package/.server/server/plugins/engine/pageControllers/validationOptions.js +24 -3
- package/.server/server/plugins/engine/pageControllers/validationOptions.js.map +1 -1
- package/.server/server/plugins/engine/types/enums.d.ts +3 -3
- package/.server/server/plugins/engine/types/enums.js +5 -4
- package/.server/server/plugins/engine/types/enums.js.map +1 -1
- package/.server/server/plugins/engine/types/schema.js +10 -3
- package/.server/server/plugins/engine/types/schema.js.map +1 -1
- package/.server/server/plugins/engine/types.d.ts +18 -2
- package/.server/server/plugins/engine/types.js.map +1 -1
- package/.server/server/plugins/engine/unavailable-response.js +5 -2
- package/.server/server/plugins/engine/unavailable-response.js.map +1 -1
- package/.server/server/plugins/engine/views/components/_location-field-base.html +4 -2
- package/.server/server/plugins/engine/views/components/fileuploadfield.html +1 -1
- package/.server/server/plugins/engine/views/components/geospatialfield.html +1 -0
- package/.server/server/plugins/engine/views/components/multilinetextfield.html +12 -1
- package/.server/server/plugins/engine/views/components/osgridreffield.html +4 -1
- package/.server/server/plugins/engine/views/components/paymentfield.html +1 -1
- package/.server/server/plugins/engine/views/components/ukaddressfield.html +1 -1
- package/.server/server/plugins/engine/views/file-upload.html +1 -1
- package/.server/server/plugins/engine/views/partials/preview-banner.html +3 -1
- package/.server/server/plugins/engine/views/unavailable.html +14 -11
- package/.server/server/plugins/nunjucks/filters/applyUrlParam.d.ts +9 -0
- package/.server/server/plugins/nunjucks/filters/applyUrlParam.js +17 -0
- package/.server/server/plugins/nunjucks/filters/applyUrlParam.js.map +1 -0
- package/.server/server/plugins/nunjucks/filters/applyUrlParam.test.js +17 -0
- package/.server/server/plugins/nunjucks/filters/applyUrlParam.test.js.map +1 -0
- package/.server/server/plugins/nunjucks/filters/field.d.ts +1 -1
- package/.server/server/plugins/nunjucks/filters/index.d.ts +1 -0
- package/.server/server/plugins/nunjucks/filters/index.js +1 -0
- package/.server/server/plugins/nunjucks/filters/index.js.map +1 -1
- package/.server/server/plugins/payment/helper.d.ts +11 -1
- package/.server/server/plugins/payment/helper.js +18 -2
- package/.server/server/plugins/payment/helper.js.map +1 -1
- package/.server/server/plugins/payment/helper.test.js +2 -1
- package/.server/server/plugins/payment/helper.test.js.map +1 -1
- package/.server/server/plugins/payment/service.d.ts +2 -1
- package/.server/server/plugins/payment/service.js +5 -2
- package/.server/server/plugins/payment/service.js.map +1 -1
- package/.server/server/plugins/payment/service.test.js +7 -3
- package/.server/server/plugins/payment/service.test.js.map +1 -1
- package/.server/server/plugins/payment/types.d.ts +4 -0
- package/.server/server/plugins/payment/types.js +1 -0
- package/.server/server/plugins/payment/types.js.map +1 -1
- package/.server/server/plugins/postcode-lookup/models/index.d.ts +249 -3
- package/.server/server/plugins/postcode-lookup/models/index.js +87 -33
- package/.server/server/plugins/postcode-lookup/models/index.js.map +1 -1
- package/.server/server/plugins/postcode-lookup/routes/index.d.ts +15 -1
- package/.server/server/plugins/postcode-lookup/routes/index.js +47 -15
- package/.server/server/plugins/postcode-lookup/routes/index.js.map +1 -1
- package/.server/server/plugins/postcode-lookup/routes/index.test.js +84 -0
- package/.server/server/plugins/postcode-lookup/routes/index.test.js.map +1 -0
- package/.server/server/plugins/postcode-lookup/types.d.ts +12 -0
- package/.server/server/plugins/postcode-lookup/types.js +6 -1
- package/.server/server/plugins/postcode-lookup/types.js.map +1 -1
- package/.server/server/plugins/postcode-lookup/views/postcode-lookup-details.html +3 -3
- package/.server/server/utils/type-utils.d.ts +1 -2
- package/.server/server/utils/type-utils.js +0 -3
- package/.server/server/utils/type-utils.js.map +1 -1
- package/.server/server/utils/utils.d.ts +6 -0
- package/.server/server/utils/utils.js +18 -1
- package/.server/server/utils/utils.js.map +1 -1
- package/.server/server/utils/utils.test.js +21 -1
- package/.server/server/utils/utils.test.js.map +1 -1
- package/package.json +20 -5
- package/src/client/javascripts/file-upload.js +11 -3
- package/src/client/javascripts/geospatial-map.js +176 -81
- package/src/client/javascripts/govuk.js +2 -0
- package/src/client/javascripts/location-map.js +60 -4
- package/src/client/javascripts/map-constants.js +3 -0
- package/src/client/javascripts/map.js +47 -0
- package/src/client/javascripts/maps.js +5 -0
- package/src/client/javascripts/shared.js +1 -4
- package/src/client/javascripts/sssi-dataset.js +39 -41
- package/src/client/stylesheets/maps.scss +4 -0
- package/src/client/stylesheets/shared.scss +1 -5
- package/src/server/constants.js +2 -0
- package/src/server/plugins/engine/__stubs__/definitions.ts +155 -0
- package/src/server/plugins/engine/components/AutocompleteField.ts +13 -0
- package/src/server/plugins/engine/components/CheckboxesField.ts +38 -5
- package/src/server/plugins/engine/components/ComponentBase.ts +2 -0
- package/src/server/plugins/engine/components/ComponentCollection.ts +16 -11
- package/src/server/plugins/engine/components/DatePartsField.ts +20 -9
- package/src/server/plugins/engine/components/DeclarationField.ts +7 -6
- package/src/server/plugins/engine/components/EastingNorthingField.ts +185 -89
- package/src/server/plugins/engine/components/EmailAddressField.ts +2 -1
- package/src/server/plugins/engine/components/FileUploadField.ts +44 -3
- package/src/server/plugins/engine/components/FormComponent.ts +6 -5
- package/src/server/plugins/engine/components/GeospatialField.ts +47 -9
- package/src/server/plugins/engine/components/LatLongField.ts +128 -58
- package/src/server/plugins/engine/components/LocationFieldBase.ts +30 -7
- package/src/server/plugins/engine/components/LocationFieldHelpers.ts +28 -14
- package/src/server/plugins/engine/components/Markdown.ts +2 -3
- package/src/server/plugins/engine/components/MonthYearField.ts +20 -15
- package/src/server/plugins/engine/components/NationalGridFieldNumberField.ts +9 -3
- package/src/server/plugins/engine/components/NumberField.ts +21 -1
- package/src/server/plugins/engine/components/OsGridRefField.ts +22 -3
- package/src/server/plugins/engine/components/PaymentField.ts +15 -5
- package/src/server/plugins/engine/components/UkAddressField.ts +30 -7
- package/src/server/plugins/engine/components/YesNoField.ts +17 -9
- package/src/server/plugins/engine/components/helpers/components.ts +3 -3
- package/src/server/plugins/engine/components/helpers/geospatial.ts +84 -21
- package/src/server/plugins/engine/components/helpers/index.ts +19 -0
- package/src/server/plugins/engine/components/types.ts +1 -0
- package/src/server/plugins/engine/errors.ts +78 -0
- package/src/server/plugins/engine/form-availability.ts +8 -2
- package/src/server/plugins/engine/form-context.ts +4 -2
- package/src/server/plugins/engine/helpers.ts +52 -5
- package/src/server/plugins/engine/i18n/buildValidationMessages.ts +16 -8
- package/src/server/plugins/engine/i18n/createFormTranslator.ts +62 -11
- package/src/server/plugins/engine/i18n/extractBaseTranslations.ts +7 -1
- package/src/server/plugins/engine/i18n/form.ts +54 -0
- package/src/server/plugins/engine/i18n/languages.ts +19 -0
- package/src/server/plugins/engine/i18n/translations/cy.json +192 -9
- package/src/server/plugins/engine/i18n/translations/en-GB.json +125 -7
- package/src/server/plugins/engine/i18n/types.ts +3 -0
- package/src/server/plugins/engine/index.ts +7 -0
- package/src/server/plugins/engine/models/FormModel.ts +46 -23
- package/src/server/plugins/engine/models/SummaryViewModel.ts +6 -5
- package/src/server/plugins/engine/models/types.ts +31 -0
- package/src/server/plugins/engine/models/unavailable-view-model.ts +26 -5
- package/src/server/plugins/engine/outputFormatters/adapter/v1.ts +18 -7
- package/src/server/plugins/engine/outputFormatters/human/v1.ts +2 -1
- package/src/server/plugins/engine/outputFormatters/machine/v2.ts +3 -0
- package/src/server/plugins/engine/pageControllers/FileUploadPageController.ts +60 -9
- package/src/server/plugins/engine/pageControllers/QuestionPageController.ts +10 -5
- package/src/server/plugins/engine/pageControllers/RepeatPageController.ts +2 -2
- package/src/server/plugins/engine/pageControllers/SummaryPageController.ts +15 -4
- package/src/server/plugins/engine/pageControllers/helpers/pages.ts +2 -1
- package/src/server/plugins/engine/pageControllers/helpers/submission.ts +143 -4
- package/src/server/plugins/engine/pageControllers/validationOptions.ts +29 -4
- package/src/server/plugins/engine/types/enums.ts +4 -3
- package/src/server/plugins/engine/types/schema.ts +17 -4
- package/src/server/plugins/engine/types.ts +19 -1
- package/src/server/plugins/engine/unavailable-response.ts +6 -2
- package/src/server/plugins/engine/views/components/_location-field-base.html +4 -2
- package/src/server/plugins/engine/views/components/fileuploadfield.html +1 -1
- package/src/server/plugins/engine/views/components/geospatialfield.html +1 -0
- package/src/server/plugins/engine/views/components/multilinetextfield.html +12 -1
- package/src/server/plugins/engine/views/components/osgridreffield.html +4 -1
- package/src/server/plugins/engine/views/components/paymentfield.html +1 -1
- package/src/server/plugins/engine/views/components/ukaddressfield.html +1 -1
- package/src/server/plugins/engine/views/file-upload.html +1 -1
- package/src/server/plugins/engine/views/partials/preview-banner.html +3 -1
- package/src/server/plugins/engine/views/unavailable.html +14 -11
- package/src/server/plugins/nunjucks/filters/applyUrlParam.js +17 -0
- package/src/server/plugins/nunjucks/filters/index.js +1 -0
- package/src/server/plugins/payment/helper.js +22 -2
- package/src/server/plugins/payment/service.js +6 -2
- package/src/server/plugins/payment/types.js +1 -0
- package/src/server/plugins/postcode-lookup/models/index.js +75 -43
- package/src/server/plugins/postcode-lookup/routes/index.js +73 -16
- package/src/server/plugins/postcode-lookup/types.js +6 -1
- package/src/server/plugins/postcode-lookup/views/postcode-lookup-details.html +3 -3
- package/src/server/utils/type-utils.ts +1 -11
- package/src/server/utils/utils.js +19 -1
|
@@ -1 +1 @@
|
|
|
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":[]}
|
|
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","def","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\n const definition = await formsService.getFormDefinition(\n metadata.id,\n formState\n )\n\n assertFormAvailable(metadata, definition, formState, isPreview)\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 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 assertFormAvailable(metadata, entry.model.def, formState, isPreview)\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;EAEzD,MAAMW,UAAU,GAAG,MAAMP,YAAY,CAACQ,iBAAiB,CACrDH,QAAQ,CAACI,EAAE,EACXN,SACF,CAAC;EAEDhB,mBAAmB,CAACkB,QAAQ,EAAEE,UAAU,EAAEJ,SAAS,EAAEF,SAAS,CAAC;EAE/D,IAAI,CAACM,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;EACrE,MAAMyC,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;EAEAzD,mBAAmB,CAACkB,QAAQ,EAAEuC,KAAK,CAACQ,KAAK,CAACE,GAAG,EAAEnD,SAAS,EAAEF,SAAS,CAAC;EAEpE,OAAO2C,KAAK,CAACQ,KAAK;AACpB;AAEA,SAASxC,aAAaA,CACpBC,WAAmB,EACnBjB,IAAY,EACZC,KAAiB,EACjBI,SAAkB,EAClB;EACA,MAAMsD,IAAI,GAAG,CACXtD,SAAS,GACL,GAAGY,WAAW,GAAG3B,mBAAmB,IAAIW,KAAK,IAAID,IAAI,EAAE,GACvD,GAAGiB,WAAW,IAAIjB,IAAI,EAAE,EAC5B4D,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,YAAYxE,sBAAsB,IACjD0E,sBAAsB,EACtB;IACA,OAAOA,sBAAsB;EAC/B;EAEA,OAAOF,eAAe;AACxB;AAEA,SAAS3D,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":[]}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { type ComponentDef, type FormDefinition, type Page } from '@defra/forms-model';
|
|
2
2
|
import { type ResponseToolkit, type Server } from '@hapi/hapi';
|
|
3
|
+
import { type Locale } from 'date-fns';
|
|
3
4
|
import { type ValidationErrorItem } from 'joi';
|
|
4
5
|
import { Liquid } from 'liquidjs';
|
|
5
6
|
import { type FormModel } from '../../../server/plugins/engine/models/FormModel.js';
|
|
@@ -41,10 +42,11 @@ export declare function checkFormStatus(params?: FormParams): {
|
|
|
41
42
|
export declare function checkEmailAddressForLiveFormSubmission(emailAddress: string | undefined, isPreview: boolean): void;
|
|
42
43
|
/**
|
|
43
44
|
* Parses the errors from {@link Schema.validate} so they can be rendered by govuk-frontend templates
|
|
45
|
+
* @param language - the target language for translations
|
|
44
46
|
* @param [details] - provided by {@link Schema.validate}
|
|
45
47
|
*/
|
|
46
|
-
export declare function getErrors(details?: ValidationErrorItem[]): FormSubmissionError[] | undefined;
|
|
47
|
-
export declare function getError(detail: ValidationErrorItem): FormSubmissionError;
|
|
48
|
+
export declare function getErrors(language: string | undefined, details?: ValidationErrorItem[]): FormSubmissionError[] | undefined;
|
|
49
|
+
export declare function getError(language: string | undefined, detail: ValidationErrorItem): FormSubmissionError;
|
|
48
50
|
export declare function createError(componentName: string, message: string): {
|
|
49
51
|
href: string;
|
|
50
52
|
name: string;
|
|
@@ -88,3 +90,21 @@ export interface FormVersionMetadata {
|
|
|
88
90
|
* Extracts form version metadata from a form definition
|
|
89
91
|
*/
|
|
90
92
|
export declare function getFormVersion(definition: Pick<FormDefinition, 'metadata'>): FormVersionMetadata | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* Converts a BCP 47 language tag to the ISO 639-1 code GOV.UK Pay accepts.
|
|
95
|
+
* Defaults to English if the language is not supported.
|
|
96
|
+
* @param { string | undefined } language - BCP 47 language code
|
|
97
|
+
* @returns {string} language code required by GOV.UK Pay
|
|
98
|
+
*/
|
|
99
|
+
export declare function toPayLanguageCode(language: string | undefined): string;
|
|
100
|
+
/**
|
|
101
|
+
* Converts a BCP 47 language tag to the date-fns Locale (for date formatting).
|
|
102
|
+
* Defaults to English if the language is not supported.
|
|
103
|
+
* @param { string | undefined } language - BCP 47 language code
|
|
104
|
+
* @returns {Locale} language locale
|
|
105
|
+
*/
|
|
106
|
+
export declare function toLanguageLocale(language: string | undefined): Locale;
|
|
107
|
+
/**
|
|
108
|
+
* @import { FormsService } from '../../../server/types.js'
|
|
109
|
+
* @import { Locale } from 'date-fns/locale'
|
|
110
|
+
*/
|
|
@@ -1,10 +1,11 @@
|
|
|
1
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
|
+
import { cy, enGB } from 'date-fns/locale';
|
|
4
5
|
import { StatusCodes } from 'http-status-codes';
|
|
5
6
|
import { Liquid } from 'liquidjs';
|
|
6
7
|
import { logger } from "../../common/helpers/logging/logger.js";
|
|
7
|
-
import { FORM_VERSION_METADATA_KEY } from "../../constants.js";
|
|
8
|
+
import { CY, EN_GB, FORM_VERSION_METADATA_KEY } from "../../constants.js";
|
|
8
9
|
import { getAnswer } from "./components/helpers/components.js";
|
|
9
10
|
import { stripParam } from "./pageControllers/helpers/state.js";
|
|
10
11
|
import { FormAction, FormStatus } from "../../routes/types.js";
|
|
@@ -194,15 +195,16 @@ export function checkEmailAddressForLiveFormSubmission(emailAddress, isPreview)
|
|
|
194
195
|
|
|
195
196
|
/**
|
|
196
197
|
* Parses the errors from {@link Schema.validate} so they can be rendered by govuk-frontend templates
|
|
198
|
+
* @param language - the target language for translations
|
|
197
199
|
* @param [details] - provided by {@link Schema.validate}
|
|
198
200
|
*/
|
|
199
|
-
export function getErrors(details) {
|
|
201
|
+
export function getErrors(language, details) {
|
|
200
202
|
if (!details?.length) {
|
|
201
203
|
return;
|
|
202
204
|
}
|
|
203
|
-
return details.map(getError);
|
|
205
|
+
return details.map(detail => getError(language, detail));
|
|
204
206
|
}
|
|
205
|
-
export function getError(detail) {
|
|
207
|
+
export function getError(language, detail) {
|
|
206
208
|
const {
|
|
207
209
|
context,
|
|
208
210
|
message,
|
|
@@ -210,7 +212,9 @@ export function getError(detail) {
|
|
|
210
212
|
} = detail;
|
|
211
213
|
const name = context?.key ?? '';
|
|
212
214
|
const href = `#${name}`;
|
|
213
|
-
const text = message.replace(/\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z)/, text => format(parseISO(text), 'd MMMM yyyy'
|
|
215
|
+
const text = message.replace(/\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z)/, text => format(parseISO(text), 'd MMMM yyyy', {
|
|
216
|
+
locale: toLanguageLocale(language)
|
|
217
|
+
}));
|
|
214
218
|
return {
|
|
215
219
|
path,
|
|
216
220
|
href,
|
|
@@ -282,4 +286,39 @@ export function handleLegacyRedirect(h, targetUrl) {
|
|
|
282
286
|
export function getFormVersion(definition) {
|
|
283
287
|
return definition.metadata?.[FORM_VERSION_METADATA_KEY];
|
|
284
288
|
}
|
|
289
|
+
const payLanguageCodes = {
|
|
290
|
+
[EN_GB]: 'en',
|
|
291
|
+
[CY]: 'cy'
|
|
292
|
+
};
|
|
293
|
+
const languageLocales = {
|
|
294
|
+
[EN_GB]: enGB,
|
|
295
|
+
[CY]: cy
|
|
296
|
+
};
|
|
297
|
+
const defaultLanguageCode = 'en';
|
|
298
|
+
const defaultLanguageLocale = enGB;
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* Converts a BCP 47 language tag to the ISO 639-1 code GOV.UK Pay accepts.
|
|
302
|
+
* Defaults to English if the language is not supported.
|
|
303
|
+
* @param { string | undefined } language - BCP 47 language code
|
|
304
|
+
* @returns {string} language code required by GOV.UK Pay
|
|
305
|
+
*/
|
|
306
|
+
export function toPayLanguageCode(language) {
|
|
307
|
+
return payLanguageCodes[language ?? 'unknown'] ?? defaultLanguageCode;
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* Converts a BCP 47 language tag to the date-fns Locale (for date formatting).
|
|
312
|
+
* Defaults to English if the language is not supported.
|
|
313
|
+
* @param { string | undefined } language - BCP 47 language code
|
|
314
|
+
* @returns {Locale} language locale
|
|
315
|
+
*/
|
|
316
|
+
export function toLanguageLocale(language) {
|
|
317
|
+
return languageLocales[language ?? 'unknown'] ?? defaultLanguageLocale;
|
|
318
|
+
}
|
|
319
|
+
|
|
320
|
+
/**
|
|
321
|
+
* @import { FormsService } from '../../../server/types.js'
|
|
322
|
+
* @import { Locale } from 'date-fns/locale'
|
|
323
|
+
*/
|
|
285
324
|
//# sourceMappingURL=helpers.js.map
|
|
@@ -1 +1 @@
|
|
|
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":[]}
|
|
1
|
+
{"version":3,"file":"helpers.js","names":["ControllerPath","Engine","getErrorMessage","Boom","format","parseISO","cy","enGB","StatusCodes","Liquid","logger","CY","EN_GB","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","language","details","length","map","detail","getError","message","key","text","locale","toLanguageLocale","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","payLanguageCodes","languageLocales","defaultLanguageCode","defaultLanguageLocale","toPayLanguageCode"],"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, type Locale } from 'date-fns'\nimport { cy, enGB } from 'date-fns/locale'\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 { CY, EN_GB, 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 language - the target language for translations\n * @param [details] - provided by {@link Schema.validate}\n */\nexport function getErrors(\n language: string | undefined,\n details?: ValidationErrorItem[]\n): FormSubmissionError[] | undefined {\n if (!details?.length) {\n return\n }\n\n return details.map((detail) => getError(language, detail))\n}\n\nexport function getError(\n language: string | undefined,\n detail: ValidationErrorItem\n): 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) =>\n format(parseISO(text), 'd MMMM yyyy', {\n locale: toLanguageLocale(language)\n })\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\nconst payLanguageCodes = {\n [EN_GB]: 'en',\n [CY]: 'cy'\n} as Record<string, string>\n\nconst languageLocales = {\n [EN_GB]: enGB,\n [CY]: cy\n} as Record<string, Locale>\n\nconst defaultLanguageCode = 'en'\nconst defaultLanguageLocale = enGB\n\n/**\n * Converts a BCP 47 language tag to the ISO 639-1 code GOV.UK Pay accepts.\n * Defaults to English if the language is not supported.\n * @param { string | undefined } language - BCP 47 language code\n * @returns {string} language code required by GOV.UK Pay\n */\nexport function toPayLanguageCode(language: string | undefined): string {\n return payLanguageCodes[language ?? 'unknown'] ?? defaultLanguageCode\n}\n\n/**\n * Converts a BCP 47 language tag to the date-fns Locale (for date formatting).\n * Defaults to English if the language is not supported.\n * @param { string | undefined } language - BCP 47 language code\n * @returns {Locale} language locale\n */\nexport function toLanguageLocale(language: string | undefined): Locale {\n return languageLocales[language ?? 'unknown'] ?? defaultLanguageLocale\n}\n\n/**\n * @import { FormsService } from '~/src/server/types.js'\n * @import { Locale } from 'date-fns/locale'\n */\n"],"mappings":"AAAA,SACEA,cAAc,EACdC,MAAM,EACNC,eAAe,QAIV,oBAAoB;AAC3B,OAAOC,IAAI,MAAM,YAAY;AAE7B,SAASC,MAAM,EAAEC,QAAQ,QAAqB,UAAU;AACxD,SAASC,EAAE,EAAEC,IAAI,QAAQ,iBAAiB;AAC1C,SAASC,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,MAAM,QAAQ,UAAU;AAEjC,SAASC,MAAM;AACf,SAASC,EAAE,EAAEC,KAAK,EAAEC,yBAAyB;AAC7C,SACEC,SAAS;AAKX,SAASC,UAAU;AAMnB,SACEC,UAAU,EACVC,UAAU;AAMZ,OAAO,MAAMC,MAAM,GAAG,IAAIT,MAAM,CAAC;EAC/BU,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;IACE5C,MAAM,EAAE;EACV,CACF,CAAC;EAED,OAAOyC,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,CAACzD,WAAW,CAAC0D,SAAS,CAAC,GACpCL,QAAQ,CAACI,IAAI,CAACzD,WAAW,CAAC2D,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;MACZ9D,MAAM,CAAC+D,KAAK,CACVD,GAAG,EACH,6CAA6CH,IAAI,MAAMnE,eAAe,CAACsE,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,MAAM9B,IAAI,CAAC6F,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,KAAKjB,MAAM,CAACmG,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,GAAGrG,cAAc,CAACwG,KAAK;EAC3D;EAEA,MAAMH,SAAS,GAAGV,aAAa,CAAC5C,KAAK,EAAEuD,GAAG,CAACG,SAAS,CAAC;EACrD,OAAOJ,SAAS,GAAG,IAAIA,SAAS,EAAE,GAAGrG,cAAc,CAACwG,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,MAAMxG,IAAI,CAAC8G,QAAQ,CACjB,8DACF,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CACvBC,QAA4B,EAC5BC,OAA+B,EACI;EACnC,IAAI,CAACA,OAAO,EAAEC,MAAM,EAAE;IACpB;EACF;EAEA,OAAOD,OAAO,CAACE,GAAG,CAAEC,MAAM,IAAKC,QAAQ,CAACL,QAAQ,EAAEI,MAAM,CAAC,CAAC;AAC5D;AAEA,OAAO,SAASC,QAAQA,CACtBL,QAA4B,EAC5BI,MAA2B,EACN;EACrB,MAAM;IAAE9F,OAAO;IAAEgG,OAAO;IAAE7F;EAAK,CAAC,GAAG2F,MAAM;EAEzC,MAAMlF,IAAI,GAAGZ,OAAO,EAAEiG,GAAG,IAAI,EAAE;EAC/B,MAAMjC,IAAI,GAAG,IAAIpD,IAAI,EAAE;EAEvB,MAAMsF,IAAI,GAAGF,OAAO,CAAC5B,OAAO,CAC1B,0EAA0E,EACzE8B,IAAI,IACHvH,MAAM,CAACC,QAAQ,CAACsH,IAAI,CAAC,EAAE,aAAa,EAAE;IACpCC,MAAM,EAAEC,gBAAgB,CAACV,QAAQ;EACnC,CAAC,CACL,CAAC;EAED,OAAO;IACLvF,IAAI;IACJ6D,IAAI;IACJpD,IAAI;IACJsF,IAAI;IACJlG;EACF,CAAC;AACH;AAEA,OAAO,SAASqG,WAAWA,CAACC,aAAqB,EAAEN,OAAe,EAAE;EAClE,OAAO;IACLhC,IAAI,EAAE,IAAIsC,aAAa,EAAE;IACzB1F,IAAI,EAAE0F,aAAa;IACnBJ,IAAI,EAAEF;EACR,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASO,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,SAASxG,gBAAgBA,CAC9BJ,QAAgB,EAChBE,OAAoB,EACZ;EACR,MAAMD,OAAoB,GAAG;IAC3BC,OAAO;IACPK,KAAK,EAAEL,OAAO,CAAC8G,UAAU;IACzBhG,UAAU,EAAEd,OAAO,CAAC+G;EACtB,CAAC;;EAED;EACA,OAAOtH,MAAM,CAACuH,kBAAkB,CAAClH,QAAQ,EAAEE,OAAO,CAACqB,aAAa,EAAE;IAChEtB;EACF,CAAC,CAAC;AACJ;AAEA,OAAO,SAASkH,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,CAAC9F,CAAkB,EAAE+F,SAAiB,EAAE;EAC1E,OAAO/F,CAAC,CAACY,QAAQ,CAACmF,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,GAAG1I,yBAAyB,CAAC;AAGzD;AAEA,MAAM2I,gBAAgB,GAAG;EACvB,CAAC5I,KAAK,GAAG,IAAI;EACb,CAACD,EAAE,GAAG;AACR,CAA2B;AAE3B,MAAM8I,eAAe,GAAG;EACtB,CAAC7I,KAAK,GAAGL,IAAI;EACb,CAACI,EAAE,GAAGL;AACR,CAA2B;AAE3B,MAAMoJ,mBAAmB,GAAG,IAAI;AAChC,MAAMC,qBAAqB,GAAGpJ,IAAI;;AAElC;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASqJ,iBAAiBA,CAACzC,QAA4B,EAAU;EACtE,OAAOqC,gBAAgB,CAACrC,QAAQ,IAAI,SAAS,CAAC,IAAIuC,mBAAmB;AACvE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS7B,gBAAgBA,CAACV,QAA4B,EAAU;EACrE,OAAOsC,eAAe,CAACtC,QAAQ,IAAI,SAAS,CAAC,IAAIwC,qBAAqB;AACxE;;AAEA;AACA;AACA;AACA","ignoreList":[]}
|
|
@@ -7,7 +7,7 @@ import { type JoiExpression } from 'joi';
|
|
|
7
7
|
* because Joi cannot resolve custom functions from a plain string.
|
|
8
8
|
* Plain strings with only built-in tokens ({{#label}}, {{#limit}}) work without wrapping.
|
|
9
9
|
*/
|
|
10
|
-
export declare function buildValidationMessages(t: (key: string) => string): {
|
|
10
|
+
export declare function buildValidationMessages(t: (key: string, options?: Record<string, unknown>) => string): {
|
|
11
11
|
required: JoiExpression;
|
|
12
12
|
selectRequired: JoiExpression;
|
|
13
13
|
pattern: JoiExpression;
|
|
@@ -35,5 +35,8 @@ export declare function buildValidationMessages(t: (key: string) => string): {
|
|
|
35
35
|
featuresMin: string;
|
|
36
36
|
featuresMax: string;
|
|
37
37
|
featuresLength: string;
|
|
38
|
+
filesMin: string;
|
|
39
|
+
filesMax: string;
|
|
40
|
+
filesLength: string;
|
|
38
41
|
};
|
|
39
42
|
export type ValidationMessages = ReturnType<typeof buildValidationMessages>;
|
|
@@ -38,13 +38,37 @@ export function buildValidationMessages(t) {
|
|
|
38
38
|
dateFormat: t('components.dateField.validation.dateFormat'),
|
|
39
39
|
dateMin: t('components.dateField.validation.dateMin'),
|
|
40
40
|
dateMax: t('components.dateField.validation.dateMax'),
|
|
41
|
-
unicode: 'validation.unicode',
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
41
|
+
unicode: t('validation.unicode'),
|
|
42
|
+
// These generic templates are shared across fields with differing limits, so a
|
|
43
|
+
// fixed singular count is used here — components needing accurate singular/plural
|
|
44
|
+
// text (e.g. FileUploadField) build their own per-instance messages instead.
|
|
45
|
+
arrayMin: t('validation.arrayMin', {
|
|
46
|
+
count: 1
|
|
47
|
+
}),
|
|
48
|
+
arrayMax: t('validation.arrayMax', {
|
|
49
|
+
count: 1
|
|
50
|
+
}),
|
|
51
|
+
arrayLength: t('validation.arrayLength', {
|
|
52
|
+
count: 1
|
|
53
|
+
}),
|
|
54
|
+
featuresMin: t('validation.featuresMin', {
|
|
55
|
+
count: 1
|
|
56
|
+
}),
|
|
57
|
+
featuresMax: t('validation.featuresMax', {
|
|
58
|
+
count: 1
|
|
59
|
+
}),
|
|
60
|
+
featuresLength: t('validation.featuresLength', {
|
|
61
|
+
count: 1
|
|
62
|
+
}),
|
|
63
|
+
filesMin: t('validation.filesMin', {
|
|
64
|
+
count: 1
|
|
65
|
+
}),
|
|
66
|
+
filesMax: t('validation.filesMax', {
|
|
67
|
+
count: 1
|
|
68
|
+
}),
|
|
69
|
+
filesLength: t('validation.filesLength', {
|
|
70
|
+
count: 1
|
|
71
|
+
})
|
|
48
72
|
};
|
|
49
73
|
}
|
|
50
74
|
//# sourceMappingURL=buildValidationMessages.js.map
|
|
@@ -1 +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.
|
|
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","count","arrayMax","arrayLength","featuresMin","featuresMax","featuresLength","filesMin","filesMax","filesLength"],"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(\n t: (key: string, options?: Record<string, unknown>) => string\n) {\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: t('validation.unicode'),\n // These generic templates are shared across fields with differing limits, so a\n // fixed singular count is used here — components needing accurate singular/plural\n // text (e.g. FileUploadField) build their own per-instance messages instead.\n arrayMin: t('validation.arrayMin', { count: 1 }),\n arrayMax: t('validation.arrayMax', { count: 1 }),\n arrayLength: t('validation.arrayLength', { count: 1 }),\n featuresMin: t('validation.featuresMin', { count: 1 }),\n featuresMax: t('validation.featuresMax', { count: 1 }),\n featuresLength: t('validation.featuresLength', { count: 1 }),\n filesMin: t('validation.filesMin', { count: 1 }),\n filesMax: t('validation.filesMax', { count: 1 }),\n filesLength: t('validation.filesLength', { count: 1 })\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,CACrCC,CAA6D,EAC7D;EACA,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,EAAEtB,CAAC,CAAC,oBAAoB,CAAC;IAChC;IACA;IACA;IACAuB,QAAQ,EAAEvB,CAAC,CAAC,qBAAqB,EAAE;MAAEwB,KAAK,EAAE;IAAE,CAAC,CAAC;IAChDC,QAAQ,EAAEzB,CAAC,CAAC,qBAAqB,EAAE;MAAEwB,KAAK,EAAE;IAAE,CAAC,CAAC;IAChDE,WAAW,EAAE1B,CAAC,CAAC,wBAAwB,EAAE;MAAEwB,KAAK,EAAE;IAAE,CAAC,CAAC;IACtDG,WAAW,EAAE3B,CAAC,CAAC,wBAAwB,EAAE;MAAEwB,KAAK,EAAE;IAAE,CAAC,CAAC;IACtDI,WAAW,EAAE5B,CAAC,CAAC,wBAAwB,EAAE;MAAEwB,KAAK,EAAE;IAAE,CAAC,CAAC;IACtDK,cAAc,EAAE7B,CAAC,CAAC,2BAA2B,EAAE;MAAEwB,KAAK,EAAE;IAAE,CAAC,CAAC;IAC5DM,QAAQ,EAAE9B,CAAC,CAAC,qBAAqB,EAAE;MAAEwB,KAAK,EAAE;IAAE,CAAC,CAAC;IAChDO,QAAQ,EAAE/B,CAAC,CAAC,qBAAqB,EAAE;MAAEwB,KAAK,EAAE;IAAE,CAAC,CAAC;IAChDQ,WAAW,EAAEhC,CAAC,CAAC,wBAAwB,EAAE;MAAEwB,KAAK,EAAE;IAAE,CAAC;EACvD,CAAC;AACH","ignoreList":[]}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { type FormDefinition } from '@defra/forms-model';
|
|
1
|
+
import { type FormDefinition, type FormMetadata } from '@defra/forms-model';
|
|
2
2
|
import { type i18n } from 'i18next';
|
|
3
|
-
|
|
4
|
-
export declare function
|
|
5
|
-
export declare function
|
|
3
|
+
export declare function createFormTranslator(metadata: FormMetadata, definition: FormDefinition | undefined, language: string): import("../../../../server/plugins/engine/i18n/types.js").Translator;
|
|
4
|
+
export declare function loadFormTranslations(def: FormDefinition | undefined, i18nInstance: i18n): void;
|
|
5
|
+
export declare function extractMetadataBaseTranslations(metadata: FormMetadata | undefined, i18nInstance: i18n): void;
|
|
@@ -1,18 +1,47 @@
|
|
|
1
|
+
import { yesNoListNoItemId, yesNoListYesItemId } from '@defra/forms-model';
|
|
2
|
+
import { CY } from "../../../constants.js";
|
|
1
3
|
import { createTranslator } from "./createTranslator.js";
|
|
2
4
|
import { extractBaseTranslations } from "./extractBaseTranslations.js";
|
|
3
5
|
import { createFormI18nInstance } from "./index.js";
|
|
4
|
-
export function createFormTranslator(
|
|
5
|
-
const baseTranslations = extractBaseTranslations(
|
|
6
|
+
export function createFormTranslator(metadata, definition, language) {
|
|
7
|
+
const baseTranslations = extractBaseTranslations(definition);
|
|
6
8
|
const i18nInstance = createFormI18nInstance(baseTranslations);
|
|
7
|
-
loadFormTranslations(
|
|
8
|
-
|
|
9
|
+
loadFormTranslations(definition, i18nInstance);
|
|
10
|
+
extractMetadataBaseTranslations(metadata, i18nInstance);
|
|
11
|
+
const translator = createTranslator(i18nInstance, language);
|
|
12
|
+
return translator;
|
|
9
13
|
}
|
|
10
14
|
export function loadFormTranslations(def, i18nInstance) {
|
|
15
|
+
if (!def) {
|
|
16
|
+
return;
|
|
17
|
+
}
|
|
11
18
|
const formTranslations = def.metadata?.translations;
|
|
12
19
|
if (formTranslations) {
|
|
13
20
|
for (const [lng, resources] of Object.entries(formTranslations)) {
|
|
14
21
|
i18nInstance.addResourceBundle(lng, 'form', resources, true, true);
|
|
22
|
+
|
|
23
|
+
// Temporary workaround - until we develop a better solution
|
|
24
|
+
if (lng === CY) {
|
|
25
|
+
i18nInstance.addResource(lng, 'form', `listItems.${yesNoListYesItemId}.text`, 'Ie');
|
|
26
|
+
i18nInstance.addResource(lng, 'form', `listItems.${yesNoListNoItemId}.text`, 'Nage');
|
|
27
|
+
}
|
|
15
28
|
}
|
|
16
29
|
}
|
|
17
30
|
}
|
|
31
|
+
export function extractMetadataBaseTranslations(metadata, i18nInstance) {
|
|
32
|
+
if (metadata) {
|
|
33
|
+
const translations = {
|
|
34
|
+
'form.title': metadata.title,
|
|
35
|
+
'form.contact.email.address': metadata.contact?.email?.address ?? '',
|
|
36
|
+
'form.contact.email.responseTime': metadata.contact?.email?.responseTime ?? '',
|
|
37
|
+
'form.contact.online.url': metadata.contact?.online?.url ?? '',
|
|
38
|
+
'form.contact.online.text': metadata.contact?.online?.text ?? '',
|
|
39
|
+
'form.contact.phone': metadata.contact?.phone ?? '',
|
|
40
|
+
'form.submissionGuidance': metadata.submissionGuidance ?? '',
|
|
41
|
+
'form.privacyNoticeText': metadata.privacyNoticeText ?? '',
|
|
42
|
+
'form.privacyNoticeUrl': metadata.privacyNoticeUrl ?? ''
|
|
43
|
+
};
|
|
44
|
+
i18nInstance.addResourceBundle('en-GB', 'form', translations, true, true);
|
|
45
|
+
}
|
|
46
|
+
}
|
|
18
47
|
//# sourceMappingURL=createFormTranslator.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createFormTranslator.js","names":["createTranslator","extractBaseTranslations","createFormI18nInstance","createFormTranslator","
|
|
1
|
+
{"version":3,"file":"createFormTranslator.js","names":["yesNoListNoItemId","yesNoListYesItemId","CY","createTranslator","extractBaseTranslations","createFormI18nInstance","createFormTranslator","metadata","definition","language","baseTranslations","i18nInstance","loadFormTranslations","extractMetadataBaseTranslations","translator","def","formTranslations","translations","lng","resources","Object","entries","addResourceBundle","addResource","title","contact","email","address","responseTime","online","url","text","phone","submissionGuidance","privacyNoticeText","privacyNoticeUrl"],"sources":["../../../../../src/server/plugins/engine/i18n/createFormTranslator.ts"],"sourcesContent":["import {\n yesNoListNoItemId,\n yesNoListYesItemId,\n type FormDefinition,\n type FormMetadata\n} from '@defra/forms-model'\nimport { type i18n } from 'i18next'\n\nimport { CY } from '~/src/server/constants.js'\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 { type FormDefinitionTranslations } from '~/src/server/plugins/engine/i18n/types.js'\n\nexport function createFormTranslator(\n metadata: FormMetadata,\n definition: FormDefinition | undefined,\n language: string\n) {\n const baseTranslations = extractBaseTranslations(definition)\n const i18nInstance = createFormI18nInstance(baseTranslations)\n loadFormTranslations(definition, i18nInstance)\n extractMetadataBaseTranslations(metadata, i18nInstance)\n\n const translator = createTranslator(i18nInstance, language)\n\n return translator\n}\n\nexport function loadFormTranslations(\n def: FormDefinition | undefined,\n i18nInstance: i18n\n) {\n if (!def) {\n return\n }\n\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 // Temporary workaround - until we develop a better solution\n if (lng === CY) {\n i18nInstance.addResource(\n lng,\n 'form',\n `listItems.${yesNoListYesItemId}.text`,\n 'Ie'\n )\n i18nInstance.addResource(\n lng,\n 'form',\n `listItems.${yesNoListNoItemId}.text`,\n 'Nage'\n )\n }\n }\n }\n}\n\nexport function extractMetadataBaseTranslations(\n metadata: FormMetadata | undefined,\n i18nInstance: i18n\n) {\n if (metadata) {\n const translations = {\n 'form.title': metadata.title,\n 'form.contact.email.address': metadata.contact?.email?.address ?? '',\n 'form.contact.email.responseTime':\n metadata.contact?.email?.responseTime ?? '',\n 'form.contact.online.url': metadata.contact?.online?.url ?? '',\n 'form.contact.online.text': metadata.contact?.online?.text ?? '',\n 'form.contact.phone': metadata.contact?.phone ?? '',\n 'form.submissionGuidance': metadata.submissionGuidance ?? '',\n 'form.privacyNoticeText': metadata.privacyNoticeText ?? '',\n 'form.privacyNoticeUrl': metadata.privacyNoticeUrl ?? ''\n }\n i18nInstance.addResourceBundle('en-GB', 'form', translations, true, true)\n }\n}\n"],"mappings":"AAAA,SACEA,iBAAiB,EACjBC,kBAAkB,QAGb,oBAAoB;AAG3B,SAASC,EAAE;AACX,SAASC,gBAAgB;AACzB,SAASC,uBAAuB;AAChC,SAASC,sBAAsB;AAG/B,OAAO,SAASC,oBAAoBA,CAClCC,QAAsB,EACtBC,UAAsC,EACtCC,QAAgB,EAChB;EACA,MAAMC,gBAAgB,GAAGN,uBAAuB,CAACI,UAAU,CAAC;EAC5D,MAAMG,YAAY,GAAGN,sBAAsB,CAACK,gBAAgB,CAAC;EAC7DE,oBAAoB,CAACJ,UAAU,EAAEG,YAAY,CAAC;EAC9CE,+BAA+B,CAACN,QAAQ,EAAEI,YAAY,CAAC;EAEvD,MAAMG,UAAU,GAAGX,gBAAgB,CAACQ,YAAY,EAAEF,QAAQ,CAAC;EAE3D,OAAOK,UAAU;AACnB;AAEA,OAAO,SAASF,oBAAoBA,CAClCG,GAA+B,EAC/BJ,YAAkB,EAClB;EACA,IAAI,CAACI,GAAG,EAAE;IACR;EACF;EAEA,MAAMC,gBAAgB,GAAGD,GAAG,CAACR,QAAQ,EAAEU,YAE1B;EAEb,IAAID,gBAAgB,EAAE;IACpB,KAAK,MAAM,CAACE,GAAG,EAAEC,SAAS,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACL,gBAAgB,CAAC,EAAE;MAC/DL,YAAY,CAACW,iBAAiB,CAACJ,GAAG,EAAE,MAAM,EAAEC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC;;MAElE;MACA,IAAID,GAAG,KAAKhB,EAAE,EAAE;QACdS,YAAY,CAACY,WAAW,CACtBL,GAAG,EACH,MAAM,EACN,aAAajB,kBAAkB,OAAO,EACtC,IACF,CAAC;QACDU,YAAY,CAACY,WAAW,CACtBL,GAAG,EACH,MAAM,EACN,aAAalB,iBAAiB,OAAO,EACrC,MACF,CAAC;MACH;IACF;EACF;AACF;AAEA,OAAO,SAASa,+BAA+BA,CAC7CN,QAAkC,EAClCI,YAAkB,EAClB;EACA,IAAIJ,QAAQ,EAAE;IACZ,MAAMU,YAAY,GAAG;MACnB,YAAY,EAAEV,QAAQ,CAACiB,KAAK;MAC5B,4BAA4B,EAAEjB,QAAQ,CAACkB,OAAO,EAAEC,KAAK,EAAEC,OAAO,IAAI,EAAE;MACpE,iCAAiC,EAC/BpB,QAAQ,CAACkB,OAAO,EAAEC,KAAK,EAAEE,YAAY,IAAI,EAAE;MAC7C,yBAAyB,EAAErB,QAAQ,CAACkB,OAAO,EAAEI,MAAM,EAAEC,GAAG,IAAI,EAAE;MAC9D,0BAA0B,EAAEvB,QAAQ,CAACkB,OAAO,EAAEI,MAAM,EAAEE,IAAI,IAAI,EAAE;MAChE,oBAAoB,EAAExB,QAAQ,CAACkB,OAAO,EAAEO,KAAK,IAAI,EAAE;MACnD,yBAAyB,EAAEzB,QAAQ,CAAC0B,kBAAkB,IAAI,EAAE;MAC5D,wBAAwB,EAAE1B,QAAQ,CAAC2B,iBAAiB,IAAI,EAAE;MAC1D,uBAAuB,EAAE3B,QAAQ,CAAC4B,gBAAgB,IAAI;IACxD,CAAC;IACDxB,YAAY,CAACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAEL,YAAY,EAAE,IAAI,EAAE,IAAI,CAAC;EAC3E;AACF","ignoreList":[]}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type FormDefinition } from '@defra/forms-model';
|
|
2
2
|
import { type FormDefinitionTranslations } from '../../../../server/plugins/engine/i18n/types.js';
|
|
3
3
|
type BaseTranslations = FormDefinitionTranslations[string];
|
|
4
|
-
export declare function extractBaseTranslations(def: FormDefinition): BaseTranslations;
|
|
4
|
+
export declare function extractBaseTranslations(def: FormDefinition | undefined): BaseTranslations;
|
|
5
5
|
export {};
|
|
@@ -5,6 +5,15 @@ export function extractBaseTranslations(def) {
|
|
|
5
5
|
const sections = {};
|
|
6
6
|
const listItems = {};
|
|
7
7
|
const form = {};
|
|
8
|
+
if (!def) {
|
|
9
|
+
return {
|
|
10
|
+
pages,
|
|
11
|
+
components,
|
|
12
|
+
sections,
|
|
13
|
+
listItems,
|
|
14
|
+
form
|
|
15
|
+
};
|
|
16
|
+
}
|
|
8
17
|
for (const page of def.pages) {
|
|
9
18
|
if (page.id && page.title) {
|
|
10
19
|
pages[page.id] = {
|
|
@@ -1 +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,
|
|
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(\n def: FormDefinition | undefined\n): 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 if (!def) {\n return { pages, components, sections, listItems, form }\n }\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,CACrCC,GAA+B,EACb;EAClB,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,IAAI,CAACL,GAAG,EAAE;IACR,OAAO;MAAEC,KAAK;MAAEC,UAAU;MAAEC,QAAQ;MAAEC,SAAS;MAAEC;IAAK,CAAC;EACzD;EAEA,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,13 @@
|
|
|
1
|
+
import { type FormMetadata, type FormStatus } from '@defra/forms-model';
|
|
2
|
+
import { type Translator } from '../../../../server/plugins/engine/i18n/types.js';
|
|
3
|
+
import { type AnyFormRequest } from '../../../../server/plugins/engine/types.js';
|
|
4
|
+
/**
|
|
5
|
+
* Get translator for plugin, for the current form's metadata (as well as the plugin-specific boilerplate).
|
|
6
|
+
* This is an async call so we can read the form definition inside this call.
|
|
7
|
+
* See docs/features/multi-language.md for the language and translation flow overview.
|
|
8
|
+
* @param {AnyFormRequest} request
|
|
9
|
+
* @param {FormMetadata} metadata - the metadata of the form
|
|
10
|
+
* @param {FormStatus} status - the form status to use when retrieving the definition
|
|
11
|
+
* @param {string} language - the language to use for the translator
|
|
12
|
+
*/
|
|
13
|
+
export declare function getCachedPluginTranslator(request: AnyFormRequest, metadata: FormMetadata, status: FormStatus, language: string): Promise<Translator>;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import Boom from '@hapi/boom';
|
|
2
|
+
import { LRUCache } from 'lru-cache';
|
|
3
|
+
import { getPluginOptions } from "../helpers.js";
|
|
4
|
+
import { createFormTranslator } from "./createFormTranslator.js";
|
|
5
|
+
const cache = new LRUCache({
|
|
6
|
+
max: 100,
|
|
7
|
+
ttl: 1000 * 60 * 15 // 15 minutes
|
|
8
|
+
});
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Get translator for plugin, for the current form's metadata (as well as the plugin-specific boilerplate).
|
|
12
|
+
* This is an async call so we can read the form definition inside this call.
|
|
13
|
+
* See docs/features/multi-language.md for the language and translation flow overview.
|
|
14
|
+
* @param {AnyFormRequest} request
|
|
15
|
+
* @param {FormMetadata} metadata - the metadata of the form
|
|
16
|
+
* @param {FormStatus} status - the form status to use when retrieving the definition
|
|
17
|
+
* @param {string} language - the language to use for the translator
|
|
18
|
+
*/
|
|
19
|
+
export async function getCachedPluginTranslator(request, metadata, status, language) {
|
|
20
|
+
const key = `${metadata.id}-${status}-${language}-plugin-meta`;
|
|
21
|
+
if (cache.has(key)) {
|
|
22
|
+
return cache.get(key);
|
|
23
|
+
}
|
|
24
|
+
const {
|
|
25
|
+
services
|
|
26
|
+
} = getPluginOptions(request.server);
|
|
27
|
+
const definition = await services?.formsService.getFormDefinition(metadata.id, status);
|
|
28
|
+
if (!definition) {
|
|
29
|
+
throw Boom.notFound(`FormDefinition not found for form ${metadata.id} and status ${status}`);
|
|
30
|
+
}
|
|
31
|
+
const translator = createFormTranslator(metadata, definition, language);
|
|
32
|
+
cache.set(key, translator);
|
|
33
|
+
return translator;
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=form.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"form.js","names":["Boom","LRUCache","getPluginOptions","createFormTranslator","cache","max","ttl","getCachedPluginTranslator","request","metadata","status","language","key","id","has","get","services","server","definition","formsService","getFormDefinition","notFound","translator","set"],"sources":["../../../../../src/server/plugins/engine/i18n/form.ts"],"sourcesContent":["import { type FormMetadata, type FormStatus } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\nimport { LRUCache } from 'lru-cache'\n\nimport { getPluginOptions } from '~/src/server/plugins/engine/helpers.js'\nimport { createFormTranslator } from '~/src/server/plugins/engine/i18n/createFormTranslator.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport { type AnyFormRequest } from '~/src/server/plugins/engine/types.js'\n\nconst cache = new LRUCache({\n max: 100,\n ttl: 1000 * 60 * 15 // 15 minutes\n})\n\n/**\n * Get translator for plugin, for the current form's metadata (as well as the plugin-specific boilerplate).\n * This is an async call so we can read the form definition inside this call.\n * See docs/features/multi-language.md for the language and translation flow overview.\n * @param {AnyFormRequest} request\n * @param {FormMetadata} metadata - the metadata of the form\n * @param {FormStatus} status - the form status to use when retrieving the definition\n * @param {string} language - the language to use for the translator\n */\nexport async function getCachedPluginTranslator(\n request: AnyFormRequest,\n metadata: FormMetadata,\n status: FormStatus,\n language: string\n) {\n const key = `${metadata.id}-${status}-${language}-plugin-meta`\n\n if (cache.has(key)) {\n return cache.get(key) as unknown as Translator\n }\n\n const { services } = getPluginOptions(request.server)\n\n const definition = await services?.formsService.getFormDefinition(\n metadata.id,\n status\n )\n\n if (!definition) {\n throw Boom.notFound(\n `FormDefinition not found for form ${metadata.id} and status ${status}`\n )\n }\n\n const translator = createFormTranslator(metadata, definition, language)\n\n cache.set(key, translator)\n\n return translator\n}\n"],"mappings":"AACA,OAAOA,IAAI,MAAM,YAAY;AAC7B,SAASC,QAAQ,QAAQ,WAAW;AAEpC,SAASC,gBAAgB;AACzB,SAASC,oBAAoB;AAI7B,MAAMC,KAAK,GAAG,IAAIH,QAAQ,CAAC;EACzBI,GAAG,EAAE,GAAG;EACRC,GAAG,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC;AACtB,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,yBAAyBA,CAC7CC,OAAuB,EACvBC,QAAsB,EACtBC,MAAkB,EAClBC,QAAgB,EAChB;EACA,MAAMC,GAAG,GAAG,GAAGH,QAAQ,CAACI,EAAE,IAAIH,MAAM,IAAIC,QAAQ,cAAc;EAE9D,IAAIP,KAAK,CAACU,GAAG,CAACF,GAAG,CAAC,EAAE;IAClB,OAAOR,KAAK,CAACW,GAAG,CAACH,GAAG,CAAC;EACvB;EAEA,MAAM;IAAEI;EAAS,CAAC,GAAGd,gBAAgB,CAACM,OAAO,CAACS,MAAM,CAAC;EAErD,MAAMC,UAAU,GAAG,MAAMF,QAAQ,EAAEG,YAAY,CAACC,iBAAiB,CAC/DX,QAAQ,CAACI,EAAE,EACXH,MACF,CAAC;EAED,IAAI,CAACQ,UAAU,EAAE;IACf,MAAMlB,IAAI,CAACqB,QAAQ,CACjB,qCAAqCZ,QAAQ,CAACI,EAAE,eAAeH,MAAM,EACvE,CAAC;EACH;EAEA,MAAMY,UAAU,GAAGnB,oBAAoB,CAACM,QAAQ,EAAES,UAAU,EAAEP,QAAQ,CAAC;EAEvEP,KAAK,CAACmB,GAAG,CAACX,GAAG,EAAEU,UAAU,CAAC;EAE1B,OAAOA,UAAU;AACnB","ignoreList":[]}
|