@defra-fish/dynamics-lib 1.57.0-rc.1 → 1.57.0-rc.11

package/package.json

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

package/src/entities/__tests__/recurring-payment.entity.spec.js

@@ -17,8 +17,6 @@ describe('recurring payment entity', () => {
     recurringPayment.agreementId = 'c9267c6e-573d-488b-99ab-ea18431fc472'
     recurringPayment.publicId = '649-213'
     recurringPayment.status = 1
-    recurringPayment.contactId = 'b3d33cln-2e83-ea11-a811-000d3a649213'
-    recurringPayment.activePermission = 'a5b24adf-2e83-ea11-a811-000d3a649213'
 
     recurringPayment.bindToEntity(RecurringPayment.definition.relationships.contact, contact)
     recurringPayment.bindToEntity(RecurringPayment.definition.relationships.activePermission, permission)
@@ -66,9 +64,7 @@ describe('recurring payment entity', () => {
           endDate: '2019-12-15T00:00:00Z',
           agreementId: 'c9267c6e-573d-488b-99ab-ea18431fc472',
           publicId: '649-213',
-          status: 1,
-          activePermission: 'a5b24adf-2e83-ea11-a811-000d3a649213',
-          contactId: 'b3d33cln-2e83-ea11-a811-000d3a649213'
+          status: 1
         })
       )
     })
@@ -93,8 +89,6 @@ describe('recurring payment entity', () => {
           defra_agreementid: 'c9267c6e-573d-488b-99ab-ea18431fc472',
           defra_publicid: '649-213',
           statecode: 1,
-          _defra_activepermission_value: 'a5b24adf-2e83-ea11-a811-000d3a649213',
-          _defra_contact_value: 'b3d33cln-2e83-ea11-a811-000d3a649213',
           'defra_Contact@odata.bind': `$${contact.uniqueContentId}`,
           'defra_ActivePermission@odata.bind': `$${permission.uniqueContentId}`
         })
@@ -121,9 +115,7 @@ describe('recurring payment entity', () => {
           endDate: '2019-12-15T00:00:00Z',
           agreementId: 'c9267c6e-573d-488b-99ab-ea18431fc472',
           publicId: '649-213',
-          status: 1,
-          activePermission: 'a5b24adf-2e83-ea11-a811-000d3a649213',
-          contactId: 'b3d33cln-2e83-ea11-a811-000d3a649213'
+          status: 1
         })
       )
     })
@@ -143,8 +135,6 @@ describe('recurring payment entity', () => {
           defra_agreementid: 'c9267c6e-573d-488b-99ab-ea18431fc472',
           defra_publicid: '649-213',
           statecode: 1,
-          _defra_activepermission_value: 'a5b24adf-2e83-ea11-a811-000d3a649213',
-          _defra_contact_value: 'b3d33cln-2e83-ea11-a811-000d3a649213',
           'defra_Contact@odata.bind': `$${contact.uniqueContentId}`,
           'defra_ActivePermission@odata.bind': `$${permission.uniqueContentId}`
         })

package/src/entities/recurring-payment.entity.js

@@ -134,28 +134,4 @@ export class RecurringPayment extends BaseEntity {
   set status (status) {
     super._setState('status', status)
   }
-
-  /**
-   * The ID of the associated contact
-   * @type {string}
-   */
-  get contactId () {
-    return super._getState('contactId')
-  }
-
-  set contactId (contactId) {
-    super._setState('contactId', contactId)
-  }
-
-  /**
-   * The ID of the associated active permission
-   * @type {string}
-   */
-  get activePermission () {
-    return super._getState('activePermission')
-  }
-
-  set activePermission (activePermission) {
-    super._setState('activePermission', activePermission)
-  }
 }

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

