@docoi/mys-sdk 1.0.3 → 1.1.0

package/dist/bridge.d.ts

@@ -1,11 +1,50 @@
-import { default as JSBridgeSdk, CallOptions, DebugOptions, JSBridgeInterface } from '@docoi/jsbridge-sdk';
-import { Callbacks, NativeResponse } from './types';
+import { default as JSBridgeSdk } from '@docoi/jsbridge-sdk';
+import { Callbacks, ChannelDebugOptions, InvokeOptions, ListenOptions, NativeHandler, NativeResponse, RouteInfo, Transport } from './types';
 export { JSBridgeSdk };
-export type NativeHandler<TData = unknown, TResult = unknown> = (data: TData) => TResult | Promise<TResult>;
-declare const bridge: JSBridgeInterface;
-export declare const setDebug: (enabled: boolean, options?: Partial<DebugOptions>) => JSBridgeInterface;
-export default bridge;
-export declare function registerNativeHandler<TData = unknown, TResult = unknown>(name: string, handler: NativeHandler<TData, TResult>): JSBridgeInterface;
+declare const bridge: Transport;
+/** 同时作用于两个通道 */
+export declare const setDebug: (enabled: boolean, options?: ChannelDebugOptions) => void;
+/** 监听每次 invoke 的路由结果（走哪个通道、实际发送的方法与参数），仅供调试，只保留一个监听器 */
+export declare const onRoute: (listener?: (info: RouteInfo) => void) => void;
+/** 是否走旧通道：since 大于当前 App 版本（compareVersions 返回 -1）说明 App 还不支持新通道；不在 App 内保持走新通道 */
+export declare function shouldUseLegacy(since?: string): boolean;
+/**
+ * 监听 Native 事件，按 since 选择通道，返回取消该次监听的函数。
+ * once 由本文件实现（handler 触发时自行取消），不走 lib 的 once：旧通道没有该方法，统一实现行为才一致。
+ */
+export declare function listen<T = unknown>(event: string, callback: (payload: T) => void, options?: ListenOptions<T>): () => void;
+/** 取消 listen 登记的监听；不传 callback 时取消该事件下全部监听 */
+export declare function unlisten(event: string, callback?: object): void;
+/**
+ * 注册供 Native 调用的方法，按 since 选择通道，返回注销该次注册的函数。
+ * 新通道返回值会包装成 NativeResponse，旧通道直接返回原始值。
+ */
+export declare function registerHandler<TData = unknown, TResult = unknown>(name: string, handler: NativeHandler<TData, TResult>, since?: string): () => void;
+/** 取消 registerHandler 注册的方法，通道选择规则与注册时一致 */
+export declare function unregisterHandler(name: string, since?: string): void;
+/**
+ * 注册供 Native 调用的方法，固定走新通道，返回注销该次注册的函数。
+ *
+ * @note 需要按 App 版本选择通道时用 registerHandler。
+ */
+export declare function registerNativeHandler<TData = unknown, TResult = unknown>(name: string, handler: NativeHandler<TData, TResult>): () => void;
+/** SDK 层参数校验失败，不调用 Native。errMsg 为 `<fn>:fail parameter error: <msg>`，按 1002 走 fail → complete → reject */
 export declare function rejectParamError<T = void>(fnName: string, msg: string, options?: Callbacks<T>): Promise<never>;
-export declare function isNativeResponse(value: unknown): value is NativeResponse;
-export declare function invoke<T = void>(fnName: string, data?: object, options?: Callbacks<T>, callOptions?: CallOptions): Promise<NativeResponse<T>>;
+/** 当前环境不支持该能力（如 App 版本过低且没有旧版对应页面）：不调用 Native。errMsg 为 `<fn>:fail unsupported: <reason>`，按 5002 走 fail → complete → reject */
+export declare function rejectUnsupported<T = void>(fnName: string, reason: string, options?: Callbacks<T>): Promise<never>;
+/**
+ * 执行不经过 Native 的本地动作（location.href、postMessage 等），回调调度与 invoke 一致。
+ * 动作发出即视为成功，动作的返回值作为 NativeResponse.result（无返回值的动作为 {}）；动作抛错按失败处理。
+ */
+export declare function invokeLocal<T = void>(fnName: string, detail: Record<string, unknown>, action: () => T, options?: Callbacks<T>): Promise<NativeResponse<T>>;
+export declare function invoke<T = void>(fnName: string, data?: object, options?: Callbacks<T>, invokeOptions?: InvokeOptions): Promise<NativeResponse<T>>;
+/**
+ * 同 invoke，供 Demo Inspector 验证错误归一：可以指定任意方法名和通道。
+ *
+ * 非 App 环境两个通道都得到 BRIDGE_ERROR（5001，管道不存在）；App 内调一个不存在的方法名，
+ * 新通道取 Native 回的 1001，旧通道由 toLegacyFailure 按 LegacyChannelError.kind 归成 1001。
+ *
+ * 不在对外 API 清单里，不承诺兼容，随时可能移除。
+ */
+export declare const invokeDebug: typeof invoke;
+export default bridge;

