@linktr.ee/messaging-react 3.11.0 → 3.12.0-rc-1783766425

package/dist/index.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-Bx_zjNMR.cjs");exports.ActionButton=e.ActionButton;exports.Avatar=e.Avatar;exports.ChannelEmptyState=e.ChannelEmptyState;exports.ChannelList=e.ChannelList;exports.ChannelView=e.ChannelView;exports.CustomMessageProvider=e.CustomMessageProvider;exports.FaqList=e.FaqList;exports.FaqListItem=e.FaqListItem;exports.LinkAttachment=e.LinkAttachment;exports.LockedAttachment=e.LockedAttachment;exports.MediaMessage=e.MediaMessage;exports.MessageAttachment=e.MessageAttachment;exports.MessageBubble=e.MessageBubble;exports.MessageVoteButtons=e.MessageVoteButtons;exports.MessagingProvider=e.MessagingProvider;exports.MessagingShell=e.MessagingShell;exports.buildCompactMetaLabel=e.buildCompactMetaLabel;exports.formatFileSize=e.formatFileSize;exports.formatRelativeTime=e.formatRelativeTime;exports.getFileExtensionLabel=e.getFileExtensionLabel;exports.getMessageDisplayText=e.getMessageDisplayText;exports.isLinkAttachment=e.isLinkAttachment;exports.isUuidLike=e.isUuidLike;exports.messageAttachmentGroupPositionFromStream=e.bubbleGroupPositionFromStream;exports.normalizeLanguageCode=e.normalizeLanguageCode;exports.resolveConversationParticipant=e.resolveConversationParticipant;exports.resolveLinkAttachment=e.resolveLinkAttachment;exports.resolveMediaFromMessage=e.resolveMediaFromMessage;exports.resolveParticipantDisplayName=e.resolveParticipantDisplayName;exports.useComposerLocked=e.useComposerLocked;exports.useCustomMessage=e.useCustomMessage;exports.useMessageVote=e.useMessageVote;exports.useMessaging=e.useMessaging;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-CyHyftBi.cjs");exports.ActionButton=e.ActionButton;exports.Avatar=e.Avatar;exports.ChannelEmptyState=e.ChannelEmptyState;exports.ChannelList=e.ChannelList;exports.ChannelView=e.ChannelView;exports.CustomMessageProvider=e.CustomMessageProvider;exports.FaqList=e.FaqList;exports.FaqListItem=e.FaqListItem;exports.LinkAttachment=e.LinkAttachment;exports.LockedAttachment=e.LockedAttachment;exports.MediaMessage=e.MediaMessage;exports.MessageAttachment=e.MessageAttachment;exports.MessageBubble=e.MessageBubble;exports.MessageVoteButtons=e.MessageVoteButtons;exports.MessagingProvider=e.MessagingProvider;exports.MessagingShell=e.MessagingShell;exports.buildCompactMetaLabel=e.buildCompactMetaLabel;exports.formatFileSize=e.formatFileSize;exports.formatRelativeTime=e.formatRelativeTime;exports.getFileExtensionLabel=e.getFileExtensionLabel;exports.getMessageDisplayText=e.getMessageDisplayText;exports.isLinkAttachment=e.isLinkAttachment;exports.isUuidLike=e.isUuidLike;exports.messageAttachmentGroupPositionFromStream=e.bubbleGroupPositionFromStream;exports.normalizeLanguageCode=e.normalizeLanguageCode;exports.resolveConversationParticipant=e.resolveConversationParticipant;exports.resolveLinkAttachment=e.resolveLinkAttachment;exports.resolveMediaFromMessage=e.resolveMediaFromMessage;exports.resolveParticipantDisplayName=e.resolveParticipantDisplayName;exports.useComposerLocked=e.useComposerLocked;exports.useCustomMessage=e.useCustomMessage;exports.useMessageVote=e.useMessageVote;exports.useMessaging=e.useMessaging;
 //# sourceMappingURL=index.cjs.map

package/dist/index.d.ts

@@ -6,7 +6,9 @@ import { ChannelPreviewUIComponentProps } from 'stream-chat-react';
 import { ChannelSort } from 'stream-chat';
 import { ComponentType } from 'react';
 import { default as default_2 } from 'react';
+import { Dispatch } from 'react';
 import { EmptyStateIndicatorProps } from 'stream-chat-react';
+import { Event as Event_2 } from 'stream-chat';
 import { FC } from 'react';
 import { InfiniteScrollProps } from 'stream-chat-react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
@@ -14,6 +16,7 @@ import { LocalMessage } from 'stream-chat';
 import { MessagingUser } from '@linktr.ee/messaging-core';
 import { Provider } from 'react';
 import { SendMessageAPIResponse } from 'stream-chat';
