@defra/forms-engine-plugin 4.7.2 → 4.8.0

package/src/server/plugins/engine/outputFormatters/human/v1.payment.test.ts

@@ -1,147 +0,0 @@
-import { format as dateFormat } from 'date-fns'
-import { outdent } from 'outdent'
-
-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/human/v1.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 definitionPayment from '~/test/form/definitions/payment.js'
-
-describe('v1 human formatter', () => {
-  describe('Payment', () => {
-    const modelPayment = new FormModel(definitionPayment, {
-      basePath: 'test'
-    })
-
-    const submitResponse = {
-      message: 'Submit completed',
-      result: {
-        files: {
-          main: '00000000-0000-0000-0000-000000000000',
-          repeaters: {
-            pizza: '11111111-1111-1111-1111-111111111111'
-          }
-        }
-      }
-    }
-
-    const statePayment = {
-      $$__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:02:04+0000'
-        }
-      } as PaymentState
-    }
-
-    const pageUrl = new URL('http://example.com/repeat/pizza-order/summary')
-
-    const requestPayment = buildFormContextRequest({
-      method: 'get',
-      url: pageUrl,
-      path: pageUrl.pathname,
-      params: {
-        path: 'summary',
-        slug: 'payment'
-      },
-      query: {},
-      app: { model: modelPayment }
-    })
-
-    const pageDefPayment = definitionPayment.pages[2]
-
-    const controllerPayment = new SummaryPageController(
-      modelPayment,
-      pageDefPayment
-    )
-
-    const contextPayment = modelPayment.getFormContext(
-      requestPayment,
-      statePayment as unknown as FormSubmissionState
-    )
-    const summaryViewModelPayment = controllerPayment.getSummaryViewModel(
-      requestPayment,
-      contextPayment
-    )
-
-    const itemsPayment = getFormSubmissionData(
-      summaryViewModelPayment.context,
-      summaryViewModelPayment.details
-    )
-
-    it('should add payment details', () => {
-      const body = format(
-        contextPayment,
-        itemsPayment,
-        modelPayment,
-        submitResponse,
-        {
-          state: FormStatus.Draft,
-          isPreview: true
-        }
-      )
-
-      const dateNow = new Date()
-
-      expect(body).toContain(
-        outdent`
-              ${definitionPayment.name} form received at ${dateFormat(dateNow, 'h:mmaaa')} on ${dateFormat(dateNow, 'd MMMM yyyy')}.
-
-              ---
-
-              ## Which fishing licence do you want to get?
-
-              12 months \\(365\\)
-
-              ---
-
-              ## What\\'s your name?
-
-              John Smith
-
-              ---
-
-              [Download main form \\(CSV\\)](https://forms-designer/file-download/00000000-0000-0000-0000-000000000000)
-
-              ---
-
-              # Your payment of £250.00 was successful
-
-              ## Payment for
-
-              Payment desc
-
-              ---
-
-              ## Total amount
-
-              £250.00
-
-              ---
-
-              ## Date of payment
-
-              2 January 2026 11:02am
-
-              ---
-            `
-      )
-    })
-  })
-})

package/src/server/plugins/engine/outputFormatters/human/v1.test.ts

