@heybox/hb-sdk 0.2.0-alpha.2 → 0.3.2
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/README.md +7 -6
- package/dist/cli.cjs +1119 -722
- package/dist/devtools/mock-host/index.html +78 -1
- package/dist/devtools/mock-host/main.js +378 -204
- package/dist/index.cjs.js +2 -14
- package/dist/index.esm.js +3 -2
- package/dist/miniapp-publish.cjs.js +6 -5
- package/dist/miniapp-publish.esm.js +6 -5
- package/dist/templates/vue3-vite-ts/README.md.ejs +3 -1
- package/dist/templates/vue3-vite-ts/package.json.ejs +5 -0
- package/dist/vite.cjs.js +54 -30
- package/dist/vite.esm.js +55 -31
- package/package.json +3 -4
- package/skill/SKILL.md +1 -1
- package/skill/references/api-root.md +16 -89
- package/skill/references/cli.md +6 -4
- package/skill/scripts/skill-metadata.mjs +4 -1
- package/skill/scripts/sync-references.mjs +1 -1
- package/skill/skill.json +4 -4
- package/types/core/client.d.ts +7 -16
- package/types/index.d.ts +2 -6
- package/types/miniapp-manifest/index.d.ts +2 -0
- package/types/miniapp-manifest/node.d.ts +1 -0
- package/types/miniapp-manifest/schema.d.ts +14 -0
- package/types/miniapp-publish/index.d.ts +1 -1
- package/types/skill-metadata.d.ts +6 -0
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ npm install
|
|
|
13
13
|
npm run dev
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
模板默认使用 Vue 3、Vite、TypeScript 和 npm。`npm run dev` 会启动小程序页面服务，并打开 `hb-sdk` 内置的浏览器 mock 宿主环境，适合在普通浏览器里调试 SDK 能力；调试页内可点击按钮在 Mac 版 APP 中启动同一页面。
|
|
16
|
+
模板默认使用 Vue 3、Vite、TypeScript 和 npm。`npm run dev` 会启动小程序页面服务，并打开 `hb-sdk` 内置的浏览器 mock 宿主环境，适合在普通浏览器里调试 SDK 能力；调试页内可点击按钮在 Mac 版 APP 中启动同一页面。Codex、VSCode 等内嵌浏览器可能无法转交 `heybox://` 协议；需要从调试页唤起 Mac 版 APP 时，请先在系统浏览器中打开调试页。
|
|
17
17
|
|
|
18
18
|
在已有项目中安装：
|
|
19
19
|
|
|
@@ -57,7 +57,7 @@ SDK 需要在黑盒小程序 iframe 容器内运行。父容器会为页面注
|
|
|
57
57
|
npm run dev
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
调试页会通过 iframe 加载本地页面并补齐小程序 bridge 环境；如果需要真实黑盒小程序容器加载同一页面，点击调试页里的「在 Mac 版 APP 中启动」按钮。
|
|
60
|
+
调试页会通过 iframe 加载本地页面并补齐小程序 bridge 环境；如果需要真实黑盒小程序容器加载同一页面，点击调试页里的「在 Mac 版 APP 中启动」按钮。Codex、VSCode 等内嵌浏览器可能无法唤起系统 APP；遇到这种情况时，请在系统浏览器中打开同一个调试页后重试。
|
|
61
61
|
|
|
62
62
|
在未使用脚手架的 Vite 项目中，可以把命令加到 `package.json`：
|
|
63
63
|
|
|
@@ -240,8 +240,9 @@ try {
|
|
|
240
240
|
}
|
|
241
241
|
```
|
|
242
242
|
2. 已运行过 `hb-sdk login` 登录 Heybox。
|
|
243
|
-
3.
|
|
244
|
-
4.
|
|
243
|
+
3. 如果需要以公司的名义发布小程序，需先找 @秦浩东 申请小程序开发权限。
|
|
244
|
+
4. 项目根有 `scripts.build`，会被 CLI 通过 lockfile 自动选用的 `pnpm`、`yarn` 或 `npm` 触发；无 lockfile 时回退 `npm`。
|
|
245
|
+
5. 构建产物落在 `dist/`，包含 `index.html` 和 `manifest.json`。
|
|
245
246
|
|
|
246
247
|
执行流程：
|
|
247
248
|
|
|
@@ -302,7 +303,7 @@ export default defineConfig({
|
|
|
302
303
|
|
|
303
304
|
- 读取 `package.json` 失败或 JSON 解析失败：`vite build` 直接失败，并输出具体原因。
|
|
304
305
|
- `package.json.version` 不是非空字符串：`vite build` 直接失败。
|
|
305
|
-
- `package.json.version` 仍是模板默认值 `0.0.0`：`vite build`
|
|
306
|
+
- `package.json.version` 仍是模板默认值 `0.0.0`：`vite build` 输出 warning 并写入 manifest；`hb-sdk deploy` 会拒绝发布，必须改成实际 `x.y.z` 版本。
|
|
306
307
|
- 版本号不满足极简 semver 形态 `x.y.z`：只输出 Rollup/Vite warning，仍会写入 manifest。
|
|
307
308
|
|
|
308
309
|
`manifest.json` 不部署到 CDN，只交给发布流水线读取后上送后台；Host 通过后台 API 间接读取版本信息。第一阶段只支持 Vite 项目，非 Vite 打包器未来通过其他子入口扩展。
|
|
@@ -319,7 +320,7 @@ export default defineConfig({
|
|
|
319
320
|
- `HbMiniProgramSDKError`、`HbMiniProgramNetworkError`
|
|
320
321
|
- 各模块公开类型，例如 `MiniProgramNetworkRequestConfig`、`MiniProgramNetworkResponse`、`MiniProgramUserInfoResult`
|
|
321
322
|
|
|
322
|
-
|
|
323
|
+
协议常量、消息类型、能力目录、payload/result 映射和守卫只通过 `@heybox/hb-sdk/protocol` 子入口导出。iframe 小程序业务代码不应构造 raw bridge message，也不应直接处理 nonce 或 `postMessage` 信封；宿主运行时等非业务页面代码使用 `@heybox/hb-sdk/protocol`。
|
|
323
324
|
|
|
324
325
|
构建时插件 `miniappManifest` 通过 `@heybox/hb-sdk/vite` 子入口导出，仅供 `vite.config.ts` 使用，不应在小程序业务代码里 import。
|
|
325
326
|
|