Fix linter warnings and remove/tidy up TODOs.

Author: malross

app/controllers/book-into-a-clinic.js

@@ -10,14 +10,20 @@ import {
 } from '../utils/clinic-appointment.js'
 import { kebabToCamelCase } from '../utils/string.js'
 
+/**
+ * @typedef {import('express').Request} Request
+ * @typedef {import('express').Response} Response
+ * @typedef {import('express').NextFunction} Next
+ */
+
 export const bookIntoClinicController = {
   /**
    * Record the session preset
    *
-   * @param {*} request
-   * @param {*} response
-   * @param {*} next
-   * @param {*} session_preset_slug
+   * @param {Request} request
+   * @param {Response} response
+   * @param {Next} next
+   * @param {string} session_preset_slug
    */
   read(request, response, next, session_preset_slug) {
     const serviceName = 'Book into a clinic'
@@ -43,8 +49,8 @@ export const bookIntoClinicController = {
   /**
    * Send to the start page
    *
-   * @param {*} request
-   * @param {*} response
+   * @param {Request} request
+   * @param {Response} response
    */
   redirect(request, response) {
     const { sessionPreset } = response.locals
@@ -55,8 +61,8 @@ export const bookIntoClinicController = {
   /**
    * Start a new clinic booking for clinics with the primary programme we've been given
    *
-   * @param {*} request
-   * @param {*} response
+   * @param {Request} request
+   * @param {Response} response
    */
   new(request, response) {
     const { data } = request.session
@@ -81,16 +87,17 @@ export const bookIntoClinicController = {
    * This includes code to set up radio button groups for various pages (we set them up
    * regardless of which specific route we're handling).
    *
-   * @param {*} request
-   * @param {*} response
-   * @param {*} next
+   * @param {Request} request
+   * @param {Response} response
+   * @param {Next} next
    */
   readForm(request, response, next) {
     const { session_preset_slug, booking_uuid } = request.params
     const appointment_uuid = request.params.appointment_uuid
     const { data, referrer } = request.session
 
-    /** NOTE:
+    /**
+     * NOTE:
      *
      * The nature of the journey here is complex, as there are two separate sections in which we need to
      * iterate over children. Or over appointments, if you want to think of it that way (each child has
@@ -113,7 +120,7 @@ export const bookIntoClinicController = {
      *   - Health question n  <-- final page of the per-child health question journey; iterate to next child if required
      * - Confirmation
      *
-     * */
+     */
 
     // Create objects on the global context to allow us to check branching conditions, etc.
     // And make them available to the view.
@@ -204,8 +211,8 @@ export const bookIntoClinicController = {
   /**
    * Render the requested form page
    *
-   * @param {*} request
-   * @param {*} response
+   * @param {Request} request
+   * @param {Response} response
    */
   showForm(request, response) {
     const { appointment } = response.locals
@@ -258,24 +265,14 @@ export const bookIntoClinicController = {
       ]
     }
 
-    /////////////////////
-    // console.log(`view: ${view}`)
-    // console.log(
-    //   `data.wizard: ${JSON.stringify(request.session.data.wizard, null, 2)}`
-    // )
-    // console.log(
-    //   `data.appointment: ${JSON.stringify(request.session.data.appointment, null, 2)}`
-    // )
-    /////////////////////
-
     response.render(`book-into-a-clinic/form/${view}`, { key, hasSubQuestions })
   },
 
   /**
    * Store the latest values entered into a form in the booking journey
    *
-   * @param {*} request
-   * @param {*} response
+   * @param {Request} request
+   * @param {Response} response
    */
   updateForm(request, response) {
     const { booking_uuid, appointment_uuid, view } = request.params
@@ -357,8 +354,8 @@ export const bookIntoClinicController = {
   /**
    * Catch-all for pages not needing to reference a given clinic booking
    *
-   * @param {*} request
-   * @param {*} response
+   * @param {Request} request
+   * @param {Response} response
    */
   show(request, response) {
     const view = request.params.view || 'start'

app/generators/clinic-booking.js

@@ -6,7 +6,7 @@ import { ClinicBooking } from '../models.js'
 /**
  * Generate fake clinic booking (initially without any appointments, which can be added later)
  *
- * @param context
+ * @param {object} context
  * @returns {ClinicBooking} ClinicBooking
  */
 export function generateEmptyClinicBooking(context) {

app/models/clinic-appointment.js

@@ -21,9 +21,9 @@ import { stringToArray, stringToBoolean } from '../utils/string.js'
  * @property {string} booking_uuid - Unique ID for the booking in which this appointment was made
  * @property {string} [patient_uuid] - Patient UUID (if matched to a patient record)
  * @property {import('./child.js').Child} [child] - child details recorded from form input values
- * @property {Boolean} needsExtraTime - Does the child need extra time for their vaccinations?
+ * @property {boolean} needsExtraTime - Does the child need extra time for their vaccinations?
  * @property {string} [extraTimeReason] - The reason why the child needs extra time for their appointment
- * @property {ParentalRelationship} [parentalRelationship] - The relationship of the person booking the appointment to the child
+ * @property {import('../enums.js').ParentalRelationship} [parentalRelationship] - The relationship of the person booking the appointment to the child
  * @property {string} [parentalRelationshipOther] - User-defined parental relationship to the child for this appointment
  * @property {boolean} [parentHasParentalResponsibility] - Does the parent/carer have legal parental responsibility for the child?
  * @property {string} [session_id] - The ID of the clinic session in which the appointment's booked
@@ -124,6 +124,8 @@ export class ClinicAppointment {
   /**
    * Get a parent object combining the parent's contact details held in the
    * booking with the parental relationship for this appointment's child
+   *
+   * @returns {Parent} - a Parent with the correct relationship to this appointment's child
    */
   get parent() {
     const booking = this.clinicBooking

app/models/clinic-booking.js

@@ -13,7 +13,7 @@ import { formatMonospace, stringToBoolean } from '../utils/string.js'
  * @property {object} [context] - Context
  * @property {string} uuid - Clinic booking UUID
  * @property {string} bookingReference - Booking reference number
- * @property {SessionPreset} sessionPreset - the primary programme for which the parent was invited to book e.g. doubles
+ * @property {import('../enums.js').SessionPreset} sessionPreset - the primary programme for which the parent was invited to book e.g. doubles
  * @property {Parent} parent - contact details for the parent making the booking; see appointments for parental relationship details
  * @property {Array<string>} [appointments_ids] - Unique IDs of children's appointments (one parent may book in multiple children under one booking)
  */
@@ -49,7 +49,7 @@ export class ClinicBooking {
 
   /**
    *
-   * @returns Generate a new, random booking reference
+   * @returns {string} Generate a new, random booking reference
    */
   static generateReference() {
     return faker.helpers.replaceSymbols('CLN-####-####')
@@ -81,7 +81,6 @@ export class ClinicBooking {
    * @returns {Array<Programme>} the set of Programme objects represented by the session preset
    */
   get primaryProgrammes() {
-    // MAL: is this gonna trip me up, relying on the global context if called from the booking journey?
     return this.primaryProgrammeIDs.map((id) =>
       Programme.findOne(id, this.context)
     )

app/routes/book-into-a-clinic.js

@@ -32,7 +32,7 @@ router.get(
   bookIntoClinic.showForm
 )
 
-// MAL: Not convinced I need this special case for clinic bookings... unless it's to perform the final 'save'?
+// TODO: save the completed booking to the global context
 // router.post('/:session_preset_slug/:booking_uuid/new/check-answers', bookIntoClinic.update)
 
 router.post(

app/utils/clinic-appointment.js

@@ -82,9 +82,9 @@ export const getAllAppointmentPaths = (sessionData, booking) => {
  * Get the path for a single health question
  *
  * @param {string} key
- * @param {ClinicAppointment} appointment
+ * @param {import('../models/clinic-appointment.js').ClinicAppointment} appointment
  * @param {string} pathPrefix
- * @returns
+ * @returns {string} The full path to the given health question
  */
 const getHealthQuestionPath = (key, appointment, pathPrefix) => {
   return `${pathPrefix}${appointment.uuid}/health-question-${camelToKebabCase(key)}`

app/utils/clinic-booking.js

@@ -4,6 +4,7 @@ import { SessionPresets } from '../enums.js'
  * Generate a URL for booking into a clinic whose primary programme is given by the session preset
  *
  * @param {string} sessionPresetName - the primary programme for the clinic
+ * @returns {string} - path to the start of the clinic booking journey for the given programme
  */
 export const getClinicBookingUrl = (sessionPresetName) => {
   const sessionPreset = SessionPresets.find(

app/views/book-into-a-clinic/form/vaccination-choice.njk

@@ -13,12 +13,6 @@
     {{ firstName }} is also eligible for other vaccinations.
   </p>
 
-  {% set programmeOptions = [] %}
-  {% for programme in appointment.eligibleProgrammes %}
-    {# MAL: where did I copy this from? Do I need to add name property to ensure the programme IDs (and not the programme titles) are put into the request body? #}
-    {% set programmeOptions = (programmeOptions.push({ text: programme.title, value: programme.id }), programmeOptions) %}
-  {% endfor %}
-
   {{ checkboxes({
     fieldset: {
       legend: {