@dwp/govuk-casa 9.7.0 → 10.1.0

package/dist/lib/configuration-ingestor.js

@@ -1,76 +1,11 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateI18nObject = validateI18nObject;
-exports.validateI18nDirs = validateI18nDirs;
-exports.validateI18nLocales = validateI18nLocales;
-exports.validateI18nFallbackLng = validateI18nFallbackLng;
-exports.validateMountUrl = validateMountUrl;
-exports.validateSessionObject = validateSessionObject;
-exports.validateViews = validateViews;
-exports.validateSessionSecret = validateSessionSecret;
-exports.validateSessionTtl = validateSessionTtl;
-exports.validateSessionName = validateSessionName;
-exports.validateSessionSecure = validateSessionSecure;
-exports.validateSessionStore = validateSessionStore;
-exports.validateSessionCookiePath = validateSessionCookiePath;
-exports.validateErrorVisibility = validateErrorVisibility;
-exports.validateSessionCookieSameSite = validateSessionCookieSameSite;
-exports.validatePageHooks = validatePageHooks;
-exports.validateFields = validateFields;
-exports.validatePages = validatePages;
-exports.validatePlan = validatePlan;
-exports.validateGlobalHooks = validateGlobalHooks;
-exports.validatePlugins = validatePlugins;
-exports.validateEvents = validateEvents;
-exports.validateHelmetConfigurator = validateHelmetConfigurator;
-exports.validateFormMaxParams = validateFormMaxParams;
-exports.validateFormMaxBytes = validateFormMaxBytes;
-exports.validateContextIdGenerator = validateContextIdGenerator;
-exports.validateGovukRebrand = validateGovukRebrand;
-exports.default = ingest;
-const bytes_1 = __importDefault(require("bytes"));
-const field_js_1 = require("./field.js");
-const Plan_js_1 = __importDefault(require("./Plan.js"));
-const logger_js_1 = __importDefault(require("./logger.js"));
-const utils_js_1 = require("./utils.js");
-const contextIdGenerators = __importStar(require("./context-id-generators.js"));
-const constants_js_1 = require("./constants.js");
+import bytes from "bytes";
+import { PageField } from "./field.js";
+import NullObject from "./NullObject.js";
+import Plan from "./Plan.js";
+import logger from "./logger.js";
+import { validateWaypoint, validateHookName, validateHookPath, validateView, } from "./utils.js";
+import * as contextIdGenerators from "./context-id-generators.js";
+import { CONFIG_ERROR_VISIBILITY_ALWAYS, CONFIG_ERROR_VISIBILITY_ONSUBMIT, } from "./constants.js";
 /**
  * @typedef {import("../casa").ConfigurationOptions} ConfigurationOptions
  * @access private
@@ -103,7 +38,11 @@ const constants_js_1 = require("./constants.js");
  * @typedef {import("../casa").ContextIdGenerator} ContextIdGenerator
  * @access private
  */
-const log = (0, logger_js_1.default)("lib:configuration-ingestor");
+/**
+ * @typedef {true | false | "Lax" | "None" | "Strict" | "auto"} CookieSameSite
+ * @access private
+ */
+const log = logger("lib:configuration-ingestor");
 const echo = (a) => a;
 /**
  * Validates and sanitises i18n object.
@@ -114,7 +53,7 @@ const echo = (a) => a;
  * @throws {TypeError} For invalid object.
  * @access private
  */
