@emaxe/tuigram 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,108 @@
+# Changelog
+
+[English](./CHANGELOG.md) · [Русский](./CHANGELOG.ru.md)
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+### Planned
+
+- English localization of the TUI and CLI interface strings.
+
+## [1.0.1] — 2026-08-29
+
+Documentation and packaging only — no runtime changes.
+
+### Added
+
+- English `README.md` and Russian `README.ru.md` with a language switcher, a table of
+  contents and a contributing section.
+- `CHANGELOG.md` and `CHANGELOG.ru.md` in Keep a Changelog format.
+- A "Screenshots" section: ASCII captures of the main window, chat search, the help,
+  action, send-file, file-browser and chat-info modals, plus sample CLI output.
+- `AGENTS.md` with `.agents/rules/` — codebase rules for humans and AI agents
+  (architecture, code style, neo-blessed UI, tests, secrets, docs and release),
+  with thin pointers for Copilot, Cursor and Claude Code.
+
+### Changed
+
+- The npm package now ships `README.ru.md`, `CHANGELOG.md` and `CHANGELOG.ru.md`;
+  `scripts/check-package.js` treats them as required files.
+
+## [1.0.0] — 2026-08-29
+
+First public release.
+
+### Added
+
+**TUI**
+
+- Two-pane adaptive terminal interface: dialog list on the left, message history
+  and input box on the right.
+- Keyboard and mouse control — clicks and wheel scrolling.
+- Dialog categories (`1`–`6`): All, Direct messages, Groups, Channels, Bots, Unread.
+- Instant chat search and filtering by title and `@username` (`/`).
+- Live typing indicator for the active chat.
+- Rendering of Telegram entities with color: bold, italic, monospace code, code blocks,
+  URLs, mentions, hashtags and spoilers.
+- Media attachment indicators: photo, video, document, voice, sticker, poll, geo,
+  contact, venue, dice and web page previews.
+- Message reactions (👍, 🔥, ❤️) via the action menu.
+- Infinite upward pagination of message history (`PageUp` / `Ctrl+U`).
+- Reply (`Ctrl+R`) and edit (`Ctrl+E`) modes with a context banner above the input box.
+- Modal windows: help (`F1` / `?`), chat info (`Ctrl+P`), message actions (`Ctrl+A`),
+  send file (`Ctrl+O`), file browser (`Ctrl+F`) and confirmation dialogs.
+- Slash commands in the input box: `/help`, `/info`, `/sendfile`, `/clear`, `/logout`.
+- Downloading incoming media through the message action menu.
+- Three themes selectable via `TUI_THEME`: `default` (dark), `nord`, `light`.
+  All colors are hex values that reduce to xterm-256 indices ≥ 16, so a terminal's
+  own palette cannot repaint them.
+
+**CLI**
+
+- `tuigram init` — interactive and non-interactive (`--api-id`, `--api-hash`)
+  storage of Telegram API credentials.
+- `tuigram paths` — prints the configuration and data paths plus the current state.
+- `tuigram login` — login wizard with 2FA support.
+- `tuigram dialogs [--limit N]` — list of dialogs.
+- `tuigram history <peer> [--limit N]` — chat history, where `<peer>` is a `@username`,
+  an ID, or `me` for Saved Messages.
+- `tuigram send <peer> <text>` — send a text message.
+- `tuigram sendfile <peer> <path...> [--caption ...] [--as-file]` — send files;
+  up to 10 paths are sent as a single album.
+- `tuigram listen` — live stream of MTProto updates.
+- `./run.sh` — interactive launcher menu for development.
+
+**Configuration and storage**
+
+- Credentials and session are stored in OS user directories, not inside the package,
+  so a global install stays read-only and survives `npm update`.
+- Path overrides via `TUIGRAM_CONFIG_DIR` / `TUIGRAM_DATA_DIR`, with `XDG_CONFIG_HOME`
+  and `XDG_DATA_HOME` honored.
+- Settings precedence: process environment → project `.env` (repository clone only)
+  → the user `.env`.
+- Automatic migration of a session from the legacy `<project>/data/session.txt` location.
+
+**Security**
+
+- The session file and the settings file are written with `0600` permissions.
+- `scripts/check-package.js` — a pre-publish check that fails if `.env`, `data/`,
+  a session string, logs or tests would end up in the npm tarball; it also verifies
+  the shebang and the executable bit on `bin/tuigram.js`.
+- `/logout` revokes the authorization key on the server and deletes the local session file.
+
+**Tests**
+
+- Unit tests (`npm test`) covering time formatting, peer parsing and entity types,
+  Telegram-entity rendering, slash-command argument parsing, `.env` writing and
+  credential validation, non-interactive login guards, and package configuration.
+- A WCAG contrast test (3:1 threshold) applied to every theme **after** conversion
+  to xterm-256 — the colors are checked exactly as the user sees them.
+
+[Unreleased]: https://github.com/emaxe/tuigram/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/emaxe/tuigram/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/emaxe/tuigram/releases/tag/v1.0.0

package/CHANGELOG.ru.md

