@defra/forms-engine-plugin 4.0.42 → 4.0.43

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

@@ -2,17 +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> | {
-    method: string;
-    path: string;
-    options: {
-        handler: {
-            directory: {
-                path: string;
-            };
-        };
-    };
-})[];
+export function getRoutes(options: MapConfiguration): (ServerRoute<MapProxyGetRequestRefs> | ServerRoute<MapGeocodeGetRequestRefs> | ServerRoute<MapReverseGeocodeGetRequestRefs>)[];
 import type { MapConfiguration } from '~/src/server/plugins/map/types.js';
 import type { MapProxyGetRequestRefs } from '~/src/server/plugins/map/types.js';
 import type { ServerRoute } from '@hapi/hapi';

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

@@ -1,20 +1,22 @@
 import { resolve } from 'node:path';
+import { StatusCodes } from 'http-status-codes';
 import Joi from 'joi';
+import { getAccessToken } from "./get-os-token.js";
 import { find, nearest } from "../service.js";
-import { request as httpRequest } from "../../../services/httpService.js";
+import { get, request as httpRequest } from "../../../services/httpService.js";
 
 /**
  * Gets the map support routes
  * @param {MapConfiguration} options - ordnance survey names api key
  */
 export function getRoutes(options) {
-  return [mapProxyRoute(options), geocodeProxyRoute(options), reverseGeocodeProxyRoute(options), ...tileRoutes()];
+  return [mapStyleResourceRoutes(), mapProxyRoute(options), tileProxyRoute(options), geocodeProxyRoute(options), reverseGeocodeProxyRoute(options)];
 }
 
 /**
  * Proxies ordnance survey requests from the front end to api.os.com
- * Used for VTS map tiles, sprites and fonts by forwarding on the request
- * and adding the apikey and optionally an SRS (spatial reference system)
+ * Used for the VTS map source by forwarding on the request
+ * and adding the auth token and SRS (spatial reference system)
  * @param {MapConfiguration} options - the map options
  * @returns {ServerRoute<MapProxyGetRequestRefs>}
  */
@@ -27,13 +29,13 @@ function mapProxyRoute(options) {
         query
       } = request;
       const targetUrl = new URL(decodeURIComponent(query.url));
-
-      // Add API key server-side and set SRS
-      targetUrl.searchParams.set('key', options.ordnanceSurveyApiKey);
-      if (!targetUrl.searchParams.has('srs')) {
-        targetUrl.searchParams.set('srs', '3857');
-      }
-      const proxyResponse = await httpRequest('get', targetUrl.toString());
+      const token = await getAccessToken(options);
+      targetUrl.searchParams.set('srs', '3857');
+      const proxyResponse = await httpRequest('get', targetUrl.toString(), {
+        headers: {
+          Authorization: `Bearer ${token}`
+        }
+      });
       const buffer = proxyResponse.payload;
       const contentType = proxyResponse.res.headers['content-type'];
       const response = h.response(buffer);
