polfan-server-js-client 0.3.3 → 0.4.1

package/build/types/index.d.ts

@@ -4,8 +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 { 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, };
+export { IndexedCollection, ObservableIndexedCollection, IndexedObjectCollection, ObservableIndexedObjectCollection, Permissions, PermissionDefinition, Layer, WebSocketChatClient, WebApiChatClient, FilesClient, AbstractRestClient, extractUserFromMember, UserStatus, };
 export type { ChatTypes, File, UnreadSummary, };

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

@@ -6,7 +6,6 @@ export declare class RoomMessagesHistory {
     private tracker;
     private historyWindows;
     private traverseLock;
-    private timeLimitedHistory;
     constructor(room: Room, tracker: ChatStateTracker);
     /**
      * Returns a history window object for the given topic ID, allowing you to view message history.
@@ -21,24 +20,14 @@ export declare class RoomMessagesHistory {
      *
      * The window bindings are preserved; only windows that the application had
      * actually pulled to the latest page (state === LATEST) are refreshed, with
-     * a single request instead of a chain of catch-up requests. Windows that
-     * were never pulled (LIVE) or belong to an ephemeral room are left untouched
-     * so their in-memory context survives the reconnect.
-     *
-     * How a refreshed window is rebuilt depends on the room history mode: rooms
-     * keeping the full history are simply reset to the latest page (it can
-     * always be traversed back on demand), while rooms with a time-limited
-     * history (MaxAge) load the messages missed during the downtime on top of
-     * the already loaded ones, with the messages returned in both deduplicated.
-     * The maxAge retention applies to what the server serves - so that users
-     * joining later do not see the older conversation - and never to what this
-     * client already has: messages the user witnessed stay in the window until
-     * they are pushed out by its own size limit.
+     * a single resetToLatest instead of a chain of catch-up requests. Windows
+     * that were never pulled (LIVE) or belong to an ephemeral room are left
+     * untouched so their in-memory context survives the reconnect.
      */
     resync(room: Room): Promise<void>;
     private handleRoomUpdated;
     private handleNewTopic;
     private handleTopicDeleted;
     private createHistoryWindowForTopic;
-    private updateHistoryMode;
+    private updateTraverseLock;
 }

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

@@ -34,7 +34,6 @@ export declare abstract class TraversableRemoteCollection<ItemT, EventMapT exten
         fetchLimit: number;
         lastFetchCount: number;
         oldestId: string | null;
-        gaps: string[];
     };
     /**
      * Number of items to fetch per request.
@@ -63,44 +62,12 @@ export declare abstract class TraversableRemoteCollection<ItemT, EventMapT exten
      */
     set retainRatio(value: number);
     get hasLatest(): boolean;
-    /**
-     * IDs of the items the window could not stitch to the ones loaded before
-     * them: there is a gap in front of each of them, i.e. the item right above
-     * it in the window is not its real predecessor and an unknown number of
-     * items in between was never fetched.
-     *
-     * Such a gap appears when the collection is resynchronised after a
-     * reconnect (see resyncToLatest) and more items than a single page arrived
-     * while the connection was down. The markers are kept in the window order
-     * and disappear together with the items they point at.
-     */
-    get gaps(): readonly string[];
     get hasOldest(): boolean;
     abstract createMirror(): TraversableRemoteCollection<ItemT, EventMapT>;
     resetToLatest(force?: boolean): Promise<void>;
-    /**
-     * Refresh the window with the latest page, keeping the already loaded items
-     * instead of replacing them.
-     *
-     * This is the reconnect-friendly variant of resetToLatest: the items missed
-     * while the connection was down are pulled with a single request and merged
-     * on top of the loaded ones (items returned in both are deduplicated), so
-     * the context the application already had does not disappear. The window
-     * size limit is the only thing that pushes the oldest items out.
-     *
-     * An empty or partial page is not a reason to drop anything: it only means
-     * the collection has little (or nothing) left on the remote side, while the
-     * items loaded earlier are still valid. When the page is full and does not
-     * reach the loaded items, an unknown number of items in between was never
-     * fetched - both parts are still kept, and the seam between them is recorded
-     * in `gaps` so the application can show where the history is not continuous.
-     */
-    resyncToLatest(): Promise<void>;
     fetchPrevious(): Promise<void>;
     fetchNext(): Promise<void>;
     jumpTo(id: string): Promise<void>;
-    delete(...ids: string[]): void;
-    deleteAll(): void;
     protected abstract fetchLatestItems(): Promise<ItemT[]>;
     protected abstract fetchItemsBefore(): Promise<ItemT[] | null>;
     protected abstract fetchItemsAfter(): Promise<ItemT[] | null>;
@@ -109,20 +76,6 @@ export declare abstract class TraversableRemoteCollection<ItemT, EventMapT exten
     protected refreshFetchedState(): Promise<void>;
     protected addItems(newItems: ItemT[], to: 'head' | 'tail'): void;
     protected emitChangeWithDiff(itemChanged: boolean, originalState: WindowState): void;
