@dwp/govuk-casa 8.0.0-alpha1 → 8.0.0

package/dist/lib/configure.d.ts

@@ -1,46 +1,26 @@
 /**
- *
- * @typedef {Object} SessionOptions
- * @property {string} [name=casasession] Session name
- * @property {string} [secret=secret] Encryption secret
- * @property {number} [ttl=3600] Session ttl (seconds)
- * @property {boolean} [secure=false] Whether to use secure session cookies
- * @property {boolean|string} [cookieSameSite=true] SameSite setting (true (Strict), false (no value), Strict, Lax, None, default true)
- * @property {object} [store] Session store (default MemoryStore)
- */
-/**
- * @typedef {Object} GlobalHook Hook configuration
- * @property {string} hook Hook name in format `<router>.<hook>`
- * @property {function} middleware Middleware function to insert at the hook point
- * @property {string|RegExp} [path=undefined] Hook only triggered if route path matches this string/regexp (optional, default /./)
+ * @typedef {import('express').RequestHandler} ExpressRequestHandler
  */
 /**
- * @typedef {Object} PageHook (extends GlobalHook)
- * @property {string} hook Hook name (without a scope prefix)
- * @property {function} middleware Middleware function to insert at the hook point
+ * @typedef {import('./index').MutableRouter} MutableRouter
  */
 /**
- * @typedef {Object} Page Page configuration. A Page is the interactive representation of a waypoint
- * @property {string} waypoint The waypoint with which this page is associated
- * @property {string} view Template path
- * @property {PageHook[]} hooks Page-specific hooks
- * @property {PageField[]} fields Fields to be managed on this page
+ * @typedef {import('./configuration-ingestor').ConfigurationOptions} ConfigurationOptions
  */
 /**
- * @typedef {Object} ConfigureResult Result of a call to configure() function
- * @property {nunjucks.Environment} nunjucksEnv Nunjucks environment to attach to other ExpressJS app instances
- * @property {MutableRouter} staticRouter ExpressJS Router instance which serves all static assets
- * @property {MutableRouter} ancillaryRouter ExpressJS app instance which serves all ancillary routes
- * @property {MutableRouter} journeyRouter ExpressJS app instance which serves page routes for each waypoint in a user's journey
- * @property {express.RequestHandler[]} preMiddleware Middleware mounted before anything else
- * @property {express.RequestHandler[]} postMiddleware Middleware mounted after everything else
- * @property {express.RequestHandler[]} csrfMiddleware Collection of middleware useful for pages containing forms
- * @property {express.RequestHandler} sessionMiddleware Session middleware
- * @property {express.RequestHandler[]} cookieParserMiddleware Cookie-parsing middleware (configured to match that of session middleware)
- * @property {express.RequestHandler[]} i18nMiddleware I18n preparation middleware
- * @property {express.RequestHandler} bodyParserMiddleware Body parsing middleware
- * @property {express.RequestHandler[]} csrfMiddleware CSRF middleware
- * @property {function} mount Function used to mount all CASA artifacts onto an ExpressJS app instance
+ * @typedef {object} ConfigureResult Result of a call to configure() function
+ * @property {nunjucks.Environment} nunjucksEnv Nunjucks environment
+ * @property {MutableRouter} staticRouter Router handling all static assets
+ * @property {MutableRouter} ancillaryRouter Router handling ancillary routes
+ * @property {MutableRouter} journeyRouter Router handling all waypoint requests
+ * @property {ExpressRequestHandler[]} preMiddleware Middleware mounted before anything else
+ * @property {ExpressRequestHandler[]} postMiddleware Middleware mounted after everything else
+ * @property {ExpressRequestHandler[]} csrfMiddleware CSRF get/set middleware (useful for forms)
+ * @property {ExpressRequestHandler} sessionMiddleware Session middleware
+ * @property {ExpressRequestHandler[]} cookieParserMiddleware Cookie-parsing middleware
+ * @property {ExpressRequestHandler[]} i18nMiddleware I18n preparation middleware
+ * @property {ExpressRequestHandler} bodyParserMiddleware Body parsing middleware
+ * @property {Function} mount Function used to mount all CASA artifacts onto an ExpressJS app
  */
 /**
  * Configure some middleware for use in creating a new CASA app.
@@ -48,158 +28,63 @@
  * `mountUrl` is used to ensure the CSS content uses the correct reference to
  * static assets in the `govuk-frontend` module.
  *
- * @param {Object} config Configuration options
- * @param {string} [config.mountUrl=/] URL path used to serve static assets from and generate links (optional, default /)
- * @param {string} [config.serviceName=common.serviceName] Service name (i18n key) to display in header (optional, default common:serviceName)
- * @param {string[]} [config.views=[]] Array of directories in which Nunjucks templates will be searched for (optional, default [])
- * @param {SessionOptions} [config.session] Session configuration
- * @param {Page[]} [config.pages=[]] Pages the represent waypoints in the Plan (optional, default [])
- * @param {GlobalHook[]} [config.hooks=[]] Hooks to apply (optional, default [])
- * @param {Object[]} [config.plugins=[]] Plugins(optional, default [])
- * @param {I18nOptions[]} [config.i18n] I18n configuration
- * @param {Plan} config.plan CASA Plan
- * @param {ContextEvent[]} [config.events=[]] Handlers for JourneyContext events
+ * @param {ConfigurationOptions} config Configuration options
  * @returns {ConfigureResult} Result
  */
