@defra-fish/sales-api-service 1.63.0-rc.3 → 1.63.0-rc.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.63.0-rc.3",
+  "version": "1.63.0-rc.5",
   "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.63.0-rc.3",
-    "@defra-fish/connectors-lib": "1.63.0-rc.3",
-    "@defra-fish/dynamics-lib": "1.63.0-rc.3",
+    "@defra-fish/business-rules-lib": "1.63.0-rc.5",
+    "@defra-fish/connectors-lib": "1.63.0-rc.5",
+    "@defra-fish/dynamics-lib": "1.63.0-rc.5",
     "@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": "326d589e6fa640bf0a4e895c7dd280699c1cde87"
+  "gitHead": "313d1d1a8ab65bd841c27cf615f8abeec527f401"
 }

package/src/schema/__tests__/transaction.schema.spec.js

@@ -96,27 +96,42 @@ describe('createTransactionSchema', () => {
     await expect(createTransactionSchema.validateAsync(mockPayload)).rejects.toThrow()
   })
 
-  it('validates successfully when an agreementId is supplied', async () => {
+  it('validates successfully when recurring payment detail is supplied', async () => {
     const mockPayload = mockTransactionPayload()
-    mockPayload.agreementId = 't3jl08v2nqqmujrnhs09pmhtjx'
+    mockPayload.recurringPayment = {
+      agreementId: 't3jl08v2nqqmujrnhs09pmhtjx',
+      id: 'fdc73d20-a0bf-4da6-9a49-2f0a24bd3509'
+    }
     await expect(createTransactionSchema.validateAsync(mockPayload)).resolves.not.toThrow()
   })
 
-  it('validates successfully when agreementId is omitted', async () => {
+  it('validates successfully when recurring payment detail is omitted', async () => {
     const mockPayload = mockTransactionPayload()
     await expect(createTransactionSchema.validateAsync(mockPayload)).resolves.not.toThrow()
   })
 
+  it('fails validation if agreement id is omitted from recurring payment detail', async () => {
+    const mockPayload = mockTransactionPayload()
+    mockPayload.recurringPayment = { id: 'fdc73d20-a0bf-4da6-9a49-2f0a24bd3509' }
+    await expect(() => createTransactionSchema.validateAsync(mockPayload)).rejects.toThrow()
+  })
+
   it.each([
-    ['too short string', 'foo'],
-    ['too long string', 'foobarbazfoobarbazfoobarbaz'],
-    ['string containing invalid characters', '!3j@08v2nqqmujrnhs09_mhtjx'],
-    ['null', null],
-    ['numeric', 4567]
-  ])('fails validation when provided with a %s for agreementId', async (_d, agreementId) => {
+    ['agreement id is too long', { agreementId: 'thisistoolongtobeanagreementid' }],
+    ['agreement id is too short', { agreementId: 'tooshorttobeanagreementid' }],
+    ['agreement id contains invalid characters', '!3j@08v2nqqmujrnhs09_mhtjx'],
+    ['agreement id is null', { agreementId: null }],
+    ['agreement id is a numeric', { agreementId: 4567 }],
+    ['id is not a guid', { id: 'not-a-guid' }],
+    ['id is null', { id: null }]
+  ])('fails validation if %s', async (_d, recurringPayment) => {
     const mockPayload = mockTransactionPayload()
-    mockPayload.agreementId = agreementId
-    await expect(createTransactionSchema.validateAsync(mockPayload)).rejects.toThrow()
+    mockPayload.recurringPayment = {
+      agreementId: 'jhyu78iujhy7u87y6thu87uyj8',
+      id: '7a0660ec-8535-4357-b925-e598a9358119',
+      ...recurringPayment
+    }
+    await expect(() => createTransactionSchema.validateAsync(mockPayload)).rejects.toThrow()
   })
 })
 

package/src/schema/transaction.schema.js

@@ -36,7 +36,10 @@ const createTransactionRequestSchemaContent = {
   createdBy: Joi.string().optional(),
   journalId: Joi.string().optional(),
   transactionId: Joi.string().guid({ version: 'uuidv4' }).optional(),
-  agreementId: Joi.string().alphanum().length(AGREEMENT_ID_LENGTH).optional()
+  recurringPayment: Joi.object({
+    agreementId: Joi.string().alphanum().length(AGREEMENT_ID_LENGTH).required(),
+    id: Joi.string().guid()
+  }).optional()
 }
 
 /**

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

@@ -392,7 +392,9 @@ describe('recurring payments service', () => {
           ...permission
         }
       ],
-      agreementId,
+      recurringPayment: {
+        agreementId
+      },
       payment: {
         amount: 35.8,
         source: 'Gov Pay',

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

@@ -37,8 +37,8 @@ const getNextDueDate = (startDate, issueDate, endDate) => {
 }
 
 export const generateRecurringPaymentRecord = async (transactionRecord, permission) => {
-  if (transactionRecord.agreementId) {
-    const agreementResponse = await getRecurringPaymentAgreement(transactionRecord.agreementId)
+  if (transactionRecord.recurringPayment.agreementId) {
+    const agreementResponse = await getRecurringPaymentAgreement(transactionRecord.recurringPayment.agreementId)
     const lastDigitsCardNumbers = agreementResponse.payment_instrument?.card_details?.last_digits_card_number
     const [{ startDate, issueDate, endDate }] = transactionRecord.permissions
     return {
@@ -49,7 +49,7 @@ export const generateRecurringPaymentRecord = async (transactionRecord, permissi
           cancelledDate: null,
           cancelledReason: null,
           endDate,
-          agreementId: transactionRecord.agreementId,
+          agreementId: transactionRecord.recurringPayment.agreementId,
           status: 1,
           last_digits_card_number: lastDigitsCardNumbers
         }