Import contact data for a licence

app/presenters/import/legacy/company-contact.presenter.js

@@ -0,0 +1,30 @@
+'use strict'
+
+/**
+ * Creates a company contact in the WRLS format
+ * @module CompanyContactPresenter
+ */
+
+/**
+ * Creates a company contact in the WRLS format
+ *
+ * NALD does not have the concept of a 'company contact'. It is a WRLS construct only.
+ *
+ * If the NALD party is of type 'PERS', WRLS on import splits it into a 'company' and 'contact' record. The
+ * 'company-contact' record is the thing that links then together in WRLS.
+ *
+ * @param {ImportLegacyContactType} contact - the legacy NALD contact derived from the 'party'
+ *
+ * @returns {object} the details needed to persist the company contact in WRLS
+ */
+function go (contact) {
+  return {
+    externalId: contact.external_id,
+    startDate: contact.start_date,
+    licenceRoleId: contact.licence_role_id
+  }
+}
+
+module.exports = {
+  go
+}

app/presenters/import/legacy/contact.presenter.js

@@ -0,0 +1,28 @@
+'use strict'
+
+/**
+ * Maps the legacy NALD contact data to the WRLS format
+ * @module ContactPresenter
+ */
+
+/**
+ * Maps the legacy NALD contact data to the WRLS format
+ *
+ * @param {ImportLegacyContactType} contact - the legacy NALD contact
+ *
+ * @returns {object} the NALD contact data transformed into the WRLS format for a contact
+ * ready for validation and persisting
+ */
+function go (contact) {
+  return {
+    externalId: contact.external_id,
+    salutation: contact.salutation,
+    initials: contact.initials,
+    firstName: contact.first_name,
+    lastName: contact.last_name
+  }
+}
+
+module.exports = {
+  go
+}

app/services/import/legacy/fetch-company.service.js

@@ -8,7 +8,7 @@
 const { db } = require('../../../../db/db.js')
 
 /**
- * Fetches the licence data from the import.NALD_PARTIES table for the licence ref
+ * Fetches the party data from the import.NALD_PARTIES table for the licence ref
  *
  * From this point parties will be referred to as companies and a party will be known as a company
  *
@@ -29,24 +29,6 @@ function _query () {
   return `
   SELECT DISTINCT ON (np."ID")
     (concat_ws(':', np."FGAC_REGION_CODE", np."ID")) AS external_id,
-    (
-      CASE np."SALUTATION"
-        WHEN 'null' THEN NULL
-        ELSE np."SALUTATION"
-        END
-      )  AS salutation,
-    (
-      CASE np."FORENAME"
-        WHEN 'null' THEN NULL
-        ELSE np."FORENAME"
-        END
-      )  AS firstName,
-    (
-      CASE np."NAME"
-        WHEN 'null' THEN NULL
-        ELSE np."NAME"
-        END
-      )  AS lastName,
     (
       CASE np."APAR_TYPE"
         WHEN 'PER' THEN 'person'
@@ -72,8 +54,7 @@ function _query () {
           END
           )
         END
-      )) AS name,
-    np."ID" as id
+      )) AS name
   FROM import."NALD_PARTIES" np
     LEFT JOIN import."NALD_ABS_LIC_VERSIONS" nalv
       ON nalv."ACON_APAR_ID" = np."ID"
@@ -95,10 +76,6 @@ module.exports = {
 /**
  * @typedef {object} ImportLegacyCompanyType
  *
- * @property {string} - The party id
- * @property {string|null} salutation - The salutation of the person, or null if not applicable.
- * @property {string|null} firstName - The first name of the person, or null if not applicable.
- * @property {string|null} lastName - The last name of the person, or null if not applicable.
  * @property {string} type - Indicates whether the entry is a 'person' or an 'organisation'.
  * @property {string|null} name - The full name, concatenated from salutation, forename/initials, and name.
  * @property {string} external_id - The external ID, formatted as 'FGAC_REGION_CODE:ID'.

app/services/import/legacy/fetch-contacts.service.js

@@ -0,0 +1,86 @@
+'use strict'
+
+/**
+ * Fetches the contact data from the import.NALD_PARTIES table for the licence ref
+ * @module FetchContactsService
+ */
+
+const { db } = require('../../../../db/db.js')
+
+/**
+ * Fetches the company data from the import.NALD_PARTIES table for the licence ref
+ *
+ * The only contact currently imported and saved to WRLS is the licence holder.
+ *
+ * @param {string} regionCode - The NALD region code
+ * @param {string} licenceId - The NALD licence ID
+ *
+ * @returns {Promise<ImportLegacyContactType[]>}
+ */
+async function go (regionCode, licenceId) {
+  const query = _query()
+
+  const { rows } = await db.raw(query, [regionCode, licenceId])
+
+  return rows
+}
+
+function _query () {
+  return `
+  SELECT DISTINCT ON (np."ID")
+    to_date(nalv."EFF_ST_DATE", 'DD/MM/YYYY') as start_date,
+    (concat_ws(':', np."FGAC_REGION_CODE", np."ID")) AS external_id,
+    (
+      CASE np."SALUTATION"
+        WHEN 'null' THEN NULL
+        ELSE np."SALUTATION"
+      END
+    ) AS salutation,
+    (
+      CASE np."INITIALS"
+        WHEN 'null' THEN NULL
+        ELSE np."INITIALS"
+      END
+    ) AS initials,
+    (
+      CASE np."FORENAME"
+        WHEN 'null' THEN NULL
+        ELSE np."FORENAME"
+      END
+    ) AS first_name,
+    (
+      CASE np."NAME"
+        WHEN 'null' THEN NULL
+        ELSE np."NAME"
+      END
+    ) AS last_name,
+    lr.id as licence_role_id
+  FROM import."NALD_PARTIES" np
+    LEFT JOIN import."NALD_ABS_LIC_VERSIONS" nalv
+        ON nalv."ACON_APAR_ID" = np."ID"
+        AND nalv."FGAC_REGION_CODE" = np."FGAC_REGION_CODE"
+    INNER JOIN public.licence_roles lr
+        ON lr.name = 'licenceHolder'
+  WHERE np."APAR_TYPE" != 'ORG'
+    AND nalv."FGAC_REGION_CODE" = ?
+    AND nalv."AABL_ID" = ?
+  ORDER BY  np."ID", TO_DATE(nalv."EFF_ST_DATE", 'DD/MM/YYYY') ASC;
+  `
+}
+
+module.exports = {
+  go
+}
+
+/**
+ * @typedef {object} ImportLegacyContactType
+ *
+ * @property {string|null} salutation - The salutation of the person, or null if not applicable.
+ * @property {string|null} initials - The initials of the person, or null if not applicable.
+ * @property {string|null} firstName - The first name of the person, or null if not applicable.
+ * @property {string|null} lastName - The last name of the person, or null if not applicable.
+ * @property {string} external_id - The external ID, formatted as 'FGAC_REGION_CODE:ID'.
+ * @property {Date} start_date - the earliest start date for the licence versions
+ * @property {uuid} licence_role_id - the licence role reference data id from WLRS
+ *
+ */

