centrifuge 2.7.1 → 2.7.5

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+2.7.5
+=====
+
+* Fix regression of 2.7.4 - `Invalid end of JSON input error`
+
+2.7.4
+=====
+
+* Optimize & simplify json encode/decode, see [#138](https://github.com/centrifugal/centrifuge-js/pull/138)
+
+2.7.3
+=====
+
+* `SubscribeSuccessContext` can contain `data` field if custom data returned from a server in a subscribe result.
+
+2.7.2
+=====
+
+* Handle server-side SUB push in Protobuf case (previously ignored). Sub push is a message that contains information about server-side subscription made after connection already established.
+
 2.7.1
 =====
 

package/README.md

@@ -865,7 +865,7 @@ If you don't want to give client access to channel then just do not include it i
 
 There are also two public API methods which can help to subscribe to many private channels sending only one POST request to your web application backend: `startSubscribeBatching` and `stopSubscribeBatching`. When you `startSubscribeBatching` javascript client will collect private subscriptions until `stopSubscribeBatching()` called – and then send them all at once.
 
-As we just described when client subscribes on private channel by default AJAX request will be sent to `subscribeEndpoint` automatically if channel starts with `$`. In this case developer only needs to return proper response from server. But there is a way to override default behaviour and take full control on authorizing private channels. To do this it's possible to provide custom `onPrivateSubscribe` function in configuration options. This function will be called with all data required to authorize private channels client subscribes to and should call callback (will be provided by centrifuge-js as second argument) with authorization data when done. See our type declarations in `dist` folder to find out data format.
+As we just described when client subscribes on private channel by default AJAX request will be sent to `subscribeEndpoint` automatically if channel starts with `$`. In this case developer only needs to return proper response from server. But there is a way to override default behaviour and take full control on authorizing private channels. To do this it's possible to provide custom `onPrivateSubscribe` function in configuration options. This function will be called with all data required to authorize private channels client subscribes to and should call callback (will be provided by centrifuge-js as second argument) with authorization data when done. See our type declarations in `dist` folder to find out data format (**for `onPrivateSubscribe` it is slightly different** - like `{"status": 200, "data": {"channels": [...]}}`).
 
 ## Server-side subscriptions
 
@@ -984,12 +984,37 @@ var centrifuge = new Centrifuge('ws://localhost:8000/connection/sockjs', {
 })
 ```
 
+### Custom WebSocket constructor
+
+If you are building a client for a non-browser environment and want to pass custom headers then you can use the following approach to wrap a WebSocket constructor and let custom options to be used on connection initialization:
+
+```javascript
+var Centrifuge = require("centrifuge");
+const WebSocket = require('ws');
+
+const myWs = function (options) {
+    return class wsClass extends WebSocket {
+        constructor(...args) {
+            super(...[...args, ...[options]])
+        }
+    }
+}
+```
+
+It should be now possible to use pass your custom WebSocket constructor to `centrifuge-js` and so custom headers will be used when connecting to a server:
+
+```javascript
+var centrifuge = new Centrifuge('ws://localhost:8000/connection/websocket', {
+    websocket: myWs({ headers: { Authorization: '<token or key>' } }),
+});
+```
+
 ## Feature matrix
 
 - [x] connect to server using JSON protocol format
 - [x] connect to server using Protobuf protocol format
 - [x] connect with token (JWT)
-- [ ] connect with custom header (not supported by browser API)
+- [ ] connect with custom header (not supported by browser API, though [possible for a non-browser target env](https://github.com/centrifugal/centrifuge-js#custom-websocket-constructor))
 - [x] automatic reconnect in case of errors, network problems etc
 - [x] an exponential backoff for reconnect
 - [x] connect and disconnect events

package/dist/centrifuge.d.ts

@@ -131,6 +131,7 @@ declare namespace Centrifuge {
         isResubscribe: boolean;
         recovered: boolean;
         streamPosition?: StreamPosition;
+        data?: any;
     }
 
     export interface SubscribeErrorContext {

package/dist/centrifuge.js

@@ -1706,6 +1706,11 @@ var Centrifuge = /*#__PURE__*/function (_EventEmitter) {
       }
 
       ;
+
+      if (result.data) {
+        ctx.data = result.data;
+      }
+
       return ctx;
     }
   }, {
@@ -2422,15 +2427,9 @@ var JsonEncoder = /*#__PURE__*/function () {
   _createClass(JsonEncoder, [{
     key: "encodeCommands",
     value: function encodeCommands(commands) {
-      var encodedCommands = [];
-
-      for (var i in commands) {
-        if (commands.hasOwnProperty(i)) {
-          encodedCommands.push(JSON.stringify(commands[i]));
-        }
-      }
-
-      return encodedCommands.join('\n');
+      return commands.map(function (c) {
+        return JSON.stringify(c);
+      }).join('\n');
     }
   }]);
 
@@ -2447,21 +2446,11 @@ var JsonDecoder = /*#__PURE__*/function () {
   _createClass(JsonDecoder, [{
     key: "decodeReplies",
     value: function decodeReplies(data) {
-      var replies = [];
-      var encodedReplies = data.split('\n');
-
-      for (var i in encodedReplies) {
-        if (encodedReplies.hasOwnProperty(i)) {
-          if (!encodedReplies[i]) {
-            continue;
-          }
-
-          var reply = JSON.parse(encodedReplies[i]);
-          replies.push(reply);
-        }
-      }
-
-      return replies;
+      return data.split('\n').filter(function (r) {
+        return r !== '';
+      }).map(function (r) {
+        return JSON.parse(r);
+      });
     }
   }, {
     key: "decodeCommandResult",