@defra/forms-engine-plugin 0.1.10 → 0.1.12

package/src/server/forms/test.yaml

@@ -1,363 +0,0 @@
----
-startPage: "/start"
-pages:
-- title: Start
-  path: "/start"
-  components: []
-  next:
-  - path: "/uk-passport"
-  controller: StartPageController
-- path: "/uk-passport"
-  components:
-  - type: YesNoField
-    name: ukPassport
-    title: Do you have a UK passport?
-    options:
-      required: true
-    schema: {}
-  section: checkBeforeYouStart
-  next:
-  - path: "/how-many-people"
-  - path: "/no-uk-passport"
-    condition: doesntHaveUKPassport
-  title: Do you have a UK passport?
-- path: "/no-uk-passport"
-  title: You're not eligible for this service
-  components:
-  - type: Html
-    name: html
-    title: Html
-    content: >-
-      <p class="govuk-body">
-        If you still think you're eligible please contact the Foreign and Commonwealth Office.
-      </p>
-    options: {}
-    schema: {}
-  next: []
-- path: "/how-many-people"
-  section: applicantDetails
-  components:
-  - options:
-      classes: govuk-input--width-10
-      required: true
-    type: SelectField
-    name: numberOfApplicants
-    title: How many applicants are there?
-    list: numberOfApplicants
-  next:
-  - path: "/applicant-one"
-  title: How many applicants are there?
-- path: "/applicant-one"
-  title: Applicant 1
-  section: applicantOneDetails
-  components:
-  - type: Html
-    name: html
-    title: Html
-    content: <p class="govuk-body">Provide the details as they appear on your passport.</p>
-    options: {}
-    schema: {}
-  - type: TextField
-    name: firstName
-    title: First name
-    options:
-      required: true
-    schema: {}
-  - options:
-      required: false
-      optionalText: false
-    type: TextField
-    name: middleName
-    title: Middle name
-    hint: If you have a middle name on your passport you must include it here
-    schema: {}
-  - type: TextField
-    name: lastName
-    title: Surname
-    options:
-      required: true
-    schema: {}
-  next:
-  - path: "/applicant-one-address"
-- path: "/applicant-one-address"
-  section: applicantOneDetails
-  components:
-  - type: UkAddressField
-    name: address
-    title: Address
-    options:
-      required: true
-    schema: {}
-  next:
-  - path: "/applicant-two"
-    condition: moreThanOneApplicant
-  - path: "/contact-details"
-  title: Address
-- path: "/applicant-two"
-  title: Applicant 2
-  section: applicantTwoDetails
-  components:
-  - type: Html
-    name: html
-    title: Html
-    content: <p class="govuk-body">Provide the details as they appear on your passport.</p>
-    options: {}
-    schema: {}
-  - type: TextField
-    name: firstName
-    title: First name
-    options:
-      required: true
-    schema: {}
-  - options:
-      required: false
-      optionalText: false
-    type: TextField
-    name: middleName
-    title: Middle name
-    hint: If you have a middle name on your passport you must include it here
-    schema: {}
-  - type: TextField
-    name: lastName
-    title: Surname
-    options:
-      required: true
-    schema: {}
-  next:
-  - path: "/applicant-two-address"
-- path: "/applicant-two-address"
-  section: applicantTwoDetails
-  components:
-  - type: UkAddressField
-    name: address
-    title: Address
-    options:
-      required: true
-    schema: {}
-  next:
-  - path: "/applicant-three"
-    condition: moreThanTwoApplicants
-  - path: "/contact-details"
-  title: Address
-- path: "/applicant-three"
-  title: Applicant 3
-  section: applicantThreeDetails
-  components:
-  - type: Html
-    name: html
-    title: Html
-    content: <p class="govuk-body">Provide the details as they appear on your passport.</p>
-    options: {}
-    schema: {}
-  - type: TextField
-    name: firstName
-    title: First name
-    options:
-      required: true
-    schema: {}
-  - options:
-      required: false
-      optionalText: false
-    type: TextField
-    name: middleName
-    title: Middle name
-    hint: If you have a middle name on your passport you must include it here
-    schema: {}
-  - type: TextField
-    name: lastName
-    title: Surname
-    options:
-      required: true
-    schema: {}
-  next:
-  - path: "/applicant-three-address"
-- path: "/applicant-three-address"
-  section: applicantThreeDetails
-  components:
-  - type: UkAddressField
-    name: address
-    title: Address
-    options:
-      required: true
-    schema: {}
-  next:
-  - path: "/applicant-four"
-    condition: moreThanThreeApplicants
-  - path: "/contact-details"
-  title: Address
-- path: "/applicant-four"
-  title: Applicant 4
-  section: applicantFourDetails
-  components:
-  - type: Html
-    name: html
-    title: Html
-    content: <p class="govuk-body">Provide the details as they appear on your passport.</p>
-    options: {}
-    schema: {}
-  - type: TextField
-    name: firstName
-    title: First name
-    options:
-      required: true
-    schema: {}
-  - options:
-      required: false
-      optionalText: false
-    type: TextField
-    name: middleName
-    title: Middle name
-    hint: If you have a middle name on your passport you must include it here
-    schema: {}
-  - type: TextField
-    name: lastName
-    title: Surname
-    options:
-      required: true
-    schema: {}
-  next:
-  - path: "/applicant-four-address"
-- path: "/applicant-four-address"
-  section: applicantFourDetails
-  components:
-  - type: UkAddressField
-    name: address
-    title: Address
-    options:
-      required: true
-    schema: {}
-  next:
-  - path: "/contact-details"
-  title: Address
-- path: "/contact-details"
-  section: applicantDetails
-  components:
-  - type: TelephoneNumberField
-    name: phoneNumber
-    title: Phone number
-    hint: If you haven't got a UK phone number, include country code
-    options:
-      required: true
-    schema: {}
-  - type: EmailAddressField
-    name: emailAddress
-    title: Your email address
-    options:
-      required: true
-    schema: {}
-  next:
-  - path: "/summary"
-  title: Applicant contact details
-- path: "/summary"
-  controller: SummaryPageController
-  title: Summary
-  components: []
-  next: []
-lists:
-- name: numberOfApplicants
-  title: Number of people
-  type: number
-  items:
-  - text: '1'
-    value: 1
-    description: ''
-    condition: ''
-  - text: '2'
-    value: 2
-    description: ''
-    condition: ''
-  - text: '3'
-    value: 3
-    description: ''
-    condition: ''
-  - text: '4'
-    value: 4
-    description: ''
-    condition: ''
-sections:
-- name: checkBeforeYouStart
-  title: Check before you start
-- name: applicantDetails
-  title: Applicant details
-- name: applicantOneDetails
-  title: Applicant 1
-- name: applicantTwoDetails
-  title: Applicant 2
-- name: applicantThreeDetails
-  title: Applicant 3
-- name: applicantFourDetails
-  title: Applicant 4
-phaseBanner: {}
-declaration: <p class="govuk-body">All the answers you have provided are true to the
-  best of your knowledge.</p>
-conditions:
-- name: hasUKPassport
-  displayName: hasUKPassport
-  value:
-    name: hasUKPassport
-    conditions:
-    - field:
-        name: checkBeforeYouStart.ukPassport
-        type: YesNoField
-        display: Do you have a UK passport?
-      operator: is
-      value:
-        type: Value
-        value: 'true'
-        display: 'true'
-- name: doesntHaveUKPassport
-  displayName: doesntHaveUKPassport
-  value:
-    name: doesntHaveUKPassport
-    conditions:
-    - field:
-        name: checkBeforeYouStart.ukPassport
-        type: YesNoField
-        display: Do you have a UK passport?
-      operator: is
-      value:
-        type: Value
-        value: 'false'
-        display: 'false'
-- name: moreThanOneApplicant
-  displayName: moreThanOneApplicant
-  value:
-    name: moreThanOneApplicant
-    conditions:
-    - field:
-        name: applicantDetails.numberOfApplicants
-        type: SelectField
-        display: How many applicants are there?
-      operator: is more than
-      value:
-        type: Value
-        value: '1'
-        display: '1'
-- name: moreThanTwoApplicants
-  displayName: moreThanTwoApplicants
-  value:
-    name: moreThanTwoApplicants
-    conditions:
-    - field:
-        name: applicantDetails.numberOfApplicants
-        type: SelectField
-        display: How many applicants are there?
-      operator: is more than
-      value:
-        type: Value
-        value: '2'
-        display: '2'
-- name: moreThanThreeApplicants
-  displayName: moreThanThreeApplicants
-  value:
-    name: moreThanThreeApplicants
-    conditions:
-    - field:
-        name: applicantDetails.numberOfApplicants
-        type: SelectField
-        display: How many applicants are there?
-      operator: is more than
-      value:
-        type: Value
-        value: '3'
-        display: '3'

