@linktr.ee/messaging-react 1.40.2 → 2.0.1-rc-1778656305

package/src/components/CustomMessage/index.tsx

@@ -30,6 +30,7 @@ import {
 } from 'stream-chat-react'
 
 import { useMessageVote } from '../../hooks/useMessageVote'
+import { getMessageDisplayText } from '../../utils/getMessageDisplayText'
 import { Avatar } from '../Avatar'
 import LockedAttachment from '../LockedAttachment'
 import { isLinkAttachment } from '../MediaMessage'
@@ -45,10 +46,12 @@ import { MessageVoteButtons } from './MessageVoteButtons'
 
 type CustomMessageUIComponentProps = MessageUIComponentProps & {
   chatbotVotingEnabled?: boolean
+  viewerLanguage?: string
 }
 
 type CustomMessageWithContextProps = MessageContextValue & {
   chatbotVotingEnabled?: boolean
+  viewerLanguage?: string
 }
 
 const CustomMessageWithContext = (props: CustomMessageWithContextProps) => {
@@ -68,11 +71,13 @@ const CustomMessageWithContext = (props: CustomMessageWithContextProps) => {
     message,
     renderText,
     threadList,
+    viewerLanguage,
   } = props
 
   const { client } = useChatContext('CustomMessage')
   const { channel } = useChannelStateContext('CustomMessage')
-  const { isUnlocking, onUnlockClick, onFetchSource, onDownloadClick } = useCustomMessage('LockedAttachment')
+  const { isUnlocking, onUnlockClick, onFetchSource, onDownloadClick } =
+    useCustomMessage('LockedAttachment')
   const [isBounceDialogOpen, setIsBounceDialogOpen] = useState(false)
   const reminder = useMessageReminder(message.id)
   const { selected: voteState, voteUp, voteDown } = useMessageVote(message)
@@ -107,6 +112,12 @@ const CustomMessageWithContext = (props: CustomMessageWithContextProps) => {
     const filtered = raw.filter((a) => !('type' in a) || !isLinkAttachment(a))
     return filtered.length === raw.length ? raw : filtered
   }, [message])
