@defra/forms-engine-plugin 0.0.3 → 0.0.4

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

@@ -1,229 +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.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 {
-  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 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(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.data).toEqual(expectedData)
-  })
-})

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

@@ -1,140 +0,0 @@
-import { type SubmitResponsePayload } from '@defra/forms-model'
-
-import { config } from '~/src/config/index.js'
-import { getAnswer } from '~/src/server/plugins/engine/components/helpers.js'
-import { FileUploadField } from '~/src/server/plugins/engine/components/index.js'
-import { type checkFormStatus } from '~/src/server/plugins/engine/helpers.js'
-import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
-import {
-  type DetailItem,
-  type DetailItemField,
-  type DetailItemRepeat
-} from '~/src/server/plugins/engine/models/types.js'
-
-const designerUrl = config.get('designerUrl')
-
-export function format(
-  items: DetailItem[],
-  model: FormModel,
-  _submitResponse: SubmitResponsePayload,
-  _formStatus: ReturnType<typeof checkFormStatus>
-) {
-  const now = new Date()
-
-  const categorisedData = categoriseData(items)
-
-  const data = {
-    meta: {
-      schemaVersion: '1',
-      timestamp: now.toISOString(),
-      definition: model.def
-    },
-    data: categorisedData
-  }
-
-  const body = JSON.stringify(data)
-
-  return body
-}
-
-/**
- * Categories the form submission data into the "main" body and "repeaters".
- *
- * {
- *    main: {
- *       componentName: 'componentValue',
- *    },
- *    repeaters: {
- *      repeaterName: [
- *        {
- *          componentName: 'componentValue'
- *        }
- *      ]
- *    },
- *    files: {
- *      fileComponentName: [
- *        {
- *          fileId: '123-456-789',
- *          link: 'https://forms-designer/file-download/123-456-789'
- *        }
- *      ]
- *    }
- * }
- */
-function categoriseData(items: DetailItem[]) {
-  const output: {
-    main: Record<string, string>
-    repeaters: Record<string, Record<string, string>[]>
-    files: Record<string, Record<string, string>[]>
-  } = { main: {}, repeaters: {}, files: {} }
-
-  items.forEach((item) => {
-    if ('subItems' in item) {
-      output.repeaters[item.name] = extractRepeaters(item)
-    } else if (isFileUploadFieldItem(item)) {
-      output.files[item.name] = extractFileUploads(item)
-    } else {
-      output.main[item.name] = getAnswer(item.field, item.state, {
-        format: 'data'
-      })
-    }
-  })
-
-  return output
-}
-
-/**
- * Returns the "repeaters" section of the response body
- * @param item - the repeater item
- * @returns the repeater item
- */
-function extractRepeaters(item: DetailItemRepeat) {
-  const repeaters: Record<string, string>[] = []
-
-  item.subItems.forEach((inputRepeaterItem) => {
-    const outputRepeaterItem: Record<string, string> = {}
-
-    inputRepeaterItem.forEach((repeaterComponent) => {
-      outputRepeaterItem[repeaterComponent.name] = getAnswer(
-        repeaterComponent.field,
-        repeaterComponent.state,
-        {
-          format: 'data'
-        }
-      )
-    })
-
-    repeaters.push(outputRepeaterItem)
-  })
-
-  return repeaters
-}
-
-/**
- * Returns the "files" section of the response body
- * @param item - the file upload item in the form
- * @returns the file upload data
- */
-function extractFileUploads(item: FileUploadFieldDetailitem) {
-  const fileUploadState = item.field.getContextValueFromState(item.state) ?? []
-
-  return fileUploadState.map((fileId) => {
-    return {
-      fileId,
-      userDownloadLink: `${designerUrl}/file-download/${fileId}`
-    }
-  })
-}
-
-function isFileUploadFieldItem(
-  item: DetailItemField
-): item is FileUploadFieldDetailitem {
-  return item.field instanceof FileUploadField
-}
-
-/**
- * A detail item specifically for files
- */
-type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {
-  field: FileUploadField
-}

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

@@ -1,229 +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.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/v2.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 = {
-  getFormValueFromState: (_) => 'hello world'
-} as Field
-
-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(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('2')
-    expect(parsedBody.meta.timestamp).toBeDateString()
-    expect(parsedBody.meta.definition).toEqual(definition)
-    expect(parsedBody.data).toEqual(expectedData)
-  })
-})