npm - sms-verification-api - Versions diffs - 0.9.1 - Mend

sms-verification-api 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (50) hide show

package/.env.example +20 -0
package/DEPLOYMENT.md +151 -0
package/README.md +475 -0
package/docs/app/(home)/layout.tsx +7 -0
package/docs/app/(home)/page.tsx +38 -0
package/docs/app/docs/[[...slug]]/page.tsx +59 -0
package/docs/app/docs/layout.tsx +12 -0
package/docs/app/docs-og/[...slug]/route.ts +24 -0
package/docs/app/globals.css +587 -0
package/docs/app/layout.config.tsx +13 -0
package/docs/app/layout.tsx +27 -0
package/docs/app/logo.tsx +35 -0
package/docs/content/docs/API_AUTHENTICATION.md +91 -0
package/docs/content/docs/DEPLOYMENT.md +181 -0
package/docs/content/docs/api/post.mdx +35 -0
package/docs/content/docs/api/verify.mdx +34 -0
package/docs/content/docs/meta.json +8 -0
package/docs/content/docs/verify-legal-name.md +339 -0
package/docs/lib/source.ts +14 -0
package/docs/mdx-components.tsx +12 -0
package/docs/next.config.mjs +51 -0
package/docs/openapi.json +329 -0
package/docs/package.json +37 -0
package/docs/postcss.config.mjs +5 -0
package/docs/scripts/generate-docs.mjs +23 -0
package/docs/source.config.ts +5 -0
package/docs/tsconfig.json +29 -0
package/docs/worker.js +35 -0
package/docs/wrangler.toml +26 -0
package/examples/client.js +119 -0
package/examples/demo.html +325 -0
package/examples/libphonenumber-example.js +120 -0
package/openapi.json +329 -0
package/package.json +71 -0
package/scripts/deploy.sh +63 -0
package/src/identity-verification-server.ts +553 -0
package/src/index.js +8 -0
package/src/sns.js +236 -0
package/src/verify-phone-server.js +448 -0
package/src/verify-phone.ts +551 -0
package/test/api.test.js +201 -0
package/test/integration.test.js +152 -0
package/test/metadata-test.js +73 -0
package/test/server.test.js +143 -0
package/test/setup.js +32 -0
package/test/utils.test.js +186 -0
package/test/verify.test.js +23 -0
package/test/voip.test.js +112 -0
package/vitest.config.js +10 -0
package/wrangler.toml +27 -0

package/examples/demo.html ADDED Viewed

