signal-sdk 0.0.4 → 0.0.6

package/dist/SignalCli.js

@@ -62,11 +62,11 @@ class SignalCli extends events_1.EventEmitter {
         // Determine the correct signal-cli path based on platform
         let defaultPath;
         if (process.platform === 'win32') {
-            defaultPath = path.join(__dirname, '..', 'bin', 'bin', 'signal-cli.bat');
+            defaultPath = path.join(__dirname, '..', 'bin', 'signal-cli.bat');
         }
         else {
             // For Unix/Linux systems, use the shell script
-            defaultPath = path.join(__dirname, '..', 'bin', 'bin', 'signal-cli');
+            defaultPath = path.join(__dirname, '..', 'bin', 'signal-cli');
         }
         this.signalCliPath = signalCliPath || defaultPath;
         this.account = phoneNumber;

package/package.json

@@ -1,72 +1,74 @@
-{
-  "name": "signal-sdk",
-  "version": "0.0.4",
-  "description": "A comprehensive TypeScript SDK for Signal Messenger 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"
-  ],
-  "scripts": {
-    "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",
-    "example:group-management": "node examples/sdk/03-group-management.js",
-    "example:contact-management": "node examples/sdk/04-contact-management.js",
-    "example:file-handling": "node examples/sdk/05-file-handling.js",
-    "example:minimal-bot": "node examples/bot/01-minimal-bot.js",
-    "example:advanced-bot": "node examples/bot/02-advanced-bot.js"
-  },
-  "keywords": [
-    "signal",
-    "signal-cli",
-    "messaging",
-    "bot",
-    "typescript",
-    "json-rpc",
-    "sdk",
-    "automation"
-  ],
-  "author": "devbyben",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/benoitpetit/signal-sdk.git"
-  },
-  "homepage": "https://github.com/benoitpetit/signal-sdk#readme",
-  "bugs": {
-    "url": "https://github.com/benoitpetit/signal-sdk/issues"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "devDependencies": {
-    "@types/jest": "^30.0.0",
-    "@types/node": "^24.0.10",
-    "@types/qrcode-terminal": "^0.12.2",
-    "@types/uuid": "^9.0.8",
-    "jest": "^30.0.4",
-    "ts-jest": "^29.4.0",
-    "typescript": "^5.8.3"
-  },
-  "dependencies": {
-    "axios": "^1.10.0",
-    "dotenv": "^16.4.5",
-    "duckduckgo-chat-interface": "^1.1.5",
-    "events": "^3.3.0",
-    "qrcode": "^1.5.3",
-    "qrcode-terminal": "^0.12.0",
-    "tar": "^7.4.3",
-    "uuid": "^9.0.1"
-  }
+{
+  "name": "signal-sdk",
+  "version": "0.0.6",
+  "description": "A comprehensive TypeScript SDK for Signal Messenger 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/",
+    "!dist/__tests__/",
+    "scripts/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "prepublishOnly": "npm run build",
+    "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",
+    "example:group-management": "node examples/sdk/03-group-management.js",
+    "example:contact-management": "node examples/sdk/04-contact-management.js",
+    "example:file-handling": "node examples/sdk/05-file-handling.js",
+    "example:minimal-bot": "node examples/bot/01-minimal-bot.js",
+    "example:advanced-bot": "node examples/bot/02-advanced-bot.js"
+  },
+  "keywords": [
+    "signal",
+    "signal-cli",
+    "messaging",
+    "bot",
+    "typescript",
+    "json-rpc",
+    "sdk",
+    "automation"
+  ],
+  "author": "devbyben",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/benoitpetit/signal-sdk.git"
+  },
+  "homepage": "https://github.com/benoitpetit/signal-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/benoitpetit/signal-sdk/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.0.10",
+    "@types/qrcode-terminal": "^0.12.2",
+    "@types/uuid": "^9.0.8",
+    "jest": "^30.0.4",
+    "ts-jest": "^29.4.0",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "axios": "^1.10.0",
+    "dotenv": "^16.4.5",
+    "duckduckgo-chat-interface": "^1.1.5",
+    "events": "^3.3.0",
+    "qrcode": "^1.5.3",
+    "qrcode-terminal": "^0.12.0",
+    "tar": "^7.4.3",
+    "uuid": "^9.0.1"
+  }
 }

package/scripts/cli.js

@@ -1,68 +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;
-}
+#!/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

@@ -1,119 +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('\nYou can now use this device to send and receive Signal messages.');
-                console.log('\nNext 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('\nExample usage:');
-                console.log('   const { SignalCli } = require("signal-sdk");');
-                console.log('   const signalCli = new SignalCli("+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('\nInstructions:');
-                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('\nWaiting 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('\nTroubleshooting:');
-            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('\nCommon 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\nDevice linking cancelled by user.');
-    process.exit(0);
-});
-
-process.on('SIGTERM', () => {
-    console.log('\n\nDevice 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();
+#!/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('\nYou can now use this device to send and receive Signal messages.');
+                console.log('\nNext 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('\nExample usage:');
+                console.log('   const { SignalCli } = require("signal-sdk");');
+                console.log('   const signalCli = new SignalCli("+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('\nInstructions:');
+                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('\nWaiting 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('\nTroubleshooting:');
+            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('\nCommon 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\nDevice linking cancelled by user.');
+    process.exit(0);
+});
+
+process.on('SIGTERM', () => {
+    console.log('\n\nDevice 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

@@ -1,9 +1,9 @@
 const axios = require('axios');
-const tar = require('tar');
 const fs = require('fs');
 const path = require('path');
+const { execSync } = require('child_process');
 
-const VERSION = '0.13.17';
+const VERSION = '0.13.18';
 const BASE_URL = `https://github.com/AsamK/signal-cli/releases/download/v${VERSION}`;
 
 const platform = process.platform;
@@ -21,7 +21,7 @@ async function install() {
   const response = await axios({
     url,
     method: 'GET',
-    responseType: 'stream'
+    responseType: 'arraybuffer'
   });
 
   const binDir = path.join(__dirname, '..', 'bin');
@@ -29,13 +29,26 @@ async function install() {
     fs.mkdirSync(binDir, { recursive: true });
   }
 
-  response.data.pipe(tar.x({ C: binDir, strip: 1 }));
+  // Write tar file temporarily
+  const tempFile = path.join(binDir, 'signal-cli.tar.gz');
+  fs.writeFileSync(tempFile, response.data);
+
+  // Extract using system tar command
+  try {
+    execSync(`tar -xzf "${tempFile}" -C "${binDir}"`, { stdio: 'inherit' });
+  } catch (error) {
+    console.error('Failed to extract archive:', error.message);
+    throw error;
+  }
+
+  // Remove temp file
+  fs.unlinkSync(tempFile);
 
   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');
+    const signalCliExecutable = path.join(binDir, 'signal-cli');
     if (fs.existsSync(signalCliExecutable)) {
       try {
         fs.chmodSync(signalCliExecutable, '755');
@@ -48,13 +61,13 @@ async function install() {
 
   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'));
+    console.log('signal-cli.bat is located at: ' + path.join(binDir, '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'));
+    console.log('signal-cli is located at: ' + path.join(binDir, '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'));
+    console.log('signal-cli is located at: ' + path.join(binDir, 'signal-cli'));
   }
 }
 

package/dist/__tests__/SignalBot.test.d.ts

@@ -1 +0,0 @@
-export {};