@heybox/hb-sdk 0.1.3 → 0.2.0-alpha.1

package/types/protocol.d.ts

@@ -0,0 +1,13 @@
+export { MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, SDK_HANDSHAKE_METHOD, } from './protocol/constants';
+export { isMiniProgramBridgeMessage } from './protocol/guards';
+export type { MiniProgramBridgeError, MiniProgramBridgeMessage, MiniProgramBridgeMessageType, MiniProgramEventHandler, MiniProgramEventName, MiniProgramEventPayloadMap, } from './protocol/types';
+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, } from './protocol/capabilities';
+export type { MiniProgramAuthMethod, MiniProgramBridgeMethod, MiniProgramCapabilityDefinition, MiniProgramCapabilityModule, MiniProgramCapabilityPayload, MiniProgramCapabilityPayloadMap, MiniProgramCapabilityResult, MiniProgramCapabilityResultMap, MiniProgramCapabilityRisk, MiniProgramNetworkMethod, MiniProgramShareMethod, MiniProgramStorageMethod, MiniProgramUserMethod, MiniProgramViewportMethod, } from './protocol/capabilities';
+export type { LoginPayload, LoginResult } from './modules/auth';
+export type { GetUserInfoPayload, GetUserInfoResult, MiniProgramUserInfo, MiniProgramUserInfoResult, } from './modules/user';
+export type { ScreenshotPayload, ScreenshotResult } from './modules/share/screenshot';
+export type { ShowShareMenuPayload, ShowShareMenuResult } from './modules/share/show-share-menu';
+export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramShowShareMenuOptions, } from './modules/share';
+export type { GetStoragePayload, GetStorageResult, SetStoragePayload, } from './modules/storage';
+export type { GetWindowInfoPayload, GetWindowInfoResult, MiniProgramSafeArea, MiniProgramWindowInfoResult, } from './modules/viewport';
+export type { MiniProgramNetworkHeaders, MiniProgramNetworkParams, MiniProgramNetworkRequestConfig, MiniProgramNetworkRequestMethod, MiniProgramNetworkResponse, MiniProgramNetworkValidateStatus, NetworkRequestPayload, NetworkResponsePayload, } from './modules/network';

package/types/modules/system/get-storage.d.ts

@@ -1,15 +0,0 @@
-import type { MiniProgramRequester } from '../../core/client';
-/** 获取小程序隔离 storage 能力方法名。 */
-export declare const SYSTEM_GET_STORAGE_METHOD: "system.getStorage";
-/** `system.getStorage` 入参。 */
-export interface GetStoragePayload {
-    /** storage key。 */
-    key: string;
-}
-/** `system.getStorage` 返回值。 */
-export interface GetStorageResult<T = unknown> {
-    /** key 对应的数据；不存在时为 undefined。 */
-    data: T | undefined;
-}
-/** 获取小程序隔离 storage。 */
-export declare function getStorage<T = unknown>(requester: MiniProgramRequester, options: GetStoragePayload): Promise<GetStorageResult<T>>;

package/types/modules/system/get-window-info.d.ts

@@ -1,16 +0,0 @@
-import type { MiniProgramRequester } from '../../core/client';
-import type { MiniProgramWindowInfoResult } from './types';
-/** 系统窗口信息能力方法名。 */
-export declare const SYSTEM_GET_WINDOW_INFO_METHOD: "system.getWindowInfo";
-/**
- * `system.getWindowInfo` 不需要入参。
- */
-export type GetWindowInfoPayload = void;
-/**
- * `system.getWindowInfo` 返回当前小程序可用窗口信息。
- */
-export type GetWindowInfoResult = MiniProgramWindowInfoResult;
-/**
- * 获取当前小程序窗口信息。
- */
-export declare function getWindowInfo(requester: MiniProgramRequester): Promise<GetWindowInfoResult>;

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

