@rian8337/osu-base 2.0.0 → 2.1.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rian8337/osu-base",
-  "version": "2.0.0",
+  "version": "2.1.0-beta.1",
   "description": "Base module for all osu! related modules.",
   "keywords": [
     "osu",
@@ -41,5 +41,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "589b9b5c17d9e777e389f089ae37dd2f6951d8e2"
+  "gitHead": "a77da594bc83bb980cafe23e24a18791fcd13f99"
 }

package/typings/index.d.ts

@@ -87,9 +87,9 @@ interface RequestResponse {
      */
     readonly statusCode: number;
 }
-declare type DroidAPIEndpoint = "banscore.php" | "getuserinfo.php" | "scoresearch.php" | "scoresearchv2.php" | "rename.php" | "upload" | "user_list.php" | "usergeneral.php" | "top.php" | "time.php";
+declare type DroidAPIEndpoint = "banscore.php" | "getuserinfo.php" | "scoresearch.php" | "scoresearchv2.php" | "rename.php" | "upload" | "user_list.php" | "usergeneral.php" | "top.php" | "time.php" | "account_ban_get.php" | "account_ban_set.php" | "account_restricted_get.php" | "account_restricted_set.php" | "single_score_wipe.php" | "user_wipe.php" | "user_rename.php";
 declare type OsuAPIEndpoint = "get_beatmaps" | "get_user" | "get_scores" | "get_user_best" | "get_user_recent" | "get_match" | "get_replay";
