api-bot v0.0.1

api-bot

An api-bot is an customizable chat bot that can proxy with any APIs and transform the results into a bot message. A JSON or YAML config file is used to describe the both the interaction with the API and the transformation of the output. The config file/doc can also easily be served via a noSQL database.

This is a NodeJS library to handle various instructions for an api-bot.

Quick start

yarn add api-bot --save

API Reference

BotMsg

Module for handling messages from bot.

• BotMsg
  • .BaseCmd
    • new BaseCmd(payload, textAccessor)
    • .text ⇒ String
    • .payload ⇒ Object
    • .cmd ⇒ Object
    • .tokens ⇒ Array.<String>
  • .SlashCmd ⇐ BaseCmd
    • new SlashCmd(payload, textAccessor)
    • .text ⇒ String
    • .payload ⇒ Object
    • .cmd ⇒ Object
    • .tokens ⇒ Array.<String>

BotMsg.BaseCmd

Base class to parse message string into commands and arguments.

Kind: static class of BotMsg
Properties

• .BaseCmd
  • new BaseCmd(payload, textAccessor)
  • .text ⇒ String
  • .payload ⇒ Object
  • .cmd ⇒ Object
  • .tokens ⇒ Array.<String>

new BaseCmd(payload, textAccessor)

Create a new BaseCmd instance.

baseCmd.text ⇒ String

Kind: instance property of BaseCmd
Returns: String - text message from the payload

baseCmd.payload ⇒ Object

Kind: instance property of BaseCmd
Returns: Object - payload payload from bot.

baseCmd.cmd ⇒ Object

Kind: instance property of BaseCmd
Returns: Object - cmd Command string.

baseCmd.tokens ⇒ Array.<String>

Kind: instance property of BaseCmd
Returns: Array.<String> - tokens Argument tokens.

BotMsg.SlashCmd ⇐ BaseCmd

Class to extract a slash command string (i.e. /hello) and the argument tokens from a text message.

Kind: static class of BotMsg
Extends: BaseCmd

• .SlashCmd ⇐ BaseCmd
  • new SlashCmd(payload, textAccessor)
  • .text ⇒ String
  • .payload ⇒ Object
  • .cmd ⇒ Object
  • .tokens ⇒ Array.<String>

new SlashCmd(payload, textAccessor)

Create a new SlashCmd instance.

slashCmd.text ⇒ String

Kind: instance property of SlashCmd
Returns: String - text message from the payload

slashCmd.payload ⇒ Object

Kind: instance property of SlashCmd
Returns: Object - payload payload from bot.

slashCmd.cmd ⇒ Object

Kind: instance property of SlashCmd
Returns: Object - cmd Command string.

slashCmd.tokens ⇒ Array.<String>

Kind: instance property of SlashCmd

Returns: Array.<String> - tokens Argument tokens.

FbHook

Module for handling Facebook messenger hooks.

• FbHook
  • FbHook ⏏
    • static
      • .send(id, payload) ⇒ Promise
      • .process(cmds, botCmd) ⇒ Promise
    • inner
      • ~Attachment : Object
      • ~QuickReply : Object
      • ~Message : Object
      • ~Recipient : Object
      • ~Payload : Object

FbHook ⏏

Utility class to handle Facebook messenger APIs.

Kind: Exported class

FbHook.send(id, payload) ⇒ Promise

Utility class to handle Facebook messenger APIs.

Kind: static method of FbHook

FbHook.process(cmds, botCmd) ⇒ Promise

Function to process a bot message from Facebook messenger.

Kind: static method of FbHook

FbHook~Attachment : Object

attachment object for response message to Facebook messenger. details

Kind: inner typedef of FbHook
Properties

FbHook~QuickReply : Object

quick_reply object for response message to Facebook messenger. details

Kind: inner typedef of FbHook
Properties

FbHook~Message : Object

message object for response message to Facebook messenger. details

Kind: inner typedef of FbHook
Properties

FbHook~Recipient : Object

payload object for response message to Facebook messenger.

Kind: inner typedef of FbHook
Properties

FbHook~Payload : Object

payload object for response message to Facebook messenger. details

Kind: inner typedef of FbHook
Properties