-export default function configure(config?: {
-    mountUrl?: string | undefined;
-    serviceName?: string | undefined;
-    views?: string[] | undefined;
-    session?: SessionOptions | undefined;
-    pages?: Page[] | undefined;
-    hooks?: GlobalHook[] | undefined;
-    plugins?: Object[] | undefined;
-    i18n?: any[] | undefined;
-    plan: any;
-    events?: any[] | undefined;
-}): ConfigureResult;
-export type SessionOptions = {
-    /**
-     * Session name
-     */
-    name?: string | undefined;
-    /**
-     * Encryption secret
-     */
-    secret?: string | undefined;
-    /**
-     * Session ttl (seconds)
-     */
-    ttl?: number | undefined;
-    /**
-     * Whether to use secure session cookies
-     */
-    secure?: boolean | undefined;
-    /**
-     * SameSite setting (true (Strict), false (no value), Strict, Lax, None, default true)
-     */
-    cookieSameSite?: string | boolean | undefined;
-    /**
-     * Session store (default MemoryStore)
-     */
-    store?: object | undefined;
-};
-/**
- * Hook configuration
- */
-export type GlobalHook = {
-    /**
-     * Hook name in format `<router>.<hook>`
-     */
-    hook: string;
-    /**
-     * Middleware function to insert at the hook point
-     */
-    middleware: Function;
-    /**
-     * Hook only triggered if route path matches this string/regexp (optional, default /./)
-     */
-    path?: string | RegExp | undefined;
-};
-/**
- * (extends GlobalHook)
- */
-export type PageHook = {
-    /**
-     * Hook name (without a scope prefix)
-     */
-    hook: string;
-    /**
-     * Middleware function to insert at the hook point
-     */
-    middleware: Function;
-};
-/**
- * Page configuration. A Page is the interactive representation of a waypoint
- */
-export type Page = {
-    /**
-     * The waypoint with which this page is associated
-     */
-    waypoint: string;
-    /**
-     * Template path
-     */
-    view: string;
-    /**
-     * Page-specific hooks
-     */
-    hooks: PageHook[];
-    /**
-     * Fields to be managed on this page
-     */
-    fields: any[];
-};
+export default function configure(config?: ConfigurationOptions): ConfigureResult;
+export type ExpressRequestHandler = import('express').RequestHandler;
+export type MutableRouter = import('./index').MutableRouter;
+export type ConfigurationOptions = import('./configuration-ingestor').ConfigurationOptions;
 /**
  * Result of a call to configure() function
  */
 export type ConfigureResult = {
     /**
-     * Nunjucks environment to attach to other ExpressJS app instances
+     * Nunjucks environment
      */
-    nunjucksEnv: any;
+    nunjucksEnv: nunjucks.Environment;
     /**
-     * ExpressJS Router instance which serves all static assets
+     * Router handling all static assets
      */
-    staticRouter: any;
+    staticRouter: MutableRouter;
     /**
-     * ExpressJS app instance which serves all ancillary routes
+     * Router handling ancillary routes
      */
-    ancillaryRouter: any;
+    ancillaryRouter: MutableRouter;
     /**
-     * ExpressJS app instance which serves page routes for each waypoint in a user's journey
+     * Router handling all waypoint requests
      */
-    journeyRouter: any;
+    journeyRouter: MutableRouter;
     /**
      * Middleware mounted before anything else
      */
-    preMiddleware: any[];
+    preMiddleware: ExpressRequestHandler[];
     /**
      * Middleware mounted after everything else
      */
-    postMiddleware: any[];
+    postMiddleware: ExpressRequestHandler[];
     /**
-     * Collection of middleware useful for pages containing forms
+     * CSRF get/set middleware (useful for forms)
      */
-    csrfMiddleware: any[];
+    csrfMiddleware: ExpressRequestHandler[];
     /**
      * Session middleware
      */
-    sessionMiddleware: any;
+    sessionMiddleware: ExpressRequestHandler;
     /**
-     * Cookie-parsing middleware (configured to match that of session middleware)
+     * Cookie-parsing middleware
      */
-    cookieParserMiddleware: any[];
+    cookieParserMiddleware: ExpressRequestHandler[];
     /**
      * I18n preparation middleware
      */
-    i18nMiddleware: any[];
+    i18nMiddleware: ExpressRequestHandler[];
     /**
      * Body parsing middleware
      */
-    bodyParserMiddleware: any;
+    bodyParserMiddleware: ExpressRequestHandler;
     /**
-     * Function used to mount all CASA artifacts onto an ExpressJS app instance
+     * Function used to mount all CASA artifacts onto an ExpressJS app
      */
     mount: Function;
 };

