@hd-front-end/jsbridge-sdk 1.0.1

package/dist/index.d.ts

@@ -0,0 +1,645 @@
+/**
+ * JSBridge SDK 类型定义
+ */
+type Platform = 'android' | 'ios' | 'unknown';
+interface JSBridgeConfig {
+    debug?: DebugConfig;
+    monitor?: MonitorConfig;
+}
+interface DebugConfig {
+    enabled: boolean;
+    useVConsole?: boolean;
+    logLevel?: 'debug' | 'info' | 'warn' | 'error';
+    showTimestamp?: boolean;
+}
+interface MonitorConfig {
+    enabled: boolean;
+    autoReport?: boolean;
+    reportInterval?: number;
+    maxRecords?: number;
+    logTag?: string;
+}
+declare enum LogLevel {
+    DEBUG = "DEBUG",
+    INFO = "INFO",
+    WARN = "WARN",
+    ERROR = "ERROR"
+}
+interface LogRequest {
+    tag?: string;
+    level: LogLevel;
+    message: string;
+}
+interface ScanRequest {
+    scanType?: ('qrCode' | 'barCode')[];
+    hideAlbum?: boolean;
+}
+interface ScanResult {
+    resp_code: number;
+    resp_result: string;
+    resp_message?: string;
+}
+interface DeviceInfo {
+    model: string;
+    system: string;
+    version: string;
+    platform: string;
+    [key: string]: any;
+}
+interface NetworkInfo {
+    networkType: 'wifi' | '2g' | '3g' | '4g' | '5g' | 'none' | 'unknown';
+}
+interface ChooseMediaRequest {
+    count?: number;
+    mediaType?: ('image' | 'video')[];
+    sourceType?: ('album' | 'camera')[];
+    maxDuration?: number;
+    sizeType?: ('original' | 'compressed')[];
+}
+interface MediaFile {
+    tempFilePath: string;
+    size: number;
+    duration?: number;
+    height?: number;
+    width?: number;
+    thumbTempFilePath?: string;
+    fileType?: 'image' | 'video';
+}
+interface ChooseMediaResult {
+    tempFiles: MediaFile[];
+    type?: 'image' | 'video';
+}
+interface ImageInfo {
+    width: number;
+    height: number;
+    path: string;
+    orientation?: string;
+    type?: string;
+}
+interface UploadFileRequest {
+    url: string;
+    filePath: string;
+    name: string;
+    header?: Record<string, string>;
+    formData?: Record<string, any>;
+    timeout?: number;
+}
+interface UploadFileResult {
+    data: string;
+    statusCode: number;
+    errMsg?: string;
+}
+interface PrintRequest {
+    data: any;
+    [key: string]: any;
+}
+interface NavigationBarStyle {
+    navigationBarTitleText?: string;
+    backgroundColor?: string;
+    textColor?: string;
+    hideNavigationBar?: boolean;
+}
+interface RouteInfo {
+    path: string;
+    query?: Record<string, any>;
+}
+interface StorageData {
+    key: string;
+    data: any;
+}
+interface AppInfo {
+    appId: string;
+    version: string;
+    platform: Platform;
+    [key: string]: any;
+}
+interface PhoneCallRequest {
+    phoneNumber: string;
+}
+interface MonitorRecord {
+    api: string;
+    timestamp: number;
+    duration: number;
+    success: boolean;
+    error?: string;
+    platform: Platform;
+}
+interface MonitorStats {
+    totalCalls: number;
+    successCalls: number;
+    failedCalls: number;
+    avgDuration: number;
+    successRate: number;
+}
+interface DebugLog {
+    timestamp: number;
+    level: 'debug' | 'info' | 'warn' | 'error';
+    api: string;
+    message: string;
+    data?: any;
+}
+
+declare global {
+    interface Window {
+        WKWebViewJavascriptBridge: any;
+        WKWVJBCallbacks: Array<(bridge: any) => void>;
+        InjectJavascript: {
+            init: () => void;
+        };
+    }
+}
+
+/**
+ * 日志 API
+ *
+ * 参考：context/soa/src/jsBridge/JsBridgeHandlers.ts (line 152-154)
+ * 优化：增强类型安全、支持批量日志、支持日志队列
+ */
+
+/**
+ * 写入日志到原生端
+ *
+ * @example
+ * await writeLog({
+ *   tag: 'MyApp',
+ *   level: LogLevel.INFO,
+ *   message: '用户点击了按钮'
+ * })
+ */
+declare function writeLog(request: LogRequest): Promise<void>;
+
+/**
+ * 设备相关 API
+ *
+ * 参考：context/soa/src/jsBridge/JsBridgeHandlers.ts
+ */
+
+/**
+ * 扫码
+ * 参考：JsBridgeHandlers.ts line 75-87
+ *
+ * @example
+ * const result = await scan({ scanType: ['qrCode', 'barCode'] })
+ * if (result.resp_code === 1000) {
+ *   console.log('扫码结果:', result.resp_result)
+ * }
+ */
+declare function scan(request?: ScanRequest): Promise<ScanResult>;
+/**
+ * 震动
+ *
+ * @param duration 震动时长（毫秒），默认 400ms
+ */
+declare function vibrate(duration?: number): Promise<void>;
+/**
+ * 获取设备信息
+ *
+ * @example
+ * const info = await getDeviceInfo()
+ * console.log('设备型号:', info.model)
+ * console.log('系统版本:', info.version)
+ */
+declare function getDeviceInfo(): Promise<DeviceInfo>;
+/**
+ * 获取网络类型
+ *
+ * @example
+ * const network = await getNetworkType()
+ * console.log('网络类型:', network.networkType)
+ */
+declare function getNetworkType(): Promise<NetworkInfo>;
+
+/**
+ * 媒体相关 API
+ *
+ * 参考：context/soa/src/jsBridge/JsBridgeHandlers.ts
+ */
+
+/**
+ * 选择图片/视频
+ * 参考：JsBridgeHandlers.ts line 93-100
+ *
+ * @example
+ * const result = await chooseMedia({
+ *   count: 9,
+ *   mediaType: ['image'],
+ *   sourceType: ['album', 'camera']
+ * })
+ */
+declare function chooseMedia(request: ChooseMediaRequest): Promise<ChooseMediaResult | null>;
+/**
+ * 上传文件
+ * 参考：JsBridgeHandlers.ts line 117-122
+ *
+ * @example
+ * const result = await uploadFile({
+ *   url: 'https://api.example.com/upload',
+ *   filePath: '/path/to/file',
+ *   name: 'file'
+ * })
+ */
+declare function uploadFile(request: UploadFileRequest): Promise<UploadFileResult>;
+/**
+ * 预览图片
+ *
+ * @param urls 图片URL数组
+ * @param current 当前显示图片的索引，默认 0
+ */
+declare function previewImage(urls: string[], current?: number): Promise<void>;
+/**
+ * 获取图片信息
+ * 参考：JsBridgeHandlers.ts line 106-111
+ *
+ * @param path 图片路径
+ */
+declare function getImageInfo(path: string): Promise<ImageInfo>;
+/**
+ * 蓝牙打印
+ * 参考：JsBridgeHandlers.ts line 182-194
+ *
+ * @param request 打印请求
+ */
+declare function bluetoothPrint(request: PrintRequest): Promise<any>;
+
+/**
+ * 路由相关 API
+ *
+ * 参考：context/soa/src/jsBridge/JsBridgeHandlers.ts
+ */
+
+/**
+ * 设置导航栏样式
+ * 参考：JsBridgeHandlers.ts line 144-146
+ *
+ * @example
+ * await setNavigationBar({
+ *   navigationBarTitleText: '订单详情',
+ *   backgroundColor: '#ffffff',
+ *   textColor: '#000000'
+ * })
+ */
+declare function setNavigationBar(style: NavigationBarStyle): Promise<void>;
+/**
+ * 关闭当前 WebView
+ * 参考：JsBridgeHandlers.ts line 128-130
+ *
+ * @example
+ * await closeWebView()
+ */
+declare function closeWebView(): Promise<void>;
+/**
+ * 注册路由跳转回调
+ * 参考：JsBridgeHandlers.ts line 44-46
+ *
+ * @example
+ * onRoute((data, callback) => {
+ *   console.log('路由跳转:', data)
+ *   router.push(data.path)
+ *   callback({ success: true })
+ * })
+ */
+declare function onRoute(handler: (data: any, callback: (response: any) => void) => void): Promise<void>;
+/**
+ * 注册获取路由信息回调
+ * 参考：JsBridgeHandlers.ts line 51-53
+ *
+ * @example
+ * onGetRouteInfo((data, callback) => {
+ *   callback({ routes: routeConfig })
+ * })
+ */
+declare function onGetRouteInfo(handler: (data: any, callback: (response: any) => void) => void): Promise<void>;
+/**
+ * 通知原生路由变化
+ * 参考：JsBridgeHandlers.ts line 21-23
+ *
+ * @param to 目标路由
+ * @param from 来源路由
+ */
+declare function notifyRouteChange(to: RouteInfo, from: RouteInfo): Promise<void>;
+
+/**
+ * 存储相关 API
+ *
+ * 参考：context/soa/src/jsBridge/JsBridgeHandlers.ts
+ */
+
+/**
+ * 获取 App 信息
+ * 参考：JsBridgeHandlers.ts line 28-30
+ *
+ * @example
+ * const appInfo = await getAppInfo()
+ * console.log('App 版本:', appInfo.version)
+ */
+declare function getAppInfo(): Promise<AppInfo>;
+/**
+ * 获取存储数据
+ *
+ * @param key 存储键
+ */
+declare function getStorage(key: string): Promise<any>;
+/**
+ * 设置存储数据
+ *
+ * @param key 存储键
+ * @param data 存储数据
+ */
+declare function setStorage(key: string, data: any): Promise<void>;
+/**
+ * 注册刷新 store 数据回调
+ * 参考：JsBridgeHandlers.ts line 59-61
+ *
+ * @example
+ * onRefreshStore((data, callback) => {
+ *   store.dispatch('refresh', data)
+ *   callback({ success: true })
+ * })
+ */
+declare function onRefreshStore(handler: (data: any, callback: (response: any) => void) => void): Promise<void>;
+/**
+ * 通知原生 App 已加载完成
+ * 参考：JsBridgeHandlers.ts line 160-162
+ *
+ * @param data 启动数据
+ */
+declare function notifyAppOnload(data?: any): Promise<void>;
+
+/**
+ * 系统相关 API
+ *
+ * 参考：context/soa/src/jsBridge/JsBridgeHandlers.ts
+ */
+
+/**
+ * 拨打电话
+ * 参考：JsBridgeHandlers.ts line 136-138
+ *
+ * @example
+ * await makePhoneCall({ phoneNumber: '10086' })
+ */
+declare function makePhoneCall(request: PhoneCallRequest): Promise<void>;
+/**
+ * 注册 PDA 扫码回调
+ * 参考：JsBridgeHandlers.ts line 67-69
+ *
+ * @example
+ * onPdaScan((data, callback) => {
+ *   console.log('PDA 扫码结果:', data)
+ *   callback({ success: true })
+ * })
+ */
+declare function onPdaScan(handler: (data: any, callback: (response: any) => void) => void): Promise<void>;
+/**
+ * 退出登录
+ *
+ * @example
+ * await logout()
+ */
+declare function logout(): Promise<void>;
+
+/**
+ * 初始化 JSBridge SDK
+ *
+ * @example
+ * const success = await init({
+ *   debug: {
+ *     enabled: true,
+ *     useVConsole: true
+ *   },
+ *   monitor: {
+ *     enabled: true,
+ *     autoReport: true
+ *   }
+ * })
+ */
+declare function init(config?: JSBridgeConfig): Promise<boolean>;
+/**
+ * 检查是否在 App 内
+ */
+declare function inApp(): boolean;
+/**
+ * 获取平台类型
+ */
+declare function getPlatform(): Platform;
+/**
+ * 检查是否已初始化
+ */
+declare function isReady(): boolean;
+/**
+ * JSBridge API
+ * 所有可用的原生能力
+ */
+declare const JSBridge: {
+    /**
+     * 扫码
+     * @example
+     * const result = await JSBridge.scan({ scanType: ['qrCode'] })
+     */
+    scan: typeof scan;
+    /**
+     * 震动
+     * @example
+     * await JSBridge.vibrate(400)
+     */
+    vibrate: typeof vibrate;
+    /**
+     * 获取设备信息
+     * @example
+     * const info = await JSBridge.getDeviceInfo()
+     */
+    getDeviceInfo: typeof getDeviceInfo;
+    /**
+     * 获取网络类型
+     * @example
+     * const network = await JSBridge.getNetworkType()
+     */
+    getNetworkType: typeof getNetworkType;
+    /**
+     * 选择图片/视频
+     * @example
+     * const result = await JSBridge.chooseMedia({ count: 9, mediaType: ['image'] })
+     */
+    chooseMedia: typeof chooseMedia;
+    /**
+     * 上传文件
+     * @example
+     * const result = await JSBridge.uploadFile({ url, filePath, name: 'file' })
+     */
+    uploadFile: typeof uploadFile;
+    /**
+     * 预览图片
+     * @example
+     * await JSBridge.previewImage(['url1', 'url2'], 0)
+     */
+    previewImage: typeof previewImage;
+    /**
+     * 获取图片信息
+     * @example
+     * const info = await JSBridge.getImageInfo(path)
+     */
+    getImageInfo: typeof getImageInfo;
+    /**
+     * 蓝牙打印
+     * @example
+     * await JSBridge.bluetoothPrint({ data: printData })
+     */
+    bluetoothPrint: typeof bluetoothPrint;
+    /**
+     * 设置导航栏
+     * @example
+     * await JSBridge.setNavigationBar({ navigationBarTitleText: '标题' })
+     */
+    setNavigationBar: typeof setNavigationBar;
+    /**
+     * 关闭当前页面
+     * @example
+     * await JSBridge.closeWebView()
+     */
+    closeWebView: typeof closeWebView;
+    /**
+     * 注册路由跳转回调
+     * @example
+     * JSBridge.onRoute((data, callback) => { router.push(data.path) })
+     */
+    onRoute: typeof onRoute;
+    /**
+     * 注册获取路由信息回调
+     * @example
+     * JSBridge.onGetRouteInfo((data, callback) => { callback(routeConfig) })
+     */
+    onGetRouteInfo: typeof onGetRouteInfo;
+    /**
+     * 通知路由变化
+     * @example
+     * await JSBridge.notifyRouteChange(to, from)
+     */
+    notifyRouteChange: typeof notifyRouteChange;
+    /**
+     * 获取 App 信息
+     * @example
+     * const appInfo = await JSBridge.getAppInfo()
+     */
+    getAppInfo: typeof getAppInfo;
+    /**
+     * 获取存储数据
+     * @example
+     * const data = await JSBridge.getStorage('key')
+     */
+    getStorage: typeof getStorage;
+    /**
+     * 设置存储数据
+     * @example
+     * await JSBridge.setStorage('key', data)
+     */
+    setStorage: typeof setStorage;
+    /**
+     * 注册刷新 store 回调
+     * @example
+     * JSBridge.onRefreshStore((data, callback) => { store.dispatch('refresh') })
+     */
+    onRefreshStore: typeof onRefreshStore;
+    /**
+     * 通知 App 加载完成
+     * @example
+     * await JSBridge.notifyAppOnload()
+     */
+    notifyAppOnload: typeof notifyAppOnload;
+    /**
+     * 拨打电话
+     * @example
+     * await JSBridge.makePhoneCall({ phoneNumber: '10086' })
+     */
+    makePhoneCall: typeof makePhoneCall;
+    /**
+     * 注册 PDA 扫码回调
+     * @example
+     * JSBridge.onPdaScan((data, callback) => { console.log(data) })
+     */
+    onPdaScan: typeof onPdaScan;
+    /**
+     * 退出登录
+     * @example
+     * await JSBridge.logout()
+     */
+    logout: typeof logout;
+    /**
+     * 写入日志
+     * @example
+     * await JSBridge.writeLog({ level: LogLevel.INFO, message: '日志' })
+     */
+    writeLog: typeof writeLog;
+    /**
+     * 便捷日志方法
+     * @example
+     * await JSBridge.log.info('用户登录', 'Auth')
+     * await JSBridge.log.error('请求失败', 'Network')
+     */
+    log: {
+        debug: (message: string, tag?: string) => Promise<void>;
+        info: (message: string, tag?: string) => Promise<void>;
+        warn: (message: string, tag?: string) => Promise<void>;
+        error: (message: string, tag?: string) => Promise<void>;
+    };
+};
+/**
+ * 监控 API
+ */
+declare const Monitor: {
+    /**
+     * 获取统计信息
+     * @example
+     * const stats = Monitor.getStats()
+     */
+    getStats: () => MonitorStats;
+    /**
+     * 获取所有记录
+     * @example
+     * const records = Monitor.getRecords()
+     */
+    getRecords: () => MonitorRecord[];
+    /**
+     * 清空记录
+     * @example
+     * Monitor.clear()
+     */
+    clear: () => void;
+    /**
+     * 手动上报
+     * @example
+     * await Monitor.report()
+     */
+    report: () => Promise<void>;
+    /**
+     * 上报错误
+     * @example
+     * await Monitor.reportError('api', 'error message')
+     */
+    reportError: (api: string, error: string, detail?: any) => Promise<void>;
+};
+/**
+ * Debug API
+ */
+declare const Debug: {
+    /**
+     * 记录追踪日志
+     * @example
+     * Debug.trace('api', 'message', data)
+     */
+    trace: (api: string, message: string, data?: any) => void;
+    /**
+     * 获取所有日志
+     * @example
+     * const logs = Debug.getLogs()
+     */
+    getLogs: () => DebugLog[];
+    /**
+     * 清空日志
+     * @example
+     * Debug.clearLogs()
+     */
+    clearLogs: () => void;
+};
+
+export { Debug, JSBridge, LogLevel, Monitor, getPlatform, inApp, init, isReady };
+export type { AppInfo, ChooseMediaRequest, ChooseMediaResult, DebugConfig, DebugLog, DeviceInfo, ImageInfo, JSBridgeConfig, LogRequest, MediaFile, MonitorConfig, MonitorRecord, MonitorStats, NavigationBarStyle, NetworkInfo, PhoneCallRequest, Platform, PrintRequest, RouteInfo, ScanRequest, ScanResult, StorageData, UploadFileRequest, UploadFileResult };