Display return versions in view licence setup tab

.env.example

@@ -67,3 +67,4 @@ COOKIE_SECRET=
 
 # Feature flags
 ENABLE_REISSUING_BILLING_BATCHES=false
+ENABLE_REQUIREMENTS_FOR_RETURNS=false

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

@@ -5,7 +5,9 @@
  * @module SetUpPresenter
  */
 
+const FeatureFlagsConfig = require('../../../config/feature-flags.config.js')
 const { formatLongDate } = require('../base.presenter.js')
+const { returnRequirementReasons } = require('../../lib/static-lookups.lib.js')
 
 const roles = {
   billing: 'billing',
@@ -27,18 +29,25 @@ const agreementDescriptions = {
  *
  * @param {module:ChargeVersionModel[]} chargeVersions - All charge versions records for the licence
  * @param {module:WorkflowModel[]} workflows - All in-progress workflow records for the licence
- * @param {module:LicenceAgreements[]} agreements - All agreements records for the licence
+ * @param {module:LicenceAgreementModel[]} agreements - All agreements records for the licence
+ * @param {module:ReturnVersionModel[]} returnVersions - All returns version records for the licence
  * @param {Object} auth - The auth object taken from `request.auth` containing user details
  * @param {Object} commonData - Licence data already formatted for the view's shared elements
  *
  * @returns {Object} The data formatted for the view template
  */
-function go (chargeVersions, workflows, agreements, auth, commonData) {
+function go (chargeVersions, workflows, agreements, returnVersions, auth, commonData) {
+  const enableRequirementsForReturns = FeatureFlagsConfig.enableRequirementsForReturns
+
   return {
+    links: {
+      chargeInformation: _chargeInformationLinks(auth, commonData),
+      agreements: _agreementLinks(auth, commonData),
+      returnVersions: _returnVersionsLinks(commonData, enableRequirementsForReturns)
+    },
     agreements: _agreements(commonData, agreements, auth),
     chargeInformation: _chargeInformation(chargeVersions, workflows, auth),
-    ..._agreementButtons(auth, commonData),
-    ..._authorisedLinks(auth, commonData)
+    returnVersions: _returnVersions(returnVersions)
   }
 }
 
@@ -93,17 +102,17 @@ function _agreementActionLinks (commonData, agreement, auth) {
   return actionLinks
 }
 
-function _agreementButtons (auth, commonData) {
+function _agreementLinks (auth, commonData) {
   if (auth.credentials.scope.includes(roles.manageAgreements) && !_endsSixYearsAgo(commonData.ends)) {
     return {
       setUpAgreement: `/licences/${commonData.licenceId}/agreements/select-type`
     }
   }
 
-  return null
+  return {}
 }
 
-function _authorisedLinks (auth, commonData) {
+function _chargeInformationLinks (auth, commonData) {
   if (auth.credentials.scope.includes(roles.workflowEditor) && !_endsSixYearsAgo(commonData.ends)) {
     return {
       setupNewCharge: `/licences/${commonData.licenceId}/charge-information/create`,
@@ -161,6 +170,32 @@ function _financialAgreementCode (agreement) {
   return agreement.financialAgreements[0].financialAgreementCode
 }
 
+function _returnVersions (returnVersions = [{}]) {
+  return returnVersions.map((returnVersion) => {
+    return {
+      action: [{
+        text: 'View',
+        link: ''
+      }],
+      endDate: returnVersion.endDate ? formatLongDate(returnVersion.endDate) : '',
+      reason: returnVersion.reason ? returnRequirementReasons[returnVersion.reason] : '',
+      startDate: formatLongDate(returnVersion.startDate),
+      status: _status(returnVersion.status)
+    }
+  })
+}
+
+function _returnVersionsLinks (commonData, enableRequirementsForReturns) {
+  if (enableRequirementsForReturns) {
+    return {
+      returnsRequired: `/system/licences/${commonData.licenceId}/returns-required`,
+      noReturnsRequired: `/system/licences/${commonData.licenceId}/no-returns-required`
+    }
+  }
+
+  return {}
+}
+
 function _status (status) {
   const statuses = {
     current: 'approved',

app/services/licences/fetch-return-versions.service.js

@@ -0,0 +1,38 @@
+'use strict'
+
+/**
+ * Fetches return requirements data needed for the view '/licences/{id}/set-up` page
+ * @module FetchReturnVersionsService
+ */
+
+const ReturnVersionModel = require('../../models/return-version.model.js')
+
+/**
+ * Fetches return requirements data needed for the view '/licences/{id}/set-up` page
+ *
+ * @param {string} licenceId - The licence id for the licence to fetch return requirements
+ *
+ * @returns {Promise<Object>} the data needed to populate the view licence page's set up tab
+ */
+async function go (licenceId) {
+  return _fetch(licenceId)
+}
+
+async function _fetch (licenceId) {
+  return ReturnVersionModel.query()
+    .select([
+      'id',
+      'startDate',
+      'endDate',
+      'status',
+      'reason'
+    ])
+    .where('licenceId', licenceId)
+    .orderBy([
+      { column: 'startDate', order: 'desc' }
+    ])
+}
+
+module.exports = {
+  go
+}

app/services/licences/view-licence-set-up.service.js

@@ -7,6 +7,7 @@
 
 const FetchAgreementsService = require('./fetch-agreements.service.js')
 const FetchChargeVersionsService = require('./fetch-charge-versions.service.js')
+const FetchReturnVersionsService = require('./fetch-return-versions.service.js')
 const FetchWorkflowsService = require('./fetch-workflows.service.js')
 const SetUpPresenter = require('../../presenters/licences/set-up.presenter.js')
 const ViewLicenceService = require('./view-licence.service.js')
@@ -25,8 +26,10 @@ async function go (licenceId, auth) {
   const agreements = await FetchAgreementsService.go(commonData.licenceRef)
   const chargeVersions = await FetchChargeVersionsService.go(licenceId)
   const workflows = await FetchWorkflowsService.go(licenceId)
+  const returnVersions = await FetchReturnVersionsService.go(licenceId)
 
-  const licenceSetUpData = SetUpPresenter.go(chargeVersions, workflows, agreements, auth, commonData)
+  const licenceSetUpData = SetUpPresenter
+    .go(chargeVersions, workflows, agreements, returnVersions, auth, commonData)
 
   return {
     activeTab: 'set-up',