ahs-cti 1.0.0-beta.2 → 1.0.0-beta.21

package/dist/index.d.ts

@@ -1,5 +1,413 @@
 import React from 'react';
 
+/**
+ * @fileoverview TypeScript Declaration File for SDK State Manager
+ * @description Type declarations for the SDK state management system.
+ * Provides type definitions for centralized state management in the Call Control SDK.
+ *
+ * @author CTI SDK Team
+ * @version 6.x.x
+ * @since 2024
+ */
+
+/**
+ * Inline type definitions to avoid Rollup DTS bundler resolution issues
+ * with relative imports from handwritten .d.ts files.
+ */
+type SDKConfig$1 = {
+	disableEndCallButton?: boolean;
+	enableSmsServices?: boolean;
+	enableQueueName?: boolean;
+	enableRingtone?: boolean;
+	disabledMoreOptionsButton?: boolean;
+	disabledDialButton?: boolean;
+	disableCallTransferButton?: boolean;
+	disableBlindTransfer?: boolean;
+	disableAttendedTransfer?: boolean;
+	disableWarmTransfer?: boolean;
+	isDraggable?: boolean;
+	disableSoftPhone?: boolean;
+	disableConferenceButton?: boolean;
+	disableHoldButton?: boolean;
+	disableMuteButton?: boolean;
+	disabled?: any;
+	enabled?: any;
+	outlined?: any;
+	auto_wrapup_time?: number;
+	break_time?: number;
+	sdkPosition?: "horizontal" | "vertical";
+};
+
+type CallStatus =
+	| "IDLE"
+	| "READY"
+	| "BREAK"
+	| "ONCALL"
+	| "WRAPUP"
+	| "RINGING"
+	| "DIALING"
+	| "MISSED"
+	| "HOLD"
+	| "UNHOLD"
+	| "MUTE"
+	| "UNMUTE"
+	| "DISCONNECTED"
+	| "CONFERENCE"
+	| string;
+
+type CallData$1 = {
+	mode?: string;
+	queue_name?: string;
+	mobileNumber?: string;
+	callReferenceId?: string;
+	convoxId?: string;
+	type?: string;
+	status: string;
+	agent_id: number;
+	phone_number?: string;
+	event_time?: string;
+	convox_id?: string;
+	process_id?: string;
+	process_name?: string;
+	mute?: number;
+	hold?: number;
+};
+
+type ConferenceLineTypes = {
+	line: number;
+	status: string;
+	type: "external" | "internal" | "";
+	phone: string;
+	isMute: boolean;
+	isHold: boolean;
+	isCallStart: boolean;
+	isMergeCall: boolean;
+};
+
+type SDKState$1 = {
+	authorization: any;
+	openConferenceDialog: boolean;
+	openCallTransferDialog: boolean;
+	process?: { process_id: number; process_name: string } | null;
+	agentId: string;
+	sessionId?: string;
+	sdkConfig: SDKConfig$1 | null;
+	urlConfig: any | null;
+	isInitialized: boolean;
+	convox_id?: string;
+	process_id?: number;
+	callStartTime: number | null;
+	position?: { x: number; y: number };
+	controlPanelPosition: { x: number; y: number };
+	iframePosition: { x: number; y: number };
+	callData: CallData$1;
+	conferenceLine: ConferenceLineTypes[];
+	hold: number;
+	mute: number;
+	agentStatus: string;
+	sdk: any | null;
+	isPermissionsLoaded: boolean;
+	userPermissions: string[] | null;
+	menuEntitlements: Array<{ code: string; name: string; enabled: boolean }> | null;
+	consultInfo: any | null;
+};
+
+/**
+ * @interface SDKStateManager
+ * @description Interface for the SDK state manager class
+ */
+interface SDKStateManager {
+	/**
+	 * Initialize the SDK with API key, tenant ID, agent ID, and optional configuration
+	 * @param apiKey - API key for authentication
+	 * @param tenantId - Tenant identifier
+	 * @param agentId - Agent identifier
+	 * @param urlConfig - Optional URL configuration
+	 * @param res - Optional initialization response
+	 * @param callControlConfig - Optional call control configuration
+	 */
+	initialize(apiKey: string, tenantId: string, agentId: string, urlConfig?: any, res?: any, callControlConfig?: SDKConfig$1): void;
+
+	/**
+	 * Get the current state
+	 * @returns Current SDK state
+	 */
+	getState(): SDKState$1;
+
+	/**
+	 * Subscribe to state changes
+	 * @param listener - Callback function to be called on state changes
+	 * @returns Unsubscribe function
+	 */
+	subscribe(listener: () => void): () => void;
+
+	/**
+	 * Set holding state
+	 * @param isHolding - Whether call is on hold
+	 */
+	setHolding(isHolding: boolean): void;
+
+	/**
+	 * Set muted state
+	 * @param isMuted - Whether call is muted
+	 */
+	setMuted(isMuted: boolean): void;
+
+	/**
+	 * Set call status
+	 * @param status - Current call status
+	 */
+	setStatus(status: CallStatus): void;
+
+	/**
+	 * Set process information
+	 * @param process - Process data with ID and name
+	 */
+	setProcess(process: { process_id: number; process_name: string }): void;
+
+	/**
+	 * Set control panel position
+	 * @param position - X and Y coordinates
+	 */
+	setControlPanelPosition(position: { x: number; y: number }): void;
+
+	/**
+	 * Set iframe position
+	 * @param position - X and Y coordinates
+	 */
+	setIframePosition(position: { x: number; y: number }): void;
+
+	/**
+	 * Start a call (set start time and status)
+	 */
+	startCall(): void;
+
+	/**
+	 * End a call (reset call state)
+	 */
+	endCall(): void;
+
+	/**
+	 * Set initialization check flag
+	 */
+	setInitCheck(): void;
+
+	/**
+	 * Set conference dialog open state
+	 * @param open - Whether conference dialog is open
+	 */
+	setOpenConferenceDialog(open: boolean): void;
+
+	/**
+	 * Set call transfer dialog open state
+	 * @param open - Whether call transfer dialog is open
+	 */
+	setOpenCallTransferDialog(open: boolean): void;
+
+	/**
+	 * Update call data
+	 * @param data - Partial call data to update
+	 */
+	updateCallData(data: Partial<CallData$1>): void;
+
+	/**
+	 * Update conference data
+	 * @param data - Array of conference line data
+	 */
+	updateConferenceData(data: ConferenceLineTypes[]): void;
+
+	/**
+	 * Set specific conference line
+	 * @param line - Conference line data
+	 */
+	setConferenceLine(line: ConferenceLineTypes): void;
+
+	/**
+	 * Reset conference lines to initial state
+	 */
+	resetConferenceLines(): void;
+
+	/**
+	 * Clear storage and reset to initial state
+	 */
+	clearStorageAndReset(): void;
+
+	/**
+	 * Debug storage data
+	 */
+	debugStorage(): void;
+
+	/**
+	 * Get conference lines
+	 * @returns Array of conference line data
+	 */
+	getConferenceLines(): ConferenceLineTypes[];
+
+	/**
+	 * Set SDK permissions from user info
+	 * @param userInfo - User info object from init response
+	 */
+	setSDKPermissions(userInfo: any): void;
+
+	/**
+	 * Get entitlement-based controls configuration
+	 * @returns Controls configuration derived from permissions
+	 */
+	getControlsConfig(): Partial<SDKConfig$1>;
+}
+
+/**
+ * @class SDKStateManager
+ * @description Centralized state management class for the Call Control SDK.
+ * Handles state persistence, subscriptions, and provides methods for state updates.
+ */
+declare class SDKStateManager implements SDKStateManager {
+	/**
+	 * Initialize the SDK with API key, tenant ID, agent ID, and optional configuration
+	 * @param apiKey - API key for authentication
+	 * @param tenantId - Tenant identifier
+	 * @param agentId - Agent identifier
+	 * @param urlConfig - Optional URL configuration
+	 * @param res - Optional initialization response
+	 * @param callControlConfig - Optional call control configuration
+	 */
+	public initialize(apiKey: string, tenantId: string, agentId: string, urlConfig?: any, res?: any, callControlConfig?: SDKConfig$1): void;
+
+	/**
+	 * Get the current state
+	 * @returns Current SDK state
+	 */
+	public getState(): SDKState$1;
+
+	/**
+	 * Subscribe to state changes
+	 * @param listener - Callback function to be called on state changes
+	 * @returns Unsubscribe function
+	 */
+	public subscribe(listener: () => void): () => void;
+
+	/**
+	 * Set holding state
+	 * @param isHolding - Whether call is on hold
+	 */
+	public setHolding(isHolding: boolean): void;
+
+	/**
+	 * Set muted state
+	 * @param isMuted - Whether call is muted
+	 */
+	public setMuted(isMuted: boolean): void;
+
+	/**
+	 * Set call status
+	 * @param status - Current call status
+	 */
+	public setStatus(status: CallStatus): void;
+
+	/**
+	 * Set process information
+	 * @param process - Process data with ID and name
+	 */
+	public setProcess(process: { process_id: number; process_name: string }): void;
+
+	/**
+	 * Set control panel position
+	 * @param position - X and Y coordinates
+	 */
+	public setControlPanelPosition(position: { x: number; y: number }): void;
+
+	/**
+	 * Set iframe position
+	 * @param position - X and Y coordinates
+	 */
+	public setIframePosition(position: { x: number; y: number }): void;
+
+	/**
+	 * Start a call (set start time and status)
+	 */
+	public startCall(): void;
+
+	/**
+	 * End a call (reset call state)
+	 */
+	public endCall(): void;
+
+	/**
+	 * Set initialization check flag
+	 */
+	public setInitCheck(): void;
+
+	/**
+	 * Set conference dialog open state
+	 * @param open - Whether conference dialog is open
+	 */
+	public setOpenConferenceDialog(open: boolean): void;
+
+	/**
+	 * Set call transfer dialog open state
+	 * @param open - Whether call transfer dialog is open
+	 */
+	public setOpenCallTransferDialog(open: boolean): void;
+
+	/**
+	 * Update call data
+	 * @param data - Partial call data to update
+	 */
+	public updateCallData(data: Partial<CallData$1>): void;
+
+	/**
+	 * Update conference data
+	 * @param data - Array of conference line data
+	 */
+	public updateConferenceData(data: ConferenceLineTypes[]): void;
+
+	/**
+	 * Set specific conference line
+	 * @param line - Conference line data
+	 */
+	public setConferenceLine(line: ConferenceLineTypes): void;
+
+	/**
+	 * Reset conference lines to initial state
+	 */
+	public resetConferenceLines(): void;
+
+	/**
+	 * Clear storage and reset to initial state
+	 */
+	public clearStorageAndReset(): void;
+
+	/**
+	 * Debug storage data
+	 */
+	public debugStorage(): void;
+
+	/**
+	 * Get conference lines
+	 * @returns Array of conference line data
+	 */
+	public getConferenceLines(): ConferenceLineTypes[];
+
+	/**
+	 * Set SDK permissions from user info
+	 * @param userInfo - User info object from init response
+	 */
+	public setSDKPermissions(userInfo: any): void;
+
+	/**
+	 * Get entitlement-based controls configuration
+	 * @returns Controls configuration derived from permissions
+	 */
+	public getControlsConfig(): Partial<SDKConfig$1>;
+}
+
+/**
+ * @constant sdkStateManager
+ * @description Singleton instance of the SDK state manager
+ * @type {SDKStateManager}
+ */
+declare const sdkStateManager: SDKStateManager;
+
 /**
  * @fileoverview 📦 TypeScript Declaration File for Call Control SDK
  * @description Comprehensive CTI (Computer Telephony Integration) SDK for agent platform applications.
@@ -168,6 +576,21 @@ declare function isSDKInitialized(): boolean;
  */
 declare const CallControlPanel: React.ComponentType<CallControlPanelProps>;
 