@@ -0,0 +1,110 @@
+# История изменений
+
+[English](./CHANGELOG.md) · [Русский](./CHANGELOG.ru.md)
+
+Все заметные изменения проекта фиксируются в этом файле.
+
+Формат основан на [Keep a Changelog](https://keepachangelog.com/ru/1.1.0/),
+версионирование — по [Semantic Versioning](https://semver.org/lang/ru/).
+
+## [Unreleased]
+
+### Планируется
+
+- Английская локализация строк интерфейса TUI и CLI.
+
+## [1.0.1] — 2026-08-29
+
+Только документация и упаковка — поведение клиента не менялось.
+
+### Добавлено
+
+- Английский `README.md` и русский `README.ru.md` с переключателем языков,
+  оглавлением и разделом об участии в разработке.
+- `CHANGELOG.md` и `CHANGELOG.ru.md` в формате Keep a Changelog.
+- Раздел «Скриншоты»: текстовые снимки главного окна, поиска чатов, окон справки,
+  действий, отправки файла, обзора файлов и сведений о чате, а также примеры вывода CLI.
+- `AGENTS.md` вместе с `.agents/rules/` — правила кодовой базы для людей и ИИ-агентов
+  (архитектура, стиль кода, интерфейс на neo-blessed, тесты, секреты, документация
+  и релиз) и тонкие указатели для Copilot, Cursor и Claude Code.
+
+### Изменено
+
+- В npm-пакет теперь попадают `README.ru.md`, `CHANGELOG.md` и `CHANGELOG.ru.md`;
+  `scripts/check-package.js` считает их обязательными.
+
+## [1.0.0] — 2026-08-29
+
+Первый публичный релиз.
+
+### Добавлено
+
+**TUI**
+
+- Двухпанельный адаптивный интерфейс терминала: список диалогов слева, история
+  сообщений и поле ввода справа.
+- Управление клавиатурой и мышью — клики и прокрутка колесом.
+- Категории диалогов (`1`–`6`): Все, Личные, Группы, Каналы, Боты, Непрочитанные.
+- Мгновенный поиск и фильтрация чатов по названию и `@username` (`/`).
+- Индикатор набора текста в активном чате в реальном времени.
+- Цветовое отображение Telegram Entities: жирный, курсив, моноширинный код, блоки
+  кода, ссылки, упоминания, хештеги и спойлеры.
+- Индикаторы медиа-вложений: фото, видео, документы, голосовые, стикеры, опросы,
+  геопозиции, контакты, места, кубик и превью веб-страниц.
+- Реакции на сообщения (👍, 🔥, ❤️) через меню действий.
+- Бесконечная пагинация истории сообщений вверх (`PageUp` / `Ctrl+U`).
+- Режимы ответа (`Ctrl+R`) и редактирования (`Ctrl+E`) с контекстной плашкой над
+  полем ввода.
+- Модальные окна: справка (`F1` / `?`), сведения о чате (`Ctrl+P`), действия с
+  сообщением (`Ctrl+A`), отправка файла (`Ctrl+O`), обзор файлов (`Ctrl+F`) и
+  диалоги подтверждения.
+- Слэш-команды в поле ввода: `/help`, `/info`, `/sendfile`, `/clear`, `/logout`.
+- Скачивание входящих медиа через меню действий с сообщением.
+- Три темы, выбираемые через `TUI_THEME`: `default` (тёмная), `nord`, `light`.
+  Все цвета заданы hex-значениями, которые сводятся к индексам xterm-256 ≥ 16 —
+  собственная палитра терминала не может их перекрасить.
+
+**CLI**
+
+- `tuigram init` — интерактивное и неинтерактивное (`--api-id`, `--api-hash`)
+  сохранение ключей Telegram API.
+- `tuigram paths` — вывод путей конфигурации и данных вместе с текущим состоянием.
+- `tuigram login` — визард авторизации с поддержкой 2FA.
+- `tuigram dialogs [--limit N]` — список диалогов.
+- `tuigram history <peer> [--limit N]` — история чата, где `<peer>` — это `@username`,
+  ID или `me` для «Избранного».
+- `tuigram send <peer> <текст>` — отправка текстового сообщения.
+- `tuigram sendfile <peer> <путь...> [--caption ...] [--as-file]` — отправка файлов;
+  до 10 путей уходят одним альбомом.
+- `tuigram listen` — живой стрим обновлений MTProto.
+- `./run.sh` — интерактивное меню-диспетчер для разработки.
+
+**Конфигурация и хранение**
+
+- Ключи и сессия хранятся в пользовательских директориях ОС, а не внутри пакета,
+  поэтому глобальная установка остаётся read-only и переживает `npm update`.
+- Переопределение путей через `TUIGRAM_CONFIG_DIR` / `TUIGRAM_DATA_DIR`, с учётом
+  `XDG_CONFIG_HOME` и `XDG_DATA_HOME`.
+- Приоритет настроек: окружение процесса → `.env` проекта (только клон репозитория)
+  → пользовательский `.env`.
+- Автоматический перенос сессии из устаревшего расположения `<проект>/data/session.txt`.
+
+**Безопасность**
+
+- Файл сессии и файл настроек сохраняются с правами `0600`.
+- `scripts/check-package.js` — предпубликационная проверка, которая падает, если в
+  npm-архив попадают `.env`, `data/`, строка сессии, логи или тесты; она же проверяет
+  shebang и флаг исполняемости у `bin/tuigram.js`.
+- `/logout` отзывает ключ авторизации на сервере и удаляет локальный файл сессии.
+
+**Тесты**
+
+- Юнит-тесты (`npm test`) на форматирование времени, разбор пиров и типов сущностей,
+  рендеринг Telegram Entities, разбор аргументов слэш-команд, запись `.env` и валидацию
+  ключей, защиту от неинтерактивного логина и конфигурацию пакета.
+- Тест контраста по WCAG (порог 3:1) для каждой темы — **после** конверсии в xterm-256,
+  то есть ровно в том виде, в каком цвет увидит пользователь.
+
+[Unreleased]: https://github.com/emaxe/tuigram/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/emaxe/tuigram/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/emaxe/tuigram/releases/tag/v1.0.0