@defra/forms-engine-plugin 4.0.61 → 4.0.62

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 UkAddressFieldComponent\n} from '@defra/forms-model'\nimport {\n  type PluginProperties,\n  type Request,\n  type ResponseObject\n} from '@hapi/hapi'\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 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\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 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  | 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  submittedVersionNumber?: number\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  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 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 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  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  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\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\n  extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AAyDA;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;;AAyBA;AACA;AACA;AACA;;AAsGA,SACEA,UAAU,EACVC,YAAY;;AAgQd;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 UkAddressFieldComponent\n} from '@defra/forms-model'\nimport {\n  type PluginProperties,\n  type Request,\n  type ResponseObject\n} from '@hapi/hapi'\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 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\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 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  | 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  submittedVersionNumber?: number\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  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 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  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  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\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\n  extends FormAdapterSubmissionMessagePayload {\n  messageId: string\n  recordCreatedAt: Date\n}\n\nexport interface FormAdapterSubmissionService {\n  handleFormSubmission: (\n    submissionMessage: FormAdapterSubmissionMessage\n  ) => unknown\n}\n"],"mappings":"AA0DA;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;;AAyBA;AACA;AACA;AACA;;AAsGA,SACEA,UAAU,EACVC,YAAY;;AAoQd;AACA;AACA;;AAKA;AACA;AACA","ignoreList":[]}

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

@@ -1,19 +1,11 @@
-/**
- * Determine which payment API key value to use.
- * If a draft preview form or a live preview form, read the TEST API key value specific to that form.
- * If a live (non-preview) form, read the LIVE API key value specific to that form.
- * @param {boolean} isLivePayment - true if this is a live payment (as opposed to a test one)
- * @param {string} formId - id of the form
- * @returns {string}
- */
-export function getPaymentApiKey(isLivePayment: boolean, formId: string): string;
 /**
  * Creates a PaymentService instance with the appropriate API key
  * @param {boolean} isLivePayment - true if this is a live payment
  * @param {string} formId - id of the form
- * @returns {PaymentService}
+ * @param {FormsService} formsService - service to handle form data operations
+ * @returns {Promise<PaymentService>}
  */
-export function createPaymentService(isLivePayment: boolean, formId: string): PaymentService;
+export function createPaymentService(isLivePayment: boolean, formId: string, formsService: FormsService): Promise<PaymentService>;
 /**
  * Formats a payment date for display
  * @param {string} isoString - ISO date string
@@ -29,4 +21,5 @@ export function formatPaymentDate(isoString: string): string;
  */
 export function formatCurrency(amount: number, locale?: "en-GB", currency?: "GBP"): string;
 export const DEFAULT_PAYMENT_HELP_URL: "https://www.gov.uk/government/organisations/department-for-environment-food-rural-affairs";
+import type { FormsService } from '~/src/server/types.js';
 import { PaymentService } from '~/src/server/plugins/payment/service.js';

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

@@ -1,31 +1,19 @@
 import { format } from 'date-fns';
 import { PaymentService } from "./service.js";
 export const DEFAULT_PAYMENT_HELP_URL = 'https://www.gov.uk/government/organisations/department-for-environment-food-rural-affairs';
-
-/**
- * Determine which payment API key value to use.
- * If a draft preview form or a live preview form, read the TEST API key value specific to that form.
- * If a live (non-preview) form, read the LIVE API key value specific to that form.
- * @param {boolean} isLivePayment - true if this is a live payment (as opposed to a test one)
- * @param {string} formId - id of the form
- * @returns {string}
- */
-export function getPaymentApiKey(isLivePayment, formId) {
-  const apiKeyValue = isLivePayment ? process.env[`PAYMENT_PROVIDER_API_KEY_LIVE_${formId}`] : process.env[`PAYMENT_PROVIDER_API_KEY_TEST_${formId}`];
-  if (!apiKeyValue) {
-    throw new Error(`[payment] Missing payment api key for ${isLivePayment ? 'live' : 'test'} form id ${formId}`);
-  }
-  return apiKeyValue;
-}
+const PAYMENT_TEST_API_KEY = 'payment-test-api-key';
+const PAYMENT_LIVE_API_KEY = 'payment-live-api-key';
 
 /**
  * Creates a PaymentService instance with the appropriate API key
  * @param {boolean} isLivePayment - true if this is a live payment
  * @param {string} formId - id of the form
- * @returns {PaymentService}
+ * @param {FormsService} formsService - service to handle form data operations
+ * @returns {Promise<PaymentService>}
  */
-export function createPaymentService(isLivePayment, formId) {
-  const apiKey = getPaymentApiKey(isLivePayment, formId);
+export async function createPaymentService(isLivePayment, formId, formsService) {
+  const secretName = isLivePayment ? PAYMENT_LIVE_API_KEY : PAYMENT_TEST_API_KEY;
+  const apiKey = await formsService.getFormSecret(formId, secretName);
   return new PaymentService(apiKey);
 }
 
@@ -52,4 +40,8 @@ export function formatCurrency(amount, locale = 'en-GB', currency = 'GBP') {
   });
   return formatter.format(amount);
 }
+
+/**
+ * @import { FormsService } from '~/src/server/types.js'
+ */
 //# sourceMappingURL=helper.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"helper.js","names":["format","PaymentService","DEFAULT_PAYMENT_HELP_URL","getPaymentApiKey","isLivePayment","formId","apiKeyValue","process","env","Error","createPaymentService","apiKey","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\n/**\n * Determine which payment API key value to use.\n * If a draft preview form or a live preview form, read the TEST API key value specific to that form.\n * If a live (non-preview) form, read the LIVE API key value specific to that form.\n * @param {boolean} isLivePayment - true if this is a live payment (as opposed to a test one)\n * @param {string} formId - id of the form\n * @returns {string}\n */\nexport function getPaymentApiKey(isLivePayment, formId) {\n  const apiKeyValue = isLivePayment\n    ? process.env[`PAYMENT_PROVIDER_API_KEY_LIVE_${formId}`]\n    : process.env[`PAYMENT_PROVIDER_API_KEY_TEST_${formId}`]\n\n  if (!apiKeyValue) {\n    throw new Error(\n      `[payment] Missing payment api key for ${isLivePayment ? 'live' : 'test'} form id ${formId}`\n    )\n  }\n  return apiKeyValue\n}\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 * @returns {PaymentService}\n */\nexport function createPaymentService(isLivePayment, formId) {\n  const apiKey = getPaymentApiKey(isLivePayment, formId)\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"],"mappings":"AAAA,SAASA,MAAM,QAAQ,UAAU;AAEjC,SAASC,cAAc;AAEvB,OAAO,MAAMC,wBAAwB,GACnC,2FAA2F;;AAE7F;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAACC,aAAa,EAAEC,MAAM,EAAE;EACtD,MAAMC,WAAW,GAAGF,aAAa,GAC7BG,OAAO,CAACC,GAAG,CAAC,iCAAiCH,MAAM,EAAE,CAAC,GACtDE,OAAO,CAACC,GAAG,CAAC,iCAAiCH,MAAM,EAAE,CAAC;EAE1D,IAAI,CAACC,WAAW,EAAE;IAChB,MAAM,IAAIG,KAAK,CACb,yCAAyCL,aAAa,GAAG,MAAM,GAAG,MAAM,YAAYC,MAAM,EAC5F,CAAC;EACH;EACA,OAAOC,WAAW;AACpB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,oBAAoBA,CAACN,aAAa,EAAEC,MAAM,EAAE;EAC1D,MAAMM,MAAM,GAAGR,gBAAgB,CAACC,aAAa,EAAEC,MAAM,CAAC;EACtD,OAAO,IAAIJ,cAAc,CAACU,MAAM,CAAC;AACnC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,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","ignoreList":[]}
+{"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":[]}

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

@@ -1,25 +1,4 @@
-import { config } from "../../../config/index.js";
-import { formatCurrency, formatPaymentDate, getPaymentApiKey } from "./helper.js";
-describe('getPaymentApiKey', () => {
-  config.set('paymentProviderApiKeyTest', 'TEST-API-KEY');
-  const formId = 'form-id';
-  process.env['PAYMENT_PROVIDER_API_KEY_LIVE_form-id'] = 'LIVE-API-KEY';
-  process.env['PAYMENT_PROVIDER_API_KEY_TEST_form-id'] = 'TEST-API-KEY';
-  it('should read test key when non-live form', () => {
-    const apiKey = getPaymentApiKey(false, formId);
-    expect(apiKey).toBe('TEST-API-KEY');
-  });
-  it('should read live key when live form', () => {
-    const apiKey = getPaymentApiKey(true, formId);
-    expect(apiKey).toBe('LIVE-API-KEY');
-  });
-  it('should throw if TEST key is missing', () => {
-    expect(() => getPaymentApiKey(false, 'form-id-missing')).toThrow('Missing payment api key for test form id form-id-missing');
-  });
-  it('should throw if LIVE key is missing', () => {
-    expect(() => getPaymentApiKey(true, 'form-id-missing')).toThrow('Missing payment api key for live form id form-id-missing');
-  });
-});
+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');

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

