@heybox/hb-sdk 0.4.3 → 0.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +106 -18
- package/dist/cli-chunks/{create-BV4h2BTs.cjs → create-DpyZCNdo.cjs} +1 -1
- package/dist/cli-chunks/{dev-DgX88vaK.cjs → dev-DWIpgJnn.cjs} +1 -1
- package/dist/cli-chunks/{doctor-BIZoQ6go.cjs → doctor-DBotVUQI.cjs} +1 -1
- package/dist/cli-chunks/{index-ovy_xoLn.cjs → index-BYMTp2I6.cjs} +171 -43
- package/dist/cli-chunks/{index-DQAFCtK1.cjs → index-DRsyeAcg.cjs} +3 -3
- package/dist/cli-chunks/{login-CoZhlwxt.cjs → login-DIgcT1gv.cjs} +2 -2
- package/dist/cli-chunks/{deploy-Bz0-WpHy.cjs → remote-DjaOc1VS.cjs} +797 -21
- package/dist/cli-chunks/{session-BQs0wf65.cjs → session-BAgaqpNL.cjs} +1 -1
- package/dist/cli.cjs +1 -1
- package/dist/devtools/mock-host/main.js +842 -428
- package/dist/index.cjs.js +98 -0
- package/dist/index.esm.js +96 -1
- package/dist/miniapp-publish.cjs.js +26 -0
- package/dist/miniapp-publish.esm.js +14 -1
- package/dist/protocol.cjs.js +70 -0
- package/dist/protocol.esm.js +64 -1
- package/dist/templates/vue3-vite-ts/README.md.ejs +1 -1
- package/dist/templates/vue3-vite-ts/package.json.ejs +1 -1
- package/package.json +1 -1
- package/skill/SKILL.md +23 -18
- package/skill/references/api-protocol.md +34 -2
- package/skill/references/api-root.md +79 -4
- package/skill/references/cli.md +86 -349
- package/skill/references/llms-index.md +2 -2
- package/skill/references/safety-boundaries.md +1 -1
- package/skill/scripts/sync-references.mjs +48 -4
- package/skill/skill.json +4 -4
- package/types/core/sdk.d.ts +9 -0
- package/types/core/singleton.d.ts +9 -0
- package/types/index.d.ts +7 -1
- package/types/miniapp-publish/index.d.ts +13 -0
- package/types/modules/device/index.d.ts +34 -0
- package/types/modules/navigation/index.d.ts +24 -0
- package/types/modules/ui/index.d.ts +42 -0
- package/types/protocol/capabilities.d.ts +81 -2
- package/types/protocol.d.ts +5 -2
|
@@ -4,6 +4,9 @@ import type { MiniProgramStorageModule } from '../modules/storage';
|
|
|
4
4
|
import type { MiniProgramNetworkModule } from '../modules/network';
|
|
5
5
|
import type { MiniProgramViewportModule } from '../modules/viewport';
|
|
6
6
|
import type { MiniProgramUserModule } from '../modules/user';
|
|
7
|
+
import type { MiniProgramUiModule } from '../modules/ui';
|
|
8
|
+
import type { MiniProgramDeviceModule } from '../modules/device';
|
|
9
|
+
import type { MiniProgramNavigationModule } from '../modules/navigation';
|
|
7
10
|
import type { MiniProgramEventHandler, MiniProgramEventName } from '../protocol/types';
|
|
8
11
|
/**
|
|
9
12
|
* 等待默认 SDK 实例与父容器完成握手。
|
|
@@ -40,5 +43,11 @@ export declare const viewport: MiniProgramViewportModule;
|
|
|
40
43
|
export declare const storage: MiniProgramStorageModule;
|
|
41
44
|
/** 默认 SDK 实例的 network 模块。 */
|
|
42
45
|
export declare const network: MiniProgramNetworkModule;
|
|
46
|
+
/** 默认 SDK 实例的 UI 模块。 */
|
|
47
|
+
export declare const ui: MiniProgramUiModule;
|
|
48
|
+
/** 默认 SDK 实例的 device 模块。 */
|
|
49
|
+
export declare const device: MiniProgramDeviceModule;
|
|
50
|
+
/** 默认 SDK 实例的 navigation 模块。 */
|
|
51
|
+
export declare const navigation: MiniProgramNavigationModule;
|
|
43
52
|
/** 重置默认 SDK 实例,仅用于测试。 */
|
|
44
53
|
export declare function resetDefaultSDKForTest(): void;
|
package/types/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export { createMiniProgramSDK, MiniProgramSDK } from './core/sdk';
|
|
2
2
|
export { HbMiniProgramSDKError, HbMiniProgramNetworkError } from './core/errors';
|
|
3
3
|
export type { MiniProgramSDKOptions } from './core/client';
|
|
4
|
-
export { ready, on, off, auth, user, share, viewport, storage, network } from './core/singleton';
|
|
4
|
+
export { ready, on, off, auth, user, share, viewport, storage, network, ui, device, navigation } from './core/singleton';
|
|
5
5
|
export type { MiniProgramEventHandler, MiniProgramEventName, MiniProgramEventPayloadMap, } from './protocol/types';
|
|
6
6
|
export type { LoginPayload, LoginResult, MiniProgramAuthModule } from './modules/auth';
|
|
7
7
|
export type { GetUserInfoPayload, GetUserInfoResult, MiniProgramUserInfo, MiniProgramUserInfoResult, MiniProgramUserModule, } from './modules/user';
|
|
@@ -9,6 +9,9 @@ export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgr
|
|
|
9
9
|
export type { GetWindowInfoPayload, GetWindowInfoResult, MiniProgramNavigationBarForegroundStyle, MiniProgramSafeArea, MiniProgramSetNavigationBarStyleOptions, MiniProgramViewportModule, MiniProgramWindowInfoResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, } from './modules/viewport';
|
|
10
10
|
export type { GetStoragePayload, GetStorageResult, MiniProgramStorageModule, SetStoragePayload, } from './modules/storage';
|
|
11
11
|
export type { MiniProgramNetworkHeaders, MiniProgramNetworkModule, MiniProgramNetworkParams, MiniProgramNetworkRequestConfig, MiniProgramNetworkRequestMethod, MiniProgramNetworkResponse, MiniProgramNetworkValidateStatus, NetworkRequestPayload, NetworkResponsePayload, } from './modules/network';
|
|
12
|
+
export type { HideLoadingPayload, HideLoadingResult, MiniProgramToastStatus, MiniProgramUiModule, ShowLoadingPayload, ShowLoadingResult, ShowToastPayload, ShowToastResult, } from './modules/ui';
|
|
13
|
+
export type { MiniProgramDeviceModule, MiniProgramVibrateIntensity, SetClipboardPayload, SetClipboardResult, VibratePayload, VibrateResult, } from './modules/device';
|
|
14
|
+
export type { ClosePayload, CloseResult, MiniProgramNavigationModule, ReloadPayload, ReloadResult, } from './modules/navigation';
|
|
12
15
|
import { off, on, ready } from './core/singleton';
|
|
13
16
|
declare const hbSDK: {
|
|
14
17
|
ready: typeof ready;
|
|
@@ -20,5 +23,8 @@ declare const hbSDK: {
|
|
|
20
23
|
viewport: import(".").MiniProgramViewportModule;
|
|
21
24
|
storage: import(".").MiniProgramStorageModule;
|
|
22
25
|
network: import(".").MiniProgramNetworkModule;
|
|
26
|
+
ui: import(".").MiniProgramUiModule;
|
|
27
|
+
device: import(".").MiniProgramDeviceModule;
|
|
28
|
+
navigation: import(".").MiniProgramNavigationModule;
|
|
23
29
|
};
|
|
24
30
|
export default hbSDK;
|
|
@@ -1,7 +1,20 @@
|
|
|
1
1
|
export declare const MINIAPP_UPLOAD_SCOPE = "activity";
|
|
2
2
|
export declare const ACTIVITY_UPLOAD_KEY_MAX_LENGTH = 64;
|
|
3
|
+
export declare const USER_MINIPROGRAM_ACCESS_STATUS_API_PATH = "/mall/developer/user_miniprogram/access_status";
|
|
4
|
+
export declare const LIST_USER_MINIPROGRAM_API_PATH = "/mall/developer/user_miniprogram/list";
|
|
5
|
+
export declare const CREATE_USER_MINIPROGRAM_API_PATH = "/mall/developer/user_miniprogram/create";
|
|
6
|
+
export declare const UPDATE_USER_MINIPROGRAM_API_PATH = "/mall/developer/user_miniprogram/update";
|
|
7
|
+
export declare const DETAIL_USER_MINIPROGRAM_API_PATH = "/mall/developer/user_miniprogram/detail";
|
|
8
|
+
export declare const USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH = "/mall/developer/user_miniprogram/preview_allowlist";
|
|
9
|
+
export declare const UPDATE_USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH = "/mall/developer/user_miniprogram/preview_allowlist/update";
|
|
3
10
|
export declare const PRECHECK_USER_MINIPROGRAM_VERSION_API_PATH = "/mall/developer/user_miniprogram/version/precheck";
|
|
4
11
|
export declare const SUBMIT_USER_MINIPROGRAM_AUDIT_API_PATH = "/mall/developer/user_miniprogram/version/submit_audit";
|
|
12
|
+
export declare const USER_MINIPROGRAM_VERSION_PREVIEW_INFO_API_PATH = "/mall/developer/user_miniprogram/version/preview_info";
|
|
13
|
+
export declare const WITHDRAW_USER_MINIPROGRAM_VERSION_API_PATH = "/mall/developer/user_miniprogram/version/withdraw";
|
|
14
|
+
export declare const RELEASE_USER_MINIPROGRAM_VERSION_API_PATH = "/mall/developer/user_miniprogram/version/release";
|
|
15
|
+
export declare const TAKE_DOWN_USER_MINIPROGRAM_API_PATH = "/mall/developer/user_miniprogram/take_down";
|
|
16
|
+
export declare const REOPEN_USER_MINIPROGRAM_API_PATH = "/mall/developer/user_miniprogram/reopen";
|
|
17
|
+
export declare const LIST_USER_MINIPROGRAM_VERSION_API_PATH = "/mall/developer/user_miniprogram/version/list";
|
|
5
18
|
export { isValidMiniappManifestVersion as isValidVersion } from '../miniapp-manifest/schema';
|
|
6
19
|
export declare function normalizeRelativePath(relativePath: string): string;
|
|
7
20
|
export declare function relativePathContainsNodeModulesSegment(relativePath: string): boolean;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import type { MiniProgramRequester } from '../../core/client';
|
|
2
|
+
export { DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, } from '../../protocol/capabilities';
|
|
3
|
+
/** 震动强度。 */
|
|
4
|
+
export type MiniProgramVibrateIntensity = 'light' | 'medium' | 'heavy';
|
|
5
|
+
/** `device.vibrate` 入参。 */
|
|
6
|
+
export interface VibratePayload {
|
|
7
|
+
/** 震动强度,默认 light。 */
|
|
8
|
+
intensity?: MiniProgramVibrateIntensity;
|
|
9
|
+
/** 延迟触发毫秒数,默认 0。 */
|
|
10
|
+
delay?: number;
|
|
11
|
+
}
|
|
12
|
+
/** `device.vibrate` 无稳定返回值。 */
|
|
13
|
+
export type VibrateResult = void;
|
|
14
|
+
/** `device.setClipboard` 入参。 */
|
|
15
|
+
export interface SetClipboardPayload {
|
|
16
|
+
/** 要写入系统剪贴板的文本。 */
|
|
17
|
+
text: string;
|
|
18
|
+
}
|
|
19
|
+
/** `device.setClipboard` 无稳定返回值。 */
|
|
20
|
+
export type SetClipboardResult = void;
|
|
21
|
+
export type { MiniProgramDeviceMethod } from '../../protocol/capabilities';
|
|
22
|
+
/** 外部小程序可调用的 device 模块。 */
|
|
23
|
+
export interface MiniProgramDeviceModule {
|
|
24
|
+
/** 触发宿主震动反馈。 */
|
|
25
|
+
vibrate(options?: VibratePayload): Promise<void>;
|
|
26
|
+
/** 写入系统文本剪贴板。 */
|
|
27
|
+
setClipboard(options: SetClipboardPayload): Promise<void>;
|
|
28
|
+
}
|
|
29
|
+
/** 触发宿主震动反馈。 */
|
|
30
|
+
export declare function vibrate(requester: MiniProgramRequester, options?: VibratePayload): Promise<void>;
|
|
31
|
+
/** 写入系统文本剪贴板。 */
|
|
32
|
+
export declare function setClipboard(requester: MiniProgramRequester, options: SetClipboardPayload): Promise<void>;
|
|
33
|
+
/** 创建设备能力模块。 */
|
|
34
|
+
export declare function createDeviceModule(requester: MiniProgramRequester): MiniProgramDeviceModule;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { MiniProgramRequester } from '../../core/client';
|
|
2
|
+
export { NAVIGATION_CLOSE_METHOD, NAVIGATION_RELOAD_METHOD, } from '../../protocol/capabilities';
|
|
3
|
+
/** `navigation.close` 不需要入参。 */
|
|
4
|
+
export type ClosePayload = void;
|
|
5
|
+
/** `navigation.close` 无稳定返回值。 */
|
|
6
|
+
export type CloseResult = void;
|
|
7
|
+
/** `navigation.reload` 不需要入参。 */
|
|
8
|
+
export type ReloadPayload = void;
|
|
9
|
+
/** `navigation.reload` 无稳定返回值。 */
|
|
10
|
+
export type ReloadResult = void;
|
|
11
|
+
export type { MiniProgramNavigationMethod } from '../../protocol/capabilities';
|
|
12
|
+
/** 外部小程序可调用的 navigation 模块。 */
|
|
13
|
+
export interface MiniProgramNavigationModule {
|
|
14
|
+
/** 请求宿主关闭当前小程序容器。 */
|
|
15
|
+
close(): Promise<void>;
|
|
16
|
+
/** 请求宿主重载当前小程序容器。 */
|
|
17
|
+
reload(): Promise<void>;
|
|
18
|
+
}
|
|
19
|
+
/** 请求宿主关闭当前小程序容器。 */
|
|
20
|
+
export declare function close(requester: MiniProgramRequester): Promise<void>;
|
|
21
|
+
/** 请求宿主重载当前小程序容器。 */
|
|
22
|
+
export declare function reload(requester: MiniProgramRequester): Promise<void>;
|
|
23
|
+
/** 创建导航能力模块。 */
|
|
24
|
+
export declare function createNavigationModule(requester: MiniProgramRequester): MiniProgramNavigationModule;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type { MiniProgramRequester } from '../../core/client';
|
|
2
|
+
export { UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD, } from '../../protocol/capabilities';
|
|
3
|
+
/** Toast 展示状态。 */
|
|
4
|
+
export type MiniProgramToastStatus = 'success' | 'error';
|
|
5
|
+
/** `ui.showToast` 入参。 */
|
|
6
|
+
export interface ShowToastPayload {
|
|
7
|
+
/** Toast 文案。 */
|
|
8
|
+
message: string;
|
|
9
|
+
/** Toast 状态;不传时展示普通文本 toast。 */
|
|
10
|
+
status?: MiniProgramToastStatus;
|
|
11
|
+
}
|
|
12
|
+
/** `ui.showToast` 无稳定返回值。 */
|
|
13
|
+
export type ShowToastResult = void;
|
|
14
|
+
/** `ui.showLoading` 入参。 */
|
|
15
|
+
export interface ShowLoadingPayload {
|
|
16
|
+
/** 是否允许用户手动关闭 loading。 */
|
|
17
|
+
dismissible?: boolean;
|
|
18
|
+
}
|
|
19
|
+
/** `ui.showLoading` 无稳定返回值。 */
|
|
20
|
+
export type ShowLoadingResult = void;
|
|
21
|
+
/** `ui.hideLoading` 不需要入参。 */
|
|
22
|
+
export type HideLoadingPayload = void;
|
|
23
|
+
/** `ui.hideLoading` 无稳定返回值。 */
|
|
24
|
+
export type HideLoadingResult = void;
|
|
25
|
+
export type { MiniProgramUiMethod } from '../../protocol/capabilities';
|
|
26
|
+
/** 外部小程序可调用的 UI 模块。 */
|
|
27
|
+
export interface MiniProgramUiModule {
|
|
28
|
+
/** 展示 toast。 */
|
|
29
|
+
showToast(options: ShowToastPayload): Promise<void>;
|
|
30
|
+
/** 展示全局 loading。 */
|
|
31
|
+
showLoading(options?: ShowLoadingPayload): Promise<void>;
|
|
32
|
+
/** 隐藏全局 loading。 */
|
|
33
|
+
hideLoading(): Promise<void>;
|
|
34
|
+
}
|
|
35
|
+
/** 展示 toast。 */
|
|
36
|
+
export declare function showToast(requester: MiniProgramRequester, options: ShowToastPayload): Promise<void>;
|
|
37
|
+
/** 展示全局 loading。 */
|
|
38
|
+
export declare function showLoading(requester: MiniProgramRequester, options?: ShowLoadingPayload): Promise<void>;
|
|
39
|
+
/** 隐藏全局 loading。 */
|
|
40
|
+
export declare function hideLoading(requester: MiniProgramRequester): Promise<void>;
|
|
41
|
+
/** 创建 UI 模块。 */
|
|
42
|
+
export declare function createUiModule(requester: MiniProgramRequester): MiniProgramUiModule;
|
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
import type { LoginPayload, LoginResult } from '../modules/auth';
|
|
2
|
+
import type { SetClipboardPayload, SetClipboardResult, VibratePayload, VibrateResult } from '../modules/device';
|
|
3
|
+
import type { ClosePayload, CloseResult, ReloadPayload, ReloadResult } from '../modules/navigation';
|
|
2
4
|
import type { NetworkRequestPayload, NetworkResponsePayload } from '../modules/network';
|
|
3
5
|
import type { ScreenshotPayload, ScreenshotResult, ShowShareMenuPayload, ShowShareMenuResult } from '../modules/share';
|
|
4
6
|
import type { GetStoragePayload, GetStorageResult, SetStoragePayload } from '../modules/storage';
|
|
7
|
+
import type { HideLoadingPayload, HideLoadingResult, ShowLoadingPayload, ShowLoadingResult, ShowToastPayload, ShowToastResult } from '../modules/ui';
|
|
5
8
|
import type { GetUserInfoPayload, GetUserInfoResult } from '../modules/user';
|
|
6
9
|
import type { GetWindowInfoPayload, GetWindowInfoResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult } from '../modules/viewport';
|
|
7
10
|
/**
|
|
@@ -67,6 +70,20 @@ export declare const STORAGE_SET_STORAGE_METHOD: "storage.setStorage";
|
|
|
67
70
|
* 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
|
|
68
71
|
*/
|
|
69
72
|
export declare const NETWORK_REQUEST_METHOD: "network.request";
|
|
73
|
+
/** 展示 toast 能力方法名。 */
|
|
74
|
+
export declare const UI_SHOW_TOAST_METHOD: "ui.showToast";
|
|
75
|
+
/** 展示全局 loading 能力方法名。 */
|
|
76
|
+
export declare const UI_SHOW_LOADING_METHOD: "ui.showLoading";
|
|
77
|
+
/** 隐藏全局 loading 能力方法名。 */
|
|
78
|
+
export declare const UI_HIDE_LOADING_METHOD: "ui.hideLoading";
|
|
79
|
+
/** 震动反馈能力方法名。 */
|
|
80
|
+
export declare const DEVICE_VIBRATE_METHOD: "device.vibrate";
|
|
81
|
+
/** 写入文本剪贴板能力方法名。 */
|
|
82
|
+
export declare const DEVICE_SET_CLIPBOARD_METHOD: "device.setClipboard";
|
|
83
|
+
/** 关闭当前小程序容器能力方法名。 */
|
|
84
|
+
export declare const NAVIGATION_CLOSE_METHOD: "navigation.close";
|
|
85
|
+
/** 重载当前小程序容器能力方法名。 */
|
|
86
|
+
export declare const NAVIGATION_RELOAD_METHOD: "navigation.reload";
|
|
70
87
|
/** 授权模块开放的方法名。 */
|
|
71
88
|
export type MiniProgramAuthMethod = typeof AUTH_LOGIN_METHOD;
|
|
72
89
|
/** 用户模块开放的方法名。 */
|
|
@@ -79,10 +96,16 @@ export type MiniProgramViewportMethod = typeof VIEWPORT_GET_WINDOW_INFO_METHOD |
|
|
|
79
96
|
export type MiniProgramStorageMethod = typeof STORAGE_GET_STORAGE_METHOD | typeof STORAGE_SET_STORAGE_METHOD;
|
|
80
97
|
/** 网络模块开放的方法名。 */
|
|
81
98
|
export type MiniProgramNetworkMethod = typeof NETWORK_REQUEST_METHOD;
|
|
99
|
+
/** UI 模块开放的方法名。 */
|
|
100
|
+
export type MiniProgramUiMethod = typeof UI_SHOW_TOAST_METHOD | typeof UI_SHOW_LOADING_METHOD | typeof UI_HIDE_LOADING_METHOD;
|
|
101
|
+
/** Device 模块开放的方法名。 */
|
|
102
|
+
export type MiniProgramDeviceMethod = typeof DEVICE_VIBRATE_METHOD | typeof DEVICE_SET_CLIPBOARD_METHOD;
|
|
103
|
+
/** Navigation 模块开放的方法名。 */
|
|
104
|
+
export type MiniProgramNavigationMethod = typeof NAVIGATION_CLOSE_METHOD | typeof NAVIGATION_RELOAD_METHOD;
|
|
82
105
|
/** 父容器开放给小程序调用的 bridge method。 */
|
|
83
|
-
export type MiniProgramBridgeMethod = MiniProgramAuthMethod | MiniProgramUserMethod | MiniProgramShareMethod | MiniProgramViewportMethod | MiniProgramStorageMethod | MiniProgramNetworkMethod;
|
|
106
|
+
export type MiniProgramBridgeMethod = MiniProgramAuthMethod | MiniProgramUserMethod | MiniProgramShareMethod | MiniProgramViewportMethod | MiniProgramStorageMethod | MiniProgramNetworkMethod | MiniProgramUiMethod | MiniProgramDeviceMethod | MiniProgramNavigationMethod;
|
|
84
107
|
/** 小程序开放能力所属模块。 */
|
|
85
|
-
export type MiniProgramCapabilityModule = 'auth' | 'user' | 'share' | 'viewport' | 'storage' | 'network';
|
|
108
|
+
export type MiniProgramCapabilityModule = 'auth' | 'user' | 'share' | 'viewport' | 'storage' | 'network' | 'ui' | 'device' | 'navigation';
|
|
86
109
|
/** 小程序开放能力风险级别,用于权限、审计和灰度策略。 */
|
|
87
110
|
export type MiniProgramCapabilityRisk = 'low' | 'medium' | 'high';
|
|
88
111
|
/**
|
|
@@ -164,6 +187,48 @@ export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
|
|
|
164
187
|
readonly capability: "network.request";
|
|
165
188
|
readonly permission: "network.request";
|
|
166
189
|
readonly risk: "high";
|
|
190
|
+
}, {
|
|
191
|
+
readonly method: "ui.showToast";
|
|
192
|
+
readonly module: "ui";
|
|
193
|
+
readonly capability: "ui.showToast";
|
|
194
|
+
readonly permission: "ui.toast";
|
|
195
|
+
readonly risk: "low";
|
|
196
|
+
}, {
|
|
197
|
+
readonly method: "ui.showLoading";
|
|
198
|
+
readonly module: "ui";
|
|
199
|
+
readonly capability: "ui.showLoading";
|
|
200
|
+
readonly permission: "ui.loading";
|
|
201
|
+
readonly risk: "low";
|
|
202
|
+
}, {
|
|
203
|
+
readonly method: "ui.hideLoading";
|
|
204
|
+
readonly module: "ui";
|
|
205
|
+
readonly capability: "ui.hideLoading";
|
|
206
|
+
readonly permission: "ui.loading";
|
|
207
|
+
readonly risk: "low";
|
|
208
|
+
}, {
|
|
209
|
+
readonly method: "device.vibrate";
|
|
210
|
+
readonly module: "device";
|
|
211
|
+
readonly capability: "device.vibrate";
|
|
212
|
+
readonly permission: "device.vibrate";
|
|
213
|
+
readonly risk: "low";
|
|
214
|
+
}, {
|
|
215
|
+
readonly method: "device.setClipboard";
|
|
216
|
+
readonly module: "device";
|
|
217
|
+
readonly capability: "device.setClipboard";
|
|
218
|
+
readonly permission: "device.clipboard.write";
|
|
219
|
+
readonly risk: "medium";
|
|
220
|
+
}, {
|
|
221
|
+
readonly method: "navigation.close";
|
|
222
|
+
readonly module: "navigation";
|
|
223
|
+
readonly capability: "navigation.close";
|
|
224
|
+
readonly permission: "navigation.close";
|
|
225
|
+
readonly risk: "medium";
|
|
226
|
+
}, {
|
|
227
|
+
readonly method: "navigation.reload";
|
|
228
|
+
readonly module: "navigation";
|
|
229
|
+
readonly capability: "navigation.reload";
|
|
230
|
+
readonly permission: "navigation.reload";
|
|
231
|
+
readonly risk: "medium";
|
|
167
232
|
}];
|
|
168
233
|
/** bridge method 到请求 payload 的映射。 */
|
|
169
234
|
export interface MiniProgramCapabilityPayloadMap {
|
|
@@ -176,6 +241,13 @@ export interface MiniProgramCapabilityPayloadMap {
|
|
|
176
241
|
[STORAGE_GET_STORAGE_METHOD]: GetStoragePayload;
|
|
177
242
|
[STORAGE_SET_STORAGE_METHOD]: SetStoragePayload;
|
|
178
243
|
[NETWORK_REQUEST_METHOD]: NetworkRequestPayload;
|
|
244
|
+
[UI_SHOW_TOAST_METHOD]: ShowToastPayload;
|
|
245
|
+
[UI_SHOW_LOADING_METHOD]: ShowLoadingPayload;
|
|
246
|
+
[UI_HIDE_LOADING_METHOD]: HideLoadingPayload;
|
|
247
|
+
[DEVICE_VIBRATE_METHOD]: VibratePayload;
|
|
248
|
+
[DEVICE_SET_CLIPBOARD_METHOD]: SetClipboardPayload;
|
|
249
|
+
[NAVIGATION_CLOSE_METHOD]: ClosePayload;
|
|
250
|
+
[NAVIGATION_RELOAD_METHOD]: ReloadPayload;
|
|
179
251
|
}
|
|
180
252
|
/** bridge method 到标准化响应 payload 的映射。 */
|
|
181
253
|
export interface MiniProgramCapabilityResultMap {
|
|
@@ -188,6 +260,13 @@ export interface MiniProgramCapabilityResultMap {
|
|
|
188
260
|
[STORAGE_GET_STORAGE_METHOD]: GetStorageResult;
|
|
189
261
|
[STORAGE_SET_STORAGE_METHOD]: void;
|
|
190
262
|
[NETWORK_REQUEST_METHOD]: NetworkResponsePayload;
|
|
263
|
+
[UI_SHOW_TOAST_METHOD]: ShowToastResult;
|
|
264
|
+
[UI_SHOW_LOADING_METHOD]: ShowLoadingResult;
|
|
265
|
+
[UI_HIDE_LOADING_METHOD]: HideLoadingResult;
|
|
266
|
+
[DEVICE_VIBRATE_METHOD]: VibrateResult;
|
|
267
|
+
[DEVICE_SET_CLIPBOARD_METHOD]: SetClipboardResult;
|
|
268
|
+
[NAVIGATION_CLOSE_METHOD]: CloseResult;
|
|
269
|
+
[NAVIGATION_RELOAD_METHOD]: ReloadResult;
|
|
191
270
|
}
|
|
192
271
|
/** 指定 bridge method 的请求 payload。 */
|
|
193
272
|
export type MiniProgramCapabilityPayload<T extends MiniProgramBridgeMethod> = MiniProgramCapabilityPayloadMap[T];
|
package/types/protocol.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
export { MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, SDK_HANDSHAKE_METHOD, } from './protocol/constants';
|
|
2
2
|
export { isMiniProgramBridgeMessage } from './protocol/guards';
|
|
3
3
|
export type { MiniProgramBridgeError, MiniProgramBridgeMessage, MiniProgramBridgeMessageType, MiniProgramEventHandler, MiniProgramEventName, MiniProgramEventPayloadMap, } from './protocol/types';
|
|
4
|
-
export { AUTH_LOGIN_METHOD, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NETWORK_REQUEST_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, USER_GET_INFO_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, } from './protocol/capabilities';
|
|
5
|
-
export type { MiniProgramAuthMethod, MiniProgramBridgeMethod, MiniProgramCapabilityDefinition, MiniProgramCapabilityModule, MiniProgramCapabilityPayload, MiniProgramCapabilityPayloadMap, MiniProgramCapabilityResult, MiniProgramCapabilityResultMap, MiniProgramCapabilityRisk, MiniProgramNetworkMethod, MiniProgramShareMethod, MiniProgramStorageMethod, MiniProgramUserMethod, MiniProgramViewportMethod, } from './protocol/capabilities';
|
|
4
|
+
export { AUTH_LOGIN_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_METHOD, NAVIGATION_RELOAD_METHOD, NETWORK_REQUEST_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD, USER_GET_INFO_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, } from './protocol/capabilities';
|
|
5
|
+
export type { MiniProgramDeviceMethod, MiniProgramAuthMethod, MiniProgramBridgeMethod, MiniProgramCapabilityDefinition, MiniProgramCapabilityModule, MiniProgramCapabilityPayload, MiniProgramCapabilityPayloadMap, MiniProgramCapabilityResult, MiniProgramCapabilityResultMap, MiniProgramCapabilityRisk, MiniProgramNavigationMethod, MiniProgramNetworkMethod, MiniProgramShareMethod, MiniProgramStorageMethod, MiniProgramUiMethod, MiniProgramUserMethod, MiniProgramViewportMethod, } from './protocol/capabilities';
|
|
6
6
|
export type { LoginPayload, LoginResult } from './modules/auth';
|
|
7
7
|
export type { GetUserInfoPayload, GetUserInfoResult, MiniProgramUserInfo, MiniProgramUserInfoResult, } from './modules/user';
|
|
8
8
|
export type { ScreenshotPayload, ScreenshotResult } from './modules/share/screenshot';
|
|
@@ -11,3 +11,6 @@ export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgr
|
|
|
11
11
|
export type { GetStoragePayload, GetStorageResult, SetStoragePayload, } from './modules/storage';
|
|
12
12
|
export type { GetWindowInfoPayload, GetWindowInfoResult, MiniProgramNavigationBarForegroundStyle, MiniProgramSafeArea, MiniProgramSetNavigationBarStyleOptions, MiniProgramWindowInfoResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, } from './modules/viewport';
|
|
13
13
|
export type { MiniProgramNetworkHeaders, MiniProgramNetworkParams, MiniProgramNetworkRequestConfig, MiniProgramNetworkRequestMethod, MiniProgramNetworkResponse, MiniProgramNetworkValidateStatus, NetworkRequestPayload, NetworkResponsePayload, } from './modules/network';
|
|
14
|
+
export type { HideLoadingPayload, HideLoadingResult, MiniProgramToastStatus, ShowLoadingPayload, ShowLoadingResult, ShowToastPayload, ShowToastResult, } from './modules/ui';
|
|
15
|
+
export type { MiniProgramVibrateIntensity, SetClipboardPayload, SetClipboardResult, VibratePayload, VibrateResult, } from './modules/device';
|
|
16
|
+
export type { ClosePayload, CloseResult, ReloadPayload, ReloadResult, } from './modules/navigation';
|