@defra-fish/sales-api-service 1.60.0 → 1.61.0-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.60.0",
+  "version": "1.61.0-rc.0",
   "description": "Rod Licensing Sales API",
   "type": "module",
   "engines": {
@@ -35,9 +35,9 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@defra-fish/business-rules-lib": "1.60.0",
-    "@defra-fish/connectors-lib": "1.60.0",
-    "@defra-fish/dynamics-lib": "1.60.0",
+    "@defra-fish/business-rules-lib": "1.61.0-rc.0",
+    "@defra-fish/connectors-lib": "1.61.0-rc.0",
+    "@defra-fish/dynamics-lib": "1.61.0-rc.0",
     "@hapi/boom": "^9.1.2",
     "@hapi/hapi": "^20.1.3",
     "@hapi/inert": "^6.0.3",
@@ -52,5 +52,5 @@
     "moment-timezone": "^0.5.34",
     "uuid": "^8.3.2"
   },
-  "gitHead": "417b6030d76dace0415cf9b4d1e7cddecb93df99"
+  "gitHead": "67185f8a721c75f38052b63bdb92a5549622367c"
 }

package/src/schema/__tests__/recurring-payments.schema.spec.js

@@ -1,11 +1,15 @@
-import { dueRecurringPaymentsResponseSchema } from '../recurring-payments.schema.js'
+import {
+  dueRecurringPaymentsRequestParamsSchema,
+  dueRecurringPaymentsResponseSchema,
+  processRPResultRequestParamsSchema
+} from '../recurring-payments.schema.js'
 
 jest.mock('../validators/validators.js', () => ({
   ...jest.requireActual('../validators/validators.js'),
   createEntityIdValidator: () => () => {} // sample data so we don't want it validated for being a real entity id
 }))
 
