@yext/phonenumber-util 0.2.0 → 0.2.2

package/.husky/pre-commit

@@ -3,4 +3,6 @@
 
 npx lint-staged
 npm run format
-npx vitest run --coverage
+npx vitest run --coverage
+npm run make-badges
+npx generate-license-file --input package.json --output THIRD-PARTY-NOTICES --overwrite

package/README.md

@@ -1,5 +1,7 @@
 Utility for extracting and validating phone numbers. Extracts an array of phone numbers from an inputted string, validates that these numbers appear genuine and provide data about those phone numbers.
 
+[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) ![Statements](https://img.shields.io/badge/statements-100%25-brightgreen.svg?style=flat) ![Branches](https://img.shields.io/badge/branches-100%25-brightgreen.svg?style=flat) ![Functions](https://img.shields.io/badge/functions-100%25-brightgreen.svg?style=flat) ![Lines](https://img.shields.io/badge/lines-100%25-brightgreen.svg?style=flat)
+
 ### Scripts
 
 #### Install dependencies
@@ -196,7 +198,7 @@ Example output for Arizona:
 
 ```javascript
 import { findTimeFromAreaCode } from '@yext/phonenumber-util/geo';
-findTimeFromAreaCode('250');
+findTimeFromAreaCode('250', date); // A date object is optional, defaulting to the current time.
 ```
 
 Example output for British Columbia:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yext/phonenumber-util",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "author": "bajohnson@hearsaycorp.com",
   "license": "BSD-3-Clause",
   "description": "Utility for extracting and validating phone numbers",
@@ -21,14 +21,17 @@
     "format": "prettier --write **/*.js **/__tests__/*.js",
     "test": "TZ=America/Los_Angeles vitest",
     "build": "node -e \"console.log('No build script for vanilla JS')\"",
-    "prepare": "husky"
+    "prepare": "husky",
+    "make-badges": "istanbul-badges-readme"
   },
   "devDependencies": {
     "@eslint/js": "^9.7.0",
     "@vitest/coverage-v8": "^2.1.1",
     "eslint": "^9.7.0",
+    "generate-license-file": "^3.5.1",
     "globals": "^15.8.0",
     "husky": "^9.1.5",
+    "istanbul-badges-readme": "^1.9.0",
     "lint-staged": "^15.2.10",
     "prettier": "^3.3.3",
     "vitest": "^2.1.1"

package/src/__tests__/base.test.js

@@ -220,20 +220,29 @@ describe('Phone number pretty formatting', () => {
         format: findPhoneFormat({ regionCode: '57', e164: '+573211234567' }),
       },
       germany: {
-        e164: '+49 170 87654321',
+        e164: '+4917087654321',
         regionCode: '49',
         format: findPhoneFormat({ regionCode: '49', e164: '+4917087654321' }),
       },
       germanyAlt: {
-        e164: '+49 170 8765432',
+        e164: '+491708765432',
         regionCode: '49',
         format: findPhoneFormat({ regionCode: '49', e164: '+491708765432' }),
       },
+      norwayUnexpected: {
+        e164: '+47174087654',
+        regionCode: '47',
+        format: findPhoneFormat({ regionCode: '47', e164: '+471740876543' }),
+      },
     };
 
     expect(formatPhoneNumber(testNumbers.nullCase)).toBe(null);
     expect(formatPhoneNumber(testNumbers.us)).toBe('(310) 349-6200');
     expect(formatPhoneNumber(testNumbers.colombia)).toBe('+57 321 123 4567');
     expect(formatPhoneNumber(testNumbers.germanyAlt)).toBe('+49 17 08765432');
+    // This looks like a Norwegian number, but doesn't match a known format.  In this case, we'll return a sanitized generic format.
+    expect(formatPhoneNumber(testNumbers.norwayUnexpected)).toBe(
+      '+47174087654',
+    );
   });
 });

package/src/__tests__/geo.test.js

@@ -37,6 +37,27 @@ const seattlePhone = {
   },
 };
 