+/**
+ * 📄 SDK Pages
+ *
+ * @description Pre-built pages provided by the SDK, automatically protected by permission guards.
+ *
+ * @properties
+ * - `CallHistory` - Call History page component
+ *
+ * @since 1.0.0
+ * @author CTI SDK Team
+ */
+declare const SDKPages: {
+	readonly CallHistory: React.ComponentType<any>;
+};
+
 // =============================================================================
 // 🗃️ TYPE EXPORTS
 // =============================================================================
@@ -235,14 +658,14 @@ interface SDKConfig {
 }
 
 interface URLConfig {
-	id: string;
+	id?: string;
 	baseURL: string;
 	iframeURL: string;
 	iframeAPIURL: string;
 	password: string;
 	webSocketURL: string;
 	coreBaseURL: string;
-	accessToken?: string;
+	accessToken: string;
 }
 
 /**
@@ -1292,6 +1715,11 @@ interface StartCallPayload {
 	mobileNumber: string;
 }
 
+interface ConferenceCallPayload {
+	mobileNumber: string;
+	lineNumber?: number;
+}
+
 /**
  * 📞 Call Initiation Function Type
  *
@@ -1790,6 +2218,65 @@ interface ErrorResponse {
 	 * @type {any}
 	 */
 	details?: any;
