- [deps] use forked
@bottender/jfs
instead of unmaintainedjfs
.
-
[deprecated] add deprecated warning to the following methods:
-
context.useAccessToken
-
context.replyButtonTemplate
-
context.push
-
context.pushText
-
context.pushImage
-
context.pushVideo
-
context.pushAudio
-
context.pushLocation
-
context.pushSticker
-
context.pushImagemap
-
context.pushFlex
-
context.pushTemplate
-
context.pushButtonTemplate
-
context.pushButtonsTemplate
-
context.pushConfirmTemplate
-
context.pushCarouselTemplate
-
context.pushImageCarouselTemplate
-
context.send
-
context.sendImage
-
context.sendVideo
-
context.sendAudio
-
context.sendLocation
-
context.sendSticker
-
context.sendImagemap
-
context.sendFlex
-
context.sendTemplate
-
context.sendButtonTemplate
-
context.sendButtonsTemplate
-
context.sendConfirmTemplate
-
context.sendCarouselTemplate
-
context.sendImageCarouselTemplate
- [deps] remove
prompt-confirm
.
- [deps] update dependencies.
- [new] Server: support experimental custom connectors (#781):
// bottender.config.js
module.exports = {
channels: {
mychannel: {
enabled: true,
path: '/webhooks/mychannel',
connector: new MyConnector(/* ... */),
},
},
};
- [new]: export clients, factories from
messaging-apis
(#806):
const {
// clients
MessengerClient,
LineClient,
TelegramClient,
SlackOAuthClient,
ViberClient,
TwilioClient,
// factories
Messenger,
Line,
} = require('bottender');
- [new] Bot: implement the
onRequest
option (#773):
// bottender.config.js
function onRequest(body, requestContext) {
console.log({
body,
requestContext,
});
}
module.exports = {
channels: {
messenger: {
// ...
onRequest,
},
whatsapp: {
// ...
onRequest,
},
line: {
// ...
onRequest,
},
telegram: {
// ...
onRequest,
},
slack: {
// ...
onRequest,
},
viber: {
// ...
onRequest,
},
},
};
- [new] RequestContext: add
id
toRequestContext
(#774) - [fix] Server: should await for
connector.preprocess
(#771) - [deps] upgrade
messaging-apis
to v1.0.0
- [new] get/set/delete user level persistent menu for context user (#790):
await context.getUserPersistentMenu();
// [
// {
// locale: 'default',
// composerInputDisabled: false,
// callToActions: [
// {
// type: 'postback',
// title: 'Restart Conversation',
// payload: 'RESTART',
// },
// {
// type: 'web_url',
// title: 'Powered by ALOHA.AI, Yoctol',
// url: 'https://www.yoctol.com/',
// },
// ],
// },
// ]
await context.setUserPersistentMenu([
{
locale: 'default',
composerInputDisabled: false,
callToActions: [
{
type: 'postback',
title: 'Restart Conversation',
payload: 'RESTART',
},
{
type: 'web_url',
title: 'Powered by ALOHA.AI, Yoctol',
url: 'https://www.yoctol.com/',
},
],
},
]);
await context.deleteUserPersistentMenu();
- [new] support line multi-channel using
getConfig
(#770):
// bottender.config.js
module.exports = {
channels: {
line: {
enabled: true,
path: '/webhooks/line/:channelId',
async getConfig({ params }) {
console.log(params.channelId);
// ...get the config from the API, database or wherever you like when every time receiving a new event
return {
accessToken,
channelSecret,
};
},
},
},
};
- [new] add
emojis
on LINE text message event (#793):
if (context.event.isMessage) {
context.event.message.emojis;
// [
// {
// index: 14,
// length: 6,
// productId: '5ac1bfd5040ab15980c9b435',
// emojiId: '001',
// },
// ]
}
- [new] add
LineContext.getMembersCount
method (#824):
await context.getMembersCount();
// 10
- [new] add
TelegramEvent.isPollAnswer
andTelegramEvent.pollAnswer
(#745):
if (context.event.isPollAnswer) {
console.log(context.event.pollAnswer);
}
- [new] add
pollAnswer
to telegram routes:
const { router, telegram } = require('bottender/router');
async function HandlePollAnswer(context) {
// ...
}
function App() {
return router([telegram.pollAnswer(HandlePollAnswer)]);
}
- [new] add
TelegramContext.answerCallbackQuery
(#750):
await context.answerCallbackQuery({
url: 'https://example.com/',
});
- [new] slack route accept any requests by passing
*
(#758):
const { router, slack } = require('bottender/router');
async function HandleAllEvent(context) {
// ...
}
function App() {
return router([slack.event('*', HandleAllEvent)]);
}
- [fix] fix
context.views.open
in slack home tab (#809) - [fix] fix route slack event (#841)
- [fix] fix slack session when channel id is null (#802)
- [docs] update slack routes improvement (#759)
- [example] example: slack update and delete (#769)
- [example] slack home tab (#829)
- [example] slack modal on home (#827)
- [example] slack modal update (#825)
- [example] slack modal form (#828)
- [deps] use
@google-cloud/dialogflow
v4
- [fix] fix context concat and env name (#859)
- [new] add new connector -
FacebookConnector
to experiment using same connector for Messenger and Facebook.
// bottender.config.js
const { FacebookConnector } = require('@bottender/facebook');
module.exports = {
channels: {
facebook: {
enabled: true,
path: '/webhooks/facebook',
connector: new FacebookConnector({
// The top level access token should be provided for the batch requests.
accessToken: process.env.FACEBOOK_ACCESS_TOKEN,
appSecret: process.env.FACEBOOK_APP_SECRET,
verifyToken: process.env.FACEBOOK_VERIFY_TOKEN,
origin: process.env.FACEBOOK_ORIGIN,
async mapPageToAccessToken(pageId) {
console.log(pageId);
return accessToken;
},
}),
onRequest: onFacebookRequest,
},
},
};
- [fix] fix context concat and env name #859
- [fix] use for await instead of
promise.all
#851
- [fix] add Interaction type for route
slack.event
(#842)
- [fix] MongoSessionStore: enable
useUnifiedTopology
to avoid warning (#831)
- [fix] lock messaging-apis packages on specific version.
- [fix] add a workaround to support express behind trust proxies (for example: nginx) with:
server.enable('trust proxy');
// or
server.set('trust proxy', true);
- [fix] cli: remove deprecated properties on messenger profiles (including
home_url
).
- [fix] fix issue #618 ngrok undefined error message (#765)
- [fix] convert slack interactive message event to camelcase (#755).
- [type] use string instead enum to compare.
- [type] improve TS types of the
getClient
function (#744)
- [fix] bump messaging-api-line to beta.20 and fix types in text methods (#742)
- [new] route: provides
namespace.any
for better readability (#719):
function App() {
return router([
messenger.any(HandleMessenger),
line.any(HandleLine),
slack.any(HandleSlack),
telegram.any(HandleTelegram),
viber.any(HandleViber),
whatsapp.any(HandleWhatsapp),
]);
}
- [new] support custom session store (#732):
// bottender.config.js
const { MemorySessionStore } = require('bottender');
module.exports = {
session: {
driver: 'memory2',
stores: {
memory2: new MemorySessionStore();
},
},
};
- [fix] context: let getters return literal instead of string type (#724)
- [type] improve types of withProps (#731)
- [new] messenger: use v6.0 graph api as default (messaging-apis#556)
- [new] support reaction event and routing (#718):
Support event.isReaction
& event.react
:
function App(context) {
if (context.event.isReaction) {
console.log(context.event.reaction);
// {
// reaction: 'smile',
// emoji: '\u{2764}\u{FE0F}',
// action: 'react',
// mid: 'mid.$cAAE1UUyiiwthh0NPrVbVf4HFNDGl',
// }
}
}
Support detect events in routers:
const { router, messenger } = require('bottender/router');
function App() {
return router([
messenger.reaction.react(HandleReactionReact),
messenger.reaction.unreact(HandleReactionUnreact),
messenger.reaction(HandleReaction),
]);
}
async function HandleReactionReact(context) {}
async function HandleReactionUnreact(context) {}
async function HandleReaction(context) {}
- [new] add
context.sendOneTimeNotifReqTemplate
(#722):
context.sendOneTimeNotifReqTemplate({
title: '<TITLE_TEXT>',
payload: '<USER_DEFINED_PAYLOAD>',
});
- [type] improve types of MessengerContext send methods (#729)
- [new] export
LineNotify
(#721):
const { LineNotify } = require('bottender');
- [type] add
language
toUser
(messaging-apis#563) - [type] add
sticon
toTextMessage
(messaging-apis#564) - [type] export LINE flex types (messaging-apis#558)
- [new] support text responses filled on Dialogflow.
- [new] add
lib
es2018-es2020 by default. - [fix] let
App
action accept Action as return value (#734)
- [fix] put
router.d.ts
into package files whitelist
- [fix] fix
bottender/router
import statement in TypeScript (#715)
- [deps] update
messaging-api-line
for domain name change for certain endpoints.
- [fix] improve the error message of missing entry action (#705).
- [fix] fix responding with application/json when using custom server (#700).
- [deps] update
messaging-api-line
.
- [fix] rewrite generated README (#708).
- [fix] install
eslint-plugin-import
for--typescript
. - [fix] add
dist
to.gitignore
for TypeScript (#697).
- [deps] some packages bump from dependabot.
- [deps] update
messaging-api-line
to fix an issue about narrowcast.
- [fix] hint users to edit the
.env
file (#678)
- [type] export types from messaging-apis (#661):
import {
MessengerTypes,
WhatsappTypes,
LineTypes,
TelegramTypes,
SlackTypes,
ViberTypes,
} from 'bottender';
- [deps] update dependencies.
- [new] add new channel
whatsapp
built on top of Twilio API for WhatsApp (#664):
// bottender.config.js
module.exports = {
channels: {
whatsapp: {
enabled: true,
path: '/webhooks/whatsapp',
accountSid: process.env.WHATSAPP_ACCOUNT_SID,
authToken: process.env.WHATSAPP_AUTH_TOKEN,
phoneNumber: process.env.WHATSAPP_PHONE_NUMBER,
},
},
};
- [new] support Slack signing secret:
// bottender.config.js
module.exports = {
channels: {
slack: {
enabled: true,
path: '/webhooks/slack',
accessToken: process.env.SLACK_ACCESS_TOKEN,
signingSecret: process.env.SLACK_SIGNING_SECRET,
// verificationToken: process.env.SLACK_VERIFICATION_TOKEN, // deprecated, use signingSecret
},
},
};
- [new] add support for Slack slash commands (#166):
async function App(context) {
if (context.event.isCommand) {
await context.sendText(
`I received slash command '${context.event.command}' with arguments: '${context.event.text}'`
);
}
}
- [deps] update
messaging-api-line
to support narrowcast.
- [new] use signing secret in create-bottender-app (#659).
- [new] add TypeScript support to
bottender dev
(#654).
- [new] support
bottender dev --inspect=HOST:PORT
(#656).
- [fix] fix a typo in Slack error message #671
- [fix] Fixed wrong npm scripts in the instruction.
- [fix] install @types packages in package dependencies instead of workspace.
-
[new] Added four NLU packages:
-
[new] Added
context.setIntent()
for intent tracking purpose (#617):
context.intent; // null
context.setIntent('greeting');
context.intent; // 'greeting'
- [new] Added
context.setAsHandled()
andcontext.setAsNotHandled()
for tracking handling status (#624):
context.setAsHandled();
context.isHandled; // true
context.setAsNotHandled();
context.isHandled; // false
- [new] Added
getSessionStore
helper function to get the session store that configured bybottender.config.js
(#633):
const { getSessionStore } = require('bottender');
const sessionStore = getSessionStore();
- [new] Added
getClient
helper function to access underlying messaging client configured bybottender.config.js
(#634):
const { getClient } = require('bottender');
const messenger = getClient('messenger');
messenger.sendText(USER_ID, 'Hello!', { tag: 'CONFIRMED_EVENT_UPDATE' });
const line = getClient('line');
line.pushText(USER_ID, 'Hello!');
- [new] Added async plugin support.
- [docs] Updated Natural Language Understanding Guide to use NLU packages.
- [example] Using NLU packages in NLU examples.
- [new] add
includeBotMessages
option for interacting withbot_message
(#635):
// bottender.config.js
module.exports = {
// ...
slack: {
enabled: true,
path: '/webhooks/slack',
accessToken: process.env.SLACK_ACCESS_TOKEN,
verificationToken: process.env.SLACK_VERIFICATION_TOKEN,
includeBotMessages: true, // add this line
},
};
Then you can use context.event.isBotMessage
to determine if the event is a bot message event:
module.exports = function App(context) {
if (context.event.isBotMessage) {
console.log(context.event.rawEvent.botId);
}
};
- [fix] fix(Bot, LineConnector, MessengerConnector): when receiving multiple events, construct session with event instead of request #621
- [fix] fix(DevServer): call
super.prepare()
inprepare
method to avoid overwriting parent method
- [fix] improve error message when there are errors in bottender.config.js (#611)
- [new] improve error messages for bots configuration:
LINE channel secret is required. Please make sure you have filled it correctly in `bottender.config.js` or `.env` file.
Instead of:
TypeError [ERR_INVALID_ARG_TYPE]: The "key" argument must be one of type Buffer, TypedArray, DataView, string, or KeyObject. Received type undefined
- [new] Added Messenger routes:
const { router, messenger } = require('bottender/router');
function Action() {
// ...
}
function App() {
return router([
messenger.message(Action),
messenger.accountLinking.linked(Action),
messenger.accountLinking.unlinked(Action),
messenger.accountLinking(Action),
messenger.checkoutUpdate(Action),
messenger.delivery(Action),
messenger.echo(Action),
messenger.gamePlay(Action),
messenger.passThreadControl(Action),
messenger.takeThreadControl(Action),
messenger.requestThreadControl(Action),
messenger.appRoles(Action),
messenger.optin(Action),
messenger.payment(Action),
messenger.policyEnforcement(Action),
messenger.postback(Action),
messenger.preCheckout(Action),
messenger.read(Action),
messenger.referral(Action),
messenger.standby(Action),
messenger(Action),
]);
}
- [new] Added LINE routes:
const { router, line } = require('bottender/router');
function Action() {
// ...
}
function App() {
return router([
line.message(Action),
line.follow(Action),
line.unfollow(Action),
line.join(Action),
line.leave(Action),
line.memberJoined(Action),
line.memberLeft(Action),
line.postback(Action),
line.beacon.enter(Action),
line.beacon.banner(Action),
line.beacon.stay(Action),
line.beacon(Action),
line.accountLink(Action),
line.things.link(Action),
line.things.unlink(Action),
line.things.scenarioResult(Action),
line.things(Action),
line(Action),
]);
}
- [new] Implemented native Slack chat APIs, see Slack API Doc for further information. e.g.
context.chat.postMessage(...);
context.chat.postEphemeral(...);
context.chat.update(...);
context.chat.delete(...);
context.chat.meMessage(...);
context.chat.getPermalink(...);
context.chat.scheduleMessage(...);
context.chat.deleteScheduledMessage(...);
context.chat.scheduledMessages.list(...);
context.postMessage
andcontext.postEphemeral
is now deprecated, usecontext.chat.postMessage
andcontext.chat.postEphemeral
instead.
- [new] Implemented native Slack views APIs, see Slack API Doc for further information. e.g.
context.views.open(...);
context.views.publish(...);
context.views.push(...);
context.views.update(...);
For views, we keep channelId
in privateMetadata
to get session key for upcoming view events. (ref)
- [new] Added Slack routes:
const { router, slack } = require('bottender/router');
function Action() {
// ...
}
function App() {
return router([
slack.message(Action),
slack.event('pin_added', Action),
slack.event('star_added', Action),
slack(Action),
]);
}
- [new] Added Telegram routes:
const { router, telegram } = require('bottender/router');
function Action() {
// ...
}
function App() {
return router([
telegram.message(Action),
telegram.editedMessage(Action),
telegram.channelPost(Action),
telegram.editedChannelPost(Action),
telegram.inlineQuery(Action),
telegram.chosenInlineResult(Action),
telegram.callbackQuery(Action),
telegram.shippingQuery(Action),
telegram.preCheckoutQuery(Action),
telegram.poll(Action),
telegram(Action),
]);
}
- [new] Added Viber routes:
const { router, viber } = require('bottender/router');
function Action() {
// ...
}
function App() {
return router([
viber.message(Action),
viber.subscribed(Action),
viber.unsubscribed(Action),
viber.conversationStarted(Action),
viber.delivered(Action),
viber.seen(Action),
viber.failed(Action),
viber(Action),
]);
}
- [fix] fix(Bot, LineConnector, MessengerConnector): when receiving multiple events, construct session with event instead of request #621
- [fix] fix(DevServer): call
super.prepare()
inprepare
method to avoid overwriting parent method
- [fix] session should never expire by default #595
- [fix] move init session and bots into server prepare step #589
- [fix] session: use Windows safe key separator for file session
- [fix] server: require Bot using pascal case
- [fix] server: add
prepare
support for production mode.
- feat(messenger): add
fields
support tocontext.getUserProfile()
:
const user = await context.getUserProfile({
fields: [
'id',
'name',
'first_name',
'last_name',
'profile_pic',
'locale',
'timezone',
'gender',
],
});
- fix(example): fix
bottender.config.js
inmessenger-typing
example
- fix(line): set
shouldBatch
tofalse
afterhandlerDidEnd
has been called. This may be the best way to handle errors in LINE:
module.exports = async function HandleError(context, props) {
console.error(props.error);
if (process.env.NODE_ENV === 'development') {
await context.pushText('There are some unexpected errors happened. Please try again later, sorry for the inconvenience.');
await context.pushText(props.error.stack);
} else if (!context.isReplied) {
await context.replyText('There are some unexpected errors happened. Please try again later, sorry for the inconvenience.'
}
if (process.env.NODE_ENV === 'production') {
// send your error to the error tracker, for example: Sentry
}
};
- feat(telegram): add telegram
context.editMessageMedia()
:
await context.editMessageMedia(66, { type: 'photo', media: 'xxx.png' });
- The whole codebase has been fully rewritten with TypeScript.
- The repository becomes a lerna monorepo.
- [new] A brand-new project creator -
create-bottender-app
. You can use following command to create your new bot:
npx create-bottender-app my-app
- [new] Implement new runner and
bottender start
cli. It findsindex.js
entry andbottender.config.js
config file then executes accordingly:
bottender start
To enable console mode:
bottender start --console
- [new] Add new development mode via
bottender dev
cli:
bottender dev
bottender dev --console
The bot server will be restarted after changing the files.
- [new] Add several recommended ways to organize chatbot dialogs and features:
Action:
async function SayHi(context) {
await context.sendText('hi');
}
Pass Props to Action:
const { withProps } = require('bottender');
async function SayHi(context, { name }) {
await context.sendText(`hi! ${name}.`);
}
async function App() {
return withProps(SayHi, { name: 'John' });
}
Router:
const { router, text } = require('bottender/router');
async function SayHi(context) {
await context.sendText('Hi!');
}
async function SayHello(context) {
await context.sendText('Hello!');
}
async function App() {
return router([
text('hi', SayHi), // return SayHi when receiving hi text message
text('hello', SayHello), // return SayHello when receiving hello text message
]);
}
Chain:
const { chain } = require('bottender');
function RuleBased(context, props) {
if (context.event.text === 'hi') {
// discontinue and return SayHi
return SayHi;
}
// continue to next
return props.next;
}
function MachineLearningBased(context, props) {
/* ...skip */
}
function HumanAgent(context, props) {
/* ...skip */
}
function App() {
return chain([
// will execute in following order
RuleBased,
MachineLearningBased,
HumanAgent,
]);
}
- [new] Add
_error.js
entry support for error handling:
// _error.js
module.exports = async function HandleError(context, props) {
await context.sendText(
'There are some unexpected errors happened. Please try again later, sorry for the inconvenience.'
);
console.error(props.error);
if (process.env.NODE_ENV === 'production') {
// send your error to the error tracker, for example: Sentry
}
if (process.env.NODE_ENV === 'development') {
await context.sendText(props.error.stack);
}
};
- [new] Add better custom server support
- [breaking]
middleware
and Handlers has been moved to@bottender/handlers
package. You can install it from registry:
npm install @bottender/handlers
// or using yarn:
yarn add @bottender/handlers
And import them like this:
const {
middleware,
Handler,
MessengerHandler,
LineHandler,
SlackHandler,
TelegramHandler,
ViberHandler,
} = require('@bottender/handlers');
- [breaking] transform all context method parameters to camelcase:
Messenger -
context.sendGenericTemplate([
{
title: "Welcome to Peter's Hats",
imageUrl: 'https://petersfancybrownhats.com/company_image.png',
subtitle: "We've got the right hat for everyone.",
defaultAction: {
type: 'web_url',
url: 'https://peterssendreceiveapp.ngrok.io/view?item=103',
messengerExtensions: true,
webviewHeightRatio: 'tall',
fallbackUrl: 'https://peterssendreceiveapp.ngrok.io/',
},
buttons: [
{
type: 'postback',
title: 'Start Chatting',
payload: 'DEVELOPER_DEFINED_PAYLOAD',
},
],
},
]);
Slack -
context.postMessage({
blocks: [
{
type: 'section',
text: {
type: 'plain_text',
text: 'You updated the modal!',
},
},
{
type: 'image',
imageUrl: 'https://media.giphy.com/media/SVZGEcYt7brkFUyU90/giphy.gif',
altText: 'Yay! The modal was updated',
},
],
});
Telegram -
context.sendMessage('hi', {
disableWebPagePreview: true,
disableNotification: true,
});
Viber -
context.sendFile({
media: 'http://www.images.com/file.doc',
size: 10000,
fileName: 'name_of_file.doc',
});
- [breaking] transform all event attributes to camelcase:
context.event.rawEvent; // all keys is camelcase in this object
-
[breaking] rename
skipProfile
toskipLegacyProfile
, and set to true by default -
[breaking] unify requestContext (#541)
-
[deps] update
messaging-apis
to v1 -
[examples] Rewrite all examples for Bottender v1
-
[docs] A brand-new website with new docs - https://bottender.js.org?new
- [new] add
pageId
config to automatically add subscribe app inbottender messenger webhook set
. - [removed]
get-started
,greeting
,persistent-menu
,whitelisted-domains
cli subcommands has been removed. Useprofile
instead:
bottender messenger profile get
bottender messenger profile set
bottender messenger profile delete
- [removed] Remove deprecated
context.sendAirlineFlightUpdateTemplate()
.
- [new] Implement
context.getMessageContent()
. You can use it to get received media content:
async function App(context) {
if (context.event.isImage || context.event.isVideo || context.event.isAudio) {
const buffer = await context.getMessageContent();
}
}
- [new] LineBot: Set
sendMethod
toreply
andshouldBatch
totrue
by default. - [removed] legacy
menu
cli subcommand has been removed.
- [new] add block kits support:
context.postMessage({
blocks: [
{
type: 'section',
text: {
type: 'plain_text',
text: 'You updated the modal!',
},
},
{
type: 'image',
imageUrl: 'https://media.giphy.com/media/SVZGEcYt7brkFUyU90/giphy.gif',
altText: 'Yay! The modal was updated',
},
],
});
- [fix] use
token
in payload when received a JSON string payload.
- [new] implement
context.sendAnimation()
:
context.sendAnimation('xxx.mp4');
- [new] implement
context.sendPoll()
const options = ['a', 'b'];
context.sendPoll(question, options);
- [breaking] add messageId to args for all function need messageId:
context.editMessageText('<MESSAGE_ID>', text);
context.editMessageCaption('<MESSAGE_ID>', caption);
context.editMessageReplyMarkup('<MESSAGE_ID>', replyMarkup);
context.editMessageLiveLocation('<MESSAGE_ID>', location);
context.stopMessageLiveLocation('<MESSAGE_ID>');
- [new] add member join/leave event to LineEvent
event.isMemberJoined;
event.memberJoined;
event.isMemberLeft;
event.memberLeft;
- [deps] upgrade messaging-api-messenger to 0.7.16
- [new] Add
page.id
to Messenger sessions:
session.page.id;
- [new] Add
skipProfile
toLinekBot
andLinekConnector
. - [new] Add
destination
toLineEvent
.
- [new] Add
skipProfile
toSlackBot
andSlackConnector
.
- [fix] Add missing cli alias
-w
for--webhook
.
- [new] provide useful information when setting webhook
- [new] Add
context.usePersona
:
context.usePersona('<PERSONA_ID>');
await context.sendText('Hello');
await context.sendText('World');
- [new] Add
skipProfile
option toMessengerBot
andMessengerConnector
to skip auto updating user profile:
const bot = new MessengerBot({
accessToken: ACCESS_TOKEN,
appSecret: APP_SECRET,
skipProfile: true,
});
- [new] Add
skipAppSecretProof
option toMessengerBot
andMessengerConnector
:
const bot = new MessengerBot({
accessToken: ACCESS_TOKEN,
appSecret: APP_SECRET,
skipAppSecretProof: true,
});
- [new] platform bots: add
origin
option for testing purpose:
new MessengerBot({
// ...
origin: 'https://mydummytestserver.com',
});
new LineBot({
// ...
origin: 'https://mydummytestserver.com',
});
new SlackBot({
// ...
origin: 'https://mydummytestserver.com',
});
new ViberBot({
// ...
origin: 'https://mydummytestserver.com',
});
new TelegramBot({
// ...
origin: 'https://mydummytestserver.com',
});
- [fix] update Messenger profile_pic check logic
- [fix] fix persona cli error messages
- [new] Add CLI commands for Messenger persona API:
List all personas:
$ bottender messenger persona list
Create a new persona with name and profile picture url:
$ bottender messenger persona create --name <PERSONA_NAME> --pic <PROFILE_IMAGE_URL>
Get persona by persona ID:
$ bottender messenger persona get --id <PERSONA_ID>
Delete persona by persona ID:
$ bottender messenger persona delete --id <PERSONA_ID>
- [new] Add
sessionStore.all()
to fetch all of sessions from the store:
// for those session stores
const sessionStore = new MemorySessionStore(500);
const sessionStore = new MongoSessionStore('mongodb://localhost:27017/');
const sessionStore = new FileSessionStore();
const sessionStore = new RedisSessionStore();
const sessions = await sessionStore.all();
- [deps] update
messaging-apis
(which support messenger persona api)
- [new] upgrade
messaging-apis
, so now we can useDEBUG
env variable to enable request debugger:
DEBUG=messaging-api*
- [fix] fix
ConsoleBot
recognize symbol as_methodMissing
(#333) - [deps] upgrade dependencies
- [new] make sure all of methods support quick reply (#331):
context.sendText('hahaha', {
quickReply: {
items: [
{
type: 'action',
action: {
type: 'cameraRoll',
label: 'Send photo',
},
},
{
type: 'action',
action: {
type: 'camera',
label: 'Open camera',
},
},
],
},
});
- [new] add
isReplyToMessage
,replyToMessage
(#330):
event.isReplyToMessage;
event.replyToMessage;
- [fix] get correct channel id from more slack event format
- [new] add debugger for sync response
DEBUG=bottender:response
print:
bottender:response Outgoing response:
bottender:response {
bottender:response body: {
bottender:response }
bottender:response }
Useful when debugging synchronized connectors.
- [fix] makes
context.platform
consistent withcontext.session.platform
- [new] Add
mockPlatform
option:
const bot = new ConsoleBot({
fallbackMethods: true,
mockPlatform: 'messenger',
});
bot.connector.platform; // 'messenger'
bot.onEvent((context) => {
context.platform; // 'messenger'
});
- [new] Add
context.isThreadOwner()
:
await context.isThreadOwner(); // true | false
- [fix] fix cli hint (#311)
- [fix] not print empty array other args in ConsoleBot fallbackMethods (#314)
v0.15
is the second major version after we open sourced Bottender. In this version, we introduce a lot of helpful, community requested features based on Messaging APIs v0.7.
- [new] add
context.requestContext
:
Express, Micro, Restify:
context.requestContext; // { req, res }
Koa:
context.requestContext; // ctx in koa
- [new] add more debug logs and key change (#239, #295), so you can run bots with following
DEBUG
env:
DEBUG=bottender:*
DEBUG=bottender:request
DEBUG=bottender:session:read
DEBUG=bottender:session:write
- [new] skip and show warning when calling send API in Messenger echo delivery read event (#306)
- [fix] deepClone when read from
MemoryCacheStore
(#235) - [deps] Upgrade to Babel 7
- [breaking] remove deprecated
MessengerContext
method -sendQuickReplies
- [new] support Messenger platform v2.4.
- [new] enable verifying graph API calls with
appsecret_proof
by default. - [new]
context.getThreadOwner
const threadOwner = await context.getThreadOwner();
// {
// app_id: '12345678910'
// }
- [new] add
pageId
,gamePlay
,brandedCamera
,isRequestThreadControlFromPageInbox
getters toMessengerEvent
context.event.pageId; // "<PAGE_ID>"
context.event.isRequestThreadControlFromPageInbox; // true
context.event.isGamePlay; //
context.event.gamePlay; //
context.event.isBrandedCamera; //
context.event.brandedCamera; //
- [new] implement Batch Mode to send multiple requests in one batch (up to 50 messages):
const { isError613 } = require('messenger-batch');
new MessengerBot({
// ...
batchConfig: {
delay: 1000,
shouldRetry: isError613, // (#613) Calls to this api have exceeded the rate limit.
retryTimes: 2,
},
});
It will enable message batching functionality via messaging-api-messenger under the hood.
- [deprecated]
sendAirlineFlightUpdateTemplate
has been renamed tosendAirlineUpdateTemplate
.
- [new] support LINE Flex Message with
replyFlex
,pushFlex
,sendFlex
:
context.sendFlex('this is a flex', {
type: 'bubble',
header: {
type: 'box',
layout: 'vertical',
contents: [
{
type: 'text',
text: 'Header text',
},
],
},
hero: {
type: 'image',
url: 'https://example.com/flex/images/image.jpg',
},
body: {
type: 'box',
layout: 'vertical',
contents: [
{
type: 'text',
text: 'Body text',
},
],
},
footer: {
type: 'box',
layout: 'vertical',
contents: [
{
type: 'text',
text: 'Footer text',
},
],
},
styles: {
comment: 'See the example of a bubble style object',
},
});
- [new] add
issueLinkToken
toLineContext
(#245):
const result = await context.issueLinkToken();
// {
// linkToken: 'NMZTNuVrPTqlr2IF8Bnymkb7rXfYv5EY',
// }
- [new] add LINE
linkAccount
events support (#243):
context.event.isAccountLink; // true
context.event.linkAccount;
// {
// result: 'ok',
// nonce: 'xxxxxxxxxxxxxxx',
// }
- [new] add
shouldBatch
option:
new LineBot({
// ...
shouldBatch: true, // Default: false
});
When batching is enabled,
context.replyText('Hi');
context.replyText('Hi');
context.replyText('Hi');
context.replyText('Hi');
context.replyText('Hi');
Those 5 messages will be sent in one API call, just like the below one.
const { Line } = require('messaging-api-line');
context.reply([
Line.createText('Hi'),
Line.createText('Hi'),
Line.createText('Hi'),
Line.createText('Hi'),
Line.createText('Hi'),
]);
- [new] add
sendMethod
option:
new LineBot({
// ...
sendMethod: 'reply', // Default: 'push'
});
- [breaking] Now context methods throw error when
ok
isfalse
in Telegram:
{
ok: false,
result: { /* ... */ }
}
- [new] pass merged query and body to handler:
{
...query,
...body,
}
It's useful in custom connectors.
- [new] export Context from entry (#250)
const { Context } = require('bottender');
class MyContext extends Context {
//...
}
- [fix] MemoryCacheStore: make sure read as different object to prevent reading same key multiple times, causing freezed by other events.
- [new] alias LINE ButtonsTemplate to ButtonTemplate to match type name
buttons
#219
Aliases:
- replyButtonsTemplate -> replyButtonTemplate
- pushButtonsTemplate -> pushButtonTemplate
- sendButtonsTemplate -> sendButtonTemplate
- [new] Add cli option
-t
,--token
to overwrite token setting.
- [new] Add new Update APIs to
TelegramContext
:
editMessageText(text [, options])
editMessageCaption(caption [, options])
editMessageReplyMarkup(replyMarkup [, options])
deleteMessage(messageId)
editMessageLiveLocation(location [, options])
stopMessageLiveLocation(options)
forwardMessageFrom(fromChatId, messageId [, options])
forwardMessageTo(toChatId, messageId [, options])
- [new] Add new Get APIs to
TelegramContext
:
context.getUserProfilePhotos({ limit: 1 }).then((result) => {
console.log(result);
// {
// total_count: 3,
// photos: [
// [
// {
// file_id: 'AgADBAADGTo4Gz8cZAeR-ouu4XBx78EeqRkABHahi76pN-aO0UoDA050',
// file_size: 14650,
// width: 160,
// height: 160,
// },
// {
// file_id: 'AgADBAADGTo4Gz8cZAeR-ouu4XBx78EeqRkABKCfooqTgFUX0EoD5B1C',
// file_size: 39019,
// width: 320,
// height: 320,
// },
// {
// file_id: 'AgADBAADGTo4Gz8cZAeR-ouu4XBx78EeqRkABPL_pC9K3UpI0koD1B1C',
// file_size: 132470,
// width: 640,
// height: 640,
// },
// ],
// ],
// }
});
context.getChat().then((result) => {
console.log(result);
// {
// id: 313534466,
// first_name: 'first',
// last_name: 'last',
// username: 'username',
// type: 'private',
// }
});
context.getChatAdministrators().then((result) => {
console.log(result);
// [
// {
// user: {
// id: 313534466,
// first_name: 'first',
// last_name: 'last',
// username: 'username',
// languange_code: 'zh-TW',
// },
// status: 'creator',
// },
// ]
});
context.getChatMembersCount().then((result) => {
console.log(result);
// '6'
});
context.getChatMember().then((result) => {
console.log(result);
// {
// user: {
// id: 313534466,
// first_name: 'first',
// last_name: 'last',
// username: 'username',
// languange_code: 'zh-TW',
// },
// status: 'creator',
// }
});
- [new] Add new Group APIs to
TelegramContext
:
context.kickChatMember
context.unbanChatMember
context.restrictChatMember
context.promoteChatMember
context.exportChatInviteLink
context.setChatPhoto
context.deleteChatPhoto
context.setChatTitle
context.setChatDescription
context.setChatStickerSet
context.deleteChatStickerSet
context.pinChatMessage
context.unpinChatMessage
context.leaveChat
- [new] Add new Payment APIs to
TelegramContext
:
- [new] Add new
LineContext
methods:
context.getUserProfile().then((profile) => {
console.log(profile);
// {
// displayName: 'LINE taro',
// userId: USER_ID,
// pictureUrl: 'http://obs.line-apps.com/...',
// statusMessage: 'Hello, LINE!',
// }
});
context.getMemberProfile(USER_ID).then((member) => {
console.log(member);
// {
// "displayName":"LINE taro",
// "userId":"Uxxxxxxxxxxxxxx...",
// "pictureUrl":"http://obs.line-apps.com/..."
// }
});
context.getMemberIds(CURSOR).then((res) => {
console.log(res);
// {
// memberIds: [
// 'Uxxxxxxxxxxxxxx...',
// 'Uxxxxxxxxxxxxxx...',
// 'Uxxxxxxxxxxxxxx...'
// ],
// next: 'jxEWCEEP...'
// }
});
context.getAllMemberIds().then((ids) => {
console.log(ids);
// [
// 'Uxxxxxxxxxxxxxx..1',
// 'Uxxxxxxxxxxxxxx..2',
// 'Uxxxxxxxxxxxxxx..3',
// 'Uxxxxxxxxxxxxxx..4',
// 'Uxxxxxxxxxxxxxx..5',
// 'Uxxxxxxxxxxxxxx..6',
// ]
});
- [new] Implement
context.getUserProfile
:
const user = await context.getUserProfile();
// {
// first_name: 'Kevin',
// last_name: 'Durant',
// profile_pic: 'https://example.com/pic.png',
// locale: 'en_US',
// timezone: 8,
// gender: 'male',
// };
- [new] Implement
context.sendSenderAction
:
context.sendSenderAction('typing_on');
// same as
context.typingOn();
- [fix] Fix metadata argument in handover methods (#208)
- [new] Implement
context.getUserDetails
:
const user = await context.getUserDetails();
// {
// id: '01234567890A=',
// name: 'John McClane',
// avatar: 'http://avatar.example.com',
// country: 'UK',
// language: 'en',
// primary_device_os: 'android 7.1',
// api_version: 1,
// viber_version: '6.5.0',
// mcc: 1,
// mnc: 1,
// device_type: 'iPhone9,4',
// };
- [new] Implement
context.getOnlineStatus
:
const status = await context.getOnlineStatus();
// {
// id: '01234567890=',
// online_status: 0,
// online_status_message: 'online',
// }
- [new] Support using
/exit
to exit
- [new] Support passing
verifyToken
toMessengerBot
orMessengerConnector
(#204)
Support both:
- pass verifyToken in server config
const bot = new MessengerBot({
accessToken: config.accessToken,
appSecret: config.appSecret,
});
const server = createServer(bot, { verifyToken: config.verifyToken });
- pass verifyToken in bot config
const bot = new MessengerBot({
accessToken: config.accessToken,
appSecret: config.appSecret,
verifyToken: config.verifyToken,
});
const server = createServer(bot);
- [fix] Fix LINE join, leave events which do not have userId will fail get profile (#206)
- [fix] Upgrade
@slack/client
deps to fix security vulnerability
- [fix] fix context simulator initialState (#198)
- [new] Support request thread control:
context.requestThreadControl();
context.event.isRequestThreadControl; // true or false
context.event.requestThreadControl;
/*
{
metadata: 'additional content that the caller wants to set',
requested_owner_app_id: '123456789',
}
*/
- [fix] fix error on verifying facebook signature.
- [deps] bump messaging-apis to v0.6.13
- [new] Support trigger payload in
ConsoleBot
You > /payload PAYLOAD
Receive event:
context.event.isMessage; // false
context.event.message; // null
context.event.isText; // false
context.event.text; // null
context.event.isPayload; // true
context.event.payload; // PAYLOAD
- [new] Support all of methods on
ConsoleContext
withfallbackMethods: true
#184, for example:
const bot = new ConsoleBot({ fallbackMethods: true });
bot.onEvent(async (context) => {
await context.sendText('Hello World');
await context.sendImage('https://example.com/vr.jpg');
await context.sendButtonTemplate('What do you want to do next?', [
{
type: 'web_url',
url: 'https://petersapparel.parseapp.com',
title: 'Show Website',
},
{
type: 'postback',
title: 'Start Chatting',
payload: 'USER_DEFINED_PAYLOAD',
},
]);
});
Result:
Bot > Hello World
Bot > sendImage: ["https://example.com/vr.jpg"]
Bot > sendButtonTemplate: ["What do you want to do next?",[{"type":"web_url","url":"https://petersapparel.parseapp.com","title":"Show Website"},{"type":"postback","title":"Start Chatting","payload":"USER_DEFINED_PAYLOAD"}]]
- [fix] Catch write session error in async mode #185
- [improve] Show warning when calling
setState
orresetState
after session have been written #186
- [fix] Use sync mode in
ConsoleBot
to fix some format issue.
- [new] Support
--ngrok-port
when setting webhook #171. For example:
bottender messenger webhook set --ngrok-port 1234
bottender telegram webhook set --ngrok-port 1234
bottender viber webhook set --ngrok-port 1234
- [deps] Update part of dependencies.
- [new] Implement signature verify for viber
- [fix] Prevent applying any mutations to
initialState
#164
- [new] Added
context.answerInlineQuery
for Telegram #165:
context.answerInlineQuery(
[
{
type: 'photo',
id: 'UNIQUE_ID',
photo_file_id: 'FILE_ID',
title: 'PHOTO_TITLE',
},
{
type: 'audio',
id: 'UNIQUE_ID',
audio_file_id: 'FILE_ID',
caption: 'AUDIO_TITLE',
},
],
{
cache_time: 1000,
}
);
- [changed] Improve config schema validation.
- [experimental] add Slack RTM API support:
const { SlackBot } = require('bottender');
const bot = new SlackBot({
accessToken: '__FILL_YOUR_TOKEN_HERE__',
});
bot.onEvent(async (context) => {
await context.sendText('Hello World');
});
bot.createRtmRuntime();
- [new] Handle all of telegram event types includes:
message
edited_message
channel_post
edited_channel_post
inline_query
chosen_inline_result
callback_query
shipping_query
pre_checkout_query
- [new] Support group chat events.
- [new] Better handle Messenger getUserProfile failure #155
If getUserProfile
throw error, session.user
will fallback to have only id
and _updatedAt
keys.
- [new] Added more event parser and getter to telegram event #150
event.isEditedMessage
event.editedMessage
event.isChannelPost
event.channelPost
event.isEditedChannelPost
event.editedChannelPost
event.isInlineQuery
event.inlineQuery
event.isChosenInlineResult
event.chosenInlineResult
event.isShippingQuery
event.shippingQuery
event.isPreCheckoutQuery
event.preCheckoutQuery
- [new] Add
context.postEphemeral
:
context.postEphemeral({ text: 'hello' });
- [fix] Reply to thread instead of channel when receiving events in thread #145
- [fix] Use
message.chat.id
to reply #148
- [fix] Improve error handling in express middleware #142
- [new] Add optional
--yes
for Messenger force upload attachment #127 - [new] Initial State in test-utils #126
- [fix] Improve context simulator and add some tests #131
- [fix] Support Messenger webhook test requests #139
- [new] Support running Telegram bots with long polling #117
const { TelegramBot } = require('bottender');
const bot = new TelegramBot({
accessToken: '__FILL_YOUR_TOKEN_HERE__',
});
bot.onEvent(async (context) => {
await context.sendText('Hello World');
});
bot.createLongPollingRuntime({
limit: 100,
timeout: 60,
allowed_updates: ['message', 'callback_query'],
});
See more details in examples/telegram-long-polling
- [fix] Result destructing bugs in Telegram webhook commands
- [fix] ContextSimulator: sendState to setState #108
- [deprecated]
sendXXXWithDelay
is deprecated. UsesendXXX
withoptions.delay
instead.
- [fix] update messaging-api-messenger to fix empty array quick_replies bug
- [new] Add LINE
context.leave()
function for group and room #107
- [fix] Fix
context.sendVideoNote
usingmessaging-api-telegram
v0.6.5 - [new] Add context.methods:
sendMediaGroup:
context.sendMediaGroup([
{ type: 'photo', media: 'BQADBAADApYAAgcZZAfj2-xeidueWwI' },
]);
Payment API:
context.sendInvoice({
title: 'product name',
description: 'product description',
payload: 'bot-defined invoice payload',
provider_token: 'PROVIDER_TOKEN',
start_parameter: 'pay',
currency: 'USD',
prices: [
{ label: 'product', amount: 11000 },
{ label: 'tax', amount: 11000 },
],
});
Game API:
context.sendGame('Mario Bros.');
context.setGameScore(999);
context.getGameHighScores().then((result) => {
console.log(result);
/*
{
ok: true,
result: [
{
position: 1,
user: {
id: 427770117,
is_bot: false,
first_name: 'first',
},
score: 999,
},
],
};
*/
});
Introducing Viber Support to Bottender!
const { ViberBot } = require('bottender');
const { createServer } = require('bottender/express');
const bot = new ViberBot({
accessToken: '__FILL_YOUR_TOKEN_HERE__',
});
bot.onEvent(async (context) => {
if (context.event.isMessage) {
await context.sendText('Hello World');
}
});
const server = createServer(bot);
server.listen(5000, () => {
console.log('server is running on 5000 port...');
});
See viber-hello-world for more details.
- [new] Add
update-notifier
in CLI #99 - [deps] Update messaging API clients to
v0.6.x
.
- [fix] Fix domain whitelisting usage
- [fix] Check messenger menu item length #71
- [fix] Handle LINE webhook verify request in LineConnector #100
- [new] Add Slack signature validation #94
- [improve] Let slack connector handle promises parallelly #105
- [new] Add referral getters for
MessengerEvent
:
event.isReferral; // true or false
event.referral; // { source: 'SHORTLINK', type: 'OPEN_THREAD', ref: 'my_ref' }
event.ref; // 'my_ref'
- [new] Create
README.md
and.gitignore
whenbottender init
- [deps] Update messaging-apis to
v0.5.16
- [new] Add
event.isFromCustomerChatPlugin
getter - [new] Implement CLI attachment force upload #70
- [fix] Fix CLI profile bug
- [fix] Add huge like sticker support to isLikeSticker #67
- [fix] Use timingSafeEqual to validate signature #79
- [fix] Use timingSafeEqual to validate signature #79
- [new] Add
mapPageToAccessToken
to support multiple pages (Experimental) #47
new MessengerBot({
appSecret: '__FILL_YOUR_SECRET_HERE__',
mapPageToAccessToken: (pageId) => accessToken,
});
Note: API may changes between any versions.
- [new] Export
context.reply
andcontext.push
methods. #52 - [new] New CLI commands to sync LINE rich menus: #50
$ bottender line menu get
$ bottender line menu set
$ bottender line menu delete
- [new] Add support to interactive messages, and you can get action from it: #41
if (context.event.isInteractiveMessage) {
console.log(context.event.action);
}
- [new] A new command to upload your messenger attachments from
/assets
directory (in beta):
$ bottender messenger attachment upload
Then, you can import them with getAttachment
util function:
const { getAttachment } = require('bottender/utils');
console.log(getAttachment('mypic.jpg').id); // '1591074914293017'
- [new] Add
--force
option tobottender messenger profile set
(delete all and set all) - [fix] Fix file export for
test-utils.js
#44 - [fix] Refined affected methods in
withTyping
#35
- [fix] Stop passing
as_user: true
#33
- [new] Add
--skip-validate
cli option to skipJoi
schema validation #31 - [fix] Allow unknown keys in config and fix schema rules #29
- [new] Add options for
postMessage
#25
You can use it to send additional attachments, like below:
context.postMessage('I am a test message', {
attachments: [
{
text: "And here's an attachment!",
},
],
});
See official docs for more available options.
-
[new] Implement rich menu api methods on context #23
context.getLinkedRichMenu()
context.linkRichMenu(richMenuId)
context.unlinkRichMenu()
- [new] Add new send methods #19
context.sendMessage
context.sendTemplate
context.sendOpenGraphTemplate
context.sendMediaTemplate
- [new] Implement label api methods for targeting broadcast messages #18
context.associateLabel(labelId)
context.dissociateLabel(labelId)
context.getAssociatedLabels()
- [new] Implement thread control methods #15
context.passThreadControl(targetAppId, metadata)
context.passThreadControlToPageInbox
context.takeThreadControl
- [new] Send
messaging_type
asRESPONSE
when reply anything in the context. #12 - [deps] Upgrade Messaging APIs clients to latest.
First public release.