stream-chat 8.38.0 → 8.40.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stream-chat",
-  "version": "8.38.0",
+  "version": "8.40.0",
   "description": "JS SDK for the Stream Chat API",
   "author": "GetStream",
   "homepage": "https://getstream.io/chat/",
@@ -43,7 +43,7 @@
     "form-data": "^4.0.0",
     "isomorphic-ws": "^4.0.1",
     "jsonwebtoken": "~9.0.0",
-    "ws": "^7.4.4"
+    "ws": "^7.5.10"
   },
   "devDependencies": {
     "@babel/cli": "^7.16.0",
@@ -95,7 +95,7 @@
     "eslint-plugin-typescript-sort-keys": "1.5.0",
     "husky": "^4.3.8",
     "lint-staged": "^15.2.2",
-    "mocha": "^9.1.3",
+    "mocha": "^10.7.0",
     "nyc": "^15.1.0",
     "prettier": "^2.2.1",
     "rollup": "^2.41.0",
@@ -103,7 +103,7 @@
     "rollup-plugin-terser": "^7.0.2",
     "sinon": "^12.0.1",
     "standard-version": "^9.3.2",
-    "typescript": "^4.2.3",
+    "typescript": "4.2.3",
     "uuid": "^8.3.2"
   },
   "scripts": {
@@ -118,7 +118,7 @@
     "test-types": "node test/typescript/index.js && tsc --esModuleInterop true --noEmit true --strictNullChecks true --noImplicitAny true --strict true test/typescript/*.ts",
     "eslint": "eslint '**/*.{js,md,ts}' --max-warnings 0 --ignore-path ./.eslintignore",
     "eslint-fix": "npx eslint --fix '**/*.{js,md,ts}' --max-warnings 0 --ignore-path ./.eslintignore",
-    "test-unit": "NODE_ENV=test mocha --exit --bail --timeout 20000 --require ./babel-register test/unit/*.js",
+    "test-unit": "NODE_ENV=test mocha --exit --bail --timeout 20000 --require ./babel-register test/unit/*.{js,test.ts}",
     "test-coverage": "nyc yarn test-unit",
     "test": "yarn test-unit",
     "testwatch": "NODE_ENV=test nodemon ./node_modules/.bin/mocha --timeout 20000 --require test-entry.js test/test.js",
@@ -132,5 +132,6 @@
   },
   "engines": {
     "node": ">=16"
-  }
+  },
+  "packageManager": "yarn@1.22.21+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72"
 }

package/src/channel.ts

@@ -1,5 +1,5 @@
 import { ChannelState } from './channel_state';
