@defra-fish/dynamics-lib 1.64.0-rc.8 → 1.64.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/dynamics-lib",
-  "version": "1.64.0-rc.8",
+  "version": "1.64.0",
   "description": "Framework to support integration with dynamics",
   "type": "module",
   "engines": {
@@ -43,5 +43,5 @@
     "simple-oauth2": "4.3.0",
     "uuid": "8.3.2"
   },
-  "gitHead": "88a60cab95e119b46cec17336d784aec1aeabae8"
+  "gitHead": "d6a3d30c7a20169fdf5afb1a93eb1d411fe96abf"
 }

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

@@ -1,6 +1,23 @@
-import { findDueRecurringPayments, findRecurringPaymentsByAgreementId } from '../recurring-payments.queries.js'
+import {
+  findDueRecurringPayments,
+  findRecurringPaymentsByAgreementId,
+  findRecurringPaymentByPermissionId
+} from '../recurring-payments.queries.js'
 
 describe('Recurring Payment Queries', () => {
+  const baseSelection = () => [
+    'defra_recurringpaymentid',
+    'defra_name',
+    'statecode',
+    'defra_nextduedate',
+    'defra_cancelleddate',
+    'defra_cancelledreason',
+    'defra_enddate',
+    'defra_agreementid',
+    'defra_publicid',
+    'defra_lastdigitscardnumbers'
+  ]
+
   describe('findDueRecurringPayments', () => {
     it('builds a query to retrieve active recurring payments', () => {
       const date = new Date('2023-11-08')
@@ -11,18 +28,7 @@ describe('Recurring Payment Queries', () => {
         collection: 'defra_recurringpayments',
         filter:
           "defra_nextduedate eq 'Wed Nov 08 2023 00:00:00 GMT+0000 (Greenwich Mean Time)' and defra_cancelleddate eq null and _defra_nextrecurringpayment_value eq null and statecode eq 0",
-        select: [
-          'defra_recurringpaymentid',
-          'defra_name',
-          'statecode',
-          'defra_nextduedate',
-          'defra_cancelleddate',
-          'defra_cancelledreason',
-          'defra_enddate',
-          'defra_agreementid',
-          'defra_publicid',
-          'defra_lastdigitscardnumbers'
-        ],
+        select: baseSelection(),
         expand: [{ property: 'defra_Contact' }, { property: 'defra_ActivePermission' }]
       })
     })
@@ -37,18 +43,22 @@ describe('Recurring Payment Queries', () => {
       expect(query.toRetrieveRequest()).toEqual({
         collection: 'defra_recurringpayments',
         filter: `defra_agreementid eq '${agreementId}' and statecode eq 0`,
-        select: [
-          'defra_recurringpaymentid',
-          'defra_name',
-          'statecode',
-          'defra_nextduedate',
-          'defra_cancelleddate',
-          'defra_cancelledreason',
-          'defra_enddate',
-          'defra_agreementid',
-          'defra_publicid',
-          'defra_lastdigitscardnumbers'
-        ]
+        select: baseSelection()
+      })
+    })
+  })
+
+  describe('findRecurringPaymentByPermissionId', () => {
+    it('builds a query to retrieve recurring payments by permissionId', () => {
+      const permissionId = 'perm-123'
+
+      const query = findRecurringPaymentByPermissionId(permissionId)
+
+      expect(query.toRetrieveRequest()).toEqual({
+        collection: 'defra_recurringpayments',
+        filter: `_defra_activepermission_value eq ${permissionId} and statecode eq 0`,
+        select: baseSelection(),
+        expand: [{ property: 'defra_ActivePermission' }]
       })
     })
   })

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

@@ -42,3 +42,20 @@ export const findRecurringPaymentsByAgreementId = agreementId => {
     filter: filters.join(' and ')
   })
 }
+
+/**
+ * Builds a query to retrieve recurring payments by permissionId
+ *
+ * @param permissionId the id generated by a permission
+ * @returns {PredefinedQuery}
+ */
+export const findRecurringPaymentByPermissionId = permissionId => {
+  const { activePermission } = RecurringPayment.definition.relationships
+  const filter = `_defra_activepermission_value eq ${permissionId} and ${RecurringPayment.definition.defaultFilter}`
+
+  return new PredefinedQuery({
+    root: RecurringPayment,
+    filter,
+    expand: [activePermission]
+  })
+}