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

    模块 miniapp-publish

    接口

    MiniappBasicInfo

    小程序展示资料;项目声明和构建产物使用相同字段,图片路径的根目录不同。

    MiniappCompanionManifestDefinition

    一个 Companion alias 对应的展示信息、声明能力与平台归档。

    MiniappCompanionManifestTarget

    构建生成的单个 Companion ZIP 归档描述;不使用项目声明中的 source 目录。

    MiniappManifest

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

    MiniappPlatformResolution

    Manifest 平台声明的规范化解析结果,供 CLI、开放平台网页、后端与 Runtime 共用。

    MiniappWindowDeclaration

    package.json#heybox.window 的开发者声明字段。

    NetworkMiniappPermissionDeclaration

    构建产物中的网络权限声明,附带是否请求小黑盒官方域名访问的配置。

    ParseMiniappBindAppIdsOptions

    parseMiniappBindAppIds 的诊断文案配置。

    SimpleMiniappPermissionDeclaration

    构建产物中一个已启用的权限声明;未启用的项目配置项会在构建时被省略。

    UploadSizeItem

    参与上传总大小计算的构建产物条目。

    ValidateUploadTotalSizeOptions

    validateUploadTotalSize 的总量上限选项。

    类型别名

    MiniappCategory

    小程序发布类别:tool 为工具、game 为游戏、other 为其他;新上传版本必须声明,历史读取可缺省。

    MiniappCompanionCapability

    Companion 声明的能力标识:stdio 为标准输入输出、attachments 为受管附件、notifications 为通知。 声明不代表当前宿主可用;实际能力以启动后 Session 返回的 capability 集合为准。

    MiniappCompanionManifestDeclarations

    发布 Manifest 的 Companion 声明,键为以小写字母开头、长度 1–32 的小写字母/数字/连字符 alias。

    MiniappCompanionTarget

    Companion 二进制目标:Windows x64 或 macOS arm64;不是小程序的通用平台列表。

    MiniappPermissionDeclarations

    构建规范化后写入 Manifest 的权限对象;仅包含请求启用的权限,空对象表示无权限需求。

    MiniappPlatformPolicy

    Manifest 平台解析所采用的策略。

    变量

    MINIAPP_LEGACY_DEFAULT_PLATFORM_VALUES

    历史兜底平台集合。

    MINIAPP_LEGACY_MOBILE_PLATFORM_VALUES

    历史兜底平台集合的旧名称。

    MINIAPP_PLATFORM_HARD_CUT_SDK_VERSION

    平台声明硬切点:产物 hb-sdk 版本达到该值时,必须显式声明非空 platforms。

    函数

    hasMiniappRuntimeGate

    检查 HTML 是否包含 Runtime Gate 的三个结构标记。

    isValidVersion

    判断小程序版本是否符合公开 Manifest 版本规则。

    normalizeBasicInfoName

    规范化并校验小程序展示名称。

    normalizeRelativePath

    将扫描到的相对路径转换为统一的 / 分隔形式。

    parseMiniappBasicInfo

    校验项目声明或 Manifest 中的小程序展示资料。

    parseMiniappBindAppIds

    校验并规范化小程序关联的游戏 App ID。

    parseMiniappCategory

    校验项目配置或产物中的小程序类别。

    previewMiniappBasicInfo

    在浏览器中校验构建产物的展示资料图片,并创建预览 URL。

    relativePathContainsNodeModulesSegment

    判断路径中是否包含大小写不敏感的完整 node_modules 目录段。

    resolveMiniappManifestPlatforms

    解析 Manifest 平台声明,是 0.9.0 硬切规则的唯一实现。

    shouldUploadDistFile

    判断 dist 中的文件是否应作为版本产物上传。

    validateMiniappManifestForDeploy

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

    validateUploadTotalSize

    校验一组构建产物的总大小是否超过给定上限。