signal-sdk 0.0.1 → 0.0.3

package/README.md

@@ -59,6 +59,29 @@ npm install
 
 [Detailed installation guide](./docs/installation.md)
 
+### Device Linking
+
+Before using the SDK, you need to link a device to your Signal account:
+
+```bash
+# Using npx (recommended)
+npx signal-sdk connect
+
+# Or with a custom device name
+npx signal-sdk connect "My Bot Device"
+
+# Or using npm script after installation
+cd node_modules/signal-sdk
+npm run connect
+```
+
+This command will:
+1. 🔗 Generate a QR code in your terminal
+2. 📱 Display instructions for scanning with your Signal app
+3. ✅ Complete the device linking process
+
+**Note:** You only need to do this once per device. After linking, your device will be permanently connected to your Signal account.
+
 ### Basic Usage
 
 ```javascript

package/dist/SignalCli.d.ts

@@ -5,7 +5,7 @@ export declare class SignalCli extends EventEmitter {
     private account?;
     private cliProcess;
     private requestPromises;
-    constructor(signalCliPath?: string, account?: string);
+    constructor(accountOrPath?: string, account?: string);
     connect(): Promise<void>;
     disconnect(): void;
     gracefulShutdown(): Promise<void>;

package/dist/SignalCli.js

@@ -40,10 +40,25 @@ const qrcodeTerminal = __importStar(require("qrcode-terminal"));
 const events_1 = require("events");
 const path = __importStar(require("path"));
 class SignalCli extends events_1.EventEmitter {
-    constructor(signalCliPath, account) {
+    constructor(accountOrPath, account) {
         super();
         this.cliProcess = null;
         this.requestPromises = new Map();
+        let signalCliPath;
+        let phoneNumber;
+        // Smart parameter detection
+        if (typeof accountOrPath === 'string') {
+            if (accountOrPath.startsWith('+')) {
+                // First parameter is a phone number
+                phoneNumber = accountOrPath;
+                signalCliPath = undefined;
+            }
+            else {
+                // First parameter is a path, second is phone number
+                signalCliPath = accountOrPath;
+                phoneNumber = account;
+            }
+        }
         // Determine the correct signal-cli path based on platform
         let defaultPath;
         if (process.platform === 'win32') {
@@ -54,7 +69,7 @@ class SignalCli extends events_1.EventEmitter {
             defaultPath = path.join(__dirname, '..', 'bin', 'bin', 'signal-cli');
         }
         this.signalCliPath = signalCliPath || defaultPath;
-        this.account = account;
+        this.account = phoneNumber;
     }
     async connect() {
         const args = this.account ? ['-a', this.account, 'jsonRpc'] : ['jsonRpc'];
@@ -73,8 +88,33 @@ class SignalCli extends events_1.EventEmitter {
         });
         this.cliProcess.on('error', (err) => this.emit('error', err));
         return new Promise((resolve, reject) => {
-            this.cliProcess?.stdout?.once('data', () => resolve());
-            this.cliProcess?.once('error', (err) => reject(err));
+            // Set a timeout to resolve the promise even if no data is received
+            const connectTimeout = setTimeout(() => {
+                // Test if the process is still alive and responsive
+                if (this.cliProcess && !this.cliProcess.killed) {
+                    resolve();
+                }
+                else {
+                    reject(new Error('signal-cli process failed to start'));
+                }
+            }, 2000); // Wait 2 seconds max
+            // If we get data quickly, resolve immediately
+            this.cliProcess?.stdout?.once('data', () => {
+                clearTimeout(connectTimeout);
+                resolve();
+            });
+            // If there's an error, reject
+            this.cliProcess?.once('error', (err) => {
+                clearTimeout(connectTimeout);
+                reject(err);
+            });
+            // If the process exits immediately, that's an error
+            this.cliProcess?.once('close', (code) => {
+                clearTimeout(connectTimeout);
+                if (code !== 0) {
+                    reject(new Error(`signal-cli exited with code ${code}`));
+                }
+            });
         });
     }
     disconnect() {

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "signal-sdk",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "A comprehensive TypeScript SDK for Signal CLI with native JSON-RPC support, providing high-performance messaging, bot framework, and full signal-cli integration.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "bin": {
+    "signal-sdk": "scripts/cli.js"
+  },
   "files": [
     "dist/",
+    "scripts/",
     "README.md",
     "LICENSE"
   ],
@@ -13,6 +17,7 @@
     "build": "tsc",
     "test": "jest",
     "postinstall": "node scripts/install.js",
+    "connect": "node scripts/connect.js",
     "signal:connect": "node examples/sdk/00-device-linking.js",
     "example:basic": "node examples/sdk/01-basic-usage.js",
     "example:quick-start": "node examples/sdk/02-quick-start.js",

package/scripts/cli.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+
+/**
+ * Signal SDK - CLI Tool
+ * 
+ * Command-line interface for Signal SDK operations
+ */
+
+const { spawn } = require('child_process');
+const path = require('path');
+
+function showHelp() {
+    console.log('Signal SDK - Command Line Interface');
+    console.log('===================================\n');
+    console.log('Usage:');
+    console.log('  npx signal-sdk <command> [options]\n');
+    console.log('Commands:');
+    console.log('  connect [device-name]    Link a new device with QR code');
+    console.log('  help                     Show this help message\n');
+    console.log('Examples:');
+    console.log('  npx signal-sdk connect');
+    console.log('  npx signal-sdk connect "My Bot Device"');
+    console.log('  npx signal-sdk help\n');
+    console.log('For more information, visit: https://github.com/benoitpetit/signal-sdk');
+}
+
+function runCommand(scriptName, args = []) {
+    const scriptPath = path.join(__dirname, `${scriptName}.js`);
+    const child = spawn('node', [scriptPath, ...args], {
+        stdio: 'inherit',
+        cwd: process.cwd()
+    });
+
+    child.on('exit', (code) => {
+        process.exit(code || 0);
+    });
+
+    child.on('error', (error) => {
+        console.error('Error running command:', error.message);
+        process.exit(1);
+    });
+}
+
+// Parse command line arguments
+const [,, command, ...args] = process.argv;
+
+switch (command) {
+    case 'connect':
+        runCommand('connect', args);
+        break;
+    
+    case 'help':
+    case '--help':
+    case '-h':
+        showHelp();
+        break;
+    
+    default:
+        if (!command) {
+            console.log('Signal SDK - No command specified\n');
+            showHelp();
+        } else {
+            console.log(`Signal SDK - Unknown command: ${command}\n`);
+            showHelp();
+            process.exit(1);
+        }
+        break;
+}

package/scripts/connect.js

@@ -0,0 +1,119 @@
+#!/usr/bin/env node
+
+/**
+ * Signal SDK - Device Connection Script
+ * 
+ * This script allows you to link a new device to an existing Signal account
+ * by generating and displaying a QR code that can be scanned with your phone.
+ * 
+ * Usage:
+ *   node scripts/connect.js [device-name]
+ * 
+ * Examples:
+ *   node scripts/connect.js
+ *   node scripts/connect.js "My Bot Device"
+ *   npx signal-sdk connect
+ *   npx signal-sdk connect "My Custom Device"
+ */
+
+const { SignalCli } = require('../dist/SignalCli');
+
+async function connectDevice() {
+    console.log('🔗 Signal SDK - Device Connection');
+    console.log('==================================\n');
+
+    // Get device name from command line arguments
+    const deviceName = process.argv[2] || 'Signal SDK Device';
+    
+    console.log(`📱 Device name: ${deviceName}`);
+    console.log('⏳ Generating QR code for device linking...\n');
+
+    // Initialize the SDK without an account (for linking)
+    const signalCli = new SignalCli();
+
+    try {
+        // Start device linking with QR code output to console
+        const linkingResult = await signalCli.deviceLink({
+            name: deviceName,
+            qrCodeOutput: 'console'
+        });
+
+        if (linkingResult.success) {
+            if (linkingResult.isLinked) {
+                console.log('✅ Device successfully linked!');
+                console.log(`📱 Device name: ${linkingResult.deviceName}`);
+                console.log('\n🎉 You can now use this device to send and receive Signal messages.');
+                console.log('\n💡 Next steps:');
+                console.log('   1. Import SignalCli in your Node.js project');
+                console.log('   2. Initialize with your phone number');
+                console.log('   3. Start sending and receiving messages');
+                console.log('\n📖 Example usage:');
+                console.log('   const { SignalCli } = require("signal-sdk");');
+                console.log('   const signalCli = new SignalCli(undefined, "+YourPhoneNumber");');
+                console.log('   await signalCli.connect();');
+            } else {
+                console.log('📋 QR code generated successfully!');
+                console.log('📱 Scan the QR code above with your Signal app to link this device.');
+                console.log('\n📝 Instructions:');
+                console.log('   1. Open Signal on your phone');
+                console.log('   2. Go to Settings > Linked devices');
+                console.log('   3. Tap "Link new device"');
+                console.log('   4. Scan the QR code displayed above');
+                console.log('\n⏳ Waiting for device linking...');
+                console.log('   (This process may take a few moments)');
+            }
+        } else {
+            console.error('❌ Device linking failed');
+            if (linkingResult.error) {
+                console.error(`   Error: ${linkingResult.error}`);
+            }
+            console.error('\n🔧 Troubleshooting:');
+            console.error('   • Make sure signal-cli is properly installed');
+            console.error('   • Check your internet connection');
+            console.error('   • Ensure your Signal app is up to date');
+            console.error('   • Try running the command again');
+            process.exit(1);
+        }
+    } catch (error) {
+        console.error('❌ Fatal error during device linking:', error.message);
+        console.error('\n🔧 Common solutions:');
+        console.error('   • Install signal-cli: https://github.com/AsamK/signal-cli');
+        console.error('   • Make sure Java is installed and accessible');
+        console.error('   • Check that signal-cli is in your PATH');
+        console.error('   • Verify your internet connection');
+        process.exit(1);
+    }
+}
+
+// Handle graceful shutdown
+process.on('SIGINT', () => {
+    console.log('\n\n⏹️  Device linking cancelled by user.');
+    process.exit(0);
+});
+
+process.on('SIGTERM', () => {
+    console.log('\n\n⏹️  Device linking terminated.');
+    process.exit(0);
+});
+
+// Display help if requested
+if (process.argv.includes('--help') || process.argv.includes('-h')) {
+    console.log('Signal SDK - Device Connection Script');
+    console.log('=====================================\n');
+    console.log('Usage:');
+    console.log('  node scripts/connect.js [device-name]');
+    console.log('  npx signal-sdk connect [device-name]\n');
+    console.log('Arguments:');
+    console.log('  device-name    Optional name for the linked device (default: "Signal SDK Device")\n');
+    console.log('Examples:');
+    console.log('  node scripts/connect.js');
+    console.log('  node scripts/connect.js "My Bot Device"');
+    console.log('  npx signal-sdk connect');
+    console.log('  npx signal-sdk connect "My Custom Device"\n');
+    console.log('This script generates a QR code that you can scan with your Signal app');
+    console.log('to link a new device for use with the Signal SDK.');
+    process.exit(0);
+}
+
+// Run the connection process
+connectDevice();

package/scripts/install.js

@@ -0,0 +1,64 @@
+const axios = require('axios');
+const tar = require('tar');
+const fs = require('fs');
+const path = require('path');
+
+const VERSION = '0.13.17';
+const BASE_URL = `https://github.com/AsamK/signal-cli/releases/download/v${VERSION}`;
+
+const platform = process.platform;
+
+async function install() {
+  let url;
+  if (platform === 'linux') {
+    url = `${BASE_URL}/signal-cli-${VERSION}-Linux-native.tar.gz`;
+  } else {
+    url = `${BASE_URL}/signal-cli-${VERSION}.tar.gz`;
+  }
+
+  console.log(`Downloading signal-cli from ${url}`);
+
+  const response = await axios({
+    url,
+    method: 'GET',
+    responseType: 'stream'
+  });
+
+  const binDir = path.join(__dirname, '..', 'bin');
+  if (!fs.existsSync(binDir)) {
+    fs.mkdirSync(binDir, { recursive: true });
+  }
+
+  response.data.pipe(tar.x({ C: binDir, strip: 1 }));
+
+  console.log('signal-cli downloaded and extracted successfully.');
+
+  // Set executable permissions on Unix/Linux systems
+  if (platform !== 'win32') {
+    const signalCliExecutable = path.join(binDir, 'bin', 'signal-cli');
+    if (fs.existsSync(signalCliExecutable)) {
+      try {
+        fs.chmodSync(signalCliExecutable, '755');
+        console.log('Set executable permissions for signal-cli');
+      } catch (error) {
+        console.warn('Could not set executable permissions:', error.message);
+      }
+    }
+  }
+
+  if (platform === 'win32') {
+    console.log('Windows detected. Make sure you have Java installed and signal-cli.bat is executable.');
+    console.log('signal-cli.bat is located at: ' + path.join(binDir, 'bin', 'signal-cli.bat'));
+  } else if (platform === 'linux') {
+    console.log('Linux detected. signal-cli executable is ready.');
+    console.log('signal-cli is located at: ' + path.join(binDir, 'bin', 'signal-cli'));
+  } else {
+    console.log('Please ensure you have Java installed on your system for signal-cli to work.');
+    console.log('signal-cli is located at: ' + path.join(binDir, 'bin', 'signal-cli'));
+  }
+}
+
+install().catch(error => {
+  console.error('Failed to install signal-cli:', error);
+  process.exit(1);
+});