whatsapp-rpc 0.0.6 → 0.0.9

package/README.md

@@ -1,6 +1,7 @@
 # WhatsApp WEB RPC
 
 [![npm version](https://img.shields.io/npm/v/whatsapp-rpc.svg)](https://www.npmjs.com/package/whatsapp-rpc)
+[![PyPI version](https://img.shields.io/pypi/v/whatsapp-rpc.svg)](https://pypi.org/project/whatsapp-rpc/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 WebSocket JSON-RPC 2.0 API for QR Based WhatsApp Web.
@@ -64,7 +65,6 @@ Data Storage:
 ┌─────────────────────────────────────────────────────────┐
 │  data/                                                   │
 │  ├── whatsapp.db    (SQLite: session, contacts, history)│
-│  ├── qr/*.png       (QR code images)                    │
 │  └── groups.json    (Group cache)                       │
 └─────────────────────────────────────────────────────────┘
 ```
@@ -78,6 +78,9 @@ npx whatsapp-rpc restart         # Restart API server
 npx whatsapp-rpc status          # Check if running
 npx whatsapp-rpc api --foreground  # Run in foreground (for Docker)
 npx whatsapp-rpc build           # Build from source (requires Go)
+
+# Custom port
+npx whatsapp-rpc start --port 8080
 ```
 
 ## Docker
@@ -106,7 +109,7 @@ Connect via WebSocket to `ws://localhost:9400/ws/rpc` and send JSON-RPC 2.0 requ
 | `restart` | Full reset: logout, delete DB, cleanup, start fresh |
 | `reset` | Reset session (logout and delete credentials) |
 | `diagnostics` | Get detailed diagnostics information |
-| `qr` | Get QR code for pairing (code, filename, image_data as base64 PNG) |
+| `qr` | Get QR code for pairing (code, image_data as base64 PNG) |
 
 ### Messaging
 
@@ -172,7 +175,7 @@ The server pushes events as JSON-RPC notifications (no `id` field):
 | `event.connection_failure` | Connection failed |
 | `event.logged_out` | User logged out |
 | `event.temporary_ban` | Temporary ban received |
-| `event.qr_code` | New QR code available (code, filename, image_data) |
+| `event.qr_code` | New QR code available (code, image_data) |
 | `event.message_sent` | Message sent successfully |
 | `event.message_received` | New message received (includes forwarding info) |
 | `event.history_sync_complete` | History sync completed after first login |
@@ -334,6 +337,7 @@ The server pushes events as JSON-RPC notifications (no `id` field):
 | Variable | Default | Description |
 |----------|---------|-------------|
 | `PORT` | 9400 | WebSocket API port |
+| `WHATSAPP_RPC_PORT` | 9400 | WebSocket API port (alternative to `PORT`) |
 | `WHATSAPP_RPC_SKIP_BINARY_DOWNLOAD` | - | Set to `1` to skip binary download |
 | `WHATSAPP_RPC_PREFER_SOURCE` | - | Set to `1` to build from source if Go is installed |
 
@@ -342,7 +346,6 @@ The server pushes events as JSON-RPC notifications (no `id` field):
 | Path | Description |
 |------|-------------|
 | `data/whatsapp.db` | SQLite database (session, contacts, message history) |
-| `data/qr/*.png` | QR code images for pairing |
 | `data/groups.json` | Group cache (auto-generated on connection) |
 
 ## Building from Source
@@ -357,6 +360,33 @@ npm run build
 
 See [schema.json](schema.json) for complete OpenRPC specification.
 
+## Python Client
+
+An async Python client is available on PyPI:
+
+```bash
+pip install whatsapp-rpc
+```
+
+```python
+import asyncio
+from whatsapp_rpc import WhatsAppRPCClient
+
+async def main():
+    client = WhatsAppRPCClient("ws://localhost:9400/ws/rpc")
+    await client.connect()
+
+    status = await client.status()
+    print(status)
+
+    await client.send(phone="1234567890", type="text", message="Hello!")
+    await client.close()
+
+asyncio.run(main())
+```
+
+See [src/python/README.md](src/python/README.md) for full Python client documentation.
+
 ## Requirements
 
 - Node.js 18+

package/configs/config.yaml

@@ -2,6 +2,6 @@ environment: "development"
 log_level: 4
 server:
   port: 9400
-  host: "0.0.0.0"
+  host: "127.0.0.1"
 database:
   path: "data/whatsapp.db"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "whatsapp-rpc",
-  "version": "0.0.6",
+  "version": "0.0.9",
   "type": "module",
   "description": "WhatsApp WebSocket RPC Server with JSON-RPC 2.0 protocol",
   "author": "Rohit G <trohitg@gmail.com>",
@@ -44,8 +44,10 @@
     "status": "node scripts/cli.js status",
     "api": "node scripts/cli.js api --foreground",
     "web": "node scripts/cli.js web",
+    "prebuild": "node -e \"require('fs').existsSync('node_modules') || process.exit(1)\" || npm install",
     "build": "node scripts/cli.js build",
-    "clean": "node scripts/clean.cjs"
+    "preclean": "node -e \"require('fs').existsSync('node_modules') || process.exit(1)\" || npm install",
+    "clean": "node scripts/cli.js clean"
   },
   "dependencies": {
     "chalk": "^5.3.0",

package/scripts/cli.js

@@ -5,16 +5,25 @@ import { execa } from 'execa';
 import killPort from 'kill-port';
 import { Socket } from 'net';
 import { execSync, spawn } from 'child_process';
-import { existsSync, statSync, mkdirSync } from 'fs';
+import { existsSync, statSync, mkdirSync, rmSync, readdirSync, unlinkSync, readFileSync } from 'fs';
 import { dirname, join } from 'path';
 import { fileURLToPath } from 'url';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const ROOT = join(__dirname, '..');
-const API_PORT = 9400;
+const pkg = JSON.parse(readFileSync(join(ROOT, 'package.json'), 'utf8'));
+const DEFAULT_PORT = 9400;
 const BIN = process.platform === 'win32' ? 'whatsapp-rpc-server.exe' : 'whatsapp-rpc-server';
 const BIN_DIR = join(ROOT, 'bin');
 
+// Get port from environment or default
+const getPort = (opts = {}) => {
+  if (opts.port) return parseInt(opts.port, 10);
+  if (process.env.PORT) return parseInt(process.env.PORT, 10);
+  if (process.env.WHATSAPP_RPC_PORT) return parseInt(process.env.WHATSAPP_RPC_PORT, 10);
+  return DEFAULT_PORT;
+};
+
 const log = (m, c = 'blue') => console.log(chalk[c](m));
 const sleep = ms => new Promise(r => setTimeout(r, ms));
 
@@ -43,8 +52,11 @@ const hasGo = () => {
   catch { return false; }
 };
 
-async function api(foreground = false) {
-  if (await portUp(API_PORT)) { log(`API already running on port ${API_PORT}`, 'yellow'); return; }
+async function api(opts = {}) {
+  const port = getPort(opts);
+  const foreground = opts.foreground || false;
+
+  if (await portUp(port)) { log(`API already running on port ${port}`, 'yellow'); return; }
   const bin = join(BIN_DIR, BIN);
   if (!existsSync(bin)) {
     if (!hasGo()) {
@@ -59,27 +71,35 @@ async function api(foreground = false) {
     await build();
   }
 
+  // Pass port to Go binary via environment variable
+  const env = { ...process.env, WA_SERVER_PORT: String(port) };
+
   if (foreground) {
     // Run in foreground - will receive Ctrl+C signals
-    const proc = spawn(bin, [], { cwd: ROOT, stdio: 'inherit' });
+    const proc = spawn(bin, [], { cwd: ROOT, stdio: 'inherit', env });
     proc.on('close', (code) => process.exit(code || 0));
     process.on('SIGINT', () => { proc.kill('SIGINT'); });
     process.on('SIGTERM', () => { proc.kill('SIGTERM'); });
-    log(`API running: ws://localhost:${API_PORT}/ws/rpc`, 'green');
+    log(`API running: ws://localhost:${port}/ws/rpc`, 'green');
   } else {
     // Run detached in background
-    spawn(bin, [], { cwd: ROOT, detached: true, stdio: 'ignore' }).unref();
-    if (await wait(API_PORT)) log(`API started: ws://localhost:${API_PORT}/ws/rpc`, 'green');
+    spawn(bin, [], { cwd: ROOT, detached: true, stdio: 'ignore', env }).unref();
+    if (await wait(port)) log(`API started: ws://localhost:${port}/ws/rpc`, 'green');
     else log('API failed to start', 'red');
   }
 }
 
-async function start() { await api(); }
-async function stop() { await kill(API_PORT, 'API'); }
+async function start(opts = {}) { await api(opts); }
+
+async function stop(opts = {}) {
+  const port = getPort(opts);
+  await kill(port, 'API');
+}
 
-async function status() {
-  const a = await portUp(API_PORT);
-  log(`API (${API_PORT}): ${a ? 'UP' : 'DOWN'}`, a ? 'green' : 'red');
+async function status(opts = {}) {
+  const port = getPort(opts);
+  const a = await portUp(port);
+  log(`API (${port}): ${a ? 'UP' : 'DOWN'}`, a ? 'green' : 'red');
 }
 
 async function build() {
@@ -110,11 +130,58 @@ async function build() {
   log(`Built: ${BIN} (${(statSync(bin).size / 1024 / 1024).toFixed(1)}MB)`, 'green');
 }
 
-program.name('whatsapp-rpc').version('1.0.0');
-program.command('start').description('Start API server').action(start);
-program.command('stop').description('Stop API server').action(stop);
-program.command('restart').description('Restart API server').action(async () => { await stop(); await sleep(1000); await start(); });
-program.command('status').description('Show server status').action(status);
-program.command('api').description('Start API server').option('-f, --foreground', 'Run in foreground').action((opts) => api(opts.foreground));
+async function clean(opts = {}) {
+  const port = getPort(opts);
+
+  // Stop API server
+  log('Stopping API server...', 'blue');
+  await kill(port, 'API');
+
+  // Remove bin directory
+  if (existsSync(BIN_DIR)) {
+    rmSync(BIN_DIR, { recursive: true });
+    log('Removed bin/', 'green');
+  }
+
+  // Remove data directory
+  const dataDir = join(ROOT, 'data');
+  if (existsSync(dataDir)) {
+    rmSync(dataDir, { recursive: true });
+    log('Removed data/', 'green');
+  }
+
+  // Remove any .db files in project root (legacy locations)
+  readdirSync(ROOT).filter(f => f.endsWith('.db') || f.endsWith('.db-wal') || f.endsWith('.db-shm')).forEach(f => {
+    unlinkSync(join(ROOT, f));
+    log(`Removed ${f}`, 'green');
+  });
+
+  // Remove node_modules
+  const nodeModules = join(ROOT, 'node_modules');
+  if (existsSync(nodeModules)) {
+    rmSync(nodeModules, { recursive: true });
+    log('Removed node_modules/', 'green');
+  }
+
+  // Remove package-lock.json
+  const lockFile = join(ROOT, 'package-lock.json');
+  if (existsSync(lockFile)) {
+    unlinkSync(lockFile);
+    log('Removed package-lock.json', 'green');
+  }
+
+  log('Clean complete', 'green');
+}
+
+// Global port option for all commands
+const portOption = ['-p, --port <port>', 'API port (default: 9400, or PORT/WHATSAPP_RPC_PORT env var)'];
+
+program.name('whatsapp-rpc').version(pkg.version);
+program.command('start').description('Start API server').option(...portOption).action(start);
+program.command('stop').description('Stop API server').option(...portOption).action(stop);
+program.command('restart').description('Restart API server').option(...portOption).action(async (opts) => { await stop(opts); await sleep(1000); await start(opts); });
+program.command('status').description('Show server status').option(...portOption).action(status);
+program.command('api').description('Start API server').option('-f, --foreground', 'Run in foreground').option(...portOption).action(api);
 program.command('build').description('Build binary from source (requires Go)').action(build);
+program.command('clean').description('Full cleanup (stop server, remove bin/, data/, node_modules/)').action(clean);
 program.parse();

package/scripts/clean.cjs

@@ -1,63 +0,0 @@
-#!/usr/bin/env node
-// Standalone clean script - no npm dependencies required
-// Uses CommonJS for compatibility when node_modules doesn't exist
-const { existsSync, unlinkSync, readdirSync, rmSync } = require('fs');
-const { join } = require('path');
-const { execSync } = require('child_process');
-
-const ROOT = join(__dirname, '..');
-const BIN = process.platform === 'win32' ? 'whatsapp-rpc-server.exe' : 'whatsapp-rpc-server';
-const BIN_DIR = join(ROOT, 'bin');
-const API_PORT = 9400;
-
-const log = (msg, color) => {
-  const colors = { green: '\x1b[32m', blue: '\x1b[34m', yellow: '\x1b[33m', red: '\x1b[31m', reset: '\x1b[0m' };
-  console.log(`${colors[color] || ''}${msg}${colors.reset}`);
-};
-
-// Kill process on port
-const killPort = (port, name) => {
-  try {
-    if (process.platform === 'win32') {
-      execSync(`for /f "tokens=5" %a in ('netstat -aon ^| findstr :${port} ^| findstr LISTENING') do taskkill /F /PID %a`, { stdio: 'ignore', shell: 'cmd.exe' });
-    } else {
-      execSync(`lsof -ti:${port} | xargs kill -9 2>/dev/null || true`, { stdio: 'ignore' });
-    }
-    log(`${name} stopped`, 'green');
-  } catch { log(`${name} not running`, 'yellow'); }
-};
-
-log('Stopping API server...', 'blue');
-killPort(API_PORT, 'API');
-
-// Remove binary
-const bin = join(BIN_DIR, BIN);
-if (existsSync(bin)) { unlinkSync(bin); log(`Removed ${BIN}`, 'green'); }
-
-// Remove bin directory if empty
-if (existsSync(BIN_DIR) && readdirSync(BIN_DIR).length === 0) {
-  rmSync(BIN_DIR, { recursive: true }); log('Removed bin/', 'green');
-}
-
-// Remove data directory (database, QR codes, etc.)
-const dataDir = join(ROOT, 'data');
-if (existsSync(dataDir)) {
-  rmSync(dataDir, { recursive: true });
-  log('Removed data/', 'green');
-}
-
-// Remove any .db files in project root (legacy locations)
-readdirSync(ROOT).filter(f => f.endsWith('.db') || f.endsWith('.db-wal') || f.endsWith('.db-shm')).forEach(f => {
-  unlinkSync(join(ROOT, f));
-  log(`Removed ${f}`, 'green');
-});
-
-// Remove node_modules
-const nodeModules = join(ROOT, 'node_modules');
-if (existsSync(nodeModules)) { rmSync(nodeModules, { recursive: true }); log('Removed node_modules/', 'green'); }
-
-// Remove package-lock.json
-const lockFile = join(ROOT, 'package-lock.json');
-if (existsSync(lockFile)) { unlinkSync(lockFile); log('Removed package-lock.json', 'green'); }
-
-log('Clean complete', 'green');