package/src/server/plugins/blankie.test.ts

@@ -1,73 +0,0 @@
-import { config } from '~/src/config/index.js'
-import { configureBlankiePlugin } from '~/src/server/plugins/blankie.js'
-
-describe('Server Blankie Plugin', () => {
-  test('configuration default options are provided', () => {
-    config.set('googleAnalyticsTrackingId', '')
-
-    const { options } = configureBlankiePlugin()
-
-    expect(options).toEqual({
-      defaultSrc: ['self'],
-      fontSrc: ['self', 'data:'],
-      frameSrc: ['self', 'data:'],
-      connectSrc: ['self', 'https://test-uploader.cdp-int.defra.cloud'],
-      scriptSrc: ['self', 'strict-dynamic', 'unsafe-inline'],
-      styleSrc: ['self', 'unsafe-inline'],
-      imgSrc: ['self'],
-      generateNonces: true
-    })
-  })
-
-  test('configuration default and GA options are provided', () => {
-    config.set('googleAnalyticsTrackingId', '12345')
-
-    const { options } = configureBlankiePlugin()
-
-    expect(options).toEqual({
-      defaultSrc: ['self'],
-      fontSrc: ['self', 'data:'],
-      frameSrc: ['self', 'data:'],
-      connectSrc: [
-        'self',
-        'https://*.google-analytics.com',
-        'https://*.analytics.google.com',
-        'https://*.googletagmanager.com',
-        'https://test-uploader.cdp-int.defra.cloud'
-      ],
-      scriptSrc: [
-        'self',
-        'strict-dynamic',
-        'unsafe-inline',
-        'https://*.googletagmanager.com'
-      ],
-      styleSrc: ['self', 'unsafe-inline'],
-      imgSrc: [
-        'self',
-        'https://*.google-analytics.com',
-        'https://*.googletagmanager.com'
-      ],
-      generateNonces: true
-    })
-  })
-
-  test('configuration includes uploaderUrl when provided', () => {
-    config.set('googleAnalyticsTrackingId', '')
-    config.set('uploaderUrl', 'https://some-random-uploader.example.com')
-
-    const { options } = configureBlankiePlugin()
-
-    expect(options?.connectSrc).toContain(
-      'https://some-random-uploader.example.com'
-    )
-  })
-
-  test('configuration does not include uploaderUrl when not provided', () => {
-    config.set('googleAnalyticsTrackingId', '')
-    config.set('uploaderUrl', '')
-
-    const { options } = configureBlankiePlugin()
-
-    expect(options?.connectSrc).toEqual(['self'])
-  })
-})

