@heybox/hb-sdk-protocol 0.7.5-alpha.0 → 0.8.0-alpha.2

package/types/capabilities.d.ts

@@ -1,4 +1,4 @@
-import type { ClosePayload, CloseResult, CopyLinkPayload, CopyLinkResult, DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, GetStoragePayload, GetStorageResult, GetSteamGameListPayload, GetSteamGameListResult, GetUserInfoPayload, GetUserInfoResult, GetWindowInfoPayload, GetWindowInfoResult, HideLoadingPayload, HideLoadingResult, LoginPayload, LoginResult, NetworkRequestPayload, NetworkResponsePayload, OpenAppPagePayload, OpenAppPageResult, ReloadPayload, ReloadResult, ScreenshotPayload, ScreenshotResult, SetClipboardPayload, SetClipboardResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, SetStoragePayload, ShowLoadingPayload, ShowLoadingResult, ShowShareMenuPayload, ShowShareMenuResult, ShowToastPayload, ShowToastResult, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult, VibratePayload, VibrateResult } from './payloads';
+import type { ClosePayload, CloseResult, CopyLinkPayload, CopyLinkResult, DirectoryCreatePayload, DirectoryCreateResult, DirectoryExistsPayload, DirectoryExistsResult, DirectoryListPayload, DirectoryListResult, DirectoryRemovePayload, DirectoryRemoveResult, DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, GetStoragePayload, GetStorageResult, GetSteamGameListPayload, GetSteamGameListResult, GetUserInfoPayload, GetUserInfoResult, GetWindowInfoPayload, GetWindowInfoResult, HideLoadingPayload, HideLoadingResult, FileCreatePayload, FileCreateResult, FileExistsPayload, FileExistsResult, FileReadBytesPayload, FileReadBytesResult, FileReadTextPayload, FileReadTextResult, FileRemovePayload, FileRemoveResult, FileStatPayload, FileStatResult, FileWriteBytesPayload, FileWriteBytesResult, FileWriteTextPayload, FileWriteTextResult, LoginPayload, LoginResult, NetworkDownloadPayload, NetworkDownloadResult, NetworkRequestPayload, NetworkResponsePayload, OpenAppPagePayload, OpenAppPageResult, PickDirectoryPayload, PickDirectoryResult, PickFilesPayload, PickFilesResult, ReloadPayload, ReloadResult, ScreenshotPayload, ScreenshotResult, SaveFilePayload, SaveFileResult, SetClipboardPayload, SetClipboardResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, SetStoragePayload, ShowLoadingPayload, ShowLoadingResult, ShowShareMenuPayload, ShowShareMenuResult, ShowToastPayload, ShowToastResult, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult, VibratePayload, VibrateResult } from './payloads';
 export declare const AUTH_LOGIN_METHOD: "auth.login";
 export declare const USER_GET_INFO_METHOD: "user.getInfo";
 export declare const USER_REVOKE_AUTHORIZATION_METHOD: "user.revokeAuthorization";
@@ -11,6 +11,22 @@ export declare const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD: "viewport.setNavi
 export declare const STORAGE_GET_STORAGE_METHOD: "storage.getStorage";
 export declare const STORAGE_SET_STORAGE_METHOD: "storage.setStorage";
 export declare const NETWORK_REQUEST_METHOD: "network.request";
+export declare const NETWORK_DOWNLOAD_METHOD: "network.download";
+export declare const FILES_PICK_FILES_METHOD: "files.pickFiles";
+export declare const FILES_PICK_DIRECTORY_METHOD: "files.pickDirectory";
+export declare const FILES_SAVE_FILE_METHOD: "files.saveFile";
+export declare const FILE_CREATE_METHOD: "file.create";
+export declare const FILE_REMOVE_METHOD: "file.remove";
+export declare const FILE_EXISTS_METHOD: "file.exists";
+export declare const FILE_READ_TEXT_METHOD: "file.readText";
+export declare const FILE_WRITE_TEXT_METHOD: "file.writeText";
+export declare const FILE_READ_BYTES_METHOD: "file.readBytes";
+export declare const FILE_WRITE_BYTES_METHOD: "file.writeBytes";
+export declare const FILE_STAT_METHOD: "file.stat";
+export declare const DIRECTORY_CREATE_METHOD: "directory.create";
+export declare const DIRECTORY_REMOVE_METHOD: "directory.remove";
+export declare const DIRECTORY_EXISTS_METHOD: "directory.exists";
+export declare const DIRECTORY_LIST_METHOD: "directory.list";
 export declare const UI_SHOW_TOAST_METHOD: "ui.showToast";
 export declare const UI_SHOW_LOADING_METHOD: "ui.showLoading";
 export declare const UI_HIDE_LOADING_METHOD: "ui.hideLoading";
