zkldi_Tachi/server/src/common/database-lookup/chart.ts

import { version } from "commander";
import { Difficulties, Game, integer, Playtypes, IDStrings } from "kamaitachi-common";
import db from "../../db/db";

/**
 * Find chart with PlaytypeDifficulty. This only finds charts that have `isPrimary` set to true.
 * If you want to find charts that are not primary, you need to use PTDFVersion.
 * @see FindChartWithPTDFVersion
 */
export function FindChartWithPTDF<
    G extends Game = Game,
    P extends Playtypes[G] = Playtypes[G],
    I extends IDStrings = IDStrings
>(game: G, songID: integer, playtype: P, difficulty: Difficulties[I]) {
    return db.charts[game].findOne({
        songID: songID,
        playtype: playtype,
        difficulty: difficulty,
        isPrimary: true,
    });
}

/**
 * Find chart with Playtype, Difficulty and a given version. This does not necessarily return a chart that has
 * `isPrimary` set.
 */
export function FindChartWithPTDFVersion<
    G extends Game = Game,
    P extends Playtypes[G] = Playtypes[G],
    I extends IDStrings = IDStrings
>(game: G, songID: integer, playtype: P, difficulty: Difficulties[I], version: string) {
    return db.charts[game].findOne({
        songID: songID,
        playtype: playtype,
        difficulty: difficulty,
        versions: version,
    });
}

/**
 * Finds a DDR Chart based on its "song hash".
 * Songs in DDR have a consistent checksum-like identifier used on the e-amusement website.
 * We can use this to locate a chart by combining it with a playtype and difficulty.
 *
 * Despite the potentially confusing name of "songHash", songs are NOT meant to store lookup-like tokens.
 * This is just for simplification reasons.
 * @param songHash The identifier for the song.
 * @param playtype The playtype for the chart.
 * @param difficulty The difficulty for the chart.
 */
export function FindDDRChartOnSongHash(
    songHash: string,
    // Technically both of these should be "ddr" instead of Game, but it proves hard to work with.
    playtype: Playtypes[Game],
    difficulty: Difficulties[IDStrings]
) {
    // note: this only works on accident because monk
    // allows any strings like "foo.bar".
    // We *should* normally cast this to ChartDocument<"ddr:SP" | "ddr:DP">
    return db.charts.ddr.findOne({
        "data.songHash": songHash,
        playtype,
        difficulty,
    });
}

/**
 * Find a BMS chart on either its md5sum or its sha256sum.
 * @param hash The md5 or sha256 hash to look for.
 */
export function FindBMSChartOnHash(hash: string) {
    return db.charts.bms.findOne({
        $or: [{ "data.hashMD5": hash }, { "data.hashSHA256": hash }],
    });
}

/**
 * Find a chart on its in-game-ID, playtype and difficulty.
 */
export function FindChartOnInGameID(
    game: Game,
    inGameID: number,
    playtype: Playtypes[Game],
    difficulty: Difficulties[IDStrings]
) {
    // @todo throw an error if this is called with a game that doesn't
    // support InGameID.
    return db.charts[game].findOne({
        "data.inGameID": inGameID,
        playtype,
        difficulty,
    });
}

/**
 * Find a chart on its in-game-ID, playtype, difficulty and version.
 */
export function FindChartOnInGameIDVersion(
    game: Game,
    inGameID: number,
    playtype: Playtypes[Game],
    difficulty: Difficulties[IDStrings],
    version: string
) {
    return db.charts[game].findOne({
        "data.inGameID": inGameID,
        versions: version,
        playtype,
        difficulty,
    });
}

/**
 * Find an SDVX Chart on its in game ID. This exists to handle
 * oddities with SDVX difficulties - If "ANY_INF" is sent, it actually
 * refers to any of INF, GRV, HVN or VVD. This is because some services treat
 * all of those as the same difficulty, but we do not.
 */
export function FindSDVXChartOnInGameID(
    inGameID: number,
    playtype: Playtypes[Game],
    difficulty: "NOV" | "ADV" | "EXH" | "MXM" | "ANY_INF"
) {
    let diffQuery =
        difficulty === "ANY_INF"
            ? { $in: ["INF", "GRV", "HVN", "VVD"] as Difficulties["sdvx:Single"][] }
            : difficulty;

    return db.charts.sdvx.findOne({
        "data.inGameID": inGameID,
        playtype,
        difficulty: diffQuery,
    });
}