@mtcute/core 0.13.2 → 0.13.3

package/cjs/highlevel/client.d.ts

@@ -6,6 +6,7 @@ import { RpcCallOptions } from '../network/index.js';
 import { MaybeArray, MaybePromise, PartialExcept, PartialOnly } from '../types/index.js';
 import { BaseTelegramClientOptions } from './base.js';
 import { ITelegramClient } from './client.types.js';
+import { LogOutResult } from './methods/auth/log-out.js';
 import { start } from './methods/auth/start.js';
 import { CreateGroupResult } from './methods/chats/create-group.js';
 import { getChatEventLog } from './methods/chats/get-chat-event-log.js';
@@ -308,7 +309,7 @@ export interface TelegramClient extends ITelegramClient {
      *
      * @returns  On success, `true` is returned
      */
-    logOut(): Promise<true>;
+    logOut(): Promise<LogOutResult>;
     /**
      * Recover your password with a recovery code and log in.
      *
@@ -359,6 +360,10 @@ export interface TelegramClient extends ITelegramClient {
     sendCode(params: {
         /** Phone number in international format */
         phone: string;
+        /** Saved future auth tokens, if any */
+        futureAuthTokens?: Uint8Array[];
+        /** Additional code settings to pass to the server */
+        codeSettings?: Omit<tl.RawCodeSettings, '_' | 'logoutTokens'>;
     }): Promise<SentCode>;
     /**
      * Send a code to email needed to recover your password
@@ -494,6 +499,10 @@ export interface TelegramClient extends ITelegramClient {
          * @default  `console.log`.
          */
         codeSentCallback?: (code: SentCode) => MaybePromise<void>;
+        /** Saved future auth tokens, if any */
+        futureAuthTokens?: Uint8Array[];
+        /** Additional code settings to pass to the server */
+        codeSettings?: Omit<tl.RawCodeSettings, '_' | 'logoutTokens'>;
     }): Promise<User>;
     /**
      * Check if the given peer/input peer is referring to the current user
@@ -1364,6 +1373,11 @@ export interface TelegramClient extends ITelegramClient {
      * Some library logic depends on this, for example, the library will
      * periodically ping the server to keep the updates flowing.
      *
+     * > **Warning**: Opening a chat with `openChat` method will make the library make additional requests
+     * > every so often. Which means that you should **avoid opening more than 5-10 chats at once**,
+     * > as it will probably trigger server-side limits and you might start getting transport errors
+     * > or even get banned.
+     *
      * **Available**: ✅ both users and bots
      *
      * @param chat  Chat to open