@rian8337/osu-base 2.0.0-alpha.7 → 2.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rian8337/osu-base",
-  "version": "2.0.0-alpha.7",
+  "version": "2.0.1",
   "description": "Base module for all osu! related modules.",
   "keywords": [
     "osu",
@@ -19,7 +19,7 @@
   "scripts": {
     "build": "rollup -c ../../rollup.config.js",
     "lint": "eslint --ext ts",
-    "prepublishOnly": "npm run build",
+    "prepare": "npm run build",
     "test": "jest -i"
   },
   "repository": {
@@ -41,5 +41,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "cea730e1d7922e2ec6c1553e9f16f034f7af8e61"
+  "gitHead": "e48b38c17a7fd73c2cf286c5824b689697e61284"
 }

package/typings/index.d.ts

@@ -317,7 +317,7 @@ declare class MapStats {
          */
         speedMultiplier?: number;
         /**
-         * Whether or not force AR is turned on.
+         * Whether force AR is turned on.
          */
         isForceAR?: boolean;
     }): MapStats;
@@ -907,6 +907,8 @@ declare abstract class ControlPointManager<T extends ControlPoint> {
     /**
      * Removes a control point.
      *
+     * This method will remove the earliest control point in the array that is equal to the given control point.
+     *
      * @param controlPoint The control point to remove.
      * @returns Whether the control point was removed.
      */
@@ -1621,17 +1623,24 @@ declare abstract class Encoder<T, E extends BaseEncoder> {
      * The result of the encoding process.
      */
     protected finalResult: string;
+    /**
+     * The result of the encoding process.
+     */
+    get result(): string;
     /**
      * Available per-section encoders.
      */
     protected abstract encoders: E[];
+    /**
+     * @param target The target of the encoding process.
+     */
     constructor(target: T);
     /**
      * Performs the decoding process.
      *
      * Keep in mind that this will not produce the exact same file as the original decoded file.
      */
-    encode(): string;
+    encode(): this;
     /**
      * Writes a line to encoded text.
      *
@@ -2117,21 +2126,24 @@ declare abstract class HitWindow {
      */
     constructor(overallDifficulty: number);
     /**
-     * Gets the threshold for 300 (great) hit result.
+     * Gets the hit window for 300 (great) hit result.
      *
-     * @param isPrecise Whether or not to calculate for Precise mod. This is only available for `DroidHitWindow`.
+     * @param isPrecise Whether to calculate for Precise mod.
+     * @returns The hit window in milliseconds.
      */
     abstract hitWindowFor300(isPrecise?: boolean): number;
     /**
-     * Gets the threshold for 100 (good) hit result.
+     * Gets the hit window for 100 (good) hit result.
      *
-     * @param isPrecise Whether or not to calculate for Precise mod. This is only available for `DroidHitWindow`.
+     * @param isPrecise Whether to calculate for Precise mod.
+     * @returns The hit window in milliseconds.
      */
     abstract hitWindowFor100(isPrecise?: boolean): number;
     /**
-     * Gets the threshold for 50 (meh) hit result.
+     * Gets the hit window for 50 (meh) hit result.
      *
-     * @param isPrecise Whether or not to calculate for Precise mod. This is only available for `DroidHitWindow`.
+     * @param isPrecise Whether to calculate for Precise mod.
+     * @returns The hit window in milliseconds.
      */
     abstract hitWindowFor50(isPrecise?: boolean): number;
 }
@@ -2139,6 +2151,30 @@ declare abstract class HitWindow {
  * Represents the hit window of osu!droid.
  */
 declare class DroidHitWindow extends HitWindow {
+    /**
+     * Calculates the overall difficulty value of a great hit window.
+     *
+     * @param value The value of the hit window, in milliseconds.
+     * @param isPrecise Whether to calculate for Precise mod.
+     * @returns The overall difficulty value.
+     */
+    static hitWindow300ToOD(value: number, isPrecise?: boolean): number;
+    /**
+     * Calculates the overall difficulty value of a good hit window.
+     *
+     * @param value The value of the hit window, in milliseconds.
+     * @param isPrecise Whether to calculate for Precise mod.
+     * @returns The overall difficulty value.
+     */
+    static hitWindow100ToOD(value: number, isPrecise?: boolean): number;
+    /**
+     * Calculates the overall difficulty value of a meh hit window.
+     *
+     * @param value The value of the hit window, in milliseconds.
+     * @param isPrecise Whether to calculate for Precise mod.
+     * @returns The overall difficulty value.
+     */
+    static hitWindow50ToOD(value: number, isPrecise?: boolean): number;
     hitWindowFor300(isPrecise?: boolean): number;
     hitWindowFor100(isPrecise?: boolean): number;
     hitWindowFor50(isPrecise?: boolean): number;
@@ -2147,6 +2183,27 @@ declare class DroidHitWindow extends HitWindow {
  * Represents the hit window of osu!standard.
  */
 declare class OsuHitWindow extends HitWindow {
+    /**
+     * Calculates the overall difficulty value of a great hit window.
+     *
+     * @param value The value of the hit window, in milliseconds.
+     * @returns The overall difficulty value.
+     */
+    static hitWindow300ToOD(value: number): number;
+    /**
+     * Calculates the overall difficulty value of a good hit window.
+     *
+     * @param value The value of the hit window, in milliseconds.
+     * @returns The overall difficulty value.
+     */
+    static hitWindow100ToOD(value: number): number;
+    /**
+     * Calculates the overall difficulty value of a meh hit window.
+     *
+     * @param value The value of the hit window, in milliseconds.
+     * @returns The overall difficulty value.
+     */
+    static hitWindow50ToOD(value: number): number;
     hitWindowFor300(): number;
     hitWindowFor100(): number;
     hitWindowFor50(): number;
@@ -2163,6 +2220,11 @@ declare enum HitSoundType {
     clap = 8
 }
 
+/**
+ * Quick and simple if statement for type checking.
+ */
+declare type If<T extends boolean, A, B = null> = T extends true ? A : T extends false ? B : A | B;
+
 declare abstract class Interpolation {
     static lerp(start: number, final: number, amount: number): number;
 }
@@ -2225,7 +2287,7 @@ interface OsuAPIResponse {
 /**
  * Represents a beatmap with general information.
  */
-declare class MapInfo {
+declare class MapInfo<HasBeatmap extends boolean = boolean> {
     /**
      * The title of the song of the beatmap.
      */
@@ -2355,41 +2417,60 @@ declare class MapInfo {
      */
     videoAvailable: boolean;
     /**
-     * The parsed beatmap from beatmap parser.
+     * The decoded beatmap from beatmap decoder.
      */
-    get map(): Beatmap | undefined;
-    private cachedBeatmap?;
+    get beatmap(): If<HasBeatmap, Beatmap>;
+    private cachedBeatmap;
     /**
      * Retrieve a beatmap's general information.
      *
-     * Either beatmap ID or MD5 hash of the beatmap must be specified. If both are specified, beatmap ID is taken.
+     * @param beatmapId The ID of the beatmap.
+     * @param downloadBeatmap Whether to also retrieve the .osu file of the beatmap. Defaults to `true`.
+     * @returns The beatmap, `null` if the beatmap is not found or the beatmap is not an osu!standard beatmap.
      */
-    static getInformation(params: {
-        /**
-         * The ID of the beatmap.
-         */
-        beatmapID?: number;
-        /**
-         * The MD5 hash of the beatmap.
-         */
-        hash?: string;
-        /**
-         * Whether or not to also retrieve the .osu file of the beatmap (required for some utilities). Defaults to `true`.
-         */
-        file?: boolean;
-    }): Promise<MapInfo>;
+    static getInformation(beatmapId: number, downloadBeatmap?: boolean): Promise<MapInfo<true> | null>;
+    /**
+     * Retrieve a beatmap's general information.
+     *
+     * @param beatmapId The ID of the beatmap.
+     * @param downloadBeatmap Whether to also retrieve the .osu file of the beatmap. Defaults to `true`.
+     * @returns The beatmap, `null` if the beatmap is not found or the beatmap is not an osu!standard beatmap.
+     */
+    static getInformation(beatmapId: number, downloadBeatmap: false): Promise<MapInfo<false> | null>;
+    /**
+     * Retrieve a beatmap's general information.
+     *
+     * @param hash The MD5 hash of the beatmap.
+     * @param downloadBeatmap Whether to also retrieve the .osu file of the beatmap. Defaults to `true`.
+     * @returns The beatmap, `null` if the beatmap is not found or the beatmap is not an osu!standard beatmap.
+     */
+    static getInformation(hash: string, downloadBeatmap?: boolean): Promise<MapInfo<true> | null>;
+    /**
+     * Retrieve a beatmap's general information.
+     *
+     * @param hash The MD5 hash of the beatmap.
+     * @param downloadBeatmap Whether to also retrieve the .osu file of the beatmap. Defaults to `true`.
+     * @returns The beatmap, `null` if the beatmap is not found or the beatmap is not an osu!standard beatmap.
+     */
+    static getInformation(hash: string, downloadBeatmap: false): Promise<MapInfo<false> | null>;
     /**
      * Fills the current instance with map data.
      *
      * @param mapinfo The map data.
      */
     fillMetadata(mapinfo: OsuAPIResponse): MapInfo;
+    /**
+     * Checks whether the beatmap file has been downloaded.
+     */
+    hasDownloadedBeatmap(): this is MapInfo<true>;
     /**
      * Retrieves the .osu file of the beatmap.
      *
-     * @param forceDownload Whether or not to download the file regardless if it's already available.
+     * After this, you can use the `hasDownloadedBeatmap` method to check if the beatmap has been downloaded.
+     *
+     * @param force Whether to download the file regardless if it's already available.
      */
-    retrieveBeatmapFile(forceDownload?: boolean): Promise<MapInfo>;
+    retrieveBeatmapFile(force?: boolean): Promise<void>;
     /**
      * Converts the beatmap's BPM if speed-changing mods are applied.
      */
@@ -2411,10 +2492,12 @@ declare class MapInfo {
      *
      * - Option `0`: return map title and mods used if defined
      * - Option `1`: return song source and map download link to beatmap mirrors
-     * - Option `2`: return CS, AR, OD, HP
-     * - Option `3`: return BPM, map length, max combo
-     * - Option `4`: return last update date and map status
-     * - Option `5`: return favorite count and play count
+     * - Option `2`: return circle, slider, and spinner count
+     * - Option `3`: return CS, AR, OD, HP, and max score statistics for droid
+     * - Option `4`: return CS, AR, OD, HP, and max score statistics for PC
+     * - Option `5`: return BPM, map length, and max combo
+     * - Option `6`: return last update date and map status
+     * - Option `7`: return favorite count and play count
      *
      * @param option The option to pick.
      * @param stats The custom statistics to apply. This will only be used to apply mods, custom speed multiplier, and force AR.
@@ -2575,6 +2658,8 @@ declare class ModHardRock extends Mod {
  * Represents the Hidden mod.
  */
 declare class ModHidden extends Mod {
+    static readonly fadeInDurationMultiplier: number;
+    static readonly fadeOutDurationMultiplier: number;
     readonly scoreMultiplier: number;
     readonly acronym: string;
     readonly name: string;
@@ -2739,6 +2824,19 @@ declare class ModTouchDevice extends Mod {
     readonly droidOnly: boolean;
 }
 
+/**
+ * Options for parsing mods.
+ */
+interface ModParseOptions {
+    /**
+     * Whether to check for duplicate mods. Defaults to `true`.
+     */
+    checkDuplicate?: boolean;
+    /**
+     * Whether to check for incompatible mods. Defaults to `true`.
+     */
+    checkIncompatible?: boolean;
+}
 /**
  * Utilities for mods.
  */
@@ -2763,26 +2861,46 @@ declare abstract class ModUtil {
      * Gets a list of mods from a droid mod string, such as "hd".
      *
      * @param str The string.
+     * @param options Options for parsing behavior.
      */
-    static droidStringToMods(str: string): Mod[];
+    static droidStringToMods(str: string, options?: ModParseOptions): Mod[];
     /**
      * Gets a list of mods from a PC modbits.
      *
      * @param modbits The modbits.
+     * @param options Options for parsing behavior.
      */
-    static pcModbitsToMods(modbits: number): Mod[];
+    static pcModbitsToMods(modbits: number, options?: ModParseOptions): Mod[];
     /**
      * Gets a list of mods from a PC mod string, such as "HDHR".
      *
      * @param str The string.
+     * @param options Options for parsing behavior.
      */
-    static pcStringToMods(str: string): Mod[];
+    static pcStringToMods(str: string, options?: ModParseOptions): Mod[];
     /**
-     * Checks for mods that are duplicate and incompatible with each other.
+     * Checks for mods that are duplicated.
      *
      * @param mods The mods to check for.
+     * @returns Mods that have been filtered.
+     */
+    static checkDuplicateMods(mods: Mod[]): Mod[];
+    /**
+     * Checks for mods that are incompatible with each other.
+     *
+     * This will modify the original array.
+     *
+     * @param mods The mods to check for.
+     */
+    static checkIncompatibleMods(mods: Mod[]): void;
+    /**
+     * Processes parsing options.
+     *
+     * @param mods The mods to process.
+     * @param options The options to process.
+     * @returns The processed mods.
      */
-    private static checkDuplicateMods;
+    private static processParsingOptions;
 }
 
 /**
@@ -3336,4 +3454,4 @@ declare abstract class Utils {
     static sleep(duration: number): Promise<void>;
 }
 
-export { Accuracy, Anchor, AnimationLoopType, Beatmap, BeatmapBackground, BeatmapColor, BeatmapControlPoints, BeatmapCountdown, BeatmapDecoder, BeatmapDifficulty, BeatmapEditor, BeatmapEncoder, BeatmapEvents, BeatmapGeneral, BeatmapHitObjects, BeatmapMetadata, BeatmapOverlayPosition, BeatmapVideo, BlendingEquation, BlendingParameters, BlendingType, BreakPoint, Circle, Command, CommandLoop, CommandTimeline, CommandTimelineGroup, CommandTimelineSelector, CommandTrigger, ControlPointManager, DifficultyControlPoint, DroidAPIRequestBuilder, DroidHitWindow, Easing, EditorGridSize, EffectControlPoint, GameMode, HitObject, HitSampleInfo, HitSoundType, ICommandTimeline, Interpolation, MapInfo, MapStats, MathUtils, Mod, ModAuto, ModAutopilot, ModDoubleTime, ModEasy, ModFlashlight, ModHalfTime, ModHardRock, ModHidden, ModNightCore, ModNoFail, ModPerfect, ModPrecise, ModReallyEasy, ModRelax, ModScoreV2, ModSmallCircle, ModSpunOut, ModSuddenDeath, ModTouchDevice, ModUtil, OsuAPIRequestBuilder, OsuAPIResponse, OsuHitWindow, PathApproximator, PathType, Precision, RGBColor, RequestResponse, SampleBank, SampleBankInfo, SampleControlPoint, Slider, SliderHead, SliderPath, SliderRepeat, SliderTail, SliderTick, Spinner, Storyboard, StoryboardAnimation, StoryboardCommandType, StoryboardDecoder, StoryboardElement, StoryboardEncoder, StoryboardEventType, StoryboardLayer, StoryboardLayerType, StoryboardParameterCommandType, StoryboardSample, StoryboardSprite, TimingControlPoint, Utils, Vector2, modes, objectTypes, rankedStatus };
+export { Accuracy, Anchor, AnimationLoopType, Beatmap, BeatmapBackground, BeatmapColor, BeatmapControlPoints, BeatmapCountdown, BeatmapDecoder, BeatmapDifficulty, BeatmapEditor, BeatmapEncoder, BeatmapEvents, BeatmapGeneral, BeatmapHitObjects, BeatmapMetadata, BeatmapOverlayPosition, BeatmapVideo, BlendingEquation, BlendingParameters, BlendingType, BreakPoint, Circle, Command, CommandLoop, CommandTimeline, CommandTimelineGroup, CommandTimelineSelector, CommandTrigger, ControlPointManager, DifficultyControlPoint, DifficultyControlPointManager, DroidAPIRequestBuilder, DroidHitWindow, Easing, EditorGridSize, EffectControlPoint, EffectControlPointManager, GameMode, HitObject, HitSampleInfo, HitSoundType, ICommandTimeline, If, Interpolation, MapInfo, MapStats, MathUtils, Mod, ModAuto, ModAutopilot, ModDoubleTime, ModEasy, ModFlashlight, ModHalfTime, ModHardRock, ModHidden, ModNightCore, ModNoFail, ModParseOptions, ModPerfect, ModPrecise, ModReallyEasy, ModRelax, ModScoreV2, ModSmallCircle, ModSpunOut, ModSuddenDeath, ModTouchDevice, ModUtil, OsuAPIRequestBuilder, OsuAPIResponse, OsuHitWindow, PathApproximator, PathType, Precision, RGBColor, RequestResponse, SampleBank, SampleBankInfo, SampleControlPoint, SampleControlPointManager, Slider, SliderHead, SliderPath, SliderRepeat, SliderTail, SliderTick, Spinner, Storyboard, StoryboardAnimation, StoryboardCommandType, StoryboardDecoder, StoryboardElement, StoryboardEncoder, StoryboardEventType, StoryboardLayer, StoryboardLayerType, StoryboardParameterCommandType, StoryboardSample, StoryboardSprite, TimingControlPoint, TimingControlPointManager, Utils, Vector2, modes, objectTypes, rankedStatus };