@patricktobias86/node-red-telegram-account 1.1.10 → 1.1.12

package/CHANGELOG.md

@@ -19,3 +19,11 @@ All notable changes to this project will be documented in this file.
 ### Changed
 - `delete-message` now forwards the original message along with the Telegram API response.
 
+## [1.1.11] - 2025-08-04
+### Fixed
+- All nodes now preserve properties on the incoming message outside of the payload.
+
+## [1.1.12] - 2025-08-06
+### Fixed
+- Auth node now emits the generated `stringSession` so it can be used by other nodes.
+

package/README.md

@@ -17,7 +17,7 @@ This package contains a collection of Node‑RED nodes built on top of [GramJS](
 See [docs/NODES.md](docs/NODES.md) for a detailed description of every node. Below is a quick summary:
 
 - **config** – stores your API credentials and caches sessions for reuse.
-- **auth** – interactive login that outputs a `stringSession`.
+- **auth** – interactive login that outputs a `stringSession` (also set on `msg.stringSession`).
 - **receiver** – emits messages for every incoming update (with optional ignore list). Event listeners are cleaned up on node close so redeploys won't duplicate messages.
 - **command** – triggers when an incoming message matches a command or regex. Event listeners are removed on redeploy to prevent duplicates.
 - **send-message** – sends text or media messages with rich options.
@@ -29,6 +29,8 @@ See [docs/NODES.md](docs/NODES.md) for a detailed description of every node. Bel
 - **promote-admin** – promotes a user to admin with configurable rights.
 - **resolve-userid** – converts a username to a numeric user ID.
 
+All nodes preserve any properties on the incoming message outside of <code>msg.payload</code>.
+
 All nodes include a <code>Debug</code> option that logs incoming and outgoing messages to the Node-RED log when enabled.
 
 ## Session management

package/docs/NODES.md

@@ -7,7 +7,7 @@ Below is a short description of each node. For a full list of configuration opti
 | Node | Description |
 |------|-------------|
 | **config** | Configuration node storing API credentials and connection options. Other nodes reference this to share a Telegram client and reuse the session. Connections are tracked in a Map with a reference count so multiple nodes can wait for the same connection. |
-| **auth** | Starts an interactive login flow. Produces a `stringSession` that can be reused with the `config` node. |
+| **auth** | Starts an interactive login flow. Produces a `stringSession` (available in both <code>msg.payload.stringSession</code> and <code>msg.stringSession</code>) that can be reused with the `config` node. |
 | **receiver** | Emits an output message for every incoming Telegram message. Can ignore specific user IDs. Event handlers are automatically removed when the node is closed. |
 | **command** | Listens for new messages and triggers when a message matches a configured command or regular expression. The event listener is cleaned up on node close to avoid duplicates. |
 | **send-message** | Sends text messages or media files to a chat. Supports parse mode, buttons, scheduling, and more. |
@@ -19,6 +19,7 @@ Below is a short description of each node. For a full list of configuration opti
 | **promote-admin** | Grants admin rights to a user in a group or channel with configurable permissions. |
 | **resolve-userid** | Converts a Telegram username to its numeric user ID. |
 
+All nodes forward any properties on the incoming `msg` outside of `msg.payload` unchanged.
 
 All nodes provide a **Debug** checkbox. When enabled the node will log its input and output messages to aid troubleshooting.
 

package/nodes/auth.html

@@ -130,6 +130,8 @@ if (typeof wait === "function") {
                 <li><code>message</code> or <code>error</code>: Additional info.</li>
             </ul>
         </dd>
+        <dt>stringSession <span class="property-type">string</span></dt>
+        <dd>A copy of the session string for easier access.</dd>
     </dl>
 
     <h3>Example</h3>

package/nodes/auth.js

@@ -49,6 +49,7 @@ module.exports = function (RED) {
                 });
 
                 const stringSession = client.session.save();
+                await client.disconnect();
 
                 console.log("Sending result to output:", {
                     stringSession,
@@ -57,12 +58,13 @@ module.exports = function (RED) {
                         { type: "session_token", text: "Copy this stringSession to use in other nodes." }
                     ]
                 });
-
                 const out = {
+                    ...msg,
                     topic: "auth_success",
+                    stringSession,
                     payload: {
                         stringSession,
-                        message: "Authorization successful!"
+                        message: "Authorization successful!",
                     }
                 };
                 node.send(out);
@@ -73,12 +75,12 @@ module.exports = function (RED) {
                 node.status({ fill: "green", shape: "dot", text: "Authenticated" });
 
             } catch (err) {
-                node.error("Authentication failed: " + err.message);
-                const out = { topic: "auth_error", payload: { error: err.message } };
-                node.send(out);
-                if (debug) {
-                    node.log('auth output: ' + JSON.stringify(out));
-                }
+                 node.error("Authentication failed: " + err.message);
+                 const out = { ...msg, topic: "auth_error", payload: { error: err.message } };
+                 node.send(out);
+                 if (debug) {
+                     node.log('auth output: ' + JSON.stringify(out));
+                 }
                 node.status({ fill: "red", shape: "ring", text: "Failed" });
             }
         });

