@voicenter-team/events-sdk 0.0.12 → 0.0.14

package/src/classes/storage/storage.class.ts

@@ -0,0 +1,43 @@
+import { LoginSessionData } from '@/types/auth'
+
+export class StorageClass{
+    public static async getSessionStorageDataByKey (key: string): Promise<LoginSessionData | undefined> {
+        if (typeof chrome !== 'undefined' && typeof chrome.storage !== 'undefined') {
+            const loginSessionKey = await chrome.storage.session.get(key)
+
+            if (loginSessionKey[key]) {
+                return JSON.parse(loginSessionKey[key])
+            }
+        }
+
+        if (typeof window !== 'undefined') {
+            const loginSessionKey = window.sessionStorage.getItem(key)
+
+            if (loginSessionKey) {
+                return JSON.parse(loginSessionKey)
+            }
+        }
+    }
+
+    public static async updateSessionStorageKey (key: string, storageData: Partial<LoginSessionData>) {
+        if (typeof chrome !== 'undefined' && typeof chrome.storage !== 'undefined') {
+            await chrome.storage.session.set({
+                [key]: JSON.stringify(storageData)
+            })
+        }
+
+        if (typeof window !== 'undefined') {
+            window.sessionStorage.setItem(key, JSON.stringify(storageData))
+        }
+    }
+
+    public static clearSessionStorage () {
+        if (typeof chrome !== 'undefined' && typeof chrome.storage !== 'undefined') {
+            chrome.storage.session.clear()
+        }
+
+        if (typeof window !== 'undefined') {
+            window.sessionStorage.clear()
+        }
+    }
+}

package/src/enum/auth.enum.ts

@@ -0,0 +1,4 @@
+export enum LoginType {
+    USER = 'User',
+    TOKEN = 'Token'
+}

package/src/enum/events.enum.ts

@@ -0,0 +1,98 @@
+/**
+ * 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',
+    DIALER_EVENT = 'DialerEvent',
+}
+
+/**
+ * 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',
+    DIALER = 'dialer',
+}
+
+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,15 @@
+import EventsSdkClass from '@/classes/events-sdk/events-sdk.class'
+import { EventsEnum } from '@/enum/events.enum'
+
+// Export all types and enums
+export type * from './types/auth'
+export type * from './types/events.common'
+export type * from './types/events'
+export type * from './types/listeners'
+export type * from './types/public-api'
+export type * from './types/socket'
+export type * from './classes/events-sdk/events-sdk.types'
+
+export { EventsEnum }
+
+export default EventsSdkClass

package/{dist → src}/types/auth.d.ts

@@ -1,5 +1,5 @@
-import { Server } from '../classes/events-sdk/events-sdk.types'
-import { LoginType } from '../enum/auth.enum'
+import { Server } from '@/classes/events-sdk/events-sdk.types'
+import { LoginType } from '@/enum/auth.enum'
 
 export interface LoginSessionPayload {
     token: string,
@@ -14,15 +14,19 @@ export interface ExternalLoginRequestBody {
     token?: string
 }
 
-interface ExternalLoginResponseData {
+export interface ExternalLoginResponse<T> {
+    StatusCode: number,
+    Status: string,
+    Data: T
+}
+
+interface ExternalLoginNewStackResponseData {
     AccessToken: string,
     RefreshToken: string
 }
 
-export interface ExternalLoginResponse {
-    StatusCode: number,
-    Status: string,
-    Data: ExternalLoginResponseData
+interface ExternalLoginOldStackResponseData {
+    Socket: Socket,
 }
 
 export interface Socket {
@@ -46,4 +50,4 @@ export interface Settings {
     MonitorList: Server[]
 }
 
-export interface LoginSessionData extends Settings, ExternalLoginResponseData {}
+export interface LoginSessionData extends Settings, ExternalLoginNewStackResponseData, Socket {}

package/{dist → src}/types/events.common.d.ts

@@ -1,4 +1,4 @@
-import { CallStatusEnum, CallTypeEnum, DialerType, DirectionEnum, DoNotCallMeStatusCodeEnum } from '../enum/events.enum'
+import { CallStatusEnum, CallTypeEnum, DialerType, DirectionEnum, DoNotCallMeStatusCodeEnum } from '@/enum/events.enum'
 
 export interface Dialer {
     campaignID: number,

package/{dist → src}/types/events.d.ts

@@ -5,7 +5,7 @@ import {
     ExtensionHangupCauseEnum,
     QueueEventReasonEnum
 } from '@/enum/events.enum'
-import { Queue, Extension, Dialer, User } from './events.common'
+import { Queue, Extension, Dialer, User } from '@/types/events.common'
 
 /**
  * Base structure for all event types, containing common properties.

package/{dist → src}/types/socket.d.ts

@@ -1,5 +1,5 @@
 import { Socket } from 'socket.io-client'
-import { EventCallbackRegistry } from './events'
+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))