polfan-server-js-client 0.4.2 → 0.4.3

package/build/types/Permissions.d.ts

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

package/build/types/index.d.ts

@@ -4,9 +4,9 @@ import { IndexedCollection, IndexedObjectCollection, ObservableIndexedCollection
 import { FilesClient, File } from "./FilesClient";
 import { Permissions, PermissionDefinition, Layer } from "./Permissions";
 import * as ChatTypes from './types/src';
-import { UserStatus } from './types/src';
+import { RoleFlag, UserStatus } from './types/src';
 import { extractUserFromMember } from "./state-tracker/functions";
 import { AbstractRestClient } from "./AbstractRestClient";
 import { UnreadSummary } from "./state-tracker/FollowedTopicsManager";
-export { IndexedCollection, ObservableIndexedCollection, IndexedObjectCollection, ObservableIndexedObjectCollection, Permissions, PermissionDefinition, Layer, WebSocketChatClient, WebApiChatClient, FilesClient, AbstractRestClient, extractUserFromMember, UserStatus, };
+export { IndexedCollection, ObservableIndexedCollection, IndexedObjectCollection, ObservableIndexedObjectCollection, Permissions, PermissionDefinition, Layer, WebSocketChatClient, WebApiChatClient, FilesClient, AbstractRestClient, extractUserFromMember, UserStatus, RoleFlag, };
 export type { ChatTypes, File, UnreadSummary, };

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

@@ -1,7 +1,7 @@
 import { Envelope } from "./schemes/Envelope";
-import { Message, MessageType, MessageAuthor } from "./schemes/Message";
+import { Message, MessageType, MessageAuthor, MessageMentions } from "./schemes/Message";
 import { PermissionOverwritesValue } from "./schemes/PermissionOverwritesValue";
-import { Role } from "./schemes/Role";
+import { Role, RoleFlag } from "./schemes/Role";
 import { Room, RoomType } from "./schemes/Room";
 import { RoomMember } from "./schemes/RoomMember";
 import { RoomSummary, RoomSummaryExtras } from "./schemes/RoomSummary";
@@ -153,4 +153,4 @@ import { GetReactionDetails } from "./schemes/commands/GetReactionDetails";
 import { ReactionUpdated } from "./schemes/events/ReactionUpdated";
 import { Reacted } from "./schemes/events/Reacted";
 import { ReactionDetails } from "./schemes/events/ReactionDetails";
-export { Envelope, Message, MessageType, MessageAuthor, Role, Room, RoomType, RoomStream, RoomStreamType, RoomHistory, RoomHistoryMode, RoomMember, RoomSummary, RoomSummaryExtras, Space, SpaceMember, Topic, FollowedTopic, NotificationLevel, User, UserStatus, UserState, PermissionOverwritesValue, ChatLocation, SpaceSummary, SpaceDiscoverable, Emoticon, PermissionOverwritesTarget, BanObject, LeaveReason, UserRelationship, UserRelationshipType, CreateTopicInitialMessage, UserInformation, SessionPush, SessionData, SessionPlatform, UserData, PrivateMessagePolicy, ReactionType, MessageReaction, UserReaction, ToggledReaction, MessagePoll, MessagePollOption, Bye, Error, Messages, NewMessage, NewRole, NewRoom, NewTopic, TopicFollowed, TopicUnfollowed, FollowedTopics, FollowedTopicUpdated, ComputedPermissions, PermissionOverwrites, PermissionOverwritesUpdated, RoleDeleted, RoleUpdated, RoomDeleted, RoomUpdated, RoomJoined, RoomLeft, RoomMembersJoined, 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, RoomSummaryUpdated, Pong, MessagesRedacted, UserInfo, Invited, ReactionUpdated, Reacted, ReactionDetails, AssignRole, GetMessages, CreateMessage, Ack, CreateRole, CreateRoom, CreateSpace, CreateTopic, FollowTopic, UnfollowTopic, UpdateFollowedTopic, 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, UpdateSpaceMember, CreateRelationship, DeleteRelationship, GetRelationships, UpdateRoomMember, Ping, ReportAbuse, RedactMessages, GetUserInfo, SetSessionData, GetSessionData, SetUserData, GetUserData, Invite, Uninvite, GetInvited, React, Unreact, GetReactionDetails, };
+export { Envelope, Message, MessageType, MessageAuthor, MessageMentions, Role, RoleFlag, Room, RoomType, RoomStream, RoomStreamType, RoomHistory, RoomHistoryMode, RoomMember, RoomSummary, RoomSummaryExtras, Space, SpaceMember, Topic, FollowedTopic, NotificationLevel, User, UserStatus, UserState, PermissionOverwritesValue, ChatLocation, SpaceSummary, SpaceDiscoverable, Emoticon, PermissionOverwritesTarget, BanObject, LeaveReason, UserRelationship, UserRelationshipType, CreateTopicInitialMessage, UserInformation, SessionPush, SessionData, SessionPlatform, UserData, PrivateMessagePolicy, ReactionType, MessageReaction, UserReaction, ToggledReaction, MessagePoll, MessagePollOption, Bye, Error, Messages, NewMessage, NewRole, NewRoom, NewTopic, TopicFollowed, TopicUnfollowed, FollowedTopics, FollowedTopicUpdated, ComputedPermissions, PermissionOverwrites, PermissionOverwritesUpdated, RoleDeleted, RoleUpdated, RoomDeleted, RoomUpdated, RoomJoined, RoomLeft, RoomMembersJoined, 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, RoomSummaryUpdated, Pong, MessagesRedacted, UserInfo, Invited, ReactionUpdated, Reacted, ReactionDetails, AssignRole, GetMessages, CreateMessage, Ack, CreateRole, CreateRoom, CreateSpace, CreateTopic, FollowTopic, UnfollowTopic, UpdateFollowedTopic, 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, UpdateSpaceMember, CreateRelationship, DeleteRelationship, GetRelationships, UpdateRoomMember, Ping, ReportAbuse, RedactMessages, GetUserInfo, SetSessionData, GetSessionData, SetUserData, GetUserData, Invite, Uninvite, GetInvited, React, Unreact, GetReactionDetails, };

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

@@ -3,6 +3,15 @@ import { ChatLocation } from "./ChatLocation";
 import { MessageReaction } from "./Reaction";
 import { MessagePoll } from "./MessagePoll";
 export type MessageType = 'Text' | 'RoomJoin' | 'RoomMemberAdd' | 'RoomLeave' | 'SpaceJoin' | 'SpaceLeave' | 'TopicChange' | 'CustomNickChange' | 'Ephemeral' | 'Poll';
+/**
+ * Mention targets a message actually reached, as resolved by the server: role
+ * mentions the author was not allowed to fire are absent, even though they stay
+ * in the content. Null when the message mentions nobody.
+ */
+export interface MessageMentions {
+    userIds: string[];
+    roleIds: string[];
+}
 export interface MessageAuthor {
     user: User;
     customNick?: string;
@@ -19,4 +28,5 @@ export interface Message {
     attachments: string[] | null;
     reactions: MessageReaction[];
     poll?: MessagePoll;
+    mentions: MessageMentions | null;
 }

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

@@ -1,6 +1,20 @@
+/**
+ * Bit flags of a role, stored in {@link Role.flags}.
+ *
+ * - `SeparateOnMembersList` - available holders of the role are listed in their
+ *   own group of the members list, headed by the role name.
+ * - `MentionableByEveryone` - anybody may mention the role with notification
+ *   effects; without it the mention is decorative only, unless the author holds
+ *   the `MentionAllRoles` permission.
+ */
+export declare enum RoleFlag {
+    SeparateOnMembersList = 1,
+    MentionableByEveryone = 2
+}
 export interface Role {
     id: string;
     priority: number;
     name: string;
     color?: string;
+    flags: number;
 }

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

@@ -2,4 +2,5 @@ export interface CreateRole {
     spaceId: string;
     name: string;
     color: string;
+    flags?: number;
 }

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

@@ -4,4 +4,5 @@ export interface UpdateRole {
     priority?: number;
     name?: string;
     color?: string;
+    flags?: number;
 }

package/package.json

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

package/src/Permissions.ts

@@ -35,6 +35,7 @@ export class Permissions {
         AddMembers: {value: 1 << 20, maxLayer: Layer.Space},
         React: {value: 1 << 21, maxLayer: Layer.Topic},
         CreatePolls: {value: 1 << 22, maxLayer: Layer.Topic},
+        MentionAllRoles: {value: 1 << 23, maxLayer: Layer.Topic},
     };
 
     public static getNames(): (keyof typeof this.list)[] {

package/src/index.ts

@@ -9,7 +9,7 @@ import {
 import {FilesClient, File} from "./FilesClient";
 import { Permissions, PermissionDefinition, Layer } from "./Permissions";
 import * as ChatTypes from './types/src';
-import {UserStatus} from './types/src';
+import {RoleFlag, UserStatus} from './types/src';
 import {extractUserFromMember} from "./state-tracker/functions";
 import {AbstractRestClient} from "./AbstractRestClient";
 import {UnreadSummary} from "./state-tracker/FollowedTopicsManager";
@@ -23,6 +23,7 @@ export {
     AbstractRestClient,
     extractUserFromMember,
     UserStatus,
+    RoleFlag,
 };
 
 export type {

package/src/types/src/index.ts

@@ -1,7 +1,7 @@
 import {Envelope} from "./schemes/Envelope";
-import {Message, MessageType, MessageAuthor} from "./schemes/Message";
+import {Message, MessageType, MessageAuthor, MessageMentions} from "./schemes/Message";
 import {PermissionOverwritesValue} from "./schemes/PermissionOverwritesValue";
-import {Role} from "./schemes/Role";
+import {Role, RoleFlag} from "./schemes/Role";
 import {Room, RoomType} from "./schemes/Room";
 import {RoomMember} from "./schemes/RoomMember";
 import {RoomSummary, RoomSummaryExtras} from "./schemes/RoomSummary";
@@ -160,7 +160,9 @@ export {
     Message,
     MessageType,
     MessageAuthor,
+    MessageMentions,
     Role,
+    RoleFlag,
     Room,
     RoomType,
     RoomStream,

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

@@ -5,6 +5,16 @@ import {MessagePoll} from "./MessagePoll";
 
 export type MessageType = 'Text'|'RoomJoin'|'RoomMemberAdd'|'RoomLeave'|'SpaceJoin'|'SpaceLeave'|'TopicChange'|'CustomNickChange'|'Ephemeral'|'Poll';
 
+/**
+ * Mention targets a message actually reached, as resolved by the server: role
+ * mentions the author was not allowed to fire are absent, even though they stay
+ * in the content. Null when the message mentions nobody.
+ */
+export interface MessageMentions {
+    userIds: string[];
+    roleIds: string[];
+}
+
 export interface MessageAuthor {
     user: User;
     customNick?: string;
@@ -22,4 +32,5 @@ export interface Message {
     attachments: string[] | null;
     reactions: MessageReaction[];
     poll?: MessagePoll;
+    mentions: MessageMentions | null;
 }

package/src/types/src/schemes/Role.ts

@@ -1,6 +1,21 @@
+/**
+ * Bit flags of a role, stored in {@link Role.flags}.
+ *
+ * - `SeparateOnMembersList` - available holders of the role are listed in their
+ *   own group of the members list, headed by the role name.
+ * - `MentionableByEveryone` - anybody may mention the role with notification
+ *   effects; without it the mention is decorative only, unless the author holds
+ *   the `MentionAllRoles` permission.
+ */
+export enum RoleFlag {
+    SeparateOnMembersList = 1 << 0,
+    MentionableByEveryone = 1 << 1,
+}
+
 export interface Role {
     id: string;
     priority: number;
     name: string;
     color?: string;
-}
+    flags: number;
+}

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

@@ -2,4 +2,5 @@ export interface CreateRole {
     spaceId: string;
     name: string;
     color: string;
+    flags?: number;
 }

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

@@ -4,4 +4,5 @@ export interface UpdateRole {
     priority?: number;
     name?: string;
     color?: string;
+    flags?: number;
 }

package/tests/space-roles.test.ts

@@ -5,11 +5,11 @@ import {reorderRolesOnPriorityUpdate} from "../src/state-tracker/functions";
 const createCollection = () => new IndexedObjectCollection<Role>(
     role => role.id,
     [
-        {id: 'id1', name: 'everyone', priority: 0, color: '#ff0000'},
-        {id: 'id2', name: 'roleA', priority: 1, color: '#ff0000'},
-        {id: 'id3', name: 'roleB', priority: 2, color: '#ff0000'},
-        {id: 'id4', name: 'roleC', priority: 3, color: '#ff0000'},
-        {id: 'id5', name: 'roleD', priority: 4, color: '#ff0000'},
+        {id: 'id1', name: 'everyone', priority: 0, color: '#ff0000', flags: 0},
+        {id: 'id2', name: 'roleA', priority: 1, color: '#ff0000', flags: 0},
+        {id: 'id3', name: 'roleB', priority: 2, color: '#ff0000', flags: 0},
+        {id: 'id4', name: 'roleC', priority: 3, color: '#ff0000', flags: 0},
+        {id: 'id5', name: 'roleD', priority: 4, color: '#ff0000', flags: 0},
     ],
 );