@defra/forms-engine-plugin 4.9.1 → 4.9.2

package/.server/server/plugins/engine/components/PaymentField.js

@@ -179,16 +179,10 @@ export class PaymentField extends FormComponent {
     const slug = `/${model.basePath}`;
     const payCallbackUrl = `${baseUrl}/payment-callback?uuid=${uuid}`;
     const paymentPageUrl = args.sourceUrl;
-
-    // Prepopulate GOV.UK Pay email if emailField is configured.
-    // The referenced EmailAddressField validates with joi.string().email()
-    // at input time, so the value in state is already validated.
     let prefilledEmail;
-    if (options.emailField) {
-      const emailValue = state[options.emailField];
-      if (typeof emailValue === 'string' && emailValue) {
-        prefilledEmail = emailValue;
-      }
+    const userConfirmationEmail = state.userConfirmationEmailAddress;
+    if (typeof userConfirmationEmail === 'string' && userConfirmationEmail) {
+      prefilledEmail = userConfirmationEmail;
     }
     const amountInPence = Math.round(resolvedAmount * 100);
     const payment = await paymentService.createPayment(amountInPence, description, payCallbackUrl, reference, isLivePayment, {

package/.server/server/plugins/engine/components/PaymentField.js.map

@@ -1 +1 @@
-{"version":3,"file":"PaymentField.js","names":["randomUUID","StatusCodes","joi","createLogger","COMPONENT_STATE_ERROR","FormComponent","createError","getPluginOptions","PaymentErrorTypes","PaymentPreAuthError","PaymentSubmissionError","createPaymentService","formatCurrency","logger","PaymentField","isAppendageStateSingleObject","constructor","def","props","options","paymentStateSchema","object","paymentId","string","required","reference","amount","number","description","uuid","formId","isLivePayment","boolean","preAuth","status","valid","createdAt","isoDate","unknown","label","formSchema","stateSchema","getPaymentStateFromState","state","value","name","isPaymentState","undefined","getDisplayStringFromState","getViewModel","payload","errors","viewModel","paymentState","Array","isArray","isState","getFormValue","getContextValueFromState","getAllPossibleErrors","baseErrors","type","template","advancedSettingsErrors","resolveAmount","model","conditionalAmounts","length","condition","conditions","warn","fn","dispatcher","request","h","args","componentName","component","controller","getState","baseUrl","server","summaryUrl","basePath","existingPaymentState","redirect","code","SEE_OTHER","isLive","isPreview","formsService","services","paymentService","$$__referenceNumber","resolvedAmount","slug","payCallbackUrl","paymentPageUrl","sourceUrl","prefilledEmail","emailField","emailValue","amountInPence","Math","round","payment","createPayment","message","govukError","yar","flash","url","pathname","search","sessionData","returnUrl","failureUrl","set","paymentUrl","onSubmit","_metadata","context","PaymentIncomplete","capture","getPaymentStatus","checkPaymentAmount","markPaymentCaptured","PaymentExpired","captured","capturePayment","updatedState","Date","toISOString","page","currentState","mergeState"],"sources":["../../../../../src/server/plugins/engine/components/PaymentField.ts"],"sourcesContent":["import { randomUUID } from 'node:crypto'\n\nimport {\n  type FormMetadata,\n  type PaymentFieldComponent\n} from '@defra/forms-model'\nimport { StatusCodes } from 'http-status-codes'\nimport joi, { type ObjectSchema } from 'joi'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport { COMPONENT_STATE_ERROR } from '~/src/server/constants.js'\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js'\nimport {\n  createError,\n  getPluginOptions\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  PaymentErrorTypes,\n  PaymentPreAuthError,\n  PaymentSubmissionError\n} from '~/src/server/plugins/engine/pageControllers/errors.js'\nimport {\n  type FormContext,\n  type FormRequestPayload,\n  type FormResponseToolkit\n} from '~/src/server/plugins/engine/types/index.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type PaymentExternalArgs\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  createPaymentService,\n  formatCurrency\n} from '~/src/server/plugins/payment/helper.js'\n\nconst logger = createLogger()\n\nexport class PaymentField extends FormComponent {\n  declare options: PaymentFieldComponent['options']\n  declare formSchema: ObjectSchema\n  declare stateSchema: ObjectSchema\n  isAppendageStateSingleObject = true\n\n  constructor(\n    def: PaymentFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    this.options = def.options\n\n    const paymentStateSchema = joi\n      .object({\n        paymentId: joi.string().required(),\n        reference: joi.string().required(),\n        amount: joi.number().required(),\n        description: joi.string().required(),\n        uuid: joi.string().uuid().required(),\n        formId: joi.string().required(),\n        isLivePayment: joi.boolean().required(),\n        preAuth: joi\n          .object({\n            status: joi\n              .string()\n              .valid('success', 'failed', 'started')\n              .required(),\n            createdAt: joi.string().isoDate().required()\n          })\n          .required()\n      })\n      .unknown(true)\n      .label(this.label)\n\n    this.formSchema = paymentStateSchema\n    // 'required()' forces the payment page to be invalid until we have valid payment state\n    // i.e. the user will automatically be directed back to the payment page\n    // if they attempt to access future pages when no payment entered yet\n    this.stateSchema = paymentStateSchema.required()\n  }\n\n  /**\n   * Gets the PaymentState from form submission state\n   */\n  getPaymentStateFromState(\n    state: FormSubmissionState\n  ): PaymentState | undefined {\n    const value = state[this.name]\n    return this.isPaymentState(value) ? value : undefined\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState): string {\n    const value = this.getPaymentStateFromState(state)\n\n    if (!value) {\n      return ''\n    }\n\n    return `${formatCurrency(value.amount)} - ${value.description}`\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n\n    // Payload is pre-populated from state if a payment has already been made\n    const paymentState = this.isPaymentState(payload[this.name] as unknown)\n      ? (payload[this.name] as unknown as PaymentState)\n      : undefined\n\n    // Use payment state amount if pre-authorized, otherwise use default.\n    // The page controller overrides this with the resolved conditional amount\n    // using the full form state (which getViewModel doesn't have access to).\n    const amount = paymentState?.amount ?? this.options.amount\n\n    return {\n      ...viewModel,\n      amount: formatCurrency(amount),\n      description: this.options.description,\n      paymentState\n    }\n  }\n\n  /**\n   * Type guard to check if value is PaymentState\n   */\n  isPaymentState(value: unknown): value is PaymentState {\n    return PaymentField.isPaymentState(value)\n  }\n\n  /**\n   * Static type guard to check if value is PaymentState\n   */\n  static isPaymentState(value: unknown): value is PaymentState {\n    if (!value || typeof value !== 'object' || Array.isArray(value)) {\n      return false\n    }\n\n    const state = value as PaymentState\n    return (\n      typeof state.paymentId === 'string' &&\n      typeof state.amount === 'number' &&\n      typeof state.description === 'string'\n    )\n  }\n\n  /**\n   * Override base isState to validate PaymentState\n   */\n  isState(value?: FormStateValue | FormState): value is FormState {\n    return this.isPaymentState(value)\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isPaymentState(value)\n      ? (value as unknown as NonNullable<FormStateValue>)\n      : undefined\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    return this.isPaymentState(state)\n      ? `Reference: ${state.reference}\\nAmount: ${formatCurrency(state.amount)}`\n      : ''\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return PaymentField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        {\n          type: 'paymentRequired',\n          template: 'Complete the payment to continue'\n        }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n\n  /**\n   * Resolves the payment amount from conditional amounts configuration.\n   * Evaluates conditions in order; first true condition wins.\n   * Falls back to the default options.amount.\n   */\n  static resolveAmount(\n    options: PaymentFieldComponent['options'],\n    model: FormModel,\n    state: FormState\n  ): number {\n    const { conditionalAmounts } = options\n\n    if (!conditionalAmounts?.length) {\n      return options.amount\n    }\n\n    for (const { condition, amount } of conditionalAmounts) {\n      if (!model.conditions[condition]) {\n        logger.warn(\n          `[payment] Condition '${condition}' not found in form conditions. Skipping.`\n        )\n        continue\n      }\n      if (model.conditions[condition].fn(state)) {\n        return amount\n      }\n    }\n\n    return options.amount\n  }\n\n  /**\n   * Dispatcher for external redirect to GOV.UK Pay\n   */\n  static async dispatcher(\n    request: FormRequestPayload,\n    h: FormResponseToolkit,\n    args: PaymentExternalArgs\n  ): Promise<unknown> {\n    const { options, name: componentName } = args.component\n    const { model } = args.controller\n\n    const state = await args.controller.getState(request)\n    const { baseUrl } = getPluginOptions(request.server)\n    const summaryUrl = `${baseUrl}/${model.basePath}/summary`\n\n    const existingPaymentState = state[componentName]\n    if (\n      PaymentField.isPaymentState(existingPaymentState) &&\n      existingPaymentState.preAuth?.status === 'success'\n    ) {\n      return h.redirect(summaryUrl).code(StatusCodes.SEE_OTHER)\n    }\n\n    const isLivePayment = args.isLive && !args.isPreview\n    const formId = args.controller.model.formId\n    const formsService = model.services.formsService\n    const paymentService = await createPaymentService(\n      isLivePayment,\n      formId,\n      formsService\n    )\n\n    const uuid = randomUUID()\n\n    const reference = state.$$__referenceNumber as string\n    const resolvedAmount = PaymentField.resolveAmount(options, model, state)\n\n    // Zero-amount safety net (page skip should prevent this, but defensive)\n    if (resolvedAmount === 0) {\n      return h.redirect(summaryUrl).code(StatusCodes.SEE_OTHER)\n    }\n\n    const description = options.description\n\n    const slug = `/${model.basePath}`\n\n    const payCallbackUrl = `${baseUrl}/payment-callback?uuid=${uuid}`\n    const paymentPageUrl = args.sourceUrl\n\n    // Prepopulate GOV.UK Pay email if emailField is configured.\n    // The referenced EmailAddressField validates with joi.string().email()\n    // at input time, so the value in state is already validated.\n    let prefilledEmail: string | undefined\n    if (options.emailField) {\n      const emailValue = state[options.emailField]\n      if (typeof emailValue === 'string' && emailValue) {\n        prefilledEmail = emailValue\n      }\n    }\n\n    const amountInPence = Math.round(resolvedAmount * 100)\n    const payment = await paymentService.createPayment(\n      amountInPence,\n      description,\n      payCallbackUrl,\n      reference,\n      isLivePayment,\n      { formId, slug },\n      prefilledEmail\n    )\n\n    if (!payment) {\n      const message = isLivePayment\n        ? 'There is a problem and we cannot take a payment. Contact us (details in the footer of this form) or save your progress and return to the form later.'\n        : 'Add a valid test API key before you can preview the payment journey.'\n      const govukError = createError(componentName, message)\n      request.yar.flash(COMPONENT_STATE_ERROR, govukError, true)\n      return h\n        .redirect(`${request.url.pathname}${request.url.search}`)\n        .code(StatusCodes.SEE_OTHER)\n    }\n\n    const sessionData: PaymentSessionData = {\n      uuid,\n      formId,\n      reference,\n      amount: resolvedAmount,\n      description,\n      paymentId: payment.paymentId,\n      componentName,\n      returnUrl: summaryUrl,\n      failureUrl: paymentPageUrl,\n      isLivePayment\n    }\n\n    request.yar.set(`payment-${uuid}`, sessionData)\n\n    return h.redirect(payment.paymentUrl).code(StatusCodes.SEE_OTHER)\n  }\n\n  /**\n   * Called on form submission to capture the payment\n   * @see https://docs.payments.service.gov.uk/delayed_capture/#delay-taking-a-payment\n   */\n  async onSubmit(\n    request: FormRequestPayload,\n    _metadata: FormMetadata,\n    context: FormContext\n  ): Promise<void> {\n    // Zero-amount bypass — no capture needed\n    const resolvedAmount = PaymentField.resolveAmount(\n      this.options,\n      this.model,\n      context.state\n    )\n    if (resolvedAmount === 0) {\n      return\n    }\n\n    const paymentState = this.getPaymentStateFromState(context.state)\n\n    if (!paymentState) {\n      throw new PaymentPreAuthError(\n        this,\n        'Complete the payment to continue',\n        true,\n        PaymentErrorTypes.PaymentIncomplete\n      )\n    }\n\n    if (paymentState.capture?.status === 'success') {\n      return\n    }\n\n    const { paymentId, isLivePayment, formId } = paymentState\n    const formsService = this.model.services.formsService\n    const paymentService = await createPaymentService(\n      isLivePayment,\n      formId,\n      formsService\n    )\n\n    /**\n     * @see https://docs.payments.service.gov.uk/api_reference/#payment-status-lifecycle\n     */\n    const status = await paymentService.getPaymentStatus(\n      paymentId,\n      isLivePayment\n    )\n\n    PaymentSubmissionError.checkPaymentAmount(\n      status.amount,\n      resolvedAmount,\n      this\n    )\n\n    if (status.state.status === 'success') {\n      await this.markPaymentCaptured(request, paymentState)\n      return\n    }\n\n    if (status.state.status !== 'capturable') {\n      throw new PaymentPreAuthError(\n        this,\n        'Your payment authorisation has expired. Please add your payment details again.',\n        true,\n        PaymentErrorTypes.PaymentExpired\n      )\n    }\n\n    const captured = await paymentService.capturePayment(\n      paymentId,\n      status.amount\n    )\n\n    if (!captured) {\n      throw new PaymentPreAuthError(\n        this,\n        'There was a problem and your form was not submitted. Try submitting the form again.',\n        false\n      )\n    }\n\n    await this.markPaymentCaptured(request, paymentState)\n  }\n\n  /**\n   * Updates payment state to mark capture as successful\n   * This ensures we don't try to re-capture on submission retry\n   */\n  private async markPaymentCaptured(\n    request: FormRequestPayload,\n    paymentState: PaymentState\n  ): Promise<void> {\n    const updatedState: PaymentState = {\n      ...paymentState,\n      capture: {\n        status: 'success',\n        createdAt: new Date().toISOString()\n      }\n    }\n\n    if (this.page) {\n      const currentState = await this.page.getState(request)\n      await this.page.mergeState(request, currentState, {\n        [this.name]: updatedState\n      })\n    }\n  }\n}\n\n/**\n * Session data stored when dispatching to GOV.UK Pay\n */\nexport interface PaymentSessionData {\n  uuid: string\n  formId: string\n  reference: string\n  amount: number\n  description: string\n  paymentId: string\n  componentName: string\n  returnUrl: string\n  failureUrl: string\n  isLivePayment: boolean\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,aAAa;AAMxC,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,OAAOC,GAAG,MAA6B,KAAK;AAE5C,SAASC,YAAY;AACrB,SAASC,qBAAqB;AAC9B,SAASC,aAAa;AAEtB,SACEC,WAAW,EACXC,gBAAgB;AAGlB,SACEC,iBAAiB,EACjBC,mBAAmB,EACnBC,sBAAsB;AAgBxB,SACEC,oBAAoB,EACpBC,cAAc;AAGhB,MAAMC,MAAM,GAAGV,YAAY,CAAC,CAAC;AAE7B,OAAO,MAAMW,YAAY,SAAST,aAAa,CAAC;EAI9CU,4BAA4B,GAAG,IAAI;EAEnCC,WAAWA,CACTC,GAA0B,EAC1BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,IAAI,CAACC,OAAO,GAAGF,GAAG,CAACE,OAAO;IAE1B,MAAMC,kBAAkB,GAAGlB,GAAG,CAC3BmB,MAAM,CAAC;MACNC,SAAS,EAAEpB,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAClCC,SAAS,EAAEvB,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAClCE,MAAM,EAAExB,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;MAC/BI,WAAW,EAAE1B,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MACpCK,IAAI,EAAE3B,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACM,IAAI,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;MACpCM,MAAM,EAAE5B,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAC/BO,aAAa,EAAE7B,GAAG,CAAC8B,OAAO,CAAC,CAAC,CAACR,QAAQ,CAAC,CAAC;MACvCS,OAAO,EAAE/B,GAAG,CACTmB,MAAM,CAAC;QACNa,MAAM,EAAEhC,GAAG,CACRqB,MAAM,CAAC,CAAC,CACRY,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CACrCX,QAAQ,CAAC,CAAC;QACbY,SAAS,EAAElC,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACc,OAAO,CAAC,CAAC,CAACb,QAAQ,CAAC;MAC7C,CAAC,CAAC,CACDA,QAAQ,CAAC;IACd,CAAC,CAAC,CACDc,OAAO,CAAC,IAAI,CAAC,CACbC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC;IAEpB,IAAI,CAACC,UAAU,GAAGpB,kBAAkB;IACpC;IACA;IACA;IACA,IAAI,CAACqB,WAAW,GAAGrB,kBAAkB,CAACI,QAAQ,CAAC,CAAC;EAClD;;EAEA;AACF;AACA;EACEkB,wBAAwBA,CACtBC,KAA0B,EACA;IAC1B,MAAMC,KAAK,GAAGD,KAAK,CAAC,IAAI,CAACE,IAAI,CAAC;IAC9B,OAAO,IAAI,CAACC,cAAc,CAACF,KAAK,CAAC,GAAGA,KAAK,GAAGG,SAAS;EACvD;EAEAC,yBAAyBA,CAACL,KAA0B,EAAU;IAC5D,MAAMC,KAAK,GAAG,IAAI,CAACF,wBAAwB,CAACC,KAAK,CAAC;IAElD,IAAI,CAACC,KAAK,EAAE;MACV,OAAO,EAAE;IACX;IAEA,OAAO,GAAGhC,cAAc,CAACgC,KAAK,CAAClB,MAAM,CAAC,MAAMkB,KAAK,CAAChB,WAAW,EAAE;EACjE;EAEAqB,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;;IAErD;IACA,MAAME,YAAY,GAAG,IAAI,CAACP,cAAc,CAACI,OAAO,CAAC,IAAI,CAACL,IAAI,CAAY,CAAC,GAClEK,OAAO,CAAC,IAAI,CAACL,IAAI,CAAC,GACnBE,SAAS;;IAEb;IACA;IACA;IACA,MAAMrB,MAAM,GAAG2B,YAAY,EAAE3B,MAAM,IAAI,IAAI,CAACP,OAAO,CAACO,MAAM;IAE1D,OAAO;MACL,GAAG0B,SAAS;MACZ1B,MAAM,EAAEd,cAAc,CAACc,MAAM,CAAC;MAC9BE,WAAW,EAAE,IAAI,CAACT,OAAO,CAACS,WAAW;MACrCyB;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACEP,cAAcA,CAACF,KAAc,EAAyB;IACpD,OAAO9B,YAAY,CAACgC,cAAc,CAACF,KAAK,CAAC;EAC3C;;EAEA;AACF;AACA;EACE,OAAOE,cAAcA,CAACF,KAAc,EAAyB;IAC3D,IAAI,CAACA,KAAK,IAAI,OAAOA,KAAK,KAAK,QAAQ,IAAIU,KAAK,CAACC,OAAO,CAACX,KAAK,CAAC,EAAE;MAC/D,OAAO,KAAK;IACd;IAEA,MAAMD,KAAK,GAAGC,KAAqB;IACnC,OACE,OAAOD,KAAK,CAACrB,SAAS,KAAK,QAAQ,IACnC,OAAOqB,KAAK,CAACjB,MAAM,KAAK,QAAQ,IAChC,OAAOiB,KAAK,CAACf,WAAW,KAAK,QAAQ;EAEzC;;EAEA;AACF;AACA;EACE4B,OAAOA,CAACZ,KAAkC,EAAsB;IAC9D,OAAO,IAAI,CAACE,cAAc,CAACF,KAAK,CAAC;EACnC;EAEAa,YAAYA,CAACb,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACE,cAAc,CAACF,KAAK,CAAC,GAC5BA,KAAK,GACNG,SAAS;EACf;EAEAW,wBAAwBA,CAACf,KAA0B,EAAE;IACnD,OAAO,IAAI,CAACG,cAAc,CAACH,KAAK,CAAC,GAC7B,cAAcA,KAAK,CAAClB,SAAS,aAAab,cAAc,CAAC+B,KAAK,CAACjB,MAAM,CAAC,EAAE,GACxE,EAAE;EACR;;EAEA;AACF;AACA;EACEiC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO7C,YAAY,CAAC6C,oBAAoB,CAAC,CAAC;EAC5C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QACEC,IAAI,EAAE,iBAAiB;QACvBC,QAAQ,EAAE;MACZ,CAAC,CACF;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;EACE,OAAOC,aAAaA,CAClB7C,OAAyC,EACzC8C,KAAgB,EAChBtB,KAAgB,EACR;IACR,MAAM;MAAEuB;IAAmB,CAAC,GAAG/C,OAAO;IAEtC,IAAI,CAAC+C,kBAAkB,EAAEC,MAAM,EAAE;MAC/B,OAAOhD,OAAO,CAACO,MAAM;IACvB;IAEA,KAAK,MAAM;MAAE0C,SAAS;MAAE1C;IAAO,CAAC,IAAIwC,kBAAkB,EAAE;MACtD,IAAI,CAACD,KAAK,CAACI,UAAU,CAACD,SAAS,CAAC,EAAE;QAChCvD,MAAM,CAACyD,IAAI,CACT,wBAAwBF,SAAS,2CACnC,CAAC;QACD;MACF;MACA,IAAIH,KAAK,CAACI,UAAU,CAACD,SAAS,CAAC,CAACG,EAAE,CAAC5B,KAAK,CAAC,EAAE;QACzC,OAAOjB,MAAM;MACf;IACF;IAEA,OAAOP,OAAO,CAACO,MAAM;EACvB;;EAEA;AACF;AACA;EACE,aAAa8C,UAAUA,CACrBC,OAA2B,EAC3BC,CAAsB,EACtBC,IAAyB,EACP;IAClB,MAAM;MAAExD,OAAO;MAAE0B,IAAI,EAAE+B;IAAc,CAAC,GAAGD,IAAI,CAACE,SAAS;IACvD,MAAM;MAAEZ;IAAM,CAAC,GAAGU,IAAI,CAACG,UAAU;IAEjC,MAAMnC,KAAK,GAAG,MAAMgC,IAAI,CAACG,UAAU,CAACC,QAAQ,CAACN,OAAO,CAAC;IACrD,MAAM;MAAEO;IAAQ,CAAC,GAAGzE,gBAAgB,CAACkE,OAAO,CAACQ,MAAM,CAAC;IACpD,MAAMC,UAAU,GAAG,GAAGF,OAAO,IAAIf,KAAK,CAACkB,QAAQ,UAAU;IAEzD,MAAMC,oBAAoB,GAAGzC,KAAK,CAACiC,aAAa,CAAC;IACjD,IACE9D,YAAY,CAACgC,cAAc,CAACsC,oBAAoB,CAAC,IACjDA,oBAAoB,CAACnD,OAAO,EAAEC,MAAM,KAAK,SAAS,EAClD;MACA,OAAOwC,CAAC,CAACW,QAAQ,CAACH,UAAU,CAAC,CAACI,IAAI,CAACrF,WAAW,CAACsF,SAAS,CAAC;IAC3D;IAEA,MAAMxD,aAAa,GAAG4C,IAAI,CAACa,MAAM,IAAI,CAACb,IAAI,CAACc,SAAS;IACpD,MAAM3D,MAAM,GAAG6C,IAAI,CAACG,UAAU,CAACb,KAAK,CAACnC,MAAM;IAC3C,MAAM4D,YAAY,GAAGzB,KAAK,CAAC0B,QAAQ,CAACD,YAAY;IAChD,MAAME,cAAc,GAAG,MAAMjF,oBAAoB,CAC/CoB,aAAa,EACbD,MAAM,EACN4D,YACF,CAAC;IAED,MAAM7D,IAAI,GAAG7B,UAAU,CAAC,CAAC;IAEzB,MAAMyB,SAAS,GAAGkB,KAAK,CAACkD,mBAA6B;IACrD,MAAMC,cAAc,GAAGhF,YAAY,CAACkD,aAAa,CAAC7C,OAAO,EAAE8C,KAAK,EAAEtB,KAAK,CAAC;;IAExE;IACA,IAAImD,cAAc,KAAK,CAAC,EAAE;MACxB,OAAOpB,CAAC,CAACW,QAAQ,CAACH,UAAU,CAAC,CAACI,IAAI,CAACrF,WAAW,CAACsF,SAAS,CAAC;IAC3D;IAEA,MAAM3D,WAAW,GAAGT,OAAO,CAACS,WAAW;IAEvC,MAAMmE,IAAI,GAAG,IAAI9B,KAAK,CAACkB,QAAQ,EAAE;IAEjC,MAAMa,cAAc,GAAG,GAAGhB,OAAO,0BAA0BnD,IAAI,EAAE;IACjE,MAAMoE,cAAc,GAAGtB,IAAI,CAACuB,SAAS;;IAErC;IACA;IACA;IACA,IAAIC,cAAkC;IACtC,IAAIhF,OAAO,CAACiF,UAAU,EAAE;MACtB,MAAMC,UAAU,GAAG1D,KAAK,CAACxB,OAAO,CAACiF,UAAU,CAAC;MAC5C,IAAI,OAAOC,UAAU,KAAK,QAAQ,IAAIA,UAAU,EAAE;QAChDF,cAAc,GAAGE,UAAU;MAC7B;IACF;IAEA,MAAMC,aAAa,GAAGC,IAAI,CAACC,KAAK,CAACV,cAAc,GAAG,GAAG,CAAC;IACtD,MAAMW,OAAO,GAAG,MAAMb,cAAc,CAACc,aAAa,CAChDJ,aAAa,EACb1E,WAAW,EACXoE,cAAc,EACdvE,SAAS,EACTM,aAAa,EACb;MAAED,MAAM;MAAEiE;IAAK,CAAC,EAChBI,cACF,CAAC;IAED,IAAI,CAACM,OAAO,EAAE;MACZ,MAAME,OAAO,GAAG5E,aAAa,GACzB,sJAAsJ,GACtJ,sEAAsE;MAC1E,MAAM6E,UAAU,GAAGtG,WAAW,CAACsE,aAAa,EAAE+B,OAAO,CAAC;MACtDlC,OAAO,CAACoC,GAAG,CAACC,KAAK,CAAC1G,qBAAqB,EAAEwG,UAAU,EAAE,IAAI,CAAC;MAC1D,OAAOlC,CAAC,CACLW,QAAQ,CAAC,GAAGZ,OAAO,CAACsC,GAAG,CAACC,QAAQ,GAAGvC,OAAO,CAACsC,GAAG,CAACE,MAAM,EAAE,CAAC,CACxD3B,IAAI,CAACrF,WAAW,CAACsF,SAAS,CAAC;IAChC;IAEA,MAAM2B,WAA+B,GAAG;MACtCrF,IAAI;MACJC,MAAM;MACNL,SAAS;MACTC,MAAM,EAAEoE,cAAc;MACtBlE,WAAW;MACXN,SAAS,EAAEmF,OAAO,CAACnF,SAAS;MAC5BsD,aAAa;MACbuC,SAAS,EAAEjC,UAAU;MACrBkC,UAAU,EAAEnB,cAAc;MAC1BlE;IACF,CAAC;IAED0C,OAAO,CAACoC,GAAG,CAACQ,GAAG,CAAC,WAAWxF,IAAI,EAAE,EAAEqF,WAAW,CAAC;IAE/C,OAAOxC,CAAC,CAACW,QAAQ,CAACoB,OAAO,CAACa,UAAU,CAAC,CAAChC,IAAI,CAACrF,WAAW,CAACsF,SAAS,CAAC;EACnE;;EAEA;AACF;AACA;AACA;EACE,MAAMgC,QAAQA,CACZ9C,OAA2B,EAC3B+C,SAAuB,EACvBC,OAAoB,EACL;IACf;IACA,MAAM3B,cAAc,GAAGhF,YAAY,CAACkD,aAAa,CAC/C,IAAI,CAAC7C,OAAO,EACZ,IAAI,CAAC8C,KAAK,EACVwD,OAAO,CAAC9E,KACV,CAAC;IACD,IAAImD,cAAc,KAAK,CAAC,EAAE;MACxB;IACF;IAEA,MAAMzC,YAAY,GAAG,IAAI,CAACX,wBAAwB,CAAC+E,OAAO,CAAC9E,KAAK,CAAC;IAEjE,IAAI,CAACU,YAAY,EAAE;MACjB,MAAM,IAAI5C,mBAAmB,CAC3B,IAAI,EACJ,kCAAkC,EAClC,IAAI,EACJD,iBAAiB,CAACkH,iBACpB,CAAC;IACH;IAEA,IAAIrE,YAAY,CAACsE,OAAO,EAAEzF,MAAM,KAAK,SAAS,EAAE;MAC9C;IACF;IAEA,MAAM;MAAEZ,SAAS;MAAES,aAAa;MAAED;IAAO,CAAC,GAAGuB,YAAY;IACzD,MAAMqC,YAAY,GAAG,IAAI,CAACzB,KAAK,CAAC0B,QAAQ,CAACD,YAAY;IACrD,MAAME,cAAc,GAAG,MAAMjF,oBAAoB,CAC/CoB,aAAa,EACbD,MAAM,EACN4D,YACF,CAAC;;IAED;AACJ;AACA;IACI,MAAMxD,MAAM,GAAG,MAAM0D,cAAc,CAACgC,gBAAgB,CAClDtG,SAAS,EACTS,aACF,CAAC;IAEDrB,sBAAsB,CAACmH,kBAAkB,CACvC3F,MAAM,CAACR,MAAM,EACboE,cAAc,EACd,IACF,CAAC;IAED,IAAI5D,MAAM,CAACS,KAAK,CAACT,MAAM,KAAK,SAAS,EAAE;MACrC,MAAM,IAAI,CAAC4F,mBAAmB,CAACrD,OAAO,EAAEpB,YAAY,CAAC;MACrD;IACF;IAEA,IAAInB,MAAM,CAACS,KAAK,CAACT,MAAM,KAAK,YAAY,EAAE;MACxC,MAAM,IAAIzB,mBAAmB,CAC3B,IAAI,EACJ,gFAAgF,EAChF,IAAI,EACJD,iBAAiB,CAACuH,cACpB,CAAC;IACH;IAEA,MAAMC,QAAQ,GAAG,MAAMpC,cAAc,CAACqC,cAAc,CAClD3G,SAAS,EACTY,MAAM,CAACR,MACT,CAAC;IAED,IAAI,CAACsG,QAAQ,EAAE;MACb,MAAM,IAAIvH,mBAAmB,CAC3B,IAAI,EACJ,qFAAqF,EACrF,KACF,CAAC;IACH;IAEA,MAAM,IAAI,CAACqH,mBAAmB,CAACrD,OAAO,EAAEpB,YAAY,CAAC;EACvD;;EAEA;AACF;AACA;AACA;EACE,MAAcyE,mBAAmBA,CAC/BrD,OAA2B,EAC3BpB,YAA0B,EACX;IACf,MAAM6E,YAA0B,GAAG;MACjC,GAAG7E,YAAY;MACfsE,OAAO,EAAE;QACPzF,MAAM,EAAE,SAAS;QACjBE,SAAS,EAAE,IAAI+F,IAAI,CAAC,CAAC,CAACC,WAAW,CAAC;MACpC;IACF,CAAC;IAED,IAAI,IAAI,CAACC,IAAI,EAAE;MACb,MAAMC,YAAY,GAAG,MAAM,IAAI,CAACD,IAAI,CAACtD,QAAQ,CAACN,OAAO,CAAC;MACtD,MAAM,IAAI,CAAC4D,IAAI,CAACE,UAAU,CAAC9D,OAAO,EAAE6D,YAAY,EAAE;QAChD,CAAC,IAAI,CAACzF,IAAI,GAAGqF;MACf,CAAC,CAAC;IACJ;EACF;AACF;;AAEA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"PaymentField.js","names":["randomUUID","StatusCodes","joi","createLogger","COMPONENT_STATE_ERROR","FormComponent","createError","getPluginOptions","PaymentErrorTypes","PaymentPreAuthError","PaymentSubmissionError","createPaymentService","formatCurrency","logger","PaymentField","isAppendageStateSingleObject","constructor","def","props","options","paymentStateSchema","object","paymentId","string","required","reference","amount","number","description","uuid","formId","isLivePayment","boolean","preAuth","status","valid","createdAt","isoDate","unknown","label","formSchema","stateSchema","getPaymentStateFromState","state","value","name","isPaymentState","undefined","getDisplayStringFromState","getViewModel","payload","errors","viewModel","paymentState","Array","isArray","isState","getFormValue","getContextValueFromState","getAllPossibleErrors","baseErrors","type","template","advancedSettingsErrors","resolveAmount","model","conditionalAmounts","length","condition","conditions","warn","fn","dispatcher","request","h","args","componentName","component","controller","getState","baseUrl","server","summaryUrl","basePath","existingPaymentState","redirect","code","SEE_OTHER","isLive","isPreview","formsService","services","paymentService","$$__referenceNumber","resolvedAmount","slug","payCallbackUrl","paymentPageUrl","sourceUrl","prefilledEmail","userConfirmationEmail","userConfirmationEmailAddress","amountInPence","Math","round","payment","createPayment","message","govukError","yar","flash","url","pathname","search","sessionData","returnUrl","failureUrl","set","paymentUrl","onSubmit","_metadata","context","PaymentIncomplete","capture","getPaymentStatus","checkPaymentAmount","markPaymentCaptured","PaymentExpired","captured","capturePayment","updatedState","Date","toISOString","page","currentState","mergeState"],"sources":["../../../../../src/server/plugins/engine/components/PaymentField.ts"],"sourcesContent":["import { randomUUID } from 'node:crypto'\n\nimport {\n  type FormMetadata,\n  type PaymentFieldComponent\n} from '@defra/forms-model'\nimport { StatusCodes } from 'http-status-codes'\nimport joi, { type ObjectSchema } from 'joi'\n\nimport { createLogger } from '~/src/server/common/helpers/logging/logger.js'\nimport { COMPONENT_STATE_ERROR } from '~/src/server/constants.js'\nimport { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'\nimport { type PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js'\nimport {\n  createError,\n  getPluginOptions\n} from '~/src/server/plugins/engine/helpers.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  PaymentErrorTypes,\n  PaymentPreAuthError,\n  PaymentSubmissionError\n} from '~/src/server/plugins/engine/pageControllers/errors.js'\nimport {\n  type FormContext,\n  type FormRequestPayload,\n  type FormResponseToolkit\n} from '~/src/server/plugins/engine/types/index.js'\nimport {\n  type ErrorMessageTemplateList,\n  type FormPayload,\n  type FormState,\n  type FormStateValue,\n  type FormSubmissionError,\n  type FormSubmissionState,\n  type PaymentExternalArgs\n} from '~/src/server/plugins/engine/types.js'\nimport {\n  createPaymentService,\n  formatCurrency\n} from '~/src/server/plugins/payment/helper.js'\n\nconst logger = createLogger()\n\nexport class PaymentField extends FormComponent {\n  declare options: PaymentFieldComponent['options']\n  declare formSchema: ObjectSchema\n  declare stateSchema: ObjectSchema\n  isAppendageStateSingleObject = true\n\n  constructor(\n    def: PaymentFieldComponent,\n    props: ConstructorParameters<typeof FormComponent>[1]\n  ) {\n    super(def, props)\n\n    this.options = def.options\n\n    const paymentStateSchema = joi\n      .object({\n        paymentId: joi.string().required(),\n        reference: joi.string().required(),\n        amount: joi.number().required(),\n        description: joi.string().required(),\n        uuid: joi.string().uuid().required(),\n        formId: joi.string().required(),\n        isLivePayment: joi.boolean().required(),\n        preAuth: joi\n          .object({\n            status: joi\n              .string()\n              .valid('success', 'failed', 'started')\n              .required(),\n            createdAt: joi.string().isoDate().required()\n          })\n          .required()\n      })\n      .unknown(true)\n      .label(this.label)\n\n    this.formSchema = paymentStateSchema\n    // 'required()' forces the payment page to be invalid until we have valid payment state\n    // i.e. the user will automatically be directed back to the payment page\n    // if they attempt to access future pages when no payment entered yet\n    this.stateSchema = paymentStateSchema.required()\n  }\n\n  /**\n   * Gets the PaymentState from form submission state\n   */\n  getPaymentStateFromState(\n    state: FormSubmissionState\n  ): PaymentState | undefined {\n    const value = state[this.name]\n    return this.isPaymentState(value) ? value : undefined\n  }\n\n  getDisplayStringFromState(state: FormSubmissionState): string {\n    const value = this.getPaymentStateFromState(state)\n\n    if (!value) {\n      return ''\n    }\n\n    return `${formatCurrency(value.amount)} - ${value.description}`\n  }\n\n  getViewModel(payload: FormPayload, errors?: FormSubmissionError[]) {\n    const viewModel = super.getViewModel(payload, errors)\n\n    // Payload is pre-populated from state if a payment has already been made\n    const paymentState = this.isPaymentState(payload[this.name] as unknown)\n      ? (payload[this.name] as unknown as PaymentState)\n      : undefined\n\n    // Use payment state amount if pre-authorized, otherwise use default.\n    // The page controller overrides this with the resolved conditional amount\n    // using the full form state (which getViewModel doesn't have access to).\n    const amount = paymentState?.amount ?? this.options.amount\n\n    return {\n      ...viewModel,\n      amount: formatCurrency(amount),\n      description: this.options.description,\n      paymentState\n    }\n  }\n\n  /**\n   * Type guard to check if value is PaymentState\n   */\n  isPaymentState(value: unknown): value is PaymentState {\n    return PaymentField.isPaymentState(value)\n  }\n\n  /**\n   * Static type guard to check if value is PaymentState\n   */\n  static isPaymentState(value: unknown): value is PaymentState {\n    if (!value || typeof value !== 'object' || Array.isArray(value)) {\n      return false\n    }\n\n    const state = value as PaymentState\n    return (\n      typeof state.paymentId === 'string' &&\n      typeof state.amount === 'number' &&\n      typeof state.description === 'string'\n    )\n  }\n\n  /**\n   * Override base isState to validate PaymentState\n   */\n  isState(value?: FormStateValue | FormState): value is FormState {\n    return this.isPaymentState(value)\n  }\n\n  getFormValue(value?: FormStateValue | FormState) {\n    return this.isPaymentState(value)\n      ? (value as unknown as NonNullable<FormStateValue>)\n      : undefined\n  }\n\n  getContextValueFromState(state: FormSubmissionState) {\n    return this.isPaymentState(state)\n      ? `Reference: ${state.reference}\\nAmount: ${formatCurrency(state.amount)}`\n      : ''\n  }\n\n  /**\n   * For error preview page that shows all possible errors on a component\n   */\n  getAllPossibleErrors(): ErrorMessageTemplateList {\n    return PaymentField.getAllPossibleErrors()\n  }\n\n  /**\n   * Static version of getAllPossibleErrors that doesn't require a component instance.\n   */\n  static getAllPossibleErrors(): ErrorMessageTemplateList {\n    return {\n      baseErrors: [\n        {\n          type: 'paymentRequired',\n          template: 'Complete the payment to continue'\n        }\n      ],\n      advancedSettingsErrors: []\n    }\n  }\n\n  /**\n   * Resolves the payment amount from conditional amounts configuration.\n   * Evaluates conditions in order; first true condition wins.\n   * Falls back to the default options.amount.\n   */\n  static resolveAmount(\n    options: PaymentFieldComponent['options'],\n    model: FormModel,\n    state: FormState\n  ): number {\n    const { conditionalAmounts } = options\n\n    if (!conditionalAmounts?.length) {\n      return options.amount\n    }\n\n    for (const { condition, amount } of conditionalAmounts) {\n      if (!model.conditions[condition]) {\n        logger.warn(\n          `[payment] Condition '${condition}' not found in form conditions. Skipping.`\n        )\n        continue\n      }\n      if (model.conditions[condition].fn(state)) {\n        return amount\n      }\n    }\n\n    return options.amount\n  }\n\n  /**\n   * Dispatcher for external redirect to GOV.UK Pay\n   */\n  static async dispatcher(\n    request: FormRequestPayload,\n    h: FormResponseToolkit,\n    args: PaymentExternalArgs\n  ): Promise<unknown> {\n    const { options, name: componentName } = args.component\n    const { model } = args.controller\n\n    const state = await args.controller.getState(request)\n    const { baseUrl } = getPluginOptions(request.server)\n    const summaryUrl = `${baseUrl}/${model.basePath}/summary`\n\n    const existingPaymentState = state[componentName]\n    if (\n      PaymentField.isPaymentState(existingPaymentState) &&\n      existingPaymentState.preAuth?.status === 'success'\n    ) {\n      return h.redirect(summaryUrl).code(StatusCodes.SEE_OTHER)\n    }\n\n    const isLivePayment = args.isLive && !args.isPreview\n    const formId = args.controller.model.formId\n    const formsService = model.services.formsService\n    const paymentService = await createPaymentService(\n      isLivePayment,\n      formId,\n      formsService\n    )\n\n    const uuid = randomUUID()\n\n    const reference = state.$$__referenceNumber as string\n    const resolvedAmount = PaymentField.resolveAmount(options, model, state)\n\n    // Zero-amount safety net (page skip should prevent this, but defensive)\n    if (resolvedAmount === 0) {\n      return h.redirect(summaryUrl).code(StatusCodes.SEE_OTHER)\n    }\n\n    const description = options.description\n\n    const slug = `/${model.basePath}`\n\n    const payCallbackUrl = `${baseUrl}/payment-callback?uuid=${uuid}`\n    const paymentPageUrl = args.sourceUrl\n\n    let prefilledEmail: string | undefined\n    const userConfirmationEmail = state.userConfirmationEmailAddress\n    if (typeof userConfirmationEmail === 'string' && userConfirmationEmail) {\n      prefilledEmail = userConfirmationEmail\n    }\n\n    const amountInPence = Math.round(resolvedAmount * 100)\n    const payment = await paymentService.createPayment(\n      amountInPence,\n      description,\n      payCallbackUrl,\n      reference,\n      isLivePayment,\n      { formId, slug },\n      prefilledEmail\n    )\n\n    if (!payment) {\n      const message = isLivePayment\n        ? 'There is a problem and we cannot take a payment. Contact us (details in the footer of this form) or save your progress and return to the form later.'\n        : 'Add a valid test API key before you can preview the payment journey.'\n      const govukError = createError(componentName, message)\n      request.yar.flash(COMPONENT_STATE_ERROR, govukError, true)\n      return h\n        .redirect(`${request.url.pathname}${request.url.search}`)\n        .code(StatusCodes.SEE_OTHER)\n    }\n\n    const sessionData: PaymentSessionData = {\n      uuid,\n      formId,\n      reference,\n      amount: resolvedAmount,\n      description,\n      paymentId: payment.paymentId,\n      componentName,\n      returnUrl: summaryUrl,\n      failureUrl: paymentPageUrl,\n      isLivePayment\n    }\n\n    request.yar.set(`payment-${uuid}`, sessionData)\n\n    return h.redirect(payment.paymentUrl).code(StatusCodes.SEE_OTHER)\n  }\n\n  /**\n   * Called on form submission to capture the payment\n   * @see https://docs.payments.service.gov.uk/delayed_capture/#delay-taking-a-payment\n   */\n  async onSubmit(\n    request: FormRequestPayload,\n    _metadata: FormMetadata,\n    context: FormContext\n  ): Promise<void> {\n    // Zero-amount bypass — no capture needed\n    const resolvedAmount = PaymentField.resolveAmount(\n      this.options,\n      this.model,\n      context.state\n    )\n    if (resolvedAmount === 0) {\n      return\n    }\n\n    const paymentState = this.getPaymentStateFromState(context.state)\n\n    if (!paymentState) {\n      throw new PaymentPreAuthError(\n        this,\n        'Complete the payment to continue',\n        true,\n        PaymentErrorTypes.PaymentIncomplete\n      )\n    }\n\n    if (paymentState.capture?.status === 'success') {\n      return\n    }\n\n    const { paymentId, isLivePayment, formId } = paymentState\n    const formsService = this.model.services.formsService\n    const paymentService = await createPaymentService(\n      isLivePayment,\n      formId,\n      formsService\n    )\n\n    /**\n     * @see https://docs.payments.service.gov.uk/api_reference/#payment-status-lifecycle\n     */\n    const status = await paymentService.getPaymentStatus(\n      paymentId,\n      isLivePayment\n    )\n\n    PaymentSubmissionError.checkPaymentAmount(\n      status.amount,\n      resolvedAmount,\n      this\n    )\n\n    if (status.state.status === 'success') {\n      await this.markPaymentCaptured(request, paymentState)\n      return\n    }\n\n    if (status.state.status !== 'capturable') {\n      throw new PaymentPreAuthError(\n        this,\n        'Your payment authorisation has expired. Please add your payment details again.',\n        true,\n        PaymentErrorTypes.PaymentExpired\n      )\n    }\n\n    const captured = await paymentService.capturePayment(\n      paymentId,\n      status.amount\n    )\n\n    if (!captured) {\n      throw new PaymentPreAuthError(\n        this,\n        'There was a problem and your form was not submitted. Try submitting the form again.',\n        false\n      )\n    }\n\n    await this.markPaymentCaptured(request, paymentState)\n  }\n\n  /**\n   * Updates payment state to mark capture as successful\n   * This ensures we don't try to re-capture on submission retry\n   */\n  private async markPaymentCaptured(\n    request: FormRequestPayload,\n    paymentState: PaymentState\n  ): Promise<void> {\n    const updatedState: PaymentState = {\n      ...paymentState,\n      capture: {\n        status: 'success',\n        createdAt: new Date().toISOString()\n      }\n    }\n\n    if (this.page) {\n      const currentState = await this.page.getState(request)\n      await this.page.mergeState(request, currentState, {\n        [this.name]: updatedState\n      })\n    }\n  }\n}\n\n/**\n * Session data stored when dispatching to GOV.UK Pay\n */\nexport interface PaymentSessionData {\n  uuid: string\n  formId: string\n  reference: string\n  amount: number\n  description: string\n  paymentId: string\n  componentName: string\n  returnUrl: string\n  failureUrl: string\n  isLivePayment: boolean\n}\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,aAAa;AAMxC,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,OAAOC,GAAG,MAA6B,KAAK;AAE5C,SAASC,YAAY;AACrB,SAASC,qBAAqB;AAC9B,SAASC,aAAa;AAEtB,SACEC,WAAW,EACXC,gBAAgB;AAGlB,SACEC,iBAAiB,EACjBC,mBAAmB,EACnBC,sBAAsB;AAgBxB,SACEC,oBAAoB,EACpBC,cAAc;AAGhB,MAAMC,MAAM,GAAGV,YAAY,CAAC,CAAC;AAE7B,OAAO,MAAMW,YAAY,SAAST,aAAa,CAAC;EAI9CU,4BAA4B,GAAG,IAAI;EAEnCC,WAAWA,CACTC,GAA0B,EAC1BC,KAAqD,EACrD;IACA,KAAK,CAACD,GAAG,EAAEC,KAAK,CAAC;IAEjB,IAAI,CAACC,OAAO,GAAGF,GAAG,CAACE,OAAO;IAE1B,MAAMC,kBAAkB,GAAGlB,GAAG,CAC3BmB,MAAM,CAAC;MACNC,SAAS,EAAEpB,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAClCC,SAAS,EAAEvB,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAClCE,MAAM,EAAExB,GAAG,CAACyB,MAAM,CAAC,CAAC,CAACH,QAAQ,CAAC,CAAC;MAC/BI,WAAW,EAAE1B,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MACpCK,IAAI,EAAE3B,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACM,IAAI,CAAC,CAAC,CAACL,QAAQ,CAAC,CAAC;MACpCM,MAAM,EAAE5B,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;MAC/BO,aAAa,EAAE7B,GAAG,CAAC8B,OAAO,CAAC,CAAC,CAACR,QAAQ,CAAC,CAAC;MACvCS,OAAO,EAAE/B,GAAG,CACTmB,MAAM,CAAC;QACNa,MAAM,EAAEhC,GAAG,CACRqB,MAAM,CAAC,CAAC,CACRY,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CACrCX,QAAQ,CAAC,CAAC;QACbY,SAAS,EAAElC,GAAG,CAACqB,MAAM,CAAC,CAAC,CAACc,OAAO,CAAC,CAAC,CAACb,QAAQ,CAAC;MAC7C,CAAC,CAAC,CACDA,QAAQ,CAAC;IACd,CAAC,CAAC,CACDc,OAAO,CAAC,IAAI,CAAC,CACbC,KAAK,CAAC,IAAI,CAACA,KAAK,CAAC;IAEpB,IAAI,CAACC,UAAU,GAAGpB,kBAAkB;IACpC;IACA;IACA;IACA,IAAI,CAACqB,WAAW,GAAGrB,kBAAkB,CAACI,QAAQ,CAAC,CAAC;EAClD;;EAEA;AACF;AACA;EACEkB,wBAAwBA,CACtBC,KAA0B,EACA;IAC1B,MAAMC,KAAK,GAAGD,KAAK,CAAC,IAAI,CAACE,IAAI,CAAC;IAC9B,OAAO,IAAI,CAACC,cAAc,CAACF,KAAK,CAAC,GAAGA,KAAK,GAAGG,SAAS;EACvD;EAEAC,yBAAyBA,CAACL,KAA0B,EAAU;IAC5D,MAAMC,KAAK,GAAG,IAAI,CAACF,wBAAwB,CAACC,KAAK,CAAC;IAElD,IAAI,CAACC,KAAK,EAAE;MACV,OAAO,EAAE;IACX;IAEA,OAAO,GAAGhC,cAAc,CAACgC,KAAK,CAAClB,MAAM,CAAC,MAAMkB,KAAK,CAAChB,WAAW,EAAE;EACjE;EAEAqB,YAAYA,CAACC,OAAoB,EAAEC,MAA8B,EAAE;IACjE,MAAMC,SAAS,GAAG,KAAK,CAACH,YAAY,CAACC,OAAO,EAAEC,MAAM,CAAC;;IAErD;IACA,MAAME,YAAY,GAAG,IAAI,CAACP,cAAc,CAACI,OAAO,CAAC,IAAI,CAACL,IAAI,CAAY,CAAC,GAClEK,OAAO,CAAC,IAAI,CAACL,IAAI,CAAC,GACnBE,SAAS;;IAEb;IACA;IACA;IACA,MAAMrB,MAAM,GAAG2B,YAAY,EAAE3B,MAAM,IAAI,IAAI,CAACP,OAAO,CAACO,MAAM;IAE1D,OAAO;MACL,GAAG0B,SAAS;MACZ1B,MAAM,EAAEd,cAAc,CAACc,MAAM,CAAC;MAC9BE,WAAW,EAAE,IAAI,CAACT,OAAO,CAACS,WAAW;MACrCyB;IACF,CAAC;EACH;;EAEA;AACF;AACA;EACEP,cAAcA,CAACF,KAAc,EAAyB;IACpD,OAAO9B,YAAY,CAACgC,cAAc,CAACF,KAAK,CAAC;EAC3C;;EAEA;AACF;AACA;EACE,OAAOE,cAAcA,CAACF,KAAc,EAAyB;IAC3D,IAAI,CAACA,KAAK,IAAI,OAAOA,KAAK,KAAK,QAAQ,IAAIU,KAAK,CAACC,OAAO,CAACX,KAAK,CAAC,EAAE;MAC/D,OAAO,KAAK;IACd;IAEA,MAAMD,KAAK,GAAGC,KAAqB;IACnC,OACE,OAAOD,KAAK,CAACrB,SAAS,KAAK,QAAQ,IACnC,OAAOqB,KAAK,CAACjB,MAAM,KAAK,QAAQ,IAChC,OAAOiB,KAAK,CAACf,WAAW,KAAK,QAAQ;EAEzC;;EAEA;AACF;AACA;EACE4B,OAAOA,CAACZ,KAAkC,EAAsB;IAC9D,OAAO,IAAI,CAACE,cAAc,CAACF,KAAK,CAAC;EACnC;EAEAa,YAAYA,CAACb,KAAkC,EAAE;IAC/C,OAAO,IAAI,CAACE,cAAc,CAACF,KAAK,CAAC,GAC5BA,KAAK,GACNG,SAAS;EACf;EAEAW,wBAAwBA,CAACf,KAA0B,EAAE;IACnD,OAAO,IAAI,CAACG,cAAc,CAACH,KAAK,CAAC,GAC7B,cAAcA,KAAK,CAAClB,SAAS,aAAab,cAAc,CAAC+B,KAAK,CAACjB,MAAM,CAAC,EAAE,GACxE,EAAE;EACR;;EAEA;AACF;AACA;EACEiC,oBAAoBA,CAAA,EAA6B;IAC/C,OAAO7C,YAAY,CAAC6C,oBAAoB,CAAC,CAAC;EAC5C;;EAEA;AACF;AACA;EACE,OAAOA,oBAAoBA,CAAA,EAA6B;IACtD,OAAO;MACLC,UAAU,EAAE,CACV;QACEC,IAAI,EAAE,iBAAiB;QACvBC,QAAQ,EAAE;MACZ,CAAC,CACF;MACDC,sBAAsB,EAAE;IAC1B,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;EACE,OAAOC,aAAaA,CAClB7C,OAAyC,EACzC8C,KAAgB,EAChBtB,KAAgB,EACR;IACR,MAAM;MAAEuB;IAAmB,CAAC,GAAG/C,OAAO;IAEtC,IAAI,CAAC+C,kBAAkB,EAAEC,MAAM,EAAE;MAC/B,OAAOhD,OAAO,CAACO,MAAM;IACvB;IAEA,KAAK,MAAM;MAAE0C,SAAS;MAAE1C;IAAO,CAAC,IAAIwC,kBAAkB,EAAE;MACtD,IAAI,CAACD,KAAK,CAACI,UAAU,CAACD,SAAS,CAAC,EAAE;QAChCvD,MAAM,CAACyD,IAAI,CACT,wBAAwBF,SAAS,2CACnC,CAAC;QACD;MACF;MACA,IAAIH,KAAK,CAACI,UAAU,CAACD,SAAS,CAAC,CAACG,EAAE,CAAC5B,KAAK,CAAC,EAAE;QACzC,OAAOjB,MAAM;MACf;IACF;IAEA,OAAOP,OAAO,CAACO,MAAM;EACvB;;EAEA;AACF;AACA;EACE,aAAa8C,UAAUA,CACrBC,OAA2B,EAC3BC,CAAsB,EACtBC,IAAyB,EACP;IAClB,MAAM;MAAExD,OAAO;MAAE0B,IAAI,EAAE+B;IAAc,CAAC,GAAGD,IAAI,CAACE,SAAS;IACvD,MAAM;MAAEZ;IAAM,CAAC,GAAGU,IAAI,CAACG,UAAU;IAEjC,MAAMnC,KAAK,GAAG,MAAMgC,IAAI,CAACG,UAAU,CAACC,QAAQ,CAACN,OAAO,CAAC;IACrD,MAAM;MAAEO;IAAQ,CAAC,GAAGzE,gBAAgB,CAACkE,OAAO,CAACQ,MAAM,CAAC;IACpD,MAAMC,UAAU,GAAG,GAAGF,OAAO,IAAIf,KAAK,CAACkB,QAAQ,UAAU;IAEzD,MAAMC,oBAAoB,GAAGzC,KAAK,CAACiC,aAAa,CAAC;IACjD,IACE9D,YAAY,CAACgC,cAAc,CAACsC,oBAAoB,CAAC,IACjDA,oBAAoB,CAACnD,OAAO,EAAEC,MAAM,KAAK,SAAS,EAClD;MACA,OAAOwC,CAAC,CAACW,QAAQ,CAACH,UAAU,CAAC,CAACI,IAAI,CAACrF,WAAW,CAACsF,SAAS,CAAC;IAC3D;IAEA,MAAMxD,aAAa,GAAG4C,IAAI,CAACa,MAAM,IAAI,CAACb,IAAI,CAACc,SAAS;IACpD,MAAM3D,MAAM,GAAG6C,IAAI,CAACG,UAAU,CAACb,KAAK,CAACnC,MAAM;IAC3C,MAAM4D,YAAY,GAAGzB,KAAK,CAAC0B,QAAQ,CAACD,YAAY;IAChD,MAAME,cAAc,GAAG,MAAMjF,oBAAoB,CAC/CoB,aAAa,EACbD,MAAM,EACN4D,YACF,CAAC;IAED,MAAM7D,IAAI,GAAG7B,UAAU,CAAC,CAAC;IAEzB,MAAMyB,SAAS,GAAGkB,KAAK,CAACkD,mBAA6B;IACrD,MAAMC,cAAc,GAAGhF,YAAY,CAACkD,aAAa,CAAC7C,OAAO,EAAE8C,KAAK,EAAEtB,KAAK,CAAC;;IAExE;IACA,IAAImD,cAAc,KAAK,CAAC,EAAE;MACxB,OAAOpB,CAAC,CAACW,QAAQ,CAACH,UAAU,CAAC,CAACI,IAAI,CAACrF,WAAW,CAACsF,SAAS,CAAC;IAC3D;IAEA,MAAM3D,WAAW,GAAGT,OAAO,CAACS,WAAW;IAEvC,MAAMmE,IAAI,GAAG,IAAI9B,KAAK,CAACkB,QAAQ,EAAE;IAEjC,MAAMa,cAAc,GAAG,GAAGhB,OAAO,0BAA0BnD,IAAI,EAAE;IACjE,MAAMoE,cAAc,GAAGtB,IAAI,CAACuB,SAAS;IAErC,IAAIC,cAAkC;IACtC,MAAMC,qBAAqB,GAAGzD,KAAK,CAAC0D,4BAA4B;IAChE,IAAI,OAAOD,qBAAqB,KAAK,QAAQ,IAAIA,qBAAqB,EAAE;MACtED,cAAc,GAAGC,qBAAqB;IACxC;IAEA,MAAME,aAAa,GAAGC,IAAI,CAACC,KAAK,CAACV,cAAc,GAAG,GAAG,CAAC;IACtD,MAAMW,OAAO,GAAG,MAAMb,cAAc,CAACc,aAAa,CAChDJ,aAAa,EACb1E,WAAW,EACXoE,cAAc,EACdvE,SAAS,EACTM,aAAa,EACb;MAAED,MAAM;MAAEiE;IAAK,CAAC,EAChBI,cACF,CAAC;IAED,IAAI,CAACM,OAAO,EAAE;MACZ,MAAME,OAAO,GAAG5E,aAAa,GACzB,sJAAsJ,GACtJ,sEAAsE;MAC1E,MAAM6E,UAAU,GAAGtG,WAAW,CAACsE,aAAa,EAAE+B,OAAO,CAAC;MACtDlC,OAAO,CAACoC,GAAG,CAACC,KAAK,CAAC1G,qBAAqB,EAAEwG,UAAU,EAAE,IAAI,CAAC;MAC1D,OAAOlC,CAAC,CACLW,QAAQ,CAAC,GAAGZ,OAAO,CAACsC,GAAG,CAACC,QAAQ,GAAGvC,OAAO,CAACsC,GAAG,CAACE,MAAM,EAAE,CAAC,CACxD3B,IAAI,CAACrF,WAAW,CAACsF,SAAS,CAAC;IAChC;IAEA,MAAM2B,WAA+B,GAAG;MACtCrF,IAAI;MACJC,MAAM;MACNL,SAAS;MACTC,MAAM,EAAEoE,cAAc;MACtBlE,WAAW;MACXN,SAAS,EAAEmF,OAAO,CAACnF,SAAS;MAC5BsD,aAAa;MACbuC,SAAS,EAAEjC,UAAU;MACrBkC,UAAU,EAAEnB,cAAc;MAC1BlE;IACF,CAAC;IAED0C,OAAO,CAACoC,GAAG,CAACQ,GAAG,CAAC,WAAWxF,IAAI,EAAE,EAAEqF,WAAW,CAAC;IAE/C,OAAOxC,CAAC,CAACW,QAAQ,CAACoB,OAAO,CAACa,UAAU,CAAC,CAAChC,IAAI,CAACrF,WAAW,CAACsF,SAAS,CAAC;EACnE;;EAEA;AACF;AACA;AACA;EACE,MAAMgC,QAAQA,CACZ9C,OAA2B,EAC3B+C,SAAuB,EACvBC,OAAoB,EACL;IACf;IACA,MAAM3B,cAAc,GAAGhF,YAAY,CAACkD,aAAa,CAC/C,IAAI,CAAC7C,OAAO,EACZ,IAAI,CAAC8C,KAAK,EACVwD,OAAO,CAAC9E,KACV,CAAC;IACD,IAAImD,cAAc,KAAK,CAAC,EAAE;MACxB;IACF;IAEA,MAAMzC,YAAY,GAAG,IAAI,CAACX,wBAAwB,CAAC+E,OAAO,CAAC9E,KAAK,CAAC;IAEjE,IAAI,CAACU,YAAY,EAAE;MACjB,MAAM,IAAI5C,mBAAmB,CAC3B,IAAI,EACJ,kCAAkC,EAClC,IAAI,EACJD,iBAAiB,CAACkH,iBACpB,CAAC;IACH;IAEA,IAAIrE,YAAY,CAACsE,OAAO,EAAEzF,MAAM,KAAK,SAAS,EAAE;MAC9C;IACF;IAEA,MAAM;MAAEZ,SAAS;MAAES,aAAa;MAAED;IAAO,CAAC,GAAGuB,YAAY;IACzD,MAAMqC,YAAY,GAAG,IAAI,CAACzB,KAAK,CAAC0B,QAAQ,CAACD,YAAY;IACrD,MAAME,cAAc,GAAG,MAAMjF,oBAAoB,CAC/CoB,aAAa,EACbD,MAAM,EACN4D,YACF,CAAC;;IAED;AACJ;AACA;IACI,MAAMxD,MAAM,GAAG,MAAM0D,cAAc,CAACgC,gBAAgB,CAClDtG,SAAS,EACTS,aACF,CAAC;IAEDrB,sBAAsB,CAACmH,kBAAkB,CACvC3F,MAAM,CAACR,MAAM,EACboE,cAAc,EACd,IACF,CAAC;IAED,IAAI5D,MAAM,CAACS,KAAK,CAACT,MAAM,KAAK,SAAS,EAAE;MACrC,MAAM,IAAI,CAAC4F,mBAAmB,CAACrD,OAAO,EAAEpB,YAAY,CAAC;MACrD;IACF;IAEA,IAAInB,MAAM,CAACS,KAAK,CAACT,MAAM,KAAK,YAAY,EAAE;MACxC,MAAM,IAAIzB,mBAAmB,CAC3B,IAAI,EACJ,gFAAgF,EAChF,IAAI,EACJD,iBAAiB,CAACuH,cACpB,CAAC;IACH;IAEA,MAAMC,QAAQ,GAAG,MAAMpC,cAAc,CAACqC,cAAc,CAClD3G,SAAS,EACTY,MAAM,CAACR,MACT,CAAC;IAED,IAAI,CAACsG,QAAQ,EAAE;MACb,MAAM,IAAIvH,mBAAmB,CAC3B,IAAI,EACJ,qFAAqF,EACrF,KACF,CAAC;IACH;IAEA,MAAM,IAAI,CAACqH,mBAAmB,CAACrD,OAAO,EAAEpB,YAAY,CAAC;EACvD;;EAEA;AACF;AACA;AACA;EACE,MAAcyE,mBAAmBA,CAC/BrD,OAA2B,EAC3BpB,YAA0B,EACX;IACf,MAAM6E,YAA0B,GAAG;MACjC,GAAG7E,YAAY;MACfsE,OAAO,EAAE;QACPzF,MAAM,EAAE,SAAS;QACjBE,SAAS,EAAE,IAAI+F,IAAI,CAAC,CAAC,CAACC,WAAW,CAAC;MACpC;IACF,CAAC;IAED,IAAI,IAAI,CAACC,IAAI,EAAE;MACb,MAAMC,YAAY,GAAG,MAAM,IAAI,CAACD,IAAI,CAACtD,QAAQ,CAACN,OAAO,CAAC;MACtD,MAAM,IAAI,CAAC4D,IAAI,CAACE,UAAU,CAAC9D,OAAO,EAAE6D,YAAY,EAAE;QAChD,CAAC,IAAI,CAACzF,IAAI,GAAGqF;MACf,CAAC,CAAC;IACJ;EACF;AACF;;AAEA;AACA;AACA","ignoreList":[]}

package/package.json

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

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

@@ -270,15 +270,10 @@ export class PaymentField extends FormComponent {
     const payCallbackUrl = `${baseUrl}/payment-callback?uuid=${uuid}`
     const paymentPageUrl = args.sourceUrl
 
-    // Prepopulate GOV.UK Pay email if emailField is configured.
-    // The referenced EmailAddressField validates with joi.string().email()
-    // at input time, so the value in state is already validated.
     let prefilledEmail: string | undefined
-    if (options.emailField) {
-      const emailValue = state[options.emailField]
-      if (typeof emailValue === 'string' && emailValue) {
-        prefilledEmail = emailValue
-      }
+    const userConfirmationEmail = state.userConfirmationEmailAddress
+    if (typeof userConfirmationEmail === 'string' && userConfirmationEmail) {
+      prefilledEmail = userConfirmationEmail
     }
 
     const amountInPence = Math.round(resolvedAmount * 100)