@planning-inspectorate/dynamic-forms 3.3.4 → 3.4.0

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

@@ -0,0 +1,106 @@
+/**
+ * @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
+ */
+/**
+ * @typedef {Object} Suffix
+ * @property {string} text
+ * @property {string} [classes] optional property, used to add classes to the suffix/prefix
+ */
+/**
+ * @typedef {Object} InputField
+ * @property {string} fieldName
+ * @property {string} label
+ * @property {string} [formatJoinString] optional property, used by formatAnswerForSummary (eg task list display), effective default to line break
+ * @property {string} [formatPrefix] optional property, used by formatAnswerForSummary (eg task list display), to prefix answer
+ * @property {function} [formatTextFunction] optional property, used to format the answer for display and value in question
+ * @property {Record<string, string>} [attributes] optional property, used to add html attributes to the field
+ * @property {Suffix} [suffix] optional property, used to add a suffix to the field
+ * @property {Suffix} [prefix] optional property, used to add a prefix to the field
+ */
+/**
+ * @class
+ */
+export default class MultiFieldInputQuestion extends Question {
+    /**
+     * @param {import('#question-types').QuestionParameters} params
+     * @param {string|undefined} [params.label] if defined this show as a label for the input and the question will just be a standard h1
+     * @param {Record<string, string>} [params.inputAttributes] html attributes to add to the input
+     * @param {InputField[]} params.inputFields input fields
+     */
+    constructor({ label, inputAttributes, inputFields, ...params }: import("#question-types").QuestionParameters);
+    /** @type {Record<string, string>} */
+    inputAttributes: Record<string, string>;
+    label: any;
+    inputFields: any;
+    answerForViewModel(answers: any): any;
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     * @param {Journey} journey
+     * @param {String} sectionSegment
+     * @returns {Array<{
+     *   key: string;
+     *   value: string | Object;
+     *   action: {
+     *     href: string;
+     *     text: string;
+     *     visuallyHiddenText: string;
+     *   };
+     * }>}
+     */
+    formatAnswerForSummary(sectionSegment: string, journey: Journey): Array<{
+        key: string;
+        value: string | Object;
+        action: {
+            href: string;
+            text: string;
+            visuallyHiddenText: string;
+        };
+    }>;
+    #private;
+}
+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;
+export type Suffix = {
+    text: string;
+    /**
+     * optional property, used to add classes to the suffix/prefix
+     */
+    classes?: string | undefined;
+};
+export type InputField = {
+    fieldName: string;
+    label: string;
+    /**
+     * optional property, used by formatAnswerForSummary (eg task list display), effective default to line break
+     */
+    formatJoinString?: string | undefined;
+    /**
+     * optional property, used by formatAnswerForSummary (eg task list display), to prefix answer
+     */
+    formatPrefix?: string | undefined;
+    /**
+     * optional property, used to format the answer for display and value in question
+     */
+    formatTextFunction?: Function | undefined;
+    /**
+     * optional property, used to add html attributes to the field
+     */
+    attributes?: Record<string, string> | undefined;
+    /**
+     * optional property, used to add a suffix to the field
+     */
+    suffix?: Suffix | undefined;
+    /**
+     * optional property, used to add a prefix to the field
+     */
+    prefix?: Suffix | undefined;
+};
+import { Question } from '#question';
+//# sourceMappingURL=question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/multi-field-input/question.js"],"names":[],"mappings":"AAIA;;;;;;GAMG;AAEH;;;;GAIG;AAEH;;;;;;;;;;GAUG;AAEH;;GAEG;AACH;IAIC;;;;;OAKG;IACH,gEALW,OAAO,iBAAiB,EAAE,kBAAkB,EAkBtD;IAtBD,qCAAqC;IACrC,iBADW,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CACjB;IAaf,WAAkB;IAIjB,iBAA8B;IAMhC,sCAOC;IA8BD;;;;;;;;;;;;;OAaG;IACH,wDAZW,OAAO,GAEL,KAAK,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,kBAAkB,EAAE,MAAM,CAAC;SAC5B,CAAC;KACH,CAAC,CAkBJ;;CAyBD;gCAjJY,OAAO,WAAW,EAAE,iBAAiB;sBACrC,OAAO,UAAU,EAAE,OAAO;8BAC1B,OAAO,mBAAmB,EAAE,eAAe;;;;UAO1C,MAAM;;;;;;;eAMN,MAAM;WACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;yBArBK,WAAW"}

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

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

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

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

