Add copy from existing returns

app/models/return-requirement-point.model.js

@@ -0,0 +1,31 @@
+'use strict'
+
+/**
+ * Model for return_requirement_points (water.return_requirement_points)
+ * @module ReturnRequirementPointModel
+ */
+
+const { Model } = require('objection')
+
+const BaseModel = require('./base.model.js')
+
+class ReturnRequirementPointModel extends BaseModel {
+  static get tableName () {
+    return 'returnRequirementPoints'
+  }
+
+  static get relationMappings () {
+    return {
+      returnRequirements: {
+        relation: Model.BelongsToOneRelation,
+        modelClass: 'return-requirement.model',
+        join: {
+          from: 'returnRequirements.id',
+          to: 'returnRequirementPoints.returnRequirementId'
+        }
+      }
+    }
+  }
+}
+
+module.exports = ReturnRequirementPointModel

app/models/return-requirement.model.js

@@ -0,0 +1,39 @@
+'use strict'
+
+/**
+ * Model for return_requirements (water.return_requirements)
+ * @module ReturnRequirementModel
+ */
+
+const { Model } = require('objection')
+
+const BaseModel = require('./base.model.js')
+
+class ReturnRequirementModel extends BaseModel {
+  static get tableName () {
+    return 'returnRequirements'
+  }
+
+  static get relationMappings () {
+    return {
+      returnVersions: {
+        relation: Model.BelongsToOneRelation,
+        modelClass: 'return-version.model',
+        join: {
+          from: 'returnRequirements.returnVersionId',
+          to: 'returnVersions.id'
+        }
+      },
+      returnRequirementPoints: {
+        relation: Model.ManyToManyRelation,
+        modelClass: 'return-requirement-point.model',
+        join: {
+          from: 'returnRequirements.id',
+          to: 'returnRequirementPoints.returnRequirementId'
+        }
+      }
+    }
+  }
+}
+
+module.exports = ReturnRequirementModel

app/models/return-version.model.js

@@ -0,0 +1,43 @@
+'use strict'
+
+/**
+ * Model for return_versions (water.return_versions)
+ * @module ReturnVersionModel
+ */
+
+const { Model } = require('objection')
+
+const BaseModel = require('./base.model.js')
+
+class ReturnVersionModel extends BaseModel {
+  static get tableName () {
+    return 'returnVersions'
+  }
+
+  static get relationMappings () {
+    return {
+      licence: {
+        relation: Model.BelongsToOneRelation,
+        modelClass: 'licence.model',
+        join: {
+          from: 'returnVersions.licenceId',
+          to: 'licences.id'
+        }
+      },
+      returnRequirementPoints: {
+        relation: Model.ManyToManyRelation,
+        modelClass: 'return-requirement-point.model',
+        join: {
+          from: 'returnVersions.id',
+          through: {
+            from: 'returnRequirements.returnVersionId',
+            to: 'returnRequirements.id'
+          },
+          to: 'returnRequirementPoints.returnRequirementId'
+        }
+      }
+    }
+  }
+}
+
+module.exports = ReturnVersionModel

app/presenters/return-requirements/setup.presenter.js

@@ -12,12 +12,36 @@
  *
  * @returns {Object} - The data formatted for the view template
  */
