@mtcute/web 0.18.0-rc.5 → 0.18.0

package/client.d.cts

@@ -0,0 +1,23 @@
+import { ITelegramStorageProvider, PartialOnly } from '@mtcute/core';
+import { BaseTelegramClientOptions as BaseTelegramClientOptionsBase, TelegramClientOptions, BaseTelegramClient as BaseTelegramClientBase, TelegramClient as TelegramClientBase } from '@mtcute/core/client.js';
+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 IndexedDB database.
+     *
+     * @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);
+}

package/common-internals-web/logging.d.cts

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

package/crypto.d.cts

@@ -0,0 +1,21 @@
+import { IAesCtr, ICryptoProvider, IEncryptionScheme, BaseCryptoProvider } from '@mtcute/core/utils.js';
+import { WasmInitInput } from './wasm.js';
+export interface WebCryptoProviderOptions {
+    crypto?: Crypto;
+    wasmInput?: WasmInitInput;
+}
+export declare class WebCryptoProvider extends BaseCryptoProvider implements ICryptoProvider {
+    readonly crypto: Crypto;
+    private _wasmInput?;
+    sha1(data: Uint8Array): Uint8Array;
+    sha256(data: Uint8Array): Uint8Array;
+    createAesCtr(key: Uint8Array, iv: Uint8Array): IAesCtr;
+    createAesIge(key: Uint8Array, iv: Uint8Array): IEncryptionScheme;
+    gzip(data: Uint8Array, maxSize: number): Uint8Array | null;
+    gunzip(data: Uint8Array): Uint8Array;
+    constructor(params?: WebCryptoProviderOptions);
+    initialize(): Promise<void>;
+    pbkdf2(password: Uint8Array, salt: Uint8Array, iterations: number, keylen?: number | undefined, algo?: string | undefined): Promise<Uint8Array>;
+    hmacSha256(data: Uint8Array, key: Uint8Array): Promise<Uint8Array>;
+    randomFill(buf: Uint8Array): void;
+}

package/exit-hook.d.cts

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

package/idb/driver.d.cts

@@ -0,0 +1,18 @@
+import { BaseStorageDriver } from '@mtcute/core';
+export type PostMigrationFunction = (db: IDBDatabase) => Promise<void>;
+type MigrationFunction = (db: IDBDatabase) => void | PostMigrationFunction;
+export declare class IdbStorageDriver extends BaseStorageDriver {
+    readonly _dbName: string;
+    db: IDBDatabase;
+    constructor(_dbName: string);
+    private _pendingWrites;
+    private _pendingWritesOses;
+    private _migrations;
+    private _maxVersion;
+    registerMigration(repo: string, version: number, migration: MigrationFunction): void;
+    writeLater(os: string, obj: unknown): void;
+    _load(): Promise<void>;
+    _save(): Promise<void>;
+    _destroy(): void;
+}
+export {};

package/idb/idb.test.d.cts

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

package/idb/index.d.cts

@@ -0,0 +1,22 @@
+import { IMtStorageProvider } from '@mtcute/core';
+import { IdbStorageDriver } from './driver.js';
+import { IdbAuthKeysRepository } from './repository/auth-keys.js';
+import { IdbKvRepository } from './repository/kv.js';
+import { IdbPeersRepository } from './repository/peers.js';
+import { IdbRefMsgRepository } from './repository/ref-messages.js';
+export { IdbStorageDriver } from './driver.js';
+/**
+ * mtcute storage that uses IndexedDB as a backend.
+ *
+ * This storage is the default one for browsers, and is generally
+ * recommended over local storage based one.
+ */
+export declare class IdbStorage implements IMtStorageProvider {
+    readonly dbName: string;
+    readonly driver: IdbStorageDriver;
+    readonly kv: IdbKvRepository;
+    readonly authKeys: IdbAuthKeysRepository;
+    readonly peers: IdbPeersRepository;
+    readonly refMessages: IdbRefMsgRepository;
+    constructor(dbName: string);
+}

package/idb/repository/auth-keys.d.cts

@@ -0,0 +1,14 @@
+import { IAuthKeysRepository } from '@mtcute/core';
+import { IdbStorageDriver } from '../driver.js';
+export declare class IdbAuthKeysRepository implements IAuthKeysRepository {
+    readonly _driver: IdbStorageDriver;
+    constructor(_driver: IdbStorageDriver);
+    private os;
+    set(dc: number, key: Uint8Array | null): Promise<void>;
+    get(dc: number): Promise<Uint8Array | null>;
+    private osTemp;
+    setTemp(dc: number, idx: number, key: Uint8Array | null, expires: number): Promise<void>;
+    getTemp(dc: number, idx: number, now: number): Promise<Uint8Array | null>;
+    deleteByDc(dc: number): Promise<void>;
+    deleteAll(): Promise<void>;
+}

package/idb/repository/kv.d.cts

