@dwp/govuk-casa 8.2.1 → 8.2.4

package/dist/lib/utils.js

@@ -1,12 +1,14 @@
 "use strict";
 /**
+ * @access private
  * @typedef {import('../casa').GlobalHook | import('../casa').PageHook} Hook
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stripProxyFromUrlPath = exports.notProto = exports.validateHookPath = exports.validateHookName = exports.validateView = exports.validateUrlPath = exports.validateWaypoint = exports.resolveMiddlewareHooks = exports.isEmpty = exports.stringifyInput = exports.isStringable = void 0;
+exports.notProto = exports.validateHookPath = exports.validateHookName = exports.validateView = exports.validateUrlPath = exports.validateWaypoint = exports.resolveMiddlewareHooks = exports.isEmpty = exports.stringifyInput = exports.isStringable = void 0;
 /**
  * Test is a value can be stringifed (numbers or strings)
  *
+ * @access private
  * @param {any} value Item to test
  * @returns {boolean} Whether the value is stringable or not
  */
@@ -17,6 +19,7 @@ exports.isStringable = isStringable;
 /**
  * Coerce an input to a string.
  *
+ * @access private
  * @param {any} input Input to be stringified
  * @param {string} fallback Fallback to use if input can't be stringified
  * @returns {string} The stringified input
@@ -30,6 +33,7 @@ exports.stringifyInput = stringifyInput;
 /**
  * Determine if value is empty. Recurse over objects.
  *
+ * @access private
  * @param  {any} val Value to check
  * @returns {boolean} True if the object is empty
  */
@@ -51,6 +55,7 @@ exports.isEmpty = isEmpty;
  * Extract the middleware functions that are relevant for the given hook and
  * path.
  *
+ * @access private
  * @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
@@ -63,6 +68,15 @@ function resolveMiddlewareHooks(hookName, path, hooks = []) {
 }
 exports.resolveMiddlewareHooks = resolveMiddlewareHooks;
 /* ------------------------------------------------ validation / sanitisation */
