Toolkit for developing applications for the Messenger platform written in TypeScript.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
lib
test
.editorconfig
.gitignore
LICENSE
README.md
index.ts
modules.d.ts
package-lock.json
package.json
tsconfig.json

README.md

typed-messenger-platform

Toolkit for developing applications for the Messenger platform written in TypeScript.

State

In active development. Feel free to open an issue if you would like to contribute or check out existing issues.

Principles

  • follow the original API as closely as possible and provide type information
  • de-couple server (for receiving webhooks), client (for sending messages etc) and message builder parts (POJO)

Goals

Setup

To interact with the messenger platform you require a fb app connected to a page. Set up a webhook connecting the page with your server. To install the module:

npm i typed-messenger-platform

Usage

Echo bot:

import http = require('http');
import * as platform from 'typed-messenger-platform';

const PAGE_TOKEN = 'TOKEN';

const { sendMessage, messageTo } = platform;

const fbServer = platform
  // initial configuration is passed via createServer
  .createServer({
    verificationToken: 'YOUR TOKEN',
  })
  // handle messages of specific types with .onTextMessage, .onLocationMessage etc
  .onTextMessage(
    async (testMessage: platform.webhookApi.MessageReceivedEvent) => {
      // decide
      // - when to construct a message (with the builder interface `messageTo`)
      // - when to actually send a message (with `sendMessage` call)
      // - whether to process synchronously or concurrently (with await)
      await sendMessage(
        PAGE_TOKEN,
        messageTo(testMessage.sender).text(
          testMessage.message.text || 'No message',
        ),
      );
    },
  );

// call .done to get node http compatible handler
http.createServer(fbServer.done()).listen(3000);

// monitor errors asynchronously
fbServer.on('error', (err: Error) => {
  console.log('error', err);
})

Message builder interface allows chaining calls to build a message:

messageTo(recipient)
  .text('Answer the question: Where is Berlin?')
  .quickTextReply('Germany', 'GER')
  .quickLocationReply();

Also see examples.

The following message handlers (on[MessageType]Message) are available:

  • onTextMessage - fired if the message contains text
  • onLocationMessage - fired if the message contains a location attachment
  • onAudioMessage - fired if the message contains an audio attachment
  • onVideoMessage - fired if the message contains a video attachment
  • onFileMessage - fired if the message contains a file attachment
  • onImageMessage - fired if the message contains a image attachment
  • onUnknownMessage - fired for every message of unknown type
  • onAnyMesage - fired for every message of known type

The messages are evaluated in order and only one of the handlers is called for any given message, the one that matches first. Exceptions are onAnyMesage which is fired always for any message of known type (even if a more specific handlers were already called) and onUnknownMessage which is called for every message of unknown type.

LICENCE

MIT