@yext/phonenumber-util 0.3.0 → 0.3.1

package/.github/workflows/pull-request.yml

@@ -1,5 +1,8 @@
 name: Run pull request checks
 
+permissions:
+  contents: read
+
 on:
   pull_request:
     branches: ["main"]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yext/phonenumber-util",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "author": "bajohnson@hearsaycorp.com",
   "license": "BSD-3-Clause",
   "description": "Utility for extracting and validating phone numbers",
@@ -25,16 +25,16 @@
     "make-badges": "istanbul-badges-readme"
   },
   "devDependencies": {
-    "@eslint/js": "^9.28.0",
-    "@vitest/coverage-v8": "^3.2.3",
-    "eslint": "^9.28.0",
+    "@eslint/js": "^9.31.0",
+    "@vitest/coverage-v8": "^3.2.4",
+    "eslint": "^9.31.0",
     "generate-license-file": "4.0.0",
-    "globals": "^16.2.0",
+    "globals": "^16.3.0",
     "husky": "^9.1.7",
     "istanbul-badges-readme": "^1.9.0",
-    "lint-staged": "^16.1.0",
-    "prettier": "^3.5.3",
-    "vitest": "^3.2.3"
+    "lint-staged": "^16.1.2",
+    "prettier": "^3.6.2",
+    "vitest": "^3.2.4"
   },
   "eslintConfig": {},
   "lint-staged": {

package/src/__tests__/geo.test.js

@@ -6,6 +6,10 @@ import {
   findTimeFromAreaCode,
   findRegionFromRegionCode,
 } from '../geo.js';
+import { AREA_CODE_LIST } from '../areaCodeList.js';
+import { AREA_CODES, REGION_CODES } from '../phoneCodes.js';
+import { PHONE_FORMATS } from '../phoneFormats.js';
+
 import { describe, it, expect } from 'vitest';
 
 const invalidPhone = {
@@ -184,6 +188,74 @@ const canadianPhone = {
   },
 };
 
+describe('Validate that every allow-list area code has matching geo and time info', () => {
+  it('should ensure every area code in AREA_CODE_LIST has a matching region code in AREA_CODES', () => {
+    AREA_CODE_LIST.forEach((areaCode) => {
+      const areaCodeInfo = AREA_CODES[areaCode];
+
+      if (!areaCodeInfo) {
+        console.warn(
+          `Area code ${areaCode} does not have a matching AREA_CODES entry.`,
+        );
+      }
+
+      expect(areaCodeInfo).toBeDefined();
+      expect(areaCodeInfo).not.toBeNull();
+    });
+
+    Object.keys(AREA_CODES).forEach((areaCode) => {
+      const exists = AREA_CODE_LIST.includes(areaCode);
+
+      if (!exists) {
+        console.warn(
+          `Area code ${areaCode} does not have a matching AREA_CODE_LIST entry.`,
+        );
+      }
+
+      expect(exists).toBe(true);
+    });
+  });
+
+  it('should ensure every area code in AREA_CODE_LIST has a matching timezone', () => {
+    AREA_CODE_LIST.forEach((areaCode) => {
+      const timezone = findTimeFromAreaCode(
+        areaCode,
+        new Date('2024-07-15T08:00:00'),
+      );
+      expect(timezone).toBeDefined();
+      expect(timezone).not.toBeNull();
+    });
+  });
+
+  it('should ensure every region code in REGION_CODES has a matching phone format', () => {
+    Object.keys(REGION_CODES).forEach((regionCode) => {
+      const phoneFormat = PHONE_FORMATS[regionCode];
+
+      if (!phoneFormat) {
+        console.warn(
+          `Region code ${regionCode} does not have a matching PHONE_FORMATS entry.`,
+        );
+      }
+
+      expect(phoneFormat).toBeDefined();
+      expect(phoneFormat).not.toBeNull();
+    });
+
+    Object.keys(PHONE_FORMATS).forEach((regionCode) => {
+      const regionInfo = REGION_CODES[regionCode];
+
+      if (!regionInfo) {
+        console.warn(
+          `Region code ${regionCode} does not have a matching REGION_CODES entry.`,
+        );
+      }
+
+      expect(regionInfo).toBeDefined();
+      expect(regionInfo).not.toBeNull();
+    });
+  });
+});
+
 describe('Daylight Savings', () => {
   it('should correctly be determined if the time given is or is not within daylight savings time', () => {
     const daylightSavings = new Date('2024-07-15T12:00:00');

package/src/areaCodeList.js

@@ -38,6 +38,7 @@ export const AREA_CODE_LIST = [
   '242',
   '246',
   '248',
+  '249',
   '250',
   '251',
   '252',
@@ -46,6 +47,7 @@ export const AREA_CODE_LIST = [
   '256',
   '260',
   '262',
+  '263',
   '264',
   '267',
   '268',
@@ -98,15 +100,18 @@ export const AREA_CODE_LIST = [
   '350',
   '351',
   '352',
+  '354',
   '357',
   '360',
   '361',
   '363',
   '364',
   '365',
+  '367',
   '368',
   '369',
   '380',
+  '382',
   '385',
   '386',
   '387',
@@ -150,11 +155,13 @@ export const AREA_CODE_LIST = [
   '458',
   '463',
   '464',
+  '468',
   '469',
   '470',
   '471',
   '472',
   '473',
+  '474',
   '475',
   '478',
   '479',
@@ -236,6 +243,7 @@ export const AREA_CODE_LIST = [
   '580',
   '581',
   '582',
+  '584',
   '585',
   '586',
   '587',
@@ -301,6 +309,7 @@ export const AREA_CODE_LIST = [
   '680',
   '681',
   '682',
+  '683',
   '684',
   '686',
   '688',
@@ -343,6 +352,7 @@ export const AREA_CODE_LIST = [
   '743',
   '747',
   '748',
+  '753',
   '754',
   '757',
   '758',

package/src/base.js

@@ -322,8 +322,8 @@ export const findNumbersInString = (text) => {
     if (
       number.replace(new RegExp(`[${VALID_PUNCTUATION}]`, 'g'), '').length >= 6
     ) {
-      const index = text.indexOf(number);
-      const lastIndex = index + number.length;
+      const index = match.index;
+      const lastIndex = regex.lastIndex;
       const phoneParts = getPhoneParts(number);
 
       // Presumed phone numbers may be invalidated by omission of formattedNumber from getPhoneParts.

package/src/daylightSavings.js

@@ -18,4 +18,6 @@ export const AREA_CODES_WITH_MULTIPLE_DAYLIGHT_SAVINGS = {
   672: 'British Columbia',
   778: 'British Columbia',
   306: 'Saskatchewan',
+  474: 'Saskatchewan',
+  639: 'Saskatchewan',
 };

package/src/phoneCodes.js

@@ -568,6 +568,7 @@ export const AREA_CODES = {
   778: { name: 'British Columbia', code: 'BC', region: CANADA },
   204: { name: 'Manitoba', code: 'MB', region: CANADA },
   431: { name: 'Manitoba', code: 'MB', region: CANADA },
+  584: { name: 'Manitoba', code: 'MB', region: CANADA },
   506: { name: 'New Brunswick', code: 'NB', region: CANADA },
   709: { name: 'Newfoundland and Labrador', code: 'NL', region: CANADA },
   782: {
@@ -581,30 +582,39 @@ export const AREA_CODES = {
     region: CANADA,
   },
   226: { name: 'Ontario', code: 'ON', region: CANADA },
+  249: { name: 'Ontario', code: 'ON', region: CANADA },
   289: { name: 'Ontario', code: 'ON', region: CANADA },
   343: { name: 'Ontario', code: 'ON', region: CANADA },
   365: { name: 'Ontario', code: 'ON', region: CANADA },
+  382: { name: 'Ontario', code: 'ON', region: CANADA },
   416: { name: 'Ontario', code: 'ON', region: CANADA },
   437: { name: 'Ontario', code: 'ON', region: CANADA },
   519: { name: 'Ontario', code: 'ON', region: CANADA },
   548: { name: 'Ontario', code: 'ON', region: CANADA },
   613: { name: 'Ontario', code: 'ON', region: CANADA },
   647: { name: 'Ontario', code: 'ON', region: CANADA },
+  683: { name: 'Ontario', code: 'ON', region: CANADA },
   705: { name: 'Ontario', code: 'ON', region: CANADA },
+  753: { name: 'Ontario', code: 'ON', region: CANADA },
   742: { name: 'Ontario', code: 'ON', region: CANADA },
   807: { name: 'Ontario', code: 'ON', region: CANADA },
   942: { name: 'Ontario', code: 'ON', region: CANADA },
   905: { name: 'Ontario', code: 'ON', region: CANADA },
+  263: { name: 'Quebec', code: 'QC', region: CANADA },
+  354: { name: 'Quebec', code: 'QC', region: CANADA },
+  367: { name: 'Quebec', code: 'QC', region: CANADA },
   387: { name: 'Quebec', code: 'QC', region: CANADA },
   418: { name: 'Quebec', code: 'QC', region: CANADA },
   438: { name: 'Quebec', code: 'QC', region: CANADA },
   450: { name: 'Quebec', code: 'QC', region: CANADA },
+  468: { name: 'Quebec', code: 'QC', region: CANADA },
   514: { name: 'Quebec', code: 'QC', region: CANADA },
   579: { name: 'Quebec', code: 'QC', region: CANADA },
   581: { name: 'Quebec', code: 'QC', region: CANADA },
   819: { name: 'Quebec', code: 'QC', region: CANADA },
   873: { name: 'Quebec', code: 'QC', region: CANADA },
   306: { name: 'Saskatchewan', code: 'SK', region: CANADA },
+  474: { name: 'Saskatchewan', code: 'SK', region: CANADA },
   639: { name: 'Saskatchewan', code: 'SK', region: CANADA },
   867: {
     name: 'Yukon, Northwest Territories, and Nunavut',
@@ -708,6 +718,7 @@ export const REGION_CODES = {
   679: { name: 'Fiji', code: 'FJ', flag: '🇫🇯' },
   358: { name: 'Finland', code: 'FI', flag: '🇫🇮' },
   33: { name: 'France', code: 'FR', flag: '🇫🇷' },
+  594: { name: 'French Guiana', code: 'GF', flag: '🇬🇫' },
   689: { name: 'French Polynesia', code: 'PF', flag: '🇵🇫' },
   241: { name: 'Gabon', code: 'GA', flag: '🇬🇦' },
   220: { name: 'Gambia', code: 'GM', flag: '🇬🇲' },
@@ -761,6 +772,7 @@ export const REGION_CODES = {
   223: { name: 'Mali', code: 'ML', flag: '🇲🇱' },
   356: { name: 'Malta', code: 'MT', flag: '🇲🇹' },
   692: { name: 'Marshall Islands', code: 'MH', flag: '🇲🇭' },
+  596: { name: 'Martinique', code: 'MQ', flag: '🇲🇶' },
   222: { name: 'Mauritania', code: 'MR', flag: '🇲🇷' },
   230: { name: 'Mauritius', code: 'MU', flag: '🇲🇺' },
   262: { name: 'Mayotte, Reunion', code: 'YT/RE', flag: '🇾🇹/🇷🇪' },

package/src/phoneFormats.js

@@ -145,7 +145,6 @@ export const PHONE_FORMATS = {
   269: '+xxx xxx xx xx', // Comoros
   290: '+xxx xxxx', // Saint Helena
   291: '+xxx x xxx xxx', // Eritrea
-  295: '+xxx xxx xxxx', // San Marino
   297: '+xxx xxx xxxx', // Aruba
   298: '+xxx xxx xxx', // Faroe Islands
   299: '+xxx xx xx xx', // Greenland

package/src/timezones.js

@@ -118,6 +118,11 @@ export const STATES_WITH_MULTIPLE_TIMEZONES = {
     458: ['-08:00', '-07:00'],
     541: ['-08:00', '-07:00'],
   },
+  Saskatchewan: {
+    306: ['-07:00', '-06:00', '-05:00'],
+    474: ['-07:00', '-06:00', '-05:00'],
+    639: ['-07:00', '-06:00', '-05:00'],
+  },
   'South Dakota': {
     605: ['-06:00', '-07:00'],
   },
@@ -142,7 +147,9 @@ export const STATES_WITH_MULTIPLE_TIMEZONES = {
     807: ['-05:00', '-06:00'],
   },
   Quebec: {
+    367: ['-04:00'],
     418: ['-04:00'],
+    581: ['-04:00'],
   },
   'Newfoundland and Labrador': {
     709: ['-03:30', '-04:00'],