@defra/forms-engine-plugin 0.0.1

package/compose/aws.env

@@ -0,0 +1,4 @@
+AWS_REGION=eu-west-2
+AWS_DEFAULT_REGION=eu-west-2
+AWS_ACCESS_KEY_ID=test
+AWS_SECRET_ACCESS_KEY=test

package/compose/start-localstack.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+export AWS_REGION=eu-west-2
+export AWS_DEFAULT_REGION=eu-west-2
+export AWS_ACCESS_KEY_ID=test
+export AWS_SECRET_ACCESS_KEY=test
+
+aws --endpoint-url=http://localhost:4566 s3 mb s3://cdp-uploader-quarantine
+aws --endpoint-url=http://localhost:4566 s3 mb s3://my-bucket
+
+# queues
+aws --endpoint-url=http://localhost:4566 sqs create-queue --queue-name cdp-clamav-results
+aws --endpoint-url=http://localhost:4566 sqs create-queue --queue-name cdp-uploader-scan-results-callback.fifo --attributes "{\"FifoQueue\":\"true\",\"ContentBasedDeduplication\": \"true\"}"
+
+# test harness
+aws --endpoint-url=http://localhost:4566 sqs create-queue --queue-name mock-clamav
+aws --endpoint-url=http://localhost:4566 s3api put-bucket-notification-configuration\
+  --bucket cdp-uploader-quarantine \
+  --notification-configuration '
+    {
+      "QueueConfigurations": [
+        {
+          "QueueArn": "arn:aws:sqs:eu-west-2:000000000000:mock-clamav",
+          "Events": ["s3:ObjectCreated:*"]
+        }
+      ]
+    }'

package/docker-compose.yaml

@@ -0,0 +1,86 @@
+services:
+  redis:
+    image: redis:7.0.7
+    restart: unless-stopped
+    ports:
+      - '6379:6379'
+    environment:
+      - REDIS_PASSWORD=my-password
+      - REDIS_PORT=6379
+    networks:
+      - cdpuploader
+
+  redisinsight:
+    image: redislabs/redisinsight:latest
+    ports:
+      - '5540:5540'
+    volumes:
+      - redisinsight:/data
+    depends_on:
+      - redis
+
+  localstack:
+    image: localstack/localstack:3.0.2
+    ports:
+      - '127.0.0.1:4566:4566' # LocalStack Gateway
+      - '127.0.0.1:4510-4559:4510-4559' # external services port range
+    env_file:
+      - 'compose/aws.env'
+    environment:
+      DEBUG: ${DEBUG:-1}
+      LS_LOG: WARN # Localstack DEBUG Level
+      SERVICES: s3,sqs,sns,firehose
+      LOCALSTACK_HOST: 127.0.0.1
+    volumes:
+      - '${TMPDIR:-/tmp}/localstack:/var/lib/localstack'
+      - ./compose/start-localstack.sh:/etc/localstack/init/ready.d/start-localstack.sh
+    healthcheck:
+      test: ['CMD', 'curl', 'localhost:4566']
+      interval: 5s
+      start_period: 5s
+      retries: 3
+    networks:
+      cdpuploader:
+        ipv4_address: 10.0.2.20
+
+  cdp-uploader:
+    image: defradigital/cdp-uploader:${CDP_UPLOADER_VERSION:-latest}
+    ports:
+      - '127.0.0.1:7337:7337'
+    links:
+      - 'localstack:localstack'
+      - 'redis:redis'
+    depends_on:
+      localstack:
+        condition: service_healthy
+    env_file:
+      - 'compose/aws.env'
+    environment:
+      VIRTUAL_HOST: ~^uploader\..*\.sslip\.io
+      VIRTUAL_PATH: /
+      VIRTUAL_PORT: 7337
+      PORT: 7337
+      NODE_ENV: development
+      REDIS_HOST: redis
+      LOCALSTACK_ENDPOINT: http://localhost.localstack.cloud:4566
+      S3_ENDPOINT: http://localhost.localstack.cloud:4566
+      SQS_ENDPOINT: http://localhost.localstack.cloud:4566
+      USE_SINGLE_INSTANCE_CACHE: true
+      MOCK_VIRUS_SCAN_ENABLED: true
+      MOCK_VIRUS_RESULT_DELAY: 3
+    dns:
+      # Set the DNS server to be the LocalStack container
+      - 10.0.2.20
+    networks:
+      - cdpuploader
+
+volumes:
+  redisinsight:
+
+networks:
+  cdpuploader:
+    driver: bridge
+    ipam:
+      config:
+        # Specify the subnet range for IP address allocation
+        - subnet: 10.0.2.0/24