package/dist/constants/code.d.ts

@@ -5,9 +5,9 @@
  */
 /** 业务成功。 */
 export declare const SUCCESS = 0;
-/** 系统异常。由异常工厂方法使用，业务方不应主动赋值。 */
+/** 系统异常。由 SDK 内部使用，业务方不应主动赋值。 */
 export declare const SYSTEM_EXCEPTION = -1;
-/** 通用业务错误：方法不存在（兜底返回）。 */
+/** 通用业务错误：方法不存在。两个通道的「方法不支持」都归一到这个码。 */
 export declare const METHOD_NOT_FOUND = 1001;
 /** 参数错误段起点：参数解析失败、入参校验失败、参数缺失、格式错误等。 */
 export declare const PARAMS_ERROR = 1002;
@@ -17,5 +17,13 @@ export declare const NOT_LOGGED_IN = 2002;
 export declare const PERMISSION_DENIED = 3002;
 /** 网络错误段起点：网络异常、服务端 5xx、超时等。 */
 export declare const NETWORK_ERROR = 4002;
+/** 环境错误段起点：通信链路问题。 */
+export declare const BRIDGE_ERROR = 5001;
+/** 环境不支持：当前 App 版本没有该能力，SDK 直接返回，不调用 Native。运行环境没有原生通道属于 BRIDGE_ERROR。 */
+export declare const ENV_UNSUPPORTED = 5002;
 /** 业务自定义错误段起点：业务方自定义错误兜底。 */
 export declare const CUSTOM = 9002;
+/** 录音：已有录音在进行，重复调用 startRecordAudio 被拒绝，H5 需要先 cancelRecordAudio 再重试。 */
+export declare const RECORD_BUSY = 9101;
+/** 录音：其他录音失败，如麦克风被占用、启动期间被取消、录音器初始化失败、录音中编码或写文件失败，具体原因见 errMsg。 */
+export declare const RECORD_FAILED = 9102;

package/dist/index.d.ts

