@defra/forms-engine-plugin 5.0.0-alpha.24 → 5.0.0-alpha.26

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

@@ -21,11 +21,18 @@
  * @property {string} query - name query
  */
 
+export const CountryMap = {
+  england: 1,
+  'northern-ireland': 3,
+  scotland: 2,
+  wales: 4
+}
+
 /**
  * Geospatial countries query params
  * @typedef {object} GeospatialCountriesQuery
- * @property {string} omit - the country to omit
- * @property {string} only - the country to include
+ * @property {keyof typeof CountryMap} [omit] - the country to omit
+ * @property {keyof typeof CountryMap} [only] - the country to include
  */
 
 /**

package/src/server/plugins/postcode-lookup/models/index.js

@@ -298,6 +298,19 @@ export const stepSchema = Joi.string()
   .valid(...Object.keys(steps))
   .required()
 
+/**
+ * Joi object schema factories typed with their payload, as JavaScript files
+ * cannot pass type arguments to `Joi.object<T>()`
+ */
+/** @type {() => ObjectSchema<PostcodeLookupDetailsPayload>} */
+const detailsObjectSchema = Joi.object.bind(Joi)
+
+/** @type {() => ObjectSchema<PostcodeLookupSelectPayload>} */
+const selectObjectSchema = Joi.object.bind(Joi)
+
+/** @type {() => ObjectSchema<PostcodeLookupManualPayload>} */
+const manualObjectSchema = Joi.object.bind(Joi)
+
 const sharedPayloadSchemaKeys = {
   crumb: crumbSchema,
   step: stepSchema
@@ -309,7 +322,7 @@ const sharedPayloadSchemaKeys = {
  * @returns {ObjectSchema<PostcodeLookupDetailsPayload>}
  */
 export function createDetailsPayloadSchema(language = 'en-GB') {
-  return Joi.object()
+  return detailsObjectSchema()
     .keys({
       ...sharedPayloadSchemaKeys,
       [postcodeQueryFieldName]: Joi.string()
@@ -338,7 +351,7 @@ export function createDetailsPayloadSchema(language = 'en-GB') {
  * @returns {ObjectSchema<PostcodeLookupSelectPayload>}
  */
 export function createSelectPayloadSchema(language = 'en-GB') {
-  return Joi.object()
+  return selectObjectSchema()
     .keys({
       ...sharedPayloadSchemaKeys,
       [uprnFieldName]: Joi.string()
@@ -356,7 +369,7 @@ export function createSelectPayloadSchema(language = 'en-GB') {
  * @returns {ObjectSchema<PostcodeLookupManualPayload>}
  */
 export function createManualPayloadSchema(language = 'en-GB') {
-  return Joi.object()
+  return manualObjectSchema()
     .keys({
       ...sharedPayloadSchemaKeys,
       [line1FieldName]: Joi.string()

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

@@ -198,6 +198,19 @@ function postRoute(options) {
   }
 }
 
+/**
+ * Validate a payload against a schema. Joi types the value as `any` when
+ * validation fails, so it is typed here as the partially converted payload.
+ * @template TSchema
+ * @param {ObjectSchema<TSchema>} schema
+ * @param {unknown} payload
+ * @param {ValidationOptions} [options]
+ * @returns {{ value: TSchema, error: undefined } | { value: TSchema | undefined, error: ValidationError }}
+ */
+function validatePayload(schema, payload, options) {
+  return schema.validate(payload, options)
+}
+
 /**
  * Post handler for the details step
  * @param {PostcodeLookupPostRequest} request
@@ -214,9 +227,10 @@ async function detailsPostHandler(request, h, options) {
   )
   const language = translator.language
 
-  const { value: details, error } = createDetailsPayloadSchema(
-    language
-  ).validate(request.payload)
+  const { value: details, error } = validatePayload(
+    createDetailsPayloadSchema(language),
+    request.payload
+  )
 
   let model
 
@@ -252,7 +266,8 @@ async function selectPostHandler(request, h, options) {
     request.query.language
   )
   const language = translator.language
-  const { value: select, error } = createSelectPayloadSchema(language).validate(
+  const { value: select, error } = validatePayload(
+    createSelectPayloadSchema(language),
     request.payload
   )
 
@@ -295,11 +310,10 @@ async function manualPostHandler(request, h) {
   )
   const language = translator.language
 
-  const { value: manual, error } = createManualPayloadSchema(language).validate(
+  const { value: manual, error } = validatePayload(
+    createManualPayloadSchema(language),
     request.payload,
-    {
-      abortEarly: false
-    }
+    { abortEarly: false }
   )
 
   if (error) {
@@ -317,6 +331,7 @@ async function manualPostHandler(request, h) {
 
 /**
  * @import { ResponseToolkit, ServerRoute } from '@hapi/hapi'
+ * @import { ObjectSchema, ValidationError, ValidationOptions } from 'joi'
  * @import { FormMetadata } from '@defra/forms-model'
  * @import { PostcodeLookupManualPayload, Address, PostcodeLookupGetRequestRefs, PostcodeLookupPostRequestRefs, PostcodeLookupRequest, PostcodeLookupPostRequest, PostcodeLookupConfiguration, PostcodeLookupDispatchData, PostcodeLookupSessionData } from '../types.js'
  * @import { FormRequestPayload, FormResponseToolkit } from '../../../routes/types.js'

package/src/typings/geodesy/index.d.ts

@@ -0,0 +1,18 @@
+declare module 'geodesy/osgridref.js' {
+  export class LatLon {
+    constructor(lat: number, lon: number, height?: number)
+    get latitude(): number
+    get longitude(): number
+    get height(): number
+    toOsGrid(): OsGridRef
+  }
+
+  export default class OsGridRef {
+    constructor(easting: number, northing: number)
+    easting: number
+    northing: number
+    toLatLon(): LatLon
+    toString(digits?: number): string
+    static parse(gridref: string): OsGridRef
+  }
+}