@hipnation-truth/sdk 0.11.0 → 0.13.0

package/dist/react.d.ts

@@ -107,54 +107,6 @@ interface ConversationRow {
  * already exported from the SDK; re-exported here under a clearer name
  * for the new hook surface.
  */
-/**
- * Conversation note row — single entry shown in the right-panel notes
- * tab in CommHub. Replaces the urql Hasura `internal_activities` row
- * with `type='note'`.
- */
-interface ConversationNoteRow {
-    /** Convex id of the conversationNotes row. */
-    id: string;
-    conversationId: string;
-    /** Dialpad event the note is attached to, when present. */
-    eventId: string | null;
-    author: string;
-    content: string;
-    /** Free-form status flag — matches CommHub's existing schema. */
-    status: string | null;
-    /** Free-form `type` discriminator — matches CommHub's existing schema. */
-    type: string | null;
-    createdAt: string;
-    updatedAt: string;
-}
-/**
- * Conversation task row — single entry shown in the right-panel tasks
- * tab. Replaces the urql Hasura `internal_activities` row with
- * `type='task'`.
- */
-interface ConversationTaskRow {
-    id: string;
-    conversationId: string;
-    eventId: string | null;
-    author: string;
-    description: string;
-    status: "pending" | "completed";
-    priority: "high" | "medium" | "low" | null;
-    assignee: string | null;
-    resolvedBy: string | null;
-    type: string | null;
-    createdAt: string;
-    updatedAt: string;
-}
-/**
- * Cross-conversation task row used by the "My Tasks" tab. Adds the
- * conversation's normalized phone pair so the UI can render the
- * patient handle without a second reactive query.
- */
-interface ConversationTaskForUserRow extends ConversationTaskRow {
-    /** Normalized `(patient_phone | provider_phone)` for the task's conversation. */
-    phonePair: string | null;
-}
 interface ConversationMessageRow {
     kind: "call" | "sms";
     id: string;
@@ -194,15 +146,6 @@ interface UseConversationsFilters {
      * the query — useful when the auth session is still loading.
      */
     userId: string | null | undefined;
-    /**
-     * Optional search term — when non-empty, switches the hook from
-     * `conversations:listForUser` to `conversations:searchForUser`, which
-     * fans out two parallel Convex full-text patient searches
-     * (firstName + lastName) and returns the matching conversations the
-     * user can see, sorted by recency. Whitespace-only values are treated
-     * as empty.
-     */
-    search?: string;
     /** Page size. Server caps at 100 by default. */
     limit?: number;
 }
@@ -246,36 +189,109 @@ 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>;
+
 /**
- * Subscribe to all notes attached to a conversation, newest first.
- * Replaces the urql Hasura `useConversation_NotesSubscription` in
- * CommHub (Truth #730). Pass `null`/`undefined` to skip the query.
- */
-declare function useConversationNotes(conversationId: string | null | undefined): UseQueryResult<ConversationNoteRow[]>;
-/**
- * Subscribe to all tasks attached to a conversation, newest first.
- * Replaces the urql Hasura `useConversation_TasksSubscription` in
- * CommHub (Truth #730).
+ * React hooks for Dialpad call events — replaces CommHub's Hasura
+ * `useDialpad_EventsSubscription`. Powered by the new
+ * `dialpadCallEvents` + `dialpadCallEventLog` Convex tables that the
+ * Truth webhook handler writes on every call state transition.
+ *
+ * Same `{ data, loading, error }` contract as the other hooks in this
+ * SDK; same `skip` semantics on missing arguments.
+ *
+ * @example
+ * ```tsx
+ * import { useActiveCalls, useDialpadCallByCallId } from '@hipnation-truth/sdk/react';
+ *
+ * function IncomingBanner() {
+ *   const { data: active } = useActiveCalls();
+ *   if (!active?.length) return null;
+ *   return <Banner calls={active} />;
+ * }
+ * ```
  */
-declare function useConversationTasks(conversationId: string | null | undefined): UseQueryResult<ConversationTaskRow[]>;
+
+declare const DialpadCallState: {
+    readonly Calling: "calling";
+    readonly Ringing: "ringing";
+    readonly Connected: "connected";
+    readonly Hold: "hold";
+    readonly Hangup: "hangup";
+    readonly Missed: "missed";
+    readonly VoicemailUploaded: "voicemail_uploaded";
+};
+type DialpadCallState = (typeof DialpadCallState)[keyof typeof DialpadCallState];
+/** Ringing states — caller hasn't been picked up yet. */
+declare const RINGING_CALL_STATES: ReadonlySet<DialpadCallState>;
+/** Connected states — call is live (or on hold). */
+declare const CONNECTED_CALL_STATES: ReadonlySet<DialpadCallState>;
+/**
+ * Active states — anything not terminal. Default filter for
+ * `useActiveCalls`; the union of ringing + connected. `hold` is NOT
+ * included by default because the IncomingCalls UI doesn't surface
+ * held calls in the inbox banner.
+ */
+declare const ACTIVE_CALL_STATES: ReadonlySet<DialpadCallState>;
+/** Terminal states — call has ended. Used to exclude rows from active lists. */
+declare const TERMINAL_CALL_STATES: ReadonlySet<DialpadCallState>;
+interface DialpadCallRow {
+    _id: string;
+    _creationTime: number;
+    callId: string;
+    state: string;
+    direction: string | null;
+    fromNumber: string | null;
+    toNumber: string | null;
+    phonePair: string | null;
+    conversationId: string | null;
+    patientId: string | null;
+    voicemailLink: string | null;
+    voicemailDurationSec: number | null;
+    transcript: unknown | null;
+    duration: number | null;
+    occurredAt: string;
+    updatedAt: string;
+}
+interface DialpadCallLogRow {
+    _id: string;
+    _creationTime: number;
+    callId: string;
+    state: string;
+    direction: string | null;
+    payload: unknown | null;
+    occurredAt: string;
+}
+interface UseActiveCallsOptions {
+    /** Page cap. Default 50. */
+    limit?: number;
+    /**
+     * Terminal states excluded from the active list. Override only if
+     * Dialpad introduces a new state.
+     */
+    terminalStates?: string[];
+}
 /**
- * Same as `useConversationNotes` but keyed on the normalized
- * `(patient_phone | provider_phone)` pair — saves the caller from
- * chaining a separate `useConversationByPhonePair` call. Returns
- * `[]` if no conversation exists for the pair yet.
+ * Live list of every Dialpad call that hasn't reached a terminal state
+ * — used by CommHub's IncomingCalls banner. Updates as the webhook
+ * handler patches the per-call row.
  */
-declare function useConversationNotesByPhonePair(phonePair: string | null | undefined): UseQueryResult<ConversationNoteRow[]>;
+declare function useActiveCalls(options?: UseActiveCallsOptions): UseQueryResult<DialpadCallRow[]>;
 /**
- * Same as `useConversationTasks` but keyed on phonePair.
+ * All calls (most-recent-first) on a single conversation. Pass the
+ * Convex conversation `_id` (e.g. from `useConversationByPhonePair`).
  */
+declare function useDialpadCallsForConversation(conversationId: string | null | undefined, options?: {
+    limit?: number;
+}): UseQueryResult<DialpadCallRow[]>;
+/** Single call lookup by Dialpad `call_id`. */
+declare function useDialpadCallByCallId(callId: string | null | undefined): UseQueryResult<DialpadCallRow | null>;
 /**
- * Subscribe to every conversation task where the caller is the
- * assignee or the author. Backs CommHub's "My Tasks" tab.
+ * Full audit history of state transitions for a call — backs the
+ * hold / recording / transcription timeline in the right panel.
  */
-declare function useConversationTasksForUser(userId: string | null | undefined, options?: {
+declare function useDialpadCallLog(callId: string | null | undefined, options?: {
     limit?: number;
-}): UseQueryResult<ConversationTaskForUserRow[]>;
-declare function useConversationTasksByPhonePair(phonePair: string | null | undefined): UseQueryResult<ConversationTaskRow[]>;
+}): UseQueryResult<DialpadCallLogRow[]>;
 
 /**
  * React hooks for Truth SDK — real-time Convex-backed data access.
@@ -993,4 +1009,4 @@ interface PatientListOptions {
     cursor?: string;
 }
 
-export { type Appointment, type AppointmentListOptions, type ConversationListItem, type ConversationMessage, type ConversationMessageRow, type ConversationNoteRow, type ConversationRow, type ConversationTaskForUserRow, type ConversationTaskRow, type EventPayloadMap, type EventType, type Patient, type PatientListOptions, type PermissionStatus, type Physician, type TrackOptions, TruthProvider, type TruthProviderProps, type TruthTrackingContextValue, TruthTrackingProvider, type TruthTrackingProviderProps, type UseAppointmentListOptions, type UseConversationMessagesOptions, type UseConversationsFilters, type UseMessagesOptions, type UseNotificationsOptions, type UseNotificationsResult, type UsePatientBasicOptions, type UsePatientBasicResult, type UsePatientListOptions, type UsePatientMedicalOptions, type UsePatientPhotoOptions, type UseQueryResult, useAppointment, useAppointmentByElationId, useAppointments, useConversationByPhonePair, useConversationMessages, useConversationNotes, useConversationNotesByPhonePair, useConversationTasks, useConversationTasksByPhonePair, useConversationTasksForUser, useConversations, useMessages, useNotifications, usePatient, usePatientBasic, usePatientByElationId, usePatientByHintId, usePatientMedical, usePatientPhoto, usePatients, usePharmacyByNcpdpId, usePhysicianByElationId, usePhysiciansByElationIds, useTruth, useUnreadCount };
+export { ACTIVE_CALL_STATES, type Appointment, type AppointmentListOptions, CONNECTED_CALL_STATES, type ConversationListItem, type ConversationMessage, type ConversationMessageRow, type ConversationRow, type DialpadCallLogRow, type DialpadCallRow, DialpadCallState, type EventPayloadMap, type EventType, type Patient, type PatientListOptions, type PermissionStatus, type 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 UsePatientListOptions, type UsePatientMedicalOptions, type UsePatientPhotoOptions, type UseQueryResult, useActiveCalls, useAppointment, useAppointmentByElationId, useAppointments, useConversationByPhonePair, useConversationMessages, useConversations, useDialpadCallByCallId, useDialpadCallLog, useDialpadCallsForConversation, useMessages, useNotifications, usePatient, usePatientBasic, usePatientByElationId, usePatientByHintId, usePatientMedical, usePatientPhoto, usePatients, usePharmacyByNcpdpId, usePhysicianByElationId, usePhysiciansByElationIds, useTruth, useUnreadCount };