@defra-fish/dynamics-lib 1.68.0-rc.4 → 1.68.0-rc.5

package/package.json

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

package/src/entities/__tests__/rcr-activity.entity.spec.js

@@ -0,0 +1,42 @@
+import { Contact, RCRActivity, RCR_ACTIVITY_STATUS } from '../../index.js'
+
+describe('rcr activity entity', () => {
+  it('maps from dynamics', async () => {
+    const rcrActivity = RCRActivity.fromResponse({
+      activityid: '1',
+      defra_activitystatus: RCR_ACTIVITY_STATUS.STARTED,
+      defra_season: 2025,
+      actualstart: '2020-03-31T22:59:00Z',
+      modifiedon: '2020-03-31T22:59:00Z',
+      actualend: '2020-03-31T22:59:00Z'
+    })
+
+    expect(rcrActivity.id).toBe('1')
+    expect(rcrActivity.status).toBe(RCR_ACTIVITY_STATUS.STARTED)
+    expect(rcrActivity.season).toBe(2025)
+    expect(rcrActivity.startDate).toBe('2020-03-31T22:59:00Z')
+    expect(rcrActivity.lastUpdated).toBe('2020-03-31T22:59:00Z')
+    expect(rcrActivity.submittedDate).toBe('2020-03-31T22:59:00Z')
+  })
+
+  it('maps to dynamics', async () => {
+    const rcrActivity = new RCRActivity()
+    rcrActivity.status = RCR_ACTIVITY_STATUS.SUBMITTED
+    rcrActivity.season = 2025
+    rcrActivity.startDate = '2020-03-31T22:59:00Z'
+    rcrActivity.submittedDate = '2020-03-31T22:59:00Z'
+
+    const contact = new Contact()
+    rcrActivity.bindToEntity(RCRActivity.definition.relationships.licensee, contact)
+
+    const expectedFields = {
+      actualend: '2020-03-31T22:59:00Z',
+      actualstart: '2020-03-31T22:59:00Z',
+      defra_activitystatus: RCR_ACTIVITY_STATUS.SUBMITTED,
+      defra_season: 2025,
+      'regardingobjectid_contact_defra_rcractivity@odata.bind': `$${contact.uniqueContentId}`
+    }
+
+    expect(rcrActivity.toRequestBody()).toStrictEqual(expectedFields)
+  })
+})

package/src/entities/rcr-activity.entity.js

@@ -0,0 +1,95 @@
+import { BaseEntity, EntityDefinition } from './base.entity.js'
+import { Contact } from './contact.entity.js'
+
+export const RCR_ACTIVITY_STATUS = Object.freeze({
+  STARTED: 910400000,
+  SUBMITTED: 910400001
+})
+
+/**
+ * RCRActivity entity
+ * @extends BaseEntity
+ */
+export class RCRActivity extends BaseEntity {
+  /** @type {EntityDefinition} */
+  static _definition = new EntityDefinition(() => ({
+    localName: 'rcrActivity',
+    dynamicsCollection: 'defra_rcractivities',
+    defaultFilter: 'statecode eq 0',
+    mappings: {
+      id: { field: 'activityid', type: 'string' },
+      status: { field: 'defra_activitystatus', type: 'integer' },
+      season: { field: 'defra_season', type: 'integer' },
+      startDate: { field: 'actualstart', type: 'datetime' },
+      lastUpdated: { field: 'modifiedon', type: 'datetime' },
+      submittedDate: { field: 'actualend', type: 'datetime' }
+    },
+    relationships: {
+      licensee: { property: 'regardingobjectid_contact_defra_rcractivity', entity: Contact, parent: true }
+    }
+  }))
+
+  /**
+   * The {@link EntityDefinition} providing mappings between Dynamics entity and the local entity
+   * @type {EntityDefinition}
+   */
+  static get definition () {
+    return RCRActivity._definition
+  }
+
+  /**
+   * The status associated with the rcr activity
+   * @type {RCR_ACTIVITY_STATUS}
+   */
+  get status () {
+    return super._getState('status')
+  }
+
+  set status (status) {
+    super._setState('status', status)
+  }
+
+  /**
+   * The season associated with the rcr activity
+   * @type {number}
+   */
+  get season () {
+    return super._getState('season')
+  }
+
+  set season (season) {
+    super._setState('season', season)
+  }
+
+  /**
+   * The start date associated with the rcr activity
+   * @type {date}
+   */
+  get startDate () {
+    return super._getState('startDate')
+  }
+
+  set startDate (startDate) {
+    super._setState('startDate', startDate)
+  }
+
+  /**
+   * The last updated date associated with the rcr activity
+   * @type {date}
+   */
+  get lastUpdated () {
+    return super._getState('lastUpdated')
+  }
+
+  /**
+   * The submitted date associated with the rcr activity
+   * @type {date}
+   */
+  get submittedDate () {
+    return super._getState('submittedDate')
+  }
+
+  set submittedDate (submittedDate) {
+    super._setState('submittedDate', submittedDate)
+  }
+}

