@planning-inspectorate/dynamic-forms 3.10.10 → 3.10.11

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

@@ -0,0 +1,182 @@
+import type { QuestionParameters } from '#src/questions/question-types.d.ts';
+
+type QuestionTypes =
+	| 'boolean'
+	| 'checkbox'
+	| 'date'
+	| 'date-period'
+	| 'date-time'
+	| 'email'
+	| 'manage-list'
+	| 'multi-field-input'
+	| 'number'
+	| 'radio'
+	| 'select'
+	| 'single-line-input'
+	| 'site-address'
+	| 'text-entry'
+	| 'text-entry-redact'
+	| 'unit-option';
+
+type CommonQuestionProps = Omit<QuestionParameters, 'viewFolder'> & {
+	type: QuestionTypes;
+};
+
+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;
+			};
+	  }
+	| { divider?: string };
+
+type Affix = {
+	text: string;
+	classes?: string;
+};
+
+interface InputField {
+	fieldName: string;
+	label: string;
+	formatJoinString?: string; // used by formatAnswerForSummary (e.g. task list display), effective default to line break
+	formatPrefix?: string; // used by formatAnswerForSummary (e.g. task list display), to prefix answer
+	formatTextFunction?: (text: string) => string; // used to format the answer for display and value in question
+	attributes?: Record<string, string>; // used to add HTML attributes to the field
+	suffix?: Affix; // used to add a suffix to the field
+	prefix?: Affix; // used to add a prefix to the field
+	hint?: string;
+}
+
+/*
+ * UnitOptions are the options displayed in the radio format - in this case the value
+ * represents the unit.
+ * Conditionals must be used to capture the relevant quantity.
+ * Each conditional must have a fieldName which uses the conditionalFieldName from the
+ * UnitOptionEntryQuestion object as a base, followed by an underscore and unit reference
+ * eg 'siteAreaSquareMetres_hectares' - this is required for validation and saving to the DB
+ */
+interface UnitOption {
+	text: string;
+	value: string;
+	hint?: object;
+	checked?: boolean | undefined;
+	attributes?: Record<string, string>;
+	behaviour?: 'exclusive';
+	conditional: {
+		fieldName: string;
+		suffix: string;
+		value?: unknown;
+		label?: string;
+		hint?: string;
+		conversionFactor?: number;
+	};
+}
+
+type BooleanQuestionProps = CommonQuestionProps & {
+	type: 'boolean';
+	options?: Option[];
+	interfaceType?: 'checkbox' | 'radio';
+};
+
+type CheckboxQuestionProps = CommonQuestionProps & {
+	type: 'checkbox';
+	options: Option[];
+};
+
+type DateQuestionProps = CommonQuestionProps & {
+	type: 'date';
+};
+
+type DatePeriodQuestionProps = CommonQuestionProps & {
+	type: 'date-period';
+};
+
+type DateTimeQuestionProps = CommonQuestionProps & {
+	type: 'date-time';
+};
+
+type ManageListQuestionProps = CommonQuestionProps & {
+	type: 'manage-list';
+};
+
+type EmailQuestionProps = CommonQuestionProps & {
+	type: 'email';
+};
+
+export type MultiFieldInputQuestionProps = CommonQuestionProps & {
+	type: 'multi-field-input';
+	inputFields: InputField[];
+};
+
+type NumberEntryQuestionProps = CommonQuestionProps & {
+	type: 'number';
+	suffix?: string;
+};
+
+type RadioQuestionProps = CommonQuestionProps & {
+	type: 'radio';
+	options: Option[];
+};
+
+type SelectQuestionProps = CommonQuestionProps & {
+	type: 'select';
+	options: Option[];
+	disableAccessibleAutocomplete?: boolean;
+};
+
+type SingleLineInputQuestionProps = CommonQuestionProps & {
+	type: 'single-line-input';
+	inputAttributes?: Record<string, string>;
+};
+
+type SiteAddressQuestionProps = CommonQuestionProps & {
+	type: 'site-address';
+};
+
+type TextEntryQuestionProps = CommonQuestionProps & {
+	type: 'text-entry';
+};
+
+type TextEntryRedactQuestionProps = CommonQuestionProps & {
+	type: 'text-entry-redact';
+};
+
+type UnitOptionEntryQuestionProps = CommonQuestionProps & {
+	type: 'unit-option';
+	conditionalFieldName: string;
+	options: UnitOption[];
+};
+
+export type QuestionProps =
+	| BooleanQuestionProps
+	| CheckboxQuestionProps
+	| DateQuestionProps
+	| DatePeriodQuestionProps
+	| DateTimeQuestionProps
+	| ManageListQuestionProps
+	| EmailQuestionProps
+	| MultiFieldInputQuestionProps
+	| NumberEntryQuestionProps
+	| RadioQuestionProps
+	| SelectQuestionProps
+	| SingleLineInputQuestionProps
+	| SiteAddressQuestionProps
+	| TextEntryQuestionProps
+	| TextEntryRedactQuestionProps
+	| UnitOptionEntryQuestionProps;

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

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

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

