call-control-sdk 6.4.1 → 6.4.3

package/README.md

@@ -303,10 +303,10 @@ export default function LogoutButton() {
 get Authorization token for external API call
 
 ```tsx
-import { getAuthorizationToken } from "call-control-sdk";
+import { useGetAuthorizationToken } from "call-control-sdk";
 
 export default function axios() {
-	const token = getAuthorizationToken();
+	const token = useGetAuthorizationToken();
 
 	console.log(token);
 }

package/dist/index.d.mts

@@ -979,6 +979,148 @@ interface UseLogoutReturn extends LogoutHookStateTypes {
  */
 declare const useLogout: () => UseLogoutReturn;
 
+/**
+ * 🔐 Authorization Token Custom Hook
+ *
+ * @function useGetAuthorizationToken
+ * @description 🎯 Custom hook that provides reactive access to the current SDK authorization token.
+ *              Automatically updates when the token changes, making it perfect for external API calls
+ *              and authentication headers.
+ *
+ * @returns {string | undefined} Current authorization token or undefined if not available
+ *
+ * @example
+ * ```typescript
+ * // Basic usage in a component
+ * const ApiCallComponent = () => {
+ *   const token = useGetAuthorizationToken();
+ *
+ *   const makeExternalApiCall = async () => {
+ *     if (!token) {
+ *       console.error('No authorization token available');
+ *       return;
+ *     }
+ *
+ *     try {
+ *       const response = await fetch('/api/external', {
+ *         headers: {
+ *           'Authorization': `Bearer ${token}`,
+ *           'Content-Type': 'application/json'
+ *         }
+ *       });
+ *       const data = await response.json();
+ *       console.log('External API response:', data);
+ *     } catch (error) {
+ *       console.error('API call failed:', error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <button onClick={makeExternalApiCall} disabled={!token}>
+ *       {token ? 'Make API Call' : 'No Token Available'}
+ *     </button>
+ *   );
+ * };
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Usage with axios
+ * const ApiService = () => {
+ *   const token = useGetAuthorizationToken();
+ *
+ *   useEffect(() => {
+ *     if (token) {
+ *       // Configure axios with the token
+ *       axios.defaults.headers.common['Authorization'] = `Bearer ${token}`;
+ *     }
+ *   }, [token]);
+ *
+ *   return null; // This is just for token management
+ * };
+ * ```
+ *
+ *
+ * @since 1.0.0
+ * @author CTI SDK Team
+ */
+declare const useGetAuthorizationToken: () => string | undefined;
+
+/**
+ * 📞 Caller Data Custom Hook
+ *
+ * @function useGetCallerData
+ * @description 🎯 Custom hook that provides reactive access to current call data.
+ *              This is an independent alternative to the CallControlPanel's onDataChange prop,
+ *              allowing you to access call information anywhere in your application without
+ *              depending on the CallControlPanel component.
+ *
+ * @returns {CallData} Current call data object containing all available call information
+ *
+ * @example
+ * ```typescript
+ * // Basic usage in a component
+ * const CallStatusWidget = () => {
+ *   const callerData = useGetCallerData();
+ *
+ *   return (
+ *     <div className="call-status-widget">
+ *       <h3>Current Call Status</h3>
+ *       {callerData.status === "ONCALL" ? (
+ *         <div>
+ *           <p>📞 Active Call: {callerData.phone_number}</p>
+ *           <p>Agent: {callerData.agent_id}</p>
+ *           <p>Process: {callerData.process_name}</p>
+ *           <p>Call ID: {callerData.callReferenceId}</p>
+ *         </div>
+ *       ) : (
+ *         <p>No active call</p>
+ *       )}
+ *     </div>
+ *   );
+ * };
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Usage for call analytics
+ * const CallAnalytics = () => {
+ *   const callerData = useGetCallerData();
+ *
+ *   useEffect(() => {
+ *     if (callerData.status === "ONCALL") {
+ *       // Track call start
+ *       analytics.track('call_started', {
+ *         phone_number: callerData.phone_number,
+ *         agent_id: callerData.agent_id,
+ *         process_name: callerData.process_name
+ *       });
+ *     }
+ *   }, [callerData.status]);
+ *
+ *   return null; // This is just for analytics
+ * };
+ * ```
+ *
+ *
+ *
+ * @returns_data_structure
+ * ```typescript
+ * {
+ *   phone_number: string,        // Phone number involved in the call
+ *   status: string,             // Current call status (ONCALL, RINGING, WRAPUP, etc.)
+ *   callReferenceId: string,     // Unique identifier for the call
+ *   agent_id: string,           // ID of the agent handling the call
+ *   process_id: string,         // Process identifier for the call
+ *   process_name: string        // Name of the process handling the call
+ * }
+ * ```
+ *
+ * @since 1.0.0
+ * @author CTI SDK Team
+ */
+declare const useGetCallerData: () => CallData;
+
 /**
  * 🗃️ SDK State Interface
  *
@@ -1635,4 +1777,4 @@ interface ErrorResponse {
 	details?: any;
 }
 
-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 UseClickToCallReturn, type UseEndCallReturn, type UseLogoutReturn, getSDKVersion, initSDK, isSDKInitialized, useClickToCall, useEndCall, useLogout };
+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 UseClickToCallReturn, type UseEndCallReturn, type UseLogoutReturn, getSDKVersion, initSDK, isSDKInitialized, useClickToCall, useEndCall, useGetAuthorizationToken, useGetCallerData, useLogout };

package/dist/index.d.ts

@@ -979,6 +979,148 @@ interface UseLogoutReturn extends LogoutHookStateTypes {
  */
 declare const useLogout: () => UseLogoutReturn;
 
+/**
+ * 🔐 Authorization Token Custom Hook
+ *
+ * @function useGetAuthorizationToken
+ * @description 🎯 Custom hook that provides reactive access to the current SDK authorization token.
+ *              Automatically updates when the token changes, making it perfect for external API calls
+ *              and authentication headers.
+ *
+ * @returns {string | undefined} Current authorization token or undefined if not available
+ *
+ * @example
+ * ```typescript
+ * // Basic usage in a component
+ * const ApiCallComponent = () => {
+ *   const token = useGetAuthorizationToken();
+ *
+ *   const makeExternalApiCall = async () => {
+ *     if (!token) {
+ *       console.error('No authorization token available');
+ *       return;
+ *     }
+ *
+ *     try {
+ *       const response = await fetch('/api/external', {
+ *         headers: {
+ *           'Authorization': `Bearer ${token}`,
+ *           'Content-Type': 'application/json'
+ *         }
+ *       });
+ *       const data = await response.json();
+ *       console.log('External API response:', data);
+ *     } catch (error) {
+ *       console.error('API call failed:', error);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <button onClick={makeExternalApiCall} disabled={!token}>
+ *       {token ? 'Make API Call' : 'No Token Available'}
+ *     </button>
+ *   );
+ * };
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Usage with axios
+ * const ApiService = () => {
+ *   const token = useGetAuthorizationToken();
+ *
+ *   useEffect(() => {
+ *     if (token) {
+ *       // Configure axios with the token
+ *       axios.defaults.headers.common['Authorization'] = `Bearer ${token}`;
+ *     }
+ *   }, [token]);
+ *
+ *   return null; // This is just for token management
+ * };
+ * ```
+ *
+ *
+ * @since 1.0.0
+ * @author CTI SDK Team
+ */
+declare const useGetAuthorizationToken: () => string | undefined;
+
+/**
+ * 📞 Caller Data Custom Hook
+ *
+ * @function useGetCallerData
+ * @description 🎯 Custom hook that provides reactive access to current call data.
+ *              This is an independent alternative to the CallControlPanel's onDataChange prop,
+ *              allowing you to access call information anywhere in your application without
+ *              depending on the CallControlPanel component.
+ *
+ * @returns {CallData} Current call data object containing all available call information
+ *
+ * @example
+ * ```typescript
+ * // Basic usage in a component
+ * const CallStatusWidget = () => {
+ *   const callerData = useGetCallerData();
+ *
+ *   return (
+ *     <div className="call-status-widget">
+ *       <h3>Current Call Status</h3>
+ *       {callerData.status === "ONCALL" ? (
+ *         <div>
+ *           <p>📞 Active Call: {callerData.phone_number}</p>
+ *           <p>Agent: {callerData.agent_id}</p>
+ *           <p>Process: {callerData.process_name}</p>
+ *           <p>Call ID: {callerData.callReferenceId}</p>
+ *         </div>
+ *       ) : (
+ *         <p>No active call</p>
+ *       )}
+ *     </div>
+ *   );
+ * };
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Usage for call analytics
+ * const CallAnalytics = () => {
+ *   const callerData = useGetCallerData();
+ *
+ *   useEffect(() => {
+ *     if (callerData.status === "ONCALL") {
+ *       // Track call start
+ *       analytics.track('call_started', {
+ *         phone_number: callerData.phone_number,
+ *         agent_id: callerData.agent_id,
+ *         process_name: callerData.process_name
+ *       });
+ *     }
+ *   }, [callerData.status]);
+ *
+ *   return null; // This is just for analytics
+ * };
+ * ```
+ *
+ *
+ *
+ * @returns_data_structure
+ * ```typescript
+ * {
+ *   phone_number: string,        // Phone number involved in the call
+ *   status: string,             // Current call status (ONCALL, RINGING, WRAPUP, etc.)
+ *   callReferenceId: string,     // Unique identifier for the call
+ *   agent_id: string,           // ID of the agent handling the call
+ *   process_id: string,         // Process identifier for the call
+ *   process_name: string        // Name of the process handling the call
+ * }
+ * ```
+ *
+ * @since 1.0.0
+ * @author CTI SDK Team
+ */
+declare const useGetCallerData: () => CallData;
+
 /**
  * 🗃️ SDK State Interface
  *
@@ -1635,4 +1777,4 @@ interface ErrorResponse {
 	details?: any;
 }
 
-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 UseClickToCallReturn, type UseEndCallReturn, type UseLogoutReturn, getSDKVersion, initSDK, isSDKInitialized, useClickToCall, useEndCall, useLogout };
+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 UseClickToCallReturn, type UseEndCallReturn, type UseLogoutReturn, getSDKVersion, initSDK, isSDKInitialized, useClickToCall, useEndCall, useGetAuthorizationToken, useGetCallerData, useLogout };