@heybox/hb-sdk 0.1.3 → 0.2.0-alpha.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.
Files changed (67) hide show
  1. package/README.md +149 -345
  2. package/bin/hb-sdk.cjs +3 -0
  3. package/dist/cli.cjs +10117 -0
  4. package/dist/devtools/mock-host/index.html +252 -0
  5. package/dist/devtools/mock-host/main.js +975 -0
  6. package/dist/index.cjs.js +474 -85
  7. package/dist/index.esm.js +465 -71
  8. package/dist/protocol.cjs.js +163 -0
  9. package/dist/protocol.esm.js +148 -0
  10. package/dist/templates/vue3-vite-ts/.gitignore.ejs +5 -0
  11. package/dist/templates/vue3-vite-ts/README.md.ejs +42 -0
  12. package/dist/templates/vue3-vite-ts/index.html.ejs +12 -0
  13. package/dist/templates/vue3-vite-ts/package.json.ejs +28 -0
  14. package/dist/templates/vue3-vite-ts/src/App.vue +63 -0
  15. package/dist/templates/vue3-vite-ts/src/__tests__/App.spec.ts +67 -0
  16. package/dist/templates/vue3-vite-ts/src/main.ts +5 -0
  17. package/dist/templates/vue3-vite-ts/src/styles.css +60 -0
  18. package/dist/templates/vue3-vite-ts/src/vite-env.d.ts +1 -0
  19. package/dist/templates/vue3-vite-ts/tsconfig.app.json +17 -0
  20. package/dist/templates/vue3-vite-ts/tsconfig.json +11 -0
  21. package/dist/templates/vue3-vite-ts/tsconfig.node.json +11 -0
  22. package/dist/templates/vue3-vite-ts/vite.config.ts +6 -0
  23. package/dist/templates/vue3-vite-ts/vitest.config.ts +10 -0
  24. package/package.json +30 -5
  25. package/skill/SKILL.md +95 -0
  26. package/skill/references/api-protocol.md +135 -0
  27. package/skill/references/api-root.md +346 -0
  28. package/skill/references/cli.md +360 -0
  29. package/skill/references/examples.md +107 -0
  30. package/skill/references/llms-index.md +44 -0
  31. package/skill/references/recipes.md +374 -0
  32. package/skill/references/safety-boundaries.md +28 -0
  33. package/skill/references/smoke-evaluation.md +24 -0
  34. package/skill/scripts/check-references.mjs +14 -0
  35. package/skill/scripts/package-skill.mjs +60 -0
  36. package/skill/scripts/package-skill.sh +6 -0
  37. package/skill/scripts/skill-metadata.mjs +74 -0
  38. package/skill/scripts/sync-references.mjs +541 -0
  39. package/skill/scripts/validate-skill.mjs +233 -0
  40. package/skill/skill.json +11 -0
  41. package/types/core/client.d.ts +23 -3
  42. package/types/core/errors.d.ts +45 -2
  43. package/types/core/sdk.d.ts +78 -10
  44. package/types/core/singleton.d.ts +33 -7
  45. package/types/core/utils.d.ts +2 -0
  46. package/types/index.d.ts +14 -6
  47. package/types/modules/auth/index.d.ts +35 -0
  48. package/types/modules/network/index.d.ts +120 -0
  49. package/types/modules/share/index.d.ts +9 -5
  50. package/types/modules/share/screenshot.d.ts +9 -3
  51. package/types/modules/share/show-share-menu.d.ts +9 -3
  52. package/types/modules/share/types.d.ts +24 -4
  53. package/types/modules/storage/index.d.ts +56 -0
  54. package/types/modules/user/get-info.d.ts +6 -2
  55. package/types/modules/user/index.d.ts +8 -10
  56. package/types/modules/user/types.d.ts +1 -0
  57. package/types/modules/viewport/index.d.ts +71 -0
  58. package/types/protocol/capabilities.d.ts +180 -0
  59. package/types/protocol/guards.d.ts +6 -1
  60. package/types/protocol/types.d.ts +19 -4
  61. package/types/protocol.d.ts +13 -0
  62. package/types/modules/system/get-storage.d.ts +0 -15
  63. package/types/modules/system/get-window-info.d.ts +0 -16
  64. package/types/modules/system/index.d.ts +0 -23
  65. package/types/modules/system/set-storage.d.ts +0 -12
  66. package/types/modules/system/types.d.ts +0 -34
  67. package/types/modules/user/login.d.ts +0 -18
