@heybox/hb-sdk 0.4.3 → 0.4.4

package/README.md

@@ -1,6 +1,6 @@
 # @heybox/hb-sdk
 
-黑盒外部小程序前端 SDK。业务页面运行在黑盒父容器创建的 iframe 沙盒中，通过这个 SDK 等待容器 ready、获取登录态、唤起登录、分享、读取窗口信息、使用隔离 storage，以及发起受控网络请求。
+黑盒外部小程序前端 SDK。业务页面运行在黑盒父容器创建的 iframe 沙盒中，通过这个 SDK 等待容器 ready、获取登录态、唤起登录、分享、展示基础 UI、使用设备能力、控制容器导航、读取窗口信息、使用隔离 storage，以及发起受控网络请求。
 
 ## 快速开始
 
@@ -110,6 +110,53 @@ await share.screenshot({
 });
 ```
 
+### 基础 UI
+
+```ts
+import { ui } from '@heybox/hb-sdk';
+
+await ui.showToast({
+  message: '保存成功',
+  status: 'success',
+});
+
+await ui.showLoading({
+  dismissible: true,
+});
+
+await ui.hideLoading();
+```
+
+`showToast()` 的 `message` 会 trim 后发送给宿主，不能为空，最长 120 个字符；`status` 只支持 `success` 和 `error`，不传时展示普通文本 toast。loading 是全局单例，多次 `showLoading()` 会覆盖当前配置，`hideLoading()` 在未展示时也会成功。
+
+### 设备能力
+
+```ts
+import { device } from '@heybox/hb-sdk';
+
+await device.vibrate({
+  intensity: 'light',
+  delay: 0,
+});
+
+await device.setClipboard({
+  text: 'hello',
+});
+```
+
+`vibrate()` 的 `intensity` 默认为 `light`，还支持 `medium` 和 `heavy`；`delay` 默认为 `0`，必须是 `0..5000` 的整数毫秒。`setClipboard()` 第一版只支持文本写入，`text` 必须是非空字符串，最长 10000 个字符，不会自动 trim 写入内容，也不提供读取或清空剪贴板能力。
+
+### 导航控制
+
+```ts
+import { navigation } from '@heybox/hb-sdk';
+
+await navigation.reload();
+await navigation.close();
+```
+
+`navigation.close()` 请求宿主关闭当前小程序容器，`navigation.reload()` 请求宿主重载当前小程序页面/容器。调用后 JS 上下文可能被宿主销毁，不保证后续代码继续执行；这两个能力不接受 `reason`、`force`、`confirm` 或 `fallbackUrl` 等扩展参数。
+
 ### 窗口信息
 
 ```ts
@@ -307,7 +354,7 @@ CLI 登录态只供 CLI 命令访问黑盒接口时复用，不会注入 iframe
 
 - 调用模块能力前会自动等待 `ready()`，但业务仍建议在页面启动阶段显式 `await ready()`，便于集中处理握手失败。
 - `user.getInfo()` 不会触发登录；登录必须由业务在用户操作后调用 `auth.login()`。
-- 分享、截图、storage 和网络请求只开放稳定窄接口，不透传黑盒客户端内部协议参数。
+- 分享、截图、UI、设备、导航、storage 和网络请求只开放稳定窄接口，不透传黑盒客户端内部协议参数。
 - `network.request()` 的 `validateStatus` 只在 SDK 本地执行，不会被序列化给父容器。
 - `on()` 返回取消监听函数；组件卸载或页面销毁时应主动取消监听。
 - 使用 `createMiniProgramSDK()` 创建独立实例后，不再需要时应调用 `destroy()`。
