@defra-fish/dynamics-lib 1.38.0-rc.9 → 1.38.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/dynamics-lib",
-  "version": "1.38.0-rc.9",
+  "version": "1.38.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": "a8ec3497238f140ef01a6cbe98a3dc784d3d4793"
+  "gitHead": "969a00c2d4362e0413ead04f9afbef4fd11f9531"
 }

package/src/__mocks__/option-set-data.json

@@ -6630,57 +6630,6 @@
         }
       ]
     },
-    {
-      "Name": "defra_cancelledreason",
-      "MetadataId": "c5bb4ec0-78b5-4413-9c95-b879793343c7",
-      "Options": [
-        {
-          "Value": 910400195,
-          "Color": "#0000ff",
-          "IsManaged": false,
-          "ExternalValue": null,
-          "ParentValues": [],
-          "MetadataId": null,
-          "HasChanged": null,
-          "Label": {
-            "LocalizedLabels": [
-              {
-                "Label": "User cancelled",
-                "LanguageCode": 1033,
-                "IsManaged": false,
-                "MetadataId": "cd2cfff1-d4e1-e711-810c-5065f38ada61",
-                "HasChanged": null
-              }
-            ],
-            "UserLocalizedLabel": {
-              "Label": "User cancelled",
-              "LanguageCode": 1033,
-              "IsManaged": false,
-              "MetadataId": "cd2cfff1-d4e1-e711-810c-5065f38ada61",
-              "HasChanged": null
-            }
-          },
-          "Description": {
-            "LocalizedLabels": [
-              {
-                "Label": "",
-                "LanguageCode": 1033,
-                "IsManaged": false,
-                "MetadataId": "de2cfff1-d4e1-e711-810c-5065f38ada61",
-                "HasChanged": null
-              }
-            ],
-            "UserLocalizedLabel": {
-              "Label": "",
-              "LanguageCode": 1033,
-              "IsManaged": false,
-              "MetadataId": "de2cfff1-d4e1-e711-810c-5065f38ada61",
-              "HasChanged": null
-            }
-          }
-        }
-      ]
-    },
     {
       "Name": "defra_poclfilestatus",
       "MetadataId": "ed91518d-2948-4b5b-8cc2-cb9ce7cb751c",

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

@@ -1,4 +1,4 @@
-import { Contact, Permission, RecurringPayment, retrieveGlobalOptionSets } from '../../index.js'
+import { Contact, RecurringPayment, retrieveGlobalOptionSets } from '../../index.js'
 
 let optionSetData
 describe('recurring payment entity', () => {
@@ -6,149 +6,52 @@ describe('recurring payment entity', () => {
     optionSetData = await retrieveGlobalOptionSets().cached()
   })
 
-  const createRecurringPayment = (contact, permission, cancelledDate, cancelledReason) => {
-    const recurringPayment = new RecurringPayment()
-
-    recurringPayment.name = 'Test Name'
-    recurringPayment.nextDueDate = '2019-12-14T00:00:00Z'
-    recurringPayment.cancelledDate = cancelledDate
-    recurringPayment.cancelledReason = cancelledReason
-    recurringPayment.endDate = '2019-12-15T00:00:00Z'
-    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)
-
-    return recurringPayment
-  }
-
-  const getRecurringPayment = (overrides = {}) => {
-    const defaultResponse = {
-      '@odata.etag': 'W/"11528905"',
-      defra_recurringpaymentid: 'b5b24adf-2e83-ea11-a811-000d3a649213',
-      defra_name: '18569ba8-094e-4e8c-9911-bfedd5ccc17a',
-      defra_nextduedate: '2019-12-14T00:00:00Z',
-      defra_cancelleddate: '2019-12-14T00:00:00Z',
-      defra_cancelledreason: 910400195,
-      defra_enddate: '2019-12-15T00:00:00Z',
-      defra_agreementid: 'c9267c6e-573d-488b-99ab-ea18431fc472',
-      defra_publicid: '649-213',
-      statecode: 1,
-      _defra_contact_value: 'b3d33cln-2e83-ea11-a811-000d3a649213',
-      _defra_activepermission_value: 'a5b24adf-2e83-ea11-a811-000d3a649213'
+  it('maps from dynamics', async () => {
+    const recurringPayment = RecurringPayment.fromResponse(
+      {
+        '@odata.etag': 'W/"53585133"',
+        defra_recurringpaymentid: 'b5b24adf-2e83-ea11-a811-000d3a649213',
+        defra_name: '18569ba8-094e-4e8c-9911-bfedd5ccc17a',
+        defra_mandate: 'c9267c6e-573d-488b-99ab-ea18431fc472',
+        defra_inceptionday: 2,
+        defra_inceptionmonth: 1
+      },
+      optionSetData
+    )
+
+    const expectedFields = {
+      id: 'b5b24adf-2e83-ea11-a811-000d3a649213',
+      referenceNumber: '18569ba8-094e-4e8c-9911-bfedd5ccc17a',
+      mandate: 'c9267c6e-573d-488b-99ab-ea18431fc472',
+      inceptionDay: 2,
+      inceptionMonth: 1
     }
 
-    const response = { ...defaultResponse, ...overrides }
-
-    return RecurringPayment.fromResponse(response, optionSetData)
-  }
-
-  describe('mappings with cancelled rp', () => {
-    it('is a recurring payment', () => {
-      const recurringPayment = getRecurringPayment()
-      expect(recurringPayment).toBeInstanceOf(RecurringPayment)
-    })
-
-    it('matches expectedFields', () => {
-      const recurringPayment = getRecurringPayment()
-      expect(recurringPayment).toMatchObject(
-        expect.objectContaining({
-          etag: 'W/"11528905"',
-          id: 'b5b24adf-2e83-ea11-a811-000d3a649213',
-          name: '18569ba8-094e-4e8c-9911-bfedd5ccc17a',
-          nextDueDate: '2019-12-14T00:00:00Z',
-          cancelledDate: '2019-12-14T00:00:00Z',
-          cancelledReason: expect.objectContaining({ id: 910400195, label: 'User cancelled', description: 'User cancelled' }),
-          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'
-        })
-      )
-    })
-
-    it('maps to dynamics', async () => {
-      const contact = new Contact()
-      const permission = new Permission()
-      const recurringPayment = createRecurringPayment(
-        contact,
-        permission,
-        '2019-10-14T00:00:00Z',
-        optionSetData.defra_cancelledreason.options['910400195']
-      )
-      const dynamicsEntity = recurringPayment.toRequestBody()
-      expect(dynamicsEntity).toMatchObject(
-        expect.objectContaining({
-          defra_name: 'Test Name',
-          defra_nextduedate: '2019-12-14T00:00:00Z',
-          defra_cancelleddate: '2019-10-14T00:00:00Z',
-          defra_cancelledreason: 910400195,
-          defra_enddate: '2019-12-15T00:00:00Z',
-          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}`
-        })
-      )
-    })
+    expect(recurringPayment).toBeInstanceOf(RecurringPayment)
+    expect(recurringPayment).toMatchObject(expect.objectContaining({ etag: 'W/"53585133"', ...expectedFields }))
+    expect(recurringPayment.toJSON()).toMatchObject(expect.objectContaining(expectedFields))
+    expect(JSON.parse(recurringPayment.toString())).toMatchObject(expect.objectContaining(expectedFields))
   })
 
-  describe('mappings without cancelled rp', () => {
-    it('is a recurring payment', () => {
-      const recurringPayment = getRecurringPayment({ defra_cancelleddate: null, defra_cancelledreason: null })
-      expect(recurringPayment).toBeInstanceOf(RecurringPayment)
-    })
+  it('maps to dynamics', async () => {
+    const contact = new Contact()
 
-    it('matches expectedFields', () => {
-      const recurringPayment = getRecurringPayment({ defra_cancelleddate: null, defra_cancelledreason: null })
-      expect(recurringPayment).toMatchObject(
-        expect.objectContaining({
-          etag: 'W/"11528905"',
-          id: 'b5b24adf-2e83-ea11-a811-000d3a649213',
-          name: '18569ba8-094e-4e8c-9911-bfedd5ccc17a',
-          nextDueDate: '2019-12-14T00:00:00Z',
-          cancelledDate: null,
-          cancelledReason: null,
-          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'
-        })
-      )
-    })
-
-    it('maps to dynamics', async () => {
-      const contact = new Contact()
-      const permission = new Permission()
-      const recurringPayment = createRecurringPayment(contact, permission, null, null)
-      const dynamicsEntity = recurringPayment.toRequestBody()
-      expect(dynamicsEntity).toMatchObject(
-        expect.objectContaining({
-          defra_name: 'Test Name',
-          defra_nextduedate: '2019-12-14T00:00:00Z',
-          defra_cancelleddate: null,
-          defra_cancelledreason: null,
-          defra_enddate: '2019-12-15T00:00:00Z',
-          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}`
-        })
-      )
-    })
+    const recurringPayment = new RecurringPayment()
+    recurringPayment.referenceNumber = 'Test Reference Number'
+    recurringPayment.mandate = 'Test mandate'
+    recurringPayment.inceptionDay = 28
+    recurringPayment.inceptionMonth = 2
+    recurringPayment.bindToEntity(RecurringPayment.definition.relationships.payer, contact)
+
+    const dynamicsEntity = recurringPayment.toRequestBody()
+    expect(dynamicsEntity).toMatchObject(
+      expect.objectContaining({
+        defra_name: 'Test Reference Number',
+        defra_mandate: 'Test mandate',
+        defra_inceptionday: 28,
+        defra_inceptionmonth: 2,
+        'defra_Contact@odata.bind': `$${contact.uniqueContentId}`
+      })
+    )
   })
 })

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

@@ -1,6 +1,5 @@
 import { BaseEntity, EntityDefinition } from './base.entity.js'
 import { Contact } from './contact.entity.js'
-import { Permission } from './permission.entity.js'
 
 /**
  * Recurring payment entity
@@ -14,20 +13,13 @@ export class RecurringPayment extends BaseEntity {
     defaultFilter: 'statecode eq 0',
     mappings: {
       id: { field: 'defra_recurringpaymentid', type: 'string' },
-      name: { field: 'defra_name', type: 'string' },
-      status: { field: 'statecode', type: 'decimal' },
-      nextDueDate: { field: 'defra_nextduedate', type: 'datetime' },
-      cancelledDate: { field: 'defra_cancelleddate', type: 'datetime' },
-      cancelledReason: { field: 'defra_cancelledreason', type: 'optionset', ref: 'defra_cancelledreason' },
-      endDate: { field: 'defra_enddate', type: 'datetime' },
-      agreementId: { field: 'defra_agreementid', type: 'string' },
-      activePermission: { field: '_defra_activepermission_value', type: 'string' },
-      contactId: { field: '_defra_contact_value', type: 'string' },
-      publicId: { field: 'defra_publicid', type: 'string' }
+      referenceNumber: { field: 'defra_name', type: 'string' },
+      mandate: { field: 'defra_mandate', type: 'string' },
+      inceptionDay: { field: 'defra_inceptionday', type: 'integer' },
+      inceptionMonth: { field: 'defra_inceptionmonth', type: 'integer' }
     },
     relationships: {
-      contact: { property: 'defra_Contact', entity: Contact, parent: true },
-      activePermission: { property: 'defra_ActivePermission', entity: Permission, parent: true }
+      payer: { property: 'defra_Contact', entity: Contact, parent: true }
     }
   }))
 
@@ -40,122 +32,52 @@ export class RecurringPayment extends BaseEntity {
   }
 
   /**
-   * The default name associated with the recurring payment
+   * The reference number associated with the recurring payment
    * @type {string}
    */
-  get name () {
-    return super._getState('name')
+  get referenceNumber () {
+    return super._getState('referenceNumber')
   }
 
-  set name (name) {
-    super._setState('name', name)
+  set referenceNumber (referenceNumber) {
+    super._setState('referenceNumber', referenceNumber)
   }
 
   /**
-   * The date the recurring payment is due
-   * @type {datetime}
-   */
-  get nextDueDate () {
-    return super._getState('nextDueDate')
-  }
-
-  set nextDueDate (nextDueDate) {
-    super._setState('nextDueDate', nextDueDate)
-  }
-
-  /**
-   * The date the recurring payment was cancelled
-   * @type {datetime}
-   */
-  get cancelledDate () {
-    return super._getState('cancelledDate')
-  }
-
-  set cancelledDate (cancelledDate) {
-    super._setState('cancelledDate', cancelledDate)
-  }
-
-  /**
-   * The reason the recurring payment was cancelled
-   * @type {GlobalOptionSetDefinition}
-   */
-  get cancelledReason () {
-    return super._getState('cancelledReason')
-  }
-
-  set cancelledReason (cancelledReason) {
-    super._setState('cancelledReason', cancelledReason)
-  }
-
-  /**
-   * The end of the recurring payment
-   * @type {datetime}
-   */
-  get endDate () {
-    return super._getState('endDate')
-  }
-
-  set endDate (endDate) {
-    super._setState('endDate', endDate)
-  }
-
-  /**
-   * The agreement identification number
+   * The mandate identifier associated with the recurring payment
    * @type {string}
    */
-  get agreementId () {
-    return super._getState('agreementId')
+  get mandate () {
+    return super._getState('mandate')
   }
 
-  set agreementId (agreementId) {
-    super._setState('agreementId', agreementId)
+  set mandate (mandate) {
+    super._setState('mandate', mandate)
   }
 
   /**
-   * Hash of the id
-   * @type {string}
+   * The inception day associated with the recurring payment
+   * @type {integer}
    */
-  get publicId () {
-    return super._getState('publicId')
+  get inceptionDay () {
+    return super._getState('inceptionDay')
   }
 
-  set publicId (publicId) {
-    super._setState('publicId', publicId)
+  set inceptionDay (inceptionDay) {
+    super._setState('inceptionDay', inceptionDay)
   }
 
   /**
-   * The state code
-   * @type {decimal}
-   */
-  get status () {
-    return super._getState('status')
-  }
-
-  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}
+   * The inception month associated with the recurring payment
+   * Note: Months are zero indexed, so January is month 0.
+   *
+   * @type {integer}
    */
-  get activePermission () {
-    return super._getState('activePermission')
+  get inceptionMonth () {
+    return super._getState('inceptionMonth')
   }
 
-  set activePermission (activePermission) {
-    super._setState('activePermission', activePermission)
+  set inceptionMonth (inceptionMonth) {
+    super._setState('inceptionMonth', inceptionMonth)
   }
 }

package/src/index.js

@@ -26,7 +26,6 @@ export * from './queries/permission.queries.js'
 export * from './queries/fulfilment.queries.js'
 export * from './queries/concession-proof.queries.js'
 export * from './queries/pocl-validation-error.queries.js'
-export * from './queries/recurring-payment.queries.js'
 
 // Framework functionality
 export * from './client/util.js'

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

@@ -1,31 +0,0 @@
-import { findDueRecurringPayments } from '../recurring-payment.queries.js'
-
-describe('Recurring Payment Queries', () => {
-  describe('findDueRecurringPayments', () => {
-    it('builds a query to retrieve active recurring payments', () => {
-      const date = new Date('2023-11-08')
-
-      const query = findDueRecurringPayments(date)
-
-      expect(query.toRetrieveRequest()).toEqual({
-        collection: 'defra_recurringpayments',
-        filter:
-          "Microsoft.Dynamics.CRM.On(PropertyName='defra_nextduedate', PropertyValue='Wed Nov 08 2023 00:00:00 GMT+0000 (Greenwich Mean Time)')",
-        select: [
-          'defra_recurringpaymentid',
-          'defra_name',
-          'statecode',
-          'defra_nextduedate',
-          'defra_cancelleddate',
-          'defra_cancelledreason',
-          'defra_enddate',
-          'defra_agreementid',
-          '_defra_activepermission_value',
-          '_defra_contact_value',
-          'defra_publicid'
-        ],
-        expand: [{ property: 'defra_Contact' }, { property: 'defra_ActivePermission' }]
-      })
-    })
-  })
-})

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

@@ -1,20 +0,0 @@
-import { RecurringPayment } from '../entities/recurring-payment.entity.js'
-import { PredefinedQuery } from './predefined-query.js'
-
-/**
- * Builds a query to retrieve active recurring payment and related entities for a given date
- *
- * @param date current date used for lookup
- * @returns {PredefinedQuery}
- */
-export const findDueRecurringPayments = date => {
-  const { contact, activePermission } = RecurringPayment.definition.relationships
-
-  const filter = `Microsoft.Dynamics.CRM.On(PropertyName='defra_nextduedate', PropertyValue='${date}')`
-
-  return new PredefinedQuery({
-    root: RecurringPayment,
-    filter: filter,
-    expand: [contact, activePermission]
-  })
-}