@planning-inspectorate/dynamic-forms 3.3.3 → 3.4.0

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

@@ -0,0 +1,60 @@
+/**
+ * Display the date in Europe/London
+ * @param {Date|string} [date]
+ * @param {Object} [options]
+ * @param {string} [options.format] date formatting string
+ * @returns {string} formatted date string or empty string if invalid value passed in
+ */
+export function formatDateForDisplay(date?: Date | string, { format }?: {
+    format?: string | undefined;
+}): string;
+/**
+ * @typedef {Object} DateTimeParams
+ * @property {number} year
+ * @property {number} month
+ * @property {number} day
+ * @property {number} [hour]
+ * @property {number} [minute]
+ * @property {number} [second]
+ * @property {boolean} [convertToUTC]
+ */
+/**
+ * Parse the date and time parameters provided by a user
+ * @param {DateTimeParams} params
+ * @returns {Date}
+ */
+export function parseDateInput({ year, month, day, hour, minute, second }: DateTimeParams): Date;
+/**
+ * Start of the day in UK time zone
+ */
+export function startOfDay(): Date;
+/**
+ * End of the day in UK time zone
+ */
+export function endOfDay(): Date;
+/**
+ * Check if today is within the date range inclusive (start <= now <= end)
+ * @param {Date} startDate
+ * @param {Date} endDate
+ * @returns {boolean}
+ */
+export function nowIsWithinRange(startDate: Date, endDate: Date): boolean;
+/**
+ * Check if today is on or after the start date
+ * @param {Date} startDate
+ * @returns {boolean}
+ */
+export function isNowAfterStartDate(startDate: Date): boolean;
+export function dateIsAfterToday(date: Date): boolean;
+export function dateIsBeforeToday(date: Date): boolean;
+export function dateIsToday(date: Date): boolean;
+export type DateTimeParams = {
+    year: number;
+    month: number;
+    day: number;
+    hour?: number | undefined;
+    minute?: number | undefined;
+    second?: number | undefined;
+    convertToUTC?: boolean | undefined;
+};
+//# sourceMappingURL=date-utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"date-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/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/types/src/lib/date-utils.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=date-utils.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"date-utils.test.d.ts","sourceRoot":"","sources":["../../../src/lib/date-utils.test.js"],"names":[],"mappings":""}

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

@@ -0,0 +1,84 @@
+/**
+ * A `SaveDataFn` implementation that saves answers to the session.
+ * Answers are saved into a forms object, keyed by the journeyId, and optionally by a request parameter
+ * @example
+ * req: {
+ * 	session: {
+ * 		forms: {
+ * 			'journey-id-1': {
+ * 				questionOne: 'my answer'
+ * 				// ...
+ * 			}
+ * 		}
+ * 	}
+ * }
+ *
+ * or when keyed by a req parameter:
+ * @example
+ * req: {
+ * 	session: {
+ * 		forms: {
+ * 			'some-req-param': {
+ * 			   'journey-id-1': {
+ * 				   questionOne: 'my answer'
+ * 				   // ...
+ * 			   }
+ * 			}
+ * 		}
+ * 	}
+ * }
+ *
+ *
+ * @param {Object} opts
+ * @param {string} [opts.reqParam]
+ * - optional request parameter to use as a key
+ * @returns {import('../controller').SaveDataFn}
+ */
+export function buildSaveDataToSession({ reqParam }?: {
+    reqParam?: string | undefined;
+}): any;
+/**
+ * A function to clear journey answers from the session
+ *
+ * @example
+ * req: {
+ * 	session: {
+ * 		forms: {
+ * 			'journey-id-1': {
+ * 				questionOne: 'my answer'
+ * 				// ...
+ * 			}
+ * 		}
+ * 	}
+ * }
+ *
+ * @param {Object} params
+ * @param {import('express').Request} params.req
+ * @param {string} params.journeyId
+ * @param {Object<string, any>} [params.replaceWith] - optional data to replace the form answers with
+ * @param {string} [params.reqParam] - optional request parameter used as a key
+ * @returns {void}
+ */
+export function clearDataFromSession({ req, journeyId, replaceWith, reqParam }: {
+    req: any;
+    journeyId: string;
+    replaceWith?: {
+        [x: string]: any;
+    } | undefined;
+    reqParam?: string | undefined;
+}): void;
+/**
+ * Fetch session answers from the session
+ *
+ * @param {string} journeyId
+ * @param {string} [reqParam] - optional request parameter used as a key
+ * @returns {import('express').Handler}
+ */
+export function buildGetJourneyResponseFromSession(journeyId: string, reqParam?: string): any;
+/**
+ * Default save-to-session function with no request parameter
+ *
+ * @type {import('../controller').SaveDataFn}
+ */
+export const saveDataToSession: any;
+//# sourceMappingURL=session-answer-store.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"session-answer-store.d.ts","sourceRoot":"","sources":["../../../src/lib/session-answer-store.js"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,sDAJG;IAAsB,QAAQ;CAE9B,OA4BF;AASD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,gFANG;IAA0C,GAAG,EAArC,GAAyB;IACV,SAAS,EAAxB,MAAM;IACuB,WAAW;;;IACxB,QAAQ;CAChC,GAAU,IAAI,CAkBhB;AAED;;;;;;GAMG;AACH,8DAJW,MAAM,aACN,MAAM,OA4BhB;AA/ED;;;;GAIG;AACH,oCAA0D"}

