@bud-fe/h5-native-bridge 1.0.4

package/dist/src/plugins/device.d.ts

@@ -0,0 +1,117 @@
+import { BridgePlugin, PluginContext, CallbacksBase } from '../core';
+
+export interface DeviceInfo {
+    model: string;
+    pixelRatio: number;
+    windowWidth: number;
+    windowHeight: number;
+    version: string;
+    storage: string;
+    currentBattery: string;
+    system: string;
+    platform: string;
+    screenWidth: number;
+    screenHeight: number;
+    brand: string;
+    fontSizeSetting: number;
+}
+export interface DeviceInfoOptions extends CallbacksBase {
+    success?: (deviceInfo: DeviceInfo) => void;
+}
+export interface GetWifiOptions extends CallbacksBase {
+    /** 超时时间 int 必选 */
+    timeout?: number;
+    /** 缓存时间 int 必选 */
+    cacheTime?: number;
+}
+export interface KeepScreenOnOptions extends CallbacksBase {
+    /** 是否保持屏幕常亮 */
+    isKeep: boolean;
+}
+/**
+ * 获取WIFI 返回结果定义
+ * @apiName device.base.getScanWifiListAsync
+ */
+export interface WifiListAsyncResult {
+    /** 错误码 int枚举值 必选 取值{ 0：成功 1：json错误 2：系统错误 3：超时 } */
+    resultCode: number;
+    /** WiFi列表 */
+    wifiList?: any[];
+    /** 成功或错误信息 */
+    resultMessage?: string;
+}
+export interface GetDeviceUUIDOptions extends CallbacksBase {
+    uuid?: string;
+}
+declare module "../core" {
+    interface PluginMethods {
+        getSystemInfo: (options?: DeviceInfoOptions) => Promise<DeviceInfo>;
+        getSystemInfoSync: (options?: DeviceInfoOptions) => void;
+        getUUID: () => Promise<GetDeviceUUIDOptions>;
+        getWifiList: (options?: GetWifiOptions) => Promise<WifiListAsyncResult>;
+        setKeepScreenOn: (options: KeepScreenOnOptions) => void;
+    }
+    interface NativeBridgeCore extends PluginMethods {
+    }
+}
+/**
+ * 设备信息插件类
+ */
+declare class DevicePlugin implements BridgePlugin {
+    readonly name = "device";
+    readonly version = "1.0.0";
+    private context?;
+    /**
+     * 安装插件
+     */
+    install(context: PluginContext): void;
+    /**
+     * 设置屏幕常亮状态
+     * @param options 配置选项
+     * @param options.isKeep 是否保持屏幕常亮，默认为true
+     * @param options.success 成功回调
+     * @param options.fail 失败回调
+     * @param options.complete 完成回调
+     * @returns void
+     */
+    setKeepScreenOn(options: KeepScreenOnOptions): void;
+    /**
+     * 同步获取设备系统信息
+     *
+     * @param options - 获取设备信息的配置选项
+     * @returns any - 返回设备信息结果
+     */
+    getSystemInfoSync(options?: DeviceInfoOptions): any;
+    /**
+     * 获取设备信息（Promise 风格）
+     *
+     * @description
+     * 1. 检查插件是否初始化，未初始化则抛出错误
+     * 2. 创建并返回一个Promise，用于异步获取设备信息
+     * 3. 通过Native Bridge调用原生能力获取设备信息
+     *
+     * @throws {BridgeError} 当插件未初始化时抛出错误
+     * @returns {Promise<DeviceInfo>} 返回包含设备信息的Promise对象
+     */
+    getSystemInfo(): Promise<DeviceInfo>;
+    /**
+    * 获取WiFi列表
+    *
+    * 该方法通过原生桥接获取当前可用的WiFi列表，返回一个Promise对象
+    *
+    * @param {GetWifiOptions} [options={}] - 获取WiFi列表的可选参数对象
+    * @returns {Promise<WifiListAsyncResult>} 返回一个Promise，解析后包含WiFi列表或错误信息
+    *   - resultCode: 0表示成功，1表示失败
+    *   - resultMessage: 结果描述信息
+    *   - wifiList: WiFi列表数组
+    */
+    getWifiList(options?: GetWifiOptions): Promise<WifiListAsyncResult>;
+    /**
+     * 获取设备的唯一标识符
+     * @returns 返回一个Promise，解析后得到设备的UUID信息
+     * @throws 如果插件未正确初始化会抛出错误
+     */
+    getUUID(): Promise<GetDeviceUUIDOptions>;
+}
+export declare const devicePlugin: DevicePlugin;
+export default devicePlugin;

