@power-rent/phone-validation-adapter 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Power Rent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,459 @@
+# Phone Validation Adapter
+
+REST API adapter for phone number validation using Twilio Lookup API. This project was created to solve a critical issue: legacy applications running on Node.js < 14 cannot directly install the Twilio SDK due to version incompatibility. This adapter provides a simple REST interface that allows legacy systems to validate phone numbers by calling this service, eliminating the need to upgrade their entire Node.js infrastructure.
+
+## Setup
+
+### Prerequisites
+
+- Node.js >= 18.0.0
+- Twilio Account with API credentials
+
+### Installation
+
+```bash
+npm install
+```
+
+### Environment Variables
+
+Create a `.env` file in the root directory:
+
+```
+TWILIO_ACCOUNT_SID=your_account_sid
+TWILIO_AUTH_TOKEN=your_auth_token
+PORT=3000
+```
+
+**Important:** The `TWILIO_ACCOUNT_SID` and `TWILIO_AUTH_TOKEN` are required. Without them, the validation service will return HTTP 503.
+
+### API Key Configuration
+
+All requests to the validation endpoint require an API key and project name for authentication. API keys are stored in `src/validApiKeys.ts`:
+
+```typescript
+const validApiKeys: Record<string, string> = {
+  RLC: process.env.API_KEY_RLC || '',
+  TJS: process.env.API_KEY_TJS || ''
+};
+```
+
+**Project Names:**
+- `RLC` - Power Rent Rental Company
+- `TJS` - TJ Services
+
+**To add a new project:**
+
+1. Add environment variable to `.env`:
+```
+API_KEY_NEW_PROJECT="your-secret-api-key"
+```
+
+2. Update `src/validApiKeys.ts`:
+```typescript
+const validApiKeys: Record<string, string> = {
+  RLC: process.env.API_KEY_RLC || '',
+  TJS: process.env.API_KEY_TJS || '',
+  NEW_PROJECT: process.env.API_KEY_NEW_PROJECT || ''
+};
+```
+
+3. Rebuild and restart:
+```bash
+npm run build
+npm run start
+```
+
+**Important Security Notes:**
+- Never commit actual API keys to version control
+- Store keys in environment variables or a secrets manager
+- Each client application should have its own unique key
+- Rotate keys regularly (every 90 days recommended)
+
+## API Endpoints
+
+### POST /validate
+
+Validates a phone number using Twilio Lookup API.
+
+**Authentication Required:** `x-api-key` and `x-project-name` headers with valid credentials.
+
+#### Request
+
+```bash
+curl -X POST http://localhost:3000/validate \
+  -H "Content-Type: application/json" \
+  -H "x-api-key: apple-blossom-elephant-rocket" \
+  -H "x-project-name: RLC" \
+  -d '{"phoneNumber": "+1234567890"}'
+```
+
+Request body:
+
+```json
+{
+  "phoneNumber": "+1234567890"
+}
+```
+
+Request headers:
+
+| Header | Value | Required | Description |
+|--------|-------|----------|-------------|
+| `x-api-key` | API Key | Yes | Project-specific API key for authentication |
+| `x-project-name` | Project Name | Yes | Project identifier (RLC or TJS) |
+| `Content-Type` | application/json | Yes | Request content type |
+
+#### Response (Success - HTTP 200)
+
+```json
+{
+  "success": true,
+  "isValid": true
+}
+```
+
+#### Response (Invalid Number - HTTP 200)
+
+```json
+{
+  "success": true,
+  "isValid": false
+}
+```
+
+#### Response (Unauthorized - HTTP 401)
+
+Returned when API key or project name is missing or invalid:
+
+```json
+{
+  "success": false,
+  "error": "Invalid API key"
+}
+```
+
+Or:
+
+```json
+{
+  "success": false,
+  "error": "Invalid project name"
+}
+```
+
+#### Response (Client Error - HTTP 400)
+
+```json
+{
+  "success": false,
+  "error": "phoneNumber is required and must be a non-empty string"
+}
+```
+
+#### Response (Service Unavailable - HTTP 503)
+
+Returned when Twilio credentials are not configured:
+
+```json
+{
+  "success": false,
+  "error": "Validation service is temporarily unavailable"
+}
+```
+
+#### Response (Server Error - HTTP 500)
+
+Returned when Twilio API fails or times out:
+
+```json
+{
+  "success": false,
+  "error": "Phone validation failed. Please try again later."
+}
+```
+
+## Error Handling Flow
+
+This diagram shows how errors are handled at different stages:
+
+```
+POST /validate
+│
+├─ API Key Validation
+│  ├─ x-project-name header missing?
+│  │  └─ HTTP 401 (Unauthorized)
+│  │     └─ Client error: invalid project name
+│  │
+│  ├─ x-project-name exists in whitelist?
+│  │  └─ Continue to x-api-key validation
+│  │
+│  ├─ x-api-key header missing?
+│  │  └─ HTTP 401 (Unauthorized)
+│  │     └─ Client error: invalid API key
+│  │
+│  └─ x-api-key matches project?
+│     └─ Continue to Input validation
+│
+├─ Input Validation
+│  ├─ Missing or empty phoneNumber?
+│  │  └─ HTTP 400 (Bad Request)
+│  │     └─ Client error: invalid input
+│  │
+│  └─ phoneNumber is valid string?
+│     └─ Continue to Twilio validation
+│
+├─ Configuration Check (twilioLookupValidation.ts)
+│  ├─ TWILIO_ACCOUNT_SID missing?
+│  │  ├─ Throw ConfigurationError
+│  │  ├─ Log to Sentry
+│  │  └─ server.ts catches it
+│  │     └─ HTTP 503 (Service Unavailable)
+│  │        └─ User sees: "Service temporarily unavailable"
+│  │
+│  ├─ TWILIO_AUTH_TOKEN missing?
+│  │  ├─ Throw ConfigurationError
+│  │  ├─ Log to Sentry
+│  │  └─ server.ts catches it
+│  │     └─ HTTP 503 (Service Unavailable)
+│  │
+│  └─ Credentials OK?
+│     └─ Call Twilio API with 5s timeout
+│
+├─ Twilio API Call
+│  ├─ Request times out (> 5s)?
+│  │  ├─ Throw ValidationError
+│  │  ├─ Log to Sentry
+│  │  └─ server.ts catches it
+│  │     └─ HTTP 500 (Internal Server Error)
+│  │        └─ User sees: "Validation failed, try again"
+│  │
+│  ├─ Twilio API returns error?
+│  │  ├─ Throw ValidationError
+│  │  ├─ Log to Sentry
+│  │  └─ server.ts catches it
+│  │     └─ HTTP 500 (Internal Server Error)
+│  │
+│  ├─ Phone is valid?
+│  │  └─ Return true
+│  │     └─ HTTP 200 + isValid: true
+│  │        └─ User can submit form
+│  │
+│  └─ Phone is invalid?
+│     └─ Return false
+│        └─ HTTP 200 + isValid: false
+│           └─ User sees validation error message
+│
+└─ Error Logging (All paths)
+   └─ Sentry with error type tag
+      ├─ ConfigurationError → errorType: 'configuration'
+      └─ ValidationError → errorType: 'validation'
+```
+
+## Key Design Decisions
+
+### 1. Explicit Error Types
+
+Two custom error classes distinguish between different failure modes:
+
+- **ConfigurationError**: Missing Twilio credentials (HTTP 503)
+- **ValidationError**: Twilio API failures or timeouts (HTTP 500)
+
+This prevents silent failures where configuration problems would be masked as valid numbers.
+
+### 2. Timeout Protection
+
+Twilio API calls have a 5-second timeout. If exceeded:
+- ValidationError is thrown
+- HTTP 500 is returned
+- User is informed of the failure
+
+### 3. No Silent Failures
+
+Previous implementation returned `true` for missing credentials. This caused:
+- Users to believe their phone was validated
+- Form submissions with invalid phone numbers
+- Data quality issues
+
+Current implementation:
+- Fails explicitly with HTTP 503
+- Informs users the service is unavailable
+- Prevents invalid data submission
+
+## Architecture & Security
+
+This adapter is designed as a **backend microservice** that bridges the gap between legacy applications and Twilio. Understanding the architecture is critical for proper deployment and security.
+
+### Client-Server Architecture
+
+```
+┌─────────────────────────────────┐
+│  Client Application             │
+│  (Frontend/Backend/Legacy app)  │
+└────────────┬────────────────────┘
+             │ HTTP POST /validate
+             │ with x-api-key header
+             ↓
+┌─────────────────────────────────────────────┐
+│  Phone Validation Adapter                   │
+│  (this service)                             │
+│  ✓ Validates API key                        │
+│  ✓ Validates phone number format            │
+│  ✓ Calls Twilio API                         │
+│  ✓ Returns validation result                │
+└────────────┬────────────────────────────────┘
+             │
+             ↓
+     ┌───────────────────┐
+     │   Twilio API      │
+     └───────────────────┘
+```
+
+### Backend Responsibilities
+
+The backend service (this adapter) is responsible for:
+
+1. **Store API Keys Securely**
+
+   API keys should **never** be hardcoded in production. Instead, use one of these approaches:
+
+   - **Environment Variables** (recommended for simple deployments):
+     ```bash
+     VALID_API_KEYS=key1,key2,key3
+     ```
+
+   - **Secrets Manager** (AWS Secrets Manager, HashiCorp Vault, etc.):
+     ```typescript
+     // Pseudo-code
+     const keys = await secretsManager.getSecret('phone-validation-keys');
+     ```
+
+   - **Database** (for dynamic key management):
+     ```typescript
+     // Pseudo-code
+     const keys = await database.query('SELECT api_key FROM valid_keys WHERE active = true');
+     ```
+
+2. **Issue Keys to Clients**
+
+   Provide a secure endpoint where authenticated clients can request API keys:
+
+   ```typescript
+   // Pseudo-code example
+   app.post('/api-keys/request', (req, res) => {
+     // Verify client identity (JWT, OAuth, mTLS, etc.)
+     // Generate or retrieve API key
+     // Return key to client
+     res.json({ apiKey: 'generated-key' });
+   });
+   ```
+
+   **Important:** This endpoint should:
+   - Require strong authentication (JWT, OAuth, mTLS)
+   - Rate limit requests
+   - Log all key requests
+   - Expire keys automatically
+   - Allow key rotation
+
+3. **Validate Keys Before Processing**
+
+   Always verify API keys on the server before calling Twilio:
+
+   ```typescript
+   // Current implementation does this via middleware
+   const authenticateApiKey = (req, res, next) => {
+     const apiKey = req.headers['x-api-key'];
+     const projectName = req.headers['x-project-name'];
+     
+     if (!checkIfKeyExists(projectName)) {
+       res.status(401).json({ error: 'Invalid project name' });
+       return;
+     }
+     
+     if (!isValidApiKey({ key: apiKey, projectName })) {
+       res.status(401).json({ error: 'Invalid API key' });
+       return;
+     }
+     next();
+   };
+   ```
+
+   Benefits:
+   - Keys never exposed to clients
+   - Project-specific key validation
+   - Prevents unauthorized Twilio API calls
+   - Reduces costs (Twilio charges per request)
+   - Enables per-project rate limiting
+   - Audit trail for all validation attempts
+
+### Frontend/Client Responsibilities
+
+Client applications should:
+
+1. **Never hardcode API keys** in frontend code
+2. **Request keys from backend** via secure endpoint
+3. **Pass keys in request headers** (`x-api-key`)
+4. **Handle 401 responses** gracefully
+5. **Implement retry logic** for transient failures
+
+Example client usage:
+
+```typescript
+// Get API key from backend (must be authenticated)
+const apiKey = await fetch('/api/phone-validation-key', {
+  headers: { Authorization: 'Bearer ' + userToken }
+}).then(r => r.json()).then(r => r.apiKey);
+
+// Get project name from backend config or user settings
+const projectName = 'RLC'; // or 'TJS'
+
+// Use key to validate phone
+const result = await fetch('https://validator-service.example.com/validate', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+    'x-api-key': apiKey,
+    'x-project-name': projectName
+  },
+  body: JSON.stringify({ phoneNumber: '+1234567890' })
+});
+```
+
+### Security Best Practices
+
+1. **Rotate API Keys Regularly** - Change keys every 90 days
+2. **Use HTTPS** - All communication must be encrypted
+3. **Rate Limit** - Prevent abuse of the validation endpoint
+4. **Monitor Usage** - Track validation requests and costs
+5. **Separate Credentials** - Twilio keys ≠ Adapter keys
+6. **Audit Logging** - Log all API key usage
+7. **Principle of Least Privilege** - Give clients minimum permissions needed
+
+## Development
+
+### Start Development Server
+
+```bash
+npm run dev
+```
+
+Server runs on `http://localhost:3000` by default.
+
+### Build
+
+```bash
+npm run build
+```
+
+Output goes to `dist/` directory.
+
+### Testing
+
+```bash
+npm run lint
+npm run format:check
+```
+
+## License
+
+MIT

