@hipnation-truth/sdk 0.16.1 → 0.17.0

package/dist/react.d.ts

@@ -156,6 +156,12 @@ interface ConversationTaskRow {
 interface ConversationTaskForUserRow extends ConversationTaskRow {
     /** Normalized `(patient_phone | provider_phone)` for the task's conversation. */
     phonePair: string | null;
+    /**
+     * Set of user ids who have seen this task (opened the detail panel).
+     * Replaces the Hasura `event_activities.seen` boolean — use
+     * `seenBy.includes(userId)` to derive the per-user boolean.
+     */
+    seenBy: string[];
 }
 interface ConversationMessageRow {
     kind: "call" | "sms";
@@ -248,6 +254,18 @@ declare function useMessages(conversationId: string | null | undefined, options?
  * messages, `undefined` while loading or when `userId` is missing.
  */
 declare function useUnreadCount(userId: string | null | undefined): UseQueryResult<number>;
+/**
+ * Server-side aggregate of the user's unread total + count of
+ * conversations with at least one unread. Optionally filtered by
+ * `providerPhones` (e.g. selected offices) — the aggregate is
+ * computed in Convex, no client-side fetch-and-filter.
+ */
+declare function useUnreadAggregate(userId: string | null | undefined, options?: {
+    providerPhones?: string[];
+}): UseQueryResult<{
+    totalMessages: number;
+    conversationCount: number;
+}>;
 /**
  * Subscribe to all notes attached to a conversation, newest first.
  * Replaces the urql Hasura `useConversation_NotesSubscription` in
@@ -382,6 +400,45 @@ declare function useDialpadCallLog(callId: string | null | undefined, options?:
     limit?: number;
 }): UseQueryResult<DialpadCallLogRow[]>;
 
+/**
+ * React hook for a single conversation lookup by Convex id — Truth SDK.
+ *
+ * Replaces CommHub's `useGet_Conversation_EventQuery` (backed by the
+ * Hasura `Get_Conversation_Event` GraphQL query). Queries the Convex
+ * `conversations:getById` function which returns the raw conversation
+ * row, or `null` when the id doesn't exist.
+ *
+ * The returned `ConversationRow` carries the same phone-pair fields as
+ * `useConversationByPhonePair` — `patientPhone`, `providerPhone`,
+ * `phonePair`, `patientId` — but is keyed on the Convex document `_id`
+ * rather than the pair. Use this when you have a Convex id from a push
+ * notification or a deep-link route param.
+ *
+ * Must be used within a `<TruthProvider />`.
+ *
+ * @example
+ * ```tsx
+ * import { useConversationById } from '@hipnation-truth/sdk/react/conversation-by-id';
+ *
+ * function ConversationScreen({ id }: { id: string }) {
+ *   const { data: conversation, loading } = useConversationById(id);
+ *   if (loading) return <Spinner />;
+ *   if (!conversation) return <NotFound />;
+ *   return <View>{conversation.patientPhone}</View>;
+ * }
+ * ```
+ */
+
+/**
+ * Subscribe to a single conversation by its Convex document id. Returns
+ * `null` when no conversation exists for that id.
+ *
+ * `data` is `undefined` while loading or when `id` is falsy (skip). Pass
+ * `null` or `undefined` to skip the query — useful when the route param
+ * hasn't resolved yet.
+ */
+declare function useConversationById(id: string | null | undefined): UseQueryResult<ConversationRow | null>;
+
 /**
  * React hooks for Truth SDK — real-time Convex-backed data access.
  *
@@ -1003,6 +1060,41 @@ interface ScheduleReminderResult {
  */
 declare function useRemindersForConversations(conversationIds: string[] | null | undefined): UseQueryResult<Record<string, Reminder>>;
 
+/**
+ * React hooks for conversation tasks (My Tasks surface).
+ *
+ * Provides a reactive `useMutation` wrapper around the
+ * `conversationTasks:markSeen` Convex mutation so CommHub can replace
+ * `useMark_Event_Activity_SeenMutation` from `@/generated/graphql`
+ * with a Truth SDK equivalent without touching `react.ts` exports (the
+ * central agent wires those).
+ *
+ * Pattern mirrors the existing hooks in `./conversations.ts`:
+ *   - `makeFunctionReference` for decoupled Convex references
+ *   - SKIP sentinel for conditional execution
+ *   - Returns a stable callback, not a live subscription
+ *
+ * Must be used within `<TruthProvider />`.
+ */
+/**
+ * Returns a stable `markSeen(taskId, userId)` callback backed by the
+ * `conversationTasks:markSeen` Convex mutation. Replaces the Hasura
+ * `useMark_Event_Activity_SeenMutation` in CommHub's My Tasks surface.
+ *
+ * @example
+ * ```tsx
+ * const markSeen = useConversationTaskMarkSeen();
+ *
+ * // When a task row is pressed:
+ * if (!task.seenBy.includes(userId)) {
+ *   markSeen(task.id, userId).catch(console.error);
+ * }
+ * ```
+ */
+declare function useConversationTaskMarkSeen(): (taskId: string, userId: string) => Promise<{
+    ok: true;
+}>;
+
 /**
  * Typed event definitions for the Truth Platform event store.
  *
@@ -2316,6 +2408,16 @@ interface UpdateTaskStatusInput {
     resolvedBy?: string;
     data?: unknown;
 }
+/**
+ * Input for `tasks.markSeen()` — marks a conversation task as seen by
+ * the given user, backing CommHub's My Tasks "unseen" indicator.
+ */
+interface ConversationTaskMarkSeenInput {
+    /** Convex `_id` of the `conversationTasks` row. */
+    taskId: string;
+    /** User id of the person who viewed the task. */
+    userId: string;
+}
 
 /**
  * TasksResource — create, update status, list, get tasks.
@@ -2343,6 +2445,17 @@ declare class TasksResource {
         limit?: number;
     }): Promise<Task[]>;
     listOpen(limit?: number): Promise<Task[]>;
+    /**
+     * Mark a conversation task as seen by the given user. Appends `userId`
+     * to the `seenBy` array on the `conversationTasks` row if not already
+     * present. Replaces CommHub's `useMark_Event_Activity_SeenMutation`.
+     *
+     * @returns `{ ok: true }` on success.
+     * @throws if the task does not exist in Convex.
+     */
+    markSeen(input: ConversationTaskMarkSeenInput): Promise<{
+        ok: true;
+    }>;
 }
 
 interface TranslationResult {
@@ -2542,4 +2655,4 @@ interface UseVoicemailUrlResult {
  */
 declare function useVoicemailUrl(client: TruthClient): UseVoicemailUrlResult;
 
-export { ACTIVE_CALL_STATES, type Appointment, type AppointmentListOptions, CONNECTED_CALL_STATES, type ConversationListItem, type ConversationMessage, type ConversationMessageRow, type ConversationNoteRow, type ConversationRow, type ConversationTaskForUserRow, type ConversationTaskRow, type DialpadCallLogRow, type DialpadCallRow, DialpadCallState, type EventPayloadMap, type EventType, type FamilyMemberRow, type Patient, type PatientListOptions, type PatientSearchResult, type PermissionStatus, type Physician$1 as Physician, RINGING_CALL_STATES, TERMINAL_CALL_STATES, type TrackOptions, TruthProvider, type TruthProviderProps, type TruthTrackingContextValue, TruthTrackingProvider, type TruthTrackingProviderProps, type UseActiveCallsOptions, type UseAppointmentListOptions, type UseConversationMessagesOptions, type UseConversationsFilters, type UseMessagesOptions, type UseNotificationsOptions, type UseNotificationsResult, type UsePatientBasicOptions, type UsePatientBasicResult, type UsePatientFamilyMembersInput, type UsePatientListOptions, type UsePatientMedicalOptions, type UsePatientPhotoOptions, type UsePatientSearchOptions, type UseQueryResult, useActiveCalls, useAppointment, useAppointmentByElationId, useAppointments, useConversationByPhonePair, useConversationMessages, useConversationNotes, useConversationNotesByPhonePair, useConversationTasks, useConversationTasksByPhonePair, useConversationTasksForUser, useConversations, useDialpadCallByCallId, useDialpadCallLog, useDialpadCallsForConversation, useMessages, useNotifications, usePatient, usePatientBasic, usePatientByElationId, usePatientByHintId, usePatientFamilyMembers, usePatientMedical, usePatientPhoto, usePatientSearch, usePatients, usePatientsByIds, usePatientsByPhones, usePharmacyByNcpdpId, usePhysicianByElationId, usePhysiciansByElationIds, useRemindersForConversations, useTruth, useUnreadCount, useUserSettings, useVoicemailUrl };
+export { ACTIVE_CALL_STATES, type Appointment, type AppointmentListOptions, CONNECTED_CALL_STATES, type ConversationListItem, type ConversationMessage, type ConversationMessageRow, type ConversationNoteRow, type ConversationRow, type ConversationTaskForUserRow, type ConversationTaskRow, type DialpadCallLogRow, type DialpadCallRow, DialpadCallState, type EventPayloadMap, type EventType, type FamilyMemberRow, type Patient, type PatientListOptions, type PatientSearchResult, type PermissionStatus, type Physician$1 as Physician, RINGING_CALL_STATES, TERMINAL_CALL_STATES, type TrackOptions, TruthProvider, type TruthProviderProps, type TruthTrackingContextValue, TruthTrackingProvider, type TruthTrackingProviderProps, type UseActiveCallsOptions, type UseAppointmentListOptions, type UseConversationMessagesOptions, type UseConversationsFilters, type UseMessagesOptions, type UseNotificationsOptions, type UseNotificationsResult, type UsePatientBasicOptions, type UsePatientBasicResult, type UsePatientFamilyMembersInput, type UsePatientListOptions, type UsePatientMedicalOptions, type UsePatientPhotoOptions, type UsePatientSearchOptions, type UseQueryResult, useActiveCalls, useAppointment, useAppointmentByElationId, useAppointments, useConversationById, useConversationByPhonePair, useConversationMessages, useConversationNotes, useConversationNotesByPhonePair, useConversationTaskMarkSeen, useConversationTasks, useConversationTasksByPhonePair, useConversationTasksForUser, useConversations, useDialpadCallByCallId, useDialpadCallLog, useDialpadCallsForConversation, useMessages, useNotifications, usePatient, usePatientBasic, usePatientByElationId, usePatientByHintId, usePatientFamilyMembers, usePatientMedical, usePatientPhoto, usePatientSearch, usePatients, usePatientsByIds, usePatientsByPhones, usePharmacyByNcpdpId, usePhysicianByElationId, usePhysiciansByElationIds, useRemindersForConversations, useTruth, useUnreadAggregate, useUnreadCount, useUserSettings, useVoicemailUrl };