@mtcute/node 0.18.0-rc.5 → 0.18.0

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/index.d.cts

@@ -0,0 +1,9 @@
+export * from './client.js';
+export * from './sqlite/index.js';
+export * from './utils/platform.js';
+export * from './utils/proxies.js';
+export * from './utils/tcp.js';
+export * from './worker.js';
+export * from '@mtcute/core';
+export * from '@mtcute/html-parser';
+export * from '@mtcute/markdown-parser';

package/methods/download-file.d.cts

@@ -0,0 +1,9 @@
+import { FileDownloadLocation, FileDownloadParameters, ITelegramClient } from '@mtcute/core';
+/**
+ * Download a remote file to a local file (only for NodeJS).
+ * Promise will resolve once the download is complete.
+ *
+ * @param filename  Local file name to which the remote file will be downloaded
+ * @param params  File download parameters
+ */
+export declare function downloadToFile(client: ITelegramClient, filename: string, location: FileDownloadLocation, params?: FileDownloadParameters): Promise<void>;

package/methods/download-node-stream.d.cts

@@ -0,0 +1,8 @@
+import { FileDownloadLocation, FileDownloadParameters, ITelegramClient } from '@mtcute/core';
+import { Readable } from 'node:stream';
+/**
+ * Download a remote file as a Node.js Readable stream.
+ *
+ * @param params  File download parameters
+ */
+export declare function downloadAsNodeStream(client: ITelegramClient, location: FileDownloadLocation, params?: FileDownloadParameters): Readable;

package/methods.d.cts

@@ -0,0 +1,3 @@
+export { downloadToFile } from './methods/download-file.js';
+export { downloadAsNodeStream } from './methods/download-node-stream.js';
+export * from '@mtcute/core/methods.js';

package/package.json

@@ -1,23 +1,17 @@
 {
     "name": "@mtcute/node",
     "type": "module",
-    "version": "0.18.0-rc.5",
+    "version": "0.18.0",
     "description": "Meta-package for Node.js",
     "license": "MIT",
-    "homepage": "https://mtcute.dev",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/mtcute/mtcute.git"
-    },
-    "scripts": {},
     "dependencies": {
-        "@mtcute/core": "0.18.0-rc.5",
-        "@mtcute/html-parser": "0.18.0-rc.5",
-        "@mtcute/markdown-parser": "0.18.0-rc.5",
-        "@mtcute/wasm": "0.18.0-rc.5",
-        "@fuman/utils": "0.0.3",
-        "@fuman/net": "0.0.3",
-        "@fuman/node": "0.0.3",
+        "@mtcute/core": "^0.18.0",
+        "@mtcute/html-parser": "^0.18.0",
+        "@mtcute/markdown-parser": "^0.18.0",
+        "@mtcute/wasm": "^0.18.0",
+        "@fuman/utils": "0.0.4",
+        "@fuman/net": "0.0.4",
+        "@fuman/node": "0.0.4",
         "better-sqlite3": "11.3.0"
     },
     "exports": {
@@ -53,5 +47,11 @@
         }
     },
     "author": "alina sireneva <alina@tei.su>",
-    "sideEffects": false
+    "sideEffects": false,
+    "homepage": "https://mtcute.dev",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/mtcute/mtcute.git"
+    },
+    "scripts": {}
 }

package/sqlite/driver.d.cts

@@ -0,0 +1,25 @@
+import { ISqliteDatabase, BaseSqliteStorageDriver } from '@mtcute/core';
+import { Options } from 'better-sqlite3';
+export interface SqliteStorageDriverOptions {
+    /**
+     * By default, WAL mode is enabled, which
+     * significantly improves performance.
+     * [Learn more](https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/performance.md)
+     *
+     * However, you might encounter some issues,
+     * and if you do, you can disable WAL by passing `true`
+     *
+     * @default  false
+     */
+    disableWal?: boolean;
+    /**
+     * Additional options to pass to `better-sqlite3`
+     */
+    options?: Options;
+}
+export declare class SqliteStorageDriver extends BaseSqliteStorageDriver {
+    readonly filename: string;
+    readonly params?: SqliteStorageDriverOptions | undefined;
+    constructor(filename?: string, params?: SqliteStorageDriverOptions | undefined);
+    _createDatabase(): ISqliteDatabase;
+}

package/sqlite/index.d.cts

@@ -0,0 +1,8 @@
+import { SqliteStorageDriverOptions } from './driver.js';
+import { BaseSqliteStorage } from '@mtcute/core';
+export { SqliteStorageDriver } from './driver.js';
+export declare class SqliteStorage extends BaseSqliteStorage {
+    readonly filename: string;
+    readonly params?: SqliteStorageDriverOptions | undefined;
+    constructor(filename?: string, params?: SqliteStorageDriverOptions | undefined);
+}

package/sqlite/sqlite.test.d.cts

@@ -0,0 +1 @@
+export {};

package/utils/crypto.d.cts