package/dist/server.d.ts

@@ -0,0 +1 @@
+import "dotenv/config";

package/dist/server.js

@@ -0,0 +1,76 @@
+import "dotenv/config";
+import express from "express";
+import { twilioLookupValidation } from "./twilioLookupValidation.js";
+import isValidApiKey, { checkIfKeyExists } from "./utils.js";
+const app = express();
+const PORT = process.env.PORT || 3000;
+app.use(express.json());
+const authenticateApiKey = (req, res, next) => {
+    const apiKey = req.headers["x-api-key"];
+    const projectName = req.headers["x-project-name"];
+    if (!checkIfKeyExists(projectName)) {
+        res.status(401).json({
+            success: false,
+            error: "Invalid project name"
+        });
+        return;
+    }
+    if (!isValidApiKey({ key: apiKey, projectName })) {
+        res.status(401).json({
+            success: false,
+            error: "Invalid API key"
+        });
+        return;
+    }
+    next();
+};
+const validatePhoneNumber = (req, res, next) => {
+    const body = req.body;
+    const phoneNumber = body?.phoneNumber;
+    if (!phoneNumber || typeof phoneNumber !== "string" || phoneNumber.trim().length === 0) {
+        res.status(400).json({
+            success: false,
+            error: "phoneNumber is required and must be a non-empty string"
+        });
+        return;
+    }
+    next();
+};
+app.post("/validate", authenticateApiKey, validatePhoneNumber, async (req, res) => {
+    try {
+        const body = req.body;
+        const phoneNumber = body.phoneNumber;
+        const isValid = await twilioLookupValidation(phoneNumber);
+        res.json({
+            success: true,
+            isValid
+        });
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : "Unknown error";
+        const errorName = error instanceof Error ? error.name : "Error";
+        console.error("Error in /validate route:", { name: errorName, message: errorMessage });
+        if (errorName === "ConfigurationError") {
+            res.status(503).json({
+                success: false,
+                error: "Validation service is temporarily unavailable"
+            });
+            return;
+        }
+        res.status(500).json({
+            success: false,
+            error: "Phone validation failed. Please try again later."
+        });
+    }
+});
+app.use((err, _req, res, _next) => {
+    console.error("Middleware error:", err);
+    res.status(400).json({
+        success: false,
+        error: "Invalid JSON in request body"
+    });
+});
+app.listen(PORT, () => {
+    console.log(`Server is running on port ${PORT}`);
+});
+//# sourceMappingURL=server.js.map