-function validateI18nObject(i18n = Object.create(null), cb = echo) {
+export function validateI18nObject(i18n = new NullObject(), cb = echo) {
     if (Object.prototype.toString.call(i18n) !== "[object Object]") {
         throw new TypeError("I18n must be an object");
     }
@@ -129,7 +68,7 @@ function validateI18nObject(i18n = Object.create(null), cb = echo) {
  * @throws {TypeError} For invalid type.
  * @access private
  */
-function validateI18nDirs(dirs = []) {
+export function validateI18nDirs(dirs = []) {
     if (!Array.isArray(dirs)) {
         throw new TypeError("I18n directories must be an array (i18n.dirs)");
     }
@@ -138,6 +77,7 @@ function validateI18nDirs(dirs = []) {
         if (typeof dir !== "string") {
             throw new TypeError(`I18n directory must be a string, got ${typeof dir} (i18n.dirs[${i++}])`);
         }
+        i++;
     }
     return dirs;
 }
@@ -150,7 +90,7 @@ function validateI18nDirs(dirs = []) {
  * @throws {TypeError} For invalid type.
  * @access private
  */
-function validateI18nLocales(locales = ["en", "cy"]) {
+export function validateI18nLocales(locales = ["en", "cy"]) {
     if (!Array.isArray(locales)) {
         throw new TypeError("I18n locales must be an array (i18n.locales)");
     }
@@ -159,6 +99,7 @@ function validateI18nLocales(locales = ["en", "cy"]) {
         if (typeof locale !== "string") {
             throw new TypeError(`I18n locale must be a string, got ${typeof locale} (i18n.locales[${i++}])`);
         }
+        i++;
     }
     return locales;
 }
@@ -172,7 +113,7 @@ function validateI18nLocales(locales = ["en", "cy"]) {
  * @throws {TypeError} For invalid type.
  * @access private
  */
-function validateI18nFallbackLng(fallback, locales = ["en", "cy"]) {
+export function validateI18nFallbackLng(fallback, locales = ["en", "cy"]) {
     if (fallback === undefined) {
         return false;
     }
@@ -192,7 +133,7 @@ function validateI18nFallbackLng(fallback, locales = ["en", "cy"]) {
  * @throws {SyntaxError} For invalid URL.
  * @access private
  */
-function validateMountUrl(mountUrl) {
+export function validateMountUrl(mountUrl) {
     if (typeof mountUrl === "undefined") {
         return undefined;
     }
@@ -210,7 +151,7 @@ function validateMountUrl(mountUrl) {
  * @throws {TypeError} For invalid object.
  * @access private
  */
-function validateSessionObject(session = Object.create(null), cb = echo) {
+export function validateSessionObject(session = new NullObject(), cb = echo) {
     if (session === undefined) {
         return cb(session);
     }
@@ -228,7 +169,7 @@ function validateSessionObject(session = Object.create(null), cb = echo) {
  * @throws {TypeError} For invalid type.
  * @access private
  */
-function validateViews(dirs = []) {
+export function validateViews(dirs = []) {
     if (!Array.isArray(dirs)) {
         throw new TypeError("View directories must be an array (views)");
     }
@@ -237,6 +178,7 @@ function validateViews(dirs = []) {
         if (typeof dir !== "string") {
             throw new TypeError(`View directory must be a string, got ${typeof dir} (views[${i++}])`);
         }
+        i++;
     }
     return dirs;
 }
@@ -249,7 +191,7 @@ function validateViews(dirs = []) {
  * @throws {TypeError} For invalid value.
  * @access private
  */
-function validateSessionSecret(secret) {
+export function validateSessionSecret(secret) {
     if (typeof secret === "undefined") {
         throw ReferenceError("Session secret is missing (session.secret)");
     }
@@ -267,7 +209,7 @@ function validateSessionSecret(secret) {
  * @throws {TypeError} For invalid value.
  * @access private
  */
-function validateSessionTtl(ttl = 3600) {
+export function validateSessionTtl(ttl = 3600) {
     if (typeof ttl !== "number") {
         throw new TypeError("Session ttl must be an integer (session.ttl)");
     }
@@ -282,7 +224,7 @@ function validateSessionTtl(ttl = 3600) {
  * @throws {TypeError} For invalid value.
  * @access private
  */
-function validateSessionName(name = "casa-session") {
+export function validateSessionName(name = "casa-session") {
     if (typeof name !== "string") {
         throw new TypeError("Session name must be a string (session.name)");
     }
@@ -297,7 +239,7 @@ function validateSessionName(name = "casa-session") {
  * @throws {TypeError} For invalid or missing value.
  * @access private
  */
-function validateSessionSecure(secure) {
+export function validateSessionSecure(secure) {
     if (secure === undefined) {
         throw new Error("Session secure flag must be explicitly defined (session.secure)");
     }
@@ -313,7 +255,7 @@ function validateSessionSecure(secure) {
  * @returns {Function} Store.
  * @access private
  */
-function validateSessionStore(store) {
+export function validateSessionStore(store) {
     if (typeof store === "undefined") {
         log.warn("Using MemoryStore session storage, which is not suitable for production");
         return null;
@@ -328,22 +270,12 @@ function validateSessionStore(store) {
  * @returns {string} Cookie path.
  * @access private
  */
-function validateSessionCookiePath(cookiePath, defaultPath = "/") {
+export function validateSessionCookiePath(cookiePath, defaultPath = "/") {
     if (typeof cookiePath === "undefined") {
         return defaultPath;
     }
     return cookiePath;
 }
-/**
- * Validates and sanitises sessions cookie "sameSite" flag. One of: true
- * (Strict) false (will not set the flag at all) Strict Lax None
- *
- * @param {any} cookieSameSite Session cookie "sameSite" flag
- * @param {any} defaultFlag Default path if none specified
- * @returns {boolean} Cookie path
- * @throws {TypeError} When invalid arguments are provided
- * @access private
- */
 /**
  * Validates errorVisibility.
  *
@@ -353,23 +285,28 @@ function validateSessionCookiePath(cookiePath, defaultPath = "/") {
  * @throws {SyntaxError} For invalid errorVisibility flag.
  * @access private
  */
-function validateErrorVisibility(errorVisibility = constants_js_1.CONFIG_ERROR_VISIBILITY_ONSUBMIT) {
+export function validateErrorVisibility(errorVisibility = CONFIG_ERROR_VISIBILITY_ONSUBMIT) {
     if (errorVisibility === undefined) {
         return undefined;
     }
-    if (errorVisibility === constants_js_1.CONFIG_ERROR_VISIBILITY_ALWAYS ||
-        errorVisibility === constants_js_1.CONFIG_ERROR_VISIBILITY_ONSUBMIT ||
+    if (errorVisibility === CONFIG_ERROR_VISIBILITY_ALWAYS ||
+        errorVisibility === 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");
 }
 /**
- * @param {boolean | string} cookieSameSite Cookie SameSite value
- * @param {boolean | string} defaultFlag Default value
+ * Validates and sanitises sessions cookie "sameSite" flag. One of: true
+ * (Strict) false (will not set the flag at all) Strict Lax None
+ *
+ * @param {CookieSameSite} cookieSameSite Session cookie "sameSite" flag
+ * @param {CookieSameSite} defaultFlag Default value
  * @returns {boolean | string} Validated value
+ * @throws {TypeError} When invalid arguments are provided
+ * @access private
  */
-function validateSessionCookieSameSite(cookieSameSite, defaultFlag) {
+export function validateSessionCookieSameSite(cookieSameSite, defaultFlag) {
     const validValues = [true, false, "Strict", "Lax", "None"];
     if (defaultFlag === undefined) {
         throw new TypeError("validateSessionCookieSameSite() requires an explicit default flag");
@@ -385,7 +322,7 @@ function validateSessionCookieSameSite(cookieSameSite, defaultFlag) {
 }
 const validatePageHook = (hook, index) => {
     try {
-        (0, utils_js_1.validateHookName)(hook.hook);
+        validateHookName(hook.hook);
         if (typeof hook.middleware !== "function") {
             throw new TypeError("Hook middleware must be a function");
         }
@@ -399,7 +336,7 @@ const validatePageHook = (hook, index) => {
  * @param {PageHook[]} hooks Page hook functions
  * @returns {PageHook[]} Validated page hooks
  */
-function validatePageHooks(hooks) {
+export function validatePageHooks(hooks) {
     if (!Array.isArray(hooks)) {
         throw new TypeError("Hooks must be an array");
     }
@@ -411,7 +348,7 @@ function validatePageHooks(hooks) {
 }
 const validateField = (field, index) => {
     try {
-        if (!(field instanceof field_js_1.PageField)) {
+        if (!(field instanceof PageField)) {
             throw new TypeError('Page field must be an instance of PageField (created via the "field()" function)');
         }
     }
@@ -424,7 +361,7 @@ const validateField = (field, index) => {
  * @param {PageField[]} fields Page fields
  * @returns {PageField[]} Validated fields
  */
-function validateFields(fields) {
+export function validateFields(fields) {
     if (!Array.isArray(fields)) {
         throw new TypeError("Page fields must be an array (page[].fields)");
     }
@@ -436,8 +373,8 @@ function validateFields(fields) {
 }
 const validatePage = (page, index) => {
     try {
-        (0, utils_js_1.validateWaypoint)(page.waypoint);
-        (0, utils_js_1.validateView)(page.view);
+        validateWaypoint(page.waypoint);
+        validateView(page.view);
         if (page.fields !== undefined) {
             validateFields(page.fields);
         }
@@ -457,7 +394,7 @@ const validatePage = (page, index) => {
  * @param {Page[]} [pages] Pages
  * @returns {Page[]} Validated pages
  */
-function validatePages(pages = []) {
+export function validatePages(pages = []) {
     if (!Array.isArray(pages)) {
         throw new TypeError("Pages must be an array (pages)");
     }
@@ -471,23 +408,23 @@ function validatePages(pages = []) {
  * @param {Plan} plan Plan
  * @returns {Plan} Validated plan
  */
-function validatePlan(plan) {
+export function validatePlan(plan) {
     if (plan === undefined) {
         return plan;
     }
-    if (!(plan instanceof Plan_js_1.default)) {
+    if (!(plan instanceof 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);
+        validateHookName(hook.hook);
         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);
+            validateHookPath(hook.path);
         }
     }
     catch (err) {
@@ -499,7 +436,7 @@ const validateGlobalHook = (hook, index) => {
  * @param {GlobalHook[]} hooks Global hook functions
  * @returns {GlobalHook[]} Validated global hooks
  */
-function validateGlobalHooks(hooks) {
+export function validateGlobalHooks(hooks) {
     if (hooks === undefined) {
         return [];
     }
@@ -516,14 +453,14 @@ function validateGlobalHooks(hooks) {
  * @param {IPlugin[]} plugins Plugins
  * @returns {IPlugin[]} Validated plugins
  */
-function validatePlugins(plugins) {
+export function validatePlugins(plugins) {
     return plugins;
 }
 /**
  * @param {ContextEventHandler[]} events Event handlers
  * @returns {ContextEventHandler[]} Validated event handlers
  */
-function validateEvents(events) {
+export function validateEvents(events) {
     return events;
 }
 /**
@@ -534,7 +471,7 @@ function validateEvents(events) {
  * @throws {TypeError} When passed a non-function
  * @access private
  */
-function validateHelmetConfigurator(helmetConfigurator) {
+export function validateHelmetConfigurator(helmetConfigurator) {
     if (helmetConfigurator !== undefined &&
         !(helmetConfigurator instanceof Function)) {
         throw new TypeError("Helmet configurator must be a function");
@@ -548,7 +485,7 @@ function validateHelmetConfigurator(helmetConfigurator) {
  * @throws {TypeError} If not an integer
  * @throws {RangeError} If out of bounds
  */
-function validateFormMaxParams(value, defaultValue = 25) {
+export function validateFormMaxParams(value, defaultValue = 25) {
     // CASA needs to send certain hidden form fields (see `sanitise-fields`
     // middleware), plus some padding here.
     const MIN_PARAMS = 10;
@@ -570,17 +507,17 @@ function validateFormMaxParams(value, defaultValue = 25) {
  * @throws {TypeError} If not an integer
  * @throws {RangeError} If out of bounds
  */
-function validateFormMaxBytes(value, defaultValue = 1024 * 50) {
+export function validateFormMaxBytes(value, defaultValue = 1024 * 50) {
     const MIN_BYTES = 1024;
     if (value === undefined) {
         return defaultValue;
     }
-    const parsedValue = bytes_1.default.parse(value);
+    const parsedValue = bytes.parse(value);
     if (!Number.isInteger(parsedValue)) {
         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)})`);
+        throw new RangeError(`formMaxBytes must be at least ${MIN_BYTES} bytes (${bytes.format(MIN_BYTES)})`);
     }
     return parsedValue;
 }
@@ -589,7 +526,7 @@ function validateFormMaxBytes(value, defaultValue = 1024 * 50) {
  * @returns {ContextIdGenerator} Validated generator
  * @throws {TypeError} If not a function
  */
-function validateContextIdGenerator(generator) {
+export function validateContextIdGenerator(generator) {
     if (generator === undefined) {
         return contextIdGenerators.uuid();
     }
@@ -598,23 +535,6 @@ function validateContextIdGenerator(generator) {
     }
     return generator;
 }
-/**
- * Validates the govuk rebrand feature flag.
- *
- * @param {boolean} [govukRebrand] Govuk rebrand feature flag
- * @returns {boolean | true} Boolean.
- * @throws {TypeError} For invalid feagure flag is set.
- * @access private
- */
-function validateGovukRebrand(govukRebrand) {
-    if (govukRebrand === undefined) {
-        return false;
-    }
-    if (typeof govukRebrand !== "boolean") {
-        throw new TypeError("govukRebrand must be a boolean");
-    }
-    return govukRebrand;
-}
 /**
  * Ingest, validate, sanitise and manipulate configuration parameters.
  *
@@ -623,7 +543,7 @@ function validateGovukRebrand(govukRebrand) {
  * @throws {Error | SyntaxError | TypeError} For invalid config values.
  * @access private
  */
-function ingest(config = {}) {
+export default function ingest(config = {}) {
     const parsed = {
         // I18n configuration
         i18n: validateI18nObject(config.i18n, (i18n) => ({
@@ -664,10 +584,8 @@ function ingest(config = {}) {
         formMaxBytes: validateFormMaxBytes(config.formMaxBytes, 1024 * 50),
         // Context ID generator
         contextIdGenerator: validateContextIdGenerator(config.contextIdGenerator),
-        govukRebrand: validateGovukRebrand(config.govukRebrand),
     };
     // Freeze to modifications
     Object.freeze(parsed);
     return parsed;
 }
-//# sourceMappingURL=configuration-ingestor.js.map

package/dist/lib/configure.d.ts

@@ -13,7 +13,7 @@
 /**
  * Configure some middleware for use in creating a new CASA app.
  *
- * @memberof module:@dwp/govuk-casa
+ * @memberof module:"@dwp/govuk-casa"
  * @param {ConfigurationOptions} config Configuration options
  * @returns {ConfigureResult} Result
  */
@@ -21,3 +21,4 @@ export default function configure(config?: ConfigurationOptions): ConfigureResul
 export type ConfigurationOptions = import("../casa").ConfigurationOptions;
 export type ConfigureResult = import("../casa").ConfigureResult;
 export type Mounter = import("../casa").Mounter;
+//# sourceMappingURL=configure.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"configure.d.ts","sourceRoot":"","sources":["../../src/lib/configure.js"],"names":[],"mappings":"AAyBA;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;;;GAMG;AACH,2CAHW,oBAAoB,GAClB,eAAe,CAgL3B;mCAnMY,OAAO,SAAS,EAAE,oBAAoB;8BAKtC,OAAO,SAAS,EAAE,eAAe;sBAKjC,OAAO,SAAS,EAAE,OAAO"}