@defra-fish/sales-api-service 1.44.0-rc.9 → 1.44.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.44.0-rc.9",
+  "version": "1.44.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.44.0-rc.9",
-    "@defra-fish/connectors-lib": "1.44.0-rc.9",
-    "@defra-fish/dynamics-lib": "1.44.0-rc.9",
+    "@defra-fish/business-rules-lib": "1.44.0",
+    "@defra-fish/connectors-lib": "1.44.0",
+    "@defra-fish/dynamics-lib": "1.44.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": "a1b20131086b1233fecb04ebd90e188b74356d37"
+  "gitHead": "c1a99ab268a24df0eacdf151bf62a549e7e971b2"
 }

package/src/schema/transaction.schema.js

@@ -106,9 +106,23 @@ const finaliseTransactionRequestSchemaContent = {
     channelId: Joi.string().trim().optional().description('Channel specific identifier'),
     method: buildJoiOptionSetValidator('defra_paymenttype', 'Debit card'),
     recurring: Joi.object({
-      payer: contactRequestSchema,
-      referenceNumber: Joi.string().required().description('The reference number associated with the recurring payment').example(uuidv4()),
-      mandate: Joi.string().required().description('The mandate identifier associated with the recurring payment').example(uuidv4())
+      name: Joi.string().required().description('The default name associated with the recurring payment').example(uuidv4()),
+      nextDueDate: Joi.string()
+        .isoDate()
+        .required()
+        .description('The date of payment for a renewed permission')
+        .example(new Date().toISOString()),
+      cancelledDate: Joi.string()
+        .isoDate()
+        .optional()
+        .description('Optional field for when recurring payment cancelled')
+        .example(new Date().toISOString()),
+      cancelledReason: buildJoiOptionSetValidator('defra_cancelledreason', 'User Cancelled'),
+      endDate: Joi.string().isoDate().required().description('End of recurring payment').example(new Date().toISOString()),
+      agreementId: Joi.string().required().description('Agreement identification number, Gov.UK Pay field').example(uuidv4()),
+      publicId: Joi.string().required().description('SHA-256 hash of id').example(uuidv4()),
+      contact: contactRequestSchema,
+      activePermission: finalisePermissionResponseSchema
     })
       .label('finalise-transaction-recurring-payment-details')
       .description('Used to establish a recurring payment (e.g. via Direct Debit)')

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

@@ -0,0 +1,31 @@
+import dueRecurringPayments from '../recurring-payments.js'
+import { getRecurringPayments } from '../../../services/recurring-payments.service.js'
+
+jest.mock('../../../services/recurring-payments.service.js', () => ({
+  getRecurringPayments: jest.fn()
+}))
+
+const getMockRequest = ({ date = '2023-10-19' }) => ({
+  params: { date }
+})
+
+const getMockResponseToolkit = () => ({
+  response: jest.fn()
+})
+
+describe('recurring payments', () => {
+  beforeEach(jest.clearAllMocks)
+
+  it('handler should return continue response', async () => {
+    const request = getMockRequest({})
+    const responseToolkit = getMockResponseToolkit()
+    expect(await dueRecurringPayments[0].handler(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())
+    expect(getRecurringPayments).toHaveBeenCalledWith(date)
+  })
+})

package/src/server/routes/index.js

@@ -6,6 +6,7 @@ import PaymentJournals from './payment-journals.js'
 import StagingExceptions from './staging-exceptions.js'
 import Authenticate from './authenticate.js'
 import Users from './system-users.js'
+import RecurringPayment from './recurring-payments.js'
 
 import Static from './static.js'
 
@@ -18,5 +19,6 @@ export default [
   ...PaymentJournals,
   ...StagingExceptions,
   ...Authenticate,
-  ...Users
+  ...Users,
+  ...RecurringPayment
 ]

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

@@ -0,0 +1,12 @@
+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)
+    }
+  }
+]

package/src/services/__tests__/__snapshots__/recurring-payments.service.spec.js.snap

