Skip to content
Permalink
Browse files

Rename `stanza.io` to `stanza`.

The new Web URL is https://stanzajs.org.

Version bumped to 11 for the name change, but otherwise identical to the
version 10 line of the old `stanza.io` package.
  • Loading branch information...
legastero committed Mar 15, 2019
1 parent 2b7590b commit b336440c697cd6b0b686942516fc9bdb30f5746f
Showing with 111 additions and 113 deletions.
  1. +5 −0 CHANGELOG.md
  2. +7 −7 README.md
  3. +2 −2 demo.html
  4. +5 −8 docs/Create_Plugin.md
  5. +1 −1 docs/JID.md
  6. +8 −8 docs/Reference.md
  7. +75 −76 docs/Supported_XEPs.md
  8. +2 −2 jingle-demo.html
  9. +3 −6 package.json
  10. +1 −1 src/plugins/disco.js
  11. +1 −1 src/plugins/version.js
  12. +1 −1 webpack.config.js
@@ -1,5 +1,10 @@
# Change Log

## 11.0.0

- **Changed package name from `stanza.io` to `stanza`.**
- The new website URL is https://stanzajs.org

## 10.0.0 -> 10.1.0

- Renamed `muc:affiliation` event to `muc:other`
@@ -1,20 +1,20 @@
# Stanza.io
# Stanza

**Modern XMPP in the browser, with a JSON API.**

<hr />