-function go (session) {
+function go (session, existingData) {
   const { id: sessionId, licence, setup } = session
 
+  const radioOptions = [{
+    value: 'use-abstraction-data',
+    text: 'Start by using abstraction data',
+    checked: setup === 'use-abstraction-data'
+  }]
+
+  if (existingData.length !== 0) {
+    radioOptions.push({
+      value: 'use-existing-requirements',
+      text: 'Copy existing requirements',
+      checked: setup === 'use-existing-requirements'
+    })
+  }
+
+  radioOptions.push({
+    divider: 'or'
+  },
+  {
+    value: 'set-up-manually',
+    text: 'Set up manually',
+    checked: setup === 'set-up-manually'
+  })
+
   return {
     backLink: `/system/return-requirements/${sessionId}/reason`,
     licenceRef: licence.licenceRef,
+    radioOptions,
     sessionId,
     setup: setup ?? null
   }

app/services/return-requirements/fetch-return-requirements.service.js

@@ -0,0 +1,38 @@
+'use strict'
+
+/**
+ * Fetches existing return requirements needed for `/return-requirements/{sessionId}/setup` page
+ * @module FetchReturnRequirementsService
+ */
+
+const ReturnVersionModel = require('../../models/return-version.model.js')
+
+/**
+ * Fetches existing return requirements needed for `/return-requirements/{sessionId}/setup` page
+ *
+ * @param {string} licenceId - The UUID for the licence to fetch
+ *
+ * @returns {Promise<Object>} The existing return requirements for the matching licenceId
+ */
+async function go (licenceId) {
+  const data = await _fetchReturnRequirements(licenceId)
+
+  return data
+}
+
+async function _fetchReturnRequirements (licenceId) {
+  const result = await ReturnVersionModel.query()
+    .where('licenceId', licenceId)
+    .withGraphFetched('returnRequirementPoints')
+    .modifyGraph('returnRequirementPoints', (builder) => {
+      builder.select([
+        'id'
+      ])
+    })
+
+  return result
+}
+
+module.exports = {
+  go
+}

app/services/return-requirements/setup.service.js

@@ -5,23 +5,26 @@
  * @module SetupService
  */
 
-const SetupPresenter = require('../../presenters/return-requirements/setup.presenter.js')
+const FetchReturnRequirementsService = require('./fetch-return-requirements.service.js')
 const SessionModel = require('../../models/session.model.js')
+const SetupPresenter = require('../../presenters/return-requirements/setup.presenter.js')
 
 /**
  * Orchestrates fetching and presenting the data for `/return-requirements/{sessionId}/setup` page
  *
- * Supports generating the data needed for the select reason page in the return requirements setup journey. It
- * fetches the current session record and combines it with the radio buttons and other information needed for the form.
+ * Supports generating the data needed for selecting how you want to set up the return in the return requirements setup
+ * journey. It fetches the current session record and combines it with the radio buttons and other information needed
+ * for the form.
  *
  * @param {string} sessionId - The UUID for return requirement setup session record
  *
  * @returns {Promise<Object>} page data needed by the view template
  */
 async function go (sessionId) {
   const session = await SessionModel.query().findById(sessionId)
+  const existingData = await FetchReturnRequirementsService.go(session.licence.id)
 
-  const formattedData = SetupPresenter.go(session)
+  const formattedData = SetupPresenter.go(session, existingData)
 
   return {
     activeNavBar: 'search',

app/services/return-requirements/submit-setup.service.js

@@ -5,6 +5,7 @@
  * @module SubmitSetupService
  */
 
+const FetchReturnRequirementsService = require('./fetch-return-requirements.service.js')
 const SessionModel = require('../../models/session.model.js')
 const SetupPresenter = require('../../presenters/return-requirements/setup.presenter.js')
 const SetupValidator = require('../../validators/return-requirements/setup.validator.js')
@@ -21,11 +22,12 @@ const SetupValidator = require('../../validators/return-requirements/setup.valid
  * @param {string} sessionId - The UUID of the current session
  * @param {Object} payload - The submitted form data
  *
- * @returns {Promise<Object>} If no errors a the url for where the user should be redirected else the page data for the
+ * @returns {Promise<Object>} If no errors return a url for where the user should be redirected else the page data for the
  * setup page including the validation error details
  */
 async function go (sessionId, payload) {
   const session = await SessionModel.query().findById(sessionId)
+  const existingData = await FetchReturnRequirementsService.go(session.licence.id)
 
   const validationResult = _validate(payload)
 
@@ -37,7 +39,7 @@ async function go (sessionId, payload) {
     }
   }
 
-  const formattedData = SetupPresenter.go(session, payload)
+  const formattedData = SetupPresenter.go(session, existingData)
 
   return {
     activeNavBar: 'search',
@@ -54,6 +56,10 @@ function _redirect (setup) {
     endpoint = 'check'
   }
 
+  if (setup === 'use-existing-requirements') {
+    endpoint = 'existing'
+  }
+
   if (setup === 'set-up-manually') {
     endpoint = 'purpose/0'
   }

app/validators/return-requirements/setup.validator.js

@@ -9,6 +9,7 @@ const Joi = require('joi')
 
 const VALID_VALUES = [
   'use-abstraction-data',
+  'use-existing-requirements',
   'set-up-manually'
 ]
 

app/views/return-requirements/setup.njk

@@ -39,21 +39,7 @@
             classes: "govuk-fieldset__legend--l govuk-!-margin-bottom-6"
           }
         },
-        items: [
-          {
-            value: "use-abstraction-data",
-            text: "Start by using abstraction data",
-            checked: "use-abstraction-data" === setup
-          },
-          {
-            divider: "or"
-          },
-          {
-            value: "set-up-manually",
-            text: "Set up manually",
-            checked: "set-up-manually" === setup
-          }
-        ]
+        items: radioOptions
       }) }}
 
       {{ govukButton({ text: "Continue", preventDoubleClick: true }) }}