@@ -1 +1 @@
-{"version":3,"file":"helper.test.js","names":["config","formatCurrency","formatPaymentDate","getPaymentApiKey","describe","set","formId","process","env","it","apiKey","expect","toBe","toThrow","result"],"sources":["../../../../src/server/plugins/payment/helper.test.js"],"sourcesContent":["import { config } from '~/src/config/index.js'\nimport {\n  formatCurrency,\n  formatPaymentDate,\n  getPaymentApiKey\n} from '~/src/server/plugins/payment/helper.js'\n\ndescribe('getPaymentApiKey', () => {\n  config.set('paymentProviderApiKeyTest', 'TEST-API-KEY')\n  const formId = 'form-id'\n  process.env['PAYMENT_PROVIDER_API_KEY_LIVE_form-id'] = 'LIVE-API-KEY'\n  process.env['PAYMENT_PROVIDER_API_KEY_TEST_form-id'] = 'TEST-API-KEY'\n\n  it('should read test key when non-live form', () => {\n    const apiKey = getPaymentApiKey(false, formId)\n    expect(apiKey).toBe('TEST-API-KEY')\n  })\n\n  it('should read live key when live form', () => {\n    const apiKey = getPaymentApiKey(true, formId)\n    expect(apiKey).toBe('LIVE-API-KEY')\n  })\n\n  it('should throw if TEST key is missing', () => {\n    expect(() => getPaymentApiKey(false, 'form-id-missing')).toThrow(\n      'Missing payment api key for test form id form-id-missing'\n    )\n  })\n\n  it('should throw if LIVE key is missing', () => {\n    expect(() => getPaymentApiKey(true, 'form-id-missing')).toThrow(\n      'Missing payment api key for live form id form-id-missing'\n    )\n  })\n})\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,SAASA,MAAM;AACf,SACEC,cAAc,EACdC,iBAAiB,EACjBC,gBAAgB;AAGlBC,QAAQ,CAAC,kBAAkB,EAAE,MAAM;EACjCJ,MAAM,CAACK,GAAG,CAAC,2BAA2B,EAAE,cAAc,CAAC;EACvD,MAAMC,MAAM,GAAG,SAAS;EACxBC,OAAO,CAACC,GAAG,CAAC,uCAAuC,CAAC,GAAG,cAAc;EACrED,OAAO,CAACC,GAAG,CAAC,uCAAuC,CAAC,GAAG,cAAc;EAErEC,EAAE,CAAC,yCAAyC,EAAE,MAAM;IAClD,MAAMC,MAAM,GAAGP,gBAAgB,CAAC,KAAK,EAAEG,MAAM,CAAC;IAC9CK,MAAM,CAACD,MAAM,CAAC,CAACE,IAAI,CAAC,cAAc,CAAC;EACrC,CAAC,CAAC;EAEFH,EAAE,CAAC,qCAAqC,EAAE,MAAM;IAC9C,MAAMC,MAAM,GAAGP,gBAAgB,CAAC,IAAI,EAAEG,MAAM,CAAC;IAC7CK,MAAM,CAACD,MAAM,CAAC,CAACE,IAAI,CAAC,cAAc,CAAC;EACrC,CAAC,CAAC;EAEFH,EAAE,CAAC,qCAAqC,EAAE,MAAM;IAC9CE,MAAM,CAAC,MAAMR,gBAAgB,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAACU,OAAO,CAC9D,0DACF,CAAC;EACH,CAAC,CAAC;EAEFJ,EAAE,CAAC,qCAAqC,EAAE,MAAM;IAC9CE,MAAM,CAAC,MAAMR,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAACU,OAAO,CAC7D,0DACF,CAAC;EACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAEFT,QAAQ,CAAC,mBAAmB,EAAE,MAAM;EAClCK,EAAE,CAAC,+CAA+C,EAAE,MAAM;IACxD,MAAMK,MAAM,GAAGZ,iBAAiB,CAAC,0BAA0B,CAAC;IAC5DS,MAAM,CAACG,MAAM,CAAC,CAACF,IAAI,CAAC,yBAAyB,CAAC;EAChD,CAAC,CAAC;AACJ,CAAC,CAAC;AAEFR,QAAQ,CAAC,gBAAgB,EAAE,MAAM;EAC/BK,EAAE,CAAC,iDAAiD,EAAE,MAAM;IAC1DE,MAAM,CAACV,cAAc,CAAC,EAAE,CAAC,CAAC,CAACW,IAAI,CAAC,QAAQ,CAAC;EAC3C,CAAC,CAAC;EAEFH,EAAE,CAAC,mDAAmD,EAAE,MAAM;IAC5DE,MAAM,CAACV,cAAc,CAAC,IAAI,CAAC,CAAC,CAACW,IAAI,CAAC,QAAQ,CAAC;EAC7C,CAAC,CAAC;EAEFH,EAAE,CAAC,sDAAsD,EAAE,MAAM;IAC/DE,MAAM,CAACV,cAAc,CAAC,OAAO,CAAC,CAAC,CAACW,IAAI,CAAC,WAAW,CAAC;EACnD,CAAC,CAAC;EAEFH,EAAE,CAAC,2DAA2D,EAAE,MAAM;IACpEE,MAAM,CAACV,cAAc,CAAC,KAAK,CAAC,CAAC,CAACW,IAAI,CAAC,YAAY,CAAC;EAClD,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
+{"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":[]}

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

@@ -10,15 +10,15 @@ export class PaymentService {
      * @param {string} returnUrl
      * @param {string} reference
      * @param {boolean} isLivePayment
-     * @param {{ formId: string, slug: string }} metadata
+     * @param {{ formId: string, slug: string } | undefined } metadata
      */
     createPayment(amount: number, description: string, returnUrl: string, reference: string, isLivePayment: boolean, metadata: {
         formId: string;
         slug: string;
-    }): Promise<{
+    } | undefined): Promise<{
         paymentId: string;
         paymentUrl: string;
-    }>;
+    } | undefined>;
     /**
      * @param {string} paymentId
      * @param {boolean} isLivePayment

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

@@ -33,22 +33,30 @@ export class PaymentService {
    * @param {string} returnUrl
    * @param {string} reference
    * @param {boolean} isLivePayment
-   * @param {{ formId: string, slug: string }} metadata
+   * @param {{ formId: string, slug: string } | undefined } metadata
    */
   async createPayment(amount, description, returnUrl, reference, isLivePayment, metadata) {
-    const response = await this.postToPayProvider({
-      amount,
-      description,
-      reference,
-      metadata,
-      return_url: returnUrl,
-      delayed_capture: true
-    });
-    logger.info(buildPaymentInfo('create-payment', 'success', `amount=${convertPenceToPounds(amount)}`, isLivePayment, response.payment_id), `[payment] Created payment and user taken to enter pre-auth details for paymentId=${response.payment_id}`);
-    return {
-      paymentId: response.payment_id,
-      paymentUrl: response._links.next_url.href
-    };
+    try {
+      const response = await this.postToPayProvider({
+        amount,
+        description,
+        reference,
+        metadata,
+        return_url: returnUrl,
+        delayed_capture: true
+      });
+      logger.info(buildPaymentInfo('create-payment', 'success', `amount=${convertPenceToPounds(amount)}`, isLivePayment, response.payment_id), `[payment] Created payment and user taken to enter pre-auth details for paymentId=${response.payment_id}`);
+      return {
+        paymentId: response.payment_id,
+        paymentUrl: response._links.next_url.href
+      };
+    } catch (err) {
+      const error = /** @type {{ output?: { payload?: any }, message?: any }} */err;
+      if (isLivePayment) {
+        logger.error(error.output?.payload ?? error.message, `[payment] Failed to create payment session for reference ${reference}`);
+      }
+    }
+    return undefined;
   }
 
   /**
@@ -132,7 +140,9 @@ export class PaymentService {
       return response.payload;
     } catch (err) {
       const error = /** @type {Error} */err;
-      logger.error(error, `[payment] Error creating payment for reference=${payload.reference}: ${error.message}`);
+      if (!error.message.includes('401 Unauthorized')) {
+        logger.error(error, `[payment] Error creating payment for reference=${payload.reference}: ${error.message}`);
+      }
       throw err;
     }
   }

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

