signal-sdk 0.1.1 → 0.1.3

package/README.md

@@ -14,10 +14,10 @@
 
 [![npm version](https://badge.fury.io/js/signal-sdk.svg)](https://badge.fury.io/js/signal-sdk)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-[![signal-cli](https://img.shields.io/badge/signal--cli-v0.13.22-blue.svg)](https://github.com/AsamK/signal-cli)
+[![signal-cli](https://img.shields.io/badge/signal--cli-v0.13.23-blue.svg)](https://github.com/AsamK/signal-cli)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.8+-blue.svg)](https://www.typescriptlang.org/)
 [![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
-[![Tests](https://img.shields.io/badge/tests-310%20passing-brightgreen.svg)](./src/__tests__)
+[![Tests](https://img.shields.io/badge/tests-393%20passing-brightgreen.svg)](./src/__tests__)
 [![Donate on Liberapay](https://img.shields.io/badge/Liberapay-Donate-yellow.svg)](https://liberapay.com/devbyben/donate)
 
   </div>
@@ -70,7 +70,8 @@
 - **Progress Tracking** - Monitor upload progress
 - **Polls** - Create, vote, and terminate polls
 - **Attachment Retrieval** - Retrieve attachments, avatars, and stickers
-- **Account Management** - Update account settings
+- **Account Management** - Update account settings, PIN, and registration
+- **Note to Self** - Send private notes to your own account
 - **Stories** - View and interact with Signal stories
 - **Group Information** - Retrieve detailed group permissions
 
@@ -213,7 +214,7 @@ bot.on("ready", () => {
 });
 
 bot.on("message", (message) => {
-  console.log(`Received: ${message.text} from ${message.sender}`);
+  console.log(`Received: ${message.text} from ${message.source}`);
 });
 
 // Start the bot
@@ -362,9 +363,9 @@ await bot.start();
 
 - **Node.js**: >=18.0.0
 - **TypeScript**: 5.8+ with strict mode
-- **Test Coverage**: 225 passing tests across 9 suites
-- **Code Coverage**: 57.52% overall, critical modules at 96-100%
-- **signal-cli**: Compatible with v0.13.22
+- **Test Coverage**: 393 passing tests across 21 suites
+- **Code Coverage**: 83.54% overall, critical modules at 96-100%
+- **signal-cli**: Compatible with v0.13.23
 
 ## Testing
 
@@ -372,9 +373,9 @@ The SDK has comprehensive test coverage to ensure reliability and quality.
 
 ### Test Statistics
 
-- **Total Tests**: 225 passing
-- **Test Suites**: 9 suites
-- **Overall Coverage**: 57.52%
+- **Total Tests**: 393 passing
+- **Test Suites**: 21 suites
+- **Overall Coverage**: 83.54%
 
 ### Coverage by Module
 
@@ -570,7 +571,7 @@ This project is licensed under the MIT License - see the [LICENSE](./LICENSE) fi
 
 ## API Methods
 
-Compatible with signal-cli v0.13.22 - **100% Feature Coverage**
+Compatible with signal-cli v0.13.23 - **100% Feature Coverage**
 
 | Category        | Method                     | Description                        | Status |
 | --------------- | -------------------------- | ---------------------------------- | ------ |
@@ -595,6 +596,8 @@ Compatible with signal-cli v0.13.22 - **100% Feature Coverage**
 |                 | `getUserStatus`            | Check registration status          | ✅     |
 | **Account**     | `updateAccount`            | Update account settings            | ✅     |
 |                 | `listAccountsDetailed`     | List accounts with detailed info   | ✅     |
+| **Devices**     | `listDevices`              | List linked devices                | ✅     |
+|                 | `updateDevice`             | Update device name (v0.13.23+)     | ✅     |
 | **Attachments** | `getAttachment`            | Retrieve attachment by ID          | ✅     |
 |                 | `getAvatar`                | Retrieve avatar by ID              | ✅     |
 |                 | `getSticker`               | Retrieve sticker by ID             | ✅     |
@@ -605,6 +608,15 @@ Compatible with signal-cli v0.13.22 - **100% Feature Coverage**
 |                 | `startChangeNumber`        | Start phone number change          | ✅     |
 |                 | `finishChangeNumber`       | Complete phone number change       | ✅     |
 |                 | `sendMessageWithProgress`  | Enhanced messaging with progress   | ✅     |
+|                 | `sendNoteToSelf`           | Send message to own conversation   | ✅     |
+|                 | `unregister`               | Unregister account from server     | ✅     |
+| **Identities**  | `listIdentities`           | List known identities              | ✅     |
+|                 | `trustIdentity`            | Mark identity as trusted           | ✅     |
+|                 | `getSafetyNumber`          | Get safety number for contact      | ✅     |
+|                 | `verifySafetyNumber`       | Verify and trust safety number     | ✅     |
+| **Multi-Account**| `addAccount`              | Add account to manager             | ✅     |
+|                 | `connectAll`               | Connect all managed accounts       | ✅     |
+|                 | `getStatus`                | Get status for all accounts        | ✅     |
 
 [Complete API documentation](./docs/api-reference.md)
 

package/dist/MultiAccountManager.js

@@ -45,7 +45,7 @@ class MultiAccountManager extends events_1.EventEmitter {
         this.options = options;
         this.logger = new config_1.Logger({
             level: options.verbose ? 'debug' : 'info',
-            enableFile: false
+            enableFile: false,
         });
         this.logger.info('MultiAccountManager initialized');
     }
@@ -65,7 +65,7 @@ class MultiAccountManager extends events_1.EventEmitter {
         const signalConfig = {
             signalCliPath: this.options.signalCliPath,
             verbose: this.options.verbose,
-            ...config
+            ...config,
         };
         const instance = new SignalCli_1.SignalCli(account, undefined, signalConfig);
         // Forward events from this instance
@@ -75,7 +75,7 @@ class MultiAccountManager extends events_1.EventEmitter {
             account,
             instance,
             connected: false,
-            lastActivity: Date.now()
+            lastActivity: Date.now(),
         };
         this.accounts.set(account, managedAccount);
         this.emit('accountAdded', account);
@@ -186,7 +186,7 @@ class MultiAccountManager extends events_1.EventEmitter {
      */
     async connectAll() {
         this.logger.info('Connecting all accounts');
-        const promises = Array.from(this.accounts.keys()).map(account => this.connect(account).catch(error => {
+        const promises = Array.from(this.accounts.keys()).map((account) => this.connect(account).catch((error) => {
             this.logger.error(`Failed to connect ${account}:`, error);
         }));
         await Promise.all(promises);
@@ -197,7 +197,7 @@ class MultiAccountManager extends events_1.EventEmitter {
      */
     async disconnectAll() {
         this.logger.info('Disconnecting all accounts');
-        const promises = Array.from(this.accounts.keys()).map(account => this.disconnect(account).catch(error => {
+        const promises = Array.from(this.accounts.keys()).map((account) => this.disconnect(account).catch((error) => {
             this.logger.error(`Failed to disconnect ${account}:`, error);
         }));
         await Promise.all(promises);
@@ -235,14 +235,14 @@ class MultiAccountManager extends events_1.EventEmitter {
                 account: managedAccount.account,
                 connected: managedAccount.connected,
                 lastActivity: managedAccount.lastActivity,
-                uptime: Date.now() - managedAccount.lastActivity
+                uptime: Date.now() - managedAccount.lastActivity,
             };
         }
         // Return status for all accounts
         const status = {
             totalAccounts: this.accounts.size,
             connectedAccounts: 0,
-            accounts: []
+            accounts: [],
         };
         for (const [account, managed] of this.accounts) {
             if (managed.connected) {
@@ -252,7 +252,7 @@ class MultiAccountManager extends events_1.EventEmitter {
                 account,
                 connected: managed.connected,
                 lastActivity: managed.lastActivity,
-                uptime: Date.now() - managed.lastActivity
+                uptime: Date.now() - managed.lastActivity,
             });
         }
         return status;
@@ -264,16 +264,8 @@ class MultiAccountManager extends events_1.EventEmitter {
      */
     setupEventForwarding(account, instance) {
         // Forward all events with account prefix
-        const events = [
-            'message',
-            'receipt',
-            'typing',
-            'reaction',
-            'error',
-            'connected',
-            'disconnected'
-        ];
-        events.forEach(event => {
+        const events = ['message', 'receipt', 'typing', 'reaction', 'error', 'connected', 'disconnected'];
+        events.forEach((event) => {
             instance.on(event, (...args) => {
                 // Emit with account information
                 this.emit(event, account, ...args);
@@ -281,7 +273,7 @@ class MultiAccountManager extends events_1.EventEmitter {
                 this.emit('accountEvent', {
                     account,
                     event,
-                    data: args
+                    data: args,
                 });
                 // Update last activity
                 const managedAccount = this.accounts.get(account);

package/dist/SignalBot.js

@@ -78,7 +78,7 @@ class SignalBot extends events_1.EventEmitter {
             commandsExecuted: 0,
             startTime: Date.now(),
             lastActivity: Date.now(),
-            activeUsers: 0
+            activeUsers: 0,
         };
         this.setupDefaultCommands();
     }
@@ -93,7 +93,8 @@ class SignalBot extends events_1.EventEmitter {
             const tempFilePath = path.join(process.cwd(), tempFileName);
             const file = fs.createWriteStream(tempFilePath);
             const client = imageUrl.startsWith('https:') ? https : http;
-            client.get(imageUrl, (response) => {
+            client
+                .get(imageUrl, (response) => {
                 if (response.statusCode !== 200) {
                     fs.unlink(tempFilePath, () => { }); // Clean up on error
                     reject(new Error(`Failed to download image: ${response.statusCode}`));
@@ -108,7 +109,8 @@ class SignalBot extends events_1.EventEmitter {
                     fs.unlink(tempFilePath, () => { }); // Clean up on error
                     reject(err);
                 });
-            }).on('error', (err) => {
+            })
+                .on('error', (err) => {
                 fs.unlink(tempFilePath, () => { }); // Clean up on error
                 reject(err);
             });
@@ -124,7 +126,8 @@ class SignalBot extends events_1.EventEmitter {
         return new Promise((resolve, reject) => {
             const downloadWithRedirect = (url, maxRedirects = 5) => {
                 const client = url.startsWith('https:') ? https : http;
-                client.get(url, (response) => {
+                client
+                    .get(url, (response) => {
                     // Handle redirections (3xx status codes)
                     if (response.statusCode && response.statusCode >= 300 && response.statusCode < 400) {
                         if (maxRedirects <= 0) {
@@ -137,7 +140,9 @@ class SignalBot extends events_1.EventEmitter {
                             return;
                         }
                         // Resolve relative URLs
-                        const finalUrl = redirectUrl.startsWith('http') ? redirectUrl : new URL(redirectUrl, url).href;
+                        const finalUrl = redirectUrl.startsWith('http')
+                            ? redirectUrl
+                            : new URL(redirectUrl, url).href;
                         this.log(`🔄 Following redirect to: ${finalUrl}`, 'DEBUG');
                         downloadWithRedirect(finalUrl, maxRedirects - 1);
                         return;
@@ -162,7 +167,8 @@ class SignalBot extends events_1.EventEmitter {
                         fs.unlink(tempFilePath, () => { }); // Clean up on error
                         reject(err);
                     });
-                }).on('error', (err) => {
+                })
+                    .on('error', (err) => {
                     reject(err);
                 });
             };
@@ -189,7 +195,7 @@ class SignalBot extends events_1.EventEmitter {
                 recipient,
                 message,
                 attachments: [tempFilePath],
-                cleanup: [tempFilePath] // Mark files for cleanup after sending
+                cleanup: [tempFilePath], // Mark files for cleanup after sending
             });
             this.processActionQueue();
         }
@@ -319,7 +325,7 @@ class SignalBot extends events_1.EventEmitter {
         this.log('- Stopping Signal Bot...');
         this.isRunning = false;
         // Clear all active timers
-        this.activeTimers.forEach(timer => clearTimeout(timer));
+        this.activeTimers.forEach((timer) => clearTimeout(timer));
         this.activeTimers = [];
         this.signalCli.disconnect();
         this.emit('stopped');
@@ -329,7 +335,7 @@ class SignalBot extends events_1.EventEmitter {
         this.log('- Gracefully shutting down Signal Bot...');
         this.isRunning = false;
         // Clear all active timers
-        this.activeTimers.forEach(timer => clearTimeout(timer));
+        this.activeTimers.forEach((timer) => clearTimeout(timer));
         this.activeTimers = [];
         try {
             await this.signalCli.gracefulShutdown();
@@ -376,7 +382,7 @@ class SignalBot extends events_1.EventEmitter {
     getStats() {
         return {
             ...this.stats,
-            activeUsers: this.userCooldowns.size
+            activeUsers: this.userCooldowns.size,
         };
     }
     /**
@@ -404,11 +410,11 @@ class SignalBot extends events_1.EventEmitter {
             description: 'Displays available commands',
             handler: async (message, args) => {
                 const userCommands = Array.from(this.commands.values())
-                    .filter(cmd => !cmd.adminOnly || message.isFromAdmin)
-                    .map(cmd => `${this.config.settings.commandPrefix}${cmd.name} - ${cmd.description}`)
+                    .filter((cmd) => !cmd.adminOnly || message.isFromAdmin)
+                    .map((cmd) => `${this.config.settings.commandPrefix}${cmd.name} - ${cmd.description}`)
                     .join('\n');
                 return `Signal Bot Commands\n\n${userCommands}\n\n${message.isFromAdmin ? '| You have admin privileges' : ''}`;
-            }
+            },
         });
         // Stats command
         this.addCommand({
@@ -417,12 +423,12 @@ class SignalBot extends events_1.EventEmitter {
             handler: async () => {
                 const stats = this.getStats();
                 const uptime = this.formatUptime(Date.now() - stats.startTime);
-                return `Bot Statistics\n\n` +
+                return (`Bot Statistics\n\n` +
                     `1. Messages Received: ${stats.messagesReceived}\n` +
                     `2. Commands Executed: ${stats.commandsExecuted}\n` +
                     `3. Uptime: ${uptime}\n` +
-                    `4. Active Users: ${stats.activeUsers}`;
-            }
+                    `4. Active Users: ${stats.activeUsers}`);
+            },
         });
         // Ping command
         this.addCommand({
@@ -431,7 +437,7 @@ class SignalBot extends events_1.EventEmitter {
             handler: async (message) => {
                 const responseTime = Date.now() - message.timestamp;
                 return `Pong! Response time: ${responseTime}ms`;
-            }
+            },
         });
         // Info command (admin only)
         this.addCommand({
@@ -439,13 +445,13 @@ class SignalBot extends events_1.EventEmitter {
             description: 'Detailed bot information (admin)',
             adminOnly: true,
             handler: async () => {
-                return `Bot Information\n\n` +
+                return (`Bot Information\n\n` +
                     `- Number: ${this.config.phoneNumber}\n` +
                     `- Group: ${this.config.group ? this.config.group.name : 'N/A'}\n` +
                     `- Admins: ${this.config.admins.length}\n` +
                     `- Commands: ${this.commands.size}\n` +
-                    `- Prefix: ${this.config.settings.commandPrefix}`;
-            }
+                    `- Prefix: ${this.config.settings.commandPrefix}`);
+            },
         });
     }
     async setupBotGroup() {
@@ -462,7 +468,7 @@ class SignalBot extends events_1.EventEmitter {
             }
             // Search for an existing group
             const groups = await this.signalCli.listGroups();
-            const existingGroup = groups.find(group => group.name === this.config.group.name && group.isMember);
+            const existingGroup = groups.find((group) => group.name === this.config.group.name && group.isMember);
             if (existingGroup) {
                 // Try different possible field names for the group ID
                 const groupData = existingGroup;
@@ -471,7 +477,7 @@ class SignalBot extends events_1.EventEmitter {
                 this.log(`- Existing group found: ${this.config.group.name} (${possibleGroupId})`);
                 // Check if all admins are in the group and add them if not
                 const currentMembers = existingGroup.members?.map((m) => m.number || m) || [];
-                const missingAdmins = this.config.admins.filter(admin => !currentMembers.includes(admin));
+                const missingAdmins = this.config.admins.filter((admin) => !currentMembers.includes(admin));
                 // Prepare update options
                 const updateOptions = {};
                 if (missingAdmins.length > 0) {
@@ -517,10 +523,7 @@ class SignalBot extends events_1.EventEmitter {
             }
             // Create a new group only if none exists
             this.log(`- Creating group: ${this.config.group.name}`);
-            const initialMembers = [
-                ...this.config.admins,
-                ...(this.config.group.initialMembers || [])
-            ].filter((member, index, array) => array.indexOf(member) === index);
+            const initialMembers = [...this.config.admins, ...(this.config.group.initialMembers || [])].filter((member, index, array) => array.indexOf(member) === index);
             try {
                 const newGroup = await this.signalCli.createGroup(this.config.group.name, initialMembers);
                 const newGroupData = newGroup;
@@ -531,7 +534,7 @@ class SignalBot extends events_1.EventEmitter {
                     const configOptions = {
                         description: this.config.group.description,
                         permissionAddMember: 'ONLY_ADMINS',
-                        permissionEditDetails: 'ONLY_ADMINS'
+                        permissionEditDetails: 'ONLY_ADMINS',
                     };
                     if (avatarPath) {
                         configOptions.avatar = avatarPath;
@@ -556,7 +559,7 @@ class SignalBot extends events_1.EventEmitter {
                     this.log(`   2. Add the bot number (${this.config.phoneNumber}) to the group`, 'INFO');
                     this.log(`   3. Add all admins to the group: ${this.config.admins.join(', ')}`, 'INFO');
                     this.log(`   4. Restart the bot`, 'INFO');
-                    this.log(`   Available groups: ${groups.map(g => g.name).join(', ')}`, 'INFO');
+                    this.log(`   Available groups: ${groups.map((g) => g.name).join(', ')}`, 'INFO');
                     // Don't use a fallback group - this is misleading behavior
                     throw new Error(`Group "${this.config.group.name}" does not exist and cannot be created automatically. Please create it manually as described above.`);
                 }
@@ -617,7 +620,7 @@ class SignalBot extends events_1.EventEmitter {
                 text: messageData.envelope.dataMessage.message || '',
                 timestamp: messageData.envelope.timestamp,
                 groupInfo: messageData.envelope.dataMessage.groupInfo,
-                isFromAdmin: this.isAdmin(messageData.envelope.sourceNumber || messageData.envelope.source)
+                isFromAdmin: this.isAdmin(messageData.envelope.sourceNumber || messageData.envelope.source),
             };
             // Ignore own messages
             if (parsedMessage.source === this.config.phoneNumber) {
@@ -697,8 +700,9 @@ class SignalBot extends events_1.EventEmitter {
         }
     }
     async sendCommandResponse(message, response) {
-        const recipient = message.groupInfo ?
-            (message.groupInfo.id || message.groupInfo.groupId || message.source) : message.source;
+        const recipient = message.groupInfo
+            ? message.groupInfo.id || message.groupInfo.groupId || message.source
+            : message.source;
         await this.sendMessage(recipient, response);
     }
     isOnCooldown(userId) {
@@ -707,7 +711,7 @@ class SignalBot extends events_1.EventEmitter {
             return false;
         const now = Date.now();
         const cooldownMs = (this.config.settings.cooldownSeconds || 2) * 1000;
-        return (now - lastCommand) < cooldownMs;
+        return now - lastCommand < cooldownMs;
     }
     async processActionQueue() {
         if (this.isProcessingQueue || this.actionQueue.length === 0) {
@@ -727,13 +731,13 @@ class SignalBot extends events_1.EventEmitter {
                         case 'sendMessageWithAttachment':
                             this.log(`Executing sendMessageWithAttachment to ${action.recipient} with ${action.attachments.length} file(s)...`, 'DEBUG');
                             await this.signalCli.sendMessage(action.recipient, action.message, {
-                                attachments: action.attachments
+                                attachments: action.attachments,
                             });
                             // Wait a bit for signal-cli to finish processing the files before cleanup
                             // signal-cli responds immediately but continues processing files in background
                             if (action.cleanup && action.cleanup.length > 0) {
                                 const cleanupTimer = setTimeout(() => {
-                                    action.cleanup.forEach(filePath => {
+                                    action.cleanup.forEach((filePath) => {
                                         this.cleanupTempFile(filePath);
                                     });
                                     // Remove timer from active list
@@ -752,7 +756,7 @@ class SignalBot extends events_1.EventEmitter {
                             break;
                     }
                     // Wait a bit between actions to be safe
-                    await new Promise(resolve => {
+                    await new Promise((resolve) => {
                         const timer = setTimeout(resolve, 250);
                         if (timer.unref)
                             timer.unref();
@@ -762,7 +766,7 @@ class SignalBot extends events_1.EventEmitter {
                     this.log(`ERROR: Failed to execute action ${action.type}: ${error?.message || error}`, 'ERROR');
                     // Clean up temporary files even on error
                     if (action.type === 'sendMessageWithAttachment' && action.cleanup && action.cleanup.length > 0) {
-                        action.cleanup.forEach(filePath => {
+                        action.cleanup.forEach((filePath) => {
                             this.cleanupTempFile(filePath);
                         });
                     }