package/nodes/get-entity.js

@@ -25,14 +25,14 @@ module.exports = function (RED) {
                     entity = await client.getEntity(input);
                 }
 
-                const out = { payload: { input: entity } };
+                const out = { ...msg, payload: { input: entity } };
                 node.send(out);
                 if (debug) {
                     node.log('get-entity output: ' + JSON.stringify(out));
                 }
             } catch (err) {
                 node.error('Error getting entity: ' + err.message);
-                const out = { payload: { input: null } };
+                const out = { ...msg, payload: { input: null } };
                 node.send(out);
                 if (debug) {
                     node.log('get-entity output: ' + JSON.stringify(out));

package/nodes/iter-dialogs.js

@@ -45,7 +45,7 @@ module.exports = function (RED) {
                     dialogs[dialog.id] = dialog;
                     console.log(`${dialog.id}: ${dialog.title}`);
                 }
-                const out = { payload: { dialogs } };
+                const out = { ...msg, payload: { dialogs } };
                 node.send(out);
                 if (debug) {
                     node.log('iter-dialogs output: ' + JSON.stringify(out));

package/nodes/iter-messages.js

@@ -84,8 +84,8 @@ module.exports = function (RED) {
                         console.log(message.id, message.text);
                     }
                 }
-                
-                const out = { payload: { messages } };
+
+                const out = { ...msg, payload: { messages } };
                 node.send(out);
                 if (debug) {
                     node.log('iter-messages output: ' + JSON.stringify(out));

package/nodes/promote-admin.js

@@ -44,7 +44,7 @@ module.exports = function (RED) {
                     rank: rank,
                 }));
 
-                const out = { payload: { response: result } };
+                const out = { ...msg, payload: { response: result } };
                 node.send(out);
                 if (debug) {
                     node.log('promote-admin output: ' + JSON.stringify(out));

package/nodes/resolve-userid.js

@@ -30,14 +30,14 @@ module.exports = function(RED) {
                 } else if (entity?.userId) {
                     userId = entity.userId;
                 }
-                const out = { payload: { userId } };
+                const out = { ...msg, payload: { userId } };
                 node.send(out);
                 if (debug) {
                     node.log('resolve-userid output: ' + JSON.stringify(out));
                 }
             } catch (err) {
                 node.error('Error resolving username: ' + err.message);
-                const out = { payload: { userId: null } };
+                const out = { ...msg, payload: { userId: null } };
                 node.send(out);
                 if (debug) {
                     node.log('resolve-userid output: ' + JSON.stringify(out));

package/nodes/send-file.js

@@ -64,7 +64,7 @@ module.exports = function (RED) {
                 
                 // Send files
                 const response = await client.sendFile(chatId, params);
-                const out = { payload: response };
+                const out = { ...msg, payload: response };
                 node.send(out);
                 if (debug) {
                     node.log('send-files output: ' + JSON.stringify(out));

package/nodes/send-message.js

@@ -73,7 +73,7 @@ module.exports = function (RED) {
                     await client.sendMessage(entity, params);
                 }
 
-                const out = { payload: { response } };
+                const out = { ...msg, payload: { response } };
                 node.send(out);
                 if (debug) {
                     node.log('send-message output: ' + JSON.stringify(out));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patricktobias86/node-red-telegram-account",
-  "version": "1.1.10",
+  "version": "1.1.12",
   "description": "Node-RED nodes to communicate with GramJS.",
   "main": "nodes/config.js",
   "keywords": [

package/test/auth.test.js

@@ -0,0 +1,48 @@
+const assert = require('assert');
+const proxyquire = require('proxyquire').noPreserveCache();
+
+function setup() {
+  let NodeCtor;
+  let sent;
+  class TelegramClientStub {
+    constructor(session, id, hash, opts) {
+      this.session = { save: () => 'sess-string' };
+    }
+    start() { return Promise.resolve(); }
+    disconnect() { return Promise.resolve(); }
+  }
+  class StringSessionStub { constructor(str) {} }
+
+  const RED = {
+    nodes: {
+      createNode(node) {
+        node._events = {};
+        node.on = (e, fn) => { node._events[e] = fn; };
+        node.send = (msg) => { sent = msg; };
+        node.status = () => {};
+        node.log = () => {};
+        node.error = () => {};
+        node.context = () => ({ flow: { set() {}, get() {} } });
+      },
+      registerType(name, ctor) { NodeCtor = ctor; }
+    }
+  };
+
+  proxyquire('../nodes/auth.js', {
+    telegram: { TelegramClient: TelegramClientStub },
+    'telegram/sessions': { StringSession: StringSessionStub }
+  })(RED);
+
+  return { NodeCtor, getSent: () => sent };
+}
+
+describe('auth node', function() {
+  it('emits stringSession on successful auth', async function() {
+    const { NodeCtor, getSent } = setup();
+    const node = new NodeCtor({ api_id: 1, api_hash: 'hash', phoneNumber: '123' });
+    await node._events['input']({ payload: {} });
+    const out = getSent();
+    assert.strictEqual(out.stringSession, 'sess-string');
+    assert.strictEqual(out.payload.stringSession, 'sess-string');
+  });
+});

package/test/pass-through.test.js

@@ -0,0 +1,41 @@
+const assert = require('assert');
+const proxyquire = require('proxyquire').noPreserveCache();
+
+function setup() {
+  let NodeCtor;
+  let sent;
+  const configNode = { client: {} };
+  const RED = {
+    nodes: {
+      createNode(node) {
+        node._events = {};
+        node.on = (e, fn) => { node._events[e] = fn; };
+        node.send = (msg) => { sent = msg; };
+        node.log = () => {};
+        node.error = () => {};
+      },
+      registerType(name, ctor) { NodeCtor = ctor; },
+      getNode() { return configNode; }
+    }
+  };
+
+  proxyquire('../nodes/send-message.js', {
+    telegram: { TelegramClient: function() {} },
+    'telegram/Utils': { parseID: () => ({}) }
+  })(RED);
+
+  return { NodeCtor, getSent: () => sent };
+}
+
+describe('message property relay', function() {
+  it('keeps non-payload properties on send-message output', async function() {
+    const { NodeCtor, getSent } = setup();
+    const node = new NodeCtor({ config: 'c', file: "" });
+    const client = { sendMessage: async () => 'ok' };
+    const msg = { foo: 'bar', payload: { client, chatId: 'me', message: 'hi' } };
+    await node._events['input'](msg);
+    const out = getSent();
+    assert.strictEqual(out.foo, 'bar');
+    assert.deepStrictEqual(out.payload.response, 'ok');
+  });
+});