-import { logChatPromiseExecution, normalizeQuerySort } from './utils';
+import { logChatPromiseExecution, messageSetPagination, normalizeQuerySort } from './utils';
 import { StreamChat } from './client';
 import {
   APIResponse,
@@ -58,6 +58,7 @@ import {
   AscDesc,
 } from './types';
 import { Role } from './permissions';
+import { DEFAULT_QUERY_CHANNEL_MESSAGE_LIST_PAGE_SIZE } from './constants';
 
 /**
  * Channel - The Channel class manages it's own state.
@@ -319,7 +320,7 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
       throw Error(`Reaction object is missing`);
     }
     return await this.getClient().post<ReactionAPIResponse<StreamChatGenerics>>(
-      this.getClient().baseURL + `/messages/${messageID}/reaction`,
+      this.getClient().baseURL + `/messages/${encodeURIComponent(messageID)}/reaction`,
       {
         reaction,
         ...options,
@@ -342,7 +343,9 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
       throw Error('Deleting a reaction requires specifying both the message and reaction type');
     }
 
-    const url = this.getClient().baseURL + `/messages/${messageID}/reaction/${reactionType}`;
+    const url =
+      this.getClient().baseURL +
+      `/messages/${encodeURIComponent(messageID)}/reaction/${encodeURIComponent(reactionType)}`;
     //provided when server side request
     if (user_id) {
       return this.getClient().delete<ReactionAPIResponse<StreamChatGenerics>>(url, { user_id });
@@ -639,7 +642,7 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
       throw Error(`Message id is missing`);
     }
     return this.getClient().post<SendMessageAPIResponse<StreamChatGenerics>>(
-      this.getClient().baseURL + `/messages/${messageID}/action`,
+      this.getClient().baseURL + `/messages/${encodeURIComponent(messageID)}/action`,
       {
         message_id: messageID,
         form_data: formData,
@@ -704,7 +707,7 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
    *
    * @return {ReturnType<ChannelState<StreamChatGenerics>['formatMessage']> | undefined} Description
    */
-  lastMessage() {
+  lastMessage(): FormatMessageResponse<StreamChatGenerics> | undefined {
     // get last 5 messages, sort, return the latest
     // get a slice of the last 5
     let min = this.state.latestMessages.length - 5;
@@ -821,7 +824,9 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
   }
 
   /**
-   * getReplies - List the message replies for a parent message
+   * getReplies - List the message replies for a parent message.
+   *
+   * The recommended way of working with threads is to use the Thread class.
    *
    * @param {string} parent_id The message parent id, ie the top of the thread
    * @param {MessagePaginationOptions & { user?: UserResponse<StreamChatGenerics>; user_id?: string }} options Pagination params, ie {limit:10, id_lte: 10}
@@ -835,7 +840,7 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
   ) {
     const normalizedSort = sort ? normalizeQuerySort(sort) : undefined;
     const data = await this.getClient().get<GetRepliesAPIResponse<StreamChatGenerics>>(
-      this.getClient().baseURL + `/messages/${parent_id}/replies`,
+      this.getClient().baseURL + `/messages/${encodeURIComponent(parent_id)}/replies`,
       {
         sort: normalizedSort,
         ...options,
@@ -863,7 +868,7 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
     sort: PinnedMessagesSort = [],
   ) {
     return await this.getClient().get<GetRepliesAPIResponse<StreamChatGenerics>>(
-      this.getClient().baseURL + `/channels/${this.type}/${this.id}/pinned_messages`,
+      this._channelURL() + '/pinned_messages',
       {
         payload: {
           ...options,
@@ -883,7 +888,7 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
    */
   getReactions(message_id: string, options: { limit?: number; offset?: number }) {
     return this.getClient().get<GetReactionsAPIResponse<StreamChatGenerics>>(
-      this.getClient().baseURL + `/messages/${message_id}/reactions`,
+      this.getClient().baseURL + `/messages/${encodeURIComponent(message_id)}/reactions`,
       {
         ...options,
       },
@@ -1000,15 +1005,15 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
    * @return {Promise<QueryChannelAPIResponse<StreamChatGenerics>>} Returns a query response
    */
   async query(
-    options: ChannelQueryOptions<StreamChatGenerics>,
+    options?: ChannelQueryOptions<StreamChatGenerics>,
     messageSetToAddToIfDoesNotExist: MessageSetType = 'current',
   ) {
     // Make sure we wait for the connect promise if there is a pending one
     await this.getClient().wsPromise;
 
-    let queryURL = `${this.getClient().baseURL}/channels/${this.type}`;
+    let queryURL = `${this.getClient().baseURL}/channels/${encodeURIComponent(this.type)}`;
     if (this.id) {
-      queryURL += `/${this.id}`;
+      queryURL += `/${encodeURIComponent(this.id)}`;
     }
 
     const state = await this.getClient().post<QueryChannelAPIResponse<StreamChatGenerics>>(queryURL + '/query', {
@@ -1044,6 +1049,16 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
 
     // add any messages to our channel state
     const { messageSet } = this._initializeState(state, messageSetToAddToIfDoesNotExist);
+    messageSet.pagination = {
+      ...messageSet.pagination,
+      ...messageSetPagination({
+        parentSet: messageSet,
+        messagePaginationOptions: options?.messages,
+        requestedPageSize: options?.messages?.limit ?? DEFAULT_QUERY_CHANNEL_MESSAGE_LIST_PAGE_SIZE,
+        returnedPage: state.messages,
+        logger: this.getClient().logger,
+      }),
+    };
 
     const areCapabilitiesChanged =
       [...(state.channel.own_capabilities || [])].sort().join() !==
@@ -1533,7 +1548,7 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
     if (!this.id) {
       throw new Error('channel id is not defined');
     }
-    return `${this.getClient().baseURL}/channels/${this.type}/${this.id}`;
+    return `${this.getClient().baseURL}/channels/${encodeURIComponent(this.type)}/${encodeURIComponent(this.id)}`;
   };
 
   _checkInitialized() {

package/src/channel_state.ts

@@ -6,6 +6,7 @@ import {
   ExtendableGenerics,
   FormatMessageResponse,
   MessageResponse,
+  MessageSet,
   MessageSetType,
   PendingMessageResponse,
   PollResponse,
@@ -13,7 +14,8 @@ import {
   ReactionResponse,
   UserResponse,
 } from './types';
-import { addToMessageList } from './utils';
+import { addToMessageList, formatMessage } from './utils';
+import { DEFAULT_MESSAGE_SET_PAGINATION } from './constants';
 
 type ChannelReadStatus<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Record<
   string,
@@ -56,11 +58,8 @@ export class ChannelState<StreamChatGenerics extends ExtendableGenerics = Defaul
    * The state manages these lists and merges them when lists overlap
    * The messages array contains the currently active set
    */
-  messageSets: {
-    isCurrent: boolean;
-    isLatest: boolean;
-    messages: Array<ReturnType<ChannelState<StreamChatGenerics>['formatMessage']>>;
-  }[] = [];
+  messageSets: MessageSet[] = [];
+
   constructor(channel: Channel<StreamChatGenerics>) {
     this._channel = channel;
     this.watcher_count = 0;
@@ -108,6 +107,10 @@ export class ChannelState<StreamChatGenerics extends ExtendableGenerics = Defaul
     this.messageSets[index].messages = messages;
   }
 
+  get messagePagination() {
+    return this.messageSets.find((s) => s.isCurrent)?.pagination || DEFAULT_MESSAGE_SET_PAGINATION;
+  }
+
   /**
    * addMessageSorted - Add a message to the state
    *
@@ -132,26 +135,12 @@ export class ChannelState<StreamChatGenerics extends ExtendableGenerics = Defaul
   }
 
   /**
-   * formatMessage - Takes the message object. Parses the dates, sets __html
-   * and sets the status to received if missing. Returns a message object
-   *
-   * @param {MessageResponse<StreamChatGenerics>} message a message object
+   * Takes the message object, parses the dates, sets `__html`
+   * and sets the status to `received` if missing; returns a new message object.
    *
+   * @param {MessageResponse<StreamChatGenerics>} message `MessageResponse` object
    */
-  formatMessage(message: MessageResponse<StreamChatGenerics>): FormatMessageResponse<StreamChatGenerics> {
-    return {
-      ...message,
-      /**
-       * @deprecated please use `html`
-       */
-      __html: message.html,
-      // parse the date..
-      pinned_at: message.pinned_at ? new Date(message.pinned_at) : null,
-      created_at: message.created_at ? new Date(message.created_at) : new Date(),
-      updated_at: message.updated_at ? new Date(message.updated_at) : new Date(),
-      status: message.status || 'received',
-    };
-  }
+  formatMessage = (message: MessageResponse<StreamChatGenerics>) => formatMessage<StreamChatGenerics>(message);
 
   /**
    * addMessagesSorted - Add the list of messages to state and resorts the messages
@@ -664,7 +653,7 @@ export class ChannelState<StreamChatGenerics extends ExtendableGenerics = Defaul
           messages[i] = {
             ...m,
             type: 'deleted',
-            deleted_at: user.deleted_at,
+            deleted_at: user.deleted_at ? new Date(user.deleted_at) : null,
           };
         }
       }
@@ -717,7 +706,7 @@ export class ChannelState<StreamChatGenerics extends ExtendableGenerics = Defaul
   }
 
   initMessages() {
-    this.messageSets = [{ messages: [], isLatest: true, isCurrent: true }];
+    this.messageSets = [{ messages: [], isLatest: true, isCurrent: true, pagination: DEFAULT_MESSAGE_SET_PAGINATION }];
   }
 
   /**
@@ -725,6 +714,7 @@ export class ChannelState<StreamChatGenerics extends ExtendableGenerics = Defaul
    *
    * @param {string} messageId The id of the message, or 'latest' to indicate switching to the latest messages
    * @param {string} parentMessageId The id of the parent message, if we want load a thread reply
+   * @param {number} limit The page size if the message has to be queried from the server
    */
   async loadMessageIntoState(messageId: string | 'latest', parentMessageId?: string, limit = 25) {
     let messageSetIndex: number;
@@ -820,7 +810,12 @@ export class ChannelState<StreamChatGenerics extends ExtendableGenerics = Defaul
             targetMessageSetIndex = overlappingMessageSetIndices[0];
             // No new message set is created if newMessages only contains thread replies
           } else if (newMessages.some((m) => !m.parent_id)) {
-            this.messageSets.push({ messages: [], isCurrent: false, isLatest: false });
+            this.messageSets.push({
+              messages: [],
+              isCurrent: false,
+              isLatest: false,
+              pagination: DEFAULT_MESSAGE_SET_PAGINATION,
+            });
             targetMessageSetIndex = this.messageSets.length - 1;
           }
           break;
@@ -846,6 +841,14 @@ export class ChannelState<StreamChatGenerics extends ExtendableGenerics = Defaul
         sources.forEach((messageSet) => {
           target.isLatest = target.isLatest || messageSet.isLatest;
           target.isCurrent = target.isCurrent || messageSet.isCurrent;
+          target.pagination.hasPrev =
+            messageSet.messages[0].created_at < target.messages[0].created_at
+              ? messageSet.pagination.hasPrev
+              : target.pagination.hasPrev;
+          target.pagination.hasNext =
+            target.messages.slice(-1)[0].created_at < messageSet.messages.slice(-1)[0].created_at
+              ? messageSet.pagination.hasNext
+              : target.pagination.hasNext;
           messagesToAdd = [...messagesToAdd, ...messageSet.messages];
         });
         sources.forEach((s) => this.messageSets.splice(this.messageSets.indexOf(s), 1));