@defra-fish/sales-api-service 1.24.0-rc.7 → 1.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.24.0-rc.7",
+  "version": "1.24.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.24.0-rc.7",
-    "@defra-fish/connectors-lib": "1.24.0-rc.7",
-    "@defra-fish/dynamics-lib": "1.24.0-rc.7",
+    "@defra-fish/business-rules-lib": "1.24.0",
+    "@defra-fish/connectors-lib": "1.24.0",
+    "@defra-fish/dynamics-lib": "1.24.0",
     "@hapi/boom": "^9.1.2",
     "@hapi/hapi": "^20.1.3",
     "@hapi/inert": "^6.0.3",
@@ -51,5 +51,5 @@
     "moment": "^2.29.1",
     "uuid": "^8.3.2"
   },
-  "gitHead": "da3683aebd2547d7a8d2be3668c16c258a073328"
+  "gitHead": "c138f45936dbae8ebb917599a53b6cf96c73aaa5"
 }

package/src/__mocks__/test-data.js

@@ -66,7 +66,8 @@ export const mockPermissionPayload = () => ({
     }
   ],
   issueDate: MOCK_ISSUE_DATE,
-  startDate: MOCK_START_DATE
+  startDate: MOCK_START_DATE,
+  isRenewal: false
 })
 
 export const mockTransactionPayload = () => ({

package/src/schema/permission.schema.js

@@ -36,25 +36,17 @@ export const stagedPermissionSchema = Joi.object({
   concessions: concessionProofSchema.optional(),
   issueDate: issueDateSchema.allow(null),
   startDate: startDateSchema.allow(null),
-  isLicenceForYou: Joi.boolean()
-    .optional()
-    .allow(null)
-    .example('true')
+  isRenewal: Joi.boolean(),
+  isLicenceForYou: Joi.boolean().optional().allow(null).example('true')
 }).label('staged-permission')
 
 export const finalisedPermissionSchemaContent = {
-  id: Joi.string()
-    .guid()
-    .required()
-    .example(uuid()),
+  id: Joi.string().guid().required().example(uuid()),
   referenceNumber: validation.permission.createPermissionNumberValidator(Joi),
   issueDate: issueDateSchema,
   startDate: startDateSchema,
   endDate: endDateSchema,
-  stagingId: Joi.string()
-    .guid()
-    .required()
-    .example(uuid()),
+  stagingId: Joi.string().guid().required().example(uuid()),
   dataSource: optionSetOption
 }
 

package/src/schema/staging-exception.schema.js

@@ -6,10 +6,7 @@ import { concessionProofSchema } from './concession-proof.schema.js'
 import { buildJoiOptionSetValidator, createAlternateKeyValidator } from './validators/validators.js'
 import { PoclFile, PoclStagingException } from '@defra-fish/dynamics-lib'
 
-const dateSchema = Joi.string()
-  .isoDate()
-  .required()
-  .example(new Date().toISOString())
+const dateSchema = Joi.string().isoDate().required().example(new Date().toISOString())
 
 const TRANSACTION_DATE = dateSchema.description('An ISO8601 compatible date string defining when the transaction was completed')
 
@@ -26,9 +23,7 @@ const schemaObject = {
     json: Joi.string().required(),
     notes: Joi.string(),
     type: buildJoiOptionSetValidator(PoclStagingException.definition.mappings.type.ref, 'Failure'),
-    transactionFile: Joi.string()
-      .external(createAlternateKeyValidator(PoclFile))
-      .required(),
+    transactionFile: Joi.string().external(createAlternateKeyValidator(PoclFile)).required(),
     permissionId: Joi.string()
   }),
   record: Joi.object({
@@ -80,77 +75,45 @@ export const poclValidationErrorItemSchema = Joi.object({
   postalFulfilment: Joi.boolean().required(),
   concessions: concessionProofSchema.optional(),
   startDate: dateSchema.description('An ISO8601 compatible date string defining when the permission commences'),
-  serialNumber: Joi.string()
-    .trim()
-    .required(),
-  transactionFile: Joi.string()
-    .trim()
-    .required(),
-  permitId: Joi.string()
-    .guid()
-    .required(),
+  serialNumber: Joi.string().trim().required(),
+  transactionFile: Joi.string().trim().required(),
+  permitId: Joi.string().guid().required(),
   amount: Joi.number().required(),
   transactionDate: TRANSACTION_DATE,
-  paymentSource: Joi.string()
-    .trim()
-    .required(),
-  channelId: Joi.string()
-    .trim()
-    .required()
-    .description('Channel specific identifier'),
+  paymentSource: Joi.string().trim().required(),
+  channelId: Joi.string().trim().required().description('Channel specific identifier'),
   methodOfPayment: buildJoiOptionSetValidator('defra_paymenttype', 'Debit card'),
   dataSource: buildJoiOptionSetValidator('defra_datasource', 'Post Office Sales'),
   status: buildJoiOptionSetValidator('defra_status', 'Ready for Processing'),
   stateCode: Joi.number().required()
 }).label('pocl-validation-error-item')
 
-export const poclValidationErrorListSchema = Joi.array()
-  .items(poclValidationErrorItemSchema)
-  .label('pocl-validation-error-item-list')
+export const poclValidationErrorListSchema = Joi.array().items(poclValidationErrorItemSchema).label('pocl-validation-error-item-list')
 
 export const poclValidationErrorParamsSchema = Joi.object({
-  id: Joi.string()
-    .trim()
-    .guid()
-    .required()
-    .description('The POCL validation error identifier')
-    .example(uuidv4())
+  id: Joi.string().trim().guid().required().description('The POCL validation error identifier').example(uuidv4())
 })
 
 // There may be further issues in the record data at this point
 export const updatePoclValidationErrorPayload = Joi.object({
-  poclValidationErrorId: Joi.string()
-    .trim()
-    .guid()
-    .required()
-    .description('The POCL validation error identifier')
-    .example(uuidv4()),
+  poclValidationErrorId: Joi.string().trim().guid().required().description('The POCL validation error identifier').example(uuidv4()),
   createTransactionPayload: {
     dataSource: Joi.string().optional(),
     journalId: Joi.string().optional(),
-    serialNumber: Joi.string()
-      .trim()
-      .required(),
+    serialNumber: Joi.string().trim().required(),
     permissions: Joi.array().items(
       Joi.object({
         licensee: Joi.object(),
         issueDate: TRANSACTION_DATE,
         startDate: dateSchema.description('An ISO8601 compatible date string defining when the permission commences'),
-        permitId: Joi.string()
-          .guid()
-          .required(),
+        permitId: Joi.string().guid().required(),
         concessions: Joi.array()
           .items(
             Joi.object({
-              id: Joi.string()
-                .guid()
-                .required()
-                .example(uuidv4()),
+              id: Joi.string().guid().required().example(uuidv4()),
               proof: Joi.object({
                 type: Joi.string().required(),
-                referenceNumber: Joi.string()
-                  .optional()
-                  .example('QQ 12 34 56 C')
+                referenceNumber: Joi.string().optional().example('QQ 12 34 56 C')
               }).required()
             })
           )
@@ -163,16 +126,9 @@ export const updatePoclValidationErrorPayload = Joi.object({
     payment: {
       timestamp: TRANSACTION_DATE,
       amount: Joi.number().required(),
-      source: Joi.string()
-        .trim()
-        .required(),
-      channelId: Joi.string()
-        .trim()
-        .required()
-        .description('Channel specific identifier'),
-      method: Joi.string()
-        .trim()
-        .required()
+      source: Joi.string().trim().required(),
+      channelId: Joi.string().trim().required().description('Channel specific identifier'),
+      method: Joi.string().trim().required()
     }
   },
   createTransactionError: Joi.object().optional(),

package/src/schema/transaction.schema.js

@@ -29,10 +29,7 @@ const createTransactionRequestSchemaContent = {
   dataSource: buildJoiOptionSetValidator('defra_datasource', 'Web Sales'),
   serialNumber: Joi.when('dataSource', {
     is: Joi.valid(...POCL_TRANSACTION_SOURCES),
-    then: Joi.string()
-      .trim()
-      .min(1)
-      .required()
+    then: Joi.string().trim().min(1).required()
   }),
   createdBy: Joi.string().optional(),
   journalId: Joi.string().optional()
@@ -55,33 +52,19 @@ export const createTransactionSchema = Joi.object(createTransactionRequestSchema
 export const createTransactionBatchSchema = Joi.array()
   .min(1)
   .max(BATCH_CREATE_MAX_COUNT)
-  .items(
-    Joi.object()
-      .required()
-      .label('create-transaction-batch-item')
-      .description('See create-transaction-request for proper structure')
-  )
+  .items(Joi.object().required().label('create-transaction-batch-item').description('See create-transaction-request for proper structure'))
   .required()
   .label('create-transaction-batch-request')
 
 const createTransactionResponseSchemaContent = {
-  id: Joi.string()
-    .trim()
-    .guid()
-    .required(),
+  id: Joi.string().trim().guid().required(),
   expires: Joi.number().required(),
   ...createTransactionRequestSchemaContent,
-  permissions: Joi.array()
-    .min(1)
-    .items(stagedPermissionSchema)
-    .required()
-    .label('create-transaction-response-permissions'),
+  permissions: Joi.array().min(1).items(stagedPermissionSchema).required().label('create-transaction-response-permissions'),
   cost: Joi.number().required(),
   isRecurringPaymentSupported: Joi.boolean().required(),
   status: Joi.object({
-    id: Joi.string()
-      .valid('STAGED')
-      .required()
+    id: Joi.string().valid('STAGED').required()
   })
     .label('create-transaction-status')
     .required()
@@ -101,9 +84,7 @@ export const createTransactionBatchResponseSchema = Joi.array()
   .items(
     Joi.object({
       statusCode: Joi.number().required(),
-      response: Joi.object(createTransactionResponseSchemaContent)
-        .label('create-transaction-batch-item-response')
-        .optional(),
+      response: Joi.object(createTransactionResponseSchemaContent).label('create-transaction-batch-item-response').optional(),
       error: Joi.string().optional(),
       message: Joi.string().optional()
     }).label('create-transaction-batch-response-item')
@@ -122,21 +103,12 @@ const finaliseTransactionRequestSchemaContent = {
       .description('An ISO8601 compatible date string defining when the transaction was completed')
       .example(new Date().toISOString()),
     source: buildJoiOptionSetValidator('defra_financialtransactionsource', 'Gov Pay'),
-    channelId: Joi.string()
-      .trim()
-      .optional()
-      .description('Channel specific identifier'),
+    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())
+      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())
     })
       .label('finalise-transaction-recurring-payment-details')
       .description('Used to establish a recurring payment (e.g. via Direct Debit)')
@@ -155,15 +127,9 @@ export const finaliseTransactionRequestSchema = Joi.object(finaliseTransactionRe
 export const finaliseTransactionResponseSchema = Joi.object({
   ...createTransactionResponseSchemaContent,
   ...finaliseTransactionRequestSchemaContent,
-  permissions: Joi.array()
-    .min(1)
-    .items(finalisePermissionResponseSchema)
-    .required()
-    .label('finalise-transaction-response-permissions'),
+  permissions: Joi.array().min(1).items(finalisePermissionResponseSchema).required().label('finalise-transaction-response-permissions'),
   status: Joi.object({
-    id: Joi.string()
-      .valid('FINALISED')
-      .required(),
+    id: Joi.string().valid('FINALISED').required(),
     messageId: Joi.string().required()
   })
     .required()

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

@@ -34,12 +34,8 @@ const getStagedTransactionRecord = () => {
   const {
     permissions: [permission]
   } = record
-  permission.issueDate = moment(permission.issueDate)
-    .year(2021)
-    .toISOString()
-  permission.startDate = moment(permission.startDate)
-    .add(START_AFTER_PAYMENT_MINUTES, 'minutes')
-    .toISOString()
+  permission.issueDate = moment(permission.issueDate).year(2021).toISOString()
+  permission.startDate = moment(permission.startDate).add(START_AFTER_PAYMENT_MINUTES, 'minutes').toISOString()
   return record
 }
 
@@ -98,11 +94,7 @@ describe('transaction service', () => {
           ':permissions': mockRecord.permissions.map(p => ({
             ...p,
             issueDate: p.issueDate ?? completionFields.payment.timestamp,
-            startDate:
-              p.startDate ??
-              moment(completionFields.payment.timestamp)
-                .add(START_AFTER_PAYMENT_MINUTES, 'minutes')
-                .toISOString(),
+            startDate: p.startDate ?? moment(completionFields.payment.timestamp).add(START_AFTER_PAYMENT_MINUTES, 'minutes').toISOString(),
             endDate: expect.any(String),
             referenceNumber: expect.any(String)
           })),
@@ -261,9 +253,7 @@ describe('transaction service', () => {
               ':permissions': expect.arrayContaining([
                 expect.objectContaining({
                   permitId: mockPermission.permitId,
-                  startDate: moment(issueDate)
-                    .add(startAfterPaymentMinutes, 'minutes')
-                    .toISOString()
+                  startDate: moment(issueDate).add(startAfterPaymentMinutes, 'minutes').toISOString()
                 })
               ])
             })
@@ -317,7 +307,6 @@ describe('transaction service', () => {
       const [mockPermission] = mockRecord.permissions
       mockPermission.issueDate = issueDate
       mockPermission.startDate = startDate
-      const licenceLength = moment(endDate).subtract(moment(startDate))
       const completionFields = getCompletionFields()
       AwsMock.DynamoDB.DocumentClient.__setResponse('update', {
         Attributes: { ...mockRecord, ...completionFields, status: { id: TRANSACTION_STATUS.FINALISED } }
@@ -441,9 +430,7 @@ describe('transaction service', () => {
       expect(permission).toEqual(
         expect.objectContaining({
           permitId: mockPermission.permitId,
-          startDate: moment(completionFields.payment.timestamp)
-            .add(START_AFTER_PAYMENT_MINUTES, 'minutes')
-            .toISOString()
+          startDate: moment(completionFields.payment.timestamp).add(START_AFTER_PAYMENT_MINUTES, 'minutes').toISOString()
         })
       )
     })

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

@@ -252,7 +252,7 @@ describe('transaction service', () => {
         ['123456', 2020],
         ['654321', 2021],
         ['567890', 2022]
-      ])('and it\'s a DDE File, and has a journal id, returns journal id', (journalId, year) => {
+      ])("and it's a DDE File, and has a journal id, returns journal id", (journalId, year) => {
         jest.useFakeTimers()
         jest.setSystemTime(new Date(year, 1, 1, 10, 0, 0, 0))
         const mockRecord = getSampleRecord({
@@ -264,7 +264,7 @@ describe('transaction service', () => {
         jest.useRealTimers()
       })
 
-      it('and it\'s a POCL file, and has a journal id and a serial number, returns serial number', () => {
+      it("and it's a POCL file, and has a journal id and a serial number, returns serial number", () => {
         const mockRecord = getSampleRecord()
         mockRecord.journalId = '123456'
         const refNumber = getTransactionJournalRefNumber(mockRecord, 'Payment')

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

@@ -15,9 +15,7 @@ const getAdjustedStartDate = ({ issueDate, startDate, dataSource }) => {
   const startDateTooEarly = moment(startDate).isBefore(moment(issueDate).add(START_AFTER_PAYMENT_MINUTES, 'minutes'))
   const webOrTelesales = !POCL_TRANSACTION_SOURCES.includes(dataSource)
   if (startDateTooEarly && webOrTelesales) {
-    return moment(issueDate)
-      .add(START_AFTER_PAYMENT_MINUTES, 'minutes')
-      .toISOString()
+    return moment(issueDate).add(START_AFTER_PAYMENT_MINUTES, 'minutes').toISOString()
   }
   return startDate
 }
@@ -39,11 +37,7 @@ export async function finaliseTransaction ({ id, ...payload }) {
   // Generate derived fields
   for (const permission of transactionRecord.permissions) {
     permission.issueDate = permission.issueDate ?? payload.payment.timestamp
-    const startDate =
-      permission.startDate ??
-      moment(payload.payment.timestamp)
-        .add(START_AFTER_PAYMENT_MINUTES, 'minutes')
-        .toISOString()
+    const startDate = permission.startDate ?? moment(payload.payment.timestamp).add(START_AFTER_PAYMENT_MINUTES, 'minutes').toISOString()
     permission.startDate = getAdjustedStartDate({
       startDate,
       dataSource: transactionRecord.dataSource,

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

@@ -51,6 +51,7 @@ export async function processQueue ({ id }) {
     issueDate,
     startDate,
     endDate,
+    isRenewal,
     isLicenceForYou
   } of transactionRecord.permissions) {
     const contact = await resolveContactPayload(licensee)
@@ -58,7 +59,16 @@ export async function processQueue ({ id }) {
 
     totalTransactionValue += permit.cost
 
-    const permission = await mapToPermission(referenceNumber, transactionRecord, issueDate, startDate, endDate, dataSource, isLicenceForYou)
+    const permission = await mapToPermission(
+      referenceNumber,
+      transactionRecord,
+      issueDate,
+      startDate,
+      endDate,
+      dataSource,
+      isLicenceForYou,
+      isRenewal
+    )
 
     permission.bindToEntity(Permission.definition.relationships.licensee, contact)
     permission.bindToEntity(Permission.definition.relationships.permit, permit)
@@ -102,7 +112,16 @@ export async function processQueue ({ id }) {
     .promise()
 }
 
-const mapToPermission = async (referenceNumber, transactionRecord, issueDate, startDate, endDate, dataSource, isLicenceForYou) => {
+const mapToPermission = async (
+  referenceNumber,
+  transactionRecord,
+  issueDate,
+  startDate,
+  endDate,
+  dataSource,
+  isLicenceForYou,
+  isRenewal
+) => {
   const permission = new Permission()
   permission.referenceNumber = referenceNumber
   permission.stagingId = transactionRecord.id
@@ -110,6 +129,7 @@ const mapToPermission = async (referenceNumber, transactionRecord, issueDate, st
   permission.startDate = startDate
   permission.endDate = endDate
   permission.dataSource = dataSource
+  permission.isRenewal = isRenewal
   if (isLicenceForYou !== null && isLicenceForYou !== undefined) {
     permission.isLicenceForYou = await getGlobalOptionSetValue(
       Permission.definition.mappings.isLicenceForYou.ref,
@@ -171,7 +191,7 @@ const createTransactionEntities = async transactionRecord => {
 export const getTransactionJournalRefNumber = (transactionRecord, type) => {
   if (POCL_TRANSACTION_SOURCES.includes(transactionRecord.dataSource) && type === 'Payment') {
     if (transactionRecord.dataSource === DDE_DATA_SOURCE && transactionRecord.journalId) {
-      return `DDE-${(new Date()).getFullYear()}-${transactionRecord.journalId}`
+      return `DDE-${new Date().getFullYear()}-${transactionRecord.journalId}`
     }
     return transactionRecord.serialNumber || transactionRecord.id
   }