@dwp/govuk-casa 9.7.0 → 10.1.0

package/dist/casa.d.ts

@@ -1,4 +1,7 @@
 export type PageField = import("./lib/field").PageField;
+export type ExpressRequest = import("express").Request;
+export type RequestHandler = import("express").RequestHandler;
+export type HelmetOptions = import("helmet").HelmetOptions;
 export type ContextEventHandlerOptions = {
     /**
      * Context including changes
@@ -39,6 +42,9 @@ export type ContextEvent = {
      */
     handler: ContextEventHandler;
 };
+export type ErrorVisibiltyFunction = (opts: {
+    req: ExpressRequest;
+}) => any;
 /**
  * Page configuration. A Page is the interactive
  *   representation of a waypoint
@@ -52,6 +58,11 @@ export type Page = {
      * Template path
      */
     view: string;
+    /**
+     * Should page
+     * validation errors be visible on GET requests
+     */
+    errorVisibility?: symbol | ErrorVisibiltyFunction | undefined;
     /**
      * Page-specific hooks (optional, default []).
      * Default is `[]`
@@ -88,10 +99,10 @@ export type GlobalHook = {
      */
     hook: string;
     /**
-     * Middleware function to insert at the hook
-     * point
+     * Middleware function to insert at the
+     * hook point
      */
-    middleware: Function;
+    middleware: RequestHandler;
     /**
      * Only run if route path matches
      * this string/regexp. Default is `undefined`
@@ -107,10 +118,10 @@ export type PageHook = {
      */
     hook: string;
     /**
-     * Middleware function to insert at the hook
-     * point
+     * Middleware function to insert at the
+     * hook point
      */
