@heybox/hb-sdk-protocol 0.9.1-alpha.1 → 0.9.1-alpha.11

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.
@@ -1,596 +0,0 @@
1
- import type { CompanionCancelPreparationPayload, CompanionCancelPreparationResult, CompanionGetActiveSessionPayload, CompanionGetActiveSessionResult, CompanionGetInfoPayload, CompanionGetInfoResult, CompanionGetPreparationStatusPayload, CompanionGetPreparationStatusResult, CompanionLaunchPayload, CompanionLaunchResult, CompanionOpenAttachmentPayload, CompanionOpenAttachmentResult, CompanionPreparePayload, CompanionPrepareProgress, CompanionPrepareResult, CompanionSessionAckOutputPayload, CompanionSessionAckOutputResult, CompanionSessionCloseStdinPayload, CompanionSessionCloseStdinResult, CompanionSessionTerminatePayload, CompanionSessionTerminateResult, CompanionSessionWritePayload, CompanionSessionWriteResult, CompanionShowNotificationPayload, CompanionShowNotificationResult, ClosePayload, CloseResult, CopyLinkPayload, CopyLinkResult, DirectoryCreatePayload, DirectoryCreateResult, DirectoryExistsPayload, DirectoryExistsResult, DirectoryListPayload, DirectoryListResult, DirectoryRemovePayload, DirectoryRemoveResult, DownloadProgressPayload, DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, GetStoragePayload, GetStorageResult, GetSteamGameListPayload, GetSteamGameListResult, GetUserInfoPayload, GetUserInfoResult, GetWindowInfoPayload, GetWindowInfoResult, HideLoadingPayload, HideLoadingResult, FileCreatePayload, FileCreateResult, FileExistsPayload, FileExistsResult, FileReadBytesPayload, FileReadBytesResult, FileReadTextPayload, FileReadTextResult, FileRemovePayload, FileRemoveResult, FileStatPayload, FileStatResult, FileWriteBytesPayload, FileWriteBytesResult, FileWriteTextPayload, FileWriteTextResult, LoginPayload, LoginResult, NetworkDownloadPayload, NetworkDownloadResult, NetworkRequestPayload, NetworkResponsePayload, OpenAppPagePayload, OpenAppPageResult, PickDirectoryPayload, PickDirectoryResult, PickFilesPayload, PickFilesResult, ReloadPayload, ReloadResult, ScreenshotPayload, ScreenshotResult, SaveFilePayload, SaveFileResult, SetClipboardPayload, SetClipboardResult, SetDisplayPayload, SetDisplayResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, SetStoragePayload, ShowLoadingPayload, ShowLoadingResult, ShowShareMenuPayload, ShowShareMenuResult, ShowToastPayload, ShowToastResult, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult, VibratePayload, VibrateResult } from './payloads';
2
- import type { MiniProgramPermissionRequirement } from './permission-catalog';
3
- export declare const AUTH_LOGIN_METHOD: "auth.login";
4
- export declare const USER_GET_INFO_METHOD: "user.getInfo";
5
- export declare const USER_REVOKE_AUTHORIZATION_METHOD: "user.revokeAuthorization";
6
- export declare const USER_GET_STEAM_GAME_LIST_METHOD: "user.getSteamGameList";
7
- export declare const SHARE_COPY_LINK_METHOD: "share.copyLink";
8
- export declare const SHARE_SHOW_SHARE_MENU_METHOD: "share.showShareMenu";
9
- export declare const SHARE_SCREENSHOT_METHOD: "share.screenshot";
10
- export declare const VIEWPORT_SET_DISPLAY_METHOD: "viewport.setDisplay";
11
- export declare const VIEWPORT_GET_WINDOW_INFO_METHOD: "viewport.getWindowInfo";
12
- export declare const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD: "viewport.setNavigationBarStyle";
13
- export declare const STORAGE_GET_STORAGE_METHOD: "storage.getStorage";
14
- export declare const STORAGE_SET_STORAGE_METHOD: "storage.setStorage";
15
- export declare const NETWORK_REQUEST_METHOD: "network.request";
16
- export declare const NETWORK_DOWNLOAD_METHOD: "network.download";
17
- export declare const FILES_PICK_FILES_METHOD: "files.pickFiles";
18
- export declare const FILES_PICK_DIRECTORY_METHOD: "files.pickDirectory";
19
- export declare const FILES_SAVE_FILE_METHOD: "files.saveFile";
20
- export declare const FILE_CREATE_METHOD: "file.create";
21
- export declare const FILE_REMOVE_METHOD: "file.remove";
22
- export declare const FILE_EXISTS_METHOD: "file.exists";
23
- export declare const FILE_READ_TEXT_METHOD: "file.readText";
24
- export declare const FILE_WRITE_TEXT_METHOD: "file.writeText";
25
- export declare const FILE_READ_BYTES_METHOD: "file.readBytes";
26
- export declare const FILE_WRITE_BYTES_METHOD: "file.writeBytes";
27
- export declare const FILE_STAT_METHOD: "file.stat";
28
- export declare const DIRECTORY_CREATE_METHOD: "directory.create";
29
- export declare const DIRECTORY_REMOVE_METHOD: "directory.remove";
30
- export declare const DIRECTORY_EXISTS_METHOD: "directory.exists";
31
- export declare const DIRECTORY_LIST_METHOD: "directory.list";
32
- export declare const UI_SHOW_TOAST_METHOD: "ui.showToast";
33
- export declare const UI_SHOW_LOADING_METHOD: "ui.showLoading";
34
- export declare const UI_HIDE_LOADING_METHOD: "ui.hideLoading";
35
- export declare const DEVICE_VIBRATE_METHOD: "device.vibrate";
36
- export declare const DEVICE_SET_CLIPBOARD_METHOD: "device.setClipboard";
37
- export declare const NAVIGATION_CLOSE_METHOD: "navigation.close";
38
- export declare const NAVIGATION_RELOAD_METHOD: "navigation.reload";
39
- export declare const NAVIGATION_OPEN_APP_PAGE_METHOD: "navigation.openAppPage";
40
- export declare const CLOUD_LEADERBOARD_SUBMIT_METHOD: "cloud.leaderboard.submit";
41
- export declare const CLOUD_LEADERBOARD_GET_LIST_METHOD: "cloud.leaderboard.getList";
42
- export declare const CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD: "cloud.leaderboard.getCurrentUserEntry";
43
- export declare const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD: "cloud.leaderboard.deleteCurrentUserEntry";
44
- export declare const CLOUD_LEADERBOARD_GET_INFO_METHOD: "cloud.leaderboard.getInfo";
45
- export declare const COMPANION_GET_INFO_METHOD: "companion.getInfo";
46
- export declare const COMPANION_GET_PREPARATION_STATUS_METHOD: "companion.getPreparationStatus";
47
- export declare const COMPANION_PREPARE_METHOD: "companion.prepare";
48
- export declare const COMPANION_CANCEL_PREPARATION_METHOD: "companion.cancelPreparation";
49
- export declare const COMPANION_GET_ACTIVE_SESSION_METHOD: "companion.getActiveSession";
50
- export declare const COMPANION_LAUNCH_METHOD: "companion.launch";
51
- export declare const COMPANION_SESSION_WRITE_METHOD: "companion.session.write";
52
- export declare const COMPANION_SESSION_CLOSE_STDIN_METHOD: "companion.session.closeStdin";
53
- export declare const COMPANION_SESSION_TERMINATE_METHOD: "companion.session.terminate";
54
- export declare const COMPANION_SESSION_ACK_OUTPUT_METHOD: "companion.session.ackOutput";
55
- export declare const COMPANION_OPEN_ATTACHMENT_METHOD: "companion.openAttachment";
56
- export declare const COMPANION_SHOW_NOTIFICATION_METHOD: "companion.showNotification";
57
- export type MiniProgramAuthMethod = typeof AUTH_LOGIN_METHOD;
58
- export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD | typeof USER_REVOKE_AUTHORIZATION_METHOD | typeof USER_GET_STEAM_GAME_LIST_METHOD;
59
- export type MiniProgramShareMethod = typeof SHARE_COPY_LINK_METHOD | typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
60
- export type MiniProgramViewportMethod = typeof VIEWPORT_SET_DISPLAY_METHOD | typeof VIEWPORT_GET_WINDOW_INFO_METHOD | typeof VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD;
61
- export type MiniProgramStorageMethod = typeof STORAGE_GET_STORAGE_METHOD | typeof STORAGE_SET_STORAGE_METHOD;
62
- export type MiniProgramNetworkMethod = typeof NETWORK_REQUEST_METHOD | typeof NETWORK_DOWNLOAD_METHOD;
63
- export type MiniProgramFilesMethod = typeof FILES_PICK_FILES_METHOD | typeof FILES_PICK_DIRECTORY_METHOD | typeof FILES_SAVE_FILE_METHOD;
64
- export type MiniProgramFileMethod = typeof FILE_CREATE_METHOD | typeof FILE_REMOVE_METHOD | typeof FILE_EXISTS_METHOD | typeof FILE_READ_TEXT_METHOD | typeof FILE_WRITE_TEXT_METHOD | typeof FILE_READ_BYTES_METHOD | typeof FILE_WRITE_BYTES_METHOD | typeof FILE_STAT_METHOD;
65
- export type MiniProgramDirectoryMethod = typeof DIRECTORY_CREATE_METHOD | typeof DIRECTORY_REMOVE_METHOD | typeof DIRECTORY_EXISTS_METHOD | typeof DIRECTORY_LIST_METHOD;
66
- export type MiniProgramUiMethod = typeof UI_SHOW_TOAST_METHOD | typeof UI_SHOW_LOADING_METHOD | typeof UI_HIDE_LOADING_METHOD;
67
- export type MiniProgramDeviceMethod = typeof DEVICE_VIBRATE_METHOD | typeof DEVICE_SET_CLIPBOARD_METHOD;
68
- export type MiniProgramNavigationMethod = typeof NAVIGATION_CLOSE_METHOD | typeof NAVIGATION_RELOAD_METHOD | typeof NAVIGATION_OPEN_APP_PAGE_METHOD;
69
- export type MiniProgramCloudMethod = typeof CLOUD_LEADERBOARD_SUBMIT_METHOD | typeof CLOUD_LEADERBOARD_GET_LIST_METHOD | typeof CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD | typeof CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD | typeof CLOUD_LEADERBOARD_GET_INFO_METHOD;
70
- export type MiniProgramCompanionMethod = typeof COMPANION_GET_INFO_METHOD | typeof COMPANION_GET_PREPARATION_STATUS_METHOD | typeof COMPANION_PREPARE_METHOD | typeof COMPANION_CANCEL_PREPARATION_METHOD | typeof COMPANION_GET_ACTIVE_SESSION_METHOD | typeof COMPANION_LAUNCH_METHOD | typeof COMPANION_SESSION_WRITE_METHOD | typeof COMPANION_SESSION_CLOSE_STDIN_METHOD | typeof COMPANION_SESSION_TERMINATE_METHOD | typeof COMPANION_SESSION_ACK_OUTPUT_METHOD | typeof COMPANION_OPEN_ATTACHMENT_METHOD | typeof COMPANION_SHOW_NOTIFICATION_METHOD;
71
- export type MiniProgramBridgeMethod = MiniProgramAuthMethod | MiniProgramUserMethod | MiniProgramShareMethod | MiniProgramViewportMethod | MiniProgramStorageMethod | MiniProgramNetworkMethod | MiniProgramFilesMethod | MiniProgramFileMethod | MiniProgramDirectoryMethod | MiniProgramUiMethod | MiniProgramDeviceMethod | MiniProgramNavigationMethod | MiniProgramCloudMethod | MiniProgramCompanionMethod;
72
- export type MiniProgramCapabilityModule = 'auth' | 'user' | 'share' | 'viewport' | 'storage' | 'network' | 'files' | 'file' | 'directory' | 'ui' | 'device' | 'navigation' | 'cloud' | 'companion';
73
- export type MiniProgramCapabilityRisk = 'low' | 'medium' | 'high';
74
- /** 单个公开 bridge method 的机器可读协议元数据。 */
75
- export interface MiniProgramCapabilityDefinition {
76
- /** wire envelope 中使用的唯一 method 名。 */
77
- method: MiniProgramBridgeMethod;
78
- /** 负责实现和分发该 method 的 capability module。 */
79
- module: MiniProgramCapabilityModule;
80
- /** Runtime capability 开关使用的 key;当前公开协议中与 {@link method} 相同。 */
81
- capability: MiniProgramBridgeMethod;
82
- /** Manifest 声明必须满足的权限组合;不替代权限状态、Host 支持或业务授权校验。 */
83
- requirement: MiniProgramPermissionRequirement;
84
- /** 供审核、诊断和展示使用的静态风险分级;它本身不会执行安全策略。 */
85
- risk: MiniProgramCapabilityRisk;
86
- }
87
- /**
88
- * 所有公开小程序 bridge method 的权威 method-level 目录。
89
- *
90
- * @remarks
91
- * Host Runtime、文档生成器和一致性测试使用该目录判断 method 是否属于协议、由哪个 module
92
- * 持有,以及调用前需要满足哪些声明权限。每个 {@link MiniProgramBridgeMethod} 必须且只能出现
93
- * 一次;消费者不应另建 method、module、requirement 或 risk 的平行目录。
94
- *
95
- * 该目录只拥有 method metadata。精确 payload/result 类型分别由
96
- * {@link MiniProgramCapabilityPayloadMap} 与 {@link MiniProgramCapabilityResultMap} 定义,权限的
97
- * 展示名称、配置字段和平台审批属性由 `MINI_PROGRAM_PERMISSION_CATALOG` 定义。`kind: 'none'`
98
- * 仅表示无需 Manifest 权限声明,不表示绕过参数校验、Host 能力、可信手势或业务策略。
99
- */
100
- export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
101
- readonly method: "auth.login";
102
- readonly module: "auth";
103
- readonly capability: "auth.login";
104
- readonly requirement: {
105
- readonly kind: "all";
106
- readonly permissions: readonly ["userInfo"];
107
- };
108
- readonly risk: "medium";
109
- }, {
110
- readonly method: "user.getInfo";
111
- readonly module: "user";
112
- readonly capability: "user.getInfo";
113
- readonly requirement: {
114
- readonly kind: "all";
115
- readonly permissions: readonly ["userInfo"];
116
- };
117
- readonly risk: "medium";
118
- }, {
119
- readonly method: "user.revokeAuthorization";
120
- readonly module: "user";
121
- readonly capability: "user.revokeAuthorization";
122
- readonly requirement: {
123
- readonly kind: "none";
124
- };
125
- readonly risk: "high";
126
- }, {
127
- readonly method: "user.getSteamGameList";
128
- readonly module: "user";
129
- readonly capability: "user.getSteamGameList";
130
- readonly requirement: {
131
- readonly kind: "all";
132
- readonly permissions: readonly ["steamLibrary"];
133
- };
134
- readonly risk: "high";
135
- }, {
136
- readonly method: "share.copyLink";
137
- readonly module: "share";
138
- readonly capability: "share.copyLink";
139
- readonly requirement: {
140
- readonly kind: "all";
141
- readonly permissions: readonly ["share"];
142
- };
143
- readonly risk: "medium";
144
- }, {
145
- readonly method: "share.showShareMenu";
146
- readonly module: "share";
147
- readonly capability: "share.showShareMenu";
148
- readonly requirement: {
149
- readonly kind: "all";
150
- readonly permissions: readonly ["share"];
151
- };
152
- readonly risk: "low";
153
- }, {
154
- readonly method: "share.screenshot";
155
- readonly module: "share";
156
- readonly capability: "share.screenshot";
157
- readonly requirement: {
158
- readonly kind: "all";
159
- readonly permissions: readonly ["share"];
160
- };
161
- readonly risk: "medium";
162
- }, {
163
- readonly method: "viewport.getWindowInfo";
164
- readonly module: "viewport";
165
- readonly capability: "viewport.getWindowInfo";
166
- readonly requirement: {
167
- readonly kind: "none";
168
- };
169
- readonly risk: "low";
170
- }, {
171
- readonly method: "viewport.setNavigationBarStyle";
172
- readonly module: "viewport";
173
- readonly capability: "viewport.setNavigationBarStyle";
174
- readonly requirement: {
175
- readonly kind: "none";
176
- };
177
- readonly risk: "low";
178
- }, {
179
- readonly method: "viewport.setDisplay";
180
- readonly module: "viewport";
181
- readonly capability: "viewport.setDisplay";
182
- readonly requirement: {
183
- readonly kind: "none";
184
- };
185
- readonly risk: "low";
186
- }, {
187
- readonly method: "storage.getStorage";
188
- readonly module: "storage";
189
- readonly capability: "storage.getStorage";
190
- readonly requirement: {
191
- readonly kind: "all";
192
- readonly permissions: readonly ["storage"];
193
- };
194
- readonly risk: "low";
195
- }, {
196
- readonly method: "storage.setStorage";
197
- readonly module: "storage";
198
- readonly capability: "storage.setStorage";
199
- readonly requirement: {
200
- readonly kind: "all";
201
- readonly permissions: readonly ["storage"];
202
- };
203
- readonly risk: "medium";
204
- }, {
205
- readonly method: "network.request";
206
- readonly module: "network";
207
- readonly capability: "network.request";
208
- readonly requirement: {
209
- readonly kind: "all";
210
- readonly permissions: readonly ["network"];
211
- };
212
- readonly risk: "high";
213
- }, {
214
- readonly method: "network.download";
215
- readonly module: "network";
216
- readonly capability: "network.download";
217
- readonly requirement: {
218
- readonly kind: "all";
219
- readonly permissions: readonly ["network", "filesystem"];
220
- };
221
- readonly risk: "high";
222
- }, {
223
- readonly method: "files.pickFiles";
224
- readonly module: "files";
225
- readonly capability: "files.pickFiles";
226
- readonly requirement: {
227
- readonly kind: "all";
228
- readonly permissions: readonly ["filesystem"];
229
- };
230
- readonly risk: "high";
231
- }, {
232
- readonly method: "files.pickDirectory";
233
- readonly module: "files";
234
- readonly capability: "files.pickDirectory";
235
- readonly requirement: {
236
- readonly kind: "all";
237
- readonly permissions: readonly ["filesystem"];
238
- };
239
- readonly risk: "high";
240
- }, {
241
- readonly method: "files.saveFile";
242
- readonly module: "files";
243
- readonly capability: "files.saveFile";
244
- readonly requirement: {
245
- readonly kind: "all";
246
- readonly permissions: readonly ["filesystem"];
247
- };
248
- readonly risk: "high";
249
- }, {
250
- readonly method: "file.create";
251
- readonly module: "file";
252
- readonly capability: "file.create";
253
- readonly requirement: {
254
- readonly kind: "all";
255
- readonly permissions: readonly ["filesystem"];
256
- };
257
- readonly risk: "high";
258
- }, {
259
- readonly method: "file.remove";
260
- readonly module: "file";
261
- readonly capability: "file.remove";
262
- readonly requirement: {
263
- readonly kind: "all";
264
- readonly permissions: readonly ["filesystem"];
265
- };
266
- readonly risk: "high";
267
- }, {
268
- readonly method: "file.exists";
269
- readonly module: "file";
270
- readonly capability: "file.exists";
271
- readonly requirement: {
272
- readonly kind: "all";
273
- readonly permissions: readonly ["filesystem"];
274
- };
275
- readonly risk: "high";
276
- }, {
277
- readonly method: "file.readText";
278
- readonly module: "file";
279
- readonly capability: "file.readText";
280
- readonly requirement: {
281
- readonly kind: "all";
282
- readonly permissions: readonly ["filesystem"];
283
- };
284
- readonly risk: "high";
285
- }, {
286
- readonly method: "file.writeText";
287
- readonly module: "file";
288
- readonly capability: "file.writeText";
289
- readonly requirement: {
290
- readonly kind: "all";
291
- readonly permissions: readonly ["filesystem"];
292
- };
293
- readonly risk: "high";
294
- }, {
295
- readonly method: "file.readBytes";
296
- readonly module: "file";
297
- readonly capability: "file.readBytes";
298
- readonly requirement: {
299
- readonly kind: "all";
300
- readonly permissions: readonly ["filesystem"];
301
- };
302
- readonly risk: "high";
303
- }, {
304
- readonly method: "file.writeBytes";
305
- readonly module: "file";
306
- readonly capability: "file.writeBytes";
307
- readonly requirement: {
308
- readonly kind: "all";
309
- readonly permissions: readonly ["filesystem"];
310
- };
311
- readonly risk: "high";
312
- }, {
313
- readonly method: "file.stat";
314
- readonly module: "file";
315
- readonly capability: "file.stat";
316
- readonly requirement: {
317
- readonly kind: "all";
318
- readonly permissions: readonly ["filesystem"];
319
- };
320
- readonly risk: "high";
321
- }, {
322
- readonly method: "directory.create";
323
- readonly module: "directory";
324
- readonly capability: "directory.create";
325
- readonly requirement: {
326
- readonly kind: "all";
327
- readonly permissions: readonly ["filesystem"];
328
- };
329
- readonly risk: "high";
330
- }, {
331
- readonly method: "directory.remove";
332
- readonly module: "directory";
333
- readonly capability: "directory.remove";
334
- readonly requirement: {
335
- readonly kind: "all";
336
- readonly permissions: readonly ["filesystem"];
337
- };
338
- readonly risk: "high";
339
- }, {
340
- readonly method: "directory.exists";
341
- readonly module: "directory";
342
- readonly capability: "directory.exists";
343
- readonly requirement: {
344
- readonly kind: "all";
345
- readonly permissions: readonly ["filesystem"];
346
- };
347
- readonly risk: "high";
348
- }, {
349
- readonly method: "directory.list";
350
- readonly module: "directory";
351
- readonly capability: "directory.list";
352
- readonly requirement: {
353
- readonly kind: "all";
354
- readonly permissions: readonly ["filesystem"];
355
- };
356
- readonly risk: "high";
357
- }, {
358
- readonly method: "ui.showToast";
359
- readonly module: "ui";
360
- readonly capability: "ui.showToast";
361
- readonly requirement: {
362
- readonly kind: "none";
363
- };
364
- readonly risk: "low";
365
- }, {
366
- readonly method: "ui.showLoading";
367
- readonly module: "ui";
368
- readonly capability: "ui.showLoading";
369
- readonly requirement: {
370
- readonly kind: "none";
371
- };
372
- readonly risk: "low";
373
- }, {
374
- readonly method: "ui.hideLoading";
375
- readonly module: "ui";
376
- readonly capability: "ui.hideLoading";
377
- readonly requirement: {
378
- readonly kind: "none";
379
- };
380
- readonly risk: "low";
381
- }, {
382
- readonly method: "device.vibrate";
383
- readonly module: "device";
384
- readonly capability: "device.vibrate";
385
- readonly requirement: {
386
- readonly kind: "none";
387
- };
388
- readonly risk: "low";
389
- }, {
390
- readonly method: "device.setClipboard";
391
- readonly module: "device";
392
- readonly capability: "device.setClipboard";
393
- readonly requirement: {
394
- readonly kind: "all";
395
- readonly permissions: readonly ["clipboard"];
396
- };
397
- readonly risk: "medium";
398
- }, {
399
- readonly method: "navigation.close";
400
- readonly module: "navigation";
401
- readonly capability: "navigation.close";
402
- readonly requirement: {
403
- readonly kind: "none";
404
- };
405
- readonly risk: "medium";
406
- }, {
407
- readonly method: "navigation.reload";
408
- readonly module: "navigation";
409
- readonly capability: "navigation.reload";
410
- readonly requirement: {
411
- readonly kind: "none";
412
- };
413
- readonly risk: "medium";
414
- }, {
415
- readonly method: "navigation.openAppPage";
416
- readonly module: "navigation";
417
- readonly capability: "navigation.openAppPage";
418
- readonly requirement: {
419
- readonly kind: "none";
420
- };
421
- readonly risk: "medium";
422
- }, {
423
- readonly method: "cloud.leaderboard.submit";
424
- readonly module: "cloud";
425
- readonly capability: "cloud.leaderboard.submit";
426
- readonly requirement: {
427
- readonly kind: "all";
428
- readonly permissions: readonly ["leaderboard"];
429
- };
430
- readonly risk: "medium";
431
- }, {
432
- readonly method: "cloud.leaderboard.getList";
433
- readonly module: "cloud";
434
- readonly capability: "cloud.leaderboard.getList";
435
- readonly requirement: {
436
- readonly kind: "all";
437
- readonly permissions: readonly ["leaderboard"];
438
- };
439
- readonly risk: "low";
440
- }, {
441
- readonly method: "cloud.leaderboard.getCurrentUserEntry";
442
- readonly module: "cloud";
443
- readonly capability: "cloud.leaderboard.getCurrentUserEntry";
444
- readonly requirement: {
445
- readonly kind: "all";
446
- readonly permissions: readonly ["leaderboard"];
447
- };
448
- readonly risk: "medium";
449
- }, {
450
- readonly method: "cloud.leaderboard.deleteCurrentUserEntry";
451
- readonly module: "cloud";
452
- readonly capability: "cloud.leaderboard.deleteCurrentUserEntry";
453
- readonly requirement: {
454
- readonly kind: "all";
455
- readonly permissions: readonly ["leaderboard"];
456
- };
457
- readonly risk: "medium";
458
- }, {
459
- readonly method: "cloud.leaderboard.getInfo";
460
- readonly module: "cloud";
461
- readonly capability: "cloud.leaderboard.getInfo";
462
- readonly requirement: {
463
- readonly kind: "all";
464
- readonly permissions: readonly ["leaderboard"];
465
- };
466
- readonly risk: "low";
467
- }, ...{
468
- method: "companion.getInfo" | "companion.getPreparationStatus" | "companion.prepare" | "companion.cancelPreparation" | "companion.getActiveSession" | "companion.launch" | "companion.session.write" | "companion.session.closeStdin" | "companion.session.terminate" | "companion.session.ackOutput" | "companion.openAttachment" | "companion.showNotification";
469
- module: "companion";
470
- capability: "companion.getInfo" | "companion.getPreparationStatus" | "companion.prepare" | "companion.cancelPreparation" | "companion.getActiveSession" | "companion.launch" | "companion.session.write" | "companion.session.closeStdin" | "companion.session.terminate" | "companion.session.ackOutput" | "companion.openAttachment" | "companion.showNotification";
471
- requirement: {
472
- kind: "all";
473
- permissions: "companion"[];
474
- };
475
- risk: "high";
476
- }[]];
477
- export interface MiniProgramCapabilityPayloadMap {
478
- [AUTH_LOGIN_METHOD]: LoginPayload;
479
- [USER_GET_INFO_METHOD]: GetUserInfoPayload;
480
- [USER_REVOKE_AUTHORIZATION_METHOD]: void;
481
- [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListPayload;
482
- [SHARE_COPY_LINK_METHOD]: CopyLinkPayload;
483
- [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuPayload;
484
- [SHARE_SCREENSHOT_METHOD]: ScreenshotPayload;
485
- [VIEWPORT_SET_DISPLAY_METHOD]: SetDisplayPayload;
486
- [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoPayload;
487
- [VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD]: SetNavigationBarStylePayload;
488
- [STORAGE_GET_STORAGE_METHOD]: GetStoragePayload;
489
- [STORAGE_SET_STORAGE_METHOD]: SetStoragePayload;
490
- [NETWORK_REQUEST_METHOD]: NetworkRequestPayload;
491
- [NETWORK_DOWNLOAD_METHOD]: NetworkDownloadPayload;
492
- [FILES_PICK_FILES_METHOD]: PickFilesPayload;
493
- [FILES_PICK_DIRECTORY_METHOD]: PickDirectoryPayload;
494
- [FILES_SAVE_FILE_METHOD]: SaveFilePayload;
495
- [FILE_CREATE_METHOD]: FileCreatePayload;
496
- [FILE_REMOVE_METHOD]: FileRemovePayload;
497
- [FILE_EXISTS_METHOD]: FileExistsPayload;
498
- [FILE_READ_TEXT_METHOD]: FileReadTextPayload;
499
- [FILE_WRITE_TEXT_METHOD]: FileWriteTextPayload;
500
- [FILE_READ_BYTES_METHOD]: FileReadBytesPayload;
501
- [FILE_WRITE_BYTES_METHOD]: FileWriteBytesPayload;
502
- [FILE_STAT_METHOD]: FileStatPayload;
503
- [DIRECTORY_CREATE_METHOD]: DirectoryCreatePayload;
504
- [DIRECTORY_REMOVE_METHOD]: DirectoryRemovePayload;
505
- [DIRECTORY_EXISTS_METHOD]: DirectoryExistsPayload;
506
- [DIRECTORY_LIST_METHOD]: DirectoryListPayload;
507
- [UI_SHOW_TOAST_METHOD]: ShowToastPayload;
508
- [UI_SHOW_LOADING_METHOD]: ShowLoadingPayload;
509
- [UI_HIDE_LOADING_METHOD]: HideLoadingPayload;
510
- [DEVICE_VIBRATE_METHOD]: VibratePayload;
511
- [DEVICE_SET_CLIPBOARD_METHOD]: SetClipboardPayload;
512
- [NAVIGATION_CLOSE_METHOD]: ClosePayload;
513
- [NAVIGATION_RELOAD_METHOD]: ReloadPayload;
514
- [NAVIGATION_OPEN_APP_PAGE_METHOD]: OpenAppPagePayload;
515
- [CLOUD_LEADERBOARD_SUBMIT_METHOD]: SubmitLeaderboardEntryPayload;
516
- [CLOUD_LEADERBOARD_GET_LIST_METHOD]: GetLeaderboardListPayload | undefined;
517
- [CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD]: GetCurrentUserLeaderboardEntryPayload | undefined;
518
- [CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD]: DeleteCurrentUserLeaderboardEntryPayload | undefined;
519
- [CLOUD_LEADERBOARD_GET_INFO_METHOD]: GetLeaderboardInfoPayload | undefined;
520
- [COMPANION_GET_INFO_METHOD]: CompanionGetInfoPayload;
521
- [COMPANION_GET_PREPARATION_STATUS_METHOD]: CompanionGetPreparationStatusPayload;
522
- [COMPANION_PREPARE_METHOD]: CompanionPreparePayload;
523
- [COMPANION_CANCEL_PREPARATION_METHOD]: CompanionCancelPreparationPayload;
524
- [COMPANION_GET_ACTIVE_SESSION_METHOD]: CompanionGetActiveSessionPayload;
525
- [COMPANION_LAUNCH_METHOD]: CompanionLaunchPayload;
526
- [COMPANION_SESSION_WRITE_METHOD]: CompanionSessionWritePayload;
527
- [COMPANION_SESSION_CLOSE_STDIN_METHOD]: CompanionSessionCloseStdinPayload;
528
- [COMPANION_SESSION_TERMINATE_METHOD]: CompanionSessionTerminatePayload;
529
- [COMPANION_SESSION_ACK_OUTPUT_METHOD]: CompanionSessionAckOutputPayload;
530
- [COMPANION_OPEN_ATTACHMENT_METHOD]: CompanionOpenAttachmentPayload;
531
- [COMPANION_SHOW_NOTIFICATION_METHOD]: CompanionShowNotificationPayload;
532
- }
533
- export interface MiniProgramCapabilityResultMap {
534
- [AUTH_LOGIN_METHOD]: LoginResult;
535
- [USER_GET_INFO_METHOD]: GetUserInfoResult;
536
- [USER_REVOKE_AUTHORIZATION_METHOD]: void;
537
- [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListResult;
538
- [SHARE_COPY_LINK_METHOD]: CopyLinkResult;
539
- [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuResult;
540
- [SHARE_SCREENSHOT_METHOD]: ScreenshotResult;
541
- [VIEWPORT_SET_DISPLAY_METHOD]: SetDisplayResult;
542
- [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoResult;
543
- [VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD]: SetNavigationBarStyleResult;
544
- [STORAGE_GET_STORAGE_METHOD]: GetStorageResult;
545
- [STORAGE_SET_STORAGE_METHOD]: void;
546
- [NETWORK_REQUEST_METHOD]: NetworkResponsePayload;
547
- [NETWORK_DOWNLOAD_METHOD]: NetworkDownloadResult;
548
- [FILES_PICK_FILES_METHOD]: PickFilesResult;
549
- [FILES_PICK_DIRECTORY_METHOD]: PickDirectoryResult;
550
- [FILES_SAVE_FILE_METHOD]: SaveFileResult;
551
- [FILE_CREATE_METHOD]: FileCreateResult;
552
- [FILE_REMOVE_METHOD]: FileRemoveResult;
553
- [FILE_EXISTS_METHOD]: FileExistsResult;
554
- [FILE_READ_TEXT_METHOD]: FileReadTextResult;
555
- [FILE_WRITE_TEXT_METHOD]: FileWriteTextResult;
556
- [FILE_READ_BYTES_METHOD]: FileReadBytesResult;
557
- [FILE_WRITE_BYTES_METHOD]: FileWriteBytesResult;
558
- [FILE_STAT_METHOD]: FileStatResult;
559
- [DIRECTORY_CREATE_METHOD]: DirectoryCreateResult;
560
- [DIRECTORY_REMOVE_METHOD]: DirectoryRemoveResult;
561
- [DIRECTORY_EXISTS_METHOD]: DirectoryExistsResult;
562
- [DIRECTORY_LIST_METHOD]: DirectoryListResult;
563
- [UI_SHOW_TOAST_METHOD]: ShowToastResult;
564
- [UI_SHOW_LOADING_METHOD]: ShowLoadingResult;
565
- [UI_HIDE_LOADING_METHOD]: HideLoadingResult;
566
- [DEVICE_VIBRATE_METHOD]: VibrateResult;
567
- [DEVICE_SET_CLIPBOARD_METHOD]: SetClipboardResult;
568
- [NAVIGATION_CLOSE_METHOD]: CloseResult;
569
- [NAVIGATION_RELOAD_METHOD]: ReloadResult;
570
- [NAVIGATION_OPEN_APP_PAGE_METHOD]: OpenAppPageResult;
571
- [CLOUD_LEADERBOARD_SUBMIT_METHOD]: SubmitLeaderboardEntryResult;
572
- [CLOUD_LEADERBOARD_GET_LIST_METHOD]: GetLeaderboardListResult;
573
- [CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD]: GetCurrentUserLeaderboardEntryResult;
574
- [CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD]: DeleteCurrentUserLeaderboardEntryResult;
575
- [CLOUD_LEADERBOARD_GET_INFO_METHOD]: GetLeaderboardInfoResult;
576
- [COMPANION_GET_INFO_METHOD]: CompanionGetInfoResult;
577
- [COMPANION_GET_PREPARATION_STATUS_METHOD]: CompanionGetPreparationStatusResult;
578
- [COMPANION_PREPARE_METHOD]: CompanionPrepareResult;
579
- [COMPANION_CANCEL_PREPARATION_METHOD]: CompanionCancelPreparationResult;
580
- [COMPANION_GET_ACTIVE_SESSION_METHOD]: CompanionGetActiveSessionResult;
581
- [COMPANION_LAUNCH_METHOD]: CompanionLaunchResult;
582
- [COMPANION_SESSION_WRITE_METHOD]: CompanionSessionWriteResult;
583
- [COMPANION_SESSION_CLOSE_STDIN_METHOD]: CompanionSessionCloseStdinResult;
584
- [COMPANION_SESSION_TERMINATE_METHOD]: CompanionSessionTerminateResult;
585
- [COMPANION_SESSION_ACK_OUTPUT_METHOD]: CompanionSessionAckOutputResult;
586
- [COMPANION_OPEN_ATTACHMENT_METHOD]: CompanionOpenAttachmentResult;
587
- [COMPANION_SHOW_NOTIFICATION_METHOD]: CompanionShowNotificationResult;
588
- }
589
- export interface MiniProgramCapabilityProgressMap {
590
- [NETWORK_DOWNLOAD_METHOD]: DownloadProgressPayload;
591
- [COMPANION_PREPARE_METHOD]: CompanionPrepareProgress;
592
- }
593
- export type MiniProgramProgressMethod = keyof MiniProgramCapabilityProgressMap;
594
- export type MiniProgramCapabilityProgress<T extends MiniProgramProgressMethod> = MiniProgramCapabilityProgressMap[T];
595
- export type MiniProgramCapabilityPayload<T extends MiniProgramBridgeMethod> = MiniProgramCapabilityPayloadMap[T];
596
- export type MiniProgramCapabilityResult<T extends MiniProgramBridgeMethod> = MiniProgramCapabilityResultMap[T];
@@ -1,33 +0,0 @@
1
- /**
2
- * 所有小程序 iframe bridge envelope 共用的固定 namespace。
3
- *
4
- * @remarks 该值用于排除无关 `postMessage` 数据,不负责验证消息来源;接收方仍须校验 source 和 nonce,
5
- * 并在 origin 可以固定且协议模式要求时校验 origin。
6
- */
7
- export declare const MINI_PROGRAM_MESSAGE_NAMESPACE: "heybox:miniprogram";
8
- /**
9
- * 新消息默认发送的当前 bridge wire 版本。
10
- *
11
- * @remarks 接收 guard 为握手协商继续接受 v1 与 v2 envelope;cancel 与 operation progress 等 v2-only 消息仍必须使用 v2。
12
- */
13
- export declare const MINI_PROGRAM_MESSAGE_VERSION: 2;
14
- /**
15
- * Runtime 在 iframe URL 中传递 bridge nonce 的 query 参数名。
16
- *
17
- * @remarks nonce 用于把消息关联到当前 iframe 实例,不是独立的身份认证凭据;接收方还必须校验 source,
18
- * 并在 origin 可以固定且协议模式要求时校验 origin。
19
- */
20
- export declare const MINI_PROGRAM_BRIDGE_NONCE_PARAM: "hb_mini_bridge_nonce";
21
- /**
22
- * SDK 发起 bridge 握手时使用的保留 method。
23
- *
24
- * @remarks `type: 'handshake'` 的消息必须使用该 method;Runtime 的可选握手响应也可携带该 method 供 SDK 识别环境快照。
25
- */
26
- export declare const SDK_HANDSHAKE_METHOD: "sdk.handshake";
27
- export declare const RUNTIME_LOCATION_PROBE_METHOD: "runtime.location.probe";
28
- export declare const SDK_LOCATION_REPORT_METHOD: "sdk.location.report";
29
- export declare const SDK_CSP_VIOLATION_METHOD: "sdk.csp.violation";
30
- export declare const MINI_PROGRAM_OPERATION_PROGRESS_METHOD: "operation.progress";
31
- export declare const COMPANION_SESSION_OUTPUT_EVENT: "companion.session.output";
32
- export declare const COMPANION_SESSION_EXIT_EVENT: "companion.session.exit";
33
- export declare const COMPANION_SESSION_OWNERSHIP_LOST_EVENT: "companion.session.ownershipLost";