polfan-server-js-client 0.2.65 → 0.2.67

package/.idea/workspace.xml

@@ -4,14 +4,13 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="831dae43-0da1-47fd-a5f7-33dd5eec2992" name="Changes" comment="Align to custom colors and nicks protocol changes">
-      <change beforePath="$PROJECT_DIR$/build/index.cjs.js" beforeDir="false" afterPath="$PROJECT_DIR$/build/index.cjs.js" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/build/index.cjs.js.map" beforeDir="false" afterPath="$PROJECT_DIR$/build/index.cjs.js.map" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/build/index.umd.js" beforeDir="false" afterPath="$PROJECT_DIR$/build/index.umd.js" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/build/index.umd.js.map" beforeDir="false" afterPath="$PROJECT_DIR$/build/index.umd.js.map" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/build/types/WebSocketChatClient.d.ts" beforeDir="false" afterPath="$PROJECT_DIR$/build/types/WebSocketChatClient.d.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/package.json" afterDir="false" />
+    <list default="true" id="831dae43-0da1-47fd-a5f7-33dd5eec2992" name="Changes" comment="Connection handling optimizations">
+      <change afterPath="$PROJECT_DIR$/src/types/src/schemes/commands/Ping.ts" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/src/types/src/schemes/events/Pong.ts" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/AbstractChatClient.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/AbstractChatClient.ts" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/src/WebSocketChatClient.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/WebSocketChatClient.ts" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/types" beforeDir="false" afterPath="$PROJECT_DIR$/src/types" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/types/src/index.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/types/src/index.ts" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -163,15 +162,7 @@
       <workItem from="1764758258935" duration="1127000" />
       <workItem from="1764792690210" duration="1002000" />
       <workItem from="1764794428269" duration="595000" />
-      <workItem from="1764847260499" duration="4990000" />
-    </task>
-    <task id="LOCAL-00017" summary="New scheme of Bye event">
-      <option name="closed" value="true" />
-      <created>1740250355576</created>
-      <option name="number" value="00017" />
-      <option name="presentableId" value="LOCAL-00017" />
-      <option name="project" value="LOCAL" />
-      <updated>1740250355576</updated>
+      <workItem from="1764847260499" duration="25756000" />
     </task>
     <task id="LOCAL-00018" summary="Fix authentication">
       <option name="closed" value="true" />
@@ -557,7 +548,15 @@
       <option name="project" value="LOCAL" />
       <updated>1764689897014</updated>
     </task>
-    <option name="localTasksCounter" value="66" />
+    <task id="LOCAL-00066" summary="Connection handling optimizations">
+      <option name="closed" value="true" />
+      <created>1764955397384</created>
+      <option name="number" value="00066" />
+      <option name="presentableId" value="LOCAL-00066" />
+      <option name="project" value="LOCAL" />
+      <updated>1764955397384</updated>
+    </task>
+    <option name="localTasksCounter" value="67" />
     <servers />
   </component>
   <component name="TypeScriptGeneratedFilesManager">
@@ -575,7 +574,6 @@
     </option>
   </component>
   <component name="VcsManagerConfiguration">
-    <MESSAGE value="Fix package.json exports" />
     <MESSAGE value="Fix package.json type exports" />
     <MESSAGE value="New message type" />
     <MESSAGE value="Dedicated event for user status change" />
@@ -600,7 +598,8 @@
     <MESSAGE value="Update deps and improve library building" />
     <MESSAGE value="Improvements and fixes to collection mirroring" />
     <MESSAGE value="Align to custom colors and nicks protocol changes" />
-    <option name="LAST_COMMIT_MESSAGE" value="Align to custom colors and nicks protocol changes" />
+    <MESSAGE value="Connection handling optimizations" />
+    <option name="LAST_COMMIT_MESSAGE" value="Connection handling optimizations" />
   </component>
   <component name="github-copilot-workspace">
     <instructionFileLocations>

package/README.md

@@ -1,5 +1,5 @@
 # pserv-js-client-library
-TypeScript client library to handle connection with Polfan chat service.
+TypeScript client library to handle connection with Devana (new Polfan) chat service.
 
 ## How to use?
 
