@depup/express-validator 7.3.1-depup.1

package/lib/chain/validators.d.ts

@@ -0,0 +1,181 @@
+import { CustomValidator, ErrorMessage, FieldMessageFactory } from '../base';
+import * as Options from '../options';
+export type ExistsOptions = {
+    /**
+     * Defines which kind of value makes a field _NOT_ exist.
+     *
+     * - `undefined`: only `undefined` values; equivalent to `value !== undefined`
+     * - `null`: only `undefined` and `null` values; equivalent to `value != null`
+     * - `falsy`: all falsy values; equivalent to `!!value`
+     *
+     * @default 'undefined'
+     */
+    values?: 'undefined' | 'null' | 'falsy';
+    /**
+     * Whether a field whose value is falsy should be considered non-existent.
+     * @default false
+     * @deprecated  Use `values` instead
+     */
+    checkFalsy?: boolean;
+    /**
+     * Whether a field whose value is `null` or `undefined` should be considered non-existent.
+     * @default false
+     * @deprecated  Use `values` instead
+     */
+    checkNull?: boolean;
+};
+export interface Validators<Return> {
+    /**
+     * Negates the result of the next validator.
+     *
+     * @example check('weekday').not().isIn(['sunday', 'saturday'])
+     * @returns the current validation chain
+     */
+    not(): Return;
+    /**
+     * Sets the error message for the previous validator.
+     *
+     * @param message the message, which can be any value, or a function for dynamically creating the
+     *                error message based on the field value
+     * @returns the current validation chain
+     */
+    withMessage(message: FieldMessageFactory | ErrorMessage): Return;
+    /**
+     * Adds a custom validator to the validation chain.
+     *
+     * @param validator the custom validator
+     * @returns the current validation chain
+     */
+    custom(validator: CustomValidator): Return;
+    /**
+     * Adds a validator to check that the fields exist in the request.
+     * By default, this means that the value of the fields may not be `undefined`;
+     * all other values are acceptable.
+     *
+     * @param options
+     * @returns the current validation chain
+     */
+    exists(options?: ExistsOptions): Return;
+    /**
+     * Adds a validator to check if a value is an array.
+     *
+     * @param options
+     * @returns the current validation chain
+     */
+    isArray(options?: {
+        min?: number;
+        max?: number;
+    }): Return;
+    /**
+     * Adds a validator to check if a value is an object.
+     *
+     * @param options
+     * @returns the current validation chain
+     */
+    isObject(options?: {
+        strict?: boolean;
+    }): Return;
+    /**
+     * Adds a validator to check if a value is a string.
+     *
+     * @returns the current validation chain
+     */
+    isString(): Return;
+    /**
+     * Adds a validator to check if a value is not empty; that is, a string with length of 1 or more.
+     *
+     * @param options
+     * @returns the current validation chain
+     */
+    notEmpty(options?: Options.IsEmptyOptions): Return;
+    contains(elem: any, options?: Options.ContainsOptions): Return;
+    equals(comparison: string): Return;
+    isAbaRouting(): Return;
+    isAfter(dateOrOptions?: string | Options.IsAfterOptions): Return;
+    isAlpha(locale?: Options.AlphaLocale, options?: Options.IsAlphaOptions): Return;
+    isAlphanumeric(locale?: Options.AlphanumericLocale, options?: Options.IsAlphanumericOptions): Return;
+    isAscii(): Return;
+    isBase32(options?: Options.IsBase32Options): Return;
+    isBase58(): Return;
+    isBase64(options?: Options.IsBase64Options): Return;
+    isBefore(date?: string): Return;
+    isBIC(): Return;
+    isBoolean(options?: Options.IsBooleanOptions): Return;
+    isBtcAddress(): Return;
+    isByteLength(options: Options.MinMaxExtendedOptions): Return;
+    isCreditCard(options?: Options.IsCreditCard): Return;
+    isCurrency(options?: Options.IsCurrencyOptions): Return;
+    isDataURI(): Return;
+    isDate(options?: Options.IsDateOptions): Return;
+    isDecimal(options?: Options.IsDecimalOptions): Return;
+    isDivisibleBy(number: number): Return;
+    isEAN(): Return;
+    isEmail(options?: Options.IsEmailOptions): Return;
+    isEmpty(options?: Options.IsEmptyOptions): Return;
+    isEthereumAddress(): Return;
+    isFQDN(options?: Options.IsFQDNOptions): Return;
+    isFloat(options?: Options.IsFloatOptions): Return;
+    isFreightContainerID(): Return;
+    isFullWidth(): Return;
+    isHalfWidth(): Return;
+    isHash(algorithm: Options.HashAlgorithm): Return;
+    isHexColor(): Return;
+    isHexadecimal(): Return;
+    isHSL(): Return;
+    isIBAN(options?: Options.IsIBANOptions): Return;
+    isIdentityCard(locale?: Options.IdentityCardLocale): Return;
+    isIMEI(options?: Options.IsIMEIOptions): Return;
+    isIP(version?: Options.IPVersion): Return;
+    isIPRange(version?: Options.IPVersion): Return;
+    isISBN(versionOrOptions?: number | Options.IsISBNOptions): Return;
+    isISSN(options?: Options.IsISSNOptions): Return;
+    isISIN(): Return;
+    isISO6346(): Return;
+    isISO6391(): Return;
+    isISO8601(options?: Options.IsISO8601Options): Return;
+    isISO31661Numeric(): Return;
+    isISO31661Alpha2(): Return;
+    isISO31661Alpha3(): Return;
+    isISO4217(): Return;
+    isISO15924(): Return;
+    isISRC(): Return;
+    isIn(values: readonly any[]): Return;
+    isInt(options?: Options.IsIntOptions): Return;
+    isJSON(options?: Options.IsJSONOptions): Return;
+    isJWT(): Return;
+    isLatLong(options?: Options.IsLatLongOptions): Return;
+    isLength(options: Options.MinMaxOptions): Return;
+    isLicensePlate(locale: Options.IsLicensePlateLocale): Return;
+    isLocale(): Return;
+    isLowercase(): Return;
+    isLuhnNumber(): Return;
+    isMagnetURI(): Return;
+    isMailtoURI(options?: Options.IsEmailOptions): Return;
+    isMACAddress(options?: Options.IsMACAddressOptions): Return;
+    isMD5(): Return;
+    isMimeType(): Return;
+    isMobilePhone(locale: Options.MobilePhoneLocale | readonly Options.MobilePhoneLocale[], options?: Options.IsMobilePhoneOptions): Return;
+    isMongoId(): Return;
+    isMultibyte(): Return;
+    isNumeric(options?: Options.IsNumericOptions): Return;
+    isOctal(): Return;
+    isPassportNumber(countryCode?: Options.PassportCountryCode): Return;
+    isPort(): Return;
+    isPostalCode(locale: Options.PostalCodeLocale): Return;
+    isRgbColor(includePercentValues?: boolean): Return;
+    isRFC3339(): Return;
+    isSemVer(): Return;
+    isSlug(): Return;
+    isStrongPassword(options?: Options.IsStrongPasswordOptions): Return;
+    isSurrogatePair(): Return;
+    isTaxID(locale: Options.TaxIDLocale): Return;
+    isTime(options: Options.IsTimeOptions): Return;
+    isURL(options?: Options.IsURLOptions): Return;
+    isULID(): Return;
+    isUUID(version?: Options.UUIDVersion): Return;
+    isUppercase(): Return;
+    isVariableWidth(): Return;
+    isVAT(countryCode: Options.VATCountryCode): Return;
+    isWhitelisted(chars: string | readonly string[]): Return;
+    matches(pattern: RegExp | string, modifiers?: string): Return;
+}

