core-services-sdk 1.3.9 → 1.3.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-services-sdk",
-  "version": "1.3.9",
+  "version": "1.3.11",
   "main": "src/index.js",
   "type": "module",
   "scripts": {
@@ -23,9 +23,9 @@
     "@aws-sdk/credential-provider-node": "^3.862.0",
     "@sendgrid/mail": "^8.1.5",
     "amqplib": "^0.10.8",
-    "crypto": "^1.0.1",
     "dot": "^1.1.3",
     "fastify": "^5.4.0",
+    "google-libphonenumber": "^3.2.42",
     "http-status": "^2.1.0",
     "mongodb": "^6.18.0",
     "node-fetch": "^3.3.2",
@@ -40,4 +40,4 @@
     "url": "^0.11.4",
     "vitest": "^3.2.4"
   }
-}
+}

package/src/core/index.js

@@ -3,3 +3,4 @@ export * from './otp-generators.js'
 export * from './sanitize-objects.js'
 export * from './normalize-to-array.js'
 export * from './combine-unique-arrays.js'
+export * from './normalize-phone-number.js'

package/src/core/normalize-phone-number.js

@@ -0,0 +1,93 @@
+// src/core/phone-validate.js
+// Validate & normalize using google-libphonenumber
+
+import { PhoneNumberUtil, PhoneNumberFormat } from 'google-libphonenumber'
+
+const phoneUtil = PhoneNumberUtil.getInstance()
+
+/**
+ * Trim and remove invisible RTL markers that can sneak in from copy/paste.
+ * @param {string} input
+ * @returns {string}
+ */
+function clean(input) {
+  return String(input)
+    .trim()
+    .replace(/[\u200e\u200f]/g, '')
+}
+
+/**
+ * Convert a parsed libphonenumber object into a normalized result.
+ * @param {import('google-libphonenumber').PhoneNumber} parsed
+ * @returns {{e164:string,national:string,international:string,regionCode:string|undefined,type:number}}
+ */
+function toResult(parsed) {
+  return {
+    e164: phoneUtil.format(parsed, PhoneNumberFormat.E164),
+    national: phoneUtil.format(parsed, PhoneNumberFormat.NATIONAL),
+    international: phoneUtil.format(parsed, PhoneNumberFormat.INTERNATIONAL),
+    regionCode: phoneUtil.getRegionCodeForNumber(parsed),
+    type: phoneUtil.getNumberType(parsed),
+  }
+}
+
+/**
+ * Parse & validate an international number (must start with '+').
+ * Throws on invalid input.
+ *
+ * @param {string} input - International number, e.g. "+972541234567"
+ * @returns {{e164:string,national:string,international:string,regionCode:string|undefined,type:number}}
+ * @throws {Error} If the number is invalid
+ */
+export function normalizePhoneOrThrowIntl(input) {
+  try {
+    const parsed = phoneUtil.parseAndKeepRawInput(clean(input))
+    if (!phoneUtil.isValidNumber(parsed)) throw new Error('x')
+    return toResult(parsed)
+  } catch {
+    throw new Error('Invalid phone number')
+  }
+}
+
+/**
+ * Parse & validate a national number using a region hint.
+ * Throws on invalid input.
+ *
+ * @param {string} input - National number, e.g. "054-123-4567"
+ * @param {string} defaultRegion - ISO region like "IL" or "US"
+ * @returns {{e164:string,national:string,international:string,regionCode:string|undefined,type:number}}
+ * @throws {Error} If the number is invalid
+ */
+export function normalizePhoneOrThrowWithRegion(input, defaultRegion) {
+  try {
+    const parsed = phoneUtil.parseAndKeepRawInput(clean(input), defaultRegion)
+    if (!phoneUtil.isValidNumber(parsed)) throw new Error('x')
+    return toResult(parsed)
+  } catch {
+    throw new Error('Invalid phone number')
+  }
+}
+
+/**
+ * Smart normalization:
+ * - If input starts with '+', parse as international.
+ * - Otherwise require a defaultRegion and parse as national.
+ * Throws on invalid input or when defaultRegion is missing for non-international numbers.
+ *
+ * @param {string} input
+ * @param {{ defaultRegion?: string }} [opts]
+ * @returns {{e164:string,national:string,international:string,regionCode:string|undefined,type:number}}
+ * @throws {Error} If invalid or defaultRegion is missing for non-international input
+ */
+export function normalizePhoneOrThrow(input, opts = {}) {
+  const cleaned = clean(input)
+  if (/^\+/.test(cleaned)) {
+    return normalizePhoneOrThrowIntl(cleaned)
+  }
+  const { defaultRegion } = opts
+  if (!defaultRegion) {
+    // keep this one specific; your test relies on a different message here
+    throw new Error('defaultRegion is required for non-international numbers')
+  }
+  return normalizePhoneOrThrowWithRegion(cleaned, defaultRegion)
+}

