@planning-inspectorate/dynamic-forms 3.3.3 → 3.4.0

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":""}

package/types/src/controller.d.ts

@@ -0,0 +1,78 @@
+/**
+ * @param {object} [viewData]
+ * @returns {import('express').Handler}
+ */
+export function buildList(viewData?: object): any;
+/**
+ * @param {import('express').Request} req
+ * @param {import('express').Response} res
+ * @param {string} pageCaption
+ * @param {object} viewData
+ */
+export function list(req: any, res: any, pageCaption: string, viewData: object): Promise<any>;
+/**
+ * Render an individual question
+ *
+ * @type {import('express').Handler}
+ */
+export function question(req: any, res: any): Promise<any>;
+/**
+ * @typedef {Object} SaveParams
+ * @property {import('express').Request} req
+ * @property {import('express').Response} res
+ * @property {string} journeyId
+ * @property {string} referenceId
+ * @property {boolean} isManageListItem
+ * @property {string} [manageListQuestionFieldName]
+ * @property {Object<string, any>} data
+ */
+/**
+ * @typedef {(params: SaveParams) => Promise<void>} SaveDataFn
+ */
+/**
+ * @param {SaveDataFn} saveData
+ * @param {boolean} [redirectToTaskListOnSuccess] - optionally redirect to the task list after save instead of next question
+ * @returns {import('express').Handler}
+ */
+export function buildSave(saveData: SaveDataFn, redirectToTaskListOnSuccess?: boolean): any;
+export type Journey = import("./journey/journey.js").Journey;
+export type Question = import("./questions/question.js").Question;
+export type Section = any;
+export type SectionView = {
+    heading: string;
+    status: string;
+    list: {
+        rows: Array<RowView>;
+    };
+};
+export type RowView = {
+    key: {
+        text: string;
+    };
+    value: {
+        text: string;
+    } | {
+        html: string;
+    };
+    actions?: {
+        items: ActionView[];
+    } | undefined;
+};
+export type ActionView = {
+    href: string;
+    text: string;
+    visuallyHiddenText?: string | undefined;
+};
+export type SaveParams = {
+    req: any;
+    res: any;
+    journeyId: string;
+    referenceId: string;
+    isManageListItem: boolean;
+    manageListQuestionFieldName?: string | undefined;
+    data: {
+        [x: string]: any;
+    };
+};
+export type SaveDataFn = (params: SaveParams) => Promise<void>;
+//# sourceMappingURL=controller.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/controller.js"],"names":[],"mappings":"AAsEA;;;GAGG;AACH,qCAHW,MAAM,OAKhB;AAED;;;;;GAKG;AACH,sDAHW,MAAM,YACN,MAAM,gBA8DhB;AAED;;;;GAIG;AACH,2DA6BC;AAED;;;;;;;;;GASG;AAEH;;GAEG;AAEH;;;;GAIG;AACH,oCAJW,UAAU,gCACV,OAAO,OAsFjB;sBAvRY,OAAO,sBAAsB,EAAE,OAAO;uBACtC,OAAO,yBAAyB,EAAE,QAAQ;;;aAMzC,MAAM;YACN,MAAM;UAEjB;QAAiC,IAAI,EAA1B,KAAK,CAAE,OAAO,CAAC;KAC5B;;;SAIa;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;WAChB;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;;eAC1B,UAAU,EAAE;;;;UAKrB,MAAM;UACN,MAAM;;;;;;eA6JN,MAAM;iBACN,MAAM;sBACN,OAAO;;;;;;yBAMR,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC"}

package/types/src/controller.test.d.ts

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

package/types/src/controller.test.d.ts.map

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

package/types/src/index.d.ts

