polfan-server-js-client 0.2.107 → 0.2.108

package/build/types/index.d.ts

@@ -6,5 +6,6 @@ import { Permissions, PermissionDefinition, Layer } from "./Permissions";
 import * as ChatTypes from './types/src';
 import { extractUserFromMember } from "./state-tracker/functions";
 import { AbstractRestClient } from "./AbstractRestClient";
+import { UnreadSummary } from "./state-tracker/FollowedTopicsManager";
 export { IndexedCollection, ObservableIndexedCollection, IndexedObjectCollection, ObservableIndexedObjectCollection, Permissions, PermissionDefinition, Layer, WebSocketChatClient, WebApiChatClient, FilesClient, AbstractRestClient, extractUserFromMember, };
-export type { ChatTypes, File, };
+export type { ChatTypes, File, UnreadSummary, };

package/build/types/state-tracker/FollowedTopicsManager.d.ts

@@ -5,6 +5,11 @@ import { ChatLocation, FollowedTopic } from "../types/src";
 interface EventMap {
     change: {};
 }
+export interface UnreadSummary {
+    mentionCount: number;
+    unreadTopicCount: number;
+    isUnread: boolean;
+}
 export declare class FollowedTopicsManager extends EventTarget<EventMap> {
     private tracker;
     private readonly followedTopics;
@@ -38,10 +43,7 @@ export declare class FollowedTopicsManager extends EventTarget<EventMap> {
      * Capture the 'change' event to determine when it's worth calling this method again due to data changes.
      * @return Undefined if you are not in room.
      */
-    summarize(location: ChatLocation): Promise<{
-        mentionCount: number;
-        isUnread: boolean;
-    }>;
+    summarize(location: ChatLocation): Promise<UnreadSummary>;
     /**
      * For internal use. If you want to delete the message, execute a proper command on client object.
      * @internal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polfan-server-js-client",
-  "version": "0.2.107",
+  "version": "0.2.108",
   "description": "JavaScript client library for handling communication with Polfan chat server.",
   "author": "Jarosław Żak",
   "license": "MIT",

package/src/index.ts

@@ -11,6 +11,7 @@ import { Permissions, PermissionDefinition, Layer } from "./Permissions";
 import * as ChatTypes from './types/src';
 import {extractUserFromMember} from "./state-tracker/functions";
 import {AbstractRestClient} from "./AbstractRestClient";
+import {UnreadSummary} from "./state-tracker/FollowedTopicsManager";
 
 export {
     IndexedCollection, ObservableIndexedCollection,
@@ -25,4 +26,5 @@ export {
 export type {
     ChatTypes,
     File,
+    UnreadSummary,
 };

package/src/state-tracker/FollowedTopicsManager.ts

@@ -17,11 +17,17 @@ interface EventMap {
     change: {};
 }
 
+export interface UnreadSummary {
+    mentionCount: number;
+    unreadTopicCount: number;
+    isUnread: boolean;
+}
+
 export class FollowedTopicsManager extends EventTarget<EventMap> {
     private readonly followedTopics = new IndexedCollection<string, ObservableIndexedObjectCollection<FollowedTopic>>();
     private readonly followedTopicsPromises = new PromiseRegistry();
     private readonly deferredSession = new DeferredTask();
-    private readonly summariesCache = new Map<string, { mentionCount: number, isUnread: boolean }>();
+    private readonly summariesCache = new Map<string, UnreadSummary>();
 
     /**
      * Rooms whose cached followed-topics are stale after a reconnect and must
@@ -134,7 +140,7 @@ export class FollowedTopicsManager extends EventTarget<EventMap> {
      * Capture the 'change' event to determine when it's worth calling this method again due to data changes.
      * @return Undefined if you are not in room.
      */
-    public async summarize(location: ChatLocation): Promise<{ mentionCount: number, isUnread: boolean }> {
+    public async summarize(location: ChatLocation): Promise<UnreadSummary> {
         const cacheKey = location.topicId
             ? `topic:${location.roomId}:${location.topicId}`
             : location.roomId
@@ -168,7 +174,7 @@ export class FollowedTopicsManager extends EventTarget<EventMap> {
         }
 
         let mentionCount = 0;
-        let isUnread = false;
+        let unreadTopicCount = 0;
 
         for (const roomId of roomIds) {
             const collection = await this.getForRoom(roomId);
@@ -183,14 +189,14 @@ export class FollowedTopicsManager extends EventTarget<EventMap> {
                 }
 
                 if (topic.isUnread) {
-                    isUnread = true;
+                    unreadTopicCount++;
                 }
 
                 mentionCount += (topic.mentionCount ?? 0);
             }
         }
 
-        const result = { mentionCount, isUnread };
+        const result = { mentionCount, unreadTopicCount, isUnread: unreadTopicCount > 0 };
         this.summariesCache.set(cacheKey, result);
 
         return result;