stream-chat-react-native-core 10.0.0-rc.1 → 10.0.0-rc.3

package/src/contexts/channelAddMembersContext/ChannelAddMembersContext.tsx

@@ -14,23 +14,15 @@ import { isTestEnvironment } from '../utils/isTestEnvironment';
 export type ChannelAddMembersContextValue = {
   selectionStore: SelectionStore;
   searchSource: UserSearchSource;
-  /**
-   * Adds the currently selected members to the channel. Resolves on success and
-   * rejects if the request fails.
-   */
+  /** Adds the selected members to the channel. Rejects if the request fails. */
   submit: () => Promise<void>;
 };
 
-/**
- * Props for the {@link ChannelAddMembersProvider} that seed the add-members
- * configuration into the context.
- */
+/** Props of the {@link ChannelAddMembersProvider}. */
 export type ChannelAddMembersProviderProps = PropsWithChildren<{
   /**
-   * A custom `UserSearchSource` used to query and paginate the users to add.
-   * Overrides the source the provider creates by default (pre-configured to
-   * autocomplete by `name`). The provider uses it as-is, so the consumer owns
-   * its activation/sorting.
+   * Custom `UserSearchSource` (the default autocompletes by `name`) that queries and paginates the
+   * users to add. It is used as-is, so the consumer owns its activation and sorting.
    */
   searchSource?: UserSearchSource;
 }>;
