@defra/forms-engine-plugin 5.0.0-alpha.7 → 5.0.0-alpha.9

package/.server/server/plugins/postcode-lookup/routes/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Boom","StatusCodes","Joi","EXTERNAL_STATE_APPENDAGE","JOURNEY_BASE_URL","createDetailsPayloadSchema","createManualPayloadSchema","createSelectPayloadSchema","detailsViewModel","manualViewModel","selectViewModel","stepSchema","steps","service","viewName","getSessionState","request","state","yar","get","badRequest","flashComponentState","componentName","address","addressState","addressLine1","addressLine2","town","county","postcode","uprn","undefined","appendage","component","data","flash","dispatch","h","initial","details","postcodeQuery","buildingNameQuery","set","query","step","redirect","code","SEE_OTHER","getRoutes","options","getRoute","postRoute","method","path","handler","session","model","manual","view","validate","object","keys","string","allow","optional","payload","detailsPostHandler","select","selectPostHandler","manualPostHandler","unknown","ordnanceSurveyApiKey","apiKey","language","value","error","addresses","searchByUPRN","property","at","internal","sourceUrl","abortEarly"],"sources":["../../../../../src/server/plugins/postcode-lookup/routes/index.js"],"sourcesContent":["import Boom from '@hapi/boom'\nimport { StatusCodes } from 'http-status-codes'\nimport Joi from 'joi'\n\nimport { EXTERNAL_STATE_APPENDAGE } from '~/src/server/constants.js'\nimport {\n  JOURNEY_BASE_URL,\n  createDetailsPayloadSchema,\n  createManualPayloadSchema,\n  createSelectPayloadSchema,\n  detailsViewModel,\n  manualViewModel,\n  selectViewModel,\n  stepSchema,\n  steps\n} from '~/src/server/plugins/postcode-lookup/models/index.js'\nimport * as service from '~/src/server/plugins/postcode-lookup/service.js'\n\nconst viewName = 'postcode-lookup-details'\n\n/**\n * Get the session state associated with this journey\n * @param {PostcodeLookupRequest} request\n */\nfunction getSessionState(request) {\n  /**\n   * @type {PostcodeLookupSessionData | null | undefined}\n   */\n  const state = request.yar.get(JOURNEY_BASE_URL)\n\n  if (!state) {\n    throw Boom.badRequest(\n      `No postcode lookup data found for ${JOURNEY_BASE_URL}`\n    )\n  }\n\n  return state\n}\n\n/**\n * Flash form component state\n * @param {PostcodeLookupRequest} request - the request\n * @param {string} componentName - the component name\n * @param {Address | PostcodeLookupManualPayload} address - the address from ordnance survey or manually entered\n */\nfunction flashComponentState(request, componentName, address) {\n  const addressState = {\n    addressLine1: address.addressLine1,\n    addressLine2: address.addressLine2,\n    town: address.town,\n    county: address.county,\n    postcode: address.postcode,\n    uprn: 'uprn' in address && address.uprn ? address.uprn : undefined\n  }\n\n  /**\n   * @type {ExternalStateAppendage}\n   */\n  const appendage = {\n    component: componentName,\n    data: addressState\n  }\n\n  request.yar.flash(EXTERNAL_STATE_APPENDAGE, appendage, true)\n}\n\n/**\n * Initialises and dispatches the request to the postcode lookup journey\n * @param {FormRequestPayload} request - the source page\n * @param {FormResponseToolkit} h - the source page\n * @param {PostcodeLookupDispatchData} initial - the source data\n */\nexport function dispatch(request, h, initial) {\n  /**\n   * @type {PostcodeLookupSessionData}\n   */\n  const data = {\n    initial,\n    details: { postcodeQuery: '', buildingNameQuery: '' }\n  }\n\n  request.yar.set(JOURNEY_BASE_URL, data)\n\n  const query = initial.step ? `?step=${initial.step}` : ''\n\n  return h.redirect(`${JOURNEY_BASE_URL}${query}`).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * Gets the postcode lookup routes\n * @param {PostcodeLookupConfiguration} options - ordnance survey api key\n */\nexport function getRoutes(options) {\n  return [getRoute(), postRoute(options)]\n}\n\n/**\n * @returns {ServerRoute<PostcodeLookupGetRequestRefs>}\n */\nfunction getRoute() {\n  return {\n    method: 'GET',\n    path: JOURNEY_BASE_URL,\n    handler(request, h) {\n      const { query } = request\n      const { step } = query\n      const session = getSessionState(request)\n\n      const model =\n        step === steps.manual\n          ? manualViewModel(session)\n          : detailsViewModel(session)\n\n      return h.view(viewName, model)\n    },\n    options: {\n      validate: {\n        query: Joi.object()\n          .keys({\n            step: Joi.string().allow(steps.details, steps.manual).optional()\n          })\n          .optional()\n      }\n    }\n  }\n}\n\n/**\n * @param {PostcodeLookupConfiguration} options\n * @returns {ServerRoute<PostcodeLookupPostRequestRefs>}\n */\nfunction postRoute(options) {\n  return {\n    method: 'POST',\n    path: JOURNEY_BASE_URL,\n    async handler(request, h) {\n      const { payload } = request\n      const { step } = payload\n\n      switch (step) {\n        case steps.details: {\n          return detailsPostHandler(request, h, options)\n        }\n        case steps.select: {\n          return selectPostHandler(request, h, options)\n        }\n        case steps.manual: {\n          return manualPostHandler(request, h)\n        }\n        default:\n          throw Boom.badRequest(`Invalid step ${step}`)\n      }\n    },\n    options: {\n      validate: {\n        payload: Joi.object()\n          .keys({\n            step: stepSchema\n          })\n          .unknown(true)\n      }\n    }\n  }\n}\n\n/**\n * Post handler for the details step\n * @param {PostcodeLookupPostRequest} request\n * @param {ResponseToolkit<PostcodeLookupPostRequestRefs>} h\n * @param {PostcodeLookupConfiguration} options\n */\nasync function detailsPostHandler(request, h, options) {\n  const session = getSessionState(request)\n  const { ordnanceSurveyApiKey: apiKey } = options\n  const language = session.initial.language ?? 'en-GB'\n  const { value: details, error } = createDetailsPayloadSchema(\n    language\n  ).validate(request.payload)\n\n  let model\n\n  if (error) {\n    model = detailsViewModel(session, details, error)\n\n    return h.view(viewName, model)\n  }\n\n  const { postcodeQuery, buildingNameQuery } = details\n  session.details = { postcodeQuery, buildingNameQuery }\n\n  // Store the updated session\n  request.yar.set(JOURNEY_BASE_URL, session)\n\n  model = await selectViewModel({ session, apiKey })\n\n  return h.view(viewName, model)\n}\n\n/**\n * Post handler for the select step\n * @param {PostcodeLookupPostRequest} request\n * @param {ResponseToolkit<PostcodeLookupPostRequestRefs>} h\n * @param {PostcodeLookupConfiguration} options\n */\nasync function selectPostHandler(request, h, options) {\n  const session = getSessionState(request)\n  const { ordnanceSurveyApiKey: apiKey } = options\n  const language = session.initial.language ?? 'en-GB'\n  const { value: select, error } = createSelectPayloadSchema(language).validate(\n    request.payload\n  )\n\n  if (error) {\n    const model = await selectViewModel({ session, apiKey }, select, error)\n\n    return h.view(viewName, model)\n  }\n\n  const addresses = await service.searchByUPRN(select.uprn, apiKey)\n  const property = addresses.at(0)\n\n  if (!property) {\n    throw Boom.internal(`UPRN ${property} not found`)\n  }\n\n  const { componentName, sourceUrl } = session.initial\n  flashComponentState(request, componentName, property)\n\n  // Redirect back to the source form page\n  return h.redirect(sourceUrl).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * Post handler for the manual step\n * @param {PostcodeLookupPostRequest} request\n * @param {ResponseToolkit<PostcodeLookupPostRequestRefs>} h\n */\nfunction manualPostHandler(request, h) {\n  const session = getSessionState(request)\n  const language = session.initial.language ?? 'en-GB'\n\n  const { value: manual, error } = createManualPayloadSchema(language).validate(\n    request.payload,\n    {\n      abortEarly: false\n    }\n  )\n\n  if (error) {\n    const model = manualViewModel(session, manual, error)\n\n    return h.view(viewName, model)\n  }\n\n  const { componentName, sourceUrl } = session.initial\n  flashComponentState(request, componentName, manual)\n\n  // Redirect back to the source form page\n  return h.redirect(sourceUrl).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * @import { ResponseToolkit, ServerRoute } from '@hapi/hapi'\n * @import { PostcodeLookupManualPayload, PostcodeLookupDetailsPayload, PostcodeLookupSelectPayload, Address, PostcodeLookupGetRequestRefs, PostcodeLookupPostRequestRefs, PostcodeLookupRequest, PostcodeLookupPostRequest, PostcodeLookupConfiguration, PostcodeLookupDispatchData, PostcodeLookupSessionData } from '~/src/server/plugins/postcode-lookup/types.js'\n * @import { FormRequestPayload, FormResponseToolkit } from '~/src/server/routes/types.js'\n * @import { ExternalStateAppendage } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAC7B,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,wBAAwB;AACjC,SACEC,gBAAgB,EAChBC,0BAA0B,EAC1BC,yBAAyB,EACzBC,yBAAyB,EACzBC,gBAAgB,EAChBC,eAAe,EACfC,eAAe,EACfC,UAAU,EACVC,KAAK;AAEP,OAAO,KAAKC,OAAO;AAEnB,MAAMC,QAAQ,GAAG,yBAAyB;;AAE1C;AACA;AACA;AACA;AACA,SAASC,eAAeA,CAACC,OAAO,EAAE;EAChC;AACF;AACA;EACE,MAAMC,KAAK,GAAGD,OAAO,CAACE,GAAG,CAACC,GAAG,CAACf,gBAAgB,CAAC;EAE/C,IAAI,CAACa,KAAK,EAAE;IACV,MAAMjB,IAAI,CAACoB,UAAU,CACnB,qCAAqChB,gBAAgB,EACvD,CAAC;EACH;EAEA,OAAOa,KAAK;AACd;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASI,mBAAmBA,CAACL,OAAO,EAAEM,aAAa,EAAEC,OAAO,EAAE;EAC5D,MAAMC,YAAY,GAAG;IACnBC,YAAY,EAAEF,OAAO,CAACE,YAAY;IAClCC,YAAY,EAAEH,OAAO,CAACG,YAAY;IAClCC,IAAI,EAAEJ,OAAO,CAACI,IAAI;IAClBC,MAAM,EAAEL,OAAO,CAACK,MAAM;IACtBC,QAAQ,EAAEN,OAAO,CAACM,QAAQ;IAC1BC,IAAI,EAAE,MAAM,IAAIP,OAAO,IAAIA,OAAO,CAACO,IAAI,GAAGP,OAAO,CAACO,IAAI,GAAGC;EAC3D,CAAC;;EAED;AACF;AACA;EACE,MAAMC,SAAS,GAAG;IAChBC,SAAS,EAAEX,aAAa;IACxBY,IAAI,EAAEV;EACR,CAAC;EAEDR,OAAO,CAACE,GAAG,CAACiB,KAAK,CAAChC,wBAAwB,EAAE6B,SAAS,EAAE,IAAI,CAAC;AAC9D;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,QAAQA,CAACpB,OAAO,EAAEqB,CAAC,EAAEC,OAAO,EAAE;EAC5C;AACF;AACA;EACE,MAAMJ,IAAI,GAAG;IACXI,OAAO;IACPC,OAAO,EAAE;MAAEC,aAAa,EAAE,EAAE;MAAEC,iBAAiB,EAAE;IAAG;EACtD,CAAC;EAEDzB,OAAO,CAACE,GAAG,CAACwB,GAAG,CAACtC,gBAAgB,EAAE8B,IAAI,CAAC;EAEvC,MAAMS,KAAK,GAAGL,OAAO,CAACM,IAAI,GAAG,SAASN,OAAO,CAACM,IAAI,EAAE,GAAG,EAAE;EAEzD,OAAOP,CAAC,CAACQ,QAAQ,CAAC,GAAGzC,gBAAgB,GAAGuC,KAAK,EAAE,CAAC,CAACG,IAAI,CAAC7C,WAAW,CAAC8C,SAAS,CAAC;AAC9E;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACC,OAAO,EAAE;EACjC,OAAO,CAACC,QAAQ,CAAC,CAAC,EAAEC,SAAS,CAACF,OAAO,CAAC,CAAC;AACzC;;AAEA;AACA;AACA;AACA,SAASC,QAAQA,CAAA,EAAG;EAClB,OAAO;IACLE,MAAM,EAAE,KAAK;IACbC,IAAI,EAAEjD,gBAAgB;IACtBkD,OAAOA,CAACtC,OAAO,EAAEqB,CAAC,EAAE;MAClB,MAAM;QAAEM;MAAM,CAAC,GAAG3B,OAAO;MACzB,MAAM;QAAE4B;MAAK,CAAC,GAAGD,KAAK;MACtB,MAAMY,OAAO,GAAGxC,eAAe,CAACC,OAAO,CAAC;MAExC,MAAMwC,KAAK,GACTZ,IAAI,KAAKhC,KAAK,CAAC6C,MAAM,GACjBhD,eAAe,CAAC8C,OAAO,CAAC,GACxB/C,gBAAgB,CAAC+C,OAAO,CAAC;MAE/B,OAAOlB,CAAC,CAACqB,IAAI,CAAC5C,QAAQ,EAAE0C,KAAK,CAAC;IAChC,CAAC;IACDP,OAAO,EAAE;MACPU,QAAQ,EAAE;QACRhB,KAAK,EAAEzC,GAAG,CAAC0D,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJjB,IAAI,EAAE1C,GAAG,CAAC4D,MAAM,CAAC,CAAC,CAACC,KAAK,CAACnD,KAAK,CAAC2B,OAAO,EAAE3B,KAAK,CAAC6C,MAAM,CAAC,CAACO,QAAQ,CAAC;QACjE,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,SAASb,SAASA,CAACF,OAAO,EAAE;EAC1B,OAAO;IACLG,MAAM,EAAE,MAAM;IACdC,IAAI,EAAEjD,gBAAgB;IACtB,MAAMkD,OAAOA,CAACtC,OAAO,EAAEqB,CAAC,EAAE;MACxB,MAAM;QAAE4B;MAAQ,CAAC,GAAGjD,OAAO;MAC3B,MAAM;QAAE4B;MAAK,CAAC,GAAGqB,OAAO;MAExB,QAAQrB,IAAI;QACV,KAAKhC,KAAK,CAAC2B,OAAO;UAAE;YAClB,OAAO2B,kBAAkB,CAAClD,OAAO,EAAEqB,CAAC,EAAEY,OAAO,CAAC;UAChD;QACA,KAAKrC,KAAK,CAACuD,MAAM;UAAE;YACjB,OAAOC,iBAAiB,CAACpD,OAAO,EAAEqB,CAAC,EAAEY,OAAO,CAAC;UAC/C;QACA,KAAKrC,KAAK,CAAC6C,MAAM;UAAE;YACjB,OAAOY,iBAAiB,CAACrD,OAAO,EAAEqB,CAAC,CAAC;UACtC;QACA;UACE,MAAMrC,IAAI,CAACoB,UAAU,CAAC,gBAAgBwB,IAAI,EAAE,CAAC;MACjD;IACF,CAAC;IACDK,OAAO,EAAE;MACPU,QAAQ,EAAE;QACRM,OAAO,EAAE/D,GAAG,CAAC0D,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJjB,IAAI,EAAEjC;QACR,CAAC,CAAC,CACD2D,OAAO,CAAC,IAAI;MACjB;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,eAAeJ,kBAAkBA,CAAClD,OAAO,EAAEqB,CAAC,EAAEY,OAAO,EAAE;EACrD,MAAMM,OAAO,GAAGxC,eAAe,CAACC,OAAO,CAAC;EACxC,MAAM;IAAEuD,oBAAoB,EAAEC;EAAO,CAAC,GAAGvB,OAAO;EAChD,MAAMwB,QAAQ,GAAGlB,OAAO,CAACjB,OAAO,CAACmC,QAAQ,IAAI,OAAO;EACpD,MAAM;IAAEC,KAAK,EAAEnC,OAAO;IAAEoC;EAAM,CAAC,GAAGtE,0BAA0B,CAC1DoE,QACF,CAAC,CAACd,QAAQ,CAAC3C,OAAO,CAACiD,OAAO,CAAC;EAE3B,IAAIT,KAAK;EAET,IAAImB,KAAK,EAAE;IACTnB,KAAK,GAAGhD,gBAAgB,CAAC+C,OAAO,EAAEhB,OAAO,EAAEoC,KAAK,CAAC;IAEjD,OAAOtC,CAAC,CAACqB,IAAI,CAAC5C,QAAQ,EAAE0C,KAAK,CAAC;EAChC;EAEA,MAAM;IAAEhB,aAAa;IAAEC;EAAkB,CAAC,GAAGF,OAAO;EACpDgB,OAAO,CAAChB,OAAO,GAAG;IAAEC,aAAa;IAAEC;EAAkB,CAAC;;EAEtD;EACAzB,OAAO,CAACE,GAAG,CAACwB,GAAG,CAACtC,gBAAgB,EAAEmD,OAAO,CAAC;EAE1CC,KAAK,GAAG,MAAM9C,eAAe,CAAC;IAAE6C,OAAO;IAAEiB;EAAO,CAAC,CAAC;EAElD,OAAOnC,CAAC,CAACqB,IAAI,CAAC5C,QAAQ,EAAE0C,KAAK,CAAC;AAChC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,eAAeY,iBAAiBA,CAACpD,OAAO,EAAEqB,CAAC,EAAEY,OAAO,EAAE;EACpD,MAAMM,OAAO,GAAGxC,eAAe,CAACC,OAAO,CAAC;EACxC,MAAM;IAAEuD,oBAAoB,EAAEC;EAAO,CAAC,GAAGvB,OAAO;EAChD,MAAMwB,QAAQ,GAAGlB,OAAO,CAACjB,OAAO,CAACmC,QAAQ,IAAI,OAAO;EACpD,MAAM;IAAEC,KAAK,EAAEP,MAAM;IAAEQ;EAAM,CAAC,GAAGpE,yBAAyB,CAACkE,QAAQ,CAAC,CAACd,QAAQ,CAC3E3C,OAAO,CAACiD,OACV,CAAC;EAED,IAAIU,KAAK,EAAE;IACT,MAAMnB,KAAK,GAAG,MAAM9C,eAAe,CAAC;MAAE6C,OAAO;MAAEiB;IAAO,CAAC,EAAEL,MAAM,EAAEQ,KAAK,CAAC;IAEvE,OAAOtC,CAAC,CAACqB,IAAI,CAAC5C,QAAQ,EAAE0C,KAAK,CAAC;EAChC;EAEA,MAAMoB,SAAS,GAAG,MAAM/D,OAAO,CAACgE,YAAY,CAACV,MAAM,CAACrC,IAAI,EAAE0C,MAAM,CAAC;EACjE,MAAMM,QAAQ,GAAGF,SAAS,CAACG,EAAE,CAAC,CAAC,CAAC;EAEhC,IAAI,CAACD,QAAQ,EAAE;IACb,MAAM9E,IAAI,CAACgF,QAAQ,CAAC,QAAQF,QAAQ,YAAY,CAAC;EACnD;EAEA,MAAM;IAAExD,aAAa;IAAE2D;EAAU,CAAC,GAAG1B,OAAO,CAACjB,OAAO;EACpDjB,mBAAmB,CAACL,OAAO,EAAEM,aAAa,EAAEwD,QAAQ,CAAC;;EAErD;EACA,OAAOzC,CAAC,CAACQ,QAAQ,CAACoC,SAAS,CAAC,CAACnC,IAAI,CAAC7C,WAAW,CAAC8C,SAAS,CAAC;AAC1D;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASsB,iBAAiBA,CAACrD,OAAO,EAAEqB,CAAC,EAAE;EACrC,MAAMkB,OAAO,GAAGxC,eAAe,CAACC,OAAO,CAAC;EACxC,MAAMyD,QAAQ,GAAGlB,OAAO,CAACjB,OAAO,CAACmC,QAAQ,IAAI,OAAO;EAEpD,MAAM;IAAEC,KAAK,EAAEjB,MAAM;IAAEkB;EAAM,CAAC,GAAGrE,yBAAyB,CAACmE,QAAQ,CAAC,CAACd,QAAQ,CAC3E3C,OAAO,CAACiD,OAAO,EACf;IACEiB,UAAU,EAAE;EACd,CACF,CAAC;EAED,IAAIP,KAAK,EAAE;IACT,MAAMnB,KAAK,GAAG/C,eAAe,CAAC8C,OAAO,EAAEE,MAAM,EAAEkB,KAAK,CAAC;IAErD,OAAOtC,CAAC,CAACqB,IAAI,CAAC5C,QAAQ,EAAE0C,KAAK,CAAC;EAChC;EAEA,MAAM;IAAElC,aAAa;IAAE2D;EAAU,CAAC,GAAG1B,OAAO,CAACjB,OAAO;EACpDjB,mBAAmB,CAACL,OAAO,EAAEM,aAAa,EAAEmC,MAAM,CAAC;;EAEnD;EACA,OAAOpB,CAAC,CAACQ,QAAQ,CAACoC,SAAS,CAAC,CAACnC,IAAI,CAAC7C,WAAW,CAAC8C,SAAS,CAAC;AAC1D;;AAEA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":["Boom","StatusCodes","Joi","EXTERNAL_STATE_APPENDAGE","getCachedPluginTranslator","JOURNEY_BASE_URL","createDetailsPayloadSchema","createManualPayloadSchema","createSelectPayloadSchema","detailsViewModel","manualViewModel","selectViewModel","stepSchema","steps","service","resolveLanguage","viewName","getSessionState","request","state","yar","get","badRequest","flashComponentState","componentName","address","addressState","addressLine1","addressLine2","town","county","postcode","uprn","undefined","appendage","component","data","flash","getDispatchTranslator","initial","language","formId","formStatus","set","typedReq","lang","translator","id","dispatch","h","details","postcodeQuery","buildingNameQuery","query","step","redirect","code","SEE_OTHER","getRoutes","options","getRoute","postRoute","method","path","handler","session","model","manual","view","validate","object","keys","string","allow","optional","payload","detailsPostHandler","select","selectPostHandler","manualPostHandler","unknown","ordnanceSurveyApiKey","apiKey","value","error","addresses","searchByUPRN","property","at","internal","sourceUrl","abortEarly"],"sources":["../../../../../src/server/plugins/postcode-lookup/routes/index.js"],"sourcesContent":["import Boom from '@hapi/boom'\nimport { StatusCodes } from 'http-status-codes'\nimport Joi from 'joi'\n\nimport { EXTERNAL_STATE_APPENDAGE } from '~/src/server/constants.js'\nimport { getCachedPluginTranslator } from '~/src/server/plugins/engine/i18n/form.js'\nimport {\n  JOURNEY_BASE_URL,\n  createDetailsPayloadSchema,\n  createManualPayloadSchema,\n  createSelectPayloadSchema,\n  detailsViewModel,\n  manualViewModel,\n  selectViewModel,\n  stepSchema,\n  steps\n} from '~/src/server/plugins/postcode-lookup/models/index.js'\nimport * as service from '~/src/server/plugins/postcode-lookup/service.js'\nimport { resolveLanguage } from '~/src/server/utils/utils.js'\n\nconst viewName = 'postcode-lookup-details'\n\n/**\n * Get the session state associated with this journey\n * @param {PostcodeLookupRequest} request\n */\nexport function getSessionState(request) {\n  /**\n   * @type {PostcodeLookupSessionData | null | undefined}\n   */\n  const state = request.yar.get(JOURNEY_BASE_URL)\n\n  if (!state) {\n    throw Boom.badRequest(\n      `No postcode lookup data found for ${JOURNEY_BASE_URL}`\n    )\n  }\n\n  return state\n}\n\n/**\n * Flash form component state\n * @param {PostcodeLookupRequest} request - the request\n * @param {string} componentName - the component name\n * @param {Address | PostcodeLookupManualPayload} address - the address from ordnance survey or manually entered\n */\nfunction flashComponentState(request, componentName, address) {\n  const addressState = {\n    addressLine1: address.addressLine1,\n    addressLine2: address.addressLine2,\n    town: address.town,\n    county: address.county,\n    postcode: address.postcode,\n    uprn: 'uprn' in address && address.uprn ? address.uprn : undefined\n  }\n\n  /**\n   * @type {ExternalStateAppendage}\n   */\n  const appendage = {\n    component: componentName,\n    data: addressState\n  }\n\n  request.yar.flash(EXTERNAL_STATE_APPENDAGE, appendage, true)\n}\n/**\n * Get a cached translator, or create a new one if not in the cache\n * @param {PostcodeLookupRequest} request\n * @param {PostcodeLookupDispatchData} initial\n * @param { string | string[] | undefined } language\n */\nexport async function getDispatchTranslator(request, initial, language) {\n  const { formId, formStatus } = initial\n\n  // Override language if passed as a query param\n  if (language) {\n    request.yar.set('language', language)\n  }\n\n  const typedReq = /** @type {AnyFormRequest} */ (/** @type {any} */ (request))\n  const lang = resolveLanguage(typedReq)\n\n  const translator = await getCachedPluginTranslator(\n    typedReq,\n    /** @type {FormMetadata} */ ({ id: formId }),\n    formStatus,\n    lang\n  )\n\n  return translator\n}\n\n/**\n * Initialises and dispatches the request to the postcode lookup journey\n * @param {FormRequestPayload} request - the source page\n * @param {FormResponseToolkit} h - the source page\n * @param {PostcodeLookupDispatchData} initial - the source data\n */\nexport function dispatch(request, h, initial) {\n  /**\n   * @type {PostcodeLookupSessionData}\n   */\n  const data = {\n    initial,\n    details: { postcodeQuery: '', buildingNameQuery: '' }\n  }\n\n  request.yar.set(JOURNEY_BASE_URL, data)\n\n  const query = initial.step ? `?step=${initial.step}` : ''\n\n  return h.redirect(`${JOURNEY_BASE_URL}${query}`).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * Gets the postcode lookup routes\n * @param {PostcodeLookupConfiguration} options - ordnance survey api key\n */\nexport function getRoutes(options) {\n  return [getRoute(), postRoute(options)]\n}\n\n/**\n * @returns {ServerRoute<PostcodeLookupGetRequestRefs>}\n */\nfunction getRoute() {\n  return {\n    method: 'GET',\n    path: JOURNEY_BASE_URL,\n    async handler(request, h) {\n      const { query } = request\n      const { step, language } = query\n      const session = getSessionState(request)\n\n      const translator = await getDispatchTranslator(\n        request,\n        session.initial,\n        language\n      )\n\n      const model =\n        step === steps.manual\n          ? manualViewModel(session, translator)\n          : detailsViewModel(session, translator)\n\n      return h.view(viewName, model)\n    },\n    options: {\n      validate: {\n        query: Joi.object()\n          .keys({\n            step: Joi.string().allow(steps.details, steps.manual).optional(),\n            language: Joi.string().allow('en-GB', 'cy').optional()\n          })\n          .optional()\n      }\n    }\n  }\n}\n\n/**\n * @param {PostcodeLookupConfiguration} options\n * @returns {ServerRoute<PostcodeLookupPostRequestRefs>}\n */\nfunction postRoute(options) {\n  return {\n    method: 'POST',\n    path: JOURNEY_BASE_URL,\n    async handler(request, h) {\n      const { payload } = request\n      const { step } = payload\n\n      switch (step) {\n        case steps.details: {\n          return detailsPostHandler(request, h, options)\n        }\n        case steps.select: {\n          return selectPostHandler(request, h, options)\n        }\n        case steps.manual: {\n          return manualPostHandler(request, h)\n        }\n        default:\n          throw Boom.badRequest(`Invalid step ${step}`)\n      }\n    },\n    options: {\n      validate: {\n        payload: Joi.object()\n          .keys({\n            step: stepSchema\n          })\n          .unknown(true)\n      }\n    }\n  }\n}\n\n/**\n * Post handler for the details step\n * @param {PostcodeLookupPostRequest} request\n * @param {ResponseToolkit<PostcodeLookupPostRequestRefs>} h\n * @param {PostcodeLookupConfiguration} options\n */\nasync function detailsPostHandler(request, h, options) {\n  const session = getSessionState(request)\n  const { ordnanceSurveyApiKey: apiKey } = options\n  const translator = await getDispatchTranslator(\n    request,\n    session.initial,\n    request.query.language\n  )\n  const language = translator.language\n\n  const { value: details, error } = createDetailsPayloadSchema(\n    language\n  ).validate(request.payload)\n\n  let model\n\n  if (error) {\n    model = detailsViewModel(session, translator, details, error)\n\n    return h.view(viewName, model)\n  }\n\n  const { postcodeQuery, buildingNameQuery } = details\n  session.details = { postcodeQuery, buildingNameQuery }\n\n  // Store the updated session\n  request.yar.set(JOURNEY_BASE_URL, session)\n\n  model = await selectViewModel({ session, apiKey }, translator)\n\n  return h.view(viewName, model)\n}\n\n/**\n * Post handler for the select step\n * @param {PostcodeLookupPostRequest} request\n * @param {ResponseToolkit<PostcodeLookupPostRequestRefs>} h\n * @param {PostcodeLookupConfiguration} options\n */\nasync function selectPostHandler(request, h, options) {\n  const session = getSessionState(request)\n  const { ordnanceSurveyApiKey: apiKey } = options\n  const translator = await getDispatchTranslator(\n    request,\n    session.initial,\n    request.query.language\n  )\n  const language = translator.language\n  const { value: select, error } = createSelectPayloadSchema(language).validate(\n    request.payload\n  )\n\n  if (error) {\n    const model = await selectViewModel(\n      { session, apiKey },\n      translator,\n      select,\n      error\n    )\n\n    return h.view(viewName, model)\n  }\n\n  const addresses = await service.searchByUPRN(select.uprn, apiKey)\n  const property = addresses.at(0)\n\n  if (!property) {\n    throw Boom.internal(`UPRN ${property} not found`)\n  }\n\n  const { componentName, sourceUrl } = session.initial\n  flashComponentState(request, componentName, property)\n\n  // Redirect back to the source form page\n  return h.redirect(sourceUrl).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * Post handler for the manual step\n * @param {PostcodeLookupPostRequest} request\n * @param {ResponseToolkit<PostcodeLookupPostRequestRefs>} h\n */\nasync function manualPostHandler(request, h) {\n  const session = getSessionState(request)\n  const translator = await getDispatchTranslator(\n    request,\n    session.initial,\n    request.query.language\n  )\n  const language = translator.language\n\n  const { value: manual, error } = createManualPayloadSchema(language).validate(\n    request.payload,\n    {\n      abortEarly: false\n    }\n  )\n\n  if (error) {\n    const model = manualViewModel(session, translator, manual, error)\n\n    return h.view(viewName, model)\n  }\n\n  const { componentName, sourceUrl } = session.initial\n  flashComponentState(request, componentName, manual)\n\n  // Redirect back to the source form page\n  return h.redirect(sourceUrl).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * @import { ResponseToolkit, ServerRoute } from '@hapi/hapi'\n * @import { FormMetadata } from '@defra/forms-model'\n * @import { PostcodeLookupManualPayload, Address, PostcodeLookupGetRequestRefs, PostcodeLookupPostRequestRefs, PostcodeLookupRequest, PostcodeLookupPostRequest, PostcodeLookupConfiguration, PostcodeLookupDispatchData, PostcodeLookupSessionData } from '~/src/server/plugins/postcode-lookup/types.js'\n * @import { FormRequestPayload, FormResponseToolkit } from '~/src/server/routes/types.js'\n * @import { AnyFormRequest, ExternalStateAppendage } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAC7B,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,wBAAwB;AACjC,SAASC,yBAAyB;AAClC,SACEC,gBAAgB,EAChBC,0BAA0B,EAC1BC,yBAAyB,EACzBC,yBAAyB,EACzBC,gBAAgB,EAChBC,eAAe,EACfC,eAAe,EACfC,UAAU,EACVC,KAAK;AAEP,OAAO,KAAKC,OAAO;AACnB,SAASC,eAAe;AAExB,MAAMC,QAAQ,GAAG,yBAAyB;;AAE1C;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACC,OAAO,EAAE;EACvC;AACF;AACA;EACE,MAAMC,KAAK,GAAGD,OAAO,CAACE,GAAG,CAACC,GAAG,CAAChB,gBAAgB,CAAC;EAE/C,IAAI,CAACc,KAAK,EAAE;IACV,MAAMnB,IAAI,CAACsB,UAAU,CACnB,qCAAqCjB,gBAAgB,EACvD,CAAC;EACH;EAEA,OAAOc,KAAK;AACd;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASI,mBAAmBA,CAACL,OAAO,EAAEM,aAAa,EAAEC,OAAO,EAAE;EAC5D,MAAMC,YAAY,GAAG;IACnBC,YAAY,EAAEF,OAAO,CAACE,YAAY;IAClCC,YAAY,EAAEH,OAAO,CAACG,YAAY;IAClCC,IAAI,EAAEJ,OAAO,CAACI,IAAI;IAClBC,MAAM,EAAEL,OAAO,CAACK,MAAM;IACtBC,QAAQ,EAAEN,OAAO,CAACM,QAAQ;IAC1BC,IAAI,EAAE,MAAM,IAAIP,OAAO,IAAIA,OAAO,CAACO,IAAI,GAAGP,OAAO,CAACO,IAAI,GAAGC;EAC3D,CAAC;;EAED;AACF;AACA;EACE,MAAMC,SAAS,GAAG;IAChBC,SAAS,EAAEX,aAAa;IACxBY,IAAI,EAAEV;EACR,CAAC;EAEDR,OAAO,CAACE,GAAG,CAACiB,KAAK,CAAClC,wBAAwB,EAAE+B,SAAS,EAAE,IAAI,CAAC;AAC9D;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeI,qBAAqBA,CAACpB,OAAO,EAAEqB,OAAO,EAAEC,QAAQ,EAAE;EACtE,MAAM;IAAEC,MAAM;IAAEC;EAAW,CAAC,GAAGH,OAAO;;EAEtC;EACA,IAAIC,QAAQ,EAAE;IACZtB,OAAO,CAACE,GAAG,CAACuB,GAAG,CAAC,UAAU,EAAEH,QAAQ,CAAC;EACvC;EAEA,MAAMI,QAAQ,GAAG,8BAA+B,kBAAoB1B,OAAS;EAC7E,MAAM2B,IAAI,GAAG9B,eAAe,CAAC6B,QAAQ,CAAC;EAEtC,MAAME,UAAU,GAAG,MAAM1C,yBAAyB,CAChDwC,QAAQ,EACR,2BAA6B;IAAEG,EAAE,EAAEN;EAAO,CAAC,EAC3CC,UAAU,EACVG,IACF,CAAC;EAED,OAAOC,UAAU;AACnB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,QAAQA,CAAC9B,OAAO,EAAE+B,CAAC,EAAEV,OAAO,EAAE;EAC5C;AACF;AACA;EACE,MAAMH,IAAI,GAAG;IACXG,OAAO;IACPW,OAAO,EAAE;MAAEC,aAAa,EAAE,EAAE;MAAEC,iBAAiB,EAAE;IAAG;EACtD,CAAC;EAEDlC,OAAO,CAACE,GAAG,CAACuB,GAAG,CAACtC,gBAAgB,EAAE+B,IAAI,CAAC;EAEvC,MAAMiB,KAAK,GAAGd,OAAO,CAACe,IAAI,GAAG,SAASf,OAAO,CAACe,IAAI,EAAE,GAAG,EAAE;EAEzD,OAAOL,CAAC,CAACM,QAAQ,CAAC,GAAGlD,gBAAgB,GAAGgD,KAAK,EAAE,CAAC,CAACG,IAAI,CAACvD,WAAW,CAACwD,SAAS,CAAC;AAC9E;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACC,OAAO,EAAE;EACjC,OAAO,CAACC,QAAQ,CAAC,CAAC,EAAEC,SAAS,CAACF,OAAO,CAAC,CAAC;AACzC;;AAEA;AACA;AACA;AACA,SAASC,QAAQA,CAAA,EAAG;EAClB,OAAO;IACLE,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE1D,gBAAgB;IACtB,MAAM2D,OAAOA,CAAC9C,OAAO,EAAE+B,CAAC,EAAE;MACxB,MAAM;QAAEI;MAAM,CAAC,GAAGnC,OAAO;MACzB,MAAM;QAAEoC,IAAI;QAAEd;MAAS,CAAC,GAAGa,KAAK;MAChC,MAAMY,OAAO,GAAGhD,eAAe,CAACC,OAAO,CAAC;MAExC,MAAM4B,UAAU,GAAG,MAAMR,qBAAqB,CAC5CpB,OAAO,EACP+C,OAAO,CAAC1B,OAAO,EACfC,QACF,CAAC;MAED,MAAM0B,KAAK,GACTZ,IAAI,KAAKzC,KAAK,CAACsD,MAAM,GACjBzD,eAAe,CAACuD,OAAO,EAAEnB,UAAU,CAAC,GACpCrC,gBAAgB,CAACwD,OAAO,EAAEnB,UAAU,CAAC;MAE3C,OAAOG,CAAC,CAACmB,IAAI,CAACpD,QAAQ,EAAEkD,KAAK,CAAC;IAChC,CAAC;IACDP,OAAO,EAAE;MACPU,QAAQ,EAAE;QACRhB,KAAK,EAAEnD,GAAG,CAACoE,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJjB,IAAI,EAAEpD,GAAG,CAACsE,MAAM,CAAC,CAAC,CAACC,KAAK,CAAC5D,KAAK,CAACqC,OAAO,EAAErC,KAAK,CAACsD,MAAM,CAAC,CAACO,QAAQ,CAAC,CAAC;UAChElC,QAAQ,EAAEtC,GAAG,CAACsE,MAAM,CAAC,CAAC,CAACC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAACC,QAAQ,CAAC;QACvD,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,SAASb,SAASA,CAACF,OAAO,EAAE;EAC1B,OAAO;IACLG,MAAM,EAAE,MAAM;IACdC,IAAI,EAAE1D,gBAAgB;IACtB,MAAM2D,OAAOA,CAAC9C,OAAO,EAAE+B,CAAC,EAAE;MACxB,MAAM;QAAE0B;MAAQ,CAAC,GAAGzD,OAAO;MAC3B,MAAM;QAAEoC;MAAK,CAAC,GAAGqB,OAAO;MAExB,QAAQrB,IAAI;QACV,KAAKzC,KAAK,CAACqC,OAAO;UAAE;YAClB,OAAO0B,kBAAkB,CAAC1D,OAAO,EAAE+B,CAAC,EAAEU,OAAO,CAAC;UAChD;QACA,KAAK9C,KAAK,CAACgE,MAAM;UAAE;YACjB,OAAOC,iBAAiB,CAAC5D,OAAO,EAAE+B,CAAC,EAAEU,OAAO,CAAC;UAC/C;QACA,KAAK9C,KAAK,CAACsD,MAAM;UAAE;YACjB,OAAOY,iBAAiB,CAAC7D,OAAO,EAAE+B,CAAC,CAAC;UACtC;QACA;UACE,MAAMjD,IAAI,CAACsB,UAAU,CAAC,gBAAgBgC,IAAI,EAAE,CAAC;MACjD;IACF,CAAC;IACDK,OAAO,EAAE;MACPU,QAAQ,EAAE;QACRM,OAAO,EAAEzE,GAAG,CAACoE,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;UACJjB,IAAI,EAAE1C;QACR,CAAC,CAAC,CACDoE,OAAO,CAAC,IAAI;MACjB;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,eAAeJ,kBAAkBA,CAAC1D,OAAO,EAAE+B,CAAC,EAAEU,OAAO,EAAE;EACrD,MAAMM,OAAO,GAAGhD,eAAe,CAACC,OAAO,CAAC;EACxC,MAAM;IAAE+D,oBAAoB,EAAEC;EAAO,CAAC,GAAGvB,OAAO;EAChD,MAAMb,UAAU,GAAG,MAAMR,qBAAqB,CAC5CpB,OAAO,EACP+C,OAAO,CAAC1B,OAAO,EACfrB,OAAO,CAACmC,KAAK,CAACb,QAChB,CAAC;EACD,MAAMA,QAAQ,GAAGM,UAAU,CAACN,QAAQ;EAEpC,MAAM;IAAE2C,KAAK,EAAEjC,OAAO;IAAEkC;EAAM,CAAC,GAAG9E,0BAA0B,CAC1DkC,QACF,CAAC,CAAC6B,QAAQ,CAACnD,OAAO,CAACyD,OAAO,CAAC;EAE3B,IAAIT,KAAK;EAET,IAAIkB,KAAK,EAAE;IACTlB,KAAK,GAAGzD,gBAAgB,CAACwD,OAAO,EAAEnB,UAAU,EAAEI,OAAO,EAAEkC,KAAK,CAAC;IAE7D,OAAOnC,CAAC,CAACmB,IAAI,CAACpD,QAAQ,EAAEkD,KAAK,CAAC;EAChC;EAEA,MAAM;IAAEf,aAAa;IAAEC;EAAkB,CAAC,GAAGF,OAAO;EACpDe,OAAO,CAACf,OAAO,GAAG;IAAEC,aAAa;IAAEC;EAAkB,CAAC;;EAEtD;EACAlC,OAAO,CAACE,GAAG,CAACuB,GAAG,CAACtC,gBAAgB,EAAE4D,OAAO,CAAC;EAE1CC,KAAK,GAAG,MAAMvD,eAAe,CAAC;IAAEsD,OAAO;IAAEiB;EAAO,CAAC,EAAEpC,UAAU,CAAC;EAE9D,OAAOG,CAAC,CAACmB,IAAI,CAACpD,QAAQ,EAAEkD,KAAK,CAAC;AAChC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,eAAeY,iBAAiBA,CAAC5D,OAAO,EAAE+B,CAAC,EAAEU,OAAO,EAAE;EACpD,MAAMM,OAAO,GAAGhD,eAAe,CAACC,OAAO,CAAC;EACxC,MAAM;IAAE+D,oBAAoB,EAAEC;EAAO,CAAC,GAAGvB,OAAO;EAChD,MAAMb,UAAU,GAAG,MAAMR,qBAAqB,CAC5CpB,OAAO,EACP+C,OAAO,CAAC1B,OAAO,EACfrB,OAAO,CAACmC,KAAK,CAACb,QAChB,CAAC;EACD,MAAMA,QAAQ,GAAGM,UAAU,CAACN,QAAQ;EACpC,MAAM;IAAE2C,KAAK,EAAEN,MAAM;IAAEO;EAAM,CAAC,GAAG5E,yBAAyB,CAACgC,QAAQ,CAAC,CAAC6B,QAAQ,CAC3EnD,OAAO,CAACyD,OACV,CAAC;EAED,IAAIS,KAAK,EAAE;IACT,MAAMlB,KAAK,GAAG,MAAMvD,eAAe,CACjC;MAAEsD,OAAO;MAAEiB;IAAO,CAAC,EACnBpC,UAAU,EACV+B,MAAM,EACNO,KACF,CAAC;IAED,OAAOnC,CAAC,CAACmB,IAAI,CAACpD,QAAQ,EAAEkD,KAAK,CAAC;EAChC;EAEA,MAAMmB,SAAS,GAAG,MAAMvE,OAAO,CAACwE,YAAY,CAACT,MAAM,CAAC7C,IAAI,EAAEkD,MAAM,CAAC;EACjE,MAAMK,QAAQ,GAAGF,SAAS,CAACG,EAAE,CAAC,CAAC,CAAC;EAEhC,IAAI,CAACD,QAAQ,EAAE;IACb,MAAMvF,IAAI,CAACyF,QAAQ,CAAC,QAAQF,QAAQ,YAAY,CAAC;EACnD;EAEA,MAAM;IAAE/D,aAAa;IAAEkE;EAAU,CAAC,GAAGzB,OAAO,CAAC1B,OAAO;EACpDhB,mBAAmB,CAACL,OAAO,EAAEM,aAAa,EAAE+D,QAAQ,CAAC;;EAErD;EACA,OAAOtC,CAAC,CAACM,QAAQ,CAACmC,SAAS,CAAC,CAAClC,IAAI,CAACvD,WAAW,CAACwD,SAAS,CAAC;AAC1D;;AAEA;AACA;AACA;AACA;AACA;AACA,eAAesB,iBAAiBA,CAAC7D,OAAO,EAAE+B,CAAC,EAAE;EAC3C,MAAMgB,OAAO,GAAGhD,eAAe,CAACC,OAAO,CAAC;EACxC,MAAM4B,UAAU,GAAG,MAAMR,qBAAqB,CAC5CpB,OAAO,EACP+C,OAAO,CAAC1B,OAAO,EACfrB,OAAO,CAACmC,KAAK,CAACb,QAChB,CAAC;EACD,MAAMA,QAAQ,GAAGM,UAAU,CAACN,QAAQ;EAEpC,MAAM;IAAE2C,KAAK,EAAEhB,MAAM;IAAEiB;EAAM,CAAC,GAAG7E,yBAAyB,CAACiC,QAAQ,CAAC,CAAC6B,QAAQ,CAC3EnD,OAAO,CAACyD,OAAO,EACf;IACEgB,UAAU,EAAE;EACd,CACF,CAAC;EAED,IAAIP,KAAK,EAAE;IACT,MAAMlB,KAAK,GAAGxD,eAAe,CAACuD,OAAO,EAAEnB,UAAU,EAAEqB,MAAM,EAAEiB,KAAK,CAAC;IAEjE,OAAOnC,CAAC,CAACmB,IAAI,CAACpD,QAAQ,EAAEkD,KAAK,CAAC;EAChC;EAEA,MAAM;IAAE1C,aAAa;IAAEkE;EAAU,CAAC,GAAGzB,OAAO,CAAC1B,OAAO;EACpDhB,mBAAmB,CAACL,OAAO,EAAEM,aAAa,EAAE2C,MAAM,CAAC;;EAEnD;EACA,OAAOlB,CAAC,CAACM,QAAQ,CAACmC,SAAS,CAAC,CAAClC,IAAI,CAACvD,WAAW,CAACwD,SAAS,CAAC;AAC1D;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/postcode-lookup/routes/index.test.js

@@ -0,0 +1,84 @@
+import { EN_GB } from "../../../constants.js";
+import { getCachedPluginTranslator } from "../../engine/i18n/form.js";
+import { getDispatchTranslator, getSessionState } from "./index.js";
+jest.mock("../../engine/i18n/form.ts");
+describe('postcode-lookup routes', () => {
+  describe('getSessionState', () => {
+    test('should throw if missing state', () => {
+      const mockRequest = /** @type { PostcodeLookupRequest} */
+      /** @type {any} */
+      {
+        yar: {
+          get: jest.fn()
+        }
+      };
+      expect(() => getSessionState(mockRequest)).toThrow('No postcode lookup data found for /postcode-lookup');
+    });
+  });
+  describe('getDispatchTranslator', () => {
+    test('should get default translator', async () => {
+      const mockSet = jest.fn();
+      const mockRequest = /** @type { PostcodeLookupRequest} */
+      /** @type {any} */
+      {
+        yar: {
+          get: jest.fn(),
+          set: mockSet
+        },
+        query: {},
+        server: {
+          // eslint-disable-next-line no-useless-computed-key
+          plugins: {
+            ['forms-engine-plugin']: {
+              getLanguage: () => 'en-GB'
+            }
+          }
+        }
+      };
+      const mockTranslator = /** @type {Translator} */{
+        language: EN_GB
+      };
+      jest.mocked(getCachedPluginTranslator).mockResolvedValue(mockTranslator);
+      const initial = /** @type {PostcodeLookupDispatchData} */{};
+      const res = await getDispatchTranslator(mockRequest, initial, EN_GB);
+      expect(mockSet).toHaveBeenCalledWith('language', EN_GB);
+      expect(res).toBeDefined();
+      expect(res.language).toBe(EN_GB);
+    });
+    test('should get welsh translator', async () => {
+      const mockSet = jest.fn();
+      const mockRequest = /** @type { PostcodeLookupRequest} */
+      /** @type {any} */
+      {
+        yar: {
+          get: jest.fn().mockResolvedValueOnce('cy'),
+          set: mockSet
+        },
+        query: {},
+        server: {
+          // eslint-disable-next-line no-useless-computed-key
+          plugins: {
+            ['forms-engine-plugin']: {
+              getLanguage: () => 'en-GB'
+            }
+          }
+        }
+      };
+      const mockTranslator = /** @type {Translator} */{
+        language: 'cy'
+      };
+      jest.mocked(getCachedPluginTranslator).mockResolvedValue(mockTranslator);
+      const initial = /** @type {PostcodeLookupDispatchData} */{};
+      const res = await getDispatchTranslator(mockRequest, initial, 'cy');
+      expect(mockSet).toHaveBeenCalledWith('language', 'cy');
+      expect(res).toBeDefined();
+      expect(res.language).toBe('cy');
+    });
+  });
+});
+
+/**
+ * @import { PostcodeLookupDispatchData, PostcodeLookupRequest } from '../../../../server/plugins/postcode-lookup/types.js'
+ * @import { Translator } from '../../../../server/plugins/engine/i18n/types.js'
+ */
+//# sourceMappingURL=index.test.js.map

package/.server/server/plugins/postcode-lookup/routes/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","names":["EN_GB","getCachedPluginTranslator","getDispatchTranslator","getSessionState","jest","mock","describe","test","mockRequest","yar","get","fn","expect","toThrow","mockSet","set","query","server","plugins","getLanguage","mockTranslator","language","mocked","mockResolvedValue","initial","res","toHaveBeenCalledWith","toBeDefined","toBe","mockResolvedValueOnce"],"sources":["../../../../../src/server/plugins/postcode-lookup/routes/index.test.js"],"sourcesContent":["import { EN_GB } from '~/src/server/constants.js'\nimport { getCachedPluginTranslator } from '~/src/server/plugins/engine/i18n/form.js'\nimport {\n  getDispatchTranslator,\n  getSessionState\n} from '~/src/server/plugins/postcode-lookup/routes/index.js'\n\njest.mock('~/src/server/plugins/engine/i18n/form.ts')\n\ndescribe('postcode-lookup routes', () => {\n  describe('getSessionState', () => {\n    test('should throw if missing state', () => {\n      const mockRequest = /** @type { PostcodeLookupRequest} */ (\n        /** @type {any} */\n        ({\n          yar: {\n            get: jest.fn()\n          }\n        })\n      )\n      expect(() => getSessionState(mockRequest)).toThrow(\n        'No postcode lookup data found for /postcode-lookup'\n      )\n    })\n  })\n\n  describe('getDispatchTranslator', () => {\n    test('should get default translator', async () => {\n      const mockSet = jest.fn()\n      const mockRequest = /** @type { PostcodeLookupRequest} */ (\n        /** @type {any} */\n        ({\n          yar: {\n            get: jest.fn(),\n            set: mockSet\n          },\n          query: {},\n          server: {\n            // eslint-disable-next-line no-useless-computed-key\n            plugins: { ['forms-engine-plugin']: { getLanguage: () => 'en-GB' } }\n          }\n        })\n      )\n      const mockTranslator = /** @type {Translator} */ ({ language: EN_GB })\n      jest.mocked(getCachedPluginTranslator).mockResolvedValue(mockTranslator)\n      const initial = /** @type {PostcodeLookupDispatchData} */ ({})\n      const res = await getDispatchTranslator(mockRequest, initial, EN_GB)\n      expect(mockSet).toHaveBeenCalledWith('language', EN_GB)\n      expect(res).toBeDefined()\n      expect(res.language).toBe(EN_GB)\n    })\n\n    test('should get welsh translator', async () => {\n      const mockSet = jest.fn()\n      const mockRequest = /** @type { PostcodeLookupRequest} */ (\n        /** @type {any} */\n        ({\n          yar: {\n            get: jest.fn().mockResolvedValueOnce('cy'),\n            set: mockSet\n          },\n          query: {},\n          server: {\n            // eslint-disable-next-line no-useless-computed-key\n            plugins: { ['forms-engine-plugin']: { getLanguage: () => 'en-GB' } }\n          }\n        })\n      )\n      const mockTranslator = /** @type {Translator} */ ({ language: 'cy' })\n      jest.mocked(getCachedPluginTranslator).mockResolvedValue(mockTranslator)\n      const initial = /** @type {PostcodeLookupDispatchData} */ ({})\n      const res = await getDispatchTranslator(mockRequest, initial, 'cy')\n      expect(mockSet).toHaveBeenCalledWith('language', 'cy')\n      expect(res).toBeDefined()\n      expect(res.language).toBe('cy')\n    })\n  })\n})\n\n/**\n * @import { PostcodeLookupDispatchData, PostcodeLookupRequest } from '~/src/server/plugins/postcode-lookup/types.js'\n * @import { Translator } from '~/src/server/plugins/engine/i18n/types.js'\n */\n"],"mappings":"AAAA,SAASA,KAAK;AACd,SAASC,yBAAyB;AAClC,SACEC,qBAAqB,EACrBC,eAAe;AAGjBC,IAAI,CAACC,IAAI,4BAA2C,CAAC;AAErDC,QAAQ,CAAC,wBAAwB,EAAE,MAAM;EACvCA,QAAQ,CAAC,iBAAiB,EAAE,MAAM;IAChCC,IAAI,CAAC,+BAA+B,EAAE,MAAM;MAC1C,MAAMC,WAAW,GAAG;MAClB;MACC;QACCC,GAAG,EAAE;UACHC,GAAG,EAAEN,IAAI,CAACO,EAAE,CAAC;QACf;MACF,CACD;MACDC,MAAM,CAAC,MAAMT,eAAe,CAACK,WAAW,CAAC,CAAC,CAACK,OAAO,CAChD,oDACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFP,QAAQ,CAAC,uBAAuB,EAAE,MAAM;IACtCC,IAAI,CAAC,+BAA+B,EAAE,YAAY;MAChD,MAAMO,OAAO,GAAGV,IAAI,CAACO,EAAE,CAAC,CAAC;MACzB,MAAMH,WAAW,GAAG;MAClB;MACC;QACCC,GAAG,EAAE;UACHC,GAAG,EAAEN,IAAI,CAACO,EAAE,CAAC,CAAC;UACdI,GAAG,EAAED;QACP,CAAC;QACDE,KAAK,EAAE,CAAC,CAAC;QACTC,MAAM,EAAE;UACN;UACAC,OAAO,EAAE;YAAE,CAAC,qBAAqB,GAAG;cAAEC,WAAW,EAAEA,CAAA,KAAM;YAAQ;UAAE;QACrE;MACF,CACD;MACD,MAAMC,cAAc,GAAG,yBAA2B;QAAEC,QAAQ,EAAErB;MAAM,CAAE;MACtEI,IAAI,CAACkB,MAAM,CAACrB,yBAAyB,CAAC,CAACsB,iBAAiB,CAACH,cAAc,CAAC;MACxE,MAAMI,OAAO,GAAG,yCAA2C,CAAC,CAAE;MAC9D,MAAMC,GAAG,GAAG,MAAMvB,qBAAqB,CAACM,WAAW,EAAEgB,OAAO,EAAExB,KAAK,CAAC;MACpEY,MAAM,CAACE,OAAO,CAAC,CAACY,oBAAoB,CAAC,UAAU,EAAE1B,KAAK,CAAC;MACvDY,MAAM,CAACa,GAAG,CAAC,CAACE,WAAW,CAAC,CAAC;MACzBf,MAAM,CAACa,GAAG,CAACJ,QAAQ,CAAC,CAACO,IAAI,CAAC5B,KAAK,CAAC;IAClC,CAAC,CAAC;IAEFO,IAAI,CAAC,6BAA6B,EAAE,YAAY;MAC9C,MAAMO,OAAO,GAAGV,IAAI,CAACO,EAAE,CAAC,CAAC;MACzB,MAAMH,WAAW,GAAG;MAClB;MACC;QACCC,GAAG,EAAE;UACHC,GAAG,EAAEN,IAAI,CAACO,EAAE,CAAC,CAAC,CAACkB,qBAAqB,CAAC,IAAI,CAAC;UAC1Cd,GAAG,EAAED;QACP,CAAC;QACDE,KAAK,EAAE,CAAC,CAAC;QACTC,MAAM,EAAE;UACN;UACAC,OAAO,EAAE;YAAE,CAAC,qBAAqB,GAAG;cAAEC,WAAW,EAAEA,CAAA,KAAM;YAAQ;UAAE;QACrE;MACF,CACD;MACD,MAAMC,cAAc,GAAG,yBAA2B;QAAEC,QAAQ,EAAE;MAAK,CAAE;MACrEjB,IAAI,CAACkB,MAAM,CAACrB,yBAAyB,CAAC,CAACsB,iBAAiB,CAACH,cAAc,CAAC;MACxE,MAAMI,OAAO,GAAG,yCAA2C,CAAC,CAAE;MAC9D,MAAMC,GAAG,GAAG,MAAMvB,qBAAqB,CAACM,WAAW,EAAEgB,OAAO,EAAE,IAAI,CAAC;MACnEZ,MAAM,CAACE,OAAO,CAAC,CAACY,oBAAoB,CAAC,UAAU,EAAE,IAAI,CAAC;MACtDd,MAAM,CAACa,GAAG,CAAC,CAACE,WAAW,CAAC,CAAC;MACzBf,MAAM,CAACa,GAAG,CAACJ,QAAQ,CAAC,CAACO,IAAI,CAAC,IAAI,CAAC;IACjC,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/postcode-lookup/types.d.ts

@@ -7,12 +7,19 @@ export type PostcodeLookupDispatchArgs = {
 };
 export type PostcodeLookupDispatchData = {
     sourceUrl: string;
+    formId: string;
     formName: string;
+    formStatus: FormStatus;
+    componentId: string;
     componentName: string;
     componentTitle: string;
     componentHint?: string;
     step?: string;
     language?: string;
+    languages?: {
+        name: string;
+        code: string;
+    }[];
 };
 export type PostcodeLookupSessionData = {
     initial: PostcodeLookupDispatchData;
@@ -39,6 +46,10 @@ export type PostcodeLookupQuery = {
      * - step
      */
     step?: string | undefined;
+    /**
+     * - language
+     */
+    language?: string | undefined;
 };
 export type PostcodeLookupDetailsPayloadProperties = {
     /**
@@ -202,4 +213,5 @@ export type DeliveryPointAddressResult = {
      */
     results?: DeliveryPointAddressItem[] | undefined;
 };
+import type { FormStatus } from '@defra/forms-model';
 import type { Request } from '@hapi/hapi';

package/.server/server/plugins/postcode-lookup/types.js

@@ -14,12 +14,16 @@
 /**
  * @typedef {{
  *   sourceUrl: string,
+ *   formId: string
  *   formName: string
+ *   formStatus: FormStatus
+ *   componentId: string
  *   componentName: string
  *   componentTitle: string,
  *   componentHint?: string
  *   step?: string
  *   language?: string
+ *   languages?: { name: string, code: string}[]
  * }} PostcodeLookupDispatchData
  */
 
@@ -49,6 +53,7 @@
  * Postcode lookup query params
  * @typedef {object} PostcodeLookupQuery
  * @property {string} [step] - step
+ * @property {string} [language] - language
  */
 
 /**
@@ -140,6 +145,6 @@
 
 /**
  * @import { Request } from '@hapi/hapi'
- * @import { FormPayload } from '../../../server/plugins/engine/types.js'
+ * @import { FormStatus } from '@defra/forms-model'
  */
 //# sourceMappingURL=types.js.map

package/.server/server/plugins/postcode-lookup/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../src/server/plugins/postcode-lookup/types.js"],"sourcesContent":["/**\n * @typedef {{\n *   ordnanceSurveyApiKey: string\n * }} PostcodeLookupConfiguration\n */\n\n/**\n * @typedef {{\n *   name: string\n *   step?: string\n * }} PostcodeLookupDispatchArgs\n */\n\n/**\n * @typedef {{\n *   sourceUrl: string,\n *   formName: string\n *   componentName: string\n *   componentTitle: string,\n *   componentHint?: string\n *   step?: string\n *   language?: string\n * }} PostcodeLookupDispatchData\n */\n\n/**\n * @typedef {{\n *   initial: PostcodeLookupDispatchData\n *   details: PostcodeLookupDetailsData\n * }} PostcodeLookupSessionData\n */\n\n//\n// Model types\n//\n\n/**\n * The postcode lookup details form view model data\n * @typedef {object} PostcodeLookupDetailsData\n * @property {string} postcodeQuery - postcode query\n * @property {string} buildingNameQuery - Building name or number query\n */\n\n//\n// Route types\n//\n\n/**\n * Postcode lookup query params\n * @typedef {object} PostcodeLookupQuery\n * @property {string} [step] - step\n */\n\n/**\n * @typedef {object} PostcodeLookupDetailsPayloadProperties\n * @property {string} step - step\n */\n\n/**\n * @typedef {PostcodeLookupDetailsData & PostcodeLookupDetailsPayloadProperties} PostcodeLookupDetailsPayload\n */\n\n/**\n * @typedef {object} PostcodeLookupSelectPayload\n * @property {string} step - step\n * @property {string} uprn - postcode\n */\n\n/**\n * Postcode lookup get request\n * @typedef {object} PostcodeLookupGetRequestRefs\n * @property {PostcodeLookupQuery} Query - Request query\n */\n\n/**\n * Postcode lookup post request\n * @typedef {object} PostcodeLookupPostRequestRefs\n * @property {PostcodeLookupDetailsPayload | PostcodeLookupSelectPayload} Payload - Request payload\n */\n\n/**\n * @typedef {PostcodeLookupGetRequestRefs | PostcodeLookupPostRequestRefs} PostcodeLookupRequestRefs\n * @typedef {Request<PostcodeLookupGetRequestRefs>} PostcodeLookupGetRequest\n * @typedef {Request<PostcodeLookupPostRequestRefs>} PostcodeLookupPostRequest\n * @typedef {PostcodeLookupGetRequest | PostcodeLookupPostRequest} PostcodeLookupRequest\n */\n\n/**\n * @typedef {object} PostcodeLookupManualPayload\n * @property {string} addressLine1 - The address line 1\n * @property {string} addressLine2 - The address line 2\n * @property {string} town - The address town or city\n * @property {string} county - The address county\n * @property {string} postcode - The address postcode\n */\n\n//\n// Service types\n//\n\n/**\n * @typedef {object} Address\n * @property {string} uprn - The unique property reference\n * @property {string} address - The full address\n * @property {string} addressLine1 - Address line 1\n * @property {string} addressLine2 - Address line 2\n * @property {string} town - Address town\n * @property {string} county - Address county\n * @property {string} postcode - Address postcode\n * @property {string} formatted - The full formatted address\n */\n\n/**\n * OS places address response\n * @typedef {object} DeliveryPointAddress\n * @property {string} UPRN - Unique property reference number\n * @property {string} UDPRN - Unique delivery point Reference Number\n * @property {string} ADDRESS - Address\n * @property {string} ORGANISATION_NAME - Organisation name\n * @property {string} SUB_BUILDING_NAME - Sub building name\n * @property {string} BUILDING_NAME - Building name\n * @property {string} BUILDING_NUMBER - Building number\n * @property {string} THOROUGHFARE_NAME - Throughfare name\n * @property {string} DEPENDENT_LOCALITY - Dependent locality\n * @property {string} POST_TOWN - Post town\n * @property {string} POSTCODE - Postcode\n */\n\n/**\n * OS places DPA response\n * @typedef {object} DeliveryPointAddressItem\n * @property {DeliveryPointAddress} DPA - Delivery point address\n */\n\n/**\n * OS places DPA response\n * @typedef {object} DeliveryPointAddressResult\n * @property {DeliveryPointAddressItem[]} [results] - Delivery point address results\n */\n\n/**\n * @import { Request } from '@hapi/hapi'\n * @import { FormPayload } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/server/plugins/postcode-lookup/types.js"],"sourcesContent":["/**\n * @typedef {{\n *   ordnanceSurveyApiKey: string\n * }} PostcodeLookupConfiguration\n */\n\n/**\n * @typedef {{\n *   name: string\n *   step?: string\n * }} PostcodeLookupDispatchArgs\n */\n\n/**\n * @typedef {{\n *   sourceUrl: string,\n *   formId: string\n *   formName: string\n *   formStatus: FormStatus\n *   componentId: string\n *   componentName: string\n *   componentTitle: string,\n *   componentHint?: string\n *   step?: string\n *   language?: string\n *   languages?: { name: string, code: string}[]\n * }} PostcodeLookupDispatchData\n */\n\n/**\n * @typedef {{\n *   initial: PostcodeLookupDispatchData\n *   details: PostcodeLookupDetailsData\n * }} PostcodeLookupSessionData\n */\n\n//\n// Model types\n//\n\n/**\n * The postcode lookup details form view model data\n * @typedef {object} PostcodeLookupDetailsData\n * @property {string} postcodeQuery - postcode query\n * @property {string} buildingNameQuery - Building name or number query\n */\n\n//\n// Route types\n//\n\n/**\n * Postcode lookup query params\n * @typedef {object} PostcodeLookupQuery\n * @property {string} [step] - step\n * @property {string} [language] - language\n */\n\n/**\n * @typedef {object} PostcodeLookupDetailsPayloadProperties\n * @property {string} step - step\n */\n\n/**\n * @typedef {PostcodeLookupDetailsData & PostcodeLookupDetailsPayloadProperties} PostcodeLookupDetailsPayload\n */\n\n/**\n * @typedef {object} PostcodeLookupSelectPayload\n * @property {string} step - step\n * @property {string} uprn - postcode\n */\n\n/**\n * Postcode lookup get request\n * @typedef {object} PostcodeLookupGetRequestRefs\n * @property {PostcodeLookupQuery} Query - Request query\n */\n\n/**\n * Postcode lookup post request\n * @typedef {object} PostcodeLookupPostRequestRefs\n * @property {PostcodeLookupDetailsPayload | PostcodeLookupSelectPayload} Payload - Request payload\n */\n\n/**\n * @typedef {PostcodeLookupGetRequestRefs | PostcodeLookupPostRequestRefs} PostcodeLookupRequestRefs\n * @typedef {Request<PostcodeLookupGetRequestRefs>} PostcodeLookupGetRequest\n * @typedef {Request<PostcodeLookupPostRequestRefs>} PostcodeLookupPostRequest\n * @typedef {PostcodeLookupGetRequest | PostcodeLookupPostRequest} PostcodeLookupRequest\n */\n\n/**\n * @typedef {object} PostcodeLookupManualPayload\n * @property {string} addressLine1 - The address line 1\n * @property {string} addressLine2 - The address line 2\n * @property {string} town - The address town or city\n * @property {string} county - The address county\n * @property {string} postcode - The address postcode\n */\n\n//\n// Service types\n//\n\n/**\n * @typedef {object} Address\n * @property {string} uprn - The unique property reference\n * @property {string} address - The full address\n * @property {string} addressLine1 - Address line 1\n * @property {string} addressLine2 - Address line 2\n * @property {string} town - Address town\n * @property {string} county - Address county\n * @property {string} postcode - Address postcode\n * @property {string} formatted - The full formatted address\n */\n\n/**\n * OS places address response\n * @typedef {object} DeliveryPointAddress\n * @property {string} UPRN - Unique property reference number\n * @property {string} UDPRN - Unique delivery point Reference Number\n * @property {string} ADDRESS - Address\n * @property {string} ORGANISATION_NAME - Organisation name\n * @property {string} SUB_BUILDING_NAME - Sub building name\n * @property {string} BUILDING_NAME - Building name\n * @property {string} BUILDING_NUMBER - Building number\n * @property {string} THOROUGHFARE_NAME - Throughfare name\n * @property {string} DEPENDENT_LOCALITY - Dependent locality\n * @property {string} POST_TOWN - Post town\n * @property {string} POSTCODE - Postcode\n */\n\n/**\n * OS places DPA response\n * @typedef {object} DeliveryPointAddressItem\n * @property {DeliveryPointAddress} DPA - Delivery point address\n */\n\n/**\n * OS places DPA response\n * @typedef {object} DeliveryPointAddressResult\n * @property {DeliveryPointAddressItem[]} [results] - Delivery point address results\n */\n\n/**\n * @import { Request } from '@hapi/hapi'\n * @import { FormStatus } from '@defra/forms-model'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/postcode-lookup/views/postcode-lookup-details.html

@@ -33,7 +33,7 @@
             <!-- Postcode lookup select -->
             <!-- Postcode lookup details display -->
             {%- set detailsHtml -%}
-              <strong>{{ details.postcodeQuery }}</strong>{% if details.buildingNameQuery %} and <strong>{{ details.buildingNameQuery }}</strong>{% endif %}
+              <strong>{{ details.postcodeQuery }}</strong>{% if details.buildingNameQuery %} {{ t('common.or')}} <strong>{{ details.buildingNameQuery }}</strong>{% endif %}
             {%- endset -%}
 
             {% if hasAddresses %}
@@ -72,9 +72,9 @@
           {{ govukButton(buttons.continueButton) }}
 
           {% if buttons.manualLink %}
-            <p class="govuk-body">or <a class="govuk-link govuk-link--no-visited-state" href="{{ buttons.manualLink.href }}">{{buttons.manualLink.text}}</a></p>
+            <p class="govuk-body">{{ t('common.or')}} <a class="govuk-link govuk-link--no-visited-state" href="{{ buttons.manualLink.href }}">{{buttons.manualLink.text}}</a></p>
           {% elif buttons.detailsLink %}
-            <p class="govuk-body">or <a class="govuk-link govuk-link--no-visited-state" href="{{ buttons.detailsLink.href }}">{{buttons.detailsLink.text}}</a></p>
+            <p class="govuk-body">{{ t('common.or')}} <a class="govuk-link govuk-link--no-visited-state" href="{{ buttons.detailsLink.href }}">{{buttons.detailsLink.text}}</a></p>
           {% endif %}
         </div>
       </form>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "5.0.0-alpha.7",
+  "version": "5.0.0-alpha.9",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -19,6 +19,11 @@
       "import": "./.server/server/plugins/engine/types/index.js",
       "default": "./.server/server/plugins/engine/types/index.js"
     },
+    "./maps": {
+      "sass": "./.server/client/stylesheets/maps.scss",
+      "import": "./.server/client/javascripts/maps.js",
+      "default": "./.server/client/javascripts/maps.js"
+    },
     "./shared.js": "./.server/client/javascripts/shared.js",
     "./shared.min.js": "./.public/javascripts/shared.min.js",
     "./shared.min.js.map": "./.public/javascripts/shared.min.js.map",
@@ -131,6 +136,7 @@
     "joi": "^17.13.3",
     "liquidjs": "^10.24.0",
     "lodash": "^4.17.21",
+    "lru-cache": "^11.5.1",
     "maplibre-gl": "^5.24.0",
     "marked": "^15.0.12",
     "nunjucks": "^3.2.4",

package/src/client/javascripts/maps.js

@@ -0,0 +1,5 @@
+export { initMaps } from './map.js'
+export * as map from './map.js'
+export * as locationMap from './location-map.js'
+export * as geospatialMap from './geospatial-map.js'
+export * as sssiDataset from './sssi-dataset.js'

package/src/client/javascripts/shared.js

@@ -3,10 +3,7 @@ import { initDebounceClick as initDebounceClickImp } from './debounce-click.js'
 import { initFileUpload as initFileUploadImp } from './file-upload.js'
 import { initAllGovuk as initAllGovukImp } from './govuk.js'
 import { initPreviewCloseLink as initPreviewCloseLinkImp } from './preview-close-link.js'
-export { initMaps } from './map.js'
-export * as map from './map.js'
-export * as geospatialMap from './geospatial-map.js'
-export * as sssiDataset from './sssi-dataset.js'
+export * from './maps.js'
 
 export const initAllGovuk = initAllGovukImp
 export const initAllAutocomplete = initAllAutocompleteImp

package/src/client/stylesheets/maps.scss

@@ -0,0 +1,4 @@
+@use "@defra/interactive-map/css" as core;
+@use "@defra/interactive-map/plugins/map-styles/css" as mapStyles;
+@use "@defra/interactive-map/plugins/search/css" as search;
+@use "@defra/interactive-map/plugins/scale-bar/css" as scaleBar;

package/src/client/stylesheets/shared.scss

@@ -3,11 +3,7 @@
 @use "prose";
 @use "summary-list";
 @use "location-fields";
-
-@use "@defra/interactive-map/css" as core;
-@use "@defra/interactive-map/plugins/map-styles/css" as mapStyles;
-@use "@defra/interactive-map/plugins/search/css" as search;
-@use "@defra/interactive-map/plugins/scale-bar/css" as scaleBar;
+@use "maps";
 
 // Use default GDS Transport font for autocomplete
 .autocomplete__hint,

package/src/server/constants.js

@@ -5,4 +5,5 @@ export const EXTERNAL_STATE_PAYLOAD = 'EXTERNAL_STATE_PAYLOAD'
 export const EXTERNAL_STATE_APPENDAGE = 'EXTERNAL_STATE_APPENDAGE'
 export const COMPONENT_STATE_ERROR = 'COMPONENT_STATE_ERROR'
 export const PAYMENT_EXPIRED_NOTIFICATION = 'PAYMENT_EXPIRED_NOTIFICATION'
-export const EN_GB = 'en-GB'
+export const EN_GB = 'en-GB' // English language
+export const CY = 'cy' // Welsh language

package/src/server/plugins/engine/components/ComponentCollection.ts

@@ -15,6 +15,7 @@ import {
   type Field,
   type Guidance
 } from './helpers/components.js'
+import { getTranslatedLabel } from './helpers/index.js'
 import {
   type ComponentViewModel,
   type RenderContext
@@ -302,25 +303,28 @@ export class ComponentCollection {
           for (const subField of field.collection.fields) {
             const translatedSubLabel = t(subField.title) || subField.label
             let patchedSchema = subField.formSchema.label(translatedSubLabel)
-            if (messagesOverride) {
-              patchedSchema = patchedSchema.messages(messagesOverride)
+            const subFieldMessages = messagesOverride
+              ? messagesOverride[subField.name]
+              : undefined
+            if (subFieldMessages) {
+              patchedSchema = patchedSchema.messages(subFieldMessages)
             }
             labelOverrides[subField.name] = patchedSchema
           }
         } else {
           const fieldDef = field.def
-          const translatedLabel =
-            translator.tComponent(fieldDef, 'errorDescription') ||
-            translator.tComponent(fieldDef, 'shortDescription') ||
-            translator.tComponent(fieldDef, 'title')
+          const translatedLabel = getTranslatedLabel(fieldDef, translator)
           const messagesOverride =
             field.getValidationMessagesOverride(translator)
           let patchedSchema = field.formSchema
           if (translatedLabel && translatedLabel !== field.label) {
             patchedSchema = patchedSchema.label(translatedLabel)
           }
-          if (messagesOverride) {
-            patchedSchema = patchedSchema.messages(messagesOverride)
+          const fieldMessages = messagesOverride
+            ? messagesOverride[field.name]
+            : undefined
+          if (fieldMessages) {
+            patchedSchema = patchedSchema.messages(fieldMessages)
           }
           if (patchedSchema !== field.formSchema) {
             labelOverrides[field.name] = patchedSchema
@@ -339,10 +343,12 @@ export class ComponentCollection {
     })
 
     const details = result.error?.details
+    const language = translator?.language
 
     return {
       value: (result.value ?? {}) as typeof value,
-      errors: this.page?.getErrors(details) ?? getErrors(details)
+      errors:
+        this.page?.getErrors(details, language) ?? getErrors(language, details)
     }
   }
 

package/src/server/plugins/engine/components/DatePartsField.ts

@@ -25,6 +25,7 @@ import {
   type FormStateValue,
   type FormSubmissionState
 } from '../types.js'
+import { formatDateForLanguage } from '../../payment/helper.js'
 import { convertToLanguageMessages } from '../../../utils/type-utils.js'
 
 export class DatePartsField extends FormComponent {
@@ -111,15 +112,16 @@ export class DatePartsField extends FormComponent {
 
   getDisplayStringFromFormValue(
     formValue: DatePartsState | undefined,
-    _translator: Translator
+    translator: Translator
   ) {
     if (!formValue) {
       return ''
     }
 
-    return format(
+    return formatDateForLanguage(
       `${formValue.year}-${formValue.month}-${formValue.day}`,
-      'd MMMM yyyy'
+      'd MMMM yyyy',
+      translator.language
     )
   }
 
@@ -158,15 +160,17 @@ export class DatePartsField extends FormComponent {
 
   getValidationMessagesOverride(translator: Translator) {
     const { t } = translator
-    return convertToLanguageMessages({
-      'any.required': buildValidationMessages(t).objectMissing,
-      'number.base': buildValidationMessages(t).objectMissing,
-      'number.precision': buildValidationMessages(t).dateFormat,
-      'number.integer': buildValidationMessages(t).dateFormat,
-      'number.unsafe': buildValidationMessages(t).dateFormat,
-      'number.min': buildValidationMessages(t).dateFormat,
-      'number.max': buildValidationMessages(t).dateFormat
-    })
+    return {
+      [this.name]: convertToLanguageMessages({
+        'any.required': buildValidationMessages(t).objectMissing,
+        'number.base': buildValidationMessages(t).objectMissing,
+        'number.precision': buildValidationMessages(t).dateFormat,
+        'number.integer': buildValidationMessages(t).dateFormat,
+        'number.unsafe': buildValidationMessages(t).dateFormat,
+        'number.min': buildValidationMessages(t).dateFormat,
+        'number.max': buildValidationMessages(t).dateFormat
+      })
+    }
   }
 
   getViewModel(context: RenderContext) {

package/src/server/plugins/engine/components/DeclarationField.ts

@@ -120,10 +120,12 @@ export class DeclarationField extends FormComponent {
     const { declarationRequired } = buildValidationMessages(translator.t)
     const msg = declarationRequired as unknown as string
     return {
-      'any.required': msg,
-      'any.unknown': msg,
-      'array.includesRequiredUnknowns': msg
-    } as unknown as LanguageMessages
+      [this.name]: {
+        'any.required': msg,
+        'any.unknown': msg,
+        'array.includesRequiredUnknowns': msg
+      } as unknown as LanguageMessages
+    }
   }
 
   getDisplayStringFromFormValue(