@dwp/govuk-casa 10.0.0 → 10.1.0

package/dist/casa.d.ts

@@ -62,7 +62,7 @@ export type Page = {
      * Should page
      * validation errors be visible on GET requests
      */
-    errorVisibility: ErrorVisibiltyFunction | symbol;
+    errorVisibility?: symbol | ErrorVisibiltyFunction | undefined;
     /**
      * Page-specific hooks (optional, default []).
      * Default is `[]`
@@ -173,6 +173,7 @@ export type IPlugin = {
 export type PluginConfigureFunction = (config: ConfigurationOptions) => any;
 export type PluginBootstrapFunction = (config: ConfigureResult) => any;
 export type HelmetConfigurator = (config: HelmetOptions) => HelmetOptions;
+export type CasaNunjucksEnvironment = Omit<import("nunjucks").Environment & import("./lib/CasaTemplateLoader.js").default, "getSource">;
 /**
  * Mounting function.
  *
@@ -182,9 +183,10 @@ export type HelmetConfigurator = (config: HelmetOptions) => HelmetOptions;
  * 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
  */
@@ -259,7 +261,7 @@ export type ConfigureResult = {
     /**
      * Nunjucks environment
      */
-    nunjucksEnv: import("nunjucks").Environment;
+    nunjucksEnv: CasaNunjucksEnvironment;
     /**
      * Router handling all static assets
      */
@@ -302,6 +304,10 @@ export type ConfigureResult = {
      * Body parsing middleware
      */
     bodyParserMiddleware: RequestHandler;
+    /**
+     * Data decoration middleware
+     */
+    dataMiddleware: RequestHandler[];
     /**
      * Function used to mount all CASA artifacts onto an
      * ExpressJS app

package/dist/casa.d.ts.map

@@ -1 +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;;;;;qBACN,sBAAsB,GAAG,MAAM;;;;;;;;;;;;;;;;UAU/B,MAAM,EAAE;;;;;;;;;;;;;;;;;;;UASR,MAAM;;;;;gBACN,cAAc;;;;;;;;;;;;;;UAQd,MAAM;;;;;gBACN,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+CA2BjB,oBAAoB;+CAKpB,eAAe;0CAKf,aAAa,KACX,aAAa;;;;;;;;;;4BAaf,OAAO,SAAS,EAAE,OAAO,QAEjC;IAAsB,KAAK;CAE3B,KAAU,OAAO,SAAS,EAAE,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+BxB,OAAO,UAAU,EAAE,WAAW;;;;kBAC9B,aAAa;;;;qBACb,aAAa;;;;mBACb,aAAa;;;;;mBACb,cAAc,EAAE;;;;;oBAEhB,cAAc,EAAE;;;;oBAEhB,cAAc,EAAE;;;;uBAChB,cAAc;;;;4BACd,cAAc,EAAE;;;;oBAChB,cAAc,EAAE;;;;0BAChB,cAAc;;;;;WACd,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;sBAhaG,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"}
+{"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

@@ -65,7 +65,7 @@ corePlugins, };
  *   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
+ * @property {ErrorVisibiltyFunction | symbol} [errorVisibility] Should page
  *   validation errors be visible on GET requests
  * @property {PageHook[]} [hooks=[]] Page-specific hooks (optional, default []).
  *   Default is `[]`
@@ -126,6 +126,13 @@ corePlugins, };
  * @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.
  *
@@ -137,9 +144,12 @@ 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
  */
 /**
@@ -169,7 +179,7 @@ corePlugins, };
  */
 /**
  * @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
@@ -182,6 +192,7 @@ corePlugins, };
  * @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

package/dist/lib/MutableRouter.d.ts

@@ -18,152 +18,157 @@ export default class MutableRouter {
     /**
      * Prepend middleware function(s) using the `all()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependAll(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    prependAll(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Prepend middleware function(s) using the `get()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependGet(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    prependGet(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Prepend middleware function(s) using the `post()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependPost(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    prependPost(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Prepend middleware function(s) using the `delete()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependDelete(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    prependDelete(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Prepend middleware function(s) using the `put()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependPut(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    prependPut(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Prepend middleware function(s) using the `use()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
-     * @param {...RequestHandler} callbacks Additional middleware functions
+     * @param {PathParams | RequestHandlerParams} path Route path or middleware
+     *   function
+     * @param {...RequestHandlerParams} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependUse(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    prependUse(path: PathParams | RequestHandlerParams, ...callbacks: RequestHandlerParams[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `all()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    replaceAll(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    replaceAll(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `get()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    replaceGet(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    replaceGet(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `post()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    replacePost(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    replacePost(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `delete()`
      * method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    replaceDelete(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    replaceDelete(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `put()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    replacePut(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    replacePut(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `use()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
-     * @param {...RequestHandler} callbacks Additional middleware functions
+     * @param {PathParams | RequestHandlerParams} path Route path or middleware
+     *   function
+     * @param {...RequestHandlerParams} callbacks Additional middleware functions
      * @returns {void}
      */
-    replaceUse(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    replaceUse(path: PathParams | RequestHandlerParams, ...callbacks: RequestHandlerParams[]): void;
     /**
      * Append middleware function(s) using the `all()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    all(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    all(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Append middleware function(s) using the `get()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    get(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    get(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Append middleware function(s) using the `post()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    post(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    post(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Append middleware function(s) using the `delete()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    delete(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    delete(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Append middleware function(s) using the `put()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
-    put(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    put(path: PathParams | RequestHandler, ...callbacks: RequestHandler[]): void;
     /**
      * Append middleware function(s) using the `use()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
-     * @param {...RequestHandler} callbacks Additional middleware functions
+     * @param {PathParams | RequestHandlerParams} path Route path or middleware
+     *   function
+     * @param {...RequestHandlerParams} callbacks Additional middleware functions
      * @returns {void}
      */
-    use(path: string | RequestHandler, ...callbacks: RequestHandler[]): void;
+    use(path: PathParams | RequestHandlerParams, ...callbacks: RequestHandlerParams[]): void;
     route(): void;
     #private;
 }
 export type RequestHandler = import("express").RequestHandler;
+export type PathParams = import("express-serve-static-core").PathParams;
+export type RequestHandlerParams = import("express-serve-static-core").RequestHandlerParams;
 /**
  * Stack route
  */
@@ -175,11 +180,11 @@ export type StackRoute = {
     /**
      * Route path
      */
-    path: string;
+    path: PathParams;
     /**
      * Router arguments
      */
-    args: [string, ...RequestHandler[]];
+    args: [PathParams, ...RequestHandler[]];
 };
 import { Router } from "express";
 //# sourceMappingURL=MutableRouter.d.ts.map

package/dist/lib/MutableRouter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MutableRouter.d.ts","sourceRoot":"","sources":["../../src/lib/MutableRouter.js"],"names":[],"mappings":"AAEA,yCAAyC;AACzC;IAUE;;;;;;;OAOG;IACH,sBAFW,OAAO,SAAS,EAAE,aAAa,EAMzC;IAkDD;;;;OAIG;IACH,QAFa,MAAM,CAiBlB;IAID;;;;;;OAMG;IACH,iBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,kBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,oBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAID;;;;;;OAMG;IACH,iBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,kBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;;OAOG;IACH,oBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iBAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAID;;;;;;OAMG;IACH,UAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,UAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,WAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,aAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,UAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,UAJW,MAAM,GAAG,cAAc,gBACpB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED,cAIC;;CACF;6BAEa,OAAO,SAAS,EAAE,cAAc;;;;;;;;YAIhC,MAAM;;;;UACN,MAAM;;;;UACN,CAAC,MAAM,EAAE,GAAG,cAAc,EAAE,CAAC;;uBA3TpB,SAAS"}
+{"version":3,"file":"MutableRouter.d.ts","sourceRoot":"","sources":["../../src/lib/MutableRouter.js"],"names":[],"mappings":"AAEA,yCAAyC;AACzC;IAUE;;;;;;;OAOG;IACH,sBAFW,OAAO,SAAS,EAAE,aAAa,EAMzC;IAkDD;;;;OAIG;IACH,QAFa,MAAM,CAiBlB;IAID;;;;;;OAMG;IACH,iBAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iBAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,kBAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,oBAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iBAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;;OAOG;IACH,iBALW,UAAU,GAAG,oBAAoB,gBAE9B,oBAAoB,EAAA,GACrB,IAAI,CAIhB;IAID;;;;;;OAMG;IACH,iBAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iBAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,kBAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;;OAOG;IACH,oBAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,iBAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;;OAOG;IACH,iBALW,UAAU,GAAG,oBAAoB,gBAE9B,oBAAoB,EAAA,GACrB,IAAI,CAIhB;IAID;;;;;;OAMG;IACH,UAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,UAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,WAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,aAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;OAMG;IACH,UAJW,UAAU,GAAG,cAAc,gBACxB,cAAc,EAAA,GACf,IAAI,CAIhB;IAED;;;;;;;OAOG;IACH,UALW,UAAU,GAAG,oBAAoB,gBAE9B,oBAAoB,EAAA,GACrB,IAAI,CAIhB;IAED,cAIC;;CACF;6BAEa,OAAO,SAAS,EAAE,cAAc;yBAChC,OAAO,2BAA2B,EAAE,UAAU;mCAC9C,OAAO,2BAA2B,EAAE,oBAAoB;;;;;;;;YAIxD,MAAM;;;;UACN,UAAU;;;;UACV,CAAC,UAAU,EAAE,GAAG,cAAc,EAAE,CAAC;;uBAhUxB,SAAS"}

package/dist/lib/MutableRouter.js

@@ -79,7 +79,7 @@ export default class MutableRouter {
     /**
      * Prepend middleware function(s) using the `all()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -89,7 +89,7 @@ export default class MutableRouter {
     /**
      * Prepend middleware function(s) using the `get()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -99,7 +99,7 @@ export default class MutableRouter {
     /**
      * Prepend middleware function(s) using the `post()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -109,7 +109,7 @@ export default class MutableRouter {
     /**
      * Prepend middleware function(s) using the `delete()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -119,7 +119,7 @@ export default class MutableRouter {
     /**
      * Prepend middleware function(s) using the `put()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -129,8 +129,9 @@ export default class MutableRouter {
     /**
      * Prepend middleware function(s) using the `use()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
-     * @param {...RequestHandler} callbacks Additional middleware functions
+     * @param {PathParams | RequestHandlerParams} path Route path or middleware
+     *   function
+     * @param {...RequestHandlerParams} callbacks Additional middleware functions
      * @returns {void}
      */
     prependUse(path, ...callbacks) {
@@ -140,7 +141,7 @@ export default class MutableRouter {
     /**
      * Replace middleware function(s) that were mounted using the `all()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -150,7 +151,7 @@ export default class MutableRouter {
     /**
      * Replace middleware function(s) that were mounted using the `get()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -160,7 +161,7 @@ export default class MutableRouter {
     /**
      * Replace middleware function(s) that were mounted using the `post()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -171,7 +172,7 @@ export default class MutableRouter {
      * Replace middleware function(s) that were mounted using the `delete()`
      * method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -181,7 +182,7 @@ export default class MutableRouter {
     /**
      * Replace middleware function(s) that were mounted using the `put()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -191,8 +192,9 @@ export default class MutableRouter {
     /**
      * Replace middleware function(s) that were mounted using the `use()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
-     * @param {...RequestHandler} callbacks Additional middleware functions
+     * @param {PathParams | RequestHandlerParams} path Route path or middleware
+     *   function
+     * @param {...RequestHandlerParams} callbacks Additional middleware functions
      * @returns {void}
      */
     replaceUse(path, ...callbacks) {
@@ -202,7 +204,7 @@ export default class MutableRouter {
     /**
      * Append middleware function(s) using the `all()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -212,7 +214,7 @@ export default class MutableRouter {
     /**
      * Append middleware function(s) using the `get()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -222,7 +224,7 @@ export default class MutableRouter {
     /**
      * Append middleware function(s) using the `post()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -232,7 +234,7 @@ export default class MutableRouter {
     /**
      * Append middleware function(s) using the `delete()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -242,7 +244,7 @@ export default class MutableRouter {
     /**
      * Append middleware function(s) using the `put()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
+     * @param {PathParams | RequestHandler} path Route path or middleware function
      * @param {...RequestHandler} callbacks Additional middleware functions
      * @returns {void}
      */
@@ -252,8 +254,9 @@ export default class MutableRouter {
     /**
      * Append middleware function(s) using the `use()` method.
      *
-     * @param {string | RequestHandler} path Route path or middleware function
-     * @param {...RequestHandler} callbacks Additional middleware functions
+     * @param {PathParams | RequestHandlerParams} path Route path or middleware
+     *   function
+     * @param {...RequestHandlerParams} callbacks Additional middleware functions
      * @returns {void}
      */
     use(path, ...callbacks) {
@@ -264,9 +267,11 @@ export default class MutableRouter {
     }
 }
 /** @typedef {import("express").RequestHandler} RequestHandler */
+/** @typedef {import("express-serve-static-core").PathParams} PathParams */
+/** @typedef {import("express-serve-static-core").RequestHandlerParams} RequestHandlerParams */
 /**
  * @typedef {object} StackRoute Stack route
  * @property {string} method HTTP request method
- * @property {string} path Route path
- * @property {[string, ...RequestHandler[]]} args Router arguments
+ * @property {PathParams} path Route path
+ * @property {[PathParams, ...RequestHandler[]]} args Router arguments
  */

package/dist/lib/nunjucks.d.ts

@@ -7,10 +7,11 @@
  * Create a Nunjucks environment.
  *
  * @param {NunjucksOptions} options Nunjucks options
- * @returns {Environment} Nunjucks Environment instance
+ * @returns {import("../casa.js").CasaNunjucksEnvironment} Nunjucks Environment
+ *   instance
  * @access private
  */
-export default function nunjucksConfig({ views }: NunjucksOptions): Environment;
+export default function nunjucksConfig({ views }: NunjucksOptions): import("../casa.js").CasaNunjucksEnvironment;
 export type NunjucksOptions = {
     /**
      * Template file directories (optional, default
@@ -18,5 +19,4 @@ export type NunjucksOptions = {
      */
     views?: string[] | undefined;
 };
-import { Environment } from "nunjucks";
 //# sourceMappingURL=nunjucks.d.ts.map

package/dist/lib/nunjucks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nunjucks.d.ts","sourceRoot":"","sources":["../../src/lib/nunjucks.js"],"names":[],"mappings":"AAUA;;;;GAIG;AAEH;;;;;;GAMG;AACH,kDAJW,eAAe,GACb,WAAW,CA+BvB;;;;;;;;4BAnD2B,UAAU"}
+{"version":3,"file":"nunjucks.d.ts","sourceRoot":"","sources":["../../src/lib/nunjucks.js"],"names":[],"mappings":"AAUA;;;;GAIG;AAEH;;;;;;;GAOG;AACH,kDALW,eAAe,GACb,OAAO,YAAY,EAAE,uBAAuB,CAgCxD"}

package/dist/lib/nunjucks.js

@@ -11,7 +11,8 @@ import { mergeObjects, includes, renderAsAttributes, formatDateObject, } from ".
  * Create a Nunjucks environment.
  *
  * @param {NunjucksOptions} options Nunjucks options
- * @returns {Environment} Nunjucks Environment instance
+ * @returns {import("../casa.js").CasaNunjucksEnvironment} Nunjucks Environment
+ *   instance
  * @access private
  */
 export default function nunjucksConfig({ views = [] }) {

package/dist/middleware/post.d.ts

@@ -1,4 +1,5 @@
-/** @returns {RequestHandler[]} Middleware functions */
-export default function postMiddleware(): RequestHandler[];
+/** @returns {[RequestHandler, ErrorRequestHandler]} Middleware functions */
+export default function postMiddleware(): [RequestHandler, ErrorRequestHandler];
 export type RequestHandler = import("express").RequestHandler;
+export type ErrorRequestHandler = import("express").ErrorRequestHandler;
 //# sourceMappingURL=post.d.ts.map

package/dist/middleware/post.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"post.d.ts","sourceRoot":"","sources":["../../src/middleware/post.js"],"names":[],"mappings":"AAUA,uDAAuD;AACvD,0CADc,cAAc,EAAE,CA4E7B;6BAlFY,OAAO,SAAS,EAAE,cAAc"}
+{"version":3,"file":"post.d.ts","sourceRoot":"","sources":["../../src/middleware/post.js"],"names":[],"mappings":"AAYA,4EAA4E;AAC5E,0CADc,CAAC,cAAc,EAAE,mBAAmB,CAAC,CA4ElD;6BApFY,OAAO,SAAS,EAAE,cAAc;kCAEhC,OAAO,SAAS,EAAE,mBAAmB"}

package/dist/middleware/post.js

@@ -2,10 +2,12 @@
 import logger from "../lib/logger.js";
 /**
  * @typedef {import("express").RequestHandler} RequestHandler
+ *
+ * @typedef {import("express").ErrorRequestHandler} ErrorRequestHandler
  * @access private
  */
 const log = logger("middleware:post");
-/** @returns {RequestHandler[]} Middleware functions */
+/** @returns {[RequestHandler, ErrorRequestHandler]} Middleware functions */
 export default function postMiddleware() {
     return [
         (req, res) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "10.0.0",
+  "version": "10.1.0",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
   "repository": {
     "type": "git",
@@ -58,9 +58,9 @@
     "express-session": "1.19.0",
     "fast-equals": "6.0.0",
     "govuk-frontend": "6.1.0",
-    "helmet": "8.1.0",
-    "i18next": "26.0.10",
-    "i18next-http-middleware": "3.9.6",
+    "helmet": "8.2.0",
+    "i18next": "26.3.0",
+    "i18next-http-middleware": "3.9.7",
     "is-plain-obj": "4.1.0",
     "js-yaml": "4.1.1",
     "luxon": "3.7.2",
@@ -70,30 +70,30 @@
     "validator": "13.15.35"
   },
   "devDependencies": {
-    "@dwp/casa-spiderplan": "4.6.2",
-    "@dwp/casa-spiderplan-a11y-plugin": "1.1.0",
-    "@dwp/casa-spiderplan-zap-plugin": "1.1.0",
+    "@dwp/casa-spiderplan": "5.0.0",
+    "@dwp/casa-spiderplan-a11y-plugin": "2.0.0",
+    "@dwp/casa-spiderplan-zap-plugin": "2.0.0",
     "@dwp/commitlint-config-base": "5.0.0",
     "@dwp/eslint-config-base": "9.0.2",
     "@types/express": "5.0.6",
     "@types/luxon": "3.7.1",
-    "@types/node": "25.6.0",
+    "@types/node": "25.9.1",
     "@types/nunjucks": "3.2.6",
     "c8": "11.0.0",
     "cheerio": "1.2.0",
-    "commitlint": "20.5.3",
+    "commitlint": "21.0.1",
     "docdash": "2.0.2",
     "eslint": "9.39.4",
     "eslint-plugin-import": "2.32.0",
-    "eslint-plugin-jsdoc": "62.9.0",
+    "eslint-plugin-jsdoc": "63.0.0",
     "eslint-plugin-security": "4.0.0",
     "eslint-plugin-sonarjs": "4.0.3",
-    "fast-check": "4.7.0",
+    "fast-check": "4.8.0",
     "jsdoc": "4.0.5",
     "jsdoc-tsimport-plugin": "1.0.5",
     "prettier": "3.8.3",
     "prettier-plugin-jsdoc": "1.8.0",
-    "sass": "1.99.0",
+    "sass": "1.100.0",
     "supertest": "7.2.2",
     "ts-api-utils": "2.5.0",
     "typescript": "6.0.3"

package/src/casa.js

@@ -90,7 +90,7 @@ export {
  *   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
+ * @property {ErrorVisibiltyFunction | symbol} [errorVisibility] Should page
  *   validation errors be visible on GET requests
  * @property {PageHook[]} [hooks=[]] Page-specific hooks (optional, default []).
  *   Default is `[]`
@@ -160,6 +160,14 @@ export {
  * @returns {HelmetOptions} The modified configuration object
  */
 
+/**
+ * @typedef {Omit<
+ *   import("nunjucks").Environment &
+ *     import("./lib/CasaTemplateLoader.js").default,
+ *   "getSource"
+ * >} CasaNunjucksEnvironment
+ */
+
 /**
  * Mounting function.
  *
@@ -171,9 +179,12 @@ export {
  *
  * @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
  */
 
@@ -205,7 +216,7 @@ export {
 
 /**
  * @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
@@ -218,6 +229,7 @@ export {
  * @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

package/src/lib/MutableRouter.js

@@ -100,7 +100,7 @@ export default class MutableRouter {
   /**
    * Prepend middleware function(s) using the `all()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -111,7 +111,7 @@ export default class MutableRouter {
   /**
    * Prepend middleware function(s) using the `get()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -122,7 +122,7 @@ export default class MutableRouter {
   /**
    * Prepend middleware function(s) using the `post()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -133,7 +133,7 @@ export default class MutableRouter {
   /**
    * Prepend middleware function(s) using the `delete()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -144,7 +144,7 @@ export default class MutableRouter {
   /**
    * Prepend middleware function(s) using the `put()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -155,8 +155,9 @@ export default class MutableRouter {
   /**
    * Prepend middleware function(s) using the `use()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
-   * @param {...RequestHandler} callbacks Additional middleware functions
+   * @param {PathParams | RequestHandlerParams} path Route path or middleware
+   *   function
+   * @param {...RequestHandlerParams} callbacks Additional middleware functions
    * @returns {void}
    */
   prependUse(path, ...callbacks) {
@@ -168,7 +169,7 @@ export default class MutableRouter {
   /**
    * Replace middleware function(s) that were mounted using the `all()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -179,7 +180,7 @@ export default class MutableRouter {
   /**
    * Replace middleware function(s) that were mounted using the `get()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -190,7 +191,7 @@ export default class MutableRouter {
   /**
    * Replace middleware function(s) that were mounted using the `post()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -202,7 +203,7 @@ export default class MutableRouter {
    * Replace middleware function(s) that were mounted using the `delete()`
    * method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -213,7 +214,7 @@ export default class MutableRouter {
   /**
    * Replace middleware function(s) that were mounted using the `put()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -224,8 +225,9 @@ export default class MutableRouter {
   /**
    * Replace middleware function(s) that were mounted using the `use()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
-   * @param {...RequestHandler} callbacks Additional middleware functions
+   * @param {PathParams | RequestHandlerParams} path Route path or middleware
+   *   function
+   * @param {...RequestHandlerParams} callbacks Additional middleware functions
    * @returns {void}
    */
   replaceUse(path, ...callbacks) {
@@ -237,7 +239,7 @@ export default class MutableRouter {
   /**
    * Append middleware function(s) using the `all()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -248,7 +250,7 @@ export default class MutableRouter {
   /**
    * Append middleware function(s) using the `get()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -259,7 +261,7 @@ export default class MutableRouter {
   /**
    * Append middleware function(s) using the `post()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -270,7 +272,7 @@ export default class MutableRouter {
   /**
    * Append middleware function(s) using the `delete()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -281,7 +283,7 @@ export default class MutableRouter {
   /**
    * Append middleware function(s) using the `put()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
+   * @param {PathParams | RequestHandler} path Route path or middleware function
    * @param {...RequestHandler} callbacks Additional middleware functions
    * @returns {void}
    */
@@ -292,8 +294,9 @@ export default class MutableRouter {
   /**
    * Append middleware function(s) using the `use()` method.
    *
-   * @param {string | RequestHandler} path Route path or middleware function
-   * @param {...RequestHandler} callbacks Additional middleware functions
+   * @param {PathParams | RequestHandlerParams} path Route path or middleware
+   *   function
+   * @param {...RequestHandlerParams} callbacks Additional middleware functions
    * @returns {void}
    */
   use(path, ...callbacks) {
@@ -308,10 +311,12 @@ export default class MutableRouter {
 }
 
 /** @typedef {import("express").RequestHandler} RequestHandler */
+/** @typedef {import("express-serve-static-core").PathParams} PathParams */
+/** @typedef {import("express-serve-static-core").RequestHandlerParams} RequestHandlerParams */
 
 /**
  * @typedef {object} StackRoute Stack route
  * @property {string} method HTTP request method
- * @property {string} path Route path
- * @property {[string, ...RequestHandler[]]} args Router arguments
+ * @property {PathParams} path Route path
+ * @property {[PathParams, ...RequestHandler[]]} args Router arguments
  */

package/src/lib/nunjucks.js

@@ -18,7 +18,8 @@ import {
  * Create a Nunjucks environment.
  *
  * @param {NunjucksOptions} options Nunjucks options
- * @returns {Environment} Nunjucks Environment instance
+ * @returns {import("../casa.js").CasaNunjucksEnvironment} Nunjucks Environment
+ *   instance
  * @access private
  */
 export default function nunjucksConfig({ views = [] }) {

package/src/middleware/post.js

@@ -3,12 +3,14 @@ import logger from "../lib/logger.js";
 
 /**
  * @typedef {import("express").RequestHandler} RequestHandler
+ *
+ * @typedef {import("express").ErrorRequestHandler} ErrorRequestHandler
  * @access private
  */
 
 const log = logger("middleware:post");
 
-/** @returns {RequestHandler[]} Middleware functions */
+/** @returns {[RequestHandler, ErrorRequestHandler]} Middleware functions */
 export default function postMiddleware() {
   return [
     (req, res) => {