node-xmpp

idiomatic XMPP library for node.js

Now usable in browsers too thanks to Browserify.

Sub-modules

We've split node-xmpp into a set of submodules, realistically its now one of these that you'll want to use rather than node-xmpp itself. This project remains so existing users can continue to use the project, and as a location for integration tests. New users should make use of the sub-modules.

node-xmpp-server

node-xmpp-client

node-xmpp-component

node-xmpp-core

Installation

Note: We now only support nodejs versions 0.8.0 and greater.

With package manager npm:

npm install node-xmpp

Testing

Install the dev dependencies, then...

npm test

To run the tests and the code style checks then use:

grunt test

Also see the tests run in travis. The tests in travis run both the code and code style tests.

How to use

Please see the various examples.

Objectives of node-xmpp:

• Use node.js conventions, especially EventEmitter, ie. for write buffer control
• Fast parsing, node-expat was written for this library
• Client support for both XMPP clients and components
• Optional server infrastructure with Router
• After authentication, leave trivial protocol bits to the user, that is XML handling according to any XEP

Features

• Client authentication with SASL DIGEST-MD5, PLAIN, ANONYMOUS, X-FACEBOOK-PLATFORM
• _xmpp-client._tcp SRV record support
• Simple JID parsing with Stringprep normalization
  • Optional now, you won't need ICU for just node-xmpp
  • Please be aware if you identify users by JIDs
  • npm install node-stringprep
• Uses ltx
  • Much easier to handle than a standard DOM
  • xmlns-aware
  • Easy XML builder like Strophe.js (see down)
  • Non-buffering serialization
  • Was split out of node-xmpp for modularization and resuability
• Component connections
• Run your own server/talk to other servers with xmpp.Router
• Even runs in the Browser.

Dependencies

• node-expat (requires libexpat!)
• ltx

Optional

• node-stringprep: for icu-based string normalization.

Built with node-xmpp

• Sockethub by using node-simple-xmpp
• hubot-xmpp
• superfeedr-node
• xmpp-ftw

Related Libraries

• node-xmpp-bosh: BOSH & websocket server (connection manager)
• node-xmpp-via-bosh: BOSH client connections from node.js
• node-simple-xmpp: Simpler high-level client layer
• xmpp-server: Reusable XMPP server on top of node-xmpp
• node-xmpp-joap: Jabber Object Access Protocol (XEP-0075) library for node-xmpp
• node-xmpp-serviceadmin: Service Administration (XEP-0133) library for node-xmpp
• Junction: An extensible XMPP middleware layer
• xmpp-ftw: XMPP For The Web ::: Powerful XMPP, simple JSON
• Lightstream: XMPP Framework

Design

Inheritance tree and associations:

┌────────────┐1     1┌────────────┐
│ net.Stream ├───────┤ Connection │
└────────────┘       └────────────┘
                           ↑
      ┌────────────┬───────┴───┬────────────┐
      │            │           │            │
┏━━━━━┷━━━━┓ ┏━━━━━┷━━━━━┓ ┌───┴────┐ ┌─────┴─────┐
┃  Client  ┃ ┃ Component ┃ │ Server │ │ C2SStream │
┗━━━━━━━━━━┛ ┗━━━━━━━━━━━┛ └────────┘ └───────────┘
                               ↑            ↑0..*
         ┌─────────────────────┤            │accepts
         │                     │            │1
┌────────┴───────┐ ┌───────────┴────┐ ┏━━━━━┷━━━━━┓
│ OutgoingServer │ │ IncomingServer │ ┃ C2SServer ┃
└─────────────┬──┘ └───┬────────────┘ ┗━━━━━┯━━━━━┛
         0..* │        │ 0..*               │
      creates │        │ accepts            │
             ┏┷━━━━━━━━┷┓                   │
             ┃  Router  ┃←──────────────────┘
             ┗━━━━━━━━━━┛ 1

This foundation is complemented by two basic data structures:

• JID: a Jabber-Id, represented as a triple of user, domain, resource
• Element: any XML Element

Building XML Elements

Strophe.js' XML Builder is very convenient for producing XMPP stanzas. ltx includes it in a much more primitive way: the c(), cnode() and t() methods can be called on any Element object, returning the new child element.

This can be confusing: in the end, you will hold the last-added child until you use up(), a getter for the parent. Connection.send() first invokes tree() to retrieve the uppermost parent, the XMPP stanza, before sending it out the wire.

Browser Support

node-xmpp now comes with a prebuilt browser bundle:

<script src="/node_modules/node-xmpp/node-xmpp-browser.js"></script>
<script type="text/javascript">
    var client = new XMPP.Client(opts);
</script>

Keepalives

Rather than send empty packets in order to keep any socket alive please try the following:

this.client.connection.socket.setTimeout(0)
this.client.connection.socket.setKeepAlive(true, 10000)

Where this.client is the result of new require('node-xmpp').Client().

Roadmap for future versions

• Events harmonization
• Common pause/resume/... for any Client/Component/Server session
• Smoothen reconnect
• Websockets server (at least for testing the client)
• Lookup BOSH URLs in DNS TXT records
• Move connecting to connection, use WS/BOSH as TCP fallback
• Use split-out srv library
• Ensure tls end/close/drain events
• Properly disconnect on stream errors, not on connection errors
• Tests for S2S connections
• Tests for Component connections (w/ Component server?)
• Find a browser-based demo app that can be switched from Strophe.js

Documentation

(Builing up documentation slowly)

C2S Client to Server

var client = new xmpp.Client({
    jid: 'user@example.com',
    password: 'password'
})

client.on('connection', function() {
    console.log('online')
})

client.on('stanza', function(stanza) {
    console.log('Incoming stanza: ', stanza.toString())
})

Closing a connection

client.end()