@heybox/hb-sdk 0.8.0-alpha.3 → 0.8.0

package/types/miniapp-manifest/index.d.ts

@@ -1,2 +1,3 @@
 export * from './schema';
 export * from './node';
+export * from './permissions';

package/types/miniapp-manifest/node.d.ts

@@ -1 +1,4 @@
+import { type ParsedMiniappPermissions } from './permissions';
 export declare function readMiniappVersionFromPackageJson(root: string): string;
+export declare function readMiniappPermissionsFromPackageJson(root: string, sdkVersion: string): ParsedMiniappPermissions;
+export declare function resolveMiniappSdkVersion(): string;

package/types/miniapp-manifest/permissions.d.ts

@@ -0,0 +1,37 @@
+import { type MiniProgramPermissionKey, type MiniProgramRuntimePermissionsSnapshot } from '@heybox/hb-sdk-protocol';
+export declare const MINIAPP_PERMISSION_KEYS: readonly ["userInfo", "steamLibrary", "share", "storage", "filesystem", "clipboard", "leaderboard", "network"];
+export type MiniappPermissionKey = MiniProgramPermissionKey;
+export interface SimpleMiniappPermissionDeclaration {
+    enabled: true;
+}
+export interface NetworkMiniappPermissionDeclaration extends SimpleMiniappPermissionDeclaration {
+    useOfficialDomain: boolean;
+}
+export type MiniappPermissionDeclarations = Partial<Record<Exclude<MiniappPermissionKey, 'network'>, SimpleMiniappPermissionDeclaration> & {
+    network: NetworkMiniappPermissionDeclaration;
+}>;
+export interface ParsedMiniappPermissions {
+    declared: boolean;
+    permissions?: MiniappPermissionDeclarations;
+}
+export interface MiniappPermissionView {
+    key: MiniappPermissionKey;
+    access: 'declaration' | 'platform-approval';
+    declared: boolean;
+    approved: boolean | null;
+    requestedConfig?: Record<string, boolean>;
+    approvedConfig?: Record<string, boolean>;
+    effective: boolean;
+    effectiveConfig?: Record<string, boolean>;
+}
+export declare function parseMiniappPermissions(value: unknown, options: {
+    present: boolean;
+    sdkVersion: string;
+    sourceLabel?: string;
+}): ParsedMiniappPermissions;
+export declare function requiresExplicitPermissions(sdkVersion: string): boolean;
+export declare function getMissingPermissionsWarning(sourceLabel?: string): string;
+export declare function composeMiniappRuntimePermissions(local: ParsedMiniappPermissions, approvals: unknown): {
+    runtimePermissions: MiniProgramRuntimePermissionsSnapshot;
+    views: MiniappPermissionView[];
+};

package/types/miniapp-manifest/schema.d.ts

@@ -1,3 +1,4 @@
+import { type MiniappPermissionDeclarations } from './permissions';
 export declare const MINIAPP_TEMPLATE_VERSION = "0.0.0";
 export declare const MINIAPP_PLATFORM_VALUES: readonly ["android", "ios", "ohos", "windows", "macos", "linux"];
 export type MiniappPlatform = (typeof MINIAPP_PLATFORM_VALUES)[number];
@@ -6,6 +7,7 @@ export interface MiniappManifest {
     sdkVersion: string;
     version: string;
     platforms: readonly MiniappPlatform[];
+    permissions?: MiniappPermissionDeclarations;
 }
 export interface ParseMiniappManifestResult {
     manifest: MiniappManifest;
@@ -17,6 +19,9 @@ export declare function validateMiniappManifestVersion(version: unknown, sourceL
 export declare function renderMiniappManifest(manifest: MiniappManifest): string;
 export declare function parseMiniappManifestJson(raw: string, sourceLabel?: string): ParseMiniappManifestResult;
 export declare function validateMiniappManifestForDeploy(manifest: MiniappManifest): {
+    permissions?: Partial<Record<"userInfo" | "steamLibrary" | "share" | "storage" | "filesystem" | "clipboard" | "leaderboard", import("./permissions").SimpleMiniappPermissionDeclaration> & {
+        network: import("./permissions").NetworkMiniappPermissionDeclaration;
+    }> | undefined;
     version: string;
     sdkVersion: string;
     platforms: readonly ("android" | "ios" | "ohos" | "windows" | "macos" | "linux")[];

package/types/modules/share/index.d.ts

@@ -43,7 +43,7 @@ export interface MiniProgramShareModule {
      */
     getExtra(): MiniProgramShareExtraValue | undefined;
     /**
-     * 展示基础分享面板。
+     * 展示以当前小程序通用分享页为落地页的基础分享面板。
      *
      * @since 0.2.0-alpha.0
      * @hbPlatform android

package/types/modules/share/show-share-menu.d.ts

@@ -6,7 +6,7 @@ export type ShowShareMenuPayload = MiniProgramShowShareMenuOptions;
 /** `share.showShareMenu` 返回值由客户端协议决定。 */
 export type ShowShareMenuResult = unknown;
 /**
- * 展示基础分享面板。
+ * 展示以当前小程序通用分享页为落地页的基础分享面板。
  *
  * @param requester - 底层 bridge 请求能力。
  * @param options - 基础分享参数。

package/types/modules/share/types.d.ts

@@ -25,16 +25,14 @@ export interface MiniProgramSharePostOptions {
  * 展示基础分享面板的配置。
  *
  * @remarks
- * 该配置只暴露基础分享字段，不暴露宿主内部上报、回调、自定义按钮等协议参数。
+ * 分享落地页固定为当前小程序的通用分享页。该配置只暴露基础分享字段，不暴露宿主内部上报、回调、自定义按钮等协议参数。
  */
 export interface MiniProgramShowShareMenuOptions {
     /** 分享标题。 */
     title: string;
     /** 分享描述。 */
     desc: string;
-    /** 分享落地页 URL；不传时由宿主 runtime 生成当前小程序的通用分享页。 */
-    url?: string;
-    /** 分享扩展数据；最多 8 层、单层最多 64 项、容量不超过 128 字节，且不能与 `url` 同时使用。 */
+    /** 分享扩展数据；最多 8 层、单层最多 64 项、容量不超过 128 字节。 */
     extra?: MiniProgramShareExtraValue;
     /** 分享缩略图 URL。 */
     imageUrl?: string;

package/types/vite/index.d.ts

@@ -1,7 +1,9 @@
 import { MINIAPP_PLATFORM_VALUES, type MiniappPlatform } from '../miniapp-manifest/schema';
 export interface MiniappManifestPlugin {
     name: string;
-    config: (config: MiniappManifestUserConfig) => MiniappManifestUserConfig | void;
+    config: (config: MiniappManifestUserConfig, env?: {
+        command: 'build' | 'serve';
+    }) => MiniappManifestUserConfig | void;
     configResolved: (resolved: MiniappManifestResolvedConfig) => void;
     /** Rollup 在构建失败后仍会跑 closeBundle；用 buildEnd 记录真实错误，避免二次校验掩盖原因。 */
     buildEnd: (error?: Error) => void;