@heybox/hb-sdk 0.9.1-alpha.8 → 0.9.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.
- package/CHANGELOG.md +123 -17
- package/README.md +18 -17
- package/dist/cli-chunks/_commonjs-dynamic-modules-DUamuDzp.cjs +7 -0
- package/dist/cli-chunks/browser-RAy8e8cV.cjs +635 -0
- package/dist/cli-chunks/{build-CQkpLf81.cjs → build-DCp9C9V4.cjs} +10 -14
- package/dist/cli-chunks/{context-CqJDNtEi.cjs → context-Bg6C5ow7.cjs} +10 -5
- package/dist/cli-chunks/{create-BRuR2M7y.cjs → create-D5bX2Xvw.cjs} +7 -12
- package/dist/cli-chunks/{dev-KJAFHEg_.cjs → dev-CFjwhG3q.cjs} +195 -82
- package/dist/cli-chunks/{doctor-DhiUViwk.cjs → doctor-CMz_Kf7-.cjs} +9 -13
- package/dist/cli-chunks/{index-9trmrUtW.cjs → index-B_KKGIBN.cjs} +13591 -10542
- package/dist/cli-chunks/{index-rxAV5dza.cjs → index-YnVa6S_p.cjs} +9 -10
- package/dist/cli-chunks/{index.esm-Cv9FlhXy.cjs → index.esm-CgZPnqEA.cjs} +43 -43
- package/dist/cli-chunks/{login-5DEcU9eL.cjs → login-Df_v6jNs.cjs} +13 -12
- package/dist/cli-chunks/{project-vite-CXWFwbEz.cjs → project-vite-By8cnIwP.cjs} +1 -1
- package/dist/cli-chunks/{remote-laUZaGpI.cjs → remote-ClIJz-e2.cjs} +42 -71
- package/dist/cli-chunks/{runtime-gate-DmJhPcNQ.cjs → runtime-gate-DKiyNwX2.cjs} +9 -13
- package/dist/cli-chunks/{runtime-permission-env-Gy2dH17F.cjs → runtime-permission-env-BNQ2fx4w.cjs} +82 -2794
- package/dist/cli-chunks/{skill--mZIZkyn.cjs → skill-Bk-EBSbJ.cjs} +10 -14
- package/dist/cli-chunks/{version-BMp9qmtC.cjs → version-CG_VNZGM.cjs} +1 -1
- package/dist/cli.cjs +11 -16
- package/dist/devtools/browser-dev-host/assets/browser-dev-host-C1g2tadT.js +102 -0
- package/dist/devtools/browser-dev-host/assets/{desktop-app-launch-BU-vzcs0.js → desktop-app-launch-sH2a_jbj.js} +1 -1
- package/dist/devtools/browser-dev-host/assets/{index-BRxbUJVN.css → index-7Cq8iNcD.css} +1 -1
- package/dist/devtools/browser-dev-host/assets/{index-BZBZfB4t.js → index-Bpxbe1lP.js} +4 -4
- package/dist/devtools/browser-dev-host/index.html +3 -3
- package/dist/index.cjs.js +16 -8
- package/dist/index.esm.js +16 -8
- package/dist/miniapp-publish.cjs.js +27 -0
- package/dist/miniapp-publish.esm.js +27 -0
- package/dist/protocol.cjs.js +1 -1
- package/dist/protocol.esm.js +1 -1
- package/dist/vite.cjs.js +36 -1
- package/dist/vite.esm.js +36 -1
- package/docs/runtime-host-migration.md +4 -2
- package/package.json +6 -5
- package/skill/SKILL.md +10 -0
- package/skill/skill.json +5 -5
- package/types/index.d.ts +124 -94
- package/types/miniapp-publish/index.d.ts +3 -0
- package/types/protocol.d.ts +47 -39
- package/types/vite/index.d.ts +1 -0
- package/dist/cli-chunks/browser-YVckob3g.cjs +0 -15
- package/dist/devtools/browser-dev-host/assets/browser-dev-host-COdk-39n.js +0 -102
package/types/index.d.ts
CHANGED
|
@@ -169,7 +169,7 @@ interface PathRoot {
|
|
|
169
169
|
* 对应 operation:[FileHandle](/reference/symbols/root/interfaces/FileHandle) 的 `create()`、`remove()`、
|
|
170
170
|
* `exists()`、`readText()`、`readBytes()`、`writeText()`、`writeBytes()`、`stat()` 分别使用
|
|
171
171
|
* `file.create`、`file.remove`、`file.exists`、`file.readText`、`file.readBytes`、`file.writeText`、
|
|
172
|
-
* `file.writeBytes`、`file.stat
|
|
172
|
+
* `file.writeBytes`、`file.stat`。当前运行快照缺少或未启用所需权限时分别返回 `PERMISSION_NOT_IN_SNAPSHOT` 或
|
|
173
173
|
* `PERMISSION_DENIED`,Host 未开放具体 operation 时返回 `METHOD_FORBIDDEN`;这些错误在调用异步
|
|
174
174
|
* 方法时发生,不由本方法抛出。
|
|
175
175
|
*
|
|
@@ -244,8 +244,8 @@ interface PathRoot {
|
|
|
244
244
|
* 后续 I/O 才要求在 `package.json#heybox.permissions` 中声明并启用 `filesystem`,并由 Host 开放
|
|
245
245
|
* 对应 operation:[DirectoryHandle](/reference/symbols/root/interfaces/DirectoryHandle) 的 `create()`、
|
|
246
246
|
* `exists()`、`list()`、`remove()` 分别使用 `directory.create`、`directory.exists`、
|
|
247
|
-
* `directory.list`、`directory.remove
|
|
248
|
-
* `
|
|
247
|
+
* `directory.list`、`directory.remove`。当前运行快照缺少或未启用所需权限时分别返回
|
|
248
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` 或 `PERMISSION_DENIED`,Host 未开放具体 operation 时返回
|
|
249
249
|
* `METHOD_FORBIDDEN`;这些错误在调用异步方法时发生,不由本方法抛出。
|
|
250
250
|
*
|
|
251
251
|
* `files.sandbox.directory('.')` 是沙箱根目录的逻辑代理,可用于 `exists()` 或 `list()`,但不能删除;
|
|
@@ -322,8 +322,8 @@ interface FileHandle {
|
|
|
322
322
|
* ensure-exists 不会截断或改写已有内容。
|
|
323
323
|
* @throws {@link HbMiniProgramSDKError} options 非对象,或 `recursive` / `exclusive` 不是 boolean 时
|
|
324
324
|
* 返回 `INVALID_PARAMS`;代理不是 `readwrite` 时在发送 bridge 请求前返回 `FILE_ACCESS_DENIED`。
|
|
325
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
326
|
-
* `
|
|
325
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 时返回
|
|
326
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放或未协商到 `file.create` 时返回
|
|
327
327
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。
|
|
328
328
|
* @throws {@link HbMiniProgramSDKError} `recursive: false` 且父目录缺失时返回
|
|
329
329
|
* `DIRECTORY_NOT_FOUND`;目标实际是目录或路径中的祖先实际是文件时返回 `FILE_TYPE_MISMATCH`;
|
|
@@ -344,8 +344,8 @@ interface FileHandle {
|
|
|
344
344
|
* 该方法不需要可信用户手势,也不会创建新的 direct handle、消耗 1024 个外部授权句柄配额或暴露真实路径。
|
|
345
345
|
*
|
|
346
346
|
* 新 PC Host 支持该 operation;Android/iOS 需要 `1.3.396+` 并以 `system.describe` 实际宣告的
|
|
347
|
-
* operation 为准,OHOS 同样按 Host
|
|
348
|
-
*
|
|
347
|
+
* operation 为准,OHOS 同样按 Host 协商结果启用。外部精确 File 只有实际获授 `readwrite`
|
|
348
|
+
* 时才能调用本方法;较早 Android 客户端可能仅授予 `read`。Web、Browser Dev Host、旧 Host
|
|
349
349
|
* 或 operation 集不完整时 fail closed,不提供 Blob 或内存 fallback。
|
|
350
350
|
*
|
|
351
351
|
* `create()` 只创建空目标。父目录已经存在时,{@link FileHandle.writeText} /
|
|
@@ -405,8 +405,8 @@ interface FileHandle {
|
|
|
405
405
|
* @throws {@link HbMiniProgramSDKError} 目标或祖先不存在时返回 `FILE_NOT_FOUND` /
|
|
406
406
|
* `DIRECTORY_NOT_FOUND`,目标实际是目录时可返回 `FILE_TYPE_MISMATCH`;授权失效或 Host 删除失败
|
|
407
407
|
* 时返回 `FILE_ACCESS_REVOKED` / `FILE_IO_FAILED` 等稳定文件错误码。
|
|
408
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
409
|
-
* `
|
|
408
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 时返回
|
|
409
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放 `file.remove` operation 时返回
|
|
410
410
|
* `METHOD_FORBIDDEN`,旧 Runtime 不认识该 method 时可返回 `METHOD_NOT_FOUND`。
|
|
411
411
|
*
|
|
412
412
|
* @remarks
|
|
@@ -453,8 +453,8 @@ interface FileHandle {
|
|
|
453
453
|
* @returns Host 能取得目标且确认其类型为文件时返回 `true`。目标文件不存在、任一祖先目录
|
|
454
454
|
* 不存在,或同一逻辑位置实际是目录时返回 `false`;这些正常的“不存在”结果不会抛出
|
|
455
455
|
* `FILE_NOT_FOUND`、`DIRECTORY_NOT_FOUND` 或 `FILE_TYPE_MISMATCH`。
|
|
456
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
457
|
-
* `
|
|
456
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 权限时分别以
|
|
457
|
+
* `PERMISSION_NOT_IN_SNAPSHOT`、`PERMISSION_DENIED` 拒绝;当前 Host 未开放 `file.exists` 时以
|
|
458
458
|
* `METHOD_FORBIDDEN` 拒绝,旧 Runtime 也可能返回 `METHOD_NOT_FOUND`。
|
|
459
459
|
* @throws {@link HbMiniProgramSDKError} picker / `saveFile()` 返回的精确外部授权被撤销、句柄
|
|
460
460
|
* 不属于当前 Runtime session 或 registry 已释放时,以 `FILE_ACCESS_REVOKED` 拒绝,而不是返回
|
|
@@ -539,8 +539,8 @@ interface FileHandle {
|
|
|
539
539
|
* @throws {@link HbMiniProgramSDKError} 目标或祖先不存在时返回 `FILE_NOT_FOUND` / `DIRECTORY_NOT_FOUND`,
|
|
540
540
|
* 目标类型不匹配时返回 `FILE_TYPE_MISMATCH`。Android/iOS 当前对一次完整读取设 8 MiB 上限,
|
|
541
541
|
* 超限时返回 `FILE_TOO_LARGE`。
|
|
542
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
543
|
-
* `filesystem` 时返回 `
|
|
542
|
+
* @throws {@link HbMiniProgramSDKError} 使用普通 sandbox / picker / `saveFile()` 句柄时,运行快照缺少或未启用
|
|
543
|
+
* `filesystem` 时返回 `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放或未协商到
|
|
544
544
|
* `file.readText` 时返回 `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。
|
|
545
545
|
* @throws {@link HbMiniProgramSDKError} 外部 direct handle 已失效、来自其他或已结束的 Runtime
|
|
546
546
|
* session 时返回 `FILE_ACCESS_REVOKED`;SDK / Runtime 已终止、调用超时、Host 返回无效内容或底层
|
|
@@ -605,8 +605,8 @@ interface FileHandle {
|
|
|
605
605
|
* @throws {@link HbMiniProgramSDKError} `content` 不是字符串时在 Host I/O 前以
|
|
606
606
|
* `INVALID_PARAMS` 拒绝;当前代理的 `mode` 不是 `readwrite` 时在发送 bridge 请求前以
|
|
607
607
|
* `FILE_ACCESS_DENIED` 拒绝。
|
|
608
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
609
|
-
* `
|
|
608
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 权限时分别以
|
|
609
|
+
* `PERMISSION_NOT_IN_SNAPSHOT`、`PERMISSION_DENIED` 拒绝;Host 未开放 `file.writeText` 时以
|
|
610
610
|
* `METHOD_FORBIDDEN` 拒绝,旧 Runtime 也可能返回 `METHOD_NOT_FOUND`。
|
|
611
611
|
* @throws {@link HbMiniProgramSDKError} 缺失父目录时返回 `DIRECTORY_NOT_FOUND`,路径中的祖先
|
|
612
612
|
* 或目标类型不匹配时返回 `FILE_TYPE_MISMATCH`。Android / iOS 对一次完整写入的 UTF-8 编码结果
|
|
@@ -632,7 +632,7 @@ interface FileHandle {
|
|
|
632
632
|
* sandbox lazy FileHandle 固定继承 `readwrite`,并在每次调用时按当前 Mini-program identity 解析。
|
|
633
633
|
* `pickFiles({ mode: 'readwrite' })`、`pickDirectory({ mode: 'readwrite' })` 的派生文件和
|
|
634
634
|
* `saveFile()` 返回的精确外部 FileHandle 也可以写入,但授权范围不会因此扩张;direct handle 只在
|
|
635
|
-
* 当前 Runtime session 有效。只读 picker
|
|
635
|
+
* 当前 Runtime session 有效。只读 picker 结果和 Companion attachment
|
|
636
636
|
* 会在本地 mode 检查时以 `FILE_ACCESS_DENIED` 拒绝。该方法不需要新的可信用户手势;只有最初
|
|
637
637
|
* 获取外部授权的 picker / `saveFile()` 需要手势。
|
|
638
638
|
*
|
|
@@ -698,8 +698,8 @@ interface FileHandle {
|
|
|
698
698
|
* @throws {@link HbMiniProgramSDKError} 目标或祖先不存在时返回 `FILE_NOT_FOUND` / `DIRECTORY_NOT_FOUND`,
|
|
699
699
|
* 目标类型不匹配时返回 `FILE_TYPE_MISMATCH`。Android / iOS 当前对一次完整读取设 `8 MiB`
|
|
700
700
|
* (`8 * 1024 * 1024` bytes)上限,超限时返回 `FILE_TOO_LARGE`。
|
|
701
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
702
|
-
* `filesystem` 时返回 `
|
|
701
|
+
* @throws {@link HbMiniProgramSDKError} 使用普通 sandbox / picker / `saveFile()` 句柄时,运行快照缺少或未启用
|
|
702
|
+
* `filesystem` 时返回 `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放或未协商到
|
|
703
703
|
* `file.readBytes` 时返回 `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。
|
|
704
704
|
* @throws {@link HbMiniProgramSDKError} 外部 direct handle 被撤销、不属于当前或已结束的 Runtime
|
|
705
705
|
* session 时返回 `FILE_ACCESS_REVOKED`;Host 拒绝底层授权时也可能返回 `FILE_ACCESS_DENIED`。
|
|
@@ -775,8 +775,8 @@ interface FileHandle {
|
|
|
775
775
|
* @throws {@link HbMiniProgramSDKError} `content` 不是 `Uint8Array`,或其 backing buffer 是
|
|
776
776
|
* `SharedArrayBuffer` 时,在发送 bridge 请求前返回 `INVALID_PARAMS`;当前代理不是 `readwrite`
|
|
777
777
|
* 时在输入复制和 Host I/O 前返回 `FILE_ACCESS_DENIED`。
|
|
778
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
779
|
-
* `
|
|
778
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 权限时返回
|
|
779
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放或未协商到 `file.writeBytes` 时返回
|
|
780
780
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。
|
|
781
781
|
* @throws {@link HbMiniProgramSDKError} 缺失父目录时返回 `DIRECTORY_NOT_FOUND`,路径中的祖先或
|
|
782
782
|
* 目标类型不匹配时返回 `FILE_TYPE_MISMATCH`。Android / iOS 对一次完整写入设 8 MiB 上限;当前
|
|
@@ -802,8 +802,8 @@ interface FileHandle {
|
|
|
802
802
|
*
|
|
803
803
|
* sandbox lazy FileHandle 固定继承 `readwrite`。`pickFiles({ mode: 'readwrite' })`、
|
|
804
804
|
* `pickDirectory({ mode: 'readwrite' })` 的派生文件和 `saveFile()` 返回的精确外部 FileHandle 也可
|
|
805
|
-
* 写入,但 direct handle 只在当前 Runtime session 有效,且授权范围不会扩张。只读 picker
|
|
806
|
-
*
|
|
805
|
+
* 写入,但 direct handle 只在当前 Runtime session 有效,且授权范围不会扩张。只读 picker 结果
|
|
806
|
+
* 和 Companion attachment 返回 `FILE_ACCESS_DENIED`。该方法不需要新的
|
|
807
807
|
* 可信用户手势;只有最初取得外部授权的 picker / `saveFile()` 需要手势。
|
|
808
808
|
*
|
|
809
809
|
* 新 PC Host 支持该操作;Android / iOS `1.3.396+` 仅在 `system.describe` 同时宣告
|
|
@@ -853,8 +853,8 @@ interface FileHandle {
|
|
|
853
853
|
* `DIRECTORY_NOT_FOUND`;目标实际是目录、direct handle 类型不匹配时返回 `FILE_TYPE_MISMATCH`。
|
|
854
854
|
* @throws {@link HbMiniProgramSDKError} 外部 direct handle 已撤销、不属于当前 Runtime session 或
|
|
855
855
|
* registry 已释放时返回 `FILE_ACCESS_REVOKED`;Host 拒绝读取元数据时返回 `FILE_ACCESS_DENIED`。
|
|
856
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
857
|
-
* `
|
|
856
|
+
* @throws {@link HbMiniProgramSDKError} 使用普通 FileHandle 时,运行快照缺少或未启用 `filesystem` 时返回
|
|
857
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放或未协商到 `file.stat` 时返回
|
|
858
858
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。Companion attachment 是受控例外:
|
|
859
859
|
* 它使用已启用的 `companion` 授权读取自身元数据,不要求另行声明 `filesystem`。
|
|
860
860
|
* @throws {@link HbMiniProgramSDKError} Host 返回非对象、错误的 `kind`,负数/小数/unsafe `size`,
|
|
@@ -957,8 +957,8 @@ interface DirectoryHandle extends PathRoot {
|
|
|
957
957
|
* `result === directory`。不会创建新的授权 handle,也不会刷新或改变代理的 `name`、`mode`。
|
|
958
958
|
* @throws {@link HbMiniProgramSDKError} options 非对象,或 `recursive` / `exclusive` 不是 boolean 时
|
|
959
959
|
* 返回 `INVALID_PARAMS`;代理不是 `readwrite` 时在发送 bridge 请求前返回 `FILE_ACCESS_DENIED`。
|
|
960
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
961
|
-
* `
|
|
960
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 时返回
|
|
961
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放或未协商到 `directory.create` 时返回
|
|
962
962
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。
|
|
963
963
|
* @throws {@link HbMiniProgramSDKError} `recursive: false` 且任一父目录缺失时返回
|
|
964
964
|
* `DIRECTORY_NOT_FOUND`;目标实际是文件或路径中的祖先实际是文件时返回 `FILE_TYPE_MISMATCH`;
|
|
@@ -1042,8 +1042,8 @@ interface DirectoryHandle extends PathRoot {
|
|
|
1042
1042
|
* @throws {@link HbMiniProgramSDKError} 目标或任一祖先不存在时返回 `DIRECTORY_NOT_FOUND`,目标
|
|
1043
1043
|
* 实际是文件或路径中的祖先类型不匹配时返回 `FILE_TYPE_MISMATCH`。删除已经不存在的目录不会
|
|
1044
1044
|
* 当作幂等成功;需要“确保不存在”语义时应先接受缺失错误或在操作后调用 `exists()` 对账。
|
|
1045
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
1046
|
-
* `
|
|
1045
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 权限时分别以
|
|
1046
|
+
* `PERMISSION_NOT_IN_SNAPSHOT`、`PERMISSION_DENIED` 拒绝;Host 未开放 `directory.remove` 时以
|
|
1047
1047
|
* `METHOD_FORBIDDEN` 拒绝,旧 Runtime 也可能返回 `METHOD_NOT_FOUND`。
|
|
1048
1048
|
* @throws {@link HbMiniProgramSDKError} SDK 已销毁、Runtime 已卸载、请求超时、Host 拒绝删除或
|
|
1049
1049
|
* 发生底层 I/O 失败时,以 `SDK_DESTROYED`、`RUNTIME_UNAVAILABLE`、`REQUEST_TIMEOUT`、
|
|
@@ -1126,8 +1126,8 @@ interface DirectoryHandle extends PathRoot {
|
|
|
1126
1126
|
* `FILE_NOT_FOUND`、`DIRECTORY_NOT_FOUND`、`FILE_TYPE_MISMATCH` 报告同类状态时返回 `false`;Host
|
|
1127
1127
|
* stat 响应不是对象或 `kind` 不是 `'directory'` 时也按类型不匹配返回 `false`。不返回目录元数据、
|
|
1128
1128
|
* 句柄或缺失原因。
|
|
1129
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
1130
|
-
* `
|
|
1129
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 时返回
|
|
1130
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放或未协商到 `directory.exists`
|
|
1131
1131
|
* (底层要求 `files.stat`)时返回 `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。
|
|
1132
1132
|
* @throws {@link HbMiniProgramSDKError} 外部 direct directory handle 被撤销、不属于当前或已结束的
|
|
1133
1133
|
* Runtime session 时返回 `FILE_ACCESS_REVOKED`;Host 拒绝当前目录授权时返回 `FILE_ACCESS_DENIED`。
|
|
@@ -1206,8 +1206,8 @@ interface DirectoryHandle extends PathRoot {
|
|
|
1206
1206
|
* @throws {@link HbMiniProgramSDKError} 当前目录或任一祖先不存在时返回 `DIRECTORY_NOT_FOUND`,目标
|
|
1207
1207
|
* 实际是文件时返回 `FILE_TYPE_MISMATCH`;外部 direct Directory 授权失效、来自其他或已结束的
|
|
1208
1208
|
* Runtime session 时返回 `FILE_ACCESS_REVOKED`。
|
|
1209
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
1210
|
-
* `
|
|
1209
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 时返回
|
|
1210
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放或未协商到 `directory.list` 时返回
|
|
1211
1211
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。
|
|
1212
1212
|
* @throws {@link HbMiniProgramSDKError} Host 返回非数组、稀疏数组、非法 kind/name/mode/handle,或
|
|
1213
1213
|
* 子项不能安全派生为当前目录的直接后代时返回 `FILE_IO_FAILED`;其他 Host 枚举或底层 I/O 失败
|
|
@@ -1319,8 +1319,8 @@ interface FilesModule {
|
|
|
1319
1319
|
* @throws {@link HbMiniProgramSDKError} options、`mode`、`accept` 或 `multiple` 非法时返回
|
|
1320
1320
|
* `INVALID_PARAMS`;缺少当前可信用户手势时返回 `USER_GESTURE_REQUIRED`;用户取消系统选择器
|
|
1321
1321
|
* 时返回 `FILE_PICKER_CANCELLED`。
|
|
1322
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
1323
|
-
* `
|
|
1322
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 时返回
|
|
1323
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放/未协商到 `files.external` 时返回
|
|
1324
1324
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`;请求的 `readwrite` 未获 Host
|
|
1325
1325
|
* 授予时返回 `FILE_ACCESS_DENIED`。
|
|
1326
1326
|
* @throws {@link HbMiniProgramSDKError} 整批结果会让当前 session 的外部 direct handle 超过
|
|
@@ -1410,8 +1410,8 @@ interface FilesModule {
|
|
|
1410
1410
|
* @throws {@link HbMiniProgramSDKError} options 或 `mode` 非法时返回 `INVALID_PARAMS`;缺少当前
|
|
1411
1411
|
* 可信用户手势时返回 `USER_GESTURE_REQUIRED`;用户取消系统选择器时返回
|
|
1412
1412
|
* `FILE_PICKER_CANCELLED`。
|
|
1413
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
1414
|
-
* `
|
|
1413
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 时返回
|
|
1414
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放/未协商到 `files.external` 时返回
|
|
1415
1415
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`;请求的 `readwrite` 未获 Host
|
|
1416
1416
|
* 授予时返回 `FILE_ACCESS_DENIED`。
|
|
1417
1417
|
* @throws {@link HbMiniProgramSDKError} 当前 session 的外部 direct handle 达到 1024 上限时返回
|
|
@@ -1496,8 +1496,8 @@ interface FilesModule {
|
|
|
1496
1496
|
* @throws {@link HbMiniProgramSDKError} options 缺失/非对象、`suggestedName` 非字符串或不是规范
|
|
1497
1497
|
* basename、或传入 V1 不支持的 `accept` 时返回 `INVALID_PARAMS`;缺少当前可信用户手势时
|
|
1498
1498
|
* 返回 `USER_GESTURE_REQUIRED`;用户取消系统保存界面时返回 `FILE_PICKER_CANCELLED`。
|
|
1499
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
1500
|
-
* `
|
|
1499
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `filesystem` 时返回
|
|
1500
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放/未协商到保存 operation 时返回
|
|
1501
1501
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。目标已存在且 Host 不能独占创建
|
|
1502
1502
|
* 时返回 `FILE_ALREADY_EXISTS`,不会静默覆盖。
|
|
1503
1503
|
* @throws {@link HbMiniProgramSDKError} 当前 session 的外部 direct handle 达到 1024 上限时返回
|
|
@@ -1878,8 +1878,8 @@ interface MiniProgramNetworkModule {
|
|
|
1878
1878
|
* @throws {@link HbMiniProgramNetworkError} Host 已完成 HTTP 响应,但状态未通过
|
|
1879
1879
|
* `validateStatus` 时抛出;错误的 `status`、`data`、安全 `headers`、`config` 与 `response`
|
|
1880
1880
|
* 可用于业务分支。它不表示权限、bridge 或网络不可达。
|
|
1881
|
-
* @throws {@link HbMiniProgramSDKError} 配置/数据/Header 非法时返回 `INVALID_PARAMS
|
|
1882
|
-
*
|
|
1881
|
+
* @throws {@link HbMiniProgramSDKError} 配置/数据/Header 非法时返回 `INVALID_PARAMS`;当前运行快照
|
|
1882
|
+
* 缺少 `network` 时返回 `PERMISSION_NOT_IN_SNAPSHOT`;权限未启用或未获官方域名批准时返回
|
|
1883
1883
|
* `PERMISSION_DENIED`;Host 不支持请求形态时返回 `REQUEST_UNSUPPORTED`,Host/transport
|
|
1884
1884
|
* 失败返回 `REQUEST_FAILED`,Host 能力关闭或旧 Runtime 不认识 method 时可返回
|
|
1885
1885
|
* `METHOD_FORBIDDEN` / `METHOD_NOT_FOUND`,响应结构无效返回 `INVALID_NETWORK_RESPONSE`;
|
|
@@ -1956,8 +1956,8 @@ interface MiniProgramNetworkModule {
|
|
|
1956
1956
|
* @returns Host 完成原子提交后的 `readwrite` {@link FileHandle}。File target 返回传入的同一
|
|
1957
1957
|
* 代理;Directory target 返回目标目录中新建或替换的直接子 File 代理。
|
|
1958
1958
|
* @throws {@link HbMiniProgramSDKError} 参数、URL、Header、目标或 Host 返回值不合法时返回
|
|
1959
|
-
* `INVALID_PARAMS` / `INVALID_NETWORK_RESPONSE
|
|
1960
|
-
* 时返回 `
|
|
1959
|
+
* `INVALID_PARAMS` / `INVALID_NETWORK_RESPONSE`;当前运行快照缺少或未启用 `network`、`filesystem`
|
|
1960
|
+
* 时返回 `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 能力缺失时返回
|
|
1961
1961
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。
|
|
1962
1962
|
* @throws {@link HbMiniProgramSDKError} 非成功或部分 HTTP 响应返回 `DOWNLOAD_HTTP_STATUS`;
|
|
1963
1963
|
* 网络/响应 framing 失败、空闲超时、提交前取消或超出 `maxBytes` 分别返回
|
|
@@ -2079,10 +2079,12 @@ interface MiniProgramNetworkModule {
|
|
|
2079
2079
|
* `data` 仅作为可选调试信息,不保证结构稳定。错误码是跨 Host 的分支契约;
|
|
2080
2080
|
* `message` 只用于日志和开发者提示,不应作为机器判断条件。
|
|
2081
2081
|
*
|
|
2082
|
-
* 常见处理类别包括:`INVALID_PARAMS`(修正调用参数)、`
|
|
2083
|
-
|
|
2082
|
+
* 常见处理类别包括:`INVALID_PARAMS`(修正调用参数)、`PERMISSION_NOT_IN_SNAPSHOT`
|
|
2083
|
+
*(当前运行快照缺少权限,需发布含声明的新版本或重新打开调试)、
|
|
2084
|
+
* `PERMISSION_DENIED`(检查权限启用状态与平台批准)、`USER_GESTURE_REQUIRED`
|
|
2084
2085
|
*(改为用户点击后重试)、`AUTHORIZATION_CANCELLED`(结束当前流程),以及
|
|
2085
2086
|
* `METHOD_FORBIDDEN`(当前 Host 不支持该能力)。具体能力还可能返回模块专属错误码。
|
|
2087
|
+
* 旧 Runtime 仍可能返回 `PERMISSION_NOT_DECLARED`;SDK 会保留 Host 返回的错误码。
|
|
2086
2088
|
* 不要把所有错误都当作可重试错误,也不要把 `data` 当成稳定的序列化协议。
|
|
2087
2089
|
*
|
|
2088
2090
|
* @example
|
|
@@ -2490,8 +2492,8 @@ interface MiniProgramAuthModule {
|
|
|
2490
2492
|
* 实际授权 scope,不包含用户资料、`app_user_id`、access token、cookie 或应用密钥。
|
|
2491
2493
|
* @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`:`scopes` 不是数组、包含未知值或
|
|
2492
2494
|
* 重复值,或当前 Host 尚未启用请求的 `steam_account` scope。
|
|
2493
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
2494
|
-
*
|
|
2495
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` 或 `PERMISSION_DENIED`:
|
|
2496
|
+
* 当前运行快照缺少或未启用 `userInfo` 权限。
|
|
2495
2497
|
* @throws {@link HbMiniProgramSDKError} `SERVER_API_REQUIRED`:当前处于无网络的 `local`
|
|
2496
2498
|
* 模式,不能获取授权码;需要为当前版本启用有效网络权限。
|
|
2497
2499
|
* @throws {@link HbMiniProgramSDKError} `USER_GESTURE_REQUIRED`:本次需要展示黑盒登录或
|
|
@@ -2760,8 +2762,8 @@ interface MiniProgramUserModule {
|
|
|
2760
2762
|
* 支持 Steam 账号能力的 Host 还可能返回 `authorization.steam_account` 与
|
|
2761
2763
|
* `userInfo.steam_id`;授权与绑定状态应分别判断。
|
|
2762
2764
|
*
|
|
2763
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
2764
|
-
* `userInfo`
|
|
2765
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED` 表示
|
|
2766
|
+
* 当前运行快照缺少或未启用 `userInfo` 权限;`INVALID_STATE` 表示缺少 canonical 小程序身份;
|
|
2765
2767
|
* `REQUEST_FAILED` / `REQUEST_UNSUPPORTED` / `INVALID_RESPONSE` 表示 Host 或资料读取失败;
|
|
2766
2768
|
* `HEYBOX_APP_LOGIN_REQUIRED` 表示初次登录态检查后,Host 会话在隔离身份读取期间失效;
|
|
2767
2769
|
* `AUTHORIZATION_CONTEXT_CHANGED` 表示请求期间发生账号切换或授权撤销;
|
|
@@ -2906,8 +2908,8 @@ interface MiniProgramUserModule {
|
|
|
2906
2908
|
* `data` 为 `null`;两者均为 `true` 时返回游戏列表、`hasMore` 和 `nextOffset`。
|
|
2907
2909
|
* @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS` 表示存在未知字段,或参数类型、范围
|
|
2908
2910
|
* 不合法。
|
|
2909
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
2910
|
-
* `steamLibrary
|
|
2911
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED` 表示
|
|
2912
|
+
* 当前运行快照缺少或未启用 `steamLibrary`;`METHOD_FORBIDDEN` 表示当前 Host 缺少该能力依赖。
|
|
2911
2913
|
* @throws {@link HbMiniProgramSDKError} `INVALID_STATE` 表示缺少 canonical 小程序身份;
|
|
2912
2914
|
* `REQUEST_UNSUPPORTED` / `REQUEST_FAILED` / `INVALID_RESPONSE` 表示 Host 请求能力、Steam
|
|
2913
2915
|
* 请求或响应失败;`HEYBOX_APP_LOGIN_REQUIRED` 表示请求期间 Host 登录态失效。
|
|
@@ -3133,13 +3135,21 @@ interface MiniProgramScreenshotRect {
|
|
|
3133
3135
|
* 截图分享配置。
|
|
3134
3136
|
*
|
|
3135
3137
|
* @remarks
|
|
3136
|
-
*
|
|
3138
|
+
* 该配置只暴露截图、保存相册与水印主题字段,不暴露宿主内部上传、回调或其他样式扩展能力。
|
|
3137
3139
|
* 所有字段均可省略;省略整个配置等同于传入空配置,并在调用时截取当前可见窗口。
|
|
3138
3140
|
* JavaScript 调用在运行时传入 `null` 也会按空配置处理,但 TypeScript 调用方应直接省略参数。
|
|
3139
3141
|
*
|
|
3140
3142
|
* @see {@link MiniProgramShareModule.screenshot | share.screenshot}
|
|
3141
3143
|
*/
|
|
3142
3144
|
interface MiniProgramScreenshotOptions {
|
|
3145
|
+
/**
|
|
3146
|
+
* 按截图背景选择水印主题:`light` 用于浅色背景,显示黑色胶囊与 40% 黑色说明文字;
|
|
3147
|
+
* `dark` 用于深色背景,显示白色胶囊与 40% 白色说明文字。省略时默认为 `dark`,
|
|
3148
|
+
* 保持现有白色水印效果;不会自动跟随 App 或系统主题。其他值会以 `INVALID_PARAMS` 拒绝。
|
|
3149
|
+
*
|
|
3150
|
+
* @remarks 仅影响水印配色,不改变小程序页面主题;底部仍需预留至少 57 个逻辑像素。
|
|
3151
|
+
*/
|
|
3152
|
+
watermarkTheme?: 'light' | 'dark';
|
|
3143
3153
|
/**
|
|
3144
3154
|
* 指定截图区域;省略时截取调用时的整个可见窗口。
|
|
3145
3155
|
*
|
|
@@ -3234,8 +3244,8 @@ interface MiniProgramShareModule {
|
|
|
3234
3244
|
* `options.extra` 时生成不带扩展数据的链接。
|
|
3235
3245
|
* @returns Host 完成剪贴板写入后 resolve 的完整分享链接;返回字符串与剪贴板内容一致。
|
|
3236
3246
|
* @throws {@link HbMiniProgramSDKError} 参数、`extra` 编码或小程序身份不合法时返回
|
|
3237
|
-
* `INVALID_PARAMS
|
|
3238
|
-
* `
|
|
3247
|
+
* `INVALID_PARAMS`;当前运行快照缺少或未启用 `share` 权限时分别返回
|
|
3248
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` 或 `PERMISSION_DENIED`;当前 Host 未开放剪贴板能力时可返回
|
|
3239
3249
|
* `METHOD_FORBIDDEN` 或 `REQUEST_UNSUPPORTED`。握手、bridge 超时和其他 Host 写入失败会保留
|
|
3240
3250
|
* 对应错误码。
|
|
3241
3251
|
*
|
|
@@ -3344,8 +3354,8 @@ interface MiniProgramShareModule {
|
|
|
3344
3354
|
* trim 后为空,出现自定义 `url`,`imageUrl` 不是 HTTP(S),`channel` 不在公开枚举内,
|
|
3345
3355
|
* `extra` 超出编码限制,缺少 canonical 小程序身份/有效当前 URL,或开发态 `post` 无效、
|
|
3346
3356
|
* 超过一个分区、与 `channel` 冲突。
|
|
3347
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
3348
|
-
* `share`
|
|
3357
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED` 表示
|
|
3358
|
+
* 当前运行快照缺少或未启用 `share` 权限;`METHOD_FORBIDDEN` / `METHOD_NOT_FOUND` 表示当前 Host 未开放
|
|
3349
3359
|
* 分享面板;`REQUEST_UNSUPPORTED` 表示 Host 不支持当前分享参数或渠道。
|
|
3350
3360
|
* @throws {@link HbMiniProgramSDKError} `RUNTIME_DESTROYED` / `RUNTIME_UNAVAILABLE` /
|
|
3351
3361
|
* `SDK_DESTROYED` 表示 Runtime、容器或 SDK 已进入终态。SDK 握手失败或 Host 面板调用超时
|
|
@@ -3430,8 +3440,8 @@ interface MiniProgramShareModule {
|
|
|
3430
3440
|
* 除外),`rect` 不是对象或其坐标、尺寸经 `Number(...)` 转换后不是有效范围,`delay`
|
|
3431
3441
|
* 转换后不是非负有限数,
|
|
3432
3442
|
* `saveToAlbum` 不是布尔值,或开发 Runtime 中 `post` 含无效项时以 `INVALID_PARAMS`
|
|
3433
|
-
*
|
|
3434
|
-
* `
|
|
3443
|
+
* 拒绝。当前运行快照缺少或未启用 `share` 权限时分别以
|
|
3444
|
+
* `PERMISSION_NOT_IN_SNAPSHOT`、`PERMISSION_DENIED` 拒绝;当前 Host 未开放截图能力时以
|
|
3435
3445
|
* `METHOD_FORBIDDEN` 拒绝,不支持请求形状时可能以 `REQUEST_UNSUPPORTED` 拒绝。握手失败、
|
|
3436
3446
|
* SDK/Runtime 已销毁、bridge 超时或 Host 截图失败时抛出对应 SDK 错误。用户取消由
|
|
3437
3447
|
* Host 决定返回不透明结果还是错误,不能依赖统一形态。
|
|
@@ -3443,6 +3453,26 @@ interface MiniProgramShareModule {
|
|
|
3443
3453
|
* `pixelRatio` 换算,也不把越界矩形夹取到窗口内。JavaScript 的 coercible 非 number 值可能被
|
|
3444
3454
|
* 当前 Runtime 接受,但这不是 TypeScript 公共合同,不应依赖。
|
|
3445
3455
|
*
|
|
3456
|
+
* SDK 每次调用都会输出 warning,提醒水印行为变化及布局、配色要求;日志失败不阻断截图。
|
|
3457
|
+
* 新 Runtime 按 Version record 中已校验的 SDK 版本启用水印:低于正式版 `0.9.1`
|
|
3458
|
+
* (包括 `0.9.1-alpha.*`)或兼容模式下版本缺失时,静默保持无水印截图;
|
|
3459
|
+
* `0.9.1` 及以上默认添加水印。升级 SDK 前应同步调整截图布局。
|
|
3460
|
+
*
|
|
3461
|
+
* 启用水印时,Runtime 会在截图区域底部居中叠加「小黑盒 + 搜索图标 + 当前小程序名称」胶囊,
|
|
3462
|
+
* 下方显示灰色「小黑盒工坊小程序」。开发者应在目标截图区域底部预留至少 57 个逻辑
|
|
3463
|
+
* 像素的空白背景,不放置成绩、正文、按钮等重要内容,并保证背景与所选水印配色
|
|
3464
|
+
* 有足够对比度;自定义 `rect` 也按该区域的底部预留。水印不增加图片尺寸,只在本次
|
|
3465
|
+
* SDK 截图期间展示,完成、失败或终止后移除,不常驻业务页面。系统按键截图不属于
|
|
3466
|
+
* 此能力;开发者无需自行绘制水印,也不能通过截图参数关闭水印。
|
|
3467
|
+
*
|
|
3468
|
+
* `watermarkTheme` 按截图背景选择:`light` 用于浅色背景,显示黑色水印;`dark` 用于
|
|
3469
|
+
* 深色背景,显示白色水印。说明文字分别为 40% 黑色或白色。省略时默认为 `dark`,
|
|
3470
|
+
* 不自动跟随 App 或系统主题。该参数由宿主 Runtime 实现,旧 Runtime 可能忽略此字段。
|
|
3471
|
+
*
|
|
3472
|
+
* 截图不受 SDK 普通请求的固定超时限制;排队、延迟和成图等待由 Host 管理,
|
|
3473
|
+
* SDK/Runtime 终止时取消尚未投递的截图。Mobile Host 在延迟结束后才投递原生截图,
|
|
3474
|
+
* 并从投递时起最多等待 15 秒成图回调。已投递原生的截图无法保证撤回。
|
|
3475
|
+
*
|
|
3446
3476
|
* `delay` 省略时由 Host 使用默认延迟;`saveToAlbum` 省略时由 Host 决定是否提供相册
|
|
3447
3477
|
* 入口。`post` 会对分区 ID 和话题 trim、规范化及去重。截图分享允许多个分区;开发
|
|
3448
3478
|
* Runtime 对任一无效项返回 `INVALID_PARAMS`,生产 Runtime 过滤无效项,并在没有有效项
|
|
@@ -4099,8 +4129,8 @@ interface MiniProgramCloudLeaderboardModule {
|
|
|
4099
4129
|
* @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`:`options` 不是对象、含未知字段,
|
|
4100
4130
|
* key 不合法,score 缺失/非有限数字/超出安全范围,或 extra 不是对象、不可 JSON 序列化、
|
|
4101
4131
|
* 超过 2048 UTF-8 bytes。
|
|
4102
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
4103
|
-
*
|
|
4132
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`:当前运行快照
|
|
4133
|
+
* 缺少或未启用 `leaderboard`;`UNAUTHORIZED`:Host 未登录、服务端会话失效,或
|
|
4104
4134
|
* 请求期间登录账号发生变化。
|
|
4105
4135
|
* @throws {@link HbMiniProgramSDKError} `LEADERBOARD_DEFAULT_NOT_FOUND`:省略 key 但当前
|
|
4106
4136
|
* 小程序未创建 `default` 榜单;`LEADERBOARD_SUBMIT_LOCKED`:同一用户记录正在被另一提交
|
|
@@ -4185,8 +4215,8 @@ interface MiniProgramCloudLeaderboardModule {
|
|
|
4185
4215
|
* @returns 当前页 {@link LeaderboardEntry} 数组、可选下一页 cursor 和权威 `hasMore` 标记。
|
|
4186
4216
|
* @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`:`options` 不是对象、含未知字段,
|
|
4187
4217
|
* key 不符合 1 至 64 位 `[A-Za-z0-9_-]`,limit 不是 1 至 100 的整数,或 cursor 不是字符串。
|
|
4188
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
4189
|
-
*
|
|
4218
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`:当前运行快照
|
|
4219
|
+
* 缺少或未启用 `leaderboard` 权限。
|
|
4190
4220
|
* @throws {@link HbMiniProgramSDKError} `LEADERBOARD_DEFAULT_NOT_FOUND`:省略 key 但当前
|
|
4191
4221
|
* 小程序未创建 `default` 榜单。命名榜单不存在、cursor 失效或后端拒绝时保留服务端错误码。
|
|
4192
4222
|
* @throws {@link HbMiniProgramSDKError} `INVALID_STATE`:canonical 小程序身份未就绪;
|
|
@@ -4269,8 +4299,8 @@ interface MiniProgramCloudLeaderboardModule {
|
|
|
4269
4299
|
* 正常空结果。返回记录但 `ranked: false` 时记录仍存在,`rank` 固定为 `0`。
|
|
4270
4300
|
* @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`:`options` 不是对象、含 `key` 以外
|
|
4271
4301
|
* 的字段,或 key 不符合 1 至 64 位 `[A-Za-z0-9_-]` 规则。
|
|
4272
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
4273
|
-
*
|
|
4302
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`:当前运行快照
|
|
4303
|
+
* 缺少或未启用 `leaderboard`;`UNAUTHORIZED`:Host 未登录、服务端会话失效,或
|
|
4274
4304
|
* 请求期间登录账号发生变化。
|
|
4275
4305
|
* @throws {@link HbMiniProgramSDKError} `LEADERBOARD_DEFAULT_NOT_FOUND`:省略 key 但当前
|
|
4276
4306
|
* 小程序未创建 `default` 榜单。命名榜单不存在或后端拒绝时保留服务端错误码。
|
|
@@ -4355,8 +4385,8 @@ interface MiniProgramCloudLeaderboardModule {
|
|
|
4355
4385
|
* `deleted: false` 表示调用成功但已无记录,是幂等空结果。
|
|
4356
4386
|
* @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`:`options` 不是对象、含 `key` 以外
|
|
4357
4387
|
* 的字段,或 key 不符合 1 至 64 位 `[A-Za-z0-9_-]` 规则。
|
|
4358
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
4359
|
-
*
|
|
4388
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`:当前运行快照
|
|
4389
|
+
* 缺少或未启用 `leaderboard`;`UNAUTHORIZED`:Host 未登录、服务端会话失效,或
|
|
4360
4390
|
* 请求期间登录账号发生变化。
|
|
4361
4391
|
* @throws {@link HbMiniProgramSDKError} `LEADERBOARD_DEFAULT_NOT_FOUND`:省略 key 但当前
|
|
4362
4392
|
* 小程序未创建 `default` 榜单。命名榜单不存在或后端拒绝时保留服务端错误码。
|
|
@@ -4428,8 +4458,8 @@ interface MiniProgramCloudLeaderboardModule {
|
|
|
4428
4458
|
* 和列表展示上限 `rankLimit`。不返回榜单记录或当前用户数据。
|
|
4429
4459
|
* @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`:`options` 不是对象、含 `key` 以外
|
|
4430
4460
|
* 的字段,或 key 不符合 1 至 64 位 `[A-Za-z0-9_-]` 规则。
|
|
4431
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
4432
|
-
*
|
|
4461
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`:当前运行快照
|
|
4462
|
+
* 缺少或未启用 `leaderboard` 权限。
|
|
4433
4463
|
* @throws {@link HbMiniProgramSDKError} `LEADERBOARD_DEFAULT_NOT_FOUND`:省略 key 但当前
|
|
4434
4464
|
* 小程序未创建 `default` 榜单。命名榜单不存在或后端拒绝时保留服务端错误码。
|
|
4435
4465
|
* @throws {@link HbMiniProgramSDKError} `INVALID_STATE`:canonical 小程序身份未就绪;
|
|
@@ -4646,8 +4676,8 @@ interface CompanionStdio {
|
|
|
4646
4676
|
* @throws {@link HbMiniProgramSDKError} stdin 已由 {@link CompanionStdio.closeStdin | closeStdin()}
|
|
4647
4677
|
* 关闭、Session 不再提供 `stdio` 或通信管道不可用时返回 `COMPANION_PIPE_CLOSED`;进程异常退出
|
|
4648
4678
|
* 或因输出上限结束时还可能返回 `COMPANION_PROCESS_CRASHED` / `COMPANION_OUTPUT_LIMIT`。
|
|
4649
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
4650
|
-
* `
|
|
4679
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `companion` 权限时返回
|
|
4680
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放 `companion.session.write` 时返回
|
|
4651
4681
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。未知 Host 失败会脱敏并返回
|
|
4652
4682
|
* `COMPANION_HOST_FAILED`;SDK/Runtime 终止或请求超时还可能返回 `SDK_DESTROYED`、
|
|
4653
4683
|
* `RUNTIME_UNAVAILABLE`、`REQUEST_TIMEOUT`。
|
|
@@ -4748,8 +4778,8 @@ interface CompanionStdio {
|
|
|
4748
4778
|
* @throws {@link HbMiniProgramSDKError} stdin 已关闭、Session 不再提供 `stdio` 或通信管道不可用时
|
|
4749
4779
|
* 可返回 `COMPANION_PIPE_CLOSED`;进程异常退出或因输出上限结束时还可能返回
|
|
4750
4780
|
* `COMPANION_PROCESS_CRASHED` / `COMPANION_OUTPUT_LIMIT`。
|
|
4751
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
4752
|
-
* `
|
|
4781
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `companion` 权限时返回
|
|
4782
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放
|
|
4753
4783
|
* `companion.session.closeStdin` 时返回 `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。
|
|
4754
4784
|
* 未识别的 Host 失败会脱敏为 `COMPANION_HOST_FAILED`;SDK / Runtime 终止、不可用或请求超时还
|
|
4755
4785
|
* 可能返回 `SDK_DESTROYED`、`RUNTIME_UNAVAILABLE`、`REQUEST_TIMEOUT`。
|
|
@@ -5012,8 +5042,8 @@ interface CompanionAttachments {
|
|
|
5012
5042
|
* `COMPANION_SESSION_EXITED`;controller 已转移给其他 Runtime generation 时返回
|
|
5013
5043
|
* `COMPANION_SESSION_OWNERSHIP_LOST`。本地检查与 Host 打开之间存在竞态,Host 会用未公开的
|
|
5014
5044
|
* controller generation 再次校验当前调用。
|
|
5015
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
5016
|
-
* `
|
|
5045
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `companion` 权限时返回
|
|
5046
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放 `companion.openAttachment` 时返回
|
|
5017
5047
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。Host 不支持 Companion 或附件描述符
|
|
5018
5048
|
* 暂不可用时还可能返回 `COMPANION_UNSUPPORTED` / `COMPANION_DESCRIPTOR_UNAVAILABLE`。
|
|
5019
5049
|
* @throws {@link HbMiniProgramSDKError} 当前 Runtime session 的 direct handles 已达到 1024 上限时
|
|
@@ -5137,8 +5167,8 @@ interface CompanionNotifications {
|
|
|
5137
5167
|
* @throws {@link HbMiniProgramSDKError} 当前 Host、操作系统或 Session 无法展示通知时返回
|
|
5138
5168
|
* `COMPANION_NOTIFICATION_UNAVAILABLE`;Companion 不受支持、进程已异常退出或因输出上限结束时
|
|
5139
5169
|
* 还可能返回 `COMPANION_UNSUPPORTED`、`COMPANION_PROCESS_CRASHED`、`COMPANION_OUTPUT_LIMIT`。
|
|
5140
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
5141
|
-
* `
|
|
5170
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `companion` 权限时返回
|
|
5171
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放 `companion.showNotification` 时返回
|
|
5142
5172
|
* `METHOD_FORBIDDEN`,旧 Runtime 可返回 `METHOD_NOT_FOUND`。未知 Host 失败会脱敏为
|
|
5143
5173
|
* `COMPANION_HOST_FAILED`;SDK / Runtime 终止、不可用或请求超时还可能返回 `SDK_DESTROYED`、
|
|
5144
5174
|
* `RUNTIME_UNAVAILABLE`、`REQUEST_TIMEOUT`。
|
|
@@ -5234,8 +5264,8 @@ interface CompanionSession {
|
|
|
5234
5264
|
* `COMPANION_TERMINATE_FAILED` 拒绝;进程已异常退出、因输出上限结束或 Session 状态已变化时还
|
|
5235
5265
|
* 可能返回 `COMPANION_PROCESS_CRASHED`、`COMPANION_OUTPUT_LIMIT`、
|
|
5236
5266
|
* `COMPANION_SESSION_EXITED` 等对应稳定 Companion 错误码。
|
|
5237
|
-
* @throws {@link HbMiniProgramSDKError}
|
|
5238
|
-
* `
|
|
5267
|
+
* @throws {@link HbMiniProgramSDKError} 当前运行快照缺少或未启用 `companion` 权限时返回
|
|
5268
|
+
* `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`;Host 未开放
|
|
5239
5269
|
* `companion.session.terminate` 时返回 `METHOD_FORBIDDEN`,旧 Runtime 也可能返回
|
|
5240
5270
|
* `METHOD_NOT_FOUND`。未知 Host 失败会脱敏为 `COMPANION_HOST_FAILED`;SDK / Runtime 已终止、
|
|
5241
5271
|
* 不可用或请求超时时还可能返回 `SDK_DESTROYED`、`RUNTIME_UNAVAILABLE`、`REQUEST_TIMEOUT`。
|
|
@@ -5633,7 +5663,7 @@ interface MiniProgramCompanionModule {
|
|
|
5633
5663
|
* 描述符暂不可用或当前 Host 不支持能力时,可能以 `COMPANION_NOT_DECLARED`、
|
|
5634
5664
|
* `COMPANION_TARGET_UNSUPPORTED`、`COMPANION_PREVIEW_UNSUPPORTED`、
|
|
5635
5665
|
* `COMPANION_DESCRIPTOR_UNAVAILABLE`、`COMPANION_UNSUPPORTED` 或 `METHOD_FORBIDDEN` 拒绝。
|
|
5636
|
-
*
|
|
5666
|
+
* 当前运行快照缺少或未启用 `companion` 权限时分别以 `PERMISSION_NOT_IN_SNAPSHOT`、
|
|
5637
5667
|
* `PERMISSION_DENIED` 拒绝;Host 返回 alias 不匹配、未知 target/capability/source、非法大小
|
|
5638
5668
|
* 或签名状态时以 `COMPANION_HOST_FAILED` 拒绝。握手失败、SDK/Runtime 已销毁、bridge
|
|
5639
5669
|
* 超时及其他 Host 失败会保留对应 SDK 错误码。
|
|
@@ -5698,7 +5728,7 @@ interface MiniProgramCompanionModule {
|
|
|
5698
5728
|
* 描述符暂不可用或 Host 不支持该能力时,可能以 `COMPANION_NOT_DECLARED`、
|
|
5699
5729
|
* `COMPANION_TARGET_UNSUPPORTED`、`COMPANION_PREVIEW_UNSUPPORTED`、
|
|
5700
5730
|
* `COMPANION_DESCRIPTOR_UNAVAILABLE`、`COMPANION_UNSUPPORTED` 或 `METHOD_FORBIDDEN` 拒绝。
|
|
5701
|
-
*
|
|
5731
|
+
* 当前运行快照缺少或未启用 `companion` 权限时分别以 `PERMISSION_NOT_IN_SNAPSHOT`、
|
|
5702
5732
|
* `PERMISSION_DENIED` 拒绝;Host 返回未知 state、非法进度、非法 `preparedAt` 或失败摘要
|
|
5703
5733
|
* 时以 `COMPANION_HOST_FAILED` 拒绝。握手失败、SDK/Runtime 已销毁、bridge 超时及其他
|
|
5704
5734
|
* Host 失败会保留对应 SDK 错误码。
|
|
@@ -5785,7 +5815,7 @@ interface MiniProgramCompanionModule {
|
|
|
5785
5815
|
* 暂不可用或当前 Host 未开放能力时,可能以 `COMPANION_NOT_DECLARED`、
|
|
5786
5816
|
* `COMPANION_TARGET_UNSUPPORTED`、`COMPANION_PREVIEW_UNSUPPORTED`、
|
|
5787
5817
|
* `COMPANION_DESCRIPTOR_UNAVAILABLE`、`COMPANION_UNSUPPORTED` 或 `METHOD_FORBIDDEN` 拒绝。
|
|
5788
|
-
*
|
|
5818
|
+
* 当前运行快照缺少或未启用 `companion` 权限时分别以 `PERMISSION_NOT_IN_SNAPSHOT`、
|
|
5789
5819
|
* `PERMISSION_DENIED` 拒绝;Host 返回非法状态、进度或产物描述时以
|
|
5790
5820
|
* `COMPANION_HOST_FAILED` 拒绝。握手失败、SDK/Runtime 已销毁及其他 bridge 或 Host 失败
|
|
5791
5821
|
* 会保留对应 SDK 错误码。
|
|
@@ -5874,8 +5904,8 @@ interface MiniProgramCompanionModule {
|
|
|
5874
5904
|
* @throws {@link HbMiniProgramSDKError} alias 不符合格式时在请求前以 `INVALID_PARAMS`
|
|
5875
5905
|
* 拒绝;当前审核版本未声明该 alias、目标平台不匹配或 Host 不支持 Companion 时可能以
|
|
5876
5906
|
* `COMPANION_NOT_DECLARED`、`COMPANION_TARGET_UNSUPPORTED`、`COMPANION_UNSUPPORTED` 或
|
|
5877
|
-
* `METHOD_FORBIDDEN`
|
|
5878
|
-
* `
|
|
5907
|
+
* `METHOD_FORBIDDEN` 拒绝。当前运行快照缺少或未启用 `companion` 权限时分别以
|
|
5908
|
+
* `PERMISSION_NOT_IN_SNAPSHOT`、`PERMISSION_DENIED` 拒绝;握手失败、SDK/Runtime 已销毁、
|
|
5879
5909
|
* bridge 超时及其他 Host 失败会保留对应 SDK 错误码。
|
|
5880
5910
|
*
|
|
5881
5911
|
* @remarks
|
|
@@ -5942,7 +5972,7 @@ interface MiniProgramCompanionModule {
|
|
|
5942
5972
|
* 当前版本未声明 alias、当前平台没有匹配 target、预览 Host 不支持 Companion 或当前
|
|
5943
5973
|
* Host 未开放能力时,可能以 `COMPANION_NOT_DECLARED`、`COMPANION_TARGET_UNSUPPORTED`、
|
|
5944
5974
|
* `COMPANION_PREVIEW_UNSUPPORTED`、`COMPANION_UNSUPPORTED` 或 `METHOD_FORBIDDEN` 拒绝。
|
|
5945
|
-
*
|
|
5975
|
+
* 当前运行快照缺少或未启用 `companion` 权限时分别以 `PERMISSION_NOT_IN_SNAPSHOT`、
|
|
5946
5976
|
* `PERMISSION_DENIED` 拒绝;Host 返回非法 Session 快照时以 `COMPANION_HOST_FAILED` 拒绝,
|
|
5947
5977
|
* 同一 Session ID 的 alias、target 或 capability 集合发生不兼容变化时以
|
|
5948
5978
|
* `COMPANION_SESSION_VERSION_MISMATCH` 拒绝。握手失败、SDK/Runtime 已销毁及其他 bridge
|
|
@@ -6034,8 +6064,8 @@ interface MiniProgramCompanionModule {
|
|
|
6034
6064
|
* @throws {@link HbMiniProgramSDKError} alias 不符合格式时在请求前以 `INVALID_PARAMS`
|
|
6035
6065
|
* 拒绝;当前审核版本未声明 alias、目标平台不匹配或 Host 不支持时可能以
|
|
6036
6066
|
* `COMPANION_NOT_DECLARED`、`COMPANION_TARGET_UNSUPPORTED`、`COMPANION_UNSUPPORTED` 或
|
|
6037
|
-
* `METHOD_FORBIDDEN`
|
|
6038
|
-
* `
|
|
6067
|
+
* `METHOD_FORBIDDEN` 拒绝。当前运行快照缺少或未启用 `companion` 权限时分别以
|
|
6068
|
+
* `PERMISSION_NOT_IN_SNAPSHOT`、`PERMISSION_DENIED` 拒绝;Host 返回非法 Session 快照时以
|
|
6039
6069
|
* `COMPANION_HOST_FAILED` 拒绝,同一 Session ID 的 alias、target 或 capability 集合发生
|
|
6040
6070
|
* 不兼容变化时以 `COMPANION_SESSION_VERSION_MISMATCH` 拒绝。握手失败、SDK/Runtime 已
|
|
6041
6071
|
* 销毁、bridge 超时及其他 Host 失败会保留对应 SDK 错误码。
|
|
@@ -6185,8 +6215,8 @@ interface MiniProgramStorageModule {
|
|
|
6185
6215
|
* @typeParam T - 调用方期望的反序列化数据类型;SDK 不会在运行时校验该类型。
|
|
6186
6216
|
* @param options - 读取参数;`options.key` 必须符合 {@link GetStoragePayload.key} 的字符和长度约束。
|
|
6187
6217
|
* @returns Host 读取完成后 resolve 的结果。合法 JSON 会被反序列化;key 不存在或历史空串返回 `{ data: undefined }`,合法 JSON `null` 返回 `{ data: null }`,历史非 JSON 原始值返回原字符串。
|
|
6188
|
-
* @throws {@link HbMiniProgramSDKError} 参数非法时返回 `INVALID_PARAMS
|
|
6189
|
-
* `storage` 权限时分别返回 `
|
|
6218
|
+
* @throws {@link HbMiniProgramSDKError} 参数非法时返回 `INVALID_PARAMS`;当前运行快照缺少或未启用
|
|
6219
|
+
* `storage` 权限时分别返回 `PERMISSION_NOT_IN_SNAPSHOT` 或 `PERMISSION_DENIED`;canonical
|
|
6190
6220
|
* identity 尚未就绪时返回 `INVALID_STATE`;Host 不支持或禁用能力时可返回
|
|
6191
6221
|
* `METHOD_NOT_FOUND` 或 `METHOD_FORBIDDEN`。其他 bridge 与 Host 读取错误会保留对应错误码。
|
|
6192
6222
|
*
|
|
@@ -6238,9 +6268,9 @@ interface MiniProgramStorageModule {
|
|
|
6238
6268
|
* @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`:`options`、key 或 JSON 数据非法,
|
|
6239
6269
|
* 包括顶层 `undefined`、`BigInt`、循环引用或序列化过程抛错。
|
|
6240
6270
|
* @throws {@link HbMiniProgramSDKError} `STORAGE_QUOTA_EXCEEDED`:完整 JSON 字符串的 UTF-8
|
|
6241
|
-
* 字节数超过当前 Host
|
|
6242
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
6243
|
-
*
|
|
6271
|
+
* 字节数超过当前 Host 配额,或写入新 key 后当前小程序的不同 key 数量将超过 1000 个。
|
|
6272
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`:当前运行快照
|
|
6273
|
+
* 缺少或未启用 `storage`;`INVALID_STATE`:canonical 小程序身份尚未就绪。
|
|
6244
6274
|
* @throws {@link HbMiniProgramSDKError} `METHOD_NOT_FOUND` / `METHOD_FORBIDDEN`:当前 Host
|
|
6245
6275
|
* 不支持或禁用了该能力。其他握手、bridge、超时与 Host 写入失败会保留对应错误码。
|
|
6246
6276
|
* @throws `DOMException` 数据含函数、Symbol、自定义 `toJSON` 方法等不可 structured-clone
|
|
@@ -6710,8 +6740,8 @@ interface MiniProgramDeviceModule {
|
|
|
6710
6740
|
* @returns Host 确认系统剪贴板写入完成后 resolve `undefined`;不会返回或回读剪贴板内容。
|
|
6711
6741
|
* @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`:`options` 不是对象、包含 `text`
|
|
6712
6742
|
* 以外的字段,或 `text` 不是字符串、全为空白、超过 `10000` 个 UTF-16 code units。
|
|
6713
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
6714
|
-
*
|
|
6743
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`:当前运行快照
|
|
6744
|
+
* 缺少或未启用 `clipboard` 权限。
|
|
6715
6745
|
* @throws {@link HbMiniProgramSDKError} `METHOD_FORBIDDEN` / `METHOD_NOT_FOUND`:当前 Host
|
|
6716
6746
|
* 未开放或尚不认识该能力;Host 不支持本次写入形状时可返回 `REQUEST_UNSUPPORTED`。
|
|
6717
6747
|
* 其他握手、bridge 超时和 Host / 系统剪贴板失败会保留对应错误码。
|
|
@@ -6771,8 +6801,8 @@ interface MiniProgramDeviceModule {
|
|
|
6771
6801
|
* @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`:输入既不是非空字符串,也不是带非空
|
|
6772
6802
|
* 字符串 `protocol_type` 的 JSON 可序列化对象(含函数、`symbol`、`BigInt`、非有限数字或循环
|
|
6773
6803
|
* 引用时会失败),此时不会产生任何投递。
|
|
6774
|
-
* @throws {@link HbMiniProgramSDKError} `
|
|
6775
|
-
*
|
|
6804
|
+
* @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_IN_SNAPSHOT` / `PERMISSION_DENIED`:当前运行快照
|
|
6805
|
+
* 缺少 `appProtocol`,或该权限未启用/未获平台批准;不会产生协议副作用。
|
|
6776
6806
|
* @throws {@link HbMiniProgramSDKError} `METHOD_FORBIDDEN` / `METHOD_NOT_FOUND`:当前 Host 未
|
|
6777
6807
|
* 开放或尚不认识通用协议执行能力;旧 PC Host 属于此分支。Host 明确拒绝的协议也可能映射为
|
|
6778
6808
|
* 不支持错误。
|
|
@@ -155,6 +155,8 @@ interface MiniappManifest {
|
|
|
155
155
|
bindAppIds?: readonly string[];
|
|
156
156
|
/** 发布类别;历史读取可缺省,发布校验必须提供。 */
|
|
157
157
|
category?: MiniappCategory;
|
|
158
|
+
/** 简介,最多 200 个字符;未声明时简介页不展示。 */
|
|
159
|
+
desc?: string;
|
|
158
160
|
}
|
|
159
161
|
/**
|
|
160
162
|
* 判断小程序版本是否符合公开 Manifest 版本规则。
|
|
@@ -211,6 +213,7 @@ declare function isValidMiniappManifestVersion(version: string): boolean;
|
|
|
211
213
|
* 成功仅表示 Manifest 字段通过校验,不能替代文件检查与服务端发布预检。
|
|
212
214
|
*/
|
|
213
215
|
declare function validateMiniappManifestForDeploy(manifest: MiniappManifest): {
|
|
216
|
+
desc?: string | undefined;
|
|
214
217
|
category?: MiniappCategory | undefined;
|
|
215
218
|
bindAppIds?: readonly string[] | undefined;
|
|
216
219
|
window?: MiniappWindowDeclaration | undefined;
|