polfan-server-js-client 0.4.0 → 0.4.1

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

@@ -145,4 +145,12 @@ import { Uninvite } from "./schemes/commands/Uninvite";
 import { GetInvited } from "./schemes/commands/GetInvited";
 import { Invited } from "./schemes/events/Invited";
 import { TopicUnfollowed } from "./schemes/events/TopicUnfollowed";
-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, 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, 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, };
+import { MessageReaction, ReactionType, ToggledReaction, UserReaction } from "./schemes/Reaction";
+import { MessagePoll, MessagePollOption } from "./schemes/MessagePoll";
+import { React } from "./schemes/commands/React";
+import { Unreact } from "./schemes/commands/Unreact";
+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, };

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

@@ -1,6 +1,8 @@
 import { User } from "./User";
 import { ChatLocation } from "./ChatLocation";
-export type MessageType = 'Text' | 'RoomJoin' | 'RoomMemberAdd' | 'RoomLeave' | 'SpaceJoin' | 'SpaceLeave' | 'TopicChange' | 'CustomNickChange' | 'Ephemeral';
+import { MessageReaction } from "./Reaction";
+import { MessagePoll } from "./MessagePoll";
+export type MessageType = 'Text' | 'RoomJoin' | 'RoomMemberAdd' | 'RoomLeave' | 'SpaceJoin' | 'SpaceLeave' | 'TopicChange' | 'CustomNickChange' | 'Ephemeral' | 'Poll';
 export interface MessageAuthor {
     user: User;
     customNick?: string;
@@ -15,4 +17,6 @@ export interface Message {
     content?: string;
     topicRef: string | null;
     attachments: string[] | null;
+    reactions: MessageReaction[];
+    poll?: MessagePoll;
 }

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

@@ -0,0 +1,10 @@
+import { ReactionType } from "./Reaction";
+export interface MessagePollOption {
+    type: ReactionType;
+    value: string;
+    label: string;
+}
+export interface MessagePoll {
+    multipleChoice: boolean;
+    options: MessagePollOption[];
+}

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

@@ -0,0 +1,13 @@
+export type ReactionType = 'Emoji' | 'Emoticon';
+export interface MessageReaction {
+    type: ReactionType;
+    value: string;
+    count: number;
+}
+export interface UserReaction {
+    type: ReactionType;
+    value: string;
+}
+export interface ToggledReaction extends UserReaction {
+    isAdded: boolean;
+}

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

@@ -1,8 +1,11 @@
 import { ChatLocation } from "../ChatLocation";
+import { MessagePoll } from "../MessagePoll";
 export interface CreateMessage {
     location: ChatLocation;
     content: string;
     attachments?: string[];
     customNick?: string;
     customColor?: string;
+    /** Turns the message into a poll; its content becomes the question. */
+    poll?: MessagePoll;
 }

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

@@ -5,4 +5,9 @@ export interface GetMessages {
     after?: string;
     around?: string;
     limit?: number;
+    /**
+     * Pull the reactions of the asking user along with the messages, instead of
+     * asking for their own state separately.
+     */
+    includeMyReactions?: boolean;
 }

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

@@ -0,0 +1,8 @@
+import { ReactionType } from "../Reaction";
+export interface GetReactionDetails {
+    messageId: string;
+    type: ReactionType;
+    value: string;
+    limit?: number;
+    offset?: number;
+}

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

@@ -0,0 +1,6 @@
+import { ReactionType } from "../Reaction";
+export interface React {
+    messageId: string;
+    type: ReactionType;
+    value: string;
+}

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

@@ -0,0 +1,6 @@
+import { ReactionType } from "../Reaction";
+export interface Unreact {
+    messageId: string;
+    type: ReactionType;
+    value: string;
+}

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

@@ -1,6 +1,9 @@
 import { ChatLocation } from "../ChatLocation";
 import { Message } from "../Message";
+import { UserReaction } from "../Reaction";
 export interface Messages {
     location: ChatLocation;
     messages: Message[];
+    /** Message id => reactions of the asking user; present only when requested. */
+    myReactions?: Record<string, UserReaction[]>;
 }

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

@@ -0,0 +1,9 @@
+import { ToggledReaction } from "../Reaction";
+/**
+ * Sent to every client of the voting user, so all of their devices know what they
+ * voted for without refetching the message history.
+ */
+export interface Reacted {
+    messageId: string;
+    reaction: ToggledReaction;
+}

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

@@ -0,0 +1,11 @@
+import { ReactionType } from "../Reaction";
+/**
+ * Who reacted, oldest vote first. Only the ids travel - the nicks are already
+ * known from the room members collection.
+ */
+export interface ReactionDetails {
+    messageId: string;
+    type: ReactionType;
+    value: string;
+    userIds: string[];
+}

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

@@ -0,0 +1,8 @@
+import { MessageReaction } from "../Reaction";
+/**
+ * The single source of truth of a reaction counter, broadcast to the whole room.
+ */
+export interface ReactionUpdated {
+    messageId: string;
+    reaction: MessageReaction;
+}

package/package.json

@@ -1,43 +1,43 @@
-{
-  "name": "polfan-server-js-client",
-  "version": "0.4.0",
-  "description": "JavaScript client library for handling communication with Polfan chat server.",
-  "author": "Jarosław Żak",
-  "license": "MIT",
-  "main": "build/index.cjs.js",
-  "browser": "build/index.umd.js",
-  "types": "build/types/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./build/types/index.d.ts",
-      "require": "./build/index.cjs.js",
-      "browser": "./build/index.umd.js",
-      "default": "./build/index.cjs.js"
-    }
-  },
-  "scripts": {
-    "build": "npm run build:node && npm run build:browser && tsc",
-    "build:node": "webpack --config webpack.config.node.js",
-    "build:browser": "webpack --config webpack.config.browser.js",
-    "test": "jest",
-    "coverage": "npm run test -- --coverage",
-    "trypublish": "npm publish || true"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.28.3",
-    "@babel/core": "^7.28.5",
-    "@babel/preset-env": "^7.28.5",
-    "@babel/preset-typescript": "^7.28.5",
-    "@types/jest": "^29.5.14",
-    "babel-loader": "^9.2.1",
-    "file-loader": "^6.2.0",
-    "jest": "^29.7.0",
-    "ts-node": "^10.9.2",
-    "typescript": "^4.9.5",
-    "webpack": "^5.103.0",
-    "webpack-cli": "^5.1.4"
-  },
-  "dependencies": {
-    "terser-webpack-plugin": "^5.3.14"
-  }
-}
+{
+  "name": "polfan-server-js-client",
+  "version": "0.4.1",
+  "description": "JavaScript client library for handling communication with Polfan chat server.",
+  "author": "Jarosław Żak",
+  "license": "MIT",
+  "main": "build/index.cjs.js",
+  "browser": "build/index.umd.js",
+  "types": "build/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./build/types/index.d.ts",
+      "require": "./build/index.cjs.js",
+      "browser": "./build/index.umd.js",
+      "default": "./build/index.cjs.js"
+    }
+  },
+  "scripts": {
+    "build": "npm run build:node && npm run build:browser && tsc",
+    "build:node": "webpack --config webpack.config.node.js",
+    "build:browser": "webpack --config webpack.config.browser.js",
+    "test": "jest",
+    "coverage": "npm run test -- --coverage",
+    "trypublish": "npm publish || true"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.28.3",
+    "@babel/core": "^7.28.5",
+    "@babel/preset-env": "^7.28.5",
+    "@babel/preset-typescript": "^7.28.5",
+    "@types/jest": "^29.5.14",
+    "babel-loader": "^9.2.1",
+    "file-loader": "^6.2.0",
+    "jest": "^29.7.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.9.5",
+    "webpack": "^5.103.0",
+    "webpack-cli": "^5.1.4"
+  },
+  "dependencies": {
+    "terser-webpack-plugin": "^5.3.14"
+  }
+}

