@planning-inspectorate/dynamic-forms 3.10.10 → 3.10.12

package/package.json

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

package/src/questions/question.js

@@ -99,7 +99,7 @@ export class Question {
 	_isInManageListSection = false;
 
 	/**
-	 * @param {import('#question-types').QuestionParameters} params
+	 * @param {import('./question-types.js').QuestionParameters} params
 	 * @param {Record<string, Function>} [methodOverrides]
 	 */
 	constructor(
@@ -214,7 +214,7 @@ 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').PrepQuestionForRenderingOptions} [options] - required to support manage list question
+	 * @param {import('./question-types.js').PrepQuestionForRenderingOptions} [options] - required to support manage list question
 	 * @returns {QuestionViewModel}
 	 */
 	prepQuestionForRendering(section, journey, customViewData, payload, options) {
@@ -282,7 +282,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').PrepQuestionForRenderingOptions} [options]
+	 * @param {import('./question-types.js').PrepQuestionForRenderingOptions} [options]
 	 * @returns {Record<string, any>}
 	 */
 	answerObjectFromJourneyResponse(response, { params, manageListQuestion } = {}) {

package/src/section.js

@@ -83,8 +83,8 @@ export class 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]
+	 * @param {import('./questions/question.js').Question} question
+	 * @param {import('./components/manage-list/manage-list-section.js').ManageListSection} [manageListSection]
 	 * @returns {Section}
 	 */
 	addQuestion(question, manageListSection) {

package/types/commitlint.config.d.ts

@@ -0,0 +1,7 @@
+declare namespace _default {
+    let _extends: string[];
+    export { _extends as extends };
+    export let ignores: ((commit: any) => any)[];
+}
+export default _default;
+//# sourceMappingURL=commitlint.config.d.ts.map

package/types/commitlint.config.d.ts.map

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

package/types/eslint.config.d.ts

@@ -0,0 +1,95 @@
+declare const _default: ({
+    readonly rules: Readonly<import("eslint").Linter.RulesRecord>;
+} | {
+    ignores: string[];
+    languageOptions: {
+        ecmaVersion: number;
+        sourceType: string;
+        globals: {
+            __dirname: false;
+            __filename: false;
+            AbortController: false;
+            AbortSignal: false;
+            AsyncDisposableStack: false;
+            atob: false;
+            Blob: false;
+            BroadcastChannel: false;
+            btoa: false;
+            Buffer: false;
+            ByteLengthQueuingStrategy: false;
+            clearImmediate: false;
+            clearInterval: false;
+            clearTimeout: false;
+            CloseEvent: false;
+            CompressionStream: false;
+            console: false;
+            CountQueuingStrategy: false;
+            crypto: false;
+            Crypto: false;
+            CryptoKey: false;
+            CustomEvent: false;
+            DecompressionStream: false;
+            DisposableStack: false;
+            DOMException: false;
+            ErrorEvent: false;
+            Event: false;
+            EventTarget: false;
+            exports: true;
+            fetch: false;
+            File: false;
+            FormData: false;
+            global: false;
+            Headers: false;
+            localStorage: false;
+            MessageChannel: false;
+            MessageEvent: false;
+            MessagePort: false;
+            module: false;
+            navigator: false;
+            Navigator: false;
+            performance: false;
+            Performance: false;
+            PerformanceEntry: false;
+            PerformanceMark: false;
+            PerformanceMeasure: false;
+            PerformanceObserver: false;
+            PerformanceObserverEntryList: false;
+            PerformanceResourceTiming: false;
+            process: false;
+            queueMicrotask: false;
+            ReadableByteStreamController: false;
+            ReadableStream: false;
+            ReadableStreamBYOBReader: false;
+            ReadableStreamBYOBRequest: false;
+            ReadableStreamDefaultController: false;
+            ReadableStreamDefaultReader: false;
+            Request: false;
+            require: false;
+            Response: false;
+            sessionStorage: false;
+            setImmediate: false;
+            setInterval: false;
+            setTimeout: false;
+            Storage: false;
+            structuredClone: false;
+            SubtleCrypto: false;
+            SuppressedError: false;
+            TextDecoder: false;
+            TextDecoderStream: false;
+            TextEncoder: false;
+            TextEncoderStream: false;
+            TransformStream: false;
+            TransformStreamDefaultController: false;
+            URL: false;
+            URLPattern: false;
+            URLSearchParams: false;
+            WebAssembly: false;
+            WebSocket: false;
+            WritableStream: false;
+            WritableStreamDefaultController: false;
+            WritableStreamDefaultWriter: false;
+        };
+    };
+})[];
+export default _default;
+//# sourceMappingURL=eslint.config.d.ts.map

package/types/eslint.config.d.ts.map

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

package/types/move-types.d.ts

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

package/types/move-types.d.ts.map

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

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

@@ -0,0 +1,36 @@
+export class AddressQuestion extends Question {
+    /**
+     * @param {import('#question-types').QuestionParameters} params
+     */
+    constructor(params: import("#question-types").QuestionParameters);
+    requiredFields: {
+        addressLine1: boolean;
+        addressLine2: boolean;
+        townCity: boolean;
+        county: boolean;
+        postcode: boolean;
+    } | undefined;
+    addressLabels: {
+        addressLine1: string;
+        addressLine2: string;
+        townCity: string;
+        county: string;
+        postcode: string;
+    };
+    /**
+     * @param {Record<string, any>} answers
+     * @returns {*|string}
+     */
+    answerForViewModel(answers: Record<string, any>): any | string;
+    /**
+     * @param {Object<string, any>} answer
+     * @returns The formatted address to be presented in the UI
+     */
+    format(answer: {
+        [x: string]: any;
+    }): string;
+    formatLabelFromRequiredFields(fieldName: any): "" | " (optional)";
+}
+export default AddressQuestion;
+import { Question } from '#question';
+//# sourceMappingURL=question.d.ts.map

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

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

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

@@ -0,0 +1,52 @@
+export const BOOLEAN_OPTIONS: Readonly<{
+    YES: "yes";
+    NO: "no";
+}>;
+export function yesNoToBoolean(value: string | any): boolean;
+export function booleanToYesNoValue(value: any): "yes" | "no";
+export function booleanToYesNoOrNull(value: boolean | null): string | null;
+export class BooleanQuestion extends RadioQuestion {
+    /**
+     * @param {Object} params
+     * @param {string} params.title
+     * @param {string} params.question
+     * @param {string} params.fieldName
+     * @param {string} [params.url]
+     * @param {string} [params.hint]
+     * @param {string} [params.pageTitle]
+     * @param {string} [params.description]
+     * @param {string} [params.html]
+     * @param {string} [params.interfaceType]
+     * @param {Array.<import('../../questions/options-question.js').Option>} [params.options]
+     * @param {Array.<import('#base-validator').BaseValidator>} [params.validators]
+     * @param {boolean} [params.editable]
+     * @param {import('#question-types').QuestionParameters['viewData']} [params.viewData]
+     */
+    constructor({ title, question, fieldName, url, hint, pageTitle, description, html, validators, interfaceType, options, editable, viewData }: {
+        title: string;
+        question: string;
+        fieldName: string;
+        url?: string | undefined;
+        hint?: string | undefined;
+        pageTitle?: string | undefined;
+        description?: string | undefined;
+        html?: string | undefined;
+        interfaceType?: string | undefined;
+        options?: import("../../questions/options-question.js").Option[] | undefined;
+        validators?: import("#base-validator").BaseValidator[] | undefined;
+        editable?: boolean | undefined;
+        viewData?: import("#question-types").QuestionParameters["viewData"];
+    });
+    interfaceType: string;
+    /**
+     * Get the data to save from the request, returns an object of answers
+     * @param {import('express').Request} req
+     * @param {JourneyResponse} journeyResponse - current journey response, modified with the new answers
+     * @returns {Promise<{ answers: Record<string, unknown> }>}
+     */ getDataToSave(req: import("express").Request, journeyResponse: JourneyResponse): Promise<{
+        answers: Record<string, unknown>;
+    }>;
+}
+export default BooleanQuestion;
+import RadioQuestion from '../radio/question.js';
+//# sourceMappingURL=question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/boolean/question.js"],"names":[],"mappings":"AAEA;;;GAGG;AAMI,sCAHI,MAAM,GAAC,GAAC,GACN,OAAO,CAOnB;AAEM,8DAEN;AAMM,4CAHI,OAAO,GAAC,IAAI,GACV,MAAM,GAAC,IAAI,CAOvB;AAED;IACC;;;;;;;;;;;;;;;OAeG;IACH,6IAdG;QAAuB,KAAK,EAApB,MAAM;QACS,QAAQ,EAAvB,MAAM;QACS,SAAS,EAAxB,MAAM;QACU,GAAG;QACH,IAAI;QACJ,SAAS;QACT,WAAW;QACX,IAAI;QACJ,aAAa;QACyC,OAAO;QACpB,UAAU;QAClD,QAAQ;QACyC,QAAQ,GAA1E,OAAO,iBAAiB,EAAE,kBAAkB,CAAC,UAAU,CAAC;KAAmB,EAmDrF;IADA,sBAAkC;IAGnC;;;;;OAKG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,eAAe,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAezD;CACD;;0BAzHyB,sBAAsB"}

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

@@ -0,0 +1,52 @@
+/**
+ * @typedef ConditionalAnswerObject
+ * @type {object}
+ * @property {string} value the checkbox answer
+ * @property {string} conditional the conditional text input
+ */
+export class CheckboxQuestion extends OptionsQuestion {
+    /**
+     * @param {Object} params
+     * @param {string} params.title
+     * @param {string} params.question
+     * @param {string} params.fieldName
+     * @param {string} [params.url]
+     * @param {string} [params.pageTitle]
+     * @param {string} [params.description]
+     * @param {Array.<import('../../questions/options-question.js').Option>} params.options
+     * @param {Array.<import('#base-validator').BaseValidator>} [params.validators]
+     * @param {import('#question-types').QuestionParameters['viewData']} [params.viewData]
+     */
+    constructor({ title, question, fieldName, url, pageTitle, description, options, validators, viewData }: {
+        title: string;
+        question: string;
+        fieldName: string;
+        url?: string | undefined;
+        pageTitle?: string | undefined;
+        description?: string | undefined;
+        options: Array<import("../../questions/options-question.js").Option>;
+        validators?: import("#base-validator").BaseValidator[] | undefined;
+        viewData?: import("#question-types").QuestionParameters["viewData"];
+    });
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     * @param {string | ConditionalAnswerObject } answer will be a single value string, a comma-separated string representing multiple values (one of which may be a conditional) or a single ConditionalAnswerObject
+     * @param {import('#journey').Journey} journey
+     * @param {String} sectionSegment
+     * @returns {Array.<Object>}
+     */
+    formatAnswerForSummary(sectionSegment: string, journey: import("#journey").Journey, answer: string | ConditionalAnswerObject): Array<Object>;
+}
+export default CheckboxQuestion;
+export type ConditionalAnswerObject = {
+    /**
+     * the checkbox answer
+     */
+    value: string;
+    /**
+     * the conditional text input
+     */
+    conditional: string;
+};
+import OptionsQuestion from '../../questions/options-question.js';
+//# sourceMappingURL=question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/checkbox/question.js"],"names":[],"mappings":"AAKA;;;;;GAKG;AAEH;IACC;;;;;;;;;;;OAWG;IACH,wGAVG;QAAuB,KAAK,EAApB,MAAM;QACS,QAAQ,EAAvB,MAAM;QACS,SAAS,EAAxB,MAAM;QACU,GAAG;QACH,SAAS;QACT,WAAW;QAC0C,OAAO,EAA5E,KAAK,CAAE,OAAO,qCAAqC,EAAE,MAAM,CAAC;QACH,UAAU;QACD,QAAQ,GAA1E,OAAO,iBAAiB,EAAE,kBAAkB,CAAC,UAAU,CAAC;KAAmB,EAiBrF;IAED;;;;;;OAMG;IACH,wDAJW,OAAO,UAAU,EAAE,OAAO,UAD1B,MAAM,GAAG,uBAAuB,GAG9B,KAAK,CAAE,MAAM,CAAC,CAuC1B;CACD;;;;;;WA/Ea,MAAM;;;;iBACN,MAAM;;4BATQ,qCAAqC"}

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

@@ -0,0 +1,23 @@
+/**
+ * @class
+ */
+export class DateQuestion extends Question {
+    /**
+     * @param {import('#question-types').QuestionParameters} params
+     * @param {string} [params.dateFormat]
+     */
+    constructor({ dateFormat, ...params }: import("#question-types").QuestionParameters);
+    dateFormat: any;
+    /**
+     * Get the data to save from the request, returns an object of answers
+     * @param {import('express').Request} req
+     * @param {import('#journey-response').JourneyResponse} journeyResponse - current journey response, modified with the new answers
+     * @returns {Promise.<Object>}
+     */ getDataToSave(req: import("express").Request, journeyResponse: import("#journey-response").JourneyResponse): Promise<Object>;
+    answerForViewModel(answers: any, isPayload: any): {
+        [x: string]: any;
+    };
+}
+export default DateQuestion;
+import { Question } from '../../questions/question.js';
+//# sourceMappingURL=question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/date/question.js"],"names":[],"mappings":"AAKA;;GAEG;AACH;IACC;;;OAGG;IACH,uCAHW,OAAO,iBAAiB,EAAE,kBAAkB,EAStD;IADA,gBAA4B;IAG7B;;;;;OAKG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,OAAO,mBAAmB,EAAE,eAAe,GACzC,OAAO,CAAE,MAAM,CAAC,CAY5B;IAED;;MAwBC;CAoBD;;yBAlFwB,6BAA6B"}

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

@@ -0,0 +1,35 @@
+/**
+ * Represents a date period, two dates which make up a period or range
+ * @class
+ */
+export class DatePeriodQuestion extends Question {
+    /**
+     * @param {import('#question-types').QuestionParameters} params
+     * @param {string} [params.dateFormat]
+     * @param {{start: string, end: string}} [params.labels]
+     * @param {string} [params.hint]
+     * @param {string} [params.hintStart]
+     * @param {string} [params.hintEnd]
+     * @param {{hour: number, minute: number, second: number}} [params.startTime]
+     * @param {{hour: number, minute: number, second: number}} [params.endTime]
+     */
+    constructor({ dateFormat, hint, labels, hintStart, startTime, hintEnd, endTime, ...params }: import("#question-types").QuestionParameters);
+    dateFormat: any;
+    labels: any;
+    hintStart: any;
+    hintEnd: any;
+    startTime: any;
+    endTime: any;
+    /**
+     * Get the data to save from the request, returns an object of answers
+     * @param {import('express').Request} req
+     * @param {import('#journey-response').JourneyResponse} journeyResponse - current journey response, modified with the new answers
+     * @returns {Promise.<Object>}
+     */ getDataToSave(req: import("express").Request, journeyResponse: import("#journey-response").JourneyResponse): Promise<Object>;
+    answerForViewModel(answers: any, isPayload: any): {
+        [x: string]: any;
+    };
+}
+export default DatePeriodQuestion;
+import { Question } from '#question';
+//# sourceMappingURL=question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/date-period/question.js"],"names":[],"mappings":"AAOA;;;GAGG;AACH;IACC;;;;;;;;;OASG;IACH,6FATW,OAAO,iBAAiB,EAAE,kBAAkB,EAqBtD;IAPA,gBAA4B;IAC5B,YAAsD;IAEtD,eAA0B;IAC1B,aAAsB;IACtB,eAA+D;IAC/D,aAA2D;IAG5D;;;;;OAKG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,OAAO,mBAAmB,EAAE,eAAe,GACzC,OAAO,CAAE,MAAM,CAAC,CAgC5B;IAED;;MAuCC;CAyCD;;yBAzJwB,WAAW"}

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

@@ -0,0 +1,25 @@
+export class DateTimeQuestion extends Question {
+    static AM: string;
+    static PM: string;
+    /**
+     * @param {import('#question-types').QuestionParameters} params
+     * @param {string} [params.dateFormat]
+     * @param {string} [params.timeFormat]
+     */
+    constructor({ dateFormat, timeFormat, ...params }: import("#question-types").QuestionParameters);
+    dateFormat: any;
+    timeFormat: any;
+    /**
+     * Get the data to save from the request, returns an object of answers
+     * @param {import('express').Request} req
+     * @param {JourneyResponse} journeyResponse - current journey response, modified with the new answers
+     * @returns {Promise.<Object>}
+     */ getDataToSave(req: import("express").Request, journeyResponse: JourneyResponse): Promise<Object>;
+    answerForViewModel(answers: any, isPayload: any): {
+        [x: string]: any;
+    };
+    #private;
+}
+export default DateTimeQuestion;
+import { Question } from '../../questions/question.js';
+//# sourceMappingURL=question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/date-time/question.js"],"names":[],"mappings":"AAMA;IACC,kBAAiB;IACjB,kBAAiB;IAEjB;;;;OAIG;IACH,mDAJW,OAAO,iBAAiB,EAAE,kBAAkB,EAWtD;IAFA,gBAA4B;IAC5B,gBAA4B;IAG7B;;;;;OAKG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,eAAe,GACb,OAAO,CAAE,MAAM,CAAC,CAqB5B;IAED;;MAqCC;;CAoCD;;yBA5HwB,6BAA6B"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/email/question.js"],"names":[],"mappings":"AAEA;;;;;;GAMG;AAEH;;;;GAIG;AACH;IA2BC;;;;;;;OAOG;IACH,uCALW,MAAM,WACN,OAAO,UAAU,EAAE,OAAO,UAC1B,MAAM,SAMhB;CACD;;gCAnDY,OAAO,WAAW,EAAE,iBAAiB;sBACrC,OAAO,UAAU,EAAE,OAAO;8BAC1B,OAAO,mBAAmB,EAAE,eAAe;;;oCALpB,kCAAkC"}

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

@@ -0,0 +1,16 @@
+export class IdentifierQuestion extends Question {
+    /**
+     * @param {import('#question-types').QuestionParameters} params
+     * @param {string} [params.inputClasses] css class string to be added to the input
+     * @param {string|undefined} [params.label] if defined this show as a label for the input and the question will just be a standard h1
+     */
+    constructor({ inputClasses, label, ...params }: import("#question-types").QuestionParameters);
+    /** @type {string|undefined} page h1, optional, will default to use question's label */
+    pageHeading: string | undefined;
+    /** @type {string} css classes to apply to input element */
+    inputClasses: string;
+    label: any;
+}
+export default IdentifierQuestion;
+import { Question } from '#question';
+//# sourceMappingURL=question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/identifier/question.js"],"names":[],"mappings":"AAEA;IAMC;;;;OAIG;IACH,gDAJW,OAAO,iBAAiB,EAAE,kBAAkB,EAYtD;IAlBD,uFAAuF;IACvF,aADW,MAAM,GAAC,SAAS,CACf;IACZ,2DAA2D;IAC3D,cADW,MAAM,CACJ;IAcZ,WAAkB;CAUnB;;yBA9BwB,WAAW"}

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

@@ -0,0 +1,10 @@
+/**
+ *
+ * @type {Readonly<{ADD: string, EDIT: string, REMOVE: string}>}
+ */
+export const MANAGE_LIST_ACTIONS: Readonly<{
+    ADD: string;
+    EDIT: string;
+    REMOVE: string;
+}>;
+//# sourceMappingURL=manage-list-actions.d.ts.map

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * Extends the Section class for extra logic around managing lists.
+ */
+export class ManageListSection extends Section {
+    constructor();
+    /**
+     * Is this section a manage list section?
+     *
+     * Used by controller and other logic.
+     *
+     * @returns {boolean}
+     */
+    get isManageListSection(): boolean;
+}
+import { Section } from '#src/section.js';
+//# sourceMappingURL=manage-list-section.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"manage-list-section.d.ts","sourceRoot":"","sources":["../../../../src/components/manage-list/manage-list-section.js"],"names":[],"mappings":"AAEA;;GAEG;AACH;IACC,cAEC;IAED;;;;;;OAMG;IACH,2BAFa,OAAO,CAInB;CAmBD;wBAtCuB,iBAAiB"}

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

@@ -0,0 +1,49 @@
+/**
+ * @typedef {Object} ManageListQuestionParameters
+ * @property {string} titleSingular - the single name of the list item, e.g. "Holiday activity"
+ * @property {boolean} [showManageListQuestions] - whether to show the question titles as well as answers on the manage list summary page
+ * @property {boolean} [showAnswersInSummary] - whether to show the answers on the main check-your-answers page (or just a count)
+ * @property {string} [confirmationQuestion] - the name of the confirmation question to use when removing an item, default 'confirm'
+ */
+export class ManageListQuestion extends Question {
+    /**
+     * @param {import('#question-types').QuestionParameters & ManageListQuestionParameters} params
+     */
+    constructor(params: import("#question-types").QuestionParameters & ManageListQuestionParameters);
+    get confirmationQuestionParam(): string;
+    getDataToSave(req: any, journeyResponse: any): Promise<{
+        answers: {
+            [x: string]: any;
+        };
+    }>;
+    formatAnswerForSummary(sectionSegment: any, journey: any, answer: any): {
+        key: string;
+        value: string;
+        action: import("../../controller.js").ActionView | import("../../controller.js").ActionView[] | undefined;
+    }[];
+    renderConfirmationAction(res: any, itemToRemove: any, viewModel: any): void;
+    set section(section: import("../../section.js").Section);
+    get section(): import("../../section.js").Section;
+    #private;
+}
+export default ManageListQuestion;
+export type ManageListQuestionParameters = {
+    /**
+     * - the single name of the list item, e.g. "Holiday activity"
+     */
+    titleSingular: string;
+    /**
+     * - whether to show the question titles as well as answers on the manage list summary page
+     */
+    showManageListQuestions?: boolean | undefined;
+    /**
+     * - whether to show the answers on the main check-your-answers page (or just a count)
+     */
+    showAnswersInSummary?: boolean | undefined;
+    /**
+     * - the name of the confirmation question to use when removing an item, default 'confirm'
+     */
+    confirmationQuestion?: string | undefined;
+};
+import { Question } from '#question';
+//# sourceMappingURL=question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/manage-list/question.js"],"names":[],"mappings":"AAKA;;;;;;GAMG;AAEH;IAOC;;OAEG;IACH,oBAFW,OAAO,iBAAiB,EAAE,kBAAkB,GAAG,4BAA4B,EAerF;IAcD,wCAEC;IAyDD;;;;OAMC;IAED;;;;QAsBC;IAED,4EAQC;IAoCD,yDAEC;IATD,kDAKC;;CAKD;;;;;;mBArLa,MAAM;;;;;;;;;;;;;;yBAPK,WAAW"}

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

@@ -0,0 +1,18 @@
+/**
+ *
+ * @param {import('../../journey/journey-response.js').JourneyResponse} response
+ * @param {import('./question.js')} manageListQuestion
+ * @param {string} manageListItemId
+ * @returns {Record<string, unknown>}
+ */
+export function answerObjectForManageList(response: import("../../journey/journey-response.js").JourneyResponse, manageListQuestion: typeof import("./question.js"), manageListItemId: string): Record<string, unknown>;
+/**
+ * Similar to answerObjectForManageList but will edit response and add a new array entry if not found
+ *
+ * @param {import('../../journey/journey-response.js').JourneyResponse} response
+ * @param {import('./question.js')} manageListQuestion
+ * @param {import('../../journey/journey-types.js').RouteParams} params
+ * @returns {import('../../journey/journey-types.js').ManageListAnswers}
+ */
+export function answerObjectForManageListSaving(response: import("../../journey/journey-response.js").JourneyResponse, manageListQuestion: typeof import("./question.js"), params: import("../../journey/journey-types.js").RouteParams): import("../../journey/journey-types.js").ManageListAnswers;
+//# sourceMappingURL=utils.d.ts.map

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

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