@defra/forms-engine-plugin 4.13.0 → 4.14.1

package/src/server/forms/simple-form.yaml

@@ -25,6 +25,15 @@ pages:
           required: true
         schema: {}
         id: b68df7f1-d4f4-4c17-83c8-402f584906c9
+      - type: GeospatialField
+        title: Where do you live?
+        name: applicantLocation
+        shortDescription: Your location
+        hint: ''
+        options:
+          required: true
+        schema: {}
+        id: e18116e0-7c3e-416a-af42-6f229017c5b1
     next: []
     id: 622a35ec-3795-418a-81f3-a45746959045
   - title: Upload a copy of your passport

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

@@ -31,18 +31,21 @@ export class GeospatialField extends FormComponent {
 
     const { options } = def
 
-    let formSchema = getGeospatialSchema(options.countries?.at(0))
+    const formSchema = getGeospatialSchema(def)
       .label(this.label)
-      .required()
+      .messages({
+        'array.min': messageTemplate.featuresMin as string,
+        'array.max': messageTemplate.featuresMax as string,
+        'array.length': messageTemplate.featuresLength as string
+      })
 
-    formSchema = formSchema.max(50)
+    this.formSchema = formSchema
+    this.stateSchema = formSchema.default(null)
 
-    if (options.required !== false) {
-      formSchema = formSchema.min(1)
+    if (options.required === false) {
+      this.stateSchema = this.stateSchema.allow(null)
     }
 
-    this.formSchema = formSchema
-    this.stateSchema = formSchema.default(null)
     this.options = options
   }
 
@@ -93,6 +96,7 @@ export class GeospatialField extends FormComponent {
     return {
       ...viewModel,
       country: this.options.countries?.at(0),
+      geometryTypes: this.options.geometryTypes,
       value
     }
   }

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

@@ -1,5 +1,6 @@
 import {
   GeospatialFieldOptionsCountryEnum,
+  type GeospatialFieldComponent,
   type GeospatialFieldOptionsCountry
 } from '@defra/forms-model'
 import Bourne from '@hapi/bourne'
@@ -31,7 +32,8 @@ const Joi = JoiBase.extend({
     from: 'string',
     method(value, helpers) {
       if (typeof value === 'string') {
-        if (value.trim() === '') {
+        const trimmed = value.trim()
+        if (trimmed === '' || trimmed === '[]') {
           return {
             value: undefined
           }
@@ -96,14 +98,48 @@ const featureSchema = Joi.object<Feature>().keys({
   geometry: featureGeometrySchema
 })
 
-const geospatialSchema = Joi.array<Feature[]>()
-  .items(featureSchema)
-  .unique('id')
-  .required()
+function applySchemaConstraints(
+  schema: JoiBase.ArraySchema<Feature[]>,
+  def: GeospatialFieldComponent
+) {
+  const { options, schema: constraints } = def
+  const isOptional = options.required === false
+
+  if (typeof constraints?.length === 'number') {
+    schema = schema.length(constraints.length)
+  } else {
+    if (typeof constraints?.min === 'number') {
+      schema = schema.min(constraints.min)
+    } else if (!isOptional) {
+      schema = schema.min(1)
+    }
+
+    schema = schema.max(
+      typeof constraints?.max === 'number' ? constraints.max : 50
+    )
+  }
+
+  if (isOptional) {
+    schema = schema.optional()
+  } else {
+    schema = schema.required()
+  }
+
+  return schema
+}
+
+export function getGeospatialSchema(
+  def: GeospatialFieldComponent
+): JoiBase.ArraySchema<Feature[]> {
+  const { options = {} } = def
+  const country: GeospatialFieldOptionsCountry | undefined =
+    options.countries?.at(0)
 
-export function getGeospatialSchema(country?: GeospatialFieldOptionsCountry) {
   if (!country) {
-    return geospatialSchema
+    return applySchemaConstraints(
+      Joi.array<Feature[]>().items(featureSchema).unique('id'),
+      def
+    )
   }
 
   const validateCountryBounds: CustomValidator = (value, helpers) => {
@@ -128,10 +164,12 @@ export function getGeospatialSchema(country?: GeospatialFieldOptionsCountry) {
     return value
   }
 
-  return Joi.array<Feature[]>()
-    .items(featureSchema.custom(validateCountryBounds))
-    .unique('id')
-    .required()
+  return applySchemaConstraints(
+    Joi.array<Feature[]>()
+      .items(featureSchema.custom(validateCountryBounds))
+      .unique('id'),
+    def
+  )
 }
 
 /**

package/src/server/plugins/engine/pageControllers/validationOptions.ts

@@ -64,7 +64,10 @@ export const messageTemplate: Record<string, JoiExpression> = {
   dateMax: '{{#title}} must be the same as or before {{#limit}}',
   arrayMin: 'Select at least {{#limit}} options from the list',
   arrayMax: 'Only {{#limit}} can be selected from the list',
-  arrayLength: 'Select only {{#limit}} options from the list'
+  arrayLength: 'Select only {{#limit}} options from the list',
+  featuresMin: 'Define at least {{#limit}} features',
+  featuresMax: 'Only {{#limit}} features can be defined',
+  featuresLength: 'Define exactly {{#limit}} features'
 }
 
 export const messages: LanguageMessagesExt = {

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" data-country="{{component.model.country}}">
+  <div class="app-geospatial-field" data-country="{{component.model.country}}" data-geometryTypes="{{component.model.geometryTypes}}">
     {{ govukTextarea(component.model) }}
   </div>
 {% endmacro %}