+/**
+ * Validate a waypoint.
+ *
+ * @access private
+ * @param {string} waypoint Waypoint
+ * @returns {void}
+ * @throws {TypeError}
+ * @throws {SyntaxError}
+ */
 function validateWaypoint(waypoint) {
     if (typeof waypoint !== 'string') {
         throw new TypeError('Waypoint must be a string');
@@ -75,6 +89,15 @@ function validateWaypoint(waypoint) {
     }
 }
 exports.validateWaypoint = validateWaypoint;
+/**
+ * Validate a URL path.
+ *
+ * @access private
+ * @param {string} path URL path
+ * @returns {string} Same string, if valid
+ * @throws {TypeError}
+ * @throws {SyntaxError}
+ */
 function validateUrlPath(path) {
     if (typeof path !== 'string') {
         throw new TypeError('URL path must be a string');
@@ -88,6 +111,15 @@ function validateUrlPath(path) {
     return path;
 }
 exports.validateUrlPath = validateUrlPath;
+/**
+ * Validate a template name.
+ *
+ * @access private
+ * @param {string} view Template name
+ * @returns {void}
+ * @throws {TypeError}
+ * @throws {SyntaxError}
+ */
 function validateView(view) {
     if (typeof view !== 'string') {
         throw new TypeError('View must be a string');
@@ -100,6 +132,15 @@ function validateView(view) {
     }
 }
 exports.validateView = validateView;
+/**
+ * Validate a hook name.
+ *
+ * @access private
+ * @param {string} hookName Hook name
+ * @returns {void}
+ * @throws {TypeError}
+ * @throws {SyntaxError}
+ */
 function validateHookName(hookName) {
     if (typeof hookName !== 'string') {
         throw new TypeError('Hook name must be a string');
@@ -121,6 +162,7 @@ exports.validateHookPath = validateHookPath;
 /**
  * Checks if the given string can be used as an object key.
  *
+ * @access private
  * @param {string} key Proposed Object key
  * @returns {string} Same key if it's valid
  * @throws {Error} if proposed key is an invalid keyword
@@ -132,28 +174,3 @@ function notProto(key) {
     return key;
 }
 exports.notProto = notProto;
-/**
- * Remove any path segments from the URL that are present in the `mountpath`,
- * but not in the `baseUrl`. Those segments are considered to be part of an
- * internal proxying arrangement, and should not be used by CASA.
- *
- * @param {import('express').Request} req Express request
- * @throws {Error} When multiple mountpaths are present
- * @returns {string} URL path with any proxy prefixes removed
- */
-function stripProxyFromUrlPath(req) {
-    if (typeof req.app.mountpath !== 'string') {
-        throw new Error('CASA does not currently support multiple mountpaths');
-    }
-    let stripped = '/';
-    const mountPathParts = req.app.mountpath.replace(/^\/+/, '').replace(/\/+$/, '').split('/');
-    const baseUrlParts = req.baseUrl.replace(/^\/+/, '').replace(/\/+$/, '').split('/');
-    for (let i = 0, l = mountPathParts.length; i < l; i++) {
-        /* eslint-disable-next-line security/detect-object-injection */
-        if (baseUrlParts.length && mountPathParts[i] === baseUrlParts[0]) {
-            stripped = `${stripped}${baseUrlParts.shift()}/`;
-        }
-    }
-    return stripped;
-}
-exports.stripProxyFromUrlPath = stripProxyFromUrlPath;

package/dist/lib/validators/dateObject.d.ts

@@ -1,5 +1,79 @@
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} DateObjectConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ * @property {object} [afterOffsetFromNow] Offset from now
+ * @property {ErrorMessageConfig} [errorMsgAfterOffset] Error if date is after this offset
+ * @property {object} [beforeOffsetFromNow] Offset from now
+ * @property {ErrorMessageConfig} [errorMsgBeforeOffset] Error if date is before this offset
+ * @property {boolean} [allowMonthNames=false] Allow "Jan", "January", etc
+ * @property {boolean} [allowSingleDigitDay=false] Allow "1" rather than "01"
+ * @property {boolean} [allowSingleDigitMonth=false] Allow "1" rather than "01"
+ * @property {DateTime} [now=false] Override the notion of "now" (useful for testing)
+ */
+/**
+ * Date object format:
+ *  {
+ *    dd: <string>,
+ *    mm: <string>,
+ *    yyyy: <string>
+ *  }.
+ *
+ * Note that the time part will be zero'ed, as we are only interested in the
+ * date component (minimum day resolution).
+ *
+ * See {@link DateObjectConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 export default class DateObject extends ValidatorFactory {
+    /** @property {string} name Validator name ("dateObject") */
     name: string;
-    validate(value: any, dataContext?: {}): object[];
+    validate(value: any, dataContext?: {}): ValidationError[];
+    sanitise(value: any): any;
 }
+export type ErrorMessageConfig = import('../../casa').ErrorMessageConfig;
+export type DateObjectConfigOptions = {
+    /**
+     * Error message config
+     */
+    errorMsg: ErrorMessageConfig;
+    /**
+     * Offset from now
+     */
+    afterOffsetFromNow?: object | undefined;
+    /**
+     * Error if date is after this offset
+     */
+    errorMsgAfterOffset?: import("../../casa").ErrorMessageConfig | undefined;
+    /**
+     * Offset from now
+     */
+    beforeOffsetFromNow?: object | undefined;
+    /**
+     * Error if date is before this offset
+     */
+    errorMsgBeforeOffset?: import("../../casa").ErrorMessageConfig | undefined;
+    /**
+     * Allow "Jan", "January", etc
+     */
+    allowMonthNames?: boolean | undefined;
+    /**
+     * Allow "1" rather than "01"
+     */
+    allowSingleDigitDay?: boolean | undefined;
+    /**
+     * Allow "1" rather than "01"
+     */
+    allowSingleDigitMonth?: boolean | undefined;
+    /**
+     * Override the notion of "now" (useful for testing)
+     */
+    now?: any;
+};
 import ValidatorFactory from "../ValidatorFactory.js";
+import ValidationError from "../ValidationError.js";

package/dist/lib/validators/dateObject.js

@@ -4,6 +4,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable class-methods-use-this */
+const luxon_1 = require("luxon");
+const lodash_1 = __importDefault(require("lodash"));
+const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
+const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
+const utils_js_1 = require("../utils.js");
+const { isPlainObject } = lodash_1.default;
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} DateObjectConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ * @property {object} [afterOffsetFromNow] Offset from now
+ * @property {ErrorMessageConfig} [errorMsgAfterOffset] Error if date is after this offset
+ * @property {object} [beforeOffsetFromNow] Offset from now
+ * @property {ErrorMessageConfig} [errorMsgBeforeOffset] Error if date is before this offset
+ * @property {boolean} [allowMonthNames=false] Allow "Jan", "January", etc
+ * @property {boolean} [allowSingleDigitDay=false] Allow "1" rather than "01"
+ * @property {boolean} [allowSingleDigitMonth=false] Allow "1" rather than "01"
+ * @property {DateTime} [now=false] Override the notion of "now" (useful for testing)
+ */
 /**
  * Date object format:
  *  {
@@ -12,29 +34,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
  *    yyyy: <string>
  *  }.
  *
- * Note that the time part of any injected "DateTime" objects will be zero'ed, as
- * we are only interested in the date component (minimum day resolution).
+ * Note that the time part will be zero'ed, as we are only interested in the
+ * date component (minimum day resolution).
+ *
+ * See {@link DateObjectConfigOptions} for `make()` options.
  *
- * Config options:
- *   string|object errorMsg = Error message to use on validation failure
- *   object|luxon.Duration afterOffsetFromNow = Date must be after offset from now
- *   string|object errorMsgAfterOffset = Error for afterOffsetFromNow failure
- *   object|luxon.Duration beforeOffsetFromNow = Date must be before offset from now
- *   string|object errorMsgBeforeOffset = Error for beforeOffsetFromNow failure
- *   bool allowMonthNames = Allow "Jan", "January", etc (default = false)
- *   bool allowSingleDigitDay = Allow "1" rather than "01" (default = false)
- *   bool allowSingleDigitMonth = Allow "1" rather than "01" (default = false)
- *   luxon.DateTime now = Override the notion of "now" (useful for testing)
+ * @memberof Validators
+ * @augments ValidatorFactory
  */
-const luxon_1 = require("luxon");
-const lodash_1 = __importDefault(require("lodash"));
-const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
-const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
-const utils_js_1 = require("../utils.js");
-const { isPlainObject } = lodash_1.default;
 class DateObject extends ValidatorFactory_js_1.default {
     constructor() {
         super(...arguments);
+        /** @property {string} name Validator name ("dateObject") */
         this.name = 'dateObject';
     }
     validate(value, dataContext = {}) {

package/dist/lib/validators/email.d.ts

@@ -1,6 +1,33 @@
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} EmailConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ */
+/**
+ * Email address.
+ *
+ * This is not an exhaustive validation, and is permissive.
+ *
+ * See {@link EmailConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 export default class Email extends ValidatorFactory {
+    /** @property {string} name Validator name ("email") */
     name: string;
-    validate(value: any, dataContext?: {}): object[];
+    validate(value: any, dataContext?: {}): ValidationError[];
     sanitise(value: any): string | undefined;
 }
+export type ErrorMessageConfig = import('../../casa').ErrorMessageConfig;
+export type EmailConfigOptions = {
+    /**
+     * Error message config
+     */
+    errorMsg: ErrorMessageConfig;
+};
 import ValidatorFactory from "../ValidatorFactory.js";
+import ValidationError from "../ValidationError.js";

package/dist/lib/validators/email.js

@@ -1,25 +1,36 @@
 "use strict";
-/* eslint-disable class-methods-use-this */
-/**
- * Email address.
- *
- * This is not an exhaustive validation, and is permissive.
- *
- * Config options:
- *   string|object errorMsg = Error message to use on validation failure
- */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable class-methods-use-this */
 const validator_1 = __importDefault(require("validator"));
 const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
 const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
 const utils_js_1 = require("../utils.js");
 const { isEmail } = validator_1.default; // CommonJS
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} EmailConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ */
+/**
+ * Email address.
+ *
+ * This is not an exhaustive validation, and is permissive.
+ *
+ * See {@link EmailConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 class Email extends ValidatorFactory_js_1.default {
     constructor() {
         super(...arguments);
+        /** @property {string} name Validator name ("email") */
         this.name = 'email';
     }
     validate(value, dataContext = {}) {

package/dist/lib/validators/inArray.d.ts

@@ -1,6 +1,39 @@
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} ArrayConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ * @property {string[]} source Array of values to test against
+ */
+/**
+ * Test if a value is present in an array.
+ *
+ * If the value itself is an array, all values within that array must be present
+ * in the `source` array in order to pass validation.
+ *
+ * See {@link ArrayConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 export default class InArray extends ValidatorFactory {
+    /** @property {string} name Validator name ("inArray") */
     name: string;
-    validate(value: any, dataContext?: {}): object[];
+    validate(value: any, dataContext?: {}): ValidationError[];
     sanitise(value: any): string | string[] | undefined;
 }