package/globals.d.ts

@@ -0,0 +1 @@
+import 'jest-extended'

package/jest.config.cjs

@@ -0,0 +1,54 @@
+const { CI } = process.env
+
+/**
+ * Jest config
+ * @type {import('@jest/types').Config.InitialOptions}
+ */
+module.exports = {
+  resetMocks: true,
+  resetModules: true,
+  restoreMocks: true,
+  clearMocks: true,
+  silent: true,
+  testMatch: [
+    '<rootDir>/src/**/*.test.{cjs,js,mjs,ts}',
+    '<rootDir>/test/**/*.test.{cjs,js,mjs,ts}'
+  ],
+  reporters: CI
+    ? [['github-actions', { silent: false }], 'summary']
+    : ['default', 'summary'],
+  collectCoverageFrom: ['<rootDir>/src/**/*.{cjs,js,mjs,ts}'],
+  coveragePathIgnorePatterns: [
+    '<rootDir>/node_modules/',
+    '<rootDir>/.server',
+    '<rootDir>/src/client/(?!javascripts)',
+    '<rootDir>/src/client/javascripts/application.js',
+    '<rootDir>/test'
+  ],
+  coverageDirectory: '<rootDir>/coverage',
+  setupFiles: ['<rootDir>/jest.setup.cjs'],
+  setupFilesAfterEnv: ['<rootDir>/jest.environment.js', 'jest-extended/all'],
+  transform: {
+    '^.+\\.(cjs|js|mjs|ts)$': [
+      'babel-jest',
+      {
+        browserslistEnv: 'node',
+        plugins: ['transform-import-meta'],
+        rootMode: 'upward'
+      }
+    ]
+  },
+
+  // Enable Babel transforms for node_modules
+  // See: https://jestjs.io/docs/ecmascript-modules
+  transformIgnorePatterns: [
+    `node_modules/(?!${[
+      '@defra/forms-model/.*',
+      'nanoid', // Supports ESM only
+      'slug', // Supports ESM only
+      '@defra/hapi-tracing' // Supports ESM only|
+    ].join('|')}/)`
+  ],
+  testTimeout: 10000,
+  forceExit: true
+}

package/jest.environment.js

@@ -0,0 +1,4 @@
+import '@testing-library/jest-dom'
+import JSDOM from 'global-jsdom'
+
+JSDOM()

package/jest.setup.cjs

@@ -0,0 +1,14 @@
+process.env.MANAGER_URL = 'http://localhost:3001'
+process.env.REDIS_HOST = 'dummy'
+process.env.REDIS_KEY_PREFIX = 'forms-designer'
+process.env.REDIS_PASSWORD = 'dummy'
+process.env.REDIS_USERNAME = 'dummy'
+process.env.SESSION_COOKIE_PASSWORD = 'test-env-session-cookie-password'
+process.env.NOTIFY_TEMPLATE_ID = 'dummy'
+process.env.NOTIFY_API_KEY = 'dummy'
+process.env.FEEDBACK_LINK = 'https://test.defra.gov.uk/'
+process.env.DESIGNER_URL = 'https://forms-designer'
+process.env.SUBMISSION_URL = 'https://test-submission-api.cdp-int.defra.cloud'
+process.env.UPLOADER_URL = 'https://test-uploader.cdp-int.defra.cloud'
+process.env.UPLOADER_BUCKET_NAME = 'dummy-bucket'
+process.env.GOOGLE_ANALYTICS_TRACKING_ID = 'G-123456789'

