@wxcc-desktop/sdk 1.3.16 → 2.0.1
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/README.md +99 -37
- package/dist/index.js +10 -1
- package/dist/types/index.d.ts +3 -1
- package/dist/types/jsapi/actions-jsapi.d.ts +1 -1
- package/dist/types/jsapi/agent-config-jsapi.d.ts +19 -0
- package/dist/types/jsapi/agent-contact-jsapi.d.ts +76 -549
- package/dist/types/jsapi/agent-state-info-jsapi.d.ts +9 -26
- package/dist/types/jsapi/agent-station-logout-jsapi.d.ts +5 -15
- package/dist/types/jsapi/call-monitoring-jsapi.d.ts +5 -5
- package/dist/types/jsapi/common/_logger.d.ts +1 -1
- package/dist/types/jsapi/common/_service-checker.d.ts +1 -1
- package/dist/types/jsapi/common/_service-events.d.ts +4 -4
- package/dist/types/jsapi/config-jsapi.d.ts +43 -3
- package/dist/types/jsapi/dialer-jsapi.d.ts +4 -36
- package/dist/types/jsapi/i18n-jsapi.d.ts +1 -1
- package/dist/types/jsapi/logger-jsapi.d.ts +1 -1
- package/dist/types/jsapi/post-interaction-jsapi.d.ts +1 -1
- package/dist/types/jsapi/rtdwc-jsapi.d.ts +1 -1
- package/dist/types/jsapi/screenpop-jsapi.d.ts +2 -2
- package/dist/types/jsapi/shortcut-key-jsapi.d.ts +1 -1
- package/package.json +3 -2
@@ -1,11 +1,11 @@
|
|
1
1
|
import { AgentxService, Service } from "@wxcc-desktop/sdk-types";
|
2
2
|
import { createJsApiLogger } from "./common/_logger";
|
3
3
|
import { createServiceChecker } from "./common/_service-checker";
|
4
|
-
|
4
|
+
type IdleCodeData = {
|
5
5
|
id: string;
|
6
6
|
name: string;
|
7
7
|
};
|
8
|
-
|
8
|
+
type LatestInfoData = {
|
9
9
|
agentName?: string;
|
10
10
|
agentProfileID?: string;
|
11
11
|
agentSessionId?: string;
|
@@ -28,19 +28,19 @@ declare type LatestInfoData = {
|
|
28
28
|
isCampaignManagementEnabled?: boolean;
|
29
29
|
agentPersonalStatsEnabled?: boolean;
|
30
30
|
};
|
31
|
-
|
31
|
+
type Listeners = {
|
32
32
|
updated: (p: {
|
33
33
|
name: keyof LatestInfoData;
|
34
34
|
value?: string;
|
35
35
|
oldValue?: string;
|
36
36
|
}[]) => void;
|
37
37
|
};
|
38
|
-
|
39
|
-
|
38
|
+
type Events = keyof Listeners;
|
39
|
+
type Config = {
|
40
40
|
logger: ReturnType<typeof createJsApiLogger>;
|
41
41
|
serviceChecker: ReturnType<typeof createServiceChecker>;
|
42
42
|
};
|
43
|
-
|
43
|
+
type changeAgentStateDataType = {
|
44
44
|
state: "AVAILABLE" | "IDLE";
|
45
45
|
auxCodeId: string;
|
46
46
|
lastStateChangeReason?: string;
|
@@ -69,26 +69,9 @@ export declare class AgentStateInfoJsapi {
|
|
69
69
|
stateChange(stateData: {
|
70
70
|
state: "Available" | "Idle";
|
71
71
|
auxCodeIdArray: string;
|
72
|
-
}): Promise<
|
73
|
-
|
74
|
-
|
75
|
-
trackingId: string;
|
76
|
-
auxCodeId: string;
|
77
|
-
agentSessionId: string;
|
78
|
-
orgId: string;
|
79
|
-
status: string;
|
80
|
-
subStatus: "Idle" | "Available";
|
81
|
-
lastIdleCodeChangeTimestamp: number;
|
82
|
-
lastStateChangeTimestamp: number;
|
83
|
-
type: "AgentStateChangeSuccess";
|
84
|
-
changedBy: string | null;
|
85
|
-
changedById: string | null;
|
86
|
-
changedByName: string | null;
|
87
|
-
}> | undefined>;
|
88
|
-
mockOutdialAniList(): Promise<import("@wxcc-desktop/sdk-types/agentx-services/core/aqm-reqs").Msg<{
|
89
|
-
data: Record<string, any>;
|
90
|
-
}> | undefined>;
|
91
|
-
fetchAddressBooks(): Promise<Service.Aqm.Agent.AddressBooks | undefined>;
|
72
|
+
}): Promise<Service.Aqm.Agent.StateChangeSuccess | undefined>;
|
73
|
+
mockOutdialAniList(): Promise<any>;
|
74
|
+
fetchAddressBooks(): Promise<any>;
|
92
75
|
changeAgentState(orgId: string, data: changeAgentStateDataType): Promise<void | undefined>;
|
93
76
|
fetchAgentIdleCodes(orgId: string, agentId: string): Promise<Service.Cms.AgentIdleCodes | undefined>;
|
94
77
|
fetchOrganizationIdleCodes(orgId: string): Promise<Service.Aqm.Configs.Entity[] | undefined>;
|
@@ -2,11 +2,11 @@ import { AgentxService, Service } from "@wxcc-desktop/sdk-types";
|
|
2
2
|
import { createJsApiLogger } from "./common/_logger";
|
3
3
|
import { createServiceChecker } from "./common/_service-checker";
|
4
4
|
import { AqmServiceEntityEvents } from "./common/_service-events";
|
5
|
-
|
5
|
+
type Listeners = {
|
6
6
|
eAgentLogoutSuccess: Parameters<AgentxService["aqm"]["agent"]["eAgentLogoutSuccess"]["listen"]>[0];
|
7
7
|
};
|
8
|
-
|
9
|
-
|
8
|
+
type AqmAgentEvents = AqmServiceEntityEvents<Listeners>;
|
9
|
+
type Config = {
|
10
10
|
logger: ReturnType<typeof createJsApiLogger>;
|
11
11
|
serviceChecker: ReturnType<typeof createServiceChecker>;
|
12
12
|
aqmEvents: AqmAgentEvents;
|
@@ -22,18 +22,8 @@ export declare class LogoutJsApi {
|
|
22
22
|
cleanup(): void;
|
23
23
|
desktopLogout(p: {
|
24
24
|
data: Service.Aqm.Agent.Logout;
|
25
|
-
}): Promise<
|
26
|
-
|
27
|
-
agentId: string;
|
28
|
-
trackingId: string;
|
29
|
-
agentSessionId: string;
|
30
|
-
orgId: string;
|
31
|
-
status: string;
|
32
|
-
subStatus: string;
|
33
|
-
loggedOutBy?: string | undefined;
|
34
|
-
roles?: string[] | undefined;
|
35
|
-
type: "AgentLogoutSuccess";
|
36
|
-
}> | undefined>;
|
25
|
+
}): Promise<Service.Aqm.Agent.LogoutSuccess | undefined>;
|
26
|
+
signoutAgent(p: Service.Aqm.Supervisor.agentSignoutRequest): Promise<any>;
|
37
27
|
addEventListener<T extends keyof Listeners>(eventName: T, listener: Listeners[T]): void;
|
38
28
|
addOnceEventListener<T extends keyof Listeners>(eventName: T, listener: Listeners[T]): void;
|
39
29
|
removeEventListener<T extends keyof Listeners>(eventName: T, listener: Listeners[T]): void;
|
@@ -2,7 +2,7 @@ import { AgentxService, Service } from "@wxcc-desktop/sdk-types";
|
|
2
2
|
import { createJsApiLogger } from "./common/_logger";
|
3
3
|
import { createServiceChecker } from "./common/_service-checker";
|
4
4
|
import { AqmServiceEntityEvents } from "./common/_service-events";
|
5
|
-
|
5
|
+
type Listeners = {
|
6
6
|
eMonitoringOffered: Parameters<AgentxService["aqm"]["supervisor"]["eMonitoringOffered"]["listen"]>[0];
|
7
7
|
eMonitoringStarted: Parameters<AgentxService["aqm"]["supervisor"]["eMonitoringStarted"]["listen"]>[0];
|
8
8
|
eMonitoringRequestCreateFailed: Parameters<AgentxService["aqm"]["supervisor"]["eMonitoringRequestCreateFailed"]["listen"]>[0];
|
@@ -13,11 +13,11 @@ declare type Listeners = {
|
|
13
13
|
eMonitoringHoldFailed: Parameters<AgentxService["aqm"]["supervisor"]["eMonitoringHoldFailed"]["listen"]>[0];
|
14
14
|
eMonitoringUnHeld: Parameters<AgentxService["aqm"]["supervisor"]["eMonitoringUnHeld"]["listen"]>[0];
|
15
15
|
eMonitoringUnHoldFailed: Parameters<AgentxService["aqm"]["supervisor"]["eMonitoringUnHoldFailed"]["listen"]>[0];
|
16
|
-
|
17
|
-
|
16
|
+
eAgentMonitorStateChanged: Parameters<AgentxService["aqm"]["supervisor"]["eAgentMonitorStateChanged"]["listen"]>[0];
|
17
|
+
eAgentMonitorStateChangeFailed: Parameters<AgentxService["aqm"]["supervisor"]["eAgentMonitorStateChangeFailed"]["listen"]>[0];
|
18
18
|
};
|
19
|
-
|
20
|
-
|
19
|
+
type AqmSupervisorEvents = AqmServiceEntityEvents<Listeners>;
|
20
|
+
type Config = {
|
21
21
|
logger: ReturnType<typeof createJsApiLogger>;
|
22
22
|
serviceChecker: ReturnType<typeof createServiceChecker>;
|
23
23
|
aqmEvents: AqmSupervisorEvents;
|
@@ -1,4 +1,4 @@
|
|
1
1
|
import { Logger } from "@uuip/unified-ui-platform-sdk";
|
2
|
-
|
2
|
+
type SeverityLogger = Pick<Logger.Service, "info" | "warn" | "error">;
|
3
3
|
export declare const createJsApiLogger: (logger: SeverityLogger, subPrefix: string) => SeverityLogger;
|
4
4
|
export {};
|
@@ -1,11 +1,11 @@
|
|
1
1
|
import { AgentxService } from "@wxcc-desktop/sdk-types";
|
2
2
|
import { createJsApiLogger } from "./_logger";
|
3
|
-
|
4
|
-
|
5
|
-
|
3
|
+
type AqmServiceEntities = AgentxService["aqm"]["agent"] | AgentxService["aqm"]["configs"] | AgentxService["aqm"]["contact"] | AgentxService["aqm"]["dialer"] | AgentxService["aqm"]["supervisor"] | AgentxService["aqm"]["screenpop"];
|
4
|
+
type Events<Listeners> = keyof Listeners;
|
5
|
+
type Config = {
|
6
6
|
logger: ReturnType<typeof createJsApiLogger>;
|
7
7
|
};
|
8
|
-
|
8
|
+
type InitConfig = {
|
9
9
|
aqmServiceEntity: AqmServiceEntities;
|
10
10
|
aqmServiceEntityString: string;
|
11
11
|
};
|
@@ -1,11 +1,32 @@
|
|
1
1
|
import { AgentxService } from "@wxcc-desktop/sdk-types";
|
2
2
|
import { createJsApiLogger } from "./common/_logger";
|
3
|
-
|
3
|
+
type Listeners = {
|
4
4
|
inited: () => void;
|
5
5
|
cleaned: () => void;
|
6
6
|
};
|
7
|
-
|
7
|
+
type Events = keyof Listeners;
|
8
|
+
type ConfigType = {
|
9
|
+
/**
|
10
|
+
* Name of the widget
|
11
|
+
*/
|
12
|
+
widgetName: string;
|
13
|
+
/**
|
14
|
+
* Name of the widget provider/owner/customer
|
15
|
+
*/
|
16
|
+
widgetProvider: string;
|
17
|
+
};
|
18
|
+
type CrmConnectorProvider = {
|
19
|
+
/**
|
20
|
+
* Name of the CRM provider, e.g. "salesforce", "microsoft-dynamics", "oracle", "sap", "zendesk", "freshdesk", "freshservice", "freshsales", "hubspot", "pipedrive"
|
21
|
+
*/
|
22
|
+
crmPlatform?: string;
|
23
|
+
/**
|
24
|
+
* Name of the CRM connector provider, e.g. "cisco"
|
25
|
+
*/
|
26
|
+
crmConnectorProvider?: string;
|
27
|
+
};
|
8
28
|
export declare class ConfigJsApi {
|
29
|
+
private initEventType;
|
9
30
|
private readonly emitter;
|
10
31
|
private readonly logger;
|
11
32
|
private agentxSERVICE?;
|
@@ -16,7 +37,26 @@ export declare class ConfigJsApi {
|
|
16
37
|
});
|
17
38
|
private checkService;
|
18
39
|
private emit;
|
19
|
-
|
40
|
+
/**
|
41
|
+
* initialize wxcc-desktop js sdk
|
42
|
+
* @param config
|
43
|
+
* @example
|
44
|
+
* ``
|
45
|
+
* Desktop.config.init({widgetName: "widgetName", widgetProvider: "widgetProvider"});
|
46
|
+
* `ts
|
47
|
+
*/
|
48
|
+
init(config: ConfigType): Promise<void>;
|
49
|
+
/**
|
50
|
+
* Register CRM Connector
|
51
|
+
* @param provider
|
52
|
+
* @example
|
53
|
+
* ``
|
54
|
+
* Desktop.config.init({widgetName: "widgetName", widgetProvider: "widgetProvider"});
|
55
|
+
* config.registerCrmConnector({ crmConnectorProvider: "Cisco", crmPlatform: "SFDC"});
|
56
|
+
* `ts
|
57
|
+
*/
|
58
|
+
registerCrmConnector(provider: CrmConnectorProvider): void;
|
59
|
+
private publishEvent;
|
20
60
|
cleanup(): void;
|
21
61
|
get clientLocale(): string;
|
22
62
|
addEventListener<T extends Events>(eventName: T, listener: Listeners[T]): void;
|
@@ -2,11 +2,11 @@ import { AgentxService, Service } from "@wxcc-desktop/sdk-types";
|
|
2
2
|
import { createJsApiLogger } from "./common/_logger";
|
3
3
|
import { createServiceChecker } from "./common/_service-checker";
|
4
4
|
import { AqmServiceEntityEvents } from "./common/_service-events";
|
5
|
-
|
5
|
+
type Listeners = {
|
6
6
|
eOutdialFailed: Parameters<AgentxService["aqm"]["dialer"]["eOutdialFailed"]["listen"]>[0];
|
7
7
|
};
|
8
|
-
|
9
|
-
|
8
|
+
type AqmDialerEvents = AqmServiceEntityEvents<Listeners>;
|
9
|
+
type Config = {
|
10
10
|
logger: ReturnType<typeof createJsApiLogger>;
|
11
11
|
serviceChecker: ReturnType<typeof createServiceChecker>;
|
12
12
|
aqmEvents: AqmDialerEvents;
|
@@ -22,39 +22,7 @@ export declare class DialerJsApi {
|
|
22
22
|
cleanup(): void;
|
23
23
|
startOutdial(p: {
|
24
24
|
data: Service.Aqm.Dialer.tasks;
|
25
|
-
}): Promise<
|
26
|
-
mediaResourceId: string;
|
27
|
-
eventType: string;
|
28
|
-
agentId: string;
|
29
|
-
destAgentId: string;
|
30
|
-
trackingId: string;
|
31
|
-
consultMediaResourceId: string;
|
32
|
-
interaction: Service.Aqm.Contact.Interaction;
|
33
|
-
childInteractionId?: string | undefined;
|
34
|
-
interactionId: string;
|
35
|
-
orgId: string;
|
36
|
-
owner: string;
|
37
|
-
queueMgr: string;
|
38
|
-
queueName?: string | undefined;
|
39
|
-
type: string;
|
40
|
-
ronaTimeout?: number | undefined;
|
41
|
-
isConsulted?: boolean | undefined;
|
42
|
-
isConferencing: boolean;
|
43
|
-
updatedBy?: string | undefined;
|
44
|
-
destinationType?: string | undefined;
|
45
|
-
autoResumed?: boolean | undefined;
|
46
|
-
reasonCode?: string | number | undefined;
|
47
|
-
reason?: string | undefined;
|
48
|
-
consultingAgentId?: string | undefined;
|
49
|
-
taskId?: string | undefined;
|
50
|
-
task?: Service.Aqm.Contact.Interaction | undefined;
|
51
|
-
supervisorId?: string | undefined;
|
52
|
-
monitorType?: string | undefined;
|
53
|
-
supervisorDN?: string | undefined;
|
54
|
-
id?: string | undefined;
|
55
|
-
isWebCallMute?: boolean | undefined;
|
56
|
-
reservationInteractionId?: string | undefined;
|
57
|
-
}> | undefined>;
|
25
|
+
}): Promise<Service.Aqm.Contact.AgentContact | undefined>;
|
58
26
|
updateCadVariables(p: {
|
59
27
|
interactionId: string;
|
60
28
|
data: Service.Aqm.Dialer.updateCadPayLoad;
|
@@ -2,7 +2,7 @@ import { I18N } from "@uuip/unified-ui-platform-sdk";
|
|
2
2
|
import { AgentxService } from "@wxcc-desktop/sdk-types";
|
3
3
|
import { createJsApiLogger } from "./common/_logger";
|
4
4
|
import { createServiceChecker } from "./common/_service-checker";
|
5
|
-
|
5
|
+
type Config = {
|
6
6
|
logger: ReturnType<typeof createJsApiLogger>;
|
7
7
|
serviceChecker: ReturnType<typeof createServiceChecker>;
|
8
8
|
};
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { AgentxService } from "@wxcc-desktop/sdk-types";
|
2
2
|
import { createJsApiLogger } from "./common/_logger";
|
3
3
|
import { createServiceChecker } from "./common/_service-checker";
|
4
|
-
|
4
|
+
type Config = {
|
5
5
|
logger: ReturnType<typeof createJsApiLogger>;
|
6
6
|
serviceChecker: ReturnType<typeof createServiceChecker>;
|
7
7
|
};
|
@@ -2,10 +2,10 @@ import { AgentxService } from "@wxcc-desktop/sdk-types";
|
|
2
2
|
import { createJsApiLogger } from "./common/_logger";
|
3
3
|
import { createServiceChecker } from "./common/_service-checker";
|
4
4
|
import { AqmServiceEntityEvents } from "./common/_service-events";
|
5
|
-
|
5
|
+
type Listeners = {
|
6
6
|
eScreenPop: Parameters<AgentxService["aqm"]["screenpop"]["eScreenPop"]["listen"]>[0];
|
7
7
|
};
|
8
|
-
|
8
|
+
type Config = {
|
9
9
|
logger: ReturnType<typeof createJsApiLogger>;
|
10
10
|
aqmEvents: AqmServiceEntityEvents<Listeners>;
|
11
11
|
serviceChecker: ReturnType<typeof createServiceChecker>;
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { AgentxService } from "@wxcc-desktop/sdk-types";
|
2
2
|
import { createJsApiLogger } from "./common/_logger";
|
3
3
|
import { createServiceChecker } from "./common/_service-checker";
|
4
|
-
|
4
|
+
type Config = {
|
5
5
|
logger: ReturnType<typeof createJsApiLogger>;
|
6
6
|
serviceChecker: ReturnType<typeof createServiceChecker>;
|
7
7
|
};
|
package/package.json
CHANGED
@@ -1,14 +1,15 @@
|
|
1
1
|
{
|
2
2
|
"name": "@wxcc-desktop/sdk",
|
3
|
-
"version": "
|
3
|
+
"version": "2.0.1",
|
4
4
|
"author": "Roman Manchenko",
|
5
5
|
"license": "ISC",
|
6
6
|
"repository": "git@sqbu-github.cisco.com:CBABU/agentx-js-api.git",
|
7
7
|
"main": "./dist/index.js",
|
8
8
|
"types": "./dist/types/index.d.ts",
|
9
9
|
"dependencies": {
|
10
|
+
"@babel/runtime": "^7.25.6",
|
10
11
|
"@uuip/unified-ui-platform-sdk": "^1.3.6",
|
11
|
-
"@wxcc-desktop/sdk-types": "^1.0.
|
12
|
+
"@wxcc-desktop/sdk-types": "^1.0.15",
|
12
13
|
"event-emitter": "^0.3.5",
|
13
14
|
"js-cookie": "^3.0.1"
|
14
15
|
},
|