polfan-server-js-client 0.2.49 → 0.2.50

package/build/types/AbstractChatClient.d.ts

@@ -1,4 +1,4 @@
-import { Bye, GetSession, JoinSpace, Session, SpaceJoined, Error as ErrorType, SpaceLeft, SpaceMemberJoined, SpaceMemberLeft, SpaceMemberUpdated, SpaceDeleted, SpaceMembers, SpaceRooms, NewRole, RoomDeleted, RoomJoined, RoomLeft, RoomMemberLeft, RoomMemberJoined, RoomMembers, NewRoom, NewTopic, TopicDeleted, NewMessage, GetPermissionOverwrites, GetComputedPermissions, LeaveSpace, CreateSpace, DeleteSpace, GetSpaceMembers, GetSpaceRooms, CreateRole, DeleteRole, AssignRole, DeassignRole, SetPermissionOverwrites, JoinRoom, LeaveRoom, CreateRoom, DeleteRoom, GetRoomMembers, CreateTopic, DeleteTopic, CreateMessage, Envelope, PermissionOverwrites, PermissionOverwritesUpdated, RoomMemberUpdated, UpdateRole, RoleUpdated, Ack, UserUpdated, UpdateRoom, RoomUpdated, UpdateSpace, SpaceUpdated, PermissionOverwriteTargets, GetPermissionOverwriteTargets, Owners, Ok, GetOwners, CreateOwner, RoleDeleted, FollowedTopicUpdated, TopicFollowed, TopicUnfollowed, FollowedTopics, FollowTopic, UnfollowTopic, GetFollowedTopics, Messages, GetMessages, Topics, GetTopics, TopicUpdated, UpdateTopic, GetDiscoverableSpaces, DiscoverableSpaces, CreateEmoticon, DeleteEmoticon, GetEmoticons, Emoticons, EmoticonDeleted, NewEmoticon, Bans, GetBans, Ban, Unban, Kick, ClientData, GetClientData, SetClientData, GetRoomSummary, GetSpaceSummary, RoomSummaryEvent, SpaceSummaryEvent, SetCustomNick, Relationships, RelationshipDeleted, NewRelationship, DeleteRelationship, CreateRelationship } from "./types/src/index";
+import { Bye, GetSession, JoinSpace, Session, SpaceJoined, Error as ErrorType, SpaceLeft, SpaceMemberJoined, SpaceMemberLeft, SpaceMemberUpdated, SpaceDeleted, SpaceMembers, SpaceRooms, NewRole, RoomDeleted, RoomJoined, RoomLeft, RoomMemberLeft, RoomMemberJoined, RoomMembers, NewRoom, NewTopic, TopicDeleted, NewMessage, GetPermissionOverwrites, GetComputedPermissions, LeaveSpace, CreateSpace, DeleteSpace, GetSpaceMembers, GetSpaceRooms, CreateRole, DeleteRole, AssignRole, DeassignRole, SetPermissionOverwrites, JoinRoom, LeaveRoom, CreateRoom, DeleteRoom, GetRoomMembers, CreateTopic, DeleteTopic, CreateMessage, Envelope, PermissionOverwrites, PermissionOverwritesUpdated, RoomMemberUpdated, UpdateRole, RoleUpdated, Ack, UserUpdated, UpdateRoom, RoomUpdated, UpdateSpace, SpaceUpdated, PermissionOverwriteTargets, GetPermissionOverwriteTargets, Owners, Ok, GetOwners, CreateOwner, RoleDeleted, FollowedTopicUpdated, TopicFollowed, TopicUnfollowed, FollowedTopics, FollowTopic, UnfollowTopic, GetFollowedTopics, Messages, GetMessages, Topics, GetTopics, TopicUpdated, UpdateTopic, GetDiscoverableSpaces, DiscoverableSpaces, CreateEmoticon, DeleteEmoticon, GetEmoticons, Emoticons, EmoticonDeleted, NewEmoticon, Bans, GetBans, Ban, Unban, Kick, ClientData, GetClientData, SetClientData, GetRoomSummary, GetSpaceSummary, RoomSummaryEvent, SpaceSummaryEvent, SetCustomNick, Relationships, RelationshipDeleted, NewRelationship, DeleteRelationship, CreateRelationship, RoomSummaryUpdated } from "./types/src/index";
 import { EventTarget } from "./EventTarget";
 import { GetRelationships } from "./types/src/schemes/commands/GetRelationships";
 type ArrayOfPromiseResolvers = [(value: any) => void, (reason?: any) => void];