package/lib/chain/validators.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/context-builder.d.ts

@@ -0,0 +1,20 @@
+import { ContextItem } from './context-items';
+import { Context, Optional } from './context';
+import { Location } from './base';
+export declare class ContextBuilder {
+    private readonly stack;
+    private fields;
+    private locations;
+    private message;
+    private optional;
+    private requestBail;
+    private visibility;
+    setFields(fields: string[]): this;
+    setLocations(locations: Location[]): this;
+    setMessage(message: any): this;
+    addItem(...items: ContextItem[]): this;
+    setOptional(options: Optional): this;
+    setRequestBail(): this;
+    setHidden(hidden: boolean, hiddenValue?: string): this;
+    build(): Context;
+}

package/lib/context-builder.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextBuilder = void 0;
+const context_1 = require("./context");
+class ContextBuilder {
+    constructor() {
+        this.stack = [];
+        this.fields = [];
+        this.locations = [];
+        this.optional = false;
+        this.requestBail = false;
+        this.visibility = { type: 'visible' };
+    }
+    setFields(fields) {
+        this.fields = fields;
+        return this;
+    }
+    setLocations(locations) {
+        this.locations = locations;
+        return this;
+    }
+    setMessage(message) {
+        this.message = message;
+        return this;
+    }
+    addItem(...items) {
+        this.stack.push(...items);
+        return this;
+    }
+    setOptional(options) {
+        this.optional = options;
+        return this;
+    }
+    setRequestBail() {
+        this.requestBail = true;
+        return this;
+    }
+    setHidden(hidden, hiddenValue) {
+        if (hidden) {
+            this.visibility =
+                hiddenValue !== undefined ? { type: 'redacted', value: hiddenValue } : { type: 'hidden' };
+        }
+        else {
+            this.visibility = { type: 'visible' };
+        }
+        return this;
+    }
+    build() {
+        return new context_1.Context(this.fields, this.locations, this.stack, this.optional, this.requestBail, this.visibility, this.message);
+    }
+}
+exports.ContextBuilder = ContextBuilder;

