✏️ extends BaseWithData #51

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;
   }
 

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;