package/types/src/components/number-entry/question.d.ts

@@ -0,0 +1,37 @@
+export default class NumberEntryQuestion extends Question {
+    /**
+     * @param {import('#question-types').QuestionParameters} params
+     * @param {string} [params.suffix]
+     * @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({ label, suffix, ...params }: import("#question-types").QuestionParameters);
+    suffix: any;
+    label: any;
+    answerForViewModel(answers: any): string | number;
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     * @param {Object} answer
+     * @param {import('#journey').Journey} journey
+     * @param {String} sectionSegment
+     * @returns {Array<{
+     *   key: string;
+     *   value: string | Object;
+     *   action: {
+     *     href: string;
+     *     text: string;
+     *     visuallyHiddenText: string;
+     *   };
+     * }>}
+     */
+    formatAnswerForSummary(sectionSegment: string, journey: import("#journey").Journey, answer: Object): Array<{
+        key: string;
+        value: string | Object;
+        action: {
+            href: string;
+            text: string;
+            visuallyHiddenText: string;
+        };
+    }>;
+}
+import { Question } from '#question';
+//# sourceMappingURL=question.d.ts.map

package/types/src/components/number-entry/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/number-entry/question.js"],"names":[],"mappings":"AAGA;IACC;;;;OAIG;IACH,0CAJW,OAAO,iBAAiB,EAAE,kBAAkB,EAYtD;IAFA,YAAoB;IACpB,WAAkB;IAGnB,kDAEC;IAUD;;;;;;;;;;;;;;OAcG;IACH,wDAZW,OAAO,UAAU,EAAE,OAAO,UAD1B,MAAM,GAGJ,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,CAIJ;CACD;yBAjDwB,WAAW"}

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

@@ -0,0 +1,53 @@
+export default class RadioQuestion extends OptionsQuestion {
+    /**
+     * @param {Object} params
+     * @param {string} params.title
+     * @param {string} params.question
+     * @param {string} params.fieldName
+     * @param {string} [params.viewFolder]
+     * @param {string} [params.url]
+     * @param {string} [params.hint]
+     * @param {string} [params.pageTitle]
+     * @param {string} [params.description]
+     * @param {string} [params.label]
+     * @param {string} [params.html]
+     * @param {string} [params.legend] - optional legend, used instead of h1
+     * @param {Array.<import('../../questions/options-question.js').Option>} params.options
+     * @param {Array.<import('#base-validator').BaseValidator>} [params.validators]
+     * @param {boolean} [params.editable]
+     * @param {Object<string, any>} [params.viewData]
+     * @param {import('../../questions/question-types.js').ActionLink} [params.actionLink]
+     */
+    constructor({ title, question, fieldName, viewFolder, url, hint, pageTitle, description, label, html, legend, options, validators, actionLink, editable, viewData }: {
+        title: string;
+        question: string;
+        fieldName: string;
+        viewFolder?: string | undefined;
+        url?: string | undefined;
+        hint?: string | undefined;
+        pageTitle?: string | undefined;
+        description?: string | undefined;
+        label?: string | undefined;
+        html?: string | undefined;
+        legend?: string | undefined;
+        options: Array<import("../../questions/options-question.js").Option>;
+        validators?: any[] | undefined;
+        editable?: boolean | undefined;
+        viewData?: {
+            [x: string]: any;
+        } | undefined;
+        actionLink?: import("../../questions/question-types.js").ActionLink | undefined;
+    });
+    label: string | undefined;
+    legend: string | undefined;
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     * @param {Object} answer
+     * @param {Journey} journey
+     * @param {String} sectionSegment
+     * @returns {Array.<Object>}
+     */
+    formatAnswerForSummary(sectionSegment: string, journey: Journey, answer: Object): Array<Object>;
+}
+import OptionsQuestion from '../../questions/options-question.js';
+//# sourceMappingURL=question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/radio/question.js"],"names":[],"mappings":"AAEA;IACC;;;;;;;;;;;;;;;;;;OAkBG;IACH,qKAjBG;QAAuB,KAAK,EAApB,MAAM;QACS,QAAQ,EAAvB,MAAM;QACS,SAAS,EAAxB,MAAM;QACU,UAAU;QACV,GAAG;QACH,IAAI;QACJ,SAAS;QACT,WAAW;QACX,KAAK;QACL,IAAI;QACJ,MAAM;QAC+C,OAAO,EAA5E,KAAK,CAAE,OAAO,qCAAqC,EAAE,MAAM,CAAC;QACH,UAAU;QAClD,QAAQ;QACI,QAAQ;;;QAC2B,UAAU;KAAC,EAuCrF;IAFA,0BAAkB;IAClB,2BAAoB;IAWrB;;;;;;OAMG;IACH,wDAJW,OAAO,UADP,MAAM,GAGJ,KAAK,CAAE,MAAM,CAAC,CAgB1B;CACD;4BA3F2B,qCAAqC"}