package/types/src/lib/session-answer-store.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=session-answer-store.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"session-answer-store.test.d.ts","sourceRoot":"","sources":["../../../src/lib/session-answer-store.test.js"],"names":[],"mappings":""}

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

@@ -0,0 +1,19 @@
+/**
+ * replaces new line chars with a <br>
+ * @param {string} [value]
+ * @returns {string}
+ */
+export function nl2br(value?: string): string;
+/**
+ * @param {string|any} str
+ * @returns {string}
+ */
+export function capitalize(str: string | any): string;
+/**
+ * Trim a trailing slash if present
+ *
+ * @param {string} [str]
+ * @returns {string}
+ */
+export function trimTrailingSlash(str?: string): string;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/lib/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"}

package/types/src/lib/utils.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=utils.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.test.d.ts","sourceRoot":"","sources":["../../../src/lib/utils.test.js"],"names":[],"mappings":""}

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

@@ -0,0 +1,7 @@
+/**
+ * Wrapper class so it can be overridden by test mocks
+ */
+export class Uuid {
+    static randomUUID(): `${string}-${string}-${string}-${string}-${string}`;
+}
+//# sourceMappingURL=uuid.d.ts.map

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

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

package/types/src/lib/uuid.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=uuid.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"uuid.test.d.ts","sourceRoot":"","sources":["../../../src/lib/uuid.test.js"],"names":[],"mappings":""}

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