package/dist/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AACvB,OAAO,OAA4C,MAAM,SAAS,CAAC;AAEnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,aAAa,EAAE,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE7D,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;AACtB,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC;AAEtC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;AAaxB,MAAM,kBAAkB,GAAG,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAQ,EAAE;IACnF,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,CAAW,CAAC;IAClD,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAW,CAAC;IAE5D,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,CAAC;QACnC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,sBAAsB;SAC9B,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;QACjD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,iBAAiB;SACzB,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,IAAI,EAAE,CAAC;AACT,CAAC,CAAC;AAGF,MAAM,mBAAmB,GAAG,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAQ,EAAE;IACpF,MAAM,IAAI,GAAG,GAAG,CAAC,IAA2B,CAAC;IAC7C,MAAM,WAAW,GAAG,IAAI,EAAE,WAAW,CAAC;IAEtC,IAAI,CAAC,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvF,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,wDAAwD;SAChE,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,IAAI,EAAE,CAAC;AACT,CAAC,CAAC;AAEF,GAAG,CAAC,IAAI,CACN,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,KAAK,EAAE,GAAY,EAAE,GAA+B,EAAiB,EAAE;IACrE,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,GAAG,CAAC,IAA2B,CAAC;QAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,WAAqB,CAAC;QAE/C,MAAM,OAAO,GAAG,MAAM,sBAAsB,CAAC,WAAW,CAAC,CAAC;QAE1D,GAAG,CAAC,IAAI,CAAC;YACP,OAAO,EAAE,IAAI;YACb,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;QAC9E,MAAM,SAAS,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;QAGhE,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;QAEvF,IAAI,SAAS,KAAK,oBAAoB,EAAE,CAAC;YACvC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACnB,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,+CAA+C;aACvD,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,kDAAkD;SAC1D,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CACF,CAAC;AAEF,GAAG,CAAC,GAAG,CAAC,CAAC,GAAU,EAAE,IAAa,EAAE,GAAa,EAAE,KAAmB,EAAQ,EAAE;IAE9E,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;IACxC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;QACnB,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,8BAA8B;KACtC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;IAEpB,OAAO,CAAC,GAAG,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;AACnD,CAAC,CAAC,CAAC"}

