@planning-inspectorate/dynamic-forms 3.3.3 → 3.4.0

package/types/src/validator/multi-field-input-validator.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @typedef {Object} Regex
+ * @property {String | RegExp} regex
+ * @property {String} regexMessage
+ */
+/**
+ * @typedef {Object} MinLength
+ * @property {Number} minLength
+ * @property {String} minLengthMessage
+ */
+/**
+ * @typedef {Object} MaxLength
+ * @property {Number} maxLength
+ * @property {String} maxLengthMessage
+ */
+/**
+ * @typedef {Object} Field
+ * @property {string} fieldName
+ * @property {boolean} required
+ * @property {string} errorMessage
+ * @property {MinLength} [minLength]
+ * @property {MaxLength} [maxLength]
+ * @property {Regex} [regex]
+ */
+export default class MultiFieldInputValidator extends BaseValidator {
+    /**
+     * @param {Object} params
+     * @param {Field[]} [params.fields]
+     * @param {string} [params.noInputsMessage]
+     */
+    constructor({ fields, noInputsMessage }?: {
+        fields?: Field[] | undefined;
+        noInputsMessage?: string | undefined;
+    });
+    fields: Field[];
+    noInputsMessage: string;
+    /**
+     * validates response body against question's required fields
+     */
+    validate(): import("express-validator").ValidationChain[];
+    isRequired(): boolean;
+    /**
+     * checks if a field is required
+     * @param {string} fieldName
+     * @returns {boolean}
+     */
+    inputFieldIsRequired(fieldName: string): boolean;
+}
+export type Regex = {
+    regex: string | RegExp;
+    regexMessage: string;
+};
+export type MinLength = {
+    minLength: number;
+    minLengthMessage: string;
+};
+export type MaxLength = {
+    maxLength: number;
+    maxLengthMessage: string;
+};
+export type Field = {
+    fieldName: string;
+    required: boolean;
+    errorMessage: string;
+    minLength?: MinLength | undefined;
+    maxLength?: MaxLength | undefined;
+    regex?: Regex | undefined;
+};
+import BaseValidator from './base-validator.js';
+//# sourceMappingURL=multi-field-input-validator.d.ts.map

package/types/src/validator/multi-field-input-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi-field-input-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/multi-field-input-validator.js"],"names":[],"mappings":"AAGA;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;;;GAQG;AAEH;IACC;;;;OAIG;IACH,0CAHG;QAAyB,MAAM;QACP,eAAe;KAAC,EAQ1C;IAFA,gBAAoB;IACpB,wBAAwE;IAGzE;;OAEG;IAEH,0DA8BC;IAED,sBAEC;IACD;;;;OAIG;IACH,gCAHW,MAAM,GACJ,OAAO,CAQnB;CACD;;WA3Fa,SAAS,MAAM;;;;;;;;;;;;eAkBf,MAAM;cACN,OAAO;kBACP,MAAM;;;;;0BAvBM,qBAAqB"}

package/types/src/validator/multi-field-input-validator.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=multi-field-input-validator.test.d.ts.map

package/types/src/validator/multi-field-input-validator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi-field-input-validator.test.d.ts","sourceRoot":"","sources":["../../../src/validator/multi-field-input-validator.test.js"],"names":[],"mappings":""}

package/types/src/validator/numeric-validator.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @typedef {Object} MinValue
+ * @property {Number} min
+ * @property {String} minMessage
+ */
+/**
+ * @typedef {Object} MaxValue
+ * @property {Number} max
+ * @property {String} maxMessage
+ */
+export default class NumericValidator extends BaseValidator {
+    /**
+     * @param {Object} params
+     * @param {number} [params.min]
+     * @param {string} [params.minMessage]
+     * @param {number} [params.max]
+     * @param {string} [params.maxMessage]
+     * @param {RegExp} [params.regex]
+     * @param {string} [params.regexMessage]
+     * @param {string} [params.fieldName]
+     */
+    constructor({ min, minMessage, max, maxMessage, regex, regexMessage, fieldName }?: {
+        min?: number | undefined;
+        minMessage?: string | undefined;
+        max?: number | undefined;
+        maxMessage?: string | undefined;
+        regex?: RegExp | undefined;
+        regexMessage?: string | undefined;
+        fieldName?: string | undefined;
+    });
+    min: number | undefined;
+    minMessage: string;
+    max: number | undefined;
+    maxMessage: string;
+    regex: RegExp | undefined;
+    regexMessage: string;
+    fieldName: string | undefined;
+    validate(questionObj: any): import("express-validator").ValidationChain;
+}
+export type MinValue = {
+    min: number;
+    minMessage: string;
+};
+export type MaxValue = {
+    max: number;
+    maxMessage: string;
+};
+import BaseValidator from './base-validator.js';
+//# sourceMappingURL=numeric-validator.d.ts.map

