@clipboard-health/phone-number 2.9.3 → 2.10.0

package/README.md

@@ -16,6 +16,16 @@ npm install @clipboard-health/phone-number
 
 ## Usage
 
+```typescript
+import { randomPhoneNumber } from "@clipboard-health/phone-number";
+
+const nationalPhoneNumber = randomPhoneNumber();
+const internationalPhoneNumber = randomPhoneNumber({ international: true });
+```
+
+`randomPhoneNumber` produces valid-looking NANP numbers for synthetic identities. The numbers are
+not reserved, so callers must suppress outbound routing.
+
 ## Local development commands
 
 See [`package.json`](./package.json) `scripts` for a list of commands.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clipboard-health/phone-number",
-  "version": "2.9.3",
+  "version": "2.10.0",
   "description": "Phone number utility functions.",
   "keywords": [],
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
@@ -17,12 +17,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@clipboard-health/util-ts": "5.14.0",
+    "@clipboard-health/util-ts": "5.14.1",
     "tslib": "2.8.1"
   },
   "devDependencies": {
-    "@clipboard-health/testing-core": "2.9.3",
-    "libphonenumber-js": "1.13.9"
+    "@clipboard-health/testing-core": "2.9.4",
+    "libphonenumber-js": "1.13.10"
   },
   "peerDependencies": {
     "libphonenumber-js": "^1.12"

package/src/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./lib/formatPhoneNumber";
 export * from "./lib/isValidPhoneNumber";
+export * from "./lib/randomPhoneNumber";

package/src/index.js

@@ -3,4 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./lib/formatPhoneNumber"), exports);
 tslib_1.__exportStar(require("./lib/isValidPhoneNumber"), exports);
+tslib_1.__exportStar(require("./lib/randomPhoneNumber"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/phone-number/src/index.ts"],"names":[],"mappings":";;;AAAA,kEAAwC;AACxC,mEAAyC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/phone-number/src/index.ts"],"names":[],"mappings":";;;AAAA,kEAAwC;AACxC,mEAAyC;AACzC,kEAAwC"}

package/src/lib/randomPhoneNumber.d.ts

@@ -0,0 +1,12 @@
+export interface RandomPhoneNumberOptions {
+    /** Whether to include the US country code in the number. */
+    international?: boolean;
+}
+/**
+ * Creates a random US phone number accepted by pinned libphonenumber-js metadata.
+ *
+ * The 126 area codes × 8,000,000 full-width subscriber numbers provide
+ * 1,008,000,000 possible values. These are not reserved NANP test numbers;
+ * callers creating synthetic identities must suppress outbound routing.
+ */
+export declare function randomPhoneNumber(options?: RandomPhoneNumberOptions): string;

package/src/lib/randomPhoneNumber.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.randomPhoneNumber = randomPhoneNumber;
+const VALID_TEST_PHONE_AREA_CODES = [
+    "201",
+    "202",
+    "203",
+    "205",
+    "206",
+    "207",
+    "208",
+    "209",
+    "210",
+    "212",
+    "213",
+    "214",
+    "215",
+    "216",
+    "217",
+    "218",
+    "219",
+    "220",
+    "223",
+    "224",
+    "225",
+    "227",
+    "228",
+    "229",
+    "231",
+    "234",
+    "235",
+    "239",
+    "240",
+    "248",
+    "251",
+    "252",
+    "253",
+    "254",
+    "256",
+    "260",
+    "262",
+    "267",
+    "269",
+    "270",
+    "272",
+    "276",
+    "279",
+    "281",
+    "283",
+    "301",
+    "302",
+    "303",
+    "304",
+    "305",
+    "307",
+    "308",
+    "309",
+    "310",
+    "312",
+    "313",
+    "314",
+    "315",
+    "316",
+    "317",
+    "318",
+    "319",
+    "320",
+    "321",
+    "323",
+    "324",
+    "325",
+    "326",
+    "327",
+    "329",
+    "330",
+    "331",
+    "332",
+    "334",
+    "336",
+    "337",
+    "339",
+    "341",
+    "346",
+    "347",
+    "350",
+    "351",
+    "352",
+    "353",
+    "360",
+    "361",
+    "363",
+    "364",
+    "369",
+    "380",
+    "385",
+    "386",
+    "401",
+    "402",
+    "404",
+    "405",
+    "406",
+    "407",
+    "408",
+    "409",
+    "410",
+    "412",
+    "413",
+    "414",
+    "415",
+    "417",
+    "419",
+    "423",
+    "424",
+    "425",
+    "430",
+    "432",
+    "434",
+    "435",
+    "440",
+    "442",
+    "443",
+    "445",
+    "447",
+    "448",
+    "458",
+    "463",
+    "464",
+    "469",
+    "470",
+    "475",
+];
+const MINIMUM_SUBSCRIBER_NUMBER = 2_000_000;
+const MAXIMUM_SUBSCRIBER_NUMBER = 9_999_999;
+/**
+ * Creates a random US phone number accepted by pinned libphonenumber-js metadata.
+ *
+ * The 126 area codes × 8,000,000 full-width subscriber numbers provide
+ * 1,008,000,000 possible values. These are not reserved NANP test numbers;
+ * callers creating synthetic identities must suppress outbound routing.
+ */
+function randomPhoneNumber(options = {}) {
+    const { international = false } = options;
+    const prefix = international ? "+1" : "";
+    const areaCode = randomAreaCode();
+    const subscriberNumber = randomInteger({
+        minimum: MINIMUM_SUBSCRIBER_NUMBER,
+        maximum: MAXIMUM_SUBSCRIBER_NUMBER,
+    });
+    return `${prefix}${areaCode}${subscriberNumber}`;
+}
+function randomInteger({ minimum, maximum }) {
+    const minimumInteger = Math.ceil(minimum);
+    const maximumInteger = Math.floor(maximum);
+    return Math.floor(Math.random() * (maximumInteger - minimumInteger + 1)) + minimumInteger;
+}
+function randomAreaCode() {
+    const index = randomInteger({ minimum: 0, maximum: VALID_TEST_PHONE_AREA_CODES.length - 1 });
+    return VALID_TEST_PHONE_AREA_CODES.slice(index, index + 1).join("");
+}
+//# sourceMappingURL=randomPhoneNumber.js.map

package/src/lib/randomPhoneNumber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"randomPhoneNumber.js","sourceRoot":"","sources":["../../../../../packages/phone-number/src/lib/randomPhoneNumber.ts"],"names":[],"mappings":";;;AAKA,MAAM,2BAA2B,GAAG;IAClC,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;CACG,CAAC;AAEX,MAAM,yBAAyB,GAAG,SAAS,CAAC;AAC5C,MAAM,yBAAyB,GAAG,SAAS,CAAC;AAE5C;;;;;;GAMG;AACH,2BAAkC,OAAO,GAA6B,EAAE;IACtE,MAAM,EAAE,aAAa,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAC1C,MAAM,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACzC,MAAM,QAAQ,GAAG,cAAc,EAAE,CAAC;IAClC,MAAM,gBAAgB,GAAG,aAAa,CAAC;QACrC,OAAO,EAAE,yBAAyB;QAClC,OAAO,EAAE,yBAAyB;KACnC,CAAC,CAAC;IAEH,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,gBAAgB,EAAE,CAAC;AACnD,CAAC;AAOD,SAAS,aAAa,CAAC,EAAE,OAAO,EAAE,OAAO,EAAuB;IAC9D,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAE3C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,cAAc,GAAG,cAAc,GAAG,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC;AAC5F,CAAC;AAED,SAAS,cAAc;IACrB,MAAM,KAAK,GAAG,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,2BAA2B,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC;IAE7F,OAAO,2BAA2B,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACtE,CAAC"}