db/migrations/legacy/20221108007023-water-return-versions.js

@@ -15,8 +15,11 @@ exports.up = function (knex) {
       table.integer('version_number').notNullable()
       table.date('start_date').notNullable()
       table.date('end_date')
-      table.string('status water').notNullable()
+      table.string('status').notNullable()
       table.string('external_id')
+      table.string('reason')
+      table.boolean('multiple_upload')
+      table.text('notes')
 
       // Legacy timestamps
       table.timestamp('date_created', { useTz: false }).notNullable()

db/migrations/legacy/20221108007024-water-return-requirements.js

@@ -23,6 +23,11 @@ exports.up = function (knex) {
       table.string('description')
       table.integer('legacy_id')
       table.string('external_id')
+      table.string('collection_frequency')
+      table.boolean('gravity_fill')
+      table.boolean('reabstraction')
+      table.boolean('two_part_tariff')
+      table.boolean('fifty_six_exception')
 
       // Legacy timestamps
       table.timestamp('date_created', { useTz: false }).notNullable()

db/migrations/legacy/20240530131706_water-return-requirement-points-table.js

@@ -0,0 +1,29 @@
+'use strict'
+
+const tableName = 'return_requirement_points'
+
+exports.up = function (knex) {
+  return knex
+    .schema
+    .withSchema('water')
+    .createTable(tableName, (table) => {
+      // Primary Key
+      table.uuid('id').primary().defaultTo(knex.raw('gen_random_uuid()'))
+
+      // Data
+      table.uuid('return_requirement_id').notNullable()
+      table.string('description').notNullable()
+      table.string('ngr_1').notNullable()
+      table.string('ngr_2')
+      table.string('ngr_3')
+      table.string('ngr_4')
+      table.string('external_id')
+    })
+}
+
+exports.down = function (knex) {
+  return knex
+    .schema
+    .withSchema('water')
+    .dropTableIfExists(tableName)
+}

db/migrations/public/20240527105914_water-return-version-view.js

@@ -0,0 +1,30 @@
+'use strict'
+
+const viewName = 'return_versions'
+
+exports.up = function (knex) {
+  return knex
+    .schema
+    .createView(viewName, (view) => {
+      view.as(knex('return_versions').withSchema('water').select([
+        'return_version_id AS id',
+        'licence_id',
+        'version_number',
+        'start_date',
+        'end_date',
+        'status',
+        'external_id',
+        'reason',
+        'multiple_upload',
+        'notes',
+        'date_created AS created_at',
+        'date_updated AS updated_at'
+      ]))
+    })
+}
+
+exports.down = function (knex) {
+  return knex
+    .schema
+    .dropViewIfExists(viewName)
+}