@@ -0,0 +1,14 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`recurring payments service processRecurringPayment should return a valid recurringPayment when transactionRecord.payment.recurring is present 1`] = `
+Object {
+  "agreementId": "435678",
+  "cancelledDate": null,
+  "cancelledReason": null,
+  "endDate": 2023-11-12T00:00:00.000Z,
+  "name": "Test Name",
+  "nextDueDate": 2023-11-02T00:00:00.000Z,
+  "publicId": "1234456",
+  "status": 0,
+}
+`;

package/src/services/__tests__/recurring-payments.service.spec.js

@@ -0,0 +1,137 @@
+import { findDueRecurringPayments } from '@defra-fish/dynamics-lib'
+import { getRecurringPayments, processRecurringPayment } from '../recurring-payments.service.js'
+
+jest.mock('@defra-fish/dynamics-lib', () => ({
+  ...jest.requireActual('@defra-fish/dynamics-lib'),
+  executeQuery: jest.fn(),
+  findById: jest.fn(),
+  findDueRecurringPayments: jest.fn()
+}))
+
+const dynamicsLib = jest.requireMock('@defra-fish/dynamics-lib')
+
+const getMockRecurringPayment = () => ({
+  name: 'Test Name',
+  nextDueDate: '2019-12-14T00:00:00Z',
+  cancelledDate: null,
+  cancelledReason: null,
+  endDate: '2019-12-15T00:00:00Z',
+  agreementId: 'c9267c6e-573d-488b-99ab-ea18431fc472',
+  publicId: '649-213',
+  status: 1,
+  expanded: {
+    contact: {
+      entity: getMockContact()
+    },
+    activePermission: {
+      entity: getMockPermission()
+    }
+  }
+})
+
+const getMockRPContactPermission = (contact, permission) => ({
+  name: 'Test Name',
+  nextDueDate: '2019-12-14T00:00:00Z',
+  cancelledDate: null,
+  cancelledReason: null,
+  endDate: '2019-12-15T00:00:00Z',
+  agreementId: 'c9267c6e-573d-488b-99ab-ea18431fc472',
+  publicId: '649-213',
+  status: 1,
+  expanded: {
+    contact,
+    activePermission: permission
+  }
+})
+
+const getMockContact = () => ({
+  firstName: 'Fester',
+  lastName: 'Tester',
+  birthDate: '2000-01-01',
+  email: 'person@example.com',
+  mobilePhone: '+44 7700 900088',
+  premises: 'Example House',
+  street: 'Example Street',
+  locality: 'Near Sample',
+  town: 'Exampleton',
+  postcode: 'AB12 3CD',
+  country: 'GB-ENG',
+  preferredMethodOfConfirmation: 'Text',
+  preferredMethodOfNewsletter: 'Email',
+  preferredMethodOfReminder: 'Letter',
+  postalFulfilment: true
+})
+
+const getMockPermission = () => ({
+  referenceNumber: '12345678',
+  licenceLength: '12M',
+  isLicenceForYou: true,
+  licensee: {
+    firstName: 'Fester',
+    lastName: 'Tester',
+    premises: '14 Howecroft Court',
+    street: 'Eastmead Lane',
+    town: 'Bristol',
+    postcode: 'BS9 1HJ',
+    email: 'fester@tester.com',
+    mobilePhone: '01234567890',
+    birthDate: '1996-01-01',
+    postalFulfilment: true
+  }
+})
+
+describe('recurring payments service', () => {
+  beforeEach(jest.clearAllMocks)
+  describe('getRecurringPayments', () => {
+    it('should equal result of findDueRecurringPayments query', async () => {
+      const mockRecurringPayments = [getMockRecurringPayment()]
+      const mockContact = mockRecurringPayments[0].expanded.contact
+      const mockPermission = mockRecurringPayments[0].expanded.activePermission
+
+      dynamicsLib.executeQuery.mockResolvedValueOnce(mockRecurringPayments)
+
+      const result = await getRecurringPayments(new Date())
+
+      expect(result).toEqual([getMockRPContactPermission(mockContact, mockPermission)])
+    })
+
+    it('executeQuery is called with findDueRecurringPayments with a date', async () => {
+      const mockRecurringPayments = [getMockRecurringPayment()]
+      const mockDate = new Date()
+      dynamicsLib.executeQuery.mockResolvedValueOnce(mockRecurringPayments)
+
+      await getRecurringPayments(mockDate)
+
+      expect(dynamicsLib.executeQuery).toHaveBeenCalledWith(findDueRecurringPayments(mockDate))
+    })
+  })
+
+  describe('processRecurringPayment', () => {
+    it('should return null when transactionRecord.payment.recurring is not present', async () => {
+      const transactionRecord = { payment: null }
+      const result = await processRecurringPayment(transactionRecord, getMockContact())
+      expect(result.recurringPayment).toBeNull()
+    })
+
+    it('should return a valid recurringPayment when transactionRecord.payment.recurring is present', async () => {
+      const transactionRecord = {
+        payment: {
+          recurring: {
+            name: 'Test Name',
+            nextDueDate: new Date('2023-11-02'),
+            cancelledDate: null,
+            cancelledReason: null,
+            endDate: new Date('2023-11-12'),
+            agreementId: '435678',
+            publicId: '1234456',
+            status: 0
+          }
+        },
+        permissions: [getMockPermission()]
+      }
+      const contact = getMockContact()
+      const result = await processRecurringPayment(transactionRecord, contact)
+      expect(result.recurringPayment).toMatchSnapshot()
+    })
+  })
+})