@@ -53,7 +55,44 @@ function mapProxyRoute(options) {
 }
 
 /**
- * Proxies ordnance survey geocode requests from the front end to api.os.com
+ * Proxies ordnance survey requests from the front end to api.os.uk
+ * Used for VTS map tiles forwarding on the request and adding the auth token
+ * @param {MapConfiguration} options - the map options
+ * @returns {ServerRoute<MapProxyGetRequestRefs>}
+ */
+function tileProxyRoute(options) {
+  return {
+    method: 'GET',
+    path: '/api/tile/{z}/{y}/{x}.pbf',
+    handler: async (request, h) => {
+      const {
+        z,
+        y,
+        x
+      } = request.params;
+      const token = await getAccessToken(options);
+      const url = `https://api.os.uk/maps/vector/v1/vts/tile/${z}/${y}/${x}.pbf?srs=3857`;
+      const {
+        payload,
+        res
+      } = await get(url, {
+        headers: {
+          Authorization: `Bearer ${token}`,
+          Accept: 'application/x-protobuf'
+        },
+        json: false,
+        gunzip: true
+      });
+      if (res.statusCode && res.statusCode !== StatusCodes.OK.valueOf()) {
+        return h.response('Tile fetch failed').code(res.statusCode);
+      }
+      return h.response(payload).type('application/x-protobuf').header('Cache-Control', 'public, max-age=86400');
+    }
+  };
+}
+
+/**
+ * Proxies ordnance survey geocode requests from the front end to api.os.uk
  * Used for the gazzeteer address lookup to find name from query strings like postcode and place names
  * @param {MapConfiguration} options - the map options
  * @returns {ServerRoute<MapGeocodeGetRequestRefs>}
@@ -80,7 +119,7 @@ function geocodeProxyRoute(options) {
 }
 
 /**
- * Proxies ordnance survey reverse geocode requests from the front end to api.os.com
+ * 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
@@ -107,8 +146,13 @@ function reverseGeocodeProxyRoute(options) {
     }
   };
 }
-function tileRoutes() {
-  return [{
+
+/**
+ * Resource routes to return sprites and glyphs
+ * @returns {ServerRoute<MapProxyGetRequestRefs>}
+ */
+function mapStyleResourceRoutes() {
+  return {
     method: 'GET',
     path: '/api/maps/vts/{path*}',
     options: {
@@ -118,7 +162,7 @@ function tileRoutes() {
         }
       }
     }
-  }];
+  };
 }
 
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["resolve","Joi","find","nearest","request","httpRequest","getRoutes","options","mapProxyRoute","geocodeProxyRoute","reverseGeocodeProxyRoute","tileRoutes","method","path","handler","h","query","targetUrl","URL","decodeURIComponent","url","searchParams","set","ordnanceSurveyApiKey","has","proxyResponse","toString","buffer","payload","contentType","res","headers","response","type","validate","object","keys","string","required","optional","_h","data","easting","northing","number","directory","import","meta","dirname"],"sources":["../../../../../src/server/plugins/map/routes/index.js"],"sourcesContent":["import { resolve } from 'node:path'\n\nimport Joi from 'joi'\n\nimport { find, nearest } from '~/src/server/plugins/map/service.js'\nimport { request as httpRequest } from '~/src/server/services/httpService.js'\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    mapProxyRoute(options),\n    geocodeProxyRoute(options),\n    reverseGeocodeProxyRoute(options),\n    ...tileRoutes()\n  ]\n}\n\n/**\n * Proxies ordnance survey requests from the front end to api.os.com\n * Used for VTS map tiles, sprites and fonts by forwarding on the request\n * and adding the apikey and optionally an 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\n      // Add API key server-side and set SRS\n      targetUrl.searchParams.set('key', options.ordnanceSurveyApiKey)\n      if (!targetUrl.searchParams.has('srs')) {\n        targetUrl.searchParams.set('srs', '3857')\n      }\n\n      const proxyResponse = await httpRequest('get', targetUrl.toString())\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      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 geocode requests from the front end to api.os.com\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      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.com\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      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\nfunction tileRoutes() {\n  return [\n    {\n      method: 'GET',\n      path: '/api/maps/vts/{path*}',\n      options: {\n        handler: {\n          directory: {\n            path: resolve(import.meta.dirname, './vts')\n          }\n        }\n      }\n    }\n  ]\n}\n\n/**\n * @import { ServerRoute } from '@hapi/hapi'\n * @import { MapConfiguration, MapProxyGetRequestRefs, MapGeocodeGetRequestRefs, MapReverseGeocodeGetRequestRefs } from '~/src/server/plugins/map/types.js'\n */\n"],"mappings":"AAAA,SAASA,OAAO,QAAQ,WAAW;AAEnC,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,IAAI,EAAEC,OAAO;AACtB,SAASC,OAAO,IAAIC,WAAW;;AAE/B;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACC,OAAO,EAAE;EACjC,OAAO,CACLC,aAAa,CAACD,OAAO,CAAC,EACtBE,iBAAiB,CAACF,OAAO,CAAC,EAC1BG,wBAAwB,CAACH,OAAO,CAAC,EACjC,GAAGI,UAAU,CAAC,CAAC,CAChB;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASH,aAAaA,CAACD,OAAO,EAAE;EAC9B,OAAO;IACLK,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,gBAAgB;IACtBC,OAAO,EAAE,MAAAA,CAAOV,OAAO,EAAEW,CAAC,KAAK;MAC7B,MAAM;QAAEC;MAAM,CAAC,GAAGZ,OAAO;MACzB,MAAMa,SAAS,GAAG,IAAIC,GAAG,CAACC,kBAAkB,CAACH,KAAK,CAACI,GAAG,CAAC,CAAC;;MAExD;MACAH,SAAS,CAACI,YAAY,CAACC,GAAG,CAAC,KAAK,EAAEf,OAAO,CAACgB,oBAAoB,CAAC;MAC/D,IAAI,CAACN,SAAS,CAACI,YAAY,CAACG,GAAG,CAAC,KAAK,CAAC,EAAE;QACtCP,SAAS,CAACI,YAAY,CAACC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC;MAC3C;MAEA,MAAMG,aAAa,GAAG,MAAMpB,WAAW,CAAC,KAAK,EAAEY,SAAS,CAACS,QAAQ,CAAC,CAAC,CAAC;MACpE,MAAMC,MAAM,GAAGF,aAAa,CAACG,OAAO;MACpC,MAAMC,WAAW,GAAGJ,aAAa,CAACK,GAAG,CAACC,OAAO,CAAC,cAAc,CAAC;MAC7D,MAAMC,QAAQ,GAAGjB,CAAC,CAACiB,QAAQ,CAACL,MAAM,CAAC;MAEnC,IAAIE,WAAW,EAAE;QACfG,QAAQ,CAACC,IAAI,CAACJ,WAAW,CAAC;MAC5B;MAEA,OAAOG,QAAQ;IACjB,CAAC;IACDzB,OAAO,EAAE;MACP2B,QAAQ,EAAE;QACRlB,KAAK,EAAEf,GAAG,CAACkC,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJhB,GAAG,EAAEnB,GAAG,CAACoC,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;QAC7B,CAAC,CAAC,CACDC,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS9B,iBAAiBA,CAACF,OAAO,EAAE;EAClC,OAAO;IACLK,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,oBAAoB;IAC1B,MAAMC,OAAOA,CAACV,OAAO,EAAEoC,EAAE,EAAE;MACzB,MAAM;QAAExB;MAAM,CAAC,GAAGZ,OAAO;MACzB,MAAMqC,IAAI,GAAG,MAAMvC,IAAI,CAACc,KAAK,CAACA,KAAK,EAAET,OAAO,CAACgB,oBAAoB,CAAC;MAElE,OAAOkB,IAAI;IACb,CAAC;IACDlC,OAAO,EAAE;MACP2B,QAAQ,EAAE;QACRlB,KAAK,EAAEf,GAAG,CAACkC,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJpB,KAAK,EAAEf,GAAG,CAACoC,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;QAC/B,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS5B,wBAAwBA,CAACH,OAAO,EAAE;EACzC,OAAO;IACLK,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,4BAA4B;IAClC,MAAMC,OAAOA,CAACV,OAAO,EAAEoC,EAAE,EAAE;MACzB,MAAM;QAAExB;MAAM,CAAC,GAAGZ,OAAO;MACzB,MAAMqC,IAAI,GAAG,MAAMtC,OAAO,CACxBa,KAAK,CAAC0B,OAAO,EACb1B,KAAK,CAAC2B,QAAQ,EACdpC,OAAO,CAACgB,oBACV,CAAC;MAED,OAAOkB,IAAI;IACb,CAAC;IACDlC,OAAO,EAAE;MACP2B,QAAQ,EAAE;QACRlB,KAAK,EAAEf,GAAG,CAACkC,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJM,OAAO,EAAEzC,GAAG,CAAC2C,MAAM,CAAC,CAAC,CAACN,QAAQ,CAAC,CAAC;UAChCK,QAAQ,EAAE1C,GAAG,CAAC2C,MAAM,CAAC,CAAC,CAACN,QAAQ,CAAC;QAClC,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;AAEA,SAAS3B,UAAUA,CAAA,EAAG;EACpB,OAAO,CACL;IACEC,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,uBAAuB;IAC7BN,OAAO,EAAE;MACPO,OAAO,EAAE;QACP+B,SAAS,EAAE;UACThC,IAAI,EAAEb,OAAO,CAAC8C,MAAM,CAACC,IAAI,CAACC,OAAO,EAAE,OAAO;QAC5C;MACF;IACF;EACF,CAAC,CACF;AACH;;AAEA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":["resolve","StatusCodes","Joi","getAccessToken","find","nearest","get","request","httpRequest","getRoutes","options","mapStyleResourceRoutes","mapProxyRoute","tileProxyRoute","geocodeProxyRoute","reverseGeocodeProxyRoute","method","path","handler","h","query","targetUrl","URL","decodeURIComponent","url","token","searchParams","set","proxyResponse","toString","headers","Authorization","buffer","payload","contentType","res","response","type","validate","object","keys","string","required","optional","z","y","x","params","Accept","json","gunzip","statusCode","OK","valueOf","code","header","_h","data","ordnanceSurveyApiKey","easting","northing","number","directory","import","meta","dirname"],"sources":["../../../../../src/server/plugins/map/routes/index.js"],"sourcesContent":["import { resolve } from 'node:path'\n\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\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  ]\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      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 { payload, res } = await get(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  }\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      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      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      handler: {\n        directory: {\n          path: resolve(import.meta.dirname, './vts')\n        }\n      }\n    }\n  }\n}\n\n/**\n * @import { ServerRoute } from '@hapi/hapi'\n * @import { MapConfiguration, MapProxyGetRequestRefs, MapGeocodeGetRequestRefs, MapReverseGeocodeGetRequestRefs } from '~/src/server/plugins/map/types.js'\n */\n"],"mappings":"AAAA,SAASA,OAAO,QAAQ,WAAW;AAEnC,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;AACA;AACA;AACA;AACA,OAAO,SAASC,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,CAClC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASE,aAAaA,CAACF,OAAO,EAAE;EAC9B,OAAO;IACLM,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,gBAAgB;IACtBC,OAAO,EAAE,MAAAA,CAAOX,OAAO,EAAEY,CAAC,KAAK;MAC7B,MAAM;QAAEC;MAAM,CAAC,GAAGb,OAAO;MACzB,MAAMc,SAAS,GAAG,IAAIC,GAAG,CAACC,kBAAkB,CAACH,KAAK,CAACI,GAAG,CAAC,CAAC;MACxD,MAAMC,KAAK,GAAG,MAAMtB,cAAc,CAACO,OAAO,CAAC;MAE3CW,SAAS,CAACK,YAAY,CAACC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC;MAEzC,MAAMC,aAAa,GAAG,MAAMpB,WAAW,CAAC,KAAK,EAAEa,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,QAAQ,EAAE;QACRlB,KAAK,EAAElB,GAAG,CAACqC,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJhB,GAAG,EAAEtB,GAAG,CAACuC,MAAM,CAAC,CAAC,CAACC,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,CAAOX,OAAO,EAAEY,CAAC,KAAK;MAC7B,MAAM;QAAEyB,CAAC;QAAEC,CAAC;QAAEC;MAAE,CAAC,GAAGvC,OAAO,CAACwC,MAAM;MAClC,MAAMtB,KAAK,GAAG,MAAMtB,cAAc,CAACO,OAAO,CAAC;MAE3C,MAAMc,GAAG,GAAG,6CAA6CoB,CAAC,IAAIC,CAAC,IAAIC,CAAC,eAAe;MAEnF,MAAM;QAAEb,OAAO;QAAEE;MAAI,CAAC,GAAG,MAAM7B,GAAG,CAACkB,GAAG,EAAE;QACtCM,OAAO,EAAE;UACPC,aAAa,EAAE,UAAUN,KAAK,EAAE;UAChCuB,MAAM,EAAE;QACV,CAAC;QACDC,IAAI,EAAE,KAAK;QACXC,MAAM,EAAE;MACV,CAAC,CAAC;MAEF,IAAIf,GAAG,CAACgB,UAAU,IAAIhB,GAAG,CAACgB,UAAU,KAAKlD,WAAW,CAACmD,EAAE,CAACC,OAAO,CAAC,CAAC,EAAE;QACjE,OAAOlC,CAAC,CAACiB,QAAQ,CAAC,mBAAmB,CAAC,CAACkB,IAAI,CAACnB,GAAG,CAACgB,UAAU,CAAC;MAC7D;MAEA,OAAOhC,CAAC,CACLiB,QAAQ,CAACH,OAAO,CAAC,CACjBI,IAAI,CAAC,wBAAwB,CAAC,CAC9BkB,MAAM,CAAC,eAAe,EAAE,uBAAuB,CAAC;IACrD;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASzC,iBAAiBA,CAACJ,OAAO,EAAE;EAClC,OAAO;IACLM,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,oBAAoB;IAC1B,MAAMC,OAAOA,CAACX,OAAO,EAAEiD,EAAE,EAAE;MACzB,MAAM;QAAEpC;MAAM,CAAC,GAAGb,OAAO;MACzB,MAAMkD,IAAI,GAAG,MAAMrD,IAAI,CAACgB,KAAK,CAACA,KAAK,EAAEV,OAAO,CAACgD,oBAAoB,CAAC;MAElE,OAAOD,IAAI;IACb,CAAC;IACD/C,OAAO,EAAE;MACP4B,QAAQ,EAAE;QACRlB,KAAK,EAAElB,GAAG,CAACqC,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJpB,KAAK,EAAElB,GAAG,CAACuC,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC;QAC/B,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS3B,wBAAwBA,CAACL,OAAO,EAAE;EACzC,OAAO;IACLM,MAAM,EAAE,KAAK;IACbC,IAAI,EAAE,4BAA4B;IAClC,MAAMC,OAAOA,CAACX,OAAO,EAAEiD,EAAE,EAAE;MACzB,MAAM;QAAEpC;MAAM,CAAC,GAAGb,OAAO;MACzB,MAAMkD,IAAI,GAAG,MAAMpD,OAAO,CACxBe,KAAK,CAACuC,OAAO,EACbvC,KAAK,CAACwC,QAAQ,EACdlD,OAAO,CAACgD,oBACV,CAAC;MAED,OAAOD,IAAI;IACb,CAAC;IACD/C,OAAO,EAAE;MACP4B,QAAQ,EAAE;QACRlB,KAAK,EAAElB,GAAG,CAACqC,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJmB,OAAO,EAAEzD,GAAG,CAAC2D,MAAM,CAAC,CAAC,CAACnB,QAAQ,CAAC,CAAC;UAChCkB,QAAQ,EAAE1D,GAAG,CAAC2D,MAAM,CAAC,CAAC,CAACnB,QAAQ,CAAC;QAClC,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;MACPQ,OAAO,EAAE;QACP4C,SAAS,EAAE;UACT7C,IAAI,EAAEjB,OAAO,CAAC+D,MAAM,CAACC,IAAI,CAACC,OAAO,EAAE,OAAO;QAC5C;MACF;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA","ignoreList":[]}

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

