polfan-server-js-client 0.3.2 → 0.4.0

package/README.md

@@ -1,45 +1,45 @@
-# pserv-js-client-library
-TypeScript client library to handle connection with Devana (new Polfan) chat service.
-
-## How to use?
-
-```js
-(async () => {
-    // Get access token by credentials
-    const token = await PServ.AuthClient.createToken('login', 'password');
-    
-    // Create web api client (there is also WebSocket client available)
-    const client = new PServ.WebApiChatClient({
-        token: token.token, // Pass received token
-        url: 'https://pserv-api-address',
-    });
-    
-    // Call `GetSession` command which returns user session data
-    const session = await client.send('GetSession');
-    
-    console.log("My nick:", session.user.nick);
-    console.log("The rooms you are in:", session.rooms);
-    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,
+# pserv-js-client-library
+TypeScript client library to handle connection with Devana (new Polfan) chat service.
+
+## How to use?
+
+```js
+(async () => {
+    // Get access token by credentials
+    const token = await PServ.AuthClient.createToken('login', 'password');
+    
+    // Create web api client (there is also WebSocket client available)
+    const client = new PServ.WebApiChatClient({
+        token: token.token, // Pass received token
+        url: 'https://pserv-api-address',
+    });
+    
+    // Call `GetSession` command which returns user session data
+    const session = await client.send('GetSession');
+    
+    console.log("My nick:", session.user.nick);
+    console.log("The rooms you are in:", session.rooms);
+    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,6 +1,6 @@
-module.exports = {
-  presets: [
-    ["@babel/preset-env"],
-    ["@babel/preset-typescript", { allowDeclareFields: true }],
-  ],
+module.exports = {
+  presets: [
+    ["@babel/preset-env"],
+    ["@babel/preset-typescript", { allowDeclareFields: true }],
+  ],
 };

package/build/index.cjs.js

@@ -48,6 +48,7 @@ __webpack_require__.d(__webpack_exports__, {
   ObservableIndexedObjectCollection: () => (/* reexport */ ObservableIndexedObjectCollection),
   PermissionDefinition: () => (/* reexport */ PermissionDefinition),
   Permissions: () => (/* reexport */ Permissions),
+  UserStatus: () => (/* reexport */ UserStatus),
   WebApiChatClient: () => (/* reexport */ WebApiChatClient),
   WebSocketChatClient: () => (/* reexport */ WebSocketChatClient),
   extractUserFromMember: () => (/* reexport */ extractUserFromMember)
@@ -5022,8 +5023,8 @@ var UsersManager = /*#__PURE__*/function () {
     });
   }
 
-  /**
-   * Get all available (cached) user objects at once.
+  /**
+   * Get all available (cached) user objects at once.
    */
   return UsersManager_createClass(UsersManager, [{
     key: "getAvailable",
@@ -5061,7 +5062,7 @@ var UsersManager = /*#__PURE__*/function () {
         _this$users;
       users.forEach(function (newUser) {
         var oldUser = _this2.users.get(newUser.id);
-        if (oldUser && oldUser.online !== newUser.online) {
+        if (oldUser && oldUser.status !== newUser.status) {
           _this2.onlineStatus.emit('change', newUser);
         }
       });
@@ -5230,28 +5231,28 @@ var ChatStateTracker = /*#__PURE__*/function () {
     var _this = this;
     ChatStateTracker_classCallCheck(this, ChatStateTracker);
     ChatStateTracker_defineProperty(this, "client", void 0);
-    /**
-     * State of your permissions.
+    /**
+     * State of your permissions.
      */
     ChatStateTracker_defineProperty(this, "permissions", void 0);
-    /**
-     * State of the rooms you are in.
+    /**
+     * State of the rooms you are in.
      */
     ChatStateTracker_defineProperty(this, "rooms", void 0);
-    /**
-     * State of the spaces you are in.
+    /**
+     * State of the spaces you are in.
      */
     ChatStateTracker_defineProperty(this, "spaces", void 0);
-    /**
-     * State of the emoticons (global and space-related).
+    /**
+     * State of the emoticons (global and space-related).
      */
     ChatStateTracker_defineProperty(this, "emoticons", void 0);
-    /**
-     * Users related state.
+    /**
+     * Users related state.
      */
     ChatStateTracker_defineProperty(this, "users", void 0);
-    /**
-     * State of relationships with other users.
+    /**
+     * State of relationships with other users.
      */
     ChatStateTracker_defineProperty(this, "relationships", void 0);
     ChatStateTracker_defineProperty(this, "_me", null);
@@ -6047,6 +6048,170 @@ var FilesClient = /*#__PURE__*/function (_AbstractRestClient) {
     }()
   }]);
 }(AbstractRestClient);
+;// ./src/types/src/schemes/User.ts
+/**
+ * Availability of a user, aggregated over all of their sessions.
+ *
+ * - `Offline` - no session is connected and none can be reached asynchronously.
+ * - `Online` - at least one session holds a live connection.
+ * - `OnlineAsync` - no live connection, but a push-registered device was active
+ *   recently, so a message will still reach the user.
+ */
+var UserStatus = /*#__PURE__*/function (UserStatus) {
+  UserStatus[UserStatus["Offline"] = 0] = "Offline";
+  UserStatus[UserStatus["Online"] = 1] = "Online";
+  UserStatus[UserStatus["OnlineAsync"] = 2] = "OnlineAsync";
+  return UserStatus;
+}({});
+;// ./src/types/src/index.ts
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 ;// ./src/index.ts
 
 
@@ -6056,6 +6221,7 @@ var FilesClient = /*#__PURE__*/function (_AbstractRestClient) {
 
 
 
+
 module.exports = __webpack_exports__;
 /******/ })()
 ;