+import { SetStateAction } from 'react';
 import { StreamChat } from 'stream-chat';
 import { StreamChatService } from '@linktr.ee/messaging-core';
 import { StreamChatServiceConfig } from '@linktr.ee/messaging-core';
@@ -153,8 +156,37 @@ export declare interface ChannelListProps {
      * Falls back to message.text when no matching translation exists.
      */
     viewerLanguage?: string;
+    /**
+     * Lock the visible channel order so live events don't promote a channel to
+     * the top. Forwarded to Stream's `<ChannelList>`. Note `lockChannelOrder`
+     * alone doesn't cover `notification.message_new` or `channel.visible`; pair it
+     * with the event handlers below to fully neutralize promotion.
+     */
+    lockChannelOrder?: boolean;
+    /**
+     * Live channel-list event handlers forwarded verbatim to Stream's
+     * `<ChannelList>`. Left undefined, Stream applies its default "move the
+     * changed channel to the top" behaviour.
+     *
+     * Hosts that order by a custom channel field (`last_conversation_at` for the
+     * inbox, `priority_score` for Spotlight) use these to neutralize promotion on
+     * new-message / visibility events and re-sort on `channel.updated` instead.
+     * Each receives Stream's `setChannels` dispatcher and the triggering event.
+     * See MES-1214 / MES-1219.
+     */
+    onMessageNewHandler?: ChannelListReorderHandler;
+    onMessageNew?: ChannelListReorderHandler;
+    onChannelVisible?: ChannelListReorderHandler;
+    onAddedToChannel?: ChannelListReorderHandler;
+    onChannelUpdated?: ChannelListReorderHandler;
 }
 
+/**
+ * Signature of Stream's `<ChannelList>` live-event handlers: mutate the loaded
+ * channel array via `setChannels` in response to a websocket `event`.
+ */
+export declare type ChannelListReorderHandler = (setChannels: Dispatch<SetStateAction<Channel[]>>, event: Event_2) => void;
+
 declare type ChannelMember = ChannelMembers[string];
 
 declare type ChannelMembers = NonNullable<Channel['state']>['members'];

package/dist/index.js

@@ -1,4 +1,4 @@
-import { a as e, b as t, C as i, c as o, d as n, e as m, F as r, f as g, L as l, h as M, M as u, i as c, j as L, k as h, l as d, m as p, n as v, o as C, p as A, q as k, s as F, t as b, u as P, v as f, w as x, x as y, y as B, z as S, B as q, D as z, E as D, G as E, H as V } from "./index-DFZrAiLB.js";
+import { a as e, b as t, C as i, c as o, d as n, e as m, F as r, f as g, L as l, h as M, M as u, i as c, j as L, k as h, l as d, m as p, n as v, o as C, p as A, q as k, s as F, t as b, u as P, v as f, w as x, x as y, y as B, z as S, B as q, D as z, E as D, G as E, H as V } from "./index-DJXjS2H9.js";
 export {
   e as ActionButton,
   t as Avatar,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linktr.ee/messaging-react",
-  "version": "3.11.0",
+  "version": "3.12.0-rc-1783766425",
   "description": "React messaging components built on messaging-core for web applications",
   "type": "module",
   "main": "dist/index.cjs",
@@ -50,7 +50,7 @@
   },
   "dependencies": {
     "@linktr.ee/component-library": "11.8.6",
-    "@linktr.ee/messaging-core": "^2.2.0",
+    "@linktr.ee/messaging-core": "2.3.0-rc-1783766425",
     "@phosphor-icons/react": "^2.1.10"
   },
   "devDependencies": {

package/src/components/ChannelList/index.test.tsx

@@ -125,6 +125,52 @@ describe('ChannelList', () => {
     })
   })
 
