@planning-inspectorate/dynamic-forms 3.1.0 → 3.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "This package is for building GDS forms using a configuration-based approach.",
   "main": "./src/index.js",
   "type": "module",

package/src/components/manage-list/question.js

@@ -86,6 +86,13 @@ export default class ManageListQuestion extends Question {
 		});
 	}
 
+	async getDataToSave(req, journeyResponse) {
+		let responseToSave = { answers: {} };
+		const data = journeyResponse.answers[this.fieldName];
+		responseToSave.answers[this.fieldName] = data || [];
+		return responseToSave;
+	}
+
 	formatAnswerForSummary(sectionSegment, journey, answer) {
 		let formattedAnswer = this.notStartedText;
 		if (answer && Array.isArray(answer)) {

package/src/controller.js

@@ -184,6 +184,8 @@ export async function question(req, res) {
  * @property {import('express').Response} res
  * @property {string} journeyId
  * @property {string} referenceId
+ * @property {boolean} isManageListItem
+ * @property {string} [manageListQuestionFieldName]
  * @property {Object<string, any>} data
  */
 
@@ -234,6 +236,8 @@ export function buildSave(saveData, redirectToTaskListOnSuccess) {
 				res,
 				journeyId: journeyResponse.journeyId,
 				referenceId: journeyResponse.referenceId,
+				isManageListItem: question.isInManageListSection,
+				manageListQuestionFieldName: manageListQuestion?.fieldName,
 				data
 			});
 

package/src/controller.test.js

@@ -386,6 +386,8 @@ describe('dynamic-form/controller', () => {
 					res,
 					journeyId: journeyParams.journeyId,
 					referenceId: journeyParams.referenceId,
+					isManageListItem: undefined,
+					manageListQuestionFieldName: undefined,
 					data: undefined
 				}
 			]);
@@ -443,7 +445,9 @@ describe('dynamic-form/controller', () => {
 						res,
 						journeyId: journeyParams.journeyId,
 						referenceId: journeyParams.referenceId,
-						data: undefined
+						data: undefined,
+						isManageListItem: undefined,
+						manageListQuestionFieldName: undefined
 					}
 				],
 				'save data args'

package/src/lib/session-answer-store.js

@@ -35,11 +35,12 @@ import { booleanToYesNoValue } from '../components/boolean/question.js';
  *
  *
  * @param {Object} opts
- * @param {string} [opts.reqParam] - optional request parameter to use as a key
+ * @param {string} [opts.reqParam]
+ * - optional request parameter to use as a key
  * @returns {import('../controller').SaveDataFn}
  */
 export function buildSaveDataToSession({ reqParam } = {}) {
-	return async ({ req, journeyId, data }) => {
+	return async ({ req, journeyId, data, isManageListItem, manageListQuestionFieldName }) => {
 		if (!req.session) {
 			throw new Error('request session required');
 		}
@@ -50,8 +51,16 @@ export function buildSaveDataToSession({ reqParam } = {}) {
 			// key by a further param
 			forms = forms[reqParamValue] || (forms[reqParamValue] = {});
 		}
-		const answers = forms[journeyId] || (forms[journeyId] = {});
+		let answers = forms[journeyId] || (forms[journeyId] = {});
+		if (isManageListItem) {
+			const answersList = answers[manageListQuestionFieldName] || (answers[manageListQuestionFieldName] = []);
+			answers = answersList.find((item) => item.id === req.params.manageListItemId);
 
+			if (!answers) {
+				answers = { id: req.params.manageListItemId };
+				answersList.push(answers);
+			}
+		}
 		for (const [k, v] of Object.entries(data?.answers || {})) {
 			answers[k] = v;
 		}

package/src/lib/session-answer-store.test.js

@@ -80,6 +80,48 @@ describe('session-answer-store', () => {
 				}
 			});
 		});
+		it('should add a new managed list item when not present in the session', async () => {
+			const req = mockReq();
+			req.params = { manageListItemId: '12345' };
+			req.session = {};
+			const journeyId = 'j-1';
+			const data = { answers: { q1: 'a1' } };
+			const isManageListItem = true;
+			const manageListQuestionFieldName = 'myManagedList';
+			const saveDataToSession = buildSaveDataToSession();
+			await saveDataToSession({ req, journeyId, data, isManageListItem, manageListQuestionFieldName });
+			assert.deepStrictEqual(req.session, {
+				forms: {
+					'j-1': {
+						myManagedList: [{ id: '12345', q1: 'a1' }]
+					}
+				}
+			});
+		});
+		it('should add to an existing managed list item using the id when present in the session', async () => {
+			const req = mockReq();
+			req.params = { manageListItemId: '12345' };
+			req.session = {
+				forms: {
+					'j-1': {
+						myManagedList: [{ id: '12345', q1: 'old value' }]
+					}
+				}
+			};
+			const journeyId = 'j-1';
+			const data = { answers: { q2: 'a1' } };
+			const isManageListItem = true;
+			const manageListQuestionFieldName = 'myManagedList';
+			const saveDataToSession = buildSaveDataToSession();
+			await saveDataToSession({ req, journeyId, data, isManageListItem, manageListQuestionFieldName });
+			assert.deepStrictEqual(req.session, {
+				forms: {
+					'j-1': {
+						myManagedList: [{ id: '12345', q1: 'old value', q2: 'a1' }]
+					}
+				}
+			});
+		});
 
 		it('should overwrite existing data by reqParam & journeyId', async () => {
 			const req = mockReq();

package/test/check-your-answers.test.js

@@ -1,9 +1,10 @@
 import { describe, it } from 'node:test';
 import assert from 'assert';
-import { questionsInOrder } from './questions.js';
+import { manageListQuestions, questionsInOrder } from './questions.js';
 import path from 'path';
 import { escapeForRegExp, snapshotsDir } from './utils/utils.js';
 import { createAppWithQuestions, mockAnswer, mockAnswerBody } from './questions.test.js';
+import { COMPONENT_TYPES } from '#src/index.js';
 
 describe('check-your-answers', () => {
 	it(`should render all question rows with no answers`, async (ctx) => {
@@ -39,6 +40,23 @@ describe('check-your-answers', () => {
 
 		// 'answer' each question
 		for (const q of questionsInOrder) {
+			// Save happens on subquestion for manage list questions
+			if (q.type === COMPONENT_TYPES.MANAGE_LIST) {
+				// Get the list of subquestions for this manage list question
+				const manageListQuestion = manageListQuestions.find(
+					(question) => question.manageListQuestion.fieldName === q.fieldName
+				);
+				const subQuestionAnswers = mockAnswerBody(q)[manageListQuestion.manageListQuestion.fieldName];
+				// Post to them individually
+				for (const answer of subQuestionAnswers) {
+					const id = answer.id;
+					for (const subQuestion of manageListQuestion.questions) {
+						const key = subQuestion.fieldName;
+						const body = { [key]: answer[key] };
+						await testServer.post(`/questions/${q.url}/add/${id}/${subQuestion.url}`, body, { redirect: 'manual' });
+					}
+				}
+			}
 			await testServer.post(`/questions/${q.url}`, mockAnswerBody(q), { redirect: 'manual' });
 		}
 

package/test/questions.test.js

@@ -257,9 +257,9 @@ export function mockAnswerBody(q) {
 			// manage list questions not available here so just hard coded
 			return {
 				[q.fieldName]: [
-					{ travelCompanionName: 'Companion 1', travelCompanionEmail: 'compaion-1@example.com' },
-					{ travelCompanionName: 'Companion 2', travelCompanionEmail: 'compaion-2@example.com' },
-					{ travelCompanionName: 'Companion 3', travelCompanionEmail: 'compaion-3@example.com' }
+					{ id: '1234', travelCompanionName: 'Companion 1', travelCompanionEmail: 'companion-1@example.com' },
+					{ id: '4567', travelCompanionName: 'Companion 2', travelCompanionEmail: 'companion-2@example.com' },
+					{ id: '8901', travelCompanionName: 'Companion 3', travelCompanionEmail: 'companion-3@example.com' }
 				]
 			};
 		}