package/dist/src/plugins/location.d.ts

@@ -0,0 +1,89 @@
+import { BridgePlugin, PluginContext, CallbacksBase } from '../core';
+
+export interface LocationInfo {
+    /** 经度 */
+    longitude: number;
+    /** 纬度 */
+    latitude: number;
+    /** 实际的定位精度半径（单位米） */
+    accuracy: number;
+    /** 格式化地址，如：北京市朝阳区南磨房镇北京国家广告产业园区 */
+    address: string;
+    /** 省份，如：北京市 */
+    province: string;
+    /** 城市，直辖市会返回空 */
+    city: string;
+    /** 行政区，如：朝阳区 */
+    district: string;
+    /** 街道，如：西大望路甲12-2号楼 */
+    road: string;
+    /** 当前设备网络类型，如：wifi、3g等 */
+    netType: string;
+    /** 当前设备使用移动运营商，如：CMCC等 */
+    operatorType: string;
+    /** 对错误码的描述 */
+    errorMessage?: string;
+    /** 错误码 */
+    errorCode?: number;
+    /** 仅Android支持，wifi设置是否开启，不保证已连接上 */
+    isWifiEnabled?: boolean;
+    /** 仅Android支持，gps设置是否开启，不保证已经连接上 */
+    isGpsEnabled?: boolean;
+    /** 仅Android支持，定位返回的经纬度是否是模拟的结果 */
+    isFromMock?: boolean;
+    /** 仅Android支持，我们使用的是混合定位，具体定位提供者有wifi/lbs/gps" 这三种 */
+    provider?: "wifi" | "lbs" | "gps";
+    /** 仅Android支持，移动网络是设置是否开启，不保证已经连接上 */
+    isMobileEnabled: boolean;
+}
+export interface GetLocationOptions extends CallbacksBase {
+    success?: (location: string) => void;
+    /**
+     * 期望定位精度半径（单位米），定位结果尽量满足该参数要求，但是不一定能保证小于该误差，
+     * 开发者需要读取返回结果的 accuracy 字段校验坐标精度；
+     * 建议按照业务需求设置定位精度，推荐采用200m，
+     * 可获得较好的精度和较短的响应时长
+     */
+    targetAccuracy: number;
+    /** 1：获取高德坐标， 0：获取标准坐标；推荐使用高德坐标；标准坐标没有address字段 */
+    coordinate: number;
+    /** 是否需要带有逆地理编码信息；该功能需要网络请求，请更具自己的业务场景使用 */
+    withReGeocode: boolean;
+    /** 是否缓存地理位置信息。默认是true。如果true，客户端会对定位的地理位置信息缓存，在缓存期内（2分钟）再次定位会返回旧的定位 */
+    useCache: boolean;
+}
+declare module "../core" {
+    interface PluginMethods {
+        /**
+         * 同步获取位置信息
+         * @param options 定位选项
+         */
+        getLocationSync: (options?: GetLocationOptions) => void;
+        /**
+         * 异步获取位置信息
+         * @param options 定位选项
+         */
+        getLocation: (options?: Omit<GetLocationOptions, "success" | "fail">) => Promise<LocationInfo>;
+    }
+    interface NativeBridgeCore extends PluginMethods {
+    }
+}
+declare class LocationPlugin implements BridgePlugin {
+    readonly name = "location";
+    readonly version = "1.0.0";
+    private context?;
+    install(context: PluginContext): void;
+    /**
+     * 获取当前位置信息
+     * @param options - 位置选项，可选参数包括：
+     *   - targetAccuracy: 目标精度，单位米，默认200
+     *   - coordinate: 坐标类型，默认1（可能表示WGS84）
+     *   - withReGeocode: 是否需要逆地理编码，默认true
+     *   - useCache: 是否使用缓存，默认true
+     * @returns 返回一个Promise，解析为LocationInfo对象
+     */
+    getLocation(options?: Omit<GetLocationOptions, "success" | "fail">): Promise<LocationInfo>;
+    getLocationSync(options?: GetLocationOptions): void;
+}
+export declare const locationPlugin: LocationPlugin;
+export default locationPlugin;