package/lib/context-items/bail.d.ts

@@ -0,0 +1,5 @@
+import { Context } from '../context';
+import { ContextItem } from './context-item';
+export declare class Bail implements ContextItem {
+    run(context: Context): Promise<void>;
+}

package/lib/context-items/bail.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Bail = void 0;
+const base_1 = require("../base");
+class Bail {
+    run(context) {
+        if (context.errors.length > 0) {
+            throw new base_1.ValidationHalt();
+        }
+        return Promise.resolve();
+    }
+}
+exports.Bail = Bail;

package/lib/context-items/chain-condition.d.ts

@@ -0,0 +1,9 @@
+import { Meta } from '../base';
+import { ContextRunner } from '../chain';
+import { Context } from '../context';
+import { ContextItem } from './context-item';
+export declare class ChainCondition implements ContextItem {
+    private readonly chain;
+    constructor(chain: ContextRunner);
+    run(_context: Context, _value: any, meta: Meta): Promise<void>;
+}

package/lib/context-items/chain-condition.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChainCondition = void 0;
+const base_1 = require("../base");
+class ChainCondition {
+    constructor(chain) {
+        this.chain = chain;
+    }
+    async run(_context, _value, meta) {
+        const result = await this.chain.run(meta.req, { dryRun: true });
+        if (!result.isEmpty()) {
+            throw new base_1.ValidationHalt();
+        }
+    }
+}
+exports.ChainCondition = ChainCondition;

package/lib/context-items/context-item.d.ts

@@ -0,0 +1,5 @@
+import { Meta } from '../base';
+import { Context } from '../context';
+export interface ContextItem {
+    run(context: Context, value: any, meta: Meta): Promise<void>;
+}

package/lib/context-items/context-item.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/context-items/custom-condition.d.ts

@@ -0,0 +1,8 @@
+import { CustomValidator, Meta } from '../base';
+import { Context } from '../context';
+import { ContextItem } from './context-item';
+export declare class CustomCondition implements ContextItem {
+    private readonly condition;
+    constructor(condition: CustomValidator);
+    run(_context: Context, value: any, meta: Meta): Promise<void>;
+}