package/src/index.js

@@ -13,6 +13,7 @@ export * from './entities/transaction-currency.entity.js'
 export * from './entities/pocl-file.entity.js'
 export * from './entities/pocl-staging-exception.entity.js'
 export * from './entities/pocl-validation-error.entity.js'
+export * from './entities/rcr-activity.entity.js'
 export * from './entities/recurring-payment.entity.js'
 export * from './entities/recurring-payment-instruction.entity.js'
 export * from './entities/staging-exception.entity.js'
@@ -29,6 +30,7 @@ export * from './queries/pocl-validation-error.queries.js'
 export * from './queries/recurring-payments.queries.js'
 export * from './queries/contact.queries.js'
 export * from './queries/activity.queries.js'
+export * from './queries/rcr-activity.queries.js'
 
 // Framework functionality
 export * from './client/util.js'

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

@@ -63,19 +63,8 @@ describe('Contact Queries', () => {
       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' }
+        id: { field: 'contactid' },
+        postcode: { field: 'defra_postcode' }
       })
     })
 
@@ -93,14 +82,14 @@ describe('Contact Queries', () => {
       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'"
+        "endswith(defra_name, 'ABC123') and statecode eq 0 and defra_ContactId/defra_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'])
+      expect(result._retrieveRequest.orderBy).toEqual(['defra_issuedate desc', 'defra_ContactId/contactid asc'])
     })
 
     it('should set expand correctly', () => {
@@ -108,8 +97,8 @@ describe('Contact Queries', () => {
 
       expect(result._retrieveRequest.expand).toEqual([
         {
-          property: 'mock_licensee',
-          select: ['mock_contactid', 'mock_postcode']
+          property: 'defra_ContactId',
+          select: ['contactid', 'defra_postcode']
         }
       ])
     })
@@ -125,12 +114,12 @@ describe('Contact Queries', () => {
 
         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'],
+          filter: `endswith(defra_name, '${permissionLast6}') and statecode eq 0 and defra_ContactId/defra_postcode eq '${postcode}'`,
+          orderBy: ['defra_issuedate desc', 'defra_ContactId/contactid asc'],
           expand: [
             {
-              property: 'mock_licensee',
-              select: ['mock_contactid', 'mock_postcode']
+              property: 'defra_ContactId',
+              select: ['contactid', 'defra_postcode']
             }
           ],
           select: [

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

@@ -0,0 +1,48 @@
+import { RCRActivity } from '../../entities/rcr-activity.entity.js'
+import { PredefinedQuery } from '../predefined-query.js'
+import { rcrActivityForContact } from '../rcr-activity.queries.js'
+
+describe('rcrActivityForContact', () => {
+  beforeEach(() => {
+    jest.resetAllMocks()
+  })
+
+  it('should return a predefined query', () => {
+    const result = rcrActivityForContact('CONTACT123', 2024)
+    expect(result).toBeInstanceOf(PredefinedQuery)
+  })
+
+  it('root should return RCRActivity', () => {
+    const result = rcrActivityForContact('CONTACT123', 2024)
+    expect(result._root).toEqual(RCRActivity)
+  })
+
+  it('should build correct filter', () => {
+    const result = rcrActivityForContact('CONTACT123', 2024)
+
+    expect(result._retrieveRequest.filter).toEqual(
+      "regardingobjectid_contact_defra_rcractivity/contactid eq 'CONTACT123' and defra_season eq 2024 and statecode eq 0"
+    )
+  })
+
+  it('should set expand to empty array', () => {
+    const result = rcrActivityForContact('CONTACT123', 2024)
+
+    expect(result._retrieveRequest.expand).toEqual([])
+  })
+
+  it.each([
+    ['ABC123', 2023],
+    ['XYZ999', 2024],
+    ['AAAAAA', 2025]
+  ])('should return correct retrieve request when contactId is %s and season is %s', (contactId, season) => {
+    const result = rcrActivityForContact(contactId, season)
+
+    expect(result._retrieveRequest).toEqual({
+      collection: 'defra_rcractivities',
+      filter: `regardingobjectid_contact_defra_rcractivity/contactid eq '${contactId}' and defra_season eq ${season} and statecode eq 0`,
+      expand: [],
+      select: ['activityid', 'defra_activitystatus', 'defra_season', 'actualstart', 'modifiedon', 'actualend']
+    })
+  })
+})

package/src/queries/contact.queries.js

@@ -18,21 +18,20 @@ export const contactForLicenseeNoReference = (licenseeBirthDate, licenseePostcod
 /**
  * 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
+ * @param {string} permissionLast6Characters the last 6 characters of the permission reference number
+ * @param {string} licenseePostcode the postcode of the contact associated with the permission
+ * @returns {PredefinedQuery<Permission>} 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 { referenceNumber, issueDate } = Permission.definition.mappings
+  const { licensee } = Permission.definition.relationships
+  const { id } = Contact.definition.mappings
+
+  const filter = `endswith(${referenceNumber.field}, '${escapeODataStringValue(permissionLast6Characters)}') and ${
+    Permission.definition.defaultFilter
+  } and ${licensee.property}/${Contact.definition.mappings.postcode.field} eq '${escapeODataStringValue(licenseePostcode)}'`
+  const orderBy = [`${issueDate.field} desc`, `${licensee.property}/${id.field} asc`]
 
   const query = new PredefinedQuery({
     root: Permission,

package/src/queries/rcr-activity.queries.js

@@ -0,0 +1,27 @@
+import { Contact } from '../entities/contact.entity.js'
+import { RCRActivity } from '../entities/rcr-activity.entity.js'
+import { escapeODataStringValue } from '../client/util.js'
+import { PredefinedQuery } from './predefined-query.js'
+
+/**
+ * Creates a predefined OData query for retrieving {@link RCRActivity} records
+ * associated with a specific contact id and season.
+ *
+ * @param {string} contactId The unique identifier of the {@link Contact}.
+ * @param {string|number} seasonInput The season value to filter activities by.
+ * @returns {PredefinedQuery<RCRActivity>} returns a query as an object to fetch the contact
+ */
+export const rcrActivityForContact = (contactId, seasonInput) => {
+  const { season } = RCRActivity.definition.mappings
+  const { licensee } = RCRActivity.definition.relationships
+  const { id } = Contact.definition.mappings
+
+  const filter = `${licensee.property}/${id.field} eq '${escapeODataStringValue(contactId)}' and ${
+    season.field
+  } eq ${escapeODataStringValue(seasonInput)} and ${RCRActivity.definition.defaultFilter}`
+  return new PredefinedQuery({
+    root: RCRActivity,
+    filter,
+    expand: []
+  })
+}