polfan-server-js-client 0.1.99925 → 0.1.99926

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

@@ -1,5 +1,5 @@
 import { ChatStateTracker } from "./ChatStateTracker";
-import { ChatLocation, PermissionOverwrites } from "../types/src";
+import { ChatLocation, PermissionOverwrites, PermissionOverwritesTarget } from "../types/src";
 import { EventHandler, EventTarget } from "../EventTarget";
 import { Permissions } from "../Permissions";
 interface CheckPermissionsResult {
@@ -16,7 +16,7 @@ export declare class PermissionsManager extends EventTarget {
     private readonly overwrites;
     private readonly overwritesPromises;
     constructor(tracker: ChatStateTracker);
-    getOverwrites(location: ChatLocation, target: PermissionOverwrites['target'], targetId: PermissionOverwrites['targetId']): Promise<PermissionOverwrites | undefined>;
+    getOverwrites(location: ChatLocation, target: PermissionOverwritesTarget): Promise<PermissionOverwrites | undefined>;
     on(eventName: 'change', handler: EventHandler<any>): this;
     check(permissionNames: (keyof typeof Permissions.list)[], location: ChatLocation): Promise<CheckPermissionsResult>;
     calculatePermissions(location: ChatLocation): Promise<number>;

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

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

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

@@ -0,0 +1,5 @@
+export interface PermissionOverwritesTarget {
+    type: 'User' | 'Role';
+    userId?: string;
+    roleId?: string;
+}

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

@@ -1,6 +1,6 @@
 import { ChatLocation } from "../ChatLocation";
+import { PermissionOverwritesTarget } from "../PermissionOverwritesTarget";
 export interface GetPermissionOverwrites {
     location: ChatLocation;
-    target: 'User' | 'Role';
-    targetId: string;
+    target: PermissionOverwritesTarget;
 }

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

@@ -1,8 +1,8 @@
 import { PermissionOverwritesValue } from "../PermissionOverwritesValue";
 import { ChatLocation } from "../ChatLocation";
+import { PermissionOverwritesTarget } from "../PermissionOverwritesTarget";
 export interface SetPermissionOverwrites {
     location: ChatLocation;
-    target: 'User' | 'Role';
-    targetId: string;
+    target: PermissionOverwritesTarget;
     overwrites: PermissionOverwritesValue;
 }

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

@@ -1,8 +1,8 @@
 import { PermissionOverwritesValue } from "../PermissionOverwritesValue";
 import { ChatLocation } from "../ChatLocation";
+import { PermissionOverwritesTarget } from "../PermissionOverwritesTarget";
 export interface PermissionOverwrites {
     location: ChatLocation;
-    target: 'User' | 'Role';
-    targetId: string;
+    target: PermissionOverwritesTarget;
     overwrites: PermissionOverwritesValue;
 }

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

@@ -1,8 +1,8 @@
 import { PermissionOverwritesValue } from "../PermissionOverwritesValue";
 import { ChatLocation } from "../ChatLocation";
+import { PermissionOverwritesTarget } from "../PermissionOverwritesTarget";
 export interface PermissionOverwritesUpdated {
     location: ChatLocation;
-    target: 'User' | 'Role';
-    targetId: string;
+    target: PermissionOverwritesTarget;
     overwrites: PermissionOverwritesValue;
 }

package/package.json

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

package/src/state-tracker/PermissionsManager.ts

@@ -1,7 +1,7 @@
 import {ChatStateTracker} from "./ChatStateTracker";
 import {
     ChatLocation,
-    PermissionOverwrites,
+    PermissionOverwrites, PermissionOverwritesTarget,
     PermissionOverwritesUpdated,
     PermissionOverwritesValue,
     RoleDeleted,
@@ -19,13 +19,11 @@ import {PromiseRegistry} from "./AsyncUtils";
 
 const getOvId = (
     location: ChatLocation,
-    target?: PermissionOverwrites['target'],
-    targetId?: PermissionOverwrites['targetId'],
-) => (location.spaceId ?? '') + (location.roomId ?? '') + (location.topicId ?? '') + (target ?? '') + (targetId ?? '');
+    target?: PermissionOverwritesTarget,
+) => [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, overwrites.targetId
-);
+const getOvIdByObject
+    = (overwrites: PermissionOverwrites | PermissionOverwritesUpdated): string => getOvId(overwrites.location, overwrites.target);
 
 interface CheckPermissionsResult {
     /**
@@ -58,18 +56,17 @@ export class PermissionsManager extends EventTarget {
 
     public async getOverwrites(
         location: ChatLocation,
-        target: PermissionOverwrites['target'],
-        targetId: PermissionOverwrites['targetId'],
+        target: PermissionOverwritesTarget,
     ): Promise<PermissionOverwrites | undefined> {
         this.validateLocation(location);
 
-        const id = getOvId(location, target, targetId);
+        const id = getOvId(location, target);
 
         if (this.overwritesPromises.notExist(id)) {
             this.overwritesPromises.registerByFunction(async () => {
                 const result = await this.tracker.client.send(
                     'GetPermissionOverwrites',
-                    {location, target, targetId},
+                    {location, target},
                 );
                 if (result.error) {
                     throw result.error;
@@ -119,13 +116,13 @@ export class PermissionsManager extends EventTarget {
         const userRoles: string[] = [...(spaceMember?.roles ?? []), ...(roomMember?.roles ?? [])];
         const promises: Promise<PermissionOverwritesValue>[] = [
             // Global user overwrites
-            this.getOverwrites({}, 'User', userId).then(v => v.overwrites),
+            this.getOverwrites({}, { type: 'User', userId }).then(v => v.overwrites),
         ];
 
         if (location.spaceId && (await this.tracker.spaces.get())?.has(location.spaceId)) {
             const filterLocation: ChatLocation = {spaceId: location.spaceId};
             promises.push(this.collectRoleOverwrites(filterLocation, userRoles));
-            promises.push(this.getOverwrites(filterLocation, 'User', userId).then(v => v.overwrites));
+            promises.push(this.getOverwrites(filterLocation, { type: 'User', userId }).then(v => v.overwrites));
         }
 
         if (location.roomId && (await this.tracker.rooms.get())?.has(location.roomId)) {
@@ -133,14 +130,14 @@ export class PermissionsManager extends EventTarget {
             if (userRoles.length) {
                 promises.push(this.collectRoleOverwrites(filterLocation, userRoles));
             }
-            promises.push(this.getOverwrites(filterLocation, 'User', userId).then(v => v.overwrites));
+            promises.push(this.getOverwrites(filterLocation, { type: 'User', userId }).then(v => v.overwrites));
         }
 
         if (location.topicId && (await this.tracker.rooms.getTopics(location.roomId))?.has(location.topicId)) {
             if (userRoles.length) {
                 promises.push(this.collectRoleOverwrites(location, userRoles));
             }
-            promises.push(this.getOverwrites(location, 'User', userId).then(v => v.overwrites));
+            promises.push(this.getOverwrites(location, { type: 'User', userId }).then(v => v.overwrites));
         }
 
         return this.resolveOverwritesHierarchy(await Promise.all(promises));
@@ -170,7 +167,7 @@ export class PermissionsManager extends EventTarget {
     }
 
     private handleRoleDeleted(ev: RoleDeleted): void {
-        const ids = this.deleteOverwritesByIdPrefix(getOvId({spaceId: ev.spaceId}, 'Role', ev.id));
+        const ids = this.deleteOverwritesByIdPrefix(getOvId({spaceId: ev.spaceId}, { type: 'Role', roleId: ev.id }));
         this.overwritesPromises.forget(...ids);
     }
 
@@ -208,7 +205,7 @@ export class PermissionsManager extends EventTarget {
         userRoles: string[],
     ): Promise<PermissionOverwritesValue> {
         const roleOverwrites = await Promise.all(userRoles.map(
-            roleId => this.getOverwrites(location, 'Role', roleId)
+            roleId => this.getOverwrites(location, { type: 'Role', roleId }),
         ));
 
         return this.resolveOverwritesFromRolesByOrder(location.spaceId, roleOverwrites);
@@ -222,7 +219,7 @@ export class PermissionsManager extends EventTarget {
         const roles = await this.tracker.spaces.getRoles(spaceId);
         const sortedOverwrites = overwrites.sort(
             (a, b) =>
-                roles.get(a.targetId).priority - roles.get(b.targetId).priority
+                roles.get(a.target.roleId).priority - roles.get(b.target.roleId).priority
         );
 
         // Max length of bit word

package/src/types/src/index.ts

@@ -99,6 +99,7 @@ import {CreateEmoticon} from "./schemes/commands/CreateEmoticon";
 import {DeleteEmoticon} from "./schemes/commands/DeleteEmoticon";
 import {NewEmoticon} from "./schemes/events/NewEmoticon";
 import {EmoticonDeleted} from "./schemes/events/EmoticonDeleted";
+import {PermissionOverwritesTarget} from "./schemes/PermissionOverwritesTarget";
 
 export {
     // objects
@@ -122,6 +123,7 @@ export {
     SpaceSummary,
     SpaceDiscoverable,
     Emoticon,
+    PermissionOverwritesTarget,
     // events
     Bye,
     Error,

package/src/types/src/schemes/PermissionOverwritesTarget.ts

@@ -0,0 +1,5 @@
+export interface PermissionOverwritesTarget {
+    type: 'User' | 'Role';
+    userId?: string;
+    roleId?: string;
+}

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

@@ -1,7 +1,7 @@
 import {ChatLocation} from "../ChatLocation";
+import {PermissionOverwritesTarget} from "../PermissionOverwritesTarget";
 
 export interface GetPermissionOverwrites {
     location: ChatLocation;
-    target: 'User' | 'Role';
-    targetId: string;
+    target: PermissionOverwritesTarget;
 }

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

@@ -1,9 +1,9 @@
 import {PermissionOverwritesValue} from "../PermissionOverwritesValue";
 import {ChatLocation} from "../ChatLocation";
+import {PermissionOverwritesTarget} from "../PermissionOverwritesTarget";
 
 export interface SetPermissionOverwrites {
     location: ChatLocation;
-    target: 'User' | 'Role';
-    targetId: string;
+    target: PermissionOverwritesTarget;
     overwrites: PermissionOverwritesValue;
 }

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

@@ -1,9 +1,9 @@
 import {PermissionOverwritesValue} from "../PermissionOverwritesValue";
 import {ChatLocation} from "../ChatLocation";
+import {PermissionOverwritesTarget} from "../PermissionOverwritesTarget";
 
 export interface PermissionOverwrites {
     location: ChatLocation;
-    target: 'User' | 'Role';
-    targetId: string;
+    target: PermissionOverwritesTarget;
     overwrites: PermissionOverwritesValue;
 }

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

@@ -1,9 +1,9 @@
 import {PermissionOverwritesValue} from "../PermissionOverwritesValue";
 import {ChatLocation} from "../ChatLocation";
+import {PermissionOverwritesTarget} from "../PermissionOverwritesTarget";
 
 export interface PermissionOverwritesUpdated {
     location: ChatLocation;
-    target: 'User' | 'Role';
-    targetId: string;
+    target: PermissionOverwritesTarget;
     overwrites: PermissionOverwritesValue;
 }