@dwp/govuk-casa 9.0.0 → 9.2.0

package/dist/casa.js

@@ -56,9 +56,7 @@ const contextIdGenerators = __importStar(require("./lib/context-id-generators.js
 exports.contextIdGenerators = contextIdGenerators;
 /* ----------------------------------------------------------------- Typedefs */
 // These exist here so that consumer can import CASA's internal types
-/**
- * @typedef {import('./lib/field').PageField} PageField
- */
+/** @typedef {import("./lib/field").PageField} PageField */
 /**
  * @typedef {object} ContextEventHandlerOptions
  * @property {JourneyContext} journeyContext Context including changes
@@ -73,7 +71,8 @@ exports.contextIdGenerators = contextIdGenerators;
  */
 /**
  * @typedef {object} ContextEventUserInfo
- * @property {symbol} [casaRequestPhase] Request phase at which event is triggered
+ * @property {symbol} [casaRequestPhase] Request phase at which event is
+ *   triggered
  */
 /**
  * @typedef {object} ContextEvent
@@ -82,43 +81,53 @@ exports.contextIdGenerators = contextIdGenerators;
  * @property {ContextEventHandler} handler Handler to invoke when change happens
  */
 /**
- * @typedef {object} Page Page configuration. A Page is the interactive representation of a waypoint
+ * @typedef {object} Page Page configuration. A Page is the interactive
+ *   representation of a waypoint
  * @property {string} waypoint The waypoint with which this page is associated
  * @property {string} view Template path
- * @property {PageHook[]} [hooks=[]] Page-specific hooks (optional, default [])
- * @property {PageField[]} [fields=[]] Fields to be managed on this page (optional, default [])
+ * @property {PageHook[]} [hooks=[]] Page-specific hooks (optional, default []).
+ *   Default is `[]`
+ * @property {PageField[]} [fields=[]] Fields to be managed on this page
+ *   (optional, default []). Default is `[]`
  */
 /**
  * @typedef {object} I18nOptions
  * @property {string[]} dirs Directories to search for locale dictionaries
- * @property {string[]} [locales=['en', 'cy']] Supported locales
+ * @property {string[]} [locales=['en', 'cy']] Supported locales. Default is
+ *   `['en', 'cy']`
  */
 /**
  * @typedef {object} GlobalHook Hook configuration
  * @property {string} hook Hook name in format `<router>.<hook>`
- * @property {Function} middleware Middleware function to insert at the hook point
- * @property {string|RegExp} [path=undefined] Only run if route path matches this string/regexp
+ * @property {Function} middleware Middleware function to insert at the hook
+ *   point
+ * @property {string | RegExp} [path=undefined] Only run if route path matches
+ *   this string/regexp. Default is `undefined`
  */
 /**
  * @typedef {object} PageHook (extends GlobalHook)
  * @property {string} hook Hook name (without a scope prefix)
- * @property {Function} middleware Middleware function to insert at the hook point
+ * @property {Function} middleware Middleware function to insert at the hook
+ *   point
  */
 /**
  * @typedef {object} SessionOptions
- * @property {string} [name=casasession] Session name
- * @property {string} [secret=secret] Encryption secret
- * @property {number} [ttl=3600] Session ttl (seconds)
- * @property {boolean} [secure=false] Whether to use secure session cookies
- * @property {boolean|string} [cookieSameSite=true] SameSite (true = Strict)
+ * @property {string} [name=casasession] Session name. Default is `casasession`
+ * @property {string} [secret=secret] Encryption secret. Default is `secret`
+ * @property {number} [ttl=3600] Session ttl (seconds). Default is `3600`
+ * @property {boolean} [secure=false] Whether to use secure session cookies.
+ *   Default is `false`
+ * @property {boolean | string} [cookieSameSite=true] SameSite (true = Strict).
+ *   Default is `true`
  * @property {object} [store] Session store (default MemoryStore)
- * @property {string} [cookiePath] the URL path on which the session cookie
- * is valid (defaults to '/')
+ * @property {string} [cookiePath] The URL path on which the session cookie is
+ *   valid (defaults to '/')
  */
 /**
  * @typedef {object} IPlugin Plugin interface
  * @property {PluginConfigureFunction} [configure] Modify the app config
- * @property {PluginBootstrapFunction} [bootstrap] Modify post-configuration artifacts
+ * @property {PluginBootstrapFunction} [bootstrap] Modify post-configuration
+ *   artifacts
  */
 /**
  * @callback PluginConfigureFunction
@@ -136,91 +145,104 @@ exports.contextIdGenerators = contextIdGenerators;
 /**
  * Mounting function.
  *
- * This will mount all of the routes and middleware in the correct order on
- * the given ExpressJS app.
+ * This will mount all of the routes and middleware in the correct order on the
+ * given ExpressJS app.
  *
  * Once this is called, you will not be able to modify any of the routers as
  * they will be "sealed".
  *
  * @callback Mounter
- * @param {import('express').Express} app Express application
+ * @param {import("express").Express} app Express application
  * @param {object} opts Mounting options
- * @param {string} [opts.route='/'] Optional route to attach all middleware/routers too
- * @returns {import('express').Express} The prepared ExpressJS app instance
+ * @param {string} [opts.route='/'] Optional route to attach all
+ *   middleware/routers too. Default is `'/'`
+ * @returns {import("express").Express} The prepared ExpressJS app instance
  */
 /**
  * Configure some middleware for use in creating a new CASA app.
  *
  * @typedef {object} ConfigurationOptions Configuration options
  * @property {string} [mountUrl] Prefix for all URLS in browser address bar
- * @property {string[]} [views=[]] Template directories
+ * @property {string[]} [views=[]] Template directories. Default is `[]`
  * @property {SessionOptions} [session] Session configuration
- * @property {Page[]} [pages=[]] Pages the represent waypoints
- * @property {GlobalHook[]} [hooks=[]] Hooks to apply
- * @property {IPlugin[]} [plugins=[]] Plugins
+ * @property {Page[]} [pages=[]] Pages the represent waypoints. Default is `[]`
+ * @property {GlobalHook[]} [hooks=[]] Hooks to apply. Default is `[]`
+ * @property {IPlugin[]} [plugins=[]] Plugins. Default is `[]`
  * @property {I18nOptions} [i18n] I18n configuration
  * @property {Plan} [plan] CASA Plan
- * @property {ContextEvent[]} [events=[]] Handlers for JourneyContext events
- * @property {HelmetConfigurator} [helmetConfigurator] Helmet configuration manipulator function
- * @property {number} [formMaxParams=25] Max number of form parameters to ingest
- * @property {number|string} [formMaxBytes="50KB"] Max total form payload size to ingest
- * @property {ContextIdGenerator} [contextIdGenerator] Custom context ID generator
- * @property {symbol|Function} [errorVisibility] option to keep page errors active on GET request
+ * @property {ContextEvent[]} [events=[]] Handlers for JourneyContext events.
+ *   Default is `[]`
+ * @property {HelmetConfigurator} [helmetConfigurator] Helmet configuration
+ *   manipulator function
+ * @property {number} [formMaxParams=25] Max number of form parameters to
+ *   ingest. Default is `25`
+ * @property {number | string} [formMaxBytes="50KB"] Max total form payload size
+ *   to ingest. Default is `"50KB"`
+ * @property {ContextIdGenerator} [contextIdGenerator] Custom context ID
+ *   generator
+ * @property {symbol | Function} [errorVisibility] Option to keep page errors
+ *   active on GET request
  */
 /**
  * @typedef {object} ConfigureResult Result of a call to configure() function
- * @property {import('nunjucks').Environment} nunjucksEnv Nunjucks environment
+ * @property {import("nunjucks").Environment} nunjucksEnv Nunjucks environment
  * @property {MutableRouter} staticRouter Router handling all static assets
  * @property {MutableRouter} ancillaryRouter Router handling ancillary routes
  * @property {MutableRouter} journeyRouter Router handling all waypoint requests
- * @property {import('express').RequestHandler[]} preMiddleware Middleware mounted before everything
- * @property {import('express').RequestHandler[]} postMiddleware Middleware mounted after everything
- * @property {import('express').RequestHandler[]} csrfMiddleware CSRF get/set form middleware
- * @property {import('express').RequestHandler} sessionMiddleware Session middleware
- * @property {import('express').RequestHandler[]} cookieParserMiddleware Cookie-parsing middleware
- * @property {import('express').RequestHandler[]} i18nMiddleware I18n preparation middleware
- * @property {import('express').RequestHandler} bodyParserMiddleware Body parsing middleware
- * @property {Mounter} mount Function used to mount all CASA artifacts onto an ExpressJS app
- * @property {ConfigurationOptions} config Ingested config supplied to `configure()`
- */
-/**
- * Configuration for generating a ValidationError.
- * i.e. `new ValidationError(configObject)`
- * <br/><br/>
+ * @property {import("express").RequestHandler[]} preMiddleware Middleware
+ *   mounted before everything
+ * @property {import("express").RequestHandler[]} postMiddleware Middleware
+ *   mounted after everything
+ * @property {import("express").RequestHandler[]} csrfMiddleware CSRF get/set
+ *   form middleware
+ * @property {import("express").RequestHandler} sessionMiddleware Session
+ *   middleware
+ * @property {import("express").RequestHandler[]} cookieParserMiddleware
+ *   Cookie-parsing middleware
+ * @property {import("express").RequestHandler[]} i18nMiddleware I18n
+ *   preparation middleware
+ * @property {import("express").RequestHandler} bodyParserMiddleware Body
+ *   parsing middleware
+ * @property {Mounter} mount Function used to mount all CASA artifacts onto an
+ *   ExpressJS app
+ * @property {ConfigurationOptions} config Ingested config supplied to
+ *   `configure()`
+ */
+/**
+ * Configuration for generating a ValidationError. i.e. `new
+ * ValidationError(configObject)` <br/><br/>
  *
- * The `fieldKeySuffix` is used to differentiate errors attached to
- * the same field name. For example, given these fields inputs ...
+ * The `fieldKeySuffix` is used to differentiate errors attached to the same
+ * field name. For example, given these fields inputs ...<pre> <input
+ * name="dateOfBirth[dd]" /> <input name="dateOfBirth[mm]" /> <input
+ * name="dateOfBirth[yyyy]" /> </pre>
  *
- * <pre>
- * &lt;input name="dateOfBirth[dd]" /&gt;
- * &lt;input name="dateOfBirth[mm]" /&gt;
- * &lt;input name="dateOfBirth[yyyy]" /&gt;
- * </pre>
+ * If we wanted to generate an error specifically for the `dd` element, then
+ * we'd include `{ fieldKeySuffix: '[dd]' }` in this config. <br/><br/>
  *
- * If we wanted to generate an error specifically for the `dd`
- * element, then we'd include `{ fieldKeySuffix: '[dd]' }` in this
- * config.
- * <br/><br/>
+ * We can also use `focusSuffix` to control which properties of an object field
+ * should be highlighted with a red border when in error. Looking again at the
+ * `dateOfBirth` example above, if we did not specify any `focusSuffix`, then
+ * all three inputs would be highlighted. However, if we use `{ focusSuffix:
+ * ['[dd]', '[yyyy]'] }` then only the `[dd]` and `[yyyy]` inputs would be
+ * highlighted. <br/><br/>
  *
- * We can also use `focusSuffix` to control which properties of an
- * object field should be highlighted with a red border when in error. Looking
- * again at the `dateOfBirth` example above, if we did not specify
- * any `focusSuffix`, then all three inputs would be highlighted.
- * However, if we use `{ focusSuffix: ['[dd]', '[yyyy]'] }` then only
- * the `[dd]` and `[yyyy]` inputs would be highlighted.
- * <br/><br/>
- *
- * The `fieldHref` and `field` properties are strictly for
- * internal use only and public access may be removed at any point.
+ * The `fieldHref` and `field` properties are strictly for internal use only and
+ * public access may be removed at any point.
  *
  * @typedef {object} ErrorMessageConfigObject
  * @property {string} summary Summary message
- * @property {string} [inline] Inline message (@deprecated now uses summary everywhere)
- * @property {string|string[]} [focusSuffix] String(s) to append to URL hash for focusing inputs
- * @property {string} [fieldKeySuffix] Object fields may use this to show errors per sub-property
- * @property {object|ErrorMessageVariablesGenerator} [variables] Interpolation variables
+ * @property {string} [inline] Inline message (@deprecated now uses summary
+ *   everywhere)
+ * @property {string | string[]} [focusSuffix] String(s) to append to URL hash
+ *   for focusing inputs
+ * @property {string} [fieldKeySuffix] Object fields may use this to show errors
+ *   per sub-property
+ * @property {object | ErrorMessageVariablesGenerator} [variables]
+ *   Interpolation variables
  * @property {string} [validator] Name of the validator
- * @property {string} [fieldHref] (internal) URL hash to link to field in UI, i.e `#f-..`
+ * @property {string} [fieldHref] (internal) URL hash to link to field in UI,
+ *   i.e `#f-..`
  * @property {string} [field] (internal) Field name, including any focus suffix
  */
 /**
@@ -234,10 +256,13 @@ exports.contextIdGenerators = contextIdGenerators;
 /**
  * @callback ErrorMessageConfigGenerator
  * @param {ValidateContext} dataContext Data context
- * @returns {string|ErrorMessageConfigObject} Compiled error message config
+ * @returns {string | ErrorMessageConfigObject} Compiled error message config
  */
 /**
- * @typedef {string|ErrorMessageConfigObject|ErrorMessageConfigGenerator|Error} ErrorMessageConfig
+ * @typedef {string
+ *   | ErrorMessageConfigObject
+ *   | ErrorMessageConfigGenerator
+ *   | Error} ErrorMessageConfig
  */
 /**
  * @typedef {object} ValidateContext Context passed to validate function
@@ -261,7 +286,8 @@ exports.contextIdGenerators = contextIdGenerators;
 /**
  * @typedef {object} Validator
  * @property {ValidateFunction} validate Validation function
- * @property {FieldProcessorFunction} sanitise Sanitise a given value prior to validation
+ * @property {FieldProcessorFunction} sanitise Sanitise a given value prior to
+ *   validation
  * @property {object} config Configuration
  * @property {string} name Validator name
  */
@@ -294,26 +320,31 @@ exports.contextIdGenerators = contextIdGenerators;
  */
 /**
  * @typedef PlanTraverseOptions
- * @property {string} [startWaypoint] Waypoint from which to start (defaults to first in list)
+ * @property {string} [startWaypoint] Waypoint from which to start (defaults to
+ *   first in list)
  * @property {string} routeName Follow routes matching this name (next | prev)
  * @property {Map} history Used to detect loops in traversal (INTERNAL USE ONLY)
- * @property {Function} [stopCondition] If true, traversal will be stopped (useful for performance)
- * @property {string|PlanArbiter} [arbiter] Multiple target routes found, this decides which to use
+ * @property {Function} [stopCondition] If true, traversal will be stopped
+ *   (useful for performance)
+ * @property {string | PlanArbiter} [arbiter] Multiple target routes found, this
+ *   decides which to use
  */
 /**
  * @typedef {object} PlanArbiterParams
  * @property {PlanRoute[]} targets Potential target routes that need arbitration
  * @property {JourneyContext} journeyContext Journey Context
- * @property {PlanTraverseOptions} traverseOptions Original traverse options passed to `traverse()`
+ * @property {PlanTraverseOptions} traverseOptions Original traverse options
+ *   passed to `traverse()`
  */
 /**
  * @callback PlanArbiter
  * @param {PlanArbiterParams} route Route metadata
- * @returns {PlanRoute[]} Returns all routes, excluding those that the arbiter could eliminate
+ * @returns {PlanRoute[]} Returns all routes, excluding those that the arbiter
+ *   could eliminate
  */
 /**
  * @typedef {object} JourneyContextObject Journey Context Object
- * @property {Record<string,any>} [data] Data
+ * @property {Record<string, any>} [data] Data
  * @property {any} [validation] Validation state
  * @property {any} [nav] Navigation meta
  * @property {any} [identity] Identity meta
@@ -321,14 +352,16 @@ exports.contextIdGenerators = contextIdGenerators;
 /**
  * @typedef ContextIdGeneratorParams
  * @property {object} args Arguments
- * @property {import('express').Request} args.req Request
- * @property {[string]} args.reservedIds List of IDs already in use in session or request
+ * @property {import("express").Request} args.req Request
+ * @property {[string]} args.reservedIds List of IDs already in use in session
+ *   or request
  */
 /**
  * Generates a GUID for use as a journey context ID. This ID must not clash with
  * any other context IDs in the given session.
  *
  * The resulting ID must match these criteria:
+ *
  * - A string
  * - Between 1 and 64 characters
  * - Contain only the characters a-z, 0-9, -

package/dist/casa.js.map

@@ -1 +1 @@
-{"version":3,"file":"casa.js","sourceRoot":"","sources":["../src/casa.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4EAA4E;AAC5E,sEAA2C;AAgBzC,oBAhBK,sBAAS,CAgBL;AAfX,yEAAmD;AAgBjD,qBAhBK,kBAAU,CAgBL;AAfZ,8DAAmC;AAgBjC,gBAhBK,kBAAK,CAgBL;AAfP,4DAAiC;AAgB/B,eAhBK,iBAAI,CAgBL;AAfN,gFAAqD;AAgBnD,yBAhBK,2BAAc,CAgBL;AAfhB,oFAAyD;AAgBvD,2BAhBK,6BAAgB,CAgBL;AAflB,kFAAuD;AAgBrD,0BAhBK,4BAAe,CAgBL;AAfjB,8EAAmD;AAgBjD,wBAhBK,0BAAa,CAgBL;AAff,4EAAgD;AAkB9C,sBAlBK,yBAAW,CAkBL;AAjBb,0EAA8C;AAkB5C,qBAlBK,wBAAU,CAkBL;AAjBZ,2EAA6D;AAoB3D,0CAAe;AAnBjB,8DAAgD;AAsB9C,8BAAS;AArBX,oFAAsE;AAwBpE,kDAAmB;AAGrB,gFAAgF;AAChF,qEAAqE;AAErE;;GAEG;AAEH;;;;;;GAMG;AAEH;;;;GAIG;AAEH;;;GAGG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;;;;;;;;GAUG;AAEH;;;;GAIG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;GAcG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;;;;;;;;;GAeG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH;;;;;;;GAOG;AAEH;;;;GAIG;AAEH;;GAEG;AAEH;;;;;;;GAOG;AAEH;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;;GAYG"}
+{"version":3,"file":"casa.js","sourceRoot":"","sources":["../src/casa.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4EAA4E;AAC5E,sEAA2C;AAgBzC,oBAhBK,sBAAS,CAgBL;AAfX,yEAAmD;AAgBjD,qBAhBK,kBAAU,CAgBL;AAfZ,8DAAmC;AAgBjC,gBAhBK,kBAAK,CAgBL;AAfP,4DAAiC;AAgB/B,eAhBK,iBAAI,CAgBL;AAfN,gFAAqD;AAgBnD,yBAhBK,2BAAc,CAgBL;AAfhB,oFAAyD;AAgBvD,2BAhBK,6BAAgB,CAgBL;AAflB,kFAAuD;AAgBrD,0BAhBK,4BAAe,CAgBL;AAfjB,8EAAmD;AAgBjD,wBAhBK,0BAAa,CAgBL;AAff,4EAAgD;AAkB9C,sBAlBK,yBAAW,CAkBL;AAjBb,0EAA8C;AAkB5C,qBAlBK,wBAAU,CAkBL;AAjBZ,2EAA6D;AAoB3D,0CAAe;AAnBjB,8DAAgD;AAsB9C,8BAAS;AArBX,oFAAsE;AAwBpE,kDAAmB;AAGrB,gFAAgF;AAChF,qEAAqE;AAErE,2DAA2D;AAE3D;;;;;;GAMG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;;;;GASG;AAEH;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;;GAYG;AAEH;;;;;GAKG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;;GAeG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH;;;;;;;GAOG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;;;;;GAOG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;GAMG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;;;;;GAMG;AAEH;;;;;;;;;;;;;GAaG"}

package/dist/lib/CasaTemplateLoader.d.ts

@@ -4,8 +4,8 @@
  * @returns {string} The modified template source
  */
 /**
- * @access private
  * @augments FileSystemLoader
+ * @access private
  */
 export default class CasaTemplateLoader extends FileSystemLoader {
     /**
@@ -26,7 +26,7 @@ export default class CasaTemplateLoader extends FileSystemLoader {
     modifyBlock(block: string, modifier: BlockModifier): void;
     #private;
 }
-export type FileSystemLoaderOptions = import('nunjucks').FileSystemLoaderOptions;
-export type LoaderSource = import('nunjucks').LoaderSource;
+export type FileSystemLoaderOptions = import("nunjucks").FileSystemLoaderOptions;
+export type LoaderSource = import("nunjucks").LoaderSource;
 export type BlockModifier = (templateName: string) => string;
-import { FileSystemLoader } from 'nunjucks';
+import { FileSystemLoader } from "nunjucks";

package/dist/lib/CasaTemplateLoader.js

@@ -14,27 +14,27 @@ var _CasaTemplateLoader_instances, _CasaTemplateLoader_blockModifiers, _CasaTemp
 Object.defineProperty(exports, "__esModule", { value: true });
 const nunjucks_1 = require("nunjucks");
 /**
+ * @typedef {import("nunjucks").FileSystemLoaderOptions} FileSystemLoaderOptions
  * @access private
- * @typedef {import('nunjucks').FileSystemLoaderOptions} FileSystemLoaderOptions
  */
 /**
+ * @typedef {import("nunjucks").LoaderSource} LoaderSource
  * @access private
- * @typedef {import('nunjucks').LoaderSource} LoaderSource
  */
 const VALID_BLOCKS = [
-    'beforeContent',
-    'bodyEnd',
-    'bodyStart',
-    'casaPageTitle',
-    'content',
-    'footer',
-    'head',
-    'header',
-    'headIcons',
-    'journey_form',
-    'main',
-    'pageTitle',
-    'skipLink',
+    "beforeContent",
+    "bodyEnd",
+    "bodyStart",
+    "casaPageTitle",
+    "content",
+    "footer",
+    "head",
+    "header",
+    "headIcons",
+    "journey_form",
+    "main",
+    "pageTitle",
+    "skipLink",
 ];
 /**
  * @callback BlockModifier
@@ -42,8 +42,8 @@ const VALID_BLOCKS = [
  * @returns {string} The modified template source
  */
 /**
- * @access private
  * @augments FileSystemLoader
+ * @access private
  */
 class CasaTemplateLoader extends nunjucks_1.FileSystemLoader {
     /**

package/dist/lib/CasaTemplateLoader.js.map

@@ -1 +1 @@
-{"version":3,"file":"CasaTemplateLoader.js","sourceRoot":"","sources":["../../src/lib/CasaTemplateLoader.js"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,uCAA4C;AAE5C;;;GAGG;AAEH;;;GAGG;AAEH,MAAM,YAAY,GAAG;IACnB,eAAe;IACf,SAAS;IACT,WAAW;IACX,eAAe;IACf,SAAS;IACT,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,WAAW;IACX,cAAc;IACd,MAAM;IACN,WAAW;IACX,UAAU;CACX,CAAC;AAEF;;;;GAIG;AAEH;;;GAGG;AACH,MAAqB,kBAAmB,SAAQ,2BAAgB;IAG9D;;;;;OAKG;IACH,YAAY,WAAW,EAAE,IAAI;QAC3B,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;;QAT3B,qDAAgB;QAWd,uBAAA,IAAI,sCAAmB,EAAE,MAAA,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,IAAI;QACZ,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,MAAM,CAAC,CAAC,CAAC,uBAAA,IAAI,8EAAqB,MAAzB,IAAI,EAAsB,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,QAAQ;QACzB,6EAA6E;QAC7E,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,UAAU,MAAM,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAClF,CAAC;QAED,uBAAA,IAAI,0CAAgB,CAAC,IAAI,CAAC;YACxB,KAAK;YACL,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;CAqBF;8LAZsB,IAAI,EAAE,MAAM;IAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,uBAAA,IAAI,0CAAgB,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5D,uCAAuC;QACvC,+DAA+D;QAC/D,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,uBAAA,IAAI,0CAAgB,CAAC,CAAC,CAAC,CAAC;QACpD,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAC9C,gDAAgD;YAChD,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,KAAK,KAAK,EAAE,SAAS,KAAK,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7F,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;kBAhEkB,kBAAkB"}
+{"version":3,"file":"CasaTemplateLoader.js","sourceRoot":"","sources":["../../src/lib/CasaTemplateLoader.js"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,uCAA4C;AAE5C;;;GAGG;AAEH;;;GAGG;AAEH,MAAM,YAAY,GAAG;IACnB,eAAe;IACf,SAAS;IACT,WAAW;IACX,eAAe;IACf,SAAS;IACT,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,WAAW;IACX,cAAc;IACd,MAAM;IACN,WAAW;IACX,UAAU;CACX,CAAC;AAEF;;;;GAIG;AAEH;;;GAGG;AACH,MAAqB,kBAAmB,SAAQ,2BAAgB;IAG9D;;;;;OAKG;IACH,YAAY,WAAW,EAAE,IAAI;QAC3B,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;;QAT3B,qDAAgB;QAWd,uBAAA,IAAI,sCAAmB,EAAE,MAAA,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,IAAI;QACZ,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,MAAM,CAAC,CAAC,CAAC,uBAAA,IAAI,8EAAqB,MAAzB,IAAI,EAAsB,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,QAAQ;QACzB,6EAA6E;QAC7E,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CACb,UAAU,MAAM,CAAC,KAAK,CAAC,uCAAuC,CAC/D,CAAC;QACJ,CAAC;QAED,uBAAA,IAAI,0CAAgB,CAAC,IAAI,CAAC;YACxB,KAAK;YACL,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;CAwBF;8LAfsB,IAAI,EAAE,MAAM;IAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,uBAAA,IAAI,0CAAgB,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5D,uCAAuC;QACvC,+DAA+D;QAC/D,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,uBAAA,IAAI,0CAAgB,CAAC,CAAC,CAAC,CAAC;QACpD,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAC9C,gDAAgD;YAChD,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAC7B,SAAS,KAAK,KAAK,EACnB,SAAS,KAAK,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,CACrC,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;kBArEkB,kBAAkB"}

package/dist/lib/JourneyContext.d.ts

@@ -1,40 +1,34 @@
 /**
+ * @typedef {import("../casa").ContextEventUserInfo} ContextEventUserInfo
  * @access private
- * @typedef {import('../casa').ContextEventUserInfo} ContextEventUserInfo
  */
 /**
+ * @typedef {import("../casa").Page} Page
  * @access private
- * @typedef {import('../casa').Page} Page
  */
 /**
+ * @typedef {import("../casa").ContextEventHandler} ContextEventHandler
  * @access private
- * @typedef {import('../casa').ContextEventHandler} ContextEventHandler
  */
 /**
+ * @typedef {import("../casa").ContextEvent} ContextEvent
  * @access private
- * @typedef {import('../casa').ContextEvent} ContextEvent
  */
 /**
+ * @typedef {import("../casa").JourneyContextObject} JourneyContextObject
  * @access private
- * @typedef {import('../casa').JourneyContextObject} JourneyContextObject
  */
 /**
+ * @typedef {import("express").Request} ExpressRequest
  * @access private
- * @typedef {import('express').Request} ExpressRequest
  */
 export function validateObjectKey(key?: string): string;
-/**
- * @memberof module:@dwp/govuk-casa
- */
+/** @memberof module:@dwp/govuk-casa */
 export default class JourneyContext {
     static DEFAULT_CONTEXT_ID: string;
-    /**
-     * @type {symbol}
-     */
+    /** @type {symbol} */
     static ID_GENERATOR_REQ_LOG: symbol;
-    /**
-     * @type {symbol}
-     */
+    /** @type {symbol} */
     static ID_GENERATOR_REQ_KEY: symbol;
     /**
      * Create a new JourneyContext using the plain object.
@@ -72,6 +66,7 @@ export default class JourneyContext {
     static initContextStore(session: object): void;
     /**
      * Validate the format of a context ID:
+     *
      * - Between 1 and 64 characters
      * - Contain only the characters a-z, 0-9, -
      *
@@ -82,8 +77,8 @@ export default class JourneyContext {
      */
     static validateContextId(id: string): string;
     /**
-     * Generate a new context ID, validate it, and throw if the ID has already been
-     * generated during this request lifecycle. This may happen if an ID was
+     * Generate a new context ID, validate it, and throw if the ID has already
+     * been generated during this request lifecycle. This may happen if an ID was
      * generated, but never used to store a new context in the session. Therefore
      * it is important for user code to always call `putContext()` before
      * generating another ID.
@@ -122,9 +117,9 @@ export default class JourneyContext {
      *
      * @param {object} session Request session
      * @param {string} tag Context tag
-     * @returns {Array<JourneyContext>} The discovered JourneyContext instance
+     * @returns {JourneyContext[]} The discovered JourneyContext instance
      */
-    static getContextsByTag(session: object, tag: string): Array<JourneyContext>;
+    static getContextsByTag(session: object, tag: string): JourneyContext[];
     /**
      * Return all contexts currently stored in the session.
      *
@@ -138,7 +133,8 @@ export default class JourneyContext {
      * @param {object} session Request session
      * @param {JourneyContext} context Context
      * @param {object} options Options
-     * @param {ContextEventUserInfo|object} [options.userInfo] Pass-through event info
+     * @param {ContextEventUserInfo | object} [options.userInfo] Pass-through
+     *   event info
      * @returns {void}
      * @throws {TypeError} When session is not a valid type, or context has no ID
      */
@@ -187,9 +183,9 @@ export default class JourneyContext {
     /**
      * Extract the Journey Context referred to in the incoming request.
      *
-     * This will look in `req.params`, `req.query` and
-     * `req.body` for a `contextid` parameter, and use that
-     * to load the correct Journey Context from the session.
+     * This will look in `req.params`, `req.query` and `req.body` for a
+     * `contextid` parameter, and use that to load the correct Journey Context
+     * from the session.
      *
      * @param {ExpressRequest} req ExpressJS incoming request
      * @returns {JourneyContext} The Journey Context
@@ -200,7 +196,7 @@ export default class JourneyContext {
      *
      * `data` is the "single source of truth" for all data gathered during the
      * user's journey. This is referred to as the "canonical data model".
-     *  Page-specific "views" of this data are generated at runtime in order to
+     * Page-specific "views" of this data are generated at runtime in order to
      * populate/validate specific form fields.
      *
      * `validation` holds the results of form field validation carried out when
@@ -213,10 +209,11 @@ export default class JourneyContext {
      * `identity` holds information that helps uniquely identify this context
      * among a group of contexts stored in the session.
      *
-     * @param {Record<string,any>} data Entire journey data.
+     * @param {Record<string, any>} data Entire journey data.
      * @param {object} validation Page errors (indexed by waypoint id).
      * @param {object} nav Navigation context.
-     * @param {object} identity Some metadata for identifying this context among others.
+     * @param {object} identity Some metadata for identifying this context among
+     *   others.
      */
     constructor(data?: Record<string, any>, validation?: object, nav?: object, identity?: object);
     /**
@@ -233,7 +230,7 @@ export default class JourneyContext {
     /**
      * Get data context for a specific a specific page.
      *
-     * @param  {string | Page} page Page waypoint ID, or Page object.
+     * @param {string | Page} page Page waypoint ID, or Page object.
      * @returns {object} Page data.
      * @throws {TypeError} When page is invalid.
      */
@@ -303,12 +300,13 @@ export default class JourneyContext {
      */
     getValidationErrorsForPage(pageId: string): ValidationError[];
     /**
-     * Same as `getValidationErrorsForPage()`, but the return value is
-     * an object whose keys are the field names, and values are the list of errors
+     * Same as `getValidationErrorsForPage()`, but the return value is an object
+     * whose keys are the field names, and values are the list of errors
      * associated with that particular field.
      *
      * @param {string} pageId Page ID.
-     * @returns {object} Object indexed by field names; values containing list of errors
+     * @returns {object} Object indexed by field names; values containing list of
+     *   errors
      */
     getValidationErrorsForPageByField(pageId: string): object;
     /**
@@ -348,8 +346,8 @@ export default class JourneyContext {
      */
     invalidate(waypoints?: string[]): void;
     /**
-     * Event listeners are transient. They are not stored in session, and generally
-     * only apply for the current request.
+     * Event listeners are transient. They are not stored in session, and
+     * generally only apply for the current request.
      *
      * They also only act on a fixed snapshot of this context's state, which is
      * taken at the point of attaching the listeners (in the "data" middleware).
@@ -369,7 +367,7 @@ export default class JourneyContext {
      * @param {object} params Params
      * @param {string} params.event Event (waypoint-change | context-change)
      * @param {object} params.session Session
-     * @param {ContextEventUserInfo|object} [params.userInfo] Pass-through info
+     * @param {ContextEventUserInfo | object} [params.userInfo] Pass-through info
      * @returns {JourneyContext} Chain
      */
     applyEventListeners({ event, session, userInfo }: {
@@ -383,12 +381,32 @@ export default class JourneyContext {
      * @returns {boolean} True if this is the "default" journey context
      */
     isDefault(): boolean;
+    /**
+     * Set page skipped status.
+     *
+     * @param {string} waypoint Waypoint to skip.
+     * @param {boolean | object} opts Is skipped flag or options.
+     * @param {string} opts.to Waypoint to skip to.
+     */
+    setSkipped(waypoint: string, opts: boolean | object): void;
+    /**
+     * Tests if a page has been skipped.
+     *
+     * @param {string} page Page ID (waypoint).
+     * @param {object} opts Skip ptions.
+     * @param {string} opts.to Waypoint that should be skipped to.
+     * @returns {boolean} True if the page has been skipped, or if it has been
+     *   skipped to a specific page.
+     */
+    isSkipped(waypoint: any, opts: {
+        to: string;
+    }): boolean;
     #private;
 }
-export type ContextEventUserInfo = import('../casa').ContextEventUserInfo;
-export type Page = import('../casa').Page;
-export type ContextEventHandler = import('../casa').ContextEventHandler;
-export type ContextEvent = import('../casa').ContextEvent;
-export type JourneyContextObject = import('../casa').JourneyContextObject;
-export type ExpressRequest = import('express').Request;
-import ValidationError from './ValidationError.js';
+export type ContextEventUserInfo = import("../casa").ContextEventUserInfo;
+export type Page = import("../casa").Page;
+export type ContextEventHandler = import("../casa").ContextEventHandler;
+export type ContextEvent = import("../casa").ContextEvent;
+export type JourneyContextObject = import("../casa").JourneyContextObject;
+export type ExpressRequest = import("express").Request;
+import ValidationError from "./ValidationError.js";