package/src/services/recurring-payments.service.js

@@ -0,0 +1,27 @@
+import { executeQuery, findDueRecurringPayments, RecurringPayment } from '@defra-fish/dynamics-lib'
+
+export const getRecurringPayments = date => executeQuery(findDueRecurringPayments(date))
+
+/**
+ * Process a recurring payment instruction
+ * @param transactionRecord
+ * @returns {Promise<{recurringPayment: RecurringPayment | null}>}
+ */
+export const processRecurringPayment = async (transactionRecord, contact) => {
+  if (transactionRecord.payment?.recurring) {
+    const recurringPayment = new RecurringPayment()
+    recurringPayment.name = transactionRecord.payment.recurring.name
+    recurringPayment.nextDueDate = transactionRecord.payment.recurring.nextDueDate
+    recurringPayment.cancelledDate = transactionRecord.payment.recurring.cancelledDate
+    recurringPayment.cancelledReason = transactionRecord.payment.recurring.cancelledReason
+    recurringPayment.endDate = transactionRecord.payment.recurring.endDate
+    recurringPayment.agreementId = transactionRecord.payment.recurring.agreementId
+    recurringPayment.publicId = transactionRecord.payment.recurring.publicId
+    recurringPayment.status = transactionRecord.payment.recurring.status
+    const [permission] = transactionRecord.permissions
+    recurringPayment.bindToEntity(RecurringPayment.definition.relationships.activePermission, permission)
+    recurringPayment.bindToEntity(RecurringPayment.definition.relationships.contact, contact)
+    return { recurringPayment }
+  }
+  return { recurringPayment: null }
+}

package/src/services/transactions/__tests__/finalise-transaction.spec.js