@@ -0,0 +1,11 @@
+import { IKeyValueRepository } from '@mtcute/core';
+import { IdbStorageDriver } from '../driver.js';
+export declare class IdbKvRepository implements IKeyValueRepository {
+    readonly _driver: IdbStorageDriver;
+    constructor(_driver: IdbStorageDriver);
+    set(key: string, value: Uint8Array): void;
+    private os;
+    get(key: string): Promise<Uint8Array | null>;
+    delete(key: string): Promise<void>;
+    deleteAll(): Promise<void>;
+}

package/idb/repository/peers.d.cts

@@ -0,0 +1,12 @@
+import { IPeersRepository } from '@mtcute/core';
+import { IdbStorageDriver } from '../driver.js';
+export declare class IdbPeersRepository implements IPeersRepository {
+    readonly _driver: IdbStorageDriver;
+    constructor(_driver: IdbStorageDriver);
+    store(peer: IPeersRepository.PeerInfo): void;
+    private os;
+    getById(id: number, allowMin: boolean): Promise<IPeersRepository.PeerInfo | null>;
+    getByUsername(username: string): Promise<IPeersRepository.PeerInfo | null>;
+    getByPhone(phone: string): Promise<IPeersRepository.PeerInfo | null>;
+    deleteAll(): Promise<void>;
+}

package/idb/repository/ref-messages.d.cts

@@ -0,0 +1,12 @@
+import { IReferenceMessagesRepository } from '@mtcute/core';
+import { IdbStorageDriver } from '../driver.js';
+export declare class IdbRefMsgRepository implements IReferenceMessagesRepository {
+    readonly _driver: IdbStorageDriver;
+    constructor(_driver: IdbStorageDriver);
+    private os;
+    store(peerId: number, chatId: number, msgId: number): Promise<void>;
+    getByPeer(peerId: number): Promise<[number, number] | null>;
+    delete(chatId: number, msgIds: number[]): Promise<void>;
+    deleteByPeer(peerId: number): Promise<void>;
+    deleteAll(): Promise<void>;
+}

package/idb/utils.d.cts

@@ -0,0 +1,2 @@
+export declare function txToPromise(tx: IDBTransaction): Promise<void>;
+export declare function reqToPromise<T>(req: IDBRequest<T>): Promise<T>;

package/index.d.cts

@@ -0,0 +1,7 @@
+export * from './client.js';
+export * from './crypto.js';
+export * from './idb/index.js';
+export * from './platform.js';
+export * from './websocket.js';
+export * from './worker.js';
+export * from '@mtcute/core';

package/methods.d.cts

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

package/package.json

@@ -1,19 +1,13 @@
 {
     "name": "@mtcute/web",
     "type": "module",
-    "version": "0.18.0-rc.5",
+    "version": "0.18.0",
     "description": "Meta-package for the web platform",
     "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/wasm": "0.18.0-rc.5",
-        "@fuman/net": "0.0.3",
+        "@mtcute/core": "^0.18.0",
+        "@mtcute/wasm": "^0.18.0",
+        "@fuman/net": "0.0.4",
         "events": "3.2.0"
     },
     "exports": {
@@ -58,5 +52,11 @@
                 "WebWorker"
             ]
         }
-    }
+    },
+    "homepage": "https://mtcute.dev",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/mtcute/mtcute.git"
+    },
+    "scripts": {}
 }

package/platform.d.cts

@@ -0,0 +1,11 @@
+import { ICorePlatform } from '@mtcute/core';
+import { defaultLoggingHandler } from './common-internals-web/logging.js';
+import { beforeExit } from './exit-hook.js';
+export declare class WebPlatform implements ICorePlatform {
+    log: typeof defaultLoggingHandler;
+    beforeExit: typeof beforeExit;
+    getDeviceModel(): string;
+    getDefaultLogLevel(): number | null;
+    onNetworkChanged(fn: (connected: boolean) => void): () => void;
+    isOnline(): boolean;
+}

package/utils.d.cts

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

package/wasm.d.cts

@@ -0,0 +1,2 @@
+export type WasmInitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+export declare function loadWasmBinary(input?: WasmInitInput): Promise<WebAssembly.Instance>;

package/websocket.d.cts

@@ -0,0 +1,18 @@
+import { WebSocketConstructor } from '@fuman/net';
+import { IPacketCodec, ITelegramConnection, TelegramTransport } from '@mtcute/core';
+import { BasicDcOption } from './utils.js';
+export declare class WebSocketTransport implements TelegramTransport {
+    private _baseDomain;
+    private _subdomains;
+    private _WebSocket;
+    constructor({ ws, baseDomain, subdomains, }?: {
+        /** Custom implementation of WebSocket (e.g. https://npm.im/ws) */
+        ws?: WebSocketConstructor;
+        /** Base WebSocket domain */
+        baseDomain?: string;
+        /** Map of sub-domains (key is DC ID, value is string) */
+        subdomains?: Record<string, string>;
+    });
+    connect(dc: BasicDcOption): Promise<ITelegramConnection>;
+    packetCodec(): IPacketCodec;
+}

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];
+}