@defra/forms-engine-plugin 4.0.42 → 4.0.44

package/.server/server/plugins/engine/routes/payment-helper.test.js

@@ -0,0 +1,81 @@
+import { getPaymentContext } from "./payment-helper.js";
+import { get } from "../../../services/httpService.js";
+jest.mock("../../../services/httpService.ts");
+describe('payment helper', () => {
+  const uuid = '5a54c2fe-da49-4202-8cd3-2121eaca03c3';
+  it('should throw if no session', async () => {
+    const mockRequest = {
+      yar: {
+        get: jest.fn().mockReturnValueOnce(undefined)
+      }
+    };
+    // @ts-expect-error - partial request mock
+    await expect(() => getPaymentContext(mockRequest, uuid)).rejects.toThrow('No payment session found for uuid=5a54c2fe-da49-4202-8cd3-2121eaca03c3');
+  });
+  it('should throw if no payment id', async () => {
+    const mockRequest = {
+      yar: {
+        get: jest.fn().mockReturnValueOnce({})
+      }
+    };
+    // @ts-expect-error - partial request mock
+    await expect(() => getPaymentContext(mockRequest, uuid)).rejects.toThrow('No paymentId in session');
+  });
+  it('should get context successfully', async () => {
+    const mockRequest = {
+      yar: {
+        get: jest.fn().mockReturnValueOnce({
+          paymentId: 'payment-id',
+          isLivePayment: false,
+          formId: 'formid'
+        })
+      }
+    };
+    const getPaymentStatusApiResult = {
+      payment_id: 'payment-id-12345',
+      _links: {
+        next_url: {
+          href: 'http://next-url-href/payment'
+        }
+      },
+      state: {
+        status: 'created'
+      }
+    };
+    jest.mocked(get).mockResolvedValueOnce({
+      res: (/** @type {IncomingMessage} */{
+        statusCode: 200,
+        headers: {}
+      }),
+      payload: getPaymentStatusApiResult,
+      error: undefined
+    });
+
+    // @ts-expect-error - partial request mock
+    const res = await getPaymentContext(mockRequest, uuid);
+    expect(res).toEqual({
+      paymentStatus: {
+        paymentId: 'payment-id-12345',
+        _links: {
+          next_url: {
+            href: 'http://next-url-href/payment'
+          }
+        },
+        state: {
+          status: 'created'
+        }
+      },
+      session: {
+        formId: 'formid',
+        isLivePayment: false,
+        paymentId: 'payment-id'
+      },
+      sessionKey: 'payment-5a54c2fe-da49-4202-8cd3-2121eaca03c3'
+    });
+  });
+});
+
+/**
+ * @import  { IncomingMessage } from 'node:http'
+ */
+//# sourceMappingURL=payment-helper.test.js.map

