@dwp/govuk-casa 8.0.0-alpha1 → 8.0.0

package/dist/lib/field.js

@@ -16,42 +16,43 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 var _PageField_name, _PageField_processors, _PageField_validators, _PageField_conditions, _PageField_meta;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PageField = void 0;
-const utils_js_1 = require("./utils.js");
 const lodash_1 = __importDefault(require("lodash"));
+const utils_js_1 = require("./utils.js");
 const { isFunction } = lodash_1.default;
 /**
- * @typedef {Object} Validator
- * @property {ValidateFunction} validate Validation function
- * @property {SanitiseFunction} sanitise Sanitise a given value to make it suitable for this validator
- * @property {Object} config Configuration
- * @property {string} name Validator name
+ * @typedef {import('./index').JourneyContext} JourneyContext
  */
 /**
- * @callback ValidateFunction
- * @param {any} value
- * @param {ValidateContext} context
- * @return {ValidationError[]}
+ * @typedef {import('./index').Validator} Validator
  */
 /**
- * @callback SanitiseFunction
- * @param {any} value
+ * @typedef {import('./index').ValidateFunction} ValidateFunction
+ */
+/**
+ * @typedef {import('./index').ValidateContext} ValidateContext
+ */
+/**
+ * @typedef {import('./index').ValidationError} ValidationError
+ */
+/**
+ * @callback ProcessorFunction
+ * @param {any} value Value to be processed
  * @returns {any}
  */
 /**
- * @typedef {Object} ValidateContext Context passed to validate function
- * @property {JourneyContext} journeyContext Journey context
- * @property {string} waypoint Waypoint
- * @property {string} fieldName Name of field being processed
+ * @callback ConditionFunction
+ * @param {Object} context Value to be processed
+ * @param {string} context.fieldName Field name
+ * @param {any} context.fieldValue Field value
+ * @param {string} context.waypoint Waypoint
+ * @param {string} context.waypointId [DEPRECATED] Waypoint (for backwards compatibility with v7)
+ * @param {JourneyContext} journeyContext Journey Context
+ * @returns {boolean} True if the validators should be run
  */
 // Quick check to see if the field name corresponds to a non-primitive complex
 // type. For example, `my_field[nested]`.
 const reComplexType = /\[/;
-const reInvalidName = /[^a-z0-9_.\-\[\]]/i;
-// Factory for convenience
-function field(...args) {
-    return new PageField(...args);
-}
-exports.default = field;
+const reInvalidName = /[^a-z0-9_.\-[\]]/i;
 // This is never exposed via a public API, and instead users are encouraged to
 // use the `field()` factory instead
 class PageField {
@@ -61,19 +62,19 @@ class PageField {
          */
         _PageField_name.set(this, void 0);
         /**
-         * @type {function[]}
+         * @type {ProcessorFunction[]}
          */
         _PageField_processors.set(this, void 0);
         /**
-         * @type {Validator[]}
+         * @type {ValidateFunction[]}
          */
         _PageField_validators.set(this, void 0);
         /**
-         * @type {function[]}
+         * @type {ConditionFunction[]}
          */
         _PageField_conditions.set(this, void 0);
         /**
-         * @type {Object}
+         * @type {object}
          */
         _PageField_meta.set(this, void 0);
         if (!name) {
@@ -96,8 +97,9 @@ class PageField {
      * For complex fields, we need may need to drill into an object to extract the
      * value.
      *
-     * @param {Object} obj Object from which to extract the value
-     * @returns {any}
+     * @param {object} obj Object from which to extract the value
+     * @returns {any} Value extracted from object
+     * @throws {Error} When run on a complex field
      */
     getValue(obj = Object.create(null)) {
         if (!__classPrivateFieldGet(this, _PageField_meta, "f").complex) {
@@ -107,6 +109,7 @@ class PageField {
     }
     putValue(obj = Object.create(null), value) {
         if (!__classPrivateFieldGet(this, _PageField_meta, "f").complex) {
+            /* eslint-disable-next-line no-param-reassign */
             obj[__classPrivateFieldGet(this, _PageField_name, "f")] = value;
             return this;
         }
@@ -119,28 +122,47 @@ class PageField {
     get meta() {
         return __classPrivateFieldGet(this, _PageField_meta, "f");
     }
-    // Add/get value validators
-    // Some validators might include their own processors on
-    validators(...items) {
-        // TODO: prepend any sanitisers these validators may have onto the #processors array
-        if (!items.length)
+    /**
+     * Add/get value validators
+     * Some validators will include a `sanitise()` method which will be run at the
+     * same time as other "processors".
+     *
+     * @param {ValidateFunction[]} items Validation functions
+     * @returns {PageField | ValidateFunction[]} Chain or return all validators
+     */
+    validators(items = []) {
+        if (!items.length) {
             return __classPrivateFieldGet(this, _PageField_validators, "f");
+        }
         __classPrivateFieldSet(this, _PageField_validators, [...__classPrivateFieldGet(this, _PageField_validators, "f"), ...(items.flat())], "f");
         return this;
     }
-    // Add/get value pre-processors
-    // This is most often used to sanitise values to a particular data type
-    processors(...items) {
-        if (!items.length)
+    /**
+     * Add/get value pre-processors
+     * This is most often used to sanitise values to a particular data type.
+     *
+     * @param {ProcessorFunction[]} items Processor functions
+     * @returns {PageField | ProcessorFunction[]} Chain or return all processors
+     */
+    processors(items = []) {
+        if (!items.length) {
             return __classPrivateFieldGet(this, _PageField_processors, "f");
+        }
         __classPrivateFieldSet(this, _PageField_processors, [...__classPrivateFieldGet(this, _PageField_processors, "f"), ...(items.flat())], "f");
         return this;
     }
-    // Add/get conditions
-    // All conditions must be met in order for this field to be considered "actionable"
-    conditions(...items) {
-        if (!items.length)
+    /**
+     * Add/get conditions
+     * All conditions must be met in order for this field to be considered
+     * "actionable".
+     *
+     * @param {ConditionFunction[]} items Condition functions
+     * @returns {PageField | ConditionFunction[]} Chain or return all conditions
+     */
+    conditions(items = []) {
+        if (!items.length) {
             return __classPrivateFieldGet(this, _PageField_conditions, "f");
+        }
         __classPrivateFieldSet(this, _PageField_conditions, [...__classPrivateFieldGet(this, _PageField_conditions, "f"), ...(items.flat())], "f");
         return this;
     }
@@ -159,7 +181,10 @@ class PageField {
         }
         let errors = [];
         for (let i = 0, l = __classPrivateFieldGet(this, _PageField_validators, "f").length; i < l; i++) {
-            const fieldErrors = __classPrivateFieldGet(this, _PageField_validators, "f")[i].validate(value, context).map(e => e.withContext(Object.assign(Object.assign({}, context), { validator: __classPrivateFieldGet(this, _PageField_validators, "f")[i].name })));
+            // ESLint disabled as `i` is an integer
+            /* eslint-disable security/detect-object-injection */
+            const fieldErrors = __classPrivateFieldGet(this, _PageField_validators, "f")[i].validate(value, context).map((e) => e.withContext(Object.assign(Object.assign({}, context), { validator: __classPrivateFieldGet(this, _PageField_validators, "f")[i].name })));
+            /* eslint-enable security/detect-object-injection */
             errors = [
                 ...errors,
                 ...(fieldErrors !== null && fieldErrors !== void 0 ? fieldErrors : []),
@@ -167,17 +192,27 @@ class PageField {
         }
         return errors;
     }
-    // Apply all the processors to the given value
+    /*
+     * Apply all the processors to the given value.
+     *
+     * @param {any} value Value to process
+     * @returns {any} Processed value
+     */
     applyProcessors(value) {
         let processedValue = value;
         // Some of the validators may have their own "sanitise()" methods. These
         // should be run before any other processors
+        // ESLint disabled as `i` is an integer
+        /* eslint-disable security/detect-object-injection */
         for (let i = 0, l = __classPrivateFieldGet(this, _PageField_validators, "f").length; i < l; i++) {
             if (isFunction(__classPrivateFieldGet(this, _PageField_validators, "f")[i].sanitise)) {
                 processedValue = __classPrivateFieldGet(this, _PageField_validators, "f")[i].sanitise(processedValue);
             }
         }
+        /* eslint-enable security/detect-object-injection */
         for (let i = 0, l = __classPrivateFieldGet(this, _PageField_processors, "f").length; i < l; i++) {
+            // ESLint disabled as `i` is an integer
+            /* eslint-disable-next-line security/detect-object-injection */
             processedValue = __classPrivateFieldGet(this, _PageField_processors, "f")[i](processedValue);
         }
         return processedValue;
@@ -185,11 +220,11 @@ class PageField {
     /**
      * Apply all conditions to get the resulting boolean
      *
-     * @param {Object} params Parameters
-     * @param {string} fieldValue Field value
-     * @param {string} waypoint Waypoint
-     * @param {object} journeyContext JourneyContext
-     * @returns {boolean}
+     * @param {object} params Parameters
+     * @param {string} params.fieldValue Field value
+     * @param {string} params.waypoint Waypoint
+     * @param {object} params.journeyContext JourneyContext
+     * @returns {boolean} True if all conditions pass
      */
     testConditions({ fieldValue, waypoint, journeyContext }) {
         const context = {
@@ -201,19 +236,21 @@ class PageField {
         };
         let result = true;
         for (let i = 0, l = __classPrivateFieldGet(this, _PageField_conditions, "f").length; i < l; i++) {
+            // ESLint disabled as `i` is an integer
+            /* eslint-disable-next-line security/detect-object-injection */
             result = result && __classPrivateFieldGet(this, _PageField_conditions, "f")[i](context);
         }
         return result;
     }
     /* ---------------------------------------------------------------- aliases */
-    validator(...args) {
-        return this.validators(...args);
+    validator(validator) {
+        return this.validators([validator]);
     }
-    processor(...args) {
-        return this.processors(...args);
+    processor(processor) {
+        return this.processors([processor]);
     }
-    condition(...args) {
-        return this.conditions(...args);
+    condition(condition) {
+        return this.conditions([condition]);
     }
     if(...args) {
         return this.conditions(...args);
@@ -221,3 +258,8 @@ class PageField {
 }
 exports.PageField = PageField;
 _PageField_name = new WeakMap(), _PageField_processors = new WeakMap(), _PageField_validators = new WeakMap(), _PageField_conditions = new WeakMap(), _PageField_meta = new WeakMap();
+// Factory for convenience
+function field(...args) {
+    return new PageField(...args);
+}
+exports.default = field;

package/dist/lib/index.d.ts

@@ -0,0 +1,14 @@
+import CasaTemplateLoader from "./CasaTemplateLoader.js";
+import configure from "./configure.js";
+import configurationIngestor from "./configuration-ingestor.js";
+import endSession from "./end-session.js";
+import field from "./field.js";
+import { PageField } from "./field.js";
+import JourneyContext from "./JourneyContext.js";
+import MutableRouter from "./MutableRouter.js";
+import Plan from "./Plan.js";
+import * as utils from "./utils.js";
+import ValidationError from "./ValidationError.js";
+import ValidatorFactory from "./ValidatorFactory.js";
+import waypointUrl from "./waypoint-url.js";
+export { CasaTemplateLoader, configure, configurationIngestor, endSession, field, PageField, JourneyContext, MutableRouter, Plan, utils, ValidationError, ValidatorFactory, waypointUrl };

package/dist/lib/index.js

@@ -0,0 +1,54 @@
+"use strict";
+/**
+ * Just used to collate type information for intellisense. This should not get
+ * imported anywhere in code, other than JSDoc references.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 (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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waypointUrl = exports.ValidatorFactory = exports.ValidationError = exports.utils = exports.Plan = exports.MutableRouter = exports.JourneyContext = exports.PageField = exports.field = exports.endSession = exports.configurationIngestor = exports.configure = exports.CasaTemplateLoader = void 0;
+const CasaTemplateLoader_js_1 = __importDefault(require("./CasaTemplateLoader.js"));
+exports.CasaTemplateLoader = CasaTemplateLoader_js_1.default;
+const configure_js_1 = __importDefault(require("./configure.js"));
+exports.configure = configure_js_1.default;
+const configuration_ingestor_js_1 = __importDefault(require("./configuration-ingestor.js"));
+exports.configurationIngestor = configuration_ingestor_js_1.default;
+const end_session_js_1 = __importDefault(require("./end-session.js"));
+exports.endSession = end_session_js_1.default;
+const field_js_1 = __importStar(require("./field.js"));
+exports.field = field_js_1.default;
+Object.defineProperty(exports, "PageField", { enumerable: true, get: function () { return field_js_1.PageField; } });
+const JourneyContext_js_1 = __importDefault(require("./JourneyContext.js"));
+exports.JourneyContext = JourneyContext_js_1.default;
+const MutableRouter_js_1 = __importDefault(require("./MutableRouter.js"));
+exports.MutableRouter = MutableRouter_js_1.default;
+const Plan_js_1 = __importDefault(require("./Plan.js"));
+exports.Plan = Plan_js_1.default;
+const ValidationError_js_1 = __importDefault(require("./ValidationError.js"));
+exports.ValidationError = ValidationError_js_1.default;
+const ValidatorFactory_js_1 = __importDefault(require("./ValidatorFactory.js"));
+exports.ValidatorFactory = ValidatorFactory_js_1.default;
+const waypoint_url_js_1 = __importDefault(require("./waypoint-url.js"));
+exports.waypointUrl = waypoint_url_js_1.default;
+const utils = __importStar(require("./utils.js"));
+exports.utils = utils;

package/dist/lib/logger.d.ts

@@ -1,4 +1,4 @@
-export default function _default(ns: any): {
+declare function _default(namespace: any): {
     trace: any;
     debug: any;
     info: any;
@@ -6,3 +6,4 @@ export default function _default(ns: any): {
     error: any;
     fatal: any;
 };
+export default _default;

package/dist/lib/logger.js

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const debug_1 = __importDefault(require("debug"));
 const casaDebugger = (0, debug_1.default)('casa');
-function default_1(ns) {
-    const logger = casaDebugger.extend(ns);
+exports.default = (namespace) => {
+    const logger = casaDebugger.extend(namespace);
     return {
         trace: logger.extend('trace'),
         debug: logger.extend('debug'),
@@ -15,5 +15,4 @@ function default_1(ns) {
         error: logger.extend('error'),
         fatal: logger.extend('fatal'),
     };
-}
-exports.default = default_1;
+};

package/dist/lib/nunjucks-filters.d.ts

@@ -1,17 +1,17 @@
 export function mergeObjects(...objects: any[]): object;
 export function includes(source?: any[], search?: string): boolean;
 /**
-* Format a given date.
-*
-* Requires NodeJS >= 14 to make use of bundled date locale data.
-*
-* `date` may be any of the following types:
-*   object - {dd:'', mm:'', yyyy:''}
-*
-* @param  {object} date Date (see supported formats above)
-* @param  {object} config Holds locale
-* @returns {string} Formatted date
-*/
+ * Format a given date.
+ *
+ * Requires NodeJS >= 14 to make use of bundled date locale data.
+ *
+ * `date` may be any of the following types:
+ *   object - {dd:'', mm:'', yyyy:''}
+ *
+ * @param  {object} date Date (see supported formats above)
+ * @param  {object} config Holds locale
+ * @returns {string} Formatted date
+ */
 export function formatDateObject(date: object, config?: object): string;
 /**
  * Attribute values will be HTML/attribute escaped.

package/dist/lib/nunjucks-filters.js

@@ -1,37 +1,21 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (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 (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 __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.renderAsAttributes = exports.formatDateObject = exports.includes = exports.mergeObjects = void 0;
-const deepmerge_1 = __importStar(require("deepmerge"));
+const deepmerge_1 = __importDefault(require("deepmerge"));
 const luxon_1 = require("luxon");
 const nunjucks_1 = __importDefault(require("nunjucks"));
+const { all: deepmergeAll } = deepmerge_1.default;
 // Arrays will be merged such that elements at the same index will be merged
 // into each other
 // ref: https://www.npmjs.com/package/deepmerge
 const combineMerge = (target, source, options) => {
     const destination = target.slice();
     source.forEach((item, index) => {
+        // ESLint disabled as `index` is only an integer
+        /* eslint-disable security/detect-object-injection */
         if (typeof destination[index] === 'undefined') {
             destination[index] = options.cloneUnlessOtherwiseSpecified(item, options);
         }
@@ -41,31 +25,30 @@ const combineMerge = (target, source, options) => {
         else if (target.indexOf(item) === -1) {
             destination.push(item);
         }
+        /* eslint-enable security/detect-object-injection */
     });
     return destination;
 };
 function mergeObjects(...objects) {
-    return (0, deepmerge_1.all)([Object.create(null), ...objects], { arrayMerge: combineMerge });
+    return deepmergeAll([Object.create(null), ...objects], { arrayMerge: combineMerge });
 }
 exports.mergeObjects = mergeObjects;
-;
 function includes(source = [], search = '') {
     return source.includes(search);
 }
 exports.includes = includes;
-;
 /**
-* Format a given date.
-*
-* Requires NodeJS >= 14 to make use of bundled date locale data.
-*
-* `date` may be any of the following types:
-*   object - {dd:'', mm:'', yyyy:''}
-*
-* @param  {object} date Date (see supported formats above)
-* @param  {object} config Holds locale
-* @returns {string} Formatted date
-*/
+ * Format a given date.
+ *
+ * Requires NodeJS >= 14 to make use of bundled date locale data.
+ *
+ * `date` may be any of the following types:
+ *   object - {dd:'', mm:'', yyyy:''}
+ *
+ * @param  {object} date Date (see supported formats above)
+ * @param  {object} config Holds locale
+ * @returns {string} Formatted date
+ */
 function formatDateObject(date, config = {}) {
     const { locale = 'en' } = config;
     if (Object.prototype.toString.call(date) === '[object Object]'
@@ -81,7 +64,6 @@ function formatDateObject(date, config = {}) {
     return 'INVALID DATE OBJECT';
 }
 exports.formatDateObject = formatDateObject;
-;
 /**
  * Attribute values will be HTML/attribute escaped.
  *
@@ -96,6 +78,10 @@ function renderAsAttributes(attrsObject) {
     const attrsList = [];
     if (typeof attrsObject === 'object') {
         Object.keys(attrsObject).forEach((key) => {
+            // ESLint disable as `attrsObject` is dev-controlled, `Object.keys()` has
+            // been used (to get "own" properties) and `m` is one of the characters
+            // found by the regex.
+            /* eslint-disable security/detect-object-injection */
             const value = String(attrsObject[key]).replace(/[<>"'&]/g, (m) => ({
                 '<': '&lt;',
                 '>': '&gt;',
@@ -103,10 +89,10 @@ function renderAsAttributes(attrsObject) {
                 '\'': '&#039;',
                 '&': '&amp;',
             }[m]));
+            /* eslint-enable security/detect-object-injection */
             attrsList.push(`${key}="${value}"`);
         });
     }
     return new nunjucks_1.default.runtime.SafeString(attrsList.join(' '));
 }
 exports.renderAsAttributes = renderAsAttributes;
-;

package/dist/lib/nunjucks.d.ts

@@ -1,22 +1,23 @@
 /**
- * @typedef {Object} NunjucksOptions
- * @property {string} [mountUrl=/] Mount URL. This i made available as a `casa.mountUrl` template variable (optional, default /)
- * @property {string[]} [views=[]] List of directories to look for template files (optional, default [])
+ * @typedef {object} NunjucksOptions
+ * @property {string} [mountUrl=/] Mount URL (optional, default /)
+ * @property {string[]} [views=[]] Template file directories (optional, default [])
  */
 /**
  * Create a Nunjucks environment.
  *
  * @param {NunjucksOptions} options Nunjucks options
- * @returns {nunjucks.Environment} Nunjucks Environment instance
+ * @returns {Environment} Nunjucks Environment instance
  */
-export default function _default({ mountUrl, views, }: NunjucksOptions): any;
+export default function nunjucksConfig({ mountUrl, views, }: NunjucksOptions): Environment;
 export type NunjucksOptions = {
     /**
      * )
      */
     mountUrl?: string | undefined;
     /**
-     * List of directories to look for template files (optional, default [])
+     * Template file directories (optional, default [])
      */
     views?: string[] | undefined;
 };
+import { Environment } from "nunjucks";

package/dist/lib/nunjucks.js

@@ -10,17 +10,17 @@ const dirname_cjs_1 = __importDefault(require("./dirname.cjs"));
 const CasaTemplateLoader_js_1 = __importDefault(require("./CasaTemplateLoader.js"));
 const nunjucks_filters_js_1 = require("./nunjucks-filters.js");
 /**
- * @typedef {Object} NunjucksOptions
- * @property {string} [mountUrl=/] Mount URL. This i made available as a `casa.mountUrl` template variable (optional, default /)
- * @property {string[]} [views=[]] List of directories to look for template files (optional, default [])
+ * @typedef {object} NunjucksOptions
+ * @property {string} [mountUrl=/] Mount URL (optional, default /)
+ * @property {string[]} [views=[]] Template file directories (optional, default [])
  */
 /**
  * Create a Nunjucks environment.
  *
  * @param {NunjucksOptions} options Nunjucks options
- * @returns {nunjucks.Environment} Nunjucks Environment instance
+ * @returns {Environment} Nunjucks Environment instance
  */
-function default_1({ mountUrl = '/', views = [], }) {
+function nunjucksConfig({ mountUrl = '/', views = [], }) {
     // Prepare a single Nunjucks environment for all responses to use. Note that
     // we cannot prepare response-specific global functions/filters if we use a
     // single environment, but the performance gains of doing so are significant.
@@ -46,4 +46,4 @@ function default_1({ mountUrl = '/', views = [], }) {
     env.addGlobal('renderAsAttributes', nunjucks_filters_js_1.renderAsAttributes);
     return env;
 }
-exports.default = default_1;
+exports.default = nunjucksConfig;

package/dist/lib/utils.d.ts

@@ -1,3 +1,12 @@
+/**
+ * @typedef {import('./configuration-ingestor').GlobalHook} GlobalHook
+ */
+/**
+ * @typedef {import('./configuration-ingestor').PageHook} PageHook
+ */
+/**
+ * @typedef {GlobalHook | PageHook} Hook
+ */
 /**
  * Test is a value can be stringifed (numbers or strings)
  *
@@ -20,3 +29,20 @@ export function stringifyInput(input: any, fallback: string, ...args: any[]): st
  * @returns {boolean} True if the object is empty
  */
 export function isEmpty(val: any): boolean;
+/**
+ * Extract the middleware functions that are relevant for the given hook and
+ * path.
+ *
+ * @param {string} hookName Hook name (including scope prefix)
+ * @param {string} path URL path to match (relative to mountUrl)
+ * @param {Hook[]} hooks Hooks to be applied at the page level
+ * @returns {Function[]} An array of middleware that should be applied
+ */
+export function resolveMiddlewareHooks(hookName: string, path: string, hooks?: Hook[]): Function[];
+export function validateWaypoint(waypoint: any): void;
+export function validateView(view: any): void;
+export function validateHookName(hookName: any): void;
+export function validateHookPath(path: any): void;
+export type GlobalHook = import('./configuration-ingestor').GlobalHook;
+export type PageHook = import('./configuration-ingestor').PageHook;
+export type Hook = GlobalHook | PageHook;