@@ -1,5 +1,6 @@
 export type MapConfiguration = {
     ordnanceSurveyApiKey: string;
+    ordnanceSurveyApiSecret: string;
 };
 /**
  * Map proxy query params

package/.server/server/plugins/map/types.js

@@ -1,6 +1,7 @@
 /**
  * @typedef {{
  *   ordnanceSurveyApiKey: string
+ *   ordnanceSurveyApiSecret: string
  * }} MapConfiguration
  */
 

package/.server/server/plugins/map/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../src/server/plugins/map/types.js"],"sourcesContent":["/**\n * @typedef {{\n *   ordnanceSurveyApiKey: string\n * }} MapConfiguration\n */\n\n//\n// Route types\n//\n\n/**\n * Map proxy query params\n * @typedef {object} MapProxyQuery\n * @property {string} url - the proxied url\n */\n\n/**\n * Map geocode query params\n * @typedef {object} MapGeocodeQuery\n * @property {string} query - name query\n */\n\n/**\n * Map reverse geocode query params\n * @typedef {object} MapReverseGeocodeQuery\n * @property {number} easting - the Easting point\n * @property {number} northing - the Northing point\n */\n\n/**\n * Map geocode get request\n * @typedef {object} MapProxyGetRequestRefs\n * @property {MapProxyQuery} Query - Request query\n */\n\n/**\n * Map geocode get request\n * @typedef {object} MapGeocodeGetRequestRefs\n * @property {MapGeocodeQuery} Query - Request query\n */\n\n/**\n * Map reverst geocode get request\n * @typedef {object} MapReverseGeocodeGetRequestRefs\n * @property {MapReverseGeocodeQuery} Query - Request query\n */\n\n/**\n * @typedef {MapProxyGetRequestRefs} MapProxyRequestRefs\n * @typedef {MapGeocodeGetRequestRefs} MapGeocodeRequestRefs\n * @typedef {MapReverseGeocodeGetRequestRefs} MapReverseGeocodeRequestRefs\n * @typedef {Request<MapGeocodeGetRequestRefs>} MapProxyGetRequest\n * @typedef {Request<MapGeocodeGetRequestRefs>} MapGeocodeGetRequest\n * @typedef {Request<MapReverseGeocodeGetRequestRefs>} MapReverseGeocodeGetRequest\n * @typedef {MapProxyGetRequest | MapGeocodeGetRequest | MapReverseGeocodeGetRequest} MapRequest\n */\n\n//\n// Service types\n//\n\n/**\n * @typedef {object} OsNamesFindResponse\n * @property {OsNamesFindHeader} header - Metadata about the search request and results.\n * @property {OsNamesFindResult[]} results - An array of matched place records from the search.\n */\n\n/**\n * @typedef {object} OsNamesFindHeader\n * @property {string} uri - The query URI (usually same as search text).\n * @property {string} query - The original text query string passed to the API.\n * @property {string} format - The response format returned (e.g., \"JSON\").\n * @property {number} maxresults - The maximum number of results requested.\n * @property {number} offset - The offset used in the search results.\n * @property {number} totalresults - The total number of results that matched the query.\n * @property {string} filter - The original filter string passed to the API.\n */\n\n/**\n * @typedef {object} OsNamesFindGazetteerEntry\n * @property {string} ID - Unique identifier for the place/feature.\n * @property {string} NAMES_URI - A URI (identifier) for this named feature.\n * @property {string} NAME1 - Primary name of the feature.\n * @property {string} TYPE - General type classification of the feature.\n * @property {string} LOCAL_TYPE - Local or more specific type classification.\n * @property {number} GEOMETRY_X - Easting coordinate (British National Grid).\n * @property {number} GEOMETRY_Y - Northing coordinate (British National Grid).\n * @property {number} MOST_DETAIL_VIEW_RES - Most detailed resolution available.\n * @property {number} LEAST_DETAIL_VIEW_RES - Least detailed resolution available.\n * @property {number} [MBR_XMIN] - Minimum bounding box X (easting).\n * @property {number} [MBR_YMIN] - Minimum bounding box Y (northing).\n * @property {number} [MBR_XMAX] - Maximum bounding box X (easting).\n * @property {number} [MBR_YMAX] - Maximum bounding box Y (northing).\n * @property {string} [DISTRICT_BOROUGH] - (Optional) District borough.\n * @property {string} [DISTRICT_BOROUGH_URI] - (Optional) URI for the district borough.\n * @property {string} [DISTRICT_BOROUGH_TYPE] - (Optional) Type of the district borough.\n * @property {string} [POSTCODE_DISTRICT] - (Optional) Postcode district.\n * @property {string} [POSTCODE_DISTRICT_URI] - (Optional) URI for the postcode district.\n * @property {string} [POPULATED_PLACE] - (Optional) Name of associated populated place.\n * @property {string} [POPULATED_PLACE_URI] - (Optional) URI of populated place.\n * @property {string} [POPULATED_PLACE_TYPE] - (Optional) Type of populated place.\n * @property {string} [COUNTY_UNITARY] - (Optional) County or unitary authority name.\n * @property {string} [COUNTY_UNITARY_URI] - (Optional) URI for county/unitary authority.\n * @property {string} [COUNTY_UNITARY_TYPE] - (Optional) Classification of county/unitary authority.\n * @property {string} [REGION] - (Optional) Region name.\n * @property {string} [REGION_URI] - (Optional) URI for region.\n * @property {string} [COUNTRY] - (Optional) Country name.\n * @property {string} [COUNTRY_URI] - (Optional) URI for country.\n */\n\n/**\n * OS names GAZETTEER_ENTRY response\n * @typedef {object} OsNamesFindResult\n * @property {OsNamesFindGazetteerEntry} GAZETTEER_ENTRY - Gazetteer entry\n */\n\n/**\n * @import { Request } from '@hapi/hapi'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/server/plugins/map/types.js"],"sourcesContent":["/**\n * @typedef {{\n *   ordnanceSurveyApiKey: string\n *   ordnanceSurveyApiSecret: string\n * }} MapConfiguration\n */\n\n//\n// Route types\n//\n\n/**\n * Map proxy query params\n * @typedef {object} MapProxyQuery\n * @property {string} url - the proxied url\n */\n\n/**\n * Map geocode query params\n * @typedef {object} MapGeocodeQuery\n * @property {string} query - name query\n */\n\n/**\n * Map reverse geocode query params\n * @typedef {object} MapReverseGeocodeQuery\n * @property {number} easting - the Easting point\n * @property {number} northing - the Northing point\n */\n\n/**\n * Map geocode get request\n * @typedef {object} MapProxyGetRequestRefs\n * @property {MapProxyQuery} Query - Request query\n */\n\n/**\n * Map geocode get request\n * @typedef {object} MapGeocodeGetRequestRefs\n * @property {MapGeocodeQuery} Query - Request query\n */\n\n/**\n * Map reverst geocode get request\n * @typedef {object} MapReverseGeocodeGetRequestRefs\n * @property {MapReverseGeocodeQuery} Query - Request query\n */\n\n/**\n * @typedef {MapProxyGetRequestRefs} MapProxyRequestRefs\n * @typedef {MapGeocodeGetRequestRefs} MapGeocodeRequestRefs\n * @typedef {MapReverseGeocodeGetRequestRefs} MapReverseGeocodeRequestRefs\n * @typedef {Request<MapGeocodeGetRequestRefs>} MapProxyGetRequest\n * @typedef {Request<MapGeocodeGetRequestRefs>} MapGeocodeGetRequest\n * @typedef {Request<MapReverseGeocodeGetRequestRefs>} MapReverseGeocodeGetRequest\n * @typedef {MapProxyGetRequest | MapGeocodeGetRequest | MapReverseGeocodeGetRequest} MapRequest\n */\n\n//\n// Service types\n//\n\n/**\n * @typedef {object} OsNamesFindResponse\n * @property {OsNamesFindHeader} header - Metadata about the search request and results.\n * @property {OsNamesFindResult[]} results - An array of matched place records from the search.\n */\n\n/**\n * @typedef {object} OsNamesFindHeader\n * @property {string} uri - The query URI (usually same as search text).\n * @property {string} query - The original text query string passed to the API.\n * @property {string} format - The response format returned (e.g., \"JSON\").\n * @property {number} maxresults - The maximum number of results requested.\n * @property {number} offset - The offset used in the search results.\n * @property {number} totalresults - The total number of results that matched the query.\n * @property {string} filter - The original filter string passed to the API.\n */\n\n/**\n * @typedef {object} OsNamesFindGazetteerEntry\n * @property {string} ID - Unique identifier for the place/feature.\n * @property {string} NAMES_URI - A URI (identifier) for this named feature.\n * @property {string} NAME1 - Primary name of the feature.\n * @property {string} TYPE - General type classification of the feature.\n * @property {string} LOCAL_TYPE - Local or more specific type classification.\n * @property {number} GEOMETRY_X - Easting coordinate (British National Grid).\n * @property {number} GEOMETRY_Y - Northing coordinate (British National Grid).\n * @property {number} MOST_DETAIL_VIEW_RES - Most detailed resolution available.\n * @property {number} LEAST_DETAIL_VIEW_RES - Least detailed resolution available.\n * @property {number} [MBR_XMIN] - Minimum bounding box X (easting).\n * @property {number} [MBR_YMIN] - Minimum bounding box Y (northing).\n * @property {number} [MBR_XMAX] - Maximum bounding box X (easting).\n * @property {number} [MBR_YMAX] - Maximum bounding box Y (northing).\n * @property {string} [DISTRICT_BOROUGH] - (Optional) District borough.\n * @property {string} [DISTRICT_BOROUGH_URI] - (Optional) URI for the district borough.\n * @property {string} [DISTRICT_BOROUGH_TYPE] - (Optional) Type of the district borough.\n * @property {string} [POSTCODE_DISTRICT] - (Optional) Postcode district.\n * @property {string} [POSTCODE_DISTRICT_URI] - (Optional) URI for the postcode district.\n * @property {string} [POPULATED_PLACE] - (Optional) Name of associated populated place.\n * @property {string} [POPULATED_PLACE_URI] - (Optional) URI of populated place.\n * @property {string} [POPULATED_PLACE_TYPE] - (Optional) Type of populated place.\n * @property {string} [COUNTY_UNITARY] - (Optional) County or unitary authority name.\n * @property {string} [COUNTY_UNITARY_URI] - (Optional) URI for county/unitary authority.\n * @property {string} [COUNTY_UNITARY_TYPE] - (Optional) Classification of county/unitary authority.\n * @property {string} [REGION] - (Optional) Region name.\n * @property {string} [REGION_URI] - (Optional) URI for region.\n * @property {string} [COUNTRY] - (Optional) Country name.\n * @property {string} [COUNTRY_URI] - (Optional) URI for country.\n */\n\n/**\n * OS names GAZETTEER_ENTRY response\n * @typedef {object} OsNamesFindResult\n * @property {OsNamesFindGazetteerEntry} GAZETTEER_ENTRY - Gazetteer entry\n */\n\n/**\n * @import { Request } from '@hapi/hapi'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA","ignoreList":[]}

