@mtkruto/node 0.0.993 → 0.0.994

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

@@ -1,414 +0,0 @@
-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 { CallbackQuery, ForceReply, InlineKeyboardMarkup, InlineQuery, Message, // high-level Telegram API message
-MessageEntity, ReplyKeyboardMarkup, ReplyKeyboardRemove } from "../3_types.js";
-import { ClientPlainParams } from "./2_client_plain.js";
-import { ClientAbstract } from "./1_client_abstract.js";
-export declare const getEntity: unique symbol;
-export declare const getStickerSetName: unique symbol;
-export declare const handleMigrationError: unique symbol;
-export declare const getMessageWithReply: unique symbol;
-export declare const restartAuth: unique symbol;
-export declare enum ParseMode {
-    None = "none",
-    HTML = "html"
-}
-export interface AuthorizeUserParams<S = string> {
-    phone: S | (() => MaybePromise<S>);
-    code: S | (() => MaybePromise<S>);
-    password: S | ((hint: string | null) => MaybePromise<S>);
-}
-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;
-    /**
-     * The app_version parameter to be passed to initConnection when calling `authorize`. It is recommended that this parameter is changed if users are authorized. Defaults to "MTKruto" followed by this version of MTKruto.
-     */
-    appVersion?: string;
-    /**
-     * The device_version parameter to be passed to initConnection when calling `authorize`. The default varies by the current runtime.
-     */
-    deviceModel?: string;
-    /**
-     * The lang_code parameter to be passed to initConnection when calling `authorize`. Defaults to the runtime's language or `"en"`.
-     */
-    langCode?: string;
-    /**
-     * The lang_pack parameter to be passed to initConnection when calling `authorize`. Defaults to an empty string.
-     */
-    langPack?: string;
-    /**
-     * The system_lang_cde parameter to be passed to initConnection when calling `authorize`. Defaults to the runtime's language or `"en"`.
-     */
-    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;
-}
-export interface AnswerCallbackQueryParams {
-    /** Text of the answer */
-    text?: string;
-    /** Pass true to show an alert to the user instead of a toast notification */
-    alert?: boolean;
-    /** URL to be opened */
-    url?: string;
-    /** Time during which the result of the query can be cached, in seconds */
-    cacheTime?: number;
-}
-/**
- * A chat identifier as provided by MTKruto or a string starting with a @ that is followed by a username.
- */
-export type ChatID = number | string;
-export interface SendMessagesParams {
-    /**
-     * The parse mode to use. If not provided, the default parse mode will be used.
-     */
-    parseMode?: ParseMode;
-    /**
-     * The message's entities.
-     */
-    entities?: MessageEntity[];
-    /**
-     * Whether to disable web page previews in the message that is to be sent.
-     */
-    disableWebPagePreview?: 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 EditMessageParams {
-    /**
-     * The parse mode to use. If not provided, the default parse mode will be used.
-     */
-    parseMode?: ParseMode;
-    /**
-     * The message's entities.
-     */
-    entities?: MessageEntity[];
-    /**
-     * Whether to disable web page previews in the message that is to be edited.
-     */
-    disableWebPagePreview?: boolean;
-    /**
-     * The reply markup of the message. Bot-only.
-     */
-    replyMarkup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
-}
-export interface ForwardMessagesParams {
-    messageThreadId?: number;
-    /**
-     * Whether to forward the message in a silent way without making a sound on the recipients' clients.
-     */
-    disableNotification?: boolean;
-    /**
-     * Whether to protect the contents of the forwarded message from copying and forwarding.
-     */
-    protectContent?: boolean;
-    /**
-     * The identifier of the chat to forward the message on behalf of. User-only.
-     */
-    sendAs?: ChatID;
-    /**
-     * Whether to not include the original sender of the message that is going to be forwarded.
-     */
-    dropSenderName?: boolean;
-    /**
-     * Whether to not include the original caption of the message that is going to be forwarded.
-     */
-    dropCaption?: boolean;
-}
-export declare class Client extends ClientAbstract {
-    readonly storage: Storage;
-    readonly apiId: number | null;
-    readonly apiHash: string | null;
-    private auth;
-    private sessionId;
-    private state;
-    private promises;
-    private toAcknowledge;
-    private updateState?;
-    readonly parseMode: ParseMode;
-    readonly appVersion: string;
-    readonly deviceModel: string;
-    readonly langCode: string;
-    readonly langPack: string;
-    readonly systemLangCode: string;
-    readonly systemVersion: string;
-    private readonly publicKeys?;
-    private readonly autoStart;
-    /**
-     * Constructs the client.
-     *
-     * @param storage The storage provider to use. Defaults to memory storage.
-     * @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).
-     * @param params Other parameters.
-     */
-    constructor(storage?: Storage, apiId?: number | null, apiHash?: string | null, params?: ClientParams);
-    private propagateConnectionState;
-    private lastPropagatedConnectionState;
-    protected stateChangeHandler: (connected: boolean) => void;
-    private storageInited;
-    /**
-     * 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.
-     *
-     * @param dc The DC to change to.
-     */
-    setDc(dc: DC): Promise<void>;
-    private setAuth;
-    private connectMutex;
-    /**
-     * Loads the session if `setDc` was not called, initializes and connnects
-     * a `ClientPlain` to generate auth key if there was none, and connects the client.
-     * Before establishing the connection, the session is saved.
-     */
-    connect(): Promise<void>;
-    private fetchState;
-    [handleMigrationError](err: types.RPCError): Promise<void>;
-    private connectionInited;
-    disconnect(): Promise<void>;
-    private initConnection;
-    private lastPropagatedAuthorizationState;
-    private propagateAuthorizationState;
-    /**
-     * Calls [initConnection](1) and authorizes the client with one of the following:
-     *
-     * - Bot token (`string`)
-     * - Exported authorization (`types.AuthExportedAuthorization`)
-     * - User authorization handlers (`AuthorizeUserParams`)
-     *
-     * if the current auth key doesn't throw AUTH_KEY_UNREGISTERED when calling [updates.getState](2).
-     *
-     * Notes:
-     * 1. Requires the `apiId` and `apiHash` paramters to be passed when constructing the client.
-     * 2. Reconnects the client to the appropriate DC in case of MIGRATE_X errors.
-     * 3. The parameters passed to the [initConnection][1] call can be configured with the last parameter of the constructor.
-     *
-     * [1]: https://core.telegram.org/method/initConnection
-     * [2]: https://core.telegram.org/method/updates.getState
-     */
-    authorize(params?: string | types.AuthExportedAuthorization | AuthorizeUserParams): Promise<void>;
-    /**
-     * Same as calling `.connect()` followed by `.authorize(params)`.
-     */
-    start(params?: string | types.AuthExportedAuthorization | AuthorizeUserParams): Promise<void>;
-    private receiveLoop;
-    private pingLoop;
-    private autoStarted;
-    private lastMsgId;
-    /**
-     * Invokes a function waiting and returning its reply if the second parameter is not `true`. Requires the client
-     * to be connected.
-     *
-     * @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>;
-    /**
-     * Alias for `invoke` with its second parameter being `true`.
-     */
-    send<T extends (functions.Function<unknown> | types.Type) = functions.Function<unknown>>(function_: T): Promise<void>;
-    private processChats;
-    private processUsers;
-    private handleUpdateQueue;
-    private processUpdatesQueue;
-    private checkGap;
-    private checkChannelGap;
-    private processUpdates;
-    private setUpdateStateDate;
-    private getLocalState;
-    private recoverUpdateGap;
-    private recoverChannelUpdateGap;
-    private getUserAccessHash;
-    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>;
-    processResult(result: ReadObject): Promise<void>;
-    private updatesToMessages;
-    /**
-     * Send a text message.
-     *
-     * @param chatId The chat to send the message to.
-     * @param text The message's text.
-     */
-    sendMessage(chatId: ChatID, text: string, params?: SendMessagesParams): Promise<Message>;
-    /**
-     * Edit a message's text.
-     *
-     * @param chatId The chat where the message is.
-     * @param messageId The ID of the message.
-     * @param text The new text of the message.
-     */
-    editMessageText(chatId: ChatID, messageId: number, text: string, params?: EditMessageParams): Promise<void>;
-    private getMessagesInner;
-    /**
-     * Retrieve multiple messages.
-     *
-     * @param chatId The identifier of the chat to retrieve the messages from.
-     * @param messageIds The identifiers of the messages to retrieve.
-     */
-    getMessages(chatId_: ChatID, messageIds: number[]): Promise<Omit<Message, "replyToMessage">[]>;
-    [getMessageWithReply](chatId: ChatID, messageId: number): Promise<Message | null>;
-    /**
-     * Retrieve a single message.
-     *
-     * @param chatId The identifier of the chat to retrieve the message from.
-     * @param messageId The identifier of the message to retrieve.
-     */
-    getMessage(chatId: ChatID, messageId: number): Promise<Omit<Message, "replyToMessage"> | null>;
-    private downloadInner;
-    /**
-     * Download a file.
-     *
-     * @param fileId The identifier of the file to download.
-     */
-    download(fileId: string): Promise<AsyncGenerator<Uint8Array, void, unknown>>;
-    [getStickerSetName](inputStickerSet: types.InputStickerSetID, hash?: number): Promise<string>;
-    /**
-     * Forward multiple messages.
-     *
-     * @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.
-     */
-    forwardMessages(from: ChatID, to: ChatID, messageIds: number[], params?: ForwardMessagesParams): Promise<Message[]>;
-    /**
-     * Forward a single message.
-     *
-     * @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.
-     */
-    forwardMessage(from: ChatID, to: ChatID, messageId: number, params?: ForwardMessagesParams): Promise<Message>;
-    /**
-     * Get information on the currently authorized user.
-     */
-    getMe(): Promise<import("../3_types.js").User>;
-    private handleUpdate;
-    handler: Handler;
-    use(middleware: Handler): void;
-    on<U extends keyof Update, K extends keyof Update[U]>(filter: U extends FilterableUpdates ? U | [U, K, ...K[]] : U, handler: Handler<Pick<{
-        [P in U]: With<Update[U], K>;
-    }, U>>): void;
-    /**
-     * Answer a callback query. Bot-only.
-     *
-     * @param id ID of the callback query to answer.
-     */
-    answerCallbackQuery(id: string, params?: AnswerCallbackQueryParams): Promise<void>;
-    sendPoll(chatId: ChatID, question: string, options: [string, string, ...string[]], params?: SendPollParams): Promise<void>;
-}
-export interface SendPollParams {
-    /**
-     * True, if the poll needs to be anonymous, defaults to True */
-    isAnonymous?: boolean;
-    /**
-     * The type of the poll. Defaults to regular. */
-    type?: "quiz" | "regular";
-    /**
-     * True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False */
-    allowMultipleAnswers?: boolean;
-    /**
-     * Index of the correct option. Required for quizzes. */
-    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 */
-    explanation?: string;
-    /**
-     * The parse mode to use for the explanation. If not provided, the default parse mode will be used.
-     */
-    explanationParseMode?: ParseMode;
-    /**
-     * The explanation's entities.
-     */
-    explanationEntities?: MessageEntity[];
-    /**
-     * Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.
-     */
-    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.
-     */
-    closeDate?: Date;
-    /**
-     * Pass True if the poll needs to be immediately closed. This can be useful for poll preview.
-     */
-    isClosed?: boolean;
-    /**
-     * Whether to send the message in a silent way without making a sound on the recipients' clients.
-     */
-    disableNotification?: 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;
-    /**
-     * Whether to protect the contents of the message from copying and forwarding.
-     */
-    protectContent?: boolean;
-}
-type With<T, K extends keyof T> = T & Required<Pick<T, K>>;
-export type ConnectionState = "not-connected" | "updating" | "ready";
-export type AuthorizationState = {
-    authorized: boolean;
-};
-type FilterableUpdates = "message" | "editedMessage" | "callbackQuery";
-export interface Update {
-    message: Message;
-    editedMessage: Message;
-    connectionState: ConnectionState;
-    authorizationState: AuthorizationState;
-    deletedMessages: [Message, ...Message[]];
-    callbackQuery: CallbackQuery;
-    inlineQuery: InlineQuery;
-}
-export interface Handler<U extends Partial<Update> = Partial<Update>> {
-    (update: U, next: () => Promise<void>): MaybePromise<void>;
-}
-export {};