@@ -1,145 +0,0 @@
-import { addDays, format as dateFormat } from 'date-fns'
-import { outdent } from 'outdent'
-
-import { FormModel } from '~/src/server/plugins/engine/models/index.js'
-import { format } from '~/src/server/plugins/engine/outputFormatters/human/v1.js'
-import {
-  SummaryPageController,
-  getFormSubmissionData
-} from '~/src/server/plugins/engine/pageControllers/SummaryPageController.js'
-import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
-import { FormStatus } from '~/src/server/routes/types.js'
-import definition from '~/test/form/definitions/repeat-mixed.js'
-
-describe('v1 human formatter', () => {
-  const itemId1 = 'abc-123'
-  const itemId2 = 'xyz-987'
-
-  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 state = {
-    $$__referenceNumber: 'foobar',
-    orderType: 'delivery',
-    pizza: [
-      {
-        toppings: 'Ham',
-        quantity: 2,
-        itemId: itemId1
-      },
-      {
-        toppings: 'Pepperoni',
-        quantity: 1,
-        itemId: itemId2
-      }
-    ]
-  }
-
-  const pageDef = definition.pages[2]
-  const pageUrl = new URL('http://example.com/repeat/pizza-order/summary')
-
-  const controller = new SummaryPageController(model, pageDef)
-
-  const request = buildFormContextRequest({
-    method: 'get',
-    url: pageUrl,
-    path: pageUrl.pathname,
-    params: {
-      path: 'pizza-order',
-      slug: 'repeat'
-    },
-    query: {},
-    app: { model }
-  })
-
-  const context = model.getFormContext(request, state)
-  const summaryViewModel = controller.getSummaryViewModel(request, context)
-
-  const items = getFormSubmissionData(
-    summaryViewModel.context,
-    summaryViewModel.details
-  )
-
-  describe('getPersonalisation', () => {
-    it.each([
-      {
-        state: FormStatus.Live,
-        isPreview: false
-      },
-      {
-        state: FormStatus.Draft,
-        isPreview: true
-      }
-    ])('should personalise $state email', (formStatus) => {
-      const body = format(context, items, model, submitResponse, formStatus)
-
-      const dateNow = new Date()
-      const dateExpiry = addDays(dateNow, 90)
-
-      // Check for link expiry message
-      expect(body).toContain(
-        `^ For security reasons, the links in this email expire at ${dateFormat(dateExpiry, 'h:mmaaa')} on ${dateFormat(dateExpiry, 'eeee d MMMM yyyy')}`
-      )
-
-      expect(body).toContain(
-        outdent`
-              ${definition.name} form received at ${dateFormat(dateNow, 'h:mmaaa')} on ${dateFormat(dateNow, 'd MMMM yyyy')}.
-
-              ---
-
-              ## How would you like to receive your pizza?
-
-              Delivery
-
-              ---
-
-              ## Pizza
-
-              [Download Pizza \\(CSV\\)](https://forms-designer/file-download/11111111-1111-1111-1111-111111111111)
-
-              ---
-
-              [Download main form \\(CSV\\)](https://forms-designer/file-download/00000000-0000-0000-0000-000000000000)
-            `
-      )
-    })
-
-    it('should add test warnings to preview email only', () => {
-      const formStatus = {
-        state: FormStatus.Draft,
-        isPreview: true
-      }
-
-      const body1 = format(context, items, model, submitResponse, {
-        state: FormStatus.Live,
-        isPreview: false
-      })
-
-      const body2 = format(context, items, model, submitResponse, {
-        state: FormStatus.Draft,
-        isPreview: true
-      })
-
-      expect(body1).not.toContain(
-        `This is a test of the ${definition.name} ${formStatus.state} form`
-      )
-
-      expect(body2).toContain(
-        `This is a test of the ${definition.name} ${formStatus.state} form`
-      )
-    })
-  })
-})

package/src/server/plugins/engine/outputFormatters/index.test.ts

@@ -1,17 +0,0 @@
-import { format as formatHumanV1 } from '~/src/server/plugins/engine/outputFormatters/human/v1.js'
-import { getFormatter } from '~/src/server/plugins/engine/outputFormatters/index.js'
-
-describe('Page controller helpers', () => {
-  it('should return a valid formatter if it exists', () => {
-    const formatter = getFormatter('human', '1')
-    expect(formatter).toBe(formatHumanV1)
-  })
-
-  it("should return an error if the audience doesn't exist", () => {
-    expect(() => getFormatter('foobar', '1')).toThrow('Unknown audience')
-  })
-
-  it("should return an error if the version doesn't exist", () => {
-    expect(() => getFormatter('human', '9999')).toThrow('Unknown version')
-  })
-})

package/src/server/plugins/engine/outputFormatters/machine/v1.test.ts