-    middleware: Function;
+    middleware: RequestHandler;
 };
 export type SessionOptions = {
     /**
@@ -161,7 +172,8 @@ export type IPlugin = {
 };
 export type PluginConfigureFunction = (config: ConfigurationOptions) => any;
 export type PluginBootstrapFunction = (config: ConfigureResult) => any;
-export type HelmetConfigurator = (config: object) => object;
+export type HelmetConfigurator = (config: HelmetOptions) => HelmetOptions;
+export type CasaNunjucksEnvironment = Omit<import("nunjucks").Environment & import("./lib/CasaTemplateLoader.js").default, "getSource">;
 /**
  * Mounting function.
  *
@@ -171,9 +183,10 @@ export type HelmetConfigurator = (config: object) => object;
  * Once this is called, you will not be able to modify any of the routers as
  * they will be "sealed".
  */
-export type Mounter = (app: import("express").Express, opts: {
+export type Mounter = (app: import("express").Express, opts?: {
     route?: string | undefined;
-}) => import("express").Express;
+    serveFirstWaypoint?: boolean | undefined;
+} | undefined) => import("express").Express;
 /**
  * Configuration options
  */
@@ -236,15 +249,10 @@ export type ConfigurationOptions = {
      */
     contextIdGenerator?: ContextIdGenerator | undefined;
     /**
-     * Option to keep page errors
-     * active on GET request
-     */
-    errorVisibility?: symbol | Function | undefined;
-    /**
-     * Sets whether you wish to use the
-     * govuk rebrand. Default is `false`
+     * Option to keep
+     * page errors active on GET request
      */
-    govukRebrand?: boolean | undefined;
+    errorVisibility?: symbol | ErrorVisibiltyFunction | undefined;
 };
 /**
  * Result of a call to configure() function
@@ -253,7 +261,7 @@ export type ConfigureResult = {
     /**
      * Nunjucks environment
      */
-    nunjucksEnv: import("nunjucks").Environment;
+    nunjucksEnv: CasaNunjucksEnvironment;
     /**
      * Router handling all static assets
      */
@@ -267,39 +275,39 @@ export type ConfigureResult = {
      */
     journeyRouter: MutableRouter;
     /**
-     * Middleware
-     * mounted before everything
+     * Middleware mounted before
+     * everything
      */
-    preMiddleware: import("express").RequestHandler[];
+    preMiddleware: RequestHandler[];
     /**
-     * Middleware
-     * mounted after everything
+     * Middleware mounted after
+     * everything
      */
-    postMiddleware: import("express").RequestHandler[];
+    postMiddleware: RequestHandler[];
     /**
-     * CSRF get/set
-     * form middleware
+     * CSRF get/set form middleware
      */
-    csrfMiddleware: import("express").RequestHandler[];
+    csrfMiddleware: RequestHandler[];
     /**
-     * Session
-     * middleware
+     * Session middleware
      */
-    sessionMiddleware: import("express").RequestHandler;
+    sessionMiddleware: RequestHandler;
     /**
-     *   Cookie-parsing middleware
+     * Cookie-parsing middleware
      */
-    cookieParserMiddleware: import("express").RequestHandler[];
+    cookieParserMiddleware: RequestHandler[];
     /**
-     * I18n
-     * preparation middleware
+     * I18n preparation middleware
      */
-    i18nMiddleware: import("express").RequestHandler[];
+    i18nMiddleware: RequestHandler[];
     /**
-     * Body
-     * parsing middleware
+     * Body parsing middleware
      */
-    bodyParserMiddleware: import("express").RequestHandler;
+    bodyParserMiddleware: RequestHandler;
+    /**
+     * Data decoration middleware
+     */
+    dataMiddleware: RequestHandler[];
     /**
      * Function used to mount all CASA artifacts onto an
      * ExpressJS app
@@ -465,6 +473,7 @@ export type PlanRoute = {
     label: string;
 };
 export type PlanRouteCondition = (route: PlanRoute, context: JourneyContext) => boolean;
+export type StopCondition = (route: PlanRoute) => boolean;
 export type PlanTraverseOptions = {
     /**
      * Waypoint from which to start (defaults to
@@ -483,7 +492,7 @@ export type PlanTraverseOptions = {
      * If true, traversal will be stopped
      * (useful for performance)
      */
-    stopCondition?: Function | undefined;
+    stopCondition?: StopCondition | undefined;
     /**
      * Multiple target routes found, this
      * decides which to use
@@ -506,6 +515,23 @@ export type PlanArbiterParams = {
     traverseOptions: PlanTraverseOptions;
 };
 export type PlanArbiter = (route: PlanArbiterParams) => PlanRoute[];
+/**
+ * Journey Context Identity Object
+ */
+export type JourneyContextIdentity = {
+    /**
+     * The context ID
+     */
+    id?: string | undefined;
+    /**
+     * Context name
+     */
+    name?: string | undefined;
+    /**
+     * JouneyContext tags
+     */
+    tags?: string[] | undefined;
+};
 /**
  * Journey Context Object
  */
@@ -515,24 +541,25 @@ export type JourneyContextObject = {
      */
     data?: Record<string, any> | undefined;
     /**
-     * Validation state
+     * Validation
+     * state
      */
-    validation?: any;
+    validation?: Record<string, ValidationError[] | null> | undefined;
     /**
      * Navigation meta
      */
-    nav?: any;
+    nav?: object | undefined;
     /**
      * Identity meta
      */
-    identity?: any;
+    identity?: JourneyContextIdentity | undefined;
 };
 export type ContextIdGeneratorParams = {
     /**
      * Arguments
      */
     args: {
-        req: import("express").Request;
+        req: ExpressRequest;
         reservedIds: [string];
     };
 };
@@ -563,3 +590,22 @@ import * as constants from "./lib/constants.js";
 import * as contextIdGenerators from "./lib/context-id-generators.js";
 import * as corePlugins from "./core-plugins/index.js";
 export { configure, validators, field, Plan, JourneyContext, ValidatorFactory, ValidationError, MutableRouter, waypointUrl, endSession, generateGovukErrors, nunjucksFilters, constants, contextIdGenerators, corePlugins };
+//# sourceMappingURL=casa.d.ts.map
+declare global {
+  namespace Express {
+    type CasaRequestContext = {
+      plan: Plan,
+      journeyContext: JourneyContext,
+      editMode: boolean,
+      editOrigin: string,
+    }
+
+    // Inject additional properties on express.Request
+    interface Request {
+      /**
+       * CASA request context
+       */
+      casa: CasaRequestContext;
+    }
+  }
+}

package/dist/casa.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"casa.d.ts","sourceRoot":"","sources":["../src/casa.js"],"names":[],"mappings":"wBAiDc,OAAO,aAAa,EAAE,SAAS;6BAC/B,OAAO,SAAS,EAAE,OAAO;6BACzB,OAAO,SAAS,EAAE,cAAc;4BAChC,OAAO,QAAQ,EAAE,aAAa;;;;;oBAI9B,cAAc;;;;qBACd,cAAc;;;;aACd,MAAM;;;;cACN,oBAAoB;;yCAKvB,0BAA0B,KACxB,IAAI;;;;;;;;;;;;cAWH,MAAM;;;;;;;;aAEN,mBAAmB;;4CAM9B;IAA6B,GAAG,EAAxB,cAAc;CACxB;;;;;;;;;cAKa,MAAM;;;;UACN,MAAM;;;;;;;;;;;;;;;;;;;;;UAWN,MAAM,EAAE;;;;;;;;;;;;;;;;;;;UASR,MAAM;;;;;gBACN,cAAc;;;;;;;;;;;;;;UAQd,MAAM;;;;;gBACN,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+CA2BjB,oBAAoB;+CAKpB,eAAe;0CAKf,aAAa,KACX,aAAa;sCAIb,IAAI,CAChB,OAAW,UAAU,EAAE,WAAW,GAClC,OAAa,6BAA6B,EAAE,OAAO,EACnD,WAAe,CACZ;;;;;;;;;;4BAaO,OAAO,SAAS,EAAE,OAAO;;;kBAOvB,OAAO,SAAS,EAAE,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+BxB,uBAAuB;;;;kBACvB,aAAa;;;;qBACb,aAAa;;;;mBACb,aAAa;;;;;mBACb,cAAc,EAAE;;;;;oBAEhB,cAAc,EAAE;;;;oBAEhB,cAAc,EAAE;;;;uBAChB,cAAc;;;;4BACd,cAAc,EAAE;;;;oBAChB,cAAc,EAAE;;;;0BAChB,cAAc;;;;oBACd,cAAc,EAAE;;;;;WAChB,OAAO;;;;;YAEP,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;aA2BpB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2DAoBT,eAAe,KACb,MAAM;wDAKR,eAAe,KACb,MAAM,GAAG,wBAAwB;iCAIjC,MAAM,GACZ,wBAAwB,GACxB,2BAA2B,GAC3B,KAAK;;;;;;;;oBAKE,cAAc;;;;cACd,MAAM;;;;eACN,MAAM;;;;iBACN,GAAG;;;;;;uCAMN,GAAG,WACH,eAAe,KACb,eAAe,EAAE;6CAKnB,GAAG,KACD,GAAG;;;;;cAKF,gBAAgB;;;;;cAChB,sBAAsB;;;;YAEtB,MAAM;;;;UACN,MAAM;;;;;;eAKN,MAAM;;;;gBACN,GAAG;;;;cACH,MAAM;;;;oBACN,cAAc;;;;;mDAOjB,gCAAgC,KAC9B,OAAO;;;;;YAKN,MAAM;;;;YACN,MAAM;;;;UACN,MAAM;;;;WACN,MAAM;;yCAKT,SAAS,WACT,cAAc,KACZ,OAAO;oCAKT,SAAS,KACP,OAAO;;;;;;;;;;eAON,MAAM;;;;;;;;;;;;;;;;;;;;aAUN,SAAS,EAAE;;;;oBACX,cAAc;;;;;qBACd,mBAAmB;;kCAMtB,iBAAiB,KACf,SAAS,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAuBrB;QAAgC,GAAG,EAAxB,cAAc;QACC,WAAW,EAA1B,CAAC,MAAM,CAAC;KAErB;;;;;;;;;;;;0CAaU,wBAAwB,KACtB,MAAM;sBA5aG,oBAAoB;uBACnB,2BAA2B;kBAChC,gBAAgB;iBACjB,eAAe;2BACL,yBAAyB;6BACvB,2BAA2B;4BAC5B,0BAA0B;0BAC5B,wBAAwB;wBAC1B,uBAAuB;uBACxB,sBAAsB;oCACT,qBAAqB;iCACxB,2BAA2B;2BACjC,oBAAoB;qCACV,gCAAgC;6BACxC,yBAAyB"}

package/dist/casa.js

@@ -1,76 +1,37 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.corePlugins = exports.contextIdGenerators = exports.constants = exports.nunjucksFilters = exports.generateGovukErrors = exports.endSession = exports.waypointUrl = exports.MutableRouter = exports.ValidationError = exports.ValidatorFactory = exports.JourneyContext = exports.Plan = exports.field = exports.validators = exports.configure = void 0;
 // NOTE: Any changes made here must be reflected in `scripts/esm-wrapper.js`
-const configure_js_1 = __importDefault(require("./lib/configure.js"));
-exports.configure = configure_js_1.default;
-const index_js_1 = __importDefault(require("./lib/validators/index.js"));
-exports.validators = index_js_1.default;
-const field_js_1 = __importDefault(require("./lib/field.js"));
-exports.field = field_js_1.default;
-const Plan_js_1 = __importDefault(require("./lib/Plan.js"));
-exports.Plan = Plan_js_1.default;
-const JourneyContext_js_1 = __importDefault(require("./lib/JourneyContext.js"));
-exports.JourneyContext = JourneyContext_js_1.default;
-const ValidatorFactory_js_1 = __importDefault(require("./lib/ValidatorFactory.js"));
-exports.ValidatorFactory = ValidatorFactory_js_1.default;
-const ValidationError_js_1 = __importDefault(require("./lib/ValidationError.js"));
-exports.ValidationError = ValidationError_js_1.default;
-const MutableRouter_js_1 = __importDefault(require("./lib/MutableRouter.js"));
-exports.MutableRouter = MutableRouter_js_1.default;
-const waypoint_url_js_1 = __importDefault(require("./lib/waypoint-url.js"));
-exports.waypointUrl = waypoint_url_js_1.default;
-const end_session_js_1 = __importDefault(require("./lib/end-session.js"));
-exports.endSession = end_session_js_1.default;
-const journey_js_1 = require("./routes/journey.js");
-Object.defineProperty(exports, "generateGovukErrors", { enumerable: true, get: function () { return journey_js_1.generateGovukErrors; } });
-const nunjucksFilters = __importStar(require("./lib/nunjucks-filters.js"));
-exports.nunjucksFilters = nunjucksFilters;
-const constants = __importStar(require("./lib/constants.js"));
-exports.constants = constants;
-const contextIdGenerators = __importStar(require("./lib/context-id-generators.js"));
-exports.contextIdGenerators = contextIdGenerators;
-const corePlugins = __importStar(require("./core-plugins/index.js"));
-exports.corePlugins = corePlugins;
+import configure from "./lib/configure.js";
+import validators from "./lib/validators/index.js";
+import field from "./lib/field.js";
+import Plan from "./lib/Plan.js";
+import JourneyContext from "./lib/JourneyContext.js";
+import ValidatorFactory from "./lib/ValidatorFactory.js";
+import ValidationError from "./lib/ValidationError.js";
+import MutableRouter from "./lib/MutableRouter.js";
+import waypointUrl from "./lib/waypoint-url.js";
+import endSession from "./lib/end-session.js";
+import { generateGovukErrors } from "./routes/journey.js";
+import * as nunjucksFilters from "./lib/nunjucks-filters.js";
+import * as constants from "./lib/constants.js";
+import * as contextIdGenerators from "./lib/context-id-generators.js";
+import * as corePlugins from "./core-plugins/index.js";
+/** @module @dwp/govuk-casa */
+export { configure, validators, field, Plan, JourneyContext, ValidatorFactory, ValidationError, MutableRouter, 
+// Utilities
+waypointUrl, endSession, generateGovukErrors, 
+// Nunjucks filters
+nunjucksFilters, 
+// Constants
+constants, 
+// Context ID generators
+contextIdGenerators, 
+// Core plugins
+corePlugins, };
 /* ----------------------------------------------------------------- Typedefs */
 // These exist here so that consumer can import CASA's internal types
 /** @typedef {import("./lib/field").PageField} PageField */
+/** @typedef {import("express").Request} ExpressRequest */
+/** @typedef {import("express").RequestHandler} RequestHandler */
+/** @typedef {import("helmet").HelmetOptions} HelmetOptions */
 /**
  * @typedef {object} ContextEventHandlerOptions
  * @property {JourneyContext} journeyContext Context including changes
@@ -94,11 +55,18 @@ exports.corePlugins = corePlugins;
  * @property {string} [field] Field to watch for changes
  * @property {ContextEventHandler} handler Handler to invoke when change happens
  */
+/**
+ * @callback ErrorVisibiltyFunction
+ * @param {object} opts Options
+ * @param {ExpressRequest} opts.req Request
+ */
 /**
  * @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 {ErrorVisibiltyFunction | symbol} [errorVisibility] Should page
+ *   validation errors be visible on GET requests
  * @property {PageHook[]} [hooks=[]] Page-specific hooks (optional, default []).
  *   Default is `[]`
  * @property {PageField[]} [fields=[]] Fields to be managed on this page
@@ -115,16 +83,16 @@ exports.corePlugins = corePlugins;
 /**
  * @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 {RequestHandler} 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 {RequestHandler} middleware Middleware function to insert at the
+ *   hook point
  */
 /**
  * @typedef {object} SessionOptions
@@ -155,8 +123,15 @@ exports.corePlugins = corePlugins;
  */
 /**
  * @callback HelmetConfigurator
- * @param {object} config A default Helmet configuration provided by CASA
- * @returns {object} The modified configuration object
+ * @param {HelmetOptions} config A default Helmet configuration provided by CASA
+ * @returns {HelmetOptions} The modified configuration object
+ */
+/**
+ * @typedef {Omit<
+ *   import("nunjucks").Environment &
+ *     import("./lib/CasaTemplateLoader.js").default,
+ *   "getSource"
+ * >} CasaNunjucksEnvironment
  */
 /**
  * Mounting function.
@@ -169,9 +144,12 @@ exports.corePlugins = corePlugins;
  *
  * @callback Mounter
  * @param {import("express").Express} app Express application
- * @param {object} opts Mounting options
+ * @param {object} [opts] Mounting options
  * @param {string} [opts.route='/'] Optional route to attach all
  *   middleware/routers too. Default is `'/'`
+ * @param {boolean} [opts.serveFirstWaypoint=false] Automatically redirect
+ *   requests to the mount route to the first waypoint in the plan. Default is
+ *   `false`
  * @returns {import("express").Express} The prepared ExpressJS app instance
  */
 /**
@@ -196,31 +174,25 @@ exports.corePlugins = corePlugins;
  *   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
- * @property {boolean} [govukRebrand=false] Sets whether you wish to use the
- *   govuk rebrand. Default is `false`
+ * @property {symbol | ErrorVisibiltyFunction} [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 {CasaNunjucksEnvironment} 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 {RequestHandler[]} preMiddleware Middleware mounted before
+ *   everything
+ * @property {RequestHandler[]} postMiddleware Middleware mounted after
+ *   everything
+ * @property {RequestHandler[]} csrfMiddleware CSRF get/set form middleware
+ * @property {RequestHandler} sessionMiddleware Session middleware
+ * @property {RequestHandler[]} cookieParserMiddleware Cookie-parsing middleware
+ * @property {RequestHandler[]} i18nMiddleware I18n preparation middleware
+ * @property {RequestHandler} bodyParserMiddleware Body parsing middleware
+ * @property {RequestHandler[]} dataMiddleware Data decoration middleware
  * @property {Mounter} mount Function used to mount all CASA artifacts onto an
  *   ExpressJS app
  * @property {ConfigurationOptions} config Ingested config supplied to
@@ -336,13 +308,18 @@ exports.corePlugins = corePlugins;
  * @param {JourneyContext} context Journey Context
  * @returns {boolean} Returns true is route should be followed
  */
+/**
+ * @callback StopCondition
+ * @param {PlanRoute} route Route metadata
+ * @returns {boolean} Returns true is traversal should be stopped
+ */
 /**
  * @typedef PlanTraverseOptions
  * @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
+ * @property {StopCondition} [stopCondition] If true, traversal will be stopped
  *   (useful for performance)
  * @property {string | PlanArbiter} [arbiter] Multiple target routes found, this
  *   decides which to use
@@ -360,17 +337,24 @@ exports.corePlugins = corePlugins;
  * @returns {PlanRoute[]} Returns all routes, excluding those that the arbiter
  *   could eliminate
  */
+/**
+ * @typedef {object} JourneyContextIdentity Journey Context Identity Object
+ * @property {string} [id] The context ID
+ * @property {string} [name] Context name
+ * @property {string[]} [tags] JouneyContext tags
+ */
 /**
  * @typedef {object} JourneyContextObject Journey Context Object
  * @property {Record<string, any>} [data] Data
- * @property {any} [validation] Validation state
- * @property {any} [nav] Navigation meta
- * @property {any} [identity] Identity meta
+ * @property {Record<string, ValidationError[] | null>} [validation] Validation
+ *   state
+ * @property {object} [nav] Navigation meta
+ * @property {JourneyContextIdentity} [identity] Identity meta
  */
 /**
  * @typedef ContextIdGeneratorParams
  * @property {object} args Arguments
- * @property {import("express").Request} args.req Request
+ * @property {ExpressRequest} args.req Request
  * @property {[string]} args.reservedIds List of IDs already in use in session
  *   or request
  */
@@ -388,4 +372,4 @@ exports.corePlugins = corePlugins;
  * @param {ContextIdGeneratorParams} params Parameters
  * @returns {string} A newly generated GUID
  */
-//# sourceMappingURL=casa.js.map
+/** @typedef {import("../src/globals.d.ts")} */

package/dist/core-plugins/edit-snapshot/src/configure.d.ts

@@ -4,3 +4,4 @@
  */
 export default function _default(config: ConfigurationOptions): void;
 export type ConfigurationOptions = import("../../../casa.js").ConfigurationOptions;
+//# sourceMappingURL=configure.d.ts.map

package/dist/core-plugins/edit-snapshot/src/configure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configure.d.ts","sourceRoot":"","sources":["../../../../src/core-plugins/edit-snapshot/src/configure.js"],"names":[],"mappings":"AAWA;;;GAGG;AACH,yCAHW,oBAAoB,GAClB,IAAI,CAgBhB;mCAxBY,OAAO,kBAAkB,EAAE,oBAAoB"}

package/dist/core-plugins/edit-snapshot/src/configure.js

@@ -1,30 +1,23 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = default_1;
-const logger_js_1 = __importDefault(require("../../../lib/logger.js"));
-const pre_steer_hook_js_1 = __importDefault(require("./pre-steer-hook.js"));
-const post_steer_hook_js_1 = __importDefault(require("./post-steer-hook.js"));
+import logger from "../../../lib/logger.js";
+import preSteerHook from "./pre-steer-hook.js";
+import postSteerHook from "./post-steer-hook.js";
 /**
  * @typedef {import("../../../casa.js").ConfigurationOptions} ConfigurationOptions
  * @access private
  */
-const log = (0, logger_js_1.default)("lib:internal-plugin:edit-snapshot");
+const log = logger("lib:internal-plugin:edit-snapshot");
 /**
  * @param {ConfigurationOptions} config Configuration object
  * @returns {void}
  */
-function default_1(config) {
+export default function (config) {
     log.info("Configuring 'edit-snapshot' plugin");
     config.hooks ??= [];
     config.hooks.push({
         hook: "journey.presteer",
-        middleware: pre_steer_hook_js_1.default,
+        middleware: preSteerHook,
     }, {
         hook: "journey.poststeer",
-        middleware: post_steer_hook_js_1.default,
+        middleware: postSteerHook,
     });
 }
-//# sourceMappingURL=configure.js.map

package/dist/core-plugins/edit-snapshot/src/index.d.ts

@@ -3,3 +3,4 @@ declare function _default(): {
 };
 export default _default;
 import configure from "./configure.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/core-plugins/edit-snapshot/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/core-plugins/edit-snapshot/src/index.js"],"names":[],"mappings":"AAEe;;EAId;;sBANqB,gBAAgB"}

