@defra/forms-engine-plugin 4.14.3 → 4.15.0

package/.server/server/plugins/engine/components/helpers/telephone.d.ts

@@ -1,10 +1,6 @@
-import { TelephoneNumberFieldOptionsFormatEnum } from '@defra/forms-model';
 import LibPhoneNumber from 'google-libphonenumber';
 import JoiBase from 'joi';
 export declare const COUNTRY = "GB";
 export declare const INVALID_ERROR_CODE = "phoneNumber.invalid";
-export declare const UK_ERROR_CODE = "phoneNumber.uk";
-export declare const INTERNATIONAL_ERROR_CODE = "phoneNumber.international";
 export declare const isUKNumber: (value: LibPhoneNumber.PhoneNumber) => boolean;
-export declare function getErrorCode(format?: TelephoneNumberFieldOptionsFormatEnum): "phoneNumber.invalid" | "phoneNumber.uk" | "phoneNumber.international";
 export declare const joi: JoiBase.Root;

package/.server/server/plugins/engine/components/helpers/telephone.js

@@ -1,30 +1,18 @@
 import { TelephoneNumberFieldOptionsFormatEnum } from '@defra/forms-model';
 import LibPhoneNumber from 'google-libphonenumber';
 import JoiBase from 'joi';
-import { opts } from "../../pageControllers/validationOptions.js";
+import { messageTemplate } from "../../pageControllers/validationOptions.js";
 const phoneUtil = LibPhoneNumber.PhoneNumberUtil.getInstance();
 export const COUNTRY = 'GB';
 export const INVALID_ERROR_CODE = 'phoneNumber.invalid';
-export const UK_ERROR_CODE = 'phoneNumber.uk';
-export const INTERNATIONAL_ERROR_CODE = 'phoneNumber.international';
 export const isUKNumber = value => {
   return phoneUtil.isValidNumberForRegion(value, COUNTRY);
 };
