@heybox/hb-sdk 0.3.3 → 0.4.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/README.md +63 -28
- package/dist/cli-chunks/browser-RAy8e8cV.cjs +635 -0
- package/dist/cli-chunks/create-Ds8A82lV.cjs +1376 -0
- package/dist/cli-chunks/deploy-D4uxwB2W.cjs +3730 -0
- package/dist/cli-chunks/dev-v-tcA7mM.cjs +955 -0
- package/dist/cli-chunks/doctor-C8NP7bow.cjs +186 -0
- package/dist/cli-chunks/index-BWrMUHh9.cjs +64023 -0
- package/dist/cli-chunks/index-DDqd9qAR.cjs +13348 -0
- package/dist/cli-chunks/login-BJVOo-hq.cjs +193 -0
- package/dist/cli-chunks/session-Iyxc2AGl.cjs +3040 -0
- package/dist/cli.cjs +19 -77707
- package/dist/devtools/mock-host/index.html +62 -2
- package/dist/devtools/mock-host/main.js +3246 -20
- package/dist/index.cjs.js +20 -0
- package/dist/index.esm.js +20 -0
- package/dist/miniapp-publish.cjs.js +2810 -4
- package/dist/miniapp-publish.esm.js +2809 -4
- package/dist/protocol.cjs.js +15 -0
- package/dist/protocol.esm.js +15 -1
- package/dist/templates/vue3-vite-ts/README.md.ejs +6 -2
- package/dist/vite.cjs.js +2814 -14
- package/dist/vite.esm.js +2814 -14
- package/package.json +6 -1
- package/skill/SKILL.md +19 -13
- package/skill/references/api-protocol.md +7 -2
- package/skill/references/api-root.md +24 -13
- package/skill/references/cli.md +339 -104
- package/skill/scripts/sync-references.mjs +17 -1
- package/skill/skill.json +4 -4
- package/types/index.d.ts +1 -1
- package/types/miniapp-manifest/schema.d.ts +2 -1
- package/types/miniapp-publish/index.d.ts +2 -1
- package/types/modules/viewport/index.d.ts +33 -0
- package/types/protocol/capabilities.d.ts +17 -2
- package/types/protocol.d.ts +2 -2
package/dist/protocol.cjs.js
CHANGED
|
@@ -61,6 +61,13 @@ const SHARE_SCREENSHOT_METHOD = 'share.screenshot';
|
|
|
61
61
|
* 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
|
|
62
62
|
*/
|
|
63
63
|
const VIEWPORT_GET_WINDOW_INFO_METHOD = 'viewport.getWindowInfo';
|
|
64
|
+
/**
|
|
65
|
+
* 设置导航栏样式能力方法名。
|
|
66
|
+
*
|
|
67
|
+
* @remarks
|
|
68
|
+
* 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
|
|
69
|
+
*/
|
|
70
|
+
const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD = 'viewport.setNavigationBarStyle';
|
|
64
71
|
/**
|
|
65
72
|
* 读取小程序隔离 storage 能力方法名。
|
|
66
73
|
*
|
|
@@ -124,6 +131,13 @@ const MINI_PROGRAM_PROTOCOL_CAPABILITIES = [
|
|
|
124
131
|
permission: 'viewport.windowInfo',
|
|
125
132
|
risk: 'low',
|
|
126
133
|
},
|
|
134
|
+
{
|
|
135
|
+
method: VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD,
|
|
136
|
+
module: 'viewport',
|
|
137
|
+
capability: VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD,
|
|
138
|
+
permission: 'viewport.navigationBarStyle',
|
|
139
|
+
risk: 'low',
|
|
140
|
+
},
|
|
127
141
|
{
|
|
128
142
|
method: STORAGE_GET_STORAGE_METHOD,
|
|
129
143
|
module: 'storage',
|
|
@@ -160,4 +174,5 @@ exports.STORAGE_GET_STORAGE_METHOD = STORAGE_GET_STORAGE_METHOD;
|
|
|
160
174
|
exports.STORAGE_SET_STORAGE_METHOD = STORAGE_SET_STORAGE_METHOD;
|
|
161
175
|
exports.USER_GET_INFO_METHOD = USER_GET_INFO_METHOD;
|
|
162
176
|
exports.VIEWPORT_GET_WINDOW_INFO_METHOD = VIEWPORT_GET_WINDOW_INFO_METHOD;
|
|
177
|
+
exports.VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD = VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD;
|
|
163
178
|
exports.isMiniProgramBridgeMessage = isMiniProgramBridgeMessage;
|
package/dist/protocol.esm.js
CHANGED
|
@@ -59,6 +59,13 @@ const SHARE_SCREENSHOT_METHOD = 'share.screenshot';
|
|
|
59
59
|
* 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
|
|
60
60
|
*/
|
|
61
61
|
const VIEWPORT_GET_WINDOW_INFO_METHOD = 'viewport.getWindowInfo';
|
|
62
|
+
/**
|
|
63
|
+
* 设置导航栏样式能力方法名。
|
|
64
|
+
*
|
|
65
|
+
* @remarks
|
|
66
|
+
* 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
|
|
67
|
+
*/
|
|
68
|
+
const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD = 'viewport.setNavigationBarStyle';
|
|
62
69
|
/**
|
|
63
70
|
* 读取小程序隔离 storage 能力方法名。
|
|
64
71
|
*
|
|
@@ -122,6 +129,13 @@ const MINI_PROGRAM_PROTOCOL_CAPABILITIES = [
|
|
|
122
129
|
permission: 'viewport.windowInfo',
|
|
123
130
|
risk: 'low',
|
|
124
131
|
},
|
|
132
|
+
{
|
|
133
|
+
method: VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD,
|
|
134
|
+
module: 'viewport',
|
|
135
|
+
capability: VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD,
|
|
136
|
+
permission: 'viewport.navigationBarStyle',
|
|
137
|
+
risk: 'low',
|
|
138
|
+
},
|
|
125
139
|
{
|
|
126
140
|
method: STORAGE_GET_STORAGE_METHOD,
|
|
127
141
|
module: 'storage',
|
|
@@ -145,4 +159,4 @@ const MINI_PROGRAM_PROTOCOL_CAPABILITIES = [
|
|
|
145
159
|
},
|
|
146
160
|
];
|
|
147
161
|
|
|
148
|
-
export { AUTH_LOGIN_METHOD, MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NETWORK_REQUEST_METHOD, SDK_HANDSHAKE_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, USER_GET_INFO_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, isMiniProgramBridgeMessage };
|
|
162
|
+
export { AUTH_LOGIN_METHOD, MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NETWORK_REQUEST_METHOD, SDK_HANDSHAKE_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, USER_GET_INFO_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, isMiniProgramBridgeMessage };
|
|
@@ -13,11 +13,15 @@ npm run build
|
|
|
13
13
|
npm run deploy
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
+
## 依赖说明
|
|
17
|
+
|
|
18
|
+
`@heybox/hb-sdk` 是小程序页面运行时会 import 的 SDK,因此模板把它放在 `dependencies`。Vite、TypeScript、Vitest 等只参与本地开发、测试或构建的工具放在 `devDependencies`。
|
|
19
|
+
|
|
16
20
|
## 开发模式
|
|
17
21
|
|
|
18
|
-
- `npm run dev`:启动本地 Vite 服务和 `hb-sdk` 内置 mock runtime host,适合本地调试 SDK 能力;调试页内可点击按钮在 Mac 版 APP
|
|
22
|
+
- `npm run dev`:启动本地 Vite 服务和 `hb-sdk` 内置 mock runtime host,适合本地调试 SDK 能力;调试页内可点击按钮在 Mac 版 APP 中启动同一页面,也可以选择局域网网卡后用手机小黑盒 APP 扫码调试。手机需要与电脑处在同一局域网,并使用支持小程序调试壳的新版小黑盒 APP。Codex、VSCode 等内嵌浏览器可能无法唤起系统 APP,需要时请在系统浏览器中打开同一个调试页后重试。
|
|
19
23
|
- `npm run build`:先执行 TypeScript 检查,再构建生产产物。
|
|
20
|
-
- `npm run deploy
|
|
24
|
+
- `npm run deploy -- --release-note "..."`:构建、上传并提交当前小程序版本审核。部署前需要先把 `package.json` 中的 `heybox.miniProgramId` 改成后台分配的真实小程序 id,并执行过 `npx hb-sdk login`;默认审核通过后需在开放平台手动发布,如需审核通过后自动发布可追加 `--auto-publish`。
|
|
21
25
|
|
|
22
26
|
## 更多能力
|
|
23
27
|
|