@mtkruto/node 0.1.170 → 0.1.190

package/script/client/4_client.d.ts

@@ -2,25 +2,12 @@ import { MaybePromise } from "../1_utilities.js";
 import { enums, functions, types } from "../2_tl.js";
 import { Storage } from "../3_storage.js";
 import { DC } from "../3_transport.js";
-import { BotCommand, Chat, ChatAction, ChatMember, ChatP, FileSource, ID, InactiveChat, InlineQueryResult, InputStoryContent, InviteLink, Message, MessageAnimation, MessageAudio, MessageContact, MessageDice, MessageDocument, MessageLocation, MessagePhoto, MessagePoll, MessageText, MessageVenue, MessageVideo, MessageVideoNote, MessageVoice, NetworkStatistics, ParseMode, Reaction, Sticker, Story, Update, UpdateIntersection, User } from "../3_types.js";
+import { BotCommand, Chat, ChatAction, ChatMember, ChatP, FileSource, ID, InactiveChat, InlineQueryResult, InputStoryContent, InviteLink, Message, MessageAnimation, MessageAudio, MessageContact, MessageDice, MessageDocument, MessageLocation, MessagePhoto, MessagePoll, MessageSticker, MessageText, MessageVenue, MessageVideo, MessageVideoNote, MessageVoice, NetworkStatistics, ParseMode, Poll, Reaction, Sticker, Story, Update, User } from "../3_types.js";
 import { Migrate } from "../4_errors.js";
-import { ClientAbstract } from "./0_client_abstract.js";
-import { FilterQuery, WithFilter } from "./0_filters.js";
-import { AddReactionParams, AnswerCallbackQueryParams, AnswerInlineQueryParams, AuthorizeUserParams, BanChatMemberParams, CreateInviteLinkParams, CreateStoryParams, DeleteMessageParams, DeleteMessagesParams, DownloadParams, EditMessageParams, EditMessageReplyMarkupParams, ForwardMessagesParams, GetChatsParams, GetCreatedInviteLinksParams, GetHistoryParams, GetMyCommandsParams, PinMessageParams, ReplyParams, SearchMessagesParams, SendAnimationParams, SendAudioParams, SendContactParams, SendDiceParams, SendDocumentParams, SendLocationParams, SendMessageParams, SendPhotoParams, SendPollParams, SendVenueParams, SendVideoNoteParams, SendVideoParams, SendVoiceParams, SetChatMemberRightsParams, SetChatPhotoParams, SetMyCommandsParams, SetReactionsParams, UploadParams } from "./0_params.js";
+import { AddReactionParams, AnswerCallbackQueryParams, AnswerInlineQueryParams, AuthorizeUserParams, BanChatMemberParams, CreateInviteLinkParams, CreateStoryParams, DeleteMessageParams, DeleteMessagesParams, DownloadParams, EditMessageLiveLocationParams, EditMessageParams, EditMessageReplyMarkupParams, ForwardMessagesParams, GetChatsParams, GetCreatedInviteLinksParams, GetHistoryParams, GetMyCommandsParams, PinMessageParams, ReplyParams, SearchMessagesParams, SendAnimationParams, SendAudioParams, SendContactParams, SendDiceParams, SendDocumentParams, SendLocationParams, SendMessageParams, SendPhotoParams, SendPollParams, SendStickerParams, SendVenueParams, SendVideoNoteParams, SendVideoParams, SendVoiceParams, SetChatMemberRightsParams, SetChatPhotoParams, SetMyCommandsParams, SetReactionsParams, StopPollParams, UploadParams } from "./0_params.js";
 import { Api } from "./0_types.js";
