polfan-server-js-client 0.4.0 → 0.4.2

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

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

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

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

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

@@ -0,0 +1,16 @@
+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/src/types/src/schemes/commands/CreateMessage.ts

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

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

@@ -6,4 +6,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/src/types/src/schemes/commands/GetReactionDetails.ts

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

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

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

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

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

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

@@ -1,7 +1,10 @@
 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/src/types/src/schemes/events/Reacted.ts

@@ -0,0 +1,10 @@
+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/src/types/src/schemes/events/ReactionDetails.ts

@@ -0,0 +1,12 @@
+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/src/types/src/schemes/events/ReactionUpdated.ts

@@ -0,0 +1,9 @@
+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;
+}