@heybox/hb-sdk API Reference - v0.9.5
    正在准备搜索索引...

    接口 MiniappManifestPlugin

    miniappManifest 返回的 Vite 插件契约。

    业务项目只需把 miniappManifest() 放入 vite.config.ts 的 plugins 数组,通常不需要直接构造该接口, 也不应手动调用这些 Vite hook。该接口不包含小程序声明;目标平台、权限、窗口、游戏绑定和 Companion 等配置统一来自距离 Vite root 最近的 package.json#heybox。

    interface MiniappManifestPlugin {
        buildEnd: (error?: Error) => void;
        closeBundle: (this: MiniappManifestPluginContext) => Promise<void>;
        config: (
            config: MiniappManifestUserConfig,
            env?: { command: "build" | "serve" },
        ) => void | MiniappManifestUserConfig;
        configResolved: (resolved: MiniappManifestResolvedConfig) => void;
        configureServer: (server: MiniappManifestDevServer) => void;
        name: string;
        transformIndexHtml: (html: string) => string;
    }
    索引

    属性

    buildEnd: (error?: Error) => void

    保留 Rollup/Vite 已报告的构建错误,避免产物校验用二次错误掩盖原始原因。

    closeBundle: (this: MiniappManifestPluginContext) => Promise<void>

    serve 关闭时直接完成;生产构建结束时校验单页产物并写入 Manifest 和 Companion 归档。

    config: (
        config: MiniappManifestUserConfig,
        env?: { command: "build" | "serve" },
    ) => void | MiniappManifestUserConfig

    校验资源基准路径、保留生产语法兼容下限,并注入 SDK 版本和开发期日志开关。

    configResolved: (resolved: MiniappManifestResolvedConfig) => void

    记录 Vite 根目录、输出目录、运行命令和开发期 HMR 地址。

    configureServer: (server: MiniappManifestDevServer) => void

    为 hb-sdk dev 注册本机调试能力;生产构建不会创建开发服务。

    name: string

    固定为 heybox-miniapp-manifest,同一份 Vite 配置必须且只能注册一个实例。

    transformIndexHtml: (html: string) => string

    向入口 HTML 注入 Runtime Gate 和平台 CSP;serve 时还会加入受限的 HMR 与日志调试支持。