@defra/forms-engine-plugin 5.0.0-alpha.2 → 5.0.0-alpha.21

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

@@ -1 +1 @@
-{"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 FormVersionMetadata,\n  type Item,\n  type List,\n  type Page,\n  type PaymentFieldComponent,\n  type UkAddressFieldComponent\n} from '@defra/forms-model'\nimport {\n  type PluginProperties,\n  type Request,\n  type RequestQuery,\n  type ResponseObject\n} from '@hapi/hapi'\nimport { type Yar } from '@hapi/yar'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  type FileUploadField,\n  type PaymentField\n} from '~/src/server/plugins/engine/components/index.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel,\n  type DatePartsState,\n  type EastingNorthingState,\n  type LatLongState,\n  type MonthYearState\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItemField } from '~/src/server/plugins/engine/models/types.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 { type QuestionPageController } from '~/src/server/plugins/engine/pageControllers/index.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 FormRequest,\n  type FormRequestPayload,\n  type FormResponseToolkit,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\nexport type AnyFormRequest = FormRequest | FormRequestPayload\nexport type AnyRequest = Request | AnyFormRequest\n\nexport interface CacheRequest {\n  yar: { id: string | undefined }\n  params: { slug?: string; state?: string }\n}\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 extends Pick<\n  ValidationErrorItem,\n  'context' | 'path'\n> {\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 FormConfirmationState {\n  confirmed?: true\n  formId?: string\n  referenceNumber?: string\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  | GeospatialState\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  languages: { name: string; code: string }[]\n  translator: Translator | undefined\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\n/**\n * A longitude/latitude coordinate pair in WGS84 format\n * Format: [longitude, latitude]\n */\nexport type Coordinates = [longitude: number, latitude: number]\n\n/**\n * GeoJSON Point geometry\n */\nexport interface PointGeometry {\n  type: 'Point'\n  coordinates: Coordinates\n}\n\n/**\n * GeoJSON LineString geometry\n */\nexport interface LineStringGeometry {\n  type: 'LineString'\n  coordinates: Coordinates[]\n}\n\n/**\n * GeoJSON Polygon geometry\n */\nexport interface PolygonGeometry {\n  type: 'Polygon'\n  coordinates: Coordinates[][]\n}\n\n/**\n * Supported geometry types\n */\nexport type Geometry = PointGeometry | LineStringGeometry | PolygonGeometry\n\n/**\n * Feature metadata\n */\nexport interface FeatureProperties {\n  /**\n   * Human-readable description of the feature\n   */\n  description: string\n  /**\n   * The OS grid reference of the first coordinate of the feature\n   */\n  coordinateGridReference?: string\n  /**\n   * The OS grid reference of the centroid of the feature\n   */\n  centroidGridReference?: string\n}\n\n/**\n * A single GeoJSON Feature\n */\nexport interface Feature {\n  id: string\n  type: 'Feature'\n  properties: FeatureProperties\n  geometry: Geometry\n}\n\n/**\n * A GeoJSON FeatureCollection\n */\nexport type FeatureCollection = Feature[]\n\nexport type GeospatialState = FeatureCollection\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  t?: (key: string, opts?: Record<string, unknown>) => 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  allowSaveAndExit: boolean\n  showSubmitButton?: boolean\n  showPaymentExpiredNotification?: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n  allowSaveAndExit: boolean\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: AnyFormRequest,\n  h: FormResponseToolkit,\n  context: FormContext\n) =>\n  | ResponseObject\n  | FormResponseToolkit['continue']\n  | Promise<ResponseObject | FormResponseToolkit['continue']>\n\nexport type SaveAndExitHandler = (\n  request: FormRequestPayload,\n  h: FormResponseToolkit,\n  context: FormContext\n) => ResponseObject\n\nexport type GetLanguageHandler = (query?: RequestQuery, yar?: Yar) => string\n\nexport interface ExternalArgs {\n  component: ComponentDef\n  controller: QuestionPageController\n  sourceUrl: string\n  actionArgs?: Record<string, string>\n  isLive: boolean\n  isPreview: boolean\n}\n\nexport interface PostcodeLookupExternalArgs extends ExternalArgs {\n  component: UkAddressFieldComponent\n  actionArgs: { step: string }\n}\n\nexport interface PaymentExternalArgs extends ExternalArgs {\n  component: PaymentFieldComponent\n}\n\nexport interface ExternalStateAppendage {\n  component: string\n  data: FormStateValue | FormState\n}\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cache?: CacheService | string\n  globals?: Record<string, GlobalFunction>\n  filters?: Record<string, FilterFunction>\n  saveAndExit?: SaveAndExitHandler\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  getLanguage?: GetLanguageHandler\n  baseUrl: string // base URL of the application, protocol and hostname e.g. \"https://myapp.com\"\n  ordnanceSurveyApiKey?: string\n  ordnanceSurveyApiSecret?: string\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  versionMetadata?: FormVersionMetadata\n  language?: string\n  custom?: Record<string, unknown>\n}\n\nexport type FormAdapterSubmissionMessageMetaSerialised = Omit<\n  FormAdapterSubmissionMessageMeta,\n  'schemaVersion' | 'timestamp' | 'status'\n> & {\n  schemaVersion: number\n  status: string\n  timestamp: string\n}\nexport interface FormAdapterFile {\n  fileName: string\n  fileId: string\n  userDownloadLink: string\n}\n\nexport interface FormAdapterPayment {\n  paymentId: string\n  reference: string\n  amount: number\n  description: string\n  createdAt: string\n}\n\nexport interface FormAdapterSubmissionMessageResult {\n  files: {\n    main: string\n    repeaters: Record<string, string>\n  }\n}\n\n/**\n * A detail item specifically for files\n */\nexport type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {\n  field: FileUploadField\n}\n\n/**\n * A detail item specifically for payments\n */\nexport type PaymentFieldDetailItem = Omit<DetailItemField, 'field'> & {\n  field: PaymentField\n}\nexport type RichFormValue =\n  | FormValue\n  | FormPayload\n  | DatePartsState\n  | MonthYearState\n  | UkAddressState\n  | EastingNorthingState\n  | LatLongState\n  | GeospatialState\n\nexport interface FormAdapterSubmissionMessageData {\n  main: Record<string, RichFormValue | null>\n  repeaters: Record<string, Record<string, RichFormValue>[]>\n  files: Record<string, FormAdapterFile[]>\n  payment?: FormAdapterPayment\n}\n\nexport interface FormAdapterSubmissionMessagePayload {\n  meta: FormAdapterSubmissionMessageMeta\n  data: FormAdapterSubmissionMessageData\n  result: FormAdapterSubmissionMessageResult\n}\n\nexport interface FormAdapterSubmissionMessage extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AAkEA;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;;AA2BA;AACA;AACA;AACA;;AAwGA,SACEA,UAAU,EACVC,YAAY;;AAgEd;AACA;AACA;AACA;;AAGA;AACA;AACA;;AAMA;AACA;AACA;;AAMA;AACA;AACA;;AAMA;AACA;AACA;;AAGA;AACA;AACA;;AAgBA;AACA;AACA;;AAQA;AACA;AACA;;AA8MA;AACA;AACA;;AAKA;AACA;AACA","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 FormVersionMetadata,\n  type Item,\n  type List,\n  type Page,\n  type PaymentFieldComponent,\n  type SubmitConditionEvaluation,\n  type UkAddressFieldComponent\n} from '@defra/forms-model'\nimport {\n  type PluginProperties,\n  type Request,\n  type RequestQuery,\n  type ResponseObject\n} from '@hapi/hapi'\nimport { type Yar } from '@hapi/yar'\nimport { type JoiExpression, type ValidationErrorItem } from 'joi'\n\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js'\nimport { type Component } from '~/src/server/plugins/engine/components/helpers/components.js'\nimport {\n  type FileUploadField,\n  type PaymentField\n} from '~/src/server/plugins/engine/components/index.js'\nimport {\n  type BackLink,\n  type ComponentText,\n  type ComponentViewModel,\n  type DatePartsState,\n  type EastingNorthingState,\n  type LatLongState,\n  type MonthYearState\n} from '~/src/server/plugins/engine/components/types.js'\nimport { type Translator } from '~/src/server/plugins/engine/i18n/types.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItemField } from '~/src/server/plugins/engine/models/types.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 { type QuestionPageController } from '~/src/server/plugins/engine/pageControllers/index.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 FormRequest,\n  type FormRequestPayload,\n  type FormResponseToolkit,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\nimport { type RequestOptions } from '~/src/server/services/httpService.js'\nimport { type Services } from '~/src/server/types.js'\n\nexport type AnyFormRequest = FormRequest | FormRequestPayload\nexport type AnyRequest = Request | AnyFormRequest\n\nexport interface CacheRequest {\n  yar: { id: string | undefined }\n  params: { slug?: string; state?: string }\n}\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 extends Pick<\n  ValidationErrorItem,\n  'context' | 'path'\n> {\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 FormConfirmationState {\n  confirmed?: true\n  formId?: string\n  referenceNumber?: string\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  | GeospatialState\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  languages: { name: string; code: string }[]\n  translator: Translator | undefined\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      errorCode?: string\n      errorMessage?: string\n      errorParams?: Record<string, number | string | string[]>\n    }\n  | {\n      fileStatus: FileStatus.complete\n      errorCode?: string\n      errorMessage?: undefined\n      errorParams?: Record<string, number | string | string[]>\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\n/**\n * A longitude/latitude coordinate pair in WGS84 format\n * Format: [longitude, latitude]\n */\nexport type Coordinates = [longitude: number, latitude: number]\n\n/**\n * GeoJSON Point geometry\n */\nexport interface PointGeometry {\n  type: 'Point'\n  coordinates: Coordinates\n}\n\n/**\n * GeoJSON LineString geometry\n */\nexport interface LineStringGeometry {\n  type: 'LineString'\n  coordinates: Coordinates[]\n}\n\n/**\n * GeoJSON Polygon geometry\n */\nexport interface PolygonGeometry {\n  type: 'Polygon'\n  coordinates: Coordinates[][]\n}\n\n/**\n * Supported geometry types\n */\nexport type Geometry = PointGeometry | LineStringGeometry | PolygonGeometry\n\n/**\n * Feature metadata\n */\nexport interface FeatureProperties {\n  /**\n   * Human-readable description of the feature\n   */\n  description: string\n  /**\n   * The OS grid reference of the first coordinate of the feature\n   */\n  coordinateGridReference?: string\n  /**\n   * The OS grid reference of the centroid of the feature\n   */\n  centroidGridReference?: string\n}\n\n/**\n * A single GeoJSON Feature\n */\nexport interface Feature {\n  id: string\n  type: 'Feature'\n  properties: FeatureProperties\n  geometry: Geometry\n}\n\n/**\n * A GeoJSON FeatureCollection\n */\nexport type FeatureCollection = Feature[]\n\nexport type GeospatialState = FeatureCollection\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  t?: (key: string, opts?: Record<string, unknown>) => 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  allowSaveAndExit: boolean\n  showSubmitButton?: boolean\n  showPaymentExpiredNotification?: boolean\n}\n\nexport interface RepeaterSummaryPageViewModel extends PageViewModelBase {\n  context: FormContext\n  errors?: FormSubmissionError[]\n  checkAnswers: CheckAnswers[]\n  repeatTitle: string\n  allowSaveAndExit: boolean\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: AnyFormRequest,\n  h: FormResponseToolkit,\n  context: FormContext\n) =>\n  | ResponseObject\n  | FormResponseToolkit['continue']\n  | Promise<ResponseObject | FormResponseToolkit['continue']>\n\nexport type SaveAndExitHandler = (\n  request: FormRequestPayload,\n  h: FormResponseToolkit,\n  context: FormContext\n) => ResponseObject\n\nexport type GetLanguageHandler = (query?: RequestQuery, yar?: Yar) => string\n\nexport interface ExternalArgs {\n  component: ComponentDef\n  controller: QuestionPageController\n  sourceUrl: string\n  actionArgs?: Record<string, string>\n  isLive: boolean\n  isPreview: boolean\n}\n\nexport interface PostcodeLookupExternalArgs extends ExternalArgs {\n  component: UkAddressFieldComponent\n  actionArgs: { step: string }\n}\n\nexport interface PaymentExternalArgs extends ExternalArgs {\n  component: PaymentFieldComponent\n}\n\nexport interface ExternalStateAppendage {\n  component: string\n  data: FormStateValue | FormState\n}\n\nexport interface PluginOptions {\n  model?: FormModel\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  cache?: CacheService | string\n  globals?: Record<string, GlobalFunction>\n  filters?: Record<string, FilterFunction>\n  saveAndExit?: SaveAndExitHandler\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  getLanguage?: GetLanguageHandler\n  baseUrl: string // base URL of the application, protocol and hostname e.g. \"https://myapp.com\"\n  ordnanceSurveyApiKey?: string\n  ordnanceSurveyApiSecret?: string\n}\n\nexport interface FormAdapterSubmissionMessageMeta {\n  schemaVersion: (typeof FormAdapterSubmissionSchemaVersion)[keyof typeof 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  versionMetadata?: FormVersionMetadata\n  language?: string\n  custom?: Record<string, unknown>\n}\n\nexport type FormAdapterSubmissionMessageMetaSerialised = Omit<\n  FormAdapterSubmissionMessageMeta,\n  'schemaVersion' | 'timestamp' | 'status'\n> & {\n  schemaVersion: number\n  status: string\n  timestamp: string\n}\nexport interface FormAdapterFile {\n  fileName: string\n  fileId: string\n  userDownloadLink: string\n}\n\nexport interface FormAdapterPayment {\n  paymentId: string\n  reference: string\n  amount: number\n  description: string\n  descriptionInEng?: string\n  createdAt: string\n}\n\nexport interface FormAdapterSubmissionMessageResult {\n  files: {\n    main: string\n    repeaters: Record<string, string>\n  }\n}\n\n/**\n * A detail item specifically for files\n */\nexport type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {\n  field: FileUploadField\n}\n\n/**\n * A detail item specifically for payments\n */\nexport type PaymentFieldDetailItem = Omit<DetailItemField, 'field'> & {\n  field: PaymentField\n}\nexport type RichFormValue =\n  | FormValue\n  | FormPayload\n  | DatePartsState\n  | MonthYearState\n  | UkAddressState\n  | EastingNorthingState\n  | LatLongState\n  | GeospatialState\n\nexport interface FormAdapterSubmissionMessageData {\n  main: Record<string, RichFormValue | null>\n  repeaters: Record<string, Record<string, RichFormValue>[]>\n  files: Record<string, FormAdapterFile[]>\n  payment?: FormAdapterPayment\n}\n\nexport interface FormAdapterSubmissionMessagePayload {\n  meta: FormAdapterSubmissionMessageMeta\n  data: FormAdapterSubmissionMessageData\n  result: FormAdapterSubmissionMessageResult\n\n  /**\n   * The outcome of every condition in the form definition, evaluated against\n   * the final answers at the point of submission.\n   *\n   * Always emitted, empty when there is nothing to report - a V1-engine form\n   * has no stable condition ids to record against. Optional only for\n   * backwards compatibility: a message published before this existed carries\n   * no evaluations at all, and consumers fall back to resolving the recipients\n   * from the form definition themselves.\n   */\n  conditionEvaluations?: SubmitConditionEvaluation[]\n}\n\nexport interface FormAdapterSubmissionMessage extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AAmEA;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;;AA2BA;AACA;AACA;AACA;;AAwGA,SACEA,UAAU,EACVC,YAAY;;AAoEd;AACA;AACA;AACA;;AAGA;AACA;AACA;;AAMA;AACA;AACA;;AAMA;AACA;AACA;;AAMA;AACA;AACA;;AAGA;AACA;AACA;;AAgBA;AACA;AACA;;AAQA;AACA;AACA;;AA+MA;AACA;AACA;;AAKA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/unavailable-response.js

@@ -1,5 +1,6 @@
 import { isOfflineBoom } from "./form-availability.js";
 import { unavailableViewModel } from "./models/unavailable-view-model.js";
+import { resolveLanguage } from "../../utils/utils.js";
 
 /**
  * Registers a server-wide onPreResponse extension that intercepts the offline
@@ -15,9 +16,11 @@ export function registerUnavailableResponse(server) {
       return h.continue;
     }
     const {
-      metadata
+      metadata,
+      definition
     } = response.data;
-    return h.view('unavailable', unavailableViewModel(metadata)).header('Cache-Control', 'no-store, no-cache, must-revalidate').header('X-Robots-Tag', 'noindex, nofollow').code(200).takeover();
+    const language = resolveLanguage(request);
+    return h.view('unavailable', unavailableViewModel(metadata, definition, language)).header('Cache-Control', 'no-store, no-cache, must-revalidate').header('X-Robots-Tag', 'noindex, nofollow').code(200).takeover();
   });
 }
 //# sourceMappingURL=unavailable-response.js.map

package/.server/server/plugins/engine/unavailable-response.js.map

@@ -1 +1 @@
-{"version":3,"file":"unavailable-response.js","names":["isOfflineBoom","unavailableViewModel","registerUnavailableResponse","server","ext","request","h","response","continue","metadata","data","view","header","code","takeover"],"sources":["../../../../src/server/plugins/engine/unavailable-response.ts"],"sourcesContent":["import { type Request, type ResponseToolkit, type Server } from '@hapi/hapi'\n\nimport { isOfflineBoom } from '~/src/server/plugins/engine/form-availability.js'\nimport { unavailableViewModel } from '~/src/server/plugins/engine/models/unavailable-view-model.js'\n\n/**\n * Registers a server-wide onPreResponse extension that intercepts the offline\n * Boom thrown and renders the unavailable view.\n *\n * Must be registered after the engine's routes so it sees their responses,\n * but before any global error-page handler that would re-shape Boom errors.\n */\nexport function registerUnavailableResponse(server: Server) {\n  server.ext('onPreResponse', (request: Request, h: ResponseToolkit) => {\n    const response = request.response\n    if (!isOfflineBoom(response)) {\n      return h.continue\n    }\n\n    const { metadata } = response.data\n\n    return h\n      .view('unavailable', unavailableViewModel(metadata))\n      .header('Cache-Control', 'no-store, no-cache, must-revalidate')\n      .header('X-Robots-Tag', 'noindex, nofollow')\n      .code(200)\n      .takeover()\n  })\n}\n"],"mappings":"AAEA,SAASA,aAAa;AACtB,SAASC,oBAAoB;;AAE7B;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,2BAA2BA,CAACC,MAAc,EAAE;EAC1DA,MAAM,CAACC,GAAG,CAAC,eAAe,EAAE,CAACC,OAAgB,EAAEC,CAAkB,KAAK;IACpE,MAAMC,QAAQ,GAAGF,OAAO,CAACE,QAAQ;IACjC,IAAI,CAACP,aAAa,CAACO,QAAQ,CAAC,EAAE;MAC5B,OAAOD,CAAC,CAACE,QAAQ;IACnB;IAEA,MAAM;MAAEC;IAAS,CAAC,GAAGF,QAAQ,CAACG,IAAI;IAElC,OAAOJ,CAAC,CACLK,IAAI,CAAC,aAAa,EAAEV,oBAAoB,CAACQ,QAAQ,CAAC,CAAC,CACnDG,MAAM,CAAC,eAAe,EAAE,qCAAqC,CAAC,CAC9DA,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAC3CC,IAAI,CAAC,GAAG,CAAC,CACTC,QAAQ,CAAC,CAAC;EACf,CAAC,CAAC;AACJ","ignoreList":[]}
+{"version":3,"file":"unavailable-response.js","names":["isOfflineBoom","unavailableViewModel","resolveLanguage","registerUnavailableResponse","server","ext","request","h","response","continue","metadata","definition","data","language","view","header","code","takeover"],"sources":["../../../../src/server/plugins/engine/unavailable-response.ts"],"sourcesContent":["import { type Request, type ResponseToolkit, type Server } from '@hapi/hapi'\n\nimport { isOfflineBoom } from '~/src/server/plugins/engine/form-availability.js'\nimport { unavailableViewModel } from '~/src/server/plugins/engine/models/unavailable-view-model.js'\nimport { type AnyFormRequest } from '~/src/server/plugins/engine/types.js'\nimport { resolveLanguage } from '~/src/server/utils/utils.js'\n\n/**\n * Registers a server-wide onPreResponse extension that intercepts the offline\n * Boom thrown and renders the unavailable view.\n *\n * Must be registered after the engine's routes so it sees their responses,\n * but before any global error-page handler that would re-shape Boom errors.\n */\nexport function registerUnavailableResponse(server: Server) {\n  server.ext('onPreResponse', (request: Request, h: ResponseToolkit) => {\n    const response = request.response\n    if (!isOfflineBoom(response)) {\n      return h.continue\n    }\n\n    const { metadata, definition } = response.data\n\n    const language = resolveLanguage(request as unknown as AnyFormRequest)\n\n    return h\n      .view('unavailable', unavailableViewModel(metadata, definition, language))\n      .header('Cache-Control', 'no-store, no-cache, must-revalidate')\n      .header('X-Robots-Tag', 'noindex, nofollow')\n      .code(200)\n      .takeover()\n  })\n}\n"],"mappings":"AAEA,SAASA,aAAa;AACtB,SAASC,oBAAoB;AAE7B,SAASC,eAAe;;AAExB;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,2BAA2BA,CAACC,MAAc,EAAE;EAC1DA,MAAM,CAACC,GAAG,CAAC,eAAe,EAAE,CAACC,OAAgB,EAAEC,CAAkB,KAAK;IACpE,MAAMC,QAAQ,GAAGF,OAAO,CAACE,QAAQ;IACjC,IAAI,CAACR,aAAa,CAACQ,QAAQ,CAAC,EAAE;MAC5B,OAAOD,CAAC,CAACE,QAAQ;IACnB;IAEA,MAAM;MAAEC,QAAQ;MAAEC;IAAW,CAAC,GAAGH,QAAQ,CAACI,IAAI;IAE9C,MAAMC,QAAQ,GAAGX,eAAe,CAACI,OAAoC,CAAC;IAEtE,OAAOC,CAAC,CACLO,IAAI,CAAC,aAAa,EAAEb,oBAAoB,CAACS,QAAQ,EAAEC,UAAU,EAAEE,QAAQ,CAAC,CAAC,CACzEE,MAAM,CAAC,eAAe,EAAE,qCAAqC,CAAC,CAC9DA,MAAM,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAC3CC,IAAI,CAAC,GAAG,CAAC,CACTC,QAAQ,CAAC,CAAC;EACf,CAAC,CAAC;AACJ","ignoreList":[]}

package/.server/server/plugins/engine/views/components/_location-field-base.html

@@ -61,7 +61,7 @@
   {% set detailsHtml %}
     {% if component.model.instructionText %}
       {{ govukDetails({
-        summaryText: t('components.locationFieldBase.howToFind'),
+        summaryText: component.model.instructionSummary,
         html: component.model.instructionText | markdown | safe,
         classes: "govuk-!-margin-top-3"
       }) }}
@@ -70,8 +70,10 @@
 
   {% set hasErrors = showFieldsetError and component.model.errorMessage %}
 
-  <div class="govuk-form-group app-location-field {{ "govuk-form-group--error" if hasErrors }}"
+  <div id="{{component.model.name}}" class="govuk-form-group app-location-field {{ "govuk-form-group--error" if hasErrors }}"
     data-locationtype="{{component.type | lower}}"
+    data-country="{{component.model.country}}"
+    data-lang="{{component.model.lang}}"
     data-maplayers="{{component.model.mapLayers}}">
     {{ govukFieldset({
       legend: {

package/.server/server/plugins/engine/views/components/fileuploadfield.html

@@ -3,7 +3,7 @@
 {% macro FileUploadField(component) %}
   {% set upload = component.model.upload %}
 
-  <div id="uploadedFilesContainer">
+  <div id="uploadedFilesContainer" data-uploadinglabel="{{ upload.uploadingLabel }}">
     <h2 class="govuk-heading-m">{{ t('components.fileUploadField.uploadedFilesHeading') }}</h2>
     {% if upload.count %}
       <p class="govuk-body" role="alert">{{ t('components.fileUploadField.filesCount', { count: upload.count }) }}</p>

package/.server/server/plugins/engine/views/components/geospatialfield.html

@@ -2,6 +2,7 @@
 
 {% macro GeospatialField(component) %}
   <div class="app-geospatial-field"
+    data-lang="{{component.model.lang}}"
     data-country="{{component.model.country}}"
     data-geometryTypes="{{component.model.geometryTypes}}"
     data-maplayers="{{component.model.mapLayers}}">

package/.server/server/plugins/engine/views/components/multilinetextfield.html

@@ -3,7 +3,18 @@
 
 {% macro MultilineTextField(component) %}
   {% if component.model.isCharacterOrWordCount == true %}
-    {{ govukCharacterCount(component.model) }}
+    {% set characterParams = component.model | merge({
+      charactersUnderLimitText: {
+        one: t('components.characterCount.underLimit.one'),
+        other: t('components.characterCount.underLimit.other')
+      },
+      charactersAtLimitText: t('components.characterCount.atLimit'),
+      charactersOverLimitText: {
+        one: t('components.characterCount.overLimit.one'),
+        other: t('components.characterCount.overLimit.other')
+      }
+    } ) %}
+    {{ govukCharacterCount(characterParams) }}
   {% else %}
     {{ govukTextarea(component.model) }}
   {% endif %}

package/.server/server/plugins/engine/views/components/osgridreffield.html

@@ -3,7 +3,10 @@
 
 {% macro OsGridRefField(component) %}
   {% set hasErrors = component.model.errorMessage %}
-  <div class="govuk-form-group app-location-field {{ "govuk-form-group--error" if hasErrors }}" data-locationtype="{{component.type | lower}}">
+  <div class="govuk-form-group app-location-field {{ "govuk-form-group--error" if hasErrors }}"
+    data-locationtype="{{component.type | lower}}"
+    data-lang="{{component.model.lang}}"
+    data-maplayers="{{component.model.mapLayers}}">
     <div class="app-location-field-inputs">
       {{ TextField(component) }}
     </div>

package/.server/server/plugins/engine/views/components/paymentfield.html

@@ -16,7 +16,7 @@
       <p class="govuk-body">{{ t('components.paymentField.preAuthorisedBody') }}</p>
     {% else %}
       {# No pre-authorisation - show payment form #}
-      <h2 class="govuk-heading-m">{{ model.label.text if model.label and model.label.text else t('components.paymentField.detailsRequired') }}</h2>
+      <h2 class="govuk-heading-m">{{ t('components.paymentField.detailsRequired') }}</h2>
 
       <p class="govuk-body">{{ description }}</p>
 

package/.server/server/plugins/engine/views/components/ukaddressfield.html

@@ -61,7 +61,7 @@
               },
               classes: "govuk-button--secondary govuk-!-margin-right-1 govuk-!-margin-bottom-0"
             }) }}
-            <p class="govuk-body govuk-!-margin-bottom-0">or <button class="govuk-link govuk-button--link govuk-!-margin-right-1 govuk-!-margin-bottom-0" name="action" value="external-{{component.model.name}}--step:manual">{{ t('components.addressField.enterManually') }}</button></p>
+            <p class="govuk-body govuk-!-margin-bottom-0">{{ t('common.or')}} <button class="govuk-link govuk-button--link govuk-!-margin-right-1 govuk-!-margin-bottom-0" name="action" value="external-{{component.model.name}}--step:manual">{{ t('components.addressField.enterManually') }}</button></p>
           </div>
           {# Include a line break if this is the last component #}
           {% if components[components.length - 1] == component %}

package/.server/server/plugins/engine/views/file-upload.html

@@ -15,7 +15,7 @@
     {% if formAction %}
       {{ govukButton({
         text: t('pages.fileUpload.upload'),
-        classes: "govuk-button--secondary upload-file-button",
+        classes: "govuk-button--secondary upload-file-button js-hidden",
         preventDoubleClick: true,
         disabled: context.isForceAccess
       }) }}

package/.server/server/plugins/engine/views/partials/preview-banner.html

@@ -8,7 +8,9 @@
   </p>
 {%- endmacro -%}
 
-{% call govukNotificationBanner() %}
+{% call govukNotificationBanner({
+  titleText: t('pages.preview.bannerTitle')
+}) %}
   {% set previewModeTranslated = t('common.' + previewMode) %}
   {% if not context.isForceAccess %}
     <p class="govuk-notification-banner__heading govuk-!-margin-bottom-0">

package/.server/server/plugins/engine/views/unavailable.html

@@ -1,32 +1,35 @@
 {% extends baseLayoutPath %}
 
+{% set t = context.translator.t %}
+{% set tForm = context.translator.tForm %}
+
 {% block content %}
   <div class="govuk-grid-row">
     <div class="govuk-grid-column-two-thirds">
-      <h1 class="govuk-heading-l">Sorry, this form is unavailable</h1>
-      <p class="govuk-body">'{{ formTitle }}' is no longer available.</p>
-      <h2 class="govuk-heading-m">Contact details for {{ organisationName }}</h2>
+      <h1 class="govuk-heading-l">{{ t('pages.formUnavailable.title') }}</h1>
+      <p class="govuk-body">{{ t('pages.formUnavailable.subHeading', { formTitle: formTitle }) }}</p>
+      <h2 class="govuk-heading-m">{{ t('pages.formUnavailable.contactDetailsHeading', { organisationName: organisationName }) }}</h2>
 
       {% if contact.phone %}
-        <h3 class="govuk-heading-s">Telephone</h3>
+        <h3 class="govuk-heading-s">{{ t('pages.formUnavailable.telephone') }}</h3>
         <div class="app-prose-scope">
-          {{ contact.phone | markdown(3) | safe }}
+          {{ tForm('contact.phone') | markdown(3) | safe }}
         </div>
-        <p class="govuk-body"><a href="https://www.gov.uk/call-charges" class="govuk-link govuk-link--no-visited-state">Find out about call charges</a></p>
+        <p class="govuk-body"><a href="https://www.gov.uk/call-charges" class="govuk-link govuk-link--no-visited-state">{{ t('pages.formUnavailable.callCharges') }}</a></p>
       {% endif %}
 
       {% if contact.email %}
-        <h3 class="govuk-heading-s">Email</h3>
+        <h3 class="govuk-heading-s">{{ t('pages.formUnavailable.email') }}</h3>
         <ul class="govuk-list">
-          <li><a class="govuk-link govuk-link--no-visited-state" href="mailto:{{ contact.email.address }}">{{ contact.email.address }}</a></li>
-          <li>{{ contact.email.responseTime }}</li>
+          <li><a class="govuk-link govuk-link--no-visited-state" href="mailto:{{ tForm('contact.email.address') }}">{{ tForm('contact.email.address') }}</a></li>
+          <li>{{ tForm('contact.email.responseTime') }}</li>
         </ul>
       {% endif %}
 
       {% if contact.online %}
-        <h3 class="govuk-heading-s">Online contact form</h3>
+        <h3 class="govuk-heading-s">{{ t('pages.formUnavailable.onlineContactForm') }}</h3>
         <ul class="govuk-list">
-          <li><a class="govuk-link govuk-link--no-visited-state" href="{{ contact.online.url }}">{{ contact.online.text }}</a></li>
+          <li><a class="govuk-link govuk-link--no-visited-state" href="{{ tForm('contact.online.url') }}">{{ tForm('contact.online.text') }}</a></li>
         </ul>
       {% endif %}
     </div>

package/.server/server/plugins/nunjucks/filters/applyUrlParam.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Nunjucks filter to add/replace a parameter on a query string of a url.
+ * Currently only used in forms-runner.
+ * @param {string} urlPath - existing relative url with query string
+ * @param {string} paramName - name of parameter
+ * @param {string} paramValue - value of parameter
+ * @returns {string}
+ */
+export function applyUrlParam(urlPath: string, paramName: string, paramValue: string): string;

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

@@ -0,0 +1,17 @@
+/**
+ * Nunjucks filter to add/replace a parameter on a query string of a url.
+ * Currently only used in forms-runner.
+ * @param {string} urlPath - existing relative url with query string
+ * @param {string} paramName - name of parameter
+ * @param {string} paramValue - value of parameter
+ * @returns {string}
+ */
+export function applyUrlParam(urlPath, paramName, paramValue) {
+  if (typeof urlPath !== 'string') {
+    return '';
+  }
+  const url = new URL(urlPath, 'https://dummy');
+  url.searchParams.set(paramName, paramValue);
+  return url.pathname + url.search;
+}
+//# sourceMappingURL=applyUrlParam.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"applyUrlParam.js","names":["applyUrlParam","urlPath","paramName","paramValue","url","URL","searchParams","set","pathname","search"],"sources":["../../../../../src/server/plugins/nunjucks/filters/applyUrlParam.js"],"sourcesContent":["/**\n * Nunjucks filter to add/replace a parameter on a query string of a url.\n * Currently only used in forms-runner.\n * @param {string} urlPath - existing relative url with query string\n * @param {string} paramName - name of parameter\n * @param {string} paramValue - value of parameter\n * @returns {string}\n */\nexport function applyUrlParam(urlPath, paramName, paramValue) {\n  if (typeof urlPath !== 'string') {\n    return ''\n  }\n  const url = new URL(urlPath, 'https://dummy')\n  url.searchParams.set(paramName, paramValue)\n\n  return url.pathname + url.search\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,aAAaA,CAACC,OAAO,EAAEC,SAAS,EAAEC,UAAU,EAAE;EAC5D,IAAI,OAAOF,OAAO,KAAK,QAAQ,EAAE;IAC/B,OAAO,EAAE;EACX;EACA,MAAMG,GAAG,GAAG,IAAIC,GAAG,CAACJ,OAAO,EAAE,eAAe,CAAC;EAC7CG,GAAG,CAACE,YAAY,CAACC,GAAG,CAACL,SAAS,EAAEC,UAAU,CAAC;EAE3C,OAAOC,GAAG,CAACI,QAAQ,GAAGJ,GAAG,CAACK,MAAM;AAClC","ignoreList":[]}

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

@@ -0,0 +1,17 @@
+import { applyUrlParam } from "./applyUrlParam.js";
+describe('applyUrlParam', () => {
+  test('should return blank string if not a string input', () => {
+    // @ts-expect-error - wrong datatype for test
+    expect(applyUrlParam({}, 'name', 'val')).toBe('');
+  });
+  test('should add param', () => {
+    expect(applyUrlParam('/my-path/my-form', 'language', 'cy')).toBe('/my-path/my-form?language=cy');
+  });
+  test('should concat param', () => {
+    expect(applyUrlParam('/my-path/my-form?otherParam=123', 'language', 'en-GB')).toBe('/my-path/my-form?otherParam=123&language=en-GB');
+  });
+  test('should replace param', () => {
+    expect(applyUrlParam('/my-path/my-form?language=cy', 'language', 'en-GB')).toBe('/my-path/my-form?language=en-GB');
+  });
+});
+//# sourceMappingURL=applyUrlParam.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"applyUrlParam.test.js","names":["applyUrlParam","describe","test","expect","toBe"],"sources":["../../../../../src/server/plugins/nunjucks/filters/applyUrlParam.test.js"],"sourcesContent":["import { applyUrlParam } from '~/src/server/plugins/nunjucks/filters/applyUrlParam.js'\n\ndescribe('applyUrlParam', () => {\n  test('should return blank string if not a string input', () => {\n    // @ts-expect-error - wrong datatype for test\n    expect(applyUrlParam({}, 'name', 'val')).toBe('')\n  })\n\n  test('should add param', () => {\n    expect(applyUrlParam('/my-path/my-form', 'language', 'cy')).toBe(\n      '/my-path/my-form?language=cy'\n    )\n  })\n\n  test('should concat param', () => {\n    expect(\n      applyUrlParam('/my-path/my-form?otherParam=123', 'language', 'en-GB')\n    ).toBe('/my-path/my-form?otherParam=123&language=en-GB')\n  })\n\n  test('should replace param', () => {\n    expect(\n      applyUrlParam('/my-path/my-form?language=cy', 'language', 'en-GB')\n    ).toBe('/my-path/my-form?language=en-GB')\n  })\n})\n"],"mappings":"AAAA,SAASA,aAAa;AAEtBC,QAAQ,CAAC,eAAe,EAAE,MAAM;EAC9BC,IAAI,CAAC,kDAAkD,EAAE,MAAM;IAC7D;IACAC,MAAM,CAACH,aAAa,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAACI,IAAI,CAAC,EAAE,CAAC;EACnD,CAAC,CAAC;EAEFF,IAAI,CAAC,kBAAkB,EAAE,MAAM;IAC7BC,MAAM,CAACH,aAAa,CAAC,kBAAkB,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,CAACI,IAAI,CAC9D,8BACF,CAAC;EACH,CAAC,CAAC;EAEFF,IAAI,CAAC,qBAAqB,EAAE,MAAM;IAChCC,MAAM,CACJH,aAAa,CAAC,iCAAiC,EAAE,UAAU,EAAE,OAAO,CACtE,CAAC,CAACI,IAAI,CAAC,gDAAgD,CAAC;EAC1D,CAAC,CAAC;EAEFF,IAAI,CAAC,sBAAsB,EAAE,MAAM;IACjCC,MAAM,CACJH,aAAa,CAAC,8BAA8B,EAAE,UAAU,EAAE,OAAO,CACnE,CAAC,CAACI,IAAI,CAAC,iCAAiC,CAAC;EAC3C,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/.server/server/plugins/nunjucks/filters/field.d.ts

@@ -3,5 +3,5 @@
  * @this {NunjucksContext}
  * @param {string} name - The name of the component
  */
-export function field(this: NunjucksContext, name: string): import("../../engine/components/TextField.js").TextField | import("../../engine/components/PaymentField.js").PaymentField | import("../../engine/components/SelectField.js").SelectField | import("../../engine/components/RadiosField.js").RadiosField | import("../../engine/components/YesNoField.js").YesNoField | import("../../engine/components/CheckboxesField.js").CheckboxesField | import("../../engine/components/DatePartsField.js").DatePartsField | import("../../engine/components/DeclarationField.js").DeclarationField | import("../../engine/components/EastingNorthingField.js").EastingNorthingField | import("../../engine/components/EmailAddressField.js").EmailAddressField | import("../../engine/components/LatLongField.js").LatLongField | import("../../engine/components/MonthYearField.js").MonthYearField | import("../../engine/components/MultilineTextField.js").MultilineTextField | import("../../engine/components/NationalGridFieldNumberField.js").NationalGridFieldNumberField | import("../../engine/components/NumberField.js").NumberField | import("../../engine/components/OsGridRefField.js").OsGridRefField | import("../../engine/components/TelephoneNumberField.js").TelephoneNumberField | import("../../engine/components/UkAddressField.js").UkAddressField | import("../../engine/components/FileUploadField.js").FileUploadField | import("../../engine/components/HiddenField.js").HiddenField | import("../../engine/components/GeospatialField.js").GeospatialField | import("../../engine/components/Details.js").Details | import("../../engine/components/Html.js").Html | import("../../engine/components/InsetText.js").InsetText | import("../../engine/components/List.js").List | import("../../engine/components/Markdown.js").Markdown | import("../../engine/components/NotificationBanner.js").NotificationBanner | undefined;
+export function field(this: NunjucksContext, name: string): import("../../engine/components/TextField.js").TextField | import("../../engine/components/SelectField.js").SelectField | import("../../engine/components/RadiosField.js").RadiosField | import("../../engine/components/YesNoField.js").YesNoField | import("../../engine/components/CheckboxesField.js").CheckboxesField | import("../../engine/components/DatePartsField.js").DatePartsField | import("../../engine/components/DeclarationField.js").DeclarationField | import("../../engine/components/EastingNorthingField.js").EastingNorthingField | import("../../engine/components/EmailAddressField.js").EmailAddressField | import("../../engine/components/LatLongField.js").LatLongField | import("../../engine/components/MonthYearField.js").MonthYearField | import("../../engine/components/MultilineTextField.js").MultilineTextField | import("../../engine/components/NationalGridFieldNumberField.js").NationalGridFieldNumberField | import("../../engine/components/NumberField.js").NumberField | import("../../engine/components/OsGridRefField.js").OsGridRefField | import("../../engine/components/TelephoneNumberField.js").TelephoneNumberField | import("../../engine/components/UkAddressField.js").UkAddressField | import("../../engine/components/FileUploadField.js").FileUploadField | import("../../engine/components/HiddenField.js").HiddenField | import("../../engine/components/PaymentField.js").PaymentField | import("../../engine/components/GeospatialField.js").GeospatialField | import("../../engine/components/Details.js").Details | import("../../engine/components/Html.js").Html | import("../../engine/components/InsetText.js").InsetText | import("../../engine/components/List.js").List | import("../../engine/components/Markdown.js").Markdown | import("../../engine/components/NotificationBanner.js").NotificationBanner | undefined;
 import type { NunjucksContext } from '../../../../server/plugins/nunjucks/types.js';

package/.server/server/plugins/nunjucks/filters/index.d.ts

@@ -6,3 +6,4 @@ export { href } from "../../../../server/plugins/nunjucks/filters/href.js";
 export { field } from "../../../../server/plugins/nunjucks/filters/field.js";
 export { page } from "../../../../server/plugins/nunjucks/filters/page.js";
 export { merge } from "../../../../server/plugins/nunjucks/filters/merge.js";
+export { applyUrlParam } from "../../../../server/plugins/nunjucks/filters/applyUrlParam.js";

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

@@ -6,4 +6,5 @@ export { href } from "./href.js";
 export { field } from "./field.js";
 export { page } from "./page.js";
 export { merge } from "./merge.js";
+export { applyUrlParam } from "./applyUrlParam.js";
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["highlight","inspect","evaluate","answer","href","field","page","merge"],"sources":["../../../../../src/server/plugins/nunjucks/filters/index.js"],"sourcesContent":["export { highlight } from '~/src/server/plugins/nunjucks/filters/highlight.js'\nexport { inspect } from '~/src/server/plugins/nunjucks/filters/inspect.js'\nexport { evaluate } from '~/src/server/plugins/nunjucks/filters/evaluate.js'\nexport { answer } from '~/src/server/plugins/nunjucks/filters/answer.js'\nexport { href } from '~/src/server/plugins/nunjucks/filters/href.js'\nexport { field } from '~/src/server/plugins/nunjucks/filters/field.js'\nexport { page } from '~/src/server/plugins/nunjucks/filters/page.js'\nexport { merge } from '~/src/server/plugins/nunjucks/filters/merge.js'\n"],"mappings":"AAAA,SAASA,SAAS;AAClB,SAASC,OAAO;AAChB,SAASC,QAAQ;AACjB,SAASC,MAAM;AACf,SAASC,IAAI;AACb,SAASC,KAAK;AACd,SAASC,IAAI;AACb,SAASC,KAAK","ignoreList":[]}
+{"version":3,"file":"index.js","names":["highlight","inspect","evaluate","answer","href","field","page","merge","applyUrlParam"],"sources":["../../../../../src/server/plugins/nunjucks/filters/index.js"],"sourcesContent":["export { highlight } from '~/src/server/plugins/nunjucks/filters/highlight.js'\nexport { inspect } from '~/src/server/plugins/nunjucks/filters/inspect.js'\nexport { evaluate } from '~/src/server/plugins/nunjucks/filters/evaluate.js'\nexport { answer } from '~/src/server/plugins/nunjucks/filters/answer.js'\nexport { href } from '~/src/server/plugins/nunjucks/filters/href.js'\nexport { field } from '~/src/server/plugins/nunjucks/filters/field.js'\nexport { page } from '~/src/server/plugins/nunjucks/filters/page.js'\nexport { merge } from '~/src/server/plugins/nunjucks/filters/merge.js'\nexport { applyUrlParam } from '~/src/server/plugins/nunjucks/filters/applyUrlParam.js'\n"],"mappings":"AAAA,SAASA,SAAS;AAClB,SAASC,OAAO;AAChB,SAASC,QAAQ;AACjB,SAASC,MAAM;AACf,SAASC,IAAI;AACb,SAASC,KAAK;AACd,SAASC,IAAI;AACb,SAASC,KAAK;AACd,SAASC,aAAa","ignoreList":[]}

package/.server/server/plugins/payment/helper.d.ts

@@ -9,9 +9,19 @@ export function createPaymentService(isLivePayment: boolean, formId: string, for
 /**
  * Formats a payment date for display
  * @param {string} isoString - ISO date string
+ * @param {string} language - the target language
  * @returns {string} Formatted date string (e.g., "26 January 2026 5:01pm")
  */
-export function formatPaymentDate(isoString: string): string;
+export function formatPaymentDate(isoString: string, language: string): string;
+/**
+ * Formats a date for display in a specific language.
+ * To use additional languages, the appropriate module must be imported from 'date-fns/locale'
+ * @param { Date | string } date - the date
+ * @param {string} formatMask - the format mask
+ * @param {string} language - the target language
+ * @returns {string} Formatted date string (e.g., "26 January 2026 5:01pm")
+ */
+export function formatDateForLanguage(date: Date | string, formatMask: string, language: string): string;
 /**
  * Formats a currency amount with thousand separators and two decimal places
  * @param {number} amount - amount in pounds

package/.server/server/plugins/payment/helper.js

@@ -1,4 +1,5 @@
 import { format } from 'date-fns';
+import { toLanguageLocale } from "../engine/helpers.js";
 import { PaymentService } from "./service.js";
 export const DEFAULT_PAYMENT_HELP_URL = 'https://www.gov.uk/government/organisations/department-for-environment-food-rural-affairs';
 const PAYMENT_TEST_API_KEY = 'payment-test-api-key';
@@ -20,10 +21,25 @@ export async function createPaymentService(isLivePayment, formId, formsService)
 /**
  * Formats a payment date for display
  * @param {string} isoString - ISO date string
+ * @param {string} language - the target language
  * @returns {string} Formatted date string (e.g., "26 January 2026 5:01pm")
  */
-export function formatPaymentDate(isoString) {
-  return format(new Date(isoString), 'd MMMM yyyy h:mmaaa');
+export function formatPaymentDate(isoString, language) {
+  return formatDateForLanguage(new Date(isoString), 'd MMMM yyyy h:mmaaa', language);
+}
+
+/**
+ * Formats a date for display in a specific language.
+ * To use additional languages, the appropriate module must be imported from 'date-fns/locale'
+ * @param { Date | string } date - the date
+ * @param {string} formatMask - the format mask
+ * @param {string} language - the target language
+ * @returns {string} Formatted date string (e.g., "26 January 2026 5:01pm")
+ */
+export function formatDateForLanguage(date, formatMask, language) {
+  return format(date, formatMask, {
+    locale: toLanguageLocale(language)
+  });
 }
 
 /**

package/.server/server/plugins/payment/helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"helper.js","names":["format","PaymentService","DEFAULT_PAYMENT_HELP_URL","PAYMENT_TEST_API_KEY","PAYMENT_LIVE_API_KEY","createPaymentService","isLivePayment","formId","formsService","secretName","apiKey","getFormSecret","formatPaymentDate","isoString","Date","formatCurrency","amount","locale","currency","formatter","Intl","NumberFormat","style"],"sources":["../../../../src/server/plugins/payment/helper.js"],"sourcesContent":["import { format } from 'date-fns'\n\nimport { PaymentService } from '~/src/server/plugins/payment/service.js'\n\nexport const DEFAULT_PAYMENT_HELP_URL =\n  'https://www.gov.uk/government/organisations/department-for-environment-food-rural-affairs'\n\nconst PAYMENT_TEST_API_KEY = 'payment-test-api-key'\nconst PAYMENT_LIVE_API_KEY = 'payment-live-api-key'\n\n/**\n * Creates a PaymentService instance with the appropriate API key\n * @param {boolean} isLivePayment - true if this is a live payment\n * @param {string} formId - id of the form\n * @param {FormsService} formsService - service to handle form data operations\n * @returns {Promise<PaymentService>}\n */\nexport async function createPaymentService(\n  isLivePayment,\n  formId,\n  formsService\n) {\n  const secretName = isLivePayment ? PAYMENT_LIVE_API_KEY : PAYMENT_TEST_API_KEY\n  const apiKey = await formsService.getFormSecret(formId, secretName)\n  return new PaymentService(apiKey)\n}\n\n/**\n * Formats a payment date for display\n * @param {string} isoString - ISO date string\n * @returns {string} Formatted date string (e.g., \"26 January 2026 5:01pm\")\n */\nexport function formatPaymentDate(isoString) {\n  return format(new Date(isoString), 'd MMMM yyyy h:mmaaa')\n}\n\n/**\n * Formats a currency amount with thousand separators and two decimal places\n * @param {number} amount - amount in pounds\n * @param {'en-GB'} [locale] - locale for formatting\n * @param {'GBP'} [currency] - currency code\n * @returns {string} Formatted amount (e.g., \"£1,234.56\")\n */\nexport function formatCurrency(amount, locale = 'en-GB', currency = 'GBP') {\n  const formatter = new Intl.NumberFormat(locale, {\n    style: 'currency',\n    currency\n  })\n\n  return formatter.format(amount)\n}\n\n/**\n * @import { FormsService } from '~/src/server/types.js'\n */\n"],"mappings":"AAAA,SAASA,MAAM,QAAQ,UAAU;AAEjC,SAASC,cAAc;AAEvB,OAAO,MAAMC,wBAAwB,GACnC,2FAA2F;AAE7F,MAAMC,oBAAoB,GAAG,sBAAsB;AACnD,MAAMC,oBAAoB,GAAG,sBAAsB;;AAEnD;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,oBAAoBA,CACxCC,aAAa,EACbC,MAAM,EACNC,YAAY,EACZ;EACA,MAAMC,UAAU,GAAGH,aAAa,GAAGF,oBAAoB,GAAGD,oBAAoB;EAC9E,MAAMO,MAAM,GAAG,MAAMF,YAAY,CAACG,aAAa,CAACJ,MAAM,EAAEE,UAAU,CAAC;EACnE,OAAO,IAAIR,cAAc,CAACS,MAAM,CAAC;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,iBAAiBA,CAACC,SAAS,EAAE;EAC3C,OAAOb,MAAM,CAAC,IAAIc,IAAI,CAACD,SAAS,CAAC,EAAE,qBAAqB,CAAC;AAC3D;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,cAAcA,CAACC,MAAM,EAAEC,MAAM,GAAG,OAAO,EAAEC,QAAQ,GAAG,KAAK,EAAE;EACzE,MAAMC,SAAS,GAAG,IAAIC,IAAI,CAACC,YAAY,CAACJ,MAAM,EAAE;IAC9CK,KAAK,EAAE,UAAU;IACjBJ;EACF,CAAC,CAAC;EAEF,OAAOC,SAAS,CAACnB,MAAM,CAACgB,MAAM,CAAC;AACjC;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"helper.js","names":["format","toLanguageLocale","PaymentService","DEFAULT_PAYMENT_HELP_URL","PAYMENT_TEST_API_KEY","PAYMENT_LIVE_API_KEY","createPaymentService","isLivePayment","formId","formsService","secretName","apiKey","getFormSecret","formatPaymentDate","isoString","language","formatDateForLanguage","Date","date","formatMask","locale","formatCurrency","amount","currency","formatter","Intl","NumberFormat","style"],"sources":["../../../../src/server/plugins/payment/helper.js"],"sourcesContent":["import { format } from 'date-fns'\n\nimport { toLanguageLocale } from '~/src/server/plugins/engine/helpers.js'\nimport { PaymentService } from '~/src/server/plugins/payment/service.js'\n\nexport const DEFAULT_PAYMENT_HELP_URL =\n  'https://www.gov.uk/government/organisations/department-for-environment-food-rural-affairs'\n\nconst PAYMENT_TEST_API_KEY = 'payment-test-api-key'\nconst PAYMENT_LIVE_API_KEY = 'payment-live-api-key'\n\n/**\n * Creates a PaymentService instance with the appropriate API key\n * @param {boolean} isLivePayment - true if this is a live payment\n * @param {string} formId - id of the form\n * @param {FormsService} formsService - service to handle form data operations\n * @returns {Promise<PaymentService>}\n */\nexport async function createPaymentService(\n  isLivePayment,\n  formId,\n  formsService\n) {\n  const secretName = isLivePayment ? PAYMENT_LIVE_API_KEY : PAYMENT_TEST_API_KEY\n  const apiKey = await formsService.getFormSecret(formId, secretName)\n  return new PaymentService(apiKey)\n}\n\n/**\n * Formats a payment date for display\n * @param {string} isoString - ISO date string\n * @param {string} language - the target language\n * @returns {string} Formatted date string (e.g., \"26 January 2026 5:01pm\")\n */\nexport function formatPaymentDate(isoString, language) {\n  return formatDateForLanguage(\n    new Date(isoString),\n    'd MMMM yyyy h:mmaaa',\n    language\n  )\n}\n\n/**\n * Formats a date for display in a specific language.\n * To use additional languages, the appropriate module must be imported from 'date-fns/locale'\n * @param { Date | string } date - the date\n * @param {string} formatMask - the format mask\n * @param {string} language - the target language\n * @returns {string} Formatted date string (e.g., \"26 January 2026 5:01pm\")\n */\nexport function formatDateForLanguage(date, formatMask, language) {\n  return format(date, formatMask, {\n    locale: toLanguageLocale(language)\n  })\n}\n\n/**\n * Formats a currency amount with thousand separators and two decimal places\n * @param {number} amount - amount in pounds\n * @param {'en-GB'} [locale] - locale for formatting\n * @param {'GBP'} [currency] - currency code\n * @returns {string} Formatted amount (e.g., \"£1,234.56\")\n */\nexport function formatCurrency(amount, locale = 'en-GB', currency = 'GBP') {\n  const formatter = new Intl.NumberFormat(locale, {\n    style: 'currency',\n    currency\n  })\n\n  return formatter.format(amount)\n}\n\n/**\n * @import { FormsService } from '~/src/server/types.js'\n */\n"],"mappings":"AAAA,SAASA,MAAM,QAAQ,UAAU;AAEjC,SAASC,gBAAgB;AACzB,SAASC,cAAc;AAEvB,OAAO,MAAMC,wBAAwB,GACnC,2FAA2F;AAE7F,MAAMC,oBAAoB,GAAG,sBAAsB;AACnD,MAAMC,oBAAoB,GAAG,sBAAsB;;AAEnD;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAeC,oBAAoBA,CACxCC,aAAa,EACbC,MAAM,EACNC,YAAY,EACZ;EACA,MAAMC,UAAU,GAAGH,aAAa,GAAGF,oBAAoB,GAAGD,oBAAoB;EAC9E,MAAMO,MAAM,GAAG,MAAMF,YAAY,CAACG,aAAa,CAACJ,MAAM,EAAEE,UAAU,CAAC;EACnE,OAAO,IAAIR,cAAc,CAACS,MAAM,CAAC;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,iBAAiBA,CAACC,SAAS,EAAEC,QAAQ,EAAE;EACrD,OAAOC,qBAAqB,CAC1B,IAAIC,IAAI,CAACH,SAAS,CAAC,EACnB,qBAAqB,EACrBC,QACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,qBAAqBA,CAACE,IAAI,EAAEC,UAAU,EAAEJ,QAAQ,EAAE;EAChE,OAAOf,MAAM,CAACkB,IAAI,EAAEC,UAAU,EAAE;IAC9BC,MAAM,EAAEnB,gBAAgB,CAACc,QAAQ;EACnC,CAAC,CAAC;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASM,cAAcA,CAACC,MAAM,EAAEF,MAAM,GAAG,OAAO,EAAEG,QAAQ,GAAG,KAAK,EAAE;EACzE,MAAMC,SAAS,GAAG,IAAIC,IAAI,CAACC,YAAY,CAACN,MAAM,EAAE;IAC9CO,KAAK,EAAE,UAAU;IACjBJ;EACF,CAAC,CAAC;EAEF,OAAOC,SAAS,CAACxB,MAAM,CAACsB,MAAM,CAAC;AACjC;;AAEA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/payment/helper.test.js

@@ -1,7 +1,8 @@
+import { EN_GB } from "../../constants.js";
 import { formatCurrency, formatPaymentDate } from "./helper.js";
 describe('formatPaymentDate', () => {
   it('should format ISO date string to en-GB format', () => {
-    const result = formatPaymentDate('2025-11-10T17:01:29.000Z');
+    const result = formatPaymentDate('2025-11-10T17:01:29.000Z', EN_GB);
     expect(result).toBe('10 November 2025 5:01pm');
   });
 });

package/.server/server/plugins/payment/helper.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"helper.test.js","names":["formatCurrency","formatPaymentDate","describe","it","result","expect","toBe"],"sources":["../../../../src/server/plugins/payment/helper.test.js"],"sourcesContent":["import {\n  formatCurrency,\n  formatPaymentDate\n} from '~/src/server/plugins/payment/helper.js'\n\ndescribe('formatPaymentDate', () => {\n  it('should format ISO date string to en-GB format', () => {\n    const result = formatPaymentDate('2025-11-10T17:01:29.000Z')\n    expect(result).toBe('10 November 2025 5:01pm')\n  })\n})\n\ndescribe('formatCurrency', () => {\n  it('should format whole number with currency symbol', () => {\n    expect(formatCurrency(10)).toBe('£10.00')\n  })\n\n  it('should format decimal amount with currency symbol', () => {\n    expect(formatCurrency(99.5)).toBe('£99.50')\n  })\n\n  it('should format large amounts with thousand separators', () => {\n    expect(formatCurrency(1234.56)).toBe('£1,234.56')\n  })\n\n  it('should format very large amounts with thousand separators', () => {\n    expect(formatCurrency(20000)).toBe('£20,000.00')\n  })\n})\n"],"mappings":"AAAA,SACEA,cAAc,EACdC,iBAAiB;AAGnBC,QAAQ,CAAC,mBAAmB,EAAE,MAAM;EAClCC,EAAE,CAAC,+CAA+C,EAAE,MAAM;IACxD,MAAMC,MAAM,GAAGH,iBAAiB,CAAC,0BAA0B,CAAC;IAC5DI,MAAM,CAACD,MAAM,CAAC,CAACE,IAAI,CAAC,yBAAyB,CAAC;EAChD,CAAC,CAAC;AACJ,CAAC,CAAC;AAEFJ,QAAQ,CAAC,gBAAgB,EAAE,MAAM;EAC/BC,EAAE,CAAC,iDAAiD,EAAE,MAAM;IAC1DE,MAAM,CAACL,cAAc,CAAC,EAAE,CAAC,CAAC,CAACM,IAAI,CAAC,QAAQ,CAAC;EAC3C,CAAC,CAAC;EAEFH,EAAE,CAAC,mDAAmD,EAAE,MAAM;IAC5DE,MAAM,CAACL,cAAc,CAAC,IAAI,CAAC,CAAC,CAACM,IAAI,CAAC,QAAQ,CAAC;EAC7C,CAAC,CAAC;EAEFH,EAAE,CAAC,sDAAsD,EAAE,MAAM;IAC/DE,MAAM,CAACL,cAAc,CAAC,OAAO,CAAC,CAAC,CAACM,IAAI,CAAC,WAAW,CAAC;EACnD,CAAC,CAAC;EAEFH,EAAE,CAAC,2DAA2D,EAAE,MAAM;IACpEE,MAAM,CAACL,cAAc,CAAC,KAAK,CAAC,CAAC,CAACM,IAAI,CAAC,YAAY,CAAC;EAClD,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"helper.test.js","names":["EN_GB","formatCurrency","formatPaymentDate","describe","it","result","expect","toBe"],"sources":["../../../../src/server/plugins/payment/helper.test.js"],"sourcesContent":["import { EN_GB } from '~/src/server/constants.js'\nimport {\n  formatCurrency,\n  formatPaymentDate\n} from '~/src/server/plugins/payment/helper.js'\n\ndescribe('formatPaymentDate', () => {\n  it('should format ISO date string to en-GB format', () => {\n    const result = formatPaymentDate('2025-11-10T17:01:29.000Z', EN_GB)\n    expect(result).toBe('10 November 2025 5:01pm')\n  })\n})\n\ndescribe('formatCurrency', () => {\n  it('should format whole number with currency symbol', () => {\n    expect(formatCurrency(10)).toBe('£10.00')\n  })\n\n  it('should format decimal amount with currency symbol', () => {\n    expect(formatCurrency(99.5)).toBe('£99.50')\n  })\n\n  it('should format large amounts with thousand separators', () => {\n    expect(formatCurrency(1234.56)).toBe('£1,234.56')\n  })\n\n  it('should format very large amounts with thousand separators', () => {\n    expect(formatCurrency(20000)).toBe('£20,000.00')\n  })\n})\n"],"mappings":"AAAA,SAASA,KAAK;AACd,SACEC,cAAc,EACdC,iBAAiB;AAGnBC,QAAQ,CAAC,mBAAmB,EAAE,MAAM;EAClCC,EAAE,CAAC,+CAA+C,EAAE,MAAM;IACxD,MAAMC,MAAM,GAAGH,iBAAiB,CAAC,0BAA0B,EAAEF,KAAK,CAAC;IACnEM,MAAM,CAACD,MAAM,CAAC,CAACE,IAAI,CAAC,yBAAyB,CAAC;EAChD,CAAC,CAAC;AACJ,CAAC,CAAC;AAEFJ,QAAQ,CAAC,gBAAgB,EAAE,MAAM;EAC/BC,EAAE,CAAC,iDAAiD,EAAE,MAAM;IAC1DE,MAAM,CAACL,cAAc,CAAC,EAAE,CAAC,CAAC,CAACM,IAAI,CAAC,QAAQ,CAAC;EAC3C,CAAC,CAAC;EAEFH,EAAE,CAAC,mDAAmD,EAAE,MAAM;IAC5DE,MAAM,CAACL,cAAc,CAAC,IAAI,CAAC,CAAC,CAACM,IAAI,CAAC,QAAQ,CAAC;EAC7C,CAAC,CAAC;EAEFH,EAAE,CAAC,sDAAsD,EAAE,MAAM;IAC/DE,MAAM,CAACL,cAAc,CAAC,OAAO,CAAC,CAAC,CAACM,IAAI,CAAC,WAAW,CAAC;EACnD,CAAC,CAAC;EAEFH,EAAE,CAAC,2DAA2D,EAAE,MAAM;IACpEE,MAAM,CAACL,cAAc,CAAC,KAAK,CAAC,CAAC,CAACM,IAAI,CAAC,YAAY,CAAC;EAClD,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/.server/server/plugins/payment/service.d.ts

@@ -10,12 +10,13 @@ export class PaymentService {
      * @param {string} returnUrl
      * @param {string} reference
      * @param {boolean} isLivePayment
-     * @param {{ formId: string, slug: string } | undefined } metadata
+     * @param {{ formId: string, slug: string, language: string } | undefined } metadata
      * @param {string} [email] - optional email to prepopulate on GOV.UK Pay
      */
     createPayment(amount: number, description: string, returnUrl: string, reference: string, isLivePayment: boolean, metadata: {
         formId: string;
         slug: string;
+        language: string;
     } | undefined, email?: string): Promise<{
         paymentId: string;
         paymentUrl: string;

package/.server/server/plugins/payment/service.js

@@ -1,5 +1,6 @@
 import { StatusCodes } from 'http-status-codes';
 import { logger } from "../../common/helpers/logging/logger.js";
+import { toPayLanguageCode } from "../engine/helpers.js";
 import { buildPaymentInfo, convertPenceToPounds } from "../engine/routes/payment-helper.js";
 import { get, post, postJson } from "../../services/httpService.js";
 const PAYMENT_BASE_URL = 'https://publicapi.payments.service.gov.uk';
@@ -32,10 +33,11 @@ export class PaymentService {
    * @param {string} returnUrl
    * @param {string} reference
    * @param {boolean} isLivePayment
-   * @param {{ formId: string, slug: string } | undefined } metadata
+   * @param {{ formId: string, slug: string, language: string } | undefined } metadata
    * @param {string} [email] - optional email to prepopulate on GOV.UK Pay
    */
   async createPayment(amount, description, returnUrl, reference, isLivePayment, metadata, email) {
+    const language = toPayLanguageCode(metadata?.language);
     try {
       /** @type {CreatePaymentRequest} */
       const payload = {
@@ -44,7 +46,8 @@ export class PaymentService {
         reference,
         metadata,
         return_url: returnUrl,
-        delayed_capture: true
+        delayed_capture: true,
+        language
       };
 
       // Prepopulate email on GOV.UK Pay if provided