-import { Composer, Middleware } from "./1_composer.js";
-import { ClientPlainParams } from "./2_client_plain.js";
-export type NextFn<T = void> = () => Promise<T>;
-export interface InvokeErrorHandler<C> {
-    (ctx: {
-        client: C;
-        error: unknown;
-        function: types.Type | functions.Function<unknown>;
-        n: number;
-    }, next: NextFn<boolean>): MaybePromise<boolean>;
-}
-declare const getEntity: unique symbol;
-export declare const handleMigrationError: unique symbol;
+import { ClientPlainParams } from "./1_client_plain.js";
+import { Composer as Composer_, NextFunction } from "./1_composer.js";
 export interface Context {
     /** The client that received the update. */
     client: Client;
@@ -42,6 +29,8 @@ export interface Context {
     replyPhoto: (photo: FileSource, params?: Omit<SendPhotoParams, "replyToMessageId"> & ReplyParams) => Promise<MessagePhoto>;
     /** Context-aware alias for `client.sendDocument()`. */
     replyDocument: (document: FileSource, params?: Omit<SendDocumentParams, "replyToMessageId"> & ReplyParams) => Promise<MessageDocument>;
+    /** Context-aware alias for `client.sendSticker()`. */
+    replySticker: (sticker: FileSource, params?: Omit<SendStickerParams, "replyToMessageId"> & ReplyParams) => Promise<MessageSticker>;
     /** Context-aware alias for `client.sendLocation()`. */
     replyLocation: (latitude: number, longitude: number, params?: Omit<SendLocationParams, "replyToMessageId"> & ReplyParams) => Promise<MessageLocation>;
     /** Context-aware alias for `client.sendDice()`. */
@@ -84,10 +73,14 @@ export interface Context {
     }) => Promise<void>;
     /** Context-aware alias for `client.editInlineMessageText()`. */
     editInlineMessageText: (text: string, params?: EditMessageParams) => Promise<void>;
+    /** Context-aware alias for `client.editInlineMessageLiveLocation()`. */
+    editInlineMessageLiveLocation: (latitude: number, longitude: number, params?: EditMessageLiveLocationParams) => Promise<void>;
     /** Context-aware alias for `client.editInlineMessageReplyMarkup()`. */
     editInlineMessageReplyMarkup: (params?: EditMessageReplyMarkupParams) => Promise<void>;
     /** Context-aware alias for `client.editMessageText()`. */
     editMessageText: (messageId: number, text: string, params?: EditMessageParams) => Promise<MessageText>;
+    /** Context-aware alias for `client.editMessageLiveLocation()`. */
+    editMessageLiveLocation: (messageId: number, latitude: number, longitude: number, params?: EditMessageLiveLocationParams) => Promise<MessageLocation>;
     /** Context-aware alias for `client.editMessageReplyMarkup()`. */
     editMessageReplyMarkup: (messageId: number, params?: EditMessageReplyMarkupParams) => Promise<Message>;
     /** Context-aware alias for `client.answerCallbackQuery()`. */
@@ -148,10 +141,27 @@ export interface Context {
     block: () => Promise<void>;
     /** Context-aware alias for `client.unblockUser()`. */
     unblock: () => Promise<void>;
+    /** Context-aware alias for `client.getChatMember()`. */
+    getChatMember: (userId: ID) => Promise<ChatMember>;
+    /** Context-aware alias for `client.setChatStickerSet()`. */
+    setChatStickerSet: (setName: string) => Promise<void>;
+    /** Context-aware alias for `client.deleteChatStickerSet()`. */
+    deleteChatStickerSet: () => Promise<void>;
     toJSON: () => Update;
 }
-export declare function skipInvoke<C extends Context>(): InvokeErrorHandler<Client<C>>;
+export declare class Composer<C extends Context = Context> extends Composer_<C> {
+}
+export interface InvokeErrorHandler<C> {
+    (ctx: {
+        client: C;
+        error: unknown;
+        function: types.Type | functions.Function<unknown>;
+        n: number;
+    }, next: NextFunction<boolean>): MaybePromise<boolean>;
+}
 export declare const restartAuth: unique symbol;
+export declare const handleMigrationError: unique symbol;
+declare const getEntity: unique symbol;
 export interface ClientParams extends ClientPlainParams {
     /** A parse mode to use when the `parseMode` parameter is not specified when sending or editing messages. Defauls to `ParseMode.None`. */
     parseMode?: ParseMode;
@@ -167,8 +177,6 @@ export interface ClientParams extends ClientPlainParams {
     systemLangCode?: string;
     /** The system_version parameter to be passed to initConnection when calling `authorize`. The default varies by the current runtime. */
     systemVersion?: string;
-    /** Whether to automatically call `start` with no parameters in the first `invoke` call. Defaults to `true`. */
-    autoStart?: boolean;
     /** Whether to use default handlers. Defaults to `true`. */
     defaultHandlers?: boolean;
     /** Whether to ignore outgoing messages. Defaults to `true` for bots, and `false` for users. */
@@ -182,7 +190,10 @@ export interface ClientParams extends ClientPlainParams {
     /** Whether to store messages. Defaults to `false`. */
     storeMessages?: boolean;
 }
-export declare class Client<C extends Context = Context> extends ClientAbstract {
+/**
+ * An MTKruto client.
+ */
+export declare class Client<C extends Context = Context> extends Composer<C> {
     #private;
     readonly apiId: number | null;
     readonly apiHash: string | null;
@@ -197,13 +208,14 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     /**
      * Constructs the client.
      *
-     * @param storage The storage provider to use. Defaults to memory storage. Passing a string constructs a memory storage with the string being the string session.
+     * @param storage The storage provider to use. Defaults to memory storage. Passing a string constructs a memory storage with the string being the auth string.
      * @param apiId App's API ID from [my.telegram.org](https://my.telegram.org/apps). Defaults to 0 (unset).
      * @param apiHash App's API hash from [my.telegram.org/apps](https://my.telegram.org/apps). Defaults to empty string (unset).
      */
     constructor(storage?: Storage | string | null, apiId?: number | null, apiHash?: string | null, params?: ClientParams);
+    get connected(): boolean;
+    get disconnected(): boolean;
     api: Api;
-    protected stateChangeHandler: (connected: boolean) => void;
     /**
      * Sets the DC and resets the auth key stored in the session provider
      * if the stored DC was not the same as the `dc` parameter.
@@ -217,6 +229,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      * Before establishing the connection, the session is saved.
      */
     connect(): Promise<void>;
+    reconnect(dc: DC): Promise<void>;
     [handleMigrationError](err: Migrate): Promise<void>;
     disconnect(): Promise<void>;
     /**
@@ -259,22 +272,28 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     send<T extends (functions.Function<unknown> | types.Type) = functions.Function<unknown>>(function_: T): Promise<void>;
     exportAuthString(): Promise<string>;
     importAuthString(authString: string): Promise<void>;
+    /**
+     * Get a chat's inputPeer. Useful when calling API functions directly.
+     *
+     * @param id The identifier of the chat.
+     */
     getInputPeer(id: ID): Promise<enums.InputPeer>;
+    /**
+     * Get a channel or a supergroup's inputChannel. Useful when calling API functions directly.
+     *
+     * @param id The identifier of the channel or the supergroup.
+     */
     getInputChannel(id: ID): Promise<types.InputChannel>;
+    /**
+     * Get a user's inputUser. Useful when calling API functions directly.
+     *
+     * @param id The identifier of the user.
+     */
     getInputUser(id: ID): Promise<types.InputUser>;
     private [getEntity];
     private [getEntity];
     private [getEntity];
     private [getEntity];
-    use(...middleware: Middleware<UpdateIntersection<C>>[]): Composer<C>;
-    branch(predicate: (ctx: UpdateIntersection<C>) => MaybePromise<boolean>, trueHandler_: Middleware<UpdateIntersection<C>>, falseHandler_: Middleware<UpdateIntersection<C>>): Composer<C>;
-    filter<D extends C>(predicate: (ctx: UpdateIntersection<C>) => ctx is D, ...middleware: Middleware<D>[]): Composer<D>;
-    filter(predicate: (ctx: UpdateIntersection<C>) => MaybePromise<boolean>, ...middleware: Middleware<UpdateIntersection<C>>[]): Composer<C>;
-    on<Q extends FilterQuery>(filter: Q, ...middleware: Middleware<WithFilter<C, Q>>[]): Composer<UpdateIntersection<WithFilter<C, Q>>>;
-    command(commands: string | RegExp | (string | RegExp)[] | {
-        names: string | RegExp | (string | RegExp)[];
-        prefixes: string | string[];
-    }, ...middleware: Middleware<WithFilter<C, "message:text">>[]): Composer<WithFilter<C, "message:text">>;
     /**
      * Send a text message.
      *
@@ -288,14 +307,14 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      * Edit a message's text.
      *
      * @method ms
-     * @param chatId The identifier of the chat that contains the messages.
+     * @param chatId The identifier of the chat that contains the message.
      * @param messageId The message's identifier.
      * @param text The new text of the message.
      * @returns The edited text message.
      */
     editMessageText(chatId: ID, messageId: number, text: string, params?: EditMessageParams): Promise<MessageText>;
     /**
-     * Edit an inline message's text.
+     * Edit an inline message's text. Bot-only.
      *
      * @method ms
      * @param inlineMessageId The inline message's identifier.
@@ -306,18 +325,39 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      * Edit a message's reply markup.
      *
      * @method ms
-     * @param chatId The identifier of the chat that contains the messages.
+     * @param chatId The identifier of the chat that contains the message.
      * @param messageId The message's identifier.
      * @returns The edited message.
      */
     editMessageReplyMarkup(chatId: ID, messageId: number, params?: EditMessageReplyMarkupParams): Promise<Message>;
     /**
-     * Edit an inline message's reply markup.
+     * Edit an inline message's reply markup. Bot-only.
      *
      * @method ms
      * @param inlineMessageId The inline message's identifier.
      */
     editInlineMessageReplyMarkup(inlineMessageId: string, params?: EditMessageReplyMarkupParams): Promise<void>;
+    /**
+     * Edit a message's live location.
+     *
+     * @method ms
+     * @param chatId The identifier of the chat that contains the messages.
+     * @param messageId The message's identifier.
+     * @param latitude The new latitude.
+     * @param longitude The new longitude.
+     * @returns The edited location message.
+     */
+    editMessageLiveLocation(chatId: ID, messageId: number, latitude: number, longitude: number, params?: EditMessageLiveLocationParams): Promise<MessageLocation>;
+    /**
+     * Edit an inline message's live location. Bot-only.
+     *
+     * @method ms
+     * @param inlineMessageId The inline message's identifier.
+     * @param latitude The new latitude.
+     * @param longitude The new longitude.
+     * @returns The edited location message.
+     */
+    editInlineMessageLiveLocation(inlineMessageId: string, latitude: number, longitude: number, params?: EditMessageLiveLocationParams): Promise<void>;
     /**
      * Retrieve multiple messages.
      *
@@ -398,6 +438,15 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      * @returns The sent poll.
      */
     sendPoll(chatId: ID, question: string, options: [string, string, ...string[]], params?: SendPollParams): Promise<MessagePoll>;
+    /**
+     * Stop a poll.
+     *
+     * @method ms
+     * @param chatId The chat that includes the poll.
+     * @param messageId The idenfifier of the poll's message.
+     * @returns The new state of the poll.
+     */
+    stopPoll(chatId: ID, messageId: number, params?: StopPollParams): Promise<Poll>;
     /**
      * Send a chat action.
      *
@@ -527,6 +576,15 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      * @returns The sent document.
      */
     sendDocument(chatId: ID, document: FileSource, params?: SendDocumentParams): Promise<MessageDocument>;
+    /**
+     * Send a sticker.
+     *
+     * @method ms
+     * @param chatId The chat to send the sticker to.
+     * @param document The sticker to send.
+     * @returns The sent sticker.
+     */
+    sendSticker(chatId: ID, sticker: FileSource, params?: SendStickerParams): Promise<MessageSticker>;
     /**
      * Send a video.
      *
@@ -646,7 +704,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      */
     getCustomEmojiStickers(id: string | string[]): Promise<Sticker[]>;
     /**
-     * Set a chat's available reactions.
+     * Set a chat's available reactions. User-only.
      *
      * @method ch
      * @param chatId The identifier of the chat.
@@ -696,7 +754,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      */
     deleteChatPhoto(chatId: number): Promise<void>;
     /**
-     * Delete all messages sent by a specific member of a chat.
+     * Delete all messages sent by a specific member of a chat. User-only.
      *
      * @method ms
      * @param chatId The identifier of the chat. Must be a supergroup.
@@ -893,7 +951,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      */
     getInactiveChats(): Promise<InactiveChat[]>;
     /**
-     * Search the messages of a chat.
+     * Search the messages of a chat. User-only.
      *
      * @method ms
      * @param chatId The identifier of the chat to search the messages in.
@@ -901,7 +959,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      */
     searchMessages(chatId: ID, query: string, params?: SearchMessagesParams): Promise<Message[]>;
     /**
-     * Set the number of boosts required to circument a chat's default restrictions.
+     * Set the number of boosts required to circument a chat's default restrictions. User-only.
      *
      * @method ch
      * @param chatId The identifier of the chat.