@campxdev/campx-web-utils 2.0.13 → 2.0.14

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import * as _axios from 'axios';
 import { Severity, ConfirmDialogType, MultiSelectProps, SingleSelectProps } from '@campxdev/react-blueprint';
 import { Store } from 'pullstate';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ReactNode } from 'react';
+import React, { ReactNode } from 'react';
 import { ReducersMapObject } from '@reduxjs/toolkit';
 export { BrowserRouter } from 'react-router-dom';
 
@@ -30,6 +30,25 @@ declare function createRsbuildSharedConfig(dependencies: Dependencies, alwaysEag
 
 declare const nonWorkspaceAxios: _axios.AxiosInstance;
 
+/**
+ * VoIP Configuration Module
+ *
+ * This module manages VoIP/Exotel configuration for workspaces.
+ * Only workspaces listed in VOIP_ENABLED_WORKSPACES will have VoIP functionality.
+ */
+/**
+ * List of workspaces that have VoIP/Exotel calling enabled.
+ * Add workspace names here to enable VoIP for that workspace.
+ */
+declare const VOIP_ENABLED_WORKSPACES: string[];
+/**
+ * Check if VoIP is enabled for a given workspace
+ *
+ * @param workspaceName - The name of the workspace to check
+ * @returns boolean indicating if VoIP is enabled for the workspace
+ */
+declare function isVoIPEnabledForWorkspace(workspaceName: string): boolean;
+
 type Classroom = {
     id: number;
     batchName?: string;
@@ -198,5 +217,340 @@ declare const workspaceApiMapping: Record<string, string>;
 
 declare const openInNewTab: (pathAfterBase: string, excludeInstitution?: boolean, excludeWorkspace?: boolean) => void;
 
-export { ApplicationStore, BatchSelector, ConfirmDialogProvider, CourseSelector, DepartmentMongoMultiSelector, DepartmentSelector, DepartmentSqlMultiSelector, EmployeesSelector, ErrorBoundary, ExamTypeSelector, ExamsRegulationSelector, FeeTypeSelector, HostelBlockSelector, HostelFloorSelector, HostelRoomSelector, MonthYearSelector, PrintFormatSelector, ProgramSelector, Providers, RegulationSelector, ResearchExpertDesignationSelector, ResearchExpertSelector, ResearchStageSelector, SemesterSelector, SnackbarProvider, StudentSelector, StudentServicesSelector, YearRangeSelector, axios, createRsbuildSharedConfig, initialApplicationState, institutionCode, isDevelopment, nonWorkspaceAxios, openInNewTab, tenantCode, useConfirm, workspace, workspaceApiMapping };
-export type { ApplicationStoreType, ErrorBoundaryProps, InstitutionInfo };
+type PermissionStatus = 'granted' | 'denied' | 'prompt' | 'unknown';
+
+/**
+ * Voice config from notification-configs API
+ */
+interface VoiceConfig {
+    id: string;
+    isEnabled: boolean;
+    name: string;
+    channelType: string;
+    EXOTEL?: {
+        appId: string;
+        appSecret: string;
+        token?: string;
+        tokenExpiresAt?: string;
+    };
+}
+/**
+ * Notification config response structure
+ */
+interface NotificationConfigResponse {
+    config: {
+        id: string;
+        tenantId: string;
+        institutionUniqueId: number;
+        enableVoice?: boolean;
+        voiceConfigs?: VoiceConfig[];
+    };
+    options: {
+        voiceChannels?: string[];
+    };
+}
+/**
+ * Check if VoIP is enabled for the current tenant by fetching notification config.
+ * Returns true only if:
+ * - enableVoice is true
+ * - voiceConfigs has at least one enabled config
+ */
+declare const checkVoIPEnabled: () => Promise<{
+    enabled: boolean;
+    hasValidToken: boolean;
+}>;
+/**
+ * Get the active Exotel voice token from the backend.
+ * The backend manages credentials securely and auto-refreshes tokens.
+ */
+declare const getActiveVoiceToken: () => Promise<{
+    token: string;
+    expiresAt: string;
+} | null>;
+/**
+ * @deprecated Use getActiveVoiceToken instead.
+ * This function is kept for backwards compatibility but will be removed.
+ */
+declare const createExotelAppToken: () => Promise<{
+    Data: string;
+}>;
+interface CallActivity {
+    id: string;
+    callSid: string;
+    prospectId: string;
+    direction: 'inbound' | 'outbound';
+    status: string;
+    durationSeconds?: number;
+    createdAt: string;
+    startTime?: string;
+    endTime?: string;
+    fromNumber?: string;
+    toNumber?: string;
+    userId?: number;
+    dispositionCategory?: string;
+    dispositionReason?: string;
+    dispositionNotes?: string;
+    callStatusDisposition?: 'connected' | 'not_connected';
+    recordingUrl?: string;
+}
+interface InitiateCallInput {
+    prospectId: string;
+    toNumber: string;
+    fromNumber?: string;
+    userId?: number;
+    callSid?: string;
+}
+interface SaveDispositionInput {
+    callId: string;
+    prospectId?: string;
+    callStatusDisposition?: 'connected' | 'not_connected';
+    dispositionCategory: string;
+    dispositionReason?: string;
+    dispositionNotes?: string;
+    callbackScheduledAt?: string;
+}
+interface CancelCallInput {
+    callSid: string;
+    reason?: string;
+}
+interface CallActivityResponse {
+    success: boolean;
+    message: string;
+    data: CallActivity;
+}
+interface RegisterIncomingCallInput {
+    callSid: string;
+    fromNumber: string;
+    toNumber?: string;
+    prospectId?: string;
+    userId?: number;
+}
+interface RegisterIncomingCallResponse {
+    success: boolean;
+    message: string;
+    data: CallActivity;
+    prospect?: {
+        id: string;
+        uniqueId?: number;
+        prospectId?: string;
+        name: string;
+        mobile: string;
+    };
+}
+/**
+ * Initiate an outbound call - creates call activity record
+ */
+declare const initiateCallActivity: (input: InitiateCallInput) => Promise<{
+    success: boolean;
+    message: string;
+    data: CallActivity;
+}>;
+/**
+ * Register an incoming call - creates call activity record
+ */
+declare const registerIncomingCall: (input: RegisterIncomingCallInput) => Promise<RegisterIncomingCallResponse>;
+/**
+ * Fetch call history for a prospect
+ */
+declare const fetchCallHistory: (prospectId: string) => Promise<CallActivity[]>;
+/**
+ * Get call activity by ID
+ */
+declare const getCallActivityById: (id: string) => Promise<CallActivity>;
+/**
+ * Get call activity by CallSid
+ */
+declare const getCallActivityByCallSid: (callSid: string) => Promise<CallActivity>;
+/**
+ * Get call count for a prospect
+ */
+declare const getCallCountByProspect: (prospectId: string) => Promise<number>;
+/**
+ * Save call disposition
+ */
+declare const saveCallDisposition: (input: SaveDispositionInput) => Promise<CallActivity>;
+/**
+ * Cancel/decline a call before it was connected
+ * Updates the call activity status to CANCELED
+ */
+declare const cancelCall: (input: CancelCallInput) => Promise<{
+    success: boolean;
+    message: string;
+}>;
+
+interface CallEventData {
+    callId: string;
+    remoteId: string;
+    remoteDisplayName: string;
+    callDirection: string;
+    callState: string;
+    callDuration: string;
+    callStartedTime: string;
+    callEstablishedTime: string;
+    callEndedTime: string;
+    callAnswerTime: string;
+    callEndReason: string;
+    sessionId: string;
+    callFromNumber?: string;
+    status?: string;
+}
+type CallPhase = 'idle' | 'ready_to_call' | 'calling' | 'incoming' | 'connected' | 'ended';
+interface CallState {
+    phase: CallPhase;
+    callData: CallEventData | null;
+    isOnHold: boolean;
+    isMuted: boolean;
+    isSpeakerOff: boolean;
+    callDirection: 'outbound' | 'inbound' | null;
+    callStartTime: number | null;
+    callDuration: number;
+    callerName: string | null;
+    callerNumber: string | null;
+    callActivityId: string | null;
+    exotelCallSid: string | null;
+    prospectUniqueId: number | null;
+    wasAccepted: boolean;
+}
+interface CallDispositionData {
+    callId: string;
+    exotelCallId: string;
+    callDirection: 'outbound' | 'inbound';
+    callDuration: number;
+    callerName: string | null;
+    callerNumber: string | null;
+}
+interface ExotelContextType {
+    isInitialized: boolean;
+    isConnected: boolean;
+    callState: CallState;
+    permissionStatus: PermissionStatus;
+    dispositionData: CallDispositionData | null;
+    makeCall: (phoneNumber: string, callerName?: string, callActivityId?: string, maskedNumber?: string) => Promise<any>;
+    acceptCall: () => Promise<void>;
+    hangupCall: () => void;
+    rejectCall: () => void;
+    toggleHold: () => void;
+    toggleMute: () => void;
+    toggleSpeaker: () => void;
+    sendDTMF: (digit: string) => void;
+    registerDevice: () => Promise<void>;
+    unregisterDevice: () => void;
+    requestMicrophoneAccess: () => Promise<boolean>;
+    clearDisposition: () => void;
+    setCallActivityId: (callActivityId: string) => void;
+    setExotelCallSid: (callSid: string) => void;
+}
+interface ExotelProviderProps {
+    children: ReactNode;
+    accessToken: string;
+    agentUserId: string;
+    autoConnectVOIP?: boolean;
+    callerName?: string;
+    callerNumber?: string;
+}
+declare const ExotelProvider: React.FC<ExotelProviderProps>;
+declare const useExotel: () => ExotelContextType;
+/**
+ * Safe version of useExotel that returns null when outside the provider
+ * Use this in components that may render outside of ExotelProvider
+ */
+declare const useExotelSafe: () => ExotelContextType | null;
+
+type CallStatusType = 'connected' | 'not_connected';
+interface DispositionFormData {
+    prospectId?: string;
+    callId: string;
+    channel: string;
+    direction: string;
+    duration: number;
+    callStatusDisposition: CallStatusType;
+    dispositionReason?: string;
+    dispositionCategory: string;
+    remarks: string;
+    callerName: string;
+    callerNumber: string;
+}
+interface ExistingDispositionData {
+    callStatusDisposition?: CallStatusType;
+    dispositionCategory?: string;
+    dispositionNotes?: string;
+}
+interface CallDispositionFormProps {
+    dispositionData: CallDispositionData;
+    prospectId?: string;
+    onClose: () => void;
+    onSave: (data: DispositionFormData) => Promise<any>;
+    existingData?: ExistingDispositionData;
+}
+declare const CallDispositionForm: ({ dispositionData, prospectId, onClose, onSave, existingData, }: CallDispositionFormProps) => react_jsx_runtime.JSX.Element;
+
+interface ExotelPhoneProps {
+    className?: string;
+    prospectId?: string;
+    prospectName?: string;
+    prospectNumber?: string;
+    onSaveDisposition?: (data: DispositionFormData) => Promise<any>;
+}
+declare const ExotelPhone: ({ className, prospectId, prospectName, prospectNumber, onSaveDisposition }: ExotelPhoneProps) => react_jsx_runtime.JSX.Element | null;
+
+interface CallButtonProps {
+    phoneNumber?: string;
+    encryptedPhoneNumber?: string;
+    callerName?: string;
+    prospectId?: string;
+    className?: string;
+    disabled?: boolean;
+}
+declare const CallButton: ({ phoneNumber, encryptedPhoneNumber, callerName, prospectId, className, disabled, }: CallButtonProps) => react_jsx_runtime.JSX.Element | null;
+
+interface MicrophonePermissionProps {
+    onPermissionGranted?: () => void;
+    onPermissionDenied?: () => void;
+}
+declare const MicrophonePermission: ({ onPermissionGranted, onPermissionDenied, }: MicrophonePermissionProps) => react_jsx_runtime.JSX.Element;
+
+interface ExotelWrapperProps {
+    children: ReactNode;
+    enabled?: boolean;
+    prospectId?: string;
+    prospectName?: string;
+    prospectNumber?: string;
+}
+/**
+ * Wrapper component that initializes Exotel VoIP functionality
+ * Fetches the access token from backend and provides the Exotel context to children
+ */
+declare const ExotelWrapper: ({ children, enabled, prospectId, prospectName, prospectNumber, }: ExotelWrapperProps) => react_jsx_runtime.JSX.Element;
+
+interface VoIPProviderProps {
+    children: ReactNode;
+    workspace: string;
+    agentUserId?: string;
+    prospectId?: string;
+    prospectName?: string;
+    prospectNumber?: string;
+    onSaveDisposition?: (data: DispositionFormData) => Promise<any>;
+}
+/**
+ * VoIPProvider - Workspace-level VoIP/Exotel integration
+ *
+ * This provider checks if VoIP is enabled for the current workspace AND tenant
+ * and initializes the Exotel SDK if enabled.
+ *
+ * VoIP is enabled only when ALL conditions are met:
+ * 1. Workspace is in VOIP_ENABLED_WORKSPACES (common-workspace, tele-caller-workspace)
+ * 2. Tenant has enableVoice: true in notification config
+ * 3. Tenant has at least one enabled voice config (voiceConfigs[].isEnabled: true)
+ * 4. Active token is available
+ *
+ * Features:
+ * - Workspace-level VoIP enablement
+ * - Tenant-level VoIP configuration check
+ * - Automatic token fetching from backend
+ * - Microphone permission handling
+ * - Floating phone UI for active calls
+ */
+declare const VoIPProvider: React.FC<VoIPProviderProps>;
+
+export { ApplicationStore, BatchSelector, CallButton, CallDispositionForm, ConfirmDialogProvider, CourseSelector, DepartmentMongoMultiSelector, DepartmentSelector, DepartmentSqlMultiSelector, EmployeesSelector, ErrorBoundary, ExamTypeSelector, ExamsRegulationSelector, ExotelPhone, ExotelProvider, ExotelWrapper, FeeTypeSelector, HostelBlockSelector, HostelFloorSelector, HostelRoomSelector, MicrophonePermission, MonthYearSelector, PrintFormatSelector, ProgramSelector, Providers, RegulationSelector, ResearchExpertDesignationSelector, ResearchExpertSelector, ResearchStageSelector, SemesterSelector, SnackbarProvider, StudentSelector, StudentServicesSelector, VOIP_ENABLED_WORKSPACES, VoIPProvider, YearRangeSelector, axios, cancelCall, checkVoIPEnabled, createExotelAppToken, createRsbuildSharedConfig, fetchCallHistory, getActiveVoiceToken, getCallActivityByCallSid, getCallActivityById, getCallCountByProspect, initialApplicationState, initiateCallActivity, institutionCode, isDevelopment, isVoIPEnabledForWorkspace, nonWorkspaceAxios, openInNewTab, registerIncomingCall, saveCallDisposition, tenantCode, useConfirm, useExotel, useExotelSafe, workspace, workspaceApiMapping };
+export type { ApplicationStoreType, CallActivity, CallActivityResponse, CallDispositionData, CallEventData, CallPhase, CallState, CancelCallInput, DispositionFormData, ErrorBoundaryProps, ExistingDispositionData, ExotelContextType, ExotelProviderProps, InitiateCallInput, InstitutionInfo, NotificationConfigResponse, PermissionStatus, RegisterIncomingCallInput, RegisterIncomingCallResponse, SaveDispositionInput, VoiceConfig };