+const portlandPhone = {
+  areaCodeHasMultipleTimezones: false,
+  daylightSavings: true,
+  estimatedTime: false,
+  isQuietHours: false,
+  isTCPAQuietHours: false,
+  localTime24Hour: '08:00:00',
+  localTimeReadable: '8:00:00 AM',
+  stateHasMultipleTimezones: true,
+  timezoneOffset: '-07:00',
+  state: {
+    name: 'Oregon',
+    code: 'OR',
+  },
+  region: {
+    name: 'United States',
+    code: 'US',
+    flag: '🇺🇸',
+  },
+};
+
 const arizonaPhoneJul = {
   areaCodeHasMultipleTimezones: false,
   daylightSavings: true,
@@ -250,6 +271,9 @@ describe('Provides general time information for the given phone number (US and C
     expect(
       findTimeFromAreaCode('206', new Date('2024-07-15T08:00:00')),
     ).toEqual(seattlePhone);
+    expect(
+      findTimeFromAreaCode('503', new Date('2024-07-15T08:00:00')),
+    ).toEqual(portlandPhone);
     expect(
       findTimeFromAreaCode('928', new Date('2024-07-15T08:00:00')),
     ).toEqual(arizonaPhoneJul);

package/src/areaCodeList.js

@@ -21,6 +21,7 @@ export const AREA_CODE_LIST = [
   '223',
   '224',
   '225',
+  '226',
   '257',
   '228',
   '229',

package/src/base.js

@@ -234,18 +234,6 @@ export const getPhoneParts = (phoneNumber) => {
     phoneParts.e164 = formatPhoneNumberForE164(phoneParts);
     phoneParts.format = findPhoneFormat(phoneParts);
     phoneParts.formattedNumber = formatPhoneNumber(phoneParts);
-
-    // If there are left over x's, the formatting ran into something unexpected.
-    // This may be ok depending on the region and their phone number formats.
-    // But it does mean we don't want to display this number.
-    if (
-      phoneParts.formattedNumber &&
-      phoneParts.formattedNumber.indexOf('x') !== -1
-    ) {
-      // Since `rawNumber` isn't sanitized, we'll use a simple format that we
-      // are assured to be safe.
-      phoneParts.formattedNumber = strippedPhoneNumber;
-    }
   }
 
   return phoneParts;
@@ -353,16 +341,26 @@ export const findPhoneFormat = ({ regionCode, e164 }) => {
  * @param {Object} params - The parameters for formatting the phone number.
  * @param {string} params.format - The desired format for the phone number. Example: `(xxx) xxx-xxxx`.
  * @param {string} params.e164 - The E.164 formatted phone number to format. Example: `+12065551234`.
+ * @param {string} params.regionCode - The region code of the phone number.  Example, the US would be "1".
  * @returns {string|null} The formatted phone number, or null if the E.164 number or format is not provided.
  */
-export const formatPhoneNumber = ({ format, e164 }) => {
+export const formatPhoneNumber = ({ format, e164, regionCode }) => {
   let formattedNumber = '';
 
   if (e164 && format) {
     // Remove the leading '+' and let the format handle it.
-    const strippedPhone = e164.replace(/\D/g, '');
+    const strippedPhone = e164.replace(/\+/g, '');
     let phoneIndex = strippedPhone.length - 1;
 
+    // The US / NANP rarely includes region code prefix when sharing numbers.  Other regions often do, so we'll have a special condition to allow ignoring of the region code for region 1.
+    // For other regions, we'll return the stripped number to safely display the presumed good number that may be in a safe but not-ideal format.
+    if (
+      regionCode !== '1' &&
+      strippedPhone.length !== format.split('x').length - 1
+    ) {
+      return e164;
+    }
+
     // Traverse backward so we can omit country code in some formats (like US).
     for (let i = format.length; i >= 0; i--) {
       if (format[i]) {

package/src/geo.js

@@ -186,7 +186,8 @@ export function findTimeFromAreaCode(areaCode, date = new Date()) {
       returnTime.areaCodeHasMultipleTimezones = false;
     }
   } else {
-    returnTime.stateHasMultipleTimezones = false;
+    returnTime.stateHasMultipleTimezones =
+      !!STATES_WITH_MULTIPLE_TIMEZONES[stateName];
     returnTime.areaCodeHasMultipleTimezones = false;
     localOffset = STATE_TIMEZONES[stateName];
   }

package/src/phoneCodes.js

@@ -389,6 +389,7 @@ export const AREA_CODES = {
     state: 'NS/PE',
     region: CANADA,
   },
+  226: { 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 },

package/vitest.config.js

@@ -2,5 +2,8 @@ export default {
   test: {
     globals: true,
     environment: 'node',
+    coverage: {
+      reporter: ['json-summary'],
+    },
   },
 };