@mtkruto/node 0.1.105 → 0.1.107

package/script/client/4_client.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Client = exports.ConnectionError = exports.restartAuth = exports.getMessageWithReply = exports.handleMigrationError = exports.getStickerSetName = exports.getEntity = void 0;
+exports.Client = exports.ConnectionError = exports.restartAuth = exports.handleMigrationError = void 0;
 const _0_deps_js_1 = require("../0_deps.js");
 const _1_utilities_js_1 = require("../1_utilities.js");
 const _2_tl_js_1 = require("../2_tl.js");
@@ -21,10 +21,10 @@ const dGapC = (0, _0_deps_js_1.debug)("Client/recoverChannelUpdateGap");
 const dAuth = (0, _0_deps_js_1.debug)("Client/authorize");
 const dRecv = (0, _0_deps_js_1.debug)("Client/receiveLoop");
 const dUpload = (0, _0_deps_js_1.debug)("Client/upload");
-exports.getEntity = Symbol();
-exports.getStickerSetName = Symbol();
+const getEntity = Symbol();
+const getStickerSetName = Symbol();
 exports.handleMigrationError = Symbol();
-exports.getMessageWithReply = Symbol();
+const getMessageWithReply = Symbol();
 exports.restartAuth = Symbol();
 class ConnectionError extends Error {
 }
@@ -1158,7 +1158,7 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
             throw new Error("ID format unknown or not implemented");
         }
     }
