@mtkruto/node 0.1.105 → 0.1.107

package/esm/types/1_document.d.ts

@@ -1,18 +1,17 @@
 import { types } from "../2_tl.js";
 import { Thumbnail } from "./0_thumbnail.js";
-/** This object represents a general file (as opposed to photos, voice messages and audio files). */
 export interface Document {
-    /** Identifier for this file, which can be used to download or reuse the file */
+    /** A file identifier that can be used to download or reuse this file. */
     fileId: string;
-    /** Unique identifier for this file, which is supposed to be the same over time and for different users and bots. Can't be used to download or reuse the file. */
+    /** A file identifier that can be used to identify this file. */
     fileUniqueId: string;
-    /** Document thumbnail as defined by sender */
+    /** Thumbnails of the document. */
     thumbnails: Thumbnail[];
-    /** Original filename as defined by sender */
+    /** The original file name. */
     fileName: string;
-    /** MIME type of the file as defined by sender */
+    /** MIME type of the file. */
     mimeType: string;
-    /** File size in bytes */
+    /** Size of the file in bytes. */
     fileSize: number;
 }
 export declare function constructDocument(document: types.Document, fileNameAttribute: types.DocumentAttributeFilename, fileId: string, fileUniqueId: string): Document;

package/esm/types/1_keyboard_button.d.ts

