@schema-element-editor/host-sdk 2.0.2 → 2.1.0
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/LICENSE +21 -0
- package/dist/chunk-3OZ7E3LK.js +391 -0
- package/dist/chunk-432BCQVI.js +0 -0
- package/dist/chunk-5URPGJPF.js +391 -0
- package/dist/chunk-APBK7FQZ.js +437 -0
- package/dist/chunk-BVGJ5UDR.js +390 -0
- package/dist/chunk-D67MT673.js +44 -0
- package/dist/chunk-DGO4Z6NW.js +399 -0
- package/dist/chunk-EIQP2PZ6.js +56 -0
- package/dist/chunk-IYQL6QJY.js +60 -0
- package/dist/chunk-LD4OEJ4X.js +56 -0
- package/dist/chunk-LJJYJHOZ.js +450 -0
- package/dist/chunk-MQTHVJYR.js +54 -0
- package/dist/chunk-NF4H2OT3.js +355 -0
- package/dist/chunk-NWZVU75I.js +54 -0
- package/dist/chunk-Q6EJUFM6.js +56 -0
- package/dist/chunk-R4LAS3QA.js +54 -0
- package/dist/chunk-XIS7CAP4.js +54 -0
- package/dist/chunk-Y2OF4YA4.js +54 -0
- package/dist/core.cjs +282 -1
- package/dist/core.d.cts +16 -81
- package/dist/core.d.ts +16 -81
- package/dist/core.js +2 -1
- package/dist/index.cjs +301 -11
- package/dist/index.d.cts +2 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +3 -2
- package/dist/react.cjs +301 -11
- package/dist/react.d.cts +2 -3
- package/dist/react.d.ts +2 -3
- package/dist/react.js +2 -2
- package/dist/types-D2ZJx8T_.d.cts +103 -0
- package/dist/types-D2ZJx8T_.d.ts +103 -0
- package/dist/vue.cjs +300 -5
- package/dist/vue.d.cts +17 -3
- package/dist/vue.d.ts +17 -3
- package/dist/vue.js +20 -4
- package/package.json +5 -6
package/dist/core.cjs
CHANGED
|
@@ -23,10 +23,13 @@ __export(core_exports, {
|
|
|
23
23
|
createSchemaElementEditorBridge: () => createSchemaElementEditorBridge
|
|
24
24
|
});
|
|
25
25
|
module.exports = __toCommonJS(core_exports);
|
|
26
|
+
|
|
27
|
+
// src/constants.ts
|
|
26
28
|
var DEFAULT_SOURCE_CONFIG = {
|
|
27
29
|
contentSource: "schema-element-editor-content",
|
|
28
30
|
hostSource: "schema-element-editor-host"
|
|
29
31
|
};
|
|
32
|
+
var SDK_COORDINATOR_SOURCE = "schema-element-editor-sdk-coordinator";
|
|
30
33
|
var DEFAULT_MESSAGE_TYPES = {
|
|
31
34
|
getSchema: "GET_SCHEMA",
|
|
32
35
|
updateSchema: "UPDATE_SCHEMA",
|
|
@@ -38,8 +41,239 @@ var DEFAULT_MESSAGE_TYPES = {
|
|
|
38
41
|
stopRecording: "STOP_RECORDING",
|
|
39
42
|
schemaPush: "SCHEMA_PUSH"
|
|
40
43
|
};
|
|
44
|
+
var SDK_COORDINATION_MESSAGE_TYPES = {
|
|
45
|
+
register: "SDK_REGISTER",
|
|
46
|
+
unregister: "SDK_UNREGISTER",
|
|
47
|
+
query: "SDK_QUERY"
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
// src/coordinator.ts
|
|
51
|
+
var SdkCoordinator = class {
|
|
52
|
+
constructor(config) {
|
|
53
|
+
/**
|
|
54
|
+
* SDK 销毁标志
|
|
55
|
+
*
|
|
56
|
+
* 作用:防止在 cleanup() 执行期间,监听器移除前仍然响应请求
|
|
57
|
+
*
|
|
58
|
+
* 场景:cleanup() 中先调用 destroy()(设置 isDestroyed = true),
|
|
59
|
+
* 然后才移除 handleMessage 监听器。在这个微小的时间窗口内,
|
|
60
|
+
* 如果插件请求到达,没有 isDestroyed 检查会导致已销毁的 SDK 仍然响应。
|
|
61
|
+
*/
|
|
62
|
+
this.isDestroyed = false;
|
|
63
|
+
/**
|
|
64
|
+
* 存储比当前 SDK 优先级更高的其他 SDK ID
|
|
65
|
+
* 按方法分类:如果某个方法的集合不为空,说明有更高优先级的 SDK 应该处理该方法
|
|
66
|
+
*
|
|
67
|
+
* 优化:只为当前 SDK 实现了的方法维护优先级集合
|
|
68
|
+
*/
|
|
69
|
+
this.higherLevelSDKs = {};
|
|
70
|
+
/**
|
|
71
|
+
* 存储与当前 SDK 优先级相同的其他 SDK ID
|
|
72
|
+
* 按方法分类:用于判断是否需要在执行失败时跳过响应
|
|
73
|
+
*
|
|
74
|
+
* 当有同级竞争者时,SDK在执行失败/无数据时会跳过响应,让其他SDK有机会响应
|
|
75
|
+
*/
|
|
76
|
+
this.sameLevelSDKs = {};
|
|
77
|
+
/**
|
|
78
|
+
* 处理 SDK 协调消息
|
|
79
|
+
*/
|
|
80
|
+
this.handleCoordinationMessage = (event) => {
|
|
81
|
+
const isFromSelf = event.source === window;
|
|
82
|
+
const isFromParent = window !== window.top && event.source === window.parent;
|
|
83
|
+
if (!isFromSelf && !isFromParent) return;
|
|
84
|
+
const data = event.data;
|
|
85
|
+
if (!data || data.source !== SDK_COORDINATOR_SOURCE) return;
|
|
86
|
+
switch (data.type) {
|
|
87
|
+
case SDK_COORDINATION_MESSAGE_TYPES.query:
|
|
88
|
+
this.sendRegister();
|
|
89
|
+
break;
|
|
90
|
+
case SDK_COORDINATION_MESSAGE_TYPES.register:
|
|
91
|
+
this.handleSdkRegister(data.payload);
|
|
92
|
+
break;
|
|
93
|
+
case SDK_COORDINATION_MESSAGE_TYPES.unregister:
|
|
94
|
+
this.handleSdkUnregister(data.payload.sdkId);
|
|
95
|
+
break;
|
|
96
|
+
}
|
|
97
|
+
};
|
|
98
|
+
this.sdkId = config.sdkId || `sdk-${Date.now()}-${Math.random().toString(36).slice(2, 11)}`;
|
|
99
|
+
this.messageSource = config.messageSource;
|
|
100
|
+
this.level = config.level ?? 0;
|
|
101
|
+
this.methodLevels = config.methodLevels ?? {};
|
|
102
|
+
this.implementedMethods = config.implementedMethods;
|
|
103
|
+
this.implementedMethods.forEach((method) => {
|
|
104
|
+
this.higherLevelSDKs[method] = /* @__PURE__ */ new Set();
|
|
105
|
+
this.sameLevelSDKs[method] = /* @__PURE__ */ new Set();
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* 初始化协调器
|
|
110
|
+
*/
|
|
111
|
+
init() {
|
|
112
|
+
window.addEventListener("message", this.handleCoordinationMessage);
|
|
113
|
+
this.sendQuery();
|
|
114
|
+
this.sendRegister();
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* 销毁协调器
|
|
118
|
+
*/
|
|
119
|
+
destroy() {
|
|
120
|
+
this.isDestroyed = true;
|
|
121
|
+
this.sendUnregister();
|
|
122
|
+
window.removeEventListener("message", this.handleCoordinationMessage);
|
|
123
|
+
Object.values(this.higherLevelSDKs).forEach((set) => set.clear());
|
|
124
|
+
Object.values(this.sameLevelSDKs).forEach((set) => set.clear());
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* 判断是否应该响应某个方法的请求
|
|
128
|
+
* @param method - 方法名
|
|
129
|
+
* @returns 是否应该响应
|
|
130
|
+
*/
|
|
131
|
+
shouldRespond(method) {
|
|
132
|
+
if (this.isDestroyed) return false;
|
|
133
|
+
if (!this.implementedMethods.includes(method)) {
|
|
134
|
+
return false;
|
|
135
|
+
}
|
|
136
|
+
const higherSDKs = this.higherLevelSDKs[method];
|
|
137
|
+
return !higherSDKs || higherSDKs.size === 0;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* 判断某个方法是否有相同优先级的竞争者
|
|
141
|
+
* @param method - 方法名
|
|
142
|
+
* @returns 是否存在同级竞争者
|
|
143
|
+
*/
|
|
144
|
+
hasSameLevelCompetitors(method) {
|
|
145
|
+
const sameSDKs = this.sameLevelSDKs[method];
|
|
146
|
+
return sameSDKs ? sameSDKs.size > 0 : false;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* 获取方法的优先级
|
|
150
|
+
*/
|
|
151
|
+
getMethodLevel(method) {
|
|
152
|
+
return this.methodLevels[method] ?? this.level;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* 处理其他 SDK 的注册
|
|
156
|
+
*/
|
|
157
|
+
handleSdkRegister(info) {
|
|
158
|
+
if (info.sdkId === this.sdkId) return;
|
|
159
|
+
if (info.messageSource !== this.messageSource) return;
|
|
160
|
+
this.implementedMethods.forEach((method) => {
|
|
161
|
+
if (!info.implementedMethods.includes(method)) {
|
|
162
|
+
return;
|
|
163
|
+
}
|
|
164
|
+
const myLevel = this.getMethodLevel(method);
|
|
165
|
+
const otherLevel = info.methodLevels[method] ?? info.level;
|
|
166
|
+
if (otherLevel > myLevel) {
|
|
167
|
+
this.higherLevelSDKs[method].add(info.sdkId);
|
|
168
|
+
this.sameLevelSDKs[method].delete(info.sdkId);
|
|
169
|
+
} else if (otherLevel === myLevel) {
|
|
170
|
+
this.sameLevelSDKs[method].add(info.sdkId);
|
|
171
|
+
this.higherLevelSDKs[method].delete(info.sdkId);
|
|
172
|
+
} else {
|
|
173
|
+
this.higherLevelSDKs[method].delete(info.sdkId);
|
|
174
|
+
this.sameLevelSDKs[method].delete(info.sdkId);
|
|
175
|
+
}
|
|
176
|
+
});
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* 处理其他 SDK 的注销
|
|
180
|
+
*/
|
|
181
|
+
handleSdkUnregister(sdkId) {
|
|
182
|
+
Object.values(this.higherLevelSDKs).forEach((set) => {
|
|
183
|
+
set.delete(sdkId);
|
|
184
|
+
});
|
|
185
|
+
Object.values(this.sameLevelSDKs).forEach((set) => {
|
|
186
|
+
set.delete(sdkId);
|
|
187
|
+
});
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* 发送查询消息
|
|
191
|
+
*/
|
|
192
|
+
sendQuery() {
|
|
193
|
+
const message = {
|
|
194
|
+
source: SDK_COORDINATOR_SOURCE,
|
|
195
|
+
type: SDK_COORDINATION_MESSAGE_TYPES.query,
|
|
196
|
+
payload: { sdkId: this.sdkId }
|
|
197
|
+
};
|
|
198
|
+
this.postCoordinationMessage(message);
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* 发送注册消息
|
|
202
|
+
*/
|
|
203
|
+
sendRegister() {
|
|
204
|
+
const message = {
|
|
205
|
+
source: SDK_COORDINATOR_SOURCE,
|
|
206
|
+
type: SDK_COORDINATION_MESSAGE_TYPES.register,
|
|
207
|
+
payload: {
|
|
208
|
+
sdkId: this.sdkId,
|
|
209
|
+
messageSource: this.messageSource,
|
|
210
|
+
level: this.level,
|
|
211
|
+
methodLevels: this.methodLevels,
|
|
212
|
+
implementedMethods: this.implementedMethods
|
|
213
|
+
}
|
|
214
|
+
};
|
|
215
|
+
this.postCoordinationMessage(message);
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* 发送注销消息
|
|
219
|
+
*/
|
|
220
|
+
sendUnregister() {
|
|
221
|
+
const message = {
|
|
222
|
+
source: SDK_COORDINATOR_SOURCE,
|
|
223
|
+
type: SDK_COORDINATION_MESSAGE_TYPES.unregister,
|
|
224
|
+
payload: { sdkId: this.sdkId }
|
|
225
|
+
};
|
|
226
|
+
this.postCoordinationMessage(message);
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* 发送协调消息
|
|
230
|
+
*/
|
|
231
|
+
postCoordinationMessage(message) {
|
|
232
|
+
window.postMessage(message, "*");
|
|
233
|
+
if (window.top && window.top !== window) {
|
|
234
|
+
window.top.postMessage(message, "*");
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
};
|
|
238
|
+
|
|
239
|
+
// src/bridge.ts
|
|
240
|
+
var METHOD_NAMES = {
|
|
241
|
+
GET_SCHEMA: "getSchema",
|
|
242
|
+
UPDATE_SCHEMA: "updateSchema",
|
|
243
|
+
CHECK_PREVIEW: "checkPreview",
|
|
244
|
+
RENDER_PREVIEW: "renderPreview",
|
|
245
|
+
CLEANUP_PREVIEW: "cleanupPreview",
|
|
246
|
+
START_RECORDING: "startRecording",
|
|
247
|
+
STOP_RECORDING: "stopRecording"
|
|
248
|
+
};
|
|
249
|
+
function shouldSkipFailedResponse(method, result) {
|
|
250
|
+
switch (method) {
|
|
251
|
+
case METHOD_NAMES.GET_SCHEMA:
|
|
252
|
+
return result.success === true && result.data === void 0;
|
|
253
|
+
case METHOD_NAMES.UPDATE_SCHEMA:
|
|
254
|
+
return result.success === false;
|
|
255
|
+
case METHOD_NAMES.RENDER_PREVIEW:
|
|
256
|
+
case METHOD_NAMES.CLEANUP_PREVIEW:
|
|
257
|
+
return result.success === false;
|
|
258
|
+
case METHOD_NAMES.CHECK_PREVIEW:
|
|
259
|
+
case METHOD_NAMES.START_RECORDING:
|
|
260
|
+
case METHOD_NAMES.STOP_RECORDING:
|
|
261
|
+
return false;
|
|
262
|
+
default:
|
|
263
|
+
return false;
|
|
264
|
+
}
|
|
265
|
+
}
|
|
41
266
|
function createSchemaElementEditorBridge(config) {
|
|
42
|
-
const {
|
|
267
|
+
const {
|
|
268
|
+
getSchema,
|
|
269
|
+
updateSchema,
|
|
270
|
+
renderPreview,
|
|
271
|
+
sourceConfig,
|
|
272
|
+
messageTypes,
|
|
273
|
+
sdkId,
|
|
274
|
+
level,
|
|
275
|
+
methodLevels
|
|
276
|
+
} = config;
|
|
43
277
|
const mergedSourceConfig = {
|
|
44
278
|
...DEFAULT_SOURCE_CONFIG,
|
|
45
279
|
...sourceConfig
|
|
@@ -48,9 +282,40 @@ function createSchemaElementEditorBridge(config) {
|
|
|
48
282
|
...DEFAULT_MESSAGE_TYPES,
|
|
49
283
|
...messageTypes
|
|
50
284
|
};
|
|
285
|
+
const implementedMethods = [];
|
|
286
|
+
if (typeof getSchema === "function") implementedMethods.push(METHOD_NAMES.GET_SCHEMA);
|
|
287
|
+
if (typeof updateSchema === "function") implementedMethods.push(METHOD_NAMES.UPDATE_SCHEMA);
|
|
288
|
+
if (typeof renderPreview === "function") {
|
|
289
|
+
implementedMethods.push(
|
|
290
|
+
METHOD_NAMES.CHECK_PREVIEW,
|
|
291
|
+
METHOD_NAMES.RENDER_PREVIEW,
|
|
292
|
+
METHOD_NAMES.CLEANUP_PREVIEW
|
|
293
|
+
);
|
|
294
|
+
}
|
|
295
|
+
implementedMethods.push(METHOD_NAMES.START_RECORDING, METHOD_NAMES.STOP_RECORDING);
|
|
296
|
+
const coordinator = new SdkCoordinator({
|
|
297
|
+
sdkId,
|
|
298
|
+
messageSource: mergedSourceConfig.contentSource,
|
|
299
|
+
level,
|
|
300
|
+
methodLevels,
|
|
301
|
+
implementedMethods
|
|
302
|
+
});
|
|
303
|
+
coordinator.init();
|
|
51
304
|
let previewCleanupFn = null;
|
|
52
305
|
const recordingParams = /* @__PURE__ */ new Set();
|
|
53
306
|
const currentConfig = { getSchema, updateSchema, renderPreview };
|
|
307
|
+
const methodTypeToName = {
|
|
308
|
+
[mergedMessageTypes.getSchema]: METHOD_NAMES.GET_SCHEMA,
|
|
309
|
+
[mergedMessageTypes.updateSchema]: METHOD_NAMES.UPDATE_SCHEMA,
|
|
310
|
+
[mergedMessageTypes.checkPreview]: METHOD_NAMES.CHECK_PREVIEW,
|
|
311
|
+
[mergedMessageTypes.renderPreview]: METHOD_NAMES.RENDER_PREVIEW,
|
|
312
|
+
[mergedMessageTypes.cleanupPreview]: METHOD_NAMES.CLEANUP_PREVIEW,
|
|
313
|
+
[mergedMessageTypes.startRecording]: METHOD_NAMES.START_RECORDING,
|
|
314
|
+
[mergedMessageTypes.stopRecording]: METHOD_NAMES.STOP_RECORDING
|
|
315
|
+
};
|
|
316
|
+
const getMethodNameByType = (type) => {
|
|
317
|
+
return methodTypeToName[type] ?? null;
|
|
318
|
+
};
|
|
54
319
|
const sendResponse = (requestId, result) => {
|
|
55
320
|
const message = {
|
|
56
321
|
source: mergedSourceConfig.hostSource,
|
|
@@ -83,10 +348,18 @@ function createSchemaElementEditorBridge(config) {
|
|
|
83
348
|
if (!event.data || event.data.source !== mergedSourceConfig.contentSource) return;
|
|
84
349
|
const { type, payload, requestId } = event.data;
|
|
85
350
|
if (!requestId) return;
|
|
351
|
+
const methodName = getMethodNameByType(type);
|
|
352
|
+
if (!methodName) return;
|
|
353
|
+
if (!coordinator.shouldRespond(methodName)) {
|
|
354
|
+
return;
|
|
355
|
+
}
|
|
86
356
|
const { getSchema: getSchema2, updateSchema: updateSchema2, renderPreview: renderPreview2 } = currentConfig;
|
|
87
357
|
let result;
|
|
88
358
|
switch (type) {
|
|
89
359
|
case mergedMessageTypes.getSchema: {
|
|
360
|
+
if (typeof getSchema2 !== "function") {
|
|
361
|
+
return;
|
|
362
|
+
}
|
|
90
363
|
const params = String(payload?.params ?? "");
|
|
91
364
|
try {
|
|
92
365
|
const data = getSchema2(params);
|
|
@@ -100,6 +373,9 @@ function createSchemaElementEditorBridge(config) {
|
|
|
100
373
|
break;
|
|
101
374
|
}
|
|
102
375
|
case mergedMessageTypes.updateSchema: {
|
|
376
|
+
if (typeof updateSchema2 !== "function") {
|
|
377
|
+
return;
|
|
378
|
+
}
|
|
103
379
|
const schema = payload?.schema;
|
|
104
380
|
const params = String(payload?.params ?? "");
|
|
105
381
|
try {
|
|
@@ -172,11 +448,16 @@ function createSchemaElementEditorBridge(config) {
|
|
|
172
448
|
default:
|
|
173
449
|
return;
|
|
174
450
|
}
|
|
451
|
+
const hasSameLevelSdks = coordinator.hasSameLevelCompetitors(methodName);
|
|
452
|
+
if (hasSameLevelSdks && shouldSkipFailedResponse(methodName, result)) {
|
|
453
|
+
return;
|
|
454
|
+
}
|
|
175
455
|
sendResponse(requestId, result);
|
|
176
456
|
};
|
|
177
457
|
window.addEventListener("message", handleMessage);
|
|
178
458
|
return {
|
|
179
459
|
cleanup: () => {
|
|
460
|
+
coordinator.destroy();
|
|
180
461
|
window.removeEventListener("message", handleMessage);
|
|
181
462
|
if (previewCleanupFn) {
|
|
182
463
|
previewCleanupFn();
|
package/dist/core.d.cts
CHANGED
|
@@ -1,85 +1,16 @@
|
|
|
1
|
+
import { b as SchemaElementEditorConfig, c as SchemaElementEditorBridge } from './types-D2ZJx8T_.cjs';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
|
-
* Schema Element Editor Host SDK -
|
|
4
|
+
* Schema Element Editor Host SDK - Bridge
|
|
3
5
|
* 纯 JS 核心逻辑,无框架依赖
|
|
4
6
|
*/
|
|
5
|
-
|
|
6
|
-
* Schema 数据类型
|
|
7
|
-
* 支持所有 JSON.parse 可返回的类型
|
|
8
|
-
*/
|
|
9
|
-
type SchemaValue = Record<string, unknown> | unknown[] | string | number | boolean | null;
|
|
10
|
-
/** postMessage 消息标识配置 */
|
|
11
|
-
interface PostMessageSourceConfig {
|
|
12
|
-
/** 插件端发送消息的 source 标识 */
|
|
13
|
-
contentSource: string;
|
|
14
|
-
/** 宿主端响应消息的 source 标识 */
|
|
15
|
-
hostSource: string;
|
|
16
|
-
}
|
|
17
|
-
/** postMessage 消息类型配置 */
|
|
18
|
-
interface PostMessageTypeConfig {
|
|
19
|
-
getSchema: string;
|
|
20
|
-
updateSchema: string;
|
|
21
|
-
checkPreview: string;
|
|
22
|
-
renderPreview: string;
|
|
23
|
-
cleanupPreview: string;
|
|
24
|
-
startRecording: string;
|
|
25
|
-
stopRecording: string;
|
|
26
|
-
schemaPush: string;
|
|
27
|
-
}
|
|
28
|
-
/**
|
|
29
|
-
* Schema Element Editor 配置接口
|
|
30
|
-
*/
|
|
31
|
-
interface SchemaElementEditorConfig {
|
|
32
|
-
/**
|
|
33
|
-
* 获取 Schema 数据
|
|
34
|
-
* @param params - 元素参数(通常是 data-id 的值)
|
|
35
|
-
* @returns Schema 数据(支持所有 JSON 类型)
|
|
36
|
-
*/
|
|
37
|
-
getSchema: (params: string) => SchemaValue;
|
|
38
|
-
/**
|
|
39
|
-
* 更新 Schema 数据
|
|
40
|
-
* @param schema - 新的 Schema 数据(支持所有 JSON 类型)
|
|
41
|
-
* @param params - 元素参数
|
|
42
|
-
* @returns 是否更新成功
|
|
43
|
-
*/
|
|
44
|
-
updateSchema: (schema: SchemaValue, params: string) => boolean;
|
|
45
|
-
/**
|
|
46
|
-
* 渲染预览(可选)
|
|
47
|
-
* @param schema - Schema 数据(支持所有 JSON 类型)
|
|
48
|
-
* @param containerId - 预览容器 ID
|
|
49
|
-
* @returns 清理函数(可选)
|
|
50
|
-
*/
|
|
51
|
-
renderPreview?: (schema: SchemaValue, containerId: string) => (() => void) | void;
|
|
52
|
-
/** 消息标识配置(可选,有默认值) */
|
|
53
|
-
sourceConfig?: Partial<PostMessageSourceConfig>;
|
|
54
|
-
/** 消息类型配置(可选,有默认值) */
|
|
55
|
-
messageTypes?: Partial<PostMessageTypeConfig>;
|
|
56
|
-
}
|
|
57
|
-
/**
|
|
58
|
-
* 录制相关方法
|
|
59
|
-
*/
|
|
60
|
-
interface SchemaElementEditorRecording {
|
|
61
|
-
/**
|
|
62
|
-
* 推送 Schema 数据(SDK 内部判断是否在录制,未录制时静默忽略)
|
|
63
|
-
* @param params - 元素参数(data-id 的值)
|
|
64
|
-
* @param data - Schema 数据
|
|
65
|
-
*/
|
|
66
|
-
push: (params: string, data: SchemaValue) => void;
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* Schema Element Editor 桥接器返回值
|
|
70
|
-
*/
|
|
71
|
-
interface SchemaElementEditorBridge {
|
|
72
|
-
/** 清理桥接器,移除事件监听 */
|
|
73
|
-
cleanup: () => void;
|
|
74
|
-
/** 录制相关方法 */
|
|
75
|
-
recording: SchemaElementEditorRecording;
|
|
76
|
-
}
|
|
7
|
+
|
|
77
8
|
/**
|
|
78
9
|
* 创建 Schema Element Editor 桥接器
|
|
79
10
|
* 纯 JS 函数,返回桥接器对象
|
|
80
11
|
*
|
|
81
12
|
* @param config - Schema Element Editor 配置
|
|
82
|
-
* @returns 桥接器对象,包含 cleanup 和
|
|
13
|
+
* @returns 桥接器对象,包含 cleanup 和 recording 方法
|
|
83
14
|
*
|
|
84
15
|
* @example
|
|
85
16
|
* ```js
|
|
@@ -92,16 +23,20 @@ interface SchemaElementEditorBridge {
|
|
|
92
23
|
* },
|
|
93
24
|
* })
|
|
94
25
|
*
|
|
95
|
-
* //
|
|
26
|
+
* // 只提供预览功能,让其他 SDK 处理数据管理
|
|
27
|
+
* const bridge = createSchemaElementEditorBridge({
|
|
28
|
+
* level: 100,
|
|
29
|
+
* renderPreview: (schema, containerId) => {
|
|
30
|
+
* renderMyCustomPreview(schema, containerId)
|
|
31
|
+
* },
|
|
32
|
+
* })
|
|
33
|
+
*
|
|
34
|
+
* // 数据变化时调用 recording.push 推送数据(录制功能自动可用)
|
|
96
35
|
* sseHandler.onData = (params, data) => {
|
|
97
|
-
* bridge.
|
|
36
|
+
* bridge.recording.push(params, data)
|
|
98
37
|
* }
|
|
99
|
-
*
|
|
100
|
-
* // 如需在录制开始/停止时执行额外逻辑,可配置回调(可选)
|
|
101
|
-
* // onStartRecording: (params) => console.log('开始录制:', params),
|
|
102
|
-
* // onStopRecording: (params) => console.log('停止录制:', params),
|
|
103
38
|
* ```
|
|
104
39
|
*/
|
|
105
40
|
declare function createSchemaElementEditorBridge(config: SchemaElementEditorConfig): SchemaElementEditorBridge;
|
|
106
41
|
|
|
107
|
-
export {
|
|
42
|
+
export { createSchemaElementEditorBridge };
|
package/dist/core.d.ts
CHANGED
|
@@ -1,85 +1,16 @@
|
|
|
1
|
+
import { b as SchemaElementEditorConfig, c as SchemaElementEditorBridge } from './types-D2ZJx8T_.js';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
|
-
* Schema Element Editor Host SDK -
|
|
4
|
+
* Schema Element Editor Host SDK - Bridge
|
|
3
5
|
* 纯 JS 核心逻辑,无框架依赖
|
|
4
6
|
*/
|
|
5
|
-
|
|
6
|
-
* Schema 数据类型
|
|
7
|
-
* 支持所有 JSON.parse 可返回的类型
|
|
8
|
-
*/
|
|
9
|
-
type SchemaValue = Record<string, unknown> | unknown[] | string | number | boolean | null;
|
|
10
|
-
/** postMessage 消息标识配置 */
|
|
11
|
-
interface PostMessageSourceConfig {
|
|
12
|
-
/** 插件端发送消息的 source 标识 */
|
|
13
|
-
contentSource: string;
|
|
14
|
-
/** 宿主端响应消息的 source 标识 */
|
|
15
|
-
hostSource: string;
|
|
16
|
-
}
|
|
17
|
-
/** postMessage 消息类型配置 */
|
|
18
|
-
interface PostMessageTypeConfig {
|
|
19
|
-
getSchema: string;
|
|
20
|
-
updateSchema: string;
|
|
21
|
-
checkPreview: string;
|
|
22
|
-
renderPreview: string;
|
|
23
|
-
cleanupPreview: string;
|
|
24
|
-
startRecording: string;
|
|
25
|
-
stopRecording: string;
|
|
26
|
-
schemaPush: string;
|
|
27
|
-
}
|
|
28
|
-
/**
|
|
29
|
-
* Schema Element Editor 配置接口
|
|
30
|
-
*/
|
|
31
|
-
interface SchemaElementEditorConfig {
|
|
32
|
-
/**
|
|
33
|
-
* 获取 Schema 数据
|
|
34
|
-
* @param params - 元素参数(通常是 data-id 的值)
|
|
35
|
-
* @returns Schema 数据(支持所有 JSON 类型)
|
|
36
|
-
*/
|
|
37
|
-
getSchema: (params: string) => SchemaValue;
|
|
38
|
-
/**
|
|
39
|
-
* 更新 Schema 数据
|
|
40
|
-
* @param schema - 新的 Schema 数据(支持所有 JSON 类型)
|
|
41
|
-
* @param params - 元素参数
|
|
42
|
-
* @returns 是否更新成功
|
|
43
|
-
*/
|
|
44
|
-
updateSchema: (schema: SchemaValue, params: string) => boolean;
|
|
45
|
-
/**
|
|
46
|
-
* 渲染预览(可选)
|
|
47
|
-
* @param schema - Schema 数据(支持所有 JSON 类型)
|
|
48
|
-
* @param containerId - 预览容器 ID
|
|
49
|
-
* @returns 清理函数(可选)
|
|
50
|
-
*/
|
|
51
|
-
renderPreview?: (schema: SchemaValue, containerId: string) => (() => void) | void;
|
|
52
|
-
/** 消息标识配置(可选,有默认值) */
|
|
53
|
-
sourceConfig?: Partial<PostMessageSourceConfig>;
|
|
54
|
-
/** 消息类型配置(可选,有默认值) */
|
|
55
|
-
messageTypes?: Partial<PostMessageTypeConfig>;
|
|
56
|
-
}
|
|
57
|
-
/**
|
|
58
|
-
* 录制相关方法
|
|
59
|
-
*/
|
|
60
|
-
interface SchemaElementEditorRecording {
|
|
61
|
-
/**
|
|
62
|
-
* 推送 Schema 数据(SDK 内部判断是否在录制,未录制时静默忽略)
|
|
63
|
-
* @param params - 元素参数(data-id 的值)
|
|
64
|
-
* @param data - Schema 数据
|
|
65
|
-
*/
|
|
66
|
-
push: (params: string, data: SchemaValue) => void;
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* Schema Element Editor 桥接器返回值
|
|
70
|
-
*/
|
|
71
|
-
interface SchemaElementEditorBridge {
|
|
72
|
-
/** 清理桥接器,移除事件监听 */
|
|
73
|
-
cleanup: () => void;
|
|
74
|
-
/** 录制相关方法 */
|
|
75
|
-
recording: SchemaElementEditorRecording;
|
|
76
|
-
}
|
|
7
|
+
|
|
77
8
|
/**
|
|
78
9
|
* 创建 Schema Element Editor 桥接器
|
|
79
10
|
* 纯 JS 函数,返回桥接器对象
|
|
80
11
|
*
|
|
81
12
|
* @param config - Schema Element Editor 配置
|
|
82
|
-
* @returns 桥接器对象,包含 cleanup 和
|
|
13
|
+
* @returns 桥接器对象,包含 cleanup 和 recording 方法
|
|
83
14
|
*
|
|
84
15
|
* @example
|
|
85
16
|
* ```js
|
|
@@ -92,16 +23,20 @@ interface SchemaElementEditorBridge {
|
|
|
92
23
|
* },
|
|
93
24
|
* })
|
|
94
25
|
*
|
|
95
|
-
* //
|
|
26
|
+
* // 只提供预览功能,让其他 SDK 处理数据管理
|
|
27
|
+
* const bridge = createSchemaElementEditorBridge({
|
|
28
|
+
* level: 100,
|
|
29
|
+
* renderPreview: (schema, containerId) => {
|
|
30
|
+
* renderMyCustomPreview(schema, containerId)
|
|
31
|
+
* },
|
|
32
|
+
* })
|
|
33
|
+
*
|
|
34
|
+
* // 数据变化时调用 recording.push 推送数据(录制功能自动可用)
|
|
96
35
|
* sseHandler.onData = (params, data) => {
|
|
97
|
-
* bridge.
|
|
36
|
+
* bridge.recording.push(params, data)
|
|
98
37
|
* }
|
|
99
|
-
*
|
|
100
|
-
* // 如需在录制开始/停止时执行额外逻辑,可配置回调(可选)
|
|
101
|
-
* // onStartRecording: (params) => console.log('开始录制:', params),
|
|
102
|
-
* // onStopRecording: (params) => console.log('停止录制:', params),
|
|
103
38
|
* ```
|
|
104
39
|
*/
|
|
105
40
|
declare function createSchemaElementEditorBridge(config: SchemaElementEditorConfig): SchemaElementEditorBridge;
|
|
106
41
|
|
|
107
|
-
export {
|
|
42
|
+
export { createSchemaElementEditorBridge };
|