@planning-inspectorate/dynamic-forms 3.23.0 → 3.24.0

package/README.md

@@ -39,6 +39,54 @@ All exports are named exports from the root module:
 
 `import {COMPONENT_TYPES} from '@planning-inspectorate/dynamic-forms`
 
+### Custom answer types
+
+TypeScript consumers can supply an answer interface without an index signature. Both
+`JourneyResponse` and `Journey` default to `JourneyAnswers` when no answer type is specified.
+
+```typescript
+import { Journey, JourneyResponse } from '@planning-inspectorate/dynamic-forms';
+import type { JourneyResponseLike } from '@planning-inspectorate/dynamic-forms';
+
+interface HolidayAppViewModel {
+    holidayDestination: string;
+    holidayActivities: string[];
+}
+
+const answers: HolidayAppViewModel = {
+    holidayDestination: 'beach',
+    holidayActivities: ['swimming', 'sightseeing']
+};
+const response = new JourneyResponse<HolidayAppViewModel>('holiday-journey', 'ref', answers);
+const journey = new Journey<HolidayAppViewModel>({
+    journeyId: 'holiday-journey',
+    response,
+    makeBaseUrl: (currentResponse) => `/journey/${currentResponse.referenceId}`,
+    journeyTemplate: 'views/layout-journey.njk',
+    taskListTemplate: 'views/layout-check-your-answers.njk',
+    journeyTitle: 'Holiday Booking',
+    sections: []
+});
+
+journey.response.answers.holidayDestination; // string
+
+// Plain objects are also accepted in the constructor and by setResponse.
+const plainResponse: JourneyResponseLike<HolidayAppViewModel> = {
+    journeyId: 'holiday-journey',
+    referenceId: 'ref',
+    answers
+};
+journey.setResponse(plainResponse);
+```
+
+Answer types can also be inferred from the supplied response. `makeBaseUrl` and
+`setResponse` retain the journey's answer type. Component, validator, controller,
+and middleware APIs continue to use their existing default answer types.
+
+Supply populated answers when using an interface with required properties:
+`JourneyResponse` retains its existing empty-object fallback for null or missing
+answers, which does not populate those properties.
+
 ### Components
 
 Components available are exported via the `COMPONENT_TYPES` constant. 
