smallSquirrel / stanza.io

Modern XMPP in the browser, with a JSON API

Stanza.io

Modern XMPP in the browser, with a JSON API.

What is this?

Stanza.io is a library for using modern XMPP in the browser, and it does that by exposing everything as JSON. Unless you insist, you have no need to ever see or touch any XML when using stanza.io.

Important Protocol Changes

Starting with v4.0.0, stanza.io is using the protocol specified in RFC 7395 by default, which contains backwards incompatible changes.

Servers have started switching to using the RFC version of the WebSocket binding; notably, Prosody's WebSocket module for prosody-0.10. If your server has not yet been upgraded, you can set transports to ['old-websocket'] in the config:

var oldws = XMPP.createClient({
    ...
    transports: ['old-websocket']
});

Installing

$ npm install stanza.io

Building bundled/minified version (for AMD, etc)

First run npm install to get all of the dependencies, and then run make:

$ npm install
$ make

The bundled and minified files will be in the generated build directory.

Getting Started

1. Find or install a server which supports XMPP over WebSocket (Prosody recommended).
2. Run npm install in the node_modules/stanza.io directory.
3. Run make to build build/stanzaio.bundle.js.
4. Open demo.html in your browser.
5. Enter your connection info, click connect.
6. Use the JS console to play with the XMPP client (var client).

Echo Client Demo

var XMPP = require('stanza.io'); // if using browserify

var client = XMPP.createClient({
    jid: '[e-mail]',
    password: 'hunter2',

    // If you have a .well-known/host-meta.json file for your
    // domain, the connection transport config can be skipped.

    transport: 'websocket',
    wsURL: 'wss://example.com:5281/xmpp-websocket'
    // (or `boshURL` if using 'bosh' as the transport)
});

client.on('session:started', function () {
    client.getRoster();
    client.sendPresence();
});

client.on('chat', function (msg) {
    client.sendMessage({
      to: msg.from,
      body: 'You sent: ' + msg.body
    });
});

client.connect();

Documentation

• API Reference
• Supported XEPs
• Creating Plugins
• Using PubSub

License

MIT

Created By

If you like this, follow @lancestout on twitter.