bottender-compose

bottender-compose

An utility library for Bottender and higher-order handlers

Installation

npm install bottender-compose

API Reference

series

Create a function that executes methods in series.

const { series, sendText } = require('bottender-compose');

bot.onEvent(
  series([
    sendText('1. First Item'),
    sendText('2. Second Item'),
    sendText('3. Third Item'),
  ])
);

parallel

Create a function that executes methods in parallel.

const { parallel, sendText } = require('bottender-compose');

bot.onEvent(
  parallel([
    sendText('- You got one of Items'),
    sendText('- You got one of Items'),
    sendText('- You got one of Items'),
  ])
);

random

Create a function that executes one of method randomly.

const { random, sendText } = require('bottender-compose');

bot.onEvent(
  random([
    sendText('You got a random item: A'),
    sendText('You got a random item: B'),
    sendText('You got a random item: C'),
  ])
);

branch

Create a function that will process either the onTrue or the onFalse function depending upon the result of the condition predicate.

const { branch, sendText } = require('bottender-compose');

bot.onEvent(
  branch(
    context => true,
    sendText('You are the lucky one.'),
    sendText('Too bad.')
  )
);

Or you can executes function on true and do nothing when received false.

branch(context => true, sendText('You are the lucky one.'));

condition

Create a function that encapsulates if/else, if/else, ... logic.

const { condition, sendText } = require('bottender-compose');

bot.onEvent(
  condition([
    [context => false, sendText('a')],
    [context => false, sendText('b')],
    [context => true, sendText('c')],
  ])
);

platform

Create a function that will process function depending upon the platform context.

const {
  platform,
  sendGenericTemplate,
  sendImagemap,
} = require('bottender-compose');

bot.onEvent(platform({
  messenger: sendGenericTemplate(...),
  line: sendImagemap(...),
}));

Or you can use others key to match other platforms:

platform({
  messenger: sendGenericTemplate(...),
  line: sendImagemap(...),
  others: sendText('Unsupported.'),
});

tryCatch

Create a function that calls error handler on error.

const { tryCatch, sendText } = require('bottender-compose');

bot.onEvent(
  tryCatch(doSomethingMayFail(), sendText('Error Happened~~~~~~~~~~~!'))
);

weight

Create a function that randomly executes one of method by its weight.

const { weight, sendText } = require('bottender-compose');

bot.onEvent(
  weight([
    [0.2, sendText('20%')],
    [0.4, sendText('40%')],
    [0.4, sendText('40%')],
  ])
);

doNothing

Create a no-op function.

const { branch, sendText, doNothing } = require('bottender-compose');

bot.onEvent(
  branch(
    context => false,
    sendText('You are the lucky one.'),
    doNothing() // do exactly nothing...
  )
);

repeat

Create a function that executes the method repeatedly.

const { repeat, sendText } = require('bottender-compose');

bot.onEvent(repeat(3, sendText('This will be sent 3 times.')));

delay

Create a function that executes methods after a number of milliseconds.

const { series, delay, sendText } = require('bottender-compose');

bot.onEvent(
  B.series([
    B.sendText('1. First Item'),
    B.delay(1000);
    B.sendText('2. Second Item'),
    B.delay(1000);
    B.sendText('3. Third Item'),
  ])
);

Context Methods

Common

• setState
• resetState
• typing

Messenger

• sendMessage
• sendText
• sendAttachment
• sendAudio
• sendImage
• sendVideo
• sendFile
• sendTemplate
• sendButtonTemplate
• sendGenericTemplate
• sendListTemplate
• sendOpenGraphTemplate
• sendMediaTemplate
• sendReceiptTemplate
• sendAirlineBoardingPassTemplate
• sendAirlineCheckinTemplate
• sendAirlineItineraryTemplate
• sendAirlineFlightUpdateTemplate
• sendSenderAction
• markSeen
• typingOn
• typingOff
• passThreadControl
• passThreadControlToPageInbox
• takeThreadControl
• associateLabel
• dissociateLabel
• getAssociatedLabels

LINE

• sendText
• sendImage
• sendVideo
• sendAudio
• sendLocation
• sendSticker
• sendImagemap
• sendButtonTemplate
• sendConfirmTemplate
• sendCarouselTemplate
• sendImageCarouselTemplate
• reply
• replyText
• replyImage
• replyVideo
• replyAudio
• replyLocation
• replySticker
• replyImagemap
• replyButtonTemplate
• replyConfirmTemplate
• replyCarouselTemplate
• replyImageCarouselTemplate
• push
• pushText
• pushImage
• pushVideo
• pushAudio
• pushLocation
• pushSticker
• pushImagemap
• pushButtonTemplate
• pushConfirmTemplate
• pushCarouselTemplate
• pushImageCarouselTemplate
• getLinkedRichMenu
• linkRichMenu
• unlinkRichMenu

Slack

• sendText
• postMessage

Telegram

• sendText
• sendMessage
• sendPhoto
• sendAudio
• sendDocument
• sendSticker
• sendVideo
• sendVoice
• sendVideoNote
• sendMediaGroup
• sendLocation
• sendVenue
• sendContact
• sendChatAction
• sendInvoice
• sendGame
• setGameScore

Viber

• sendMessage
• sendText
• sendPicture
• sendVideo
• sendFile
• sendContact
• sendLocation
• sendURL
• sendSticker
• sendCarouselContent

Facebook

• sendComment
• sendPrivateReply

Passing Function as Argument to Context Method

You can pass function as argument to handle time-specified or context-specified case, for example:

// Lazy execution
B.sendText(() => `Now: ${new Date()}`);

// Use user information on context
B.sendText(
  context =>
    `${context.session.user.first_name} ${
      context.session.user.last_name
    }, You are the lucky one.`
);

// Use event information
B.sendText(context => `Received: ${context.event.text}`);

License

MIT © Yoctol

Changelog

0.6.0 / 2018-03-21

• [new] Support passing function as argument to context methods:

You can pass function as argument to handle time-specified or context-specified case, for example:

// Lazy execution
B.sendText(() => `Now: ${new Date()}`);

// Use user information on context
B.sendText(
  context =>
    `${context.session.user.first_name} ${context.session.user.last_name}, You are the lucky one.`
);

// Use event information
B.sendText(context => `Received: ${context.event.text}`);