@voicenter-team/events-sdk 0.0.1

package/src/enum/events.enum.ts

@@ -0,0 +1,96 @@
+/**
+ * All events that can be received from the server.
+ */
+export enum EventsEnum {
+    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'
+}
+
+/**
+ * All the reasons for the extension event, e.g. a new call is ringing or dialing from an extension.
+ */
+export 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',
+}
+
+export enum QueueEventReasonEnum {
+    ANSWER = 'ANSWER',
+    ABANDONED = 'ABANDONED',
+    EXIT = 'EXIT',
+    JOIN = 'JOIN'
+}
+
+export enum DialerType {
+    AUTOMATIC = 'Automatic',
+    IVR = 'IVR'
+}
+
+/**
+ * All the eventNames that can be received from the server. Exists only in EXTENSION_EVENT and QueueEvent
+ */
+export enum EventNameEnum {
+    EXTENSION = 'extension',
+    QUEUE = 'queue',
+}
+
+export 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'
+}
+
+export enum CallStatusEnum {
+    RINGING = 'Ringing',
+    TALKING = 'Talking',
+    DIALING = 'Dialing',
+    HOLD = 'Hold',
+}
+
+export enum CallTypeEnum {
+    INCOMING = 'Incoming',
+    OUTGOING = 'Outgoing'
+}
+
+export enum DoNotCallMeStatusCodeEnum {
+    RESPONSE_FROM_API_VALID = 'RESPONSE_FROM_API_VALID',
+    RESPONSE_FROM_API_INVALID = 'RESPONSE_FROM_API_INVALID'
+}
+
+export enum DirectionEnum {
+    INCOMING = 'Incoming',
+    OUTGOING = 'Outgoing',
+    SPY = 'Spy',
+    CLICK2CALL = 'Click2call'
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+import EventsSdkClass from '@/classes/events-sdk/events-sdk.class'
+
+export default EventsSdkClass

package/src/types/auth.d.ts

@@ -0,0 +1,18 @@
+export interface LoginSessionPayload {
+    token: string,
+    email: string,
+    username: string,
+    password: string
+}
+
+export interface LoginSessionData {
+    Client: string,
+    PersonId: number,
+    RefreshToken: string,
+    RefreshTokenExpiry: Date,
+    Token: string,
+    TokenExpiry: Date,
+    URLList: string[],
+    Url: string,
+    Version: string
+}

package/src/types/events.common.d.ts

@@ -0,0 +1,110 @@
+import { CallStatusEnum, CallTypeEnum, DialerType, DirectionEnum, DoNotCallMeStatusCodeEnum } from 'enum/events.enum'
+
+export interface Dialer {
+    campaignID: number,
+    name: string,
+    typeID: number,
+    type: DialerType,
+    code: string,
+    calls: unknown,
+    statistics: unknown
+}
+
+export interface User {
+    userID: number,
+    userName: string,
+    accountID: number
+
+}
+
+export interface Extension {
+    calls: ExtensionCall[],
+    userID: number,
+    userName: string,
+    number: number,
+    extenUser: string,
+    accountID: number,
+    topAccountID: number,
+    summery: Summery,
+    onlineUserID: number,
+    representative: number,
+    representativeStatus: number,
+    lastCallEventEpoch: number,
+    lastAnsweredCallEventEpoch: number,
+    lastHangupCallEpoch: number,
+    representativeUpdated: number,
+    peerStatus: unknown,
+    currentCall?: ExtensionCall,
+}
+
+export interface Queue {
+    QueueID: number,
+    QueueName: string,
+    Calls: QueueCall[],
+    UserId?: number,
+    DistributorID?: number,
+    IsDistributedQueue?: boolean,
+    AnsweredAgent?: string,
+}
+
+interface ExtensionCall {
+    callStarted: number,
+    calldurationinterval: number,
+    callAnswered: number,
+    answered: number,
+    callername: string,
+    callerphone: string,
+    outgoingcallername?: string,
+    outgoingcallerphone?: string,
+    callstatus: CallStatusEnum,
+    customdata: CustomData,
+    direction: DirectionEnum,
+    ivrid: string,
+    recording: Recording,
+    did: string,
+    relatedIvrUniqueIDs?: string[],
+    callType?: CallTypeEnum,
+    ip: string,
+    isInternal: boolean
+    blcServerID: number,
+    isOpensips: boolean,
+    channel: string,
+    channel2: string,
+    queueID?: number,
+    isSpyed?: boolean,
+    blcServerId?: number,
+    originalCallerID?: string,
+    originalCallerName?: string,
+    actualDialedNumber?: number
+}
+
+interface QueueCall {
+    CallerID: string,
+    CallerName: string,
+    IvrUniqueID: string,
+    JoinTimeStamp: number,
+    calldurationinterval: number,
+    ivrid: string,
+    isDistributedQueue?: boolean
+}
+
+interface Summery {
+    representative: string
+}
+
+interface CustomData {
+    DoNotCallMeStatus?: string,
+    DoNotCallMeStatusCode?: DoNotCallMeStatusCodeEnum,
+    DoNotCallMeTokenName?: string,
+    DoNotCallMetransactionId?: string,
+    IsDoNotCallMe?: string
+}
+
+interface Recording {
+    Filename: string,
+    Options: string,
+    ApproximateURL: string,
+    IsMuted: number
+}
+
+

package/src/types/events.d.ts

@@ -0,0 +1,160 @@
+import {
+    EventNameEnum,
+    EventsEnum,
+    ExtensionEventReasonEnum,
+    ExtensionHangupCauseEnum,
+    QueueEventReasonEnum
+} from '@/enum/events.enum'
+import { Queue, Extension, Dialer, User } from '@/types/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 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.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/src/types/listeners.d.ts

@@ -0,0 +1,37 @@
+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/src/types/public-api.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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/src/types/socket.d.ts

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

package/swagger/generated/Swagger.json

@@ -0,0 +1 @@
+{"host":"localhost:3000","info":{"title":"admin-api","contact":{},"version":"0.01","description":"irst Alpha - Hope it will wok for yall :-)","termsOfService":""},"paths":{"/Account/List/":{"post":{"tags":["Account"],"security":[{"AdminAuthentication":["Admin"]}],"responses":{"200":{"schema":{"$ref":"#/definitions/AccountListResponse"},"description":"Status 200"},"400":{"schema":{"$ref":"#/definitions/Error"},"description":"Error Response"}},"parameters":[{"in":"body","name":"RequestBody","schema":{"$ref":"#/definitions/AccountListRequest"},"description":"Searching for Account that meets the query. multiple values are support. multiple selections in same feild will be treated as OR, multiple feilds will be searched with OR between them."}],"x-AuthType":["Admin"],"operationId":"AccountList","x-serviceID":3,"x-methodName":"List","x-serviceName":"Account"}},"/Account/Update/":{"post":{"tags":["Account"],"security":[{"AdminAuthentication":["Admin"]}],"responses":{"200":{"schema":{"$ref":"#/definitions/Response"},"description":"Status 200"},"400":{"schema":{"$ref":"#/definitions/Error"},"description":"Error Response"}},"parameters":[],"x-AuthType":["Admin"],"operationId":"AccountUpdate","x-serviceID":3,"x-methodName":"Update","x-serviceName":"Account"}}},"schemes":["https"],"swagger":"2.0","basePath":"/v1","consumes":["application/json"],"produces":["application/json"],"definitions":{"Error":{"type":"object","required":["Description","Status"],"properties":{"Status":{"type":"integer","example":400,"description":"Code of the Error"},"Description":{"type":"string","example":"Not found","description":"Textual description of the error"},"ReasonPhrase":{"type":"string","example":"ID not valid","description":"Specific reason for the error"}}},"Response":{"type":"object","required":["Description","ReasonPhrase","Status"],"properties":{"Status":{"type":"integer","example":200,"description":"Code of response"},"Description":{"type":"string","example":"OK","description":"Description of response"},"ReasonPhrase":{"type":"string","description":"Data of response"}}},"AccountAdd":{"type":"object","properties":{}},"ProviderAdd":{"type":"object","properties":{}},"ProviderDisable":{"type":"object","properties":{}},"ProvidersAddList":{"type":"object","properties":{}},"ProviderPrefixAdd":{"type":"object","properties":{}},"AccountListRequest":{"type":"object","properties":{}},"AccountListResponse":{"type":"object","properties":{}},"ProviderListResponse":{"type":"object","properties":{}},"ProviderPrefixUpdate":{"type":"object","properties":{}},"ProvidersDisableList":{"type":"object","properties":{}},"ProviderPrefixAddList":{"type":"object","properties":{}},"ProviderPrefixUpdateList":{"type":"object","properties":{}},"ProviderPrefixBulkRequest":{"type":"object","properties":{}},"ProviderPrefixBulkResponse":{"type":"object","properties":{}},"ProviderPrefixListResponse":{"type":"object","properties":{}},"ProviderPrefixUpdateResponse":{"type":"object","properties":{}}},"securityDefinitions":{}}

package/swagger/index.js

@@ -0,0 +1,60 @@
+import fs from 'fs'
+import fastify from 'fastify'
+import fastifySwagger from 'fastify-swagger'
+import openapiGlue from 'fastify-openapi-glue'
+
+const app = fastify()
+
+const start = async () => {
+    try {
+        if (!fs.existsSync('./generated/Swagger.json')) {
+            console.log('Swagger.json file not generated. Try to run: npm run update')
+
+            return
+        }
+
+        const swagger = JSON.parse(fs.readFileSync('./generated/Swagger.json').toString())
+
+        const swaggerOptions = {
+            routePrefix: '/documentation',
+            exposeRoute: true,
+            swagger: {
+                ...swagger,
+                schemes: [ 'https', 'http' ],
+                securityDefinitions: {
+                    JWT: {
+                        type: 'apiKey',
+                        name: 'Authorization',
+                        in: 'header'
+                    }
+                },
+                security: [ { JWT: [] } ]
+            },
+            uiConfig: {
+                docExpansion: 'full',
+                deepLinking: false
+            }
+        }
+
+        const openapiGlueOptions = {
+            specification: './generated/Swagger.json',
+            service: {},
+        }
+
+        app.register(fastifySwagger, swaggerOptions)
+
+        app.register(openapiGlue, openapiGlueOptions)
+
+        await app.listen({
+            port: 3000
+        })
+
+        console.log('Server is running on port: 3000')
+    } catch (err) {
+        console.error('Error starting server:', err)
+
+        process.exit(1)
+    }
+}
+
+start()

package/swagger/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "swagger",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "update": "node scripts/update-swagger-json.js",
+    "start": "node index.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@fastify/swagger": "^8.13.0",
+    "@voicenter-team/mysql-dynamic-cluster": "^3.0.5",
+    "fastify": "^3.19.1",
+    "fastify-swagger": "^4.8.3",
+    "fastify-openapi-glue": "git+https://github.com/VoicenterTeam/fastify-openapi-glue.git"
+  }
+}