package/types/src/components/radio/question.test.d.ts

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

package/types/src/components/radio/question.test.d.ts.map

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

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

@@ -0,0 +1,51 @@
+export default class SelectQuestion extends OptionsQuestion {
+    /**
+     * @param {Object} params
+     * @param {string} params.title
+     * @param {string} params.question
+     * @param {string} params.fieldName
+     * @param {string} [params.viewFolder]
+     * @param {string} [params.url]
+     * @param {string} [params.hint]
+     * @param {string} [params.pageTitle]
+     * @param {string} [params.description]
+     * @param {string} [params.label]
+     * @param {string} [params.html]
+     * @param {string} [params.legend] - optional legend, used instead of h1
+     * @param {Array.<import('../../questions/options-question.js').Option>} params.options
+     * @param {Object<string, any>} [params.viewData]
+     * @param {Array.<import('#base-validator').BaseValidator>} [params.validators]
+     */
+    constructor({ title, question, fieldName, viewFolder, url, hint, pageTitle, description, label, html, legend, options, validators, viewData }: {
+        title: string;
+        question: string;
+        fieldName: string;
+        viewFolder?: string | undefined;
+        url?: string | undefined;
+        hint?: string | undefined;
+        pageTitle?: string | undefined;
+        description?: string | undefined;
+        label?: string | undefined;
+        html?: string | undefined;
+        legend?: string | undefined;
+        options: Array<import("../../questions/options-question.js").Option>;
+        viewData?: {
+            [x: string]: any;
+        } | undefined;
+        validators?: any[] | undefined;
+    });
+    label: string | undefined;
+    legend: string | undefined;
+    /**
+     * returns the formatted answers values to be used to build task list elements
+     * note: only supports a single answer
+     *
+     * @param {Object} answer
+     * @param {Journey} journey
+     * @param {String} sectionSegment
+     * @returns {Array.<Object>}
+     */
+    formatAnswerForSummary(sectionSegment: string, journey: Journey, answer: Object): Array<Object>;
+}
+import OptionsQuestion from '../../questions/options-question.js';
+//# sourceMappingURL=question.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/select/question.js"],"names":[],"mappings":"AAEA;IACC;;;;;;;;;;;;;;;;OAgBG;IACH,+IAfG;QAAuB,KAAK,EAApB,MAAM;QACS,QAAQ,EAAvB,MAAM;QACS,SAAS,EAAxB,MAAM;QACU,UAAU;QACV,GAAG;QACH,IAAI;QACJ,SAAS;QACT,WAAW;QACX,KAAK;QACL,IAAI;QACJ,MAAM;QAC+C,OAAO,EAA5E,KAAK,CAAE,OAAO,qCAAqC,EAAE,MAAM,CAAC;QAC/B,QAAQ;;;QACoB,UAAU;KAAC,EAmC9E;IAFA,0BAAkB;IAClB,2BAAoB;IAWrB;;;;;;;;OAQG;IACH,wDAJW,OAAO,UADP,MAAM,GAGJ,KAAK,CAAE,MAAM,CAAC,CAS1B;CACD;4BAhF2B,qCAAqC"}

