@planning-inspectorate/dynamic-forms 3.3.1 → 3.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "3.3.1",
+  "version": "3.3.3",
   "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

@@ -1,6 +1,6 @@
 import { Question } from '#question';
 import { Uuid } from '#src/lib/uuid.js';
-import { nunjucksEnv } from '#src/components/utils/nunjucks.js';
+import nunjucks from 'nunjucks';
 
 /**
  * @typedef {Object} ManageListQuestionParameters
@@ -107,7 +107,10 @@ export default class ManageListQuestion extends Question {
 		if (answer && Array.isArray(answer)) {
 			if (this.#showAnswersInSummary) {
 				const answers = answer.map((a) => this.#formatItemAnswers(a));
-				formattedAnswer = nunjucksEnv().render('components/manage-list/answer-summary-list.njk', { answers });
+				// note: nunjucks.render uses the last configured environment
+				// so we assume here that it is the one used by the main application and
+				// is configured for dynamic-forms and govuk components
+				formattedAnswer = nunjucks.render('components/manage-list/answer-summary-list.njk', { answers });
 			} else if (answer.length > 0) {
 				formattedAnswer = `${answer.length} ${this.title}`;
 			}

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

@@ -91,6 +91,8 @@ describe('components/manage-list/question', () => {
 	});
 
 	it('should support showing all answers in the format list answer for summary', (ctx) => {
+		// nunjucks.render uses the last environment configured, so make sure one is configured
+		configureNunjucksTestEnv();
 		const { q } = questionWithManageQuestions(ctx, { showAnswersInSummary: true });
 		const answerForSummary = q.formatAnswerForSummary('section-1', mockJourney(), [{}, {}, {}]);
 		assert.strictEqual(answerForSummary.length, 1);

package/src/components/unit-option-entry/question.js

@@ -112,6 +112,9 @@ export default class UnitOptionEntryQuestion extends Question {
 				conditionalField.value = payload ? payload[conditionalField.fieldName] : existingValue;
 
 				optionData.conditional = {
+					// note: nunjucks.render uses the last configured environment
+					// so we assume here that it is the one used by the main application and
+					// is configured for dynamic-forms and govuk components
 					html: nunjucks.render(`./components/conditional/unit.njk`, {
 						payload,
 						...conditionalField,

package/src/controller.js

@@ -1,6 +1,7 @@
 import { SECTION_STATUS } from './section.js';
 import questionUtils from './components/utils/question-utils.js';
 import { answerObjectForManageListSaving } from '#src/components/manage-list/utils.js';
+import { booleanToYesNoValue } from '#src/components/boolean/question.js';
 
 /**
  * @typedef {import('./journey/journey.js').Journey} Journey
@@ -258,6 +259,12 @@ export function buildSave(saveData, redirectToTaskListOnSuccess) {
 				answers = answerObjectForManageListSaving(journeyResponse, manageListQuestion, req.params);
 			}
 			for (const [k, v] of Object.entries(data?.answers || {})) {
+				if (typeof v === 'boolean') {
+					// boolean answers are saved at booleans, but stored in session and
+					// checked by display logic as yes/no
+					answers[k] = booleanToYesNoValue(v);
+					continue;
+				}
 				answers[k] = v;
 			}
 			// move to the next question

package/src/controller.test.js

@@ -6,6 +6,7 @@ import { Journey } from './journey/journey.js';
 import { SECTION_STATUS } from './section.js';
 
 import { mockReq, mockRes } from '#test/utils/utils.js';
+import { BOOLEAN_OPTIONS } from '#src/components/boolean/question.js';
 
 const res = mockRes();
 const mockBaseUrl = '/manage-appeals/questionnaire';
@@ -501,7 +502,10 @@ describe('dynamic-form/controller', () => {
 				...sampleQuestionObj
 			};
 			sampleQuestionObjWithActions.getDataToSave.mock.mockImplementationOnce(() => ({
-				answers: { [sampleQuestionObj.fieldName]: 'my-answer' }
+				answers: {
+					[sampleQuestionObj.fieldName]: 'my-answer',
+					aBooleanToTest: true
+				}
 			}));
 
 			req.params = {
@@ -528,6 +532,8 @@ describe('dynamic-form/controller', () => {
 			assert.strictEqual(res.redirect.mock.calls[0].arguments[0], expectedUrl);
 			// journey response should be edited if redirecting to next question
 			assert.strictEqual(res.locals.journeyResponse.answers?.sampleFieldName, 'my-answer');
+			// booleans must be strings in journey response
+			assert.strictEqual(res.locals.journeyResponse.answers?.aBooleanToTest, BOOLEAN_OPTIONS.YES);
 		});
 
 		it('should redirect to task list if configured', async () => {

package/src/questions/options-question.js

@@ -100,6 +100,9 @@ export default class OptionsQuestion extends Question {
 				conditionalField.value = answers[conditionalField.fieldName] || '';
 
 				optionData.conditional = {
+					// note: nunjucks.render uses the last configured environment
+					// so we assume here that it is the one used by the main application and
+					// is configured for dynamic-forms and govuk components
 					html: nunjucks.render(`./components/conditional/${conditionalField.type}.njk`, {
 						payload,
 						...conditionalField,

package/src/components/utils/nunjucks.js

@@ -1,20 +0,0 @@
-import path from 'path';
-import nunjucks from 'nunjucks';
-
-/**
- * Returns a nunjucks environment configured with the `src` folder
- * @returns {import('nunjucks').Environment}
- */
-export function nunjucksEnv() {
-	const utilsDir = path.dirname(new URL(import.meta.url).pathname);
-	const srcDir = path.resolve(utilsDir, '..', '..');
-
-	return nunjucks.configure([srcDir], {
-		// output with dangerous characters are escaped automatically
-		autoescape: true,
-		// automatically remove trailing newlines from a block/tag
-		trimBlocks: true,
-		// automatically remove leading whitespace from a block/tag
-		lstripBlocks: true
-	});
-}