@defra/forms-engine-plugin 5.0.0-alpha.12 → 5.0.0-alpha.14
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/shared.min.js +1 -1
- package/.public/javascripts/shared.min.js.map +1 -1
- package/.server/client/javascripts/geospatial-map.d.ts +153 -5
- package/.server/client/javascripts/geospatial-map.js +147 -46
- package/.server/client/javascripts/geospatial-map.js.map +1 -1
- package/.server/client/javascripts/location-map.d.ts +44 -0
- package/.server/client/javascripts/location-map.js +43 -3
- 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 +4 -0
- package/.server/client/javascripts/map.js +5 -0
- package/.server/client/javascripts/map.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/EastingNorthingField.d.ts +2 -0
- package/.server/server/plugins/engine/components/GeospatialField.d.ts +1 -0
- package/.server/server/plugins/engine/components/GeospatialField.js +1 -0
- package/.server/server/plugins/engine/components/GeospatialField.js.map +1 -1
- package/.server/server/plugins/engine/components/LatLongField.d.ts +2 -0
- package/.server/server/plugins/engine/components/LocationFieldBase.js +3 -0
- package/.server/server/plugins/engine/components/LocationFieldBase.js.map +1 -1
- package/.server/server/plugins/engine/components/LocationFieldHelpers.d.ts +2 -0
- package/.server/server/plugins/engine/components/LocationFieldHelpers.js +2 -1
- package/.server/server/plugins/engine/components/LocationFieldHelpers.js.map +1 -1
- package/.server/server/plugins/engine/components/helpers/components.js +2 -1
- package/.server/server/plugins/engine/components/helpers/components.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/i18n/translations/cy.json +51 -1
- package/.server/server/plugins/engine/i18n/translations/en-GB.json +51 -1
- package/.server/server/plugins/engine/models/FormModel.js +10 -2
- package/.server/server/plugins/engine/models/FormModel.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/views/components/_location-field-base.html +1 -0
- package/.server/server/plugins/engine/views/components/geospatialfield.html +1 -0
- package/.server/server/plugins/engine/views/components/osgridreffield.html +3 -1
- package/package.json +1 -1
- package/src/client/javascripts/geospatial-map.js +169 -47
- package/src/client/javascripts/location-map.js +51 -3
- package/src/client/javascripts/map-constants.js +3 -0
- package/src/client/javascripts/map.js +5 -0
- package/src/server/plugins/engine/__stubs__/definitions.ts +155 -0
- package/src/server/plugins/engine/components/GeospatialField.ts +1 -0
- package/src/server/plugins/engine/components/LocationFieldBase.ts +4 -0
- package/src/server/plugins/engine/components/LocationFieldHelpers.ts +2 -1
- package/src/server/plugins/engine/components/helpers/components.ts +2 -1
- package/src/server/plugins/engine/errors.ts +78 -0
- package/src/server/plugins/engine/i18n/translations/cy.json +51 -1
- package/src/server/plugins/engine/i18n/translations/en-GB.json +51 -1
- package/src/server/plugins/engine/models/FormModel.ts +12 -2
- package/src/server/plugins/engine/pageControllers/helpers/pages.ts +2 -1
- package/src/server/plugins/engine/views/components/_location-field-base.html +1 -0
- package/src/server/plugins/engine/views/components/geospatialfield.html +1 -0
- package/src/server/plugins/engine/views/components/osgridreffield.html +3 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"LocationFieldHelpers.js","names":["EastingNorthingField","isFormValue","lowercaseMessageStart","message","charAt","toLowerCase","slice","joinWithAnd","items","translator","t","length","leading","join","last","formatErrorList","messages","formattedMessages","map","msg","index","mergeCssClasses","classNames","tokens","flatMap","name","split","token","trim","filter","Boolean","undefined","Array","from","Set","deduplicateErrorsByHref","errors","error","self","findIndex","err","href","getMapLayers","component","mapLayers","options","layers","sssi","push","getLocationFieldViewModel","viewModel","context","collection","fieldset","existingFieldset","label","subViewModels","getViewModel","fieldErrors","forEach","model","errorMessage","text","hasFieldErrors","type","value","classes","prefix","suffix","toString","baseItem","id","showFieldsetError","legend","result","country","countries","at","instructionText","tComponent","instructionSummary","def","createLocationFieldValidator","payload","helpers","values","getFormValueFromState","getStateFromValidForm","missing","keys","key","isState","required"],"sources":["../../../../../src/server/plugins/engine/components/LocationFieldHelpers.ts"],"sourcesContent":["import { type Context, type CustomValidator } from 'joi'\n\nimport { EastingNorthingField } from '~/src/server/plugins/engine/components/EastingNorthingField.js'\nimport { isFormValue } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type GeospatialField } from '~/src/server/plugins/engine/components/GeospatialField.js'\nimport { type LatLongField } from '~/src/server/plugins/engine/components/LatLongField.js'\nimport { type OsGridRefField } from '~/src/server/plugins/engine/components/OsGridRefField.js'\nimport {\n type DateInputItem,\n type Label,\n type RenderContext,\n type ViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport {\n type FormPayload,\n type FormSubmissionError,\n type FormValue\n} from '~/src/server/plugins/engine/types.js'\n\nexport type LocationField =\n | InstanceType<typeof EastingNorthingField>\n | InstanceType<typeof LatLongField>\n\n/**\n * Lowercases the start of a message for concatenation.\n * Handles patterns like:\n * - \"Enter latitude\" -> \"enter latitude\"\n * - \"Enter a valid latitude...\" -> \"enter a valid latitude...\"\n * - \"latitude must be...\" -> \"latitude must be...\"\n */\nfunction lowercaseMessageStart(message: string): string {\n // Lowercase first character for a message\n return message.charAt(0).toLowerCase() + message.slice(1)\n}\n\nexport function joinWithAnd(items: string[], translator: Translator): string {\n const { t } = translator\n if (items.length === 2) {\n return `${items[0]} ${t('common.and')} ${items[1]}`\n }\n\n const leading = items.slice(0, -1).join(', ')\n const last = items[items.length - 1]\n return `${leading} ${t('common.and')} ${last}`\n}\n\nexport function formatErrorList(\n messages: string[],\n translator: Translator\n): string {\n if (!messages.length) {\n return ''\n }\n\n if (messages.length === 1) {\n return messages[0]\n }\n\n const formattedMessages = messages.map((msg, index) =>\n index === 0 ? msg : lowercaseMessageStart(msg)\n )\n\n return joinWithAnd(formattedMessages, translator)\n}\n\nexport function mergeCssClasses(...classNames: (string | undefined)[]) {\n const tokens = classNames\n .flatMap((name) => name?.split(/\\s+/) ?? [])\n .map((token) => token.trim())\n .filter(Boolean)\n\n if (!tokens.length) {\n return undefined\n }\n\n return Array.from(new Set(tokens)).join(' ')\n}\n\nexport function deduplicateErrorsByHref(\n errors?: FormSubmissionError[]\n): FormSubmissionError[] | undefined {\n if (!errors?.length) {\n return undefined\n }\n\n return errors.filter(\n (error, index, self) =>\n index === self.findIndex((err) => err.href === error.href)\n )\n}\n\nexport function getMapLayers(\n component:\n | GeospatialField\n | OsGridRefField\n | LatLongField\n | EastingNorthingField\n) {\n const { mapLayers } = component.options\n const layers = []\n\n if (mapLayers?.sssi) {\n layers.push('sssi')\n }\n\n return layers.join(',')\n}\n\nexport function getLocationFieldViewModel(\n component: LocationField,\n viewModel: ViewModel & {\n label: Label\n id: string\n name: string\n value: FormValue\n },\n context: RenderContext\n) {\n const { collection } = component\n const { fieldset: existingFieldset, label } = viewModel\n\n const subViewModels = collection.getViewModel(context)\n\n const fieldErrors: string[] = []\n subViewModels.forEach(({ model }) => {\n if (model.errorMessage?.text) {\n fieldErrors.push(model.errorMessage.text)\n }\n })\n\n const hasFieldErrors = fieldErrors.length > 0\n\n const items: DateInputItem[] = subViewModels.map(\n ({ model }): DateInputItem => {\n let { label, type, value, classes, prefix, suffix, errorMessage } = model\n\n if (label) {\n label.toString = () => label.text\n }\n\n if (!isFormValue(value)) {\n value = undefined\n }\n\n const baseItem: DateInputItem = {\n label,\n id: model.id,\n name: model.name,\n type,\n value,\n classes: mergeCssClasses(\n classes,\n hasFieldErrors ? 'govuk-input--error' : undefined\n ),\n prefix,\n suffix\n }\n\n if (!hasFieldErrors && errorMessage) {\n baseItem.errorMessage = errorMessage\n }\n\n return baseItem\n }\n )\n\n const showFieldsetError =\n hasFieldErrors || Boolean(viewModel.errorMessage?.text)\n\n viewModel.showFieldsetError = showFieldsetError\n\n if (hasFieldErrors) {\n viewModel.errorMessage = {\n text:\n fieldErrors.length === 1\n ? fieldErrors[0]\n : formatErrorList(fieldErrors, context.translator)\n }\n }\n\n const fieldset = existingFieldset ?? {\n legend: {\n text: label.text,\n classes: 'govuk-fieldset__legend--m'\n }\n }\n\n const result = {\n ...viewModel,\n fieldset,\n items,\n mapLayers: getMapLayers(component),\n country:\n component instanceof EastingNorthingField\n ? component.options.countries?.at(0)\n : undefined\n }\n\n if (component.options.instructionText) {\n const { t, tComponent } = context.translator\n\n return {\n ...result,\n instructionSummary: t('components.locationFieldBase.howToFind'),\n instructionText:\n tComponent(component.def, 'instructionText') ||\n component.options.instructionText,\n t\n }\n }\n\n return result\n}\n\n/**\n * Validator factory for location-based fields.\n * This creates a validator that ensures all required fields are present.\n */\nexport function createLocationFieldValidator(\n component: LocationField\n): CustomValidator {\n return (payload: FormPayload, helpers) => {\n const { collection, name, options } = component\n\n const values = component.getFormValueFromState(\n component.getStateFromValidForm(payload)\n )\n\n const context: Context = {\n missing: collection.keys,\n key: name\n }\n\n if (!component.isState(values)) {\n return options.required !== false\n ? helpers.error('object.required', context)\n : payload\n }\n\n return payload\n }\n}\n"],"mappings":"AAEA,SAASA,oBAAoB;AAC7B,SAASC,WAAW;AAqBpB;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,qBAAqBA,CAACC,OAAe,EAAU;EACtD;EACA,OAAOA,OAAO,CAACC,MAAM,CAAC,CAAC,CAAC,CAACC,WAAW,CAAC,CAAC,GAAGF,OAAO,CAACG,KAAK,CAAC,CAAC,CAAC;AAC3D;AAEA,OAAO,SAASC,WAAWA,CAACC,KAAe,EAAEC,UAAsB,EAAU;EAC3E,MAAM;IAAEC;EAAE,CAAC,GAAGD,UAAU;EACxB,IAAID,KAAK,CAACG,MAAM,KAAK,CAAC,EAAE;IACtB,OAAO,GAAGH,KAAK,CAAC,CAAC,CAAC,IAAIE,CAAC,CAAC,YAAY,CAAC,IAAIF,KAAK,CAAC,CAAC,CAAC,EAAE;EACrD;EAEA,MAAMI,OAAO,GAAGJ,KAAK,CAACF,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAACO,IAAI,CAAC,IAAI,CAAC;EAC7C,MAAMC,IAAI,GAAGN,KAAK,CAACA,KAAK,CAACG,MAAM,GAAG,CAAC,CAAC;EACpC,OAAO,GAAGC,OAAO,IAAIF,CAAC,CAAC,YAAY,CAAC,IAAII,IAAI,EAAE;AAChD;AAEA,OAAO,SAASC,eAAeA,CAC7BC,QAAkB,EAClBP,UAAsB,EACd;EACR,IAAI,CAACO,QAAQ,CAACL,MAAM,EAAE;IACpB,OAAO,EAAE;EACX;EAEA,IAAIK,QAAQ,CAACL,MAAM,KAAK,CAAC,EAAE;IACzB,OAAOK,QAAQ,CAAC,CAAC,CAAC;EACpB;EAEA,MAAMC,iBAAiB,GAAGD,QAAQ,CAACE,GAAG,CAAC,CAACC,GAAG,EAAEC,KAAK,KAChDA,KAAK,KAAK,CAAC,GAAGD,GAAG,GAAGjB,qBAAqB,CAACiB,GAAG,CAC/C,CAAC;EAED,OAAOZ,WAAW,CAACU,iBAAiB,EAAER,UAAU,CAAC;AACnD;AAEA,OAAO,SAASY,eAAeA,CAAC,GAAGC,UAAkC,EAAE;EACrE,MAAMC,MAAM,GAAGD,UAAU,CACtBE,OAAO,CAAEC,IAAI,IAAKA,IAAI,EAAEC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAC3CR,GAAG,CAAES,KAAK,IAAKA,KAAK,CAACC,IAAI,CAAC,CAAC,CAAC,CAC5BC,MAAM,CAACC,OAAO,CAAC;EAElB,IAAI,CAACP,MAAM,CAACZ,MAAM,EAAE;IAClB,OAAOoB,SAAS;EAClB;EAEA,OAAOC,KAAK,CAACC,IAAI,CAAC,IAAIC,GAAG,CAACX,MAAM,CAAC,CAAC,CAACV,IAAI,CAAC,GAAG,CAAC;AAC9C;AAEA,OAAO,SAASsB,uBAAuBA,CACrCC,MAA8B,EACK;EACnC,IAAI,CAACA,MAAM,EAAEzB,MAAM,EAAE;IACnB,OAAOoB,SAAS;EAClB;EAEA,OAAOK,MAAM,CAACP,MAAM,CAClB,CAACQ,KAAK,EAAEjB,KAAK,EAAEkB,IAAI,KACjBlB,KAAK,KAAKkB,IAAI,CAACC,SAAS,CAAEC,GAAG,IAAKA,GAAG,CAACC,IAAI,KAAKJ,KAAK,CAACI,IAAI,CAC7D,CAAC;AACH;AAEA,OAAO,SAASC,YAAYA,CAC1BC,SAIwB,EACxB;EACA,MAAM;IAAEC;EAAU,CAAC,GAAGD,SAAS,CAACE,OAAO;EACvC,MAAMC,MAAM,GAAG,EAAE;EAEjB,IAAIF,SAAS,EAAEG,IAAI,EAAE;IACnBD,MAAM,CAACE,IAAI,CAAC,MAAM,CAAC;EACrB;EAEA,OAAOF,MAAM,CAACjC,IAAI,CAAC,GAAG,CAAC;AACzB;AAEA,OAAO,SAASoC,yBAAyBA,CACvCN,SAAwB,EACxBO,SAKC,EACDC,OAAsB,EACtB;EACA,MAAM;IAAEC;EAAW,CAAC,GAAGT,SAAS;EAChC,MAAM;IAAEU,QAAQ,EAAEC,gBAAgB;IAAEC;EAAM,CAAC,GAAGL,SAAS;EAEvD,MAAMM,aAAa,GAAGJ,UAAU,CAACK,YAAY,CAACN,OAAO,CAAC;EAEtD,MAAMO,WAAqB,GAAG,EAAE;EAChCF,aAAa,CAACG,OAAO,CAAC,CAAC;IAAEC;EAAM,CAAC,KAAK;IACnC,IAAIA,KAAK,CAACC,YAAY,EAAEC,IAAI,EAAE;MAC5BJ,WAAW,CAACV,IAAI,CAACY,KAAK,CAACC,YAAY,CAACC,IAAI,CAAC;IAC3C;EACF,CAAC,CAAC;EAEF,MAAMC,cAAc,GAAGL,WAAW,CAAC/C,MAAM,GAAG,CAAC;EAE7C,MAAMH,KAAsB,GAAGgD,aAAa,CAACtC,GAAG,CAC9C,CAAC;IAAE0C;EAAM,CAAC,KAAoB;IAC5B,IAAI;MAAEL,KAAK;MAAES,IAAI;MAAEC,KAAK;MAAEC,OAAO;MAAEC,MAAM;MAAEC,MAAM;MAAEP;IAAa,CAAC,GAAGD,KAAK;IAEzE,IAAIL,KAAK,EAAE;MACTA,KAAK,CAACc,QAAQ,GAAG,MAAMd,KAAK,CAACO,IAAI;IACnC;IAEA,IAAI,CAAC7D,WAAW,CAACgE,KAAK,CAAC,EAAE;MACvBA,KAAK,GAAGlC,SAAS;IACnB;IAEA,MAAMuC,QAAuB,GAAG;MAC9Bf,KAAK;MACLgB,EAAE,EAAEX,KAAK,CAACW,EAAE;MACZ9C,IAAI,EAAEmC,KAAK,CAACnC,IAAI;MAChBuC,IAAI;MACJC,KAAK;MACLC,OAAO,EAAE7C,eAAe,CACtB6C,OAAO,EACPH,cAAc,GAAG,oBAAoB,GAAGhC,SAC1C,CAAC;MACDoC,MAAM;MACNC;IACF,CAAC;IAED,IAAI,CAACL,cAAc,IAAIF,YAAY,EAAE;MACnCS,QAAQ,CAACT,YAAY,GAAGA,YAAY;IACtC;IAEA,OAAOS,QAAQ;EACjB,CACF,CAAC;EAED,MAAME,iBAAiB,GACrBT,cAAc,IAAIjC,OAAO,CAACoB,SAAS,CAACW,YAAY,EAAEC,IAAI,CAAC;EAEzDZ,SAAS,CAACsB,iBAAiB,GAAGA,iBAAiB;EAE/C,IAAIT,cAAc,EAAE;IAClBb,SAAS,CAACW,YAAY,GAAG;MACvBC,IAAI,EACFJ,WAAW,CAAC/C,MAAM,KAAK,CAAC,GACpB+C,WAAW,CAAC,CAAC,CAAC,GACd3C,eAAe,CAAC2C,WAAW,EAAEP,OAAO,CAAC1C,UAAU;IACvD,CAAC;EACH;EAEA,MAAM4C,QAAQ,GAAGC,gBAAgB,IAAI;IACnCmB,MAAM,EAAE;MACNX,IAAI,EAAEP,KAAK,CAACO,IAAI;MAChBI,OAAO,EAAE;IACX;EACF,CAAC;EAED,MAAMQ,MAAM,GAAG;IACb,GAAGxB,SAAS;IACZG,QAAQ;IACR7C,KAAK;IACLoC,SAAS,EAAEF,YAAY,CAACC,SAAS,CAAC;IAClCgC,OAAO,EACLhC,SAAS,YAAY3C,oBAAoB,GACrC2C,SAAS,CAACE,OAAO,CAAC+B,SAAS,EAAEC,EAAE,CAAC,CAAC,CAAC,GAClC9C;EACR,CAAC;EAED,IAAIY,SAAS,CAACE,OAAO,CAACiC,eAAe,EAAE;IACrC,MAAM;MAAEpE,CAAC;MAAEqE;IAAW,CAAC,GAAG5B,OAAO,CAAC1C,UAAU;IAE5C,OAAO;MACL,GAAGiE,MAAM;MACTM,kBAAkB,EAAEtE,CAAC,CAAC,wCAAwC,CAAC;MAC/DoE,eAAe,EACbC,UAAU,CAACpC,SAAS,CAACsC,GAAG,EAAE,iBAAiB,CAAC,IAC5CtC,SAAS,CAACE,OAAO,CAACiC,eAAe;MACnCpE;IACF,CAAC;EACH;EAEA,OAAOgE,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASQ,4BAA4BA,CAC1CvC,SAAwB,EACP;EACjB,OAAO,CAACwC,OAAoB,EAAEC,OAAO,KAAK;IACxC,MAAM;MAAEhC,UAAU;MAAE3B,IAAI;MAAEoB;IAAQ,CAAC,GAAGF,SAAS;IAE/C,MAAM0C,MAAM,GAAG1C,SAAS,CAAC2C,qBAAqB,CAC5C3C,SAAS,CAAC4C,qBAAqB,CAACJ,OAAO,CACzC,CAAC;IAED,MAAMhC,OAAgB,GAAG;MACvBqC,OAAO,EAAEpC,UAAU,CAACqC,IAAI;MACxBC,GAAG,EAAEjE;IACP,CAAC;IAED,IAAI,CAACkB,SAAS,CAACgD,OAAO,CAACN,MAAM,CAAC,EAAE;MAC9B,OAAOxC,OAAO,CAAC+C,QAAQ,KAAK,KAAK,GAC7BR,OAAO,CAAC/C,KAAK,CAAC,iBAAiB,EAAEc,OAAO,CAAC,GACzCgC,OAAO;IACb;IAEA,OAAOA,OAAO;EAChB,CAAC;AACH","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"LocationFieldHelpers.js","names":["EastingNorthingField","isFormValue","lowercaseMessageStart","message","charAt","toLowerCase","slice","joinWithAnd","items","translator","t","length","leading","join","last","formatErrorList","messages","formattedMessages","map","msg","index","mergeCssClasses","classNames","tokens","flatMap","name","split","token","trim","filter","Boolean","undefined","Array","from","Set","deduplicateErrorsByHref","errors","error","self","findIndex","err","href","getMapLayers","component","mapLayers","options","layers","sssi","push","getLocationFieldViewModel","viewModel","context","collection","fieldset","existingFieldset","label","subViewModels","getViewModel","fieldErrors","forEach","model","errorMessage","text","hasFieldErrors","type","value","classes","prefix","suffix","toString","baseItem","id","showFieldsetError","legend","result","country","countries","at","lang","language","instructionText","tComponent","instructionSummary","def","createLocationFieldValidator","payload","helpers","values","getFormValueFromState","getStateFromValidForm","missing","keys","key","isState","required"],"sources":["../../../../../src/server/plugins/engine/components/LocationFieldHelpers.ts"],"sourcesContent":["import { type Context, type CustomValidator } from 'joi'\n\nimport { EastingNorthingField } from '~/src/server/plugins/engine/components/EastingNorthingField.js'\nimport { isFormValue } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type GeospatialField } from '~/src/server/plugins/engine/components/GeospatialField.js'\nimport { type LatLongField } from '~/src/server/plugins/engine/components/LatLongField.js'\nimport { type OsGridRefField } from '~/src/server/plugins/engine/components/OsGridRefField.js'\nimport {\n type DateInputItem,\n type Label,\n type RenderContext,\n type ViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport {\n type FormPayload,\n type FormSubmissionError,\n type FormValue\n} from '~/src/server/plugins/engine/types.js'\n\nexport type LocationField =\n | InstanceType<typeof EastingNorthingField>\n | InstanceType<typeof LatLongField>\n\n/**\n * Lowercases the start of a message for concatenation.\n * Handles patterns like:\n * - \"Enter latitude\" -> \"enter latitude\"\n * - \"Enter a valid latitude...\" -> \"enter a valid latitude...\"\n * - \"latitude must be...\" -> \"latitude must be...\"\n */\nfunction lowercaseMessageStart(message: string): string {\n // Lowercase first character for a message\n return message.charAt(0).toLowerCase() + message.slice(1)\n}\n\nexport function joinWithAnd(items: string[], translator: Translator): string {\n const { t } = translator\n if (items.length === 2) {\n return `${items[0]} ${t('common.and')} ${items[1]}`\n }\n\n const leading = items.slice(0, -1).join(', ')\n const last = items[items.length - 1]\n return `${leading} ${t('common.and')} ${last}`\n}\n\nexport function formatErrorList(\n messages: string[],\n translator: Translator\n): string {\n if (!messages.length) {\n return ''\n }\n\n if (messages.length === 1) {\n return messages[0]\n }\n\n const formattedMessages = messages.map((msg, index) =>\n index === 0 ? msg : lowercaseMessageStart(msg)\n )\n\n return joinWithAnd(formattedMessages, translator)\n}\n\nexport function mergeCssClasses(...classNames: (string | undefined)[]) {\n const tokens = classNames\n .flatMap((name) => name?.split(/\\s+/) ?? [])\n .map((token) => token.trim())\n .filter(Boolean)\n\n if (!tokens.length) {\n return undefined\n }\n\n return Array.from(new Set(tokens)).join(' ')\n}\n\nexport function deduplicateErrorsByHref(\n errors?: FormSubmissionError[]\n): FormSubmissionError[] | undefined {\n if (!errors?.length) {\n return undefined\n }\n\n return errors.filter(\n (error, index, self) =>\n index === self.findIndex((err) => err.href === error.href)\n )\n}\n\nexport function getMapLayers(\n component:\n | GeospatialField\n | OsGridRefField\n | LatLongField\n | EastingNorthingField\n) {\n const { mapLayers } = component.options\n const layers = []\n\n if (mapLayers?.sssi) {\n layers.push('sssi')\n }\n\n return layers.join(',')\n}\n\nexport function getLocationFieldViewModel(\n component: LocationField,\n viewModel: ViewModel & {\n label: Label\n id: string\n name: string\n value: FormValue\n },\n context: RenderContext\n) {\n const { collection } = component\n const { fieldset: existingFieldset, label } = viewModel\n\n const subViewModels = collection.getViewModel(context)\n\n const fieldErrors: string[] = []\n subViewModels.forEach(({ model }) => {\n if (model.errorMessage?.text) {\n fieldErrors.push(model.errorMessage.text)\n }\n })\n\n const hasFieldErrors = fieldErrors.length > 0\n\n const items: DateInputItem[] = subViewModels.map(\n ({ model }): DateInputItem => {\n let { label, type, value, classes, prefix, suffix, errorMessage } = model\n\n if (label) {\n label.toString = () => label.text\n }\n\n if (!isFormValue(value)) {\n value = undefined\n }\n\n const baseItem: DateInputItem = {\n label,\n id: model.id,\n name: model.name,\n type,\n value,\n classes: mergeCssClasses(\n classes,\n hasFieldErrors ? 'govuk-input--error' : undefined\n ),\n prefix,\n suffix\n }\n\n if (!hasFieldErrors && errorMessage) {\n baseItem.errorMessage = errorMessage\n }\n\n return baseItem\n }\n )\n\n const showFieldsetError =\n hasFieldErrors || Boolean(viewModel.errorMessage?.text)\n\n viewModel.showFieldsetError = showFieldsetError\n\n if (hasFieldErrors) {\n viewModel.errorMessage = {\n text:\n fieldErrors.length === 1\n ? fieldErrors[0]\n : formatErrorList(fieldErrors, context.translator)\n }\n }\n\n const fieldset = existingFieldset ?? {\n legend: {\n text: label.text,\n classes: 'govuk-fieldset__legend--m'\n }\n }\n\n const result = {\n ...viewModel,\n fieldset,\n items,\n mapLayers: getMapLayers(component),\n country:\n component instanceof EastingNorthingField\n ? component.options.countries?.at(0)\n : undefined,\n lang: context.translator.language\n }\n\n if (component.options.instructionText) {\n const { t, tComponent } = context.translator\n\n return {\n ...result,\n instructionSummary: t('components.locationFieldBase.howToFind'),\n instructionText:\n tComponent(component.def, 'instructionText') ||\n component.options.instructionText,\n t\n }\n }\n\n return result\n}\n\n/**\n * Validator factory for location-based fields.\n * This creates a validator that ensures all required fields are present.\n */\nexport function createLocationFieldValidator(\n component: LocationField\n): CustomValidator {\n return (payload: FormPayload, helpers) => {\n const { collection, name, options } = component\n\n const values = component.getFormValueFromState(\n component.getStateFromValidForm(payload)\n )\n\n const context: Context = {\n missing: collection.keys,\n key: name\n }\n\n if (!component.isState(values)) {\n return options.required !== false\n ? helpers.error('object.required', context)\n : payload\n }\n\n return payload\n }\n}\n"],"mappings":"AAEA,SAASA,oBAAoB;AAC7B,SAASC,WAAW;AAqBpB;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,qBAAqBA,CAACC,OAAe,EAAU;EACtD;EACA,OAAOA,OAAO,CAACC,MAAM,CAAC,CAAC,CAAC,CAACC,WAAW,CAAC,CAAC,GAAGF,OAAO,CAACG,KAAK,CAAC,CAAC,CAAC;AAC3D;AAEA,OAAO,SAASC,WAAWA,CAACC,KAAe,EAAEC,UAAsB,EAAU;EAC3E,MAAM;IAAEC;EAAE,CAAC,GAAGD,UAAU;EACxB,IAAID,KAAK,CAACG,MAAM,KAAK,CAAC,EAAE;IACtB,OAAO,GAAGH,KAAK,CAAC,CAAC,CAAC,IAAIE,CAAC,CAAC,YAAY,CAAC,IAAIF,KAAK,CAAC,CAAC,CAAC,EAAE;EACrD;EAEA,MAAMI,OAAO,GAAGJ,KAAK,CAACF,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAACO,IAAI,CAAC,IAAI,CAAC;EAC7C,MAAMC,IAAI,GAAGN,KAAK,CAACA,KAAK,CAACG,MAAM,GAAG,CAAC,CAAC;EACpC,OAAO,GAAGC,OAAO,IAAIF,CAAC,CAAC,YAAY,CAAC,IAAII,IAAI,EAAE;AAChD;AAEA,OAAO,SAASC,eAAeA,CAC7BC,QAAkB,EAClBP,UAAsB,EACd;EACR,IAAI,CAACO,QAAQ,CAACL,MAAM,EAAE;IACpB,OAAO,EAAE;EACX;EAEA,IAAIK,QAAQ,CAACL,MAAM,KAAK,CAAC,EAAE;IACzB,OAAOK,QAAQ,CAAC,CAAC,CAAC;EACpB;EAEA,MAAMC,iBAAiB,GAAGD,QAAQ,CAACE,GAAG,CAAC,CAACC,GAAG,EAAEC,KAAK,KAChDA,KAAK,KAAK,CAAC,GAAGD,GAAG,GAAGjB,qBAAqB,CAACiB,GAAG,CAC/C,CAAC;EAED,OAAOZ,WAAW,CAACU,iBAAiB,EAAER,UAAU,CAAC;AACnD;AAEA,OAAO,SAASY,eAAeA,CAAC,GAAGC,UAAkC,EAAE;EACrE,MAAMC,MAAM,GAAGD,UAAU,CACtBE,OAAO,CAAEC,IAAI,IAAKA,IAAI,EAAEC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAC3CR,GAAG,CAAES,KAAK,IAAKA,KAAK,CAACC,IAAI,CAAC,CAAC,CAAC,CAC5BC,MAAM,CAACC,OAAO,CAAC;EAElB,IAAI,CAACP,MAAM,CAACZ,MAAM,EAAE;IAClB,OAAOoB,SAAS;EAClB;EAEA,OAAOC,KAAK,CAACC,IAAI,CAAC,IAAIC,GAAG,CAACX,MAAM,CAAC,CAAC,CAACV,IAAI,CAAC,GAAG,CAAC;AAC9C;AAEA,OAAO,SAASsB,uBAAuBA,CACrCC,MAA8B,EACK;EACnC,IAAI,CAACA,MAAM,EAAEzB,MAAM,EAAE;IACnB,OAAOoB,SAAS;EAClB;EAEA,OAAOK,MAAM,CAACP,MAAM,CAClB,CAACQ,KAAK,EAAEjB,KAAK,EAAEkB,IAAI,KACjBlB,KAAK,KAAKkB,IAAI,CAACC,SAAS,CAAEC,GAAG,IAAKA,GAAG,CAACC,IAAI,KAAKJ,KAAK,CAACI,IAAI,CAC7D,CAAC;AACH;AAEA,OAAO,SAASC,YAAYA,CAC1BC,SAIwB,EACxB;EACA,MAAM;IAAEC;EAAU,CAAC,GAAGD,SAAS,CAACE,OAAO;EACvC,MAAMC,MAAM,GAAG,EAAE;EAEjB,IAAIF,SAAS,EAAEG,IAAI,EAAE;IACnBD,MAAM,CAACE,IAAI,CAAC,MAAM,CAAC;EACrB;EAEA,OAAOF,MAAM,CAACjC,IAAI,CAAC,GAAG,CAAC;AACzB;AAEA,OAAO,SAASoC,yBAAyBA,CACvCN,SAAwB,EACxBO,SAKC,EACDC,OAAsB,EACtB;EACA,MAAM;IAAEC;EAAW,CAAC,GAAGT,SAAS;EAChC,MAAM;IAAEU,QAAQ,EAAEC,gBAAgB;IAAEC;EAAM,CAAC,GAAGL,SAAS;EAEvD,MAAMM,aAAa,GAAGJ,UAAU,CAACK,YAAY,CAACN,OAAO,CAAC;EAEtD,MAAMO,WAAqB,GAAG,EAAE;EAChCF,aAAa,CAACG,OAAO,CAAC,CAAC;IAAEC;EAAM,CAAC,KAAK;IACnC,IAAIA,KAAK,CAACC,YAAY,EAAEC,IAAI,EAAE;MAC5BJ,WAAW,CAACV,IAAI,CAACY,KAAK,CAACC,YAAY,CAACC,IAAI,CAAC;IAC3C;EACF,CAAC,CAAC;EAEF,MAAMC,cAAc,GAAGL,WAAW,CAAC/C,MAAM,GAAG,CAAC;EAE7C,MAAMH,KAAsB,GAAGgD,aAAa,CAACtC,GAAG,CAC9C,CAAC;IAAE0C;EAAM,CAAC,KAAoB;IAC5B,IAAI;MAAEL,KAAK;MAAES,IAAI;MAAEC,KAAK;MAAEC,OAAO;MAAEC,MAAM;MAAEC,MAAM;MAAEP;IAAa,CAAC,GAAGD,KAAK;IAEzE,IAAIL,KAAK,EAAE;MACTA,KAAK,CAACc,QAAQ,GAAG,MAAMd,KAAK,CAACO,IAAI;IACnC;IAEA,IAAI,CAAC7D,WAAW,CAACgE,KAAK,CAAC,EAAE;MACvBA,KAAK,GAAGlC,SAAS;IACnB;IAEA,MAAMuC,QAAuB,GAAG;MAC9Bf,KAAK;MACLgB,EAAE,EAAEX,KAAK,CAACW,EAAE;MACZ9C,IAAI,EAAEmC,KAAK,CAACnC,IAAI;MAChBuC,IAAI;MACJC,KAAK;MACLC,OAAO,EAAE7C,eAAe,CACtB6C,OAAO,EACPH,cAAc,GAAG,oBAAoB,GAAGhC,SAC1C,CAAC;MACDoC,MAAM;MACNC;IACF,CAAC;IAED,IAAI,CAACL,cAAc,IAAIF,YAAY,EAAE;MACnCS,QAAQ,CAACT,YAAY,GAAGA,YAAY;IACtC;IAEA,OAAOS,QAAQ;EACjB,CACF,CAAC;EAED,MAAME,iBAAiB,GACrBT,cAAc,IAAIjC,OAAO,CAACoB,SAAS,CAACW,YAAY,EAAEC,IAAI,CAAC;EAEzDZ,SAAS,CAACsB,iBAAiB,GAAGA,iBAAiB;EAE/C,IAAIT,cAAc,EAAE;IAClBb,SAAS,CAACW,YAAY,GAAG;MACvBC,IAAI,EACFJ,WAAW,CAAC/C,MAAM,KAAK,CAAC,GACpB+C,WAAW,CAAC,CAAC,CAAC,GACd3C,eAAe,CAAC2C,WAAW,EAAEP,OAAO,CAAC1C,UAAU;IACvD,CAAC;EACH;EAEA,MAAM4C,QAAQ,GAAGC,gBAAgB,IAAI;IACnCmB,MAAM,EAAE;MACNX,IAAI,EAAEP,KAAK,CAACO,IAAI;MAChBI,OAAO,EAAE;IACX;EACF,CAAC;EAED,MAAMQ,MAAM,GAAG;IACb,GAAGxB,SAAS;IACZG,QAAQ;IACR7C,KAAK;IACLoC,SAAS,EAAEF,YAAY,CAACC,SAAS,CAAC;IAClCgC,OAAO,EACLhC,SAAS,YAAY3C,oBAAoB,GACrC2C,SAAS,CAACE,OAAO,CAAC+B,SAAS,EAAEC,EAAE,CAAC,CAAC,CAAC,GAClC9C,SAAS;IACf+C,IAAI,EAAE3B,OAAO,CAAC1C,UAAU,CAACsE;EAC3B,CAAC;EAED,IAAIpC,SAAS,CAACE,OAAO,CAACmC,eAAe,EAAE;IACrC,MAAM;MAAEtE,CAAC;MAAEuE;IAAW,CAAC,GAAG9B,OAAO,CAAC1C,UAAU;IAE5C,OAAO;MACL,GAAGiE,MAAM;MACTQ,kBAAkB,EAAExE,CAAC,CAAC,wCAAwC,CAAC;MAC/DsE,eAAe,EACbC,UAAU,CAACtC,SAAS,CAACwC,GAAG,EAAE,iBAAiB,CAAC,IAC5CxC,SAAS,CAACE,OAAO,CAACmC,eAAe;MACnCtE;IACF,CAAC;EACH;EAEA,OAAOgE,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASU,4BAA4BA,CAC1CzC,SAAwB,EACP;EACjB,OAAO,CAAC0C,OAAoB,EAAEC,OAAO,KAAK;IACxC,MAAM;MAAElC,UAAU;MAAE3B,IAAI;MAAEoB;IAAQ,CAAC,GAAGF,SAAS;IAE/C,MAAM4C,MAAM,GAAG5C,SAAS,CAAC6C,qBAAqB,CAC5C7C,SAAS,CAAC8C,qBAAqB,CAACJ,OAAO,CACzC,CAAC;IAED,MAAMlC,OAAgB,GAAG;MACvBuC,OAAO,EAAEtC,UAAU,CAACuC,IAAI;MACxBC,GAAG,EAAEnE;IACP,CAAC;IAED,IAAI,CAACkB,SAAS,CAACkD,OAAO,CAACN,MAAM,CAAC,EAAE;MAC9B,OAAO1C,OAAO,CAACiD,QAAQ,KAAK,KAAK,GAC7BR,OAAO,CAACjD,KAAK,CAAC,iBAAiB,EAAEc,OAAO,CAAC,GACzCkC,OAAO;IACb;IAEA,OAAOA,OAAO;EAChB,CAAC;AACH","ignoreList":[]}
|
|
@@ -4,6 +4,7 @@ import { ListFormComponent } from "../ListFormComponent.js";
|
|
|
4
4
|
import { escapeMarkdown } from "./index.js";
|
|
5
5
|
import * as Components from "../index.js";
|
|
6
6
|
import { markdown } from "../markdownParser.js";
|
|
7
|
+
import { UnknownComponentTypeError } from "../../errors.js";
|
|
7
8
|
|
|
8
9
|
// All component instances
|
|
9
10
|
|
|
@@ -121,7 +122,7 @@ export function createComponent(def, options) {
|
|
|
121
122
|
break;
|
|
122
123
|
}
|
|
123
124
|
if (typeof component === 'undefined') {
|
|
124
|
-
throw new
|
|
125
|
+
throw new UnknownComponentTypeError(def.type);
|
|
125
126
|
}
|
|
126
127
|
return component;
|
|
127
128
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"components.js","names":["ComponentType","config","ListFormComponent","escapeMarkdown","Components","markdown","designerUrl","get","hasListFormField","field","type","undefined","isListFieldType","allowedTypes","AutocompleteField","CheckboxesField","RadiosField","SelectField","YesNoField","includes","createComponent","def","options","component","DatePartsField","DeclarationField","Details","EmailAddressField","Html","InsetText","List","Markdown","NotificationBanner","MultilineTextField","NumberField","TelephoneNumberField","TextField","UkAddressField","MonthYearField","FileUploadField","EastingNorthingField","OsGridRefField","NationalGridFieldNumberField","LatLongField","HiddenField","PaymentField","GeospatialField","Error","getAnswer","state","translator","format","getAnswerMarkdown","context","getContextValueFromState","toString","parse","async","trim","getDisplayStringFromState","answer","answerEscaped","files","getFormValueFromState","length","map","status","file","form","filename","fileId","join","values","flat","items","filter","value","item","resolvedText","tListItem","text","label","line","toLowerCase","split","concat","features","getDisplayStringFromFormValue"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/components.ts"],"sourcesContent":["import { ComponentType, type ComponentDef } from '@defra/forms-model'\n\nimport { config } from '~/src/config/index.js'\nimport { type ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'\nimport { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'\nimport { escapeMarkdown } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport * as Components from '~/src/server/plugins/engine/components/index.js'\nimport { markdown } from '~/src/server/plugins/engine/components/markdownParser.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport { type FormState } from '~/src/server/plugins/engine/types.js'\n\n// All component instances\nexport type Component = InstanceType<\n (typeof Components)[keyof typeof Components]\n>\n\n// Field component instances only\nexport type Field = InstanceType<\n | typeof Components.AutocompleteField\n | typeof Components.RadiosField\n | typeof Components.YesNoField\n | typeof Components.CheckboxesField\n | typeof Components.DatePartsField\n | typeof Components.DeclarationField\n | typeof Components.EastingNorthingField\n | typeof Components.EmailAddressField\n | typeof Components.LatLongField\n | typeof Components.MonthYearField\n | typeof Components.MultilineTextField\n | typeof Components.NationalGridFieldNumberField\n | typeof Components.NumberField\n | typeof Components.OsGridRefField\n | typeof Components.SelectField\n | typeof Components.TelephoneNumberField\n | typeof Components.TextField\n | typeof Components.UkAddressField\n | typeof Components.FileUploadField\n | typeof Components.HiddenField\n | typeof Components.PaymentField\n | typeof Components.GeospatialField\n>\n\n// Guidance component instances only\nexport type Guidance =\n | InstanceType<typeof Components.Details>\n | InstanceType<typeof Components.Html>\n | InstanceType<typeof Components.Markdown>\n | InstanceType<typeof Components.InsetText>\n | InstanceType<typeof Components.List>\n | InstanceType<typeof Components.NotificationBanner>\n\n// List component instances only\nexport type ListField = InstanceType<\n | typeof Components.AutocompleteField\n | typeof Components.CheckboxesField\n | typeof Components.RadiosField\n | typeof Components.SelectField\n | typeof Components.YesNoField\n>\n\nexport const designerUrl = config.get('designerUrl')\n\n// Re-export markdown from its own module to avoid circular dependencies\nexport { markdown } from '~/src/server/plugins/engine/components/markdownParser.js'\n\n/**\n * Filter known components with lists\n */\nexport function hasListFormField(\n field?: Partial<Component>\n): field is ListFormComponent {\n return !!field && field.type !== undefined && isListFieldType(field.type)\n}\n\nexport function isListFieldType(\n type?: ComponentType\n): type is ListField['type'] {\n const allowedTypes = [\n ComponentType.AutocompleteField,\n ComponentType.CheckboxesField,\n ComponentType.RadiosField,\n ComponentType.SelectField,\n ComponentType.YesNoField\n ]\n\n return !!type && allowedTypes.includes(type)\n}\n\n/**\n * Create field instance for each {@link ComponentDef} type\n */\nexport function createComponent(\n def: ComponentDef,\n options: ConstructorParameters<typeof ComponentBase>[1]\n): Component {\n let component: Component | undefined\n\n switch (def.type) {\n case ComponentType.AutocompleteField:\n component = new Components.AutocompleteField(def, options)\n break\n\n case ComponentType.CheckboxesField:\n component = new Components.CheckboxesField(def, options)\n break\n\n case ComponentType.DatePartsField:\n component = new Components.DatePartsField(def, options)\n break\n\n case ComponentType.DeclarationField:\n component = new Components.DeclarationField(def, options)\n break\n\n case ComponentType.Details:\n component = new Components.Details(def, options)\n break\n\n case ComponentType.EmailAddressField:\n component = new Components.EmailAddressField(def, options)\n break\n\n case ComponentType.Html:\n component = new Components.Html(def, options)\n break\n\n case ComponentType.InsetText:\n component = new Components.InsetText(def, options)\n break\n\n case ComponentType.List:\n component = new Components.List(def, options)\n break\n\n case ComponentType.Markdown:\n component = new Components.Markdown(def, options)\n break\n\n case ComponentType.NotificationBanner:\n component = new Components.NotificationBanner(def, options)\n break\n\n case ComponentType.MultilineTextField:\n component = new Components.MultilineTextField(def, options)\n break\n\n case ComponentType.NumberField:\n component = new Components.NumberField(def, options)\n break\n\n case ComponentType.RadiosField:\n component = new Components.RadiosField(def, options)\n break\n\n case ComponentType.SelectField:\n component = new Components.SelectField(def, options)\n break\n\n case ComponentType.TelephoneNumberField:\n component = new Components.TelephoneNumberField(def, options)\n break\n\n case ComponentType.TextField:\n component = new Components.TextField(def, options)\n break\n\n case ComponentType.UkAddressField:\n component = new Components.UkAddressField(def, options)\n break\n\n case ComponentType.YesNoField:\n component = new Components.YesNoField(def, options)\n break\n\n case ComponentType.MonthYearField:\n component = new Components.MonthYearField(def, options)\n break\n\n case ComponentType.FileUploadField:\n component = new Components.FileUploadField(def, options)\n break\n\n case ComponentType.EastingNorthingField:\n component = new Components.EastingNorthingField(def, options)\n break\n\n case ComponentType.OsGridRefField:\n component = new Components.OsGridRefField(def, options)\n break\n\n case ComponentType.NationalGridFieldNumberField:\n component = new Components.NationalGridFieldNumberField(def, options)\n break\n\n case ComponentType.LatLongField:\n component = new Components.LatLongField(def, options)\n break\n\n case ComponentType.HiddenField:\n component = new Components.HiddenField(def, options)\n break\n\n case ComponentType.PaymentField:\n component = new Components.PaymentField(def, options)\n break\n\n case ComponentType.GeospatialField:\n component = new Components.GeospatialField(def, options)\n break\n }\n\n if (typeof component === 'undefined') {\n throw new Error(`Component type ${def.type} does not exist`)\n }\n\n return component\n}\n\n/**\n * Get formatted answer for a field\n */\nexport function getAnswer(\n field: Field,\n state: FormState,\n translator: Translator,\n options: {\n format:\n | 'data' // Submission data\n | 'email' // GOV.UK Notify emails\n | 'summary' // Check answers summary\n } = { format: 'summary' }\n) {\n // Use escaped display text for GOV.UK Notify emails\n if (options.format === 'email') {\n return getAnswerMarkdown(field, state, translator, { format: 'email' })\n }\n\n // Use context value for submission data\n if (options.format === 'data') {\n const context = field.getContextValueFromState(state)\n return context?.toString() ?? ''\n }\n\n // Use display HTML for check answers summary (multi line)\n if (\n field instanceof ListFormComponent ||\n field instanceof Components.MultilineTextField ||\n field instanceof Components.UkAddressField ||\n field instanceof Components.EastingNorthingField ||\n field instanceof Components.LatLongField\n ) {\n return markdown\n .parse(\n getAnswerMarkdown(field, state, translator, { format: 'summary' }),\n { async: false }\n )\n .trim()\n }\n\n // Use display text for check answers summary (single line)\n return field.getDisplayStringFromState(state, translator)\n}\n\n/**\n * Get formatted answer for a field (Markdown only)\n */\nexport function getAnswerMarkdown(\n field: Field,\n state: FormState,\n translator: Translator,\n options: {\n format:\n | 'email' // GOV.UK Notify emails\n | 'summary' // Check answers summary\n } = { format: 'summary' }\n) {\n const answer = field.getDisplayStringFromState(state, translator)\n\n // Use escaped display text\n let answerEscaped = `${escapeMarkdown(answer)}\\n`\n\n if (field instanceof Components.FileUploadField) {\n const files = field.getFormValueFromState(state)\n\n // Skip empty files\n if (!files?.length) {\n return answerEscaped\n }\n\n answerEscaped = `${escapeMarkdown(answer)}:\\n\\n`\n\n // Append bullet points\n answerEscaped += files\n .map(({ status }) => {\n const { file } = status.form\n const filename = escapeMarkdown(file.filename)\n return `* [${filename}](${designerUrl}/file-download/${file.fileId})\\n`\n })\n .join('')\n } else if (field instanceof ListFormComponent) {\n const values = [field.getContextValueFromState(state)].flat()\n const items = field.items.filter(({ value }) => values.includes(value))\n\n // Skip empty values\n if (!items.length) {\n return answerEscaped\n }\n\n answerEscaped = ''\n\n // Append bullet points\n answerEscaped += items\n .map((item) => {\n const resolvedText = translator.tListItem(item, 'text') || item.text\n const label = escapeMarkdown(resolvedText)\n const value = escapeMarkdown(`(${item.value})`)\n\n let line = label\n\n // Prepend bullet points for checkboxes only\n if (field instanceof Components.CheckboxesField) {\n line = `* ${line}`\n }\n\n // Append raw values in parentheses\n // e.g. `* None of the above (false)`\n return options.format === 'email' &&\n `${item.value}`.toLowerCase() !== item.text.toLowerCase()\n ? `${line} ${value}\\n`\n : `${line}\\n`\n })\n .join('')\n } else if (field instanceof Components.MultilineTextField) {\n // Preserve Multiline text new lines\n answerEscaped = answer\n .split(/(?:\\r?\\n)+/)\n .map(escapeMarkdown)\n .join('\\n')\n .concat('\\n')\n } else if (field instanceof Components.UkAddressField) {\n // Format UK addresses into new lines\n answerEscaped = (field.getContextValueFromState(state) ?? [])\n .map(escapeMarkdown)\n .join('\\n')\n .concat('\\n')\n } else if (\n field instanceof Components.EastingNorthingField ||\n field instanceof Components.LatLongField\n ) {\n answerEscaped = answer ? `${answer}\\n` : ''\n } else if (field instanceof Components.GeospatialField) {\n const features = field.getFormValueFromState(state)\n const value = field.getDisplayStringFromFormValue(features, translator)\n\n answerEscaped = value ? `${value}\\n` : ''\n }\n\n return answerEscaped\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAA2B,oBAAoB;AAErE,SAASC,MAAM;AAEf,SAASC,iBAAiB;AAC1B,SAASC,cAAc;AACvB,OAAO,KAAKC,UAAU;AACtB,SAASC,QAAQ;;AAIjB;;AAKA;;AA0BA;;AASA;;AASA,OAAO,MAAMC,WAAW,GAAGL,MAAM,CAACM,GAAG,CAAC,aAAa,CAAC;;AAEpD;AACA,SAASF,QAAQ;;AAEjB;AACA;AACA;AACA,OAAO,SAASG,gBAAgBA,CAC9BC,KAA0B,EACE;EAC5B,OAAO,CAAC,CAACA,KAAK,IAAIA,KAAK,CAACC,IAAI,KAAKC,SAAS,IAAIC,eAAe,CAACH,KAAK,CAACC,IAAI,CAAC;AAC3E;AAEA,OAAO,SAASE,eAAeA,CAC7BF,IAAoB,EACO;EAC3B,MAAMG,YAAY,GAAG,CACnBb,aAAa,CAACc,iBAAiB,EAC/Bd,aAAa,CAACe,eAAe,EAC7Bf,aAAa,CAACgB,WAAW,EACzBhB,aAAa,CAACiB,WAAW,EACzBjB,aAAa,CAACkB,UAAU,CACzB;EAED,OAAO,CAAC,CAACR,IAAI,IAAIG,YAAY,CAACM,QAAQ,CAACT,IAAI,CAAC;AAC9C;;AAEA;AACA;AACA;AACA,OAAO,SAASU,eAAeA,CAC7BC,GAAiB,EACjBC,OAAuD,EAC5C;EACX,IAAIC,SAAgC;EAEpC,QAAQF,GAAG,CAACX,IAAI;IACd,KAAKV,aAAa,CAACc,iBAAiB;MAClCS,SAAS,GAAG,IAAInB,UAAU,CAACU,iBAAiB,CAACO,GAAG,EAAEC,OAAO,CAAC;MAC1D;IAEF,KAAKtB,aAAa,CAACe,eAAe;MAChCQ,SAAS,GAAG,IAAInB,UAAU,CAACW,eAAe,CAACM,GAAG,EAAEC,OAAO,CAAC;MACxD;IAEF,KAAKtB,aAAa,CAACwB,cAAc;MAC/BD,SAAS,GAAG,IAAInB,UAAU,CAACoB,cAAc,CAACH,GAAG,EAAEC,OAAO,CAAC;MACvD;IAEF,KAAKtB,aAAa,CAACyB,gBAAgB;MACjCF,SAAS,GAAG,IAAInB,UAAU,CAACqB,gBAAgB,CAACJ,GAAG,EAAEC,OAAO,CAAC;MACzD;IAEF,KAAKtB,aAAa,CAAC0B,OAAO;MACxBH,SAAS,GAAG,IAAInB,UAAU,CAACsB,OAAO,CAACL,GAAG,EAAEC,OAAO,CAAC;MAChD;IAEF,KAAKtB,aAAa,CAAC2B,iBAAiB;MAClCJ,SAAS,GAAG,IAAInB,UAAU,CAACuB,iBAAiB,CAACN,GAAG,EAAEC,OAAO,CAAC;MAC1D;IAEF,KAAKtB,aAAa,CAAC4B,IAAI;MACrBL,SAAS,GAAG,IAAInB,UAAU,CAACwB,IAAI,CAACP,GAAG,EAAEC,OAAO,CAAC;MAC7C;IAEF,KAAKtB,aAAa,CAAC6B,SAAS;MAC1BN,SAAS,GAAG,IAAInB,UAAU,CAACyB,SAAS,CAACR,GAAG,EAAEC,OAAO,CAAC;MAClD;IAEF,KAAKtB,aAAa,CAAC8B,IAAI;MACrBP,SAAS,GAAG,IAAInB,UAAU,CAAC0B,IAAI,CAACT,GAAG,EAAEC,OAAO,CAAC;MAC7C;IAEF,KAAKtB,aAAa,CAAC+B,QAAQ;MACzBR,SAAS,GAAG,IAAInB,UAAU,CAAC2B,QAAQ,CAACV,GAAG,EAAEC,OAAO,CAAC;MACjD;IAEF,KAAKtB,aAAa,CAACgC,kBAAkB;MACnCT,SAAS,GAAG,IAAInB,UAAU,CAAC4B,kBAAkB,CAACX,GAAG,EAAEC,OAAO,CAAC;MAC3D;IAEF,KAAKtB,aAAa,CAACiC,kBAAkB;MACnCV,SAAS,GAAG,IAAInB,UAAU,CAAC6B,kBAAkB,CAACZ,GAAG,EAAEC,OAAO,CAAC;MAC3D;IAEF,KAAKtB,aAAa,CAACkC,WAAW;MAC5BX,SAAS,GAAG,IAAInB,UAAU,CAAC8B,WAAW,CAACb,GAAG,EAAEC,OAAO,CAAC;MACpD;IAEF,KAAKtB,aAAa,CAACgB,WAAW;MAC5BO,SAAS,GAAG,IAAInB,UAAU,CAACY,WAAW,CAACK,GAAG,EAAEC,OAAO,CAAC;MACpD;IAEF,KAAKtB,aAAa,CAACiB,WAAW;MAC5BM,SAAS,GAAG,IAAInB,UAAU,CAACa,WAAW,CAACI,GAAG,EAAEC,OAAO,CAAC;MACpD;IAEF,KAAKtB,aAAa,CAACmC,oBAAoB;MACrCZ,SAAS,GAAG,IAAInB,UAAU,CAAC+B,oBAAoB,CAACd,GAAG,EAAEC,OAAO,CAAC;MAC7D;IAEF,KAAKtB,aAAa,CAACoC,SAAS;MAC1Bb,SAAS,GAAG,IAAInB,UAAU,CAACgC,SAAS,CAACf,GAAG,EAAEC,OAAO,CAAC;MAClD;IAEF,KAAKtB,aAAa,CAACqC,cAAc;MAC/Bd,SAAS,GAAG,IAAInB,UAAU,CAACiC,cAAc,CAAChB,GAAG,EAAEC,OAAO,CAAC;MACvD;IAEF,KAAKtB,aAAa,CAACkB,UAAU;MAC3BK,SAAS,GAAG,IAAInB,UAAU,CAACc,UAAU,CAACG,GAAG,EAAEC,OAAO,CAAC;MACnD;IAEF,KAAKtB,aAAa,CAACsC,cAAc;MAC/Bf,SAAS,GAAG,IAAInB,UAAU,CAACkC,cAAc,CAACjB,GAAG,EAAEC,OAAO,CAAC;MACvD;IAEF,KAAKtB,aAAa,CAACuC,eAAe;MAChChB,SAAS,GAAG,IAAInB,UAAU,CAACmC,eAAe,CAAClB,GAAG,EAAEC,OAAO,CAAC;MACxD;IAEF,KAAKtB,aAAa,CAACwC,oBAAoB;MACrCjB,SAAS,GAAG,IAAInB,UAAU,CAACoC,oBAAoB,CAACnB,GAAG,EAAEC,OAAO,CAAC;MAC7D;IAEF,KAAKtB,aAAa,CAACyC,cAAc;MAC/BlB,SAAS,GAAG,IAAInB,UAAU,CAACqC,cAAc,CAACpB,GAAG,EAAEC,OAAO,CAAC;MACvD;IAEF,KAAKtB,aAAa,CAAC0C,4BAA4B;MAC7CnB,SAAS,GAAG,IAAInB,UAAU,CAACsC,4BAA4B,CAACrB,GAAG,EAAEC,OAAO,CAAC;MACrE;IAEF,KAAKtB,aAAa,CAAC2C,YAAY;MAC7BpB,SAAS,GAAG,IAAInB,UAAU,CAACuC,YAAY,CAACtB,GAAG,EAAEC,OAAO,CAAC;MACrD;IAEF,KAAKtB,aAAa,CAAC4C,WAAW;MAC5BrB,SAAS,GAAG,IAAInB,UAAU,CAACwC,WAAW,CAACvB,GAAG,EAAEC,OAAO,CAAC;MACpD;IAEF,KAAKtB,aAAa,CAAC6C,YAAY;MAC7BtB,SAAS,GAAG,IAAInB,UAAU,CAACyC,YAAY,CAACxB,GAAG,EAAEC,OAAO,CAAC;MACrD;IAEF,KAAKtB,aAAa,CAAC8C,eAAe;MAChCvB,SAAS,GAAG,IAAInB,UAAU,CAAC0C,eAAe,CAACzB,GAAG,EAAEC,OAAO,CAAC;MACxD;EACJ;EAEA,IAAI,OAAOC,SAAS,KAAK,WAAW,EAAE;IACpC,MAAM,IAAIwB,KAAK,CAAC,kBAAkB1B,GAAG,CAACX,IAAI,iBAAiB,CAAC;EAC9D;EAEA,OAAOa,SAAS;AAClB;;AAEA;AACA;AACA;AACA,OAAO,SAASyB,SAASA,CACvBvC,KAAY,EACZwC,KAAgB,EAChBC,UAAsB,EACtB5B,OAKC,GAAG;EAAE6B,MAAM,EAAE;AAAU,CAAC,EACzB;EACA;EACA,IAAI7B,OAAO,CAAC6B,MAAM,KAAK,OAAO,EAAE;IAC9B,OAAOC,iBAAiB,CAAC3C,KAAK,EAAEwC,KAAK,EAAEC,UAAU,EAAE;MAAEC,MAAM,EAAE;IAAQ,CAAC,CAAC;EACzE;;EAEA;EACA,IAAI7B,OAAO,CAAC6B,MAAM,KAAK,MAAM,EAAE;IAC7B,MAAME,OAAO,GAAG5C,KAAK,CAAC6C,wBAAwB,CAACL,KAAK,CAAC;IACrD,OAAOI,OAAO,EAAEE,QAAQ,CAAC,CAAC,IAAI,EAAE;EAClC;;EAEA;EACA,IACE9C,KAAK,YAAYP,iBAAiB,IAClCO,KAAK,YAAYL,UAAU,CAAC6B,kBAAkB,IAC9CxB,KAAK,YAAYL,UAAU,CAACiC,cAAc,IAC1C5B,KAAK,YAAYL,UAAU,CAACoC,oBAAoB,IAChD/B,KAAK,YAAYL,UAAU,CAACuC,YAAY,EACxC;IACA,OAAOtC,QAAQ,CACZmD,KAAK,CACJJ,iBAAiB,CAAC3C,KAAK,EAAEwC,KAAK,EAAEC,UAAU,EAAE;MAAEC,MAAM,EAAE;IAAU,CAAC,CAAC,EAClE;MAAEM,KAAK,EAAE;IAAM,CACjB,CAAC,CACAC,IAAI,CAAC,CAAC;EACX;;EAEA;EACA,OAAOjD,KAAK,CAACkD,yBAAyB,CAACV,KAAK,EAAEC,UAAU,CAAC;AAC3D;;AAEA;AACA;AACA;AACA,OAAO,SAASE,iBAAiBA,CAC/B3C,KAAY,EACZwC,KAAgB,EAChBC,UAAsB,EACtB5B,OAIC,GAAG;EAAE6B,MAAM,EAAE;AAAU,CAAC,EACzB;EACA,MAAMS,MAAM,GAAGnD,KAAK,CAACkD,yBAAyB,CAACV,KAAK,EAAEC,UAAU,CAAC;;EAEjE;EACA,IAAIW,aAAa,GAAG,GAAG1D,cAAc,CAACyD,MAAM,CAAC,IAAI;EAEjD,IAAInD,KAAK,YAAYL,UAAU,CAACmC,eAAe,EAAE;IAC/C,MAAMuB,KAAK,GAAGrD,KAAK,CAACsD,qBAAqB,CAACd,KAAK,CAAC;;IAEhD;IACA,IAAI,CAACa,KAAK,EAAEE,MAAM,EAAE;MAClB,OAAOH,aAAa;IACtB;IAEAA,aAAa,GAAG,GAAG1D,cAAc,CAACyD,MAAM,CAAC,OAAO;;IAEhD;IACAC,aAAa,IAAIC,KAAK,CACnBG,GAAG,CAAC,CAAC;MAAEC;IAAO,CAAC,KAAK;MACnB,MAAM;QAAEC;MAAK,CAAC,GAAGD,MAAM,CAACE,IAAI;MAC5B,MAAMC,QAAQ,GAAGlE,cAAc,CAACgE,IAAI,CAACE,QAAQ,CAAC;MAC9C,OAAO,MAAMA,QAAQ,KAAK/D,WAAW,kBAAkB6D,IAAI,CAACG,MAAM,KAAK;IACzE,CAAC,CAAC,CACDC,IAAI,CAAC,EAAE,CAAC;EACb,CAAC,MAAM,IAAI9D,KAAK,YAAYP,iBAAiB,EAAE;IAC7C,MAAMsE,MAAM,GAAG,CAAC/D,KAAK,CAAC6C,wBAAwB,CAACL,KAAK,CAAC,CAAC,CAACwB,IAAI,CAAC,CAAC;IAC7D,MAAMC,KAAK,GAAGjE,KAAK,CAACiE,KAAK,CAACC,MAAM,CAAC,CAAC;MAAEC;IAAM,CAAC,KAAKJ,MAAM,CAACrD,QAAQ,CAACyD,KAAK,CAAC,CAAC;;IAEvE;IACA,IAAI,CAACF,KAAK,CAACV,MAAM,EAAE;MACjB,OAAOH,aAAa;IACtB;IAEAA,aAAa,GAAG,EAAE;;IAElB;IACAA,aAAa,IAAIa,KAAK,CACnBT,GAAG,CAAEY,IAAI,IAAK;MACb,MAAMC,YAAY,GAAG5B,UAAU,CAAC6B,SAAS,CAACF,IAAI,EAAE,MAAM,CAAC,IAAIA,IAAI,CAACG,IAAI;MACpE,MAAMC,KAAK,GAAG9E,cAAc,CAAC2E,YAAY,CAAC;MAC1C,MAAMF,KAAK,GAAGzE,cAAc,CAAC,IAAI0E,IAAI,CAACD,KAAK,GAAG,CAAC;MAE/C,IAAIM,IAAI,GAAGD,KAAK;;MAEhB;MACA,IAAIxE,KAAK,YAAYL,UAAU,CAACW,eAAe,EAAE;QAC/CmE,IAAI,GAAG,KAAKA,IAAI,EAAE;MACpB;;MAEA;MACA;MACA,OAAO5D,OAAO,CAAC6B,MAAM,KAAK,OAAO,IAC/B,GAAG0B,IAAI,CAACD,KAAK,EAAE,CAACO,WAAW,CAAC,CAAC,KAAKN,IAAI,CAACG,IAAI,CAACG,WAAW,CAAC,CAAC,GACvD,GAAGD,IAAI,IAAIN,KAAK,IAAI,GACpB,GAAGM,IAAI,IAAI;IACjB,CAAC,CAAC,CACDX,IAAI,CAAC,EAAE,CAAC;EACb,CAAC,MAAM,IAAI9D,KAAK,YAAYL,UAAU,CAAC6B,kBAAkB,EAAE;IACzD;IACA4B,aAAa,GAAGD,MAAM,CACnBwB,KAAK,CAAC,YAAY,CAAC,CACnBnB,GAAG,CAAC9D,cAAc,CAAC,CACnBoE,IAAI,CAAC,IAAI,CAAC,CACVc,MAAM,CAAC,IAAI,CAAC;EACjB,CAAC,MAAM,IAAI5E,KAAK,YAAYL,UAAU,CAACiC,cAAc,EAAE;IACrD;IACAwB,aAAa,GAAG,CAACpD,KAAK,CAAC6C,wBAAwB,CAACL,KAAK,CAAC,IAAI,EAAE,EACzDgB,GAAG,CAAC9D,cAAc,CAAC,CACnBoE,IAAI,CAAC,IAAI,CAAC,CACVc,MAAM,CAAC,IAAI,CAAC;EACjB,CAAC,MAAM,IACL5E,KAAK,YAAYL,UAAU,CAACoC,oBAAoB,IAChD/B,KAAK,YAAYL,UAAU,CAACuC,YAAY,EACxC;IACAkB,aAAa,GAAGD,MAAM,GAAG,GAAGA,MAAM,IAAI,GAAG,EAAE;EAC7C,CAAC,MAAM,IAAInD,KAAK,YAAYL,UAAU,CAAC0C,eAAe,EAAE;IACtD,MAAMwC,QAAQ,GAAG7E,KAAK,CAACsD,qBAAqB,CAACd,KAAK,CAAC;IACnD,MAAM2B,KAAK,GAAGnE,KAAK,CAAC8E,6BAA6B,CAACD,QAAQ,EAAEpC,UAAU,CAAC;IAEvEW,aAAa,GAAGe,KAAK,GAAG,GAAGA,KAAK,IAAI,GAAG,EAAE;EAC3C;EAEA,OAAOf,aAAa;AACtB","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"components.js","names":["ComponentType","config","ListFormComponent","escapeMarkdown","Components","markdown","UnknownComponentTypeError","designerUrl","get","hasListFormField","field","type","undefined","isListFieldType","allowedTypes","AutocompleteField","CheckboxesField","RadiosField","SelectField","YesNoField","includes","createComponent","def","options","component","DatePartsField","DeclarationField","Details","EmailAddressField","Html","InsetText","List","Markdown","NotificationBanner","MultilineTextField","NumberField","TelephoneNumberField","TextField","UkAddressField","MonthYearField","FileUploadField","EastingNorthingField","OsGridRefField","NationalGridFieldNumberField","LatLongField","HiddenField","PaymentField","GeospatialField","getAnswer","state","translator","format","getAnswerMarkdown","context","getContextValueFromState","toString","parse","async","trim","getDisplayStringFromState","answer","answerEscaped","files","getFormValueFromState","length","map","status","file","form","filename","fileId","join","values","flat","items","filter","value","item","resolvedText","tListItem","text","label","line","toLowerCase","split","concat","features","getDisplayStringFromFormValue"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/components.ts"],"sourcesContent":["import { ComponentType, type ComponentDef } from '@defra/forms-model'\n\nimport { config } from '~/src/config/index.js'\nimport { type ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'\nimport { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'\nimport { escapeMarkdown } from '~/src/server/plugins/engine/components/helpers/index.js'\nimport * as Components from '~/src/server/plugins/engine/components/index.js'\nimport { markdown } from '~/src/server/plugins/engine/components/markdownParser.js'\nimport { UnknownComponentTypeError } from '~/src/server/plugins/engine/errors.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport { type FormState } from '~/src/server/plugins/engine/types.js'\n\n// All component instances\nexport type Component = InstanceType<\n (typeof Components)[keyof typeof Components]\n>\n\n// Field component instances only\nexport type Field = InstanceType<\n | typeof Components.AutocompleteField\n | typeof Components.RadiosField\n | typeof Components.YesNoField\n | typeof Components.CheckboxesField\n | typeof Components.DatePartsField\n | typeof Components.DeclarationField\n | typeof Components.EastingNorthingField\n | typeof Components.EmailAddressField\n | typeof Components.LatLongField\n | typeof Components.MonthYearField\n | typeof Components.MultilineTextField\n | typeof Components.NationalGridFieldNumberField\n | typeof Components.NumberField\n | typeof Components.OsGridRefField\n | typeof Components.SelectField\n | typeof Components.TelephoneNumberField\n | typeof Components.TextField\n | typeof Components.UkAddressField\n | typeof Components.FileUploadField\n | typeof Components.HiddenField\n | typeof Components.PaymentField\n | typeof Components.GeospatialField\n>\n\n// Guidance component instances only\nexport type Guidance =\n | InstanceType<typeof Components.Details>\n | InstanceType<typeof Components.Html>\n | InstanceType<typeof Components.Markdown>\n | InstanceType<typeof Components.InsetText>\n | InstanceType<typeof Components.List>\n | InstanceType<typeof Components.NotificationBanner>\n\n// List component instances only\nexport type ListField = InstanceType<\n | typeof Components.AutocompleteField\n | typeof Components.CheckboxesField\n | typeof Components.RadiosField\n | typeof Components.SelectField\n | typeof Components.YesNoField\n>\n\nexport const designerUrl = config.get('designerUrl')\n\n// Re-export markdown from its own module to avoid circular dependencies\nexport { markdown } from '~/src/server/plugins/engine/components/markdownParser.js'\n\n/**\n * Filter known components with lists\n */\nexport function hasListFormField(\n field?: Partial<Component>\n): field is ListFormComponent {\n return !!field && field.type !== undefined && isListFieldType(field.type)\n}\n\nexport function isListFieldType(\n type?: ComponentType\n): type is ListField['type'] {\n const allowedTypes = [\n ComponentType.AutocompleteField,\n ComponentType.CheckboxesField,\n ComponentType.RadiosField,\n ComponentType.SelectField,\n ComponentType.YesNoField\n ]\n\n return !!type && allowedTypes.includes(type)\n}\n\n/**\n * Create field instance for each {@link ComponentDef} type\n */\nexport function createComponent(\n def: ComponentDef,\n options: ConstructorParameters<typeof ComponentBase>[1]\n): Component {\n let component: Component | undefined\n\n switch (def.type) {\n case ComponentType.AutocompleteField:\n component = new Components.AutocompleteField(def, options)\n break\n\n case ComponentType.CheckboxesField:\n component = new Components.CheckboxesField(def, options)\n break\n\n case ComponentType.DatePartsField:\n component = new Components.DatePartsField(def, options)\n break\n\n case ComponentType.DeclarationField:\n component = new Components.DeclarationField(def, options)\n break\n\n case ComponentType.Details:\n component = new Components.Details(def, options)\n break\n\n case ComponentType.EmailAddressField:\n component = new Components.EmailAddressField(def, options)\n break\n\n case ComponentType.Html:\n component = new Components.Html(def, options)\n break\n\n case ComponentType.InsetText:\n component = new Components.InsetText(def, options)\n break\n\n case ComponentType.List:\n component = new Components.List(def, options)\n break\n\n case ComponentType.Markdown:\n component = new Components.Markdown(def, options)\n break\n\n case ComponentType.NotificationBanner:\n component = new Components.NotificationBanner(def, options)\n break\n\n case ComponentType.MultilineTextField:\n component = new Components.MultilineTextField(def, options)\n break\n\n case ComponentType.NumberField:\n component = new Components.NumberField(def, options)\n break\n\n case ComponentType.RadiosField:\n component = new Components.RadiosField(def, options)\n break\n\n case ComponentType.SelectField:\n component = new Components.SelectField(def, options)\n break\n\n case ComponentType.TelephoneNumberField:\n component = new Components.TelephoneNumberField(def, options)\n break\n\n case ComponentType.TextField:\n component = new Components.TextField(def, options)\n break\n\n case ComponentType.UkAddressField:\n component = new Components.UkAddressField(def, options)\n break\n\n case ComponentType.YesNoField:\n component = new Components.YesNoField(def, options)\n break\n\n case ComponentType.MonthYearField:\n component = new Components.MonthYearField(def, options)\n break\n\n case ComponentType.FileUploadField:\n component = new Components.FileUploadField(def, options)\n break\n\n case ComponentType.EastingNorthingField:\n component = new Components.EastingNorthingField(def, options)\n break\n\n case ComponentType.OsGridRefField:\n component = new Components.OsGridRefField(def, options)\n break\n\n case ComponentType.NationalGridFieldNumberField:\n component = new Components.NationalGridFieldNumberField(def, options)\n break\n\n case ComponentType.LatLongField:\n component = new Components.LatLongField(def, options)\n break\n\n case ComponentType.HiddenField:\n component = new Components.HiddenField(def, options)\n break\n\n case ComponentType.PaymentField:\n component = new Components.PaymentField(def, options)\n break\n\n case ComponentType.GeospatialField:\n component = new Components.GeospatialField(def, options)\n break\n }\n\n if (typeof component === 'undefined') {\n throw new UnknownComponentTypeError(def.type)\n }\n\n return component\n}\n\n/**\n * Get formatted answer for a field\n */\nexport function getAnswer(\n field: Field,\n state: FormState,\n translator: Translator,\n options: {\n format:\n | 'data' // Submission data\n | 'email' // GOV.UK Notify emails\n | 'summary' // Check answers summary\n } = { format: 'summary' }\n) {\n // Use escaped display text for GOV.UK Notify emails\n if (options.format === 'email') {\n return getAnswerMarkdown(field, state, translator, { format: 'email' })\n }\n\n // Use context value for submission data\n if (options.format === 'data') {\n const context = field.getContextValueFromState(state)\n return context?.toString() ?? ''\n }\n\n // Use display HTML for check answers summary (multi line)\n if (\n field instanceof ListFormComponent ||\n field instanceof Components.MultilineTextField ||\n field instanceof Components.UkAddressField ||\n field instanceof Components.EastingNorthingField ||\n field instanceof Components.LatLongField\n ) {\n return markdown\n .parse(\n getAnswerMarkdown(field, state, translator, { format: 'summary' }),\n { async: false }\n )\n .trim()\n }\n\n // Use display text for check answers summary (single line)\n return field.getDisplayStringFromState(state, translator)\n}\n\n/**\n * Get formatted answer for a field (Markdown only)\n */\nexport function getAnswerMarkdown(\n field: Field,\n state: FormState,\n translator: Translator,\n options: {\n format:\n | 'email' // GOV.UK Notify emails\n | 'summary' // Check answers summary\n } = { format: 'summary' }\n) {\n const answer = field.getDisplayStringFromState(state, translator)\n\n // Use escaped display text\n let answerEscaped = `${escapeMarkdown(answer)}\\n`\n\n if (field instanceof Components.FileUploadField) {\n const files = field.getFormValueFromState(state)\n\n // Skip empty files\n if (!files?.length) {\n return answerEscaped\n }\n\n answerEscaped = `${escapeMarkdown(answer)}:\\n\\n`\n\n // Append bullet points\n answerEscaped += files\n .map(({ status }) => {\n const { file } = status.form\n const filename = escapeMarkdown(file.filename)\n return `* [${filename}](${designerUrl}/file-download/${file.fileId})\\n`\n })\n .join('')\n } else if (field instanceof ListFormComponent) {\n const values = [field.getContextValueFromState(state)].flat()\n const items = field.items.filter(({ value }) => values.includes(value))\n\n // Skip empty values\n if (!items.length) {\n return answerEscaped\n }\n\n answerEscaped = ''\n\n // Append bullet points\n answerEscaped += items\n .map((item) => {\n const resolvedText = translator.tListItem(item, 'text') || item.text\n const label = escapeMarkdown(resolvedText)\n const value = escapeMarkdown(`(${item.value})`)\n\n let line = label\n\n // Prepend bullet points for checkboxes only\n if (field instanceof Components.CheckboxesField) {\n line = `* ${line}`\n }\n\n // Append raw values in parentheses\n // e.g. `* None of the above (false)`\n return options.format === 'email' &&\n `${item.value}`.toLowerCase() !== item.text.toLowerCase()\n ? `${line} ${value}\\n`\n : `${line}\\n`\n })\n .join('')\n } else if (field instanceof Components.MultilineTextField) {\n // Preserve Multiline text new lines\n answerEscaped = answer\n .split(/(?:\\r?\\n)+/)\n .map(escapeMarkdown)\n .join('\\n')\n .concat('\\n')\n } else if (field instanceof Components.UkAddressField) {\n // Format UK addresses into new lines\n answerEscaped = (field.getContextValueFromState(state) ?? [])\n .map(escapeMarkdown)\n .join('\\n')\n .concat('\\n')\n } else if (\n field instanceof Components.EastingNorthingField ||\n field instanceof Components.LatLongField\n ) {\n answerEscaped = answer ? `${answer}\\n` : ''\n } else if (field instanceof Components.GeospatialField) {\n const features = field.getFormValueFromState(state)\n const value = field.getDisplayStringFromFormValue(features, translator)\n\n answerEscaped = value ? `${value}\\n` : ''\n }\n\n return answerEscaped\n}\n"],"mappings":"AAAA,SAASA,aAAa,QAA2B,oBAAoB;AAErE,SAASC,MAAM;AAEf,SAASC,iBAAiB;AAC1B,SAASC,cAAc;AACvB,OAAO,KAAKC,UAAU;AACtB,SAASC,QAAQ;AACjB,SAASC,yBAAyB;;AAIlC;;AAKA;;AA0BA;;AASA;;AASA,OAAO,MAAMC,WAAW,GAAGN,MAAM,CAACO,GAAG,CAAC,aAAa,CAAC;;AAEpD;AACA,SAASH,QAAQ;;AAEjB;AACA;AACA;AACA,OAAO,SAASI,gBAAgBA,CAC9BC,KAA0B,EACE;EAC5B,OAAO,CAAC,CAACA,KAAK,IAAIA,KAAK,CAACC,IAAI,KAAKC,SAAS,IAAIC,eAAe,CAACH,KAAK,CAACC,IAAI,CAAC;AAC3E;AAEA,OAAO,SAASE,eAAeA,CAC7BF,IAAoB,EACO;EAC3B,MAAMG,YAAY,GAAG,CACnBd,aAAa,CAACe,iBAAiB,EAC/Bf,aAAa,CAACgB,eAAe,EAC7BhB,aAAa,CAACiB,WAAW,EACzBjB,aAAa,CAACkB,WAAW,EACzBlB,aAAa,CAACmB,UAAU,CACzB;EAED,OAAO,CAAC,CAACR,IAAI,IAAIG,YAAY,CAACM,QAAQ,CAACT,IAAI,CAAC;AAC9C;;AAEA;AACA;AACA;AACA,OAAO,SAASU,eAAeA,CAC7BC,GAAiB,EACjBC,OAAuD,EAC5C;EACX,IAAIC,SAAgC;EAEpC,QAAQF,GAAG,CAACX,IAAI;IACd,KAAKX,aAAa,CAACe,iBAAiB;MAClCS,SAAS,GAAG,IAAIpB,UAAU,CAACW,iBAAiB,CAACO,GAAG,EAAEC,OAAO,CAAC;MAC1D;IAEF,KAAKvB,aAAa,CAACgB,eAAe;MAChCQ,SAAS,GAAG,IAAIpB,UAAU,CAACY,eAAe,CAACM,GAAG,EAAEC,OAAO,CAAC;MACxD;IAEF,KAAKvB,aAAa,CAACyB,cAAc;MAC/BD,SAAS,GAAG,IAAIpB,UAAU,CAACqB,cAAc,CAACH,GAAG,EAAEC,OAAO,CAAC;MACvD;IAEF,KAAKvB,aAAa,CAAC0B,gBAAgB;MACjCF,SAAS,GAAG,IAAIpB,UAAU,CAACsB,gBAAgB,CAACJ,GAAG,EAAEC,OAAO,CAAC;MACzD;IAEF,KAAKvB,aAAa,CAAC2B,OAAO;MACxBH,SAAS,GAAG,IAAIpB,UAAU,CAACuB,OAAO,CAACL,GAAG,EAAEC,OAAO,CAAC;MAChD;IAEF,KAAKvB,aAAa,CAAC4B,iBAAiB;MAClCJ,SAAS,GAAG,IAAIpB,UAAU,CAACwB,iBAAiB,CAACN,GAAG,EAAEC,OAAO,CAAC;MAC1D;IAEF,KAAKvB,aAAa,CAAC6B,IAAI;MACrBL,SAAS,GAAG,IAAIpB,UAAU,CAACyB,IAAI,CAACP,GAAG,EAAEC,OAAO,CAAC;MAC7C;IAEF,KAAKvB,aAAa,CAAC8B,SAAS;MAC1BN,SAAS,GAAG,IAAIpB,UAAU,CAAC0B,SAAS,CAACR,GAAG,EAAEC,OAAO,CAAC;MAClD;IAEF,KAAKvB,aAAa,CAAC+B,IAAI;MACrBP,SAAS,GAAG,IAAIpB,UAAU,CAAC2B,IAAI,CAACT,GAAG,EAAEC,OAAO,CAAC;MAC7C;IAEF,KAAKvB,aAAa,CAACgC,QAAQ;MACzBR,SAAS,GAAG,IAAIpB,UAAU,CAAC4B,QAAQ,CAACV,GAAG,EAAEC,OAAO,CAAC;MACjD;IAEF,KAAKvB,aAAa,CAACiC,kBAAkB;MACnCT,SAAS,GAAG,IAAIpB,UAAU,CAAC6B,kBAAkB,CAACX,GAAG,EAAEC,OAAO,CAAC;MAC3D;IAEF,KAAKvB,aAAa,CAACkC,kBAAkB;MACnCV,SAAS,GAAG,IAAIpB,UAAU,CAAC8B,kBAAkB,CAACZ,GAAG,EAAEC,OAAO,CAAC;MAC3D;IAEF,KAAKvB,aAAa,CAACmC,WAAW;MAC5BX,SAAS,GAAG,IAAIpB,UAAU,CAAC+B,WAAW,CAACb,GAAG,EAAEC,OAAO,CAAC;MACpD;IAEF,KAAKvB,aAAa,CAACiB,WAAW;MAC5BO,SAAS,GAAG,IAAIpB,UAAU,CAACa,WAAW,CAACK,GAAG,EAAEC,OAAO,CAAC;MACpD;IAEF,KAAKvB,aAAa,CAACkB,WAAW;MAC5BM,SAAS,GAAG,IAAIpB,UAAU,CAACc,WAAW,CAACI,GAAG,EAAEC,OAAO,CAAC;MACpD;IAEF,KAAKvB,aAAa,CAACoC,oBAAoB;MACrCZ,SAAS,GAAG,IAAIpB,UAAU,CAACgC,oBAAoB,CAACd,GAAG,EAAEC,OAAO,CAAC;MAC7D;IAEF,KAAKvB,aAAa,CAACqC,SAAS;MAC1Bb,SAAS,GAAG,IAAIpB,UAAU,CAACiC,SAAS,CAACf,GAAG,EAAEC,OAAO,CAAC;MAClD;IAEF,KAAKvB,aAAa,CAACsC,cAAc;MAC/Bd,SAAS,GAAG,IAAIpB,UAAU,CAACkC,cAAc,CAAChB,GAAG,EAAEC,OAAO,CAAC;MACvD;IAEF,KAAKvB,aAAa,CAACmB,UAAU;MAC3BK,SAAS,GAAG,IAAIpB,UAAU,CAACe,UAAU,CAACG,GAAG,EAAEC,OAAO,CAAC;MACnD;IAEF,KAAKvB,aAAa,CAACuC,cAAc;MAC/Bf,SAAS,GAAG,IAAIpB,UAAU,CAACmC,cAAc,CAACjB,GAAG,EAAEC,OAAO,CAAC;MACvD;IAEF,KAAKvB,aAAa,CAACwC,eAAe;MAChChB,SAAS,GAAG,IAAIpB,UAAU,CAACoC,eAAe,CAAClB,GAAG,EAAEC,OAAO,CAAC;MACxD;IAEF,KAAKvB,aAAa,CAACyC,oBAAoB;MACrCjB,SAAS,GAAG,IAAIpB,UAAU,CAACqC,oBAAoB,CAACnB,GAAG,EAAEC,OAAO,CAAC;MAC7D;IAEF,KAAKvB,aAAa,CAAC0C,cAAc;MAC/BlB,SAAS,GAAG,IAAIpB,UAAU,CAACsC,cAAc,CAACpB,GAAG,EAAEC,OAAO,CAAC;MACvD;IAEF,KAAKvB,aAAa,CAAC2C,4BAA4B;MAC7CnB,SAAS,GAAG,IAAIpB,UAAU,CAACuC,4BAA4B,CAACrB,GAAG,EAAEC,OAAO,CAAC;MACrE;IAEF,KAAKvB,aAAa,CAAC4C,YAAY;MAC7BpB,SAAS,GAAG,IAAIpB,UAAU,CAACwC,YAAY,CAACtB,GAAG,EAAEC,OAAO,CAAC;MACrD;IAEF,KAAKvB,aAAa,CAAC6C,WAAW;MAC5BrB,SAAS,GAAG,IAAIpB,UAAU,CAACyC,WAAW,CAACvB,GAAG,EAAEC,OAAO,CAAC;MACpD;IAEF,KAAKvB,aAAa,CAAC8C,YAAY;MAC7BtB,SAAS,GAAG,IAAIpB,UAAU,CAAC0C,YAAY,CAACxB,GAAG,EAAEC,OAAO,CAAC;MACrD;IAEF,KAAKvB,aAAa,CAAC+C,eAAe;MAChCvB,SAAS,GAAG,IAAIpB,UAAU,CAAC2C,eAAe,CAACzB,GAAG,EAAEC,OAAO,CAAC;MACxD;EACJ;EAEA,IAAI,OAAOC,SAAS,KAAK,WAAW,EAAE;IACpC,MAAM,IAAIlB,yBAAyB,CAACgB,GAAG,CAACX,IAAI,CAAC;EAC/C;EAEA,OAAOa,SAAS;AAClB;;AAEA;AACA;AACA;AACA,OAAO,SAASwB,SAASA,CACvBtC,KAAY,EACZuC,KAAgB,EAChBC,UAAsB,EACtB3B,OAKC,GAAG;EAAE4B,MAAM,EAAE;AAAU,CAAC,EACzB;EACA;EACA,IAAI5B,OAAO,CAAC4B,MAAM,KAAK,OAAO,EAAE;IAC9B,OAAOC,iBAAiB,CAAC1C,KAAK,EAAEuC,KAAK,EAAEC,UAAU,EAAE;MAAEC,MAAM,EAAE;IAAQ,CAAC,CAAC;EACzE;;EAEA;EACA,IAAI5B,OAAO,CAAC4B,MAAM,KAAK,MAAM,EAAE;IAC7B,MAAME,OAAO,GAAG3C,KAAK,CAAC4C,wBAAwB,CAACL,KAAK,CAAC;IACrD,OAAOI,OAAO,EAAEE,QAAQ,CAAC,CAAC,IAAI,EAAE;EAClC;;EAEA;EACA,IACE7C,KAAK,YAAYR,iBAAiB,IAClCQ,KAAK,YAAYN,UAAU,CAAC8B,kBAAkB,IAC9CxB,KAAK,YAAYN,UAAU,CAACkC,cAAc,IAC1C5B,KAAK,YAAYN,UAAU,CAACqC,oBAAoB,IAChD/B,KAAK,YAAYN,UAAU,CAACwC,YAAY,EACxC;IACA,OAAOvC,QAAQ,CACZmD,KAAK,CACJJ,iBAAiB,CAAC1C,KAAK,EAAEuC,KAAK,EAAEC,UAAU,EAAE;MAAEC,MAAM,EAAE;IAAU,CAAC,CAAC,EAClE;MAAEM,KAAK,EAAE;IAAM,CACjB,CAAC,CACAC,IAAI,CAAC,CAAC;EACX;;EAEA;EACA,OAAOhD,KAAK,CAACiD,yBAAyB,CAACV,KAAK,EAAEC,UAAU,CAAC;AAC3D;;AAEA;AACA;AACA;AACA,OAAO,SAASE,iBAAiBA,CAC/B1C,KAAY,EACZuC,KAAgB,EAChBC,UAAsB,EACtB3B,OAIC,GAAG;EAAE4B,MAAM,EAAE;AAAU,CAAC,EACzB;EACA,MAAMS,MAAM,GAAGlD,KAAK,CAACiD,yBAAyB,CAACV,KAAK,EAAEC,UAAU,CAAC;;EAEjE;EACA,IAAIW,aAAa,GAAG,GAAG1D,cAAc,CAACyD,MAAM,CAAC,IAAI;EAEjD,IAAIlD,KAAK,YAAYN,UAAU,CAACoC,eAAe,EAAE;IAC/C,MAAMsB,KAAK,GAAGpD,KAAK,CAACqD,qBAAqB,CAACd,KAAK,CAAC;;IAEhD;IACA,IAAI,CAACa,KAAK,EAAEE,MAAM,EAAE;MAClB,OAAOH,aAAa;IACtB;IAEAA,aAAa,GAAG,GAAG1D,cAAc,CAACyD,MAAM,CAAC,OAAO;;IAEhD;IACAC,aAAa,IAAIC,KAAK,CACnBG,GAAG,CAAC,CAAC;MAAEC;IAAO,CAAC,KAAK;MACnB,MAAM;QAAEC;MAAK,CAAC,GAAGD,MAAM,CAACE,IAAI;MAC5B,MAAMC,QAAQ,GAAGlE,cAAc,CAACgE,IAAI,CAACE,QAAQ,CAAC;MAC9C,OAAO,MAAMA,QAAQ,KAAK9D,WAAW,kBAAkB4D,IAAI,CAACG,MAAM,KAAK;IACzE,CAAC,CAAC,CACDC,IAAI,CAAC,EAAE,CAAC;EACb,CAAC,MAAM,IAAI7D,KAAK,YAAYR,iBAAiB,EAAE;IAC7C,MAAMsE,MAAM,GAAG,CAAC9D,KAAK,CAAC4C,wBAAwB,CAACL,KAAK,CAAC,CAAC,CAACwB,IAAI,CAAC,CAAC;IAC7D,MAAMC,KAAK,GAAGhE,KAAK,CAACgE,KAAK,CAACC,MAAM,CAAC,CAAC;MAAEC;IAAM,CAAC,KAAKJ,MAAM,CAACpD,QAAQ,CAACwD,KAAK,CAAC,CAAC;;IAEvE;IACA,IAAI,CAACF,KAAK,CAACV,MAAM,EAAE;MACjB,OAAOH,aAAa;IACtB;IAEAA,aAAa,GAAG,EAAE;;IAElB;IACAA,aAAa,IAAIa,KAAK,CACnBT,GAAG,CAAEY,IAAI,IAAK;MACb,MAAMC,YAAY,GAAG5B,UAAU,CAAC6B,SAAS,CAACF,IAAI,EAAE,MAAM,CAAC,IAAIA,IAAI,CAACG,IAAI;MACpE,MAAMC,KAAK,GAAG9E,cAAc,CAAC2E,YAAY,CAAC;MAC1C,MAAMF,KAAK,GAAGzE,cAAc,CAAC,IAAI0E,IAAI,CAACD,KAAK,GAAG,CAAC;MAE/C,IAAIM,IAAI,GAAGD,KAAK;;MAEhB;MACA,IAAIvE,KAAK,YAAYN,UAAU,CAACY,eAAe,EAAE;QAC/CkE,IAAI,GAAG,KAAKA,IAAI,EAAE;MACpB;;MAEA;MACA;MACA,OAAO3D,OAAO,CAAC4B,MAAM,KAAK,OAAO,IAC/B,GAAG0B,IAAI,CAACD,KAAK,EAAE,CAACO,WAAW,CAAC,CAAC,KAAKN,IAAI,CAACG,IAAI,CAACG,WAAW,CAAC,CAAC,GACvD,GAAGD,IAAI,IAAIN,KAAK,IAAI,GACpB,GAAGM,IAAI,IAAI;IACjB,CAAC,CAAC,CACDX,IAAI,CAAC,EAAE,CAAC;EACb,CAAC,MAAM,IAAI7D,KAAK,YAAYN,UAAU,CAAC8B,kBAAkB,EAAE;IACzD;IACA2B,aAAa,GAAGD,MAAM,CACnBwB,KAAK,CAAC,YAAY,CAAC,CACnBnB,GAAG,CAAC9D,cAAc,CAAC,CACnBoE,IAAI,CAAC,IAAI,CAAC,CACVc,MAAM,CAAC,IAAI,CAAC;EACjB,CAAC,MAAM,IAAI3E,KAAK,YAAYN,UAAU,CAACkC,cAAc,EAAE;IACrD;IACAuB,aAAa,GAAG,CAACnD,KAAK,CAAC4C,wBAAwB,CAACL,KAAK,CAAC,IAAI,EAAE,EACzDgB,GAAG,CAAC9D,cAAc,CAAC,CACnBoE,IAAI,CAAC,IAAI,CAAC,CACVc,MAAM,CAAC,IAAI,CAAC;EACjB,CAAC,MAAM,IACL3E,KAAK,YAAYN,UAAU,CAACqC,oBAAoB,IAChD/B,KAAK,YAAYN,UAAU,CAACwC,YAAY,EACxC;IACAiB,aAAa,GAAGD,MAAM,GAAG,GAAGA,MAAM,IAAI,GAAG,EAAE;EAC7C,CAAC,MAAM,IAAIlD,KAAK,YAAYN,UAAU,CAAC2C,eAAe,EAAE;IACtD,MAAMuC,QAAQ,GAAG5E,KAAK,CAACqD,qBAAqB,CAACd,KAAK,CAAC;IACnD,MAAM2B,KAAK,GAAGlE,KAAK,CAAC6E,6BAA6B,CAACD,QAAQ,EAAEpC,UAAU,CAAC;IAEvEW,aAAa,GAAGe,KAAK,GAAG,GAAGA,KAAK,IAAI,GAAG,EAAE;EAC3C;EAEA,OAAOf,aAAa;AACtB","ignoreList":[]}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { type ValidationError } from 'joi';
|
|
2
|
+
/**
|
|
3
|
+
* Base class for errors caused by an invalid form definition — whether it
|
|
4
|
+
* fails schema validation or passes the schema but cannot be used by the
|
|
5
|
+
* engine. Never thrown directly — throw a subclass. Consumers (e.g.
|
|
6
|
+
* forms-runner error pages) detect the family with
|
|
7
|
+
* `instanceof InvalidFormDefinitionError`.
|
|
8
|
+
*
|
|
9
|
+
* When subclassing, remember that the message and the messages of any
|
|
10
|
+
* `cause` chain are shown to form authors on preview error pages. Only
|
|
11
|
+
* describe the problem with the form itself — never include sensitive
|
|
12
|
+
* details such as file paths, configuration values or secrets.
|
|
13
|
+
*/
|
|
14
|
+
export declare class InvalidFormDefinitionError extends Error {
|
|
15
|
+
constructor(message: string, options?: ErrorOptions);
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Thrown when a condition in the definition cannot be compiled into an
|
|
19
|
+
* evaluatable expression (e.g. it references the wrong component or list).
|
|
20
|
+
*/
|
|
21
|
+
export declare class ConditionBuildError extends InvalidFormDefinitionError {
|
|
22
|
+
readonly conditionName: string;
|
|
23
|
+
constructor(conditionName: string, options?: ErrorOptions);
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Thrown when a page names a controller that is neither built in nor
|
|
27
|
+
* registered by the host application.
|
|
28
|
+
*/
|
|
29
|
+
export declare class UnknownPageControllerError extends InvalidFormDefinitionError {
|
|
30
|
+
readonly controllerName: string;
|
|
31
|
+
constructor(controllerName: string);
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Thrown when a component declares a type with no registered implementation.
|
|
35
|
+
*/
|
|
36
|
+
export declare class UnknownComponentTypeError extends InvalidFormDefinitionError {
|
|
37
|
+
readonly componentType: string;
|
|
38
|
+
constructor(componentType: string);
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Thrown when a form definition fails Joi schema validation. The raw
|
|
42
|
+
* ValidationError is preserved as `cause` so consumers can reach the
|
|
43
|
+
* per-field details; the message carries Joi's own summary so log lines
|
|
44
|
+
* remain diagnostic for consumers that only read `error.message`.
|
|
45
|
+
*/
|
|
46
|
+
export declare class SchemaValidationError extends InvalidFormDefinitionError {
|
|
47
|
+
cause: ValidationError;
|
|
48
|
+
constructor(cause: ValidationError);
|
|
49
|
+
}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Base class for errors caused by an invalid form definition — whether it
|
|
3
|
+
* fails schema validation or passes the schema but cannot be used by the
|
|
4
|
+
* engine. Never thrown directly — throw a subclass. Consumers (e.g.
|
|
5
|
+
* forms-runner error pages) detect the family with
|
|
6
|
+
* `instanceof InvalidFormDefinitionError`.
|
|
7
|
+
*
|
|
8
|
+
* When subclassing, remember that the message and the messages of any
|
|
9
|
+
* `cause` chain are shown to form authors on preview error pages. Only
|
|
10
|
+
* describe the problem with the form itself — never include sensitive
|
|
11
|
+
* details such as file paths, configuration values or secrets.
|
|
12
|
+
*/
|
|
13
|
+
export class InvalidFormDefinitionError extends Error {
|
|
14
|
+
constructor(message, options) {
|
|
15
|
+
super(message, options);
|
|
16
|
+
this.name = 'InvalidFormDefinitionError';
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Thrown when a condition in the definition cannot be compiled into an
|
|
22
|
+
* evaluatable expression (e.g. it references the wrong component or list).
|
|
23
|
+
*/
|
|
24
|
+
export class ConditionBuildError extends InvalidFormDefinitionError {
|
|
25
|
+
conditionName;
|
|
26
|
+
constructor(conditionName, options) {
|
|
27
|
+
super(`Failed to build condition '${conditionName}'`, options);
|
|
28
|
+
this.name = 'ConditionBuildError';
|
|
29
|
+
this.conditionName = conditionName;
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Thrown when a page names a controller that is neither built in nor
|
|
35
|
+
* registered by the host application.
|
|
36
|
+
*/
|
|
37
|
+
export class UnknownPageControllerError extends InvalidFormDefinitionError {
|
|
38
|
+
controllerName;
|
|
39
|
+
constructor(controllerName) {
|
|
40
|
+
super(`Page controller ${controllerName} does not exist`);
|
|
41
|
+
this.name = 'UnknownPageControllerError';
|
|
42
|
+
this.controllerName = controllerName;
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Thrown when a component declares a type with no registered implementation.
|
|
48
|
+
*/
|
|
49
|
+
export class UnknownComponentTypeError extends InvalidFormDefinitionError {
|
|
50
|
+
componentType;
|
|
51
|
+
constructor(componentType) {
|
|
52
|
+
super(`Component type ${componentType} does not exist`);
|
|
53
|
+
this.name = 'UnknownComponentTypeError';
|
|
54
|
+
this.componentType = componentType;
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Thrown when a form definition fails Joi schema validation. The raw
|
|
60
|
+
* ValidationError is preserved as `cause` so consumers can reach the
|
|
61
|
+
* per-field details; the message carries Joi's own summary so log lines
|
|
62
|
+
* remain diagnostic for consumers that only read `error.message`.
|
|
63
|
+
*/
|
|
64
|
+
export class SchemaValidationError extends InvalidFormDefinitionError {
|
|
65
|
+
// Error types `cause` as unknown; this constructor only accepts a Joi
|
|
66
|
+
// ValidationError, so narrow the declaration for consumers (type-only).
|
|
67
|
+
|
|
68
|
+
constructor(cause) {
|
|
69
|
+
super(`Invalid form definition: ${cause.message}`, {
|
|
70
|
+
cause
|
|
71
|
+
});
|
|
72
|
+
this.name = 'SchemaValidationError';
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
//# sourceMappingURL=errors.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.js","names":["InvalidFormDefinitionError","Error","constructor","message","options","name","ConditionBuildError","conditionName","UnknownPageControllerError","controllerName","UnknownComponentTypeError","componentType","SchemaValidationError","cause"],"sources":["../../../../src/server/plugins/engine/errors.ts"],"sourcesContent":["import { type ValidationError } from 'joi'\n\n/**\n * Base class for errors caused by an invalid form definition — whether it\n * fails schema validation or passes the schema but cannot be used by the\n * engine. Never thrown directly — throw a subclass. Consumers (e.g.\n * forms-runner error pages) detect the family with\n * `instanceof InvalidFormDefinitionError`.\n *\n * When subclassing, remember that the message and the messages of any\n * `cause` chain are shown to form authors on preview error pages. Only\n * describe the problem with the form itself — never include sensitive\n * details such as file paths, configuration values or secrets.\n */\nexport class InvalidFormDefinitionError extends Error {\n constructor(message: string, options?: ErrorOptions) {\n super(message, options)\n this.name = 'InvalidFormDefinitionError'\n }\n}\n\n/**\n * Thrown when a condition in the definition cannot be compiled into an\n * evaluatable expression (e.g. it references the wrong component or list).\n */\nexport class ConditionBuildError extends InvalidFormDefinitionError {\n public readonly conditionName: string\n\n constructor(conditionName: string, options?: ErrorOptions) {\n super(`Failed to build condition '${conditionName}'`, options)\n this.name = 'ConditionBuildError'\n this.conditionName = conditionName\n }\n}\n\n/**\n * Thrown when a page names a controller that is neither built in nor\n * registered by the host application.\n */\nexport class UnknownPageControllerError extends InvalidFormDefinitionError {\n public readonly controllerName: string\n\n constructor(controllerName: string) {\n super(`Page controller ${controllerName} does not exist`)\n this.name = 'UnknownPageControllerError'\n this.controllerName = controllerName\n }\n}\n\n/**\n * Thrown when a component declares a type with no registered implementation.\n */\nexport class UnknownComponentTypeError extends InvalidFormDefinitionError {\n public readonly componentType: string\n\n constructor(componentType: string) {\n super(`Component type ${componentType} does not exist`)\n this.name = 'UnknownComponentTypeError'\n this.componentType = componentType\n }\n}\n\n/**\n * Thrown when a form definition fails Joi schema validation. The raw\n * ValidationError is preserved as `cause` so consumers can reach the\n * per-field details; the message carries Joi's own summary so log lines\n * remain diagnostic for consumers that only read `error.message`.\n */\nexport class SchemaValidationError extends InvalidFormDefinitionError {\n // Error types `cause` as unknown; this constructor only accepts a Joi\n // ValidationError, so narrow the declaration for consumers (type-only).\n declare cause: ValidationError\n\n constructor(cause: ValidationError) {\n super(`Invalid form definition: ${cause.message}`, { cause })\n this.name = 'SchemaValidationError'\n }\n}\n"],"mappings":"AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMA,0BAA0B,SAASC,KAAK,CAAC;EACpDC,WAAWA,CAACC,OAAe,EAAEC,OAAsB,EAAE;IACnD,KAAK,CAACD,OAAO,EAAEC,OAAO,CAAC;IACvB,IAAI,CAACC,IAAI,GAAG,4BAA4B;EAC1C;AACF;;AAEA;AACA;AACA;AACA;AACA,OAAO,MAAMC,mBAAmB,SAASN,0BAA0B,CAAC;EAClDO,aAAa;EAE7BL,WAAWA,CAACK,aAAqB,EAAEH,OAAsB,EAAE;IACzD,KAAK,CAAC,8BAA8BG,aAAa,GAAG,EAAEH,OAAO,CAAC;IAC9D,IAAI,CAACC,IAAI,GAAG,qBAAqB;IACjC,IAAI,CAACE,aAAa,GAAGA,aAAa;EACpC;AACF;;AAEA;AACA;AACA;AACA;AACA,OAAO,MAAMC,0BAA0B,SAASR,0BAA0B,CAAC;EACzDS,cAAc;EAE9BP,WAAWA,CAACO,cAAsB,EAAE;IAClC,KAAK,CAAC,mBAAmBA,cAAc,iBAAiB,CAAC;IACzD,IAAI,CAACJ,IAAI,GAAG,4BAA4B;IACxC,IAAI,CAACI,cAAc,GAAGA,cAAc;EACtC;AACF;;AAEA;AACA;AACA;AACA,OAAO,MAAMC,yBAAyB,SAASV,0BAA0B,CAAC;EACxDW,aAAa;EAE7BT,WAAWA,CAACS,aAAqB,EAAE;IACjC,KAAK,CAAC,kBAAkBA,aAAa,iBAAiB,CAAC;IACvD,IAAI,CAACN,IAAI,GAAG,2BAA2B;IACvC,IAAI,CAACM,aAAa,GAAGA,aAAa;EACpC;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,qBAAqB,SAASZ,0BAA0B,CAAC;EACpE;EACA;;EAGAE,WAAWA,CAACW,KAAsB,EAAE;IAClC,KAAK,CAAC,4BAA4BA,KAAK,CAACV,OAAO,EAAE,EAAE;MAAEU;IAAM,CAAC,CAAC;IAC7D,IAAI,CAACR,IAAI,GAAG,uBAAuB;EACrC;AACF","ignoreList":[]}
|
|
@@ -323,7 +323,16 @@
|
|
|
323
323
|
},
|
|
324
324
|
|
|
325
325
|
"locationFieldBase": {
|
|
326
|
-
"howToFind": "Sut i ddod o hyd i fanylion lleoliad"
|
|
326
|
+
"howToFind": "Sut i ddod o hyd i fanylion lleoliad",
|
|
327
|
+
"map": {
|
|
328
|
+
"helpPanel": {
|
|
329
|
+
"label": "Sut i ddefnyddio'r map hwn",
|
|
330
|
+
"point1": "Chwilio am sir, lle neu god post",
|
|
331
|
+
"point2": "Defnyddiwch yr eiconau + a - i chwyddo i mewn ac allan",
|
|
332
|
+
"point3": "Defnyddiwch lyfliwr neu allweddlon i ganolbwyntio'r pwynt yn y lleoliad",
|
|
333
|
+
"point4": "Cliciwch i ychwanegu'r lleoliad i'r map"
|
|
334
|
+
}
|
|
335
|
+
}
|
|
327
336
|
},
|
|
328
337
|
|
|
329
338
|
"yesNoField": {
|
|
@@ -350,6 +359,47 @@
|
|
|
350
359
|
"added_few": "Ychwanegwyd [[count]] lleoliad",
|
|
351
360
|
"added_many": "Ychwanegwyd [[count]] o leoliadau",
|
|
352
361
|
"added_other": "Ychwanegwyd [[count]] lleoliad",
|
|
362
|
+
"map": {
|
|
363
|
+
"helpPanel": {
|
|
364
|
+
"label": "Sut i ddefnyddio'r map hwn",
|
|
365
|
+
"ledeIntro": "Gallwch ychwanegu",
|
|
366
|
+
"ledeOutro": "i'r map.",
|
|
367
|
+
"lineText": "llinell",
|
|
368
|
+
"shapeText": "siâp",
|
|
369
|
+
"lineOrShapeText": "llinell neu siâp",
|
|
370
|
+
"typesPhrasePoint": "pwyntiau",
|
|
371
|
+
"typesPhraseLine": "lliniau",
|
|
372
|
+
"typesPhraseShape": "siâpiau",
|
|
373
|
+
"typesPhraseOr": "neu",
|
|
374
|
+
"point1": "Chwilio am sir, lle neu god post",
|
|
375
|
+
"point2": "Defnyddiwch yr eiconau + a - i chwyddo i mewn ac allan",
|
|
376
|
+
"point3": "Cliciwch ddwywaith, neu dewiswch 'Wedi gorffen', pan fyddwch wedi",
|
|
377
|
+
"point4": "Rhowch enw i'r lleoliad"
|
|
378
|
+
},
|
|
379
|
+
"typeDescriptions": {
|
|
380
|
+
"point": "Pwynt",
|
|
381
|
+
"line": "Llinell",
|
|
382
|
+
"polygon": "Siâp"
|
|
383
|
+
},
|
|
384
|
+
"buttons": {
|
|
385
|
+
"point": "Ychwanegu pwynt",
|
|
386
|
+
"line": "Ychwanegu llinell",
|
|
387
|
+
"polygon": "Ychwanegu siâp"
|
|
388
|
+
},
|
|
389
|
+
"itemLabel1": "Lleoliad",
|
|
390
|
+
"itemLabel2": "disgrifiad",
|
|
391
|
+
"itemUpdateLink": "Diweddaru",
|
|
392
|
+
"itemDeleteLink": "Dileu",
|
|
393
|
+
"itemFocusLink": "Dangos",
|
|
394
|
+
"itemVisuallyHidden": "lleoliad",
|
|
395
|
+
"details": {
|
|
396
|
+
"summary": "Cyfesurynnau",
|
|
397
|
+
"type": "Math",
|
|
398
|
+
"centroidGridReference": "Canol cyfeirnod grid",
|
|
399
|
+
"firstPointGridReference": "Cyfeirnod grid y pwynt cyntaf",
|
|
400
|
+
"detailedCoordinates": "Cyfesurynnau manwl"
|
|
401
|
+
}
|
|
402
|
+
},
|
|
353
403
|
"validation": {
|
|
354
404
|
"descriptionRequired": "Rhowch ddisgrifiad ar gyfer lleoliad [[count]]",
|
|
355
405
|
"wrongCountry": "Rhaid i leoliad [[count]] fod y tu mewn i [[country]]"
|
|
@@ -266,7 +266,16 @@
|
|
|
266
266
|
},
|
|
267
267
|
|
|
268
268
|
"locationFieldBase": {
|
|
269
|
-
"howToFind": "How to find location details"
|
|
269
|
+
"howToFind": "How to find location details",
|
|
270
|
+
"map": {
|
|
271
|
+
"helpPanel": {
|
|
272
|
+
"label": "How to use this map",
|
|
273
|
+
"point1": "Search for a place or postcode",
|
|
274
|
+
"point2": "Use the + and - icons to zoom in and out",
|
|
275
|
+
"point3": "Use a mouse or keyboard to centre the point at the location",
|
|
276
|
+
"point4": "Click to add the location to the map"
|
|
277
|
+
}
|
|
278
|
+
}
|
|
270
279
|
},
|
|
271
280
|
|
|
272
281
|
"yesNoField": {
|
|
@@ -289,6 +298,47 @@
|
|
|
289
298
|
"geospatialField": {
|
|
290
299
|
"added_one": "Added [[count]] location",
|
|
291
300
|
"added_other": "Added [[count]] locations",
|
|
301
|
+
"map": {
|
|
302
|
+
"helpPanel": {
|
|
303
|
+
"label": "How to use this map",
|
|
304
|
+
"ledeIntro": "You can add",
|
|
305
|
+
"ledeOutro": "to the map.",
|
|
306
|
+
"lineText": "a line",
|
|
307
|
+
"shapeText": "a shape",
|
|
308
|
+
"lineOrShapeText": "a line or shape",
|
|
309
|
+
"typesPhrasePoint": "points",
|
|
310
|
+
"typesPhraseLine": "lines",
|
|
311
|
+
"typesPhraseShape": "shapes",
|
|
312
|
+
"typesPhraseOr": "or",
|
|
313
|
+
"point1": "Search for a county, place or postcode",
|
|
314
|
+
"point2": "Use the + and - icons to zoom in and out",
|
|
315
|
+
"point3": "Double‑click, or select 'Done', when you have finished drawing",
|
|
316
|
+
"point4": "Give the location a name"
|
|
317
|
+
},
|
|
318
|
+
"typeDescriptions": {
|
|
319
|
+
"point": "Point",
|
|
320
|
+
"line": "Line",
|
|
321
|
+
"polygon": "Shape"
|
|
322
|
+
},
|
|
323
|
+
"buttons": {
|
|
324
|
+
"point": "Add point",
|
|
325
|
+
"line": "Add line",
|
|
326
|
+
"polygon": "Add shape"
|
|
327
|
+
},
|
|
328
|
+
"itemLabel1": "Location",
|
|
329
|
+
"itemLabel2": "description",
|
|
330
|
+
"itemUpdateLink": "Update",
|
|
331
|
+
"itemDeleteLink": "Delete",
|
|
332
|
+
"itemFocusLink": "Show",
|
|
333
|
+
"itemVisuallyHidden": "location",
|
|
334
|
+
"details": {
|
|
335
|
+
"summary": "Coordinates",
|
|
336
|
+
"type": "Type",
|
|
337
|
+
"centroidGridReference": "Centre grid reference",
|
|
338
|
+
"firstPointGridReference": "First point grid reference",
|
|
339
|
+
"detailedCoordinates": "Detailed coordinates"
|
|
340
|
+
}
|
|
341
|
+
},
|
|
292
342
|
"validation": {
|
|
293
343
|
"descriptionRequired": "Enter description for location [[count]]",
|
|
294
344
|
"wrongCountry": "Location [[count]] must be within [[country]]"
|
|
@@ -7,6 +7,7 @@ import { EN_GB } from "../../../constants.js";
|
|
|
7
7
|
import "../components/YesNoField.js";
|
|
8
8
|
import { hasListFormField } from "../components/helpers/components.js";
|
|
9
9
|
import { todayAsDateOnly } from "../date-helper.js";
|
|
10
|
+
import { ConditionBuildError, SchemaValidationError } from "../errors.js";
|
|
10
11
|
import { findPage, getError, getPage } from "../helpers.js";
|
|
11
12
|
import { loadFormTranslations } from "../i18n/createFormTranslator.js";
|
|
12
13
|
import { createTranslator } from "../i18n/createTranslator.js";
|
|
@@ -54,7 +55,7 @@ export class FormModel {
|
|
|
54
55
|
abortEarly: false
|
|
55
56
|
});
|
|
56
57
|
if (result.error) {
|
|
57
|
-
throw result.error;
|
|
58
|
+
throw new SchemaValidationError(result.error);
|
|
58
59
|
}
|
|
59
60
|
|
|
60
61
|
// Make a clone of the shallow copy returned
|
|
@@ -180,7 +181,14 @@ export class FormModel {
|
|
|
180
181
|
displayName,
|
|
181
182
|
value
|
|
182
183
|
} = condition;
|
|
183
|
-
|
|
184
|
+
let expr;
|
|
185
|
+
try {
|
|
186
|
+
expr = this.toConditionExpression(value, parser);
|
|
187
|
+
} catch (cause) {
|
|
188
|
+
throw new ConditionBuildError(displayName, {
|
|
189
|
+
cause
|
|
190
|
+
});
|
|
191
|
+
}
|
|
184
192
|
const fn = evaluationState => {
|
|
185
193
|
const ctx = this.toConditionContext(evaluationState, this.conditions);
|
|
186
194
|
try {
|