package/dist/src/plugins/media.d.ts

@@ -0,0 +1,157 @@
+import { BridgePlugin, PluginContext, CallbacksBase, NativeResponse } from '../core';
+
+export interface MediaInfo {
+    platform: "android" | "ios" | "unknown";
+    url: string;
+}
+export interface MediaInfoOptions extends CallbacksBase {
+    url: string;
+}
+export interface ScanOptions extends CallbacksBase {
+    /**
+     * 扫码样式。
+     * 可选值：
+     *   - 'qr'：二维码扫码框
+     *   - 'bar'：条形码扫码框
+     * 默认为 'qr'。
+     * 兼容性说明：此字段从必填变为可选，未传递时将使用默认值 'qr'，如之前为必填请注意兼容性。
+     */
+    key?: "qr" | "bar";
+    /**
+     * 是否支持从相册选择:
+     * 默认值为 true，
+     */
+    isSupportAlbum?: boolean;
+}
+export interface ScanRes {
+    /** 扫码所得数据 */
+    code?: string;
+    /**
+     * 扫描二维码时返回二维码数据。
+     */
+    qrCode?: string;
+    /**
+     * 扫描条形码时返回条形码数据。
+     */
+    barCode?: string;
+    /**
+     * 扫描结果的最后一帧图片的本地定位符
+     */
+    filePath?: string;
+    /**
+     * 扫描结果的最后一帧图片的本地真实图片路径。
+     */
+    fileRealPath?: string;
+}
+export interface ChooseImageOptions extends CallbacksBase {
+    count?: number;
+    sourceType?: string[];
+}
+export interface ChooseImageResponse {
+    filePaths: string[];
+    fileRealPaths: string[];
+}
+export interface previewImageOptions extends CallbacksBase {
+    urls: string[];
+    current?: number;
+}
+export interface compressImageOptions extends CallbacksBase {
+    filePaths: string[];
+    compressLevel?: number;
+}
+export interface compressImageResponse {
+    filePaths: string;
+}
+export interface ChooseVideoOptions extends CallbacksBase {
+    sourceType?: string[];
+    maxDuration?: number;
+}
+export interface ChooseVideoResponse {
+    filePath: string;
+    duration: number;
+    size: number;
+    height: number;
+    width: number;
+}
+declare module "../core" {
+    interface PluginMethods {
+        saveImage: (options: MediaInfoOptions) => Promise<NativeResponse>;
+        scan: (options: ScanOptions) => Promise<ScanRes>;
+        chooseImage: (options?: ChooseImageOptions) => Promise<ChooseImageResponse>;
+        previewImage: (options: previewImageOptions) => Promise<void>;
+        compressImage: (options: compressImageOptions) => Promise<compressImageResponse>;
+        chooseVideo: (options?: ChooseVideoOptions) => Promise<ChooseVideoResponse>;
+    }
+    interface NativeBridgeCore extends PluginMethods {
+    }
+}
+/**
+ * 设备信息插件类
+ */
+declare class MediaPlugin implements BridgePlugin {
+    readonly name = "media";
+    readonly version = "1.0.0";
+    private context?;
+    /**
+     * 安装插件
+     */
+    install(context: PluginContext): void;
+    /**
+     * 执行扫码功能
+     *
+     * @description 调用原生扫码功能，返回扫码结果。该方法会等待桥接准备就绪后调用原生扫码API。
+     *
+     * @param options - 扫码配置选项，排除了success和fail回调
+     * @param options.complete - 可选的完成回调函数，无论成功或失败都会执行
+     *
+     * @returns Promise<ScanRes> 返回包含扫码结果的Promise对象
+     *
+     * @throws {BridgeError} 当插件未正确初始化时抛出PLUGIN_NOT_INITIALIZED错误
+     * @throws {BridgeError} 当扫码失败时抛出SYSTEM_ERROR错误
+     *
+     * @example
+     */
+    scan(options: Omit<ScanOptions, "success" | "fail">): Promise<ScanRes>;
+    /**
+     * 保存图片到相册（Promise 风格）
+     */
+    saveImage(options: MediaInfoOptions): Promise<NativeResponse>;
+    /**
+     * 选择图片功能
+     * @param options 选择图片的配置选项
+     * @returns 返回一个Promise，解析为选择的图片响应数据
+     */
+    chooseImage(options?: ChooseImageOptions): Promise<ChooseImageResponse>;
+    /**
+     * 预览图片功能
+     * @param options 预览图片的配置参数对象，包含以下属性：
+     *   - current: 可选，number类型，默认0，表示从第几张图片开始预览
+     *   - urls: string[]类型，图片URL数组
+     *   - 其他可能的自定义参数
+     * @returns Promise<void>
+     *   成功时：解析为原生返回的结果对象(已JSON.parse处理)
+     *   失败时：拒绝返回错误信息
+     */
+    previewImage(options: previewImageOptions): Promise<void>;
+    /**
+     * 压缩图片
+     * @param options 压缩图片的配置选项
+     * @returns 返回一个Promise，解析为压缩后的图片响应数据
+     */
+    compressImage(options: compressImageOptions): Promise<compressImageResponse>;
+    /**
+     * 选择视频文件
+     * @param options 选择视频的配置选项，包含以下属性：
+     * @param options.sourceType 视频来源类型，默认同时支持相册和相机['album','camera']
+     * @param options.maxDuration 视频最大时长(秒)，默认60秒
+     * @returns Promise<ChooseVideoResponse> 返回包含视频信息的Promise对象
+     * @returns ChooseVideoResponse.filePath 视频临时文件路径
+     * @returns ChooseVideoResponse.duration 视频时长(秒)
+     * @returns ChooseVideoResponse.size 视频文件大小(字节)
+     * @returns ChooseVideoResponse.height 视频高度
+     * @returns ChooseVideoResponse.width 视频宽度
+     */
+    chooseVideo(options?: ChooseVideoOptions): Promise<ChooseVideoResponse>;
+}
+export declare const mediaPlugin: MediaPlugin;
+export default mediaPlugin;

