vk-bot-api - npm Package Compare versions

vk-bot-api

Package Overview

Dependencies

Maintainers

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 1.4.7 to 2.0.0

package.json

		{
		"name": "vk-bot-api",
		"version": "1.4.7",
		"description": "Tool to make VK chat bots",
		"main": "./lib/vk.js",
		"keywords": [
		"vk",
		"чат бот",
		"бот",
		"bot",
		"вк",
		"vk api"
		],
		"version": "2.0.0",
		"description": "",
		"main": "index.js",
		"scripts": {
		"prepublish": "./node_modules/.bin/babel -d ./lib src",
		"test": "echo \"Error: no test specified\" && exit 1"
		},
		"author": "Vitaly Volynsky <vitalya147@ya.ru>",
		"license": "MIT",
		"devDependencies": {
		"babel-cli": "^6.16.0",
		"babel-preset-latest": "^6.16.0",
		"eslint": "^3.8.1",
		"eslint-config-standard": "^6.2.0",
		"eslint-plugin-promise": "^3.3.0",
		"eslint-plugin-standard": "^2.0.1"
		"repository": {
		"type": "git",
		"url": "git+https://github.com/npm/deprecate-holder.git"
		},
		"dependencies": {
		"eventemitter3": "^2.0.2",
		"request": "^2.75.0",
		"request-promise": "^4.1.1"
		}
		"author": "",
		"license": "ISC",
		"bugs": {
		"url": "https://github.com/npm/deprecate-holder/issues"
		},
		"homepage": "https://github.com/npm/deprecate-holder#readme"
		}

102

README.md

		@@ -1,101 +0,5 @@
		## vk-bot-api
		Библиотека для создания чат-ботов ВК.
		# Deprecated Package

		## Установка
		```sh
		npm i --save vk-bot-api
		```
		## Получение токена
		```
		https://oauth.vk.com/authorize?client_id= ID ВАШЕГО ПРИЛОЖЕНИЯ &scope=messages,photos&redirect_uri=http://oauth.vk.com/blank.html&response_type=token
		```
		Права доступа:
		This package is no longer supported and has been deprecated. To avoid malicious use, npm is hanging on to the package name.

		\| Право доступа \| Зачем \|
		\| ------------- \| ----- \|
		\| messages \| Отправка, прием сообщений \|
		\| photos \| Загрузка фотографий \|

		Данные права обязательны, но можно добавить еще дабы расширить функционал бота

		## Пример использования
		```js
		var VkBotApi = require('vk-bot-api')
		var bot = new VkBotApi({
		token: '<VK_TOKEN>',
		prefix: /бот/i
		})

		// создаем команду "дуров онлайн?"
		bot.onText(/дуров онлайн\?/i, msg => {
		bot.API.call('users.get', { // запрашиваем информацию о Дурове из VK API
		user_ids: 1,
		fields: 'online'
		}).then(users => {
		var durov = users[0]
		bot.sendMessage(msg, durov.online ? 'Да' : 'Нет')
		})
		})
		```

		## Конструктор бота
		Создает событие `message`, когда приходит новое сообщение для бота, `unhalded`, когда приходят собщения, на которые не сработал ни один обработчик сообщений и дополнительные события `chat_create`, `chat_title_update`, `chat_photo_update`, `chat_invite_user`, `chat_kick_user` (для бесед)

		Параметры:

		\| Параметр \|Описание \| Тип \| По умолчанию \|
		\|-----------\|---------\|-----\|--------------\|
		\| token \| Токен \| Строка \| \|
		\| v \| Используемая версия VK API \| Число \| 5 \|
		\| chats \| Список id чатов и пользователей, на сообщения которых бот будут отвечать. Если не указывать, то будет отвечать на все сообщения. ID беседы = 2e9 + номер беседы. <br> Например, если указать `[1, 2e9+12]`, то бот будет отвечать только на сообщения Дурова и чата #12 \| Массив \| Пуст \|
		\| prefix \| Имя бота, с которого должны начинаться сообщения. Если не указывать, то будет отвечать на все сообщения. \| Регулярное выражение \| \|
		\| timeout \| Таймаут для обращений к VK API. \| Число \| 5 \|
		\| prefixOnlyForGroups \| Если true, то префикс будет проверяться только в беседах, а в диалогах с пользователями будет отвечать на все \| Логический \| false
		\| LPMessages \| Если true, то сообщения будут приходить не в виде [объекта сообщения](https://vk.com/dev/message), а в виде [массива, который присылает LongPoll - сервер](https://vk.com/dev/using_longpoll). Иначе, бот сначала получит объект используя API. \| Логический \| false \|

		## Запросы к VK API
		В примере выше вы могли заметить, что мы воспользовались методом Vk API. Запросы делаются так:
		```js
		bot.API.call('метод', {
		ключ: значение
		})
		```

		## Создание команд
		Для этого используется функция `onText`, принимающая два параметра:
		* RegExp, содержащий команду
		* Функция, которая выполняется при совпадении

		```js
		bot.onText(/погода (.*)/, (msg, match) => {
		// получаем погоду...

		bot.sendMessage(msg, 'В городе ' + match[1] + 'тепло')
		})
		```

		## Отправка сообщений
		Параметры:

		\| Параметр \|Описание \|
		\|-----------\|---------\|
		\| peer_id \| [`peer_id`](https://vk.com/dev/messages.send) \|
		\| message \| Текст сообщения \|
		\| params \| Объект с дополнительными параметрами

		```js
		bot.sendMessage(2e9 + 12, 'Привет с:', {
		'attachment': 'photo100172_166443618'
		})
		```

		## Загрузка фотографий

		Выполняется с помощью функции uploadPhoto.
		В качестве параметра принимается адрес файла, возвращает объект фотографии (см. [photos.saveMessagesPhoto](https://vk.com/dev/photos.saveMessagesPhoto)).
		```js
		bot.uploadPhoto('/home/user/kittens.png') // путь к файлу
		.then(photo => {
		// творим магию
		})
		```
		Please contact support@npmjs.com if you have questions about this package.

lib/_vk.js

lib/api.js

lib/lp.js

lib/vk.js

New alerts

Fixed alerts

Improved metrics

Worsened metrics

Dependency changes