@defra/forms-engine-plugin 4.0.5 → 4.0.7

package/src/server/plugins/engine/outputFormatters/adapter/v1.location.test.ts

@@ -0,0 +1,356 @@
+import {
+  ComponentType,
+  type EastingNorthingFieldComponent,
+  type FormDefinition,
+  type LatLongFieldComponent,
+  type NationalGridFieldNumberFieldComponent,
+  type OsGridRefFieldComponent,
+  type PageQuestion
+} from '@defra/forms-model'
+
+import {
+  EastingNorthingField,
+  LatLongField,
+  NationalGridFieldNumberField,
+  OsGridRefField
+} from '~/src/server/plugins/engine/components/index.js'
+import { FormModel } from '~/src/server/plugins/engine/models/index.js'
+import { type DetailItemField } from '~/src/server/plugins/engine/models/types.js'
+import { format } from '~/src/server/plugins/engine/outputFormatters/adapter/v1.js'
+import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
+import {
+  FormAdapterSubmissionSchemaVersion,
+  type FormAdapterSubmissionMessagePayload
+} from '~/src/server/plugins/engine/types/index.js'
+import { FormStatus } from '~/src/server/routes/types.js'
+
+describe('Adapter V1 formatter - Location fields', () => {
+  const definition: FormDefinition = {
+    name: 'Location Test Form',
+    startPage: '/location',
+    pages: [
+      {
+        path: '/location',
+        title: 'Location Page',
+        next: [],
+        components: [
+          {
+            type: ComponentType.EastingNorthingField,
+            name: 'locationEN',
+            title: 'Easting and Northing',
+            options: {}
+          },
+          {
+            type: ComponentType.LatLongField,
+            name: 'locationLL',
+            title: 'Latitude and Longitude',
+            options: {}
+          },
+          {
+            type: ComponentType.OsGridRefField,
+            name: 'gridRef',
+            title: 'OS Grid Reference',
+            options: {}
+          },
+          {
+            type: ComponentType.NationalGridFieldNumberField,
+            name: 'ngField',
+            title: 'National Grid Field Number',
+            options: {}
+          }
+        ]
+      } satisfies PageQuestion
+    ],
+    lists: [],
+    sections: [],
+    conditions: []
+  }
+
+  const model = new FormModel(definition, { basePath: 'test' })
+  const locationPage = definition.pages[0] as PageQuestion
+
+  const submitResponse = {
+    message: 'Submit completed',
+    result: {
+      files: {
+        main: '00000000-0000-0000-0000-000000000000',
+        repeaters: {}
+      }
+    }
+  }
+
+  const pageUrl = new URL('http://example.com/test/location')
+
+  const request = buildFormContextRequest({
+    method: 'get',
+    url: pageUrl,
+    path: pageUrl.pathname,
+    params: {
+      path: 'location',
+      slug: 'test'
+    },
+    query: {},
+    app: { model }
+  })
+
+  it('includes EastingNorthingField values in the payload', () => {
+    const state = {
+      $$__referenceNumber: 'ABC-123',
+      locationEN__easting: 123456,
+      locationEN__northing: 654321,
+      locationLL__latitude: 51.5,
+      locationLL__longitude: -0.1,
+      gridRef: 'TQ123456',
+      ngField: 'NG12345678'
+    }
+
+    const context = model.getFormContext(request, state)
+
+    const eastingNorthingField = new EastingNorthingField(
+      locationPage.components[0] as EastingNorthingFieldComponent,
+      { model }
+    )
+
+    const items: DetailItemField[] = [
+      {
+        name: 'locationEN',
+        label: 'Easting and Northing',
+        href: '/location',
+        title: 'Easting and Northing',
+        field: eastingNorthingField,
+        state,
+        value: '654321, 123456'
+      } as unknown as DetailItemField
+    ]
+
+    const result = format(context, items, model, submitResponse, {
+      state: FormStatus.Live,
+      isPreview: false
+    })
+
+    const payload = JSON.parse(result) as FormAdapterSubmissionMessagePayload
+
+    expect(payload.meta.schemaVersion).toBe(
+      FormAdapterSubmissionSchemaVersion.V1
+    )
+    expect(payload.data.main.locationEN).toEqual({
+      easting: 123456,
+      northing: 654321
+    })
+  })
+
+  it('includes LatLongField values in the payload', () => {
+    const state = {
+      $$__referenceNumber: 'ABC-123',
+      locationLL__latitude: 51.51945,
+      locationLL__longitude: -0.127758
+    }
+
+    const context = model.getFormContext(request, state)
+
+    const latLongField = new LatLongField(
+      locationPage.components[1] as LatLongFieldComponent,
+      { model }
+    )
+
+    const items: DetailItemField[] = [
+      {
+        name: 'locationLL',
+        label: 'Latitude and Longitude',
+        href: '/location',
+        title: 'Latitude and Longitude',
+        field: latLongField,
+        state,
+        value: '51.519450, -0.127758'
+      } as unknown as DetailItemField
+    ]
+
+    const result = format(context, items, model, submitResponse, {
+      state: FormStatus.Live,
+      isPreview: false
+    })
+
+    const payload = JSON.parse(result) as FormAdapterSubmissionMessagePayload
+
+    expect(payload.data.main.locationLL).toEqual({
+      latitude: 51.51945,
+      longitude: -0.127758
+    })
+  })
+
+  it('includes simple location field values in the payload', () => {
+    const state = {
+      $$__referenceNumber: 'ABC-123',
+      gridRef: 'TQ123456',
+      ngField: 'NG12345678'
+    }
+
+    const context = model.getFormContext(request, state)
+
+    const osGridRefField = new OsGridRefField(
+      locationPage.components[2] as OsGridRefFieldComponent,
+      { model }
+    )
+
+    const nationalGridField = new NationalGridFieldNumberField(
+      locationPage.components[3] as NationalGridFieldNumberFieldComponent,
+      { model }
+    )
+
+    const items: DetailItemField[] = [
+      {
+        name: 'gridRef',
+        label: 'OS Grid Reference',
+        href: '/location',
+        title: 'OS Grid Reference',
+        field: osGridRefField,
+        state,
+        value: 'TQ123456'
+      } as unknown as DetailItemField,
+      {
+        name: 'ngField',
+        label: 'National Grid Field Number',
+        href: '/location',
+        title: 'National Grid Field Number',
+        field: nationalGridField,
+        state,
+        value: 'NG12345678'
+      } as unknown as DetailItemField
+    ]
+
+    const result = format(context, items, model, submitResponse, {
+      state: FormStatus.Live,
+      isPreview: false
+    })
+
+    const payload = JSON.parse(result) as FormAdapterSubmissionMessagePayload
+
+    expect(payload.data.main.gridRef).toBe('TQ123456')
+    expect(payload.data.main.ngField).toBe('NG12345678')
+  })
+
+  it('handles null values for optional location fields', () => {
+    const state = {
+      $$__referenceNumber: 'ABC-123'
+    }
+
+    const context = model.getFormContext(request, state)
+
+    const eastingNorthingField = new EastingNorthingField(
+      locationPage.components[0] as EastingNorthingFieldComponent,
+      { model }
+    )
+
+    const items: DetailItemField[] = [
+      {
+        name: 'locationEN',
+        label: 'Easting and Northing',
+        href: '/location',
+        title: 'Easting and Northing',
+        field: eastingNorthingField,
+        state,
+        value: ''
+      } as unknown as DetailItemField
+    ]
+
+    const result = format(context, items, model, submitResponse, {
+      state: FormStatus.Live,
+      isPreview: false
+    })
+
+    const payload = JSON.parse(result) as FormAdapterSubmissionMessagePayload
+
+    expect(payload.data.main.locationEN).toBeNull()
+  })
+
+  it('includes all location fields in a mixed form', () => {
+    const state = {
+      $$__referenceNumber: 'ABC-123',
+      locationEN__easting: 123456,
+      locationEN__northing: 654321,
+      locationLL__latitude: 51.51945,
+      locationLL__longitude: -0.127758,
+      gridRef: 'TQ123456',
+      ngField: 'NG12345678'
+    }
+
+    const context = model.getFormContext(request, state)
+
+    const eastingNorthingField = new EastingNorthingField(
+      locationPage.components[0] as EastingNorthingFieldComponent,
+      { model }
+    )
+    const latLongField = new LatLongField(
+      locationPage.components[1] as LatLongFieldComponent,
+      { model }
+    )
+    const osGridRefField = new OsGridRefField(
+      locationPage.components[2] as OsGridRefFieldComponent,
+      { model }
+    )
+    const nationalGridField = new NationalGridFieldNumberField(
+      locationPage.components[3] as NationalGridFieldNumberFieldComponent,
+      { model }
+    )
+
+    const items: DetailItemField[] = [
+      {
+        name: 'locationEN',
+        label: 'Easting and Northing',
+        href: '/location',
+        title: 'Easting and Northing',
+        field: eastingNorthingField,
+        state,
+        value: '654321, 123456'
+      } as unknown as DetailItemField,
+      {
+        name: 'locationLL',
+        label: 'Latitude and Longitude',
+        href: '/location',
+        title: 'Latitude and Longitude',
+        field: latLongField,
+        state,
+        value: '51.519450, -0.127758'
+      } as unknown as DetailItemField,
+      {
+        name: 'gridRef',
+        label: 'OS Grid Reference',
+        href: '/location',
+        title: 'OS Grid Reference',
+        field: osGridRefField,
+        state,
+        value: 'TQ123456'
+      } as unknown as DetailItemField,
+      {
+        name: 'ngField',
+        label: 'National Grid Field Number',
+        href: '/location',
+        title: 'National Grid Field Number',
+        field: nationalGridField,
+        state,
+        value: 'NG12345678'
+      } as unknown as DetailItemField
+    ]
+
+    const result = format(context, items, model, submitResponse, {
+      state: FormStatus.Live,
+      isPreview: false
+    })
+
+    const payload = JSON.parse(result) as FormAdapterSubmissionMessagePayload
+
+    // Check all location fields are included correctly
+    expect(payload.data.main).toEqual({
+      locationEN: {
+        easting: 123456,
+        northing: 654321
+      },
+      locationLL: {
+        latitude: 51.51945,
+        longitude: -0.127758
+      },
+      gridRef: 'TQ123456',
+      ngField: 'NG12345678'
+    })
+  })
+})

