@defra/forms-engine-plugin 4.9.2 → 4.11.0

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/helpers.ts

@@ -15,7 +15,7 @@ import { StatusCodes } from 'http-status-codes'
 import { type Schema, type ValidationErrorItem } from 'joi'
 import { Liquid } from 'liquidjs'
 
-import { createLogger } from '../../common/helpers/logging/logger.js'
+import { logger } from '../../common/helpers/logging/logger.js'
 import { FORM_VERSION_METADATA_KEY } from '../../constants.js'
 import {
   getAnswer,
@@ -37,8 +37,6 @@ import {
   type FormResponseToolkit
 } from '../../routes/types.js'
 
-const logger = createLogger()
-
 export const engine = new Liquid({
   outputEscape: 'escape',
   jsTruthy: true,

package/src/server/plugins/engine/models/FormModel.ts

@@ -28,7 +28,7 @@ import { add, format } from 'date-fns'
 import { Parser, type Value } from 'expr-eval-fork'
 import joi from 'joi'
 
-import { createLogger } from '../../../common/helpers/logging/logger.js'
+import { logger } from '../../../common/helpers/logging/logger.js'
 import { type ListFormComponent } from '../components/ListFormComponent.js'
 import {} from '../components/YesNoField.js'
 import {
@@ -61,8 +61,6 @@ import { FormAction } from '../../../routes/types.js'
 import { merge } from '../../../services/cacheService.js'
 import { type Services } from '../../../types.js'
 
-const logger = createLogger()
-
 export class FormModel {
   /** The runtime engine that should be used */
   engine?: Engine

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

@@ -1,11 +1,9 @@
 import { getErrorMessage } from '@defra/forms-model'
 import Joi from 'joi'
 
-import { createLogger } from '../../common/helpers/logging/logger.js'
+import { logger } from '../../common/helpers/logging/logger.js'
 import { CacheService } from '../../services/index.js'
 
-const logger = createLogger()
-
 const pluginRegistrationOptionsSchema = Joi.object({
   model: Joi.object().optional(),
   services: Joi.object().optional(),

package/src/server/plugins/engine/routes/payment.js

@@ -2,7 +2,7 @@ import Boom from '@hapi/boom'
 import { StatusCodes } from 'http-status-codes'
 import Joi from 'joi'
 
-import { createLogger } from '../../../common/helpers/logging/logger.js'
+import { logger } from '../../../common/helpers/logging/logger.js'
 import { EXTERNAL_STATE_APPENDAGE } from '../../../constants.js'
 import { getPluginOptions } from '../helpers.js'
 import {
@@ -14,8 +14,6 @@ import {
 export const PAYMENT_RETURN_PATH = '/payment-callback'
 export const PAYMENT_SESSION_PREFIX = 'payment-'
 
-const logger = createLogger()
-
 /**
  * Flash form component state after successful payment
  * @param {Request} request - the request

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'
  */