@dwp/govuk-casa 8.16.2 → 8.16.3

package/dist/lib/ValidatorFactory.js

@@ -3,7 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable class-methods-use-this */
 const lodash_1 = __importDefault(require("lodash"));
 const { isPlainObject } = lodash_1.default; // CommonJS
 /**
@@ -45,12 +44,11 @@ class ValidatorFactory {
      */
     static make(config = {}) {
         if (!isPlainObject(config)) {
-            throw new TypeError('Configuration must be an object');
+            throw new TypeError("Configuration must be an object");
         }
         const validator = Reflect.construct(this, [config]);
-        /* eslint-disable-next-line sonarjs/prefer-object-literal */
         const instance = {};
-        instance.name = validator.name || 'unknown';
+        instance.name = validator.name || "unknown";
         instance.config = config;
         instance.validate = validator.validate.bind(instance);
         instance.sanitise = validator.sanitise.bind(instance);
@@ -64,7 +62,7 @@ class ValidatorFactory {
      */
     constructor(config = {}) {
         if (new.target === ValidatorFactory) {
-            throw new TypeError('Cannot instantiate the abstract class, ValidatorFactory');
+            throw new TypeError("Cannot instantiate the abstract class, ValidatorFactory");
         }
         this.config = config;
     }
@@ -79,9 +77,8 @@ class ValidatorFactory {
      * @throws {Error}
      */
     validate(fieldValue, context) {
-        throw new Error('validate() method has not been implemented');
+        throw new Error("validate() method has not been implemented");
     }
-    /* eslint-disable-next-line jsdoc/require-returns-check */
     /**
      * Sanitise the given value.
      *

package/dist/lib/ValidatorFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"ValidatorFactory.js","sourceRoot":"","sources":["../../src/lib/ValidatorFactory.js"],"names":[],"mappings":";;;;;AAAA,2CAA2C;AAC3C,oDAA4B;AAE5B,MAAM,EAAE,aAAa,EAAE,GAAG,gBAAM,CAAC,CAAC,WAAW;AAE7C;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AACH,MAAqB,gBAAgB;IACnC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE;QACrB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAEpD,4DAA4D;QAC5D,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC;QAC5C,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QACzB,QAAQ,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtD,QAAQ,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEtD,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAExB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,YAAY,MAAM,GAAG,EAAE;QACrB,IAAI,GAAG,CAAC,MAAM,KAAK,gBAAgB,EAAE,CAAC;YACpC,MAAM,IAAI,SAAS,CAAC,yDAAyD,CAAC,CAAC;QACjF,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,mCAAmC;IAEnC,0DAA0D;IAC1D;;;;;;;OAOG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO;QAC1B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED,0DAA0D;IAC1D;;;;;OAKG;IACH,QAAQ,CAAC,UAAU;QACjB,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAjED,mCAiEC"}
+{"version":3,"file":"ValidatorFactory.js","sourceRoot":"","sources":["../../src/lib/ValidatorFactory.js"],"names":[],"mappings":";;;;;AAAA,oDAA4B;AAE5B,MAAM,EAAE,aAAa,EAAE,GAAG,gBAAM,CAAC,CAAC,WAAW;AAE7C;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AACH,MAAqB,gBAAgB;IACnC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE;QACrB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAEpD,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC;QAC5C,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QACzB,QAAQ,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtD,QAAQ,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEtD,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAExB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,YAAY,MAAM,GAAG,EAAE;QACrB,IAAI,GAAG,CAAC,MAAM,KAAK,gBAAgB,EAAE,CAAC;YACpC,MAAM,IAAI,SAAS,CACjB,yDAAyD,CAC1D,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,mCAAmC;IAEnC,0DAA0D;IAC1D;;;;;;;OAOG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO;QAC1B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,UAAU;QACjB,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAjED,mCAiEC"}

package/dist/lib/configuration-ingestor.d.ts

@@ -81,12 +81,12 @@ export function validateSessionTtl(ttl?: number): number;
  * Validates and sanitises sessions name.
  *
  * @access private
- * @param {string} [name=casa-session] Session name.
+ * @param {string} [name] Session name.
  * @throws {ReferenceError} For missing value type.
  * @throws {TypeError} For invalid value.
  * @returns {string} Name.
  */
-export function validateSessionName(name?: string | undefined): string;
+export function validateSessionName(name?: string): string;
 /**
  * Validates and sanitises sessions secure flag.
  *
@@ -96,7 +96,7 @@ export function validateSessionName(name?: string | undefined): string;
  * @throws {TypeError} For invalid or missing value.
  * @returns {string} Name.
  */
-export function validateSessionSecure(secure?: boolean | undefined): string;
+export function validateSessionSecure(secure?: boolean): string;
 /**
  * Validates and sanitises sessions store.
  *
@@ -137,14 +137,47 @@ export function validateSessionCookiePath(cookiePath: string, defaultPath?: stri
  * @returns {symbol | Function} flag for error visibility.
  */
 export function validateErrorVisibility(errorVisibility?: string): symbol | Function;
-export function validateSessionCookieSameSite(cookieSameSite: any, defaultFlag: any): any;
-export function validatePageHooks(hooks: any): any[];
-export function validateFields(fields: any): any[];
-export function validatePages(pages?: any[]): any[];
-export function validatePlan(plan: any): any;
-export function validateGlobalHooks(hooks: any): any[];
-export function validatePlugins(plugins: any): any;
-export function validateEvents(events: any): any;
+/**
+ * @param {boolean | string} cookieSameSite Cookie SameSite value
+ * @param {boolean | string} defaultFlag Default value
+ * @returns {boolean | string} Validated value
+ */
+export function validateSessionCookieSameSite(cookieSameSite: boolean | string, defaultFlag: boolean | string): boolean | string;
+/**
+ * @param {PageHook[]} hooks Page hook functions
+ * @returns {PageHook[]} Validated page hooks
+ */
+export function validatePageHooks(hooks: PageHook[]): PageHook[];
+/**
+ * @param {PageField[]} fields Page fields
+ * @returns {PageField[]} Validated fields
+ */
+export function validateFields(fields: PageField[]): PageField[];
+/**
+ * @param {Page[]} [pages] Pages
+ * @returns {Page[]} Validated pages
+ */
+export function validatePages(pages?: Page[]): Page[];
+/**
+ * @param {Plan} plan Plan
+ * @returns {Plan} Validated plan
+ */
+export function validatePlan(plan: Plan): Plan;
+/**
+ * @param {GlobalHook[]} hooks Global hook functions
+ * @returns {GlobalHook[]} Validated global hooks
+ */
+export function validateGlobalHooks(hooks: GlobalHook[]): GlobalHook[];
+/**
+ * @param {IPlugin[]} plugins Plugins
+ * @returns {IPlugin[]} Validated plugins
+ */
+export function validatePlugins(plugins: IPlugin[]): IPlugin[];
+/**
+ * @param {ContextEventHandler[]} events Event handlers
+ * @returns {ContextEventHandler[]} Validated event handlers
+ */
+export function validateEvents(events: ContextEventHandler[]): ContextEventHandler[];
 /**
  * Validates helmet configuration function.
  *
@@ -154,9 +187,28 @@ export function validateEvents(events: any): any;
  * @throws {TypeError} when passed a non-function
  */
 export function validateHelmetConfigurator(helmetConfigurator: HelmetConfigurator): HelmetConfigurator;
-export function validateFormMaxParams(value: any, defaultValue?: number): any;
-export function validateFormMaxBytes(value: any, defaultValue?: number): any;
-export function validateContextIdGenerator(generator: any): any;
+/**
+ * @param {number} value Max params value
+ * @param {number} [defaultValue] Default value
+ * @returns {number} Valid value
+ * @throws {TypeError} If not an integer
+ * @throws {RangeError} If out of bounds
+ */
+export function validateFormMaxParams(value: number, defaultValue?: number): number;
+/**
+ * @param {number} value Max bytes value
+ * @param {number} [defaultValue] Default value
+ * @returns {number} Valid value
+ * @throws {TypeError} If not an integer
+ * @throws {RangeError} If out of bounds
+ */
+export function validateFormMaxBytes(value: number, defaultValue?: number): number;
+/**
+ * @param {ContextIdGenerator} generator ID generator function
+ * @returns {ContextIdGenerator} Validated generator
+ * @throws {TypeError} If not a function
+ */
+export function validateContextIdGenerator(generator: ContextIdGenerator): ContextIdGenerator;
 /**
  * Ingest, validate, sanitise and manipulate configuration parameters.
  *
@@ -168,3 +220,12 @@ export function validateContextIdGenerator(generator: any): any;
 export default function ingest(config?: ConfigurationOptions): object;
 export type ConfigurationOptions = import("../casa").ConfigurationOptions;
 export type HelmetConfigurator = import("../casa").HelmetConfigurator;
+export type Page = import("../casa").Page;
+export type PageField = import("../casa").PageField;
+export type PageHook = import("../casa").PageHook;
+export type GlobalHook = import("../casa").GlobalHook;
+export type IPlugin = import("../casa").IPlugin;
+export type ContextEventHandler = import("../casa").ContextEventHandler;
+export type ContextIdGenerator = import("../casa").ContextIdGenerator;
+import { PageField } from "./field.js";
+import Plan from "./Plan.js";

package/dist/lib/configuration-ingestor.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -52,7 +62,6 @@ exports.validateFormMaxParams = validateFormMaxParams;
 exports.validateFormMaxBytes = validateFormMaxBytes;
 exports.validateContextIdGenerator = validateContextIdGenerator;
 exports.default = ingest;
-/* eslint-disable sonarjs/no-duplicate-string */
 const bytes_1 = __importDefault(require("bytes"));
 const field_js_1 = require("./field.js");
 const Plan_js_1 = __importDefault(require("./Plan.js"));
@@ -61,15 +70,43 @@ const utils_js_1 = require("./utils.js");
 const contextIdGenerators = __importStar(require("./context-id-generators.js"));
 const constants_js_1 = require("./constants.js");
 /**
+ * @typedef {import("../casa").ConfigurationOptions} ConfigurationOptions
+ * @access private
+ */
+/**
+ * @typedef {import("../casa").HelmetConfigurator} HelmetConfigurator
+ * @access private
+ */
+/**
+ * @typedef {import("../casa").Page} Page
+ * @access private
+ */
+/**
+ * @typedef {import("../casa").PageField} PageField
+ * @access private
+ */
+/**
+ * @typedef {import("../casa").PageHook} PageHook
+ * @access private
+ */
+/**
+ * @typedef {import("../casa").GlobalHook} GlobalHook
+ * @access private
+ */
+/**
+ * @typedef {import("../casa").IPlugin} IPlugin
+ * @access private
+ */
+/**
+ * @typedef {import("../casa").ContextEventHandler} ContextEventHandler
  * @access private
- * @typedef {import('../casa').ConfigurationOptions} ConfigurationOptions
  */
 /**
+ * @typedef {import("../casa").ContextIdGenerator} ContextIdGenerator
  * @access private
- * @typedef {import('../casa').HelmetConfigurator} HelmetConfigurator
  */
-const log = (0, logger_js_1.default)('lib:configuration-ingestor');
-const echo = (a) => (a);
+const log = (0, logger_js_1.default)("lib:configuration-ingestor");
+const echo = (a) => a;
 /**
  * Validates and sanitises i18n object.
  *
@@ -80,8 +117,8 @@ const echo = (a) => (a);
  * @returns {object} Sanitised i18n object.
  */
 function validateI18nObject(i18n = Object.create(null), cb = echo) {
-    if (Object.prototype.toString.call(i18n) !== '[object Object]') {
-        throw new TypeError('I18n must be an object');
+    if (Object.prototype.toString.call(i18n) !== "[object Object]") {
+        throw new TypeError("I18n must be an object");
     }
     return cb(i18n);
 }
@@ -96,10 +133,10 @@ function validateI18nObject(i18n = Object.create(null), cb = echo) {
  */
 function validateI18nDirs(dirs = []) {
     if (!Array.isArray(dirs)) {
-        throw new TypeError('I18n directories must be an array (i18n.dirs)');
+        throw new TypeError("I18n directories must be an array (i18n.dirs)");
     }
     dirs.forEach((dir, i) => {
-        if (typeof dir !== 'string') {
+        if (typeof dir !== "string") {
             throw new TypeError(`I18n directory must be a string, got ${typeof dir} (i18n.dirs[${i}])`);
         }
     });
@@ -114,12 +151,12 @@ function validateI18nDirs(dirs = []) {
  * @throws {TypeError} For invalid type.
  * @returns {Array} Array of locales.
  */
-function validateI18nLocales(locales = ['en', 'cy']) {
+function validateI18nLocales(locales = ["en", "cy"]) {
     if (!Array.isArray(locales)) {
-        throw new TypeError('I18n locales must be an array (i18n.locales)');
+        throw new TypeError("I18n locales must be an array (i18n.locales)");
     }
     locales.forEach((locale, i) => {
-        if (typeof locale !== 'string') {
+        if (typeof locale !== "string") {
             throw new TypeError(`I18n locale must be a string, got ${typeof locale} (i18n.locales[${i}])`);
         }
     });
@@ -134,11 +171,11 @@ function validateI18nLocales(locales = ['en', 'cy']) {
  * @returns {string|undefined} Sanitised URL.
  */
 function validateMountUrl(mountUrl) {
-    if (typeof mountUrl === 'undefined') {
+    if (typeof mountUrl === "undefined") {
         return undefined;
     }
     if (!mountUrl.match(/\/$/)) {
-        throw new SyntaxError('mountUrl must include a trailing slash (/)');
+        throw new SyntaxError("mountUrl must include a trailing slash (/)");
     }
     return mountUrl;
 }
@@ -155,8 +192,8 @@ function validateSessionObject(session = Object.create(null), cb = echo) {
     if (session === undefined) {
         return cb(session);
     }
-    if (typeof session !== 'object') {
-        throw new TypeError('Session config has not been specified');
+    if (typeof session !== "object") {
+        throw new TypeError("Session config has not been specified");
     }
     return cb(session);
 }
@@ -171,10 +208,10 @@ function validateSessionObject(session = Object.create(null), cb = echo) {
  */
 function validateViews(dirs = []) {
     if (!Array.isArray(dirs)) {
-        throw new TypeError('View directories must be an array (views)');
+        throw new TypeError("View directories must be an array (views)");
     }
     dirs.forEach((dir, i) => {
-        if (typeof dir !== 'string') {
+        if (typeof dir !== "string") {
             throw new TypeError(`View directory must be a string, got ${typeof dir} (views[${i}])`);
         }
     });
@@ -190,11 +227,11 @@ function validateViews(dirs = []) {
  * @returns {string} Secret.
  */
 function validateSessionSecret(secret) {
-    if (typeof secret === 'undefined') {
-        throw ReferenceError('Session secret is missing (session.secret)');
+    if (typeof secret === "undefined") {
+        throw ReferenceError("Session secret is missing (session.secret)");
     }
-    else if (typeof secret !== 'string') {
-        throw new TypeError('Session secret must be a string (session.secret)');
+    else if (typeof secret !== "string") {
+        throw new TypeError("Session secret must be a string (session.secret)");
     }
     return secret;
 }
@@ -208,8 +245,8 @@ function validateSessionSecret(secret) {
  * @returns {number} Ttl.
  */
 function validateSessionTtl(ttl = 3600) {
-    if (typeof ttl !== 'number') {
-        throw new TypeError('Session ttl must be an integer (session.ttl)');
+    if (typeof ttl !== "number") {
+        throw new TypeError("Session ttl must be an integer (session.ttl)");
     }
     return ttl;
 }
@@ -217,14 +254,14 @@ function validateSessionTtl(ttl = 3600) {
  * Validates and sanitises sessions name.
  *
  * @access private
- * @param {string} [name=casa-session] Session name.
+ * @param {string} [name] Session name.
  * @throws {ReferenceError} For missing value type.
  * @throws {TypeError} For invalid value.
  * @returns {string} Name.
  */
-function validateSessionName(name = 'casa-session') {
-    if (typeof name !== 'string') {
-        throw new TypeError('Session name must be a string (session.name)');
+function validateSessionName(name = "casa-session") {
+    if (typeof name !== "string") {
+        throw new TypeError("Session name must be a string (session.name)");
     }
     return name;
 }
@@ -239,10 +276,10 @@ function validateSessionName(name = 'casa-session') {
  */
 function validateSessionSecure(secure) {
     if (secure === undefined) {
-        throw new Error('Session secure flag must be explicitly defined (session.secure)');
+        throw new Error("Session secure flag must be explicitly defined (session.secure)");
     }
-    if (typeof secure !== 'boolean') {
-        throw new TypeError('Session secure flag must be boolean (session.secure)');
+    if (typeof secure !== "boolean") {
+        throw new TypeError("Session secure flag must be boolean (session.secure)");
     }
     return secure;
 }
@@ -254,8 +291,8 @@ function validateSessionSecure(secure) {
  * @returns {Function} Store.
  */
 function validateSessionStore(store) {
-    if (typeof store === 'undefined') {
-        log.warn('Using MemoryStore session storage, which is not suitable for production');
+    if (typeof store === "undefined") {
+        log.warn("Using MemoryStore session storage, which is not suitable for production");
         return null;
     }
     return store;
@@ -268,8 +305,8 @@ function validateSessionStore(store) {
  * @param {string} defaultPath Default path if none specified.
  * @returns {string} Cookie path.
  */
-function validateSessionCookiePath(cookiePath, defaultPath = '/') {
-    if (typeof cookiePath === 'undefined') {
+function validateSessionCookiePath(cookiePath, defaultPath = "/") {
+    if (typeof cookiePath === "undefined") {
         return defaultPath;
     }
     return cookiePath;
@@ -300,30 +337,37 @@ function validateErrorVisibility(errorVisibility = constants_js_1.CONFIG_ERROR_V
     if (errorVisibility === undefined) {
         return undefined;
     }
-    if (errorVisibility === constants_js_1.CONFIG_ERROR_VISIBILITY_ALWAYS || errorVisibility === constants_js_1.CONFIG_ERROR_VISIBILITY_ONSUBMIT || typeof errorVisibility === 'function') {
+    if (errorVisibility === constants_js_1.CONFIG_ERROR_VISIBILITY_ALWAYS ||
+        errorVisibility === constants_js_1.CONFIG_ERROR_VISIBILITY_ONSUBMIT ||
+        typeof errorVisibility === "function") {
         return errorVisibility;
     }
-    throw new TypeError('errorVisibility must be casa constant CONFIG_ERROR_VISIBILITY_ALWAYS | CONFIG_ERROR_VISIBILITY_ONSUBMIT or function');
+    throw new TypeError("errorVisibility must be casa constant CONFIG_ERROR_VISIBILITY_ALWAYS | CONFIG_ERROR_VISIBILITY_ONSUBMIT or function");
 }
+/**
+ * @param {boolean | string} cookieSameSite Cookie SameSite value
+ * @param {boolean | string} defaultFlag Default value
+ * @returns {boolean | string} Validated value
+ */
 function validateSessionCookieSameSite(cookieSameSite, defaultFlag) {
-    const validValues = [true, false, 'Strict', 'Lax', 'None'];
+    const validValues = [true, false, "Strict", "Lax", "None"];
     if (defaultFlag === undefined) {
-        throw new TypeError('validateSessionCookieSameSite() requires an explicit default flag');
+        throw new TypeError("validateSessionCookieSameSite() requires an explicit default flag");
     }
     else if (!validValues.includes(defaultFlag)) {
-        throw new TypeError('validateSessionCookieSameSite() default flag must be set to one of true, false, Strict, Lax or None (session.cookieSameSite)');
+        throw new TypeError("validateSessionCookieSameSite() default flag must be set to one of true, false, Strict, Lax or None (session.cookieSameSite)");
     }
     const value = cookieSameSite !== undefined ? cookieSameSite : defaultFlag;
     if (!validValues.includes(value)) {
-        throw new TypeError('SameSite flag must be set to one of true, false, Strict, Lax or None (session.cookieSameSite)');
+        throw new TypeError("SameSite flag must be set to one of true, false, Strict, Lax or None (session.cookieSameSite)");
     }
     return value;
 }
 const validatePageHook = (hook, index) => {
     try {
         (0, utils_js_1.validateHookName)(hook.hook);
-        if (typeof hook.middleware !== 'function') {
-            throw new TypeError('Hook middleware must be a function');
+        if (typeof hook.middleware !== "function") {
+            throw new TypeError("Hook middleware must be a function");
         }
     }
     catch (err) {
@@ -331,9 +375,13 @@ const validatePageHook = (hook, index) => {
         throw err;
     }
 };
+/**
+ * @param {PageHook[]} hooks Page hook functions
+ * @returns {PageHook[]} Validated page hooks
+ */
 function validatePageHooks(hooks) {
     if (!Array.isArray(hooks)) {
-        throw new TypeError('Hooks must be an array');
+        throw new TypeError("Hooks must be an array");
     }
     hooks.forEach((hook, index) => validatePageHook(hook, index));
     return hooks;
@@ -349,9 +397,13 @@ const validateField = (field, index) => {
         throw err;
     }
 };
+/**
+ * @param {PageField[]} fields Page fields
+ * @returns {PageField[]} Validated fields
+ */
 function validateFields(fields) {
     if (!Array.isArray(fields)) {
-        throw new TypeError('Page fields must be an array (page[].fields)');
+        throw new TypeError("Page fields must be an array (page[].fields)");
     }
     fields.forEach((hook, index) => validateField(hook, index));
     return fields;
@@ -375,27 +427,35 @@ const validatePage = (page, index) => {
         throw err;
     }
 };
+/**
+ * @param {Page[]} [pages] Pages
+ * @returns {Page[]} Validated pages
+ */
 function validatePages(pages = []) {
     if (!Array.isArray(pages)) {
-        throw new TypeError('Pages must be an array (pages)');
+        throw new TypeError("Pages must be an array (pages)");
     }
     pages.forEach((page, index) => validatePage(page, index));
     return pages;
 }
+/**
+ * @param {Plan} plan Plan
+ * @returns {Plan} Validated plan
+ */
 function validatePlan(plan) {
     if (plan === undefined) {
         return plan;
     }
     if (!(plan instanceof Plan_js_1.default)) {
-        throw new TypeError('Plan must be an instance the Plan class (plan)');
+        throw new TypeError("Plan must be an instance the Plan class (plan)");
     }
     return plan;
 }
 const validateGlobalHook = (hook, index) => {
     try {
         (0, utils_js_1.validateHookName)(hook.hook);
-        if (typeof hook.middleware !== 'function') {
-            throw new TypeError('Hook middleware must be a function');
+        if (typeof hook.middleware !== "function") {
+            throw new TypeError("Hook middleware must be a function");
         }
         if (hook.path !== undefined) {
             (0, utils_js_1.validateHookPath)(hook.path);
@@ -406,19 +466,31 @@ const validateGlobalHook = (hook, index) => {
         throw err;
     }
 };
+/**
+ * @param {GlobalHook[]} hooks Global hook functions
+ * @returns {GlobalHook[]} Validated global hooks
+ */
 function validateGlobalHooks(hooks) {
     if (hooks === undefined) {
         return [];
     }
     if (!Array.isArray(hooks)) {
-        throw new TypeError('Hooks must be an array');
+        throw new TypeError("Hooks must be an array");
     }
     hooks.forEach((hook, index) => validateGlobalHook(hook, index));
     return hooks;
 }
+/**
+ * @param {IPlugin[]} plugins Plugins
+ * @returns {IPlugin[]} Validated plugins
+ */
 function validatePlugins(plugins) {
     return plugins;
 }
+/**
+ * @param {ContextEventHandler[]} events Event handlers
+ * @returns {ContextEventHandler[]} Validated event handlers
+ */
 function validateEvents(events) {
     return events;
 }
@@ -431,11 +503,19 @@ function validateEvents(events) {
  * @throws {TypeError} when passed a non-function
  */
 function validateHelmetConfigurator(helmetConfigurator) {
-    if (helmetConfigurator !== undefined && !(helmetConfigurator instanceof Function)) {
-        throw new TypeError('Helmet configurator must be a function');
+    if (helmetConfigurator !== undefined &&
+        !(helmetConfigurator instanceof Function)) {
+        throw new TypeError("Helmet configurator must be a function");
     }
     return helmetConfigurator;
 }
+/**
+ * @param {number} value Max params value
+ * @param {number} [defaultValue] Default value
+ * @returns {number} Valid value
+ * @throws {TypeError} If not an integer
+ * @throws {RangeError} If out of bounds
+ */
 function validateFormMaxParams(value, defaultValue = 25) {
     // CASA needs to send certain hidden form fields (see `sanitise-fields`
     // middleware), plus some padding here.
@@ -444,13 +524,20 @@ function validateFormMaxParams(value, defaultValue = 25) {
         return defaultValue;
     }
     if (!Number.isInteger(value)) {
-        throw new TypeError('formMaxParams must be an integer');
+        throw new TypeError("formMaxParams must be an integer");
     }
     if (value < MIN_PARAMS) {
         throw new RangeError(`formMaxParams must be at least ${MIN_PARAMS}`);
     }
     return value;
 }
+/**
+ * @param {number} value Max bytes value
+ * @param {number} [defaultValue] Default value
+ * @returns {number} Valid value
+ * @throws {TypeError} If not an integer
+ * @throws {RangeError} If out of bounds
+ */
 function validateFormMaxBytes(value, defaultValue = 1024 * 50) {
     const MIN_BYTES = 1024;
     if (value === undefined) {
@@ -458,19 +545,24 @@ function validateFormMaxBytes(value, defaultValue = 1024 * 50) {
     }
     const parsedValue = bytes_1.default.parse(value);
     if (!Number.isInteger(parsedValue)) {
-        throw new TypeError('formMaxParams must be a string or an integer');
+        throw new TypeError("formMaxParams must be a string or an integer");
     }
     if (parsedValue < MIN_BYTES) {
         throw new RangeError(`formMaxBytes must be at least ${MIN_BYTES} bytes (${bytes_1.default.format(MIN_BYTES)})`);
     }
     return parsedValue;
 }
+/**
+ * @param {ContextIdGenerator} generator ID generator function
+ * @returns {ContextIdGenerator} Validated generator
+ * @throws {TypeError} If not a function
+ */
 function validateContextIdGenerator(generator) {
     if (generator === undefined) {
         return contextIdGenerators.uuid();
     }
     if (!(generator instanceof Function)) {
-        throw new TypeError('contextIdGenerator must be a function');
+        throw new TypeError("contextIdGenerator must be a function");
     }
     return generator;
 }
@@ -500,8 +592,8 @@ function ingest(config = {}) {
             secure: validateSessionSecure(session.secure),
             ttl: validateSessionTtl(session.ttl),
             store: validateSessionStore(session.store),
-            cookiePath: validateSessionCookiePath(session.cookiePath, '/'),
-            cookieSameSite: validateSessionCookieSameSite(session.cookieSameSite, 'Strict'),
+            cookiePath: validateSessionCookiePath(session.cookiePath, "/"),
+            cookieSameSite: validateSessionCookieSameSite(session.cookieSameSite, "Strict"),
         })),
         // Views configuration
         views: validateViews(config.views),