Import Licence versions

app/controllers/import.controller.js

@@ -8,15 +8,16 @@ const Boom = require('@hapi/boom')
  * @module ImportController
  */
 async function licence (request, h) {
-  try {
-    const { licenceRef } = request.payload
+  // try {
+  const { licenceRef } = request.payload
 
-    await LegacyImportLicenceService.go(licenceRef)
+  await LegacyImportLicenceService.go(licenceRef)
 
-    return h.response().code(204)
-  } catch (error) {
-    return Boom.badImplementation(error.message)
-  }
+  return h.response().code(204)
+  // } catch (error) {
+  // log licence ref error in logs ?
+  //   return Boom.badImplementation(error.message)
+  // }
 }
 
 module.exports = {

app/services/import/legacy-import/fetch-licence-versions.service.js

@@ -6,6 +6,14 @@
  */
 const { db } = require('../../../../db/db.js')
 
+/**
+ * Gets the licence versions
+ *
+ * Returns the licence version purposes
+ *
+ * @param {LegacyLicenceType} licenceData - the licence
+ * @returns {Promise<LegacyLicenceVersionsArray>}
+ */
 async function go (licenceData) {
   const { ID: licenceId, FGAC_REGION_CODE: regionCode } = licenceData
 
@@ -14,29 +22,47 @@ async function go (licenceData) {
 
 async function _getLicenceVersions (licenceId, regionCode) {
   const query = `
-      SELECT *
-      FROM import."NALD_ABS_LIC_VERSIONS" v
-      WHERE v."FGAC_REGION_CODE" = '${regionCode}'
-        AND v."AABL_ID" = '${licenceId}'
-        AND v."STATUS" <> 'DRAFT';`
+      SELECT
+            versions."EFF_END_DATE",
+            versions."EFF_ST_DATE",
+            versions."INCR_NO",
+            versions."ISSUE_NO",
+            versions."STATUS",
+            versions."FGAC_REGION_CODE",
+            versions."AABL_ID",
+            (SELECT json_agg(json_build_object(
+              'PERIOD_END_DAY', purposes."PERIOD_END_DAY",
+              'PERIOD_END_MONTH', purposes."PERIOD_END_MONTH",
+              'PERIOD_ST_DAY', purposes."PERIOD_ST_DAY",
+              'PERIOD_ST_MONTH', purposes."PERIOD_ST_MONTH",
+              'ANNUAL_QTY', purposes."ANNUAL_QTY",
+              'DAILY_QTY', purposes."DAILY_QTY",
+              'FGAC_REGION_CODE', purposes."FGAC_REGION_CODE",
+              'ID', purposes."ID",
+              'HOURLY_QTY', purposes."HOURLY_QTY",
+              'INST_QTY', purposes."INST_QTY",
+              'NOTES', purposes."NOTES",
+              'APUR_APPR_CODE', purposes."APUR_APPR_CODE",
+              'APUR_APSE_CODE', purposes."APUR_APSE_CODE",
+              'APUR_APUS_CODE', purposes."APUR_APUS_CODE",
+              'TIMELTD_END_DATE', purposes."TIMELTD_END_DATE",
+              'TIMELTD_ST_DATE', purposes."TIMELTD_ST_DATE"
+                              )
+                      )
+              FROM import."NALD_ABS_LIC_PURPOSES" purposes
+              WHERE purposes."AABV_AABL_ID" = versions."AABL_ID"
+                AND purposes."AABV_ISSUE_NO" = versions."ISSUE_NO"
+                AND purposes."AABV_INCR_NO" = versions."INCR_NO"
+                AND purposes."FGAC_REGION_CODE" = versions."FGAC_REGION_CODE") AS purposes
+      FROM import."NALD_ABS_LIC_VERSIONS" versions
+      WHERE versions."FGAC_REGION_CODE" = '${regionCode}'
+        AND versions."AABL_ID" = '${licenceId}'
+        AND versions."STATUS" <> 'DRAFT';
+  `
 
   const { rows } = await db.raw(query)
 
-  return select(rows)
-}
-
-/**
- * Maps licence versions to the required format / data
- *
- * @param {{}} rows - the licence version columns
- * @returns {LegacyLicenceVersionsArray}
- */
-function select (rows) {
-  return rows.map((row) => {
-    return {
-      EFF_ST_DATE: row.EFF_ST_DATE
-    }
-  })
+  return rows
 }
 
 module.exports = {
@@ -47,10 +73,37 @@ module.exports = {
  * A legacy licence version
  * @typedef {Object} LegacyLicenceVersionsType
  *
- * @property {string} EFF_ST_DATE - date in UK format | 'null'
+ * @property {string} EFF_END_DATE - date in UK format - can be 'null'
+ * @property {string} EFF_ST_DATE - date in UK format
+ * @property {string} INCR_NO - a number between 1 - 5
+ * @property {string} ISSUE_NO - a number - linked to the purpose id ?
+ * @property {string} STATUS - enum - 'DRAFT', 'SUPER', 'CURR' (Draft will not be selected)
+ * @property {string} FGAC_REGION_CODE
+ * @property {string} AABL_ID
+ * @property {LegacyLicenceVersionsPurposesType} purposes
  */
 
 /**
  * An array of legacy licence versions.
  * @typedef {LegacyLicenceVersionsType[]} LegacyLicenceVersionsArray
  */
+
+/**
+ * @typedef {Object} LegacyLicenceVersionsPurposesType
+ * @property {string} PERIOD_END_DAY - The end day of the period.
+ * @property {string} PERIOD_END_MONTH - The end month of the period.
+ * @property {string} PERIOD_ST_DAY - The start day of the period.
+ * @property {string} PERIOD_ST_MONTH - The start month of the period.
+ * @property {string} ANNUAL_QTY - The annual quantity.
+ * @property {string} DAILY_QTY - The daily quantity.
+ * @property {string} FGAC_REGION_CODE - The FGAC region code.
+ * @property {string} ID - The identifier.
+ * @property {string} HOURLY_QTY - The hourly quantity.
+ * @property {string} INST_QTY - The instant quantity.
+ * @property {string} NOTES - Additional notes.
+ * @property {string} APUR_APPR_CODE - The APUR approval code.
+ * @property {string} APUR_APSE_CODE - The APUR secondary code.
+ * @property {string} APUR_APUS_CODE - The APUR usage code.
+ * @property {string} TIMELTD_END_DATE - The time-limited end date.
+ * @property {string} TIMELTD_ST_DATE - The time-limited start date.
+ */

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

@@ -17,38 +17,26 @@ async function go (licenceRef) {
 }
 
 async function _getLicenceByRef (licenceRef) {
-  // TODO: granular select  ? map data to simplify if needs be
   const query = `
-      SELECT *
-      FROM import."NALD_ABS_LICENCES" l
-      WHERE l."LIC_NO" = '${licenceRef}';
+      SELECT
+          licence.AREP_AREA_CODE,
+          licence.AREP_EIUC_CODE,
+          licence.AREP_LEAP_CODE,
+          licence.AREP_SUC_CODE,
+          licence.EXPIRY_DATE,
+          licence.FGAC_REGION_CODE,
+          licence.ID,
+          licence.LAPSED_DATE,
+          licence.LIC_NO,
+          licence.ORIG_EFF_DATE,
+          licence.REV_DATE
+      FROM import."NALD_ABS_LICENCES" licence
+      WHERE licence."LIC_NO" = '${licenceRef}';
   `
 
   const { rows: [row] } = await db.raw(query)
 
-  return select(row)
-}
-
-/**
- * Fetches the licence data for the licence ref from the import.NALD_ABS_LICENCES table
- *
- * @param {any} licence
- * @returns {LegacyLicenceType}
- */
-function select (licence) {
-  return {
-    AREP_AREA_CODE: licence.AREP_AREA_CODE,
-    AREP_EIUC_CODE: licence.AREP_EIUC_CODE,
-    AREP_LEAP_CODE: licence.AREP_LEAP_CODE,
-    AREP_SUC_CODE: licence.AREP_SUC_CODE,
-    EXPIRY_DATE: licence.EXPIRY_DATE,
-    FGAC_REGION_CODE: licence.FGAC_REGION_CODE,
-    ID: licence.ID,
-    LAPSED_DATE: licence.LAPSED_DATE,
-    LIC_NO: licence.LIC_NO,
-    ORIG_EFF_DATE: licence.ORIG_EFF_DATE,
-    REV_DATE: licence.REV_DATE
-  }
+  return row
 }
 
 module.exports = {

app/services/import/legacy-import/licence-versions.mapper.js

@@ -0,0 +1,95 @@
+'use strict'
+
+/**
+ * Maps the import licence versions data to the desired format
+ * @module LegacyImportLicenceVersionMapper
+ */
+
+const { formatStandardDateToISO } = require('../../../lib/dates.lib.js')
+
+const statuses = {
+  CURR: 'current',
+  SUPER: 'superseded',
+  DRAFT: 'draft' // todo: check this can be removed as it the sql does not get draft status
+}
+
+const createExternalId = (licenceVersion) => {
+  const { FGAC_REGION_CODE, AABL_ID, ISSUE_NO, INCR_NO } = licenceVersion
+
+  return `${FGAC_REGION_CODE}:${AABL_ID}:${ISSUE_NO}:${INCR_NO}`
+}
+
+/**
+ * Maps the import licence versions data
+ *
+ * @param {LegacyLicenceVersionsArray} licenceVersions
+ * @returns {ImportLicenceVersionType[]}
+ */
+function go (licenceVersions) {
+  return _mapLicenceVersions(licenceVersions)
+}
+
+/**
+ * Iterates the import licence versions
+ *
+ * @param {LegacyLicenceVersionsArray} licenceVersions
+ * @returns {ImportLicenceVersionType[]}
+ */
+function _mapLicenceVersions (licenceVersions) {
+  return licenceVersions.map((licenceVersion) => {
+    const issue = licenceVersion.ISSUE_NO // mapped to the legacy purpose id -
+    const increment = licenceVersion.INCR_NO
+
+    return {
+      endDate: formatStandardDateToISO(licenceVersion.EFF_END_DATE),
+      externalId: createExternalId(licenceVersion),
+      increment: Number(increment),
+      issue: Number(issue),
+      startDate: formatStandardDateToISO(licenceVersion.EFF_ST_DATE),
+      status: statuses[licenceVersion.STATUS],
+      purposes: _mapPurposes(licenceVersion)
+    }
+  })
+}
+
+/**
+ * Iterates the import licence versions purposes
+ *
+ * @param {LegacyLicenceVersionsType} licenceVersion
+ * @returns {ImportLicenceVersionPurposeType}
+ */
+function _mapPurposes (licenceVersion) {
+  return licenceVersion.purposes.map((purpose) => {
+    return _mapPurpose(purpose)
+  })
+}
+
+/**
+ * Maps the import licence versions purposes data to the desired format
+ *
+ * @param {LegacyLicenceVersionsPurposesType} purpose
+ * @returns {ImportLicenceVersionPurposeType}
+ */
+const _mapPurpose = (purpose) => {
+  return {
+    abstractionPeriodEndDay: Number(purpose.PERIOD_END_DAY),
+    abstractionPeriodEndMonth: Number(purpose.PERIOD_END_MONTH),
+    abstractionPeriodStartDay: Number(purpose.PERIOD_ST_DAY),
+    abstractionPeriodStartMonth: Number(purpose.PERIOD_ST_MONTH),
+    annualQuantity: purpose.ANNUAL_QTY === 'null' ? null : Number(purpose.ANNUAL_QTY),
+    dailyQuantity: purpose.DAILY_QTY === 'null' ? null : Number(purpose.DAILY_QTY),
+    externalId: `${purpose.FGAC_REGION_CODE}:${purpose.ID}`,
+    hourlyQuantity: purpose.HOURLY_QTY === 'null' ? null : Number(purpose.HOURLY_QTY),
+    instantQuantity: purpose.INST_QTY === 'null' ? null : Number(purpose.INST_QTY),
+    notes: purpose.NOTES === 'null' ? null : purpose.NOTES,
+    primaryPurposeId: purpose.APUR_APPR_CODE,
+    secondaryPurposeId: purpose.APUR_APSE_CODE,
+    purposeId: purpose.APUR_APUS_CODE,
+    timeLimitedEndDate: formatStandardDateToISO(purpose.TIMELTD_END_DATE),
+    timeLimitedStartDate: formatStandardDateToISO(purpose.TIMELTD_ST_DATE)
+  }
+}
+
+module.exports = {
+  go
+}

app/services/import/legacy-import/licence.mapper.js

@@ -36,7 +36,7 @@ function _mapLicence (licence, licenceVersions) {
  * Creates a JSON object of the region data
  *
  * @param {Object} licenceData
- * @return {RegionsType}
+ * @return {ImportRegionType}
  */
 const _regions = (licenceData) => {
   const historicalAreaCode = licenceData.AREP_AREA_CODE

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

@@ -7,9 +7,11 @@
 
 const FetchLegacyImportLicenceService = require('./legacy-import/fetch-licence.service.js')
 const FetchLegacyImportLicenceVersionsService = require('./legacy-import/fetch-licence-versions.service.js')
-const LegacyImportLicenceMapper = require('./legacy-import/licence.mapper.js')
 const ImportLicenceValidatorService = require('./licence-validator.service.js')
+const LegacyImportLicenceMapper = require('./legacy-import/licence.mapper.js')
+const LegacyImportLicenceVersionMapper = require('./legacy-import/licence-versions.mapper.js')
 const PersistLicenceService = require('./persist-licence.service.js')
+const PersistLicenceVersionsService = require('./persist-licence-versions.service.js')
 
 /**
  * Imports a licence from the legacy import tables. Maps and validates the data and then saves to the database.
@@ -21,22 +23,17 @@ async function go (licenceRef) {
   console.debug('Importing licence ref: ', licenceRef)
   const licenceData = await FetchLegacyImportLicenceService.go(licenceRef)
 
-  console.debug('Imported licence data: ', licenceData)
   const licenceVersionsData = await FetchLegacyImportLicenceVersionsService.go(licenceData)
 
-  console.debug('Imported licence versions data: ', licenceVersionsData)
+  const mappedLicenceData = LegacyImportLicenceMapper.go(licenceData, licenceVersionsData)
 
-  const mappedLicenceData = await LegacyImportLicenceMapper.go(licenceData, licenceVersionsData)
+  const mappedLicenceVersionsData = LegacyImportLicenceVersionMapper.go(licenceVersionsData)
 
-  console.debug('Mapped imported licence data: ', mappedLicenceData)
-
-  ImportLicenceValidatorService.go(mappedLicenceData)
+  ImportLicenceValidatorService.go(mappedLicenceData, mappedLicenceVersionsData)
 
   const savedLicence = await PersistLicenceService.go(mappedLicenceData)
 
-  console.debug('Saved Licence: ', savedLicence)
-
-  return savedLicence
+  await PersistLicenceVersionsService.go(mappedLicenceVersionsData, savedLicence.id)
 }
 
 module.exports = {