• Stars
    star
    105
  • Rank 328,196 (Top 7 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 13 years ago
  • Updated about 6 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Essential XMPP middleware for Node.js.

Junction

Junction is an extensible XMPP middleware layer for Node. Highly scalable applications can be constructed by assembling sets of "plugins" known as middleware and filters. Middleware process incoming stanzas, while filters process outgoing stanzas.

This architecture has been proven effective by Connect, which provides HTTP middleware. Junction adopts this approach, repurposing it for use in XMPP, allowing XMPP applications to be built quickly and easily, while harnessing the powerful patterns familiar to Node.js developers.

Installation

$ npm install junction

Usage

Create an Application

To create a new application, simply invoke junction(). Use the built in message and presence parsing middleware to parse common stanzas.

var app = junction()
  .use(junction.messageParser())
  .use(junction.presenceParser());

Handle Stanzas

Use additional middleware to define your application's behavior. In this example, the built in message middleware is used to handle chat messages. Anytime a message is received, we send a greeting and echo the message body.

app.use(junction.message(function(handler) {
  handler.on('chat', function(stanza) {
    var msg = new Message(stanza.from);
    msg.c('body', {}).t('Hello ' + stanza.from + '!\n\n' +
                        'You said: ' + stanza.body);
    stanza.connection.send(msg);
  });
}));

Junction provides bundled middleware to handle core XMPP functionality. Additional middleware and higher-level frameworks are available as separate modules.

Trailing Middleware

Conclude the app by using the typical trailing middleware:

app.use(junction.serviceUnavailable())
   .use(junction.errorHandler());

serviceUnavailable middleware responds with a service-unavailable stanza error when other XMPP entities send the application a request that it doesn't support. This is recommended for well-behaved XMPP applications.

errorHandler middleware will respond with stanza errors when the application encounters an error condition.

These middleware should be used last in the stack, ensuring that other middleware take priority.

Connect to XMPP Network

With the app configured, connect to the XMPP network.

app.connect({ jid: '[email protected]', password: 's3cr3t' }).on('online', function() {
  console.log('connected as: ' + this.jid);
  this.send(new Presence());
});

Junction uses node-xmpp for the underlying connection, allowing apps to connect as clients, components, or any other supported connection type.

Frameworks

At its core, XMPP is a protocol that allows structured data to be exchanged in real-time between entities on the network. While typically used for instant messaging and presence, numerous XMPP extension protocols (known as XEPs) are available which make XMPP broadly applicable to non-IM applications.

These XEPs build on XMPP's core, while defining their own higher-level semantics. Junction-based frameworks implement support for these extensions, building on essential middleware and enhancing it with tooling designed to support development of applications making use of the XEP.

FrameworkDescription
DiscoService Discovery (XEP-0030) framework.
PubSubPublish-Subscribe (XEP-0060) framework.

Middleware

Additional middleware is available to parse non-core extension elements commonly found in stanzas. Some middleware implement complete support for simple XEPs that don't justify the need for a full-fledged framework.

MiddlewareDescription
junction-attentionAttention (XEP-0224) middleware.
junction-delayDelayed Delivery (XEP-0203) middleware.
junction-lastactivityLast Activity (XEP-0012) middleware.
junction-legacy-delayLegacy Delayed Delivery (XEP-0091) middleware.
junction-legacy-timeLegacy Entity Time (XEP-0090) middleware.
junction-nicknameUser Nickname (XEP-0172) middleware.
junction-pingXMPP Ping (XEP-0199) middleware.
junction-softwareversionSoftware Version (XEP-0092) middleware.
junction-timeEntity Time (XEP-0202) middleware.
junction-capsEntity Capabilities (XEP-0115) middleware.

Tests

$ npm install --dev
$ make test

Build Status

Credits

License

The MIT License

Copyright (c) 2011-2017 Jared Hanson <http://jaredhanson.net/>

Sponsor

More Repositories

1

passport

Simple, unobtrusive authentication for Node.js.
JavaScript
21,911
star
2

oauth2orize

OAuth 2.0 authorization server toolkit for Node.js.
JavaScript
3,417
star
3

passport-local

Username and password authentication strategy for Passport and Node.js.
JavaScript
2,669
star
4

passport-facebook

Facebook authentication strategy for Passport and Node.js.
JavaScript
1,281
star
5

connect-flash

Flash message middleware for Connect and Express.
JavaScript
1,225
star
6

passport-http-bearer

HTTP Bearer authentication strategy for Passport and Node.js.
JavaScript
946
star
7

locomotive

Powerful MVC web framework for Node.js.
JavaScript
892
star
8

passport-google-oauth2

Google authentication strategy for Passport and Node.js.
JavaScript
808
star
9

passport-google-oauth

Google authentication strategies for Passport and Node.js.
JavaScript
753
star
10

passport-oauth2

OAuth 2.0 authentication strategy for Passport and Node.js.
JavaScript
575
star
11

electrolyte

Elegant dependency injection for Node.js.
JavaScript
563
star
12

passport-github

GitHub authentication strategy for Passport and Node.js.
JavaScript
528
star
13

passport-twitter

Twitter authentication strategy for Passport and Node.js.
JavaScript
467
star
14

connect-ensure-login

Login session ensuring middleware for Connect and Express.
JavaScript
465
star
15

passport-http

HTTP Basic and Digest authentication strategies for Passport and Node.js.
JavaScript
265
star
16

passport-remember-me

Remember Me cookie authentication strategy for Passport and Node.js
JavaScript
217
star
17

oauthorize

OAuth service provider toolkit for Node.js.
JavaScript
200
star
18

deamdify

Browserify transform that converts AMD to CommonJS.
JavaScript
198
star
19

passport-openidconnect

OpenID Connect authentication strategy for Passport and Node.js.
JavaScript
181
star
20

passport-instagram

Instagram authentication strategy for Passport and Node.js.
JavaScript
172
star
21

passport-totp

TOTP authentication strategy for Passport and Node.js.
JavaScript
147
star
22

passport-google

Google (OpenID) authentication strategy for Passport and Node.js.
JavaScript
146
star
23

passport-linkedin

LinkedIn authentication strategy for Passport and Node.js.
JavaScript
141
star
24

passport-oauth

OAuth 1.0 and 2.0 authentication strategies for Passport and Node.js.
JavaScript
117
star
25

passport-strategy

An abstract class implementing Passport's strategy API.
Makefile
107
star
26

passport-openid

OpenID authentication strategy for Passport and Node.js.
JavaScript
100
star
27

passport-oauth2-client-password

OAuth 2.0 client password authentication strategy for Passport and Node.js.
JavaScript
96
star
28

kerouac

Poetic static site generator for Node.js.
JavaScript
82
star
29

utils-merge

merge() utility function
JavaScript
71
star
30

passport-http-oauth

HTTP OAuth authentication strategy for Passport and Node.js.
JavaScript
70
star
31

bootable

Easy application initialization for Node.js.
JavaScript
68
star
32

oauth2orize-openid

Extensions to support OpenID Connect with OAuth2orize.
JavaScript
62
star
33

passport-anonymous

Anonymous authentication strategy for Passport and Node.js.
Makefile
59
star
34

passport-browserid

BrowserID authentication strategy for Passport and Node.js.
JavaScript
53
star
35

passport-webauthn

WebAuthn authentication strategy for Passport.
JavaScript
45
star
36

passport-soundcloud

SoundCloud authentication strategy for Passport and Node.js.
JavaScript
38
star
37

passport-amazon

Amazon authentication strategy for Passport and Node.js.
JavaScript
37
star
38

node-parent-require

Require modules from parent modules.
JavaScript
35
star
39

passport-windowslive

Windows Live authentication strategy for Passport and Node.js.
JavaScript
34
star
40

chai-passport-strategy

Helpers for testing Passport strategies with the Chai assertion library.
JavaScript
33
star
41

passport-fitbit

Fitbit authentication strategy for Passport and Node.js.
JavaScript
32
star
42

passport-tumblr

Tumblr authentication strategy for Passport and Node.js.
JavaScript
30
star
43

passport-dropbox

Dropbox authentication strategy for Passport and Node.js.
JavaScript
29
star
44

passport-paypal-oauth

PayPal (OAuth) authentication strategy for Passport and Node.js.
JavaScript
28
star
45

passport-bitbucket

Bitbucket authentication strategy for Passport and Node.js.
JavaScript
26
star
46

passport-oauth1

OAuth 1.0 authentication strategy for Passport and Node.js.
JavaScript
23
star
47

passport-foursquare

Foursquare authentication strategy for Passport and Node.js.
JavaScript
22
star
48

node-notifications

A mechanism for dispatching notifications within a Node.js program.
JavaScript
22
star
49

passport-goodreads

Goodreads authentication strategy for Passport and Node.js.
JavaScript
21
star
50

passport-yahoo-oauth

Yahoo! (OAuth) authentication strategy for Passport and Node.js.
JavaScript
19
star
51

passport-persona

Mozilla Persona authentication strategy for Passport and Node.js.
JavaScript
19
star
52

locomotive-mongoose

Mongoose datastore adapter for Locomotive.
JavaScript
18
star
53

passport-runkeeper

RunKeeper authentication strategy for Passport and Node.js.
JavaScript
18
star
54

node-jsonsp

JSON stream parser for Node.js.
JavaScript
17
star
55

node-jsonrpc-tcp

JSON-RPC over TCP for Node.js.
JavaScript
16
star
56

passport-intuit-oauth

Intuit (OAuth) authentication strategy for Passport and Node.js.
JavaScript
15
star
57

passport-evernote

Evernote authentication strategy for Passport and Node.js.
JavaScript
15
star
58

passport-ethereum

Ethereum authentication strategy for Passport.
JavaScript
15
star
59

passport-meetup

Meetup authentication strategy for Passport and Node.js.
JavaScript
15
star
60

passport-google-openidconnect

Google authentication strategy for Passport and Node.js.
JavaScript
14
star
61

crane

Diligent work queue for Node.js.
JavaScript
13
star
62

rivet

Efficient build tool utilizing JavaScript and Node.js.
JavaScript
13
star
63

connect-powered-by

X-Powered-By header middleware for Connect.
JavaScript
11
star
64

passport-yammer

Yammer authentication strategy for Passport and Node.js.
JavaScript
11
star
65

passport-hotp

HOTP authentication strategy for Passport and Node.js.
JavaScript
11
star
66

passport-paypal

PayPal (OpenID) authentication strategy for Passport and Node.js.
JavaScript
10
star
67

passport-intuit

Intuit (OpenID) authentication strategy for Passport and Node.js.
JavaScript
10
star
68

js-sasl

SASL mechanism factory.
JavaScript
10
star
69

node-tokens

Encode and decode security tokens.
JavaScript
9
star
70

draft-oauth-mfa

9
star
71

passport-openstreetmap

OpenStreetMap authentication strategy for Passport and Node.js.
JavaScript
9
star
72

node-servicelocator

Central location to register and locate services within a Node.js application.
JavaScript
9
star
73

passport-dwolla

Dwolla authentication strategy for Passport and Node.js.
JavaScript
9
star
74

todos-fastify-sqlite

Todo app built with Node.js, Fastify, and SQLite.
CSS
9
star
75

passport-angellist

AngelList authentication strategy for Passport and Node.js.
JavaScript
8
star
76

make-node

Useful makefiles for developing Node.js packages.
Makefile
8
star
77

chai-connect-middleware

Helpers for testing Connect middleware with the Chai assertion library.
JavaScript
8
star
78

todos-express-sqlite

Todo app built with Node.js, Express, and SQLite.
CSS
7
star
79

passport-familysearch

FamilySearch authentication strategy for Passport and Node.js.
JavaScript
7
star
80

oauth2orize-mfa

Multi-Factor Authentication exchanges for OAuth2orize.
JavaScript
6
star
81

flowstate

Per-request state management middleware.
JavaScript
6
star
82

suitcss-utils-space

Utility classes for low-level CSS spacing traits
CSS
6
star
83

passport-fido-u2f

FIDO U2F authentication strategy for Passport and Node.js.
JavaScript
6
star
84

passport-rdio

Rdio authentication strategy for Passport and Node.js.
JavaScript
6
star
85

passport-37signals

37signals authentication strategy for Passport and Node.js.
JavaScript
6
star
86

oauth2orize-pkce

Extensions to support Proof Key for Code Exchange with OAuth2orize.
JavaScript
6
star
87

node-ffi-ipmi

wrapping various ipmi related tools and libs for node via node-ffi @ https://github.com/rbranson/node-ffi.git
C
6
star
88

node-functionpool

Provides a pool of functions that can be used to execute tasks in Node.js.
JavaScript
5
star
89

connect-lrdd

Link-based Resource Descriptor Document (LRDD) middleware for Connect.
JavaScript
5
star
90

dotfiles

$HOME
Shell
5
star
91

passport-vimeo

Vimeo authentication strategy for Passport and Node.js.
JavaScript
5
star
92

amd-resolve

A hookable AMD module resolution implementation.
JavaScript
5
star
93

passport-ssl-certificate

SSL certificate authentication strategy for Passport and Node.js.
JavaScript
5
star
94

node-nks-fs

Secure key services.
JavaScript
5
star
95

marked-engine

Express-compatible Markdown rendering powered by marked.
JavaScript
5
star
96

chai-oauth2orize-grant

Helpers for testing OAuth2orize grants with the Chai assertion library.
JavaScript
5
star
97

oauth2orize-device-code

Extensions to support device flow with OAuth2orize.
JavaScript
5
star
98

oauth2orize-redelegate

Token redelegation and chaining exchange for OAuth2orize.
JavaScript
5
star
99

passport-web3

Web3 authentication strategy for Passport.
JavaScript
5
star
100

pocket

A simple, small, file system-based data store for Node.js.
JavaScript
4
star