![](https://img.shields.io/npm/v/stanza.io.svg?style=flat) [![](https://img.shields.io/badge/endpoint.svg?url=https://stanza.io/discuss/badge.json&style=flat)](https://stanza.io/discuss/logs/)
![](https://img.shields.io/npm/v/stanza.svg?style=flat) [![](https://img.shields.io/badge/endpoint.svg?url=https://stanzajs.org/discuss/badge.json&style=flat)](https://stanzajs.org/discuss/logs/)

## 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.
Stanza 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.

## Installing

```sh
$ npm install stanza.io
$ npm install stanza
```

@@ -31,7 +31,7 @@ $ npm install stanza.io
## Echo Client Demo

```javascript
var XMPP = require('stanza.io');
var XMPP = require('stanza');
var client = XMPP.createClient({
jid: 'echobot@example.com',
@@ -70,7 +70,7 @@ client.connect();

## Discussion

MUC Room: [discuss@stanza.io](https://stanza.io/discuss/logs) / [Logs](https://stanza.io/discuss/logs)
MUC Room: [discuss@stanzajs.org](https://stanzajs.org/discuss/logs) / [Logs](https://stanzajs.org/discuss/logs)

## License

@@ -2,7 +2,7 @@
<html>
<head>
<meta charset="utf-8" />
<title>Stanza.io Demo</title>
<title>Stanza Demo</title>
<style>
html {
margin: 0px;
@@ -69,7 +69,7 @@
margin-right: 20px;
}
</style>
<script src="dist/stanzaio.browser.js"></script>
<script src="dist/stanza.browser.js"></script>
</head>
<body>
<h1 id="logTitle">Events &amp; Data</h1>
@@ -1,8 +1,7 @@
# Creating a Stanza.io Plugin


```javascript
module.exports = function (client, stanzas) {
module.exports = function(client, stanzas) {
// 1. Create and register our custom `mystanza` stanza type
var types = stanzas.utils;
@@ -17,14 +16,13 @@ module.exports = function (client, stanzas) {
}
});
stanzas.withMessage(function (Message) {
stanzas.withMessage(function(Message) {
stanzas.extend(Message, Foo);
});
// 2. Add API to the Stanza client for sending `mystanza` data
// 2. Add API to the stanza.io client for sending `mystanza` data
client.sendMyStanza = function (jid, foo) {
client.sendMyStanza = function(jid, foo) {
client.sendMessage({
to: jid,
mystanza: {
@@ -34,10 +32,9 @@ module.exports = function (client, stanzas) {
});
};
// 3. Listen for incoming `mystanza` data and emit our own event
client.on('message', function (msg) {
client.on('message', function(msg) {
if (msg.mystanza) {
client.emit('foo', msg);
}
@@ -24,7 +24,7 @@ client connection (i.e., a specific connection for the associated "bare JID" acc
## Usage

```javascript
const jid = require('stanza.io').jid;
const jid = require('stanza').jid;
const res = new jid.JID('user@example.com');
// or jid.create('user@example.com');
@@ -204,13 +204,13 @@ _Instantiating a client via this function will not load any built-in plugins._
- `options` - An object with the client configuration as described in [client options](#client-options).

```javascript
var XMPP = require('stanza.io');
var XMPP = require('stanza');
var client = new XMPP.Client({
jid: 'test@example.com',
password: 'hunter2'
});
// Loading plugins
var plugins = require('stanza.io/lib/plugins');
var plugins = require('stanza/plugins');
client.use(plugins);
```

@@ -223,7 +223,7 @@ _Instantiating a client via this function will load all built-in plugins._
- `options` - An object with the client configuration as described in [client options](#client-options).

```javascript
var XMPP = require('stanza.io');
var XMPP = require('stanza');
var client = XMPP.createClient({
jid: 'test@example.com',
password: 'hunter2'
@@ -259,8 +259,8 @@ When creating a client instance, the following settings will configure its behav
- `rosterVer` - version ID of cached roster data given by the server, typically saved from a previous session.
- `capsNode` - a URL for identifying the client app.
- `softwareVersion`
- `name` - the name of the client software using stanza.io
- `version` - the version of the client software using stanza.io
- `name` - the name of the client software using Stanza
- `version` - the version of the client software using Stanza
- `os` - the operating system that the client is running on
- `timeout` - number of seconds that IQ requests will wait for a response before generating a timeout error.
- `lang` - preferred language used by the client, such as `'en'` or `'de'`.
@@ -332,8 +332,8 @@ Note the `session:started`. You'll need to send your presence immediately to get

Options:

- `interval` - Client pings server every interval time. Default is every 300 seconds.
- `timeout` - Client will be disconnected if no response is received before the timeout time. Default is 15 seconds.
- `interval` - Client pings server every interval time. Default is every 300 seconds.
- `timeout` - Client will be disconnected if no response is received before the timeout time. Default is 15 seconds.

##### `client.disableKeepAlive()`

@@ -712,7 +712,7 @@ Example:
from: JID,
caps: {
hash: 'sha-1',
node: 'https://stanza.io',
node: 'https://stanzajs.org',
ver: 'rs/tl9NCfXBpKoOYUy+JdBbPGDg='
}
}
@@ -1,99 +1,98 @@
# Supported XEPs

- [XEP-0004: Data Forms](http://xmpp.org/extensions/xep-0004.html)
- [XEP-0030: Service Discovery](http://xmpp.org/extensions/xep-0030.html)
- [XEP-0045: Multi-User Chat](http://xmpp.org/extensions/xep-0045.html)
- [XEP-0048: Bookmarks](http://xmpp.org/extensions/xep-0048.html)
- [XEP-0004: Data Forms](http://xmpp.org/extensions/xep-0004.html)
- [XEP-0030: Service Discovery](http://xmpp.org/extensions/xep-0030.html)
- [XEP-0045: Multi-User Chat](http://xmpp.org/extensions/xep-0045.html)
- [XEP-0048: Bookmarks](http://xmpp.org/extensions/xep-0048.html)

Using private XML storage.

- [XEP-0049: Private XML Storage](http://xmpp.org/extensions/xep-0049.html)
- [XEP-0050: Ad-Hoc Commands](http://xmpp.org/extensions/xep-0050.html)
- [XEP-0049: Private XML Storage](http://xmpp.org/extensions/xep-0049.html)
- [XEP-0050: Ad-Hoc Commands](http://xmpp.org/extensions/xep-0050.html)

Partial support, for discovering available commands.

- [XEP-0054: vcard-temp](http://xmpp.org/extensions/xep-0054.html)
- [XEP-0054: vcard-temp](http://xmpp.org/extensions/xep-0054.html)

Partial support, for the most common vCard fields.

- [XEP-0059: Result Set Management](http://xmpp.org/extensions/xep-0059.html)
- [XEP-0060: Publish-Subscribe](http://xmpp.org/extensions/xep-0060.html)
- [XEP-0066: Out of Band Data](http://xmpp.org/extensions/xep-0066.html)
- [XEP-0077: In-Band Registration](http://xmpp.org/extensions/xep-0077.html)
- [XEP-0059: Result Set Management](http://xmpp.org/extensions/xep-0059.html)
- [XEP-0060: Publish-Subscribe](http://xmpp.org/extensions/xep-0060.html)
- [XEP-0066: Out of Band Data](http://xmpp.org/extensions/xep-0066.html)
- [XEP-0077: In-Band Registration](http://xmpp.org/extensions/xep-0077.html)

Support for registering/unregistering with services, and retrieving/updating your XMPP account information. Does **NOT** support in-band registration for new XMPP accounts.

- [XEP-0080: User Location](http://xmpp.org/extensions/xep-0080.html)
- [XEP-0082: XMPP Date and Time Profiles](http://xmpp.org/extensions/xep-0082.html)
- [XEP-0084: User Avatar](http://xmpp.org/extensions/xep-0084.html)
- [XEP-0085: Chat State Notifications](http://xmpp.org/extensions/xep-0085.html)
- [XEP-0092: Software Version](http://xmpp.org/extensions/xep-0092.html)
- [XEP-0106: JID Escaping](http://xmpp.org/extensions/xep-0106.html)
- [XEP-0107: User Mood](http://xmpp.org/extensions/xep-0107.html)
- [XEP-0115: Entity Capabilities](http://xmpp.org/extensions/xep-0115.html)
- [XEP-0118: User Tune](http://xmpp.org/extensions/xep-0118.html)
- [XEP-0122: Data Forms Validation](http://xmpp.org/extensions/xep-0122.html)
- [XEP-0124: Bidirectional-streams Over Synchronous HTTP (BOSH)](http://xmpp.org/extensions/xep-0124.html)
- [XEP-0128: Service Discovery Extensions](http://xmpp.org/extensions/xep-0128.html)
- [XEP-0131: Stanza Headers and Internet Metadata](http://xmpp.org/extensions/xep-0131.html)
- [XEP-0141: Data Forms Layout](http://xmpp.org/extensions/xep-0141.html)
- [XEP-0152: Reachability Addresses](http://xmpp.org/extensions/xep-0152.html)
- [XEP-0153: vCard-Based Avatars](http://xmpp.org/extensions/xep-0153.html)
- [XEP-0080: User Location](http://xmpp.org/extensions/xep-0080.html)
- [XEP-0082: XMPP Date and Time Profiles](http://xmpp.org/extensions/xep-0082.html)
- [XEP-0084: User Avatar](http://xmpp.org/extensions/xep-0084.html)
- [XEP-0085: Chat State Notifications](http://xmpp.org/extensions/xep-0085.html)
- [XEP-0092: Software Version](http://xmpp.org/extensions/xep-0092.html)
- [XEP-0106: JID Escaping](http://xmpp.org/extensions/xep-0106.html)
- [XEP-0107: User Mood](http://xmpp.org/extensions/xep-0107.html)
- [XEP-0115: Entity Capabilities](http://xmpp.org/extensions/xep-0115.html)
- [XEP-0118: User Tune](http://xmpp.org/extensions/xep-0118.html)
- [XEP-0122: Data Forms Validation](http://xmpp.org/extensions/xep-0122.html)
- [XEP-0124: Bidirectional-streams Over Synchronous HTTP (BOSH)](http://xmpp.org/extensions/xep-0124.html)
- [XEP-0128: Service Discovery Extensions](http://xmpp.org/extensions/xep-0128.html)
- [XEP-0131: Stanza Headers and Internet Metadata](http://xmpp.org/extensions/xep-0131.html)
- [XEP-0141: Data Forms Layout](http://xmpp.org/extensions/xep-0141.html)
- [XEP-0152: Reachability Addresses](http://xmpp.org/extensions/xep-0152.html)
- [XEP-0153: vCard-Based Avatars](http://xmpp.org/extensions/xep-0153.html)

Read only support. Use XEP-0084 instead for setting user avatars.

- [XEP-0156: Discovering Alternative XMPP Connection Methods](http://xmpp.org/extensions/xep-0156.html)
- [XEP-0156: Discovering Alternative XMPP Connection Methods](http://xmpp.org/extensions/xep-0156.html)

Support for the HTTP discovery method.

- [XEP-0163: Personal Eventing Protocol](http://xmpp.org/extensions/xep-0163.html)
- [XEP-0166: Jingle](http://xmpp.org/extensions/xep-0166.html)
- [XEP-0167: Jingle RTP Sesssions](http://xmpp.org/extensions/xep-0167.html)
- [XEP-0172: User Nickname](http://xmpp.org/extensions/xep-0172.html)
- [XEP-0176: Jingle ICE-UDP Transport Method](http://xmpp.org/extensions/xep-0176.html)
- [XEP-0184: Message Delivery Receipts](http://xmpp.org/extensions/xep-0184.html)
- [XEP-0186: Invisible Command](http://xmpp.org/extensions/xep-0186.html)
- [XEP-0191: Blocking Command](http://xmpp.org/extensions/xep-0191.html)
- [XEP-0198: Stream Management](http://xmpp.org/extensions/xep-0198.html)
- [XEP-0199: XMPP Ping](http://xmpp.org/extensions/xep-0199.html)
- [XEP-0202: Entity Time](http://xmpp.org/extensions/xep-0202.html)
- [XEP-0203: Delayed Delivery](http://xmpp.org/extensions/xep-0203.html)
- [XEP-0206: XMPP Over BOSH](http://xmpp.org/extensions/xep-0206.html)
- [XEP-0215: External Service Discovery](http://xmpp.org/extensions/xep-0215.html)
- [XEP-0221: Data Forms Media Element](http://xmpp.org/extensions/xep-0221.html)
- [XEP-0224: Attention](http://xmpp.org/extensions/xep-0224.html)
- [XEP-0231: Bits of Binary](http://xmpp.org/extensions/xep-0231.html)

Support for requesting bits. Responding to requests for bits is left to the application using stanza.io by listening to the `iq:get:bob` event.

- [XEP-0234: Jingle File Transfer](http://xmpp.org/extensions/xep-0234.html)
- [XEP-0249: Direct MUC Invitations](http://xmpp.org/extensions/xep-0249.html)
- [XEP-0264: File Transfer Thumbnails](http://xmpp.org/extensions/xep-0264.html)
- [XEP-0276: Presence Decloaking](http://xmpp.org/extensions/xep-0276.html)
- [XEP-0280: Message Carbons](http://xmpp.org/extensions/xep-0280.html)
- [XEP-0293: Jingle RTP Feedback Negotiation](http://xmpp.org/extensions/xep-0293.html)
- [XEP-0294: Jingle RTP Header Extensions Negotiation](http://xmpp.org/extensions/xep-0294.html)
- [XEP-0297: Stanza Forwarding](http://xmpp.org/extensions/xep-0297.html)
- [XEP-0300: Use of Cryptographic Hash Functions in XMPP](http://xmpp.org/extensions/xep-0300.html)
- [XEP-0301: In-Band Real Time Text](http://xmpp.org/extensions/xep-0301.html)
- [XEP-0163: Personal Eventing Protocol](http://xmpp.org/extensions/xep-0163.html)
- [XEP-0166: Jingle](http://xmpp.org/extensions/xep-0166.html)
- [XEP-0167: Jingle RTP Sesssions](http://xmpp.org/extensions/xep-0167.html)
- [XEP-0172: User Nickname](http://xmpp.org/extensions/xep-0172.html)
- [XEP-0176: Jingle ICE-UDP Transport Method](http://xmpp.org/extensions/xep-0176.html)
- [XEP-0184: Message Delivery Receipts](http://xmpp.org/extensions/xep-0184.html)
- [XEP-0186: Invisible Command](http://xmpp.org/extensions/xep-0186.html)
- [XEP-0191: Blocking Command](http://xmpp.org/extensions/xep-0191.html)
- [XEP-0198: Stream Management](http://xmpp.org/extensions/xep-0198.html)
- [XEP-0199: XMPP Ping](http://xmpp.org/extensions/xep-0199.html)
- [XEP-0202: Entity Time](http://xmpp.org/extensions/xep-0202.html)
- [XEP-0203: Delayed Delivery](http://xmpp.org/extensions/xep-0203.html)
- [XEP-0206: XMPP Over BOSH](http://xmpp.org/extensions/xep-0206.html)
- [XEP-0215: External Service Discovery](http://xmpp.org/extensions/xep-0215.html)
- [XEP-0221: Data Forms Media Element](http://xmpp.org/extensions/xep-0221.html)
- [XEP-0224: Attention](http://xmpp.org/extensions/xep-0224.html)
- [XEP-0231: Bits of Binary](http://xmpp.org/extensions/xep-0231.html)

Support for requesting bits. Responding to requests for bits is left to the application using Stanza by listening to the `iq:get:bob` event.

- [XEP-0234: Jingle File Transfer](http://xmpp.org/extensions/xep-0234.html)
- [XEP-0249: Direct MUC Invitations](http://xmpp.org/extensions/xep-0249.html)
- [XEP-0264: File Transfer Thumbnails](http://xmpp.org/extensions/xep-0264.html)
- [XEP-0276: Presence Decloaking](http://xmpp.org/extensions/xep-0276.html)
- [XEP-0280: Message Carbons](http://xmpp.org/extensions/xep-0280.html)
- [XEP-0293: Jingle RTP Feedback Negotiation](http://xmpp.org/extensions/xep-0293.html)
- [XEP-0294: Jingle RTP Header Extensions Negotiation](http://xmpp.org/extensions/xep-0294.html)
- [XEP-0297: Stanza Forwarding](http://xmpp.org/extensions/xep-0297.html)
- [XEP-0300: Use of Cryptographic Hash Functions in XMPP](http://xmpp.org/extensions/xep-0300.html)
- [XEP-0301: In-Band Real Time Text](http://xmpp.org/extensions/xep-0301.html)

Support for the RTT protocol only. Processing the RTT information for UI display is left to the user & other modules such as [rtt-buffer](https://github.com/otalk/rtt-buffer).

- [XEP-0307: Unique Room Names for Multi-User Chat](http://xmpp.org/extensions/xep-0307.html)
- [XEP-0308: Last Message Correction](http://xmpp.org/extensions/xep-0308.html)
- [XEP-0310: Presence State Annotations](http://xmpp.org/extensions/xep-0310.html)
- [XEP-0313: Message Archive Management](http://xmpp.org/extensions/xep-0313.html)
- [XEP-0317: Hats](http://xmpp.org/extensions/xep-0317.html)
- [XEP-0319: Last User Interaction in Presence](http://xmpp.org/extensions/xep-0319.html)
- [XEP-0320: Use of DTLS-SRTP in Jingle Sessions](http://xmpp.org/extensions/xep-0320.html)
- [XEP-0328: JID Prep](http://xmpp.org/extensions/xep-0328.html)
- [XEP-0333: Chat Markers](http://xmpp.org/extensions/xep-0333.html)
- [XEP-0335: JSON Containers](http://xmpp.org/extensions/xep-0335.html)
- [XEP-0337: Event Logging over XMPP](http://xmpp.org/extensions/xep-0337.html)
- [XEP-0338: Jingle Grouping Framework](http://xmpp.org/extensions/xep-0338.html)
- [XEP-0339: Source-Specific Media Attributes in Jingle](http://xmpp.org/extensions/xep-0339.html)
- [XEP-0343: Use of DTLS/SCTP in Jingle ICE-UDP](http://xmpp.org/extensions/xep-0343.html)
- [XEP-0352: Client State Indication](http://xmpp.org/extensions/xep-0352.html)
- [XEP-0357: Push Notifications](https://xmpp.org/extensions/xep-0357.html)
- [XEP-0372: References](http://xmpp.org/extensions/xep-0372.html)

- [XEP-0307: Unique Room Names for Multi-User Chat](http://xmpp.org/extensions/xep-0307.html)
- [XEP-0308: Last Message Correction](http://xmpp.org/extensions/xep-0308.html)
- [XEP-0310: Presence State Annotations](http://xmpp.org/extensions/xep-0310.html)
- [XEP-0313: Message Archive Management](http://xmpp.org/extensions/xep-0313.html)
- [XEP-0317: Hats](http://xmpp.org/extensions/xep-0317.html)
- [XEP-0319: Last User Interaction in Presence](http://xmpp.org/extensions/xep-0319.html)
- [XEP-0320: Use of DTLS-SRTP in Jingle Sessions](http://xmpp.org/extensions/xep-0320.html)
- [XEP-0328: JID Prep](http://xmpp.org/extensions/xep-0328.html)
- [XEP-0333: Chat Markers](http://xmpp.org/extensions/xep-0333.html)
- [XEP-0335: JSON Containers](http://xmpp.org/extensions/xep-0335.html)
- [XEP-0337: Event Logging over XMPP](http://xmpp.org/extensions/xep-0337.html)
- [XEP-0338: Jingle Grouping Framework](http://xmpp.org/extensions/xep-0338.html)
- [XEP-0339: Source-Specific Media Attributes in Jingle](http://xmpp.org/extensions/xep-0339.html)
- [XEP-0343: Use of DTLS/SCTP in Jingle ICE-UDP](http://xmpp.org/extensions/xep-0343.html)
- [XEP-0352: Client State Indication](http://xmpp.org/extensions/xep-0352.html)
- [XEP-0357: Push Notifications](https://xmpp.org/extensions/xep-0357.html)
- [XEP-0372: References](http://xmpp.org/extensions/xep-0372.html)
@@ -1,10 +1,10 @@
<html>
<head>
<meta charset="UTF-8" />
<title>stanza.io — Jingle Interop Testing</title>
<title>Jingle Testing</title>
<!-- Using webrtc-adapter is 1000% recommended -->
<script src="https://github.com/webrtcHacks/adapter/blob/master/release/adapter.js"></script>
<script src="dist/stanzaio.browser.js"></script>
<script src="dist/stanza.browser.js"></script>
<style>
video {
width: 320px;
@@ -1,7 +1,7 @@
{
"name": "stanza.io",
"name": "stanza",
"description": "Modern XMPP in the browser, with a JSON API",
"version": "10.3.4",
"version": "11.0.0",
"author": "Lance Stout <lancestout@gmail.com>",
"browser": {
"node-stringprep": false,
@@ -41,19 +41,16 @@
"webpack-bundle-analyzer": "^3.0.3",
"webpack-cli": "^3.1.2"
},
"homepage": "https://stanza.io",
"homepage": "https://stanzajs.org",
"husky": {
"hooks": {
"pre-commit": "pretty-quick --stage && npm run lint && npm test"
}
},
"keywords": [
"bosh",
"jingle",
"json",
"stanza",
"stanza.io",
"websocket",
"xmpp"
],
"license": "MIT",
Oops, something went wrong.

0 comments on commit b336440

Please sign in to comment.
You can’t perform that action at this time.