polfan-server-js-client 0.4.1 → 0.4.2

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, RoomMembersJoined, 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, FollowedTopics, FollowTopic, UpdateFollowedTopic, 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, UpdateSpaceMember, Relationships, RelationshipDeleted, NewRelationship, DeleteRelationship, CreateRelationship, RoomSummaryUpdated, Pong, Ping, RedactMessages, MessagesRedacted, ReportAbuse, UpdateRoomMember, GetRelationships, GetUserInfo, UserInfo, SetSessionData, SessionData, GetSessionData, SetUserData, UserData, GetUserData, UnfollowTopic, TopicUnfollowed, Invite, Uninvite, GetInvited, Invited } from "./types/src";
+import { Bye, GetSession, JoinSpace, Session, SpaceJoined, Error as ErrorType, SpaceLeft, SpaceMemberJoined, SpaceMemberLeft, SpaceMemberUpdated, SpaceDeleted, SpaceMembers, SpaceRooms, NewRole, RoomDeleted, RoomJoined, RoomLeft, RoomMemberLeft, RoomMembersJoined, 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, FollowedTopics, FollowTopic, UpdateFollowedTopic, 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, UpdateSpaceMember, Relationships, RelationshipDeleted, NewRelationship, DeleteRelationship, CreateRelationship, RoomSummaryUpdated, Pong, Ping, RedactMessages, MessagesRedacted, ReportAbuse, UpdateRoomMember, GetRelationships, GetUserInfo, UserInfo, SetSessionData, SessionData, GetSessionData, SetUserData, UserData, GetUserData, UnfollowTopic, TopicUnfollowed, Invite, Uninvite, GetInvited, Invited, React, Unreact, GetReactionDetails, ReactionUpdated, Reacted, ReactionDetails } from "./types/src";
 import { EventTarget } from "./EventTarget";
 type ArrayOfPromiseResolvers = [(value: any) => void, (reason?: any) => void];
 type ExtraEventMap = Record<string, any>;
@@ -90,6 +90,9 @@ export type EventsMap = {
     Topics: Topics;
     TopicUpdated: TopicUpdated;
     MessagesRedacted: MessagesRedacted;
+    ReactionUpdated: ReactionUpdated;
+    Reacted: Reacted;
+    ReactionDetails: ReactionDetails;
 };
 /**
  * Map of commands and their corresponding events.
@@ -160,5 +163,8 @@ export type CommandsMap = {
     GetTopics: CommandDefinition<GetTopics, EventsMap['Topics']>;
     UpdateTopic: CommandDefinition<UpdateTopic, EventsMap['TopicUpdated']>;
     RedactMessages: CommandDefinition<RedactMessages, EventsMap['MessagesRedacted']>;
+    React: CommandDefinition<React, EventsMap['Reacted']>;
+    Unreact: CommandDefinition<Unreact, EventsMap['Reacted']>;
+    GetReactionDetails: CommandDefinition<GetReactionDetails, EventsMap['ReactionDetails']>;
 };
 export {};

package/build/types/Permissions.d.ts

@@ -90,6 +90,14 @@ export declare class Permissions {
             value: number;
             maxLayer: Layer;
         };
+        React: {
+            value: number;
+            maxLayer: Layer;
+        };
+        CreatePolls: {
+            value: number;
+            maxLayer: Layer;
+        };
     };
     static getNames(): (keyof typeof this.list)[];
     static getByName(name: keyof typeof this.list): PermissionDefinition | undefined;

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

@@ -1,4 +1,4 @@
-import { Message, Topic } from "../types/src";
+import { Message, Topic, UserReaction } from "../types/src";
 import { ChatStateTracker } from "./ChatStateTracker";
 import { CollectionEventMap, ObservableIndexedObjectCollection } from "../IndexedObjectCollection";
 export declare enum WindowState {
@@ -94,10 +94,23 @@ export declare class TopicHistoryWindow extends TraversableRemoteCollection<Mess
     readonly WindowState: typeof WindowState;
     protected internalState: typeof TraversableRemoteCollection<Message>['prototype']['internalState'] & {
         traverseLock: boolean;
+        includeMyReactions: boolean;
+        myReactions: Record<string, UserReaction[]>;
     };
     constructor(roomId: string, topicId: string, tracker: ChatStateTracker, bindEvents?: boolean);
     createMirror(): TopicHistoryWindow;
     get isTraverseLocked(): boolean;
+    /**
+     * What the connected user has reacted with, keyed by message id. Kept apart from
+     * the messages, so the history itself is identical for every user.
+     */
+    get myReactions(): Readonly<Record<string, UserReaction[]>>;
+    /**
+     * Whether the history is fetched together with the reactions of the connected
+     * user. Turn it off only where the active state of a reaction is never rendered.
+     */
+    get includeMyReactions(): boolean;
+    set includeMyReactions(value: boolean);
     setTraverseLock(lock: boolean): Promise<void>;
     resetToLatest(force?: boolean): Promise<void>;
     fetchNext(): Promise<void>;