package/.server/server/types.d.ts

@@ -34,6 +34,7 @@ export interface RouteConfig {
     saveAndExit?: PluginOptions['saveAndExit'];
     cacheServiceCreator?: (server: Server) => CacheService;
     ordnanceSurveyApiKey?: string;
+    ordnanceSurveyApiSecret?: string;
 }
 export interface OutputService {
     submit: (context: FormContext, request: FormRequestPayload, model: FormModel, emailAddress: string, items: DetailItem[], submitResponse: SubmitResponsePayload, formMetadata?: FormMetadata) => Promise<void>;

package/.server/server/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { type Server } from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormMetadataById: (id: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndExit?: PluginOptions['saveAndExit']\n  cacheServiceCreator?: (server: Server) => CacheService\n  ordnanceSurveyApiKey?: string\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { type Server } from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormMetadataById: (id: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndExit?: PluginOptions['saveAndExit']\n  cacheServiceCreator?: (server: Server) => CacheService\n  ordnanceSurveyApiKey?: string\n  ordnanceSurveyApiSecret?: string\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.42",
+  "version": "4.0.43",
   "description": "Defra forms engine",
   "type": "module",
   "files": [

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

@@ -138,10 +138,18 @@ export function makeTileRequestTransformer(apiPath) {
    * @param {string} resourceType - the resource type
    */
   return function transformTileRequest(url, resourceType) {
-    // Only proxy OS API requests that don't already have a key
-    if (resourceType !== 'Style' && url.startsWith('https://api.os.uk')) {
-      const urlObj = new URL(url)
-      if (!urlObj.searchParams.has('key')) {
+    if (url.startsWith('https://api.os.uk')) {
+      if (resourceType === 'Tile') {
+        return {
+          url: url.replace(
+            'https://api.os.uk/maps/vector/v1/vts',
+            `${window.location.origin}${apiPath}`
+          ),
+          headers: {}
+        }
+      }
+
+      if (resourceType !== 'Style') {
         return {
           url: `${apiPath}/map-proxy?url=${encodeURIComponent(url)}`,
           headers: {}

package/src/server/plugins/engine/configureEnginePlugin.ts

@@ -22,7 +22,8 @@ export const configureEnginePlugin = async (
     preparePageEventRequestOptions,
     onRequest,
     saveAndExit,
-    ordnanceSurveyApiKey
+    ordnanceSurveyApiKey,
+    ordnanceSurveyApiSecret
   }: RouteConfig = {},
   cache?: CacheService
 ): Promise<{
@@ -65,7 +66,8 @@ export const configureEnginePlugin = async (
       onRequest,
       baseUrl: 'http://localhost:3009', // always runs locally
       saveAndExit,
-      ordnanceSurveyApiKey
+      ordnanceSurveyApiKey,
+      ordnanceSurveyApiSecret
     }
   }
 }

package/src/server/plugins/engine/options.js

@@ -26,7 +26,8 @@ const pluginRegistrationOptionsSchema = Joi.object({
   onRequest: Joi.function().optional(),
   baseUrl: Joi.string().uri().required(),
   saveAndExit: Joi.function().optional(),
-  ordnanceSurveyApiKey: Joi.string().optional()
+  ordnanceSurveyApiKey: Joi.string().optional(),
+  ordnanceSurveyApiSecret: Joi.string().optional()
 })
 
 /**

package/src/server/plugins/engine/plugin.ts

@@ -38,7 +38,8 @@ export const plugin = {
       viewContext,
       preparePageEventRequestOptions,
       onRequest,
-      ordnanceSurveyApiKey
+      ordnanceSurveyApiKey,
+      ordnanceSurveyApiSecret
     } = options
 
     const cacheService =
@@ -58,12 +59,13 @@ export const plugin = {
       })
     }
 
-    // Register the maps plugin only if we have an OS api key
-    if (ordnanceSurveyApiKey) {
+    // Register the maps plugin only if we have an OS api key & secret
+    if (ordnanceSurveyApiKey && ordnanceSurveyApiSecret) {
       await server.register({
         plugin: mapPlugin,
         options: {
-          ordnanceSurveyApiKey
+          ordnanceSurveyApiKey,
+          ordnanceSurveyApiSecret
         }
       })
     }

package/src/server/plugins/engine/types.ts

@@ -423,6 +423,7 @@ export interface PluginOptions {
   onRequest?: OnRequestCallback
   baseUrl: string // base URL of the application, protocol and hostname e.g. "https://myapp.com"
   ordnanceSurveyApiKey?: string
+  ordnanceSurveyApiSecret?: string
 }
 
 export interface FormAdapterSubmissionMessageMeta {

package/src/server/plugins/map/routes/get-os-token.js

@@ -0,0 +1,41 @@
+import { post } from '~/src/server/services/httpService.js'
+
+/**
+ * @type {string}
+ */
+let cachedToken
+let tokenExpiry = 0
+
+/**
+ * Get Ordnance Survey OAuth token
+ * @param {MapConfiguration} options - Ordnance survey map options
+ */
+export async function getAccessToken(options) {
+  const { ordnanceSurveyApiKey: key, ordnanceSurveyApiSecret: secret } = options
+  const now = Date.now()
+
+  if (cachedToken && now < tokenExpiry) {
+    return cachedToken
+  }
+
+  const creds = `${key}:${secret}`
+  const result = await post('https://api.os.uk/oauth2/token/v1', {
+    headers: {
+      Authorization: `Basic ${btoa(creds)}`,
+      'Content-Type': 'application/x-www-form-urlencoded'
+    },
+    payload: 'grant_type=client_credentials',
+    json: true
+  })
+
+  const data = result.payload
+
+  cachedToken = data.access_token
+  tokenExpiry = now + (data.expires_in - 60) * 1000 // refresh early
+
+  return cachedToken
+}
+
+/**
+ * @import { MapConfiguration } from '~/src/server/plugins/map/types.js'
+ */

package/src/server/plugins/map/routes/get-os-token.test.js

@@ -0,0 +1,55 @@
+import { getAccessToken } from '~/src/server/plugins/map/routes/get-os-token.js'
+import { post } from '~/src/server/services/httpService.js'
+
+jest.mock('~/src/server/services/httpService.ts')
+
+describe('OS OAuth token', () => {
+  describe('getAccessToken', () => {
+    it('should get access token', async () => {
+      jest.mocked(post).mockResolvedValueOnce({
+        res: /** @type {IncomingMessage} */ ({
+          statusCode: 200,
+          headers: {}
+        }),
+        payload: {
+          access_token: 'access_token',
+          expires_in: '299',
+          issued_at: '1770036762387',
+          token_type: 'Bearer'
+        },
+        error: undefined
+      })
+
+      const token = await getAccessToken({
+        ordnanceSurveyApiKey: 'apikey',
+        ordnanceSurveyApiSecret: 'apisecret'
+      })
+
+      expect(token).toBe('access_token')
+
+      expect(post).toHaveBeenCalledWith('https://api.os.uk/oauth2/token/v1', {
+        headers: {
+          Authorization: `Basic ${btoa('apikey:apisecret')}`,
+          'Content-Type': 'application/x-www-form-urlencoded'
+        },
+        payload: 'grant_type=client_credentials',
+        json: true
+      })
+      expect(post).toHaveBeenCalledTimes(1)
+    })
+
+    it('should return an cached token', async () => {
+      const token = await getAccessToken({
+        ordnanceSurveyApiKey: 'apikey',
+        ordnanceSurveyApiSecret: 'apisecret'
+      })
+
+      expect(token).toBe('access_token')
+      expect(post).toHaveBeenCalledTimes(0)
+    })
+  })
+})
+
+/**
+ * @import  { IncomingMessage } from 'node:http'
+ */

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

@@ -1,9 +1,14 @@
 import { resolve } from 'node:path'
 
+import { StatusCodes } from 'http-status-codes'
 import Joi from 'joi'
 
+import { getAccessToken } from '~/src/server/plugins/map/routes/get-os-token.js'
 import { find, nearest } from '~/src/server/plugins/map/service.js'
-import { request as httpRequest } from '~/src/server/services/httpService.js'
+import {
+  get,
+  request as httpRequest
+} from '~/src/server/services/httpService.js'
 
 /**
  * Gets the map support routes
@@ -11,17 +16,18 @@ import { request as httpRequest } from '~/src/server/services/httpService.js'
  */
 export function getRoutes(options) {
   return [
+    mapStyleResourceRoutes(),
     mapProxyRoute(options),
+    tileProxyRoute(options),
     geocodeProxyRoute(options),
-    reverseGeocodeProxyRoute(options),
-    ...tileRoutes()
+    reverseGeocodeProxyRoute(options)
   ]
 }
 
 /**
  * Proxies ordnance survey requests from the front end to api.os.com
- * Used for VTS map tiles, sprites and fonts by forwarding on the request
- * and adding the apikey and optionally an SRS (spatial reference system)
+ * Used for the VTS map source by forwarding on the request
+ * and adding the auth token and SRS (spatial reference system)
  * @param {MapConfiguration} options - the map options
  * @returns {ServerRoute<MapProxyGetRequestRefs>}
  */
@@ -32,14 +38,15 @@ function mapProxyRoute(options) {
     handler: async (request, h) => {
       const { query } = request
       const targetUrl = new URL(decodeURIComponent(query.url))
+      const token = await getAccessToken(options)
 
-      // Add API key server-side and set SRS
-      targetUrl.searchParams.set('key', options.ordnanceSurveyApiKey)
-      if (!targetUrl.searchParams.has('srs')) {
-        targetUrl.searchParams.set('srs', '3857')
-      }
+      targetUrl.searchParams.set('srs', '3857')
 
-      const proxyResponse = await httpRequest('get', targetUrl.toString())
+      const proxyResponse = await httpRequest('get', targetUrl.toString(), {
+        headers: {
+          Authorization: `Bearer ${token}`
+        }
+      })
       const buffer = proxyResponse.payload
       const contentType = proxyResponse.res.headers['content-type']
       const response = h.response(buffer)
@@ -63,7 +70,44 @@ function mapProxyRoute(options) {
 }
 
 /**
- * Proxies ordnance survey geocode requests from the front end to api.os.com
+ * Proxies ordnance survey requests from the front end to api.os.uk
+ * Used for VTS map tiles forwarding on the request and adding the auth token
+ * @param {MapConfiguration} options - the map options
+ * @returns {ServerRoute<MapProxyGetRequestRefs>}
+ */
+function tileProxyRoute(options) {
+  return {
+    method: 'GET',
+    path: '/api/tile/{z}/{y}/{x}.pbf',
+    handler: async (request, h) => {
+      const { z, y, x } = request.params
+      const token = await getAccessToken(options)
+
+      const url = `https://api.os.uk/maps/vector/v1/vts/tile/${z}/${y}/${x}.pbf?srs=3857`
+
+      const { payload, res } = await get(url, {
+        headers: {
+          Authorization: `Bearer ${token}`,
+          Accept: 'application/x-protobuf'
+        },
+        json: false,
+        gunzip: true
+      })
+
+      if (res.statusCode && res.statusCode !== StatusCodes.OK.valueOf()) {
+        return h.response('Tile fetch failed').code(res.statusCode)
+      }
+
+      return h
+        .response(payload)
+        .type('application/x-protobuf')
+        .header('Cache-Control', 'public, max-age=86400')
+    }
+  }
+}
+
+/**
+ * Proxies ordnance survey geocode requests from the front end to api.os.uk
  * Used for the gazzeteer address lookup to find name from query strings like postcode and place names
  * @param {MapConfiguration} options - the map options
  * @returns {ServerRoute<MapGeocodeGetRequestRefs>}
@@ -91,7 +135,7 @@ function geocodeProxyRoute(options) {
 }
 
 /**
- * Proxies ordnance survey reverse geocode requests from the front end to api.os.com
+ * 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
@@ -124,20 +168,22 @@ function reverseGeocodeProxyRoute(options) {
   }
 }
 
-function tileRoutes() {
-  return [
-    {
-      method: 'GET',
-      path: '/api/maps/vts/{path*}',
-      options: {
-        handler: {
-          directory: {
-            path: resolve(import.meta.dirname, './vts')
-          }
+/**
+ * Resource routes to return sprites and glyphs
+ * @returns {ServerRoute<MapProxyGetRequestRefs>}
+ */
+function mapStyleResourceRoutes() {
+  return {
+    method: 'GET',
+    path: '/api/maps/vts/{path*}',
+    options: {
+      handler: {
+        directory: {
+          path: resolve(import.meta.dirname, './vts')
         }
       }
     }
-  ]
+  }
 }
 
 /**

package/src/server/plugins/map/types.js

@@ -1,6 +1,7 @@
 /**
  * @typedef {{
  *   ordnanceSurveyApiKey: string
+ *   ordnanceSurveyApiSecret: string
  * }} MapConfiguration
  */
 

package/src/server/types.ts

@@ -55,6 +55,7 @@ export interface RouteConfig {
   saveAndExit?: PluginOptions['saveAndExit']
   cacheServiceCreator?: (server: Server) => CacheService
   ordnanceSurveyApiKey?: string
+  ordnanceSurveyApiSecret?: string
 }
 
 export interface OutputService {