@linktr.ee/messaging-react 4.0.0-rc-1786390369 → 4.0.0

package/dist/index.d.ts

@@ -393,10 +393,11 @@ export declare interface ChannelViewProps {
      */
     onOutboundClick?: OutboundClickHandler;
     /**
-     * Resolves an outbound record id to the current automation id and name. The
-     * host must provide a new resolver reference when a returned outbound
-     * changes so ChannelView re-renders and publishes the new value to memoized
-     * rows. Missing records stay unresolved and render no label.
+     * Resolves `metadata.outbound_id` (an outbound record id) to the current
+     * automation id and name. The host must provide a new resolver reference
+     * when a returned outbound changes so ChannelView re-renders and publishes
+     * the new value to memoized rows. Missing records stay unresolved and render
+     * no label.
      */
     resolveOutbound?: OutboundResolver;
     /**
@@ -1403,8 +1404,8 @@ export declare interface MessageMetadata {
      */
     sent_from?: 'stack_detail';
     /**
-     * Opaque Outbound Record id on automation messages. Hosts resolve this
-     * server-side to the current automation id and name.
+     * Opaque outbound record id on automation messages. The Stream wire field is
+     * `outbound_id`; resolver APIs name this value `outboundRecordId` explicitly.
      */
     outbound_id?: string;
 }
@@ -1549,7 +1550,7 @@ export declare function optimizeMessagingAttachmentUrl(url: string | undefined |
 
 export declare type OutboundClickHandler = (outbound: ResolvedOutbound) => void;
 
-export declare type OutboundResolver = (outboundId: string) => ResolvedOutbound | undefined;
+export declare type OutboundResolver = (outboundRecordId: string) => ResolvedOutbound | undefined;
 
 /**
  * Generic participant interface for different host environments
@@ -1636,6 +1637,7 @@ export declare interface ReceivedBubbleProps extends MessageBubbleBaseProps {
 export declare function resolveConversationParticipant(members: ChannelMembers | undefined, currentUserId: string | undefined, channelType: string | undefined): ChannelMember | undefined;
 
 export declare type ResolvedOutbound = {
+    /** Automation id referenced by the outbound record. */
     id: string;
     name?: string;
 };

package/dist/index.js

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

package/dist/testing.d.ts

@@ -57,8 +57,8 @@ export declare interface MessageMetadata {
      */
     sent_from?: 'stack_detail';
     /**
-     * Opaque Outbound Record id on automation messages. Hosts resolve this
-     * server-side to the current automation id and name.
+     * Opaque outbound record id on automation messages. The Stream wire field is
+     * `outbound_id`; resolver APIs name this value `outboundRecordId` explicitly.
      */
     outbound_id?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linktr.ee/messaging-react",
-  "version": "4.0.0-rc-1786390369",
+  "version": "4.0.0",
   "description": "React messaging components built on messaging-core for web applications",
   "type": "module",
   "main": "dist/index.cjs",
@@ -50,7 +50,7 @@
     "chromatic:local": "yarn storybook:build && chromatic"
   },
   "dependencies": {
-    "@linktr.ee/messaging-core": "2.4.0-rc-1786390369",
+    "@linktr.ee/messaging-core": "^2.4.0",
     "@linktr.ee/messaging-taxonomy": "^0.9.0",
     "@phosphor-icons/react": "^2.1.10"
   },

package/src/components/ChannelView.outbound-resolution.integration.test.tsx

