stream-chat 8.54.1 → 8.56.0

package/dist/types/utils.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="node" />
 import FormData from 'form-data';
-import { AscDesc, ExtendableGenerics, DefaultGenerics, Logger, OwnUserResponse, UserResponse, MessageResponse, FormatMessageResponse, MessageSet, MessagePaginationOptions } from './types';
+import { AscDesc, ExtendableGenerics, DefaultGenerics, Logger, OwnUserResponse, UserResponse, MessageResponse, FormatMessageResponse, MessageSet, MessagePaginationOptions, ChannelQueryOptions, ChannelSort, ChannelFilters, ChannelSortBase, PromoteChannelParams } from './types';
+import { StreamChat } from './client';
+import { Channel } from './channel';
 import { AxiosRequestConfig } from 'axios';
 /**
  * logChatPromiseExecution - utility function for logging the execution of a promise..
@@ -86,6 +88,34 @@ export declare const findIndexInSortedArray: <T, L>({ needle, sortedArray, selec
     sortDirection?: "ascending" | "descending" | undefined;
 }) => number;
 export declare function addToMessageList<T extends FormatMessageResponse>(messages: readonly T[], newMessage: T, timestampChanged?: boolean, sortBy?: 'pinned_at' | 'created_at', addIfDoesNotExist?: boolean): T[];
+export interface DebouncedFunc<T extends (...args: any[]) => any> {
+    /**
+     * Call the original function, but applying the debounce rules.
+     *
+     * If the debounced function can be run immediately, this calls it and returns its return
+     * value.
+     *
+     * Otherwise, it returns the return value of the last invocation, or undefined if the debounced
+     * function was not invoked yet.
+     */
+    (...args: Parameters<T>): ReturnType<T> | undefined;
+    /**
+     * Throw away any pending invocation of the debounced function.
+     */
+    cancel(): void;
+    /**
+     * If there is a pending invocation of the debounced function, invoke it immediately and return
+     * its return value.
+     *
+     * Otherwise, return the value from the last invocation, or undefined if the debounced function
+     * was never invoked.
+     */
+    flush(): ReturnType<T> | undefined;
+}
+export declare const debounce: <T extends (...args: any[]) => any>(fn: T, timeout?: number, { leading, trailing }?: {
+    leading?: boolean | undefined;
+    trailing?: boolean | undefined;
+}) => DebouncedFunc<T>;
 export declare const throttle: <T extends (...args: unknown[]) => unknown>(fn: T, timeout?: number, { leading, trailing }?: {
     leading?: boolean | undefined;
     trailing?: boolean | undefined;
@@ -104,5 +134,92 @@ export declare const messageSetPagination: <StreamChatGenerics extends Extendabl
     hasNext: boolean;
     hasPrev: boolean;
 };
+declare type GetChannelParams<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
+    client: StreamChat<StreamChatGenerics>;
+    channel?: Channel<StreamChatGenerics>;
+    id?: string;
+    members?: string[];
+    options?: ChannelQueryOptions<StreamChatGenerics>;
+    type?: string;
+};
+/**
+ * Calls channel.watch() if it was not already recently called. Waits for watch promise to resolve even if it was invoked previously.
+ * If the channel is not passed as a property, it will get it either by its channel.cid or by its members list and do the same.
+ * @param client
+ * @param members
+ * @param options
+ * @param type
+ * @param id
+ * @param channel
+ */
+export declare const getAndWatchChannel: <StreamChatGenerics extends ExtendableGenerics = DefaultGenerics>({ channel, client, id, members, options, type, }: GetChannelParams<StreamChatGenerics>) => Promise<Channel<StreamChatGenerics>>;
+/**
+ * Generates a temporary channel.cid for channels created without ID, as they need to be referenced
+ * by an identifier until the back-end generates the final ID. The cid is generated by its member IDs
+ * which are sorted and can be recreated the same every time given the same arguments.
+ * @param channelType
+ * @param members
+ */
+export declare const generateChannelTempCid: (channelType: string, members: string[]) => string | undefined;
+/**
+ * Checks if a channel is pinned or not. Will return true only if channel.state.membership.pinned_at exists.
+ * @param channel
+ */
+export declare const isChannelPinned: <StreamChatGenerics extends ExtendableGenerics = DefaultGenerics>(channel: Channel<StreamChatGenerics>) => boolean;
+/**
+ * Checks if a channel is archived or not. Will return true only if channel.state.membership.archived_at exists.
+ * @param channel
+ */
+export declare const isChannelArchived: <StreamChatGenerics extends ExtendableGenerics = DefaultGenerics>(channel: Channel<StreamChatGenerics>) => boolean;
+/**
+ * A utility that tells us whether we should consider archived channels or not based
+ * on filters. Will return true only if filters.archived exists and is a boolean value.
+ * @param filters
+ */
+export declare const shouldConsiderArchivedChannels: <StreamChatGenerics extends ExtendableGenerics = DefaultGenerics>(filters: ChannelFilters<StreamChatGenerics>) => boolean;
+/**
+ * Extracts the value of the sort parameter at a given index, for a targeted key. Can
+ * handle both array and object versions of sort. Will return null if the index/key
+ * combination does not exist.
+ * @param atIndex - the index at which we'll examine the sort value, if it's an array one
+ * @param sort - the sort value - both array and object notations are accepted
+ * @param targetKey - the target key which needs to exist for the sort at a certain index
+ */
+export declare const extractSortValue: <StreamChatGenerics extends ExtendableGenerics = DefaultGenerics>({ atIndex, sort, targetKey, }: {
+    atIndex: number;
+    targetKey: "unread_count" | "created_at" | "pinned_at" | "updated_at" | "last_message_at" | "member_count" | keyof StreamChatGenerics["channelType"] | "has_unread" | "last_updated";
+    sort?: ChannelSort<StreamChatGenerics> | undefined;
+}) => NonNullable<NonNullable<ChannelSortBase<StreamChatGenerics>>["unread_count" | "created_at" | "pinned_at" | "updated_at" | "last_message_at" | "member_count" | keyof StreamChatGenerics["channelType"] | "has_unread" | "last_updated"]> | null;
+/**
+ * Returns true only if `{ pinned_at: -1 }` or `{ pinned_at: 1 }` option is first within the `sort` array.
+ */
+export declare const shouldConsiderPinnedChannels: <StreamChatGenerics extends ExtendableGenerics = DefaultGenerics>(sort: ChannelSort<StreamChatGenerics>) => boolean;
+/**
+ * Checks whether the sort value of type object contains a pinned_at value or if
+ * an array sort value type has the first value be an object containing pinned_at.
+ * @param sort
+ */
+export declare const findPinnedAtSortOrder: <StreamChatGenerics extends ExtendableGenerics = DefaultGenerics>({ sort, }: {
+    sort: ChannelSort<StreamChatGenerics>;
+}) => NonNullable<NonNullable<ChannelSortBase<StreamChatGenerics>>["unread_count" | "created_at" | "pinned_at" | "updated_at" | "last_message_at" | "member_count" | "has_unread" | "last_updated" | keyof StreamChatGenerics["channelType"]]> | null;
+/**
+ * Finds the index of the last consecutively pinned channel, starting from the start of the
+ * array. Will not consider any pinned channels after the contiguous subsequence at the
+ * start of the array.
+ * @param channels
+ */
+export declare const findLastPinnedChannelIndex: <StreamChatGenerics extends ExtendableGenerics = DefaultGenerics>({ channels, }: {
+    channels: Channel<StreamChatGenerics>[];
+}) => number | null;
+/**
+ * A utility used to move a channel towards the beginning of a list of channels (promote it to a higher position). It
+ * considers pinned channels in the process if needed and makes sure to only update the list reference if the list
+ * should actually change. It will try to move the channel as high as it can within the list.
+ * @param channels - the list of channels we want to modify
+ * @param channelToMove - the channel we want to promote
+ * @param channelToMoveIndexWithinChannels - optionally, the index of the channel we want to move if we know it (will skip a manual check)
+ * @param sort - the sort value used to check for pinned channels
+ */
+export declare const promoteChannel: <StreamChatGenerics extends ExtendableGenerics = DefaultGenerics>({ channels, channelToMove, channelToMoveIndexWithinChannels, sort, }: PromoteChannelParams<StreamChatGenerics>) => Channel<StreamChatGenerics>[];
 export {};
 //# sourceMappingURL=utils.d.ts.map

