maidraw 0.7.0 → 0.7.1

package/dist/mai/best50/index.d.ts

@@ -1,10 +1,234 @@
-import { IScore } from "../type";
-import ScoreTrackerAdapter from "./lib";
-import * as lxns from "./lib/lxns";
-import * as kamaiTachi from "./lib/kamaiTachi";
-import * as divingFish from "./lib/divingFish";
+import ScoreTrackerAdapter from "../lib";
+import * as lxns from "../lib/lxns";
+import * as kamaiTachi from "../lib/kamaiTachi";
+import * as divingFish from "../lib/divingFish";
+import { EDifficulty } from "../type";
 export declare class Best50 {
-    static readonly RATING_CONSTANTS: {
+    private static readonly DEFAULT_THEME;
+    private static get assetsPath();
+    private static themes;
+    static hasTheme(name: string): boolean;
+    private static validateManifest;
+    private static primaryTheme;
+    static loadTheme(path: string): boolean;
+    private static getTheme;
+    private static getThemeFile;
+    private static drawImageModule;
+    private static drawScoreGridModule;
+    private static drawProfileModule;
+    private static drawTextModule;
+    static draw(name: string, rating: number, newScores: Best50.IScore[], oldScores: Best50.IScore[], options?: {
+        scale?: number;
+        theme?: string;
+        profilePicture?: Buffer;
+    }): Promise<Buffer | null>;
+    static drawWithScoreSource(source: ScoreTrackerAdapter, username: string, options?: {
+        scale?: number;
+        theme?: string;
+        profilePicture?: Buffer | null;
+    }): Promise<Buffer | null>;
+    private static getRatingNumber;
+}
+export declare namespace Best50 {
+    export import LXNS = lxns.LXNS;
+    export import KamaiTachi = kamaiTachi.KamaiTachi;
+    export import DivingFish = divingFish.DivingFish;
+    interface IThemeManifest {
+        displayName: string;
+        name: string;
+        width: number;
+        height: number;
+        sprites: IThemeSprites;
+        elements: IThemeElements[];
+    }
+    interface IThemeSprites {
+        achievement: {
+            d: string;
+            c: string;
+            b: string;
+            bb: string;
+            bbb: string;
+            a: string;
+            aa: string;
+            aaa: string;
+            s: string;
+            sp: string;
+            ss: string;
+            ssp: string;
+            sss: string;
+            sssp: string;
+        };
+        mode: {
+            standard: string;
+            dx: string;
+        };
+        milestone: {
+            ap: string;
+            app: string;
+            fc: string;
+            fcp: string;
+            fdx: string;
+            fdxp: string;
+            fs: string;
+            fsp: string;
+            sync: string;
+            none: string;
+        };
+        dxRating: {
+            white: string;
+            blue: string;
+            green: string;
+            yellow: string;
+            red: string;
+            purple: string;
+            bronze: string;
+            silver: string;
+            gold: string;
+            platinum: string;
+            rainbow: string;
+        };
+        dxRatingNumberMap: string;
+        profile: {
+            icon: string;
+            nameplate: string;
+        };
+    }
+    type IThemeElements = IThemeProfileElement | IThemeScoreElement | IThemeImageElement | IThemeTextElement;
+    interface IThemeElement {
+        type: string;
+        x: number;
+        y: number;
+    }
+    interface IThemeProfileElement extends IThemeElement {
+        type: "profile";
+        height: number;
+    }
+    interface IThemeScoreElement extends IThemeElement {
+        type: "score-grid";
+        horizontalSize: number;
+        verticalSize: number;
+        region: "new" | "old";
+        index: number;
+        scoreBubble: {
+            width: number;
+            height: number;
+            margin: number;
+            gap: number;
+            color: {
+                basic: string;
+                advanced: string;
+                expert: string;
+                master: string;
+                remaster: string;
+                utage: string;
+            };
+        };
+    }
+    interface IThemeImageElement extends IThemeElement {
+        type: "image";
+        width: number;
+        height: number;
+        /**
+         * Relative path from the manifest file to the element file.
+         */
+        path: string;
+    }
+    interface IThemeTextElement extends IThemeElement {
+        type: "text";
+        size: number;
+        content: string;
+        /**
+         * If width is provied and the text is too long, it will be cut off.
+         */
+        width?: number;
+        /**
+         * If height is provied and the text is too big, it will be cut off.
+         */
+        height?: number;
+        /**
+         * If true, instead of cutting off the text, it will change to a new line.
+         * Height restrictions will still apply.
+         */
+        linebreak?: boolean;
+        /**
+         * Text alignment.
+         * Defaults to left.
+         */
+        align?: "left" | "center" | "right";
+        /**
+         * Text color.
+         * Defaults to white (#FFFFFF).
+         */
+        color?: string;
+        /**
+         * Text border color.
+         * Defaults a darker variant of `color`.
+         */
+        borderColor?: string;
+        /**
+         * Text font. Please make sure the font is available in the environment.
+         * Defaults to a preconfigured font macro. Check source code for more info.
+         */
+        font?: string;
+    }
+    interface IBest50 {
+        new: IScore[];
+        old: IScore[];
+        username: string;
+        rating: number;
+    }
+    enum EComboTypes {
+        NONE = 0,
+        FULL_COMBO = 1,
+        FULL_COMBO_PLUS = 2,
+        ALL_PERFECT = 3,
+        ALL_PERFECT_PLUS = 4
+    }
+    enum ESyncTypes {
+        NONE = 0,
+        SYNC_PLAY = 1,
+        FULL_SYNC = 2,
+        FULL_SYNC_PLUS = 3,
+        FULL_SYNC_DX = 4,
+        FULL_SYNC_DX_PLUS = 5
+    }
+    enum EAchievementTypes {
+        D = 0,
+        C = 1,
+        B = 2,
+        BB = 3,
+        BBB = 4,
+        A = 5,
+        AA = 6,
+        AAA = 7,
+        S = 8,
+        SP = 9,
+        SS = 10,
+        SSP = 11,
+        SSS = 12,
+        SSSP = 13
+    }
+    interface IScore {
+        chart: IChart;
+        combo: EComboTypes;
+        sync: ESyncTypes;
+        achievement: number;
+        achievementRank: EAchievementTypes;
+        dxRating: number;
+        dxScore: number;
+    }
+    interface IChart {
+        id: number;
+        name: string;
+        difficulty: EDifficulty;
+        /**
+         * Chart internal level.
+         * `7.0, 11.2, 11.7, 13.2, 14.8, 15.0`
+         */
+        level: number;
+        maxDxScore: number;
+    }
+    const RATING_CONSTANTS: {
         0: {
             0.4: number;
             0.3: number;
@@ -26,7 +250,7 @@ export declare class Best50 {
         12: number;
         13: number;
     };
-    static readonly RANK_BORDERS: {
+    const RANK_BORDERS: {
         0: number[];
         1: number;
         2: number;
@@ -42,35 +266,4 @@ export declare class Best50 {
         12: number;
         13: number;
     };
-    private static readonly DEFAULT_THEME;
-    private static get assetsPath();
-    private static themes;
-    static hasTheme(name: string): boolean;
-    private static validateManifest;
-    private static primaryTheme;
-    static loadTheme(path: string): boolean;
-    private static getTheme;
-    private static getThemeFile;
-    private static findMaxFitString;
-    private static drawText;
-    private static drawImageModule;
-    private static drawScoreGridModule;
-    private static drawProfileModule;
-    private static drawTextModule;
-    static draw(name: string, rating: number, newScores: IScore[], oldScores: IScore[], options?: {
-        scale?: number;
-        theme?: string;
-        profilePicture?: Buffer;
-    }): Promise<Buffer | null>;
-    static drawWithScoreSource(source: ScoreTrackerAdapter, username: string, options?: {
-        scale?: number;
-        theme?: string;
-        profilePicture?: Buffer | null;
-    }): Promise<Buffer | null>;
-    private static getRatingNumber;
-}
-export declare namespace Best50 {
-    export import LXNS = lxns.LXNS;
-    export import KamaiTachi = kamaiTachi.KamaiTachi;
-    export import DivingFish = divingFish.DivingFish;
 }