package/dist/index.esm.js CHANGED
@@ -1,4 +1,11 @@
1
- /** SDK 对外抛出的标准错误类型。 */
1
+ /**
2
+ * SDK 对外抛出的标准 bridge / runtime 错误类型。
3
+ *
4
+ * @remarks
5
+ * 该错误用于表示握手失败、bridge 调用失败、父容器运行时错误等
6
+ * 非 HTTP 结果错误。其 `code` 字段可用于业务分支处理,
7
+ * `data` 仅作为可选调试信息,不保证结构稳定。
8
+ */
2
9
  class HbMiniProgramSDKError extends Error {
3
10
  /** 稳定错误码。 */
4
11
  code;
@@ -11,7 +18,17 @@ class HbMiniProgramSDKError extends Error {
11
18
  this.data = error.data;
12
19
  }
13
20
  }
14
- /** 创建 SDK 标准错误。 */
21
+ /**
22
+ * 创建 SDK 标准错误。
23
+ *
24
+ * @param code 稳定错误码。
25
+ * @param message 面向开发者的错误说明。
26
+ * @param data 可选调试数据。
27
+ * @returns 标准化 `HbMiniProgramSDKError` 实例。
28
+ *
29
+ * @remarks
30
+ * 仅供 SDK 内部或同仓运行时层统一构造 bridge / runtime 错误。
31
+ */
15
32
  function createSDKError(code, message, data) {
16
33
  return new HbMiniProgramSDKError({
17
34
  code,
@@ -19,6 +36,39 @@ function createSDKError(code, message, data) {
19
36
  data,
20
37
  });
21
38
  }
39
+ /**
40
+ * SDK 对外抛出的 HTTP 错误类型。
41
+ *
42
+ * @remarks
43
+ * 仅在请求已经成功走完 bridge / runtime / 宿主调用链、但最终 HTTP 状态不满足
44
+ * `validateStatus` 时抛出。它不表示握手失败或 bridge 级错误。
45
+ *
46
+ * @typeParam T 标准化响应数据的类型。
47
+ */
48
+ class HbMiniProgramNetworkError extends Error {
49
+ /** HTTP 状态码。 */
50
+ status;
51
+ /** 标准化响应数据。 */
52
+ data;
53
+ /** 标准化响应头。 */
54
+ headers;
55
+ /** SDK 公共请求配置快照。 */
56
+ config;
57
+ /** 完整标准化响应。 */
58
+ response;
59
+ /**
60
+ * @param response 已完成请求的标准化网络响应。
61
+ */
62
+ constructor(response) {
63
+ super(`network.request failed with status ${response.status}`);
64
+ this.name = 'HbMiniProgramNetworkError';
65
+ this.status = response.status;
66
+ this.data = response.data;
67
+ this.headers = response.headers;
68
+ this.config = response.config;
69
+ this.response = response;
70
+ }
71
+ }
22
72
 
23
73
  /** SDK 内部事件总线,负责管理沙盒生命周期与业务事件监听。 */
24
74
  class MiniProgramEventBus {
@@ -73,6 +123,31 @@ function getParentWindow(currentWindow) {
73
123
  }
74
124
  return currentWindow.parent;
75
125
  }
126
+ /** 尝试读取父窗口 origin;跨域读取失败时回退到 document.referrer。 */
127
+ function readParentOrigin(currentWindow) {
128
+ const parentWindow = getParentWindow(currentWindow);
129
+ if (parentWindow) {
130
+ try {
131
+ const origin = parentWindow.location?.origin;
132
+ if (origin && origin !== 'null') {
133
+ return origin;
134
+ }
135
+ }
136
+ catch {
137
+ // ignore cross-origin parent access and fall back to referrer
138
+ }
139
+ }
140
+ const referrer = currentWindow?.document?.referrer;
141
+ if (!referrer) {
142
+ return '';
143
+ }
144
+ try {
145
+ return new URL(referrer).origin;
146
+ }
147
+ catch {
148
+ return '';
149
+ }
150
+ }
76
151
  /** 从父容器注入到 URL 的 query 中读取 bridge nonce。 */
77
152
  function readBridgeNonce(currentWindow) {
78
153
  const href = currentWindow?.location?.href;
@@ -95,7 +170,12 @@ function createMessageId() {
95
170
  return `${Date.now().toString(36)}_${Math.random().toString(36).slice(2)}`;
96
171
  }
97
172
 
98
- /** 判断未知数据是否符合小程序 bridge 消息信封。 */
173
+ /**
174
+ * 判断未知数据是否符合小程序 bridge 消息信封。
175
+ *
176
+ * @param value 待判断的未知数据。
177
+ * @returns 当数据满足小程序 bridge 消息基础结构时返回 `true`。
178
+ */
99
179
  function isMiniProgramBridgeMessage(value) {
100
180
  if (!value || typeof value !== 'object') {
101
181
  return false;
@@ -114,6 +194,7 @@ class MiniProgramBridgeClient {
114
194
  timeout;
115
195
  selfWindow;
116
196
  targetWindow;
197
+ targetOrigin;
117
198
  nonce;
118
199
  pendingRequests = new Map();
119
200
  eventBus = new MiniProgramEventBus();
@@ -131,6 +212,7 @@ class MiniProgramBridgeClient {
131
212
  this.selfWindow = options.selfWindow || getGlobalWindow();
132
213
  this.targetWindow =
133
214
  options.targetWindow === undefined ? getParentWindow(this.selfWindow) : options.targetWindow;
215
+ this.targetOrigin = options.targetOrigin || readParentOrigin(this.selfWindow) || '*';
134
216
  this.nonce = options.nonce || readBridgeNonce(this.selfWindow);
135
217
  this.handleMessage = this.onMessage.bind(this);
136
218
  this.readyPromise = new Promise((resolve, reject) => {
@@ -286,7 +368,7 @@ class MiniProgramBridgeClient {
286
368
  if (!this.targetWindow) {
287
369
  throw createSDKError('NOT_IN_IFRAME', '当前页面不在小程序沙盒 iframe 中');
288
370
  }
289
- this.targetWindow.postMessage(message, '*');
371
+ this.targetWindow.postMessage(message, this.targetOrigin);
290
372
  }
291
373
  resolveReadyOnce() {
292
374
  if (this.readySettled) {
@@ -315,7 +397,7 @@ class MiniProgramBridgeClient {
315
397
  }
316
398
  }
317
399
  rejectAllPending(error) {
318
- this.pendingRequests.forEach((pending) => {
400
+ this.pendingRequests.forEach(pending => {
319
401
  clearTimeout(pending.timer);
320
402
  pending.reject(error);
321
403
  });
@@ -323,21 +405,118 @@ class MiniProgramBridgeClient {
323
405
  }
324
406
  }
325
407
 
326
- /** 截图分享能力方法名。 */
408
+ /**
409
+ * 登录授权能力方法名。
410
+ *
411
+ * @remarks
412
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
413
+ */
414
+ const AUTH_LOGIN_METHOD = 'auth.login';
415
+ /**
416
+ * 用户信息能力方法名。
417
+ *
418
+ * @remarks
419
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
420
+ */
421
+ const USER_GET_INFO_METHOD = 'user.getInfo';
422
+ /**
423
+ * 展示分享面板能力方法名。
424
+ *
425
+ * @remarks
426
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
427
+ */
428
+ const SHARE_SHOW_SHARE_MENU_METHOD = 'share.showShareMenu';
429
+ /**
430
+ * 截图分享能力方法名。
431
+ *
432
+ * @remarks
433
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
434
+ */
327
435
  const SHARE_SCREENSHOT_METHOD = 'share.screenshot';
328
- /** 截图并唤起分享。 */
436
+ /**
437
+ * 视口窗口信息能力方法名。
438
+ *
439
+ * @remarks
440
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
441
+ */
442
+ const VIEWPORT_GET_WINDOW_INFO_METHOD = 'viewport.getWindowInfo';
443
+ /**
444
+ * 读取小程序隔离 storage 能力方法名。
445
+ *
446
+ * @remarks
447
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
448
+ */
449
+ const STORAGE_GET_STORAGE_METHOD = 'storage.getStorage';
450
+ /**
451
+ * 写入小程序隔离 storage 能力方法名。
452
+ *
453
+ * @remarks
454
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
455
+ */
456
+ const STORAGE_SET_STORAGE_METHOD = 'storage.setStorage';
457
+ /**
458
+ * 发起网络请求能力方法名。
459
+ *
460
+ * @remarks
461
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
462
+ */
463
+ const NETWORK_REQUEST_METHOD = 'network.request';
464
+
465
+ /**
466
+ * 唤起登录授权,并在流程返回后刷新用户公开基础资料。
467
+ *
468
+ * @param requester 底层 bridge 请求能力。
469
+ * @returns 登录流程完成后的最新用户登录态与公开资料。
470
+ * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主运行时调用失败时抛出。
471
+ *
472
+ * @remarks
473
+ * 该能力不会向小程序暴露 token、cookie 或其他登录凭据。
474
+ */
475
+ function login(requester) {
476
+ return requester.request(AUTH_LOGIN_METHOD);
477
+ }
478
+ /**
479
+ * 创建授权模块。
480
+ *
481
+ * @param requester 底层 bridge 请求能力。
482
+ * @returns 面向业务层的授权模块对象。
483
+ */
484
+ function createAuthModule(requester) {
485
+ return {
486
+ login: () => login(requester),
487
+ };
488
+ }
489
+
490
+ /**
491
+ * 截图并唤起分享。
492
+ *
493
+ * @param requester 底层 bridge 请求能力。
494
+ * @param options 截图区域、延迟与保存相册等配置。
495
+ * @returns 由宿主客户端协议决定的结果。
496
+ * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
497
+ */
329
498
  function screenshot(requester, options) {
330
499
  return requester.request(SHARE_SCREENSHOT_METHOD, options);
331
500
  }
332
501
 
333
- /** 展示分享面板能力方法名。 */
334
- const SHARE_SHOW_SHARE_MENU_METHOD = 'share.showShareMenu';
335
- /** 展示基础分享面板。 */
502
+ /**
503
+ * 展示基础分享面板。
504
+ *
505
+ * @param requester 底层 bridge 请求能力。
506
+ * @param options 基础分享参数。
507
+ * @returns 由宿主客户端协议决定的结果。
508
+ * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
509
+ */
336
510
  function showShareMenu(requester, options) {
337
511
  return requester.request(SHARE_SHOW_SHARE_MENU_METHOD, options);
338
512
  }
339
513
 
340
- /** 创建分享模块。 */
514
+ /**
515
+ * 创建分享模块。
516
+ *
517
+ * @param requester 底层 bridge 请求能力。
518
+ * @returns 面向业务层的分享模块对象。
519
+ */
341
520
  function createShareModule(requester) {
342
521
  return {
343
522
  showShareMenu: options => showShareMenu(requester, options),
@@ -345,102 +524,287 @@ function createShareModule(requester) {
345
524
  };
346
525
  }
347
526
 
348
- /** 用户信息能力方法名。 */
349
- const USER_GET_INFO_METHOD = 'user.getInfo';
350
527
  /**
351
- * 获取当前访问小程序用户的公开基础资料。
528
+ * 获取小程序隔离 storage。
352
529
  *
353
- * 该能力只返回 `heybox_id`、`nickname`、`avatar` 三个公开字段。
354
- * 未登录时不会触发登录流程,直接返回 `{ isLogin: false, userInfo: null }`。
530
+ * @param requester 底层 bridge 请求能力。
531
+ * @param options 读取的 storage key。
532
+ * @returns 对应 key 的标准化读取结果。
533
+ * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
355
534
  */
356
- function getInfo(requester) {
357
- return requester.request(USER_GET_INFO_METHOD);
535
+ function getStorage(requester, options) {
536
+ return requester.request(STORAGE_GET_STORAGE_METHOD, options);
358
537
  }
359
-
360
- /** 用户登录能力方法名。 */
361
- const USER_LOGIN_METHOD = 'user.login';
362
538
  /**
363
- * 唤起黑盒登录流程,并在流程返回后刷新用户公开基础资料。
539
+ * 写入小程序隔离 storage。
364
540
  *
365
- * 该能力不会向小程序暴露 token、cookie 或任何登录凭据。
541
+ * @param requester 底层 bridge 请求能力。
542
+ * @param options 要写入的 storage key 与数据。
543
+ * @returns 当写入完成后 resolve。
544
+ * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
366
545
  */
367
- function login(requester) {
368
- return requester.request(USER_LOGIN_METHOD);
546
+ function setStorage(requester, options) {
547
+ return requester.request(STORAGE_SET_STORAGE_METHOD, options);
548
+ }
549
+ /**
550
+ * 创建 storage 模块。
551
+ *
552
+ * @param requester 底层 bridge 请求能力。
553
+ * @returns 面向业务层的 storage 模块对象。
554
+ */
555
+ function createStorageModule(requester) {
556
+ return {
557
+ getStorage: options => getStorage(requester, options),
558
+ setStorage: options => setStorage(requester, options),
559
+ };
369
560
  }
370
561
 
371
- /** 创建用户模块。 */
372
- function createUserModule(requester) {
562
+ const DEFAULT_VALIDATE_STATUS = status => status >= 200 && status < 300;
563
+ function isPlainObject(value) {
564
+ return Object.prototype.toString.call(value) === '[object Object]';
565
+ }
566
+ function clonePublicValue(value) {
567
+ if (Array.isArray(value)) {
568
+ return value.map(item => clonePublicValue(item));
569
+ }
570
+ if (isPlainObject(value)) {
571
+ return Object.fromEntries(Object.entries(value).map(([key, item]) => [key, clonePublicValue(item)]));
572
+ }
573
+ return value;
574
+ }
575
+ function snapshotRequestConfig(config) {
373
576
  return {
374
- getInfo: () => getInfo(requester),
375
- login: () => login(requester),
577
+ url: config.url,
578
+ ...(config.method === undefined ? {} : { method: config.method }),
579
+ ...(config.params === undefined ? {} : { params: clonePublicValue(config.params) }),
580
+ ...(config.data === undefined ? {} : { data: clonePublicValue(config.data) }),
581
+ ...(config.headers === undefined ? {} : { headers: clonePublicValue(config.headers) }),
582
+ ...(config.timeout === undefined ? {} : { timeout: config.timeout }),
583
+ ...(config.withCredentials === undefined ? {} : { withCredentials: config.withCredentials }),
584
+ ...(config.validateStatus === undefined ? {} : { validateStatus: config.validateStatus }),
585
+ };
586
+ }
587
+ function toRequestPayload(config) {
588
+ return {
589
+ url: config.url,
590
+ ...(config.method === undefined ? {} : { method: config.method }),
591
+ ...(config.params === undefined ? {} : { params: clonePublicValue(config.params) }),
592
+ ...(config.data === undefined ? {} : { data: clonePublicValue(config.data) }),
593
+ ...(config.headers === undefined ? {} : { headers: clonePublicValue(config.headers) }),
594
+ ...(config.timeout === undefined ? {} : { timeout: config.timeout }),
595
+ ...(config.withCredentials === undefined ? {} : { withCredentials: config.withCredentials }),
596
+ };
597
+ }
598
+ function normalizeHeaders(headers) {
599
+ if (!isPlainObject(headers)) {
600
+ return {};
601
+ }
602
+ return Object.fromEntries(Object.entries(headers).flatMap(([key, value]) => (typeof value === 'string' ? [[key, value]] : [])));
603
+ }
604
+ function toNetworkResponse(payload, config) {
605
+ if (typeof payload.status !== 'number' || Number.isNaN(payload.status)) {
606
+ throw createSDKError('INVALID_NETWORK_RESPONSE', 'network.request 返回了无效的 status', payload);
607
+ }
608
+ return {
609
+ data: payload.data,
610
+ status: payload.status,
611
+ ...(typeof payload.statusText === 'string' ? { statusText: payload.statusText } : {}),
612
+ headers: normalizeHeaders(payload.headers),
613
+ config: snapshotRequestConfig(config),
614
+ };
615
+ }
616
+ /**
617
+ * 发起网络请求并返回标准化响应。
618
+ *
619
+ * @param requester 底层 bridge 请求能力。
620
+ * @param config 面向业务层的网络请求配置。
621
+ * @returns 标准化网络响应。HTTP 2xx 默认返回 resolve。
622
+ * @throws {HbMiniProgramNetworkError} 当请求已完成但 HTTP 状态不满足 `validateStatus` 时抛出。
623
+ * @throws {HbMiniProgramSDKError} 当 bridge、运行时或宿主能力调用失败时抛出。
624
+ *
625
+ * @remarks
626
+ * `validateStatus` 仅在 SDK 侧执行,不会跨 bridge 传输函数值。
627
+ * 公开配置与返回结构都保持 axios-like 的窄接口,不暴露宿主原始协议字段。
628
+ *
629
+ * @example
630
+ * ```ts
631
+ * const result = await request(requester, {
632
+ * url: 'https://api.xiaoheihe.cn/demo',
633
+ * method: 'GET',
634
+ * })
635
+ * ```
636
+ */
637
+ async function request(requester, config) {
638
+ const validateStatus = config.validateStatus || DEFAULT_VALIDATE_STATUS;
639
+ const responsePayload = await requester.request(NETWORK_REQUEST_METHOD, toRequestPayload(config));
640
+ const response = toNetworkResponse(responsePayload, config);
641
+ if (!validateStatus(response.status)) {
642
+ throw new HbMiniProgramNetworkError(response);
643
+ }
644
+ return response;
645
+ }
646
+ /**
647
+ * 创建 network 模块。
648
+ *
649
+ * @param requester 底层 bridge 请求能力。
650
+ * @returns 面向业务层的网络模块对象。
651
+ */
652
+ function createNetworkModule(requester) {
653
+ return {
654
+ request: config => request(requester, config),
376
655
  };
377
656
  }
378
657
 
379
- /** 系统窗口信息能力方法名。 */
380
- const SYSTEM_GET_WINDOW_INFO_METHOD = 'system.getWindowInfo';
381
658
  /**
382
659
  * 获取当前小程序窗口信息。
660
+ *
661
+ * @param requester 底层 bridge 请求能力。
662
+ * @returns 当前小程序可用窗口信息。
663
+ * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
383
664
  */
384
665
  function getWindowInfo(requester) {
385
- return requester.request(SYSTEM_GET_WINDOW_INFO_METHOD);
666
+ return requester.request(VIEWPORT_GET_WINDOW_INFO_METHOD);
386
667
  }
387
-
388
- /** 获取小程序隔离 storage 能力方法名。 */
389
- const SYSTEM_GET_STORAGE_METHOD = 'system.getStorage';
390
- /** 获取小程序隔离 storage。 */
391
- function getStorage(requester, options) {
392
- return requester.request(SYSTEM_GET_STORAGE_METHOD, options);
668
+ /**
669
+ * 创建 Viewport 模块。
670
+ *
671
+ * @param requester 底层 bridge 请求能力。
672
+ * @returns 面向业务层的 Viewport 模块对象。
673
+ */
674
+ function createViewportModule(requester) {
675
+ return {
676
+ getWindowInfo: () => getWindowInfo(requester),
677
+ };
393
678
  }
394
679
 
395
- /** 写入小程序隔离 storage 能力方法名。 */
396
- const SYSTEM_SET_STORAGE_METHOD = 'system.setStorage';
397
- /** 写入小程序隔离 storage。 */
398
- function setStorage(requester, options) {
399
- return requester.request(SYSTEM_SET_STORAGE_METHOD, options);
680
+ /**
681
+ * 获取当前访问小程序用户的公开基础资料。
682
+ *
683
+ * @param requester 底层 bridge 请求能力。
684
+ * @returns 当前用户的登录态与公开基础资料。
685
+ *
686
+ * 该能力只返回 `heybox_id`、`nickname`、`avatar` 三个公开字段。
687
+ * 未登录时不会触发登录流程,直接返回 `{ isLogin: false, userInfo: null }`。
688
+ *
689
+ * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主运行时调用失败时抛出。
690
+ */
691
+ function getInfo(requester) {
692
+ return requester.request(USER_GET_INFO_METHOD);
400
693
  }
401
694
 
402
- /** 创建系统模块。 */
403
- function createSystemModule(requester) {
695
+ /**
696
+ * 创建用户模块。
697
+ *
698
+ * @param requester 底层 bridge 请求能力。
699
+ * @returns 面向业务层的用户模块对象。
700
+ */
701
+ function createUserModule(requester) {
404
702
  return {
405
- getWindowInfo: () => getWindowInfo(requester),
406
- getStorage: options => getStorage(requester, options),
407
- setStorage: options => setStorage(requester, options),
703
+ getInfo: () => getInfo(requester),
408
704
  };
409
705
  }
410
706
 
411
- /** 外部小程序 SDK 实例。 */
707
+ /**
708
+ * 外部小程序 SDK 实例。
709
+ *
710
+ * @remarks
711
+ * 该实例负责组织授权、用户、分享、容器、存储与网络等开放能力,并维护
712
+ * iframe 内小程序与父容器之间的 bridge 生命周期。
713
+ *
714
+ * 多数业务页直接使用默认单例即可;只有在测试、多实例或需要定制运行参数时,
715
+ * 才建议显式创建独立实例。
716
+ *
717
+ * @example
718
+ * ```ts
719
+ * import { createMiniProgramSDK } from '@heybox/hb-sdk'
720
+ *
721
+ * const sdk = createMiniProgramSDK({
722
+ * timeout: 15000,
723
+ * })
724
+ *
725
+ * await sdk.ready()
726
+ * ```
727
+ */
412
728
  class MiniProgramSDK {
413
729
  client;
414
- /** 用户相关开放能力。 */
730
+ /** 授权相关开放能力。 */
731
+ auth;
732
+ /** 用户资料相关开放能力。 */
415
733
  user;
416
734
  /** 分享相关开放能力。 */
417
735
  share;
418
- /** 系统相关开放能力。 */
419
- system;
736
+ /** 视口相关开放能力。 */
737
+ viewport;
738
+ /** Storage 相关开放能力。 */
739
+ storage;
740
+ /** 网络请求相关开放能力。 */
741
+ network;
420
742
  constructor(options) {
421
743
  this.client = new MiniProgramBridgeClient(options);
744
+ this.auth = createAuthModule(this.client);
422
745
  this.user = createUserModule(this.client);
423
746
  this.share = createShareModule(this.client);
424
- this.system = createSystemModule(this.client);
425
- }
426
- /** 等待 SDK 与父容器完成握手。 */
747
+ this.viewport = createViewportModule(this.client);
748
+ this.storage = createStorageModule(this.client);
749
+ this.network = createNetworkModule(this.client);
750
+ }
751
+ /**
752
+ * 等待 SDK 与父容器完成握手。
753
+ *
754
+ * @returns 当 bridge 握手成功后 resolve。
755
+ * @throws {HbMiniProgramSDKError} 当当前页面不在 iframe 中、缺少 nonce 或握手超时时抛出。
756
+ */
427
757
  ready() {
428
758
  return this.client.ready();
429
759
  }
430
- /** 注册小程序生命周期或业务事件。 */
760
+ /**
761
+ * 注册小程序生命周期或业务事件。
762
+ *
763
+ * @param eventName 要监听的事件名。
764
+ * @param handler 事件处理函数。
765
+ * @returns 事件解绑函数。
766
+ */
431
767
  on(eventName, handler) {
432
768
  return this.client.on(eventName, handler);
433
769
  }
434
- /** 移除小程序生命周期或业务事件。 */
770
+ /**
771
+ * 移除小程序生命周期或业务事件。
772
+ *
773
+ * @param eventName 要移除的事件名。
774
+ * @param handler 对应的事件处理函数。
775
+ */
435
776
  off(eventName, handler) {
436
777
  this.client.off(eventName, handler);
437
778
  }
438
- /** 销毁 SDK 实例。 */
779
+ /**
780
+ * 销毁 SDK 实例。
781
+ *
782
+ * @remarks
783
+ * 销毁后会移除 message 监听,并拒绝尚未完成的 bridge 请求。
784
+ * 已销毁实例不应继续复用。
785
+ */
439
786
  destroy() {
440
787
  this.client.destroy();
441
788
  }
442
789
  }
443
- /** 创建独立 SDK 实例,主要用于测试或多实例场景。 */
790
+ /**
791
+ * 创建独立 SDK 实例。
792
+ *
793
+ * @param options SDK 运行配置,例如超时时间、nonce 或测试环境注入的 window。
794
+ * @returns 可独立管理生命周期的 `MiniProgramSDK` 实例。
795
+ *
796
+ * @remarks
797
+ * 适用于测试、多实例场景,或需要自定义 `timeout`、`targetWindow` 等运行参数的场景。
798
+ *
799
+ * @example
800
+ * ```ts
801
+ * import { createMiniProgramSDK } from '@heybox/hb-sdk'
802
+ *
803
+ * const sdk = createMiniProgramSDK({
804
+ * timeout: 15000,
805
+ * })
806
+ * ```
807
+ */
444
808
  function createMiniProgramSDK(options) {
445
809
  return new MiniProgramSDK(options);
446
810
  }
@@ -452,42 +816,72 @@ function getDefaultSDK() {
452
816
  }
453
817
  return defaultSDK;
454
818
  }
455
- /** 等待默认 SDK 实例与父容器完成握手。 */
819
+ /**
820
+ * 等待默认 SDK 实例与父容器完成握手。
821
+ *
822
+ * @returns 当默认 SDK 单例与父容器握手成功后 resolve。
823
+ * @throws {HbMiniProgramSDKError} 当当前页面不在 iframe 中、缺少 nonce 或握手超时时抛出。
824
+ */
456
825
  function ready() {
457
826
  return getDefaultSDK().ready();
458
827
  }
459
- /** 注册默认 SDK 实例的事件监听。 */
828
+ /**
829
+ * 注册默认 SDK 实例的事件监听。
830
+ *
831
+ * @param eventName 要监听的事件名。
832
+ * @param handler 事件处理函数。
833
+ * @returns 事件解绑函数。
834
+ */
460
835
  function on(eventName, handler) {
461
836
  return getDefaultSDK().on(eventName, handler);
462
837
  }
463
- /** 移除默认 SDK 实例的事件监听。 */
838
+ /**
839
+ * 移除默认 SDK 实例的事件监听。
840
+ *
841
+ * @param eventName 要移除的事件名。
842
+ * @param handler 对应的事件处理函数。
843
+ * @returns 无返回值。
844
+ */
464
845
  function off(eventName, handler) {
465
846
  getDefaultSDK().off(eventName, handler);
466
847
  }
467
- /** 默认 SDK 实例的用户模块。 */
848
+ /** 默认 SDK 实例的授权模块。 */
849
+ const auth = {
850
+ login: () => getDefaultSDK().auth.login(),
851
+ };
852
+ /** 默认 SDK 实例的用户资料模块。 */
468
853
  const user = {
469
854
  getInfo: () => getDefaultSDK().user.getInfo(),
470
- login: () => getDefaultSDK().user.login(),
471
855
  };
472
856
  /** 默认 SDK 实例的分享模块。 */
473
857
  const share = {
474
858
  showShareMenu: options => getDefaultSDK().share.showShareMenu(options),
475
859
  screenshot: options => getDefaultSDK().share.screenshot(options),
476
860
  };
477
- /** 默认 SDK 实例的系统模块。 */
478
- const system = {
479
- getWindowInfo: () => getDefaultSDK().system.getWindowInfo(),
480
- getStorage: options => getDefaultSDK().system.getStorage(options),
481
- setStorage: options => getDefaultSDK().system.setStorage(options),
861
+ /** 默认 SDK 实例的 Viewport 模块。 */
862
+ const viewport = {
863
+ getWindowInfo: () => getDefaultSDK().viewport.getWindowInfo(),
864
+ };
865
+ /** 默认 SDK 实例的 storage 模块。 */
866
+ const storage = {
867
+ getStorage: options => getDefaultSDK().storage.getStorage(options),
868
+ setStorage: options => getDefaultSDK().storage.setStorage(options),
869
+ };
870
+ /** 默认 SDK 实例的 network 模块。 */
871
+ const network = {
872
+ request: config => getDefaultSDK().network.request(config),
482
873
  };
483
874
 
484
875
  const hbSDK = {
485
876
  ready,
486
877
  on,
487
878
  off,
879
+ auth,
488
880
  user,
489
881
  share,
490
- system,
882
+ viewport,
883
+ storage,
884
+ network,
491
885
  };
492
886
 
493
- export { HbMiniProgramSDKError, MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, MiniProgramSDK, SDK_HANDSHAKE_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, SYSTEM_GET_STORAGE_METHOD, SYSTEM_GET_WINDOW_INFO_METHOD, SYSTEM_SET_STORAGE_METHOD, USER_GET_INFO_METHOD, USER_LOGIN_METHOD, createMiniProgramSDK, createShareModule, createSystemModule, createUserModule, hbSDK as default, getInfo, getStorage, getWindowInfo, isMiniProgramBridgeMessage, login, off, on, ready, screenshot, setStorage, share, showShareMenu, system, user };
887
+ export { AUTH_LOGIN_METHOD, HbMiniProgramNetworkError, HbMiniProgramSDKError, MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, MiniProgramSDK, NETWORK_REQUEST_METHOD, SDK_HANDSHAKE_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, USER_GET_INFO_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, auth, createMiniProgramSDK, hbSDK as default, isMiniProgramBridgeMessage, network, off, on, ready, share, storage, user, viewport };