@bruch/max-client 0.1.0 → 0.1.2

package/README.md

@@ -1,68 +1,69 @@
-# tsmax
+# MAX Client
 
-Неофициальный Bun/TypeScript-клиент внутреннего API мессенджера MAX. Это TypeScript-форк
-[PyMax](https://github.com/skar404/pymax), ориентированный на вход от имени обычного пользователя,
-SMS- и QR-аутентификацию, сообщения, чаты, контакты и вложения.
+An unofficial Bun/TypeScript client for the internal MAX messenger API. It supports regular user
+accounts, SMS and QR authentication, messages, chats, contacts, attachments, and live events.
 
-> Это не официальный SDK MAX. Внутренний протокол может измениться без предупреждения. Используйте
-> проект только для собственных аккаунтов и сценариев, которые не нарушают правила сервиса и закон.
+> This is not an official MAX SDK. The internal protocol may change without notice. Use the project
+> only with your own accounts and for workflows that comply with the service rules and applicable
+> laws.
 
-## Требования
+## Requirements
 
-- Bun 1.3.0 или новее;
-- Node.js не нужен и не поддерживается как runtime;
-- Bun используется и как runtime, и как пакетный менеджер;
-- ESLint проверяет код, Prettier отвечает за форматирование.
+- Bun 1.3.0 or newer
+- Bun as both the runtime and package manager
+- ESLint for code quality and Prettier for formatting
 
-## Установка
+Node.js is not required and is not supported as a runtime.
+
+## Installation
 
 ```bash
-bun add tsmax
+bun add @bruch/max-client
 ```
 
-До публикации пакета можно подключить локальный checkout:
+Before the package is published, you can install a local checkout:
 
 ```bash
 bun add ../tsmax
 ```
 
-## SMS-вход
+## SMS authentication
 
 ```ts
-import { Client } from "tsmax";
+import { Client } from "@bruch/max-client";
 
 const client = new Client({
   phone: "+79990000000",
-  smsCodeProvider: (phone) => prompt(`Код из SMS для ${phone}:`) ?? "",
-  passwordProvider: (hint) => prompt(`Пароль 2FA${hint ? ` (${hint})` : ""}:`) ?? "",
+  smsCodeProvider: (phone) => prompt(`SMS code for ${phone}:`) ?? "",
+  passwordProvider: (hint) => prompt(`2FA password${hint ? ` (${hint})` : ""}:`) ?? "",
 });
 
 client.onStart(async (app) => {
-  console.log(`Вошли как ${app.me?.contact.id}`);
-  await app.sendMessage({ chatId: 123456789n, text: "Привет из **tsmax**" });
+  console.log(`Authenticated as ${app.me?.contact.id}`);
+  await app.sendMessage({ chatId: 123456789n, text: "Hello from **MAX Client**" });
 });
 
 await client.start();
 ```
 
-`start()` держит клиент подключённым до закрытия соединения. Для корректной остановки вызовите
-`await client.stop()`.
+`start()` keeps the client connected until the connection closes. Call `await client.stop()` for a
+graceful shutdown.
 
-## QR-вход
+## QR authentication
 
 ```ts
-import { WebClient } from "tsmax";
+import { WebClient } from "@bruch/max-client";
 
 const client = new WebClient({
-  qrHandler: (link) => console.log("Откройте QR-ссылку:", link),
+  qrHandler: (link) => console.log("Open this QR link:", link),
 });
 
 await client.start();
 ```
 
-Стандартный QR-handler выводит QR-код прямо в терминал.
+The default QR handler renders a QR code directly in the terminal.
 
-## События
+## Events
 
 ```ts
 client.onMessage(
@@ -72,22 +73,22 @@ client.onMessage(
   (message) => message.chatId !== null,
 );
 
-client.onMessageEdit((message) => console.log("Изменено:", message.text));
+client.onMessageEdit((message) => console.log("Edited:", message.text));
 client.onTyping((event) => console.log(event.userId, event.typing));
 client.onDisconnect((error, reconnect) => console.error(error.message, { reconnect }));
 ```
 
-Все идентификаторы пользователей, чатов и сообщений представлены как `bigint`. Передавайте литералы
-с суффиксом `n` и превращайте их в строки перед JSON-сериализацией.
+User, chat, and message identifiers are represented as `bigint`. Use the `n` suffix for literals and
+convert identifiers to strings before JSON serialization.
 
-## Вложения
+## Attachments
 
 ```ts
-import { File, Photo, Video } from "tsmax/files";
+import { File, Photo, Video } from "@bruch/max-client/files";
 
 await client.sendMessage({
   chatId: 123456789n,
-  text: "Файлы",
+  text: "Files",
   attachments: [
     new Photo({ path: "./photo.jpg" }),
     new Video({ path: "./clip.mp4" }),
@@ -96,13 +97,14 @@ await client.sendMessage({
 });
 ```
 
-Для видео и файлов клиент ждёт серверное событие о завершении обработки, как PyMax.
+For videos and files, the client waits for the server-side processing completion event before
+continuing.
 
-## Сессии PyMax
+## Sessions
 
-По умолчанию используется SQLite-файл `session.db`. Схема и миграции совместимы с PyMax 2.3.1:
-существующую базу можно открыть из обоих клиентов. Значения `sync_state` и токены сохраняются без
-потери 64-битных ID.
+Sessions use the SQLite file `session.db` by default. Legacy minimal schemas are migrated
+automatically, and `sync_state` values, tokens, and 64-bit identifiers are stored without precision
+loss.
 
 ```ts
 const client = new Client({
@@ -112,13 +114,13 @@ const client = new Client({
 });
 ```
 
-Не коммитьте базы сессий: они содержат токены авторизации.
+Never commit session databases. They contain authentication tokens.
 
-## Proxy и транспорт
+## Proxies and transports
 
-Мобильный `Client` использует TCP/TLS и поддерживает HTTP CONNECT, HTTPS CONNECT, SOCKS4/4a и
-SOCKS5. `WebClient` использует встроенный WebSocket Bun; его `proxy` поддерживает HTTP(S)-proxy в
-формате Bun.
+The mobile `Client` uses TCP/TLS and supports HTTP CONNECT, HTTPS CONNECT, SOCKS4/4a, and SOCKS5.
+`WebClient` uses Bun's built-in WebSocket implementation; its `proxy` option accepts an HTTP(S)
+proxy in Bun's format.
 
 ```ts
 const client = new Client({
@@ -127,42 +129,41 @@ const client = new Client({
 });
 ```
 
-## Разработка
+## Development
 
 ```bash
 bun install
 bun run check
 ```
 
-Основные команды: `lint`, `format:check`, `typecheck`, `test`, `build`, `pack:check`. Покрытие строк,
-функций и statements не должно опускаться ниже 90% для загруженных тестами модулей.
+The main commands are `lint`, `format:check`, `typecheck`, `test`, `build`, and `pack:check`. Line,
+function, and statement coverage must remain at or above 90% for modules loaded by the test suite.
 
-## Реальный smoke-test
+## Real account smoke test
 
-Файл `scripts/real-test.ts` проверяет настоящее TCP-подключение и SMS/2FA-вход. После авторизации он
-выводит имя пользователя, список активных подписок типа `CHANNEL` и остаётся подключённым. Каждый
-новый пост выводится с ID поста, ID и названием канала, текстом и типами вложений:
+`scripts/real-test.ts` verifies a real TCP connection and SMS/2FA authentication. After login, it
+prints the current user, lists active `CHANNEL` subscriptions, and stays connected. Every new post
+is printed with its post ID, channel ID and title, text, and attachment types:
 
 ```bash
 MAX_PHONE=+79990000000 bun run test:real
 ```
 
-Тест ничего не отправляет и не изменяет в аккаунте; остановите его через `Ctrl+C`. Дополнительные
-переменные: `MAX_PROXY`, `MAX_WORK_DIR` и `MAX_SESSION_NAME`. Сессия по умолчанию хранится в
-`.data/real-test.db`; не публикуйте этот файл и не передавайте его другим людям.
+The test does not send messages or modify the account. Stop it with `Ctrl+C`. Optional environment
+variables are `MAX_PROXY`, `MAX_WORK_DIR`, and `MAX_SESSION_NAME`. The default session is stored in
+`.data/real-test.db`; never publish this file or share it with anyone.
 
-## Отличия от Node.js-пакета
+## Bun-only runtime
 
-Выбор Bun-only даёт единый runtime и доступ к `bun:sqlite`, `Bun.connect`, `Bun.zstdDecompress`,
-`Bun.file` и встроенному WebSocket. Цена этого решения — пакет нельзя исполнять в Node.js, Deno,
-Cloudflare Workers и большинстве serverless-платформ без Bun; Node-специфичные тестовые инструменты и
-APM-интеграции также не гарантируются. Скомпилированный `dist` всё равно имеет target `bun`.
+Using Bun exclusively provides a single runtime and direct access to `bun:sqlite`, `Bun.connect`,
+`Bun.zstdDecompress`, `Bun.file`, and the built-in WebSocket implementation. The tradeoff is that the
+package cannot run in Node.js, Deno, Cloudflare Workers, or most serverless platforms without Bun.
+Node-specific test tooling and APM integrations are not guaranteed to work. The compiled `dist`
+output still targets Bun.
 
-## Статус совместимости
+## API conventions
 
-Базовая линия: PyMax 2.3.1, commit `8c40b71`. Детали зафиксированы в [UPSTREAM.md](./UPSTREAM.md).
-Публичный API сделан идиоматичным для TypeScript: `camelCase`, `bigint`, именованные методы событий и
-явные providers для интерактивной аутентификации.
+The public API follows TypeScript conventions: `camelCase`, `bigint` identifiers, named event
+methods, and explicit providers for interactive authentication.
 
-Лицензия: MIT. Проект содержит самостоятельную TypeScript-реализацию протокола и сохраняет
-атрибуцию исходному PyMax.
+Licensed under the MIT License. This project is unofficial and is not affiliated with MAX.

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "@bruch/max-client",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Unofficial Bun/TypeScript client for the Max messenger internal API",
   "type": "module",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sibstark/tsmax.git"
+  },
+  "homepage": "https://github.com/sibstark/tsmax#readme",
+  "bugs": {
+    "url": "https://github.com/sibstark/tsmax/issues"
+  },
   "engines": {
     "bun": ">=1.3.0"
   },
@@ -49,8 +57,7 @@
     "dist",
     "src",
     "README.md",
-    "LICENSE",
-    "UPSTREAM.md"
+    "LICENSE"
   ],
   "scripts": {
     "build": "bun run clean && bun build src/index.ts src/auth/index.ts src/files/index.ts src/protocol/index.ts src/session/index.ts src/telemetry/index.ts src/types/index.ts --outdir dist --target bun --format esm --packages external --sourcemap=external && tsc -p tsconfig.build.json",

package/UPSTREAM.md

@@ -1,10 +0,0 @@
-# Upstream
-
-`tsmax` is a TypeScript/Bun port of [MaxApiTeam/PyMax](https://github.com/MaxApiTeam/PyMax).
-
-- Compatibility baseline: PyMax 2.3.1
-- Git commit: `8c40b71`
-- Upstream license: MIT
-
-The local `PyMax/` checkout is used only as a development reference and is not included in the
-published package.