stream-chat 9.50.3 → 10.0.0-rc.2

package/src/messageComposer/middleware/messageComposer/types.ts

@@ -1,15 +1,14 @@
 import type { Middleware, MiddlewareExecutionResult } from '../../../middleware';
 import type {
-  DraftMessagePayload,
   LocalMessage,
-  Message,
+  MessageRequest,
   SendMessageOptions,
   UpdatedMessage,
 } from '../../../types';
 import type { MessageComposer } from '../../messageComposer';
 
 export type MessageComposerMiddlewareState = {
-  message: Message | UpdatedMessage;
+  message: MessageRequest | UpdatedMessage;
   localMessage: LocalMessage;
   sendOptions: SendMessageOptions;
 };
@@ -22,7 +21,7 @@ export type MessageComposerMiddlewareExecutorOptions = {
 };
 
 export type MessageDraftComposerMiddlewareValueState = {
-  draft: DraftMessagePayload;
+  draft: MessageRequest;
 };
 
 export type MessageDraftComposerMiddlewareExecutorOptions = {

package/src/messageComposer/middleware/messageComposer/userDataInjection.ts

@@ -4,7 +4,7 @@ import type {
   MessageCompositionMiddleware,
 } from './types';
 import type { MiddlewareHandlerParams } from '../../../middleware';
-import type { OwnUserResponse } from '../../../types';
+import type { OwnUserResponse, RequireLiteral } from '../../../types';
 
 export const createUserDataInjectionMiddleware = (
   composer: MessageComposer,
@@ -27,14 +27,18 @@ export const createUserDataInjectionMiddleware = (
       // precedence after we connectUser the first time and we get the connection health
       // check event. Due to how liberal the type of client.user is, we have to do it this
       // way to maintain type safety.
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      const { channel_mutes, devices, mutes, ...messageUser } = composer.client
-        .user as OwnUserResponse;
+
+      const {
+        channel_mutes: _channel_mutes,
+        devices: _devices,
+        mutes: _mutes,
+        ...messageUser
+      } = composer.client.user;
       return next({
         ...state,
         localMessage: {
           ...state.localMessage,
-          user: messageUser,
+          user: messageUser as RequireLiteral<OwnUserResponse, 'blocked_user_ids'>, // TODO: drop RequireLiteral once the oapi spec is adjusted,
           user_id: messageUser.id,
         },
       });

package/src/messageComposer/middleware/pollComposer/state.ts

@@ -21,7 +21,6 @@ export type PollStateValidationOutput = Partial<
 
 export type PollStateChangeValidator = (params: {
   data: PollComposerState['data'];
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   value: any;
   currentError?: PollComposerFieldErrors[keyof PollComposerFieldErrors];
 }) => PollStateValidationOutput;
@@ -95,7 +94,6 @@ export type PollCompositionStateProcessorOutput = Partial<PollComposerState['dat
 
 export type PollCompositionStateProcessor = (params: {
   data: PollComposerState['data'];
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   value: any;
 }) => PollCompositionStateProcessorOutput;
 

package/src/messageComposer/middleware/pollComposer/types.ts

@@ -1,5 +1,5 @@
 import type { MiddlewareExecutionResult } from '../../../middleware';
-import type { CreatePollData, VotingVisibility } from '../../../types';
+import type { CreatePollRequest, VotingVisibility } from '../../../types';
 
 export type PollComposerOption = {
   id: string;
@@ -19,17 +19,15 @@ export type UpdateFieldsData = Partial<Omit<PollComposerState['data'], 'options'
   options?: PollComposerOptionUpdate;
 };
 
-type Id = string;
-
 export type PollComposerFieldErrors = Partial<
-  Omit<Record<keyof CreatePollData, string>, 'options'> & {
+  Omit<Record<keyof CreatePollRequest, string>, 'options'> & {
     options?: Record<string, string>;
   }
 >;
 
 export type PollComposerState = {
   data: {
-    id: Id;
+    id: string;
     max_votes_allowed: string;
     name: string;
     options: PollComposerOption[];
@@ -38,14 +36,13 @@ export type PollComposerState = {
     description?: string;
     enforce_unique_vote?: boolean;
     is_closed?: boolean;
-    user_id?: string;
     voting_visibility?: VotingVisibility;
   };
   errors: PollComposerFieldErrors;
 };
 
 export type PollComposerCompositionMiddlewareValueState = {
-  data: CreatePollData;
+  data: CreatePollRequest;
   errors: PollComposerFieldErrors;
 };
 

package/src/messageComposer/middleware/textComposer/TextComposerMiddlewareExecutor.ts

@@ -2,6 +2,7 @@ import { createCommandsMiddleware } from './commands';
 import { createCommandEffectsMiddleware } from './commandEffects';
 import { createMentionsMiddleware } from './mentions';
 import { createTextComposerPreValidationMiddleware } from './validation';
+import { chatLoggerSystem } from '../../../logger';
 import { MiddlewareExecutor } from '../../../middleware';
 import type {
   ExecuteParams,
@@ -16,6 +17,8 @@ import type {
   TextComposerState,
 } from './types';
 
+const logger = chatLoggerSystem.getLogger('text-composer');
+
 export type TextComposerMiddlewareExecutorState<T extends Suggestion = Suggestion> =
   TextComposerState<T> & {
     change?: {
@@ -71,7 +74,13 @@ export class TextComposerMiddlewareExecutor<
      * That means the result of the previous search call as the debounced call result is unknown at the moment.
      * Custom search source implementation should handle errors meaningfully internally.
      */
-    searchSource?.search(query)?.catch(console.error);
+    searchSource
+      ?.search(query)
+      ?.catch((error) =>
+        logger
+          .withExtraTags('execute')
+          .error('Searching for suggestions failed.', { error }),
+      );
 
     return result;
   }

package/src/messageComposer/middleware/textComposer/commandEffects.ts

@@ -1,5 +1,5 @@
 import type { Middleware } from '../../../middleware';
-import type { CommandResponse } from '../../../types';
+import type { Command } from '../../../types';
 import type {
   CommandSuggestion,
   TextComposerCommandActivationEffect,
@@ -18,14 +18,14 @@ const emptyCommandStateToRestore: TextComposerCommandActivationStateToRestore =
 };
 
 const createCommandActivationEffect = (
-  command: CommandResponse,
+  command: Command,
 ): TextComposerCommandActivationEffect => ({
   command,
   stateToRestore: emptyCommandStateToRestore,
   type: 'command.activate',
 });
 
-const isCommandResponse = (suggestion: unknown): suggestion is CommandSuggestion =>
+const isCommand = (suggestion: unknown): suggestion is CommandSuggestion =>
   typeof (suggestion as CommandSuggestion | undefined)?.name === 'string';
 
 export const createCommandEffectsMiddleware = (): CommandEffectsMiddleware => ({
@@ -34,7 +34,7 @@ export const createCommandEffectsMiddleware = (): CommandEffectsMiddleware => ({
     onSuggestionItemSelect: ({ state, next, forward }) => {
       const { selectedSuggestion } = state.change ?? {};
       if (
-        !isCommandResponse(selectedSuggestion) ||
+        !isCommand(selectedSuggestion) ||
         !state.command ||
         state.command.name !== selectedSuggestion.name
       ) {

package/src/messageComposer/middleware/textComposer/commandUtils.ts

@@ -1,5 +1,5 @@
 import type { MessageComposer } from '../../messageComposer';
-import type { CommandResponse, UserResponse } from '../../../types';
+import type { Command, UserResponse } from '../../../types';
 import type { CommandSendability } from '../../configuration';
 import type { CommandSearchSource } from './commands';
 
@@ -49,7 +49,7 @@ export const getMentionedUsersInText = (text: string, mentionedUsers: UserRespon
 export const getCommandByName = (
   searchSource: CommandSearchSource,
   commandName?: string,
-): CommandResponse | undefined => {
+): Command | undefined => {
   if (!commandName) return;
 
   const normalizedCommandName = commandName.toLowerCase();
@@ -58,10 +58,7 @@ export const getCommandByName = (
     .items.find((command) => command.name?.toLowerCase() === normalizedCommandName);
 };
 
-export const notifyCommandDisabled = (
-  composer: MessageComposer,
-  command: CommandResponse,
-) => {
+export const notifyCommandDisabled = (composer: MessageComposer, command: Command) => {
   const disabledReason = composer.getCommandDisabledReason(command);
   if (!disabledReason) return;
 

package/src/messageComposer/middleware/textComposer/commands.ts

@@ -2,7 +2,7 @@ import type { Channel } from '../../../channel';
 import type { Middleware } from '../../../middleware';
 import type { SearchSourceOptions } from '../../../search';
 import { BaseSearchSourceSync } from '../../../search';
-import type { CommandResponse } from '../../../types';
+import type { Command } from '../../../types';
 import { mergeWith } from '../../../utils/mergeWith';
 import type { MessageComposer } from '../../messageComposer';
 import type { CommandSuggestion, TextComposerMiddlewareOptions } from './types';
@@ -40,8 +40,8 @@ export class CommandSearchSource extends BaseSearchSourceSync<CommandSuggestion>
   query(searchQuery: string) {
     const channelConfig = this.channel.getConfig();
     const commands = channelConfig?.commands || [];
-    const selectedCommands: (CommandResponse & { name: string })[] = commands.filter(
-      (command): command is CommandResponse & { name: string } =>
+    const selectedCommands: Command[] = commands.filter(
+      (command): command is Command =>
         !!(
           command.name &&
           command.name.toLowerCase().indexOf(searchQuery.toLowerCase()) !== -1

package/src/messageComposer/middleware/textComposer/mentionUtils.ts

@@ -13,8 +13,8 @@ export const userResponsesToMentionEntities = (users: UserResponse[]) =>
   users.map(userResponseToMentionEntity);
 
 export const mentionEntityToUserResponse = (entity: UserMentionEntity): UserResponse => {
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const { mentionType, ...user } = entity;
+  void mentionType;
   return user;
 };
 

package/src/messageComposer/middleware/textComposer/mentions.ts

@@ -487,7 +487,7 @@ export class MentionsSearchSource extends BaseSearchSource<MentionSuggestion> {
 
     return this.getMembersAndWatchers()
       .filter((user) => {
-        if (user.id === this.client.userID) return false;
+        if (user.id === this.client.userId) return false;
         if (!searchQuery) return true;
 
         const updatedId = this.transliterate(removeDiacritics(user.id)).toLowerCase();
@@ -513,7 +513,7 @@ export class MentionsSearchSource extends BaseSearchSource<MentionSuggestion> {
         if (!this.memberSort) return (a.name || '').localeCompare(b.name || '');
 
         // Apply each sort criteria in order
-        for (const [field, direction] of Object.entries(this.memberSort)) {
+        for (const { field, direction } of this.memberSort) {
           const aValue = a[field as keyof UserResponse];
           const bValue = b[field as keyof UserResponse];
 
@@ -534,20 +534,22 @@ export class MentionsSearchSource extends BaseSearchSource<MentionSuggestion> {
       ],
       ...this.userFilters,
     } as UserFilters,
-    sort: this.userSort ?? ([{ name: 1 }, { id: 1 }] as UserSort), // todo: document the change - the sort is overridden, not merged
+    sort:
+      this.userSort ??
+      ([
+        { field: 'name', direction: 1 },
+        { field: 'id', direction: 1 },
+      ] satisfies UserSort), // todo: document the change - the sort is overridden, not merged
     options: { ...this.searchOptions, limit: this.pageSize, offset },
   });
 
   prepareQueryMembersParams = (searchQuery: string, offset = 0) => {
     // QueryMembers failed with error: \"sort must contain at maximum 1 item\"
-    const maxSortParamsCount = 1;
-    let sort: MemberSort = [{ user_id: 1 }];
-    if (!this.memberSort) {
-      sort = [{ user_id: 1 }];
-    } else if (Array.isArray(this.memberSort)) {
-      sort = this.memberSort[0];
-    } else if (Object.keys(this.memberSort).length === maxSortParamsCount) {
-      sort = this.memberSort;
+    let sort: MemberSort = [{ field: 'user_id', direction: 1 }];
+    if (!this.memberSort || !this.memberSort.length) {
+      sort = [{ field: 'user_id', direction: 1 }];
+    } else {
+      sort = this.memberSort.slice(0, 1);
     } // todo: document the change - the sort is overridden, not merged
     return {
       // todo: document the change - the filter is overridden, not merged
@@ -560,7 +562,13 @@ export class MentionsSearchSource extends BaseSearchSource<MentionSuggestion> {
 
   queryUsers = async (searchQuery: string, offset = 0) => {
     const { filters, sort, options } = this.prepareQueryUsersParams(searchQuery, offset);
-    const { users } = await this.client.queryUsers(filters, sort, options);
+    const { users } = await this.client.queryUsers({
+      payload: {
+        filter_conditions: filters,
+        sort,
+        ...options,
+      },
+    });
     return users;
   };
 
@@ -569,7 +577,13 @@ export class MentionsSearchSource extends BaseSearchSource<MentionSuggestion> {
       searchQuery,
       offset,
     );
-    const response = await this.channel.queryMembers(filters, sort, options);
+    const response = await this.channel.queryMembers({
+      payload: {
+        filter_conditions: filters,
+        sort,
+        ...options,
+      },
+    });
 
     return response.members.map((member) => member.user) as UserResponse[];
   };
@@ -721,13 +735,15 @@ export class MentionsSearchSource extends BaseSearchSource<MentionSuggestion> {
       return data.filter(
         (suggestion) =>
           suggestion.mentionType === 'user' &&
-          mutedUsers.some((mute) => mute.target.id === suggestion.id),
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          mutedUsers.some((mute) => mute.target!.id === suggestion.id),
       );
     }
     return data.filter(
       (suggestion) =>
         suggestion.mentionType !== 'user' ||
-        mutedUsers.every((mute) => mute.target.id !== suggestion.id),
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        mutedUsers.every((mute) => mute.target!.id !== suggestion.id),
     );
   }
 

package/src/messageComposer/middleware/textComposer/types.ts

@@ -1,6 +1,6 @@
 import type { MessageComposer } from '../../messageComposer';
 import type { MessageComposerEffect } from '../../messageComposer';
-import type { CommandResponse, UserResponse } from '../../../types';
+import type { Command, Event, UserResponse } from '../../../types';
 import type { TokenizationPayload } from './textMiddlewareUtils';
 import type { SearchSource, SearchSourceSync } from '../../../search';
 import type { CustomTextComposerSuggestion } from '../../types.custom';
@@ -15,7 +15,7 @@ export type BaseSuggestion = {
 
 export type CommandSuggestionDisabledReason = 'editing' | 'quoted_message';
 
-export type CommandSuggestion = BaseSuggestion & CommandResponse;
+export type CommandSuggestion = BaseSuggestion & Command;
 export type UserSuggestion = BaseSuggestion &
   UserResponse &
   TokenizationPayload & {
@@ -90,7 +90,7 @@ export type TextComposerCommandActivationStateToRestore =
   Partial<TextComposerStateSnapshot>;
 
 export type TextComposerCommandActivationEffect = {
-  command: CommandResponse;
+  command: Command;
   stateToRestore?: TextComposerCommandActivationStateToRestore;
   type: 'command.activate';
 };
@@ -126,6 +126,11 @@ export type TextComposerState<T extends Suggestion = Suggestion> = {
   mentions?: MentionEntity[];
   selection: TextSelection;
   text: string;
-  command?: CommandResponse | null;
+  /**
+   * Live typing events keyed by user id.
+   * Maps `user.id` -> latest typing event (`typing.start`/`typing.stop`) for that user.
+   */
+  typing: Record<string, Event>;
+  command?: Command | null;
   suggestions?: Suggestions<T>;
 };

package/src/messageComposer/pollComposer.ts

@@ -45,7 +45,6 @@ export class PollComposer {
         max_votes_allowed: '',
         name: '',
         options: [{ id: generateUUIDv4(), text: '' }],
-        user_id: this.composer.client.user?.id,
         voting_visibility: VotingVisibility.public,
       },
       errors: {},
@@ -76,9 +75,6 @@ export class PollComposer {
   get options() {
     return this.state.getLatestValue().data.options;
   }
-  get user_id() {
-    return this.state.getLatestValue().data.user_id;
-  }
   get voting_visibility() {
     return this.state.getLatestValue().data.voting_visibility;
   }
@@ -86,7 +82,7 @@ export class PollComposer {
   get canCreatePoll() {
     const { data, errors } = this.state.getLatestValue();
     const hasAtLeastOneNonEmptyOption =
-      data.options.filter((o) => !!o.text.trim()).length > 0;
+      Array.isArray(data.options) && data.options.some((o) => !!o.text?.trim());
     const hasName = !!data.name;
     const maxVotesAllowedNumber = parseInt(
       data.max_votes_allowed?.match(VALID_MAX_VOTES_VALUE_REGEX)?.[0] || '',
@@ -116,9 +112,11 @@ export class PollComposer {
   };
 
   /**
-   * Updates specified fields and generates relevant errors
-   * @param data
-   * @param injectedFieldErrors - errors produced externally that will take precedence over the errors generated in the middleware chaing
+   * Updates specified fields and generates relevant errors.
+   *
+   * @param data - Partial poll data with the fields to update.
+   * @param injectedFieldErrors - Errors produced externally that will take precedence over the
+   *   errors generated in the middleware chain.
    */
   // FIXME: change method params to a single object with the next major release
   updateFields = async (

package/src/messageComposer/textComposer.ts

@@ -18,7 +18,7 @@ import {
   userResponseToMentionEntity,
 } from './middleware/textComposer/mentionUtils';
 import type { MessageComposer } from './messageComposer';
-import type { CommandResponse, DraftMessage, LocalMessage, UserResponse } from '../types';
+import type { Command, DraftMessage, Event, LocalMessage, UserResponse } from '../types';
 
 export type TextComposerOptions = {
   composer: MessageComposer;
@@ -120,6 +120,7 @@ const initState = ({
       mentionedUsers: [],
       mentions: [],
       text,
+      typing: {},
       selection: { start: text.length, end: text.length },
     };
   }
@@ -133,6 +134,7 @@ const initState = ({
     mentionedUsers,
     mentions,
     text,
+    typing: {},
     selection: { start: text.length, end: text.length },
   };
 };
@@ -227,6 +229,29 @@ export class TextComposer {
     return this.state.getLatestValue().text;
   }
 
+  get typing() {
+    return this.state.getLatestValue().typing;
+  }
+
+  set typing(typing: Record<string, Event>) {
+    this.state.partialNext({ typing });
+  }
+
+  setTyping = (typing: Record<string, Event>) => {
+    this.typing = typing;
+  };
+
+  setTypingEvent = (userId: string, event: Event) => {
+    this.typing = { ...this.typing, [userId]: event };
+  };
+
+  removeTypingEvent = (userId: string) => {
+    if (!this.typing[userId]) return;
+    const typing = { ...this.typing };
+    delete typing[userId];
+    this.typing = typing;
+  };
+
   get textIsEmpty() {
     return textIsEmpty(this.text);
   }
@@ -341,7 +366,7 @@ export class TextComposer {
     this.setMentions(mentions);
   };
 
-  setCommand = (command: CommandResponse | null) => {
+  setCommand = (command: Command | null) => {
     if (!command) {
       this.clearCommand();
       return;

package/src/messageComposer/types.ts

@@ -1,4 +1,5 @@
-import type { Attachment, FileUploadConfig, GiphyData } from '../types';
+import type { CustomAttachmentData } from '../custom_types';
+import type { Attachment, FileUploadConfig } from '../types';
 
 export type LocalAttachment = AnyLocalAttachment | LocalUploadAttachment;
 
@@ -57,54 +58,31 @@ export type UploadedAttachment =
   | VoiceRecordingAttachment;
 
 export type VoiceRecordingAttachment = Attachment & {
-  asset_url: string;
   type: 'voiceRecording';
-  duration?: number;
-  file_size?: number;
-  mime_type?: string;
-  title?: string;
-  waveform_data?: Array<number>;
+  custom: CustomAttachmentData & {
+    duration?: number;
+    waveform_data?: Array<number>;
+  };
 };
 
 export type FileAttachment = Attachment & {
   type: 'file';
-  asset_url?: string;
-  file_size?: number;
-  mime_type?: string;
-  title?: string;
 };
 
 export type AudioAttachment = Attachment & {
   type: 'audio';
-  asset_url?: string;
-  file_size?: number;
-  mime_type?: string;
-  title?: string;
 };
 
 export type VideoAttachment = Attachment & {
   type: 'video';
-  asset_url?: string;
-  file_size?: number;
-  mime_type?: string;
-  thumb_url?: string;
-  title?: string;
 };
 
 export type ImageAttachment = Attachment & {
   type: 'image';
-  fallback?: string;
-  image_url?: string;
-  original_height?: number;
-  original_width?: number;
 };
 
 export type GiphyAttachment = Attachment & {
   type: 'giphy';
-  giphy?: GiphyData;
-  title?: string;
-  title_link?: string;
-  thumbnail_url?: string;
 };
 
 export type BaseLocalAttachmentMetadata = {