package/dist/lib/configure.js

@@ -3,10 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const dirname_cjs_1 = __importDefault(require("./dirname.cjs"));
 const express_session_1 = require("express-session");
 const path_1 = require("path");
 const module_1 = require("module");
+const cookie_parser_1 = __importDefault(require("cookie-parser"));
+const dirname_cjs_1 = __importDefault(require("./dirname.cjs"));
+const configuration_ingestor_js_1 = __importDefault(require("./configuration-ingestor.js"));
 const nunjucks_js_1 = __importDefault(require("./nunjucks.js"));
 const static_js_1 = __importDefault(require("../routes/static.js"));
 const ancillary_js_1 = __importDefault(require("../routes/ancillary.js"));
@@ -14,54 +16,33 @@ const journey_js_1 = __importDefault(require("../routes/journey.js"));
 const pre_js_1 = __importDefault(require("../middleware/pre.js"));
 const post_js_1 = __importDefault(require("../middleware/post.js"));
 const session_js_1 = __importDefault(require("../middleware/session.js"));
-const cookie_parser_1 = __importDefault(require("cookie-parser"));
 const i18n_js_1 = __importDefault(require("../middleware/i18n.js"));
 const data_js_1 = __importDefault(require("../middleware/data.js"));
 const body_parser_js_1 = __importDefault(require("../middleware/body-parser.js"));
 const csrf_js_1 = __importDefault(require("../middleware/csrf.js"));
 /**
- *
- * @typedef {Object} SessionOptions
- * @property {string} [name=casasession] Session name
- * @property {string} [secret=secret] Encryption secret
- * @property {number} [ttl=3600] Session ttl (seconds)
- * @property {boolean} [secure=false] Whether to use secure session cookies
- * @property {boolean|string} [cookieSameSite=true] SameSite setting (true (Strict), false (no value), Strict, Lax, None, default true)
- * @property {object} [store] Session store (default MemoryStore)
+ * @typedef {import('express').RequestHandler} ExpressRequestHandler
  */
 /**
- * @typedef {Object} GlobalHook Hook configuration
- * @property {string} hook Hook name in format `<router>.<hook>`
- * @property {function} middleware Middleware function to insert at the hook point
- * @property {string|RegExp} [path=undefined] Hook only triggered if route path matches this string/regexp (optional, default /./)
+ * @typedef {import('./index').MutableRouter} MutableRouter
  */
 /**
- * @typedef {Object} PageHook (extends GlobalHook)
- * @property {string} hook Hook name (without a scope prefix)
- * @property {function} middleware Middleware function to insert at the hook point
+ * @typedef {import('./configuration-ingestor').ConfigurationOptions} ConfigurationOptions
  */
 /**
- * @typedef {Object} Page Page configuration. A Page is the interactive representation of a waypoint
- * @property {string} waypoint The waypoint with which this page is associated
- * @property {string} view Template path
- * @property {PageHook[]} hooks Page-specific hooks
- * @property {PageField[]} fields Fields to be managed on this page
- */
-/**
- * @typedef {Object} ConfigureResult Result of a call to configure() function
- * @property {nunjucks.Environment} nunjucksEnv Nunjucks environment to attach to other ExpressJS app instances
- * @property {MutableRouter} staticRouter ExpressJS Router instance which serves all static assets
- * @property {MutableRouter} ancillaryRouter ExpressJS app instance which serves all ancillary routes
- * @property {MutableRouter} journeyRouter ExpressJS app instance which serves page routes for each waypoint in a user's journey
- * @property {express.RequestHandler[]} preMiddleware Middleware mounted before anything else
- * @property {express.RequestHandler[]} postMiddleware Middleware mounted after everything else
- * @property {express.RequestHandler[]} csrfMiddleware Collection of middleware useful for pages containing forms
- * @property {express.RequestHandler} sessionMiddleware Session middleware
- * @property {express.RequestHandler[]} cookieParserMiddleware Cookie-parsing middleware (configured to match that of session middleware)
- * @property {express.RequestHandler[]} i18nMiddleware I18n preparation middleware
- * @property {express.RequestHandler} bodyParserMiddleware Body parsing middleware
- * @property {express.RequestHandler[]} csrfMiddleware CSRF middleware
- * @property {function} mount Function used to mount all CASA artifacts onto an ExpressJS app instance
+ * @typedef {object} ConfigureResult Result of a call to configure() function
+ * @property {nunjucks.Environment} nunjucksEnv Nunjucks environment
+ * @property {MutableRouter} staticRouter Router handling all static assets
+ * @property {MutableRouter} ancillaryRouter Router handling ancillary routes
+ * @property {MutableRouter} journeyRouter Router handling all waypoint requests
+ * @property {ExpressRequestHandler[]} preMiddleware Middleware mounted before anything else
+ * @property {ExpressRequestHandler[]} postMiddleware Middleware mounted after everything else
+ * @property {ExpressRequestHandler[]} csrfMiddleware CSRF get/set middleware (useful for forms)
+ * @property {ExpressRequestHandler} sessionMiddleware Session middleware
+ * @property {ExpressRequestHandler[]} cookieParserMiddleware Cookie-parsing middleware
+ * @property {ExpressRequestHandler[]} i18nMiddleware I18n preparation middleware
+ * @property {ExpressRequestHandler} bodyParserMiddleware Body parsing middleware
+ * @property {Function} mount Function used to mount all CASA artifacts onto an ExpressJS app
  */
 /**
  * Configure some middleware for use in creating a new CASA app.
@@ -69,17 +50,7 @@ const csrf_js_1 = __importDefault(require("../middleware/csrf.js"));
  * `mountUrl` is used to ensure the CSS content uses the correct reference to
  * static assets in the `govuk-frontend` module.
  *
- * @param {Object} config Configuration options
- * @param {string} [config.mountUrl=/] URL path used to serve static assets from and generate links (optional, default /)
- * @param {string} [config.serviceName=common.serviceName] Service name (i18n key) to display in header (optional, default common:serviceName)
- * @param {string[]} [config.views=[]] Array of directories in which Nunjucks templates will be searched for (optional, default [])
- * @param {SessionOptions} [config.session] Session configuration
- * @param {Page[]} [config.pages=[]] Pages the represent waypoints in the Plan (optional, default [])
- * @param {GlobalHook[]} [config.hooks=[]] Hooks to apply (optional, default [])
- * @param {Object[]} [config.plugins=[]] Plugins(optional, default [])
- * @param {I18nOptions[]} [config.i18n] I18n configuration
- * @param {Plan} config.plan CASA Plan
- * @param {ContextEvent[]} [config.events=[]] Handlers for JourneyContext events
+ * @param {ConfigurationOptions} config Configuration options
  * @returns {ConfigureResult} Result
  */
 function configure(config = {}) {
@@ -90,18 +61,24 @@ function configure(config = {}) {
         plugin.configure(config);
     });
     // Extract config