package/dist/src/plugins/navigate.d.ts

@@ -0,0 +1,84 @@
+import { BridgePlugin, PluginContext, CallbacksBase } from '../core';
+
+export interface NavigateInfo extends CallbacksBase {
+    url: string;
+}
+export interface NavigationBarOptions extends CallbacksBase {
+    /** 是否显示导航栏
+     *  默认显示
+     *  否：隐藏导航栏
+     */
+    isShowBar?: boolean;
+    /** 导航栏标题 */
+    title?: string;
+    /** 导航栏标题颜色
+     *  导航栏背景色，支持十六进制颜色值。
+     */
+    backgroundColor?: string;
+    /** 是否重置导航栏背景色默认配色。
+     */
+    reset?: boolean;
+}
+export interface navigateBackInfo extends CallbacksBase {
+    delta?: number;
+}
+export interface OpenLinkOptions extends CallbacksBase {
+    url: string;
+    enableShare?: boolean;
+}
+declare module "../core" {
+    interface PluginMethods {
+        /**
+         * 导航到指定页面
+         * @param options 导航选项
+         */
+        navigateTo: (options: NavigateInfo) => void;
+        /**
+         * 重定向到指定页面
+         * @param options 导航选项
+         */
+        redirectTo: (options: NavigateInfo) => void;
+        /**
+         * 重新加载当前页面
+         * @param options 导航选项
+         */
+        reLaunch: (options: NavigateInfo) => void;
+        /**
+         * 返回到上一个页面
+         * @param options 导航选项
+         */
+        navigateBack: (options: navigateBackInfo) => void;
+        /**
+         * 设置导航栏
+         * @param options 样式选项
+         */
+        setNavigationBar: (options: NavigationBarOptions) => Promise<void>;
+        /**
+         * 打开外部链接
+         * @param options 链接选项
+         */
+        openLink: (options: OpenLinkOptions) => Promise<void>;
+    }
+    interface NativeBridgeCore extends PluginMethods {
+    }
+}
+declare class NavigatePlugin implements BridgePlugin {
+    readonly name = "navigate";
+    readonly version = "1.0.0";
+    private context?;
+    install(context: PluginContext): void;
+    setNavigationBar(options: NavigationBarOptions): Promise<void>;
+    private navigate;
+    navigateTo(options: NavigateInfo): void;
+    redirectTo(options: NavigateInfo): void;
+    reLaunch(options: NavigateInfo): void;
+    navigateBack(options: navigateBackInfo): void;
+    /**
+     * 打开外部链接
+     * @param options 链接选项
+      * @returns Promise对象，解析为打开链接的响应
+     */
+    openLink(options: OpenLinkOptions): Promise<void>;
+}
+export declare const navigatePlugin: NavigatePlugin;
+export default navigatePlugin;

