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

    接口 MiniappManifest

    构建生成的小程序发布 Manifest;可选字段用于兼容历史产物,发布前仍需完整校验。

    interface MiniappManifest {
        bindAppIds?: readonly string[];
        category?: MiniappCategory;
        companions?: MiniappCompanionManifestDeclarations;
        coverImages?: string[];
        desc?: string;
        icon?: string;
        name?: string;
        permissions?: Partial<
            Record<
                | "storage"
                | "workspaceCards"
                | "userInfo"
                | "steamLibrary"
                | "share"
                | "cloud_storage"
                | "gameSaves"
                | "filesystem"
                | "media"
                | "clipboard"
                | "leaderboard"
                | "companion"
                | "appProtocol",
                SimpleMiniappPermissionDeclaration,
            > & { network: NetworkMiniappPermissionDeclaration },
        >;
        platforms: readonly (
            "windows"
            | "macos"
            | "android"
            | "ios"
            | "ohos"
            | "linux"
        )[];
        sdkVersion: string;
        version: string;
        window?: MiniappWindowDeclaration;
        workspaceCards?: WorkspaceCardsManifest;
        [key: string]: unknown;
    }

    可索引

    • [key: string]: unknown

      原始产物可带额外元数据;发布校验返回值只保留已知字段。

    索引

    属性

    bindAppIds?: readonly string[]

    关联游戏 App ID 字符串,最多 20 个;空列表在发布校验结果中省略。

    category?: MiniappCategory

    发布类别;历史读取可缺省,发布校验必须提供。

    构建生成的 Companion 归档声明,不是含 source 目录的项目 authoring 配置。

    coverImages?: string[]

    相对构建目录的封面路径,1–5 张,按展示顺序排列。

    desc?: string

    简介,最多 200 个字符;未声明时简介页不展示。

    icon?: string

    相对构建目录的图标路径。

    name?: string

    展示名称;SDK 0.8.2 起需与图标、封面一起提供。

    permissions?: Partial<
        Record<
            | "storage"
            | "workspaceCards"
            | "userInfo"
            | "steamLibrary"
            | "share"
            | "cloud_storage"
            | "gameSaves"
            | "filesystem"
            | "media"
            | "clipboard"
            | "leaderboard"
            | "companion"
            | "appProtocol",
            SimpleMiniappPermissionDeclaration,
        > & { network: NetworkMiniappPermissionDeclaration },
    >

    产物权限声明;SDK 0.9 系列起必须显式提供,无权限需求时使用空对象。

    platforms: readonly ("windows" | "macos" | "android" | "ios" | "ohos" | "linux")[]

    小程序承诺适配的非空、无重复目标平台列表。

    sdkVersion: string

    生成产物时实际安装的 hb-sdk 版本,不是小程序发布版本。

    version: string

    小程序发布版本:完整 SemVer,可含 prerelease,不允许 build metadata 或 core 0.0.0。

    桌面窗口的可选初值、最小尺寸及是否可缩放。

    workspaceCards?: WorkspaceCardsManifest

    构建生成的工作区卡片不可变合同与执行制品回执。