@defra-fish/dynamics-lib 1.67.0 → 1.68.0-rc.1

package/package.json

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

package/src/queries/__tests__/contact.queries.spec.js

@@ -1,6 +1,6 @@
-import { contactForLicensee, contactForLicenseeNoReference } from '../contact.queries.js'
-import { dynamicsClient } from '../../client/dynamics-client.js'
+import { contactAndPermissionForLicensee, contactForLicenseeNoReference } from '../contact.queries.js'
 import { Contact } from '../../entities/contact.entity.js'
+import { Permission } from '../../entities/permission.entity.js'
 import { PredefinedQuery } from '../predefined-query.js'
 
 jest.mock('dynamics-web-api', () => {
@@ -12,94 +12,6 @@ jest.mock('dynamics-web-api', () => {
 })
 
 describe('Contact Queries', () => {
-  describe('contactForLicensee', () => {
-    const mockResponse = {
-      ContactId: 'f1bb733e-3b1e-ea11-a810-000d3a25c5d6',
-      FirstName: 'Fester',
-      LastName: 'Tester',
-      DateOfBirth: '9/13/1946 12:00:00 AM',
-      Premises: '47',
-      Street: null,
-      Town: 'Testerton',
-      Locality: null,
-      Postcode: 'AB12 3CD',
-      ReturnStatus: 'success',
-      SuccessMessage: 'contact found successfully',
-      ErrorMessage: null,
-      ReturnPermissionNumber: '11100420-2WT1SFT-KPMW2C',
-      oDataContext: 'https://api.com/api/data/v9.1/$metadata#Microsoft.Dynamics.CRM.defra_GetContactByLicenceAndPostcodeResponse'
-    }
-
-    const noContactResponse = {
-      ContactId: null,
-      FirstName: null,
-      LastName: null,
-      DateOfBirth: null,
-      Premises: null,
-      Street: null,
-      Town: null,
-      Locality: null,
-      Postcode: null,
-      ReturnStatus: 'error',
-      SuccessMessage: '',
-      ErrorMessage: 'contact does not exists',
-      ReturnPermissionNumber: null,
-      oDataContext:
-        'https://api.crm4.dynamics.com/api/data/v9.1/$metadata#Microsoft.Dynamics.CRM.defra_GetContactByLicenceAndPostcodeResponse'
-    }
-
-    it('should call dynamicsClient with correct parameters', async () => {
-      dynamicsClient.executeUnboundAction.mockResolvedValue(mockResponse)
-
-      const permissionNumber = 'KPMW2C'
-      const postcode = 'AB12 3CD'
-
-      await contactForLicensee(permissionNumber, postcode)
-
-      expect(dynamicsClient.executeUnboundAction).toHaveBeenCalledWith('defra_GetContactByLicenceAndPostcode', {
-        PermissionNumber: permissionNumber,
-        InputPostCode: postcode
-      })
-    })
-
-    it('should return the CRM response correctly', async () => {
-      dynamicsClient.executeUnboundAction.mockResolvedValue(mockResponse)
-
-      const result = await contactForLicensee('KPMW2C', 'AB12 3CD')
-
-      expect(result).toEqual(mockResponse)
-    })
-
-    it('should handle error in dynamicsClient response', async () => {
-      const error = new Error('Failed to fetch data')
-      dynamicsClient.executeUnboundAction.mockRejectedValue(error)
-
-      await expect(contactForLicensee('KPMW2C', 'AB12 3CD')).rejects.toThrow('Failed to fetch data')
-    })
-
-    it('should handle the case where contact does not exist', async () => {
-      dynamicsClient.executeUnboundAction.mockResolvedValue(noContactResponse)
-
-      const result = await contactForLicensee('654321', 'ZZ1 1ZZ')
-
-      expect(result).toMatchObject({
-        ContactId: null,
-        FirstName: null,
-        LastName: null,
-        DateOfBirth: null,
-        Premises: null,
-        Street: null,
-        Town: null,
-        Locality: null,
-        Postcode: null,
-        ReturnStatus: 'error',
-        SuccessMessage: '',
-        ErrorMessage: 'contact does not exists',
-        ReturnPermissionNumber: null
-      })
-    })
-  })
-
   describe('contactForLicenseeNoReference', () => {
     beforeEach(() => {
       jest.resetAllMocks()
@@ -145,4 +57,96 @@ describe('Contact Queries', () => {
       })
     })
   })
+
+  describe('contactAndPermissionForLicensee', () => {
+    beforeEach(() => {
+      jest.resetAllMocks()
+
+      jest.spyOn(Contact.definition, 'mappings', 'get').mockReturnValue({
+        id: { field: 'mock_contactid' },
+        postcode: { field: 'mock_postcode' }
+      })
+
+      jest.spyOn(Permission.definition, 'mappings', 'get').mockReturnValue({
+        referenceNumber: { field: 'mock_reference' },
+        issueDate: { field: 'mock_issueDate' }
+      })
+
+      jest.spyOn(Permission.definition, 'defaultFilter', 'get').mockReturnValue('statecode eq 0')
+
+      jest.spyOn(Permission.definition, 'relationships', 'get').mockReturnValue({
+        licensee: { property: 'mock_licensee' }
+      })
+    })
+
+    it('should return a predefined query', () => {
+      const result = contactAndPermissionForLicensee('ABC123', 'AB12 3CD')
+      expect(result).toBeInstanceOf(PredefinedQuery)
+    })
+
+    it('root should return Permission', () => {
+      const result = contactAndPermissionForLicensee('ABC123', 'AB12 3CD')
+      expect(result._root).toEqual(Permission)
+    })
+
+    it('should build correct filter', () => {
+      const result = contactAndPermissionForLicensee('ABC123', 'AB12 3CD')
+
+      expect(result._retrieveRequest.filter).toEqual(
+        "endswith(mock_reference, 'ABC123') and statecode eq 0 and mock_licensee/mock_postcode eq 'AB12 3CD'"
+      )
+    })
+
+    it('should build correct orderBy', () => {
+      const result = contactAndPermissionForLicensee('ABC123', 'AB12 3CD')
+
+      expect(result._retrieveRequest.orderBy).toEqual(['mock_issueDate desc', 'mock_licensee/mock_contactid asc'])
+    })
+
+    it('should set expand correctly', () => {
+      const result = contactAndPermissionForLicensee('ABC123', 'AB12 3CD')
+
+      expect(result._retrieveRequest.expand).toEqual([
+        {
+          property: 'mock_licensee',
+          select: ['mock_contactid', 'mock_postcode']
+        }
+      ])
+    })
+
+    it.each([
+      ['XYZ999', 'EF45 6GH'],
+      ['123ABC', 'IJ78 9KL'],
+      ['AAAAAA', 'ZZ99 9ZZ']
+    ])(
+      'should return correct retrieve request when the last 6 characters of the permission is %s and postcode is %s',
+      (permissionLast6, postcode) => {
+        const result = contactAndPermissionForLicensee(permissionLast6, postcode)
+
+        expect(result._retrieveRequest).toEqual({
+          collection: 'defra_permissions',
+          filter: `endswith(mock_reference, '${permissionLast6}') and statecode eq 0 and mock_licensee/mock_postcode eq '${postcode}'`,
+          orderBy: ['mock_issueDate desc', 'mock_licensee/mock_contactid asc'],
+          expand: [
+            {
+              property: 'mock_licensee',
+              select: ['mock_contactid', 'mock_postcode']
+            }
+          ],
+          select: [
+            'defra_permissionid',
+            'defra_name',
+            'defra_issuedate',
+            'defra_startdate',
+            'defra_enddate',
+            'defra_stagingid',
+            'defra_datasource',
+            'defra_renewal',
+            'defra_rcpagreement',
+            'defra_licenceforyou'
+          ]
+        })
+      }
+    )
+  })
 })

package/src/queries/contact.queries.js

@@ -1,42 +1,8 @@
-import { dynamicsClient } from '../client/dynamics-client.js'
 import { Contact } from '../entities/contact.entity.js'
+import { Permission } from '../entities/permission.entity.js'
 import { escapeODataStringValue } from '../client/util.js'
 import { PredefinedQuery } from './predefined-query.js'
 
-/**
- * @typedef {Object} ContactByLicenceAndPostcode
- * @property {string|null} ContactId - The contact's unique identifier
- * @property {string|null} FirstName - The contact's first name
- * @property {string|null} LastName - The contact's last name
- * @property {string|null} DateOfBirth - The contact's date of birth
- * @property {string|null} Street - The contact's street
- * @property {string|null} Town - The contact's town
- * @property {string|null} Locality - The contact's locality
- * @property {string|null} Postcode - The contact's postcode
- * @property {string} ReturnStatus - The status of the request (e.g., "success" or "error")
- * @property {string|null} SuccessMessage - A success message if the contact is found
- * @property {string|null} ErrorMessage - An error message if the contact is not found
- * @property {string|null} ReturnPermissionNumber - The full permission number of the contact
- * @property {string} oDataContext - The OData context URL
- */
-
-/**
- * Calls the defra_GetContactByLicenceAndPostcode CRM plugin to retrieve a contact by the last 6 characters if their license number and postcode
- *
- * @param permissionReferenceNumberLast6Characters the last 6 characters of the permission reference number
- * @param licenseePostcode the postcode of the contact associated with the permission
- * @returns {Promise<ContactByLicenceAndPostcode>}
- */
-
-export const contactForLicensee = (permissionReferenceNumberLast6Characters, licenseePostcode) => {
-  const request = {
-    PermissionNumber: permissionReferenceNumberLast6Characters,
-    InputPostCode: licenseePostcode
-  }
-
-  return dynamicsClient.executeUnboundAction('defra_GetContactByLicenceAndPostcode', request)
-}
-
 export const contactForLicenseeNoReference = (licenseeBirthDate, licenseePostcode) => {
   const { postcode, birthDate } = Contact.definition.mappings
   const filter = `${postcode.field} eq '${escapeODataStringValue(licenseePostcode)}' and ${birthDate.field} eq ${licenseeBirthDate} and ${
@@ -48,3 +14,38 @@ export const contactForLicenseeNoReference = (licenseeBirthDate, licenseePostcod
     expand: []
   })
 }
+
+/**
+ * Gets the query to get a contact by the last 6 characters if their license number and postcode
+ *
+ * @param permissionLast6Characters the last 6 characters of the permission reference number
+ * @param licenseePostcode the postcode of the contact associated with the permission
+ * @returns {Object} returns a query as an object to fetch the contact
+ */
+
+export const contactAndPermissionForLicensee = (permissionLast6Characters, licenseePostcode) => {
+  const filter = `endswith(${Permission.definition.mappings.referenceNumber.field}, '${escapeODataStringValue(
+    permissionLast6Characters
+  )}') and ${Permission.definition.defaultFilter} and ${Permission.definition.relationships.licensee.property}/${
+    Contact.definition.mappings.postcode.field
+  } eq '${escapeODataStringValue(licenseePostcode)}'`
+  const orderBy = [
+    `${Permission.definition.mappings.issueDate.field} desc`,
+    `${Permission.definition.relationships.licensee.property}/${Contact.definition.mappings.id.field} asc`
+  ]
+
+  const query = new PredefinedQuery({
+    root: Permission,
+    filter,
+    orderBy
+  })
+
+  query._retrieveRequest.expand = [
+    {
+      property: Permission.definition.relationships.licensee.property,
+      select: [Contact.definition.mappings.id.field, Contact.definition.mappings.postcode.field]
+    }
+  ]
+
+  return query
+}