app/services/import/legacy/process-licence.service.js

@@ -9,6 +9,7 @@ const LicenceStructureValidator = require('../../../validators/import/licence-st
 const PersistLicenceService = require('../persist-licence.service.js')
 const ProcessLicenceReturnLogsService = require('../../jobs/return-logs/process-licence-return-logs.service.js')
 const TransformCompaniesService = require('./transform-companies.service.js')
+const TransformContactsService = require('./transform-contacts.service.js')
 const TransformLicenceService = require('./transform-licence.service.js')
 const TransformLicenceVersionPurposeConditionsService = require('./transform-licence-version-purpose-conditions.service.js')
 const TransformLicenceVersionPurposesService = require('./transform-licence-version-purposes.service.js')
@@ -38,6 +39,9 @@ async function go (licenceRef) {
     // Transform the company data
     const { transformedCompanies } = await TransformCompaniesService.go(regionCode, naldLicenceId)
 
+    // Pass the transformed companies through each transformation step, building the company as we go
+    await TransformContactsService.go(regionCode, naldLicenceId, transformedCompanies)
+
     // Ensure the built licence has all the valid child records we require
     LicenceStructureValidator.go(transformedLicence)
 

app/services/import/legacy/transform-contacts.service.js

@@ -0,0 +1,45 @@
+'use strict'
+
+/**
+ * Transforms NALD contact data into a valid object that matches the WRLS structure
+ * @module ImportLegacyTransformContactsService
+ */
+
+const FetchContactsService = require('./fetch-contacts.service.js')
+const ContactPresenter = require('../../../presenters/import/legacy/contact.presenter.js')
+const CompanyContactPresenter = require('../../../presenters/import/legacy/company-contact.presenter.js')
+const ImportContactValidator = require('../../../validators/import/contact.validator.js')
+
+/**
+ * Transforms NALD contact data into a validated object that matches the WRLS structure
+ *
+ * @param {string} regionCode - The NALD region code
+ * @param {string} licenceId - The NALD licence ID
+ * @param {object[]} transformedCompanies
+ *
+ */
+async function go (regionCode, licenceId, transformedCompanies) {
+  const naldContacts = await FetchContactsService.go(regionCode, licenceId)
+
+  naldContacts.forEach((naldContact) => {
+    const matchingCompany = _matchingCompany(transformedCompanies, naldContact)
+
+    const transformedContact = ContactPresenter.go(naldContact)
+
+    ImportContactValidator.go(transformedContact)
+
+    matchingCompany.contact = { ...transformedContact, dataSource: 'nald' }
+
+    matchingCompany.companyContact = CompanyContactPresenter.go(naldContact)
+  })
+}
+
+function _matchingCompany (transformedCompanies, naldContact) {
+  return transformedCompanies.find((company) => {
+    return company.externalId === naldContact.external_id
+  })
+}
+
+module.exports = {
+  go
+}

app/services/import/persist-licence.service.js

@@ -5,12 +5,14 @@
  * @module PersistLicenceService
  */
 
-const { timestampForPostgres } = require('../../lib/general.lib.js')
+const CompanyModel = require('../../models/company.model.js')
+const ContactModel = require('../../models/contact.model.js')
 const LicenceModel = require('../../models/licence.model.js')
 const LicenceVersionModel = require('../../models/licence-version.model.js')
-const LicenceVersionPurposeModel = require('../../models/licence-version-purpose.model.js')
 const LicenceVersionPurposeConditionModel = require('../../models/licence-version-purpose-condition.model.js')
-const CompanyModel = require('../../models/company.model.js')
+const LicenceVersionPurposeModel = require('../../models/licence-version-purpose.model.js')
+const { timestampForPostgres } = require('../../lib/general.lib.js')
+const { db } = require('../../../db/db.js')
 
 /**
  * Creates or updates an imported licence and its child entities that have been transformed and validated
@@ -140,11 +142,19 @@ async function _persistLicenceVersionPurposeCondition (
 async function _persistCompanies (trx, updatedAt, companies) {
   for (const company of companies) {
     await _persistCompany(trx, updatedAt, company)
+
+    if (company.contact) {
+      await _persistContact(trx, updatedAt, company.contact)
+    }
+
+    if (company.companyContact) {
+      await _persistsCompanyContact(trx, updatedAt, company.companyContact)
+    }
   }
 }
 
 async function _persistCompany (trx, updatedAt, company) {
-  const { ...propertiesToPersist } = company
+  const { contact, companyContact, ...propertiesToPersist } = company
 
   return CompanyModel.query(trx)
     .insert({ ...propertiesToPersist, updatedAt })
@@ -156,6 +166,38 @@ async function _persistCompany (trx, updatedAt, company) {
     ])
 }
 
+async function _persistContact (trx, updatedAt, contact) {
+  return ContactModel.query(trx)
+    .insert({ ...contact, updatedAt })
+    .onConflict('externalId')
+    .merge([
+      'salutation',
+      'initials',
+      'firstName',
+      'lastName',
+      'updatedAt'
+    ])
+}
+
+async function _persistsCompanyContact (trx, updatedAt, companyContact) {
+  const { externalId, startDate, licenceRoleId } = companyContact
+
+  return db.raw(`
+    INSERT INTO public."company_contacts" (company_id, contact_id, licence_role_id, start_date, "default", created_at, updated_at)
+    SELECT com.id, con.id, lr.id, ?, true, NOW(), ?
+    FROM public.companies com
+      JOIN public."licence_roles" lr on lr.id = ?
+      JOIN public.contacts con ON con.external_id = ?
+    WHERE com.external_id = ?
+    ON CONFLICT (company_id, contact_id, licence_role_id, start_date)
+      DO UPDATE SET
+        contact_id = EXCLUDED.contact_id,
+        "default" = EXCLUDED."default",
+        updated_at = EXCLUDED.updated_at
+  `, [startDate, updatedAt, licenceRoleId, externalId, externalId])
+    .transacting(trx)
+}
+
 module.exports = {
   go
 }

app/validators/import/contact.validator.js

@@ -0,0 +1,34 @@
+'use strict'
+
+/**
+ * @module ImportContactValidator
+ */
+
+const Joi = require('joi')
+
+/**
+ * Checks that the imported contact data has been transformed and is valid for persisting to WRLS
+ *
+ * @param {object} contact - The transformed contact data
+ *
+ * @throws {Joi.ValidationError} - throws a Joi validation error if the validation fails
+ */
+function go (contact) {
+  const schema = Joi.object({
+    salutation: Joi.string().allow(null),
+    initials: Joi.string().allow(null),
+    firstName: Joi.string().allow(null),
+    lastName: Joi.string().allow(null),
+    externalId: Joi.string().required()
+  })
+
+  const result = schema.validate(contact, { convert: false })
+
+  if (result.error) {
+    throw result.error
+  }
+}
+
+module.exports = {
+  go
+}