-export function getErrorCode(format) {
-  if (format === TelephoneNumberFieldOptionsFormatEnum.UK) {
-    return UK_ERROR_CODE;
-  } else if (format === TelephoneNumberFieldOptionsFormatEnum.International) {
-    return INTERNATIONAL_ERROR_CODE;
-  }
-  return INVALID_ERROR_CODE;
-}
 export const joi = JoiBase.extend({
   type: 'string',
   base: JoiBase.string(),
   messages: {
-    [INVALID_ERROR_CODE]: JoiBase.expression('Enter {{lowerFirst(#label)}}, like 01632 960 001, 07700 900 982, +44 808 157 0192 or +924568456136', opts),
-    [UK_ERROR_CODE]: JoiBase.expression('Enter {{lowerFirst(#label)}}, like 01632 960 001, 07700 900 982 or +44 808 157 0192', opts),
-    [INTERNATIONAL_ERROR_CODE]: JoiBase.expression('Enter {{lowerFirst(#label)}}, starting with + and the country code, for example +92333 1234567 or 00923331234567', opts)
+    [INVALID_ERROR_CODE]: messageTemplate.format
   },
   rules: {
     phoneNumber: {
@@ -50,19 +38,17 @@ export const joi = JoiBase.extend({
         try {
           const parsed = phoneUtil.parse(value, COUNTRY);
           if (!phoneUtil.isValidNumber(parsed)) {
-            return error(getErrorCode(format));
+            return error(INVALID_ERROR_CODE);
           }
           if (format) {
             const isUK = isUKNumber(parsed);
-            if (!isUK && format === TelephoneNumberFieldOptionsFormatEnum.UK) {
-              return error(UK_ERROR_CODE);
-            } else if (isUK && format === TelephoneNumberFieldOptionsFormatEnum.International) {
-              return error(INTERNATIONAL_ERROR_CODE);
+            if (!isUK && format === TelephoneNumberFieldOptionsFormatEnum.UK || isUK && format === TelephoneNumberFieldOptionsFormatEnum.International) {
+              return error(INVALID_ERROR_CODE);
             }
           }
           return value;
         } catch {
-          return error(getErrorCode(format));
+          return error(INVALID_ERROR_CODE);
         }
       }
     }

package/.server/server/plugins/engine/components/helpers/telephone.js.map

@@ -1 +1 @@
-{"version":3,"file":"telephone.js","names":["TelephoneNumberFieldOptionsFormatEnum","LibPhoneNumber","JoiBase","opts","phoneUtil","PhoneNumberUtil","getInstance","COUNTRY","INVALID_ERROR_CODE","UK_ERROR_CODE","INTERNATIONAL_ERROR_CODE","isUKNumber","value","isValidNumberForRegion","getErrorCode","format","UK","International","joi","extend","type","base","string","messages","expression","rules","phoneNumber","method","$_addRule","name","args","ref","assert","valid","validate","error","parsed","parse","isValidNumber","isUK"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/telephone.ts"],"sourcesContent":["import { TelephoneNumberFieldOptionsFormatEnum } from '@defra/forms-model'\nimport LibPhoneNumber from 'google-libphonenumber'\nimport JoiBase, { type JoiExpression, type LanguageMessages } from 'joi'\n\nimport { opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\n\nconst phoneUtil = LibPhoneNumber.PhoneNumberUtil.getInstance()\n\nexport const COUNTRY = 'GB'\nexport const INVALID_ERROR_CODE = 'phoneNumber.invalid'\nexport const UK_ERROR_CODE = 'phoneNumber.uk'\nexport const INTERNATIONAL_ERROR_CODE = 'phoneNumber.international'\n\nexport const isUKNumber = (value: LibPhoneNumber.PhoneNumber) => {\n  return phoneUtil.isValidNumberForRegion(value, COUNTRY)\n}\n\nexport function getErrorCode(format?: TelephoneNumberFieldOptionsFormatEnum) {\n  if (format === TelephoneNumberFieldOptionsFormatEnum.UK) {\n    return UK_ERROR_CODE\n  } else if (format === TelephoneNumberFieldOptionsFormatEnum.International) {\n    return INTERNATIONAL_ERROR_CODE\n  }\n\n  return INVALID_ERROR_CODE\n}\n\nexport const joi = JoiBase.extend({\n  type: 'string',\n  base: JoiBase.string(),\n  messages: {\n    [INVALID_ERROR_CODE]: JoiBase.expression(\n      'Enter {{lowerFirst(#label)}}, like 01632 960 001, 07700 900 982, +44 808 157 0192 or +924568456136',\n      opts\n    ) as JoiExpression,\n    [UK_ERROR_CODE]: JoiBase.expression(\n      'Enter {{lowerFirst(#label)}}, like 01632 960 001, 07700 900 982 or +44 808 157 0192',\n      opts\n    ) as JoiExpression,\n    [INTERNATIONAL_ERROR_CODE]: JoiBase.expression(\n      'Enter {{lowerFirst(#label)}}, starting with + and the country code, for example +92333 1234567 or 00923331234567',\n      opts\n    ) as JoiExpression\n  } as unknown as LanguageMessages,\n  rules: {\n    phoneNumber: {\n      method({\n        format\n      }: { format?: TelephoneNumberFieldOptionsFormatEnum } = {}) {\n        return this.$_addRule({\n          name: 'phoneNumber',\n          args: { format }\n        })\n      },\n      args: [\n        {\n          name: 'format',\n          ref: true,\n          assert: JoiBase.valid(\n            TelephoneNumberFieldOptionsFormatEnum.International,\n            TelephoneNumberFieldOptionsFormatEnum.UK\n          )\n        }\n      ],\n      validate(value, { error }, args) {\n        const format = args.format\n\n        try {\n          const parsed = phoneUtil.parse(value, COUNTRY)\n\n          if (!phoneUtil.isValidNumber(parsed)) {\n            return error(getErrorCode(format))\n          }\n\n          if (format) {\n            const isUK = isUKNumber(parsed)\n\n            if (!isUK && format === TelephoneNumberFieldOptionsFormatEnum.UK) {\n              return error(UK_ERROR_CODE)\n            } else if (\n              isUK &&\n              format === TelephoneNumberFieldOptionsFormatEnum.International\n            ) {\n              return error(INTERNATIONAL_ERROR_CODE)\n            }\n          }\n\n          return value\n        } catch {\n          return error(getErrorCode(format))\n        }\n      }\n    }\n  }\n}) as JoiBase.Root\n"],"mappings":"AAAA,SAASA,qCAAqC,QAAQ,oBAAoB;AAC1E,OAAOC,cAAc,MAAM,uBAAuB;AAClD,OAAOC,OAAO,MAAqD,KAAK;AAExE,SAASC,IAAI;AAEb,MAAMC,SAAS,GAAGH,cAAc,CAACI,eAAe,CAACC,WAAW,CAAC,CAAC;AAE9D,OAAO,MAAMC,OAAO,GAAG,IAAI;AAC3B,OAAO,MAAMC,kBAAkB,GAAG,qBAAqB;AACvD,OAAO,MAAMC,aAAa,GAAG,gBAAgB;AAC7C,OAAO,MAAMC,wBAAwB,GAAG,2BAA2B;AAEnE,OAAO,MAAMC,UAAU,GAAIC,KAAiC,IAAK;EAC/D,OAAOR,SAAS,CAACS,sBAAsB,CAACD,KAAK,EAAEL,OAAO,CAAC;AACzD,CAAC;AAED,OAAO,SAASO,YAAYA,CAACC,MAA8C,EAAE;EAC3E,IAAIA,MAAM,KAAKf,qCAAqC,CAACgB,EAAE,EAAE;IACvD,OAAOP,aAAa;EACtB,CAAC,MAAM,IAAIM,MAAM,KAAKf,qCAAqC,CAACiB,aAAa,EAAE;IACzE,OAAOP,wBAAwB;EACjC;EAEA,OAAOF,kBAAkB;AAC3B;AAEA,OAAO,MAAMU,GAAG,GAAGhB,OAAO,CAACiB,MAAM,CAAC;EAChCC,IAAI,EAAE,QAAQ;EACdC,IAAI,EAAEnB,OAAO,CAACoB,MAAM,CAAC,CAAC;EACtBC,QAAQ,EAAE;IACR,CAACf,kBAAkB,GAAGN,OAAO,CAACsB,UAAU,CACtC,oGAAoG,EACpGrB,IACF,CAAkB;IAClB,CAACM,aAAa,GAAGP,OAAO,CAACsB,UAAU,CACjC,qFAAqF,EACrFrB,IACF,CAAkB;IAClB,CAACO,wBAAwB,GAAGR,OAAO,CAACsB,UAAU,CAC5C,kHAAkH,EAClHrB,IACF;EACF,CAAgC;EAChCsB,KAAK,EAAE;IACLC,WAAW,EAAE;MACXC,MAAMA,CAAC;QACLZ;MACkD,CAAC,GAAG,CAAC,CAAC,EAAE;QAC1D,OAAO,IAAI,CAACa,SAAS,CAAC;UACpBC,IAAI,EAAE,aAAa;UACnBC,IAAI,EAAE;YAAEf;UAAO;QACjB,CAAC,CAAC;MACJ,CAAC;MACDe,IAAI,EAAE,CACJ;QACED,IAAI,EAAE,QAAQ;QACdE,GAAG,EAAE,IAAI;QACTC,MAAM,EAAE9B,OAAO,CAAC+B,KAAK,CACnBjC,qCAAqC,CAACiB,aAAa,EACnDjB,qCAAqC,CAACgB,EACxC;MACF,CAAC,CACF;MACDkB,QAAQA,CAACtB,KAAK,EAAE;QAAEuB;MAAM,CAAC,EAAEL,IAAI,EAAE;QAC/B,MAAMf,MAAM,GAAGe,IAAI,CAACf,MAAM;QAE1B,IAAI;UACF,MAAMqB,MAAM,GAAGhC,SAAS,CAACiC,KAAK,CAACzB,KAAK,EAAEL,OAAO,CAAC;UAE9C,IAAI,CAACH,SAAS,CAACkC,aAAa,CAACF,MAAM,CAAC,EAAE;YACpC,OAAOD,KAAK,CAACrB,YAAY,CAACC,MAAM,CAAC,CAAC;UACpC;UAEA,IAAIA,MAAM,EAAE;YACV,MAAMwB,IAAI,GAAG5B,UAAU,CAACyB,MAAM,CAAC;YAE/B,IAAI,CAACG,IAAI,IAAIxB,MAAM,KAAKf,qCAAqC,CAACgB,EAAE,EAAE;cAChE,OAAOmB,KAAK,CAAC1B,aAAa,CAAC;YAC7B,CAAC,MAAM,IACL8B,IAAI,IACJxB,MAAM,KAAKf,qCAAqC,CAACiB,aAAa,EAC9D;cACA,OAAOkB,KAAK,CAACzB,wBAAwB,CAAC;YACxC;UACF;UAEA,OAAOE,KAAK;QACd,CAAC,CAAC,MAAM;UACN,OAAOuB,KAAK,CAACrB,YAAY,CAACC,MAAM,CAAC,CAAC;QACpC;MACF;IACF;EACF;AACF,CAAC,CAAiB","ignoreList":[]}
+{"version":3,"file":"telephone.js","names":["TelephoneNumberFieldOptionsFormatEnum","LibPhoneNumber","JoiBase","messageTemplate","phoneUtil","PhoneNumberUtil","getInstance","COUNTRY","INVALID_ERROR_CODE","isUKNumber","value","isValidNumberForRegion","joi","extend","type","base","string","messages","format","rules","phoneNumber","method","$_addRule","name","args","ref","assert","valid","International","UK","validate","error","parsed","parse","isValidNumber","isUK"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/telephone.ts"],"sourcesContent":["import { TelephoneNumberFieldOptionsFormatEnum } from '@defra/forms-model'\nimport LibPhoneNumber from 'google-libphonenumber'\nimport JoiBase, { type LanguageMessages } from 'joi'\n\nimport { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'\n\nconst phoneUtil = LibPhoneNumber.PhoneNumberUtil.getInstance()\n\nexport const COUNTRY = 'GB'\nexport const INVALID_ERROR_CODE = 'phoneNumber.invalid'\n\nexport const isUKNumber = (value: LibPhoneNumber.PhoneNumber) => {\n  return phoneUtil.isValidNumberForRegion(value, COUNTRY)\n}\n\nexport const joi = JoiBase.extend({\n  type: 'string',\n  base: JoiBase.string(),\n  messages: {\n    [INVALID_ERROR_CODE]: messageTemplate.format\n  } as LanguageMessages,\n  rules: {\n    phoneNumber: {\n      method({\n        format\n      }: { format?: TelephoneNumberFieldOptionsFormatEnum } = {}) {\n        return this.$_addRule({\n          name: 'phoneNumber',\n          args: { format }\n        })\n      },\n      args: [\n        {\n          name: 'format',\n          ref: true,\n          assert: JoiBase.valid(\n            TelephoneNumberFieldOptionsFormatEnum.International,\n            TelephoneNumberFieldOptionsFormatEnum.UK\n          )\n        }\n      ],\n      validate(value, { error }, args) {\n        const format = args.format\n\n        try {\n          const parsed = phoneUtil.parse(value, COUNTRY)\n\n          if (!phoneUtil.isValidNumber(parsed)) {\n            return error(INVALID_ERROR_CODE)\n          }\n\n          if (format) {\n            const isUK = isUKNumber(parsed)\n\n            if (\n              (!isUK && format === TelephoneNumberFieldOptionsFormatEnum.UK) ||\n              (isUK &&\n                format === TelephoneNumberFieldOptionsFormatEnum.International)\n            ) {\n              return error(INVALID_ERROR_CODE)\n            }\n          }\n\n          return value\n        } catch {\n          return error(INVALID_ERROR_CODE)\n        }\n      }\n    }\n  }\n}) as JoiBase.Root\n"],"mappings":"AAAA,SAASA,qCAAqC,QAAQ,oBAAoB;AAC1E,OAAOC,cAAc,MAAM,uBAAuB;AAClD,OAAOC,OAAO,MAAiC,KAAK;AAEpD,SAASC,eAAe;AAExB,MAAMC,SAAS,GAAGH,cAAc,CAACI,eAAe,CAACC,WAAW,CAAC,CAAC;AAE9D,OAAO,MAAMC,OAAO,GAAG,IAAI;AAC3B,OAAO,MAAMC,kBAAkB,GAAG,qBAAqB;AAEvD,OAAO,MAAMC,UAAU,GAAIC,KAAiC,IAAK;EAC/D,OAAON,SAAS,CAACO,sBAAsB,CAACD,KAAK,EAAEH,OAAO,CAAC;AACzD,CAAC;AAED,OAAO,MAAMK,GAAG,GAAGV,OAAO,CAACW,MAAM,CAAC;EAChCC,IAAI,EAAE,QAAQ;EACdC,IAAI,EAAEb,OAAO,CAACc,MAAM,CAAC,CAAC;EACtBC,QAAQ,EAAE;IACR,CAACT,kBAAkB,GAAGL,eAAe,CAACe;EACxC,CAAqB;EACrBC,KAAK,EAAE;IACLC,WAAW,EAAE;MACXC,MAAMA,CAAC;QACLH;MACkD,CAAC,GAAG,CAAC,CAAC,EAAE;QAC1D,OAAO,IAAI,CAACI,SAAS,CAAC;UACpBC,IAAI,EAAE,aAAa;UACnBC,IAAI,EAAE;YAAEN;UAAO;QACjB,CAAC,CAAC;MACJ,CAAC;MACDM,IAAI,EAAE,CACJ;QACED,IAAI,EAAE,QAAQ;QACdE,GAAG,EAAE,IAAI;QACTC,MAAM,EAAExB,OAAO,CAACyB,KAAK,CACnB3B,qCAAqC,CAAC4B,aAAa,EACnD5B,qCAAqC,CAAC6B,EACxC;MACF,CAAC,CACF;MACDC,QAAQA,CAACpB,KAAK,EAAE;QAAEqB;MAAM,CAAC,EAAEP,IAAI,EAAE;QAC/B,MAAMN,MAAM,GAAGM,IAAI,CAACN,MAAM;QAE1B,IAAI;UACF,MAAMc,MAAM,GAAG5B,SAAS,CAAC6B,KAAK,CAACvB,KAAK,EAAEH,OAAO,CAAC;UAE9C,IAAI,CAACH,SAAS,CAAC8B,aAAa,CAACF,MAAM,CAAC,EAAE;YACpC,OAAOD,KAAK,CAACvB,kBAAkB,CAAC;UAClC;UAEA,IAAIU,MAAM,EAAE;YACV,MAAMiB,IAAI,GAAG1B,UAAU,CAACuB,MAAM,CAAC;YAE/B,IACG,CAACG,IAAI,IAAIjB,MAAM,KAAKlB,qCAAqC,CAAC6B,EAAE,IAC5DM,IAAI,IACHjB,MAAM,KAAKlB,qCAAqC,CAAC4B,aAAc,EACjE;cACA,OAAOG,KAAK,CAACvB,kBAAkB,CAAC;YAClC;UACF;UAEA,OAAOE,KAAK;QACd,CAAC,CAAC,MAAM;UACN,OAAOqB,KAAK,CAACvB,kBAAkB,CAAC;QAClC;MACF;IACF;EACF;AACF,CAAC,CAAiB","ignoreList":[]}

package/.server/server/plugins/engine/components/helpers/telephone.test.js

@@ -24,7 +24,7 @@ describe('Telephone validation helpers', () => {
       }).label('Home phone');
       const result = telephoneSchema.validate('ABC');
       expect(result.error).toBeDefined();
-      expect(result.error?.message).toBe('Enter home phone, like 01632 960 001, 07700 900 982 or +44 808 157 0192');
+      expect(result.error?.message).toBe('Enter home phone in the correct format');
       expect(result.value).toBe('ABC');
     });
     test('it should have errors for international telephone number', () => {
@@ -33,7 +33,7 @@ describe('Telephone validation helpers', () => {
       }).label('Home phone');
       const result = telephoneSchema.validate('+1-212-456-7890');
       expect(result.error).toBeDefined();
-      expect(result.error?.message).toBe('Enter home phone, like 01632 960 001, 07700 900 982 or +44 808 157 0192');
+      expect(result.error?.message).toBe('Enter home phone in the correct format');
       expect(result.value).toBe('+1-212-456-7890');
     });
   });
@@ -52,7 +52,7 @@ describe('Telephone validation helpers', () => {
       }).label('Home phone');
       const result = telephoneSchema.validate('ABC');
       expect(result.error).toBeDefined();
-      expect(result.error?.message).toBe('Enter home phone, starting with + and the country code, for example +92333 1234567 or 00923331234567');
+      expect(result.error?.message).toBe('Enter home phone in the correct format');
       expect(result.value).toBe('ABC');
     });
     test('it should have errors for UK phone number in international format', () => {
@@ -61,7 +61,7 @@ describe('Telephone validation helpers', () => {
       }).label('Home phone');
       const result = telephoneSchema.validate('+44 1606 76477');
       expect(result.error).toBeDefined();
-      expect(result.error?.message).toBe('Enter home phone, starting with + and the country code, for example +92333 1234567 or 00923331234567');
+      expect(result.error?.message).toBe('Enter home phone in the correct format');
       expect(result.value).toBe('+44 1606 76477');
     });
   });
@@ -82,7 +82,7 @@ describe('Telephone validation helpers', () => {
       const telephoneSchema = joi.string().phoneNumber().label('Home phone');
       const result = telephoneSchema.validate('ABC');
       expect(result.error).toBeDefined();
-      expect(result.error?.message).toBe('Enter home phone, like 01632 960 001, 07700 900 982, +44 808 157 0192 or +924568456136');
+      expect(result.error?.message).toBe('Enter home phone in the correct format');
       expect(result.value).toBe('ABC');
     });
   });

package/.server/server/plugins/engine/components/helpers/telephone.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"telephone.test.js","names":["TelephoneNumberFieldOptionsFormatEnum","joi","describe","test","telephoneSchema","string","phoneNumber","format","UK","label","result","validate","expect","error","toBeUndefined","value","toBe","toBeDefined","message","International"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/telephone.test.js"],"sourcesContent":["import { TelephoneNumberFieldOptionsFormatEnum } from '@defra/forms-model'\n\nimport { joi } from '~/src/server/plugins/engine/components/helpers/telephone.js'\n\ndescribe('Telephone validation helpers', () => {\n  describe('UK numbers', () => {\n    test('it should not have errors for valid telephone number', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({ format: TelephoneNumberFieldOptionsFormatEnum.UK })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('0160676477')\n\n      expect(result.error).toBeUndefined()\n      expect(result.value).toBe('0160676477')\n    })\n\n    test('it should not have errors for valid UK telephone number in international format', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({ format: TelephoneNumberFieldOptionsFormatEnum.UK })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('+44 1606 76477')\n\n      expect(result.error).toBeUndefined()\n      expect(result.value).toBe('+44 1606 76477')\n    })\n\n    test('it should have errors for invalid telephone number', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({ format: TelephoneNumberFieldOptionsFormatEnum.UK })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('ABC')\n\n      expect(result.error).toBeDefined()\n      expect(result.error?.message).toBe(\n        'Enter home phone, like 01632 960 001, 07700 900 982 or +44 808 157 0192'\n      )\n      expect(result.value).toBe('ABC')\n    })\n\n    test('it should have errors for international telephone number', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({ format: TelephoneNumberFieldOptionsFormatEnum.UK })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('+1-212-456-7890')\n\n      expect(result.error).toBeDefined()\n      expect(result.error?.message).toBe(\n        'Enter home phone, like 01632 960 001, 07700 900 982 or +44 808 157 0192'\n      )\n      expect(result.value).toBe('+1-212-456-7890')\n    })\n  })\n\n  describe('International numbers', () => {\n    test('it should not have errors for valid telephone number', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({\n          format: TelephoneNumberFieldOptionsFormatEnum.International\n        })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('+1-212-456-7890')\n\n      expect(result.error).toBeUndefined()\n      expect(result.value).toBe('+1-212-456-7890')\n    })\n\n    test('it should have errors for invalid telephone number', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({\n          format: TelephoneNumberFieldOptionsFormatEnum.International\n        })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('ABC')\n\n      expect(result.error).toBeDefined()\n      expect(result.error?.message).toBe(\n        'Enter home phone, starting with + and the country code, for example +92333 1234567 or 00923331234567'\n      )\n      expect(result.value).toBe('ABC')\n    })\n\n    test('it should have errors for UK phone number in international format', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({\n          format: TelephoneNumberFieldOptionsFormatEnum.International\n        })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('+44 1606 76477')\n\n      expect(result.error).toBeDefined()\n      expect(result.error?.message).toBe(\n        'Enter home phone, starting with + and the country code, for example +92333 1234567 or 00923331234567'\n      )\n      expect(result.value).toBe('+44 1606 76477')\n    })\n  })\n\n  describe('Any format', () => {\n    test('it should not have errors for valid national telephone number', () => {\n      const telephoneSchema = joi.string().phoneNumber().label('Home phone')\n\n      const result = telephoneSchema.validate('0160676477')\n\n      expect(result.error).toBeUndefined()\n      expect(result.value).toBe('0160676477')\n    })\n\n    test('it should not have errors for valid international telephone number', () => {\n      const telephoneSchema = joi.string().phoneNumber().label('Home phone')\n\n      const result = telephoneSchema.validate('+1-212-456-7890')\n\n      expect(result.error).toBeUndefined()\n      expect(result.value).toBe('+1-212-456-7890')\n    })\n\n    test('it should have errors for invalid telephone number', () => {\n      const telephoneSchema = joi.string().phoneNumber().label('Home phone')\n\n      const result = telephoneSchema.validate('ABC')\n\n      expect(result.error).toBeDefined()\n      expect(result.error?.message).toBe(\n        'Enter home phone, like 01632 960 001, 07700 900 982, +44 808 157 0192 or +924568456136'\n      )\n      expect(result.value).toBe('ABC')\n    })\n  })\n})\n"],"mappings":"AAAA,SAASA,qCAAqC,QAAQ,oBAAoB;AAE1E,SAASC,GAAG;AAEZC,QAAQ,CAAC,8BAA8B,EAAE,MAAM;EAC7CA,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC3BC,IAAI,CAAC,sDAAsD,EAAE,MAAM;MACjE,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QAAEC,MAAM,EAAEP,qCAAqC,CAACQ;MAAG,CAAC,CAAC,CACjEC,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,YAAY,CAAC;MAErDC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;MACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,YAAY,CAAC;IACzC,CAAC,CAAC;IAEFb,IAAI,CAAC,iFAAiF,EAAE,MAAM;MAC5F,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QAAEC,MAAM,EAAEP,qCAAqC,CAACQ;MAAG,CAAC,CAAC,CACjEC,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,gBAAgB,CAAC;MAEzDC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;MACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,gBAAgB,CAAC;IAC7C,CAAC,CAAC;IAEFb,IAAI,CAAC,oDAAoD,EAAE,MAAM;MAC/D,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QAAEC,MAAM,EAAEP,qCAAqC,CAACQ;MAAG,CAAC,CAAC,CACjEC,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,KAAK,CAAC;MAE9CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACI,WAAW,CAAC,CAAC;MAClCL,MAAM,CAACF,MAAM,CAACG,KAAK,EAAEK,OAAO,CAAC,CAACF,IAAI,CAChC,yEACF,CAAC;MACDJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,KAAK,CAAC;IAClC,CAAC,CAAC;IAEFb,IAAI,CAAC,0DAA0D,EAAE,MAAM;MACrE,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QAAEC,MAAM,EAAEP,qCAAqC,CAACQ;MAAG,CAAC,CAAC,CACjEC,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,iBAAiB,CAAC;MAE1DC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACI,WAAW,CAAC,CAAC;MAClCL,MAAM,CAACF,MAAM,CAACG,KAAK,EAAEK,OAAO,CAAC,CAACF,IAAI,CAChC,yEACF,CAAC;MACDJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,iBAAiB,CAAC;IAC9C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFd,QAAQ,CAAC,uBAAuB,EAAE,MAAM;IACtCC,IAAI,CAAC,sDAAsD,EAAE,MAAM;MACjE,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QACXC,MAAM,EAAEP,qCAAqC,CAACmB;MAChD,CAAC,CAAC,CACDV,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,iBAAiB,CAAC;MAE1DC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;MACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,iBAAiB,CAAC;IAC9C,CAAC,CAAC;IAEFb,IAAI,CAAC,oDAAoD,EAAE,MAAM;MAC/D,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QACXC,MAAM,EAAEP,qCAAqC,CAACmB;MAChD,CAAC,CAAC,CACDV,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,KAAK,CAAC;MAE9CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACI,WAAW,CAAC,CAAC;MAClCL,MAAM,CAACF,MAAM,CAACG,KAAK,EAAEK,OAAO,CAAC,CAACF,IAAI,CAChC,sGACF,CAAC;MACDJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,KAAK,CAAC;IAClC,CAAC,CAAC;IAEFb,IAAI,CAAC,mEAAmE,EAAE,MAAM;MAC9E,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QACXC,MAAM,EAAEP,qCAAqC,CAACmB;MAChD,CAAC,CAAC,CACDV,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,gBAAgB,CAAC;MAEzDC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACI,WAAW,CAAC,CAAC;MAClCL,MAAM,CAACF,MAAM,CAACG,KAAK,EAAEK,OAAO,CAAC,CAACF,IAAI,CAChC,sGACF,CAAC;MACDJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,gBAAgB,CAAC;IAC7C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFd,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC3BC,IAAI,CAAC,+DAA+D,EAAE,MAAM;MAC1E,MAAMC,eAAe,GAAGH,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,WAAW,CAAC,CAAC,CAACG,KAAK,CAAC,YAAY,CAAC;MAEtE,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,YAAY,CAAC;MAErDC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;MACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,YAAY,CAAC;IACzC,CAAC,CAAC;IAEFb,IAAI,CAAC,oEAAoE,EAAE,MAAM;MAC/E,MAAMC,eAAe,GAAGH,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,WAAW,CAAC,CAAC,CAACG,KAAK,CAAC,YAAY,CAAC;MAEtE,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,iBAAiB,CAAC;MAE1DC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;MACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,iBAAiB,CAAC;IAC9C,CAAC,CAAC;IAEFb,IAAI,CAAC,oDAAoD,EAAE,MAAM;MAC/D,MAAMC,eAAe,GAAGH,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,WAAW,CAAC,CAAC,CAACG,KAAK,CAAC,YAAY,CAAC;MAEtE,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,KAAK,CAAC;MAE9CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACI,WAAW,CAAC,CAAC;MAClCL,MAAM,CAACF,MAAM,CAACG,KAAK,EAAEK,OAAO,CAAC,CAACF,IAAI,CAChC,wFACF,CAAC;MACDJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,KAAK,CAAC;IAClC,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"telephone.test.js","names":["TelephoneNumberFieldOptionsFormatEnum","joi","describe","test","telephoneSchema","string","phoneNumber","format","UK","label","result","validate","expect","error","toBeUndefined","value","toBe","toBeDefined","message","International"],"sources":["../../../../../../src/server/plugins/engine/components/helpers/telephone.test.js"],"sourcesContent":["import { TelephoneNumberFieldOptionsFormatEnum } from '@defra/forms-model'\n\nimport { joi } from '~/src/server/plugins/engine/components/helpers/telephone.js'\n\ndescribe('Telephone validation helpers', () => {\n  describe('UK numbers', () => {\n    test('it should not have errors for valid telephone number', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({ format: TelephoneNumberFieldOptionsFormatEnum.UK })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('0160676477')\n\n      expect(result.error).toBeUndefined()\n      expect(result.value).toBe('0160676477')\n    })\n\n    test('it should not have errors for valid UK telephone number in international format', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({ format: TelephoneNumberFieldOptionsFormatEnum.UK })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('+44 1606 76477')\n\n      expect(result.error).toBeUndefined()\n      expect(result.value).toBe('+44 1606 76477')\n    })\n\n    test('it should have errors for invalid telephone number', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({ format: TelephoneNumberFieldOptionsFormatEnum.UK })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('ABC')\n\n      expect(result.error).toBeDefined()\n      expect(result.error?.message).toBe(\n        'Enter home phone in the correct format'\n      )\n      expect(result.value).toBe('ABC')\n    })\n\n    test('it should have errors for international telephone number', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({ format: TelephoneNumberFieldOptionsFormatEnum.UK })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('+1-212-456-7890')\n\n      expect(result.error).toBeDefined()\n      expect(result.error?.message).toBe(\n        'Enter home phone in the correct format'\n      )\n      expect(result.value).toBe('+1-212-456-7890')\n    })\n  })\n\n  describe('International numbers', () => {\n    test('it should not have errors for valid telephone number', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({\n          format: TelephoneNumberFieldOptionsFormatEnum.International\n        })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('+1-212-456-7890')\n\n      expect(result.error).toBeUndefined()\n      expect(result.value).toBe('+1-212-456-7890')\n    })\n\n    test('it should have errors for invalid telephone number', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({\n          format: TelephoneNumberFieldOptionsFormatEnum.International\n        })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('ABC')\n\n      expect(result.error).toBeDefined()\n      expect(result.error?.message).toBe(\n        'Enter home phone in the correct format'\n      )\n      expect(result.value).toBe('ABC')\n    })\n\n    test('it should have errors for UK phone number in international format', () => {\n      const telephoneSchema = joi\n        .string()\n        .phoneNumber({\n          format: TelephoneNumberFieldOptionsFormatEnum.International\n        })\n        .label('Home phone')\n\n      const result = telephoneSchema.validate('+44 1606 76477')\n\n      expect(result.error).toBeDefined()\n      expect(result.error?.message).toBe(\n        'Enter home phone in the correct format'\n      )\n      expect(result.value).toBe('+44 1606 76477')\n    })\n  })\n\n  describe('Any format', () => {\n    test('it should not have errors for valid national telephone number', () => {\n      const telephoneSchema = joi.string().phoneNumber().label('Home phone')\n\n      const result = telephoneSchema.validate('0160676477')\n\n      expect(result.error).toBeUndefined()\n      expect(result.value).toBe('0160676477')\n    })\n\n    test('it should not have errors for valid international telephone number', () => {\n      const telephoneSchema = joi.string().phoneNumber().label('Home phone')\n\n      const result = telephoneSchema.validate('+1-212-456-7890')\n\n      expect(result.error).toBeUndefined()\n      expect(result.value).toBe('+1-212-456-7890')\n    })\n\n    test('it should have errors for invalid telephone number', () => {\n      const telephoneSchema = joi.string().phoneNumber().label('Home phone')\n\n      const result = telephoneSchema.validate('ABC')\n\n      expect(result.error).toBeDefined()\n      expect(result.error?.message).toBe(\n        'Enter home phone in the correct format'\n      )\n      expect(result.value).toBe('ABC')\n    })\n  })\n})\n"],"mappings":"AAAA,SAASA,qCAAqC,QAAQ,oBAAoB;AAE1E,SAASC,GAAG;AAEZC,QAAQ,CAAC,8BAA8B,EAAE,MAAM;EAC7CA,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC3BC,IAAI,CAAC,sDAAsD,EAAE,MAAM;MACjE,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QAAEC,MAAM,EAAEP,qCAAqC,CAACQ;MAAG,CAAC,CAAC,CACjEC,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,YAAY,CAAC;MAErDC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;MACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,YAAY,CAAC;IACzC,CAAC,CAAC;IAEFb,IAAI,CAAC,iFAAiF,EAAE,MAAM;MAC5F,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QAAEC,MAAM,EAAEP,qCAAqC,CAACQ;MAAG,CAAC,CAAC,CACjEC,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,gBAAgB,CAAC;MAEzDC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;MACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,gBAAgB,CAAC;IAC7C,CAAC,CAAC;IAEFb,IAAI,CAAC,oDAAoD,EAAE,MAAM;MAC/D,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QAAEC,MAAM,EAAEP,qCAAqC,CAACQ;MAAG,CAAC,CAAC,CACjEC,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,KAAK,CAAC;MAE9CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACI,WAAW,CAAC,CAAC;MAClCL,MAAM,CAACF,MAAM,CAACG,KAAK,EAAEK,OAAO,CAAC,CAACF,IAAI,CAChC,wCACF,CAAC;MACDJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,KAAK,CAAC;IAClC,CAAC,CAAC;IAEFb,IAAI,CAAC,0DAA0D,EAAE,MAAM;MACrE,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QAAEC,MAAM,EAAEP,qCAAqC,CAACQ;MAAG,CAAC,CAAC,CACjEC,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,iBAAiB,CAAC;MAE1DC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACI,WAAW,CAAC,CAAC;MAClCL,MAAM,CAACF,MAAM,CAACG,KAAK,EAAEK,OAAO,CAAC,CAACF,IAAI,CAChC,wCACF,CAAC;MACDJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,iBAAiB,CAAC;IAC9C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFd,QAAQ,CAAC,uBAAuB,EAAE,MAAM;IACtCC,IAAI,CAAC,sDAAsD,EAAE,MAAM;MACjE,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QACXC,MAAM,EAAEP,qCAAqC,CAACmB;MAChD,CAAC,CAAC,CACDV,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,iBAAiB,CAAC;MAE1DC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;MACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,iBAAiB,CAAC;IAC9C,CAAC,CAAC;IAEFb,IAAI,CAAC,oDAAoD,EAAE,MAAM;MAC/D,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QACXC,MAAM,EAAEP,qCAAqC,CAACmB;MAChD,CAAC,CAAC,CACDV,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,KAAK,CAAC;MAE9CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACI,WAAW,CAAC,CAAC;MAClCL,MAAM,CAACF,MAAM,CAACG,KAAK,EAAEK,OAAO,CAAC,CAACF,IAAI,CAChC,wCACF,CAAC;MACDJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,KAAK,CAAC;IAClC,CAAC,CAAC;IAEFb,IAAI,CAAC,mEAAmE,EAAE,MAAM;MAC9E,MAAMC,eAAe,GAAGH,GAAG,CACxBI,MAAM,CAAC,CAAC,CACRC,WAAW,CAAC;QACXC,MAAM,EAAEP,qCAAqC,CAACmB;MAChD,CAAC,CAAC,CACDV,KAAK,CAAC,YAAY,CAAC;MAEtB,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,gBAAgB,CAAC;MAEzDC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACI,WAAW,CAAC,CAAC;MAClCL,MAAM,CAACF,MAAM,CAACG,KAAK,EAAEK,OAAO,CAAC,CAACF,IAAI,CAChC,wCACF,CAAC;MACDJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,gBAAgB,CAAC;IAC7C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFd,QAAQ,CAAC,YAAY,EAAE,MAAM;IAC3BC,IAAI,CAAC,+DAA+D,EAAE,MAAM;MAC1E,MAAMC,eAAe,GAAGH,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,WAAW,CAAC,CAAC,CAACG,KAAK,CAAC,YAAY,CAAC;MAEtE,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,YAAY,CAAC;MAErDC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;MACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,YAAY,CAAC;IACzC,CAAC,CAAC;IAEFb,IAAI,CAAC,oEAAoE,EAAE,MAAM;MAC/E,MAAMC,eAAe,GAAGH,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,WAAW,CAAC,CAAC,CAACG,KAAK,CAAC,YAAY,CAAC;MAEtE,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,iBAAiB,CAAC;MAE1DC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACC,aAAa,CAAC,CAAC;MACpCF,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,iBAAiB,CAAC;IAC9C,CAAC,CAAC;IAEFb,IAAI,CAAC,oDAAoD,EAAE,MAAM;MAC/D,MAAMC,eAAe,GAAGH,GAAG,CAACI,MAAM,CAAC,CAAC,CAACC,WAAW,CAAC,CAAC,CAACG,KAAK,CAAC,YAAY,CAAC;MAEtE,MAAMC,MAAM,GAAGN,eAAe,CAACO,QAAQ,CAAC,KAAK,CAAC;MAE9CC,MAAM,CAACF,MAAM,CAACG,KAAK,CAAC,CAACI,WAAW,CAAC,CAAC;MAClCL,MAAM,CAACF,MAAM,CAACG,KAAK,EAAEK,OAAO,CAAC,CAACF,IAAI,CAChC,wCACF,CAAC;MACDJ,MAAM,CAACF,MAAM,CAACK,KAAK,CAAC,CAACC,IAAI,CAAC,KAAK,CAAC;IAClC,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/.server/server/plugins/map/routes/index.d.ts

