polfan-server-js-client 0.2.2 → 0.2.6

package/src/state-tracker/TopicHistoryWindow.ts

@@ -31,60 +31,80 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
      * Current mode od collection window. To change mode, call one of available fetch methods.
      */
     public get state(): WindowState {
-        return this.currentState;
+        return this.internalState.current;
     }
 
+    protected internalState: {
+        current: WindowState,
+        ongoing?: WindowState,
+        limit: number | null,
+        oldestId: string | null,
+    } = {
+        current: WindowState.LIVE,
+        ongoing: undefined,
+        limit: 50,
+        oldestId: null,
+    };
+
     /**
      * Maximum numer of items stored in window.
      * Null for unlimited.
      */
-    public limit: number | null = 50;
+    public get limit(): number | null {
+        return this.internalState.limit;
+    }
 
-    private currentState: WindowState = WindowState.LIVE;
-    private fetchingState: WindowState = undefined;
-    public oldestId: string = null;
+    /**
+     * Maximum numer of items stored in window.
+     * Null for unlimited.
+     */
+    public set limit(value: number | null) {
+        this.internalState.limit = value;
+    }
 
     public get hasLatest(): boolean {
         return [WindowState.LATEST, WindowState.LIVE].includes(this.state);
     }
 
     public get hasOldest(): boolean {
-        return this.state === WindowState.OLDEST || this.oldestId !== null && this.has(this.oldestId);
+        return this.state === WindowState.OLDEST || this.internalState.oldestId !== null && this.has(this.internalState.oldestId);
     }
 