package/dist/twilioLookupValidation.d.ts

@@ -0,0 +1 @@
+export declare const twilioLookupValidation: (phoneNumber: string) => Promise<boolean>;

package/dist/twilioLookupValidation.js

@@ -0,0 +1,46 @@
+import twilio from "twilio";
+import * as Sentry from "@sentry/node";
+class ConfigurationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ConfigurationError";
+    }
+}
+class ValidationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ValidationError";
+    }
+}
+export const twilioLookupValidation = async (phoneNumber) => {
+    try {
+        const accountSid = process.env.TWILIO_ACCOUNT_SID;
+        const authToken = process.env.TWILIO_AUTH_TOKEN;
+        if (!accountSid || !authToken) {
+            const error = new ConfigurationError("TWILIO_ACCOUNT_SID or TWILIO_AUTH_TOKEN is not set");
+            console.error("ConfigurationError in twilioLookupValidation", error);
+            Sentry.captureException(error, {
+                tags: { errorType: "configuration", service: "twilio" }
+            });
+            throw error;
+        }
+        const client = twilio(accountSid, authToken);
+        const phone = phoneNumber.trim();
+        const response = await client.lookups.v2.phoneNumbers(phone).fetch();
+        return response.valid;
+    }
+    catch (error) {
+        if (error instanceof ConfigurationError) {
+            throw error;
+        }
+        const validationError = error instanceof ValidationError
+            ? error
+            : new ValidationError(error instanceof Error ? error.message : "Unknown error during phone validation");
+        console.error("ValidationError in twilioLookupValidation", validationError);
+        Sentry.captureException(validationError, {
+            tags: { errorType: "validation", service: "twilio" }
+        });
+        throw validationError;
+    }
+};
+//# sourceMappingURL=twilioLookupValidation.js.map

