@mtcute/node 0.17.0 → 0.18.0

package/client.cjs

@@ -0,0 +1,101 @@
+if (typeof globalThis !== "undefined" && !globalThis._MTCUTE_CJS_DEPRECATION_WARNED) {
+  globalThis._MTCUTE_CJS_DEPRECATION_WARNED = true;
+  console.warn("[mtcute-workspace] CommonJS support is deprecated and will be removed in 0.20.0. Please consider switching to ESM, it's " + (/* @__PURE__ */ new Date()).getFullYear() + " already.");
+  console.warn("[mtcute-workspace] Learn more about switching to ESM: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c");
+}
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const node_readline = require("node:readline");
+const utils = require("@fuman/utils");
+const client_js = require("@mtcute/core/client.js");
+const downloadFile = require("./methods/download-file.cjs");
+const downloadNodeStream = require("./methods/download-node-stream.cjs");
+const index = require("./sqlite/index.cjs");
+const crypto = require("./utils/crypto.cjs");
+const platform = require("./utils/platform.cjs");
+const tcp = require("./utils/tcp.cjs");
+let nativeCrypto;
+try {
+  nativeCrypto = require("@mtcute/crypto-node").NodeNativeCryptoProvider;
+} catch {
+}
+class BaseTelegramClient extends client_js.BaseTelegramClient {
+  constructor(opts) {
+    super({
+      // eslint-disable-next-line
+      crypto: nativeCrypto ? new nativeCrypto() : new crypto.NodeCryptoProvider(),
+      transport: new tcp.TcpTransport(),
+      platform: new platform.NodePlatform(),
+      ...opts,
+      storage: typeof opts.storage === "string" ? new index.SqliteStorage(opts.storage) : opts.storage ?? new index.SqliteStorage("client.session")
+    });
+  }
+}
+class TelegramClient extends client_js.TelegramClient {
+  constructor(opts) {
+    if ("client" in opts) {
+      super(opts);
+      return;
+    }
+    super({
+      client: new BaseTelegramClient(opts),
+      disableUpdates: opts.disableUpdates,
+      skipConversationUpdates: opts.skipConversationUpdates,
+      updates: opts.updates
+    });
+  }
+  _rl;
+  /**
+   * Tiny wrapper over Node `readline` package
+   * for simpler user input for `.start()` method.
+   *
+   * Associated `readline` interface is closed
+   * after `start()` returns, or with the client.
+   *
+   * @param text  Text of the question
+   */
+  input(text) {
+    if (!this._rl) {
+      this._rl = node_readline.createInterface({
+        input: process.stdin,
+        output: process.stdout
+      });
+    }
+    return new Promise((res) => this._rl?.question(text, res));
+  }
+  close() {
+    this._rl?.close();
+    return super.close();
+  }
+  start(params = {}) {
+    if (!params.botToken) {
+      if (!params.phone) params.phone = () => this.input("phone > ");
+      if (!params.code) params.code = () => this.input("code > ");
+      if (!params.password) {
+        params.password = () => this.input("2fa password > ");
+      }
+    }
+    return super.start(params).then((user) => {
+      if (this._rl) {
+        this._rl.close();
+        delete this._rl;
+      }
+      return user;
+    });
+  }
+  run(params, then) {
+    if (typeof params === "function") {
+      then = params;
+      params = {};
+    }
+    this.start(params).then(then).catch((err) => this.onError.emit(utils.unknownToError(err)));
+  }
+  downloadToFile(filename, location, params) {
+    return downloadFile.downloadToFile(this, filename, location, params);
+  }
+  downloadAsNodeStream(location, params) {
+    return downloadNodeStream.downloadAsNodeStream(this, location, params);
+  }
+}
+exports.BaseTelegramClient = BaseTelegramClient;
+exports.TelegramClient = TelegramClient;

package/client.d.cts

@@ -0,0 +1,40 @@
+import { FileDownloadLocation, FileDownloadParameters, ITelegramStorageProvider, PartialOnly, User } from '@mtcute/core';
+import { BaseTelegramClientOptions as BaseTelegramClientOptionsBase, TelegramClientOptions, BaseTelegramClient as BaseTelegramClientBase, TelegramClient as TelegramClientBase } from '@mtcute/core/client.js';
+import { Readable } from 'node:stream';
+export type { TelegramClientOptions };
+export interface BaseTelegramClientOptions extends PartialOnly<Omit<BaseTelegramClientOptionsBase, 'storage'>, 'transport' | 'crypto' | 'platform'> {
+    /**
+     * Storage to use for this client.
+     *
+     * If a string is passed, it will be used as
+     * a name for an SQLite database file.
+     *
+     * @default `"client.session"`
+     */
+    storage?: string | ITelegramStorageProvider;
+}
+export declare class BaseTelegramClient extends BaseTelegramClientBase {
+    constructor(opts: BaseTelegramClientOptions);
+}
+/**
+ * Telegram client for use in Node.js
+ */
+export declare class TelegramClient extends TelegramClientBase {
+    constructor(opts: TelegramClientOptions);
+    private _rl?;
+    /**
+     * Tiny wrapper over Node `readline` package
+     * for simpler user input for `.start()` method.
+     *
+     * Associated `readline` interface is closed
+     * after `start()` returns, or with the client.
+     *
+     * @param text  Text of the question
+     */
+    input(text: string): Promise<string>;
+    close(): Promise<void>;
+    start(params?: Parameters<TelegramClientBase['start']>[0]): Promise<User>;
+    run(params: Parameters<TelegramClient['start']>[0] | ((user: User) => void | Promise<void>), then?: (user: User) => void | Promise<void>): void;
+    downloadToFile(filename: string, location: FileDownloadLocation, params?: FileDownloadParameters | undefined): Promise<void>;
+    downloadAsNodeStream(location: FileDownloadLocation, params?: FileDownloadParameters | undefined): Readable;
+}

