qsh-webview-sdk 2.0.4 → 2.0.6

package/dist/index.d.ts

@@ -1,137 +1,321 @@
-/**
- * UniApp WebView SDK 类型定义
- */
-
-declare namespace UniWebView {
-  /**
-   * 导航选项
-   */
-  interface NavigateOptions {
-    /** 目标页面路径 */
-    url: string;
-  }
-
-  /**
-   * 返回选项
-   */
-  interface NavigateBackOptions {
-    /** 返回的页面数，默认1 */
-    delta?: number;
-  }
-
-  /**
-   * 消息选项
-   */
-  interface PostMessageOptions {
-    /** 要发送的数据 */
-    data?: any;
-  }
-
-  /**
-   * 环境信息
-   */
-  interface EnvironmentInfo {
-    /** 是否微信小程序环境 */
-    miniprogram?: boolean;
-    /** 是否微信环境 */
-    weixin?: boolean;
-    /** 是否 APP 环境 */
-    app?: boolean;
-    /** 是否 Plus 环境 */
-    plus?: boolean;
-    /** 是否 NVUE 环境 */
-    nvue?: boolean;
-    /** 是否 UVUE 环境 */
-    uvue?: boolean;
-    /** 是否 H5 环境 */
-    h5?: boolean;
-  }
-
-  /**
-   * 环境对象
-   */
-  interface Environment {
-    /** 是否微信小程序环境 */
-    isWeixinMiniProgram: boolean;
-    /** 是否 APP Plus 环境 */
-    isAppPlus: boolean;
-    /** 是否 NVUE 环境 */
-    isNvue: boolean;
-    /** 是否 UVUE 环境 */
-    isUvue: boolean;
-    /** 是否 UniApp 环境 */
-    isUniApp: boolean;
-    /** 是否 Html5Plus 环境 */
-    isHtml5Plus: boolean;
-    /** 环境类型 */
-    type: 'weixin' | 'plus' | 'nvue' | 'uvue' | 'h5';
-  }
-
-  /**
-   * WebView 对象接口
-   */
-  interface WebView {
-    navigateTo(options: NavigateOptions): void;
-    navigateBack(options?: NavigateBackOptions): void;
-    switchTab(options: NavigateOptions): void;
-    reLaunch(options: NavigateOptions): void;
-    redirectTo(options: NavigateOptions): void;
-    postMessage(options?: PostMessageOptions): void;
-    getEnv(callback: (info: EnvironmentInfo) => void): void;
-  }
-
-  /**
-   * Uni 对象接口
-   */
-  interface Uni extends WebView {
-    /** 环境信息 */
-    environment: Environment;
-    /** 等待桥接准备就绪 */
-    ready(): Promise<void>;
-    /** WebView 对象（兼容旧版本） */
-    webView: WebView | null;
-    /** 加密 API（SM2/SM3/SM4） */
-    crypto: {
-      // SM2
-      sm2GenerateKeyPair(random?: any): { publicKey: string; privateKey: string };
-      sm2Encrypt(message: string | number[], publicKey: string, cipherMode?: 0 | 1, options?: Record<string, any>): string | number[];
-      sm2Decrypt(cipherText: string | number[], privateKey: string, cipherMode?: 0 | 1, options?: { output?: 'array' | 'string' }): string | number[];
-      sm2Sign(message: string | number[], privateKey: string, options?: Record<string, any>): string;
-      sm2Verify(message: string | number[], signatureHex: string, publicKey: string, options?: Record<string, any>): boolean;
-      sm2GetPublicKey(privateKey: string): string;
-      sm2GetPoint(): any;
-      sm2CompressPublicKey(publicKey: string): string;
-      sm2ComparePublicKey(a: string, b: string): boolean;
-      sm2VerifyPublicKey(publicKey: string): boolean;
-      // SM3
-      sm3Hash(message: string | number[], options?: { key?: string | number[] }): string;
-      // SM4
-      sm4Encrypt(message: string | number[], key: string | number[], options?: { padding?: 'pkcs#7' | 'pkcs#5' | 'none'; output?: 'array' | 'string'; mode?: 'ecb' | 'cbc'; iv?: string | number[] }): string | number[];
-      sm4Decrypt(cipherText: string | number[], key: string | number[], options?: { padding?: 'pkcs#7' | 'pkcs#5' | 'none'; output?: 'array' | 'string'; mode?: 'ecb' | 'cbc'; iv?: string | number[] }): string | number[];
-      __raw__: any;
-    };
-  }
-}
-
-/**
- * 全局 qsh/uni 对象（默认导出为模块默认值）
- */
-declare const qsh: UniWebView.Uni;
-declare const uni: UniWebView.Uni;
-
-/**
- * 模块导出
- */
-export default qsh;
-
-/**
- * 全局声明
- */
-declare global {
-  interface Window {
-    qsh: UniWebView.Uni;
-    UniAppJSBridge?: boolean;
-  }
-}
-
+/**
+ * UniApp WebView SDK 类型定义
+ */
+
+declare namespace UniWebView {
+  /**
+   * 导航选项
+   */
+  interface NavigateOptions {
+    /** 目标页面路径 */
+    url: string;
+  }
+
+  /**
+   * 返回选项
+   */
+  interface NavigateBackOptions {
+    /** 返回的页面数，默认1 */
+    delta?: number;
+  }
+
+  /**
+   * 消息选项
+   */
+  interface PostMessageOptions {
+    /** 要发送的数据 */
+    data?: any;
+  }
+
+  /**
+   * 环境信息
+   */
+  interface EnvironmentInfo {
+    /** 是否微信小程序环境 */
+    miniprogram?: boolean;
+    /** 是否微信环境 */
+    weixin?: boolean;
+    /** 是否 APP 环境 */
+    app?: boolean;
+    /** 是否 Plus 环境 */
+    plus?: boolean;
+    /** 是否 NVUE 环境 */
+    nvue?: boolean;
+    /** 是否 UVUE 环境 */
+    uvue?: boolean;
+    /** 是否 H5 环境 */
+    h5?: boolean;
+  }
+
+  /**
+   * 图片选择选项
+   */
+  interface ChooseImageOptions {
+    /** 最多选择的图片数量，默认9 */
+    count?: number;
+    /** 图片质量类型 */
+    sizeType?: ('original' | 'compressed')[];
+    /** 图片来源类型 */
+    sourceType?: ('album' | 'camera')[];
+    /** 成功回调 */
+    success?: (res: ChooseImageResult) => void;
+    /** 失败回调 */
+    fail?: (error: any) => void;
+    /** 完成回调（无论成功失败） */
+    complete?: () => void;
+  }
+
+  /**
+   * 图片选择结果（微信环境）
+   */
+  interface WeixinChooseImageResult {
+    /** 图片本地ID列表 */
+    localIds: string[];
+    /** 错误信息 */
+    errMsg?: string;
+  }
+
+  /**
+   * 图片选择结果（UniApp环境）
+   */
+  interface UniAppChooseImageResult {
+    /** 图片临时文件路径列表 */
+    tempFilePaths: string[];
+    /** 图片临时文件信息 */
+    tempFiles?: {
+      path: string;
+      size: number;
+    }[];
+    /** 错误信息 */
+    errMsg?: string;
+  }
+
+  /**
+   * 统一的图片选择结果
+   */
+  type ChooseImageResult = WeixinChooseImageResult | UniAppChooseImageResult;
+
+  /**
+   * 图片来源类型枚举
+   */
+  interface ImageSourceTypesEnum {
+    readonly ALBUM: 'album';
+    readonly CAMERA: 'camera';
+  }
+
+  /**
+   * 图片大小类型枚举
+   */
+  interface ImageSizeTypesEnum {
+    readonly ORIGINAL: 'original';
+    readonly COMPRESSED: 'compressed';
+  }
+
+  /**
+   * 图片功能能力信息
+   */
+  interface ImageCapabilities {
+    /** 是否支持图片选择功能 */
+    supported: boolean;
+    /** 当前环境类型 */
+    environment: string;
+    /** 底层实现类型 */
+    implementation: string;
+    /** 功能特性 */
+    features: {
+      multipleSelection: boolean;
+      sizeTypeSelection: boolean;
+      sourceTypeSelection: boolean;
+      asyncSupport: boolean;
+    };
+  }
+
+  /**
+   * 位置选择选项
+   */
+  interface ChooseLocationOptions {
+    /** 目标地纬度 */
+    latitude?: number;
+    /** 目标地经度 */
+    longitude?: number;
+    /** 成功回调 */
+    success?: (res: ChooseLocationResult) => void;
+    /** 失败回调 */
+    fail?: (error: any) => void;
+    /** 完成回调（无论成功失败） */
+    complete?: () => void;
+  }
+
+  /**
+   * 位置选择结果
+   */
+  interface ChooseLocationResult {
+    /** 位置名称 */
+    name: string;
+    /** 详细地址 */
+    address: string;
+    /** 纬度 */
+    latitude: number;
+    /** 经度 */
+    longitude: number;
+    /** 错误信息 */
+    errMsg?: string;
+  }
+
+  /**
+   * 位置选择功能能力信息
+   */
+  interface ChooseLocationCapabilities {
+    /** 是否支持位置选择功能 */
+    supported: boolean;
+    /** 当前环境类型 */
+    environment: string;
+    /** 底层实现类型 */
+    implementation: string;
+    /** 功能特性 */
+    features: {
+      /** 支持位置选择 */
+      chooseLocation: boolean;
+      /** 支持指定中心点（latitude/longitude） */
+      centerPoint: boolean;
+      /** 支持 Promise */
+      asyncSupport: boolean;
+    };
+  }
+
+  /**
+   * 环境对象
+   */
+  interface Environment {
+    /** 是否微信小程序环境 */
+    isWeixinMiniProgram: boolean;
+    /** 是否 APP Plus 环境 */
+    isAppPlus: boolean;
+    /** 是否 NVUE 环境 */
+    isNvue: boolean;
+    /** 是否 UVUE 环境 */
+    isUvue: boolean;
+    /** 是否 UniApp 环境 */
+    isUniApp: boolean;
+    /** 是否 Html5Plus 环境 */
+    isHtml5Plus: boolean;
+    /** 环境类型 */
+    type: 'weixin' | 'plus' | 'nvue' | 'uvue' | 'UniApp' | 'webview' | 'h5';
+  }
+
+  /**
+   * 微信分享选项
+   */
+  interface ShareOptions {
+    /** 分享去向：0 聊天，1 朋友圈 */
+    scene?: 0 | 1;
+    /** 分享内容类型：0 图文，1 文字，2 图片，3 音乐，4 视频，5 小程序 */
+    type: 0 | 1 | 2 | 3 | 4 | 5;
+    title?: string;
+    summary?: string;
+    imageUrl?: string;
+    path?: string;
+    miniProgram?: Record<string, any>;
+    success?: (res: ShareResult) => void;
+    fail?: (error: any) => void;
+    complete?: () => void;
+  }
+
+  interface ShareResult {
+    errMsg?: string;
+    [key: string]: any;
+  }
+
+  interface BluetoothOptions {
+    success?: (res: any) => void;
+    fail?: (error: any) => void;
+    complete?: () => void;
+    [key: string]: any;
+  }
+
+  /**
+   * WebView 对象接口
+   */
+  interface WebView {
+    navigateTo(options: NavigateOptions): void;
+    navigateBack(options?: NavigateBackOptions): void;
+    switchTab(options: NavigateOptions): void;
+    reLaunch(options: NavigateOptions): void;
+    redirectTo(options: NavigateOptions): void;
+    postMessage(options?: PostMessageOptions): void;
+    getEnv(callback: (info: EnvironmentInfo) => void): void;
+    chooseImage(options?: ChooseImageOptions): void;
+    chooseLocation(options?: ChooseLocationOptions): void;
+  }
+
+  /**
+   * Uni 对象接口
+   */
+  interface Uni extends WebView {
+    /** 环境信息 */
+    environment: Environment;
+    /** 等待桥接准备就绪 */
+    ready(): Promise<void>;
+    /** WebView 对象（兼容旧版本） */
+    webView: WebView | null;
+    
+    /** 图片选择（Promise版本） */
+    chooseImageAsync(options?: Omit<ChooseImageOptions, 'success' | 'fail' | 'complete'>): Promise<ChooseImageResult>;
+    /** 获取图片功能能力信息 */
+    getImageCapabilities(): ImageCapabilities;
+    
+    /** 位置选择（Promise版本） */
+    chooseLocationAsync(options?: Omit<ChooseLocationOptions, 'success' | 'fail' | 'complete'>): Promise<ChooseLocationResult>;
+    /** 获取位置选择功能能力信息 */
+    getChooseLocationCapabilities(): ChooseLocationCapabilities;
+    
+    /** 图片来源类型枚举 */
+    ImageSourceTypes: ImageSourceTypesEnum;
+    /** 图片大小类型枚举 */
+    ImageSizeTypes: ImageSizeTypesEnum;
+
+    /** 微信分享 */
+    toShare(options: ShareOptions): Promise<ShareResult> | void;
+    toShareAsync(options: Omit<ShareOptions, 'success' | 'fail' | 'complete'>): Promise<ShareResult>;
+
+    /** 蓝牙 API */
+    openBluetoothAdapter(options?: BluetoothOptions): Promise<any> | void;
+    openBluetoothAdapterAsync(options?: BluetoothOptions): Promise<any>;
+    startBluetoothDevicesDiscovery(options?: BluetoothOptions): Promise<any> | void;
+    startBluetoothDevicesDiscoveryAsync(options?: BluetoothOptions): Promise<any>;
+    onBluetoothDeviceFound(options?: BluetoothOptions): Promise<any> | void;
+    onBluetoothDeviceFoundAsync(options?: BluetoothOptions): Promise<any>;
+    createBLEConnection(options?: BluetoothOptions): Promise<any> | void;
+    createBLEConnectionAsync(options?: BluetoothOptions): Promise<any>;
+
+    /** 观测指标 */
+    metrics: {
+      getPerformanceReport(): Record<string, any>;
+      clearPerformanceMetrics(): void;
+    };
+  }
+  }
+}
+
+/**
+ * 全局 qsh/uni 对象（默认导出为模块默认值）
+ */
+declare const qsh: UniWebView.Uni;
+declare const uni: UniWebView.Uni;
+
+/**
+ * 模块导出
+ */
+export default qsh;
+
+/**
+ * 全局声明
+ */
+declare global {
+  interface Window {
+    qsh: UniWebView.Uni;
+    UniAppJSBridge?: boolean;
+  }
+}
+
 export as namespace qsh;