stanza.io's Introduction

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.

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 npm run build:

$ npm install
$ npm run build

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

Getting Started

Find or install a server which supports XMPP over WebSocket (Prosody recommended).
Clone this repo with git clone https://github.com/legastero/stanza.io.git
Run npm install in the new stanza.io directory.
Run npm run build to create dist/stanzaio.browser.js.
Open demo.html in your browser.
Enter your connection info, click connect.
Use the JS console to play with the XMPP client (var client).

Echo Client Demo

var XMPP = require('stanza.io');

var client = XMPP.createClient({
    jid: '[email protected]',
    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();