+    public abstract createMirror(): TraversableRemoteCollection<T>;
+
     public async resetToLatest(): Promise<void> {
-        if (this.fetchingState || this.currentState === WindowState.LATEST) {
+        if (this.internalState.ongoing || this.internalState.current === WindowState.LATEST) {
             return;
         }
 
-        this.fetchingState = WindowState.LATEST;
+        this.internalState.ongoing = WindowState.LATEST;
 
         let result;
 
         try {
             result = await this.fetchLatestItems();
         } finally {
-            this.fetchingState = undefined;
+            this.internalState.ongoing = undefined;
         }
 
         this.deleteAll();
         this.addItems(result, 'tail');
-        this.currentState = WindowState.LATEST;
+        this.internalState.current = WindowState.LATEST;
     }
 
     public async fetchPrevious(): Promise<void> {
-        if (this.fetchingState || this.hasOldest) {
+        if (this.internalState.ongoing || this.hasOldest) {
             return;
         }
 
-        this.fetchingState = WindowState.PAST;
+        this.internalState.ongoing = WindowState.PAST;
 
         let result;
 
         try {
             result = await this.fetchItemsBefore();
         } finally {
-            this.fetchingState = undefined;
+            this.internalState.ongoing = undefined;
         }
 
         if (! result) {
@@ -93,13 +113,13 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
 
         if (! result.length) {
             const firstItem = this.getAt(0);
-            this.oldestId = firstItem ? this.getId(firstItem) : null;
+            this.internalState.oldestId = firstItem ? this.getId(firstItem) : null;
 
             await this.refreshFetchedState();
 
             // LATEST state has priority over OLDEST
-            if (this.currentState === WindowState.PAST) {
-                this.currentState = WindowState.OLDEST;
+            if (this.internalState.current === WindowState.PAST) {
+                this.internalState.current = WindowState.OLDEST;
             }
 
             return;
@@ -110,18 +130,18 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
     }
 
     public async fetchNext(): Promise<void> {
-        if (this.fetchingState || this.hasLatest) {
+        if (this.internalState.ongoing || this.hasLatest) {
             return;
         }
 
-        this.fetchingState = WindowState.PAST;
+        this.internalState.ongoing = WindowState.PAST;
 
         let result;
 
         try {
             result = await this.fetchItemsAfter();
         } finally {
-            this.fetchingState = undefined;
+            this.internalState.ongoing = undefined;
         }
 
         if (! result) {
@@ -145,7 +165,7 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
     protected abstract isLatestItemLoaded(): Promise<boolean>;
 
     protected async refreshFetchedState(): Promise<void> {
-        this.currentState = (await this.isLatestItemLoaded()) ? WindowState.LATEST : WindowState.PAST;
+        this.internalState.current = (await this.isLatestItemLoaded()) ? WindowState.LATEST : WindowState.PAST;
     }
 
     protected addItems(newItems: T[], to: 'head' | 'tail'): void {
@@ -187,14 +207,65 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
      */
     public readonly WindowState: typeof WindowState = WindowState;
 
+    declare protected internalState: typeof TraversableRemoteCollection<Message>['prototype']['internalState'] & {
+        traverseLock: boolean,
+    };
+
     public constructor(
         private roomId: string,
         private topicId: string,
         private tracker: ChatStateTracker,
+        bindEvents: boolean = true,
     ) {
         super('id');
-        this.tracker.client.on('Session', ev => this.handleSession(ev));
-        this.tracker.client.on('NewMessage', ev => this.handleNewMessage(ev));
+
+        this.internalState.traverseLock = false;
+
+        if (bindEvents) {
+            this.tracker.client.on('Session', ev => this.handleSession(ev));
+            this.tracker.client.on('NewMessage', ev => this.handleNewMessage(ev));
+        }
+    }
+
+    public createMirror(): TopicHistoryWindow {
+        const copy = new TopicHistoryWindow(this.roomId, this.topicId, this.tracker, false);
+        copy.eventTarget = this.eventTarget;
+        copy._items = this._items;
+        copy.internalState = this.internalState;
+        return copy;
+    }
+
+    public get isTraverseLocked(): boolean {
+        return this.internalState.traverseLock;
+    }
+
+    public async setTraverseLock(lock: boolean): Promise<void> {
+        this.internalState.traverseLock = lock;
+
+        if (lock && (this.state !== WindowState.LIVE && this.state !== WindowState.LATEST)) {
+            await super.resetToLatest();
+        }
+    }
+
+    public async resetToLatest(): Promise<void> {
+        if (this.internalState.traverseLock) {
+            return;
+        }
+        return super.resetToLatest();
+    }
+
+    public async fetchNext(): Promise<void> {
+        if (this.internalState.traverseLock) {
+            return;
+        }
+        return super.fetchNext();
+    }
+
+    public async fetchPrevious(): Promise<void> {
+        if (this.internalState.traverseLock) {
+            return;
+        }
+        return super.fetchPrevious();
     }
 
     /**
@@ -224,7 +295,7 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
         const rooms = ev.state.rooms;
 
         if (rooms.find(room => room.id === this.roomId)) {
-            this.resetToLatest();
+            void this.resetToLatest();
         } else {
             this.deleteAll();
         }

package/src/state-tracker/UsersManager.ts

@@ -2,8 +2,11 @@ import {ChatStateTracker} from "./ChatStateTracker";
 import {ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
 import {RoomMember, Session, SpaceMember, User} from "../types/src";
 import {extractUserFromMember} from "./functions";
+import {EventTarget} from "../EventTarget";
 
 export class UsersManager {
+    public readonly onlineStatus = new EventTarget();
+
     private readonly users: ObservableIndexedObjectCollection<User> = new ObservableIndexedObjectCollection('id');
 
     public constructor(private tracker: ChatStateTracker) {
@@ -26,15 +29,22 @@ export class UsersManager {
     }
 
     private handleMembers(members: (RoomMember | SpaceMember)[]): void {
-        this.users.set(...members.map(extractUserFromMember));
-    }
-
-    private handleUsers(users: User[]): void {
-        this.users.set(...users);
+        this.handleUsers(members.map(extractUserFromMember));
     }
 
     private handleSession(session: Session): void {
         this.users.deleteAll();
-        this.users.set(session.user);
+        this.handleUsers([session.user]);
+    }
+
+    private handleUsers(users: User[]): void {
+        users.forEach(newUser => {
+            const oldUser = this.users.get(newUser.id);
+            if (oldUser && oldUser.online !== newUser.online) {
+                this.onlineStatus.emit('change', newUser);
+            }
+        });
+
+        this.users.set(...users);
     }
 }

package/src/types/src/index.ts

@@ -57,7 +57,7 @@ import {LeaveRoom} from "./schemes/commands/LeaveRoom";
 import {CreateRoom} from "./schemes/commands/CreateRoom";
 import {DeleteRoom} from "./schemes/commands/DeleteRoom";
 import {GetRoomMembers} from "./schemes/commands/GetRoomMembers";
-import {CreateTopic} from "./schemes/commands/CreateTopic";
+import {CreateTopic, CreateTopicInitialMessage} from "./schemes/commands/CreateTopic";
 import {DeleteTopic} from "./schemes/commands/DeleteTopic";
 import {CreateMessage} from "./schemes/commands/CreateMessage";
 import {UpdateRole} from "./schemes/commands/UpdateRole";
@@ -111,12 +111,21 @@ import {GetClientData} from "./schemes/commands/GetClientData";
 import {SetClientData} from "./schemes/commands/SetClientData";
 import {ClientData} from "./schemes/events/ClientData";
 import {RoomStream, RoomStreamType} from "./schemes/RoomStream";
+import {RoomHistory, RoomHistoryMode} from "./schemes/RoomHistory";
 import {GetRoomSummary} from "./schemes/commands/GetRoomSummary";
 import {GetSpaceSummary} from "./schemes/commands/GetSpaceSummary";
 import {SpaceFlag} from "./schemes/Space";
 import {SpaceSummary as SpaceSummaryEvent} from "./schemes/events/SpaceSummary";
 import {RoomSummary as RoomSummaryEvent} from "./schemes/events/RoomSummary";
-import {SetCustomNick} from "./schemes/commands/SetCustomNick";
+import {UpdateSpaceMember} from "./schemes/commands/UpdateSpaceMember";
+import {NewRelationship} from "./schemes/events/NewRelationship";
+import {RelationshipDeleted} from "./schemes/events/RelationshipDeleted";
+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";
+import {UpdateRoomMember} from "./schemes/commands/UpdateRoomMember";
 
 export {
     // objects
@@ -128,6 +137,10 @@ export {
     Room,
     RoomFlag,
     RoomType,
+    RoomStream,
+    RoomStreamType,
+    RoomHistory,
+    RoomHistoryMode,
     RoomMember,
     RoomSummary,
     RoomSummaryExtras,
@@ -146,8 +159,9 @@ export {
     PermissionOverwritesTarget,
     BanObject,
     LeaveReason,
-    RoomStream,
-    RoomStreamType,
+    UserRelationship,
+    UserRelationshipType,
+    CreateTopicInitialMessage,
     // events
     Bye,
     Error,
@@ -197,6 +211,10 @@ export {
     ClientData,
     SpaceSummaryEvent,
     RoomSummaryEvent,
+    NewRelationship,
+    RelationshipDeleted,
+    Relationships,
+    RoomSummaryUpdated,
     // commands
     AssignRole,
     GetMessages,
@@ -247,5 +265,8 @@ export {
     SetClientData,
     GetSpaceSummary,
     GetRoomSummary,
-    SetCustomNick,
+    UpdateSpaceMember,
+    CreateRelationship,
+    DeleteRelationship,
+    UpdateRoomMember,
 };

package/src/types/src/schemes/Emoticon.ts

@@ -6,4 +6,5 @@ export interface Emoticon {
     name: string;
     fileId: string;
     user: User;
+    tag?: string;
 }

package/src/types/src/schemes/Message.ts

@@ -1,7 +1,7 @@
 import {User} from "./User";
 import {ChatLocation} from "./ChatLocation";
 
-export type MessageType = 'Text'|'RoomJoin'|'RoomLeave'|'SpaceJoin'|'SpaceLeave'|'TopicChange'|'CustomNickChange';
+export type MessageType = 'Text'|'RoomJoin'|'RoomLeave'|'SpaceJoin'|'SpaceLeave'|'TopicChange'|'CustomNickChange'|'Ephemeral';
 
 export interface MessageAuthor {
     user: User;

package/src/types/src/schemes/Room.ts

@@ -1,6 +1,7 @@
 import {Topic} from "./Topic";
 import {User} from "./User";
 import {RoomStream} from "./RoomStream";
+import {RoomHistory} from "./RoomHistory";
 
 export type RoomType = 'Text' | 'ClassicText' | 'Pm';
 
@@ -19,4 +20,5 @@ export interface Room {
     recipients: User[] | null;
     flags: number;
     stream: RoomStream | null;
+    history: RoomHistory | null;
 }

package/src/types/src/schemes/RoomHistory.ts

@@ -0,0 +1,6 @@
+export type RoomHistoryMode = 'Full' | 'Ephemeral' | 'MaxAge';
+
+export interface RoomHistory {
+    mode: RoomHistoryMode;
+    maxAge?: number;
+}

package/src/types/src/schemes/RoomSummary.ts

@@ -8,6 +8,7 @@ export interface RoomSummary {
     id: string;
     name: string;
     description: string;
+    memberCount: number;
     type: RoomType;
     extras?: RoomSummaryExtras;
 }

package/src/types/src/schemes/SpaceSummary.ts

@@ -4,4 +4,5 @@ export interface SpaceSummary {
     description: string;
     icon?: string;
     banner?: string;
+    memberCount: number;
 }

package/src/types/src/schemes/User.ts

@@ -1,9 +1,9 @@
-export type UserFlag = 'bot' | 'temp';
+export type UserTags = 'bot' | 'temp';
 
 export interface User {
     id: string;
     nick: string;
     avatar: string;
-    flags: UserFlag[];
+    tags: UserTags[];
     online: boolean;
 }

package/src/types/src/schemes/UserRelationship.ts

@@ -0,0 +1,8 @@
+import {User} from "./User";
+
+export type UserRelationshipType = 'Ignore';
+
+export interface UserRelationship {
+    refUser: User;
+    type: UserRelationshipType;
+}

package/src/types/src/schemes/commands/CreateMessage.ts

@@ -4,4 +4,6 @@ export interface CreateMessage {
     location: ChatLocation;
     content: string;
     attachments?: string[];
+    customNick?: string;
+    customColor?: string;
 }

package/src/types/src/schemes/commands/CreateRelationship.ts

@@ -0,0 +1,6 @@
+import {UserRelationshipType} from "../UserRelationship";
+
+export interface CreateRelationship {
+    refUserId: string;
+    type: UserRelationshipType;
+}

package/src/types/src/schemes/commands/CreateTopic.ts

@@ -1,9 +1,13 @@
 import {ChatLocation} from "../ChatLocation";
-import {CreateMessage} from "./CreateMessage";
+
+export interface CreateTopicInitialMessage {
+    content?: string;
+    attachments?: string[];
+}
 
 export interface CreateTopic {
     location: ChatLocation;
     name: string;
     refMessageId?: string;
-    initialMessage?: Omit<CreateMessage, 'location'>;
+    initialMessage?: CreateTopicInitialMessage;
 }

package/src/types/src/schemes/commands/DeleteRelationship.ts

@@ -0,0 +1,6 @@
+import {UserRelationshipType} from "../UserRelationship";
+
+export interface DeleteRelationship {
+    refUserId: string;
+    type: UserRelationshipType;
+}

package/src/types/src/schemes/commands/GetRelationships.ts

@@ -0,0 +1,3 @@
+export interface GetRelationships {
+
+}

package/src/types/src/schemes/commands/UpdateRoom.ts

@@ -1,4 +1,5 @@
 import {RoomStream} from "../RoomStream";
+import {RoomHistory} from "../RoomHistory";
 
 export interface UpdateRoom {
     id: string;
@@ -6,4 +7,5 @@ export interface UpdateRoom {
     description?: string;
     flags?: number;
     stream?: RoomStream | null;
+    history?: RoomHistory;
 }

package/src/types/src/schemes/commands/UpdateRoomMember.ts

@@ -0,0 +1,7 @@
+export interface UpdateRoomMember {
+    roomId: string;
+    userId: string;
+    customNick?: string|null;
+    customColor?: string|null;
+    extras?: string|null;
+}

package/src/types/src/schemes/commands/UpdateSpaceMember.ts

@@ -0,0 +1,5 @@
+export interface UpdateSpaceMember {
+    spaceId: string;
+    userId: string;
+    customNick?: string|null;
+}

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

@@ -0,0 +1,5 @@
+import {UserRelationship} from "../UserRelationship";
+
+export interface NewRelationship {
+    relationship: UserRelationship;
+}

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

@@ -0,0 +1,5 @@
+import {UserRelationship} from "../UserRelationship";
+
+export interface RelationshipDeleted {
+    relationship: UserRelationship;
+}

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

@@ -0,0 +1,5 @@
+import {UserRelationship} from "../UserRelationship";
+
+export interface Relationships {
+    relationships: UserRelationship[];
+}

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;
+}

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

@@ -3,6 +3,7 @@ import {User} from "../User";
 
 export interface Session {
     serverVersion: string;
+    protoVersion: string;
     state: UserState;
     user: User;
 }

package/tests/history-window.test.ts

@@ -1,4 +1,5 @@
-import {TraversableRemoteCollection, WindowState} from "../src/state-tracker/TopicHistoryWindow";
+import { IndexedObjectCollection } from "../src";
+import {TopicHistoryWindow, TraversableRemoteCollection, WindowState} from "../src/state-tracker/TopicHistoryWindow";
 
 interface SimpleMessage {
     id: number;
@@ -18,6 +19,10 @@ const messages: SimpleMessage[] = [
 ];
 
 class TestableHistoryWindow extends TraversableRemoteCollection<SimpleMessage> {
+    public createMirror(): TraversableRemoteCollection<SimpleMessage> {
+        throw new Error('Method not implemented.');
+    }
+
     public constructor() {
         super('id');
     }

package/webpack.config.browser.js

@@ -1,6 +1,5 @@
 const path = require('path');
-const TerserPlugin = require('terser-webpack-plugin');
-const MiniCssExtractPlugin = require("mini-css-extract-plugin");
+const TerserPlugin = require("terser-webpack-plugin");
 
 module.exports = {
     mode: "production",
@@ -27,32 +26,11 @@ module.exports = {
                 test: /\.(m|j|t)s$/,
                 exclude: /(node_modules|bower_components)/,
                 use: {
-                    loader: 'babel-loader',
-                    options: {
-                        presets: [
-                            ['@babel/preset-env', { targets: { esmodules: true } }],
-                            '@babel/preset-typescript'
-                        ],
-                        plugins: [
-
-                        ]
-                    }
+                    loader: 'babel-loader'
                 }
             },
-            {
-                test: /\.(sa|sc|c)ss$/,
-                use: [
-                    MiniCssExtractPlugin.loader,
-                    { loader: "css-loader", options: { sourceMap: true } },
-                ],
-            }
         ]
     },
-    plugins: [
-        new MiniCssExtractPlugin({
-            filename: 'index.css',
-        }),
-    ],
     resolve: {
         extensions: ['.ts', '.js', '.json']
     }

package/webpack.config.node.js

@@ -24,24 +24,12 @@ module.exports = {
                 test: /\.(m|j|t)s$/,
                 exclude: /(node_modules|bower_components)/,
                 use: {
-                    loader: 'babel-loader',
-                    options: {
-                        presets: [
-                            ['@babel/preset-env', { targets: { node: 'current' } }],
-                            '@babel/preset-typescript'
-                        ],
-                        plugins: [
-
-                        ]
-                    }
+                    loader: 'babel-loader'
                 }
             },
         ]
     },
     resolve: {
         extensions: ['.ts', '.js', '.json']
-    },
-    externals: [
-
-    ]
+    }
 };

package/src/types/src/schemes/commands/SetCustomNick.ts

@@ -1,5 +0,0 @@
-export interface SetCustomNick {
-    spaceId: string;
-    userId: string;
-    nick: string|null;
-}