-}
+}
+
+
+// =============================================================================
+// ⚡ FRAMEWORK-AGNOSTIC ACTION EXPORTS (for Angular / non-React consumers)
+// =============================================================================
+
+interface EndCallOptions {
+  disposition?: string;
+  followUp?: string;
+  callbackDate?: string;
+  callbackHrs?: string;
+  callbackMins?: string;
+  isBreak?: boolean;
+  patientLog?: any;
+}
+
+type SupervisorMonitorMode = "listen" | "whisper" | "barge";
+
+interface StartMonitoringPayload {
+  call_id: string;
+  mode: SupervisorMonitorMode;
+  supervisor_extension?: string;
+  agent_extension?: string;
+}
+
+interface StopMonitoringPayload {
+  call_uuid: string;
+  session_id?: string;
+}
+
+interface ChangeModePayload {
+  call_uuid: string;
+  mode: SupervisorMonitorMode;
+  session_id?: string;
+}
+
+declare function clickToCall(payload: StartCallPayload): Promise<any>;
+declare function clickToConference(payload: ConferenceCallPayload): Promise<any>;
+declare function endCall(options?: EndCallOptions): Promise<any>;
+declare function logout(): Promise<void>;
+declare function startMonitoring(payload: StartMonitoringPayload): Promise<any>;
+declare function stopMonitoring(payload: StopMonitoringPayload): Promise<any>;
+declare function changeMonitorMode(payload: ChangeModePayload): Promise<any>;
+
+// =============================================================================
+// ⚛️ REACT HOOKS
+// =============================================================================
+
+interface UseClickToConferenceReturn {
+  handleStartConferenceCall: (payload: ConferenceCallPayload) => Promise<any>;
+  isLoading: boolean;
+  isSuccess: boolean;
+  isError: boolean;
+  error: any;
+  data: any;
+}
+
+declare function useClickToConference(): UseClickToConferenceReturn;
 