@@ -62,6 +62,7 @@ export type EventsMap = {
     RoomDeleted: RoomDeleted;
     RoomUpdated: RoomUpdated;
     RoomSummaryEvent: RoomSummaryEvent;
+    RoomSummaryUpdated: RoomSummaryUpdated;
     NewTopic: NewTopic;
     TopicDeleted: TopicDeleted;
     NewMessage: NewMessage;

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

@@ -5,6 +5,7 @@ export declare class RoomMessagesHistory {
     private room;
     private tracker;
     private historyWindows;
+    private traverseLock;
     constructor(room: Room, tracker: ChatStateTracker);
     /**
      * Returns a history window object for the given topic ID, allowing you to view message history.
@@ -14,4 +15,5 @@ export declare class RoomMessagesHistory {
     private handleNewTopic;
     private handleTopicDeleted;
     private createHistoryWindowForTopic;
+    private updateTraverseLock;
 }

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

@@ -45,6 +45,7 @@ export declare class SpacesManager {
     private handleSpaceMemberLeft;
     private handleSpaceMembers;
     private handleSpaceRooms;
+    private handleRoomSummaryUpdated;
     private handleSpaceMemberUpdated;
     private handleRoleUpdated;
     private handleSession;

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

@@ -58,7 +58,13 @@ export declare class TopicHistoryWindow extends TraversableRemoteCollection<Mess
      * Reexported available window modes enum.
      */
     readonly WindowState: typeof WindowState;
+    private traverseLock;
     constructor(roomId: string, topicId: string, tracker: ChatStateTracker);
+    get isTraverseLocked(): boolean;
+    setTraverseLock(lock: boolean): Promise<void>;
+    resetToLatest(): Promise<void>;
+    fetchNext(): Promise<void>;
+    fetchPrevious(): Promise<void>;
     /**
      * For internal use.
      * @internal

package/build/types/types/src/index.d.ts

@@ -124,4 +124,5 @@ import { UserRelationship, UserRelationshipType } from "./schemes/UserRelationsh
 import { DeleteRelationship } from "./schemes/commands/DeleteRelationship";
 import { Relationships } from "./schemes/events/Relationships";
 import { CreateRelationship } from "./schemes/commands/CreateRelationship";
-export { Envelope, Message, MessageType, MessageAuthor, Role, Room, RoomFlag, RoomType, RoomStream, RoomStreamType, RoomHistory, RoomHistoryMode, RoomMember, RoomSummary, RoomSummaryExtras, Space, SpaceFlag, SpaceMember, Topic, FollowedTopic, User, UserState, PermissionOverwritesValue, ChatLocation, SpaceSummary, SpaceDiscoverable, Emoticon, PermissionOverwritesTarget, BanObject, LeaveReason, UserRelationship, UserRelationshipType, CreateTopicInitialMessage, Bye, Error, Messages, NewMessage, NewRole, NewRoom, NewTopic, TopicFollowed, TopicUnfollowed, FollowedTopics, FollowedTopicUpdated, ComputedPermissions, PermissionOverwrites, PermissionOverwritesUpdated, RoleDeleted, RoleUpdated, RoomDeleted, RoomUpdated, RoomJoined, RoomLeft, RoomMemberJoined, RoomMemberLeft, RoomMembers, RoomMemberUpdated, UserUpdated, Session, SpaceDeleted, SpaceUpdated, SpaceJoined, SpaceLeft, SpaceMemberJoined, SpaceMemberLeft, SpaceMembers, SpaceMemberUpdated, SpaceRooms, TopicDeleted, TopicUpdated, PermissionOverwriteTargets, Owners, Ok, DiscoverableSpaces, Emoticons, EmoticonDeleted, NewEmoticon, Bans, ClientData, SpaceSummaryEvent, RoomSummaryEvent, NewRelationship, RelationshipDeleted, Relationships, AssignRole, GetMessages, CreateMessage, Ack, CreateRole, CreateRoom, CreateSpace, CreateTopic, FollowTopic, UnfollowTopic, GetFollowedTopics, DeassignRole, DeleteRole, DeleteRoom, DeleteSpace, DeleteTopic, SetPermissionOverwrites, GetPermissionOverwrites, GetComputedPermissions, GetRoomMembers, GetSession, GetSpaceMembers, GetSpaceRooms, JoinRoom, JoinSpace, LeaveRoom, LeaveSpace, UpdateRole, UpdateSpace, UpdateRoom, UpdateTopic, GetPermissionOverwriteTargets, CreateOwner, DeleteOwner, GetOwners, Topics, GetTopics, GetDiscoverableSpaces, GetEmoticons, CreateEmoticon, DeleteEmoticon, Ban, Unban, GetBans, Kick, GetClientData, SetClientData, GetSpaceSummary, GetRoomSummary, SetCustomNick, CreateRelationship, DeleteRelationship };
+import { RoomSummaryUpdated } from "./schemes/events/RoomSummaryUpdated";
+export { Envelope, Message, MessageType, MessageAuthor, Role, Room, RoomFlag, RoomType, RoomStream, RoomStreamType, RoomHistory, RoomHistoryMode, RoomMember, RoomSummary, RoomSummaryExtras, Space, SpaceFlag, SpaceMember, Topic, FollowedTopic, User, UserState, PermissionOverwritesValue, ChatLocation, SpaceSummary, SpaceDiscoverable, Emoticon, PermissionOverwritesTarget, BanObject, LeaveReason, UserRelationship, UserRelationshipType, CreateTopicInitialMessage, Bye, Error, Messages, NewMessage, NewRole, NewRoom, NewTopic, TopicFollowed, TopicUnfollowed, FollowedTopics, FollowedTopicUpdated, ComputedPermissions, PermissionOverwrites, PermissionOverwritesUpdated, RoleDeleted, RoleUpdated, RoomDeleted, RoomUpdated, RoomJoined, RoomLeft, RoomMemberJoined, RoomMemberLeft, RoomMembers, RoomMemberUpdated, UserUpdated, Session, SpaceDeleted, SpaceUpdated, SpaceJoined, SpaceLeft, SpaceMemberJoined, SpaceMemberLeft, SpaceMembers, SpaceMemberUpdated, SpaceRooms, TopicDeleted, TopicUpdated, PermissionOverwriteTargets, Owners, Ok, DiscoverableSpaces, Emoticons, EmoticonDeleted, NewEmoticon, Bans, ClientData, SpaceSummaryEvent, RoomSummaryEvent, NewRelationship, RelationshipDeleted, Relationships, RoomSummaryUpdated, AssignRole, GetMessages, CreateMessage, Ack, CreateRole, CreateRoom, CreateSpace, CreateTopic, FollowTopic, UnfollowTopic, GetFollowedTopics, DeassignRole, DeleteRole, DeleteRoom, DeleteSpace, DeleteTopic, SetPermissionOverwrites, GetPermissionOverwrites, GetComputedPermissions, GetRoomMembers, GetSession, GetSpaceMembers, GetSpaceRooms, JoinRoom, JoinSpace, LeaveRoom, LeaveSpace, UpdateRole, UpdateSpace, UpdateRoom, UpdateTopic, GetPermissionOverwriteTargets, CreateOwner, DeleteOwner, GetOwners, Topics, GetTopics, GetDiscoverableSpaces, GetEmoticons, CreateEmoticon, DeleteEmoticon, Ban, Unban, GetBans, Kick, GetClientData, SetClientData, GetSpaceSummary, GetRoomSummary, SetCustomNick, CreateRelationship, DeleteRelationship };

package/build/types/types/src/schemes/events/RoomSummaryUpdated.d.ts

@@ -0,0 +1,7 @@
+import { RoomSummary } from "../RoomSummary";
+export interface RoomSummaryUpdated {
+    /**
+     * Partial summary: without the `extras` field.
+     */
+    summary: RoomSummary;
+}

package/package.json

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

package/src/AbstractChatClient.ts

@@ -82,12 +82,26 @@ import {
     GetEmoticons,
     Emoticons,
     EmoticonDeleted,
-    NewEmoticon, Bans, GetBans, Ban, Unban, Kick, ClientData, GetClientData, SetClientData,
+    NewEmoticon,
+    Bans,
+    GetBans,
+    Ban,
+    Unban,
+    Kick,
+    ClientData,
+    GetClientData,
+    SetClientData,
     GetRoomSummary,
     GetSpaceSummary,
     RoomSummaryEvent,
     SpaceSummaryEvent,
-    SetCustomNick, Relationships, RelationshipDeleted, NewRelationship, DeleteRelationship, CreateRelationship,
+    SetCustomNick,
+    Relationships,
+    RelationshipDeleted,
+    NewRelationship,
+    DeleteRelationship,
+    CreateRelationship,
+    RoomSummaryUpdated,
 } from "./types/src/index";
 import {EventTarget} from "./EventTarget";
 import {GetRelationships} from "./types/src/schemes/commands/GetRelationships";
@@ -195,6 +209,7 @@ export type EventsMap = {
     RoomDeleted: RoomDeleted,
     RoomUpdated: RoomUpdated,
     RoomSummaryEvent: RoomSummaryEvent,
+    RoomSummaryUpdated: RoomSummaryUpdated,
     // Topic events
     NewTopic: NewTopic,
     TopicDeleted: TopicDeleted,

package/src/state-tracker/RoomMessagesHistory.ts

@@ -5,6 +5,7 @@ import {TopicHistoryWindow} from "./TopicHistoryWindow";
 
 export class RoomMessagesHistory {
     private historyWindows = new IndexedCollection<string, TopicHistoryWindow>();
+    private traverseLock: boolean = false;
 
     public constructor(
         private room: Room,
@@ -14,6 +15,8 @@ export class RoomMessagesHistory {
         this.tracker.client.on('NewTopic', ev => this.handleNewTopic(ev));
         this.tracker.client.on('TopicDeleted', ev => this.handleTopicDeleted(ev));
 
+        this.updateTraverseLock(this.room);
+
         if (this.room.defaultTopic) {
             this.createHistoryWindowForTopic(this.room.defaultTopic);
         }
@@ -25,7 +28,7 @@ export class RoomMessagesHistory {
     public async getMessagesWindow(topicId: string): Promise<TopicHistoryWindow | undefined> {
         let historyWindow = this.historyWindows.get(topicId);
 
-        if (! historyWindow) {
+        if (!historyWindow) {
             const topic = (await this.tracker.rooms.getTopics(this.room.id, [topicId])).get(topicId);
 
             if (topic) {
@@ -36,13 +39,19 @@ export class RoomMessagesHistory {
         return this.historyWindows.get(topicId);
     }
 
-    private handleRoomUpdated(ev: RoomUpdated): void {
+    private async handleRoomUpdated(ev: RoomUpdated): Promise<void> {
         if (this.room.id === ev.room.id) {
             this.room = ev.room;
 
+            this.updateTraverseLock(ev.room);
+
             if (ev.room.defaultTopic) {
                 this.createHistoryWindowForTopic(ev.room.defaultTopic);
             }
+
+            for (const [, window] of Array.from(this.historyWindows.items)) {
+                await window.setTraverseLock(this.traverseLock);
+            }
         }
     }
 
@@ -63,7 +72,11 @@ export class RoomMessagesHistory {
             return;
         }
 
-        this.historyWindows.set([topic.id, new TopicHistoryWindow(this.room.id, topic.id, this.tracker)]);
+        const historyWindow = new TopicHistoryWindow(this.room.id, topic.id, this.tracker);
+
+        historyWindow.setTraverseLock(this.traverseLock);
+
+        this.historyWindows.set([topic.id, historyWindow]);
 
         // If new topic refers to some message from this room, update other structures
         if (topic.refMessage) {
@@ -71,4 +84,8 @@ export class RoomMessagesHistory {
             refHistoryWindow?._updateMessageReference(topic);
         }
     }
+
+    private updateTraverseLock(room: Room): void {
+        this.traverseLock = room.history.mode === 'Ephemeral';
+    }
 }

package/src/state-tracker/SpacesManager.ts

@@ -8,6 +8,7 @@ import {
     RoleUpdated,
     RoomDeleted,
     RoomSummary,
+    RoomSummaryUpdated,
     RoomUpdated,
     Session,
     Space,
@@ -48,6 +49,7 @@ export class SpacesManager {
         this.tracker.client.on('SpaceMemberLeft', ev => this.handleSpaceMemberLeft(ev));
         this.tracker.client.on('SpaceMembers', ev => this.handleSpaceMembers(ev));
         this.tracker.client.on('SpaceRooms', ev => this.handleSpaceRooms(ev));
+        this.tracker.client.on('RoomSummaryUpdated', ev => this.handleRoomSummaryUpdated(ev));
         this.tracker.client.on('SpaceMemberUpdated', ev => this.handleSpaceMemberUpdated(ev));
         this.tracker.client.on('UserUpdated', ev => this.handleUserUpdated(ev));
         this.tracker.client.on('NewRole', ev => this.handleNewRole(ev));
@@ -229,12 +231,37 @@ export class SpacesManager {
     }
 
     private handleSpaceRooms(ev: SpaceRooms): void {
-        if (! this.rooms.has(ev.id)) {
+        if (!this.rooms.has(ev.id)) {
             this.rooms.set([ev.id, new ObservableIndexedObjectCollection('id', ev.summaries)]);
             ev.summaries.forEach(summary => this.roomIdToSpaceId.set([summary.id, ev.id]));
         }
     }
 
+    private async handleRoomSummaryUpdated(ev: RoomSummaryUpdated): Promise<void> {
+        const spaceId = this.roomIdToSpaceId.get(ev.summary.id);
+        const summariesPromise = this.roomsPromises.get(spaceId);
+
+        /**
+         * Update summary only if the list was already loaded.
+         * RoomSummaryUpdated event has a partial summary, so we need to update the existing summary by merging it.
+         */
+        if (spaceId && summariesPromise) {
+            await summariesPromise;
+
+            const summaries = this.rooms.get(spaceId);
+            const oldSummary = summaries.get(ev.summary.id);
+            let newSummary: RoomSummary;
+
+            if (oldSummary) {
+                newSummary = {...oldSummary, ...ev.summary};
+            } else {
+                newSummary = ev.summary;
+            }
+
+            summaries.set(newSummary);
+        }
+    }
+
     private handleSpaceMemberUpdated(ev: SpaceMemberUpdated): void {
         if (this.members.has(ev.spaceId)) {
             const members = this.members.get(ev.spaceId);

package/src/state-tracker/TopicHistoryWindow.ts

@@ -187,6 +187,8 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
      */
     public readonly WindowState: typeof WindowState = WindowState;
 
+    private traverseLock: boolean = false;
+
     public constructor(
         private roomId: string,
         private topicId: string,
@@ -197,6 +199,39 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
         this.tracker.client.on('NewMessage', ev => this.handleNewMessage(ev));
     }
 
+    public get isTraverseLocked(): boolean {
+        return this.traverseLock;
+    }
+
+    public async setTraverseLock(lock: boolean): Promise<void> {
+        this.traverseLock = lock;
+
+        if (lock && (this.state !== WindowState.LIVE && this.state !== WindowState.LATEST)) {
+            await super.resetToLatest();
+        }
+    }
+
+    public async resetToLatest(): Promise<void> {
+        if (this.traverseLock) {
+            return;
+        }
+        return super.resetToLatest();
+    }
+
+    public async fetchNext(): Promise<void> {
+        if (this.traverseLock) {
+            return;
+        }
+        return super.fetchNext();
+    }
+
+    public async fetchPrevious(): Promise<void> {
+        if (this.traverseLock) {
+            return;
+        }
+        return super.fetchPrevious();
+    }
+
     /**
      * For internal use.
      * @internal

package/src/types/src/index.ts

@@ -124,6 +124,7 @@ import {UserRelationship, UserRelationshipType} from "./schemes/UserRelationship
 import {DeleteRelationship} from "./schemes/commands/DeleteRelationship";
 import {Relationships} from "./schemes/events/Relationships";
 import {CreateRelationship} from "./schemes/commands/CreateRelationship";
+import {RoomSummaryUpdated} from "./schemes/events/RoomSummaryUpdated";
 
 export {
     // objects
@@ -212,6 +213,7 @@ export {
     NewRelationship,
     RelationshipDeleted,
     Relationships,
+    RoomSummaryUpdated,
     // commands
     AssignRole,
     GetMessages,

package/src/types/src/schemes/events/RoomSummaryUpdated.ts

@@ -0,0 +1,8 @@
+import {RoomSummary} from "../RoomSummary";
+
+export interface RoomSummaryUpdated {
+    /**
+     * Partial summary: without the `extras` field.
+     */
+    summary: RoomSummary;
+}