n8n-nodes-signal-cli-rest-api 0.6.1 → 0.7.0

package/README.md

@@ -53,7 +53,7 @@ services:
     ports:
       - "8085:8080"  # Change 8085 to available port if needed (e.g., 8003:8080)
     volumes:
-      - /mnt/your-pool/signal-data:/home/.local/share/signal-cli  # Replace /mnt/your-pool with your dataset/pool in TrueNAS
+      - /mnt/your-pool/signal-data:/home/.local/share/signal-cli  # Replace /mnt/your-pool with your path to signal data
       # Additionally, for config: - /mnt/your-pool/signal-config:/etc/signal-cli-rest-api (if custom settings)
     environment:
       - MODE=json-rpc  # Recommended for speed and resolves group reception issues

package/dist/nodes/Signal/Signal.node.js

@@ -37,15 +37,9 @@ class Signal {
                         {
                             name: 'Messages: Send Message',
                             value: 'sendMessage',
-                            description: 'Send a text message to a contact or group',
+                            description: 'Send a text message to a contact or group, optionally with attachments',
                             action: 'Send a text message',
                         },
-                        {
-                            name: 'Messages: Send Attachment',
-                            value: 'sendAttachment',
-                            description: 'Send a file or image to a contact or group',
-                            action: 'Send an attachment',
-                        },
                         {
                             name: 'Messages: Send Reaction',
                             value: 'sendReaction',
@@ -120,11 +114,11 @@ class Signal {
                     type: 'string',
                     default: '',
                     placeholder: '+1234567890 or groupId',
-                    description: 'Phone number or group ID to send the message, attachment, reaction, or typing indicator to',
+                    description: 'Phone number or group ID to send the message, reaction, or typing indicator to',
                     required: true,
                     displayOptions: {
                         show: {
-                            operation: ['sendMessage', 'sendAttachment', 'sendReaction', 'removeReaction', 'startTyping', 'stopTyping'],
+                            operation: ['sendMessage', 'sendReaction', 'removeReaction', 'startTyping', 'stopTyping'],
                         },
                     },
                 },
@@ -136,23 +130,40 @@ class Signal {
                     description: 'The text message to send (optional for attachments)',
                     displayOptions: {
                         show: {
-                            operation: ['sendMessage', 'sendAttachment'],
+                            operation: ['sendMessage'],
                         },
                     },
                 },
                 {
-                    displayName: 'Attachment URL',
-                    name: 'attachmentUrl',
-                    type: 'string',
-                    default: '',
-                    placeholder: 'https://example.com/image.jpg',
-                    description: 'URL of the file or image to send (e.g., PNG, JPG, PDF, MP3 for voice notes)',
-                    required: true,
+                    displayName: 'Binary Fields',
+                    name: 'binaryFields',
+                    type: 'fixedCollection',
+                    typeOptions: {
+                        multipleValues: true,
+                    },
+                    default: {},
+                    placeholder: 'Add Binary Field',
+                    description: 'Binary fields for attachments (empty or invalid fields are ignored)',
                     displayOptions: {
                         show: {
-                            operation: ['sendAttachment'],
+                            operation: ['sendMessage'],
                         },
                     },
+                    options: [
+                        {
+                            name: 'binaryFieldValues',
+                            displayName: 'Binary Field',
+                            values: [
+                                {
+                                    displayName: 'Input Binary Field',
+                                    name: 'inputBinaryField',
+                                    type: 'string',
+                                    default: '',
+                                    description: 'Name of the binary field containing the file to send (e.g., data)',
+                                },
+                            ],
+                        },
+                    ],
                 },
                 {
                     displayName: 'Group ID',
@@ -173,8 +184,7 @@ class Signal {
                     name: 'groupName',
                     type: 'string',
                     default: '',
-                    description: 'Name of the new or updated group',
-                    required: false,
+                    description: 'Name of the group to create or update',
                     displayOptions: {
                         show: {
                             operation: ['createGroup', 'updateGroup'],
@@ -188,7 +198,6 @@ class Signal {
                     default: '',
                     placeholder: '+1234567890,+0987654321',
                     description: 'Comma-separated list of phone numbers to add to the group',
-                    required: false,
                     displayOptions: {
                         show: {
                             operation: ['createGroup', 'updateGroup'],
@@ -272,7 +281,7 @@ class Signal {
                     description: 'Request timeout in seconds (set higher for Get Groups, e.g., 300)',
                     displayOptions: {
                         show: {
-                            operation: ['sendMessage', 'sendAttachment', 'sendReaction', 'removeReaction', 'startTyping', 'stopTyping', 'getContacts', 'getGroups', 'createGroup', 'updateGroup', 'listAttachments', 'downloadAttachment', 'removeAttachment'],
+                            operation: ['sendMessage', 'sendReaction', 'removeReaction', 'startTyping', 'stopTyping', 'getContacts', 'getGroups', 'createGroup', 'updateGroup', 'listAttachments', 'downloadAttachment', 'removeAttachment'],
                         },
                     },
                     typeOptions: {
@@ -295,10 +304,16 @@ class Signal {
         this.logger.debug(`Signal: Starting execute for operation ${operation}, items length: ${items.length}`);
         for (let i = 0; i < items.length; i++) {
             const timeout = this.getNodeParameter('timeout', i, operation === 'getGroups' ? 300 : 60) * 1000;
+            const binaryFields = this.getNodeParameter('binaryFields', i, {});
+            const inputBinaryFields = binaryFields.binaryFieldValues
+                ? binaryFields.binaryFieldValues
+                    .map(value => value.inputBinaryField)
+                    .filter(field => field.trim() !== '') // Filter out empty fields
+                : [];
+            this.logger.debug(`Signal: Input binary fields for item ${i}: ${JSON.stringify(inputBinaryFields)}`);
             const params = {
                 recipient: this.getNodeParameter('recipient', i, ''),
                 message: this.getNodeParameter('message', i, ''),
-                attachmentUrl: this.getNodeParameter('attachmentUrl', i, ''),
                 groupId: this.getNodeParameter('groupId', i, ''),
                 groupName: this.getNodeParameter('groupName', i, ''),
                 groupMembers: this.getNodeParameter('groupMembers', i, ''),
@@ -306,6 +321,7 @@ class Signal {
                 targetAuthor: this.getNodeParameter('targetAuthor', i, ''),
                 targetSentTimestamp: this.getNodeParameter('targetSentTimestamp', i, 0),
                 attachmentId: this.getNodeParameter('attachmentId', i, ''),
+                inputBinaryFields,
                 timeout,
                 apiUrl,
                 apiToken,
@@ -313,7 +329,7 @@ class Signal {
             };
             try {
                 let result;
-                if (['sendMessage', 'sendAttachment', 'sendReaction', 'removeReaction', 'startTyping', 'stopTyping'].includes(operation)) {
+                if (['sendMessage', 'sendReaction', 'removeReaction', 'startTyping', 'stopTyping'].includes(operation)) {
                     result = await messages_1.executeMessagesOperation.call(this, operation, i, params);
                 }
                 else if (['listAttachments', 'downloadAttachment', 'removeAttachment'].includes(operation)) {

package/dist/nodes/Signal/messages.d.ts

@@ -2,10 +2,10 @@ import { IExecuteFunctions, INodeExecutionData } from 'n8n-workflow';
 interface OperationParams {
     recipient?: string;
     message?: string;
-    attachmentUrl?: string;
     emoji?: string;
     targetAuthor?: string;
     targetSentTimestamp?: number;
+    inputBinaryFields?: string[];
     timeout: number;
     apiUrl: string;
     apiToken: string;

package/dist/nodes/Signal/messages.js

@@ -8,7 +8,7 @@ const n8n_workflow_1 = require("n8n-workflow");
 const axios_1 = __importDefault(require("axios"));
 async function executeMessagesOperation(operation, itemIndex, params) {
     var _a, _b, _c, _d;
-    const { recipient, message, attachmentUrl, emoji, targetAuthor, targetSentTimestamp, timeout, apiUrl, apiToken, phoneNumber } = params;
+    const { recipient, message, emoji, targetAuthor, targetSentTimestamp, inputBinaryFields, timeout, apiUrl, apiToken, phoneNumber } = params;
     const axiosConfig = {
         headers: apiToken ? { Authorization: `Bearer ${apiToken}` } : {},
         timeout,
@@ -27,23 +27,74 @@ async function executeMessagesOperation(operation, itemIndex, params) {
     };
     try {
         if (operation === 'sendMessage') {
-            const response = await retryRequest(() => axios_1.default.post(`${apiUrl}/v1/send`, {
+            if (!recipient) {
+                throw new n8n_workflow_1.NodeApiError(this.getNode(), {
+                    message: 'Recipient is required for sending a message',
+                }, { itemIndex });
+            }
+            const body = {
                 message,
                 number: phoneNumber,
                 recipients: [recipient],
-            }, axiosConfig));
+            };
+            // Handle binary attachments if inputBinaryFields are specified and valid
+            if (inputBinaryFields && inputBinaryFields.length > 0) {
+                const binary = this.getInputData()[itemIndex].binary;
+                if (!binary) {
+                    this.logger.debug(`Signal: No binary data for item ${itemIndex}, skipping attachments`);
+                }
+                else {
+                    const base64Attachments = [];
+                    for (const inputBinaryField of inputBinaryFields) {
+                        if (!inputBinaryField || !binary[inputBinaryField]) {
+                            this.logger.debug(`Signal: No binary data for field '${inputBinaryField}' in item ${itemIndex}, skipping`);
+                            continue;
+                        }
+                        const binaryData = binary[inputBinaryField];
+                        // Skip if binary data is empty
+                        if (!binaryData.data || binaryData.data.length === 0) {
+                            this.logger.debug(`Signal: Binary data in field '${inputBinaryField}' is empty for item ${itemIndex}, skipping`);
+                            continue;
+                        }
+                        // Check file size (Signal limit: 100MB)
+                        const maxFileSizeBytes = 99 * 1024 * 1024; // 99MB to be safe
+                        const binaryBuffer = Buffer.from(binaryData.data, 'base64');
+                        if (binaryBuffer.length > maxFileSizeBytes) {
+                            throw new n8n_workflow_1.NodeApiError(this.getNode(), {
+                                message: `File size exceeds Signal's 100MB limit (size: ${(binaryBuffer.length / (1024 * 1024)).toFixed(2)}MB). See https://support.signal.org/hc/en-us/articles/360007320391-What-kinds-of-files-can-I-send`,
+                            }, { itemIndex });
+                        }
+                        // Convert binary data to base64
+                        const base64Data = binaryBuffer.toString('base64');
+                        const mimeType = binaryData.mimeType || 'application/octet-stream';
+                        const fileName = binaryData.fileName || `attachment_${itemIndex}_${inputBinaryField}`;
+                        // Use data URI format with MIME type and filename (without encoding)
+                        const base64Attachment = `data:${mimeType};filename=${fileName};base64,${base64Data}`;
+                        base64Attachments.push(base64Attachment);
+                        this.logger.debug(`Signal: Added base64 attachment for item ${itemIndex}, field '${inputBinaryField}': ${fileName}, MIME: ${mimeType}, Size: ${binaryBuffer.length} bytes`);
+                        this.logger.debug(`Signal: Attachment format: ${base64Attachment.substring(0, 100)}...`);
+                    }
+                    if (base64Attachments.length > 0) {
+                        body.base64_attachments = base64Attachments;
+                    }
+                    else {
+                        this.logger.debug(`Signal: No valid attachments for item ${itemIndex}, sending text only`);
+                    }
+                }
+            }
+            // Use /v2/send if base64_attachments are present, otherwise /v1/send
+            const endpoint = body.base64_attachments ? `${apiUrl}/v2/send` : `${apiUrl}/v1/send`;
+            this.logger.debug(`Signal: Sending request to ${endpoint} with body: ${JSON.stringify(body, null, 2)}`);
+            const response = await retryRequest(() => axios_1.default.post(endpoint, body, axiosConfig));
+            this.logger.debug(`Signal: Response: ${JSON.stringify(response.data, null, 2)}`);
             return { json: response.data || { status: 'Message sent' }, pairedItem: { item: itemIndex } };
         }
-        else if (operation === 'sendAttachment') {
-            const response = await retryRequest(() => axios_1.default.post(`${apiUrl}/v1/send`, {
-                message,
-                number: phoneNumber,
-                recipients: [recipient],
-                attachments: [attachmentUrl],
-            }, axiosConfig));
-            return { json: response.data || { status: 'Attachment sent' }, pairedItem: { item: itemIndex } };
-        }
         else if (operation === 'sendReaction') {
+            if (!recipient) {
+                throw new n8n_workflow_1.NodeApiError(this.getNode(), {
+                    message: 'Recipient is required for sending a reaction',
+                }, { itemIndex });
+            }
             const response = await retryRequest(() => axios_1.default.post(`${apiUrl}/v1/reactions/${phoneNumber}`, {
                 reaction: emoji,
                 recipient,
@@ -53,6 +104,11 @@ async function executeMessagesOperation(operation, itemIndex, params) {
             return { json: response.data || { status: 'Reaction sent' }, pairedItem: { item: itemIndex } };
         }
         else if (operation === 'removeReaction') {
+            if (!recipient) {
+                throw new n8n_workflow_1.NodeApiError(this.getNode(), {
+                    message: 'Recipient is required for removing a reaction',
+                }, { itemIndex });
+            }
             const response = await retryRequest(() => axios_1.default.delete(`${apiUrl}/v1/reactions/${phoneNumber}`, {
                 ...axiosConfig,
                 data: {
@@ -64,6 +120,11 @@ async function executeMessagesOperation(operation, itemIndex, params) {
             return { json: response.data || { status: 'Reaction removed' }, pairedItem: { item: itemIndex } };
         }
         else if (operation === 'startTyping') {
+            if (!recipient) {
+                throw new n8n_workflow_1.NodeApiError(this.getNode(), {
+                    message: 'Recipient is required for starting typing indicator',
+                }, { itemIndex });
+            }
             const response = await retryRequest(() => axios_1.default.put(`${apiUrl}/v1/typing-indicator/${phoneNumber}`, {
                 recipient,
                 action: "start",
@@ -80,6 +141,11 @@ async function executeMessagesOperation(operation, itemIndex, params) {
             };
         }
         else if (operation === 'stopTyping') {
+            if (!recipient) {
+                throw new n8n_workflow_1.NodeApiError(this.getNode(), {
+                    message: 'Recipient is required for stopping typing indicator',
+                }, { itemIndex });
+            }
             const response = await retryRequest(() => axios_1.default.put(`${apiUrl}/v1/typing-indicator/${phoneNumber}`, {
                 recipient,
                 action: "stop",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n8n-nodes-signal-cli-rest-api",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Signal Node for n8n using signal-cli-rest-api",
   "repository": {
     "type": "git",