@defra-fish/sales-api-service 1.59.0-rc.0 → 1.59.0-rc.1

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

@@ -0,0 +1,99 @@
+import { dueRecurringPaymentsResponseSchema } 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 = () => ({
+  id: 'd5549fc6-41c1-ef11-b8e8-7c1e52215dc9',
+  name: 'test',
+  status: 0,
+  nextDueDate: '2025-01-22T00:00:00.000Z',
+  cancelledDate: null,
+  cancelledReason: null,
+  endDate: '2025-12-22T23:59:59.000Z',
+  agreementId: 'c756d22b-0003-4e24-a922-009f358852bd',
+  activePermission: 'cb549fc6-41c1-ef11-b8e8-7c1e52215dc9',
+  contactId: 'bf549fc6-41c1-ef11-b8e8-7c1e52215dc9',
+  publicId: 'q/kJYJrYNt/PkVbWChugMRSSxoDEttw1ownaNzDDyEw=',
+  expanded: {
+    contact: {
+      entity: {
+        id: 'bf549fc6-41c1-ef11-b8e8-7c1e52215dc9',
+        firstName: 'Recurring',
+        lastName: 'Test',
+        birthDate: '1991-01-01',
+        email: 'recurring.test@hotmail.com',
+        mobilePhone: null,
+        organisation: null,
+        premises: '1',
+        street: 'Catharine Place',
+        locality: null,
+        town: 'Bath',
+        postcode: 'BA1 2PR'
+      }
+    },
+    activePermission: {
+      entity: {
+        id: 'cb549fc6-41c1-ef11-b8e8-7c1e52215dc9',
+        referenceNumber: '23221225-2WC3FRT-ADQFJ6',
+        issueDate: '2024-12-23T15:22:49.000Z',
+        startDate: '2024-12-23T15:52:49.000Z',
+        endDate: '2025-12-22T23:59:59.000Z',
+        stagingId: 'a544cc77-156c-40e7-9c69-02e70829341d',
+        dataSource: {
+          id: 910400003,
+          label: 'Web Sales',
+          description: 'Web Sales'
+        }
+      }
+    }
+  }
+})
+
+describe('getDueRecurringPaymentsSchema', () => {
+  it('validates expected object', async () => {
+    await expect(() => dueRecurringPaymentsResponseSchema.validateAsync(getSampleData())).not.toThrow()
+  })
+
+  it.each([
+    'id',
+    'name',
+    'status',
+    'nextDueDate',
+    'cancelledDate',
+    'cancelledReason',
+    'endDate',
+    'agreementId',
+    'activePermission',
+    'contactId',
+    'publicId'
+  ])('throws an error if %s is missing', async property => {
+    const sampleData = getSampleData()
+    delete sampleData[property]
+    expect(() => dueRecurringPaymentsResponseSchema.validateAsync(sampleData)).rejects.toThrow()
+  })
+
+  it.each([
+    ['id', 'not-a-guid'],
+    ['name', 99],
+    ['status', 'not-a-number'],
+    ['nextDueDate', 'not-a-date'],
+    ['cancelledDate', 'not-a-date'],
+    ['cancelledReason', 99],
+    ['endDate', 'not-a-date'],
+    ['agreementId', 'not-a-guid'],
+    ['activePermission', 'not-a-guid'],
+    ['contactId', 'still-not-a-guid'],
+    ['publicId', 99]
+  ])('throws an error if %s is not the correct type', async (property, value) => {
+    const sampleData = getSampleData()
+    sampleData[property] = value
+    expect(() => dueRecurringPaymentsResponseSchema.validateAsync(sampleData)).rejects.toThrow()
+  })
+
+  it('snapshot test schema', async () => {
+    expect(dueRecurringPaymentsResponseSchema).toMatchSnapshot()
+  })
+})

package/src/schema/permission.schema.js

@@ -5,25 +5,25 @@ import { optionSetOption } from './option-set.schema.js'
 import { createReferenceDataEntityValidator } from './validators/validators.js'
 import { Permit } from '@defra-fish/dynamics-lib'
 import { validation } from '@defra-fish/business-rules-lib'
-import { v4 as uuid } from 'uuid'
 
+const DATE_EXAMPLE = '2025-01-01T00:00:00.000Z'
 const issueDateSchema = Joi.string()
   .isoDate()
   .required()
   .allow(null)
   .description('An ISO8601 compatible date string defining when the permission was issued')
