Botact enables developers to focus on writing reusable application logic instead of spending time building infrastructure.
Botact enables developers to focus on writing reusable application logic instead of spending time building infrastructure.
$ npm i botact
const bodyParser = require('body-parser')
const express = require('express')
const { Botact } = require('botact')
const app = express()
const bot = new Botact({
confirmation: process.env.CONFIRMATION,
token: process.env.TOKEN
})
bot.command('start', ({ reply }) => reply('This is start!'))
bot.hears(/(car|tesla)/, ({ reply }) => reply('I love Tesla!'))
bot.event('group_join', ({ reply }) => reply('Thanks!'))
bot.on(({ reply }) => reply('What?'))
app.use(bodyParser.json())
app.post('/', bot.listen)
app.listen(process.env.PORT)
Core
Actions
Options
Upload helpers
Create bot.
Botact Flow:
Turn settings.redis to true, if you will use Botact Flow.
For detailed redis config see this
Definition:
constructor (settings: {
confirmation: string; // required
token: string; // required
group_id?: number;
// Flow Settings
flowTimeout?: number; // Document expire time, in seconds
redis?: boolean; // false by default
redisConfig?: object; // {} by default
})
Usage:
const { Botact } = require('botact')
const bot = new Botact({
confirmation: process.env.CONFIRMATION,
token: process.env.TOKEN
})
Call API method (https://vk.com/dev/methods).
Definition:
async api (
method: string, // required
options?: object, // api call parameters
): Promise<any>; // Promise with response/error
Usage:
const user_data = await bot.api('users.get', {
user_ids: 1
})
Call API by execute.
Definition:
async execute (
method: string, // required
options?: object, // api call parameters
callback?: function
): Promise<any>; // Promise with response/error
Usage:
bot.execute('users.get', {
user_ids: 1
}, (body) => {
// {
// response: [{
// id: 1,
// first_name: 'Павел',
// last_name: 'Дуров'
// }]
// }
})
Sends message to user
Definition:
async reply (
user_id: number,
message: string, // required, if attachment not setten
attachment: string // required, if message not setten
): Promise<any> // Promise with response/error
Usage:
bot.command('start', (ctx) => {
// with shortcut from context
ctx.reply('Hi, this is start!')
// function from context
ctx.sendMessage(ctx.user_id, 'Hi, this is start!')
// simple usage
bot.reply(ctx.user_id, 'Hi, this is start!')
// to multiple users
bot.reply([ ctx.user_id, 1 ], 'Hi, this is start!')
})
Start listen Express server.
Definition:
listen (
req: any, // Express request, required
res: any // Express response, required
)
Usage:
bot.listen(req, res)
Add callback before bot will start.
Definition:
before (
callback: function
)
Usage:
bot.before(() => new Date())
bot.on(({ inital }) => {
// Fri Nov 24 2017 16:00:21 GMT+0300 (MSK)
})
Add command w/ strict match.
Definition:
command (
command: string | string[],
callback: function
): Botact
Usage:
bot.command('start', ({ reply }) => reply('This is start!'))
Add event handler .
Definition:
event (
event: string | string[],
callback: function
): Botact;
Usage:
bot.event('group_join', ({ reply }) => reply('Thanks!'))
Add command w/ match like RegEx.
Definition:
hears (
hear: string | RegExp | (string | RegExp)[],
callback: function
): Botact;
Usage:
bot.hears(/(car|tesla)/, ({ reply }) => reply('I love Tesla!'))
Add reserved callback.
Definition:
on (
type: string,
callback: function
): Botact;
OR
on (
callback: function
): Botact;
Usage:
bot.on(({ reply }) => reply('What?'))
bot.on('audio', ({ reply }) => reply('Great music!'))
Add middleware.
Definition:
use (
callback: function
): Botact
Usage:
bot.use(ctx => ctx.date = new Date())
bot.on(({ date }) => {
// Fri Nov 24 2017 16:00:21 GMT+0300 (MSK)
})
Get options.
bot.options
// {
// confirmation: '12345',
// token: 'abcde...'
// }
Set options.
bot.options = { foo: 'bar' }
// {
// confirmation: '12345',
// token: 'abcde...',
// foo: 'bar'
// }
Delete keys settings.
Definition:
deleteOptions (
keys: string[]
): Botact
Usage:
bot.deleteOptions([ 'token', 'confirmation' ])
// {
// foo: 'bar'
// }
Upload and save cover. See detailed settings here.
Definition:
async uploadCover (
filepath: string, // Path to file with cover
settings?: object
): Promise<any> // Promise with response/error
Usage:
await bot.uploadCover('./cover.jpg', { crop_x2: 1590 })
// {
// images: [
// {
// url: "URL",
// width: 1920,
// height: 1080
// },
// [Object],
// [Object],
// [Object],
// [Object]
// ]
// }
Uploads document to peer.
Definition:
async uploadDocument (
filepath: string, // Path to file
peer_id: number,
type: 'doc' | 'audio_message' // 'doc' by default
): Promise<any>; // Promise with response/error
Usage:
await bot.uploadDocument('./book.pdf', 1234)
// {
// response:
// [{
// id: 1234,
// owner_id: 1234,
// title: "",
// ...
// }]
// }
Uploads photo to peer.
Definition:
async uploadPhoto (
filepath: string, // Path to picture
peer_id: number
): Promise<any> // Promise with response/error
Usage:
await bot.uploadPhoto('./picture.png', 1234)
// {
// id: 1234,
// album_id: 1234,
// owner_id: 1234,
// ...
// }
$ redis-server
const bodyParser = require('body-parser')
const express = require('express')
const { Botact } = require('botact')
const app = express()
const bot = new Botact({
confirmation: process.env.CONFIRMATION,
token: process.env.TOKEN,
flowTimeout: 20, // document will be deleted after 20 secs
redisConfig: {
host: '127.0.0.1', // default host for redis
port: 8080 // custom port for redis
},
})
bot.addScene('wizard',
({ reply, scene: { next } }) => {
next()
reply('Write me something!')
},
({ reply, body, scene: { leave } }) => {
leave()
reply(`You wrote: ${body}`)
}
)
bot.command('join', ({ scene: { join } }) => join('wizard'))
app.use(bodyParser.json())
app.post('/', bot.listen)
app.listen(process.env.PORT)
Add scene.
Definition:
addScene (
name: string,
...args: function[]
): Botact;
Usage:
bot.addScene('wizard',
({ reply, scene: { next } }) => {
next()
reply('Write me something!')
},
({ reply, body, scene: { leave } }) => {
leave()
reply(`You wrote: ${body}`)
}
)
Enter scene.
Definition:
async joinScene (
ctx: object,
scene: string,
session?: object, // {} by default
step?: number, // 0 by default
instantly?: boolean // true by default
): Promise<Botact>;
Usage:
bot.command('join', (ctx) => {
// with shortcut without additional settings
ctx.scene.join('wizard')
// simple usage with additional settings
bot.joinScene(ctx, 'wizard', { foo: 'bar' })
})
Navigate scene.
Definition:
async nextScene (
ctx: object,
session?: object, // {} by default
): Promise<Botact>;
Usage:
bot.addScene('wizard',
(ctx) => {
// with shortcut without additional settings
ctx.scene.next({ foo: 'bar' })
// simple usage with additional settings
bot.nextScene(ctx, { foo: 'bar' })
}
)
Leave scene.
Definition:
async leaveScene(
ctx: object
): Promise<Botact>;
Usage:
bot.addScene('wizard',
(ctx) => {
// with shortcut
ctx.scene.leave()
// simple usage
bot.leaveScene(ctx)
}
)
Botact includes TypeScript definitions.
$ npm test
Thank you for donations.
MIT.
FAQs
Botact enables developers to focus on writing reusable application logic instead of spending time building infrastructure.
The npm package botact receives a total of 30 weekly downloads. As such, botact popularity was classified as not popular.
We found that botact 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
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.