@patricktobias86/node-red-telegram-account 1.0.6

package/nodes/delete-message.html

@@ -0,0 +1,96 @@
+<script type="text/javascript">
+    RED.nodes.registerType('delete-message', {
+      category: 'telegram-account',
+      color: '#FF5733',
+      icon: 'tg.png',
+      align: 'right',
+      defaults: {
+        name: { value: '' },
+        config: { type: 'config', required: false },
+      },
+      inputs: 1,
+      outputs: 1,
+      label: function () {
+        return this.name || 'Delete Message';
+      },
+    });
+</script>
+
+<script type="text/html" data-template-name="delete-message">
+    <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-gear"></i> Config
+      </label>
+      <input
+        type="hidden"
+        id="node-input-config"
+        placeholder="Config"
+        style="width: 60%"
+      />
+    </div>
+  </script>
+
+
+  <script type="text/html" data-help-name="delete-message">
+    <p>The <b>delete-message</b> node allows you to delete messages from a Telegram chat. It supports deleting multiple messages at once and provides an option to revoke messages for all chat participants.</p>
+
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>payload.chatId
+            <span class="property-type">string</span>
+        </dt>
+        <dd>The ID or username of the chat from which the messages will be deleted. Use "me" for personal chats.</dd>
+        
+        <dt>payload.messageIds
+            <span class="property-type">number | array</span>
+        </dt>
+        <dd>The ID or an array of IDs of the messages to be deleted.</dd>
+        
+        <dt>payload.revoke
+            <span class="property-type">boolean</span>
+        </dt>
+        <dd>If true, the messages will be deleted for all participants in the chat (revoke). Defaults to true.</dd>
+        
+        <dt>payload.client
+            <span class="property-type">object</span>
+        </dt>
+        <dd>An optional Telegram client instance if not configured globally.</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <dl class="message-properties">
+        <dt>payload
+            <span class="property-type">object</span>
+        </dt>
+        <dd>The response from the Telegram API, confirming the deletion.</dd>
+    </dl>
+
+    <h3>Details</h3>
+    <p>The <b>delete-message</b> node uses the Telegram API to delete messages from a specified chat. It can delete a single message or multiple messages at once. If the <code>revoke</code> parameter is set to true, the messages will be removed for all participants, not just the sender.</p>
+
+    <h3>Example</h3>
+    <pre>
+    {
+        "payload": {
+            "chatId": "@example_user",
+            "messageIds": [12345, 12346],
+            "revoke": true
+        }
+    }
+    </pre>
+    <p>This input deletes the messages with IDs 12345 and 12346 from the chat with the user <code>@example_user</code>, revoking them for all participants.</p>
+
+    <h3>Configuration</h3>
+    <p>The node can use a globally configured Telegram client or a client instance provided in the message payload. Ensure that the client has the necessary permissions to delete messages from the specified chat.</p>
+</script>

package/nodes/delete-message.js

@@ -0,0 +1,27 @@
+module.exports = function (RED) {
+    function DeleteMessage(config) {
+        RED.nodes.createNode(this, config);
+        this.config = RED.nodes.getNode(config.config);
+        var node = this;
+
+        this.on('input', async function (msg) {
+            const chatId = msg.payload.chatId || config.chatId;
+            const messageIds = msg.payload.messageIds || config.messageIds;
+            const revoke = msg.payload.revoke || config.revoke || { revoke: true };
+              /** @type {TelegramClient} */
+            const client = msg.payload?.client ? msg.payload.client : this.config.client;
+
+            try {
+                const response = await client.deleteMessages(chatId, messageIds, revoke);
+
+                node.send({
+                    payload: response,
+                });
+            } catch (err) {
+                node.error('Error deleting message: ' + err.message);
+            }
+        });
+    }
+
+    RED.nodes.registerType('delete-message', DeleteMessage);
+};

package/nodes/get-entity.html

