@docoi/mys-sdk 1.0.3 → 1.1.0

package/dist/api/biz.d.ts

@@ -1,17 +1,18 @@
-import { Callbacks, NativeResponse, ShareWebCardParams, ShareImageParams, ShareImageResult, ShowAdParams, BindGameRoleParams, LoginResult, GetTokenResult, GetCircleInfoResult } from '../types';
+import { Callbacks, NativeResponse, EventListenOptions, ShareWebCardParams, ShareImageParams, ShareImageResult, ShowAdParams, BindGameRoleParams, OpenCommentPanelParams, VoteActionParams, OpenGiftBagParams, OpenFriendsListParams, OpenFriendsListResult, UpdateDataParams, LoginResult, GetTokenResult, GetCircleInfoResult, VoteData, AdFinishedCallback, MemberActivateHandler } from '../types';
 /**
- * 登录授权，获取用户信息。
+ * 登录授权。
  *
- * @app 1.2.3
+ * @note App 4.4.0 以下 Native 只保证登录动作被处理，result.isLogin 不一定返回。
+ *
+ * @app 2.7.0
  * @example
- * const res = await mys.login()
- * console.log(res.result.code)
+ * await mys.login()
  */
 export declare function login(params?: Callbacks<LoginResult>): Promise<NativeResponse<LoginResult>>;
 /**
  * 获取当前用户的登录 Token。
  *
- * @app 1.2.3
+ * @app 3.2.0
  * @example
  * const res = await mys.getToken()
  * console.log(res.result.token)
@@ -20,39 +21,59 @@ export declare function getToken(params?: Callbacks<GetTokenResult>): Promise<Na
 /**
  * 获取当前社群/圈子信息。
  *
- * @app 1.2.3
+ * @app 3.6.0
  * @example
  * const res = await mys.getCurrentCircleInfo()
- * console.log(res.result.name)
+ * console.log(res.result.serverId)
  */
 export declare function getCurrentCircleInfo(params?: Callbacks<GetCircleInfoResult>): Promise<NativeResponse<GetCircleInfoResult>>;
 /**
  * 分享网页卡片到社交平台（微信、QQ 等）。
  *
- * @note
- * title 不能为空。
- * shareTypes 默认 [1, 2, 3]。
+ * @note 响应只表示分享面板已唤起，不包含分享结果；用户完成分享后通过 onShared 回调通知，不需要单独监听事件。
+ * @note activityDetail 传对象时会序列化为 JSON 字符串后下发；trackData 需自行 JSON.stringify。
+ * @note onShared、getSharePictureUrl 不需要手动取消，触发后、调用失败或下一次调用 shareWebCard 时自动取消。
+ * @note 每次调用都会重新注册 getSharePictureUrl，截图结果的缓存要放在函数外面（页面级变量），否则每次分享都会重新截图。
  *
- * @app 1.2.3
+ * @app 2.9.0
  * @example
+ * // 只关心分享结果：用户完成分享后触发 onShared，取消分享不会触发
  * await mys.shareWebCard({
- *   title: '精彩文章',
- *   content: '点开看看',
+ *   title: '梦游社App马到成功',
+ *   content: '梦游社App一往无前',
  *   icon: 'https://example.com/icon.png',
- *   shareUrl: 'https://example.com/article/1',
- *   shareTypes: [1, 2, 3],
+ *   shareUrl: 'https://docoi.cc',
+ *   daokeUrl: 'daoke://page?type=5&h5Type=4&url=https://docoi.cc',
+ *   externalContent: '梦游社App一往无前',
+ *   shareTypes: [ShareType.RecentContacts, ShareType.External, ShareType.Channel],
+ *   onShared: (res) => {
+ *     console.log('分享完成', res?.shareChannel)
+ *   },
+ * })
+ *
+ * // 分享图片：isSharePic 为 true 时提供 getSharePictureUrl，其余字段同上。
+ * // 用户点击客户端的生成图片按钮时 Native 才会调用它，在里面截图并上传；失败时返回 { pictureUrl: undefined }
+ * await mys.shareWebCard({
+ *   // ...其余字段同上
+ *   isSharePic: true,
+ *   getSharePictureUrl: async () => ({ pictureUrl: await generateShareImg() }),
+ *   onShared: (res) => {
+ *     console.log('分享完成', res?.shareChannel)
+ *   },
  * })
+ *
+ * export async function share(getSharePictureUrl: SharePictureUrlHandler) {
+ *   await mys.shareWebCard({ ..., isSharePic: true, getSharePictureUrl })
+ * }
  */
 export declare function shareWebCard(params: ShareWebCardParams): Promise<NativeResponse<void>>;
 /**
  * 唤起客户端图片分享弹窗，分享网络图片。
  *
- * 弹窗提供微信好友、微信朋友圈、QQ 好友、保存图片、取消五个操作，用户点击后通过 result.action 返回所选操作。
- *
- * @note
- * url 不能为空，且必须为 http(s) 网络地址。
- * 点击取消按钮属于成功响应，result.action 为 cancel。
+ * @note 弹窗提供微信好友、微信朋友圈、QQ 好友、保存图片、取消五个操作，用户点击后通过 result.action 返回所选操作。
+ * @note 点击取消按钮属于成功响应，result.action 为 cancel。
  *
+ * @app 4.4.0
  * @example
  * const res = await mys.shareImage({ url: 'https://example.com/poster.png' })
  * console.log(res.result.action) // 'wechat' | 'moment' | 'qq' | 'save' | 'cancel'
@@ -61,30 +82,132 @@ export declare function shareImage(params: ShareImageParams): Promise<NativeResp
 /**
  * 打开添加自定义表情页面。
  *
- * @app 1.2.3
+ * @app 3.9.0
  * @example
  * await mys.openAddCustomEmoji()
  */
 export declare function openAddCustomEmoji(params?: Callbacks): Promise<NativeResponse<void>>;
 /**
- * 跳转绑定游戏角色页面。
+ * 打开动态评论区面板。
  *
- * @note
- * gameName 和 serverId 不能为空。
+ * @note 面板的打开、关闭状态可通过 onCommentPanelChange 监听。
  *
- * @app 1.2.3
+ * @app 4.2.0
+ * @example
+ * await mys.openCommentPanel({ serverId: 's123', dynamicId: 'd456', autoFocusInput: true })
+ */
+export declare function openCommentPanel(params: OpenCommentPanelParams): Promise<NativeResponse<void>>;
+/**
+ * 打开龙跃会员说明弹窗。
+ *
+ * @app 3.2.0
+ * @example
+ * await mys.showLongVipDesDialog()
+ */
+export declare function showLongVipDesDialog(params?: Callbacks): Promise<NativeResponse<void>>;
+/**
+ * 在客户端预览中点击投票或取消投票。
+ *
+ * @note 入参为当前投票数据（字段同返回值）加上被点击选项的下标 index，返回更新后的投票数据。
+ *
+ * @app 4.1.0
+ * @example
+ * const res = await mys.voteAction({ ...voteData, index: 0 })
+ * console.log(res.result.vote_total)
+ */
+export declare function voteAction(params: VoteActionParams): Promise<NativeResponse<VoteData>>;
+/**
+ * 打开好友选择列表，选中的好友在返回结果的 selectedList 里。
+ *
+ * @note 已选好友回显后继续选择，只会返回新增的好友（增量数据）。
+ * @note 低版本 App 的调用方式和返回值与新版一致，不需要区分版本，也不需要自己监听事件。
+ *
+ * @app 3.4.0
+ * @example
+ * const res = await mys.openFriendsList({ selectedUserIds: [] })
+ * console.log(res.result.selectedList)
+ */
+export declare function openFriendsList(params: OpenFriendsListParams): Promise<NativeResponse<OpenFriendsListResult>>;
+/**
+ * 跳转绑定游戏角色页面。
+ *
+ * @app 2.7.0
  * @example
  * await mys.toBindGameRole({ gameName: '大话西游', serverId: 's123' })
  */
 export declare function toBindGameRole(params: BindGameRoleParams): Promise<NativeResponse<void>>;