@@ -1,4 +1,4 @@
-import { createActivity } from '../activity.queries.js'
+import { createActivity, updateActivity } from '../activity.queries.js'
 import { dynamicsClient } from '../../client/dynamics-client.js'
 
 jest.mock('dynamics-web-api', () => {
@@ -11,26 +11,26 @@ jest.mock('dynamics-web-api', () => {
 
 describe('Activity Service', () => {
   describe('createActivity', () => {
-    const mockResponse = {
+    const getSuccessResponse = () => ({
       '@odata.context': 'https://dynamics.com/api/data/v9.1/defra_CreateRCRActivityResponse',
       RCRActivityId: 'abc123',
       ReturnStatus: 'success',
       SuccessMessage: 'RCR Activity - created successfully',
       ErrorMessage: null,
       oDataContext: 'https://dynamics.com/api/data/v9.1/defra_CreateRCRActivityResponse'
-    }
+    })
 
-    const errorResponse = {
+    const getErrorResponse = () => ({
       '@odata.context': 'https://dynamics.com/api/data/v9.1/.defra_CreateRCRActivityResponse',
       RCRActivityId: null,
       ReturnStatus: 'error',
       SuccessMessage: '',
       ErrorMessage: 'Failed to create activity',
       oDataContext: 'https://dynamics.com/api/data/v9.1/$metadata#Microsoft.Dynamics.CRM.defra_CreateRCRActivityResponse'
-    }
+    })
 
     it('should call dynamicsClient with correct parameters', async () => {
-      dynamicsClient.executeUnboundAction.mockResolvedValue(mockResponse)
+      dynamicsClient.executeUnboundAction.mockResolvedValue(getSuccessResponse())
 
       await createActivity('contact-identifier-123', 2023)
 
@@ -42,11 +42,12 @@ describe('Activity Service', () => {
     })
 
     it('should return the CRM response correctly', async () => {
-      dynamicsClient.executeUnboundAction.mockResolvedValue(mockResponse)
+      const successResponse = getSuccessResponse()
+      dynamicsClient.executeUnboundAction.mockResolvedValue(successResponse)
 
       const result = await createActivity('contact-identifier-123', 2024)
 
-      expect(result).toEqual(mockResponse)
+      expect(result).toEqual(successResponse)
     })
 
     it('should handle error in dynamicsClient response', async () => {
@@ -57,7 +58,7 @@ describe('Activity Service', () => {
     })
 
     it('should handle the case where activity creation fails', async () => {
-      dynamicsClient.executeUnboundAction.mockResolvedValue(errorResponse)
+      dynamicsClient.executeUnboundAction.mockResolvedValue(getErrorResponse())
 
       const result = await createActivity('invalid-contact-id', 2024)
 
@@ -69,4 +70,64 @@ describe('Activity Service', () => {
       })
     })
   })
+
+  describe('updateActivity', () => {
+    const getSuccessResponse = () => ({
+      '@odata.context': 'https://dynamics.om/api/data/v9.1/defra_UpdateRCRActivityResponse',
+      ReturnStatus: 'success',
+      SuccessMessage: 'RCR Activity - updated successfully',
+      ErrorMessage: null,
+      oDataContext: 'https://dynamics.com/api/data/v9.1/defra_UpdateRCRActivityResponse'
+    })
+
+    const getErrorResponse = () => ({
+      '@odata.context': 'https://dynamics.om/api/data/v9.1/defra_UpdateRCRActivityResponse',
+      RCRActivityId: null,
+      ReturnStatus: 'error',
+      SuccessMessage: '',
+      ErrorMessage: 'Failed to update activity',
+      oDataContext: 'https://dynamics.com/api/data/v9.1/defra_UpdateRCRActivityResponse'
+    })
+
+    it('should call dynamicsClient with correct parameters', async () => {
+      dynamicsClient.executeUnboundAction.mockResolvedValue(getSuccessResponse())
+
+      await updateActivity('contact-identifier-123', 2023)
+
+      expect(dynamicsClient.executeUnboundAction).toHaveBeenCalledWith('defra_UpdateRCRActivity', {
+        ContactId: 'contact-identifier-123',
+        ActivityStatus: 'SUBMITTED',
+        Season: 2023
+      })
+    })
+
+    it('should return the CRM response correctly', async () => {
+      const successResponse = getSuccessResponse()
+      dynamicsClient.executeUnboundAction.mockResolvedValue(successResponse)
+
+      const result = await updateActivity('contact-identifier-123', 2024)
+
+      expect(result).toEqual(successResponse)
+    })
+
+    it('should handle error in dynamicsClient response', async () => {
+      const error = new Error('Failed to update activity')
+      dynamicsClient.executeUnboundAction.mockRejectedValue(error)
+
+      await expect(updateActivity('contact-identifier-123', 2024)).rejects.toThrow('Failed to update activity')
+    })
+
+    it('should handle the case where activity creation fails', async () => {
+      dynamicsClient.executeUnboundAction.mockResolvedValue(getErrorResponse())
+
+      const result = await updateActivity('invalid-contact-id', 2024)
+
+      expect(result).toMatchObject({
+        RCRActivityId: null,
+        ReturnStatus: 'error',
+        SuccessMessage: '',
+        ErrorMessage: 'Failed to update activity'
+      })
+    })
+  })
 })

package/src/queries/activity.queries.js

@@ -22,3 +22,26 @@ export const createActivity = (contactId, season) => {
 
   return dynamicsClient.executeUnboundAction('defra_CreateRCRActivity', request)
 }
+
+/**
+ * Updates an RCR Activity in Microsoft Dynamics CRM.
+ *
+ * @param {string} contactId - The ID of the contact associated with the activity.
+ * @param {number} season - The season year for which the activity is being created.
+ * @returns {Promise<Object>} - A promise that resolves to the response from Dynamics CRM.
+ * @property {string} response.@odata.context - The OData context URL of the response.
+ * @property {string} response.RCRActivityId - The unique identifier of the created RCR activity.
+ * @property {string} response.ReturnStatus - The status of the activity creation operation (e.g., 'success').
+ * @property {string} response.SuccessMessage - A message indicating successful creation of the activity.
+ * @property {string|null} response.ErrorMessage - An error message if the activity creation failed, otherwise null.
+ * @property {string} response.oDataContext - The OData context URL of the response.
+ */
+export const updateActivity = (contactId, season) => {
+  const request = {
+    ContactId: contactId,
+    ActivityStatus: 'SUBMITTED',
+    Season: season
+  }
+
+  return dynamicsClient.executeUnboundAction('defra_UpdateRCRActivity', request)
+}