@voicenter-team/events-sdk 0.0.38 → 0.0.41

package/dist/voicenter-events-sdk.d.ts

@@ -1,13 +1,15 @@
 import { DebouncedFuncLeading } from 'lodash';
 import { io } from 'socket.io-client';
-import { LoggerOptions } from '@voicenter-team/socketio-storage-logger/dist/storage-logger';
+import { LoggerOptions } from '@voicenter-team/socketio-storage-logger';
 import { Socket as Socket_2 } from 'socket.io-client';
 
 export declare type ActiveRoomListener = (event: number | undefined) => void
 
 export declare type addRoomListener = (value: string) => void
 
-export declare type AllDialersStatusEvent = {
+export declare type AllDialersStatusEvent = EventTypeData<EventsEnum.ALL_DIALER_STATUS>
+
+declare type AllDialersStatusEvent_2 = {
     dialers: Array<Dialer>;
     /**
      * 0 - Connection was establishing successfully.
@@ -27,7 +29,9 @@ export declare type AllDialersStatusEvent = {
     serverTimeOffset: number;
 };
 
-export declare type AllExtensionStatusEvent = {
+export declare type AllExtensionStatusEvent = EventTypeData<EventsEnum.ALL_EXTENSION_STATUS>
+
+declare type AllExtensionStatusEvent_2 = {
     /**
      * 0 - Connection was establishing successfully.
      */
@@ -40,14 +44,20 @@ export declare type AllExtensionStatusEvent = {
     /**
      * Server time at the moment of the event
      */
-    serverTime: number;
+    servertime: number;
     /**
      * Difference in time between server and client
      */
-    serverTimeOffset: number;
+    servertimeoffset: number;
 };
 
-export declare type AllUsersStatusEvent = {
+declare interface AllExtensionStatusEventExtended extends Omit<AllExtensionStatusEvent_2, 'extensions'> {
+    extensions: Array<ExtensionDataExtended>
+}
+
+export declare type AllUsersStatusEvent = EventTypeData<EventsEnum.ALL_USERS_STATUS>
+
+declare type AllUsersStatusEvent_2 = {
     users: Array<User>;
     /**
      * 0 - Connection was establishing successfully.
@@ -87,14 +97,14 @@ declare class AuthClass {
 
 export declare type CallAddingProgressListener = (callId: string | undefined) => void
 
-export declare enum CallStatusEnum {
+declare enum CallStatusEnum {
     RINGING = 'Ringing',
     TALKING = 'Talking',
     DIALING = 'Dialing',
     HOLD = 'Hold',
 }
 
-export declare enum CallTypeEnum {
+declare enum CallTypeEnum {
     INCOMING = 'Incoming',
     OUTGOING = 'Outgoing',
 }
@@ -113,7 +123,18 @@ export declare type changeIsMutedListener = (value: boolean) => void
 
 export declare type changeMuteWhenJoinListener = (value: boolean) => void
 
-export declare type CustomData = {
+declare interface CurrentCallEnded extends CurrentCallUTCExtended {
+    duration: number
+}
+
+declare interface CurrentCallUTCExtended extends ExtensionCall {
+    callStarted_UTC: number
+    callStarted_UTC_CLIENT: number
+    callAnswered_UTC: number
+    callAnswered_UTC_CLIENT: number
+}
+
+declare type CustomData = {
     /**
      * Is do not call me
      */
@@ -133,7 +154,7 @@ export declare type CustomData = {
     DoNotCallMetransactionId?: string;
 };
 
-export declare type Dialer = {
+declare type Dialer = {
     /**
      * Code
      */
@@ -161,7 +182,9 @@ export declare type Dialer = {
     statistics: string;
 };
 
-export declare type DialerEvent = {
+export declare type DialerEvent = EventTypeData<EventsEnum.DIALER_EVENT>
+
+declare type DialerEvent_2 = {
     data: Dialer;
     /**
      * callerID
@@ -185,27 +208,23 @@ export declare type DialerEvent = {
     telephonyServerTime?: number;
 };
 
-export declare enum DialerTypeEnum {
+declare enum DialerTypeEnum {
     AUTOMATIC = 'Automatic',
     IVR = 'IVR',
 }
 
-export declare enum DirectionEnum {
+declare enum DirectionEnum {
     INCOMINC = 'Incoming',
     OUTGOING = 'Outgoing',
     SPY = 'Spy',
     CLICK2CALL = 'Click2Call',
 }
 
-export declare enum DoNotCallMeStatusCodeEnum {
+declare enum DoNotCallMeStatusCodeEnum {
     RESPONSE_FROM_API_VALID = 'RESPONSE_FROM_API_VALID',
     RESPONSE_FROM_API_INVALID = 'RESPONSE_FROM_API_INVALID',
 }
 
-declare type Error_2 = {
-};
-export { Error_2 as Error }
-
 /**
  * This type defines a map where each key is an event name, and the value is an array of callback functions associated with that event.
  * This structure is used to manage event listeners for different events
@@ -223,21 +242,33 @@ export declare type EventCallbackRegistry = {
     [K in EventTypeNames]: (data: EventDataMap[K]) => void
 }
 
+export declare type EventData = EventDataMapExtended[EventsEnum]
+
 /**
  * Mapping of event names to their respective data structures.
+ * The data structures that socket io will send us
  */
 export declare interface EventDataMap {
-    [EventsEnum.ALL_EXTENSION_STATUS]: AllExtensionStatusEvent
-    [EventsEnum.ALL_DIALER_STATUS]: AllDialersStatusEvent
-    [EventsEnum.ALL_USERS_STATUS]: AllUsersStatusEvent
-    [EventsEnum.QUEUE_EVENT]: QueueEvent
-    [EventsEnum.EXTENSION_EVENT]: ExtensionEvent
-    [EventsEnum.DIALER_EVENT]: DialerEvent
-    [EventsEnum.LOGIN_SUCCESS]: LoginSuccessEvent
-    [EventsEnum.LOGIN_STATUS]: LoginStatusEvent
-    [EventsEnum.KEEP_ALIVE_RESPONSE]: KeepAliveResponseEvent
-    [EventsEnum.ONLINE_STATUS_EVENT]: OnlineStatusEvent
-    [EventsEnum.EXTENSIONS_UPDATED]: ExtensionsUpdated
+    [EventsEnum.ALL_EXTENSION_STATUS]: AllExtensionStatusEvent_2
+    [EventsEnum.ALL_DIALER_STATUS]: AllDialersStatusEvent_2
+    [EventsEnum.ALL_USERS_STATUS]: AllUsersStatusEvent_2
+    [EventsEnum.QUEUE_EVENT]: QueueEvent_2
+    [EventsEnum.EXTENSION_EVENT]: ExtensionEvent_2
+    [EventsEnum.DIALER_EVENT]: DialerEvent_2
+    [EventsEnum.LOGIN_SUCCESS]: LoginSuccessEvent_2
+    [EventsEnum.LOGIN_STATUS]: LoginStatusEvent_2
+    [EventsEnum.KEEP_ALIVE_RESPONSE]: KeepAliveResponseEvent_2
+    [EventsEnum.ONLINE_STATUS_EVENT]: OnlineStatusEvent_2
+    [EventsEnum.EXTENSIONS_UPDATED]: ExtensionsUpdated_2
+}
+
+/**
+ * Mapping of event names to their respective data structures.
+ * The data structures that we will send to the end user, here we can modify the type of events data
+ */
+export declare interface EventDataMapExtended extends EventDataMap {
+    [EventsEnum.EXTENSION_EVENT]: ExtensionEventExtended
+    [EventsEnum.ALL_EXTENSION_STATUS]: AllExtensionStatusEventExtended
 }
 
 declare class EventEmitterClass {
@@ -245,14 +276,13 @@ declare class EventEmitterClass {
     private listeners;
     private allListeners;
     constructor(eventsSdkClass: EventsSdkClass);
-    on<T extends EventTypeNames>(event: T, callback: EventSpecificCallback<T>): void;
-    on(event: '*', callback: (data: GenericEventWrapper) => void): void;
+    on(event: unknown, callback: unknown): void;
     off<T extends EventTypeNames>(event: T, callback: EventSpecificCallback<T>): void;
     off(event: '*', callback: (data: GenericEventWrapper) => void): void;
     emit<T extends EventTypeNames>(event: T, data: EventTypeData<T>): void;
 }
 
-export declare enum EventsEnum {
+declare enum EventsEnum {
     ALL_DIALER_STATUS = 'AllDialersStatus',
     ALL_EXTENSION_STATUS = 'AllExtensionsStatus',
     ALL_USERS_STATUS = 'AllUsersStatus',
@@ -294,7 +324,8 @@ declare class EventsSdkClass {
     retryConnection: DebouncedFuncLeading<(serverParameter: ServerParameter) => void>;
     constructor(options: EventsSdkOptions);
     on<T extends EventTypeNames>(event: T, callback: EventSpecificCallback<T>): void;
-    emit(event: EventsEnum, data: unknown): void;
+    on(event: '*', callback: (data: GenericEventWrapper) => void): void;
+    emit<T extends ServerEmitEventTypeNames>(event: T, ...args: Parameters<ServerEmitEventCallbackRegistry[T]>): void;
     connect(serverParameter: ServerParameter): void;
     disconnect(): void;
     clearKeepAliveInterval(): void;
@@ -338,7 +369,10 @@ export declare interface EventsSdkOptions {
     username: string;
 }
 
-export declare type EventTypeData<T extends EventsEnum> = EventDataMap[T]
+/**
+ * The structure of event data for a specific event type.
+ */
+export declare type EventTypeData<T extends EventsEnum> = EventDataMapExtended[T]
 
 /**
  * Represents the set of all possible event type names as keys from the EventDataMap.
@@ -389,7 +423,7 @@ export declare type EventWrappedSocketDataMap = {
     [K in EventTypeNames]: WrappedSocketEvent<K>
 }
 
-export declare type Extension = {
+declare type Extension = {
     calls: Array<ExtensionCall>;
     /**
      * Number
@@ -451,7 +485,7 @@ export declare type Extension = {
     lastAnsweredCallEventEpoch: number;
 };
 
-export declare type ExtensionCall = {
+declare type ExtensionCall = {
     /**
      * Ip
      */
@@ -481,10 +515,6 @@ export declare type ExtensionCall = {
      */
     answered: number;
     callType?: CallTypeEnum;
-    /**
-     * duration
-     */
-    duration?: number;
     /**
      * Channel 2
      */
@@ -525,14 +555,6 @@ export declare type ExtensionCall = {
      * Call answered
      */
     callAnswered: number;
-    /**
-     * callStartedUTC
-     */
-    callStartedUTC?: number;
-    /**
-     * callAnsweredUTC
-     */
-    callAnsweredUTC?: number;
     /**
      * Original caller id
      */
@@ -557,21 +579,21 @@ export declare type ExtensionCall = {
      * Related ivr unique ids
      */
     relatedIvrUniqueIDs?: Array<string>;
-    /**
-     * callStartedUTCClient
-     */
-    callStartedUTCClient?: number;
     /**
      * Call duration interval
      */
     calldurationinterval: number;
-    /**
-     * callAnsweredUTCClient
-     */
-    callAnsweredUTCClient?: number;
 };
 
-export declare type ExtensionEvent = {
+declare type ExtensionDataExtended = ExtensionUTCExtended | ExtensionEnded
+
+declare interface ExtensionEnded extends Extension {
+    currentCall?: CurrentCallEnded
+}
+
+export declare type ExtensionEvent = EventTypeData<EventsEnum.EXTENSION_EVENT>
+
+declare type ExtensionEvent_2 = {
     data: Extension;
     cause?: ExtensionHangupCauseEnum;
     reason: ExtensionEventReasonEnum;
@@ -605,7 +627,14 @@ export declare type ExtensionEvent = {
     telephonyServerTime?: number;
 };
 
-export declare enum ExtensionEventReasonEnum {
+declare interface ExtensionEventEnded extends Omit<ExtensionEvent_2, 'reason' | 'data'> {
+    reason: ExtensionEventReasonEnum.HANGUP
+    data: ExtensionEnded
+}
+
+declare type ExtensionEventExtended = ExtensionEventUTCExtended | ExtensionEventEnded
+
+declare enum ExtensionEventReasonEnum {
     NEWCALL = 'NEWCALL',
     ANSWER = 'ANSWER',
     HOLD = 'HOLD',
@@ -614,7 +643,12 @@ export declare enum ExtensionEventReasonEnum {
     USER_STATUS_UPDATE = 'userStatusUpdate',
 }
 
-export declare enum ExtensionHangupCauseEnum {
+declare interface ExtensionEventUTCExtended extends Omit<ExtensionEvent_2, 'reason' | 'data'> {
+    reason: Exclude<ExtensionEventReasonEnum, ExtensionEventReasonEnum.HANGUP>
+    data: ExtensionUTCExtended
+}
+
+declare enum ExtensionHangupCauseEnum {
     NORMAL_HANGUP = 'Normal hangup',
     USER_BUSY = 'User busy',
     CALL_REJECTED = 'Call Rejected',
@@ -625,7 +659,13 @@ export declare enum ExtensionHangupCauseEnum {
     ANSWERED_ELSEWHERE = 'Answered elsewhere',
 }
 
-export declare type ExtensionsUpdated = string;
+export declare type ExtensionsUpdated = EventTypeData<EventsEnum.EXTENSIONS_UPDATED>
+
+declare type ExtensionsUpdated_2 = string;
+
+declare interface ExtensionUTCExtended extends Extension {
+    currentCall?: CurrentCallUTCExtended
+}
 
 export declare interface ExternalLoginNewStackResponseData {
     AccessToken: string,
@@ -655,7 +695,9 @@ export declare interface ExternalLoginResponse<T> {
  */
 export declare type GenericEventWrapper = EventWrappedSocketDataMap[EventTypeNames]
 
-export declare type KeepAliveResponseEvent = {
+export declare type KeepAliveResponseEvent = EventTypeData<EventsEnum.KEEP_ALIVE_RESPONSE>
+
+declare type KeepAliveResponseEvent_2 = {
     /**
      * Is ok
      */
@@ -726,7 +768,9 @@ export declare interface LoginSessionPayload {
     password: string
 }
 
-export declare type LoginStatusEvent = {
+export declare type LoginStatusEvent = EventTypeData<EventsEnum.LOGIN_STATUS>
+
+declare type LoginStatusEvent_2 = {
     queues: Array<Queue>;
     /**
      * 0 - Connection was establishing successfully.
@@ -746,7 +790,16 @@ export declare type LoginStatusEvent = {
     serverTimeOffset: number;
 };
 
-export declare type LoginSuccessEvent = {
+/**
+ * Event types declared for being used in the application.
+ * These are just aliases for the EventTypeData type.
+ * We need that for the IDE to show the correct type of the event data, based on if the event is extended or not.
+ * NOT FOR USAGE IN THE EVENTS SDK CODEBASE, JUST FOR USAGE IN THE APPLICATION CODEBASE.
+ */
+
+export declare type LoginSuccessEvent = EventTypeData<EventsEnum.LOGIN_SUCCESS>
+
+declare type LoginSuccessEvent_2 = {
     /**
      * 0 - Connection was establishing successfully.
      */
@@ -770,7 +823,9 @@ declare enum LoginType {
     TOKEN = "Token"
 }
 
-export declare type OnlineStatusEvent = {
+export declare type OnlineStatusEvent = EventTypeData<EventsEnum.ONLINE_STATUS_EVENT>
+
+declare type OnlineStatusEvent_2 = {
     /**
      * attemptToConnect
      */
@@ -799,7 +854,7 @@ export declare interface OpenSIPSEventMap {
     changeCallStatus: changeCallStatusListener
 }
 
-export declare type Queue = {
+declare type Queue = {
     Calls: Array<QueueCall>;
     /**
      * User id
@@ -827,7 +882,7 @@ export declare type Queue = {
     IsDistributedQueue?: boolean;
 };
 
-export declare type QueueCall = {
+declare type QueueCall = {
     /**
      * Ivr id
      */
@@ -858,7 +913,9 @@ export declare type QueueCall = {
     calldurationinterval: number;
 };
 
-export declare type QueueEvent = {
+export declare type QueueEvent = EventTypeData<EventsEnum.QUEUE_EVENT>
+
+declare type QueueEvent_2 = {
     data: Queue;
     reason: QueueEventReasonEnum;
     /**
@@ -875,7 +932,7 @@ export declare type QueueEvent = {
     telephonyServerTime: number;
 };
 
-export declare enum QueueEventReasonEnum {
+declare enum QueueEventReasonEnum {
     ANSWER = 'ANSWER',
     ABANDONED = 'ABANDONED',
     EXIT = 'EXIT',
@@ -892,7 +949,7 @@ export declare interface ReconnectOptions {
     maxReconnectionDelay: number;
 }
 
-export declare type Recording = {
+declare type Recording = {
     /**
      * Is muted
      */
@@ -913,10 +970,6 @@ export declare type Recording = {
 
 export declare type removeRoomListener = (value: string) => void
 
-declare type Response_2 = {
-};
-export { Response_2 as Response }
-
 export declare type RoomDeletedListener = (roomId: number) => void
 
 export declare interface Server {
@@ -926,6 +979,30 @@ export declare interface Server {
     Version: string;
 }
 
+export declare type ServerEmitEventCallbackRegistry = {
+    [K in ServerEmitEventTypeNames]: (data: ServerEmitEventDataMap[K]) => void
+}
+
+/**
+ * Mapping of event names to their respective data structures.
+ * The data structures that we can send to the server
+ */
+export declare interface ServerEmitEventDataMap {
+    [ServerListenerEventsEnum.UPDATE_MONITORED_EXTENSIONS]: UpdateMonitoredExtensionsPayload
+    [ServerListenerEventsEnum.KEEP_ALIVE]: string
+}
+
+/**
+ * Represents the set of all possible event type names as keys from the ServerEmitEventDataMap.
+ * This type is used to define event emitters and data.
+ */
+export declare type ServerEmitEventTypeNames = keyof ServerEmitEventDataMap
+
+export declare enum ServerListenerEventsEnum {
+    UPDATE_MONITORED_EXTENSIONS = "updateMonitoredExtensions",
+    KEEP_ALIVE = "keepAlive"
+}
+
 export declare enum ServerParameter {
     MAIN = "main",
     NEXT = "next"
@@ -969,20 +1046,27 @@ declare class SocketIoClass {
     private connected;
     getSocketIoFunction(Client: string): void;
     initSocketConnection(): void;
-    initSocketEvents(): void;
     clearKeepAliveInterval(): void;
     initKeepAlive(): void;
     closeAllConnections(): void;
+    initSocketEvents(): void;
+    private onLoginSuccessEvent;
+    private onQueueEvent;
+    private onExtensionEvent;
+    private onDialerEvent;
+    private onLoginStatusEvent;
+    private onAllExtensionStatus;
+    private onAllDialerStatus;
     private onKeepAliveResponse;
+    private onExtensionsUpdatedEvent;
     private onConnect;
     private onDisconnect;
     private onConnectError;
-    private configureUTCForObject;
 }
 
-export declare type SocketTyped = Socket_2<EventCallbackRegistry, Record<EventsEnum, any>>
+export declare type SocketTyped = Socket_2<EventCallbackRegistry, ServerEmitEventCallbackRegistry>
 
-export declare type Summery = {
+declare type Summery = {
     /**
      * Representative
      */
@@ -993,9 +1077,13 @@ export declare type TestEventListener = (event: { test: string }) => void
 
 declare type TypedSocketIo = (...args: Parameters<typeof io>) => SocketTyped;
 
+export declare interface UpdateMonitoredExtensionsPayload {
+    extensionsString: string
+}
+
 export declare type updateRoomListener = (value: string) => void
 
-export declare type User = {
+declare type User = {
     /**
      * User id
      */
@@ -1010,9 +1098,12 @@ export declare type User = {
     accountID: number;
 };
 
+/**
+ * The structure of received socket events.
+ */
 export declare type WrappedSocketEvent<T extends EventsEnum> = {
     name: T
-    data: EventDataMap[T]
+    data: EventDataMapExtended[T]
 }
 
 export { }