package/types/src/validator/numeric-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/numeric-validator.js"],"names":[],"mappings":"AAIA;;;;GAIG;AAEH;;;;GAIG;AAEH;IACC;;;;;;;;;OASG;IACH,mFARG;QAAwB,GAAG;QACH,UAAU;QACV,GAAG;QACH,UAAU;QACV,KAAK;QACL,YAAY;QACZ,SAAS;KAAC,EAWpC;IAPA,wBAAc;IACd,mBAAmE;IACnE,wBAAc;IACd,mBAAkE;IAClE,0BAAkB;IAClB,qBAA0D;IAC1D,8BAA0B;IAG3B,wEAgBC;CACD;;;;;;;;;0BArDyB,qBAAqB"}

package/types/src/validator/numeric-validator.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=numeric-validator.test.d.ts.map

package/types/src/validator/numeric-validator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-validator.test.d.ts","sourceRoot":"","sources":["../../../src/validator/numeric-validator.test.js"],"names":[],"mappings":""}

package/types/src/validator/required-validator.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @typedef {import('../questions/question.js')} Question
+ */
+/**
+ * enforces a field is not empty
+ * @class
+ */
+export default class RequiredValidator extends BaseValidator {
+    /**
+     * creates an instance of a RequiredValidator
+     * @param {string} [errorMessage] - custom error message to show on validation failure
+     */
+    constructor(errorMessage?: string);
+    /**
+     * validates the response body, checking the questionObj's fieldname
+     * @param {Question} questionObj
+     */
+    validate(questionObj: Question): import("express-validator").ValidationChain;
+}
+export type Question = typeof import("../questions/question.js");
+import BaseValidator from './base-validator.js';
+//# sourceMappingURL=required-validator.d.ts.map

package/types/src/validator/required-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"required-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/required-validator.js"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH;IAMC;;;OAGG;IACH,2BAFW,MAAM,EAQhB;IAED;;;OAGG;IACH,sBAFW,QAAQ,+CAIlB;CACD;;0BAnCyB,qBAAqB"}

package/types/src/validator/required-validator.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=required-validator.test.d.ts.map

package/types/src/validator/required-validator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"required-validator.test.d.ts","sourceRoot":"","sources":["../../../src/validator/required-validator.test.js"],"names":[],"mappings":""}

package/types/src/validator/same-answer-validator.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Universal validator to ensure the answer to the current question is not the same as another question's answer
+ */
+export default class SameAnswerValidator extends BaseValidator {
+    /**
+     * @param {string[]} fieldNamesToCompare - field name to compare against
+     * @param {string} [errorMessage]
+     */
+    constructor(fieldNamesToCompare: string[], errorMessage?: string);
+    fieldNamesToCompare: string[];
+    /**
+     * validates the questionToCompare and compares it to the answer in the journeyResponse
+     * @param questionObj
+     */
+    validate(questionObj: any): import("express-validator").ValidationChain;
+}
+import BaseValidator from './base-validator.js';
+//# sourceMappingURL=same-answer-validator.d.ts.map

package/types/src/validator/same-answer-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"same-answer-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/same-answer-validator.js"],"names":[],"mappings":"AAGA;;GAEG;AACH;IACC;;;OAGG;IAEH,iCAJW,MAAM,EAAE,iBACR,MAAM,EAOhB;IAFA,8BAAoD;IAIrD;;;OAGG;IACH,wEAQC;CACD;0BA9ByB,qBAAqB"}

package/types/src/validator/same-answer-validator.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=same-answer-validator.test.d.ts.map