package/dist/twilioLookupValidation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"twilioLookupValidation.js","sourceRoot":"","sources":["../src/twilioLookupValidation.ts"],"names":[],"mappings":"AAEA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AAkBvC,MAAM,kBAAmB,SAAQ,KAAK;IACpC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AAED,MAAM,eAAgB,SAAQ,KAAK;IACjC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAED,MAAM,CAAC,MAAM,sBAAsB,GAAG,KAAK,EAAE,WAAmB,EAAoB,EAAE;IACpF,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;QAClD,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;QAEhD,IAAI,CAAC,UAAU,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,MAAM,KAAK,GAAG,IAAI,kBAAkB,CAAC,oDAAoD,CAAC,CAAC;YAE3F,OAAO,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,CAAC,CAAC;YACrE,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE;gBAC7B,IAAI,EAAE,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE;aACxD,CAAC,CAAC;YACH,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAC7C,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QAEjC,MAAM,QAAQ,GAAyB,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;QAE3F,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,kBAAkB,EAAE,CAAC;YACxC,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,eAAe,GACnB,KAAK,YAAY,eAAe;YAC9B,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,IAAI,eAAe,CACjB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,uCAAuC,CACjF,CAAC;QAGR,OAAO,CAAC,KAAK,CAAC,2CAA2C,EAAE,eAAe,CAAC,CAAC;QAC5E,MAAM,CAAC,gBAAgB,CAAC,eAAe,EAAE;YACvC,IAAI,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE;SACrD,CAAC,CAAC;QACH,MAAM,eAAe,CAAC;IACxB,CAAC;AACH,CAAC,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,7 @@
+export declare const checkIfKeyExists: (key: string) => boolean;
+type Args = {
+    key: string;
+    projectName: string;
+};
+declare const isValidApiKey: ({ key, projectName }: Args) => boolean;
+export default isValidApiKey;

