@nr1e/commons 0.4.5 → 0.4.6

package/dist/business/index.d.mts

@@ -1,3 +1,4 @@
 export * from './card.mjs';
+export * from './phone-number.mjs';
 export * from './us-state-to-code.mjs';
 //# sourceMappingURL=index.d.mts.map

package/dist/business/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/business/index.mts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/business/index.mts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC"}

package/dist/business/index.mjs

@@ -1,3 +1,4 @@
 export * from './card.mjs';
+export * from './phone-number.mjs';
 export * from './us-state-to-code.mjs';
 //# sourceMappingURL=index.mjs.map

package/dist/business/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/business/index.mts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/business/index.mts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC"}

package/dist/business/phone-number.d.mts

@@ -0,0 +1,44 @@
+import * as v from 'valibot';
+import { parsePhoneNumberFromString, CountryCode } from 'libphonenumber-js';
+export { parsePhoneNumberFromString, CountryCode };
+/**
+ * Checks if a phone number is valid according to E.164 format.
+ *
+ * @param phoneNumber - The phone number to check.
+ */
+export declare function isValidE164(phoneNumber: string): boolean;
+/**
+ * Checks if a phone number is valid according to the specified country code.
+ *
+ * @param phoneNumber - The phone number to check.
+ * @param countryCode - The 2-letter country code (ISO 3166-1 alpha-2).
+ */
+export declare function isValidPhoneNumber(phoneNumber: string, countryCode: CountryCode): boolean;
+/**
+ * Converts a phone number to E.164 format.
+ *
+ * @param phoneNumber
+ * @param defaultCountry
+ */
+export declare function toE164(phoneNumber: string, defaultCountry?: CountryCode): string | null;
+/**
+ * Generates a valibot schema to validate a phone number given a country code.
+ *
+ * @param countryCode - The 2-letter country code (ISO 3166-1 alpha-2).
+ * @param msg - The error message to use if the phone number is invalid.
+ */
+export declare function phoneNumberSchema(countryCode: CountryCode, msg?: string): v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, string>]>;
+/**
+ * Generates a valibot schema to validate a phone number in E.164 format.
+ *
+ * @param msg - The error message to use if the phone number is invalid.
+ */
+export declare function phoneNumberE164Schema(msg?: string): v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, string>]>;
+/**
+ * Generates a valibot schema to validate a phone number and transform it into E.164 format
+ *
+ * @param countryCode - The 2-letter country code (ISO 3166-1 alpha-2).
+ * @param msg - The error message to use if the phone number is invalid.
+ */
+export declare function phoneNumberToE164Schema(countryCode?: CountryCode, msg?: string): v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TrimAction, v.TransformAction<string, string | null>, v.CheckAction<string | null, string>]>;
+//# sourceMappingURL=phone-number.d.mts.map

package/dist/business/phone-number.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone-number.d.mts","sourceRoot":"","sources":["../../src/business/phone-number.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAC,0BAA0B,EAAE,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAE1E,OAAO,EAAC,0BAA0B,EAAE,WAAW,EAAC,CAAC;AAEjD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAOxD;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,WAAW,WAMzB;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CACpB,WAAW,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,WAAW,GAC3B,MAAM,GAAG,IAAI,CAQf;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,EAAE,MAAM,yFAUvE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,CAAC,EAAE,MAAM,yFASjD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,WAAW,CAAC,EAAE,WAAW,EACzB,GAAG,CAAC,EAAE,MAAM,wJAab"}

package/dist/business/phone-number.mjs