@@ -0,0 +1,54 @@
+export * from "./components/boolean/question.js";
+export * from "./components/checkbox/question.js";
+export * from "./components/date/question.js";
+export * from "./components/date-period/question.js";
+export * from "./components/multi-field-input/question.js";
+export * from "./components/number-entry/question.js";
+export * from "./components/radio/question.js";
+export * from "./components/select/question.js";
+export * from "./components/single-line-input/question.js";
+export * from "./components/text-entry/question.js";
+export * from "./components/text-entry-redact/question.js";
+export * from "./components/unit-option-entry/question.js";
+export * from "./components/utils/persisted-number-answer.js";
+export * from "./components/utils/question-has-answer.js";
+export * from "./components/utils/question-utils.js";
+export * from "./components/utils/component-types.js";
+export * from "./controller.js";
+export * from "./lib/address.js";
+export * from "./lib/address-utils.js";
+export * from "./lib/date-utils.js";
+export * from "./lib/session-answer-store.js";
+export * from "./lib/utils.js";
+export * from "./middleware/build-get-journey.js";
+export * from "./middleware/redirect-to-unanswered-question.js";
+export * from "./questions/options-question.js";
+export * from "./validator/address-validator.js";
+export * from "./validator/base-validator.js";
+export * from "./validator/conditional-required-validator.js";
+export * from "./validator/confirmation-checkbox-validator.js";
+export * from "./validator/coordinates-validator.js";
+export * from "./validator/date-period-validator.js";
+export * from "./validator/date-time-validator.js";
+export * from "./validator/document-upload-validator.js";
+export * from "./validator/multi-field-input-validator.js";
+export * from "./validator/numeric-validator.js";
+export * from "./validator/same-answer-validator.js";
+export * from "./validator/unit-option-entry-validator.js";
+export * from "./validator/valid-option-validator.js";
+export * from "./validator/validation-error-handler.js";
+export * from "./validator/validator.js";
+export { Journey } from "./journey/journey.js";
+export { JourneyResponse } from "./journey/journey-response.js";
+export { Question } from "./questions/question.js";
+export { createQuestions } from "./questions/create-questions.js";
+export { questionClasses } from "./questions/questions.js";
+export { Section } from "./section.js";
+export { default as RequiredValidator } from "./validator/required-validator.js";
+export { default as validate } from "./validator/validator.js";
+import AddressQuestion from './components/address/question.js';
+import DateValidator from './validator/date-validator.js';
+import EmailValidator from './validator/email-validator.js';
+import StringValidator from './validator/string-validator.js';
+export { AddressQuestion, DateValidator, EmailValidator, StringValidator };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAC4B,kCAAkC;0BACpC,+BAA+B;2BAC9B,gCAAgC;4BAC/B,iCAAiC"}

package/types/src/journey/journey-response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @typedef {import('./journey-factory').JourneyType} JourneyType
+ */
+/**
+ * Defines a response to a journey, a set of Answers to the questions
+ * @class
+ */
+export class JourneyResponse {
+    /**
+     * creates an instance of a JourneyResponse
+     * @param {JourneyType} journeyId
+     * @param {string} referenceId
+     * @param {import('./journey-types.d.ts').JourneyAnswers | null} answers
+     * @param {string} [lpaCode]
+     */
+    constructor(journeyId: JourneyType, referenceId: string, answers: import("./journey-types.d.ts").JourneyAnswers | null, lpaCode?: string);
+    /**
+     * @type {string} - reference id used in the url for the journey e.g. appeal id - provides a unique lookup for responses in combination with formId
+     */
+    referenceId: string;
+    /**
+     * @type {JourneyType} - a reference to the journey type e.g. has-questionnaire - provides a unique lookup for responses in combination with referenceId
+     */
+    journeyId: JourneyType;
+    /**
+     * @type {import('./journey-types.d.ts').JourneyAnswers} - answers to the journey
+     */
+    answers: import("./journey-types.d.ts").JourneyAnswers;
+    LPACode: string | undefined;
+}
+export type JourneyType = any;
+//# sourceMappingURL=journey-response.d.ts.map

package/types/src/journey/journey-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"journey-response.d.ts","sourceRoot":"","sources":["../../../src/journey/journey-response.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AACH;IAgBC;;;;;;OAMG;IACH,uBALW,WAAW,eACX,MAAM,WACN,OAAO,sBAAsB,EAAE,cAAc,GAAG,IAAI,YACpD,MAAM,EAWhB;IA/BD;;OAEG;IACH,aAFU,MAAM,CAEJ;IAEZ;;OAEG;IACH,WAFU,WAAW,CAEX;IAEV;;OAEG;IACH,SAFU,OAAO,sBAAsB,EAAE,cAAc,CAE/C;IAiBP,4BAAsB;CAEvB"}