@@ -0,0 +1,86 @@
+import type { RouteParams } from '#src/journey/journey-types.d.ts';
+import type ManageListQuestion from '#src/components/manage-list/question.js';
+import type BaseValidator from '../validator/base-validator.js';
+import type { JourneyResponse } from '../journey/journey-response.js';
+
+export interface QuestionParameters {
+	title: string;
+	question: string;
+	viewFolder: string;
+	fieldName: string;
+	url?: string;
+	pageTitle?: string;
+	description?: string;
+	validators?: BaseValidator[];
+	html?: string;
+	hint?: string;
+	interfaceType?: string;
+	shouldDisplay?: (response: JourneyResponse) => boolean;
+	autocomplete?: string;
+	// is this question editable? defaults to true
+	editable?: boolean;
+	// override the action link for this question
+	actionLink?: ActionLink;
+	// static view data for this question
+	viewData?: {
+		/**
+		 * @deprecated replaced by secondaryActions
+		 */
+		extraActionButtons?: SecondaryAction[];
+		/**
+		 * Secondary action buttons
+		 */
+		secondaryActions?: SecondaryAction[];
+		[key: string]: any;
+	};
+}
+
+export interface ActionLink {
+	text: string;
+	href: string;
+}
+
+export type SecondaryAction = SecondaryActionButton | SecondaryActionLink;
+
+export interface SecondaryActionButton {
+	text: string;
+	type?: string;
+	formaction?: string;
+	classes?: string;
+}
+
+export interface SecondaryActionLink {
+	text: string;
+	href: string;
+	classes?: string;
+}
+
+export interface QuestionViewModel {
+	question: {
+		value: string | number | Record<string, any>;
+		question: string;
+		fieldName: string;
+		pageTitle: string;
+		description?: string;
+		html?: string;
+	};
+	layoutTemplate: string;
+	pageCaption: string;
+	continueButtonText: string;
+	backLink: string;
+	showBackToListLink: string;
+	listLink: string;
+	journeyTitle: string;
+	[k: string]: any;
+}
+
+export interface PrepQuestionForRenderingOptions {
+	params: RouteParams;
+	manageListQuestion?: ManageListQuestion;
+}
+
+/**
+ * Define a question class type so that projects downstream can extend the
+ * Question class and still pass them to the createQuestions function.
+ */
+export type QuestionClass<TQuestion extends Question = Question> = new (...args: never[]) => TQuestion;

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

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

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