@@ -348,12 +395,12 @@ export default defineConfig({
 
 ## 导出
 
-默认导出 `hbSDK`，包含 `ready`、`on`、`off`、`auth`、`user`、`share`、`viewport`、`storage`、`network`。
+默认导出 `hbSDK`，包含 `ready`、`on`、`off`、`auth`、`user`、`share`、`viewport`、`storage`、`network`、`ui`、`device`、`navigation`。
 
 常用命名导出：
 
 - `ready`、`on`、`off`
-- `auth`、`user`、`share`、`viewport`、`storage`、`network`
+- `auth`、`user`、`share`、`viewport`、`storage`、`network`、`ui`、`device`、`navigation`
 - `createMiniProgramSDK`、`MiniProgramSDK`
 - `HbMiniProgramSDKError`、`HbMiniProgramNetworkError`
 - 各模块公开类型，例如 `MiniProgramNetworkRequestConfig`、`MiniProgramNetworkResponse`、`MiniProgramUserInfoResult`

package/dist/cli-chunks/{create-BV4h2BTs.cjs → create-DAW1oAnH.cjs}

@@ -5,7 +5,7 @@ var fs = require('node:fs/promises');
 var path = require('node:path');
 var require$$0 = require('fs');
 var require$$1 = require('path');
-var index = require('./index-ovy_xoLn.cjs');
+var index = require('./index-Bboot1us.cjs');
 require('node:module');
 require('os');
 require('readline');

package/dist/cli-chunks/{deploy-Bz0-WpHy.cjs → deploy-BaLyuR1X.cjs}

@@ -5,8 +5,8 @@ var fs = require('node:fs');
 var fs$1 = require('node:fs/promises');
 var path = require('node:path');
 var promises = require('node:readline/promises');
-var session = require('./session-BQs0wf65.cjs');
-var index = require('./index-ovy_xoLn.cjs');
+var session = require('./session-DiyDXvXu.cjs');
+var index = require('./index-Bboot1us.cjs');
 var node_crypto = require('node:crypto');
 
 var re = {exports: {}};
@@ -3328,7 +3328,7 @@ async function createDefaultCosClient(uploadToken) {
     };
 }
 async function loadCosConstructor() {
-    const cosModule = await Promise.resolve().then(function () { return require('./index-DQAFCtK1.cjs'); }).then(function (n) { return n.index; });
+    const cosModule = await Promise.resolve().then(function () { return require('./index-D7-awGYB.cjs'); }).then(function (n) { return n.index; });
     return cosModule.default;
 }
 function formatSize(bytes) {

package/dist/cli-chunks/{dev-DgX88vaK.cjs → dev-BA_4fnzO.cjs}

@@ -9,7 +9,7 @@ var node_url = require('node:url');
 var net = require('node:net');
 var node_http = require('node:http');
 var browser = require('./browser-RAy8e8cV.cjs');
-var index = require('./index-ovy_xoLn.cjs');
+var index = require('./index-Bboot1us.cjs');
 require('node:process');
 require('node:buffer');
 require('node:util');

package/dist/cli-chunks/{doctor-BIZoQ6go.cjs → doctor-Bbv8Lzu_.cjs}

@@ -4,7 +4,7 @@ var fs$1 = require('node:fs');
 var fs = require('node:fs/promises');
 var os = require('node:os');
 var path = require('node:path');
-var index = require('./index-ovy_xoLn.cjs');
+var index = require('./index-Bboot1us.cjs');
 require('node:module');
 require('path');
 require('os');

package/dist/cli-chunks/{index-ovy_xoLn.cjs → index-Bboot1us.cjs}

@@ -234,19 +234,19 @@ function requireArgument () {
 
 var command = {};
 
-const require$5 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli-chunks/index-ovy_xoLn.cjs', document.baseURI).href)));
+const require$5 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli-chunks/index-Bboot1us.cjs', document.baseURI).href)));
 function __require$4() { return require$5("node:events"); }
 
-const require$4 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli-chunks/index-ovy_xoLn.cjs', document.baseURI).href)));
+const require$4 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli-chunks/index-Bboot1us.cjs', document.baseURI).href)));
 function __require$3() { return require$4("node:child_process"); }
 
-const require$3 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli-chunks/index-ovy_xoLn.cjs', document.baseURI).href)));
+const require$3 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli-chunks/index-Bboot1us.cjs', document.baseURI).href)));
 function __require$2() { return require$3("node:path"); }
 
-const require$2 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli-chunks/index-ovy_xoLn.cjs', document.baseURI).href)));
+const require$2 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli-chunks/index-Bboot1us.cjs', document.baseURI).href)));
 function __require$1() { return require$2("node:fs"); }
 
-const require$1 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli-chunks/index-ovy_xoLn.cjs', document.baseURI).href)));
+const require$1 = node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli-chunks/index-Bboot1us.cjs', document.baseURI).href)));
 function __require() { return require$1("node:process"); }
 
 var help = {};
@@ -13092,7 +13092,7 @@ function readErrorMessage(error, options = {}) {
 }
 
 const CLI_VERSION_PLACEHOLDER = ['__HB', 'SDK', 'CLI', 'VERSION__'].join('_');
-const BUILT_CLI_VERSION = '0.4.3';
+const BUILT_CLI_VERSION = '0.4.4';
 const PACKAGE_JSON_CANDIDATES = [
     path.resolve(__dirname, '..', '..', 'package.json'),
     path.resolve(__dirname, '..', 'package.json'),
@@ -13249,31 +13249,31 @@ function createCommandLoggerResolver(options) {
     };
 }
 const defaultClearLoginStatus = async (...args) => {
-    const { clearLoginStatus } = await Promise.resolve().then(function () { return require('./login-CoZhlwxt.cjs'); });
+    const { clearLoginStatus } = await Promise.resolve().then(function () { return require('./login-BQo2pIkq.cjs'); });
     return clearLoginStatus(...args);
 };
 const defaultLoginToHeybox = async (...args) => {
-    const { loginToHeybox } = await Promise.resolve().then(function () { return require('./login-CoZhlwxt.cjs'); });
+    const { loginToHeybox } = await Promise.resolve().then(function () { return require('./login-BQo2pIkq.cjs'); });
     return loginToHeybox(...args);
 };
 const defaultPrintLoginStatus = async (...args) => {
-    const { printLoginStatus } = await Promise.resolve().then(function () { return require('./login-CoZhlwxt.cjs'); });
+    const { printLoginStatus } = await Promise.resolve().then(function () { return require('./login-BQo2pIkq.cjs'); });
     return printLoginStatus(...args);
 };
 const defaultRunCreateCommand = async (...args) => {
-    const { runCreateCommand } = await Promise.resolve().then(function () { return require('./create-BV4h2BTs.cjs'); });
+    const { runCreateCommand } = await Promise.resolve().then(function () { return require('./create-DAW1oAnH.cjs'); });
     return runCreateCommand(...args);
 };
 const defaultRunDeployCommand = async (...args) => {
-    const { runDeployCommand } = await Promise.resolve().then(function () { return require('./deploy-Bz0-WpHy.cjs'); }).then(function (n) { return n.deploy; });
+    const { runDeployCommand } = await Promise.resolve().then(function () { return require('./deploy-BaLyuR1X.cjs'); }).then(function (n) { return n.deploy; });
     return runDeployCommand(...args);
 };
 const defaultRunDevCommand = async (...args) => {
-    const { runDevCommand } = await Promise.resolve().then(function () { return require('./dev-DgX88vaK.cjs'); });
+    const { runDevCommand } = await Promise.resolve().then(function () { return require('./dev-BA_4fnzO.cjs'); });
     return runDevCommand(...args);
 };
 const defaultRunDoctorCommand = async (...args) => {
-    const { runDoctorCommand } = await Promise.resolve().then(function () { return require('./doctor-BIZoQ6go.cjs'); });
+    const { runDoctorCommand } = await Promise.resolve().then(function () { return require('./doctor-Bbv8Lzu_.cjs'); });
     return runDoctorCommand(...args);
 };
 function resolveStandaloneLogger(options, verbose) {

package/dist/cli-chunks/{index-DQAFCtK1.cjs → index-D7-awGYB.cjs}

@@ -1,13 +1,13 @@
 'use strict';
 
-var index$2 = require('./index-ovy_xoLn.cjs');
+var index$2 = require('./index-Bboot1us.cjs');
 var require$$0$2 = require('fs');
 var require$$2$1 = require('crypto');
 var require$$1$2 = require('path');
 var require$$0$3 = require('assert');
 var require$$4$2 = require('events');
 var require$$1$1 = require('util');
-var deploy = require('./deploy-Bz0-WpHy.cjs');
+var deploy = require('./deploy-BaLyuR1X.cjs');
 var require$$0$5 = require('net');
 var require$$0$4 = require('url');
 var require$$2$2 = require('http');

package/dist/cli-chunks/{login-CoZhlwxt.cjs → login-BQo2pIkq.cjs}

@@ -2,9 +2,9 @@
 
 var node_crypto = require('node:crypto');
 var node_http = require('node:http');
-var session = require('./session-BQs0wf65.cjs');
+var session = require('./session-DiyDXvXu.cjs');
 var browser = require('./browser-RAy8e8cV.cjs');
-var index = require('./index-ovy_xoLn.cjs');
+var index = require('./index-Bboot1us.cjs');
 require('node:path');
 require('fs');
 require('constants');

package/dist/cli-chunks/{session-BQs0wf65.cjs → session-DiyDXvXu.cjs}

@@ -1,7 +1,7 @@
 'use strict';
 
 var path = require('node:path');
-var index = require('./index-ovy_xoLn.cjs');
+var index = require('./index-Bboot1us.cjs');
 var require$$0$2 = require('fs');
 var require$$0 = require('constants');
 var require$$0$1 = require('stream');

package/dist/cli.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var index = require('./cli-chunks/index-ovy_xoLn.cjs');
+var index = require('./cli-chunks/index-Bboot1us.cjs');
 require('node:module');
 require('node:fs');
 require('node:fs/promises');