@ztlink-imk/ztlinkcloud-agent-sdk 1.0.0 → 1.0.2
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 +11 -7
- package/dist/index.cjs +27 -5
- package/dist/index.d.cts +39 -30
- package/dist/index.d.ts +39 -30
- package/dist/index.js +27 -5
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -4,7 +4,9 @@
|
|
|
4
4
|
npm i @ztlink-imk/ztlinkcloud-agent-sdk
|
|
5
5
|
```
|
|
6
6
|
|
|
7
|
-
SDK 实现不在本包内:客户服务端签发 Ticket 时,响应 `data.sdk` 同时给出运行时地址(带 CDN
|
|
7
|
+
SDK 实现不在本包内:客户服务端签发 Ticket 时,响应 `data.sdk` 同时给出运行时地址(带 CDN 签名)、版本、integrity 与浏览器 SDK 的服务地址。浏览器加载该脚本后得到 `window.ImkAgentSdk`。本包负责注入脚本并提供公共类型,没有运行时依赖。
|
|
8
|
+
|
|
9
|
+
前端不配置任何 IMK 服务地址:服务基址随 `sdk` 下发,业务通知地址随坐席登录结果下发。该写法自本包 1.0.2 起(运行时 1.0.4)(需服务端 HTTP v0.16.0 下发地址)。客户服务端原样转发 `sdk`,不解析其内容。
|
|
8
10
|
|
|
9
11
|
客户通过本包锁定**大版本**;大版本内的小版本由服务端决定,发版或回退后客户刷新页面即生效。
|
|
10
12
|
|
|
@@ -23,8 +25,8 @@ import { loadAgentSdk, AgentSdkLoadError } from '@ztlink-imk/ztlinkcloud-agent-s
|
|
|
23
25
|
const { ticket, sdk } = await fetchTicketFromHostBackend();
|
|
24
26
|
|
|
25
27
|
try {
|
|
26
|
-
const runtime = await loadAgentSdk(sdk); //
|
|
27
|
-
const core = runtime.createCallCenter(
|
|
28
|
+
const runtime = await loadAgentSdk(sdk); // 原样传入 Ticket 响应中的 data.sdk
|
|
29
|
+
const core = runtime.createCallCenter(); // 不传地址,服务地址由 sdk 与登录结果下发
|
|
28
30
|
const panel = runtime.mountPanel('#imk-panel', { core }); // 不需要界面时可不调用
|
|
29
31
|
await core.initialize(ticket);
|
|
30
32
|
} catch (error) {
|
|
@@ -36,17 +38,18 @@ try {
|
|
|
36
38
|
```
|
|
37
39
|
|
|
38
40
|
- 产物为 ESM + CJS,附带自包含的 `.d.ts`;JavaScript 项目不需要类型也可直接使用。
|
|
39
|
-
-
|
|
41
|
+
- 同一页面重复调用只加载一次运行时,返回值绑定本次 `sdk`。页面已加载的版本与本次 `sdk.version` 不同时不替换已运行的代码,控制台提示刷新页面后生效;需要自行提示时比较 `runtime.version !== sdk.version`。
|
|
42
|
+
- `createCallCenter` 的 `apiBaseUrl`、`wsUrl` 选项已弃用:显式传入时仍优先使用,新接入不要传。
|
|
40
43
|
|
|
41
44
|
| 错误码 | 含义 | 处理 |
|
|
42
45
|
|---|---|---|
|
|
43
|
-
| `INVALID_ARGUMENT` | `sdk` 缺少非空的 `version`/`url`/`integrity` | 检查宿主后端是否原样转发 `data.sdk` |
|
|
46
|
+
| `INVALID_ARGUMENT` | `sdk` 缺少非空的 `version`/`url`/`integrity`,或 `apiBaseUrl` 不是合法 http(s) 基址 | 检查宿主后端是否原样转发 `data.sdk` |
|
|
44
47
|
| `MAJOR_VERSION_MISMATCH` | 下发版本或页面已加载的运行时大版本与加载器不一致 | 升级加载器包 |
|
|
45
48
|
| `LOAD_FAILED` | 网络、签名过期、CORS、integrity 校验失败等,浏览器不区分原因 | 重新签发 Ticket 获取新地址后重试 |
|
|
46
49
|
|
|
47
50
|
## 方式二:原生脚本(JSP、jQuery、纯 HTML 等无构建工具的页面)
|
|
48
51
|
|
|
49
|
-
|
|
52
|
+
简化写法,只演示注入脚本与大版本校验;不含加载器的参数校验、同页单飞、失败后移除脚本以便重试等处理,有构建工具时优先使用方式一:
|
|
50
53
|
|
|
51
54
|
```html
|
|
52
55
|
<div id="imk-panel"></div>
|
|
@@ -76,7 +79,8 @@ try {
|
|
|
76
79
|
fetchTicketFromHostBackend()
|
|
77
80
|
.then(function (data) {
|
|
78
81
|
return loadAgentSdk(data.sdk).then(function (runtime) {
|
|
79
|
-
|
|
82
|
+
// 原生脚本没有加载器包装,传入下发的 sdk,服务地址从中读取
|
|
83
|
+
var core = runtime.createCallCenter({ sdk: data.sdk });
|
|
80
84
|
runtime.mountPanel('#imk-panel', { core: core });
|
|
81
85
|
return core.initialize(data.ticket);
|
|
82
86
|
});
|
package/dist/index.cjs
CHANGED
|
@@ -45,10 +45,29 @@ function majorOf(version) {
|
|
|
45
45
|
const match = /^(\d+)\.\d+\.\d+/.exec(version);
|
|
46
46
|
return match ? Number(match[1]) : null;
|
|
47
47
|
}
|
|
48
|
+
var INTEGRITY_PATTERN = /^sha384-[A-Za-z0-9+/]{64}$/;
|
|
49
|
+
function isApiBaseUrl(value) {
|
|
50
|
+
if (typeof value !== "string") return false;
|
|
51
|
+
try {
|
|
52
|
+
const url = new URL(value);
|
|
53
|
+
return (url.protocol === "https:" || url.protocol === "http:") && !url.username && !url.password && !url.search && !url.hash;
|
|
54
|
+
} catch {
|
|
55
|
+
return false;
|
|
56
|
+
}
|
|
57
|
+
}
|
|
48
58
|
function isDelivery(sdk) {
|
|
49
59
|
if (typeof sdk !== "object" || sdk === null) return false;
|
|
50
|
-
const { version, url, integrity } = sdk;
|
|
51
|
-
return [version, url
|
|
60
|
+
const { version, url, integrity, apiBaseUrl } = sdk;
|
|
61
|
+
return [version, url].every((field) => typeof field === "string" && field !== "") && typeof integrity === "string" && INTEGRITY_PATTERN.test(integrity) && (apiBaseUrl === void 0 || isApiBaseUrl(apiBaseUrl));
|
|
62
|
+
}
|
|
63
|
+
function bind(runtime, sdk) {
|
|
64
|
+
return Object.freeze({
|
|
65
|
+
version: runtime.version,
|
|
66
|
+
createCallCenter: (options = {}) => runtime.createCallCenter(
|
|
67
|
+
options.apiBaseUrl === void 0 && sdk.apiBaseUrl !== void 0 ? { ...options, apiBaseUrl: sdk.apiBaseUrl } : options
|
|
68
|
+
),
|
|
69
|
+
mountPanel: (...args) => runtime.mountPanel(...args)
|
|
70
|
+
});
|
|
52
71
|
}
|
|
53
72
|
function adopt(runtime, sdk) {
|
|
54
73
|
if (majorOf(runtime.version) !== SUPPORTED_MAJOR)
|
|
@@ -84,14 +103,17 @@ function inject(sdk) {
|
|
|
84
103
|
}
|
|
85
104
|
async function loadAgentSdk(sdk) {
|
|
86
105
|
if (!isDelivery(sdk))
|
|
87
|
-
throw new AgentSdkLoadError(
|
|
106
|
+
throw new AgentSdkLoadError(
|
|
107
|
+
"INVALID_ARGUMENT",
|
|
108
|
+
"sdk \u9700\u5305\u542B\u975E\u7A7A\u7684 version\u3001url\u3001sha384 \u683C\u5F0F\u7684 integrity\uFF0CapiBaseUrl \u5B58\u5728\u65F6\u987B\u4E3A\u5408\u6CD5 http(s) \u57FA\u5740"
|
|
109
|
+
);
|
|
88
110
|
if (majorOf(sdk.version) !== SUPPORTED_MAJOR)
|
|
89
111
|
throw new AgentSdkLoadError("MAJOR_VERSION_MISMATCH", "\u670D\u52A1\u7AEF\u4E0B\u53D1\u7684\u8FD0\u884C\u65F6\u5927\u7248\u672C\u4E0E\u52A0\u8F7D\u5668\u4E0D\u4E00\u81F4");
|
|
90
112
|
const loaded = window.ImkAgentSdk;
|
|
91
|
-
if (loaded) return adopt(loaded, sdk);
|
|
113
|
+
if (loaded) return bind(adopt(loaded, sdk), sdk);
|
|
92
114
|
pending ??= inject(sdk).catch((error) => {
|
|
93
115
|
pending = null;
|
|
94
116
|
throw error;
|
|
95
117
|
});
|
|
96
|
-
return adopt(await pending, sdk);
|
|
118
|
+
return bind(adopt(await pending, sdk), sdk);
|
|
97
119
|
}
|
package/dist/index.d.cts
CHANGED
|
@@ -47,9 +47,31 @@ interface DiagnosticEntry {
|
|
|
47
47
|
readonly code: string;
|
|
48
48
|
readonly at: number;
|
|
49
49
|
}
|
|
50
|
+
/** 服务端随 Ticket 下发的 SDK 信息(Ticket 响应 data.sdk),宿主原样传入,不理解其内容。 */
|
|
51
|
+
interface SdkDelivery {
|
|
52
|
+
/** 运行时完整版本号,如 1.2.3。 */
|
|
53
|
+
readonly version: string;
|
|
54
|
+
/** 带 CDN 签名的运行时地址;不含 Ticket,签名有效期有限,需用本次签发的值。 */
|
|
55
|
+
readonly url: string;
|
|
56
|
+
/** 运行时文件的 SRI 值(sha384-...),浏览器据此校验下载内容。 */
|
|
57
|
+
readonly integrity: string;
|
|
58
|
+
/** 浏览器 SDK 服务基址(HTTP v0.16.0 起下发);可选以兼容未升级的服务端。 */
|
|
59
|
+
readonly apiBaseUrl?: string;
|
|
60
|
+
}
|
|
50
61
|
interface CallCenterOptions {
|
|
51
|
-
|
|
52
|
-
|
|
62
|
+
/**
|
|
63
|
+
* 服务端随 Ticket 下发的 SDK 信息;未显式传 apiBaseUrl 时取其中的 apiBaseUrl。
|
|
64
|
+
* 经加载器创建时由加载器填入服务基址,宿主无需传入。
|
|
65
|
+
*/
|
|
66
|
+
readonly sdk?: SdkDelivery;
|
|
67
|
+
/**
|
|
68
|
+
* @deprecated 服务基址改由服务端随 Ticket 下发(sdk.apiBaseUrl),宿主不再配置;显式传入时优先使用。
|
|
69
|
+
*/
|
|
70
|
+
readonly apiBaseUrl?: string;
|
|
71
|
+
/**
|
|
72
|
+
* @deprecated 通知地址改由服务端随登录结果下发,宿主不再配置;显式传入(ws/wss)时优先使用,
|
|
73
|
+
* 未传时按每次登录结果建立,登录结果不含通知地址则不建立通知连接。
|
|
74
|
+
*/
|
|
53
75
|
readonly wsUrl?: string;
|
|
54
76
|
readonly device?: DeviceInfo;
|
|
55
77
|
readonly requestTimeoutMs?: number;
|
|
@@ -120,15 +142,15 @@ interface CallSnapshot {
|
|
|
120
142
|
readonly callId: string;
|
|
121
143
|
readonly direction: 'outbound' | 'inbound';
|
|
122
144
|
readonly status: CallStatus;
|
|
123
|
-
/** 外呼为目标号码,回呼为 INVITE
|
|
145
|
+
/** 外呼为目标号码,回呼为 INVITE From 的号码(anumber)。 */
|
|
124
146
|
readonly remoteNumber: string;
|
|
125
|
-
/**
|
|
147
|
+
/** 回呼原始号码;From、To 及出现时的 bnumber 头校验完成后才随来电快照发布,不受 setDisplay 修改影响。 */
|
|
126
148
|
readonly callbackNumbers?: {
|
|
127
|
-
/**
|
|
149
|
+
/** 来电主号码,取自 INVITE From。 */
|
|
128
150
|
readonly anumber: string;
|
|
129
|
-
/**
|
|
130
|
-
readonly bnumber
|
|
131
|
-
/**
|
|
151
|
+
/** 被叫号码,取自 INVITE 的可选 bnumber 头;FS 未下发时缺失。 */
|
|
152
|
+
readonly bnumber?: string;
|
|
153
|
+
/** 外显号码,取自 INVITE To。 */
|
|
132
154
|
readonly xnumber: string;
|
|
133
155
|
};
|
|
134
156
|
readonly display?: CallDisplay;
|
|
@@ -428,7 +450,7 @@ interface AgentsApi {
|
|
|
428
450
|
disable(agentId: string): Promise<AgentResource>;
|
|
429
451
|
}
|
|
430
452
|
/** 本 SDK 消费的后端 HTTP 契约版本(openapi-v1.yaml info.version) */
|
|
431
|
-
declare const CONTRACT_VERSION: "0.
|
|
453
|
+
declare const CONTRACT_VERSION: "0.16.0";
|
|
432
454
|
|
|
433
455
|
/** 宿主稳定门面;仅描述已验收能力,不从内部实现推导额外类型。 */
|
|
434
456
|
interface CallCenter {
|
|
@@ -473,15 +495,6 @@ interface CallCenter {
|
|
|
473
495
|
* 加载器按此返回;同一大版本内只允许向后兼容的新增,不删除、不改名、不改语义。
|
|
474
496
|
*/
|
|
475
497
|
|
|
476
|
-
/** 服务端随 Ticket 下发的 SDK 信息(Ticket 响应 data.sdk),宿主原样交给加载器。 */
|
|
477
|
-
interface SdkDelivery {
|
|
478
|
-
/** 运行时完整版本号,如 1.2.3。 */
|
|
479
|
-
readonly version: string;
|
|
480
|
-
/** 带 CDN 签名的运行时地址;不含 Ticket,签名有效期有限,需用本次签发的值。 */
|
|
481
|
-
readonly url: string;
|
|
482
|
-
/** 运行时文件的 SRI 值(sha384-...),浏览器据此校验下载内容。 */
|
|
483
|
-
readonly integrity: string;
|
|
484
|
-
}
|
|
485
498
|
/** mountPanel 选项。 */
|
|
486
499
|
interface PanelOptions {
|
|
487
500
|
/** 宿主创建的唯一 Core 实例;面板只订阅和调用,不销毁。 */
|
|
@@ -523,10 +536,12 @@ interface ImkAgentSdkRuntime {
|
|
|
523
536
|
readonly version: string;
|
|
524
537
|
/**
|
|
525
538
|
* 创建 Core 实例;创建本身不发请求。
|
|
526
|
-
*
|
|
539
|
+
* 经 loadAgentSdk 取得的运行时已绑定本次 sdk,宿主不传服务地址:`createCallCenter()`。
|
|
540
|
+
* @param options 实例选项,可省略;apiBaseUrl、wsUrl 已弃用,显式传入时优先
|
|
527
541
|
* @returns 宿主唯一的 CallCenter 实例,由宿主负责 destroy
|
|
542
|
+
* @throws CallCenterError INVALID_ARGUMENT:选项不合法,或既无 apiBaseUrl 也无 sdk.apiBaseUrl
|
|
528
543
|
*/
|
|
529
|
-
createCallCenter(options
|
|
544
|
+
createCallCenter(options?: CallCenterOptions): CallCenter;
|
|
530
545
|
/**
|
|
531
546
|
* 在目标元素内以 Shadow DOM 挂载通话面板;不需要界面的宿主可不调用。
|
|
532
547
|
* @param target CSS 选择器或元素
|
|
@@ -543,16 +558,9 @@ declare global {
|
|
|
543
558
|
}
|
|
544
559
|
}
|
|
545
560
|
|
|
546
|
-
/**
|
|
547
|
-
* 按服务端下发的 SdkDelivery 注入运行时脚本,等待加载完成后返回 window.ImkAgentSdk。
|
|
548
|
-
*
|
|
549
|
-
* 客户通过本包锁定大版本;大版本内的小版本由服务端版本指针决定。
|
|
550
|
-
* 同一页面只加载一次运行时,已运行的代码不会被替换,新版本在刷新页面后生效。
|
|
551
|
-
*/
|
|
552
|
-
|
|
553
561
|
/** 加载失败的稳定错误码。 */
|
|
554
562
|
type AgentSdkLoadErrorCode =
|
|
555
|
-
/** sdk
|
|
563
|
+
/** sdk 参数缺失、字段不是非空字符串,或 apiBaseUrl 不是合法 http(s) 基址。 */
|
|
556
564
|
'INVALID_ARGUMENT'
|
|
557
565
|
/** 下发版本或页面已加载的运行时与本加载器大版本不一致,需升级加载器包。 */
|
|
558
566
|
| 'MAJOR_VERSION_MISMATCH'
|
|
@@ -571,10 +579,11 @@ declare class AgentSdkLoadError extends Error {
|
|
|
571
579
|
/**
|
|
572
580
|
* 加载服务端下发的 SDK 运行时。
|
|
573
581
|
*
|
|
574
|
-
*
|
|
582
|
+
* 同一页面重复调用只加载一次运行时;页面已通过原生脚本加载时直接采用。
|
|
575
583
|
* 已加载版本与本次 sdk.version 不同时不替换,console 提示刷新页面后生效。
|
|
584
|
+
* 返回值绑定本次 sdk(见 {@link bind}),createCallCenter() 无需传服务地址。
|
|
576
585
|
* @param sdk Ticket 响应中的 data.sdk,原样传入
|
|
577
|
-
* @returns window.ImkAgentSdk
|
|
586
|
+
* @returns 绑定本次 sdk 的 window.ImkAgentSdk 包装
|
|
578
587
|
* @throws AgentSdkLoadError INVALID_ARGUMENT / MAJOR_VERSION_MISMATCH / LOAD_FAILED
|
|
579
588
|
*/
|
|
580
589
|
declare function loadAgentSdk(sdk: SdkDelivery): Promise<ImkAgentSdkRuntime>;
|
package/dist/index.d.ts
CHANGED
|
@@ -47,9 +47,31 @@ interface DiagnosticEntry {
|
|
|
47
47
|
readonly code: string;
|
|
48
48
|
readonly at: number;
|
|
49
49
|
}
|
|
50
|
+
/** 服务端随 Ticket 下发的 SDK 信息(Ticket 响应 data.sdk),宿主原样传入,不理解其内容。 */
|
|
51
|
+
interface SdkDelivery {
|
|
52
|
+
/** 运行时完整版本号,如 1.2.3。 */
|
|
53
|
+
readonly version: string;
|
|
54
|
+
/** 带 CDN 签名的运行时地址;不含 Ticket,签名有效期有限,需用本次签发的值。 */
|
|
55
|
+
readonly url: string;
|
|
56
|
+
/** 运行时文件的 SRI 值(sha384-...),浏览器据此校验下载内容。 */
|
|
57
|
+
readonly integrity: string;
|
|
58
|
+
/** 浏览器 SDK 服务基址(HTTP v0.16.0 起下发);可选以兼容未升级的服务端。 */
|
|
59
|
+
readonly apiBaseUrl?: string;
|
|
60
|
+
}
|
|
50
61
|
interface CallCenterOptions {
|
|
51
|
-
|
|
52
|
-
|
|
62
|
+
/**
|
|
63
|
+
* 服务端随 Ticket 下发的 SDK 信息;未显式传 apiBaseUrl 时取其中的 apiBaseUrl。
|
|
64
|
+
* 经加载器创建时由加载器填入服务基址,宿主无需传入。
|
|
65
|
+
*/
|
|
66
|
+
readonly sdk?: SdkDelivery;
|
|
67
|
+
/**
|
|
68
|
+
* @deprecated 服务基址改由服务端随 Ticket 下发(sdk.apiBaseUrl),宿主不再配置;显式传入时优先使用。
|
|
69
|
+
*/
|
|
70
|
+
readonly apiBaseUrl?: string;
|
|
71
|
+
/**
|
|
72
|
+
* @deprecated 通知地址改由服务端随登录结果下发,宿主不再配置;显式传入(ws/wss)时优先使用,
|
|
73
|
+
* 未传时按每次登录结果建立,登录结果不含通知地址则不建立通知连接。
|
|
74
|
+
*/
|
|
53
75
|
readonly wsUrl?: string;
|
|
54
76
|
readonly device?: DeviceInfo;
|
|
55
77
|
readonly requestTimeoutMs?: number;
|
|
@@ -120,15 +142,15 @@ interface CallSnapshot {
|
|
|
120
142
|
readonly callId: string;
|
|
121
143
|
readonly direction: 'outbound' | 'inbound';
|
|
122
144
|
readonly status: CallStatus;
|
|
123
|
-
/** 外呼为目标号码,回呼为 INVITE
|
|
145
|
+
/** 外呼为目标号码,回呼为 INVITE From 的号码(anumber)。 */
|
|
124
146
|
readonly remoteNumber: string;
|
|
125
|
-
/**
|
|
147
|
+
/** 回呼原始号码;From、To 及出现时的 bnumber 头校验完成后才随来电快照发布,不受 setDisplay 修改影响。 */
|
|
126
148
|
readonly callbackNumbers?: {
|
|
127
|
-
/**
|
|
149
|
+
/** 来电主号码,取自 INVITE From。 */
|
|
128
150
|
readonly anumber: string;
|
|
129
|
-
/**
|
|
130
|
-
readonly bnumber
|
|
131
|
-
/**
|
|
151
|
+
/** 被叫号码,取自 INVITE 的可选 bnumber 头;FS 未下发时缺失。 */
|
|
152
|
+
readonly bnumber?: string;
|
|
153
|
+
/** 外显号码,取自 INVITE To。 */
|
|
132
154
|
readonly xnumber: string;
|
|
133
155
|
};
|
|
134
156
|
readonly display?: CallDisplay;
|
|
@@ -428,7 +450,7 @@ interface AgentsApi {
|
|
|
428
450
|
disable(agentId: string): Promise<AgentResource>;
|
|
429
451
|
}
|
|
430
452
|
/** 本 SDK 消费的后端 HTTP 契约版本(openapi-v1.yaml info.version) */
|
|
431
|
-
declare const CONTRACT_VERSION: "0.
|
|
453
|
+
declare const CONTRACT_VERSION: "0.16.0";
|
|
432
454
|
|
|
433
455
|
/** 宿主稳定门面;仅描述已验收能力,不从内部实现推导额外类型。 */
|
|
434
456
|
interface CallCenter {
|
|
@@ -473,15 +495,6 @@ interface CallCenter {
|
|
|
473
495
|
* 加载器按此返回;同一大版本内只允许向后兼容的新增,不删除、不改名、不改语义。
|
|
474
496
|
*/
|
|
475
497
|
|
|
476
|
-
/** 服务端随 Ticket 下发的 SDK 信息(Ticket 响应 data.sdk),宿主原样交给加载器。 */
|
|
477
|
-
interface SdkDelivery {
|
|
478
|
-
/** 运行时完整版本号,如 1.2.3。 */
|
|
479
|
-
readonly version: string;
|
|
480
|
-
/** 带 CDN 签名的运行时地址;不含 Ticket,签名有效期有限,需用本次签发的值。 */
|
|
481
|
-
readonly url: string;
|
|
482
|
-
/** 运行时文件的 SRI 值(sha384-...),浏览器据此校验下载内容。 */
|
|
483
|
-
readonly integrity: string;
|
|
484
|
-
}
|
|
485
498
|
/** mountPanel 选项。 */
|
|
486
499
|
interface PanelOptions {
|
|
487
500
|
/** 宿主创建的唯一 Core 实例;面板只订阅和调用,不销毁。 */
|
|
@@ -523,10 +536,12 @@ interface ImkAgentSdkRuntime {
|
|
|
523
536
|
readonly version: string;
|
|
524
537
|
/**
|
|
525
538
|
* 创建 Core 实例;创建本身不发请求。
|
|
526
|
-
*
|
|
539
|
+
* 经 loadAgentSdk 取得的运行时已绑定本次 sdk,宿主不传服务地址:`createCallCenter()`。
|
|
540
|
+
* @param options 实例选项,可省略;apiBaseUrl、wsUrl 已弃用,显式传入时优先
|
|
527
541
|
* @returns 宿主唯一的 CallCenter 实例,由宿主负责 destroy
|
|
542
|
+
* @throws CallCenterError INVALID_ARGUMENT:选项不合法,或既无 apiBaseUrl 也无 sdk.apiBaseUrl
|
|
528
543
|
*/
|
|
529
|
-
createCallCenter(options
|
|
544
|
+
createCallCenter(options?: CallCenterOptions): CallCenter;
|
|
530
545
|
/**
|
|
531
546
|
* 在目标元素内以 Shadow DOM 挂载通话面板;不需要界面的宿主可不调用。
|
|
532
547
|
* @param target CSS 选择器或元素
|
|
@@ -543,16 +558,9 @@ declare global {
|
|
|
543
558
|
}
|
|
544
559
|
}
|
|
545
560
|
|
|
546
|
-
/**
|
|
547
|
-
* 按服务端下发的 SdkDelivery 注入运行时脚本,等待加载完成后返回 window.ImkAgentSdk。
|
|
548
|
-
*
|
|
549
|
-
* 客户通过本包锁定大版本;大版本内的小版本由服务端版本指针决定。
|
|
550
|
-
* 同一页面只加载一次运行时,已运行的代码不会被替换,新版本在刷新页面后生效。
|
|
551
|
-
*/
|
|
552
|
-
|
|
553
561
|
/** 加载失败的稳定错误码。 */
|
|
554
562
|
type AgentSdkLoadErrorCode =
|
|
555
|
-
/** sdk
|
|
563
|
+
/** sdk 参数缺失、字段不是非空字符串,或 apiBaseUrl 不是合法 http(s) 基址。 */
|
|
556
564
|
'INVALID_ARGUMENT'
|
|
557
565
|
/** 下发版本或页面已加载的运行时与本加载器大版本不一致,需升级加载器包。 */
|
|
558
566
|
| 'MAJOR_VERSION_MISMATCH'
|
|
@@ -571,10 +579,11 @@ declare class AgentSdkLoadError extends Error {
|
|
|
571
579
|
/**
|
|
572
580
|
* 加载服务端下发的 SDK 运行时。
|
|
573
581
|
*
|
|
574
|
-
*
|
|
582
|
+
* 同一页面重复调用只加载一次运行时;页面已通过原生脚本加载时直接采用。
|
|
575
583
|
* 已加载版本与本次 sdk.version 不同时不替换,console 提示刷新页面后生效。
|
|
584
|
+
* 返回值绑定本次 sdk(见 {@link bind}),createCallCenter() 无需传服务地址。
|
|
576
585
|
* @param sdk Ticket 响应中的 data.sdk,原样传入
|
|
577
|
-
* @returns window.ImkAgentSdk
|
|
586
|
+
* @returns 绑定本次 sdk 的 window.ImkAgentSdk 包装
|
|
578
587
|
* @throws AgentSdkLoadError INVALID_ARGUMENT / MAJOR_VERSION_MISMATCH / LOAD_FAILED
|
|
579
588
|
*/
|
|
580
589
|
declare function loadAgentSdk(sdk: SdkDelivery): Promise<ImkAgentSdkRuntime>;
|
package/dist/index.js
CHANGED
|
@@ -18,10 +18,29 @@ function majorOf(version) {
|
|
|
18
18
|
const match = /^(\d+)\.\d+\.\d+/.exec(version);
|
|
19
19
|
return match ? Number(match[1]) : null;
|
|
20
20
|
}
|
|
21
|
+
var INTEGRITY_PATTERN = /^sha384-[A-Za-z0-9+/]{64}$/;
|
|
22
|
+
function isApiBaseUrl(value) {
|
|
23
|
+
if (typeof value !== "string") return false;
|
|
24
|
+
try {
|
|
25
|
+
const url = new URL(value);
|
|
26
|
+
return (url.protocol === "https:" || url.protocol === "http:") && !url.username && !url.password && !url.search && !url.hash;
|
|
27
|
+
} catch {
|
|
28
|
+
return false;
|
|
29
|
+
}
|
|
30
|
+
}
|
|
21
31
|
function isDelivery(sdk) {
|
|
22
32
|
if (typeof sdk !== "object" || sdk === null) return false;
|
|
23
|
-
const { version, url, integrity } = sdk;
|
|
24
|
-
return [version, url
|
|
33
|
+
const { version, url, integrity, apiBaseUrl } = sdk;
|
|
34
|
+
return [version, url].every((field) => typeof field === "string" && field !== "") && typeof integrity === "string" && INTEGRITY_PATTERN.test(integrity) && (apiBaseUrl === void 0 || isApiBaseUrl(apiBaseUrl));
|
|
35
|
+
}
|
|
36
|
+
function bind(runtime, sdk) {
|
|
37
|
+
return Object.freeze({
|
|
38
|
+
version: runtime.version,
|
|
39
|
+
createCallCenter: (options = {}) => runtime.createCallCenter(
|
|
40
|
+
options.apiBaseUrl === void 0 && sdk.apiBaseUrl !== void 0 ? { ...options, apiBaseUrl: sdk.apiBaseUrl } : options
|
|
41
|
+
),
|
|
42
|
+
mountPanel: (...args) => runtime.mountPanel(...args)
|
|
43
|
+
});
|
|
25
44
|
}
|
|
26
45
|
function adopt(runtime, sdk) {
|
|
27
46
|
if (majorOf(runtime.version) !== SUPPORTED_MAJOR)
|
|
@@ -57,16 +76,19 @@ function inject(sdk) {
|
|
|
57
76
|
}
|
|
58
77
|
async function loadAgentSdk(sdk) {
|
|
59
78
|
if (!isDelivery(sdk))
|
|
60
|
-
throw new AgentSdkLoadError(
|
|
79
|
+
throw new AgentSdkLoadError(
|
|
80
|
+
"INVALID_ARGUMENT",
|
|
81
|
+
"sdk \u9700\u5305\u542B\u975E\u7A7A\u7684 version\u3001url\u3001sha384 \u683C\u5F0F\u7684 integrity\uFF0CapiBaseUrl \u5B58\u5728\u65F6\u987B\u4E3A\u5408\u6CD5 http(s) \u57FA\u5740"
|
|
82
|
+
);
|
|
61
83
|
if (majorOf(sdk.version) !== SUPPORTED_MAJOR)
|
|
62
84
|
throw new AgentSdkLoadError("MAJOR_VERSION_MISMATCH", "\u670D\u52A1\u7AEF\u4E0B\u53D1\u7684\u8FD0\u884C\u65F6\u5927\u7248\u672C\u4E0E\u52A0\u8F7D\u5668\u4E0D\u4E00\u81F4");
|
|
63
85
|
const loaded = window.ImkAgentSdk;
|
|
64
|
-
if (loaded) return adopt(loaded, sdk);
|
|
86
|
+
if (loaded) return bind(adopt(loaded, sdk), sdk);
|
|
65
87
|
pending ??= inject(sdk).catch((error) => {
|
|
66
88
|
pending = null;
|
|
67
89
|
throw error;
|
|
68
90
|
});
|
|
69
|
-
return adopt(await pending, sdk);
|
|
91
|
+
return bind(adopt(await pending, sdk), sdk);
|
|
70
92
|
}
|
|
71
93
|
export {
|
|
72
94
|
AgentSdkLoadError,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ztlink-imk/ztlinkcloud-agent-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
5
|
"description": "IMK 呼叫中心坐席 SDK 加载器与公共类型:按服务端下发的地址加载 SDK 运行时",
|
|
6
6
|
"type": "module",
|
|
@@ -20,13 +20,14 @@
|
|
|
20
20
|
"./package.json": "./package.json"
|
|
21
21
|
},
|
|
22
22
|
"devDependencies": {
|
|
23
|
-
"@imk/agent-core": "1.0.
|
|
23
|
+
"@imk/agent-core": "1.0.4"
|
|
24
24
|
},
|
|
25
25
|
"publishConfig": {
|
|
26
26
|
"access": "public"
|
|
27
27
|
},
|
|
28
28
|
"scripts": {
|
|
29
29
|
"build": "tsup",
|
|
30
|
-
"typecheck": "tsc -p tsconfig.json"
|
|
30
|
+
"typecheck": "tsc -p tsconfig.json",
|
|
31
|
+
"test": "vitest run"
|
|
31
32
|
}
|
|
32
33
|
}
|