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

    函数 validateMiniappManifestForDeploy

    • 校验发布 Manifest 并返回规范化后的已知字段。

      参数

      • manifest: MiniappManifest

        从构建产物读取的 Manifest,图片和 Companion 路径相对构建目录。

      返回 {
          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;
      }

      新对象:规范化版本、名称、平台与游戏绑定,省略空绑定及未声明的可选字段;不保留未知字段。

      • 可选bindAppIds?: readonly string[]
      • 可选category?: MiniappCategory
      • 可选companions?: MiniappCompanionManifestDeclarations
      • 可选coverImages?: string[]

        1–5 个互不重复的封面相对路径,按展示顺序排列。

      • 可选desc?: string
      • 可选icon?: string

        图标的规范相对路径;项目声明相对项目目录,Manifest 相对构建目录。

      • 可选name?: string

        NFKC 规范化并移除首尾 Unicode 空白后的名称,长度为 1–40 个 Unicode code point。

      • 可选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

      Error 版本、平台、资料、权限、窗口、游戏绑定或生成的 Companion 声明非法,以及类别缺失时抛出。

      不修改输入对象,不执行文件 I/O;不会验证图片/归档是否存在、内容摘要是否匹配,也不查询远端发布资格。 成功仅表示 Manifest 字段通过校验,不能替代文件检查与服务端发布预检。

      0.8.2