valgen 5.3.0 → 5.3.1

package/esm/core/context.js

@@ -19,7 +19,7 @@ export class Context {
             index: this.index,
             label: this.label,
             value,
-            ...details
+            ...details,
         });
         issue.value = value;
         const onFail = this.onFail || rule[kOptions].onFail;
@@ -34,8 +34,7 @@ export class Context {
             else
                 issue.message = String(x);
         }
-        issue.message = ('' + issue.message)
-            .replace(VARIABLE_REPLACE_PATTERN, (x, g) => {
+        issue.message = ('' + issue.message).replace(VARIABLE_REPLACE_PATTERN, (x, g) => {
             const m = OPTIONAL_VAR_PATTERN.exec(g);
             if (!m)
                 return x;

package/esm/core/validator.js

@@ -19,10 +19,10 @@ export function validator(arg0, arg1, arg2) {
         throw new TypeError('You must provide a rule function argument');
     id = id || fn.name || 'unnamed-rule';
     const name = fn.name || camelCase(id);
-    const _rule = ({
+    const _rule = {
         [name](input, options) {
             const ctx = options instanceof Context ? options : undefined;
-            const opts = (ctx ? undefined : options);
+            const opts = ctx ? undefined : options;
             const context = ctx || new Context(opts);
             let value;
             try {
@@ -36,8 +36,8 @@ export function validator(arg0, arg1, arg2) {
             if (!ctx && context.errors.length)
                 throw new ValidationError(context.errors);
             return value;
-        }
-    })[name];
+        },
+    }[name];
     _rule.id = id;
     _rule[kValidatorFn] = fn;
     _rule[kOptions] = validatorOptions || {};

package/esm/index.js

@@ -32,7 +32,7 @@ const isMACAddress = vg.isMACAddress();
 const isPort = vg.isPort();
 const isURL = vg.isURL();
 const isBase64 = vg.isBase64();
-const isBIC = vg.isBIC();
+const isSWIFT = vg.isSWIFT();
 const isCreditCard = vg.isCreditCard();
 const isIBAN = vg.isIBAN();
 const isEAN = vg.isEAN();
@@ -48,7 +48,7 @@ const isAlpha = vg.isAlpha();
 const isAlphanumeric = vg.isAlphanumeric();
 const isAscii = vg.isAscii();
 const isDecimal = vg.isDecimal();
-const isHexadecimal = vg.isHexadecimal();
+const isHex = vg.isHex();
 const toArray = vg.isArray(isAny, { coerce: true });
 const toBoolean = vg.isBoolean({ coerce: true });
 const toDate = vg.isDate({ coerce: true });
@@ -56,4 +56,4 @@ const toDateString = vg.isDateString({ coerce: true });
 const toInteger = vg.isInteger({ coerce: true });
 const toNumber = vg.isNumber({ coerce: true });
 const toString = vg.isString({ coerce: true });
-export { vg, isAny, isArray, isBigint, isBoolean, isDate, isDateString, isEmpty, isNotEmpty, isInteger, isNull, isNullish, isDefined, isUndefined, isNumber, isObject, isObjectId, isString, isUUID, isUUID1, isUUID2, isUUID3, isUUID4, isUUID5, isEmail, isMobilePhone, isIP, isIPRange, isMACAddress, isPort, isURL, isBase64, isBIC, isCreditCard, isIBAN, isEAN, isFQDN, isISSN, isBtcAddress, isETHAddress, isHexColor, isJWT, isLowercase, isUppercase, isAlpha, isAlphanumeric, isAscii, isDecimal, isHexadecimal, toArray, toBoolean, toDate, toDateString, toInteger, toNumber, toString };
+export { vg, isAny, isArray, isBigint, isBoolean, isDate, isDateString, isEmpty, isNotEmpty, isInteger, isNull, isNullish, isDefined, isUndefined, isNumber, isObject, isObjectId, isString, isUUID, isUUID1, isUUID2, isUUID3, isUUID4, isUUID5, isEmail, isMobilePhone, isIP, isIPRange, isMACAddress, isPort, isURL, isBase64, isSWIFT, isCreditCard, isIBAN, isEAN, isFQDN, isISSN, isBtcAddress, isETHAddress, isHexColor, isJWT, isLowercase, isUppercase, isAlpha, isAlphanumeric, isAscii, isDecimal, isHex, toArray, toBoolean, toDate, toDateString, toInteger, toNumber, toString, };

package/esm/rules/format-rules/is-alpha.js

@@ -0,0 +1,24 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Check if the string contains only letters (a-zA-Z).
+ * @validator isAlpha
+ */
+export function isAlpha(options) {
+    return validator('isLowercase', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isAlpha(input))
+            return input;
+        context.fail(_this, `"{{value}}" is not an alpha string`, input);
+    }, options);
+}
+/**
+ * Check if the string contains only letters and numbers.
+ * @validator isAlphanumeric
+ */
+export function isAlphanumeric(options) {
+    return validator('isAlphanumeric', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isAlphanumeric(input))
+            return input;
+        context.fail(_this, `"{{value}}" is not an alphanumeric string`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-ascii.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Check if the string contains ASCII chars only.
+ * @validator isAscii
+ */
+export function isAscii(options) {
+    return validator('isAscii', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isAscii(input))
+            return input;
+        context.fail(_this, `Value is not an ascii string`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-base64.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is a "Base64" string.
+ * @validator isBase64
+ */
+export function isBase64(options) {
+    return validator('isBase64', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isBase64(input, options))
+            return input;
+        context.fail(_this, `"{{value}}" is not a valid a Base64 string`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-btc-address.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is a BTC address.
+ * @validator isBtcAddress
+ */
+export function isBtcAddress(options) {
+    return validator('isBtcAddress', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isBtcAddress(input))
+            return input;
+        context.fail(_this, `Value is not a valid a BTC address`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-credit-card.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is a credit card number
+ * @validator isCreditCard
+ */
+export function isCreditCard(options) {
+    return validator('isCreditCard', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isCreditCard(input, options))
+            return input;
+        context.fail(_this, `"{{value}}" is not a valid Credit Card number`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-decimal.js

@@ -0,0 +1,14 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Check if the string represents a decimal number,
+ * such as `0.1`, `.3`, `1.1`, `1.00003`, `4.0` etc.
+ * @validator isDecimal
+ */
+export function isDecimal(options) {
+    return validator('isDecimal', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isDecimal(input))
+            return input;
+        context.fail(_this, `"{{value}}" is not an decimal number string`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-ean.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is an EAN (European Article Number)
+ * @validator isEAN
+ */
+export function isEAN(options) {
+    return validator('isEAN', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isEAN(input))
+            return input;
+        context.fail(_this, `"{{value}}" is not a valid EAN (European Article Number)`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-email.js

@@ -0,0 +1,70 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is a valid Email
+ * @validator isEmail
+ */
+export function isEmail(options) {
+    const emailOptions = {
+        // eslint-disable-next-line camelcase
+        allow_display_name: true,
+        // eslint-disable-next-line camelcase
+        allow_utf8_local_part: options?.utf8LocalPart,
+        // eslint-disable-next-line camelcase
+        ignore_max_length: true,
+        // eslint-disable-next-line camelcase
+        allow_ip_domain: options?.allowIpDomain,
+    };
+    return validator('isEmail', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isEmail(input, emailOptions)) {
+            if (options?.requireDisplayName) {
+                if (!validatorJS.isEmail(input, {
+                    ...emailOptions,
+                    // eslint-disable-next-line camelcase
+                    require_display_name: true,
+                })) {
+                    context.fail(_this, `Display name for the email is required. Etc. ( Name <me@tempuri.org> ) `, input);
+                    return;
+                }
+            }
+            else if (!options?.allowDisplayName &&
+                !validatorJS.isEmail(input, {
+                    ...emailOptions,
+                    // eslint-disable-next-line camelcase
+                    allow_display_name: false,
+                })) {
+                context.fail(_this, `Display name in email is not allowed`, input);
+                return;
+            }
+            if (options?.hostBlacklist &&
+                !validatorJS.isEmail(input, {
+                    ...emailOptions,
+                    // eslint-disable-next-line camelcase
+                    host_blacklist: options.hostBlacklist,
+                })) {
+                context.fail(_this, `Email "{{value}}" is in black-list`, input);
+                return;
+            }
+            if (options?.hostWhitelist &&
+                !validatorJS.isEmail(input, {
+                    ...emailOptions,
+                    // eslint-disable-next-line camelcase
+                    host_whitelist: options.hostWhitelist,
+                })) {
+                context.fail(_this, `Email "{{value}}" is in not white-list`, input);
+                return;
+            }
+            if (options?.blacklistedChars &&
+                !validatorJS.isEmail(input, {
+                    ...emailOptions,
+                    // eslint-disable-next-line camelcase
+                    blacklisted_chars: options.blacklistedChars,
+                })) {
+                context.fail(_this, `Black listed characters (${options.blacklistedChars}) found in name part`, input);
+                return;
+            }
+            return input;
+        }
+        context.fail(_this, `"{{value}}" does not match required e-mail format`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-eth-address.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is a ETH (Ethereum) address.
+ * @validator isETHAddress
+ */
+export function isETHAddress(options) {
+    return validator('isETHAddress', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isEthereumAddress(input))
+            return input;
+        context.fail(_this, `Value is not a valid a ETH (Ethereum) address`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-fqdn.js

@@ -0,0 +1,17 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is an FQDN
+ * @validator isFQDN
+ */
+export function isFQDN(options) {
+    const opts = {
+        // eslint-disable-next-line camelcase
+        allow_wildcard: options?.allowWildcard,
+    };
+    return validator('isFQDN', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isFQDN(input, opts))
+            return input;
+        context.fail(_this, `"{{value}}" is not valid FQDN`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-hash.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value a hash of type algorithm
+ * @validator isHash
+ */
+export function isHash(algorithm, options) {
+    return validator('isHash', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isHash(input, algorithm))
+            return input;
+        context.fail(_this, `Value is not a valid ${algorithm} hash`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-hex-color.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is a Hex Color
+ * @validator isHexColor
+ */
+export function isHexColor(options) {
+    return validator('isHexColor', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isHexColor(input))
+            return input;
+        context.fail(_this, `{{label}} is not a valid Hex Color`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-hex.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Check if the string is a hexadecimal number.
+ * @validator isHex
+ */
+export function isHex(options) {
+    return validator('isHex', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isHexadecimal(input))
+            return input;
+        context.fail(_this, `{{label}} is not an hexadecimal string`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-iban.js

@@ -0,0 +1,24 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is an IBAN (International Bank Account Number)
+ * @validator isIBAN
+ */
+export function isIBAN(options) {
+    return validator('isIBAN', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isIBAN(input))
+            return input;
+        context.fail(_this, `{{label}} is not a valid IBAN (International Bank Account Number)`, input);
+    }, options);
+}
+/**
+ * Validates if value is a BIC (Bank Identification Code) or SWIFT code
+ * @validator isSWIFT
+ */
+export function isSWIFT(options) {
+    return validator('isSWIFT', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isBIC(input))
+            return input;
+        context.fail(_this, `{{label}}is not a valid a BIC (Bank Identification Code) or SWIFT code`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-ip.js

@@ -0,0 +1,24 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is an IP
+ * @validator isIP
+ */
+export function isIP(version, options) {
+    return validator('isIP', function (input, context, _this) {
+        if (input != null && typeof input === 'string' && validatorJS.isIP(input, version))
+            return input;
+        context.fail(_this, `"{{value}}" is not a valid IP${version ? ' v' + version : ''}`, input);
+    }, options);
+}
+/**
+ * Validates if value is an IP
+ * @validator isIPRange
+ */
+export function isIPRange(version, options) {
+    return validator('isIPRange', function (input, context, _this) {
+        if (input != null && typeof input === 'string' && validatorJS.isIPRange(input, version))
+            return input;
+        context.fail(_this, `"{{value}}" is not a valid IP${version ? ' v' + version : ''} range`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-issn.js

@@ -0,0 +1,17 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is an ISSN
+ * @validator isISSN
+ */
+export function isISSN(options) {
+    const opts = {
+        // eslint-disable-next-line camelcase
+        case_sensitive: options?.caseSensitive,
+    };
+    return validator('isISSN', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isISSN(input, opts))
+            return input;
+        context.fail(_this, `"{{value}}" is not a valid ISSN`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-jwt.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value a valid JWT token
+ * @validator isJWT
+ */
+export function isJWT(options) {
+    return validator('isJWT', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isJWT(input))
+            return input;
+        context.fail(_this, `Value is not a valid JWT token`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-lowercase.js

@@ -0,0 +1,24 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value a Lowercase string
+ * @validator isLowercase
+ */
+export function isLowercase(options) {
+    return validator('isLowercase', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isLowercase(input))
+            return input;
+        context.fail(_this, `"{{value}}" is not a lowercase string`, input);
+    }, options);
+}
+/**
+ * Validates if value a Uppercase string
+ * @validator isUppercase
+ */
+export function isUppercase(options) {
+    return validator('isUppercase', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isUppercase(input))
+            return input;
+        context.fail(_this, `"{{value}}" is not an uppercase string`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-mac-address.js

@@ -0,0 +1,18 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is an MACAddress
+ * @validator isMACAddress
+ */
+export function isMACAddress(options) {
+    const opts = {
+        // eslint-disable-next-line camelcase
+        no_separators: options?.noSeparators,
+        eui: options?.eui,
+    };
+    return validator('isMACAddress', function (input, context, _this) {
+        if (input != null && typeof input === 'string' && validatorJS.isMACAddress(input, opts))
+            return input;
+        context.fail(_this, `{{label}} is not a valid MAC address`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-mobile-phone.js

@@ -0,0 +1,16 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is a valid Email
+ * @validator isMobilePhone
+ */
+export function isMobilePhone(options) {
+    const opts = {
+        strictMode: options?.strictMode,
+    };
+    return validator('isMobilePhone', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isMobilePhone(input, options?.locale, opts))
+            return input;
+        context.fail(_this, `"{{value}}" is not a valid a Mobile Phone Number`, input);
+    }, options);
+}

package/esm/rules/{is-object-id.js → format-rules/is-object-id.js}

@@ -1,5 +1,5 @@
 import validatorJS from 'validator';
-import { validator } from '../core/index.js';
+import { validator } from '../../core/index.js';
 /**
  * Validates if value is an "ObjectId".
  * @validator isObjectId
@@ -16,6 +16,6 @@ export function isObjectId(options) {
     }, options);
 }
 function _isObjectIdValue(input) {
-    return (input instanceof Uint8Array && input.length === 12) ||
-        (typeof input === 'string' && input.length === 24 && validatorJS.isHexadecimal(input));
+    return ((input instanceof Uint8Array && input.length === 12) ||
+        (typeof input === 'string' && input.length === 24 && validatorJS.isHexadecimal(input)));
 }

package/esm/rules/format-rules/is-passport-number.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is a passport number
+ * @validator isPassportNumber
+ */
+export function isPassportNumber(countryCode, options) {
+    return validator('isPassportNumber', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isPassportNumber(input, countryCode))
+            return input;
+        context.fail(_this, `"{{value}}" is not a valid ${countryCode} PassportNumber)`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-port.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is a port number
+ * @validator isPort
+ */
+export function isPort(options) {
+    return validator('isPort', function (input, context, _this) {
+        if (input != null && typeof input === 'string' && validatorJS.isPort(input))
+            return input;
+        context.fail(_this, `{{label}} is not a valid port number`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-url.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is an URL
+ * @validator isURL
+ */
+export function isURL(options) {
+    return validator('isURL', function (input, context, _this) {
+        if (input != null && typeof input === 'string' && validatorJS.isURL(input, options))
+            return input;
+        context.fail(_this, `{{value}} is not a valid URL`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-uuid.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is an "UUID".
+ * @validator isUUID
+ */
+export function isUUID(version, options) {
+    return validator('isUUID', function (input, context, _this) {
+        if (input != null && typeof input === 'string' && validatorJS.isUUID(input, version))
+            return input;
+        context.fail(_this, `{{label}} is not a valid UUID${version ? ' v' + version : ''}`, input);
+    }, options);
+}

package/esm/rules/format-rules/is-vat-number.js

@@ -0,0 +1,13 @@
+import * as validatorJS from 'validator';
+import { validator } from '../../core/index.js';
+/**
+ * Validates if value is an VAT number
+ * @validator isVAT
+ */
+export function isVATNumber(countryCode, options) {
+    return validator('isVATNumber', function (input, context, _this) {
+        if (typeof input === 'string' && validatorJS.isVAT(input, countryCode))
+            return input;
+        context.fail(_this, `"{{value}}" is not a valid VAT number`, input);
+    }, options);
+}

package/esm/rules/{is-regexp.js → format-rules/matches.js}

@@ -1,9 +1,9 @@
-import { validator } from '../core/index.js';
+import { validator } from '../../core/index.js';
 /**
  * Coerces given value to "UUID" format or returns undefined if nullish
  * @validator uuid
  */
-export function isRegExp(format, options) {
+export function matches(format, options) {
     const regExp = format instanceof RegExp ? format : new RegExp(format);
     const formatName = options?.formatName;
     return validator('matches', function (input, context, _this) {
@@ -11,6 +11,9 @@ export function isRegExp(format, options) {
             return;
         if (typeof input === 'string' && regExp.test(input))
             return input;
-        context.fail(_this, `{{label}} does not match ${formatName || 'requested'} format`, input, { format, formatName });
+        context.fail(_this, `"{{value}}" does not match ${formatName || 'requested'} format`, input, {
+            format,
+            formatName,
+        });
     }, options);
 }