@defra/forms-engine-plugin 4.10.0 → 4.11.0

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

@@ -33,6 +33,19 @@ export type MapReverseGeocodeQuery = {
      */
     northing: number;
 };
+/**
+ * Geospatial countries query params
+ */
+export type GeospatialCountriesQuery = {
+    /**
+     * - the country to omit
+     */
+    omit: string;
+    /**
+     * - the country to include
+     */
+    only: string;
+};
 /**
  * Map geocode get request
  */
@@ -52,7 +65,7 @@ export type MapGeocodeGetRequestRefs = {
     Query: MapGeocodeQuery;
 };
 /**
- * Map reverst geocode get request
+ * Map reverse geocode get request
  */
 export type MapReverseGeocodeGetRequestRefs = {
     /**
@@ -60,6 +73,15 @@ export type MapReverseGeocodeGetRequestRefs = {
      */
     Query: MapReverseGeocodeQuery;
 };
+/**
+ * Map countries geojson get request
+ */
+export type GeospatialCountriesGetRequestRefs = {
+    /**
+     * - Request query
+     */
+    Query: GeospatialCountriesQuery;
+};
 export type MapProxyRequestRefs = MapProxyGetRequestRefs;
 export type MapGeocodeRequestRefs = MapGeocodeGetRequestRefs;
 export type MapReverseGeocodeRequestRefs = MapReverseGeocodeGetRequestRefs;

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

@@ -28,6 +28,13 @@
  * @property {number} northing - the Northing point
  */
 
+/**
+ * Geospatial countries query params
+ * @typedef {object} GeospatialCountriesQuery
+ * @property {string} omit - the country to omit
+ * @property {string} only - the country to include
+ */
+
 /**
  * Map geocode get request
  * @typedef {object} MapProxyGetRequestRefs
@@ -41,11 +48,17 @@
  */
 
 /**
- * Map reverst geocode get request
+ * Map reverse geocode get request
  * @typedef {object} MapReverseGeocodeGetRequestRefs
  * @property {MapReverseGeocodeQuery} Query - Request query
  */
 
+/**
+ * Map countries geojson get request
+ * @typedef {object} GeospatialCountriesGetRequestRefs
+ * @property {GeospatialCountriesQuery} Query - Request query
+ */
+
 /**
  * @typedef {MapProxyGetRequestRefs} MapProxyRequestRefs
  * @typedef {MapGeocodeGetRequestRefs} MapGeocodeRequestRefs

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 *   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":[]}
+{"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 * Geospatial countries query params\n * @typedef {object} GeospatialCountriesQuery\n * @property {string} omit - the country to omit\n * @property {string} only - the country to include\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 reverse geocode get request\n * @typedef {object} MapReverseGeocodeGetRequestRefs\n * @property {MapReverseGeocodeQuery} Query - Request query\n */\n\n/**\n * Map countries geojson get request\n * @typedef {object} GeospatialCountriesGetRequestRefs\n * @property {GeospatialCountriesQuery} 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;AACA;;AAEA;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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.10.0",
+  "version": "4.11.0",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -44,9 +44,10 @@
     "dev:debug": "concurrently \"npm run client:watch\" \"npm run server:watch:debug\" --kill-others --names \"client,server\" --prefix-colors \"red.dim,blue.dim\"",
     "format": "npm run format:check -- --write",
     "format:check": "prettier --cache --cache-location .cache/prettier --cache-strategy content --check \"**/*.{cjs,js,json,md,mjs,scss,ts}\"",
+    "predocs:dev": "node scripts/generate-schema-docs.js && node scripts/generate-component-docs.js",
     "docs:dev": "BROWSERSLIST_ENV=javascripts docusaurus start --host 0.0.0.0",
     "docs:build": "BROWSERSLIST_ENV=javascripts docusaurus build",
-    "docs:build:all": "node scripts/generate-schema-docs.js && npm run docs:build",
+    "docs:build:all": "node scripts/generate-schema-docs.js && node scripts/generate-component-docs.js && npm run docs:build",
     "docs:serve": "docusaurus serve --host 0.0.0.0",
     "docs:clear": "docusaurus clear",
     "generate-schema-docs": "node scripts/generate-schema-docs.js",