-    [exports.getEntity](peer) {
+    [getEntity](peer) {
         const type = peer instanceof _2_tl_js_1.types.PeerUser ? "user" : peer instanceof _2_tl_js_1.types.PeerChat ? "chat" : peer instanceof _2_tl_js_1.types.PeerChannel ? "channel" : (0, _1_utilities_js_1.UNREACHABLE)();
         const id = peer instanceof _2_tl_js_1.types.PeerUser ? peer.userId : peer instanceof _2_tl_js_1.types.PeerChat ? peer.chatId : peer instanceof _2_tl_js_1.types.PeerChannel ? peer.channelId : (0, _1_utilities_js_1.UNREACHABLE)();
         return this.storage.getEntity(type, id);
@@ -1218,10 +1218,10 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
         if (updates instanceof _2_tl_js_1.types.Updates) {
             for (const update of updates.updates) {
                 if (update instanceof _2_tl_js_1.types.UpdateNewMessage || update instanceof _2_tl_js_1.types.UpdateEditMessage) {
-                    messages.push(await (0, _3_types_js_1.constructMessage)(update.message, this[exports.getEntity].bind(this), this.getMessage.bind(this), this[exports.getStickerSetName].bind(this)));
+                    messages.push(await (0, _3_types_js_1.constructMessage)(update.message, this[getEntity].bind(this), this.getMessage.bind(this), this[getStickerSetName].bind(this)));
                 }
                 else if (update instanceof _2_tl_js_1.types.UpdateNewChannelMessage || update instanceof _2_tl_js_1.types.UpdateEditChannelMessage) {
-                    messages.push(await (0, _3_types_js_1.constructMessage)(update.message, this[exports.getEntity].bind(this), this.getMessage.bind(this), this[exports.getStickerSetName].bind(this)));
+                    messages.push(await (0, _3_types_js_1.constructMessage)(update.message, this[getEntity].bind(this), this.getMessage.bind(this), this[getStickerSetName].bind(this)));
                 }
             }
         }
@@ -1243,8 +1243,10 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Send a text message.
      *
+     * @method
      * @param chatId The chat to send the message to.
      * @param text The message's text.
+     * @returns The sent text message.
      */
     async sendMessage(chatId, text, params) {
         const [message, entities] = this.parseText(text, params);
@@ -1295,9 +1297,11 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Edit a message's text.
      *
+     * @method
      * @param chatId The chat where the message is.
      * @param messageId The ID of the message.
      * @param text The new text of the message.
+     * @returns The edited text message.
      */
     async editMessageText(chatId, messageId, text, params) {
         const [message, entities] = this.parseText(text, params);
@@ -1343,7 +1347,7 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
         }
         const messages = new Array();
         for (const message_ of messages_) {
-            const message = await (0, _3_types_js_1.constructMessage)(message_, this[exports.getEntity].bind(this), null, this[exports.getStickerSetName].bind(this));
+            const message = await (0, _3_types_js_1.constructMessage)(message_, this[getEntity].bind(this), null, this[getStickerSetName].bind(this));
             const isReplyToMessage = message_ instanceof _2_tl_js_1.types.Message && message_.replyTo instanceof _2_tl_js_1.types.MessageReplyHeader;
             messages.push({ message, isReplyToMessage });
         }
@@ -1352,21 +1356,31 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Retrieve multiple messages.
      *
+     * @method
      * @param chatId The identifier of the chat to retrieve the messages from.
      * @param messageIds The identifiers of the messages to retrieve.
+     * @example ```ts
+     * const message = await client.getMessages("@MTKruto", [210, 212]);
+     * ```
+     * @returns The retrieved messages.
      */
-    async getMessages(chatId_, messageIds) {
-        return await this.getMessagesInner(chatId_, messageIds).then((v) => v.map((v) => v.message));
+    async getMessages(chatId, messageIds) {
+        return await this.getMessagesInner(chatId, messageIds).then((v) => v.map((v) => v.message));
     }
-    async [exports.getMessageWithReply](chatId, messageId) {
+    async [getMessageWithReply](chatId, messageId) {
         const messages = await this.getMessagesInner(chatId, [messageId]);
         return messages[0]?.message ?? null;
     }
     /**
      * Retrieve a single message.
      *
+     * @method
      * @param chatId The identifier of the chat to retrieve the message from.
      * @param messageId The identifier of the message to retrieve.
+     * @example ```ts
+     * const message = await client.getMessage("@MTKruto", 212);
+     * ```
+     * @returns The retrieved message.
      */
     async getMessage(chatId, messageId) {
         const messages = await this.getMessages(chatId, [messageId]);
@@ -1416,7 +1430,14 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Download a file.
      *
+     * @method
      * @param fileId The identifier of the file to download.
+     * @example ```ts
+     * for await (const chunk of client.download(fileId, { chunkSize: 256 * 1024 })) {
+     *   await outFile.write(chunk);
+     * }
+     * ```
+     * @returns A generator yielding the contents of the file.
      */
     async download(fileId, params) {
         const fileId_ = _3_types_js_1.FileID.decode(fileId);
@@ -1443,7 +1464,7 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
                 (0, _1_utilities_js_1.UNREACHABLE)();
         }
     }
-    async [exports.getStickerSetName](inputStickerSet, hash = 0) {
+    async [getStickerSetName](inputStickerSet, hash = 0) {
         const maybeStickerSetName = await this.storage.getStickerSetName(inputStickerSet.id, inputStickerSet.accessHash);
         if (maybeStickerSetName != null && Date.now() - maybeStickerSetName[1].getTime() < _4_constants_js_1.STICKER_SET_NAME_TTL) {
             return maybeStickerSetName[0];
@@ -1458,9 +1479,11 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Forward multiple messages.
      *
+     * @method
      * @param from The identifier of the chat to forward the messages from.
      * @param to The identifier of the chat to forward the messages to.
      * @param messageIds The identifiers of the messages to forward.
+     * @returns The forwarded messages.
      */
     async forwardMessages(from, to, messageIds, params) {
         const result = await this.invoke(new _2_tl_js_1.functions.MessagesForwardMessages({
@@ -1480,15 +1503,19 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Forward a single message.
      *
+     * @method
      * @param from The identifier of the chat to forward the message from.
      * @param to The identifier of the chat to forward the message to.
      * @param messageId The identifier of the message to forward.
+     * @returns The forwarded message.
      */
     async forwardMessage(from, to, messageId, params) {
         return await this.forwardMessages(from, to, [messageId], params).then((v) => v[0]);
     }
     /**
      * Get information on the currently authorized user.
+     *
+     * @method
      */
     async getMe() {
         const users = await this.invoke(new _2_tl_js_1.functions.UsersGetUsers({ id: [new _2_tl_js_1.types.InputUserSelf()] }));
@@ -1553,7 +1580,7 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
             update instanceof _2_tl_js_1.types.UpdateEditMessage ||
             update instanceof _2_tl_js_1.types.UpdateEditChannelMessage) {
             const key = update instanceof _2_tl_js_1.types.UpdateNewMessage || update instanceof _2_tl_js_1.types.UpdateNewChannelMessage ? "message" : "editedMessage";
-            const message = await (0, _3_types_js_1.constructMessage)(update.message, this[exports.getEntity].bind(this), this.getMessage.bind(this), this[exports.getStickerSetName].bind(this));
+            const message = await (0, _3_types_js_1.constructMessage)(update.message, this[getEntity].bind(this), this.getMessage.bind(this), this[getStickerSetName].bind(this));
             await this.handle({ [key]: message }, _0_utilities_js_1.resolve);
         }
         if (update instanceof _2_tl_js_1.types.UpdateDeleteMessages) {
@@ -1563,7 +1590,7 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
                 if (chatId) {
                     const message = await this.storage.getMessage(chatId, messageId);
                     if (message != null) {
-                        deletedMessages.push(await (0, _3_types_js_1.constructMessage)(message, this[exports.getEntity].bind(this), this.getMessage.bind(this), this[exports.getStickerSetName].bind(this)));
+                        deletedMessages.push(await (0, _3_types_js_1.constructMessage)(message, this[getEntity].bind(this), this.getMessage.bind(this), this[getStickerSetName].bind(this)));
                     }
                     await this.storage.setMessage(chatId, messageId, null);
                 }
@@ -1578,7 +1605,7 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
             for (const messageId of update.messages) {
                 const message = await this.storage.getMessage(chatId, messageId);
                 if (message) {
-                    deletedMessages.push(await (0, _3_types_js_1.constructMessage)(message, this[exports.getEntity].bind(this), this.getMessage.bind(this), this[exports.getStickerSetName].bind(this)));
+                    deletedMessages.push(await (0, _3_types_js_1.constructMessage)(message, this[getEntity].bind(this), this.getMessage.bind(this), this[getStickerSetName].bind(this)));
                 }
                 await this.storage.setMessage(chatId, messageId, null);
             }
@@ -1587,15 +1614,16 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
             }
         }
         if (update instanceof _2_tl_js_1.types.UpdateBotCallbackQuery || update instanceof _2_tl_js_1.types.UpdateInlineBotCallbackQuery) {
-            await this.handle({ callbackQuery: await (0, _3_types_js_1.constructCallbackQuery)(update, this[exports.getEntity].bind(this), this[exports.getMessageWithReply].bind(this)) }, _0_utilities_js_1.resolve);
+            await this.handle({ callbackQuery: await (0, _3_types_js_1.constructCallbackQuery)(update, this[getEntity].bind(this), this[getMessageWithReply].bind(this)) }, _0_utilities_js_1.resolve);
         }
         else if (update instanceof _2_tl_js_1.types.UpdateBotInlineQuery) {
-            await this.handle({ inlineQuery: await (0, _3_types_js_1.constructInlineQuery)(update, this[exports.getEntity].bind(this)) }, _0_utilities_js_1.resolve);
+            await this.handle({ inlineQuery: await (0, _3_types_js_1.constructInlineQuery)(update, this[getEntity].bind(this)) }, _0_utilities_js_1.resolve);
         }
     }
     /**
      * Answer a callback query. Bot-only.
      *
+     * @method
      * @param id ID of the callback query to answer.
      */
     async answerCallbackQuery(id, params) {
@@ -1622,9 +1650,11 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Send a poll.
      *
+     * @method
      * @param chatId The chat to send the poll to.
      * @param question The poll's question.
      * @param options The poll's options.
+     * @returns The sent poll.
      */
     async sendPoll(chatId, question, options, params) {
         const peer = await this.getInputPeer(chatId);
@@ -1674,54 +1704,56 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Send a chat action.
      *
+     * @method
      * @param chatId The chat to send the chat action to.
      * @param action The chat action.
      * @param messageThreadId The thread to send the chat action to.
      */
-    async sendChatAction(chatId, action_, messageThreadId) {
-        let action;
-        switch (action_) {
+    async sendChatAction(chatId, action, params) {
+        let action_;
+        switch (action) {
             case "type":
-                action = new _2_tl_js_1.types.SendMessageTypingAction();
+                action_ = new _2_tl_js_1.types.SendMessageTypingAction();
                 break;
             case "uploadPhoto":
-                action = new _2_tl_js_1.types.SendMessageUploadPhotoAction({ progress: 0 });
+                action_ = new _2_tl_js_1.types.SendMessageUploadPhotoAction({ progress: 0 });
                 break;
             case "recordVideo":
-                action = new _2_tl_js_1.types.SendMessageRecordVideoAction();
+                action_ = new _2_tl_js_1.types.SendMessageRecordVideoAction();
                 break;
             case "uploadVideo":
-                action = new _2_tl_js_1.types.SendMessageRecordVideoAction();
+                action_ = new _2_tl_js_1.types.SendMessageRecordVideoAction();
                 break;
             case "recordVoice":
-                action = new _2_tl_js_1.types.SendMessageRecordAudioAction();
+                action_ = new _2_tl_js_1.types.SendMessageRecordAudioAction();
                 break;
             case "uploadAudio":
-                action = new _2_tl_js_1.types.SendMessageUploadAudioAction({ progress: 0 });
+                action_ = new _2_tl_js_1.types.SendMessageUploadAudioAction({ progress: 0 });
                 break;
             case "uploadDocument":
-                action = new _2_tl_js_1.types.SendMessageUploadDocumentAction({ progress: 0 });
+                action_ = new _2_tl_js_1.types.SendMessageUploadDocumentAction({ progress: 0 });
                 break;
             case "chooseSticker":
-                action = new _2_tl_js_1.types.SendMessageChooseStickerAction();
+                action_ = new _2_tl_js_1.types.SendMessageChooseStickerAction();
                 break;
             case "findLocation":
-                action = new _2_tl_js_1.types.SendMessageGeoLocationAction();
+                action_ = new _2_tl_js_1.types.SendMessageGeoLocationAction();
                 break;
             case "recordVideoNote":
-                action = new _2_tl_js_1.types.SendMessageRecordRoundAction();
+                action_ = new _2_tl_js_1.types.SendMessageRecordRoundAction();
                 break;
             case "uploadVideoNote":
-                action = new _2_tl_js_1.types.SendMessageUploadRoundAction({ progress: 0 });
+                action_ = new _2_tl_js_1.types.SendMessageUploadRoundAction({ progress: 0 });
                 break;
             default:
-                throw new Error("Invalid chat action: " + action_);
+                throw new Error("Invalid chat action: " + action);
         }
-        await this.invoke(new _2_tl_js_1.functions.MessagesSetTyping({ peer: await this.getInputPeer(chatId), action, topMsgId: messageThreadId }));
+        await this.invoke(new _2_tl_js_1.functions.MessagesSetTyping({ peer: await this.getInputPeer(chatId), action: action_, topMsgId: params?.messageThreadId }));
     }
     /**
      * Upload a file.
      *
+     * @method
      * @param contents The contents of the file.
      */
     async upload(contents, params) {
@@ -1812,6 +1844,7 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Set the bot's commands in the given scope and/or language. Bot-only.
      *
+     * @method
      * @param commands The commands to set.
      */
     async setMyCommands(commands, params) {
@@ -1834,6 +1867,7 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Answer an inline query. Bot-only.
      *
+     * @method
      * @param id The ID of the inline query to answer.
      * @param results The results to answer with.
      */
@@ -1900,6 +1934,8 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     }
     /**
      * Set the bot's description in the given language. Bot-only.
+     *
+     * @method
      */
     async setMyDescription({ description, languageCode }) {
         await this.assertBot("setMyDescription");
@@ -1907,6 +1943,8 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     }
     /**
      * Set the bot's name in the given language. Bot-only.
+     *
+     * @method
      */
     async setMyName({ name, languageCode }) {
         await this.assertBot("setMyName");
@@ -1914,6 +1952,8 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     }
     /**
      * Set the bot's short description in the given language. Bot-only.
+     *
+     * @method
      */
     async setMyShortDescription({ shortDescription: about, languageCode }) {
         await this.assertBot("setMyShortDescription");
@@ -1924,24 +1964,30 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     }
     /**
      * Get the bot's description in the given language. Bot-only.
+     *
+     * @method
      */
-    async getMyDescription(languageCode) {
+    async getMyDescription(params) {
         await this.assertBot("getMyDescription");
-        return await this.getMyInfo(languageCode).then((v) => v.description);
+        return await this.getMyInfo(params?.languageCode).then((v) => v.description);
     }
     /**
      * Set the bot's name in the given language. Bot-only.
+     *
+     * @method
      */
-    async getMyName(languageCode) {
+    async getMyName(params) {
         await this.assertBot("getMyName");
-        return await this.getMyInfo(languageCode).then((v) => v.description);
+        return await this.getMyInfo(params?.languageCode).then((v) => v.description);
     }
     /**
      * Get the bot's short description in the given language. Bot-only.
+     *
+     * @method
      */
-    async getMyShortDescription(languageCode) {
+    async getMyShortDescription(params) {
         await this.assertBot("getMyShortDescription");
-        return await this.getMyInfo(languageCode).then((v) => v.about);
+        return await this.getMyInfo(params?.languageCode).then((v) => v.about);
     }
 }
 exports.Client = Client;