-    /**
-     * Record that the history is not continuous in front of the given item.
-     */
-    protected markGapBefore(id: string): void;
-    /**
-     * Forget the gap in front of the given item - the items before it are known
-     * to be its real predecessors now.
-     */
-    protected clearGapBefore(id: string): void;
-    /**
-     * Forget the gap markers pointing at items that are no longer in the window
-     * (trimmed, deleted or replaced), so `gaps` never refers to nothing.
-     */
-    protected dropDanglingGaps(): void;
     /**
      * Return array with messages trimmed using High/Low Watermark strategy.
      */
@@ -147,7 +100,6 @@ export declare class TopicHistoryWindow extends TraversableRemoteCollection<Mess
     get isTraverseLocked(): boolean;
     setTraverseLock(lock: boolean): Promise<void>;
     resetToLatest(force?: boolean): Promise<void>;
-    resyncToLatest(): Promise<void>;
     fetchNext(): Promise<void>;
     fetchPrevious(): Promise<void>;
     jumpTo(id: string): Promise<void>;

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

@@ -8,7 +8,7 @@ import { RoomSummary, RoomSummaryExtras } from "./schemes/RoomSummary";
 import { Space, SpaceDiscoverable } from "./schemes/Space";
 import { SpaceMember } from "./schemes/SpaceMember";
 import { Topic } from "./schemes/Topic";
-import { User } from "./schemes/User";
+import { User, UserStatus } from "./schemes/User";
 import { UserState } from "./schemes/UserState";
 import { Bye } from "./schemes/events/Bye";
 import { Error } from "./schemes/events/Error";
@@ -134,7 +134,7 @@ import { GetUserInfo } from "./schemes/commands/GetUserInfo";
 import { UserInfo } from "./schemes/events/UserInfo";
 import { UserInformation } from "./schemes/UserInformation";
 import { SetSessionData, SessionPush } from "./schemes/commands/SetSessionData";
-import { SessionData } from "./schemes/SessionData";
+import { SessionData, SessionPlatform } from "./schemes/SessionData";
 import { GetSessionData } from "./schemes/commands/GetSessionData";
 import { UserData, PrivateMessagePolicy } from "./schemes/UserData";
 import { SetUserData } from "./schemes/commands/SetUserData";
@@ -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, UserState, PermissionOverwritesValue, ChatLocation, SpaceSummary, SpaceDiscoverable, Emoticon, PermissionOverwritesTarget, BanObject, LeaveReason, UserRelationship, UserRelationshipType, CreateTopicInitialMessage, UserInformation, SessionPush, SessionData, 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/SessionData.d.ts

@@ -1,4 +1,10 @@
 import { SessionPush } from "./commands/SetSessionData";
+/**
+ * Platform of a client session. Reported on connect (the `platform` query
+ * parameter) and independent of the push registration.
+ */
+export type SessionPlatform = 'web' | 'ios' | 'android' | 'desktop';
 export interface SessionData {
+    platform?: SessionPlatform;
     push?: SessionPush;
 }

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

@@ -1,8 +1,23 @@
 export type UserTags = 'bot' | 'temp' | string;
+/**
+ * Availability of a user, aggregated over all of their sessions.
+ *
+ * - `Offline` - no session is connected and none can be reached asynchronously.
+ * - `Online` - at least one session holds a live connection.
+ * - `OnlineAsync` - no live connection, but a push-registered device was active
+ *   recently, so a message will still reach the user.
+ */
+export declare enum UserStatus {
+    Offline = 0,
+    Online = 1,
+    OnlineAsync = 2
+}
 export interface User {
     id: string;
     nick: string;
     avatar: string;
     tags: UserTags[];
+    status: UserStatus;
+    /** @deprecated Use {@link status}. Kept for clients older than the numeric status. */
     online: boolean;
 }

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

@@ -1,4 +1,9 @@
 export type PrivateMessagePolicy = 'None' | 'Mutual' | 'All';
 export interface UserData {
     privateMessagePolicy: PrivateMessagePolicy;
+    /**
+     * Whether others may see that the user is reachable on a push-registered
+     * device while disconnected. When false the user simply reads as offline.
+     */
+    showAsyncPresence: 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/SetSessionData.d.ts

@@ -1,9 +1,17 @@
+import { SessionPlatform } from "../SessionData";
 export interface SessionPush {
     token?: string;
-    platform?: 'ios' | 'android' | 'web';
     active?: boolean;
+    /**
+     * @deprecated The platform describes the session, not its push registration.
+     * Use {@link SetSessionData.platform} (or the `platform` connection query
+     * parameter). Still accepted by the server, but the top-level field wins.
+     */
+    platform?: SessionPlatform;
 }
 export interface SetSessionData {
     clientFocused?: boolean;
     push?: SessionPush;
+    /** Client platform of this session; null leaves the stored value unchanged. */
+    platform?: SessionPlatform;
 }

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

@@ -1,4 +1,5 @@
 import { PrivateMessagePolicy } from "../UserData";
 export interface SetUserData {
     privateMessagePolicy?: PrivateMessagePolicy;
+    showAsyncPresence?: boolean;
 }

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;
+}