@defra/forms-engine-plugin 2.1.5 → 2.1.7

package/.server/server/plugins/engine/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":["UploadStatus","FileStatus","FormAdapterSubmissionSchemaVersion"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Event,\n  type FormDefinition,\n  type FormMetadata,\n  type Item,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport { type PluginProperties, type Request } from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type RichFormValue } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport {\n  type FormAction,\n  type FormParams,\n  type FormRequest,\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\ntype RequestType = Request | FormRequest | FormRequestPayload\n\n/**\n * Form submission state stores the following in Redis:\n * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`\n *   a) . e.g:\n * ```ts\n *     {\n *       _C9PRHmsgt: 'Ben',\n *       WfLk9McjzX: 'Music',\n *       IK7jkUFCBL: 'Royal Academy of Music'\n *     }\n * ```\n *\n *   b)\n * ```ts\n *   {\n *         checkBeforeYouStart: { ukPassport: true },\n *         applicantDetails: {\n *           numberOfApplicants: 1,\n *           phoneNumber: '77777777',\n *           emailAddress: 'aaa@aaa.com'\n *         },\n *         applicantOneDetails: {\n *           firstName: 'a',\n *           middleName: 'a',\n *           lastName: 'a',\n *           address: { addressLine1: 'a', addressLine2: 'a', town: 'a', postcode: 'a' }\n *         }\n *     }\n * ```\n */\n\n/**\n * Form submission state\n */\nexport type FormSubmissionState = {\n  upload?: Record<string, TempFileState>\n} & FormState\n\nexport interface FormSubmissionError\n  extends Pick<ValidationErrorItem, 'context' | 'path'> {\n  href: string // e.g: '#dateField__day'\n  name: string // e.g: 'dateField__day'\n  text: string // e.g: 'Date field must be a real date'\n}\n\nexport interface FormPayloadParams {\n  action?: FormAction\n  confirm?: true\n  crumb?: string\n  itemId?: string\n}\n\n/**\n * Form POST for question pages\n * (after Joi has converted value types)\n */\nexport type FormPayload = FormPayloadParams & Partial<Record<string, FormValue>>\n\nexport type FormValue =\n  | Item['value']\n  | Item['value'][]\n  | UploadState\n  | RepeatListState\n  | undefined\n\nexport type FormState = Partial<Record<string, FormStateValue>>\nexport type FormStateValue = Exclude<FormValue, undefined> | null\n\nexport interface FormValidationResult<\n  ValueType extends FormPayload | FormSubmissionState\n> {\n  value: ValueType\n  errors: FormSubmissionError[] | undefined\n}\n\nexport interface FormContext {\n  /**\n   * Evaluation form state only (filtered by visited paths),\n   * with values formatted for condition evaluation using\n   * {@link FormComponent.getContextValueFromState}\n   */\n  evaluationState: FormState\n\n  /**\n   * Relevant form state only (filtered by visited paths)\n   */\n  relevantState: FormState\n\n  /**\n   * Relevant pages only (filtered by visited paths)\n   */\n  relevantPages: PageControllerClass[]\n\n  /**\n   * Form submission payload (single page)\n   */\n  payload: FormPayload\n\n  /**\n   * Form submission state (entire form)\n   */\n  state: FormSubmissionState\n\n  /**\n   * Validation errors (entire form)\n   */\n  errors?: FormSubmissionError[]\n\n  /**\n   * Visited paths evaluated from form state\n   */\n  paths: string[]\n\n  /**\n   * Preview URL direct access is allowed\n   */\n  isForceAccess: boolean\n\n  /**\n   * Miscellaneous extra data from event responses\n   */\n  data: object\n\n  pageDefMap: Map<string, Page>\n  listDefMap: Map<string, List>\n  componentDefMap: Map<string, ComponentDef>\n  pageMap: Map<string, PageControllerClass>\n  componentMap: Map<string, Component>\n  referenceNumber: string\n}\n\nexport type FormContextRequest = (\n  | {\n      method: 'get'\n      payload?: undefined\n    }\n  | {\n      method: 'post'\n      payload: FormPayload\n    }\n  | {\n      method: FormRequest['method']\n      payload?: object | undefined\n    }\n) &\n  Pick<\n    FormRequest,\n    'app' | 'method' | 'params' | 'path' | 'query' | 'url' | 'server'\n  >\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport enum UploadStatus {\n  initiated = 'initiated',\n  pending = 'pending',\n  ready = 'ready'\n}\n\nexport enum FileStatus {\n  complete = 'complete',\n  rejected = 'rejected',\n  pending = 'pending'\n}\n\nexport type UploadState = FileState[]\n\nexport type FileUpload = {\n  fileId: string\n  filename: string\n  contentLength: number\n} & (\n  | {\n      fileStatus: FileStatus.complete | FileStatus.rejected | FileStatus.pending\n      errorMessage?: string\n    }\n  | {\n      fileStatus: FileStatus.complete\n      errorMessage?: undefined\n    }\n)\n\nexport interface FileUploadMetadata {\n  retrievalKey: string\n}\n\nexport type UploadStatusResponse =\n  | {\n      uploadStatus: UploadStatus.initiated\n      metadata: FileUploadMetadata\n      form: { file?: undefined }\n    }\n  | {\n      uploadStatus: UploadStatus.pending | UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles?: number\n    }\n  | {\n      uploadStatus: UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles: 0\n    }\n\nexport type UploadStatusFileResponse = Exclude<\n  UploadStatusResponse,\n  { uploadStatus: UploadStatus.initiated }\n>\n\nexport interface FileState {\n  uploadId: string\n  status: UploadStatusFileResponse\n}\n\nexport interface TempFileState {\n  upload?: UploadInitiateResponse\n  files: UploadState\n}\n\nexport interface RepeatItemState extends FormPayload {\n  itemId: string\n}\n\nexport type RepeatListState = RepeatItemState[]\n\nexport interface CheckAnswers {\n  title?: ComponentText\n  summaryList: SummaryList\n}\n\nexport interface SummaryList {\n  classes?: string\n  rows: SummaryListRow[]\n}\n\nexport interface SummaryListRow {\n  key: ComponentText\n  value: ComponentText\n  actions?: { items: SummaryListAction[] }\n}\n\nexport type SummaryListAction = ComponentText & {\n  href: string\n  visuallyHiddenText: string\n}\n\nexport interface PageViewModelBase extends Partial<ViewContext> {\n  page: PageController\n  name?: string\n  pageTitle: string\n  sectionTitle?: string\n  showTitle: boolean\n  isStartPage: boolean\n  backLink?: BackLink\n  feedbackLink?: string\n  serviceUrl: string\n  phaseTag?: string\n}\n\nexport interface ItemDeletePageViewModel extends PageViewModelBase {\n  context: FormContext\n  itemTitle: string\n  confirmation?: ComponentText\n  buttonConfirm: ComponentText\n  buttonCancel: ComponentText\n}\n\nexport interface FormPageViewModel extends PageViewModelBase {\n  components: ComponentViewModel[]\n  context: FormContext\n  errors?: FormSubmissionError[]\n  hasMissingNotificationEmail?: boolean\n  allowSaveAndReturn: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n}\n\nexport interface FeaturedFormPageViewModel extends FormPageViewModel {\n  formAction?: string\n  formComponent: ComponentViewModel\n  componentsBefore: ComponentViewModel[]\n  uploadId: string | undefined\n  proxyUrl: string | null\n}\n\nexport type PageViewModel =\n  | PageViewModelBase\n  | ItemDeletePageViewModel\n  | FormPageViewModel\n  | RepeaterSummaryPageViewModel\n  | FeaturedFormPageViewModel\n\nexport type GlobalFunction = (value: unknown) => unknown\nexport type FilterFunction = (value: unknown) => unknown\nexport interface ErrorMessageTemplate {\n  type: string\n  template: JoiExpression\n}\n\nexport interface ErrorMessageTemplateList {\n  baseErrors: ErrorMessageTemplate[]\n  advancedSettingsErrors: ErrorMessageTemplate[]\n}\n\nexport type PreparePageEventRequestOptions = (\n  options: RequestOptions,\n  event: Event,\n  page: PageControllerClass,\n  context: FormContext\n) => void\n\nexport type OnRequestCallback = (\n  request: FormRequest | FormRequestPayload,\n  params: FormParams,\n  definition: FormDefinition,\n  metadata: FormMetadata\n) => void\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cacheName?: string\n  globals?: Record<string, GlobalFunction>\n  filters?: Record<string, FilterFunction>\n  saveAndReturn?: {\n    keyGenerator: (request: RequestType) => string\n    sessionHydrator: (request: RequestType) => Promise<FormSubmissionState>\n    sessionPersister: (\n      state: FormSubmissionState,\n      request: RequestType\n    ) => Promise<void>\n  }\n  pluginPath?: string\n  nunjucks: {\n    baseLayoutPath: string\n    paths: string[]\n  }\n  viewContext: PluginProperties['forms-engine-plugin']['viewContext']\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  baseUrl: string // base URL of the application, protocol and hostname e.g. \"https://myapp.com\"\n}\n\nexport interface FormAdapterSubmissionMessageMeta {\n  schemaVersion: FormAdapterSubmissionSchemaVersion\n  timestamp: Date\n  referenceNumber: string\n  formName: string\n  formId: string\n  formSlug: string\n  status: FormStatus\n  isPreview: boolean\n  notificationEmail: string\n}\n\nexport type FormAdapterSubmissionMessageMetaSerialised = Omit<\n  FormAdapterSubmissionMessageMeta,\n  'schemaVersion' | 'timestamp' | 'status'\n> & {\n  schemaVersion: string\n  status: string\n  timestamp: string\n}\n\nexport interface FormAdapterSubmissionMessageData {\n  main: Record<string, RichFormValue>\n  repeaters: Record<string, Record<string, RichFormValue>[]>\n  files: Record<string, Record<string, string>[]>\n}\n\nexport enum FormAdapterSubmissionSchemaVersion {\n  V1 = 1\n}\n\nexport interface FormAdapterSubmissionMessagePayload {\n  meta: FormAdapterSubmissionMessageMeta\n  data: FormAdapterSubmissionMessageData\n}\n\nexport interface FormAdapterSubmissionMessage\n  extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AAoCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAmBA;AACA;AACA;AACA;;AAqGA,WAAYA,YAAY,0BAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAA,OAAZA,YAAY;AAAA;AAMxB,WAAYC,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA;AA0NtB,WAAYC,kCAAkC,0BAAlCA,kCAAkC;EAAlCA,kCAAkC,CAAlCA,kCAAkC;EAAA,OAAlCA,kCAAkC;AAAA","ignoreList":[]}
+{"version":3,"file":"types.js","names":["FileStatus","UploadStatus"],"sources":["../../../../src/server/plugins/engine/types.ts"],"sourcesContent":["import {\n  type ComponentDef,\n  type Event,\n  type FormDefinition,\n  type FormMetadata,\n  type Item,\n  type List,\n  type Page\n} from '@defra/forms-model'\nimport { type PluginProperties, type Request } from '@hapi/hapi'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type RichFormValue } from '~/src/server/plugins/engine/outputFormatters/machine/v2.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'\nimport {\n  type FileStatus,\n  type FormAdapterSubmissionSchemaVersion,\n  type UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\nimport { type ViewContext } from '~/src/server/plugins/nunjucks/types.js'\nimport {\n  type FormAction,\n  type FormParams,\n  type FormRequest,\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\ntype RequestType = Request | FormRequest | FormRequestPayload\n\n/**\n * Form submission state stores the following in Redis:\n * Props containing user's submitted values as `{ [inputId]: value }` or as `{ [sectionName]: { [inputName]: value } }`\n *   a) . e.g:\n * ```ts\n *     {\n *       _C9PRHmsgt: 'Ben',\n *       WfLk9McjzX: 'Music',\n *       IK7jkUFCBL: 'Royal Academy of Music'\n *     }\n * ```\n *\n *   b)\n * ```ts\n *   {\n *         checkBeforeYouStart: { ukPassport: true },\n *         applicantDetails: {\n *           numberOfApplicants: 1,\n *           phoneNumber: '77777777',\n *           emailAddress: 'aaa@aaa.com'\n *         },\n *         applicantOneDetails: {\n *           firstName: 'a',\n *           middleName: 'a',\n *           lastName: 'a',\n *           address: { addressLine1: 'a', addressLine2: 'a', town: 'a', postcode: 'a' }\n *         }\n *     }\n * ```\n */\n\n/**\n * Form submission state\n */\nexport type FormSubmissionState = {\n  upload?: Record<string, TempFileState>\n} & FormState\n\nexport interface FormSubmissionError\n  extends Pick<ValidationErrorItem, 'context' | 'path'> {\n  href: string // e.g: '#dateField__day'\n  name: string // e.g: 'dateField__day'\n  text: string // e.g: 'Date field must be a real date'\n}\n\nexport interface FormPayloadParams {\n  action?: FormAction\n  confirm?: true\n  crumb?: string\n  itemId?: string\n}\n\n/**\n * Form POST for question pages\n * (after Joi has converted value types)\n */\nexport type FormPayload = FormPayloadParams & Partial<Record<string, FormValue>>\n\nexport type FormValue =\n  | Item['value']\n  | Item['value'][]\n  | UploadState\n  | RepeatListState\n  | undefined\n\nexport type FormState = Partial<Record<string, FormStateValue>>\nexport type FormStateValue = Exclude<FormValue, undefined> | null\n\nexport interface FormValidationResult<\n  ValueType extends FormPayload | FormSubmissionState\n> {\n  value: ValueType\n  errors: FormSubmissionError[] | undefined\n}\n\nexport interface FormContext {\n  /**\n   * Evaluation form state only (filtered by visited paths),\n   * with values formatted for condition evaluation using\n   * {@link FormComponent.getContextValueFromState}\n   */\n  evaluationState: FormState\n\n  /**\n   * Relevant form state only (filtered by visited paths)\n   */\n  relevantState: FormState\n\n  /**\n   * Relevant pages only (filtered by visited paths)\n   */\n  relevantPages: PageControllerClass[]\n\n  /**\n   * Form submission payload (single page)\n   */\n  payload: FormPayload\n\n  /**\n   * Form submission state (entire form)\n   */\n  state: FormSubmissionState\n\n  /**\n   * Validation errors (entire form)\n   */\n  errors?: FormSubmissionError[]\n\n  /**\n   * Visited paths evaluated from form state\n   */\n  paths: string[]\n\n  /**\n   * Preview URL direct access is allowed\n   */\n  isForceAccess: boolean\n\n  /**\n   * Miscellaneous extra data from event responses\n   */\n  data: object\n\n  pageDefMap: Map<string, Page>\n  listDefMap: Map<string, List>\n  componentDefMap: Map<string, ComponentDef>\n  pageMap: Map<string, PageControllerClass>\n  componentMap: Map<string, Component>\n  referenceNumber: string\n}\n\nexport type FormContextRequest = (\n  | {\n      method: 'get'\n      payload?: undefined\n    }\n  | {\n      method: 'post'\n      payload: FormPayload\n    }\n  | {\n      method: FormRequest['method']\n      payload?: object | undefined\n    }\n) &\n  Pick<\n    FormRequest,\n    'app' | 'method' | 'params' | 'path' | 'query' | 'url' | 'server'\n  >\n\nexport interface UploadInitiateResponse {\n  uploadId: string\n  uploadUrl: string\n  statusUrl: string\n}\n\nexport {\n  FileStatus,\n  UploadStatus\n} from '~/src/server/plugins/engine/types/enums.js'\n\nexport type UploadState = FileState[]\n\nexport type FileUpload = {\n  fileId: string\n  filename: string\n  contentLength: number\n} & (\n  | {\n      fileStatus: FileStatus.complete | FileStatus.rejected | FileStatus.pending\n      errorMessage?: string\n    }\n  | {\n      fileStatus: FileStatus.complete\n      errorMessage?: undefined\n    }\n)\n\nexport interface FileUploadMetadata {\n  retrievalKey: string\n}\n\nexport type UploadStatusResponse =\n  | {\n      uploadStatus: UploadStatus.initiated\n      metadata: FileUploadMetadata\n      form: { file?: undefined }\n    }\n  | {\n      uploadStatus: UploadStatus.pending | UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles?: number\n    }\n  | {\n      uploadStatus: UploadStatus.ready\n      metadata: FileUploadMetadata\n      form: { file: FileUpload }\n      numberOfRejectedFiles: 0\n    }\n\nexport type UploadStatusFileResponse = Exclude<\n  UploadStatusResponse,\n  { uploadStatus: UploadStatus.initiated }\n>\n\nexport interface FileState {\n  uploadId: string\n  status: UploadStatusFileResponse\n}\n\nexport interface TempFileState {\n  upload?: UploadInitiateResponse\n  files: UploadState\n}\n\nexport interface RepeatItemState extends FormPayload {\n  itemId: string\n}\n\nexport type RepeatListState = RepeatItemState[]\n\nexport interface CheckAnswers {\n  title?: ComponentText\n  summaryList: SummaryList\n}\n\nexport interface SummaryList {\n  classes?: string\n  rows: SummaryListRow[]\n}\n\nexport interface SummaryListRow {\n  key: ComponentText\n  value: ComponentText\n  actions?: { items: SummaryListAction[] }\n}\n\nexport type SummaryListAction = ComponentText & {\n  href: string\n  visuallyHiddenText: string\n}\n\nexport interface PageViewModelBase extends Partial<ViewContext> {\n  page: PageController\n  name?: string\n  pageTitle: string\n  sectionTitle?: string\n  showTitle: boolean\n  isStartPage: boolean\n  backLink?: BackLink\n  feedbackLink?: string\n  serviceUrl: string\n  phaseTag?: string\n}\n\nexport interface ItemDeletePageViewModel extends PageViewModelBase {\n  context: FormContext\n  itemTitle: string\n  confirmation?: ComponentText\n  buttonConfirm: ComponentText\n  buttonCancel: ComponentText\n}\n\nexport interface FormPageViewModel extends PageViewModelBase {\n  components: ComponentViewModel[]\n  context: FormContext\n  errors?: FormSubmissionError[]\n  hasMissingNotificationEmail?: boolean\n  allowSaveAndReturn: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n}\n\nexport interface FeaturedFormPageViewModel extends FormPageViewModel {\n  formAction?: string\n  formComponent: ComponentViewModel\n  componentsBefore: ComponentViewModel[]\n  uploadId: string | undefined\n  proxyUrl: string | null\n}\n\nexport type PageViewModel =\n  | PageViewModelBase\n  | ItemDeletePageViewModel\n  | FormPageViewModel\n  | RepeaterSummaryPageViewModel\n  | FeaturedFormPageViewModel\n\nexport type GlobalFunction = (value: unknown) => unknown\nexport type FilterFunction = (value: unknown) => unknown\nexport interface ErrorMessageTemplate {\n  type: string\n  template: JoiExpression\n}\n\nexport interface ErrorMessageTemplateList {\n  baseErrors: ErrorMessageTemplate[]\n  advancedSettingsErrors: ErrorMessageTemplate[]\n}\n\nexport type PreparePageEventRequestOptions = (\n  options: RequestOptions,\n  event: Event,\n  page: PageControllerClass,\n  context: FormContext\n) => void\n\nexport type OnRequestCallback = (\n  request: FormRequest | FormRequestPayload,\n  params: FormParams,\n  definition: FormDefinition,\n  metadata: FormMetadata\n) => void\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cacheName?: string\n  globals?: Record<string, GlobalFunction>\n  filters?: Record<string, FilterFunction>\n  saveAndReturn?: {\n    keyGenerator: (request: RequestType) => string\n    sessionHydrator: (request: RequestType) => Promise<FormSubmissionState>\n    sessionPersister: (\n      state: FormSubmissionState,\n      request: RequestType\n    ) => Promise<void>\n  }\n  pluginPath?: string\n  nunjucks: {\n    baseLayoutPath: string\n    paths: string[]\n  }\n  viewContext: PluginProperties['forms-engine-plugin']['viewContext']\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  baseUrl: string // base URL of the application, protocol and hostname e.g. \"https://myapp.com\"\n}\n\nexport interface FormAdapterSubmissionMessageMeta {\n  schemaVersion: FormAdapterSubmissionSchemaVersion\n  timestamp: Date\n  referenceNumber: string\n  formName: string\n  formId: string\n  formSlug: string\n  status: FormStatus\n  isPreview: boolean\n  notificationEmail: string\n}\n\nexport type FormAdapterSubmissionMessageMetaSerialised = Omit<\n  FormAdapterSubmissionMessageMeta,\n  'schemaVersion' | 'timestamp' | 'status'\n> & {\n  schemaVersion: number\n  status: string\n  timestamp: string\n}\n\nexport interface FormAdapterSubmissionMessageData {\n  main: Record<string, RichFormValue>\n  repeaters: Record<string, Record<string, RichFormValue>[]>\n  files: Record<string, Record<string, string>[]>\n}\n\nexport interface FormAdapterSubmissionMessagePayload {\n  meta: FormAdapterSubmissionMessageMeta\n  data: FormAdapterSubmissionMessageData\n}\n\nexport interface FormAdapterSubmissionMessage\n  extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AAyCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAmBA;AACA;AACA;AACA;;AAqGA,SACEA,UAAU,EACVC,YAAY","ignoreList":[]}

package/.server/server/plugins/nunjucks/filters/answer.js

@@ -1,4 +1,4 @@
-import { getAnswer } from "../../engine/components/helpers.js";
+import { getAnswer } from "../../engine/components/helpers/components.js";
 
 /**
  * Nunjucks filter to get the answer for a component
@@ -21,6 +21,6 @@ export function answer(name) {
 
 /**
  * @import { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js'
- * @import { Field } from '~/src/server/plugins/engine/components/helpers.js'
+ * @import { Field } from '~/src/server/plugins/engine/components/helpers/components.js'
  */
 //# sourceMappingURL=answer.js.map

package/.server/server/plugins/nunjucks/filters/answer.js.map

@@ -1 +1 @@
-{"version":3,"file":"answer.js","names":["getAnswer","answer","name","context","ctx","undefined","component","componentMap","get","isFormComponent","relevantState"],"sources":["../../../../../src/server/plugins/nunjucks/filters/answer.js"],"sourcesContent":["import { getAnswer } from '~/src/server/plugins/engine/components/helpers.js'\n\n/**\n * Nunjucks filter to get the answer for a component\n * @this {NunjucksContext}\n * @param {string} name - The name of the component to check\n */\nexport function answer(name) {\n  const { context } = this.ctx\n\n  if (!context) {\n    return undefined\n  }\n\n  const component = context.componentMap.get(name)\n\n  if (!component?.isFormComponent) {\n    return undefined\n  }\n\n  return getAnswer(/** @type {Field} */ (component), context.relevantState)\n}\n\n/**\n * @import { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js'\n * @import { Field } from '~/src/server/plugins/engine/components/helpers.js'\n */\n"],"mappings":"AAAA,SAASA,SAAS;;AAElB;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACC,IAAI,EAAE;EAC3B,MAAM;IAAEC;EAAQ,CAAC,GAAG,IAAI,CAACC,GAAG;EAE5B,IAAI,CAACD,OAAO,EAAE;IACZ,OAAOE,SAAS;EAClB;EAEA,MAAMC,SAAS,GAAGH,OAAO,CAACI,YAAY,CAACC,GAAG,CAACN,IAAI,CAAC;EAEhD,IAAI,CAACI,SAAS,EAAEG,eAAe,EAAE;IAC/B,OAAOJ,SAAS;EAClB;EAEA,OAAOL,SAAS,CAAC,oBAAsBM,SAAS,EAAGH,OAAO,CAACO,aAAa,CAAC;AAC3E;;AAEA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"answer.js","names":["getAnswer","answer","name","context","ctx","undefined","component","componentMap","get","isFormComponent","relevantState"],"sources":["../../../../../src/server/plugins/nunjucks/filters/answer.js"],"sourcesContent":["import { getAnswer } from '~/src/server/plugins/engine/components/helpers/components.js'\n\n/**\n * Nunjucks filter to get the answer for a component\n * @this {NunjucksContext}\n * @param {string} name - The name of the component to check\n */\nexport function answer(name) {\n  const { context } = this.ctx\n\n  if (!context) {\n    return undefined\n  }\n\n  const component = context.componentMap.get(name)\n\n  if (!component?.isFormComponent) {\n    return undefined\n  }\n\n  return getAnswer(/** @type {Field} */ (component), context.relevantState)\n}\n\n/**\n * @import { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js'\n * @import { Field } from '~/src/server/plugins/engine/components/helpers/components.js'\n */\n"],"mappings":"AAAA,SAASA,SAAS;;AAElB;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACC,IAAI,EAAE;EAC3B,MAAM;IAAEC;EAAQ,CAAC,GAAG,IAAI,CAACC,GAAG;EAE5B,IAAI,CAACD,OAAO,EAAE;IACZ,OAAOE,SAAS;EAClB;EAEA,MAAMC,SAAS,GAAGH,OAAO,CAACI,YAAY,CAACC,GAAG,CAACN,IAAI,CAAC;EAEhD,IAAI,CAACI,SAAS,EAAEG,eAAe,EAAE;IAC/B,OAAOJ,SAAS;EAClB;EAEA,OAAOL,SAAS,CAAC,oBAAsBM,SAAS,EAAGH,OAAO,CAACO,aAAa,CAAC;AAC3E;;AAEA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/nunjucks/filters/answer.test.js

@@ -1,6 +1,6 @@
-import { getAnswer } from "../../engine/components/helpers.js";
+import { getAnswer } from "../../engine/components/helpers/components.js";
 import { answer } from "./answer.js";
-jest.mock("../../engine/components/helpers.ts", () => ({
+jest.mock("../../engine/components/helpers/components.ts", () => ({
   getAnswer: jest.fn()
 }));
 describe('answer Nunjucks filter', () => {

package/.server/server/plugins/nunjucks/filters/answer.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"answer.test.js","names":["getAnswer","answer","jest","mock","fn","describe","mockThis","beforeEach","clearAllMocks","ctx","context","componentMap","Map","relevantState","someState","mocked","mockReturnValue","it","undefined","result","call","expect","toBeUndefined","not","toHaveBeenCalled","set","isFormComponent","mockFormComponent","someProperty","toHaveBeenCalledWith","toBe"],"sources":["../../../../../src/server/plugins/nunjucks/filters/answer.test.js"],"sourcesContent":["import { getAnswer } from '~/src/server/plugins/engine/components/helpers.js'\nimport { answer } from '~/src/server/plugins/nunjucks/filters/answer.js'\n\njest.mock('~/src/server/plugins/engine/components/helpers.ts', () => ({\n  getAnswer: jest.fn()\n}))\n\ndescribe('answer Nunjucks filter', () => {\n  /** @type { NunjucksContext } */\n  let mockThis\n\n  beforeEach(() => {\n    jest.clearAllMocks()\n\n    mockThis = /** @type {NunjucksContext} */ (\n      /** @type {unknown} */ ({\n        ctx: {\n          context: {\n            componentMap: new Map(),\n            relevantState: { someState: 'value' }\n          }\n        }\n      })\n    )\n\n    jest.mocked(getAnswer).mockReturnValue('test answer')\n  })\n\n  describe('missing context', () => {\n    it('returns undefined', () => {\n      mockThis.ctx.context = undefined\n\n      const result = answer.call(mockThis, 'componentName')\n\n      expect(result).toBeUndefined()\n      expect(getAnswer).not.toHaveBeenCalled()\n    })\n  })\n\n  describe('component lookup', () => {\n    it('returns undefined for non-existent component', () => {\n      const result = answer.call(mockThis, 'nonExistentComponent')\n\n      expect(result).toBeUndefined()\n      expect(getAnswer).not.toHaveBeenCalled()\n    })\n  })\n\n  describe('non-form component', () => {\n    it('returns undefined', () => {\n      mockThis.ctx.context?.componentMap.set(\n        'nonFormComponent',\n        // @ts-expect-error - simplified mock component for testing\n        { isFormComponent: false }\n      )\n\n      const result = answer.call(mockThis, 'nonFormComponent')\n\n      expect(result).toBeUndefined()\n      expect(getAnswer).not.toHaveBeenCalled()\n    })\n  })\n\n  describe('valid form component', () => {\n    it('returns the answer', () => {\n      const mockFormComponent = {\n        isFormComponent: true,\n        someProperty: 'value'\n      }\n      mockThis.ctx.context?.componentMap.set(\n        'validFormComponent',\n        // @ts-expect-error - simplified mock component for testing\n        mockFormComponent\n      )\n\n      const result = answer.call(mockThis, 'validFormComponent')\n\n      expect(getAnswer).toHaveBeenCalledWith(\n        mockFormComponent,\n        mockThis.ctx.context?.relevantState\n      )\n      expect(result).toBe('test answer')\n    })\n  })\n})\n\n/**\n * @import { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js'\n */\n"],"mappings":"AAAA,SAASA,SAAS;AAClB,SAASC,MAAM;AAEfC,IAAI,CAACC,IAAI,uCAAsD,OAAO;EACpEH,SAAS,EAAEE,IAAI,CAACE,EAAE,CAAC;AACrB,CAAC,CAAC,CAAC;AAEHC,QAAQ,CAAC,wBAAwB,EAAE,MAAM;EACvC;EACA,IAAIC,QAAQ;EAEZC,UAAU,CAAC,MAAM;IACfL,IAAI,CAACM,aAAa,CAAC,CAAC;IAEpBF,QAAQ,GAAG;IACT,sBAAwB;MACtBG,GAAG,EAAE;QACHC,OAAO,EAAE;UACPC,YAAY,EAAE,IAAIC,GAAG,CAAC,CAAC;UACvBC,aAAa,EAAE;YAAEC,SAAS,EAAE;UAAQ;QACtC;MACF;IACF,CACD;IAEDZ,IAAI,CAACa,MAAM,CAACf,SAAS,CAAC,CAACgB,eAAe,CAAC,aAAa,CAAC;EACvD,CAAC,CAAC;EAEFX,QAAQ,CAAC,iBAAiB,EAAE,MAAM;IAChCY,EAAE,CAAC,mBAAmB,EAAE,MAAM;MAC5BX,QAAQ,CAACG,GAAG,CAACC,OAAO,GAAGQ,SAAS;MAEhC,MAAMC,MAAM,GAAGlB,MAAM,CAACmB,IAAI,CAACd,QAAQ,EAAE,eAAe,CAAC;MAErDe,MAAM,CAACF,MAAM,CAAC,CAACG,aAAa,CAAC,CAAC;MAC9BD,MAAM,CAACrB,SAAS,CAAC,CAACuB,GAAG,CAACC,gBAAgB,CAAC,CAAC;IAC1C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFnB,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjCY,EAAE,CAAC,8CAA8C,EAAE,MAAM;MACvD,MAAME,MAAM,GAAGlB,MAAM,CAACmB,IAAI,CAACd,QAAQ,EAAE,sBAAsB,CAAC;MAE5De,MAAM,CAACF,MAAM,CAAC,CAACG,aAAa,CAAC,CAAC;MAC9BD,MAAM,CAACrB,SAAS,CAAC,CAACuB,GAAG,CAACC,gBAAgB,CAAC,CAAC;IAC1C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFnB,QAAQ,CAAC,oBAAoB,EAAE,MAAM;IACnCY,EAAE,CAAC,mBAAmB,EAAE,MAAM;MAC5BX,QAAQ,CAACG,GAAG,CAACC,OAAO,EAAEC,YAAY,CAACc,GAAG,CACpC,kBAAkB;MAClB;MACA;QAAEC,eAAe,EAAE;MAAM,CAC3B,CAAC;MAED,MAAMP,MAAM,GAAGlB,MAAM,CAACmB,IAAI,CAACd,QAAQ,EAAE,kBAAkB,CAAC;MAExDe,MAAM,CAACF,MAAM,CAAC,CAACG,aAAa,CAAC,CAAC;MAC9BD,MAAM,CAACrB,SAAS,CAAC,CAACuB,GAAG,CAACC,gBAAgB,CAAC,CAAC;IAC1C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFnB,QAAQ,CAAC,sBAAsB,EAAE,MAAM;IACrCY,EAAE,CAAC,oBAAoB,EAAE,MAAM;MAC7B,MAAMU,iBAAiB,GAAG;QACxBD,eAAe,EAAE,IAAI;QACrBE,YAAY,EAAE;MAChB,CAAC;MACDtB,QAAQ,CAACG,GAAG,CAACC,OAAO,EAAEC,YAAY,CAACc,GAAG,CACpC,oBAAoB;MACpB;MACAE,iBACF,CAAC;MAED,MAAMR,MAAM,GAAGlB,MAAM,CAACmB,IAAI,CAACd,QAAQ,EAAE,oBAAoB,CAAC;MAE1De,MAAM,CAACrB,SAAS,CAAC,CAAC6B,oBAAoB,CACpCF,iBAAiB,EACjBrB,QAAQ,CAACG,GAAG,CAACC,OAAO,EAAEG,aACxB,CAAC;MACDQ,MAAM,CAACF,MAAM,CAAC,CAACW,IAAI,CAAC,aAAa,CAAC;IACpC,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"answer.test.js","names":["getAnswer","answer","jest","mock","fn","describe","mockThis","beforeEach","clearAllMocks","ctx","context","componentMap","Map","relevantState","someState","mocked","mockReturnValue","it","undefined","result","call","expect","toBeUndefined","not","toHaveBeenCalled","set","isFormComponent","mockFormComponent","someProperty","toHaveBeenCalledWith","toBe"],"sources":["../../../../../src/server/plugins/nunjucks/filters/answer.test.js"],"sourcesContent":["import { getAnswer } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport { answer } from '~/src/server/plugins/nunjucks/filters/answer.js'\n\njest.mock(\n  '~/src/server/plugins/engine/components/helpers/components.ts',\n  () => ({\n    getAnswer: jest.fn()\n  })\n)\n\ndescribe('answer Nunjucks filter', () => {\n  /** @type { NunjucksContext } */\n  let mockThis\n\n  beforeEach(() => {\n    jest.clearAllMocks()\n\n    mockThis = /** @type {NunjucksContext} */ (\n      /** @type {unknown} */ ({\n        ctx: {\n          context: {\n            componentMap: new Map(),\n            relevantState: { someState: 'value' }\n          }\n        }\n      })\n    )\n\n    jest.mocked(getAnswer).mockReturnValue('test answer')\n  })\n\n  describe('missing context', () => {\n    it('returns undefined', () => {\n      mockThis.ctx.context = undefined\n\n      const result = answer.call(mockThis, 'componentName')\n\n      expect(result).toBeUndefined()\n      expect(getAnswer).not.toHaveBeenCalled()\n    })\n  })\n\n  describe('component lookup', () => {\n    it('returns undefined for non-existent component', () => {\n      const result = answer.call(mockThis, 'nonExistentComponent')\n\n      expect(result).toBeUndefined()\n      expect(getAnswer).not.toHaveBeenCalled()\n    })\n  })\n\n  describe('non-form component', () => {\n    it('returns undefined', () => {\n      mockThis.ctx.context?.componentMap.set(\n        'nonFormComponent',\n        // @ts-expect-error - simplified mock component for testing\n        { isFormComponent: false }\n      )\n\n      const result = answer.call(mockThis, 'nonFormComponent')\n\n      expect(result).toBeUndefined()\n      expect(getAnswer).not.toHaveBeenCalled()\n    })\n  })\n\n  describe('valid form component', () => {\n    it('returns the answer', () => {\n      const mockFormComponent = {\n        isFormComponent: true,\n        someProperty: 'value'\n      }\n      mockThis.ctx.context?.componentMap.set(\n        'validFormComponent',\n        // @ts-expect-error - simplified mock component for testing\n        mockFormComponent\n      )\n\n      const result = answer.call(mockThis, 'validFormComponent')\n\n      expect(getAnswer).toHaveBeenCalledWith(\n        mockFormComponent,\n        mockThis.ctx.context?.relevantState\n      )\n      expect(result).toBe('test answer')\n    })\n  })\n})\n\n/**\n * @import { NunjucksContext } from '~/src/server/plugins/nunjucks/types.js'\n */\n"],"mappings":"AAAA,SAASA,SAAS;AAClB,SAASC,MAAM;AAEfC,IAAI,CAACC,IAAI,kDAEP,OAAO;EACLH,SAAS,EAAEE,IAAI,CAACE,EAAE,CAAC;AACrB,CAAC,CACH,CAAC;AAEDC,QAAQ,CAAC,wBAAwB,EAAE,MAAM;EACvC;EACA,IAAIC,QAAQ;EAEZC,UAAU,CAAC,MAAM;IACfL,IAAI,CAACM,aAAa,CAAC,CAAC;IAEpBF,QAAQ,GAAG;IACT,sBAAwB;MACtBG,GAAG,EAAE;QACHC,OAAO,EAAE;UACPC,YAAY,EAAE,IAAIC,GAAG,CAAC,CAAC;UACvBC,aAAa,EAAE;YAAEC,SAAS,EAAE;UAAQ;QACtC;MACF;IACF,CACD;IAEDZ,IAAI,CAACa,MAAM,CAACf,SAAS,CAAC,CAACgB,eAAe,CAAC,aAAa,CAAC;EACvD,CAAC,CAAC;EAEFX,QAAQ,CAAC,iBAAiB,EAAE,MAAM;IAChCY,EAAE,CAAC,mBAAmB,EAAE,MAAM;MAC5BX,QAAQ,CAACG,GAAG,CAACC,OAAO,GAAGQ,SAAS;MAEhC,MAAMC,MAAM,GAAGlB,MAAM,CAACmB,IAAI,CAACd,QAAQ,EAAE,eAAe,CAAC;MAErDe,MAAM,CAACF,MAAM,CAAC,CAACG,aAAa,CAAC,CAAC;MAC9BD,MAAM,CAACrB,SAAS,CAAC,CAACuB,GAAG,CAACC,gBAAgB,CAAC,CAAC;IAC1C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFnB,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjCY,EAAE,CAAC,8CAA8C,EAAE,MAAM;MACvD,MAAME,MAAM,GAAGlB,MAAM,CAACmB,IAAI,CAACd,QAAQ,EAAE,sBAAsB,CAAC;MAE5De,MAAM,CAACF,MAAM,CAAC,CAACG,aAAa,CAAC,CAAC;MAC9BD,MAAM,CAACrB,SAAS,CAAC,CAACuB,GAAG,CAACC,gBAAgB,CAAC,CAAC;IAC1C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFnB,QAAQ,CAAC,oBAAoB,EAAE,MAAM;IACnCY,EAAE,CAAC,mBAAmB,EAAE,MAAM;MAC5BX,QAAQ,CAACG,GAAG,CAACC,OAAO,EAAEC,YAAY,CAACc,GAAG,CACpC,kBAAkB;MAClB;MACA;QAAEC,eAAe,EAAE;MAAM,CAC3B,CAAC;MAED,MAAMP,MAAM,GAAGlB,MAAM,CAACmB,IAAI,CAACd,QAAQ,EAAE,kBAAkB,CAAC;MAExDe,MAAM,CAACF,MAAM,CAAC,CAACG,aAAa,CAAC,CAAC;MAC9BD,MAAM,CAACrB,SAAS,CAAC,CAACuB,GAAG,CAACC,gBAAgB,CAAC,CAAC;IAC1C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFnB,QAAQ,CAAC,sBAAsB,EAAE,MAAM;IACrCY,EAAE,CAAC,oBAAoB,EAAE,MAAM;MAC7B,MAAMU,iBAAiB,GAAG;QACxBD,eAAe,EAAE,IAAI;QACrBE,YAAY,EAAE;MAChB,CAAC;MACDtB,QAAQ,CAACG,GAAG,CAACC,OAAO,EAAEC,YAAY,CAACc,GAAG,CACpC,oBAAoB;MACpB;MACAE,iBACF,CAAC;MAED,MAAMR,MAAM,GAAGlB,MAAM,CAACmB,IAAI,CAACd,QAAQ,EAAE,oBAAoB,CAAC;MAE1De,MAAM,CAACrB,SAAS,CAAC,CAAC6B,oBAAoB,CACpCF,iBAAiB,EACjBrB,QAAQ,CAACG,GAAG,CAACC,OAAO,EAAEG,aACxB,CAAC;MACDQ,MAAM,CAACF,MAAM,CAAC,CAACW,IAAI,CAAC,aAAa,CAAC;IACpC,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "2.1.5",
+  "version": "2.1.7",
   "description": "Defra forms engine",
   "type": "module",
   "files": [

package/src/server/plugins/engine/components/AutocompleteField.test.ts

@@ -9,7 +9,7 @@ import { ComponentCollection } from '~/src/server/plugins/engine/components/Comp
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import {
   listNumber,

package/src/server/plugins/engine/components/CheckboxesField.test.ts

@@ -11,7 +11,7 @@ import { ComponentCollection } from '~/src/server/plugins/engine/components/Comp
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import {
   listNumber,

package/src/server/plugins/engine/components/ComponentBase.ts

@@ -9,10 +9,10 @@ import joi, {
 } from 'joi'
 
 import { type ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
-import { type Component } from '~/src/server/plugins/engine/components/helpers.js'
+import { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'
 import { type ViewModel } from '~/src/server/plugins/engine/components/types.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
-import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'
+import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
 
 export class ComponentBase {
   page?: PageControllerClass

package/src/server/plugins/engine/components/ComponentCollection.ts

@@ -15,11 +15,11 @@ import {
   type Component,
   type Field,
   type Guidance
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { type ComponentViewModel } from '~/src/server/plugins/engine/components/types.js'
 import { getErrors } from '~/src/server/plugins/engine/helpers.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js'
-import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'
+import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
 import { validationOptions as opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
 import {
   type FormPayload,

package/src/server/plugins/engine/components/DatePartsField.test.ts

@@ -5,7 +5,7 @@ import { ComponentCollection } from '~/src/server/plugins/engine/components/Comp
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { type DateInputItem } from '~/src/server/plugins/engine/components/types.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import {

package/src/server/plugins/engine/components/Details.test.ts

@@ -1,7 +1,7 @@
 import { ComponentType, type DetailsComponent } from '@defra/forms-model'
 
 import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
-import { type Guidance } from '~/src/server/plugins/engine/components/helpers.js'
+import { type Guidance } from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/basic.js'
 

package/src/server/plugins/engine/components/EmailAddressField.test.ts

@@ -7,7 +7,7 @@ import { ComponentCollection } from '~/src/server/plugins/engine/components/Comp
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/blank.js'
 import { getFormData, getFormState } from '~/test/helpers/component-helpers.js'

package/src/server/plugins/engine/components/FileUploadField.test.ts

@@ -8,12 +8,12 @@ import { tempItemSchema } from '~/src/server/plugins/engine/components/FileUploa
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import {
   createPage,
   type PageControllerClass
-} from '~/src/server/plugins/engine/pageControllers/helpers.js'
+} from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
 import { validationOptions as opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
 import {
   FileStatus,

package/src/server/plugins/engine/components/Html.test.ts

@@ -1,7 +1,7 @@
 import { ComponentType, type HtmlComponent } from '@defra/forms-model'
 
 import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
-import { type Guidance } from '~/src/server/plugins/engine/components/helpers.js'
+import { type Guidance } from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/basic.js'
 

package/src/server/plugins/engine/components/InsetText.test.ts

@@ -1,7 +1,7 @@
 import { ComponentType, type InsetTextComponent } from '@defra/forms-model'
 
 import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
-import { type Guidance } from '~/src/server/plugins/engine/components/helpers.js'
+import { type Guidance } from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/basic.js'
 

package/src/server/plugins/engine/components/List.test.ts

@@ -1,7 +1,7 @@
 import { ComponentType, type ListComponent } from '@defra/forms-model'
 
 import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
-import { type Guidance } from '~/src/server/plugins/engine/components/helpers.js'
+import { type Guidance } from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/basic.js'
 

package/src/server/plugins/engine/components/Markdown.test.ts

@@ -1,7 +1,7 @@
 import { ComponentType, type MarkdownComponent } from '@defra/forms-model'
 
 import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
-import { type Guidance } from '~/src/server/plugins/engine/components/helpers.js'
+import { type Guidance } from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/basic.js'
 

package/src/server/plugins/engine/components/MonthYearField.test.ts

@@ -5,7 +5,7 @@ import { ComponentCollection } from '~/src/server/plugins/engine/components/Comp
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { type DateInputItem } from '~/src/server/plugins/engine/components/types.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import {

package/src/server/plugins/engine/components/MultilineTextField.test.ts

@@ -8,7 +8,7 @@ import { MultilineTextField } from '~/src/server/plugins/engine/components/Multi
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/blank.js'
 import { getFormData, getFormState } from '~/test/helpers/component-helpers.js'

package/src/server/plugins/engine/components/NumberField.test.ts

@@ -5,7 +5,7 @@ import { NumberField } from '~/src/server/plugins/engine/components/NumberField.
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/blank.js'
 import { getFormData, getFormState } from '~/test/helpers/component-helpers.js'

package/src/server/plugins/engine/components/RadiosField.test.ts

@@ -6,7 +6,7 @@ import { RadiosField } from '~/src/server/plugins/engine/components/RadiosField.
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import {
   listNumber,

package/src/server/plugins/engine/components/SelectField.test.ts

@@ -6,7 +6,7 @@ import { SelectField } from '~/src/server/plugins/engine/components/SelectField.
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import {
   listNumber,

package/src/server/plugins/engine/components/TelephoneNumberField.test.ts

@@ -7,7 +7,7 @@ import { ComponentCollection } from '~/src/server/plugins/engine/components/Comp
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/blank.js'
 import { getFormData, getFormState } from '~/test/helpers/component-helpers.js'

package/src/server/plugins/engine/components/TelephoneNumberField.ts

@@ -2,7 +2,7 @@ import { type TelephoneNumberFieldComponent } from '@defra/forms-model'
 import joi, { type StringSchema } from 'joi'
 
 import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'
-import { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers.js'
+import { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers/index.js'
 import { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
 import {
   type ErrorMessageTemplateList,

package/src/server/plugins/engine/components/TextField.test.ts

@@ -4,7 +4,7 @@ import { ComponentCollection } from '~/src/server/plugins/engine/components/Comp
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/blank.js'
 import { getFormData, getFormState } from '~/test/helpers/component-helpers.js'

package/src/server/plugins/engine/components/UkAddressField.test.ts

@@ -9,7 +9,7 @@ import { UkAddressField } from '~/src/server/plugins/engine/components/UkAddress
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { type ViewModel } from '~/src/server/plugins/engine/components/types.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import {

package/src/server/plugins/engine/components/YesNoField.test.ts

@@ -4,7 +4,7 @@ import { ComponentCollection } from '~/src/server/plugins/engine/components/Comp
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { listYesNoExamples } from '~/test/fixtures/list.js'
 import definition from '~/test/form/definitions/blank.js'

package/src/server/plugins/engine/components/YesNoField.ts

@@ -6,7 +6,7 @@ import {
 } from '@defra/forms-model'
 
 import { SelectionControlField } from '~/src/server/plugins/engine/components/SelectionControlField.js'
-import { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers.js'
+import { addClassOptionIfNone } from '~/src/server/plugins/engine/components/helpers/index.js'
 import { messageTemplate } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
 import { type ErrorMessageTemplateList } from '~/src/server/plugins/engine/types.js'
 import { convertToLanguageMessages } from '~/src/server/utils/type-utils.js'

package/src/server/plugins/engine/components/{helpers.ts → helpers/components.ts}

@@ -4,49 +4,10 @@ import { Marked, type Token } from 'marked'
 import { config } from '~/src/config/index.js'
 import { type ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'
 import { ListFormComponent } from '~/src/server/plugins/engine/components/ListFormComponent.js'
+import { escapeMarkdown } from '~/src/server/plugins/engine/components/helpers/index.js'
 import * as Components from '~/src/server/plugins/engine/components/index.js'
 import { type FormState } from '~/src/server/plugins/engine/types.js'
 
-const designerUrl = config.get('designerUrl')
-
-const markdown = new Marked({
-  breaks: true,
-  gfm: true,
-
-  /**
-   * Render paragraphs without `<p>` wrappers
-   * for check answers summary list `<dd>`
-   */
-  extensions: [
-    {
-      name: 'paragraph',
-      renderer({ tokens = [] }) {
-        const text = this.parser.parseInline(tokens)
-        return tokens.length > 1 ? `${text}<br>` : text
-      }
-    }
-  ],
-
-  /**
-   * Restrict allowed Markdown tokens
-   */
-  walkTokens(token) {
-    const tokens: Token['type'][] = [
-      'br',
-      'escape',
-      'list',
-      'list_item',
-      'paragraph',
-      'space',
-      'text'
-    ]
-
-    if (!tokens.includes(token.type)) {
-      token.type = 'text'
-    }
-  }
-})
-
 // All component instances
 export type Component = InstanceType<
   (typeof Components)[keyof typeof Components]
@@ -88,6 +49,46 @@ export type ListField = InstanceType<
   | typeof Components.YesNoField
 >
 
+export const designerUrl = config.get('designerUrl')
+
+export const markdown = new Marked({
+  breaks: true,
+  gfm: true,
+
+  /**
+   * Render paragraphs without `<p>` wrappers
+   * for check answers summary list `<dd>`
+   */
+  extensions: [
+    {
+      name: 'paragraph',
+      renderer({ tokens = [] }) {
+        const text = this.parser.parseInline(tokens)
+        return tokens.length > 1 ? `${text}<br>` : text
+      }
+    }
+  ],
+
+  /**
+   * Restrict allowed Markdown tokens
+   */
+  walkTokens(token) {
+    const tokens: Token['type'][] = [
+      'br',
+      'escape',
+      'list',
+      'list_item',
+      'paragraph',
+      'space',
+      'text'
+    ]
+
+    if (!tokens.includes(token.type)) {
+      token.type = 'text'
+    }
+  }
+})
+
 /**
  * Filter known components with lists
  */
@@ -328,40 +329,3 @@ export function getAnswerMarkdown(
 
   return answerEscaped
 }
-
-/**
- * Prevent Markdown formatting
- * @see {@link https://pandoc.org/chunkedhtml-demo/8.11-backslash-escapes.html}
- */
-export function escapeMarkdown(answer: string) {
-  const punctuation = [
-    '`',
-    "'",
-    '*',
-    '_',
-    '{',
-    '}',
-    '[',
-    ']',
-    '(',
-    ')',
-    '#',
-    '+',
-    '-',
-    '.',
-    '!'
-  ]
-
-  for (const character of punctuation) {
-    answer = answer.toString().replaceAll(character, `\\${character}`)
-  }
-
-  return answer
-}
-
-export const addClassOptionIfNone = (
-  options: Extract<ComponentDef, { options: { classes?: string } }>['options'],
-  className: string
-) => {
-  options.classes ??= className
-}

package/src/server/plugins/engine/components/{helpers.test.ts → helpers/helpers.test.ts}

@@ -1,7 +1,7 @@
 import { type ComponentDef } from '@defra/forms-model'
 
 import { ComponentBase } from '~/src/server/plugins/engine/components/ComponentBase.js'
-import { createComponent } from '~/src/server/plugins/engine/components/helpers.js'
+import { createComponent } from '~/src/server/plugins/engine/components/helpers/components.js'
 import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import definition from '~/test/form/definitions/basic.js'
 

package/src/server/plugins/engine/components/helpers/index.ts

@@ -0,0 +1,38 @@
+import { type ComponentDef } from '@defra/forms-model'
+
+/**
+ * Prevent Markdown formatting
+ * @see {@link https://pandoc.org/chunkedhtml-demo/8.11-backslash-escapes.html}
+ */
+export function escapeMarkdown(answer: string) {
+  const punctuation = [
+    '`',
+    "'",
+    '*',
+    '_',
+    '{',
+    '}',
+    '[',
+    ']',
+    '(',
+    ')',
+    '#',
+    '+',
+    '-',
+    '.',
+    '!'
+  ]
+
+  for (const character of punctuation) {
+    answer = answer.toString().replaceAll(character, `\\${character}`)
+  }
+
+  return answer
+}
+
+export const addClassOptionIfNone = (
+  options: Extract<ComponentDef, { options: { classes?: string } }>['options'],
+  className: string
+) => {
+  options.classes ??= className
+}

package/src/server/plugins/engine/helpers.test.ts

@@ -22,7 +22,7 @@ import { buildFormContextRequest } from '~/src/server/plugins/engine/pageControl
 import {
   createPage,
   type PageControllerClass
-} from '~/src/server/plugins/engine/pageControllers/helpers.js'
+} from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
 import {
   type FormContext,
   type FormContextRequest

package/src/server/plugins/engine/helpers.ts

@@ -19,9 +19,9 @@ import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
 import {
   getAnswer,
   type Field
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { type FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
-import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers.js'
+import { type PageControllerClass } from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
 import {
   type FormContext,
   type FormContextRequest,

package/src/server/plugins/engine/models/FormModel.ts

@@ -33,7 +33,7 @@ import {} from '~/src/server/plugins/engine/components/YesNoField.js'
 import {
   hasListFormField,
   type Component
-} from '~/src/server/plugins/engine/components/helpers.js'
+} from '~/src/server/plugins/engine/components/helpers/components.js'
 import { todayAsDateOnly } from '~/src/server/plugins/engine/date-helper.js'
 import {
   findPage,
@@ -46,7 +46,7 @@ import { type PageController } from '~/src/server/plugins/engine/pageControllers
 import {
   createPage,
   type PageControllerClass
-} from '~/src/server/plugins/engine/pageControllers/helpers.js'
+} from '~/src/server/plugins/engine/pageControllers/helpers/pages.js'
 import { validationOptions as opts } from '~/src/server/plugins/engine/pageControllers/validationOptions.js'
 import * as defaultServices from '~/src/server/plugins/engine/services/index.js'
 import {