@mtkruto/node 0.1.112 → 0.1.114

package/script/client/{4_client.d.ts → 5_client.d.ts}

@@ -2,19 +2,66 @@ import { MaybePromise } from "../1_utilities.js";
 import { functions, ReadObject, types } from "../2_tl.js";
 import { Storage } from "../3_storage.js";
 import { DC } from "../3_transport.js";
-import { BotCommand, ChatAction, ChatID, InlineQueryResult, Message, ParseMode, User } from "../3_types.js";
+import { BotCommand, CallbackQuery, ChatAction, ChatID, InlineQuery, InlineQueryResult, Message, ParseMode, User } from "../3_types.js";
 import { Migrate } from "../4_errors.js";
-import { With } from "./0_utilities.js";
+import { FileSource, With } from "./0_utilities.js";
 import { ClientAbstract } from "./1_client_abstract.js";
-import { AnswerCallbackQueryParams, AnswerInlineQueryParams, AuthorizeUserParams, ClientParams, DownloadParams, EditMessageParams, FilterableUpdates, FilterUpdate, ForwardMessagesParams, GetMyCommandsParams, Handler, SendMessagesParams, SendPollParams, SetMyCommandsParams, Update, UploadParams } from "./3_types.js";
+import { AnswerCallbackQueryParams, AnswerInlineQueryParams, AuthorizeUserParams, ClientParams, DeleteMessageParams, DeleteMessagesParams, DownloadParams, EditMessageParams, FilterableUpdates, FilterUpdate, ForwardMessagesParams, GetMyCommandsParams, InvokeErrorHandler, ReplyParams, SendMessageParams, SendPhotoParams, SendPollParams, SetMyCommandsParams, Update, UploadParams } from "./3_types.js";
+import { Composer, Middleware } from "./4_composer.js";
 declare const getEntity: unique symbol;
 declare const getStickerSetName: unique symbol;
 export declare const handleMigrationError: unique symbol;
 declare const getMessageWithReply: unique symbol;