package/dist/src/plugins/request.d.ts

@@ -0,0 +1,89 @@
+import { BridgePlugin, PluginContext, CallbacksBase } from '../core';
+
+export interface RequestOptions extends CallbacksBase {
+    url: string;
+    method?: "GET" | "POST";
+    headers?: Record<string, string>;
+    data?: Record<string, any>;
+    timeout?: number;
+    cacheModel: "noStore" | "noCache" | "smartCache" | "firstCache";
+    dataType?: "json" | "text" | 'base64';
+}
+export interface RequestResponse {
+    status: number;
+    data: any;
+    headers: Record<string, string>;
+}
+export interface UploadFileOptions extends CallbacksBase {
+    url: string;
+    filePath: string;
+    fileName: string;
+    fileType: 'image' | 'video' | 'audio';
+    formData?: Record<string, any>;
+    header?: Record<string, string>;
+}
+export interface UploadFileResponse {
+    statusCode: number;
+    data: string;
+    headers: Record<string, string>;
+}
+export interface DownloadFileOptions extends CallbacksBase {
+    url: string;
+    header?: Record<string, string>;
+}
+export interface DownloadFileResponse {
+    filePath: string;
+}
+declare module "../core" {
+    interface PluginMethods {
+        httpRequest: (options: RequestOptions) => Promise<RequestResponse>;
+        httpRequestSync: (options: RequestOptions) => void;
+        uploadFile: (options: UploadFileOptions) => Promise<UploadFileResponse>;
+        downloadFile: (options: DownloadFileOptions) => Promise<DownloadFileResponse>;
+    }
+    interface NativeBridgeCore extends PluginMethods {
+    }
+}
+/**
+ * 网络请求插件类
+ */
+declare class RequestPlugin implements BridgePlugin {
+    readonly name = "request";
+    readonly version = "1.0.0";
+    private context?;
+    /**
+     * 安装插件
+     */
+    install(context: PluginContext): void;
+    /**
+    * 执行HTTP请求
+    * @param options 请求配置选项
+    *   @property {string} url 请求URL(必需)
+    *   @property {string} [method] HTTP方法，默认为'GET'
+    *   @property {Object} [headers] 请求头，默认为{'Content-Type': 'application/x-www-form-urlencoded'}
+    *   @property {Object} [data] 请求数据，默认为{}
+    *   @property {string} [dataType] 响应数据类型，默认为'json'
+    *   @property {number} [timeout] 超时时间(毫秒)，默认为30000
+    *   @property {string} [cacheModel] 缓存模式，默认为'noStore'
+    * @returns {Promise<RequestResponse>} 返回一个Promise，解析为请求响应结果
+    */
+    httpRequest(options: RequestOptions): Promise<RequestResponse>;
+    /**
+     *
+     */
+    httpRequestSync(options: RequestOptions): void;
+    /**
+     * 执行文件上传
+     * @param options 上传文件选项
+     * @returns Promise<UploadFileResponse> 返回上传结果
+     */
+    uploadFile(options: UploadFileOptions): Promise<UploadFileResponse>;
+    /**
+     * 执行文件下载
+     * @param options 下载文件选项
+     * @returns Promise<DownloadFileResponse> 返回下载结果
+     */
+    downloadFile(options: DownloadFileOptions): Promise<DownloadFileResponse>;
+}
+declare const _default: RequestPlugin;
+export default _default;

package/dist/src/plugins/storage.d.ts

