@maxhub/max-bot-api 0.2.1

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@maxhub/max-bot-api",
+  "version": "0.2.1",
+  "description": "Max Bot Framework",
+  "repository": "https://github.com/max-messenger/max-bot-api-client-ts",
+  "author": "Juice Development",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.18.0"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist/"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "default": "./dist/types.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "types": [
+        "./dist/types.d.ts"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint ./src --ext ts --report-unused-disable-directives"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.12",
+    "@types/node": "^22.5.5",
+    "@types/vcf": "^2.0.7",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "eslint": "^8.2.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-config-airbnb-typescript": "^18.0.0",
+    "eslint-plugin-import": "^2.25.2",
+    "mit-license": "^1.0.0",
+    "nodemon": "^3.1.7",
+    "typescript": "^5.4.2"
+  },
+  "dependencies": {
+    "debug": "^4.3.7",
+    "vcf": "^2.1.2"
+  }
+}

package/readme.md

@@ -0,0 +1,62 @@
+# Max Bot API Client 
+
+## Документация
+
+В [документации](https://github.com/max-messenger/max-bot-api-client-ts/tree/master/docs) вы можете найти подробные инструкции по использованию фреймворка.
+
+## Быстрый старт
+
+> Если вы новичок, то можете прочитать [официальную документацию](https://dev.max.ru/), написанную разработчиками Max
+
+### Получение токена
+Откройте диалог с [PrimeBot](https://max.ru/primebot), следуйте инструкциям и создайте нового бота. После создания бота PrimeBot отправит вам токен.
+
+### Установка
+#### npm
+```sh
+npm install @maxhub/max-bot-api
+```
+#### yarn
+```sh
+yarn add @maxhub/max-bot-api
+```
+#### pnpm
+```sh
+pnpm add @maxhub/max-bot-api
+```
+
+### Пример
+```javascript
+import { Bot } from '@maxhub/max-bot-api';
+
+const bot = new Bot(process.env.BOT_TOKEN);
+
+// Установка подсказок с доступными командами
+bot.api.setMyCommands([
+  { 
+    name: 'ping',
+    description: 'Сыграть в пинг-понг'
+  },
+]);
+
+// Обработчик события запуска бота
+bot.on('bot_started', (ctx) => ctx.reply('Привет! Отправь мне команду /ping, чтобы сыграть в пинг-понг'));
+
+// Обработчик команды '/ping'
+bot.command('ping', (ctx) => ctx.reply('pong'));
+
+// Обработчик для сообщения с текстом 'hello'
+bot.hears('hello', (ctx) => ctx.reply('world'));
+
+// Обработчик для всех остальных входящих сообщений
+bot.on('message_created', (ctx) => ctx.reply(ctx.message.body.text));
+
+bot.start();
+```
+
+### Обработка ошибок
+Если во время обработки события произойдёт ошибка, Bot вызовет метод `bot.handleError`. По умолчанию `bot.handleError` просто завершает работу программы, но вы можете переопределить это поведение, используя `bot.catch`.
+
+> ⚠️ Завершайте работу программы при неизвестных ошибках, иначе бот может зависнуть в состоянии ошибки.
+
+> ℹ️ [`pm2`](https://pm2.keymetrics.io/) может автоматически перезапустить вашего бота, если он остановится по какой-либо причине