Интерфейс для работы с ICQ ботами для NodeJS/TypeScript. В этом пакете я (разработчик) попытался максимально избавится от всех зависимостей и сделал максимально похожий код и интерфейс на версию "bot-python" из pip от mail.ru
Все интерфейсы ответов сервера, сущностей и доступны для работы с TypeScript и готовы к экспорту.
Тестирование проекта выполняется с помощью фреймворка mocha.
Также имеется описание проекта на английском языке в README.EN.md доступное после скачивания.
Библиотека поддерживает Bot API 1.0 интерфейс и совместимый с NodeJS верси 13.10.1
Что бы создать собственного бота необходимо зарегистрироваться в ICQ и написать в чат Metabot команду
/newbot
Далее следуйте инструкции.
Метобот сможет ответить вам если вы добавите его в список контактов или сами начнёте диалог.
Установка с использованием npm:
npm install icq-bot -s
Обратите внимание на актуальную мажерную версию бота
Инициализация для JS проекта
const ICQ = require("icq-bot").default;
const TOKEN = "XXX.XXX.XXX:XXX"
const bot = new ICQ.Bot(TOKEN);
где XXX.XXX.XXX:XXX - токен, который выдал метобот в диалоге
Конструктор класса поддерживает два параметра
const options = {
apiUrlBase: string,
name: string,
version: string,
timeoutS: number,
pollTimeS: number
};
new ICQ.Bot(TOKEN, options);
где:
Отправка сообщений чрез API
const chatId = "XXX";
bot.sendText(charID,"TEXT HERE..").then( response =>{ console.log( response.ok ) });
где XXX - номер чата
Как использовать пулинг
Для начала нужно созать обработчик. Вы можете использовать следующие обработчики (Хэндлеры): ICQ.Handler.* :
Хэндлер должен быть помещён в экземпляр класса дипечер в экземпляре класса бот. Для этого в ранее созданном боте необходимо вызвать метод getDispatcher() который вернёт актуальный диспетчер.
Далее следует вызвать метод addHanler( handler: BaseHandler ) и поместить один из выше перечисленных созданных обработчиков. В примере приведен обработчик Message
let handler = new ICQ.Handler.Message(null, (bot, event) => { });
bot.getDispatcher().addHandler(handler);
bot.startPolling();
Как использовать фильтры для обработчиков
Вы можете использовать следующие фильтры: ICQ.Filters.* :
Все фильтры с * возвращают уже созданные объекты. Все остальные возвращают классы.
Обратите внимание, что все классы находятся в пространстве имён ICQ
Также доступен класс FilterComposite с тремя статическими методами:
let handler = new ICQ.Handler.Message(ICQ.Filter.url, (bot, event) => {
// code here...
});
bot.getDispatcher().addHandler(handler);
bot.startPolling();
Обратите внимание, что обработчики будут вызывать функцию обратного вызова каждый раз когда они подходят фильтру. Если у вас 2 обработчика, например ICQ.Handler.Message(null,... и ICQ.Handler.Message(ICQ.Filter.url,... то на сообщение со ссылкой будут вызваны оба обработчика, а на сообщение без ссылки только один обработчик.
Кнопки вынесены в отдельный класс ICQButton
let buttonOk = new ICQ.Button("Ok", "1319184")
let buttonOpenWeb = new ICQ.Button("Ok", null, "https://fake-mm.ru")
Цель:
Команды в терминале bash
# Создаём директорию
mkdir testBot
# Переходим в неё
cd ./testBot
# Создаём npm проект по умолчанию
npm init --force
# Устанавливаем зависимость icq-bot
npm i icq-bot -s
Далее создаём и вставляем в index.js код ниже со своим токеном.
// Импортируем бота
const ICQ = require('icq-bot').default;
// Создаём фасад пакета ICQ
const bot = new ICQ.Bot(ВАШ_ТОКЕН_БОТА);
// Создаём обработчик для новых сообщений
const handlerNewMessage = new ICQ.Handler.Message(null, (bot, event) => {
// Получаем номер чата из объекта event
const chatId = event.fromChatId;
// Выводим в консоль тип события и номер чата
console.log(`New Message event.fromChatID = ${chatId}`);
// Отправляем сообщение в чат отправителя
bot.sendText(chatId, "Привет!");
});
// Создаём обработчик для удалённых сообщений
const handlerDeleteMessage = new ICQ.Handler.DeletedMessage(null, (bot, event) => {
// Получаем номер чата из объекта event
const chatId = event.fromChatId;
// Выводим в консоль тип события и номер чата
console.log(`Deleted Message event.fromChatID = ${chatId}`);
// Отправляем сообщение в чат отправителя
bot.sendText(chatId, "Зачем!");
});
// Получаем диспетчер бота и добавляем в него обработчики
bot.getDispatcher().addHandler(handlerNewMessage);
bot.getDispatcher().addHandler(handlerDeleteMessage);
// Запускаем пулинг для получения команд обработчикам
bot.startPolling();
Далее остаётся запустить нашего бота
# Запускаем проект
node index.js
Цель: Сценарий 1
Сценарий 2
Аналогично первому примеру создадим проект и в файл index.js добавим следующий код:
const ICQ = require('icq-bot').default;
const TaskService = require("./TaskService").default;
const bot = new ICQ.Bot(ВАШ_ТОКЕН_БОТА);
const service = new TaskService();
const handlerCommand = new ICQ.Handler.Command("update",null, (bot, event) => {
let buttonOpenWeb = new ICQ.Button("Читать статьи", null, "https://fake-mm.ru")
// Вызов метода сервиса обработки данных и получение ID задачи
const id = service.addTask();
let buttonOk = new ICQ.Button("Отменить обработку", `{"name": "removeTask","id": ${id}}`)
bot.sendText(event.fromChatId, "Данные в очереди на обработку ", null,null,null,[buttonOk,buttonOpenWeb ]);
});
const helpCommand = new ICQ.Handler.HelpCommand(null,(bot, event) => {
const id = Math.random();
let buttonOk = new ICQ.Button("Открыть мануал", `{"name": "openManual", "id": ${id}}`)
bot.sendText(event.fromChatId, "Вся документация доступна по кнопке", null,null,null,[buttonOk]);
})
const handlerButton = new ICQ.Handler.BotButtonCommand(null,(bot,event) => {
try {
const command = JSON.parse(event.data.callbackData);
switch(command.name) {
case "removeTask" :
if(service.removeTask(command.id)) {
bot.answerCallbackQuery(event.data.queryId,"Обработка данных прервана; ID: "+command.id,false)
} else {
bot.answerCallbackQuery(event.data.queryId,"Задача ID: "+command.id + " не найдена!",true)
}
break;
case "openManual" :
bot.answerCallbackQuery(event.data.queryId,"Мануал по ссылке",false,"https://fake-mm.ru/features")
break;
default:
bot.answerCallbackQuery(event.data.queryId,"Обработка кнопки не задана!",true)
}
} catch(ex) {
bot.answerCallbackQuery(event.data.queryId,"Ошибка распознания команды!",true)
}
})
bot.getDispatcher().addHandler(handlerCommand);
bot.getDispatcher().addHandler(helpCommand);
bot.getDispatcher().addHandler(handlerButton);
bot.startPolling();
Далее создадим файл сервиса TaskService.js и вставим код ниже
class TaskService {
static inc = 0;
constructor() {
this.task = [];
}
addTask() {
const id = ++TaskService.inc;
this.task.push(id)
console.log(this.task)
return id;
}
removeTask(id) {
const index = this.getIndex(id);
if(index != -1) {
delete this.task[index]
console.log(this.task)
return true;
}
console.log(this.task)
return false;
}
getIndex(id) {
return this.task.findIndex(tid => tid == id);
}
}
exports.default = TaskService;
Далее остаётся запустить нашего бота
# Запускаем проект
node index.js
FAQs
ICQ-BOT
The npm package icq-bot receives a total of 2 weekly downloads. As such, icq-bot popularity was classified as not popular.
We found that icq-bot demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.