@planning-inspectorate/dynamic-forms 3.8.0 → 3.8.2

package/.azure/pipelines/azure-pipelines-pr.yml

@@ -16,14 +16,13 @@ resources:
       type: github
       endpoint: Planning-Inspectorate
       name: Planning-Inspectorate/common-pipeline-templates
-      ref: refs/tags/release/3.23.0
+      ref: refs/tags/release/3.25.2
 
 extends:
   template: stages/wrapper_ci.yml@templates
   parameters:
     gitFetchDepth: 0
     skipAzureAuth: true
-    skipGitTagging: true
     validationJobs:
       - name: Run Linting & Tests
         steps:

package/package.json

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

package/src/controller.js

@@ -53,7 +53,7 @@ function buildSectionViewModel(name, status = '') {
  * build a view model for a row in the journey overview
  * @param {string} key
  * @param {string} value
- * @param {ActionView|ActionView[]} action
+ * @param {ActionView|ActionView[]} [action]
  * @returns {RowView} a representation of a row
  */
 function buildSectionRowViewModel(key, value, action) {
@@ -64,9 +64,7 @@ function buildSectionRowViewModel(key, value, action) {
 		value: {
 			html: value
 		},
-		actions: {
-			items: toArray(action)
-		}
+		actions: action ? { items: toArray(action) } : undefined
 	};
 }
 

package/src/controller.test.js

@@ -299,6 +299,56 @@ describe('dynamic-form/controller', () => {
 			assert.strictEqual(args[0], mockJourney.sections[0].segment);
 			assert.strictEqual(args[2], expectedAnswer.value);
 		});
+		it('should format an undefined action as undefined', async () => {
+			const mockFn = res.render.mock;
+			mockFn.resetCalls();
+			mockJourney.sections[0].questions[0].formatAnswerForSummary.mock.mockImplementation(() => [
+				{
+					key: 'Title 1a',
+					value: mockAnswer,
+					action: undefined
+				}
+			]);
+			res.locals.journeyResponse.referenceId = mockRef;
+			const appeal = { a: 1, caseReference: 2 };
+
+			const pageCaption = `Appeal ${appeal.caseReference}`;
+			await list(req, res, pageCaption, { appeal });
+
+			const renderCall = mockFn.calls[0].arguments[1];
+			const firstRowActions = renderCall.summaryListData.sections[0].list.rows[0].actions;
+			assert.strictEqual(firstRowActions, undefined);
+		});
+
+		it('should format a single action object as an array in the actions property', async () => {
+			const mockFn = res.render.mock;
+			mockFn.resetCalls();
+			mockJourney.sections[0].questions[0].formatAnswerForSummary.mock.mockImplementation(() => [
+				{
+					key: 'Title 1a',
+					value: mockAnswer,
+					action: {
+						href: '/manage-appeals/questionnaire/123456/segment-1/title-1a',
+						text: 'Answer',
+						visuallyHiddenText: 'Answer'
+					}
+				}
+			]);
+			res.locals.journeyResponse.referenceId = mockRef;
+
+			await list(req, res);
+
+			const renderCall = mockFn.calls[0].arguments[1];
+			const rowActions = renderCall.summaryListData.sections[0].list.rows[0].actions;
+			assert.ok(rowActions);
+			assert.ok(Array.isArray(rowActions.items));
+			assert.strictEqual(rowActions.items.length, 1);
+			assert.deepStrictEqual(rowActions.items[0], {
+				href: '/manage-appeals/questionnaire/123456/segment-1/title-1a',
+				text: 'Answer',
+				visuallyHiddenText: 'Answer'
+			});
+		});
 	});
 
 	describe('question', () => {

package/src/validator/address-validator.js

@@ -31,9 +31,8 @@ export const postcodeMinLength = 5;
 export default class AddressValidator extends BaseValidator {
 	/**
 	 * creates an instance of an AddressValidator
-	 * @param {Object} opts
-	 * @param {boolean} [opts.required]
-	 * @param {{[key: string]: boolean}} [opts.requiredFields]
+	 * @param {Object} [opts]
+	 * @param {{addressLine1: boolean, addressLine2: boolean, townCity: boolean, county: boolean, postcode: boolean}} [opts.requiredFields]
 	 */
 	constructor(opts) {
 		super();

package/src/validator/string-validator.js

@@ -4,19 +4,19 @@ import BaseValidator from './base-validator.js';
 /**
  * @typedef {Object} MinLength
  * @property {Number} minLength
- * @property {String} minLengthMessage
+ * @property {String} [minLengthMessage]
  */
 
 /**
  * @typedef {Object} MaxLength
  * @property {Number} maxLength
- * @property {String} maxLengthMessage
+ * @property {String} [maxLengthMessage]
  */
 
 /**
  * @typedef {Object} Regex
  * @property {String | RegExp} regex
- * @property {String} regexMessage
+ * @property {String} [regexMessage]
  */
 
 export default class StringValidator extends BaseValidator {

package/types/src/components/address/question.d.ts

@@ -4,7 +4,11 @@ export default class AddressQuestion extends Question {
      */
     constructor(params: import("#question-types").QuestionParameters);
     requiredFields: {
-        [key: string]: boolean;
+        addressLine1: boolean;
+        addressLine2: boolean;
+        townCity: boolean;
+        county: boolean;
+        postcode: boolean;
     } | undefined;
     addressLabels: {
         addressLine1: string;

package/types/src/components/address/question.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/address/question.js"],"names":[],"mappings":"AAOA;IACC;;OAEG;IACH,oBAFW,OAAO,iBAAiB,EAAE,kBAAkB,EAqBtD;IAXE;;kBAA8C;IAIhD;;;;;;MAMC;IAGF;;;OAGG;IACH,4BAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,GAAC,GAAC,MAAM,CAqBpB;IAqCD;;;OAGG;IACH;;eAUC;IAuBD,kEAMC;CACD;yBAxIwB,WAAW"}
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/address/question.js"],"names":[],"mappings":"AAOA;IACC;;OAEG;IACH,oBAFW,OAAO,iBAAiB,EAAE,kBAAkB,EAqBtD;IAXE;;;;;;kBAA8C;IAIhD;;;;;;MAMC;IAGF;;;OAGG;IACH,4BAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,GAAC,GAAC,MAAM,CAqBpB;IAqCD;;;OAGG;IACH;;eAUC;IAuBD,kEAMC;CACD;yBAxIwB,WAAW"}

package/types/src/controller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/controller.js"],"names":[],"mappings":"AAwEA;;;GAGG;AACH,qCAHW,MAAM,OAKhB;AAED;;;;;GAKG;AACH,sDAHW,MAAM,YACN,MAAM,gBA8DhB;AAED;;;;GAIG;AACH,2DA0CC;AAED;;;;;;;;;;GAUG;AAEH;;GAEG;AAEH;;;;GAIG;AACH,oCAJW,UAAU,gCACV,OAAO,OAuFjB;sBAtSY,OAAO,sBAAsB,EAAE,OAAO;uBACtC,OAAO,yBAAyB,EAAE,QAAQ;;;aAMzC,MAAM;YACN,MAAM;UAEjB;QAAiC,IAAI,EAA1B,KAAK,CAAE,OAAO,CAAC;KAC5B;;;SAIa;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;WAChB;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;;eAC1B,UAAU,EAAE;;;;UAKrB,MAAM;UACN,MAAM;;;;;;eA0KN,MAAM;iBACN,MAAM;sBACN,OAAO;;;;;;;yBAOR,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC"}
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/controller.js"],"names":[],"mappings":"AAsEA;;;GAGG;AACH,qCAHW,MAAM,OAKhB;AAED;;;;;GAKG;AACH,sDAHW,MAAM,YACN,MAAM,gBA8DhB;AAED;;;;GAIG;AACH,2DA0CC;AAED;;;;;;;;;;GAUG;AAEH;;GAEG;AAEH;;;;GAIG;AACH,oCAJW,UAAU,gCACV,OAAO,OAuFjB;sBApSY,OAAO,sBAAsB,EAAE,OAAO;uBACtC,OAAO,yBAAyB,EAAE,QAAQ;;;aAMzC,MAAM;YACN,MAAM;UAEjB;QAAiC,IAAI,EAA1B,KAAK,CAAE,OAAO,CAAC;KAC5B;;;SAIa;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;WAChB;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;;eAC1B,UAAU,EAAE;;;;UAKrB,MAAM;UACN,MAAM;;;;;;eAwKN,MAAM;iBACN,MAAM;sBACN,OAAO;;;;;;;yBAOR,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC"}

package/types/src/validator/address-validator.d.ts

@@ -16,18 +16,24 @@ export const postcodeMinLength: 5;
 export default class AddressValidator extends BaseValidator {
     /**
      * creates an instance of an AddressValidator
-     * @param {Object} opts
-     * @param {boolean} [opts.required]
-     * @param {{[key: string]: boolean}} [opts.requiredFields]
+     * @param {Object} [opts]
+     * @param {{addressLine1: boolean, addressLine2: boolean, townCity: boolean, county: boolean, postcode: boolean}} [opts.requiredFields]
      */
-    constructor(opts: {
-        required?: boolean | undefined;
+    constructor(opts?: {
         requiredFields?: {
-            [key: string]: boolean;
+            addressLine1: boolean;
+            addressLine2: boolean;
+            townCity: boolean;
+            county: boolean;
+            postcode: boolean;
         } | undefined;
     });
     requiredFields: {
-        [key: string]: boolean;
+        addressLine1: boolean;
+        addressLine2: boolean;
+        townCity: boolean;
+        county: boolean;
+        postcode: boolean;
     } | undefined;
     /**
      * validates response body using questionObj fieldname

package/types/src/validator/address-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"address-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/address-validator.js"],"names":[],"mappings":"AAIO,4EAQN;AAGD,oCAAqC,GAAG,CAAC;AACzC,oCAAqC,CAAC,CAAC;AACvC,oCAAqC,GAAG,CAAC;AACzC,oCAAqC,CAAC,CAAC;AACvC,gCAAiC,GAAG,CAAC;AACrC,gCAAiC,CAAC,CAAC;AACnC,8BAA+B,GAAG,CAAC;AACnC,8BAA+B,CAAC,CAAC;AACjC,gCAAiC,CAAC,CAAC;AACnC,gCAAiC,CAAC,CAAC;AAEnC;;;GAGG;AACH;IACC;;;;;OAKG;IACH,kBAHG;QAAuB,QAAQ;QACS,cAAc;;;KAAC,EAKzD;IADA;;kBAA0C;IAG3C;;;OAGG;IACH,sBAFW,QAAQ,iDAYlB;IA+FD,sBAKC;;CACD;0BA3JyB,qBAAqB"}
+{"version":3,"file":"address-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/address-validator.js"],"names":[],"mappings":"AAIO,4EAQN;AAGD,oCAAqC,GAAG,CAAC;AACzC,oCAAqC,CAAC,CAAC;AACvC,oCAAqC,GAAG,CAAC;AACzC,oCAAqC,CAAC,CAAC;AACvC,gCAAiC,GAAG,CAAC;AACrC,gCAAiC,CAAC,CAAC;AACnC,8BAA+B,GAAG,CAAC;AACnC,8BAA+B,CAAC,CAAC;AACjC,gCAAiC,CAAC,CAAC;AACnC,gCAAiC,CAAC,CAAC;AAEnC;;;GAGG;AACH;IACC;;;;OAIG;IACH,mBAFG;QAAqH,cAAc;0BAA5G,OAAO;0BAAgB,OAAO;sBAAY,OAAO;oBAAU,OAAO;sBAAY,OAAO;;KAAwB,EAKtI;IADA;sBAJyB,OAAO;sBAAgB,OAAO;kBAAY,OAAO;gBAAU,OAAO;kBAAY,OAAO;kBAIpE;IAG3C;;;OAGG;IACH,sBAFW,QAAQ,iDAYlB;IA+FD,sBAKC;;CACD;0BA1JyB,qBAAqB"}

package/types/src/validator/string-validator.d.ts

@@ -1,17 +1,17 @@
 /**
  * @typedef {Object} MinLength
  * @property {Number} minLength
- * @property {String} minLengthMessage
+ * @property {String} [minLengthMessage]
  */
 /**
  * @typedef {Object} MaxLength
  * @property {Number} maxLength
- * @property {String} maxLengthMessage
+ * @property {String} [maxLengthMessage]
  */
 /**
  * @typedef {Object} Regex
  * @property {String | RegExp} regex
- * @property {String} regexMessage
+ * @property {String} [regexMessage]
  */
 export default class StringValidator extends BaseValidator {
     /**
@@ -44,15 +44,15 @@ export default class StringValidator extends BaseValidator {
 }
 export type MinLength = {
     minLength: number;
-    minLengthMessage: string;
+    minLengthMessage?: string | undefined;
 };
 export type MaxLength = {
     maxLength: number;
-    maxLengthMessage: string;
+    maxLengthMessage?: string | undefined;
 };
 export type Regex = {
     regex: string | RegExp;
-    regexMessage: string;
+    regexMessage?: string | undefined;
 };
 import BaseValidator from './base-validator.js';
 //# sourceMappingURL=string-validator.d.ts.map