@planning-inspectorate/dynamic-forms 3.10.10 → 3.10.12

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.js').JourneyAnswers | null} answers
+     * @param {string} [lpaCode]
+     */
+    constructor(journeyId: JourneyType, referenceId: string, answers: import("./journey-types.js").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.js').JourneyAnswers} - answers to the journey
+     */
+    answers: import("./journey-types.js").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,oBAAoB,EAAE,cAAc,GAAG,IAAI,YAClD,MAAM,EAWhB;IA/BD;;OAEG;IACH,aAFU,MAAM,CAEJ;IAEZ;;OAEG;IACH,WAFU,WAAW,CAEX;IAEV;;OAEG;IACH,SAFU,OAAO,oBAAoB,EAAE,cAAc,CAE7C;IAiBP,4BAAsB;CAEvB"}

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

@@ -0,0 +1,28 @@
+/**
+ * Express route parameters used for journey routes
+ */
+export type RouteParams = CoreRouteParams & ManageListRouteParams;
+
+export type CoreRouteParams = {
+	section: string;
+	question: string;
+	[key: string]: string;
+};
+
+export type ManageListRouteParams =
+	| {
+			manageListAction: string;
+			manageListItemId: string;
+			manageListQuestion: string;
+	  }
+	| {};
+
+export interface JourneyAnswers {
+	// if the answer is for a manage list question, the answer will be an array of answer objects
+	[k: string]: unknown | ManageListAnswers[];
+}
+
+export interface ManageListAnswers {
+	id: string;
+	[k: string]: unknown;
+}

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

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

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

@@ -0,0 +1,136 @@
+/**
+ * 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: import('./journey-response.js').JourneyResponse) => string} options.makeBaseUrl - base url of journey
+     * @param {string} [options.taskListUrl] - task list url - added to base url, can be left undefined
+     * @param {import('./journey-response.js').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 {import('../section.js').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: import("./journey-response.js").JourneyResponse) => string;
+        taskListUrl?: string | undefined;
+        response: import("./journey-response.js").JourneyResponse;
+        journeyTemplate: string;
+        taskListTemplate: string;
+        informationPageViewPath?: string | undefined;
+        journeyTitle: string;
+        returnToListing?: boolean | undefined;
+        sections: import("../section.js").Section[];
+        initialBackLink?: string | undefined;
+    });
+    /** @type {string} journeyId - a unique, human-readable id for this journey */
+    journeyId: string;
+    /** @type {Array.<import('../section.js').Section>} sections - sections within the journey */
+    sections: Array<import("../section.js").Section>;
+    /** @type {import('./journey-response.js').JourneyResponse} response - the user's response to the journey so far */
+    response: import("./journey-response.js").JourneyResponse;
+    /** @type {string} baseUrl - base url of the journey, gets prepended to question urls */
+    baseUrl: string;
+    /** @type {(journeyResponse: import('./journey-response.js').JourneyResponse) => string} makeBaseUrl - function to generate base url of the journey */
+    makeBaseUrl: (journeyResponse: import("./journey-response.js").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 {import('../section.js').Section | undefined}
+     */
+    getSection(sectionSegment: string): import("../section.js").Section | undefined;
+    /**
+     * gets a question from the object's sections based on a section + question names
+     * @param {import('./journey-types.js').RouteParams} params
+     * @returns {import('../questions/question.js').Question | undefined} question found by lookup
+     */
+    getQuestionByParams(params: import("./journey-types.js").RouteParams): import("../questions/question.js").Question | undefined;
+    /**
+     * Get the back link for the journey - e.g. the previous question
+     *
+     * @param {Object} options
+     * @param {import('./journey-types.js').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.js").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.js').RouteParams} params
+     * @param {import('#src/components/manage-list/question.js')} [manageListQuestion]
+     * @returns {void}
+     */
+    redirectToNextQuestion(res: import("express").Response, params: import("./journey-types.js").RouteParams, manageListQuestion?: typeof import("#src/components/manage-list/question.js")): void;
+    /**
+     * Get url for the next question in the journey
+     *
+     * @param {import('./journey-types.js').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.js").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 {import('./journey-response.js').JourneyResponse} journeyResponse
+     */
+    setResponse(journeyResponse: import("./journey-response.js").JourneyResponse): void;
+    #private;
+}
+//# 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":"AAQA;;;GAGG;AACH;IAwBC;;;;;;;;;;;;;;OAcG;IACH,qLAZG;QAAwB,SAAS,EAAzB,MAAM;QACyE,WAAW,EAA1F,CAAC,QAAQ,EAAE,OAAO,uBAAuB,EAAE,eAAe,KAAK,MAAM;QACpD,WAAW;QAC6B,QAAQ,EAAjE,OAAO,uBAAuB,EAAE,eAAe;QAC/B,eAAe,EAA/B,MAAM;QACU,gBAAgB,EAAhC,MAAM;QACW,uBAAuB;QACxB,YAAY,EAA5B,MAAM;QACY,eAAe;QACU,QAAQ,EAAnD,OAAO,eAAe,EAAE,OAAO,EAAE;QAChB,eAAe;KAC1C,EAoDA;IAzFD,8EAA8E;IAC9E,WADW,MAAM,CACP;IACV,6FAA6F;IAC7F,UADW,KAAK,CAAE,OAAO,eAAe,EAAE,OAAO,CAAC,CACpC;IACd,mHAAmH;IACnH,UADW,OAAO,uBAAuB,EAAE,eAAe,CACjD;IACT,wFAAwF;IACxF,SADW,MAAM,CACJ;IACb,sJAAsJ;IACtJ,aADW,CAAC,eAAe,EAAE,OAAO,uBAAuB,EAAE,eAAe,KAAK,MAAM,CAChE;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,eAAe,EAAE,OAAO,GAAG,SAAS,CAMvD;IA8BD;;;;OAIG;IACH,4BAHW,OAAO,oBAAoB,EAAE,WAAW,GACtC,OAAO,0BAA0B,EAAE,QAAQ,GAAG,SAAS,CAiBnE;IAED;;;;;;;OAOG;IACH,4CAJG;QAA0D,MAAM,EAAxD,OAAO,oBAAoB,EAAE,WAAW;QACoB,kBAAkB;KACtF,GAAU,MAAM,GAAC,IAAI,CAWvB;IAED;;;;;;;;OAQG;IACH,4BALW,OAAO,SAAS,EAAE,QAAQ,UAC1B,OAAO,oBAAoB,EAAE,WAAW,kFAEtC,IAAI,CAKhB;IAED;;;;;;;;OAQG;IACH,2BANW,OAAO,oBAAoB,EAAE,WAAW,oCAEhD;QAA0B,OAAO;QACmC,kBAAkB;KACtF,GAAU,MAAM,GAAC,IAAI,CAyEvB;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,OAAO,uBAAuB,EAAE,eAAe,QAKzD;;CACD"}

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.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/date-utils.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"date-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/date-utils.js"],"names":[],"mappings":"AAKA;;;;;;GAMG;AACH,4CALW,IAAI,GAAC,MAAM,eAEnB;IAAyB,MAAM;CAC/B,GAAU,MAAM,CAMlB;AAED;;;;;;;;;GASG;AAEH;;;;GAIG;AACH,2EAHW,cAAc,GACZ,IAAI,CAMhB;AAED;;GAEG;AACH,mCAWC;AAED;;GAEG;AACH,iCAWC;AAqCD;;;;;GAKG;AACH,4CAJW,IAAI,WACJ,IAAI,GACF,OAAO,CASnB;AAED;;;;GAIG;AACH,+CAHW,IAAI,GACF,OAAO,CASnB;AA/CM,uCAHI,IAAI,GACF,OAAO,CAInB;AAMM,wCAHI,IAAI,GACF,OAAO,CAInB;AAMM,kCAHI,IAAI,GACF,OAAO,CAInB;;UArFa,MAAM;WACN,MAAM;SACN,MAAM"}

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