package/dist/utils.js

@@ -0,0 +1,14 @@
+import validApiKeys from "./validApiKeys.js";
+export const checkIfKeyExists = (key) => {
+    return Object.keys(validApiKeys).includes(key);
+};
+const isValidApiKey = ({ key, projectName }) => {
+    if (!key || !projectName)
+        return false;
+    const isValidProjectName = Object.keys(validApiKeys).includes(projectName);
+    if (!isValidProjectName)
+        return false;
+    return validApiKeys[projectName] === key;
+};
+export default isValidApiKey;
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAE7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAW,EAAE;IACvD,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AACjD,CAAC,CAAC;AAOF,MAAM,aAAa,GAAG,CAAC,EAAE,GAAG,EAAE,WAAW,EAAQ,EAAW,EAAE;IAC5D,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW;QAAE,OAAO,KAAK,CAAC;IACvC,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC3E,IAAI,CAAC,kBAAkB;QAAE,OAAO,KAAK,CAAC;IACtC,OAAO,YAAY,CAAC,WAAW,CAAC,KAAK,GAAG,CAAC;AAC3C,CAAC,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/validApiKeys.d.ts

@@ -0,0 +1,2 @@
+declare const validApiKeys: Record<string, string>;
+export default validApiKeys;

package/dist/validApiKeys.js

@@ -0,0 +1,6 @@
+const validApiKeys = {
+    RLC: process.env.API_KEY_RLC || "",
+    TJS: process.env.API_KEY_TJS || ""
+};
+export default validApiKeys;
+//# sourceMappingURL=validApiKeys.js.map

package/dist/validApiKeys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validApiKeys.js","sourceRoot":"","sources":["../src/validApiKeys.ts"],"names":[],"mappings":"AAAA,MAAM,YAAY,GAA2B;IAC3C,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE;IAClC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE;CACnC,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@power-rent/phone-validation-adapter",
+  "version": "1.0.0",
+  "description": "REST API for phone number validation using Twilio Lookup API",
+  "main": "./dist/server.js",
+  "types": "./dist/server.d.ts",
+  "type": "module",
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "build": "npm run clean && tsc",
+    "start": "node dist/server.js",
+    "dev": "tsx watch src/server.ts",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint 'src/**/*.{ts,tsx}'",
+    "lint:fix": "eslint 'src/**/*.{ts,tsx}' --fix",
+    "format": "prettier --write 'src/**/*.{ts,tsx}'",
+    "format:check": "prettier --check 'src/**/*.{ts,tsx}'",
+    "clean": "rm -rf dist",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "release": "npm run build && changeset publish"
+  },
+  "keywords": [
+    "phone",
+    "validation",
+    "adapter",
+    "twilio",
+    "e164",
+    "telephone",
+    "validator",
+    "strategy-pattern"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/power-rent/phone-validation-adapter.git"
+  },
+  "bugs": {
+    "url": "https://github.com/power-rent/phone-validation-adapter/issues"
+  },
+  "homepage": "https://github.com/power-rent/phone-validation-adapter#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.8",
+    "@types/express": "^5.0.6",
+    "@types/node": "^20.0.0",
+    "@types/supertest": "^6.0.3",
+    "@typescript-eslint/eslint-plugin": "^8.55.0",
+    "@typescript-eslint/parser": "^8.55.0",
+    "eslint": "^8.0.0",
+    "prettier": "^3.0.0",
+    "supertest": "^7.2.2",
+    "tsx": "^4.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^4.0.18"
+  },
+  "dependencies": {
+    "@sentry/node": "^7.120.0",
+    "dotenv": "^16.4.5",
+    "express": "^5.2.1",
+    "twilio": "^3.84.1"
+  }
+}