@defra/forms-engine-plugin 4.7.2 → 4.8.0

package/src/server/plugins/engine/outputFormatters/machine/v2.location.test.ts

@@ -1,341 +0,0 @@
-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/machine/v2.js'
-import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
-import { FormStatus } from '~/src/server/routes/types.js'
-
-describe('Machine V2 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 }
-  })
-
-  const formStatus = {
-    isPreview: false,
-    state: FormStatus.Live
-  }
-
-  it('includes LatLongField values with full property names (latitude/longitude) 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, formStatus)
-    const payload = JSON.parse(result)
-
-    // Verify the payload uses full property names, not abbreviated
-    expect(payload.data.main.locationLL).toEqual({
-      latitude: 51.51945,
-      longitude: -0.127758
-    })
-
-    // Ensure abbreviated forms are NOT present
-    expect(payload.data.main.locationLL).not.toHaveProperty('lat')
-    expect(payload.data.main.locationLL).not.toHaveProperty('long')
-  })
-
-  it('includes EastingNorthingField values with full property names (easting/northing) in the payload', () => {
-    const state = {
-      $$__referenceNumber: 'ABC-123',
-      locationEN__easting: 123456,
-      locationEN__northing: 654321
-    }
-
-    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, formStatus)
-    const payload = JSON.parse(result)
-
-    // Verify the payload uses full property names
-    expect(payload.data.main.locationEN).toEqual({
-      easting: 123456,
-      northing: 654321
-    })
-  })
-
-  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, formStatus)
-    const payload = JSON.parse(result)
-
-    expect(payload.data.main.gridRef).toBe('TQ123456')
-    expect(payload.data.main.ngField).toBe('NG12345678')
-  })
-
-  it('includes all location fields in a mixed form with correct property names', () => {
-    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, formStatus)
-    const payload = JSON.parse(result)
-
-    // Check all location fields use full property names
-    expect(payload.data.main).toEqual({
-      locationEN: {
-        easting: 123456,
-        northing: 654321
-      },
-      locationLL: {
-        latitude: 51.51945,
-        longitude: -0.127758
-      },
-      gridRef: 'TQ123456',
-      ngField: 'NG12345678'
-    })
-
-    // Explicitly verify no abbreviated forms exist
-    expect(payload.data.main.locationLL).not.toHaveProperty('lat')
-    expect(payload.data.main.locationLL).not.toHaveProperty('long')
-  })
-
-  it('handles undefined location field values correctly', () => {
-    const state = {
-      $$__referenceNumber: 'ABC-123'
-    }
-
-    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: ''
-      } as unknown as DetailItemField
-    ]
-
-    const result = format(context, items, model, submitResponse, formStatus)
-    const payload = JSON.parse(result)
-
-    // Undefined location fields should be undefined in v2 (not null like in v1)
-    expect(payload.data.main.locationLL).toBeUndefined()
-  })
-})

package/src/server/plugins/engine/outputFormatters/machine/v2.payment.test.ts

@@ -1,115 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-
-import { type PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js'
-import { FormModel } from '~/src/server/plugins/engine/models/index.js'
-import { format } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'
-import {
-  SummaryPageController,
-  getFormSubmissionData
-} from '~/src/server/plugins/engine/pageControllers/SummaryPageController.js'
-import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
-import { type FormSubmissionState } from '~/src/server/plugins/engine/types.js'
-import { FormStatus } from '~/src/server/routes/types.js'
-import definition from '~/test/form/definitions/payment.js'
-
-const submitResponse = {
-  message: 'Submit completed',
-  result: {
-    files: {
-      main: '00000000-0000-0000-0000-000000000000',
-      repeaters: {
-        pizza: '11111111-1111-1111-1111-111111111111'
-      }
-    }
-  }
-}
-
-const model = new FormModel(definition, {
-  basePath: 'test'
-})
-
-const formStatus = {
-  isPreview: false,
-  state: FormStatus.Live
-}
-
-const state = {
-  $$__referenceNumber: 'foobar',
-  licenceLength: 365,
-  fullName: 'John Smith',
-  paymentField: {
-    paymentId: 'payment-id',
-    reference: 'payment-ref',
-    amount: 250,
-    description: 'Payment desc',
-    uuid: 'uuid',
-    formId: 'form-id',
-    isLivePayment: false,
-    preAuth: {
-      status: 'success',
-      createdAt: '2026-01-02T11:00:04+0000'
-    }
-  } as PaymentState
-}
-
-const pageUrl = new URL('http://example.com/repeat/pizza-order/summary')
-
-const request = buildFormContextRequest({
-  method: 'get',
-  url: pageUrl,
-  path: pageUrl.pathname,
-  params: {
-    path: 'summary',
-    slug: 'payment'
-  },
-  query: {},
-  app: { model }
-})
-
-const context = model.getFormContext(
-  request,
-  state as unknown as FormSubmissionState
-)
-
-const pageDef = definition.pages[2]
-
-const controller = new SummaryPageController(model, pageDef)
-
-const summaryViewModel = controller.getSummaryViewModel(request, context)
-
-const items = getFormSubmissionData(
-  summaryViewModel.context,
-  summaryViewModel.details
-)
-
-describe('getPersonalisation', () => {
-  it('should return the machine output', () => {
-    model.def = definition
-
-    const body = format(context, items, model, submitResponse, formStatus)
-
-    const parsedBody = JSON.parse(body)
-
-    const expectedData = {
-      main: {
-        licenceLength: 365,
-        fullName: 'John Smith'
-      },
-      payment: {
-        amount: 250,
-        createdAt: '2026-01-02T11:00:04+0000',
-        description: 'Payment desc',
-        paymentId: 'payment-id',
-        reference: 'payment-ref'
-      },
-      repeaters: {},
-      files: {}
-    }
-
-    expect(parsedBody.meta.schemaVersion).toBe('2')
-    expect(parsedBody.meta.timestamp).toBeDateString()
-    expect(parsedBody.meta.definition).toEqual(definition)
-    expect(parsedBody.meta.referenceNumber).toBe('foobar')
-    expect(parsedBody.data).toEqual(expectedData)
-  })
-})