@@ -1,47 +1,26 @@
-import { default as bridge, registerNativeHandler, setDebug, JSBridgeSdk } from './bridge';
-import { DebugOptions, JSBridgeInterface } from '@docoi/jsbridge-sdk';
-import { Callbacks, LoginResult, NativeResponse, GetTokenResult, GetCircleInfoResult, ShareWebCardParams, ShareImageParams, ShareImageResult, BindGameRoleParams, ShowAdParams, ShowToastParams, TriggerVibrateParams, KeyboardHeightChangeCallback, EventListenOptions, CommentPanelChangeCallback, PlayMediaParams, ChooseMediaParams, ChooseMediaResult, UploadFilesParams, UploadFilesResult, SaveImageToPhotosAlbumParams, SaveVideoToPhotosAlbumParams, StartRecordParams, SystemInfoResult, NetworkTypeResult, SetClipboardDataParams, GetClipboardDataResult, CheckPermissionParams, CheckPermissionResult, OpenPhoneSettingParams, OpenInExternalBrowserParams } from './types';
-declare const mys: {
-    setDebug: (enabled: boolean, options?: Partial< DebugOptions>) => JSBridgeInterface;
-    registerNativeHandler: typeof registerNativeHandler;
-    login(params?: Callbacks<LoginResult>): Promise< NativeResponse<LoginResult>>;
-    getToken(params?: Callbacks<GetTokenResult>): Promise< NativeResponse<GetTokenResult>>;
-    getCurrentCircleInfo(params?: Callbacks<GetCircleInfoResult>): Promise< NativeResponse<GetCircleInfoResult>>;
-    shareWebCard(params: ShareWebCardParams): Promise< NativeResponse<void>>;
-    shareImage(params: ShareImageParams): Promise< NativeResponse<ShareImageResult>>;
-    openAddCustomEmoji(params?: Callbacks): Promise< NativeResponse<void>>;
-    toBindGameRole(params: BindGameRoleParams): Promise< NativeResponse<void>>;
-    showAd(params: ShowAdParams): Promise< NativeResponse<void>>;
-    showToast(params: ShowToastParams): Promise< NativeResponse<void>>;
-    triggerVibrate(params?: TriggerVibrateParams): Promise< NativeResponse<void>>;
-    stopVibrate(params?: Callbacks): Promise< NativeResponse<void>>;
-    hideKeyboard(params?: Callbacks): Promise< NativeResponse<void>>;
-    onKeyboardHeightChange(callback: KeyboardHeightChangeCallback, options?: EventListenOptions): void;
-    offKeyboardHeightChange(callback?: KeyboardHeightChangeCallback): void;
-    onCommentPanelChange(callback: CommentPanelChangeCallback, options?: EventListenOptions): void;
-    offCommentPanelChange(callback?: CommentPanelChangeCallback): void;
-    previewImage(params: PlayMediaParams): Promise< NativeResponse<void>>;
-    previewVideo(params: PlayMediaParams): Promise< NativeResponse<void>>;
-    chooseMedia(params?: ChooseMediaParams): Promise< NativeResponse<ChooseMediaResult>>;
-    uploadFiles(params: UploadFilesParams): Promise< NativeResponse<UploadFilesResult>>;
-    saveImageToPhotosAlbum(params: SaveImageToPhotosAlbumParams): Promise< NativeResponse<void>>;
-    saveVideoToPhotosAlbum(params: SaveVideoToPhotosAlbumParams): Promise< NativeResponse<void>>;
-    startRecord(params?: StartRecordParams): Promise< NativeResponse<void>>;
-    stopRecord(params?: Callbacks): Promise< NativeResponse<void>>;
-    getSystemInfo(params?: Callbacks<SystemInfoResult>): Promise< NativeResponse<SystemInfoResult>>;
-    getNetworkType(params?: Callbacks<NetworkTypeResult>): Promise< NativeResponse<NetworkTypeResult>>;
-    setClipboardData(params: SetClipboardDataParams): Promise< NativeResponse<void>>;
-    getClipboardData(params?: Callbacks<GetClipboardDataResult>): Promise< NativeResponse<GetClipboardDataResult>>;
-    checkPermission(params: CheckPermissionParams): Promise< NativeResponse<CheckPermissionResult>>;
-    openPhoneSetting(params: OpenPhoneSettingParams): Promise< NativeResponse<void>>;
-    closeWebView(params?: Callbacks): Promise< NativeResponse<void>>;
-    openInExternalBrowser(params: OpenInExternalBrowserParams): Promise< NativeResponse<void>>;
-};
+/**
+ * 主入口：默认导出聚合对象 mys，同时命名导出所有 API、工具与类型。
+ * 所有 API 返回 Promise，并兼容 success / fail / complete 回调。
+ *
+ * @module index
+ */
+import * as basicApi from './api/basic';
+import * as bizApi from './api/biz';
+import * as routerApi from './api/router';
+import * as bridgeApi from './bridge';
+/**
+ * 聚合对象的类型：用各模块命名空间的交叉，属性类型保持对原函数的符号引用。
+ * 直接写对象字面量会被推断成匿名函数类型，JSDoc 附着不到属性上，IDE 里 mys.xxx 就没有悬浮说明。
+ */
+type ApiNamespace = typeof basicApi & typeof routerApi & typeof bizApi & Pick<typeof bridgeApi, 'setDebug' | 'registerNativeHandler'>;
+/** mys-sdk 的全部 API 与工具，各 API 也都有等价的命名导出 */
+declare const mys: ApiNamespace;
 export default mys;
 export * from './api/basic';
+export * from './api/router';
 export * from './api/biz';
-export { setDebug, registerNativeHandler, bridge };
-export { JSBridgeSdk };
-export { ToastDuration } from './types';
+export { setDebug, registerNativeHandler, onRoute, invokeDebug } from './bridge';
+export { getAppBaseInfo, isInApp, compareVersions } from './utils/app';
+export { ToastDuration, ShareType } from './types';
 export * from './constants/code';
 export type * from './types';