🎨 规范化代码

2026-04-05 07:15:06 +08:00 · 2025-12-24 02:46:28 +08:00
parent 8500668213
commit 651a89145f
199 changed files with 5067 additions and 5390 deletions
--- a/src/enum/anno.ts
+++ b/src/enum/anno.ts
@@ -1,64 +0,0 @@
-/**
- * @file src/enum/anno.ts
- * @description 游戏内公告相关枚举
- * @since Beta v0.8.4
- */
-
-/**
- * @description 公告语言类型
- * @since Beta v0.7.7
- * @const AnnoLangEnum
- */
-export const AnnoLangEnum: typeof TGApp.BBS.Announcement.AnnoLang = {
-  CHS: "zh-cn",
-  CHT: "zh-tw",
-  EN: "en",
-  JP: "ja",
-};
-
-/**
- * @description 获取公告语音描述
- * @since Beta v0.7.7
- * @param {TGApp.BBS.Announcement.AnnoLangEnum} lang 公告语言
- * @return {string} 公告语言描述
- */
-export function getAnnoLangDesc(lang: TGApp.BBS.Announcement.AnnoLangEnum): string {
-  switch (lang) {
-    case AnnoLangEnum.CHS:
-      return "简体中文";
-    case AnnoLangEnum.CHT:
-      return "繁体中文";
-    case AnnoLangEnum.EN:
-      return "英语";
-    case AnnoLangEnum.JP:
-      return "日语";
-  }
-}
-
-/**
- * @description 公告类型
- * @since Beta v0.8.4
- * @const AnnoTypeEnum
- */
-export const AnnoTypeEnum: typeof TGApp.BBS.Announcement.AnnoType = {
-  ACTIVITY: "activity",
-  GAME: "game",
-  UGC: "ugc",
-};
-
-/**
- * @description 获取公告类型描述
- * @since Beta v0.8.4
- * @param {TGApp.BBS.Announcement.AnnoTypeEnum} type 公告类型
- * @return {string} 公告类型描述
- */
-export function getAnnoTypeDesc(type: TGApp.BBS.Announcement.AnnoTypeEnum): string {
-  switch (type) {
-    case AnnoTypeEnum.ACTIVITY:
-      return "活动公告";
-    case AnnoTypeEnum.GAME:
-      return "游戏公告";
-    case AnnoTypeEnum.UGC:
-      return "千星奇域";
-  }
-}
--- a/src/enum/bbs.ts
+++ b/src/enum/bbs.ts
@@ -1,25 +1,24 @@
 /**
- * @file src/enum/bbs.ts
- * @description BBS 相关枚举
+ * 米游社相关枚举
 * @since Beta v0.7.9
 */

 /**
- * @description 用户头像类型
+ * 用户头像类型
 * @since Beta v0.7.9
- * @enum AvatarExtTypeEnum
+ * @see TGApp.BBS.User.AvatarExtTypeEnum
 */
