@voicenter-team/events-sdk 0.0.11 → 0.0.13

package/dist/types/events.d.ts

@@ -1,175 +0,0 @@
-import {
-    EventNameEnum,
-    EventsEnum,
-    ExtensionEventReasonEnum,
-    ExtensionHangupCauseEnum,
-    QueueEventReasonEnum
-} from '@/enum/events.enum'
-import { Queue, Extension, Dialer, User } from './events.common'
-
-/**
- * Base structure for all event types, containing common properties.
- */
-interface CommonEventProperties {
-    // Error code, 0 indicates no error
-    errorCode?: number
-    // Description of the error, "Ok" indicates successful connection
-    errorDesc?: string
-    // Server time at the moment of the event
-    serverTime: number
-    // Difference in time between server and client
-    serverTimeOffset: number
-}
-
-// Inherits properties from CommonEventProperties
-type LoginSuccessEvent = CommonEventProperties
-
-/**
- * Data structure for login status event.
- */
-export interface LoginStatusEvent extends CommonEventProperties {
-    // Array of Queue objects
-    queues: Queue[]
-}
-
-/**
- * Data structure for all extension status event.
- */
-export interface AllExtensionStatusEvent extends CommonEventProperties {
-    // Array of Extension objects
-    extensions: Extension[]
-}
-
-/**
- * Data structure for all dialers status event.
- */
-export interface AllDialersStatusEvent extends CommonEventProperties {
-    // Array of Dialer objects
-    dialers: Dialer[]
-}
-
-/**
- * Data structure for all users status event.
- */
-export interface AllUsersStatusEvent extends CommonEventProperties {
-    // Array of User objects
-    users: User[]
-}
-
-/**
- * Data structure for queue event.
- */
-export interface QueueEvent extends CommonEventProperties {
-    eventName: EventNameEnum.QUEUE,
-    reason: QueueEventReasonEnum,
-    telephonyServerTime: number,
-    ivrUniqueId: string,
-    data: Queue
-}
-
-/**
- * Data structure for extension event.
- */
-export interface ExtensionEvent extends CommonEventProperties {
-    data: Extension
-    eventName: EventNameEnum.EXTENSION
-    reason: ExtensionEventReasonEnum
-    telephonyServerTime?: number
-    callerID?: string
-    ivrUniqueId?: string
-    dialStatus?: string
-    cause?: ExtensionHangupCauseEnum
-}
-
-/**
- * Data structure for dialer event.
- */
-export interface DialerEvent extends CommonEventProperties {
-    data: Dialer
-    eventName: EventNameEnum.DIALER
-    //reason: ExtensionEventReasonEnum // TODO: do research for dialer 'reason' prop
-    telephonyServerTime?: number
-    callerID?: string
-    ivrUniqueId?: string
-    dialStatus?: string
-    //cause?: ExtensionHangupCauseEnum // TODO: do research for dialer 'cause' prop
-}
-
-/**
- * Data structure for keep alive response event.
- */
-export interface KeepAliveResponseEvent extends CommonEventProperties {
-    isOk: boolean
-}
-
-export interface OnlineStatusEvent {
-    isSocketConnected: boolean
-}
-
-/**
- * Mapping of event names to their respective data structures.
- */
-export 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
-}
-
-/**
- * Represents the set of all possible event type names as keys from the EventDataMap.
- * This type is used to define event listeners and handlers.
- */
-type EventTypeNames = keyof EventDataMap
-
-// Generic structure for wrapped socket event data
-type WrappedSocketEvent<T extends EventsEnum> = {
-    name: T
-    data: EventDataMap[T]
-}
-
-// Generic type for event type data
-export type EventTypeData<T extends EventsEnum> = EventDataMap[T]
-
-/**
- * Defines a registry of callback functions for each event type.
- * Each key is an event type name, and the value is a function that takes the specific event data type as an argument.
- * This registry is used to manage and invoke event-specific callbacks.
- */
-export type EventCallbackRegistry = {
-    [K in EventTypeNames]: (data: EventDataMap[K]) => void
-}
-
-/**
- * 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.
- */
-export type EventSpecificCallback<T extends EventTypeNames> = (data: WrappedSocketEvent<T>) => void
-
-/**
- * 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
- */
-export type EventCallbackListenersMap = {
-    [K in EventTypeNames]: Array<EventSpecificCallback<K>>
-}
-
-/**
- * This type represents a mapping of listener event names to their corresponding wrapped socket event data structures.
- * Each key is an event name, and the value is the wrapped socket event data for that event
- */
-type EventWrappedSocketDataMap = {
-    [K in EventTypeNames]: WrappedSocketEvent<K>
-}
-
-/**
- * A generic type that represents the structure of any event data wrapped in a socket event format.
- * This type is used in the handling of all event types, providing a consistent structure for event data processing.
- */
-export type GenericEventWrapper = EventWrappedSocketDataMap[EventTypeNames]