-  .example(new Date().toISOString())
+  .example(DATE_EXAMPLE)
 const startDateSchema = Joi.string()
   .isoDate()
   .required()
   .allow(null)
   .description('An ISO8601 compatible date string defining when the permission commences')
-  .example(new Date().toISOString())
+  .example(DATE_EXAMPLE)
 const endDateSchema = Joi.string()
   .isoDate()
   .required()
   .description('An ISO8601 compatible date string defining when the permission expires')
-  .example(new Date().toISOString())
+  .example(DATE_EXAMPLE)
 
 export const stagedPermissionSchema = Joi.object({
   permitId: Joi.string()
@@ -41,12 +41,12 @@ export const stagedPermissionSchema = Joi.object({
 }).label('staged-permission')
 
 export const finalisedPermissionSchemaContent = {
-  id: Joi.string().guid().required().example(uuid()),
+  id: Joi.string().guid().required().example('a17fc331-141b-4fc0-8549-329d6934fadb'),
   referenceNumber: validation.permission.createPermissionNumberValidator(Joi),
   issueDate: issueDateSchema,
   startDate: startDateSchema,
   endDate: endDateSchema,
-  stagingId: Joi.string().guid().required().example(uuid()),
+  stagingId: Joi.string().guid().required().example('a17fc331-141b-4fc0-8549-329d6934fadb'),
   dataSource: optionSetOption
 }
 

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

@@ -0,0 +1,21 @@
+import Joi from 'joi'
+import { commonContactSchema } from './contact.schema.js'
+import { finalisedPermissionSchemaContent } from './permission.schema.js'
+
+export const dueRecurringPaymentsResponseSchema = Joi.object({
+  id: Joi.string().guid().required(),
+  name: Joi.string().required(),
+  status: Joi.number().required(),
+  nextDueDate: Joi.string().isoDate().required(),
+  cancelledDate: Joi.string().isoDate().allow(null).required(),
+  cancelledReason: Joi.string().allow(null).required(),
+  endDate: Joi.string().isoDate().required(),
+  agreementId: Joi.string().guid().required(),
+  activePermission: Joi.string().guid().required(),
+  contactId: Joi.string().guid().required(),
+  publicId: Joi.string().required(),
+  expanded: Joi.object({
+    contact: { entity: commonContactSchema },
+    activePermission: { entity: finalisedPermissionSchemaContent }
+  })
+})

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

@@ -1,6 +1,12 @@
 import dueRecurringPayments from '../recurring-payments.js'
 import { getRecurringPayments } from '../../../services/recurring-payments.service.js'
 
+const [
+  {
+    options: { handler: drpHandler }
+  }
+] = dueRecurringPayments
+
 jest.mock('../../../services/recurring-payments.service.js', () => ({
   getRecurringPayments: jest.fn()
 }))
@@ -19,13 +25,13 @@ describe('recurring payments', () => {
   it('handler should return continue response', async () => {
     const request = getMockRequest({})
     const responseToolkit = getMockResponseToolkit()
-    expect(await dueRecurringPayments[0].handler(request, responseToolkit)).toEqual(responseToolkit.continue)
+    expect(await drpHandler(request, responseToolkit)).toEqual(responseToolkit.continue)
   })
 
   it('should call getRecurringPayments with date', async () => {
     const date = Symbol('date')
     const request = getMockRequest({ date })
-    await dueRecurringPayments[0].handler(request, getMockResponseToolkit())
+    await drpHandler(request, getMockResponseToolkit())
     expect(getRecurringPayments).toHaveBeenCalledWith(date)
   })
 })

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

@@ -1,12 +1,25 @@
+import { dueRecurringPaymentsResponseSchema } from '../../schema/recurring-payments.schema.js'
 import { getRecurringPayments } from '../../services/recurring-payments.service.js'
 export default [
   {
     method: 'GET',
     path: '/dueRecurringPayments/{date}',
-    handler: async (request, h) => {
-      const { date } = request.params
-      const result = await getRecurringPayments(date)
-      return h.response(result)
+    options: {
+      handler: async (request, h) => {
+        const { date } = request.params
+        const result = await getRecurringPayments(date)
+        return h.response(result)
+      },
+      description: 'Retrieve recurring payments due for the specified date',
+      tags: ['api', 'recurring-payments'],
+      plugins: {
+        'hapi-swagger': {
+          responses: {
+            200: { description: 'Recurring payments due', schema: dueRecurringPaymentsResponseSchema }
+          },
+          order: 1
+        }
+      }
     }
   }
 ]