@@ -181,7 +181,7 @@ describe('transaction service', () => {
             type: 'Gov Pay',
             method: 'Debit card',
             recurring: {
-              payer: {
+              contact: {
                 firstName: 'Fester',
                 lastName: 'Tester',
                 birthDate: '2000-01-01',

package/src/services/transactions/__tests__/process-transaction-queue.spec.js

@@ -7,10 +7,10 @@ import {
   FulfilmentRequest,
   Permission,
   PoclFile,
-  RecurringPayment,
   RecurringPaymentInstruction,
   Transaction,
-  TransactionJournal
+  TransactionJournal,
+  RecurringPayment
 } from '@defra-fish/dynamics-lib'
 import {
   mockFinalisedTransactionRecord,
@@ -126,12 +126,17 @@ describe('transaction service', () => {
           'licences with a recurring payment',
           () => {
             const mockRecord = mockFinalisedTransactionRecord()
-            mockRecord.permissions[0].permitId = MOCK_12MONTH_SENIOR_PERMIT.id
             mockRecord.payment.recurring = {
-              referenceNumber: 'Test Reference Number',
-              mandate: 'Test Mandate',
+              name: 'Test name',
+              nextDueDate: new Date('2020/01/11'),
+              endDate: new Date('2022/01/16'),
+              agreementId: '123446jjng',
+              publicId: 'sdf-123',
+              status: 1,
+              activePermission: mockRecord.permissions[0],
               contact: Object.assign(mockContactPayload(), { firstName: 'Esther' })
             }
+            mockRecord.permissions[0].permitId = MOCK_12MONTH_SENIOR_PERMIT.id
             return mockRecord
           },
           [
@@ -140,7 +145,6 @@ describe('transaction service', () => {
             expect.any(TransactionJournal),
             expect.any(RecurringPayment),
             expect.any(Contact),
-            expect.any(Contact),
             expect.any(Permission),
             expect.any(RecurringPaymentInstruction),
             expect.any(ConcessionProof)

package/src/services/transactions/process-transaction-queue.js

@@ -8,17 +8,17 @@ import {
   Transaction,
   TransactionCurrency,
   TransactionJournal,
-  RecurringPayment,
   RecurringPaymentInstruction
 } from '@defra-fish/dynamics-lib'
 import { DDE_DATA_SOURCE, FULFILMENT_SWITCHOVER_DATE, POCL_TRANSACTION_SOURCES } from '@defra-fish/business-rules-lib'
 import { getReferenceDataForEntityAndId, getGlobalOptionSetValue, getReferenceDataForEntity } from '../reference-data.service.js'
+import { processRecurringPayment } from '../recurring-payments.service.js'
 import { resolveContactPayload } from '../contacts.service.js'
 import { retrieveStagedTransaction } from './retrieve-transaction.js'
 import { TRANSACTION_STAGING_TABLE, TRANSACTION_STAGING_HISTORY_TABLE } from '../../config.js'
-import moment from 'moment'
 import { AWS } from '@defra-fish/connectors-lib'
 import db from 'debug'
+import moment from 'moment'
 const { docClient } = AWS()
 const debug = db('sales:transactions')
 
@@ -38,9 +38,6 @@ export async function processQueue ({ id }) {
   const { transaction, chargeJournal, paymentJournal } = await createTransactionEntities(transactionRecord)
   entities.push(transaction, chargeJournal, paymentJournal)
 
-  const { recurringPayment, payer } = await processRecurringPayment(transactionRecord)
-  recurringPayment && entities.push(recurringPayment, payer)
-
   const totalTransactionValue = transactionRecord.payment.amount
   const dataSource = await getGlobalOptionSetValue(Permission.definition.mappings.dataSource.ref, transactionRecord.dataSource)
   for (const {
@@ -68,6 +65,11 @@ export async function processQueue ({ id }) {
       isRenewal
     )
 
+    const { recurringPayment } = await processRecurringPayment(transactionRecord, contact)
+    if (recurringPayment) {
+      entities.push(recurringPayment)
+    }
+
     permission.bindToEntity(Permission.definition.relationships.licensee, contact)
     permission.bindToEntity(Permission.definition.relationships.permit, permit)
     permission.bindToEntity(Permission.definition.relationships.transaction, transaction)
@@ -142,27 +144,6 @@ const mapToPermission = async (
   return permission
 }
 
-/**
- * Process a recurring payment instruction
- * @param transactionRecord
- * @returns {Promise<{recurringPayment: null, payer: null}>}
- */
-const processRecurringPayment = async transactionRecord => {
-  let recurringPayment = null
-  let payer = null
-  if (transactionRecord.payment.recurring) {
-    const inceptionMoment = moment(transactionRecord.payment.timestamp, true).utc()
-    recurringPayment = new RecurringPayment()
-    recurringPayment.referenceNumber = transactionRecord.payment.recurring.referenceNumber
-    recurringPayment.mandate = transactionRecord.payment.recurring.mandate
-    recurringPayment.inceptionDay = inceptionMoment.date()
-    recurringPayment.inceptionMonth = inceptionMoment.month()
-    payer = await resolveContactPayload(transactionRecord.payment.recurring.payer)
-    recurringPayment.bindToEntity(RecurringPayment.definition.relationships.contact, payer)
-  }
-  return { recurringPayment, payer }
-}
-
 /**
  * Create transaction entities required to represent this transaction payload
  *