@@ -112,9 +125,21 @@ export declare class TopicHistoryWindow extends TraversableRemoteCollection<Mess
     protected fetchItemsAround(id: string): Promise<Message[] | null>;
     protected fetchItemsBefore(): Promise<Message[] | null>;
     protected fetchLatestItems(): Promise<Message[]>;
+    private fetchMessages;
+    /**
+     * The response is the truth for every message it covers, so a message it does not
+     * mention has no reaction of this user left on it.
+     */
+    private storeMyReactions;
     private getTopic;
     private getLatestMessageId;
     protected isLatestItemLoaded(): Promise<boolean>;
     private handleNewMessage;
+    /**
+     * The counter arrives as the global source of truth - only it is overwritten, and
+     * a reaction nobody holds any more (count 0) leaves the message.
+     */
+    private handleReactionUpdated;
+    private handleReacted;
     private handleMessagesRedacted;
 }

package/package.json

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

package/src/AbstractChatClient.ts

@@ -122,6 +122,12 @@ import {
     Uninvite,
     GetInvited,
     Invited,
+    React,
+    Unreact,
+    GetReactionDetails,
+    ReactionUpdated,
+    Reacted,
+    ReactionDetails,
 } from "./types/src";
 import {EventTarget} from "./EventTarget";
 
@@ -263,6 +269,9 @@ export type CommandResponse<CommandType extends keyof CommandsMap> = CommandsMap
     Topics: Topics,
     TopicUpdated: TopicUpdated,
     MessagesRedacted: MessagesRedacted,
