polfan-server-js-client 0.2.43 → 0.2.45

package/build/types/AbstractChatClient.d.ts

@@ -1,5 +1,6 @@
-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 } 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 } from "./types/src/index";
 import { EventTarget } from "./EventTarget";
+import { GetRelationships } from "./types/src/schemes/commands/GetRelationships";
 type ArrayOfPromiseResolvers = [(value: any) => void, (reason?: any) => void];
 export declare abstract class AbstractChatClient extends EventTarget {
     protected awaitingResponse: Map<string, ArrayOfPromiseResolvers>;
@@ -34,6 +35,9 @@ export type EventsMap = {
     Emoticons: Emoticons;
     Bans: Bans;
     ClientData: ClientData;
+    NewRelationship: NewRelationship;
+    RelationshipDeleted: RelationshipDeleted;
+    Relationships: Relationships;
     DiscoverableSpaces: DiscoverableSpaces;
     SpaceJoined: SpaceJoined;
     SpaceLeft: SpaceLeft;
@@ -91,6 +95,9 @@ export type CommandsMap = {
     Kick: [Kick, EventsMap['Ok']];
     GetClientData: [GetClientData, EventsMap['ClientData']];
     SetClientData: [SetClientData, EventsMap['Ok']];
+    DeleteRelationship: [DeleteRelationship, EventsMap['RelationshipDeleted']];
+    CreateRelationship: [CreateRelationship, EventsMap['NewRelationship']];
+    GetRelationships: [GetRelationships, EventsMap['Relationships']];
     GetDiscoverableSpaces: [GetDiscoverableSpaces, EventsMap['DiscoverableSpaces']];
     JoinSpace: [JoinSpace, EventsMap['SpaceJoined']];
     LeaveSpace: [LeaveSpace, EventsMap['SpaceLeft']];

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

@@ -5,6 +5,7 @@ import { SpacesManager } from "./SpacesManager";
 import { PermissionsManager } from "./PermissionsManager";
 import { EmoticonsManager } from "./EmoticonsManager";
 import { UsersManager } from "./UsersManager";
+import { RelationshipsManager } from "./RelationshipsManager";
 export declare class ChatStateTracker {
     readonly client: WebSocketChatClient;
     /**
@@ -27,6 +28,10 @@ export declare class ChatStateTracker {
      * Users related state.
      */
     readonly users: UsersManager;
+    /**
+     * State of relationships with other users.
+     */
+    readonly relationships: RelationshipsManager;
     private _me;
     private readonly deferredSession;
     constructor(client: WebSocketChatClient);

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

@@ -0,0 +1,15 @@
+import { ObservableIndexedObjectCollection } from "../IndexedObjectCollection";
+import { UserRelationship, UserRelationshipType } from "../types/src";
+import { ChatStateTracker } from "./ChatStateTracker";
+export declare class RelationshipsManager {
+    private tracker;
+    private relationships;
+    private promises;
+    constructor(tracker: ChatStateTracker);
+    get(): Promise<ObservableIndexedObjectCollection<UserRelationship>>;
+    exists(refUserId: string, type: UserRelationshipType): Promise<boolean>;
+    private handleRelationships;
+    private handleNewRelationship;
+    private handleRelationshipDeleted;
+    private handleSession;
+}

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

@@ -117,4 +117,10 @@ 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";
-export { Envelope, Message, MessageType, MessageAuthor, Role, Room, RoomFlag, RoomType, RoomMember, RoomSummary, RoomSummaryExtras, Space, SpaceFlag, 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, SpaceSummaryEvent, RoomSummaryEvent, 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, };
+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";
+export { Envelope, Message, MessageType, MessageAuthor, Role, Room, RoomFlag, RoomType, RoomMember, RoomSummary, RoomSummaryExtras, Space, SpaceFlag, SpaceMember, Topic, FollowedTopic, User, UserState, PermissionOverwritesValue, ChatLocation, SpaceSummary, SpaceDiscoverable, Emoticon, PermissionOverwritesTarget, BanObject, LeaveReason, RoomStream, RoomStreamType, UserRelationship, UserRelationshipType, 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 };

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

@@ -0,0 +1,8 @@
+export declare enum UserRelationshipType {
+    Ignore = "Ignore"
+}
+export interface UserRelationship {
+    userId: string;
+    refUserId: string;
+    type: UserRelationshipType;
+}

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

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

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

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

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

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

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

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

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

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

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

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

package/package.json

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

package/src/AbstractChatClient.ts

@@ -87,9 +87,10 @@ import {
     GetSpaceSummary,
     RoomSummaryEvent,
     SpaceSummaryEvent,
-    SetCustomNick,
+    SetCustomNick, Relationships, RelationshipDeleted, NewRelationship, DeleteRelationship, CreateRelationship,
 } from "./types/src/index";
 import {EventTarget} from "./EventTarget";
+import {GetRelationships} from "./types/src/schemes/commands/GetRelationships";
 
 type ArrayOfPromiseResolvers = [(value: any) => void, (reason?: any) => void];
 
@@ -165,6 +166,9 @@ export type EventsMap = {
     Emoticons: Emoticons,
     Bans: Bans,
     ClientData: ClientData,
+    NewRelationship: NewRelationship,
+    RelationshipDeleted: RelationshipDeleted,
+    Relationships: Relationships,
     // Space events
     DiscoverableSpaces: DiscoverableSpaces,
     SpaceJoined: SpaceJoined,
@@ -227,6 +231,9 @@ export type CommandsMap = {
     Kick: [Kick, EventsMap['Ok']],
     GetClientData: [GetClientData, EventsMap['ClientData']],
     SetClientData: [SetClientData, EventsMap['Ok']],
+    DeleteRelationship: [DeleteRelationship, EventsMap['RelationshipDeleted']],
+    CreateRelationship: [CreateRelationship, EventsMap['NewRelationship']],
+    GetRelationships: [GetRelationships, EventsMap['Relationships']],
     // Space commands
     GetDiscoverableSpaces: [GetDiscoverableSpaces, EventsMap['DiscoverableSpaces']],
     JoinSpace: [JoinSpace, EventsMap['SpaceJoined']],

package/src/state-tracker/ChatStateTracker.ts

@@ -6,6 +6,7 @@ import {PermissionsManager} from "./PermissionsManager";
 import {DeferredTask} from "./AsyncUtils";
 import {EmoticonsManager} from "./EmoticonsManager";
 import {UsersManager} from "./UsersManager";
+import {RelationshipsManager} from "./RelationshipsManager";
 
 export class ChatStateTracker {
     /**
@@ -33,6 +34,11 @@ export class ChatStateTracker {
      */
     public readonly users = new UsersManager(this);
 
+    /**
+     * State of relationships with other users.
+     */
+    public readonly relationships = new RelationshipsManager(this);
+
     private _me: User = null;
     private readonly deferredSession = new DeferredTask();
 

package/src/state-tracker/RelationshipsManager.ts

@@ -0,0 +1,68 @@
+import {ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
+import {
+    NewRelationship,
+    RelationshipDeleted,
+    Relationships,
+    UserRelationship,
+    UserRelationshipType
+} from "../types/src";
+import {PromiseRegistry} from "./AsyncUtils";
+import {ChatStateTracker} from "./ChatStateTracker";
+
+const getId = (refUserId: string, type: UserRelationshipType): string => `${refUserId}-${type}`;
+const getIdFromRelationship = (relationship: UserRelationship): string => getId(relationship.refUserId, relationship.type);
+
+export class RelationshipsManager {
+    private relationships: ObservableIndexedObjectCollection<UserRelationship> = new ObservableIndexedObjectCollection<UserRelationship>(getIdFromRelationship);
+    private promises = new PromiseRegistry();
+
+    public constructor(private tracker: ChatStateTracker) {
+        this.tracker.client.on('Relationships', ev => this.handleRelationships(ev));
+        this.tracker.client.on('NewRelationship', ev => this.handleNewRelationship(ev));
+        this.tracker.client.on('RelationshipDeleted', ev => this.handleRelationshipDeleted(ev));
+        this.tracker.client.on('Session', () => this.handleSession());
+    }
+
+    public async get(): Promise<ObservableIndexedObjectCollection<UserRelationship>> {
+        if (this.promises.notExist('all')) {
+            this.promises.registerByFunction(async () => {
+                const result = await this.tracker.client.send('GetRelationships', {});
+                if (result.error) {
+                    throw result.error;
+                }
+            }, 'all');
+        }
+
+        await this.promises.get('all');
+        return this.relationships;
+    }
+
+    public async exists(refUserId: string, type: UserRelationshipType): Promise<boolean> {
+        await this.get();
+        return this.relationships.has(getId(refUserId, type));
+    }
+
+    private handleRelationships(ev: Relationships): void {
+        this.relationships.deleteAll();
+        ev.relationships.forEach(relationship => {
+            this.relationships.set(relationship);
+        });
+    }
+
+    private handleNewRelationship(ev: NewRelationship): void {
+        if (this.promises.has('all')) {
+            this.relationships.set(ev.relationship);
+        }
+    }
+
+    private handleRelationshipDeleted(ev: RelationshipDeleted): void {
+        if (this.promises.has('all')) {
+            this.relationships.delete(getIdFromRelationship(ev.relationship));
+        }
+    }
+
+    private handleSession(): void {
+        this.promises.forgetAll();
+        this.relationships.deleteAll();
+    }
+}

package/src/state-tracker/RoomsManager.ts

@@ -214,7 +214,7 @@ export class RoomsManager {
     }
 
     private handleRoomUpdated(ev: RoomUpdated): void {
-        if (this.list.has(ev.room)) {
+        if (this.list.has(ev.room.id)) {
             this.list.set(ev.room);
         }
     }

package/src/types/src/index.ts

@@ -117,6 +117,12 @@ 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 {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";
 
 export {
     // objects
@@ -148,6 +154,8 @@ export {
     LeaveReason,
     RoomStream,
     RoomStreamType,
+    UserRelationship,
+    UserRelationshipType,
     // events
     Bye,
     Error,
@@ -197,6 +205,9 @@ export {
     ClientData,
     SpaceSummaryEvent,
     RoomSummaryEvent,
+    NewRelationship,
+    RelationshipDeleted,
+    Relationships,
     // commands
     AssignRole,
     GetMessages,
@@ -248,4 +259,6 @@ export {
     GetSpaceSummary,
     GetRoomSummary,
     SetCustomNick,
+    CreateRelationship,
+    DeleteRelationship
 };

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

@@ -0,0 +1,9 @@
+export enum UserRelationshipType {
+    Ignore = 'Ignore',
+}
+
+export interface UserRelationship {
+    userId: string;
+    refUserId: string;
+    type: UserRelationshipType;
+}

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/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/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[];
+}