package/client.d.ts

@@ -1,8 +1,8 @@
-import { Readable } from 'node:stream';
 import { FileDownloadLocation, FileDownloadParameters, ITelegramStorageProvider, PartialOnly, User } from '@mtcute/core';
 import { BaseTelegramClientOptions as BaseTelegramClientOptionsBase, TelegramClientOptions, BaseTelegramClient as BaseTelegramClientBase, TelegramClient as TelegramClientBase } from '@mtcute/core/client.js';
+import { Readable } from 'node:stream';
 export type { TelegramClientOptions };
-export interface BaseTelegramClientOptions extends PartialOnly<Omit<BaseTelegramClientOptionsBase, 'storage'>, 'transport' | 'crypto'> {
+export interface BaseTelegramClientOptions extends PartialOnly<Omit<BaseTelegramClientOptionsBase, 'storage'>, 'transport' | 'crypto' | 'platform'> {
     /**
      * Storage to use for this client.
      *
@@ -12,13 +12,6 @@ export interface BaseTelegramClientOptions extends PartialOnly<Omit<BaseTelegram
      * @default `"client.session"`
      */
     storage?: string | ITelegramStorageProvider;
-    /**
-     * **ADVANCED USE ONLY**
-     *
-     * Whether to not set up the platform.
-     * This is useful if you call `setPlatform` yourself.
-     */
-    platformless?: boolean;
 }
 export declare class BaseTelegramClient extends BaseTelegramClientBase {
     constructor(opts: BaseTelegramClientOptions);

package/client.js

@@ -0,0 +1,96 @@
+import { createInterface } from "node:readline";
+import { unknownToError } from "@fuman/utils";
+import { BaseTelegramClient as BaseTelegramClient$1, TelegramClient as TelegramClient$1 } from "@mtcute/core/client.js";
+import { downloadToFile } from "./methods/download-file.js";
+import { downloadAsNodeStream } from "./methods/download-node-stream.js";
+import { SqliteStorage } from "./sqlite/index.js";
+import { NodeCryptoProvider } from "./utils/crypto.js";
+import { NodePlatform } from "./utils/platform.js";
+import { TcpTransport } from "./utils/tcp.js";
+let nativeCrypto;
+try {
+  nativeCrypto = (await import("@mtcute/crypto-node")).NodeNativeCryptoProvider;
+} catch {
+}
+class BaseTelegramClient extends BaseTelegramClient$1 {
+  constructor(opts) {
+    super({
+      // eslint-disable-next-line
+      crypto: nativeCrypto ? new nativeCrypto() : new NodeCryptoProvider(),
+      transport: new TcpTransport(),
+      platform: new NodePlatform(),
+      ...opts,
+      storage: typeof opts.storage === "string" ? new SqliteStorage(opts.storage) : opts.storage ?? new SqliteStorage("client.session")
+    });
+  }
+}
+class TelegramClient extends TelegramClient$1 {
+  constructor(opts) {
+    if ("client" in opts) {
+      super(opts);
+      return;
+    }
+    super({
+      client: new BaseTelegramClient(opts),
+      disableUpdates: opts.disableUpdates,
+      skipConversationUpdates: opts.skipConversationUpdates,
+      updates: opts.updates
+    });
+  }
+  _rl;
+  /**
+   * Tiny wrapper over Node `readline` package
+   * for simpler user input for `.start()` method.
+   *
+   * Associated `readline` interface is closed
+   * after `start()` returns, or with the client.
+   *
+   * @param text  Text of the question
+   */
+  input(text) {
+    if (!this._rl) {
+      this._rl = createInterface({
+        input: process.stdin,
+        output: process.stdout
+      });
+    }
+    return new Promise((res) => this._rl?.question(text, res));
+  }
+  close() {
+    this._rl?.close();
+    return super.close();
+  }
+  start(params = {}) {
+    if (!params.botToken) {
+      if (!params.phone) params.phone = () => this.input("phone > ");
+      if (!params.code) params.code = () => this.input("code > ");
+      if (!params.password) {
+        params.password = () => this.input("2fa password > ");
+      }
+    }
+    return super.start(params).then((user) => {
+      if (this._rl) {
+        this._rl.close();
+        delete this._rl;
+      }
+      return user;
+    });
+  }
+  run(params, then) {
+    if (typeof params === "function") {
+      then = params;
+      params = {};
+    }
+    this.start(params).then(then).catch((err) => this.onError.emit(unknownToError(err)));
+  }
+  downloadToFile(filename, location, params) {
+    return downloadToFile(this, filename, location, params);
+  }
+  downloadAsNodeStream(location, params) {
+    return downloadAsNodeStream(this, location, params);
+  }
+}
+export {
+  BaseTelegramClient,
+  TelegramClient
+};