@@ -1,23 +0,0 @@
-import type { MiniProgramRequester } from '../../core/client';
-import { SYSTEM_GET_WINDOW_INFO_METHOD, type GetWindowInfoResult } from './get-window-info';
-import { SYSTEM_GET_STORAGE_METHOD, type GetStoragePayload, type GetStorageResult } from './get-storage';
-import { SYSTEM_SET_STORAGE_METHOD, type SetStoragePayload } from './set-storage';
-export * from './get-window-info';
-export * from './get-storage';
-export * from './set-storage';
-export * from './types';
-/** 系统模块开放的方法名。 */
-export type MiniProgramSystemMethod = typeof SYSTEM_GET_WINDOW_INFO_METHOD | typeof SYSTEM_GET_STORAGE_METHOD | typeof SYSTEM_SET_STORAGE_METHOD;
-/** 外部小程序可调用的系统模块。 */
-export interface MiniProgramSystemModule {
-    /**
-     * 获取当前小程序窗口信息。
-     */
-    getWindowInfo(): Promise<GetWindowInfoResult>;
-    /** 获取小程序隔离 storage。 */
-    getStorage<T = unknown>(options: GetStoragePayload): Promise<GetStorageResult<T>>;
-    /** 写入小程序隔离 storage。 */
-    setStorage(options: SetStoragePayload): Promise<void>;
-}
-/** 创建系统模块。 */
-export declare function createSystemModule(requester: MiniProgramRequester): MiniProgramSystemModule;

package/types/modules/system/set-storage.d.ts

@@ -1,12 +0,0 @@
-import type { MiniProgramRequester } from '../../core/client';
-/** 写入小程序隔离 storage 能力方法名。 */
-export declare const SYSTEM_SET_STORAGE_METHOD: "system.setStorage";
-/** `system.setStorage` 入参。 */
-export interface SetStoragePayload {
-    /** storage key。 */
-    key: string;
-    /** 需要写入的数据。 */
-    data: unknown;
-}
-/** 写入小程序隔离 storage。 */
-export declare function setStorage(requester: MiniProgramRequester, options: SetStoragePayload): Promise<void>;

package/types/modules/system/types.d.ts

@@ -1,34 +0,0 @@
-/** 小程序安全区域信息。 */
-export interface MiniProgramSafeArea {
-    /** 安全区域左上角横坐标。 */
-    left: number;
-    /** 安全区域右下角横坐标。 */
-    right: number;
-    /** 安全区域左上角纵坐标。 */
-    top: number;
-    /** 安全区域右下角纵坐标。 */
-    bottom: number;
-    /** 安全区域宽度，单位 px。 */
-    width: number;
-    /** 安全区域高度，单位 px。 */
-    height: number;
-}
-/** 小程序窗口信息。 */
-export interface MiniProgramWindowInfoResult {
-    /** 设备像素比。 */
-    pixelRatio: number;
-    /** 屏幕宽度，单位 px。 */
-    screenWidth: number;
-    /** 屏幕高度，单位 px。 */
-    screenHeight: number;
-    /** 可使用窗口宽度，单位 px。 */
-    windowWidth: number;
-    /** 可使用窗口高度，单位 px。 */
-    windowHeight: number;
-    /** 状态栏高度；黑盒环境按顶部可用偏移兼容。 */
-    statusBarHeight: number;
-    /** 安全区域。 */
-    safeArea: MiniProgramSafeArea;
-    /** 窗口上边缘的 y 值。 */
-    screenTop: number;
-}

package/types/modules/user/login.d.ts

@@ -1,18 +0,0 @@
-import type { MiniProgramRequester } from '../../core/client';
-import type { MiniProgramUserInfoResult } from './types';
-/** 用户登录能力方法名。 */
-export declare const USER_LOGIN_METHOD: "user.login";
-/**
- * `user.login` 不需要入参。
- */
-export type LoginPayload = void;
-/**
- * `user.login` 返回登录流程结束后的最新用户登录态与公开基础资料。
- */
-export type LoginResult = MiniProgramUserInfoResult;
-/**
- * 唤起黑盒登录流程，并在流程返回后刷新用户公开基础资料。
- *
- * 该能力不会向小程序暴露 token、cookie 或任何登录凭据。
- */
-export declare function login(requester: MiniProgramRequester): Promise<LoginResult>;