polfan-server-js-client 0.2.64 → 0.2.66

package/.idea/workspace.xml

@@ -5,6 +5,7 @@
   </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$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
       <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" />
@@ -12,6 +13,8 @@
       <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" />
       <change beforePath="$PROJECT_DIR$/src/WebSocketChatClient.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/WebSocketChatClient.ts" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/state-tracker/MessagesManager.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/state-tracker/MessagesManager.ts" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/state-tracker/TopicHistoryWindow.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/state-tracker/TopicHistoryWindow.ts" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -163,7 +166,7 @@
       <workItem from="1764758258935" duration="1127000" />
       <workItem from="1764792690210" duration="1002000" />
       <workItem from="1764794428269" duration="595000" />
-      <workItem from="1764847260499" duration="3270000" />
+      <workItem from="1764847260499" duration="12786000" />
     </task>
     <task id="LOCAL-00017" summary="New scheme of Bye event">
       <option name="closed" value="true" />

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 () {
@@ -4314,7 +4298,7 @@ var WebSocketChatClient = /*#__PURE__*/function (_AbstractChatClient) {
         return WebSocketChatClient_regenerator().w(function (_context) {
           while (1) switch (_context.n) {
             case 0:
-              if (!(this.isReadyToSendWsState() || this.isPendingReadyWsState())) {
+              if (!(this.isOpenWsState() || this.isConnectingWsState())) {
                 _context.n = 1;
                 break;
               }
@@ -4365,7 +4349,7 @@ var WebSocketChatClient = /*#__PURE__*/function (_AbstractChatClient) {
             case 0:
               envelope = this.createEnvelope(commandType, commandData);
               promise = this.createPromiseFromCommandEnvelope(envelope);
-              if (!this.isPendingReadyWsState()) {
+              if (!(this.isConnectingWsState() || !this.authenticated && this.isOpenWsState())) {
                 _context2.n = 1;
                 break;
               }
@@ -4385,17 +4369,17 @@ var WebSocketChatClient = /*#__PURE__*/function (_AbstractChatClient) {
   }, {
     key: "isReady",
     get: function get() {
-      return this.isReadyToSendWsState();
+      return this.isOpenWsState() && this.authenticated;
     }
   }, {
     key: "sendEnvelope",
     value: function sendEnvelope(envelope) {
       var _this$ws$readyState, _this$ws2;
-      if (this.isReadyToSendWsState()) {
+      if (this.isReady) {
         this.ws.send(JSON.stringify(envelope));
         return;
       }
-      this.handleEnvelopeSendError(envelope, new Error("Cannot send; invalid websocket state=".concat((_this$ws$readyState = (_this$ws2 = this.ws) === null || _this$ws2 === void 0 ? void 0 : _this$ws2.readyState) !== null && _this$ws$readyState !== void 0 ? _this$ws$readyState : '[no connection]')));
+      this.handleEnvelopeSendError(envelope, new Error("Cannot send - client is not ready (state=".concat((_this$ws$readyState = (_this$ws2 = this.ws) === null || _this$ws2 === void 0 ? void 0 : _this$ws2.readyState) !== null && _this$ws$readyState !== void 0 ? _this$ws$readyState : '[no connection]', "; authenticated=").concat(this.authenticated, ")")));
     }
   }, {
     key: "onMessage",
@@ -4455,14 +4439,14 @@ var WebSocketChatClient = /*#__PURE__*/function (_AbstractChatClient) {
       this.emit(this.Event.error, new Error('Connection timeout'));
     }
   }, {
-    key: "isPendingReadyWsState",
-    value: function isPendingReadyWsState() {
-      return this.ws && this.ws.readyState === this.ws.CONNECTING || !this.authenticated;
+    key: "isConnectingWsState",
+    value: function isConnectingWsState() {
+      return this.ws && this.ws.readyState === this.ws.CONNECTING;
     }
   }, {
-    key: "isReadyToSendWsState",
-    value: function isReadyToSendWsState() {
-      return this.ws && this.ws.readyState === this.ws.OPEN && this.authenticated;
+    key: "isOpenWsState",
+    value: function isOpenWsState() {
+      return this.ws && this.ws.readyState === this.ws.OPEN;
     }
   }]);
 }(AbstractChatClient);