@defra-fish/sales-api-service 1.55.0 → 1.56.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.55.0",
+  "version": "1.56.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.55.0",
-    "@defra-fish/connectors-lib": "1.55.0",
-    "@defra-fish/dynamics-lib": "1.55.0",
+    "@defra-fish/business-rules-lib": "1.56.0",
+    "@defra-fish/connectors-lib": "1.56.0",
+    "@defra-fish/dynamics-lib": "1.56.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": "3405322b81a2016ba22e530de8d096a49be0bea4"
+  "gitHead": "4edcdd349b077ad0bdb3e7b4029df3aba7c04b49"
 }

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

@@ -71,7 +71,7 @@ describe('createTransactionSchema', () => {
     await expect(createTransactionSchema.validateAsync(mockPayload)).rejects.toThrow('"permissions[0].isLicenceForYou" must be a boolean')
   })
 
-  it('validates successfully when a uuid v4 transaction id is supplied', async () => {
+  it('validates successfully when a uuid v4 transactionId is supplied', async () => {
     const mockPayload = mockTransactionPayload()
     mockPayload.transactionId = '25fa0126-55da-4309-9bce-9957990d141e'
     await expect(createTransactionSchema.validateAsync(mockPayload)).resolves.not.toThrow()
@@ -90,11 +90,34 @@ describe('createTransactionSchema', () => {
     ['uuid6 string', 'a3bb189e-8bf9-3888-9912-ace4e6543002'],
     ['uuid7 string', '01927705-ffac-77b5-89af-c97451b1bbe2'],
     ['numeric', 4567]
-  ])('fails validation when provided with a %s', async (_d, transactionId) => {
+  ])('fails validation when provided with a %s for transactionId', async (_d, transactionId) => {
     const mockPayload = mockTransactionPayload()
     mockPayload.transactionId = transactionId
     await expect(createTransactionSchema.validateAsync(mockPayload)).rejects.toThrow()
   })
+
+  it('validates successfully when an agreementId is supplied', async () => {
+    const mockPayload = mockTransactionPayload()
+    mockPayload.agreementId = 't3jl08v2nqqmujrnhs09pmhtjx'
+    await expect(createTransactionSchema.validateAsync(mockPayload)).resolves.not.toThrow()
+  })
+
+  it('validates successfully when agreementId is omitted', async () => {
+    const mockPayload = mockTransactionPayload()
+    await expect(createTransactionSchema.validateAsync(mockPayload)).resolves.not.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) => {
+    const mockPayload = mockTransactionPayload()
+    mockPayload.agreementId = agreementId
+    await expect(createTransactionSchema.validateAsync(mockPayload)).rejects.toThrow()
+  })
 })
 
 describe('createTransactionResponseSchema', () => {

package/src/schema/transaction.schema.js

@@ -7,6 +7,8 @@ import { MAX_PERMISSIONS_PER_TRANSACTION, POCL_TRANSACTION_SOURCES } from '@defr
 
 import { v4 as uuidv4 } from 'uuid'
 
+const AGREEMENT_ID_LENGTH = 26
+
 /**
  * Maximum number of items that can be created in a batch - limited by DynamoDB max batch size
  * @type {number}
@@ -33,7 +35,8 @@ const createTransactionRequestSchemaContent = {
   }),
   createdBy: Joi.string().optional(),
   journalId: Joi.string().optional(),
-  transactionId: Joi.string().guid({ version: 'uuidv4' })
+  transactionId: Joi.string().guid({ version: 'uuidv4' }).optional(),
+  agreementId: Joi.string().alphanum().length(AGREEMENT_ID_LENGTH).optional()
 }
 
 /**