package/dist/types/listeners.d.ts

@@ -1,37 +0,0 @@
-export type readyListener = (value: boolean) => void
-export type changeActiveCallsListener = (event: { [key: string]: string }) => void
-export type TestEventListener = (event: { test: string }) => void
-export type ActiveRoomListener = (event: number | undefined) => void
-export type CallAddingProgressListener = (callId: string | undefined) => void
-export type RoomDeletedListener = (roomId: number) => void
-export type changeActiveInputMediaDeviceListener = (event: string) => void
-export type changeActiveOutputMediaDeviceListener = (event: string) => void
-export type changeMuteWhenJoinListener = (value: boolean) => void
-export type changeIsDNDListener = (value: boolean) => void
-export type changeIsMutedListener = (value: boolean) => void
-export type addRoomListener = (value: string) => void
-export type updateRoomListener = (value: string) => void
-export type removeRoomListener = (value: string) => void
-export type changeCallStatusListener = (event: { [key: string]: number }) => void
-
-export interface OpenSIPSEventMap {
-    ready: readyListener
-    changeActiveCalls: changeActiveCallsListener
-    callConfirmed: TestEventListener
-    currentActiveRoomChanged: ActiveRoomListener
-    callAddingInProgressChanged: CallAddingProgressListener
-    roomDeleted: RoomDeletedListener
-    changeActiveInputMediaDevice: changeActiveInputMediaDeviceListener
-    changeActiveOutputMediaDevice: changeActiveOutputMediaDeviceListener
-    changeMuteWhenJoin: changeMuteWhenJoinListener
-    changeIsDND: changeIsDNDListener
-    changeIsMuted: changeIsMutedListener
-    addRoom: addRoomListener
-    updateRoom: updateRoomListener
-    removeRoom: removeRoomListener
-    changeCallStatus: changeCallStatusListener
-}
-
-export type ListenersKeyType = keyof OpenSIPSEventMap
-export type ListenersCallbackFnType = OpenSIPSEventMap[ListenersKeyType]
-export type ListenerCallbackFnType<T extends ListenersKeyType> = OpenSIPSEventMap[T]

package/dist/types/public-api.d.ts

@@ -1,39 +0,0 @@
-/**
- * Represents Event Types in Enum
- */
-export enum EventTypesEnum {
-    ALL_DIALERS_STATUS = 'AllDialersStatus',
-    ALL_EXTENSION_STATUS = 'AllExtensionsStatus',
-    CLOSE = 'closeme',
-    CONNECT = 'connect',
-    CONNECT_ERROR = 'connect_error',
-    CONNECT_TIMEOUT = 'connect_timeout',
-    DISCONNECT = 'disconnect',
-    DIALER_EVENT = 'DialerEvent',
-    DIALERS_UPDATED = 'DialersUpdated',
-    ERROR = 'error',
-    EXTENSION_EVENT = 'ExtensionEvent',
-    EXTENSION_UPDATED = 'ExtensionsUpdated',
-    KEEP_ALIVE = 'keepalive',
-    KEEP_ALIVE_RESPONSE = 'keepaliveResponse',
-    LOGIN = 'login',
-    LOGIN_ACCOUNT = 'loginAccount',
-    LOGIN_CODE = 'loginUserCode',
-    LOGIN_RESPONSE = 'loginResponse',
-    LOGIN_STATUS = 'loginStatus',
-    LOGIN_USER = 'loginUser',
-    PONG = 'pong',
-    QUEUE_EVENT = 'QueueEvent',
-    QUEUES_UPDATED = 'QueuesUpdated',
-    RECONNECT = 'reconnect',
-    RECONNECT_ATTEMPT = 'reconnect_attempt',
-    RECONNECT_ERROR = 'reconnect_error',
-    RECONNECT_FAILED = 'reconnect_failed',
-    RECONNECTING = 'reconnecting',
-    RESYNC = 'resync'
-}
-
-export enum ServerTypesEnum {
-    DEFAULT = 1,
-    CHROME_EXTENSION = 2
-}

package/dist/types/socket.d.ts

@@ -1,5 +0,0 @@
-import { Socket } from 'socket.io-client'
-import { EventCallbackRegistry } from './events'
-import { EventsEnum } from 'enum/events.enum'
-
-export type SocketTyped = Socket<EventCallbackRegistry, Record<EventsEnum, any>>