@@ -1 +1 @@
-{"version":3,"file":"service.js","names":["StatusCodes","createLogger","buildPaymentInfo","convertPenceToPounds","get","post","postJson","PAYMENT_BASE_URL","PAYMENT_ENDPOINT","logger","getAuthHeaders","apiKey","Authorization","PaymentService","constructor","createPayment","amount","description","returnUrl","reference","isLivePayment","metadata","response","postToPayProvider","return_url","delayed_capture","info","payment_id","paymentId","paymentUrl","_links","next_url","href","getPaymentStatus","getByType","headers","json","error","errorMessage","Error","message","JSON","stringify","state","payload","status","code","email","err","capturePayment","statusCode","res","OK","NO_CONTENT","event","category","action","outcome","reason","postJsonByType"],"sources":["../../../../src/server/plugins/payment/service.js"],"sourcesContent":["import { StatusCodes } from 'http-status-codes'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport {\n  buildPaymentInfo,\n  convertPenceToPounds\n} from '~/src/server/plugins/engine/routes/payment-helper.js'\nimport { get, post, postJson } from '~/src/server/services/httpService.js'\n\nconst PAYMENT_BASE_URL = 'https://publicapi.payments.service.gov.uk'\nconst PAYMENT_ENDPOINT = '/v1/payments'\n\nconst logger = createLogger()\n\n/**\n * @param {string} apiKey\n * @returns {{ Authorization: string }}\n */\nfunction getAuthHeaders(apiKey) {\n  return {\n    Authorization: `Bearer ${apiKey}`\n  }\n}\n\nexport class PaymentService {\n  /** @type {string} */\n  #apiKey\n\n  /**\n   * @param {string} apiKey - API key to use (global config for test value, per-form config for live value)\n   */\n  constructor(apiKey) {\n    this.#apiKey = apiKey\n  }\n\n  /**\n   * Creates a payment with delayed capture (pre-authorisation)\n   * @param {number} amount - in pence\n   * @param {string} description\n   * @param {string} returnUrl\n   * @param {string} reference\n   * @param {boolean} isLivePayment\n   * @param {{ formId: string, slug: string }} metadata\n   */\n  async createPayment(\n    amount,\n    description,\n    returnUrl,\n    reference,\n    isLivePayment,\n    metadata\n  ) {\n    const response = await this.postToPayProvider({\n      amount,\n      description,\n      reference,\n      metadata,\n      return_url: returnUrl,\n      delayed_capture: true\n    })\n\n    logger.info(\n      buildPaymentInfo(\n        'create-payment',\n        'success',\n        `amount=${convertPenceToPounds(amount)}`,\n        isLivePayment,\n        response.payment_id\n      ),\n      `[payment] Created payment and user taken to enter pre-auth details for paymentId=${response.payment_id}`\n    )\n\n    return {\n      paymentId: response.payment_id,\n      paymentUrl: response._links.next_url.href\n    }\n  }\n\n  /**\n   * @param {string} paymentId\n   * @param {boolean} isLivePayment\n   * @returns {Promise<GetPaymentResponse>}\n   */\n  async getPaymentStatus(paymentId, isLivePayment) {\n    const getByType = /** @type {typeof get<GetPaymentApiResponse>} */ (get)\n\n    try {\n      const response = await getByType(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}/${paymentId}`,\n        {\n          headers: getAuthHeaders(this.#apiKey),\n          json: true\n        }\n      )\n\n      if (response.error) {\n        const errorMessage =\n          response.error instanceof Error\n            ? response.error.message\n            : JSON.stringify(response.error)\n        throw new Error(`Failed to get payment status: ${errorMessage}`)\n      }\n\n      const state = response.payload.state\n      logger.info(\n        buildPaymentInfo(\n          'get-payment-status',\n          state.status === 'capturable' || state.status === 'success'\n            ? 'success'\n            : 'failure',\n          `status:${state.status} code:${state.code ?? 'N/A'} message:${state.message ?? 'N/A'}`,\n          isLivePayment,\n          paymentId\n        ),\n        `[payment] Got payment status for paymentId=${paymentId}: status=${state.status}`\n      )\n\n      return {\n        state,\n        _links: response.payload._links,\n        email: response.payload.email,\n        paymentId: response.payload.payment_id,\n        amount: response.payload.amount\n      }\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      logger.error(\n        error,\n        `[payment] Error getting payment status for paymentId=${paymentId}: ${error.message}`\n      )\n      throw err\n    }\n  }\n\n  /**\n   * Captures a payment that is in 'capturable' status\n   * @param {string} paymentId\n   * @param {number} amount\n   * @returns {Promise<boolean>}\n   */\n  async capturePayment(paymentId, amount) {\n    try {\n      const response = await post(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}/${paymentId}/capture`,\n        {\n          headers: getAuthHeaders(this.#apiKey)\n        }\n      )\n\n      const statusCode = response.res.statusCode\n\n      if (\n        statusCode === StatusCodes.OK ||\n        statusCode === StatusCodes.NO_CONTENT\n      ) {\n        logger.info(\n          {\n            event: {\n              category: 'payment',\n              action: 'capture-payment',\n              outcome: 'success',\n              reason: `amount=${convertPenceToPounds(amount)}`,\n              reference: paymentId\n            }\n          },\n          `[payment] Successfully captured payment for paymentId=${paymentId}`\n        )\n        return true\n      }\n\n      logger.error(\n        `[payment] Capture failed for paymentId=${paymentId}: HTTP ${statusCode}`\n      )\n      return false\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      logger.error(\n        error,\n        `[payment] Error capturing payment for paymentId=${paymentId}: ${error.message}`\n      )\n      throw err\n    }\n  }\n\n  /**\n   * @param {CreatePaymentRequest} payload\n   */\n  async postToPayProvider(payload) {\n    const postJsonByType =\n      /** @type {typeof postJson<CreatePaymentResponse>} */ (postJson)\n\n    try {\n      const response = await postJsonByType(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}`,\n        {\n          payload,\n          headers: getAuthHeaders(this.#apiKey)\n        }\n      )\n\n      if (response.payload?.state.status !== 'created') {\n        throw new Error(\n          `Failed to create payment for reference=${payload.reference}`\n        )\n      }\n\n      return response.payload\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      logger.error(\n        error,\n        `[payment] Error creating payment for reference=${payload.reference}: ${error.message}`\n      )\n      throw err\n    }\n  }\n}\n\n/**\n * @import { CreatePaymentRequest, CreatePaymentResponse, GetPaymentApiResponse, GetPaymentResponse } from '~/src/server/plugins/payment/types.js'\n */\n"],"mappings":"AAAA,SAASA,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,YAAY;AACrB,SACEC,gBAAgB,EAChBC,oBAAoB;AAEtB,SAASC,GAAG,EAAEC,IAAI,EAAEC,QAAQ;AAE5B,MAAMC,gBAAgB,GAAG,2CAA2C;AACpE,MAAMC,gBAAgB,GAAG,cAAc;AAEvC,MAAMC,MAAM,GAAGR,YAAY,CAAC,CAAC;;AAE7B;AACA;AACA;AACA;AACA,SAASS,cAAcA,CAACC,MAAM,EAAE;EAC9B,OAAO;IACLC,aAAa,EAAE,UAAUD,MAAM;EACjC,CAAC;AACH;AAEA,OAAO,MAAME,cAAc,CAAC;EAC1B;EACA,CAACF,MAAM;;EAEP;AACF;AACA;EACEG,WAAWA,CAACH,MAAM,EAAE;IAClB,IAAI,CAAC,CAACA,MAAM,GAAGA,MAAM;EACvB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMI,aAAaA,CACjBC,MAAM,EACNC,WAAW,EACXC,SAAS,EACTC,SAAS,EACTC,aAAa,EACbC,QAAQ,EACR;IACA,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACC,iBAAiB,CAAC;MAC5CP,MAAM;MACNC,WAAW;MACXE,SAAS;MACTE,QAAQ;MACRG,UAAU,EAAEN,SAAS;MACrBO,eAAe,EAAE;IACnB,CAAC,CAAC;IAEFhB,MAAM,CAACiB,IAAI,CACTxB,gBAAgB,CACd,gBAAgB,EAChB,SAAS,EACT,UAAUC,oBAAoB,CAACa,MAAM,CAAC,EAAE,EACxCI,aAAa,EACbE,QAAQ,CAACK,UACX,CAAC,EACD,oFAAoFL,QAAQ,CAACK,UAAU,EACzG,CAAC;IAED,OAAO;MACLC,SAAS,EAAEN,QAAQ,CAACK,UAAU;MAC9BE,UAAU,EAAEP,QAAQ,CAACQ,MAAM,CAACC,QAAQ,CAACC;IACvC,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMC,gBAAgBA,CAACL,SAAS,EAAER,aAAa,EAAE;IAC/C,MAAMc,SAAS,GAAG,gDAAkD9B,GAAI;IAExE,IAAI;MACF,MAAMkB,QAAQ,GAAG,MAAMY,SAAS,CAC9B,GAAG3B,gBAAgB,GAAGC,gBAAgB,IAAIoB,SAAS,EAAE,EACrD;QACEO,OAAO,EAAEzB,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM,CAAC;QACrCyB,IAAI,EAAE;MACR,CACF,CAAC;MAED,IAAId,QAAQ,CAACe,KAAK,EAAE;QAClB,MAAMC,YAAY,GAChBhB,QAAQ,CAACe,KAAK,YAAYE,KAAK,GAC3BjB,QAAQ,CAACe,KAAK,CAACG,OAAO,GACtBC,IAAI,CAACC,SAAS,CAACpB,QAAQ,CAACe,KAAK,CAAC;QACpC,MAAM,IAAIE,KAAK,CAAC,iCAAiCD,YAAY,EAAE,CAAC;MAClE;MAEA,MAAMK,KAAK,GAAGrB,QAAQ,CAACsB,OAAO,CAACD,KAAK;MACpClC,MAAM,CAACiB,IAAI,CACTxB,gBAAgB,CACd,oBAAoB,EACpByC,KAAK,CAACE,MAAM,KAAK,YAAY,IAAIF,KAAK,CAACE,MAAM,KAAK,SAAS,GACvD,SAAS,GACT,SAAS,EACb,UAAUF,KAAK,CAACE,MAAM,SAASF,KAAK,CAACG,IAAI,IAAI,KAAK,YAAYH,KAAK,CAACH,OAAO,IAAI,KAAK,EAAE,EACtFpB,aAAa,EACbQ,SACF,CAAC,EACD,8CAA8CA,SAAS,YAAYe,KAAK,CAACE,MAAM,EACjF,CAAC;MAED,OAAO;QACLF,KAAK;QACLb,MAAM,EAAER,QAAQ,CAACsB,OAAO,CAACd,MAAM;QAC/BiB,KAAK,EAAEzB,QAAQ,CAACsB,OAAO,CAACG,KAAK;QAC7BnB,SAAS,EAAEN,QAAQ,CAACsB,OAAO,CAACjB,UAAU;QACtCX,MAAM,EAAEM,QAAQ,CAACsB,OAAO,CAAC5B;MAC3B,CAAC;IACH,CAAC,CAAC,OAAOgC,GAAG,EAAE;MACZ,MAAMX,KAAK,GAAG,oBAAsBW,GAAI;MACxCvC,MAAM,CAAC4B,KAAK,CACVA,KAAK,EACL,wDAAwDT,SAAS,KAAKS,KAAK,CAACG,OAAO,EACrF,CAAC;MACD,MAAMQ,GAAG;IACX;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE,MAAMC,cAAcA,CAACrB,SAAS,EAAEZ,MAAM,EAAE;IACtC,IAAI;MACF,MAAMM,QAAQ,GAAG,MAAMjB,IAAI,CACzB,GAAGE,gBAAgB,GAAGC,gBAAgB,IAAIoB,SAAS,UAAU,EAC7D;QACEO,OAAO,EAAEzB,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM;MACtC,CACF,CAAC;MAED,MAAMuC,UAAU,GAAG5B,QAAQ,CAAC6B,GAAG,CAACD,UAAU;MAE1C,IACEA,UAAU,KAAKlD,WAAW,CAACoD,EAAE,IAC7BF,UAAU,KAAKlD,WAAW,CAACqD,UAAU,EACrC;QACA5C,MAAM,CAACiB,IAAI,CACT;UACE4B,KAAK,EAAE;YACLC,QAAQ,EAAE,SAAS;YACnBC,MAAM,EAAE,iBAAiB;YACzBC,OAAO,EAAE,SAAS;YAClBC,MAAM,EAAE,UAAUvD,oBAAoB,CAACa,MAAM,CAAC,EAAE;YAChDG,SAAS,EAAES;UACb;QACF,CAAC,EACD,yDAAyDA,SAAS,EACpE,CAAC;QACD,OAAO,IAAI;MACb;MAEAnB,MAAM,CAAC4B,KAAK,CACV,0CAA0CT,SAAS,UAAUsB,UAAU,EACzE,CAAC;MACD,OAAO,KAAK;IACd,CAAC,CAAC,OAAOF,GAAG,EAAE;MACZ,MAAMX,KAAK,GAAG,oBAAsBW,GAAI;MACxCvC,MAAM,CAAC4B,KAAK,CACVA,KAAK,EACL,mDAAmDT,SAAS,KAAKS,KAAK,CAACG,OAAO,EAChF,CAAC;MACD,MAAMQ,GAAG;IACX;EACF;;EAEA;AACF;AACA;EACE,MAAMzB,iBAAiBA,CAACqB,OAAO,EAAE;IAC/B,MAAMe,cAAc,GAClB,qDAAuDrD,QAAS;IAElE,IAAI;MACF,MAAMgB,QAAQ,GAAG,MAAMqC,cAAc,CACnC,GAAGpD,gBAAgB,GAAGC,gBAAgB,EAAE,EACxC;QACEoC,OAAO;QACPT,OAAO,EAAEzB,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM;MACtC,CACF,CAAC;MAED,IAAIW,QAAQ,CAACsB,OAAO,EAAED,KAAK,CAACE,MAAM,KAAK,SAAS,EAAE;QAChD,MAAM,IAAIN,KAAK,CACb,0CAA0CK,OAAO,CAACzB,SAAS,EAC7D,CAAC;MACH;MAEA,OAAOG,QAAQ,CAACsB,OAAO;IACzB,CAAC,CAAC,OAAOI,GAAG,EAAE;MACZ,MAAMX,KAAK,GAAG,oBAAsBW,GAAI;MACxCvC,MAAM,CAAC4B,KAAK,CACVA,KAAK,EACL,kDAAkDO,OAAO,CAACzB,SAAS,KAAKkB,KAAK,CAACG,OAAO,EACvF,CAAC;MACD,MAAMQ,GAAG;IACX;EACF;AACF;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"service.js","names":["StatusCodes","createLogger","buildPaymentInfo","convertPenceToPounds","get","post","postJson","PAYMENT_BASE_URL","PAYMENT_ENDPOINT","logger","getAuthHeaders","apiKey","Authorization","PaymentService","constructor","createPayment","amount","description","returnUrl","reference","isLivePayment","metadata","response","postToPayProvider","return_url","delayed_capture","info","payment_id","paymentId","paymentUrl","_links","next_url","href","err","error","output","payload","message","undefined","getPaymentStatus","getByType","headers","json","errorMessage","Error","JSON","stringify","state","status","code","email","capturePayment","statusCode","res","OK","NO_CONTENT","event","category","action","outcome","reason","postJsonByType","includes"],"sources":["../../../../src/server/plugins/payment/service.js"],"sourcesContent":["import { StatusCodes } from 'http-status-codes'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport {\n  buildPaymentInfo,\n  convertPenceToPounds\n} from '~/src/server/plugins/engine/routes/payment-helper.js'\nimport { get, post, postJson } from '~/src/server/services/httpService.js'\n\nconst PAYMENT_BASE_URL = 'https://publicapi.payments.service.gov.uk'\nconst PAYMENT_ENDPOINT = '/v1/payments'\n\nconst logger = createLogger()\n\n/**\n * @param {string} apiKey\n * @returns {{ Authorization: string }}\n */\nfunction getAuthHeaders(apiKey) {\n  return {\n    Authorization: `Bearer ${apiKey}`\n  }\n}\n\nexport class PaymentService {\n  /** @type {string} */\n  #apiKey\n\n  /**\n   * @param {string} apiKey - API key to use (global config for test value, per-form config for live value)\n   */\n  constructor(apiKey) {\n    this.#apiKey = apiKey\n  }\n\n  /**\n   * Creates a payment with delayed capture (pre-authorisation)\n   * @param {number} amount - in pence\n   * @param {string} description\n   * @param {string} returnUrl\n   * @param {string} reference\n   * @param {boolean} isLivePayment\n   * @param {{ formId: string, slug: string } | undefined } metadata\n   */\n  async createPayment(\n    amount,\n    description,\n    returnUrl,\n    reference,\n    isLivePayment,\n    metadata\n  ) {\n    try {\n      const response = await this.postToPayProvider({\n        amount,\n        description,\n        reference,\n        metadata,\n        return_url: returnUrl,\n        delayed_capture: true\n      })\n\n      logger.info(\n        buildPaymentInfo(\n          'create-payment',\n          'success',\n          `amount=${convertPenceToPounds(amount)}`,\n          isLivePayment,\n          response.payment_id\n        ),\n        `[payment] Created payment and user taken to enter pre-auth details for paymentId=${response.payment_id}`\n      )\n\n      return {\n        paymentId: response.payment_id,\n        paymentUrl: response._links.next_url.href\n      }\n    } catch (err) {\n      const error =\n        /** @type {{ output?: { payload?: any }, message?: any }} */ (err)\n      if (isLivePayment) {\n        logger.error(\n          error.output?.payload ?? error.message,\n          `[payment] Failed to create payment session for reference ${reference}`\n        )\n      }\n    }\n    return undefined\n  }\n\n  /**\n   * @param {string} paymentId\n   * @param {boolean} isLivePayment\n   * @returns {Promise<GetPaymentResponse>}\n   */\n  async getPaymentStatus(paymentId, isLivePayment) {\n    const getByType = /** @type {typeof get<GetPaymentApiResponse>} */ (get)\n\n    try {\n      const response = await getByType(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}/${paymentId}`,\n        {\n          headers: getAuthHeaders(this.#apiKey),\n          json: true\n        }\n      )\n\n      if (response.error) {\n        const errorMessage =\n          response.error instanceof Error\n            ? response.error.message\n            : JSON.stringify(response.error)\n        throw new Error(`Failed to get payment status: ${errorMessage}`)\n      }\n\n      const state = response.payload.state\n      logger.info(\n        buildPaymentInfo(\n          'get-payment-status',\n          state.status === 'capturable' || state.status === 'success'\n            ? 'success'\n            : 'failure',\n          `status:${state.status} code:${state.code ?? 'N/A'} message:${state.message ?? 'N/A'}`,\n          isLivePayment,\n          paymentId\n        ),\n        `[payment] Got payment status for paymentId=${paymentId}: status=${state.status}`\n      )\n\n      return {\n        state,\n        _links: response.payload._links,\n        email: response.payload.email,\n        paymentId: response.payload.payment_id,\n        amount: response.payload.amount\n      }\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      logger.error(\n        error,\n        `[payment] Error getting payment status for paymentId=${paymentId}: ${error.message}`\n      )\n      throw err\n    }\n  }\n\n  /**\n   * Captures a payment that is in 'capturable' status\n   * @param {string} paymentId\n   * @param {number} amount\n   * @returns {Promise<boolean>}\n   */\n  async capturePayment(paymentId, amount) {\n    try {\n      const response = await post(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}/${paymentId}/capture`,\n        {\n          headers: getAuthHeaders(this.#apiKey)\n        }\n      )\n\n      const statusCode = response.res.statusCode\n\n      if (\n        statusCode === StatusCodes.OK ||\n        statusCode === StatusCodes.NO_CONTENT\n      ) {\n        logger.info(\n          {\n            event: {\n              category: 'payment',\n              action: 'capture-payment',\n              outcome: 'success',\n              reason: `amount=${convertPenceToPounds(amount)}`,\n              reference: paymentId\n            }\n          },\n          `[payment] Successfully captured payment for paymentId=${paymentId}`\n        )\n        return true\n      }\n\n      logger.error(\n        `[payment] Capture failed for paymentId=${paymentId}: HTTP ${statusCode}`\n      )\n      return false\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      logger.error(\n        error,\n        `[payment] Error capturing payment for paymentId=${paymentId}: ${error.message}`\n      )\n      throw err\n    }\n  }\n\n  /**\n   * @param {CreatePaymentRequest} payload\n   */\n  async postToPayProvider(payload) {\n    const postJsonByType =\n      /** @type {typeof postJson<CreatePaymentResponse>} */ (postJson)\n\n    try {\n      const response = await postJsonByType(\n        `${PAYMENT_BASE_URL}${PAYMENT_ENDPOINT}`,\n        {\n          payload,\n          headers: getAuthHeaders(this.#apiKey)\n        }\n      )\n\n      if (response.payload?.state.status !== 'created') {\n        throw new Error(\n          `Failed to create payment for reference=${payload.reference}`\n        )\n      }\n\n      return response.payload\n    } catch (err) {\n      const error = /** @type {Error} */ (err)\n      if (!error.message.includes('401 Unauthorized')) {\n        logger.error(\n          error,\n          `[payment] Error creating payment for reference=${payload.reference}: ${error.message}`\n        )\n      }\n      throw err\n    }\n  }\n}\n\n/**\n * @import { CreatePaymentRequest, CreatePaymentResponse, GetPaymentApiResponse, GetPaymentResponse } from '~/src/server/plugins/payment/types.js'\n */\n"],"mappings":"AAAA,SAASA,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,YAAY;AACrB,SACEC,gBAAgB,EAChBC,oBAAoB;AAEtB,SAASC,GAAG,EAAEC,IAAI,EAAEC,QAAQ;AAE5B,MAAMC,gBAAgB,GAAG,2CAA2C;AACpE,MAAMC,gBAAgB,GAAG,cAAc;AAEvC,MAAMC,MAAM,GAAGR,YAAY,CAAC,CAAC;;AAE7B;AACA;AACA;AACA;AACA,SAASS,cAAcA,CAACC,MAAM,EAAE;EAC9B,OAAO;IACLC,aAAa,EAAE,UAAUD,MAAM;EACjC,CAAC;AACH;AAEA,OAAO,MAAME,cAAc,CAAC;EAC1B;EACA,CAACF,MAAM;;EAEP;AACF;AACA;EACEG,WAAWA,CAACH,MAAM,EAAE;IAClB,IAAI,CAAC,CAACA,MAAM,GAAGA,MAAM;EACvB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMI,aAAaA,CACjBC,MAAM,EACNC,WAAW,EACXC,SAAS,EACTC,SAAS,EACTC,aAAa,EACbC,QAAQ,EACR;IACA,IAAI;MACF,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACC,iBAAiB,CAAC;QAC5CP,MAAM;QACNC,WAAW;QACXE,SAAS;QACTE,QAAQ;QACRG,UAAU,EAAEN,SAAS;QACrBO,eAAe,EAAE;MACnB,CAAC,CAAC;MAEFhB,MAAM,CAACiB,IAAI,CACTxB,gBAAgB,CACd,gBAAgB,EAChB,SAAS,EACT,UAAUC,oBAAoB,CAACa,MAAM,CAAC,EAAE,EACxCI,aAAa,EACbE,QAAQ,CAACK,UACX,CAAC,EACD,oFAAoFL,QAAQ,CAACK,UAAU,EACzG,CAAC;MAED,OAAO;QACLC,SAAS,EAAEN,QAAQ,CAACK,UAAU;QAC9BE,UAAU,EAAEP,QAAQ,CAACQ,MAAM,CAACC,QAAQ,CAACC;MACvC,CAAC;IACH,CAAC,CAAC,OAAOC,GAAG,EAAE;MACZ,MAAMC,KAAK,GACT,4DAA8DD,GAAI;MACpE,IAAIb,aAAa,EAAE;QACjBX,MAAM,CAACyB,KAAK,CACVA,KAAK,CAACC,MAAM,EAAEC,OAAO,IAAIF,KAAK,CAACG,OAAO,EACtC,4DAA4DlB,SAAS,EACvE,CAAC;MACH;IACF;IACA,OAAOmB,SAAS;EAClB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMC,gBAAgBA,CAACX,SAAS,EAAER,aAAa,EAAE;IAC/C,MAAMoB,SAAS,GAAG,gDAAkDpC,GAAI;IAExE,IAAI;MACF,MAAMkB,QAAQ,GAAG,MAAMkB,SAAS,CAC9B,GAAGjC,gBAAgB,GAAGC,gBAAgB,IAAIoB,SAAS,EAAE,EACrD;QACEa,OAAO,EAAE/B,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM,CAAC;QACrC+B,IAAI,EAAE;MACR,CACF,CAAC;MAED,IAAIpB,QAAQ,CAACY,KAAK,EAAE;QAClB,MAAMS,YAAY,GAChBrB,QAAQ,CAACY,KAAK,YAAYU,KAAK,GAC3BtB,QAAQ,CAACY,KAAK,CAACG,OAAO,GACtBQ,IAAI,CAACC,SAAS,CAACxB,QAAQ,CAACY,KAAK,CAAC;QACpC,MAAM,IAAIU,KAAK,CAAC,iCAAiCD,YAAY,EAAE,CAAC;MAClE;MAEA,MAAMI,KAAK,GAAGzB,QAAQ,CAACc,OAAO,CAACW,KAAK;MACpCtC,MAAM,CAACiB,IAAI,CACTxB,gBAAgB,CACd,oBAAoB,EACpB6C,KAAK,CAACC,MAAM,KAAK,YAAY,IAAID,KAAK,CAACC,MAAM,KAAK,SAAS,GACvD,SAAS,GACT,SAAS,EACb,UAAUD,KAAK,CAACC,MAAM,SAASD,KAAK,CAACE,IAAI,IAAI,KAAK,YAAYF,KAAK,CAACV,OAAO,IAAI,KAAK,EAAE,EACtFjB,aAAa,EACbQ,SACF,CAAC,EACD,8CAA8CA,SAAS,YAAYmB,KAAK,CAACC,MAAM,EACjF,CAAC;MAED,OAAO;QACLD,KAAK;QACLjB,MAAM,EAAER,QAAQ,CAACc,OAAO,CAACN,MAAM;QAC/BoB,KAAK,EAAE5B,QAAQ,CAACc,OAAO,CAACc,KAAK;QAC7BtB,SAAS,EAAEN,QAAQ,CAACc,OAAO,CAACT,UAAU;QACtCX,MAAM,EAAEM,QAAQ,CAACc,OAAO,CAACpB;MAC3B,CAAC;IACH,CAAC,CAAC,OAAOiB,GAAG,EAAE;MACZ,MAAMC,KAAK,GAAG,oBAAsBD,GAAI;MACxCxB,MAAM,CAACyB,KAAK,CACVA,KAAK,EACL,wDAAwDN,SAAS,KAAKM,KAAK,CAACG,OAAO,EACrF,CAAC;MACD,MAAMJ,GAAG;IACX;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE,MAAMkB,cAAcA,CAACvB,SAAS,EAAEZ,MAAM,EAAE;IACtC,IAAI;MACF,MAAMM,QAAQ,GAAG,MAAMjB,IAAI,CACzB,GAAGE,gBAAgB,GAAGC,gBAAgB,IAAIoB,SAAS,UAAU,EAC7D;QACEa,OAAO,EAAE/B,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM;MACtC,CACF,CAAC;MAED,MAAMyC,UAAU,GAAG9B,QAAQ,CAAC+B,GAAG,CAACD,UAAU;MAE1C,IACEA,UAAU,KAAKpD,WAAW,CAACsD,EAAE,IAC7BF,UAAU,KAAKpD,WAAW,CAACuD,UAAU,EACrC;QACA9C,MAAM,CAACiB,IAAI,CACT;UACE8B,KAAK,EAAE;YACLC,QAAQ,EAAE,SAAS;YACnBC,MAAM,EAAE,iBAAiB;YACzBC,OAAO,EAAE,SAAS;YAClBC,MAAM,EAAE,UAAUzD,oBAAoB,CAACa,MAAM,CAAC,EAAE;YAChDG,SAAS,EAAES;UACb;QACF,CAAC,EACD,yDAAyDA,SAAS,EACpE,CAAC;QACD,OAAO,IAAI;MACb;MAEAnB,MAAM,CAACyB,KAAK,CACV,0CAA0CN,SAAS,UAAUwB,UAAU,EACzE,CAAC;MACD,OAAO,KAAK;IACd,CAAC,CAAC,OAAOnB,GAAG,EAAE;MACZ,MAAMC,KAAK,GAAG,oBAAsBD,GAAI;MACxCxB,MAAM,CAACyB,KAAK,CACVA,KAAK,EACL,mDAAmDN,SAAS,KAAKM,KAAK,CAACG,OAAO,EAChF,CAAC;MACD,MAAMJ,GAAG;IACX;EACF;;EAEA;AACF;AACA;EACE,MAAMV,iBAAiBA,CAACa,OAAO,EAAE;IAC/B,MAAMyB,cAAc,GAClB,qDAAuDvD,QAAS;IAElE,IAAI;MACF,MAAMgB,QAAQ,GAAG,MAAMuC,cAAc,CACnC,GAAGtD,gBAAgB,GAAGC,gBAAgB,EAAE,EACxC;QACE4B,OAAO;QACPK,OAAO,EAAE/B,cAAc,CAAC,IAAI,CAAC,CAACC,MAAM;MACtC,CACF,CAAC;MAED,IAAIW,QAAQ,CAACc,OAAO,EAAEW,KAAK,CAACC,MAAM,KAAK,SAAS,EAAE;QAChD,MAAM,IAAIJ,KAAK,CACb,0CAA0CR,OAAO,CAACjB,SAAS,EAC7D,CAAC;MACH;MAEA,OAAOG,QAAQ,CAACc,OAAO;IACzB,CAAC,CAAC,OAAOH,GAAG,EAAE;MACZ,MAAMC,KAAK,GAAG,oBAAsBD,GAAI;MACxC,IAAI,CAACC,KAAK,CAACG,OAAO,CAACyB,QAAQ,CAAC,kBAAkB,CAAC,EAAE;QAC/CrD,MAAM,CAACyB,KAAK,CACVA,KAAK,EACL,kDAAkDE,OAAO,CAACjB,SAAS,KAAKe,KAAK,CAACG,OAAO,EACvF,CAAC;MACH;MACA,MAAMJ,GAAG;IACX;EACF;AACF;;AAEA;AACA;AACA","ignoreList":[]}

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

@@ -36,10 +36,10 @@ describe('payment service', () => {
         slug: 'my-form-slug'
       };
       const payment = await service.createPayment(100, 'Payment description', returnUrl, referenceNumber, false, metadata);
-      expect(payment.paymentId).toBe('payment-id-12345');
-      expect(payment.paymentUrl).toBe('http://next-url-href/payment');
+      expect(payment?.paymentId).toBe('payment-id-12345');
+      expect(payment?.paymentUrl).toBe('http://next-url-href/payment');
     });
-    it('should throw if fails to create a payment - failed API call', async () => {
+    it('should return undefined if fails to create a payment - failed API call', async () => {
       jest.mocked(postJson).mockRejectedValueOnce(new Error('internal creation error'));
       const referenceNumber = 'ABC-DEF-123';
       const returnUrl = 'http://localhost:3009/payment-callback-handler';
@@ -47,9 +47,10 @@ describe('payment service', () => {
         formId: 'form-id',
         slug: 'my-form-slug'
       };
-      await expect(() => service.createPayment(100, 'Payment description', returnUrl, referenceNumber, false, metadata)).rejects.toThrow('internal creation error');
+      const res = await service.createPayment(100, 'Payment description', returnUrl, referenceNumber, false, metadata);
+      expect(res).toBeUndefined();
     });
-    it('should throw if fails to create a payment - bad result from API call', async () => {
+    it('should return undefined if fails to create a payment - bad result from API call', async () => {
       const createPaymentResult = {
         state: {
           status: 'failed'
@@ -69,7 +70,8 @@ describe('payment service', () => {
         formId: 'form-id',
         slug: 'my-form-slug'
       };
-      await expect(() => service.createPayment(100, 'Payment description', returnUrl, referenceNumber, false, metadata)).rejects.toThrow('Failed to create payment');
+      const res = await service.createPayment(100, 'Payment description', returnUrl, referenceNumber, false, metadata);
+      expect(res).toBeUndefined();
     });
   });
   describe('getPaymentStatus', () => {

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

@@ -1 +1 @@
-{"version":3,"file":"service.test.js","names":["PaymentService","get","post","postJson","jest","mock","describe","service","it","expect","toBeDefined","createPaymentResult","payment_id","_links","next_url","href","state","status","mocked","mockResolvedValueOnce","res","statusCode","headers","payload","error","undefined","referenceNumber","returnUrl","metadata","formId","slug","payment","createPayment","paymentId","toBe","paymentUrl","mockRejectedValueOnce","Error","rejects","toThrow","getPaymentStatusResult","paymentStatus","getPaymentStatus","capturePaymentResult","captureResult","capturePayment"],"sources":["../../../../src/server/plugins/payment/service.test.js"],"sourcesContent":["import { PaymentService } from '~/src/server/plugins/payment/service.js'\nimport { get, post, postJson } from '~/src/server/services/httpService.js'\n\njest.mock('~/src/server/services/httpService.ts')\n\ndescribe('payment service', () => {\n  const service = new PaymentService('my-api-key')\n  describe('constructor', () => {\n    it('should create instance', () => {\n      expect(service).toBeDefined()\n    })\n  })\n\n  describe('createPayment', () => {\n    it('should create a payment', async () => {\n      const createPaymentResult = {\n        payment_id: 'payment-id-12345',\n        _links: {\n          next_url: {\n            href: 'http://next-url-href/payment'\n          }\n        },\n        state: {\n          status: 'created'\n        }\n      }\n      jest.mocked(postJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: createPaymentResult,\n        error: undefined\n      })\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      const payment = await service.createPayment(\n        100,\n        'Payment description',\n        returnUrl,\n        referenceNumber,\n        false,\n        metadata\n      )\n      expect(payment.paymentId).toBe('payment-id-12345')\n      expect(payment.paymentUrl).toBe('http://next-url-href/payment')\n    })\n\n    it('should throw if fails to create a payment - failed API call', async () => {\n      jest\n        .mocked(postJson)\n        .mockRejectedValueOnce(new Error('internal creation error'))\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      await expect(() =>\n        service.createPayment(\n          100,\n          'Payment description',\n          returnUrl,\n          referenceNumber,\n          false,\n          metadata\n        )\n      ).rejects.toThrow('internal creation error')\n    })\n\n    it('should throw if fails to create a payment - bad result from API call', async () => {\n      const createPaymentResult = {\n        state: {\n          status: 'failed'\n        }\n      }\n      jest.mocked(postJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: createPaymentResult,\n        error: undefined\n      })\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      await expect(() =>\n        service.createPayment(\n          100,\n          'Payment description',\n          returnUrl,\n          referenceNumber,\n          false,\n          metadata\n        )\n      ).rejects.toThrow('Failed to create payment')\n    })\n  })\n\n  describe('getPaymentStatus', () => {\n    it('should get payment status if exists', async () => {\n      const getPaymentStatusResult = {\n        payment_id: 'payment-id-12345',\n        _links: {\n          next_url: {\n            href: 'http://next-url-href/payment'\n          }\n        },\n        state: {\n          status: 'created'\n        }\n      }\n\n      jest.mocked(get).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: getPaymentStatusResult,\n        error: undefined\n      })\n\n      const paymentStatus = await service.getPaymentStatus(\n        'payment-id-12345',\n        false\n      )\n      expect(paymentStatus.paymentId).toBe('payment-id-12345')\n      expect(paymentStatus._links.next_url?.href).toBe(\n        'http://next-url-href/payment'\n      )\n    })\n\n    it('should handle payment status error', async () => {\n      jest.mocked(get).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: undefined,\n        error: new Error('some-error')\n      })\n\n      await expect(() =>\n        service.getPaymentStatus('payment-id-12345', false)\n      ).rejects.toThrow('Failed to get payment status: some-error')\n    })\n  })\n\n  describe('capturePayment', () => {\n    it('should return true when successful capture with statusCode 200', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(true)\n    })\n\n    it('should return true when successful capture with statusCode 204', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 204,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(true)\n    })\n\n    it('should return false when status code not 200 or 204', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 500,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(false)\n    })\n\n    it('should throw when internal error', async () => {\n      jest\n        .mocked(post)\n        .mockRejectedValueOnce(new Error('internal capture error'))\n\n      await expect(() =>\n        service.capturePayment('payment-id-12345', 100)\n      ).rejects.toThrow('internal capture error')\n    })\n  })\n})\n\n/**\n * @import  { IncomingMessage } from 'node:http'\n */\n"],"mappings":"AAAA,SAASA,cAAc;AACvB,SAASC,GAAG,EAAEC,IAAI,EAAEC,QAAQ;AAE5BC,IAAI,CAACC,IAAI,gCAAuC,CAAC;AAEjDC,QAAQ,CAAC,iBAAiB,EAAE,MAAM;EAChC,MAAMC,OAAO,GAAG,IAAIP,cAAc,CAAC,YAAY,CAAC;EAChDM,QAAQ,CAAC,aAAa,EAAE,MAAM;IAC5BE,EAAE,CAAC,wBAAwB,EAAE,MAAM;MACjCC,MAAM,CAACF,OAAO,CAAC,CAACG,WAAW,CAAC,CAAC;IAC/B,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFJ,QAAQ,CAAC,eAAe,EAAE,MAAM;IAC9BE,EAAE,CAAC,yBAAyB,EAAE,YAAY;MACxC,MAAMG,mBAAmB,GAAG;QAC1BC,UAAU,EAAE,kBAAkB;QAC9BC,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR;QACF,CAAC;QACDC,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MACDb,IAAI,CAACc,MAAM,CAACf,QAAQ,CAAC,CAACgB,qBAAqB,CAAC;QAC1CC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEZ,mBAAmB;QAC5Ba,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMC,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMC,OAAO,GAAG,MAAMxB,OAAO,CAACyB,aAAa,CACzC,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACf,KAAK,EACLE,QACF,CAAC;MACDnB,MAAM,CAACsB,OAAO,CAACE,SAAS,CAAC,CAACC,IAAI,CAAC,kBAAkB,CAAC;MAClDzB,MAAM,CAACsB,OAAO,CAACI,UAAU,CAAC,CAACD,IAAI,CAAC,8BAA8B,CAAC;IACjE,CAAC,CAAC;IAEF1B,EAAE,CAAC,6DAA6D,EAAE,YAAY;MAC5EJ,IAAI,CACDc,MAAM,CAACf,QAAQ,CAAC,CAChBiC,qBAAqB,CAAC,IAAIC,KAAK,CAAC,yBAAyB,CAAC,CAAC;MAE9D,MAAMX,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMrB,MAAM,CAAC,MACXF,OAAO,CAACyB,aAAa,CACnB,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACf,KAAK,EACLE,QACF,CACF,CAAC,CAACU,OAAO,CAACC,OAAO,CAAC,yBAAyB,CAAC;IAC9C,CAAC,CAAC;IAEF/B,EAAE,CAAC,sEAAsE,EAAE,YAAY;MACrF,MAAMG,mBAAmB,GAAG;QAC1BK,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MACDb,IAAI,CAACc,MAAM,CAACf,QAAQ,CAAC,CAACgB,qBAAqB,CAAC;QAC1CC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEZ,mBAAmB;QAC5Ba,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMC,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMrB,MAAM,CAAC,MACXF,OAAO,CAACyB,aAAa,CACnB,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACf,KAAK,EACLE,QACF,CACF,CAAC,CAACU,OAAO,CAACC,OAAO,CAAC,0BAA0B,CAAC;IAC/C,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFjC,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjCE,EAAE,CAAC,qCAAqC,EAAE,YAAY;MACpD,MAAMgC,sBAAsB,GAAG;QAC7B5B,UAAU,EAAE,kBAAkB;QAC9BC,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR;QACF,CAAC;QACDC,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MAEDb,IAAI,CAACc,MAAM,CAACjB,GAAG,CAAC,CAACkB,qBAAqB,CAAC;QACrCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEiB,sBAAsB;QAC/BhB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMgB,aAAa,GAAG,MAAMlC,OAAO,CAACmC,gBAAgB,CAClD,kBAAkB,EAClB,KACF,CAAC;MACDjC,MAAM,CAACgC,aAAa,CAACR,SAAS,CAAC,CAACC,IAAI,CAAC,kBAAkB,CAAC;MACxDzB,MAAM,CAACgC,aAAa,CAAC5B,MAAM,CAACC,QAAQ,EAAEC,IAAI,CAAC,CAACmB,IAAI,CAC9C,8BACF,CAAC;IACH,CAAC,CAAC;IAEF1B,EAAE,CAAC,oCAAoC,EAAE,YAAY;MACnDJ,IAAI,CAACc,MAAM,CAACjB,GAAG,CAAC,CAACkB,qBAAqB,CAAC;QACrCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEE,SAAS;QAClBD,KAAK,EAAE,IAAIa,KAAK,CAAC,YAAY;MAC/B,CAAC,CAAC;MAEF,MAAM5B,MAAM,CAAC,MACXF,OAAO,CAACmC,gBAAgB,CAAC,kBAAkB,EAAE,KAAK,CACpD,CAAC,CAACJ,OAAO,CAACC,OAAO,CAAC,0CAA0C,CAAC;IAC/D,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFjC,QAAQ,CAAC,gBAAgB,EAAE,MAAM;IAC/BE,EAAE,CAAC,gEAAgE,EAAE,YAAY;MAC/E,MAAMmC,oBAAoB,GAAG,CAAC,CAAC;MAC/BvC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEoB,oBAAoB;QAC7BnB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMmB,aAAa,GAAG,MAAMrC,OAAO,CAACsC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDpC,MAAM,CAACmC,aAAa,CAAC,CAACV,IAAI,CAAC,IAAI,CAAC;IAClC,CAAC,CAAC;IAEF1B,EAAE,CAAC,gEAAgE,EAAE,YAAY;MAC/E,MAAMmC,oBAAoB,GAAG,CAAC,CAAC;MAC/BvC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEoB,oBAAoB;QAC7BnB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMmB,aAAa,GAAG,MAAMrC,OAAO,CAACsC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDpC,MAAM,CAACmC,aAAa,CAAC,CAACV,IAAI,CAAC,IAAI,CAAC;IAClC,CAAC,CAAC;IAEF1B,EAAE,CAAC,qDAAqD,EAAE,YAAY;MACpE,MAAMmC,oBAAoB,GAAG,CAAC,CAAC;MAC/BvC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEoB,oBAAoB;QAC7BnB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMmB,aAAa,GAAG,MAAMrC,OAAO,CAACsC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDpC,MAAM,CAACmC,aAAa,CAAC,CAACV,IAAI,CAAC,KAAK,CAAC;IACnC,CAAC,CAAC;IAEF1B,EAAE,CAAC,kCAAkC,EAAE,YAAY;MACjDJ,IAAI,CACDc,MAAM,CAAChB,IAAI,CAAC,CACZkC,qBAAqB,CAAC,IAAIC,KAAK,CAAC,wBAAwB,CAAC,CAAC;MAE7D,MAAM5B,MAAM,CAAC,MACXF,OAAO,CAACsC,cAAc,CAAC,kBAAkB,EAAE,GAAG,CAChD,CAAC,CAACP,OAAO,CAACC,OAAO,CAAC,wBAAwB,CAAC;IAC7C,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"service.test.js","names":["PaymentService","get","post","postJson","jest","mock","describe","service","it","expect","toBeDefined","createPaymentResult","payment_id","_links","next_url","href","state","status","mocked","mockResolvedValueOnce","res","statusCode","headers","payload","error","undefined","referenceNumber","returnUrl","metadata","formId","slug","payment","createPayment","paymentId","toBe","paymentUrl","mockRejectedValueOnce","Error","toBeUndefined","getPaymentStatusResult","paymentStatus","getPaymentStatus","rejects","toThrow","capturePaymentResult","captureResult","capturePayment"],"sources":["../../../../src/server/plugins/payment/service.test.js"],"sourcesContent":["import { PaymentService } from '~/src/server/plugins/payment/service.js'\nimport { get, post, postJson } from '~/src/server/services/httpService.js'\n\njest.mock('~/src/server/services/httpService.ts')\n\ndescribe('payment service', () => {\n  const service = new PaymentService('my-api-key')\n  describe('constructor', () => {\n    it('should create instance', () => {\n      expect(service).toBeDefined()\n    })\n  })\n\n  describe('createPayment', () => {\n    it('should create a payment', async () => {\n      const createPaymentResult = {\n        payment_id: 'payment-id-12345',\n        _links: {\n          next_url: {\n            href: 'http://next-url-href/payment'\n          }\n        },\n        state: {\n          status: 'created'\n        }\n      }\n      jest.mocked(postJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: createPaymentResult,\n        error: undefined\n      })\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      const payment = await service.createPayment(\n        100,\n        'Payment description',\n        returnUrl,\n        referenceNumber,\n        false,\n        metadata\n      )\n      expect(payment?.paymentId).toBe('payment-id-12345')\n      expect(payment?.paymentUrl).toBe('http://next-url-href/payment')\n    })\n\n    it('should return undefined if fails to create a payment - failed API call', async () => {\n      jest\n        .mocked(postJson)\n        .mockRejectedValueOnce(new Error('internal creation error'))\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      const res = await service.createPayment(\n        100,\n        'Payment description',\n        returnUrl,\n        referenceNumber,\n        false,\n        metadata\n      )\n      expect(res).toBeUndefined()\n    })\n\n    it('should return undefined if fails to create a payment - bad result from API call', async () => {\n      const createPaymentResult = {\n        state: {\n          status: 'failed'\n        }\n      }\n      jest.mocked(postJson).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: createPaymentResult,\n        error: undefined\n      })\n\n      const referenceNumber = 'ABC-DEF-123'\n      const returnUrl = 'http://localhost:3009/payment-callback-handler'\n      const metadata = { formId: 'form-id', slug: 'my-form-slug' }\n      const res = await service.createPayment(\n        100,\n        'Payment description',\n        returnUrl,\n        referenceNumber,\n        false,\n        metadata\n      )\n      expect(res).toBeUndefined()\n    })\n  })\n\n  describe('getPaymentStatus', () => {\n    it('should get payment status if exists', async () => {\n      const getPaymentStatusResult = {\n        payment_id: 'payment-id-12345',\n        _links: {\n          next_url: {\n            href: 'http://next-url-href/payment'\n          }\n        },\n        state: {\n          status: 'created'\n        }\n      }\n\n      jest.mocked(get).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: getPaymentStatusResult,\n        error: undefined\n      })\n\n      const paymentStatus = await service.getPaymentStatus(\n        'payment-id-12345',\n        false\n      )\n      expect(paymentStatus.paymentId).toBe('payment-id-12345')\n      expect(paymentStatus._links.next_url?.href).toBe(\n        'http://next-url-href/payment'\n      )\n    })\n\n    it('should handle payment status error', async () => {\n      jest.mocked(get).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: undefined,\n        error: new Error('some-error')\n      })\n\n      await expect(() =>\n        service.getPaymentStatus('payment-id-12345', false)\n      ).rejects.toThrow('Failed to get payment status: some-error')\n    })\n  })\n\n  describe('capturePayment', () => {\n    it('should return true when successful capture with statusCode 200', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 200,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(true)\n    })\n\n    it('should return true when successful capture with statusCode 204', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 204,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(true)\n    })\n\n    it('should return false when status code not 200 or 204', async () => {\n      const capturePaymentResult = {}\n      jest.mocked(post).mockResolvedValueOnce({\n        res: /** @type {IncomingMessage} */ ({\n          statusCode: 500,\n          headers: {}\n        }),\n        payload: capturePaymentResult,\n        error: undefined\n      })\n\n      const captureResult = await service.capturePayment(\n        'payment-id-12345',\n        100\n      )\n      expect(captureResult).toBe(false)\n    })\n\n    it('should throw when internal error', async () => {\n      jest\n        .mocked(post)\n        .mockRejectedValueOnce(new Error('internal capture error'))\n\n      await expect(() =>\n        service.capturePayment('payment-id-12345', 100)\n      ).rejects.toThrow('internal capture error')\n    })\n  })\n})\n\n/**\n * @import  { IncomingMessage } from 'node:http'\n */\n"],"mappings":"AAAA,SAASA,cAAc;AACvB,SAASC,GAAG,EAAEC,IAAI,EAAEC,QAAQ;AAE5BC,IAAI,CAACC,IAAI,gCAAuC,CAAC;AAEjDC,QAAQ,CAAC,iBAAiB,EAAE,MAAM;EAChC,MAAMC,OAAO,GAAG,IAAIP,cAAc,CAAC,YAAY,CAAC;EAChDM,QAAQ,CAAC,aAAa,EAAE,MAAM;IAC5BE,EAAE,CAAC,wBAAwB,EAAE,MAAM;MACjCC,MAAM,CAACF,OAAO,CAAC,CAACG,WAAW,CAAC,CAAC;IAC/B,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFJ,QAAQ,CAAC,eAAe,EAAE,MAAM;IAC9BE,EAAE,CAAC,yBAAyB,EAAE,YAAY;MACxC,MAAMG,mBAAmB,GAAG;QAC1BC,UAAU,EAAE,kBAAkB;QAC9BC,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR;QACF,CAAC;QACDC,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MACDb,IAAI,CAACc,MAAM,CAACf,QAAQ,CAAC,CAACgB,qBAAqB,CAAC;QAC1CC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEZ,mBAAmB;QAC5Ba,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMC,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMC,OAAO,GAAG,MAAMxB,OAAO,CAACyB,aAAa,CACzC,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACf,KAAK,EACLE,QACF,CAAC;MACDnB,MAAM,CAACsB,OAAO,EAAEE,SAAS,CAAC,CAACC,IAAI,CAAC,kBAAkB,CAAC;MACnDzB,MAAM,CAACsB,OAAO,EAAEI,UAAU,CAAC,CAACD,IAAI,CAAC,8BAA8B,CAAC;IAClE,CAAC,CAAC;IAEF1B,EAAE,CAAC,wEAAwE,EAAE,YAAY;MACvFJ,IAAI,CACDc,MAAM,CAACf,QAAQ,CAAC,CAChBiC,qBAAqB,CAAC,IAAIC,KAAK,CAAC,yBAAyB,CAAC,CAAC;MAE9D,MAAMX,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMV,GAAG,GAAG,MAAMb,OAAO,CAACyB,aAAa,CACrC,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACf,KAAK,EACLE,QACF,CAAC;MACDnB,MAAM,CAACW,GAAG,CAAC,CAACkB,aAAa,CAAC,CAAC;IAC7B,CAAC,CAAC;IAEF9B,EAAE,CAAC,iFAAiF,EAAE,YAAY;MAChG,MAAMG,mBAAmB,GAAG;QAC1BK,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MACDb,IAAI,CAACc,MAAM,CAACf,QAAQ,CAAC,CAACgB,qBAAqB,CAAC;QAC1CC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEZ,mBAAmB;QAC5Ba,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMC,eAAe,GAAG,aAAa;MACrC,MAAMC,SAAS,GAAG,gDAAgD;MAClE,MAAMC,QAAQ,GAAG;QAAEC,MAAM,EAAE,SAAS;QAAEC,IAAI,EAAE;MAAe,CAAC;MAC5D,MAAMV,GAAG,GAAG,MAAMb,OAAO,CAACyB,aAAa,CACrC,GAAG,EACH,qBAAqB,EACrBL,SAAS,EACTD,eAAe,EACf,KAAK,EACLE,QACF,CAAC;MACDnB,MAAM,CAACW,GAAG,CAAC,CAACkB,aAAa,CAAC,CAAC;IAC7B,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFhC,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjCE,EAAE,CAAC,qCAAqC,EAAE,YAAY;MACpD,MAAM+B,sBAAsB,GAAG;QAC7B3B,UAAU,EAAE,kBAAkB;QAC9BC,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR;QACF,CAAC;QACDC,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MAEDb,IAAI,CAACc,MAAM,CAACjB,GAAG,CAAC,CAACkB,qBAAqB,CAAC;QACrCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEgB,sBAAsB;QAC/Bf,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMe,aAAa,GAAG,MAAMjC,OAAO,CAACkC,gBAAgB,CAClD,kBAAkB,EAClB,KACF,CAAC;MACDhC,MAAM,CAAC+B,aAAa,CAACP,SAAS,CAAC,CAACC,IAAI,CAAC,kBAAkB,CAAC;MACxDzB,MAAM,CAAC+B,aAAa,CAAC3B,MAAM,CAACC,QAAQ,EAAEC,IAAI,CAAC,CAACmB,IAAI,CAC9C,8BACF,CAAC;IACH,CAAC,CAAC;IAEF1B,EAAE,CAAC,oCAAoC,EAAE,YAAY;MACnDJ,IAAI,CAACc,MAAM,CAACjB,GAAG,CAAC,CAACkB,qBAAqB,CAAC;QACrCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEE,SAAS;QAClBD,KAAK,EAAE,IAAIa,KAAK,CAAC,YAAY;MAC/B,CAAC,CAAC;MAEF,MAAM5B,MAAM,CAAC,MACXF,OAAO,CAACkC,gBAAgB,CAAC,kBAAkB,EAAE,KAAK,CACpD,CAAC,CAACC,OAAO,CAACC,OAAO,CAAC,0CAA0C,CAAC;IAC/D,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFrC,QAAQ,CAAC,gBAAgB,EAAE,MAAM;IAC/BE,EAAE,CAAC,gEAAgE,EAAE,YAAY;MAC/E,MAAMoC,oBAAoB,GAAG,CAAC,CAAC;MAC/BxC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEqB,oBAAoB;QAC7BpB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMoB,aAAa,GAAG,MAAMtC,OAAO,CAACuC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDrC,MAAM,CAACoC,aAAa,CAAC,CAACX,IAAI,CAAC,IAAI,CAAC;IAClC,CAAC,CAAC;IAEF1B,EAAE,CAAC,gEAAgE,EAAE,YAAY;MAC/E,MAAMoC,oBAAoB,GAAG,CAAC,CAAC;MAC/BxC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEqB,oBAAoB;QAC7BpB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMoB,aAAa,GAAG,MAAMtC,OAAO,CAACuC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDrC,MAAM,CAACoC,aAAa,CAAC,CAACX,IAAI,CAAC,IAAI,CAAC;IAClC,CAAC,CAAC;IAEF1B,EAAE,CAAC,qDAAqD,EAAE,YAAY;MACpE,MAAMoC,oBAAoB,GAAG,CAAC,CAAC;MAC/BxC,IAAI,CAACc,MAAM,CAAChB,IAAI,CAAC,CAACiB,qBAAqB,CAAC;QACtCC,GAAG,GAAE,8BAAgC;UACnCC,UAAU,EAAE,GAAG;UACfC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACFC,OAAO,EAAEqB,oBAAoB;QAC7BpB,KAAK,EAAEC;MACT,CAAC,CAAC;MAEF,MAAMoB,aAAa,GAAG,MAAMtC,OAAO,CAACuC,cAAc,CAChD,kBAAkB,EAClB,GACF,CAAC;MACDrC,MAAM,CAACoC,aAAa,CAAC,CAACX,IAAI,CAAC,KAAK,CAAC;IACnC,CAAC,CAAC;IAEF1B,EAAE,CAAC,kCAAkC,EAAE,YAAY;MACjDJ,IAAI,CACDc,MAAM,CAAChB,IAAI,CAAC,CACZkC,qBAAqB,CAAC,IAAIC,KAAK,CAAC,wBAAwB,CAAC,CAAC;MAE7D,MAAM5B,MAAM,CAAC,MACXF,OAAO,CAACuC,cAAc,CAAC,kBAAkB,EAAE,GAAG,CAChD,CAAC,CAACJ,OAAO,CAACC,OAAO,CAAC,wBAAwB,CAAC;IAC7C,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}

