node-telegram-api/lib/index.js

156 lines
4.1 KiB
JavaScript
Raw Normal View History

2015-06-26 17:20:54 +00:00
import API from './api';
2015-06-29 22:20:34 +00:00
import webhook from './webhook';
import poll from './poll';
2015-06-26 17:20:54 +00:00
import {EventEmitter} from 'events';
const DEFAULTS = {
update: {
offset: 0,
timeout: 0.5,
limit: 100
}
};
2015-06-28 22:42:48 +00:00
/**
* Bot class used to connect to a new bot
* Bots have an api property which gives access to all Telegram API methods,
* see API class
*/
export default class Bot extends EventEmitter {
/**
* Create and connect to a new bot
* @param {object} options Bot properties.
*/
2015-06-26 17:20:54 +00:00
constructor(options = {update: {}}) {
2015-06-28 22:42:48 +00:00
super();
2015-06-26 17:20:54 +00:00
if (!options.token) {
throw new Error('Token cannot be empty');
}
2015-06-28 22:42:48 +00:00
2015-06-26 17:20:54 +00:00
this.token = options.token;
this.update = Object.assign(options.update || {}, DEFAULTS.update);
this.api = new API(this.token);
this.msg = {};
2015-06-26 17:20:54 +00:00
// EventEmitter
this._events = {};
this._userEvents = [];
2015-06-26 17:20:54 +00:00
}
2015-06-28 22:42:48 +00:00
/**
2015-06-29 22:20:34 +00:00
* Gets information about the bot and then
* 1) starts polling updates from API
* 2) sets a webhook as defined by the first parameter and listens for updates
2015-06-28 22:42:48 +00:00
* Emits an `update` event after polling with the response from server
* Returns a promise which is resolved after the bot information is received
* and set to it's `info` property i.e. bot.info
2015-06-29 22:20:34 +00:00
*
* @param {object} hook An object containg options passed to webhook
* properties:
* - url: HTTPS url to listen on POST requests coming
* from the Telegram API
* - port: the port to listen to, defaults to 443
* - server: An object passed to https.createServer
*
2015-06-28 22:42:48 +00:00
* @return {promise} A promise which is resolved with the response of getMe
*/
2015-06-29 22:20:34 +00:00
start(hook) {
if (hook) {
return webhook(hook, this);
}
2015-06-26 23:56:28 +00:00
return this.api.getMe().then(response => {
this.info = response.result;
2015-06-29 22:20:34 +00:00
this.on('update', this._update);
if (hook) {
return webhook(hook, this);
} else {
return poll(this);
}
});
}
2015-06-28 22:42:48 +00:00
/**
* Listens on specific message matching the pattern which can be an string
* or a regexp.
* @param {string/regex} pattern
* @param {function} listener function to call when a message matching the
* pattern is found, gets the Update
* In case of string, the message should start
* with the string i.e. /^yourString/
* @return {object} returns the bot object
*/
get(pattern, listener) {
if (typeof pattern === 'string') {
pattern = new RegExp(`^${pattern}`);
}
this._userEvents.push({
2015-06-28 22:42:48 +00:00
pattern, listener
});
2015-06-28 22:42:48 +00:00
return this;
2015-06-26 17:20:54 +00:00
}
2015-06-28 22:42:48 +00:00
/**
* Listens on a command
* @param {string} cmd the command string, should not include slash (/)
* @param {function} listener function to call when the command is received,
* gets the update
* @return {object} returns the bot object
*/
2015-06-26 17:20:54 +00:00
command(cmd, listener) {
this._userEvents.push({
2015-06-28 22:42:48 +00:00
pattern: new RegExp(`/${cmd}`),
listener
});
2015-06-28 22:42:48 +00:00
return this;
2015-06-26 17:20:54 +00:00
}
2015-06-28 22:42:48 +00:00
/**
* Sends the message provided
* @param {object} message The message to send. Gets it's send method called
* @return {unknown} returns the result of calling message's send method
*/
2015-06-28 01:04:18 +00:00
send(message) {
return message.send(this).catch(console.error);
2015-06-26 17:20:54 +00:00
}
2015-06-29 22:20:34 +00:00
/**
* The internal update event listener, used to parse messages and fire
* command/get events - YOU SHOULD NOT USE THIS
*
* @param {object} update
*/
_update(update) {
if (!this.update.offset) {
const updateId = update[update.length - 1].update_id;
this.update.offset = updateId;
}
if (this.update) {
this.update.offset += 1;
}
update.forEach(res => {
let text = res.message.text;
if (text.startsWith('/')) {
// Commands are sent in /command@thisusername format in groups
const regex = new RegExp(`@${this.info.username}$`);
text = text.replace(regex, '');
}
let ev = this._userEvents.find(({pattern}) => pattern.test(text));
if (!ev) {
return;
}
ev.listener(res.message);
});
}
}