Merge remote-tracking branch 'main/master' into sgress454/update-is-url-docs

sgress454 · sgress454 · commit c84f6b990533 · 2025-04-11T11:55:07.000-05:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -6,25 +6,24 @@ on:
     branches: [master]
 jobs:
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20, 18, 16, 14, 12, 10, 8, 6]
+        node-version: [22, 20, 18, 16, 14, 12, 10, 8, 6]
     name: Run tests on Node.js ${{ matrix.node-version }}
     steps:
     - name: Setup Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2-beta
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
-        check-latest: true
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
     - name: Install dependencies
-      run:  npm install --legacy-peer-deps
+      run: npm install --legacy-peer-deps
     - name: Run tests
       run: npm test
-    - if: matrix.node-version == 20
+    - if: matrix.node-version == 22
       name: Send coverage info to Codecov
-      uses: codecov/codecov-action@v1
+      uses: codecov/codecov-action@v5
       with:
-        file: ./coverage/cobertura-coverage.xml
+        token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -38,11 +38,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -53,7 +53,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -67,4 +67,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -4,21 +4,20 @@ on:
     types: [created]
 jobs:
   publish:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     permissions:
       contents: read
       id-token: write
     steps:
-    - name: Setup Node.js 18
-      uses: actions/setup-node@v3
+    - name: Setup Node.js 22
+      uses: actions/setup-node@v4
       with:
-        node-version: 18
-        check-latest: true
+        node-version: 22
         registry-url: https://registry.npmjs.org/
     - name: Checkout Repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Install Dependencies
-      run: npm install
+      run: npm install --legacy-peer-deps
     - name: Run Tests
       run: npm test
     - name: Publish Package to NPM Registry
diff --git a/README.md b/README.md
@@ -157,7 +157,7 @@ Validator                               | Description
 **isOctal(str)**                        | check if the string is a valid octal number.
 **isPassportNumber(str, countryCode)**    | check if the string is a valid passport number.<br/><br/>`countryCode` is one of `['AM', 'AR', 'AT', 'AU', 'AZ', 'BE', 'BG', 'BY', 'BR', 'CA', 'CH', 'CN', 'CY', 'CZ', 'DE', 'DK', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'IE', 'IN', 'IR', 'ID', 'IS', 'IT', 'JM', 'JP', 'KR', 'KZ', 'LI', 'LT', 'LU', 'LV', 'LY', 'MT', 'MX', 'MY', 'MZ', 'NL', 'NZ', 'PH', 'PK', 'PL', 'PT', 'RO', 'RU', 'SE', 'SL', 'SK', 'TH', 'TR', 'UA', 'US', 'ZA']`.  Locale list is `validator.passportNumberLocales`.
 **isPort(str)**                         | check if the string is a valid port number.
