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

package/src/index.ts

@@ -3,4 +3,5 @@ export * from './capabilities';
 export * from './constants';
 export * from './guards';
 export * from './payloads';
+export * from './permission-catalog';
 export * from './permissions';

package/src/payloads.ts

@@ -116,7 +116,6 @@ export interface MiniProgramScreenshotRect {
 export type ShowShareMenuPayload = {
   title: string;
   desc: string;
-  url?: string;
   extra?: unknown;
   imageUrl?: string;
   channel?: MiniProgramShareChannel;
@@ -189,6 +188,180 @@ export interface NetworkResponsePayload<T = unknown> {
   headers: MiniProgramNetworkHeaders;
 }
 
+export type MiniProgramFileMode = 'read' | 'readwrite';
+
+export interface MiniProgramSandboxRootRef {
+  kind: 'sandbox';
+}
+
+export interface MiniProgramDirectFileRef {
+  kind: 'file';
+  handleId: string;
+}
+
+export interface MiniProgramDirectDirectoryRef {
+  kind: 'directory';
+  handleId: string;
+}
+
+export type MiniProgramPathRootRef = MiniProgramSandboxRootRef | MiniProgramDirectDirectoryRef;
+
+export interface MiniProgramDerivedFileRef {
+  kind: 'file';
+  root: MiniProgramPathRootRef;
+  relativePath: string;
+}
+
+export interface MiniProgramDerivedDirectoryRef {
+  kind: 'directory';
+  root: MiniProgramPathRootRef;
+  relativePath: string;
+}
+
+export type MiniProgramFileRef = MiniProgramDirectFileRef | MiniProgramDerivedFileRef;
+export type MiniProgramDirectoryRef = MiniProgramDirectDirectoryRef | MiniProgramDerivedDirectoryRef;
+export type MiniProgramFileSystemEntityRef = MiniProgramFileRef | MiniProgramDirectoryRef;
+
+export interface MiniProgramFileDescriptor {
+  kind: 'file';
+  name: string;
+  mode: MiniProgramFileMode;
+  ref: MiniProgramFileRef;
+}
+
+export interface MiniProgramDirectoryDescriptor {
+  kind: 'directory';
+  name: string;
+  mode: MiniProgramFileMode;
+  ref: MiniProgramDirectoryRef;
+}
+
+export type MiniProgramFileSystemEntityDescriptor = MiniProgramFileDescriptor | MiniProgramDirectoryDescriptor;
+
+export interface MiniProgramCreateOptions {
+  recursive?: boolean;
+  exclusive?: boolean;
+}
+
+export interface MiniProgramFileStat {
+  kind: 'file';
+  size: number;
+  modifiedAt?: number;
+  createdAt?: number;
+}
+
+export type PickFilesPayload =
+  | {
+      mode?: MiniProgramFileMode;
+      accept?: string[];
+      multiple?: boolean;
+    }
+  | undefined;
+export type PickFilesResult = Array<MiniProgramFileDescriptor & { ref: MiniProgramDirectFileRef }>;
+
+export type PickDirectoryPayload = { mode?: MiniProgramFileMode } | undefined;
+export type PickDirectoryResult = MiniProgramDirectoryDescriptor & { ref: MiniProgramDirectDirectoryRef };
+
+export interface SaveFilePayload {
+  suggestedName: string;
+}
+export type SaveFileResult = MiniProgramFileDescriptor & { ref: MiniProgramDirectFileRef };
+
+export interface FileCreatePayload extends MiniProgramCreateOptions {
+  target: MiniProgramFileRef;
+}
+export type FileCreateResult = void;
+
+export interface FileRemovePayload {
+  target: MiniProgramFileRef;
+}
+export type FileRemoveResult = void;
+
+export interface FileExistsPayload {
+  target: MiniProgramFileRef;
+}
+export type FileExistsResult = boolean;
+
+export interface FileReadTextPayload {
+  target: MiniProgramFileRef;
+}
+export type FileReadTextResult = string;
+
+export interface FileWriteTextPayload {
+  target: MiniProgramFileRef;
+  content: string;
+}
+export type FileWriteTextResult = void;
+
+export interface FileReadBytesPayload {
+  target: MiniProgramFileRef;
+}
+export type FileReadBytesResult = Uint8Array;
+
+export interface FileWriteBytesPayload {
+  target: MiniProgramFileRef;
+  content: Uint8Array;
+}
+export type FileWriteBytesResult = void;
+
+export interface FileStatPayload {
+  target: MiniProgramFileRef;
+}
+export type FileStatResult = MiniProgramFileStat;
+
+export interface DirectoryCreatePayload extends MiniProgramCreateOptions {
+  target: MiniProgramDirectoryRef;
+}
+export type DirectoryCreateResult = void;
+
+export interface DirectoryRemovePayload {
+  target: MiniProgramDirectoryRef;
+  recursive?: boolean;
+}
+export type DirectoryRemoveResult = void;
+
+export interface DirectoryExistsPayload {
+  target: MiniProgramDirectoryRef;
+}
+export type DirectoryExistsResult = boolean;
+
+export interface DirectoryListPayload {
+  target: MiniProgramDirectoryRef;
+  limit?: number;
+}
+export type DirectoryListResult = MiniProgramFileSystemEntityDescriptor[];
+
+export interface DownloadProgressPayload {
+  loaded: number;
+  total?: number;
+  lengthComputable: boolean;
+}
+
+interface NetworkDownloadBasePayload {
+  url: string;
+  params?: MiniProgramNetworkParams;
+  headers?: MiniProgramNetworkHeaders;
+  timeout?: number;
+  withCredentials?: boolean;
+  maxBytes?: number;
+}
+
+export type NetworkDownloadPayload = NetworkDownloadBasePayload &
+  (
+    | {
+        to: MiniProgramFileRef;
+        suggestedName?: never;
+        overwrite?: never;
+      }
+    | {
+        to: MiniProgramDirectoryRef;
+        suggestedName?: string;
+        overwrite?: boolean;
+      }
+  );
+
+export type NetworkDownloadResult = MiniProgramFileDescriptor;
+
 export type MiniProgramToastStatus = 'success' | 'error';
 export interface ShowToastPayload {
   message: string;

package/src/permission-catalog.ts

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

package/src/permissions.ts

@@ -1,11 +1,13 @@
-const MANAGED_RUNTIME_PERMISSION_KEYS = new Set(['network.request']);
+import { MINI_PROGRAM_PERMISSION_KEYS, type MiniProgramPermissionKey } from './permission-catalog';
 
-export function isManagedMiniProgramRuntimePermissionKey(key: string) {
+const MANAGED_RUNTIME_PERMISSION_KEYS = new Set<string>(MINI_PROGRAM_PERMISSION_KEYS);
+
+export function isManagedMiniProgramRuntimePermissionKey(key: string): key is MiniProgramPermissionKey {
   return MANAGED_RUNTIME_PERMISSION_KEYS.has(key);
 }
 export type MiniProgramRuntimePermissionStatus = 'enabled' | 'disabled';
 export interface MiniProgramRuntimePermissionEntry {
-  key: string;
+  key: MiniProgramPermissionKey;
   status: MiniProgramRuntimePermissionStatus;
   config: Record<string, unknown>;
 }
@@ -16,7 +18,7 @@ export interface MiniProgramRuntimePermissionsSnapshot {
 }
 export interface ParsedMiniProgramRuntimePermissions {
   valid: boolean;
-  permissions: Record<string, MiniProgramRuntimePermissionEntry>;
+  permissions: Partial<Record<MiniProgramPermissionKey, MiniProgramRuntimePermissionEntry>>;
 }
 
 export function parseMiniProgramRuntimePermissions(snapshot: unknown): ParsedMiniProgramRuntimePermissions {
@@ -28,24 +30,40 @@ export function parseMiniProgramRuntimePermissions(snapshot: unknown): ParsedMin
   }
 
   const seenKeys = new Set<string>();
-  const permissions: Record<string, MiniProgramRuntimePermissionEntry> = {};
+  const permissions: Partial<Record<MiniProgramPermissionKey, MiniProgramRuntimePermissionEntry>> = {};
   for (const rawEntry of snapshot.entries) {
     if (!isRecord(rawEntry) || typeof rawEntry.key !== 'string' || !rawEntry.key.trim()) {
       return { valid: false, permissions: {} };
     }
-    const key = rawEntry.key.trim();
-    if (seenKeys.has(key) || (rawEntry.status !== 'enabled' && rawEntry.status !== 'disabled') || !isRecord(rawEntry.config)) {
+    const inputKey = rawEntry.key.trim();
+    const key = inputKey === 'network.request' ? 'network' : inputKey;
+    if (seenKeys.has(key) || (rawEntry.status !== 'enabled' && rawEntry.status !== 'disabled')) {
       return { valid: false, permissions: {} };
     }
     seenKeys.add(key);
-    if (!isManagedMiniProgramRuntimePermissionKey(key)) continue;
-    if (key === 'network.request' && typeof rawEntry.config.useOfficialDomain !== 'boolean') {
+    if (!isManagedMiniProgramRuntimePermissionKey(key)) {
+      if (!isRecord(rawEntry.config)) return { valid: false, permissions: {} };
+      continue;
+    }
+    if (key === 'network') {
+      const config = rawEntry.config;
+      if (!isRecord(config) || typeof config.useOfficialDomain !== 'boolean') {
+        return { valid: false, permissions: {} };
+      }
+      permissions[key] = {
+        key,
+        status: rawEntry.status,
+        config: { useOfficialDomain: config.useOfficialDomain },
+      };
+      continue;
+    }
+    if (rawEntry.config !== null && rawEntry.config !== undefined && (!isRecord(rawEntry.config) || Object.keys(rawEntry.config).length > 0)) {
       return { valid: false, permissions: {} };
     }
     permissions[key] = {
       key,
       status: rawEntry.status,
-      config: { useOfficialDomain: rawEntry.config.useOfficialDomain },
+      config: {},
     };
   }
   return { valid: true, permissions };

package/types/bridge.d.ts

@@ -1,6 +1,6 @@
-import { MINI_PROGRAM_MESSAGE_NAMESPACE } from './constants';
-import type { UserInfoAuthorization } from './payloads';
-export type MiniProgramBridgeMessageType = 'handshake' | 'request' | 'response' | 'event';
+import { MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_OPERATION_PROGRESS_METHOD } from './constants';
+import type { DownloadProgressPayload, UserInfoAuthorization } from './payloads';
+export type MiniProgramBridgeMessageType = 'handshake' | 'request' | 'response' | 'event' | 'cancel';
 export type MiniProgramEventName = 'launch' | 'ready' | 'show' | 'hide' | 'unload' | 'error' | 'heybox_app_login_change' | 'user_info_authorization_change';
 export interface MiniProgramBridgeError {
     code: string;
@@ -46,6 +46,22 @@ export interface MiniProgramBridgeMessage<TPayload = unknown> {
     payload?: TPayload;
     error?: MiniProgramBridgeError;
 }
+export interface MiniProgramBridgeCancelMessage extends MiniProgramBridgeMessage<never> {
+    version: 2;
+    type: 'cancel';
+    id: string;
+    method?: never;
+    payload?: never;
+    error?: never;
+}
+export interface MiniProgramBridgeProgressMessage extends MiniProgramBridgeMessage<DownloadProgressPayload> {
+    version: 2;
+    type: 'event';
+    id: string;
+    method: typeof MINI_PROGRAM_OPERATION_PROGRESS_METHOD;
+    payload: DownloadProgressPayload;
+    error?: never;
+}
 export interface MiniProgramEventPayloadMap {
     launch: {
         timestamp: number;