@apiteam/twa-bridge 8.0.13 → 9.6.0

package/README.md

@@ -1,32 +1,73 @@
-## Описание
-
-Библиотека для работы с Telegram WebApp API, предоставляющая удобный интерфейс для взаимодействия с функциями Telegram Mini Apps. Реализована на TypeScript с поддержкой строгой типизации.
-
-## Полная документация
-[Документация API](https://docs.apiteam.ru)
-
-## Основные возможности
-
-- Управление внешним видом WebApp (цвета, кнопки)
-- Работа с платежами и инвойсами
-- Взаимодействие с QR-сканером
-- Управление буфером обмена
-- Обработка системных событий Telegram
-
-## Установка
-
-```bash
-npm install @apiteam/twa-bridge
-```
-
-# Поддержка
-
-Если у вас возникли вопросы или проблемы:
-
-## Способы связи
-
-- [Создать issue в GitHub](https://github.com/apiteamru/twa-bridge/issues)  
-  _(Для багрепортов и запросов функций)_
-
-- Написать в Telegram: [@apiteam_help](https://t.me/apiteam_help)  
-  _(Быстрая помощь в реальном времени)_
+# @apiteam/twa-bridge
+
+Минималистичный TypeScript-мост для [Telegram Mini Apps](https://core.telegram.org/bots/webapps). Он отправляет методы в клиент Telegram, проверяет поддержку API и предоставляет типизированные события в одном интерфейсе.
+
+Полная справка по методам находится в [документации](https://docs.apiteam.ru) и в каталоге [`docs`](docs/).
+
+## Установка
+
+```bash
+npm install @apiteam/twa-bridge
+```
+
+## Быстрый старт
+
+```ts
+import {
+	bridgeReady,
+	bridgeShareToStory,
+	listener,
+} from '@apiteam/twa-bridge'
+
+bridgeReady()
+
+listener.on('theme_changed', ({ theme_params }) => {
+	console.log(theme_params.bg_color)
+})
+
+bridgeShareToStory({
+	media_url: 'https://example.com/photo.jpg',
+	text: 'Моя история',
+})
+```
+
+Для каждого метода есть `support…`-функция, например `supportShareToStory()`. При неподдерживаемой версии Telegram bridge-методы возвращают `{ status: 'not_supported' }`.
+
+## События
+
+`listener` использует `EventEmitter` из `@minsize/utils` и экспортирует `on`, `once` и `off`. Имя события и его payload выводятся из типа `EventsData`.
+
+```ts
+import { listener } from '@apiteam/twa-bridge'
+
+const onLocation = data => {
+	if (data.available) {
+		console.log(data.latitude, data.longitude)
+	}
+}
+
+listener.on('location_requested', onLocation)
+listener.off('location_requested', onLocation)
+```
+
+При инициализации bridge сохраняет существующий объект `window.Telegram`, поэтому `window.Telegram.WebApp` из официального SDK остаётся доступен. Bridge назначает обработчик только в `window.Telegram.WebView.receiveEvent` — не подключайте второй SDK, который записывает в этот же обработчик, без явного объединения обработчиков.
+
+Подробнее: [Listener и события](docs/functions/listener.md).
+
+## Методы
+
+Высокоуровневые функции имеют префикс `bridge`: например, `bridgeRequestLocation`, `bridgeStartAccelerometer`, `bridgeDeviceStorage` и `bridgeRequestChat`. Для прямого вызова по имени Telegram-метода используйте `bridgeSend` и константы `Method`:
+
+```ts
+import { bridgeSend, Method } from '@apiteam/twa-bridge'
+
+await bridgeSend(Method.RequestLocation)
+```
+
+`bridgeSend` выбирает соответствующую bridge-функцию, если она есть, поэтому сохраняются проверка версии и обработка результата. Низкоуровневый `sender(eventType, eventData)` отправляет событие в Telegram без этих обёрток.
+
+Новые API Telegram 7.10–9.6, включая геолокацию, датчики, device/secure storage, скрытие клавиатуры и запрос чата, описаны в разделе [Новые платформенные API](docs/functions/platformApis.md).
+
+## Поддержка
+
+Если есть ошибка или нужен метод, [создайте issue](https://github.com/apiteamru/twa-bridge/issues).

package/package.json

@@ -1,23 +1,26 @@
-{
-  "name": "@apiteam/twa-bridge",
-  "version": "8.0.13",
-  "description": "Telegram bridge",
-  "license": "MIT",
-  "types": "index.ts",
-  "author": {
-    "name": "Egor Kytyukov",
-    "url": "https://vk.com/xuserz"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/APITEAMRU/twa-bridge.git"
-  },
-  "contributors": [],
-  "keywords": [
-    "twa-sdk",
-    "telegram sdk",
-    "telegram",
-    "tg",
-    "telegram module"
-  ]
+{
+  "name": "@apiteam/twa-bridge",
+  "version": "9.6.0",
+  "description": "Telegram bridge",
+  "license": "MIT",
+  "types": "index.ts",
+  "author": {
+    "name": "Egor Kytyukov",
+    "url": "https://vk.com/xuserz"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/APITEAMRU/twa-bridge.git"
+  },
+  "contributors": [],
+  "keywords": [
+    "twa-sdk",
+    "telegram sdk",
+    "telegram",
+    "tg",
+    "telegram module"
+  ],
+  "dependencies": {
+    "@minsize/utils": "^1.0.0"
+  }
 }