@dwp/govuk-casa 8.5.1 → 8.6.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [8.6.0](https://github.com/dwp/govuk-casa/compare/8.5.2...8.6.0) (2022-11-04)
+
+
+### Features
+
+* **better-typescript-support:** fixes and additions to types ([8dda905](https://github.com/dwp/govuk-casa/commit/8dda9050b53ee8a5f53c8f7c1cb4afa91df2e674))
+
+### [8.5.2](https://github.com/dwp/govuk-casa/compare/8.5.1...8.5.2) (2022-10-31)
+
 ### [8.5.1](https://github.com/dwp/govuk-casa/compare/8.5.0...8.5.1) (2022-10-13)
 
 ## [8.5.0](https://github.com/dwp/govuk-casa/compare/8.4.0...8.5.0) (2022-09-22)

package/dist/casa.d.ts

@@ -1,5 +1,19 @@
 export type PageField = import('./lib/field').PageField;
-export type ContextEventHandler = (opts: object, journeyContext: JourneyContext, previousContext: JourneyContext, session: object) => void;
+export type ContextEventHandlerOptions = {
+    /**
+     * Context including changes
+     */
+    journeyContext: JourneyContext;
+    /**
+     * Context prior to changes
+     */
+    previousContext: JourneyContext;
+    /**
+     * Request session object
+     */
+    session: object;
+};
+export type ContextEventHandler = (opts: ContextEventHandlerOptions) => void;
 export type ContextEvent = {
     /**
      * Waypoint to watch for changes
@@ -100,6 +114,11 @@ export type SessionOptions = {
      * Session store (default MemoryStore)
      */
     store?: object | undefined;
+    /**
+     * the URL path on which the session cookie
+     * is valid (defaults to '/')
+     */
+    cookiePath?: string | undefined;
 };
 /**
  * Plugin interface
@@ -127,7 +146,6 @@ export type HelmetConfigurator = (config: object) => object;
  * they will be "sealed".
  */
 export type Mounter = (app: import('express').Express, opts: object, route?: string | undefined) => import('express').Express;
-export type MutableRouter = import('./lib/index').MutableRouter;
 /**
  * Configuration options
  */
@@ -159,7 +177,7 @@ export type ConfigurationOptions = {
     /**
      * I18n configuration
      */
-    i18n?: I18nOptions[] | undefined;
+    i18n?: I18nOptions | undefined;
     /**
      * CASA Plan
      */
@@ -435,7 +453,8 @@ 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 * as nunjucksFilters from "./lib/nunjucks-filters.js";
-export { configure, validators, field, Plan, JourneyContext, ValidatorFactory, ValidationError, waypointUrl, endSession, nunjucksFilters };
+export { configure, validators, field, Plan, JourneyContext, ValidatorFactory, ValidationError, MutableRouter, waypointUrl, endSession, nunjucksFilters };

package/dist/casa.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.nunjucksFilters = exports.endSession = exports.waypointUrl = exports.ValidationError = exports.ValidatorFactory = exports.JourneyContext = exports.Plan = exports.field = exports.validators = exports.configure = void 0;
+exports.nunjucksFilters = 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;
@@ -42,6 +42,8 @@ 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"));
@@ -53,12 +55,15 @@ exports.nunjucksFilters = nunjucksFilters;
 /**
  * @typedef {import('./lib/field').PageField} PageField
  */
+/**
+ * @typedef {object} ContextEventHandlerOptions
+ * @property {JourneyContext} journeyContext Context including changes
+ * @property {JourneyContext} previousContext Context prior to changes
+ * @property {object} session Request session object
+ */
 /**
  * @callback ContextEventHandler
- * @param {object} opts Options
- * @param {JourneyContext} opts.journeyContext Context including changes
- * @param {JourneyContext} opts.previousContext Context prior to changes
- * @param {object} opts.session Request session object
+ * @param {ContextEventHandlerOptions} opts Options
  * @returns {void}
  */
 /**
@@ -98,6 +103,8 @@ exports.nunjucksFilters = nunjucksFilters;
  * @property {boolean} [secure=false] Whether to use secure session cookies
  * @property {boolean|string} [cookieSameSite=true] SameSite (true = Strict)
  * @property {object} [store] Session store (default MemoryStore)
+ * @property {string} [cookiePath] the URL path on which the session cookie
+ * is valid (defaults to '/')
  */
 /**
  * @typedef {object} IPlugin Plugin interface
@@ -132,9 +139,6 @@ exports.nunjucksFilters = nunjucksFilters;
  * @param {string} [opts.route='/'] Optional route to attach all middleware/routers too
  * @returns {import('express').Express} The prepared ExpressJS app instance
  */
-/**
- * @typedef {import('./lib/index').MutableRouter} MutableRouter
- */
 /**
  * Configure some middleware for use in creating a new CASA app.
  *
@@ -145,7 +149,7 @@ exports.nunjucksFilters = nunjucksFilters;
  * @property {Page[]} [pages=[]] Pages the represent waypoints
  * @property {GlobalHook[]} [hooks=[]] Hooks to apply
  * @property {IPlugin[]} [plugins=[]] Plugins
- * @property {I18nOptions[]} [i18n] I18n configuration
+ * @property {I18nOptions} [i18n] I18n configuration
  * @property {Plan} [plan] CASA Plan
  * @property {ContextEvent[]} [events=[]] Handlers for JourneyContext events
  * @property {HelmetConfigurator} [helmetConfigurator] Helmet configuration manipulator function

package/dist/lib/JourneyContext.d.ts

@@ -184,20 +184,20 @@ export default class JourneyContext {
      * `identity` holds information that helps uniquely identify this context
      * among a group of contexts stored in the session.
      *
-     * @param {object} data Entire journey data.
+     * @param {Record<string,unknown>} 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.
      */
-    constructor(data?: object, validation?: object, nav?: object, identity?: object);
+    constructor(data?: Record<string, unknown>, validation?: object, nav?: object, identity?: object);
     /**
      * Clone into an object that can be stringified.
      *
      * @returns {object} Plain object.
      */
     toObject(): object;
-    set data(arg: object);
-    get data(): object;
+    set data(arg: Record<string, unknown>);
+    get data(): Record<string, unknown>;
     get validation(): object;
     get nav(): object;
     get identity(): object;

package/dist/lib/JourneyContext.js

@@ -88,7 +88,7 @@ class JourneyContext {
      * `identity` holds information that helps uniquely identify this context
      * among a group of contexts stored in the session.
      *
-     * @param {object} data Entire journey data.
+     * @param {Record<string,unknown>} 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.

package/dist/lib/MutableRouter.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @memberof module:@dwp/govuk-casa
+ */
 export default class MutableRouter {
     /**
      * Seals this router to make it immutable. Returns the ExpressJS router.
@@ -8,147 +11,147 @@ export default class MutableRouter {
     /**
      * Prepend middleware function(s) using the `all()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependAll(path: string, ...callbacks: Function[]): void;
+    prependAll(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Prepend middleware function(s) using the `get()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependGet(path: string, ...callbacks: Function[]): void;
+    prependGet(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Prepend middleware function(s) using the `post()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependPost(path: string, ...callbacks: Function[]): void;
+    prependPost(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Prepend middleware function(s) using the `delete()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependDelete(path: string, ...callbacks: Function[]): void;
+    prependDelete(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Prepend middleware function(s) using the `put()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependPut(path: string, ...callbacks: Function[]): void;
+    prependPut(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Prepend middleware function(s) using the `use()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    prependUse(path: string, ...callbacks: Function[]): void;
+    prependUse(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `all()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    replaceAll(path: string, ...callbacks: Function[]): void;
+    replaceAll(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `get()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    replaceGet(path: string, ...callbacks: Function[]): void;
+    replaceGet(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `post()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    replacePost(path: string, ...callbacks: Function[]): void;
+    replacePost(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `delete()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    replaceDelete(path: string, ...callbacks: Function[]): void;
+    replaceDelete(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `put()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    replacePut(path: string, ...callbacks: Function[]): void;
+    replacePut(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Replace middleware function(s) that were mounted using the `use()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    replaceUse(path: string, ...callbacks: Function[]): void;
+    replaceUse(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Append middleware function(s) using the `all()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    all(path: string, ...callbacks: Function[]): void;
+    all(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Append middleware function(s) using the `get()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    get(path: string, ...callbacks: Function[]): void;
+    get(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Append middleware function(s) using the `post()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    post(path: string, ...callbacks: Function[]): void;
+    post(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Append middleware function(s) using the `delete()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    delete(path: string, ...callbacks: Function[]): void;
+    delete(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Append middleware function(s) using the `put()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    put(path: string, ...callbacks: Function[]): void;
+    put(path: string | Function, ...callbacks: Function[]): void;
     /**
      * Append middleware function(s) using the `use()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
-    use(path: string, ...callbacks: Function[]): void;
+    use(path: string | Function, ...callbacks: Function[]): void;
     route(): void;
     #private;
 }

package/dist/lib/MutableRouter.js

@@ -14,9 +14,14 @@ var _MutableRouter_instances, _MutableRouter_stack, _MutableRouter_router, _Muta
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable sonarjs/no-duplicate-string,class-methods-use-this */
 const express_1 = require("express");
+/**
+ * @memberof module:@dwp/govuk-casa
+ */
 class MutableRouter {
     /**
-     * Mutable router.
+     * A wrapping class to make Express routers mutable. You can append, prepend
+     * and remove routes from a MutableRouter before finally "sealing" it and
+     * mounting it on your Express app.
      *
      * @class
      */
@@ -34,7 +39,7 @@ class MutableRouter {
          * @type {boolean}
          */
         _MutableRouter_sealed.set(this, void 0);
-        __classPrivateFieldSet(this, _MutableRouter_router, new express_1.Router(), "f");
+        __classPrivateFieldSet(this, _MutableRouter_router, (0, express_1.Router)(), "f");
         __classPrivateFieldSet(this, _MutableRouter_stack, [], "f");
         __classPrivateFieldSet(this, _MutableRouter_sealed, false, "f");
     }
@@ -60,8 +65,8 @@ class MutableRouter {
     /**
      * Prepend middleware function(s) using the `all()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     prependAll(path, ...callbacks) {
@@ -70,8 +75,8 @@ class MutableRouter {
     /**
      * Prepend middleware function(s) using the `get()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     prependGet(path, ...callbacks) {
@@ -80,8 +85,8 @@ class MutableRouter {
     /**
      * Prepend middleware function(s) using the `post()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     prependPost(path, ...callbacks) {
@@ -90,8 +95,8 @@ class MutableRouter {
     /**
      * Prepend middleware function(s) using the `delete()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     prependDelete(path, ...callbacks) {
@@ -100,8 +105,8 @@ class MutableRouter {
     /**
      * Prepend middleware function(s) using the `put()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     prependPut(path, ...callbacks) {
@@ -110,8 +115,8 @@ class MutableRouter {
     /**
      * Prepend middleware function(s) using the `use()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     prependUse(path, ...callbacks) {
@@ -121,8 +126,8 @@ class MutableRouter {
     /**
      * Replace middleware function(s) that were mounted using the `all()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     replaceAll(path, ...callbacks) {
@@ -131,8 +136,8 @@ class MutableRouter {
     /**
      * Replace middleware function(s) that were mounted using the `get()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     replaceGet(path, ...callbacks) {
@@ -141,8 +146,8 @@ class MutableRouter {
     /**
      * Replace middleware function(s) that were mounted using the `post()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     replacePost(path, ...callbacks) {
@@ -151,8 +156,8 @@ class MutableRouter {
     /**
      * Replace middleware function(s) that were mounted using the `delete()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     replaceDelete(path, ...callbacks) {
@@ -161,8 +166,8 @@ class MutableRouter {
     /**
      * Replace middleware function(s) that were mounted using the `put()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     replacePut(path, ...callbacks) {
@@ -171,8 +176,8 @@ class MutableRouter {
     /**
      * Replace middleware function(s) that were mounted using the `use()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     replaceUse(path, ...callbacks) {
@@ -182,8 +187,8 @@ class MutableRouter {
     /**
      * Append middleware function(s) using the `all()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     all(path, ...callbacks) {
@@ -192,8 +197,8 @@ class MutableRouter {
     /**
      * Append middleware function(s) using the `get()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     get(path, ...callbacks) {
@@ -202,8 +207,8 @@ class MutableRouter {
     /**
      * Append middleware function(s) using the `post()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     post(path, ...callbacks) {
@@ -212,8 +217,8 @@ class MutableRouter {
     /**
      * Append middleware function(s) using the `delete()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     delete(path, ...callbacks) {
@@ -222,8 +227,8 @@ class MutableRouter {
     /**
      * Append middleware function(s) using the `put()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     put(path, ...callbacks) {
@@ -232,8 +237,8 @@ class MutableRouter {
     /**
      * Append middleware function(s) using the `use()` method.
      *
-     * @param {string} path route path
-     * @param  {...Function} callbacks Middleware functions
+     * @param {string | Function} path route path or middleware function
+     * @param  {...Function} callbacks Additional middleware functions
      * @returns {void}
      */
     use(path, ...callbacks) {

package/dist/lib/ValidatorFactory.d.ts

@@ -19,7 +19,7 @@
  * @typedef {import('../casa').Validator} Validator
  */
 /**
- * @typedef {object} ValidatorFactoryOptions
+ * @typedef {Object.<string, unknown>} ValidatorFactoryOptions
  * @property {ErrorMessageConfig} errorMsg Error message
  */
 /**
@@ -42,7 +42,9 @@ export default class ValidatorFactory {
      * @param {ValidatorFactoryOptions} config Validator config (custom to each validator)
      */
     constructor(config?: ValidatorFactoryOptions);
-    config: ValidatorFactoryOptions;
+    config: {
+        [x: string]: unknown;
+    };
     /**
      * Validate the given value.
      *
@@ -66,8 +68,5 @@ export type ValidationError = import('./index').ValidationError;
 export type ValidateContext = import('../casa').ValidateContext;
 export type Validator = import('../casa').Validator;
 export type ValidatorFactoryOptions = {
-    /**
-     * Error message
-     */
-    errorMsg: ErrorMessageConfig;
+    [x: string]: unknown;
 };

package/dist/lib/ValidatorFactory.js

@@ -27,7 +27,7 @@ const { isPlainObject } = lodash_1.default; // CommonJS
  * @typedef {import('../casa').Validator} Validator
  */
 /**
- * @typedef {object} ValidatorFactoryOptions
+ * @typedef {Object.<string, unknown>} ValidatorFactoryOptions
  * @property {ErrorMessageConfig} errorMsg Error message
  */
 /**

package/dist/lib/field.d.ts

@@ -3,15 +3,15 @@
  *
  * @memberof module:@dwp/govuk-casa
  * @param {string} name Field name
- * @param {object} opts Options
+ * @param {object} [opts] Options
  * @param {boolean} [opts.optional=false] Whether this field is optional
  * @param {boolean} [opts.persist=true] Whether this field will persist in `req.body`
  * @returns {PageField} A PageField
  */
-export default function field(name: string, opts: {
+export default function field(name: string, opts?: {
     optional?: boolean | undefined;
     persist?: boolean | undefined;
-}): PageField;
+} | undefined): PageField;
 /**
  * This class is not exposed via the public API. Instances should instead be
  * instantiated through the `field()` factory function.
@@ -23,14 +23,14 @@ export class PageField {
      * Create a field.
      *
      * @param {string} name Field name
-     * @param {object} opts Options
+     * @param {object} [opts] Options
      * @param {boolean} [opts.optional=false] Whether this field is optional
      * @param {boolean} [opts.persist=true] Whether this field will persist in `req.body`
      */
     constructor(name: string, { optional, persist }?: {
         optional?: boolean | undefined;
         persist?: boolean | undefined;
-    });
+    } | undefined);
     /**
      * Clone this field.
      *
@@ -68,38 +68,63 @@ export class PageField {
      * @throws {SyntaxError} When the name is invalid in some way
      */
     rename(name: string): PageField;
+    /**
+     * Get validators
+     *
+     * @returns {Validator[]} A list containing all validators.
+     */
+    getValidators(): Validator[];
     /**
      * Add/get value validators
      * Some validators will include a `sanitise()` method which will be run at the
      * same time as other "processors".
      *
      * @param {Validator[]} items Validation functions
-     * @returns {PageField | Validator[]} Chain or return all validators
+     * @returns {PageField} Chain - Deprecated: this currently gets all validators if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getValidators().
      */
-    validators(items?: Validator[]): PageField | Validator[];
+    validators(items?: Validator[]): PageField;
+    /**
+     * Get processors
+     *
+     * @returns {FieldProcessorFunction[]} A list containing all processors.
+     */
+    getProcessors(): FieldProcessorFunction[];
     /**
      * Add/get value pre-processors
      * This is most often used to sanitise values to a particular data type.
      *
      * @param {FieldProcessorFunction[]} items Processor functions
-     * @returns {PageField | FieldProcessorFunction[]} Chain or return all processors
+     * @returns {PageField} Chain - Deprecated: this currently gets all processors if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getProcessors().
+     */
+    processors(items?: FieldProcessorFunction[]): PageField;
+    /**
+     * Get conditions
+     *
+     * @returns {ValidatorConditionFunction[]} A list containing all conditions.
      */
-    processors(items?: FieldProcessorFunction[]): PageField | FieldProcessorFunction[];
+    getConditions(): ValidatorConditionFunction[];
     /**
      * Add/get conditions
      * All conditions must be met in order for this field to be considered
      * "actionable".
      *
      * @param {ValidatorConditionFunction[]} items Condition functions
-     * @returns {PageField | ValidatorConditionFunction[]} Chain or return all conditions
+     * @returns {PageField} Chain - Deprecated: this currently gets all conditions if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getConditions().
      */
-    conditions(items?: ValidatorConditionFunction[]): PageField | ValidatorConditionFunction[];
+    conditions(items?: ValidatorConditionFunction[]): PageField;
     /**
      * Run all validators and return array of errors, if applicable.
      *
      * @param {any} value Value to validate
      * @param {ValidateContext} context Contextual validation information
      * @returns {ValidationError[]} Errors, or an empty array if all valid
+     * @throws {TypeError} If validator does not return an array
      */
     runValidators(value: any, context?: ValidateContext): ValidationError[];
     /**

package/dist/lib/field.js

@@ -19,8 +19,8 @@ exports.PageField = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const utils_js_1 = require("./utils.js");
 const logger_js_1 = __importDefault(require("./logger.js"));
-const { isFunction } = lodash_1.default;
 const log = (0, logger_js_1.default)('lib:field');
+const { isFunction } = lodash_1.default;
 /**
  * @access private
  * @typedef {import('./index').JourneyContext} JourneyContext
@@ -60,7 +60,7 @@ class PageField {
      * Create a field.
      *
      * @param {string} name Field name
-     * @param {object} opts Options
+     * @param {object} [opts] Options
      * @param {boolean} [opts.optional=false] Whether this field is optional
      * @param {boolean} [opts.persist=true] Whether this field will persist in `req.body`
      */
@@ -100,6 +100,7 @@ class PageField {
             complexFieldProperty: undefined,
         }, "f");
         // Apply name
+        /* eslint-disable-next-line security/detect-non-literal-fs-filename */
         this.rename(name);
     }
     /**
@@ -112,14 +113,14 @@ class PageField {
             optional: __classPrivateFieldGet(this, _PageField_meta, "f").optional,
             persist: __classPrivateFieldGet(this, _PageField_meta, "f").persist,
         });
-        if (this.validators()) {
-            clone.validators(this.validators());
+        if (this.getValidators()) {
+            clone.validators(this.getValidators());
         }
-        if (this.conditions()) {
-            clone.conditions(this.conditions());
+        if (this.getConditions()) {
+            clone.conditions(this.getConditions());
         }
-        if (this.processors()) {
-            clone.processors(this.processors());
+        if (this.getProcessors()) {
+            clone.processors(this.getProcessors());
         }
         return clone;
     }
@@ -195,46 +196,79 @@ class PageField {
         }
         return this;
     }
+    /**
+     * Get validators
+     *
+     * @returns {Validator[]} A list containing all validators.
+     */
+    getValidators() {
+        return __classPrivateFieldGet(this, _PageField_validators, "f");
+    }
     /**
      * Add/get value validators
      * Some validators will include a `sanitise()` method which will be run at the
      * same time as other "processors".
      *
      * @param {Validator[]} items Validation functions
-     * @returns {PageField | Validator[]} Chain or return all validators
+     * @returns {PageField} Chain - Deprecated: this currently gets all validators if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getValidators().
      */
     validators(items = []) {
         if (!items.length) {
-            return __classPrivateFieldGet(this, _PageField_validators, "f");
+            log.warn('Calling validators() to get all validators is deprecated, please use getValidators()');
+            return this.getValidators();
         }
         __classPrivateFieldSet(this, _PageField_validators, [...__classPrivateFieldGet(this, _PageField_validators, "f"), ...(items.flat())], "f");
         return this;
     }
+    /**
+     * Get processors
+     *
+     * @returns {FieldProcessorFunction[]} A list containing all processors.
+     */
+    getProcessors() {
+        return __classPrivateFieldGet(this, _PageField_processors, "f");
+    }
     /**
      * Add/get value pre-processors
      * This is most often used to sanitise values to a particular data type.
      *
      * @param {FieldProcessorFunction[]} items Processor functions
-     * @returns {PageField | FieldProcessorFunction[]} Chain or return all processors
+     * @returns {PageField} Chain - Deprecated: this currently gets all processors if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getProcessors().
      */
     processors(items = []) {
         if (!items.length) {
-            return __classPrivateFieldGet(this, _PageField_processors, "f");
+            log.warn('Calling processors() to get all processors is deprecated, please use getProcessors()');
+            return this.getProcessors();
         }
         __classPrivateFieldSet(this, _PageField_processors, [...__classPrivateFieldGet(this, _PageField_processors, "f"), ...(items.flat())], "f");
         return this;
     }
+    /**
+     * Get conditions
+     *
+     * @returns {ValidatorConditionFunction[]} A list containing all conditions.
+     */
+    getConditions() {
+        return __classPrivateFieldGet(this, _PageField_conditions, "f");
+    }
     /**
      * Add/get conditions
      * All conditions must be met in order for this field to be considered
      * "actionable".
      *
      * @param {ValidatorConditionFunction[]} items Condition functions
-     * @returns {PageField | ValidatorConditionFunction[]} Chain or return all conditions
+     * @returns {PageField} Chain - Deprecated: this currently gets all conditions if
+     * empty or missing, in v9 this functionality will removed in favour of the
+     * function getConditions().
      */
     conditions(items = []) {
         if (!items.length) {
-            return __classPrivateFieldGet(this, _PageField_conditions, "f");
+            log.warn('Calling conditions() to get all conditions is deprecated, please use getConditions()');
+            return this.getConditions();
         }
         __classPrivateFieldSet(this, _PageField_conditions, [...__classPrivateFieldGet(this, _PageField_conditions, "f"), ...(items.flat())], "f");
         return this;
@@ -246,6 +280,7 @@ class PageField {
      * @param {any} value Value to validate
      * @param {ValidateContext} context Contextual validation information
      * @returns {ValidationError[]} Errors, or an empty array if all valid
+     * @throws {TypeError} If validator does not return an array
      */
     runValidators(value, context = Object.create(null)) {
         var _a;
@@ -362,7 +397,7 @@ class PageField {
      * @returns {PageField} Chain
      */
     if(...args) {
-        return this.conditions(...args);
+        return this.conditions(args);
     }
 }
 exports.PageField = PageField;
@@ -372,7 +407,7 @@ _PageField_name = new WeakMap(), _PageField_processors = new WeakMap(), _PageFie
  *
  * @memberof module:@dwp/govuk-casa
  * @param {string} name Field name
- * @param {object} opts Options
+ * @param {object} [opts] Options
  * @param {boolean} [opts.optional=false] Whether this field is optional
  * @param {boolean} [opts.persist=true] Whether this field will persist in `req.body`
  * @returns {PageField} A PageField

package/dist/lib/waypoint-url.d.ts

@@ -9,7 +9,6 @@
  *   edit: true,
  *   editOrigin: '/somewhere/else'
  * })
- *
  * @memberof module:@dwp/govuk-casa
  * @param {object} obj Options
  * @param {string} obj.waypoint Waypoint

package/dist/lib/waypoint-url.js

@@ -25,7 +25,6 @@ const sanitiseWaypoint = (w) => w.replace(/[^/a-z0-9_-]/ig, '').replace(/\/+/g,
  *   edit: true,
  *   editOrigin: '/somewhere/else'
  * })
- *
  * @memberof module:@dwp/govuk-casa
  * @param {object} obj Options
  * @param {string} obj.waypoint Waypoint

package/dist/middleware/pre.js

@@ -5,14 +5,29 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const crypto_1 = require("crypto");
 const helmet_1 = __importDefault(require("helmet"));
+/**
+ * @access private
+ * @typedef {import('../casa').HelmetConfigurator} HelmetConfigurator
+ */
 const GA_DOMAIN = '*.google-analytics.com';
 const GA_ANALYTICS_DOMAIN = '*.analytics.google.com';
 const GTM_DOMAIN = '*.googletagmanager.com';
 const GTM_PREVIEW_DOMAIN = 'https://tagmanager.google.com';
 /**
- * @access private
- * @typedef {import('../casa').HelmetConfigurator} HelmetConfigurator
+ * Extracts the CSP nonce used in every template, and makes it available as a
+ * nonce value in the CSP header.
+ *
+ * IMPORTANT: Do not rename this function as it _might_ be used in consumer code
+ * to identify this function specifically, most likely to remove it from CSP
+ * headers for custom purposes.
+ *
+ * @param {import('express').Request} req Request
+ * @param {import('express').Response} res Response
+ * @returns {string} nonce value suitable for use in CSP header
  */
+function casaCspNonce(req, res) {
+    return `'nonce-${res.locals.cspNonce}'`;
+}
 /**
  * Pre middleware.
  *
@@ -56,13 +71,13 @@ exports.default = ({ helmetConfigurator = (config) => (config), } = {}) => [
             useDefaults: true,
             directives: {
                 'default-src': ["'none'"],
-                'script-src': ["'self'", GA_DOMAIN, GTM_DOMAIN, GTM_PREVIEW_DOMAIN, (req, res) => `'nonce-${res.locals.cspNonce}'`],
+                'script-src': ["'self'", GA_DOMAIN, GTM_DOMAIN, GTM_PREVIEW_DOMAIN, casaCspNonce],
                 'img-src': ["'self'", GA_DOMAIN, GA_ANALYTICS_DOMAIN, GTM_DOMAIN, 'https://ssl.gstatic.com', 'https://www.gstatic.com'],
                 'connect-src': ["'self'", GA_DOMAIN, GA_ANALYTICS_DOMAIN, GTM_DOMAIN],
                 'frame-src': ["'self'", GTM_DOMAIN],
                 'frame-ancestors': ["'self'"],
                 'form-action': ["'self'"],
-                'style-src': ["'self'", 'https://fonts.googleapis.com', GTM_PREVIEW_DOMAIN, (req, res) => `'nonce-${res.locals.cspNonce}'`],
+                'style-src': ["'self'", 'https://fonts.googleapis.com', GTM_PREVIEW_DOMAIN, casaCspNonce],
                 'font-src': ["'self'", 'data:', 'https://fonts.gstatic.com'],
             },
         },

package/locales/cy/common.json

@@ -20,4 +20,4 @@
       }
     }
   }
-}
+}

package/locales/cy/macros.json

@@ -12,4 +12,4 @@
     "address4": "Sir",
     "postcode": "Cod post"
   }
-}
+}

package/locales/cy/review.json

@@ -5,4 +5,4 @@
     "containsErrors": "Mae'r dudalen hon yn cynnwys gwallau",
     "changeLink": "Newid"
   }
-}
+}

package/locales/cy/validation.json

@@ -78,4 +78,4 @@
       }
     }
   }
-}
+}

package/locales/en/common.json

@@ -20,4 +20,4 @@
       }
     }
   }
-}
+}

package/locales/en/review.json

@@ -5,4 +5,4 @@
     "containsErrors": "This page contains errors",
     "changeLink": "Change"
   }
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "8.5.1",
+  "version": "8.6.0",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
   "repository": {
     "type": "git",
@@ -34,8 +34,7 @@
     "build:css-assets": "node scripts/compile-sass.js",
     "build:api-docs": "npx jsdoc -c ./jsdoc.json -d ./docs/api/ --debug -P '' -r -R ./README.md --verbose -t ./node_modules/docdash ./src",
     "prepare": "npm run build",
-    "upgrade-deps": "OD=$(npm outdated --long --parseable); echo \"$OD\" | grep ':devDependencies:' | awk -F: '{ print $4 }' | xargs npm i -DE; echo \"$OD\" | grep ':dependencies:' | awk -F: '{ print $4 }' | xargs npm i -E",
-    "standard-version": "node scripts/standard-version.js"
+    "upgrade-deps": "OD=$(npm outdated --long --parseable); echo \"$OD\" | grep ':devDependencies:' | awk -F: '{ print $4 }' | xargs npm i -DE; echo \"$OD\" | grep ':dependencies:' | awk -F: '{ print $4 }' | xargs npm i -E"
   },
   "keywords": [],
   "author": "DWP Digital",
@@ -50,50 +49,50 @@
     "express-session": "1.17.3",
     "govuk-frontend": "4.3.1",
     "graphlib": "2.1.8",
-    "helmet": "5.1.1",
-    "i18next": "21.10.0",
+    "helmet": "6.0.0",
+    "i18next": "22.0.4",
     "i18next-http-middleware": "3.2.1",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",
-    "luxon": "2.5.0",
+    "luxon": "3.1.0",
     "nunjucks": "3.2.3",
     "path-to-regexp": "6.2.1",
-    "uuid": "8.3.2",
+    "uuid": "9.0.0",
     "validator": "13.7.0"
   },
   "devDependencies": {
-    "@babel/core": "7.19.3",
+    "@babel/core": "7.20.2",
     "@babel/eslint-parser": "7.19.1",
-    "@babel/preset-env": "7.19.4",
-    "@ckeditor/jsdoc-plugins": "30.5.0",
-    "@commitlint/config-conventional": "17.1.0",
+    "@babel/preset-env": "7.20.2",
+    "@ckeditor/jsdoc-plugins": "31.1.8",
+    "@commitlint/config-conventional": "17.2.0",
     "@dwp/casa-spiderplan": "2.4.1",
     "@dwp/casa-spiderplan-a11y-plugin": "0.1.4",
     "@dwp/casa-spiderplan-zap-plugin": "0.1.1",
     "@dwp/eslint-config-base": "6.0.0",
     "@types/express": "4.17.14",
-    "@types/node": "18.0.0",
+    "@types/node": "18.11.9",
     "@types/nunjucks": "3.2.1",
     "babel-eslint": "10.1.0",
     "c8": "7.12.0",
     "chai": "4.3.6",
     "cheerio": "1.0.0-rc.12",
-    "commitlint": "17.1.2",
+    "commitlint": "17.2.0",
     "docdash": "1.2.0",
-    "eslint": "8.25.0",
+    "eslint": "8.26.0",
     "eslint-plugin-no-unsafe-regex": "1.0.0",
     "eslint-plugin-security": "1.5.0",
     "eslint-plugin-sonarjs": "0.16.0",
-    "fast-check": "3.2.0",
+    "fast-check": "3.3.0",
     "husky": "8.0.1",
-    "jsdoc": "3.6.11",
+    "jsdoc": "4.0.0",
     "jsdoc-tsimport-plugin": "1.0.5",
-    "mocha": "10.0.0",
-    "sass": "1.55.0",
+    "mocha": "10.1.0",
+    "sass": "1.56.0",
     "sinon": "14.0.1",
     "sinon-chai": "3.7.0",
     "standard-version": "9.5.0",
-    "supertest": "6.3.0",
+    "supertest": "6.3.1",
     "typescript": "4.8.4"
   }
 }

package/views/casa/components/date-input/README.md

@@ -99,4 +99,4 @@ You can also pass a locale:
 ```
 ```
 1 Ionawr 1980
-```
+```

package/views/casa/layouts/journey.njk

@@ -46,4 +46,4 @@
   }) %}
     {% block journey_form %}{% endblock %}
   {% endcall %}
-{% endblock %}
+{% endblock %}