+export type ErrorMessageConfig = import('../../casa').ErrorMessageConfig;
+export type ArrayConfigOptions = {
+    /**
+     * Error message config
+     */
+    errorMsg: ErrorMessageConfig;
+    /**
+     * Array of values to test against
+     */
+    source: string[];
+};
 import ValidatorFactory from "../ValidatorFactory.js";
+import ValidationError from "../ValidationError.js";

package/dist/lib/validators/inArray.js

@@ -16,9 +16,30 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
 const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
 const utils_js_1 = require("../utils.js");
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} ArrayConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ * @property {string[]} source Array of values to test against
+ */
+/**
+ * Test if a value is present in an array.
+ *
+ * If the value itself is an array, all values within that array must be present
+ * in the `source` array in order to pass validation.
+ *
+ * See {@link ArrayConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 class InArray extends ValidatorFactory_js_1.default {
     constructor() {
         super(...arguments);
+        /** @property {string} name Validator name ("inArray") */
         this.name = 'inArray';
     }
     validate(value, dataContext = {}) {

package/dist/lib/validators/index.js

@@ -12,6 +12,9 @@ const regex_js_1 = __importDefault(require("./regex.js"));
 const required_js_1 = __importDefault(require("./required.js"));
 const strlen_js_1 = __importDefault(require("./strlen.js"));
 const wordCount_js_1 = __importDefault(require("./wordCount.js"));
+/**
+ * @namespace Validators
+ */
 exports.default = {
     dateObject: dateObject_js_1.default,
     email: email_js_1.default,

package/dist/lib/validators/nino.d.ts

@@ -1,6 +1,39 @@
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} NinoConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ * @property {boolean} allowWhitespace Will permit input values that contain spaces.
+ */
+/**
+ * UK National Insurance number.
+ *
+ * Ref:
+ * https://en.wikipedia.org/wiki/National_Insurance_number#Format
+ * https://design-system.service.gov.uk/patterns/national-insurance-numbers/
+ *
+ * See {@link NinoConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 export default class Nino extends ValidatorFactory {
     name: string;
-    validate(value: any, dataContext?: {}): object[];
+    validate(value: any, dataContext?: {}): ValidationError[];
     sanitise(value: any): string | undefined;
 }
+export type ErrorMessageConfig = import('../../casa').ErrorMessageConfig;
+export type NinoConfigOptions = {
+    /**
+     * Error message config
+     */
+    errorMsg: ErrorMessageConfig;
+    /**
+     * Will permit input values that contain spaces.
+     */
+    allowWhitespace: boolean;
+};
 import ValidatorFactory from "../ValidatorFactory.js";