@@ -2,7 +2,7 @@
  * Gets the map support routes
  * @param {MapConfiguration} options - ordnance survey names api key
  */
-export function getRoutes(options: MapConfiguration): (ServerRoute<MapProxyGetRequestRefs> | ServerRoute<MapGeocodeGetRequestRefs> | ServerRoute<MapReverseGeocodeGetRequestRefs> | ServerRoute<GeospatialCountriesGetRequestRefs>)[];
+export function getRoutes(options: MapConfiguration): (ServerRoute<MapProxyGetRequestRefs> | ServerRoute<MapGeocodeGetRequestRefs> | ServerRoute<GeospatialCountriesGetRequestRefs>)[];
 /**
  * @type {FeatureCollection}
  */
@@ -12,7 +12,6 @@ import type { MapConfiguration } from '../../../../server/plugins/map/types.js';
 import type { MapProxyGetRequestRefs } from '../../../../server/plugins/map/types.js';
 import type { ServerRoute } from '@hapi/hapi';
 import type { MapGeocodeGetRequestRefs } from '../../../../server/plugins/map/types.js';
-import type { MapReverseGeocodeGetRequestRefs } from '../../../../server/plugins/map/types.js';
 import type { GeospatialCountriesGetRequestRefs } from '../../../../server/plugins/map/types.js';
 import type { FeatureCollection } from 'geojson';
 import Joi from 'joi';

package/.server/server/plugins/map/routes/index.js

@@ -4,7 +4,7 @@ import { GeospatialFieldOptionsCountryEnum } from '@defra/forms-model';
 import { StatusCodes } from 'http-status-codes';
 import Joi from 'joi';
 import { getAccessToken } from "./get-os-token.js";
-import { find, nearest } from "../service.js";
+import { find } from "../service.js";
 import { get, request as httpRequest } from "../../../services/httpService.js";
 const filePath = resolve(import.meta.dirname, './vts/countries.geojson');
 