+  const displayMessage = useMemo(() => {
+    const displayText = getMessageDisplayText({ message, viewerLanguage })
+    return displayText === message.text
+      ? message
+      : { ...message, text: displayText }
+  }, [message, viewerLanguage])
 
   if (isDateSeparatorMessage(message)) {
     return null
@@ -216,21 +227,20 @@ const CustomMessageWithContext = (props: CustomMessageWithContextProps) => {
           {isAttachment ? (
             <div className="str-chat__message-bubble-wrapper">
               {isMine ? (
-                <LockedAttachment.Creator
+                <LockedAttachment.Sent
                   title={message.metadata?.attachment_title}
                   mimeType={message.metadata?.attachment_mime_type}
                   thumbnailUrl={message.metadata?.attachment_thumbnail}
                   amountText={message.metadata?.amount_text}
                   detail={message.metadata?.attachment_detail}
                   paymentStatus={message.metadata?.payment_status}
-                  isUnlocking={isUnlocking(message.id)}
                   onPreviewClick={() => onUnlockClick?.(message, channel)}
                   onFetchSource={async () =>
                     await onFetchSource?.(message, channel)
                   }
                 />
               ) : (
-                <LockedAttachment.Visitor
+                <LockedAttachment.Received
                   title={message.metadata?.attachment_title}
                   mimeType={message.metadata?.attachment_mime_type}
                   thumbnailUrl={message.metadata?.attachment_thumbnail}
@@ -247,7 +257,10 @@ const CustomMessageWithContext = (props: CustomMessageWithContextProps) => {
               )}
               {message.text && (
                 <div className="str-chat__message-bubble">
-                  <MessageText message={message} renderText={renderText} />
+                  <MessageText
+                    message={displayMessage}
+                    renderText={renderText}
+                  />
                 </div>
               )}
             </div>
@@ -273,11 +286,14 @@ const CustomMessageWithContext = (props: CustomMessageWithContextProps) => {
                 ) : null}
                 {isAIGenerated ? (
                   <StreamedMessageText
-                    message={message}
+                    message={displayMessage}
                     renderText={renderText}
                   />
                 ) : (
-                  <MessageText message={message} renderText={renderText} />
+                  <MessageText
+                    message={displayMessage}
+                    renderText={renderText}
+                  />
                 )}
                 <MessageErrorIcon />
               </div>
@@ -317,6 +333,7 @@ const MemoizedCustomMessage = React.memo(
   CustomMessageWithContext,
   (prev, next) => {
     if (prev.chatbotVotingEnabled !== next.chatbotVotingEnabled) return false
+    if (prev.viewerLanguage !== next.viewerLanguage) return false
     return areMessageUIPropsEqual(prev, next)
   }
 ) as typeof CustomMessageWithContext

package/src/components/CustomTypingIndicator/CustomTypingIndicator.stories.tsx

@@ -2,16 +2,21 @@ import type { Meta, StoryFn } from '@storybook/react'
 import React from 'react'
 import type { Event } from 'stream-chat'
 import {
+  AIStates,
   ChannelStateProvider,
   ChatProvider,
   TypingProvider,
 } from 'stream-chat-react'
 
+import { DmAgentEnabledContext } from './DmAgentContext'
+
 import CustomTypingIndicator from '.'
 
 type StoryProps = {
   typingEventsEnabled?: boolean
   typing?: Record<string, Event>
+  aiState?: string
+  dmAgentEnabled?: boolean
 }
 
 const currentUser = {
@@ -33,10 +38,38 @@ const defaultTyping: Record<string, Event> = {
   } as Event,
 }
 
+type ListenerMap = Record<string, (event: { ai_state: string; cid: string }) => void>
+
+const createMockChannel = ({ aiState }: { aiState?: string }) => {
+  const listeners: ListenerMap = {}
+  const channel = {
+    cid: 'messaging:test',
+    state: {
+      members: {
+        [currentUser.id]: { user: currentUser },
+        [typingUser.id]: { user: typingUser },
+      },
+    },
+    on(eventType: string, handler: ListenerMap[string]) {
+      listeners[eventType] = handler
+      // Fire the requested AI state synchronously so the hook picks it up.
+      if (eventType === 'ai_indicator.update' && aiState) {
+        handler({ ai_state: aiState, cid: 'messaging:test' })
+      }
+      return { unsubscribe: () => {} }
+    },
+  }
+  return channel
+}
+
 const StoryWrapper: React.FC<StoryProps> = ({
   typingEventsEnabled = true,
-  typing = defaultTyping,
+  typing = {},
+  aiState,
+  dmAgentEnabled = true,
 }) => {
+  const channel = createMockChannel({ aiState })
+
   const chatContextValue = {
     client: {
       user: currentUser,
@@ -57,18 +90,7 @@ const StoryWrapper: React.FC<StoryProps> = ({
   }
 
   const channelStateValue = {
-    channel: {
-      state: {
-        members: {
-          [currentUser.id]: {
-            user: currentUser,
-          },
-          [typingUser.id]: {
-            user: typingUser,
-          },
-        },
-      },
-    },
+    channel,
     channelCapabilities: {},
     channelConfig: {
       typing_events: typingEventsEnabled,
@@ -85,9 +107,11 @@ const StoryWrapper: React.FC<StoryProps> = ({
     <ChatProvider value={chatContextValue as never}>
       <ChannelStateProvider value={channelStateValue as never}>
         <TypingProvider value={{ typing }}>
-          <div className="relative h-20 w-[200px] bg-[#f4f4f4] p-3">
-            <CustomTypingIndicator />
-          </div>
+          <DmAgentEnabledContext.Provider value={dmAgentEnabled}>
+            <div className="relative h-20 w-[200px] bg-[#f4f4f4] p-3">
+              <CustomTypingIndicator />
+            </div>
+          </DmAgentEnabledContext.Provider>
         </TypingProvider>
       </ChannelStateProvider>
     </ChatProvider>
@@ -104,7 +128,9 @@ const meta: Meta<StoryProps> = {
 export default meta
 
 export const Default: StoryFn<StoryProps> = (args) => <StoryWrapper {...args} />
-Default.args = {}
+Default.args = {
+  typing: defaultTyping,
+}
 
 export const HiddenWhenNoTyping: StoryFn<StoryProps> = (args) => (
   <StoryWrapper {...args} />
@@ -112,3 +138,17 @@ export const HiddenWhenNoTyping: StoryFn<StoryProps> = (args) => (
 HiddenWhenNoTyping.args = {
   typing: {},
 }
+
+export const AiAgentThinking: StoryFn<StoryProps> = (args) => (
+  <StoryWrapper {...args} />
+)
+AiAgentThinking.args = {
+  aiState: AIStates.Thinking,
+}
+
+export const AiAgentGenerating: StoryFn<StoryProps> = (args) => (
+  <StoryWrapper {...args} />
+)
+AiAgentGenerating.args = {
+  aiState: AIStates.Generating,
+}

package/src/components/CustomTypingIndicator/CustomTypingIndicator.test.tsx

@@ -0,0 +1,187 @@
+import React from 'react'
+import type { Event } from 'stream-chat'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+
+import { renderWithProviders, screen } from '../../test/utils'
+
+import { DmAgentEnabledContext } from './DmAgentContext'
+
+const visitor = { id: 'visitor-1', name: 'Visitor' }
+const agent = { id: 'creator-1', name: 'Creator', image: 'agent.png' }
+
+let typingContext: { typing: Record<string, Event> } = { typing: {} }
+let aiStateContext: { aiState: string } = { aiState: 'AI_STATE_IDLE' }
+let channelStateContext: {
+  channel: {
+    state: { members: Record<string, { user: typeof visitor | typeof agent }> }
+  }
+  channelConfig: { typing_events: boolean }
+  thread: undefined
+} = {
+  channel: {
+    state: {
+      members: {
+        [visitor.id]: { user: visitor },
+        [agent.id]: { user: agent },
+      },
+    },
+  },
+  channelConfig: { typing_events: true },
+  thread: undefined,
+}
+
+vi.mock('stream-chat-react', () => ({
+  AIStates: {
+    Error: 'AI_STATE_ERROR',
+    ExternalSources: 'AI_STATE_EXTERNAL_SOURCES',
+    Generating: 'AI_STATE_GENERATING',
+    Idle: 'AI_STATE_IDLE',
+    Stop: 'AI_STATE_STOP',
+    Thinking: 'AI_STATE_THINKING',
+  },
+  useAIState: () => aiStateContext,
+  useChannelStateContext: () => channelStateContext,
+  useChatContext: () => ({ client: { user: visitor } }),
+  useTypingContext: () => typingContext,
+}))
+
+vi.mock('../Avatar', () => ({
+  Avatar: ({ name, id }: { name: string; id: string }) => (
+    <div data-testid="avatar" data-id={id}>
+      {name}
+    </div>
+  ),
+}))
+
+const importIndicator = async () => (await import('.')).default
+
+const renderIndicator = async (dmAgentEnabled = true) => {
+  const CustomTypingIndicator = await importIndicator()
+  return renderWithProviders(
+    <DmAgentEnabledContext.Provider value={dmAgentEnabled}>
+      <CustomTypingIndicator />
+    </DmAgentEnabledContext.Provider>
+  )
+}
+
+describe('CustomTypingIndicator', () => {
+  beforeEach(() => {
+    typingContext = { typing: {} }
+    aiStateContext = { aiState: 'AI_STATE_IDLE' }
+    channelStateContext = {
+      channel: {
+        state: {
+          members: {
+            [visitor.id]: { user: visitor },
+            [agent.id]: { user: agent },
+          },
+        },
+      },
+      channelConfig: { typing_events: true },
+      thread: undefined,
+    }
+  })
+
+  it('renders nothing when idle and no typers', async () => {
+    await renderIndicator()
+    expect(screen.queryByTestId('typing-indicator')).toBeNull()
+    expect(screen.queryByTestId('typing-indicator-ai')).toBeNull()
+  })
+
+  it('renders the human typing bubble when someone else is typing', async () => {
+    typingContext = {
+      typing: {
+        [agent.id]: {
+          type: 'typing.start',
+          user: agent,
+          parent_id: undefined,
+        } as Event,
+      },
+    }
+    await renderIndicator()
+    expect(screen.getByTestId('typing-indicator')).toBeInTheDocument()
+    expect(screen.getByTestId('avatar')).toHaveAttribute('data-id', agent.id)
+  })
+
+  it('hides the human typing bubble when typing_events is disabled', async () => {
+    channelStateContext.channelConfig.typing_events = false
+    typingContext = {
+      typing: {
+        [agent.id]: {
+          type: 'typing.start',
+          user: agent,
+          parent_id: undefined,
+        } as Event,
+      },
+    }
+    await renderIndicator()
+    expect(screen.queryByTestId('typing-indicator')).toBeNull()
+  })
+
+  it('renders the AI bubble when the agent is thinking', async () => {
+    aiStateContext = { aiState: 'AI_STATE_THINKING' }
+    await renderIndicator()
+    expect(screen.getByTestId('typing-indicator-ai')).toBeInTheDocument()
+    expect(screen.getByTestId('avatar')).toHaveAttribute('data-id', agent.id)
+  })
+
+  it('renders the AI bubble when the agent is generating', async () => {
+    aiStateContext = { aiState: 'AI_STATE_GENERATING' }
+    await renderIndicator()
+    expect(screen.getByTestId('typing-indicator-ai')).toBeInTheDocument()
+  })
+
+  it('renders the AI bubble when the agent is checking external sources', async () => {
+    aiStateContext = { aiState: 'AI_STATE_EXTERNAL_SOURCES' }
+    await renderIndicator()
+    expect(screen.getByTestId('typing-indicator-ai')).toBeInTheDocument()
+  })
+
+  it('does not render the AI bubble inside a thread list', async () => {
+    aiStateContext = { aiState: 'AI_STATE_GENERATING' }
+    const CustomTypingIndicator = await importIndicator()
+    renderWithProviders(
+      <DmAgentEnabledContext.Provider value={true}>
+        <CustomTypingIndicator threadList />
+      </DmAgentEnabledContext.Provider>
+    )
+    expect(screen.queryByTestId('typing-indicator-ai')).toBeNull()
+  })
+
+  it('renders the AI bubble even when typing_events is disabled', async () => {
+    channelStateContext.channelConfig.typing_events = false
+    aiStateContext = { aiState: 'AI_STATE_THINKING' }
+    await renderIndicator()
+    expect(screen.getByTestId('typing-indicator-ai')).toBeInTheDocument()
+  })
+
+  it('falls back to a default avatar id when no other channel member exists', async () => {
+    channelStateContext.channel.state.members = {
+      [visitor.id]: { user: visitor },
+    }
+    aiStateContext = { aiState: 'AI_STATE_GENERATING' }
+    await renderIndicator()
+    expect(screen.getByTestId('typing-indicator-ai')).toBeInTheDocument()
+    expect(screen.getByTestId('avatar')).toHaveAttribute('data-id', 'ai-agent')
+  })
+
+  it('does not render the AI bubble when dmAgentEnabled is false', async () => {
+    aiStateContext = { aiState: 'AI_STATE_GENERATING' }
+    await renderIndicator(false)
+    expect(screen.queryByTestId('typing-indicator-ai')).toBeNull()
+  })
+
+  it('still renders the human bubble when dmAgentEnabled is false', async () => {
+    typingContext = {
+      typing: {
+        [agent.id]: {
+          type: 'typing.start',
+          user: agent,
+          parent_id: undefined,
+        } as Event,
+      },
+    }
+    await renderIndicator(false)
+    expect(screen.getByTestId('typing-indicator')).toBeInTheDocument()
+  })
+})

package/src/components/CustomTypingIndicator/DmAgentContext.ts

@@ -0,0 +1,3 @@
+import { createContext } from 'react'
+
+export const DmAgentEnabledContext = createContext<boolean>(false)

package/src/components/CustomTypingIndicator/index.tsx

@@ -1,6 +1,8 @@
-import React from 'react'
-import type { Event } from 'stream-chat'
+import React, { useContext } from 'react'
+import type { Event, UserResponse } from 'stream-chat'
 import {
+  AIStates,
+  useAIState,
   useChannelStateContext,
   useChatContext,
   useTypingContext,
@@ -8,6 +10,8 @@ import {
 
 import { Avatar } from '../Avatar'
 
+import { DmAgentEnabledContext } from './DmAgentContext'
+
 interface CustomTypingIndicatorProps {
   threadList?: boolean
 }
@@ -25,10 +29,38 @@ const Circle = ({ cx, index }: { cx: string; index: number }) => (
   </circle>
 )
 
+const AI_ACTIVE_STATES = new Set<string>([
+  AIStates.Thinking,
+  AIStates.Generating,
+  AIStates.ExternalSources,
+])
+
 const CustomTypingIndicator = ({ threadList }: CustomTypingIndicatorProps) => {
   const { channel, channelConfig, thread } = useChannelStateContext()
   const { client } = useChatContext()
   const { typing = {} } = useTypingContext()
+  const { aiState } = useAIState(channel)
+  const dmAgentEnabled = useContext(DmAgentEnabledContext)
+
+  // Show the AI indicator whenever the consumer agent is producing a reply.
+  // This event stream is independent of `typing.start`/`typing.stop`, so it is
+  // intentionally NOT gated by `channelConfig.typing_events`. Gate strictly on
+  // `dmAgentEnabled` so stale or off-surface ai_indicator events never surface
+  // the bubble on channels where the agent is not active.
+  const isAiActive =
+    !threadList && dmAgentEnabled && AI_ACTIVE_STATES.has(aiState)
+
+  if (isAiActive) {
+    const agentUser = findOtherChannelUser(channel, client.user?.id)
+    return (
+      <TypingBubble
+        avatarId={agentUser?.id ?? 'ai-agent'}
+        avatarName={agentUser?.name ?? agentUser?.id ?? 'Agent'}
+        avatarImage={agentUser?.image}
+        testId="typing-indicator-ai"
+      />
+    )
+  }
 
   if (channelConfig?.typing_events === false) {
     return null
@@ -59,43 +91,75 @@ const CustomTypingIndicator = ({ threadList }: CustomTypingIndicatorProps) => {
       ? channel.state.members[typingUser.id].user
       : undefined
 
-  const avatarId = typingUser?.id ?? memberUser?.id ?? 'typing-user'
-  const avatarName =
-    typingUser?.name ?? memberUser?.name ?? typingUser?.id ?? 'Typing user'
-  const avatarImage = typingUser?.image ?? memberUser?.image
-
   return (
-    <div
-      className="str-chat__typing-indicator !items-end !bg-transparent"
-      data-testid="typing-indicator"
-      style={{ insetInlineStart: 0, insetInlineEnd: 'auto' }}
-    >
-      <div className="shrink-0" aria-hidden="true">
-        <Avatar
-          id={avatarId}
-          name={avatarName}
-          image={avatarImage}
-          size={24}
-          shape="circle"
-        />
-      </div>
-
-      <div className="px-4 py-3 rounded-lg bg-[#E9EAED] h-12 flex flex-col justify-end">
-        <svg
-          aria-hidden="true"
-          className="block overflow-visible mb-[0.2rem]"
-          viewBox="0 0 32 8"
-          width="32"
-          height="8"
-          overflow="visible"
-        >
-          <Circle cx="4" index={0} />
-          <Circle cx="16" index={1} />
-          <Circle cx="28" index={2} />
-        </svg>
-      </div>
-    </div>
+    <TypingBubble
+      avatarId={typingUser?.id ?? memberUser?.id ?? 'typing-user'}
+      avatarName={
+        typingUser?.name ?? memberUser?.name ?? typingUser?.id ?? 'Typing user'
+      }
+      avatarImage={typingUser?.image ?? memberUser?.image}
+      testId="typing-indicator"
+    />
   )
 }
 
+const TypingBubble = ({
+  avatarId,
+  avatarName,
+  avatarImage,
+  testId,
+}: {
+  avatarId: string
+  avatarName: string
+  avatarImage?: string | null
+  testId: string
+}) => (
+  <div
+    className="str-chat__typing-indicator !items-end !bg-transparent"
+    data-testid={testId}
+    style={{ insetInlineStart: 0, insetInlineEnd: 'auto' }}
+  >
+    <div className="shrink-0" aria-hidden="true">
+      <Avatar
+        id={avatarId}
+        name={avatarName}
+        image={avatarImage ?? undefined}
+        size={24}
+        shape="circle"
+      />
+    </div>
+
+    <div className="px-4 py-3 rounded-lg bg-[#E9EAED] h-12 flex flex-col justify-end">
+      <svg
+        aria-hidden="true"
+        className="block overflow-visible mb-[0.2rem]"
+        viewBox="0 0 32 8"
+        width="32"
+        height="8"
+        overflow="visible"
+      >
+        <Circle cx="4" index={0} />
+        <Circle cx="16" index={1} />
+        <Circle cx="28" index={2} />
+      </svg>
+    </div>
+  </div>
+)
+
+type ChannelLike = ReturnType<typeof useChannelStateContext>['channel']
+
+function findOtherChannelUser(
+  channel: ChannelLike,
+  selfId: string | undefined
+): UserResponse | undefined {
+  const members = channel?.state?.members ?? {}
+  for (const member of Object.values(members)) {
+    const memberUser = member?.user
+    if (memberUser && memberUser.id !== selfId) {
+      return memberUser
+    }
+  }
+  return undefined
+}
+
 export default CustomTypingIndicator