+export interface Context extends Update {
+    /** The client that received the update. */
+    client: Client;
+    /** Resolves to `ctx.message ?? ctx.editedMessage ?? ctx.callbackQuery?.message`. */
+    msg: undefined extends this["message"] ? undefined extends this["editedMessage"] ? undefined extends this["callbackQuery"] ? never : this["callbackQuery"] extends With<CallbackQuery, "message"> ? this["callbackQuery"]["message"] : this["callbackQuery"] extends With<CallbackQuery, "inlineMessageId"> ? never : (Message | undefined) : this["editedMessage"] : this["message"];
+    /** Resolves to `effectiveMessage?.chat`. */
+    chat: this["msg"] extends never ? never : this["msg"]["chat"];
+    /** Resolves to `(ctx.message ?? ctx.editedMessage)?.from ?? ctx.callbackQuery?.from ?? ctx.inlineQuery?.from`. */
+    from: this["message"] extends Message ? this["message"]["from"] : this["editedMessage"] extends Message ? this["editedMessage"]["from"] : this["callbackQuery"] extends CallbackQuery ? this["callbackQuery"]["from"] : this["inlineQuery"] extends InlineQuery ? this["inlineQuery"]["from"] : never;
+    /** Resolves to `effectiveMessage?.senderChat`. */
+    senderChat: this["msg"] extends never ? never : this["msg"]["senderChat"];
+    /** Reply the received message with a text message. */
+    reply: (text: string, params?: Omit<SendMessageParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "text">>;
+    /** Reply the received message with a poll. */
+    replyPoll: (question: string, options: [string, string, ...string[]], params?: Omit<SendPollParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "poll">>;
+    /** Reply the received message with a photo. */
+    replyPhoto: (photo: FileSource, params?: Omit<SendPhotoParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "photo">>;
+    /** Delete the received message. */
+    delete: () => Promise<void>;
+    /** Forward the received message. */
+    forward: (to: ChatID, params?: ForwardMessagesParams) => Promise<this["msg"]>;
+    /** Send a chat action to the chat which the message was received from. */
+    sendChatAction: (action: ChatAction, params?: {
+        messageThreadId?: number;
+    }) => Promise<void>;
+    /** Edit a message in the chat which the message was received from. */
+    editMessageText: (messageId: number, text: string, params?: EditMessageParams) => Promise<With<Message, "text">>;
+    /** Answer the received callback query. */
+    answerCallbackQuery: (params?: AnswerCallbackQueryParams) => Promise<void>;
+    /** Answer the received inline query. */
+    answerInlineQuery: (results: InlineQueryResult[], params?: AnswerInlineQueryParams) => Promise<void>;
+    /** Retrieve a single message of the chat which the message was received from. */
+    getMessage: (messageId: number) => Promise<Omit<Message, "replyToMessage"> | null>;
+    /** Retrieve multiple messages of the chat which the message was received from. */
+    getMessages: (messageIds: number[]) => Promise<Omit<Message, "replyToMessage">[]>;
+    /** Forward a message of the chat which the message was received from. */
+    forwardMessage: (to: ChatID, messageId: number, params?: ForwardMessagesParams) => Promise<Message>;
+    /** Forward multiple messages of the chat which the message was received from. */
+    forwardMessages: (to: ChatID, messageIds: number[], params?: ForwardMessagesParams) => Promise<Message[]>;
+    /** Delete a message in the chat which the message was received from. */
+    deleteMessage: (messageId: number, params?: DeleteMessagesParams) => Promise<void>;
+    /** Delete multiple messages in the chat which the message was received from. */
+    deleteMessages: (messageIds: number[], params?: DeleteMessagesParams) => Promise<void>;
+    toJSON: () => Update;
+}
+export declare function skipInvoke<C extends Context>(): InvokeErrorHandler<Client<C>>;
 export declare const restartAuth: unique symbol;
 export declare class ConnectionError extends Error {
 }
-export declare class Client extends ClientAbstract {
+export declare class Client<C extends Context = Context> extends ClientAbstract {
     #private;
     readonly apiId: number | null;
     readonly apiHash: string | null;
@@ -78,8 +125,12 @@ export declare class Client extends ClientAbstract {
      *
      * @param function_ The function to invoke.
      */
-    invoke<T extends (functions.Function<unknown> | types.Type) = functions.Function<unknown>>(function_: T): Promise<T extends functions.Function<unknown> ? T["__R"] : void>;
-    invoke<T extends (functions.Function<unknown> | types.Type) = functions.Function<unknown>>(function_: T, noWait: true): Promise<void>;
+    invoke: {
+        <T extends types.Type | functions.Function<unknown> = functions.Function<unknown>>(function_: T): Promise<T extends functions.Function<unknown> ? T["__R"] : void>;
+        <T_1 extends types.Type | functions.Function<unknown> = functions.Function<unknown>>(function_: T_1, noWait: true): Promise<void>;
+    } & {
+        use: (handler: InvokeErrorHandler<Client<C>>) => void;
+    };
     /**
      * Alias for `invoke` with its second parameter being `true`.
      */
@@ -99,7 +150,7 @@ export declare class Client extends ClientAbstract {
      * @param text The message's text.
      * @returns The sent text message.
      */
-    sendMessage(chatId: ChatID, text: string, params?: SendMessagesParams): Promise<With<Message, "text">>;
+    sendMessage(chatId: ChatID, text: string, params?: SendMessageParams): Promise<With<Message, "text">>;
     /**
      * Edit a message's text.
      *
@@ -229,11 +280,11 @@ export declare class Client extends ClientAbstract {
      * @param results The results to answer with.
      */
     answerInlineQuery(id: string, results: InlineQueryResult[], params?: AnswerInlineQueryParams): Promise<void>;
-    use(handler: Handler): void;
-    branch(predicate: (upd: Update) => MaybePromise<boolean>, trueHandler: Handler, falseHandler: Handler): void;
-    filter<D extends Update>(predicate: (update: Update) => update is D, handler: Handler<D>): void;
-    filter(predicate: (update: Update) => MaybePromise<boolean>, handler: Handler): void;
-    on<T extends keyof Update, F extends keyof NonNullable<Update[T]>>(filter: T extends FilterableUpdates ? T | [T, F, ...F[]] : T, handler: Handler<FilterUpdate<Update, T, F>>): void;
+    use(...middleware: Middleware<C>[]): Composer<C>;
+    branch(predicate: (ctx: C) => MaybePromise<boolean>, trueHandler_: Middleware<C>, falseHandler_: Middleware<C>): Composer<C>;
+    filter<D extends C>(predicate: (ctx: C) => ctx is D, ...middleware: Middleware<D>[]): void;
+    filter(predicate: (ctx: C) => MaybePromise<boolean>, ...middleware: Middleware<C>[]): void;
+    on<T extends keyof Update, F extends keyof NonNullable<Update[T]>>(filter: T extends FilterableUpdates ? T | [T, F, ...F[]] : T, ...middleawre: Middleware<FilterUpdate<C, T, F>>[]): void;
     /**
      * Set the bot's description in the given language. Bot-only.
      *
@@ -285,5 +336,29 @@ export declare class Client extends ClientAbstract {
     getMyShortDescription(params?: {
         languageCode?: string;
     }): Promise<string>;
+    /**
+     * Delete multiple messages.
+     *
+     * @method
+     * @param chatId The chat that contains the messages.
+     * @param messageIds The identifier of the messages to delete.
+     */
+    deleteMessages(chatId: ChatID, messageIds: number[], params?: DeleteMessagesParams): Promise<void>;
+    /**
+     * Delete a single message.
+     *
+     * @method
+     * @param chatId The chat that contains the message.
+     * @param messageId The identifier of the message to delete.
+     */
+    deleteMessage(chatId: ChatID, messageId: number, params?: DeleteMessageParams): Promise<void>;
+    /**
+     * Send a photo.
+     *
+     * @method
+     * @param chatId The chat to send the photo to.
+     * @param photo The photo to send.
+     */
+    sendPhoto(chatId: ChatID, photo: FileSource, params?: SendPhotoParams): Promise<With<Message, "photo">>;
 }
 export {};