package/swagger/scripts/update-swagger-json.js

@@ -0,0 +1,53 @@
+import fs from 'fs'
+import mysql from '@voicenter-team/mysql-dynamic-cluster'
+
+const connection = mysql.createPoolCluster({
+    clusterName: 'demo',
+    hosts: [
+        {
+            host: '192.168.187.22',
+            port: 3306,
+            name: 'lab22',
+        }
+    ],
+    // Configuration for all pools
+    defaultPoolSettings: {
+        user: 'api',
+        password: 'SecretAPI35t478p3!!!',
+        database: 'voicenter_core',
+        docsDatabase: 'monitor_events_api_doc',
+        charset: 'utf8mb4',
+        port: 3313,
+        // validators: [],
+        // loadFactors: [],
+    },
+})
+
+const pathToFile = 'generated/'
+const filename = 'Swagger.json'
+const fullPath = pathToFile + filename
+
+const generate = async () => {
+    await connection.connect()
+
+    const results = await connection.query('SELECT monitor_events_api_doc.FN_GetSwagger(0.01) as data')
+
+    const targetResult = results[0].data
+
+    console.log(targetResult)
+
+    const targetResultString = JSON.stringify(targetResult)
+
+    if (!fs.existsSync(pathToFile)) {
+        fs.mkdirSync(pathToFile, { recursive: true })
+    }
+
+    fs.writeFile(fullPath, targetResultString, (err) => {
+        if (err) throw err
+        console.log('Swagger.json is updated!')
+    })
+
+    await connection.disconnect()
+}
+
+generate().then(data => console.log(data))