centrifuge 2.8.0 → 2.8.4

package/.github/workflows/ci.yml

@@ -19,3 +19,5 @@ jobs:
         run: npm install --pure-lockfile
       - name: Test
         run: npm run test
+      - name: Check ts definitions
+        run: npx check-dts@0.5.6 dist/centrifuge.d.ts

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+2.8.4
+=====
+
+* Support setting a custom `data` attached to a subscribe request. This `data` will be then available in `OnSubscribe` callback on the server side (in the case of Centrifugo subscribe proxy will be able to access this data). [#171](https://github.com/centrifugal/centrifuge-js/pull/171).
+
+2.8.3
+=====
+
+* Fix regression of 2.8.0: handle server-side subscribe and unsubscribe pushes.
+
+2.8.2
+=====
+
+* Fix TypeScript definitions for subscribe (`A rest parameter must be last in a parameter list.`). 
+
+2.8.1
+=====
+
+* Support `sockjsTimeout` (number) option which translates to [SockJS.timeout option](https://github.com/sockjs/sockjs-client#sockjs-class) - i.e. a minimum timeout in milliseconds to use for the transport connections. By default SockJS uses timeout determined automatically based on calculating round trip time during info request. 
+
 2.8.0
 =====
 

package/README.md

@@ -346,7 +346,7 @@ centrifuge.rpc({"input": "hello"}).then(function(res) {
 `namedRPC` method allows to send rpc request from client to server and wait for data response. Unlike `rpc` it additionally allows to provide method name string (which can be handy to have on RPC request top level).
 
 ```javascript
-centrifuge.namedRPC({"input": "hello"}).then(function(res) {
+centrifuge.namedRPC("my.method.name", {"input": "hello"}).then(function(res) {
     console.log('rpc result', res);
 }, function(err) {
     console.log('rpc error', err);
@@ -678,10 +678,9 @@ var subscription = centrifuge.subscribe("news", function(message) {
 });
 
 subscription.history().then(function(response) {
-        // history messages received
-    }, function(err) {
-        // history call failed with error
-    });
+    // history messages received
+}, function(err) {
+    // history call failed with error
 });
 ```
 

package/dist/centrifuge.d.ts

@@ -50,7 +50,7 @@ declare class Centrifuge extends EventEmitter {
     stopBatching(): void;
     startSubscribeBatching(): void;
     stopSubscribeBatching(): void;
-    subscribe(channel: string, events?: (...args: any[], opts?: Centrifuge.SubscribeOptions) => void): Centrifuge.Subscription;
+    subscribe(channel: string, events?: (...args: any[]) => void, opts?: Centrifuge.SubscribeOptions): Centrifuge.Subscription;
     subscribe(channel: string, events?: Centrifuge.SubscriptionEvents, opts?: Centrifuge.SubscribeOptions): Centrifuge.Subscription;
 }
 
@@ -73,6 +73,7 @@ declare namespace Centrifuge {
         privateChannelPrefix?: string;
         onTransportClose?: (ctx: object) => void;
         sockjsServer?: string;
+        sockjsTimeout?: number;
         sockjsTransports?: string[];
         refreshEndpoint?: string;
         refreshHeaders?: object;
@@ -209,6 +210,7 @@ declare namespace Centrifuge {
 
     export interface SubscribeOptions {
         since?: StreamPosition;
+        data?: any;
     }
 
     export interface StreamPosition {

package/dist/centrifuge.js

@@ -46,11 +46,11 @@ function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || func
 
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
 
-function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
 
 function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
 
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 
 function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
 
@@ -129,6 +129,7 @@ var Centrifuge = /*#__PURE__*/function (_EventEmitter) {
       privateChannelPrefix: '$',
       onTransportClose: null,
       sockjsServer: null,
+      sockjsTimeout: null,
       sockjsTransports: ['websocket', 'xdr-streaming', 'xhr-streaming', 'eventsource', 'iframe-eventsource', 'iframe-htmlfile', 'xdr-polling', 'xhr-polling', 'iframe-xhr-polling', 'jsonp-polling'],
       refreshEndpoint: '/centrifuge/refresh',
       refreshHeaders: {},
@@ -557,6 +558,10 @@ var Centrifuge = /*#__PURE__*/function (_EventEmitter) {
           sockjsOptions.server = this._config.sockjsServer;
         }
 
+        if (this._config.sockjsTimeout !== null) {
+          sockjsOptions.timeout = this._config.sockjsTimeout;
+        }
+
         this._isSockjs = true;
         this._transport = new this._sockjs(this._url, null, sockjsOptions);
       } else {
@@ -1413,11 +1418,16 @@ var Centrifuge = /*#__PURE__*/function (_EventEmitter) {
         params: {
           channel: channel
         }
-      }; // If channel name does not start with privateChannelPrefix - then we
+      };
+
+      if (sub._subscribeData) {
+        msg.params.data = sub._subscribeData;
+      } // If channel name does not start with privateChannelPrefix - then we
       // can just send subscription message to Centrifuge. If channel name
       // starts with privateChannelPrefix - then this is a private channel
       // and we should ask web application backend for permission first.
 
+
       if ((0, _utils.startsWith)(channel, this._config.privateChannelPrefix)) {
         // private channel.
         if (this._isSubscribeBatching) {
@@ -2008,12 +2018,12 @@ var Centrifuge = /*#__PURE__*/function (_EventEmitter) {
         var leave = this._decoder.decodePushData(this._pushType.LEAVE, push.data);
 
         this._handleLeave(channel, leave);
-      } else if (type === this._pushType.UNSUB) {
-        var unsub = this._decoder.decodePushData(this._pushType.UNSUB, push.data);
+      } else if (type === this._pushType.UNSUBSCRIBE) {
+        var unsub = this._decoder.decodePushData(this._pushType.UNSUBSCRIBE, push.data);
 
         this._handleUnsub(channel, unsub);
-      } else if (type === this._pushType.SUB) {
-        var sub = this._decoder.decodePushData(this._pushType.SUB, push.data);
+      } else if (type === this._pushType.SUBSCRIBE) {
+        var sub = this._decoder.decodePushData(this._pushType.UNSUBSCRIBE, push.data);
 
         this._handleSub(channel, sub);
       }
@@ -2386,7 +2396,7 @@ var Centrifuge = /*#__PURE__*/function (_EventEmitter) {
         currentSub._setEvents(events);
 
         if (currentSub._isUnsubscribed()) {
-          currentSub.subscribe();
+          currentSub.subscribe(opts);
         }
 
         return currentSub;
@@ -2394,12 +2404,7 @@ var Centrifuge = /*#__PURE__*/function (_EventEmitter) {
 
       var sub = new _subscription["default"](this, channel, events);
       this._subs[channel] = sub;
-
-      if (opts && opts.since) {
-        this._setSubscribeSince(sub, opts.since);
-      }
-
-      sub.subscribe();
+      sub.subscribe(opts);
       return sub;
     }
   }]);
@@ -2419,12 +2424,12 @@ exports.Centrifuge = Centrifuge;
 Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
-exports.default = void 0;
+exports["default"] = void 0;
 
 var _centrifuge = __webpack_require__(382);
 
 var _default = _centrifuge.Centrifuge;
-exports.default = _default;
+exports["default"] = _default;
 module.exports = exports["default"];
 
 /***/ }),
@@ -2437,7 +2442,7 @@ module.exports = exports["default"];
 Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
-exports.JsonDecoder = exports.JsonEncoder = exports.JsonPushType = exports.JsonMethodType = void 0;
+exports.JsonPushType = exports.JsonMethodType = exports.JsonEncoder = exports.JsonDecoder = void 0;
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
@@ -2537,7 +2542,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "functi
 Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
-exports.default = void 0;
+exports["default"] = void 0;
 
 var _events = _interopRequireDefault(__webpack_require__(187));
 
@@ -2557,11 +2562,11 @@ function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || func
 
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
 
-function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
 
 function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
 
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 
 function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
 
@@ -2599,6 +2604,7 @@ var Subscription = /*#__PURE__*/function (_EventEmitter) {
 
     _this._promises = {};
     _this._promiseId = 0;
+    _this._subscribeData = null;
 
     _this.on('error', function (errContext) {
       this._centrifuge._debug('subscription error', errContext);
@@ -2820,6 +2826,11 @@ var Subscription = /*#__PURE__*/function (_EventEmitter) {
       subscribeErrorContext.isResubscribe = this._isResubscribe;
       return subscribeErrorContext;
     }
+  }, {
+    key: "_setSubscribeData",
+    value: function _setSubscribeData(data) {
+      this._subscribeData = data;
+    }
   }, {
     key: "ready",
     value: function ready(callback, errback) {
@@ -2838,12 +2849,16 @@ var Subscription = /*#__PURE__*/function (_EventEmitter) {
         return;
       }
 
-      this._noResubscribe = false;
-
       if (opts && opts.since) {
         this._centrifuge._setSubscribeSince(this, opts.since);
       }
 
+      if (opts && opts.data) {
+        this._setSubscribeData(opts.data);
+      }
+
+      this._noResubscribe = false;
+
       this._centrifuge._subscribe(this);
     }
   }, {
@@ -2916,7 +2931,7 @@ var Subscription = /*#__PURE__*/function (_EventEmitter) {
   return Subscription;
 }(_events["default"]);
 
-exports.default = Subscription;
+exports["default"] = Subscription;
 module.exports = exports["default"];
 
 /***/ }),
@@ -2929,12 +2944,12 @@ module.exports = exports["default"];
 Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
-exports.startsWith = startsWith;
-exports.isFunction = isFunction;
-exports.log = log;
 exports.backoff = backoff;
 exports.errorExists = errorExists;
 exports.extend = extend;
+exports.isFunction = isFunction;
+exports.log = log;
+exports.startsWith = startsWith;
 
 function startsWith(value, prefix) {
   return value.lastIndexOf(prefix, 0) === 0;