@@ -4,7 +4,7 @@ import { KeyboardButtonPollType } from "./0_keyboard_button_poll_type.js";
 import { WebAppInfo } from "./0_web_app_info.js";
 export declare namespace KeyboardButton {
     interface Text {
-        /** Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed */
+        /** The button's text. */
         text: string;
     }
     /** This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed. */

package/esm/types/1_photo.d.ts

@@ -2,15 +2,15 @@ import { types } from "../2_tl.js";
 import { Thumbnail } from "./0_thumbnail.js";
 /** This object represents a photo. */
 export interface Photo {
-    /** Identifier for this file, which can be used to download or reuse the file */
+    /** A file identifier that can be used to download or reuse this file. */
     fileId: string;
-    /** Unique identifier for this file, which is supposed to be the same over time and for different users and bots. Can't be used to download or reuse the file. */
+    /** A file identifier that can be used to identify this file. */
     fileUniqueId: string;
     /** Photo width */
     width: number;
     /** Photo height */
     height: number;
-    /** File size in bytes */
+    /** Size of the file in bytes. */
     fileSize: number;
     thumbnails: Thumbnail[];
 }

package/esm/types/1_sticker.d.ts

@@ -4,9 +4,9 @@ import { MaskPosition } from "./0_mask_position.js";
 import { Thumbnail } from "./0_thumbnail.js";
 /** This object represents a sticker. */
 export interface Sticker {
-    /** Identifier for this file, which can be used to download or reuse the file */
+    /** A file identifier that can be used to download or reuse this file. */
     fileId: string;
-    /** Unique identifier for this file, which is supposed to be the same over time and for different users and bots. Can't be used to download or reuse the file. */
+    /** A file identifier that can be used to identify this file. */
     fileUniqueId: string;
     /** Type of the sticker, currently one of "regular", "mask", "customEmoji". The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video. */
     type: "regular" | "mask" | "customEmoji";

package/esm/types/1_user.d.ts

@@ -5,6 +5,7 @@ import { Color } from "./0_color.js";
 export interface User {
     /** Unique identifier for this user or bot */
     id: number;
+    /** A color that can be displayed instead of the user's photo. */
     color: Color;
     /** True, if this user is a bot */
     isBot: boolean;
@@ -16,7 +17,7 @@ export interface User {
     username?: string;
     /** Additional usernames */
     also?: string[];
-    /** Chat photo */
+    /** The user's photo. */
     photo?: ChatPhoto.User;
     /** [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language */
     languageCode?: string;

package/esm/types/1_video.d.ts

@@ -2,9 +2,9 @@ import { types } from "../2_tl.js";
 import { Thumbnail } from "./0_thumbnail.js";
 /** This object represents a video file. */
 export interface Video {
-    /** Identifier for this file, which can be used to download or reuse the file */
+    /** A file identifier that can be used to download or reuse this file. */
     fileId: string;
-    /** Unique identifier for this file, which is supposed to be the same over time and for different users and bots. Can't be used to download or reuse the file. */
+    /** A file identifier that can be used to identify this file. */
     fileUniqueId: string;
     /** Video width as defined by sender */
     width: number;
@@ -16,9 +16,9 @@ export interface Video {
     thumbnails: Thumbnail[];
     /** Original filename as defined by sender */
     fileName?: string;
-    /** MIME type of the file as defined by sender */
+    /** MIME type of the file. */
     mimeType: string;
-    /** File size in bytes */
+    /** Size of the file in bytes. */
     fileSize: number;
 }
 export declare function constructVideo(document: types.Document, videoAttribute: types.DocumentAttributeVideo, fileName: string | undefined, fileId: string, fileUniqueId: string): Video;

package/esm/types/1_video_note.d.ts

@@ -2,9 +2,9 @@ import { types } from "../2_tl.js";
 import { Thumbnail } from "./0_thumbnail.js";
 /** This object represents a video message (available in Telegram apps as of v.4.0). */
 export interface VideoNote {
-    /** Identifier for this file, which can be used to download or reuse the file */
+    /** A file identifier that can be used to download or reuse this file. */
     fileId: string;
-    /** Unique identifier for this file, which is supposed to be the same over time and for different users and bots. Can't be used to download or reuse the file. */
+    /** A file identifier that can be used to identify this file. */
     fileUniqueId: string;
     /** Video width and height (diameter of the video message) as defined by sender */
     length: number;
@@ -14,7 +14,7 @@ export interface VideoNote {
     thumbnails: Thumbnail[];
     /** Original filename as defined by sender */
     fileName?: string;
-    /** File size in bytes */
+    /** Size of the file in bytes. */
     fileSize: number;
 }
 export declare function constructVideoNote(document: types.Document, videoAttribute: types.DocumentAttributeVideo, fileId: string, fileUniqueId: string): VideoNote;

package/package.json

@@ -2,7 +2,7 @@
   "module": "./esm/mod.js",
   "main": "./script/mod.js",
   "name": "@mtkruto/node",
-  "version": "0.1.105",
+  "version": "0.1.107",
   "description": "MTKruto for Node.js",
   "author": "Roj <rojvv@icloud.com>",
   "license": "LGPL-3.0-or-later",

package/script/4_constants.d.ts

@@ -4,8 +4,8 @@ export type PublicKeys = readonly [bigint, [bigint, bigint]][];
 export declare const PUBLIC_KEYS: PublicKeys;
 export declare const VECTOR_CONSTRUCTOR = 481674261;
 export declare const INITIAL_DC: DC;
-export declare const LAYER = 161;
-export declare const APP_VERSION = "MTKruto 0.1.105";
+export declare const LAYER = 165;
+export declare const APP_VERSION = "MTKruto 0.1.107";
 export declare const DEVICE_MODEL: string;
 export declare const LANG_CODE: string;
 export declare const LANG_PACK = "";

package/script/4_constants.js

@@ -79,8 +79,8 @@ exports.PUBLIC_KEYS = Object.freeze([
 ]);
 exports.VECTOR_CONSTRUCTOR = 0x1CB5C415;
 exports.INITIAL_DC = "2-test";
-exports.LAYER = 161;
-exports.APP_VERSION = "MTKruto 0.1.105";
+exports.LAYER = 165;
+exports.APP_VERSION = "MTKruto 0.1.107";
 // @ts-ignore: lib
 exports.DEVICE_MODEL = typeof dntShim.Deno === "undefined" ? typeof navigator === "undefined" ? typeof process === "undefined" ? "Unknown" : process.platform + "-" + process.arch : navigator.userAgent.split(" ")[0] : dntShim.Deno.build.os + "-" + dntShim.Deno.build.arch;
 exports.LANG_CODE = typeof navigator === "undefined" ? "en" : navigator.language.split("-")[0];

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

@@ -40,13 +40,13 @@ export interface ClientParams extends ClientPlainParams {
     errorHandler?: (err: unknown, function_: types.Type | functions.Function<unknown>, n: number) => MaybePromise<boolean>;
 }
 export interface AnswerCallbackQueryParams {
-    /** Text of the answer */
+    /** A text to be shown to the user. */
     text?: string;
-    /** Pass true to show an alert to the user instead of a toast notification */
+    /** Whether to show the text as an alert (popup). */
     alert?: boolean;
-    /** URL to be opened */
+    /** A URL to be opened. */
     url?: string;
-    /** Time during which the result of the query can be cached, in seconds */
+    /** TTL of answer caches in seconds. */
     cacheTime?: number;
 }
 export interface AuthorizeUserParams<S = string> {
@@ -135,19 +135,24 @@ export interface ForwardMessagesParams {
 }
 export interface SendPollParams {
     /**
-     * True, if the poll needs to be anonymous, defaults to True */
+     * Whether the poll should be anonymous.
+     */
     isAnonymous?: boolean;
     /**
-     * The type of the poll. Defaults to regular. */
+     * The type of the poll.
+     */
     type?: "quiz" | "regular";
     /**
-     * True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False */
+     * Whether multiple selections should be allowed. Only valid for regular polls.
+     */
     allowMultipleAnswers?: boolean;
     /**
-     * Index of the correct option. Required for quizzes. */
+     * Index of the correct option. Required for quiz polls.
+     */
     correctOptionIndex?: number;
     /**
-     *  Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing */
+     * A text that will be shown to the user when the poll is answered. Only valid for quiz polls.
+     */
     explanation?: string;
     /**
      * The parse mode to use for the explanation. If not provided, the default parse mode will be used.
@@ -158,15 +163,15 @@ export interface SendPollParams {
      */
     explanationEntities?: MessageEntity[];
     /**
-     * Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.
+     * Duration of the poll in seconds. Must be in the range of 5-600. Cannot be used simultaneously with `closeDate`.
      */
     openPeriod?: number;
     /**
-     * Point in time when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.
+     * The time in which the poll will be closed. Must be at least 5 seconds in the future, and no more than 600. Cannot be used simultaneously with `openPeriod`.
      */
     closeDate?: Date;
     /**
-     * Pass True if the poll needs to be immediately closed. This can be useful for poll preview.
+     * Whether the poll should be closed as soon as it is sent, allowing no answers.
      */
     isClosed?: boolean;
     /**

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

@@ -2,15 +2,15 @@ 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 } from "../3_types.js";
+import { BotCommand, ChatAction, ChatID, InlineQueryResult, Message, User } from "../3_types.js";
 import { Migrate } from "../4_errors.js";
 import { With } from "./0_utilities.js";
 import { ClientAbstract } from "./1_client_abstract.js";
 import { AnswerCallbackQueryParams, AnswerInlineQueryParams, AuthorizeUserParams, ClientParams, DownloadParams, EditMessageParams, FilterableUpdates, FilterUpdate, ForwardMessagesParams, GetMyCommandsParams, Handler, ParseMode, SendMessagesParams, SendPollParams, SetMyCommandsParams, Update, UploadParams } from "./3_types.js";
-export declare const getEntity: unique symbol;
-export declare const getStickerSetName: unique symbol;
+declare const getEntity: unique symbol;
+declare const getStickerSetName: unique symbol;
 export declare const handleMigrationError: unique symbol;
-export declare const getMessageWithReply: unique symbol;
+declare const getMessageWithReply: unique symbol;
 export declare const restartAuth: unique symbol;
 export declare class ConnectionError extends Error {
 }
@@ -126,76 +126,104 @@ export declare class Client extends ClientAbstract {
     private getChannelAccessHash;
     getInputPeer(id: ChatID): Promise<types.InputPeerChat | types.InputPeerUser | types.InputPeerChannel>;
     private getInputPeerInner;
-    [getEntity](peer: types.PeerUser): Promise<types.User | null>;
-    [getEntity](peer: types.PeerChat): Promise<types.Chat | null>;
-    [getEntity](peer: types.PeerChannel): Promise<types.Channel | null>;
+    private [getEntity];
+    private [getEntity];
+    private [getEntity];
     processResult(result: ReadObject): Promise<void>;
     private updatesToMessages;
     private resolveSendAs;
     /**
      * 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.
      */
     sendMessage(chatId: ChatID, text: string, params?: SendMessagesParams): Promise<With<Message, "text">>;
     private parseText;
     /**
      * 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.
      */
     editMessageText(chatId: ChatID, messageId: number, text: string, params?: EditMessageParams): Promise<With<Message, "text">>;
     private getMessagesInner;
     /**
      * 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.
      */
-    getMessages(chatId_: ChatID, messageIds: number[]): Promise<Omit<Message, "replyToMessage">[]>;
-    [getMessageWithReply](chatId: ChatID, messageId: number): Promise<Message | null>;
+    getMessages(chatId: ChatID, messageIds: number[]): Promise<Omit<Message, "replyToMessage">[]>;
+    private [getMessageWithReply];
     /**
      * 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.
      */
     getMessage(chatId: ChatID, messageId: number): Promise<Omit<Message, "replyToMessage"> | null>;
     private downloadInner;
     /**
      * 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.
      */
     download(fileId: string, params?: DownloadParams): Promise<AsyncGenerator<Uint8Array, void, unknown>>;
-    [getStickerSetName](inputStickerSet: types.InputStickerSetID, hash?: number): Promise<string>;
+    private [getStickerSetName];
     /**
      * 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.
      */
     forwardMessages(from: ChatID, to: ChatID, messageIds: number[], params?: ForwardMessagesParams): Promise<Message[]>;
     /**
      * 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.
      */
     forwardMessage(from: ChatID, to: ChatID, messageId: number, params?: ForwardMessagesParams): Promise<Message>;
     /**
      * Get information on the currently authorized user.
+     *
+     * @method
      */
-    getMe(): Promise<import("../3_types.js").User>;
+    getMe(): Promise<User>;
     private handleUpdate;
     /**
      * Answer a callback query. Bot-only.
      *
+     * @method
      * @param id ID of the callback query to answer.
      */
     answerCallbackQuery(id: string, params?: AnswerCallbackQueryParams): Promise<void>;
@@ -205,28 +233,35 @@ export declare class Client extends 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.
      */
     sendPoll(chatId: ChatID, question: string, options: [string, string, ...string[]], params?: SendPollParams): Promise<With<Message, "poll">>;
     /**
      * 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.
      */
-    sendChatAction(chatId: ChatID, action_: ChatAction, messageThreadId?: number): Promise<void>;
+    sendChatAction(chatId: ChatID, action: ChatAction, params?: {
+        messageThreadId?: number;
+    }): Promise<void>;
     /**
      * Upload a file.
      *
+     * @method
      * @param contents The contents of the file.
      */
     upload(contents: Uint8Array, params?: UploadParams): Promise<types.InputFile | types.InputFileBig>;
     /**
      * Set the bot's commands in the given scope and/or language. Bot-only.
      *
+     * @method
      * @param commands The commands to set.
      */
     setMyCommands(commands: BotCommand[], params?: SetMyCommandsParams): Promise<void>;
@@ -237,6 +272,7 @@ export declare class Client extends 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.
      */
@@ -250,6 +286,8 @@ export declare class Client extends ClientAbstract {
     private setMyInfo;
     /**
      * Set the bot's description in the given language. Bot-only.
+     *
+     * @method
      */
     setMyDescription({ description, languageCode }: {
         description?: string;
@@ -257,6 +295,8 @@ export declare class Client extends ClientAbstract {
     }): Promise<void>;
     /**
      * Set the bot's name in the given language. Bot-only.
+     *
+     * @method
      */
     setMyName({ name, languageCode }: {
         name?: string;
@@ -264,6 +304,8 @@ export declare class Client extends ClientAbstract {
     }): Promise<void>;
     /**
      * Set the bot's short description in the given language. Bot-only.
+     *
+     * @method
      */
     setMyShortDescription({ shortDescription: about, languageCode }: {
         shortDescription?: string;
@@ -272,14 +314,27 @@ export declare class Client extends ClientAbstract {
     private getMyInfo;
     /**
      * Get the bot's description in the given language. Bot-only.
+     *
+     * @method
      */
-    getMyDescription(languageCode?: string): Promise<string>;
+    getMyDescription(params?: {
+        languageCode?: string;
+    }): Promise<string>;
     /**
      * Set the bot's name in the given language. Bot-only.
+     *
+     * @method
      */
-    getMyName(languageCode?: string): Promise<string>;
+    getMyName(params?: {
+        languageCode?: string;
+    }): Promise<string>;
     /**
      * Get the bot's short description in the given language. Bot-only.
+     *
+     * @method
      */
-    getMyShortDescription(languageCode?: string): Promise<string>;
+    getMyShortDescription(params?: {
+        languageCode?: string;
+    }): Promise<string>;
 }
+export {};