package/src/server/plugins/blankie.ts

@@ -1,48 +0,0 @@
-import { type ServerRegisterPluginObject } from '@hapi/hapi'
-import Blankie from 'blankie'
-
-import { config } from '~/src/config/index.js'
-
-const googleAnalyticsOptions = {
-  scriptSrc: ['https://*.googletagmanager.com'],
-  imgSrc: ['https://*.google-analytics.com', 'https://*.googletagmanager.com'],
-  connectSrc: [
-    'https://*.google-analytics.com',
-    'https://*.analytics.google.com',
-    'https://*.googletagmanager.com'
-  ]
-}
-
-export const configureBlankiePlugin = (): ServerRegisterPluginObject<
-  Record<string, boolean | string | string[]>
-> => {
-  const gaTrackingId = config.get('googleAnalyticsTrackingId')
-  const uploaderUrl = config.get('uploaderUrl')
-
-  /*
-  Note that unsafe-inline is a fallback for old browsers that don't support nonces. It will be ignored by modern browsers as the nonce is provided.
-  */
-  return {
-    plugin: Blankie,
-    options: {
-      defaultSrc: ['self'],
-      fontSrc: ['self', 'data:'],
-      connectSrc: [
-        ['self'],
-        gaTrackingId ? googleAnalyticsOptions.connectSrc : [],
-        uploaderUrl ? [uploaderUrl] : []
-      ].flat(),
-      scriptSrc: [
-        ['self', 'strict-dynamic', 'unsafe-inline'],
-        gaTrackingId ? googleAnalyticsOptions.scriptSrc : []
-      ].flat(),
-      styleSrc: ['self', 'unsafe-inline'],
-      imgSrc: [
-        ['self'],
-        gaTrackingId ? googleAnalyticsOptions.imgSrc : []
-      ].flat(),
-      frameSrc: ['self', 'data:'],
-      generateNonces: true
-    }
-  }
-}