@@ -1,268 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-
-import { FileUploadField } from '~/src/server/plugins/engine/components/FileUploadField.js'
-import { type Field } from '~/src/server/plugins/engine/components/helpers/components.js'
-import { FormModel } from '~/src/server/plugins/engine/models/index.js'
-import {
-  type DetailItem,
-  type DetailItemField,
-  type DetailItemRepeat
-} from '~/src/server/plugins/engine/models/types.js'
-import { format } from '~/src/server/plugins/engine/outputFormatters/machine/v1.js'
-import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControllers/__stubs__/request.js'
-import {
-  FileStatus,
-  UploadStatus,
-  type FileState
-} from '~/src/server/plugins/engine/types.js'
-import { FormStatus } from '~/src/server/routes/types.js'
-import definition from '~/test/form/definitions/repeat-mixed.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 dummyField: Field = {
-  getContextValueFromState: (_) => 'hello world'
-} as Field
-
-const itemId1 = 'abc-123'
-const itemId2 = 'xyz-987'
-
-const state = {
-  $$__referenceNumber: 'foobar',
-  orderType: 'delivery',
-  pizza: [
-    {
-      toppings: 'Ham',
-      quantity: 2,
-      itemId: itemId1
-    },
-    {
-      toppings: 'Pepperoni',
-      quantity: 1,
-      itemId: itemId2
-    }
-  ]
-}
-
-const pageUrl = new URL('http://example.com/repeat/pizza-order/summary')
-
-const request = buildFormContextRequest({
-  method: 'get',
-  url: pageUrl,
-  path: pageUrl.pathname,
-  params: {
-    path: 'pizza-order',
-    slug: 'repeat'
-  },
-  query: {},
-  app: { model }
-})
-
-const context = model.getFormContext(request, state)
-
-const testDetailItemField: DetailItemField = {
-  name: 'exampleField',
-  label: 'Example Field',
-  href: '/example-field',
-  title: 'Example Field Title',
-  field: dummyField,
-  value: 'Example Value'
-} as DetailItemField
-
-const testDetailItemField2: DetailItemField = {
-  name: 'exampleField2',
-  label: 'Example Field 2',
-  href: '/example-field 2',
-  title: 'Example Field 2 Title',
-  field: dummyField,
-  value: 'Example Value 2'
-} as DetailItemField
-
-const testDetailItemRepeat: DetailItemRepeat = {
-  name: 'exampleRepeat',
-  label: 'Example Repeat',
-  href: '/example-repeat',
-  title: 'Example Repeat Title',
-  value: 'Example Repeat Value',
-  subItems: [
-    [
-      {
-        name: 'subItem1_1',
-        label: 'Sub Item 1 1',
-        field: dummyField,
-        href: '/sub-item-1-1',
-        title: 'Sub Item 1 1 Title',
-        value: 'Sub Item 1 1 Value'
-      } as DetailItemField,
-      {
-        name: 'subItem1_2',
-        label: 'Sub Item 1 2',
-        field: dummyField,
-        href: '/sub-item-1-2',
-        title: 'Sub Item 1 2 Title',
-        value: 'Sub Item 1 2 Value'
-      } as DetailItemField
-    ],
-    [
-      {
-        name: 'subItem2_1',
-        label: 'Sub Item 2 1',
-        field: dummyField,
-        href: '/sub-item-2 1',
-        title: 'Sub Item 2 1 Title',
-        value: 'Sub Item 2 1 Value'
-      } as DetailItemField
-    ]
-  ]
-} as DetailItemRepeat
-
-const testDetailItemRepeat2: DetailItemRepeat = {
-  name: 'exampleRepeat2',
-  label: 'Example Repeat 2',
-  href: '/example-repeat-2',
-  title: 'Example Repeat 2 Title',
-  value: 'Example Repeat 2 Value',
-  subItems: [
-    [
-      {
-        name: 'subItem1_1',
-        label: 'Sub Item 1 1',
-        field: dummyField,
-        href: '/sub-item-1-1',
-        title: 'Sub Item 1 1 Title',
-        value: 'Sub Item 1 1 Value'
-      } as DetailItemField
-    ]
-  ]
-} as DetailItemRepeat
-
-const fileState: FileState = {
-  uploadId: '123',
-  status: {
-    form: {
-      file: {
-        fileId: '123-456-789',
-        contentLength: 1,
-        filename: 'foobar.txt',
-        fileStatus: FileStatus.complete
-      }
-    },
-    uploadStatus: UploadStatus.ready,
-    numberOfRejectedFiles: 0,
-    metadata: {
-      retrievalKey: '123'
-    }
-  }
-}
-
-const fileState2: FileState = {
-  uploadId: '456',
-  status: {
-    form: {
-      file: {
-        fileId: '456-789-123',
-        contentLength: 1,
-        filename: 'bazbuzz.txt',
-        fileStatus: FileStatus.complete
-      }
-    },
-    uploadStatus: UploadStatus.ready,
-    numberOfRejectedFiles: 0,
-    metadata: {
-      retrievalKey: '123'
-    }
-  }
-}
-
-const testDetailItemFile1: DetailItemField = Object.create(
-  FileUploadField.prototype
-)
-Object.assign(testDetailItemFile1, {
-  name: 'exampleFile1',
-  label: 'Example Field',
-  href: '/example-field',
-  title: 'Example Field Title',
-  field: testDetailItemFile1,
-  value: 'Example Value',
-  state: {
-    exampleFile1: [fileState, fileState2]
-  }
-})
-
-const items: DetailItem[] = [
-  testDetailItemField,
-  testDetailItemField2,
-  testDetailItemRepeat,
-  testDetailItemRepeat2,
-  testDetailItemFile1
-]
-
-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: {
-        exampleField: 'hello world',
-        exampleField2: 'hello world'
-      },
-      repeaters: {
-        exampleRepeat: [
-          {
-            subItem1_1: 'hello world',
-            subItem1_2: 'hello world'
-          },
-          {
-            subItem2_1: 'hello world'
-          }
-        ],
-        exampleRepeat2: [
-          {
-            subItem1_1: 'hello world'
-          }
-        ]
-      },
-      files: {
-        exampleFile1: [
-          {
-            fileId: '123-456-789',
-            userDownloadLink: 'https://forms-designer/file-download/123-456-789'
-          },
-          {
-            fileId: '456-789-123',
-            userDownloadLink: 'https://forms-designer/file-download/456-789-123'
-          }
-        ]
-      }
-    }
-
-    expect(parsedBody.meta.schemaVersion).toBe('1')
-    expect(parsedBody.meta.timestamp).toBeDateString()
-    expect(parsedBody.meta.definition).toEqual(definition)
-    expect(parsedBody.meta.referenceNumber).toBe('foobar')
-    expect(parsedBody.data).toEqual(expectedData)
-  })
-})