package/types/src/components/select/question.test.d.ts

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

package/types/src/components/select/question.test.d.ts.map

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

package/types/src/components/single-line-input/question.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @class
+ */
+export default class SingleLineInputQuestion extends Question {
+    /**
+     * @param {import('#question-types').QuestionParameters} params
+     * @param {string|undefined} [params.label] if defined this show as a label for the input and the question will just be a standard h1
+     * @param {Record<string, string>} [params.inputAttributes] html attributes to add to the input
+     * @param {string} [params.classes] html classes to add to the input
+     */
+    constructor(params: import("#question-types").QuestionParameters);
+    /** @type {Record<string, string>} */
+    inputAttributes: Record<string, string>;
+    label: any;
+    classes: any;
+}
+import { Question } from '#question';
+//# sourceMappingURL=question.d.ts.map

package/types/src/components/single-line-input/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/single-line-input/question.js"],"names":[],"mappings":"AAEA;;GAEG;AACH;IAIC;;;;;OAKG;IACH,oBALW,OAAO,iBAAiB,EAAE,kBAAkB,EActD;IAlBD,qCAAqC;IACrC,iBADW,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CACjB;IAcf,WAAyB;IAEzB,aAAmC;CAepC;yBAtCwB,WAAW"}

package/types/src/components/single-line-input/question.test.d.ts

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

package/types/src/components/single-line-input/question.test.d.ts.map

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

