@defra-fish/dynamics-lib 1.73.0-rc.7 → 1.73.0-sales-api-refactor

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/dynamics-lib",
-  "version": "1.73.0-rc.7",
+  "version": "1.73.0-sales-api-refactor",
   "description": "Framework to support integration with dynamics",
   "type": "module",
   "engines": {
@@ -42,6 +42,5 @@
     "pluralize": "8.0.0",
     "simple-oauth2": "4.3.0",
     "uuid": "8.3.2"
-  },
-  "gitHead": "1c9a9f4c74601a11ab01e0d34620ff023d1bef1a"
+  }
 }

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

@@ -1,8 +1,10 @@
 import {
   findDueRecurringPayments,
   findRecurringPaymentsByAgreementId,
-  findRecurringPaymentByPermissionId
+  findRecurringPaymentByPermissionId,
+  findPermissionByRecurringPaymentId
 } from '../recurring-payments.queries.js'
+import { RecurringPayment } from '../../entities/recurring-payment.entity.js'
 
 describe('Recurring Payment Queries', () => {
   const baseSelection = () => [
@@ -19,7 +21,7 @@ describe('Recurring Payment Queries', () => {
   ]
 
   describe('findDueRecurringPayments', () => {
-    it('builds a query to retrieve active recurring payments', () => {
+    it('builds retrieve request with due date filter, active-state checks and contact/permission expands', () => {
       const date = new Date('2023-11-08')
 
       const query = findDueRecurringPayments(date)
@@ -35,7 +37,7 @@ describe('Recurring Payment Queries', () => {
   })
 
   describe('findRecurringPaymentsByAgreementId', () => {
-    it('builds a query to retrieve active recurring payments', () => {
+    it('builds retrieve request filtered by agreement id and active state', () => {
       const agreementId = 'abc123'
 
       const query = findRecurringPaymentsByAgreementId(agreementId)
@@ -49,7 +51,7 @@ describe('Recurring Payment Queries', () => {
   })
 
   describe('findRecurringPaymentByPermissionId', () => {
-    it('builds a query to retrieve recurring payments by permissionId', () => {
+    it('builds retrieve request filtered by active permission id and active state', () => {
       const permissionId = 'perm-123'
 
       const query = findRecurringPaymentByPermissionId(permissionId)
@@ -62,4 +64,43 @@ describe('Recurring Payment Queries', () => {
       })
     })
   })
+
+  describe('findPermissionByRecurringPaymentId', () => {
+    const createMockDefinition = defaultFilter => ({
+      defaultFilter,
+      relationships: {
+        activePermission: { property: 'defra_ActivePermission' }
+      },
+      toRetrieveRequest: filter => ({
+        collection: 'defra_recurringpayments',
+        select: baseSelection(),
+        filter
+      })
+    })
+
+    it.each(['rcp-456', 'rcp-789'])('builds full filter with conjunctions when recurring payment id is %s', recurringPaymentId => {
+      const mockDefaultFilter = 'mock_default_filter'
+      const definitionSpy = jest.spyOn(RecurringPayment, 'definition', 'get').mockReturnValue(createMockDefinition(mockDefaultFilter))
+
+      try {
+        const request = findPermissionByRecurringPaymentId(recurringPaymentId).toRetrieveRequest()
+        expect(request.filter).toBe(
+          `_defra_activepermission_value ne null and defra_recurringpaymentid eq ${recurringPaymentId} and ${mockDefaultFilter}`
+        )
+      } finally {
+        definitionSpy.mockRestore()
+      }
+    })
+
+    it('expands active permission relationship', () => {
+      const definitionSpy = jest.spyOn(RecurringPayment, 'definition', 'get').mockReturnValue(createMockDefinition('mock_default_filter'))
+
+      try {
+        const request = findPermissionByRecurringPaymentId('rcp-456').toRetrieveRequest()
+        expect(request.expand).toContainEqual({ property: 'defra_ActivePermission' })
+      } finally {
+        definitionSpy.mockRestore()
+      }
+    })
+  })
 })

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

@@ -59,3 +59,20 @@ export const findRecurringPaymentByPermissionId = permissionId => {
     expand: [activePermission]
   })
 }
+
+/**
+ * Builds a query to retrieve the active permission linked to a recurring payment
+ *
+ * @param recurringPaymentId the id of the recurring payment
+ * @returns {PredefinedQuery}
+ */
+export const findPermissionByRecurringPaymentId = recurringPaymentId => {
+  const { activePermission } = RecurringPayment.definition.relationships
+  const filter = `_defra_activepermission_value ne null and defra_recurringpaymentid eq ${recurringPaymentId} and ${RecurringPayment.definition.defaultFilter}`
+
+  return new PredefinedQuery({
+    root: RecurringPayment,
+    filter,
+    expand: [activePermission]
+  })
+}