@yext/phonenumber-util 0.2.2 → 0.2.4

package/.husky/pre-commit

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

package/README.md

@@ -1,6 +1,11 @@
 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)
+[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Install from NPM](https://img.shields.io/badge/npm-@yext/phonenumber--util-blue)](https://www.npmjs.com/package/@yext/phonenumber-util)
+![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
 
@@ -38,6 +43,12 @@ npx vitest run --coverage
 
 The returned object will include a `rawNumber` value. This value is the return of the exact value passed to the function. No sanitization occurs with this value. If you reference this number, ensure you sanitize it _BEFORE_ passing to this function.
 
+### Install
+
+```bash
+npm i @yext/phonenumber-util --save
+```
+
 ### Usage
 
 There is additional functionality exposed as `export`, but the primary expected use case is:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yext/phonenumber-util",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "author": "bajohnson@hearsaycorp.com",
   "license": "BSD-3-Clause",
   "description": "Utility for extracting and validating phone numbers",
@@ -26,14 +26,14 @@
   },
   "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",
+    "@vitest/coverage-v8": "^2.1.8",
+    "eslint": "^9.17.0",
+    "generate-license-file": "^3.6.0",
+    "globals": "^15.14.0",
+    "husky": "^9.1.7",
     "istanbul-badges-readme": "^1.9.0",
-    "lint-staged": "^15.2.10",
-    "prettier": "^3.3.3",
+    "lint-staged": "^15.2.11",
+    "prettier": "^3.4.2",
     "vitest": "^2.1.1"
   },
   "eslintConfig": {},

package/src/areaCodeList.js

@@ -1,3 +1,7 @@
+// The AREA_CODE_LIST is used in validation of NANP phone numbers.  If a number is passed to `isValidPhoneNumber` that is not found in this array, `false` will be returned.
+// If a new area code is added to this array, it must also be added to the AREA_CODES object in phoneCodes.js.
+// If a new area code is added and covers a region that has multiple timezones, it will need to be added to the STATES_WITH_MULTIPLE_TIMEZONES object in timezones.js.
+// If a new area code is added and covers a region that has portions that do and portions that do not adhere to daylight savings time, it will need to be added to the AREA_CODES_WITH_MULTIPLE_DAYLIGHT_SAVINGS object in daylightSavings.js.
 export const AREA_CODE_LIST = [
   '201',
   '202',
@@ -22,6 +26,7 @@ export const AREA_CODE_LIST = [
   '224',
   '225',
   '226',
+  '227',
   '257',
   '228',
   '229',
@@ -50,6 +55,7 @@ export const AREA_CODE_LIST = [
   '276',
   '279',
   '281',
+  '283',
   '284',
   '289',
   '301',
@@ -347,6 +353,7 @@ export const AREA_CODE_LIST = [
   '839',
   '840',
   '843',
+  '844',
   '845',
   '847',
   '848',

package/src/compliance.js

@@ -1,3 +1,4 @@
+// Compliance settings are used to define quiet hours for the US (using TCPA) and Canada (using CRTC).
 export const TCPA_QUIET_HOURS = {
   start: 8,
   end: 21,
@@ -14,6 +15,7 @@ export const CRTC_QUIET_HOURS = {
   },
 };
 
+// The strings of CRTC_STATES must match the `name` field found within AREA_CODES object in phoneCodes.js.
 export const CRTC_STATES = [
   'Alberta',
   'British Columbia',

package/src/phoneCodes.js

@@ -6,6 +6,7 @@ export const AREA_CODES = {
   // Toll Free / Not Geographic
   800: { name: 'Toll-free', region: { name: 'United States', code: 'US' } },
   833: { name: 'Toll-free', region: { name: 'United States', code: 'US' } },
+  844: { name: 'Toll-free', region: { name: 'United States', code: 'US' } },
   888: { name: 'Toll-free', region: { name: 'United States', code: 'US' } },
   877: { name: 'Toll-free', region: { name: 'United States', code: 'US' } },
   866: { name: 'Toll-free', region: { name: 'United States', code: 'US' } },
@@ -156,6 +157,7 @@ export const AREA_CODES = {
   504: { name: 'Louisiana', code: 'LA', region: UNITED_STATES },
   985: { name: 'Louisiana', code: 'LA', region: UNITED_STATES },
   207: { name: 'Maine', code: 'ME', region: UNITED_STATES },
+  227: { name: 'Maryland', code: 'MD', region: UNITED_STATES },
   240: { name: 'Maryland', code: 'MD', region: UNITED_STATES },
   301: { name: 'Maryland', code: 'MD', region: UNITED_STATES },
   410: { name: 'Maryland', code: 'MD', region: UNITED_STATES },
@@ -256,6 +258,7 @@ export const AREA_CODES = {
   216: { name: 'Ohio', code: 'OH', region: UNITED_STATES },
   220: { name: 'Ohio', code: 'OH', region: UNITED_STATES },
   234: { name: 'Ohio', code: 'OH', region: UNITED_STATES },
+  283: { name: 'Ohio', code: 'OH', region: UNITED_STATES },
   326: { name: 'Ohio', code: 'OH', region: UNITED_STATES },
   330: { name: 'Ohio', code: 'OH', region: UNITED_STATES },
   380: { name: 'Ohio', code: 'OH', region: UNITED_STATES },
@@ -421,7 +424,6 @@ export const AREA_CODES = {
     region: CANADA,
   },
   // Other North American Numbering Plan (NANP) Numbers
-  // These will return "United States, Canada" as the region, which is incorrect, but they follow the same standard.
   684: { region: { name: 'American Samoa', code: 'AS', flag: '🇦🇸' } },
   264: { region: { name: 'Anguilla', code: 'AI', flag: '🇦🇮' } },
   268: { region: { name: 'Antigua and Barbuda', code: 'AG', flag: '🇦🇬' } },
@@ -492,7 +494,7 @@ export const REGION_CODES = {
   235: { name: 'Chad', code: 'TD', flag: '🇹🇩' },
   56: { name: 'Chile', code: 'CL', flag: '🇨🇱' },
   86: { name: 'China', code: 'CN', flag: '🇨🇳' },
-  61: { name: 'Christmas Island, Cocos Islands', code: 'CX', flag: '🇨🇽' },
+  61: { name: 'Australia', code: 'AU', flag: '🇦🇺' },
   57: { name: 'Colombia', code: 'CO', flag: '🇨🇴' },
   269: { name: 'Comoros', code: 'KM', flag: '🇰🇲' },
   682: { name: 'Cook Islands', code: 'CK', flag: '🇨🇰' },

package/src/phoneFormats.js

@@ -1,3 +1,5 @@
+// For each region, provide a pretty format.  Some regions may have multiple formats, in which case an array can be used.  Each "x" will be replaced with a digit when the number of digits matches the number of "x"s in the format.
+// If no format is found with a correct matching length, a sanitized e164 is returned as a fall-back.
 export const PHONE_FORMATS = {
   1: '(xxx) xxx-xxxx', // United States
   7: '+x xxx xxx-xx-xx', // Russia

package/src/timezones.js

@@ -1,3 +1,6 @@
+// Default timezone for each state, region or province.
+// While some region may have multiple timezones, we set the most common one here as a default.  See STATES_WITH_MULTIPLE_TIMEZONES below for references to exceptions within these regions.
+// Time calculations are only provided for US and Canada.
 export const STATE_TIMEZONES = {
   Alabama: '-06:00',
   Alaska: '-09:00',