@webex/contact-center 3.12.0 → 3.13.0-next.10
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/.repo-context.json +704 -0
- package/.sdd/manifest.json +1613 -0
- package/AGENTS.md +969 -0
- package/dist/cc.js +1102 -47
- package/dist/cc.js.map +1 -1
- package/dist/config.js +13 -0
- package/dist/config.js.map +1 -1
- package/dist/constants.js +46 -3
- package/dist/constants.js.map +1 -1
- package/dist/index.js +86 -17
- package/dist/index.js.map +1 -1
- package/dist/metrics/MetricsManager.js +16 -0
- package/dist/metrics/MetricsManager.js.map +1 -1
- package/dist/metrics/behavioral-events.js +211 -0
- package/dist/metrics/behavioral-events.js.map +1 -1
- package/dist/metrics/constants.js +58 -4
- package/dist/metrics/constants.js.map +1 -1
- package/dist/services/AddressBook.js +18 -15
- package/dist/services/AddressBook.js.map +1 -1
- package/dist/services/AnswerCallOnWebexService.js +202 -0
- package/dist/services/AnswerCallOnWebexService.js.map +1 -0
- package/dist/services/ApiAiAssistant.js +369 -14
- package/dist/services/ApiAiAssistant.js.map +1 -1
- package/dist/services/EntryPoint.js +46 -68
- package/dist/services/EntryPoint.js.map +1 -1
- package/dist/services/Queue.js +27 -22
- package/dist/services/Queue.js.map +1 -1
- package/dist/services/UserPreference.js +427 -0
- package/dist/services/UserPreference.js.map +1 -0
- package/dist/services/WebCallingService.js +287 -37
- package/dist/services/WebCallingService.js.map +1 -1
- package/dist/services/WebexCrossClientService.js +225 -0
- package/dist/services/WebexCrossClientService.js.map +1 -0
- package/dist/services/WxAppTelephonyMercurySync.js +111 -0
- package/dist/services/WxAppTelephonyMercurySync.js.map +1 -0
- package/dist/services/config/Util.js +48 -48
- package/dist/services/config/Util.js.map +1 -1
- package/dist/services/config/constants.js +57 -79
- package/dist/services/config/constants.js.map +1 -1
- package/dist/services/config/index.js +100 -226
- package/dist/services/config/index.js.map +1 -1
- package/dist/services/config/types.js +100 -40
- package/dist/services/config/types.js.map +1 -1
- package/dist/services/constants.js +19 -1
- package/dist/services/constants.js.map +1 -1
- package/dist/services/core/Err.js.map +1 -1
- package/dist/services/core/Utils.js +131 -32
- package/dist/services/core/Utils.js.map +1 -1
- package/dist/services/core/WebexRequest.js +6 -2
- package/dist/services/core/WebexRequest.js.map +1 -1
- package/dist/services/core/aqm-reqs.js +17 -11
- package/dist/services/core/aqm-reqs.js.map +1 -1
- package/dist/services/core/constants.js +9 -1
- package/dist/services/core/constants.js.map +1 -1
- package/dist/services/core/types.js.map +1 -1
- package/dist/services/core/websocket/WebSocketManager.js +26 -6
- package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
- package/dist/services/core/websocket/connection-service.js +3 -1
- package/dist/services/core/websocket/connection-service.js.map +1 -1
- package/dist/services/core/websocket/types.js.map +1 -1
- package/dist/services/index.js +6 -0
- package/dist/services/index.js.map +1 -1
- package/dist/services/task/Task.js +955 -0
- package/dist/services/task/Task.js.map +1 -0
- package/dist/services/task/TaskFactory.js +50 -0
- package/dist/services/task/TaskFactory.js.map +1 -0
- package/dist/services/task/TaskManager.js +1275 -504
- package/dist/services/task/TaskManager.js.map +1 -1
- package/dist/services/task/TaskUtils.js +221 -27
- package/dist/services/task/TaskUtils.js.map +1 -1
- package/dist/services/task/WebexCallingUtils.js +70 -0
- package/dist/services/task/WebexCallingUtils.js.map +1 -0
- package/dist/services/task/constants.js +22 -2
- package/dist/services/task/constants.js.map +1 -1
- package/dist/services/task/contact.js +29 -0
- package/dist/services/task/contact.js.map +1 -1
- package/dist/services/task/dialer.js +78 -0
- package/dist/services/task/dialer.js.map +1 -1
- package/dist/services/task/digital/Digital.js +78 -0
- package/dist/services/task/digital/Digital.js.map +1 -0
- package/dist/services/task/state-machine/TaskStateMachine.js +982 -0
- package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -0
- package/dist/services/task/state-machine/actions.js +572 -0
- package/dist/services/task/state-machine/actions.js.map +1 -0
- package/dist/services/task/state-machine/constants.js +161 -0
- package/dist/services/task/state-machine/constants.js.map +1 -0
- package/dist/services/task/state-machine/guards.js +379 -0
- package/dist/services/task/state-machine/guards.js.map +1 -0
- package/dist/services/task/state-machine/index.js +53 -0
- package/dist/services/task/state-machine/index.js.map +1 -0
- package/dist/services/task/state-machine/types.js +54 -0
- package/dist/services/task/state-machine/types.js.map +1 -0
- package/dist/services/task/state-machine/uiControlsComputer.js +703 -0
- package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -0
- package/dist/services/task/taskDataNormalizer.js +99 -0
- package/dist/services/task/taskDataNormalizer.js.map +1 -0
- package/dist/services/task/types.js +259 -5
- package/dist/services/task/types.js.map +1 -1
- package/dist/services/task/voice/Voice.js +1504 -0
- package/dist/services/task/voice/Voice.js.map +1 -0
- package/dist/services/task/voice/WebRTC.js +152 -0
- package/dist/services/task/voice/WebRTC.js.map +1 -0
- package/dist/services/task/voice/wxAppOfferObservability.js +145 -0
- package/dist/services/task/voice/wxAppOfferObservability.js.map +1 -0
- package/dist/services/task/voice/wxAppVoiceMethods.js +395 -0
- package/dist/services/task/voice/wxAppVoiceMethods.js.map +1 -0
- package/dist/services/wxAppDiagnosticLogging.js +159 -0
- package/dist/services/wxAppDiagnosticLogging.js.map +1 -0
- package/dist/services/wxAppTelephonyUtils.js +19 -0
- package/dist/services/wxAppTelephonyUtils.js.map +1 -0
- package/dist/types/cc.d.ts +222 -10
- package/dist/types/config.d.ts +13 -0
- package/dist/types/constants.d.ts +40 -1
- package/dist/types/index.d.ts +58 -22
- package/dist/types/metrics/MetricsManager.d.ts +6 -0
- package/dist/types/metrics/constants.d.ts +52 -1
- package/dist/types/services/AddressBook.d.ts +2 -1
- package/dist/types/services/AnswerCallOnWebexService.d.ts +38 -0
- package/dist/types/services/ApiAiAssistant.d.ts +67 -5
- package/dist/types/services/EntryPoint.d.ts +7 -5
- package/dist/types/services/Queue.d.ts +5 -3
- package/dist/types/services/UserPreference.d.ts +118 -0
- package/dist/types/services/WebexCrossClientService.d.ts +32 -0
- package/dist/types/services/WxAppTelephonyMercurySync.d.ts +28 -0
- package/dist/types/services/config/Util.d.ts +4 -8
- package/dist/types/services/config/constants.d.ts +49 -76
- package/dist/types/services/config/index.d.ts +16 -64
- package/dist/types/services/config/types.d.ts +252 -114
- package/dist/types/services/constants.d.ts +16 -0
- package/dist/types/services/core/Err.d.ts +6 -0
- package/dist/types/services/core/Utils.d.ts +43 -13
- package/dist/types/services/core/WebexRequest.d.ts +1 -0
- package/dist/types/services/core/constants.d.ts +7 -0
- package/dist/types/services/core/types.d.ts +2 -0
- package/dist/types/services/core/websocket/WebSocketManager.d.ts +2 -0
- package/dist/types/services/core/websocket/types.d.ts +1 -1
- package/dist/types/services/index.d.ts +2 -0
- package/dist/types/services/task/Task.d.ts +186 -0
- package/dist/types/services/task/TaskFactory.d.ts +14 -0
- package/dist/types/services/task/TaskUtils.d.ts +54 -2
- package/dist/types/services/task/WebexCallingUtils.d.ts +11 -0
- package/dist/types/services/task/constants.d.ts +20 -0
- package/dist/types/services/task/contact.d.ts +4 -0
- package/dist/types/services/task/dialer.d.ts +30 -0
- package/dist/types/services/task/digital/Digital.d.ts +23 -0
- package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +1442 -0
- package/dist/types/services/task/state-machine/actions.d.ts +10 -0
- package/dist/types/services/task/state-machine/constants.d.ts +107 -0
- package/dist/types/services/task/state-machine/guards.d.ts +103 -0
- package/dist/types/services/task/state-machine/index.d.ts +13 -0
- package/dist/types/services/task/state-machine/types.d.ts +277 -0
- package/dist/types/services/task/state-machine/uiControlsComputer.d.ts +9 -0
- package/dist/types/services/task/taskDataNormalizer.d.ts +10 -0
- package/dist/types/services/task/types.d.ts +790 -66
- package/dist/types/services/task/voice/Voice.d.ts +241 -0
- package/dist/types/services/task/voice/WebRTC.d.ts +54 -0
- package/dist/types/services/task/voice/wxAppOfferObservability.d.ts +39 -0
- package/dist/types/services/task/voice/wxAppVoiceMethods.d.ts +68 -0
- package/dist/types/services/wxAppDiagnosticLogging.d.ts +63 -0
- package/dist/types/services/wxAppTelephonyUtils.d.ts +5 -0
- package/dist/types/types.d.ts +258 -11
- package/dist/types/utils/PageCache.d.ts +20 -3
- package/dist/types/webex.d.ts +1 -0
- package/dist/types.js +204 -6
- package/dist/types.js.map +1 -1
- package/dist/utils/PageCache.js +19 -5
- package/dist/utils/PageCache.js.map +1 -1
- package/dist/webex.js +22 -2
- package/dist/webex.js.map +1 -1
- package/docs/adr/0001-spec-source-policy.md +97 -0
- package/docs/adr/0002-consult-transfer-list-policy.md +345 -0
- package/docs/adr/0003-repo-standards-migration.md +104 -0
- package/docs/adr/index.md +35 -0
- package/docs/architecture.md +460 -0
- package/docs/getting-started.md +142 -0
- package/docs/index.md +53 -0
- package/docs/specs/README.md +98 -0
- package/package.json +17 -12
- package/schemas/repo-context.schema.json +796 -0
- package/src/cc.ts +1439 -105
- package/src/config.ts +13 -0
- package/src/constants.ts +53 -1
- package/src/docs/README.md +727 -0
- package/src/index.ts +72 -16
- package/src/metrics/MetricsManager.ts +16 -0
- package/src/metrics/behavioral-events.ts +218 -0
- package/src/metrics/constants.ts +63 -4
- package/src/metrics/docs/README.md +710 -0
- package/src/services/AddressBook.ts +17 -6
- package/src/services/AnswerCallOnWebexService.ts +239 -0
- package/src/services/ApiAiAssistant.ts +494 -15
- package/src/services/EntryPoint.ts +59 -60
- package/src/services/Queue.ts +29 -12
- package/src/services/UserPreference.ts +509 -0
- package/src/services/WebCallingService.ts +362 -40
- package/src/services/WebexCrossClientService.ts +298 -0
- package/src/services/WxAppTelephonyMercurySync.ts +142 -0
- package/src/services/agent/docs/README.md +673 -0
- package/src/services/config/Util.ts +54 -84
- package/src/services/config/constants.ts +64 -86
- package/src/services/config/docs/README.md +530 -0
- package/src/services/config/index.ts +116 -277
- package/src/services/config/types.ts +238 -125
- package/src/services/constants.ts +18 -0
- package/src/services/core/Err.ts +3 -0
- package/src/services/core/Utils.ts +151 -37
- package/src/services/core/WebexRequest.ts +3 -1
- package/src/services/core/aqm-reqs.ts +18 -12
- package/src/services/core/constants.ts +8 -0
- package/src/services/core/docs/README.md +993 -0
- package/src/services/core/types.ts +33 -1
- package/src/services/core/websocket/WebSocketManager.ts +37 -8
- package/src/services/core/websocket/connection-service.ts +5 -1
- package/src/services/core/websocket/types.ts +1 -1
- package/src/services/docs/README.md +765 -0
- package/src/services/index.ts +4 -0
- package/src/services/task/Task.ts +1211 -0
- package/src/services/task/TaskFactory.ts +82 -0
- package/src/services/task/TaskManager.ts +1551 -584
- package/src/services/task/TaskUtils.ts +316 -25
- package/src/services/task/WebexCallingUtils.ts +136 -0
- package/src/services/task/constants.ts +21 -0
- package/src/services/task/contact.ts +30 -0
- package/src/services/task/dialer.ts +80 -0
- package/src/services/task/digital/Digital.ts +102 -0
- package/src/services/task/docs/README.md +1569 -0
- package/src/services/task/state-machine/TaskStateMachine.ts +1320 -0
- package/src/services/task/state-machine/actions.ts +741 -0
- package/src/services/task/state-machine/constants.ts +172 -0
- package/src/services/task/state-machine/docs/README.md +1388 -0
- package/src/services/task/state-machine/guards.ts +442 -0
- package/src/services/task/state-machine/index.ts +28 -0
- package/src/services/task/state-machine/types.ts +258 -0
- package/src/services/task/state-machine/uiControlsComputer.ts +1135 -0
- package/src/services/task/taskDataNormalizer.ts +137 -0
- package/src/services/task/types.ts +974 -70
- package/src/services/task/voice/Voice.ts +1878 -0
- package/src/services/task/voice/WebRTC.ts +194 -0
- package/src/services/task/voice/wxAppOfferObservability.ts +204 -0
- package/src/services/task/voice/wxAppVoiceMethods.ts +575 -0
- package/src/services/wxAppDiagnosticLogging.ts +286 -0
- package/src/services/wxAppTelephonyUtils.ts +14 -0
- package/src/types.ts +323 -13
- package/src/utils/AGENTS.md +291 -0
- package/src/utils/PageCache.ts +38 -5
- package/src/utils/docs/README.md +413 -0
- package/src/webex.js +10 -0
- package/test/unit/fixtures/aiSummaryTestUtils.ts +40 -0
- package/test/unit/spec/cc.ts +4046 -181
- package/test/unit/spec/index.ts +891 -0
- package/test/unit/spec/logger-proxy.ts +70 -0
- package/test/unit/spec/metrics/MetricsManager.ts +25 -0
- package/test/unit/spec/metrics/behavioral-events.ts +60 -0
- package/test/unit/spec/services/AddressBook.ts +37 -6
- package/test/unit/spec/services/AnswerCallOnWebexService.ts +264 -0
- package/test/unit/spec/services/ApiAiAssistant.ts +442 -23
- package/test/unit/spec/services/EntryPoint.ts +87 -40
- package/test/unit/spec/services/Queue.ts +123 -12
- package/test/unit/spec/services/UserPreference.ts +401 -0
- package/test/unit/spec/services/WebCallingService.ts +484 -49
- package/test/unit/spec/services/WebexCrossClientService.ts +509 -0
- package/test/unit/spec/services/WxAppTelephonyMercurySync.ts +136 -0
- package/test/unit/spec/services/config/Util.ts +501 -0
- package/test/unit/spec/services/config/index.ts +318 -548
- package/test/unit/spec/services/core/Utils.ts +447 -8
- package/test/unit/spec/services/core/WebexRequest.ts +8 -7
- package/test/unit/spec/services/core/aqm-reqs.ts +142 -1
- package/test/unit/spec/services/core/websocket/WebSocketManager.ts +132 -56
- package/test/unit/spec/services/core/websocket/connection-service.ts +3 -1
- package/test/unit/spec/services/task/AutoWrapup.ts +63 -0
- package/test/unit/spec/services/task/Task.ts +2723 -0
- package/test/unit/spec/services/task/TaskFactory.ts +116 -0
- package/test/unit/spec/services/task/TaskManager.ts +4800 -1586
- package/test/unit/spec/services/task/TaskUtils.ts +307 -0
- package/test/unit/spec/services/task/WebexCallingUtils.ts +153 -0
- package/test/unit/spec/services/task/contact.ts +33 -0
- package/test/unit/spec/services/task/dialer.ts +190 -0
- package/test/unit/spec/services/task/digital/Digital.ts +105 -0
- package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +4060 -0
- package/test/unit/spec/services/task/state-machine/guards.ts +839 -0
- package/test/unit/spec/services/task/state-machine/types.ts +18 -0
- package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +3101 -0
- package/test/unit/spec/services/task/taskTestUtils.ts +87 -0
- package/test/unit/spec/services/task/voice/Voice.ts +2355 -0
- package/test/unit/spec/services/task/voice/WebRTC.ts +235 -0
- package/test/unit/spec/services/task/voice/wxAppOfferObservability.ts +361 -0
- package/test/unit/spec/services/task/voice/wxAppVoiceMethods.ts +719 -0
- package/test/unit/spec/services/wxAppDiagnosticLogging.ts +179 -0
- package/test/unit/spec/wellnessSampleUtils.ts +288 -0
- package/typedoc.md +1 -1
- package/umd/contact-center.min.js +2 -2
- package/umd/contact-center.min.js.map +1 -1
- package/dist/services/task/index.js +0 -1525
- package/dist/services/task/index.js.map +0 -1
- package/dist/types/services/task/index.d.ts +0 -650
- package/src/services/task/index.ts +0 -1801
- package/test/unit/spec/services/task/index.ts +0 -2184
|
@@ -0,0 +1,298 @@
|
|
|
1
|
+
import LoggerProxy from '../logger-proxy';
|
|
2
|
+
import {METHODS} from '../constants';
|
|
3
|
+
import {WebexSDK} from '../types';
|
|
4
|
+
import MetricsManager from '../metrics/MetricsManager';
|
|
5
|
+
import {METRIC_EVENT_NAMES} from '../metrics/constants';
|
|
6
|
+
|
|
7
|
+
const WEBEX_CROSS_CLIENT_FILE = 'WebexCrossClientService';
|
|
8
|
+
const DEFAULT_CROSS_CLIENT_STATE_TTL = 900;
|
|
9
|
+
const EXPIRATION_OFFSET_MS = 60_000;
|
|
10
|
+
/** Must match Agent Desktop usersub publish — Webex App reads `wxcc` cross-client state. */
|
|
11
|
+
const DEFAULT_APP_NAME = 'wxcc';
|
|
12
|
+
const REFRESH_RETRY_DELAY_MS = 30_000;
|
|
13
|
+
const MAX_REFRESH_RETRIES = 3;
|
|
14
|
+
|
|
15
|
+
type RefreshTimer = ReturnType<typeof setTimeout>;
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Publishes usersub cross-client state so Webex App suppresses native calling toasts (WXCC-6026).
|
|
19
|
+
*/
|
|
20
|
+
export default class WebexCrossClientService {
|
|
21
|
+
private webex: WebexSDK;
|
|
22
|
+
private refreshTimer?: RefreshTimer;
|
|
23
|
+
private refreshRetryTimer?: RefreshTimer;
|
|
24
|
+
private answerCallsState = false;
|
|
25
|
+
private appName = DEFAULT_APP_NAME;
|
|
26
|
+
/** Incremented on teardown/disable to ignore stale refresh timer callbacks. */
|
|
27
|
+
private refreshGeneration = 0;
|
|
28
|
+
/** Monotonic id for usersub publish metrics timers; stale publishes cancel only their own timer. */
|
|
29
|
+
private usersubPublishMetricsId = 0;
|
|
30
|
+
|
|
31
|
+
constructor(webex: WebexSDK) {
|
|
32
|
+
this.webex = webex;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
private extractDeviceIdFromUrl(url: string): string {
|
|
36
|
+
const match = url.match(/\/devices\/([^/?]+)/);
|
|
37
|
+
|
|
38
|
+
return match ? match[1] : '';
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
private getDeviceUrl(): string | undefined {
|
|
42
|
+
return this.webex.internal.device?.url;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
private clearRefreshTimer(): void {
|
|
46
|
+
if (this.refreshTimer) {
|
|
47
|
+
clearTimeout(this.refreshTimer);
|
|
48
|
+
this.refreshTimer = undefined;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
if (this.refreshRetryTimer) {
|
|
52
|
+
clearTimeout(this.refreshRetryTimer);
|
|
53
|
+
this.refreshRetryTimer = undefined;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
private scheduleRefreshRetry(
|
|
58
|
+
userId: string,
|
|
59
|
+
ttl: number,
|
|
60
|
+
scheduledGeneration: number,
|
|
61
|
+
retryAttempt: number
|
|
62
|
+
): void {
|
|
63
|
+
if (
|
|
64
|
+
retryAttempt >= MAX_REFRESH_RETRIES ||
|
|
65
|
+
scheduledGeneration !== this.refreshGeneration ||
|
|
66
|
+
!this.answerCallsState
|
|
67
|
+
) {
|
|
68
|
+
return;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
this.refreshRetryTimer = setTimeout(async () => {
|
|
72
|
+
if (scheduledGeneration !== this.refreshGeneration || !this.answerCallsState) {
|
|
73
|
+
return;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
try {
|
|
77
|
+
await this.setManageWebexCallingInWxcc(true, {userId, ttl, appName: this.appName});
|
|
78
|
+
} catch (error) {
|
|
79
|
+
LoggerProxy.error(`WebexCrossClientService refresh retry failed: ${error}`, {
|
|
80
|
+
module: WEBEX_CROSS_CLIENT_FILE,
|
|
81
|
+
method: METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC,
|
|
82
|
+
});
|
|
83
|
+
this.scheduleRefreshRetry(userId, ttl, scheduledGeneration, retryAttempt + 1);
|
|
84
|
+
}
|
|
85
|
+
}, REFRESH_RETRY_DELAY_MS);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
private startRefreshTimer(userId: string, ttl: number): void {
|
|
89
|
+
this.clearRefreshTimer();
|
|
90
|
+
|
|
91
|
+
if (!this.answerCallsState) {
|
|
92
|
+
return;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
const refreshTime = ttl * 1000 - EXPIRATION_OFFSET_MS;
|
|
96
|
+
const scheduledGeneration = this.refreshGeneration;
|
|
97
|
+
this.refreshTimer = setTimeout(async () => {
|
|
98
|
+
if (scheduledGeneration !== this.refreshGeneration || !this.answerCallsState) {
|
|
99
|
+
return;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
try {
|
|
103
|
+
await this.setManageWebexCallingInWxcc(true, {userId, ttl, appName: this.appName});
|
|
104
|
+
} catch (error) {
|
|
105
|
+
LoggerProxy.error(`WebexCrossClientService refresh failed: ${error}`, {
|
|
106
|
+
module: WEBEX_CROSS_CLIENT_FILE,
|
|
107
|
+
method: METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC,
|
|
108
|
+
});
|
|
109
|
+
this.scheduleRefreshRetry(userId, ttl, scheduledGeneration, 0);
|
|
110
|
+
}
|
|
111
|
+
}, refreshTime);
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
private publishCrossClientState(
|
|
115
|
+
users: string[],
|
|
116
|
+
ttl: number,
|
|
117
|
+
composition: Record<string, unknown>,
|
|
118
|
+
logContext: string
|
|
119
|
+
): Promise<unknown> {
|
|
120
|
+
const body = {
|
|
121
|
+
users,
|
|
122
|
+
compositions: [
|
|
123
|
+
{
|
|
124
|
+
type: 'cross-client-state',
|
|
125
|
+
ttl,
|
|
126
|
+
composition,
|
|
127
|
+
},
|
|
128
|
+
],
|
|
129
|
+
};
|
|
130
|
+
|
|
131
|
+
return this.webex
|
|
132
|
+
.request({
|
|
133
|
+
method: 'POST',
|
|
134
|
+
service: 'usersub',
|
|
135
|
+
resource: 'publish',
|
|
136
|
+
body,
|
|
137
|
+
})
|
|
138
|
+
.then((response: {body?: unknown}) => response?.body)
|
|
139
|
+
.catch((error: unknown) => {
|
|
140
|
+
LoggerProxy.error(`WebexCrossClientService.${logContext} failed: ${error}`, {
|
|
141
|
+
module: WEBEX_CROSS_CLIENT_FILE,
|
|
142
|
+
method: METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC,
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
return Promise.reject(error);
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
public async setManageWebexCallingInWxcc(
|
|
150
|
+
enable: boolean,
|
|
151
|
+
options?: {userId?: string; ttl?: number; appName?: string; trackPublishMetrics?: boolean}
|
|
152
|
+
): Promise<void> {
|
|
153
|
+
const operationGeneration = this.refreshGeneration;
|
|
154
|
+
const userId = options?.userId ?? this.webex.internal.device?.userId;
|
|
155
|
+
const ttl = options?.ttl ?? DEFAULT_CROSS_CLIENT_STATE_TTL;
|
|
156
|
+
const appName = options?.appName ?? DEFAULT_APP_NAME;
|
|
157
|
+
const trackPublishMetrics = options?.trackPublishMetrics ?? false;
|
|
158
|
+
this.appName = appName;
|
|
159
|
+
|
|
160
|
+
if (!userId) {
|
|
161
|
+
const error = 'User ID is unavailable for cross-client publish';
|
|
162
|
+
this.trackUsersubPreflightFailure(enable, 'user_id_unavailable', error, trackPublishMetrics);
|
|
163
|
+
throw new Error(error);
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
const deviceUrl = this.getDeviceUrl();
|
|
167
|
+
if (!deviceUrl) {
|
|
168
|
+
const error = 'Device URL is unavailable for cross-client publish';
|
|
169
|
+
this.trackUsersubPreflightFailure(
|
|
170
|
+
enable,
|
|
171
|
+
'device_url_unavailable',
|
|
172
|
+
error,
|
|
173
|
+
trackPublishMetrics
|
|
174
|
+
);
|
|
175
|
+
throw new Error(error);
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
const composition = {
|
|
179
|
+
devices: [
|
|
180
|
+
{
|
|
181
|
+
deviceId: this.extractDeviceIdFromUrl(deviceUrl),
|
|
182
|
+
appName,
|
|
183
|
+
state: {
|
|
184
|
+
'answer-calls-on-wxcc': enable,
|
|
185
|
+
},
|
|
186
|
+
},
|
|
187
|
+
],
|
|
188
|
+
};
|
|
189
|
+
|
|
190
|
+
const metricsManager = MetricsManager.getInstance();
|
|
191
|
+
const usersubPublishEventKeys = [
|
|
192
|
+
METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_SUCCESS,
|
|
193
|
+
METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_FAILED,
|
|
194
|
+
];
|
|
195
|
+
|
|
196
|
+
let publishMetricsId = 0;
|
|
197
|
+
if (trackPublishMetrics) {
|
|
198
|
+
this.usersubPublishMetricsId += 1;
|
|
199
|
+
publishMetricsId = this.usersubPublishMetricsId;
|
|
200
|
+
metricsManager.timeEvent(usersubPublishEventKeys);
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
try {
|
|
204
|
+
await this.publishCrossClientState([userId], ttl, composition, 'setManageWebexCallingInWxcc');
|
|
205
|
+
} catch (error) {
|
|
206
|
+
if (trackPublishMetrics) {
|
|
207
|
+
if (operationGeneration !== this.refreshGeneration) {
|
|
208
|
+
if (publishMetricsId === this.usersubPublishMetricsId) {
|
|
209
|
+
metricsManager.cancelTimedEvent(usersubPublishEventKeys);
|
|
210
|
+
}
|
|
211
|
+
} else {
|
|
212
|
+
metricsManager.trackEvent(
|
|
213
|
+
METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_FAILED,
|
|
214
|
+
{
|
|
215
|
+
enableWxBetterTogether: enable,
|
|
216
|
+
usersubPublished: this.answerCallsState,
|
|
217
|
+
error: error instanceof Error ? error.toString() : String(error),
|
|
218
|
+
},
|
|
219
|
+
['operational', 'behavioral']
|
|
220
|
+
);
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
throw error;
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
if (operationGeneration !== this.refreshGeneration) {
|
|
228
|
+
if (trackPublishMetrics && publishMetricsId === this.usersubPublishMetricsId) {
|
|
229
|
+
metricsManager.cancelTimedEvent(usersubPublishEventKeys);
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
return;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
this.answerCallsState = enable;
|
|
236
|
+
|
|
237
|
+
if (enable) {
|
|
238
|
+
this.startRefreshTimer(userId, ttl);
|
|
239
|
+
} else {
|
|
240
|
+
this.refreshGeneration += 1;
|
|
241
|
+
this.clearRefreshTimer();
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
if (trackPublishMetrics) {
|
|
245
|
+
metricsManager.trackEvent(
|
|
246
|
+
METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_SUCCESS,
|
|
247
|
+
{
|
|
248
|
+
enableWxBetterTogether: enable,
|
|
249
|
+
usersubPublished: enable,
|
|
250
|
+
},
|
|
251
|
+
['operational', 'behavioral']
|
|
252
|
+
);
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
LoggerProxy.log(`Cross-client answer-calls-on-wxcc set to ${enable}`, {
|
|
256
|
+
module: WEBEX_CROSS_CLIENT_FILE,
|
|
257
|
+
method: METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC,
|
|
258
|
+
data: {
|
|
259
|
+
appName,
|
|
260
|
+
deviceId: this.extractDeviceIdFromUrl(deviceUrl),
|
|
261
|
+
ttl,
|
|
262
|
+
},
|
|
263
|
+
});
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
private trackUsersubPreflightFailure(
|
|
267
|
+
enable: boolean,
|
|
268
|
+
skipReason: 'user_id_unavailable' | 'device_url_unavailable',
|
|
269
|
+
error: string,
|
|
270
|
+
trackPublishMetrics: boolean
|
|
271
|
+
): void {
|
|
272
|
+
if (!trackPublishMetrics) {
|
|
273
|
+
return;
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
MetricsManager.getInstance().trackEvent(
|
|
277
|
+
METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_FAILED,
|
|
278
|
+
{
|
|
279
|
+
enableWxBetterTogether: enable,
|
|
280
|
+
usersubPublished: this.answerCallsState,
|
|
281
|
+
skipReason,
|
|
282
|
+
error,
|
|
283
|
+
},
|
|
284
|
+
['operational', 'behavioral']
|
|
285
|
+
);
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
public teardown(): void {
|
|
289
|
+
this.refreshGeneration += 1;
|
|
290
|
+
this.clearRefreshTimer();
|
|
291
|
+
this.answerCallsState = false;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
/** Whether usersub `answer-calls-on-wxcc: true` was successfully published this session. */
|
|
295
|
+
public isAnswerCallsStateActive(): boolean {
|
|
296
|
+
return this.answerCallsState;
|
|
297
|
+
}
|
|
298
|
+
}
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
import LoggerProxy from '../logger-proxy';
|
|
2
|
+
import {METHODS} from '../constants';
|
|
3
|
+
import {WebexSDK} from '../types';
|
|
4
|
+
import MetricsManager from '../metrics/MetricsManager';
|
|
5
|
+
import {METRIC_EVENT_NAMES} from '../metrics/constants';
|
|
6
|
+
import {callIdSuffix, logWxAppMercuryMuteSync} from './wxAppDiagnosticLogging';
|
|
7
|
+
|
|
8
|
+
const WXAPP_TELEPHONY_MERCURY_SYNC_FILE = 'WxAppTelephonyMercurySync';
|
|
9
|
+
|
|
10
|
+
export const TELEPHONY_CALL_MUTED = 'event:telephony_calls.muted';
|
|
11
|
+
export const TELEPHONY_CALL_UNMUTED = 'event:telephony_calls.unmuted';
|
|
12
|
+
|
|
13
|
+
export type UpdatedCallMuteStateEvent = {
|
|
14
|
+
data: {
|
|
15
|
+
actorId: string;
|
|
16
|
+
callId: string;
|
|
17
|
+
muted: boolean;
|
|
18
|
+
};
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
type MuteChangeHandler = (callId: string, muted: boolean) => void;
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Subscribes to Mercury telephony mute/unmute events for wxApp thick-client sync (AD parity).
|
|
25
|
+
*/
|
|
26
|
+
export default class WxAppTelephonyMercurySync {
|
|
27
|
+
private webex: WebexSDK;
|
|
28
|
+
private subscribedAgentId?: string;
|
|
29
|
+
private muteChangeHandler?: MuteChangeHandler;
|
|
30
|
+
private boundMuteHandler?: (event: UpdatedCallMuteStateEvent) => void;
|
|
31
|
+
private boundUnmuteHandler?: (event: UpdatedCallMuteStateEvent) => void;
|
|
32
|
+
|
|
33
|
+
constructor(webex: WebexSDK) {
|
|
34
|
+
this.webex = webex;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
private decodeBase64(value: string): string {
|
|
38
|
+
try {
|
|
39
|
+
return atob(value);
|
|
40
|
+
} catch {
|
|
41
|
+
return value;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
private handleMuteStateEvent = (agentId: string, event: UpdatedCallMuteStateEvent): void => {
|
|
46
|
+
const {actorId, callId, muted} = event?.data ?? {};
|
|
47
|
+
if (!actorId || !callId || muted === undefined) {
|
|
48
|
+
logWxAppMercuryMuteSync({
|
|
49
|
+
phase: 'dropped',
|
|
50
|
+
dropReason: 'missing_mercury_event_fields',
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
const decodedActorId = this.decodeBase64(actorId);
|
|
57
|
+
const decodedCallId = this.decodeBase64(callId);
|
|
58
|
+
|
|
59
|
+
if (!decodedActorId.endsWith(agentId)) {
|
|
60
|
+
logWxAppMercuryMuteSync({
|
|
61
|
+
phase: 'dropped',
|
|
62
|
+
muted,
|
|
63
|
+
callIdSuffix: callIdSuffix(decodedCallId),
|
|
64
|
+
dropReason: 'actor_id_mismatch',
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
return;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
logWxAppMercuryMuteSync({
|
|
71
|
+
phase: 'received',
|
|
72
|
+
muted,
|
|
73
|
+
callIdSuffix: callIdSuffix(decodedCallId),
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
this.muteChangeHandler?.(decodedCallId, muted);
|
|
77
|
+
};
|
|
78
|
+
|
|
79
|
+
public subscribe(agentId: string, onMuteChange: MuteChangeHandler): void {
|
|
80
|
+
this.unsubscribe();
|
|
81
|
+
|
|
82
|
+
const mercury = this.webex.internal.mercury;
|
|
83
|
+
if (!mercury) {
|
|
84
|
+
LoggerProxy.error('Mercury is unavailable for wxApp mute sync', {
|
|
85
|
+
module: WXAPP_TELEPHONY_MERCURY_SYNC_FILE,
|
|
86
|
+
method: METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY,
|
|
87
|
+
});
|
|
88
|
+
|
|
89
|
+
MetricsManager.getInstance().trackEvent(
|
|
90
|
+
METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED,
|
|
91
|
+
{error: 'Mercury is unavailable for wxApp mute sync', mercurySubscribed: false},
|
|
92
|
+
['operational', 'behavioral']
|
|
93
|
+
);
|
|
94
|
+
|
|
95
|
+
return;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
this.subscribedAgentId = agentId;
|
|
99
|
+
this.muteChangeHandler = onMuteChange;
|
|
100
|
+
|
|
101
|
+
this.boundMuteHandler = (event: UpdatedCallMuteStateEvent) => {
|
|
102
|
+
this.handleMuteStateEvent(agentId, event);
|
|
103
|
+
};
|
|
104
|
+
this.boundUnmuteHandler = (event: UpdatedCallMuteStateEvent) => {
|
|
105
|
+
this.handleMuteStateEvent(agentId, event);
|
|
106
|
+
};
|
|
107
|
+
|
|
108
|
+
mercury.on(TELEPHONY_CALL_MUTED, this.boundMuteHandler);
|
|
109
|
+
mercury.on(TELEPHONY_CALL_UNMUTED, this.boundUnmuteHandler);
|
|
110
|
+
|
|
111
|
+
MetricsManager.getInstance().trackEvent(
|
|
112
|
+
METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_SUCCESS,
|
|
113
|
+
{mercurySubscribed: true},
|
|
114
|
+
['operational', 'behavioral']
|
|
115
|
+
);
|
|
116
|
+
|
|
117
|
+
LoggerProxy.log('Subscribed to wxApp telephony Mercury mute sync', {
|
|
118
|
+
module: WXAPP_TELEPHONY_MERCURY_SYNC_FILE,
|
|
119
|
+
method: METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY,
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
public unsubscribe(): void {
|
|
124
|
+
const mercury = this.webex.internal.mercury;
|
|
125
|
+
|
|
126
|
+
if (mercury && this.boundMuteHandler) {
|
|
127
|
+
mercury.off(TELEPHONY_CALL_MUTED, this.boundMuteHandler);
|
|
128
|
+
}
|
|
129
|
+
if (mercury && this.boundUnmuteHandler) {
|
|
130
|
+
mercury.off(TELEPHONY_CALL_UNMUTED, this.boundUnmuteHandler);
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
this.subscribedAgentId = undefined;
|
|
134
|
+
this.muteChangeHandler = undefined;
|
|
135
|
+
this.boundMuteHandler = undefined;
|
|
136
|
+
this.boundUnmuteHandler = undefined;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
public isSubscribed(): boolean {
|
|
140
|
+
return Boolean(this.subscribedAgentId && this.muteChangeHandler);
|
|
141
|
+
}
|
|
142
|
+
}
|