[Refactor] Consolidate typings/ into @types/, and API types (#6823)

.dependency-cruiser.cjs

@@ -20,6 +20,7 @@ module.exports = {
       comment: "Files in 'enums/' and '@types/' must only use type imports.",
       from: {
         path: ["(^|/)src/@types", "(^|/)src/enums"],
+        pathNot: ["(^|/)src/@types/phaser[.]d[.]ts"],
       },
       to: {
         dependencyTypesNot: ["type-only"],

src/@types/api.ts

@@ -0,0 +1,147 @@
+import type { SessionSaveData, SystemSaveData } from "#types/save-data";
+
+export interface UserInfo {
+  username: string;
+  lastSessionSlot: number;
+  discordId: string;
+  googleId: string;
+  hasAdminRole: boolean;
+}
+
+export interface TitleStatsResponse {
+  playerCount: number;
+  battleCount: number;
+}
+
+// #region Account API
+
+export interface AccountInfoResponse extends UserInfo {}
+
+export interface AccountLoginRequest {
+  username: string;
+  password: string;
+}
+
+export interface AccountLoginResponse {
+  token: string;
+}
+
+export interface AccountRegisterRequest {
+  username: string;
+  password: string;
+}
+
+export interface AccountChangePwRequest {
+  password: string;
+}
+export interface AccountChangePwResponse {
+  success: boolean;
+}
+
+// #endregion
+// #region Admin API
+
+export interface SearchAccountRequest {
+  username: string;
+}
+
+export interface DiscordRequest extends SearchAccountRequest {
+  discordId: string;
+}
+
+export interface GoogleRequest extends SearchAccountRequest {
+  googleId: string;
+}
+
+export interface SearchAccountResponse {
+  username: string;
+  discordId: string;
+  googleId: string;
+  lastLoggedIn: string;
+  registered: string;
+  systemData?: SystemSaveData;
+}
+
+/** Third party login services */
+export type AdminUiHandlerService = "discord" | "google";
+/** Mode for the admin UI handler */
+export type AdminUiHandlerServiceMode = "Link" | "Unlink";
+
+export interface PokerogueAdminApiParams extends Record<AdminUiHandlerService, SearchAccountRequest> {
+  discord: DiscordRequest;
+  google: GoogleRequest;
+}
+
+// #endregion
+
+export interface UpdateAllSavedataRequest {
+  system: SystemSaveData;
+  session: SessionSaveData;
+  sessionSlotId: number;
+  clientSessionId: string;
+}
+
+// #region Session Save API
+
+export interface UpdateSessionSavedataRequest {
+  slot: number;
+  trainerId: number;
+  secretId: number;
+  clientSessionId: string;
+}
+
+/** This is **NOT** related to {@linkcode ClearSessionSavedataRequest}  */
+export interface NewClearSessionSavedataRequest {
+  slot: number;
+  isVictory: boolean;
+  clientSessionId: string;
+}
+
+export interface GetSessionSavedataRequest {
+  slot: number;
+  clientSessionId: string;
+}
+
+export interface DeleteSessionSavedataRequest {
+  slot: number;
+  clientSessionId: string;
+}
+
+/** This is **NOT** related to {@linkcode NewClearSessionSavedataRequest} */
+export interface ClearSessionSavedataRequest {
+  slot: number;
+  trainerId: number;
+  clientSessionId: string;
+}
+
+/** Pokerogue API response for path: `/savedata/session/clear` */
+export interface ClearSessionSavedataResponse {
+  /** Contains the error message if any occured */
+  error?: string;
+  /** Is `true` if the request was successfully processed */
+  success?: boolean;
+}
+
+// #endregion
+// #region System Save API
+
+export interface GetSystemSavedataRequest {
+  clientSessionId: string;
+}
+
+export interface UpdateSystemSavedataRequest {
+  clientSessionId: string;
+  trainerId?: number;
+  secretId?: number;
+}
+
+export interface VerifySystemSavedataRequest {
+  clientSessionId: string;
+}
+
+export interface VerifySystemSavedataResponse {
+  valid: boolean;
+  systemData: SystemSaveData;
+}
+
+// #endregion

src/@types/api/pokerogue-account-api.ts

@@ -1,24 +0,0 @@
-import type { UserInfo } from "#types/user-info";
-
-export interface AccountInfoResponse extends UserInfo {}
-
-export interface AccountLoginRequest {
-  username: string;
-  password: string;
-}
-
-export interface AccountLoginResponse {
-  token: string;
-}
-
-export interface AccountRegisterRequest {
-  username: string;
-  password: string;
-}
-
-export interface AccountChangePwRequest {
-  password: string;
-}
-export interface AccountChangePwResponse {
-  success: boolean;
-}

src/@types/api/pokerogue-admin-api.ts

@@ -1,32 +0,0 @@
-import type { SystemSaveData } from "#types/save-data";
-
-export interface SearchAccountRequest {
-  username: string;
-}
-
-export interface DiscordRequest extends SearchAccountRequest {
-  discordId: string;
-}
-
-export interface GoogleRequest extends SearchAccountRequest {
-  googleId: string;
-}
-
-export interface SearchAccountResponse {
-  username: string;
-  discordId: string;
-  googleId: string;
-  lastLoggedIn: string;
-  registered: string;
-  systemData?: SystemSaveData;
-}
-
-/** Third party login services */
-export type AdminUiHandlerService = "discord" | "google";
-/** Mode for the admin UI handler */
-export type AdminUiHandlerServiceMode = "Link" | "Unlink";
-
-export interface PokerogueAdminApiParams extends Record<AdminUiHandlerService, SearchAccountRequest> {
-  discord: DiscordRequest;
-  google: GoogleRequest;
-}

src/@types/api/pokerogue-api-types.ts

@@ -1,4 +0,0 @@
-export interface TitleStatsResponse {
-  playerCount: number;
-  battleCount: number;
-}

src/@types/api/pokerogue-save-data-api.ts

@@ -1,8 +0,0 @@
-import type { SessionSaveData, SystemSaveData } from "#types/save-data";
-
-export interface UpdateAllSavedataRequest {
-  system: SystemSaveData;
-  session: SessionSaveData;
-  sessionSlotId: number;
-  clientSessionId: string;
-}

src/@types/api/pokerogue-session-save-data-api.ts

@@ -1,40 +0,0 @@
-export interface UpdateSessionSavedataRequest {
-  slot: number;
-  trainerId: number;
-  secretId: number;
-  clientSessionId: string;
-}
-
-/** This is **NOT** similar to {@linkcode ClearSessionSavedataRequest}  */
-export interface NewClearSessionSavedataRequest {
-  slot: number;
-  isVictory: boolean;
-  clientSessionId: string;
-}
-
-export interface GetSessionSavedataRequest {
-  slot: number;
-  clientSessionId: string;
-}
-
-export interface DeleteSessionSavedataRequest {
-  slot: number;
-  clientSessionId: string;
-}
-
-/** This is **NOT** similar to {@linkcode NewClearSessionSavedataRequest} */
-export interface ClearSessionSavedataRequest {
-  slot: number;
-  trainerId: number;
-  clientSessionId: string;
-}
-
-/**
- * Pokerogue API response for path: `/savedata/session/clear`
- */
-export interface ClearSessionSavedataResponse {
-  /** Contains the error message if any occured */
-  error?: string;
-  /** Is `true` if the request was successfully processed */
-  success?: boolean;
-}

src/@types/api/pokerogue-system-save-data-api.ts

@@ -1,20 +0,0 @@
-import type { SystemSaveData } from "#types/save-data";
-
-export interface GetSystemSavedataRequest {
-  clientSessionId: string;
-}
-
-export interface UpdateSystemSavedataRequest {
-  clientSessionId: string;
-  trainerId?: number;
-  secretId?: number;
-}
-
-export interface VerifySystemSavedataRequest {
-  clientSessionId: string;
-}
-
-export interface VerifySystemSavedataResponse {
-  valid: boolean;
-  systemData: SystemSaveData;
-}

src/@types/pokerogue-daily-api.ts

@@ -1,10 +1,12 @@
 import type { ScoreboardCategory } from "#ui/daily-run-scoreboard";
 
+/** @deprecated */
 export interface GetDailyRankingsRequest {
   category: ScoreboardCategory;
   page?: number;
 }
 
+/** @deprecated */
 export interface GetDailyRankingsPageCountRequest {
   category: ScoreboardCategory;
 }

src/@types/save-data.ts

@@ -131,7 +131,7 @@ export type RunHistoryData = Record<number, RunEntry>;
 export interface RunEntry {
   entry: SessionSaveData;
   isVictory: boolean;
-  /*Automatically set to false at the moment - implementation TBD*/
+  /** Automatically set to false at the moment - implementation TBD */
   isFavorite: boolean;
 }
 

src/@types/save-migrators.ts

@@ -0,0 +1,16 @@
+import type { SessionSaveData, SystemSaveData } from "#types/save-data";
+
+export interface SessionSaveMigrator {
+  version: string;
+  migrate: (data: SessionSaveData) => void;
+}
+
+export interface SettingsSaveMigrator {
+  version: string;
+  migrate: (data: object) => void;
+}
+
+export interface SystemSaveMigrator {
+  version: string;
+  migrate: (data: SystemSaveData) => void;
+}

src/@types/session-save-migrator.ts

@@ -1,6 +0,0 @@
-import type { SessionSaveData } from "./save-data";
-
-export interface SessionSaveMigrator {
-  version: string;
-  migrate: (data: SessionSaveData) => void;
-}

src/@types/settings-save-migrator.ts

@@ -1,5 +0,0 @@
-export interface SettingsSaveMigrator {
-  version: string;
-  // biome-ignore lint/complexity/noBannedTypes: TODO - refactor settings
-  migrate: (data: Object) => void;
-}

src/@types/system-save-migrator.ts

@@ -1,6 +0,0 @@
-import type { SystemSaveData } from "./save-data";
-
-export interface SystemSaveMigrator {
-  version: string;
-  migrate: (data: SystemSaveData) => void;
-}

src/@types/user-info.ts

@@ -1,7 +0,0 @@
-export interface UserInfo {
-  username: string;
-  lastSessionSlot: number;
-  discordId: string;
-  googleId: string;
-  hasAdminRole: boolean;
-}

src/account.ts

@@ -1,6 +1,6 @@
 import { pokerogueApi } from "#api/pokerogue-api";
 import { bypassLogin } from "#constants/app-constants";
-import type { UserInfo } from "#types/user-info";
+import type { UserInfo } from "#types/api";
 import { randomString } from "#utils/common";
 
 export let loggedInUser: UserInfo | null = null;

src/plugins/api/pokerogue-account-api.ts

@@ -6,7 +6,7 @@ import type {
   AccountLoginRequest,
   AccountLoginResponse,
   AccountRegisterRequest,
-} from "#types/api/pokerogue-account-api";
+} from "#types/api";
 import { removeCookie, setCookie } from "#utils/cookies";
 
 /**

src/plugins/api/pokerogue-admin-api.ts

@@ -5,7 +5,7 @@ import type {
   PokerogueAdminApiParams,
   SearchAccountRequest,
   SearchAccountResponse,
-} from "#types/api/pokerogue-admin-api";
+} from "#types/api";
 
 export class PokerogueAdminApi extends ApiBase {
   public readonly ERR_USERNAME_NOT_FOUND: string = "Username not found!";

src/plugins/api/pokerogue-api.ts

@@ -3,7 +3,7 @@ import { PokerogueAccountApi } from "#api/pokerogue-account-api";
 import { PokerogueAdminApi } from "#api/pokerogue-admin-api";
 import { PokerogueDailyApi } from "#api/pokerogue-daily-api";
 import { PokerogueSavedataApi } from "#api/pokerogue-savedata-api";
-import type { TitleStatsResponse } from "#types/api/pokerogue-api-types";
+import type { TitleStatsResponse } from "#types/api";
 
 /**
  * A wrapper for PokéRogue API requests.

src/plugins/api/pokerogue-daily-api.ts

@@ -1,13 +1,11 @@
 import { ApiBase } from "#api/api-base";
-import type { GetDailyRankingsPageCountRequest, GetDailyRankingsRequest } from "#types/api/pokerogue-daily-api";
+import type { GetDailyRankingsPageCountRequest, GetDailyRankingsRequest } from "#types/pokerogue-daily-api";
 import type { RankingEntry } from "#ui/daily-run-scoreboard";
 
 /**
  * A wrapper for daily-run PokéRogue API requests.
  */
 export class PokerogueDailyApi extends ApiBase {
-  //#region Public
-
   /**
    * Request the daily-run seed.
    * @returns The active daily-run seed as `string`.
@@ -25,6 +23,7 @@ export class PokerogueDailyApi extends ApiBase {
   /**
    * Get the daily rankings for a {@linkcode ScoreboardCategory}.
    * @param params The {@linkcode GetDailyRankingsRequest} to send
+   * @deprecated
    */
   public async getRankings(params: GetDailyRankingsRequest) {
     try {
@@ -41,6 +40,7 @@ export class PokerogueDailyApi extends ApiBase {
   /**
    * Get the page count of the daily rankings for a {@linkcode ScoreboardCategory}.
    * @param params The {@linkcode GetDailyRankingsPageCountRequest} to send.
+   * @deprecated
    */
   public async getRankingsPageCount(params: GetDailyRankingsPageCountRequest) {
     try {

src/plugins/api/pokerogue-savedata-api.ts

@@ -2,7 +2,7 @@ import { ApiBase } from "#api/api-base";
 import { PokerogueSessionSavedataApi } from "#api/pokerogue-session-savedata-api";
 import { PokerogueSystemSavedataApi } from "#api/pokerogue-system-savedata-api";
 import { MAX_INT_ATTR_VALUE } from "#app/constants";
-import type { UpdateAllSavedataRequest } from "#types/api/pokerogue-save-data-api";
+import type { UpdateAllSavedataRequest } from "#types/api";
 
 /**
  * A wrapper for PokéRogue savedata API requests.

src/plugins/api/pokerogue-session-savedata-api.ts

@@ -6,7 +6,7 @@ import type {
   GetSessionSavedataRequest,
   NewClearSessionSavedataRequest,
   UpdateSessionSavedataRequest,
-} from "#types/api/pokerogue-session-save-data-api";
+} from "#types/api";
 import type { SessionSaveData } from "#types/save-data";
 
 /**

src/plugins/api/pokerogue-system-savedata-api.ts

@@ -4,7 +4,7 @@ import type {
   UpdateSystemSavedataRequest,
   VerifySystemSavedataRequest,
   VerifySystemSavedataResponse,
-} from "#types/api/pokerogue-system-save-data-api";
+} from "#types/api";
 
 /**
  * A wrapper for PokéRogue system savedata API requests.

src/system/version-migration/version-converter.ts

@@ -2,9 +2,7 @@
 
 import { version } from "#package.json";
 import type { SessionSaveData, SystemSaveData } from "#types/save-data";
-import type { SessionSaveMigrator } from "#types/session-save-migrator";
-import type { SettingsSaveMigrator } from "#types/settings-save-migrator";
-import type { SystemSaveMigrator } from "#types/system-save-migrator";
+import type { SessionSaveMigrator, SettingsSaveMigrator, SystemSaveMigrator } from "#types/save-migrators";
 import { compareVersions } from "compare-versions";
 
 /*

src/system/version-migration/versions/v1_0_4.ts

@@ -5,9 +5,7 @@ import { AbilityAttr } from "#enums/ability-attr";
 import { DexAttr } from "#enums/dex-attr";
 import { SettingKeys } from "#system/settings";
 import type { SessionSaveData, SystemSaveData } from "#types/save-data";
-import type { SessionSaveMigrator } from "#types/session-save-migrator";
-import type { SettingsSaveMigrator } from "#types/settings-save-migrator";
-import type { SystemSaveMigrator } from "#types/system-save-migrator";
+import type { SessionSaveMigrator, SettingsSaveMigrator, SystemSaveMigrator } from "#types/save-migrators";
 
 /**
  * Migrate ability starter data if empty for caught species.

src/system/version-migration/versions/v1_10_0.ts

@@ -3,7 +3,7 @@ import type { MoveId } from "#enums/move-id";
 import type { MoveResult } from "#enums/move-result";
 import { MoveUseMode } from "#enums/move-use-mode";
 import type { SessionSaveData } from "#types/save-data";
-import type { SessionSaveMigrator } from "#types/session-save-migrator";
+import type { SessionSaveMigrator } from "#types/save-migrators";
 import type { TurnMove } from "#types/turn-move";
 
 /** Prior signature of `TurnMove`; used to ensure parity */

src/system/version-migration/versions/v1_7_0.ts

@@ -1,8 +1,7 @@
 import { globalScene } from "#app/global-scene";
 import { DexAttr } from "#enums/dex-attr";
 import type { SessionSaveData, SystemSaveData } from "#types/save-data";
-import type { SessionSaveMigrator } from "#types/session-save-migrator";
-import type { SystemSaveMigrator } from "#types/system-save-migrator";
+import type { SessionSaveMigrator, SystemSaveMigrator } from "#types/save-migrators";
 import { getPokemonSpecies, getPokemonSpeciesForm } from "#utils/pokemon-utils";
 
 /**

src/system/version-migration/versions/v1_8_3.ts

@@ -1,7 +1,7 @@
 import { DexAttr } from "#enums/dex-attr";
 import { SpeciesId } from "#enums/species-id";
 import type { SystemSaveData } from "#types/save-data";
-import type { SystemSaveMigrator } from "#types/system-save-migrator";
+import type { SystemSaveMigrator } from "#types/save-migrators";
 import { getPokemonSpecies } from "#utils/pokemon-utils";
 
 /**

src/system/version-migration/versions/v1_9_0.ts

@@ -2,7 +2,7 @@ import { MoveId } from "#enums/move-id";
 import { PokemonMove } from "#moves/pokemon-move";
 import type { PokemonData } from "#system/pokemon-data";
 import type { SessionSaveData } from "#types/save-data";
-import type { SessionSaveMigrator } from "#types/session-save-migrator";
+import type { SessionSaveMigrator } from "#types/save-migrators";
 
 /**
  * Migrate all lingering rage fist data inside `CustomPokemonData`,

src/ui/containers/daily-run-scoreboard.ts

@@ -7,6 +7,7 @@ import { executeIf } from "#utils/common";
 import { getEnumKeys } from "#utils/enums";
 import i18next from "i18next";
 
+/** @deprecated */
 export interface RankingEntry {
   rank: number;
   username: string;
@@ -15,11 +16,13 @@ export interface RankingEntry {
 }
 
 // Don't forget to update translations when adding a new category
+/** @deprecated */
 export enum ScoreboardCategory {
   DAILY,
   WEEKLY,
 }
 
+/** @deprecated */
 export class DailyRunScoreboard extends Phaser.GameObjects.Container {
   private loadingLabel: Phaser.GameObjects.Text;
   private titleLabel: Phaser.GameObjects.Text;

src/ui/handlers/admin-ui-handler.ts

@@ -6,11 +6,7 @@ import { Button } from "#enums/buttons";
 import { TextStyle } from "#enums/text-style";
 import { UiMode } from "#enums/ui-mode";
 import { GameData } from "#system/game-data";
-import type {
-  AdminUiHandlerService,
-  AdminUiHandlerServiceMode,
-  SearchAccountResponse,
-} from "#types/api/pokerogue-admin-api";
+import type { AdminUiHandlerService, AdminUiHandlerServiceMode, SearchAccountResponse } from "#types/api";
 import type { InputFieldConfig } from "#ui/form-modal-ui-handler";
 import { FormModalUiHandler } from "#ui/form-modal-ui-handler";
 import type { ModalConfig } from "#ui/modal-ui-handler";

test/plugins/api/pokerogue-account-api.test.ts

@@ -2,7 +2,7 @@ import { PokerogueAccountApi } from "#api/pokerogue-account-api";
 import { SESSION_ID_COOKIE_NAME } from "#app/constants";
 import { initServerForApiTests } from "#test/test-utils/test-file-initialization";
 import { getApiBaseUrl } from "#test/test-utils/test-utils";
-import type { AccountInfoResponse } from "#types/api/pokerogue-account-api";
+import type { AccountInfoResponse } from "#types/api";
 import * as CookieUtils from "#utils/cookies";
 import * as cookies from "#utils/cookies";
 import { HttpResponse, http } from "msw";

test/plugins/api/pokerogue-admin-api.test.ts

@@ -1,12 +1,7 @@
 import { PokerogueAdminApi } from "#api/pokerogue-admin-api";
 import { initServerForApiTests } from "#test/test-utils/test-file-initialization";
 import { getApiBaseUrl } from "#test/test-utils/test-utils";
-import type {
-  DiscordRequest,
-  GoogleRequest,
-  SearchAccountRequest,
-  SearchAccountResponse,
-} from "#types/api/pokerogue-admin-api";
+import type { DiscordRequest, GoogleRequest, SearchAccountRequest, SearchAccountResponse } from "#types/api";
 import { HttpResponse, http } from "msw";
 import type { SetupServerApi } from "msw/node";
 import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";

test/plugins/api/pokerogue-api.test.ts

@@ -1,7 +1,7 @@
 import { pokerogueApi } from "#api/pokerogue-api";
 import { initServerForApiTests } from "#test/test-utils/test-file-initialization";
 import { getApiBaseUrl } from "#test/test-utils/test-utils";
-import type { TitleStatsResponse } from "#types/api/pokerogue-api-types";
+import type { TitleStatsResponse } from "#types/api";
 import { HttpResponse, http } from "msw";
 import type { SetupServerApi } from "msw/node";
 import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";

test/plugins/api/pokerogue-daily-api.test.ts

@@ -1,7 +1,7 @@
 import { PokerogueDailyApi } from "#api/pokerogue-daily-api";
 import { initServerForApiTests } from "#test/test-utils/test-file-initialization";
 import { getApiBaseUrl } from "#test/test-utils/test-utils";
-import type { GetDailyRankingsPageCountRequest, GetDailyRankingsRequest } from "#types/api/pokerogue-daily-api";
+import type { GetDailyRankingsPageCountRequest, GetDailyRankingsRequest } from "#types/pokerogue-daily-api";
 import { type RankingEntry, ScoreboardCategory } from "#ui/daily-run-scoreboard";
 import { HttpResponse, http } from "msw";
 import type { SetupServerApi } from "msw/node";

test/plugins/api/pokerogue-savedata-api.test.ts

@@ -1,7 +1,7 @@
 import { PokerogueSavedataApi } from "#api/pokerogue-savedata-api";
 import { initServerForApiTests } from "#test/test-utils/test-file-initialization";
 import { getApiBaseUrl } from "#test/test-utils/test-utils";
-import type { UpdateAllSavedataRequest } from "#types/api/pokerogue-save-data-api";
+import type { UpdateAllSavedataRequest } from "#types/api";
 import { HttpResponse, http } from "msw";
 import type { SetupServerApi } from "msw/node";
 import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";

test/plugins/api/pokerogue-session-savedata-api.test.ts

@@ -8,7 +8,7 @@ import type {
   GetSessionSavedataRequest,
   NewClearSessionSavedataRequest,
   UpdateSessionSavedataRequest,
-} from "#types/api/pokerogue-session-save-data-api";
+} from "#types/api";
 import type { SessionSaveData } from "#types/save-data";
 import { HttpResponse, http } from "msw";
 import type { SetupServerApi } from "msw/node";

test/plugins/api/pokerogue-system-savedata-api.test.ts

@@ -6,7 +6,7 @@ import type {
   UpdateSystemSavedataRequest,
   VerifySystemSavedataRequest,
   VerifySystemSavedataResponse,
-} from "#types/api/pokerogue-system-save-data-api";
+} from "#types/api";
 import type { SystemSaveData } from "#types/save-data";
 import { HttpResponse, http } from "msw";
 import type { SetupServerApi } from "msw/node";

tsconfig.json

@@ -61,7 +61,7 @@
         "./src/system/*.ts"
       ],
       "#trainers/*": ["./src/data/trainers/*.ts"],
-      "#types/*": ["./src/@types/helpers/*.ts", "./src/@types/*.ts", "./src/typings/phaser/*.ts"],
+      "#types/*": ["./src/@types/*.ts"],
       "#ui/*": [
         "./src/ui/battle-info/*.ts",
         "./src/ui/containers/*.ts",