@heybox/hb-sdk-protocol 0.8.0-alpha → 0.8.0-alpha.12

package/types/permission-catalog.d.ts

@@ -0,0 +1,108 @@
+import type { MiniProgramBridgeMethod, MiniProgramCapabilityRisk } from './capabilities';
+export declare const MINI_PROGRAM_PERMISSION_KEYS: readonly ["userInfo", "steamLibrary", "share", "storage", "filesystem", "clipboard", "leaderboard", "network"];
+export type MiniProgramPermissionKey = (typeof MINI_PROGRAM_PERMISSION_KEYS)[number];
+export type MiniProgramPermissionRequirement = {
+    readonly kind: 'none';
+} | {
+    readonly kind: 'all';
+    readonly permissions: readonly MiniProgramPermissionKey[];
+};
+export type MiniProgramPermissionAccess = 'declaration' | 'platform-approval';
+export interface MiniProgramPermissionConfigFieldDefinition {
+    readonly type: 'boolean';
+    readonly required: boolean;
+    readonly default: boolean;
+    readonly description: string;
+}
+export interface MiniProgramPermissionDefinition {
+    readonly key: MiniProgramPermissionKey;
+    readonly name: string;
+    readonly description: string;
+    readonly access: MiniProgramPermissionAccess;
+    readonly risk: MiniProgramCapabilityRisk;
+    readonly config: Readonly<Record<string, MiniProgramPermissionConfigFieldDefinition>>;
+    readonly methods: readonly MiniProgramBridgeMethod[];
+    readonly conditions: readonly string[];
+}
+export declare const MINI_PROGRAM_PERMISSION_CATALOG: readonly [{
+    readonly key: "userInfo";
+    readonly name: "用户信息";
+    readonly description: "登录小程序并读取当前用户的授权信息。";
+    readonly access: "declaration";
+    readonly risk: "medium";
+    readonly config: {};
+    readonly methods: readonly ["auth.login", "user.getInfo"];
+    readonly conditions: readonly ["继续执行黑盒登录、用户授权和可信手势规则。"];
+}, {
+    readonly key: "steamLibrary";
+    readonly name: "Steam 游戏库";
+    readonly description: "读取当前用户授权的 Steam 游戏库。";
+    readonly access: "declaration";
+    readonly risk: "high";
+    readonly config: {};
+    readonly methods: readonly ["user.getSteamGameList"];
+    readonly conditions: readonly ["继续执行账号绑定和数据可用性规则。"];
+}, {
+    readonly key: "share";
+    readonly name: "分享";
+    readonly description: "使用小程序分享、分享菜单和截图能力。";
+    readonly access: "declaration";
+    readonly risk: "medium";
+    readonly config: {};
+    readonly methods: readonly ["share.copyLink", "share.showShareMenu", "share.screenshot"];
+    readonly conditions: readonly ["继续执行分享参数校验和 Host 支持检查。"];
+}, {
+    readonly key: "storage";
+    readonly name: "键值存储";
+    readonly description: "读写按小程序隔离的简单键值数据。";
+    readonly access: "declaration";
+    readonly risk: "medium";
+    readonly config: {};
+    readonly methods: readonly ["storage.getStorage", "storage.setStorage"];
+    readonly conditions: readonly ["仅用于简单键值存储，不包含文件系统。"];
+}, {
+    readonly key: "filesystem";
+    readonly name: "文件系统";
+    readonly description: "访问小程序沙盒文件和用户选择的外部文件。";
+    readonly access: "declaration";
+    readonly risk: "high";
+    readonly config: {};
+    readonly methods: readonly ["network.download", "files.pickFiles", "files.pickDirectory", "files.saveFile", "file.create", "file.remove", "file.exists", "file.readText", "file.writeText", "file.readBytes", "file.writeBytes", "file.stat", "directory.create", "directory.remove", "directory.exists", "directory.list"];
+    readonly conditions: readonly ["外部文件继续要求有效的用户选择、会话句柄和匹配的读写模式。"];
+}, {
+    readonly key: "clipboard";
+    readonly name: "剪贴板";
+    readonly description: "向系统剪贴板写入文本。";
+    readonly access: "declaration";
+    readonly risk: "medium";
+    readonly config: {};
+    readonly methods: readonly ["device.setClipboard"];
+    readonly conditions: readonly ["继续执行文本长度和 Host 支持限制。"];
+}, {
+    readonly key: "leaderboard";
+    readonly name: "排行榜";
+    readonly description: "读写小程序云排行榜。";
+    readonly access: "declaration";
+    readonly risk: "medium";
+    readonly config: {};
+    readonly methods: readonly ["cloud.leaderboard.submit", "cloud.leaderboard.getList", "cloud.leaderboard.getCurrentUserEntry", "cloud.leaderboard.deleteCurrentUserEntry", "cloud.leaderboard.getInfo"];
+    readonly conditions: readonly ["排行榜必须已创建，用户和资源规则保持不变。"];
+}, {
+    readonly key: "network";
+    readonly name: "网络";
+    readonly description: "通过 network 模块请求或下载外部资源。";
+    readonly access: "platform-approval";
+    readonly risk: "high";
+    readonly config: {
+        readonly useOfficialDomain: {
+            readonly type: "boolean";
+            readonly required: false;
+            readonly default: false;
+            readonly description: "是否申请访问小黑盒官方域名。";
+        };
+    };
+    readonly methods: readonly ["network.request", "network.download"];
+    readonly conditions: readonly ["声明后仍需平台批准，并继续执行网络安全策略。"];
+}];
+export declare const MINI_PROGRAM_NO_DECLARATION_METHODS: readonly ["user.revokeAuthorization", "ui.showToast", "ui.showLoading", "ui.hideLoading", "viewport.getWindowInfo", "viewport.setNavigationBarStyle", "device.vibrate", "navigation.close", "navigation.reload", "navigation.openAppPage"];
+export declare function isMiniProgramPermissionKey(key: string): key is MiniProgramPermissionKey;

package/types/permissions.d.ts

@@ -1,7 +1,8 @@
-export declare function isManagedMiniProgramRuntimePermissionKey(key: string): boolean;
+import { type MiniProgramPermissionKey } from './permission-catalog';
+export declare function isManagedMiniProgramRuntimePermissionKey(key: string): key is MiniProgramPermissionKey;
 export type MiniProgramRuntimePermissionStatus = 'enabled' | 'disabled';
 export interface MiniProgramRuntimePermissionEntry {
-    key: string;
+    key: MiniProgramPermissionKey;
     status: MiniProgramRuntimePermissionStatus;
     config: Record<string, unknown>;
 }
@@ -12,6 +13,6 @@ export interface MiniProgramRuntimePermissionsSnapshot {
 }
 export interface ParsedMiniProgramRuntimePermissions {
     valid: boolean;
-    permissions: Record<string, MiniProgramRuntimePermissionEntry>;
+    permissions: Partial<Record<MiniProgramPermissionKey, MiniProgramRuntimePermissionEntry>>;
 }
 export declare function parseMiniProgramRuntimePermissions(snapshot: unknown): ParsedMiniProgramRuntimePermissions;