@heybox/hb-sdk 0.9.2-alpha.7 → 0.9.2-alpha.9
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/CHANGELOG.md +25 -0
- package/README.md +4 -2
- package/dist/card-controller.cjs.js +35 -3
- package/dist/card-controller.esm.js +35 -3
- package/dist/cli-chunks/{build-Do22AWbq.cjs → build-DvHmPnZZ.cjs} +5 -5
- package/dist/cli-chunks/{context-DQhjWa7X.cjs → context-DYlZV8UG.cjs} +2 -2
- package/dist/cli-chunks/{create-QuI_mw8x.cjs → create-CJ0cyrJG.cjs} +1 -1
- package/dist/cli-chunks/deploy-lock-CmKl9M1c.cjs +148 -0
- package/dist/cli-chunks/{dev-KAhj5UTy.cjs → dev-DhEZBjd6.cjs} +8 -8
- package/dist/cli-chunks/{doctor-DNoQWBpo.cjs → doctor-B8q0UuXs.cjs} +1 -1
- package/dist/cli-chunks/games-CmO-AKXg.cjs +140 -0
- package/dist/cli-chunks/{index-DZUYwb3h.cjs → index-CRwNLk5w.cjs} +1 -1
- package/dist/cli-chunks/{index-bZIxID9N.cjs → index-hYvQR19Q.cjs} +35 -16
- package/dist/cli-chunks/{index.esm-EWleN3S5.cjs → index.esm-DU7YhFWI.cjs} +6 -6
- package/dist/cli-chunks/{login-BYM3Nwau.cjs → login-DMJ45_Bs.cjs} +1 -1
- package/dist/cli-chunks/{project-vite-6eLmb4Em.cjs → project-vite-BGy9w-Bx.cjs} +1 -1
- package/dist/cli-chunks/{remote-dvOjaxJu.cjs → remote-CSuwqlKA.cjs} +33 -146
- package/dist/cli-chunks/{runtime-gate-BKc2zPV-.cjs → runtime-gate-BvcLwvzi.cjs} +3 -2
- package/dist/cli-chunks/{runtime-permission-env-B9SqoP85.cjs → runtime-permission-env-CbqmHz0r.cjs} +14 -2
- package/dist/cli-chunks/{skill-DFXZ0SK_.cjs → skill-CtKW2J0U.cjs} +2 -2
- package/dist/cli-chunks/{version-CwEOrhL1.cjs → version-BQMfLqms.cjs} +1 -1
- package/dist/cli.cjs +1 -1
- package/dist/devtools/browser-dev-host/assets/{browser-dev-host-BitDUIsy.js → browser-dev-host-Cjw0mAi_.js} +1 -1
- package/dist/devtools/browser-dev-host/assets/{desktop-app-launch-B0yrI7xe.js → desktop-app-launch-D9lPBkUV.js} +1 -1
- package/dist/devtools/browser-dev-host/assets/{index-D_mC4Hvt.js → index-DrbZkH9C.js} +3 -3
- package/dist/devtools/browser-dev-host/index.html +2 -2
- package/dist/index.cjs.js +13 -5
- package/dist/index.esm.js +13 -5
- package/dist/miniapp-publish.cjs.js +35 -81
- package/dist/miniapp-publish.esm.js +35 -80
- package/dist/protocol.cjs.js +13 -0
- package/dist/protocol.esm.js +13 -0
- package/dist/templates/vanilla-vite-js/README.md.ejs +4 -0
- package/dist/vite.cjs.js +51 -3
- package/dist/vite.esm.js +51 -3
- package/package.json +5 -4
- package/skill/SKILL.md +9 -0
- package/skill/skill.json +5 -5
- package/types/card-controller.d.ts +35 -3
- package/types/index.d.ts +51 -51
- package/types/miniapp-publish/index.d.ts +28 -60
- package/types/protocol.d.ts +10 -10
- package/types/vite/index.d.ts +8 -1
package/types/index.d.ts
CHANGED
|
@@ -207,7 +207,7 @@ interface PathRoot {
|
|
|
207
207
|
* @see [FileHandle](/reference/symbols/root/interfaces/FileHandle) 查看创建、读写、状态与删除方法。
|
|
208
208
|
* @see [文件能力与沙箱](/guide/files-and-sandbox) 路径、权限、Host operation 与配额说明。
|
|
209
209
|
*
|
|
210
|
-
* @since 0.8.0
|
|
210
|
+
* @since 0.8.0
|
|
211
211
|
* @hbPlatform android
|
|
212
212
|
* @hbPlatform ios
|
|
213
213
|
* @hbPlatform ohos
|
|
@@ -276,7 +276,7 @@ interface PathRoot {
|
|
|
276
276
|
* @see [DirectoryHandle](/reference/symbols/root/interfaces/DirectoryHandle) 查看 `create()`、`exists()`、`list()` 与 `remove()`。
|
|
277
277
|
* @see [文件能力与沙箱](/guide/files-and-sandbox) 路径、权限、Host operation 与配额说明。
|
|
278
278
|
*
|
|
279
|
-
* @since 0.8.0
|
|
279
|
+
* @since 0.8.0
|
|
280
280
|
* @hbPlatform android
|
|
281
281
|
* @hbPlatform ios
|
|
282
282
|
* @hbPlatform ohos
|
|
@@ -381,7 +381,7 @@ interface FileHandle {
|
|
|
381
381
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/error-handling | 错误处理}
|
|
382
382
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
383
383
|
*
|
|
384
|
-
* @since 0.8.0
|
|
384
|
+
* @since 0.8.0
|
|
385
385
|
* @hbPlatform android
|
|
386
386
|
* @hbPlatform ios
|
|
387
387
|
* @hbPlatform ohos
|
|
@@ -514,7 +514,7 @@ interface FileHandle {
|
|
|
514
514
|
* @see [files.pickFiles()](/reference/sdk/files/pickFiles) 取得当前 session 的精确外部文件授权。
|
|
515
515
|
* @see [文件能力与沙箱](/guide/files-and-sandbox) 查看权限、平台与 Host operation 说明。
|
|
516
516
|
*
|
|
517
|
-
* @since 0.8.0
|
|
517
|
+
* @since 0.8.0
|
|
518
518
|
* @hbPlatform android
|
|
519
519
|
* @hbPlatform ios
|
|
520
520
|
* @hbPlatform ohos
|
|
@@ -676,7 +676,7 @@ interface FileHandle {
|
|
|
676
676
|
* @see [files.saveFile()](/reference/sdk/files/saveFile) 让用户指定新的精确可写目标。
|
|
677
677
|
* @see [文件能力与沙箱](/guide/files-and-sandbox) 查看路径、权限、平台与配额边界。
|
|
678
678
|
*
|
|
679
|
-
* @since 0.8.0
|
|
679
|
+
* @since 0.8.0
|
|
680
680
|
* @hbPlatform android
|
|
681
681
|
* @hbPlatform ios
|
|
682
682
|
* @hbPlatform ohos
|
|
@@ -920,7 +920,7 @@ interface FileHandle {
|
|
|
920
920
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/error-handling | 错误处理}
|
|
921
921
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
922
922
|
*
|
|
923
|
-
* @since 0.8.0
|
|
923
|
+
* @since 0.8.0
|
|
924
924
|
* @hbPlatform android
|
|
925
925
|
* @hbPlatform ios
|
|
926
926
|
* @hbPlatform ohos
|
|
@@ -1105,7 +1105,7 @@ interface DirectoryHandle extends PathRoot {
|
|
|
1105
1105
|
* @see [files.pickDirectory()](/reference/sdk/files/pickDirectory) 取得不可删除的外部目录授权。
|
|
1106
1106
|
* @see [文件能力与沙箱](/guide/files-and-sandbox) 查看来源、权限、平台和错误码边界。
|
|
1107
1107
|
*
|
|
1108
|
-
* @since 0.8.0
|
|
1108
|
+
* @since 0.8.0
|
|
1109
1109
|
* @hbPlatform android
|
|
1110
1110
|
* @hbPlatform ios
|
|
1111
1111
|
* @hbPlatform ohos
|
|
@@ -1386,7 +1386,7 @@ interface FilesModule {
|
|
|
1386
1386
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/error-handling | 错误处理}
|
|
1387
1387
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
1388
1388
|
*
|
|
1389
|
-
* @since 0.8.0
|
|
1389
|
+
* @since 0.8.0
|
|
1390
1390
|
* @hbPlatform android
|
|
1391
1391
|
* @hbPlatform ios
|
|
1392
1392
|
* @hbPlatform ohos
|
|
@@ -1473,7 +1473,7 @@ interface FilesModule {
|
|
|
1473
1473
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/error-handling | 错误处理}
|
|
1474
1474
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
1475
1475
|
*
|
|
1476
|
-
* @since 0.8.0
|
|
1476
|
+
* @since 0.8.0
|
|
1477
1477
|
* @hbPlatform android
|
|
1478
1478
|
* @hbPlatform ios
|
|
1479
1479
|
* @hbPlatform ohos
|
|
@@ -1559,7 +1559,7 @@ interface FilesModule {
|
|
|
1559
1559
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/error-handling | 错误处理}
|
|
1560
1560
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
1561
1561
|
*
|
|
1562
|
-
* @since 0.8.0
|
|
1562
|
+
* @since 0.8.0
|
|
1563
1563
|
* @hbPlatform android
|
|
1564
1564
|
* @hbPlatform ios
|
|
1565
1565
|
* @hbPlatform ohos
|
|
@@ -1894,7 +1894,7 @@ interface MiniProgramNetworkModule {
|
|
|
1894
1894
|
* 返回到 SDK,默认触发 {@link HbMiniProgramNetworkError},只有自定义 `validateStatus`
|
|
1895
1895
|
* 接受时才 resolve。平台保留的 Runtime auth/OpenAPI 路径始终不能通过该能力访问。
|
|
1896
1896
|
*
|
|
1897
|
-
*
|
|
1897
|
+
* 自正式版 0.8.1 起公开 config 不再支持 `withCredentials`;JavaScript 仍传入时会被 SDK
|
|
1898
1898
|
* 忽略且不报错,也不会把凭据开关传给 Host。原生 Cookie 是否随请求发送由 Host 按目标
|
|
1899
1899
|
* 域名决定,iframe Cookie 不会由 SDK 自动读取;响应中的 `Set-Cookie` 与认证 Header 不会
|
|
1900
1900
|
* 暴露给页面。应用显式 Header 仍必须遵守敏感信息边界。
|
|
@@ -1935,7 +1935,7 @@ interface MiniProgramNetworkModule {
|
|
|
1935
1935
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/error-handling | 错误处理}
|
|
1936
1936
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
1937
1937
|
*
|
|
1938
|
-
* @since 0.
|
|
1938
|
+
* @since 0.3.1
|
|
1939
1939
|
* @hbPlatform android
|
|
1940
1940
|
* @hbPlatform ios
|
|
1941
1941
|
* @hbPlatform ohos
|
|
@@ -2029,7 +2029,7 @@ interface MiniProgramNetworkModule {
|
|
|
2029
2029
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/error-handling | 错误处理}
|
|
2030
2030
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
2031
2031
|
*
|
|
2032
|
-
* @since 0.8.0
|
|
2032
|
+
* @since 0.8.0
|
|
2033
2033
|
* @hbPlatform android
|
|
2034
2034
|
* @hbPlatform ios
|
|
2035
2035
|
* @hbPlatform ohos
|
|
@@ -2055,7 +2055,7 @@ interface MiniProgramNetworkModule {
|
|
|
2055
2055
|
* @returns 标准化 HTTP 响应;默认仅 2xx resolve。
|
|
2056
2056
|
* @throws HbMiniProgramNetworkError HTTP 状态未通过 validateStatus。
|
|
2057
2057
|
* @throws HbMiniProgramSDKError 文件、参数、权限、传输或 Host 能力错误。
|
|
2058
|
-
* @since 0.9.1
|
|
2058
|
+
* @since 0.9.1
|
|
2059
2059
|
* @hbPlatform android
|
|
2060
2060
|
* @hbPlatform ios
|
|
2061
2061
|
* @hbPlatform ohos
|
|
@@ -2291,7 +2291,7 @@ interface MiniProgramEnvironmentModule {
|
|
|
2291
2291
|
* @see [getHandshakeState()](/reference/sdk/lifecycle/getHandshakeState) 同步检查持久握手状态。
|
|
2292
2292
|
* @see [onHandshakeStateChange()](/reference/sdk/lifecycle/onHandshakeStateChange) 订阅当前状态及后续唯一一次迁移。
|
|
2293
2293
|
*
|
|
2294
|
-
* @since 0.8.1
|
|
2294
|
+
* @since 0.8.1
|
|
2295
2295
|
* @hbPlatform android
|
|
2296
2296
|
* @hbPlatform ios
|
|
2297
2297
|
* @hbPlatform ohos
|
|
@@ -2377,7 +2377,7 @@ interface MiniProgramEnvironmentModule {
|
|
|
2377
2377
|
* @see [getHandshakeState()](/reference/sdk/lifecycle/getHandshakeState) 同步读取当前持久握手状态。
|
|
2378
2378
|
* @see [onHandshakeStateChange()](/reference/sdk/lifecycle/onHandshakeStateChange) 立即接收当前状态并订阅唯一一次迁移。
|
|
2379
2379
|
*
|
|
2380
|
-
* @since 0.8.1
|
|
2380
|
+
* @since 0.8.1
|
|
2381
2381
|
* @hbPlatform android
|
|
2382
2382
|
* @hbPlatform ios
|
|
2383
2383
|
* @hbPlatform ohos
|
|
@@ -2497,7 +2497,7 @@ interface MiniProgramAuthModule {
|
|
|
2497
2497
|
* 旧 Host 不支持时保留原错误;查询期间收到账号事件时抛 AUTHORIZATION_CONTEXT_CHANGED,
|
|
2498
2498
|
* 调用方应保留较新的事件状态并按需重新读取。
|
|
2499
2499
|
*
|
|
2500
|
-
* @since 0.9.2
|
|
2500
|
+
* @since 0.9.2
|
|
2501
2501
|
* @hbPlatform android
|
|
2502
2502
|
* @hbPlatform ios
|
|
2503
2503
|
* @hbPlatform ohos
|
|
@@ -2590,7 +2590,7 @@ interface MiniProgramAuthModule {
|
|
|
2590
2590
|
* @see [user.revokeAuthorization](https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/user/revokeAuthorization)
|
|
2591
2591
|
* @see [network.request](https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/network/request)
|
|
2592
2592
|
*
|
|
2593
|
-
* @since 0.
|
|
2593
|
+
* @since 0.3.1
|
|
2594
2594
|
* @hbPlatform android
|
|
2595
2595
|
* @hbPlatform ios
|
|
2596
2596
|
* @hbPlatform ohos
|
|
@@ -2842,7 +2842,7 @@ interface MiniProgramUserModule {
|
|
|
2842
2842
|
* @see [用户身份与登录](/guide/auth)
|
|
2843
2843
|
* @see [权限声明](/guide/permissions)
|
|
2844
2844
|
*
|
|
2845
|
-
* @since 0.
|
|
2845
|
+
* @since 0.3.1
|
|
2846
2846
|
* @hbPlatform android
|
|
2847
2847
|
* @hbPlatform ios
|
|
2848
2848
|
* @hbPlatform ohos
|
|
@@ -2913,7 +2913,7 @@ interface MiniProgramUserModule {
|
|
|
2913
2913
|
* @see [用户身份与登录](/guide/auth#撤销当前小程序授权)
|
|
2914
2914
|
* @see [权限声明](/guide/permissions#无需声明的-api)
|
|
2915
2915
|
*
|
|
2916
|
-
* @since 0.7.0
|
|
2916
|
+
* @since 0.7.0
|
|
2917
2917
|
* @hbPlatform android
|
|
2918
2918
|
* @hbPlatform ios
|
|
2919
2919
|
* @hbPlatform ohos
|
|
@@ -3301,7 +3301,7 @@ interface MiniProgramShareModule {
|
|
|
3301
3301
|
* @see {@link MiniProgramShareModule.showShareMenu | share.showShareMenu}
|
|
3302
3302
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
3303
3303
|
*
|
|
3304
|
-
* @since 0.7.4
|
|
3304
|
+
* @since 0.7.4
|
|
3305
3305
|
* @hbPlatform android
|
|
3306
3306
|
* @hbPlatform ios
|
|
3307
3307
|
* @hbPlatform ohos
|
|
@@ -3357,7 +3357,7 @@ interface MiniProgramShareModule {
|
|
|
3357
3357
|
* @see {@link MiniProgramShareModule.screenshot | share.screenshot}
|
|
3358
3358
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/recipes/community-share | 社区分享预置}
|
|
3359
3359
|
*
|
|
3360
|
-
* @since 0.7.4
|
|
3360
|
+
* @since 0.7.4
|
|
3361
3361
|
* @hbPlatform android
|
|
3362
3362
|
* @hbPlatform ios
|
|
3363
3363
|
* @hbPlatform ohos
|
|
@@ -3443,7 +3443,7 @@ interface MiniProgramShareModule {
|
|
|
3443
3443
|
* @see [社区分享预置](/recipes/community-share)
|
|
3444
3444
|
* @see [权限声明](/guide/permissions)
|
|
3445
3445
|
*
|
|
3446
|
-
* @since 0.
|
|
3446
|
+
* @since 0.3.1
|
|
3447
3447
|
* @hbPlatform android
|
|
3448
3448
|
* @hbPlatform ios
|
|
3449
3449
|
* @hbPlatform ohos
|
|
@@ -3544,7 +3544,7 @@ interface MiniProgramShareModule {
|
|
|
3544
3544
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/recipes/community-share | 社区分享预置}
|
|
3545
3545
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
3546
3546
|
*
|
|
3547
|
-
* @since 0.
|
|
3547
|
+
* @since 0.3.1
|
|
3548
3548
|
* @hbPlatform android
|
|
3549
3549
|
* @hbPlatform ios
|
|
3550
3550
|
* @hbPlatform ohos
|
|
@@ -3715,7 +3715,7 @@ interface MiniProgramViewportModule {
|
|
|
3715
3715
|
* if (!result.supported) console.log('Host 不支持原生展示设置')
|
|
3716
3716
|
* ```
|
|
3717
3717
|
*
|
|
3718
|
-
* @since 0.8.
|
|
3718
|
+
* @since 0.8.3
|
|
3719
3719
|
* @hbPlatform android
|
|
3720
3720
|
* @hbPlatform ios
|
|
3721
3721
|
* @hbPlatform ohos
|
|
@@ -3766,7 +3766,7 @@ interface MiniProgramViewportModule {
|
|
|
3766
3766
|
* @see {@link MiniProgramViewportModule.setNavigationBarStyle}
|
|
3767
3767
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/window-size/ | 窗口尺寸与可缩放性}
|
|
3768
3768
|
*
|
|
3769
|
-
* @since 0.
|
|
3769
|
+
* @since 0.3.1
|
|
3770
3770
|
* @hbPlatform android
|
|
3771
3771
|
* @hbPlatform ios
|
|
3772
3772
|
* @hbPlatform ohos
|
|
@@ -3855,7 +3855,7 @@ interface WorkspaceCardsModule {
|
|
|
3855
3855
|
/**
|
|
3856
3856
|
* 合并刷新当前小程序活动 Controller,返回进入调度的实例数。
|
|
3857
3857
|
*
|
|
3858
|
-
* @since 0.9.
|
|
3858
|
+
* @since 0.9.1
|
|
3859
3859
|
* @hbPlatform windows
|
|
3860
3860
|
* @hbPlatform macos
|
|
3861
3861
|
* @hbClient windows none
|
|
@@ -3867,7 +3867,7 @@ interface WorkspaceCardsModule {
|
|
|
3867
3867
|
/**
|
|
3868
3868
|
* 读取最近一次卡片启动上下文;普通启动或账号变化后为空。
|
|
3869
3869
|
*
|
|
3870
|
-
* @since 0.9.
|
|
3870
|
+
* @since 0.9.1
|
|
3871
3871
|
* @hbPlatform windows
|
|
3872
3872
|
* @hbPlatform macos
|
|
3873
3873
|
* @hbClient windows none
|
|
@@ -3877,7 +3877,7 @@ interface WorkspaceCardsModule {
|
|
|
3877
3877
|
/**
|
|
3878
3878
|
* 立即回放当前上下文,并订阅后续变化。按 launchId 去重业务启动。
|
|
3879
3879
|
*
|
|
3880
|
-
* @since 0.9.
|
|
3880
|
+
* @since 0.9.1
|
|
3881
3881
|
* @hbPlatform windows
|
|
3882
3882
|
* @hbPlatform macos
|
|
3883
3883
|
* @hbClient windows none
|
|
@@ -4552,7 +4552,7 @@ interface MiniProgramCloudStorageModule {
|
|
|
4552
4552
|
/** 读取原始字符串,不存在返回 undefined,空字符串正常返回。key 仅支持 1–128 位字母、数字、下划线和连字符。
|
|
4553
4553
|
* @throws HbMiniProgramSDKError 参数错误、权限不足、登录失效或请求失败时拒绝 Promise。
|
|
4554
4554
|
*
|
|
4555
|
-
* @since 0.9.
|
|
4555
|
+
* @since 0.9.2
|
|
4556
4556
|
* @hbPlatform android
|
|
4557
4557
|
* @hbPlatform ios
|
|
4558
4558
|
* @hbPlatform ohos
|
|
@@ -4570,7 +4570,7 @@ interface MiniProgramCloudStorageModule {
|
|
|
4570
4570
|
* 不同 key 独立提交,同 key 请求串行;删除隔开窗口,不跨删除合并写入。
|
|
4571
4571
|
* 版本由 Runtime 管理;冲突返回 VERSION_CONFLICT。失败时拒绝同 key 已排队操作,需重新读取,不自动覆盖重试。
|
|
4572
4572
|
*
|
|
4573
|
-
* @since 0.9.
|
|
4573
|
+
* @since 0.9.2
|
|
4574
4574
|
* @hbPlatform android
|
|
4575
4575
|
* @hbPlatform ios
|
|
4576
4576
|
* @hbPlatform ohos
|
|
@@ -4584,7 +4584,7 @@ interface MiniProgramCloudStorageModule {
|
|
|
4584
4584
|
*/
|
|
4585
4585
|
setStorage(key: string, value: string): Promise<void>;
|
|
4586
4586
|
/** 删除整个键值记录;不存在也视为成功,与同 key 的写入保持调用顺序。
|
|
4587
|
-
* @since 0.9.
|
|
4587
|
+
* @since 0.9.2
|
|
4588
4588
|
* @hbPlatform android
|
|
4589
4589
|
* @hbPlatform ios
|
|
4590
4590
|
* @hbPlatform ohos
|
|
@@ -4598,7 +4598,7 @@ interface MiniProgramCloudStorageModule {
|
|
|
4598
4598
|
*/
|
|
4599
4599
|
removeItem(key: string): Promise<void>;
|
|
4600
4600
|
/** 返回当前用户在当前小程序下全部 key,不暴露数量、配额和内部版本。
|
|
4601
|
-
* @since 0.9.
|
|
4601
|
+
* @since 0.9.2
|
|
4602
4602
|
* @hbPlatform android
|
|
4603
4603
|
* @hbPlatform ios
|
|
4604
4604
|
* @hbPlatform ohos
|
|
@@ -4851,7 +4851,7 @@ interface CompanionStdio {
|
|
|
4851
4851
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/error-handling | 错误处理}
|
|
4852
4852
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
4853
4853
|
*
|
|
4854
|
-
* @since 0.8.1
|
|
4854
|
+
* @since 0.8.1
|
|
4855
4855
|
* @hbPlatform windows
|
|
4856
4856
|
* @hbPlatform macos
|
|
4857
4857
|
* @hbClient windows none
|
|
@@ -5021,7 +5021,7 @@ interface CompanionStdio {
|
|
|
5021
5021
|
* @see {@link MiniProgramCompanionModule.getActiveSession | companion.getActiveSession} 恢复活动 Session controller。
|
|
5022
5022
|
* @see [受管桌面程序](/guide/companion) 查看 stdio framing、重放与恢复流程。
|
|
5023
5023
|
*
|
|
5024
|
-
* @since 0.8.1
|
|
5024
|
+
* @since 0.8.1
|
|
5025
5025
|
* @hbPlatform windows
|
|
5026
5026
|
* @hbPlatform macos
|
|
5027
5027
|
* @hbClient windows none
|
|
@@ -5232,7 +5232,7 @@ interface CompanionAttachments {
|
|
|
5232
5232
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/error-handling | 错误处理}
|
|
5233
5233
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
5234
5234
|
*
|
|
5235
|
-
* @since 0.8.1
|
|
5235
|
+
* @since 0.8.1
|
|
5236
5236
|
* @hbPlatform windows
|
|
5237
5237
|
* @hbPlatform macos
|
|
5238
5238
|
* @hbClient windows none
|
|
@@ -5437,7 +5437,7 @@ interface CompanionSession {
|
|
|
5437
5437
|
* @see {@link MiniProgramCompanionModule.getActiveSession | companion.getActiveSession} 恢复活动 Session controller。
|
|
5438
5438
|
* @see [受管桌面程序](/guide/companion) 查看 Session、stdio 与进程树生命周期。
|
|
5439
5439
|
*
|
|
5440
|
-
* @since 0.8.1
|
|
5440
|
+
* @since 0.8.1
|
|
5441
5441
|
* @hbPlatform windows
|
|
5442
5442
|
* @hbPlatform macos
|
|
5443
5443
|
* @hbClient windows none
|
|
@@ -5734,7 +5734,7 @@ interface CompanionSession {
|
|
|
5734
5734
|
* @see {@link CompanionStdio.write | CompanionStdio.write()} 发送业务协议命令。
|
|
5735
5735
|
* @see [受管桌面程序](/guide/companion) 查看 ownership、Session 与恢复流程。
|
|
5736
5736
|
*
|
|
5737
|
-
* @since 0.8.1
|
|
5737
|
+
* @since 0.8.1
|
|
5738
5738
|
* @hbPlatform windows
|
|
5739
5739
|
* @hbPlatform macos
|
|
5740
5740
|
* @hbClient windows none
|
|
@@ -5801,7 +5801,7 @@ interface MiniProgramCompanionModule {
|
|
|
5801
5801
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/companion | 受管桌面程序}
|
|
5802
5802
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
5803
5803
|
*
|
|
5804
|
-
* @since 0.8.1
|
|
5804
|
+
* @since 0.8.1
|
|
5805
5805
|
* @hbPlatform windows
|
|
5806
5806
|
* @hbPlatform macos
|
|
5807
5807
|
* @hbClient windows none
|
|
@@ -5879,7 +5879,7 @@ interface MiniProgramCompanionModule {
|
|
|
5879
5879
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/companion | 受管桌面程序}
|
|
5880
5880
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
5881
5881
|
*
|
|
5882
|
-
* @since 0.8.1
|
|
5882
|
+
* @since 0.8.1
|
|
5883
5883
|
* @hbPlatform windows
|
|
5884
5884
|
* @hbPlatform macos
|
|
5885
5885
|
* @hbClient windows none
|
|
@@ -5979,7 +5979,7 @@ interface MiniProgramCompanionModule {
|
|
|
5979
5979
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/companion | 受管桌面程序}
|
|
5980
5980
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
5981
5981
|
*
|
|
5982
|
-
* @since 0.8.1
|
|
5982
|
+
* @since 0.8.1
|
|
5983
5983
|
* @hbPlatform windows
|
|
5984
5984
|
* @hbPlatform macos
|
|
5985
5985
|
* @hbClient windows none
|
|
@@ -6039,7 +6039,7 @@ interface MiniProgramCompanionModule {
|
|
|
6039
6039
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/companion | 受管桌面程序}
|
|
6040
6040
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
6041
6041
|
*
|
|
6042
|
-
* @since 0.8.1
|
|
6042
|
+
* @since 0.8.1
|
|
6043
6043
|
* @hbPlatform windows
|
|
6044
6044
|
* @hbPlatform macos
|
|
6045
6045
|
* @hbClient windows none
|
|
@@ -6138,7 +6138,7 @@ interface MiniProgramCompanionModule {
|
|
|
6138
6138
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/companion | 受管桌面程序}
|
|
6139
6139
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
6140
6140
|
*
|
|
6141
|
-
* @since 0.8.1
|
|
6141
|
+
* @since 0.8.1
|
|
6142
6142
|
* @hbPlatform windows
|
|
6143
6143
|
* @hbPlatform macos
|
|
6144
6144
|
* @hbClient windows none
|
|
@@ -6219,7 +6219,7 @@ interface MiniProgramCompanionModule {
|
|
|
6219
6219
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/companion | 受管桌面程序}
|
|
6220
6220
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
6221
6221
|
*
|
|
6222
|
-
* @since 0.8.1
|
|
6222
|
+
* @since 0.8.1
|
|
6223
6223
|
* @hbPlatform windows
|
|
6224
6224
|
* @hbPlatform macos
|
|
6225
6225
|
* @hbClient windows none
|
|
@@ -6339,7 +6339,7 @@ interface MiniProgramStorageModule {
|
|
|
6339
6339
|
* @see {@link MiniProgramStorageModule.setStorage | storage.setStorage}
|
|
6340
6340
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
6341
6341
|
*
|
|
6342
|
-
* @since 0.
|
|
6342
|
+
* @since 0.3.1
|
|
6343
6343
|
* @hbPlatform android
|
|
6344
6344
|
* @hbPlatform ios
|
|
6345
6345
|
* @hbPlatform ohos
|
|
@@ -6401,7 +6401,7 @@ interface MiniProgramStorageModule {
|
|
|
6401
6401
|
* @see {@link MiniProgramStorageModule.getStorage | storage.getStorage}
|
|
6402
6402
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
6403
6403
|
*
|
|
6404
|
-
* @since 0.
|
|
6404
|
+
* @since 0.3.1
|
|
6405
6405
|
* @hbPlatform android
|
|
6406
6406
|
* @hbPlatform ios
|
|
6407
6407
|
* @hbPlatform ohos
|
|
@@ -6936,7 +6936,7 @@ interface MiniProgramDeviceModule {
|
|
|
6936
6936
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
|
|
6937
6937
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/navigation/openAppPage | navigation.openAppPage}
|
|
6938
6938
|
*
|
|
6939
|
-
* @since 0.9.1
|
|
6939
|
+
* @since 0.9.1
|
|
6940
6940
|
* @hbPlatform android
|
|
6941
6941
|
* @hbPlatform ios
|
|
6942
6942
|
* @hbPlatform ohos
|
|
@@ -7424,7 +7424,7 @@ interface MiniProgramNavigationModule {
|
|
|
7424
7424
|
* @see [on('ready')](/reference/sdk/lifecycle/on) 不可重放的生命周期边沿事件。
|
|
7425
7425
|
* @see [environment.getInfoSync()](/reference/sdk/environment/getInfoSync) 在 `ready` 后同步读取环境快照。
|
|
7426
7426
|
*
|
|
7427
|
-
* @since 0.7.0
|
|
7427
|
+
* @since 0.7.0
|
|
7428
7428
|
* @hbPlatform android
|
|
7429
7429
|
* @hbPlatform ios
|
|
7430
7430
|
* @hbPlatform ohos
|
|
@@ -7517,7 +7517,7 @@ declare function getHandshakeState(): MiniProgramSDKHandshakeState;
|
|
|
7517
7517
|
* @see [environment.getInfoSync()](/reference/sdk/environment/getInfoSync) 在 `ready` handler 中同步读取环境。
|
|
7518
7518
|
* @see [事件与生命周期](/guide/lifecycle) 握手与普通生命周期事件的使用建议。
|
|
7519
7519
|
*
|
|
7520
|
-
* @since 0.7.0
|
|
7520
|
+
* @since 0.7.0
|
|
7521
7521
|
* @hbPlatform android
|
|
7522
7522
|
* @hbPlatform ios
|
|
7523
7523
|
* @hbPlatform ohos
|
|
@@ -7610,7 +7610,7 @@ declare function onHandshakeStateChange(handler: MiniProgramSDKHandshakeStateHan
|
|
|
7610
7610
|
* @see [onHandshakeStateChange()](/reference/sdk/lifecycle/onHandshakeStateChange) 订阅会立即回放的握手状态。
|
|
7611
7611
|
* @see [事件与生命周期](/guide/lifecycle) 生命周期时机与清理建议。
|
|
7612
7612
|
*
|
|
7613
|
-
* @since 0.
|
|
7613
|
+
* @since 0.3.1
|
|
7614
7614
|
* @hbPlatform android
|
|
7615
7615
|
* @hbPlatform ios
|
|
7616
7616
|
* @hbPlatform ohos
|
|
@@ -7677,7 +7677,7 @@ declare function on<T extends MiniProgramEventName>(eventName: T, handler: MiniP
|
|
|
7677
7677
|
* @see [onHandshakeStateChange()](/reference/sdk/lifecycle/onHandshakeStateChange) 订阅会立即回放的握手状态。
|
|
7678
7678
|
* @see [事件与生命周期](/guide/lifecycle) 生命周期事件列表与清理建议。
|
|
7679
7679
|
*
|
|
7680
|
-
* @since 0.
|
|
7680
|
+
* @since 0.3.1
|
|
7681
7681
|
* @hbPlatform android
|
|
7682
7682
|
* @hbPlatform ios
|
|
7683
7683
|
* @hbPlatform ohos
|
|
@@ -9,6 +9,7 @@ type MiniappCategory = 'tool' | 'game' | 'other';
|
|
|
9
9
|
* @param sourceLabel - 错误消息中的字段来源,默认 `package.json#heybox.category`。
|
|
10
10
|
* @returns 合法类别原值;输入 `undefined` 时返回 `undefined`,由发布流程另行检查是否必填。
|
|
11
11
|
* @throws `Error` 输入为其他值(包括 null 或空字符串)时抛出带字段来源的错误。
|
|
12
|
+
* @since 0.8.3
|
|
12
13
|
*/
|
|
13
14
|
declare function parseMiniappCategory(value: unknown, sourceLabel?: string): MiniappCategory | undefined;
|
|
14
15
|
|
|
@@ -200,6 +201,7 @@ interface MiniappManifest {
|
|
|
200
201
|
*
|
|
201
202
|
* @see {@link resolveMiniappManifestPlatforms}
|
|
202
203
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/reference/symbols/vite/functions/miniappManifest | miniappManifest}
|
|
204
|
+
* @since 0.3.1
|
|
203
205
|
*/
|
|
204
206
|
declare function isValidMiniappManifestVersion(version: string): boolean;
|
|
205
207
|
/**
|
|
@@ -211,6 +213,7 @@ declare function isValidMiniappManifestVersion(version: string): boolean;
|
|
|
211
213
|
* @remarks
|
|
212
214
|
* 不修改输入对象,不执行文件 I/O;不会验证图片/归档是否存在、内容摘要是否匹配,也不查询远端发布资格。
|
|
213
215
|
* 成功仅表示 Manifest 字段通过校验,不能替代文件检查与服务端发布预检。
|
|
216
|
+
* @since 0.8.2
|
|
214
217
|
*/
|
|
215
218
|
declare function validateMiniappManifestForDeploy(manifest: MiniappManifest): {
|
|
216
219
|
desc?: string | undefined;
|
|
@@ -334,6 +337,7 @@ interface MiniappPlatformResolution {
|
|
|
334
337
|
* @see {@link MINIAPP_LEGACY_DEFAULT_PLATFORM_VALUES}
|
|
335
338
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/reference/symbols/miniapp-publish/functions/isValidVersion | isValidVersion}
|
|
336
339
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/reference/symbols/vite/functions/miniappManifest | miniappManifest}
|
|
340
|
+
* @since 0.8.1
|
|
337
341
|
*/
|
|
338
342
|
declare function resolveMiniappManifestPlatforms(sdkVersion: string | undefined, manifest: unknown): MiniappPlatformResolution;
|
|
339
343
|
|
|
@@ -403,6 +407,7 @@ interface ParseMiniappBindAppIdsOptions {
|
|
|
403
407
|
* @see [miniappManifest](/reference/symbols/vite/functions/miniappManifest)
|
|
404
408
|
* @see [navigation.openAppPage](/reference/sdk/navigation/openAppPage)
|
|
405
409
|
* @see [CLI 与远端发布](/guide/cli#生产构建)
|
|
410
|
+
* @since 0.8.1
|
|
406
411
|
*/
|
|
407
412
|
declare function parseMiniappBindAppIds(value: unknown, options?: ParseMiniappBindAppIdsOptions): readonly string[];
|
|
408
413
|
|
|
@@ -422,6 +427,7 @@ interface MiniappBasicInfo {
|
|
|
422
427
|
* @returns NFKC 规范化、去除首尾 Unicode White_Space 后的名称;不折叠规范化后的内部空白。
|
|
423
428
|
* @throws `Error` 输入不是字符串,或规范化后不是 1–40 个 Unicode code point、不含文字或数字,或包含控制字符、
|
|
424
429
|
* 格式字符、行/段分隔符以及 HTML 特殊字符 `<`、`>`、`&`、双引号或单引号时抛出。
|
|
430
|
+
* @since 0.8.2
|
|
425
431
|
*/
|
|
426
432
|
declare function normalizeBasicInfoName(raw: unknown): string;
|
|
427
433
|
/**
|
|
@@ -434,6 +440,7 @@ declare function normalizeBasicInfoName(raw: unknown): string;
|
|
|
434
440
|
* @remarks
|
|
435
441
|
* 图片路径必须使用 `/` 分隔的非空相对路径,扩展名为 JPEG、PNG、GIF 或 WebP;拒绝 URL、点段、
|
|
436
442
|
* 控制字符和构建/缓存等保留目录。此函数只校验声明,不读取文件,也不验证图片字节、尺寸或存在性。
|
|
443
|
+
* @since 0.8.2
|
|
437
444
|
*/
|
|
438
445
|
declare function parseMiniappBasicInfo(value: Record<string, unknown>, sdkVersion?: string): MiniappBasicInfo | undefined;
|
|
439
446
|
|
|
@@ -465,6 +472,7 @@ declare function parseMiniappBasicInfo(value: Record<string, unknown>, sdkVersio
|
|
|
465
472
|
* }
|
|
466
473
|
* }
|
|
467
474
|
* ```
|
|
475
|
+
* @since 0.8.2
|
|
468
476
|
*/
|
|
469
477
|
declare function previewMiniappBasicInfo(manifest: Record<string, unknown>, files: readonly {
|
|
470
478
|
relativePath: string;
|
|
@@ -481,9 +489,23 @@ declare function previewMiniappBasicInfo(manifest: Record<string, unknown>, file
|
|
|
481
489
|
* @param html - 待检查的完整 HTML 文本,使用 HTML parser 解析。
|
|
482
490
|
* @returns Gate、隐藏样式及 bootstrap 标记均出现时返回 `true`,否则返回 `false`。
|
|
483
491
|
* @remarks 只识别标记,不验证脚本内容、标记所在节点或宿主握手;不能据此判断页面安全或实际可运行。
|
|
492
|
+
* @since 0.8.2
|
|
484
493
|
*/
|
|
485
494
|
declare function hasMiniappRuntimeGate(html: string): boolean;
|
|
486
495
|
|
|
496
|
+
/** 小程序资料缺失的非阻断提示;调用方应先完成字段格式校验。 */
|
|
497
|
+
interface MiniappMetadataWarning {
|
|
498
|
+
code: 'MINIAPP_DESC_MISSING' | 'MINIAPP_TOOL_GAME_BINDING_MISSING';
|
|
499
|
+
field: 'desc' | 'bindAppIds';
|
|
500
|
+
message: string;
|
|
501
|
+
}
|
|
502
|
+
/** 根据当前项目声明或实际版本 Manifest 检查资料完整性,不联网、不修改输入。 */
|
|
503
|
+
declare function getMiniappMetadataWarnings(metadata: {
|
|
504
|
+
desc?: unknown;
|
|
505
|
+
category?: unknown;
|
|
506
|
+
bindAppIds?: unknown;
|
|
507
|
+
}): MiniappMetadataWarning[];
|
|
508
|
+
|
|
487
509
|
/** CDN 上传接口使用的小程序产物业务 scope。 */
|
|
488
510
|
declare const MINIAPP_UPLOAD_SCOPE = "activity";
|
|
489
511
|
/** 完整 CDN 上传 key 的默认长度上限;旧固定版本流程按字符计数,上传会话流程按 UTF-8 bytes 计数。 */
|
|
@@ -561,6 +583,7 @@ declare const LIST_USER_MINIPROGRAM_VERSION_API_PATH = "/mall/developer/user_min
|
|
|
561
583
|
* @see {@link relativePathContainsNodeModulesSegment}
|
|
562
584
|
* @see {@link shouldUploadDistFile}
|
|
563
585
|
* @see {@link https://docs.xiaoheihe.cn/hb_sdk/reference/symbols/protocol/functions/isMiniProgramRelativePath | isMiniProgramRelativePath}
|
|
586
|
+
* @since 0.3.1
|
|
564
587
|
*/
|
|
565
588
|
declare function normalizeRelativePath(relativePath: string): string;
|
|
566
589
|
/**
|
|
@@ -586,6 +609,7 @@ declare function normalizeRelativePath(relativePath: string): string;
|
|
|
586
609
|
* @see [normalizeRelativePath](/reference/symbols/miniapp-publish/functions/normalizeRelativePath)
|
|
587
610
|
* @see [shouldUploadDistFile](/reference/symbols/miniapp-publish/functions/shouldUploadDistFile)
|
|
588
611
|
* @see [miniapp-publish](/reference/miniapp-publish/)
|
|
612
|
+
* @since 0.3.1
|
|
589
613
|
*/
|
|
590
614
|
declare function relativePathContainsNodeModulesSegment(relativePath: string): boolean;
|
|
591
615
|
/**
|
|
@@ -601,64 +625,6 @@ declare function relativePathContainsNodeModulesSegment(relativePath: string): b
|
|
|
601
625
|
* ```
|
|
602
626
|
*/
|
|
603
627
|
declare function getMiniProgramUploadAlias(miniProgramId: string): string;
|
|
604
|
-
/** 生成旧版固定版本上传 key 所需的输入。 */
|
|
605
|
-
interface MiniappUploadKeyInput {
|
|
606
|
-
/** 小程序 ID;函数会将其转换为稳定上传别名。 */
|
|
607
|
-
miniProgramId: string;
|
|
608
|
-
/** 要写入上传 key 的版本字符串;调用方应先完成版本合法性校验。 */
|
|
609
|
-
version: string;
|
|
610
|
-
/** 构建产物相对路径;生成 key 前会整理路径分隔符。 */
|
|
611
|
-
relativePath: string;
|
|
612
|
-
}
|
|
613
|
-
/**
|
|
614
|
-
* 生成旧版固定版本 CDN 上传 key。
|
|
615
|
-
*
|
|
616
|
-
* @param input - 小程序 ID、版本和构建产物相对路径。
|
|
617
|
-
* @returns `/u/{alias}/{version}/{relativePath}` 形式的上传 key。
|
|
618
|
-
* @remarks 此函数不会校验版本、路径安全性或 key 长度;批量上传前应调用 {@link validateUploadPaths}。
|
|
619
|
-
* @example
|
|
620
|
-
* ```ts
|
|
621
|
-
* getMiniappUploadKey({
|
|
622
|
-
* miniProgramId: 'mp_example',
|
|
623
|
-
* version: '1.2.3',
|
|
624
|
-
* relativePath: 'assets\\app.js',
|
|
625
|
-
* }); // /u/<alias>/1.2.3/assets/app.js
|
|
626
|
-
* ```
|
|
627
|
-
*/
|
|
628
|
-
declare function getMiniappUploadKey(input: MiniappUploadKeyInput): string;
|
|
629
|
-
/** 参与旧版上传路径校验的构建产物条目。 */
|
|
630
|
-
interface UploadPathItem {
|
|
631
|
-
/** 构建产物相对路径。 */
|
|
632
|
-
relativePath: string;
|
|
633
|
-
}
|
|
634
|
-
/** 旧版固定版本上传路径的校验选项。 */
|
|
635
|
-
interface ValidateUploadPathsOptions {
|
|
636
|
-
/** 小程序 ID,用于计算上传 key 中的稳定别名。 */
|
|
637
|
-
miniProgramId: string;
|
|
638
|
-
/** 要写入上传 key 的版本字符串。 */
|
|
639
|
-
version: string;
|
|
640
|
-
/** 完整上传 key 的最大字符数,默认 {@link ACTIVITY_UPLOAD_KEY_MAX_LENGTH}。 */
|
|
641
|
-
maxLength?: number;
|
|
642
|
-
}
|
|
643
|
-
/**
|
|
644
|
-
* 校验旧版固定版本上传路径的格式、唯一性和完整 key 长度。
|
|
645
|
-
*
|
|
646
|
-
* @param items - 待上传条目;按数组顺序检查。
|
|
647
|
-
* @param options - 小程序 ID、版本和可选的 key 长度上限。
|
|
648
|
-
* @returns 第一个校验错误的中文提示;全部合法时返回 `undefined`。
|
|
649
|
-
* @remarks
|
|
650
|
-
* 路径会先统一分隔符,因此 `assets\\app.js` 与 `assets/app.js` 视为重复。
|
|
651
|
-
* 长度按 JavaScript 字符串 `length` 计算;上传会话的 UTF-8 字节限制应使用 {@link validateMiniappUploadPathLengths}。
|
|
652
|
-
* @example
|
|
653
|
-
* ```ts
|
|
654
|
-
* const error = validateUploadPaths(
|
|
655
|
-
* [{ relativePath: 'index.html' }, { relativePath: 'assets/app.js' }],
|
|
656
|
-
* { miniProgramId: 'mp_example', version: '1.2.3' },
|
|
657
|
-
* );
|
|
658
|
-
* if (error) throw new Error(error);
|
|
659
|
-
* ```
|
|
660
|
-
*/
|
|
661
|
-
declare function validateUploadPaths(items: UploadPathItem[], options: ValidateUploadPathsOptions): string | undefined;
|
|
662
628
|
/**
|
|
663
629
|
* 参与上传总大小计算的构建产物条目。
|
|
664
630
|
*
|
|
@@ -746,6 +712,7 @@ interface ValidateUploadTotalSizeOptions {
|
|
|
746
712
|
* @see {@link ValidateUploadTotalSizeOptions}
|
|
747
713
|
* @see [shouldUploadDistFile](/reference/symbols/miniapp-publish/functions/shouldUploadDistFile)
|
|
748
714
|
* @see [miniapp-publish](/reference/miniapp-publish/)
|
|
715
|
+
* @since 0.4.7
|
|
749
716
|
*/
|
|
750
717
|
declare function validateUploadTotalSize(items: UploadSizeItem[], options?: ValidateUploadTotalSizeOptions): "构建产物总大小超过 100MB,请删除未引用资源或压缩图片后重新 deploy" | undefined;
|
|
751
718
|
/**
|
|
@@ -820,6 +787,7 @@ declare function validateMiniappUploadSizeBudgets(items: UploadSizeItem[], optio
|
|
|
820
787
|
* @see [relativePathContainsNodeModulesSegment](/reference/symbols/miniapp-publish/functions/relativePathContainsNodeModulesSegment)
|
|
821
788
|
* @see [validateUploadTotalSize](/reference/symbols/miniapp-publish/functions/validateUploadTotalSize)
|
|
822
789
|
* @see [miniapp-publish](/reference/miniapp-publish/)
|
|
790
|
+
* @since 0.3.1
|
|
823
791
|
*/
|
|
824
792
|
declare function shouldUploadDistFile(relativePath: string): boolean;
|
|
825
793
|
/**
|
|
@@ -1006,5 +974,5 @@ declare const LIST_USER_MINIPROGRAM_PERMISSION_APPLICATION_API_PATH = "/mall/dev
|
|
|
1006
974
|
/** 提交不绑定版本的平台权限申请。 */
|
|
1007
975
|
declare const SUBMIT_USER_MINIPROGRAM_PERMISSION_APPLICATION_API_PATH = "/mall/developer/user_miniprogram/runtime_permission/application_submit";
|
|
1008
976
|
|
|
1009
|
-
export { ACTIVITY_UPLOAD_KEY_MAX_LENGTH, CREATE_USER_MINIPROGRAM_API_PATH, CREATE_USER_MINIPROGRAM_LEADERBOARD_API_PATH, CREATE_USER_MINIPROGRAM_LOCAL_DEV_LAUNCH_TOKEN_API_PATH, DELETE_USER_MINIPROGRAM_LEADERBOARD_API_PATH, DETAIL_USER_MINIPROGRAM_API_PATH, DETAIL_USER_MINIPROGRAM_LEADERBOARD_API_PATH, DEVELOPER_ENTITY_LIST_API_PATH, DEVELOPER_ENTITY_SWITCH_API_PATH, LIST_USER_MINIPROGRAM_API_PATH, LIST_USER_MINIPROGRAM_LEADERBOARD_API_PATH, LIST_USER_MINIPROGRAM_PERMISSION_APPLICATION_API_PATH, LIST_USER_MINIPROGRAM_VERSION_API_PATH, MINIAPP_COMPANION_UPLOAD_TEMPORARY_SIZE_LIMIT_BYTES, MINIAPP_LEGACY_DEFAULT_PLATFORM_VALUES, MINIAPP_LEGACY_MOBILE_PLATFORM_VALUES, MINIAPP_PLATFORM_HARD_CUT_SDK_VERSION, MINIAPP_UPLOAD_BATCH_SIZE, MINIAPP_UPLOAD_SCOPE, MINIAPP_UPLOAD_TOTAL_SIZE_LIMIT_BYTES, PRECHECK_USER_MINIPROGRAM_VERSION_API_PATH, RELEASE_USER_MINIPROGRAM_VERSION_API_PATH, REOPEN_USER_MINIPROGRAM_API_PATH, SUBMIT_USER_MINIPROGRAM_AUDIT_API_PATH, SUBMIT_USER_MINIPROGRAM_PERMISSION_APPLICATION_API_PATH, TAKE_DOWN_USER_MINIPROGRAM_API_PATH, UPDATE_SQUARE_DISPLAY_API_PATH, UPDATE_USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH, USER_MINIPROGRAM_ACCESS_STATUS_API_PATH, USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH, USER_MINIPROGRAM_VERSION_PREVIEW_INFO_API_PATH, WITHDRAW_USER_MINIPROGRAM_VERSION_API_PATH, createMiniappArtifactFileHeader, createMiniappArtifactSignatureHeader, getMiniProgramUploadAlias,
|
|
1010
|
-
export type { MiniappArtifactFile, MiniappArtifactFileReceipt, MiniappBasicInfo, MiniappCategory, MiniappCompanionCapability, MiniappCompanionManifestDeclarations, MiniappCompanionManifestDefinition, MiniappCompanionManifestTarget, MiniappCompanionTarget, MiniappManifest, MiniappPermissionDeclarations, MiniappPlatformPolicy, MiniappPlatformResolution, MiniappReusedCompanionFile,
|
|
977
|
+
export { ACTIVITY_UPLOAD_KEY_MAX_LENGTH, CREATE_USER_MINIPROGRAM_API_PATH, CREATE_USER_MINIPROGRAM_LEADERBOARD_API_PATH, CREATE_USER_MINIPROGRAM_LOCAL_DEV_LAUNCH_TOKEN_API_PATH, DELETE_USER_MINIPROGRAM_LEADERBOARD_API_PATH, DETAIL_USER_MINIPROGRAM_API_PATH, DETAIL_USER_MINIPROGRAM_LEADERBOARD_API_PATH, DEVELOPER_ENTITY_LIST_API_PATH, DEVELOPER_ENTITY_SWITCH_API_PATH, LIST_USER_MINIPROGRAM_API_PATH, LIST_USER_MINIPROGRAM_LEADERBOARD_API_PATH, LIST_USER_MINIPROGRAM_PERMISSION_APPLICATION_API_PATH, LIST_USER_MINIPROGRAM_VERSION_API_PATH, MINIAPP_COMPANION_UPLOAD_TEMPORARY_SIZE_LIMIT_BYTES, MINIAPP_LEGACY_DEFAULT_PLATFORM_VALUES, MINIAPP_LEGACY_MOBILE_PLATFORM_VALUES, MINIAPP_PLATFORM_HARD_CUT_SDK_VERSION, MINIAPP_UPLOAD_BATCH_SIZE, MINIAPP_UPLOAD_SCOPE, MINIAPP_UPLOAD_TOTAL_SIZE_LIMIT_BYTES, PRECHECK_USER_MINIPROGRAM_VERSION_API_PATH, RELEASE_USER_MINIPROGRAM_VERSION_API_PATH, REOPEN_USER_MINIPROGRAM_API_PATH, SUBMIT_USER_MINIPROGRAM_AUDIT_API_PATH, SUBMIT_USER_MINIPROGRAM_PERMISSION_APPLICATION_API_PATH, TAKE_DOWN_USER_MINIPROGRAM_API_PATH, UPDATE_SQUARE_DISPLAY_API_PATH, UPDATE_USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH, USER_MINIPROGRAM_ACCESS_STATUS_API_PATH, USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH, USER_MINIPROGRAM_VERSION_PREVIEW_INFO_API_PATH, WITHDRAW_USER_MINIPROGRAM_VERSION_API_PATH, createMiniappArtifactFileHeader, createMiniappArtifactSignatureHeader, getMiniProgramUploadAlias, getMiniappMetadataWarnings, hasMiniappRuntimeGate, isValidMiniappManifestVersion as isValidVersion, normalizeBasicInfoName, normalizeRelativePath, parseMiniappBasicInfo, parseMiniappBindAppIds, parseMiniappCategory, prepareMiniappArtifactFiles, previewMiniappBasicInfo, relativePathContainsNodeModulesSegment, resolveMiniappManifestPlatforms, resolveMiniappUploadSessionFiles, shouldUploadDistFile, validateMiniappCompanionFileReceipts, validateMiniappManifestForDeploy, validateMiniappUploadPathLengths, validateMiniappUploadSizeBudgets, validateMiniappWorkspaceCardFileReceipts, validateUploadTotalSize };
|
|
978
|
+
export type { MiniappArtifactFile, MiniappArtifactFileReceipt, MiniappBasicInfo, MiniappCategory, MiniappCompanionCapability, MiniappCompanionManifestDeclarations, MiniappCompanionManifestDefinition, MiniappCompanionManifestTarget, MiniappCompanionTarget, MiniappManifest, MiniappMetadataWarning, MiniappPermissionDeclarations, MiniappPlatformPolicy, MiniappPlatformResolution, MiniappReusedCompanionFile, MiniappUploadSessionFile, MiniappWindowDeclaration, NetworkMiniappPermissionDeclaration, ParseMiniappBindAppIdsOptions, SimpleMiniappPermissionDeclaration, UploadSizeItem, ValidateUploadTotalSizeOptions };
|