@planning-inspectorate/dynamic-forms 2.3.0 → 3.0.0

package/src/journey/journey.test.js

@@ -1,8 +1,9 @@
 import { describe, it, mock, beforeEach } from 'node:test';
 import assert from 'node:assert';
 import { Journey } from './journey.js';
+import { Section } from '#src/section.js';
 
-const mockSections = [
+const mockSectionDetails = [
 	{
 		segment: 'section1',
 		questions: [
@@ -40,6 +41,11 @@ const mockSections = [
 		]
 	}
 ];
+const mockSections = mockSectionDetails.map((data, index) => {
+	const section = new Section(`section ${index}`, data.segment);
+	section.questions = data.questions;
+	return section;
+});
 
 describe('Journey class', () => {
 	let constructorArgs;
@@ -193,15 +199,15 @@ describe('Journey class', () => {
 		});
 	});
 
-	describe('getQuestionBySectionAndName', () => {
+	describe('getQuestionByParams', () => {
 		it('should return the correct question by section and name', () => {
 			const journey = new Journey(constructorArgs);
 			journey.sections = mockSections;
 
-			const question = journey.getQuestionBySectionAndName(
-				mockSections[0].segment,
-				mockSections[0].questions[1].fieldName
-			);
+			const question = journey.getQuestionByParams({
+				section: mockSections[0].segment,
+				question: mockSections[0].questions[1].fieldName
+			});
 
 			assert.strictEqual(question, mockSections[0].questions[1]);
 		});
@@ -210,7 +216,7 @@ describe('Journey class', () => {
 			const journey = new Journey(constructorArgs);
 			journey.sections = mockSections;
 
-			const question = journey.getQuestionBySectionAndName('a', 'b');
+			const question = journey.getQuestionByParams({ section: 'a', question: 'b' });
 
 			assert.strictEqual(question, undefined);
 		});
@@ -219,7 +225,7 @@ describe('Journey class', () => {
 			const journey = new Journey(constructorArgs);
 			journey.sections = mockSections;
 
-			const question = journey.getQuestionBySectionAndName(mockSections[0].segment, 'nope');
+			const question = journey.getQuestionByParams({ section: mockSections[0].segment, question: 'nope' });
 
 			assert.strictEqual(question, undefined);
 		});
@@ -235,7 +241,7 @@ describe('Journey class', () => {
 			journey.sections = mockSections;
 			journey.returnToListing = false;
 
-			const backLinks = journey.getBackLink(section.segment, name);
+			const backLinks = journey.getBackLink({ params: { section: section.segment, question: name } });
 
 			assert.strictEqual(backLinks, `${constructorArgs.makeBaseUrl()}/${section.segment}/${prevQuestionName}`);
 		});
@@ -251,7 +257,7 @@ describe('Journey class', () => {
 				journey.sections = mockSections;
 				journey.returnToListing = false;
 
-				const backLink = journey.getBackLink(section.segment, name, true);
+				const backLink = journey.getBackLink({ params: { section: section.segment, question: name } });
 
 				assert.strictEqual(backLink, `${constructorArgs.makeBaseUrl()}/${prevSection.segment}/${prevQuestionName}`);
 			});
@@ -265,7 +271,7 @@ describe('Journey class', () => {
 			journey.sections = mockSections;
 			journey.returnToListing = false;
 
-			const backLink = journey.getBackLink(section.segment, name, true);
+			const backLink = journey.getBackLink({ params: { section: section.segment, question: name } });
 
 			assert.strictEqual(backLink, null);
 		});
@@ -278,7 +284,7 @@ describe('Journey class', () => {
 			journey.sections = mockSections;
 			journey.returnToListing = false;
 
-			const backLink = journey.getBackLink(section.segment, name, true);
+			const backLink = journey.getBackLink({ params: { section: section.segment, question: name } });
 
 			assert.strictEqual(backLink, '/some/back/link');
 		});
@@ -294,7 +300,7 @@ describe('Journey class', () => {
 				journey.sections = mockSections;
 				journey.returnToListing = returnToListing;
 
-				const nextQuestionUrl = journey.getNextQuestionUrl(section, name, false);
+				const nextQuestionUrl = journey.getNextQuestionUrl({ section: section, question: name }, { reverse: false });
 
 				assert.strictEqual(nextQuestionUrl, null);
 			});
@@ -309,7 +315,7 @@ describe('Journey class', () => {
 				journey.sections = mockSections;
 				journey.returnToListing = returnToListing;
 
-				const nextQuestionUrl = journey.getNextQuestionUrl(section, name, false);
+				const nextQuestionUrl = journey.getNextQuestionUrl({ section: section, question: name }, { reverse: false });
 
 				assert.strictEqual(nextQuestionUrl, null);
 			});
@@ -325,7 +331,10 @@ describe('Journey class', () => {
 				journey.sections = mockSections;
 				journey.returnToListing = returnToListing;
 
-				const nextQuestionUrl = journey.getNextQuestionUrl(section.segment, name, false);
+				const nextQuestionUrl = journey.getNextQuestionUrl(
+					{ section: section.segment, question: name },
+					{ reverse: false }
+				);
 
 				assert.strictEqual(nextQuestionUrl, `${constructorArgs.makeBaseUrl()}/${section.segment}/${nextQuestionName}`);
 			});
@@ -350,7 +359,10 @@ describe('Journey class', () => {
 				journey.sections = mockSections;
 				journey.returnToListing = returnToListing;
 
-				const nextQuestionUrl = journey.getNextQuestionUrl(section.segment, name, false);
+				const nextQuestionUrl = journey.getNextQuestionUrl(
+					{ section: section.segment, question: name },
+					{ reverse: false }
+				);
 
 				assert.strictEqual(nextQuestionUrl, `${constructorArgs.makeBaseUrl()}/${section.segment}/${nextQuestionName}`);
 			});
@@ -366,7 +378,10 @@ describe('Journey class', () => {
 				journey.sections = mockSections;
 				journey.returnToListing = returnToListing;
 
-				const nextQuestionUrl = journey.getNextQuestionUrl(section.segment, name, true);
+				const nextQuestionUrl = journey.getNextQuestionUrl(
+					{ section: section.segment, question: name },
+					{ reverse: true }
+				);
 
 				assert.strictEqual(nextQuestionUrl, `${constructorArgs.makeBaseUrl()}/${section.segment}/${prevQuestionName}`);
 			});
@@ -381,7 +396,10 @@ describe('Journey class', () => {
 				journey.sections = mockSections;
 				journey.returnToListing = returnToListing;
 
-				const nextQuestionUrl = journey.getNextQuestionUrl(section.segment, name, false);
+				const nextQuestionUrl = journey.getNextQuestionUrl(
+					{ section: section.segment, question: name },
+					{ reverse: false }
+				);
 
 				assert.strictEqual(nextQuestionUrl, null);
 			});
@@ -398,7 +416,10 @@ describe('Journey class', () => {
 				journey.sections = mockSections;
 				journey.returnToListing = false;
 
-				const nextQuestionUrl = journey.getNextQuestionUrl(section.segment, name, true);
+				const nextQuestionUrl = journey.getNextQuestionUrl(
+					{ section: section.segment, question: name },
+					{ reverse: true }
+				);
 
 				assert.strictEqual(
 					nextQuestionUrl,
@@ -416,7 +437,10 @@ describe('Journey class', () => {
 				journey.sections = mockSections;
 				journey.returnToListing = returnToListing;
 
-				const nextQuestionUrl = journey.getNextQuestionUrl(section.segment, name, true);
+				const nextQuestionUrl = journey.getNextQuestionUrl(
+					{ section: section.segment, question: name },
+					{ reverse: true }
+				);
 
 				assert.strictEqual(nextQuestionUrl, null);
 			});
@@ -431,7 +455,10 @@ describe('Journey class', () => {
 				journey.sections = mockSections;
 				journey.returnToListing = true;
 
-				const nextQuestionUrl = journey.getNextQuestionUrl(section.segment, name, false);
+				const nextQuestionUrl = journey.getNextQuestionUrl(
+					{ section: section.segment, question: name },
+					{ reverse: false }
+				);
 				assert.strictEqual(nextQuestionUrl, null);
 			});
 		}
@@ -445,7 +472,10 @@ describe('Journey class', () => {
 				journey.sections = mockSections;
 				journey.returnToListing = true;
 
-				const nextQuestionUrl = journey.getNextQuestionUrl(section.segment, name, true);
+				const nextQuestionUrl = journey.getNextQuestionUrl(
+					{ section: section.segment, question: name },
+					{ reverse: true }
+				);
 
 				assert.strictEqual(nextQuestionUrl, null);
 			});
@@ -460,10 +490,51 @@ describe('Journey class', () => {
 			const journey = new Journey(constructorArgs);
 			journey.sections = mockSections;
 
-			const nextQuestionUrl = journey.getNextQuestionUrl(section.segment, name, false);
+			const nextQuestionUrl = journey.getNextQuestionUrl(
+				{ section: section.segment, question: name },
+				{ reverse: false }
+			);
 
 			assert.strictEqual(nextQuestionUrl, `base/${section.segment}/${nextQuestionName}?id=1`);
 		});
+
+		describe('manageListQuestions', () => {
+			it('should pass manageListQuestion to getNextQuestion', () => {
+				const getNextQuestion = mock.fn();
+				const journey = new Journey(constructorArgs);
+				journey.sections = [{ getNextQuestion }];
+				const manageListQuestion = { isManageListQuestion: true };
+				journey.getNextQuestionUrl({}, { manageListQuestion });
+				assert.strictEqual(getNextQuestion.mock.callCount(), 1);
+				assert.strictEqual(getNextQuestion.mock.calls[0].arguments[0].manageListQuestion, manageListQuestion);
+			});
+			it('should preserve params for manage list question', () => {
+				const question = {
+					url: 'question-3',
+					isInManageListSection: true
+				};
+				const manageListQuestion = {
+					url: 'manage-list-question',
+					isManageListQuestion: true
+				};
+				const params = {
+					section: 'section-1',
+					question: 'question-1,',
+					manageListAction: 'add',
+					manageListItemId: 'item-id-1',
+					manageListQuestion: 'question-2'
+				};
+				const getNextQuestion = mock.fn(() => question);
+				const section = {
+					segment: 'section-1',
+					getNextQuestion
+				};
+				const journey = new Journey(constructorArgs);
+				journey.sections = [section];
+				const url = journey.getNextQuestionUrl(params, { manageListQuestion });
+				assert.strictEqual(url, 'base/section-1/manage-list-question/add/item-id-1/question-3');
+			});
+		});
 	});
 
 	describe('getCurrentQuestionUrl', () => {

package/src/lib/uuid.js

@@ -0,0 +1,10 @@
+import { randomUUID } from 'node:crypto';
+
+/**
+ * Wrapper class so it can be overridden by test mocks
+ */
+export class Uuid {
+	static randomUUID() {
+		return randomUUID();
+	}
+}

package/src/lib/uuid.test.js

@@ -0,0 +1,24 @@
+import { Uuid } from '#src/lib/uuid.js';
+import { describe, it } from 'node:test';
+import assert from 'node:assert';
+
+/**
+ *
+ * @param {import('node:test').TestContext} ctx
+ * @param {string} [uuid]
+ */
+export function mockRandomUUID(ctx, uuid = '00000000-0000-0000-0000-000000000000') {
+	const original = Uuid.randomUUID;
+	Uuid.randomUUID = ctx.mock.fn(() => uuid);
+	// restore after the tests
+	ctx.after(() => (Uuid.randomUUID = original));
+}
+
+describe('uuid', () => {
+	it('should return a valid v4 UUID', () => {
+		assert.match(
+			Uuid.randomUUID(),
+			/^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/
+		);
+	});
+});

package/src/middleware/dynamic-req-files-to-req-body-files.js

@@ -16,10 +16,9 @@ export default () => (req, res, next) => {
 		return next();
 	}
 
-	const { section, question } = req.params;
 	const { journey } = res.locals;
 
-	const questionObj = journey.getQuestionBySectionAndName(section, question);
+	const questionObj = journey.getQuestionByParams(req.params);
 	const filesPropertyPath = questionObj.fieldName;
 
 	if (typeof req.files[filesPropertyPath] === 'undefined') {

package/src/middleware/dynamic-req-files-to-req-body-files.test.js

@@ -8,7 +8,7 @@ describe('dynamic-forms/middleware/dynamic-req-files-to-req-body-files', () => {
 	let mockRes;
 	let filesPropertyPath = `example-files-property-path-${counter}`;
 
-	const mockGetQuestionBySectionAndName = mock.fn(() => {
+	const mockgetQuestionByParams = mock.fn(() => {
 		return { fieldName: filesPropertyPath };
 	});
 
@@ -24,7 +24,7 @@ describe('dynamic-forms/middleware/dynamic-req-files-to-req-body-files', () => {
 			cookie: mock.fn(),
 			locals: {
 				journeyResponse: mock.fn(),
-				journey: { getQuestionBySectionAndName: mockGetQuestionBySectionAndName }
+				journey: { getQuestionByParams: mockgetQuestionByParams }
 			},
 			redirect: mock.fn(),
 			render: mock.fn(),

package/src/questions/question-props.d.ts

@@ -16,7 +16,8 @@ type QuestionTypes =
 	| 'multi-field-input'
 	| 'number'
 	| 'site-address'
-	| 'unit-option';
+	| 'unit-option'
+	| 'manage-list';
 
 interface CommonQuestionProps {
 	type: QuestionTypes;

package/src/questions/question.js

@@ -30,7 +30,6 @@ import MultiFieldInputValidator from '../validator/multi-field-input-validator.j
  * @property {string} layoutTemplate
  * @property {string} pageCaption
  * @property {string} [continueButtonText]
- * @property {Array.<string>} navigation
  * @property {string} backLink
  * @property {boolean} showBackToListLink
  * @property {string} listLink
@@ -91,6 +90,7 @@ export class Question {
 		title: '',
 		text: ''
 	};
+	#isInManageListSection = false;
 
 	/**
 	 * @param {import('#question-types').QuestionParameters} params
@@ -150,8 +150,57 @@ export class Question {
 		});
 	}
 
+	/**
+	 * Is this question a manage list question?
+	 * Implemented as a getter so manage list question implementations can override it,
+	 * but it cannot be changed at runtime.
+	 *
+	 * @returns {boolean}
+	 */
+	get isManageListQuestion() {
+		return false;
+	}
+
+	/**
+	 * Is this question added to a ManageListSection?
+	 *
+	 * @returns {boolean}
+	 */
+	get isInManageListSection() {
+		return this.#isInManageListSection;
+	}
+
+	set isInManageListSection(value) {
+		if (!value) {
+			throw new Error('Question isInManageListSection is false by default');
+		}
+		this.#isInManageListSection = value;
+	}
+
 	/**
 	 * gets the view model for this question
+	 *
+	 * Wraps prepQuestionForRendering to add the back link - which requires more parameters
+	 * that prepQuestionForRendering doesn't need
+	 *
+	 * @param {Object} options
+	 * @param {import('#src/journey/journey-types.d.ts').RouteParams} options.params
+	 * @param {import('#src/components/manage-list/question.js')} [options.manageListQuestion]
+	 * @param {Section} section - the current section
+	 * @param {Journey} journey - the journey we are in
+	 * @param {Record<string, unknown>} [customViewData] additional data to send to view
+	 * @param {unknown} [payload]
+	 * @returns {QuestionViewModel}
+	 */
+	toViewModel({ params, manageListQuestion, section, journey, customViewData, payload }) {
+		const viewModel = this.prepQuestionForRendering(section, journey, customViewData, payload);
+		viewModel.backLink = journey.getBackLink({ params, manageListQuestion });
+		return viewModel;
+	}
+
+	/**
+	 * gets the base view model for this question
+	 *
 	 * @param {Section} section - the current section
 	 * @param {Journey} journey - the journey we are in
 	 * @param {Record<string, unknown>} [customViewData] additional data to send to view
@@ -160,8 +209,6 @@ export class Question {
 	 */
 	prepQuestionForRendering(section, journey, customViewData, payload) {
 		const answer = journey.response.answers[this.fieldName] || '';
-		const backLink = journey.getBackLink(section.segment, this.fieldName);
-
 		return {
 			question: {
 				value: answer,
@@ -179,8 +226,6 @@ export class Question {
 			layoutTemplate: journey.journeyTemplate,
 			pageCaption: section?.name,
 
-			navigation: ['', backLink],
-			backLink,
 			showBackToListLink: this.showBackToListLink,
 			listLink: journey.taskListUrl,
 			journeyTitle: journey.journeyTitle,
@@ -212,23 +257,26 @@ export class Question {
 	 * check for validation errors
 	 * @param {import('express').Request} req
 	 * @param {Journey} journey
-	 * @param {Section} sectionObj
+	 * @param {Section} section
+	 * @param {import('#src/components/manage-list/question.js')} [manageListQuestion]
 	 * @returns {QuestionViewModel|undefined} returns the view model for displaying the error or undefined if there are no errors
 	 */
-	checkForValidationErrors(req, sectionObj, journey) {
+	checkForValidationErrors(req, section, journey, manageListQuestion) {
 		const { body = {} } = req;
 		const { errors = {}, errorSummary = [] } = body;
 
 		if (Object.keys(errors).length > 0) {
-			return this.prepQuestionForRendering(
-				sectionObj,
+			return this.toViewModel({
+				params: req.params,
+				section,
 				journey,
-				{
+				customViewData: {
 					errors,
 					errorSummary
 				},
-				body
-			);
+				payload: body,
+				manageListQuestion
+			});
 		}
 	}
 
@@ -279,19 +327,20 @@ export class Question {
 	}
 
 	/**
-	 * Handles redirect after saving
+	 * Handles redirect after saving. Kept around for backwards compatibility.
+	 *
 	 * @param {import('express').Response} res
 	 * @param {Journey} journey
 	 * @param {string} sectionSegment
 	 * @param {string} questionSegment
 	 * @returns {void}
+	 * @deprecated - use `journey.redirectToNextQuestion`
 	 */
 	handleNextQuestion(res, journey, sectionSegment, questionSegment) {
-		let next = journey.getNextQuestionUrl(sectionSegment, questionSegment);
-		if (next === null) {
-			next = journey.taskListUrl;
-		}
-		return res.redirect(next);
+		return journey.redirectToNextQuestion(res, {
+			section: sectionSegment,
+			question: questionSegment
+		});
 	}
 
 	/**

package/src/questions/question.test.js

@@ -63,6 +63,7 @@ describe('./src/dynamic-forms/question.js', () => {
 			assert.strictEqual(question.validators, VALIDATORS);
 			assert.strictEqual(question.html, HTML);
 			assert.strictEqual(question.hint, HINT);
+			assert.strictEqual(question.isManageListQuestion, false);
 		});
 		it('should support viewData field', () => {
 			const question = getTestQuestion({ viewData: { test: 'test' } });
@@ -110,6 +111,30 @@ describe('./src/dynamic-forms/question.js', () => {
 		});
 	});
 
+	describe('isInManageListSection', () => {
+		it('should default to false', () => {
+			const question = getTestQuestion();
+			assert.strictEqual(question.isInManageListSection, false);
+		});
+		it('should support setting isInManageListSection', () => {
+			const question = getTestQuestion();
+			assert.strictEqual(question.isInManageListSection, false);
+			question.isInManageListSection = true;
+			assert.strictEqual(question.isInManageListSection, true);
+		});
+		it('should not support setting isInManageListSection false', () => {
+			const question = getTestQuestion();
+			assert.strictEqual(question.isInManageListSection, false);
+			assert.throws(
+				() => (question.isInManageListSection = false),
+				(error) => {
+					assert.strictEqual(error.message, 'Question isInManageListSection is false by default');
+					return true;
+				}
+			);
+		});
+	});
+
 	describe('prepQuestionForRendering', () => {
 		it('should prepQuestionForRendering', () => {
 			const question = getTestQuestion();
@@ -150,8 +175,6 @@ describe('./src/dynamic-forms/question.js', () => {
 			assert.deepStrictEqual(result.answer, journey.response.answers[question.fieldName]);
 			assert.deepStrictEqual(result.layoutTemplate, journey.journeyTemplate);
 			assert.deepStrictEqual(result.pageCaption, section.name);
-			assert.deepStrictEqual(result.navigation, ['', 'back']);
-			assert.deepStrictEqual(result.backLink, 'back');
 			assert.deepStrictEqual(result.showBackToListLink, question.showBackToListLink);
 			assert.deepStrictEqual(result.listLink, journey.taskListUrl);
 			assert.deepStrictEqual(result.journeyTitle, journey.journeyTitle);
@@ -205,7 +228,7 @@ describe('./src/dynamic-forms/question.js', () => {
 			const expectedResult = { a: 1 };
 			const req = { body: { errors: { error: 'we have an error' } } };
 			const question = getTestQuestion();
-			question.prepQuestionForRendering = mock.fn(() => expectedResult);
+			question.toViewModel = mock.fn(() => expectedResult);
 
 			const result = question.checkForValidationErrors(req);
 

package/src/questions/questions.js

@@ -15,6 +15,7 @@ import EmailQuestion from '../components/email/question.js';
 import { COMPONENT_TYPES } from '../index.js';
 import TextEntryRedactQuestion from '../components/text-entry-redact/question.js';
 import DateTimeQuestion from '../components/date-time/question.js';
+import ManageListQuestion from '../components/manage-list/question.js';
 
 // This looks a bit grim because so few of our
 // Questions overlap with Question correctly.
@@ -35,5 +36,6 @@ export const questionClasses = Object.freeze({
 	[COMPONENT_TYPES.MULTI_FIELD_INPUT]: MultiFieldInputQuestion,
 	[COMPONENT_TYPES.NUMBER]: NumberEntryQuestion,
 	[COMPONENT_TYPES.UNIT_OPTION]: UnitOptionEntryQuestion,
-	[COMPONENT_TYPES.EMAIL]: EmailQuestion
+	[COMPONENT_TYPES.EMAIL]: EmailQuestion,
+	[COMPONENT_TYPES.MANAGE_LIST]: ManageListQuestion
 });

package/src/section-types.d.ts

@@ -0,0 +1,18 @@
+import { JourneyResponse } from '#src/journey/journey-response.js';
+import ManageListQuestion from '#src/components/manage-list/question.js';
+import { Question } from '#src/questions/question.js';
+
+export interface GetNextQuestionParams {
+	questionFieldName: string;
+	response: JourneyResponse;
+	// if this is part of a manage list section
+	manageListQuestion?: ManageListQuestion;
+	takeNextQuestion: boolean;
+	// to get previous question instead of next
+	reverse: boolean;
+}
+
+export interface StaticGetNextQuestionParams extends GetNextQuestionParams {
+	manageListQuestion: undefined;
+	questions: Question[];
+}

package/src/section.js

@@ -6,6 +6,13 @@
 
 import RequiredValidator from './validator/required-validator.js';
 
+/**
+ * A value indicating the final question of a section has been reached
+ *
+ * @type {Symbol}
+ */
+export const END_OF_SECTION = Symbol('END_OF_SECTION');
+
 /**
  * Defines a section for a questionnaire, a set of Questions
  * @class
@@ -75,13 +82,20 @@ export class Section {
 
 	/**
 	 * Fluent API method for adding questions
-	 * @param {any} question
+	 * @param {import('#src/questions/question.js').Question} question
+	 * @param {import('#src/components/manage-list/manage-list-section.js').ManageListSection} [manageListSection]
 	 * @returns {Section}
 	 */
-	addQuestion(question) {
+	addQuestion(question, manageListSection) {
 		if (!question) {
 			throw new Error('question is required');
 		}
+		if (question.isManageListQuestion) {
+			if (!manageListSection || !manageListSection.isManageListSection) {
+				throw new Error('manage list questions require a ManageListSection');
+			}
+			question.section = manageListSection;
+		}
 		this.questions.push(question);
 		this.#conditionAdded = false; // reset condition flag
 		this.#applyConditions(question);
@@ -183,6 +197,57 @@ export class Section {
 		return this;
 	}
 
+	/**
+	 * Get the next question in this section given a questionParam (question fieldName)
+	 * @param {import('./section-types.d.ts').GetNextQuestionParams} params
+	 * @returns {Question|Symbol|null}
+	 */
+	getNextQuestion(params) {
+		const { manageListQuestion } = params;
+		if (manageListQuestion) {
+			// first check if the next question is within the manage list section
+			const next = Section.getNextQuestion({
+				...params,
+				questions: manageListQuestion.section.questions
+			});
+			if (next === END_OF_SECTION) {
+				// after the manage list section questions, go back to the manage list question
+				return manageListQuestion;
+			}
+			return next;
+		}
+		return Section.getNextQuestion({
+			...params,
+			questions: this.questions
+		});
+	}
+
+	/**
+	 * Implementation of getNextQuestion given a list of questions
+	 *
+	 * @param {import('./section-types.d.ts').StaticGetNextQuestionParams} params
+	 * @returns {Question|Symbol|null}
+	 */
+	static getNextQuestion({ questions, questionFieldName, response, takeNextQuestion = false, reverse = false }) {
+		const numberOfQuestions = questions.length;
+
+		const questionsStart = reverse ? numberOfQuestions - 1 : 0;
+		for (let i = questionsStart; reverse ? i >= 0 : i < numberOfQuestions; reverse ? i-- : i++) {
+			const question = questions[i];
+			if (takeNextQuestion && question.shouldDisplay(response)) {
+				return question;
+			}
+
+			if (question.fieldName === questionFieldName || question.url === questionFieldName) {
+				takeNextQuestion = true;
+			}
+		}
+		if (takeNextQuestion) {
+			return END_OF_SECTION;
+		}
+		return null;
+	}
+
 	/**
 	 * checks answers on response to ensure that a answer is provided for each required question in the section
 	 * @param {JourneyResponse} journeyResponse