@@ -54,7 +54,7 @@ const createChannel = () => {
 }
 
 describe('ChannelView outbound resolution', () => {
-  it('updates an existing Stream message row when its outbound lookup resolves', async () => {
+  it('updates an existing Stream message row when its outbound record lookup resolves', async () => {
     const { channel, client } = createChannel()
     const firstResolver = () => undefined
     const secondResolver = () => ({

package/src/components/ChannelView.tsx

@@ -19,7 +19,7 @@ import { CustomMessage } from './CustomMessage'
 import { CustomMessageActions } from './CustomMessage/CustomMessageActions'
 import {
   OutboundContext,
-  useOutboundsById,
+  useOutboundsByRecordId,
 } from './CustomMessage/OutboundContext'
 import { CustomMessageInput } from './CustomMessageInput'
 import { CustomSystemMessage } from './CustomSystemMessage'
@@ -105,7 +105,7 @@ const ChannelViewInner: React.FC<{
     : undefined
   // Resolve outside memoized Stream rows so current automation details publish
   // without remounting the rows.
-  const outboundsById = useOutboundsById(messages, resolveOutbound)
+  const outboundsByRecordId = useOutboundsByRecordId(messages, resolveOutbound)
 
   const hasVisibleMessages = channel.state.messages.some(
     (message) => message.type !== 'deleted'
@@ -159,7 +159,7 @@ const ChannelViewInner: React.FC<{
   )
 
   return (
-    <OutboundContext.Provider value={outboundsById}>
+    <OutboundContext.Provider value={outboundsByRecordId}>
       <WithComponents
         overrides={{
           Message: MessageOverride,

package/src/components/CustomMessage/CustomMessage.stories.tsx

@@ -27,7 +27,7 @@ import type { OutboundResolver } from '../../types'
 import CustomTypingIndicator from '../CustomTypingIndicator'
 
 import { CustomMessageActions } from './CustomMessageActions'
-import { OutboundContext, buildOutboundsById } from './OutboundContext'
+import { OutboundContext, buildOutboundsByRecordId } from './OutboundContext'
 
 import { CustomMessage } from './index'
 
@@ -167,8 +167,8 @@ const TemplateInner: React.FC<{
     return () => clearTimeout(timer)
   }, [channel, client, typingUser])
 
-  const outboundsById = React.useMemo(
-    () => buildOutboundsById(messages, resolveOutbound),
+  const outboundsByRecordId = React.useMemo(
+    () => buildOutboundsByRecordId(messages, resolveOutbound),
     [messages, resolveOutbound]
   )
 
@@ -183,7 +183,7 @@ const TemplateInner: React.FC<{
   }
 
   return (
-    <OutboundContext.Provider value={outboundsById}>
+    <OutboundContext.Provider value={outboundsByRecordId}>
       <Chat client={client}>
         <div className="h-screen w-full bg-white">
           <Channel

package/src/components/CustomMessage/OutboundContext.test.ts

@@ -3,12 +3,15 @@ import { describe, expect, it, vi } from 'vitest'
 import { renderHook } from '../../test/utils'
 import type { OutboundResolver } from '../../types'
 
-import { buildOutboundsById, useOutboundsById } from './OutboundContext'
+import {
+  buildOutboundsByRecordId,
+  useOutboundsByRecordId,
+} from './OutboundContext'
 
-describe('buildOutboundsById', () => {
+describe('buildOutboundsByRecordId', () => {
   it('returns undefined when no resolver is provided', () => {
     expect(
-      buildOutboundsById(
+      buildOutboundsByRecordId(
         [{ metadata: { outbound_id: 'outbound-1' } }],
         undefined
       )
@@ -18,19 +21,19 @@ describe('buildOutboundsById', () => {
   it('returns undefined without invoking the resolver when there are no messages', () => {
     const resolveOutbound = vi.fn()
 
-    expect(buildOutboundsById(undefined, resolveOutbound)).toBeUndefined()
-    expect(buildOutboundsById([], resolveOutbound)).toBeUndefined()
+    expect(buildOutboundsByRecordId(undefined, resolveOutbound)).toBeUndefined()
+    expect(buildOutboundsByRecordId([], resolveOutbound)).toBeUndefined()
     expect(resolveOutbound).not.toHaveBeenCalled()
   })
 
-  it('resolves each unique outbound id once', () => {
-    const resolveOutbound = vi.fn((outboundId: string) => ({
-      id: `automation-for-${outboundId}`,
-      name: `name-for-${outboundId}`,
+  it('resolves each unique outbound record id once', () => {
+    const resolveOutbound = vi.fn((outboundRecordId: string) => ({
+      id: `automation-for-${outboundRecordId}`,
+      name: `name-for-${outboundRecordId}`,
     }))
 
     expect(
-      buildOutboundsById(
+      buildOutboundsByRecordId(
         [
           { metadata: { outbound_id: 'outbound-1' } },
           { metadata: { outbound_id: 'outbound-1' } },
@@ -54,7 +57,7 @@ describe('buildOutboundsById', () => {
 
   it('omits outbound records the resolver cannot resolve', () => {
     expect(
-      buildOutboundsById(
+      buildOutboundsByRecordId(
         [{ metadata: { outbound_id: 'outbound-1' } }],
         () => undefined
       )
@@ -62,17 +65,17 @@ describe('buildOutboundsById', () => {
   })
 })
 
-describe('useOutboundsById', () => {
+describe('useOutboundsByRecordId', () => {
   const messages = [{ metadata: { outbound_id: 'outbound-1' } }]
 
   const renderWithResolver = (resolver: OutboundResolver) =>
     renderHook(
       ({ resolveOutbound }: { resolveOutbound: OutboundResolver }) =>
-        useOutboundsById(messages, resolveOutbound),
+        useOutboundsByRecordId(messages, resolveOutbound),
       { initialProps: { resolveOutbound: resolver } }
     )
 
-  it('publishes a renamed automation under the same outbound id', () => {
+  it('publishes a renamed automation under the same outbound record id', () => {
     const { result, rerender } = renderWithResolver(() => ({
       id: 'automation-1',
       name: 'July 9th Class absentee',

package/src/components/CustomMessage/OutboundContext.ts

@@ -2,18 +2,18 @@ import { createContext, useState } from 'react'
 
 import type { OutboundResolver, ResolvedOutbound } from '../../types'
 
-/** Current outbound sources keyed by the record id stored on each message. */
-export type OutboundsById = Readonly<Record<string, ResolvedOutbound>>
+/** Current outbound sources keyed by the outbound record id stored on each message. */
+export type OutboundsByRecordId = Readonly<Record<string, ResolvedOutbound>>
 
-export const OutboundContext = createContext<OutboundsById | undefined>(
+export const OutboundContext = createContext<OutboundsByRecordId | undefined>(
   undefined
 )
 
-const outboundIdFromMessage = (message: {
+const outboundRecordIdFromMessage = (message: {
   metadata?: { outbound_id?: unknown }
 }): string | undefined => {
-  const outboundId = message.metadata?.outbound_id
-  return typeof outboundId === 'string' ? outboundId : undefined
+  const outboundRecordId = message.metadata?.outbound_id
+  return typeof outboundRecordId === 'string' ? outboundRecordId : undefined
 }
 
 /**
@@ -22,10 +22,10 @@ const outboundIdFromMessage = (message: {
  * Built outside memoized Stream rows so a new resolver reference can publish
  * current automation details without remounting the Stream message rows.
  */
-export const buildOutboundsById = (
+export const buildOutboundsByRecordId = (
   messages: readonly { metadata?: { outbound_id?: unknown } }[] | undefined,
   resolveOutbound: OutboundResolver | undefined
-): OutboundsById | undefined => {
+): OutboundsByRecordId | undefined => {
   if (!resolveOutbound || !messages?.length) {
     return undefined
   }
@@ -34,13 +34,13 @@ export const buildOutboundsById = (
   let outbounds: Record<string, ResolvedOutbound> | undefined
 
   for (const message of messages) {
-    const outboundId = outboundIdFromMessage(message)
-    if (!outboundId || seen.has(outboundId)) {
+    const outboundRecordId = outboundRecordIdFromMessage(message)
+    if (!outboundRecordId || seen.has(outboundRecordId)) {
       continue
     }
-    seen.add(outboundId)
+    seen.add(outboundRecordId)
 
-    const resolved = resolveOutbound(outboundId)
+    const resolved = resolveOutbound(outboundRecordId)
     if (!resolved) {
       continue
     }
@@ -48,7 +48,7 @@ export const buildOutboundsById = (
     outbounds ??= {}
     // Snapshot resolver-owned values so a host that mutates and reuses its
     // cached object cannot also mutate the previously published context map.
-    outbounds[outboundId] = {
+    outbounds[outboundRecordId] = {
       id: resolved.id,
       ...(resolved.name !== undefined ? { name: resolved.name } : {}),
     }
@@ -58,8 +58,8 @@ export const buildOutboundsById = (
 }
 
 const areOutboundsEqual = (
-  previous: OutboundsById | undefined,
-  next: OutboundsById | undefined
+  previous: OutboundsByRecordId | undefined,
+  next: OutboundsByRecordId | undefined
 ): boolean => {
   if (previous === next) {
     return true
@@ -75,9 +75,9 @@ const areOutboundsEqual = (
   }
 
   return previousIds.every(
-    (outboundId) =>
-      previous[outboundId].id === next[outboundId]?.id &&
-      previous[outboundId].name === next[outboundId]?.name
+    (outboundRecordId) =>
+      previous[outboundRecordId].id === next[outboundRecordId]?.id &&
+      previous[outboundRecordId].name === next[outboundRecordId]?.name
   )
 }
 
@@ -86,13 +86,13 @@ const areOutboundsEqual = (
  * the resolved id/name pairs actually change — so context consumers update for
  * late-arriving outbounds without thrashing on unrelated renders.
  */
-export const useOutboundsById = (
+export const useOutboundsByRecordId = (
   messages: readonly { metadata?: { outbound_id?: unknown } }[] | undefined,
   resolveOutbound: OutboundResolver | undefined
-): OutboundsById | undefined => {
-  const outbounds = buildOutboundsById(messages, resolveOutbound)
+): OutboundsByRecordId | undefined => {
+  const outbounds = buildOutboundsByRecordId(messages, resolveOutbound)
   const [publishedOutbounds, setPublishedOutbounds] = useState<
-    OutboundsById | undefined
+    OutboundsByRecordId | undefined
   >(outbounds)
 
   if (!areOutboundsEqual(publishedOutbounds, outbounds)) {

package/src/components/CustomMessage/SentMessageDeliveryStatus.tsx

@@ -187,11 +187,11 @@ export const SentMessageDeliveryStatus = ({
     return null
   }
 
-  const outboundId = message.metadata?.outbound_id
+  const outboundRecordId = message.metadata?.outbound_id
   const outboundStatus =
     message.status !== 'sending' &&
     message.status !== 'failed' &&
-    outboundId &&
+    outboundRecordId &&
     resolvedOutbound ? (
       <OutboundStatus
         outbound={resolvedOutbound}

package/src/components/CustomMessage/index.tsx

@@ -468,10 +468,12 @@ const MemoizedCustomMessage = React.memo(
 
 export const CustomMessage = (props: CustomMessageUIComponentProps) => {
   const messageContext = useMessageContext('CustomMessage')
-  const outboundsById = useContext(OutboundContext)
-  const outboundId = messageContext.message.metadata?.outbound_id
+  const outboundsByRecordId = useContext(OutboundContext)
+  const outboundRecordId = messageContext.message.metadata?.outbound_id
   const resolvedOutbound =
-    typeof outboundId === 'string' ? outboundsById?.[outboundId] : undefined
+    typeof outboundRecordId === 'string'
+      ? outboundsByRecordId?.[outboundRecordId]
+      : undefined
 
   return (
     <MemoizedCustomMessage

package/src/stream-custom-data.ts

@@ -67,8 +67,8 @@ export interface MessageMetadata {
    */
   sent_from?: 'stack_detail'
   /**
-   * Opaque Outbound Record id on automation messages. Hosts resolve this
-   * server-side to the current automation id and name.
+   * Opaque outbound record id on automation messages. The Stream wire field is
+   * `outbound_id`; resolver APIs name this value `outboundRecordId` explicitly.
    */
   outbound_id?: string
 }

package/src/types.ts

@@ -37,6 +37,7 @@ export type MessageLinkClickHandler = (
 ) => void
 
 export type ResolvedOutbound = {
+  /** Automation id referenced by the outbound record. */
   id: string
   name?: string
 }
@@ -44,7 +45,7 @@ export type ResolvedOutbound = {
 export type OutboundClickHandler = (outbound: ResolvedOutbound) => void
 
 export type OutboundResolver = (
-  outboundId: string
+  outboundRecordId: string
 ) => ResolvedOutbound | undefined
 
 export type ChannelPreviewProps = ChannelPreviewUIComponentProps & {
@@ -373,10 +374,11 @@ export interface ChannelViewProps {
   onOutboundClick?: OutboundClickHandler
 
   /**
-   * Resolves an outbound record id to the current automation id and name. The
-   * host must provide a new resolver reference when a returned outbound
-   * changes so ChannelView re-renders and publishes the new value to memoized
-   * rows. Missing records stay unresolved and render no label.
+   * Resolves `metadata.outbound_id` (an outbound record id) to the current
+   * automation id and name. The host must provide a new resolver reference
+   * when a returned outbound changes so ChannelView re-renders and publishes
+   * the new value to memoized rows. Missing records stay unresolved and render
+   * no label.
    */
   resolveOutbound?: OutboundResolver