@@ -0,0 +1,6 @@
+/**
+ * @param {(req: import('express').Request, journeyResponse: import('../journey/journey-response.js').JourneyResponse) => import('../journey/journey.js').Journey} createJourney
+ * @returns {import('express').Handler}
+ */
+export function buildGetJourney(createJourney: (req: any, journeyResponse: import("../journey/journey-response.js").JourneyResponse) => import("../journey/journey.js").Journey): any;
+//# sourceMappingURL=build-get-journey.d.ts.map

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * @typedef {function(import('../section').Question, import('../journey/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[]): any;
+export type ShouldDisplayCondition = (arg0: any, arg1: any) => boolean;
+//# sourceMappingURL=redirect-to-unanswered-question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirect-to-unanswered-question.d.ts","sourceRoot":"","sources":["../../../src/middleware/redirect-to-unanswered-question.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AACH,0DAHW,sBAAsB,EAAE,OA+BlC;qCArCY,CAAS,IAA6B,EAA7B,GAA6B,EAAE,IAAqD,EAArD,GAAqD,KAAG,OAAO"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=redirect-to-unanswered-question.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirect-to-unanswered-question.test.d.ts","sourceRoot":"","sources":["../../../src/middleware/redirect-to-unanswered-question.test.js"],"names":[],"mappings":""}

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

@@ -0,0 +1,21 @@
+/** @typedef {import('./question-props').QuestionProps} QuestionProps */
+/**
+ * @param {{[questionName: string]: QuestionProps}} questionPropsRecord
+ * @param {Record<string, typeof import('./question').Question>} questionClasses
+ * @param {{[questionType: string]: Record<string, Function>}} questionMethodOverrides
+ * @param {{notStartedText?: string, continueButtonText?: string, changeActionText?: string, answerActionText?: string}} [textOverrides] - customise question text
+ */
+export function createQuestions(questionPropsRecord: {
+    [questionName: string]: QuestionProps;
+}, questionClasses: Record<string, typeof import("./question").Question>, questionMethodOverrides: {
+    [questionType: string]: Record<string, Function>;
+}, textOverrides?: {
+    notStartedText?: string;
+    continueButtonText?: string;
+    changeActionText?: string;
+    answerActionText?: string;
+}): {
+    [k: string]: any;
+};
+export type QuestionProps = any;
+//# sourceMappingURL=create-questions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-questions.d.ts","sourceRoot":"","sources":["../../../src/questions/create-questions.js"],"names":[],"mappings":"AAAA,wEAAwE;AAExE;;;;;GAKG;AACH,qDALW;IAAC,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa,CAAA;CAAC,mBACvC,MAAM,CAAC,MAAM,EAAE,cAAc,YAAY,EAAE,QAAQ,CAAC,2BACpD;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;;EAwBtH"}

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

@@ -0,0 +1,74 @@
+/**
+ * @typedef {{
+ *   text: string;
+ *   value: string;
+ *     hint?: object;
+ *   checked?: boolean | undefined;
+ *   attributes?: Record<string, string>;
+ *   behaviour?: 'exclusive';
+ *   conditional?: {
+ *     question: string;
+ *     type: string;
+ *     fieldName: string;
+ *         inputClasses?: string;
+ *         html?: string;
+ *     value?: unknown;
+ *         label?: string;
+ *         hint?: string
+ *   };
+ *     conditionalText?: {
+ *       html: string;
+ *   }
+ *}} Option
+ */
+/**
+ * @typedef {import('./question').QuestionViewModel & { question: { options: Option[] } }} OptionsViewModel
+ */
+export default class OptionsQuestion extends Question {
+    /**
+     * @param {import('#question-types').QuestionParameters} params
+     * @param {Array<Option>} params.options
+     */
+    constructor(params: import("#question-types").QuestionParameters);
+    /** @type {Array<Option>} */
+    options: Array<Option>;
+    optionJoinString: string;
+    /**
+     * gets the view model for this question
+     * @param {import('#section').Section} section - the current section
+     * @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('#src/questions/question-types.d.ts').PrepQuestionForRenderingOptions} options
+     * @returns {import('./question').QuestionViewModel} QuestionViewModel
+     */
+    prepQuestionForRendering(section: import("#section").Section, journey: import("#journey").Journey, customViewData?: Record<string, unknown>, payload?: Record<string, unknown>, options: import("#src/questions/question-types.d.ts").PrepQuestionForRenderingOptions): any;
+}
+export type Option = {
+    text: string;
+    value: string;
+    hint?: object;
+    checked?: boolean | undefined;
+    attributes?: Record<string, string>;
+    behaviour?: "exclusive";
+    conditional?: {
+        question: string;
+        type: string;
+        fieldName: string;
+        inputClasses?: string;
+        html?: string;
+        value?: unknown;
+        label?: string;
+        hint?: string;
+    };
+    conditionalText?: {
+        html: string;
+    };
+};
+export type OptionsViewModel = any & {
+    question: {
+        options: Option[];
+    };
+};
+import { Question } from './question.js';
+//# sourceMappingURL=options-question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"options-question.d.ts","sourceRoot":"","sources":["../../../src/questions/options-question.js"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;GAEG;AAEH;IAIC;;;OAGG;IACH,oBAHW,OAAO,iBAAiB,EAAE,kBAAkB,EAgBtD;IApBD,4BAA4B;IAC5B,SADW,KAAK,CAAC,MAAM,CAAC,CAChB;IAkBP,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,oCAAoC,EAAE,+BAA+B,OAmDtF;CAmCD;qBA9IY;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,GAAsC,GAAG;IAAE,QAAQ,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;CAAE;yBA/BhE,eAAe"}

package/types/src/questions/options-question.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=options-question.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"options-question.test.d.ts","sourceRoot":"","sources":["../../../src/questions/options-question.test.js"],"names":[],"mappings":""}

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

@@ -0,0 +1,274 @@
+/**
+ * @import {BaseValidator} from "#base-validator"
+ * @import {Journey} from "#journey"
+ * @import {JourneyResponse} from "#journey-response"
+ * @import {Section} from "#section"
+ * @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').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").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 */
+    title: string;
+    /** @type {string} - question shown to user on question page */
+    question: string;
+    /** @type {string|undefined} - additional information to user about the question */
+    description: string | undefined;
+    /** @type {string} the folder name of the view */
+    viewFolder: string;
+    /** @type {string} the unique name of the input on the page, also used as a url segment (should this be separated) */
+    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<escape>;
+    /** @type {string|undefined} hint text displayed to user */
+    hint: string | undefined;
+    /** @type {boolean} show return to listing page link after question */
+    showBackToListLink: boolean;
+    /** @type {string|undefined} alternative url slug */
+    url: string | undefined;
+    /** @type {string|undefined} optional html content */
+    html: string | undefined;
+    /** @type {string|undefined} optional question type */
+    interfaceType: string | undefined;
+    /** @type {ActionLink|undefined} override action link */
+    actionLink: ActionLink | undefined;
+    /** @type {string} 'not started' text to display (if a question has no answer) */
+    notStartedText: string;
+    /** @type {string} button text to display */
+    continueButtonText: string;
+    /** @type {string} text to display for 'change' link */
+    changeActionText: string;
+    /** @type {string} text to display for 'answer' link */
+    answerActionText: string;
+    /** @type {string} text to display for 'add' link */
+    addActionText: string;
+    /**
+     * @param {JourneyResponse} [response]
+     * @returns {boolean}
+     */
+    shouldDisplay: () => boolean;
+    details: {
+        title: string;
+        text: string;
+    };
+    autocomplete: string | undefined;
+    editable: boolean;
+    viewData: Record<string, any>;
+    /**
+     * Is this question a manage list question?
+     * Implemented as a getter so manage list question implementations can override it,
+     * but it cannot be changed at runtime.
+     *
+     * @returns {boolean}
+     */
+    get isManageListQuestion(): boolean;
+    set isInManageListSection(value: boolean);
+    /**
+     * Is this question added to a ManageListSection?
+     *
+     * @returns {boolean}
+     */
+    get isInManageListSection(): boolean;
+    /**
+     * gets the view model for this question
+     *
+     * Wraps prepQuestionForRendering to add the back link - which requires more parameters
+     * that prepQuestionForRendering doesn't need
+     *
+     * @param {Object} options
+     * @param {import('#src/journey/journey-types.d.ts').RouteParams} options.params
+     * @param {import('#src/components/manage-list/question.js')} [options.manageListQuestion]
+     * @param {Section} options.section - the current section
+     * @param {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}
+     */
+    toViewModel({ params, manageListQuestion, section, journey, customViewData, payload }: {
+        params: import("#src/journey/journey-types.d.ts").RouteParams;
+        manageListQuestion?: typeof import("#src/components/manage-list/question.js") | undefined;
+        section: Section;
+        journey: Journey;
+        customViewData?: Record<string, unknown> | undefined;
+        payload?: unknown;
+    }): QuestionViewModel;
+    /**
+     * gets the base view model for this question
+     *
+     * @param {Section} section - the current section
+     * @param {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.d.ts').PrepQuestionForRenderingOptions} [options] - required to support manage list question
+     * @returns {QuestionViewModel}
+     */
+    prepQuestionForRendering(section: Section, journey: Journey, customViewData?: Record<string, unknown>, payload?: unknown, options?: import("./question-types.d.ts").PrepQuestionForRenderingOptions): QuestionViewModel;
+    /**
+     * The answer to this question for use in the viewModel
+     *
+     * Question implementations can override this for more complex answer types
+     *
+     * @param {Record<string, any>} answers - collection of answers to pull the answer from, may be from the response or the request/payload
+     * @param {Boolean} isPayload - whether the answers object is from the request/payload
+     * @returns {*|string}
+     */ answerForViewModel(answers: Record<string, any>, isPayload: boolean): any | string;
+    /**
+     * Question implementations can override this to add configuration or other values to the view model
+     *
+     * If possible override this method instead of prepQuestionForRendering for simple changes to the view model
+     *
+     * @param {QuestionViewModel} viewModel
+     */ addCustomDataToViewModel(viewModel: QuestionViewModel): void;
+    /**
+     * Get the answers object from the journey response, which may be nested in an array for manage list questions
+     *
+     * @param {JourneyResponse} response
+     * @param {import('./question-types.d.ts').PrepQuestionForRenderingOptions} [options]
+     * @returns {Record<string, any>}
+     */
+    answerObjectFromJourneyResponse(response: JourneyResponse, { params, manageListQuestion }?: import("./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
+     * @returns {void}
+     */
+    renderAction(res: any, viewModel: QuestionViewModel): void;
+    /**
+     * check for validation errors
+     * @param {import('express').Request} req
+     * @param {Journey} journey
+     * @param {Section} section
+     * @param {import('#src/components/manage-list/question.js')} [manageListQuestion]
+     * @returns {QuestionViewModel|undefined} returns the view model for displaying the error or undefined if there are no errors
+     */
+    checkForValidationErrors(req: any, section: Section, journey: Journey, manageListQuestion?: typeof import("#src/components/manage-list/question.js")): QuestionViewModel | undefined;
+    /**
+     * Get the data to save from the request, returns an object of answers
+     *
+     * @param {import('express').Request} req
+     * @param {JourneyResponse} journeyResponse - current journey response
+     * @returns {Promise<{ answers: Record<string, unknown> }>}
+     */ getDataToSave(req: any, journeyResponse: JourneyResponse): Promise<{
+        answers: Record<string, unknown>;
+    }>;
+    /**
+     * check for errors after saving, by default this does nothing
+     * @param {import('express').Request} req
+     * @param {Journey} journey
+     * @param {Section} sectionObj
+     * @returns {QuestionViewModel | undefined} returns the view model for displaying the error or undefined if there are no errors
+     */ checkForSavingErrors(req: any, sectionObj: Section, journey: Journey): QuestionViewModel | undefined;
+    /**
+     * Handles redirect after saving. Kept around for backwards compatibility.
+     *
+     * @param {import('express').Response} res
+     * @param {Journey} journey
+     * @param {string} sectionSegment
+     * @param {string} questionSegment
+     * @returns {void}
+     * @deprecated - use `journey.redirectToNextQuestion`
+     */
+    handleNextQuestion(res: any, journey: Journey, sectionSegment: string, questionSegment: string): void;
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     * @param {String} sectionSegment
+     * @param {Journey} journey
+     * @param {Object} answer
+     * @returns {Array<{
+     *   key: string;
+     *   value: string | Object;
+     *   action: {
+     *     href: string;
+     *     text: string;
+     *     visuallyHiddenText: string;
+     *   };
+     * }>}
+     */
+    formatAnswerForSummary(sectionSegment: string, journey: Journey, answer: Object, capitals?: boolean): Array<{
+        key: string;
+        value: string | Object;
+        action: {
+            href: string;
+            text: string;
+            visuallyHiddenText: string;
+        };
+    }>;
+    /**
+     * Returns the action link for the question
+     * @param {Object} answer
+     * @param {Journey} journey
+     * @param {String} sectionSegment
+     * @returns {ActionView|ActionView[]|undefined}
+     */
+    getAction(sectionSegment: string, journey: Journey, answer: Object): ActionView | ActionView[] | undefined;
+    /**
+     * @param {unknown} answer
+     * @returns {unknown}
+     */
+    format(answer: unknown): unknown;
+    /**
+     * @returns {boolean}
+     */
+    isRequired(): boolean;
+    /**
+     * @param {string} inputField
+     * @returns {boolean}
+     */
+    fieldIsRequired(inputField: string): boolean;
+    /**
+     * @param {JourneyResponse} journeyResponse
+     * @param {string} [fieldName] optional fieldname for multi field input questions
+     * @returns {boolean}
+     */
+    isAnswered(journeyResponse: JourneyResponse, fieldName?: string): boolean;
+    #private;
+}
+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 { ActionLink } from "./question-types.js";
+import type { Section } from "#section";
+import type { Journey } from "#journey";
+import type { JourneyResponse } from "#journey-response";
+import type { ActionView } from "../controller.js";
+//# sourceMappingURL=question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../src/questions/question.js"],"names":[],"mappings":"AAOA;;;;;;;GAOG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;GAWG;AAEH;;;GAGG;AACH;IAqDC;;;OAGG;IACH,yLAHW,OAAO,iBAAiB,EAAE,kBAAkB,oBAC5C,MAAM,CAAC,MAAM,WAAW,EAsDlC;IA5GD,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,iGAAiG;IACjG,YADW,KAAK,CAAE,MAAa,CAAC,CAChB;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,wDAAwD;IACxD,YADW,UAAU,GAAC,SAAS,CACpB;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;IACH,qBAFa,OAAO,CAEO;IAE3B;;;MAGE;IA0CD,iCAAgC;IAChC,kBAAwB;IAExB,8BAAwB;IAgBzB;;;;;;OAMG;IACH,4BAFa,OAAO,CAInB;IAWD,iCANa,OAAO,EAWnB;IAdD;;;;OAIG;IACH,6BAFa,OAAO,CAInB;IASD;;;;;;;;;;;;;;OAcG;IACH,uFARG;QAAuE,MAAM,EAArE,OAAO,iCAAiC,EAAE,WAAW;QACO,kBAAkB;QAC7D,OAAO,EAAxB,OAAO;QACU,OAAO,EAAxB,OAAO;QAC2B,cAAc;QAC9B,OAAO,GAAzB,OAAO;KACf,GAAU,iBAAiB,CAS7B;IAED;;;;;;;;;OASG;IACH,kCAPW,OAAO,WACP,OAAO,mBACP,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,OAAO,YACP,OAAO,uBAAuB,EAAE,+BAA+B,GAC7D,iBAAiB,CAuC7B;IAED;;;;;;;;OAQG,CACH,4BAJW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,uBAEjB,GAAC,GAAC,MAAM,CAIpB;IAED;;;;;;OAMG,CACH,oCAFW,iBAAiB,QAEU;IAEtC;;;;;;OAMG;IACH,0CAJW,eAAe,mCACf,OAAO,uBAAuB,EAAE,+BAA+B,GAC7D,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAc/B;IAED;;;;;OAKG;IACH,kCAHW,iBAAiB,GACf,IAAI,CAShB;IAED;;;;;;;OAOG;IACH,4CAJW,OAAO,WADP,OAAO,kFAGL,iBAAiB,GAAC,SAAS,CAmBvC;IAED;;;;;;OAMG,CACH,yCAHW,eAAe,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAczD;IAED;;;;;;OAMG,CACH,2CAHW,OAAO,WADP,OAAO,GAEL,iBAAiB,GAAG,SAAS,CAIzC;IAED;;;;;;;;;OASG;IACH,sCANW,OAAO,kBACP,MAAM,mBACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;;;;;;;;;;;;OAcG;IACH,wDAZW,OAAO,UACP,MAAM,uBACJ,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,CAaJ;IAED;;;;;;OAMG;IACH,2CAJW,OAAO,UADP,MAAM,GAGJ,UAAU,GAAC,UAAU,EAAE,GAAC,SAAS,CAqB7C;IAED;;;OAGG;IACH,eAHW,OAAO,GACL,OAAO,CAInB;IAED;;OAEG;IACH,cAFa,OAAO,CASnB;IACD;;;OAGG;IACH,4BAHW,MAAM,GACJ,OAAO,CAMnB;IAED;;;;OAIG;IACH,4BAJW,eAAe,cACf,MAAM,GACJ,OAAO,CAInB;;CACD;;WA/ca,MAAM;cACN,MAAM;eACN,MAAM;eACN,MAAM;;;;gCAMP,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;gCAdH,qBAAqB;6BAFxB,UAAU;6BAFV,UAAU;qCACF,mBAAmB;gCAExB,kBAAkB"}

package/types/src/questions/question.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=question.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.test.d.ts","sourceRoot":"","sources":["../../../src/questions/question.test.js"],"names":[],"mappings":""}