@@ -78,7 +79,7 @@
       "minimatch": "3.1.5"
     },
     "serialize-javascript": ">=7.0.3",
-    "react-router": "^7.13.1"
+    "react-router": "^5.3.4"
   },
   "engines": {
     "node": ">=22.11.0 <25.0.0",
@@ -86,9 +87,9 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@defra/forms-model": "^3.0.648",
+    "@defra/forms-model": "^3.0.655",
     "@defra/hapi-tracing": "^1.29.0",
-    "@defra/interactive-map": "^0.0.17-alpha",
+    "@defra/interactive-map": "^0.0.22-alpha",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",
     "@hapi/bourne": "^3.0.0",
@@ -104,6 +105,7 @@
     "@hapi/wreck": "^18.1.0",
     "@hapi/yar": "^11.0.3",
     "@turf/bbox": "^7.3.4",
+    "@turf/boolean-within": "^7.3.5",
     "@turf/centroid": "^7.3.4",
     "@types/humanize-duration": "^3.27.4",
     "accessible-autocomplete": "^3.0.1",
@@ -143,9 +145,9 @@
     "@babel/plugin-syntax-import-attributes": "^7.27.1",
     "@babel/preset-env": "^7.28.5",
     "@babel/preset-typescript": "^7.28.5",
-    "@defra/docusaurus-theme-govuk": "^0.0.13-alpha",
-    "@docusaurus/core": "^3.9.2",
-    "@docusaurus/plugin-content-docs": "^3.9.2",
+    "@defra/docusaurus-theme-govuk": "^0.0.22-alpha",
+    "@docusaurus/core": "^3.10.1",
+    "@docusaurus/plugin-content-docs": "^3.10.1",
     "@easyops-cn/docusaurus-search-local": "^0.55.0",
     "@hapi/basic": "^7.0.2",
     "@mdx-js/react": "^3.1.1",

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

@@ -39,8 +39,8 @@ const lineFeatureProperties = {
 }
 
 const polygonFeatureProperties = {
-  stroke: 'rgba(0,112,60,1)',
-  fill: 'rgba(0,112,60,0.2)',
+  stroke: 'rgb(0, 0, 0)',
+  fill: 'rgba(255, 221, 0, 0.2)',
   strokeWidth: 2
 }
 
@@ -111,11 +111,47 @@ export function processGeospatial(config, geospatial, index) {
   const geojson = getGeoJSON(geospatialInput)
   const bounds = geojson.features.length ? getBoundingBox(geojson) : undefined
   const drawPlugin = defra.drawMLPlugin()
+  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({
+      datasets: [
+        {
+          id: 'invalid-area',
+          label: 'Invalid areas',
+          geojson: `${config.apiPath}/maps/countries.geojson?omit=${country}`,
+          showInKey: false,
+          showInMenu: false,
+          style: {
+            stroke: 'gray',
+            strokeWidth: 1,
+            fill: 'rgba(211,211,211,0.8)'
+          }
+        },
+        {
+          id: 'valid-area',
+          label: 'Valid areas',
+          geojson: `${config.apiPath}/maps/countries.geojson?only=${country}`,
+          showInKey: false,
+          showInMenu: false,
+          style: {
+            stroke: 'rgba(0,112,60,1)',
+            strokeWidth: 1
+          }
+        }
+      ]
+    })
+
+    plugins.push(datasetsPlugin)
+  }
 
   const initConfig = {
     ...defaultConfig,
     bounds,
-    plugins: [drawPlugin]
+    plugins
   }
 
   const { map, interactPlugin } = createMap(mapId, initConfig, config)

package/src/client/javascripts/map.js

@@ -240,18 +240,6 @@ export function makeTileRequestTransformer(apiPath) {
   }
 }
 
