@dwp/govuk-casa 8.0.0-alpha2 → 8.0.0-beta1

package/dist/casa.d.ts

@@ -3,8 +3,9 @@ import validators from "./lib/validators/index.js";
 import field from "./lib/field.js";
 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 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, ValidationError, waypointUrl, endSession, nunjucksFilters };
+export { configure, validators, field, Plan, JourneyContext, ValidatorFactory, ValidationError, waypointUrl, endSession, nunjucksFilters };

package/dist/casa.js

@@ -22,7 +22,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.JourneyContext = exports.Plan = exports.field = exports.validators = exports.configure = void 0;
+exports.nunjucksFilters = exports.endSession = exports.waypointUrl = 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;
@@ -34,6 +34,8 @@ const Plan_js_1 = __importDefault(require("./lib/Plan.js"));
 exports.Plan = Plan_js_1.default;
 const JourneyContext_js_1 = __importDefault(require("./lib/JourneyContext.js"));
 exports.JourneyContext = JourneyContext_js_1.default;
+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 waypoint_url_js_1 = __importDefault(require("./lib/waypoint-url.js"));

package/dist/lib/CasaTemplateLoader.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @typedef {import('nunjucks').FileSystemLoaderOptions} FileSystemLoaderOptions
+ */
 /**
  * @callback BlockModifier
  * @param {string} templateName Path to the template being modified
@@ -8,9 +11,9 @@ export default class CasaTemplateLoader extends FileSystemLoader {
      * Constructor.
      *
      * @param {string[]} searchPaths Template directories
-     * @param {import('nunjucks').FileSystemLoaderOptions} opts Loader options
+     * @param {FileSystemLoaderOptions} opts Loader options
      */