@@ -29,13 +45,16 @@ export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD | typeof USER_RE
 export type MiniProgramShareMethod = typeof SHARE_COPY_LINK_METHOD | typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
 export type MiniProgramViewportMethod = typeof VIEWPORT_GET_WINDOW_INFO_METHOD | typeof VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD;
 export type MiniProgramStorageMethod = typeof STORAGE_GET_STORAGE_METHOD | typeof STORAGE_SET_STORAGE_METHOD;
-export type MiniProgramNetworkMethod = typeof NETWORK_REQUEST_METHOD;
+export type MiniProgramNetworkMethod = typeof NETWORK_REQUEST_METHOD | typeof NETWORK_DOWNLOAD_METHOD;
+export type MiniProgramFilesMethod = typeof FILES_PICK_FILES_METHOD | typeof FILES_PICK_DIRECTORY_METHOD | typeof FILES_SAVE_FILE_METHOD;
+export type MiniProgramFileMethod = typeof FILE_CREATE_METHOD | typeof FILE_REMOVE_METHOD | typeof FILE_EXISTS_METHOD | typeof FILE_READ_TEXT_METHOD | typeof FILE_WRITE_TEXT_METHOD | typeof FILE_READ_BYTES_METHOD | typeof FILE_WRITE_BYTES_METHOD | typeof FILE_STAT_METHOD;
+export type MiniProgramDirectoryMethod = typeof DIRECTORY_CREATE_METHOD | typeof DIRECTORY_REMOVE_METHOD | typeof DIRECTORY_EXISTS_METHOD | typeof DIRECTORY_LIST_METHOD;
 export type MiniProgramUiMethod = typeof UI_SHOW_TOAST_METHOD | typeof UI_SHOW_LOADING_METHOD | typeof UI_HIDE_LOADING_METHOD;
 export type MiniProgramDeviceMethod = typeof DEVICE_VIBRATE_METHOD | typeof DEVICE_SET_CLIPBOARD_METHOD;
 export type MiniProgramNavigationMethod = typeof NAVIGATION_CLOSE_METHOD | typeof NAVIGATION_RELOAD_METHOD | typeof NAVIGATION_OPEN_APP_PAGE_METHOD;
 export type MiniProgramCloudMethod = typeof CLOUD_LEADERBOARD_SUBMIT_METHOD | typeof CLOUD_LEADERBOARD_GET_LIST_METHOD | typeof CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD | typeof CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD | typeof CLOUD_LEADERBOARD_GET_INFO_METHOD;