package/tests/core/normalize-phone-number.unit.test.js

@@ -0,0 +1,115 @@
+import { describe, it, expect } from 'vitest'
+import { PhoneNumberUtil, PhoneNumberFormat } from 'google-libphonenumber'
+
+import {
+  normalizePhoneOrThrow,
+  normalizePhoneOrThrowIntl,
+  normalizePhoneOrThrowWithRegion,
+} from '../../src/core/normalize-phone-number.js'
+
+const phoneUtil = PhoneNumberUtil.getInstance()
+
+/**
+ * Get a valid example number for a given region from libphonenumber.
+ * This keeps tests stable across environments and avoids fake numbers.
+ * @param {string} region - e.g. "IL", "US"
+ */
+function exampleForRegion(region) {
+  const ex = phoneUtil.getExampleNumber(region)
+  return {
+    e164: phoneUtil.format(ex, PhoneNumberFormat.E164),
+    national: phoneUtil.format(ex, PhoneNumberFormat.NATIONAL),
+    region,
+  }
+}
+
+describe('phone normalization helpers', () => {
+  it('normalizePhoneOrThrowIntl: parses a valid international number (US)', () => {
+    const us = exampleForRegion('US')
+    const out = normalizePhoneOrThrowIntl(us.e164)
+    expect(out.e164).toBe(us.e164)
+    expect(out.regionCode).toBe('US')
+    expect(out.international).toMatch(/^\+1\b/)
+  })
+
+  it('normalizePhoneOrThrowWithRegion: parses a national number with region (IL)', () => {
+    const il = exampleForRegion('IL')
+    // introduce some separators/spaces to mimic user input
+    const dirty = `  ${il.national.replace(/\s/g, '-')}  `
+    const out = normalizePhoneOrThrowWithRegion(dirty, 'IL')
+    expect(out.e164).toBe(il.e164)
+    expect(out.regionCode).toBe('IL')
+    expect(out.international).toMatch(/^\+972/)
+  })
+
+  it('normalizePhoneOrThrow (smart): international path without region', () => {
+    const us = exampleForRegion('US')
+    const out = normalizePhoneOrThrow(us.e164)
+    expect(out.e164).toBe(us.e164)
+    expect(out.regionCode).toBe('US')
+  })
+
+  it('normalizePhoneOrThrow (smart): national path requires defaultRegion', () => {
+    const il = exampleForRegion('IL')
+    const dirty = il.national.replace(/\s/g, ' - ')
+    const out = normalizePhoneOrThrow(dirty, { defaultRegion: 'IL' })
+    expect(out.e164).toBe(il.e164)
+    expect(out.regionCode).toBe('IL')
+  })
+
+  it('normalizePhoneOrThrow (smart): throws if national with no defaultRegion', () => {
+    expect(() => normalizePhoneOrThrow('054-123-4567')).toThrow(
+      /defaultRegion is required/i,
+    )
+  })
+
+  it('all helpers: throw on truly invalid numbers', () => {
+    expect(() => normalizePhoneOrThrowIntl('++972')).toThrow(
+      /Invalid phone number/i,
+    )
+    expect(() => normalizePhoneOrThrowWithRegion('123', 'IL')).toThrow(
+      /Invalid phone number/i,
+    )
+    expect(() => normalizePhoneOrThrow('++972')).toThrow(
+      /Invalid phone number/i,
+    )
+  })
+
+  it('should normalize a valid international number', () => {
+    const result = normalizePhoneOrThrowIntl('+972523444444')
+
+    expect(result).toMatchObject({
+      e164: '+972523444444',
+      national: expect.stringContaining('052'),
+      international: expect.stringContaining('+972'),
+      regionCode: 'IL',
+      type: expect.any(Number), // e.g. 1 = MOBILE
+    })
+  })
+})
+
+describe('phone normalization — no region (international) & with region', () => {
+  // Valid full international IL mobile number (E.164)
+  const intlIl = '+972523444444' // 052-344-4444
+
+  it('normalizePhoneOrThrowIntl: accepts full international number without region', () => {
+    const out = normalizePhoneOrThrowIntl(intlIl)
+    expect(out.e164).toBe(intlIl)
+    expect(out.regionCode).toBe('IL')
+    expect(out.international).toMatch(/^\+972/)
+    expect(typeof out.type).toBe('number')
+  })
+
+  it('normalizePhoneOrThrow (smart): accepts +972... without defaultRegion', () => {
+    const out = normalizePhoneOrThrow(intlIl) // no opts.defaultRegion
+    expect(out.e164).toBe(intlIl)
+    expect(out.regionCode).toBe('IL')
+  })
+
+  it('normalizePhoneOrThrowWithRegion: accepts national number with region', () => {
+    const out = normalizePhoneOrThrowWithRegion('052-344-4444', 'IL')
+    expect(out.e164).toBe(intlIl)
+    expect(out.regionCode).toBe('IL')
+    expect(out.national).toMatch(/052/)
+  })
+})