+  it('leaves live-reorder controls undefined by default so Stream keeps its default ordering', () => {
+    renderWithProviders(<ChannelList {...defaultProps} />)
+
+    expect(streamChannelListMock).toHaveBeenCalledOnce()
+    const streamProps = streamChannelListMock.mock.calls[0][0] as Record<
+      string,
+      unknown
+    >
+    expect(streamProps.lockChannelOrder).toBeUndefined()
+    expect(streamProps.onMessageNewHandler).toBeUndefined()
+    expect(streamProps.onMessageNew).toBeUndefined()
+    expect(streamProps.onChannelVisible).toBeUndefined()
+    expect(streamProps.onAddedToChannel).toBeUndefined()
+    expect(streamProps.onChannelUpdated).toBeUndefined()
+  })
+
+  it('forwards live-reorder controls to Stream ChannelList when provided', () => {
+    const onMessageNewHandler = vi.fn()
+    const onMessageNew = vi.fn()
+    const onChannelVisible = vi.fn()
+    const onAddedToChannel = vi.fn()
+    const onChannelUpdated = vi.fn()
+
+    renderWithProviders(
+      <ChannelList
+        {...defaultProps}
+        lockChannelOrder
+        onMessageNewHandler={onMessageNewHandler}
+        onMessageNew={onMessageNew}
+        onChannelVisible={onChannelVisible}
+        onAddedToChannel={onAddedToChannel}
+        onChannelUpdated={onChannelUpdated}
+      />
+    )
+
+    expect(streamChannelListMock).toHaveBeenCalledOnce()
+    expect(streamChannelListMock.mock.calls[0][0]).toMatchObject({
+      lockChannelOrder: true,
+      onMessageNewHandler,
+      onMessageNew,
+      onChannelVisible,
+      onAddedToChannel,
+      onChannelUpdated,
+    })
+  })
+
   it('wraps channelRenderFilterFn to restore pending messages and delegates to consumer filter', () => {
     const filterFn = vi.fn((channels: Channel[]) => channels)
 

package/src/components/ChannelList/index.tsx

@@ -32,6 +32,12 @@ export const ChannelList = React.memo<ChannelListProps>(
     channelPreview,
     renderMessagePreview,
     viewerLanguage,
+    lockChannelOrder,
+    onMessageNewHandler,
+    onMessageNew,
+    onChannelVisible,
+    onAddedToChannel,
+    onChannelUpdated,
   }) => {
     // Track renders
     const renderCountRef = React.useRef(0)
@@ -100,6 +106,12 @@ export const ChannelList = React.memo<ChannelListProps>(
                 allowNewMessagesFromUnfilteredChannels
               }
               channelRenderFilterFn={wrappedChannelRenderFilterFn}
+              lockChannelOrder={lockChannelOrder}
+              onMessageNewHandler={onMessageNewHandler}
+              onMessageNew={onMessageNew}
+              onChannelVisible={onChannelVisible}
+              onAddedToChannel={onAddedToChannel}
+              onChannelUpdated={onChannelUpdated}
               Paginator={Paginator}
               Preview={CustomChannelPreview}
               EmptyStateIndicator={customEmptyStateIndicator}

package/src/index.ts

@@ -53,6 +53,7 @@ export { resolveConversationParticipant } from './utils/resolveConversationParti
 export type {
   MessagingShellProps,
   ChannelListProps,
+  ChannelListReorderHandler,
   ChannelPreviewProps,
   ChannelViewProps,
   MessagingProviderProps,

package/src/types.ts

@@ -2,12 +2,13 @@ import type {
   MessagingUser,
   StreamChatServiceConfig,
 } from '@linktr.ee/messaging-core'
-import type { ComponentType } from 'react'
+import type { ComponentType, Dispatch, SetStateAction } from 'react'
 import type {
   Channel,
   ChannelFilters,
   ChannelMemberResponse,
   ChannelSort,
+  Event,
   LocalMessage,
   SendMessageAPIResponse,
   StreamChat,
@@ -122,8 +123,40 @@ export interface ChannelListProps {
    * Falls back to message.text when no matching translation exists.
    */
   viewerLanguage?: string
+  /**
+   * Lock the visible channel order so live events don't promote a channel to
+   * the top. Forwarded to Stream's `<ChannelList>`. Note `lockChannelOrder`
+   * alone doesn't cover `notification.message_new` or `channel.visible`; pair it
+   * with the event handlers below to fully neutralize promotion.
+   */
+  lockChannelOrder?: boolean
+  /**
+   * Live channel-list event handlers forwarded verbatim to Stream's
+   * `<ChannelList>`. Left undefined, Stream applies its default "move the
+   * changed channel to the top" behaviour.
+   *
+   * Hosts that order by a custom channel field (`last_conversation_at` for the
+   * inbox, `priority_score` for Spotlight) use these to neutralize promotion on
+   * new-message / visibility events and re-sort on `channel.updated` instead.
+   * Each receives Stream's `setChannels` dispatcher and the triggering event.
+   * See MES-1214 / MES-1219.
+   */
+  onMessageNewHandler?: ChannelListReorderHandler
+  onMessageNew?: ChannelListReorderHandler
+  onChannelVisible?: ChannelListReorderHandler
+  onAddedToChannel?: ChannelListReorderHandler
+  onChannelUpdated?: ChannelListReorderHandler
 }
 
+/**
+ * Signature of Stream's `<ChannelList>` live-event handlers: mutate the loaded
+ * channel array via `setChannels` in response to a websocket `event`.
+ */
+export type ChannelListReorderHandler = (
+  setChannels: Dispatch<SetStateAction<Channel[]>>,
+  event: Event
+) => void
+
 /**
  * ChannelView component props
  */