satori-rtm-sdk
satori-rtm-sdk
npm i satori-rtm-sdk
satori-rtm-sdk

satori-rtm-sdk

JavaScript SDK for Satori RTM

by satori-com

1.2.2 (see all)License:SEE LICENSE IN LICENSETypeScript:Built-In
npm i satori-rtm-sdk
Readme

JavaScript SDK for Satori RTM

Use the JavaScript SDK for the Satori RTM to create browser-based applications or server-based applications running within Node.js. The applications use the RTM to publish and subscribe.

JavaScript SDK Installation

Browser Installation

To use the JavaScript SDK from a browser-based application, include the SDK from the CDN and create an RTM client instance:

<script src="https://satori-a.akamaihd.net/satori-rtm-sdk/v1.2.2/sdk.min.js"></script>

and then

// create an RTM client instance
var rtm = new RTM("YOUR_ENDPOINT", "YOUR_APPKEY");

Note: You can find the application key and endpoint on the Appkey Info page for your app in the Dev Portal.

Node.js Installation

  1. Install the JavaScript SDK with the following command from NPM:
npm install 'satori-rtm-sdk'
  1. In your application file <app_name>.js, use the following code to create an RTM client instance:
var RTM = require("satori-rtm-sdk");

// create an RTM client instance
var rtm = new RTM("YOUR_ENDPOINT", "YOUR_APPKEY");

Note: You can find the application key and endpoint for your app in the Dev Portal.

JavaScript Sample Code

// create a new subscription with "your-channel" name
var channel = rtm.subscribe("your-channel", RTM.SubscriptionMode.SIMPLE);

// add channel data handlers

// channel receives any published message
channel.on("rtm/subscription/data", function(pdu) {
    pdu.body.messages.forEach(console.log);
});

// client enters 'connected' state
rtm.on("enter-connected", function() {
    rtm.publish("your-channel", {key: "value"});
});

// client receives any PDU and PDU is passed as a parameter
rtm.on("data", function(pdu) {
    if (pdu.action.endsWith("/error")) {
        rtm.restart();
    }
});

// start the client
rtm.start();

Documentation

You can view the latest JavaScript SDK documentation here.

Generating API docs

$ npm run docs

The generated API documentation will apear in the ./docs folder.

Assembling from sources

$ git clone https://github.com/satori-com/satori-rtm-sdk-js.git
$ cd satori-rtm-sdk
$ npm install
$ npm run build

The assembled JS output will appear in the ./dist/ directory.

Binary data support

RTM supports the CBOR subprotocol to work with binary data. Binary data is represented as Uint8Array.

An example to work with binary data:
var client = new RTM("YOUR_ENDPOINT", "YOUR_APPKEY", {protocol: 'cbor'});

client.on('enter-connected', function () {
  var message = {
    who: 'zebra',
    where: new Uint8Array([1,2,3,4,5])
  };
  client.publish('animals', message, function (pdu) {
    console.log('Message published:', pdu);
  });
});

client.start();

Using HTTPS Proxy (NodeJS only)

The SDK supports working through an https (not http) proxy.

When creating a new client specify proxyAgent in options like this:

var client = new RTM(endpoint, appKey, {
    proxyAgent: proxyAgent
});

Use any custom http.Agent implementation like:

NodeJS example with using https-proxy-agent:

var HttpsProxyAgent = require('https-proxy-agent');

var client = new RTM("YOUR_ENDPOINT", "YOUR_APPKEY", {
    proxyAgent: HttpsProxyAgent('http://127.0.0.1:3128')
});

Verbose logging of all incoming and outcoming PDUs

You can enable dumping of all PDUs either from your code

var RTM = require("satori-rtm-sdk");
RTM.logger.DEBUG = true;

// create an RTM client instance
var rtm = new RTM("YOUR_ENDPOINT", "YOUR_APPKEY");

or by setting DEBUG_SATORI_SDK environment variable prior to running your application

$ export DEBUG_SATORI_SDK=true
$ node myapp.js

Testing

The SDK includes an integration test suite. The tests connect to RTM, so you need to provide RTM credentials.

The credentials.json file must include the following key-value pairs:

{
  "endpoint": "YOUR_ENDPOINT",
  "appkey": "YOUR_APPKEY",
  "auth_role_name": "YOUR_ROLE",
  "auth_role_secret_key": "YOUR_SECRET",
  "auth_restricted_channel": "YOUR_RESTRICTED_CHANNEL"
}
  • endpoint is your customer-specific endpoint for RTM access.
  • appkey is your application key.
  • auth_role_name is a role name that permits to publish / subscribe to auth_restricted_channel. Must be not default.
  • auth_role_secret_key is a secret key for auth_role_name.
  • auth_restricted_channel is a channel with subscribe and publish access for auth_role_name role only.

After setting up credentials.json, just type npm test at the command line.

Downloads/wk

3

GitHub Stars

21

LAST COMMIT

5yrs ago

MAINTAINERS

1

CONTRIBUTORS

11

OPEN ISSUES

1

OPEN PRs

2
VersionTagPublished
1.2.2
latest
5yrs ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate