@planning-inspectorate/dynamic-forms 3.15.5 → 3.16.0

package/src/journey/journey.js

@@ -131,7 +131,7 @@ export class Journey {
 
 	/**
 	 * utility function to build up a url to a question
-	 * @param {import('./journey-types.js').RouteParams} params
+	 * @param {import('#typedefs/journey-types.d.ts').RouteParams} params
 	 * @returns {string} url for a question
 	 */
 	#buildQuestionUrl(params) {
@@ -183,7 +183,7 @@ export class Journey {
 
 	/**
 	 * gets a question from the object's sections based on a section + question names
-	 * @param {import('./journey-types.js').RouteParams} params
+	 * @param {import('#typedefs/journey-types.d.ts').RouteParams} params
 	 * @returns {import('../questions/question.js').Question | undefined} question found by lookup
 	 */
 	getQuestionByParams(params) {
@@ -207,7 +207,7 @@ export class Journey {
 	 * Get the back link for the journey - e.g. the previous question
 	 *
 	 * @param {Object} options
-	 * @param {import('./journey-types.js').RouteParams} options.params
+	 * @param {import('#typedefs/journey-types.d.ts').RouteParams} options.params
 	 * @param {import('#src/components/manage-list/question.js')} [options.manageListQuestion]
 	 * @returns {string|null} url for the next question, or null if unmatched
 	 */
@@ -227,7 +227,7 @@ export class Journey {
 	 * Used after question post/saving
 	 *
 	 * @param {import('express').Response} res
-	 * @param {import('./journey-types.js').RouteParams} params
+	 * @param {import('#typedefs/journey-types.d.ts').RouteParams} params
 	 * @param {import('#src/components/manage-list/question.js')} [manageListQuestion]
 	 * @returns {void}
 	 */
@@ -239,7 +239,7 @@ export class Journey {
 	/**
 	 * Get url for the next question in the journey
 	 *
-	 * @param {import('./journey-types.js').RouteParams} params
+	 * @param {import('#typedefs/journey-types.d.ts').RouteParams} params
 	 * @param {Object} options
 	 * @param {boolean} [options.reverse] - if passed in this will get the previous question
 	 * @param {import('#src/components/manage-list/question.js')} [options.manageListQuestion]
@@ -293,7 +293,7 @@ export class Journey {
 					 * don't include other params which may be set (e.g. manageList* params), as we may now be
 					 * redirecting to a non-manage list question, having previously been on a manage list question
 					 *
-					 * @type {import('./journey-types.js').RouteParams}
+					 * @type {import('#typedefs/journey-types.d.ts').RouteParams}
 					 */
 					let newParams = {
 						section: currentSection.segment,

package/src/lib/address-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"address-utils.d.ts","sourceRoot":"","sources":["address-utils.js"],"names":[],"mappings":"AAAA;;;GAGG;AACH,kDAFa,MAAM,CAKlB"}

package/src/lib/address.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.d.ts","sourceRoot":"","sources":["address.js"],"names":[],"mappings":"AAAA;;;GAGG;AACH;IA0BC;;;;;;;;OAQG;IACH,wEANG;QAAuB,YAAY,EAA3B,MAAM;QACS,YAAY,EAA3B,MAAM;QACS,QAAQ,EAAvB,MAAM;QACS,MAAM,EAArB,MAAM;QACS,QAAQ,EAAvB,MAAM;KAChB,EAOA;IAxCD;;OAEG;IACH,cAFU,MAAM,CAEH;IAEb;;OAEG;IACH,cAFU,MAAM,CAEH;IAEb;;OAEG;IACH,UAFU,MAAM,CAEP;IAET;;OAEG;IACH,QAFU,MAAM,CAET;IAEP;;OAEG;IACH,UAFU,MAAM,CAEP;CAkBT"}

package/src/lib/date-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-utils.d.ts","sourceRoot":"","sources":["date-utils.js"],"names":[],"mappings":"AAKA;;;;;;GAMG;AACH,4CALW,IAAI,GAAC,MAAM,eAEnB;IAAyB,MAAM;CAC/B,GAAU,MAAM,CAMlB;AAED;;;;;;;;;GASG;AAEH;;;;GAIG;AACH,2EAHW,cAAc,GACZ,IAAI,CAMhB;AAED;;GAEG;AACH,mCAWC;AAED;;GAEG;AACH,iCAWC;AAqCD;;;;;GAKG;AACH,4CAJW,IAAI,WACJ,IAAI,GACF,OAAO,CASnB;AAED;;;;GAIG;AACH,+CAHW,IAAI,GACF,OAAO,CASnB;AA/CM,uCAHI,IAAI,GACF,OAAO,CAInB;AAMM,wCAHI,IAAI,GACF,OAAO,CAInB;AAMM,kCAHI,IAAI,GACF,OAAO,CAInB;;UArFa,MAAM;WACN,MAAM;SACN,MAAM"}

package/src/lib/session-answer-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-answer-store.d.ts","sourceRoot":"","sources":["session-answer-store.js"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,sDAJG;IAAsB,QAAQ;CAE9B,GAAU,OAAO,kBAAkB,EAAE,UAAU,CA8CjD;AASD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,gFANG;IAA0C,GAAG,EAArC,OAAO,SAAS,EAAE,OAAO;IACV,SAAS,EAAxB,MAAM;IACuB,WAAW;;;IACxB,QAAQ;CAChC,GAAU,IAAI,CAkBhB;AAED;;;;;;GAMG;AACH,8DAJW,MAAM,aACN,MAAM,GACJ,OAAO,SAAS,EAAE,OAAO,CA2BrC;AA/ED;;;;GAIG;AACH,gCAFU,OAAO,kBAAkB,EAAE,UAAU,CAEW"}

package/src/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,8BAHW,MAAM,GACJ,MAAM,CAMlB;AAED;;;GAGG;AACH,gCAHW,MAAM,GAAC,GAAG,GACR,MAAM,CAKlB;AAED;;;;;GAKG;AACH,wCAHW,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;GAKG;AACH,wBAFa,CAAC,SADH,CAAC,GAAC,CAAC,EAAE,OAKf"}

package/src/lib/uuid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["uuid.js"],"names":[],"mappings":"AAEA;;GAEG;AACH;IACC,yEAEC;CACD"}

package/src/middleware/build-get-journey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-get-journey.d.ts","sourceRoot":"","sources":["build-get-journey.js"],"names":[],"mappings":"AAAA;;;GAGG;AACH,+CAHW,CAAC,GAAG,EAAE,OAAO,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,gCAAgC,EAAE,eAAe,KAAK,OAAO,uBAAuB,EAAE,OAAO,GACpJ,OAAO,SAAS,EAAE,OAAO,CAgBrC"}

package/src/middleware/redirect-to-unanswered-question.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @typedef {function(import('../questions/question.js').Question, import('#journey-response').JourneyResponse): boolean} ShouldDisplayCondition
+ */
+/**
+ * Redirects to the first unanswered question in a journey, or to the task list if complete
+ *
+ * @param {ShouldDisplayCondition[]} [conditions]
+ * @returns {import('express').Handler}
+ */
+export function redirectToUnansweredQuestion(conditions?: ShouldDisplayCondition[]): import("express").Handler;
+export type ShouldDisplayCondition = (arg0: import("../questions/question.js").Question, arg1: import("#journey-response").JourneyResponse) => boolean;
+//# sourceMappingURL=redirect-to-unanswered-question.d.ts.map

package/src/middleware/redirect-to-unanswered-question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirect-to-unanswered-question.d.ts","sourceRoot":"","sources":["redirect-to-unanswered-question.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AACH,0DAHW,sBAAsB,EAAE,GACtB,OAAO,SAAS,EAAE,OAAO,CA8BrC;qCArCY,CAAS,IAA2C,EAA3C,OAAO,0BAA0B,EAAE,QAAQ,EAAE,IAA2C,EAA3C,OAAO,mBAAmB,EAAE,eAAe,KAAG,OAAO"}

package/src/middleware/redirect-to-unanswered-question.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {function(import('../section').Question, import('../journey/journey-response').JourneyResponse): boolean} ShouldDisplayCondition
+ * @typedef {function(import('../questions/question.js').Question, import('#journey-response').JourneyResponse): boolean} ShouldDisplayCondition
  */
 
 /**

package/src/questions/create-questions.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @template {string} K Question keys in questionPropsRecord
+ * @template {import('#typedefs/question-props.d.ts').BaseQuestionProps} T
+ * @param {{[questionName in K]: T}} questionPropsRecord
+ * @param {Record<string, import('#typedefs/question-types.d.ts').QuestionClass>} questionClasses
+ * @param {{[questionType: string]: Record<string, Function>}} questionMethodOverrides
+ * @param {{notStartedText?: string, continueButtonText?: string, changeActionText?: string, answerActionText?: string}} [textOverrides] - customise question text
+ * @returns {{[questionName in K]: InstanceType<import('#typedefs/question-types.d.ts').QuestionClass>}} Returns the same question keys that were passed in with each value being an instantiated question
+ */
+export function createQuestions<K extends string, T extends import("#typedefs/question-props.d.ts").BaseQuestionProps>(questionPropsRecord: { [questionName in K]: T; }, questionClasses: Record<string, import("#typedefs/question-types.d.ts").QuestionClass>, questionMethodOverrides: {
+    [questionType: string]: Record<string, Function>;
+}, textOverrides?: {
+    notStartedText?: string;
+    continueButtonText?: string;
+    changeActionText?: string;
+    answerActionText?: string;
+}): { [questionName in K]: InstanceType<import("#typedefs/question-types.d.ts").QuestionClass>; };
+//# sourceMappingURL=create-questions.d.ts.map

package/src/questions/create-questions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-questions.d.ts","sourceRoot":"","sources":["create-questions.js"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,gCARsB,CAAC,SAAV,MAAQ,EACoD,CAAC,SAA7D,OAAQ,+BAA+B,EAAE,iBAAkB,uBAC7D,GAAE,YAAY,IAAI,CAAC,GAAG,CAAC,GAAC,mBACxB,MAAM,CAAC,MAAM,EAAE,OAAO,+BAA+B,EAAE,aAAa,CAAC,2BACrE;IAAC,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,WAAW,CAAA;CAAC,kBAClD;IAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAAC,GAC1G,GAAE,YAAY,IAAI,CAAC,GAAG,YAAY,CAAC,OAAO,+BAA+B,EAAE,aAAa,CAAC,GAAC,CAwBtG"}

package/src/questions/create-questions.js

@@ -1,10 +1,11 @@
 /**
- * @template {import('./question-props.js').BaseQuestionProps} T
- * @param {{[questionName: string]: T}} questionPropsRecord
- * @param {Record<string, import('./question-types.js').QuestionClass>} questionClasses
+ * @template {string} K Question keys in questionPropsRecord
+ * @template {import('#typedefs/question-props.d.ts').BaseQuestionProps} T
+ * @param {{[questionName in K]: T}} questionPropsRecord
+ * @param {Record<string, import('#typedefs/question-types.d.ts').QuestionClass>} questionClasses
  * @param {{[questionType: string]: Record<string, Function>}} questionMethodOverrides
  * @param {{notStartedText?: string, continueButtonText?: string, changeActionText?: string, answerActionText?: string}} [textOverrides] - customise question text
- * @returns {Record<string, InstanceType<import('./question-types.js').QuestionClass>>}
+ * @returns {{[questionName in K]: InstanceType<import('#typedefs/question-types.d.ts').QuestionClass>}} Returns the same question keys that were passed in with each value being an instantiated question
  */
 export function createQuestions(questionPropsRecord, questionClasses, questionMethodOverrides, textOverrides) {
 	return Object.fromEntries(

package/{types/src → src}/questions/options-question.d.ts

@@ -22,10 +22,10 @@
  *}} Option
  */
 /**
- * @typedef {import('./question').QuestionViewModel & { question: { options: Option[] } }} OptionsViewModel
+ * @typedef {import('./question.js').QuestionViewModel & { question: { options: Option[] } }} OptionsViewModel
  */
 /**
- * @typedef {import('#question-types').QuestionParameters & { options: Array<Option> }} OptionsQuestionParameters
+ * @typedef {import('#typedefs/question-types.d.ts').QuestionParameters & { options: Array<Option> }} OptionsQuestionParameters
  */
 export class OptionsQuestion extends Question {
     /**
@@ -41,10 +41,10 @@ export class OptionsQuestion extends Question {
      * @param {import('#journey').Journey} journey - the journey we are in
      * @param {Record<string, unknown>} [customViewData] additional data to send to view
      * @param {Record<string, unknown>} [payload]
-     * @param {import('#question-types').PrepQuestionForRenderingOptions} options
-     * @returns {import('./question').QuestionViewModel} QuestionViewModel
+     * @param {import('#typedefs/question-types.d.ts').PrepQuestionForRenderingOptions} options
+     * @returns {import('./question.js').QuestionViewModel} QuestionViewModel
      */
-    prepQuestionForRendering(section: import("#section").Section, journey: import("#journey").Journey, customViewData?: Record<string, unknown>, payload?: Record<string, unknown>, options: import("#question-types").PrepQuestionForRenderingOptions): any;
+    prepQuestionForRendering(section: import("#section").Section, journey: import("#journey").Journey, customViewData?: Record<string, unknown>, payload?: Record<string, unknown>, options: import("#typedefs/question-types.d.ts").PrepQuestionForRenderingOptions): import("./question.js").QuestionViewModel;
 }
 export default OptionsQuestion;
 export type Option = {
@@ -68,12 +68,12 @@ export type Option = {
         html: string;
     };
 };
-export type OptionsViewModel = any & {
+export type OptionsViewModel = import("./question.js").QuestionViewModel & {
     question: {
         options: Option[];
     };
 };
-export type OptionsQuestionParameters = import("#question-types").QuestionParameters & {
+export type OptionsQuestionParameters = import("#typedefs/question-types.d.ts").QuestionParameters & {
     options: Array<Option>;
 };
 import { Question } from './question.js';

package/src/questions/options-question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options-question.d.ts","sourceRoot":"","sources":["options-question.js"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;GAEG;AACH;;GAEG;AAEH;IAIC;;OAEG;IACH,oBAFW,yBAAyB,EAenC;IAnBD,4BAA4B;IAC5B,SADW,KAAK,CAAC,MAAM,CAAC,CAChB;IAiBP,yBAA+C;IAGhD;;;;;;;;OAQG;IACH,kCAPW,OAAO,UAAU,EAAE,OAAO,WAC1B,OAAO,UAAU,EAAE,OAAO,mBAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACvB,OAAO,+BAA+B,EAAE,+BAA+B,GACrE,OAAO,eAAe,EAAE,iBAAiB,CAkDrD;CAmCD;;qBAhJY;IACR,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,WAAW,CAAC,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,OAAO,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;KAClB,CAAC;IACA,eAAe,CAAC,EAAE;QAChB,IAAI,EAAE,MAAM,CAAC;KAChB,CAAA;CACH;+BAIU,OAAO,eAAe,EAAE,iBAAiB,GAAG;IAAE,QAAQ,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;CAAE;wCAG/E,OAAO,+BAA+B,EAAE,kBAAkB,GAAG;IAAE,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CAAE;yBAnC3E,eAAe"}

package/src/questions/options-question.js

@@ -31,10 +31,10 @@ const defaultOptionJoinString = ',';
  */
 
 /**
- * @typedef {import('./question').QuestionViewModel & { question: { options: Option[] } }} OptionsViewModel
+ * @typedef {import('./question.js').QuestionViewModel & { question: { options: Option[] } }} OptionsViewModel
  */
 /**
- * @typedef {import('#question-types').QuestionParameters & { options: Array<Option> }} OptionsQuestionParameters
+ * @typedef {import('#typedefs/question-types.d.ts').QuestionParameters & { options: Array<Option> }} OptionsQuestionParameters
  */
 
 export class OptionsQuestion extends Question {
@@ -65,8 +65,8 @@ export class OptionsQuestion extends Question {
 	 * @param {import('#journey').Journey} journey - the journey we are in
 	 * @param {Record<string, unknown>} [customViewData] additional data to send to view
 	 * @param {Record<string, unknown>} [payload]
-	 * @param {import('#question-types').PrepQuestionForRenderingOptions} options
-	 * @returns {import('./question').QuestionViewModel} QuestionViewModel
+	 * @param {import('#typedefs/question-types.d.ts').PrepQuestionForRenderingOptions} options
+	 * @returns {import('./question.js').QuestionViewModel} QuestionViewModel
 	 */
 	prepQuestionForRendering(section, journey, customViewData, payload, options) {
 		const viewModel = super.prepQuestionForRendering(section, journey, customViewData, payload, options);

package/{types/src → src}/questions/question.d.ts

@@ -1,39 +1,13 @@
-/**
- * @import {BaseValidator} from "#base-validator"
- * @import {ActionView} from "../controller.js"
- * @import {ActionLink} from "./question-types.js"
- */
-/**
- * @typedef {Object} PreppedQuestion
- * @property {Object} value
- * @property {string} question
- * @property {string} fieldName
- * @property {string} pageTitle
- * @property {string} [description]
- * @property {string} [html]
- */
-/**
- * @typedef {Record<string, any>} QuestionViewModel
- * @property {PreppedQuestion} question
- * @property {string} layoutTemplate
- * @property {string} pageCaption
- * @property {string} [continueButtonText]
- * @property {string} backLink
- * @property {boolean} showBackToListLink
- * @property {string} listLink
- * @property {Object} util
- * @property {function(string): string} util.trimTrailingSlash
- */
 /**
  * A specific question within a journey which is made up of one (usually) or many (sometimes) components and their required content.
  * @class
  */
 export class Question {
     /**
-     * @param {import('./question-types.js').QuestionParameters} params
+     * @param {import('#typedefs/question-types.d.ts').QuestionParameters} params
      * @param {Record<string, Function>} [methodOverrides]
      */
-    constructor({ title, question, viewFolder, fieldName, url, pageTitle, description, validators, html, hint, interfaceType, shouldDisplay, autocomplete, editable, actionLink, viewData }: import("./question-types.js").QuestionParameters, methodOverrides?: Record<string, Function>);
+    constructor({ title, question, viewFolder, fieldName, url, pageTitle, description, validators, html, hint, interfaceType, shouldDisplay, autocomplete, editable, actionLink, viewData }: import("#typedefs/question-types.d.ts").QuestionParameters, methodOverrides?: Record<string, Function>);
     /** @type {string} - html page title, defaults to question if not provided */
     pageTitle: string;
     /** @type {string} - title used in the summary list */
@@ -48,8 +22,8 @@ export class Question {
     fieldName: string;
     /** @type {boolean} if the question should appear in the journey overview task list or not */
     taskList: boolean;
-    /** @type {Array.<BaseValidator>} array of validators that a question uses to validate answers */
-    validators: Array<BaseValidator>;
+    /** @type {Array.<import('../validator/base-validator.js').BaseValidator>} array of validators that a question uses to validate answers */
+    validators: Array<import("../validator/base-validator.js").BaseValidator>;
     /** @type {string|undefined} hint text displayed to user */
     hint: string | undefined;
     /** @type {boolean} show return to listing page link after question */
@@ -60,8 +34,8 @@ export class Question {
     html: string | undefined;
     /** @type {string|undefined} optional question type */
     interfaceType: string | undefined;
-    /** @type {ActionLink|undefined} override action link */
-    actionLink: ActionLink | undefined;
+    /** @type {import('#typedefs/question-types.d.ts').ActionLink|undefined} override action link */
+    actionLink: import("#typedefs/question-types.d.ts").ActionLink | undefined;
     /** @type {string} 'not started' text to display (if a question has no answer) */
     notStartedText: string;
     /** @type {string} button text to display */
@@ -76,7 +50,7 @@ export class Question {
      * @param {import('../journey/journey-response.js').JourneyResponse} [response]
      * @returns {boolean}
      */
-    shouldDisplay: () => boolean;
+    shouldDisplay: (response?: import("../journey/journey-response.js").JourneyResponse) => boolean;
     details: {
         title: string;
         text: string;
@@ -93,8 +67,8 @@ export class Question {
     editable: boolean;
     viewData: {
         [key: string]: any;
-        extraActionButtons?: import("./question-types.js").SecondaryAction[];
-        secondaryActions?: import("./question-types.js").SecondaryAction[];
+        extraActionButtons?: import("#typedefs/question-types.d.ts").SecondaryAction[];
+        secondaryActions?: import("#typedefs/question-types.d.ts").SecondaryAction[];
     };
     /**
      * Is this question a manage list question?
@@ -126,22 +100,22 @@ export class Question {
      * that prepQuestionForRendering doesn't need
      *
      * @param {Object} options
-     * @param {import('../journey/journey-types.js').RouteParams} options.params
+     * @param {import('#typedefs/journey-types.d.ts').RouteParams} options.params
      * @param {import('../components/manage-list/question.js')} [options.manageListQuestion]
      * @param {import('../section.js').Section} options.section - the current section
      * @param {import('../journey/journey.js').Journey} options.journey - the journey we are in
      * @param {Record<string, unknown>} [options.customViewData] additional data to send to view
      * @param {unknown} [options.payload]
-     * @returns {QuestionViewModel}
+     * @returns {import('#typedefs/question-types.d.ts').QuestionViewModel}
      */
     toViewModel({ params, manageListQuestion, section, journey, customViewData, payload }: {
-        params: import("../journey/journey-types.js").RouteParams;
+        params: import("#typedefs/journey-types.d.ts").RouteParams;
         manageListQuestion?: typeof import("../components/manage-list/question.js") | undefined;
         section: import("../section.js").Section;
         journey: import("../journey/journey.js").Journey;
         customViewData?: Record<string, unknown> | undefined;
         payload?: unknown;
-    }): QuestionViewModel;
+    }): import("#typedefs/question-types.d.ts").QuestionViewModel;
     /**
      * gets the base view model for this question
      *
@@ -149,10 +123,10 @@ export class Question {
      * @param {import('../journey/journey.js').Journey} journey - the journey we are in
      * @param {Record<string, unknown>} [customViewData] additional data to send to view
      * @param {unknown} [payload]
-     * @param {import('./question-types.js').PrepQuestionForRenderingOptions} [options] - required to support manage list question
-     * @returns {QuestionViewModel}
+     * @param {import('#typedefs/question-types.d.ts').PrepQuestionForRenderingOptions} [options] - required to support manage list question
+     * @returns {import('#typedefs/question-types.d.ts').QuestionViewModel}
      */
-    prepQuestionForRendering(section: import("../section.js").Section, journey: import("../journey/journey.js").Journey, customViewData?: Record<string, unknown>, payload?: unknown, options?: import("./question-types.js").PrepQuestionForRenderingOptions): QuestionViewModel;
+    prepQuestionForRendering(section: import("../section.js").Section, journey: import("../journey/journey.js").Journey, customViewData?: Record<string, unknown>, payload?: unknown, options?: import("#typedefs/question-types.d.ts").PrepQuestionForRenderingOptions): import("#typedefs/question-types.d.ts").QuestionViewModel;
     /**
      * The answer to this question for use in the viewModel
      *
@@ -167,32 +141,32 @@ export class Question {
      *
      * If possible override this method instead of prepQuestionForRendering for simple changes to the view model
      *
-     * @param {QuestionViewModel} viewModel
-     */ addCustomDataToViewModel(viewModel: QuestionViewModel): void;
+     * @param {import('#typedefs/question-types.d.ts').QuestionViewModel} viewModel
+     */ addCustomDataToViewModel(viewModel: import("#typedefs/question-types.d.ts").QuestionViewModel): void;
     /**
      * Get the answers object from the journey response, which may be nested in an array for manage list questions
      *
      * @param {import('../journey/journey-response.js').JourneyResponse} response
-     * @param {import('./question-types.js').PrepQuestionForRenderingOptions} [options]
+     * @param {import('#typedefs/question-types.d.ts').PrepQuestionForRenderingOptions} [options]
      * @returns {Record<string, any>}
      */
-    answerObjectFromJourneyResponse(response: import("../journey/journey-response.js").JourneyResponse, { params, manageListQuestion }?: import("./question-types.js").PrepQuestionForRenderingOptions): Record<string, any>;
+    answerObjectFromJourneyResponse(response: import("../journey/journey-response.js").JourneyResponse, { params, manageListQuestion }?: import("#typedefs/question-types.d.ts").PrepQuestionForRenderingOptions): Record<string, any>;
     /**
      * renders the question
      * @param {import('express').Response} res - the express response
-     * @param {QuestionViewModel} viewModel additional data to send to view
+     * @param {import('#typedefs/question-types.d.ts').QuestionViewModel} viewModel additional data to send to view
      * @returns {void}
      */
-    renderAction(res: import("express").Response, viewModel: QuestionViewModel): void;
+    renderAction(res: import("express").Response, viewModel: import("#typedefs/question-types.d.ts").QuestionViewModel): void;
     /**
      * check for validation errors
      * @param {import('express').Request} req
      * @param {import('../journey/journey.js').Journey} journey
      * @param {import('../section.js').Section} section
      * @param {import('../components/manage-list/question.js')} [manageListQuestion]
-     * @returns {QuestionViewModel|undefined} returns the view model for displaying the error or undefined if there are no errors
+     * @returns {import('#typedefs/question-types.d.ts').QuestionViewModel|undefined} returns the view model for displaying the error or undefined if there are no errors
      */
-    checkForValidationErrors(req: import("express").Request, section: import("../section.js").Section, journey: import("../journey/journey.js").Journey, manageListQuestion?: typeof import("../components/manage-list/question.js")): QuestionViewModel | undefined;
+    checkForValidationErrors(req: import("express").Request, section: import("../section.js").Section, journey: import("../journey/journey.js").Journey, manageListQuestion?: typeof import("../components/manage-list/question.js")): import("#typedefs/question-types.d.ts").QuestionViewModel | undefined;
     /**
      * Get the data to save from the request, returns an object of answers
      *
@@ -207,8 +181,8 @@ export class Question {
      * @param {import('express').Request} req
      * @param {import('../journey/journey.js').Journey} journey
      * @param {import('../section.js').Section} sectionObj
-     * @returns {QuestionViewModel | undefined} returns the view model for displaying the error or undefined if there are no errors
-     */ checkForSavingErrors(req: import("express").Request, sectionObj: import("../section.js").Section, journey: import("../journey/journey.js").Journey): QuestionViewModel | undefined;
+     * @returns {import('#typedefs/question-types.d.ts').QuestionViewModel | undefined} returns the view model for displaying the error or undefined if there are no errors
+     */ checkForSavingErrors(req: import("express").Request, sectionObj: import("../section.js").Section, journey: import("../journey/journey.js").Journey): import("#typedefs/question-types.d.ts").QuestionViewModel | undefined;
     /**
      * Handles redirect after saving. Kept around for backwards compatibility.
      *
@@ -222,28 +196,20 @@ export class Question {
     handleNextQuestion(res: import("express").Response, journey: import("../journey/journey.js").Journey, sectionSegment: string, questionSegment: string): void;
     /**
      * returns the formatted answers values to be used to build task list elements
-     * @param {String} sectionSegment
+     * @param {string} sectionSegment
      * @param {import('../journey/journey.js').Journey} journey
      * @param {unknown} answer
-     * @returns {Array<{
-     *   key: string;
-     *   value: string | Object;
-     *   action?: ActionView | ActionView[];
-     * }>}
+     * @returns {import('#typedefs/question-types.d.ts').SummaryRow[]}
      */
-    formatAnswerForSummary(sectionSegment: string, journey: import("../journey/journey.js").Journey, answer: unknown, capitals?: boolean): Array<{
-        key: string;
-        value: string | Object;
-        action?: ActionView | ActionView[];
-    }>;
+    formatAnswerForSummary(sectionSegment: string, journey: import("../journey/journey.js").Journey, answer: unknown, capitals?: boolean): import("#typedefs/question-types.d.ts").SummaryRow[];
     /**
      * Returns the action link for the question
-     * @param {unknown} answer
+     * @param {string} sectionSegment
      * @param {import('../journey/journey.js').Journey} journey
-     * @param {String} sectionSegment
-     * @returns {ActionView|ActionView[]|undefined}
+     * @param {unknown} answer
+     * @returns {import('#typedefs/question-types.d.ts').ActionView | import('#typedefs/question-types.d.ts').ActionView[] | undefined}
      */
-    getAction(sectionSegment: string, journey: import("../journey/journey.js").Journey, answer: unknown): ActionView | ActionView[] | undefined;
+    getAction(sectionSegment: string, journey: import("../journey/journey.js").Journey, answer: unknown): import("#typedefs/question-types.d.ts").ActionView | import("#typedefs/question-types.d.ts").ActionView[] | undefined;
     /**
      * @param {unknown} answer
      * @returns {unknown}
@@ -265,16 +231,4 @@ export class Question {
      */
     isAnswered(journeyResponse: import("../journey/journey-response.js").JourneyResponse, fieldName?: string): boolean;
 }
-export type PreppedQuestion = {
-    value: Object;
-    question: string;
-    fieldName: string;
-    pageTitle: string;
-    description?: string | undefined;
-    html?: string | undefined;
-};
-export type QuestionViewModel = Record<string, any>;
-import type { BaseValidator } from "#base-validator";
-import type { ActionLink } from "./question-types.js";
-import type { ActionView } from "../controller.js";
 //# sourceMappingURL=question.d.ts.map

package/src/questions/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAKA;;;GAGG;AACH;IA6DC;;;OAGG;IACH,yLAHW,OAAO,+BAA+B,EAAE,kBAAkB,oBAC1D,MAAM,CAAC,MAAM,WAAW,EAsDlC;IApHD,6EAA6E;IAC7E,WADW,MAAM,CACP;IACV,sDAAsD;IACtD,OADW,MAAM,CACX;IACN,+DAA+D;IAC/D,UADW,MAAM,CACR;IACT,mFAAmF;IACnF,aADW,MAAM,GAAC,SAAS,CACf;IACZ,iDAAiD;IACjD,YADW,MAAM,CACN;IACX,qHAAqH;IACrH,WADW,MAAM,CACP;IACV,6FAA6F;IAC7F,UADW,OAAO,CACF;IAChB,0IAA0I;IAC1I,YADW,KAAK,CAAE,OAAO,gCAAgC,EAAE,aAAa,CAAC,CACzD;IAChB,2DAA2D;IAC3D,MADW,MAAM,GAAC,SAAS,CACtB;IACL,sEAAsE;IACtE,oBADW,OAAO,CACQ;IAC1B,oDAAoD;IACpD,KADW,MAAM,GAAC,SAAS,CACvB;IACJ,qDAAqD;IACrD,MADW,MAAM,GAAC,SAAS,CACtB;IACL,sDAAsD;IACtD,eADW,MAAM,GAAC,SAAS,CACb;IACd,gGAAgG;IAChG,YADW,OAAO,+BAA+B,EAAE,UAAU,GAAC,SAAS,CAC5D;IAEX,iFAAiF;IACjF,gBADW,MAAM,CACc;IAC/B,4CAA4C;IAC5C,oBADW,MAAM,CACe;IAChC,uDAAuD;IACvD,kBADW,MAAM,CACW;IAC5B,uDAAuD;IACvD,kBADW,MAAM,CACW;IAC5B,oDAAoD;IACpD,eADW,MAAM,CACK;IAEtB;;;OAGG;IAEH,gBAAiB,WAJN,OAAO,gCAAgC,EAAE,eAI3B,KAHZ,OAAO,CAGe;IAEnC;;;MAGE;IACF;;;;;;OAMG;IACH,wBAFU,OAAO,CAEc;IAyC9B,iCAAgC;IAChC,kBAAwB;IAExB;;;;MAAwB;IAgBzB;;;;;;OAMG;IACH,4BAFa,OAAO,CAInB;IAWD,iCANa,OAAO,EAWnB;IAdD;;;;OAIG;IACH,6BAFa,OAAO,CAInB;IASD;;;;;;OAMG;IACH,sBAFa,MAAM,EAAE,CAIpB;IAED;;;;;;;;;;;;;;OAcG;IACH,uFARG;QAAoE,MAAM,EAAlE,OAAO,8BAA8B,EAAE,WAAW;QACQ,kBAAkB;QACnC,OAAO,EAAhD,OAAO,eAAe,EAAE,OAAO;QACkB,OAAO,EAAxD,OAAO,uBAAuB,EAAE,OAAO;QACL,cAAc;QAC9B,OAAO,GAAzB,OAAO;KACf,GAAU,OAAO,+BAA+B,EAAE,iBAAiB,CASrE;IAED;;;;;;;;;OASG;IACH,kCAPW,OAAO,eAAe,EAAE,OAAO,WAC/B,OAAO,uBAAuB,EAAE,OAAO,mBACvC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,OAAO,YACP,OAAO,+BAA+B,EAAE,+BAA+B,GACrE,OAAO,+BAA+B,EAAE,iBAAiB,CAuCrE;IAED;;;;;;;;OAQG,CACH,4BAJW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,uBAEjB,GAAC,GAAC,MAAM,CAIpB;IAED;;;;;;OAMG,CACH,oCAFW,OAAO,+BAA+B,EAAE,iBAAiB,QAE9B;IAEtC;;;;;;OAMG;IACH,0CAJW,OAAO,gCAAgC,EAAE,eAAe,mCACxD,OAAO,+BAA+B,EAAE,+BAA+B,GACrE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAc/B;IAED;;;;;OAKG;IACH,kBAJW,OAAO,SAAS,EAAE,QAAQ,aAC1B,OAAO,+BAA+B,EAAE,iBAAiB,GACvD,IAAI,CAShB;IAED;;;;;;;OAOG;IACH,8BANW,OAAO,SAAS,EAAE,OAAO,WAEzB,OAAO,eAAe,EAAE,OAAO,WAD/B,OAAO,uBAAuB,EAAE,OAAO,gFAGrC,OAAO,+BAA+B,EAAE,iBAAiB,GAAC,SAAS,CAmB/E;IAED;;;;;;OAMG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,OAAO,gCAAgC,EAAE,eAAe,GACtD,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAczD;IAED;;;;;;OAMG,CACH,0BALW,OAAO,SAAS,EAAE,OAAO,cAEzB,OAAO,eAAe,EAAE,OAAO,WAD/B,OAAO,uBAAuB,EAAE,OAAO,GAErC,OAAO,+BAA+B,EAAE,iBAAiB,GAAG,SAAS,CAIjF;IAED;;;;;;;;;OASG;IACH,wBAPW,OAAO,SAAS,EAAE,QAAQ,WAC1B,OAAO,uBAAuB,EAAE,OAAO,kBACvC,MAAM,mBACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;;;;OAMG;IACH,uCALW,MAAM,WACN,OAAO,uBAAuB,EAAE,OAAO,UACvC,OAAO,uBACL,OAAO,+BAA+B,EAAE,UAAU,EAAE,CAahE;IAED;;;;;;OAMG;IACH,0BALW,MAAM,WACN,OAAO,uBAAuB,EAAE,OAAO,UACvC,OAAO,GACL,OAAO,+BAA+B,EAAE,UAAU,GAAG,OAAO,+BAA+B,EAAE,UAAU,EAAE,GAAG,SAAS,CAqBjI;IAED;;;OAGG;IACH,eAHW,OAAO,GACL,OAAO,CAInB;IAED;;OAEG;IACH,cAFa,OAAO,CAInB;IACD;;;OAGG;IACH,4BAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,4BAJW,OAAO,gCAAgC,EAAE,eAAe,cACxD,MAAM,GACJ,OAAO,CAInB;CACD"}

package/src/questions/question.js

@@ -3,35 +3,6 @@ import { capitalize, nl2br, trimTrailingSlash } from '../lib/utils.js';
 import MultiFieldInputValidator from '../validator/multi-field-input-validator.js';
 import { answerObjectForManageList } from '#src/components/manage-list/utils.js';
 
-/**
- * @import {BaseValidator} from "#base-validator"
- * @import {ActionView} from "../controller.js"
- * @import {ActionLink} from "./question-types.js"
- */
-
-/**
- * @typedef {Object} PreppedQuestion
- * @property {Object} value
- * @property {string} question
- * @property {string} fieldName
- * @property {string} pageTitle
- * @property {string} [description]
- * @property {string} [html]
- */
-
-/**
- * @typedef {Record<string, any>} QuestionViewModel
- * @property {PreppedQuestion} question
- * @property {string} layoutTemplate
- * @property {string} pageCaption
- * @property {string} [continueButtonText]
- * @property {string} backLink
- * @property {boolean} showBackToListLink
- * @property {string} listLink
- * @property {Object} util
- * @property {function(string): string} util.trimTrailingSlash
- */
-
 /**
  * A specific question within a journey which is made up of one (usually) or many (sometimes) components and their required content.
  * @class
@@ -51,7 +22,7 @@ export class Question {
 	fieldName;
 	/** @type {boolean} if the question should appear in the journey overview task list or not */
 	taskList = true;
-	/** @type {Array.<BaseValidator>} array of validators that a question uses to validate answers */
+	/** @type {Array.<import('../validator/base-validator.js').BaseValidator>} array of validators that a question uses to validate answers */
 	validators = [];
 	/** @type {string|undefined} hint text displayed to user */
 	hint;
@@ -63,7 +34,7 @@ export class Question {
 	html;
 	/** @type {string|undefined} optional question type */
 	interfaceType;
-	/** @type {ActionLink|undefined} override action link */
+	/** @type {import('#typedefs/question-types.d.ts').ActionLink|undefined} override action link */
 	actionLink;
 
 	/** @type {string} 'not started' text to display (if a question has no answer) */
@@ -81,7 +52,8 @@ export class Question {
 	 * @param {import('../journey/journey-response.js').JourneyResponse} [response]
 	 * @returns {boolean}
 	 */
-	shouldDisplay = () => true;
+	// eslint-disable-next-line no-unused-vars -- response will be used by extending classes
+	shouldDisplay = (response) => true;
 
 	details = {
 		title: '',
@@ -97,7 +69,7 @@ export class Question {
 	_isInManageListSection = false;
 
 	/**
-	 * @param {import('./question-types.js').QuestionParameters} params
+	 * @param {import('#typedefs/question-types.d.ts').QuestionParameters} params
 	 * @param {Record<string, Function>} [methodOverrides]
 	 */
 	constructor(
@@ -199,13 +171,13 @@ export class Question {
 	 * that prepQuestionForRendering doesn't need
 	 *
 	 * @param {Object} options
-	 * @param {import('../journey/journey-types.js').RouteParams} options.params
+	 * @param {import('#typedefs/journey-types.d.ts').RouteParams} options.params
 	 * @param {import('../components/manage-list/question.js')} [options.manageListQuestion]
 	 * @param {import('../section.js').Section} options.section - the current section
 	 * @param {import('../journey/journey.js').Journey} options.journey - the journey we are in
 	 * @param {Record<string, unknown>} [options.customViewData] additional data to send to view
 	 * @param {unknown} [options.payload]
-	 * @returns {QuestionViewModel}
+	 * @returns {import('#typedefs/question-types.d.ts').QuestionViewModel}
 	 */
 	toViewModel({ params, manageListQuestion, section, journey, customViewData, payload }) {
 		const viewModel = this.prepQuestionForRendering(section, journey, customViewData, payload, {
@@ -223,8 +195,8 @@ export class Question {
 	 * @param {import('../journey/journey.js').Journey} journey - the journey we are in
 	 * @param {Record<string, unknown>} [customViewData] additional data to send to view
 	 * @param {unknown} [payload]
-	 * @param {import('./question-types.js').PrepQuestionForRenderingOptions} [options] - required to support manage list question
-	 * @returns {QuestionViewModel}
+	 * @param {import('#typedefs/question-types.d.ts').PrepQuestionForRenderingOptions} [options] - required to support manage list question
+	 * @returns {import('#typedefs/question-types.d.ts').QuestionViewModel}
 	 */
 	prepQuestionForRendering(section, journey, customViewData, payload, options) {
 		const answers = payload || this.answerObjectFromJourneyResponse(journey.response, options);
@@ -283,7 +255,7 @@ export class Question {
 	 *
 	 * If possible override this method instead of prepQuestionForRendering for simple changes to the view model
 	 *
-	 * @param {QuestionViewModel} viewModel
+	 * @param {import('#typedefs/question-types.d.ts').QuestionViewModel} viewModel
 	 */ // eslint-disable-next-line no-unused-vars
 	addCustomDataToViewModel(viewModel) {}
 
@@ -291,7 +263,7 @@ export class Question {
 	 * Get the answers object from the journey response, which may be nested in an array for manage list questions
 	 *
 	 * @param {import('../journey/journey-response.js').JourneyResponse} response
-	 * @param {import('./question-types.js').PrepQuestionForRenderingOptions} [options]
+	 * @param {import('#typedefs/question-types.d.ts').PrepQuestionForRenderingOptions} [options]
 	 * @returns {Record<string, any>}
 	 */
 	answerObjectFromJourneyResponse(response, { params, manageListQuestion } = {}) {
@@ -311,7 +283,7 @@ export class Question {
 	/**
 	 * renders the question
 	 * @param {import('express').Response} res - the express response
-	 * @param {QuestionViewModel} viewModel additional data to send to view
+	 * @param {import('#typedefs/question-types.d.ts').QuestionViewModel} viewModel additional data to send to view
 	 * @returns {void}
 	 */
 	renderAction(res, viewModel) {
@@ -329,7 +301,7 @@ export class Question {
 	 * @param {import('../journey/journey.js').Journey} journey
 	 * @param {import('../section.js').Section} section
 	 * @param {import('../components/manage-list/question.js')} [manageListQuestion]
-	 * @returns {QuestionViewModel|undefined} returns the view model for displaying the error or undefined if there are no errors
+	 * @returns {import('#typedefs/question-types.d.ts').QuestionViewModel|undefined} returns the view model for displaying the error or undefined if there are no errors
 	 */
 	checkForValidationErrors(req, section, journey, manageListQuestion) {
 		const { body = {} } = req;
@@ -376,7 +348,7 @@ export class Question {
 	 * @param {import('express').Request} req
 	 * @param {import('../journey/journey.js').Journey} journey
 	 * @param {import('../section.js').Section} sectionObj
-	 * @returns {QuestionViewModel | undefined} returns the view model for displaying the error or undefined if there are no errors
+	 * @returns {import('#typedefs/question-types.d.ts').QuestionViewModel | undefined} returns the view model for displaying the error or undefined if there are no errors
 	 */ //eslint-disable-next-line no-unused-vars
 	checkForSavingErrors(req, sectionObj, journey) {
 		return;
@@ -401,14 +373,10 @@ export class Question {
 
 	/**
 	 * returns the formatted answers values to be used to build task list elements
-	 * @param {String} sectionSegment
+	 * @param {string} sectionSegment
 	 * @param {import('../journey/journey.js').Journey} journey
 	 * @param {unknown} answer
-	 * @returns {Array<{
-	 *   key: string;
-	 *   value: string | Object;
-	 *   action?: ActionView | ActionView[];
-	 * }>}
+	 * @returns {import('#typedefs/question-types.d.ts').SummaryRow[]}
 	 */
 	formatAnswerForSummary(sectionSegment, journey, answer, capitals = true) {
 		const formattedAnswer = capitals ? capitalize(answer ?? this.notStartedText) : (answer ?? this.notStartedText);
@@ -425,10 +393,10 @@ export class Question {
 
 	/**
 	 * Returns the action link for the question
-	 * @param {unknown} answer
+	 * @param {string} sectionSegment
 	 * @param {import('../journey/journey.js').Journey} journey
-	 * @param {String} sectionSegment
-	 * @returns {ActionView|ActionView[]|undefined}
+	 * @param {unknown} answer
+	 * @returns {import('#typedefs/question-types.d.ts').ActionView | import('#typedefs/question-types.d.ts').ActionView[] | undefined}
 	 */
 	getAction(sectionSegment, journey, answer) {
 		if (this.actionLink) {