-/**
- * Temporary transform request function to transform geocode requests. Fixed in v0.0.18 of interactive map so this is not needed when we upgrade.
- * @param {object} request
- * @param {string} request.url
- * @param {{ method: 'get' }} request.options
- * @returns {Request}
- */
-export const transformGeocodeRequest = (request) => {
-  const url = new URL(request.url, window.location.origin)
-  return new Request(url.toString(), request.options)
-}
-
 /**
  * Create a Defra map instance
  * @param {string} mapId - the map id
@@ -267,7 +255,7 @@ export function createMap(mapId, initConfig, mapsConfig) {
 
   const interactPlugin = defra.interactPlugin({
     markerColor: { outdoor: '#ff0000', dark: '#00ff00' },
-    interactionMode: 'marker',
+    interactionModes: ['placeMarker'],
     multiSelect: false
   })
 
@@ -332,7 +320,6 @@ export function createMap(mapId, initConfig, mapsConfig) {
       }),
       interactPlugin,
       defra.searchPlugin({
-        transformRequest: transformGeocodeRequest,
         osNamesURL: `${apiPath}/geocode-proxy?query={query}`,
         width: '300px',
         showMarker: false

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

@@ -6,7 +6,7 @@ import {
   FormComponent,
   isGeospatialState
 } from './FormComponent.js'
-import { geospatialSchema } from './helpers/geospatial.js'
+import { getGeospatialSchema } from './helpers/geospatial.js'
 import { messageTemplate } from '../pageControllers/validationOptions.js'
 import {
   type ErrorMessageTemplateList,
@@ -31,7 +31,9 @@ export class GeospatialField extends FormComponent {
 
     const { options } = def
 
-    let formSchema = geospatialSchema.label(this.label).required()
+    let formSchema = getGeospatialSchema(options.countries?.at(0))
+      .label(this.label)
+      .required()
 
     formSchema = formSchema.max(50)
 
@@ -90,6 +92,7 @@ export class GeospatialField extends FormComponent {
 
     return {
       ...viewModel,
+      country: this.options.countries?.at(0),
       value
     }
   }
@@ -101,6 +104,9 @@ export class GeospatialField extends FormComponent {
       if (err.name === 'description') {
         err.href = `#description_${err.path[1]}`
         err.text = `Enter description for location ${Number(err.path[1]) + 1}`
+      } else if (typeof err.name === 'number' && err.context?.country) {
+        err.href = `#description_${err.path[1]}`
+        err.text = `Location ${Number(err.path[1]) + 1} must be in ${err.context.country}`
       }
     })
 

package/src/server/plugins/engine/components/helpers/geospatial.ts

@@ -1,5 +1,10 @@
+import {
+  GeospatialFieldOptionsCountryEnum,
+  type GeospatialFieldOptionsCountry
+} from '@defra/forms-model'
 import Bourne from '@hapi/bourne'
-import JoiBase from 'joi'
+import { booleanWithin } from '@turf/boolean-within'
+import JoiBase, { type CustomValidator } from 'joi'
 
 import {
   type Coordinates,
@@ -7,6 +12,14 @@ import {
   type FeatureProperties,
   type Geometry
 } from '../../types.js'
+import { countries } from '../../../map/routes/index.js'
+
+const countriesDesc: Record<GeospatialFieldOptionsCountryEnum, string> = {
+  [GeospatialFieldOptionsCountryEnum.England]: 'England',
+  [GeospatialFieldOptionsCountryEnum.NorthernIreland]: 'Northern Ireland',
+  [GeospatialFieldOptionsCountryEnum.Scotland]: 'Scotland',
+  [GeospatialFieldOptionsCountryEnum.Wales]: 'Wales'
+}
 
 const Joi = JoiBase.extend({
   type: 'array',
@@ -83,11 +96,44 @@ const featureSchema = Joi.object<Feature>().keys({
   geometry: featureGeometrySchema
 })
 
-export const geospatialSchema = Joi.array<Feature[]>()
+const geospatialSchema = Joi.array<Feature[]>()
   .items(featureSchema)
   .unique('id')
   .required()
 
+export function getGeospatialSchema(country?: GeospatialFieldOptionsCountry) {
+  if (!country) {
+    return geospatialSchema
+  }
+
+  const validateCountryBounds: CustomValidator = (value, helpers) => {
+    const countryFeature = countries.features.find(
+      (feature) => feature.id === country
+    )
+
+    if (!countryFeature) {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+      return value
+    }
+
+    const result = booleanWithin(value, countryFeature)
+
+    if (!result) {
+      return helpers.error('any.custom', {
+        country: countriesDesc[country as GeospatialFieldOptionsCountryEnum]
+      })
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return value
+  }
+
+  return Joi.array<Feature[]>()
+    .items(featureSchema.custom(validateCountryBounds))
+    .unique('id')
+    .required()
+}
+
 /**
  * @import { CustomHelpers } from 'joi'
  */