+/**
+ * 通知 Native 游戏角色绑定成功。
+ *
+ * @app 3.2.0
+ * @example
+ * await mys.bindGameRoleSuccess()
+ */
+export declare function bindGameRoleSuccess(params?: Callbacks): Promise<NativeResponse<void>>;
 /**
  * 展示原生广告视频。
  *
- * @note
- * type 不能为空。
+ * @note 广告播放完成后 Native 通过 onAdFinished 事件通知。
  *
- * @app 1.2.3
+ * @app 3.9.0
  * @example
- * await mys.showAd({ type: 1, circle_id: '123' })
+ * await mys.showAd({ type: 1, params: { circle_id: '123', module: 1 } })
  */
 export declare function showAd(params: ShowAdParams): Promise<NativeResponse<void>>;
+/**
+ * 监听广告播放完成。
+ *
+ * @app 3.7.0
+ * @example
+ * mys.onAdFinished((res) => {
+ *   console.log(res.module)
+ * })
+ */
+export declare function onAdFinished(callback: AdFinishedCallback, options?: EventListenOptions): void;
+/**
+ * 取消监听广告播放完成。
+ *
+ * @param callback 要取消的监听函数，不传则取消全部广告播放完成监听
+ * @app 3.7.0
+ * @example
+ * mys.offAdFinished()
+ */
+export declare function offAdFinished(callback?: AdFinishedCallback): void;
+/**
+ * 通知 Native 更新数据。
+ *
+ * @app 3.6.0
+ * @example
+ * await mys.updateData({ type: 3 })
+ * await mys.updateData({ type: 10, params: { server_id: 's123' } })
+ */
+export declare function updateData(params: UpdateDataParams): Promise<NativeResponse<void>>;
+/**
+ * 打开客户端背包。
+ *
+ * @app 3.2.0
+ * @example
+ * await mys.openGiftBag({ user_id: 'u1', server_id: 's123', openBag: true })
+ */
+export declare function openGiftBag(params: OpenGiftBagParams): Promise<NativeResponse<void>>;
+/**
+ * 注册会员激活通知的处理函数，Native 通知 H5 会员已激活时调用。
+ *
+ * @note 同一时间只保留一个处理函数，重复注册会覆盖。
+ * @note 页面卸载时应调用 offMemberActivate。
+ *
+ * @app 4.4.0
+ * @example
+ * mys.onMemberActivate(async () => {
+ *   await reloadMemberData()
+ * })
+ */
+export declare function onMemberActivate(handler: MemberActivateHandler): void;
+/**
+ * 取消注册会员激活通知的处理函数。
+ *
+ * @app 4.4.0
+ * @example
+ * mys.offMemberActivate()
+ */
+export declare function offMemberActivate(): void;

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

