polfan-server-js-client 0.1.99933 → 0.1.99935

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 } 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 } from "./types/src/index";
 import { EventTarget } from "./EventTarget";
 type ArrayOfPromiseResolvers = [(value: any) => void, (reason?: any) => void];
 export declare abstract class AbstractChatClient extends EventTarget {
@@ -33,6 +33,7 @@ export type EventsMap = {
     EmoticonDeleted: EmoticonDeleted;
     Emoticons: Emoticons;
     Bans: Bans;
+    ClientData: ClientData;
     DiscoverableSpaces: DiscoverableSpaces;
     SpaceJoined: SpaceJoined;
     SpaceLeft: SpaceLeft;
@@ -86,6 +87,8 @@ export type CommandsMap = {
     Ban: [Ban, EventsMap['Ok']];
     Unban: [Unban, EventsMap['Ok']];
     Kick: [Kick, EventsMap['Ok']];
+    GetClientData: [GetClientData, EventsMap['ClientData']];
+    SetClientData: [SetClientData, EventsMap['Ok']];
     GetDiscoverableSpaces: [GetDiscoverableSpaces, EventsMap['DiscoverableSpaces']];
     JoinSpace: [JoinSpace, EventsMap['SpaceJoined']];
     LeaveSpace: [LeaveSpace, EventsMap['SpaceLeft']];

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

@@ -4,7 +4,7 @@ import { RoomsManager } from "./RoomsManager";
 import { SpacesManager } from "./SpacesManager";
 import { PermissionsManager } from "./PermissionsManager";
 import { EmoticonsManager } from "./EmoticonsManager";
-import { Utils } from "./Utils";
+import { UsersManager } from "./UsersManager";
 export declare class ChatStateTracker {
     readonly client: WebSocketChatClient;
     /**
@@ -24,9 +24,9 @@ export declare class ChatStateTracker {
      */
     readonly emoticons: EmoticonsManager;
     /**
-     * Various utilities.
+     * Users related state.
      */
-    readonly utils: Utils;
+    readonly users: UsersManager;
     private _me;
     private readonly deferredSession;
     constructor(client: WebSocketChatClient);

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

@@ -0,0 +1,15 @@
+import { ChatStateTracker } from "./ChatStateTracker";
+import { ObservableIndexedObjectCollection } from "../IndexedObjectCollection";
+import { User } from "../types/src";
+export declare class UsersManager {
+    private tracker;
+    private readonly users;
+    constructor(tracker: ChatStateTracker);
+    /**
+     * Get all available (cached) user objects at once.
+     */
+    getAvailable(): Promise<ObservableIndexedObjectCollection<User>>;
+    private handleMembers;
+    private handleUsers;
+    private handleSession;
+}

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

@@ -107,4 +107,8 @@ import { BanObject } from "./schemes/BanObject";
 import { Bans } from "./schemes/events/Bans";
 import { Kick } from "./schemes/commands/Kick";
 import { LeaveReason } from "./schemes/LeaveReason";
-export { Envelope, Message, MessageType, Role, Room, RoomFlag, RoomType, RoomMember, RoomSummary, Space, SpaceMember, Topic, FollowedTopic, User, UserState, PermissionOverwritesValue, ChatLocation, SpaceSummary, SpaceDiscoverable, Emoticon, PermissionOverwritesTarget, BanObject, LeaveReason, 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, 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, };
+import { GetClientData } from "./schemes/commands/GetClientData";
+import { SetClientData } from "./schemes/commands/SetClientData";
+import { ClientData } from "./schemes/events/ClientData";
+import { RoomStream, RoomStreamType } from "./schemes/RoomStream";
+export { Envelope, Message, MessageType, Role, Room, RoomFlag, RoomType, RoomMember, RoomSummary, Space, SpaceMember, Topic, FollowedTopic, User, UserState, PermissionOverwritesValue, ChatLocation, SpaceSummary, SpaceDiscoverable, Emoticon, PermissionOverwritesTarget, BanObject, LeaveReason, RoomStream, RoomStreamType, 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, 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, };

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

@@ -1,5 +1,6 @@
 import { Topic } from "./Topic";
 import { User } from "./User";
+import { RoomStream } from "./RoomStream";
 export type RoomType = 'Text' | 'ClassicText' | 'Pm';
 export declare enum RoomFlag {
     AllowSystemMessages = 1
@@ -13,4 +14,5 @@ export interface Room {
     defaultTopic: Topic | null;
     recipients: User[] | null;
     flags: number;
+    stream: RoomStream | null;
 }

package/build/types/types/src/schemes/RoomStream.d.ts

@@ -0,0 +1,5 @@
+export type RoomStreamType = 'Direct' | 'Shoutcast';
+export interface RoomStream {
+    type: RoomStreamType;
+    url: string;
+}

package/build/types/types/src/schemes/commands/GetClientData.d.ts

@@ -0,0 +1,2 @@
+export interface GetClientData {
+}

package/build/types/types/src/schemes/commands/SetClientData.d.ts

@@ -0,0 +1 @@
+export type SetClientData = Record<string, any>;

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

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

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

@@ -0,0 +1 @@
+export type ClientData = Record<string, any>;

package/package.json

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

package/src/AbstractChatClient.ts

@@ -82,7 +82,7 @@ import {
     GetEmoticons,
     Emoticons,
     EmoticonDeleted,
-    NewEmoticon, Bans, GetBans, Ban, Unban, Kick,
+    NewEmoticon, Bans, GetBans, Ban, Unban, Kick, ClientData, GetClientData, SetClientData,
 } from "./types/src/index";
 import {EventTarget} from "./EventTarget";
 import {ErrorObject} from "css-minimizer-webpack-plugin";
@@ -160,6 +160,7 @@ export type EventsMap = {
     EmoticonDeleted: EmoticonDeleted,
     Emoticons: Emoticons,
     Bans: Bans,
+    ClientData: ClientData,
     // Space events
     DiscoverableSpaces: DiscoverableSpaces,
     SpaceJoined: SpaceJoined,
@@ -218,6 +219,8 @@ export type CommandsMap = {
     Ban: [Ban, EventsMap['Ok']],
     Unban: [Unban, EventsMap['Ok']],
     Kick: [Kick, EventsMap['Ok']],
+    GetClientData: [GetClientData, EventsMap['ClientData']],
+    SetClientData: [SetClientData, EventsMap['Ok']],
     // Space commands
     GetDiscoverableSpaces: [GetDiscoverableSpaces, EventsMap['DiscoverableSpaces']],
     JoinSpace: [JoinSpace, EventsMap['SpaceJoined']],

package/src/state-tracker/ChatStateTracker.ts

@@ -5,7 +5,7 @@ import {SpacesManager} from "./SpacesManager";
 import {PermissionsManager} from "./PermissionsManager";
 import {DeferredTask} from "./AsyncUtils";
 import {EmoticonsManager} from "./EmoticonsManager";
-import {Utils} from "./Utils";
+import {UsersManager} from "./UsersManager";
 
 export class ChatStateTracker {
     /**
@@ -29,9 +29,9 @@ export class ChatStateTracker {
     public readonly emoticons = new EmoticonsManager(this);
 
     /**
-     * Various utilities.
+     * Users related state.
      */
-    public readonly utils = new Utils(this);
+    public readonly users = new UsersManager(this);
 
     private _me: User = null;
     private readonly deferredSession = new DeferredTask();

package/src/state-tracker/UsersManager.ts

@@ -0,0 +1,41 @@
+import {ChatStateTracker} from "./ChatStateTracker";
+import {ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
+import {RoomMember, Session, SpaceMember, User} from "../types/src";
+import {extractUserFromMember} from "./functions";
+
+export class UsersManager {
+    private readonly users: ObservableIndexedObjectCollection<User> = new ObservableIndexedObjectCollection('id');
+
+    public constructor(private tracker: ChatStateTracker) {
+        tracker.client.on('UserUpdated', event => this.handleUsers([event.user]));
+        tracker.client.on('RoomMemberJoined', event => this.handleMembers([event.member]));
+        tracker.client.on('RoomMemberUpdated', event => this.handleMembers([event.member]));
+        tracker.client.on('SpaceMemberJoined', event => this.handleMembers([event.member]));
+        tracker.client.on('SpaceMemberUpdated', event => this.handleMembers([event.member]));
+        tracker.client.on('SpaceMembers', event => this.handleMembers(event.members));
+        tracker.client.on('RoomMembers', event => this.handleMembers(event.members));
+        tracker.client.on('Messages', event => this.handleUsers(event.messages.map(message => message.user)));
+        tracker.client.on('NewMessage', event => this.handleUsers([event.message.user]));
+        tracker.client.on('Session', event => this.handleSession(event));
+    }
+
+    /**
+     * Get all available (cached) user objects at once.
+     */
+    public async getAvailable(): Promise<ObservableIndexedObjectCollection<User>> {
+        return this.users;
+    }
+
+    private handleMembers(members: (RoomMember | SpaceMember)[]): void {
+        this.users.set(...members.map(extractUserFromMember));
+    }
+
+    private handleUsers(users: User[]): void {
+        this.users.set(...users);
+    }
+
+    private handleSession(session: Session): void {
+        this.users.deleteAll();
+        this.users.set(session.user);
+    }
+}

package/src/types/src/index.ts

@@ -107,6 +107,10 @@ import {BanObject} from "./schemes/BanObject";
 import {Bans} from "./schemes/events/Bans";
 import {Kick} from "./schemes/commands/Kick";
 import {LeaveReason} from "./schemes/LeaveReason";
+import {GetClientData} from "./schemes/commands/GetClientData";
+import {SetClientData} from "./schemes/commands/SetClientData";
+import {ClientData} from "./schemes/events/ClientData";
+import {RoomStream, RoomStreamType} from "./schemes/RoomStream";
 
 export {
     // objects
@@ -133,6 +137,8 @@ export {
     PermissionOverwritesTarget,
     BanObject,
     LeaveReason,
+    RoomStream,
+    RoomStreamType,
     // events
     Bye,
     Error,
@@ -179,6 +185,7 @@ export {
     EmoticonDeleted,
     NewEmoticon,
     Bans,
+    ClientData,
     // commands
     AssignRole,
     GetMessages,
@@ -225,4 +232,6 @@ export {
     Unban,
     GetBans,
     Kick,
+    GetClientData,
+    SetClientData,
 };

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

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

package/src/types/src/schemes/RoomStream.ts

@@ -0,0 +1,6 @@
+export type RoomStreamType = 'Direct' | 'Shoutcast';
+
+export interface RoomStream {
+    type: RoomStreamType;
+    url: string;
+}

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

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

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

@@ -0,0 +1 @@
+export type SetClientData = Record<string, any>;

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

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

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

@@ -0,0 +1 @@
+export type ClientData = Record<string, any>;

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

@@ -1,15 +0,0 @@
-import { ChatStateTracker } from "./ChatStateTracker";
-import { IndexedObjectCollection } from "../IndexedObjectCollection";
-import { Room, RoomSummary, User } from "../types/src";
-export declare class Utils {
-    private tracker;
-    constructor(tracker: ChatStateTracker);
-    /**
-     * Collect all room summaries and rooms you joined in one collection.
-     */
-    collectAllAvailableRooms(): Promise<IndexedObjectCollection<Room | RoomSummary>>;
-    /**
-     * Collect all users from all spaces and rooms you are in.
-     */
-    collectAllAvailableUsers(): Promise<IndexedObjectCollection<User>>;
-}

package/src/state-tracker/Utils.ts

@@ -1,40 +0,0 @@
-import {ChatStateTracker} from "./ChatStateTracker";
-import {IndexedObjectCollection} from "../IndexedObjectCollection";
-import {Room, RoomSummary, User} from "../types/src";
-import {extractUserFromMember} from "./functions";
-
-export class Utils {
-    public constructor(private tracker: ChatStateTracker) {}
-
-    /**
-     * Collect all room summaries and rooms you joined in one collection.
-     */
-    public async collectAllAvailableRooms(): Promise<IndexedObjectCollection<Room | RoomSummary>> {
-        const result = new IndexedObjectCollection<Room | RoomSummary>('id');
-        const spaces = await this.tracker.spaces.get();
-        const collections = await Promise.all([
-            ...spaces.items.map(space => this.tracker.spaces.getRooms(space.id)),
-            this.tracker.rooms.get(),
-        ]);
-
-        collections.forEach(collection => result.set(...collection.items));
-
-        return result;
-    }
-
-    /**
-     * Collect all users from all spaces and rooms you are in.
-     */
-    public async collectAllAvailableUsers(): Promise<IndexedObjectCollection<User>> {
-        const result = new IndexedObjectCollection<User>('id');
-        const [spaces, rooms] = await Promise.all([this.tracker.spaces.get(), this.tracker.rooms.get()]);
-        const collections = await Promise.all([
-            ...spaces.items.map(space => this.tracker.spaces.getMembers(space.id)),
-            ...rooms.items.map(room => this.tracker.rooms.getMembers(room.id)),
-        ]);
-
-        collections.forEach(collection => result.set(...collection.items.map(extractUserFromMember)));
-
-        return result;
-    }
-}