package/types/src/components/text-entry/question.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @import {QuestionViewModel} from '#question'
+ * @import {Journey} from '#journey'
+ * @import {JourneyResponse} from '#journey-response'
+ * @import {Section} from '#section'
+ */
+/**
+ * @typedef {Object} TextEntryCheckbox
+ * @property {string} header
+ * @property {string} text
+ * @property {string} name
+ * @property {string} [errorMessage]
+ */
+/**
+ * @class
+ */
+export default class TextEntryQuestion extends Question {
+    /**
+     * @param {import('#question-types').QuestionParameters} params
+     * @param {TextEntryCheckbox} [params.textEntryCheckbox]
+     * @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({ textEntryCheckbox, label, ...params }: import("#question-types").QuestionParameters);
+    textEntryCheckbox: any;
+    label: any;
+}
+export type TextEntryCheckbox = {
+    header: string;
+    text: string;
+    name: string;
+    errorMessage?: string | undefined;
+};
+import { Question } from '#question';
+//# sourceMappingURL=question.d.ts.map

package/types/src/components/text-entry/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/text-entry/question.js"],"names":[],"mappings":"AACA;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;GAEG;AACH;IACC;;;;OAIG;IACH,qDAJW,OAAO,iBAAiB,EAAE,kBAAkB,EAYtD;IAFA,uBAA0C;IAC1C,WAAkB;CAUnB;;YAhCa,MAAM;UACN,MAAM;UACN,MAAM;;;yBAZK,WAAW"}

package/types/src/components/text-entry/question.test.d.ts

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

package/types/src/components/text-entry/question.test.d.ts.map

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

package/types/src/components/text-entry-redact/question.d.ts

@@ -0,0 +1,42 @@
+export const REDACT_CHARACTER: "\u2588";
+export const TRUNCATED_MAX_LENGTH: 500;
+/**
+ * @class
+ */
+export default class TextEntryRedactQuestion extends Question {
+    /**
+     * @param {import('#question-types').QuestionParameters} params
+     * @param {import('../text-entry/question.js').TextEntryCheckbox} [params.textEntryCheckbox]
+     * @param {string|undefined} [params.label] if defined this show as a label for the input and the question will just be a standard h1
+     * @param {boolean} [params.onlyShowRedactedValueForSummary] whether to only show redacted value for summary
+     * @param {boolean} [params.useRedactedFieldNameForSave] whether to use the redacted field name when saving answers
+     * @param {boolean} [params.showSuggestionsUi] use the suggestions UI for this question
+     * @param {string} [params.summaryText] summaryText to use with the details component
+     * @param {boolean} [params.shouldTruncateSummary] determines whether redacted comment is truncated in summary view
+     */
+    constructor({ textEntryCheckbox, label, onlyShowRedactedValueForSummary, useRedactedFieldNameForSave, showSuggestionsUi, summaryText, shouldTruncateSummary, ...params }: import("#question-types").QuestionParameters);
+    textEntryCheckbox: any;
+    label: any;
+    onlyShowRedactedValueForSummary: any;
+    useRedactedFieldNameForSave: any;
+    showSuggestionsUi: any;
+    summaryText: any;
+    shouldTruncateSummary: any;
+    prepQuestionForRendering(section: any, journey: any, customViewData: any, payload: any, options: any): import("#question").QuestionViewModel;
+    answerForViewModel(answers: any): string;
+    formatAnswerForSummary(sectionSegment: any, journey: any, answer: any, capitals?: boolean): {
+        key: string;
+        value: string | Object;
+        action: {
+            href: string;
+            text: string;
+            visuallyHiddenText: string;
+        };
+    }[] | {
+        key: string;
+        value: string;
+        action: import("../../controller.js").ActionView | import("../../controller.js").ActionView[] | undefined;
+    }[];
+}
+import { Question } from '#question';
+//# sourceMappingURL=question.d.ts.map

package/types/src/components/text-entry-redact/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/text-entry-redact/question.js"],"names":[],"mappings":"AAGA,+BAAgC,QAAG,CAAC;AACpC,mCAAoC,GAAG,CAAC;AAExC;;GAEG;AACH;IACC;;;;;;;;;OASG;IACH,0KATW,OAAO,iBAAiB,EAAE,kBAAkB,EA+BtD;IAPA,uBAA0C;IAC1C,WAAkB;IAClB,qCAAsE;IACtE,iCAA8D;IAC9D,uBAA0C;IAC1C,iBAA8B;IAC9B,2BAAkD;IAkBnD,6IAOC;IAED,yCAEC;IAYD;;;;;;;;;;;;QAuBC;CACD;yBA1GwB,WAAW"}

package/types/src/components/text-entry-redact/question.test.d.ts

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

package/types/src/components/text-entry-redact/question.test.d.ts.map

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

package/types/src/components/unit-option-entry/question.d.ts

@@ -0,0 +1,83 @@
+/**
+ * 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
+ * @typedef {{
+ *   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;
+ *   }
+ *}} UnitOption
+ */
+export default class UnitOptionEntryQuestion extends Question {
+    /** @type {Array<UnitOption>} */
+    options: Array<UnitOption>;
+    conditionalFieldName: any;
+    label: any;
+    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 & {
+     *   question: import('#question').QuestionViewModel['question'] & {
+     *     options:UnitOption[]
+     *   }
+     * }}
+     */
+    prepQuestionForRendering(section: any, journey: import("#journey").Journey, customViewData?: Record<string, unknown>, payload?: Record<string, unknown>, options: import("#src/questions/question-types.d.ts").PrepQuestionForRenderingOptions): import("#question").QuestionViewModel & {
+        question: import("#question").QuestionViewModel["question"] & {
+            options: UnitOption[];
+        };
+    };
+    /**
+     * 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: any, journeyResponse: JourneyResponse): Promise<{
+        answers: Record<string, unknown>;
+    }>;
+}
+/**
+ * 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
+ */
+export type 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;
+    };
+};
+import { Question } from '../../questions/question.js';
+//# sourceMappingURL=question.d.ts.map