@@ -0,0 +1,325 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>SMS Verification API Demo</title>
+    <style>
+        body {
+            font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
+            max-width: 800px;
+            margin: 0 auto;
+            padding: 20px;
+            background-color: #f5f5f5;
+        }
+        .container {
+            background: white;
+            padding: 30px;
+            border-radius: 10px;
+            box-shadow: 0 2px 10px rgba(0,0,0,0.1);
+        }
+        h1 {
+            color: #333;
+            text-align: center;
+            margin-bottom: 30px;
+        }
+        .form-group {
+            margin-bottom: 20px;
+        }
+        label {
+            display: block;
+            margin-bottom: 5px;
+            font-weight: 600;
+            color: #555;
+        }
+        input, textarea, select {
+            width: 100%;
+            padding: 10px;
+            border: 1px solid #ddd;
+            border-radius: 5px;
+            font-size: 16px;
+            box-sizing: border-box;
+        }
+        button {
+            background: #007bff;
+            color: white;
+            padding: 12px 24px;
+            border: none;
+            border-radius: 5px;
+            cursor: pointer;
+            font-size: 16px;
+            margin-right: 10px;
+        }
+        button:hover {
+            background: #0056b3;
+        }
+        button:disabled {
+            background: #ccc;
+            cursor: not-allowed;
+        }
+        .result {
+            margin-top: 20px;
+            padding: 15px;
+            border-radius: 5px;
+            white-space: pre-wrap;
+            font-family: monospace;
+            font-size: 14px;
+        }
+        .success {
+            background: #d4edda;
+            border: 1px solid #c3e6cb;
+            color: #155724;
+        }
+        .error {
+            background: #f8d7da;
+            border: 1px solid #f5c6cb;
+            color: #721c24;
+        }
+        .info {
+            background: #d1ecf1;
+            border: 1px solid #bee5eb;
+            color: #0c5460;
+        }
+        .tabs {
+            display: flex;
+            margin-bottom: 20px;
+        }
+        .tab {
+            padding: 10px 20px;
+            cursor: pointer;
+            border: 1px solid #ddd;
+            background: #f8f9fa;
+            border-bottom: none;
+        }
+        .tab.active {
+            background: white;
+            border-bottom: 1px solid white;
+        }
+        .tab-content {
+            display: none;
+        }
+        .tab-content.active {
+            display: block;
+        }
+        .checkbox-group {
+            display: flex;
+            align-items: center;
+            gap: 10px;
+        }
+        .checkbox-group input[type="checkbox"] {
+            width: auto;
+        }
+    </style>
+</head>
+<body>
+    <div class="container">
+        <h1>SMS Verification API Demo</h1>
+        <div class="tabs">
+            <div class="tab active" onclick="showTab('send')">Send Verification</div>
+            <div class="tab" onclick="showTab('verify')">Verify Code</div>
+            <div class="tab" onclick="showTab('sms')">Send SMS</div>
+        </div>
+        <!-- Send Verification Tab -->
+        <div id="send" class="tab-content active">
+            <div class="form-group">
+                <label for="sendPhone">Phone Number:</label>
+                <input type="tel" id="sendPhone" placeholder="+1234567890" value="+1234567890">
+            </div>
+            <div class="form-group">
+                <label for="sendCode">Verification Code (optional):</label>
+                <input type="text" id="sendCode" placeholder="Leave empty for auto-generated">
+            </div>
+            <div class="form-group">
+                <label for="sendSenderId">Sender ID:</label>
+                <input type="text" id="sendSenderId" placeholder="Verify" value="Verify">
+            </div>
+            <div class="form-group">
+                <label for="sendMessageTemplate">Message Template:</label>
+                <textarea id="sendMessageTemplate" rows="3" placeholder="Your verification code is: {code}">Your verification code is: {code}</textarea>
+            </div>
+            <div class="form-group">
+                <label for="sendSmsType">SMS Type:</label>
+                <select id="sendSmsType">
+                    <option value="Transactional">Transactional</option>
+                    <option value="Promotional">Promotional</option>
+                </select>
+            </div>
+            <div class="form-group">
+                <div class="checkbox-group">
+                    <input type="checkbox" id="blockVoip">
+                    <label for="blockVoip">Block VoIP Numbers</label>
+                </div>
+            </div>
+            <button onclick="sendVerification()">Send Verification Code</button>
+            <div id="sendResult" class="result" style="display: none;"></div>
+        </div>
+        <!-- Verify Code Tab -->
+        <div id="verify" class="tab-content">
+            <div class="form-group">
+                <label for="verifyPhone">Phone Number:</label>
+                <input type="tel" id="verifyPhone" placeholder="+1234567890" value="+1234567890">
+            </div>
+            <div class="form-group">
+                <label for="verifyCode">Verification Code:</label>
+                <input type="text" id="verifyCode" placeholder="Enter the code you received">
+            </div>
+            <button onclick="verifyCode()">Verify Code</button>
+            <div id="verifyResult" class="result" style="display: none;"></div>
+        </div>
+        <!-- Send SMS Tab -->
+        <div id="sms" class="tab-content">
+            <div class="form-group">
+                <label for="smsPhone">Phone Number:</label>
+                <input type="tel" id="smsPhone" placeholder="+1234567890" value="+1234567890">
+            </div>
+            <div class="form-group">
+                <label for="smsMessage">Message:</label>
+                <textarea id="smsMessage" rows="4" placeholder="Enter your message here">Hello from the SMS API demo!</textarea>
+            </div>
+            <div class="form-group">
+                <label for="smsSenderId">Sender ID:</label>
+                <input type="text" id="smsSenderId" placeholder="Verify" value="Verify">
+            </div>
+            <div class="form-group">
+                <label for="smsType">SMS Type:</label>
+                <select id="smsType">
+                    <option value="Transactional">Transactional</option>
+                    <option value="Promotional">Promotional</option>
+                </select>
+            </div>
+            <button onclick="sendSMS()">Send SMS</button>
+            <div id="smsResult" class="result" style="display: none;"></div>
+        </div>
+    </div>
+    <script>
+        // Configuration
+        const API_BASE_URL = 'http://localhost:8787'; // Change to your deployed URL
+        const API_KEY = 'sms_1234567890abcdef1234567890abcdef'; // Change to your API key
+        function showTab(tabName) {
+            // Hide all tab contents
+            document.querySelectorAll('.tab-content').forEach(content => {
+                content.classList.remove('active');
+            });
+            // Remove active class from all tabs
+            document.querySelectorAll('.tab').forEach(tab => {
+                tab.classList.remove('active');
+            });
+            // Show selected tab content
+            document.getElementById(tabName).classList.add('active');
+            // Add active class to clicked tab
+            event.target.classList.add('active');
+        }
+        function showResult(elementId, data, isSuccess = true) {
+            const element = document.getElementById(elementId);
+            element.style.display = 'block';
+            element.className = `result ${isSuccess ? 'success' : 'error'}`;
+            element.textContent = JSON.stringify(data, null, 2);
+        }
+        async function sendVerification() {
+            const phoneNumber = document.getElementById('sendPhone').value;
+            const code = document.getElementById('sendCode').value;
+            const senderId = document.getElementById('sendSenderId').value;
+            const messageTemplate = document.getElementById('sendMessageTemplate').value;
+            const smsType = document.getElementById('sendSmsType').value;
+            const blockVoip = document.getElementById('blockVoip').checked;
+            try {
+                const response = await fetch(`${API_BASE_URL}/api/send`, {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': 'application/json',
+                        'X-API-Key': API_KEY
+                    },
+                    body: JSON.stringify({
+                        phoneNumber,
+                        code: code || undefined,
+                        senderId,
+                        messageTemplate,
+                        smsType,
+                        blockVoip
+                    })
+                });
+                const result = await response.json();
+                showResult('sendResult', result, result.success);
+            } catch (error) {
+                showResult('sendResult', { error: error.message }, false);
+            }
+        }
+        async function verifyCode() {
+            const phoneNumber = document.getElementById('verifyPhone').value;
+            const code = document.getElementById('verifyCode').value;
+            try {
+                const response = await fetch(`${API_BASE_URL}/api/verify`, {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': 'application/json',
+                        'X-API-Key': API_KEY
+                    },
+                    body: JSON.stringify({
+                        phoneNumber,
+                        code
+                    })
+                });
+                const result = await response.json();
+                showResult('verifyResult', result, result.success);
+            } catch (error) {
+                showResult('verifyResult', { error: error.message }, false);
+            }
+        }
+        async function sendSMS() {
+            const phoneNumber = document.getElementById('smsPhone').value;
+            const message = document.getElementById('smsMessage').value;
+            const senderId = document.getElementById('smsSenderId').value;
+            const smsType = document.getElementById('smsType').value;
+            try {
+                const response = await fetch(`${API_BASE_URL}/api/sms`, {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': 'application/json',
+                        'X-API-Key': API_KEY
+                    },
+                    body: JSON.stringify({
+                        phoneNumber,
+                        message,
+                        senderId,
+                        smsType
+                    })
+                });
+                const result = await response.json();
+                showResult('smsResult', result, result.success);
+            } catch (error) {
+                showResult('smsResult', { error: error.message }, false);
+            }
+        }
+        // Check server health on page load
+        window.addEventListener('load', async () => {
+            try {
+                const response = await fetch(`${API_BASE_URL}/health`);
+                const health = await response.json();
+                console.log('Server health:', health);
+            } catch (error) {
+                console.error('Server health check failed:', error);
+            }
+        });
+    </script>
+</body>
+</html>