package/lib/context-items/custom-condition.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomCondition = void 0;
+const base_1 = require("../base");
+class CustomCondition {
+    constructor(condition) {
+        this.condition = condition;
+    }
+    async run(_context, value, meta) {
+        try {
+            const result = this.condition(value, meta);
+            await result;
+            // if the promise resolved or the result is truthy somehow, then there's no validation halt.
+            if (!result) {
+                // the error thrown here is symbolic, it will be re-thrown in the catch clause anyway.
+                throw new Error();
+            }
+        }
+        catch (e) {
+            throw new base_1.ValidationHalt();
+        }
+    }
+}
+exports.CustomCondition = CustomCondition;

package/lib/context-items/custom-validation.d.ts

@@ -0,0 +1,10 @@
+import { CustomValidator, Meta } from '../base';
+import { Context } from '../context';
+import { ContextItem } from './context-item';
+export declare class CustomValidation implements ContextItem {
+    private readonly validator;
+    private readonly negated;
+    message: any;
+    constructor(validator: CustomValidator, negated: boolean);
+    run(context: Context, value: any, meta: Meta): Promise<void>;
+}

package/lib/context-items/custom-validation.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomValidation = void 0;
+class CustomValidation {
+    constructor(validator, negated) {
+        this.validator = validator;
+        this.negated = negated;
+    }
+    async run(context, value, meta) {
+        try {
+            const result = this.validator(value, meta);
+            const actualResult = await result;
+            const isPromise = result?.then;
+            const failed = this.negated ? actualResult : !actualResult;
+            // A promise that was resolved only adds an error if negated.
+            // Otherwise it always succeeds
+            if ((!isPromise && failed) || (isPromise && this.negated)) {
+                context.addError({ type: 'field', message: this.message, value, meta });
+            }
+        }
+        catch (err) {
+            if (this.negated) {
+                return;
+            }
+            context.addError({
+                type: 'field',
+                message: this.message || (err instanceof Error ? err.message : err),
+                value,
+                meta,
+            });
+        }
+    }
+}
+exports.CustomValidation = CustomValidation;

package/lib/context-items/index.d.ts

@@ -0,0 +1,5 @@
+export * from './chain-condition';
+export * from './context-item';
+export * from './custom-condition';
+export * from './custom-validation';
+export * from './standard-validation';

package/lib/context-items/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./chain-condition"), exports);
+__exportStar(require("./context-item"), exports);
+__exportStar(require("./custom-condition"), exports);
+__exportStar(require("./custom-validation"), exports);
+__exportStar(require("./standard-validation"), exports);

package/lib/context-items/sanitization.d.ts

@@ -0,0 +1,12 @@
+import { Context } from '../context';
+import { CustomSanitizer, Meta, StandardSanitizer } from '../base';
+import { toString as toStringImpl } from '../utils';
+import { ContextItem } from './context-item';
+export declare class Sanitization implements ContextItem {
+    private readonly sanitizer;
+    private readonly custom;
+    private readonly options;
+    private readonly stringify;
+    constructor(sanitizer: StandardSanitizer | CustomSanitizer, custom: boolean, options?: any[], stringify?: typeof toStringImpl);
+    run(context: Context, value: any, meta: Meta): Promise<void>;
+}

package/lib/context-items/sanitization.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sanitization = void 0;
+const utils_1 = require("../utils");
+class Sanitization {
+    constructor(sanitizer, custom, options = [], 
+    // For testing only.
+    // Deliberately not calling it `toString` in order to not override `Object.prototype.toString`.
+    stringify = utils_1.toString) {
+        this.sanitizer = sanitizer;
+        this.custom = custom;
+        this.options = options;
+        this.stringify = stringify;
+    }
+    async run(context, value, meta) {
+        const { path, location } = meta;
+        const runCustomSanitizer = async () => {
+            const sanitizerValue = this.sanitizer(value, meta);
+            return Promise.resolve(sanitizerValue);
+        };
+        if (this.custom) {
+            const newValue = await runCustomSanitizer();
+            context.setData(path, newValue, location);
+            return;
+        }
+        const values = Array.isArray(value) ? value : [value];
+        const newValues = values.map(value => {
+            return this.sanitizer(this.stringify(value), ...this.options);
+        });
+        // We get only the first value of the array if the original value was wrapped.
+        context.setData(path, values !== value ? newValues[0] : newValues, location);
+    }
+}
+exports.Sanitization = Sanitization;

