@defra/forms-engine-plugin 4.0.61 → 4.1.0

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

@@ -1 +1 @@
-{"version":3,"file":"file-form-service.test.js","names":["join","FormStatus","FileFormService","describe","service","beforeEach","now","Date","user","id","displayName","author","createdAt","createdBy","updatedAt","updatedBy","metadata","organisation","teamName","teamEmail","submissionGuidance","notificationEmail","live","addForm","import","meta","dirname","title","slug","it","getFormMetadata","expect","toBe","toThrow","getFormMetadataById","form","getFormDefinition","name","startPage","interfaceImpl","toFormsService","res1","res2","res3","Draft","readForm","rejects"],"sources":["../../../src/server/utils/file-form-service.test.js"],"sourcesContent":["import { join } from 'node:path'\n\nimport { FormStatus } from '~/src/server/routes/types.js'\nimport { FileFormService } from '~/src/server/utils/file-form-service.js'\n\ndescribe('File-form-service', () => {\n  /** @type {FileFormService} */\n  let service\n  beforeEach(async () => {\n    const now = new Date()\n    const user = { id: 'user', displayName: 'Username' }\n    const author = {\n      createdAt: now,\n      createdBy: user,\n      updatedAt: now,\n      updatedBy: user\n    }\n    service = new FileFormService()\n    const 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: 'email@domain.com',\n      ...author,\n      live: author\n    }\n    await service.addForm(\n      `${join(import.meta.dirname, '../../../test/form/definitions')}/components.json`,\n      {\n        ...metadata,\n        id: '95e92559-968d-44ae-8666-2b1ad3dffd31',\n        title: 'Form test',\n        slug: 'form-test'\n      }\n    )\n  })\n\n  describe('metadata by slug', () => {\n    it('should get form metadata by slug', () => {\n      const meta = service.getFormMetadata('form-test')\n      expect(meta.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(meta.title).toBe('Form test')\n    })\n\n    it('should throw if not found', () => {\n      expect(() => service.getFormMetadata('form-test-missing')).toThrow(\n        \"Form metadata 'form-test-missing' not found\"\n      )\n    })\n  })\n\n  describe('metadata by id', () => {\n    it('should get form metadata by id', () => {\n      const meta = service.getFormMetadataById(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31'\n      )\n      expect(meta.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(meta.title).toBe('Form test')\n    })\n\n    it('should throw if not found', () => {\n      expect(() => service.getFormMetadataById('id-missing')).toThrow(\n        \"Form metadata id 'id-missing' not found\"\n      )\n    })\n  })\n\n  describe('definition by id', () => {\n    it('should get form definition by id', () => {\n      const form = service.getFormDefinition(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31'\n      )\n      expect(form.name).toBe('All components')\n      expect(form.startPage).toBe('/all-components')\n    })\n\n    it('should throw if not found', () => {\n      expect(() => service.getFormDefinition('id-missing')).toThrow(\n        \"Form definition 'id-missing' not found\"\n      )\n    })\n  })\n\n  describe('toFormsService', () => {\n    it('should create interface', async () => {\n      const interfaceImpl = service.toFormsService()\n      const res1 = await interfaceImpl.getFormMetadata('form-test')\n      expect(res1.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(res1.title).toBe('Form test')\n\n      const res2 = await interfaceImpl.getFormMetadataById(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31'\n      )\n      expect(res2.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(res2.title).toBe('Form test')\n\n      const res3 = await interfaceImpl.getFormDefinition(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31',\n        FormStatus.Draft\n      )\n      expect(res3?.name).toBe('All components')\n      expect(res3?.startPage).toBe('/all-components')\n    })\n  })\n\n  describe('readForm', () => {\n    it('should throw if invalid extension', async () => {\n      await expect(\n        service.readForm('/some-folder/some-file.bad')\n      ).rejects.toThrow(\"Invalid file extension '.bad'\")\n    })\n  })\n})\n"],"mappings":"AAAA,SAASA,IAAI,QAAQ,WAAW;AAEhC,SAASC,UAAU;AACnB,SAASC,eAAe;AAExBC,QAAQ,CAAC,mBAAmB,EAAE,MAAM;EAClC;EACA,IAAIC,OAAO;EACXC,UAAU,CAAC,YAAY;IACrB,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;IACtB,MAAMC,IAAI,GAAG;MAAEC,EAAE,EAAE,MAAM;MAAEC,WAAW,EAAE;IAAW,CAAC;IACpD,MAAMC,MAAM,GAAG;MACbC,SAAS,EAAEN,GAAG;MACdO,SAAS,EAAEL,IAAI;MACfM,SAAS,EAAER,GAAG;MACdS,SAAS,EAAEP;IACb,CAAC;IACDJ,OAAO,GAAG,IAAIF,eAAe,CAAC,CAAC;IAC/B,MAAMc,QAAQ,GAAG;MACfC,YAAY,EAAE,OAAO;MACrBC,QAAQ,EAAE,WAAW;MACrBC,SAAS,EAAE,mBAAmB;MAC9BC,kBAAkB,EAAE,+CAA+C;MACnEC,iBAAiB,EAAE,kBAAkB;MACrC,GAAGV,MAAM;MACTW,IAAI,EAAEX;IACR,CAAC;IACD,MAAMP,OAAO,CAACmB,OAAO,CACnB,GAAGvB,IAAI,CAACwB,MAAM,CAACC,IAAI,CAACC,OAAO,EAAE,gCAAgC,CAAC,kBAAkB,EAChF;MACE,GAAGV,QAAQ;MACXP,EAAE,EAAE,sCAAsC;MAC1CkB,KAAK,EAAE,WAAW;MAClBC,IAAI,EAAE;IACR,CACF,CAAC;EACH,CAAC,CAAC;EAEFzB,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjC0B,EAAE,CAAC,kCAAkC,EAAE,MAAM;MAC3C,MAAMJ,IAAI,GAAGrB,OAAO,CAAC0B,eAAe,CAAC,WAAW,CAAC;MACjDC,MAAM,CAACN,IAAI,CAAChB,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACN,IAAI,CAACE,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;IACtC,CAAC,CAAC;IAEFH,EAAE,CAAC,2BAA2B,EAAE,MAAM;MACpCE,MAAM,CAAC,MAAM3B,OAAO,CAAC0B,eAAe,CAAC,mBAAmB,CAAC,CAAC,CAACG,OAAO,CAChE,6CACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM;IAC/B0B,EAAE,CAAC,gCAAgC,EAAE,MAAM;MACzC,MAAMJ,IAAI,GAAGrB,OAAO,CAAC8B,mBAAmB,CACtC,sCACF,CAAC;MACDH,MAAM,CAACN,IAAI,CAAChB,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACN,IAAI,CAACE,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;IACtC,CAAC,CAAC;IAEFH,EAAE,CAAC,2BAA2B,EAAE,MAAM;MACpCE,MAAM,CAAC,MAAM3B,OAAO,CAAC8B,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAACD,OAAO,CAC7D,yCACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF9B,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjC0B,EAAE,CAAC,kCAAkC,EAAE,MAAM;MAC3C,MAAMM,IAAI,GAAG/B,OAAO,CAACgC,iBAAiB,CACpC,sCACF,CAAC;MACDL,MAAM,CAACI,IAAI,CAACE,IAAI,CAAC,CAACL,IAAI,CAAC,gBAAgB,CAAC;MACxCD,MAAM,CAACI,IAAI,CAACG,SAAS,CAAC,CAACN,IAAI,CAAC,iBAAiB,CAAC;IAChD,CAAC,CAAC;IAEFH,EAAE,CAAC,2BAA2B,EAAE,MAAM;MACpCE,MAAM,CAAC,MAAM3B,OAAO,CAACgC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAACH,OAAO,CAC3D,wCACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM;IAC/B0B,EAAE,CAAC,yBAAyB,EAAE,YAAY;MACxC,MAAMU,aAAa,GAAGnC,OAAO,CAACoC,cAAc,CAAC,CAAC;MAC9C,MAAMC,IAAI,GAAG,MAAMF,aAAa,CAACT,eAAe,CAAC,WAAW,CAAC;MAC7DC,MAAM,CAACU,IAAI,CAAChC,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACU,IAAI,CAACd,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;MAEpC,MAAMU,IAAI,GAAG,MAAMH,aAAa,CAACL,mBAAmB,CAClD,sCACF,CAAC;MACDH,MAAM,CAACW,IAAI,CAACjC,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACW,IAAI,CAACf,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;MAEpC,MAAMW,IAAI,GAAG,MAAMJ,aAAa,CAACH,iBAAiB,CAChD,sCAAsC,EACtCnC,UAAU,CAAC2C,KACb,CAAC;MACDb,MAAM,CAACY,IAAI,EAAEN,IAAI,CAAC,CAACL,IAAI,CAAC,gBAAgB,CAAC;MACzCD,MAAM,CAACY,IAAI,EAAEL,SAAS,CAAC,CAACN,IAAI,CAAC,iBAAiB,CAAC;IACjD,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF7B,QAAQ,CAAC,UAAU,EAAE,MAAM;IACzB0B,EAAE,CAAC,mCAAmC,EAAE,YAAY;MAClD,MAAME,MAAM,CACV3B,OAAO,CAACyC,QAAQ,CAAC,4BAA4B,CAC/C,CAAC,CAACC,OAAO,CAACb,OAAO,CAAC,+BAA+B,CAAC;IACpD,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"file-form-service.test.js","names":["join","FormStatus","FileFormService","describe","service","beforeEach","now","Date","user","id","displayName","author","createdAt","createdBy","updatedAt","updatedBy","metadata","organisation","teamName","teamEmail","submissionGuidance","notificationEmail","live","addForm","import","meta","dirname","title","slug","it","getFormMetadata","expect","toBe","toThrow","getFormMetadataById","form","getFormDefinition","name","startPage","interfaceImpl","toFormsService","res1","res2","res3","Draft","res4","getFormSecret","process","env","PAYMENT_PROVIDER_API_KEY_TEST","res5","readForm","rejects"],"sources":["../../../src/server/utils/file-form-service.test.js"],"sourcesContent":["import { join } from 'node:path'\n\nimport { FormStatus } from '~/src/server/routes/types.js'\nimport { FileFormService } from '~/src/server/utils/file-form-service.js'\n\ndescribe('File-form-service', () => {\n  /** @type {FileFormService} */\n  let service\n  beforeEach(async () => {\n    const now = new Date()\n    const user = { id: 'user', displayName: 'Username' }\n    const author = {\n      createdAt: now,\n      createdBy: user,\n      updatedAt: now,\n      updatedBy: user\n    }\n    service = new FileFormService()\n    const 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: 'email@domain.com',\n      ...author,\n      live: author\n    }\n    await service.addForm(\n      `${join(import.meta.dirname, '../../../test/form/definitions')}/components.json`,\n      {\n        ...metadata,\n        id: '95e92559-968d-44ae-8666-2b1ad3dffd31',\n        title: 'Form test',\n        slug: 'form-test'\n      }\n    )\n  })\n\n  describe('metadata by slug', () => {\n    it('should get form metadata by slug', () => {\n      const meta = service.getFormMetadata('form-test')\n      expect(meta.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(meta.title).toBe('Form test')\n    })\n\n    it('should throw if not found', () => {\n      expect(() => service.getFormMetadata('form-test-missing')).toThrow(\n        \"Form metadata 'form-test-missing' not found\"\n      )\n    })\n  })\n\n  describe('metadata by id', () => {\n    it('should get form metadata by id', () => {\n      const meta = service.getFormMetadataById(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31'\n      )\n      expect(meta.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(meta.title).toBe('Form test')\n    })\n\n    it('should throw if not found', () => {\n      expect(() => service.getFormMetadataById('id-missing')).toThrow(\n        \"Form metadata id 'id-missing' not found\"\n      )\n    })\n  })\n\n  describe('definition by id', () => {\n    it('should get form definition by id', () => {\n      const form = service.getFormDefinition(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31'\n      )\n      expect(form.name).toBe('All components')\n      expect(form.startPage).toBe('/all-components')\n    })\n\n    it('should throw if not found', () => {\n      expect(() => service.getFormDefinition('id-missing')).toThrow(\n        \"Form definition 'id-missing' not found\"\n      )\n    })\n  })\n\n  describe('toFormsService', () => {\n    it('should create interface', async () => {\n      const interfaceImpl = service.toFormsService()\n      const res1 = await interfaceImpl.getFormMetadata('form-test')\n      expect(res1.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(res1.title).toBe('Form test')\n\n      const res2 = await interfaceImpl.getFormMetadataById(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31'\n      )\n      expect(res2.id).toBe('95e92559-968d-44ae-8666-2b1ad3dffd31')\n      expect(res2.title).toBe('Form test')\n\n      const res3 = await interfaceImpl.getFormDefinition(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31',\n        FormStatus.Draft\n      )\n      expect(res3?.name).toBe('All components')\n      expect(res3?.startPage).toBe('/all-components')\n\n      const res4 = await interfaceImpl.getFormSecret(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31',\n        'my-secret-name'\n      )\n      expect(res4).toBe('test-api-key')\n\n      delete process.env.PAYMENT_PROVIDER_API_KEY_TEST\n      const res5 = await interfaceImpl.getFormSecret(\n        '95e92559-968d-44ae-8666-2b1ad3dffd31',\n        'my-secret-name'\n      )\n      expect(res5).toBe('')\n    })\n  })\n\n  describe('readForm', () => {\n    it('should throw if invalid extension', async () => {\n      await expect(\n        service.readForm('/some-folder/some-file.bad')\n      ).rejects.toThrow(\"Invalid file extension '.bad'\")\n    })\n  })\n})\n"],"mappings":"AAAA,SAASA,IAAI,QAAQ,WAAW;AAEhC,SAASC,UAAU;AACnB,SAASC,eAAe;AAExBC,QAAQ,CAAC,mBAAmB,EAAE,MAAM;EAClC;EACA,IAAIC,OAAO;EACXC,UAAU,CAAC,YAAY;IACrB,MAAMC,GAAG,GAAG,IAAIC,IAAI,CAAC,CAAC;IACtB,MAAMC,IAAI,GAAG;MAAEC,EAAE,EAAE,MAAM;MAAEC,WAAW,EAAE;IAAW,CAAC;IACpD,MAAMC,MAAM,GAAG;MACbC,SAAS,EAAEN,GAAG;MACdO,SAAS,EAAEL,IAAI;MACfM,SAAS,EAAER,GAAG;MACdS,SAAS,EAAEP;IACb,CAAC;IACDJ,OAAO,GAAG,IAAIF,eAAe,CAAC,CAAC;IAC/B,MAAMc,QAAQ,GAAG;MACfC,YAAY,EAAE,OAAO;MACrBC,QAAQ,EAAE,WAAW;MACrBC,SAAS,EAAE,mBAAmB;MAC9BC,kBAAkB,EAAE,+CAA+C;MACnEC,iBAAiB,EAAE,kBAAkB;MACrC,GAAGV,MAAM;MACTW,IAAI,EAAEX;IACR,CAAC;IACD,MAAMP,OAAO,CAACmB,OAAO,CACnB,GAAGvB,IAAI,CAACwB,MAAM,CAACC,IAAI,CAACC,OAAO,EAAE,gCAAgC,CAAC,kBAAkB,EAChF;MACE,GAAGV,QAAQ;MACXP,EAAE,EAAE,sCAAsC;MAC1CkB,KAAK,EAAE,WAAW;MAClBC,IAAI,EAAE;IACR,CACF,CAAC;EACH,CAAC,CAAC;EAEFzB,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjC0B,EAAE,CAAC,kCAAkC,EAAE,MAAM;MAC3C,MAAMJ,IAAI,GAAGrB,OAAO,CAAC0B,eAAe,CAAC,WAAW,CAAC;MACjDC,MAAM,CAACN,IAAI,CAAChB,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACN,IAAI,CAACE,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;IACtC,CAAC,CAAC;IAEFH,EAAE,CAAC,2BAA2B,EAAE,MAAM;MACpCE,MAAM,CAAC,MAAM3B,OAAO,CAAC0B,eAAe,CAAC,mBAAmB,CAAC,CAAC,CAACG,OAAO,CAChE,6CACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM;IAC/B0B,EAAE,CAAC,gCAAgC,EAAE,MAAM;MACzC,MAAMJ,IAAI,GAAGrB,OAAO,CAAC8B,mBAAmB,CACtC,sCACF,CAAC;MACDH,MAAM,CAACN,IAAI,CAAChB,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACN,IAAI,CAACE,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;IACtC,CAAC,CAAC;IAEFH,EAAE,CAAC,2BAA2B,EAAE,MAAM;MACpCE,MAAM,CAAC,MAAM3B,OAAO,CAAC8B,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAACD,OAAO,CAC7D,yCACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF9B,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IACjC0B,EAAE,CAAC,kCAAkC,EAAE,MAAM;MAC3C,MAAMM,IAAI,GAAG/B,OAAO,CAACgC,iBAAiB,CACpC,sCACF,CAAC;MACDL,MAAM,CAACI,IAAI,CAACE,IAAI,CAAC,CAACL,IAAI,CAAC,gBAAgB,CAAC;MACxCD,MAAM,CAACI,IAAI,CAACG,SAAS,CAAC,CAACN,IAAI,CAAC,iBAAiB,CAAC;IAChD,CAAC,CAAC;IAEFH,EAAE,CAAC,2BAA2B,EAAE,MAAM;MACpCE,MAAM,CAAC,MAAM3B,OAAO,CAACgC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAACH,OAAO,CAC3D,wCACF,CAAC;IACH,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM;IAC/B0B,EAAE,CAAC,yBAAyB,EAAE,YAAY;MACxC,MAAMU,aAAa,GAAGnC,OAAO,CAACoC,cAAc,CAAC,CAAC;MAC9C,MAAMC,IAAI,GAAG,MAAMF,aAAa,CAACT,eAAe,CAAC,WAAW,CAAC;MAC7DC,MAAM,CAACU,IAAI,CAAChC,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACU,IAAI,CAACd,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;MAEpC,MAAMU,IAAI,GAAG,MAAMH,aAAa,CAACL,mBAAmB,CAClD,sCACF,CAAC;MACDH,MAAM,CAACW,IAAI,CAACjC,EAAE,CAAC,CAACuB,IAAI,CAAC,sCAAsC,CAAC;MAC5DD,MAAM,CAACW,IAAI,CAACf,KAAK,CAAC,CAACK,IAAI,CAAC,WAAW,CAAC;MAEpC,MAAMW,IAAI,GAAG,MAAMJ,aAAa,CAACH,iBAAiB,CAChD,sCAAsC,EACtCnC,UAAU,CAAC2C,KACb,CAAC;MACDb,MAAM,CAACY,IAAI,EAAEN,IAAI,CAAC,CAACL,IAAI,CAAC,gBAAgB,CAAC;MACzCD,MAAM,CAACY,IAAI,EAAEL,SAAS,CAAC,CAACN,IAAI,CAAC,iBAAiB,CAAC;MAE/C,MAAMa,IAAI,GAAG,MAAMN,aAAa,CAACO,aAAa,CAC5C,sCAAsC,EACtC,gBACF,CAAC;MACDf,MAAM,CAACc,IAAI,CAAC,CAACb,IAAI,CAAC,cAAc,CAAC;MAEjC,OAAOe,OAAO,CAACC,GAAG,CAACC,6BAA6B;MAChD,MAAMC,IAAI,GAAG,MAAMX,aAAa,CAACO,aAAa,CAC5C,sCAAsC,EACtC,gBACF,CAAC;MACDf,MAAM,CAACmB,IAAI,CAAC,CAAClB,IAAI,CAAC,EAAE,CAAC;IACvB,CAAC,CAAC;EACJ,CAAC,CAAC;EAEF7B,QAAQ,CAAC,UAAU,EAAE,MAAM;IACzB0B,EAAE,CAAC,mCAAmC,EAAE,YAAY;MAClD,MAAME,MAAM,CACV3B,OAAO,CAAC+C,QAAQ,CAAC,4BAA4B,CAC/C,CAAC,CAACC,OAAO,CAACnB,OAAO,CAAC,+BAA+B,CAAC;IACpD,CAAC,CAAC;EACJ,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/.server/typings/hapi/index.d.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.js","names":[],"sources":["../../../src/typings/hapi/index.d.ts"],"sourcesContent":["import { type Plugin } from '@hapi/hapi'\nimport { type ServerYar, type Yar } from '@hapi/yar'\nimport { type Logger } from 'pino'\n\nimport {\n  type COMPONENT_STATE_ERROR,\n  type EXTERNAL_STATE_APPENDAGE,\n  type EXTERNAL_STATE_PAYLOAD\n} from '~/src/server/constants.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type AnyFormRequest,\n  type FormSubmissionError,\n  type PluginOptions\n} from '~/src/server/plugins/engine/types.ts'\nimport { type CacheService } from '~/src/server/services/index.js'\n\ndeclare module '@hapi/yar' {\n  interface YarFlashes {\n    [EXTERNAL_STATE_APPENDAGE]: object\n    [EXTERNAL_STATE_PAYLOAD]: object\n    [COMPONENT_STATE_ERROR]: string\n    [key: string]: { errors: FormSubmissionError[] }\n  }\n}\n\ndeclare module '@hapi/hapi' {\n  // Here we are decorating Hapi interface types with\n  // props from plugins which doesn't export @types\n  interface PluginProperties {\n    crumb: {\n      generate?: (request: AnyRequest) => string\n    }\n    'forms-engine-plugin': {\n      baseLayoutPath: string\n      cacheService: CacheService\n      viewContext?: (\n        request: AnyFormRequest | null\n      ) => Record<string, unknown> | Promise<Record<string, unknown>>\n      saveAndExit?: PluginOptions['saveAndExit']\n      baseUrl: string\n    }\n  }\n\n  interface Request {\n    logger: Logger\n    yar: Yar\n  }\n\n  interface RequestApplicationState {\n    model?: FormModel\n  }\n\n  interface Server {\n    logger: Logger\n    yar: ServerYar\n  }\n\n  interface ServerApplicationState {\n    model?: FormModel\n    models: Map<string, { model: FormModel; updatedAt: Date }>\n  }\n}\n\ndeclare module 'blankie' {\n  declare const blankie: {\n    plugin: Plugin<Record<string, boolean | string | string[]>>\n  }\n\n  export = blankie\n}\n\ndeclare module 'blipp' {\n  declare const blipp: {\n    plugin: Plugin\n  }\n\n  export = blipp\n}\n\ndeclare module 'hapi-pulse' {\n  declare const hapiPulse: {\n    plugin: Plugin<{\n      timeout: number\n    }>\n  }\n\n  export = hapiPulse\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"index.d.js","names":[],"sources":["../../../src/typings/hapi/index.d.ts"],"sourcesContent":["import { type Plugin } from '@hapi/hapi'\nimport { type ServerYar, type Yar } from '@hapi/yar'\nimport { type Logger } from 'pino'\n\nimport {\n  type COMPONENT_STATE_ERROR,\n  type EXTERNAL_STATE_APPENDAGE,\n  type EXTERNAL_STATE_PAYLOAD\n} from '~/src/server/constants.js'\nimport { type FormModel } from '~/src/server/plugins/engine/models/index.js'\nimport {\n  type AnyFormRequest,\n  type FormSubmissionError,\n  type PluginOptions\n} from '~/src/server/plugins/engine/types.ts'\nimport { type CacheService } from '~/src/server/services/index.js'\n\ndeclare module '@hapi/yar' {\n  interface YarFlashes {\n    [EXTERNAL_STATE_APPENDAGE]: object\n    [EXTERNAL_STATE_PAYLOAD]: object\n    [COMPONENT_STATE_ERROR]: string\n    [key: string]: { errors: FormSubmissionError[] }\n  }\n}\n\ndeclare module '@hapi/hapi' {\n  // Here we are decorating Hapi interface types with\n  // props from plugins which doesn't export @types\n  interface PluginProperties {\n    crumb: {\n      generate?: (request: AnyRequest) => string\n    }\n    'forms-engine-plugin': {\n      baseLayoutPath: string\n      cacheService: CacheService\n      viewContext?: (\n        request: AnyFormRequest | null\n      ) => Record<string, unknown> | Promise<Record<string, unknown>>\n      saveAndExit?: PluginOptions['saveAndExit']\n      baseUrl: string\n      services: PluginOptions['services']\n    }\n  }\n\n  interface Request {\n    logger: Logger\n    yar: Yar\n  }\n\n  interface RequestApplicationState {\n    model?: FormModel\n  }\n\n  interface Server {\n    logger: Logger\n    yar: ServerYar\n  }\n\n  interface ServerApplicationState {\n    model?: FormModel\n    models: Map<string, { model: FormModel; updatedAt: Date }>\n  }\n}\n\ndeclare module 'blankie' {\n  declare const blankie: {\n    plugin: Plugin<Record<string, boolean | string | string[]>>\n  }\n\n  export = blankie\n}\n\ndeclare module 'blipp' {\n  declare const blipp: {\n    plugin: Plugin\n  }\n\n  export = blipp\n}\n\ndeclare module 'hapi-pulse' {\n  declare const hapiPulse: {\n    plugin: Plugin<{\n      timeout: number\n    }>\n  }\n\n  export = hapiPulse\n}\n"],"mappings":"","ignoreList":[]}

package/package.json

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

package/src/server/plugins/engine/beta/form-context.test.ts

@@ -150,7 +150,8 @@ describe('getFormModel helper', () => {
       formsService: {
         getFormMetadata: jest.fn().mockResolvedValue(metadata),
         getFormMetadataById: jest.fn(),
-        getFormDefinition: jest.fn().mockResolvedValue(definition)
+        getFormDefinition: jest.fn().mockResolvedValue(definition),
+        getFormSecret: jest.fn()
       },
       formSubmissionService: {
         persistFiles: jest.fn(),

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

@@ -3,6 +3,7 @@ import {
   type FormMetadata,
   type PaymentFieldComponent
 } from '@defra/forms-model'
+import { StatusCodes } from 'http-status-codes'
 
 import { ComponentCollection } from '~/src/server/plugins/engine/components/ComponentCollection.js'
 import { PaymentField } from '~/src/server/plugins/engine/components/PaymentField.js'
@@ -14,18 +15,26 @@ import { FormModel } from '~/src/server/plugins/engine/models/FormModel.js'
 import { PaymentPreAuthError } from '~/src/server/plugins/engine/pageControllers/errors.js'
 import {
   type FormContext,
-  type FormValue
+  type FormValue,
+  type PaymentExternalArgs
 } from '~/src/server/plugins/engine/types.js'
 import {
   type FormRequestPayload,
   type FormResponseToolkit
 } from '~/src/server/routes/types.js'
 import { get, post, postJson } from '~/src/server/services/httpService.js'
+import { type Services } from '~/src/server/types.js'
 import definition from '~/test/form/definitions/blank.js'
 import { getFormData, getFormState } from '~/test/helpers/component-helpers.js'
 
 jest.mock('~/src/server/services/httpService.ts')
 
+const mockServices = {
+  formsService: {
+    getFormSecret: () => 'secret-value'
+  }
+} as unknown as Services
+
 describe('PaymentField', () => {
   let model: FormModel
 
@@ -250,6 +259,7 @@ describe('PaymentField', () => {
 
     const collection = new ComponentCollection([def], { model })
     const paymentField = collection.fields[0] as PaymentField
+    paymentField.model = { services: mockServices } as unknown as FormModel
 
     describe('dispatcher', () => {
       it('should create payment and redirect to gov pay', async () => {
@@ -277,7 +287,8 @@ describe('PaymentField', () => {
             model: {
               formId: 'formid',
               basePath: 'base-path',
-              name: 'PaymentModel'
+              name: 'PaymentModel',
+              services: mockServices
             },
             getState: jest
               .fn()
@@ -287,7 +298,7 @@ describe('PaymentField', () => {
           sourceUrl: 'http://localhost:3009/test-payment',
           isLive: false,
           isPreview: true
-        }
+        } as unknown as PaymentExternalArgs
         // @ts-expect-error - partial mock
         jest.mocked(postJson).mockResolvedValueOnce({
           payload: {
@@ -342,7 +353,8 @@ describe('PaymentField', () => {
             model: {
               formId: 'formid',
               basePath: 'base-path',
-              name: 'PaymentModel'
+              name: 'PaymentModel',
+              services: mockServices
             },
             getState: jest.fn().mockResolvedValueOnce({
               $$__referenceNumber: 'pay-ref-123',
@@ -361,7 +373,7 @@ describe('PaymentField', () => {
           sourceUrl: 'http://localhost:3009/test-payment',
           isLive: false,
           isPreview: true
-        }
+        } as unknown as PaymentExternalArgs
 
         const res = await PaymentField.dispatcher(mockRequest, mockH, args)
 
@@ -372,6 +384,128 @@ describe('PaymentField', () => {
         expect(mockRedirectCode).toHaveBeenCalledWith(303)
         expect(postJson).not.toHaveBeenCalled()
       })
+
+      it('should display error if create payment fails (e.g. network or bad api key) - test payment', async () => {
+        const mockYarSet = jest.fn()
+        const mockYarFlash = jest.fn()
+        const mockRequest = {
+          server: {
+            plugins: {
+              // eslint-disable-next-line no-useless-computed-key
+              ['forms-engine-plugin']: {
+                baseUrl: 'base-url'
+              }
+            }
+          },
+          yar: {
+            set: mockYarSet,
+            flash: mockYarFlash
+          },
+          url: {
+            href: '/here'
+          }
+        } as unknown as FormRequestPayload
+        const mockH = {
+          redirect: jest
+            .fn()
+            .mockReturnValueOnce({ code: jest.fn().mockReturnValueOnce('ok') })
+        } as unknown as FormResponseToolkit
+        const args = {
+          controller: {
+            model: {
+              formId: 'formid',
+              basePath: 'base-path',
+              name: 'PaymentModel',
+              services: mockServices
+            },
+            getState: jest
+              .fn()
+              .mockResolvedValueOnce({ $$__referenceNumber: 'pay-ref-123' })
+          },
+          component: paymentField,
+          sourceUrl: 'http://localhost:3009/test-payment',
+          isLive: false,
+          isPreview: true
+        } as unknown as PaymentExternalArgs
+        jest.mocked(postJson).mockImplementationOnce(() => {
+          // eslint-disable-next-line @typescript-eslint/only-throw-error
+          throw { output: { statusCode: StatusCodes.UNAUTHORIZED } }
+        })
+
+        const res = await PaymentField.dispatcher(mockRequest, mockH, args)
+        expect(res).toBe('ok')
+        expect(mockYarSet).not.toHaveBeenCalled()
+        expect(mockYarFlash).toHaveBeenCalledWith(
+          'COMPONENT_STATE_ERROR',
+          {
+            href: '#myComponent',
+            name: 'myComponent',
+            text: 'Add a valid test API key before you can preview the payment journey.'
+          },
+          true
+        )
+      })
+
+      it('should display error if create payment fails (e.g. network or bad api key) - live payment', async () => {
+        const mockYarSet = jest.fn()
+        const mockYarFlash = jest.fn()
+        const mockRequest = {
+          server: {
+            plugins: {
+              // eslint-disable-next-line no-useless-computed-key
+              ['forms-engine-plugin']: {
+                baseUrl: 'base-url'
+              }
+            }
+          },
+          yar: {
+            set: mockYarSet,
+            flash: mockYarFlash
+          },
+          url: {
+            href: '/here'
+          }
+        } as unknown as FormRequestPayload
+        const mockH = {
+          redirect: jest
+            .fn()
+            .mockReturnValueOnce({ code: jest.fn().mockReturnValueOnce('ok') })
+        } as unknown as FormResponseToolkit
+        const args = {
+          controller: {
+            model: {
+              formId: 'formid',
+              basePath: 'base-path',
+              name: 'PaymentModel',
+              services: mockServices
+            },
+            getState: jest
+              .fn()
+              .mockResolvedValueOnce({ $$__referenceNumber: 'pay-ref-123' })
+          },
+          component: paymentField,
+          sourceUrl: 'http://localhost:3009/test-payment',
+          isLive: true,
+          isPreview: false
+        } as unknown as PaymentExternalArgs
+        jest.mocked(postJson).mockImplementationOnce(() => {
+          // eslint-disable-next-line @typescript-eslint/only-throw-error
+          throw { output: { statusCode: StatusCodes.UNAUTHORIZED } }
+        })
+
+        const res = await PaymentField.dispatcher(mockRequest, mockH, args)
+        expect(res).toBe('ok')
+        expect(mockYarSet).not.toHaveBeenCalled()
+        expect(mockYarFlash).toHaveBeenCalledWith(
+          'COMPONENT_STATE_ERROR',
+          {
+            href: '#myComponent',
+            name: 'myComponent',
+            text: '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.'
+          },
+          true
+        )
+      })
     })
 
     describe('onSubmit', () => {

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

@@ -7,16 +7,19 @@ import {
 import { StatusCodes } from 'http-status-codes'
 import joi, { type ObjectSchema } from 'joi'
 
+import { COMPONENT_STATE_ERROR } from '~/src/server/constants.js'
 import { FormComponent } from '~/src/server/plugins/engine/components/FormComponent.js'
 import { type PaymentState } from '~/src/server/plugins/engine/components/PaymentField.types.js'
-import { getPluginOptions } from '~/src/server/plugins/engine/helpers.js'
+import {
+  createError,
+  getPluginOptions
+} from '~/src/server/plugins/engine/helpers.js'
 import {
   PaymentErrorTypes,
   PaymentPreAuthError,
   PaymentSubmissionError
 } from '~/src/server/plugins/engine/pageControllers/errors.js'
 import {
-  type AnyFormRequest,
   type FormContext,
   type FormRequestPayload,
   type FormResponseToolkit
@@ -27,7 +30,8 @@ import {
   type FormState,
   type FormStateValue,
   type FormSubmissionError,
-  type FormSubmissionState
+  type FormSubmissionState,
+  type PaymentExternalArgs
 } from '~/src/server/plugins/engine/types.js'
 import {
   createPaymentService,
@@ -186,7 +190,7 @@ export class PaymentField extends FormComponent {
   static async dispatcher(
     request: FormRequestPayload,
     h: FormResponseToolkit,
-    args: PaymentDispatcherArgs
+    args: PaymentExternalArgs
   ): Promise<unknown> {
     const { options, name: componentName } = args.component
     const { model } = args.controller
@@ -205,7 +209,12 @@ export class PaymentField extends FormComponent {
 
     const isLivePayment = args.isLive && !args.isPreview
     const formId = args.controller.model.formId
-    const paymentService = createPaymentService(isLivePayment, formId)
+    const formsService = model.services.formsService
+    const paymentService = await createPaymentService(
+      isLivePayment,
+      formId,
+      formsService
+    )
 
     const uuid = randomUUID()
 
@@ -229,6 +238,15 @@ export class PaymentField extends FormComponent {
       { formId, slug }
     )
 
+    if (!payment) {
+      const message = isLivePayment
+        ? '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.'
+        : 'Add a valid test API key before you can preview the payment journey.'
+      const govukError = createError(componentName, message)
+      request.yar.flash(COMPONENT_STATE_ERROR, govukError, true)
+      return h.redirect(request.url.href).code(StatusCodes.SEE_OTHER)
+    }
+
     const sessionData: PaymentSessionData = {
       uuid,
       formId,
@@ -272,7 +290,12 @@ export class PaymentField extends FormComponent {
     }
 
     const { paymentId, isLivePayment, formId } = paymentState
-    const paymentService = createPaymentService(isLivePayment, formId)
+    const formsService = this.model.services.formsService
+    const paymentService = await createPaymentService(
+      isLivePayment,
+      formId,
+      formsService
+    )
 
     /**
      * @see https://docs.payments.service.gov.uk/api_reference/#payment-status-lifecycle
@@ -343,21 +366,6 @@ export class PaymentField extends FormComponent {
   }
 }
 
-export interface PaymentDispatcherArgs {
-  controller: {
-    model: {
-      formId: string
-      basePath: string
-      name: string
-    }
-    getState: (request: AnyFormRequest) => Promise<FormSubmissionState>
-  }
-  component: PaymentField
-  sourceUrl: string
-  isLive: boolean
-  isPreview: boolean
-}
-
 /**
  * Session data stored when dispatching to GOV.UK Pay
  */

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

@@ -41,7 +41,8 @@ export const plugin = {
       onRequest,
       ordnanceSurveyApiKey,
       baseUrl,
-      ordnanceSurveyApiSecret
+      ordnanceSurveyApiSecret,
+      services
     } = options
 
     const cacheService =
@@ -77,6 +78,7 @@ export const plugin = {
     server.expose('cacheService', cacheService)
     server.expose('saveAndExit', saveAndExit)
     server.expose('baseUrl', baseUrl)
+    server.expose('services', services)
 
     server.app.model = model
 

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

@@ -1,16 +1,16 @@
 import Boom from '@hapi/boom'
 
 import { PAYMENT_SESSION_PREFIX } from '~/src/server/plugins/engine/routes/payment.js'
-import { getPaymentApiKey } from '~/src/server/plugins/payment/helper.js'
-import { PaymentService } from '~/src/server/plugins/payment/service.js'
+import { createPaymentService } from '~/src/server/plugins/payment/helper.js'
 
 /**
  * Validates session data and retrieves payment status
  * @param {Request} request - the request
  * @param {string} uuid - the payment UUID
+ * @param {FormsService} formsService - the forms service
  * @returns {Promise<{ session: PaymentSessionData, sessionKey: string, paymentStatus: GetPaymentResponse }>}
  */
-export async function getPaymentContext(request, uuid) {
+export async function getPaymentContext(request, uuid, formsService) {
   const sessionKey = `${PAYMENT_SESSION_PREFIX}${uuid}`
   const session = /** @type {PaymentSessionData | null} */ (
     request.yar.get(sessionKey)
@@ -26,8 +26,11 @@ export async function getPaymentContext(request, uuid) {
     throw Boom.badRequest('No paymentId in session')
   }
 
-  const apiKey = getPaymentApiKey(isLivePayment, formId)
-  const paymentService = new PaymentService(apiKey)
+  const paymentService = await createPaymentService(
+    isLivePayment,
+    formId,
+    formsService
+  )
   const paymentStatus = await paymentService.getPaymentStatus(
     paymentId,
     isLivePayment
@@ -73,4 +76,5 @@ export function convertPenceToPounds(amount) {
 /**
  * @import { Request } from '@hapi/hapi'
  * @import { GetPaymentResponse, PaymentSessionData } from '~/src/server/plugins/payment/types.js'
+ * @import { FormsService } from '~/src/server/types.js'
  */

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

@@ -64,8 +64,11 @@ describe('payment helper', () => {
       error: undefined
     })
 
+    const mockFormsService = {
+      getFormSecret: () => 'secret-value'
+    }
     // @ts-expect-error - partial request mock
-    const res = await getPaymentContext(mockRequest, uuid)
+    const res = await getPaymentContext(mockRequest, uuid, mockFormsService)
     expect(res).toEqual({
       paymentStatus: {
         paymentId: 'payment-id-12345',

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

@@ -4,6 +4,7 @@ import Joi from 'joi'
 
 import { createLogger } from '~/src/server/common/helpers/logging/logger.js'
 import { EXTERNAL_STATE_APPENDAGE } from '~/src/server/constants.js'
+import { getPluginOptions } from '~/src/server/plugins/engine/helpers.js'
 import {
   buildPaymentInfo,
   convertPenceToPounds,
@@ -128,9 +129,13 @@ function getReturnRoute() {
     path: PAYMENT_RETURN_PATH,
     async handler(request, h) {
       const { uuid } = /** @type {{ uuid: string }} */ (request.query)
+
+      const { services } = getPluginOptions(request.server)
+
       const { session, sessionKey, paymentStatus } = await getPaymentContext(
         request,
-        uuid
+        uuid,
+        /** @type {FormsService} */ (services?.formsService)
       )
 
       /**
@@ -193,4 +198,6 @@ function getReturnRoute() {
  * @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'
+ * @import { PluginOptions } from '~/src/server/plugins/engine/types.js'
+ * @import { FormsService } from '~/src/server/types.js'
  */

package/src/server/plugins/engine/services/formsService.js

@@ -33,6 +33,17 @@ export function getFormDefinition(_id, _state) {
   throw error
 }
 
+// eslint-disable-next-line jsdoc/require-returns-check
+/**
+ * Dummy function to get a form secret.
+ * @param {string} _id - the id of the form
+ * @param {string} _secretName - the name of the secret
+ * @returns {Promise<string>}
+ */
+export function getFormSecret(_id, _secretName) {
+  throw error
+}
+
 /**
  * @import { FormStatus, FormDefinition, FormMetadata } from '@defra/forms-model'
  */

package/src/server/plugins/engine/services/formsService.test.js

@@ -3,7 +3,8 @@ import { FormStatus } from '@defra/forms-model'
 import {
   getFormDefinition,
   getFormMetadata,
-  getFormMetadataById
+  getFormMetadataById,
+  getFormSecret
 } from '~/src/server/plugins/engine/services/formsService.js'
 
 describe('formsService', () => {
@@ -18,4 +19,8 @@ describe('formsService', () => {
   it('getFormDefinition should throw error', () => {
     expect(() => getFormDefinition('id', FormStatus.Draft)).toThrow()
   })
+
+  it('getFormSecret should throw error', () => {
+    expect(() => getFormSecret('id', 'my-secret-name')).toThrow()
+  })
 })

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

@@ -5,6 +5,7 @@ import {
   type Item,
   type List,
   type Page,
+  type PaymentFieldComponent,
   type UkAddressFieldComponent
 } from '@defra/forms-model'
 import {
@@ -397,7 +398,7 @@ export interface ExternalArgs {
   component: ComponentDef
   controller: QuestionPageController
   sourceUrl: string
-  actionArgs: Record<string, string>
+  actionArgs?: Record<string, string>
   isLive: boolean
   isPreview: boolean
 }
@@ -407,6 +408,10 @@ export interface PostcodeLookupExternalArgs extends ExternalArgs {
   actionArgs: { step: string }
 }
 
+export interface PaymentExternalArgs extends ExternalArgs {
+  component: PaymentFieldComponent
+}
+
 export interface ExternalStateAppendage {
   component: string
   data: FormStateValue | FormState

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

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

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

@@ -1,39 +1,8 @@
-import { config } from '~/src/config/index.js'
 import {
   formatCurrency,
-  formatPaymentDate,
-  getPaymentApiKey
+  formatPaymentDate
 } from '~/src/server/plugins/payment/helper.js'
 
-describe('getPaymentApiKey', () => {
-  config.set('paymentProviderApiKeyTest', 'TEST-API-KEY')
-  const formId = 'form-id'
-  process.env['PAYMENT_PROVIDER_API_KEY_LIVE_form-id'] = 'LIVE-API-KEY'
-  process.env['PAYMENT_PROVIDER_API_KEY_TEST_form-id'] = 'TEST-API-KEY'
-
-  it('should read test key when non-live form', () => {
-    const apiKey = getPaymentApiKey(false, formId)
-    expect(apiKey).toBe('TEST-API-KEY')
-  })
-
-  it('should read live key when live form', () => {
-    const apiKey = getPaymentApiKey(true, formId)
-    expect(apiKey).toBe('LIVE-API-KEY')
-  })
-
-  it('should throw if TEST key is missing', () => {
-    expect(() => getPaymentApiKey(false, 'form-id-missing')).toThrow(
-      'Missing payment api key for test form id form-id-missing'
-    )
-  })
-
-  it('should throw if LIVE key is missing', () => {
-    expect(() => getPaymentApiKey(true, 'form-id-missing')).toThrow(
-      'Missing payment api key for live form id form-id-missing'
-    )
-  })
-})
-
 describe('formatPaymentDate', () => {
   it('should format ISO date string to en-GB format', () => {
     const result = formatPaymentDate('2025-11-10T17:01:29.000Z')