package/examples/libphonenumber-example.js ADDED Viewed

@@ -0,0 +1,120 @@
+import verifyPhone from '../src/verify-phone.js';
+// Example 1: Using libphonenumber-js for VoIP detection with full metadata
+async function exampleWithLibPhoneNumberVoipDetection() {
+    try {
+        const result = await verifyPhone({
+            phoneNumber: '+1-800-555-0123',
+            code: '123456',
+            blockVoip: true,
+            voipDetectionMethod: 'libphonenumber', // Use local analysis instead of external API
+            useLibPhoneNumber: true, // Also use libphonenumber-js for formatting/validation
+            metadataType: 'full', // Use full metadata (140KB) for better phone type detection
+            messageTemplate: 'Your verification code is: {code}. Valid for 10 minutes.'
+        });
+        console.log('Result:', result);
+    } catch (error) {
+        console.error('Error:', error);
+    }
+}
+// Example 2: Using libphonenumber-js for phone number formatting and validation only
+async function exampleWithLibPhoneNumberFormatting() {
+    try {
+        const result = await verifyPhone({
+            phoneNumber: '555-123-4567', // US number without country code
+            code: '789012',
+            blockVoip: false, // Don't block VoIP numbers
+            useLibPhoneNumber: true, // Use libphonenumber-js for formatting/validation
+            senderId: 'MyApp',
+            smsType: 'Transactional'
+        });
+        console.log('Result:', result);
+    } catch (error) {
+        console.error('Error:', error);
+    }
+}
+// Example 3: Traditional approach (external API for VoIP detection)
+async function exampleWithExternalApi() {
+    try {
+        const result = await verifyPhone({
+            phoneNumber: '+44 20 7946 0958', // UK number
+            code: 'ABCDEF',
+            blockVoip: true,
+            voipDetectionMethod: 'api', // Use external API (default)
+            useLibPhoneNumber: false, // Use basic formatting/validation
+            messageTemplate: 'Welcome! Your code: {code}'
+        });
+        console.log('Result:', result);
+    } catch (error) {
+        console.error('Error:', error);
+    }
+}
+// Example 4: International number with libphonenumber-js
+async function exampleInternationalNumber() {
+    try {
+        const result = await verifyPhone({
+            phoneNumber: '49 30 12345678', // German number
+            code: 'GHIJKL',
+            blockVoip: true,
+            voipDetectionMethod: 'libphonenumber',
+            useLibPhoneNumber: true,
+            awsRegion: 'eu-west-1'
+        });
+        console.log('Result:', result);
+    } catch (error) {
+        console.error('Error:', error);
+    }
+}
+// Example 5: Comparing minimal vs full metadata
+async function exampleMetadataComparison() {
+    try {
+        console.log('=== Testing with minimal metadata (75KB) ===');
+        const resultMinimal = await verifyPhone({
+            phoneNumber: '+1-800-555-0123',
+            code: 'MIN123',
+            blockVoip: true,
+            voipDetectionMethod: 'libphonenumber',
+            useLibPhoneNumber: true,
+            metadataType: 'minimal' // Uses pattern-based heuristics
+        });
+        console.log('Minimal metadata result:', resultMinimal);
+        console.log('\n=== Testing with full metadata (140KB) ===');
+        const resultFull = await verifyPhone({
+            phoneNumber: '+1-800-555-0123',
+            code: 'FULL456',
+            blockVoip: true,
+            voipDetectionMethod: 'libphonenumber',
+            useLibPhoneNumber: true,
+            metadataType: 'full' // Uses phone number type detection
+        });
+        console.log('Full metadata result:', resultFull);
+    } catch (error) {
+        console.error('Error:', error);
+    }
+}
+// Run examples
+console.log('=== Example 1: VoIP Detection with libphonenumber-js ===');
+await exampleWithLibPhoneNumberVoipDetection();
+console.log('\n=== Example 2: Formatting with libphonenumber-js ===');
+await exampleWithLibPhoneNumberFormatting();
+console.log('\n=== Example 3: Traditional External API ===');
+await exampleWithExternalApi();
+console.log('\n=== Example 4: International Number ===');
+await exampleInternationalNumber();
+console.log('\n=== Example 5: Metadata Comparison ===');
+await exampleMetadataComparison();