@@ -22,4 +22,24 @@ TypeScript client library to handle connection with Polfan chat service.
     console.log("The spaces you are in:", session.spaces);
     console.log("The version of server you connected to:", session.serverVersion);
 })();
-```
+```
+
+## State management
+
+The library provides built-in state management for WebSocket client. To enable it, just pass `stateTracking`
+option to the `WebSocketChatClient` constructor:
+
+```js
+const wsClient = new PServ.WebSocketChatClient({
+    token: 'your-access-token',
+    url: 'wss://pserv-websocket-address',
+    stateTracking: true, // Enable state tracking
+});
+```
+
+With state tracking enabled, the client will automatically maintain the current state of rooms, users, and messages, 
+by handling incoming events from the server. Reactive data structures are available via `ObservableIndexedObjectCollection`
+objects, which allows you to subscribe to changes.
+
+**Important note:** you can cache these objects for the connection lifetime, but you should refetch them after reconnecting,
+because some structures are rebuild from scratch on `Session` event.

package/build/index.cjs.js

@@ -968,9 +968,6 @@ var TopicHistoryWindow = /*#__PURE__*/function (_TraversableRemoteCol) {
     _this2.tracker = tracker;
     _this2.internalState.traverseLock = false;
     if (bindEvents) {
-      _this2.tracker.client.on('Session', function (ev) {
-        return _this2.handleSession(ev);
-      });
       _this2.tracker.client.on('NewMessage', function (ev) {
         return _this2.handleNewMessage(ev);
       });
@@ -1117,19 +1114,6 @@ var TopicHistoryWindow = /*#__PURE__*/function (_TraversableRemoteCol) {
       }
       return handleNewMessage;
     }()
-  }, {
-    key: "handleSession",
-    value: function handleSession(ev) {
-      var _this3 = this;
-      var rooms = ev.state.rooms;
-      if (rooms.find(function (room) {
-        return room.id === _this3.roomId;
-      })) {
-        void this.resetToLatest();
-      } else {
-        this.deleteAll();
-      }
-    }
   }, {
     key: "fetchItemsAfter",
     value: function () {
@@ -4285,7 +4269,7 @@ var WebSocketChatClientEvent = /*#__PURE__*/function (WebSocketChatClientEvent)
 }(WebSocketChatClientEvent || {});
 var WebSocketChatClient = /*#__PURE__*/function (_AbstractChatClient) {
   function WebSocketChatClient(options) {
-    var _this$options$stateTr;
+    var _this$options$stateTr, _options$ping, _options$ping2, _options$ping2$enable, _options$ping3, _options$ping3$noActi, _options$ping4, _options$ping4$pongBa;
     var _this;
     WebSocketChatClient_classCallCheck(this, WebSocketChatClient);
     _this = WebSocketChatClient_callSuper(this, WebSocketChatClient);
@@ -4296,10 +4280,17 @@ var WebSocketChatClient = /*#__PURE__*/function (_AbstractChatClient) {
     WebSocketChatClient_defineProperty(_this, "connectingTimeoutId", void 0);
     WebSocketChatClient_defineProperty(_this, "authenticated", void 0);
     WebSocketChatClient_defineProperty(_this, "authenticatedResolvers", void 0);
+    WebSocketChatClient_defineProperty(_this, "pingIntervalId", void 0);
+    WebSocketChatClient_defineProperty(_this, "lastReceivedMessageAt", void 0);
+    WebSocketChatClient_defineProperty(_this, "pingInFlight", void 0);
     _this.options = options;
     if ((_this$options$stateTr = _this.options.stateTracking) !== null && _this$options$stateTr !== void 0 ? _this$options$stateTr : true) {
       _this.state = new ChatStateTracker(_this);
     }
+    (_options$ping = options.ping) !== null && _options$ping !== void 0 ? _options$ping : options.ping = {};
+    (_options$ping2$enable = (_options$ping2 = options.ping).enabled) !== null && _options$ping2$enable !== void 0 ? _options$ping2$enable : _options$ping2.enabled = true;
+    (_options$ping3$noActi = (_options$ping3 = options.ping).noActivityTimeoutMs) !== null && _options$ping3$noActi !== void 0 ? _options$ping3$noActi : _options$ping3.noActivityTimeoutMs = 15000;
+    (_options$ping4$pongBa = (_options$ping4 = options.ping).pongBackTimeoutMs) !== null && _options$ping4$pongBa !== void 0 ? _options$ping4$pongBa : _options$ping4.pongBackTimeoutMs = 5000;
     return _this;
   }
   WebSocketChatClient_inherits(WebSocketChatClient, _AbstractChatClient);
@@ -4352,7 +4343,7 @@ var WebSocketChatClient = /*#__PURE__*/function (_AbstractChatClient) {
     value: function disconnect() {
       var _this$ws;
       this.sendQueue = [];
-      (_this$ws = this.ws) === null || _this$ws === void 0 || _this$ws.close();
+      (_this$ws = this.ws) === null || _this$ws === void 0 || _this$ws.close(1000); // Normal closure
       this.ws = null;
     }
   }, {
@@ -4400,6 +4391,7 @@ var WebSocketChatClient = /*#__PURE__*/function (_AbstractChatClient) {
   }, {
     key: "onMessage",
     value: function onMessage(event) {
+      this.lastReceivedMessageAt = Date.now();
       var envelope = JSON.parse(event.data);
       this.handleIncomingEnvelope(envelope);
       this.emit(envelope.type, envelope.data);
@@ -4410,6 +4402,7 @@ var WebSocketChatClient = /*#__PURE__*/function (_AbstractChatClient) {
         var isAuthenticated = envelope.type !== 'Bye';
         this.authenticated = isAuthenticated;
         if (isAuthenticated) {
+          this.startConnectionMonitor();
           this.authenticatedResolvers[0]();
           this.emit(this.Event.connect);
           this.sendFromQueue();
@@ -4421,6 +4414,7 @@ var WebSocketChatClient = /*#__PURE__*/function (_AbstractChatClient) {
   }, {
     key: "onClose",
     value: function onClose(event) {
+      this.stopConnectionMonitor();
       clearTimeout(this.connectingTimeoutId);
       var reconnect = event.code !== 1000; // Connection was closed because of error
       if (reconnect) {
@@ -4464,6 +4458,56 @@ var WebSocketChatClient = /*#__PURE__*/function (_AbstractChatClient) {
     value: function isOpenWsState() {
       return this.ws && this.ws.readyState === this.ws.OPEN;
     }
+  }, {
+    key: "startConnectionMonitor",
+    value: function startConnectionMonitor() {
+      var _this4 = this;
+      if (!this.options.ping.enabled) {
+        return;
+      }
+      this.lastReceivedMessageAt = Date.now();
+      this.pingIntervalId = setInterval(/*#__PURE__*/WebSocketChatClient_asyncToGenerator(/*#__PURE__*/WebSocketChatClient_regenerator().m(function _callee3() {
+        var timeout;
+        return WebSocketChatClient_regenerator().w(function (_context3) {
+          while (1) switch (_context3.n) {
+            case 0:
+              if (!(!_this4.isReady || _this4.pingInFlight)) {
+                _context3.n = 1;
+                break;
+              }
+              return _context3.a(2);
+            case 1:
+              if (!(Date.now() - _this4.lastReceivedMessageAt < _this4.options.ping.noActivityTimeoutMs)) {
+                _context3.n = 2;
+                break;
+              }
+              return _context3.a(2);
+            case 2:
+              timeout = setTimeout(function () {
+                _this4.pingInFlight = false;
+                _this4.disconnect();
+                void _this4.connect();
+              }, _this4.options.ping.pongBackTimeoutMs);
+              _this4.pingInFlight = true;
+              _this4.send('Ping', {}).then(function () {
+                _this4.pingInFlight = false;
+                clearTimeout(timeout);
+              });
+            case 3:
+              return _context3.a(2);
+          }
+        }, _callee3);
+      })), 1000);
+    }
+  }, {
+    key: "stopConnectionMonitor",
+    value: function stopConnectionMonitor() {
+      if (this.pingIntervalId) {
+        clearInterval(this.pingIntervalId);
+        this.pingIntervalId = undefined;
+      }
+      this.pingInFlight = false;
+    }
   }]);
 }(AbstractChatClient);
 ;// ./src/WebApiChatClient.ts