@@ -0,0 +1,85 @@
+import * as v from 'valibot';
+import { parsePhoneNumberFromString } from 'libphonenumber-js';
+export { parsePhoneNumberFromString };
+/**
+ * Checks if a phone number is valid according to E.164 format.
+ *
+ * @param phoneNumber - The phone number to check.
+ */
+export function isValidE164(phoneNumber) {
+    // Basic E.164 format check
+    if (!/^\+[1-9]\d{1,14}$/.test(phoneNumber)) {
+        return false;
+    }
+    const parsed = parsePhoneNumberFromString(phoneNumber);
+    return parsed?.isValid() ?? false;
+}
+/**
+ * Checks if a phone number is valid according to the specified country code.
+ *
+ * @param phoneNumber - The phone number to check.
+ * @param countryCode - The 2-letter country code (ISO 3166-1 alpha-2).
+ */
+export function isValidPhoneNumber(phoneNumber, countryCode) {
+    const parsed = parsePhoneNumberFromString(phoneNumber, {
+        defaultCountry: countryCode,
+    });
+    return parsed?.isValid() ?? false;
+}
+/**
+ * Converts a phone number to E.164 format.
+ *
+ * @param phoneNumber
+ * @param defaultCountry
+ */
+export function toE164(phoneNumber, defaultCountry) {
+    const phone = parsePhoneNumberFromString(phoneNumber, defaultCountry);
+    if (!phone || !phone.isValid()) {
+        return null;
+    }
+    return phone.number; // already E.164
+}
+/**
+ * Generates a valibot schema to validate a phone number given a country code.
+ *
+ * @param countryCode - The 2-letter country code (ISO 3166-1 alpha-2).
+ * @param msg - The error message to use if the phone number is invalid.
+ */
+export function phoneNumberSchema(countryCode, msg) {
+    return v.pipe(v.string(), v.check((phoneNumber) => {
+        const parsed = parsePhoneNumberFromString(phoneNumber, {
+            defaultCountry: countryCode,
+        });
+        return parsed?.isValid() ?? false;
+    }, msg ?? 'Invalid phone number'));
+}
+/**
+ * Generates a valibot schema to validate a phone number in E.164 format.
+ *
+ * @param msg - The error message to use if the phone number is invalid.
+ */
+export function phoneNumberE164Schema(msg) {
+    return v.pipe(v.string(), v.check((phoneNumber) => {
+        if (!isValidE164(phoneNumber))
+            return false;
+        const parsed = parsePhoneNumberFromString(phoneNumber);
+        return parsed?.isValid() ?? false;
+    }, msg ?? 'Invalid phone number'));
+}
+/**
+ * Generates a valibot schema to validate a phone number and transform it into E.164 format
+ *
+ * @param countryCode - The 2-letter country code (ISO 3166-1 alpha-2).
+ * @param msg - The error message to use if the phone number is invalid.
+ */
+export function phoneNumberToE164Schema(countryCode, msg) {
+    return v.pipe(v.string(), v.trim(), v.transform((input) => toE164(input, countryCode)), v.check((phoneNumber) => {
+        if (!phoneNumber)
+            return false;
+        if (!isValidE164(phoneNumber))
+            return false;
+        const parsed = parsePhoneNumberFromString(phoneNumber);
+        return parsed?.isValid() ?? false;
+    }, msg ?? 'Invalid phone number'));
+}
+//# sourceMappingURL=phone-number.mjs.map

package/dist/business/phone-number.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone-number.mjs","sourceRoot":"","sources":["../../src/business/phone-number.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAC,0BAA0B,EAAc,MAAM,mBAAmB,CAAC;AAE1E,OAAO,EAAC,0BAA0B,EAAc,CAAC;AAEjD;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,WAAmB;IAC7C,2BAA2B;IAC3B,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,MAAM,GAAG,0BAA0B,CAAC,WAAW,CAAC,CAAC;IACvD,OAAO,MAAM,EAAE,OAAO,EAAE,IAAI,KAAK,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAChC,WAAmB,EACnB,WAAwB;IAExB,MAAM,MAAM,GAAG,0BAA0B,CAAC,WAAW,EAAE;QACrD,cAAc,EAAE,WAAW;KAC5B,CAAC,CAAC;IACH,OAAO,MAAM,EAAE,OAAO,EAAE,IAAI,KAAK,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CACpB,WAAmB,EACnB,cAA4B;IAE5B,MAAM,KAAK,GAAG,0BAA0B,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;IAEtE,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,gBAAgB;AACvC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAwB,EAAE,GAAY;IACtE,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE;QACtB,MAAM,MAAM,GAAG,0BAA0B,CAAC,WAAW,EAAE;YACrD,cAAc,EAAE,WAAW;SAC5B,CAAC,CAAC;QACH,OAAO,MAAM,EAAE,OAAO,EAAE,IAAI,KAAK,CAAC;IACpC,CAAC,EAAE,GAAG,IAAI,sBAAsB,CAAC,CAClC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,GAAY;IAChD,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE;QACtB,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;YAAE,OAAO,KAAK,CAAC;QAC5C,MAAM,MAAM,GAAG,0BAA0B,CAAC,WAAW,CAAC,CAAC;QACvD,OAAO,MAAM,EAAE,OAAO,EAAE,IAAI,KAAK,CAAC;IACpC,CAAC,EAAE,GAAG,IAAI,sBAAsB,CAAC,CAClC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,WAAyB,EACzB,GAAY;IAEZ,OAAO,CAAC,CAAC,IAAI,CACX,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,IAAI,EAAE,EACR,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,EAClD,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE;QACtB,IAAI,CAAC,WAAW;YAAE,OAAO,KAAK,CAAC;QAC/B,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;YAAE,OAAO,KAAK,CAAC;QAC5C,MAAM,MAAM,GAAG,0BAA0B,CAAC,WAAW,CAAC,CAAC;QACvD,OAAO,MAAM,EAAE,OAAO,EAAE,IAAI,KAAK,CAAC;IACpC,CAAC,EAAE,GAAG,IAAI,sBAAsB,CAAC,CAClC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nr1e/commons",
   "description": "Common utilities for TypeScript projects",
-  "version": "0.4.5",
+  "version": "0.4.6",
   "type": "module",
   "author": "NR1E, Inc.",
   "publishConfig": {
@@ -19,9 +19,11 @@
     "@eslint/js": "^9.39.3",
     "@types/node": "^24.10.13",
     "eslint": "9.39.3",
+    "libphonenumber-js": "^1.12.26",
     "prettier": "3.8.1",
     "typescript": "5.9.3",
     "typescript-eslint": "8.56.1",
+    "valibot": "^1.2.0",
     "vitest": "4.0.18"
   },
   "dependencies": {