@docoi/mys-sdk 1.2.0 → 1.2.2

package/dist/api/biz.d.ts

@@ -32,7 +32,7 @@ export declare function getCurrentCircleInfo(params?: Callbacks<GetCircleInfoRes
  *
  * @note 响应只表示分享面板已唤起，不包含分享结果；用户完成分享后通过 onShared 回调通知，不需要单独监听事件。
  * @note activityDetail 传对象时会序列化为 JSON 字符串后下发；trackData 需自行 JSON.stringify。
- * @note onShared、getSharePictureUrl 不需要手动取消，触发后、调用失败或下一次调用 shareWebCard 时自动取消。
+ * @note onShared、getSharePictureUrl 不需要手动取消，调用失败或下一次调用 shareWebCard 时自动取消；onShared 触发一次后也会取消，getSharePictureUrl 不受影响。
  * @note 每次调用都会重新注册 getSharePictureUrl，截图结果的缓存要放在函数外面（页面级变量），否则每次分享都会重新截图。
  *
  * @app 2.9.0
@@ -90,11 +90,20 @@ export declare function openAddCustomEmoji(params?: Callbacks): Promise<NativeRe
 /**
  * 打开动态评论区面板。
  *
- * @note 面板的打开、关闭状态可通过 onCommentPanelChange 监听。
+ * @note 面板打开、关闭等状态变化通过 onChange 回调通知，不需要单独监听事件。
+ * @note onChange 不需要手动取消，调用失败或下一次调用 openCommentPanel 时自动取消；面板关闭后不取消，同一次打开可能多次触发。
  *
  * @app 4.2.0
  * @example
- * await mys.openCommentPanel({ serverId: 's123', dynamicId: 'd456', autoFocusInput: true })
+ * await mys.openCommentPanel({
+ *   serverId: 's123',
+ *   dynamicId: 'd456',
+ *   autoFocusInput: true,
+ *   onChange: (res) => {
+ *     // 面板关闭后刷新评论数
+ *     if (!res.visible) refreshCommentCount()
+ *   },
+ * })
  */
 export declare function openCommentPanel(params: OpenCommentPanelParams): Promise<NativeResponse<void>>;
 /**

package/dist/api/router/index.d.ts

@@ -9,6 +9,12 @@ import { Callbacks, NativeResponse, NavigateToParams, OpenInExternalBrowserParam
  * @app 4.4.0
  * @example
  * await mys.switchTab({ tab: 'discover', params: { subTab: 'square' } })
+ *
+ * // 各 tab
+ * mys.switchTab({ tab: 'home' })     // 首页
+ * mys.switchTab({ tab: 'discover' }) // 发现，可用 params.subTab 指定二级 tab：friends 好友圈、square 广场、comic 漫剧
+ * mys.switchTab({ tab: 'message' })  // 消息
+ * mys.switchTab({ tab: 'mine' })     // 我的
  */
 export declare function switchTab(params: SwitchTabParams): Promise<NativeResponse<void>>;
 /**
@@ -23,6 +29,35 @@ export declare function switchTab(params: SwitchTabParams): Promise<NativeRespon
  * @example
  * await mys.navigateTo({ type: 'userHomePage', params: { userId: '123' } })
  * await mys.navigateTo({ url: 'daoke://page?type=11&user_id=123' })
+ *
+ * // 各页面及必填参数；行尾标了版本的页面，App 低于该版本返回 5002
+ * mys.navigateTo({ type: 'dynamicDetailPage', params: { dynamicId } })                     // 动态详情
+ * mys.navigateTo({ type: 'dynamicPublishPage', params: { serverId } })                     // 动态发布
+ * mys.navigateTo({ type: 'topicPage', params: { topicId } })                               // 动态话题
+ * mys.navigateTo({ type: 'likeListPage', params: { dynamicId, publishType } })             // 点赞列表
+ * mys.navigateTo({ type: 'circleHomePage', params: { serverId } })                         // 圈子主页
+ * mys.navigateTo({ type: 'joinCirclePage', params: { serverId, inviteCode } })             // 查询圈子并加入
+ * mys.navigateTo({ type: 'homePage' })                                                     // 新版首页
+ * mys.navigateTo({ type: 'guideCatalogPage', params: { serverId, channelId, catalogId } }) // 攻略一级分类
+ * mys.navigateTo({ type: 'gamePushSettingPage', params: { serverId } })                    // 游戏离线推送开关
+ * mys.navigateTo({ type: 'userHomePage', params: { userId } })                             // 用户主页
+ * mys.navigateTo({ type: 'groupChatPage', params: { serverId, groupId } })                 // 群聊
+ * mys.navigateTo({ type: 'joinGroupPage', params: { inviteCode } })                        // 查询小群并加入
+ * mys.navigateTo({ type: 'privateChatPage', params: { userId } })                          // 私聊（4.1.0 起）
+ * mys.navigateTo({ type: 'myPublishPage' })                                                // 我的-发布
+ * mys.navigateTo({ type: 'myFavoritePage' })                                               // 我的-收藏（3.8.0 起）
+ * mys.navigateTo({ type: 'browseHistoryPage' })                                            // 浏览记录（4.4.0 起）
+ * mys.navigateTo({ type: 'profileEditPage' })                                              // 资料编辑
+ * mys.navigateTo({ type: 'coinRechargePage' })                                             // 金币充值
+ * mys.navigateTo({ type: 'gameSubscribePage' })                                            // 游戏消息订阅（3.8.0 起）
+ * mys.navigateTo({ type: 'douyinMallPage' })                                               // 抖音商城
+ * mys.navigateTo({ type: 'activityCenterPage' })                                           // 活动中心（3.9.0 起）
+ * mys.navigateTo({ type: 'adPage', params: { url } })                                      // 广告 SDK 页面
+ * mys.navigateTo({ type: 'coinDetailPage' })                                               // 金币明细
+ * mys.navigateTo({ type: 'miniGamesPage' })                                                // 小游戏集合（一起玩）
+ * mys.navigateTo({ type: 'bindGamePage', params: { serverId, gameName } })                 // 绑定游戏角色
+ * mys.navigateTo({ type: 'playerReportPage', params: { objectId, objectType } })           // 玩家举报（4.4.0 起）
+ * mys.navigateTo({ type: 'addCustomEmojiPage' })                                           // 添加自定义表情
  */
 export declare function navigateTo(params: NavigateToParams): Promise<NativeResponse<void>>;
 /**
@@ -35,6 +70,13 @@ export declare function navigateTo(params: NavigateToParams): Promise<NativeResp
  * @app 4.4.0
  * @example
  * await mys.openWebview({ url: 'https://example.com', type: 'immersive' })
+ *
+ * // 各容器类型
+ * mys.openWebview({ url, type: 'normal' })      // 普通 H5，带原生导航栏
+ * mys.openWebview({ url, type: 'mini' })        // 小程序样式
+ * mys.openWebview({ url, type: 'immersive' })   // 沉浸式，没有原生导航栏
+ * mys.openWebview({ url, type: 'dynamic' })     // 动态链接
+ * mys.openWebview({ url, type: 'transparent' }) // 纯透明 H5，url 需为 https，不支持 params（3.8.0 起）
  */
 export declare function openWebview(params: OpenWebviewParams): Promise<NativeResponse<void>>;
 /**

package/dist/api/router/routes.d.ts

@@ -235,7 +235,6 @@ export declare const PAGE_ROUTES: {
             };
             nickName: {
                 key: string;
-                required: true;
             };
         };
     };
@@ -629,7 +628,6 @@ export declare const ROUTES: {
             };
             nickName: {
                 key: string;
-                required: true;
             };
         };
     };

package/dist/bridge.d.ts

@@ -17,13 +17,14 @@ export declare function listen<T = unknown>(event: string, callback: (payload: T
 export declare function unlisten(event: string, callback?: object): void;
 /**
  * 注册供 Native 调用的方法，按 since 选择通道，返回注销该次注册的函数。
- * 新通道返回值会包装成 NativeResponse，旧通道直接返回原始值。
+ * 两个通道回给 Native 的结构一致（NativeHandlerReply）：旧通道由 transport/legacy.ts 包装，新通道由 registerNativeHandler 包装。
  */
 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 调用的方法，固定走新通道，返回注销该次注册的函数。
+ * 处理函数的结果按旧通道的结构包装后回给 Native：成功 `{ success: true, data }`，失败 `{ success: false, error: { message } }`。
  *
  * @note 需要按 App 版本选择通道时用 registerHandler。
  */

package/dist/constants/code.d.ts

@@ -13,6 +13,8 @@ export declare const METHOD_NOT_FOUND = 1001;
 export declare const PARAMS_ERROR = 1002;
 /** 未登录段起点：未登录、Token 失效、Token 过期等。 */
 export declare const NOT_LOGGED_IN = 2002;
+/** 未授权的调用：调用方没有通过 App 的安全校验，App 拒绝执行。与 PERMISSION_DENIED 不同，不是系统权限或用户授权的问题。 */
+export declare const UNAUTHORIZED = 3001;
 /** 权限拒绝段起点：权限被拒、权限未开通、用户拒绝授权等。 */
 export declare const PERMISSION_DENIED = 3002;
 /** 网络错误段起点：网络异常、服务端 5xx、超时等。 */