package/types/src/components/unit-option-entry/question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["../../../../src/components/unit-option-entry/question.js"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH;IACC,gCAAgC;IAChC,SADW,KAAK,CAAC,UAAU,CAAC,CACpB;IAqBP,0BAAgD;IAEhD,WAAkB;IAClB,yBAA+C;IAGhD;;;;;;;;;;;;OAYG;IACH,gDAVW,OAAO,UAAU,EAAE,OAAO,mBAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACvB,OAAO,oCAAoC,EAAE,+BAA+B,GAC1E,OAAO,WAAW,EAAE,iBAAiB,GAAG;QAChD,QAAQ,EAAE,OAAO,WAAW,EAAE,iBAAiB,CAAC,UAAU,CAAC,GAAG;YAC5D,OAAO,EAAC,UAAU,EAAE,CAAA;SACrB,CAAA;KACF,CAmDH;IAED;;;;;OAKG,CACH,yCAHW,eAAe,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAgCzD;CAoBD;;;;;;;;;yBAvKY;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,EAAE;QACX,SAAS,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,OAAO,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAA;CACH;yBA3BsB,6BAA6B"}

package/types/src/components/unit-option-entry/question.test.d.ts

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

package/types/src/components/unit-option-entry/question.test.d.ts.map

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

package/types/src/components/utils/component-types.d.ts

@@ -0,0 +1,19 @@
+export const COMPONENT_TYPES: Readonly<{
+    CHECKBOX: "checkbox";
+    BOOLEAN: "boolean";
+    RADIO: "radio";
+    DATE: "date";
+    DATE_PERIOD: "date-period";
+    DATE_TIME: "date-time";
+    TEXT_ENTRY: "text-entry";
+    TEXT_ENTRY_REDACT: "text-entry-redact";
+    SELECT: "select";
+    SINGLE_LINE_INPUT: "single-line-input";
+    MULTI_FIELD_INPUT: "multi-field-input";
+    NUMBER: "number";
+    ADDRESS: "site-address";
+    UNIT_OPTION: "unit-option";
+    EMAIL: "email";
+    MANAGE_LIST: "manage-list";
+}>;
+//# sourceMappingURL=component-types.d.ts.map

package/types/src/components/utils/component-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-types.d.ts","sourceRoot":"","sources":["../../../../src/components/utils/component-types.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG"}

package/types/src/components/utils/persisted-number-answer.d.ts

@@ -0,0 +1,2 @@
+export function getPersistedNumberAnswer(answer: number): string | number;
+//# sourceMappingURL=persisted-number-answer.d.ts.map

package/types/src/components/utils/persisted-number-answer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"persisted-number-answer.d.ts","sourceRoot":"","sources":["../../../../src/components/utils/persisted-number-answer.js"],"names":[],"mappings":"AAGO,iDAFI,MAAM,mBAYhB"}

package/types/src/components/utils/question-has-answer.d.ts

