@voicenter-team/events-sdk 0.0.14 → 0.0.18

package/dist/{index.d.ts → voicenter-events-sdk.d.ts}

@@ -1,5 +1,5 @@
+import { AsyncStorageLoggerConfig } from '@voicenter-team/socketio-storage-logger/build/interfaces/AsyncStorageLoggerConfig';
 import { DebouncedFuncLeading } from 'lodash';
-import { EventsEnum as EventsEnum_3 } from 'enum/events.enum';
 import { io } from 'socket.io-client';
 import { Socket as Socket_2 } from 'socket.io-client';
 
@@ -161,25 +161,25 @@ export declare type EventCallbackRegistry = {
  * Mapping of event names to their respective data structures.
  */
 export declare interface EventDataMap {
-    [EventsEnum_2.ALL_EXTENSION_STATUS]: AllExtensionStatusEvent
-    [EventsEnum_2.ALL_DIALER_STATUS]: AllDialersStatusEvent
-    [EventsEnum_2.ALL_USERS_STATUS]: AllUsersStatusEvent
-    [EventsEnum_2.QUEUE_EVENT]: QueueEvent
-    [EventsEnum_2.EXTENSION_EVENT]: ExtensionEvent
-    [EventsEnum_2.DIALER_EVENT]: DialerEvent
-    [EventsEnum_2.LOGIN_SUCCESS]: LoginSuccessEvent
-    [EventsEnum_2.LOGIN_STATUS]: LoginStatusEvent
-    [EventsEnum_2.KEEP_ALIVE_RESPONSE]: KeepAliveResponseEvent
-    [EventsEnum_2.ONLINE_STATUS_EVENT]: OnlineStatusEvent
+    [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
 }
 
 /**
  * All the eventNames that can be received from the server. Exists only in EXTENSION_EVENT and QueueEvent
  */
 declare enum EventNameEnum {
-    EXTENSION = 'extension',
-    QUEUE = 'queue',
-    DIALER = 'dialer',
+    EXTENSION = "extension",
+    QUEUE = "queue",
+    DIALER = "dialer"
 }
 
 /**
@@ -201,31 +201,6 @@ export declare enum EventsEnum {
     DIALER_EVENT = "DialerEvent"
 }
 
-/**
- * All events that can be received from the server.
- */
-declare enum EventsEnum_2 {
-    ALL_DIALER_STATUS = 'AllDialersStatus',
-    ALL_EXTENSION_STATUS = 'AllExtensionsStatus',
-    ALL_USERS_STATUS = 'AllUsersStatus',
-    CONNECT = 'connect',
-    DISCONNECT = 'disconnect',
-    EXTENSION_EVENT = 'ExtensionEvent',
-    KEEP_ALIVE = 'keepalive',
-    KEEP_ALIVE_RESPONSE = 'keepaliveResponse',
-    // This type of event will be sent only in case of a successful connection.
-    // The event describes the list of monitored queues on this active connection.
-    // The list of monitored queues will only be sent if the login connection was made with account credentials or account token.
-    // If the login connection type is by user credentials, only the user’s extension assigned queues will return.
-    LOGIN_STATUS = 'loginStatus',
-    // This type of event will be sent in the initial login connection request in case of a successful connection only.
-    // In case of wrong username or password or token, you will receive a 401 (“Unauthorized”) or 500 (“Unexpected token”) http error.
-    LOGIN_SUCCESS = 'loginSuccess',
-    QUEUE_EVENT = 'QueueEvent',
-    ONLINE_STATUS_EVENT = 'onlineStatusEvent',
-    DIALER_EVENT = 'DialerEvent',
-}
-
 /**
  * This is a generic type for callback functions used in event handling.
  * It takes a generic event name and defines a callback function that receives wrapped socket event data for that specific event.
@@ -241,6 +216,7 @@ declare class EventsSdkClass {
     socket: SocketTyped | undefined;
     authClass: AuthClass;
     socketIoClass: SocketIoClass;
+    loggerClass: LoggerClass;
     reconnectOptions: ReconnectOptions;
     retryConnection: DebouncedFuncLeading<(server?: ServerParameter, skipLogin?: boolean) => void>;
     private listeners;
@@ -267,6 +243,7 @@ export declare interface EventsSdkOptions {
     isNewStack?: boolean;
     servers: Server[];
     loginUrl: string;
+    getSettingsUrl?: string;
     fallbackServer: Server;
     refreshTokenUrl: string;
     refreshToken?: string;
@@ -286,16 +263,16 @@ export declare interface EventsSdkOptions {
     serverFetchStrategy?: string;
     serverType?: number;
     useLogger?: boolean;
-    loggerSocketConnection?: string;
-    loggerServer?: string;
-    loggerConfig?: LoggerConfig;
+    loggerSocketConnection?: Socket_2;
+    loggerServer: string;
+    loggerConfig: Partial<AsyncStorageLoggerConfig>;
     loggerConnectOptions?: LoggerConnectOptions;
     email: string;
     password: string;
     username: string;
 }
 
-export declare type EventTypeData<T extends EventsEnum_2> = EventDataMap[T]
+export declare type EventTypeData<T extends EventsEnum> = EventDataMap[T]
 
 /**
  * Represents the set of all possible event type names as keys from the EventDataMap.
@@ -415,29 +392,23 @@ export declare interface ExtensionEvent extends CommonEventProperties {
  * All the reasons for the extension event, e.g. a new call is ringing or dialing from an extension.
  */
 declare enum ExtensionEventReasonEnum {
-    // A new call is ringing or dialing from an extension.
-    NEW_CALL = 'NEWCALL',
-    // A call was answered at an extension.
-    ANSWER = 'ANSWER',
-    // A call was placed on hold.
-    HOLD = 'HOLD',
-    // A call is no longer on hold.
-    UNHOLD = 'UNHOLD',
-    // When a call was ended. It is not necessarily means that the call was answered.
-    HANGUP = 'HANGUP',
-    // When the extension online user updated his\her user status(Login, Break, Logout, etc.)
-    USER_STATUS_UPDATE = 'userStatusUpdate',
+    NEW_CALL = "NEWCALL",
+    ANSWER = "ANSWER",
+    HOLD = "HOLD",
+    UNHOLD = "UNHOLD",
+    HANGUP = "HANGUP",
+    USER_STATUS_UPDATE = "userStatusUpdate"
 }
 
 declare enum ExtensionHangupCauseEnum {
-    NORMAL_HANGUP = 'Normal hangup',
-    USER_BUSY = 'User busy',
-    CALL_REJECTED = 'Call Rejected',
-    UNALLOCATED_NUMBER = 'Unallocated (unassigned) number',
-    UNKNOWN = 'Unknown',
-    NO_USER_RESPONDING = 'No user responding',
-    USER_ALERTING = 'User alerting, no answer',
-    ANSWERED_ELSEWHERE =  'Answered elsewhere'
+    NORMAL_HANGUP = "Normal hangup",
+    USER_BUSY = "User busy",
+    CALL_REJECTED = "Call Rejected",
+    UNALLOCATED_NUMBER = "Unallocated (unassigned) number",
+    UNKNOWN = "Unknown",
+    NO_USER_RESPONDING = "No user responding",
+    USER_ALERTING = "User alerting, no answer",
+    ANSWERED_ELSEWHERE = "Answered elsewhere"
 }
 
 export declare interface ExternalLoginNewStackResponseData {
@@ -481,6 +452,15 @@ export declare type ListenersCallbackFnType = OpenSIPSEventMap[ListenersKeyType]
 
 export declare type ListenersKeyType = keyof OpenSIPSEventMap
 
+declare class LoggerClass {
+    private readonly eventsSdkClass;
+    constructor(eventsSdkClass: EventsSdkClass);
+    io: Socket_2 | undefined;
+    private storageLogger;
+    init(): void;
+    log(type: LoggerTypeEnum, event: EventsEnum, ...data: unknown[]): void;
+}
+
 export declare interface LoggerConfig {
     logToConsole?: boolean;
     overloadGlobalConsole?: boolean;
@@ -492,12 +472,20 @@ export declare interface LoggerConnectOptions {
     reconnection?: boolean;
     reconnectionDelay?: number;
     reconnectionAttempts?: number;
-    perMessageDeflate?: boolean;
+    perMessageDeflate?: {
+        threshold: number;
+    };
     upgrade?: boolean;
     transports?: string[];
     debug?: boolean;
 }
 
+declare enum LoggerTypeEnum {
+    INFO = "INFO",
+    WARN = "WARN",
+    ERROR = "ERROR"
+}
+
 export declare interface LoginSessionData extends Settings, ExternalLoginNewStackResponseData, Socket {}
 
 export declare interface LoginSessionPayload {
@@ -575,10 +563,10 @@ export declare interface QueueEvent extends CommonEventProperties {
 }
 
 declare enum QueueEventReasonEnum {
-    ANSWER = 'ANSWER',
-    ABANDONED = 'ABANDONED',
-    EXIT = 'EXIT',
-    JOIN = 'JOIN'
+    ANSWER = "ANSWER",
+    ABANDONED = "ABANDONED",
+    EXIT = "EXIT",
+    JOIN = "JOIN"
 }
 
 export declare type readyListener = (value: boolean) => void
@@ -662,7 +650,7 @@ declare class SocketIoClass {
     private onDisconnect;
 }
 
-export declare type SocketTyped = Socket_2<EventCallbackRegistry, Record<EventsEnum_3, any>>
+export declare type SocketTyped = Socket_2<EventCallbackRegistry, Record<EventsEnum, any>>
 
 export declare interface Summery {
     representative: string
@@ -681,7 +669,7 @@ export declare interface User {
 
 }
 
-export declare type WrappedSocketEvent<T extends EventsEnum_2> = {
+export declare type WrappedSocketEvent<T extends EventsEnum> = {
     name: T
     data: EventDataMap[T]
 }