+    ReactionUpdated: ReactionUpdated,
+    Reacted: Reacted,
+    ReactionDetails: ReactionDetails,
 };
 
 /**
@@ -338,4 +347,7 @@ export type CommandsMap = {
     GetTopics: CommandDefinition<GetTopics, EventsMap['Topics']>,
     UpdateTopic: CommandDefinition<UpdateTopic, EventsMap['TopicUpdated']>,
     RedactMessages: CommandDefinition<RedactMessages, EventsMap['MessagesRedacted']>,
+    React: CommandDefinition<React, EventsMap['Reacted']>,
+    Unreact: CommandDefinition<Unreact, EventsMap['Reacted']>,
+    GetReactionDetails: CommandDefinition<GetReactionDetails, EventsMap['ReactionDetails']>,
  }

package/src/Permissions.ts

@@ -33,6 +33,8 @@ export class Permissions {
         ChangeOwnColor: {value: 1 << 18, maxLayer: Layer.Room},
         RedactMessages: {value: 1 << 19, maxLayer: Layer.Topic},
         AddMembers: {value: 1 << 20, maxLayer: Layer.Space},
+        React: {value: 1 << 21, maxLayer: Layer.Topic},
+        CreatePolls: {value: 1 << 22, maxLayer: Layer.Topic},
     };
 
     public static getNames(): (keyof typeof this.list)[] {

package/src/state-tracker/TopicHistoryWindow.ts

@@ -1,4 +1,14 @@
-import {Message, MessagesRedacted, NewMessage, Topic} from "../types/src";
+import {
+    GetMessages,
+    Message,
+    MessageReaction,
+    ReactionUpdated,
+    MessagesRedacted,
+    NewMessage,
+    Reacted,
+    Topic,
+    UserReaction,
+} from "../types/src";
 import {ChatStateTracker} from "./ChatStateTracker";
 import {CollectionEventMap, ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
 
@@ -302,6 +312,8 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<
 
     declare protected internalState: typeof TraversableRemoteCollection<Message>['prototype']['internalState'] & {
         traverseLock: boolean,
+        includeMyReactions: boolean,
+        myReactions: Record<string, UserReaction[]>,
     };
 
     public constructor(
@@ -313,10 +325,14 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<
         super('id');
 
         this.internalState.traverseLock = false;
+        this.internalState.includeMyReactions = true;
+        this.internalState.myReactions = {};
 
         if (bindEvents) {
             this.tracker.client.on('NewMessage', ev => this.handleNewMessage(ev));
             this.tracker.client.on('MessagesRedacted', ev => this.handleMessagesRedacted(ev));
+            this.tracker.client.on('ReactionUpdated', ev => this.handleReactionUpdated(ev));
+            this.tracker.client.on('Reacted', ev => this.handleReacted(ev));
         }
     }
 
@@ -332,6 +348,26 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<
         return this.internalState.traverseLock;
     }
 
+    /**
+     * What the connected user has reacted with, keyed by message id. Kept apart from
+     * the messages, so the history itself is identical for every user.
+     */
+    public get myReactions(): Readonly<Record<string, UserReaction[]>> {
+        return this.internalState.myReactions;
+    }
+
+    /**
+     * Whether the history is fetched together with the reactions of the connected
+     * user. Turn it off only where the active state of a reaction is never rendered.
+     */
+    public get includeMyReactions(): boolean {
+        return this.internalState.includeMyReactions;
+    }
+
+    public set includeMyReactions(value: boolean) {
+        this.internalState.includeMyReactions = value;
+    }
+
     public async setTraverseLock(lock: boolean): Promise<void> {
         this.internalState.traverseLock = lock;
 
@@ -384,70 +420,60 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<
     protected async fetchItemsAfter(): Promise<Message[] | null> {
         const afterId = this.getAt(this.length - 1)?.id;
 
-        if (! afterId) {
-            // If there is no message to refer, fetch latest
-            return null;
-        }
-
-        const result = await this.tracker.client.send('GetMessages', {
-            location: {roomId: this.roomId, topicId: this.topicId},
-            after: afterId,
-            limit: this.internalState.fetchLimit,
-        });
-
-        if (result.error) {
-            throw new Error(`Cannot fetch messages: ${result.error.message}`);
-        }
-
-        return result.data.messages;
+        // If there is no message to refer, fetch latest
+        return afterId ? this.fetchMessages({after: afterId}) : null;
     }
 
     protected async fetchItemsAround(id: string): Promise<Message[] | null> {
-        const result = await this.tracker.client.send('GetMessages', {
-            location: {roomId: this.roomId, topicId: this.topicId},
-            around: id,
-            limit: this.internalState.fetchLimit,
-        });
-
-        if (result.error) {
-            throw new Error(`Cannot fetch messages: ${result.error.message}`);
-        }
-
-        return result.data.messages;
+        return this.fetchMessages({around: id});
     }
 
     protected async fetchItemsBefore(): Promise<Message[] | null> {
         const beforeId = this.getAt(0)?.id;
 
-        if (! beforeId) {
-            // If there is no message to refer, fetch latest
-            return null;
-        }
+        // If there is no message to refer, fetch latest
+        return beforeId ? this.fetchMessages({before: beforeId}) : null;
+    }
 
+    protected async fetchLatestItems(): Promise<Message[]> {
+        return this.fetchMessages({});
+    }
+
+    private async fetchMessages(criteria: Partial<GetMessages>): Promise<Message[]> {
         const result = await this.tracker.client.send('GetMessages', {
             location: {roomId: this.roomId, topicId: this.topicId},
-            before: beforeId,
             limit: this.internalState.fetchLimit,
+            includeMyReactions: this.internalState.includeMyReactions,
+            ...criteria,
         });
 
         if (result.error) {
             throw new Error(`Cannot fetch messages: ${result.error.message}`);
         }
 
+        this.storeMyReactions(result.data.messages, result.data.myReactions);
+
         return result.data.messages;
     }
 
-    protected async fetchLatestItems(): Promise<Message[]> {
-        const result = await this.tracker.client.send('GetMessages', {
-            location: {roomId: this.roomId, topicId: this.topicId},
-            limit: this.internalState.fetchLimit,
-        });
-
-        if (result.error) {
-            throw new Error(`Cannot fetch messages: ${result.error.message}`);
+    /**
+     * The response is the truth for every message it covers, so a message it does not
+     * mention has no reaction of this user left on it.
+     */
+    private storeMyReactions(messages: Message[], myReactions?: Record<string, UserReaction[]>): void {
+        if (! this.internalState.includeMyReactions) {
+            return;
         }
 
-        return result.data.messages;
+        for (const message of messages) {
+            const own = myReactions?.[message.id];
+
+            if (own?.length) {
+                this.internalState.myReactions[message.id] = own;
+            } else {
+                delete this.internalState.myReactions[message.id];
+            }
+        }
     }
 
     private async getTopic(): Promise<Topic | undefined> {
@@ -475,6 +501,59 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<
         }
     }
 
+    /**
+     * The counter arrives as the global source of truth - only it is overwritten, and
+     * a reaction nobody holds any more (count 0) leaves the message.
+     */
+    private handleReactionUpdated(ev: ReactionUpdated): void {
+        const message = this.get(ev.messageId);
+
+        if (! message) {
+            return;
+        }
+
+        const index = message.reactions.findIndex(
+            reaction => reaction.type === ev.reaction.type && reaction.value === ev.reaction.value);
+
+        if (index === -1 && ! ev.reaction.count) {
+            return;
+        }
+
+        const reactions: MessageReaction[] = [...message.reactions];
+
+        if (index === -1) {
+            reactions.push(ev.reaction);
+        } else if (ev.reaction.count) {
+            reactions[index] = ev.reaction; // In place - a pill must not jump around as its counter moves
+        } else {
+            reactions.splice(index, 1);
+        }
+
+        this.set({...message, reactions});
+    }
+
+    private handleReacted(ev: Reacted): void {
+        if (! this.has(ev.messageId)) {
+            return;
+        }
+
+        const {type, value, isAdded} = ev.reaction;
+        const own = (this.internalState.myReactions[ev.messageId] ?? [])
+            .filter(reaction => reaction.type !== type || reaction.value !== value);
+
+        if (isAdded) {
+            own.push({type, value});
+        }
+
+        if (own.length) {
+            this.internalState.myReactions[ev.messageId] = own;
+        } else {
+            delete this.internalState.myReactions[ev.messageId];
+        }
+
+        this.eventTarget.emit('change', {setItems: [ev.messageId]});
+    }
+
     private async handleMessagesRedacted(ev: MessagesRedacted): Promise<void> {
         if (ev.location.topicId !== this.topicId || ev.location.roomId !== this.roomId) {
             return;