@@ -0,0 +1,52 @@
+import { BridgePlugin, PluginContext, CallbacksBase } from '../core';
+
+export interface SetStorageOptions extends CallbacksBase {
+    key: string;
+    data: Record<string, any> | string;
+}
+export interface GetStorageOptions extends CallbacksBase {
+    key: string;
+}
+export interface RemoveStorageOptions extends CallbacksBase {
+    key: string;
+}
+export interface StorageResponse {
+    data?: Record<string, any> | string;
+}
+declare module "../core" {
+    interface PluginMethods {
+        setStorage: (options: SetStorageOptions) => Promise<string>;
+        setStorageSync: (options: SetStorageOptions) => any;
+        getStorage: (options: GetStorageOptions) => Promise<string>;
+        getStorageSync: (options: GetStorageOptions) => any;
+        removeStorage: (options: RemoveStorageOptions) => Promise<string>;
+    }
+    interface NativeBridgeCore extends PluginMethods {
+    }
+}
+declare class StoragePlugin implements BridgePlugin {
+    private context?;
+    readonly name = "storage";
+    readonly version = "1.0.0";
+    install(context: PluginContext): void;
+    private _createCallbacks;
+    private _callNativeMethod;
+    /**
+     * 同步设置存储数据
+     * @param options 存储选项，包含键值和数据
+     * @returns 存储响应
+     * @throws 如果未提供key，则抛出错误
+     */
+    setStorageSync(options: SetStorageOptions): void;
+    setStorage(options: SetStorageOptions): Promise<string>;
+    getStorageSync(options: GetStorageOptions): any;
+    getStorage(options: GetStorageOptions): Promise<string>;
+    /**
+     * 移除指定的存储数据（异步）
+     * @param options 存储选项，包含键值
+     * @returns 存储响应
+     */
+    removeStorage(options: RemoveStorageOptions): Promise<string>;
+}
+declare const _default: StoragePlugin;
+export default _default;

package/dist/src/plugins/toast.d.ts

@@ -0,0 +1,47 @@
+import { BridgePlugin, PluginContext } from '../core';
+
+export interface ToastParams {
+    /** toast的类型 none, success, fail, exception*/
+    type?: "none" | "success" | "fail" | "exception";
+    /** 提示信息 */
+    content: string;
+    /** 显示持续时间，单位毫秒，默认2000ms，按系统规范[android只有两种(<=2s >2s)] */
+    duration?: number;
+}
+export interface LoadingParams {
+    /** 提示信息 */
+    content?: string;
+}
+declare module "../core" {
+    interface PluginMethods {
+        showToast: (options: ToastParams) => Promise<void>;
+        hideToast: () => Promise<void>;
+        showLoading: (options: LoadingParams) => Promise<void>;
+        hideLoading: () => Promise<void>;
+    }
+    interface NativeBridgeCore extends PluginMethods {
+    }
+}
+declare class ToastPlugin implements BridgePlugin {
+    readonly name = "toast";
+    readonly version = "1.0.0";
+    private context?;
+    install(context: PluginContext): void;
+    hideLoading(): Promise<void>;
+    showLoading(options: LoadingParams): Promise<void>;
+    /**
+     * 显示Toast提示
+     *
+     * @param options Toast参数
+     * @returns Promise<void>
+     */
+    showToast(options: ToastParams): Promise<void>;
+    /**
+     * 隐藏Toast提示
+     *
+     * @returns Promise<void>
+     */
+    hideToast(): Promise<void>;
+}
+export declare const toastPlugin: ToastPlugin;
+export default toastPlugin;

package/dist/src/plugins/userInfo.d.ts

@@ -0,0 +1,30 @@
+import { BridgePlugin, PluginContext } from '../core';
+
+export interface ToastParams {
+    /** toast的类型 none, success, fail, exception*/
+    type: "none" | "success" | "fail" | "exception";
+    /** 提示信息 */
+    content: string;
+    /** 显示持续2000ms时间，单位秒，默认按系统规范[android只有两种(<=2s >2s)] */
+    duration?: number;
+}
+export interface LoadingParams {
+    /** 提示信息 */
+    content?: string;
+}
+declare module "../core" {
+    interface PluginMethods {
+        getUserInfo: () => Promise<any>;
+    }
+    interface NativeBridgeCore extends PluginMethods {
+    }
+}
+declare class UserInfoPlugin implements BridgePlugin {
+    readonly name = "UserInfo";
+    readonly version = "1.0.0";
+    private context?;
+    install(context: PluginContext): void;
+    getUserInfo(): Promise<any>;
+}
+export declare const userinfoPlugin: UserInfoPlugin;
+export default userinfoPlugin;