@heybox/hb-sdk 0.8.1-alpha.1 → 0.8.1-alpha.3
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 +12 -0
- package/README.md +32 -3
- package/dist/cli-chunks/{build-kMLIWqWY.cjs → build-B5Sbi8Sq.cjs} +13 -9
- package/dist/cli-chunks/{context-CzFFRcL4.cjs → context-DuxaBL3Y.cjs} +2 -2
- package/dist/cli-chunks/{create-0ow6gA9w.cjs → create-CIfZrg3F.cjs} +1 -1
- package/dist/cli-chunks/{dev-CPBPdpyu.cjs → dev-CFubP5kW.cjs} +10 -9
- package/dist/cli-chunks/{doctor-DQ8ctFKC.cjs → doctor-IPKn3PBn.cjs} +1 -1
- package/dist/cli-chunks/{index-Buner4kE.cjs → index-DCJN-V1y.cjs} +15 -15
- package/dist/cli-chunks/{index-RDcIrvwi.cjs → index-KHhdZ8eZ.cjs} +2 -2
- package/dist/cli-chunks/{index.esm-qwrdRuy-.cjs → index.esm-8hgZlNF8.cjs} +7 -7
- package/dist/cli-chunks/{login-DoduAO_f.cjs → login-CoB9jXxC.cjs} +2 -2
- package/dist/cli-chunks/{project-vite-B-sK-qup.cjs → project-vite-DMxdOWsU.cjs} +1 -1
- package/dist/cli-chunks/{remote-CF_SRmnj.cjs → remote-D4ZcngLn.cjs} +14 -10
- package/dist/cli-chunks/{runtime-gate-FseEYZze.cjs → runtime-gate-BWb8QIcX.cjs} +0 -107
- package/dist/cli-chunks/{runtime-permission-env-DdQtxdut.cjs → runtime-permission-env-XAZFauvZ.cjs} +125 -9
- package/dist/cli-chunks/{session-DHbw2Xgh.cjs → session-BnoHxzFq.cjs} +1 -1
- package/dist/cli-chunks/{skill-6IVv12JW.cjs → skill-CDEJtATn.cjs} +2 -2
- package/dist/cli-chunks/{version-TXwWxKvv.cjs → version-BGzCIQhE.cjs} +1 -1
- package/dist/cli.cjs +1 -1
- package/dist/devtools/browser-dev-host/assets/browser-dev-host-DzEst9n7.js +99 -0
- package/dist/devtools/browser-dev-host/assets/{index-C5MZZDa5.js → index-B-NHlLsr.js} +2 -2
- package/dist/devtools/browser-dev-host/index.html +1 -1
- package/dist/index.cjs.js +83 -2
- package/dist/index.esm.js +83 -3
- package/dist/templates/vanilla-vite-js/README.md.ejs +1 -1
- package/dist/templates/vanilla-vite-js/package.json.ejs +1 -0
- package/dist/templates/vanilla-vite-js/vite.config.js +1 -1
- package/dist/vite.cjs.js +19 -10
- package/dist/vite.esm.js +19 -10
- package/package.json +7 -7
- package/skill/SKILL.md +5 -2
- package/skill/references/api-protocol.md +8 -4
- package/skill/references/api-root.md +114 -12
- package/skill/references/cli.md +2 -2
- package/skill/references/examples.md +9 -1
- package/skill/references/recipes.md +1 -0
- package/skill/references/safety-boundaries.md +1 -1
- package/skill/skill.json +5 -5
- package/types/core/client.d.ts +7 -1
- package/types/core/sdk.d.ts +3 -0
- package/types/core/singleton.d.ts +3 -0
- package/types/index.d.ts +3 -1
- package/types/miniapp-manifest/node.d.ts +2 -0
- package/types/miniapp-manifest/schema.d.ts +1 -0
- package/types/modules/environment/index.d.ts +70 -0
- package/types/protocol.d.ts +1 -1
- package/types/vite/index.d.ts +1 -4
- package/dist/devtools/browser-dev-host/assets/browser-dev-host-TzYf9L6C.js +0 -99
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
- packages/hb-sdk/src/vite/index.ts
|
|
10
10
|
- packages/hb-sdk/README.md
|
|
11
11
|
- apps/docs/hb-sdk/guide/quick-start.md
|
|
12
|
+
- apps/docs/hb-sdk/guide/environment.md
|
|
12
13
|
- apps/docs/hb-sdk/guide/error-handling.md
|
|
13
14
|
- apps/docs/hb-sdk/guide/lifecycle.md
|
|
14
15
|
- apps/docs/hb-sdk/guide/cli.md
|
|
@@ -19,12 +20,13 @@
|
|
|
19
20
|
- [Public root entrypoint](#public-root-entrypoint)
|
|
20
21
|
- [Vite plugin export](#vite-plugin-export)
|
|
21
22
|
- [App-facing concepts](#app-facing-concepts)
|
|
23
|
+
- [Environment info](#environment-info)
|
|
22
24
|
- [Public modules](#public-modules)
|
|
23
25
|
- [Cloud leaderboard](#cloud-leaderboard)
|
|
24
26
|
## Package metadata
|
|
25
27
|
|
|
26
28
|
- Package: `@heybox/hb-sdk`
|
|
27
|
-
- Version at generation time: `0.8.1-alpha.
|
|
29
|
+
- Version at generation time: `0.8.1-alpha.3`
|
|
28
30
|
- Public root export: `@heybox/hb-sdk`
|
|
29
31
|
- Protocol export: `@heybox/hb-sdk/protocol`
|
|
30
32
|
- Vite plugin export: `@heybox/hb-sdk/vite`
|
|
@@ -47,6 +49,7 @@ export {
|
|
|
47
49
|
network,
|
|
48
50
|
ui,
|
|
49
51
|
device,
|
|
52
|
+
environment,
|
|
50
53
|
navigation,
|
|
51
54
|
cloud,
|
|
52
55
|
} from './core/singleton';
|
|
@@ -165,6 +168,12 @@ export type {
|
|
|
165
168
|
VibratePayload,
|
|
166
169
|
VibrateResult,
|
|
167
170
|
} from './modules/device';
|
|
171
|
+
export type {
|
|
172
|
+
MiniProgramEnvironmentInfo,
|
|
173
|
+
MiniProgramEnvironmentModule,
|
|
174
|
+
MiniProgramOperatingSystemName,
|
|
175
|
+
MiniProgramRuntimeMode,
|
|
176
|
+
} from './modules/environment';
|
|
168
177
|
export type {
|
|
169
178
|
ClosePayload,
|
|
170
179
|
CloseResult,
|
|
@@ -189,6 +198,7 @@ import {
|
|
|
189
198
|
auth,
|
|
190
199
|
cloud,
|
|
191
200
|
device,
|
|
201
|
+
environment,
|
|
192
202
|
getHandshakeState,
|
|
193
203
|
navigation,
|
|
194
204
|
network,
|
|
@@ -217,6 +227,7 @@ const hbSDK = {
|
|
|
217
227
|
network,
|
|
218
228
|
ui,
|
|
219
229
|
device,
|
|
230
|
+
environment,
|
|
220
231
|
navigation,
|
|
221
232
|
cloud,
|
|
222
233
|
};
|
|
@@ -237,11 +248,13 @@ import {
|
|
|
237
248
|
MINIAPP_PLATFORM_VALUES,
|
|
238
249
|
renderMiniappManifest,
|
|
239
250
|
validateMiniappPackageVersionForBuild,
|
|
240
|
-
validateMiniappPlatforms,
|
|
241
251
|
type MiniappPlatform,
|
|
242
252
|
} from '../miniapp-manifest/schema';
|
|
243
|
-
import {
|
|
244
|
-
|
|
253
|
+
import {
|
|
254
|
+
readMiniappPermissionsFromPackageJson,
|
|
255
|
+
readMiniappPlatformsFromPackageJson,
|
|
256
|
+
readMiniappVersionFromPackageJson,
|
|
257
|
+
} from '../miniapp-manifest/node';
|
|
245
258
|
import { getMissingPermissionsWarning } from '../miniapp-manifest/permissions';
|
|
246
259
|
import { enforceMiniappHtmlPolicy } from './html-policy';
|
|
247
260
|
import { shouldSkipMiniappPlatformCspFromEnv } from './runtime-permission-env';
|
|
@@ -311,16 +324,11 @@ function injectMiniDevConsoleBootstrap(html: string): string {
|
|
|
311
324
|
return `${html.slice(0, insertAt)}${bootstrap}${html.slice(insertAt)}`;
|
|
312
325
|
}
|
|
313
326
|
|
|
314
|
-
export interface MiniappManifestOptions {
|
|
315
|
-
platforms: readonly MiniappPlatform[];
|
|
316
|
-
}
|
|
317
|
-
|
|
318
327
|
const sdkVersionPlaceholder = ['__HB_SDK', 'VERSION__'].join('_');
|
|
319
328
|
const sdkVersionBuildConstant = ['__HB_SDK_BUILD', 'VERSION__'].join('_');
|
|
320
329
|
const miniDevLoggingConstant = ['__HB_SDK_DEV', 'LOGGING__'].join('_');
|
|
321
330
|
|
|
322
|
-
export function miniappManifest(
|
|
323
|
-
const platforms = validateMiniappPlatforms(options?.platforms, 'miniappManifest().platforms');
|
|
331
|
+
export function miniappManifest(): MiniappManifestPlugin {
|
|
324
332
|
const skipPlatformCsp = shouldSkipMiniappPlatformCspFromEnv();
|
|
325
333
|
let root = process.cwd();
|
|
326
334
|
let outDir = 'dist';
|
|
@@ -368,7 +376,8 @@ export function miniappManifest(options: MiniappManifestOptions): MiniappManifes
|
|
|
368
376
|
skipPlatformCsp,
|
|
369
377
|
});
|
|
370
378
|
return command === 'serve' ? injectMiniDevConsoleBootstrap(enforced) : enforced;
|
|
371
|
-
},
|
|
379
|
+
},
|
|
380
|
+
async closeBundle() {
|
|
372
381
|
// Rollup 在 buildStart/transform 失败后仍会调用 closeBundle。
|
|
373
382
|
// 若此时再抛「缺 index.html」等二次错误,会掩盖真实失败原因。
|
|
374
383
|
if (priorBuildError) {
|
|
@@ -377,6 +386,7 @@ export function miniappManifest(options: MiniappManifestOptions): MiniappManifes
|
|
|
377
386
|
|
|
378
387
|
const version = validateMiniappPackageVersionForBuild(readMiniappVersionFromPackageJson(root));
|
|
379
388
|
const sdkVersion = resolveSdkVersion();
|
|
389
|
+
const platforms = readMiniappPlatformsFromPackageJson(root);
|
|
380
390
|
const parsedPermissions = readMiniappPermissionsFromPackageJson(root, sdkVersion);
|
|
381
391
|
if (!parsedPermissions.declared) this.warn(getMissingPermissionsWarning());
|
|
382
392
|
const outputRoot = path.resolve(root, outDir);
|
|
@@ -458,7 +468,7 @@ function resolveHmrWebSocketUrl(resolved: MiniappManifestResolvedConfig) {
|
|
|
458
468
|
hb-sdk build [--env <name>] [--verbose]
|
|
459
469
|
```
|
|
460
470
|
|
|
461
|
-
`hb-sdk build` 直接使用项目安装的 Vite,先清理再生成固定的 `dist/`,并校验小程序入口、Manifest 和可上传产物。它不执行类型检查,不要求 CLI 登录或绑定小程序,也不访问远端服务。项目必须在 `vite.config.ts`
|
|
471
|
+
`hb-sdk build` 直接使用项目安装的 Vite,先清理再生成固定的 `dist/`,并校验小程序入口、Manifest 和可上传产物。它不执行类型检查,不要求 CLI 登录或绑定小程序,也不访问远端服务。项目必须在 `package.json#heybox.platforms` 声明目标平台,并在 `vite.config.ts` 中显式注册无参的 `miniappManifest()`;配置与构建产物不一致时构建失败。
|
|
462
472
|
|
|
463
473
|
直接运行 `hb-sdk build` 或 `vite build` 时默认注入平台 CSP。`hb-sdk remote deploy` 会在构建前读取绑定小程序的远端批准结果,并与当前版本声明取交集;仅当有效 `network` 权限启用时才跳过平台 CSP,`useOfficialDomain` 不参与该判定。权限缺失、非法或读取失败时继续注入,Runtime Gate、Manifest 与 HTML 构建检查始终保留。
|
|
464
474
|
|
|
@@ -648,6 +658,96 @@ async function saveFromUserAction(text: string) {
|
|
|
648
658
|
|
|
649
659
|
大多数小程序页面都应该使用默认实例。0.6 起不再对业务代码提供独立实例工厂。
|
|
650
660
|
|
|
661
|
+
## Environment info
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
# 环境信息
|
|
665
|
+
|
|
666
|
+
`environment` 模块提供当前小程序实例的静态环境快照,包括运行模式、小黑盒 App 版本、canonical 小程序身份、操作系统和 SDK 版本。该能力无需在 `heybox.permissions` 中声明,也不会触发用户授权。
|
|
667
|
+
|
|
668
|
+
## 推荐用法
|
|
669
|
+
|
|
670
|
+
优先使用异步方法。SDK 尚未完成握手时,`getInfo()` 会自动等待:
|
|
671
|
+
|
|
672
|
+
```ts
|
|
673
|
+
import { environment } from '@heybox/hb-sdk'
|
|
674
|
+
|
|
675
|
+
const info = await environment.getInfo()
|
|
676
|
+
|
|
677
|
+
console.log(info.runtime.mode)
|
|
678
|
+
console.log(info.host.appVersion)
|
|
679
|
+
console.log(info.miniProgram.id, info.miniProgram.version)
|
|
680
|
+
console.log(info.operatingSystem.name, info.operatingSystem.version)
|
|
681
|
+
console.log(info.sdk.version)
|
|
682
|
+
```
|
|
683
|
+
|
|
684
|
+
返回对象采用固定结构并深度冻结:
|
|
685
|
+
|
|
686
|
+
```ts
|
|
687
|
+
interface MiniProgramEnvironmentInfo {
|
|
688
|
+
readonly runtime: {
|
|
689
|
+
readonly mode: 'production' | 'preview' | 'development' | 'unknown'
|
|
690
|
+
}
|
|
691
|
+
readonly host: {
|
|
692
|
+
readonly appVersion: string | null
|
|
693
|
+
}
|
|
694
|
+
readonly miniProgram: {
|
|
695
|
+
readonly id: string | null
|
|
696
|
+
readonly version: string | null
|
|
697
|
+
}
|
|
698
|
+
readonly operatingSystem: {
|
|
699
|
+
readonly name: 'android' | 'ios' | 'ohos' | 'windows' | 'macos' | 'linux' | 'unknown'
|
|
700
|
+
readonly version: string | null
|
|
701
|
+
}
|
|
702
|
+
readonly sdk: {
|
|
703
|
+
readonly version: string
|
|
704
|
+
}
|
|
705
|
+
}
|
|
706
|
+
```
|
|
707
|
+
|
|
708
|
+
## 同步读取
|
|
709
|
+
|
|
710
|
+
只有已经确认 SDK 为 `ready` 时才能调用 `getInfoSync()`。SDK 会在派发 `ready` 状态前缓存环境快照,因此可以在握手状态订阅中同步读取:
|
|
711
|
+
|
|
712
|
+
```ts
|
|
713
|
+
import { environment, onHandshakeStateChange } from '@heybox/hb-sdk'
|
|
714
|
+
|
|
715
|
+
const unsubscribe = onHandshakeStateChange(state => {
|
|
716
|
+
if (state.status !== 'ready') return
|
|
717
|
+
|
|
718
|
+
const info = environment.getInfoSync()
|
|
719
|
+
console.log(info.operatingSystem.name)
|
|
720
|
+
})
|
|
721
|
+
```
|
|
722
|
+
|
|
723
|
+
握手完成前调用会抛出 `HbMiniProgramSDKError`,错误码为 `ENVIRONMENT_NOT_READY`。通常不需要自行等待握手;不要求同步执行的代码直接使用 `await environment.getInfo()`。
|
|
724
|
+
|
|
725
|
+
## 字段语义
|
|
726
|
+
|
|
727
|
+
| 字段 | 语义 |
|
|
728
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
729
|
+
| `runtime.mode` | 当前实例的粗粒度运行模式。正式发布为 `production`,版本预览为 `preview`,本地或 Dev Session 为 `development`。 |
|
|
730
|
+
| `host.appVersion` | 当前小黑盒 App 版本。它是 Host 提供的不透明字符串。 |
|
|
731
|
+
| `miniProgram.id` | 平台确认的 canonical `mini_program_id`,不返回数字 ID、用户 ID 或其他旧 ID。 |
|
|
732
|
+
| `miniProgram.version` | 当前加载的小程序版本,是不透明字符串。 |
|
|
733
|
+
| `operatingSystem.name` | Host 明确提供的标准系统枚举,不从小程序 iframe 的 UA 推断。 |
|
|
734
|
+
| `operatingSystem.version` | Host 明确提供的系统版本;当前 Host 未提供时为 `null`。 |
|
|
735
|
+
| `sdk.version` | 当前页面实际运行的 `@heybox/hb-sdk` 版本,遵循 npm SemVer。 |
|
|
736
|
+
|
|
737
|
+
除 `sdk.version` 外,其他版本字段均不承诺 SemVer 或大小比较语义。需要判断某项能力是否可用时,应依据能力调用结果进行降级,不要仅比较 App 或系统版本。
|
|
738
|
+
|
|
739
|
+
## 缺失与兼容
|
|
740
|
+
|
|
741
|
+
旧 Host、匿名本地调试或未提供某个字段的 Host 仍会返回完整结构:缺失字符串为 `null`,未知枚举为 `'unknown'`。非法 Host 字段只会被逐项降级,不会阻断 SDK 握手。
|
|
742
|
+
|
|
743
|
+
Browser Mock 在 Runtime 启动时使用当前设备预设作为操作系统名称,不读取开发者电脑的 UA。切换设备预设会保留当前 Runtime 和页面状态;需要重新生成环境快照时,使用调试台的重启操作。
|
|
744
|
+
|
|
745
|
+
## 信任边界
|
|
746
|
+
|
|
747
|
+
环境信息仅用于界面适配、兼容降级、埋点和诊断,不能用于鉴权、权限控制或风控。小程序提交给服务端的任何环境字段都可能被修改;服务端安全判断必须使用自身认证上下文或平台受信数据。
|
|
748
|
+
|
|
749
|
+
该 API 不提供设备型号、品牌、UA、CPU、内存、设备唯一标识、账号信息或凭据。屏幕和安全区域继续通过 [`viewport.getWindowInfo()`](https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/viewport/getWindowInfo/) 获取。
|
|
750
|
+
|
|
651
751
|
|
|
652
752
|
# 错误处理
|
|
653
753
|
|
|
@@ -686,6 +786,7 @@ try {
|
|
|
686
786
|
- `AUTHORIZATION_CANCELLED` 表示用户取消、拒绝或关闭授权页面,应正常结束当前操作。
|
|
687
787
|
- `SERVER_API_REQUIRED` 表示当前用户数据必须经开发者服务端 OpenAPI 获取,不应在页面重试对应 Host API。
|
|
688
788
|
- `METHOD_FORBIDDEN` 表示当前 Host 未实现或关闭对应能力。V1 files/download 在 Mobile、Web 和 Browser Dev Host 都会得到该错误。
|
|
789
|
+
- `ENVIRONMENT_NOT_READY` 表示在 SDK 完成握手前调用了 `environment.getInfoSync()`;一般改用会自动等待的 `environment.getInfo()`。
|
|
689
790
|
- `FILE_PICKER_CANCELLED` 表示用户取消了外部文件或目录选择,应正常结束当前操作。
|
|
690
791
|
- `DOWNLOAD_CANCELLED` 表示取消意图先于 Host 提交生效;Host 已完成提交时仍返回成功。`DOWNLOAD_TIMEOUT` 表示网络空闲超时,失败不会改动原目标。
|
|
691
792
|
- `DOWNLOAD_HTTP_STATUS` 的 `data` 只包含脱敏后的 `status`、可选 `statusText` 和安全响应头。
|
|
@@ -750,6 +851,7 @@ SDK 还提供 `getHandshakeState()` / `onHandshakeStateChange()` 管理持久握
|
|
|
750
851
|
| 模块 | 用途 |
|
|
751
852
|
| ------------ | ----------------------------------------------- |
|
|
752
853
|
| `auth` | 获取交给开发者服务端交换的短期授权码 |
|
|
854
|
+
| `environment` | 读取当前实例的冻结环境快照 |
|
|
753
855
|
| `user` | 读取 Host 当前用户资料、隔离身份或撤销授权 |
|
|
754
856
|
| `share` | 打开分享、复制链接或截图分享流程 |
|
|
755
857
|
| `ui` | 展示 Toast 和 Loading |
|
package/skill/references/cli.md
CHANGED
|
@@ -162,7 +162,7 @@ Browser Mock uses the Node `hb-sdk login` session to send Host `heybox-session`
|
|
|
162
162
|
hb-sdk build [--env <name>] [--verbose]
|
|
163
163
|
```
|
|
164
164
|
|
|
165
|
-
`hb-sdk build` 直接使用项目安装的 Vite,先清理再生成固定的 `dist/`,并校验小程序入口、Manifest 和可上传产物。它不执行类型检查,不要求 CLI 登录或绑定小程序,也不访问远端服务。项目必须在 `vite.config.ts`
|
|
165
|
+
`hb-sdk build` 直接使用项目安装的 Vite,先清理再生成固定的 `dist/`,并校验小程序入口、Manifest 和可上传产物。它不执行类型检查,不要求 CLI 登录或绑定小程序,也不访问远端服务。项目必须在 `package.json#heybox.platforms` 声明目标平台,并在 `vite.config.ts` 中显式注册无参的 `miniappManifest()`;配置与构建产物不一致时构建失败。
|
|
166
166
|
|
|
167
167
|
直接运行 `hb-sdk build` 或 `vite build` 时默认注入平台 CSP。`hb-sdk remote deploy` 会在构建前读取绑定小程序的远端批准结果,并与当前版本声明取交集;仅当有效 `network` 权限启用时才跳过平台 CSP,`useOfficialDomain` 不参与该判定。权限缺失、非法或读取失败时继续注入,Runtime Gate、Manifest 与 HTML 构建检查始终保留。
|
|
168
168
|
|
|
@@ -181,7 +181,7 @@ hb-sdk build [--env <name>] [--verbose]
|
|
|
181
181
|
Agent rules:
|
|
182
182
|
|
|
183
183
|
- Use `hb-sdk build [--env <name>] [--verbose]` as the recommended production build entry.
|
|
184
|
-
- Require
|
|
184
|
+
- Require target platforms in `package.json#heybox.platforms`, keep the no-argument `miniappManifest()` configured, and keep typechecking in the project's `scripts.build`.
|
|
185
185
|
- Do not claim `hb-sdk build` needs login, binding, or network access, and do not invent unsupported build flags.
|
|
186
186
|
- Existing `vite build` projects remain compatible and must not be auto-migrated.
|
|
187
187
|
|
|
@@ -165,13 +165,21 @@ hb-sdk login clear
|
|
|
165
165
|
|
|
166
166
|
### Vite manifest plugin
|
|
167
167
|
|
|
168
|
+
```json
|
|
169
|
+
{
|
|
170
|
+
"heybox": {
|
|
171
|
+
"platforms": ["android", "ios", "ohos"]
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
```
|
|
175
|
+
|
|
168
176
|
```ts
|
|
169
177
|
import { miniappManifest } from '@heybox/hb-sdk/vite';
|
|
170
178
|
import { defineConfig } from 'vite';
|
|
171
179
|
|
|
172
180
|
export default defineConfig({
|
|
173
181
|
base: './',
|
|
174
|
-
plugins: [miniappManifest(
|
|
182
|
+
plugins: [miniappManifest()],
|
|
175
183
|
});
|
|
176
184
|
```
|
|
177
185
|
|
|
@@ -413,6 +413,7 @@ try {
|
|
|
413
413
|
- `AUTHORIZATION_CANCELLED` 表示用户取消、拒绝或关闭授权页面,应正常结束当前操作。
|
|
414
414
|
- `SERVER_API_REQUIRED` 表示当前用户数据必须经开发者服务端 OpenAPI 获取,不应在页面重试对应 Host API。
|
|
415
415
|
- `METHOD_FORBIDDEN` 表示当前 Host 未实现或关闭对应能力。V1 files/download 在 Mobile、Web 和 Browser Dev Host 都会得到该错误。
|
|
416
|
+
- `ENVIRONMENT_NOT_READY` 表示在 SDK 完成握手前调用了 `environment.getInfoSync()`;一般改用会自动等待的 `environment.getInfo()`。
|
|
416
417
|
- `FILE_PICKER_CANCELLED` 表示用户取消了外部文件或目录选择,应正常结束当前操作。
|
|
417
418
|
- `DOWNLOAD_CANCELLED` 表示取消意图先于 Host 提交生效;Host 已完成提交时仍返回成功。`DOWNLOAD_TIMEOUT` 表示网络空闲超时,失败不会改动原目标。
|
|
418
419
|
- `DOWNLOAD_HTTP_STATUS` 的 `data` 只包含脱敏后的 `status`、可选 `statusText` 和安全响应头。
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
- Host 文件错误只保留稳定 code 与 canonical 安全文案;原始 message、data、native path 和 credential 不会进入小程序。
|
|
36
36
|
- `FileStat.size` 是非负 safe integer;`modifiedAt` / `createdAt` 若存在,单位为 Unix epoch milliseconds。
|
|
37
37
|
- 仅当当前版本声明且平台已批准 `network` 时,`hb-sdk dev` 与 `hb-sdk remote deploy` 构建才会跳过平台 CSP;其他构建继续注入平台 CSP。`useOfficialDomain` 不参与 CSP 跳过判定。
|
|
38
|
-
- 构建必须启用 `miniappManifest(
|
|
38
|
+
- 构建必须启用 `miniappManifest()`,并在 `package.json#heybox.platforms` 显式声明实际承诺适配的平台,推荐统一使用 `hb-sdk build`。新项目模板中的 `['android', 'ios', 'ohos']` 只是初始配置,不代表已经完成真机验收。
|
|
39
39
|
|
|
40
40
|
私有 Page Channel 适配没有修改 `@heybox/hb-sdk` 公开 API 或 iframe wire;本次 files/download
|
|
41
41
|
Runtime 能力随 `0.8.0-alpha.11` release family 发布,部署 detail 前必须保证
|
package/skill/skill.json
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "hb-sdk",
|
|
3
|
-
"skillVersion": "0.8.1-alpha.
|
|
3
|
+
"skillVersion": "0.8.1-alpha.3+skill.c60361a729d0",
|
|
4
4
|
"sdk": {
|
|
5
5
|
"package": "@heybox/hb-sdk",
|
|
6
|
-
"version": "0.8.1-alpha.
|
|
7
|
-
"compatibility": "0.8.1-alpha.
|
|
6
|
+
"version": "0.8.1-alpha.3",
|
|
7
|
+
"compatibility": "0.8.1-alpha.3"
|
|
8
8
|
},
|
|
9
9
|
"distribution": {
|
|
10
10
|
"type": "npm",
|
|
11
11
|
"package": "@heybox/hb-sdk",
|
|
12
|
-
"version": "0.8.1-alpha.
|
|
12
|
+
"version": "0.8.1-alpha.3",
|
|
13
13
|
"path": "skill"
|
|
14
14
|
},
|
|
15
|
-
"integrity": "sha256-
|
|
15
|
+
"integrity": "sha256-c60361a729d0821a4a2d350d1d06a92ad94abfb77ae2f42320fce078fba023e1"
|
|
16
16
|
}
|
package/types/core/client.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { type MiniProgramSDKHandshakeState, type MiniProgramSDKHandshakeStateHandler } from './handshake-state';
|
|
2
|
+
import { type MiniProgramEnvironmentInfo, type MiniProgramEnvironmentReader } from '../modules/environment';
|
|
2
3
|
import type { MiniProgramBridgeMethod, MiniProgramCapabilityPayload, MiniProgramCapabilityResult } from '../protocol/capabilities';
|
|
3
4
|
import type { MiniProgramEventHandler, MiniProgramEventName } from '../protocol/types';
|
|
4
5
|
/**
|
|
@@ -36,7 +37,7 @@ export interface MiniProgramOperationRequester extends MiniProgramRequester {
|
|
|
36
37
|
requestOperation<Method extends MiniProgramBridgeMethod, TProgress = unknown>(method: Method, payload: MiniProgramCapabilityPayload<Method>, options?: MiniProgramOperationOptions<TProgress>): Promise<MiniProgramCapabilityResult<Method>>;
|
|
37
38
|
}
|
|
38
39
|
/** 底层 bridge client,负责握手、请求响应、事件分发与超时清理。 */
|
|
39
|
-
export declare class MiniProgramBridgeClient implements MiniProgramOperationRequester {
|
|
40
|
+
export declare class MiniProgramBridgeClient implements MiniProgramOperationRequester, MiniProgramEnvironmentReader {
|
|
40
41
|
private readonly timeout;
|
|
41
42
|
private readonly selfWindow?;
|
|
42
43
|
private readonly targetWindow;
|
|
@@ -61,6 +62,7 @@ export declare class MiniProgramBridgeClient implements MiniProgramOperationRequ
|
|
|
61
62
|
private destroyed;
|
|
62
63
|
private runtimeUnavailable;
|
|
63
64
|
private runtimeUnavailableError?;
|
|
65
|
+
private environmentInfo?;
|
|
64
66
|
constructor(options?: MiniProgramSDKOptions);
|
|
65
67
|
/** 等待父容器握手完成。 */
|
|
66
68
|
waitForHandshake(): Promise<void>;
|
|
@@ -68,6 +70,10 @@ export declare class MiniProgramBridgeClient implements MiniProgramOperationRequ
|
|
|
68
70
|
getHandshakeState(): MiniProgramSDKHandshakeState;
|
|
69
71
|
/** 订阅握手状态,并立即接收当前状态。 */
|
|
70
72
|
onHandshakeStateChange(handler: MiniProgramSDKHandshakeStateHandler): () => void;
|
|
73
|
+
/** 等待握手后读取当前实例的环境快照。 */
|
|
74
|
+
getEnvironmentInfo(): Promise<MiniProgramEnvironmentInfo>;
|
|
75
|
+
/** 同步读取握手期间缓存的环境快照。 */
|
|
76
|
+
getEnvironmentInfoSync(): MiniProgramEnvironmentInfo;
|
|
71
77
|
/** 注册小程序事件监听。 */
|
|
72
78
|
on<T extends MiniProgramEventName>(eventName: T, handler: MiniProgramEventHandler<T>): () => void;
|
|
73
79
|
/** 移除小程序事件监听。 */
|
package/types/core/sdk.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ import { type MiniProgramViewportModule } from '../modules/viewport';
|
|
|
9
9
|
import { type MiniProgramUserModule } from '../modules/user';
|
|
10
10
|
import { type MiniProgramUiModule } from '../modules/ui';
|
|
11
11
|
import { type MiniProgramDeviceModule } from '../modules/device';
|
|
12
|
+
import { type MiniProgramEnvironmentModule } from '../modules/environment';
|
|
12
13
|
import { type MiniProgramNavigationModule } from '../modules/navigation';
|
|
13
14
|
import type { MiniProgramEventHandler, MiniProgramEventName } from '../protocol/types';
|
|
14
15
|
import type { MiniProgramSDKHandshakeState, MiniProgramSDKHandshakeStateHandler } from './handshake-state';
|
|
@@ -48,6 +49,8 @@ export declare class MiniProgramSDK {
|
|
|
48
49
|
readonly navigation: MiniProgramNavigationModule;
|
|
49
50
|
/** 云端数据相关开放能力。 */
|
|
50
51
|
readonly cloud: MiniProgramCloudModule;
|
|
52
|
+
/** 当前实例的环境信息。 */
|
|
53
|
+
readonly environment: MiniProgramEnvironmentModule;
|
|
51
54
|
constructor(options?: MiniProgramSDKOptions);
|
|
52
55
|
/** 获取当前握手状态。 */
|
|
53
56
|
getHandshakeState(): MiniProgramSDKHandshakeState;
|
|
@@ -8,6 +8,7 @@ import type { MiniProgramViewportModule } from '../modules/viewport';
|
|
|
8
8
|
import type { MiniProgramUserModule } from '../modules/user';
|
|
9
9
|
import type { MiniProgramUiModule } from '../modules/ui';
|
|
10
10
|
import type { MiniProgramDeviceModule } from '../modules/device';
|
|
11
|
+
import type { MiniProgramEnvironmentModule } from '../modules/environment';
|
|
11
12
|
import type { MiniProgramNavigationModule } from '../modules/navigation';
|
|
12
13
|
import type { MiniProgramEventHandler, MiniProgramEventName } from '../protocol/types';
|
|
13
14
|
import type { MiniProgramSDKHandshakeState, MiniProgramSDKHandshakeStateHandler } from './handshake-state';
|
|
@@ -103,5 +104,7 @@ export declare const device: MiniProgramDeviceModule;
|
|
|
103
104
|
export declare const navigation: MiniProgramNavigationModule;
|
|
104
105
|
/** 默认 SDK 实例的 cloud 模块。 */
|
|
105
106
|
export declare const cloud: MiniProgramCloudModule;
|
|
107
|
+
/** 默认 SDK 实例的 environment 模块。 */
|
|
108
|
+
export declare const environment: MiniProgramEnvironmentModule;
|
|
106
109
|
/** 重置默认 SDK 实例,仅用于测试。 */
|
|
107
110
|
export declare function resetDefaultSDKForTest(): void;
|
package/types/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { HbMiniProgramSDKError, HbMiniProgramNetworkError } from './core/errors';
|
|
2
|
-
export { getHandshakeState, onHandshakeStateChange, on, off, auth, user, share, viewport, storage, files, network, ui, device, navigation, cloud, } from './core/singleton';
|
|
2
|
+
export { getHandshakeState, onHandshakeStateChange, on, off, auth, user, share, viewport, storage, files, network, ui, device, environment, navigation, cloud, } from './core/singleton';
|
|
3
3
|
export type { MiniProgramSDKHandshakeState, MiniProgramSDKHandshakeStateHandler } from './core/handshake-state';
|
|
4
4
|
export type { MiniProgramEventHandler, MiniProgramEventName, MiniProgramEventPayloadMap } from './protocol/types';
|
|
5
5
|
export type { LoginOptions, LoginPayload, LoginResult, LoginScope, MiniProgramAuthModule } from './modules/auth';
|
|
@@ -14,6 +14,7 @@ export type { DownloadBaseOptions, DownloadOptions, DownloadProgress, MiniProgra
|
|
|
14
14
|
export type { CreateOptions, DirectoryHandle, FileHandle, FileMode, FileStat, FileSystem, FileSystemEntity, FilesModule, ListOptions, PathRoot, PickDirectoryOptions, PickFilesOptions, RemoveOptions, SaveFileOptions, } from './modules/files';
|
|
15
15
|
export type { HideLoadingPayload, HideLoadingResult, MiniProgramToastStatus, MiniProgramUiModule, ShowLoadingPayload, ShowLoadingResult, ShowToastPayload, ShowToastResult, } from './modules/ui';
|
|
16
16
|
export type { MiniProgramDeviceModule, MiniProgramVibrateIntensity, SetClipboardPayload, SetClipboardResult, VibratePayload, VibrateResult, } from './modules/device';
|
|
17
|
+
export type { MiniProgramEnvironmentInfo, MiniProgramEnvironmentModule, MiniProgramOperatingSystemName, MiniProgramRuntimeMode, } from './modules/environment';
|
|
17
18
|
export type { ClosePayload, CloseResult, MiniProgramAppPageTarget, MiniProgramGameDetailGameType, MiniProgramGameDetailPage, MiniProgramNavigationModule, OpenAppPageOptions, OpenAppPagePayload, OpenAppPageResult, OpenGameDetailAppPagePayload, OpenGameDetailAppPageOptions, OpenPostDetailAppPagePayload, OpenPostDetailAppPageOptions, OpenUserDetailAppPagePayload, OpenUserDetailAppPageOptions, ReloadPayload, ReloadResult, } from './modules/navigation';
|
|
18
19
|
import { getHandshakeState, off, on, onHandshakeStateChange } from './core/singleton';
|
|
19
20
|
declare const hbSDK: {
|
|
@@ -30,6 +31,7 @@ declare const hbSDK: {
|
|
|
30
31
|
network: import(".").MiniProgramNetworkModule;
|
|
31
32
|
ui: import(".").MiniProgramUiModule;
|
|
32
33
|
device: import(".").MiniProgramDeviceModule;
|
|
34
|
+
environment: import(".").MiniProgramEnvironmentModule;
|
|
33
35
|
navigation: import(".").MiniProgramNavigationModule;
|
|
34
36
|
cloud: import(".").MiniProgramCloudModule;
|
|
35
37
|
};
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { type ParsedMiniappPermissions } from './permissions';
|
|
2
|
+
import type { MiniappPlatform } from './schema';
|
|
2
3
|
export declare function readMiniappVersionFromPackageJson(root: string): string;
|
|
4
|
+
export declare function readMiniappPlatformsFromPackageJson(root: string): readonly MiniappPlatform[];
|
|
3
5
|
export declare function readMiniappPermissionsFromPackageJson(root: string, sdkVersion: string): ParsedMiniappPermissions;
|
|
4
6
|
export declare function resolveMiniappSdkVersion(): string;
|
|
@@ -27,4 +27,5 @@ export declare function validateMiniappManifestForDeploy(manifest: MiniappManife
|
|
|
27
27
|
platforms: readonly ("android" | "ios" | "ohos" | "windows" | "macos" | "linux")[];
|
|
28
28
|
};
|
|
29
29
|
export declare function validateMiniappPlatforms(platforms: unknown, sourceLabel?: string): readonly MiniappPlatform[];
|
|
30
|
+
export declare function areMiniappPlatformsEqual(left: readonly MiniappPlatform[], right: readonly MiniappPlatform[]): boolean;
|
|
30
31
|
export declare function validateSdkVersion(version: unknown, sourceLabel?: string): string;
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import type { MiniProgramOperatingSystemName, MiniProgramRuntimeMode } from '@heybox/hb-sdk-protocol';
|
|
2
|
+
/** 小程序环境信息中的运行模式。 */
|
|
3
|
+
export type { MiniProgramRuntimeMode } from '@heybox/hb-sdk-protocol';
|
|
4
|
+
/** 小程序环境信息中的操作系统名称。 */
|
|
5
|
+
export type { MiniProgramOperatingSystemName } from '@heybox/hb-sdk-protocol';
|
|
6
|
+
/** 当前小程序实例的只读环境快照。 */
|
|
7
|
+
export interface MiniProgramEnvironmentInfo {
|
|
8
|
+
readonly runtime: {
|
|
9
|
+
readonly mode: MiniProgramRuntimeMode;
|
|
10
|
+
};
|
|
11
|
+
readonly host: {
|
|
12
|
+
readonly appVersion: string | null;
|
|
13
|
+
};
|
|
14
|
+
readonly miniProgram: {
|
|
15
|
+
readonly id: string | null;
|
|
16
|
+
readonly version: string | null;
|
|
17
|
+
};
|
|
18
|
+
readonly operatingSystem: {
|
|
19
|
+
readonly name: MiniProgramOperatingSystemName;
|
|
20
|
+
readonly version: string | null;
|
|
21
|
+
};
|
|
22
|
+
readonly sdk: {
|
|
23
|
+
readonly version: string;
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
/** SDK 内部读取环境快照所需的最小能力。 */
|
|
27
|
+
export interface MiniProgramEnvironmentReader {
|
|
28
|
+
getEnvironmentInfo(): Promise<MiniProgramEnvironmentInfo>;
|
|
29
|
+
getEnvironmentInfoSync(): MiniProgramEnvironmentInfo;
|
|
30
|
+
}
|
|
31
|
+
/** 外部小程序可调用的 environment 模块。 */
|
|
32
|
+
export interface MiniProgramEnvironmentModule {
|
|
33
|
+
/**
|
|
34
|
+
* 获取当前小程序实例的环境快照,并在必要时自动等待 SDK 握手。
|
|
35
|
+
*
|
|
36
|
+
* @since 0.8.1-alpha.2
|
|
37
|
+
* @hbPlatform android
|
|
38
|
+
* @hbPlatform ios
|
|
39
|
+
* @hbPlatform ohos
|
|
40
|
+
* @hbPlatform windows
|
|
41
|
+
* @hbPlatform macos
|
|
42
|
+
* @hbClient android none
|
|
43
|
+
* @hbClient ios none
|
|
44
|
+
* @hbClient ohos none
|
|
45
|
+
* @hbClient windows none
|
|
46
|
+
* @hbClient macos none
|
|
47
|
+
*/
|
|
48
|
+
getInfo(): Promise<MiniProgramEnvironmentInfo>;
|
|
49
|
+
/**
|
|
50
|
+
* 同步读取握手完成后缓存的环境快照。
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link HbMiniProgramSDKError} SDK 尚未 ready 时抛出 `ENVIRONMENT_NOT_READY`。
|
|
53
|
+
* @since 0.8.1-alpha.2
|
|
54
|
+
* @hbPlatform android
|
|
55
|
+
* @hbPlatform ios
|
|
56
|
+
* @hbPlatform ohos
|
|
57
|
+
* @hbPlatform windows
|
|
58
|
+
* @hbPlatform macos
|
|
59
|
+
* @hbClient android none
|
|
60
|
+
* @hbClient ios none
|
|
61
|
+
* @hbClient ohos none
|
|
62
|
+
* @hbClient windows none
|
|
63
|
+
* @hbClient macos none
|
|
64
|
+
*/
|
|
65
|
+
getInfoSync(): MiniProgramEnvironmentInfo;
|
|
66
|
+
}
|
|
67
|
+
/** 创建环境信息模块。 */
|
|
68
|
+
export declare function createEnvironmentModule(reader: MiniProgramEnvironmentReader): MiniProgramEnvironmentModule;
|
|
69
|
+
/** 将不可信 wire 值逐字段降级为固定、深度冻结的公开快照。 */
|
|
70
|
+
export declare function normalizeMiniProgramEnvironmentInfo(value: unknown): MiniProgramEnvironmentInfo;
|
package/types/protocol.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { AUTH_LOGIN_METHOD, CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_INFO_METHOD, CLOUD_LEADERBOARD_GET_LIST_METHOD, CLOUD_LEADERBOARD_SUBMIT_METHOD, DIRECTORY_CREATE_METHOD, DIRECTORY_EXISTS_METHOD, DIRECTORY_LIST_METHOD, DIRECTORY_REMOVE_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, FILES_PICK_DIRECTORY_METHOD, FILES_PICK_FILES_METHOD, FILES_SAVE_FILE_METHOD, FILE_CREATE_METHOD, FILE_EXISTS_METHOD, FILE_READ_BYTES_METHOD, FILE_READ_TEXT_METHOD, FILE_REMOVE_METHOD, FILE_STAT_METHOD, FILE_WRITE_BYTES_METHOD, FILE_WRITE_TEXT_METHOD, MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, MINI_PROGRAM_OPERATION_PROGRESS_METHOD, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_METHOD, NAVIGATION_RELOAD_METHOD, NETWORK_REQUEST_METHOD, NETWORK_DOWNLOAD_METHOD, RUNTIME_LOCATION_PROBE_METHOD, SDK_CSP_VIOLATION_METHOD, SDK_HANDSHAKE_METHOD, SDK_LOCATION_REPORT_METHOD, SHARE_COPY_LINK_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD, USER_INFO_AUTHORIZATION_SCOPES, USER_GET_INFO_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_REVOKE_AUTHORIZATION_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, isManagedMiniProgramRuntimePermissionKey, isMiniProgramByteArray, isMiniProgramBridgeMessage, isMiniProgramDirectoryDescriptor, isMiniProgramDirectoryRef, isMiniProgramDownloadProgressPayload, isMiniProgramFileDescriptor, isMiniProgramFileRef, isMiniProgramFileStat, isMiniProgramFileSystemEntityDescriptor, isMiniProgramPathRootRef, isMiniProgramRelativePath, parseMiniProgramRuntimePermissions, } from '@heybox/hb-sdk-protocol';
|
|
2
|
-
export type { AuthorizedUserInfo, ClosePayload, CloseResult, CopyLinkPayload, CopyLinkResult, DirectoryCreatePayload, DirectoryCreateResult, DirectoryExistsPayload, DirectoryExistsResult, DirectoryListPayload, DirectoryListResult, DirectoryRemovePayload, DirectoryRemoveResult, DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, GetSteamGameListPayload, GetSteamGameListResult, GetStoragePayload, GetStorageResult, GetUserInfoPayload, GetUserInfoResult, GetWindowInfoPayload, GetWindowInfoResult, DownloadProgressPayload, HideLoadingPayload, HideLoadingResult, FileCreatePayload, FileCreateResult, FileExistsPayload, FileExistsResult, FileReadBytesPayload, FileReadBytesResult, FileReadTextPayload, FileReadTextResult, FileRemovePayload, FileRemoveResult, FileStatPayload, FileStatResult, FileWriteBytesPayload, FileWriteBytesResult, FileWriteTextPayload, FileWriteTextResult, LeaderboardEntry, LeaderboardOrder, LoginPayload, LoginResult, LoginScope, MiniProgramAuthMethod, MiniProgramBridgeError, MiniProgramBridgeCancelMessage, MiniProgramBridgeMessage, MiniProgramBridgeMessageType, MiniProgramBridgeProgressMessage, MiniProgramBridgeMethod, MiniProgramCapabilityDefinition, MiniProgramCapabilityModule, MiniProgramCapabilityPayload, MiniProgramCapabilityPayloadMap, MiniProgramCapabilityResult, MiniProgramCapabilityResultMap, MiniProgramCapabilityRisk, MiniProgramCloudMethod, MiniProgramDeviceMethod, MiniProgramDirectoryDescriptor, MiniProgramDirectoryMethod, MiniProgramDirectoryRef, MiniProgramDirectDirectoryRef, MiniProgramDirectFileRef, MiniProgramEventName, MiniProgramEventPayloadMap, MiniProgramFileDescriptor, MiniProgramFileMode, MiniProgramFileMethod, MiniProgramFileRef, MiniProgramFilesMethod, MiniProgramFileStat, MiniProgramFileSystemEntityDescriptor, MiniProgramFileSystemEntityRef, MiniProgramPathRootRef, MiniProgramSandboxRootRef, MiniProgramNavigationBarForegroundStyle, MiniProgramNavigationMethod, MiniProgramNetworkHeaders, MiniProgramNetworkMethod, MiniProgramNetworkParams, MiniProgramNetworkRequestMethod, MiniProgramRuntimePermissionEntry, MiniProgramRuntimePermissionsSnapshot, MiniProgramRuntimePermissionStatus, MiniProgramSafeArea, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramShareMethod, MiniProgramSharePostOptions, MiniProgramStorageMethod, MiniProgramToastStatus, MiniProgramUiMethod, MiniProgramUserInfoResult, MiniProgramUserMethod, MiniProgramVibrateIntensity, MiniProgramViewportMethod, MiniProgramWindowInfoResult, NetworkRequestPayload, NetworkResponsePayload, NetworkDownloadPayload, NetworkDownloadResult, OpenAppPagePayload, OpenAppPageResult, OpenGameDetailAppPagePayload, OpenPostDetailAppPagePayload, OpenUserDetailAppPagePayload, PickDirectoryPayload, PickDirectoryResult, PickFilesPayload, PickFilesResult, ParsedMiniProgramRuntimePermissions, ReloadPayload, ReloadResult, RevokeAuthorizationPayload, RevokeAuthorizationResult, RuntimeLocationProbePayload, ScreenshotPayload, ScreenshotResult, SaveFilePayload, SaveFileResult, SDKCSPBlockedResourceType, SDKCSPViolationPayload, SDKHandshakePayload, SDKLocationReportPayload, SDKLocationReportTrigger, SetClipboardPayload, SetClipboardResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, SetStoragePayload, ShowLoadingPayload, ShowLoadingResult, ShowShareMenuPayload, ShowShareMenuResult, ShowToastPayload, ShowToastResult, SteamGameListData, SteamGameListItem, SteamGameListSort, SteamGamePrice, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult, UserInfoAuthorization, UserInfoAuthorizationScope, UserInfoAuthorizationStatus, VibratePayload, VibrateResult, } from '@heybox/hb-sdk-protocol';
|
|
2
|
+
export type { AuthorizedUserInfo, ClosePayload, CloseResult, CopyLinkPayload, CopyLinkResult, DirectoryCreatePayload, DirectoryCreateResult, DirectoryExistsPayload, DirectoryExistsResult, DirectoryListPayload, DirectoryListResult, DirectoryRemovePayload, DirectoryRemoveResult, DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, GetSteamGameListPayload, GetSteamGameListResult, GetStoragePayload, GetStorageResult, GetUserInfoPayload, GetUserInfoResult, GetWindowInfoPayload, GetWindowInfoResult, DownloadProgressPayload, HideLoadingPayload, HideLoadingResult, FileCreatePayload, FileCreateResult, FileExistsPayload, FileExistsResult, FileReadBytesPayload, FileReadBytesResult, FileReadTextPayload, FileReadTextResult, FileRemovePayload, FileRemoveResult, FileStatPayload, FileStatResult, FileWriteBytesPayload, FileWriteBytesResult, FileWriteTextPayload, FileWriteTextResult, LeaderboardEntry, LeaderboardOrder, LoginPayload, LoginResult, LoginScope, MiniProgramAuthMethod, MiniProgramBridgeError, MiniProgramBridgeCancelMessage, MiniProgramBridgeMessage, MiniProgramBridgeMessageType, MiniProgramBridgeProgressMessage, MiniProgramBridgeMethod, MiniProgramCapabilityDefinition, MiniProgramCapabilityModule, MiniProgramCapabilityPayload, MiniProgramCapabilityPayloadMap, MiniProgramCapabilityResult, MiniProgramCapabilityResultMap, MiniProgramCapabilityRisk, MiniProgramCloudMethod, MiniProgramDeviceMethod, MiniProgramDirectoryDescriptor, MiniProgramDirectoryMethod, MiniProgramDirectoryRef, MiniProgramDirectDirectoryRef, MiniProgramDirectFileRef, MiniProgramEventName, MiniProgramEventPayloadMap, MiniProgramFileDescriptor, MiniProgramFileMode, MiniProgramFileMethod, MiniProgramFileRef, MiniProgramFilesMethod, MiniProgramFileStat, MiniProgramFileSystemEntityDescriptor, MiniProgramFileSystemEntityRef, MiniProgramPathRootRef, MiniProgramSandboxRootRef, MiniProgramNavigationBarForegroundStyle, MiniProgramNavigationMethod, MiniProgramNetworkHeaders, MiniProgramNetworkMethod, MiniProgramNetworkParams, MiniProgramNetworkRequestMethod, MiniProgramOperatingSystemName, MiniProgramRuntimePermissionEntry, MiniProgramRuntimeEnvironmentInfo, MiniProgramRuntimeMode, MiniProgramRuntimePermissionsSnapshot, MiniProgramRuntimePermissionStatus, MiniProgramSafeArea, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramShareMethod, MiniProgramSharePostOptions, MiniProgramStorageMethod, MiniProgramToastStatus, MiniProgramUiMethod, MiniProgramUserInfoResult, MiniProgramUserMethod, MiniProgramVibrateIntensity, MiniProgramViewportMethod, MiniProgramWindowInfoResult, NetworkRequestPayload, NetworkResponsePayload, NetworkDownloadPayload, NetworkDownloadResult, OpenAppPagePayload, OpenAppPageResult, OpenGameDetailAppPagePayload, OpenPostDetailAppPagePayload, OpenUserDetailAppPagePayload, PickDirectoryPayload, PickDirectoryResult, PickFilesPayload, PickFilesResult, ParsedMiniProgramRuntimePermissions, ReloadPayload, ReloadResult, RevokeAuthorizationPayload, RevokeAuthorizationResult, RuntimeLocationProbePayload, ScreenshotPayload, ScreenshotResult, SaveFilePayload, SaveFileResult, SDKCSPBlockedResourceType, SDKCSPViolationPayload, SDKHandshakePayload, SDKHandshakeResult, SDKLocationReportPayload, SDKLocationReportTrigger, SetClipboardPayload, SetClipboardResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, SetStoragePayload, ShowLoadingPayload, ShowLoadingResult, ShowShareMenuPayload, ShowShareMenuResult, ShowToastPayload, ShowToastResult, SteamGameListData, SteamGameListItem, SteamGameListSort, SteamGamePrice, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult, UserInfoAuthorization, UserInfoAuthorizationScope, UserInfoAuthorizationStatus, VibratePayload, VibrateResult, } from '@heybox/hb-sdk-protocol';
|
|
3
3
|
export type { LoginOptions } from './modules/auth';
|
|
4
4
|
export type { GetSteamGameListOptions } from './modules/user';
|
|
5
5
|
export type { MiniProgramEventHandler } from './protocol/types';
|
package/types/vite/index.d.ts
CHANGED
|
@@ -40,7 +40,4 @@ export interface MiniappManifestResolvedConfig {
|
|
|
40
40
|
}
|
|
41
41
|
export { MINIAPP_PLATFORM_VALUES };
|
|
42
42
|
export type { MiniappPlatform };
|
|
43
|
-
export
|
|
44
|
-
platforms: readonly MiniappPlatform[];
|
|
45
|
-
}
|
|
46
|
-
export declare function miniappManifest(options: MiniappManifestOptions): MiniappManifestPlugin;
|
|
43
|
+
export declare function miniappManifest(): MiniappManifestPlugin;
|