package/src/server/plugins/engine/pageControllers/helpers/helpers.test.ts

@@ -67,6 +67,10 @@ describe('Page controller helpers', () => {
         controller = SummaryPageController
         break
 
+      case ControllerType.SummaryWithConfirmationEmail:
+        controller = SummaryPageController
+        break
+
       case ControllerType.Status:
         controller = StatusPageController
         break

package/src/server/plugins/engine/pageControllers/helpers/pages.ts

@@ -11,6 +11,10 @@ import * as PageControllers from '~/src/server/plugins/engine/pageControllers/in
 export function isPageController(
   controllerName?: string | ControllerType
 ): controllerName is keyof typeof PageControllers {
+  // Handle SummaryWithConfirmationEmail as it uses SummaryPageController
+  if (controllerName === ControllerType.SummaryWithConfirmationEmail) {
+    return true
+  }
   return isControllerName(controllerName) && controllerName in PageControllers
 }
 
@@ -52,6 +56,10 @@ export function createPage(model: FormModel, pageDef: Page) {
       controller = new PageControllers.SummaryPageController(model, pageDef)
       break
 
+    case ControllerType.SummaryWithConfirmationEmail:
+      controller = new PageControllers.SummaryPageController(model, pageDef)
+      break
+
     case ControllerType.Status:
       controller = new PageControllers.StatusPageController(model, pageDef)
       break

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

@@ -61,7 +61,9 @@ export type {
   Content,
   DateInputItem,
   DatePartsState,
+  EastingNorthingState,
   Label,
+  LatLongState,
   ListItem,
   ListItemLabel,
   MonthYearState,

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

@@ -23,6 +23,8 @@ import {
   type ComponentText,
   type ComponentViewModel,
   type DatePartsState,
+  type EastingNorthingState,
+  type LatLongState,
   type MonthYearState
 } from '~/src/server/plugins/engine/components/types.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
@@ -464,6 +466,8 @@ export type RichFormValue =
   | DatePartsState
   | MonthYearState
   | UkAddressState
+  | EastingNorthingState
+  | LatLongState
 
 export interface FormAdapterSubmissionMessageData {
   main: Record<string, RichFormValue | null>

package/src/server/plugins/engine/views/components/_location-field-base.html

@@ -0,0 +1,53 @@
+{% from "govuk/components/input/macro.njk" import govukInput %}
+{% from "govuk/components/fieldset/macro.njk" import govukFieldset %}
+{% from "govuk/components/details/macro.njk" import govukDetails %}
+{% from "govuk/components/hint/macro.njk" import govukHint %}
+
+{% macro LocationFieldBase(component, inputType, inputMode) %}
+  {% set fieldsetHtml %}
+    {% if component.model.hint %}
+      {{ govukHint({
+        id: component.model.name + "-hint",
+        text: component.model.hint.text
+      }) }}
+    {% endif %}
+
+    <div class="app-location-input">
+      {% for item in component.model.items %}
+        <div class="app-location-input__item">
+          {{ govukInput({
+            id: item.id,
+            name: item.name,
+            label: {
+              text: item.label,
+              classes: "govuk-label--s"
+            },
+            classes: item.classes,
+            value: item.value,
+            type: inputType,
+            inputmode: inputMode,
+            prefix: item.prefix,
+            suffix: item.suffix
+          }) }}
+        </div>
+      {% endfor %}
+    </div>
+
+    {% if component.model.instructionText %}
+      {{ govukDetails({
+        summaryText: "How to find location details",
+        html: component.model.instructionText | safe
+      }) }}
+    {% endif %}
+  {% endset %}
+
+  {{ govukFieldset({
+    legend: {
+      text: component.model.fieldset.legend.text,
+      classes: component.model.fieldset.legend.classes,
+      isPageHeading: false
+    },
+    html: fieldsetHtml
+  }) }}
+{% endmacro %}
+

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

@@ -0,0 +1,5 @@
+{% from "./_location-field-base.html" import LocationFieldBase %}
+
+{% macro EastingNorthingField(component) %}
+  {{ LocationFieldBase(component, "number", "numeric") }}
+{% endmacro %}

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

@@ -0,0 +1,5 @@
+{% from "./_location-field-base.html" import LocationFieldBase %}
+
+{% macro LatLongField(component) %}
+  {{ LocationFieldBase(component, "text", "decimal") }}
+{% endmacro %}

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

@@ -0,0 +1,13 @@
+{% from "components/textfield.html" import TextField %}
+{% from "govuk/components/details/macro.njk" import govukDetails %}
+
+{% macro NationalGridFieldNumberField(component) %}
+  {{ TextField(component) }}
+
+  {% if component.model.instructionText %}
+    {{ govukDetails({
+      summaryText: "How to find location details",
+      html: component.model.instructionText | safe
+    }) }}
+  {% endif %}
+{% endmacro %}

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

@@ -0,0 +1,13 @@
+{% from "components/textfield.html" import TextField %}
+{% from "govuk/components/details/macro.njk" import govukDetails %}
+
+{% macro OsGridRefField(component) %}
+  {{ TextField(component) }}
+
+  {% if component.model.instructionText %}
+    {{ govukDetails({
+      summaryText: "How to find location details",
+      html: component.model.instructionText | safe
+    }) }}
+  {% endif %}
+{% endmacro %}