Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orkon/typed-messenger-platform
Toolkit for developing applications for the Messenger platform written in TypeScript.
https://github.com/orkon/typed-messenger-platform
message-builder messenger-platform typescript
Last synced: 21 days ago
JSON representation
Toolkit for developing applications for the Messenger platform written in TypeScript.
- Host: GitHub
- URL: https://github.com/orkon/typed-messenger-platform
- Owner: OrKoN
- License: mit
- Created: 2017-10-29T17:18:13.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-04T15:10:36.000Z (about 7 years ago)
- Last Synced: 2024-05-08T20:38:10.416Z (6 months ago)
- Topics: message-builder, messenger-platform, typescript
- Language: TypeScript
- Homepage:
- Size: 104 KB
- Stars: 16
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typed-messenger-platform
Toolkit for developing applications for the [Messenger platform](https://developers.facebook.com/docs/messenger-platform) written in TypeScript.
### State
In active development. Feel free to [open an issue](https://github.com/OrKoN/typed-messenger-platform/issues/new) if you would like to contribute or check out [existing issues](https://github.com/OrKoN/typed-messenger-platform/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
- full support for [Send API](https://developers.facebook.com/docs/messenger-platform/reference/send-api), [message received events](https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messages), [messaging_postbacks](https://developers.facebook.com/docs/messenger-platform/reference/webhook-events/messaging_postbacks) (not fully implemented yet)
- helpers to de-duplicate and queue messages
- the support for the rest of APIs if required
## 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:
```sh
npm i typed-messenger-platform
```
## Usage
Echo bot:
```typescript
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:
```typescript
messageTo(recipient)
.text('Answer the question: Where is Berlin?')
.quickTextReply('Germany', 'GER')
.quickLocationReply();
```
Also see [examples](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](LICENCE)