package/.server/server/plugins/engine/routes/payment-helper.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-helper.test.js","names":["getPaymentContext","get","jest","mock","describe","uuid","it","mockRequest","yar","fn","mockReturnValueOnce","undefined","expect","rejects","toThrow","paymentId","isLivePayment","formId","getPaymentStatusApiResult","payment_id","_links","next_url","href","state","status","mocked","mockResolvedValueOnce","res","statusCode","headers","payload","error","toEqual","paymentStatus","session","sessionKey"],"sources":["../../../../../src/server/plugins/engine/routes/payment-helper.test.js"],"sourcesContent":["import { getPaymentContext } from '~/src/server/plugins/engine/routes/payment-helper.js'\nimport { get } from '~/src/server/services/httpService.js'\n\njest.mock('~/src/server/services/httpService.ts')\n\ndescribe('payment helper', () => {\n  const uuid = '5a54c2fe-da49-4202-8cd3-2121eaca03c3'\n  it('should throw if no session', async () => {\n    const mockRequest = {\n      yar: {\n        get: jest.fn().mockReturnValueOnce(undefined)\n      }\n    }\n    // @ts-expect-error - partial request mock\n    await expect(() => getPaymentContext(mockRequest, uuid)).rejects.toThrow(\n      'No payment session found for uuid=5a54c2fe-da49-4202-8cd3-2121eaca03c3'\n    )\n  })\n\n  it('should throw if no payment id', async () => {\n    const mockRequest = {\n      yar: {\n        get: jest.fn().mockReturnValueOnce({})\n      }\n    }\n    // @ts-expect-error - partial request mock\n    await expect(() => getPaymentContext(mockRequest, uuid)).rejects.toThrow(\n      'No paymentId in session'\n    )\n  })\n\n  it('should get context successfully', async () => {\n    const mockRequest = {\n      yar: {\n        get: jest.fn().mockReturnValueOnce({\n          paymentId: 'payment-id',\n          isLivePayment: false,\n          formId: 'formid'\n        })\n      }\n    }\n\n    const getPaymentStatusApiResult = {\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: getPaymentStatusApiResult,\n      error: undefined\n    })\n\n    // @ts-expect-error - partial request mock\n    const res = await getPaymentContext(mockRequest, uuid)\n    expect(res).toEqual({\n      paymentStatus: {\n        paymentId: '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      session: {\n        formId: 'formid',\n        isLivePayment: false,\n        paymentId: 'payment-id'\n      },\n      sessionKey: 'payment-5a54c2fe-da49-4202-8cd3-2121eaca03c3'\n    })\n  })\n})\n\n/**\n * @import  { IncomingMessage } from 'node:http'\n */\n"],"mappings":"AAAA,SAASA,iBAAiB;AAC1B,SAASC,GAAG;AAEZC,IAAI,CAACC,IAAI,mCAAuC,CAAC;AAEjDC,QAAQ,CAAC,gBAAgB,EAAE,MAAM;EAC/B,MAAMC,IAAI,GAAG,sCAAsC;EACnDC,EAAE,CAAC,4BAA4B,EAAE,YAAY;IAC3C,MAAMC,WAAW,GAAG;MAClBC,GAAG,EAAE;QACHP,GAAG,EAAEC,IAAI,CAACO,EAAE,CAAC,CAAC,CAACC,mBAAmB,CAACC,SAAS;MAC9C;IACF,CAAC;IACD;IACA,MAAMC,MAAM,CAAC,MAAMZ,iBAAiB,CAACO,WAAW,EAAEF,IAAI,CAAC,CAAC,CAACQ,OAAO,CAACC,OAAO,CACtE,wEACF,CAAC;EACH,CAAC,CAAC;EAEFR,EAAE,CAAC,+BAA+B,EAAE,YAAY;IAC9C,MAAMC,WAAW,GAAG;MAClBC,GAAG,EAAE;QACHP,GAAG,EAAEC,IAAI,CAACO,EAAE,CAAC,CAAC,CAACC,mBAAmB,CAAC,CAAC,CAAC;MACvC;IACF,CAAC;IACD;IACA,MAAME,MAAM,CAAC,MAAMZ,iBAAiB,CAACO,WAAW,EAAEF,IAAI,CAAC,CAAC,CAACQ,OAAO,CAACC,OAAO,CACtE,yBACF,CAAC;EACH,CAAC,CAAC;EAEFR,EAAE,CAAC,iCAAiC,EAAE,YAAY;IAChD,MAAMC,WAAW,GAAG;MAClBC,GAAG,EAAE;QACHP,GAAG,EAAEC,IAAI,CAACO,EAAE,CAAC,CAAC,CAACC,mBAAmB,CAAC;UACjCK,SAAS,EAAE,YAAY;UACvBC,aAAa,EAAE,KAAK;UACpBC,MAAM,EAAE;QACV,CAAC;MACH;IACF,CAAC;IAED,MAAMC,yBAAyB,GAAG;MAChCC,UAAU,EAAE,kBAAkB;MAC9BC,MAAM,EAAE;QACNC,QAAQ,EAAE;UACRC,IAAI,EAAE;QACR;MACF,CAAC;MACDC,KAAK,EAAE;QACLC,MAAM,EAAE;MACV;IACF,CAAC;IAEDtB,IAAI,CAACuB,MAAM,CAACxB,GAAG,CAAC,CAACyB,qBAAqB,CAAC;MACrCC,GAAG,GAAE,8BAAgC;QACnCC,UAAU,EAAE,GAAG;QACfC,OAAO,EAAE,CAAC;MACZ,CAAC,CAAC;MACFC,OAAO,EAAEZ,yBAAyB;MAClCa,KAAK,EAAEpB;IACT,CAAC,CAAC;;IAEF;IACA,MAAMgB,GAAG,GAAG,MAAM3B,iBAAiB,CAACO,WAAW,EAAEF,IAAI,CAAC;IACtDO,MAAM,CAACe,GAAG,CAAC,CAACK,OAAO,CAAC;MAClBC,aAAa,EAAE;QACblB,SAAS,EAAE,kBAAkB;QAC7BK,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE;UACR;QACF,CAAC;QACDC,KAAK,EAAE;UACLC,MAAM,EAAE;QACV;MACF,CAAC;MACDU,OAAO,EAAE;QACPjB,MAAM,EAAE,QAAQ;QAChBD,aAAa,EAAE,KAAK;QACpBD,SAAS,EAAE;MACb,CAAC;MACDoB,UAAU,EAAE;IACd,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/routes/payment.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Gets the payment routes for handling GOV.UK Pay callbacks
+ * @returns {ServerRoute[]}
+ */
+export function getRoutes(): ServerRoute[];
+export const PAYMENT_RETURN_PATH: "/payment-callback";
+export const PAYMENT_SESSION_PREFIX: "payment-";
+import type { ServerRoute } from '@hapi/hapi';

package/.server/server/plugins/engine/routes/payment.js

@@ -0,0 +1,140 @@
+import Boom from '@hapi/boom';
+import { StatusCodes } from 'http-status-codes';
+import Joi from 'joi';
+import { EXTERNAL_STATE_APPENDAGE } from "../../../constants.js";
+import { getPaymentContext } from "./payment-helper.js";
+export const PAYMENT_RETURN_PATH = '/payment-callback';
+export const PAYMENT_SESSION_PREFIX = 'payment-';
+
+/**
+ * Flash form component state after successful payment
+ * @param {Request} request - the request
+ * @param {PaymentSessionData} session - the session data containing payment state
+ * @param {GetPaymentResponse} paymentStatus - the payment status response from GOV.UK Pay
+ */
+function flashComponentState(request, session, paymentStatus) {
+  /** @type {PaymentState} */
+  const paymentState = {
+    paymentId: paymentStatus.paymentId,
+    reference: session.reference,
+    amount: session.amount,
+    description: session.description,
+    uuid: session.uuid,
+    formId: session.formId,
+    isLivePayment: session.isLivePayment,
+    payerEmail: paymentStatus.email,
+    preAuth: {
+      status: 'success',
+      createdAt: new Date().toISOString()
+    }
+  };
+
+  /** @type {ExternalStateAppendage} */
+  const appendage = {
+    component: session.componentName,
+    data: (/** @type {FormState} */ /** @type {unknown} */paymentState)
+  };
+  request.yar.flash(EXTERNAL_STATE_APPENDAGE, appendage, true);
+}
+
+/**
+ * Gets the payment routes for handling GOV.UK Pay callbacks
+ * @returns {ServerRoute[]}
+ */
+export function getRoutes() {
+  return [getReturnRoute()];
+}
+
+/**
+ * Handles successful payment states (capturable/success)
+ * @param {Request} request - the request
+ * @param {ResponseToolkit} h - the response toolkit
+ * @param {PaymentSessionData} session - the session data
+ * @param {string} sessionKey - the session key
+ * @param {GetPaymentResponse} paymentStatus - the payment status from GOV.UK Pay
+ */
+function handlePaymentSuccess(request, h, session, sessionKey, paymentStatus) {
+  flashComponentState(request, session, paymentStatus);
+  request.yar.clear(sessionKey);
+  return h.redirect(session.returnUrl).code(StatusCodes.SEE_OTHER);
+}
+
+/**
+ * Handles failed/cancelled/error payment states
+ * @param {Request} request - the request
+ * @param {ResponseToolkit} h - the response toolkit
+ * @param {PaymentSessionData} session - the session data
+ * @param {string} sessionKey - the session key
+ */
+function handlePaymentFailure(request, h, session, sessionKey) {
+  request.yar.clear(sessionKey);
+  return h.redirect(session.failureUrl).code(StatusCodes.SEE_OTHER);
+}
+
+/**
+ * Route handler for payment return URL
+ * This is called when GOV.UK Pay redirects the user back after payment
+ * @returns {ServerRoute}
+ */
+function getReturnRoute() {
+  return {
+    method: 'GET',
+    path: PAYMENT_RETURN_PATH,
+    async handler(request, h) {
+      const {
+        uuid
+      } = /** @type {{ uuid: string }} */request.query;
+      const {
+        session,
+        sessionKey,
+        paymentStatus
+      } = await getPaymentContext(request, uuid);
+
+      /**
+       * @see https://docs.payments.service.gov.uk/api_reference/#payment-status-lifecycle
+       */
+      const {
+        status
+      } = paymentStatus.state;
+      switch (status) {
+        case 'capturable':
+        case 'success':
+          return handlePaymentSuccess(request, h, session, sessionKey, paymentStatus);
+        case 'cancelled':
+        case 'failed':
+        case 'error':
+          return handlePaymentFailure(request, h, session, sessionKey);
+        case 'created':
+        case 'started':
+        case 'submitted':
+          {
+            const nextUrl = paymentStatus._links.next_url?.href;
+            if (!nextUrl) {
+              throw Boom.badRequest(`Payment in state '${status}' but no next_url available`);
+            }
+            return h.redirect(nextUrl).code(StatusCodes.SEE_OTHER);
+          }
+        default:
+          {
+            const unknownStatus = /** @type {string} */status;
+            throw Boom.internal(`Unknown payment status: ${unknownStatus}`);
+          }
+      }
+    },
+    options: {
+      validate: {
+        query: Joi.object().keys({
+          uuid: Joi.string().uuid().required()
+        }).required()
+      }
+    }
+  };
+}
+
+/**
+ * @import { Request, ResponseToolkit, ServerRoute } from '@hapi/hapi'
+ * @import { GetPaymentResponse, PaymentSessionData } from '~/src/server/plugins/payment/types.js'
+ * @import { PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js'
+ * @import { ExternalStateAppendage, FormState } from '~/src/server/plugins/engine/types.js'
+ */
+//# sourceMappingURL=payment.js.map

package/.server/server/plugins/engine/routes/payment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment.js","names":["Boom","StatusCodes","Joi","EXTERNAL_STATE_APPENDAGE","getPaymentContext","PAYMENT_RETURN_PATH","PAYMENT_SESSION_PREFIX","flashComponentState","request","session","paymentStatus","paymentState","paymentId","reference","amount","description","uuid","formId","isLivePayment","payerEmail","email","preAuth","status","createdAt","Date","toISOString","appendage","component","componentName","data","yar","flash","getRoutes","getReturnRoute","handlePaymentSuccess","h","sessionKey","clear","redirect","returnUrl","code","SEE_OTHER","handlePaymentFailure","failureUrl","method","path","handler","query","state","nextUrl","_links","next_url","href","badRequest","unknownStatus","internal","options","validate","object","keys","string","required"],"sources":["../../../../../src/server/plugins/engine/routes/payment.js"],"sourcesContent":["import Boom from '@hapi/boom'\nimport { StatusCodes } from 'http-status-codes'\nimport Joi from 'joi'\n\nimport { EXTERNAL_STATE_APPENDAGE } from '~/src/server/constants.js'\nimport { getPaymentContext } from '~/src/server/plugins/engine/routes/payment-helper.js'\n\nexport const PAYMENT_RETURN_PATH = '/payment-callback'\nexport const PAYMENT_SESSION_PREFIX = 'payment-'\n\n/**\n * Flash form component state after successful payment\n * @param {Request} request - the request\n * @param {PaymentSessionData} session - the session data containing payment state\n * @param {GetPaymentResponse} paymentStatus - the payment status response from GOV.UK Pay\n */\nfunction flashComponentState(request, session, paymentStatus) {\n  /** @type {PaymentState} */\n  const paymentState = {\n    paymentId: paymentStatus.paymentId,\n    reference: session.reference,\n    amount: session.amount,\n    description: session.description,\n    uuid: session.uuid,\n    formId: session.formId,\n    isLivePayment: session.isLivePayment,\n    payerEmail: paymentStatus.email,\n    preAuth: {\n      status: 'success',\n      createdAt: new Date().toISOString()\n    }\n  }\n\n  /** @type {ExternalStateAppendage} */\n  const appendage = {\n    component: session.componentName,\n    data: /** @type {FormState} */ (/** @type {unknown} */ (paymentState))\n  }\n\n  request.yar.flash(EXTERNAL_STATE_APPENDAGE, appendage, true)\n}\n\n/**\n * Gets the payment routes for handling GOV.UK Pay callbacks\n * @returns {ServerRoute[]}\n */\nexport function getRoutes() {\n  return [getReturnRoute()]\n}\n\n/**\n * Handles successful payment states (capturable/success)\n * @param {Request} request - the request\n * @param {ResponseToolkit} h - the response toolkit\n * @param {PaymentSessionData} session - the session data\n * @param {string} sessionKey - the session key\n * @param {GetPaymentResponse} paymentStatus - the payment status from GOV.UK Pay\n */\nfunction handlePaymentSuccess(request, h, session, sessionKey, paymentStatus) {\n  flashComponentState(request, session, paymentStatus)\n  request.yar.clear(sessionKey)\n  return h.redirect(session.returnUrl).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * Handles failed/cancelled/error payment states\n * @param {Request} request - the request\n * @param {ResponseToolkit} h - the response toolkit\n * @param {PaymentSessionData} session - the session data\n * @param {string} sessionKey - the session key\n */\nfunction handlePaymentFailure(request, h, session, sessionKey) {\n  request.yar.clear(sessionKey)\n  return h.redirect(session.failureUrl).code(StatusCodes.SEE_OTHER)\n}\n\n/**\n * Route handler for payment return URL\n * This is called when GOV.UK Pay redirects the user back after payment\n * @returns {ServerRoute}\n */\nfunction getReturnRoute() {\n  return {\n    method: 'GET',\n    path: PAYMENT_RETURN_PATH,\n    async handler(request, h) {\n      const { uuid } = /** @type {{ uuid: string }} */ (request.query)\n      const { session, sessionKey, paymentStatus } = await getPaymentContext(\n        request,\n        uuid\n      )\n\n      /**\n       * @see https://docs.payments.service.gov.uk/api_reference/#payment-status-lifecycle\n       */\n      const { status } = paymentStatus.state\n\n      switch (status) {\n        case 'capturable':\n        case 'success':\n          return handlePaymentSuccess(\n            request,\n            h,\n            session,\n            sessionKey,\n            paymentStatus\n          )\n\n        case 'cancelled':\n        case 'failed':\n        case 'error':\n          return handlePaymentFailure(request, h, session, sessionKey)\n\n        case 'created':\n        case 'started':\n        case 'submitted': {\n          const nextUrl = paymentStatus._links.next_url?.href\n\n          if (!nextUrl) {\n            throw Boom.badRequest(\n              `Payment in state '${status}' but no next_url available`\n            )\n          }\n\n          return h.redirect(nextUrl).code(StatusCodes.SEE_OTHER)\n        }\n\n        default: {\n          const unknownStatus = /** @type {string} */ (status)\n          throw Boom.internal(`Unknown payment status: ${unknownStatus}`)\n        }\n      }\n    },\n    options: {\n      validate: {\n        query: Joi.object()\n          .keys({\n            uuid: Joi.string().uuid().required()\n          })\n          .required()\n      }\n    }\n  }\n}\n\n/**\n * @import { Request, ResponseToolkit, ServerRoute } from '@hapi/hapi'\n * @import { GetPaymentResponse, PaymentSessionData } from '~/src/server/plugins/payment/types.js'\n * @import { PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js'\n * @import { ExternalStateAppendage, FormState } from '~/src/server/plugins/engine/types.js'\n */\n"],"mappings":"AAAA,OAAOA,IAAI,MAAM,YAAY;AAC7B,SAASC,WAAW,QAAQ,mBAAmB;AAC/C,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,wBAAwB;AACjC,SAASC,iBAAiB;AAE1B,OAAO,MAAMC,mBAAmB,GAAG,mBAAmB;AACtD,OAAO,MAAMC,sBAAsB,GAAG,UAAU;;AAEhD;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,mBAAmBA,CAACC,OAAO,EAAEC,OAAO,EAAEC,aAAa,EAAE;EAC5D;EACA,MAAMC,YAAY,GAAG;IACnBC,SAAS,EAAEF,aAAa,CAACE,SAAS;IAClCC,SAAS,EAAEJ,OAAO,CAACI,SAAS;IAC5BC,MAAM,EAAEL,OAAO,CAACK,MAAM;IACtBC,WAAW,EAAEN,OAAO,CAACM,WAAW;IAChCC,IAAI,EAAEP,OAAO,CAACO,IAAI;IAClBC,MAAM,EAAER,OAAO,CAACQ,MAAM;IACtBC,aAAa,EAAET,OAAO,CAACS,aAAa;IACpCC,UAAU,EAAET,aAAa,CAACU,KAAK;IAC/BC,OAAO,EAAE;MACPC,MAAM,EAAE,SAAS;MACjBC,SAAS,EAAE,IAAIC,IAAI,CAAC,CAAC,CAACC,WAAW,CAAC;IACpC;EACF,CAAC;;EAED;EACA,MAAMC,SAAS,GAAG;IAChBC,SAAS,EAAElB,OAAO,CAACmB,aAAa;IAChCC,IAAI,GAAE,yBAA0B,sBAAwBlB,YAAY;EACtE,CAAC;EAEDH,OAAO,CAACsB,GAAG,CAACC,KAAK,CAAC5B,wBAAwB,EAAEuB,SAAS,EAAE,IAAI,CAAC;AAC9D;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASM,SAASA,CAAA,EAAG;EAC1B,OAAO,CAACC,cAAc,CAAC,CAAC,CAAC;AAC3B;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,oBAAoBA,CAAC1B,OAAO,EAAE2B,CAAC,EAAE1B,OAAO,EAAE2B,UAAU,EAAE1B,aAAa,EAAE;EAC5EH,mBAAmB,CAACC,OAAO,EAAEC,OAAO,EAAEC,aAAa,CAAC;EACpDF,OAAO,CAACsB,GAAG,CAACO,KAAK,CAACD,UAAU,CAAC;EAC7B,OAAOD,CAAC,CAACG,QAAQ,CAAC7B,OAAO,CAAC8B,SAAS,CAAC,CAACC,IAAI,CAACvC,WAAW,CAACwC,SAAS,CAAC;AAClE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,oBAAoBA,CAAClC,OAAO,EAAE2B,CAAC,EAAE1B,OAAO,EAAE2B,UAAU,EAAE;EAC7D5B,OAAO,CAACsB,GAAG,CAACO,KAAK,CAACD,UAAU,CAAC;EAC7B,OAAOD,CAAC,CAACG,QAAQ,CAAC7B,OAAO,CAACkC,UAAU,CAAC,CAACH,IAAI,CAACvC,WAAW,CAACwC,SAAS,CAAC;AACnE;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASR,cAAcA,CAAA,EAAG;EACxB,OAAO;IACLW,MAAM,EAAE,KAAK;IACbC,IAAI,EAAExC,mBAAmB;IACzB,MAAMyC,OAAOA,CAACtC,OAAO,EAAE2B,CAAC,EAAE;MACxB,MAAM;QAAEnB;MAAK,CAAC,GAAG,+BAAiCR,OAAO,CAACuC,KAAM;MAChE,MAAM;QAAEtC,OAAO;QAAE2B,UAAU;QAAE1B;MAAc,CAAC,GAAG,MAAMN,iBAAiB,CACpEI,OAAO,EACPQ,IACF,CAAC;;MAED;AACN;AACA;MACM,MAAM;QAAEM;MAAO,CAAC,GAAGZ,aAAa,CAACsC,KAAK;MAEtC,QAAQ1B,MAAM;QACZ,KAAK,YAAY;QACjB,KAAK,SAAS;UACZ,OAAOY,oBAAoB,CACzB1B,OAAO,EACP2B,CAAC,EACD1B,OAAO,EACP2B,UAAU,EACV1B,aACF,CAAC;QAEH,KAAK,WAAW;QAChB,KAAK,QAAQ;QACb,KAAK,OAAO;UACV,OAAOgC,oBAAoB,CAAClC,OAAO,EAAE2B,CAAC,EAAE1B,OAAO,EAAE2B,UAAU,CAAC;QAE9D,KAAK,SAAS;QACd,KAAK,SAAS;QACd,KAAK,WAAW;UAAE;YAChB,MAAMa,OAAO,GAAGvC,aAAa,CAACwC,MAAM,CAACC,QAAQ,EAAEC,IAAI;YAEnD,IAAI,CAACH,OAAO,EAAE;cACZ,MAAMjD,IAAI,CAACqD,UAAU,CACnB,qBAAqB/B,MAAM,6BAC7B,CAAC;YACH;YAEA,OAAOa,CAAC,CAACG,QAAQ,CAACW,OAAO,CAAC,CAACT,IAAI,CAACvC,WAAW,CAACwC,SAAS,CAAC;UACxD;QAEA;UAAS;YACP,MAAMa,aAAa,GAAG,qBAAuBhC,MAAO;YACpD,MAAMtB,IAAI,CAACuD,QAAQ,CAAC,2BAA2BD,aAAa,EAAE,CAAC;UACjE;MACF;IACF,CAAC;IACDE,OAAO,EAAE;MACPC,QAAQ,EAAE;QACRV,KAAK,EAAE7C,GAAG,CAACwD,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;UACJ3C,IAAI,EAAEd,GAAG,CAAC0D,MAAM,CAAC,CAAC,CAAC5C,IAAI,CAAC,CAAC,CAAC6C,QAAQ,CAAC;QACrC,CAAC,CAAC,CACDA,QAAQ,CAAC;MACd;IACF;EACF,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/routes/payment.test.js

@@ -0,0 +1,187 @@
+import { StatusCodes } from 'http-status-codes';
+import { createServer } from "../../../index.js";
+import { getPaymentContext } from "./payment-helper.js";
+import { renderResponse } from "../../../../../test/helpers/component-helpers.js";
+jest.mock("./payment-helper.js");
+describe('Payment routes', () => {
+  /** @type {Server} */
+  let server;
+  beforeAll(async () => {
+    server = await createServer();
+    await server.initialize();
+  });
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+  describe('Return route /payment-callback', () => {
+    const uuid = '06a5b11e-e3e0-48a2-8ac3-56c0fcb6c20d';
+    const options = {
+      method: 'get',
+      url: `/payment-callback?uuid=${uuid}`
+    };
+    const paymentSessionData = {
+      uuid,
+      formId: 'form-id',
+      reference: 'form-ref-123',
+      paymentId: 'payment-id',
+      amount: 123,
+      description: 'Payment desc',
+      isLivePayment: false,
+      componentName: 'my-component',
+      returnUrl: 'http://host.com/return-url',
+      failureUrl: 'http://host.com/failure-url'
+    };
+    const sessionKey = 'session-key';
+    test.each([{
+      status: 'capturable',
+      finalUrl: 'http://host.com/return-url'
+    }, {
+      status: 'success',
+      finalUrl: 'http://host.com/return-url'
+    }, {
+      status: 'cancelled',
+      finalUrl: 'http://host.com/failure-url'
+    }, {
+      status: 'failed',
+      finalUrl: 'http://host.com/failure-url'
+    }, {
+      status: 'error',
+      finalUrl: 'http://host.com/failure-url'
+    }, {
+      status: 'created',
+      finalUrl: '/next-url'
+    }, {
+      status: 'started',
+      finalUrl: '/next-url'
+    }, {
+      status: 'submitted',
+      finalUrl: '/next-url'
+    }])('should handle payment status of $row.status', async row => {
+      const paymentStatus = {
+        paymentId: 'new-payment-id',
+        amount: 125,
+        _links: {
+          next_url: {
+            href: '/next-url',
+            method: 'get'
+          },
+          self: {
+            href: '/self',
+            method: 'get'
+          }
+        },
+        state: (/** @type {PaymentResponseState} */{
+          status: row.status,
+          finished: true
+        })
+      };
+      jest.mocked(getPaymentContext).mockResolvedValueOnce({
+        session: paymentSessionData,
+        sessionKey,
+        paymentStatus
+      });
+      const {
+        response
+      } = await renderResponse(server, options);
+      expect(response.statusCode).toBe(StatusCodes.SEE_OTHER);
+      expect(response.headers.location).toBe(row.finalUrl);
+    });
+    it('should throw if nextUrl is missing', async () => {
+      const paymentStatus = {
+        paymentId: 'new-payment-id',
+        _links: {
+          next_url: {},
+          self: {
+            href: '/self',
+            method: 'get'
+          }
+        },
+        state: (/** @type {PaymentResponseState} */{
+          status: 'created',
+          finished: true
+        })
+      };
+      jest.mocked(getPaymentContext).mockResolvedValueOnce({
+        session: paymentSessionData,
+        sessionKey,
+        // @ts-expect-error - deliberate missing element from object
+        paymentStatus
+      });
+      const {
+        response
+      } = await renderResponse(server, options);
+      expect(response.statusCode).toBe(StatusCodes.BAD_REQUEST);
+      // @ts-expect-error - error object
+      expect(response.result?.message).toBe("Payment in state 'created' but no next_url available");
+    });
+    it('should throw if invalid status', async () => {
+      const paymentStatus = {
+        paymentId: 'new-payment-id',
+        _links: {
+          next_url: {
+            href: '/next-url',
+            method: 'get'
+          },
+          self: {
+            href: '/self',
+            method: 'get'
+          }
+        },
+        state: {
+          status: 'invalid',
+          finished: true
+        }
+      };
+      jest.mocked(getPaymentContext).mockResolvedValueOnce({
+        session: paymentSessionData,
+        sessionKey,
+        // @ts-expect-error - deliberate invalid value which doesnt meet type
+        paymentStatus
+      });
+      const {
+        response
+      } = await renderResponse(server, options);
+      expect(response.statusCode).toBe(StatusCodes.INTERNAL_SERVER_ERROR);
+      // @ts-expect-error - error object
+      expect(response.result?.message).toBe('Unknown payment status: invalid');
+    });
+    it('should handle payment with email from GOV.UK Pay response', async () => {
+      const paymentStatus = {
+        paymentId: 'new-payment-id',
+        payment_id: 'new-payment-id',
+        amount: 125,
+        email: 'payer@example.com',
+        _links: {
+          next_url: {
+            href: '/next-url',
+            method: 'get'
+          },
+          self: {
+            href: '/self',
+            method: 'get'
+          }
+        },
+        state: (/** @type {PaymentResponseState} */{
+          status: 'success',
+          finished: true
+        })
+      };
+      jest.mocked(getPaymentContext).mockResolvedValueOnce({
+        session: paymentSessionData,
+        sessionKey,
+        paymentStatus
+      });
+      const {
+        response
+      } = await renderResponse(server, options);
+      expect(response.statusCode).toBe(StatusCodes.SEE_OTHER);
+      expect(response.headers.location).toBe('http://host.com/return-url');
+    });
+  });
+});
+
+/**
+ * @import { Server } from '@hapi/hapi'
+ * @import { PaymentResponseState } from '~/src/server/plugins/payment/types.js'
+ */
+//# sourceMappingURL=payment.test.js.map

package/.server/server/plugins/engine/routes/payment.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment.test.js","names":["StatusCodes","createServer","getPaymentContext","renderResponse","jest","mock","describe","server","beforeAll","initialize","beforeEach","resetAllMocks","uuid","options","method","url","paymentSessionData","formId","reference","paymentId","amount","description","isLivePayment","componentName","returnUrl","failureUrl","sessionKey","test","each","status","finalUrl","row","paymentStatus","_links","next_url","href","self","state","finished","mocked","mockResolvedValueOnce","session","response","expect","statusCode","toBe","SEE_OTHER","headers","location","it","BAD_REQUEST","result","message","INTERNAL_SERVER_ERROR","payment_id","email"],"sources":["../../../../../src/server/plugins/engine/routes/payment.test.js"],"sourcesContent":["import { StatusCodes } from 'http-status-codes'\n\nimport { createServer } from '~/src/server/index.js'\nimport { getPaymentContext } from '~/src/server/plugins/engine/routes/payment-helper.js'\nimport { renderResponse } from '~/test/helpers/component-helpers.js'\n\njest.mock('~/src/server/plugins/engine/routes/payment-helper.js')\n\ndescribe('Payment routes', () => {\n  /** @type {Server} */\n  let server\n\n  beforeAll(async () => {\n    server = await createServer()\n    await server.initialize()\n  })\n\n  beforeEach(() => {\n    jest.resetAllMocks()\n  })\n\n  describe('Return route /payment-callback', () => {\n    const uuid = '06a5b11e-e3e0-48a2-8ac3-56c0fcb6c20d'\n    const options = {\n      method: 'get',\n      url: `/payment-callback?uuid=${uuid}`\n    }\n\n    const paymentSessionData = {\n      uuid,\n      formId: 'form-id',\n      reference: 'form-ref-123',\n      paymentId: 'payment-id',\n      amount: 123,\n      description: 'Payment desc',\n      isLivePayment: false,\n      componentName: 'my-component',\n      returnUrl: 'http://host.com/return-url',\n      failureUrl: 'http://host.com/failure-url'\n    }\n    const sessionKey = 'session-key'\n\n    test.each([\n      { status: 'capturable', finalUrl: 'http://host.com/return-url' },\n      { status: 'success', finalUrl: 'http://host.com/return-url' },\n      { status: 'cancelled', finalUrl: 'http://host.com/failure-url' },\n      { status: 'failed', finalUrl: 'http://host.com/failure-url' },\n      { status: 'error', finalUrl: 'http://host.com/failure-url' },\n      { status: 'created', finalUrl: '/next-url' },\n      { status: 'started', finalUrl: '/next-url' },\n      { status: 'submitted', finalUrl: '/next-url' }\n    ])('should handle payment status of $row.status', async (row) => {\n      const paymentStatus = {\n        paymentId: 'new-payment-id',\n        amount: 125,\n        _links: {\n          next_url: {\n            href: '/next-url',\n            method: 'get'\n          },\n          self: {\n            href: '/self',\n            method: 'get'\n          }\n        },\n        state: /** @type {PaymentResponseState} */ ({\n          status: row.status,\n          finished: true\n        })\n      }\n      jest.mocked(getPaymentContext).mockResolvedValueOnce({\n        session: paymentSessionData,\n        sessionKey,\n        paymentStatus\n      })\n      const { response } = await renderResponse(server, options)\n\n      expect(response.statusCode).toBe(StatusCodes.SEE_OTHER)\n      expect(response.headers.location).toBe(row.finalUrl)\n    })\n\n    it('should throw if nextUrl is missing', async () => {\n      const paymentStatus = {\n        paymentId: 'new-payment-id',\n        _links: {\n          next_url: {},\n          self: {\n            href: '/self',\n            method: 'get'\n          }\n        },\n        state: /** @type {PaymentResponseState} */ ({\n          status: 'created',\n          finished: true\n        })\n      }\n      jest.mocked(getPaymentContext).mockResolvedValueOnce({\n        session: paymentSessionData,\n        sessionKey,\n        // @ts-expect-error - deliberate missing element from object\n        paymentStatus\n      })\n      const { response } = await renderResponse(server, options)\n\n      expect(response.statusCode).toBe(StatusCodes.BAD_REQUEST)\n      // @ts-expect-error - error object\n      expect(response.result?.message).toBe(\n        \"Payment in state 'created' but no next_url available\"\n      )\n    })\n\n    it('should throw if invalid status', async () => {\n      const paymentStatus = {\n        paymentId: 'new-payment-id',\n        _links: {\n          next_url: {\n            href: '/next-url',\n            method: 'get'\n          },\n          self: {\n            href: '/self',\n            method: 'get'\n          }\n        },\n        state: {\n          status: 'invalid',\n          finished: true\n        }\n      }\n      jest.mocked(getPaymentContext).mockResolvedValueOnce({\n        session: paymentSessionData,\n        sessionKey,\n        // @ts-expect-error - deliberate invalid value which doesnt meet type\n        paymentStatus\n      })\n      const { response } = await renderResponse(server, options)\n\n      expect(response.statusCode).toBe(StatusCodes.INTERNAL_SERVER_ERROR)\n      // @ts-expect-error - error object\n      expect(response.result?.message).toBe('Unknown payment status: invalid')\n    })\n\n    it('should handle payment with email from GOV.UK Pay response', async () => {\n      const paymentStatus = {\n        paymentId: 'new-payment-id',\n        payment_id: 'new-payment-id',\n        amount: 125,\n        email: 'payer@example.com',\n        _links: {\n          next_url: {\n            href: '/next-url',\n            method: 'get'\n          },\n          self: {\n            href: '/self',\n            method: 'get'\n          }\n        },\n        state: /** @type {PaymentResponseState} */ ({\n          status: 'success',\n          finished: true\n        })\n      }\n      jest.mocked(getPaymentContext).mockResolvedValueOnce({\n        session: paymentSessionData,\n        sessionKey,\n        paymentStatus\n      })\n      const { response } = await renderResponse(server, options)\n\n      expect(response.statusCode).toBe(StatusCodes.SEE_OTHER)\n      expect(response.headers.location).toBe('http://host.com/return-url')\n    })\n  })\n})\n\n/**\n * @import { Server } from '@hapi/hapi'\n * @import { PaymentResponseState } from '~/src/server/plugins/payment/types.js'\n */\n"],"mappings":"AAAA,SAASA,WAAW,QAAQ,mBAAmB;AAE/C,SAASC,YAAY;AACrB,SAASC,iBAAiB;AAC1B,SAASC,cAAc;AAEvBC,IAAI,CAACC,IAAI,sBAAuD,CAAC;AAEjEC,QAAQ,CAAC,gBAAgB,EAAE,MAAM;EAC/B;EACA,IAAIC,MAAM;EAEVC,SAAS,CAAC,YAAY;IACpBD,MAAM,GAAG,MAAMN,YAAY,CAAC,CAAC;IAC7B,MAAMM,MAAM,CAACE,UAAU,CAAC,CAAC;EAC3B,CAAC,CAAC;EAEFC,UAAU,CAAC,MAAM;IACfN,IAAI,CAACO,aAAa,CAAC,CAAC;EACtB,CAAC,CAAC;EAEFL,QAAQ,CAAC,gCAAgC,EAAE,MAAM;IAC/C,MAAMM,IAAI,GAAG,sCAAsC;IACnD,MAAMC,OAAO,GAAG;MACdC,MAAM,EAAE,KAAK;MACbC,GAAG,EAAE,0BAA0BH,IAAI;IACrC,CAAC;IAED,MAAMI,kBAAkB,GAAG;MACzBJ,IAAI;MACJK,MAAM,EAAE,SAAS;MACjBC,SAAS,EAAE,cAAc;MACzBC,SAAS,EAAE,YAAY;MACvBC,MAAM,EAAE,GAAG;MACXC,WAAW,EAAE,cAAc;MAC3BC,aAAa,EAAE,KAAK;MACpBC,aAAa,EAAE,cAAc;MAC7BC,SAAS,EAAE,4BAA4B;MACvCC,UAAU,EAAE;IACd,CAAC;IACD,MAAMC,UAAU,GAAG,aAAa;IAEhCC,IAAI,CAACC,IAAI,CAAC,CACR;MAAEC,MAAM,EAAE,YAAY;MAAEC,QAAQ,EAAE;IAA6B,CAAC,EAChE;MAAED,MAAM,EAAE,SAAS;MAAEC,QAAQ,EAAE;IAA6B,CAAC,EAC7D;MAAED,MAAM,EAAE,WAAW;MAAEC,QAAQ,EAAE;IAA8B,CAAC,EAChE;MAAED,MAAM,EAAE,QAAQ;MAAEC,QAAQ,EAAE;IAA8B,CAAC,EAC7D;MAAED,MAAM,EAAE,OAAO;MAAEC,QAAQ,EAAE;IAA8B,CAAC,EAC5D;MAAED,MAAM,EAAE,SAAS;MAAEC,QAAQ,EAAE;IAAY,CAAC,EAC5C;MAAED,MAAM,EAAE,SAAS;MAAEC,QAAQ,EAAE;IAAY,CAAC,EAC5C;MAAED,MAAM,EAAE,WAAW;MAAEC,QAAQ,EAAE;IAAY,CAAC,CAC/C,CAAC,CAAC,6CAA6C,EAAE,MAAOC,GAAG,IAAK;MAC/D,MAAMC,aAAa,GAAG;QACpBb,SAAS,EAAE,gBAAgB;QAC3BC,MAAM,EAAE,GAAG;QACXa,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE,WAAW;YACjBrB,MAAM,EAAE;UACV,CAAC;UACDsB,IAAI,EAAE;YACJD,IAAI,EAAE,OAAO;YACbrB,MAAM,EAAE;UACV;QACF,CAAC;QACDuB,KAAK,GAAE,mCAAqC;UAC1CR,MAAM,EAAEE,GAAG,CAACF,MAAM;UAClBS,QAAQ,EAAE;QACZ,CAAC;MACH,CAAC;MACDlC,IAAI,CAACmC,MAAM,CAACrC,iBAAiB,CAAC,CAACsC,qBAAqB,CAAC;QACnDC,OAAO,EAAEzB,kBAAkB;QAC3BU,UAAU;QACVM;MACF,CAAC,CAAC;MACF,MAAM;QAAEU;MAAS,CAAC,GAAG,MAAMvC,cAAc,CAACI,MAAM,EAAEM,OAAO,CAAC;MAE1D8B,MAAM,CAACD,QAAQ,CAACE,UAAU,CAAC,CAACC,IAAI,CAAC7C,WAAW,CAAC8C,SAAS,CAAC;MACvDH,MAAM,CAACD,QAAQ,CAACK,OAAO,CAACC,QAAQ,CAAC,CAACH,IAAI,CAACd,GAAG,CAACD,QAAQ,CAAC;IACtD,CAAC,CAAC;IAEFmB,EAAE,CAAC,oCAAoC,EAAE,YAAY;MACnD,MAAMjB,aAAa,GAAG;QACpBb,SAAS,EAAE,gBAAgB;QAC3Bc,MAAM,EAAE;UACNC,QAAQ,EAAE,CAAC,CAAC;UACZE,IAAI,EAAE;YACJD,IAAI,EAAE,OAAO;YACbrB,MAAM,EAAE;UACV;QACF,CAAC;QACDuB,KAAK,GAAE,mCAAqC;UAC1CR,MAAM,EAAE,SAAS;UACjBS,QAAQ,EAAE;QACZ,CAAC;MACH,CAAC;MACDlC,IAAI,CAACmC,MAAM,CAACrC,iBAAiB,CAAC,CAACsC,qBAAqB,CAAC;QACnDC,OAAO,EAAEzB,kBAAkB;QAC3BU,UAAU;QACV;QACAM;MACF,CAAC,CAAC;MACF,MAAM;QAAEU;MAAS,CAAC,GAAG,MAAMvC,cAAc,CAACI,MAAM,EAAEM,OAAO,CAAC;MAE1D8B,MAAM,CAACD,QAAQ,CAACE,UAAU,CAAC,CAACC,IAAI,CAAC7C,WAAW,CAACkD,WAAW,CAAC;MACzD;MACAP,MAAM,CAACD,QAAQ,CAACS,MAAM,EAAEC,OAAO,CAAC,CAACP,IAAI,CACnC,sDACF,CAAC;IACH,CAAC,CAAC;IAEFI,EAAE,CAAC,gCAAgC,EAAE,YAAY;MAC/C,MAAMjB,aAAa,GAAG;QACpBb,SAAS,EAAE,gBAAgB;QAC3Bc,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE,WAAW;YACjBrB,MAAM,EAAE;UACV,CAAC;UACDsB,IAAI,EAAE;YACJD,IAAI,EAAE,OAAO;YACbrB,MAAM,EAAE;UACV;QACF,CAAC;QACDuB,KAAK,EAAE;UACLR,MAAM,EAAE,SAAS;UACjBS,QAAQ,EAAE;QACZ;MACF,CAAC;MACDlC,IAAI,CAACmC,MAAM,CAACrC,iBAAiB,CAAC,CAACsC,qBAAqB,CAAC;QACnDC,OAAO,EAAEzB,kBAAkB;QAC3BU,UAAU;QACV;QACAM;MACF,CAAC,CAAC;MACF,MAAM;QAAEU;MAAS,CAAC,GAAG,MAAMvC,cAAc,CAACI,MAAM,EAAEM,OAAO,CAAC;MAE1D8B,MAAM,CAACD,QAAQ,CAACE,UAAU,CAAC,CAACC,IAAI,CAAC7C,WAAW,CAACqD,qBAAqB,CAAC;MACnE;MACAV,MAAM,CAACD,QAAQ,CAACS,MAAM,EAAEC,OAAO,CAAC,CAACP,IAAI,CAAC,iCAAiC,CAAC;IAC1E,CAAC,CAAC;IAEFI,EAAE,CAAC,2DAA2D,EAAE,YAAY;MAC1E,MAAMjB,aAAa,GAAG;QACpBb,SAAS,EAAE,gBAAgB;QAC3BmC,UAAU,EAAE,gBAAgB;QAC5BlC,MAAM,EAAE,GAAG;QACXmC,KAAK,EAAE,mBAAmB;QAC1BtB,MAAM,EAAE;UACNC,QAAQ,EAAE;YACRC,IAAI,EAAE,WAAW;YACjBrB,MAAM,EAAE;UACV,CAAC;UACDsB,IAAI,EAAE;YACJD,IAAI,EAAE,OAAO;YACbrB,MAAM,EAAE;UACV;QACF,CAAC;QACDuB,KAAK,GAAE,mCAAqC;UAC1CR,MAAM,EAAE,SAAS;UACjBS,QAAQ,EAAE;QACZ,CAAC;MACH,CAAC;MACDlC,IAAI,CAACmC,MAAM,CAACrC,iBAAiB,CAAC,CAACsC,qBAAqB,CAAC;QACnDC,OAAO,EAAEzB,kBAAkB;QAC3BU,UAAU;QACVM;MACF,CAAC,CAAC;MACF,MAAM;QAAEU;MAAS,CAAC,GAAG,MAAMvC,cAAc,CAACI,MAAM,EAAEM,OAAO,CAAC;MAE1D8B,MAAM,CAACD,QAAQ,CAACE,UAAU,CAAC,CAACC,IAAI,CAAC7C,WAAW,CAAC8C,SAAS,CAAC;MACvDH,MAAM,CAACD,QAAQ,CAACK,OAAO,CAACC,QAAQ,CAAC,CAACH,IAAI,CAAC,4BAA4B,CAAC;IACtE,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC;;AAEF;AACA;AACA;AACA","ignoreList":[]}

package/.server/server/plugins/engine/services/localFormsService.js

@@ -57,6 +57,12 @@ export const formsService = async () => {
     title: 'Simple Form',
     slug: 'simple-form'
   });
+  await loader.addForm('src/server/forms/payment-test.yaml', {
+    ...metadata,
+    id: 'b2c3d4e5-f6a7-8901-bcde-f01234567890',
+    title: 'Payment Test Form',
+    slug: 'payment-test'
+  });
   return loader.toFormsService();
 };
 //# sourceMappingURL=localFormsService.js.map

package/.server/server/plugins/engine/services/localFormsService.js.map

@@ -1 +1 @@
-{"version":3,"file":"localFormsService.js","names":["config","FileFormService","now","Date","user","id","displayName","author","createdAt","createdBy","updatedAt","updatedBy","metadata","organisation","teamName","teamEmail","submissionGuidance","notificationEmail","get","live","formsService","loader","addForm","title","slug","toFormsService"],"sources":["../../../../../src/server/plugins/engine/services/localFormsService.js"],"sourcesContent":["import { config } from '~/src/config/index.js'\nimport { FileFormService } from '~/src/server/utils/file-form-service.js'\n\n// Create shared form metadata\nconst now = new Date()\nconst user = { id: 'user', displayName: 'Username' }\nconst author = {\n  createdAt: now,\n  createdBy: user,\n  updatedAt: now,\n  updatedBy: user\n}\nconst metadata = {\n  organisation: 'Defra',\n  teamName: 'Team name',\n  teamEmail: 'team@defra.gov.uk',\n  submissionGuidance: \"Thanks for your submission, we'll be in touch\",\n  notificationEmail: config.get('submissionEmailAddress'),\n  ...author,\n  live: author\n}\n\n/**\n * Return an function rather than the service directly. This is to prevent consumer applications\n * blowing up as they won't have these files on disk. We can defer the execution until when it's\n * needed, i.e. the createServer function of the devtool.\n */\nexport const formsService = async () => {\n  // Instantiate the file loader form service\n  const loader = new FileFormService()\n\n  // Add a Yaml form\n  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.yaml', {\n    ...metadata,\n    id: '641aeafd-13dd-40fa-9186-001703800efb',\n    title: 'Register as a unicorn breeder',\n    slug: 'register-as-a-unicorn-breeder'\n  })\n\n  await loader.addForm('src/server/forms/page-events.yaml', {\n    ...metadata,\n    id: '511db05e-ebbd-42e8-8270-5fe93f5c9762',\n    title: 'Page events demo',\n    slug: 'page-events-demo'\n  })\n\n  await loader.addForm('src/server/forms/components.json', {\n    ...metadata,\n    id: '6a872d3b-13f9e-804ce3e-4830-5c45fb32',\n    title: 'Components',\n    slug: 'components'\n  })\n\n  await loader.addForm('src/server/forms/simple-form.yaml', {\n    ...metadata,\n    id: 'a1b2c3d4-e5f6-7890-abcd-ef0123456789',\n    title: 'Simple Form',\n    slug: 'simple-form'\n  })\n\n  return loader.toFormsService()\n}\n"],"mappings":"AAAA,SAASA,MAAM;AACf,SAASC,eAAe;;AAExB;AACA,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;AACtB,MAAMC,IAAI,GAAG;EAAEC,EAAE,EAAE,MAAM;EAAEC,WAAW,EAAE;AAAW,CAAC;AACpD,MAAMC,MAAM,GAAG;EACbC,SAAS,EAAEN,GAAG;EACdO,SAAS,EAAEL,IAAI;EACfM,SAAS,EAAER,GAAG;EACdS,SAAS,EAAEP;AACb,CAAC;AACD,MAAMQ,QAAQ,GAAG;EACfC,YAAY,EAAE,OAAO;EACrBC,QAAQ,EAAE,WAAW;EACrBC,SAAS,EAAE,mBAAmB;EAC9BC,kBAAkB,EAAE,+CAA+C;EACnEC,iBAAiB,EAAEjB,MAAM,CAACkB,GAAG,CAAC,wBAAwB,CAAC;EACvD,GAAGX,MAAM;EACTY,IAAI,EAAEZ;AACR,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMa,YAAY,GAAG,MAAAA,CAAA,KAAY;EACtC;EACA,MAAMC,MAAM,GAAG,IAAIpB,eAAe,CAAC,CAAC;;EAEpC;EACA,MAAMoB,MAAM,CAACC,OAAO,CAAC,qDAAqD,EAAE;IAC1E,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,+BAA+B;IACtCC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMH,MAAM,CAACC,OAAO,CAAC,mCAAmC,EAAE;IACxD,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,kBAAkB;IACzBC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMH,MAAM,CAACC,OAAO,CAAC,kCAAkC,EAAE;IACvD,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,YAAY;IACnBC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMH,MAAM,CAACC,OAAO,CAAC,mCAAmC,EAAE;IACxD,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,aAAa;IACpBC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,OAAOH,MAAM,CAACI,cAAc,CAAC,CAAC;AAChC,CAAC","ignoreList":[]}
+{"version":3,"file":"localFormsService.js","names":["config","FileFormService","now","Date","user","id","displayName","author","createdAt","createdBy","updatedAt","updatedBy","metadata","organisation","teamName","teamEmail","submissionGuidance","notificationEmail","get","live","formsService","loader","addForm","title","slug","toFormsService"],"sources":["../../../../../src/server/plugins/engine/services/localFormsService.js"],"sourcesContent":["import { config } from '~/src/config/index.js'\nimport { FileFormService } from '~/src/server/utils/file-form-service.js'\n\n// Create shared form metadata\nconst now = new Date()\nconst user = { id: 'user', displayName: 'Username' }\nconst author = {\n  createdAt: now,\n  createdBy: user,\n  updatedAt: now,\n  updatedBy: user\n}\nconst metadata = {\n  organisation: 'Defra',\n  teamName: 'Team name',\n  teamEmail: 'team@defra.gov.uk',\n  submissionGuidance: \"Thanks for your submission, we'll be in touch\",\n  notificationEmail: config.get('submissionEmailAddress'),\n  ...author,\n  live: author\n}\n\n/**\n * Return an function rather than the service directly. This is to prevent consumer applications\n * blowing up as they won't have these files on disk. We can defer the execution until when it's\n * needed, i.e. the createServer function of the devtool.\n */\nexport const formsService = async () => {\n  // Instantiate the file loader form service\n  const loader = new FileFormService()\n\n  // Add a Yaml form\n  await loader.addForm('src/server/forms/register-as-a-unicorn-breeder.yaml', {\n    ...metadata,\n    id: '641aeafd-13dd-40fa-9186-001703800efb',\n    title: 'Register as a unicorn breeder',\n    slug: 'register-as-a-unicorn-breeder'\n  })\n\n  await loader.addForm('src/server/forms/page-events.yaml', {\n    ...metadata,\n    id: '511db05e-ebbd-42e8-8270-5fe93f5c9762',\n    title: 'Page events demo',\n    slug: 'page-events-demo'\n  })\n\n  await loader.addForm('src/server/forms/components.json', {\n    ...metadata,\n    id: '6a872d3b-13f9e-804ce3e-4830-5c45fb32',\n    title: 'Components',\n    slug: 'components'\n  })\n\n  await loader.addForm('src/server/forms/simple-form.yaml', {\n    ...metadata,\n    id: 'a1b2c3d4-e5f6-7890-abcd-ef0123456789',\n    title: 'Simple Form',\n    slug: 'simple-form'\n  })\n\n  await loader.addForm('src/server/forms/payment-test.yaml', {\n    ...metadata,\n    id: 'b2c3d4e5-f6a7-8901-bcde-f01234567890',\n    title: 'Payment Test Form',\n    slug: 'payment-test'\n  })\n\n  return loader.toFormsService()\n}\n"],"mappings":"AAAA,SAASA,MAAM;AACf,SAASC,eAAe;;AAExB;AACA,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;AACtB,MAAMC,IAAI,GAAG;EAAEC,EAAE,EAAE,MAAM;EAAEC,WAAW,EAAE;AAAW,CAAC;AACpD,MAAMC,MAAM,GAAG;EACbC,SAAS,EAAEN,GAAG;EACdO,SAAS,EAAEL,IAAI;EACfM,SAAS,EAAER,GAAG;EACdS,SAAS,EAAEP;AACb,CAAC;AACD,MAAMQ,QAAQ,GAAG;EACfC,YAAY,EAAE,OAAO;EACrBC,QAAQ,EAAE,WAAW;EACrBC,SAAS,EAAE,mBAAmB;EAC9BC,kBAAkB,EAAE,+CAA+C;EACnEC,iBAAiB,EAAEjB,MAAM,CAACkB,GAAG,CAAC,wBAAwB,CAAC;EACvD,GAAGX,MAAM;EACTY,IAAI,EAAEZ;AACR,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMa,YAAY,GAAG,MAAAA,CAAA,KAAY;EACtC;EACA,MAAMC,MAAM,GAAG,IAAIpB,eAAe,CAAC,CAAC;;EAEpC;EACA,MAAMoB,MAAM,CAACC,OAAO,CAAC,qDAAqD,EAAE;IAC1E,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,+BAA+B;IACtCC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMH,MAAM,CAACC,OAAO,CAAC,mCAAmC,EAAE;IACxD,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,kBAAkB;IACzBC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMH,MAAM,CAACC,OAAO,CAAC,kCAAkC,EAAE;IACvD,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,YAAY;IACnBC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMH,MAAM,CAACC,OAAO,CAAC,mCAAmC,EAAE;IACxD,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,aAAa;IACpBC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMH,MAAM,CAACC,OAAO,CAAC,oCAAoC,EAAE;IACzD,GAAGV,QAAQ;IACXP,EAAE,EAAE,sCAAsC;IAC1CkB,KAAK,EAAE,mBAAmB;IAC1BC,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,OAAOH,MAAM,CAACI,cAAc,CAAC,CAAC;AAChC,CAAC","ignoreList":[]}

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

@@ -17,6 +17,13 @@ export const formAdapterSubmissionMessageMetaSchema = Joi.object().keys({
 export const formAdapterSubmissionMessageDataSchema = Joi.object().keys({
   main: Joi.object(),
   repeaters: Joi.object(),
+  payment: Joi.object().keys({
+    paymentId: Joi.string().required(),
+    reference: Joi.string().required(),
+    amount: Joi.number().required(),
+    description: Joi.string().required(),
+    createdAt: Joi.string().required()
+  }).optional(),
   files: Joi.object().pattern(Joi.string(), Joi.array().items(Joi.object().keys({
     fileName: Joi.string().required(),
     fileId: Joi.string().required(),

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

@@ -1 +1 @@
-{"version":3,"file":"schema.js","names":["FormStatus","formVersionMetadataSchema","idSchema","notificationEmailAddressSchema","slugSchema","titleSchema","Joi","FormAdapterSubmissionSchemaVersion","formAdapterSubmissionMessageMetaSchema","object","keys","schemaVersion","string","valid","Object","values","timestamp","date","required","referenceNumber","formName","formId","formSlug","status","isPreview","boolean","notificationEmail","versionMetadata","optional","custom","pattern","any","unknown","description","formAdapterSubmissionMessageDataSchema","main","repeaters","files","array","items","fileName","fileId","userDownloadLink","formAdapterSubmissionMessageResultSchema","formAdapterSubmissionMessagePayloadSchema","meta","data","result"],"sources":["../../../../../src/server/plugins/engine/types/schema.ts"],"sourcesContent":["import {\n  FormStatus,\n  formVersionMetadataSchema,\n  idSchema,\n  notificationEmailAddressSchema,\n  slugSchema,\n  titleSchema\n} from '@defra/forms-model'\nimport Joi from 'joi'\n\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessageMeta,\n  type FormAdapterSubmissionMessagePayload,\n  type FormAdapterSubmissionMessageResult\n} from '~/src/server/plugins/engine/types.js'\n\nexport const formAdapterSubmissionMessageMetaSchema =\n  Joi.object<FormAdapterSubmissionMessageMeta>().keys({\n    schemaVersion: Joi.string().valid(\n      ...Object.values(FormAdapterSubmissionSchemaVersion)\n    ),\n    timestamp: Joi.date().required(),\n    referenceNumber: Joi.string().required(),\n    formName: titleSchema,\n    formId: idSchema,\n    formSlug: slugSchema,\n    status: Joi.string()\n      .valid(...Object.values(FormStatus))\n      .required(),\n    isPreview: Joi.boolean().required(),\n    notificationEmail: notificationEmailAddressSchema.required(),\n    versionMetadata: formVersionMetadataSchema.optional(),\n    custom: Joi.object()\n      .pattern(/^/, Joi.any())\n      .unknown()\n      .optional()\n      .description('Custom properties for the message')\n  })\n\nexport const formAdapterSubmissionMessageDataSchema =\n  Joi.object<FormAdapterSubmissionMessageData>().keys({\n    main: Joi.object(),\n    repeaters: Joi.object(),\n    files: Joi.object().pattern(\n      Joi.string(),\n      Joi.array().items(\n        Joi.object().keys({\n          fileName: Joi.string().required(),\n          fileId: Joi.string().required(),\n          userDownloadLink: Joi.string().required()\n        })\n      )\n    )\n  })\n\nexport const formAdapterSubmissionMessageResultSchema =\n  Joi.object<FormAdapterSubmissionMessageResult>().keys({\n    files: Joi.object()\n      .keys({\n        main: Joi.string().required(),\n        repeaters: Joi.object()\n      })\n      .required()\n  })\n\nexport const formAdapterSubmissionMessagePayloadSchema =\n  Joi.object<FormAdapterSubmissionMessagePayload>().keys({\n    meta: formAdapterSubmissionMessageMetaSchema.required(),\n    data: formAdapterSubmissionMessageDataSchema.required(),\n    result: formAdapterSubmissionMessageResultSchema.required()\n  })\n"],"mappings":"AAAA,SACEA,UAAU,EACVC,yBAAyB,EACzBC,QAAQ,EACRC,8BAA8B,EAC9BC,UAAU,EACVC,WAAW,QACN,oBAAoB;AAC3B,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,kCAAkC;AAQ3C,OAAO,MAAMC,sCAAsC,GACjDF,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDC,aAAa,EAAEL,GAAG,CAACM,MAAM,CAAC,CAAC,CAACC,KAAK,CAC/B,GAAGC,MAAM,CAACC,MAAM,CAACR,kCAAkC,CACrD,CAAC;EACDS,SAAS,EAAEV,GAAG,CAACW,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAChCC,eAAe,EAAEb,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;EACxCE,QAAQ,EAAEf,WAAW;EACrBgB,MAAM,EAAEnB,QAAQ;EAChBoB,QAAQ,EAAElB,UAAU;EACpBmB,MAAM,EAAEjB,GAAG,CAACM,MAAM,CAAC,CAAC,CACjBC,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAACf,UAAU,CAAC,CAAC,CACnCkB,QAAQ,CAAC,CAAC;EACbM,SAAS,EAAElB,GAAG,CAACmB,OAAO,CAAC,CAAC,CAACP,QAAQ,CAAC,CAAC;EACnCQ,iBAAiB,EAAEvB,8BAA8B,CAACe,QAAQ,CAAC,CAAC;EAC5DS,eAAe,EAAE1B,yBAAyB,CAAC2B,QAAQ,CAAC,CAAC;EACrDC,MAAM,EAAEvB,GAAG,CAACG,MAAM,CAAC,CAAC,CACjBqB,OAAO,CAAC,GAAG,EAAExB,GAAG,CAACyB,GAAG,CAAC,CAAC,CAAC,CACvBC,OAAO,CAAC,CAAC,CACTJ,QAAQ,CAAC,CAAC,CACVK,WAAW,CAAC,mCAAmC;AACpD,CAAC,CAAC;AAEJ,OAAO,MAAMC,sCAAsC,GACjD5B,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDyB,IAAI,EAAE7B,GAAG,CAACG,MAAM,CAAC,CAAC;EAClB2B,SAAS,EAAE9B,GAAG,CAACG,MAAM,CAAC,CAAC;EACvB4B,KAAK,EAAE/B,GAAG,CAACG,MAAM,CAAC,CAAC,CAACqB,OAAO,CACzBxB,GAAG,CAACM,MAAM,CAAC,CAAC,EACZN,GAAG,CAACgC,KAAK,CAAC,CAAC,CAACC,KAAK,CACfjC,GAAG,CAACG,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;IAChB8B,QAAQ,EAAElC,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IACjCuB,MAAM,EAAEnC,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAC/BwB,gBAAgB,EAAEpC,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC;EAC1C,CAAC,CACH,CACF;AACF,CAAC,CAAC;AAEJ,OAAO,MAAMyB,wCAAwC,GACnDrC,GAAG,CAACG,MAAM,CAAqC,CAAC,CAACC,IAAI,CAAC;EACpD2B,KAAK,EAAE/B,GAAG,CAACG,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;IACJyB,IAAI,EAAE7B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAC7BkB,SAAS,EAAE9B,GAAG,CAACG,MAAM,CAAC;EACxB,CAAC,CAAC,CACDS,QAAQ,CAAC;AACd,CAAC,CAAC;AAEJ,OAAO,MAAM0B,yCAAyC,GACpDtC,GAAG,CAACG,MAAM,CAAsC,CAAC,CAACC,IAAI,CAAC;EACrDmC,IAAI,EAAErC,sCAAsC,CAACU,QAAQ,CAAC,CAAC;EACvD4B,IAAI,EAAEZ,sCAAsC,CAAChB,QAAQ,CAAC,CAAC;EACvD6B,MAAM,EAAEJ,wCAAwC,CAACzB,QAAQ,CAAC;AAC5D,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"schema.js","names":["FormStatus","formVersionMetadataSchema","idSchema","notificationEmailAddressSchema","slugSchema","titleSchema","Joi","FormAdapterSubmissionSchemaVersion","formAdapterSubmissionMessageMetaSchema","object","keys","schemaVersion","string","valid","Object","values","timestamp","date","required","referenceNumber","formName","formId","formSlug","status","isPreview","boolean","notificationEmail","versionMetadata","optional","custom","pattern","any","unknown","description","formAdapterSubmissionMessageDataSchema","main","repeaters","payment","paymentId","reference","amount","number","createdAt","files","array","items","fileName","fileId","userDownloadLink","formAdapterSubmissionMessageResultSchema","formAdapterSubmissionMessagePayloadSchema","meta","data","result"],"sources":["../../../../../src/server/plugins/engine/types/schema.ts"],"sourcesContent":["import {\n  FormStatus,\n  formVersionMetadataSchema,\n  idSchema,\n  notificationEmailAddressSchema,\n  slugSchema,\n  titleSchema\n} from '@defra/forms-model'\nimport Joi from 'joi'\n\nimport { FormAdapterSubmissionSchemaVersion } from '~/src/server/plugins/engine/types/enums.js'\nimport {\n  type FormAdapterSubmissionMessageData,\n  type FormAdapterSubmissionMessageMeta,\n  type FormAdapterSubmissionMessagePayload,\n  type FormAdapterSubmissionMessageResult\n} from '~/src/server/plugins/engine/types.js'\n\nexport const formAdapterSubmissionMessageMetaSchema =\n  Joi.object<FormAdapterSubmissionMessageMeta>().keys({\n    schemaVersion: Joi.string().valid(\n      ...Object.values(FormAdapterSubmissionSchemaVersion)\n    ),\n    timestamp: Joi.date().required(),\n    referenceNumber: Joi.string().required(),\n    formName: titleSchema,\n    formId: idSchema,\n    formSlug: slugSchema,\n    status: Joi.string()\n      .valid(...Object.values(FormStatus))\n      .required(),\n    isPreview: Joi.boolean().required(),\n    notificationEmail: notificationEmailAddressSchema.required(),\n    versionMetadata: formVersionMetadataSchema.optional(),\n    custom: Joi.object()\n      .pattern(/^/, Joi.any())\n      .unknown()\n      .optional()\n      .description('Custom properties for the message')\n  })\n\nexport const formAdapterSubmissionMessageDataSchema =\n  Joi.object<FormAdapterSubmissionMessageData>().keys({\n    main: Joi.object(),\n    repeaters: Joi.object(),\n    payment: Joi.object()\n      .keys({\n        paymentId: Joi.string().required(),\n        reference: Joi.string().required(),\n        amount: Joi.number().required(),\n        description: Joi.string().required(),\n        createdAt: Joi.string().required()\n      })\n      .optional(),\n    files: Joi.object().pattern(\n      Joi.string(),\n      Joi.array().items(\n        Joi.object().keys({\n          fileName: Joi.string().required(),\n          fileId: Joi.string().required(),\n          userDownloadLink: Joi.string().required()\n        })\n      )\n    )\n  })\n\nexport const formAdapterSubmissionMessageResultSchema =\n  Joi.object<FormAdapterSubmissionMessageResult>().keys({\n    files: Joi.object()\n      .keys({\n        main: Joi.string().required(),\n        repeaters: Joi.object()\n      })\n      .required()\n  })\n\nexport const formAdapterSubmissionMessagePayloadSchema =\n  Joi.object<FormAdapterSubmissionMessagePayload>().keys({\n    meta: formAdapterSubmissionMessageMetaSchema.required(),\n    data: formAdapterSubmissionMessageDataSchema.required(),\n    result: formAdapterSubmissionMessageResultSchema.required()\n  })\n"],"mappings":"AAAA,SACEA,UAAU,EACVC,yBAAyB,EACzBC,QAAQ,EACRC,8BAA8B,EAC9BC,UAAU,EACVC,WAAW,QACN,oBAAoB;AAC3B,OAAOC,GAAG,MAAM,KAAK;AAErB,SAASC,kCAAkC;AAQ3C,OAAO,MAAMC,sCAAsC,GACjDF,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDC,aAAa,EAAEL,GAAG,CAACM,MAAM,CAAC,CAAC,CAACC,KAAK,CAC/B,GAAGC,MAAM,CAACC,MAAM,CAACR,kCAAkC,CACrD,CAAC;EACDS,SAAS,EAAEV,GAAG,CAACW,IAAI,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAChCC,eAAe,EAAEb,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;EACxCE,QAAQ,EAAEf,WAAW;EACrBgB,MAAM,EAAEnB,QAAQ;EAChBoB,QAAQ,EAAElB,UAAU;EACpBmB,MAAM,EAAEjB,GAAG,CAACM,MAAM,CAAC,CAAC,CACjBC,KAAK,CAAC,GAAGC,MAAM,CAACC,MAAM,CAACf,UAAU,CAAC,CAAC,CACnCkB,QAAQ,CAAC,CAAC;EACbM,SAAS,EAAElB,GAAG,CAACmB,OAAO,CAAC,CAAC,CAACP,QAAQ,CAAC,CAAC;EACnCQ,iBAAiB,EAAEvB,8BAA8B,CAACe,QAAQ,CAAC,CAAC;EAC5DS,eAAe,EAAE1B,yBAAyB,CAAC2B,QAAQ,CAAC,CAAC;EACrDC,MAAM,EAAEvB,GAAG,CAACG,MAAM,CAAC,CAAC,CACjBqB,OAAO,CAAC,GAAG,EAAExB,GAAG,CAACyB,GAAG,CAAC,CAAC,CAAC,CACvBC,OAAO,CAAC,CAAC,CACTJ,QAAQ,CAAC,CAAC,CACVK,WAAW,CAAC,mCAAmC;AACpD,CAAC,CAAC;AAEJ,OAAO,MAAMC,sCAAsC,GACjD5B,GAAG,CAACG,MAAM,CAAmC,CAAC,CAACC,IAAI,CAAC;EAClDyB,IAAI,EAAE7B,GAAG,CAACG,MAAM,CAAC,CAAC;EAClB2B,SAAS,EAAE9B,GAAG,CAACG,MAAM,CAAC,CAAC;EACvB4B,OAAO,EAAE/B,GAAG,CAACG,MAAM,CAAC,CAAC,CAClBC,IAAI,CAAC;IACJ4B,SAAS,EAAEhC,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAClCqB,SAAS,EAAEjC,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAClCsB,MAAM,EAAElC,GAAG,CAACmC,MAAM,CAAC,CAAC,CAACvB,QAAQ,CAAC,CAAC;IAC/Be,WAAW,EAAE3B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IACpCwB,SAAS,EAAEpC,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC;EACnC,CAAC,CAAC,CACDU,QAAQ,CAAC,CAAC;EACbe,KAAK,EAAErC,GAAG,CAACG,MAAM,CAAC,CAAC,CAACqB,OAAO,CACzBxB,GAAG,CAACM,MAAM,CAAC,CAAC,EACZN,GAAG,CAACsC,KAAK,CAAC,CAAC,CAACC,KAAK,CACfvC,GAAG,CAACG,MAAM,CAAC,CAAC,CAACC,IAAI,CAAC;IAChBoC,QAAQ,EAAExC,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IACjC6B,MAAM,EAAEzC,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAC/B8B,gBAAgB,EAAE1C,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC;EAC1C,CAAC,CACH,CACF;AACF,CAAC,CAAC;AAEJ,OAAO,MAAM+B,wCAAwC,GACnD3C,GAAG,CAACG,MAAM,CAAqC,CAAC,CAACC,IAAI,CAAC;EACpDiC,KAAK,EAAErC,GAAG,CAACG,MAAM,CAAC,CAAC,CAChBC,IAAI,CAAC;IACJyB,IAAI,EAAE7B,GAAG,CAACM,MAAM,CAAC,CAAC,CAACM,QAAQ,CAAC,CAAC;IAC7BkB,SAAS,EAAE9B,GAAG,CAACG,MAAM,CAAC;EACxB,CAAC,CAAC,CACDS,QAAQ,CAAC;AACd,CAAC,CAAC;AAEJ,OAAO,MAAMgC,yCAAyC,GACpD5C,GAAG,CAACG,MAAM,CAAsC,CAAC,CAACC,IAAI,CAAC;EACrDyC,IAAI,EAAE3C,sCAAsC,CAACU,QAAQ,CAAC,CAAC;EACvDkC,IAAI,EAAElB,sCAAsC,CAAChB,QAAQ,CAAC,CAAC;EACvDmC,MAAM,EAAEJ,wCAAwC,CAAC/B,QAAQ,CAAC;AAC5D,CAAC,CAAC","ignoreList":[]}

package/.server/server/plugins/engine/types.d.ts

@@ -3,7 +3,7 @@ import { type PluginProperties, type Request, type ResponseObject } from '@hapi/
 import { type JoiExpression, type ValidationErrorItem } from 'joi';
 import { type UkAddressState } from '~/src/server/plugins/engine/components/UkAddressField.js';
 import { type Component } from '~/src/server/plugins/engine/components/helpers/components.js';
-import { type FileUploadField } from '~/src/server/plugins/engine/components/index.js';
+import { type FileUploadField, type PaymentField } from '~/src/server/plugins/engine/components/index.js';
 import { type BackLink, type ComponentText, type ComponentViewModel, type DatePartsState, type EastingNorthingState, type LatLongState, type MonthYearState } from '~/src/server/plugins/engine/components/types.js';
 import { type FormModel } from '~/src/server/plugins/engine/models/index.js';
 import { type DetailItemField } from '~/src/server/plugins/engine/models/types.js';
@@ -240,6 +240,8 @@ export interface FormPageViewModel extends PageViewModelBase {
     errors?: FormSubmissionError[];
     hasMissingNotificationEmail?: boolean;
     allowSaveAndExit: boolean;
+    showSubmitButton?: boolean;
+    showPaymentExpiredNotification?: boolean;
 }
 export interface RepeaterSummaryPageViewModel extends PageViewModelBase {
     context: FormContext;
@@ -274,6 +276,8 @@ export interface ExternalArgs {
     controller: QuestionPageController;
     sourceUrl: string;
     actionArgs: Record<string, string>;
+    isLive: boolean;
+    isPreview: boolean;
 }
 export interface PostcodeLookupExternalArgs extends ExternalArgs {
     component: UkAddressFieldComponent;
@@ -303,6 +307,7 @@ export interface PluginOptions {
     onRequest?: OnRequestCallback;
     baseUrl: string;
     ordnanceSurveyApiKey?: string;
+    ordnanceSurveyApiSecret?: string;
 }
 export interface FormAdapterSubmissionMessageMeta {
     schemaVersion: FormAdapterSubmissionSchemaVersion;
@@ -327,6 +332,13 @@ export interface FormAdapterFile {
     fileId: string;
     userDownloadLink: string;
 }
+export interface FormAdapterPayment {
+    paymentId: string;
+    reference: string;
+    amount: number;
+    description: string;
+    createdAt: string;
+}
 export interface FormAdapterSubmissionMessageResult {
     files: {
         main: string;
@@ -339,11 +351,18 @@ export interface FormAdapterSubmissionMessageResult {
 export type FileUploadFieldDetailitem = Omit<DetailItemField, 'field'> & {
     field: FileUploadField;
 };
+/**
+ * A detail item specifically for payments
+ */
+export type PaymentFieldDetailItem = Omit<DetailItemField, 'field'> & {
+    field: PaymentField;
+};
 export type RichFormValue = FormValue | FormPayload | DatePartsState | MonthYearState | UkAddressState | EastingNorthingState | LatLongState;
 export interface FormAdapterSubmissionMessageData {
     main: Record<string, RichFormValue | null>;
     repeaters: Record<string, Record<string, RichFormValue>[]>;
     files: Record<string, FormAdapterFile[]>;
+    payment?: FormAdapterPayment;
 }
 export interface FormAdapterSubmissionMessagePayload {
     meta: FormAdapterSubmissionMessageMeta;

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

@@ -43,4 +43,8 @@ export { FileStatus, UploadStatus } from "./types/enums.js";
 /**
  * A detail item specifically for files
  */
+
+/**
+ * A detail item specifically for payments
+ */
 //# sourceMappingURL=types.js.map