package/src/server/plugins/engine/views/components/geospatialfield.html

@@ -1,7 +1,7 @@
 {% from "govuk/components/textarea/macro.njk" import govukTextarea %}
 
 {% macro GeospatialField(component) %}
-  <div class="app-geospatial-field">
+  <div class="app-geospatial-field" data-country="{{component.model.country}}">
     {{ govukTextarea(component.model) }}
   </div>
 {% endmacro %}

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

@@ -1,5 +1,7 @@
+import fs from 'node:fs'
 import { resolve } from 'node:path'
 
+import { GeospatialFieldOptionsCountryEnum } from '@defra/forms-model'
 import { StatusCodes } from 'http-status-codes'
 import Joi from 'joi'
 
@@ -10,6 +12,18 @@ import {
   request as httpRequest
 } from '../../../services/httpService.js'
 
+const filePath = resolve(import.meta.dirname, './vts/countries.geojson')
+
+/**
+ * @type {FeatureCollection}
+ */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+export const countries = JSON.parse(fs.readFileSync(filePath, 'utf8'))
+
+export const countrySchema = Joi.string().valid(
+  ...Object.values(GeospatialFieldOptionsCountryEnum)
+)
+
 /**
  * Gets the map support routes
  * @param {MapConfiguration} options - ordnance survey names api key
@@ -20,7 +34,8 @@ export function getRoutes(options) {
     mapProxyRoute(options),
     tileProxyRoute(options),
     geocodeProxyRoute(options),
-    reverseGeocodeProxyRoute(options)
+    reverseGeocodeProxyRoute(options),
+    getGeospatialCountries()
   ]
 }
 
@@ -188,7 +203,48 @@ function mapStyleResourceRoutes() {
   }
 }
 
+/**
+ * Resource routes to return sprites and glyphs
+ * @returns {ServerRoute<GeospatialCountriesGetRequestRefs>}
+ */
+function getGeospatialCountries() {
+  return {
+    method: 'GET',
+    path: '/api/maps/countries.geojson',
+    handler: (request) => {
+      const { omit, only } = request.query
+
+      if (omit) {
+        return {
+          ...countries,
+          features: countries.features.filter((feature) => feature.id !== omit)
+        }
+      }
+
+      if (only) {
+        return {
+          ...countries,
+          features: countries.features.filter((feature) => feature.id === only)
+        }
+      }
+
+      return countries
+    },
+    options: {
+      validate: {
+        query: Joi.object()
+          .keys({
+            omit: countrySchema.optional(),
+            only: countrySchema.optional()
+          })
+          .optional()
+      }
+    }
+  }
+}
+
 /**
  * @import { ServerRoute } from '@hapi/hapi'
- * @import { MapConfiguration, MapProxyGetRequestRefs, MapGeocodeGetRequestRefs, MapReverseGeocodeGetRequestRefs } from '../types.js'
+ * @import { FeatureCollection } from 'geojson'
+ * @import { MapConfiguration, MapProxyGetRequestRefs, MapGeocodeGetRequestRefs, MapReverseGeocodeGetRequestRefs, GeospatialCountriesGetRequestRefs } from '../types.js'
  */