-    // TODO: Validate/sanitise and deep-freeze object
-    const { mountUrl = '/', serviceName = 'common:serviceName', views = [], session = {
+    const { mountUrl = '/', views = [], session = {
         secret: 'secret',
         name: 'casasession',
         secure: false,
-        ttl: 60 * 60,
+        ttl: 3600,
         cookieSameSite: true,
+        cookiePath: '/',
         store: undefined,
     }, pages = [], plan = null, hooks = [], plugins = [], events = [], i18n = {
         dirs: [],
         locales: ['en', 'cy'],
-    }, } = config;
+    }, } = (0, configuration_ingestor_js_1.default)(config);
+    // Prepare all page hooks so they are prefixed with the `journey.` scope.
+    pages.forEach((page) => {
+        var _a;
+        /* eslint-disable-next-line no-param-reassign,no-return-assign */
+        ((_a = page === null || page === void 0 ? void 0 : page.hooks) !== null && _a !== void 0 ? _a : []).forEach((h) => h.hook = `journey.${h.hook}`);
+    });
     // Prepare a Nunjucks environment for rendering all templates.
     // Resolve priority: userland templates > CASA templates > GOVUK templates > Plugin templates
     const nunjucksEnv = (0, nunjucks_js_1.default)({
@@ -116,7 +93,7 @@ function configure(config = {}) {
     // These _must_ be added to the ExpressJS application at the start and end
     // of all other middleware respectively.
     const preMiddleware = (0, pre_js_1.default)();
-    const postMiddleware = (0, post_js_1.default)();
+    const postMiddleware = (0, post_js_1.default)({ mountUrl });
     // Prepare common middleware mounted prior to the ancillaryRouter
     const cookieParserMiddleware = (0, cookie_parser_1.default)(session.secret);
     const sessionMiddleware = (0, session_js_1.default)({
@@ -126,6 +103,7 @@ function configure(config = {}) {
         name: session.name,
         ttl: session.ttl,
         cookieSameSite: session.cookieSameSite,
+        cookiePath: session.cookiePath,
         mountUrl,
         store: (_b = session.store) !== null && _b !== void 0 ? _b : new express_session_1.MemoryStore(),
     });
@@ -140,7 +118,6 @@ function configure(config = {}) {
     const dataMiddleware = (0, data_js_1.default)({
         plan,
         mountUrl,
-        serviceName,
         events,
     });
     // Prepare form middleware and its constiuent parts
@@ -173,7 +150,7 @@ function configure(config = {}) {
         app.set('view engine', 'njk');
         app.use(preMiddleware);
         app.use(staticRouter.seal());
-        app.use(sessionMiddleware); // A session is useful to all pages, so assume it is always mounted after static routes
+        app.use(sessionMiddleware); // A session is useful to all pages, so always mounted
         app.use(i18nMiddleware);
         app.use(bodyParserMiddleware);
         app.use(dataMiddleware);
@@ -194,21 +171,20 @@ function configure(config = {}) {
         staticRouter,
         ancillaryRouter,
         journeyRouter,
-        // Form middleware. Should be used wherever form pages are built.
+        // CSRF middleware. Should be used wherever form pages are built.
         csrfMiddleware,
         // Other middleware
         // These may be used by the application author to build other custom routes
         cookieParserMiddleware,
         sessionMiddleware,
         bodyParserMiddleware,
-        csrfMiddleware,
         i18nMiddleware,
         dataMiddleware,
         // Mount function
         mount,
     };
     // Bootstrap all plugins
-    plugins.filter(p => p.bootstrap).forEach((plugin) => plugin === null || plugin === void 0 ? void 0 : plugin.bootstrap(configOutput));
+    plugins.filter((p) => p.bootstrap).forEach((plugin) => plugin === null || plugin === void 0 ? void 0 : plugin.bootstrap(configOutput));
     // Finished configuration
     return configOutput;
 }

package/dist/lib/dirname.cjs

@@ -1 +1 @@
-module.exports = __dirname;
+module.exports = __dirname;

package/dist/lib/dirname.d.cts

@@ -0,0 +1,2 @@
+declare const _exports: string;
+export = _exports;

package/dist/lib/end-session.d.ts

@@ -1,12 +1,13 @@
 /**
  * A convenience for ending the current session, but retaining some data in it,
- * like the current language.
+ * like the current language. It persists an empty session before regenerating
+ * a new ID.
  *
  * Note: this will not remove the session from server-side storage, which will
  * instead be left up to the storage mechanism to clean up.
  *
- * @param {Object} req HTTP request
+ * @param {object} req HTTP request
  * @param {Function} next Chain
  * @returns {void}
  */
-export default function endSession(req: Object, next: Function): void;
+export default function endSession(req: object, next: Function): void;

package/dist/lib/end-session.js

@@ -1,24 +1,46 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const logger_js_1 = __importDefault(require("./logger.js"));
+const log = (0, logger_js_1.default)('lib:end-session');
 /**
  * A convenience for ending the current session, but retaining some data in it,
- * like the current language.
+ * like the current language. It persists an empty session before regenerating
+ * a new ID.
  *
  * Note: this will not remove the session from server-side storage, which will
  * instead be left up to the storage mechanism to clean up.
  *
- * @param {Object} req HTTP request
+ * @param {object} req HTTP request
  * @param {Function} next Chain
  * @returns {void}
  */
 function endSession(req, next) {
-    const language = req.session.language;
-    req.session.regenerate((err) => {
-        if (err) {
-            return next(err);
+    const { language } = req.session;
+    Object.entries(req.session).forEach(([k]) => {
+        if (!['cookie'].includes(k)) {
+            // ESLint disabled as `Object.entries()` returns "own" properties, and
+            // all values are being null'd, so not assigned any user-controlled values
+            /* eslint-disable-next-line security/detect-object-injection */
+            req.session[k] = null;
         }
-        req.session.language = language;
-        req.session.save(next);
+    });
+    req.session.save((saveErr) => {
+        if (saveErr) {
+            log.error(saveErr);
+        }
+        req.session.regenerate((err) => {
+            if (err) {
+                log.error(err);
+                next(err);
+            }
+            else {
+                req.session.language = language;
+                req.session.save(next);
+            }
+        });
     });
 }
 exports.default = endSession;

package/dist/lib/field.d.ts

@@ -5,16 +5,40 @@ export 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): any;
+    getValue(obj?: object): any;
     putValue(obj: any, value: any): PageField;
     get name(): string;
-    get meta(): Object;
-    validators(...items: any[]): PageField | Validator[];
-    processors(...items: any[]): Function[] | PageField;
-    conditions(...items: any[]): Function[] | PageField;
+    get meta(): object;
+    /**
+     * 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?: ValidateFunction[]): PageField | ValidateFunction[];
+    /**
+     * 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?: ProcessorFunction[]): PageField | ProcessorFunction[];
+    /**
+     * 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?: ConditionFunction[]): PageField | ConditionFunction[];
     /**
      * Run all validators and return array of errors, if applicable.
      *
@@ -22,58 +46,32 @@ export class PageField {
      * @param {ValidateContext} context Contextual information
      * @returns {ValidationError[]} Errors, or an empty array if all valid
      */
-    runValidators(value: any, context: ValidateContext): any[];
+    runValidators(value: any, context: any): ValidationError[];
     applyProcessors(value: any): any;
     /**
      * 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 }: Object): boolean;
-    validator(...args: any[]): PageField | Validator[];
-    processor(...args: any[]): Function[] | PageField;
-    condition(...args: any[]): Function[] | PageField;
-    if(...args: any[]): Function[] | PageField;
+    testConditions({ fieldValue, waypoint, journeyContext }: {
+        fieldValue: string;
+        waypoint: string;
+        journeyContext: object;
+    }): boolean;
+    validator(validator: any): any[] | PageField;
+    processor(processor: any): PageField | ProcessorFunction[];
+    condition(condition: any): PageField | ConditionFunction[];
+    if(...args: any[]): PageField | ConditionFunction[];
     #private;
 }
-export type Validator = {
-    /**
-     * Validation function
-     */
-    validate: ValidateFunction;
-    /**
-     * Sanitise a given value to make it suitable for this validator
-     */
-    sanitise: SanitiseFunction;
-    /**
-     * Configuration
-     */
-    config: Object;
-    /**
-     * Validator name
-     */
-    name: string;
-};
-export type ValidateFunction = (value: any, context: ValidateContext) => any[];
-export type SanitiseFunction = (value: any) => any;
-/**
- * Context passed to validate function
- */
-export type ValidateContext = {
-    /**
-     * Journey context
-     */
-    journeyContext: any;
-    /**
-     * Waypoint
-     */
-    waypoint: string;
-    /**
-     * Name of field being processed
-     */
-    fieldName: string;
-};
+export type JourneyContext = import('./index').JourneyContext;
+export type Validator = import('./index').Validator;
+export type ValidateFunction = import('./index').ValidateFunction;
+export type ValidateContext = import('./index').ValidateContext;
+export type ValidationError = import('./index').ValidationError;
+export type ProcessorFunction = (value: any) => any;
+export type ConditionFunction = (context: Object, fieldName: string, fieldValue: any, waypoint: string, waypointId: string, journeyContext: JourneyContext) => boolean;