-export type MiniProgramBridgeMethod = MiniProgramAuthMethod | MiniProgramUserMethod | MiniProgramShareMethod | MiniProgramViewportMethod | MiniProgramStorageMethod | MiniProgramNetworkMethod | MiniProgramUiMethod | MiniProgramDeviceMethod | MiniProgramNavigationMethod | MiniProgramCloudMethod;
-export type MiniProgramCapabilityModule = 'auth' | 'user' | 'share' | 'viewport' | 'storage' | 'network' | 'ui' | 'device' | 'navigation' | 'cloud';
+export type MiniProgramBridgeMethod = MiniProgramAuthMethod | MiniProgramUserMethod | MiniProgramShareMethod | MiniProgramViewportMethod | MiniProgramStorageMethod | MiniProgramNetworkMethod | MiniProgramFilesMethod | MiniProgramFileMethod | MiniProgramDirectoryMethod | MiniProgramUiMethod | MiniProgramDeviceMethod | MiniProgramNavigationMethod | MiniProgramCloudMethod;
+export type MiniProgramCapabilityModule = 'auth' | 'user' | 'share' | 'viewport' | 'storage' | 'network' | 'files' | 'file' | 'directory' | 'ui' | 'device' | 'navigation' | 'cloud';
 export type MiniProgramCapabilityRisk = 'low' | 'medium' | 'high';
 export interface MiniProgramCapabilityDefinition {
     method: MiniProgramBridgeMethod;
@@ -116,6 +135,102 @@ export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
     readonly capability: "network.request";
     readonly permission: "network.request";
     readonly risk: "high";
+}, {
+    readonly method: "network.download";
+    readonly module: "network";
+    readonly capability: "network.download";
+    readonly permission: "network.request";
+    readonly risk: "high";
+}, {
+    readonly method: "files.pickFiles";
+    readonly module: "files";
+    readonly capability: "files.pickFiles";
+    readonly permission: "files.external";
+    readonly risk: "high";
+}, {
+    readonly method: "files.pickDirectory";
+    readonly module: "files";
+    readonly capability: "files.pickDirectory";
+    readonly permission: "files.external";
+    readonly risk: "high";
+}, {
+    readonly method: "files.saveFile";
+    readonly module: "files";
+    readonly capability: "files.saveFile";
+    readonly permission: "files.external";
+    readonly risk: "high";
+}, {
+    readonly method: "file.create";
+    readonly module: "file";
+    readonly capability: "file.create";
+    readonly permission: "files.access";
+    readonly risk: "high";
+}, {
+    readonly method: "file.remove";
+    readonly module: "file";
+    readonly capability: "file.remove";
+    readonly permission: "files.access";
+    readonly risk: "high";
+}, {
+    readonly method: "file.exists";
+    readonly module: "file";
+    readonly capability: "file.exists";
+    readonly permission: "files.access";
+    readonly risk: "high";
+}, {
+    readonly method: "file.readText";
+    readonly module: "file";
+    readonly capability: "file.readText";
+    readonly permission: "files.access";
+    readonly risk: "high";
+}, {
+    readonly method: "file.writeText";
+    readonly module: "file";
+    readonly capability: "file.writeText";
+    readonly permission: "files.access";
+    readonly risk: "high";
+}, {
+    readonly method: "file.readBytes";
+    readonly module: "file";
+    readonly capability: "file.readBytes";
+    readonly permission: "files.access";
+    readonly risk: "high";
+}, {
+    readonly method: "file.writeBytes";
+    readonly module: "file";
+    readonly capability: "file.writeBytes";
+    readonly permission: "files.access";
+    readonly risk: "high";
+}, {
+    readonly method: "file.stat";
+    readonly module: "file";
+    readonly capability: "file.stat";
+    readonly permission: "files.access";
+    readonly risk: "high";
+}, {
+    readonly method: "directory.create";
+    readonly module: "directory";
+    readonly capability: "directory.create";
+    readonly permission: "files.access";
+    readonly risk: "high";
+}, {
+    readonly method: "directory.remove";
+    readonly module: "directory";
+    readonly capability: "directory.remove";
+    readonly permission: "files.access";
+    readonly risk: "high";
+}, {
+    readonly method: "directory.exists";
+    readonly module: "directory";
+    readonly capability: "directory.exists";
+    readonly permission: "files.access";
+    readonly risk: "high";
+}, {
+    readonly method: "directory.list";
+    readonly module: "directory";
+    readonly capability: "directory.list";
+    readonly permission: "files.access";
+    readonly risk: "high";
 }, {
     readonly method: "ui.showToast";
     readonly module: "ui";
@@ -208,6 +323,22 @@ export interface MiniProgramCapabilityPayloadMap {
     [STORAGE_GET_STORAGE_METHOD]: GetStoragePayload;
     [STORAGE_SET_STORAGE_METHOD]: SetStoragePayload;
     [NETWORK_REQUEST_METHOD]: NetworkRequestPayload;
+    [NETWORK_DOWNLOAD_METHOD]: NetworkDownloadPayload;
+    [FILES_PICK_FILES_METHOD]: PickFilesPayload;
+    [FILES_PICK_DIRECTORY_METHOD]: PickDirectoryPayload;
+    [FILES_SAVE_FILE_METHOD]: SaveFilePayload;
+    [FILE_CREATE_METHOD]: FileCreatePayload;
+    [FILE_REMOVE_METHOD]: FileRemovePayload;
+    [FILE_EXISTS_METHOD]: FileExistsPayload;
+    [FILE_READ_TEXT_METHOD]: FileReadTextPayload;
+    [FILE_WRITE_TEXT_METHOD]: FileWriteTextPayload;
+    [FILE_READ_BYTES_METHOD]: FileReadBytesPayload;
+    [FILE_WRITE_BYTES_METHOD]: FileWriteBytesPayload;
+    [FILE_STAT_METHOD]: FileStatPayload;
+    [DIRECTORY_CREATE_METHOD]: DirectoryCreatePayload;
+    [DIRECTORY_REMOVE_METHOD]: DirectoryRemovePayload;
+    [DIRECTORY_EXISTS_METHOD]: DirectoryExistsPayload;
+    [DIRECTORY_LIST_METHOD]: DirectoryListPayload;
     [UI_SHOW_TOAST_METHOD]: ShowToastPayload;
     [UI_SHOW_LOADING_METHOD]: ShowLoadingPayload;
     [UI_HIDE_LOADING_METHOD]: HideLoadingPayload;
@@ -235,6 +366,22 @@ export interface MiniProgramCapabilityResultMap {
     [STORAGE_GET_STORAGE_METHOD]: GetStorageResult;
     [STORAGE_SET_STORAGE_METHOD]: void;
     [NETWORK_REQUEST_METHOD]: NetworkResponsePayload;
+    [NETWORK_DOWNLOAD_METHOD]: NetworkDownloadResult;
+    [FILES_PICK_FILES_METHOD]: PickFilesResult;
+    [FILES_PICK_DIRECTORY_METHOD]: PickDirectoryResult;
+    [FILES_SAVE_FILE_METHOD]: SaveFileResult;
+    [FILE_CREATE_METHOD]: FileCreateResult;
+    [FILE_REMOVE_METHOD]: FileRemoveResult;
+    [FILE_EXISTS_METHOD]: FileExistsResult;
+    [FILE_READ_TEXT_METHOD]: FileReadTextResult;
+    [FILE_WRITE_TEXT_METHOD]: FileWriteTextResult;
+    [FILE_READ_BYTES_METHOD]: FileReadBytesResult;
+    [FILE_WRITE_BYTES_METHOD]: FileWriteBytesResult;
+    [FILE_STAT_METHOD]: FileStatResult;
+    [DIRECTORY_CREATE_METHOD]: DirectoryCreateResult;
+    [DIRECTORY_REMOVE_METHOD]: DirectoryRemoveResult;
+    [DIRECTORY_EXISTS_METHOD]: DirectoryExistsResult;
+    [DIRECTORY_LIST_METHOD]: DirectoryListResult;
     [UI_SHOW_TOAST_METHOD]: ShowToastResult;
     [UI_SHOW_LOADING_METHOD]: ShowLoadingResult;
     [UI_HIDE_LOADING_METHOD]: HideLoadingResult;

package/types/constants.d.ts

@@ -5,3 +5,4 @@ export declare const SDK_HANDSHAKE_METHOD: "sdk.handshake";
 export declare const RUNTIME_LOCATION_PROBE_METHOD: "runtime.location.probe";
 export declare const SDK_LOCATION_REPORT_METHOD: "sdk.location.report";
 export declare const SDK_CSP_VIOLATION_METHOD: "sdk.csp.violation";
+export declare const MINI_PROGRAM_OPERATION_PROGRESS_METHOD: "operation.progress";

package/types/guards.d.ts

@@ -1,2 +1,13 @@
 import type { MiniProgramBridgeMessage } from './bridge';
+import type { DownloadProgressPayload, MiniProgramDirectoryDescriptor, MiniProgramDirectoryRef, MiniProgramFileDescriptor, MiniProgramFileRef, MiniProgramFileStat, MiniProgramFileSystemEntityDescriptor, MiniProgramPathRootRef } from './payloads';
 export declare function isMiniProgramBridgeMessage(value: unknown): value is MiniProgramBridgeMessage;
+export declare function isMiniProgramRelativePath(value: unknown): value is string;
+export declare function isMiniProgramPathRootRef(value: unknown): value is MiniProgramPathRootRef;
+export declare function isMiniProgramFileRef(value: unknown): value is MiniProgramFileRef;
+export declare function isMiniProgramDirectoryRef(value: unknown): value is MiniProgramDirectoryRef;
+export declare function isMiniProgramFileDescriptor(value: unknown): value is MiniProgramFileDescriptor;
+export declare function isMiniProgramDirectoryDescriptor(value: unknown): value is MiniProgramDirectoryDescriptor;
+export declare function isMiniProgramFileSystemEntityDescriptor(value: unknown): value is MiniProgramFileSystemEntityDescriptor;
+export declare function isMiniProgramByteArray(value: unknown): value is Uint8Array;
+export declare function isMiniProgramFileStat(value: unknown): value is MiniProgramFileStat;
+export declare function isMiniProgramDownloadProgressPayload(value: unknown): value is DownloadProgressPayload;

package/types/payloads.d.ts

@@ -200,6 +200,150 @@ export interface NetworkResponsePayload<T = unknown> {
     statusText?: string;
     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;