@natoe/colab 0.1.14 → 0.1.17

package/dist/index.d.mts

@@ -78,6 +78,13 @@ interface CollabConfig {
     theme?: Theme;
     /** Host app callbacks — colab calls these, never implements them */
     onOpenDicom?: (studyId: string, storageId: string) => void;
+    /**
+     * Open the case behind this conversation. Wired to the package's
+     * PatientHeader "Open" button (sibling to "View DICOM"). The host
+     * decides how to route — typically role-aware: lab → case page,
+     * radiologist → viewer, physician → order history.
+     */
+    onOpenCase?: (orderId: string, displayOrderId?: string) => void;
     onUploadFile?: (file: File | Blob, fileName?: string) => Promise<string>;
     onDeepLink?: (path: string) => void;
     onError?: (error: CollabError) => void;
@@ -256,6 +263,14 @@ interface CollabPanelProps {
     onBack?: () => void;
     /** Hide the patient name row in the header — set when a parent already shows it (e.g. CollabPopup title bar) */
     hidePatientName?: boolean;
+    /**
+     * Suppress the PatientHeader "Open" button even when the host has
+     * supplied `config.onOpenCase`. Set this when the panel is rendered
+     * for the same case the user is already on (e.g. embedded in the
+     * viewer's left panel) — otherwise clicking Open would re-fetch the
+     * current order and overwrite in-progress context.
+     */
+    hideOpenCase?: boolean;
     /**
      * Notified whenever the underlying conversation state changes (initial
      * preview load, create, channel deletion). Lets a parent like CollabPopup
@@ -280,7 +295,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, onConversationChange, themeMode, className, style, }: CollabPanelProps): react_jsx_runtime.JSX.Element;
+declare function CollabPanel({ orderId, patientData, participantIds, showSeenBy, onBack, hidePatientName, hideOpenCase, onConversationChange, themeMode, className, style, }: CollabPanelProps): react_jsx_runtime.JSX.Element;
 
 interface CollabPopupProps {
     /** Order ID for this conversation */
@@ -380,6 +395,20 @@ type PresenceCallback = (presences: Record<string, {
     userId: string;
     isOnline: boolean;
 }>) => void;
+/**
+ * Server-pushed unread counts. The backend broadcasts BOTH keyings in
+ * one payload so consumers can render badges at either granularity (FAB
+ * + inbox row use `conversation`; table-row chat icons use `order`) off
+ * a single socket event. Legacy backends that send a flat
+ * `Record<string, number>` are normalised at the socket boundary into
+ * `{ conversation: <flat>, order: {} }` for forward compatibility.
+ */
+interface UnreadCounts {
+    /** keyed by conversation id */
+    conversation: Record<string, number>;
+    /** keyed by order id — used for table-row chat-icon badges */
+    order: Record<string, number>;
+}
 interface ConversationCallbacks {
     onMessage?: MessageCallback;
     onTyping?: TypingCallback;
@@ -433,8 +462,10 @@ declare class CollabSocket {
     connect(config: CollabConfig): void;
     /** Subscribe to user-level events (unread counts, notifications) */
     private joinUserChannel;
-    /** Register callback for unread count changes */
-    onUnreadCountUpdate(callback: (counts: Record<string, number>) => void): void;
+    /** Register callback for unread count changes. The callback receives
+     *  the normalised {@link UnreadCounts} shape regardless of which
+     *  payload format the backend pushed. */
+    onUnreadCountUpdate(callback: (counts: UnreadCounts) => void): void;
     /**
      * Join a conversation channel and subscribe to events.
      *
@@ -512,6 +543,13 @@ interface CollabContextValue {
      * mounting their own useConversation.
      */
     unreadCounts: Record<string, number>;
+    /**
+     * Same unread counts, but keyed by **order ID** instead of
+     * conversation ID. Useful for table-row chat-icon badges where the
+     * row only knows its order_id, not the conversation_id. Same socket
+     * push updates both maps in lock-step.
+     */
+    unreadCountsByOrder: Record<string, number>;
     /** Batched preview lookup — coalesces calls within a microtask */
     requestPreview: (orderId: string) => Promise<ConversationPreview | null>;
     /** Invalidate a cached preview (e.g. when a new message arrives) */
@@ -834,30 +872,37 @@ interface PatientHeaderProps {
     patientData: PatientData;
     participants: Participant[];
     onOpenDicom?: () => void;
+    /**
+     * Open the case behind this conversation — bound to the "Open" button
+     * that sits next to "View DICOM". When undefined, the button is
+     * hidden.
+     */
+    onOpenCase?: () => void;
     onOpenSettings?: () => void;
     /** When set, renders a back-arrow button (compact inbox returning to list) */
     onBack?: () => void;
-    /** Suppress the channel name row — use when the name is already shown in a parent title bar */
+    /** Suppress the patient name row — use when the name is already shown in a parent title bar */
     hideName?: boolean;
     /** Override the displayed name — use the stored conversation.name to avoid reconstructing from patientData components */
     displayName?: string;
     className?: string;
 }
 /**
- * "Case card" header that sits below the window title bar. Tinted blue-50
- * background to set it apart from the conversation body. Renders a row
- * of labelled key-value columns (label uppercase on top, value below) for
- * the clinical context the host passed in, with the action buttons
- * (View DICOM + Settings) right-aligned.
+ * Compact case header. One zone, two rows:
+ *
+ *   Row 1: [back?] Patient Name                     [View DICOM] [Open] [👥 4]
+ *   Row 2: 54 · M · CT · Knee
+ *
+ * Replaces the older "case card" layout (labelled meta columns —
+ * Age/Sex, Modality, Body part — stacked below the name row). That
+ * layout cost ~70-80px of vertical real estate on every chat surface
+ * and pushed the message thread further down the panel. This version
+ * lands at ~52-60px and conveys the same identifying context inline.
  *
- * Used in two layouts:
- *   - Popup path (`hideName=true`): the surrounding title bar already
- *     shows the patient name, so we render the case card only.
- *   - Compact-inbox path (`hideName=false`): the panel is a full-page
- *     experience and there's no outer title, so we still show the name +
- *     back button stacked above the case card.
+ * When `hideName=true` (CollabPopup wraps the conversation in its own
+ * window title), only the meta + actions row renders.
  */
-declare function PatientHeader({ patientData, participants, onOpenDicom, onOpenSettings, onBack, hideName, displayName, className, }: PatientHeaderProps): react_jsx_runtime.JSX.Element;
+declare function PatientHeader({ patientData, participants, onOpenDicom, onOpenCase, onOpenSettings, onBack, hideName, displayName, className, }: PatientHeaderProps): react_jsx_runtime.JSX.Element;
 
 interface MessageListHandle {
     /** Scroll to a specific message by ID (used by pin jump-to) */

package/dist/index.d.ts

@@ -78,6 +78,13 @@ interface CollabConfig {
     theme?: Theme;
     /** Host app callbacks — colab calls these, never implements them */
     onOpenDicom?: (studyId: string, storageId: string) => void;
+    /**
+     * Open the case behind this conversation. Wired to the package's
+     * PatientHeader "Open" button (sibling to "View DICOM"). The host
+     * decides how to route — typically role-aware: lab → case page,
+     * radiologist → viewer, physician → order history.
+     */
+    onOpenCase?: (orderId: string, displayOrderId?: string) => void;
     onUploadFile?: (file: File | Blob, fileName?: string) => Promise<string>;
     onDeepLink?: (path: string) => void;
     onError?: (error: CollabError) => void;
@@ -256,6 +263,14 @@ interface CollabPanelProps {
     onBack?: () => void;
     /** Hide the patient name row in the header — set when a parent already shows it (e.g. CollabPopup title bar) */
     hidePatientName?: boolean;
+    /**
+     * Suppress the PatientHeader "Open" button even when the host has
+     * supplied `config.onOpenCase`. Set this when the panel is rendered
+     * for the same case the user is already on (e.g. embedded in the
+     * viewer's left panel) — otherwise clicking Open would re-fetch the
+     * current order and overwrite in-progress context.
+     */
+    hideOpenCase?: boolean;
     /**
      * Notified whenever the underlying conversation state changes (initial
      * preview load, create, channel deletion). Lets a parent like CollabPopup
@@ -280,7 +295,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, onConversationChange, themeMode, className, style, }: CollabPanelProps): react_jsx_runtime.JSX.Element;
+declare function CollabPanel({ orderId, patientData, participantIds, showSeenBy, onBack, hidePatientName, hideOpenCase, onConversationChange, themeMode, className, style, }: CollabPanelProps): react_jsx_runtime.JSX.Element;
 
 interface CollabPopupProps {
     /** Order ID for this conversation */
@@ -380,6 +395,20 @@ type PresenceCallback = (presences: Record<string, {
     userId: string;
     isOnline: boolean;
 }>) => void;
+/**
+ * Server-pushed unread counts. The backend broadcasts BOTH keyings in
+ * one payload so consumers can render badges at either granularity (FAB
+ * + inbox row use `conversation`; table-row chat icons use `order`) off
+ * a single socket event. Legacy backends that send a flat
+ * `Record<string, number>` are normalised at the socket boundary into
+ * `{ conversation: <flat>, order: {} }` for forward compatibility.
+ */
+interface UnreadCounts {
+    /** keyed by conversation id */
+    conversation: Record<string, number>;
+    /** keyed by order id — used for table-row chat-icon badges */
+    order: Record<string, number>;
+}
 interface ConversationCallbacks {
     onMessage?: MessageCallback;
     onTyping?: TypingCallback;
@@ -433,8 +462,10 @@ declare class CollabSocket {
     connect(config: CollabConfig): void;
     /** Subscribe to user-level events (unread counts, notifications) */
     private joinUserChannel;
-    /** Register callback for unread count changes */
-    onUnreadCountUpdate(callback: (counts: Record<string, number>) => void): void;
+    /** Register callback for unread count changes. The callback receives
+     *  the normalised {@link UnreadCounts} shape regardless of which
+     *  payload format the backend pushed. */
+    onUnreadCountUpdate(callback: (counts: UnreadCounts) => void): void;
     /**
      * Join a conversation channel and subscribe to events.
      *
@@ -512,6 +543,13 @@ interface CollabContextValue {
      * mounting their own useConversation.
      */
     unreadCounts: Record<string, number>;
+    /**
+     * Same unread counts, but keyed by **order ID** instead of
+     * conversation ID. Useful for table-row chat-icon badges where the
+     * row only knows its order_id, not the conversation_id. Same socket
+     * push updates both maps in lock-step.
+     */
+    unreadCountsByOrder: Record<string, number>;
     /** Batched preview lookup — coalesces calls within a microtask */
     requestPreview: (orderId: string) => Promise<ConversationPreview | null>;
     /** Invalidate a cached preview (e.g. when a new message arrives) */
@@ -834,30 +872,37 @@ interface PatientHeaderProps {
     patientData: PatientData;
     participants: Participant[];
     onOpenDicom?: () => void;
+    /**
+     * Open the case behind this conversation — bound to the "Open" button
+     * that sits next to "View DICOM". When undefined, the button is
+     * hidden.
+     */
+    onOpenCase?: () => void;
     onOpenSettings?: () => void;
     /** When set, renders a back-arrow button (compact inbox returning to list) */
     onBack?: () => void;
-    /** Suppress the channel name row — use when the name is already shown in a parent title bar */
+    /** Suppress the patient name row — use when the name is already shown in a parent title bar */
     hideName?: boolean;
     /** Override the displayed name — use the stored conversation.name to avoid reconstructing from patientData components */
     displayName?: string;
     className?: string;
 }
 /**
- * "Case card" header that sits below the window title bar. Tinted blue-50
- * background to set it apart from the conversation body. Renders a row
- * of labelled key-value columns (label uppercase on top, value below) for
- * the clinical context the host passed in, with the action buttons
- * (View DICOM + Settings) right-aligned.
+ * Compact case header. One zone, two rows:
+ *
+ *   Row 1: [back?] Patient Name                     [View DICOM] [Open] [👥 4]
+ *   Row 2: 54 · M · CT · Knee
+ *
+ * Replaces the older "case card" layout (labelled meta columns —
+ * Age/Sex, Modality, Body part — stacked below the name row). That
+ * layout cost ~70-80px of vertical real estate on every chat surface
+ * and pushed the message thread further down the panel. This version
+ * lands at ~52-60px and conveys the same identifying context inline.
  *
- * Used in two layouts:
- *   - Popup path (`hideName=true`): the surrounding title bar already
- *     shows the patient name, so we render the case card only.
- *   - Compact-inbox path (`hideName=false`): the panel is a full-page
- *     experience and there's no outer title, so we still show the name +
- *     back button stacked above the case card.
+ * When `hideName=true` (CollabPopup wraps the conversation in its own
+ * window title), only the meta + actions row renders.
  */
-declare function PatientHeader({ patientData, participants, onOpenDicom, onOpenSettings, onBack, hideName, displayName, className, }: PatientHeaderProps): react_jsx_runtime.JSX.Element;
+declare function PatientHeader({ patientData, participants, onOpenDicom, onOpenCase, onOpenSettings, onBack, hideName, displayName, className, }: PatientHeaderProps): react_jsx_runtime.JSX.Element;
 
 interface MessageListHandle {
     /** Scroll to a specific message by ID (used by pin jump-to) */