@@ -0,0 +1,15 @@
+import { IAesCtr, ICryptoProvider, IEncryptionScheme, BaseCryptoProvider } from '@mtcute/core/utils.js';
+export declare abstract class BaseNodeCryptoProvider extends BaseCryptoProvider {
+    createAesCtr(key: Uint8Array, iv: Uint8Array): IAesCtr;
+    pbkdf2(password: Uint8Array, salt: Uint8Array, iterations: number, keylen?: number, algo?: string): Promise<Uint8Array>;
+    sha1(data: Uint8Array): Uint8Array;
+    sha256(data: Uint8Array): Uint8Array;
+    hmacSha256(data: Uint8Array, key: Uint8Array): Uint8Array;
+    gzip(data: Uint8Array, maxSize: number): Uint8Array | null;
+    gunzip(data: Uint8Array): Uint8Array;
+    randomFill(buf: Uint8Array): void;
+}
+export declare class NodeCryptoProvider extends BaseNodeCryptoProvider implements ICryptoProvider {
+    initialize(): Promise<void>;
+    createAesIge(key: Uint8Array, iv: Uint8Array): IEncryptionScheme;
+}

package/utils/crypto.test.d.cts

@@ -0,0 +1 @@
+export {};

package/utils/exit-hook.d.cts

@@ -0,0 +1 @@
+export declare function beforeExit(fn: () => void): () => void;

package/utils/logging.d.cts

@@ -0,0 +1,2 @@
+/** @internal */
+export declare const defaultLoggingHandler: (color: number, level: number, tag: string, fmt: string, args: unknown[]) => void;

package/utils/normalize-file.d.cts

@@ -0,0 +1,6 @@
+import { UploadFileLike } from '@mtcute/core';
+export declare function normalizeFile(file: UploadFileLike): Promise<{
+    file: UploadFileLike;
+    fileName?: string | undefined;
+    fileSize?: number;
+} | null>;

package/utils/platform.d.cts

@@ -0,0 +1,11 @@
+import { ICorePlatform } from '@mtcute/core';
+import { normalizeFile } from '../utils/normalize-file.js';
+import { beforeExit } from './exit-hook.js';
+import { defaultLoggingHandler } from './logging.js';
+export declare class NodePlatform implements ICorePlatform {
+    log: typeof defaultLoggingHandler;
+    beforeExit: typeof beforeExit;
+    normalizeFile: typeof normalizeFile;
+    getDeviceModel(): string;
+    getDefaultLogLevel(): number | null;
+}

package/utils/proxies.d.cts

@@ -0,0 +1,34 @@
+import { HttpProxySettings as FumanHttpProxySettings, ITcpConnection, SocksProxySettings, TcpEndpoint } from '@fuman/net';
+import { BasicDcOption } from '@mtcute/core/utils.js';
+import { SecureContextOptions } from 'node:tls';
+import { BaseMtProxyTransport, IntermediatePacketCodec, ITelegramConnection, TelegramTransport } from '@mtcute/core';
+export type { SocksProxySettings } from '@fuman/net';
+export { HttpProxyConnectionError, SocksProxyConnectionError } from '@fuman/net';
+export type { MtProxySettings } from '@mtcute/core';
+export interface HttpProxySettings extends FumanHttpProxySettings {
+    /**
+     * Whether this is a HTTPS proxy (by default it is regular HTTP).
+     */
+    tls?: boolean;
+    /**
+     * Additional TLS options, used if `tls = true`.
+     * Can contain stuff like custom certificate, host,
+     * or whatever.
+     */
+    tlsOptions?: SecureContextOptions;
+}
+export declare class HttpProxyTcpTransport implements TelegramTransport {
+    readonly proxy: HttpProxySettings;
+    constructor(proxy: HttpProxySettings);
+    connect(dc: BasicDcOption): Promise<ITelegramConnection>;
+    packetCodec(): IntermediatePacketCodec;
+}
+export declare class SocksProxyTcpTransport implements TelegramTransport {
+    readonly proxy: SocksProxySettings;
+    constructor(proxy: SocksProxySettings);
+    connect(dc: BasicDcOption): Promise<ITelegramConnection>;
+    packetCodec(): IntermediatePacketCodec;
+}
+export declare class MtProxyTcpTransport extends BaseMtProxyTransport {
+    _connectTcp(endpoint: TcpEndpoint): Promise<ITcpConnection>;
+}

package/utils/tcp.d.cts

@@ -0,0 +1,7 @@
+import { ITcpConnection } from '@fuman/net';
+import { TelegramTransport, IntermediatePacketCodec } from '@mtcute/core';
+import { BasicDcOption } from '@mtcute/core/utils.js';
+export declare class TcpTransport implements TelegramTransport {
+    connect(dc: BasicDcOption): Promise<ITcpConnection>;
+    packetCodec(): IntermediatePacketCodec;
+}

package/utils.d.cts

@@ -0,0 +1,2 @@
+export * from './utils/crypto.js';
+export * from '@mtcute/core/utils.js';

package/worker.d.cts

@@ -0,0 +1,12 @@
+import { ClientMessageHandler, RespondFn, SendFn, SomeWorker, TelegramWorkerOptions, WorkerCustomMethods, WorkerMessageHandler, TelegramWorker as TelegramWorkerBase, TelegramWorkerPort as TelegramWorkerPortBase } from '@mtcute/core/worker.js';
+export type { TelegramWorkerOptions, WorkerCustomMethods };
+export interface TelegramWorkerPortOptions {
+    worker: SomeWorker;
+}
+export declare class TelegramWorker<T extends WorkerCustomMethods> extends TelegramWorkerBase<T> {
+    registerWorker(handler: WorkerMessageHandler): RespondFn;
+}
+export declare class TelegramWorkerPort<T extends WorkerCustomMethods> extends TelegramWorkerPortBase<T> {
+    constructor(options: TelegramWorkerPortOptions);
+    connectToWorker(worker: SomeWorker, handler: ClientMessageHandler): [SendFn, () => void];
+}