@planning-inspectorate/dynamic-forms 3.15.5 → 3.16.0

package/.gitattributes

@@ -1,2 +1,5 @@
+# Ensure all text files use LF line endings
+* text=auto eol=lf
+
 # snapshots always use \n
 test/snapshots/** text eol=lf

package/.prettierrc

@@ -7,5 +7,6 @@
 	"trailingComma": "none",
 	"bracketSpacing": true,
 	"arrowParens": "always",
+	"endOfLine": "lf",
 	"plugins": []
 }

package/README.md

@@ -295,9 +295,17 @@ Commits must follow conventional commits, and the commit types will be used by s
 The package will be released automatically using semantic-release, on merge to main. This will include a git tag for the release, and publishing to NPM.
 
 ### Type safety
-We use JSDocs to describe the types used. This is helpful for the JavaScript developers, and *crucial* for this project being compatible with TypeScript. Type declarations for TypeScript users are auto-generated by `tsc` to create type declarations. So please:
-1. Add JSDocs annotations to your code, use `@import` or an inline import, i.e. `@param {import('#section').Section} section`. Avoid a top-level import, e.g. `@typedef {import('../validator/base-validator.js')} BaseValidator` - this seems to create confusion when the compiler auto-generates the type declarations.
-2. Maintain `index.js`. If you're adding code that users of this module will import, please make it is being exported in `index.js`.
+We use JSDocs to describe the types used. This is helpful for the JavaScript developers, and *crucial* for this project being compatible with TypeScript. Type declarations for TypeScript users are auto-generated by `tsc` inline alongside the source files.
+
+**Type definitions:**
+- Shared type definitions should be placed in the `typedefs/` folder (e.g. `typedefs/question-types.d.ts`)
+- New type definition files need a corresponding empty `.js` file, which needs to be exported from `index.js`, in order to be importable from the package root.
+- Types can be imported using path aliases, e.g. `@param {import('#typedefs/question-types.d.ts').SummaryRow[]} rows`
+
+**Best practices:**
+1. Always use inline imports for JSDoc types, e.g. `@param {import('#section').Section} section`
+2. Avoid top-level `@typedef` imports like `@typedef {import('../validator/base-validator.js')} BaseValidator` - these can create confusion when the compiler auto-generates declarations
+3. Maintain `index.js` - if you're adding code that users of this module will import, ensure it is exported in `index.js`
 
 Thank you for your co-operation and contributions!
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "3.15.5",
+  "version": "3.16.0",
   "description": "This package is for building GDS forms using a configuration-based approach.",
   "main": "./src/index.js",
   "type": "module",
-  "types": "./types/src/index.d.ts",
+  "types": "./src/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Planning-Inspectorate/dynamic-forms.git"
@@ -17,7 +17,8 @@
     "lint": "npx eslint .",
     "format": "prettier --write .",
     "format-check": "prettier --check .",
-    "generate-types": "npx tsc --project tsconfig.json && node move-types.js",
+    "generate-types": "npx tsc --project tsconfig.json",
+    "reset-generated-types": "find . -name \"*.d.ts\" -not -path \"./typedefs/*\" -not -path \"./node_modules/*\" -delete && find . -name \"*.d.ts.map\" -not -path \"./node_modules/*\" -delete",
     "prepare": "node .husky/install.mjs",
     "test": "node --test",
     "test-coverage": "node --test --experimental-test-coverage"
@@ -30,7 +31,8 @@
     "nunjucks": "^3.2.4"
   },
   "imports": {
-    "#question-types": "./src/questions/question-types.d.ts",
+    "#question-types": "./typedefs/question-types.d.ts",
+    "#typedefs/*": "./typedefs/*",
     "#test/*": "./test/*",
     "#base-validator": "./src/validator/base-validator.js",
     "#journey": "./src/journey/journey.js",

package/{types/src → src}/components/address/question.d.ts

@@ -1,8 +1,8 @@
 export class AddressQuestion extends Question {
     /**
-     * @param {import('../../questions/question-props.d.ts').SiteAddressQuestionParams} params
+     * @param {import('#typedefs/question-props.d.ts').SiteAddressQuestionParams} params
      */