package/src/index.ts

@@ -1,32 +1,32 @@
-import {WebSocketChatClient} from "./WebSocketChatClient";
-import {WebApiChatClient} from "./WebApiChatClient";
-import {
-    IndexedCollection,
-    IndexedObjectCollection,
-    ObservableIndexedCollection,
-    ObservableIndexedObjectCollection
-} from "./IndexedObjectCollection";
-import {FilesClient, File} from "./FilesClient";
-import { Permissions, PermissionDefinition, Layer } from "./Permissions";
-import * as ChatTypes from './types/src';
-import {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 type {
-    ChatTypes,
-    File,
-    UnreadSummary,
+import {WebSocketChatClient} from "./WebSocketChatClient";
+import {WebApiChatClient} from "./WebApiChatClient";
+import {
+    IndexedCollection,
+    IndexedObjectCollection,
+    ObservableIndexedCollection,
+    ObservableIndexedObjectCollection
+} from "./IndexedObjectCollection";
+import {FilesClient, File} from "./FilesClient";
+import { Permissions, PermissionDefinition, Layer } from "./Permissions";
+import * as ChatTypes from './types/src';
+import {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 type {
+    ChatTypes,
+    File,
+    UnreadSummary,
 };

package/src/state-tracker/UsersManager.ts

@@ -1,52 +1,52 @@
-import {ChatStateTracker} from "./ChatStateTracker";
-import {ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
-import {RoomMember, Session, SpaceMember, User} from "../types/src";
-import {extractUserFromMember} from "./functions";
-import {EventTarget} from "../EventTarget";
-
-export class UsersManager {
-    public readonly onlineStatus = new EventTarget<{ change: User }>();
-
-    private readonly users: ObservableIndexedObjectCollection<User> = new ObservableIndexedObjectCollection('id');
-
-    public constructor(private tracker: ChatStateTracker) {
-        // RoomMemberUpdated & SpaceMemberUpdated events are not contains user object
-        tracker.client.on('UserUpdated', event => this.handleUsers([event.user]));
-        tracker.client.on('RoomMembersJoined', event => this.handleMembers(event.members));
-        tracker.client.on('SpaceMemberJoined', 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.author.user)));
-        tracker.client.on('NewMessage', event => this.handleUsers([event.message.author.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.handleUsers(members.map(extractUserFromMember));
-    }
-
-    private handleSession(session: Session): void {
-        // Keep the "seen users" cache across reconnects so bound user lists do
-        // not blank out; just ensure our own user is present/updated. Stale
-        // entries are refreshed as member/message collections refetch.
-        this.handleUsers([session.user]);
-    }
-
-    private handleUsers(users: User[]): void {
-        users.forEach(newUser => {
-            const oldUser = this.users.get(newUser.id);
-            if (oldUser && oldUser.status !== newUser.status) {
-                this.onlineStatus.emit('change', newUser);
-            }
-        });
-
-        this.users.set(...users);
-    }
+import {ChatStateTracker} from "./ChatStateTracker";
+import {ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
+import {RoomMember, Session, SpaceMember, User} from "../types/src";
+import {extractUserFromMember} from "./functions";
+import {EventTarget} from "../EventTarget";
+
+export class UsersManager {
+    public readonly onlineStatus = new EventTarget<{ change: User }>();
+
+    private readonly users: ObservableIndexedObjectCollection<User> = new ObservableIndexedObjectCollection('id');
+
+    public constructor(private tracker: ChatStateTracker) {
+        // RoomMemberUpdated & SpaceMemberUpdated events are not contains user object
+        tracker.client.on('UserUpdated', event => this.handleUsers([event.user]));
+        tracker.client.on('RoomMembersJoined', event => this.handleMembers(event.members));
+        tracker.client.on('SpaceMemberJoined', 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.author.user)));
+        tracker.client.on('NewMessage', event => this.handleUsers([event.message.author.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.handleUsers(members.map(extractUserFromMember));
+    }
+
+    private handleSession(session: Session): void {
+        // Keep the "seen users" cache across reconnects so bound user lists do
+        // not blank out; just ensure our own user is present/updated. Stale
+        // entries are refreshed as member/message collections refetch.
+        this.handleUsers([session.user]);
+    }
+
+    private handleUsers(users: User[]): void {
+        users.forEach(newUser => {
+            const oldUser = this.users.get(newUser.id);
+            if (oldUser && oldUser.status !== newUser.status) {
+                this.onlineStatus.emit('change', newUser);
+            }
+        });
+
+        this.users.set(...users);
+    }
 }