package/src/server/plugins/engine/services/formsService.test.js

@@ -1,90 +0,0 @@
-import { StatusCodes } from 'http-status-codes'
-
-import {
-  getFormDefinition,
-  getFormMetadata
-} from '~/src/server/plugins/engine/services/formsService.js'
-import { FormStatus } from '~/src/server/routes/types.js'
-import { getJson } from '~/src/server/services/httpService.js'
-import * as fixtures from '~/test/fixtures/index.js'
-
-const { MANAGER_URL } = process.env
-
-jest.mock('~/src/server/services/httpService')
-
-describe('Forms service', () => {
-  const { definition, metadata } = fixtures.form
-
-  describe('getFormMetadata', () => {
-    beforeEach(() => {
-      jest.mocked(getJson).mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.OK
-        }),
-        payload: metadata
-      })
-    })
-
-    it('requests JSON via form slug', async () => {
-      await getFormMetadata(metadata.slug)
-
-      expect(getJson).toHaveBeenCalledWith(
-        `${MANAGER_URL}/forms/slug/${metadata.slug}`
-      )
-    })
-
-    it('coerces timestamps from string to Date', async () => {
-      const payload = {
-        ...structuredClone(metadata),
-
-        // JSON payload uses string dates in transit
-        createdAt: metadata.createdAt.toISOString(),
-        updatedAt: metadata.updatedAt.toISOString()
-      }
-
-      jest.mocked(getJson).mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.OK
-        }),
-        payload
-      })
-
-      await expect(getFormMetadata(metadata.slug)).resolves.toEqual({
-        ...metadata,
-        createdAt: expect.any(Date),
-        updatedAt: expect.any(Date)
-      })
-    })
-  })
-
-  describe('getFormDefinition', () => {
-    beforeEach(() => {
-      jest.mocked(getJson).mockResolvedValue({
-        res: /** @type {IncomingMessage} */ ({
-          statusCode: StatusCodes.OK
-        }),
-        payload: definition
-      })
-    })
-
-    it('requests JSON via form ID (draft)', async () => {
-      await getFormDefinition(metadata.id, FormStatus.Draft)
-
-      expect(getJson).toHaveBeenCalledWith(
-        `${MANAGER_URL}/forms/${metadata.id}/definition/draft`
-      )
-    })
-
-    it('requests JSON via form ID (live)', async () => {
-      await getFormDefinition(metadata.id, FormStatus.Live)
-
-      expect(getJson).toHaveBeenCalledWith(
-        `${MANAGER_URL}/forms/${metadata.id}/definition`
-      )
-    })
-  })
-})
-
-/**
- * @import { IncomingMessage } from 'node:http'
- */