@@ -0,0 +1,88 @@
+/**
+ * A `SaveDataFn` implementation that saves answers to the session.
+ * Answers are saved into a forms object, keyed by the journeyId, and optionally by a request parameter
+ * @example
+ * req: {
+ * 	session: {
+ * 		forms: {
+ * 			'journey-id-1': {
+ * 				questionOne: 'my answer'
+ * 				// ...
+ * 			}
+ * 		}
+ * 	}
+ * }
+ *
+ * or when keyed by a req parameter:
+ * @example
+ * req: {
+ * 	session: {
+ * 		forms: {
+ * 			'some-req-param': {
+ * 			   'journey-id-1': {
+ * 				   questionOne: 'my answer'
+ * 				   // ...
+ * 			   }
+ * 			}
+ * 		}
+ * 	}
+ * }
+ *
+ * Delete behavior for manage-list items:
+ * - When `manageListItemRemove === true`, and both `manageListQuestionFieldName` and `req.params.manageListItemId`
+ *   are present, the item with a matching `id` is removed from the array stored at `answers[manageListQuestionFieldName]`.
+ * - If the list does not exist or is not an array, no action is taken.
+ *
+ * @param {Object} opts
+ * @param {string} [opts.reqParam]
+ * - optional request parameter to use as a key
+ * @returns {import('../controller.js').SaveDataFn}
+ */
+export function buildSaveDataToSession({ reqParam }?: {
+    reqParam?: string | undefined;
+}): import("../controller.js").SaveDataFn;
+/**
+ * A function to clear journey answers from the session
+ *
+ * @example
+ * req: {
+ * 	session: {
+ * 		forms: {
+ * 			'journey-id-1': {
+ * 				questionOne: 'my answer'
+ * 				// ...
+ * 			}
+ * 		}
+ * 	}
+ * }
+ *
+ * @param {Object} params
+ * @param {import('express').Request} params.req
+ * @param {string} params.journeyId
+ * @param {Object<string, any>} [params.replaceWith] - optional data to replace the form answers with
+ * @param {string} [params.reqParam] - optional request parameter used as a key
+ * @returns {void}
+ */
+export function clearDataFromSession({ req, journeyId, replaceWith, reqParam }: {
+    req: import("express").Request;
+    journeyId: string;
+    replaceWith?: {
+        [x: string]: any;
+    } | undefined;
+    reqParam?: string | undefined;
+}): void;
+/**
+ * Fetch session answers from the session
+ *
+ * @param {string} journeyId
+ * @param {string} [reqParam] - optional request parameter used as a key
+ * @returns {import('express').Handler}
+ */
+export function buildGetJourneyResponseFromSession(journeyId: string, reqParam?: string): import("express").Handler;
+/**
+ * Default save-to-session function with no request parameter
+ *
+ * @type {import('../controller.js').SaveDataFn}
+ */
+export const saveDataToSession: import("../controller.js").SaveDataFn;
+//# sourceMappingURL=session-answer-store.d.ts.map

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

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

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

