✏️ extends BaseWithData #51

This commit is contained in:
BTMuli
2023-11-16 00:16:04 +08:00
parent 43c282efd2
commit bed0e528b0
18 changed files with 78 additions and 91 deletions

View File

@@ -15,13 +15,12 @@ declare namespace TGApp.Plugins.Mys.Emoji {
* @description 获取表情包列表返回 * @description 获取表情包列表返回
* @since Beta v0.3.0 * @since Beta v0.3.0
* @interface Response * @interface Response
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {Series[]} data.list 表情包列表 * @property {Series[]} data.list 表情包列表
* @property {unknown} data.recently_emoticon 最近使用的表情包 * @property {unknown} data.recently_emoticon 最近使用的表情包
* @return Response * @return Response
*/ */
interface Response extends TGApp.BBS.Response.Base { interface Response extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: { data: {
list: Series[]; list: Series[];
recently_emoticon: unknown; recently_emoticon: unknown;

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.Gacha {
* @description 获取卡池信息返回 * @description 获取卡池信息返回
* @since Alpha v0.2.1 * @since Alpha v0.2.1
* @interface Response * @interface Response
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {Data[]} data.list 卡池数据 * @property {Data[]} data.list 卡池数据
* @return Response * @return Response
*/ */
interface Response extends TGApp.BBS.Response.Base { interface Response extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: { data: {
list: Data[]; list: Data[];
}; };

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.GameLogin {
* @description 获取登录二维码返回数据 * @description 获取登录二维码返回数据
* @since Beta v0.3.0 * @since Beta v0.3.0
* @interface GetLoginQrResponse * @interface GetLoginQrResponse
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {GetLoginQrData} data 数据 * @property {GetLoginQrData} data 数据
* @return GetLoginQrResponse * @return GetLoginQrResponse
*/ */
interface GetLoginQrResponse extends TGApp.BBS.Response.Base { interface GetLoginQrResponse extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: GetLoginQrData; data: GetLoginQrData;
} }
@@ -39,12 +38,11 @@ declare namespace TGApp.Plugins.Mys.GameLogin {
* @description 获取登录状态返回数据 * @description 获取登录状态返回数据
* @since Beta v0.3.0 * @since Beta v0.3.0
* @interface GetLoginStatusResponse * @interface GetLoginStatusResponse
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {GetLoginStatusData} data 数据 * @property {GetLoginStatusData} data 数据
* @return GetLoginStatusResponse * @return GetLoginStatusResponse
*/ */
interface GetLoginStatusResponse extends TGApp.BBS.Response.Base { interface GetLoginStatusResponse extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: GetLoginStatusData; data: GetLoginStatusData;
} }

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.Lottery {
* @description 抽奖返回数据 * @description 抽奖返回数据
* @since Alpha v0.2.1 * @since Alpha v0.2.1
* @interface Response * @interface Response
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {FullData} data.show_lottery 抽奖数据 * @property {FullData} data.show_lottery 抽奖数据
* @return Response * @return Response
*/ */
interface Response extends TGApp.BBS.Response.Base { interface Response extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: { data: {
show_lottery: FullData; show_lottery: FullData;
}; };

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.News {
* @description 咨讯返回数据 * @description 咨讯返回数据
* @since Alpha v0.2.1 * @since Alpha v0.2.1
* @interface Response * @interface Response
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {FullData} data 咨讯数据 * @property {FullData} data 咨讯数据
* @return Response * @return Response
*/ */
interface Response extends TGApp.BBS.Response.Base { interface Response extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: FullData; data: FullData;
} }

View File

@@ -13,16 +13,15 @@
declare namespace TGApp.Plugins.Mys.Obc { declare namespace TGApp.Plugins.Mys.Obc {
/** /**
* @description Mys obc 返回数据 * @description Mys obc 返回数据
* @since Alpha v0.2.1 * @since Beta v0.3.6
* @interface Response * @interface Response
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {Obc[]} data.list obc 列表 * @property {Data[]} data.list obc 列表
* @return Response * @return Response
*/ */
interface Response extends TGApp.BBS.Response.Base { interface Response extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: { data: {
list: Obc[]; list: Data[];
}; };
} }

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.Position {
* @description 热点追踪信息的返回类型 * @description 热点追踪信息的返回类型
* @since Alpha v0.2.1 * @since Alpha v0.2.1
* @interface Response * @interface Response
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {ObcItem[]} data.list obc 列表 * @property {ObcItem[]} data.list obc 列表
* @return Response * @return Response
*/ */
interface Response extends TGApp.BBS.Response.Base { interface Response extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: { data: {
list: ObcItem[]; list: ObcItem[];
}; };

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.Post {
* @description 帖子返回数据 * @description 帖子返回数据
* @since Alpha v0.2.1 * @since Alpha v0.2.1
* @interface Response * @interface Response
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {FullData} data.post 帖子数据 * @property {FullData} data.post 帖子数据
* @return Response * @return Response
*/ */
interface Response extends TGApp.BBS.Response.Base { interface Response extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: { data: {
post: FullData; post: FullData;
}; };

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.Plugins.Mys.User {
* @description 主页用户信息返回 * @description 主页用户信息返回
* @since Alpha v0.2.1 * @since Alpha v0.2.1
* @interface HomeResponse * @interface HomeResponse
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {Home} data 用户信息 * @property {Home} data 用户信息
* @return HomeResponse * @return HomeResponse
*/ */
interface HomeResponse extends TGApp.BBS.Response.Base { interface HomeResponse extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: Home; data: Home;
} }

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.BBS.Announcement {
* @description 公告列表返回响应类型 * @description 公告列表返回响应类型
* @interface ListResponse * @interface ListResponse
* @since Alpha v0.1.5 * @since Alpha v0.1.5
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {ListData} data - 公告列表数据 * @property {ListData} data - 公告列表数据
* @return ListResponse * @return ListResponse
*/ */
interface ListResponse extends TGApp.BBS.Response.Base { interface ListResponse extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: ListData; data: ListData;
} }
@@ -28,12 +27,11 @@ declare namespace TGApp.BBS.Announcement {
* @description 公告内容返回响应类型 * @description 公告内容返回响应类型
* @interface ContentResponse * @interface ContentResponse
* @since Alpha v0.1.5 * @since Alpha v0.1.5
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {ContentData} data - 公告内容数据 * @property {ContentData} data - 公告内容数据
* @return ContentResponse * @return ContentResponse
*/ */
interface ContentResponse extends TGApp.BBS.Response.Base { interface ContentResponse extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: ContentData; data: ContentData;
} }

View File

@@ -1,12 +1,12 @@
/** /**
* @file types/BBS/Response.d.ts * @file types/BBS/Response.d.ts
* @description BBS 返回数据类型定义文件 * @description BBS 返回数据类型定义文件
* @since Beta v0.3.5 * @since Beta v0.3.6
*/ */
/** /**
* @description BBS 返回数据类型定义 * @description BBS 返回数据类型定义
* @since Beta v0.3.5 * @since Beta v0.3.6
* @namespace TGApp.BBS.Response * @namespace TGApp.BBS.Response
* @memberof TGApp.BBS * @memberof TGApp.BBS
*/ */
@@ -15,9 +15,9 @@ declare namespace TGApp.BBS.Response {
* @description 基础返回类型,设计米游社接口请求都是这个类型 * @description 基础返回类型,设计米游社接口请求都是这个类型
* @interface Base * @interface Base
* @since Beta v0.3.5 * @since Beta v0.3.5
* @property {number} retcode - 响应代码 * @property {never} retcode - 响应代码
* @property {string} message - 响应消息 * @property {string} message - 响应消息
* @property {any} data - 响应数据 * @property {never} data - 响应数据
* @return Base * @return Base
*/ */
interface Base { interface Base {
@@ -26,6 +26,21 @@ declare namespace TGApp.BBS.Response {
data: never; 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 的响应数据返回 * @description 获取 ltoken 跟 stoken 的响应数据返回
* @interface getTokensRes * @interface getTokensRes
@@ -43,12 +58,11 @@ declare namespace TGApp.BBS.Response {
* @description 获取 ltoken 跟 stoken 的响应数据 * @description 获取 ltoken 跟 stoken 的响应数据
* @interface getTokens * @interface getTokens
* @since Alpha v0.1.5 * @since Alpha v0.1.5
* @extends Base * @extends BaseWithData
* @property {getTokensRes[]} data.list - token 列表 * @property {getTokensRes[]} data.list - token 列表
* @return getTokens * @return getTokens
*/ */
interface getTokens extends Base { interface getTokens extends BaseWithData {
retcode: 0;
data: { data: {
list: getTokensRes[]; list: getTokensRes[];
}; };
@@ -58,12 +72,11 @@ declare namespace TGApp.BBS.Response {
* @description 根据 stoken 获取 ltoken 的响应数据 * @description 根据 stoken 获取 ltoken 的响应数据
* @interface getLTokenBySToken * @interface getLTokenBySToken
* @since Alpha v0.1.5 * @since Alpha v0.1.5
* @extends Base * @extends BaseWithData
* @property {string} data.ltoken - ltoken 值 * @property {string} data.ltoken - ltoken 值
* @return getLTokenBySToken * @return getLTokenBySToken
*/ */
interface getLTokenBySToken extends Base { interface getLTokenBySToken extends BaseWithData {
retcode: 0;
data: { data: {
ltoken: string; ltoken: string;
}; };
@@ -73,13 +86,12 @@ declare namespace TGApp.BBS.Response {
* @description 根据 stoken 获取 cookie_token 的响应数据 * @description 根据 stoken 获取 cookie_token 的响应数据
* @interface getCookieTokenBySToken * @interface getCookieTokenBySToken
* @since Alpha v0.1.5 * @since Alpha v0.1.5
* @extends Base * @extends BaseWithData
* @property {string} data.uid - 用户 uid * @property {string} data.uid - 用户 uid
* @property {string} data.cookie_token - cookie_token 值 * @property {string} data.cookie_token - cookie_token 值
* @return getCookieTokenBySToken * @return getCookieTokenBySToken
*/ */
interface getCookieTokenBySToken extends Base { interface getCookieTokenBySToken extends BaseWithData {
retcode: 0;
data: { data: {
uid: string; uid: string;
cookie_token: string; cookie_token: string;
@@ -90,14 +102,13 @@ declare namespace TGApp.BBS.Response {
* @description 通过 stoken 验证用户信息的返回类型 * @description 通过 stoken 验证用户信息的返回类型
* @interface verifyUserInfoBySToken * @interface verifyUserInfoBySToken
* @since Alpha v0.1.5 * @since Alpha v0.1.5
* @extends Base * @extends BaseWithData
* @property {TGApp.BBS.Account.VerifySTokenInfo} data.user_info - 用户信息 * @property {TGApp.BBS.Account.VerifySTokenInfo} data.user_info - 用户信息
* @property {unknown} data.realname_info - 实名信息 * @property {unknown} data.realname_info - 实名信息
* @property {boolean} data.need_realperson - 是否需要实名认证 * @property {boolean} data.need_realperson - 是否需要实名认证
* @return verifyUserInfoBySToken * @return verifyUserInfoBySToken
*/ */
interface verifyUserInfoBySToken extends Base { interface verifyUserInfoBySToken extends BaseWithData {
retcode: 0;
data: { data: {
user_info: TGApp.BBS.Account.VerifySTokenInfo; user_info: TGApp.BBS.Account.VerifySTokenInfo;
realname_info: unknown; realname_info: unknown;
@@ -109,12 +120,11 @@ declare namespace TGApp.BBS.Response {
* @description 通过 gameToken 获取 stoken 的返回类型 * @description 通过 gameToken 获取 stoken 的返回类型
* @interface getStokenByGameToken * @interface getStokenByGameToken
* @since Beta v0.3.0 * @since Beta v0.3.0
* @extends Base * @extends BaseWithData
* @property {getStokenByGameTokenData} data - 返回数据 * @property {getStokenByGameTokenData} data - 返回数据
* @return getStokenByGameToken * @return getStokenByGameToken
*/ */
interface getStokenByGameToken extends Base { interface getStokenByGameToken extends BaseWithData {
retcode: 0;
data: getStokenByGameTokenData; data: getStokenByGameTokenData;
} }
@@ -143,13 +153,12 @@ declare namespace TGApp.BBS.Response {
* @description 通过 gameToken 获取 cookie_token 的返回类型 * @description 通过 gameToken 获取 cookie_token 的返回类型
* @interface getCookieTokenByGameToken * @interface getCookieTokenByGameToken
* @since Beta v0.3.0 * @since Beta v0.3.0
* @extends Base * @extends BaseWithData
* @property {string} data.uid - 用户 uid * @property {string} data.uid - 用户 uid
* @property {string} data.cookie_token - cookie_token 值 * @property {string} data.cookie_token - cookie_token 值
* @return getCookieTokenByGameToken * @return getCookieTokenByGameToken
*/ */
interface getCookieTokenByGameToken extends Base { interface getCookieTokenByGameToken extends BaseWithData {
retcode: 0;
data: { data: {
uid: string; uid: string;
cookie_token: string; cookie_token: string;
@@ -160,14 +169,13 @@ declare namespace TGApp.BBS.Response {
* @description 通过 sToken 获取 actionTicket 的返回类型 * @description 通过 sToken 获取 actionTicket 的返回类型
* @interface getActionTicketBySToken * @interface getActionTicketBySToken
* @since Beta v0.3.4 * @since Beta v0.3.4
* @extends Base * @extends BaseWithData
* @property {string} data.ticket - actionTicket 值 * @property {string} data.ticket - actionTicket 值
* @property {boolean} data.is_verified - 是否验证 * @property {boolean} data.is_verified - 是否验证
* @property {TGApp.BBS.Account.getActionTicketBySTokenInfo} data.account_info - 用户信息 * @property {TGApp.BBS.Account.getActionTicketBySTokenInfo} data.account_info - 用户信息
* @return getActionTicketBySToken * @return getActionTicketBySToken
*/ */
interface getActionTicketBySToken extends Base { interface getActionTicketBySToken extends BaseWithData {
retcode: 0;
data: { data: {
ticket: string; ticket: string;
is_verified: boolean; is_verified: boolean;

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.Game.Abyss {
* @description 深渊数据返回类型 * @description 深渊数据返回类型
* @interface Response * @interface Response
* @since Alpha v0.2.0 * @since Alpha v0.2.0
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {FullData} data - 深渊数据 * @property {FullData} data - 深渊数据
* @return Response * @return Response
*/ */
interface Response extends TGApp.BBS.Response.Base { interface Response extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: FullData; data: FullData;
} }

View File

@@ -16,12 +16,11 @@ declare namespace TGApp.Game.Calculate {
* @since Alpha v0.2.1 * @since Alpha v0.2.1
* @see TGRequest.User.calculate.getSyncAvatarListAll * @see TGRequest.User.calculate.getSyncAvatarListAll
* @interface SyncAvatarListResponse * @interface SyncAvatarListResponse
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {Array<AvatarListItem>} data.list - 角色列表 * @property {Array<AvatarListItem>} data.list - 角色列表
* @return SyncAvatarListResponse * @return SyncAvatarListResponse
*/ */
interface SyncAvatarListResponse extends TGApp.BBS.Response.Base { interface SyncAvatarListResponse extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: { data: {
list: AvatarListItem[]; list: AvatarListItem[];
}; };
@@ -57,12 +56,11 @@ declare namespace TGApp.Game.Calculate {
* @since Alpha v0.2.1 * @since Alpha v0.2.1
* @see TGRequest.User.calculate.getSyncAvatarDetail * @see TGRequest.User.calculate.getSyncAvatarDetail
* @interface SyncAvatarDetailResponse * @interface SyncAvatarDetailResponse
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {AvatarDetail} data - 角色详情 * @property {AvatarDetail} data - 角色详情
* @return SyncAvatarDetailResponse * @return SyncAvatarDetailResponse
*/ */
interface SyncAvatarDetailResponse extends TGApp.BBS.Response.Base { interface SyncAvatarDetailResponse extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: TGApp.Game.Calculate.AvatarDetail; data: TGApp.Game.Calculate.AvatarDetail;
} }

View File

@@ -15,13 +15,12 @@ declare namespace TGApp.Game.Character {
* @description 角色列表数据返回类型 * @description 角色列表数据返回类型
* @interface ListResponse * @interface ListResponse
* @since Alpha v0.2.0 * @since Alpha v0.2.0
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {ListItem[]} data.avatars - 角色列表 * @property {ListItem[]} data.avatars - 角色列表
* @property {ListRole} data.role - 角色信息 * @property {ListRole} data.role - 角色信息
* @return ListResponse * @return ListResponse
*/ */
interface ListResponse extends TGApp.BBS.Response.Base { interface ListResponse extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: { data: {
avatars: ListItem[]; avatars: ListItem[];
role: ListRole; role: ListRole;

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.Game.DailyNotes {
* @description 便笺数据返回 * @description 便笺数据返回
* @since Alpha v0.2.2 * @since Alpha v0.2.2
* @interface Response * @interface Response
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {FullInfo} data - 便笺数据 * @property {FullInfo} data - 便笺数据
* @return Response * @return Response
*/ */
interface Response extends TGApp.BBS.Response.Base { interface Response extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: FullInfo; data: FullInfo;
} }

View File

@@ -15,14 +15,13 @@ declare namespace TGApp.Game.Gacha {
* @description 获取 authkey 返回类型 * @description 获取 authkey 返回类型
* @interface AuthkeyResponse * @interface AuthkeyResponse
* @since Beta v0.3.0 * @since Beta v0.3.0
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {number} data.sign_type - 签名类型 * @property {number} data.sign_type - 签名类型
* @property {number} data.authkey_ver - authkey 版本 * @property {number} data.authkey_ver - authkey 版本
* @property {string} data.authkey - authkey * @property {string} data.authkey - authkey
* @return AuthkeyResponse * @return AuthkeyResponse
*/ */
interface AuthkeyResponse extends TGApp.BBS.Response.Base { interface AuthkeyResponse extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: { data: {
sign_type: number; sign_type: number;
authkey_ver: number; authkey_ver: number;
@@ -34,15 +33,14 @@ declare namespace TGApp.Game.Gacha {
* @description 获取抽卡记录返回类型 * @description 获取抽卡记录返回类型
* @interface GachaLogResponse * @interface GachaLogResponse
* @since Beta v0.3.0 * @since Beta v0.3.0
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {number} data.page - 页码 * @property {number} data.page - 页码
* @property {number} data.size - 每页大小 * @property {number} data.size - 每页大小
* @property {number} data.total - 总数 * @property {number} data.total - 总数
* @property {GachaItem[]} data.list - 抽卡记录列表 * @property {GachaItem[]} data.list - 抽卡记录列表
* @return GachaLogResponse * @return GachaLogResponse
*/ */
interface GachaLogResponse extends TGApp.BBS.Response.Base { interface GachaLogResponse extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: { data: {
page: number; page: number;
size: number; size: number;

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.Game.Record {
* @description 原神战绩数据返回类型 * @description 原神战绩数据返回类型
* @interface Response * @interface Response
* @since Alpha v0.2.0 * @since Alpha v0.2.0
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {FullData} data - 原神战绩数据 * @property {FullData} data - 原神战绩数据
* @return Response * @return Response
*/ */
interface Response extends TGApp.BBS.Response.Base { interface Response extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: FullData; data: FullData;
} }

View File

@@ -15,12 +15,11 @@ declare namespace TGApp.User.Account {
* @description 游戏账号返回类型 * @description 游戏账号返回类型
* @interface GameResponse * @interface GameResponse
* @since Alpha v0.1.5 * @since Alpha v0.1.5
* @extends TGApp.BBS.Response.Base * @extends TGApp.BBS.Response.BaseWithData
* @property {Game[]} data.list 游戏账号列表 * @property {Game[]} data.list 游戏账号列表
* @return GameResponse * @return GameResponse
*/ */
interface GameResponse extends TGApp.BBS.Response.Base { interface GameResponse extends TGApp.BBS.Response.BaseWithData {
retcode: 0;
data: { data: {
list: Game[]; list: Game[];
}; };