maidraw 0.6.4 → 0.7.1

package/dist/mai/chart/database.d.ts

@@ -1,4 +1,4 @@
-import { EDifficulty, IChart } from "../type";
+import { EDifficulty } from "../type";
 export declare class Database {
     private static localDatabasePath;
     static setLocalDatabasePath(path: string): void;
@@ -7,5 +7,115 @@ export declare class Database {
     static cacheJackets(ids: number[]): Promise<void>;
     static fecthJacket(id: number): Promise<Buffer | null>;
     static downloadJacket(id: number): Promise<Buffer | null>;
-    static getLocalChart(id: number, difficulty: EDifficulty): IChart | null;
+    static getLocalChart(id: number, difficulty: EDifficulty): Database.IChart | null;
+}
+export declare namespace Database {
+    interface IChart {
+        /**
+         * Unique Chart ID, i.e. a 6 digit number-like string.
+         * @example "001451" for Transcended Light standard. (Does not actually exist)
+         * @example "011451" for Transcended Light DX.
+         * @example "011804" for How To Make 音ゲ～曲！DX.
+         */
+        id: number;
+        /**
+         * Name of the song.
+         */
+        name: string;
+        /**
+         * Name of the artist.
+         */
+        artist: string;
+        /**
+         * BPM of the song.
+         */
+        bpm: number;
+        /**
+         * Difficulty category of the chart.
+         */
+        difficulty: EDifficulty;
+        /**
+         * Internal level of the chart as found in the latest version available.
+         */
+        level: number;
+        addVersion: {
+            DX?: IVersion;
+            EX?: IVersion;
+            CN?: IVersion;
+        };
+        /**
+         * Metadata of the chart.
+         */
+        meta: {
+            /**
+             * Note count of the chart.
+             */
+            notes: {
+                tap: number;
+                hold: number;
+                slide: number;
+                touch: number;
+                break: number;
+            };
+            maxDXScore: number;
+        };
+        /**
+         * Events that happened to the chart in versions.
+         */
+        events: Events[];
+        designer: {
+            id: number;
+            name: string;
+        };
+    }
+    namespace Events {
+        interface Base {
+            type: string;
+            data?: any;
+            version: IEventVersion;
+        }
+        export interface Existence extends Base {
+            type: "existence";
+            data: {
+                level: number;
+            };
+        }
+        export interface Absence extends Base {
+            type: "absence";
+        }
+        export interface Removal extends Base {
+            type: "removal";
+        }
+        export {};
+    }
+    type Events = Events.Existence | Events.Absence | Events.Removal;
+    interface IVersion {
+        /**
+         * Full name of the version.
+         * @example "maimai でらっくす PRiSM PLUS"
+         */
+        name: string;
+        /**
+         * Version number as it is used internally.
+         * Formatted as `{major}.{minor}.{patch}`.
+         *
+         * @example "1.55.0" for "1.55"
+         * @example "1.41.7" for "1.41-G"
+         */
+        gameVersion: {
+            isDX: boolean;
+            major: number;
+            minor: number;
+            release?: number;
+        };
+    }
+    interface IEventVersion extends IVersion {
+        gameVersion: {
+            isDX: boolean;
+            major: number;
+            minor: number;
+            release: number;
+        };
+        region: "DX" | "EX" | "CN";
+    }
 }

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

@@ -1,4 +1,228 @@
 import * as database from "./database";
+import ScoreTrackerAdapter from "../lib";
+import { Best50 } from "../best50";
+export declare class Chart {
+    private static readonly DEFAULT_THEME;
+    private static primaryTheme;
+    private static get assetsPath();
+    private static themes;
+    static hasTheme(name: string): boolean;
+    private static validateManifest;
+    static loadTheme(path: string): boolean;
+    private static getTheme;
+    private static getThemeFile;
+    private static drawImageModule;
+    private static drawChartGridCard;
+    private static drawDetailInfoModule;
+    private static drawChartGridModule;
+    private static drawProfileModule;
+    private static drawTextModule;
+    static draw(name: string, rating: number, chartId: number, scores: (Best50.IScore | null)[], options?: {
+        scale?: number;
+        theme?: string;
+        profilePicture?: Buffer;
+    }): Promise<Buffer | null>;
+    static drawWithScoreSource(source: ScoreTrackerAdapter, username: string, chartId: number, options?: {
+        scale?: number;
+        theme?: string;
+        profilePicture?: Buffer | null;
+    }): Promise<Buffer | null>;
+    private static getRatingNumber;
+}
 export declare namespace Chart {
     export import Database = database.Database;
+    interface ITheme {
+        manifest: IThemeManifest;
+        path: string;
+    }
+    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;
+        };
+        versions: {
+            OLD: {
+                0: string;
+                10: string;
+                20: string;
+                30: string;
+                40: string;
+                50: string;
+                60: string;
+                70: string;
+                80: string;
+                85: string;
+                90: string;
+                95: string;
+                99: string;
+            };
+            DX: {
+                0: string;
+                5: string;
+                10: string;
+                15: string;
+                20: string;
+                25: string;
+                30: string;
+                35: string;
+                40: string;
+                45: string;
+                50: string;
+                55: string;
+            };
+            EX: {
+                10: string;
+                15: string;
+            };
+            CN: {
+                0: string;
+                10: string;
+                20: string;
+                30: string;
+                40: string;
+            };
+        };
+    }
+    type IThemeElements = IThemeProfileElement | IThemeChartGridElement | IThemeImageElement | IThemeTextElement | IThemeDetailInfoElement;
+    interface IThemeElement {
+        type: string;
+        x: number;
+        y: number;
+    }
+    interface IThemeProfileElement extends IThemeElement {
+        type: "profile";
+        height: number;
+    }
+    interface IThemeChartGridElement extends IThemeElement {
+        type: "chart-grid";
+        width: number;
+        height: number;
+        margin: number;
+        gap: number;
+        bubble: {
+            margin: number;
+            color: {
+                basic: string;
+                advanced: string;
+                expert: string;
+                master: string;
+                remaster: string;
+                utage: string;
+            };
+        };
+        color: {
+            card: string;
+        };
+    }
+    interface IThemeDetailInfoElement extends IThemeElement {
+        type: "detail-info";
+        width: number;
+        height: number;
+        margin: number;
+        color: {
+            card: string;
+        };
+        font?: 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;
+    }
 }