@@ -0,0 +1,272 @@
+/**
+ * @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').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<BaseValidator>;
+    /** @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 {import('../journey/journey-response.js').JourneyResponse} [response]
+     * @returns {boolean}
+     */
+    shouldDisplay: () => boolean;
+    details: {
+        title: string;
+        text: string;
+    };
+    /**
+     * Private, but not marked as such because it breaks types, either using #variable:
+     * - Property '#isInManageListSection' is missing in type
+     * or with the @ private tag
+     * - Types have separate declarations of a private property '_isInManageListSection'.
+     * @type {boolean}
+     */
+    _isInManageListSection: boolean;
+    autocomplete: string | undefined;
+    editable: boolean;
+    viewData: {
+        [key: string]: any;
+        extraActionButtons?: import("./question-types.js").SecondaryAction[];
+        secondaryActions?: import("./question-types.js").SecondaryAction[];
+    };
+    /**
+     * 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('../journey/journey-types.js').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}
+     */
+    toViewModel({ params, manageListQuestion, section, journey, customViewData, payload }: {
+        params: import("../journey/journey-types.js").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;
+    /**
+     * gets the base view model for this question
+     *
+     * @param {import('../section.js').Section} section - the current section
+     * @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').PrepQuestionForRenderingOptions} [options] - required to support manage list question
+     * @returns {QuestionViewModel}
+     */
+    prepQuestionForRendering(section: import("../section.js").Section, journey: import("../journey/journey.js").Journey, customViewData?: Record<string, unknown>, payload?: unknown, options?: import("#question-types").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 {import('../journey/journey-response.js').JourneyResponse} response
+     * @param {import('#question-types').PrepQuestionForRenderingOptions} [options]
+     * @returns {Record<string, any>}
+     */
+    answerObjectFromJourneyResponse(response: import("../journey/journey-response.js").JourneyResponse, { params, manageListQuestion }?: import("#question-types").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: import("express").Response, viewModel: 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
+     */
+    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;
+    /**
+     * Get the data to save from the request, returns an object of answers
+     *
+     * @param {import('express').Request} req
+     * @param {import('../journey/journey-response.js').JourneyResponse} journeyResponse - current journey response
+     * @returns {Promise<{ answers: Record<string, unknown> }>}
+     */ getDataToSave(req: import("express").Request, journeyResponse: import("../journey/journey-response.js").JourneyResponse): Promise<{
+        answers: Record<string, unknown>;
+    }>;
+    /**
+     * check for errors after saving, by default this does nothing
+     * @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;
+    /**
+     * Handles redirect after saving. Kept around for backwards compatibility.
+     *
+     * @param {import('express').Response} res
+     * @param {import('../journey/journey.js').Journey} journey
+     * @param {string} sectionSegment
+     * @param {string} questionSegment
+     * @returns {void}
+     * @deprecated - use `journey.redirectToNextQuestion`
+     */
+    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 {import('../journey/journey.js').Journey} journey
+     * @param {Object} answer
+     * @returns {Array<{
+     *   key: string;
+     *   value: string | Object;
+     *   action?: ActionView | ActionView[];
+     * }>}
+     */
+    formatAnswerForSummary(sectionSegment: string, journey: import("../journey/journey.js").Journey, answer: Object, capitals?: boolean): Array<{
+        key: string;
+        value: string | Object;
+        action?: ActionView | ActionView[];
+    }>;
+    /**
+     * Returns the action link for the question
+     * @param {Object} answer
+     * @param {import('../journey/journey.js').Journey} journey
+     * @param {String} sectionSegment
+     * @returns {ActionView|ActionView[]|undefined}
+     */
+    getAction(sectionSegment: string, journey: import("../journey/journey.js").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 {import('../journey/journey-response.js').JourneyResponse} journeyResponse
+     * @param {string} [fieldName] optional fieldname for multi field input questions
+     * @returns {boolean}
+     */
+    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/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;;;;GAIG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;GAWG;AAEH;;;GAGG;AACH;IA4DC;;;OAGG;IACH,yLAHW,OAAO,iBAAiB,EAAE,kBAAkB,oBAC5C,MAAM,CAAC,MAAM,WAAW,EAsDlC;IAnHD,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,aAAa,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;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;;;;;;;;;;;;;;OAcG;IACH,uFARG;QAAmE,MAAM,EAAjE,OAAO,6BAA6B,EAAE,WAAW;QACS,kBAAkB;QACnC,OAAO,EAAhD,OAAO,eAAe,EAAE,OAAO;QACkB,OAAO,EAAxD,OAAO,uBAAuB,EAAE,OAAO;QACL,cAAc;QAC9B,OAAO,GAAzB,OAAO;KACf,GAAU,iBAAiB,CAS7B;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,iBAAiB,EAAE,+BAA+B,GACvD,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,OAAO,gCAAgC,EAAE,eAAe,mCACxD,OAAO,iBAAiB,EAAE,+BAA+B,GACvD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAc/B;IAED;;;;;OAKG;IACH,kBAJW,OAAO,SAAS,EAAE,QAAQ,aAC1B,iBAAiB,GACf,IAAI,CAShB;IAED;;;;;;;OAOG;IACH,8BANW,OAAO,SAAS,EAAE,OAAO,WAEzB,OAAO,eAAe,EAAE,OAAO,WAD/B,OAAO,uBAAuB,EAAE,OAAO,gFAGrC,iBAAiB,GAAC,SAAS,CAmBvC;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,iBAAiB,GAAG,SAAS,CAIzC;IAED;;;;;;;;;OASG;IACH,wBAPW,OAAO,SAAS,EAAE,QAAQ,WAC1B,OAAO,uBAAuB,EAAE,OAAO,kBACvC,MAAM,mBACN,MAAM,GACJ,IAAI,CAQhB;IAED;;;;;;;;;;OAUG;IACH,wDARW,OAAO,uBAAuB,EAAE,OAAO,UACvC,MAAM,uBACJ,KAAK,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;KACpC,CAAC,CAaJ;IAED;;;;;;OAMG;IACH,2CAJW,OAAO,uBAAuB,EAAE,OAAO,UADvC,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,OAAO,gCAAgC,EAAE,eAAe,cACxD,MAAM,GACJ,OAAO,CAInB;CACD;;WAlda,MAAM;cACN,MAAM;eACN,MAAM;eACN,MAAM;;;;gCAMP,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;mCAhBA,iBAAiB;gCAEpB,qBAAqB;gCADrB,kBAAkB"}

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

@@ -0,0 +1,3 @@
+/** @type {Record<string, import('./question').Question>} */
+export const questionClasses: Record<string, any>;
+//# sourceMappingURL=questions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"questions.d.ts","sourceRoot":"","sources":["../../../src/questions/questions.js"],"names":[],"mappings":"AAsBA,4DAA4D;AAC5D,8BADW,MAAM,CAAC,MAAM,EAAE,GAA6B,CAAC,CAkBrD"}

package/types/src/section.d.ts

@@ -0,0 +1,107 @@
+/**
+ * A value indicating the final question of a section has been reached
+ *
+ * @type {Symbol}
+ */
+export const END_OF_SECTION: Symbol;
+/**
+ * Defines a section for a questionnaire, a set of Questions
+ * @class
+ */
+export class Section {
+    /**
+     * Implementation of getNextQuestion given a list of questions
+     *
+     * @param {import('./section-types.d.ts').StaticGetNextQuestionParams} params
+     * @returns {Question|Symbol|null}
+     */
+    static getNextQuestion({ questions, questionFieldName, response, takeNextQuestion, reverse }: import("./section-types.d.ts").StaticGetNextQuestionParams): Question | Symbol | null;
+    /**
+     * creates an instance of a section
+     * @param {string} name
+     * @param {string} segment
+     */
+    constructor(name: string, segment: string);
+    /**
+     * @type {string} - the display name of the section shown to user
+     */
+    name: string;
+    /**
+     * @type {string} - the unique url segment for the section
+     */
+    segment: string;
+    /**
+     * @type {Array<Question>} - questions within the section
+     */
+    questions: Array<Question>;
+    /**
+     * Add a condition to all questions in this section
+     *
+     * @param {QuestionCondition} shouldIncludeSection
+     * @returns {Section}
+     */
+    withSectionCondition(shouldIncludeSection: QuestionCondition): Section;
+    /**
+     * Fluent API method for adding questions
+     * @param {import('#src/questions/question.js').Question} question
+     * @param {import('#src/components/manage-list/manage-list-section.js').ManageListSection} [manageListSection]
+     * @returns {Section}
+     */
+    addQuestion(question: import("#src/questions/question.js").Question, manageListSection?: import("#src/components/manage-list/manage-list-section.js").ManageListSection): Section;
+    /**
+     * Fluent API method for attaching conditions to the previously added question
+     * @param {QuestionCondition} shouldIncludeQuestion
+     * @returns {Section}
+     */
+    withCondition(shouldIncludeQuestion: QuestionCondition): Section;
+    withRequiredCondition(isQuestionMandatory: any, requiredFieldErrorMsg: any): this;
+    /**
+     * Fluent API method for starting a multi question condition
+     * @param {string} conditionName
+     * @param {QuestionCondition} shouldIncludeQuestion
+     * @returns {Section}
+     */
+    startMultiQuestionCondition(conditionName: string, shouldIncludeQuestion: QuestionCondition): Section;
+    /**
+     * Fluent API method for ending a multi question condition
+     * @param {string} conditionName
+     * @returns {Section}
+     */
+    endMultiQuestionCondition(conditionName: string): Section;
+    /**
+     * Get the next question in this section given a questionParam (question fieldName)
+     * @param {import('./section-types.d.ts').GetNextQuestionParams} params
+     * @returns {Question|Symbol|null}
+     */
+    getNextQuestion(params: import("./section-types.d.ts").GetNextQuestionParams): Question | Symbol | null;
+    /**
+     * checks answers on response to ensure that a answer is provided for each required question in the section
+     * @param {JourneyResponse} journeyResponse
+     * @returns {SectionStatus}
+     */
+    getStatus(journeyResponse: JourneyResponse): SectionStatus;
+    /**
+     * checks answers on response and return true if the status of the section is complete
+     * @param {JourneyResponse} journeyResponse
+     * @returns {boolean}
+     */
+    isComplete(journeyResponse: JourneyResponse): boolean;
+    #private;
+}
+export type SECTION_STATUS = SectionStatus;
+/**
+ * @typedef {string} SectionStatus
+ */
+/**
+ * @enum {SectionStatus}
+ */
+export const SECTION_STATUS: Readonly<{
+    NOT_STARTED: "Not started";
+    IN_PROGRESS: "In progress";
+    COMPLETE: "Completed";
+}>;
+export type Question = any;
+export type JourneyResponse = any;
+export type QuestionCondition = ((response: JourneyResponse) => boolean);
+export type SectionStatus = string;
+//# sourceMappingURL=section.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"section.d.ts","sourceRoot":"","sources":["../../src/section.js"],"names":[],"mappings":"AASA;;;;GAIG;AACH,6BAFU,MAAM,CAEuC;AAEvD;;;GAGG;AACH;IAgNC;;;;;OAKG;IACH,8FAHW,OAAO,sBAAsB,EAAE,2BAA2B,GACxD,QAAQ,GAAC,MAAM,GAAC,IAAI,CAoBhC;IAvMD;;;;OAIG;IACH,kBAHW,MAAM,WACN,MAAM,EAKhB;IAxCD;;OAEG;IACH,MAFU,MAAM,CAEX;IAEL;;OAEG;IACH,SAFU,MAAM,CAER;IAER;;OAEG;IACH,WAFU,KAAK,CAAC,QAAQ,CAAC,CAEV;IA6Bf;;;;;OAKG;IACH,2CAHW,iBAAiB,GACf,OAAO,CAcnB;IAED;;;;;OAKG;IACH,sBAJW,OAAO,4BAA4B,EAAE,QAAQ,sBAC7C,OAAO,oDAAoD,EAAE,iBAAiB,GAC5E,OAAO,CAgBnB;IA8BD;;;;OAIG;IACH,qCAHW,iBAAiB,GACf,OAAO,CAanB;IAED,kFAoBC;IAED;;;;;OAKG;IACH,2CAJW,MAAM,yBACN,iBAAiB,GACf,OAAO,CAQnB;IAED;;;;OAIG;IACH,yCAHW,MAAM,GACJ,OAAO,CAQnB;IAED;;;;OAIG;IACH,wBAHW,OAAO,sBAAsB,EAAE,qBAAqB,GAClD,QAAQ,GAAC,MAAM,GAAC,IAAI,CAuBhC;IA4BD;;;;OAIG;IACH,2BAHW,eAAe,GACb,aAAa,CAoDzB;IAED;;;;OAIG;IACH,4BAHW,eAAe,GACb,OAAO,CAInB;;CAKD;6BAOS,aAAa;AALvB;;GAEG;AAEH;;GAEG;AACH;;;;GAIG;;;gCA7UU,CAAC,CAAC,QAAQ,EAAE,eAAe,KAAK,OAAO,CAAC;4BAmUxC,MAAM"}