qsh-webview-sdk 2.3.0 → 2.3.2

package/dist/index.d.ts

@@ -27,6 +27,27 @@ declare namespace UniWebView {
     data?: any;
   }
 
+  interface MiniProgramNavigateResult {
+    /** errMsg */
+    errMsg?: string;
+    [key: string]: any;
+  }
+
+  interface MiniProgramNavigateOptions {
+    /** target mini program id */
+    appid: string;
+    /** target mini program page path */
+    path?: string;
+    /** target mini program env */
+    env?: "release" | "trial" | "develop";
+    /** success callback */
+    success?: (res: MiniProgramNavigateResult) => void;
+    /** fail callback */
+    fail?: (error: any) => void;
+    /** complete callback */
+    complete?: () => void;
+  }
+
   /**
    * 环境信息
    */
@@ -207,19 +228,68 @@ declare namespace UniWebView {
     type: "weixin" | "plus" | "nvue" | "uvue" | "UniApp" | "webview" | "h5" | "offline";
   }
 
+  /** 高阶 toShare：内容类型（与 type 二选一） */
+  type ShareUniversalKind = "web" | "text" | "image" | "miniProgram";
+
+  /** 高阶 toShare：去向 */
+  type ShareUniversalScene = "chat" | "timeline";
+
+  /** 各 kind 对应的 payload（按需传字段） */
+  interface ShareUniversalPayloadWeb {
+    title: string;
+    summary: string;
+    imageUrl: string;
+    /** 图文链接，与 href 二选一 */
+    path?: string;
+    href?: string;
+  }
+
+  interface ShareUniversalPayloadText {
+    /** 与 text 二选一 */
+    summary?: string;
+    text?: string;
+  }
+
+  interface ShareUniversalPayloadImage {
+    imageUrl: string;
+  }
+
+  interface ShareUniversalPayloadMiniProgram {
+    title: string;
+    summary: string;
+    imageUrl: string;
+    miniProgram: {
+      /** 小程序原始 ID（gh_ 开头），uni.share type=5 要求 */
+      id: string;
+      path: string;
+      webUrl: string;
+      type?: 0 | 1 | 2;
+    };
+  }
+
+  type ShareUniversalPayload =
+    | ShareUniversalPayloadWeb
+    | ShareUniversalPayloadText
+    | ShareUniversalPayloadImage
+    | ShareUniversalPayloadMiniProgram;
+
   /**
-   * 微信分享选项
+   * 微信分享选项（toShare 仅支持高阶入参）
    */
   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>;
+    kind: ShareUniversalKind;
+    /** 各 kind 对应字段见 ShareUniversalPayload */
+    payload?: ShareUniversalPayload;
+    /** 为 true 时不打印 hint 日志 */
+    silent?: boolean;
+    /**
+     * 为 true 且当前为微信 JS-SDK 环境时，走宿主 WebView 桥 toShareData（兼容原 toShareCallBack）
+     */
+    viaWebViewBridge?: boolean;
+    /** @deprecated 等同于 viaWebViewBridge */
+    isCallBack?: boolean;
+    /** 分享去向：0 / chat 聊天，1 / timeline 朋友圈 */
+    scene?: 0 | 1 | ShareUniversalScene;
     success?: (res: ShareResult) => void;
     fail?: (error: any) => void;
     complete?: () => void;
@@ -227,6 +297,14 @@ declare namespace UniWebView {
 
   interface ShareResult {
     errMsg?: string;
+    /** 使用 kind 高阶参数时，成功回调会附带 hint / environment / raw */
+    hint?: string;
+    environment?: {
+      type: Environment["type"];
+      isWeixinMiniProgram: boolean;
+    };
+    raw?: ShareResult;
+    error?: any;
     [key: string]: any;
   }
 
@@ -340,6 +418,7 @@ declare namespace UniWebView {
     switchTab(options: NavigateOptions): void;
     reLaunch(options: NavigateOptions): void;
     redirectTo(options: NavigateOptions): void;
+    navigateToMiniProgram(options: MiniProgramNavigateOptions): void;
     postMessage(options?: PostMessageOptions): void;
     getEnv(callback: (info: EnvironmentInfo) => void): void;
     chooseImage(options?: ChooseImageOptions): void;
@@ -358,6 +437,13 @@ declare namespace UniWebView {
     /** WebView 对象（兼容旧版本） */
     webView: WebView | null;
 
+    navigateToMiniProgram(
+      options: MiniProgramNavigateOptions,
+    ): Promise<MiniProgramNavigateResult> | void;
+    navigateToMiniProgramAsync(
+      options: Omit<MiniProgramNavigateOptions, "success" | "fail" | "complete">,
+    ): Promise<MiniProgramNavigateResult>;
+
     weixin: WeixinNamespace;
 
     /** 图片选择（Promise版本） */
@@ -385,6 +471,13 @@ declare namespace UniWebView {
       options: Omit<ShareOptions, "success" | "fail" | "complete">,
     ): Promise<ShareResult>;
 
+    /** toShare 参数说明（结构化，可 JSON 展示） */
+    readonly TO_SHARE_PARAM_HELP: Readonly<Record<string, unknown>>;
+    /** 返回 toShare 参数说明对象 */
+    getToShareParamHelp(): Readonly<Record<string, unknown>>;
+    /** 在控制台打印 toShare 参数说明，并返回文本 */
+    printToShareParamHelp(): string;
+
     /** 蓝牙 API */
     openBluetoothAdapter(options?: BluetoothOptions): Promise<any> | void;
     openBluetoothAdapterAsync(options?: BluetoothOptions): Promise<any>;