diff --git a/src/plugins/Mys/types/Emoji.d.ts b/src/plugins/Mys/types/Emoji.d.ts index 6458ff5b..3c6540b5 100644 --- a/src/plugins/Mys/types/Emoji.d.ts +++ b/src/plugins/Mys/types/Emoji.d.ts @@ -15,13 +15,12 @@ declare namespace TGApp.Plugins.Mys.Emoji { * @description 获取表情包列表返回 * @since Beta v0.3.0 * @interface Response - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {Series[]} data.list 表情包列表 * @property {unknown} data.recently_emoticon 最近使用的表情包 * @return Response */ - interface Response extends TGApp.BBS.Response.Base { - retcode: 0; + interface Response extends TGApp.BBS.Response.BaseWithData { data: { list: Series[]; recently_emoticon: unknown; diff --git a/src/plugins/Mys/types/Gacha.d.ts b/src/plugins/Mys/types/Gacha.d.ts index 6c507f03..b870b7b3 100644 --- a/src/plugins/Mys/types/Gacha.d.ts +++ b/src/plugins/Mys/types/Gacha.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.Gacha { * @description 获取卡池信息返回 * @since Alpha v0.2.1 * @interface Response - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {Data[]} data.list 卡池数据 * @return Response */ - interface Response extends TGApp.BBS.Response.Base { - retcode: 0; + interface Response extends TGApp.BBS.Response.BaseWithData { data: { list: Data[]; }; diff --git a/src/plugins/Mys/types/GameLogin.d.ts b/src/plugins/Mys/types/GameLogin.d.ts index ef49a264..bb535583 100644 --- a/src/plugins/Mys/types/GameLogin.d.ts +++ b/src/plugins/Mys/types/GameLogin.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.GameLogin { * @description 获取登录二维码返回数据 * @since Beta v0.3.0 * @interface GetLoginQrResponse - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {GetLoginQrData} data 数据 * @return GetLoginQrResponse */ - interface GetLoginQrResponse extends TGApp.BBS.Response.Base { - retcode: 0; + interface GetLoginQrResponse extends TGApp.BBS.Response.BaseWithData { data: GetLoginQrData; } @@ -39,12 +38,11 @@ declare namespace TGApp.Plugins.Mys.GameLogin { * @description 获取登录状态返回数据 * @since Beta v0.3.0 * @interface GetLoginStatusResponse - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {GetLoginStatusData} data 数据 * @return GetLoginStatusResponse */ - interface GetLoginStatusResponse extends TGApp.BBS.Response.Base { - retcode: 0; + interface GetLoginStatusResponse extends TGApp.BBS.Response.BaseWithData { data: GetLoginStatusData; } diff --git a/src/plugins/Mys/types/Lottery.d.ts b/src/plugins/Mys/types/Lottery.d.ts index 22da303e..dcccc035 100644 --- a/src/plugins/Mys/types/Lottery.d.ts +++ b/src/plugins/Mys/types/Lottery.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.Lottery { * @description 抽奖返回数据 * @since Alpha v0.2.1 * @interface Response - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {FullData} data.show_lottery 抽奖数据 * @return Response */ - interface Response extends TGApp.BBS.Response.Base { - retcode: 0; + interface Response extends TGApp.BBS.Response.BaseWithData { data: { show_lottery: FullData; }; diff --git a/src/plugins/Mys/types/News.d.ts b/src/plugins/Mys/types/News.d.ts index 9ac31286..d43abd66 100644 --- a/src/plugins/Mys/types/News.d.ts +++ b/src/plugins/Mys/types/News.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.News { * @description 咨讯返回数据 * @since Alpha v0.2.1 * @interface Response - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {FullData} data 咨讯数据 * @return Response */ - interface Response extends TGApp.BBS.Response.Base { - retcode: 0; + interface Response extends TGApp.BBS.Response.BaseWithData { data: FullData; } diff --git a/src/plugins/Mys/types/Obc.d.ts b/src/plugins/Mys/types/Obc.d.ts index 72a45005..8b055930 100644 --- a/src/plugins/Mys/types/Obc.d.ts +++ b/src/plugins/Mys/types/Obc.d.ts @@ -13,16 +13,15 @@ declare namespace TGApp.Plugins.Mys.Obc { /** * @description Mys obc 返回数据 - * @since Alpha v0.2.1 + * @since Beta v0.3.6 * @interface Response - * @extends TGApp.BBS.Response.Base - * @property {Obc[]} data.list obc 列表 + * @extends TGApp.BBS.Response.BaseWithData + * @property {Data[]} data.list obc 列表 * @return Response */ - interface Response extends TGApp.BBS.Response.Base { - retcode: 0; + interface Response extends TGApp.BBS.Response.BaseWithData { data: { - list: Obc[]; + list: Data[]; }; } diff --git a/src/plugins/Mys/types/Position.d.ts b/src/plugins/Mys/types/Position.d.ts index e3b91686..582037bf 100644 --- a/src/plugins/Mys/types/Position.d.ts +++ b/src/plugins/Mys/types/Position.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.Position { * @description 热点追踪信息的返回类型 * @since Alpha v0.2.1 * @interface Response - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {ObcItem[]} data.list obc 列表 * @return Response */ - interface Response extends TGApp.BBS.Response.Base { - retcode: 0; + interface Response extends TGApp.BBS.Response.BaseWithData { data: { list: ObcItem[]; }; diff --git a/src/plugins/Mys/types/Post.d.ts b/src/plugins/Mys/types/Post.d.ts index f452ae4b..5ab46db9 100644 --- a/src/plugins/Mys/types/Post.d.ts +++ b/src/plugins/Mys/types/Post.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.Post { * @description 帖子返回数据 * @since Alpha v0.2.1 * @interface Response - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {FullData} data.post 帖子数据 * @return Response */ - interface Response extends TGApp.BBS.Response.Base { - retcode: 0; + interface Response extends TGApp.BBS.Response.BaseWithData { data: { post: FullData; }; diff --git a/src/plugins/Mys/types/User.d.ts b/src/plugins/Mys/types/User.d.ts index a9d9b737..1894eed2 100644 --- a/src/plugins/Mys/types/User.d.ts +++ b/src/plugins/Mys/types/User.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.User { * @description 主页用户信息返回 * @since Alpha v0.2.1 * @interface HomeResponse - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {Home} data 用户信息 * @return HomeResponse */ - interface HomeResponse extends TGApp.BBS.Response.Base { - retcode: 0; + interface HomeResponse extends TGApp.BBS.Response.BaseWithData { data: Home; } diff --git a/src/types/BBS/Announcement.d.ts b/src/types/BBS/Announcement.d.ts index a37fd298..67d79ac8 100644 --- a/src/types/BBS/Announcement.d.ts +++ b/src/types/BBS/Announcement.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.BBS.Announcement { * @description 公告列表返回响应类型 * @interface ListResponse * @since Alpha v0.1.5 - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {ListData} data - 公告列表数据 * @return ListResponse */ - interface ListResponse extends TGApp.BBS.Response.Base { - retcode: 0; + interface ListResponse extends TGApp.BBS.Response.BaseWithData { data: ListData; } @@ -28,12 +27,11 @@ declare namespace TGApp.BBS.Announcement { * @description 公告内容返回响应类型 * @interface ContentResponse * @since Alpha v0.1.5 - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {ContentData} data - 公告内容数据 * @return ContentResponse */ - interface ContentResponse extends TGApp.BBS.Response.Base { - retcode: 0; + interface ContentResponse extends TGApp.BBS.Response.BaseWithData { data: ContentData; } diff --git a/src/types/BBS/Response.d.ts b/src/types/BBS/Response.d.ts index 55886f54..ea588c2a 100644 --- a/src/types/BBS/Response.d.ts +++ b/src/types/BBS/Response.d.ts @@ -1,12 +1,12 @@ /** * @file types/BBS/Response.d.ts * @description BBS 返回数据类型定义文件 - * @since Beta v0.3.5 + * @since Beta v0.3.6 */ /** * @description BBS 返回数据类型定义 - * @since Beta v0.3.5 + * @since Beta v0.3.6 * @namespace TGApp.BBS.Response * @memberof TGApp.BBS */ @@ -15,9 +15,9 @@ declare namespace TGApp.BBS.Response { * @description 基础返回类型,设计米游社接口请求都是这个类型 * @interface Base * @since Beta v0.3.5 - * @property {number} retcode - 响应代码 + * @property {never} retcode - 响应代码 * @property {string} message - 响应消息 - * @property {any} data - 响应数据 + * @property {never} data - 响应数据 * @return Base */ interface Base { @@ -26,6 +26,21 @@ declare namespace TGApp.BBS.Response { data: never; } + /** + * @description 基础返回类型-带有 data 的 + * @interface BaseWithData + * @since Beta v0.3.6 + * @property {0} retcode - 响应代码 + * @property {string} message - 响应消息 + * @property {any} data - 响应数据 + * @return BaseWithData + */ + interface BaseWithData { + retcode: 0; + message: string; + data: any; + } + /** * @description 获取 ltoken 跟 stoken 的响应数据返回 * @interface getTokensRes @@ -43,12 +58,11 @@ declare namespace TGApp.BBS.Response { * @description 获取 ltoken 跟 stoken 的响应数据 * @interface getTokens * @since Alpha v0.1.5 - * @extends Base + * @extends BaseWithData * @property {getTokensRes[]} data.list - token 列表 * @return getTokens */ - interface getTokens extends Base { - retcode: 0; + interface getTokens extends BaseWithData { data: { list: getTokensRes[]; }; @@ -58,12 +72,11 @@ declare namespace TGApp.BBS.Response { * @description 根据 stoken 获取 ltoken 的响应数据 * @interface getLTokenBySToken * @since Alpha v0.1.5 - * @extends Base + * @extends BaseWithData * @property {string} data.ltoken - ltoken 值 * @return getLTokenBySToken */ - interface getLTokenBySToken extends Base { - retcode: 0; + interface getLTokenBySToken extends BaseWithData { data: { ltoken: string; }; @@ -73,13 +86,12 @@ declare namespace TGApp.BBS.Response { * @description 根据 stoken 获取 cookie_token 的响应数据 * @interface getCookieTokenBySToken * @since Alpha v0.1.5 - * @extends Base + * @extends BaseWithData * @property {string} data.uid - 用户 uid * @property {string} data.cookie_token - cookie_token 值 * @return getCookieTokenBySToken */ - interface getCookieTokenBySToken extends Base { - retcode: 0; + interface getCookieTokenBySToken extends BaseWithData { data: { uid: string; cookie_token: string; @@ -90,14 +102,13 @@ declare namespace TGApp.BBS.Response { * @description 通过 stoken 验证用户信息的返回类型 * @interface verifyUserInfoBySToken * @since Alpha v0.1.5 - * @extends Base + * @extends BaseWithData * @property {TGApp.BBS.Account.VerifySTokenInfo} data.user_info - 用户信息 * @property {unknown} data.realname_info - 实名信息 * @property {boolean} data.need_realperson - 是否需要实名认证 * @return verifyUserInfoBySToken */ - interface verifyUserInfoBySToken extends Base { - retcode: 0; + interface verifyUserInfoBySToken extends BaseWithData { data: { user_info: TGApp.BBS.Account.VerifySTokenInfo; realname_info: unknown; @@ -109,12 +120,11 @@ declare namespace TGApp.BBS.Response { * @description 通过 gameToken 获取 stoken 的返回类型 * @interface getStokenByGameToken * @since Beta v0.3.0 - * @extends Base + * @extends BaseWithData * @property {getStokenByGameTokenData} data - 返回数据 * @return getStokenByGameToken */ - interface getStokenByGameToken extends Base { - retcode: 0; + interface getStokenByGameToken extends BaseWithData { data: getStokenByGameTokenData; } @@ -143,13 +153,12 @@ declare namespace TGApp.BBS.Response { * @description 通过 gameToken 获取 cookie_token 的返回类型 * @interface getCookieTokenByGameToken * @since Beta v0.3.0 - * @extends Base + * @extends BaseWithData * @property {string} data.uid - 用户 uid * @property {string} data.cookie_token - cookie_token 值 * @return getCookieTokenByGameToken */ - interface getCookieTokenByGameToken extends Base { - retcode: 0; + interface getCookieTokenByGameToken extends BaseWithData { data: { uid: string; cookie_token: string; @@ -160,14 +169,13 @@ declare namespace TGApp.BBS.Response { * @description 通过 sToken 获取 actionTicket 的返回类型 * @interface getActionTicketBySToken * @since Beta v0.3.4 - * @extends Base + * @extends BaseWithData * @property {string} data.ticket - actionTicket 值 * @property {boolean} data.is_verified - 是否验证 * @property {TGApp.BBS.Account.getActionTicketBySTokenInfo} data.account_info - 用户信息 * @return getActionTicketBySToken */ - interface getActionTicketBySToken extends Base { - retcode: 0; + interface getActionTicketBySToken extends BaseWithData { data: { ticket: string; is_verified: boolean; diff --git a/src/types/Game/Abyss.d.ts b/src/types/Game/Abyss.d.ts index a1013055..b021053e 100644 --- a/src/types/Game/Abyss.d.ts +++ b/src/types/Game/Abyss.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.Game.Abyss { * @description 深渊数据返回类型 * @interface Response * @since Alpha v0.2.0 - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {FullData} data - 深渊数据 * @return Response */ - interface Response extends TGApp.BBS.Response.Base { - retcode: 0; + interface Response extends TGApp.BBS.Response.BaseWithData { data: FullData; } diff --git a/src/types/Game/Calculate.d.ts b/src/types/Game/Calculate.d.ts index f05c5a08..b242aef8 100644 --- a/src/types/Game/Calculate.d.ts +++ b/src/types/Game/Calculate.d.ts @@ -16,12 +16,11 @@ declare namespace TGApp.Game.Calculate { * @since Alpha v0.2.1 * @see TGRequest.User.calculate.getSyncAvatarListAll * @interface SyncAvatarListResponse - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {Array} data.list - 角色列表 * @return SyncAvatarListResponse */ - interface SyncAvatarListResponse extends TGApp.BBS.Response.Base { - retcode: 0; + interface SyncAvatarListResponse extends TGApp.BBS.Response.BaseWithData { data: { list: AvatarListItem[]; }; @@ -57,12 +56,11 @@ declare namespace TGApp.Game.Calculate { * @since Alpha v0.2.1 * @see TGRequest.User.calculate.getSyncAvatarDetail * @interface SyncAvatarDetailResponse - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {AvatarDetail} data - 角色详情 * @return SyncAvatarDetailResponse */ - interface SyncAvatarDetailResponse extends TGApp.BBS.Response.Base { - retcode: 0; + interface SyncAvatarDetailResponse extends TGApp.BBS.Response.BaseWithData { data: TGApp.Game.Calculate.AvatarDetail; } diff --git a/src/types/Game/Character.d.ts b/src/types/Game/Character.d.ts index 0cdf3765..4562cdde 100644 --- a/src/types/Game/Character.d.ts +++ b/src/types/Game/Character.d.ts @@ -15,13 +15,12 @@ declare namespace TGApp.Game.Character { * @description 角色列表数据返回类型 * @interface ListResponse * @since Alpha v0.2.0 - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {ListItem[]} data.avatars - 角色列表 * @property {ListRole} data.role - 角色信息 * @return ListResponse */ - interface ListResponse extends TGApp.BBS.Response.Base { - retcode: 0; + interface ListResponse extends TGApp.BBS.Response.BaseWithData { data: { avatars: ListItem[]; role: ListRole; diff --git a/src/types/Game/DailyNotes.d.ts b/src/types/Game/DailyNotes.d.ts index 11ef1f25..8f238d9f 100644 --- a/src/types/Game/DailyNotes.d.ts +++ b/src/types/Game/DailyNotes.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.Game.DailyNotes { * @description 便笺数据返回 * @since Alpha v0.2.2 * @interface Response - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {FullInfo} data - 便笺数据 * @return Response */ - interface Response extends TGApp.BBS.Response.Base { - retcode: 0; + interface Response extends TGApp.BBS.Response.BaseWithData { data: FullInfo; } diff --git a/src/types/Game/Gacha.d.ts b/src/types/Game/Gacha.d.ts index 40dfdbd4..cd411df2 100644 --- a/src/types/Game/Gacha.d.ts +++ b/src/types/Game/Gacha.d.ts @@ -15,14 +15,13 @@ declare namespace TGApp.Game.Gacha { * @description 获取 authkey 返回类型 * @interface AuthkeyResponse * @since Beta v0.3.0 - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {number} data.sign_type - 签名类型 * @property {number} data.authkey_ver - authkey 版本 * @property {string} data.authkey - authkey * @return AuthkeyResponse */ - interface AuthkeyResponse extends TGApp.BBS.Response.Base { - retcode: 0; + interface AuthkeyResponse extends TGApp.BBS.Response.BaseWithData { data: { sign_type: number; authkey_ver: number; @@ -34,15 +33,14 @@ declare namespace TGApp.Game.Gacha { * @description 获取抽卡记录返回类型 * @interface GachaLogResponse * @since Beta v0.3.0 - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {number} data.page - 页码 * @property {number} data.size - 每页大小 * @property {number} data.total - 总数 * @property {GachaItem[]} data.list - 抽卡记录列表 * @return GachaLogResponse */ - interface GachaLogResponse extends TGApp.BBS.Response.Base { - retcode: 0; + interface GachaLogResponse extends TGApp.BBS.Response.BaseWithData { data: { page: number; size: number; diff --git a/src/types/Game/Record.d.ts b/src/types/Game/Record.d.ts index 62aaf652..216b4882 100644 --- a/src/types/Game/Record.d.ts +++ b/src/types/Game/Record.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.Game.Record { * @description 原神战绩数据返回类型 * @interface Response * @since Alpha v0.2.0 - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {FullData} data - 原神战绩数据 * @return Response */ - interface Response extends TGApp.BBS.Response.Base { - retcode: 0; + interface Response extends TGApp.BBS.Response.BaseWithData { data: FullData; } diff --git a/src/types/User/Account.d.ts b/src/types/User/Account.d.ts index 743d6916..ba6ade71 100644 --- a/src/types/User/Account.d.ts +++ b/src/types/User/Account.d.ts @@ -15,12 +15,11 @@ declare namespace TGApp.User.Account { * @description 游戏账号返回类型 * @interface GameResponse * @since Alpha v0.1.5 - * @extends TGApp.BBS.Response.Base + * @extends TGApp.BBS.Response.BaseWithData * @property {Game[]} data.list 游戏账号列表 * @return GameResponse */ - interface GameResponse extends TGApp.BBS.Response.Base { - retcode: 0; + interface GameResponse extends TGApp.BBS.Response.BaseWithData { data: { list: Game[]; };