maidraw 0.8.7 → 0.9.0

package/dist/mai/lib/kamaiTachi/index.d.ts

@@ -1,19 +1,21 @@
 import ScoreTrackerAdapter from "..";
 import { Best50 } from "../../best50";
 export declare class KamaiTachi extends ScoreTrackerAdapter {
-    private readonly CURRENT_VERSION;
-    constructor({ baseURL, currentVersion, }?: {
+    private currentVersion;
+    private currentRegion;
+    constructor({ baseURL, version, region, }?: {
         baseURL?: string;
-        currentVersion?: KamaiTachi.EGameVersions;
+        version?: KamaiTachi.GameVersions;
+        region?: "DX" | "EX" | "CN";
     });
+    versions(): KamaiTachiBuilder;
     getPlayerPB(userId: string): Promise<Best50.KamaiTachi.IResponse<{
         charts: KamaiTachi.IChart[];
         pbs: KamaiTachi.IPb[];
         songs: KamaiTachi.ISong[];
     }> | undefined>;
     private toMaiDrawScore;
-    getPlayerBest50(userId: string, { currentVersion, omnimix, use, }?: {
-        currentVersion?: KamaiTachi.EGameVersions;
+    getPlayerBest50(userId: string, { omnimix, use, }?: {
         omnimix?: boolean;
         use?: "AP" | "FC" | "ALL";
     }): Promise<{
@@ -21,7 +23,6 @@ export declare class KamaiTachi extends ScoreTrackerAdapter {
         old: Best50.IScore[];
     } | null>;
     getPlayerInfo(userId: string, options?: {
-        currentVersion?: KamaiTachi.EGameVersions;
         omnimix?: boolean;
         use?: "AP" | "FC" | "ALL";
     }): Promise<{
@@ -38,36 +39,46 @@ export declare class KamaiTachi extends ScoreTrackerAdapter {
         remaster: Best50.IScore | null;
         utage: Best50.IScore | null;
     }>;
-    maimai(): Best50.KamaiTachi;
-    maimaiPlus(): Best50.KamaiTachi;
-    green(): Best50.KamaiTachi;
-    greenPlus(): Best50.KamaiTachi;
-    orange(): Best50.KamaiTachi;
-    orangePlus(): Best50.KamaiTachi;
-    pink(): Best50.KamaiTachi;
-    pinkPlus(): Best50.KamaiTachi;
-    murasaki(): Best50.KamaiTachi;
-    murasakiPlus(): Best50.KamaiTachi;
-    milk(): Best50.KamaiTachi;
-    milkPlus(): Best50.KamaiTachi;
-    finale(): Best50.KamaiTachi;
-    dx(): Best50.KamaiTachi;
-    dxPlus(): Best50.KamaiTachi;
-    splash(): Best50.KamaiTachi;
-    splashPlus(): Best50.KamaiTachi;
-    universe(): Best50.KamaiTachi;
-    universePlus(): Best50.KamaiTachi;
-    festival(): Best50.KamaiTachi;
-    festivalPlus(): Best50.KamaiTachi;
-    buddies(): Best50.KamaiTachi;
-    buddiesPlus(): Best50.KamaiTachi;
-    prism(): Best50.KamaiTachi;
-    prismPlus(): Best50.KamaiTachi;
     getPlayerLevel50(username: string, level: number, page: number, options?: {
         percise: boolean;
     }): Promise<Best50.IScore[] | null>;
     private levelBoundChecker;
 }
+export declare class KamaiTachiBuilder {
+    maimai(region?: "DX" | "EX"): Best50.KamaiTachi;
+    maimaiPlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    green(region?: "DX" | "EX"): Best50.KamaiTachi;
+    greenPlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    orange(region?: "DX" | "EX"): Best50.KamaiTachi;
+    orangePlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    pink(region?: "DX" | "EX"): Best50.KamaiTachi;
+    pinkPlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    murasaki(region?: "DX" | "EX"): Best50.KamaiTachi;
+    murasakiPlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    milk(region?: "DX" | "EX"): Best50.KamaiTachi;
+    milkPlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    finale(region?: "DX" | "EX"): Best50.KamaiTachi;
+    dx(region?: "DX" | "EX"): Best50.KamaiTachi;
+    dxPlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    splash(region?: "DX" | "EX"): Best50.KamaiTachi;
+    splashPlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    universe(region?: "DX" | "EX"): Best50.KamaiTachi;
+    universePlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    festival(region?: "DX" | "EX"): Best50.KamaiTachi;
+    festivalPlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    buddies(region?: "DX" | "EX"): Best50.KamaiTachi;
+    buddiesPlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    prism(region?: "DX" | "EX"): Best50.KamaiTachi;
+    prismPlus(region?: "DX" | "EX"): Best50.KamaiTachi;
+    CN(): {
+        DX(): Best50.KamaiTachi;
+        DX2021(): Best50.KamaiTachi;
+        DX2022(): Best50.KamaiTachi;
+        DX2023(): Best50.KamaiTachi;
+        DX2024(): Best50.KamaiTachi;
+        DX2025(): Best50.KamaiTachi;
+    };
+}
 export declare namespace KamaiTachi {
     interface IResponse<T> {
         success: boolean;
@@ -78,7 +89,7 @@ export declare namespace KamaiTachi {
         chartID: string;
         data: {
             inGameID: number;
-            displayVersion: EGameVersions;
+            displayVersion: KamaiGameVersions;
         };
         difficulty: string;
         isPrimary: boolean;
@@ -149,33 +160,162 @@ export declare namespace KamaiTachi {
         songID: number;
         timeAchieved: number;
     }
-    enum EGameVersions {
-        PRISM_PLUS = "maimai\u3067\u3089\u3063\u304F\u3059 PRiSM PLUS",
-        PRISM = "maimai\u3067\u3089\u3063\u304F\u3059 PRiSM",
-        BUDDIES_PLUS = "maimai\u3067\u3089\u3063\u304F\u3059 BUDDiES PLUS",
-        BUDDIES = "maimai\u3067\u3089\u3063\u304F\u3059 BUDDiES",
-        FESTIVAL_PLUS = "maimai\u3067\u3089\u3063\u304F\u3059 FESTiVAL PLUS",
-        FESTIVAL = "maimai\u3067\u3089\u3063\u304F\u3059 FESTiVAL",
-        UNIVERSE_PLUS = "maimai\u3067\u3089\u3063\u304F\u3059 UNiVERSE PLUS",
-        UNIVERSE = "maimai\u3067\u3089\u3063\u304F\u3059 UNiVERSE",
-        SPLASH_PLUS = "maimai\u3067\u3089\u3063\u304F\u3059 Splash PLUS",
-        SPLASH = "maimai\u3067\u3089\u3063\u304F\u3059 Splash",
-        DX_PLUS = "maimai\u3067\u3089\u3063\u304F\u3059 PLUS",
-        DX = "maimai\u3067\u3089\u3063\u304F\u3059",
-        FINALE = "maimai FiNALE",
-        MILK_PLUS = "maimai MiLK PLUS",
-        MILK = "maimai MiLK",
-        MURASAKI_PLUS = "maimai MURASAKi PLUS",
-        MURASAKI = "maimai MURASAKi",
-        PINK_PLUS = "maimai PiNK PLUS",
-        PINK = "maimai PiNK",
-        ORANGE_PLUS = "maimai ORANGE PLUS",
-        ORANGE = "maimai ORANGE",
-        GREEN_PLUS = "maimai GreeN PLUS",
-        GREEN = "maimai GreeN",
-        MAIMAI_PLUS = "maimai PLUS",
-        MAIMAI = "maimai"
-    }
+    const GameVersions: {
+        readonly PRISM_PLUS: {
+            readonly kamai: "maimaiでらっくす PRiSM PLUS";
+            readonly DX: "maimai でらっくす PRiSM PLUS";
+            readonly EX: "maimai DX PRiSM PLUS";
+            readonly CN: "";
+        };
+        readonly PRISM: {
+            readonly kamai: "maimaiでらっくす PRiSM";
+            readonly DX: "maimai でらっくす PRiSM";
+            readonly EX: "maimai DX PRiSM";
+            readonly CN: "舞萌DX 2025";
+        };
+        readonly BUDDIES_PLUS: {
+            readonly kamai: "maimaiでらっくす BUDDiES PLUS";
+            readonly DX: "maimai でらっくす BUDDiES PLUS";
+            readonly EX: "maimai DX BUDDiES PLUS";
+            readonly CN: "";
+        };
+        readonly BUDDIES: {
+            readonly kamai: "maimaiでらっくす BUDDiES";
+            readonly DX: "maimai でらっくす BUDDiES";
+            readonly EX: "maimai DX BUDDiES";
+            readonly CN: "舞萌DX 2024";
+        };
+        readonly FESTIVAL_PLUS: {
+            readonly kamai: "maimaiでらっくす FESTiVAL PLUS";
+            readonly DX: "maimai でらっくす FESTiVAL PLUS";
+            readonly EX: "maimai DX FESTiVAL PLUS";
+            readonly CN: "";
+        };
+        readonly FESTIVAL: {
+            readonly kamai: "maimaiでらっくす FESTiVAL";
+            readonly DX: "maimai でらっくす FESTiVAL";
+            readonly EX: "maimai DX FESTiVAL";
+            readonly CN: "舞萌DX 2023";
+        };
+        readonly UNIVERSE_PLUS: {
+            readonly kamai: "maimaiでらっくす UNiVERSE PLUS";
+            readonly DX: "maimai でらっくす UNiVERSE PLUS";
+            readonly EX: "maimai DX UNiVERSE PLUS";
+            readonly CN: "";
+        };
+        readonly UNIVERSE: {
+            readonly kamai: "maimaiでらっくす UNiVERSE";
+            readonly DX: "maimai でらっくす UNiVERSE";
+            readonly EX: "maimai DX UNiVERSE";
+            readonly CN: "舞萌DX 2022";
+        };
+        readonly SPLASH_PLUS: {
+            readonly kamai: "maimaiでらっくす Splash PLUS";
+            readonly DX: "maimai でらっくす Splash PLUS";
+            readonly EX: "maimai DX Splash PLUS";
+            readonly CN: "";
+        };
+        readonly SPLASH: {
+            readonly kamai: "maimaiでらっくす Splash";
+            readonly DX: "maimai でらっくす Splash";
+            readonly EX: "maimai DX Splash";
+            readonly CN: "舞萌DX 2021";
+        };
+        readonly DX_PLUS: {
+            readonly kamai: "maimaiでらっくす PLUS";
+            readonly DX: "maimai でらっくす PLUS";
+            readonly EX: "maimai DX PLUS";
+            readonly CN: "";
+        };
+        readonly DX: {
+            readonly kamai: "maimaiでらっくす";
+            readonly DX: "maimai でらっくす";
+            readonly EX: "maimai DX";
+            readonly CN: "舞萌DX";
+        };
+        readonly FINALE: {
+            readonly kamai: "maimai FiNALE";
+            readonly DX: "maimai FiNALE";
+            readonly EX: "maimai FiNALE";
+            readonly CN: "maimai FiNALE";
+        };
+        readonly MILK_PLUS: {
+            readonly kamai: "maimai MiLK PLUS";
+            readonly DX: "maimai MiLK PLUS";
+            readonly EX: "maimai MiLK PLUS";
+            readonly CN: "maimai MiLK PLUS";
+        };
+        readonly MILK: {
+            readonly kamai: "maimai MiLK";
+            readonly DX: "maimai MiLK";
+            readonly EX: "maimai MiLK";
+            readonly CN: "maimai MiLK";
+        };
+        readonly MURASAKI_PLUS: {
+            readonly kamai: "maimai MURASAKi PLUS";
+            readonly DX: "maimai MURASAKi PLUS";
+            readonly EX: "maimai MURASAKi PLUS";
+            readonly CN: "maimai MURASAKi PLUS";
+        };
+        readonly MURASAKI: {
+            readonly kamai: "maimai MURASAKi";
+            readonly DX: "maimai MURASAKi";
+            readonly EX: "maimai MURASAKi";
+            readonly CN: "maimai MURASAKi";
+        };
+        readonly PINK_PLUS: {
+            readonly kamai: "maimai PiNK PLUS";
+            readonly DX: "maimai PiNK PLUS";
+            readonly EX: "maimai PiNK PLUS";
+            readonly CN: "maimai PiNK PLUS";
+        };
+        readonly PINK: {
+            readonly kamai: "maimai PiNK";
+            readonly DX: "maimai PiNK";
+            readonly EX: "maimai PiNK";
+            readonly CN: "maimai PiNK";
+        };
+        readonly ORANGE_PLUS: {
+            readonly kamai: "maimai ORANGE PLUS";
+            readonly DX: "maimai ORANGE PLUS";
+            readonly EX: "maimai ORANGE PLUS";
+            readonly CN: "maimai ORANGE PLUS";
+        };
+        readonly ORANGE: {
+            readonly kamai: "maimai ORANGE";
+            readonly DX: "maimai ORANGE";
+            readonly EX: "maimai ORANGE";
+            readonly CN: "maimai ORANGE";
+        };
+        readonly GREEN_PLUS: {
+            readonly kamai: "maimai GreeN PLUS";
+            readonly DX: "maimai GreeN PLUS";
+            readonly EX: "maimai GreeN PLUS";
+            readonly CN: "maimai GreeN PLUS";
+        };
+        readonly GREEN: {
+            readonly kamai: "maimai GreeN";
+            readonly DX: "maimai GreeN";
+            readonly EX: "maimai GreeN";
+            readonly CN: "maimai GreeN";
+        };
+        readonly MAIMAI_PLUS: {
+            readonly kamai: "maimai PLUS";
+            readonly DX: "maimai PLUS";
+            readonly EX: "maimai PLUS";
+            readonly CN: "maimai PLUS";
+        };
+        readonly MAIMAI: {
+            readonly kamai: "maimai";
+            readonly DX: "maimai";
+            readonly EX: "maimai";
+            readonly CN: "maimai";
+        };
+    };
+    type GameVersions = (typeof GameVersions)[keyof typeof GameVersions];
+    type KamaiGameVersions = (typeof GameVersions)[keyof typeof GameVersions]["kamai"];
+    type AllGameVersions = GameVersions;
+    function getGameVersion(payload: string): AllGameVersions | null;
     /**
      * Compare two game versions and calculate which is newer.
      *
@@ -183,5 +323,5 @@ export declare namespace KamaiTachi {
      * @param b Game version.
      * @returns positive if a is newer, negative if b is newer, 0 if they are the same.
      */
-    function compareGameVersions(a: EGameVersions, b: EGameVersions): number;
+    function compareGameVersions(a: AllGameVersions | null, b: AllGameVersions | null): number;
 }