@defra-fish/dynamics-lib 1.75.0-rc.2 → 1.75.0-rc.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/dynamics-lib",
-  "version": "1.75.0-rc.2",
+  "version": "1.75.0-rc.4",
   "description": "Framework to support integration with dynamics",
   "type": "module",
   "engines": {
@@ -43,5 +43,5 @@
     "simple-oauth2": "4.3.0",
     "uuid": "8.3.2"
   },
-  "gitHead": "4e154247f5b5a430aa7e6c26e71d75546d8d2411"
+  "gitHead": "663e9bf7baaedb86adc812f4a99f4accd70191be"
 }

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

@@ -1,8 +1,10 @@
 import {
   findDueRecurringPayments,
   findRecurringPaymentsByAgreementId,
-  findRecurringPaymentByPermissionId
+  findRecurringPaymentByPermissionId,
+  findRecurringPaymentById
 } from '../recurring-payments.queries.js'
+import { RecurringPayment } from '../../entities/recurring-payment.entity.js'
 
 describe('Recurring Payment Queries', () => {
   const baseSelection = () => [
@@ -62,4 +64,33 @@ describe('Recurring Payment Queries', () => {
       })
     })
   })
+
+  describe('findRecurringPaymentById', () => {
+    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'
+      jest.spyOn(RecurringPayment, 'definition', 'get').mockReturnValue(createMockDefinition(mockDefaultFilter))
+
+      const request = findRecurringPaymentById(recurringPaymentId).toRetrieveRequest()
+      expect(request.filter).toBe(`defra_recurringpaymentid eq ${recurringPaymentId} and ${mockDefaultFilter}`)
+    })
+
+    it('expands active permission relationship', () => {
+      jest.spyOn(RecurringPayment, 'definition', 'get').mockReturnValue(createMockDefinition('mock_default_filter'))
+
+      const request = findRecurringPaymentById('rcp-456').toRetrieveRequest()
+      expect(request.expand).toContainEqual({ property: 'defra_ActivePermission' })
+    })
+  })
 })

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

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