-**isPostalCode(str, locale)**           | check if the string is a postal code.<br/><br/>`locale` is one of `['AD', 'AT', 'AU', 'AZ', 'BA', 'BE', 'BG', 'BR', 'BY', 'CA', 'CH', 'CN', 'CO', 'CZ', 'DE', 'DK', 'DO', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IN', 'IR', 'IS', 'IT', 'JP', 'KE', 'KR', 'LI', 'LK', 'LT', 'LU', 'LV', 'MG', 'MT', 'MX', 'MY', 'NL', 'NO', 'NP', 'NZ', 'PL', 'PR', 'PT', 'RO', 'RU', 'SA', 'SE', 'SG', 'SI', 'SK', 'TH', 'TN', 'TW', 'UA', 'US', 'ZA', 'ZM']` OR `'any'`. If 'any' is used, function will check if any of the locales match. Locale list is `validator.isPostalCodeLocales`.
+**isPostalCode(str, locale)**           | check if the string is a postal code.<br/><br/>`locale` is one of `['AD', 'AT', 'AU', 'AZ', 'BA', 'BE', 'BG', 'BR', 'BY', 'CA', 'CH', 'CN', 'CO', 'CZ', 'DE', 'DK', 'DO', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IN', 'IR', 'IS', 'IT', 'JP', 'KE', 'KR', 'LI', 'LK', 'LT', 'LU', 'LV', 'MG', 'MT', 'MX', 'MY', 'NL', 'NO', 'NP', 'NZ', 'PK', 'PL', 'PR', 'PT', 'RO', 'RU', 'SA', 'SE', 'SG', 'SI', 'SK', 'TH', 'TN', 'TW', 'UA', 'US', 'ZA', 'ZM']` OR `'any'`. If 'any' is used, function will check if any of the locales match. Locale list is `validator.isPostalCodeLocales`.
 **isRFC3339(str)**                      | check if the string is a valid [RFC 3339][RFC 3339] date.
 **isRgbColor(str [,options])**                     | check if the string is a rgb or rgba color.<br/></br>`options` is an object with the following properties<br/><br/>`includePercentValues` defaults to `true`. If you don't want to allow to set `rgb` or `rgba` values with percents, like `rgb(5%,5%,5%)`, or `rgba(90%,90%,90%,.3)`, then set it to false.<br/><br/>`allowSpaces` defaults to `true`, which prohibits whitespace. If set to false, whitespace between color values is allowed, such as `rgb(255, 255, 255)` or even `rgba(255,       128,        0,      0.7)`.
 **isSemVer(str)**                       | check if the string is a Semantic Versioning Specification (SemVer).
diff --git a/src/lib/isBoolean.js b/src/lib/isBoolean.js
@@ -1,4 +1,5 @@
 import assertString from './util/assertString';
+import includes from './util/includesArray';
 
 const defaultOptions = { loose: false };
 const strictBooleans = ['true', 'false', '1', '0'];
@@ -8,8 +9,8 @@ export default function isBoolean(str, options = defaultOptions) {
   assertString(str);
 
   if (options.loose) {
-    return looseBooleans.includes(str.toLowerCase());
+    return includes(looseBooleans, str.toLowerCase());
   }
 
-  return strictBooleans.includes(str);
+  return includes(strictBooleans, str);
 }
diff --git a/src/lib/isDecimal.js b/src/lib/isDecimal.js
@@ -1,6 +1,6 @@
 import merge from './util/merge';
 import assertString from './util/assertString';
-import includes from './util/includes';
+import includes from './util/includesArray';
 import { decimal } from './alpha';
 
 function decimalRegExp(options) {
diff --git a/src/lib/isIBAN.js b/src/lib/isIBAN.js
@@ -1,4 +1,5 @@
 import assertString from './util/assertString';
+import includes from './util/includesArray';
 
 /**
  * List of country codes with
@@ -131,15 +132,15 @@ function hasValidIbanFormat(str, options) {
       return false;
     }
 
-    const isoCountryCodeInWhiteList = options.whitelist.includes(isoCountryCode);
+    const isoCountryCodeInWhiteList = includes(options.whitelist, isoCountryCode);
 
     if (!isoCountryCodeInWhiteList) {
       return false;
     }
   }
 
   if (options.blacklist) {
-    const isoCountryCodeInBlackList = options.blacklist.includes(isoCountryCode);
+    const isoCountryCodeInBlackList = includes(options.blacklist, isoCountryCode);
 
     if (isoCountryCodeInBlackList) {
       return false;
diff --git a/src/lib/isIdentityCard.js b/src/lib/isIdentityCard.js
@@ -1,4 +1,5 @@
 import assertString from './util/assertString';
+import includes from './util/includesArray';
 import isInt from './isInt';
 
 const validators = {
@@ -277,7 +278,7 @@ const validators = {
 
     const parityBit = ['1', '0', 'X', '9', '8', '7', '6', '5', '4', '3', '2'];
 
-    const checkAddressCode = addressCode => provincesAndCities.includes(addressCode);
+    const checkAddressCode = addressCode => includes(provincesAndCities, addressCode);
 
     const checkBirthDayCode = (birDayCode) => {
       const yyyy = parseInt(birDayCode.substring(0, 4), 10);
diff --git a/src/lib/isJSON.js b/src/lib/isJSON.js
@@ -1,4 +1,5 @@
 import assertString from './util/assertString';
+import includes from './util/includesArray';
 import merge from './util/merge';
 
 const default_json_options = {
@@ -15,7 +16,7 @@ export default function isJSON(str, options) {
     }
 
     const obj = JSON.parse(str);
-    return primitives.includes(obj) || (!!obj && typeof obj === 'object');
+    return includes(primitives, obj) || (!!obj && typeof obj === 'object');
   } catch (e) { /* ignore */ }
   return false;
 }