package/types/src/journey/journey-response.test.d.ts

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

package/types/src/journey/journey-response.test.d.ts.map

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

package/types/src/journey/journey.d.ts

@@ -0,0 +1,144 @@
+/**
+ * @typedef {import('./journey-response').JourneyResponse} JourneyResponse
+ * @typedef {import('../section').Section} Section
+ * @typedef {import('../questions/question').Question} Question
+ */
+/**
+ * A journey (An entire set of questions required for a completion of a submission)
+ * @class
+ */
+export class Journey {
+    /**
+     * creates an instance of a journey
+     * @param {object} options
+     * @param {string} options.journeyId - a unique, human-readable id for this journey
+     * @param {(response: JourneyResponse) => string} options.makeBaseUrl - base url of journey
+     * @param {string} [options.taskListUrl] - task list url - added to base url, can be left undefined
+     * @param {JourneyResponse} options.response - user's response
+     * @param {string} options.journeyTemplate - template used for all views
+     * @param {string} options.taskListTemplate - path to njk view for listing page
+     * @param {string} [options.informationPageViewPath] - path to njk view for pdf summary page
+     * @param {string} options.journeyTitle - part of the title in the njk view
+     * @param {boolean} [options.returnToListing] - defines how the next/previous question handles end of sections
+     * @param {Section[]} options.sections
+     * @param {string} [options.initialBackLink] - back link when on the first question
+     */
+    constructor({ journeyId, makeBaseUrl, taskListUrl, response, journeyTemplate, taskListTemplate, informationPageViewPath, journeyTitle, returnToListing, sections, initialBackLink }: {
+        journeyId: string;
+        makeBaseUrl: (response: JourneyResponse) => string;
+        taskListUrl?: string | undefined;
+        response: JourneyResponse;
+        journeyTemplate: string;
+        taskListTemplate: string;
+        informationPageViewPath?: string | undefined;
+        journeyTitle: string;
+        returnToListing?: boolean | undefined;
+        sections: Section[];
+        initialBackLink?: string | undefined;
+    });
+    /** @type {string} journeyId - a unique, human-readable id for this journey */
+    journeyId: string;
+    /** @type {Array.<Section>} sections - sections within the journey */
+    sections: Array<Section>;
+    /** @type {JourneyResponse} response - the user's response to the journey so far */
+    response: JourneyResponse;
+    /** @type {string} baseUrl - base url of the journey, gets prepended to question urls */
+    baseUrl: string;
+    /** @type {(journeyResponse: JourneyResponse) => string} baseUrl - base url of the journey, gets prepended to question urls */
+    makeBaseUrl: (journeyResponse: JourneyResponse) => string;
+    /** @type {string} taskListUrl - url that renders the task list */
+    taskListUrl: string;
+    /** @type {string} journeyTemplate - nunjucks template file used for */
+    journeyTemplate: string;
+    /** @type {string} taskListTemplate - nunjucks template file used for listing page */
+    taskListTemplate: string;
+    /** @type {string} informationPageViewPath - nunjucks template file used for pdf summary information page */
+    informationPageViewPath: string;
+    /** @type {boolean} defines how the next/previous question handles end of sections */
+    returnToListing: boolean;
+    /**@type {string} used as part of the overall page title */
+    journeyTitle: string;
+    initialBackLink: string | null;
+    /**
+     * Gets section based on segment
+     * @param {string} sectionSegment
+     * @returns {Section | undefined}
+     */
+    getSection(sectionSegment: string): Section | undefined;
+    /**
+     * gets a question from the object's sections based on a section + question names
+     * @param {import('./journey-types.d.ts').RouteParams} params
+     * @returns {Question | undefined} question found by lookup
+     */
+    getQuestionByParams(params: import("./journey-types.d.ts").RouteParams): Question | undefined;
+    /**
+     * Get the back link for the journey - e.g. the previous question
+     *
+     * @param {Object} options
+     * @param {import('./journey-types.d.ts').RouteParams} options.params
+     * @param {import('#src/components/manage-list/question.js')} [options.manageListQuestion]
+     * @returns {string|null} url for the next question, or null if unmatched
+     */
+    getBackLink({ params, manageListQuestion }: {
+        params: import("./journey-types.d.ts").RouteParams;
+        manageListQuestion?: typeof import("#src/components/manage-list/question.js") | undefined;
+    }): string | null;
+    /**
+     * Handles redirect to the next question in the journey
+     * Used after question post/saving
+     *
+     * @param {import('express').Response} res
+     * @param {import('./journey-types.d.ts').RouteParams} params
+     * @param {import('#src/components/manage-list/question.js')} [manageListQuestion]
+     * @returns {void}
+     */
+    redirectToNextQuestion(res: any, params: import("./journey-types.d.ts").RouteParams, manageListQuestion?: typeof import("#src/components/manage-list/question.js")): void;
+    /**
+     * Get url for the next question in the journey
+     *
+     * @param {import('./journey-types.d.ts').RouteParams} params
+     * @param {Object} options
+     * @param {boolean} [options.reverse] - if passed in this will get the previous question
+     * @param {import('#src/components/manage-list/question.js')} [options.manageListQuestion]
+     * @returns {string|null} url for the next question, or null if unmatched
+     */
+    getNextQuestionUrl(params: import("./journey-types.d.ts").RouteParams, { reverse, manageListQuestion }?: {
+        reverse?: boolean | undefined;
+        manageListQuestion?: typeof import("#src/components/manage-list/question.js") | undefined;
+    }): string | null;
+    /**
+     * Gets the url for the current question
+     * @param {string} sectionSegment - section segment name
+     * @param {string} questionSegment - question segment name
+     * @returns {string} url for the current question
+     */
+    getCurrentQuestionUrl: (sectionSegment: string, questionSegment: string) => string;
+    /**
+     * Gets the url for the current question
+     * @param {string} questionSegment - question segment name
+     * @returns {string} url for the current question
+     */
+    getCurrentQuestionUrlWithoutSection: (questionSegment: string) => string;
+    /**
+     * Gets the url for the current question
+     * @param {string} sectionSegment - section segment name
+     * @param {string} questionSegment - question segment name
+     * @param {string} addition - question segment name
+     * @returns {string} url for the current question
+     */
+    addToCurrentQuestionUrl: (sectionSegment: string, questionSegment: string, addition: string) => string;
+    /**
+     * Gets the overall completeness status of a journey based on the response associated with it and the complete state of each section.
+     * @returns {boolean} Boolean indicating if a journey response is complete
+     */
+    isComplete(): boolean;
+    /**
+     * @param {JourneyResponse} journeyResponse
+     */
+    setResponse(journeyResponse: JourneyResponse): void;
+    #private;
+}
+export type JourneyResponse = any;
+export type Section = any;
+export type Question = any;
+//# sourceMappingURL=journey.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"journey.d.ts","sourceRoot":"","sources":["../../../src/journey/journey.js"],"names":[],"mappings":"AAOA;;;;GAIG;AAEH;;;GAGG;AACH;IAwBC;;;;;;;;;;;;;;OAcG;IACH,qLAZG;QAAwB,SAAS,EAAzB,MAAM;QACyC,WAAW,EAA1D,CAAC,QAAQ,EAAE,eAAe,KAAK,MAAM;QACpB,WAAW;QACH,QAAQ,EAAjC,eAAe;QACC,eAAe,EAA/B,MAAM;QACU,gBAAgB,EAAhC,MAAM;QACW,uBAAuB;QACxB,YAAY,EAA5B,MAAM;QACY,eAAe;QACd,QAAQ,EAA3B,OAAO,EAAE;QACQ,eAAe;KAC1C,EAoDA;IAzFD,8EAA8E;IAC9E,WADW,MAAM,CACP;IACV,qEAAqE;IACrE,UADW,KAAK,CAAE,OAAO,CAAC,CACZ;IACd,mFAAmF;IACnF,UADW,eAAe,CACjB;IACT,wFAAwF;IACxF,SADW,MAAM,CACJ;IACb,8HAA8H;IAC9H,aADW,CAAC,eAAe,EAAE,eAAe,KAAK,MAAM,CAChC;IACvB,kEAAkE;IAClE,aADW,MAAM,CACA;IACjB,uEAAuE;IACvE,iBADW,MAAM,CACI;IACrB,qFAAqF;IACrF,kBADW,MAAM,CACK;IACtB,4GAA4G;IAC5G,yBADW,MAAM,CACY;IAC7B,qFAAqF;IACrF,iBADW,OAAO,CACM;IACxB,2DAA2D;IAC3D,cADU,MAAM,CACH;IAmEZ,+BAA8C;IA2C/C;;;;OAIG;IACH,2BAHW,MAAM,GACJ,OAAO,GAAG,SAAS,CAM/B;IAuBD;;;;OAIG;IACH,4BAHW,OAAO,sBAAsB,EAAE,WAAW,GACxC,QAAQ,GAAG,SAAS,CAiBhC;IAED;;;;;;;OAOG;IACH,4CAJG;QAA4D,MAAM,EAA1D,OAAO,sBAAsB,EAAE,WAAW;QACkB,kBAAkB;KACtF,GAAU,MAAM,GAAC,IAAI,CAWvB;IAED;;;;;;;;OAQG;IACH,yCAJW,OAAO,sBAAsB,EAAE,WAAW,kFAExC,IAAI,CAKhB;IAED;;;;;;;;OAQG;IACH,2BANW,OAAO,sBAAsB,EAAE,WAAW,oCAElD;QAA0B,OAAO;QACmC,kBAAkB;KACtF,GAAU,MAAM,GAAC,IAAI,CA8DvB;IAED;;;;;OAKG;IACH,wBAAyB,gBAJd,MAI4B,EAAE,iBAH9B,MAG6C,KAF3C,MAAM,CAqBjB;IAEF;;;;OAIG;IACH,sCAAuC,iBAH5B,MAG2C,KAFzC,MAAM,CAIjB;IAEF;;;;;;OAMG;IACH,0BAA2B,gBALhB,MAK8B,EAAE,iBAJhC,MAI+C,EAAE,UAHjD,MAGyD,KAFvD,MAAM,CAuBjB;IAEF;;;OAGG;IACH,cAFa,OAAO,CAInB;IAED;;OAEG;IACH,6BAFW,eAAe,QAKzB;;CACD"}