@@ -20,7 +20,7 @@ export const countrySchema = Joi.string().valid(...Object.values(GeospatialField
  * @param {MapConfiguration} options - ordnance survey names api key
  */
 export function getRoutes(options) {
-  return [mapStyleResourceRoutes(), mapProxyRoute(options), tileProxyRoute(options), geocodeProxyRoute(options), reverseGeocodeProxyRoute(options), getGeospatialCountries()];
+  return [mapStyleResourceRoutes(), mapProxyRoute(options), tileProxyRoute(options), geocodeProxyRoute(options), getGeospatialCountries()];
 }
 
 /**
@@ -134,36 +134,6 @@ function geocodeProxyRoute(options) {
   };
 }
 
-/**
- * Proxies ordnance survey reverse geocode requests from the front end to api.os.uk
- * Used to find name from easting and northing points.
- * N.B this endpoint is currently not used by the front end but will be soon in "maps V2"
- * @param {MapConfiguration} options - the map options
- * @returns {ServerRoute<MapReverseGeocodeGetRequestRefs>}
- */
-function reverseGeocodeProxyRoute(options) {
-  return {
-    method: 'GET',
-    path: '/api/reverse-geocode-proxy',
-    async handler(request, _h) {
-      const {
-        query
-      } = request;
-      const data = await nearest(query.easting, query.northing, options.ordnanceSurveyApiKey);
-      return data;
-    },
-    options: {
-      auth: false,
-      validate: {
-        query: Joi.object().keys({
-          easting: Joi.number().required(),
-          northing: Joi.number().required()
-        }).required()
-      }
-    }
-  };
-}
-
 /**
  * Resource routes to return sprites and glyphs
  * @returns {ServerRoute<MapProxyGetRequestRefs>}

package/.server/server/plugins/map/routes/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["fs","resolve","GeospatialFieldOptionsCountryEnum","StatusCodes","Joi","getAccessToken","find","nearest","get","request","httpRequest","filePath","import","meta","dirname","countries","JSON","parse","readFileSync","countrySchema","string","valid","Object","values","getRoutes","options","mapStyleResourceRoutes","mapProxyRoute","tileProxyRoute","geocodeProxyRoute","reverseGeocodeProxyRoute","getGeospatialCountries","method","path","handler","h","query","targetUrl","URL","decodeURIComponent","url","token","searchParams","set","proxyResponse","toString","headers","Authorization","buffer","payload","contentType","res","response","type","auth","validate","object","keys","required","optional","z","y","x","params","getBuffer","Accept","json","gunzip","statusCode","OK","valueOf","code","header","_h","data","ordnanceSurveyApiKey","easting","northing","number","directory","omit","only","features","filter","feature","id"],"sources":["../../../../../src/server/plugins/map/routes/index.js"],"sourcesContent":["import fs from 'node:fs'\nimport { resolve } from 'node:path'\n\nimport { GeospatialFieldOptionsCountryEnum } from '@defra/forms-model'\nimport { StatusCodes } from 'http-status-codes'\nimport Joi from 'joi'\n\nimport { getAccessToken } from '~/src/server/plugins/map/routes/get-os-token.js'\nimport { find, nearest } from '~/src/server/plugins/map/service.js'\nimport {\n  get,\n  request as httpRequest\n} from '~/src/server/services/httpService.js'\n\nconst filePath = resolve(import.meta.dirname, './vts/countries.geojson')\n\n/**\n * @type {FeatureCollection}\n */\n// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\nexport const countries = JSON.parse(fs.readFileSync(filePath, 'utf8'))\n\nexport const countrySchema = Joi.string().valid(\n  ...Object.values(GeospatialFieldOptionsCountryEnum)\n)\n\n/**\n * Gets the map support routes\n * @param {MapConfiguration} options - ordnance survey names api key\n */\nexport function getRoutes(options) {\n  return [\n    mapStyleResourceRoutes(),\n    mapProxyRoute(options),\n    tileProxyRoute(options),\n    geocodeProxyRoute(options),\n    reverseGeocodeProxyRoute(options),\n    getGeospatialCountries()\n  ]\n}\n\n/**\n * Proxies ordnance survey requests from the front end to api.os.com\n * Used for the VTS map source by forwarding on the request\n * and adding the auth token and SRS (spatial reference system)\n * @param {MapConfiguration} options - the map options\n * @returns {ServerRoute<MapProxyGetRequestRefs>}\n */\nfunction mapProxyRoute(options) {\n  return {\n    method: 'GET',\n    path: '/api/map-proxy',\n    handler: async (request, h) => {\n      const { query } = request\n      const targetUrl = new URL(decodeURIComponent(query.url))\n      const token = await getAccessToken(options)\n\n      targetUrl.searchParams.set('srs', '3857')\n\n      const proxyResponse = await httpRequest('get', targetUrl.toString(), {\n        headers: {\n          Authorization: `Bearer ${token}`\n        }\n      })\n      const buffer = proxyResponse.payload\n      const contentType = proxyResponse.res.headers['content-type']\n      const response = h.response(buffer)\n\n      if (contentType) {\n        response.type(contentType)\n      }\n\n      return response\n    },\n    options: {\n      auth: false,\n      validate: {\n        query: Joi.object()\n          .keys({\n            url: Joi.string().required()\n          })\n          .optional()\n      }\n    }\n  }\n}\n\n/**\n * Proxies ordnance survey requests from the front end to api.os.uk\n * Used for VTS map tiles forwarding on the request and adding the auth token\n * @param {MapConfiguration} options - the map options\n * @returns {ServerRoute<MapProxyGetRequestRefs>}\n */\nfunction tileProxyRoute(options) {\n  return {\n    method: 'GET',\n    path: '/api/tile/{z}/{y}/{x}.pbf',\n    handler: async (request, h) => {\n      const { z, y, x } = request.params\n      const token = await getAccessToken(options)\n\n      const url = `https://api.os.uk/maps/vector/v1/vts/tile/${z}/${y}/${x}.pbf?srs=3857`\n\n      const getBuffer = /** @type {typeof get<Buffer>} */ (get)\n\n      const { payload, res } = await getBuffer(url, {\n        headers: {\n          Authorization: `Bearer ${token}`,\n          Accept: 'application/x-protobuf'\n        },\n        json: false,\n        gunzip: true\n      })\n\n      if (res.statusCode && res.statusCode !== StatusCodes.OK.valueOf()) {\n        return h.response('Tile fetch failed').code(res.statusCode)\n      }\n\n      return h\n        .response(payload)\n        .type('application/x-protobuf')\n        .header('Cache-Control', 'public, max-age=86400')\n    },\n    options: {\n      auth: false\n    }\n  }\n}\n\n/**\n * Proxies ordnance survey geocode requests from the front end to api.os.uk\n * Used for the gazzeteer address lookup to find name from query strings like postcode and place names\n * @param {MapConfiguration} options - the map options\n * @returns {ServerRoute<MapGeocodeGetRequestRefs>}\n */\nfunction geocodeProxyRoute(options) {\n  return {\n    method: 'GET',\n    path: '/api/geocode-proxy',\n    async handler(request, _h) {\n      const { query } = request\n      const data = await find(query.query, options.ordnanceSurveyApiKey)\n\n      return data\n    },\n    options: {\n      auth: false,\n      validate: {\n        query: Joi.object()\n          .keys({\n            query: Joi.string().required()\n          })\n          .required()\n      }\n    }\n  }\n}\n\n/**\n * Proxies ordnance survey reverse geocode requests from the front end to api.os.uk\n * Used to find name from easting and northing points.\n * N.B this endpoint is currently not used by the front end but will be soon in \"maps V2\"\n * @param {MapConfiguration} options - the map options\n * @returns {ServerRoute<MapReverseGeocodeGetRequestRefs>}\n */\nfunction reverseGeocodeProxyRoute(options) {\n  return {\n    method: 'GET',\n    path: '/api/reverse-geocode-proxy',\n    async handler(request, _h) {\n      const { query } = request\n      const data = await nearest(\n        query.easting,\n        query.northing,\n        options.ordnanceSurveyApiKey\n      )\n\n      return data\n    },\n    options: {\n      auth: false,\n      validate: {\n        query: Joi.object()\n          .keys({\n            easting: Joi.number().required(),\n            northing: Joi.number().required()\n          })\n          .required()\n      }\n    }\n  }\n}\n\n/**\n * Resource routes to return sprites and glyphs\n * @returns {ServerRoute<MapProxyGetRequestRefs>}\n */\nfunction mapStyleResourceRoutes() {\n  return {\n    method: 'GET',\n    path: '/api/maps/vts/{path*}',\n    options: {\n      auth: false,\n      handler: {\n        directory: {\n          path: resolve(import.meta.dirname, './vts')\n        }\n      }\n    }\n  }\n}\n\n/**\n * Resource routes to return sprites and glyphs\n * @returns {ServerRoute<GeospatialCountriesGetRequestRefs>}\n */\nfunction getGeospatialCountries() {\n  return {\n    method: 'GET',\n    path: '/api/maps/countries.geojson',\n    handler: (request) => {\n      const { omit, only } = request.query\n\n      if (omit) {\n        return {\n          ...countries,\n          features: countries.features.filter((feature) => feature.id !== omit)\n        }\n      }\n\n      if (only) {\n        return {\n          ...countries,\n          features: countries.features.filter((feature) => feature.id === only)\n        }\n      }\n\n      return countries\n    },\n    options: {\n      auth: false,\n      validate: {\n        query: Joi.object()\n          .keys({\n            omit: countrySchema.optional(),\n            only: countrySchema.optional()\n          })\n          .optional()\n      }\n    }\n  }\n}\n\n/**\n * @import { ServerRoute } from '@hapi/hapi'\n * @import { FeatureCollection } from 'geojson'\n * @import { MapConfiguration, MapProxyGetRequestRefs, MapGeocodeGetRequestRefs, MapReverseGeocodeGetRequestRefs, GeospatialCountriesGetRequestRefs } from '~/src/server/plugins/map/types.js'\n */\n"],"mappings":"AAAA,OAAOA,EAAE,MAAM,SAAS;AACxB,SAASC,OAAO,QAAQ,WAAW;AAEnC,SAASC,iCAAiC,QAAQ,oBAAoB;AACtE,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,cAAc;AACvB,SAASC,IAAI,EAAEC,OAAO;AACtB,SACEC,GAAG,EACHC,OAAO,IAAIC,WAAW;AAGxB,MAAMC,QAAQ,GAAGV,OAAO,CAACW,MAAM,CAACC,IAAI,CAACC,OAAO,EAAE,yBAAyB,CAAC;;AAExE;AACA;AACA;AACA;AACA,OAAO,MAAMC,SAAS,GAAGC,IAAI,CAACC,KAAK,CAACjB,EAAE,CAACkB,YAAY,CAACP,QAAQ,EAAE,MAAM,CAAC,CAAC;AAEtE,OAAO,MAAMQ,aAAa,GAAGf,GAAG,CAACgB,MAAM,CAAC,CAAC,CAACC,KAAK,CAC7C,GAAGC,MAAM,CAACC,MAAM,CAACrB,iCAAiC,CACpD,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,SAASsB,SAASA,CAACC,OAAO,EAAE;EACjC,OAAO,CACLC,sBAAsB,CAAC,CAAC,EACxBC,aAAa,CAACF,OAAO,CAAC,EACtBG,cAAc,CAACH,OAAO,CAAC,EACvBI,iBAAiB,CAACJ,OAAO,CAAC,EAC1BK,wBAAwB,CAACL,OAAO,CAAC,EACjCM,sBAAsB,CAAC,CAAC,CACzB;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASJ,aAAaA,CAACF,OAAO,EAAE;EAC9B,OAAO;IACLO,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,gBAAgB;IACtBC,OAAO,EAAE,MAAAA,CAAOzB,OAAO,EAAE0B,CAAC,KAAK;MAC7B,MAAM;QAAEC;MAAM,CAAC,GAAG3B,OAAO;MACzB,MAAM4B,SAAS,GAAG,IAAIC,GAAG,CAACC,kBAAkB,CAACH,KAAK,CAACI,GAAG,CAAC,CAAC;MACxD,MAAMC,KAAK,GAAG,MAAMpC,cAAc,CAACoB,OAAO,CAAC;MAE3CY,SAAS,CAACK,YAAY,CAACC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC;MAEzC,MAAMC,aAAa,GAAG,MAAMlC,WAAW,CAAC,KAAK,EAAE2B,SAAS,CAACQ,QAAQ,CAAC,CAAC,EAAE;QACnEC,OAAO,EAAE;UACPC,aAAa,EAAE,UAAUN,KAAK;QAChC;MACF,CAAC,CAAC;MACF,MAAMO,MAAM,GAAGJ,aAAa,CAACK,OAAO;MACpC,MAAMC,WAAW,GAAGN,aAAa,CAACO,GAAG,CAACL,OAAO,CAAC,cAAc,CAAC;MAC7D,MAAMM,QAAQ,GAAGjB,CAAC,CAACiB,QAAQ,CAACJ,MAAM,CAAC;MAEnC,IAAIE,WAAW,EAAE;QACfE,QAAQ,CAACC,IAAI,CAACH,WAAW,CAAC;MAC5B;MAEA,OAAOE,QAAQ;IACjB,CAAC;IACD3B,OAAO,EAAE;MACP6B,IAAI,EAAE,KAAK;MACXC,QAAQ,EAAE;QACRnB,KAAK,EAAEhC,GAAG,CAACoD,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJjB,GAAG,EAAEpC,GAAG,CAACgB,MAAM,CAAC,CAAC,CAACsC,QAAQ,CAAC;QAC7B,CAAC,CAAC,CACDC,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS/B,cAAcA,CAACH,OAAO,EAAE;EAC/B,OAAO;IACLO,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,2BAA2B;IACjCC,OAAO,EAAE,MAAAA,CAAOzB,OAAO,EAAE0B,CAAC,KAAK;MAC7B,MAAM;QAAEyB,CAAC;QAAEC,CAAC;QAAEC;MAAE,CAAC,GAAGrD,OAAO,CAACsD,MAAM;MAClC,MAAMtB,KAAK,GAAG,MAAMpC,cAAc,CAACoB,OAAO,CAAC;MAE3C,MAAMe,GAAG,GAAG,6CAA6CoB,CAAC,IAAIC,CAAC,IAAIC,CAAC,eAAe;MAEnF,MAAME,SAAS,GAAG,iCAAmCxD,GAAI;MAEzD,MAAM;QAAEyC,OAAO;QAAEE;MAAI,CAAC,GAAG,MAAMa,SAAS,CAACxB,GAAG,EAAE;QAC5CM,OAAO,EAAE;UACPC,aAAa,EAAE,UAAUN,KAAK,EAAE;UAChCwB,MAAM,EAAE;QACV,CAAC;QACDC,IAAI,EAAE,KAAK;QACXC,MAAM,EAAE;MACV,CAAC,CAAC;MAEF,IAAIhB,GAAG,CAACiB,UAAU,IAAIjB,GAAG,CAACiB,UAAU,KAAKjE,WAAW,CAACkE,EAAE,CAACC,OAAO,CAAC,CAAC,EAAE;QACjE,OAAOnC,CAAC,CAACiB,QAAQ,CAAC,mBAAmB,CAAC,CAACmB,IAAI,CAACpB,GAAG,CAACiB,UAAU,CAAC;MAC7D;MAEA,OAAOjC,CAAC,CACLiB,QAAQ,CAACH,OAAO,CAAC,CACjBI,IAAI,CAAC,wBAAwB,CAAC,CAC9BmB,MAAM,CAAC,eAAe,EAAE,uBAAuB,CAAC;IACrD,CAAC;IACD/C,OAAO,EAAE;MACP6B,IAAI,EAAE;IACR;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASzB,iBAAiBA,CAACJ,OAAO,EAAE;EAClC,OAAO;IACLO,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,oBAAoB;IAC1B,MAAMC,OAAOA,CAACzB,OAAO,EAAEgE,EAAE,EAAE;MACzB,MAAM;QAAErC;MAAM,CAAC,GAAG3B,OAAO;MACzB,MAAMiE,IAAI,GAAG,MAAMpE,IAAI,CAAC8B,KAAK,CAACA,KAAK,EAAEX,OAAO,CAACkD,oBAAoB,CAAC;MAElE,OAAOD,IAAI;IACb,CAAC;IACDjD,OAAO,EAAE;MACP6B,IAAI,EAAE,KAAK;MACXC,QAAQ,EAAE;QACRnB,KAAK,EAAEhC,GAAG,CAACoD,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJrB,KAAK,EAAEhC,GAAG,CAACgB,MAAM,CAAC,CAAC,CAACsC,QAAQ,CAAC;QAC/B,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS5B,wBAAwBA,CAACL,OAAO,EAAE;EACzC,OAAO;IACLO,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,4BAA4B;IAClC,MAAMC,OAAOA,CAACzB,OAAO,EAAEgE,EAAE,EAAE;MACzB,MAAM;QAAErC;MAAM,CAAC,GAAG3B,OAAO;MACzB,MAAMiE,IAAI,GAAG,MAAMnE,OAAO,CACxB6B,KAAK,CAACwC,OAAO,EACbxC,KAAK,CAACyC,QAAQ,EACdpD,OAAO,CAACkD,oBACV,CAAC;MAED,OAAOD,IAAI;IACb,CAAC;IACDjD,OAAO,EAAE;MACP6B,IAAI,EAAE,KAAK;MACXC,QAAQ,EAAE;QACRnB,KAAK,EAAEhC,GAAG,CAACoD,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJmB,OAAO,EAAExE,GAAG,CAAC0E,MAAM,CAAC,CAAC,CAACpB,QAAQ,CAAC,CAAC;UAChCmB,QAAQ,EAAEzE,GAAG,CAAC0E,MAAM,CAAC,CAAC,CAACpB,QAAQ,CAAC;QAClC,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,SAAShC,sBAAsBA,CAAA,EAAG;EAChC,OAAO;IACLM,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,uBAAuB;IAC7BR,OAAO,EAAE;MACP6B,IAAI,EAAE,KAAK;MACXpB,OAAO,EAAE;QACP6C,SAAS,EAAE;UACT9C,IAAI,EAAEhC,OAAO,CAACW,MAAM,CAACC,IAAI,CAACC,OAAO,EAAE,OAAO;QAC5C;MACF;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,SAASiB,sBAAsBA,CAAA,EAAG;EAChC,OAAO;IACLC,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,6BAA6B;IACnCC,OAAO,EAAGzB,OAAO,IAAK;MACpB,MAAM;QAAEuE,IAAI;QAAEC;MAAK,CAAC,GAAGxE,OAAO,CAAC2B,KAAK;MAEpC,IAAI4C,IAAI,EAAE;QACR,OAAO;UACL,GAAGjE,SAAS;UACZmE,QAAQ,EAAEnE,SAAS,CAACmE,QAAQ,CAACC,MAAM,CAAEC,OAAO,IAAKA,OAAO,CAACC,EAAE,KAAKL,IAAI;QACtE,CAAC;MACH;MAEA,IAAIC,IAAI,EAAE;QACR,OAAO;UACL,GAAGlE,SAAS;UACZmE,QAAQ,EAAEnE,SAAS,CAACmE,QAAQ,CAACC,MAAM,CAAEC,OAAO,IAAKA,OAAO,CAACC,EAAE,KAAKJ,IAAI;QACtE,CAAC;MACH;MAEA,OAAOlE,SAAS;IAClB,CAAC;IACDU,OAAO,EAAE;MACP6B,IAAI,EAAE,KAAK;MACXC,QAAQ,EAAE;QACRnB,KAAK,EAAEhC,GAAG,CAACoD,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJuB,IAAI,EAAE7D,aAAa,CAACwC,QAAQ,CAAC,CAAC;UAC9BsB,IAAI,EAAE9D,aAAa,CAACwC,QAAQ,CAAC;QAC/B,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":["fs","resolve","GeospatialFieldOptionsCountryEnum","StatusCodes","Joi","getAccessToken","find","get","request","httpRequest","filePath","import","meta","dirname","countries","JSON","parse","readFileSync","countrySchema","string","valid","Object","values","getRoutes","options","mapStyleResourceRoutes","mapProxyRoute","tileProxyRoute","geocodeProxyRoute","getGeospatialCountries","method","path","handler","h","query","targetUrl","URL","decodeURIComponent","url","token","searchParams","set","proxyResponse","toString","headers","Authorization","buffer","payload","contentType","res","response","type","auth","validate","object","keys","required","optional","z","y","x","params","getBuffer","Accept","json","gunzip","statusCode","OK","valueOf","code","header","_h","data","ordnanceSurveyApiKey","directory","omit","only","features","filter","feature","id"],"sources":["../../../../../src/server/plugins/map/routes/index.js"],"sourcesContent":["import fs from 'node:fs'\nimport { resolve } from 'node:path'\n\nimport { GeospatialFieldOptionsCountryEnum } from '@defra/forms-model'\nimport { StatusCodes } from 'http-status-codes'\nimport Joi from 'joi'\n\nimport { getAccessToken } from '~/src/server/plugins/map/routes/get-os-token.js'\nimport { find } from '~/src/server/plugins/map/service.js'\nimport {\n  get,\n  request as httpRequest\n} from '~/src/server/services/httpService.js'\n\nconst filePath = resolve(import.meta.dirname, './vts/countries.geojson')\n\n/**\n * @type {FeatureCollection}\n */\n// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\nexport const countries = JSON.parse(fs.readFileSync(filePath, 'utf8'))\n\nexport const countrySchema = Joi.string().valid(\n  ...Object.values(GeospatialFieldOptionsCountryEnum)\n)\n\n/**\n * Gets the map support routes\n * @param {MapConfiguration} options - ordnance survey names api key\n */\nexport function getRoutes(options) {\n  return [\n    mapStyleResourceRoutes(),\n    mapProxyRoute(options),\n    tileProxyRoute(options),\n    geocodeProxyRoute(options),\n    getGeospatialCountries()\n  ]\n}\n\n/**\n * Proxies ordnance survey requests from the front end to api.os.com\n * Used for the VTS map source by forwarding on the request\n * and adding the auth token and SRS (spatial reference system)\n * @param {MapConfiguration} options - the map options\n * @returns {ServerRoute<MapProxyGetRequestRefs>}\n */\nfunction mapProxyRoute(options) {\n  return {\n    method: 'GET',\n    path: '/api/map-proxy',\n    handler: async (request, h) => {\n      const { query } = request\n      const targetUrl = new URL(decodeURIComponent(query.url))\n      const token = await getAccessToken(options)\n\n      targetUrl.searchParams.set('srs', '3857')\n\n      const proxyResponse = await httpRequest('get', targetUrl.toString(), {\n        headers: {\n          Authorization: `Bearer ${token}`\n        }\n      })\n      const buffer = proxyResponse.payload\n      const contentType = proxyResponse.res.headers['content-type']\n      const response = h.response(buffer)\n\n      if (contentType) {\n        response.type(contentType)\n      }\n\n      return response\n    },\n    options: {\n      auth: false,\n      validate: {\n        query: Joi.object()\n          .keys({\n            url: Joi.string().required()\n          })\n          .optional()\n      }\n    }\n  }\n}\n\n/**\n * Proxies ordnance survey requests from the front end to api.os.uk\n * Used for VTS map tiles forwarding on the request and adding the auth token\n * @param {MapConfiguration} options - the map options\n * @returns {ServerRoute<MapProxyGetRequestRefs>}\n */\nfunction tileProxyRoute(options) {\n  return {\n    method: 'GET',\n    path: '/api/tile/{z}/{y}/{x}.pbf',\n    handler: async (request, h) => {\n      const { z, y, x } = request.params\n      const token = await getAccessToken(options)\n\n      const url = `https://api.os.uk/maps/vector/v1/vts/tile/${z}/${y}/${x}.pbf?srs=3857`\n\n      const getBuffer = /** @type {typeof get<Buffer>} */ (get)\n\n      const { payload, res } = await getBuffer(url, {\n        headers: {\n          Authorization: `Bearer ${token}`,\n          Accept: 'application/x-protobuf'\n        },\n        json: false,\n        gunzip: true\n      })\n\n      if (res.statusCode && res.statusCode !== StatusCodes.OK.valueOf()) {\n        return h.response('Tile fetch failed').code(res.statusCode)\n      }\n\n      return h\n        .response(payload)\n        .type('application/x-protobuf')\n        .header('Cache-Control', 'public, max-age=86400')\n    },\n    options: {\n      auth: false\n    }\n  }\n}\n\n/**\n * Proxies ordnance survey geocode requests from the front end to api.os.uk\n * Used for the gazzeteer address lookup to find name from query strings like postcode and place names\n * @param {MapConfiguration} options - the map options\n * @returns {ServerRoute<MapGeocodeGetRequestRefs>}\n */\nfunction geocodeProxyRoute(options) {\n  return {\n    method: 'GET',\n    path: '/api/geocode-proxy',\n    async handler(request, _h) {\n      const { query } = request\n      const data = await find(query.query, options.ordnanceSurveyApiKey)\n\n      return data\n    },\n    options: {\n      auth: false,\n      validate: {\n        query: Joi.object()\n          .keys({\n            query: Joi.string().required()\n          })\n          .required()\n      }\n    }\n  }\n}\n\n/**\n * Resource routes to return sprites and glyphs\n * @returns {ServerRoute<MapProxyGetRequestRefs>}\n */\nfunction mapStyleResourceRoutes() {\n  return {\n    method: 'GET',\n    path: '/api/maps/vts/{path*}',\n    options: {\n      auth: false,\n      handler: {\n        directory: {\n          path: resolve(import.meta.dirname, './vts')\n        }\n      }\n    }\n  }\n}\n\n/**\n * Resource routes to return sprites and glyphs\n * @returns {ServerRoute<GeospatialCountriesGetRequestRefs>}\n */\nfunction getGeospatialCountries() {\n  return {\n    method: 'GET',\n    path: '/api/maps/countries.geojson',\n    handler: (request) => {\n      const { omit, only } = request.query\n\n      if (omit) {\n        return {\n          ...countries,\n          features: countries.features.filter((feature) => feature.id !== omit)\n        }\n      }\n\n      if (only) {\n        return {\n          ...countries,\n          features: countries.features.filter((feature) => feature.id === only)\n        }\n      }\n\n      return countries\n    },\n    options: {\n      auth: false,\n      validate: {\n        query: Joi.object()\n          .keys({\n            omit: countrySchema.optional(),\n            only: countrySchema.optional()\n          })\n          .optional()\n      }\n    }\n  }\n}\n\n/**\n * @import { ServerRoute } from '@hapi/hapi'\n * @import { FeatureCollection } from 'geojson'\n * @import { MapConfiguration, MapProxyGetRequestRefs, MapGeocodeGetRequestRefs, MapReverseGeocodeGetRequestRefs, GeospatialCountriesGetRequestRefs } from '~/src/server/plugins/map/types.js'\n */\n"],"mappings":"AAAA,OAAOA,EAAE,MAAM,SAAS;AACxB,SAASC,OAAO,QAAQ,WAAW;AAEnC,SAASC,iCAAiC,QAAQ,oBAAoB;AACtE,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,cAAc;AACvB,SAASC,IAAI;AACb,SACEC,GAAG,EACHC,OAAO,IAAIC,WAAW;AAGxB,MAAMC,QAAQ,GAAGT,OAAO,CAACU,MAAM,CAACC,IAAI,CAACC,OAAO,EAAE,yBAAyB,CAAC;;AAExE;AACA;AACA;AACA;AACA,OAAO,MAAMC,SAAS,GAAGC,IAAI,CAACC,KAAK,CAAChB,EAAE,CAACiB,YAAY,CAACP,QAAQ,EAAE,MAAM,CAAC,CAAC;AAEtE,OAAO,MAAMQ,aAAa,GAAGd,GAAG,CAACe,MAAM,CAAC,CAAC,CAACC,KAAK,CAC7C,GAAGC,MAAM,CAACC,MAAM,CAACpB,iCAAiC,CACpD,CAAC;;AAED;AACA;AACA;AACA;AACA,OAAO,SAASqB,SAASA,CAACC,OAAO,EAAE;EACjC,OAAO,CACLC,sBAAsB,CAAC,CAAC,EACxBC,aAAa,CAACF,OAAO,CAAC,EACtBG,cAAc,CAACH,OAAO,CAAC,EACvBI,iBAAiB,CAACJ,OAAO,CAAC,EAC1BK,sBAAsB,CAAC,CAAC,CACzB;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASH,aAAaA,CAACF,OAAO,EAAE;EAC9B,OAAO;IACLM,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,gBAAgB;IACtBC,OAAO,EAAE,MAAAA,CAAOxB,OAAO,EAAEyB,CAAC,KAAK;MAC7B,MAAM;QAAEC;MAAM,CAAC,GAAG1B,OAAO;MACzB,MAAM2B,SAAS,GAAG,IAAIC,GAAG,CAACC,kBAAkB,CAACH,KAAK,CAACI,GAAG,CAAC,CAAC;MACxD,MAAMC,KAAK,GAAG,MAAMlC,cAAc,CAACmB,OAAO,CAAC;MAE3CW,SAAS,CAACK,YAAY,CAACC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC;MAEzC,MAAMC,aAAa,GAAG,MAAMjC,WAAW,CAAC,KAAK,EAAE0B,SAAS,CAACQ,QAAQ,CAAC,CAAC,EAAE;QACnEC,OAAO,EAAE;UACPC,aAAa,EAAE,UAAUN,KAAK;QAChC;MACF,CAAC,CAAC;MACF,MAAMO,MAAM,GAAGJ,aAAa,CAACK,OAAO;MACpC,MAAMC,WAAW,GAAGN,aAAa,CAACO,GAAG,CAACL,OAAO,CAAC,cAAc,CAAC;MAC7D,MAAMM,QAAQ,GAAGjB,CAAC,CAACiB,QAAQ,CAACJ,MAAM,CAAC;MAEnC,IAAIE,WAAW,EAAE;QACfE,QAAQ,CAACC,IAAI,CAACH,WAAW,CAAC;MAC5B;MAEA,OAAOE,QAAQ;IACjB,CAAC;IACD1B,OAAO,EAAE;MACP4B,IAAI,EAAE,KAAK;MACXC,QAAQ,EAAE;QACRnB,KAAK,EAAE9B,GAAG,CAACkD,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJjB,GAAG,EAAElC,GAAG,CAACe,MAAM,CAAC,CAAC,CAACqC,QAAQ,CAAC;QAC7B,CAAC,CAAC,CACDC,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS9B,cAAcA,CAACH,OAAO,EAAE;EAC/B,OAAO;IACLM,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,2BAA2B;IACjCC,OAAO,EAAE,MAAAA,CAAOxB,OAAO,EAAEyB,CAAC,KAAK;MAC7B,MAAM;QAAEyB,CAAC;QAAEC,CAAC;QAAEC;MAAE,CAAC,GAAGpD,OAAO,CAACqD,MAAM;MAClC,MAAMtB,KAAK,GAAG,MAAMlC,cAAc,CAACmB,OAAO,CAAC;MAE3C,MAAMc,GAAG,GAAG,6CAA6CoB,CAAC,IAAIC,CAAC,IAAIC,CAAC,eAAe;MAEnF,MAAME,SAAS,GAAG,iCAAmCvD,GAAI;MAEzD,MAAM;QAAEwC,OAAO;QAAEE;MAAI,CAAC,GAAG,MAAMa,SAAS,CAACxB,GAAG,EAAE;QAC5CM,OAAO,EAAE;UACPC,aAAa,EAAE,UAAUN,KAAK,EAAE;UAChCwB,MAAM,EAAE;QACV,CAAC;QACDC,IAAI,EAAE,KAAK;QACXC,MAAM,EAAE;MACV,CAAC,CAAC;MAEF,IAAIhB,GAAG,CAACiB,UAAU,IAAIjB,GAAG,CAACiB,UAAU,KAAK/D,WAAW,CAACgE,EAAE,CAACC,OAAO,CAAC,CAAC,EAAE;QACjE,OAAOnC,CAAC,CAACiB,QAAQ,CAAC,mBAAmB,CAAC,CAACmB,IAAI,CAACpB,GAAG,CAACiB,UAAU,CAAC;MAC7D;MAEA,OAAOjC,CAAC,CACLiB,QAAQ,CAACH,OAAO,CAAC,CACjBI,IAAI,CAAC,wBAAwB,CAAC,CAC9BmB,MAAM,CAAC,eAAe,EAAE,uBAAuB,CAAC;IACrD,CAAC;IACD9C,OAAO,EAAE;MACP4B,IAAI,EAAE;IACR;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASxB,iBAAiBA,CAACJ,OAAO,EAAE;EAClC,OAAO;IACLM,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,oBAAoB;IAC1B,MAAMC,OAAOA,CAACxB,OAAO,EAAE+D,EAAE,EAAE;MACzB,MAAM;QAAErC;MAAM,CAAC,GAAG1B,OAAO;MACzB,MAAMgE,IAAI,GAAG,MAAMlE,IAAI,CAAC4B,KAAK,CAACA,KAAK,EAAEV,OAAO,CAACiD,oBAAoB,CAAC;MAElE,OAAOD,IAAI;IACb,CAAC;IACDhD,OAAO,EAAE;MACP4B,IAAI,EAAE,KAAK;MACXC,QAAQ,EAAE;QACRnB,KAAK,EAAE9B,GAAG,CAACkD,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJrB,KAAK,EAAE9B,GAAG,CAACe,MAAM,CAAC,CAAC,CAACqC,QAAQ,CAAC;QAC/B,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,SAAS/B,sBAAsBA,CAAA,EAAG;EAChC,OAAO;IACLK,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,uBAAuB;IAC7BP,OAAO,EAAE;MACP4B,IAAI,EAAE,KAAK;MACXpB,OAAO,EAAE;QACP0C,SAAS,EAAE;UACT3C,IAAI,EAAE9B,OAAO,CAACU,MAAM,CAACC,IAAI,CAACC,OAAO,EAAE,OAAO;QAC5C;MACF;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA,SAASgB,sBAAsBA,CAAA,EAAG;EAChC,OAAO;IACLC,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,6BAA6B;IACnCC,OAAO,EAAGxB,OAAO,IAAK;MACpB,MAAM;QAAEmE,IAAI;QAAEC;MAAK,CAAC,GAAGpE,OAAO,CAAC0B,KAAK;MAEpC,IAAIyC,IAAI,EAAE;QACR,OAAO;UACL,GAAG7D,SAAS;UACZ+D,QAAQ,EAAE/D,SAAS,CAAC+D,QAAQ,CAACC,MAAM,CAAEC,OAAO,IAAKA,OAAO,CAACC,EAAE,KAAKL,IAAI;QACtE,CAAC;MACH;MAEA,IAAIC,IAAI,EAAE;QACR,OAAO;UACL,GAAG9D,SAAS;UACZ+D,QAAQ,EAAE/D,SAAS,CAAC+D,QAAQ,CAACC,MAAM,CAAEC,OAAO,IAAKA,OAAO,CAACC,EAAE,KAAKJ,IAAI;QACtE,CAAC;MACH;MAEA,OAAO9D,SAAS;IAClB,CAAC;IACDU,OAAO,EAAE;MACP4B,IAAI,EAAE,KAAK;MACXC,QAAQ,EAAE;QACRnB,KAAK,EAAE9B,GAAG,CAACkD,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJoB,IAAI,EAAEzD,aAAa,CAACuC,QAAQ,CAAC,CAAC;UAC9BmB,IAAI,EAAE1D,aAAa,CAACuC,QAAQ,CAAC;QAC/B,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/map/service.d.ts

@@ -4,11 +4,4 @@
  * @param {string} apiKey - the OS api key
  */
 export function find(query: string, apiKey: string): Promise<OsNamesFindResponse>;
-/**
- * OS names search nearest by E/N
- * @param {number} easting - the easting
- * @param {number} northing - the northing
- * @param {string} apiKey - the OS api key
- */
-export function nearest(easting: number, northing: number, apiKey: string): Promise<OsNamesFindResponse>;
 import type { OsNamesFindResponse } from '../../../server/plugins/map/types.js';

package/.server/server/plugins/map/service.js

@@ -60,18 +60,6 @@ export async function find(query, apiKey) {
   return getData(url, endpoint);
 }
 
-/**
- * OS names search nearest by E/N
- * @param {number} easting - the easting
- * @param {number} northing - the northing
- * @param {string} apiKey - the OS api key
- */
-export async function nearest(easting, northing, apiKey) {
-  const endpoint = 'nearest';
-  const url = `https://api.os.uk/search/names/v1/nearest?key=${apiKey}&point=${easting},${northing}&radius=1000&fq=local_type:Airfield%20local_type:Airport%20local_type:Bus_Station%20local_type:Chemical_Works%20local_type:City%20local_type:Coach_Station%20local_type:Electricity_Distribution%20local_type:Electricity_Production%20local_type:Further_Education%20local_type:Gas_Distribution_or_Storage%20local_type:Hamlet%20local_type:Harbour%20local_type:Helicopter_Station%20local_type:Heliport%20local_type:Higher_or_University_Education%20local_type:Hill_Or_Mountain%20local_type:Hospice%20local_type:Hospital%20local_type:Medical_Care_Accommodation%20local_type:Named_Road%20local_type:Non_State_Primary_Education%20local_type:Non_State_Secondary_Education%20local_type:Other_Settlement%20local_type:Passenger_Ferry_Terminal%20local_type:Port_Consisting_of_Docks_and_Nautical_Berthing%20local_type:Postcode%20local_type:Primary_Education%20local_type:Railway_Station%20local_type:Road_User_Services%20local_type:Secondary_Education%20local_type:Section_Of_Named_Road%20local_type:Section_Of_Numbered_Road%20local_type:Special_Needs_Education%20local_type:Suburban_Area%20local_type:Town%20local_type:Urban_Greenspace%20local_type:Vehicular_Ferry_Terminal%20local_type:Vehicular_Rail_Terminal%20local_type:Village%20local_type:Waterfall%20`;
-  return getData(url, endpoint);
-}
-
 /**
  * @import { OsNamesFindResponse, OsNamesFindResult } from '../../../server/plugins/map/types.js'
  */

package/.server/server/plugins/map/service.js.map

@@ -1 +1 @@
-{"version":3,"file":"service.js","names":["getErrorMessage","Boom","logger","getJson","empty","results","header","logErrorAndReturnEmpty","err","endpoint","boomData","isBoom","data","msg","payload","error","message","getData","url","getJsonByType","response","find","query","apiKey","nearest","easting","northing"],"sources":["../../../../src/server/plugins/map/service.js"],"sourcesContent":["import { getErrorMessage } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\n\nimport { logger } from '~/src/server/common/helpers/logging/logger.js'\nimport { getJson } from '~/src/server/services/httpService.js'\n\n/**\n * Returns an empty result set\n */\nfunction empty() {\n  /** @type {OsNamesFindResult[]} */\n  const results = []\n\n  return /** @type {OsNamesFindResponse} */ ({ header: {}, results })\n}\n\n/**\n * Logs OS names errors\n * @param {unknown} err - the error\n * @param {string} endpoint - the OS api endpoint\n */\nfunction logErrorAndReturnEmpty(err, endpoint) {\n  /** @type {{ payload?: { error?: { message?: string } } } | false} */\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n  const boomData = Boom.isBoom(err) && err.data\n  const msg = `${getErrorMessage(err)} ${(boomData && boomData.payload?.error?.message) ?? ''}`\n\n  logger.error(err, `Exception occured calling OS names ${endpoint} - ${msg}}`)\n\n  return empty()\n}\n\n/**\n * Fetch data from OS names API\n * @param {string} url - the url to get address json data from\n * @param {string} endpoint - the url endpoint description for logging\n */\nasync function getData(url, endpoint) {\n  const getJsonByType = /** @type {typeof getJson<OsNamesFindResponse>} */ (\n    getJson\n  )\n\n  try {\n    const response = await getJsonByType(url)\n\n    if (response.error) {\n      return logErrorAndReturnEmpty(response.error, endpoint)\n    }\n\n    const results = response.payload\n\n    return results\n  } catch (err) {\n    return logErrorAndReturnEmpty(err, endpoint)\n  }\n}\n\n/**\n * OS names search find by query\n * @param {string} query - the search term\n * @param {string} apiKey - the OS api key\n */\nexport async function find(query, apiKey) {\n  const endpoint = 'find'\n  const url = `https://api.os.uk/search/names/v1/find?key=${apiKey}&query=${query}&fq=local_type:postcode%20local_type:hamlet%20local_type:village%20local_type:town%20local_type:city%20local_type:other_settlement&maxresults=8`\n\n  return getData(url, endpoint)\n}\n\n/**\n * OS names search nearest by E/N\n * @param {number} easting - the easting\n * @param {number} northing - the northing\n * @param {string} apiKey - the OS api key\n */\nexport async function nearest(easting, northing, apiKey) {\n  const endpoint = 'nearest'\n  const url = `https://api.os.uk/search/names/v1/nearest?key=${apiKey}&point=${easting},${northing}&radius=1000&fq=local_type:Airfield%20local_type:Airport%20local_type:Bus_Station%20local_type:Chemical_Works%20local_type:City%20local_type:Coach_Station%20local_type:Electricity_Distribution%20local_type:Electricity_Production%20local_type:Further_Education%20local_type:Gas_Distribution_or_Storage%20local_type:Hamlet%20local_type:Harbour%20local_type:Helicopter_Station%20local_type:Heliport%20local_type:Higher_or_University_Education%20local_type:Hill_Or_Mountain%20local_type:Hospice%20local_type:Hospital%20local_type:Medical_Care_Accommodation%20local_type:Named_Road%20local_type:Non_State_Primary_Education%20local_type:Non_State_Secondary_Education%20local_type:Other_Settlement%20local_type:Passenger_Ferry_Terminal%20local_type:Port_Consisting_of_Docks_and_Nautical_Berthing%20local_type:Postcode%20local_type:Primary_Education%20local_type:Railway_Station%20local_type:Road_User_Services%20local_type:Secondary_Education%20local_type:Section_Of_Named_Road%20local_type:Section_Of_Numbered_Road%20local_type:Special_Needs_Education%20local_type:Suburban_Area%20local_type:Town%20local_type:Urban_Greenspace%20local_type:Vehicular_Ferry_Terminal%20local_type:Vehicular_Rail_Terminal%20local_type:Village%20local_type:Waterfall%20`\n\n  return getData(url, endpoint)\n}\n\n/**\n * @import { OsNamesFindResponse, OsNamesFindResult } from '~/src/server/plugins/map/types.js'\n */\n"],"mappings":"AAAA,SAASA,eAAe,QAAQ,oBAAoB;AACpD,OAAOC,IAAI,MAAM,YAAY;AAE7B,SAASC,MAAM;AACf,SAASC,OAAO;;AAEhB;AACA;AACA;AACA,SAASC,KAAKA,CAAA,EAAG;EACf;EACA,MAAMC,OAAO,GAAG,EAAE;EAElB,OAAO,kCAAoC;IAAEC,MAAM,EAAE,CAAC,CAAC;IAAED;EAAQ,CAAC;AACpE;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASE,sBAAsBA,CAACC,GAAG,EAAEC,QAAQ,EAAE;EAC7C;EACA;EACA,MAAMC,QAAQ,GAAGT,IAAI,CAACU,MAAM,CAACH,GAAG,CAAC,IAAIA,GAAG,CAACI,IAAI;EAC7C,MAAMC,GAAG,GAAG,GAAGb,eAAe,CAACQ,GAAG,CAAC,IAAI,CAACE,QAAQ,IAAIA,QAAQ,CAACI,OAAO,EAAEC,KAAK,EAAEC,OAAO,KAAK,EAAE,EAAE;EAE7Fd,MAAM,CAACa,KAAK,CAACP,GAAG,EAAE,sCAAsCC,QAAQ,MAAMI,GAAG,GAAG,CAAC;EAE7E,OAAOT,KAAK,CAAC,CAAC;AAChB;;AAEA;AACA;AACA;AACA;AACA;AACA,eAAea,OAAOA,CAACC,GAAG,EAAET,QAAQ,EAAE;EACpC,MAAMU,aAAa,GAAG;EACpBhB,OACD;EAED,IAAI;IACF,MAAMiB,QAAQ,GAAG,MAAMD,aAAa,CAACD,GAAG,CAAC;IAEzC,IAAIE,QAAQ,CAACL,KAAK,EAAE;MAClB,OAAOR,sBAAsB,CAACa,QAAQ,CAACL,KAAK,EAAEN,QAAQ,CAAC;IACzD;IAEA,MAAMJ,OAAO,GAAGe,QAAQ,CAACN,OAAO;IAEhC,OAAOT,OAAO;EAChB,CAAC,CAAC,OAAOG,GAAG,EAAE;IACZ,OAAOD,sBAAsB,CAACC,GAAG,EAAEC,QAAQ,CAAC;EAC9C;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeY,IAAIA,CAACC,KAAK,EAAEC,MAAM,EAAE;EACxC,MAAMd,QAAQ,GAAG,MAAM;EACvB,MAAMS,GAAG,GAAG,8CAA8CK,MAAM,UAAUD,KAAK,iJAAiJ;EAEhO,OAAOL,OAAO,CAACC,GAAG,EAAET,QAAQ,CAAC;AAC/B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAee,OAAOA,CAACC,OAAO,EAAEC,QAAQ,EAAEH,MAAM,EAAE;EACvD,MAAMd,QAAQ,GAAG,SAAS;EAC1B,MAAMS,GAAG,GAAG,iDAAiDK,MAAM,UAAUE,OAAO,IAAIC,QAAQ,4tCAA4tC;EAE5zC,OAAOT,OAAO,CAACC,GAAG,EAAET,QAAQ,CAAC;AAC/B;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"service.js","names":["getErrorMessage","Boom","logger","getJson","empty","results","header","logErrorAndReturnEmpty","err","endpoint","boomData","isBoom","data","msg","payload","error","message","getData","url","getJsonByType","response","find","query","apiKey"],"sources":["../../../../src/server/plugins/map/service.js"],"sourcesContent":["import { getErrorMessage } from '@defra/forms-model'\nimport Boom from '@hapi/boom'\n\nimport { logger } from '~/src/server/common/helpers/logging/logger.js'\nimport { getJson } from '~/src/server/services/httpService.js'\n\n/**\n * Returns an empty result set\n */\nfunction empty() {\n  /** @type {OsNamesFindResult[]} */\n  const results = []\n\n  return /** @type {OsNamesFindResponse} */ ({ header: {}, results })\n}\n\n/**\n * Logs OS names errors\n * @param {unknown} err - the error\n * @param {string} endpoint - the OS api endpoint\n */\nfunction logErrorAndReturnEmpty(err, endpoint) {\n  /** @type {{ payload?: { error?: { message?: string } } } | false} */\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n  const boomData = Boom.isBoom(err) && err.data\n  const msg = `${getErrorMessage(err)} ${(boomData && boomData.payload?.error?.message) ?? ''}`\n\n  logger.error(err, `Exception occured calling OS names ${endpoint} - ${msg}}`)\n\n  return empty()\n}\n\n/**\n * Fetch data from OS names API\n * @param {string} url - the url to get address json data from\n * @param {string} endpoint - the url endpoint description for logging\n */\nasync function getData(url, endpoint) {\n  const getJsonByType = /** @type {typeof getJson<OsNamesFindResponse>} */ (\n    getJson\n  )\n\n  try {\n    const response = await getJsonByType(url)\n\n    if (response.error) {\n      return logErrorAndReturnEmpty(response.error, endpoint)\n    }\n\n    const results = response.payload\n\n    return results\n  } catch (err) {\n    return logErrorAndReturnEmpty(err, endpoint)\n  }\n}\n\n/**\n * OS names search find by query\n * @param {string} query - the search term\n * @param {string} apiKey - the OS api key\n */\nexport async function find(query, apiKey) {\n  const endpoint = 'find'\n  const url = `https://api.os.uk/search/names/v1/find?key=${apiKey}&query=${query}&fq=local_type:postcode%20local_type:hamlet%20local_type:village%20local_type:town%20local_type:city%20local_type:other_settlement&maxresults=8`\n\n  return getData(url, endpoint)\n}\n\n/**\n * @import { OsNamesFindResponse, OsNamesFindResult } from '~/src/server/plugins/map/types.js'\n */\n"],"mappings":"AAAA,SAASA,eAAe,QAAQ,oBAAoB;AACpD,OAAOC,IAAI,MAAM,YAAY;AAE7B,SAASC,MAAM;AACf,SAASC,OAAO;;AAEhB;AACA;AACA;AACA,SAASC,KAAKA,CAAA,EAAG;EACf;EACA,MAAMC,OAAO,GAAG,EAAE;EAElB,OAAO,kCAAoC;IAAEC,MAAM,EAAE,CAAC,CAAC;IAAED;EAAQ,CAAC;AACpE;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASE,sBAAsBA,CAACC,GAAG,EAAEC,QAAQ,EAAE;EAC7C;EACA;EACA,MAAMC,QAAQ,GAAGT,IAAI,CAACU,MAAM,CAACH,GAAG,CAAC,IAAIA,GAAG,CAACI,IAAI;EAC7C,MAAMC,GAAG,GAAG,GAAGb,eAAe,CAACQ,GAAG,CAAC,IAAI,CAACE,QAAQ,IAAIA,QAAQ,CAACI,OAAO,EAAEC,KAAK,EAAEC,OAAO,KAAK,EAAE,EAAE;EAE7Fd,MAAM,CAACa,KAAK,CAACP,GAAG,EAAE,sCAAsCC,QAAQ,MAAMI,GAAG,GAAG,CAAC;EAE7E,OAAOT,KAAK,CAAC,CAAC;AAChB;;AAEA;AACA;AACA;AACA;AACA;AACA,eAAea,OAAOA,CAACC,GAAG,EAAET,QAAQ,EAAE;EACpC,MAAMU,aAAa,GAAG;EACpBhB,OACD;EAED,IAAI;IACF,MAAMiB,QAAQ,GAAG,MAAMD,aAAa,CAACD,GAAG,CAAC;IAEzC,IAAIE,QAAQ,CAACL,KAAK,EAAE;MAClB,OAAOR,sBAAsB,CAACa,QAAQ,CAACL,KAAK,EAAEN,QAAQ,CAAC;IACzD;IAEA,MAAMJ,OAAO,GAAGe,QAAQ,CAACN,OAAO;IAEhC,OAAOT,OAAO;EAChB,CAAC,CAAC,OAAOG,GAAG,EAAE;IACZ,OAAOD,sBAAsB,CAACC,GAAG,EAAEC,QAAQ,CAAC;EAC9C;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeY,IAAIA,CAACC,KAAK,EAAEC,MAAM,EAAE;EACxC,MAAMd,QAAQ,GAAG,MAAM;EACvB,MAAMS,GAAG,GAAG,8CAA8CK,MAAM,UAAUD,KAAK,iJAAiJ;EAEhO,OAAOL,OAAO,CAACC,GAAG,EAAET,QAAQ,CAAC;AAC/B;;AAEA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/map/service.test.js

@@ -1,7 +1,6 @@
 import Boom from '@hapi/boom';
 import * as service from "./service.js";
 import { result as findResult } from "./test/__stubs__/find.js";
-import { result as nearestResult } from "./test/__stubs__/nearest.js";
 import { getJson } from "../../services/httpService.js";
 jest.mock("../../services/httpService.ts");
 describe('Maps service', () => {
@@ -70,48 +69,6 @@ describe('Maps service', () => {
       expect(results).toEqual([]);
     });
   });
-  describe('nearest', () => {
-    it('should return entries', async () => {
-      jest.mocked(getJson).mockResolvedValueOnce({
-        res: (/** @type {IncomingMessage} */{
-          statusCode: 200,
-          headers: {}
-        }),
-        payload: nearestResult,
-        error: undefined
-      });
-      const {
-        results
-      } = await service.nearest(700000, 1300000, 'apikey');
-      expect(results).toHaveLength(1);
-      expect(results.at(0)).toEqual({
-        GAZETTEER_ENTRY: {
-          ID: 'NW26XE',
-          NAMES_URI: 'http://data.ordnancesurvey.co.uk/id/postcodeunit/NW26XE',
-          NAME1: 'NW2 6XE',
-          TYPE: 'other',
-          LOCAL_TYPE: 'Postcode',
-          GEOMETRY_X: 523065,
-          GEOMETRY_Y: 185795,
-          MOST_DETAIL_VIEW_RES: 3500,
-          LEAST_DETAIL_VIEW_RES: 18000,
-          POPULATED_PLACE: 'London',
-          POPULATED_PLACE_URI: 'http://data.ordnancesurvey.co.uk/id/4000000074813508',
-          POPULATED_PLACE_TYPE: 'http://www.ordnancesurvey.co.uk/xml/codelists/localtype.xml#city',
-          DISTRICT_BOROUGH: 'Brent',
-          DISTRICT_BOROUGH_URI: 'http://data.ordnancesurvey.co.uk/id/7000000000011447',
-          DISTRICT_BOROUGH_TYPE: 'http://data.ordnancesurvey.co.uk/ontology/admingeo/LondonBorough',
-          COUNTY_UNITARY: 'Greater London',
-          COUNTY_UNITARY_URI: 'http://data.ordnancesurvey.co.uk/id/7000000000041441',
-          COUNTY_UNITARY_TYPE: 'http://data.ordnancesurvey.co.uk/ontology/admingeo/GreaterLondonAuthority',
-          REGION: 'London',
-          REGION_URI: 'http://data.ordnancesurvey.co.uk/id/7000000000041428',
-          COUNTRY: 'England',
-          COUNTRY_URI: 'http://data.ordnancesurvey.co.uk/id/country/england'
-        }
-      });
-    });
-  });
 });
 
 /**

package/.server/server/plugins/map/service.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"service.test.js","names":["Boom","service","result","findResult","nearestResult","getJson","jest","mock","describe","it","mocked","mockResolvedValueOnce","res","statusCode","headers","payload","error","undefined","results","find","expect","toHaveLength","at","toEqual","GAZETTEER_ENTRY","ID","NAMES_URI","NAME1","TYPE","LOCAL_TYPE","GEOMETRY_X","GEOMETRY_Y","MOST_DETAIL_VIEW_RES","LEAST_DETAIL_VIEW_RES","POPULATED_PLACE","POPULATED_PLACE_URI","POPULATED_PLACE_TYPE","DISTRICT_BOROUGH","DISTRICT_BOROUGH_URI","DISTRICT_BOROUGH_TYPE","COUNTY_UNITARY","COUNTY_UNITARY_URI","COUNTY_UNITARY_TYPE","REGION","REGION_URI","COUNTRY","COUNTRY_URI","Error","mockRejectedValueOnce","badRequest","nearest"],"sources":["../../../../src/server/plugins/map/service.test.js"],"sourcesContent":["import Boom from '@hapi/boom'\n\nimport * as service from '~/src/server/plugins/map/service.js'\nimport { result as findResult } from '~/src/server/plugins/map/test/__stubs__/find.js'\nimport { result as nearestResult } from '~/src/server/plugins/map/test/__stubs__/nearest.js'\nimport { getJson } from '~/src/server/services/httpService.js'\n\njest.mock('~/src/server/services/httpService.ts')\n\ndescribe('Maps service', () => {\n  describe('find', () => {\n    it('should return entires', async () => {\n      jest.mocked(getJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: findResult,\n        error: undefined\n      })\n\n      const { results } = await service.find('NW1 6XE', 'apikey')\n\n      expect(results).toHaveLength(8)\n      expect(results.at(1)).toEqual({\n        GAZETTEER_ENTRY: {\n          ID: 'NW26XE',\n          NAMES_URI: 'http://data.ordnancesurvey.co.uk/id/postcodeunit/NW26XE',\n          NAME1: 'NW2 6XE',\n          TYPE: 'other',\n          LOCAL_TYPE: 'Postcode',\n          GEOMETRY_X: 523065,\n          GEOMETRY_Y: 185795,\n          MOST_DETAIL_VIEW_RES: 3500,\n          LEAST_DETAIL_VIEW_RES: 18000,\n          POPULATED_PLACE: 'London',\n          POPULATED_PLACE_URI:\n            'http://data.ordnancesurvey.co.uk/id/4000000074813508',\n          POPULATED_PLACE_TYPE:\n            'http://www.ordnancesurvey.co.uk/xml/codelists/localtype.xml#city',\n          DISTRICT_BOROUGH: 'Brent',\n          DISTRICT_BOROUGH_URI:\n            'http://data.ordnancesurvey.co.uk/id/7000000000011447',\n          DISTRICT_BOROUGH_TYPE:\n            'http://data.ordnancesurvey.co.uk/ontology/admingeo/LondonBorough',\n          COUNTY_UNITARY: 'Greater London',\n          COUNTY_UNITARY_URI:\n            'http://data.ordnancesurvey.co.uk/id/7000000000041441',\n          COUNTY_UNITARY_TYPE:\n            'http://data.ordnancesurvey.co.uk/ontology/admingeo/GreaterLondonAuthority',\n          REGION: 'London',\n          REGION_URI: 'http://data.ordnancesurvey.co.uk/id/7000000000041428',\n          COUNTRY: 'England',\n          COUNTRY_URI: 'http://data.ordnancesurvey.co.uk/id/country/england'\n        }\n      })\n    })\n\n    it('should return an empty response when an error is encountered', async () => {\n      jest.mocked(getJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 300,\n          headers: {}\n        }),\n        payload: undefined,\n        error: new Error('Unknown error')\n      })\n\n      const { results } = await service.find('NW1 6XE', 'apikey')\n\n      expect(results).toHaveLength(0)\n      expect(results).toEqual([])\n    })\n\n    it('should return an empty response when a non 200 response is encountered', async () => {\n      jest\n        .mocked(getJson)\n        .mockRejectedValueOnce(\n          Boom.badRequest(\n            'OS API error',\n            new Error('Invalid postcode segments')\n          )\n        )\n\n      const { results } = await service.find('invalid postcode', 'apikey')\n\n      expect(results).toHaveLength(0)\n      expect(results).toEqual([])\n    })\n  })\n\n  describe('nearest', () => {\n    it('should return entries', async () => {\n      jest.mocked(getJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: nearestResult,\n        error: undefined\n      })\n\n      const { results } = await service.nearest(700000, 1300000, 'apikey')\n\n      expect(results).toHaveLength(1)\n      expect(results.at(0)).toEqual({\n        GAZETTEER_ENTRY: {\n          ID: 'NW26XE',\n          NAMES_URI: 'http://data.ordnancesurvey.co.uk/id/postcodeunit/NW26XE',\n          NAME1: 'NW2 6XE',\n          TYPE: 'other',\n          LOCAL_TYPE: 'Postcode',\n          GEOMETRY_X: 523065,\n          GEOMETRY_Y: 185795,\n          MOST_DETAIL_VIEW_RES: 3500,\n          LEAST_DETAIL_VIEW_RES: 18000,\n          POPULATED_PLACE: 'London',\n          POPULATED_PLACE_URI:\n            'http://data.ordnancesurvey.co.uk/id/4000000074813508',\n          POPULATED_PLACE_TYPE:\n            'http://www.ordnancesurvey.co.uk/xml/codelists/localtype.xml#city',\n          DISTRICT_BOROUGH: 'Brent',\n          DISTRICT_BOROUGH_URI:\n            'http://data.ordnancesurvey.co.uk/id/7000000000011447',\n          DISTRICT_BOROUGH_TYPE:\n            'http://data.ordnancesurvey.co.uk/ontology/admingeo/LondonBorough',\n          COUNTY_UNITARY: 'Greater London',\n          COUNTY_UNITARY_URI:\n            'http://data.ordnancesurvey.co.uk/id/7000000000041441',\n          COUNTY_UNITARY_TYPE:\n            'http://data.ordnancesurvey.co.uk/ontology/admingeo/GreaterLondonAuthority',\n          REGION: 'London',\n          REGION_URI: 'http://data.ordnancesurvey.co.uk/id/7000000000041428',\n          COUNTRY: 'England',\n          COUNTRY_URI: 'http://data.ordnancesurvey.co.uk/id/country/england'\n        }\n      })\n    })\n  })\n})\n\n/**\n * @import  { IncomingMessage } from 'node:http'\n */\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAE7B,OAAO,KAAKC,OAAO;AACnB,SAASC,MAAM,IAAIC,UAAU;AAC7B,SAASD,MAAM,IAAIE,aAAa;AAChC,SAASC,OAAO;AAEhBC,IAAI,CAACC,IAAI,gCAAuC,CAAC;AAEjDC,QAAQ,CAAC,cAAc,EAAE,MAAM;EAC7BA,QAAQ,CAAC,MAAM,EAAE,MAAM;IACrBC,EAAE,CAAC,uBAAuB,EAAE,YAAY;MACtCH,IAAI,CAACI,MAAM,CAACL,OAAO,CAAC,CAACM,qBAAqB,CAAC;QACzCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEZ,UAAU;QACnBa,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAM;QAAEC;MAAQ,CAAC,GAAG,MAAMjB,OAAO,CAACkB,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC;MAE3DC,MAAM,CAACF,OAAO,CAAC,CAACG,YAAY,CAAC,CAAC,CAAC;MAC/BD,MAAM,CAACF,OAAO,CAACI,EAAE,CAAC,CAAC,CAAC,CAAC,CAACC,OAAO,CAAC;QAC5BC,eAAe,EAAE;UACfC,EAAE,EAAE,QAAQ;UACZC,SAAS,EAAE,yDAAyD;UACpEC,KAAK,EAAE,SAAS;UAChBC,IAAI,EAAE,OAAO;UACbC,UAAU,EAAE,UAAU;UACtBC,UAAU,EAAE,MAAM;UAClBC,UAAU,EAAE,MAAM;UAClBC,oBAAoB,EAAE,IAAI;UAC1BC,qBAAqB,EAAE,KAAK;UAC5BC,eAAe,EAAE,QAAQ;UACzBC,mBAAmB,EACjB,sDAAsD;UACxDC,oBAAoB,EAClB,kEAAkE;UACpEC,gBAAgB,EAAE,OAAO;UACzBC,oBAAoB,EAClB,sDAAsD;UACxDC,qBAAqB,EACnB,kEAAkE;UACpEC,cAAc,EAAE,gBAAgB;UAChCC,kBAAkB,EAChB,sDAAsD;UACxDC,mBAAmB,EACjB,2EAA2E;UAC7EC,MAAM,EAAE,QAAQ;UAChBC,UAAU,EAAE,sDAAsD;UAClEC,OAAO,EAAE,SAAS;UAClBC,WAAW,EAAE;QACf;MACF,CAAC,CAAC;IACJ,CAAC,CAAC;IAEFrC,EAAE,CAAC,8DAA8D,EAAE,YAAY;MAC7EH,IAAI,CAACI,MAAM,CAACL,OAAO,CAAC,CAACM,qBAAqB,CAAC;QACzCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEE,SAAS;QAClBD,KAAK,EAAE,IAAI+B,KAAK,CAAC,eAAe;MAClC,CAAC,CAAC;MAEF,MAAM;QAAE7B;MAAQ,CAAC,GAAG,MAAMjB,OAAO,CAACkB,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC;MAE3DC,MAAM,CAACF,OAAO,CAAC,CAACG,YAAY,CAAC,CAAC,CAAC;MAC/BD,MAAM,CAACF,OAAO,CAAC,CAACK,OAAO,CAAC,EAAE,CAAC;IAC7B,CAAC,CAAC;IAEFd,EAAE,CAAC,wEAAwE,EAAE,YAAY;MACvFH,IAAI,CACDI,MAAM,CAACL,OAAO,CAAC,CACf2C,qBAAqB,CACpBhD,IAAI,CAACiD,UAAU,CACb,cAAc,EACd,IAAIF,KAAK,CAAC,2BAA2B,CACvC,CACF,CAAC;MAEH,MAAM;QAAE7B;MAAQ,CAAC,GAAG,MAAMjB,OAAO,CAACkB,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC;MAEpEC,MAAM,CAACF,OAAO,CAAC,CAACG,YAAY,CAAC,CAAC,CAAC;MAC/BD,MAAM,CAACF,OAAO,CAAC,CAACK,OAAO,CAAC,EAAE,CAAC;IAC7B,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFf,QAAQ,CAAC,SAAS,EAAE,MAAM;IACxBC,EAAE,CAAC,uBAAuB,EAAE,YAAY;MACtCH,IAAI,CAACI,MAAM,CAACL,OAAO,CAAC,CAACM,qBAAqB,CAAC;QACzCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEX,aAAa;QACtBY,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAM;QAAEC;MAAQ,CAAC,GAAG,MAAMjB,OAAO,CAACiD,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;MAEpE9B,MAAM,CAACF,OAAO,CAAC,CAACG,YAAY,CAAC,CAAC,CAAC;MAC/BD,MAAM,CAACF,OAAO,CAACI,EAAE,CAAC,CAAC,CAAC,CAAC,CAACC,OAAO,CAAC;QAC5BC,eAAe,EAAE;UACfC,EAAE,EAAE,QAAQ;UACZC,SAAS,EAAE,yDAAyD;UACpEC,KAAK,EAAE,SAAS;UAChBC,IAAI,EAAE,OAAO;UACbC,UAAU,EAAE,UAAU;UACtBC,UAAU,EAAE,MAAM;UAClBC,UAAU,EAAE,MAAM;UAClBC,oBAAoB,EAAE,IAAI;UAC1BC,qBAAqB,EAAE,KAAK;UAC5BC,eAAe,EAAE,QAAQ;UACzBC,mBAAmB,EACjB,sDAAsD;UACxDC,oBAAoB,EAClB,kEAAkE;UACpEC,gBAAgB,EAAE,OAAO;UACzBC,oBAAoB,EAClB,sDAAsD;UACxDC,qBAAqB,EACnB,kEAAkE;UACpEC,cAAc,EAAE,gBAAgB;UAChCC,kBAAkB,EAChB,sDAAsD;UACxDC,mBAAmB,EACjB,2EAA2E;UAC7EC,MAAM,EAAE,QAAQ;UAChBC,UAAU,EAAE,sDAAsD;UAClEC,OAAO,EAAE,SAAS;UAClBC,WAAW,EAAE;QACf;MACF,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"service.test.js","names":["Boom","service","result","findResult","getJson","jest","mock","describe","it","mocked","mockResolvedValueOnce","res","statusCode","headers","payload","error","undefined","results","find","expect","toHaveLength","at","toEqual","GAZETTEER_ENTRY","ID","NAMES_URI","NAME1","TYPE","LOCAL_TYPE","GEOMETRY_X","GEOMETRY_Y","MOST_DETAIL_VIEW_RES","LEAST_DETAIL_VIEW_RES","POPULATED_PLACE","POPULATED_PLACE_URI","POPULATED_PLACE_TYPE","DISTRICT_BOROUGH","DISTRICT_BOROUGH_URI","DISTRICT_BOROUGH_TYPE","COUNTY_UNITARY","COUNTY_UNITARY_URI","COUNTY_UNITARY_TYPE","REGION","REGION_URI","COUNTRY","COUNTRY_URI","Error","mockRejectedValueOnce","badRequest"],"sources":["../../../../src/server/plugins/map/service.test.js"],"sourcesContent":["import Boom from '@hapi/boom'\n\nimport * as service from '~/src/server/plugins/map/service.js'\nimport { result as findResult } from '~/src/server/plugins/map/test/__stubs__/find.js'\nimport { getJson } from '~/src/server/services/httpService.js'\n\njest.mock('~/src/server/services/httpService.ts')\n\ndescribe('Maps service', () => {\n  describe('find', () => {\n    it('should return entires', async () => {\n      jest.mocked(getJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: findResult,\n        error: undefined\n      })\n\n      const { results } = await service.find('NW1 6XE', 'apikey')\n\n      expect(results).toHaveLength(8)\n      expect(results.at(1)).toEqual({\n        GAZETTEER_ENTRY: {\n          ID: 'NW26XE',\n          NAMES_URI: 'http://data.ordnancesurvey.co.uk/id/postcodeunit/NW26XE',\n          NAME1: 'NW2 6XE',\n          TYPE: 'other',\n          LOCAL_TYPE: 'Postcode',\n          GEOMETRY_X: 523065,\n          GEOMETRY_Y: 185795,\n          MOST_DETAIL_VIEW_RES: 3500,\n          LEAST_DETAIL_VIEW_RES: 18000,\n          POPULATED_PLACE: 'London',\n          POPULATED_PLACE_URI:\n            'http://data.ordnancesurvey.co.uk/id/4000000074813508',\n          POPULATED_PLACE_TYPE:\n            'http://www.ordnancesurvey.co.uk/xml/codelists/localtype.xml#city',\n          DISTRICT_BOROUGH: 'Brent',\n          DISTRICT_BOROUGH_URI:\n            'http://data.ordnancesurvey.co.uk/id/7000000000011447',\n          DISTRICT_BOROUGH_TYPE:\n            'http://data.ordnancesurvey.co.uk/ontology/admingeo/LondonBorough',\n          COUNTY_UNITARY: 'Greater London',\n          COUNTY_UNITARY_URI:\n            'http://data.ordnancesurvey.co.uk/id/7000000000041441',\n          COUNTY_UNITARY_TYPE:\n            'http://data.ordnancesurvey.co.uk/ontology/admingeo/GreaterLondonAuthority',\n          REGION: 'London',\n          REGION_URI: 'http://data.ordnancesurvey.co.uk/id/7000000000041428',\n          COUNTRY: 'England',\n          COUNTRY_URI: 'http://data.ordnancesurvey.co.uk/id/country/england'\n        }\n      })\n    })\n\n    it('should return an empty response when an error is encountered', async () => {\n      jest.mocked(getJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 300,\n          headers: {}\n        }),\n        payload: undefined,\n        error: new Error('Unknown error')\n      })\n\n      const { results } = await service.find('NW1 6XE', 'apikey')\n\n      expect(results).toHaveLength(0)\n      expect(results).toEqual([])\n    })\n\n    it('should return an empty response when a non 200 response is encountered', async () => {\n      jest\n        .mocked(getJson)\n        .mockRejectedValueOnce(\n          Boom.badRequest(\n            'OS API error',\n            new Error('Invalid postcode segments')\n          )\n        )\n\n      const { results } = await service.find('invalid postcode', 'apikey')\n\n      expect(results).toHaveLength(0)\n      expect(results).toEqual([])\n    })\n  })\n})\n\n/**\n * @import  { IncomingMessage } from 'node:http'\n */\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAE7B,OAAO,KAAKC,OAAO;AACnB,SAASC,MAAM,IAAIC,UAAU;AAC7B,SAASC,OAAO;AAEhBC,IAAI,CAACC,IAAI,gCAAuC,CAAC;AAEjDC,QAAQ,CAAC,cAAc,EAAE,MAAM;EAC7BA,QAAQ,CAAC,MAAM,EAAE,MAAM;IACrBC,EAAE,CAAC,uBAAuB,EAAE,YAAY;MACtCH,IAAI,CAACI,MAAM,CAACL,OAAO,CAAC,CAACM,qBAAqB,CAAC;QACzCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEX,UAAU;QACnBY,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAM;QAAEC;MAAQ,CAAC,GAAG,MAAMhB,OAAO,CAACiB,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC;MAE3DC,MAAM,CAACF,OAAO,CAAC,CAACG,YAAY,CAAC,CAAC,CAAC;MAC/BD,MAAM,CAACF,OAAO,CAACI,EAAE,CAAC,CAAC,CAAC,CAAC,CAACC,OAAO,CAAC;QAC5BC,eAAe,EAAE;UACfC,EAAE,EAAE,QAAQ;UACZC,SAAS,EAAE,yDAAyD;UACpEC,KAAK,EAAE,SAAS;UAChBC,IAAI,EAAE,OAAO;UACbC,UAAU,EAAE,UAAU;UACtBC,UAAU,EAAE,MAAM;UAClBC,UAAU,EAAE,MAAM;UAClBC,oBAAoB,EAAE,IAAI;UAC1BC,qBAAqB,EAAE,KAAK;UAC5BC,eAAe,EAAE,QAAQ;UACzBC,mBAAmB,EACjB,sDAAsD;UACxDC,oBAAoB,EAClB,kEAAkE;UACpEC,gBAAgB,EAAE,OAAO;UACzBC,oBAAoB,EAClB,sDAAsD;UACxDC,qBAAqB,EACnB,kEAAkE;UACpEC,cAAc,EAAE,gBAAgB;UAChCC,kBAAkB,EAChB,sDAAsD;UACxDC,mBAAmB,EACjB,2EAA2E;UAC7EC,MAAM,EAAE,QAAQ;UAChBC,UAAU,EAAE,sDAAsD;UAClEC,OAAO,EAAE,SAAS;UAClBC,WAAW,EAAE;QACf;MACF,CAAC,CAAC;IACJ,CAAC,CAAC;IAEFrC,EAAE,CAAC,8DAA8D,EAAE,YAAY;MAC7EH,IAAI,CAACI,MAAM,CAACL,OAAO,CAAC,CAACM,qBAAqB,CAAC;QACzCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEE,SAAS;QAClBD,KAAK,EAAE,IAAI+B,KAAK,CAAC,eAAe;MAClC,CAAC,CAAC;MAEF,MAAM;QAAE7B;MAAQ,CAAC,GAAG,MAAMhB,OAAO,CAACiB,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC;MAE3DC,MAAM,CAACF,OAAO,CAAC,CAACG,YAAY,CAAC,CAAC,CAAC;MAC/BD,MAAM,CAACF,OAAO,CAAC,CAACK,OAAO,CAAC,EAAE,CAAC;IAC7B,CAAC,CAAC;IAEFd,EAAE,CAAC,wEAAwE,EAAE,YAAY;MACvFH,IAAI,CACDI,MAAM,CAACL,OAAO,CAAC,CACf2C,qBAAqB,CACpB/C,IAAI,CAACgD,UAAU,CACb,cAAc,EACd,IAAIF,KAAK,CAAC,2BAA2B,CACvC,CACF,CAAC;MAEH,MAAM;QAAE7B;MAAQ,CAAC,GAAG,MAAMhB,OAAO,CAACiB,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC;MAEpEC,MAAM,CAACF,OAAO,CAAC,CAACG,YAAY,CAAC,CAAC,CAAC;MAC/BD,MAAM,CAACF,OAAO,CAAC,CAACK,OAAO,CAAC,EAAE,CAAC;IAC7B,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.14.3",
+  "version": "4.15.0",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -130,6 +130,7 @@
     "joi": "^17.13.3",
     "liquidjs": "^10.24.0",
     "lodash": "^4.17.21",
+    "maplibre-gl": "^5.24.0",
     "marked": "^15.0.12",
     "nunjucks": "^3.2.4",
     "obscenity": "^0.4.5",

package/src/client/javascripts/geospatial-map.js

@@ -1,3 +1,9 @@
+// @ts-expect-error - no types
+import createDatasetsPlugin from '@defra/interactive-map/plugins/datasets'
+// @ts-expect-error - no types
+import { maplibreLayerAdapter } from '@defra/interactive-map/plugins/datasets/adapters/maplibre'
+// @ts-expect-error - no types
+import createDrawPlugin from '@defra/interactive-map/plugins/draw-ml'
 import { bbox } from '@turf/bbox'
 
 import {
@@ -151,9 +157,6 @@ export function getBoundingBox(geojson) {
  * @param {number} index - the 0-based index
  */
 export function processGeospatial(config, geospatial, index) {
-  // @ts-expect-error - Defra namespace currently comes from UMD support files
-  const defra = window.defra
-
   if (!(geospatial instanceof HTMLDivElement)) {
     return
   }
@@ -166,14 +169,15 @@ export function processGeospatial(config, geospatial, index) {
   const { listEl, mapId } = createContainers(geospatialInput, index)
   const geojson = getGeoJSON(geospatialInput)
   const bounds = geojson.features.length ? getBoundingBox(geojson) : undefined
-  const drawPlugin = defra.drawMLPlugin()
+  const drawPlugin = createDrawPlugin()
   const plugins = [drawPlugin]
   const country = geospatial.dataset.country
 
   if (country) {
     // Add the country bounds as a dataset plugin to show the valid area on the map
     // and provide feedback to the user when they add features outside of the bounds.
-    const datasetsPlugin = defra.datasetsMaplibrePlugin({
+    const datasetsPlugin = createDatasetsPlugin({
+      layerAdapter: maplibreLayerAdapter,
       datasets: [
         {
           id: 'invalid-area',