@natoe/colab 0.1.26 → 0.1.28

package/dist/index.d.mts

@@ -118,10 +118,28 @@ interface PatientData {
     labName?: string;
     bodyParts?: string[];
 }
+/**
+ * Which thread on a case this is.
+ *
+ *  - `case`             — the shared discussion: lab, radiologist, physician, admin
+ *  - `help_lab`         — imaging center <-> Natoe support, private to that side
+ *  - `help_radiologist` — assigned radiologist <-> Natoe support, private to that side
+ *
+ * The two help kinds are mutually invisible. That isolation is enforced by the
+ * backend's participant seeding, never by anything in this package — treat this
+ * as a label for rendering and for addressing the right thread, not as a
+ * security boundary.
+ *
+ * Optional everywhere, defaulting to `case`, so callers written before help
+ * threads existed keep their exact previous behaviour.
+ */
+type ConversationKind = 'case' | 'help_lab' | 'help_radiologist';
+declare function isHelpKind(kind?: ConversationKind | string): boolean;
 interface Conversation {
     id: string;
     orderId: string;
     name: string;
+    kind?: ConversationKind;
     picture?: string;
     participants: Participant[];
     lastMessage?: Message;
@@ -141,6 +159,9 @@ interface ConversationListItem$1 {
     id: string;
     orderId: string;
     name: string;
+    /** Lets the inbox label help threads distinctly from the case thread on the
+     *  same patient — both appear as separate rows. */
+    kind?: ConversationKind;
     picture?: string;
     unreadCount: number;
     lastMessage?: Message;
@@ -154,6 +175,7 @@ interface ConversationListItem$1 {
 interface ConversationPreview {
     conversationId: string;
     orderId: string;
+    kind?: ConversationKind;
     messageCount: number;
     unreadCount: number;
     /** Last N messages (typically 5) for inline display */
@@ -163,7 +185,9 @@ interface ConversationPreview {
 }
 /** Batch preview response shape from the backend */
 interface PreviewBatchResponse {
-    /** Key is orderId, value is preview or null if no conversation exists */
+    /** Key is orderId, value is preview or null if no conversation exists.
+     *  Scoped to a single `kind` per request — the backend filters server-side,
+     *  so this map never mixes a case thread and a help thread for one order. */
     previews: Record<string, ConversationPreview | null>;
 }
 /** Response from createConversationWithMessage (first-message flow) */
@@ -267,6 +291,8 @@ interface CollabPanelProps {
     patientData: PatientData;
     /** Participant user IDs — only used when creating a brand-new conversation */
     participantIds?: string[];
+    /** Which thread on the case. Defaults to the shared `case` thread. */
+    kind?: ConversationKind;
     /** Show "seen by" indicator under own messages (default true) */
     showSeenBy?: boolean;
     /**
@@ -317,7 +343,7 @@ interface CollabPanelProps {
  * Full collaboration panel: patient header + pinned bar + message thread + input.
  * Supports reply, pin/unpin, and (optionally) seen-by indicators.
  */
-declare function CollabPanel({ orderId, patientData, participantIds, showSeenBy, onBack, hidePatientName, hideOpenCase, onConversationChange, themeMode, showSettings: controlledShowSettings, onSettingsChange, className, style, }: CollabPanelProps): react_jsx_runtime.JSX.Element;
+declare function CollabPanel({ orderId, patientData, participantIds, kind, showSeenBy, onBack, hidePatientName, hideOpenCase, onConversationChange, themeMode, showSettings: controlledShowSettings, onSettingsChange, className, style, }: CollabPanelProps): react_jsx_runtime.JSX.Element;
 
 interface CollabPopupProps {
     /** Order ID for this conversation */
@@ -326,6 +352,8 @@ interface CollabPopupProps {
     patientData: PatientData;
     /** Participant user IDs — only used when creating a brand-new conversation */
     participantIds?: string[];
+    /** Which thread on the case. Defaults to the shared `case` thread. */
+    kind?: ConversationKind;
     /** Whether the popup is open */
     isOpen: boolean;
     /** Close the popup */
@@ -355,7 +383,7 @@ interface CollabPopupProps {
  * Draggable floating chat popup — drop-in replacement for DraggableChatPopup.
  * Renders a CollabPanel inside a movable, resizable container.
  */
-declare function CollabPopup({ orderId, patientData, participantIds, isOpen, onClose, onBack, onMinimize, initialPosition, width, height, className, }: CollabPopupProps): react_jsx_runtime.JSX.Element | null;
+declare function CollabPopup({ orderId, patientData, participantIds, kind, isOpen, onClose, onBack, onMinimize, initialPosition, width, height, className, }: CollabPopupProps): react_jsx_runtime.JSX.Element | null;
 
 type ColabInlineMode = 'light' | 'dark';
 interface CollabInlineProps {
@@ -363,6 +391,8 @@ interface CollabInlineProps {
     patientData: PatientData;
     /** User IDs to invite when the first message creates the conversation */
     participantIds?: string[];
+    /** Which thread on the case. Defaults to the shared `case` thread. */
+    kind?: ConversationKind;
     /** Called when user clicks the expand button — host opens the floating popup */
     onExpand?: () => void;
     /** Max inline messages to show (default 1 — just the latest) */
@@ -390,7 +420,7 @@ interface CollabInlineProps {
  * Supports text and voice messages. File attachments and full chat features
  * stay in the floating popup / inbox.
  */
-declare function CollabInline({ orderId, patientData, participantIds, onExpand, messageLimit, placeholder, mode, className, style, }: CollabInlineProps): react_jsx_runtime.JSX.Element;
+declare function CollabInline({ orderId, patientData, participantIds, kind, onExpand, messageLimit, placeholder, mode, className, style, }: CollabInlineProps): react_jsx_runtime.JSX.Element;
 
 interface CollabInboxProps {
     /** Optional: preselect a specific conversation (by conversation ID) */
@@ -552,6 +582,8 @@ interface FetchMessagesOptions {
 interface CreateConversationOptions {
     name: string;
     participantIds?: string[];
+    /** Which thread to create. Defaults to the shared case thread. */
+    kind?: ConversationKind;
 }
 interface CollabContextValue {
     socket: CollabSocket;
@@ -573,9 +605,9 @@ interface CollabContextValue {
      */
     unreadCountsByOrder: Record<string, number>;
     /** Batched preview lookup — coalesces calls within a microtask */
-    requestPreview: (orderId: string) => Promise<ConversationPreview | null>;
+    requestPreview: (orderId: string, kind?: ConversationKind) => Promise<ConversationPreview | null>;
     /** Invalidate a cached preview (e.g. when a new message arrives) */
-    invalidatePreview: (orderId: string) => void;
+    invalidatePreview: (orderId: string, kind?: ConversationKind) => void;
     /** Fetch paginated message history */
     fetchMessages: (conversationId: string, options?: FetchMessagesOptions) => Promise<Message[]>;
     /** Atomic create-or-send — creates conversation if missing, then stores the first message */
@@ -609,6 +641,15 @@ interface UseConversationOptions {
     participantIds?: string[];
     /** Load full history on mount (default true) */
     loadHistory?: boolean;
+    /**
+     * Which thread on the case to open. Defaults to the shared `case` thread,
+     * so every existing caller is unaffected.
+     *
+     * For a help kind the backend seats only the requesting side plus Natoe
+     * support, and `participantIds` is ignored server-side — a help thread
+     * must never be widened by the client.
+     */
+    kind?: ConversationKind;
 }
 interface UseConversationReturn {
     conversation: Conversation | null;
@@ -643,7 +684,7 @@ interface UseConversationReturn {
  * when the user sends the first message. If a conversation already exists for
  * the given orderId, it's loaded and joined automatically.
  */
-declare function useConversation({ orderId, patientData, participantIds, loadHistory, }: UseConversationOptions): UseConversationReturn;
+declare function useConversation({ orderId, patientData, participantIds, loadHistory, kind, }: UseConversationOptions): UseConversationReturn;
 
 interface UseConversationListOptions {
     /**
@@ -677,6 +718,8 @@ interface UseInlineCollabOptions {
     patientData: PatientData;
     /** Participant IDs passed to the backend only when creating a new conversation */
     participantIds?: string[];
+    /** Which thread on the case. Defaults to the shared `case` thread. */
+    kind?: ConversationKind;
     /** Max messages to keep in inline state (default 5) */
     messageLimit?: number;
 }
@@ -704,7 +747,7 @@ interface UseInlineCollabReturn {
  * - First sendMessage creates conversation atomically + starts real-time flow
  * - Subsequent sends go through the socket
  */
-declare function useInlineCollab({ orderId, patientData, participantIds, messageLimit, }: UseInlineCollabOptions): UseInlineCollabReturn;
+declare function useInlineCollab({ orderId, patientData, participantIds, messageLimit, kind, }: UseInlineCollabOptions): UseInlineCollabReturn;
 
 interface UseMessagesOptions {
     conversationId: string | null;
@@ -1187,4 +1230,4 @@ declare const SUPPORTED_IMAGE_TYPES: string[];
 /** Max file size in bytes (20MB) */
 declare const MAX_FILE_SIZE: number;
 
-export { AUDIO_MIME_TYPE, type ChannelEvent, ChannelSettings, type ChannelUpdatePayload, type CollabConfig, type CollabError, CollabInbox, CollabInline, CollabPanel, CollabPopup, CollabProvider, CollabSocket, type Conversation, ConversationList, ConversationListItem, type ConversationListItem$1 as ConversationListItemData, type ConversationPreview, type CreateConversationResponse, DEEP_LINK_PREFIX, EVENTS, type InviteUserPayload, MAX_FILE_SIZE, MAX_PINNED_MESSAGES, MESSAGES_PAGE_SIZE, MESSAGE_TYPES, type Message, MessageActionsMenu, MessageBubble, MessageInput, MessageList, type MessageListHandle, type MessageSnapshot, type MessageType, type Participant, ParticipantsList, type PatientData, PatientHeader, PinnedMessagesBar, type PreviewBatchResponse, ReplyPreview, ReplyQuoteBlock, SUPPORTED_IMAGE_TYPES, SeenByIndicator, type SendMessagePayload, THEME_DEFAULTS, THEME_VAR, TYPING_DEBOUNCE_MS, type Theme, type TypingEvent, type UserRole, applyThemeOverrides, useAudioRecorder, useChannelSettings, useCollab, useConversation, useConversationList, useDeepLinks, useInlineCollab, useMessages, usePinnedMessages, useUnreadCount };
+export { AUDIO_MIME_TYPE, type ChannelEvent, ChannelSettings, type ChannelUpdatePayload, type CollabConfig, type CollabError, CollabInbox, CollabInline, CollabPanel, CollabPopup, CollabProvider, CollabSocket, type Conversation, type ConversationKind, ConversationList, ConversationListItem, type ConversationListItem$1 as ConversationListItemData, type ConversationPreview, type CreateConversationResponse, DEEP_LINK_PREFIX, EVENTS, type InviteUserPayload, MAX_FILE_SIZE, MAX_PINNED_MESSAGES, MESSAGES_PAGE_SIZE, MESSAGE_TYPES, type Message, MessageActionsMenu, MessageBubble, MessageInput, MessageList, type MessageListHandle, type MessageSnapshot, type MessageType, type Participant, ParticipantsList, type PatientData, PatientHeader, PinnedMessagesBar, type PreviewBatchResponse, ReplyPreview, ReplyQuoteBlock, SUPPORTED_IMAGE_TYPES, SeenByIndicator, type SendMessagePayload, THEME_DEFAULTS, THEME_VAR, TYPING_DEBOUNCE_MS, type Theme, type TypingEvent, type UserRole, applyThemeOverrides, isHelpKind, useAudioRecorder, useChannelSettings, useCollab, useConversation, useConversationList, useDeepLinks, useInlineCollab, useMessages, usePinnedMessages, useUnreadCount };

package/dist/index.d.ts

@@ -118,10 +118,28 @@ interface PatientData {
     labName?: string;
     bodyParts?: string[];
 }
+/**
+ * Which thread on a case this is.
+ *
+ *  - `case`             — the shared discussion: lab, radiologist, physician, admin
+ *  - `help_lab`         — imaging center <-> Natoe support, private to that side
+ *  - `help_radiologist` — assigned radiologist <-> Natoe support, private to that side
+ *
+ * The two help kinds are mutually invisible. That isolation is enforced by the
+ * backend's participant seeding, never by anything in this package — treat this
+ * as a label for rendering and for addressing the right thread, not as a
+ * security boundary.
+ *
+ * Optional everywhere, defaulting to `case`, so callers written before help
+ * threads existed keep their exact previous behaviour.
+ */
+type ConversationKind = 'case' | 'help_lab' | 'help_radiologist';
+declare function isHelpKind(kind?: ConversationKind | string): boolean;
 interface Conversation {
     id: string;
     orderId: string;
     name: string;
+    kind?: ConversationKind;
     picture?: string;
     participants: Participant[];
     lastMessage?: Message;
@@ -141,6 +159,9 @@ interface ConversationListItem$1 {
     id: string;
     orderId: string;
     name: string;
+    /** Lets the inbox label help threads distinctly from the case thread on the
+     *  same patient — both appear as separate rows. */
+    kind?: ConversationKind;
     picture?: string;
     unreadCount: number;
     lastMessage?: Message;
@@ -154,6 +175,7 @@ interface ConversationListItem$1 {
 interface ConversationPreview {
     conversationId: string;
     orderId: string;
+    kind?: ConversationKind;
     messageCount: number;
     unreadCount: number;
     /** Last N messages (typically 5) for inline display */
@@ -163,7 +185,9 @@ interface ConversationPreview {
 }
 /** Batch preview response shape from the backend */
 interface PreviewBatchResponse {
-    /** Key is orderId, value is preview or null if no conversation exists */
+    /** Key is orderId, value is preview or null if no conversation exists.
+     *  Scoped to a single `kind` per request — the backend filters server-side,
+     *  so this map never mixes a case thread and a help thread for one order. */
     previews: Record<string, ConversationPreview | null>;
 }
 /** Response from createConversationWithMessage (first-message flow) */
@@ -267,6 +291,8 @@ interface CollabPanelProps {
     patientData: PatientData;
     /** Participant user IDs — only used when creating a brand-new conversation */
     participantIds?: string[];
+    /** Which thread on the case. Defaults to the shared `case` thread. */
+    kind?: ConversationKind;
     /** Show "seen by" indicator under own messages (default true) */
     showSeenBy?: boolean;
     /**
@@ -317,7 +343,7 @@ interface CollabPanelProps {
  * Full collaboration panel: patient header + pinned bar + message thread + input.
  * Supports reply, pin/unpin, and (optionally) seen-by indicators.
  */
-declare function CollabPanel({ orderId, patientData, participantIds, showSeenBy, onBack, hidePatientName, hideOpenCase, onConversationChange, themeMode, showSettings: controlledShowSettings, onSettingsChange, className, style, }: CollabPanelProps): react_jsx_runtime.JSX.Element;
+declare function CollabPanel({ orderId, patientData, participantIds, kind, showSeenBy, onBack, hidePatientName, hideOpenCase, onConversationChange, themeMode, showSettings: controlledShowSettings, onSettingsChange, className, style, }: CollabPanelProps): react_jsx_runtime.JSX.Element;
 
 interface CollabPopupProps {
     /** Order ID for this conversation */
@@ -326,6 +352,8 @@ interface CollabPopupProps {
     patientData: PatientData;
     /** Participant user IDs — only used when creating a brand-new conversation */
     participantIds?: string[];
+    /** Which thread on the case. Defaults to the shared `case` thread. */
+    kind?: ConversationKind;
     /** Whether the popup is open */
     isOpen: boolean;
     /** Close the popup */
@@ -355,7 +383,7 @@ interface CollabPopupProps {
  * Draggable floating chat popup — drop-in replacement for DraggableChatPopup.
  * Renders a CollabPanel inside a movable, resizable container.
  */
-declare function CollabPopup({ orderId, patientData, participantIds, isOpen, onClose, onBack, onMinimize, initialPosition, width, height, className, }: CollabPopupProps): react_jsx_runtime.JSX.Element | null;
+declare function CollabPopup({ orderId, patientData, participantIds, kind, isOpen, onClose, onBack, onMinimize, initialPosition, width, height, className, }: CollabPopupProps): react_jsx_runtime.JSX.Element | null;
 
 type ColabInlineMode = 'light' | 'dark';
 interface CollabInlineProps {
@@ -363,6 +391,8 @@ interface CollabInlineProps {
     patientData: PatientData;
     /** User IDs to invite when the first message creates the conversation */
     participantIds?: string[];
+    /** Which thread on the case. Defaults to the shared `case` thread. */
+    kind?: ConversationKind;
     /** Called when user clicks the expand button — host opens the floating popup */
     onExpand?: () => void;
     /** Max inline messages to show (default 1 — just the latest) */
@@ -390,7 +420,7 @@ interface CollabInlineProps {
  * Supports text and voice messages. File attachments and full chat features
  * stay in the floating popup / inbox.
  */
-declare function CollabInline({ orderId, patientData, participantIds, onExpand, messageLimit, placeholder, mode, className, style, }: CollabInlineProps): react_jsx_runtime.JSX.Element;
+declare function CollabInline({ orderId, patientData, participantIds, kind, onExpand, messageLimit, placeholder, mode, className, style, }: CollabInlineProps): react_jsx_runtime.JSX.Element;
 
 interface CollabInboxProps {
     /** Optional: preselect a specific conversation (by conversation ID) */
@@ -552,6 +582,8 @@ interface FetchMessagesOptions {
 interface CreateConversationOptions {
     name: string;
     participantIds?: string[];
+    /** Which thread to create. Defaults to the shared case thread. */
+    kind?: ConversationKind;
 }
 interface CollabContextValue {
     socket: CollabSocket;
@@ -573,9 +605,9 @@ interface CollabContextValue {
      */
     unreadCountsByOrder: Record<string, number>;
     /** Batched preview lookup — coalesces calls within a microtask */
-    requestPreview: (orderId: string) => Promise<ConversationPreview | null>;
+    requestPreview: (orderId: string, kind?: ConversationKind) => Promise<ConversationPreview | null>;
     /** Invalidate a cached preview (e.g. when a new message arrives) */
-    invalidatePreview: (orderId: string) => void;
+    invalidatePreview: (orderId: string, kind?: ConversationKind) => void;
     /** Fetch paginated message history */
     fetchMessages: (conversationId: string, options?: FetchMessagesOptions) => Promise<Message[]>;
     /** Atomic create-or-send — creates conversation if missing, then stores the first message */
@@ -609,6 +641,15 @@ interface UseConversationOptions {
     participantIds?: string[];
     /** Load full history on mount (default true) */
     loadHistory?: boolean;
+    /**
+     * Which thread on the case to open. Defaults to the shared `case` thread,
+     * so every existing caller is unaffected.
+     *
+     * For a help kind the backend seats only the requesting side plus Natoe
+     * support, and `participantIds` is ignored server-side — a help thread
+     * must never be widened by the client.
+     */
+    kind?: ConversationKind;
 }
 interface UseConversationReturn {
     conversation: Conversation | null;
@@ -643,7 +684,7 @@ interface UseConversationReturn {
  * when the user sends the first message. If a conversation already exists for
  * the given orderId, it's loaded and joined automatically.
  */
-declare function useConversation({ orderId, patientData, participantIds, loadHistory, }: UseConversationOptions): UseConversationReturn;
+declare function useConversation({ orderId, patientData, participantIds, loadHistory, kind, }: UseConversationOptions): UseConversationReturn;
 
 interface UseConversationListOptions {
     /**
@@ -677,6 +718,8 @@ interface UseInlineCollabOptions {
     patientData: PatientData;
     /** Participant IDs passed to the backend only when creating a new conversation */
     participantIds?: string[];
+    /** Which thread on the case. Defaults to the shared `case` thread. */
+    kind?: ConversationKind;
     /** Max messages to keep in inline state (default 5) */
     messageLimit?: number;
 }
@@ -704,7 +747,7 @@ interface UseInlineCollabReturn {
  * - First sendMessage creates conversation atomically + starts real-time flow
  * - Subsequent sends go through the socket
  */
-declare function useInlineCollab({ orderId, patientData, participantIds, messageLimit, }: UseInlineCollabOptions): UseInlineCollabReturn;
+declare function useInlineCollab({ orderId, patientData, participantIds, messageLimit, kind, }: UseInlineCollabOptions): UseInlineCollabReturn;
 
 interface UseMessagesOptions {
     conversationId: string | null;
@@ -1187,4 +1230,4 @@ declare const SUPPORTED_IMAGE_TYPES: string[];
 /** Max file size in bytes (20MB) */
 declare const MAX_FILE_SIZE: number;
 
-export { AUDIO_MIME_TYPE, type ChannelEvent, ChannelSettings, type ChannelUpdatePayload, type CollabConfig, type CollabError, CollabInbox, CollabInline, CollabPanel, CollabPopup, CollabProvider, CollabSocket, type Conversation, ConversationList, ConversationListItem, type ConversationListItem$1 as ConversationListItemData, type ConversationPreview, type CreateConversationResponse, DEEP_LINK_PREFIX, EVENTS, type InviteUserPayload, MAX_FILE_SIZE, MAX_PINNED_MESSAGES, MESSAGES_PAGE_SIZE, MESSAGE_TYPES, type Message, MessageActionsMenu, MessageBubble, MessageInput, MessageList, type MessageListHandle, type MessageSnapshot, type MessageType, type Participant, ParticipantsList, type PatientData, PatientHeader, PinnedMessagesBar, type PreviewBatchResponse, ReplyPreview, ReplyQuoteBlock, SUPPORTED_IMAGE_TYPES, SeenByIndicator, type SendMessagePayload, THEME_DEFAULTS, THEME_VAR, TYPING_DEBOUNCE_MS, type Theme, type TypingEvent, type UserRole, applyThemeOverrides, useAudioRecorder, useChannelSettings, useCollab, useConversation, useConversationList, useDeepLinks, useInlineCollab, useMessages, usePinnedMessages, useUnreadCount };
+export { AUDIO_MIME_TYPE, type ChannelEvent, ChannelSettings, type ChannelUpdatePayload, type CollabConfig, type CollabError, CollabInbox, CollabInline, CollabPanel, CollabPopup, CollabProvider, CollabSocket, type Conversation, type ConversationKind, ConversationList, ConversationListItem, type ConversationListItem$1 as ConversationListItemData, type ConversationPreview, type CreateConversationResponse, DEEP_LINK_PREFIX, EVENTS, type InviteUserPayload, MAX_FILE_SIZE, MAX_PINNED_MESSAGES, MESSAGES_PAGE_SIZE, MESSAGE_TYPES, type Message, MessageActionsMenu, MessageBubble, MessageInput, MessageList, type MessageListHandle, type MessageSnapshot, type MessageType, type Participant, ParticipantsList, type PatientData, PatientHeader, PinnedMessagesBar, type PreviewBatchResponse, ReplyPreview, ReplyQuoteBlock, SUPPORTED_IMAGE_TYPES, SeenByIndicator, type SendMessagePayload, THEME_DEFAULTS, THEME_VAR, TYPING_DEBOUNCE_MS, type Theme, type TypingEvent, type UserRole, applyThemeOverrides, isHelpKind, useAudioRecorder, useChannelSettings, useCollab, useConversation, useConversationList, useDeepLinks, useInlineCollab, useMessages, usePinnedMessages, useUnreadCount };