ref: deprecate and rename 'bosh' option to 'serviceUrl' (#1022)

It can either be a websocket or bosh URL, so the current naming is
confusing.

doc/API.md

@@ -219,13 +219,14 @@ This objects represents the server connection. You can create new ```JitsiConnec
     - appID - identification for the provider of Jitsi Meet video conferencing services. **NOTE: not implemented yet. You can safely pass ```null```**
     - token - secret generated by the provider of Jitsi Meet video conferencing services. The token will be send to the provider from the Jitsi Meet server deployment for authorization of the current client.
     - options - JS object with configuration options for the server connection. You can change the following properties there:
-        1. bosh -
-        2. hosts - JS Object
+        1. serviceUrl - XMPP service URL. For  example 'wss://server.com/xmpp-websocket' for Websocket or '//server.com/http-bind' for BOSH.
+        2. bosh - DEPRECATED, use serviceUrl to specify either BOSH or Websocket URL.
+        3. hosts - JS Object
             - domain
             - muc
             - anonymousdomain
-        3. useStunTurn -
-        4. enableLipSync - (optional) boolean property which enables the lipsync feature. Currently works only in Chrome and is enabled by default.
+        4. useStunTurn -
+        5. enableLipSync - (optional) boolean property which enables the lipsync feature. Currently works only in Chrome and is enabled by default.
 
 2. connect(options) - establish server connection
     - options - JS Object with ```id``` and ```password``` properties.

modules/xmpp/xmpp.js

@@ -23,18 +23,18 @@ import XMPPEvents from '../../service/xmpp/XMPPEvents';
 const logger = getLogger(__filename);
 
 /**
- *
- * @param token
- * @param bosh
+ * Creates XMPP connection.
+ * @param {string} [token] - JWT token used for authentication(JWT authentication module must be enabled in Prosody).
+ * @param {string} serviceUrl - The service URL for XMPP connection.
  */
-function createConnection(token, bosh = '/http-bind') {
+function createConnection(token, serviceUrl = '/http-bind') {
     // Append token as URL param
     if (token) {
         // eslint-disable-next-line no-param-reassign
-        bosh += `${bosh.indexOf('?') === -1 ? '?' : '&'}token=${token}`;
+        serviceUrl += `${serviceUrl.indexOf('?') === -1 ? '?' : '&'}token=${token}`;
     }
 
-    const conn = new Strophe.Connection(bosh);
+    const conn = new Strophe.Connection(serviceUrl);
 
     // The default maxRetries is 5, which is too long.
     conn.maxRetries = 3;
@@ -67,6 +67,9 @@ export default class XMPP extends Listenable {
     /**
      * FIXME describe all options
      * @param {Object} options
+     * @param {String} options.serviceUrl - URL passed to the XMPP client which will be used to establish XMPP
+     * connection with the server.
+     * @param {String} options.bosh - Deprecated, use {@code serviceUrl}.
      * @param {Array<Object>} options.p2pStunServers see
      * {@link JingleConnectionPlugin} for more details.
      * @param token
@@ -81,7 +84,8 @@ export default class XMPP extends Listenable {
         this.authenticatedUser = false;
         this._initStrophePlugins(this);
 
-        this.connection = createConnection(token, options.bosh);
+        // FIXME remove deprecated bosh option at some point
+        this.connection = createConnection(token, options.serviceUrl || options.bosh);
 
         this._lastSuccessTracker = new LastSuccessTracker();
         this._lastSuccessTracker.startTracking(this.connection);