-export const AvatarExtTypeEnum: typeof TGApp.BBS.User.AvatarExtType = {
+const AvatarExtTypeEnum: typeof TGApp.BBS.User.AvatarExtType = {
  CUSTOM: 0,
  GIF: 3,
 };

 /**
- * @description 头像拓展资源类型
+ * 头像拓展资源类型
 * @since Beta v0.7.9
- * @enum AvatarExtResTypeEnum
+ * @see TGApp.BBS.User.AvatarExtResTypeEnum
 */
-export const AvatarExtResTypeEnum: typeof TGApp.BBS.User.AvatarExtResType = {
+const AvatarExtResTypeEnum: typeof TGApp.BBS.User.AvatarExtResType = {
  WEBP: 1,
  APNG: 2,
  GIF: 3,
@@ -27,13 +26,67 @@ export const AvatarExtResTypeEnum: typeof TGApp.BBS.User.AvatarExtResType = {
 };

 /**
- * @description 帖子ViewType
+ * 帖子ViewType
 * @since Beta v0.8.4
- * @enum PostViewTypeEnum
+ * @see TGApp.BBS.Post.ViewTypeEnum
 */
-export const PostViewTypeEnum: typeof TGApp.BBS.Post.PostViewType = {
+const PostViewTypeEnum: typeof TGApp.BBS.Post.PostViewType = {
  NORMAL: 1,
  PIC: 2,
  VOD: 5,
  UGC: 7,
 };
+
+/**
+ * 咨讯类型
+ * @since Beta v0.9.1
+ * @see TGApp.BBS.Post.NewsType
+ */
+const PostNewsTypeEnum: typeof TGApp.BBS.Post.NewsType = {
+  NOTICE: 1,
+  ACTIVITY: 2,
+  NEWS: 3,
+};
+
+/**
+ * 咨讯类型只读列表
+ * @since Beta v0.9.1
+ */
+const PostNewsTypeList: ReadonlyArray<TGApp.BBS.Post.NewsTypeEnum> = [
+  PostNewsTypeEnum.NOTICE,
+  PostNewsTypeEnum.ACTIVITY,
+  PostNewsTypeEnum.NEWS,
+];
+
+/**
+ * 根据咨讯类型获取描述
+ * @since Beta v0.9.1
+ */
+function getPostNewsTypeDesc(newsType: TGApp.BBS.Post.NewsTypeEnum): string {
+  switch (newsType) {
+    case PostNewsTypeEnum.NOTICE:
+      return "公告";
+    case PostNewsTypeEnum.ACTIVITY:
+      return "活动";
+    case PostNewsTypeEnum.NEWS:
+      return "资讯";
+  }
+}
+
+/** 米游社相关枚举 */
+const bbsEnum = {
+  /** 用户信息相关枚举 */
+  user: {
+    avatarExtType: AvatarExtTypeEnum,
+    avatarResType: AvatarExtResTypeEnum,
+  },
+  /** 帖子相关枚举 */
+  post: {
+    viewType: PostViewTypeEnum,
+    newsType: PostNewsTypeEnum,
+    newsTypeList: PostNewsTypeList,
+    newsTypeDesc: getPostNewsTypeDesc,
+  },
+};
+
+export default bbsEnum;
--- a/src/enum/game.ts
+++ b/src/enum/game.ts
@@ -1,34 +1,42 @@
 /**
 * 游戏相关枚举
- * @since Beta v0.9.0
+ * @since Beta v0.9.1
 */

 /**
- * 服务器类型
+ * 服务器类型枚举
 * @since Beta v0.8.0
+ * @see TGApp.Game.Base.ServerTypeEnum
 */
-export const GameServerEnum: typeof TGApp.Game.Base.ServerType = {
-  /** 国服-官方服 */
+const GameServerEnum: typeof TGApp.Game.Base.ServerType = {
  CN_GF01: "cn_gf01",
-  /** 国服-渠道服 */
  CN_QD01: "cn_qd01",
-  /** 国际服-美服 */
  OS_USA: "os_usa",
-  /** 国际服-欧服 */
  OS_EURO: "os_euro",
-  /** 国际服-亚服 */
  OS_ASIA: "os_asia",
-  /** 国际服-港澳台服 */
  OS_CHT: "os_cht",
 };

+/**
+ * 服务器类型只读列表
+ * @since Beta v0.9.1
+ */
+const GameServerList: ReadonlyArray<TGApp.Game.Base.ServerTypeEnum> = [
+  GameServerEnum.CN_GF01,
+  GameServerEnum.CN_QD01,
+  GameServerEnum.OS_USA,
+  GameServerEnum.OS_EURO,
+  GameServerEnum.OS_ASIA,
+  GameServerEnum.OS_CHT,
+];
+
 /**
 * 获取公告服务器描述
 * @since Beta v0.8.0
- * @param {TGApp.Game.Base.ServerTypeEnum} server 公告服务器
- * @return {string} 公告服务器描述
+ * @param server - 公告服务器
+ * @returns 公告服务器描述
 */
-export function getGameServerDesc(server: TGApp.Game.Base.ServerTypeEnum): string {
+function getGameServerDesc(server: TGApp.Game.Base.ServerTypeEnum): string {
  switch (server) {
    case GameServerEnum.CN_GF01:
      return "国服-官方服";
@@ -48,22 +56,99 @@ export function getGameServerDesc(server: TGApp.Game.Base.ServerTypeEnum): strin
 /**
 * 近期活动活动类型枚举
 * @since Beta v0.9.0
+ * @see  TGApp.Game.ActCalendar.ActTypeEnum
 */
-export const ActCalendarTypeEnum: typeof TGApp.Game.ActCalendar.ActType = {
-  /** 幽境危战 */
+const ActCalendarTypeEnum: typeof TGApp.Game.ActCalendar.ActType = {
  HardChallenge: "ActTypeHardChallenge",
-  /** 真境剧诗 */
  RoleCombat: "ActTypeRoleCombat",
-  /** 深渊螺旋 */
  Tower: "ActTypeTower",
-  /** 双倍活动 */
  Double: "ActTypeDouble",
-  /** 探索活动 */
  Explore: "ActTypeExplore",
-  /** 立本活动 */
  LiBen: "ActTypeLiBen",
-  /** 累登活动 */
  SignIn: "ActTypeSignIn",
-  /** 其他活动 */
  Other: "ActTypeOther",
 };
+
+/**
+ * 祈愿类型枚举
+ * @since Beta v0.9.1
+ * @see TGApp.Game.Gacha.GachaTypeEnum
+ */
+const GachaTypeEnum: typeof TGApp.Game.Gacha.GachaType = {
+  Newbie: "100",
+  Normal: "200",
+  AvatarUp: "301",
+  AvatarUp2: "400",
+  WeaponUp: "302",
+  MixUp: "500",
+};
+
+/**
+ * 登录二维码状态枚举
+ * @since Beta v0.9.1
+ * @see TGApp.Game.Login.QrStatEnum
+ */
+const LoginQrStatEnum: typeof TGApp.Game.Login.QrStat = {
+  INIT: "Init",
+  SCANNED: "Scanned",
+  CONFIRMED: "Confirmed",
+};
+
+/**
+ * 公告语言类型枚举
+ * @since Beta v0.9.1
+ * @see TGApp.Game.Anno.AnnoLangEnum
+ */
+const GameAnnoLangEnum: typeof TGApp.Game.Anno.AnnoLang = {
+  CHS: "zh-cn",
+  CHT: "zh-tw",
+  EN: "en",
+  JP: "ja",
+};
+
+/**
+ * 公告语言只读列表
+ * @since Beta v0.9.1
+ */
+const GameAnnoLangList: ReadonlyArray<TGApp.Game.Anno.AnnoLangEnum> = [
+  GameAnnoLangEnum.CHS,
+  GameAnnoLangEnum.CHT,
+  GameAnnoLangEnum.EN,
+  GameAnnoLangEnum.JP,
+];
+
+/**
+ * 获取公告语言描述
+ * @since Beta v0.9.1
+ * @param lang - 公告语言
+ * @returns 公告语言描述
+ */
+function getGameAnnoLangDesc(lang: TGApp.Game.Anno.AnnoLangEnum): string {
+  switch (lang) {
+    case GameAnnoLangEnum.CHS:
+      return "简体中文";
+    case GameAnnoLangEnum.CHT:
+      return "繁体中文";
+    case GameAnnoLangEnum.EN:
+      return "英语";
+    case GameAnnoLangEnum.JP:
+      return "日语";
+  }
+}
+
+/** 游戏相关枚举 */
+const gameEnum = {
+  actCalendarType: ActCalendarTypeEnum,
+  gachaType: GachaTypeEnum,
+  server: GameServerEnum,
+  serverList: GameServerList,
+  serverDesc: getGameServerDesc,
+  loginQrStat: LoginQrStatEnum,
+  anno: {
+    lang: GameAnnoLangEnum,
+    langList: GameAnnoLangList,
+    langDesc: getGameAnnoLangDesc,
+  },
+};
+
+export default gameEnum;
--- a/src/enum/staticData.ts
+++ b/src/enum/staticData.ts
@@ -0,0 +1,20 @@
+/**
+ * 静态 JSON 数据对应的枚举类型
+ * @since Beta v0.9.1
+ */
+
+/**
+ * 日历数据项类型枚举
+ * @since Beta v0.9.1
+ */
+const CalendarItemTypeEnum: typeof TGApp.App.Calendar.ItemType = {
+  role: "character",
+  weapon: "weapon",
+};
+
+/** 静态 JSON 数据对应的枚举集合 */
+const staticDataEnum = {
+  calendarItem: CalendarItemTypeEnum,
+};
+
+export default staticDataEnum;
--- a/src/enum/uiaf.ts
+++ b/src/enum/uiaf.ts
@@ -8,12 +8,8 @@
 * @since Beta v0.7.8
 */
 export const UiafAchiStatEnum: typeof TGApp.Plugins.UIAF.AchiItemStat = {
-  /** 无效状态 */
  Invalid: 0,
-  /** 未完成 */
  Unfinished: 1,
-  /** 已完成未领取奖励 */
  Finished: 2,
-  /** 已领取奖励 */
  RewardTaken: 3,
 };