-    constructor(params: import("../../questions/question-props.d.ts").SiteAddressQuestionParams);
+    constructor(params: import("#typedefs/question-props.d.ts").SiteAddressQuestionParams);
     requiredFields: {
         addressLine1: boolean;
         addressLine2: boolean;
@@ -22,6 +22,10 @@ export class AddressQuestion extends Question {
      * @returns {*|string}
      */
     answerForViewModel(answers: Record<string, any>): any | string;
+    /**
+     * @param {import('#question').QuestionViewModel} viewModel
+     */
+    addCustomDataToViewModel(viewModel: import("#question").QuestionViewModel): void;
     /**
      * @param {Object<string, any>} answer
      * @returns The formatted address to be presented in the UI
@@ -29,6 +33,14 @@ export class AddressQuestion extends Question {
     format(answer: {
         [x: string]: any;
     }): string;
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     */
+    formatAnswerForSummary(sectionSegment: any, journey: any, answer: any): {
+        key: string;
+        value: string;
+        action: import("../../index.js").ActionView | import("../../index.js").ActionView[] | undefined;
+    }[];
     formatLabelFromRequiredFields(fieldName: any): "" | " (optional)";
 }
 export default AddressQuestion;

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAOA;IACC;;OAEG;IACH,oBAFW,OAAO,+BAA+B,EAAE,yBAAyB,EAqB3E;IAXE;;;;;;kBAA8C;IAIhD;;;;;;MAMC;IAiBF;;;OAGG;IACH,4BAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,GAAC,GAAC,MAAM,CAqBpB;IAED;;OAEG;IACH,oCAFW,OAAO,WAAW,EAAE,iBAAiB,QAI/C;IA8BD;;;OAGG;IACH;;eAUC;IAED;;OAEG;IACH;;;;QAgBC;IACD,kEAMC;CACD;;yBArJwB,WAAW"}

package/src/components/address/question.js

@@ -7,7 +7,7 @@ import AddressValidator from '../../validator/address-validator.js';
 
 export class AddressQuestion extends Question {
 	/**
-	 * @param {import('../../questions/question-props.d.ts').SiteAddressQuestionParams} params
+	 * @param {import('#typedefs/question-props.d.ts').SiteAddressQuestionParams} params
 	 */
 	constructor(params) {
 		super({
@@ -122,7 +122,6 @@ export class AddressQuestion extends Question {
 
 	/**
 	 * returns the formatted answers values to be used to build task list elements
-	 * @type {Question['formatAnswerForSummary']}
 	 */
 	formatAnswerForSummary(sectionSegment, journey, answer) {
 		let formattedAnswer = this.notStartedText;

package/{types/src → src}/components/boolean/question.d.ts

@@ -7,9 +7,9 @@ export function booleanToYesNoValue(value: any): "yes" | "no";
 export function booleanToYesNoOrNull(value: boolean | null): string | null;
 export class BooleanQuestion extends RadioQuestion {
     /**
-     * @param {import('../../questions/question-props.d.ts').BooleanQuestionParams} params
+     * @param {import('#typedefs/question-props.d.ts').BooleanQuestionParams} params
      */
-    constructor({ title, question, fieldName, url, hint, pageTitle, description, html, validators, interfaceType, options, editable, viewData }: import("../../questions/question-props.d.ts").BooleanQuestionParams);
+    constructor({ title, question, fieldName, url, hint, pageTitle, description, html, validators, interfaceType, options, editable, viewData }: import("#typedefs/question-props.d.ts").BooleanQuestionParams);
     interfaceType: "checkbox" | "radio";
     /**
      * Get the data to save from the request, returns an object of answers

package/src/components/boolean/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAEA;;;GAGG;AAMI,sCAHI,MAAM,GAAC,GAAC,GACN,OAAO,CAOnB;AAEM,8DAEN;AAMM,4CAHI,OAAO,GAAC,IAAI,GACV,MAAM,GAAC,IAAI,CAOvB;AAED;IACC;;OAEG;IACH,6IAFW,OAAO,+BAA+B,EAAE,qBAAqB,EAmDvE;IADA,oCAAkC;IAGnC;;;;;OAKG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,eAAe,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAezD;CACD;;0BA5GyB,sBAAsB"}

package/src/components/boolean/question.js

@@ -33,7 +33,7 @@ export const booleanToYesNoOrNull = (value) => {
 
 export class BooleanQuestion extends RadioQuestion {
 	/**
-	 * @param {import('../../questions/question-props.d.ts').BooleanQuestionParams} params
+	 * @param {import('#typedefs/question-props.d.ts').BooleanQuestionParams} params
 	 */
 	constructor({
 		title,

package/src/components/checkbox/question.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @typedef ConditionalAnswerObject
+ * @type {object}
+ * @property {string} value the checkbox answer
+ * @property {string} conditional the conditional text input
+ */
+export class CheckboxQuestion extends OptionsQuestion {
+    /**
+     * @param {import('#typedefs/question-props.d.ts').CheckboxQuestionParams} params
+     */
+    constructor({ title, question, fieldName, url, pageTitle, description, options, validators, viewData }: import("#typedefs/question-props.d.ts").CheckboxQuestionParams);
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     */
+    formatAnswerForSummary(sectionSegment: any, journey: any, answer: any): import("../../index.js").SummaryRow[];
+}
+export default CheckboxQuestion;
+export type ConditionalAnswerObject = {
+    /**
+     * the checkbox answer
+     */
+    value: string;
+    /**
+     * the conditional text input
+     */
+    conditional: string;
+};
+import OptionsQuestion from '../../questions/options-question.js';
+//# sourceMappingURL=question.d.ts.map

package/src/components/checkbox/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAKA;;;;;GAKG;AAEH;IACC;;OAEG;IACH,wGAFW,OAAO,+BAA+B,EAAE,sBAAsB,EAiBxE;IAED;;OAEG;IACH,8GAqCC;CACD;;;;;;WAlEa,MAAM;;;;iBACN,MAAM;;4BATQ,qCAAqC"}

package/src/components/checkbox/question.js

@@ -12,7 +12,7 @@ const defaultOptionJoinString = ',';
 
 export class CheckboxQuestion extends OptionsQuestion {
 	/**
-	 * @param {import('../../questions/question-props.d.ts').CheckboxQuestionParams} params
+	 * @param {import('#typedefs/question-props.d.ts').CheckboxQuestionParams} params
 	 */
 	constructor({ title, question, fieldName, url, pageTitle, description, options, validators, viewData }) {
 		super({
@@ -33,10 +33,6 @@ export class CheckboxQuestion extends OptionsQuestion {
 
 	/**
 	 * returns the formatted answers values to be used to build task list elements
-	 * @param {string | ConditionalAnswerObject } answer will be a single value string, a comma-separated string representing multiple values (one of which may be a conditional) or a single ConditionalAnswerObject
-	 * @param {import('#journey').Journey} journey
-	 * @param {String} sectionSegment
-	 * @returns {Array.<Object>}
 	 */
 	formatAnswerForSummary(sectionSegment, journey, answer) {
 		if (!answer) {

package/{types/src → src}/components/date/question.d.ts

@@ -3,9 +3,9 @@
  */
 export class DateQuestion extends Question {
     /**
-     * @param {import('../../questions/question-props.d.ts').DateQuestionParams} params
+     * @param {import('#typedefs/question-props.d.ts').DateQuestionParams} params
      */
-    constructor({ dateFormat, ...parentParams }: import("../../questions/question-props.d.ts").DateQuestionParams);
+    constructor({ dateFormat, ...parentParams }: import("#typedefs/question-props.d.ts").DateQuestionParams);
     dateFormat: string;
     /**
      * Get the data to save from the request, returns an object of answers
@@ -16,6 +16,14 @@ export class DateQuestion extends Question {
     answerForViewModel(answers: any, isPayload: any): {
         [x: string]: any;
     };
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     */
+    formatAnswerForSummary(sectionSegment: any, journey: any, answer: any): {
+        key: string;
+        value: string;
+        action: import("../../index.js").ActionView | import("../../index.js").ActionView[] | undefined;
+    }[];
 }
 export default DateQuestion;
 import { Question } from '../../questions/question.js';

package/src/components/date/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAKA;;GAEG;AACH;IACC;;OAEG;IACH,6CAFW,OAAO,+BAA+B,EAAE,kBAAkB,EAQpE;IADA,mBAA4B;IAW7B;;;;;OAKG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,OAAO,mBAAmB,EAAE,eAAe,GACzC,OAAO,CAAE,MAAM,CAAC,CAY5B;IAED;;MAwBC;IAED;;OAEG;IACH;;;;QAaC;CACD;;yBAxFwB,6BAA6B"}

package/src/components/date/question.js

@@ -8,7 +8,7 @@ const DEFAULT_DATE_FORMAT = 'd MMMM yyyy';
  */
 export class DateQuestion extends Question {
 	/**
-	 * @param {import('../../questions/question-props.d.ts').DateQuestionParams} params
+	 * @param {import('#typedefs/question-props.d.ts').DateQuestionParams} params
 	 */
 	constructor({ dateFormat = DEFAULT_DATE_FORMAT, ...parentParams }) {
 		super({
@@ -72,7 +72,6 @@ export class DateQuestion extends Question {
 
 	/**
 	 * returns the formatted answers values to be used to build task list elements
-	 * @type {Question['formatAnswerForSummary']}
 	 */
 	formatAnswerForSummary(sectionSegment, journey, answer) {
 		let formattedAnswer;

package/{types/src → src}/components/date-period/question.d.ts

@@ -4,9 +4,9 @@
  */
 export class DatePeriodQuestion extends Question {
     /**
-     * @param {import('../../questions/question-props.d.ts').DatePeriodQuestionParams} params
+     * @param {import('#typedefs/question-props.d.ts').DatePeriodQuestionParams} params
      */
-    constructor({ dateFormat, hint, labels, hintStart, startTime, hintEnd, endTime, ...parentParams }: import("../../questions/question-props.d.ts").DatePeriodQuestionParams);
+    constructor({ dateFormat, hint, labels, hintStart, startTime, hintEnd, endTime, ...parentParams }: import("#typedefs/question-props.d.ts").DatePeriodQuestionParams);
     dateFormat: string;
     labels: {
         start: string;
@@ -14,8 +14,8 @@ export class DatePeriodQuestion extends Question {
     };
     hintStart: string | undefined;
     hintEnd: string | undefined;
-    startTime: import("../../questions/question-props.d.ts").TimeComponents;
-    endTime: import("../../questions/question-props.d.ts").TimeComponents;
+    startTime: import("#typedefs/question-props.d.ts").TimeComponents;
+    endTime: import("#typedefs/question-props.d.ts").TimeComponents;
     /**
      * Get the data to save from the request, returns an object of answers
      * @param {import('express').Request} req
@@ -25,6 +25,18 @@ export class DatePeriodQuestion extends Question {
     answerForViewModel(answers: any, isPayload: any): {
         [x: string]: any;
     };
+    /**
+     * @param {import('#question').QuestionViewModel} viewModel
+     */
+    addCustomDataToViewModel(viewModel: import("#question").QuestionViewModel): void;
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     */
+    formatAnswerForSummary(sectionSegment: any, journey: any, answer: any): {
+        key: string;
+        value: string;
+        action: import("../../index.js").ActionView | import("../../index.js").ActionView[] | undefined;
+    }[];
 }
 export default DatePeriodQuestion;
 import { Question } from '#question';

package/src/components/date-period/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAOA;;;GAGG;AACH;IACC;;OAEG;IACH,mGAFW,OAAO,+BAA+B,EAAE,wBAAwB,EAuB1E;IAPA,mBAA4B;IAC5B;;;MAAsD;IAEtD,8BAA0B;IAC1B,4BAAsB;IACtB,kEAA+D;IAC/D,gEAA2D;IAkB5D;;;;;OAKG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,OAAO,mBAAmB,EAAE,eAAe,GACzC,OAAO,CAAE,MAAM,CAAC,CAgC5B;IAED;;MAuCC;IAED;;OAEG;IACH,oCAFW,OAAO,WAAW,EAAE,iBAAiB,QAM/C;IAED;;OAEG;IACH;;;;QAyBC;CACD;;yBAzKwB,WAAW"}

package/src/components/date-period/question.js

@@ -11,7 +11,7 @@ const DEFAULT_DATE_FORMAT = 'HH:mm d MMMM yyyy';
  */
 export class DatePeriodQuestion extends Question {
 	/**
-	 * @param {import('../../questions/question-props.d.ts').DatePeriodQuestionParams} params
+	 * @param {import('#typedefs/question-props.d.ts').DatePeriodQuestionParams} params
 	 */
 	constructor({
 		dateFormat = DEFAULT_DATE_FORMAT,
@@ -141,7 +141,6 @@ export class DatePeriodQuestion extends Question {
 
 	/**
 	 * returns the formatted answers values to be used to build task list elements
-	 * @type {Question['formatAnswerForSummary']}
 	 */
 	formatAnswerForSummary(sectionSegment, journey, answer) {
 		let formattedAnswer;

package/{types/src → src}/components/date-time/question.d.ts

@@ -2,9 +2,9 @@ export class DateTimeQuestion extends Question {
     static AM: string;
     static PM: string;
     /**
-     * @param {import('../../questions/question-props.d.ts').DateTimeQuestionParams} params
+     * @param {import('#typedefs/question-props.d.ts').DateTimeQuestionParams} params
      */
-    constructor({ dateFormat, timeFormat, ...parentParams }: import("../../questions/question-props.d.ts").DateTimeQuestionParams);
+    constructor({ dateFormat, timeFormat, ...parentParams }: import("#typedefs/question-props.d.ts").DateTimeQuestionParams);
     dateFormat: string;
     timeFormat: string;
     /**
@@ -16,6 +16,14 @@ export class DateTimeQuestion extends Question {
     answerForViewModel(answers: any, isPayload: any): {
         [x: string]: any;
     };
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     */
+    formatAnswerForSummary(sectionSegment: any, journey: any, answer: any): {
+        key: string;
+        value: string;
+        action: import("../../index.js").ActionView | import("../../index.js").ActionView[] | undefined;
+    }[];
     #private;
 }
 export default DateTimeQuestion;

package/src/components/date-time/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAMA;IACC,kBAAiB;IACjB,kBAAiB;IAEjB;;OAEG;IACH,yDAFW,OAAO,+BAA+B,EAAE,sBAAsB,EASxE;IAFA,mBAA4B;IAC5B,mBAA4B;IAkB7B;;;;;OAKG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,eAAe,GACb,OAAO,CAAE,MAAM,CAAC,CAqB5B;IAED;;MAqCC;IAED;;OAEG;IACH;;;;QAQC;;CAsBD;;yBAxIwB,6BAA6B"}

package/src/components/date-time/question.js

@@ -9,7 +9,7 @@ export class DateTimeQuestion extends Question {
 	static PM = 'pm';
 
 	/**
-	 * @param {import('../../questions/question-props.d.ts').DateTimeQuestionParams} params
+	 * @param {import('#typedefs/question-props.d.ts').DateTimeQuestionParams} params
 	 */
 	constructor({ dateFormat = DEFAULT_DATE_FORMAT, timeFormat = DEFAULT_TIME_FORMAT, ...parentParams }) {
 		super({
@@ -103,7 +103,6 @@ export class DateTimeQuestion extends Question {
 
 	/**
 	 * returns the formatted answers values to be used to build task list elements
-	 * @type {Question['formatAnswerForSummary']}
 	 */
 	formatAnswerForSummary(sectionSegment, journey, answer) {
 		return [

package/src/components/email/question.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Email input question that extends SingleLineInputQuestion
+ * Automatically sets the input type to "email" and adds appropriate attributes
+ * @class
+ */
+export class EmailQuestion extends SingleLineInputQuestion {
+    /**
+     * @param {import('#typedefs/question-props.d.ts').EmailQuestionParams} params
+     */
+    constructor(params: import("#typedefs/question-props.d.ts").EmailQuestionParams);
+    /**
+     * Override formatAnswerForSummary to prevent capitalization of email addresses
+     * Email addresses should remain in their original case (typically lowercase)
+     * @param {string} sectionSegment
+     * @param {import('#journey').Journey} journey
+     * @param {string} answer
+     * @returns {Array}
+     */
+    formatAnswerForSummary(sectionSegment: string, journey: import("#journey").Journey, answer: string): any[];
+}
+export default EmailQuestion;
+import SingleLineInputQuestion from '../single-line-input/question.js';
+//# sourceMappingURL=question.d.ts.map

package/src/components/email/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAEA;;;;GAIG;AACH;IACC;;OAEG;IACH,oBAFW,OAAO,+BAA+B,EAAE,mBAAmB,EAmBrE;IAED;;;;;;;OAOG;IACH,uCALW,MAAM,WACN,OAAO,UAAU,EAAE,OAAO,UAC1B,MAAM,SAMhB;CACD;;oCA1CmC,kCAAkC"}

package/src/components/email/question.js

@@ -1,13 +1,5 @@
 import SingleLineInputQuestion from '../single-line-input/question.js';
 
-/**
- * @typedef {import('#question').QuestionViewModel} QuestionViewModel
- * @typedef {import('#journey').Journey} Journey
- * @typedef {import('#journey-response').JourneyResponse} JourneyResponse
- * @typedef {import('../../section').Section} Section
- * @typedef {import('../../validator/base-validator')} BaseValidator
- */
-
 /**
  * Email input question that extends SingleLineInputQuestion
  * Automatically sets the input type to "email" and adds appropriate attributes
@@ -15,7 +7,7 @@ import SingleLineInputQuestion from '../single-line-input/question.js';
  */
 export class EmailQuestion extends SingleLineInputQuestion {
 	/**
-	 * @param {import('../../questions/question-props.d.ts').EmailQuestionParams} params
+	 * @param {import('#typedefs/question-props.d.ts').EmailQuestionParams} params
 	 */
 	constructor(params) {
 		// Set default input attributes for email

package/src/components/manage-list/manage-list-actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manage-list-actions.d.ts","sourceRoot":"","sources":["manage-list-actions.js"],"names":[],"mappings":"AAAA;;;GAGG;AACH,kCAFU,QAAQ,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAAC,CAM5D"}

package/src/components/manage-list/manage-list-section.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manage-list-section.d.ts","sourceRoot":"","sources":["manage-list-section.js"],"names":[],"mappings":"AAEA;;GAEG;AACH;IACC,cAEC;IAED;;;;;;OAMG;IACH,2BAFa,OAAO,CAInB;IAED;;;;;OAKG;IACH,sBAJW,OAAO,6BAA6B,EAAE,QAAQ,sBAC9C,OAAO,0BAA0B,EAAE,iBAAiB,GAClD,IAAI,CAYhB;CACD;wBAtCuB,kBAAkB"}

package/{types/src → src}/components/manage-list/question.d.ts

@@ -7,19 +7,26 @@
  */
 export class ManageListQuestion extends Question {
     /**
-     * @param {import('../../questions/question-props.d.ts').ManageListQuestionParams} params
+     * @param {import('#typedefs/question-props.d.ts').ManageListQuestionParams} params
      */
-    constructor(params: import("../../questions/question-props.d.ts").ManageListQuestionParams);
+    constructor(params: import("#typedefs/question-props.d.ts").ManageListQuestionParams);
     get confirmationQuestionParam(): string;
+    /**
+     * @param {import('#question').QuestionViewModel} viewModel
+     */
+    addCustomDataToViewModel(viewModel: import("#question").QuestionViewModel): void;
     getDataToSave(req: any, journeyResponse: any): Promise<{
         answers: {
             [x: string]: any;
         };
     }>;
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     */
     formatAnswerForSummary(sectionSegment: any, journey: any, answer: any): {
         key: string;
         value: string;
-        action: import("../../controller.js").ActionView | import("../../controller.js").ActionView[] | undefined;
+        action: import("../../index.js").ActionView | import("../../index.js").ActionView[] | undefined;
     }[];
     renderConfirmationAction(res: any, itemToRemove: any, viewModel: any): void;
     set section(section: import("../../section.js").Section);

package/src/components/manage-list/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAKA;;;;;;GAMG;AAEH;IAOC;;OAEG;IACH,oBAFW,OAAO,+BAA+B,EAAE,wBAAwB,EAe1E;IAcD,wCAEC;IAED;;OAEG;IACH,oCAFW,OAAO,WAAW,EAAE,iBAAiB,QAmB/C;IAmCD;;;;OAMC;IAED;;OAEG;IACH;;;;QAsBC;IAED,4EAQC;IAoCD,yDAEC;IATD,kDAKC;;CAKD;;;;;;mBAxLa,MAAM;;;;;;;;;;;;;;yBAPK,WAAW"}

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

@@ -19,7 +19,7 @@ export class ManageListQuestion extends Question {
 	#confirmationQuestionParam;
 
 	/**
-	 * @param {import('../../questions/question-props.d.ts').ManageListQuestionParams} params
+	 * @param {import('#typedefs/question-props.d.ts').ManageListQuestionParams} params
 	 */
 	constructor(params) {
 		super({
@@ -115,6 +115,9 @@ export class ManageListQuestion extends Question {
 		};
 	}
 
+	/**
+	 * returns the formatted answers values to be used to build task list elements
+	 */
 	formatAnswerForSummary(sectionSegment, journey, answer) {
 		let formattedAnswer = this.notStartedText;
 		if (answer && Array.isArray(answer)) {

package/{types/src → src}/components/manage-list/utils.d.ts

@@ -11,8 +11,8 @@ export function answerObjectForManageList(response: import("../../journey/journe
  *
  * @param {import('../../journey/journey-response.js').JourneyResponse} response
  * @param {import('./question.js')} manageListQuestion
- * @param {import('../../journey/journey-types.js').RouteParams} params
- * @returns {import('../../journey/journey-types.js').ManageListAnswers}
+ * @param {import('#typedefs/journey-types.d.ts').RouteParams} params
+ * @returns {import('#typedefs/journey-types.d.ts').ManageListAnswers}
  */
-export function answerObjectForManageListSaving(response: import("../../journey/journey-response.js").JourneyResponse, manageListQuestion: typeof import("./question.js"), params: import("../../journey/journey-types.js").RouteParams): import("../../journey/journey-types.js").ManageListAnswers;
+export function answerObjectForManageListSaving(response: import("../../journey/journey-response.js").JourneyResponse, manageListQuestion: typeof import("./question.js"), params: import("#typedefs/journey-types.d.ts").RouteParams): import("#typedefs/journey-types.d.ts").ManageListAnswers;
 //# sourceMappingURL=utils.d.ts.map

package/src/components/manage-list/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,oDALW,OAAO,mCAAmC,EAAE,eAAe,wEAE3D,MAAM,GACJ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAQnC;AAED;;;;;;;GAOG;AACH,0DALW,OAAO,mCAAmC,EAAE,eAAe,8DAE3D,OAAO,8BAA8B,EAAE,WAAW,GAChD,OAAO,8BAA8B,EAAE,iBAAiB,CAapE"}

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

@@ -18,8 +18,8 @@ export function answerObjectForManageList(response, manageListQuestion, manageLi
  *
  * @param {import('../../journey/journey-response.js').JourneyResponse} response
  * @param {import('./question.js')} manageListQuestion
- * @param {import('../../journey/journey-types.js').RouteParams} params
- * @returns {import('../../journey/journey-types.js').ManageListAnswers}
+ * @param {import('#typedefs/journey-types.d.ts').RouteParams} params
+ * @returns {import('#typedefs/journey-types.d.ts').ManageListAnswers}
  */
 export function answerObjectForManageListSaving(response, manageListQuestion, params) {
 	const answersList =

package/src/components/multi-field-input/question.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @class
+ */
+export class MultiFieldInputQuestion extends Question {
+    /**
+     * @param {import('#typedefs/question-props.d.ts').MultiFieldInputQuestionParams} params
+     */
+    constructor({ inputFields, ...parentParams }: import("#typedefs/question-props.d.ts").MultiFieldInputQuestionParams);
+    inputFields: import("#typedefs/question-props.d.ts").InputField[];
+    answerForViewModel(answers: any): {
+        value: string;
+        fieldName: string;
+        label: string;
+        formatJoinString?: string;
+        formatPrefix?: string;
+        formatTextFunction?: (text: string) => string;
+        attributes?: Record<string, string>;
+        suffix?: import("#typedefs/question-props.d.ts").Affix;
+        prefix?: import("#typedefs/question-props.d.ts").Affix;
+        hint?: string;
+        classes?: string;
+        inputmode?: "decimal" | "numeric";
+        pattern?: string;
+    }[];
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     * @param {import('#journey').Journey} journey
+     * @param {string} sectionSegment
+     * @returns {Array<{
+     *   key: string;
+     *   value: string | Object;
+     *   action: {
+     *     href: string;
+     *     text: string;
+     *     visuallyHiddenText: string;
+     *   };
+     * }>}
+     */
+    formatAnswerForSummary(sectionSegment: string, journey: import("#journey").Journey): Array<{
+        key: string;
+        value: string | Object;
+        action: {
+            href: string;
+            text: string;
+            visuallyHiddenText: string;
+        };
+    }>;
+    #private;
+}
+export default MultiFieldInputQuestion;
+import { Question } from '#question';
+//# sourceMappingURL=question.d.ts.map

package/src/components/multi-field-input/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAIA;;GAEG;AACH;IACC;;OAEG;IACH,8CAFW,OAAO,+BAA+B,EAAE,6BAA6B,EAa/E;IAJC,kEAA8B;IAchC;;;;;;;;;;;;;;QAOC;IAsBD;;;;;;;;;;;;;OAaG;IACH,uCAXW,MAAM,WADN,OAAO,UAAU,EAAE,OAAO,GAExB,KAAK,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,kBAAkB,EAAE,MAAM,CAAC;SAC5B,CAAC;KACH,CAAC,CAkBJ;;CAyBD;;yBApHwB,WAAW"}

package/src/components/multi-field-input/question.js

@@ -2,20 +2,12 @@ import { Question } from '#question';
 import escape from 'escape-html';
 import { nl2br } from '../../lib/utils.js';
 
-/**
- * @typedef {import('#question').QuestionViewModel} QuestionViewModel
- * @typedef {import('#journey').Journey} Journey
- * @typedef {import('#journey-response').JourneyResponse} JourneyResponse
- * @typedef {import('../../section').Section} Section
- * @typedef {import('../../validator/base-validator')} BaseValidator
- */
-
 /**
  * @class
  */
 export class MultiFieldInputQuestion extends Question {
 	/**
-	 * @param {import('../../questions/question-props.d.ts').MultiFieldInputQuestionParams} params
+	 * @param {import('#typedefs/question-props.d.ts').MultiFieldInputQuestionParams} params
 	 */
 	constructor({ inputFields, ...parentParams }) {
 		super({
@@ -50,7 +42,7 @@ export class MultiFieldInputQuestion extends Question {
 	/**
 	 * Get the data to save from the request, returns an object of answers
 	 * @param {import('express').Request} req
-	 * @param {JourneyResponse} journeyResponse - current journey response, modified with the new answers
+	 * @param {import('#journey-response').JourneyResponse} journeyResponse - current journey response, modified with the new answers
 	 * @returns {Promise<{ answers: Record<string, unknown> }>}
 	 */ //eslint-disable-next-line no-unused-vars -- journeyResponse kept for other questions to use
 	async getDataToSave(req, journeyResponse) {
@@ -69,8 +61,8 @@ export class MultiFieldInputQuestion extends Question {
 
 	/**
 	 * returns the formatted answers values to be used to build task list elements
-	 * @param {Journey} journey
-	 * @param {String} sectionSegment
+	 * @param {import('#journey').Journey} journey
+	 * @param {string} sectionSegment
 	 * @returns {Array<{
 	 *   key: string;
 	 *   value: string | Object;
@@ -101,7 +93,7 @@ export class MultiFieldInputQuestion extends Question {
 
 	/**
 	 * checks whether any answers have been provided for input field questions
-	 * @param {Journey} journey
+	 * @param {import('#journey').Journey} journey
 	 * @returns {boolean}
 	 */
 	#allQuestionsUnanswered(journey) {