@@ -0,0 +1,87 @@
+<script type="text/javascript">
+    RED.nodes.registerType('get-entity', {
+        category: 'telegram-account',
+        color: '#229ED9',
+        icon: 'tg.png',
+        align: "right",
+        defaults: {
+            name: { value: '' },
+            config: { type: 'config', required: false },
+        },
+        inputs: 1,
+        outputs: 1,
+        label: function () {
+            return this.name || 'Get Entity';
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="get-entity">
+    <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>
+</script>
+
+<script type="text/html" data-help-name="get-entity">
+    <p>The <b>get-entity</b> node retrieves information about a Telegram entity (e.g., user, chat, or channel) using its identifier or URL.</p>
+
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>payload.input
+            <span class="property-type">string</span>
+        </dt>
+        <dd>The identifier (username, user ID, chat ID, or channel ID) or URL of the Telegram entity to retrieve. For example, "123456789", "@example_user", or "https://t.me/example_channel".</dd>
+
+        <dt>payload.client
+            <span class="property-type">object</span>
+        </dt>
+        <dd>An optional Telegram client instance if not configured globally.</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <dl class="message-properties">
+        <dt>payload.input
+            <span class="property-type">object</span>
+        </dt>
+        <dd>The retrieved entity object containing details about the user, chat, or channel.</dd>
+    </dl>
+
+    <h3>Details</h3>
+    <p>The <b>get-entity</b> node uses the Telegram API to fetch details about a specified entity. If the input is a Telegram URL (e.g., "https://t.me/example_user"), the node extracts the username or channel name and fetches the corresponding entity. For non-URL inputs, it directly retrieves the entity using the provided identifier.</p>
+
+    <h3>Example</h3>
+    <pre>
+    {
+        "payload": {
+            "input": "https://t.me/example_user"
+        }
+    }
+    </pre>
+    <p>This input retrieves the entity information for the Telegram user <code>example_user</code>.</p>
+
+    <h3>Error Handling</h3>
+    <p>If an error occurs while retrieving the entity (e.g., the identifier is invalid or the entity does not exist), the node logs an error and sends a message with <code>payload.input</code> set to <code>null</code>.</p>
+
+    <h3>Configuration</h3>
+    <p>The node can use a globally configured Telegram client or a client instance provided in the message payload. Ensure the client has the necessary permissions to access the requested entity.</p>
+</script>
+

package/nodes/get-entity.js

@@ -0,0 +1,36 @@
+module.exports = function (RED) {
+    function GetEntity(config) {
+        RED.nodes.createNode(this, config);
+        this.config = RED.nodes.getNode(config.config);
+        var node = this;
+
+        this.on('input', async function (msg) {
+            const input = msg.payload.input || config.input;
+              /** @type {TelegramClient} */
+            const client = msg.payload?.client ? msg.payload.client : this.config.client;
+
+            try {
+                let entity;
+
+                // Check if the input is a URL
+                if (input.includes('https://t.me/')) {
+                    const username = input.split('/').pop();
+                    entity = await client.getEntity(username);
+                } else {
+                    entity = await client.getEntity(input);
+                }
+
+                node.send({
+                    payload: {input:entity},
+                });
+            } catch (err) {
+                node.error('Error getting entity: ' + err.message);
+                node.send({
+                    payload:{ input: null}
+                })
+            }
+        });
+    }
+
+    RED.nodes.registerType('get-entity', GetEntity);
+};

package/nodes/iter-dialogs.html

@@ -0,0 +1,212 @@
+<script type="text/javascript">
+    RED.nodes.registerType('iter-dialogs', {
+        category: 'telegram',
+        color: '#32a3e0',
+        defaults: {
+            name: { value: '' },
+            config: { type: 'config', required: true },
+            limit: { value: "" },
+            offsetDate: { value: ""},
+            offsetId: { value: "" },
+            ignorePinned: { value: false },
+            ignoreMigrated: { value: false },
+            folder: { value: 0 },
+            archived: { value: "" },
+        },
+        inputs: 1,
+        outputs: 1,
+        paletteLabel: 'Iterate Dialogs',
+        label: function () {
+            return this.name || 'Iterate Dialogs';
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="iter-dialogs">
+    <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%"
+            ng-model="name"
+        />
+    </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%"
+            ng-model="config"
+        />
+    </div>
+    <div class="form-row">
+        <label for="node-input-limit">
+            <i class="fa fa-tag"></i> Limit
+        </label>
+        <input
+            type="text"
+            id="node-input-limit"
+            placeholder="Limit"
+            style="width: 60%"
+            ng-model="limit"
+        />
+    </div>
+    <div class="form-row">
+        <label for="node-input-offsetDate">
+            <i class="fa fa-tag"></i> Offset Date
+        </label>
+        <input
+            type="datetime-local"
+            id="node-input-offsetDate"
+            placeholder="Offset Date"
+            style="width: 60%"
+            ng-model="offsetDate"
+        />
+    </div>
+    <div class="form-row">
+        <label for="node-input-offsetId">
+            <i class="fa fa-tag"></i> Offset ID
+        </label>
+        <input
+            type="text"
+            id="node-input-offsetId"
+            placeholder="Offset ID"
+            style="width: 60%"
+            ng-model="offsetId"
+        />
+    </div>
+    <div class="form-row">
+        <label for="node-input-ignorePinned">
+            <i class="fa fa-tag"></i> Ignore Pinned
+        </label>
+        <input
+            type="checkbox"
+            id="node-input-ignorePinned"
+            ng-model="ignorePinned"
+        />
+    </div>
+    <div class="form-row">
+        <label for="node-input-ignoreMigrated">
+            <i class="fa fa-tag"></i> Ignore Migrated
+        </label>
+        <input
+            type="checkbox"
+            id="node-input-ignoreMigrated"
+            ng-model="ignoreMigrated"
+        />
+    </div>
+    <div class="form-row">
+        <label for="node-input-folder">
+            <i class="fa fa-tag"></i> Folder
+        </label>
+        <input
+            type="text"
+            id="node-input-folder"
+            placeholder="Folder"
+            style="width: 60%"
+            ng-model="folder"
+        />
+    </div>
+    <div class="form-row">
+        <label for="node-input-archived">
+            <i class="fa fa-tag"></i> Archived
+        </label>
+        <input
+            type="checkbox"
+            id="node-input-archived"
+            ng-model="archived"
+        />
+    </div>
+</script>
+
+<script type="text/html" data-help-name="iter-dialogs">
+    <p>The <b>iter-dialogs</b> node retrieves a list of Telegram dialogs (chats, channels, or groups) by iterating through them using the Telegram API.</p>
+
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>payload.client
+            <span class="property-type">object</span>
+        </dt>
+        <dd>An optional Telegram client instance if not configured globally.</dd>
+
+        <dt>payload.limit
+            <span class="property-type">number</span>
+        </dt>
+        <dd>Limits the number of dialogs to retrieve. Default is no limit.</dd>
+
+        <dt>payload.offsetDate
+            <span class="property-type">string | number</span>
+        </dt>
+        <dd>Fetch dialogs starting from this date. Provide a UNIX timestamp or a date string.</dd>
+
+        <dt>payload.offsetId
+            <span class="property-type">number</span>
+        </dt>
+        <dd>Fetch dialogs starting from this message ID.</dd>
+
+        <dt>payload.offsetPeer
+            <span class="property-type">object</span>
+        </dt>
+        <dd>The peer object to start retrieving dialogs from.</dd>
+
+        <dt>payload.ignorePinned
+            <span class="property-type">boolean</span>
+        </dt>
+        <dd>Ignores pinned dialogs if set to <code>true</code>. Default is <code>false</code>.</dd>
+
+        <dt>payload.ignoreMigrated
+            <span class="property-type">boolean</span>
+        </dt>
+        <dd>Ignores migrated chats if set to <code>true</code>. Default is <code>false</code>.</dd>
+
+        <dt>payload.folder
+            <span class="property-type">number</span>
+        </dt>
+        <dd>Retrieves dialogs from a specific folder by folder ID.</dd>
+
+        <dt>payload.archived
+            <span class="property-type">boolean</span>
+        </dt>
+        <dd>Includes archived dialogs if set to <code>true</code>. Default is <code>false</code>.</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <dl class="message-properties">
+        <dt>payload.dialogs
+            <span class="property-type">object</span>
+        </dt>
+        <dd>An object containing dialogs, where keys are dialog IDs and values are dialog details.</dd>
+    </dl>
+
+    <h3>Details</h3>
+    <p>The <b>iter-dialogs</b> node uses the Telegram API to iterate over all available dialogs. It allows filtering by various parameters, such as the number of dialogs to retrieve (<code>limit</code>), starting date or message (<code>offsetDate</code>, <code>offsetId</code>), and additional flags like <code>ignorePinned</code> or <code>archived</code>.</p>
+    
+    <p>It supports advanced configurations such as folder-specific retrieval and skipping migrated chats, providing granular control over the dialogs to be processed.</p>
+
+    <h3>Example</h3>
+    <pre>
+    {
+        "payload": {
+            "limit": 10,
+            "offsetDate": "2023-12-01T00:00:00Z",
+            "archived": true
+        }
+    }
+    </pre>
+    <p>This input retrieves up to 10 archived dialogs starting from December 1, 2023.</p>
+
+    <h3>Error Handling</h3>
+    <p>If an error occurs during dialog retrieval (e.g., invalid parameters or API limitations), the node logs an error message and does not return a payload.</p>
+
+    <h3>Configuration</h3>
+    <p>The node can use a globally configured Telegram client or a client instance provided in the message payload. Ensure the client has sufficient permissions to access the dialogs.</p>
+</script>
+

package/nodes/iter-dialogs.js

@@ -0,0 +1,54 @@
+const { TelegramClient } = require("telegram");
+
+module.exports = function (RED) {
+    function IterDialogs(config) {
+        RED.nodes.createNode(this, config);
+        this.config = RED.nodes.getNode(config.config);
+        var node = this;
+
+        this.on('input', async function (msg) {
+    
+            /** @type {TelegramClient} */
+            const client = msg.payload?.client ? msg.payload.client : this.config.client;
+            const limit = msg.payload.limit || config.limit;
+            const offsetDate = msg.payload.offsetDate || config.offsetDate;
+            const offsetId = msg.payload.offsetId || config.offsetId;
+            const offsetPeer = msg.payload?.offsetPeer || undefined; 
+            const ignorePinned = msg.payload.ignorePinned || config.ignorePinned;
+            const ignoreMigrated = msg.payload.ignoreMigrated || config.ignoreMigrated;
+            const folder = msg.payload.folder || config.folder;
+            const archived = msg.payload.archived || config.archived;
+            
+            const params = {
+             limit: limit !== ""? parseInt(limit) : undefined,
+             offsetDate: offsetDate !== "" ? offsetDate:undefined,
+             offsetId: offsetId !== "" ? parseInt(offsetId):undefined,
+             offsetPeer: offsetPeer,
+             ignorePinned: ignorePinned,
+             ignoreMigrated: ignoreMigrated,
+             folder: folder !== "" ? parseInt(folder):undefined,
+             archived: archived,
+            }
+
+            if (offsetDate) {
+                params.offsetDate = new Date(offsetDate).getTime() / 1000;
+            }
+
+            try {
+                const dialogs = {};
+                for await (const dialog of client.iterDialogs(params)){
+                    dialogs[dialog.id] = dialog;
+                    console.log(`${dialog.id}: ${dialog.title}`);
+                }
+                node.send({
+                    payload: { dialogs },
+                });
+            } catch (err) {
+                node.error('Error iter dialogs: ' + err.message);
+            }
+
+        });
+    }
+
+    RED.nodes.registerType('iter-dialogs', IterDialogs);
+};