-    constructor(searchPaths: string[], opts: import('nunjucks').FileSystemLoaderOptions);
+    constructor(searchPaths: string[], opts: FileSystemLoaderOptions);
     /**
      * Add a modification function to the loader.
      *
@@ -21,5 +24,6 @@ export default class CasaTemplateLoader extends FileSystemLoader {
     modifyBlock(block: string, modifier: BlockModifier): void;
     #private;
 }
+export type FileSystemLoaderOptions = import('nunjucks').FileSystemLoaderOptions;
 export type BlockModifier = (templateName: string) => string;
 import { FileSystemLoader } from "nunjucks";

package/dist/lib/CasaTemplateLoader.js

@@ -13,6 +13,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _CasaTemplateLoader_instances, _CasaTemplateLoader_blockModifiers, _CasaTemplateLoader_applyBlockModifiers;
 Object.defineProperty(exports, "__esModule", { value: true });
 const nunjucks_1 = require("nunjucks");
+/**
+ * @typedef {import('nunjucks').FileSystemLoaderOptions} FileSystemLoaderOptions
+ */
 /**
  * @callback BlockModifier
  * @param {string} templateName Path to the template being modified
@@ -23,7 +26,7 @@ class CasaTemplateLoader extends nunjucks_1.FileSystemLoader {
      * Constructor.
      *
      * @param {string[]} searchPaths Template directories
-     * @param {import('nunjucks').FileSystemLoaderOptions} opts Loader options
+     * @param {FileSystemLoaderOptions} opts Loader options
      */
     constructor(searchPaths, opts) {
         super(searchPaths, opts);

package/dist/lib/JourneyContext.d.ts

@@ -1,3 +1,18 @@
+/**
+ * @typedef {import('./configuration-ingestor').Page} Page
+ */
+/**
+ * @callback ContextEventHandler
+ * @param {JourneyContext} journeyContext Context including changes
+ * @param {JourneyContext} previousContext Context prior to changes
+ * @returns {void}
+ */
+/**
+ * @typedef {object} ContextEvent
+ * @property {string} waypoint Waypoint to watch for changes
+ * @property {string} [field] Field to watch for changes
+ * @property {ContextEventHandler} handler Handler to invoke when change happens
+ */
 export default class JourneyContext {
     static DEFAULT_CONTEXT_ID: string;
     /**
@@ -133,11 +148,11 @@ export default class JourneyContext {
     /**
      * Get data context for a specific a specific page.
      *
-     * @param  {string | PageMeta} page Page waypoint ID, or Page object.
+     * @param  {string | Page} page Page waypoint ID, or Page object.
      * @returns {object} Page data.
      * @throws {TypeError} When page is invalid.
      */
-    getDataForPage(page: string | any): object;
+    getDataForPage(page: string | Page): object;
     getData(): object;
     /**
      * Overwrite the data context with a new object.
@@ -150,16 +165,16 @@ export default class JourneyContext {
      * Write field form data from a page HTML form, into the `data` model.
      *
      * By default this will store the data as-is, keyed against the page's
-     * waypoint ID. However, when passing a `PageMeta` instance, its
+     * waypoint ID. However, when passing a `Page` instance, its
      * `fieldWriter()` method will be called to transform the provided formData
      * before storing in `data`
      *
-     * @param {string | PageMeta} page Page waypoint ID, or PageMeta object
+     * @param {string | Page} page Page waypoint ID, or Page object
      * @param {object} webFormData Data to overwrite with
      * @returns {JourneyContext} Chain
      * @throws {TypeError} When page is invalid.
      */
-    setDataForPage(page: string | any, webFormData: object): JourneyContext;
+    setDataForPage(page: string | Page, webFormData: object): JourneyContext;
     /**
      * Return validation errors for all pages.
      *
@@ -251,7 +266,7 @@ export default class JourneyContext {
      * @param {ContextEvent[]} events Event listeners
      * @returns {JourneyContext} Chain
      */
-    addEventListeners(events: any[]): JourneyContext;
+    addEventListeners(events: ContextEvent[]): JourneyContext;
     applyEventListeners({ event }: {
         event: any;
     }): JourneyContext;
@@ -263,4 +278,20 @@ export default class JourneyContext {
     isDefault(): boolean;
     #private;
 }
+export type Page = import('./configuration-ingestor').Page;
+export type ContextEventHandler = (journeyContext: JourneyContext, previousContext: JourneyContext) => void;
+export type ContextEvent = {
+    /**
+     * Waypoint to watch for changes
+     */
+    waypoint: string;
+    /**
+     * Field to watch for changes
+     */
+    field?: string | undefined;
+    /**
+     * Handler to invoke when change happens
+     */
+    handler: ContextEventHandler;
+};
 import ValidationError from "./ValidationError.js";

package/dist/lib/JourneyContext.js

@@ -40,6 +40,21 @@ const ValidationError_js_1 = __importDefault(require("./ValidationError.js"));
 const logger_js_1 = __importDefault(require("./logger.js"));
 const { cloneDeep, isPlainObject, isObject, has, isEqual, } = lodash_1.default; // CommonJS
 const log = (0, logger_js_1.default)('class:journey-context');
+/**
+ * @typedef {import('./configuration-ingestor').Page} Page
+ */
+/**
+ * @callback ContextEventHandler
+ * @param {JourneyContext} journeyContext Context including changes
+ * @param {JourneyContext} previousContext Context prior to changes
+ * @returns {void}
+ */
+/**
+ * @typedef {object} ContextEvent
+ * @property {string} waypoint Waypoint to watch for changes
+ * @property {string} [field] Field to watch for changes
+ * @property {ContextEventHandler} handler Handler to invoke when change happens
+ */
 class JourneyContext {
     /**
      * Constructor.
@@ -123,7 +138,7 @@ class JourneyContext {
     /**
      * Get data context for a specific a specific page.
      *
-     * @param  {string | PageMeta} page Page waypoint ID, or Page object.
+     * @param  {string | Page} page Page waypoint ID, or Page object.
      * @returns {object} Page data.
      * @throws {TypeError} When page is invalid.
      */
@@ -153,11 +168,11 @@ class JourneyContext {
      * Write field form data from a page HTML form, into the `data` model.
      *
      * By default this will store the data as-is, keyed against the page's
-     * waypoint ID. However, when passing a `PageMeta` instance, its
+     * waypoint ID. However, when passing a `Page` instance, its
      * `fieldWriter()` method will be called to transform the provided formData
      * before storing in `data`
      *
-     * @param {string | PageMeta} page Page waypoint ID, or PageMeta object
+     * @param {string | Page} page Page waypoint ID, or Page object
      * @param {object} webFormData Data to overwrite with
      * @returns {JourneyContext} Chain
      * @throws {TypeError} When page is invalid.
@@ -325,7 +340,7 @@ class JourneyContext {
         return this;
     }
     applyEventListeners({ event }) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         if (!__classPrivateFieldGet(this, _JourneyContext_eventListeners, "f").length) {
             return this;
         }
@@ -341,11 +356,11 @@ class JourneyContext {
             }
             else if (waypoint && !field) {
                 logMessage = `Calling waypoint-specific event handler on "${waypoint}"`;
-                runHandler = !isEqual((_a = this.data) === null || _a === void 0 ? void 0 : _a[waypoint], (_b = previousContext.data) === null || _b === void 0 ? void 0 : _b[waypoint]);
+                runHandler = ((_a = previousContext.data) === null || _a === void 0 ? void 0 : _a[waypoint]) !== undefined && !isEqual((_b = this.data) === null || _b === void 0 ? void 0 : _b[waypoint], (_c = previousContext.data) === null || _c === void 0 ? void 0 : _c[waypoint]);
             }
             else if (waypoint && field) {
                 logMessage = `Calling field-specific event handler on "${waypoint} : ${field}"`;
-                runHandler = !isEqual((_d = (_c = this.data) === null || _c === void 0 ? void 0 : _c[waypoint]) === null || _d === void 0 ? void 0 : _d[field], (_f = (_e = previousContext.data) === null || _e === void 0 ? void 0 : _e[waypoint]) === null || _f === void 0 ? void 0 : _f[field]);
+                runHandler = ((_e = (_d = previousContext.data) === null || _d === void 0 ? void 0 : _d[waypoint]) === null || _e === void 0 ? void 0 : _e[field]) !== undefined && !isEqual((_g = (_f = this.data) === null || _f === void 0 ? void 0 : _f[waypoint]) === null || _g === void 0 ? void 0 : _g[field], (_j = (_h = previousContext.data) === null || _h === void 0 ? void 0 : _h[waypoint]) === null || _j === void 0 ? void 0 : _j[field]);
             }
             if (runHandler) {
                 log.trace(logMessage);

package/dist/lib/MutableRouter.js

@@ -264,12 +264,14 @@ _MutableRouter_stack = new WeakMap(), _MutableRouter_router = new WeakMap(), _Mu
     if (__classPrivateFieldGet(this, _MutableRouter_sealed, "f")) {
         throw new Error('Cannot alter middleware in a sealed mutable router');
     }
-    const index = __classPrivateFieldGet(this, _MutableRouter_stack, "f").findIndex((command) => `${command.method}|${command.path}` === `${method}|${path}`);
+    const finder = (command) => `${command.method}|${command.path}` === `${method}|${path}`;
+    const index = __classPrivateFieldGet(this, _MutableRouter_stack, "f").findIndex(finder);
     if (index > -1) {
         __classPrivateFieldGet(this, _MutableRouter_stack, "f").splice(index, 1, {
             method,
             path,
             args: [path, ...callbacks],
         });
+        __classPrivateFieldSet(this, _MutableRouter_stack, __classPrivateFieldGet(this, _MutableRouter_stack, "f").filter((command, idx) => idx <= index || !finder(command)), "f");
     }
 };

package/dist/lib/Plan.d.ts

@@ -1,12 +1,44 @@
 export default class Plan {
-    static isExitNode(name: any): boolean;
+    /**
+     * Waypoints using the url:// protocol are known as "exit nodes" as they
+     * indicate an exit point to another Plan.
+     *
+     * @param {string} name Waypoint name
+     * @returns {boolean} True if the waypoint is a url:// type
+     */
+    static isExitNode(name: string): boolean;
     /**
      * Create a Plan.
      *
      * @param {object} opts Options
+     * @param {boolean} [opts.validateBeforeRouteCondition=true] Check page validity before conditions
+     * @param {Function|string} [opts.arbiter=undefined] Arbitration mechanism
      */
-    constructor(opts?: object);
+    constructor(opts?: {
+        validateBeforeRouteCondition?: boolean | undefined;
+        arbiter?: string | Function | undefined;
+    });
     getOptions(): any;
+    /**
+     * Retrieve the list of skippable waypoints.
+     *
+     * @returns {string[]} List of skippable waypoints
+     */
+    getSkippables(): string[];
+    /**
+     * Add one or more skippable waypoints.
+     *
+     * @param  {...string} waypoints Waypoints
+     * @returns {Plan}{ Chain}
+     */
+    addSkippables(...waypoints: string[]): Plan;
+    /**
+     * Check if the user can skip the named waypoint.
+     *
+     * @param {string} waypoint Waypoint
+     * @returns {boolean} True if waypoint can be skipped
+     */
+    isSkippable(waypoint: string): boolean;
     getWaypoints(): any;
     containsWaypoint(waypoint: any): any;
     getRoutes(): any;
@@ -114,8 +146,9 @@ export default class Plan {
      * Get raw graph data structure. This can be used with other libraries to
      * generate graph visualisations, for example.
      *
-     * @returns {graphlib.Graph} Graph data structure.
+     * @returns {Graph} Graph data structure.
      */
-    getGraphStructure(): any;
+    getGraphStructure(): Graph;
+    #private;
 }
 import JourneyContext from "./JourneyContext.js";

package/dist/lib/Plan.js

@@ -1,7 +1,19 @@
 "use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _Plan_skippableWaypoints;
 Object.defineProperty(exports, "__esModule", { value: true });
 const graphlib_1 = require("graphlib");
 const JourneyContext_js_1 = __importDefault(require("./JourneyContext.js"));
@@ -35,6 +47,9 @@ function validateWaypointId(val) {
     if (typeof val !== 'string') {
         throw new TypeError(`Expected waypoint id to be a string, got ${typeof val}`);
     }
+    if (val.substr(0, 6) === 'url://' && !val.endsWith('/')) {
+        throw new SyntaxError('url:// waypoints must include a trailing /');
+    }
 }
 function validateRouteName(val) {
     if (typeof val !== 'string') {
@@ -74,15 +89,18 @@ const makeRouteObject = (dgraph, edge) => {
 const reExitNodeProtocol = /^[a-z]+:\/\//i;
 const priv = new WeakMap();
 class Plan {
-    static isExitNode(name) {
-        return reExitNodeProtocol.test(name);
-    }
     /**
      * Create a Plan.
      *
      * @param {object} opts Options
+     * @param {boolean} [opts.validateBeforeRouteCondition=true] Check page validity before conditions
+     * @param {Function|string} [opts.arbiter=undefined] Arbitration mechanism
      */
     constructor(opts = {}) {
+        /**
+         * @type {string[]} These waypoints can be skipped
+         */
+        _Plan_skippableWaypoints.set(this, void 0);
         // This is our directed, multigraph representation
         const dgraph = new graphlib_1.Graph({
             directed: true,
@@ -106,10 +124,48 @@ class Plan {
             },
             options,
         });
+        __classPrivateFieldSet(this, _Plan_skippableWaypoints, [], "f");
+    }
+    /**
+     * Waypoints using the url:// protocol are known as "exit nodes" as they
+     * indicate an exit point to another Plan.
+     *
+     * @param {string} name Waypoint name
+     * @returns {boolean} True if the waypoint is a url:// type
+     */
+    static isExitNode(name) {
+        return reExitNodeProtocol.test(name);
     }
     getOptions() {
         return priv.get(this).options;
     }
+    /**
+     * Retrieve the list of skippable waypoints.
+     *
+     * @returns {string[]} List of skippable waypoints
+     */
+    getSkippables() {
+        return __classPrivateFieldGet(this, _Plan_skippableWaypoints, "f");
+    }
+    /**
+     * Add one or more skippable waypoints.
+     *
+     * @param  {...string} waypoints Waypoints
+     * @returns {Plan}{ Chain}
+     */
+    addSkippables(...waypoints) {
+        __classPrivateFieldSet(this, _Plan_skippableWaypoints, [...__classPrivateFieldGet(this, _Plan_skippableWaypoints, "f"), ...waypoints], "f");
+        return this;
+    }
+    /**
+     * Check if the user can skip the named waypoint.
+     *
+     * @param {string} waypoint Waypoint
+     * @returns {boolean} True if waypoint can be skipped
+     */
+    isSkippable(waypoint) {
+        return __classPrivateFieldGet(this, _Plan_skippableWaypoints, "f").indexOf(waypoint) > -1;
+    }
     getWaypoints() {
         return priv.get(this).dgraph.nodes();
     }
@@ -222,12 +278,12 @@ class Plan {
             validateRouteCondition(follow);
         }
         // Get routing function name to label edge
-        const label = follow && follow.name;
+        const conditionName = follow && follow.name;
         // Warn if we're overwriting an existing edge on the same name
         if (self.dgraph.hasEdge(src, tgt, name)) {
             log.warn('Setting a route that already exists (%s, %s, %s). Will be overridden', src, tgt, name);
         }
-        self.dgraph.setEdge(src, tgt, { label }, name);
+        self.dgraph.setEdge(src, tgt, { conditionName }, name);
         // Determine which follow function to use
         let followFunc;
         if (follow) {
@@ -376,10 +432,11 @@ class Plan {
      * Get raw graph data structure. This can be used with other libraries to
      * generate graph visualisations, for example.
      *
-     * @returns {graphlib.Graph} Graph data structure.
+     * @returns {Graph} Graph data structure.
      */
     getGraphStructure() {
         return priv.get(this).dgraph;
     }
 }
 exports.default = Plan;
+_Plan_skippableWaypoints = new WeakMap();

package/dist/lib/ValidationError.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @typedef {import('./ValidatorFactory').ValidateContext} ValidateContext
+ */
 export default class ValidationError {
     /**
      * Make a ValidationError instance from a primitive object (or a function that
@@ -61,10 +64,11 @@ export default class ValidationError {
      * @param {ValidateContext} context See structure above
      * @returns {ValidationError} Chain
      */
-    withContext(context: any): ValidationError;
+    withContext(context: ValidateContext): ValidationError;
     variables: any;
-    field: any;
+    field: string | undefined;
     fieldHref: string | undefined;
     focusSuffix: any;
     validator: any;
 }
+export type ValidateContext = import('./ValidatorFactory').ValidateContext;

package/dist/lib/ValidationError.js

@@ -6,6 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const lodash_1 = __importDefault(require("lodash"));
 const { isPlainObject } = lodash_1.default; // CommonJS
 const params = new WeakMap();
+/**
+ * @typedef {import('./ValidatorFactory').ValidateContext} ValidateContext
+ */
 class ValidationError {
     /**
      * Make a ValidationError instance from a primitive object (or a function that

package/dist/lib/ValidatorFactory.d.ts

@@ -1,30 +1,83 @@
+/**
+ * @typedef {import('./index').ProcessorFunction} ProcessorFunction
+ */
+/**
+ * @typedef {import('./index').JourneyContext} JourneyContext
+ */
+/**
+ * @typedef {import('./index').ValidationError} ValidationError
+ */
+/**
+ * @typedef {object} Validator
+ * @property {ValidateFunction} validate Validation function
+ * @property {ProcessorFunction} sanitise Sanitise a given value prior to validation
+ * @property {object} config Configuration
+ * @property {string} name Validator name
+ */
+/**
+ * @callback ValidateFunction
+ * @param {any} value
+ * @param {ValidateContext} context
+ * @returns {ValidationError[]}
+ */
+/**
+ * @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
+ */
 export default class ValidatorFactory {
     /**
-     * This is a convenience method that will bind and return this class'
-     * `validate()` function, so you can call it directly rather than calling the
-     * method. i.e.
+     * This is a convenience method that will return a consistently object
+     * structure containing validation and sanitisation methods.
      *
-     *  MyValidator.make()('value to validate')
-     *    versus
-     *  (new MyValidator()).validate('value to validate')
-     *
-     * It also attaches the `sanitise()` method as a static property to that
-     * function.
-     *
-     * @param {object} config Validator config
-     * @returns {object} Validator object
+     * @param {object} config Validator config (custom to the validator being created)
+     * @returns {Validator} Validator object
      * @throws {TypeError} When configurarion is invalid.
      */
-    static make(config?: object): object;
+    static make(config?: object): Validator;
     static coerceToValidatorObject(input: any): any;
     constructor(config?: {});
     config: {};
-    /**
-     * Validate the field value.
-     *
-     * @param {any} fieldValue Field value
-     * @param {ValidateContext} context Validation context
-     */
     validate(fieldValue: any, context: any): void;
     sanitise(fieldValue: any): any;
 }
+export type ProcessorFunction = import('./index').ProcessorFunction;
+export type JourneyContext = import('./index').JourneyContext;
+export type ValidationError = import('./index').ValidationError;
+export type Validator = {
+    /**
+     * Validation function
+     */
+    validate: ValidateFunction;
+    /**
+     * Sanitise a given value prior to validation
+     */
+    sanitise: any;
+    /**
+     * Configuration
+     */
+    config: object;
+    /**
+     * Validator name
+     */
+    name: string;
+};
+export type ValidateFunction = (value: any, context: ValidateContext) => ValidationError[];
+/**
+ * Context passed to validate function
+ */
+export type ValidateContext = {
+    /**
+     * Journey context
+     */
+    journeyContext: JourneyContext;
+    /**
+     * Waypoint
+     */
+    waypoint: string;
+    /**
+     * Name of field being processed
+     */
+    fieldName: string;
+};

package/dist/lib/ValidatorFactory.js

@@ -4,24 +4,43 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable class-methods-use-this */
-// const { isPlainObject } = require('../Util.js');
 const lodash_1 = __importDefault(require("lodash"));
 const { isPlainObject } = lodash_1.default; // CommonJS
+/**
+ * @typedef {import('./index').ProcessorFunction} ProcessorFunction
+ */
+/**
+ * @typedef {import('./index').JourneyContext} JourneyContext
+ */
+/**
+ * @typedef {import('./index').ValidationError} ValidationError
+ */
+/**
+ * @typedef {object} Validator
+ * @property {ValidateFunction} validate Validation function
+ * @property {ProcessorFunction} sanitise Sanitise a given value prior to validation
+ * @property {object} config Configuration
+ * @property {string} name Validator name
+ */
+/**
+ * @callback ValidateFunction
+ * @param {any} value
+ * @param {ValidateContext} context
+ * @returns {ValidationError[]}
+ */
+/**
+ * @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
+ */
 class ValidatorFactory {
     /**
-     * This is a convenience method that will bind and return this class'
-     * `validate()` function, so you can call it directly rather than calling the
-     * method. i.e.
+     * This is a convenience method that will return a consistently object
+     * structure containing validation and sanitisation methods.
      *
-     *  MyValidator.make()('value to validate')
-     *    versus
-     *  (new MyValidator()).validate('value to validate')
-     *
-     * It also attaches the `sanitise()` method as a static property to that
-     * function.
-     *
-     * @param {object} config Validator config
-     * @returns {object} Validator object
+     * @param {object} config Validator config (custom to the validator being created)
+     * @returns {Validator} Validator object
      * @throws {TypeError} When configurarion is invalid.
      */
     static make(config = {}) {
@@ -31,7 +50,7 @@ class ValidatorFactory {
         const validator = Reflect.construct(this, [config]);
         /* eslint-disable-next-line sonarjs/prefer-object-literal */
         const instance = {};
-        instance.name = validator.name || validator.constructor.name;
+        instance.name = validator.name || 'unknown';
         instance.config = config;
         instance.validate = validator.validate.bind(instance);
         instance.sanitise = validator.sanitise.bind(instance);
@@ -75,12 +94,6 @@ class ValidatorFactory {
         }
         this.config = config;
     }
-    /**
-     * Validate the field value.
-     *
-     * @param {any} fieldValue Field value
-     * @param {ValidateContext} context Validation context
-     */
     /* eslint-disable-next-line no-unused-vars */
     validate(fieldValue, context) {
         throw new Error('validate() method has not been implemented');