diff --git a/src/lib/isLatLong.js b/src/lib/isLatLong.js
@@ -1,5 +1,6 @@
 import assertString from './util/assertString';
 import merge from './util/merge';
+import includes from './util/includesString';
 
 const lat = /^\(?[+-]?(90(\.0+)?|[1-8]?\d(\.\d+)?)$/;
 const long = /^\s?[+-]?(180(\.0+)?|1[0-7]\d(\.\d+)?|\d{1,2}(\.\d+)?)\)?$/;
@@ -15,7 +16,7 @@ export default function isLatLong(str, options) {
   assertString(str);
   options = merge(options, defaultLatLongOptions);
 
-  if (!str.includes(',')) return false;
+  if (!includes(str, ',')) return false;
   const pair = str.split(',');
   if ((pair[0].startsWith('(') && !pair[1].endsWith(')'))
     || (pair[1].endsWith(')') && !pair[0].startsWith('('))) return false;
diff --git a/src/lib/isPassportNumber.js b/src/lib/isPassportNumber.js
@@ -65,7 +65,7 @@ const passportRegexByCountryCode = {
   TH: /^[A-Z]{1,2}\d{6,7}$/, // THAILAND
   TR: /^[A-Z]\d{8}$/, // TURKEY
   UA: /^[A-Z]{2}\d{6}$/, // UKRAINE
-  US: /^\d{9}$/, // UNITED STATES
+  US: /^\d{9}$|^[A-Z]\d{8}$/, // UNITED STATES
   ZA: /^[TAMD]\d{8}$/, // SOUTH AFRICA
 };
 
diff --git a/src/lib/isPostalCode.js b/src/lib/isPostalCode.js
@@ -57,6 +57,8 @@ const patterns = {
   NO: fourDigit,
   NP: /^(10|21|22|32|33|34|44|45|56|57)\d{3}$|^(977)$/i,
   NZ: fourDigit,
+  // https://www.pakpost.gov.pk/postcodes.php
+  PK: fiveDigit,
   PL: /^\d{2}\-\d{3}$/,
   PR: /^00[679]\d{2}([ -]\d{4})?$/,
   PT: /^\d{4}\-\d{3}?$/,
@@ -69,7 +71,7 @@ const patterns = {
   SK: /^\d{3}\s?\d{2}$/,
   TH: fiveDigit,
   TN: fourDigit,
-  TW: /^\d{3}(\d{2})?$/,
+  TW: /^\d{3}(\d{2,3})?$/,
   UA: fiveDigit,
   US: /^\d{5}(-\d{4})?$/,
   ZA: fourDigit,
diff --git a/src/lib/isURL.js b/src/lib/isURL.js
@@ -1,5 +1,6 @@
 import assertString from './util/assertString';
 import checkHost from './util/checkHost';
+import includes from './util/includesString';
 
 import isFQDN from './isFQDN';
 import isIP from './isIP';
@@ -60,11 +61,11 @@ export default function isURL(url, options) {
     return false;
   }
 
-  if (!options.allow_fragments && url.includes('#')) {
+  if (!options.allow_fragments && includes(url, '#')) {
     return false;
   }
 
-  if (!options.allow_query_components && (url.includes('?') || url.includes('&'))) {
+  if (!options.allow_query_components && (includes(url, '?') || includes(url, '&'))) {
     return false;
   }
 
diff --git a/src/lib/util/includesArray.js b/src/lib/util/includesArray.js
diff --git a/src/lib/util/includesString.js b/src/lib/util/includesString.js
@@ -0,0 +1,3 @@
+const includes = (str, val) => str.indexOf(val) !== -1;
+
+export default includes;
diff --git a/test/validators.test.js b/test/validators.test.js
@@ -3615,11 +3615,15 @@ describe('Validators', () => {
       valid: [
         '790369937',
         '340007237',
+        'A90583942',
+        'E00007734',
       ],
       invalid: [
         'US0123456',
         '0123456US',
         '7903699371',
+        '90583942',
+        'E000077341',
       ],
     });
 
@@ -5608,6 +5612,105 @@ describe('Validators', () => {
         '9c858901-8a57-4791-81fe-4c455b099bc9',
       ],
     });
+    test({
+      validator: 'isUUID',
+      args: ['nil'],
+      valid: [
+        '00000000-0000-0000-0000-000000000000',
+      ],
+      invalid: [
+        '',
+        'xxxA987FBC9-4BED-3078-CF07-9141BA07C9F3',
+        'A987FBC9-4BED-3078-CF07-9141BA07C9F3',
+        'A987FBC9-4BED-3078-CF07-9141BA07C9F3xxx',
+        'A987FBC94BED3078CF079141BA07C9F3',
+        '934859',
+        '987FBC9-4BED-3078-CF07A-9141BA07C9F3',
+        'AAAAAAAA-1111-1111-AAAG-111111111111',
+        '9deb20fe-a6e0-355c-81ea-288b009e4f6d',
+        'A987FBC9-4BED-4078-8F07-9141BA07C9F3',
+        'A987FBC9-4BED-5078-AF07-9141BA07C9F3',
+        'A987FBC9-4BED-6078-AF07-9141BA07C9F3',
+        '018C544A-D384-7000-BB74-3B1738ABE43C',
+        'A987FBC9-4BED-8078-AF07-9141BA07C9F3',
+        'ffffffff-ffff-ffff-ffff-ffffffffffff',
+        'FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF',
+      ],
+    });
+    test({
+      validator: 'isUUID',
+      args: ['max'],
+      valid: [
+        'ffffffff-ffff-ffff-ffff-ffffffffffff',
+        'FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF',
+      ],
+      invalid: [
+        '',
+        'xxxA987FBC9-4BED-3078-CF07-9141BA07C9F3',
+        'A987FBC9-4BED-3078-CF07-9141BA07C9F3',
+        'A987FBC9-4BED-3078-CF07-9141BA07C9F3xxx',
+        'A987FBC94BED3078CF079141BA07C9F3',
+        '934859',
+        '987FBC9-4BED-3078-CF07A-9141BA07C9F3',
+        'AAAAAAAA-1111-1111-AAAG-111111111111',
+        '9deb20fe-a6e0-355c-81ea-288b009e4f6d',
+        'A987FBC9-4BED-4078-8F07-9141BA07C9F3',
+        'A987FBC9-4BED-5078-AF07-9141BA07C9F3',
+        'A987FBC9-4BED-6078-AF07-9141BA07C9F3',
+        '018C544A-D384-7000-BB74-3B1738ABE43C',
+        'A987FBC9-4BED-8078-AF07-9141BA07C9F3',
+        '00000000-0000-0000-0000-000000000000',
+      ],
+    });
+    test({
+      validator: 'isUUID',
+      args: ['all'],
+      valid: [
+        '9deb20fe-a6e0-355c-81ea-288b009e4f6d',
+        'A987FBC9-4BED-4078-8F07-9141BA07C9F3',
+        'A987FBC9-4BED-5078-AF07-9141BA07C9F3',
+        'A987FBC9-4BED-6078-AF07-9141BA07C9F3',
+        '018C544A-D384-7000-BB74-3B1738ABE43C',
+        'A987FBC9-4BED-8078-AF07-9141BA07C9F3',
+        '00000000-0000-0000-0000-000000000000',
+        'ffffffff-ffff-ffff-ffff-ffffffffffff',
+        'FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF',
+      ],
+      invalid: [
+        '',
+        'xxxA987FBC9-4BED-3078-CF07-9141BA07C9F3',
+        'A987FBC9-4BED-3078-CF07-9141BA07C9F3',
+        'A987FBC9-4BED-3078-CF07-9141BA07C9F3xxx',
+        'A987FBC94BED3078CF079141BA07C9F3',
+        '934859',
+        '987FBC9-4BED-3078-CF07A-9141BA07C9F3',
+        'AAAAAAAA-1111-1111-AAAG-111111111111',
+      ],
+    });
+    test({
+      validator: 'isUUID',
+      args: ['invalid'],
+      valid: [],
+      invalid: [
+        '',
+        'xxxA987FBC9-4BED-3078-CF07-9141BA07C9F3',
+        'A987FBC9-4BED-3078-CF07-9141BA07C9F3',
+        'A987FBC9-4BED-3078-CF07-9141BA07C9F3xxx',
+        'A987FBC94BED3078CF079141BA07C9F3',
+        '934859',
+        '987FBC9-4BED-3078-CF07A-9141BA07C9F3',
+        'AAAAAAAA-1111-1111-AAAG-111111111111',
+        '9deb20fe-a6e0-355c-81ea-288b009e4f6d',
+        'A987FBC9-4BED-4078-8F07-9141BA07C9F3',
+        'A987FBC9-4BED-5078-AF07-9141BA07C9F3',
+        'A987FBC9-4BED-6078-AF07-9141BA07C9F3',
+        '018C544A-D384-7000-BB74-3B1738ABE43C',
+        'A987FBC9-4BED-8078-AF07-9141BA07C9F3',
+        '00000000-0000-0000-0000-000000000000',
+        'ffffffff-ffff-ffff-ffff-ffffffffffff',
+        'FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF',
+      ],
+    });
   });
 
   it('should validate a string that is in another string or array', () => {
@@ -12576,6 +12679,7 @@ describe('Validators', () => {
           '399',
           '935',
           '38842',
+          '546023',
         ],
       },
       {
@@ -12658,6 +12762,22 @@ describe('Validators', () => {
           '4144',
         ],
       },
+      {
+        locale: 'PK',
+        valid: [
+          '25000',
+          '44000',
+          '54810',
+          '74200',
+        ],
+        invalid: [
+          '5400',
+          '540000',
+          'NY540',
+          '540CA',
+          '540-0',
+        ],
+      },
       {
         locale: 'MG',
         valid: [

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import assertString from './util/assertString';`
	`2`	`+import includes from './util/includesArray';`
`2`	`3`
`3`	`4`	`const defaultOptions = { loose: false };`
`4`	`5`	`const strictBooleans = ['true', 'false', '1', '0'];`
`@@ -8,8 +9,8 @@ export default function isBoolean(str, options = defaultOptions) {`
`8`	`9`	`assertString(str);`
`9`	`10`
`10`	`11`	`if (options.loose) {`
`11`		`- return looseBooleans.includes(str.toLowerCase());`
	`12`	`+ return includes(looseBooleans, str.toLowerCase());`
`12`	`13`	`}`
`13`	`14`
`14`		`- return strictBooleans.includes(str);`
	`15`	`+ return includes(strictBooleans, str);`
`15`	`16`	`}`