@@ -0,0 +1,26 @@
+/**
+ * replaces new line chars with a <br>
+ * @param {string} [value]
+ * @returns {string}
+ */
+export function nl2br(value?: string): string;
+/**
+ * @param {string|any} str
+ * @returns {string}
+ */
+export function capitalize(str: string | any): string;
+/**
+ * Trim a trailing slash if present
+ *
+ * @param {string} [str]
+ * @returns {string}
+ */
+export function trimTrailingSlash(str?: string): string;
+/**
+ * Convert a value to an array, unless it is already
+ *
+ * @param {T|T[]} value
+ * @template T
+ */
+export function toArray<T>(value: T | T[]): T[];
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,8BAHW,MAAM,GACJ,MAAM,CAMlB;AAED;;;GAGG;AACH,gCAHW,MAAM,GAAC,GAAG,GACR,MAAM,CAKlB;AAED;;;;;GAKG;AACH,wCAHW,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;GAKG;AACH,wBAFa,CAAC,SADH,CAAC,GAAC,CAAC,EAAE,OAKf"}

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * @typedef {function(import('../section').Question, import('../journey/journey-response').JourneyResponse): boolean} ShouldDisplayCondition
+ */
+/**
+ * Redirects to the first unanswered question in a journey, or to the task list if complete
+ *
+ * @param {ShouldDisplayCondition[]} [conditions]
+ * @returns {import('express').Handler}
+ */
+export function redirectToUnansweredQuestion(conditions?: ShouldDisplayCondition[]): import("express").Handler;
+export type ShouldDisplayCondition = (arg0: any, arg1: any) => boolean;
+//# sourceMappingURL=redirect-to-unanswered-question.d.ts.map

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-questions.d.ts","sourceRoot":"","sources":["../../../src/questions/create-questions.js"],"names":[],"mappings":"AAAA,wEAAwE;AAExE;;;;;GAKG;AACH,qDALW;IAAC,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa,CAAA;CAAC,mBACvC,MAAM,CAAC,MAAM,EAAE,OAAO,qBAAqB,EAAE,aAAa,CAAC,2BAC3D;IAAC,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,WAAW,CAAA;CAAC,kBAClD;IAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAAC;;EAwBtH"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"options-question.d.ts","sourceRoot":"","sources":["../../../src/questions/options-question.js"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;GAEG;AACH;;GAEG;AAEH;IAIC;;OAEG;IACH,oBAFW,yBAAyB,EAenC;IAnBD,4BAA4B;IAC5B,SADW,KAAK,CAAC,MAAM,CAAC,CAChB;IAiBP,yBAA+C;IAGhD;;;;;;;;OAQG;IACH,kCAPW,OAAO,UAAU,EAAE,OAAO,WAC1B,OAAO,UAAU,EAAE,OAAO,mBAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACvB,OAAO,iBAAiB,EAAE,+BAA+B,OAmDnE;CAmCD;;qBAhJY;IACR,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,WAAW,CAAC,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,OAAO,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;KAClB,CAAC;IACA,eAAe,CAAC,EAAE;QAChB,IAAI,EAAE,MAAM,CAAC;KAChB,CAAA;CACH;+BAIU,GAAsC,GAAG;IAAE,QAAQ,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;CAAE;wCAG5E,OAAO,iBAAiB,EAAE,kBAAkB,GAAG;IAAE,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CAAE;yBAnC7D,eAAe"}