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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/dynamics-lib",
-  "version": "1.35.0-rc.9",
+  "version": "1.35.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": "ab23a9e292bee3d149bb7f138750c4a55ff10ff1"
+  "gitHead": "be7f472adf337fc2e5b16431f2767defcab16d92"
 }

package/src/entities/__tests__/__snapshots__/pocl-validation-error.entity.spec.js.snap

@@ -11,6 +11,7 @@ Object {
     "id": 910400195,
     "label": "England",
   },
+  "countryUnvalidated": "GB-ENG",
   "dataSource": Object {
     "description": "Post Office Sales",
     "id": 910400000,
@@ -28,14 +29,13 @@ Object {
     "label": "Cash",
   },
   "mobilePhone": "07722 123456",
-  "newPaymentSource": Object {
+  "organisation": "Fishy Endeavours",
+  "paymentSource": Object {
     "description": "Worldpay",
     "id": 910400003,
     "label": "Worldpay",
   },
-  "newStartDate": "2021-06-15",
-  "organisation": "Fishy Endeavours",
-  "paymentSource": "Post Office Sales",
+  "paymentSourceUnvalidated": "Post Office Sales",
   "permitId": "test-permit-id",
   "postalFulfilment": true,
   "postcode": "BS9 1HJ",
@@ -57,6 +57,7 @@ Object {
   "premises": "14 Howecroft Court",
   "serialNumber": "14345-48457J",
   "startDate": "2021-06-15",
+  "startDateUnvalidated": "2021-06-15",
   "stateCode": 1,
   "status": Object {
     "description": "Needs Review",
@@ -76,6 +77,7 @@ Object {
   "defra_birthdate": "1989-07-01",
   "defra_channelid": "948594",
   "defra_concessions": "[{\\"type\\":\\"Blue Badge\\",\\"referenceNumber\\":123456789}]",
+  "defra_country": "GB-ENG",
   "defra_countrylist": 910400195,
   "defra_datasource": 910400000,
   "defra_emailaddress": "daniel-ricc@example.couk",

package/src/entities/__tests__/pocl-validation-error.entity.spec.js

@@ -7,9 +7,8 @@ describe('pocl staging exception entity', () => {
     optionSetData = await retrieveGlobalOptionSets().cached()
   })
   describe('maps from dynamics', () => {
-    let exception
-    beforeEach(() => {
-      exception = PoclValidationError.fromResponse(
+    const getPOCLValidationError = () =>
+      PoclValidationError.fromResponse(
         {
           '@odata.etag': 'W/"56351087"',
           defra_poclvalidationerrorid: '91f15d18-0aa4-ea11-a812-000d3a64905b',
@@ -21,6 +20,7 @@ describe('pocl staging exception entity', () => {
           defra_locality: 'Stoke Bishop',
           defra_town: 'Bristol',
           defra_postcode: 'BS9 1HJ',
+          defra_country: 'GB-ENG',
           defra_countrylist: 910400195,
           defra_birthdate: '1989-07-01',
           defra_emailaddress: 'daniel-ricc@example.couk',
@@ -48,14 +48,13 @@ describe('pocl staging exception entity', () => {
         },
         optionSetData
       )
-    })
 
     it('returns a PoclValidationError instance', () => {
-      expect(exception).toBeInstanceOf(PoclValidationError)
+      expect(getPOCLValidationError()).toBeInstanceOf(PoclValidationError)
     })
 
     it('has the expected data', () => {
-      expect(exception).toMatchSnapshot()
+      expect(getPOCLValidationError()).toMatchSnapshot()
     })
 
     it('has the expected fields', () => {
@@ -68,6 +67,7 @@ describe('pocl staging exception entity', () => {
         locality: 'Stoke Bishop',
         town: 'Bristol',
         postcode: 'BS9 1HJ',
+        countryUnvalidated: 'GB-ENG',
         country: expect.objectContaining({ id: 910400195, label: 'England', description: 'GB-ENG' }),
         birthDate: '1989-07-01',
         email: 'daniel-ricc@example.couk',
@@ -81,14 +81,14 @@ describe('pocl staging exception entity', () => {
         preferredMethodOfReminder: expect.objectContaining({ id: 910400002, label: 'Text', description: 'Text' }),
         postalFulfilment: true,
         concessions: '[{"type":"Blue Badge","referenceNumber":123456789}]',
+        startDateUnvalidated: '2021-06-15',
         startDate: '2021-06-15',
-        newStartDate: '2021-06-15',
         serialNumber: '14345-48457J',
         permitId: 'test-permit-id',
         transactionDate: '2020-01-01T14:00:00Z',
         amount: 30,
-        paymentSource: 'Post Office Sales',
-        newPaymentSource: {
+        paymentSourceUnvalidated: 'Post Office Sales',
+        paymentSource: {
           description: 'Worldpay',
           id: 910400003,
           label: 'Worldpay'
@@ -101,8 +101,7 @@ describe('pocl staging exception entity', () => {
         stateCode: 1,
         errorMessage: '"permissions[0].licensee.email" must be a valid email'
       }
-
-      expect(exception).toMatchObject(expect.objectContaining({ etag: 'W/"56351087"', ...expectedFields }))
+      expect(getPOCLValidationError()).toMatchObject(expect.objectContaining({ etag: 'W/"56351087"', ...expectedFields }))
     })
   })
 
@@ -116,6 +115,7 @@ describe('pocl staging exception entity', () => {
     validationError.locality = 'Stoke Bishop'
     validationError.town = 'Bristol'
     validationError.postcode = 'BS9 1HJ'
+    validationError.countryUnvalidated = 'GB-ENG'
     validationError.country = optionSetData.defra_country.options['910400195']
     validationError.birthDate = '1989-07-01'
     validationError.email = 'daniel-ricc@example.couk'
@@ -125,14 +125,14 @@ describe('pocl staging exception entity', () => {
     validationError.preferredMethodOfReminder = optionSetData.defra_preferredcontactmethod.options['910400002']
     validationError.postalFulfilment = true
     validationError.concessions = '[{"type":"Blue Badge","referenceNumber":123456789}]'
+    validationError.startDateUnvalidated = '2021-06-15'
     validationError.startDate = '2021-06-15'
-    validationError.newStartDate = '2021-06-15'
     validationError.serialNumber = '14345-48457J'
     validationError.permitId = 'test-permit-id'
     validationError.transactionDate = '2020-01-01T14:00:00Z'
     validationError.amount = 30
-    validationError.paymentSource = 'Post Office Sales'
-    validationError.newPaymentSource = optionSetData.defra_financialtransactionsource.options['910400003']
+    validationError.paymentSourceUnvalidated = 'Post Office Sales'
+    validationError.paymentSource = optionSetData.defra_financialtransactionsource.options['910400003']
     validationError.channelId = '948594'
     validationError.methodOfPayment = optionSetData.defra_paymenttype.options['910400001']
     validationError.status = optionSetData.defra_poclvalidationerrorstatus.options['910400000']

package/src/entities/base.entity.js

@@ -195,9 +195,7 @@ export class BaseEntity {
       if (type === 'date') {
         value = moment(value).format('YYYY-MM-DD')
       } else if (type === 'datetime') {
-        value = moment(value)
-          .utc()
-          .format('YYYY-MM-DDTHH:mm:ss[Z]')
+        value = moment(value).utc().format('YYYY-MM-DDTHH:mm:ss[Z]')
       } else if (type === 'optionset') {
         value = value.id
       }
@@ -375,30 +373,20 @@ export class BaseEntity {
  */
 const metadataSchema = Joi.object({
   // Local entity name
-  localName: Joi.string()
-    .min(1)
-    .required(),
+  localName: Joi.string().min(1).required(),
   // Dynamics entity collection name
-  dynamicsCollection: Joi.string()
-    .min(1)
-    .required(),
+  dynamicsCollection: Joi.string().min(1).required(),
   // Default filter to apply
   defaultFilter: Joi.string(),
   // Mapping definition used by the mapping functions
   mappings: Joi.object().pattern(
     Joi.string(),
     Joi.object({
-      field: Joi.string()
-        .min(1)
-        .required(),
-      type: Joi.string()
-        .valid('string', 'integer', 'decimal', 'boolean', 'date', 'datetime', 'optionset')
-        .required(),
+      field: Joi.string().min(1).required(),
+      type: Joi.string().valid('string', 'integer', 'decimal', 'boolean', 'date', 'datetime', 'optionset').required(),
       ref: Joi.when('type', {
         is: 'optionset',
-        then: Joi.string()
-          .min(1)
-          .required(),
+        then: Joi.string().min(1).required(),
         otherwise: Joi.forbidden()
       })
     })
@@ -406,9 +394,7 @@ const metadataSchema = Joi.object({
   relationships: Joi.object().pattern(
     Joi.string(),
     Joi.object({
-      property: Joi.string()
-        .min(1)
-        .required(),
+      property: Joi.string().min(1).required(),
       entity: Joi.function()
         .class()
         .custom(value => {
@@ -420,9 +406,7 @@ const metadataSchema = Joi.object({
       parent: Joi.boolean()
     })
   ),
-  alternateKey: Joi.string()
-    .min(1)
-    .optional()
+  alternateKey: Joi.string().min(1).optional()
 }).required()
 
 /**

package/src/entities/pocl-validation-error.entity.js

@@ -15,6 +15,7 @@ export class PoclValidationError extends BaseEntity {
       firstName: { field: 'defra_firstname', type: 'string' },
       lastName: { field: 'defra_name', type: 'string' },
       birthDate: { field: 'defra_birthdate', type: 'string' },
+      countryUnvalidated: { field: 'defra_country', type: 'string' },
       country: { field: 'defra_countrylist', type: 'optionset', ref: 'defra_country' },
       postcode: { field: 'defra_postcode', type: 'string' },
       town: { field: 'defra_town', type: 'string' },
@@ -33,14 +34,14 @@ export class PoclValidationError extends BaseEntity {
       },
       postalFulfilment: { field: 'defra_postalfulfilment', type: 'boolean' },
       concessions: { field: 'defra_concessions', type: 'string' },
-      startDate: { field: 'defra_startdate', type: 'string' },
-      newStartDate: { field: 'defra_newstartdate', type: 'string' },
+      startDateUnvalidated: { field: 'defra_startdate', type: 'string' },
+      startDate: { field: 'defra_newstartdate', type: 'string' },
       serialNumber: { field: 'defra_serialnumber', type: 'string' },
       permitId: { field: 'defra_permitid', type: 'string' },
       transactionDate: { field: 'defra_transactiondate', type: 'string' },
       amount: { field: 'defra_amount', type: 'decimal' },
-      paymentSource: { field: 'defra_paymentsource', type: 'string' },
-      newPaymentSource: { field: 'defra_newpaymentsource', type: 'optionset', ref: 'defra_financialtransactionsource' },
+      paymentSourceUnvalidated: { field: 'defra_paymentsource', type: 'string' },
+      paymentSource: { field: 'defra_newpaymentsource', type: 'optionset', ref: 'defra_financialtransactionsource' },
       channelId: { field: 'defra_channelid', type: 'string' },
       methodOfPayment: { field: 'defra_methodofpayment', type: 'optionset', ref: 'defra_paymenttype' },
       status: { field: 'defra_status', type: 'optionset', ref: 'defra_poclvalidationerrorstatus' },
@@ -99,6 +100,14 @@ export class PoclValidationError extends BaseEntity {
    * The country in the licensee address associated with this pocl record
    * @type {string}
    */
+  get countryUnvalidated () {
+    return super._getState('countryUnvalidated')
+  }
+
+  set countryUnvalidated (countryUnvalidated) {
+    super._setState('countryUnvalidated', countryUnvalidated)
+  }
+
   get country () {
     return super._getState('country')
   }
@@ -267,24 +276,24 @@ export class PoclValidationError extends BaseEntity {
    * The licence start date associated with this pocl record
    * @type {string}
    */
-  get startDate () {
-    return super._getState('startDate')
+  get startDateUnvalidated () {
+    return super._getState('startDateUnvalidated')
   }
 
-  set startDate (startDate) {
-    super._setState('startDate', startDate)
+  set startDateUnvalidated (startDateUnvalidated) {
+    super._setState('startDateUnvalidated', startDateUnvalidated)
   }
 
   /**
    * The licence new start date associated with this pocl record
    * @type {string}
    */
-  get newStartDate () {
-    return super._getState('newStartDate')
+  get startDate () {
+    return super._getState('startDate')
   }
 
-  set newStartDate (newStartDate) {
-    super._setState('newStartDate', newStartDate)
+  set startDate (startDate) {
+    super._setState('startDate', startDate)
   }
 
   /**
@@ -339,24 +348,24 @@ export class PoclValidationError extends BaseEntity {
    * The payment source associated with this pocl record
    * @type {GlobalOptionSetDefinition}
    */
-  get newPaymentSource () {
-    return super._getState('newPaymentSource')
+  get paymentSource () {
+    return super._getState('paymentSource')
   }
 
-  set newPaymentSource (newPaymentSource) {
-    super._setState('newPaymentSource', newPaymentSource)
+  set paymentSource (paymentSource) {
+    super._setState('paymentSource', paymentSource)
   }
 
   /**
    * The new payment source associated with this pocl record
    * @type {string}
    */
-  get paymentSource () {
-    return super._getState('paymentSource')
+  get paymentSourceUnvalidated () {
+    return super._getState('paymentSourceUnvalidated')
   }
 
-  set paymentSource (paymentSource) {
-    super._setState('paymentSource', paymentSource)
+  set paymentSourceUnvalidated (paymentSourceUnvalidated) {
+    super._setState('paymentSourceUnvalidated', paymentSourceUnvalidated)
   }
 
   /**