package/dist/core-plugins/edit-snapshot/src/index.js

@@ -1,12 +1,6 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const configure_js_1 = __importDefault(require("./configure.js"));
-exports.default = () => {
+import configure from "./configure.js";
+export default () => {
     return {
-        configure: configure_js_1.default,
+        configure,
     };
 };
-//# sourceMappingURL=index.js.map

package/dist/core-plugins/edit-snapshot/src/post-steer-hook.d.ts

@@ -1,2 +1,3 @@
-declare function _default(req: any, res: any, next: any): any;
+declare const _default: (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;
 export default _default;
+//# sourceMappingURL=post-steer-hook.d.ts.map

package/dist/core-plugins/edit-snapshot/src/post-steer-hook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"post-steer-hook.d.ts","sourceRoot":"","sources":["../../../../src/core-plugins/edit-snapshot/src/post-steer-hook.js"],"names":[],"mappings":"yBAMgB,4JAAG,EAAE,mFAAG,EAAE,sDAAI"}

package/dist/core-plugins/edit-snapshot/src/post-steer-hook.js

@@ -1,23 +1,18 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const logger_js_1 = __importDefault(require("../../../lib/logger.js"));
-const utils_js_1 = require("./utils.js");
-const log = (0, logger_js_1.default)("lib:internal-plugin:edit-snapshot:post-steer-hook");
-exports.default = (req, res, next) => {
+import logger from "../../../lib/logger.js";
+import { FLAG_FOR_PURGING, deleteSnapshot } from "./utils.js";
+const log = logger("lib:internal-plugin:edit-snapshot:post-steer-hook");
+/** @type {import("express").RequestHandler} */
+export default (req, res, next) => {
     // Snapshot purging is carried out here rather than in the presteer hook,
     // because the `middleware/steer-journey.js` middleware first needs the opportunity
     // to redirect if the journey cannot be traversed to the edit origin.
     // eslint-disable-next-line security/detect-object-injection
-    if (req.casa[utils_js_1.FLAG_FOR_PURGING] === true) {
+    if (req.casa[FLAG_FOR_PURGING] === true) {
         log.debug(`Snapshot purging flag has been set for context '${req.casa.journeyContext.identity.id}'. Snapshot will be deleted.`);
-        (0, utils_js_1.deleteSnapshot)(log, req);
+        deleteSnapshot(log, req);
         // eslint-disable-next-line security/detect-object-injection
-        req.casa[utils_js_1.FLAG_FOR_PURGING] = false;
+        req.casa[FLAG_FOR_PURGING] = false;
         return req.session.save(next);
     }
     next();
 };
-//# sourceMappingURL=post-steer-hook.js.map