sms-verification-api 0.9.1 → 0.9.7

package/src/verify-phone.ts

@@ -1,4 +1,4 @@
-import { parsePhoneNumber, isValidPhoneNumber as isValidPhoneNumberLib, getNumberType } from 'libphonenumber-js';
+import { parsePhoneNumber, getNumberType } from 'libphonenumber-js';
 
 interface VerifyPhoneOptions {
     /**
@@ -71,13 +71,26 @@ interface VerifyPhoneOptions {
  * @param {string} [options.messageTemplate] - Custom message template. Use {code} as placeholder for the code.
  * @returns {Promise<Object>} Response object with success status, message, messageId, and code
  */
-export default async function verifyPhone(options = {} as VerifyPhoneOptions) {
+export interface VerifyPhoneResult {
+    success: boolean;
+    message?: string;
+    messageId?: string;
+    code?: string;
+    phoneNumber?: string;
+    expiresIn?: number;
+    error?: string;
+    details?: string;
+    isVoip?: boolean;
+}
+
+export default async function verifyPhone(options: VerifyPhoneOptions = {} as VerifyPhoneOptions): Promise<VerifyPhoneResult> {
+    const env = (typeof process !== 'undefined' ? process.env : undefined) as Record<string, string | undefined> | undefined;
     var {
-        phoneNumber, 
+        phoneNumber,
         code,
-        accessKeyId = process?.env?.AWS_ACCESS_KEY_ID,
-        secretAccessKey = process?.env?.AWS_SECRET_ACCESS_KEY,
-        awsRegion = process?.env?.AWS_REGION,
+        accessKeyId = env?.AWS_ACCESS_KEY_ID,
+        secretAccessKey = env?.AWS_SECRET_ACCESS_KEY,
+        awsRegion = env?.AWS_REGION,
         blockVoip = false,
         voipDetectionMethod = 'api',
         useLibPhoneNumber = false,
@@ -154,10 +167,11 @@ export default async function verifyPhone(options = {} as VerifyPhoneOptions) {
         };
 
     } catch (error) {
+        const err = error as Error;
         return {
             success: false,
-            error: error.message,
-            details: error.stack || undefined
+            error: err?.message ?? String(error),
+            details: err?.stack || undefined
         };
     }
 }
@@ -167,7 +181,7 @@ export default async function verifyPhone(options = {} as VerifyPhoneOptions) {
  * @param {string} phone - The input phone number
  * @returns {string} - The formatted E.164 phone number
  */
-function formatPhoneNumberLibPhoneNumber(phone) {
+function formatPhoneNumberLibPhoneNumber(phone: string): string {
     try {
         const phoneNumber = parsePhoneNumber(phone);
         if (phoneNumber && phoneNumber.isValid()) {
@@ -186,7 +200,7 @@ function formatPhoneNumberLibPhoneNumber(phone) {
  * @param {string} phone - The input phone number
  * @returns {string} - The formatted E.164 phone number
  */
-function formatPhoneNumber(phone) {
+function formatPhoneNumber(phone: string): string {
     const cleaned = phone.replace(/\D/g, '');
 
     if (cleaned.length === 10) {
@@ -204,7 +218,7 @@ function formatPhoneNumber(phone) {
  * @param {boolean} useLibPhoneNumber - Whether to use libphonenumber-js for validation
  * @returns {boolean} - True if valid, false otherwise
  */
-function isValidPhoneNumber(phone, useLibPhoneNumber = false) {
+function isValidPhoneNumber(phone: string, useLibPhoneNumber = false): boolean {
     if (useLibPhoneNumber) {
         try {
             const phoneNumber = parsePhoneNumber(phone);
@@ -224,25 +238,36 @@ function isValidPhoneNumber(phone, useLibPhoneNumber = false) {
 * Works directly in the browser using Web Crypto API
 */
 
+interface InternalSNSClientOptions {
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    awsRegion?: string;
+}
+
 class SNSClient {
-    constructor(options = {}) {
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    region: string;
+    endpoint: string;
+
+    constructor(options: InternalSNSClientOptions = {}) {
         this.accessKeyId = options.accessKeyId;
         this.secretAccessKey = options.secretAccessKey;
         this.region = options.awsRegion || 'us-east-1';
         this.endpoint = `https://sns.${this.region}.amazonaws.com`;
     }
 
-    stringToUint8Array(str) {
+    stringToUint8Array(str: string): Uint8Array {
         return new TextEncoder().encode(str);
     }
 
-    arrayBufferToHex(buffer) {
-        return Array.from(new Uint8Array(buffer))
+    arrayBufferToHex(buffer: ArrayBuffer | Uint8Array): string {
+        return Array.from(new Uint8Array(buffer as ArrayBuffer))
             .map(b => b.toString(16).padStart(2, '0'))
             .join('');
     }
 
-    async sign(method, url, headers, payload) {
+    async sign(method: string, url: string, headers: Record<string, string>, payload: string): Promise<Record<string, string>> {
         const now = new Date();
         const amzDate = now.toISOString().replace(/[:\-]|\.\d{3}/g, '');
         const dateStamp = amzDate.slice(0, 8);
@@ -334,7 +359,7 @@ class SNSClient {
         return headers;
     }
 
-    async makeRequest(action, params = {}) {
+    async makeRequest(action: string, params: Record<string, string> = {}): Promise<{ MessageId?: string; raw?: string }> {
         const queryParams = new URLSearchParams({
             Action: action,
             Version: '2010-03-31',
@@ -363,11 +388,12 @@ class SNSClient {
 
             return this.parseXMLResponse(text);
         } catch (error) {
-            throw new Error(`SNS Request failed: ${error.message}`);
+            const message = error instanceof Error ? error.message : String(error);
+            throw new Error(`SNS Request failed: ${message}`);
         }
     }
 
-    parseXMLResponse(xmlText) {
+    parseXMLResponse(xmlText: string): { MessageId?: string; raw?: string } {
         const messageIdMatch = xmlText.match(/<MessageId>([^<]+)<\/MessageId>/);
         const errorCodeMatch = xmlText.match(/<Code>([^<]+)<\/Code>/);
         const errorMessageMatch = xmlText.match(/<Message>([^<]+)<\/Message>/);
@@ -391,7 +417,7 @@ class SNSClient {
  * @param {string} phone - The phone number in E.164 format (e.g., +1234567890).
  * @returns {Promise<boolean>} True if phone is Bandwidth-only VoIP
  */
-async function isPhoneNumberVoip(phone) {
+export async function isPhoneNumberVoip(phone: string): Promise<boolean> {
     try {
         const response = await fetch(`https://www.sent.dm/api/phone-lookup?phone=${encodeURIComponent(phone)}`, {
             headers: {
@@ -404,7 +430,7 @@ async function isPhoneNumberVoip(phone) {
             return false; // Default to allowing the number if lookup fails
         }
 
-        const phoneData = await response.json();
+        const phoneData = await response.json() as any;
 
         if (!phoneData || !phoneData.carrier) return false;
 
@@ -428,7 +454,7 @@ async function isPhoneNumberVoip(phone) {
  * @param {string} metadataType - Metadata type: 'minimal' (75KB) or 'full' (140KB)
  * @returns {Promise<boolean>} True if phone is likely VoIP
  */
-async function isPhoneNumberVoipLibPhoneNumber(phone, metadataType = 'minimal') {
+async function isPhoneNumberVoipLibPhoneNumber(phone: string, metadataType: 'minimal' | 'full' = 'minimal'): Promise<boolean> {
     try {
         // Parse the phone number using libphonenumber-js
         const phoneNumber = parsePhoneNumber(phone);

package/test/{api.test.js → api.test.ts}

@@ -1,11 +1,15 @@
 import { describe, it, expect, beforeEach } from 'vitest';
-import { createApp } from '../src/verify-phone-server.js';
+import { createApp } from '../src/verify-phone-server';
+
+declare global {
+  // eslint-disable-next-line no-var
+  var env: Record<string, string>;
+}
 
 describe('SMS Verification API', () => {
-  let app;
+  let app: ReturnType<typeof createApp>;
 
   beforeEach(() => {
-    // Create a fresh app instance for each test
     app = createApp(globalThis.env);
   });
 
@@ -13,7 +17,7 @@ describe('SMS Verification API', () => {
     it('should return health status', async () => {
       const req = new Request('http://localhost/health');
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(200);
       expect(data).toMatchObject({
@@ -27,7 +31,7 @@ describe('SMS Verification API', () => {
     it('should require API key authentication', async () => {
       const req = new Request('http://localhost/api/send-verification?phoneNumber=%2B1234567890');
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(401);
       expect(data).toMatchObject({
@@ -42,7 +46,7 @@ describe('SMS Verification API', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(401);
       expect(data).toMatchObject({
@@ -57,7 +61,7 @@ describe('SMS Verification API', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(200);
       expect(data.success).toBe(true);
@@ -70,7 +74,7 @@ describe('SMS Verification API', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(400);
       expect(data).toMatchObject({
@@ -85,7 +89,7 @@ describe('SMS Verification API', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(200);
       expect(data.success).toBe(true);
@@ -98,7 +102,7 @@ describe('SMS Verification API', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(200);
       expect(data.success).toBe(true);
@@ -111,7 +115,7 @@ describe('SMS Verification API', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(200);
       expect(data.success).toBe(true);
@@ -122,7 +126,7 @@ describe('SMS Verification API', () => {
     it('should require API key authentication', async () => {
       const req = new Request('http://localhost/api/verify-code?phoneNumber=%2B1234567890&code=123456');
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(401);
       expect(data).toMatchObject({
@@ -137,7 +141,7 @@ describe('SMS Verification API', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(401);
       expect(data).toMatchObject({
@@ -152,7 +156,7 @@ describe('SMS Verification API', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(400);
       expect(data).toMatchObject({
@@ -167,7 +171,7 @@ describe('SMS Verification API', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(400); // Will fail because no code was sent, but auth works
       expect(data.error).toBeDefined();
@@ -178,7 +182,7 @@ describe('SMS Verification API', () => {
     it('should serve OpenAPI documentation', async () => {
       const req = new Request('http://localhost/openapi.json');
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(200);
       expect(data).toMatchObject({

package/test/{integration.test.js → integration.test.ts}

@@ -1,8 +1,8 @@
 import { describe, it, expect, beforeEach } from 'vitest';
-import { createApp } from '../src/verify-phone-server.js';
+import { createApp } from '../src/verify-phone-server';
 
 describe('SMS Verification API Integration Tests', () => {
-  let app;
+  let app: ReturnType<typeof createApp>;
 
   beforeEach(() => {
     app = createApp(globalThis.env);
@@ -19,7 +19,7 @@ describe('SMS Verification API Integration Tests', () => {
         }
       });
       const res1 = await app.request(req1, globalThis.env);
-      const data1 = await res1.json();
+      const data1: any = await res1.json();
 
       expect(res1.status).toBe(200);
       expect(data1.success).toBe(true);
@@ -31,7 +31,7 @@ describe('SMS Verification API Integration Tests', () => {
         }
       });
       const res2 = await app.request(req2, globalThis.env);
-      const data2 = await res2.json();
+      const data2: any = await res2.json();
 
       expect(res2.status).toBe(200);
       expect(data2.success).toBe(true);
@@ -42,7 +42,7 @@ describe('SMS Verification API Integration Tests', () => {
 
       const req = new Request(`http://localhost/api/send-verification?phoneNumber=${encodeURIComponent(phoneNumber)}`);
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(401);
       expect(data.error).toBe('API key required');
@@ -57,7 +57,7 @@ describe('SMS Verification API Integration Tests', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(401);
       expect(data.error).toBe('Invalid API key');
@@ -81,7 +81,7 @@ describe('SMS Verification API Integration Tests', () => {
           }
         });
         const res = await app.request(req, globalThis.env);
-        const data = await res.json();
+        const data: any = await res.json();
 
         expect(res.status).toBe(200);
         expect(data.success).toBe(true);
@@ -104,7 +104,7 @@ describe('SMS Verification API Integration Tests', () => {
           }
         });
         const res = await app.request(req, globalThis.env);
-        const data = await res.json();
+        const data: any = await res.json();
 
         expect(res.status).toBe(400);
         expect(data.error).toBe('Invalid phone number format');
@@ -122,7 +122,7 @@ describe('SMS Verification API Integration Tests', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(200);
       expect(data).toMatchObject({
@@ -143,7 +143,7 @@ describe('SMS Verification API Integration Tests', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(400); // Will fail because no code was sent, but endpoint works
       expect(data.error).toBeDefined();

package/test/{server.test.js → server.test.ts}

@@ -21,7 +21,7 @@ describe('SMS Verification API Server', () => {
   describe('Health Check Endpoints', () => {
     it('should return API info on root endpoint', async () => {
       const res = await server.request('/');
-      const data = await res.json();
+      const data: any = await res.json();
       
       expect(res.status).toBe(200);
       expect(data.success).toBe(true);
@@ -31,7 +31,7 @@ describe('SMS Verification API Server', () => {
 
     it('should return health status', async () => {
       const res = await server.request('/health');
-      const data = await res.json();
+      const data: any = await res.json();
       
       expect(res.status).toBe(200);
       expect(data.success).toBe(true);
@@ -82,7 +82,7 @@ describe('SMS Verification API Server', () => {
   describe('Error Handling', () => {
     it('should return 404 for non-existent endpoints', async () => {
       const res = await server.request('/nonexistent');
-      const data = await res.json();
+      const data: any = await res.json();
       
       expect(res.status).toBe(404);
       expect(data.success).toBe(false);

package/test/{verify.test.js → verify.test.ts}

@@ -1,23 +1,20 @@
-import verifyPhone from '../src/verify-phone.js';
-import dotenv from 'dotenv';
-
-dotenv.config();
-
-// Basic usage with custom code
-const result = await verifyPhone({
-    phoneNumber: '+1234567890',
-    code: 'ABC123',
-    accessKeyId: process.env.AWS_ACCESS_KEY_ID,
-    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
-    awsRegion: 'us-east-1',
-    blockVoip: true,
-    senderId: 'MyApp',
-    messageTemplate: 'MyApp: Your code is {code}. Valid for 10 minutes.'
-});
-
-if (result.success) {
-    console.log('SMS sent successfully:', result.messageId);
-    console.log('Code sent:', result.code);
-} else {
-    console.error('Failed to send SMS:', result.error);
-}
+import verifyPhone from '../src/verify-phone';
+
+// Basic usage with custom code
+const result = await verifyPhone({
+    phoneNumber: '+1234567890',
+    code: 'ABC123',
+    accessKeyId: process.env.AWS_ACCESS_KEY_ID,
+    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
+    awsRegion: 'us-east-1',
+    blockVoip: true,
+    senderId: 'MyApp',
+    messageTemplate: 'MyApp: Your code is {code}. Valid for 10 minutes.'
+});
+
+if (result.success) {
+    console.log('SMS sent successfully:', result.messageId);
+    console.log('Code sent:', result.code);
+} else {
+    console.error('Failed to send SMS:', result.error);
+}

package/test/{voip.test.js → voip.test.ts}

@@ -1,8 +1,8 @@
 import { describe, it, expect, beforeEach } from 'vitest';
-import { createApp } from '../src/verify-phone-server.js';
+import { createApp } from '../src/verify-phone-server';
 
 describe('VoIP Blocking Functionality', () => {
-  let app;
+  let app: ReturnType<typeof createApp>;
 
   beforeEach(() => {
     app = createApp(globalThis.env);
@@ -16,7 +16,7 @@ describe('VoIP Blocking Functionality', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(200);
       expect(data.success).toBe(true);
@@ -29,7 +29,7 @@ describe('VoIP Blocking Functionality', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(200);
       expect(data.success).toBe(true);
@@ -42,7 +42,7 @@ describe('VoIP Blocking Functionality', () => {
         }
       });
       const res = await app.request(req, globalThis.env);
-      const data = await res.json();
+      const data: any = await res.json();
 
       expect(res.status).toBe(200);
       expect(data.success).toBe(true);
@@ -52,12 +52,13 @@ describe('VoIP Blocking Functionality', () => {
   describe('VoIP detection logic', () => {
     it('should correctly identify VoIP numbers', async () => {
       // Import the function from the module
-      const module = await import('../src/verify-phone-server.js');
+      const module = await import('../src/verify-phone-server');
       const { isPhoneNumberVoip } = module;
-      
+
       // Mock the grab function to return VoIP data
-      const originalGrab = globalThis.grab;
-      globalThis.grab = {
+      const g = globalThis as any;
+      const originalGrab = g.grab;
+      g.grab = {
         instance: () => ({
           "phone-lookup": async () => ({
             carrier: {
@@ -76,7 +77,7 @@ describe('VoIP Blocking Functionality', () => {
       expect(isVoip).toBe(true);
       
       // Mock the grab function to return mobile data
-      globalThis.grab = {
+      g.grab = {
         instance: () => ({
           "phone-lookup": async () => ({
             carrier: {
@@ -95,7 +96,7 @@ describe('VoIP Blocking Functionality', () => {
       expect(isMobile).toBe(false);
       
       // Mock the grab function to return null data
-      globalThis.grab = {
+      g.grab = {
         instance: () => ({
           "phone-lookup": async () => null
         })
@@ -106,7 +107,7 @@ describe('VoIP Blocking Functionality', () => {
       expect(isNull).toBe(false);
       
       // Restore original grab function
-      globalThis.grab = originalGrab;
+      g.grab = originalGrab;
     });
   });
 }); 

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "lib": ["ES2022"],
+    "types": ["@cloudflare/workers-types", "node"],
+    "strict": false,
+    "noImplicitAny": false,
+    "strictNullChecks": false,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "skipLibCheck": true,
+    "noEmit": true,
+    "allowJs": false,
+    "jsx": "react-jsx",
+    "forceConsistentCasingInFileNames": true,
+    "verbatimModuleSyntax": false
+  },
+  "include": ["src/**/*.ts", "test/**/*.ts", "examples/**/*.ts", "vitest.config.ts"],
+  "exclude": ["node_modules", "docs", ".wrangler", "dist"]
+}

package/{vitest.config.js → vitest.config.ts}

@@ -4,7 +4,7 @@ export default defineConfig({
   test: {
     globals: true,
     environment: 'node',
-    setupFiles: ['./test/setup.js'],
+    setupFiles: ['./test/setup.ts'],
     mockReset: true,
   },
 }); 

package/wrangler.toml

@@ -1,5 +1,5 @@
 name = "sms-verification-api"
-main = "src/index.js"
+main = "src/index.ts"
 compatibility_date = "2024-01-01"
 compatibility_flags = ["nodejs_compat"]
 
@@ -8,9 +8,6 @@ compatibility_flags = ["nodejs_compat"]
 AWS_REGION = "us-east-1"
 SMS_SENDER_ID = "Verify"
 
-# Secrets (these should be set via wrangler secret put)
-TRESTLE_API_KEY = "URx3hLxr6o9uSghxffe2S72oMXuM12Ry9zW80Src"
-
 # Staging environment
 [env.staging]
 name = "sms-verification-api-staging"