polfan-server-js-client 0.2.3 → 0.2.7

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/babel.config.js

@@ -1,7 +1,6 @@
 module.exports = {
-  presets: [["@babel/env"]],
-  plugins: [
-    ["@babel/plugin-proposal-class-properties"],
-    ["@babel/plugin-transform-typescript"],
+  presets: [
+    ["@babel/preset-env"],
+    ["@babel/preset-typescript", { allowDeclareFields: true }],
   ],
-};
+};