package/types/src/validator/same-answer-validator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"same-answer-validator.test.d.ts","sourceRoot":"","sources":["../../../src/validator/same-answer-validator.test.js"],"names":[],"mappings":""}

package/types/src/validator/string-validator.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @typedef {Object} MinLength
+ * @property {Number} minLength
+ * @property {String} minLengthMessage
+ */
+/**
+ * @typedef {Object} MaxLength
+ * @property {Number} maxLength
+ * @property {String} maxLengthMessage
+ */
+/**
+ * @typedef {Object} Regex
+ * @property {String | RegExp} regex
+ * @property {String} regexMessage
+ */
+export default class StringValidator extends BaseValidator {
+    /**
+     * @param {Object} params
+     * @param {MinLength} [params.minLength]
+     * @param {MaxLength} [params.maxLength]
+     * @param {Regex} [params.regex]
+     * @param {string} [params.fieldName]
+     */
+    constructor({ minLength, maxLength, regex, fieldName }?: {
+        minLength?: MinLength | undefined;
+        maxLength?: MaxLength | undefined;
+        regex?: Regex | undefined;
+        fieldName?: string | undefined;
+    });
+    minLength: {
+        minLength: number;
+        minLengthMessage: string;
+    };
+    maxLength: {
+        maxLength: number;
+        maxLengthMessage: string;
+    };
+    regex: {
+        regex: string;
+        regexMessage: string;
+    };
+    fieldName: string | undefined;
+    validate(questionObj: any): import("express-validator").ValidationChain;
+}
+export type MinLength = {
+    minLength: number;
+    minLengthMessage: string;
+};
+export type MaxLength = {
+    maxLength: number;
+    maxLengthMessage: string;
+};
+export type Regex = {
+    regex: string | RegExp;
+    regexMessage: string;
+};
+import BaseValidator from './base-validator.js';
+//# sourceMappingURL=string-validator.d.ts.map

package/types/src/validator/string-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/string-validator.js"],"names":[],"mappings":"AAGA;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;IAcC;;;;;;OAMG;IACH,yDALG;QAA2B,SAAS;QACT,SAAS;QACb,KAAK;QACJ,SAAS;KAAC,EAmBpC;IArCD;;;MAGE;IACF;;;MAGE;IACF;;;MAGE;IAyBD,8BAA0B;IAG3B,wEAkBC;CACD;;;;;;;;;;WA/Da,SAAS,MAAM;;;0BAfH,qBAAqB"}

package/types/src/validator/string-validator.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=string-validator.test.d.ts.map

package/types/src/validator/string-validator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-validator.test.d.ts","sourceRoot":"","sources":["../../../src/validator/string-validator.test.js"],"names":[],"mappings":""}

package/types/src/validator/unit-option-entry-validator.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @typedef {import('../questions/question.js')} Question
+ */
+/**
+ * enforces a field is not empty when condition is satisfied
+ * @class
+ */
+export default class UnitOptionEntryValidator extends BaseValidator {
+    /**
+     * @param {Object} params
+     * @param {string} [params.errorMessage]
+     * @param {string} [params.unit]
+     * @param {number} [params.min]
+     * @param {number} [params.max]
+     * @param {Regex} [params.regex]
+     * @param {string} [params.regexMessage]
+     */
+    constructor({ errorMessage, unit, min, max, regex, regexMessage }?: {
+        errorMessage?: string | undefined;
+        unit?: string | undefined;
+        min?: number | undefined;
+        max?: number | undefined;
+        regex?: any;
+        regexMessage?: string | undefined;
+    });
+    unit: string;
+    min: number | undefined;
+    max: number | undefined;
+    regex: any;
+    regexMessage: string;
+    /**
+     * validates the response body, checking the questionObj's fieldname
+     * @param {Question} questionObj
+     */
+    validate(questionObj: Question): any;
+    isValueIncluded(questionObj: any, value: any): import("express-validator").ValidationChain;
+}
+export type Question = typeof import("../questions/question.js");
+import BaseValidator from './base-validator.js';
+//# sourceMappingURL=unit-option-entry-validator.d.ts.map

