@voicenter-team/events-sdk 0.0.25 → 0.0.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/voicenter-events-sdk.cjs.js +10 -10
- package/dist/voicenter-events-sdk.cjs.js.map +1 -1
- package/dist/voicenter-events-sdk.d.ts +11 -114
- package/dist/voicenter-events-sdk.es.js +764 -761
- package/dist/voicenter-events-sdk.es.js.map +1 -1
- package/dist/voicenter-events-sdk.iife.js +13 -13
- package/dist/voicenter-events-sdk.iife.js.map +1 -1
- package/dist/voicenter-events-sdk.umd.js +12 -12
- package/dist/voicenter-events-sdk.umd.js.map +1 -1
- package/docs/package-lock.json +7 -0
- package/docs/package.json +2 -1
- package/docs/src/.vuepress/components/Demo.vue +8 -2
- package/docs/src/.vuepress/config.js.7b0e7894.mjs +64 -0
- package/package.json +2 -1
- package/src/classes/event-emitter/event-emitter.class.ts +3 -2
- package/src/classes/events-sdk/events-sdk.class.ts +1 -1
- package/src/classes/logger/logger.class.ts +1 -1
- package/src/classes/socket-io/socket-io.class.ts +4 -2
- package/src/enum/events.enum.ts +0 -26
- package/src/types/events.d.ts +13 -97
- package/src/types/socket.d.ts +1 -1
|
@@ -1,36 +1,22 @@
|
|
|
1
|
+
import { AllDialersStatusEvent } from '@voicenter-team/real-time-events-types';
|
|
2
|
+
import { AllExtensionStatusEvent } from '@voicenter-team/real-time-events-types';
|
|
3
|
+
import { AllUsersStatusEvent } from '@voicenter-team/real-time-events-types';
|
|
1
4
|
import { DebouncedFuncLeading } from 'lodash';
|
|
5
|
+
import { DialerEvent } from '@voicenter-team/real-time-events-types';
|
|
6
|
+
import { EventsEnum } from '@voicenter-team/real-time-events-types';
|
|
7
|
+
import { ExtensionEvent } from '@voicenter-team/real-time-events-types';
|
|
2
8
|
import { io } from 'socket.io-client';
|
|
9
|
+
import { KeepAliveResponseEvent } from '@voicenter-team/real-time-events-types';
|
|
3
10
|
import { LoggerOptions } from '@voicenter-team/socketio-storage-logger/dist/storage-logger';
|
|
11
|
+
import { LoginStatusEvent } from '@voicenter-team/real-time-events-types';
|
|
12
|
+
import { LoginSuccessEvent } from '@voicenter-team/real-time-events-types';
|
|
13
|
+
import { QueueEvent } from '@voicenter-team/real-time-events-types';
|
|
4
14
|
import { Socket as Socket_2 } from 'socket.io-client';
|
|
5
15
|
|
|
6
16
|
export declare type ActiveRoomListener = (event: number | undefined) => void
|
|
7
17
|
|
|
8
18
|
export declare type addRoomListener = (value: string) => void
|
|
9
19
|
|
|
10
|
-
/**
|
|
11
|
-
* Data structure for all dialers status event.
|
|
12
|
-
*/
|
|
13
|
-
export declare interface AllDialersStatusEvent extends CommonEventProperties {
|
|
14
|
-
// Array of Dialer objects
|
|
15
|
-
dialers: Dialer[]
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
* Data structure for all extension status event.
|
|
20
|
-
*/
|
|
21
|
-
export declare interface AllExtensionStatusEvent extends CommonEventProperties {
|
|
22
|
-
// Array of Extension objects
|
|
23
|
-
extensions: Extension[]
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* Data structure for all users status event.
|
|
28
|
-
*/
|
|
29
|
-
export declare interface AllUsersStatusEvent extends CommonEventProperties {
|
|
30
|
-
// Array of User objects
|
|
31
|
-
users: User[]
|
|
32
|
-
}
|
|
33
|
-
|
|
34
20
|
declare class AuthClass {
|
|
35
21
|
private readonly eventsSdkClass;
|
|
36
22
|
constructor(eventsSdkClass: EventsSdkClass);
|
|
@@ -77,20 +63,6 @@ export declare type changeIsMutedListener = (value: boolean) => void
|
|
|
77
63
|
|
|
78
64
|
export declare type changeMuteWhenJoinListener = (value: boolean) => void
|
|
79
65
|
|
|
80
|
-
/**
|
|
81
|
-
* Base structure for all event types, containing common properties.
|
|
82
|
-
*/
|
|
83
|
-
export declare interface CommonEventProperties {
|
|
84
|
-
// Error code, 0 indicates no error
|
|
85
|
-
errorCode?: number
|
|
86
|
-
// Description of the error, "Ok" indicates successful connection
|
|
87
|
-
errorDesc?: string
|
|
88
|
-
// Server time at the moment of the event
|
|
89
|
-
serverTime: number
|
|
90
|
-
// Difference in time between server and client
|
|
91
|
-
serverTimeOffset: number
|
|
92
|
-
}
|
|
93
|
-
|
|
94
66
|
export declare interface CustomData {
|
|
95
67
|
DoNotCallMeStatus?: string,
|
|
96
68
|
DoNotCallMeStatusCode?: DoNotCallMeStatusCodeEnum,
|
|
@@ -109,20 +81,6 @@ export declare interface Dialer {
|
|
|
109
81
|
statistics: unknown
|
|
110
82
|
}
|
|
111
83
|
|
|
112
|
-
/**
|
|
113
|
-
* Data structure for dialer event.
|
|
114
|
-
*/
|
|
115
|
-
export declare interface DialerEvent extends CommonEventProperties {
|
|
116
|
-
data: Dialer
|
|
117
|
-
eventName: EventNameEnum.DIALER
|
|
118
|
-
//reason: ExtensionEventReasonEnum // TODO: do research for dialer 'reason' prop
|
|
119
|
-
telephonyServerTime?: number
|
|
120
|
-
callerID?: string
|
|
121
|
-
ivrUniqueId?: string
|
|
122
|
-
dialStatus?: string
|
|
123
|
-
//cause?: ExtensionHangupCauseEnum // TODO: do research for dialer 'cause' prop
|
|
124
|
-
}
|
|
125
|
-
|
|
126
84
|
export declare enum DialerType {
|
|
127
85
|
AUTOMATIC = "Automatic",
|
|
128
86
|
IVR = "IVR"
|
|
@@ -171,6 +129,7 @@ export declare interface EventDataMap {
|
|
|
171
129
|
[EventsEnum.LOGIN_STATUS]: LoginStatusEvent
|
|
172
130
|
[EventsEnum.KEEP_ALIVE_RESPONSE]: KeepAliveResponseEvent
|
|
173
131
|
[EventsEnum.ONLINE_STATUS_EVENT]: OnlineStatusEvent
|
|
132
|
+
[EventsEnum.EXTENSIONS_UPDATED]: string
|
|
174
133
|
}
|
|
175
134
|
|
|
176
135
|
declare class EventEmitterClass {
|
|
@@ -194,26 +153,6 @@ export declare enum EventNameEnum {
|
|
|
194
153
|
DIALER = "dialer"
|
|
195
154
|
}
|
|
196
155
|
|
|
197
|
-
/**
|
|
198
|
-
* All events that can be received from the server.
|
|
199
|
-
*/
|
|
200
|
-
export declare enum EventsEnum {
|
|
201
|
-
ALL_DIALER_STATUS = "AllDialersStatus",
|
|
202
|
-
ALL_EXTENSION_STATUS = "AllExtensionsStatus",
|
|
203
|
-
ALL_USERS_STATUS = "AllUsersStatus",
|
|
204
|
-
CONNECT = "connect",
|
|
205
|
-
DISCONNECT = "disconnect",
|
|
206
|
-
CONNECT_ERROR_EVENT = "connect_error",
|
|
207
|
-
EXTENSION_EVENT = "ExtensionEvent",
|
|
208
|
-
KEEP_ALIVE = "keepalive",
|
|
209
|
-
KEEP_ALIVE_RESPONSE = "keepaliveResponse",
|
|
210
|
-
LOGIN_STATUS = "loginStatus",
|
|
211
|
-
LOGIN_SUCCESS = "loginSuccess",
|
|
212
|
-
QUEUE_EVENT = "QueueEvent",
|
|
213
|
-
ONLINE_STATUS_EVENT = "onlineStatusEvent",
|
|
214
|
-
DIALER_EVENT = "DialerEvent"
|
|
215
|
-
}
|
|
216
|
-
|
|
217
156
|
/**
|
|
218
157
|
* This is a generic type for callback functions used in event handling.
|
|
219
158
|
* It takes a generic event name and defines a callback function that receives wrapped socket event data for that specific event.
|
|
@@ -384,20 +323,6 @@ export declare interface ExtensionCall {
|
|
|
384
323
|
actualDialedNumber?: number
|
|
385
324
|
}
|
|
386
325
|
|
|
387
|
-
/**
|
|
388
|
-
* Data structure for extension event.
|
|
389
|
-
*/
|
|
390
|
-
export declare interface ExtensionEvent extends CommonEventProperties {
|
|
391
|
-
data: Extension
|
|
392
|
-
eventName: EventNameEnum.EXTENSION
|
|
393
|
-
reason: ExtensionEventReasonEnum
|
|
394
|
-
telephonyServerTime?: number
|
|
395
|
-
callerID?: string
|
|
396
|
-
ivrUniqueId?: string
|
|
397
|
-
dialStatus?: string
|
|
398
|
-
cause?: ExtensionHangupCauseEnum
|
|
399
|
-
}
|
|
400
|
-
|
|
401
326
|
/**
|
|
402
327
|
* All the reasons for the extension event, e.g. a new call is ringing or dialing from an extension.
|
|
403
328
|
*/
|
|
@@ -449,13 +374,6 @@ export declare interface ExternalLoginResponse<T> {
|
|
|
449
374
|
*/
|
|
450
375
|
export declare type GenericEventWrapper = EventWrappedSocketDataMap[EventTypeNames]
|
|
451
376
|
|
|
452
|
-
/**
|
|
453
|
-
* Data structure for keep alive response event.
|
|
454
|
-
*/
|
|
455
|
-
export declare interface KeepAliveResponseEvent extends CommonEventProperties {
|
|
456
|
-
isOk: boolean
|
|
457
|
-
}
|
|
458
|
-
|
|
459
377
|
export declare type ListenerCallbackFnType<T extends ListenersKeyType> = OpenSIPSEventMap[T]
|
|
460
378
|
|
|
461
379
|
export declare type ListenersCallbackFnType = OpenSIPSEventMap[ListenersKeyType]
|
|
@@ -504,16 +422,6 @@ export declare interface LoginSessionPayload {
|
|
|
504
422
|
password: string
|
|
505
423
|
}
|
|
506
424
|
|
|
507
|
-
/**
|
|
508
|
-
* Data structure for login status event.
|
|
509
|
-
*/
|
|
510
|
-
export declare interface LoginStatusEvent extends CommonEventProperties {
|
|
511
|
-
// Array of Queue objects
|
|
512
|
-
queues: Queue[]
|
|
513
|
-
}
|
|
514
|
-
|
|
515
|
-
export declare type LoginSuccessEvent = CommonEventProperties
|
|
516
|
-
|
|
517
425
|
declare enum LoginType {
|
|
518
426
|
USER = "User",
|
|
519
427
|
TOKEN = "Token"
|
|
@@ -562,17 +470,6 @@ export declare interface QueueCall {
|
|
|
562
470
|
isDistributedQueue?: boolean
|
|
563
471
|
}
|
|
564
472
|
|
|
565
|
-
/**
|
|
566
|
-
* Data structure for queue event.
|
|
567
|
-
*/
|
|
568
|
-
export declare interface QueueEvent extends CommonEventProperties {
|
|
569
|
-
eventName: EventNameEnum.QUEUE,
|
|
570
|
-
reason: QueueEventReasonEnum,
|
|
571
|
-
telephonyServerTime: number,
|
|
572
|
-
ivrUniqueId: string,
|
|
573
|
-
data: Queue
|
|
574
|
-
}
|
|
575
|
-
|
|
576
473
|
export declare enum QueueEventReasonEnum {
|
|
577
474
|
ANSWER = "ANSWER",
|
|
578
475
|
ABANDONED = "ABANDONED",
|