-declare abstract class APIRequestBuilder {
+declare abstract class APIRequestBuilder<APIParams extends DroidAPIEndpoint | OsuAPIEndpoint> {
     /**
      * The main point of API host.
      */
@@ -120,7 +120,7 @@ declare abstract class APIRequestBuilder {
      *
      * @param endpoint The endpoint to set.
      */
-    abstract setEndpoint(endpoint: DroidAPIEndpoint | OsuAPIEndpoint): this;
+    setEndpoint(endpoint: APIParams): this;
     /**
      * Sets if this builder includes the API key in the request URL.
      *
@@ -154,7 +154,7 @@ declare abstract class APIRequestBuilder {
 /**
  * API request builder for osu!droid.
  */
-declare class DroidAPIRequestBuilder extends APIRequestBuilder {
+declare class DroidAPIRequestBuilder extends APIRequestBuilder<DroidAPIEndpoint> {
     protected readonly host: string;
     protected readonly APIkey: string;
     protected readonly APIkeyParam: string;
@@ -163,11 +163,10 @@ declare class DroidAPIRequestBuilder extends APIRequestBuilder {
 /**
  * API request builder for osu!standard.
  */
-declare class OsuAPIRequestBuilder extends APIRequestBuilder {
+declare class OsuAPIRequestBuilder extends APIRequestBuilder<OsuAPIEndpoint> {
     protected readonly host: string;
     protected readonly APIkey: string;
     protected readonly APIkeyParam: string;
-    setEndpoint(endpoint: OsuAPIEndpoint): this;
 }
 
 /**
@@ -781,7 +780,14 @@ declare class Storyboard {
      * @returns The storyboard layer.
      */
     getLayer(type: StoryboardLayerType, createIfNotAvailable?: boolean): StoryboardLayer;
-    getLayer(type: StoryboardLayerType, createIfNotAvailable: false): StoryboardLayer | undefined;
+    /**
+     * Gets a layer of the storyboard.
+     *
+     * @param type The layer type.
+     * @param createIfNotAvailable Whether to create the storyboard layer if it's not available. Defaults to `true`.
+     * @returns The storyboard layer.
+     */
+    getLayer(type: StoryboardLayerType, createIfNotAvailable: false): StoryboardLayer | null;
 }
 
 /**
@@ -2116,6 +2122,259 @@ declare class CommandTrigger extends CommandTimelineGroup {
     toString(): string;
 }
 
+/**
+ * A Math utility class containing all methods related to the error function.
+ *
+ * This class shares the same implementation as {@link https://numerics.mathdotnet.com/ Math.NET Numerics}.
+ */
+declare abstract class ErrorFunction {
+    /**
+     * Polynomial coefficients for a numerator of erfImp
+     * calculation for erf(x) in the interval [1e-10, 0.5].
+     */
+    private static readonly erfImpAn;
+    /**
+     * Polynomial coefficients for a denominator of erfImp
+     * calculation for erf(x) in the interval [1e-10, 0.5].
+     */
+    private static readonly erfImpAd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculationfor erfc(x) in the interval [0.5, 0.75].
+     */
+    private static readonly erfImpBn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for Erfc(x) in the interval [0.5, 0.75].
+     */
+    private static readonly erfImpBd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [0.75, 1.25].
+     */
+    private static readonly erfImpCn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [0.75, 1.25].
+     */
+    private static readonly erfImpCd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [1.25, 2.25].
+     */
+    private static readonly erfImpDn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [1.25, 2.25].
+     */
+    private static readonly erfImpDd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [2.25, 3.5].
+     */
+    private static readonly erfImpEn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [2.25, 3.5].
+     */
+    private static readonly erfImpEd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [3.5, 5.25].
+     */
+    private static readonly erfImpFn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [3.5, 5.25].
+     */
+    private static readonly erfImpFd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [5.25, 8].
+     */
+    private static readonly erfImpGn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [5.25, 8].
+     */
+    private static readonly erfImpGd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [8, 11.5].
+     */
+    private static readonly erfImpHn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [8, 11.5].
+     */
+    private static readonly erfImpHd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [11.5, 17].
+     */
+    private static readonly erfImpIn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [11.5, 17].
+     */
+    private static readonly erfImpId;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [17, 24].
+     */
+    private static readonly erfImpJn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [17, 24].
+     */
+    private static readonly erfImpJd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [24, 38].
+     */
+    private static readonly erfImpKn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [24, 38].
+     */
+    private static readonly erfImpKd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [38, 60].
+     */
+    private static readonly erfImpLn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [38, 60].
+     */
+    private static readonly erfImpLd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [60, 85].
+     */
+    private static readonly erfImpMn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [60, 85].
+     */
+    private static readonly erfImpMd;
+    /**
+     * Polynomial coefficients for a numerator in erfImp
+     * calculation for erfc(x) in the interval [85, 110].
+     */
+    private static readonly erfImpNn;
+    /**
+     * Polynomial coefficients for a denominator in erfImp
+     * calculation for erfc(x) in the interval [85, 110].
+     */
+    private static readonly erfImpNd;
+    /**
+     * Polynomial coefficients for a numerator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0, 0.5].
+     */
+    private static readonly ervInvImpAn;
+    /**
+     * Polynomial coefficients for a denominator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0, 0.5].
+     */
+    private static readonly ervInvImpAd;
+    /**
+     * Polynomial coefficients for a numerator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.5, 0.75].
+     */
+    private static readonly ervInvImpBn;
+    /**
+     * Polynomial coefficients for a denominator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.5, 0.75].
+     */
+    private static readonly ervInvImpBd;
+    /**
+     * Polynomial coefficients for a numerator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.75, 1] with x less than 3.
+     */
+    private static readonly ervInvImpCn;
+    /**
+     * Polynomial coefficients for a denominator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.75, 1] with x less than 3.
+     */
+    private static readonly ervInvImpCd;
+    /**
+     * Polynomial coefficients for a numerator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.75, 1] with x between 3 and 6.
+     */
+    private static readonly ervInvImpDn;
+    /**
+     * Polynomial coefficients for a denominator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.75, 1] with x between 3 and 6.
+     */
+    private static readonly ervInvImpDd;
+    /**
+     * Polynomial coefficients for a numerator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.75, 1] with x between 6 and 18.
+     */
+    private static readonly ervInvImpEn;
+    /**
+     * Polynomial coefficients for a denominator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.75, 1] with x between 6 and 18.
+     */
+    private static readonly ervInvImpEd;
+    /**
+     * Polynomial coefficients for a numerator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.75, 1] with x between 18 and 44.
+     */
+    private static readonly ervInvImpFn;
+    /**
+     * Polynomial coefficients for a denominator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.75, 1] with x between 18 and 44.
+     */
+    private static readonly ervInvImpFd;
+    /**
+     * Polynomial coefficients for a numerator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.75, 1] with x greater than 44.
+     */
+    private static readonly ervInvImpGn;
+    /**
+     * Polynomial coefficients for a denominator of erfInvImp
+     * calculation for erf^-1(z) in the interval [0.75, 1] with x greater than 44.
+     */
+    private static readonly ervInvImpGd;
+    /**
+     * Calculates the error function.
+     *
+     * @param x The value to evaluate.
+     * @returns The error function evaluated at x, or:
+     * - 1 if `x == Number.POSITIVE_INFINITY`;
+     * - -1 if `x == Number.NEGATIVE_INFINITY`.
+     */
+    static erf(x: number): number;
+    /**
+     * Calculates the inverse error function evaluated at z.
+     *
+     * @param z The value to evaluate.
+     * @returns The inverse error function evaluated at z, or:
+     * - `Number.POSITIVE_INFINITY` if `z >= 1`;
+     * - `Number.NEGATIVE_INFINITY` if `z <= -1`.
+     */
+    static erfInv(z: number): number;
+    /**
+     * The implementation of the error function.
+     *
+     * @param z Where to evaluate the error function.
+     * @param invert Whether to compute 1 - the error function.
+     * @returns The error function.
+     */
+    private static erfImp;
+    /**
+     * The implementation of the inverse error function.
+     *
+     * @param p The first intermediate parameter.
+     * @param q The second intermediate parameter.
+     * @param s The third intermediate parameter.
+     * @returns The inverse error function.
+     */
+    private static erfInvImp;
+}
+
 declare abstract class HitWindow {
     /**
      * The overall difficulty of this hit window.
@@ -2888,11 +3147,10 @@ declare abstract class ModUtil {
     /**
      * Checks for mods that are incompatible with each other.
      *
-     * This will modify the original array.
-     *
      * @param mods The mods to check for.
+     * @returns Mods that have been filtered.
      */
-    static checkIncompatibleMods(mods: Mod[]): void;
+    static checkIncompatibleMods(mods: Mod[]): Mod[];
     /**
      * Processes parsing options.
      *
@@ -3006,6 +3264,25 @@ declare enum PathType {
     PerfectCurve = "P"
 }
 
+/**
+ * A single-variable polynomial with real-valued coefficients and non-negative exponents.
+ *
+ * This class shares the same implementation as {@link https://numerics.mathdotnet.com/ Math.NET Numerics}.
+ */
+declare abstract class Polynomial {
+    /**
+     * Evaluates a polynomial at point z.
+     *
+     * Coefficients are ordered ascending by power with power k at index k.
+     * For example, coefficients `[3, -1, 2]` represent `y = 2x^2 - x + 3`.
+     *
+     * @param z The location where to evaluate the polynomial at.
+     * @param coefficients The coefficients of the polynomial, coefficient for power k at index k.
+     * @returns The polynomial at z.
+     */
+    static evaluate(z: number, coefficients: number[]): number;
+}
+
 /**
  * Precision utilities.
  */
@@ -3454,4 +3731,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, 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, 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, ErrorFunction, 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, Polynomial, 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 };