@@ -175,6 +223,41 @@ const update: SaveDataFn = async ({
 }
 ```
 
+`SaveDataFn` and `SaveParams` accept two optional generics: `TData` to type the `data` parameter, and `TLocals` to type `res.locals`. Both default to their current behaviour, so you only need to provide the ones you want to narrow. For example, to type `data`:
+
+```typescript
+type MyData = {
+    answers: {
+        myField: string;
+    };
+};
+
+const update: SaveDataFn<MyData> = async ({data}) => {
+    const answers = data.answers; // typed as { myField: string }
+
+    console.log('saving', answers);
+
+    // TODO: map to database
+    // TODO: write to database
+}
+```
+
+To type `res.locals` as well, pass `TLocals` as the second generic:
+
+```typescript
+type MyLocals = JourneyLocals & {
+    userId: string;
+};
+
+const update: SaveDataFn<MyData, MyLocals> = async ({data, res}) => {
+    const userId = res.locals.userId; // typed as string
+
+    console.log('saving', data.answers, 'for', userId);
+
+    // TODO: map to database
+    // TODO: write to database
+}
+```
 
 ### Conditions
 

package/package.json

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

package/src/controller.d.ts

@@ -1,20 +1,26 @@
+/**
+ * @typedef {{ journey: import('./journey/journey.js').Journey, journeyResponse: import('./journey/journey-response.js').JourneyResponse } & Record<string, any>} JourneyLocals
+ */
 /**
  * @param {object} [viewData]
  * @returns {import('express').Handler}
  */
 export function buildList(viewData?: object): import("express").Handler;
 /**
+ * @template {Record<string, any>} [TLocals=JourneyLocals]
  * @param {import('express').Request} req
- * @param {import('express').Response} res
+ * @param {import('express').Response<any, TLocals>} res
  * @param {string} pageCaption
  * @param {object} viewData
  */
-export function list(req: import("express").Request, res: import("express").Response, pageCaption: string, viewData: object): Promise<void>;
+export function list<TLocals extends Record<string, any> = JourneyLocals>(req: import("express").Request, res: import("express").Response<any, TLocals>, pageCaption: string, viewData: object): Promise<void>;
 export function question(req: import("express-serve-static-core").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: import("express-serve-static-core").Response<any, Record<string, any>, number>, next: import("express-serve-static-core").NextFunction): unknown;
 /**
+ * @template [TData=Object<string, any>]
+ * @template {Record<string, any>} [TLocals=JourneyLocals]
  * @typedef {Object} SaveParams
  * @property {import('express').Request} req
- * @property {import('express').Response} res
+ * @property {import('express').Response<any, TLocals>} res
  * @property {string} journeyId
  * @property {string} referenceId
  * @property {boolean} isManageListItem
@@ -23,17 +29,23 @@ export function question(req: import("express-serve-static-core").Request<import
  * @property {boolean} isDynamicSection is this save action for a question within a DynamicSection?
  * @property {string} [dynamicSectionId] if this is within a DynamicSection, what is the section ID (segment)
  * @property {string} [dynamicSectionFieldName] if this is within a DynamicSection, what is the fieldName for the array?
- * @property {Object<string, any>} data
+ * @property {TData} data
  */
 /**
- * @typedef {(params: SaveParams) => Promise<void>} SaveDataFn
+ * @template [TData=Object<string, any>]
+ * @template {Record<string, any>} [TLocals=JourneyLocals]
+ * @typedef {(params: SaveParams<TData, TLocals>) => Promise<void>} SaveDataFn
  */
 /**
- * @param {SaveDataFn} saveData
+ * @template [TData=Object<string, any>]
+ * @template {Record<string, any>} [TLocals=JourneyLocals]
+ * @param {SaveDataFn<TData, TLocals>} 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): import("express").Handler;
+export function buildSave<TData = {
+    [x: string]: any;
+}, TLocals extends Record<string, any> = JourneyLocals>(saveData: SaveDataFn<TData, TLocals>, redirectToTaskListOnSuccess?: boolean): import("express").Handler;
 export type SectionView = {
     heading: string;
     status: string;
@@ -54,9 +66,15 @@ export type RowView = {
         items: import("#typedefs/question-types.d.ts").ActionView[];
     } | undefined;
 };
-export type SaveParams = {
+export type JourneyLocals = {
+    journey: import("./journey/journey.js").Journey;
+    journeyResponse: import("./journey/journey-response.js").JourneyResponse;
+} & Record<string, any>;
+export type SaveParams<TData = {
+    [x: string]: any;
+}, TLocals extends Record<string, any> = JourneyLocals> = {
     req: import("express").Request;
-    res: import("express").Response;
+    res: import("express").Response<any, TLocals>;
     journeyId: string;
     referenceId: string;
     isManageListItem: boolean;
@@ -74,9 +92,9 @@ export type SaveParams = {
      * if this is within a DynamicSection, what is the fieldName for the array?
      */
     dynamicSectionFieldName?: string | undefined;
-    data: {
-        [x: string]: any;
-    };
+    data: TData;
 };
-export type SaveDataFn = (params: SaveParams) => Promise<void>;
+export type SaveDataFn<TData = {
+    [x: string]: any;
+}, TLocals extends Record<string, any> = JourneyLocals> = (params: SaveParams<TData, TLocals>) => Promise<void>;
 //# sourceMappingURL=controller.d.ts.map

package/src/controller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["controller.js"],"names":[],"mappings":"AAyDA;;;GAGG;AACH,qCAHW,MAAM,GACJ,OAAO,SAAS,EAAE,OAAO,CAIrC;AAED;;;;;GAKG;AACH,0BALW,OAAO,SAAS,EAAE,OAAO,OACzB,OAAO,SAAS,EAAE,QAAQ,eAC1B,MAAM,YACN,MAAM,iBAmEhB;;AAmDD;;;;;;;;;;;;;GAaG;AAEH;;GAEG;AAEH;;;;GAIG;AACH,oCAJW,UAAU,gCACV,OAAO,GACL,OAAO,SAAS,EAAE,OAAO,CA4FrC;;aApSa,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,OAAO,+BAA+B,EAAE,UAAU,EAAE;;;;SA0K7D,OAAO,SAAS,EAAE,OAAO;SACzB,OAAO,SAAS,EAAE,QAAQ;eAC1B,MAAM;iBACN,MAAM;sBACN,OAAO;;;;;;sBAGP,OAAO;;;;;;;;;;;;;yBAOR,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC"}
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["controller.js"],"names":[],"mappings":"AAyDA;;GAEG;AAEH;;;GAGG;AACH,qCAHW,MAAM,GACJ,OAAO,SAAS,EAAE,OAAO,CAIrC;AAED;;;;;;GAMG;AACH,qBANoC,OAAO,SAA7B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAE,uBACvB,OAAO,SAAS,EAAE,OAAO,OACzB,OAAO,SAAS,EAAE,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,eACxC,MAAM,YACN,MAAM,iBAmEhB;;AAmDD;;;;;;;;;;;;;;;GAeG;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AACH,0BANc,KAAK;;GACiB,OAAO,SAA7B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAE,4BACvB,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,gCAC1B,OAAO,GACL,OAAO,SAAS,EAAE,OAAO,CA4FrC;;aA/Sa,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,OAAO,+BAA+B,EAAE,UAAU,EAAE;;;4BAuC9D;IAAE,OAAO,EAAE,OAAO,sBAAsB,EAAE,OAAO,CAAC;IAAC,eAAe,EAAE,OAAO,+BAA+B,EAAE,eAAe,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;uBAuIlJ,KAAK;;GACiB,OAAO,SAA7B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAE;SAEpB,OAAO,SAAS,EAAE,OAAO;SACzB,OAAO,SAAS,EAAE,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;eACxC,MAAM;iBACN,MAAM;sBACN,OAAO;;;;;;sBAGP,OAAO;;;;;;;;;UAGP,KAAK;;uBAIL,KAAK;;GACiB,OAAO,SAA7B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAE,oBACrB,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC"}

package/src/controller.js

@@ -55,6 +55,10 @@ function buildSectionRowViewModel(key, value, action) {
 	};
 }
 
+/**
+ * @typedef {{ journey: import('./journey/journey.js').Journey, journeyResponse: import('./journey/journey-response.js').JourneyResponse } & Record<string, any>} JourneyLocals
+ */
+
 /**
  * @param {object} [viewData]
  * @returns {import('express').Handler}
@@ -64,8 +68,9 @@ export function buildList(viewData = {}) {
 }
 
 /**
+ * @template {Record<string, any>} [TLocals=JourneyLocals]
  * @param {import('express').Request} req
- * @param {import('express').Response} res
+ * @param {import('express').Response<any, TLocals>} res
  * @param {string} pageCaption
  * @param {object} viewData
  */
@@ -186,9 +191,11 @@ export async function question(req, res) {
 }
 
 /**
+ * @template [TData=Object<string, any>]
+ * @template {Record<string, any>} [TLocals=JourneyLocals]
  * @typedef {Object} SaveParams
  * @property {import('express').Request} req
- * @property {import('express').Response} res
+ * @property {import('express').Response<any, TLocals>} res
  * @property {string} journeyId
  * @property {string} referenceId
  * @property {boolean} isManageListItem
@@ -197,15 +204,19 @@ export async function question(req, res) {
  * @property {boolean} isDynamicSection is this save action for a question within a DynamicSection?
  * @property {string} [dynamicSectionId] if this is within a DynamicSection, what is the section ID (segment)
  * @property {string} [dynamicSectionFieldName] if this is within a DynamicSection, what is the fieldName for the array?
- * @property {Object<string, any>} data
+ * @property {TData} data
  */
 
 /**
- * @typedef {(params: SaveParams) => Promise<void>} SaveDataFn
+ * @template [TData=Object<string, any>]
+ * @template {Record<string, any>} [TLocals=JourneyLocals]
+ * @typedef {(params: SaveParams<TData, TLocals>) => Promise<void>} SaveDataFn
  */
 
 /**
- * @param {SaveDataFn} saveData
+ * @template [TData=Object<string, any>]
+ * @template {Record<string, any>} [TLocals=JourneyLocals]
+ * @param {SaveDataFn<TData, TLocals>} saveData
  * @param {boolean} [redirectToTaskListOnSuccess] - optionally redirect to the task list after save instead of next question
  * @returns {import('express').Handler}
  */

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

@@ -1,17 +1,17 @@
 /**
  * Defines a response to a journey, a set of Answers to the questions
  * @class
- * @template {object} [Answers=import("#typedefs/journey-types.d.ts").JourneyAnswers]
+ * @template {object} [TAnswers=import("#typedefs/journey-types.d.ts").JourneyAnswers]
  */
-export class JourneyResponse<Answers extends object = import("#typedefs/journey-types.d.ts").JourneyAnswers> {
+export class JourneyResponse<TAnswers extends object = import("#typedefs/journey-types.d.ts").JourneyAnswers> {
     /**
      * creates an instance of a JourneyResponse
      * @param {string} journeyId
      * @param {string} referenceId
-     * @param {Answers | null} answers
+     * @param {TAnswers | null} answers
      * @param {string} [lpaCode]
      */
-    constructor(journeyId: string, referenceId: string, answers: Answers | null, lpaCode?: string);
+    constructor(journeyId: string, referenceId: string, answers: TAnswers | 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
      */
@@ -21,9 +21,9 @@ export class JourneyResponse<Answers extends object = import("#typedefs/journey-
      */
     journeyId: string;
     /**
-     * @type {Answers} - answers to the journey
+     * @type {TAnswers} - answers to the journey
      */
-    answers: Answers;
+    answers: TAnswers;
     LPACode: string | undefined;
 }
 //# sourceMappingURL=journey-response.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"journey-response.d.ts","sourceRoot":"","sources":["journey-response.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,6BAFuB,OAAO,SAAjB,MAAQ;IAkBpB;;;;;;OAMG;IACH,uBALW,MAAM,eACN,MAAM,WACN,OAAO,GAAG,IAAI,YACd,MAAM,EAWhB;IA/BD;;OAEG;IACH,aAFU,MAAM,CAEJ;IAEZ;;OAEG;IACH,WAFU,MAAM,CAEN;IAEV;;OAEG;IACH,SAFU,OAAO,CAET;IAiBP,4BAAsB;CAEvB"}
+{"version":3,"file":"journey-response.d.ts","sourceRoot":"","sources":["journey-response.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,6BAFuB,QAAQ,SAAlB,MAAQ;IAkBpB;;;;;;OAMG;IACH,uBALW,MAAM,eACN,MAAM,WACN,QAAQ,GAAG,IAAI,YACf,MAAM,EAWhB;IA/BD;;OAEG;IACH,aAFU,MAAM,CAEJ;IAEZ;;OAEG;IACH,WAFU,MAAM,CAEN;IAEV;;OAEG;IACH,SAFU,QAAQ,CAEV;IAiBP,4BAAsB;CAEvB"}

package/src/journey/journey-response.js

@@ -1,7 +1,7 @@
 /**
  * Defines a response to a journey, a set of Answers to the questions
  * @class
- * @template {object} [Answers=import("#typedefs/journey-types.d.ts").JourneyAnswers]
+ * @template {object} [TAnswers=import("#typedefs/journey-types.d.ts").JourneyAnswers]
  */
 export class JourneyResponse {
 	/**
@@ -15,7 +15,7 @@ export class JourneyResponse {
 	journeyId;
 
 	/**
-	 * @type {Answers} - answers to the journey
+	 * @type {TAnswers} - answers to the journey
 	 */
 	answers;
 
@@ -23,7 +23,7 @@ export class JourneyResponse {
 	 * creates an instance of a JourneyResponse
 	 * @param {string} journeyId
 	 * @param {string} referenceId
-	 * @param {Answers | null} answers
+	 * @param {TAnswers | null} answers
 	 * @param {string} [lpaCode]
 	 */
 	constructor(journeyId, referenceId, answers, lpaCode) {

package/src/journey/journey.d.ts

@@ -1,15 +1,16 @@
 /**
  * A journey (An entire set of questions required for a completion of a submission)
  * @class
+ * @template {object} [TAnswers=import("#typedefs/journey-types.d.ts").JourneyAnswers]
  */
-export class Journey {
+export class Journey<TAnswers extends object = import("#typedefs/journey-types.d.ts").JourneyAnswers> {
     /**
      * 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 {(response: import('#typedefs/journey-types.d.ts').JourneyResponseLike<TAnswers>) => 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 {import('#typedefs/journey-types.d.ts').JourneyResponseLike<TAnswers>} 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
@@ -20,9 +21,9 @@ export class Journey {
      */
     constructor({ journeyId, makeBaseUrl, taskListUrl, response, journeyTemplate, taskListTemplate, informationPageViewPath, journeyTitle, returnToListing, sections, initialBackLink }: {
         journeyId: string;
-        makeBaseUrl: (response: import("./journey-response.js").JourneyResponse) => string;
+        makeBaseUrl: (response: import("#typedefs/journey-types.d.ts").JourneyResponseLike<TAnswers>) => string;
         taskListUrl?: string | undefined;
-        response: import("./journey-response.js").JourneyResponse;
+        response: import("#typedefs/journey-types.d.ts").JourneyResponseLike<TAnswers>;
         journeyTemplate: string;
         taskListTemplate: string;
         informationPageViewPath?: string | undefined;
@@ -35,12 +36,12 @@ export class 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 {import('#typedefs/journey-types.d.ts').JourneyResponseLike<TAnswers>} response - the user's response to the journey so far */
+    response: import("#typedefs/journey-types.d.ts").JourneyResponseLike<TAnswers>;
     /** @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 {(journeyResponse: import('#typedefs/journey-types.d.ts').JourneyResponseLike<TAnswers>) => string} makeBaseUrl - function to generate base url of the journey */
+    makeBaseUrl: (journeyResponse: import("#typedefs/journey-types.d.ts").JourneyResponseLike<TAnswers>) => string;
     /** @type {string} taskListUrl - url that renders the task list */
     taskListUrl: string;
     /** @type {string} journeyTemplate - nunjucks template file used for */
@@ -138,9 +139,9 @@ export class Journey {
      */
     isComplete(): boolean;
     /**
-     * @param {import('./journey-response.js').JourneyResponse} journeyResponse
+     * @param {import('#typedefs/journey-types.d.ts').JourneyResponseLike<TAnswers>} journeyResponse
      */
-    setResponse(journeyResponse: import("./journey-response.js").JourneyResponse): void;
+    setResponse(journeyResponse: import("#typedefs/journey-types.d.ts").JourneyResponseLike<TAnswers>): void;
     #private;
 }
 //# sourceMappingURL=journey.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"journey.d.ts","sourceRoot":"","sources":["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;IAED;;;;;;OAMG;IACH,mCAFW,MAAM;;MAQhB;IA8BD;;;;OAIG;IACH,4BAHW,OAAO,8BAA8B,EAAE,WAAW,GAChD,OAAO,0BAA0B,EAAE,QAAQ,GAAG,SAAS,CAiBnE;IAED;;;;;;;OAOG;IACH,4CAJG;QAAoE,MAAM,EAAlE,OAAO,8BAA8B,EAAE,WAAW;QACU,kBAAkB;KACtF,GAAU,MAAM,GAAC,IAAI,CAWvB;IAED;;;;;;;;OAQG;IACH,4BALW,OAAO,SAAS,EAAE,QAAQ,UAC1B,OAAO,8BAA8B,EAAE,WAAW,kFAEhD,IAAI,CAKhB;IAED;;;;;;;;OAQG;IACH,2BANW,OAAO,8BAA8B,EAAE,WAAW,oCAE1D;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"}
+{"version":3,"file":"journey.d.ts","sourceRoot":"","sources":["journey.js"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,qBAFuB,QAAQ,SAAlB,MAAQ;IA0BpB;;;;;;;;;;;;;;OAcG;IACH,qLAZG;QAAwB,SAAS,EAAzB,MAAM;QAC8F,WAAW,EAA/G,CAAC,QAAQ,EAAE,OAAO,8BAA8B,EAAE,mBAAmB,CAAC,QAAQ,CAAC,KAAK,MAAM;QACzE,WAAW;QACkD,QAAQ,EAAtF,OAAO,8BAA8B,EAAE,mBAAmB,CAAC,QAAQ,CAAC;QACpD,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,wIAAwI;IACxI,UADW,OAAO,8BAA8B,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CACtE;IACT,wFAAwF;IACxF,SADW,MAAM,CACJ;IACb,2KAA2K;IAC3K,aADW,CAAC,eAAe,EAAE,OAAO,8BAA8B,EAAE,mBAAmB,CAAC,QAAQ,CAAC,KAAK,MAAM,CACrF;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;IAED;;;;;;OAMG;IACH,mCAFW,MAAM;;MAQhB;IA8BD;;;;OAIG;IACH,4BAHW,OAAO,8BAA8B,EAAE,WAAW,GAChD,OAAO,0BAA0B,EAAE,QAAQ,GAAG,SAAS,CAiBnE;IAED;;;;;;;OAOG;IACH,4CAJG;QAAoE,MAAM,EAAlE,OAAO,8BAA8B,EAAE,WAAW;QACU,kBAAkB;KACtF,GAAU,MAAM,GAAC,IAAI,CAWvB;IAED;;;;;;;;OAQG;IACH,4BALW,OAAO,SAAS,EAAE,QAAQ,UAC1B,OAAO,8BAA8B,EAAE,WAAW,kFAEhD,IAAI,CAKhB;IAED;;;;;;;;OAQG;IACH,2BANW,OAAO,8BAA8B,EAAE,WAAW,oCAE1D;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,8BAA8B,EAAE,mBAAmB,CAAC,QAAQ,CAAC,QAK9E;;CACD"}

package/src/journey/journey.js

@@ -9,17 +9,18 @@ import { MANAGE_LIST_ACTIONS } from '#src/components/manage-list/manage-list-act
 /**
  * A journey (An entire set of questions required for a completion of a submission)
  * @class
+ * @template {object} [TAnswers=import("#typedefs/journey-types.d.ts").JourneyAnswers]
  */
 export class Journey {
 	/** @type {string} journeyId - a unique, human-readable id for this journey */
 	journeyId;
 	/** @type {Array.<import('../section.js').Section>} sections - sections within the journey */
 	sections = [];
-	/** @type {import('./journey-response.js').JourneyResponse} response - the user's response to the journey so far */
+	/** @type {import('#typedefs/journey-types.d.ts').JourneyResponseLike<TAnswers>} response - the user's response to the journey so far */
 	response;
 	/** @type {string} baseUrl - base url of the journey, gets prepended to question urls */
 	baseUrl = '';
-	/** @type {(journeyResponse: import('./journey-response.js').JourneyResponse) => string} makeBaseUrl - function to generate base url of the journey */
+	/** @type {(journeyResponse: import('#typedefs/journey-types.d.ts').JourneyResponseLike<TAnswers>) => string} makeBaseUrl - function to generate base url of the journey */
 	makeBaseUrl = () => '';
 	/** @type {string} taskListUrl - url that renders the task list */
 	taskListUrl = '';
@@ -38,9 +39,9 @@ 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 {(response: import('#typedefs/journey-types.d.ts').JourneyResponseLike<TAnswers>) => 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 {import('#typedefs/journey-types.d.ts').JourneyResponseLike<TAnswers>} 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
@@ -408,7 +409,7 @@ export class Journey {
 	}
 
 	/**
-	 * @param {import('./journey-response.js').JourneyResponse} journeyResponse
+	 * @param {import('#typedefs/journey-types.d.ts').JourneyResponseLike<TAnswers>} journeyResponse
 	 */
 	setResponse(journeyResponse) {
 		this.response = journeyResponse;

package/src/journey/journey.test.js

@@ -66,6 +66,24 @@ describe('Journey class', () => {
 	});
 
 	describe('constructor', () => {
+		it('should accept structural responses and retain them when updating the response', () => {
+			const response = {
+				journeyId: 'TEST',
+				referenceId: 'first',
+				answers: { holidayDestination: 'beach', holidayActivities: ['swimming', 'sightseeing'] }
+			};
+			constructorArgs.response = response;
+			constructorArgs.makeBaseUrl = (currentResponse) => `/journey/${currentResponse.referenceId}`;
+			const journey = new Journey(constructorArgs);
+			assert.strictEqual(journey.response, response);
+			assert.strictEqual(journey.baseUrl, '/journey/first');
+
+			const updatedResponse = { ...response, referenceId: 'second', LPACode: 'LPA' };
+			journey.setResponse(updatedResponse);
+			assert.strictEqual(journey.response, updatedResponse);
+			assert.strictEqual(journey.baseUrl, '/journey/second');
+		});
+
 		it('should throw if no arguments passed into constructor', () => {
 			assert.throws(() => new Journey({}), Error);
 		});

package/typedefs/journey-types.d.ts

@@ -22,6 +22,13 @@ export interface JourneyAnswers {
 	[k: string]: unknown | ManageListAnswers[];
 }
 
+export interface JourneyResponseLike<TAnswers = JourneyAnswers> {
+	journeyId: string;
+	referenceId: string;
+	answers: TAnswers;
+	LPACode: string | undefined;
+}
+
 export interface ManageListAnswers {
 	id: string;
 	[k: string]: unknown;