-const getSampleData = () => ({
+const getResponseSampleData = () => ({
   id: 'd5549fc6-41c1-ef11-b8e8-7c1e52215dc9',
   name: 'test',
   status: 0,
@@ -52,9 +56,15 @@ const getSampleData = () => ({
   }
 })
 
+const getProcessRPResultSampleData = () => ({
+  transactionId: 'abc123',
+  paymentId: 'def456',
+  createdDate: '2025-01-01T00:00:00.000Z'
+})
+
 describe('getDueRecurringPaymentsSchema', () => {
   it('validates expected object', async () => {
-    await expect(() => dueRecurringPaymentsResponseSchema.validateAsync(getSampleData())).not.toThrow()
+    expect(() => dueRecurringPaymentsResponseSchema.validateAsync(getResponseSampleData())).not.toThrow()
   })
 
   it.each([
@@ -70,7 +80,7 @@ describe('getDueRecurringPaymentsSchema', () => {
     'contactId',
     'publicId'
   ])('throws an error if %s is missing', async property => {
-    const sampleData = getSampleData()
+    const sampleData = getResponseSampleData()
     delete sampleData[property]
     expect(() => dueRecurringPaymentsResponseSchema.validateAsync(sampleData)).rejects.toThrow()
   })
@@ -88,7 +98,7 @@ describe('getDueRecurringPaymentsSchema', () => {
     ['contactId', 'still-not-a-guid'],
     ['publicId', 99]
   ])('throws an error if %s is not the correct type', async (property, value) => {
-    const sampleData = getSampleData()
+    const sampleData = getResponseSampleData()
     sampleData[property] = value
     expect(() => dueRecurringPaymentsResponseSchema.validateAsync(sampleData)).rejects.toThrow()
   })
@@ -97,3 +107,45 @@ describe('getDueRecurringPaymentsSchema', () => {
     expect(dueRecurringPaymentsResponseSchema).toMatchSnapshot()
   })
 })
+
+describe('dueRecurringPaymentsRequestParamsSchema', () => {
+  it('validates expected object', async () => {
+    const sampleData = {
+      date: '2024-12-23'
+    }
+    expect(() => dueRecurringPaymentsRequestParamsSchema.validateAsync(sampleData)).not.toThrow()
+  })
+
+  it('throws an error if date missing', async () => {
+    expect(() => dueRecurringPaymentsRequestParamsSchema.validateAsync({}).rejects.toThrow())
+  })
+
+  it('throws an error if date is not the correct type', async () => {
+    const sampleData = {
+      date: 'not-a-date'
+    }
+    expect(() => dueRecurringPaymentsRequestParamsSchema.validateAsync(sampleData).rejects.toThrow())
+  })
+})
+
+describe('processRPResultRequestParamsSchema', () => {
+  it('validates expected object', async () => {
+    expect(() => processRPResultRequestParamsSchema.validateAsync(getProcessRPResultSampleData())).not.toThrow()
+  })
+
+  it.each([['transactionId'], ['paymentId'], ['createdDate']])('throws an error if %s is missing', async property => {
+    const sampleData = getProcessRPResultSampleData()
+    delete sampleData[property]
+    expect(() => processRPResultRequestParamsSchema.validateAsync(sampleData).rejects.toThrow())
+  })
+
+  it.each([
+    ['transactionId', 99],
+    ['paymentId', 99],
+    ['createdDate', 'not-a-date']
+  ])('throws an error if %s is not the correct type', async (property, value) => {
+    const sampleData = getProcessRPResultSampleData()
+    sampleData[property] = value
+    expect(() => processRPResultRequestParamsSchema.validateAsync(sampleData).rejects.toThrow())
+  })
+})

package/src/schema/recurring-payments.schema.js

@@ -19,3 +19,13 @@ export const dueRecurringPaymentsResponseSchema = Joi.object({
     activePermission: { entity: finalisedPermissionSchemaContent }
   })
 })
+
+export const dueRecurringPaymentsRequestParamsSchema = Joi.object({
+  date: Joi.string().isoDate().required()
+})
+
+export const processRPResultRequestParamsSchema = Joi.object({
+  transactionId: Joi.string().required(),
+  paymentId: Joi.string().required(),
+  createdDate: Joi.string().isoDate().required()
+})

package/src/server/routes/__tests__/recurring-payments.spec.js

@@ -1,5 +1,6 @@
 import recurringPayments from '../recurring-payments.js'
 import { getRecurringPayments, processRPResult } from '../../../services/recurring-payments.service.js'
+import { dueRecurringPaymentsRequestParamsSchema, processRPResultRequestParamsSchema } from '../../../schema/recurring-payments.schema.js'
 
 const [
   {
@@ -15,6 +16,11 @@ jest.mock('../../../services/recurring-payments.service.js', () => ({
   processRPResult: jest.fn()
 }))
 
+jest.mock('../../../schema/recurring-payments.schema.js', () => ({
+  dueRecurringPaymentsRequestParamsSchema: jest.fn(),
+  processRPResultRequestParamsSchema: jest.fn()
+}))
+
 const getMockRequest = ({
   date = '2023-10-19',
   transactionId = 'transaction-id',
@@ -44,6 +50,13 @@ describe('recurring payments', () => {
       await drpHandler(request, getMockResponseToolkit())
       expect(getRecurringPayments).toHaveBeenCalledWith(date)
     })
+
+    it('should validate with dueRecurringPaymentsRequestParamsSchema', async () => {
+      const date = Symbol('date')
+      const request = getMockRequest({ date })
+      await drpHandler(request, getMockResponseToolkit())
+      expect(recurringPayments[0].options.validate.params).toBe(dueRecurringPaymentsRequestParamsSchema)
+    })
   })
 
   describe('processRPResult', () => {
@@ -61,5 +74,12 @@ describe('recurring payments', () => {
       await prpHandler(request, getMockResponseToolkit())
       expect(processRPResult).toHaveBeenCalledWith(transactionId, paymentId, createdDate)
     })
+
+    it('should validate with dueRecurringPaymentsRequestParamsSchema', async () => {
+      const date = Symbol('date')
+      const request = getMockRequest({ date })
+      await drpHandler(request, getMockResponseToolkit())
+      expect(recurringPayments[1].options.validate.params).toBe(processRPResultRequestParamsSchema)
+    })
   })
 })

package/src/server/routes/recurring-payments.js

@@ -1,4 +1,8 @@
-import { dueRecurringPaymentsResponseSchema } from '../../schema/recurring-payments.schema.js'
+import {
+  dueRecurringPaymentsRequestParamsSchema,
+  dueRecurringPaymentsResponseSchema,
+  processRPResultRequestParamsSchema
+} from '../../schema/recurring-payments.schema.js'
 import { getRecurringPayments, processRPResult } from '../../services/recurring-payments.service.js'
 
 export default [
@@ -13,6 +17,9 @@ export default [
       },
       description: 'Retrieve recurring payments due for the specified date',
       tags: ['api', 'recurring-payments'],
+      validate: {
+        params: dueRecurringPaymentsRequestParamsSchema
+      },
       plugins: {
         'hapi-swagger': {
           responses: {
@@ -34,6 +41,9 @@ export default [
       },
       description: 'Generate a permission from a recurring payment record',
       tags: ['api', 'recurring-payments'],
+      validate: {
+        params: processRPResultRequestParamsSchema
+      },
       plugins: {
         'hapi-swagger': {
           responses: {