@@ -0,0 +1,68 @@
+import { Callbacks, NativeResponse, NavigateToParams, OpenInExternalBrowserParams, OpenSchemeParams, OpenWebviewParams, SwitchTabParams } from '../../types';
+/**
+ * 跳转到 App 底部 tab 页面。
+ *
+ * @note 不在 App 内时唤起 App，唤起失败（超时仍停留在当前页）时触发 onLaunchFail，由业务侧引导下载。
+ * @note 唤起 App 和 App 4.4.0 以下的跳转都是发出即成功，不代表页面已打开。
+ * @note App 4.4.0 以下能否跳转取决于目标页面自己的起始版本，不支持的返回 ENV_UNSUPPORTED（5002）。
+ *
+ * @app 4.4.0
+ * @example
+ * await mys.switchTab({ tab: 'discover', params: { subTab: 'square' } })
+ */
+export declare function switchTab(params: SwitchTabParams): Promise<NativeResponse<void>>;
+/**
+ * 跳转到 App 原生页面。type 指定目标页面，params 传入该页面所需参数（见下方「页面参数」）；也可以传入 daoke:// 链接。
+ *
+ * @note 不在 App 内时唤起 App，唤起失败（超时仍停留在当前页）时触发 onLaunchFail，由业务侧引导下载。
+ * @note 唤起 App 和 App 4.4.0 以下的跳转都是发出即成功，不代表页面已打开。
+ * @note App 4.4.0 以下能否跳转取决于目标页面自己的起始版本，不支持的返回 ENV_UNSUPPORTED（5002）；绑定游戏角色、添加自定义表情页面在低版本仍可用。
+ *
+ * @app 4.4.0
+ * @paramsMap NavigatePageParamsMap
+ * @example
+ * await mys.navigateTo({ type: 'userHomePage', params: { userId: '123' } })
+ * await mys.navigateTo({ url: 'daoke://page?type=11&user_id=123' })
+ */
+export declare function navigateTo(params: NavigateToParams): Promise<NativeResponse<void>>;
+/**
+ * 打开新的 Webview 页面，type 指定容器类型；用外部浏览器打开请使用 openInExternalBrowser。
+ *
+ * @note 不在 App 内时唤起 App，唤起失败（超时仍停留在当前页）时触发 onLaunchFail，由业务侧引导下载。
+ * @note 唤起 App 和 App 4.4.0 以下的跳转都是发出即成功，不代表页面已打开。
+ * @note App 4.4.0 以下 transparent 类型需要 App 3.8.0，更低版本返回 ENV_UNSUPPORTED（5002）。
+ *
+ * @app 4.4.0
+ * @example
+ * await mys.openWebview({ url: 'https://example.com', type: 'immersive' })
+ */
+export declare function openWebview(params: OpenWebviewParams): Promise<NativeResponse<void>>;
+/**
+ * 按 daoke://page?... 链接跳转，链接原样处理，适用于服务端下发的存量链接。
+ *
+ * @note 唤起 App、低版本兼容和 onLaunchFail 的规则与 navigateTo 一致。
+ *
+ * @app 4.4.0
+ * @example
+ * await mys.openScheme({ url: 'daoke://page?type=11&user_id=123' })
+ */
+export declare function openScheme(params: OpenSchemeParams): Promise<NativeResponse<void>>;
+/**
+ * 用系统外部浏览器打开链接。
+ *
+ * @note 不限制为 http(s)，weixin:// 等 scheme 由系统决定能否打开。
+ * @note 只在 App 内有效，不会唤起 App。
+ *
+ * @app 3.2.0
+ * @example
+ * await mys.openInExternalBrowser({ url: 'https://example.com/download' })
+ */
+export declare function openInExternalBrowser(params: OpenInExternalBrowserParams): Promise<NativeResponse<void>>;
+/**
+ * 关闭当前 WebView 页面。
+ *
+ * @app 2.7.0
+ * @example
+ * await mys.closeWebView()
+ */
+export declare function closeWebView(params?: Callbacks): Promise<NativeResponse<void>>;

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

@@ -0,0 +1,3 @@
+import { DaokeLink } from './routes';
+/** community 壳内交给父级、通用链接由浏览器自行处理，这两个分支检测不到结果，不会触发 onLaunchFail */
+export declare function launchOutsideApp(link: DaokeLink, onLaunchFail?: () => void): void;

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

@@ -0,0 +1,22 @@
+import { Query } from './routes';
+/** openScheme 在新通道上的起始 App 版本，低于它走旧逻辑 */
+export declare const OPEN_SCHEME_SINCE = "4.4.0";
+export type LegacyPlan = {
+    via: 'redirectPage';
+    page: number;
+    params: Record<string, unknown>;
+} | {
+    via: 'legacyMethod';
+    method: string;
+    data: Record<string, unknown>;
+} | {
+    via: 'locationHref';
+} | {
+    via: 'unsupported';
+    reason: string;
+};
+/**
+ * 页面起始版本（routes.ts since）高于当前 App 版本：有旧方法调旧方法（legacyMethod），有旧页面号走 redirectPage，否则不支持；
+ * 其余：iOS 走 redirectPage page 11，Android 走 location.href 由 WebView 拦截。
+ */
+export declare function planLegacy(url: string, query: Query): LegacyPlan;