package/lib/context-items/standard-validation.d.ts

@@ -0,0 +1,13 @@
+import { Meta, StandardValidator } from '../base';
+import { toString as toStringImpl } from '../utils';
+import { Context } from '../context';
+import { ContextItem } from './context-item';
+export declare class StandardValidation implements ContextItem {
+    private readonly validator;
+    private readonly negated;
+    private readonly options;
+    private readonly stringify;
+    message: any;
+    constructor(validator: StandardValidator, negated: boolean, options?: any[], stringify?: typeof toStringImpl);
+    run(context: Context, value: any, meta: Meta): Promise<void>;
+}

package/lib/context-items/standard-validation.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StandardValidation = void 0;
+const utils_1 = require("../utils");
+class StandardValidation {
+    constructor(validator, negated, options = [], 
+    // For testing only.
+    // Deliberately not calling it `toString` in order to not override `Object.prototype.toString`.
+    stringify = utils_1.toString) {
+        this.validator = validator;
+        this.negated = negated;
+        this.options = options;
+        this.stringify = stringify;
+    }
+    async run(context, value, meta) {
+        const values = Array.isArray(value) ? value : [value];
+        values.forEach(value => {
+            const result = this.validator(this.stringify(value), ...this.options);
+            if (this.negated ? result : !result) {
+                context.addError({ type: 'field', message: this.message, value, meta });
+            }
+        });
+    }
+}
+exports.StandardValidation = StandardValidation;

package/lib/context.d.ts

@@ -0,0 +1,61 @@
+import { FieldInstance, FieldValidationError, Location, Meta, Request, UnknownFieldInstance, ValidationError } from './base';
+import { ContextItem } from './context-items';
+/**
+ * Defines which kind of value makes a field optional.
+ *
+ * - `undefined`: only `undefined` values; equivalent to `value === undefined`
+ * - `null`: only `undefined` and `null` values; equivalent to `value == null`
+ * - `falsy`: all falsy values; equivalent to `!value`
+ * - `false`: not optional.
+ */
+export type Optional = 'undefined' | 'null' | 'falsy' | false;
+export type AddErrorOptions = {
+    type: 'field';
+    message?: any;
+    value: any;
+    meta: Meta;
+} | {
+    type: 'unknown_fields';
+    req: Request;
+    message?: any;
+    fields: UnknownFieldInstance[];
+} | {
+    type: 'alternative';
+    req: Request;
+    message?: any;
+    nestedErrors: FieldValidationError[];
+} | {
+    type: 'alternative_grouped';
+    req: Request;
+    message?: any;
+    nestedErrors: FieldValidationError[][];
+};
+export type ValueVisibility = {
+    type: 'visible';
+} | {
+    type: 'hidden';
+} | {
+    type: 'redacted';
+    value: string;
+};
+export declare class Context {
+    readonly fields: string[];
+    readonly locations: Location[];
+    readonly stack: ReadonlyArray<ContextItem>;
+    readonly optional: Optional;
+    readonly bail: boolean;
+    readonly visibility: ValueVisibility;
+    readonly message?: any | undefined;
+    private readonly _errors;
+    get errors(): ReadonlyArray<ValidationError>;
+    private readonly dataMap;
+    constructor(fields: string[], locations: Location[], stack: ReadonlyArray<ContextItem>, optional: Optional, bail: boolean, visibility?: ValueVisibility, message?: any | undefined);
+    getData(options?: {
+        requiredOnly: boolean;
+    }): FieldInstance[];
+    addFieldInstances(instances: FieldInstance[]): void;
+    setData(path: string, value: any, location: Location): void;
+    addError(opts: AddErrorOptions): void;
+    private updateVisibility;
+}
+export type ReadonlyContext = Pick<Context, Exclude<keyof Context, 'setData' | 'addFieldInstances' | 'addError'>>;