polfan-server-js-client 0.1.99927 → 0.1.99929

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 } 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 } from "./types/src/index";
 import { EventTarget } from "./EventTarget";
 type ArrayOfPromiseResolvers = [(value: any) => void, (reason?: any) => void];
 export declare abstract class AbstractChatClient extends EventTarget {
@@ -32,6 +32,7 @@ export type EventsMap = {
     NewEmoticon: NewEmoticon;
     EmoticonDeleted: EmoticonDeleted;
     Emoticons: Emoticons;
+    Bans: Bans;
     DiscoverableSpaces: DiscoverableSpaces;
     SpaceJoined: SpaceJoined;
     SpaceLeft: SpaceLeft;
@@ -81,6 +82,10 @@ export type CommandsMap = {
     CreateEmoticon: [CreateEmoticon, EventsMap['NewEmoticon']];
     DeleteEmoticon: [DeleteEmoticon, EventsMap['EmoticonDeleted']];
     GetEmoticons: [GetEmoticons, EventsMap['Emoticons']];
+    GetBans: [GetBans, EventsMap['Bans']];
+    Ban: [Ban, EventsMap['Ok']];
+    Unban: [Unban, EventsMap['Ok']];
+    Kick: [Kick, EventsMap['Ok']];
     GetDiscoverableSpaces: [GetDiscoverableSpaces, EventsMap['DiscoverableSpaces']];
     JoinSpace: [JoinSpace, EventsMap['SpaceJoined']];
     LeaveSpace: [LeaveSpace, EventsMap['SpaceLeft']];

package/build/types/Permissions.d.ts

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

package/build/types/WebApiChatClient.d.ts

@@ -2,10 +2,10 @@ import { AbstractChatClient, CommandResult, CommandsMap } from "./AbstractChatCl
 import { ObservableInterface } from "./EventTarget";
 export interface WebApiChatClientOptions {
     url: string;
-    token?: string;
-    temporaryNick?: string;
+    token: string;
     attemptsToSend?: number;
     attemptDelayMs?: number;
+    queryParams?: Record<string, string>;
 }
 declare enum WebApiChatClientEvent {
     message = "message",

package/build/types/WebSocketChatClient.d.ts

@@ -4,11 +4,11 @@ import { ChatStateTracker } from "./state-tracker/ChatStateTracker";
 import { Envelope } from "./types/src";
 export interface WebSocketClientOptions {
     url: string;
-    token?: string;
-    temporaryNick?: string;
+    token: string;
     connectingTimeoutMs?: number;
     awaitQueueSendDelayMs?: number;
     stateTracking?: boolean;
+    queryParams?: Record<string, string>;
 }
 declare enum WebSocketChatClientEvent {
     connect = "connect",

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

@@ -100,4 +100,11 @@ import { DeleteEmoticon } from "./schemes/commands/DeleteEmoticon";
 import { NewEmoticon } from "./schemes/events/NewEmoticon";
 import { EmoticonDeleted } from "./schemes/events/EmoticonDeleted";
 import { PermissionOverwritesTarget } from "./schemes/PermissionOverwritesTarget";
-export { Envelope, Message, MessageType, Role, Room, RoomFlag, RoomType, RoomMember, RoomSummary, Space, SpaceMember, Topic, FollowedTopic, User, UserState, PermissionOverwritesValue, ChatLocation, SpaceSummary, SpaceDiscoverable, Emoticon, PermissionOverwritesTarget, 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, 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, };
+import { Ban } from "./schemes/commands/Ban";
+import { Unban } from "./schemes/commands/Unban";
+import { GetBans } from "./schemes/commands/GetBans";
+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, };

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

@@ -0,0 +1,11 @@
+import { User } from "./User";
+import { ChatLocation } from "./ChatLocation";
+export interface BanObject {
+    bannedUser: User;
+    banningUser?: User;
+    location: ChatLocation;
+    reason: string;
+    diagnosticId: string;
+    expiresAt?: string;
+    createdAt: string;
+}

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

@@ -0,0 +1,6 @@
+import { BanObject } from "./BanObject";
+export interface LeaveReason {
+    type: 'Leave' | 'Ban' | 'Kick';
+    ban?: BanObject;
+    kick?: string;
+}

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

@@ -0,0 +1,8 @@
+import { ChatLocation } from "../ChatLocation";
+export interface Ban {
+    userId: string;
+    location: ChatLocation;
+    reason: string;
+    expiresAt?: string;
+    notify?: boolean;
+}

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

@@ -0,0 +1,4 @@
+import { ChatLocation } from "../ChatLocation";
+export interface GetBans {
+    location: ChatLocation;
+}

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

@@ -0,0 +1,6 @@
+import { ChatLocation } from "../ChatLocation";
+export interface Kick {
+    userId: string;
+    location: ChatLocation;
+    reason: string;
+}

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

@@ -0,0 +1,5 @@
+import { ChatLocation } from "../ChatLocation";
+export interface Unban {
+    userId: string;
+    location: ChatLocation;
+}

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

@@ -0,0 +1,6 @@
+import { ChatLocation } from "../ChatLocation";
+import { BanObject } from "../BanObject";
+export interface Bans {
+    location: ChatLocation;
+    bans: BanObject[];
+}

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

@@ -1,3 +1,5 @@
+import { LeaveReason } from "../LeaveReason";
 export interface RoomLeft {
     id: string;
+    reason: LeaveReason;
 }

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

@@ -1,3 +1,5 @@
+import { LeaveReason } from "../LeaveReason";
 export interface SpaceLeft {
     id: string;
+    reason: LeaveReason;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polfan-server-js-client",
-  "version": "0.1.99927",
+  "version": "0.1.99929",
   "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,
+    NewEmoticon, Bans, GetBans, Ban, Unban, Kick,
 } from "./types/src/index";
 import {EventTarget} from "./EventTarget";
 
@@ -158,6 +158,7 @@ export type EventsMap = {
     NewEmoticon: NewEmoticon,
     EmoticonDeleted: EmoticonDeleted,
     Emoticons: Emoticons,
+    Bans: Bans,
     // Space events
     DiscoverableSpaces: DiscoverableSpaces,
     SpaceJoined: SpaceJoined,
@@ -212,6 +213,10 @@ export type CommandsMap = {
     CreateEmoticon: [CreateEmoticon, EventsMap['NewEmoticon']],
     DeleteEmoticon: [DeleteEmoticon, EventsMap['EmoticonDeleted']],
     GetEmoticons: [GetEmoticons, EventsMap['Emoticons']],
+    GetBans: [GetBans, EventsMap['Bans']],
+    Ban: [Ban, EventsMap['Ok']],
+    Unban: [Unban, EventsMap['Ok']],
+    Kick: [Kick, EventsMap['Ok']],
     // Space commands
     GetDiscoverableSpaces: [GetDiscoverableSpaces, EventsMap['DiscoverableSpaces']],
     JoinSpace: [JoinSpace, EventsMap['SpaceJoined']],

package/src/Permissions.ts

@@ -27,6 +27,8 @@ export class Permissions {
         ManageSpaceRooms: {value: 1 << 12, maxLayer: Layer.Space},
         CreateEmoticons: {value: 1 << 13, maxLayer: Layer.Space},
         ManageEmoticon: {value: 1 << 14, maxLayer: Layer.Space},
+        ManageBan: {value: 1 << 15, maxLayer: Layer.Room},
+        Kick: {value: 1 << 16, maxLayer: Layer.Room},
     };
 
     public static getNames(): (keyof typeof this.list)[] {

package/src/WebApiChatClient.ts

@@ -4,10 +4,10 @@ import {Envelope} from "./types/src";
 
 export interface WebApiChatClientOptions {
     url: string;
-    token?: string;
-    temporaryNick?: string;
+    token: string;
     attemptsToSend?: number;
     attemptDelayMs?: number;
+    queryParams?: Record<string, string>;
 }
 
 enum WebApiChatClientEvent {
@@ -23,9 +23,6 @@ export class WebApiChatClient extends AbstractChatClient implements ObservableIn
 
     public constructor(private readonly options: WebApiChatClientOptions) {
         super();
-        if (!this.options.token && !this.options.temporaryNick) {
-            throw new Error('Token or temporary nick is required');
-        }
     }
 
     public async send<CommandType extends keyof CommandsMap>(commandType: CommandType, commandData: CommandsMap[CommandType][0]):
@@ -78,13 +75,12 @@ export class WebApiChatClient extends AbstractChatClient implements ObservableIn
             Accept: 'application/json'
         };
 
-        if (this.options.token) {
-            headers.Authorization = `Bearer ${this.options.token}`;
-        } else if (this.options.temporaryNick) {
-            headers.Authorization = `Temp ${this.options.temporaryNick}`;
-        }
+        headers.Authorization = `Bearer ${this.options.token}`;
+
+        const params = new URLSearchParams(this.options.queryParams ?? {});
+        const url = `${this.options.url}${params ? '?' + params : ''}`;
 
-        fetch(this.options.url, {
+        fetch(url, {
             headers,
             body: bodyJson,
             method: 'POST',

package/src/WebSocketChatClient.ts

@@ -5,11 +5,11 @@ import {Envelope} from "./types/src";
 
 export interface WebSocketClientOptions {
     url: string;
-    token?: string;
-    temporaryNick?: string;
+    token: string;
     connectingTimeoutMs?: number;
     awaitQueueSendDelayMs?: number;
     stateTracking?: boolean;
+    queryParams?: Record<string, string>;
 }
 
 enum WebSocketChatClientEvent {
@@ -31,17 +31,16 @@ export class WebSocketChatClient extends AbstractChatClient implements Observabl
 
     public constructor(private readonly options: WebSocketClientOptions) {
         super();
-        if (!this.options.token && !this.options.temporaryNick) {
-            throw new Error('Token or temporary nick is required');
-        }
         if (this.options.stateTracking ?? true) {
             this.state = new ChatStateTracker(this);
         }
     }
 
     public async connect(): Promise<void> {
-        const authString = this.options.token ? `token=${this.options.token}` : `nick=${this.options.temporaryNick}`;
-        this.ws = new WebSocket(`${this.options.url}?${authString}`);
+        const params = new URLSearchParams(this.options.queryParams ?? {});
+        params.set('token', this.options.token);
+
+        this.ws = new WebSocket(`${this.options.url}?${params}`);
         this.ws.onclose = ev => this.onClose(ev);
         this.ws.onmessage = ev => this.onMessage(ev);
         this.connectingTimeoutId = setTimeout(
@@ -49,6 +48,7 @@ export class WebSocketChatClient extends AbstractChatClient implements Observabl
             this.options.connectingTimeoutMs ?? 10000
         );
         this.authenticated = false;
+
         return new Promise((...args) => this.authenticatedResolvers = args);
     }
 

package/src/state-tracker/PermissionsManager.ts

@@ -20,7 +20,7 @@ import {PromiseRegistry} from "./AsyncUtils";
 const getOvId = (
     location: ChatLocation,
     target?: PermissionOverwritesTarget,
-) => [location.spaceId, location.roomId, location.topicId, target.type, target.userId, target.roleId].filter(Boolean).join('/');
+) => [location.spaceId, location.roomId, location.topicId, target?.type, target?.userId, target?.roleId].filter(Boolean).join('/');
 
 const getOvIdByObject
     = (overwrites: PermissionOverwrites | PermissionOverwritesUpdated): string => getOvId(overwrites.location, overwrites.target);

package/src/state-tracker/TopicHistoryWindow.ts

@@ -221,7 +221,13 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
     }
 
     private handleSession(ev: Session): void {
-        this.resetToLatest();
+        const rooms = ev.state.rooms;
+
+        if (rooms.find(room => room.id === this.roomId)) {
+            this.resetToLatest();
+        } else {
+            this.deleteAll();
+        }
     }
 
     protected async fetchItemsAfter(): Promise<Message[] | null> {

package/src/types/src/index.ts

@@ -100,6 +100,13 @@ import {DeleteEmoticon} from "./schemes/commands/DeleteEmoticon";
 import {NewEmoticon} from "./schemes/events/NewEmoticon";
 import {EmoticonDeleted} from "./schemes/events/EmoticonDeleted";
 import {PermissionOverwritesTarget} from "./schemes/PermissionOverwritesTarget";
+import {Ban} from "./schemes/commands/Ban";
+import {Unban} from "./schemes/commands/Unban";
+import {GetBans} from "./schemes/commands/GetBans";
+import {BanObject} from "./schemes/BanObject";
+import {Bans} from "./schemes/events/Bans";
+import {Kick} from "./schemes/commands/Kick";
+import {LeaveReason} from "./schemes/LeaveReason";
 
 export {
     // objects
@@ -124,6 +131,8 @@ export {
     SpaceDiscoverable,
     Emoticon,
     PermissionOverwritesTarget,
+    BanObject,
+    LeaveReason,
     // events
     Bye,
     Error,
@@ -169,6 +178,7 @@ export {
     Emoticons,
     EmoticonDeleted,
     NewEmoticon,
+    Bans,
     // commands
     AssignRole,
     GetMessages,
@@ -211,4 +221,8 @@ export {
     GetEmoticons,
     CreateEmoticon,
     DeleteEmoticon,
+    Ban,
+    Unban,
+    GetBans,
+    Kick,
 };

package/src/types/src/schemes/BanObject.ts

@@ -0,0 +1,12 @@
+import {User} from "./User";
+import {ChatLocation} from "./ChatLocation";
+
+export interface BanObject {
+    bannedUser: User;
+    banningUser?: User;
+    location: ChatLocation;
+    reason: string;
+    diagnosticId: string;
+    expiresAt?: string;
+    createdAt: string;
+}

package/src/types/src/schemes/LeaveReason.ts

@@ -0,0 +1,7 @@
+import {BanObject} from "./BanObject";
+
+export interface LeaveReason {
+    type: 'Leave' | 'Ban' | 'Kick';
+    ban?: BanObject;
+    kick?: string;
+}

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

@@ -0,0 +1,9 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface Ban {
+    userId: string;
+    location: ChatLocation;
+    reason: string;
+    expiresAt?: string;
+    notify?: boolean;
+}

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

@@ -0,0 +1,5 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface GetBans {
+    location: ChatLocation;
+}

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

@@ -0,0 +1,7 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface Kick {
+    userId: string;
+    location: ChatLocation;
+    reason: string;
+}

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

@@ -0,0 +1,6 @@
+import {ChatLocation} from "../ChatLocation";
+
+export interface Unban {
+    userId: string;
+    location: ChatLocation;
+}

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

@@ -0,0 +1,7 @@
+import {ChatLocation} from "../ChatLocation";
+import {BanObject} from "../BanObject";
+
+export interface Bans {
+    location: ChatLocation;
+    bans: BanObject[];
+}

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

@@ -1,3 +1,6 @@
+import {LeaveReason} from "../LeaveReason";
+
 export interface RoomLeft {
     id: string;
+    reason: LeaveReason;
 }

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

@@ -1,3 +1,6 @@
+import {LeaveReason} from "../LeaveReason";
+
 export interface SpaceLeft {
     id: string;
+    reason: LeaveReason;
 }