Rename return-requirements route return-versions

app/controllers/licences.controller.js

@@ -5,7 +5,7 @@
  * @module LicencesController
  */
 
-const InitiateSessionService = require('../services/return-requirements/setup/initiate-session.service.js')
+const InitiateSessionService = require('../services/return-versions/setup/initiate-session.service.js')
 const LicenceSupplementaryProcessBillingFlagService = require('../services/licences/supplementary/process-billing-flag.service.js')
 const MarkedForSupplementaryBillingService = require('../services/licences/supplementary/marked-for-supplementary-billing.service.js')
 const MarkForSupplementaryBillingService = require('../services/licences/supplementary/mark-for-supplementary-billing.service.js')
@@ -50,15 +50,15 @@ async function noReturnsRequired (request, h) {
 
   const session = await InitiateSessionService.go(id, 'no-returns-required')
 
-  return h.redirect(`/system/return-requirements/setup/${session.id}/start-date`)
+  return h.redirect(`/system/return-versions/setup/${session.id}/start-date`)
 }
 
 async function returnsRequired (request, h) {
   const { id } = request.params
 
   const session = await InitiateSessionService.go(id, 'returns-required')
 
-  return h.redirect(`/system/return-requirements/setup/${session.id}/start-date`)
+  return h.redirect(`/system/return-versions/setup/${session.id}/start-date`)
 }
 
 async function submitMarkForSupplementaryBilling (request, h) {

app/controllers/return-versions.controller.js

@@ -0,0 +1,21 @@
+'use strict'
+
+/**
+ * Controller for /return-versions endpoints
+ * @module ReturnVersionsController
+ */
+
+const ViewService = require('../services/return-versions/view.service.js')
+
+async function view (request, h) {
+  const { id } = request.params
+  const pageData = await ViewService.go(id)
+
+  return h.view('return-versions/view.njk', {
+    ...pageData
+  })
+}
+
+module.exports = {
+  view
+}

app/plugins/router.plugin.js

@@ -25,8 +25,8 @@ const ImportRoutes = require('../routes/import.routes.js')
 const JobRoutes = require('../routes/jobs.routes.js')
 const LicenceRoutes = require('../routes/licence.routes.js')
 const MonitoringStationRoutes = require('../routes/monitoring-station.routes.js')
-const ReturnRequirementsRoutes = require('../routes/return-requirements.routes.js')
-const ReturnRequirementsSetupRoutes = require('../routes/return-requirements-setup.routes.js')
+const ReturnVersionsSetupRoutes = require('../routes/return-versions-setup.routes.js')
+const ReturnVersionsRoutes = require('../routes/return-versions.routes.js')
 const RootRoutes = require('../routes/root.routes.js')
 
 const AirbrakeConfig = require('../../config/airbrake.config.js')
@@ -44,8 +44,8 @@ const routes = [
   ...LicenceRoutes,
   ...JobRoutes,
   ...MonitoringStationRoutes,
-  ...ReturnRequirementsRoutes,
-  ...ReturnRequirementsSetupRoutes,
+  ...ReturnVersionsRoutes,
+  ...ReturnVersionsSetupRoutes,
   ...DataRoutes,
   ...ImportRoutes
 ]

app/presenters/licences/view-licence-history.presenter.js

@@ -97,7 +97,7 @@ function _returnVersionEntries (licence) {
       dateCreated: formatLongDate(createdAt),
       displayNote: notes.length > 0,
       notes,
-      link: `/system/return-requirements/${returnVersion.id}`,
+      link: `/system/return-versions/${returnVersion.id}`,
       reason: mappedReason ?? reason,
       type: { index: 2, name: 'Return version' }
     }

app/presenters/licences/view-licence-set-up.presenter.js

@@ -220,7 +220,7 @@ function _returnVersions (returnVersions = [{}]) {
     return {
       action: [{
         text: 'View',
-        link: `/system/return-requirements/${returnVersion.id}`
+        link: `/system/return-versions/${returnVersion.id}`
       }],
       endDate: returnVersion.endDate ? formatLongDate(returnVersion.endDate) : '',
       reason: _reason(returnVersion),

app/presenters/return-requirements/setup/abstraction-period.presenter.js → app/presenters/return-versions/setup/abstraction-period.presenter.js

@@ -1,12 +1,12 @@
 'use strict'
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/abstraction-period` page
+ * Formats data for the `/return-versions/setup/{sessionId}/abstraction-period` page
  * @module AbstractionPeriodPresenter
  */
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/abstraction-period` page
+ * Formats data for the `/return-versions/setup/{sessionId}/abstraction-period` page
  *
  * @param {module:SessionModel} session - The returns requirements session instance
  * @param {string} requirementIndex - The index of the requirement being added or changed
@@ -30,10 +30,10 @@ function _backLink (session, requirementIndex) {
   const { checkPageVisited, id } = session
 
   if (checkPageVisited) {
-    return `/system/return-requirements/setup/${id}/check`
+    return `/system/return-versions/setup/${id}/check`
   }
 
-  return `/system/return-requirements/setup/${id}/points/${requirementIndex}`
+  return `/system/return-versions/setup/${id}/points/${requirementIndex}`
 }
 
 module.exports = {

app/presenters/return-requirements/setup/additional-submission-options.presenter.js → app/presenters/return-versions/setup/additional-submission-options.presenter.js

@@ -1,12 +1,12 @@
 'use strict'
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/additional-submission-options` page
+ * Formats data for the `/return-versions/setup/{sessionId}/additional-submission-options` page
  * @module AdditionalSubmissionOptionsPresenter
  */
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/additional-submission-options` page
+ * Formats data for the `/return-versions/setup/{sessionId}/additional-submission-options` page
  *
  * @param {module:SessionModel} session - The returns requirements session instance
  *
@@ -16,7 +16,7 @@ function go (session) {
   const { id: sessionId, licence: { id: licenceId, licenceRef }, additionalSubmissionOptions } = session
   const data = {
     additionalSubmissionOptions: additionalSubmissionOptions ?? [],
-    backLink: `/system/return-requirements/setup/${sessionId}/check`,
+    backLink: `/system/return-versions/setup/${sessionId}/check`,
     licenceId,
     licenceRef,
     sessionId

app/presenters/return-requirements/setup/agreements-exceptions.presenter.js → app/presenters/return-versions/setup/agreements-exceptions.presenter.js

@@ -1,12 +1,12 @@
 'use strict'
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/agreements-exceptions` page
+ * Formats data for the `/return-versions/setup/{sessionId}/agreements-exceptions` page
  * @module AgreementsExceptionsPresenter
  */
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/agreements-exceptions` page
+ * Formats data for the `/return-versions/setup/{sessionId}/agreements-exceptions` page
  *
  * @param {module:SessionModel} session - The returns requirements session instance
  * @param {string} requirementIndex - The index of the requirement being added or changed
@@ -30,10 +30,10 @@ function _backLink (session, requirementIndex) {
   const { checkPageVisited, id } = session
 
   if (checkPageVisited) {
-    return `/system/return-requirements/setup/${id}/check`
+    return `/system/return-versions/setup/${id}/check`
   }
 
-  return `/system/return-requirements/setup/${id}/frequency-reported/${requirementIndex}`
+  return `/system/return-versions/setup/${id}/frequency-reported/${requirementIndex}`
 }
 
 module.exports = {

app/presenters/return-requirements/setup/cancel.presenter.js → app/presenters/return-versions/setup/cancel.presenter.js

@@ -1,15 +1,15 @@
 'use strict'
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/cancel` page
+ * Formats data for the `/return-versions/setup/{sessionId}/cancel` page
  * @module CancelRequirementsPresenter
  */
 
 const { formatLongDate } = require('../../base.presenter.js')
 const { returnRequirementFrequencies, returnRequirementReasons } = require('../../../lib/static-lookups.lib.js')
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/cancel` page
+ * Formats data for the `/return-versions/setup/{sessionId}/cancel` page
  *
  * @param {module:SessionModel} session - The returns requirements session instance
  *
@@ -19,7 +19,7 @@ function go (session) {
   const { id: sessionId, journey, licence, reason, requirements } = session
 
   return {
-    backLink: `/system/return-requirements/setup/${sessionId}/check`,
+    backLink: `/system/return-versions/setup/${sessionId}/check`,
     licenceId: licence.id,
     licenceRef: licence.licenceRef,
     reason: returnRequirementReasons[reason],

app/presenters/return-requirements/setup/check/check.presenter.js → app/presenters/return-versions/setup/check/check.presenter.js

@@ -1,15 +1,15 @@
 'use strict'
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/check` page
+ * Formats data for the `/return-versions/setup/{sessionId}/check` page
  * @module CheckPresenter
  */
 
 const { formatLongDate } = require('../../../base.presenter.js')
 const { returnRequirementReasons } = require('../../../../lib/static-lookups.lib.js')
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/check` page
+ * Formats data for the `/return-versions/setup/{sessionId}/check` page
  *
  * @param {module:SessionModel} session - The returns requirements session instance
  *
@@ -53,10 +53,10 @@ function _note (note) {
 
 function _reasonLink (sessionId, returnsRequired) {
   if (returnsRequired) {
-    return `/system/return-requirements/setup/${sessionId}/reason`
+    return `/system/return-versions/setup/${sessionId}/reason`
   }
 
-  return `/system/return-requirements/setup/${sessionId}/no-returns-required`
+  return `/system/return-versions/setup/${sessionId}/no-returns-required`
 }
 
 function _startDate (session) {

app/presenters/return-requirements/setup/check/returns-requirements.presenter.js → app/presenters/return-versions/setup/check/returns-requirements.presenter.js

@@ -1,7 +1,7 @@
 'use strict'
 
 /**
- * Formats return requirements data for the `/return-requirements/setup/{sessionId}/check` page
+ * Formats return requirements data for the `/return-versions/setup/{sessionId}/check` page
  * @module ReturnRequirementsPresenter
  */
 
@@ -17,7 +17,7 @@ const AGREEMENTS_EXCEPTIONS = {
 }
 
 /**
- * Formats return requirements data for the `/return-requirements/setup/{sessionId}/check` page
+ * Formats return requirements data for the `/return-versions/setup/{sessionId}/check` page
  *
  * @param {object[]} requirements - The existing return requirements in the current session
  * @param {module:PointModel[]} points - All points linked to the licence version purposes linked to the current licence

app/presenters/return-requirements/setup/existing.presenter.js → app/presenters/return-versions/setup/existing.presenter.js

@@ -1,15 +1,15 @@
 'use strict'
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/existing` page
+ * Formats data for the `/return-versions/setup/{sessionId}/existing` page
  * @module ExistingPresenter
  */
 
 const { formatLongDate } = require('../../base.presenter.js')
 const { returnRequirementReasons } = require('../../../lib/static-lookups.lib.js')
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/existing` page
+ * Formats data for the `/return-versions/setup/{sessionId}/existing` page
  *
  * @param {module:SessionModel} session - The returns requirements session instance
  *

app/presenters/return-requirements/setup/frequency-collected.presenter.js → app/presenters/return-versions/setup/frequency-collected.presenter.js

@@ -1,12 +1,12 @@
 'use strict'
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/frequency-collected` page
+ * Formats data for the `/return-versions/setup/{sessionId}/frequency-collected` page
  * @module FrequencyCollectedPresenter
  */
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/frequency-collected` page
+ * Formats data for the `/return-versions/setup/{sessionId}/frequency-collected` page
  *
  * @param {module:SessionModel} session - The returns requirements session instance
  * @param {string} requirementIndex - The index of the requirement being added or changed
@@ -30,10 +30,10 @@ function _backLink (session, requirementIndex) {
   const { checkPageVisited, id } = session
 
   if (checkPageVisited) {
-    return `/system/return-requirements/setup/${id}/check`
+    return `/system/return-versions/setup/${id}/check`
   }
 
-  return `/system/return-requirements/setup/${id}/site-description/${requirementIndex}`
+  return `/system/return-versions/setup/${id}/site-description/${requirementIndex}`
 }
 
 module.exports = {

app/presenters/return-requirements/setup/frequency-reported.presenter.js → app/presenters/return-versions/setup/frequency-reported.presenter.js

@@ -1,12 +1,12 @@
 'use strict'
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/frequency-reported` page
+ * Formats data for the `/return-versions/setup/{sessionId}/frequency-reported` page
  * @module FrequencyReportedPresenter
  */
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/frequency-reported` page
+ * Formats data for the `/return-versions/setup/{sessionId}/frequency-reported` page
  *
  * @param {module:SessionModel} session - The returns requirements session instance
  * @param {string} requirementIndex - The index of the requirement being added or changed
@@ -30,10 +30,10 @@ function _backLink (session, requirementIndex) {
   const { checkPageVisited, id } = session
 
   if (checkPageVisited) {
-    return `/system/return-requirements/setup/${id}/check`
+    return `/system/return-versions/setup/${id}/check`
   }
 
-  return `/system/return-requirements/setup/${id}/frequency-collected/${requirementIndex}`
+  return `/system/return-versions/setup/${id}/frequency-collected/${requirementIndex}`
 }
 
 module.exports = {

app/presenters/return-requirements/setup/method.presenter.js → app/presenters/return-versions/setup/method.presenter.js

@@ -1,12 +1,12 @@
 'use strict'
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/method` page
+ * Formats data for the `/return-versions/setup/{sessionId}/method` page
  * @module MethodPresenter
  */
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/method` page
+ * Formats data for the `/return-versions/setup/{sessionId}/method` page
  *
  * @param {module:SessionModel} session - The returns requirements session instance
  *
@@ -16,7 +16,7 @@ function go (session) {
   const { id: sessionId, licence, method } = session
 
   return {
-    backLink: `/system/return-requirements/setup/${sessionId}/reason`,
+    backLink: `/system/return-versions/setup/${sessionId}/reason`,
     displayCopyExisting: licence.returnVersions.length > 0,
     licenceRef: licence.licenceRef,
     method: method ?? null,

app/presenters/return-requirements/setup/no-returns-required.presenter.js → app/presenters/return-versions/setup/no-returns-required.presenter.js

@@ -1,12 +1,12 @@
 'use strict'
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/no-returns-required` page
+ * Formats data for the `/return-versions/setup/{sessionId}/no-returns-required` page
  * @module NoReturnsRequiredPresenter
  */
 
 /**
- * Formats data for the `/return-requirements/setup/{sessionId}/no-returns-required` page
+ * Formats data for the `/return-versions/setup/{sessionId}/no-returns-required` page
  *
  * @param {module:SessionModel} session - The returns requirements session instance
  *
@@ -27,10 +27,10 @@ function _backLink (session) {
   const { checkPageVisited, id } = session
 
   if (checkPageVisited) {
-    return `/system/return-requirements/setup/${id}/check`
+    return `/system/return-versions/setup/${id}/check`
   }
 
-  return `/system/return-requirements/setup/${id}/start-date`
+  return `/system/return-versions/setup/${id}/start-date`
 }
 
 module.exports = {