polfan-server-js-client 0.2.89 → 0.2.91

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

@@ -1,5 +1,5 @@
 import { ChatStateTracker } from "./ChatStateTracker";
-import { FollowedTopic } from "../types/src";
+import { FollowedTopic, Message, ChatLocation } from "../types/src";
 import { ObservableIndexedObjectCollection } from "../IndexedObjectCollection";
 import { RoomMessagesHistory } from "./RoomMessagesHistory";
 export declare class MessagesManager {
@@ -38,6 +38,11 @@ export declare class MessagesManager {
      * @internal
      */
     _deleteByTopicIds(roomId: string, ...topicIds: string[]): void;
+    /**
+     * For internal use.
+     * @internal
+     */
+    _resolveLastMessage(location: ChatLocation): Promise<Message | null>;
     private createHistoryForNewRoom;
     private handleNewMessage;
     private handleFollowedTopicUpdated;

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

@@ -9,8 +9,10 @@ export declare class RoomMessagesHistory {
     constructor(room: Room, tracker: ChatStateTracker);
     /**
      * Returns a history window object for the given topic ID, allowing you to view message history.
+     * @param topicId
+     * @param peek If true, do not create a cache for this topic and do not allow it to collect new messages.
      */
-    getMessagesWindow(topicId: string): Promise<TopicHistoryWindow | undefined>;
+    getMessagesWindow(topicId: string, peek?: boolean): Promise<TopicHistoryWindow | undefined>;
     private handleRoomUpdated;
     private handleNewTopic;
     private handleTopicDeleted;

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

@@ -73,6 +73,7 @@ export declare abstract class TraversableRemoteCollection<ItemT, EventMapT exten
     protected abstract isLatestItemLoaded(): Promise<boolean>;
     protected refreshFetchedState(): Promise<void>;
     protected addItems(newItems: ItemT[], to: 'head' | 'tail'): void;
+    protected emitChangeWithDiff(itemChanged: boolean, originalState: WindowState): void;
     /**
      * Return array with messages trimmed using High/Low Watermark strategy.
      */
@@ -104,12 +105,12 @@ export declare class TopicHistoryWindow extends TraversableRemoteCollection<Mess
      * @internal
      */
     _updateMessageReference(refTopic: Topic): void;
-    private handleNewMessage;
-    private handleMessagesRedacted;
     protected fetchItemsAfter(): Promise<Message[] | null>;
     protected fetchItemsBefore(): Promise<Message[] | null>;
     protected fetchLatestItems(): Promise<Message[]>;
     private getTopic;
     private getLatestMessageId;
     protected isLatestItemLoaded(): Promise<boolean>;
+    private handleNewMessage;
+    private handleMessagesRedacted;
 }

package/package.json

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

package/src/state-tracker/MessagesManager.ts

@@ -7,7 +7,12 @@ import {
     RoomDeleted,
     RoomLeft,
     TopicDeleted,
-    FollowedTopicUpdated, RoomJoined, NewTopic, Session, Room, MessageType,
+    FollowedTopicUpdated,
+    RoomJoined,
+    NewTopic,
+    Session,
+    Room,
+    Message, ChatLocation,
 } from "../types/src";
 import {
     IndexedCollection,
@@ -129,7 +134,7 @@ export class MessagesManager {
             return collection.items.reduce(
                 (previousValue: number, currentValue) => previousValue + (currentValue.missed ?? 0),
                 0,
-            );
+            ) as number;
         }
 
         return undefined;
@@ -143,6 +148,30 @@ export class MessagesManager {
         this.followedTopics.get(roomId)?.delete(...topicIds);
     }
 
+    /**
+     * For internal use.
+     * @internal
+     */
+    public async _resolveLastMessage(location: ChatLocation): Promise<Message|null> {
+        // Try to get last message from history window (if cached)
+        let message: Message = await this.getRoomHistory(location.roomId)
+            .then(roomHistory => roomHistory?.getMessagesWindow(location.topicId, true))
+            .then(
+                historyWindow =>
+                    historyWindow?.hasLatest && historyWindow.getAt(historyWindow.length - 1)
+            );
+
+        if (!message) {
+            const result = await this.tracker.client.send('GetMessages', {
+                location,
+                limit: 1,
+            });
+            message = result.data?.messages[0];
+        }
+
+        return message || null;
+    }
+
     private createHistoryForNewRoom(room: Room): void {
         this.roomHistories.set([room.id, new RoomMessagesHistory(room, this.tracker)]);
     }

package/src/state-tracker/RoomMessagesHistory.ts

@@ -24,9 +24,11 @@ export class RoomMessagesHistory {
 
     /**
      * Returns a history window object for the given topic ID, allowing you to view message history.
+     * @param topicId
+     * @param peek If true, do not create a cache for this topic and do not allow it to collect new messages.
      */
-    public async getMessagesWindow(topicId: string): Promise<TopicHistoryWindow | undefined> {
-        if (!this.historyWindows.has(topicId)) {
+    public async getMessagesWindow(topicId: string, peek: boolean = false): Promise<TopicHistoryWindow | undefined> {
+        if (!this.historyWindows.has(topicId) && !peek) {
             const topic = (await this.tracker.rooms.getTopics(this.room.id, [topicId])).get(topicId);
 
             if (topic) {

package/src/state-tracker/RoomsManager.ts

@@ -1,5 +1,6 @@
 import {IndexedCollection, ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
 import {
+    Message,
     MessagesRedacted,
     NewMessage,
     NewTopic,
@@ -368,16 +369,14 @@ export class RoomsManager {
         }
     }
 
-    private handleMessagesRedacted(ev: MessagesRedacted): void {
+    private async handleMessagesRedacted(ev: MessagesRedacted): Promise<void> {
         // Remove redacted messages from topic and update metadata
         const topics = this.topics.get(ev.location.roomId);
         const topic = topics?.get(ev.location.topicId);
         if (topic) {
-            topics.set({
-                ...topic,
-                messageCount: Math.max(topic.messageCount - ev.ids.length, 0),
-                lastMessage: ev.ids.includes(topic.lastMessage?.id) ? null : topic.lastMessage,
-            } as Topic);
+            const messageCount = Math.max(topic.messageCount - ev.ids.length, 0);
+            const lastMessage: Message = messageCount > 0 ? await this.messages._resolveLastMessage(ev.location) : null;
+            topics.set({ ...topic, messageCount, lastMessage } as Topic);
         }
     }
 }

package/src/state-tracker/TopicHistoryWindow.ts

@@ -116,9 +116,9 @@ export abstract class TraversableRemoteCollection<
             return;
         }
 
-        this.internalState.ongoing = WindowState.LATEST;
-
         let result;
+        const originalState = this.state;
+        this.internalState.ongoing = WindowState.LATEST;
 
         try {
             result = await this.fetchLatestItems();
@@ -130,6 +130,7 @@ export abstract class TraversableRemoteCollection<
         this._items.deleteAll(); // Directly call deleteAll to prevent event emit.
         this.addItems(result, 'tail');
         this.internalState.current = WindowState.LATEST;
+        this.emitChangeWithDiff(true, originalState);
     }
 
     public async fetchPrevious(): Promise<void> {
@@ -137,9 +138,9 @@ export abstract class TraversableRemoteCollection<
             return;
         }
 
-        this.internalState.ongoing = WindowState.PAST;
-
         let result;
+        const originalState = this.state;
+        this.internalState.ongoing = WindowState.PAST;
 
         try {
             result = await this.fetchItemsBefore();
@@ -163,11 +164,13 @@ export abstract class TraversableRemoteCollection<
                 this.internalState.current = WindowState.OLDEST;
             }
 
+            this.emitChangeWithDiff(false, originalState);
             return;
         }
 
         this.addItems(result, 'head');
         await this.refreshFetchedState();
+        this.emitChangeWithDiff(true, originalState);
     }
 
     public async fetchNext(): Promise<void> {
@@ -175,9 +178,9 @@ export abstract class TraversableRemoteCollection<
             return;
         }
 
-        this.internalState.ongoing = WindowState.PAST;
-
         let result;
+        const originalState = this.state;
+        this.internalState.ongoing = WindowState.PAST;
 
         try {
             result = await this.fetchItemsAfter();
@@ -194,6 +197,7 @@ export abstract class TraversableRemoteCollection<
         if (result.length) {
             this.addItems(result, 'tail');
             await this.refreshFetchedState();
+            this.emitChangeWithDiff(true, originalState);
             return;
         }
     }
@@ -221,8 +225,15 @@ export abstract class TraversableRemoteCollection<
             result = this.trimItemsArrayToLimit([...this.items, ...newItems], 'head');
         }
 
-        this._items.deleteAll(); // Directly call deleteAll to prevent event emit.
-        this.set(...result);
+        // Directly calls to prevent event emit.
+        this._items.deleteAll();
+        this._items.set(...(result.map(item => [this.getId(item), item] as [string, ItemT])));
+    }
+
+    protected emitChangeWithDiff(itemChanged: boolean, originalState: WindowState): void {
+        if (itemChanged || originalState !== this.state) {
+            this.eventTarget.emit('change', { setItems: Array.from(this._items.items.keys()) })
+        }
     }
 
     /**
@@ -336,36 +347,6 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<
         }
     }
 
-    private async handleNewMessage(ev: NewMessage): Promise<void> {
-        if (
-            [WindowState.LATEST, WindowState.LIVE].includes(this.state)
-            && ev.message.location.roomId === this.roomId
-            && ev.message.location.topicId === this.topicId
-        ) {
-            this.addItems([ev.message], 'tail');
-        }
-    }
-
-    private async handleMessagesRedacted(ev: MessagesRedacted): Promise<void> {
-        if (ev.location.topicId !== this.topicId || ev.location.roomId !== this.roomId) {
-            return;
-        }
-
-        const refTopicIds = this.items
-            .filter(msg => msg.topicRef && ev.ids.includes(msg.id))
-            .map(msg => msg.topicRef as string);
-
-        this.delete(...ev.ids);
-
-        if (this.length === 0) {
-            await this.resetToLatest();
-        }
-
-        if (refTopicIds.length > 0) {
-            this.eventTarget.emit('reftopicsdeleted', refTopicIds);
-        }
-    }
-
     protected async fetchItemsAfter(): Promise<Message[] | null> {
         const afterId = this.getAt(this.length - 1)?.id;
 
@@ -433,4 +414,36 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<
         const lastMessageId = await this.getLatestMessageId();
         return lastMessageId ? this.has(lastMessageId) : true;
     }
+
+    private async handleNewMessage(ev: NewMessage): Promise<void> {
+        if (
+            [WindowState.LATEST, WindowState.LIVE].includes(this.state)
+            && ev.message.location.roomId === this.roomId
+            && ev.message.location.topicId === this.topicId
+        ) {
+            const originalState = this.state;
+            this.addItems([ev.message], 'tail');
+            this.emitChangeWithDiff(true, originalState);
+        }
+    }
+
+    private async handleMessagesRedacted(ev: MessagesRedacted): Promise<void> {
+        if (ev.location.topicId !== this.topicId || ev.location.roomId !== this.roomId) {
+            return;
+        }
+
+        const refTopicIds = this.items
+            .filter(msg => msg.topicRef && ev.ids.includes(msg.id))
+            .map(msg => msg.topicRef as string);
+
+        this.delete(...ev.ids);
+
+        if (this.length === 0) {
+            await this.resetToLatest();
+        }
+
+        if (refTopicIds.length > 0) {
+            this.eventTarget.emit('reftopicsdeleted', refTopicIds);
+        }
+    }
 }