@@ -41,8 +33,8 @@ export const ChannelAddMembersContext = React.createContext(
 
 /**
  * Builds the {@link ChannelAddMembersContextValue}. Rendered inside the
- * {@link NotificationTargetProvider} so that notifications emitted by `submit`
- * (via {@link useChannelActions}) resolve to the add-members host.
+ * {@link NotificationTargetProvider} so notifications from `submit` resolve to the add-members
+ * host.
  */
 const ChannelAddMembersContextProviderInner = ({
   children,
@@ -53,7 +45,6 @@ const ChannelAddMembersContextProviderInner = ({
   const { addMembers } = useChannelActions(channel);
   const [selectionStore] = useState(() => new SelectionStore());
   const [searchSource] = useState(() => {
-    // A custom source is used as-is; the consumer owns its activation/sorting.
     if (searchSourceProp) {
       return searchSourceProp;
     }

package/src/contexts/channelContext/ChannelContext.tsx

@@ -8,58 +8,30 @@ import { isTestEnvironment } from '../utils/isTestEnvironment';
 
 export type ChannelContextValue = {
   /**
-   * Instance of channel object from stream-chat package.
-   *
-   * Please check the docs around how to create or query channel - https://getstream.io/chat/docs/javascript/creating_channels/?language=javascript
-   *
-   * ```
-   * import { StreamChat, Channel } from 'stream-chat';
-   * import { Chat, Channel} from 'stream-chat-react-native';
-   *
-   * const client = StreamChat.getInstance('api_key');
-   * await client.connectUser('user_id', 'user_token');
-   * const channel = client.channel('messaging', 'channel_id');
-   * await channel.watch();
-   *
-   * <Chat client={client}>
-   *  <Channel channel={channel}>
-   *  </Channel>
-   * </Chat>
-   * ```
+   * The `stream-chat` channel instance.
    *
    * @overrideType Channel
    */
   channel: Channel;
-  /**
-   * When set to true, reactions will be limited to 1 per user. If user selects another reaction
-   * then his previous reaction will be removed and replaced with new one.
-   *
-   * This is similar to reaction UX on [iMessage application](https://en.wikipedia.org/wiki/IMessage).
-   */
+  /** Limits users to one reaction; picking another replaces the previous. Defaults to false. */
   enforceUniqueReaction: boolean;
   /**
-   * Render the inline date separator above a system message when that message is the first of
-   * its day. Off by default: without it a system message on a day boundary consumes the boundary
-   * and renders nothing, so that day gets no separator at all.
+   * Renders the inline date separator above a system message that is the first of its day.
+   * Defaults to false: a system message on a day boundary then renders no separator for that day.
    */
   allowDateSeparatorForSystemMessages: boolean;
-  /**
-   * Hide inline date separators on channel
-   */
+  /** Hides the inline date separators. Defaults to false. */
   hideDateSeparators: boolean;
   hideStickyDateHeader: boolean;
   /**
-   * Returns true when Channel is about to load an initial targeted message.
+   * Returns true when `Channel` is about to load an initial targeted message.
    *
    * @internal
    */
   hasPendingInitialTargetLoad?: () => boolean;
   disabled?: boolean;
   enableMessageGroupingByUser?: boolean;
-  /**
-   * Maximum time in milliseconds that should occur between messages
-   * to still consider them grouped together
-   */
+  /** Maximum time in milliseconds between messages that are still grouped together. */
   maxTimeBetweenGroupedMessages?: number;
 };
 
@@ -83,7 +55,7 @@ export const useChannelContext = () => {
 
   if (contextValue === DEFAULT_BASE_CONTEXT_VALUE && !isTestEnvironment()) {
     throw new Error(
-      'The useChannelContext hook was called outside of the ChannelContext provider. Make sure you have configured Channel component correctly - https://getstream.io/chat/docs/sdk/reactnative/basics/hello_stream_chat/#channel',
+      'The useChannelContext hook was called outside of the ChannelContext provider. Make sure you have configured Channel component correctly - https://getstream.io/chat/docs/sdk/react-native/core-components/channel/',
     );
   }
 

package/src/contexts/channelDetailsContext/channelDetailsContext.tsx

@@ -8,9 +8,7 @@ import { isTestEnvironment } from '../utils/isTestEnvironment';
 
 export type ChannelDetailsContextValue = {
   channel: Channel;
-  /**
-   * Signals all ChannelDetails modals to close themselves.
-   */
+  /** Signals all channel details modals to close. */
   closeModals: () => void;
   signalStore: SignalStore;
 };

package/src/contexts/channelEditDetailsContext/ChannelEditDetailsContext.tsx

@@ -15,31 +15,19 @@ import { isTestEnvironment } from '../utils/isTestEnvironment';
 
 export type ChannelEditDetailsContextValue = {
   store: EditChannelDetailsStore;
-  /**
-   * Saves the edited channel details (name and/or image). Resolves once every
-   * update succeeds and rejects if any of them fail.
-   */
+  /** Saves the edited name and/or image. Rejects with an `AggregateError` if any update fails. */
   submit: () => Promise<void>;
-  /**
-   * Compress image with quality (from 0 to 1, where 1 is best quality) applied
-   * to the channel image picked during editing.
-   */
+  /** Compression quality from 0 to 1 (1 is best) for the channel image picked while editing. */
   compressImageQuality?: number;
-  /** Override the upload request used to upload the channel image. */
+  /** Overrides the request that uploads the channel image. */
   doFileUploadRequest?: GlobalFileUploadRequest;
 };
 
-/**
- * Props for the {@link ChannelEditDetailsProvider} that seed the edit flow
- * configuration into the context.
- */
+/** Props of the {@link ChannelEditDetailsProvider}. */
 export type ChannelEditDetailsProviderProps = PropsWithChildren<{
-  /**
-   * Compress image with quality (from 0 to 1, where 1 is best quality) applied
-   * to the channel image picked during editing.
-   */
+  /** Compression quality from 0 to 1 (1 is best) for the channel image picked while editing. */
   compressImageQuality?: number;
-  /** Override the upload request used to upload the channel image. */
+  /** Overrides the request that uploads the channel image. */
   doFileUploadRequest?: GlobalFileUploadRequest;
 }>;
 
@@ -49,8 +37,8 @@ export const ChannelEditDetailsContext = React.createContext(
 
 /**
  * Builds the {@link ChannelEditDetailsContextValue}. Rendered inside the
- * {@link NotificationTargetProvider} so that notifications emitted by `submit`
- * (via {@link useChannelActions}) resolve to the channel edit details host.
+ * {@link NotificationTargetProvider} so notifications from `submit` resolve to the edit details
+ * host.
  */
 const ChannelEditDetailsContextProviderInner = ({
   children,
@@ -97,10 +85,9 @@ const ChannelEditDetailsContextProviderInner = ({
 };
 
 /**
- * Creates and provides an {@link EditChannelDetailsStore} snapshotted from the
- * channel in the {@link ChannelDetailsContext}. Mount this once per edit session — the store captures the
- * channel's name/image at construction and does not track later WebSocket
- * updates, so an inbound `channel.updated` does not clobber in-progress edits.
+ * Provides an {@link EditChannelDetailsStore} snapshotted from the channel in the
+ * {@link ChannelDetailsContext}. Mount it once per edit session: the store does not track later
+ * `channel.updated` events, so they cannot overwrite in-progress edits.
  */
 export const ChannelEditDetailsProvider = ({
   children,

package/src/contexts/channelFileAttachmentListContext/ChannelFileAttachmentListContext.tsx

@@ -30,7 +30,7 @@ export const ChannelFileAttachmentListProvider = ({
     source.messageSearchFilters = {
       $or: [{ 'attachments.type': 'file' }, { 'attachments.type': 'audio' }],
     };
-    // Newest first so the list groups cleanly under month section headers.
+    // Newest first, so the list groups under month section headers.
     source.messageSearchSort = [{ field: 'created_at', direction: -1 }];
     source.activate();
     return source;

package/src/contexts/channelMediaListContext/ChannelMediaListContext.tsx

@@ -31,7 +31,7 @@ export const ChannelMediaListProvider = ({
       'attachments.type': { $in: ['image', 'video'] },
       type: undefined,
     };
-    // Newest media first so the grid reads top-to-bottom from most recent.
+    // Newest first.
     source.messageSearchSort = [{ field: 'created_at', direction: -1 }];
     source.activate();
     return source;

package/src/contexts/channelsContext/ChannelsContext.tsx

@@ -12,39 +12,22 @@ import { isTestEnvironment } from '../utils/isTestEnvironment';
 
 export type ChannelsContextValue = {
   /**
-   * Besides the existing default behavior of the ChannelListView component, you can attach
-   * additional props to the underlying React Native FlatList.
-   *
-   * You can find list of all the available FlatList props here - https://facebook.github.io/react-native/docs/flatlist#props
-   *
-   * **EXAMPLE:**
+   * Extra props for the underlying FlatList. Use `setFlatListRef` rather than these to get the ref.
    *
    * ```
-   * <ChannelListView
-   *  channels={channels}
-   *  additionalFlatListProps={{ bounces: true }}
-   * />
+   * <ChannelList additionalFlatListProps={{ bounces: true }} />
    * ```
-   *
-   * **Note:** Don't use `additionalFlatListProps` to access the FlatList ref, use `setFlatListRef`
    */
   additionalFlatListProps: Partial<FlatListProps<Channel>>;
   /**
-   * The React Native FlatList threshold to fetch more data
-   * @see See loadMoreThreshold [doc](https://facebook.github.io/react-native/docs/flatlist#onendreachedthreshold)
-   * */
-  loadMoreThreshold: number;
-  /**
-   * Loads the next page of `channels`, which is present as a required prop
+   * The FlatList `onEndReachedThreshold`, in multiples of the visible list length. Defaults to 0.1.
    */
+  loadMoreThreshold: number;
+  /** Loads the next page of channels. */
   loadNextPage: () => Promise<void>;
-  /**
-   * Max number to display within notification badge. Default: 255 and it cannot be higher than that for now due to backend limitations
-   */
+  /** Highest unread count shown in the badge, which caps larger counts. Defaults to 255. */
   maxUnreadCount: number;
-  /**
-   * Number of skeletons that should show when loading. Default: 8
-   */
+  /** Number of skeleton rows shown while loading. Defaults to 8. */
   numberOfSkeletons: number;
   /**
    * The list's `ChannelPaginator`. Read the loaded channels and the query state from
@@ -52,31 +35,24 @@ export type ChannelsContextValue = {
    */
   paginator: ChannelPaginator;
   /**
-   * Function to refresh the channel list that is similar to `reloadList`, but it doesn't wipe out existing channels
-   * from UI before loading the new ones
+   * Re-queries the first page while keeping the current channels on screen, unlike `reloadList`.
+   * Ignored within 5 seconds of the previous refresh unless the list is in an error state.
    */
   refreshList: () => void | Promise<void>;
-  /**
-   * Removes all the existing channels from UI and loads fresh channels
-   * */
+  /** Clears the channels from the UI and loads the first page again. */
   reloadList: () => Promise<void>;
   /**
-   * Function to gain access to the inner FlatList ref
-   *
-   * **Example:**
+   * Receives the inner FlatList ref, and `null` on unmount.
    *
    * ```
-   * <ChannelListView
-   *  setFlatListRef={(ref) => {
-   *    // Use ref for your own good
-   *  }}
+   * <ChannelList setFlatListRef={(ref) => { listRef.current = ref; }} />
    * ```
    */
   setFlatListRef: (ref: FlatList<Channel> | null) => void;
   /**
-   * Function to set the currently active channel, acts as a bridge between ChannelList and Channel components
+   * Called when a channel is tapped. Bridges `ChannelList` and `Channel`.
    *
-   * @param channel A channel object
+   * @param channel The tapped channel.
    */
   onSelect?: (channel: Channel) => void;
   getChannelActionItems?: GetChannelActionItems;
@@ -106,7 +82,7 @@ export const useChannelsContext = () => {
 
   if (contextValue === DEFAULT_BASE_CONTEXT_VALUE && !isTestEnvironment()) {
     throw new Error(
-      'The useChannelsContext hook was called outside of the ChannelsContext provider. Make sure you have configured ChannelList component correctly - https://getstream.io/chat/docs/sdk/reactnative/basics/hello_stream_chat/#channel-list',
+      'The useChannelsContext hook was called outside of the ChannelsContext provider. Make sure you have configured ChannelList component correctly - https://getstream.io/chat/docs/sdk/react-native/core-components/channel-list/',
     );
   }
 

package/src/contexts/chatConfigContext/ChatConfigContext.tsx

@@ -1,9 +1,7 @@
 import React, { PropsWithChildren, useContext } from 'react';
 
 export type ChatConfigContextValue = {
-  /**
-   * This option allows you to specify a list of CDNs that offer image resizing.
-   */
+  /** CDN hosts whose image URLs can be resized. Defaults to `['.stream-io-cdn.com']`. */
   resizableCDNHosts?: string[];
 };
 

package/src/contexts/chatContext/ChatContext.tsx

@@ -14,13 +14,13 @@ export type ChatContextValue = {
    */
   getAppSettings: () => Promise<GetApplicationResponse>;
   /**
-   * The StreamChat client object
+   * The `StreamChat` client.
    *
    * ```
    * import { StreamChat } from 'stream-chat';
    * import { Chat } from 'stream-chat-react-native';
    *
-   * const client = StreamChat.getInstance('api_key);
+   * const client = StreamChat.getInstance('api_key');
    * await client.connectUser('user_id', 'userToken');
    *
    * <Chat client={client}>
@@ -52,7 +52,7 @@ export const useChatContext = () => {
 
   if (contextValue === DEFAULT_BASE_CONTEXT_VALUE && !isTestEnvironment()) {
     throw new Error(
-      'The useChatContext hook was called outside the ChatContext Provider. Make sure you have configured Chat component correctly - https://getstream.io/chat/docs/sdk/reactnative/basics/hello_stream_chat/#chat',
+      'The useChatContext hook was called outside the ChatContext Provider. Make sure you have configured Chat component correctly - https://getstream.io/chat/docs/sdk/react-native/core-components/chat/',
     );
   }
 

package/src/contexts/componentsContext/ComponentsContext.tsx

@@ -1,15 +1,10 @@
 import React, { PropsWithChildren, useContext, useMemo } from 'react';
 
 /**
- * All overridable UI components in the SDK.
- * Derived from the DEFAULT_COMPONENTS map in defaultComponents.ts.
- * Adding a new default automatically makes it available as an override.
+ * The overridable UI components, derived from `DEFAULT_COMPONENTS` in `defaultComponents.ts`, so a
+ * new default is overridable automatically. Every key is optional.
  *
- * Every key is optional — only specify the components you want to override.
- *
- * The `icons` slot is a nested map: it is typed as a *partial* icon map so
- * integrators can override individual icons without having to supply them all.
- * Sibling defaults are preserved via a deep merge (see below).
+ * `icons` is a partial map: overriding one icon keeps the other defaults.
  */
 export type ComponentOverrides = Omit<
   Partial<(typeof import('./defaultComponents'))['DEFAULT_COMPONENTS']>,
@@ -20,9 +15,8 @@ export type ComponentOverrides = Omit<
   };
 
 /**
- * Resolved component overrides with defaults filled in. Unlike
- * `ComponentOverrides`, the `icons` map is guaranteed fully populated (defaults
- * back every key), so consumers can read `icons.Mute` without a null check.
+ * The component overrides merged over the defaults. Unlike `ComponentOverrides`, every key is
+ * defined, including each entry of `icons`.
  */
 export type ResolvedComponents = Required<Omit<ComponentOverrides, 'icons'>> & {
   icons: import('./defaultComponents').IconsMap;
@@ -31,8 +25,9 @@ export type ResolvedComponents = Required<Omit<ComponentOverrides, 'icons'>> & {
 const ComponentsContext = React.createContext<ComponentOverrides>({});
 
 /**
- * Provider to override UI components at any level of the tree.
- * Supports nesting — inner overrides merge over outer ones (closest wins).
+ * Overrides UI components for the tree below it. Nested providers merge, and the closest wins.
+ *
+ * `overrides` is read once at mount and must be stable.
  *
  * @example
  * ```tsx
@@ -53,8 +48,7 @@ export const WithComponents = ({
     () => ({
       ...parent,
       ...overrides,
-      // Deep-merge the nested `icons` map so overriding one icon keeps the
-      // rest (a shallow spread would replace the whole map).
+      // `icons` is merged one level deeper so overriding one icon keeps the rest.
       icons: { ...parent.icons, ...overrides.icons },
     }),
     // eslint-disable-next-line react-hooks/exhaustive-deps -- intentionally stable: overrides are set once at mount
@@ -63,8 +57,8 @@ export const WithComponents = ({
   return <ComponentsContext.Provider value={merged}>{children}</ComponentsContext.Provider>;
 };
 
-// Lazy-loaded to break circular dependency:
-// defaultComponents.ts → imports components → components import useComponentsContext from this file
+// Required lazily to break a circular import: `defaultComponents` imports components, which import
+// `useComponentsContext` from this file.
 let cachedDefaults: ComponentOverrides | undefined;
 const getDefaults = (): ComponentOverrides => {
   if (!cachedDefaults) {
@@ -75,8 +69,7 @@ const getDefaults = (): ComponentOverrides => {
 };
 
 /**
- * Hook to access resolved component overrides.
- * Returns all components with defaults filled in — user overrides merged over defaults.
+ * Returns every overridable component, with the user's overrides merged over the defaults.
  */
 export const useComponentsContext = () => {
   const overrides = useContext(ComponentsContext);
@@ -85,7 +78,7 @@ export const useComponentsContext = () => {
     return {
       ...defaults,
       ...overrides,
-      // Deep-merge icons so user overrides layer over the full default map.
+      // `icons` is merged one level deeper so overriding one icon keeps the rest.
       icons: { ...defaults.icons, ...overrides.icons },
     } as ResolvedComponents;
     // eslint-disable-next-line react-hooks/exhaustive-deps -- intentionally stable: overrides are set once at mount

package/src/contexts/componentsContext/defaultComponents.ts

@@ -149,7 +149,6 @@ import { StopMessageStreamingButton } from '../../components/MessageInput/StopMe
 import { DateHeader } from '../../components/MessageList/DateHeader';
 import { InlineDateSeparator } from '../../components/MessageList/InlineDateSeparator';
 import { InlineUnreadIndicator } from '../../components/MessageList/InlineUnreadIndicator';
-import { MessageList } from '../../components/MessageList/MessageList';
 import { MessageSystem } from '../../components/MessageList/MessageSystem';
 import { NetworkDownIndicator } from '../../components/MessageList/NetworkDownIndicator';
 import { ScrollToBottomButton } from '../../components/MessageList/ScrollToBottomButton';
@@ -270,22 +269,14 @@ import { XCircle } from '../../icons/x-circle';
 import { NewClose } from '../../icons/xmark';
 import { Cross } from '../../icons/xmark-1';
 
-/**
- * Normalizes each component entry to React.ComponentType<P>, stripping
- * extra inferred properties (like `displayName: string` from runtime
- * assignments) that would otherwise leak into the override types and
- * force integrators to match them.
- */
+/** Reduces each component to `React.ComponentType<P>`, so inferred extras do not leak out. */
 type NormalizeComponents<T> = {
   [K in keyof T]: T[K] extends React.ComponentType<infer P> ? React.ComponentType<P> : T[K];
 };
 
 /**
- * All overridable icon components in the SDK, keyed by their exported name.
- * Exposed via `WithComponents` under the nested `icons` key so integrators can
- * swap any icon: `<WithComponents overrides={{ icons: { Mute: MyMute } }}>`.
- *
- * Only icons that are actually rendered by the SDK are registered here.
+ * The overridable icons, keyed by exported name. Overridden through the nested `icons` key:
+ * `<WithComponents overrides={{ icons: { Mute: MyMute } }}>`.
  */
 export const defaultIcons = {
   ArrowBoxLeft,
@@ -382,10 +373,7 @@ export const defaultIcons = {
   ZIP,
 } satisfies Record<string, React.ComponentType<IconProps>>;
 
-/**
- * Map of all overridable SDK icons. Used to type the `icons` override slot
- * and the resolved value returned by `useComponentsContext().icons`.
- */
+/** The type of `defaultIcons`, which types the `icons` override slot. */
 export type IconsMap = typeof defaultIcons;
 
 const components = {
@@ -459,7 +447,6 @@ const components = {
   MessageInputLeadingView,
   MessageInputTrailingView,
   MessageItemView,
-  MessageList,
   MessagePinnedHeader,
   MessageReactionPicker,
   MessageReminderHeader,
@@ -514,10 +501,8 @@ const components = {
   VideoAttachmentUploadPreview,
   VideoThumbnail,
 
-  // Channel details
   ChannelDetailsHeader,
 
-  // Channel Details Screen
   ChannelAddMembersButton,
   ChannelAddMembersForm,
   ChannelAddMembersFormContent,
@@ -547,7 +532,6 @@ const components = {
   PinnedMessageItem,
   PinnedMessageList,
 
-  // Thread
   ThreadListComponent,
   ThreadListEmptyPlaceholder: DefaultThreadListEmptyPlaceholder,
   ThreadListItem,
@@ -557,7 +541,6 @@ const components = {
   ThreadListUnreadBanner,
   ThreadMessagePreviewDeliveryStatus,
 
-  // Poll
   PollButtons,
   PollHeader,
   PollAllOptionsContent,
@@ -565,23 +548,17 @@ const components = {
   PollResultsContent,
   PollOptionFullResultsContent,
 
-  // ImageGallery
   ImageGalleryFooter,
   ImageGalleryGrid,
   ImageGalleryHeader,
   ImageGalleryVideoControls: ImageGalleryVideoControl,
 
-  // Overlay
   MessageOverlayBackground: DefaultMessageOverlayBackground,
 
-  // Image
   ImageComponent: SvgAwareImage,
 };
 
-/**
- * Optional component slots that have no default implementation.
- * These are `undefined` unless the integrator provides them via WithComponents.
- */
+/** Component slots with no default, `undefined` unless provided via `WithComponents`. */
 export interface OptionalComponentOverrides {
   AttachmentPickerIOSSelectMorePhotos?: React.ComponentType;
   ChatLoadingIndicator?: React.ComponentType | null;
@@ -602,11 +579,5 @@ export interface OptionalComponentOverrides {
   PollContent?: React.ComponentType;
 }
 
-/**
- * All default component implementations used across the SDK.
- * These are the components used when no overrides are provided via WithComponents.
- *
- * The `NormalizeComponents` cast ensures that internal details like
- * `displayName: string` don't leak into the public override types.
- */
+/** The default component for every overridable slot, typed through `NormalizeComponents`. */
 export const DEFAULT_COMPONENTS: NormalizeComponents<typeof components> = components;

package/src/contexts/imageGalleryContext/ImageGalleryContextBase.tsx

@@ -26,7 +26,7 @@ export const useImageGalleryContext = () => {
 
   if (contextValue === DEFAULT_BASE_CONTEXT_VALUE && !isTestEnvironment()) {
     throw new Error(
-      'The useImageGalleryContext hook was called outside the ImageGalleryContext Provider. Make sure you have configured OverlayProvider component correctly - https://getstream.io/chat/docs/sdk/reactnative/basics/hello_stream_chat/#overlay-provider',
+      'The useImageGalleryContext hook was called outside the ImageGalleryContext Provider. Make sure you have configured OverlayProvider component correctly - https://getstream.io/chat/docs/sdk/react-native/core-components/overlay-provider/',
     );
   }
 

package/src/contexts/liveLocationManagerContext/LiveLocationManagerContext.tsx

@@ -33,10 +33,9 @@ export const LiveLocationManagerProvider = (
     if (!client) {
       return null;
     }
-    // Create a new instance of LiveLocationManager with the client and utility functions
     return new LiveLocationManager({
       client,
-      getDeviceId: getDeviceId ?? (() => `react-native-${Platform.OS}-${client.userID}`),
+      getDeviceId: getDeviceId ?? (() => `react-native-${Platform.OS}-${client.userId}`),
       watchLocation,
     });
   }, [client, getDeviceId, watchLocation]);
@@ -45,7 +44,6 @@ export const LiveLocationManagerProvider = (
     if (!liveLocationManager) {
       return;
     }
-    // Initialize the live location manager
     liveLocationManager
       .init()
       .catch((error) => console.warn('Initializing the live location manager failed:', error));

package/src/contexts/liveLocationManagerContext/hooks/useHandleLiveLocationEvents.ts

@@ -7,23 +7,22 @@ import { nowNs } from 'stream-chat';
 import { useChatContext } from '../../../contexts/chatContext/ChatContext';
 
 export type UseLiveLocationsEventsParams = {
-  /**
-   * The channel where the live location is shared.
-   */
+  /** The channel where the live location is shared. */
   channel: Channel;
-  /**
-   * The ID of the message containing the shared location.
-   */
+  /** The ID of the message containing the shared location. */
   messageId: string;
-  /**
-   * Callback function to handle location updates.
-   * It receives the updated shared location response.
-   */
+  /** Called with the updated shared location whenever the message's location is updated. */
   onLocationUpdate?: (location: SharedLocationResponse) => void;
 };
 
 /**
- * Custom hook to handle live location events.
+ * Tracks the shared location of one message from its `message.updated` events.
+ *
+ * @param params.channel The channel to listen on.
+ * @param params.messageId The ID of the message carrying the shared location.
+ * @param params.onLocationUpdate Called with each updated shared location.
+ * @returns The latest `locationResponse`, and `isLiveLocationStopped`, which is `true` once the
+ * location's `end_at` has passed and `null` before that.
  */
 export const useHandleLiveLocationEvents = ({
   channel,

package/src/contexts/messageComposerContext/MessageComposerContext.tsx

@@ -23,9 +23,7 @@ export type MessageComposerContextValue = {
    * or the channel's own.
    */
   messageComposer: MessageComposer;
-  /**
-   * The message being edited, if any.
-   */
+  /** The message being edited, if any. */
   editing?: LocalMessage;
 };