package/types/src/validator/unit-option-entry-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unit-option-entry-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/unit-option-entry-validator.js"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH;IACC;;;;;;;;OAQG;IAEH,oEARG;QAAwB,YAAY;QACZ,IAAI;QACJ,GAAG;QACH,GAAG;QACJ,KAAK;QACJ,YAAY;KAAC,EAWvC;IALA,aAA2B;IAC3B,wBAAc;IACd,wBAAc;IACd,WAAkB;IAClB,qBAA0D;IAG3D;;;OAGG;IACH,sBAFW,QAAQ,OA4ClB;IAED,2FAKC;CACD;;0BArFyB,qBAAqB"}

package/types/src/validator/unit-option-entry-validator.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=unit-option-entry-validator.test.d.ts.map

package/types/src/validator/unit-option-entry-validator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unit-option-entry-validator.test.d.ts","sourceRoot":"","sources":["../../../src/validator/unit-option-entry-validator.test.js"],"names":[],"mappings":""}

package/types/src/validator/valid-option-validator.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @typedef {import('../questions/options-question.js')} OptionsQuestion
+ */
+/**
+ * enforces a field is within the question's predefined list of options
+ * @class
+ */
+export default class ValidOptionValidator extends BaseValidator {
+    /**
+     * creates an instance of a RequiredValidator
+     * @param {string} [errorMessage] - custom error message to show on validation failure
+     */
+    constructor(errorMessage?: string);
+    /**
+     * validates the response body, checking the value sent for the questionObj's fieldname is within the predefined list of options
+     * @param {OptionsQuestion} questionObj
+     */
+    validate(questionObj: OptionsQuestion): import("express-validator").ValidationChain;
+}
+export type OptionsQuestion = typeof import("../questions/options-question.js");
+import BaseValidator from './base-validator.js';
+//# sourceMappingURL=valid-option-validator.d.ts.map

package/types/src/validator/valid-option-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valid-option-validator.d.ts","sourceRoot":"","sources":["../../../src/validator/valid-option-validator.js"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH;IACC;;;OAGG;IACH,2BAFW,MAAM,EAUhB;IAED;;;OAGG;IACH,sBAFW,eAAe,+CAUzB;CACD;;0BAtCyB,qBAAqB"}

package/types/src/validator/valid-option-validator.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=valid-option-validator.test.d.ts.map

package/types/src/validator/valid-option-validator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valid-option-validator.test.d.ts","sourceRoot":"","sources":["../../../src/validator/valid-option-validator.test.js"],"names":[],"mappings":""}

package/types/src/validator/validation-error-handler.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @typedef {{text: string, href: string}[]} GovUkErrorList
+ * @typedef {Object<string, import('express-validator').ValidationError>} ExpressValidationErrors
+ * @typedef {(errors: ExpressValidationErrors) => GovUkErrorList} ToErrorSummary
+ */
+/**
+ * @type {ToErrorSummary}
+ */
+export const expressValidationErrorsToGovUkErrorList: ToErrorSummary;
+export function buildValidationErrorHandler(validate?: import("express-validator").ResultFactory<import("express-validator").ValidationError>, toErrorSummary?: ToErrorSummary): any;
+export const validationErrorHandler: any;
+export type GovUkErrorList = {
+    text: string;
+    href: string;
+}[];
+export type ExpressValidationErrors = {
+    [x: string]: import("express-validator").ValidationError;
+};
+export type ToErrorSummary = (errors: ExpressValidationErrors) => GovUkErrorList;
+//# sourceMappingURL=validation-error-handler.d.ts.map

package/types/src/validator/validation-error-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-error-handler.d.ts","sourceRoot":"","sources":["../../../src/validator/validation-error-handler.js"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH;;GAEG;AACH,sDAFU,cAAc,CAkBtB;AAQK,uDAJI,OAAO,mBAAmB,EAAE,aAAa,CAAC,OAAO,mBAAmB,EAAE,eAAe,CAAC,mBACtF,cAAc,OA4BxB;AAED,yCAAoE;6BA3DvD;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,EAAE;;;;6BAE9B,CAAC,MAAM,EAAE,uBAAuB,KAAK,cAAc"}

package/types/src/validator/validation-error-handler.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=validation-error-handler.test.d.ts.map

package/types/src/validator/validation-error-handler.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-error-handler.test.d.ts","sourceRoot":"","sources":["../../../src/validator/validation-error-handler.test.js"],"names":[],"mappings":""}