package/dist/types/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";AAAA,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,EACL,OAAO,EACP,kBAAkB,EAClB,eAAe,EACf,MAAM,EAEN,eAAe,EACf,YAAY,EACZ,eAAe,EACf,qBAAqB,EAErB,UAAU,EACV,wBAAwB,EACzB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3C;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,QAI3E;AAED,eAAO,MAAM,KAAK,MAAO,MAAM,KAAG,QAAQ,IAAI,CAAyC,CAAC;AAExF,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,GAAG,CAAC,GAAG,KAAK,IAAI,QAAQ,CAOpE;AAED,eAAO,MAAM,SAAS;;;CAGrB,CAAC;AAyBF,wBAAgB,SAAS,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe,EACvF,IAAI,CAAC,EAAE,eAAe,CAAC,kBAAkB,CAAC,GAAG,YAAY,CAAC,kBAAkB,CAAC,GAC5E,IAAI,IAAI,eAAe,CAAC,kBAAkB,CAAC,CAE7C;AAMD,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,WAkBrD;AAED,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,cAAc,GAAG,MAAM,GAAG,IAAI,EACnD,IAAI,CAAC,EAAE,MAAM,EACb,WAAW,CAAC,EAAE,MAAM,YAiBrB;AACD,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;eACxD,OAAO;WAAS,MAAM,CAAC;IAc7D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,gBAAgB,EAAE,MAAM,UAKrD;AAED,wBAAgB,QAAQ,WAEvB;AAWD,wBAAgB,cAAc,WAgB7B;AA0BD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,KAAK,2BAgB5C;AAED;;;GAGG;AACH,wBAAgB,QAAQ,YAmBvB;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,QAKjE;AAED,wBAAgB,8BAA8B,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,QAKpE;AAED,eAAO,MAAM,qBAAqB,EAAE,kBAAkB,CAAC,kBAAkB,CAexE,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe,EAC3F,OAAO,EAAE,eAAe,CAAC,kBAAkB,CAAC,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,GACvF,qBAAqB,CAAC,kBAAkB,CAAC,CAmB3C;AAED,eAAO,MAAM,sBAAsB;;;IASjC;;;;;;;;;OASG;sCAC8B,MAAM;IACvC;;;;;;;;OAQG;;IAEH;;;;;;;OAOG;;YAgDJ,CAAC;AAEF,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,qBAAqB,EAC9D,QAAQ,EAAE,SAAS,CAAC,EAAE,EACtB,UAAU,EAAE,CAAC,EACb,gBAAgB,UAAQ,EACxB,MAAM,GAAE,WAAW,GAAG,YAA2B,EACjD,iBAAiB,UAAO,OAyDzB;AA4BD,eAAO,MAAM,QAAQ,uBAAwB,OAAO,EAAE,KAAK,OAAO;;;sCA8BjE,CAAC;AAEF,aAAK,8BAA8B,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe,IAAI;IACrG,SAAS,EAAE,UAAU,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,eAAe,CAAC,kBAAkB,CAAC,EAAE,CAAC;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;CACrD,CAAC;AAEF,wBAAgB,uCAAuC,CACrD,KAAK,EAAE;IACL,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,EAAE,EACH,UAAU,EAAE,IAAI,GACf,MAAM,CAuBR;AAiLD,eAAO,MAAM,oBAAoB;;;CAehC,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";AAAA,OAAO,QAAQ,MAAM,WAAW,CAAC;AACjC,OAAO,EACL,OAAO,EACP,kBAAkB,EAClB,eAAe,EACf,MAAM,EAEN,eAAe,EACf,YAAY,EACZ,eAAe,EACf,qBAAqB,EAErB,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EAEnB,WAAW,EACX,cAAc,EACd,eAAe,EACf,oBAAoB,EACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3C;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,QAI3E;AAED,eAAO,MAAM,KAAK,MAAO,MAAM,KAAG,QAAQ,IAAI,CAAyC,CAAC;AAExF,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,GAAG,CAAC,GAAG,KAAK,IAAI,QAAQ,CAOpE;AAED,eAAO,MAAM,SAAS;;;CAGrB,CAAC;AAyBF,wBAAgB,SAAS,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe,EACvF,IAAI,CAAC,EAAE,eAAe,CAAC,kBAAkB,CAAC,GAAG,YAAY,CAAC,kBAAkB,CAAC,GAC5E,IAAI,IAAI,eAAe,CAAC,kBAAkB,CAAC,CAE7C;AAMD,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,WAkBrD;AAED,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,cAAc,GAAG,MAAM,GAAG,IAAI,EACnD,IAAI,CAAC,EAAE,MAAM,EACb,WAAW,CAAC,EAAE,MAAM,YAiBrB;AACD,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;eACxD,OAAO;WAAS,MAAM,CAAC;IAc7D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,gBAAgB,EAAE,MAAM,UAKrD;AAED,wBAAgB,QAAQ,WAEvB;AAWD,wBAAgB,cAAc,WAgB7B;AA0BD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,KAAK,2BAgB5C;AAED;;;GAGG;AACH,wBAAgB,QAAQ,YAmBvB;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,QAKjE;AAED,wBAAgB,8BAA8B,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,QAKpE;AAED,eAAO,MAAM,qBAAqB,EAAE,kBAAkB,CAAC,kBAAkB,CAexE,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe,EAC3F,OAAO,EAAE,eAAe,CAAC,kBAAkB,CAAC,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,GACvF,qBAAqB,CAAC,kBAAkB,CAAC,CAmB3C;AAED,eAAO,MAAM,sBAAsB;;;IASjC;;;;;;;;;OASG;sCAC8B,MAAM;IACvC;;;;;;;;OAQG;;IAEH;;;;;;;OAOG;;YAgDJ,CAAC;AAEF,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,qBAAqB,EAC9D,QAAQ,EAAE,SAAS,CAAC,EAAE,EACtB,UAAU,EAAE,CAAC,EACb,gBAAgB,UAAQ,EACxB,MAAM,GAAE,WAAW,GAAG,YAA2B,EACjD,iBAAiB,UAAO,OAyDzB;AA4BD,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG;IAC9D;;;;;;;;OAQG;IACH,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAEpD;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;;;;;OAMG;IACH,KAAK,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;CACpC;AAID,eAAO,MAAM,QAAQ,uBAAwB,GAAG,EAAE,KAAK,GAAG;;;sBA4CzD,CAAC;AAGF,eAAO,MAAM,QAAQ,uBAAwB,OAAO,EAAE,KAAK,OAAO;;;sCA8BjE,CAAC;AAEF,aAAK,8BAA8B,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe,IAAI;IACrG,SAAS,EAAE,UAAU,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,eAAe,CAAC,kBAAkB,CAAC,EAAE,CAAC;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;CACrD,CAAC;AAEF,wBAAgB,uCAAuC,CACrD,KAAK,EAAE;IACL,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,EAAE,EACH,UAAU,EAAE,IAAI,GACf,MAAM,CAuBR;AAiLD,eAAO,MAAM,oBAAoB;;;CAehC,CAAC;AAQF,aAAK,gBAAgB,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe,IAAI;IACvF,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACvC,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;IAClD,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AACF;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,mMAyC9B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,gBAAiB,MAAM,WAAW,MAAM,EAAE,uBAK5E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,oHAQ3B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,oHAQ7B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,2HAM1C,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB;aAKlB,MAAM;;;qPA4BhB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,qHAQxC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;qPAS9B,CAAC;AAEL;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B;;mBAkBtC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,oNAyC1B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stream-chat",
-  "version": "8.54.1",
+  "version": "8.56.0",
   "description": "JS SDK for the Stream Chat API",
   "author": "GetStream",
   "homepage": "https://getstream.io/chat/",

package/src/channel.ts

@@ -1,5 +1,5 @@
 import { ChannelState } from './channel_state';
-import { logChatPromiseExecution, messageSetPagination, normalizeQuerySort } from './utils';
+import { generateChannelTempCid, logChatPromiseExecution, messageSetPagination, normalizeQuerySort } from './utils';
 import { StreamChat } from './client';
 import {
   APIResponse,
@@ -1179,13 +1179,12 @@ export class Channel<StreamChatGenerics extends ExtendableGenerics = DefaultGene
       this.cid = state.channel.cid;
       // set the channel as active...
 
-      const membersStr = state.members
-        .map((member) => member.user_id || member.user?.id)
-        .sort()
-        .join(',');
-      const tempChannelCid = `${this.type}:!members-${membersStr}`;
+      const tempChannelCid = generateChannelTempCid(
+        this.type,
+        state.members.map((member) => member.user_id || member.user?.id || ''),
+      );
 
-      if (tempChannelCid in this.getClient().activeChannels) {
+      if (tempChannelCid && tempChannelCid in this.getClient().activeChannels) {
         // This gets set in `client.channel()` function, when channel is created
         // using members, not id.
         delete this.getClient().activeChannels[tempChannelCid];