@fgz/wxmini-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,887 @@
+import { ClassConstructor } from 'class-transformer';
+
+declare class CsonBean {
+    static OBJECT_TYPE_FIELD_NAME: string;
+    getJavaType(): string;
+    getSimpleTypeName(removeDtoSuffix?: boolean): string;
+    _OBJECT_TYPE_: string;
+    getObjectType(): string;
+    setObjectType(type: string): CsonBean;
+    _extJsonMap: {
+        [key: string]: any;
+    } | undefined;
+    getExtJsonMap(): {
+        [key: string]: any;
+    } | undefined;
+    setExtJsonMap(extMap: {
+        [key: string]: any;
+    } | undefined): void;
+    constructor();
+}
+declare class CsonPojo extends CsonBean {
+}
+declare class FeException extends CsonPojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    constructor(err?: string, detail?: string);
+    err: string | undefined;
+    detail: string | undefined;
+    toString(): string;
+}
+declare class FeJavaException extends FeException {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    constructor(err?: string, detail?: string);
+}
+declare class CRpcFeCmd extends CsonPojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    reqId: number | undefined;
+    service: string | undefined;
+    func: string | undefined;
+    params: any[] | undefined;
+}
+declare class CRpcFeRsp extends CsonPojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    resultJson: string | undefined;
+    error: any | undefined;
+}
+
+declare class SystemCallback extends CsonPojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    timeout: number | undefined;
+    static readonly FIELD_timeout: string;
+    static debugChannel: Boolean;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class FePojo extends CsonPojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    userObject: Object | undefined;
+    static readonly FIELD_userObject: string;
+    userPojo: CsonPojo | undefined;
+    static readonly FIELD_userPojo: string;
+    binaryData: Uint8Array | undefined;
+    static readonly FIELD_binaryData: string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class NullPojo extends FePojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class ValuePojo extends FePojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    value: Object | undefined;
+    static readonly FIELD_value: string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class BinBlock extends CsonPojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    id: number | undefined;
+    static readonly FIELD_id: string;
+    start: number | undefined;
+    static readonly FIELD_start: string;
+    end: number | undefined;
+    static readonly FIELD_end: string;
+    extByteArray: Uint8Array | undefined;
+    static readonly FIELD_extByteArray: string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class PartitionTable extends CsonPojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    callbackBridgeChannel: number | undefined;
+    static readonly FIELD_callbackBridgeChannel: string;
+    bodyLength: number | undefined;
+    static readonly FIELD_bodyLength: string;
+    lstBin: Array<BinBlock> | undefined;
+    static readonly FIELD_lstBin: string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class FeAbilityExecuteException extends FeException {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    ability: CsonPojo | undefined;
+    static readonly FIELD_ability: string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class FeWxMiniCmdException extends FeAbilityExecuteException {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    wxMiniServerUrl: string | undefined;
+    static readonly FIELD_wxMiniServerUrl: string;
+    wxMiniAppUuid: string | undefined;
+    static readonly FIELD_wxMiniAppUuid: string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class WxMiniBridgeCommand extends CsonPojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    debugAppUuid: string | undefined;
+    static readonly FIELD_debugAppUuid: string;
+    appId: string | undefined;
+    static readonly FIELD_appId: string;
+    cmd: string | undefined;
+    static readonly FIELD_cmd: string;
+    params: Map<string, string | null> | undefined;
+    static readonly FIELD_params: string;
+    extHeaders: Map<string, string | null> | undefined;
+    static readonly FIELD_extHeaders: string;
+    waitOnlineTimeoutS: number | undefined;
+    static readonly FIELD_waitOnlineTimeoutS: string;
+    timeoutS: number | undefined;
+    static readonly FIELD_timeoutS: string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class WxMiniCommand extends SystemCallback {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    debugHttpUrl: string | undefined;
+    static readonly FIELD_debugHttpUrl: string;
+    debugAppUuid: string | undefined;
+    static readonly FIELD_debugAppUuid: string;
+    cmd: string | undefined;
+    static readonly FIELD_cmd: string;
+    params: Map<string, string | null> | undefined;
+    static readonly FIELD_params: string;
+    extHeaders: Map<string, string | null> | undefined;
+    static readonly FIELD_extHeaders: string;
+    waitOnlineTimeoutS: number | undefined;
+    static readonly FIELD_waitOnlineTimeoutS: string;
+    static readonly PARAM_URL: string;
+    static readonly PARAM_TITLE: string;
+    static readonly PARAM_ICON_TYPE: string;
+    static readonly PARAM_MESSAGE: string;
+    static readonly PARAM_BUTTON: string;
+    static readonly PARAM_REJECT_BUTTON: string;
+    static readonly PARAM_FILE_PATH: string;
+    static readonly DATA_FIELD_IN_MAP: string;
+    static readonly getUserProfile_TITLE: string;
+    static readonly getUserProfile_ICON_TYPE: string;
+    static readonly getUserProfile_MESSAGE: string;
+    static readonly getUserProfile_BUTTON: string;
+    static readonly getUserProfile_QUERY_TYPE: string;
+    static readonly getUserProfile_ORG_AVATAR_URL64: string;
+    static readonly getUserProfile_ORG_NICK: string;
+    static readonly getPhoneNum_TITLE: string;
+    static readonly getPhoneNum_ICON_TYPE: string;
+    static readonly getPhoneNum_MESSAGE: string;
+    static readonly getPhoneNum_BUTTON: string;
+    static readonly getPhoneNum_REJECT_BUTTON: string;
+    static readonly makePhoneCall_phoneNum: string;
+    static readonly PARAM_count: string;
+    static readonly PARAM_mediaType: string;
+    static readonly PARAM_sourceType: string;
+    static readonly PARAM_maxDuration: string;
+    static readonly PARAM_sizeType: string;
+    static readonly PARAM_camera: string;
+    static readonly MEDIATYPE_image: string;
+    static readonly MEDIATYPE_video: string;
+    static readonly MEDIATYPE_mix: string;
+    static readonly SOURCETYPE_album: string;
+    static readonly SOURCETYPE_camera: string;
+    static readonly SIZETYPE_original: string;
+    static readonly SIZETYPE_compressed: string;
+    static readonly CAMERA_back: string;
+    static readonly CAMERA_front: string;
+    static readonly PARAM_delta: string;
+    static readonly PARAM_UPLOAD_FILE_NAME: string;
+    static readonly PARAM_UPLOAD_FORM_DATA: string;
+    static readonly PARAM_SHARE_FILE_NAME: string;
+    static readonly PARAM_MAP_JSON: string;
+    static readonly PARAM_APPEND: string;
+    static readonly PARAM_OPENIT: string;
+    static readonly PARAM_LOCATION: string;
+    static readonly PARAM_COUNT: string;
+    static readonly PARAM_TYPE: string;
+    static readonly PARAM_EXTENSION: string;
+    static readonly PARAM_sharePage: string;
+    static readonly PARAM_path: string;
+    static readonly PARAM_style: string;
+    static readonly PARAM_needShowEntrance: string;
+    static readonly PARAM_entrancePath: string;
+    static readonly CLIP_BOARD_DATA: string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class WxMiniConfigDto extends CsonPojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    wxMiniServerUrl: string | undefined;
+    static readonly FIELD_wxMiniServerUrl: string;
+    wxMiniAppUuid: string | undefined;
+    static readonly FIELD_wxMiniAppUuid: string;
+    sceneFromWxMiniParams: string | undefined;
+    static readonly FIELD_sceneFromWxMiniParams: string;
+    initalQueryParameters: Map<string, any> | undefined;
+    static readonly FIELD_initalQueryParameters: string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class QueryWxMiniParam extends SystemCallback {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class QuerySceneFromWxMiniParams extends SystemCallback {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class CRpcCallbackCmd extends CsonPojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    reqId: number | undefined;
+    static readonly FIELD_reqId: string;
+    data: CsonPojo | undefined;
+    static readonly FIELD_data: string;
+    static readonly DECLARED_FIELDS: string[];
+}
+declare class CRpcCallbackRsp extends CsonPojo {
+    static JAVA_TYPE: string;
+    getJavaType(): string;
+    reqId: number | undefined;
+    static readonly FIELD_reqId: string;
+    result: CsonPojo | undefined;
+    static readonly FIELD_result: string;
+    static readonly DECLARED_FIELDS: string[];
+}
+
+declare enum PingStatus {
+    success = 0,
+    failed = 1,
+    timeout = 2,
+    none = 3
+}
+declare class PingResult {
+    constructor(status?: PingStatus, error?: any);
+    status: PingStatus;
+    error?: any;
+}
+type RpcResponseFuncType = (data: Uint8Array, isCompressed: boolean) => void;
+declare class WebSocketError extends Error {
+    constructor(msg: string);
+}
+declare class WebSocketConnectError extends Error {
+    name: string;
+    cause?: unknown;
+    constructor(msg: string, options?: {
+        cause?: unknown;
+    });
+}
+interface ConnectOptions {
+    loopRetry: boolean;
+}
+/**
+ * 服务端回调处理器接口
+ *
+ * 用于处理来自服务端的回调请求。使用方需要实现此接口来处理
+ * SystemCallback 和 PanelCallback 等回调。
+ */
+interface ServerCallbackHandler {
+    handleCallback(data: CsonPojo): Promise<any>;
+}
+declare const clients: Set<WsClient>;
+declare class WsClient {
+    private socket;
+    private url;
+    private _callbackHandler;
+    getSocket(): WebSocket | null;
+    getUrl(): string;
+    /**
+     * 设置服务端回调处理器
+     */
+    setCallbackHandler(handler: ServerCallbackHandler): void;
+    static _maskZipFlag: number;
+    static _typeBinRpcRSP: number;
+    static _typeBinRpcCallbackReq: number;
+    static _typeBinRpcCallbackRsp: number;
+    static _reqLength: number;
+    static _rspLength: number;
+    static _rspZipFlagOffset: number;
+    static _rspReqIdOffset: number;
+    static _rspTypeFlagOffset: number;
+    static _int32Length: number;
+    static _wsFlagSingle: number;
+    static _wsFlagStart: number;
+    static _wsFlagContinue: number;
+    static _wsFlagEnd: number;
+    static _wsMaxFrame: number;
+    static _wsBinHeader: Uint8Array;
+    static _wsBinHeaderZip: Uint8Array;
+    static _wsBinHeaderCallbackRSP: Uint8Array;
+    constructor(url: string);
+    connect(options?: ConnectOptions): void;
+    blockConnect(options?: ConnectOptions): Promise<void>;
+    pingInterval: number;
+    intervalId: ReturnType<typeof setInterval> | undefined;
+    tryStartLoop(): void;
+    close(): void;
+    loopRetryConnect(): void;
+    onSocketConnected(event: Event): void;
+    onSocketClose(event: CloseEvent): void;
+    isSocketValid(): boolean;
+    onSocketMessage(event: MessageEvent): void;
+    static SIM_SERVER_CON_ERROR_HEADER: Uint8Array;
+    static checkConnectionError(bytes: Uint8Array | null): void;
+    wrapSocketErrorBytes(error: any): Uint8Array;
+    onSocketError(error: Event): void;
+    _reqId: number;
+    _mapRpc: Map<number, RpcResponseFuncType>;
+    _rpcCodec: RpcCodec;
+    ping(timeout?: number): Promise<PingResult>;
+    rpc(cmd: any, onAct: RpcResponseFuncType): number;
+    rpcAsync<T>(cmd: any, returnType: any): Promise<T>;
+    handleReceivedData(buffer: ArrayBuffer): Promise<void>;
+    callbackFromServer(reqId: number, cmdByte: Uint8Array): Promise<null | undefined>;
+    sendMessage(message: string): void;
+    static getWebSocketStateName(state: number | undefined): string;
+    sendBinary(data: ArrayBuffer | Blob): Promise<void>;
+    sendRpcBytes(header: Uint8Array, bytes: Uint8Array): Promise<void>;
+    static buildRpcHeader(reqID: number, zip: boolean): Uint8Array;
+    static buildCallbackRspHeader(reqID: number): Uint8Array;
+    buildCallbackRspHeader(reqID: number): Uint8Array;
+    sendCallbackRsp(rsp: CRpcCallbackRsp): void;
+}
+declare class RpcCodec {
+    zipOut: boolean;
+    toBytes(cmd: CsonBean): Uint8Array;
+}
+
+declare class WxMiniBridge {
+    serverUrl: string | undefined;
+    appUuid: string | undefined;
+    bridgeWebSocketUrl: string | undefined;
+    sceneFromWxMiniParams: string | undefined;
+    initalQueryParameters: Map<string, any> | undefined;
+    private _bridgeClient;
+    private _processOneResult;
+    isBatchExecuting(command: WxMiniCommand): boolean;
+    prepareBridgeClient(): Promise<WsClient>;
+    handleBridgeCallback(command: WxMiniCommand): Promise<Object>;
+    handleBridgeCommand(command: WxMiniBridgeCommand): Promise<Object>;
+    queryConfig(): WxMiniConfigDto;
+    querySceneFromWxMiniParams(): string | undefined;
+    /**
+     * 关闭桥接连接
+     */
+    close(): void;
+    private _getWxMiniComdException;
+}
+
+/**
+ * WxMini API - 微信小程序高层调用接口
+ *
+ * 对 WxMiniBridge.handleBridgeCallback 的封装，将每个小程序功能封装为可直接 await 的前端方法。
+ * 对应 Java 端：fe.cmn.weixin.ability.WxMiniCommand
+ *
+ * 所有 API 参数均采用对象形式传参，所有参数对象通过继承 BaseOptions 而统一支持 timeout 设置。
+ */
+/** 小程序端支持的命令字，对应 Java 枚举 WxMiniCmd */
+declare enum WxMiniCmd {
+    getUserProfile = "getUserProfile",
+    makePhoneCall = "makePhoneCall",
+    /** 调起相机并选取照片/视频 */
+    chooseMedia = "chooseMedia",
+    readLocalFile = "readLocalFile",
+    getPhoneNum = "getPhoneNum",
+    scanCode = "scanCode",
+    /** 参数：url; 跳转到某内部页面 */
+    navigateTo = "navigateTo",
+    /** 参数：url; 关闭当前页面跳转到某内部页面 */
+    redirectTo = "redirectTo",
+    /** 参数：url; 关闭所有页面，打开到应用内的某个页面 */
+    reLaunch = "reLaunch",
+    /** 参数：delta; 关闭当前页面，返回上一页面或多级页面 */
+    navigateBack = "navigateBack",
+    /** 登录并返回登录码 code */
+    loginGetCode = "loginGetCode",
+    saveProjectConfigParam = "saveProjectConfigParam",
+    loadProjectConfigParam = "loadProjectConfigParam",
+    /** 下载文件，返回临时文件路径 */
+    downloadFile = "downloadFile",
+    /** 上传文件到服务器 */
+    uploadFile = "uploadFile",
+    saveFileToDisk = "saveFileToDisk",
+    shareFileMessage = "shareFileMessage",
+    openDocument = "openDocument",
+    getLocation = "getLocation",
+    openLocation = "openLocation",
+    chooseLocation = "chooseLocation",
+    queryAppGlobalData = "queryAppGlobalData",
+    chooseMessageFile = "chooseMessageFile",
+    setSharePageMessage = "setSharePageMessage",
+    showShareImageMenu = "showShareImageMenu",
+    saveImageToPhotosAlbum = "saveImageToPhotosAlbum",
+    saveVideoToPhotosAlbum = "saveVideoToPhotosAlbum",
+    getClipboardData = "getClipboardData",
+    setClipboardData = "setClipboardData",
+    startAudioRecord = "startAudioRecord",
+    stopAudioRecord = "stopAudioRecord",
+    pauseAudioRecord = "pauseAudioRecord",
+    resumeAudioRecord = "resumeAudioRecord"
+}
+/** 所有 API 参数对象的基类，统一支持 timeout 设置 */
+interface BaseOptions {
+    /** 超时时间（毫秒），默认 60000ms */
+    timeout?: number;
+}
+/** WxMiniApi 初始化配置 */
+interface WxMiniApiConfig {
+    /** 应用 UUID */
+    appUuid?: string;
+    /** 桥接 WebSocket 地址 */
+    bridgeWebSocketUrl?: string;
+}
+type UserProfileQueryType = 'NickName' | 'Avartar' | 'All';
+interface GpsLocationDto {
+    latitude?: number;
+    longitude?: number;
+    altitude?: number;
+    horizontalAccuracy?: number;
+    verticalAccuracy?: number;
+    speed?: number;
+    address?: string;
+}
+interface WxLocalFile {
+    /** 本地临时文件路径 */
+    tempFilePath?: string;
+    /** 文件大小 */
+    size?: number;
+    /** 文件类型 */
+    fileType?: string;
+    /** 视频时长（秒），视频时有效 */
+    duration?: number;
+    /** 视频缩略图 */
+    thumbTempFilePath?: string;
+    /** 宽度，媒体文件有效 */
+    width?: number;
+    /** 高度，媒体文件有效 */
+    height?: number;
+}
+interface WxSharePageInfo {
+    title?: string;
+    path?: string;
+    imageUrl?: string;
+    desc?: string;
+}
+interface WxMiniAppInfo {
+    appId?: string;
+    appSecret?: string;
+}
+interface GetUserProfileOptions extends BaseOptions {
+    /** 显示在确认授权对话框里的文字信息 */
+    message: string;
+    /** 显示在确认对话框里的按钮标签 */
+    buttonLabel: string;
+    /** 获取信息的类型 */
+    type?: UserProfileQueryType;
+}
+interface GetPhoneNumOptions extends BaseOptions {
+    /** 显示在确认授权对话框里的文字信息 */
+    message: string;
+    /** 确认按钮标签 */
+    buttonLabel: string;
+    /** 拒绝按钮标签 */
+    rejectButtonLabel?: string;
+}
+interface MakePhoneCallOptions extends BaseOptions {
+    /** 电话号码 */
+    phoneNum: string;
+}
+interface ChooseMediaOptions extends BaseOptions {
+    /** 最多选取数量，默认 2 */
+    count?: number;
+    /** 媒体类型，如 ['image', 'video', 'mix']，默认 ['mix'] */
+    mediaTypes?: string[];
+    /** 来源类型，如 ['album', 'camera']，默认 ['album', 'camera'] */
+    sourceTypes?: string[];
+    /** 最大时长（秒），默认 30 */
+    maxDuration?: number;
+    /** 尺寸类型，如 ['original', 'compressed']，默认 ['compressed', 'original'] */
+    sizeTypes?: string[];
+    /** 摄像头方向 'back' | 'front'，默认 'back' */
+    camera?: string;
+}
+interface ReadLocalFileOptions extends BaseOptions {
+    /** 文件路径 */
+    filePath: string;
+}
+interface DownloadFileOptions extends BaseOptions {
+    /** 文件 URL */
+    url: string;
+}
+interface UploadFileOptions extends BaseOptions {
+    /** 上传目标服务器地址 */
+    url: string;
+    /** 本地临时文件路径 */
+    filePath: string;
+    /** 上传的目标文件名 */
+    fileName: string;
+    /** 其它表单参数（如用户/授权等） */
+    formData?: Record<string, string>;
+}
+interface OpenDocumentOptions extends BaseOptions {
+    /** 临时文件路径 */
+    filePath: string;
+}
+interface SaveToAlbumOptions extends BaseOptions {
+    /** 文件路径 */
+    filePath: string;
+}
+interface ShareFileMessageOptions extends BaseOptions {
+    /** 要分享的临时文件路径 */
+    filePath: string;
+    /** 显示在聊天界面的文件名（注意扩展名要正确） */
+    fileName: string;
+}
+interface ChooseMessageFileOptions extends BaseOptions {
+    /** 最多可以选择的文件个数（0~100） */
+    count: number;
+    /** 文件类型：'all' | 'video' | 'image' | 'file'，默认 'all' */
+    type?: string;
+    /** 文件扩展名过滤（仅 type=file 时有效） */
+    extensions?: string[];
+}
+interface NavigateToOptions extends BaseOptions {
+    /** 页面路径（如 '/pages/index/index'） */
+    path: string;
+}
+interface RedirectToOptions extends BaseOptions {
+    /** 页面路径 */
+    path: string;
+}
+interface ReLaunchOptions extends BaseOptions {
+    /** 页面路径 */
+    path: string;
+}
+interface NavigateBackOptions extends BaseOptions {
+    /** 返回的页面数，默认 1 */
+    delta?: number;
+}
+interface GetLocationOptions extends BaseOptions {
+    /** 获取后是否打开地图，默认 false */
+    openIt?: boolean;
+}
+interface OpenLocationOptions extends BaseOptions {
+    /** 位置坐标 */
+    location: GpsLocationDto;
+}
+interface ChooseLocationOptions extends BaseOptions {
+    /** 初始定位（可选） */
+    initLocation?: GpsLocationDto;
+}
+interface SaveExtProjectConfigOptions extends BaseOptions {
+    /** 配置参数键值对 */
+    params: Record<string, string>;
+    /** true: 追加合并; false: 全量替换 */
+    append: boolean;
+}
+interface SetSharePageMessageOptions extends BaseOptions {
+    /** 分享页信息 */
+    sharePage: WxSharePageInfo;
+}
+interface ShowShareImageMenuOptions extends BaseOptions {
+    /** 图片路径 */
+    path: string;
+    /** 样式 */
+    style: string;
+    /** 是否需要显示入口 */
+    needShowEntrance: string;
+    /** 入口路径 */
+    entrancePath: string;
+}
+interface SetClipboardDataOptions extends BaseOptions {
+    /** 剪贴板内容 */
+    data: string;
+}
+interface StartAudioRecordOptions extends BaseOptions {
+    /** 录音时长（毫秒） */
+    duration?: number;
+    /** 采样率 */
+    sampleRate?: number;
+    /** 通道数 */
+    numberOfChannels?: number;
+    /** 编码码率 */
+    encodeBitRate?: number;
+    /** 音频格式 */
+    format?: string;
+    /** 帧大小 */
+    frameSize?: number;
+}
+/**
+ * 微信小程序高层 API 封装。
+ *
+ * 所有方法都是对 `WxMiniBridge.handleBridgeCallback` 的语义化包装，
+ * 不再需要手动构建 WxMiniCommand 对象。
+ * 所有方法参数都采用对象形式，并统一继承自 BaseOptions 以支持自定义 timeout。
+ *
+ * @example
+ * ```ts
+ * import { WxMiniApi } from 'wxmini-sdk'
+ *
+ * // 方式一：构造函数传配置
+ * const api = new WxMiniApi({
+ *   appUuid: 'xxx',
+ *   bridgeWebSocketUrl: 'wss://...',
+ * })
+ *
+ * // 方式二：后续动态设置
+ * const api2 = new WxMiniApi()
+ * api2.configure({ appUuid: 'xxx', bridgeWebSocketUrl: 'wss://...' })
+ *
+ * // 获取手机号
+ * const phoneResult = await api.getPhoneNum({ message: '请授权手机号', buttonLabel: '允许' })
+ *
+ * // 扫二维码（自定义超时 30 秒）
+ * const scanResult = await api.scanCode({ timeout: 30000 })
+ * ```
+ */
+declare class WxMiniApi {
+    /** @internal 底层桥接实例 */
+    private readonly _bridge;
+    constructor(config?: WxMiniApiConfig);
+    /**
+     * 设置或更新配置
+     * @param config - appUuid 和 bridgeWebSocketUrl
+     */
+    configure(config: WxMiniApiConfig): void;
+    /**
+     * 关闭桥接连接，释放资源
+     */
+    close(): void;
+    /** 执行一个命令并返回结果 */
+    private execute;
+    /** 执行并将结果 JSON 解析为对象 */
+    private executeAs;
+    /**
+     * 通过微信小程序接口, 获取用户信息（昵称/头像等）
+     */
+    getUserProfile(opts: GetUserProfileOptions): Promise<string>;
+    /**
+     * 通过微信小程序接口，获取用户手机号码
+     */
+    getPhoneNum(opts: GetPhoneNumOptions): Promise<string>;
+    /**
+     * 拨打电话
+     */
+    makePhoneCall(opts: MakePhoneCallOptions): Promise<void>;
+    /**
+     * 调起相机并选取照片/视频
+     */
+    chooseMedia(opts?: ChooseMediaOptions): Promise<WxLocalFile[]>;
+    /**
+     * 扫描二维码，返回二维码内容
+     */
+    scanCode(opts?: BaseOptions): Promise<string>;
+    /**
+     * 读取本地文件内容
+     * @warning 文件超过 60K 会导致链接中断，适合小文件
+     */
+    readLocalFile(opts: ReadLocalFileOptions): Promise<string>;
+    /**
+     * 下载文件，返回临时文件路径
+     */
+    downloadFile(opts: DownloadFileOptions): Promise<string>;
+    /**
+     * 上传文件到服务器
+     */
+    uploadFile(opts: UploadFileOptions): Promise<string>;
+    /**
+     * 打开预览文档（支持 txt/pdf/excel/word/ppt 等格式）
+     */
+    openDocument(opts: OpenDocumentOptions): Promise<void>;
+    /**
+     * 保存图片到相册
+     */
+    saveImageToPhotosAlbum(opts: SaveToAlbumOptions): Promise<void>;
+    /**
+     * 保存视频到相册
+     */
+    saveVideoToPhotosAlbum(opts: SaveToAlbumOptions): Promise<void>;
+    /**
+     * 分享文件消息（将临时文件分享给他人）
+     */
+    shareFileMessage(opts: ShareFileMessageOptions): Promise<void>;
+    /**
+     * 从聊天记录中选择文件
+     */
+    chooseMessageFile(opts: ChooseMessageFileOptions): Promise<WxLocalFile[]>;
+    /**
+     * 跳转到小程序内部页面
+     */
+    navigateTo(opts: NavigateToOptions): Promise<void>;
+    /**
+     * 关闭当前页面后跳转
+     */
+    redirectTo(opts: RedirectToOptions): Promise<void>;
+    /**
+     * 关闭所有页面，打开应用内某页面（清空页面栈）
+     */
+    reLaunch(opts: ReLaunchOptions): Promise<void>;
+    /**
+     * 关闭当前页面，返回上一页面或多级页面
+     */
+    navigateBack(opts?: NavigateBackOptions): Promise<void>;
+    /**
+     * 调用微信登录，返回登录码 code
+     */
+    loginGetCode(opts?: BaseOptions): Promise<string>;
+    /**
+     * 获取当前位置（经纬度）
+     */
+    getLocation(opts?: GetLocationOptions): Promise<GpsLocationDto>;
+    /**
+     * 打开地图并定位到指定位置
+     */
+    openLocation(opts: OpenLocationOptions): Promise<void>;
+    /**
+     * 打开地图让用户选择位置，返回所选位置坐标
+     */
+    chooseLocation(opts?: ChooseLocationOptions): Promise<GpsLocationDto>;
+    /**
+     * 保存扩展的工程配置参数到小程序本地（页面启动时会自动合并传入）
+     */
+    saveExtProjectConfig(opts: SaveExtProjectConfigOptions): Promise<void>;
+    /**
+     * 读取保存在小程序本地的扩展工程配置参数
+     */
+    loadExtProjectConfig(opts?: BaseOptions): Promise<Record<string, string>>;
+    /**
+     * 查询小程序 App 的 GlobalData
+     */
+    queryAppGlobalData<T = any>(opts?: BaseOptions): Promise<T>;
+    /**
+     * 设置分享页信息（用于分享转发，全局一份）
+     */
+    setSharePageMessage(opts: SetSharePageMessageOptions): Promise<void>;
+    /**
+     * 显示图片分享菜单
+     */
+    showShareImageMenu(opts: ShowShareImageMenuOptions): Promise<void>;
+    /**
+     * 读取剪贴板内容
+     */
+    getClipboardData(opts?: BaseOptions): Promise<string>;
+    /**
+     * 写入剪贴板
+     */
+    setClipboardData(opts: SetClipboardDataOptions): Promise<void>;
+    /**
+     * 开始录音
+     */
+    startAudioRecord(opts?: StartAudioRecordOptions): Promise<void>;
+    /**
+     * 停止录音，返回录音文件临时路径
+     */
+    stopAudioRecord(opts?: BaseOptions): Promise<string>;
+    /**
+     * 暂停录音
+     */
+    pauseAudioRecord(opts?: BaseOptions): Promise<void>;
+    /**
+     * 继续录音
+     */
+    resumeAudioRecord(opts?: BaseOptions): Promise<void>;
+}
+
+declare class WsService {
+    wsClient: WsClient;
+    service: string;
+    constructor(wsClient: WsClient, service: string);
+    getClient(): WsClient;
+    getServiceName(): string;
+}
+
+declare class IWxMiniBridgeService extends WsService {
+    static readonly SERVICE: string;
+    constructor(wsClient: WsClient);
+    static readonly DEFAULT_TIMEOUTS: number;
+    static readonly DEFAULT_WAIT_ONLINE_TIMEOUTS: number;
+    static readonly DECLARED_FIELDS: string[];
+    handleCommand(cmd: WxMiniBridgeCommand): Promise<Object>;
+}
+
+declare class Cson {
+    static _serialNo: number;
+    static _mapBytes: Map<number, Uint8Array>;
+    static _setCache(mapBytes: Map<number, Uint8Array> | null): void;
+    static putBytes(data: Uint8Array | null): Uint8Array | null;
+    static getBytes(o: Uint8Array): Uint8Array | null;
+    static _clearCache(): void;
+    static encode(data: any, outputBytes: Map<number, Uint8Array> | null): string;
+    static decode<T>(targetClass: ClassConstructor<T>, json: string, mapBytes: Map<number, Uint8Array> | null): T | null;
+    static decodeReturn(data: Uint8Array | null, zip: boolean): any;
+    static decodeJson(json: string, mapBytes: Map<number, Uint8Array> | null): any;
+    static decodeObject(org: any): any;
+    static decodeDynamicList(org: any[] | null): any[] | null;
+    /**
+     * 返回的是成功结果里的 result json
+     * 同时，参数 mapAttach 是附件二进制包（输出）
+     * 如果返回是异常对象, 则会抛出FeJavaException
+     */
+    static decodeReturnPayload(data: Uint8Array | null, zip: boolean, mapAttach: Map<number, Uint8Array>): string | null | undefined;
+    static decodeServerPackage(data: Uint8Array | null, zip: boolean, mapAttach: Map<number, Uint8Array>): string | null;
+    static getPojoValue(pojo: CsonPojo | null | undefined): any;
+}
+declare class JavaFactory {
+    static CSON_BEANS: Map<string, CsonBean>;
+    static registPojos(beans: Map<string, CsonBean>): void;
+    static registPojo(javaType: string, pojo: CsonBean): void;
+    static getPojoByName(javaType: string, create?: boolean): CsonBean | undefined | null;
+    static newBean(javaType: string, json: {
+        [key: string]: any;
+    } | null): CsonBean | null;
+}
+
+declare class Utils {
+    static allocUuid(): string;
+    static now(): number;
+    static cloneWithRef<T>(obj: T | null): T | any | null;
+    static createNew<T>(obj: T | null): T | any | null;
+    static isStringNotEmpty(str: string | null | undefined): boolean;
+    static isStringEmpty(str: string | null | undefined): boolean;
+    static string2Utf8(str: string | null): Uint8Array | null;
+    static utf8ToString(bytes: Uint8Array | null): string | null;
+    static concatUint8Arrays(arrays: Uint8Array[]): Uint8Array;
+    static sleep(ms: number): Promise<void>;
+    static pollAsync(fn: () => boolean, timeout?: number, interval?: number): Promise<void>;
+    static isNumber(value: any): value is number;
+    static isInteger(value: number): boolean;
+    static isFloat(value: number): boolean;
+    static pollBlock(fn: () => boolean, timeout: number, interval: number, msg?: string): Promise<void>;
+    static error(message?: any, ...optionalParams: any[]): void;
+    static log(message?: any, ...optionalParams: any[]): void;
+    static _debug: boolean;
+    static debug(message?: any, ...optionalParams: any[]): void;
+    static isInstance<T>(obj: any, constructor: new (...args: any[]) => T): boolean;
+    static assertNotNull<T>(obj: T | undefined | null, msg?: string): T;
+    static assertTrue(value: boolean, msg?: string): void;
+}
+declare class Bytes {
+    static LittleEndian: boolean;
+    /**
+     * Flutter的setInt32，以及Netty等默认都是大端序存储int：[00,00,00,03]
+     */
+    static readInt32(bytes: Uint8Array, offset: number): number;
+    static setInt32Bytes(bytes: Uint8Array, offset: number, num: number): void;
+    static int32ToBytes(v: number): Uint8Array;
+    static stringToBytes(s: string): Uint8Array;
+}
+
+/**
+ * 设备/环境检测工具
+ */
+/** 检测是否在微信小程序 WebView 环境中 */
+declare function isWxMiniprogram(): boolean;
+/** 检测触摸屏支持 */
+declare function isTouchDevice(): boolean;
+/** 获取平台类型 */
+declare function getPlatform(): string;
+/** 获取浏览器名称 */
+declare function getBrowserName(): string;
+
+export { type BaseOptions, BinBlock, Bytes, CRpcCallbackCmd, CRpcCallbackRsp, CRpcFeCmd, CRpcFeRsp, type ChooseLocationOptions, type ChooseMediaOptions, type ChooseMessageFileOptions, type ConnectOptions, Cson, CsonBean, CsonPojo, type DownloadFileOptions, FeAbilityExecuteException, FeException, FeJavaException, FePojo, FeWxMiniCmdException, type GetLocationOptions, type GetPhoneNumOptions, type GetUserProfileOptions, type GpsLocationDto, IWxMiniBridgeService, JavaFactory, type MakePhoneCallOptions, type NavigateBackOptions, type NavigateToOptions, NullPojo, type OpenDocumentOptions, type OpenLocationOptions, PartitionTable, PingResult, PingStatus, QuerySceneFromWxMiniParams, QueryWxMiniParam, type ReLaunchOptions, type ReadLocalFileOptions, type RedirectToOptions, RpcCodec, type SaveExtProjectConfigOptions, type SaveToAlbumOptions, type ServerCallbackHandler, type SetClipboardDataOptions, type SetSharePageMessageOptions, type ShareFileMessageOptions, type ShowShareImageMenuOptions, type StartAudioRecordOptions, SystemCallback, type UploadFileOptions, type UserProfileQueryType, Utils, ValuePojo, WebSocketConnectError, WebSocketError, WsClient, WsService, type WxLocalFile, WxMiniApi, type WxMiniApiConfig, type WxMiniAppInfo, WxMiniBridge, WxMiniBridgeCommand, WxMiniCmd, WxMiniCommand, WxMiniConfigDto, type WxSharePageInfo, clients, getBrowserName, getPlatform, isTouchDevice, isWxMiniprogram };