@patricktobias86/node-red-telegram-account 1.0.6

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/README.md

@@ -0,0 +1 @@
+Node-red and telegram (gramjs) integration

package/nodes/auth.html

@@ -0,0 +1,138 @@
+<script type="text/javascript">
+    RED.nodes.registerType('auth', {
+        category: 'telegram-account',
+        color: '#a6bbcf',
+        defaults: {
+            api_id: { value: "", required: true },
+            api_hash: { value: "", required: true },
+            phoneNumber: { value: "", required: true },
+            password: { value: "" },
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "font-awesome/fa-lock",
+        label: function () {
+            return this.name || "Telegram Auth";
+        },
+        oneditprepare: function () {
+            // Инициализация значений
+            $("#node-input-api_id").val(this.api_id || "");
+            $("#node-input-api_hash").val(this.api_hash || "");
+            $("#node-input-phoneNumber").val(this.phoneNumber || "");
+            $("#node-input-password").val(this.password || "");
+        },
+        oneditsave: function () {
+            // Сохранение значений
+            this.api_id = $("#node-input-api_id").val();
+            this.api_hash = $("#node-input-api_hash").val();
+            this.phoneNumber = $("#node-input-phoneNumber").val();
+            this.password = $("#node-input-password").val();
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="auth">
+<div class="form-row">
+    <label for="node-input-api_id">
+        <i class="fa fa-key"></i> API ID
+    </label>
+    <input type="text" id="node-input-api_id" placeholder="Enter your API ID">
+</div>
+
+<div class="form-row">
+    <label for="node-input-api_hash">
+        <i class="fa fa-lock"></i> API Hash
+    </label>
+    <input type="text" id="node-input-api_hash" placeholder="Enter your API Hash">
+</div>
+
+<div class="form-row">
+    <label for="node-input-phoneNumber">
+        <i class="fa fa-phone"></i> Phone Number
+    </label>
+    <input type="text" id="node-input-phoneNumber" placeholder="Enter your phone number">
+</div>
+
+<div class="form-row">
+    <label for="node-input-password">
+        <i class="fa fa-unlock-alt"></i> Password (optional)
+    </label>
+    <input type="password" id="node-input-password" placeholder="Enter your password (if any)">
+</div>
+
+<p>
+    <strong>Note:</strong> This configuration is required for connecting to the Telegram API and starting a session.
+</p>
+</script>
+
+
+<script type="text/html" data-help-name="auth">
+    <p>The <b>auth</b> node facilitates Telegram API authentication using the <code>telegram</code> library. It allows users to authenticate a session and retrieve a stringSession for future use.</p>
+
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>payload.api_id
+            <span class="property-type">number | string</span>
+        </dt>
+        <dd>The Telegram API ID. Required for authentication.</dd>
+        
+        <dt>payload.api_hash
+            <span class="property-type">string</span>
+        </dt>
+        <dd>The Telegram API hash. Required for authentication.</dd>
+        
+        <dt>payload.phoneNumber
+            <span class="property-type">string</span>
+        </dt>
+        <dd>The phone number associated with the Telegram account.</dd>
+        
+        <dt>payload.password
+            <span class="property-type">string</span>
+        </dt>
+        <dd>The password for two-factor authentication (if enabled on the Telegram account).</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <dl class="message-properties">
+        <dt>topic
+            <span class="property-type">string</span>
+        </dt>
+        <dd>
+            - <b>"auth_success"</b>: Authentication was successful.  
+            - <b>"auth_error"</b>: An error occurred during authentication.
+        </dd>
+
+        <dt>payload
+            <span class="property-type">object</span>
+        </dt>
+        <dd>
+            For <b>"auth_success"</b>:  
+            <ul>
+                <li><code>payload.stringSession</code>: The generated session string.</li>
+                <li><code>payload.message</code>: Success message.</li>
+            </ul>
+            For <b>"auth_error"</b>:  
+            <ul>
+                <li><code>payload.error</code>: The error message describing the issue.</li>
+            </ul>
+        </dd>
+    </dl>
+
+    <h3>Details</h3>
+    <p>To use the <b>auth</b> node, pass the required API credentials and phone number as part of the input message payload. The node will initiate the Telegram authentication flow. If a two-factor password is required, include it in the <code>payload.password</code>.</p>
+
+    <p>The node temporarily stores the phone code resolver in the flow context under the key <code>phoneCode</code>. This allows subsequent nodes to resolve the phone code using a separate input mechanism, such as user interaction.</p>
+
+    <h3>Example</h3>
+    <pre>
+    {
+        "payload": {
+            "api_id": 123456,
+            "api_hash": "your_api_hash",
+            "phoneNumber": "+123456789",
+            "password": "your_password"
+        }
+    }
+    </pre>
+    <p>This example input payload initiates the authentication process. Upon receiving the phone code, it should be resolved using a dedicated node or interface.</p>
+</script>

package/nodes/auth.js

@@ -0,0 +1,60 @@
+const { TelegramClient } = require("telegram");
+const { StringSession } = require("telegram/sessions");
+
+module.exports = function (RED) {
+    function TelegramClientConfig(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        this.on("input", async (msg) => {
+            const api_idString = msg.payload.api_id || config.api_id;
+            const api_hash = msg.payload.api_hash || config.api_hash;
+            const phoneNumber = msg.payload.phoneNumber || config.phoneNumber;
+            const password = msg.payload.password || config.password;
+            const api_id = parseInt(api_idString);
+
+            const session = new StringSession("");
+            const client = new TelegramClient(session, api_id, api_hash, {
+                connectionRetries: 5,
+            });
+
+ 
+            let resolvePhoneCode;
+            const context = node.context().flow;
+
+            try {
+                await client.start({
+                    phoneNumber: () => phoneNumber,
+                    password: () => password,
+                    phoneCode: async () =>{
+                        return new Promise((resolve) => {
+                            resolvePhoneCode = resolve;
+                            context.set("phoneCode", resolvePhoneCode);
+                        })
+                    },
+                    onError: (err) => node.error(`Ошибка: ${err.message}`),
+                });
+
+                const stringSession = client.session.save(); // Сохраняем сессию
+                node.send({
+                    topic: "auth_success",
+                    payload: {
+                        stringSession,
+                        message: "Авторизация прошла успешно!",
+                    },
+                });
+               
+            } catch (error) {
+                node.error(`Ошибка авторизации: ${error.message}`);
+                node.send({
+                    topic: "auth_error",
+                    payload: {
+                        error: error.message,
+                    },
+                });
+            }
+        });
+    }
+
+    RED.nodes.registerType("auth", TelegramClientConfig);
+};

package/nodes/command.html

@@ -0,0 +1,135 @@
+<script type="text/javascript">
+    RED.nodes.registerType('command', {
+      category: 'telegram-account',
+      color: '#229ED9',
+      icon: 'tg.png',
+      align:"right",
+      defaults: {
+        name: { value: '' },
+        config: { type: 'config', required: false },
+        command: { value: "", required:true },
+        regex:{ value:false }
+      },
+      inputs: 1,
+      outputs: 1,
+      label: function () {
+        return this.name || 'Command';
+      },
+      
+    });
+</script>
+
+<script type="text/html" data-template-name="command">
+    <div class="form-row">
+      <label for="node-input-name">
+        <i class="fa fa-tag"></i> Name
+      </label>
+      <input
+        type="text"
+        id="node-input-name"
+        placeholder="Name"
+        style="width: 60%"
+      />
+    </div>
+    <div class="form-row">
+      <label for="node-input-config">
+        <i class="fa fa-tag"></i> Config
+      </label>
+      <input
+        type="text"
+        id="node-input-config"
+        placeholder="Config"
+        style="width: 60%"
+      />
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-command">
+          <i class="fa fa-tag"></i> Message
+        </label>
+        <input type="text" id="node-input-command" placeholder="Message">
+    </div>
+
+    <div class="form-row">
+      <label for="regex">
+        <i class="fa fa-cog"></i><span>Regular expression</span>
+      </label>
+      <input type="checkbox" style="display: inline; width: 22px;vertical-align: top;" id="node-input-regex">
+    </div>
+  </script>
+
+  <script type="text/html" data-help-name="command">
+    <p>The <b>command</b> node listens for specific commands or patterns in Telegram messages and triggers further processing when a match is found. It supports both exact matches and regex-based pattern matching.</p>
+
+    <h3>Inputs</h3>
+    <p>This node does not take any direct inputs. Instead, it listens for incoming messages from the Telegram bot or user.</p>
+
+    <h3>Outputs</h3>
+    <dl class="message-properties">
+        <dt>payload.update
+            <span class="property-type">object</span>
+        </dt>
+        <dd>The raw Telegram update object, containing the details of the matched message, including text, sender, chat ID, and other metadata.</dd>
+    </dl>
+
+    <h3>Configuration</h3>
+    <dl class="message-properties">
+        <dt>Command
+            <span class="property-type">string</span>
+        </dt>
+        <dd>The text or pattern to match against incoming messages. For example, <code>/start</code> or <code>/help</code>.</dd>
+
+        <dt>Regex
+            <span class="property-type">boolean</span>
+        </dt>
+        <dd>If checked, treats the <b>Command</b> field as a regular expression. This allows for advanced pattern matching (e.g., <code>^/command\\s*</code>).</dd>
+
+        <dt>Telegram Configuration
+            <span class="property-type">node</span>
+        </dt>
+        <dd>A configured Telegram client node to listen for messages. Ensure the client has the necessary permissions and is correctly authenticated.</dd>
+    </dl>
+
+    <h3>Details</h3>
+    <p>The <b>command</b> node integrates with the Telegram API to monitor incoming messages in real time. When a message matches the configured command or regex, the node outputs the Telegram update object for further processing. This is particularly useful for creating bots that respond to specific commands.</p>
+
+    <h3>Example</h3>
+    <pre>
+    {
+        "payload": {
+            "update": {
+                "message": {
+                    "message": "/start",
+                    "sender": {
+                        "id": 123456789,
+                        "username": "exampleuser"
+                    },
+                    "chat": {
+                        "id": 987654321,
+                        "type": "private"
+                    }
+                }
+            }
+        }
+    }
+    </pre>
+    <p>This example output is triggered when the bot receives the <code>/start</code> command. The <code>update</code> object contains metadata about the message, sender, and chat.</p>
+
+    <h3>Error Handling</h3>
+    <p>If the Telegram client fails to authenticate or there is an error in the configuration, the node logs an error message and stops functioning.</p>
+
+    <h3>Advanced Usage</h3>
+    <p>By enabling the <b>Regex</b> option, you can create dynamic commands or match patterns such as:</p>
+    <ul>
+        <li><code>^/command\\s*</code>: Matches the command followed by optional whitespace.</li>
+        <li><code>^/start|/help$</code>: Matches either <code>/start</code> or <code>/help</code>.</li>
+    </ul>
+    <p>This makes the <b>command</b> node versatile for building complex Telegram bot functionality.</p>
+
+    <h3>Notes</h3>
+    <ul>
+        <li>Ensure the Telegram bot has sufficient permissions to receive messages in the configured chat or channel.</li>
+        <li>Regular expressions should be carefully tested to avoid unintended matches or errors.</li>
+    </ul>
+</script>
+

package/nodes/command.js

@@ -0,0 +1,53 @@
+const { NewMessage } = require("telegram/events");
+
+
+module.exports = function (RED) {
+  function Command(config) {
+    RED.nodes.createNode(this, config);
+    this.config = RED.nodes.getNode(config.config);
+    var node = this;
+    /** @type {TelegramClient} */
+    const client =  this.config.client;
+
+    
+
+    try {
+      client.addEventHandler((update) => {
+        const message = update.message.message
+        if (message) {
+            if (config.regex) {
+                const regex = new RegExp(config.command);
+
+                if (regex.test(message)) {
+                    
+                    var msg = {
+                        payload: {
+                            update
+                        }
+                    };
+
+                    
+                    node.send(msg);
+                }
+            } else if (message === config.command) {
+                
+                var msg = {
+                    payload: {
+                        update
+                    }
+                };
+
+                
+                node.send(msg);
+            }
+        }
+      }, new NewMessage());
+      
+    } catch (err) {
+      node.error('Ошибка авторизации: ' + err.message);
+    }
+
+  }
+
+  RED.nodes.registerType('command', Command);
+};

package/nodes/config.html

@@ -0,0 +1,131 @@
+<script type="text/javascript">
+  RED.nodes.registerType('config',{
+      category: 'config',
+      defaults: {
+          name: { value: '' },
+          api_id: {value:"", required:true},
+          api_hash: {value:"", required:true},
+          session: {value:"", required:true},
+          useIPV6: {value: undefined},
+          timeout: {value: undefined},
+          requestRetries: {value: undefined},
+          connectionRetries: {value: undefined},
+          proxy: {value: undefined},
+          downloadRetries: {value: undefined},
+          retryDelay: {value: undefined},
+          autoReconnect: {value: undefined},
+          sequentialUpdates: {value: undefined},
+          floodSleepThreshold: {value: undefined},
+          deviceModel: {value: undefined},
+          systemVersion: {value: undefined},
+          appVersion: {value: undefined},
+          langCode: {value: undefined},
+          systemLangCode: {value: undefined},
+          useWSS: {value: undefined},
+          maxConcurrentDownloads: {value: undefined},
+          securityChecks: {value: undefined},
+          testServers: {value: undefined}
+      },
+      label: function() {
+          return this.name || "Telegram Client Config";
+      },
+      oneditprepare: function() {
+   
+      }
+  });
+</script>
+
+<script type="text/html" data-template-name="config">
+  <div class="form-row">
+      <label for="node-config-input-name"><i class="icon-tasks"></i>Name</label>
+      <input type="text" id="node-config-input-name" placeholder="Name" style="width:70%" ng-model="node.api_id">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-api_id"><i class="icon-tasks"></i> API ID</label>
+      <input type="text" id="node-config-input-api_id" placeholder="Enter API ID" style="width:70%" ng-model="node.api_id">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-api_hash"><i class="icon-tasks"></i> API Hash</label>
+      <input type="text" id="node-config-input-api_hash" placeholder="Enter API Hash" style="width:70%" ng-model="node.api_hash">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-session"><i class="icon-tasks"></i> Session</label>
+      <input type="text" id="node-config-input-session" placeholder="Enter Session" style="width:70%" ng-model="node.session">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-useIPV6"><i class="icon-tasks"></i> Use IPV6</label>
+      <input type="checkbox" id="node-config-input-useIPV6" ng-model="node.useIPV6">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-timeout"><i class="icon-tasks"></i> Timeout</label>
+      <input type="number" id="node-config-input-timeout" placeholder="Enter Timeout" style="width:70%" ng-model="node.timeout">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-requestRetries"><i class="icon-tasks"></i> Request Retries</label>
+      <input type="number" id="node-config-input-requestRetries" placeholder="Enter Request Retries" style="width:70%" ng-model="node.requestRetries">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-connectionRetries"><i class="icon-tasks"></i> Connection Retries</label>
+      <input type="number" id="node-config-input-connectionRetries" placeholder="Enter Connection Retries" style="width:70%" ng-model="node.connectionRetries">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-proxy"><i class="icon-tasks"></i> Proxy</label>
+      <input type="text" id="node-config-input-proxy" placeholder="Enter Proxy" style="width:70%" ng-model="node.proxy">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-downloadRetries"><i class="icon-tasks"></i> Download Retries</label>
+      <input type="number" id="node-config-input-downloadRetries" placeholder="Enter Download Retries" style="width:70%" ng-model="node.downloadRetries">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-retryDelay"><i class="icon-tasks"></i> Retry Delay</label>
+      <input type="number" id="node-config-input-retryDelay" placeholder="Enter Retry Delay" style="width:70%" ng-model="node.retryDelay">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-autoReconnect"><i class="icon-tasks"></i> Auto Reconnect</label>
+      <input type="checkbox" id="node-config-input-autoReconnect" ng-model="node.autoReconnect">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-sequentialUpdates"><i class="icon-tasks"></i> Sequential Updates</label>
+      <input type="checkbox" id="node-config-input-sequentialUpdates" ng-model="node.sequentialUpdates">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-floodSleepThreshold"><i class="icon-tasks"></i> Flood Sleep Threshold</label>
+      <input type="number" id="node-config-input-floodSleepThreshold" placeholder="Enter Flood Sleep Threshold" style="width:70%" ng-model="node.floodSleepThreshold">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-deviceModel"><i class="icon-tasks"></i> Device Model</label>
+      <input type="text" id="node-config-input-deviceModel" placeholder="Enter Device Model" style="width:70%" ng-model="node.deviceModel">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-systemVersion"><i class="icon-tasks"></i> System Version</label>
+      <input type="text" id="node-config-input-systemVersion" placeholder="Enter System Version" style="width:70%" ng-model="node.systemVersion">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-appVersion"><i class="icon-tasks"></i> App Version</label>
+      <input type="text" id="node-config-input-appVersion" placeholder="Enter App Version" style="width:70%" ng-model="node.appVersion">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-langCode"><i class="icon-tasks"></i> Language Code</label>
+      <input type="text" id="node-config-input-langCode" placeholder="Enter Language Code" style="width:70%" ng-model="node.langCode">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-systemLangCode"><i class="icon-tasks"></i> System Language Code</label>
+      <input type="text" id="node-config-input-systemLangCode" placeholder="Enter System Language Code" style="width:70%" ng-model="node.systemLangCode">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-useWSS"><i class="icon-tasks"></i> Use WSS</label>
+      <input type="checkbox" id="node-config-input-useWSS" ng-model="node.useWSS">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-maxConcurrentDownloads"><i class="icon-tasks"></i> Max Concurrent Downloads</label>
+      <input type="number" id="node-config-input-maxConcurrentDownloads" placeholder="Enter Max Concurrent Downloads" style="width:70%" ng-model="node.maxConcurrentDownloads">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-securityChecks"><i class="icon-tasks"></i> Security Checks</label>
+      <input type="checkbox" id="node-config-input-securityChecks" ng-model="node.securityChecks">
+  </div>
+  <div class="form-row">
+      <label for="node-config-input-testServers"><i class="icon-tasks"></i> Test Servers</label>
+      <input type="checkbox" id="node-config-input-testServers" ng-model="node.testServers">
+  </div>
+</script>

package/nodes/config.js

@@ -0,0 +1,58 @@
+const { TelegramClient } = require("telegram");
+const { StringSession } = require("telegram/sessions");
+
+module.exports = function (RED) {
+    function TelegramClientConfig(config) {
+        RED.nodes.createNode(this, config);
+        this.apiId = config.api_id;
+        this.apiHash = config.api_hash;
+        this.session = new StringSession(config.session);
+        this.useIPV6 = config.useIPV6;
+        this.timeout = config.timeout;
+        this.requestRetries = config.requestRetries;
+        this.connectionRetries = config.connectionRetries;
+        this.proxy = config.proxy;
+        this.downloadRetries = config.downloadRetries;
+        this.retryDelay = config.retryDelay;
+        this.autoReconnect = config.autoReconnect;
+        this.sequentialUpdates = config.sequentialUpdates;
+        this.floodSleepThreshold = config.floodSleepThreshold;
+        this.deviceModel = config.deviceModel;
+        this.systemVersion = config.systemVersion;
+        this.appVersion = config.appVersion;
+        this.langCode = config.langCode;
+        this.systemLangCode = config.systemLangCode;
+        this.useWSS = config.useWSS;
+        this.maxConcurrentDownloads = config.maxConcurrentDownloads;
+        this.securityChecks = config.securityChecks;
+        this.testServers = config.testServers;
+        const node = this;
+
+
+        this.client = new TelegramClient(this.session, parseInt(this.apiId), this.apiHash, {
+           
+           
+        });
+
+        try {
+            this.client.connect().then(async () => {
+                let isAuthorized = await this.client.isUserAuthorized();
+                if (!isAuthorized) {
+                    node.error(`Session is invalid`);
+                } else {
+                    node.status({ fill: "green", shape: "dot", text: "Connected" });
+                }
+            });
+        } catch (err) {
+            node.error('Authorisation error: ' + err.message);
+        }
+
+        this.on("close", () => {
+            if (this.client) {
+                this.client.disconnect();
+                node.status({ fill: "red", shape: "ring", text: "Disconnected" });
+            }
+        });
+    }
+    RED.nodes.registerType('config', TelegramClientConfig);
+};