tsp-scale-sdk 1.1.0 → 1.2.1

package/README.md

@@ -2,36 +2,42 @@
 
 Official Node.js SDK for TSP Scale.
 
-## Install
+## 🚀 Quick Start (Zero-Config)
 
+Initialize your project in seconds. This will link your project, create a secure hidden config, and add it to your `.gitignore` automatically.
+
+```bash
+npx tsp-scale init
+```
+
+### Manual Installation
+If you prefer manual setup:
 ```bash
 npm install tsp-scale-sdk
 ```
 
-## Usage
+## 🛠️ Usage
 
-```js
-const { TspScaleClient } = require("tsp-scale-sdk");
+```javascript
+const { TspScaleClient } = require('tsp-scale-sdk');
 
-const client = new TspScaleClient({
-  apiKey: process.env.TSP_API_KEY,
-  baseUrl: "https://api.tspscale.in/api/v1",
-});
-
-async function run() {
-  const result = await client.sendEmail({
-    from: "support@yourdomain.com",
-    to: "user@example.com",
-    subject: "Hello from TSP Scale",
-    html: "<h1>It works</h1>",
-  });
+// Authenticates automatically from local config or environment variables
+const client = new TspScaleClient();
 
-  console.log(result);
+async function sendTest() {
+    const res = await client.sendEmail({
+        to: "recipient@example.com",
+        subject: "Hello from TSP Scale",
+        html: "<h1>It works!</h1>"
+    });
+    console.log(res);
 }
 
 run().catch(console.error);
 ```
 
+> **Note**: The `from` field is optional if your API Key is locked to a specific sender identity.
+
 ### WhatsApp Messaging
 
 ```js

package/bin/tsp-scale.js

@@ -0,0 +1,142 @@
+#!/usr/bin/env node
+
+const { execSync } = require('child_process');
+const path = require('path');
+const os = require('os');
+const fs = require('fs');
+
+try {
+    const readline = require('readline');
+    const crypto = require('crypto');
+    const https = require('https');
+
+    function ask(question) {
+        const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+        return new Promise(resolve => rl.question(question, ans => { rl.close(); resolve(ans); }));
+    }
+
+    async function post(url, data) {
+        return new Promise((resolve, reject) => {
+            const req = https.request(url, {
+                method: 'POST',
+                headers: { 'Content-Type': 'application/json' }
+            }, res => {
+                let body = '';
+                res.on('data', chunk => body += chunk);
+                res.on('end', () => {
+                    try {
+                        resolve({ ok: res.statusCode < 300, json: () => JSON.parse(body) });
+                    } catch (e) {
+                        resolve({ ok: false, json: () => ({ message: 'Invalid JSON response from server' }) });
+                    }
+                });
+            });
+            req.on('error', reject);
+            req.write(JSON.stringify(data));
+            req.end();
+        });
+    }
+
+    async function init() {
+        console.log("\n🚀 TSP Scale SDK - Initializing Project\n");
+        const apiKey = await ask("🔑 Enter your API Key: ");
+        if (!apiKey) return console.error("Error: API Key is required.");
+
+        const projectIdentifier = await ask("📂 Enter Project Name: ");
+        const projectId = crypto.createHash('md5').update(process.cwd()).digest('hex');
+
+        console.log("⏳ Verifying with server...");
+
+        try {
+            const res = await post("https://api.tspscale.in/api/v1/apikeys/verify", {
+                key: apiKey,
+                projectId,
+                projectIdentifier: projectIdentifier || "NodeJS Project"
+            });
+            const result = await res.json();
+            if (!res.ok) throw new Error(result.message || "Verification failed");
+
+            // 1. Save to Global Vault (Fallback)
+            const configDir = path.join(os.homedir(), '.tsp-scale');
+            if (!fs.existsSync(configDir)) fs.mkdirSync(configDir, { recursive: true });
+            fs.writeFileSync(path.join(configDir, 'config.json'), JSON.stringify({ apiKey }, null, 2));
+
+            // 2. Save to Local Hidden Config (.tspscale) - Primary
+            fs.writeFileSync(path.join(process.cwd(), '.tspscale'), JSON.stringify({ apiKey, projectId }, null, 2));
+
+            // 3. Auto-GitIgnore
+            const gitignorePath = path.join(process.cwd(), '.gitignore');
+            const ignoreLine = '\n# TSP Scale Config\n.tspscale\n';
+            if (fs.existsSync(gitignorePath)) {
+                const content = fs.readFileSync(gitignorePath, 'utf8');
+                if (!content.includes('.tspscale')) fs.appendFileSync(gitignorePath, ignoreLine);
+            } else {
+                fs.writeFileSync(gitignorePath, ignoreLine);
+            }
+
+            console.log("\n✅ Success! Project linked and .tspscale config created.");
+            console.log(`📡 Status: ${result.status}\n`);
+            console.log(`🔒 Note: Added .tspscale to your .gitignore for security.\n`);
+
+            console.log("-------------------------------------------");
+            console.log("🚀 PRODUCTION DEPLOYMENT GUIDE");
+            console.log("-------------------------------------------");
+            console.log("When you deploy to Railway, Vercel, or a VPS,");
+            console.log("add these two Environment Variables:");
+            console.log("");
+            console.log(`  TSP_API_KEY      = ${apiKey}`);
+            console.log(`  TSP_PROJECT_ID   = ${projectId}`);
+            console.log("-------------------------------------------\n");
+
+            const install = await ask("📦 Would you like to install the 'tsp-scale-sdk' in this project? (y/n): ");
+            if (install.toLowerCase() === 'y') {
+                console.log("⏳ Installing...");
+                try {
+                    execSync('npm install tsp-scale-sdk', { stdio: 'inherit' });
+                    console.log("\n✅ SDK installed successfully!");
+                } catch (e) {
+                    console.error("\n❌ Installation failed. Please run 'npm install tsp-scale-sdk' manually.");
+                }
+            }
+
+            const example = await ask("📄 Would you like to generate a sample 'tsp-test.js' script? (y/n): ");
+            if (example.toLowerCase() === 'y') {
+                const sampleCode = `const { TspScaleClient } = require('tsp-scale-sdk');
+
+// Smart Auth: Automatically uses .tspscale or environment variables
+const client = new TspScaleClient();
+
+async function main() {
+    console.log("Sending test email...");
+    try {
+        const res = await client.sendEmail({
+            // 'from' is optional if your key is locked to a sender identity
+            to: "recipient@example.com", 
+            subject: "TSP Scale Test",
+            html: "<h1>It works!</h1>"
+        });
+        console.log("Response:", res);
+    } catch (err) {
+        console.error("Error:", err.message);
+    }
+}
+
+main();`;
+                fs.writeFileSync(path.join(process.cwd(), "tsp-test.js"), sampleCode);
+                console.log("\n✅ 'tsp-test.js' created. Run it with: node tsp-test.js");
+            }
+        } catch (err) {
+            console.error(`\n❌ Error: ${err.message}`);
+        }
+    }
+
+    const command = process.argv[2];
+    if (command === 'init') {
+        init();
+    } else {
+        console.log("Usage: npx tsp-scale-sdk init");
+    }
+
+} catch (err) {
+    console.error("Initialization failed:", err.message);
+}

package/dist/index.d.ts

@@ -1,3 +1,9 @@
+export type EmailAttachment = {
+  filename: string;
+  contentType: string;
+  content: string;
+};
+
 export type SendEmailPayload = {
   to: string;
   from: string;
@@ -6,11 +12,37 @@ export type SendEmailPayload = {
   html?: string;
   bodyText?: string;
   bodyHtml?: string;
-  attachments?: Array<{
-    filename: string;
-    contentType: string;
-    content: string;
-  }>;
+  priority?: number;
+  region?: string;
+  category?: string;
+  attachments?: EmailAttachment[];
+  expiresIn?: number;
+  useGhost?: boolean;
+  runForensics?: boolean;
+  isLocked?: boolean;
+  scheduledAt?: string;
+  templateId?: string;
+  viewPassword?: string;
+};
+
+export type SendEmailStatus = "QUEUED" | "SANDBOX_DELIVERED";
+
+export type SendEmailResponse = {
+  id: string;
+  status: SendEmailStatus;
+  message?: string;
+};
+
+export type SendWhatsAppPayload = {
+  to: string;
+  text: string;
+  mediaUrl?: string;
+  configId?: string;
+};
+
+export type SendWhatsAppResponse = {
+  success: true;
+  message: string;
 };
 
 export type TspScaleClientOptions = {
@@ -23,5 +55,6 @@ export type TspScaleClientOptions = {
 
 export declare class TspScaleClient {
   constructor(options: TspScaleClientOptions);
-  sendEmail(payload: SendEmailPayload): Promise<{ message: string; emailId: string }>;
+  sendEmail(payload: SendEmailPayload): Promise<SendEmailResponse>;
+  sendWhatsApp(payload: SendWhatsAppPayload): Promise<SendWhatsAppResponse>;
 }

package/dist/index.js

@@ -1,2 +1,2 @@
-var m=require("crypto"),y={prod:"https://api.tspscale.in/api/v1",staging:"https://staging-api.tspscale.in/api/v1",local:"http://localhost:4000/api/v1"};function g(l){if(l.baseUrl)return l.baseUrl;let t=(l.env||"prod").toLowerCase();return y[t]||y.prod}var d=class{constructor(t){if(!t||!t.apiKey)throw new Error("apiKey is required");if(this.apiKey=t.apiKey,this.baseUrl=g(t).replace(/\/+$/,""),this.timeoutMs=t.timeoutMs||15e3,this.fetchImpl=t.fetchImpl||globalThis.fetch,typeof this.fetchImpl!="function")throw new Error("Fetch implementation is not available. Use Node 18+ or pass fetchImpl.")}async sendEmail(t){let e="/emails/send",c=`${this.baseUrl}${e}`,a=JSON.stringify(t||{}),n=Date.now().toString(),o=m.randomBytes(16).toString("hex"),h=this._sign({timestamp:n,nonce:o,method:"POST",path:e,body:a}),p=new AbortController,u=setTimeout(()=>p.abort(),this.timeoutMs);try{let s=await this.fetchImpl(c,{method:"POST",headers:{"Content-Type":"application/json","x-api-key":this.apiKey,"x-tsp-client":"tsp-scale-sdk/1.0.0","x-tsp-timestamp":n,"x-tsp-nonce":o,"x-tsp-signature":h},body:a,signal:p.signal}),r=await s.json().catch(()=>({}));if(!s.ok){let i=new Error(r?.error||`Request failed with status ${s.status}`);throw i.status=s.status,i.response=r,i}return r}finally{clearTimeout(u)}}async sendWhatsApp(t){let e="/whatsapp/messages/send",c=`${this.baseUrl}${e}`,a=JSON.stringify(t||{}),n=Date.now().toString(),o=m.randomBytes(16).toString("hex"),h=this._sign({timestamp:n,nonce:o,method:"POST",path:e,body:a}),p=new AbortController,u=setTimeout(()=>p.abort(),this.timeoutMs);try{let s=await this.fetchImpl(c,{method:"POST",headers:{"Content-Type":"application/json","x-api-key":this.apiKey,"x-tsp-client":"tsp-scale-sdk/1.0.0","x-tsp-timestamp":n,"x-tsp-nonce":o,"x-tsp-signature":h},body:a,signal:p.signal}),r=await s.json().catch(()=>({}));if(!s.ok){let i=new Error(r?.error||`Request failed with status ${s.status}`);throw i.status=s.status,i.response=r,i}return r}finally{clearTimeout(u)}}_sign({timestamp:t,nonce:e,method:c,path:a,body:n}){let o=`${t}.${e}.${c}.${a}.${n}`;return m.createHmac("sha256",this.apiKey).update(o).digest("hex")}};module.exports={TspScaleClient:d};
+var d=require("crypto"),m="1.2.1",y={prod:"https://api.tspscale.in/api/v1",staging:"https://staging-api.tspscale.in/api/v1",local:"http://localhost:4000/api/v1"};function g(l){if(l.baseUrl)return l.baseUrl;let t=(l.env||"prod").toLowerCase();return y[t]||y.prod}var f=class{constructor(t){let s={};typeof t=="string"?s={apiKey:t}:s=t||{};let e=require("fs"),o=require("path"),a=require("os"),n=this._loadLocalConfig();if(this.apiKey=s.apiKey||process.env.TSP_API_KEY||n.apiKey||this._loadGlobalKey(),this.projectId=s.projectId||process.env.TSP_PROJECT_ID||n.projectId,this.apiKey||console.warn("\u26A0\uFE0F TSP Scale: No API Key found. Run 'npx tsp-scale init'."),this.baseUrl=g(s).replace(/\/+$/,""),this.timeoutMs=s.timeoutMs||15e3,this.fetchImpl=s.fetchImpl||globalThis.fetch,typeof this.fetchImpl!="function")throw new Error("Fetch implementation is not available. Use Node 18+ or pass fetchImpl.")}_loadLocalConfig(){try{let t=require("fs"),e=require("path").join(process.cwd(),".tspscale");if(t.existsSync(e))return JSON.parse(t.readFileSync(e,"utf8"))}catch{}return{}}_loadGlobalKey(){try{let t=require("fs"),s=require("path"),e=require("os"),o=s.join(e.homedir(),".tsp-scale","config.json");if(t.existsSync(o))return JSON.parse(t.readFileSync(o,"utf8")).apiKey}catch{}return null}async sendEmail(t){let s="/emails/send",e=`${this.baseUrl}${s}`,o=JSON.stringify(t||{}),a=Date.now().toString(),n=d.randomBytes(16).toString("hex"),h=this._sign({timestamp:a,nonce:n,method:"POST",path:s,body:o}),p=new AbortController,u=setTimeout(()=>p.abort(),this.timeoutMs);try{let i=await this.fetchImpl(e,{method:"POST",headers:{"Content-Type":"application/json","x-api-key":this.apiKey,"x-tsp-client":`tsp-scale-sdk/${m}`,"x-tsp-timestamp":a,"x-tsp-nonce":n,"x-tsp-signature":h,...this.projectId?{"x-tsp-project-id":this.projectId}:{}},body:o,signal:p.signal}),r=await i.json().catch(()=>({}));if(!i.ok){let c=new Error(r?.error||`Request failed with status ${i.status}`);throw c.status=i.status,c.response=r,c}return r}finally{clearTimeout(u)}}async sendWhatsApp(t){let s="/whatsapp/messages/send",e=`${this.baseUrl}${s}`,o=JSON.stringify(t||{}),a=Date.now().toString(),n=d.randomBytes(16).toString("hex"),h=this._sign({timestamp:a,nonce:n,method:"POST",path:s,body:o}),p=new AbortController,u=setTimeout(()=>p.abort(),this.timeoutMs);try{let i=await this.fetchImpl(e,{method:"POST",headers:{"Content-Type":"application/json","x-api-key":this.apiKey,"x-tsp-client":`tsp-scale-sdk/${m}`,"x-tsp-timestamp":a,"x-tsp-nonce":n,"x-tsp-signature":h},body:o,signal:p.signal}),r=await i.json().catch(()=>({}));if(!i.ok){let c=new Error(r?.error||`Request failed with status ${i.status}`);throw c.status=i.status,c.response=r,c}return r}finally{clearTimeout(u)}}_sign({timestamp:t,nonce:s,method:e,path:o,body:a}){let n=`${t}.${s}.${e}.${o}.${a}`;return d.createHmac("sha256",this.apiKey).update(n).digest("hex")}};module.exports={TspScaleClient:f};
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "tsp-scale-sdk",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "Official Node.js client for TSP Scale Email and WhatsApp API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "TSP Scale",
   "license": "MIT",
   "homepage": "https://tspscale.in",
+  "bin": {
+    "tsp-scale": "./bin/tsp-scale.js"
+  },
   "keywords": [
     "tsp",
     "smtp",