package/types/src/journey/journey.test.d.ts

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

package/types/src/journey/journey.test.d.ts.map

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

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

@@ -0,0 +1,6 @@
+/**
+ * @param {import('@prisma/client').Prisma.AddressGetPayload<{}>} address
+ * @returns {string}
+ */
+export function addressToViewModel(address: any): string;
+//# sourceMappingURL=address-utils.d.ts.map

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

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

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

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

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

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

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

@@ -0,0 +1,43 @@
+/**
+ * Defines the shape of an address object
+ * @class
+ */
+export class Address {
+    /**
+     * creates an instance of an address
+     * @param {Object} params
+     * @param {string} params.addressLine1
+     * @param {string} params.addressLine2
+     * @param {string} params.townCity
+     * @param {string} params.county
+     * @param {string} params.postcode
+     */
+    constructor({ addressLine1, addressLine2, townCity, county, postcode }: {
+        addressLine1: string;
+        addressLine2: string;
+        townCity: string;
+        county: string;
+        postcode: string;
+    });
+    /**
+     * @type {string} - the first line of the address
+     */
+    addressLine1: string;
+    /**
+     * @type {string} - the second line of the address
+     */
+    addressLine2: string;
+    /**
+     * @type {string} - the name of the town, city or other settlement
+     */
+    townCity: string;
+    /**
+     * @type {string} - the name of the town, city or other settlement
+     */
+    county: string;
+    /**
+     * @type {string} - the postcode
+     */
+    postcode: string;
+}
+//# sourceMappingURL=address.d.ts.map

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

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

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

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

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

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