-export { type APIResponse, type AgentStatus, CallControlPanel, type CallControlPanelProps, type CallData, type CallInitiationFunction, type CallTerminationFunction, type CleanupOperation, type ConferenceLine, type DispositionType, type EndCallData, type EndCallPayLoadData, type EndCallPayload, type ErrorResponse, type FollowUpType, type HookStateTypes, type InitSDKParams, type LogoutFunction, type LogoutHookStateTypes, type LogoutPayload, type ProcessData, type SDKConfig, type SDKState, type StartCallPayload, type StartCalltData, type StartCalltHookStateTypes, type StorageType, type URLConfig, type UseClickToCallReturn, type UseEndCallReturn, type UseLogoutReturn, getSDKVersion, initSDK, isSDKInitialized, useClickToCall, useEndCall, useGetAuthorizationToken, useGetCallerData, useLogout };
+export type { APIResponse, AgentStatus, CallControlPanelProps, CallData, CallInitiationFunction, CallTerminationFunction, ChangeModePayload, CleanupOperation, ConferenceCallPayload, ConferenceLine, DispositionType, EndCallData, EndCallOptions, EndCallPayLoadData, EndCallPayload, ErrorResponse, FollowUpType, HookStateTypes, InitSDKParams, LogoutFunction, LogoutHookStateTypes, LogoutPayload, ProcessData, SDKConfig, SDKState, StartCallPayload, StartCalltData, StartCalltHookStateTypes, StartMonitoringPayload, StopMonitoringPayload, StorageType, SupervisorMonitorMode, URLConfig, UseClickToCallReturn, UseClickToConferenceReturn, UseEndCallReturn, UseLogoutReturn }
+export { CallControlPanel, SDKPages, SDKStateManager, changeMonitorMode, clickToCall, clickToConference, endCall, getSDKVersion, initSDK, isSDKInitialized, logout, sdkStateManager, startMonitoring, stopMonitoring, useClickToCall, useClickToConference, useEndCall, useGetAuthorizationToken, useGetCallerData, useLogout };