package/types/src/validator/validator.d.ts

@@ -0,0 +1,5 @@
+export function buildValidateBody(questions: any): (req: any, res: any, next: any) => Promise<any>;
+export default validate;
+/** @type {import('express').Handler} */
+declare const validate: any;
+//# sourceMappingURL=validator.d.ts.map

package/types/src/validator/validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../../src/validator/validator.js"],"names":[],"mappings":"AA4BA,oDACe,QAAG,EAAE,QAAG,EAAE,SAAI,kBAM5B;;AAjCD,wCAAwC;AACxC,4BAqBE"}

package/types/src/validator/validator.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=validator.test.d.ts.map

package/types/src/validator/validator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.test.d.ts","sourceRoot":"","sources":["../../../src/validator/validator.test.js"],"names":[],"mappings":""}

package/types/test/mock/journey.d.ts

@@ -0,0 +1,3 @@
+export function mockJourney(): Journey;
+import { Journey } from '#src/journey/journey.js';
+//# sourceMappingURL=journey.d.ts.map

package/types/test/mock/journey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"journey.d.ts","sourceRoot":"","sources":["../../../test/mock/journey.js"],"names":[],"mappings":"AAEA,uCAcC;wBAhBuB,yBAAyB"}

package/types/test/mock/uuid.d.ts

@@ -0,0 +1,7 @@
+/**
+ *
+ * @param {import('node:test').TestContext} ctx
+ * @param {string} [uuid]
+ */
+export function mockRandomUUID(ctx: import("node:test").TestContext, uuid?: string): void;
+//# sourceMappingURL=uuid.d.ts.map

package/types/test/mock/uuid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../../test/mock/uuid.js"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,oCAHW,OAAO,WAAW,EAAE,WAAW,SAC/B,MAAM,QAOhB"}

package/types/test/utils/nunjucks.d.ts

@@ -0,0 +1,2 @@
+export function configureNunjucksTestEnv(): any;
+//# sourceMappingURL=nunjucks.d.ts.map

package/types/test/utils/nunjucks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nunjucks.d.ts","sourceRoot":"","sources":["../../../test/utils/nunjucks.js"],"names":[],"mappings":"AAKA,gDAcC"}

package/types/test/utils/utils.d.ts

@@ -0,0 +1,32 @@
+export function testDir(): string;
+export function snapshotsDir(): string;
+/**
+ * @param {import('node:test').TestContext} ctx
+ * @param {string} content
+ * @param {string} name
+ */
+export function assertSnapshot(ctx: import("node:test").TestContext, content: string, name: string): void;
+/**
+ * @returns {import('pino').BaseLogger}
+ */
+export function mockLogger(): any;
+/**
+ * escapes all RegExp meta-characters in a string
+ * @param {string} s
+ * @returns {string}
+ */
+export function escapeForRegExp(s: string): string;
+export function mockReq(): {
+    log: any;
+    params: {};
+    body: {};
+    originalUrl: string;
+};
+export function mockRes(): {
+    locals: {};
+    redirect: import("node:test").Mock<(...args: any[]) => undefined>;
+    status: import("node:test").Mock<(...args: any[]) => undefined>;
+    render: import("node:test").Mock<(...args: any[]) => undefined>;
+    send: import("node:test").Mock<(...args: any[]) => undefined>;
+};
+//# sourceMappingURL=utils.d.ts.map

package/types/test/utils/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../test/utils/utils.js"],"names":[],"mappings":"AAGA,kCAEC;AAED,uCAEC;AAED;;;;GAIG;AACH,oCAJW,OAAO,WAAW,EAAE,WAAW,WAC/B,MAAM,QACN,MAAM,QAUhB;AAED;;GAEG;AACH,kCAWC;AAsBD;;;;GAIG;AACH,mCAHW,MAAM,GACJ,MAAM,CAIlB;AA3BM;;;;;EAKL;AACK;;;;;;EAYN"}

package/src/lib/address.d.ts

@@ -1,7 +0,0 @@
-export interface Address {
-	addressLine1?: string;
-	addressLine2?: string;
-	townCity?: string;
-	county?: string;
-	postcode?: string;
-}