From 0b9682911956580fb77b5edc0d80b5fe089f9c40 Mon Sep 17 00:00:00 2001 From: jonathangoulding Date: Thu, 22 Aug 2024 16:57:42 +0100 Subject: [PATCH] chore: fix lint --- app/controllers/import.controller.js | 5 +++++ app/presenters/import/legacy/licence.presenter.js | 5 ++++- .../import/legacy/fetch-licence-versions.service.js | 4 ++-- app/services/import/legacy/fetch-licence.service.js | 2 +- app/services/import/legacy/process-licence.service.js | 3 ++- .../licence-version-purpose-condition.validator.js | 2 +- app/validators/import/licence.validator.js | 7 +++++++ .../_fixtures/import-licence-versions.fixture.js | 11 ++++++++++- .../import/_fixtures/import-licence.fixture.js | 11 ++++++++++- .../legacy-licence-version-purpose.fixture.js | 7 ++++++- .../_fixtures/legacy-licence-version.fixture.js | 7 ++++++- .../import/_fixtures/legacy-licence.fixture.js | 7 ++++++- 12 files changed, 60 insertions(+), 11 deletions(-) diff --git a/app/controllers/import.controller.js b/app/controllers/import.controller.js index 9d3c6394ad..f2ae828f57 100644 --- a/app/controllers/import.controller.js +++ b/app/controllers/import.controller.js @@ -5,6 +5,11 @@ const ImportLegacyProcessLicenceService = require('../services/import/legacy/pro /** * Controller for /import + * @param request - the hapi request object + * @param h - the hapi response object + * + * @returns {object} + * * @module ImportController */ async function licence (request, h) { diff --git a/app/presenters/import/legacy/licence.presenter.js b/app/presenters/import/legacy/licence.presenter.js index 906919c2bb..e9bb7b9827 100644 --- a/app/presenters/import/legacy/licence.presenter.js +++ b/app/presenters/import/legacy/licence.presenter.js @@ -35,6 +35,9 @@ function _mapLicence (licence, licenceVersions) { /** * Creates a JSON object of the region data * This is stored as a JSON object in the licence.regions column. + * @param licenceData + * + * @returns {object} - the json structure to persist in the licence.regions column */ const _regions = (licenceData) => { const historicalAreaCode = licenceData.AREP_AREA_CODE @@ -56,7 +59,7 @@ const _regions = (licenceData) => { * * @param {object} licence - the legacy licence data * @param {object[]} licenceVersions - the legacy licence versions - * @return {String} YYYY-MM-DD + * @returns {string} YYYY-MM-DD */ const _startDate = (licence, licenceVersions) => { if (licence.ORIG_EFF_DATE !== 'null') { diff --git a/app/services/import/legacy/fetch-licence-versions.service.js b/app/services/import/legacy/fetch-licence-versions.service.js index daccae8687..fccdd03427 100644 --- a/app/services/import/legacy/fetch-licence-versions.service.js +++ b/app/services/import/legacy/fetch-licence-versions.service.js @@ -73,7 +73,7 @@ module.exports = { /** * A legacy licence version - * @typedef {Object} ImportLegacyLicenceVersionsType + * @typedef {object} ImportLegacyLicenceVersionsType * * @property {string} EFF_END_DATE - date in UK format - can be 'null' * @property {string} EFF_ST_DATE - date in UK format @@ -86,7 +86,7 @@ module.exports = { */ /** - * @typedef {Object} ImportLegacyLicenceVersionsPurposesType + * @typedef {object} ImportLegacyLicenceVersionsPurposesType * * @property {string} PERIOD_END_DAY - The end day of the period. * @property {string} PERIOD_END_MONTH - The end month of the period. diff --git a/app/services/import/legacy/fetch-licence.service.js b/app/services/import/legacy/fetch-licence.service.js index 6947b717cf..09b22080a4 100644 --- a/app/services/import/legacy/fetch-licence.service.js +++ b/app/services/import/legacy/fetch-licence.service.js @@ -48,7 +48,7 @@ module.exports = { /** * An Import legacy licence * - * @typedef {Object} ImportLegacyLicenceType + * @typedef {object} ImportLegacyLicenceType * * @property {string} AREP_AREA_CODE - historicalAreaCode * @property {string} AREP_EIUC_CODE - regionPrefix / regionalChargeArea diff --git a/app/services/import/legacy/process-licence.service.js b/app/services/import/legacy/process-licence.service.js index ec5eaba27b..5a23f86e27 100644 --- a/app/services/import/legacy/process-licence.service.js +++ b/app/services/import/legacy/process-licence.service.js @@ -18,7 +18,8 @@ const { currentTimeInNanoseconds, calculateAndLogTimeTaken } = require('../../.. * Imports a licence from the legacy import tables. Maps and validates the data and then saves to the database. * * @param {string} licenceRef - The licence reference of the licence - * @returns {Promise} an object representing the saved licence in the database + * + * @returns {Promise} an object representing the saved licence in the database */ async function go (licenceRef) { try { diff --git a/app/validators/import/licence-version-purpose-condition.validator.js b/app/validators/import/licence-version-purpose-condition.validator.js index f1af72deac..d6531ce6d0 100644 --- a/app/validators/import/licence-version-purpose-condition.validator.js +++ b/app/validators/import/licence-version-purpose-condition.validator.js @@ -14,7 +14,7 @@ const Joi = require('joi') * * @returns {object} the result from calling Joi's schema.validate(). It will be an object with a `value:` property. If * any errors are found the `error:` property will also exist detailing what the issues were -*/ + */ function go (data) { const schema = Joi.object({ licenceVersionPurposeId: Joi.string().guid().optional(), diff --git a/app/validators/import/licence.validator.js b/app/validators/import/licence.validator.js index 2cd685496d..c7862fca3a 100644 --- a/app/validators/import/licence.validator.js +++ b/app/validators/import/licence.validator.js @@ -28,6 +28,13 @@ const Joi = require('joi') * @throws {Error} - throw an error if any of the validations fail */ +/** + * Validate an import licence to persist in the database + * + * @param data + * + * @throws {error} - the first error from the validation failure + */ function go (data) { const result = _schema.validate(data) diff --git a/test/services/import/_fixtures/import-licence-versions.fixture.js b/test/services/import/_fixtures/import-licence-versions.fixture.js index 502ac8985a..5245b90612 100644 --- a/test/services/import/_fixtures/import-licence-versions.fixture.js +++ b/test/services/import/_fixtures/import-licence-versions.fixture.js @@ -33,7 +33,16 @@ function _createtLicenceVersion () { } } -function create (data) { +/** + * Creates a test import licence versions object with purposes + * + * This is the object we expect to see when we persist the data for the licence versions and purposes + * + * This object should pass the validation + * + * @returns {object} - an import licence object with purposes + */ +function create () { const defaults = [ { ..._createtLicenceVersion(), diff --git a/test/services/import/_fixtures/import-licence.fixture.js b/test/services/import/_fixtures/import-licence.fixture.js index 4f48a0d62a..59f355c5cb 100644 --- a/test/services/import/_fixtures/import-licence.fixture.js +++ b/test/services/import/_fixtures/import-licence.fixture.js @@ -25,7 +25,16 @@ function importLicence () { } } -function create (data) { +/** + * Creates a test import licence object + * + * This is the object we expect to see when we persist the data + * + * This object should pass the validation + * + * @returns {object} - an import licence object + */ +function create () { return { ...importLicence() } diff --git a/test/services/import/_fixtures/legacy-licence-version-purpose.fixture.js b/test/services/import/_fixtures/legacy-licence-version-purpose.fixture.js index 56706bd995..9396b55e92 100644 --- a/test/services/import/_fixtures/legacy-licence-version-purpose.fixture.js +++ b/test/services/import/_fixtures/legacy-licence-version-purpose.fixture.js @@ -21,7 +21,12 @@ function purpose () { } } -function create (data) { +/** + * Creates a test legacy import licence versions purpose object + * + * @returns {object} - a legacy import licence versions purpose object + */ +function create () { return { ...purpose() } diff --git a/test/services/import/_fixtures/legacy-licence-version.fixture.js b/test/services/import/_fixtures/legacy-licence-version.fixture.js index 454f3d789a..1497efc679 100644 --- a/test/services/import/_fixtures/legacy-licence-version.fixture.js +++ b/test/services/import/_fixtures/legacy-licence-version.fixture.js @@ -13,7 +13,12 @@ function legacyLicenceVersionFixture () { } } -function create (data) { +/** + * Creates a test legacy import licence versions object + * + * @returns {object} - a legacy import licence versions object + */ +function create () { return { ...legacyLicenceVersionFixture() } diff --git a/test/services/import/_fixtures/legacy-licence.fixture.js b/test/services/import/_fixtures/legacy-licence.fixture.js index 8fb18440b8..75d7ab6269 100644 --- a/test/services/import/_fixtures/legacy-licence.fixture.js +++ b/test/services/import/_fixtures/legacy-licence.fixture.js @@ -18,7 +18,12 @@ function legacyLicenceFixture () { } } -function create (data) { +/** + * Creates a test legacy import licence object + * + * @returns {object} - a legacy import licence object + */ +function create () { return { ...legacyLicenceFixture() }