@mtkruto/node 0.79.0 → 0.79.3

package/esm/client/2_context.js

@@ -19,6 +19,11 @@
  */
 import { unreachable } from "../0_deps.js";
 import { toJSON } from "../2_tl.js";
+/**
+ * The context object that is passed to the client's update handlers.
+ *
+ * It wraps the {@link Update} type with shortcuts and method aliases.
+ */
 export class Context {
     #client;
     #me;
@@ -102,6 +107,11 @@ export class Context {
         const from = "callbackQuery" in this.update ? this.update.callbackQuery.from : "inlineQuery" in this.update ? this.update.inlineQuery.from : "chatMember" in this.update ? this.update.chatMember.from : "myChatMember" in this.update ? this.update.myChatMember.from : "messageReactions" in this.update ? this.update.messageReactions.user : "preCheckoutQuery" in this.update ? this.update.preCheckoutQuery.from : "joinRequest" in this.update ? this.update.joinRequest.from : "businessConnection" in this.update ? this.update.businessConnection.user : "pollAnswer" in this.update ? this.update.pollAnswer.from : this.msg?.from;
         return from;
     }
+    /**
+     * Returns a representation of the update held in the context that can be converted to JSON.
+     *
+     * @returns A representation of the update in a way that can be converted to JSON.
+     */
     toJSON() {
         if ("update" in this.update) {
             return { update: toJSON(this.update.update) };
@@ -110,102 +120,165 @@ export class Context {
             return this.update;
         }
     }
+    /**
+     * Context-aware alias for {@link Client.sendMessage}.
+     */
     async reply(text, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendMessage(chatId, text, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendPoll}.
+     */
     async replyPoll(question, options, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendPoll(chatId, question, options, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendPhoto}.
+     */
     async replyPhoto(photo, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendPhoto(chatId, photo, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendMediaGroup}.
+     */
     async replyMediaGroup(media, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendMediaGroup(chatId, media, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendInvoice}.
+     */
     async replyInvoice(title, description, payload, currency, prices, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendInvoice(chatId, title, description, payload, currency, prices, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendDocument}.
+     */
     async replyDocument(document, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendDocument(chatId, document, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendSticker}.
+     */
     async replySticker(sticker, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendSticker(chatId, sticker, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendLocation}.
+     */
     async replyLocation(latitude, longitude, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendLocation(chatId, latitude, longitude, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendDice}.
+     */
     async replyDice(params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendDice(chatId, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendVenue}.
+     */
     async replyVenue(latitude, longitude, title, address, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendVenue(chatId, latitude, longitude, title, address, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendContact}.
+     */
     async replyContact(firstName, number, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendContact(chatId, firstName, number, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendVideo}.
+     */
     async replyVideo(video, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendVideo(chatId, video, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendAnimation}.
+     */
     async replyAnimation(animation, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendAnimation(chatId, animation, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendVoice}.
+     */
     async replyVoice(voice, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendVoice(chatId, voice, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendAudio}.
+     */
     async replyAudio(audio, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendAudio(chatId, audio, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.sendVideoNote}.
+     */
     async replyVideoNote(videoNote, params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         const replyTo = this.#getReplyTo(params?.quote, chatId, messageId);
         return await this.client.sendVideoNote(chatId, videoNote, { ...params, replyTo, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.deleteMessage}.
+     */
     async delete() {
         const { chatId, messageId } = this.#mustGetMsg();
         return await this.client.deleteMessage(chatId, messageId);
     }
+    /**
+     * Context-aware alias for {@link Client.forwardMessage}.
+     */
     async forward(to, params) {
         const { chatId, messageId } = this.#mustGetMsg();
         return await this.client.forwardMessage(chatId, to, messageId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.pinMessage}.
+     */
     async pin(params) {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         return await this.client.pinMessage(chatId, messageId, { ...params, businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.unpinMessage}.
+     */
     async unpin() {
         const { chatId, messageId, businessConnectionId } = this.#mustGetMsg();
         return await this.client.unpinMessage(chatId, messageId, { businessConnectionId });
     }
+    /**
+     * Context-aware alias for {@link Client.banChatMember}.
+     */
     async banSender(params) {
         const { chatId, senderId } = this.#mustGetMsg();
         if (!senderId) {
@@ -213,6 +286,9 @@ export class Context {
         }
         return await this.client.banChatMember(chatId, senderId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.kickChatMember}.
+     */
     async kickSender() {
         const { chatId, senderId } = this.#mustGetMsg();
         if (!senderId) {
@@ -220,6 +296,9 @@ export class Context {
         }
         return await this.client.kickChatMember(chatId, senderId);
     }
+    /**
+     * Context-aware alias for {@link Client.setChatMemberRights}.
+     */
     async setSenderRights(params) {
         const { chatId, senderId } = this.#mustGetMsg();
         if (!senderId) {
@@ -227,202 +306,349 @@ export class Context {
         }
         return await this.client.setChatMemberRights(chatId, senderId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.getChatAdministrators}.
+     */
     async getChatAdministrators() {
         const chatId = this.#mustGetChatId();
         return await this.client.getChatAdministrators(chatId);
     }
+    /**
+     * Context-aware alias for {@link Client.setReactions}.
+     */
     async react(reactions, params) {
         const { chatId, messageId } = this.#mustGetMsg();
         return await this.client.setReactions(chatId, messageId, reactions, params);
     }
+    /**
+     * Context-aware alias for {@link Client.sendChatAction}.
+     */
     async sendChatAction(action, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.sendChatAction(chatId, action, params);
     }
+    /**
+     * Context-aware alias for {@link Client.editInlineMessageText}.
+     */
     async editInlineMessageText(text, params) {
         const inlineMessageId = this.#mustGetInlineMsgId();
         return await this.client.editInlineMessageText(inlineMessageId, text, params);
     }
+    /**
+     * Context-aware alias for {@link Client.editInlineMessageCaption}.
+     */
     async editInlineMessageCaption(params) {
         const inlineMessageId = this.#mustGetInlineMsgId();
         return await this.client.editInlineMessageCaption(inlineMessageId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.editInlineMessageMedia}.
+     */
     async editInlineMessageMedia(media, params) {
         const inlineMessageId = this.#mustGetInlineMsgId();
         return await this.client.editInlineMessageMedia(inlineMessageId, media, params);
     }
+    /**
+     * Context-aware alias for {@link Client.editInlineMessageLiveLocation}.
+     */
     async editInlineMessageLiveLocation(latitude, longitude, params) {
         const inlineMessageId = this.#mustGetInlineMsgId();
         return await this.client.editInlineMessageLiveLocation(inlineMessageId, latitude, longitude, params);
     }
+    /**
+     * Context-aware alias for {@link Client.editInlineMessageReplyMarkup}.
+     */
     async editInlineMessageReplyMarkup(params) {
         const inlineMessageId = this.#mustGetInlineMsgId();
         return await this.client.editInlineMessageReplyMarkup(inlineMessageId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.editMessageText}.
+     */
     async editMessageText(messageId, text, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.editMessageText(chatId, messageId, text, params);
     }
+    /**
+     * Context-aware alias for {@link Client.editMessageCaption}.
+     */
     async editMessageCaption(messageId, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.editMessageCaption(chatId, messageId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.editMessageMedia}.
+     */
     async editMessageMedia(messageId, media, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.editMessageMedia(chatId, messageId, media, params);
     }
+    /**
+     * Context-aware alias for {@link Client.editMessageLiveLocation}.
+     */
     async editMessageLiveLocation(messageId, latitude, longitude, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.editMessageLiveLocation(chatId, messageId, latitude, longitude, params);
     }
+    /**
+     * Context-aware alias for {@link Client.editMessageReplyMarkup}.
+     */
     async editMessageReplyMarkup(messageId, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.editMessageReplyMarkup(chatId, messageId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.answerCallbackQuery}.
+     */
     async answerCallbackQuery(params) {
         if (!("callbackQuery" in this.update)) {
             unreachable();
         }
         return await this.client.answerCallbackQuery(this.update.callbackQuery.id, params);
     }
+    /**
+     * Context-aware alias for {@link Client.answerInlineQuery}.
+     */
     async answerInlineQuery(results, params) {
         if (!("inlineQuery" in this.update)) {
             unreachable();
         }
         return await this.client.answerInlineQuery(this.update.inlineQuery.id, results, params);
     }
+    /**
+     * Context-aware alias for {@link Client.getMessage}.
+     */
     async getMessage(messageId) {
         const chatId = this.#mustGetChatId();
         return await this.client.getMessage(chatId, messageId);
     }
+    /**
+     * Context-aware alias for {@link Client.getMessages}.
+     */
     async getMessages(messageIds) {
         const chatId = this.#mustGetChatId();
         return await this.client.getMessages(chatId, messageIds);
     }
+    /**
+     * Context-aware alias for {@link Client.forwardMessage}.
+     */
     async forwardMessage(to, messageId, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.forwardMessage(chatId, to, messageId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.forwardMessages}.
+     */
     async forwardMessages(to, messageIds, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.forwardMessages(chatId, to, messageIds, params);
     }
+    /**
+     * Context-aware alias for {@link Client.deleteMessage}.
+     */
     async deleteMessage(messageId, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.deleteMessage(chatId, messageId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.deleteMessages}.
+     */
     async deleteMessages(messageIds, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.deleteMessages(chatId, messageIds, params);
     }
+    /**
+     * Context-aware alias for {@link Client.pinMessage}.
+     */
     async pinMessage(messageId, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.pinMessage(chatId, messageId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.unpinMessage}.
+     */
     async unpinMessage(messageId) {
         const chatId = this.#mustGetChatId();
         return await this.client.unpinMessage(chatId, messageId);
     }
+    /**
+     * Context-aware alias for {@link Client.unpinMessages}.
+     */
     async unpinMessages() {
         const chatId = this.#mustGetChatId();
         return await this.client.unpinMessages(chatId);
     }
+    /**
+     * Context-aware alias for {@link Client.setAvailableReactions}.
+     */
     async setAvailableReactions(availableReactions) {
         const chatId = this.#mustGetChatId();
         return await this.client.setAvailableReactions(chatId, availableReactions);
     }
+    /**
+     * Context-aware alias for {@link Client.addReaction}.
+     */
     async addReaction(messageId, reaction, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.addReaction(chatId, messageId, reaction, params);
     }
+    /**
+     * Context-aware alias for {@link Client.removeReaction}.
+     */
     async removeReaction(messageId, reaction) {
         const chatId = this.#mustGetChatId();
         return await this.client.removeReaction(chatId, messageId, reaction);
     }
+    /**
+     * Context-aware alias for {@link Client.setReactions}.
+     */
     async setReactions(messageId, reactions, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.setReactions(chatId, messageId, reactions, params);
     }
+    /**
+     * Context-aware alias for {@link Client.readMessages}.
+     */
     async read() {
         const { chatId, messageId } = this.#mustGetMsg();
         return await this.client.readMessages(chatId, messageId);
     }
+    /**
+     * Context-aware alias for {@link Client.setChatPhoto}.
+     */
     async setChatPhoto(photo, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.setChatPhoto(chatId, photo, params);
     }
+    /**
+     * Context-aware alias for {@link Client.deleteChatPhoto}.
+     */
     async deletChatPhoto() {
         const chatId = this.#mustGetChatId();
         return await this.client.deleteChatPhoto(chatId);
     }
+    /**
+     * Context-aware alias for {@link Client.banChatMember}.
+     */
     async banChatMember(memberId, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.banChatMember(chatId, memberId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.unbanChatMember}.
+     */
     async unbanChatMember(memberId) {
         const chatId = this.#mustGetChatId();
         return await this.client.unbanChatMember(chatId, memberId);
     }
+    /**
+     * Context-aware alias for {@link Client.kickChatMember}.
+     */
     async kickChatMember(memberId) {
         const chatId = this.#mustGetChatId();
         return await this.client.kickChatMember(chatId, memberId);
     }
+    /**
+     * Context-aware alias for {@link Client.setChatMemberRights}.
+     */
     async setChatMemberRights(memberId, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.setChatMemberRights(chatId, memberId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.promoteChatMember}.
+     */
     async promoteChatMember(userId, params) {
         const chatId = this.#mustGetChatId();
         return await this.client.promoteChatMember(chatId, userId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.deleteChatMemberMessages}.
+     */
     async deleteChatMemberMessages(userId) {
         const chatId = this.#mustGetChatId();
         return await this.client.deleteChatMemberMessages(chatId, userId);
     }
+    /**
+     * Context-aware alias for {@link Client.searchMessages}.
+     */
     async searchMessages(params) {
         const chatId = this.#mustGetChatId();
         params ??= {};
         params.chatId = chatId;
         return await this.client.searchMessages(params);
     }
+    /**
+     * Context-aware alias for {@link Client.setBoostsRequiredToCircumventRestrictions}.
+     */
     async setBoostsRequiredToCircumventRestrictions(boosts) {
         const chatId = this.#mustGetChatId();
         return await this.client.setBoostsRequiredToCircumventRestrictions(chatId, boosts);
     }
+    /**
+     * Context-aware alias for {@link Client.createInviteLink}.
+     */
     async createInviteLink(params) {
         const chatId = this.#mustGetChatId();
         return await this.client.createInviteLink(chatId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.getCreatedInviteLinks}.
+     */
     async getCreatedInviteLinks(params) {
         const chatId = this.#mustGetChatId();
         return await this.client.getCreatedInviteLinks(chatId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.leaveChat}.
+     */
     async leaveChat() {
         const chatId = this.#mustGetChatId();
         return await this.client.leaveChat(chatId);
     }
+    /**
+     * Context-aware alias for {@link Client.blockUser}.
+     */
     async blockUser() {
         return await this.client.blockUser(this.#mustGetUserId());
     }
+    /**
+     * Context-aware alias for {@link Client.unblockUser}.
+     */
     async unblockUser() {
         return await this.client.unblockUser(this.#mustGetUserId());
     }
+    /**
+     * Context-aware alias for {@link Client.getChatMember}.
+     */
     async getChatMember(userId) {
         const chatId = this.#mustGetChatId();
         return await this.client.getChatMember(chatId, userId);
     }
+    /**
+     * Context-aware alias for {@link Client.getChatMembers}.
+     */
     async getChatMembers(params) {
         const chatId = this.#mustGetChatId();
         return await this.client.getChatMembers(chatId, params);
     }
+    /**
+     * Context-aware alias for {@link Client.setChatStickerSet}.
+     */
     async setChatStickerSet(setName) {
         const chatId = this.#mustGetChatId();
         return await this.client.setChatStickerSet(chatId, setName);
     }
+    /**
+     * Context-aware alias for {@link Client.deleteChatStickerSet}.
+     */
     async deleteChatStickerSet() {
         const chatId = this.#mustGetChatId();
         return await this.client.deleteChatStickerSet(chatId);
     }
+    /**
+     * Context-aware alias for {@link Client.getBusinessConnection}.
+     */
     async getBusinessConnection() {
         const { businessConnectionId } = this.#mustGetMsg();
         if (!businessConnectionId) {
@@ -430,12 +656,18 @@ export class Context {
         }
         return await this.client.getBusinessConnection(businessConnectionId);
     }
+    /**
+     * Context-aware alias for {@link Client.answerPreCheckoutQuery}.
+     */
     async answerPreCheckoutQuery(ok, params) {
         if (!("preCheckoutQuery" in this.update)) {
             unreachable();
         }
         return await this.client.answerPreCheckoutQuery(this.update.preCheckoutQuery.id, ok, params);
     }
+    /**
+     * Context-aware alias for {@link Client.approveJoinRequest}.
+     */
     async approveJoinRequest() {
         const { chatId, userId } = this.#mustGetMsg();
         if (!userId) {
@@ -443,6 +675,9 @@ export class Context {
         }
         return await this.client.approveJoinRequest(chatId, userId);
     }
+    /**
+     * Context-aware alias for {@link Client.declineJoinRequest}.
+     */
     async declineJoinRequest() {
         const { chatId, userId } = this.#mustGetMsg();
         if (!userId) {

package/esm/client/5_client.d.ts

@@ -145,6 +145,7 @@ export declare class Client<C extends Context = Context> extends Composer<C> imp
      *
      * @param password The password to check
      * @returns The result of the check.
+     * @method ac
      */
     checkPassword(password: string): Promise<PasswordCheckResult>;
     /**
@@ -152,6 +153,7 @@ export declare class Client<C extends Context = Context> extends Composer<C> imp
      *
      * @param password The password to check
      * @returns The result of the check.
+     * @method ac
      */
     checkBotToken(botToken: string): Promise<BotTokenCheckResult>;
     /**