package/tests/mailer/transport.factory.unit.test.js

@@ -1,9 +1,7 @@
+// @ts-nocheck
 import nodemailer from 'nodemailer'
-import { describe, it, expect, vi, beforeEach } from 'vitest'
 
-// ===================
-// SAFELY MOCK MODULES
-// ===================
+import { describe, it, expect, vi, beforeEach } from 'vitest'
 
 vi.mock('nodemailer', () => {
   const createTransport = vi.fn((options) => ({
@@ -17,23 +15,24 @@ vi.mock('nodemailer', () => {
   }
 })
 
-vi.mock('nodemailer-sendgrid-transport', () => ({
-  __esModule: true,
-  default: vi.fn((opts) => ({
-    sendgrid: true,
-    options: opts,
-  })),
-}))
+vi.mock('@sendgrid/mail', () => {
+  const setApiKey = vi.fn()
+  const send = vi.fn()
+  const sgMail = { setApiKey, send }
+  globalThis.__mockedSgMail__ = sgMail
+  return {
+    __esModule: true,
+    default: sgMail,
+  }
+})
 
 vi.mock('@aws-sdk/client-ses', () => {
-  const mockSesInstance = { mocked: true } // consistent reference
-  const sesClient = vi.fn(() => mockSesInstance)
-
-  globalThis.__mockedSesClient__ = sesClient
+  const mockSesInstance = { mocked: true }
+  const SESClient = vi.fn(() => mockSesInstance)
+  globalThis.__mockedSesClient__ = SESClient
   globalThis.__mockedSesInstance__ = mockSesInstance
-
   return {
-    SESClient: sesClient,
+    SESClient,
     SendRawEmailCommand: 'mocked-command',
   }
 })
@@ -41,15 +40,9 @@ vi.mock('@aws-sdk/client-ses', () => {
 vi.mock('@aws-sdk/credential-provider-node', () => {
   const defaultProvider = vi.fn(() => 'mocked-default-provider')
   globalThis.__mockedDefaultProvider__ = defaultProvider
-  return {
-    defaultProvider,
-  }
+  return { defaultProvider }
 })
 
-// ==========================
-// NOW IMPORT MODULE UNDER TEST
-// ==========================
-
 import { TransportFactory } from '../../src/mailer/transport.factory.js'
 
 describe('TransportFactory', () => {
@@ -66,7 +59,6 @@ describe('TransportFactory', () => {
       auth: { user: 'user', pass: 'pass' },
     }
 
-    // @ts-ignore
     const transport = TransportFactory.create(config)
 
     expect(nodemailer.createTransport).toHaveBeenCalledWith({
@@ -75,8 +67,6 @@ describe('TransportFactory', () => {
       secure: config.secure,
       auth: config.auth,
     })
-
-    // @ts-ignore
     expect(transport.type).toBe('mock-transport')
   })
 
@@ -86,46 +76,33 @@ describe('TransportFactory', () => {
       auth: { user: 'user@gmail.com', pass: 'pass' },
     }
 
-    // @ts-ignore
     const transport = TransportFactory.create(config)
 
     expect(nodemailer.createTransport).toHaveBeenCalledWith({
       service: 'gmail',
       auth: config.auth,
     })
-
-    // @ts-ignore
     expect(transport.type).toBe('mock-transport')
   })
 
   it('should create sendgrid transport', () => {
     const config = {
       type: 'sendgrid',
-      apiKey: 'SG.xxxx',
+      apiKey: 'SG.key',
     }
 
-    // @ts-ignore
     const transport = TransportFactory.create(config)
 
-    // @ts-ignore
-    const args = nodemailer.createTransport.mock.calls[0][0]
-
-    expect(args).toEqual({
-      sendgrid: true,
-      options: {
-        auth: { api_key: config.apiKey },
-      },
-    })
+    expect(globalThis.__mockedSgMail__.setApiKey).toHaveBeenCalledWith(
+      config.apiKey,
+    )
+    expect(transport).toEqual(globalThis.__mockedSgMail__)
+  })
 
-    expect(transport).toEqual({
-      type: 'mock-transport',
-      options: {
-        sendgrid: true,
-        options: {
-          auth: { api_key: config.apiKey },
-        },
-      },
-    })
+  it('should throw if sendgrid API key is missing', () => {
+    expect(() => {
+      TransportFactory.create({ type: 'sendgrid' })
+    }).toThrow('Missing SendGrid API key')
   })
 
   it('should create ses transport with credentials', () => {
@@ -136,7 +113,6 @@ describe('TransportFactory', () => {
       region: 'us-west-2',
     }
 
-    // @ts-ignore
     const transport = TransportFactory.create(config)
 
     expect(globalThis.__mockedSesClient__).toHaveBeenCalledWith({
@@ -147,19 +123,14 @@ describe('TransportFactory', () => {
       },
     })
 
-    // @ts-ignore
     const args = nodemailer.createTransport.mock.calls[0][0]
-
     expect(args).toEqual({
       SES: {
         ses: globalThis.__mockedSesInstance__,
-        aws: {
-          SendRawEmailCommand: 'mocked-command',
-        },
+        aws: { SendRawEmailCommand: 'mocked-command' },
       },
     })
 
-    // @ts-ignore
     expect(transport.type).toBe('mock-transport')
   })
 
@@ -169,35 +140,27 @@ describe('TransportFactory', () => {
       region: 'us-east-1',
     }
 
-    // @ts-ignore
     const transport = TransportFactory.create(config)
 
     expect(globalThis.__mockedDefaultProvider__).toHaveBeenCalled()
-
     expect(globalThis.__mockedSesClient__).toHaveBeenCalledWith({
       region: config.region,
       credentials: 'mocked-default-provider',
     })
 
-    // @ts-ignore
     const args = nodemailer.createTransport.mock.calls[0][0]
-
     expect(args).toEqual({
       SES: {
         ses: globalThis.__mockedSesInstance__,
-        aws: {
-          SendRawEmailCommand: 'mocked-command',
-        },
+        aws: { SendRawEmailCommand: 'mocked-command' },
       },
     })
 
-    // @ts-ignore
     expect(transport.type).toBe('mock-transport')
   })
 
   it('should throw error for unsupported type', () => {
     expect(() => {
-      // @ts-ignore
       TransportFactory.create({ type: 'invalid' })
     }).toThrow('Unsupported transport type: invalid')
   })