package/package.json

@@ -0,0 +1,163 @@
+{
+  "name": "@defra/forms-engine-plugin",
+  "version": "0.0.1",
+  "description": "Defra forms engine",
+  "type": "module",
+  "main": ".server/server/plugins/engine/index.js",
+  "scripts": {
+    "build": "npm run build:server && npm run build:client",
+    "build:client": "NODE_ENV=${NODE_ENV:-production} webpack",
+    "build:server": "babel --delete-dir-on-start --extensions \".js\",\".ts\" --ignore \"**/*.test.ts\" --copy-files --no-copy-ignored --source-maps --out-dir ./.server ./src",
+    "dev": "concurrently \"npm run client:watch\" \"npm run server:watch:dev\" --kill-others --names \"client,server\" --prefix-colors \"red.dim,blue.dim\"",
+    "dev:debug": "concurrently \"npm run client:watch\" \"npm run server:watch:debug\" --kill-others --names \"client,server\" --prefix-colors \"red.dim,blue.dim\"",
+    "format": "npm run format:check -- --write",
+    "format:check": "prettier --cache --cache-location .cache/prettier --cache-strategy content --check \"**/*.{cjs,js,json,md,mjs,scss,ts}\"",
+    "postinstall": "npm run setup:husky",
+    "lint": "npm run lint:editorconfig && npm run lint:js && npm run lint:types",
+    "lint:editorconfig": "editorconfig-checker",
+    "lint:fix": "npm run lint:js -- --fix",
+    "lint:js": "eslint --cache --cache-location .cache/eslint --cache-strategy content --color --ignore-path .gitignore .",
+    "lint:scss": "stylelint --cache --cache-location .cache/stylelint --cache-strategy content --color --ignore-path .gitignore --max-warnings 0 \"**/*.scss\"",
+    "lint:types": "tsc --noEmit",
+    "test": "jest --color --coverage --verbose",
+    "test:watch": "jest --color --watch",
+    "client:watch": "NODE_ENV=development npm run build:client -- --watch",
+    "server:watch": "NODE_ENV=development tsx watch --clear-screen=false --enable-source-maps --exclude \"**/*.test.*\"",
+    "server:watch:dev": "npm run server:watch -- ./src/index.ts",
+    "server:watch:debug": "npm run server:watch -- --inspect-wait ./src/index.ts",
+    "prestart": "npm run build",
+    "start": "NODE_ENV=${NODE_ENV:-production} node --enable-source-maps ./.server",
+    "setup:husky": "node -e \"try { (await import('husky')).default() } catch (e) { if (e.code !== 'ERR_MODULE_NOT_FOUND') throw e }\" --input-type module"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XGovFormBuilder/digital-form-builder/tree/main/builder"
+  },
+  "engines": {
+    "node": "^22.11.0",
+    "npm": "^10.9.0"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "dependencies": {
+    "@defra/forms-model": "^3.0.409",
+    "@defra/hapi-tracing": "^1.0.0",
+    "@elastic/ecs-pino-format": "^1.5.0",
+    "@hapi/boom": "^10.0.1",
+    "@hapi/catbox": "^12.1.1",
+    "@hapi/catbox-memory": "^6.0.2",
+    "@hapi/catbox-redis": "^7.0.2",
+    "@hapi/crumb": "^9.0.1",
+    "@hapi/hapi": "^21.3.12",
+    "@hapi/hoek": "^11.0.7",
+    "@hapi/inert": "^7.1.0",
+    "@hapi/jwt": "^3.2.0",
+    "@hapi/scooter": "^7.0.0",
+    "@hapi/vision": "^7.0.3",
+    "@hapi/wreck": "^18.1.0",
+    "@hapi/yar": "^11.0.2",
+    "@hapipal/schmervice": "^3.0.0",
+    "@types/humanize-duration": "^3.27.4",
+    "accessible-autocomplete": "^3.0.1",
+    "atob": "^2.1.2",
+    "blankie": "^5.0.0",
+    "blipp": "^4.0.2",
+    "btoa": "^1.2.1",
+    "convict": "^6.2.4",
+    "date-fns": "^4.1.0",
+    "dotenv": "^16.4.7",
+    "expr-eval": "^2.0.2",
+    "govuk-frontend": "^5.7.1",
+    "hapi-pino": "^12.1.0",
+    "hapi-pulse": "^3.0.1",
+    "highlight.js": "^11.11.1",
+    "http-status-codes": "^2.3.0",
+    "humanize-duration": "^3.32.1",
+    "ioredis": "^5.4.2",
+    "joi": "^17.13.3",
+    "liquidjs": "^10.20.3",
+    "lodash": "^4.17.21",
+    "marked": "^15.0.6",
+    "nunjucks": "^3.2.3",
+    "pino": "^9.6.0",
+    "pino-pretty": "^13.0.0",
+    "proxy-agent": "^6.5.0",
+    "resolve": "^1.22.10"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.26.4",
+    "@babel/core": "^7.26.0",
+    "@babel/plugin-syntax-import-attributes": "^7.26.0",
+    "@babel/preset-env": "^7.26.0",
+    "@babel/preset-typescript": "^7.26.0",
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@types/atob": "^2.1.4",
+    "@types/btoa": "^1.2.5",
+    "@types/convict": "^6.1.6",
+    "@types/eslint": "^9.6.1",
+    "@types/govuk-frontend": "^5.7.0",
+    "@types/hapi": "^18.0.14",
+    "@types/hapi__catbox-memory": "^4.1.8",
+    "@types/hapi__cookie": "^12.0.5",
+    "@types/hapi__crumb": "^7.3.7",
+    "@types/hapi__yar": "^10.1.6",
+    "@types/hoek": "^4.1.7",
+    "@types/jest": "^29.5.14",
+    "@types/jsdom": "^21.1.7",
+    "@types/lodash": "^4.17.13",
+    "@types/mysql": "^2.15.26",
+    "@types/node": "^22.10.2",
+    "@types/nunjucks": "^3.2.6",
+    "@types/resolve": "^1.20.6",
+    "@types/url-parse": "^1.4.11",
+    "@types/webpack-assets-manifest": "^5.1.4",
+    "@types/wreck": "^14.0.4",
+    "@typescript-eslint/eslint-plugin": "^8.19.0",
+    "@typescript-eslint/parser": "^8.19.0",
+    "autoprefixer": "^10.4.20",
+    "babel-loader": "^9.2.1",
+    "babel-plugin-module-resolver": "^5.0.2",
+    "babel-plugin-replace-import-extension": "^1.1.4",
+    "babel-plugin-transform-import-meta": "^2.3.2",
+    "clean-webpack-plugin": "^4.0.0",
+    "concurrently": "^9.1.2",
+    "cookie": "^1.0.2",
+    "copy-webpack-plugin": "^12.0.2",
+    "core-js": "^3.39.0",
+    "cssnano": "^7.0.6",
+    "cssnano-preset-default": "^7.0.4",
+    "editorconfig-checker": "^6.0.0",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-import-resolver-typescript": "^3.7.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jest": "^28.10.0",
+    "eslint-plugin-jsdoc": "^50.6.1",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-promise": "^6.6.0",
+    "global-jsdom": "^25.0.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "jest-extended": "^4.0.2",
+    "jsdom": "^25.0.1",
+    "lint-staged": "^15.3.0",
+    "outdent": "^0.8.0",
+    "postcss": "^8.4.49",
+    "postcss-load-config": "^6.0.1",
+    "postcss-loader": "^8.1.1",
+    "postcss-scss": "^4.0.9",
+    "prettier": "^3.4.2",
+    "sass-embedded": "^1.83.1",
+    "sass-loader": "^16.0.4",
+    "source-map-loader": "^5.0.0",
+    "stylelint": "^16.12.0",
+    "stylelint-config-gds": "^2.0.0",
+    "terser-webpack-plugin": "^5.3.11",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2",
+    "webpack": "^5.97.1",
+    "webpack-assets-manifest": "^5.2.1",
+    "webpack-cli": "^6.0.1"
+  }
+}

package/postcss.config.js

@@ -0,0 +1,26 @@
+import autoprefixer from 'autoprefixer'
+import cssnano from 'cssnano'
+import cssnanoPresetDefault from 'cssnano-preset-default'
+
+/**
+ * @type {Config}
+ */
+export default {
+  plugins: [
+    // Add vendor prefixes
+    autoprefixer({
+      env: 'stylesheets'
+    }),
+
+    // Apply CSS optimisations
+    cssnano({
+      preset: cssnanoPresetDefault({
+        env: 'stylesheets'
+      })
+    })
+  ]
+}
+
+/**
+ * @import { Config } from 'postcss-load-config'
+ */

package/sonar-project.properties

@@ -0,0 +1,17 @@
+sonar.projectKey=DEFRA_forms-runner
+sonar.projectName=forms-runner
+sonar.organization=defra
+
+sonar.links.homepage=https://github.com/DEFRA/forms-runner/blob/main/README.md
+sonar.links.ci=https://github.com/DEFRA/forms-runner/actions
+sonar.links.scm=https://github.com/DEFRA/forms-runner
+sonar.links.issue=https://github.com/DEFRA/forms-runner/issues
+
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
+sonar.sourceEncoding=UTF-8
+
+sonar.sources=src
+sonar.exclusions=**/*.test.*,src/server/forms/*
+sonar.tests=src,test
+sonar.test.inclusions=**/*.test.*
+sonar.cpd.exclusions=**/*.test.*

package/src/client/javascripts/application.js

@@ -0,0 +1,87 @@
+import {
+  Button,
+  CharacterCount,
+  Checkboxes,
+  ErrorSummary,
+  Header,
+  NotificationBanner,
+  Radios,
+  SkipLink,
+  createAll
+} from 'govuk-frontend'
+
+createAll(Button)
+createAll(CharacterCount)
+createAll(Checkboxes)
+createAll(ErrorSummary)
+createAll(Header)
+createAll(NotificationBanner)
+createAll(Radios)
+createAll(SkipLink)
+
+// Show preview close link via `rel="opener"`
+if (window.opener) {
+  const $closeLink = document.querySelector('.js-preview-banner-close')
+
+  $closeLink?.removeAttribute('hidden')
+  $closeLink?.addEventListener('click', (event) => {
+    event.preventDefault()
+    window.close()
+  })
+}
+
+/**
+ * Initialise autocomplete
+ * @param {HTMLSelectElement | null} $select
+ * @param {(config: object) => void} init
+ */
+function initAutocomplete($select, init) {
+  if (!$select) {
+    return
+  }
+
+  const config = {
+    id: $select.id,
+    selectElement: $select
+  }
+
+  init(config)
+
+  /** @type {HTMLInputElement | null} */
+  const $input = document.querySelector(`#${config.id}`)
+
+  // Allowed values for input
+  const inputValues = [...$select.options].map((option) => option.text)
+
+  // Reset select when input value is not allowed
+  $input?.addEventListener('blur', () => {
+    if (!$input.value || !inputValues.includes($input.value)) {
+      $select.value = ''
+    }
+  })
+}
+
+// Find all autocompletes
+const $autocompletes = document.querySelectorAll(
+  `[data-module="govuk-accessible-autocomplete"]`
+)
+
+// Lazy load autocomplete component
+if ($autocompletes.length) {
+  // @ts-expect-error -- No types available
+  import('accessible-autocomplete')
+    .then((component) => {
+      const { default: accessibleAutocomplete } = component
+
+      // Initialise each autocomplete
+      $autocompletes.forEach(($module) =>
+        initAutocomplete(
+          $module.querySelector('select'),
+          accessibleAutocomplete.enhanceSelectElement
+        )
+      )
+    })
+
+    // eslint-disable-next-line no-console
+    .catch(console.error)
+}