@@ -0,0 +1,17 @@
+export function logicalCombinations(response: import("#src/journey/journey-response.js").JourneyResponse): {
+    and: CombinationFunc;
+    or: CombinationFunc;
+};
+export function whenQuestionHasAnswer(question: import("#question").Question, expectedValue: unknown): import("#src/section.js").QuestionCondition;
+export function questionHasAnswer(response: import("#src/journey/journey-response.js").JourneyResponse, question: import("#question").Question | {
+    optionJoinString: string;
+}, expectedValue: unknown): boolean;
+export function questionArrayMeetsCondition(response: JourneyResponse, question: any, conditionFn?: (item: any) => boolean): boolean;
+export function questionsHaveAnswers(response: import("#src/journey/journey-response.js").JourneyResponse, questionKeyTuples: QuestionKeyTuples, { logicalCombinator }?: {
+    logicalCombinator: "and" | "or";
+}): boolean;
+export function questionHasNonEmptyStringAnswer(response: import("#src/journey/journey-response.js").JourneyResponse, question: import("#question").Question): boolean;
+export function questionHasNonEmptyNumberAnswer(response: import("#src/journey/journey-response.js").JourneyResponse, question: import("#question").Question): boolean;
+export type QuestionKeyTuples = [any, unknown][];
+export type CombinationFunc = (questionKeyTuples: QuestionKeyTuples) => boolean;
+//# sourceMappingURL=question-has-answer.d.ts.map

package/types/src/components/utils/question-has-answer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question-has-answer.d.ts","sourceRoot":"","sources":["../../../../src/components/utils/question-has-answer.js"],"names":[],"mappings":"AAOO,8CAHI,OAAO,kCAAkC,EAAE,eAAe,GACxD;IAAC,GAAG,EAAE,eAAe,CAAC;IAAC,EAAE,EAAE,eAAe,CAAA;CAAC,CAOtD;AAYK,gDAJI,OAAO,WAAW,EAAE,QAAQ,iBAC5B,OAAO,GACL,OAAO,iBAAiB,EAAE,iBAAiB,CAIvD;AAUM,4CALI,OAAO,kCAAkC,EAAE,eAAe,YAC1D,OAAO,WAAW,EAAE,QAAQ,GAAC;IAAC,gBAAgB,EAAE,MAAM,CAAA;CAAC,iBACvD,OAAO,GACL,OAAO,CAgBnB;AAUM,sDALI,eAAe,YACf,GAAG,gBACH,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,GACpB,OAAO,CAWnB;AASM,+CANI,OAAO,kCAAkC,EAAE,eAAe,qBAC1D,iBAAiB,0BAEzB;IAA8B,iBAAiB,EAAvC,KAAK,GAAG,IAAI;CACpB,GAAU,OAAO,CAUnB;AAOM,0DAJI,OAAO,kCAAkC,EAAE,eAAe,YAC1D,OAAO,WAAW,EAAE,QAAQ,GAC1B,OAAO,CAMnB;AAOM,0DAJI,OAAO,kCAAkC,EAAE,eAAe,YAC1D,OAAO,WAAW,EAAE,QAAQ,GAC1B,OAAO,CAMnB;gCA5Ga,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE;8BAChB,CAAC,iBAAiB,EAAE,iBAAiB,KAAK,OAAO"}

package/types/src/components/utils/question-has-answer.test.d.ts

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

package/types/src/components/utils/question-has-answer.test.d.ts.map

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

package/types/src/components/utils/question-utils.d.ts

@@ -0,0 +1,15 @@
+export function getConditionalFieldName(parentField: any, conditionalField: any): string;
+export function getConditionalAnswer(answers: any, question: any, answer: any): any;
+/**
+ * @param {unknown} conditional
+ * @returns {conditional is {html: string}}
+ */
+export function conditionalIsJustHTML(conditional: unknown): conditional is {
+    html: string;
+};
+declare namespace _default {
+    export { getConditionalAnswer };
+    export { getConditionalFieldName };
+}
+export default _default;
+//# sourceMappingURL=question-utils.d.ts.map

package/types/src/components/utils/question-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question-utils.d.ts","sourceRoot":"","sources":["../../../../src/components/utils/question-utils.js"],"names":[],"mappings":"AAAA,yFAEC;AAED,oFAGC;AAED;;;GAGG;AACH,mDAHW,OAAO,GACL,WAAW,IAAI;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,CAIzC"}

package/types/src/components/utils/question-utils.test.d.ts

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

package/types/src/components/utils/question-utils.test.d.ts.map

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