@mtkruto/node 0.1.129 → 0.1.131

package/script/client/3_types.d.ts

@@ -242,7 +242,7 @@ export interface DeleteMessageParams {
     onlyForMe?: boolean;
 }
 export interface SendPhotoParams {
-    /** The file name to assign. */
+    /** The file name to assign if applicable. */
     fileName?: string;
     /** Size of each upload chunk in bytes. */
     chunkSize?: number;
@@ -335,6 +335,367 @@ export interface SendDocumentParams {
      */
     replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
 }
+export interface SendVideoParams {
+    /** The duration of the video in seconds. */
+    duration?: number;
+    width?: number;
+    height?: number;
+    supportsStreaming?: boolean;
+    /** The file name to assign if applicable. */
+    fileName?: string;
+    /** The mime type to assign. */
+    mimeType?: string;
+    /** Size of each upload chunk in bytes. */
+    chunkSize?: number;
+    /** Upload abort signal. */
+    signal?: AbortSignal | null;
+    /** The caption of the document. */
+    caption?: string;
+    /**
+     * The caption's entities.
+     */
+    captionEntities?: MessageEntity[];
+    /**
+     * The parse mode to use for the caption. If not provided, the default parse mode will be used.
+     */
+    parseMode?: ParseMode;
+    /**
+     * Whether to mark the video as a spoiler.
+     */
+    hasSpoiler?: boolean;
+    /**
+     * Whether to send the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * Whether to protect the contents of the message from copying and forwarding.
+     */
+    protectContent?: boolean;
+    /**
+     * The identifier of a message to reply to.
+     */
+    replyToMessageId?: number;
+    /**
+     * The identifier of a thread to send the message to.
+     */
+    messageThreadId?: number;
+    /**
+     * The identifier of the chat to send the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+export interface SendAnimationParams {
+    /** The duration of the animation in seconds. */
+    duration?: number;
+    width?: number;
+    height?: number;
+    /** The file name to assign if applicable. */
+    fileName?: string;
+    /** The mime type to assign. */
+    mimeType?: string;
+    /** Size of each upload chunk in bytes. */
+    chunkSize?: number;
+    /** Upload abort signal. */
+    signal?: AbortSignal | null;
+    /** The caption of the document. */
+    caption?: string;
+    /**
+     * The caption's entities.
+     */
+    captionEntities?: MessageEntity[];
+    /**
+     * The parse mode to use for the caption. If not provided, the default parse mode will be used.
+     */
+    parseMode?: ParseMode;
+    /**
+     * Whether to mark the animation as a spoiler.
+     */
+    hasSpoiler?: boolean;
+    /**
+     * Whether to send the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * Whether to protect the contents of the message from copying and forwarding.
+     */
+    protectContent?: boolean;
+    /**
+     * The identifier of a message to reply to.
+     */
+    replyToMessageId?: number;
+    /**
+     * The identifier of a thread to send the message to.
+     */
+    messageThreadId?: number;
+    /**
+     * The identifier of the chat to send the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+export interface SendVoiceParams {
+    /** The duration of the voice message in seconds. */
+    duration?: number;
+    /** The file name to assign if applicable. */
+    fileName?: string;
+    /** The mime type to assign. */
+    mimeType?: string;
+    /** Size of each upload chunk in bytes. */
+    chunkSize?: number;
+    /** Upload abort signal. */
+    signal?: AbortSignal | null;
+    /** The caption of the document. */
+    caption?: string;
+    /**
+     * The caption's entities.
+     */
+    captionEntities?: MessageEntity[];
+    /**
+     * The parse mode to use for the caption. If not provided, the default parse mode will be used.
+     */
+    parseMode?: ParseMode;
+    /**
+     * Whether to send the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * Whether to protect the contents of the message from copying and forwarding.
+     */
+    protectContent?: boolean;
+    /**
+     * The identifier of a message to reply to.
+     */
+    replyToMessageId?: number;
+    /**
+     * The identifier of a thread to send the message to.
+     */
+    messageThreadId?: number;
+    /**
+     * The identifier of the chat to send the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+export interface SendAudioParams {
+    /** The duration of the audio file in seconds. */
+    duration?: number;
+    performer?: string;
+    title?: string;
+    /** The file name to assign if applicable. */
+    fileName?: string;
+    /** The mime type to assign. */
+    mimeType?: string;
+    /** Size of each upload chunk in bytes. */
+    chunkSize?: number;
+    /** Upload abort signal. */
+    signal?: AbortSignal | null;
+    /** The caption of the document. */
+    caption?: string;
+    /**
+     * The caption's entities.
+     */
+    captionEntities?: MessageEntity[];
+    /**
+     * The parse mode to use for the caption. If not provided, the default parse mode will be used.
+     */
+    parseMode?: ParseMode;
+    /**
+     * Whether to send the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * Whether to protect the contents of the message from copying and forwarding.
+     */
+    protectContent?: boolean;
+    /**
+     * The identifier of a message to reply to.
+     */
+    replyToMessageId?: number;
+    /**
+     * The identifier of a thread to send the message to.
+     */
+    messageThreadId?: number;
+    /**
+     * The identifier of the chat to send the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+export interface SendVideoNoteParams {
+    /** The duration of the video note in seconds. */
+    duration?: number;
+    length?: number;
+    /** The file name to assign if applicable. */
+    fileName?: string;
+    /** The mime type to assign. */
+    mimeType?: string;
+    /** Size of each upload chunk in bytes. */
+    chunkSize?: number;
+    /** Upload abort signal. */
+    signal?: AbortSignal | null;
+    /** The caption of the document. */
+    caption?: string;
+    /**
+     * The caption's entities.
+     */
+    captionEntities?: MessageEntity[];
+    /**
+     * The parse mode to use for the caption. If not provided, the default parse mode will be used.
+     */
+    parseMode?: ParseMode;
+    /**
+     * Whether to send the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * Whether to protect the contents of the message from copying and forwarding.
+     */
+    protectContent?: boolean;
+    /**
+     * The identifier of a message to reply to.
+     */
+    replyToMessageId?: number;
+    /**
+     * The identifier of a thread to send the message to.
+     */
+    messageThreadId?: number;
+    /**
+     * The identifier of the chat to send the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+export interface SendLocationParams {
+    horizontalAccuracy?: number;
+    livePeriod?: number;
+    heading?: number;
+    proximityAlertRadius?: number;
+    /**
+     * Whether to send the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * Whether to protect the contents of the message from copying and forwarding.
+     */
+    protectContent?: boolean;
+    /**
+     * The identifier of a message to reply to.
+     */
+    replyToMessageId?: number;
+    /**
+     * The identifier of a thread to send the message to.
+     */
+    messageThreadId?: number;
+    /**
+     * The identifier of the chat to send the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+export interface SendVenueParams {
+    foursquareId?: string;
+    foursquareType?: string;
+    /**
+     * Whether to send the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * Whether to protect the contents of the message from copying and forwarding.
+     */
+    protectContent?: boolean;
+    /**
+     * The identifier of a message to reply to.
+     */
+    replyToMessageId?: number;
+    /**
+     * The identifier of a thread to send the message to.
+     */
+    messageThreadId?: number;
+    /**
+     * The identifier of the chat to send the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+export interface SendContactParams {
+    /** The contact's last name. */
+    lastName?: string;
+    /** Additional information in the vCard format. */
+    vcard?: string;
+    /**
+     * Whether to send the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * Whether to protect the contents of the message from copying and forwarding.
+     */
+    protectContent?: boolean;
+    /**
+     * The identifier of a message to reply to.
+     */
+    replyToMessageId?: number;
+    /**
+     * The identifier of a thread to send the message to.
+     */
+    messageThreadId?: number;
+    /**
+     * The identifier of the chat to send the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+export interface SendDiceParams {
+    emoji?: "🎲" | "🎯" | "🏀" | "⚽" | "🎳" | "🎰";
+    /**
+     * Whether to send the message in a silent way without making a sound on the recipients' clients.
+     */
+    disableNotification?: boolean;
+    /**
+     * Whether to protect the contents of the message from copying and forwarding.
+     */
+    protectContent?: boolean;
+    /**
+     * The identifier of a message to reply to.
+     */
+    replyToMessageId?: number;
+    /**
+     * The identifier of a thread to send the message to.
+     */
+    messageThreadId?: number;
+    /**
+     * The identifier of the chat to send the message on behalf of. User-only.
+     */
+    sendAs?: ChatID;
+    /**
+     * The reply markup of the message. Bot-only.
+     */
+    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
 export type ConnectionState = "notConnected" | "updating" | "ready";
 export type AuthorizationState = {
     authorized: boolean;
@@ -391,11 +752,10 @@ export interface NetworkStatistics {
     messages: NetworkStatisticsEntry;
     cdn: NetworkStatisticsEntry;
 }
-export type ChatList = "main" | "archived";
 export declare function getChatListId(chatList: string): 0 | 1;
 export interface GetChatsParams {
     /** The chat list to get the chats from. Defaults to main. */
-    from?: ChatList;
+    from?: "main" | "archived";
     /** The last chat to get chats after. */
     after?: Chat;
     /** The maximum number of results to return. Must be in the range of 1-100. Defaults to 100. */

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

@@ -2,11 +2,11 @@ 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, CallbackQuery, Chat, ChatAction, ChatID, InlineQuery, InlineQueryResult, Message, ParseMode, User } from "../3_types.js";
+import { BotCommand, CallbackQuery, Chat, ChatAction, ChatID, Document, InlineQuery, InlineQueryResult, Message, ParseMode, User } from "../3_types.js";
 import { Migrate } from "../4_errors.js";
 import { FileSource, With } from "./0_utilities.js";
 import { ClientAbstract } from "./1_client_abstract.js";
-import { AnswerCallbackQueryParams, AnswerInlineQueryParams, AuthorizeUserParams, ClientParams, DeleteMessageParams, DeleteMessagesParams, DownloadParams, EditMessageParams, FilterableUpdates, FilterUpdate, ForwardMessagesParams, GetChatsParams, GetHistoryParams, GetMyCommandsParams, InvokeErrorHandler, NetworkStatistics, ReplyParams, SendDocumentParams, SendMessageParams, SendPhotoParams, SendPollParams, SetMyCommandsParams, Update, UploadParams } from "./3_types.js";
+import { AnswerCallbackQueryParams, AnswerInlineQueryParams, AuthorizeUserParams, ClientParams, DeleteMessageParams, DeleteMessagesParams, DownloadParams, EditMessageParams, FilterableUpdates, FilterUpdate, ForwardMessagesParams, GetChatsParams, GetHistoryParams, GetMyCommandsParams, InvokeErrorHandler, NetworkStatistics, ReplyParams, SendAnimationParams, SendAudioParams, SendContactParams, SendDiceParams, SendDocumentParams, SendLocationParams, SendMessageParams, SendPhotoParams, SendPollParams, SendVenueParams, SendVideoNoteParams, SendVideoParams, SendVoiceParams, SetMyCommandsParams, Update, UploadParams } from "./3_types.js";
 import { Composer, Middleware } from "./4_composer.js";
 declare const getEntity: unique symbol;
 declare const getStickerSetName: unique symbol;
@@ -45,6 +45,24 @@ export interface Context extends Update {
     replyPhoto: (photo: FileSource, params?: Omit<SendPhotoParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "photo">>;
     /** Reply the received message with a document. */
     replyDocument: (document: FileSource, params?: Omit<SendDocumentParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "document">>;
+    /** Reply the received message with a location. */
+    replyLocation: (latitude: number, longitude: number, params?: Omit<SendLocationParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "location">>;
+    /** Reply the received message with a dice. */
+    replyDice: (params?: Omit<SendDiceParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "dice">>;
+    /** Reply the received message with a venue. */
+    replyVenue: (latitude: number, longitude: number, title: string, address: string, params?: Omit<SendVenueParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "venue">>;
+    /** Reply the received message with a contact. */
+    replyContact: (firstName: string, number: string, params?: Omit<SendContactParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "contact">>;
+    /** Reply the received message with a video. */
+    replyVideo: (video: FileSource, params?: Omit<SendVideoParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "video">>;
+    /** Reply the received message with an animation. */
+    replyAnimation: (animation: FileSource, params?: Omit<SendAnimationParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "animation">>;
+    /** Reply the received message with a voice message. */
+    replyVoice: (voice: FileSource, params?: Omit<SendVoiceParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "voice">>;
+    /** Reply the received message with an audio file. */
+    replyAudio: (audio: FileSource, params?: Omit<SendAudioParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "audio">>;
+    /** Reply the received message with a video note. */
+    replyVideoNote: (videoNote: FileSource, params?: Omit<SendVideoNoteParams, "replyToMessageId"> & ReplyParams) => Promise<With<Message, "videoNote">>;
     /** Delete the received message. */
     delete: () => Promise<void>;
     /** Forward the received message. */
@@ -157,6 +175,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
     private [getEntity];
     private [getEntity];
     private [getEntity];
+    private [getEntity];
     processResult(result: ReadObject): Promise<void>;
     /**
      * Send a text message.
@@ -214,7 +233,7 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      * ```
      * @returns A generator yielding the contents of the file.
      */
-    download(fileId: string, params?: DownloadParams): Promise<AsyncGenerator<Uint8Array, void, unknown>>;
+    download(fileId: string, params?: DownloadParams): AsyncGenerator<Uint8Array, void, unknown>;
     private [getStickerSetName];
     /**
      * Forward multiple messages.
@@ -388,6 +407,82 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      * @param document The document to send.
      */
     sendDocument(chatId: ChatID, document: FileSource, params?: SendDocumentParams): Promise<With<Message, "document">>;
+    /**
+     * Send a video.
+     *
+     * @method
+     * @param chatId The chat to send the video to.
+     * @param video The video to send.
+     */
+    sendVideo(chatId: ChatID, video: FileSource, params?: SendVideoParams): Promise<With<Message, "video">>;
+    /**
+     * Send an animation.
+     *
+     * @method
+     * @param chatId The chat to send the animation to.
+     * @param animation The animation to send.
+     */
+    sendAnimation(chatId: ChatID, animation: FileSource, params?: SendAnimationParams): Promise<With<Message, "animation">>;
+    /**
+     * Send a voice message.
+     *
+     * @method
+     * @param chatId The chat to send the voice message to.
+     * @param voice The voice to send.
+     */
+    sendVoice(chatId: ChatID, voice: FileSource, params?: SendVoiceParams): Promise<With<Message, "voice">>;
+    /**
+     * Send an audio file.
+     *
+     * @method
+     * @param chatId The chat to send the audio file to.
+     * @param audio The audio to send.
+     */
+    sendAudio(chatId: ChatID, audio: FileSource, params?: SendAudioParams): Promise<With<Message, "audio">>;
+    /**
+     * Send a video note.
+     *
+     * @method
+     * @param chatId The chat to send the video note to.
+     * @param videoNote The video note to send.
+     */
+    sendVideoNote(chatId: ChatID, audio: FileSource, params?: SendVideoNoteParams): Promise<With<Message, "videoNote">>;
+    /**
+     * Send a location.
+     *
+     * @method
+     * @param chatId The chat to send the location to.
+     * @param latitude The location's latitude.
+     * @param longitude The location's longitude.
+     */
+    sendLocation(chatId: ChatID, latitude: number, longitude: number, params?: SendLocationParams): Promise<With<Message, "location">>;
+    /**
+     * Send a contact.
+     *
+     * @method
+     * @param chatId The chat to send the contact to.
+     * @param firstName The contact's first name.
+     * @param number The contact's phone number.
+     */
+    sendContact(chatId: ChatID, firstName: string, number: string, params?: SendContactParams): Promise<With<Message, "contact">>;
+    /**
+     * Send a dice.
+     *
+     * @method
+     * @param chatId The chat to send the dice to.
+     */
+    sendDice(chatId: ChatID, params?: SendDiceParams): Promise<With<Message, "dice">>;
+    /**
+     * Send a venue.
+     *
+     * @method
+     * @param chatId The chat to send the venue to.
+     * @param latitude The latitude of the venue.
+     * @param longitude The longitude of the venue.
+     * @param title The title of the venue.
+     * @param address The written address of the venue.
+     */
+    sendVenue(chatId: ChatID, latitude: number, longitude: number, title: string, address: string, params?: SendVenueParams): Promise<With<Message, "dice">>;
     /**
      * Get network statistics. This might not always be available.
      *
@@ -395,17 +490,30 @@ export declare class Client<C extends Context = Context> extends ClientAbstract
      */
     getNetworkStatistics(): Promise<NetworkStatistics>;
     /**
-     * Get chats.
+     * Get chats from a chat list. User-only.
      *
      * @method
      */
     getChats(params?: GetChatsParams): Promise<Chat[]>;
     /**
-     * Get chat history.
+     * Get a chat.
+     *
+     * @method
+     */
+    getChat(chatId: ChatID): Promise<Chat>;
+    /**
+     * Get chat history. User-only.
      *
      * @param chatId The identifier of the chat to get its history.
      * @method
      */
     getHistory(chatId: ChatID, params?: GetHistoryParams): Promise<Message[]>;
+    /**
+     * Get custom emoji documents for download.
+     *
+     * @param id Identifier of one or more of custom emojis.
+     * @method
+     */
+    getCustomEmojiDocuments(id: string | string[]): Promise<Document[]>;
 }
 export {};