package/.server/server/types.d.ts

@@ -11,6 +11,7 @@ export interface FormsService {
     getFormMetadata: (slug: string) => Promise<FormMetadata>;
     getFormMetadataById: (id: string) => Promise<FormMetadata>;
     getFormDefinition: (id: string, state: FormStatus) => Promise<FormDefinition | undefined>;
+    getFormSecret: (formId: string, secretName: string) => Promise<string>;
 }
 export interface FormSubmissionService {
     persistFiles: (files: {

package/.server/server/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { type Server } from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport { type PaymentService } from '~/src/server/plugins/payment/service.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormMetadataById: (id: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n  paymentService?: PaymentService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndExit?: PluginOptions['saveAndExit']\n  cacheServiceCreator?: (server: Server) => CacheService\n  ordnanceSurveyApiKey?: string\n  ordnanceSurveyApiSecret?: string\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../src/server/types.ts"],"sourcesContent":["import {\n  type FormDefinition,\n  type FormMetadata,\n  type SubmitPayload,\n  type SubmitResponsePayload\n} from '@defra/forms-model'\nimport { type Server } from '@hapi/hapi'\n\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport { type DetailItem } from '~/src/server/plugins/engine/models/types.js'\nimport { type PageController } from '~/src/server/plugins/engine/pageControllers/PageController.js'\nimport {\n  type FormContext,\n  type OnRequestCallback,\n  type PluginOptions,\n  type PreparePageEventRequestOptions\n} from '~/src/server/plugins/engine/types.js'\nimport { type PaymentService } from '~/src/server/plugins/payment/service.js'\nimport {\n  type FormRequestPayload,\n  type FormStatus\n} from '~/src/server/routes/types.js'\nimport { type CacheService } from '~/src/server/services/cacheService.js'\n\nexport interface FormsService {\n  getFormMetadata: (slug: string) => Promise<FormMetadata>\n  getFormMetadataById: (id: string) => Promise<FormMetadata>\n  getFormDefinition: (\n    id: string,\n    state: FormStatus\n  ) => Promise<FormDefinition | undefined>\n  getFormSecret: (formId: string, secretName: string) => Promise<string>\n}\n\nexport interface FormSubmissionService {\n  persistFiles: (\n    files: { fileId: string; initiatedRetrievalKey: string }[],\n    persistedRetrievalKey: string\n  ) => Promise<object>\n  submit: (data: SubmitPayload) => Promise<SubmitResponsePayload | undefined>\n}\n\nexport interface Services {\n  formsService: FormsService\n  formSubmissionService: FormSubmissionService\n  outputService: OutputService\n  paymentService?: PaymentService\n}\n\nexport interface RouteConfig {\n  formFileName?: string\n  formFilePath?: string\n  enforceCsrf?: boolean\n  services?: Services\n  controllers?: Record<string, typeof PageController>\n  preparePageEventRequestOptions?: PreparePageEventRequestOptions\n  onRequest?: OnRequestCallback\n  saveAndExit?: PluginOptions['saveAndExit']\n  cacheServiceCreator?: (server: Server) => CacheService\n  ordnanceSurveyApiKey?: string\n  ordnanceSurveyApiSecret?: string\n}\n\nexport interface OutputService {\n  submit: (\n    context: FormContext,\n    request: FormRequestPayload,\n    model: FormModel,\n    emailAddress: string,\n    items: DetailItem[],\n    submitResponse: SubmitResponsePayload,\n    formMetadata?: FormMetadata\n  ) => Promise<void>\n}\n"],"mappings":"","ignoreList":[]}

package/.server/server/utils/file-form-service.js

@@ -144,6 +144,16 @@ export class FileFormService {
        */
       getFormDefinition: id => {
         return Promise.resolve(this.getFormDefinition(id));
+      },
+      /**
+       * Get a form secret
+       * @param {string} _formId
+       * @param {string} _secretName
+       * @returns {Promise<string>}
+       */
+      getFormSecret: (_formId, _secretName) => {
+        // For local env only
+        return Promise.resolve(process.env.PAYMENT_PROVIDER_API_KEY_TEST ?? '');
       }
     };
   }

package/.server/server/utils/file-form-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"file-form-service.js","names":["fs","path","YAML","FileFormService","metadata","Map","definition","addForm","filepath","readForm","set","slug","id","ext","extname","toLowerCase","readJsonForm","readYamlForm","Error","JSON","parse","readFile","getFormMetadata","get","getFormMetadataById","Array","from","values","find","form","getFormDefinition","toFormsService","Promise","resolve"],"sources":["../../../src/server/utils/file-form-service.js"],"sourcesContent":["import fs from 'fs/promises'\nimport path from 'node:path'\n\nimport YAML from 'yaml'\n\n/**\n * FileFormService class\n */\nexport class FileFormService {\n  /**\n   * The map of form metadatas by slug\n   * @type {Map<string, FormMetadata>}\n   */\n  #metadata = new Map()\n\n  /**\n   * The map of form definitions by id\n   * @type {Map<string, FormDefinition>}\n   */\n  #definition = new Map()\n\n  /**\n   * Add form from a file\n   * @param {string} filepath - the file path\n   * @param {FormMetadata} metadata - the metadata to use for this form\n   * @returns {Promise<FormDefinition>}\n   */\n  async addForm(filepath, metadata) {\n    const definition = await this.readForm(filepath)\n\n    this.#metadata.set(metadata.slug, metadata)\n    this.#definition.set(metadata.id, definition)\n\n    return definition\n  }\n\n  /**\n   * Read the form definition from file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readForm(filepath) {\n    const ext = path.extname(filepath).toLowerCase()\n\n    switch (ext) {\n      case '.json':\n        return this.readJsonForm(filepath)\n      case '.yaml':\n        return this.readYamlForm(filepath)\n      default:\n        throw new Error(`Invalid file extension '${ext}'`)\n    }\n  }\n\n  /**\n   * Read the form definition from a json file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readJsonForm(filepath) {\n    /**\n     * @type {FormDefinition}\n     */\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const definition = JSON.parse(await fs.readFile(filepath, 'utf8'))\n\n    return definition\n  }\n\n  /**\n   * Read the form definition from a yaml file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readYamlForm(filepath) {\n    /**\n     * @type {FormDefinition}\n     */\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const definition = YAML.parse(await fs.readFile(filepath, 'utf8'))\n\n    return definition\n  }\n\n  /**\n   * Get the form metadata by slug\n   * @param {string} slug - the form slug\n   * @returns {FormMetadata}\n   */\n  getFormMetadata(slug) {\n    const metadata = this.#metadata.get(slug)\n\n    if (!metadata) {\n      throw new Error(`Form metadata '${slug}' not found`)\n    }\n\n    return metadata\n  }\n\n  /**\n   * Get the form metadata by form id\n   * @param {string} id - the form id\n   * @returns {FormMetadata}\n   */\n  getFormMetadataById(id) {\n    const metadata = Array.from(this.#metadata.values()).find(\n      (form) => form.id === id\n    )\n\n    if (!metadata) {\n      throw new Error(`Form metadata id '${id}' not found`)\n    }\n\n    return metadata\n  }\n\n  /**\n   * Get the form defintion by id\n   * @param {string} id - the form id\n   * @returns {FormDefinition}\n   */\n  getFormDefinition(id) {\n    const definition = this.#definition.get(id)\n\n    if (!definition) {\n      throw new Error(`Form definition '${id}' not found`)\n    }\n\n    return definition\n  }\n\n  /**\n   * Returns a FormsService compliant interface\n   * @returns {import('~/src/server/types.js').FormsService}\n   */\n  toFormsService() {\n    return {\n      /**\n       * Get the form metadata by slug\n       * @param {string} slug\n       * @returns {Promise<FormMetadata>}\n       */\n      getFormMetadata: (slug) => {\n        return Promise.resolve(this.getFormMetadata(slug))\n      },\n\n      /**\n       * Get the form metadata by form id\n       * @param {string} id\n       * @returns {Promise<FormMetadata>}\n       */\n      getFormMetadataById: (id) => {\n        return Promise.resolve(this.getFormMetadataById(id))\n      },\n\n      /**\n       * Get the form defintion by id\n       * @param {string} id\n       * @returns {Promise<FormDefinition>}\n       */\n      getFormDefinition: (id) => {\n        return Promise.resolve(this.getFormDefinition(id))\n      }\n    }\n  }\n}\n\n/**\n * @import { FormMetadata, FormDefinition, FormStatus } from '@defra/forms-model'\n */\n"],"mappings":"AAAA,OAAOA,EAAE,MAAM,aAAa;AAC5B,OAAOC,IAAI,MAAM,WAAW;AAE5B,OAAOC,IAAI,MAAM,MAAM;;AAEvB;AACA;AACA;AACA,OAAO,MAAMC,eAAe,CAAC;EAC3B;AACF;AACA;AACA;EACE,CAACC,QAAQ,GAAG,IAAIC,GAAG,CAAC,CAAC;;EAErB;AACF;AACA;AACA;EACE,CAACC,UAAU,GAAG,IAAID,GAAG,CAAC,CAAC;;EAEvB;AACF;AACA;AACA;AACA;AACA;EACE,MAAME,OAAOA,CAACC,QAAQ,EAAEJ,QAAQ,EAAE;IAChC,MAAME,UAAU,GAAG,MAAM,IAAI,CAACG,QAAQ,CAACD,QAAQ,CAAC;IAEhD,IAAI,CAAC,CAACJ,QAAQ,CAACM,GAAG,CAACN,QAAQ,CAACO,IAAI,EAAEP,QAAQ,CAAC;IAC3C,IAAI,CAAC,CAACE,UAAU,CAACI,GAAG,CAACN,QAAQ,CAACQ,EAAE,EAAEN,UAAU,CAAC;IAE7C,OAAOA,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMG,QAAQA,CAACD,QAAQ,EAAE;IACvB,MAAMK,GAAG,GAAGZ,IAAI,CAACa,OAAO,CAACN,QAAQ,CAAC,CAACO,WAAW,CAAC,CAAC;IAEhD,QAAQF,GAAG;MACT,KAAK,OAAO;QACV,OAAO,IAAI,CAACG,YAAY,CAACR,QAAQ,CAAC;MACpC,KAAK,OAAO;QACV,OAAO,IAAI,CAACS,YAAY,CAACT,QAAQ,CAAC;MACpC;QACE,MAAM,IAAIU,KAAK,CAAC,2BAA2BL,GAAG,GAAG,CAAC;IACtD;EACF;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMG,YAAYA,CAACR,QAAQ,EAAE;IAC3B;AACJ;AACA;IACI;IACA,MAAMF,UAAU,GAAGa,IAAI,CAACC,KAAK,CAAC,MAAMpB,EAAE,CAACqB,QAAQ,CAACb,QAAQ,EAAE,MAAM,CAAC,CAAC;IAElE,OAAOF,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMW,YAAYA,CAACT,QAAQ,EAAE;IAC3B;AACJ;AACA;IACI;IACA,MAAMF,UAAU,GAAGJ,IAAI,CAACkB,KAAK,CAAC,MAAMpB,EAAE,CAACqB,QAAQ,CAACb,QAAQ,EAAE,MAAM,CAAC,CAAC;IAElE,OAAOF,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACEgB,eAAeA,CAACX,IAAI,EAAE;IACpB,MAAMP,QAAQ,GAAG,IAAI,CAAC,CAACA,QAAQ,CAACmB,GAAG,CAACZ,IAAI,CAAC;IAEzC,IAAI,CAACP,QAAQ,EAAE;MACb,MAAM,IAAIc,KAAK,CAAC,kBAAkBP,IAAI,aAAa,CAAC;IACtD;IAEA,OAAOP,QAAQ;EACjB;;EAEA;AACF;AACA;AACA;AACA;EACEoB,mBAAmBA,CAACZ,EAAE,EAAE;IACtB,MAAMR,QAAQ,GAAGqB,KAAK,CAACC,IAAI,CAAC,IAAI,CAAC,CAACtB,QAAQ,CAACuB,MAAM,CAAC,CAAC,CAAC,CAACC,IAAI,CACtDC,IAAI,IAAKA,IAAI,CAACjB,EAAE,KAAKA,EACxB,CAAC;IAED,IAAI,CAACR,QAAQ,EAAE;MACb,MAAM,IAAIc,KAAK,CAAC,qBAAqBN,EAAE,aAAa,CAAC;IACvD;IAEA,OAAOR,QAAQ;EACjB;;EAEA;AACF;AACA;AACA;AACA;EACE0B,iBAAiBA,CAAClB,EAAE,EAAE;IACpB,MAAMN,UAAU,GAAG,IAAI,CAAC,CAACA,UAAU,CAACiB,GAAG,CAACX,EAAE,CAAC;IAE3C,IAAI,CAACN,UAAU,EAAE;MACf,MAAM,IAAIY,KAAK,CAAC,oBAAoBN,EAAE,aAAa,CAAC;IACtD;IAEA,OAAON,UAAU;EACnB;;EAEA;AACF;AACA;AACA;EACEyB,cAAcA,CAAA,EAAG;IACf,OAAO;MACL;AACN;AACA;AACA;AACA;MACMT,eAAe,EAAGX,IAAI,IAAK;QACzB,OAAOqB,OAAO,CAACC,OAAO,CAAC,IAAI,CAACX,eAAe,CAACX,IAAI,CAAC,CAAC;MACpD,CAAC;MAED;AACN;AACA;AACA;AACA;MACMa,mBAAmB,EAAGZ,EAAE,IAAK;QAC3B,OAAOoB,OAAO,CAACC,OAAO,CAAC,IAAI,CAACT,mBAAmB,CAACZ,EAAE,CAAC,CAAC;MACtD,CAAC;MAED;AACN;AACA;AACA;AACA;MACMkB,iBAAiB,EAAGlB,EAAE,IAAK;QACzB,OAAOoB,OAAO,CAACC,OAAO,CAAC,IAAI,CAACH,iBAAiB,CAAClB,EAAE,CAAC,CAAC;MACpD;IACF,CAAC;EACH;AACF;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"file-form-service.js","names":["fs","path","YAML","FileFormService","metadata","Map","definition","addForm","filepath","readForm","set","slug","id","ext","extname","toLowerCase","readJsonForm","readYamlForm","Error","JSON","parse","readFile","getFormMetadata","get","getFormMetadataById","Array","from","values","find","form","getFormDefinition","toFormsService","Promise","resolve","getFormSecret","_formId","_secretName","process","env","PAYMENT_PROVIDER_API_KEY_TEST"],"sources":["../../../src/server/utils/file-form-service.js"],"sourcesContent":["import fs from 'fs/promises'\nimport path from 'node:path'\n\nimport YAML from 'yaml'\n\n/**\n * FileFormService class\n */\nexport class FileFormService {\n  /**\n   * The map of form metadatas by slug\n   * @type {Map<string, FormMetadata>}\n   */\n  #metadata = new Map()\n\n  /**\n   * The map of form definitions by id\n   * @type {Map<string, FormDefinition>}\n   */\n  #definition = new Map()\n\n  /**\n   * Add form from a file\n   * @param {string} filepath - the file path\n   * @param {FormMetadata} metadata - the metadata to use for this form\n   * @returns {Promise<FormDefinition>}\n   */\n  async addForm(filepath, metadata) {\n    const definition = await this.readForm(filepath)\n\n    this.#metadata.set(metadata.slug, metadata)\n    this.#definition.set(metadata.id, definition)\n\n    return definition\n  }\n\n  /**\n   * Read the form definition from file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readForm(filepath) {\n    const ext = path.extname(filepath).toLowerCase()\n\n    switch (ext) {\n      case '.json':\n        return this.readJsonForm(filepath)\n      case '.yaml':\n        return this.readYamlForm(filepath)\n      default:\n        throw new Error(`Invalid file extension '${ext}'`)\n    }\n  }\n\n  /**\n   * Read the form definition from a json file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readJsonForm(filepath) {\n    /**\n     * @type {FormDefinition}\n     */\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const definition = JSON.parse(await fs.readFile(filepath, 'utf8'))\n\n    return definition\n  }\n\n  /**\n   * Read the form definition from a yaml file\n   * @param {string} filepath - the file path\n   * @returns {Promise<FormDefinition>}\n   */\n  async readYamlForm(filepath) {\n    /**\n     * @type {FormDefinition}\n     */\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    const definition = YAML.parse(await fs.readFile(filepath, 'utf8'))\n\n    return definition\n  }\n\n  /**\n   * Get the form metadata by slug\n   * @param {string} slug - the form slug\n   * @returns {FormMetadata}\n   */\n  getFormMetadata(slug) {\n    const metadata = this.#metadata.get(slug)\n\n    if (!metadata) {\n      throw new Error(`Form metadata '${slug}' not found`)\n    }\n\n    return metadata\n  }\n\n  /**\n   * Get the form metadata by form id\n   * @param {string} id - the form id\n   * @returns {FormMetadata}\n   */\n  getFormMetadataById(id) {\n    const metadata = Array.from(this.#metadata.values()).find(\n      (form) => form.id === id\n    )\n\n    if (!metadata) {\n      throw new Error(`Form metadata id '${id}' not found`)\n    }\n\n    return metadata\n  }\n\n  /**\n   * Get the form defintion by id\n   * @param {string} id - the form id\n   * @returns {FormDefinition}\n   */\n  getFormDefinition(id) {\n    const definition = this.#definition.get(id)\n\n    if (!definition) {\n      throw new Error(`Form definition '${id}' not found`)\n    }\n\n    return definition\n  }\n\n  /**\n   * Returns a FormsService compliant interface\n   * @returns {import('~/src/server/types.js').FormsService}\n   */\n  toFormsService() {\n    return {\n      /**\n       * Get the form metadata by slug\n       * @param {string} slug\n       * @returns {Promise<FormMetadata>}\n       */\n      getFormMetadata: (slug) => {\n        return Promise.resolve(this.getFormMetadata(slug))\n      },\n\n      /**\n       * Get the form metadata by form id\n       * @param {string} id\n       * @returns {Promise<FormMetadata>}\n       */\n      getFormMetadataById: (id) => {\n        return Promise.resolve(this.getFormMetadataById(id))\n      },\n\n      /**\n       * Get the form defintion by id\n       * @param {string} id\n       * @returns {Promise<FormDefinition>}\n       */\n      getFormDefinition: (id) => {\n        return Promise.resolve(this.getFormDefinition(id))\n      },\n\n      /**\n       * Get a form secret\n       * @param {string} _formId\n       * @param {string} _secretName\n       * @returns {Promise<string>}\n       */\n      getFormSecret: (_formId, _secretName) => {\n        // For local env only\n        return Promise.resolve(process.env.PAYMENT_PROVIDER_API_KEY_TEST ?? '')\n      }\n    }\n  }\n}\n\n/**\n * @import { FormMetadata, FormDefinition, FormStatus } from '@defra/forms-model'\n */\n"],"mappings":"AAAA,OAAOA,EAAE,MAAM,aAAa;AAC5B,OAAOC,IAAI,MAAM,WAAW;AAE5B,OAAOC,IAAI,MAAM,MAAM;;AAEvB;AACA;AACA;AACA,OAAO,MAAMC,eAAe,CAAC;EAC3B;AACF;AACA;AACA;EACE,CAACC,QAAQ,GAAG,IAAIC,GAAG,CAAC,CAAC;;EAErB;AACF;AACA;AACA;EACE,CAACC,UAAU,GAAG,IAAID,GAAG,CAAC,CAAC;;EAEvB;AACF;AACA;AACA;AACA;AACA;EACE,MAAME,OAAOA,CAACC,QAAQ,EAAEJ,QAAQ,EAAE;IAChC,MAAME,UAAU,GAAG,MAAM,IAAI,CAACG,QAAQ,CAACD,QAAQ,CAAC;IAEhD,IAAI,CAAC,CAACJ,QAAQ,CAACM,GAAG,CAACN,QAAQ,CAACO,IAAI,EAAEP,QAAQ,CAAC;IAC3C,IAAI,CAAC,CAACE,UAAU,CAACI,GAAG,CAACN,QAAQ,CAACQ,EAAE,EAAEN,UAAU,CAAC;IAE7C,OAAOA,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMG,QAAQA,CAACD,QAAQ,EAAE;IACvB,MAAMK,GAAG,GAAGZ,IAAI,CAACa,OAAO,CAACN,QAAQ,CAAC,CAACO,WAAW,CAAC,CAAC;IAEhD,QAAQF,GAAG;MACT,KAAK,OAAO;QACV,OAAO,IAAI,CAACG,YAAY,CAACR,QAAQ,CAAC;MACpC,KAAK,OAAO;QACV,OAAO,IAAI,CAACS,YAAY,CAACT,QAAQ,CAAC;MACpC;QACE,MAAM,IAAIU,KAAK,CAAC,2BAA2BL,GAAG,GAAG,CAAC;IACtD;EACF;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMG,YAAYA,CAACR,QAAQ,EAAE;IAC3B;AACJ;AACA;IACI;IACA,MAAMF,UAAU,GAAGa,IAAI,CAACC,KAAK,CAAC,MAAMpB,EAAE,CAACqB,QAAQ,CAACb,QAAQ,EAAE,MAAM,CAAC,CAAC;IAElE,OAAOF,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMW,YAAYA,CAACT,QAAQ,EAAE;IAC3B;AACJ;AACA;IACI;IACA,MAAMF,UAAU,GAAGJ,IAAI,CAACkB,KAAK,CAAC,MAAMpB,EAAE,CAACqB,QAAQ,CAACb,QAAQ,EAAE,MAAM,CAAC,CAAC;IAElE,OAAOF,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACEgB,eAAeA,CAACX,IAAI,EAAE;IACpB,MAAMP,QAAQ,GAAG,IAAI,CAAC,CAACA,QAAQ,CAACmB,GAAG,CAACZ,IAAI,CAAC;IAEzC,IAAI,CAACP,QAAQ,EAAE;MACb,MAAM,IAAIc,KAAK,CAAC,kBAAkBP,IAAI,aAAa,CAAC;IACtD;IAEA,OAAOP,QAAQ;EACjB;;EAEA;AACF;AACA;AACA;AACA;EACEoB,mBAAmBA,CAACZ,EAAE,EAAE;IACtB,MAAMR,QAAQ,GAAGqB,KAAK,CAACC,IAAI,CAAC,IAAI,CAAC,CAACtB,QAAQ,CAACuB,MAAM,CAAC,CAAC,CAAC,CAACC,IAAI,CACtDC,IAAI,IAAKA,IAAI,CAACjB,EAAE,KAAKA,EACxB,CAAC;IAED,IAAI,CAACR,QAAQ,EAAE;MACb,MAAM,IAAIc,KAAK,CAAC,qBAAqBN,EAAE,aAAa,CAAC;IACvD;IAEA,OAAOR,QAAQ;EACjB;;EAEA;AACF;AACA;AACA;AACA;EACE0B,iBAAiBA,CAAClB,EAAE,EAAE;IACpB,MAAMN,UAAU,GAAG,IAAI,CAAC,CAACA,UAAU,CAACiB,GAAG,CAACX,EAAE,CAAC;IAE3C,IAAI,CAACN,UAAU,EAAE;MACf,MAAM,IAAIY,KAAK,CAAC,oBAAoBN,EAAE,aAAa,CAAC;IACtD;IAEA,OAAON,UAAU;EACnB;;EAEA;AACF;AACA;AACA;EACEyB,cAAcA,CAAA,EAAG;IACf,OAAO;MACL;AACN;AACA;AACA;AACA;MACMT,eAAe,EAAGX,IAAI,IAAK;QACzB,OAAOqB,OAAO,CAACC,OAAO,CAAC,IAAI,CAACX,eAAe,CAACX,IAAI,CAAC,CAAC;MACpD,CAAC;MAED;AACN;AACA;AACA;AACA;MACMa,mBAAmB,EAAGZ,EAAE,IAAK;QAC3B,OAAOoB,OAAO,CAACC,OAAO,CAAC,IAAI,CAACT,mBAAmB,CAACZ,EAAE,CAAC,CAAC;MACtD,CAAC;MAED;AACN;AACA;AACA;AACA;MACMkB,iBAAiB,EAAGlB,EAAE,IAAK;QACzB,OAAOoB,OAAO,CAACC,OAAO,CAAC,IAAI,CAACH,iBAAiB,CAAClB,EAAE,CAAC,CAAC;MACpD,CAAC;MAED;AACN;AACA;AACA;AACA;AACA;MACMsB,aAAa,EAAEA,CAACC,OAAO,EAAEC,WAAW,KAAK;QACvC;QACA,OAAOJ,OAAO,CAACC,OAAO,CAACI,OAAO,CAACC,GAAG,CAACC,6BAA6B,IAAI,EAAE,CAAC;MACzE;IACF,CAAC;EACH;AACF;;AAEA;AACA;AACA","ignoreList":[]}

package/.server/server/utils/file-form-service.test.js

@@ -75,6 +75,11 @@ describe('File-form-service', () => {
       const res3 = await interfaceImpl.getFormDefinition('95e92559-968d-44ae-8666-2b1ad3dffd31', FormStatus.Draft);
       expect(res3?.name).toBe('All components');
       expect(res3?.startPage).toBe('/all-components');
+      const res4 = await interfaceImpl.getFormSecret('95e92559-968d-44ae-8666-2b1ad3dffd31', 'my-secret-name');
+      expect(res4).toBe('test-api-key');
+      delete process.env.PAYMENT_PROVIDER_API_KEY_TEST;
+      const res5 = await interfaceImpl.getFormSecret('95e92559-968d-44ae-8666-2b1ad3dffd31', 'my-secret-name');
+      expect(res5).toBe('');
     });
   });
   describe('readForm', () => {