+import ValidationError from "../ValidationError.js";

package/dist/lib/validators/nino.js

@@ -4,20 +4,30 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable class-methods-use-this */
+const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
+const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
+const utils_js_1 = require("../utils.js");
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} NinoConfigOptions
+ * @property {ErrorMessageConfig} errorMsg Error message config
+ * @property {boolean} allowWhitespace Will permit input values that contain spaces.
+ */
 /**
  * UK National Insurance number.
  *
- * Config options:
- *   string|object errorMsg = Error message to use on validation failure
- *   boolean allowWhitespace = will permit input values that contain spaces.
- *
  * Ref:
  * https://en.wikipedia.org/wiki/National_Insurance_number#Format
  * https://design-system.service.gov.uk/patterns/national-insurance-numbers/
+ *
+ * See {@link NinoConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
  */
-const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
-const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
-const utils_js_1 = require("../utils.js");
 class Nino extends ValidatorFactory_js_1.default {
     constructor() {
         super(...arguments);

package/dist/lib/validators/postalAddressObject.d.ts

@@ -1,5 +1,72 @@
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
+/**
+ * @typedef {object} PostalAddressObjectConfigOptions
+ * @property {ErrorMessageConfig} [errorMsg] General error message for the entire address block
+ * @property {string|object} [errorMsgAddress1] Error message for address1 part
+ * @property {string|object} [errorMsgAddress2] Error message for address2 part
+ * @property {string|object} [errorMsgAddress3] Error message for address3 part
+ * @property {string|object} [errorMsgAddress4] Error message for address4 part
+ * @property {string|object} [errorMsgPostcode] Error message for postcode part
+ * @property {number} [strlenmax] Max. String length for each of the inputs appress[1-4]
+ * @property {string[]} [requiredFields] Field parts required (others become optional). One of
+ * 'address1'|'address2'|'address3'|'address4'|'postcode'
+ */
+/**
+ * Works hand in hand with the core CASA `postalAddressObject` form
+ * macro.
+ *
+ * The errors sent back from this validator are specific to each subfield. For
+ * example, if the field name being tested is "address", any errors related to
+ * the "postcode" component would be associated with "address[postcode]".
+ *
+ * See {@link PostalAddressObjectConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
+ */
 export default class PostalAddressObject extends ValidatorFactory {
     name: string;
-    validate(value: any, dataContext?: {}): object[];
+    validate(value: any, dataContext?: {}): ValidationError[];
+    sanitise(value: any): any;
 }
+export type ErrorMessageConfig = import('../../casa').ErrorMessageConfig;
+export type PostalAddressObjectConfigOptions = {
+    /**
+     * General error message for the entire address block
+     */
+    errorMsg?: import("../../casa").ErrorMessageConfig | undefined;
+    /**
+     * Error message for address1 part
+     */
+    errorMsgAddress1?: string | object | undefined;
+    /**
+     * Error message for address2 part
+     */
+    errorMsgAddress2?: string | object | undefined;
+    /**
+     * Error message for address3 part
+     */
+    errorMsgAddress3?: string | object | undefined;
+    /**
+     * Error message for address4 part
+     */
+    errorMsgAddress4?: string | object | undefined;
+    /**
+     * Error message for postcode part
+     */
+    errorMsgPostcode?: string | object | undefined;
+    /**
+     * Max. String length for each of the inputs appress[1-4]
+     */
+    strlenmax?: number | undefined;
+    /**
+     * Field parts required (others become optional). One of
+     * 'address1'|'address2'|'address3'|'address4'|'postcode'
+     */
+    requiredFields?: string[] | undefined;
+};
 import ValidatorFactory from "../ValidatorFactory.js";
+import ValidationError from "../ValidationError.js";

package/dist/lib/validators/postalAddressObject.js

@@ -4,28 +4,40 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable class-methods-use-this */
+const lodash_1 = __importDefault(require("lodash"));
+const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
+const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
+const utils_js_1 = require("../utils.js");
+const { isPlainObject } = lodash_1.default; // CommonjS
+/**
+ * @access private
+ * @typedef {import('../../casa').ErrorMessageConfig} ErrorMessageConfig
+ */
 /**
- * Works hand in hand with the core CASA `postalAddressObject` form macro.
+ * @typedef {object} PostalAddressObjectConfigOptions
+ * @property {ErrorMessageConfig} [errorMsg] General error message for the entire address block
+ * @property {string|object} [errorMsgAddress1] Error message for address1 part
+ * @property {string|object} [errorMsgAddress2] Error message for address2 part
+ * @property {string|object} [errorMsgAddress3] Error message for address3 part
+ * @property {string|object} [errorMsgAddress4] Error message for address4 part
+ * @property {string|object} [errorMsgPostcode] Error message for postcode part
+ * @property {number} [strlenmax] Max. String length for each of the inputs appress[1-4]
+ * @property {string[]} [requiredFields] Field parts required (others become optional). One of
+ * 'address1'|'address2'|'address3'|'address4'|'postcode'
+ */
+/**
+ * Works hand in hand with the core CASA `postalAddressObject` form
+ * macro.
  *
  * The errors sent back from this validator are specific to each subfield. For
  * example, if the field name being tested is "address", any errors related to
  * the "postcode" component would be associated with "address[postcode]".
  *
- * Config options:
- *   string|object errorMsg = General error message for the entire address block
- *   string|object errorMsgAddress1 = Error message for address1 part
- *   string|object errorMsgAddress2 = Error message for address2 part
- *   string|object errorMsgAddress3 = Error message for address3 part
- *   string|object errorMsgAddress4 = Error message for address4 part
- *   string|object errorMsgPostcode = Error message for postcode part
- *   int strlenmax = Max. String length for each of the inputs appress[1-4]
- *   array requiredFields = Field parts required (others become optional)
+ * See {@link PostalAddressObjectConfigOptions} for `make()` options.
+ *
+ * @memberof Validators
+ * @augments ValidatorFactory
  */
-const lodash_1 = __importDefault(require("lodash"));
-const ValidationError_js_1 = __importDefault(require("../ValidationError.js"));
-const ValidatorFactory_js_1 = __importDefault(require("../ValidatorFactory.js"));
-const utils_js_1 = require("../utils.js");
-const { isPlainObject } = lodash_1.default; // CommonjS
 class PostalAddressObject extends ValidatorFactory_js_1.default {
     constructor() {
         super(...arguments);