Update Beatmap.DifficultyAttributes

In reaction to the latest pp update
More info: ppy/osu-web#11990

Author: TTTaevas

lib/Beatmap.ts

@@ -164,33 +164,32 @@ export namespace Beatmap {
 		/** @obtainableFrom {@link API.getBeatmapDifficultyAttributesOsu} */
 		export interface Osu extends DifficultyAttributes {
 			aim_difficulty: number
+			aim_difficult_slider_count: number
 			speed_difficulty: number
 			speed_note_count: number
-			flashlight_difficulty: number
 			slider_factor: number
-			approach_rate: number
-			overall_difficulty: number
+			aim_difficult_strain_count: number
+			speed_difficult_strain_count: number
 		}
 
 		/** @obtainableFrom {@link API.getBeatmapDifficultyAttributesTaiko} */
 		export interface Taiko extends DifficultyAttributes {
-			stamina_difficulty: number
-			rhythm_difficulty: number
-			colour_difficulty: number
-			peak_difficulty: number
-			great_hit_window: number
+			mono_stamina_factor: number
 		}
 
-		/** @obtainableFrom {@link API.getBeatmapDifficultyAttributesFruits} */
-		export interface Fruits extends DifficultyAttributes {
-			approach_rate: number
-		}
+		/**
+		 * @obtainableFrom {@link API.getBeatmapDifficultyAttributesFruits}
+		 * @remarks Since the pp update of 2025-03-06, no property exclusive to this Ruleset exists
+		 */
+		export interface Fruits extends DifficultyAttributes {}
 
-		/** @obtainableFrom {@link API.getBeatmapDifficultyAttributesMania} */
+		/**
+		 * @obtainableFrom {@link API.getBeatmapDifficultyAttributesMania}
+		 * @remarks Since the pp update of 2025-03-06, no property exclusive to this Ruleset exists
+		 */
 		export interface Mania extends DifficultyAttributes {
-			great_hit_window: number
-			/** @remarks API documentation says it exists, my thorough testing says it doesn't, so... */
-			score_multiplier?: number
+			/** @remarks This seems to be about the max_combo with **Classic mod or Stable (non-lazer) client** */
+			max_combo: number
 		}
 
 		export type Any = Osu | Taiko | Fruits | Mania
@@ -229,6 +228,7 @@ export namespace Beatmap {
 		 * Get various data about the difficulty of a ctb beatmap!
 		 * @param beatmap The Beatmap in question
 		 * @param mods Can be a bitset of mods, an array of mod acronyms, or an array of Mods (ignores mod settings) (defaults to **No Mod**)
+		 * @remarks Since the pp update of 2025-03-06, no property exclusive to this Ruleset exists
 		 */
 		export async function getFruits(this: API, beatmap: Beatmap["id"] | Beatmap, mods?: Mod[] | string[] | number): Promise<DifficultyAttributes.Fruits> {
 			return await this.getBeatmapDifficultyAttributes(beatmap, mods, Ruleset.fruits) as DifficultyAttributes.Fruits
@@ -237,6 +237,7 @@ export namespace Beatmap {
 		 * Get various data about the difficulty of a mania beatmap!
 		 * @param beatmap The Beatmap in question
 		 * @param mods Can be a bitset of mods, an array of mod acronyms, or an array of Mods (ignores mod settings) (defaults to **No Mod**)
+		 * @remarks Since the pp update of 2025-03-06, no property exclusive to this Ruleset exists
 		 */
 		export async function getMania(this: API, beatmap: Beatmap["id"] | Beatmap, mods?: Mod[] | string[] | number): Promise<DifficultyAttributes.Mania> {
 			return await this.getBeatmapDifficultyAttributes(beatmap, mods, Ruleset.mania) as DifficultyAttributes.Mania

lib/tests/exports.ts

@@ -8,25 +8,23 @@ export type Test = (api: API) => Promise<true>;
 
 const generator = tsj.createGenerator({path: "lib/index.ts", additionalProperties: true})
 
-export function validate(object: unknown, schemaName: string): boolean {
+export function validate(obj: unknown, schemaName: string): boolean {
 	try {
 		const schema = fixDate(generator.createSchema(schemaName))
 		const ajv_const = new ajv.default({strict: false})
 		ajv_const.addFormat("date-time", true)
 		const validator = ajv_const.compile(schema)
 
-		if (Array.isArray(object)) {
-			for (let i = 0; i < object.length; i++) {
-				const result = validator(object[i])
-				if (validator.errors) console.error("❌ from validator:\n", validator.errors, "\n...for the following object:\n",
-					util.inspect(object[i], {colors: true, compact: true, depth: 100}), "\n\n")
+		if (Array.isArray(obj)) {
+			for (let i = 0; i < obj.length; i++) {
+				const result = validator(obj[i])
+				if (validator.errors) console.error(obj[i], util.inspect(validator.errors, {colors: true, depth: 5}))
 				if (!result) return false
 			}
 			return true
 		} else {
-			const result = validator(object)
-			if (validator.errors) console.error("❌ from validator:\n", validator.errors, "\n...for the following object:\n",
-				util.inspect(object, {colors: true, compact: true, depth: 100}), "\n\n")
+			const result = validator(obj)
+			if (validator.errors) console.error(obj, util.inspect(validator.errors, {colors: true, depth: 5}))
 			return result
 		}
 	} catch(err) {

lib/tests/guest/beatmap.test.ts

@@ -28,29 +28,28 @@ const getBeatmaps: Test = async(api) => {
 
 const getBeatmapDifficultyAttributesOsu: Test = async(api) => {
 	const attributes = await api.getBeatmapDifficultyAttributesOsu(125660, ["DT"])
-	console.log(attributes)
-	expect(attributes.approach_rate.toFixed(2)).to.equal("9.67")
+	expect(attributes.max_combo).to.equal(1193)
 	expect(validate(attributes, "Beatmap.DifficultyAttributes.Osu"))
 	return true
 }
 
 const getBeatmapDifficultyAttributesTaiko: Test = async(api) => {
 	const attributes = await api.getBeatmapDifficultyAttributesTaiko(388463, ["DT"])
-	expect(attributes.great_hit_window).to.be.lessThan(35)
+	expect(attributes.max_combo).to.equal(876)
 	expect(validate(attributes, "Beatmap.DifficultyAttributes.Taiko"))
 	return true
 }
 
 const getBeatmapDifficultyAttributesFruits: Test = async(api) => {
 	const attributes = await api.getBeatmapDifficultyAttributesFruits(705339, ["DT"])
-	expect(attributes.approach_rate.toFixed(2)).to.equal("10.33")
+	expect(attributes.max_combo).to.equal(1029)
 	expect(validate(attributes, "Beatmap.DifficultyAttributes.Fruits"))
 	return true
 }
 
 const getBeatmapDifficultyAttributesMania: Test = async(api) => {
-	const attributes = await api.getBeatmapDifficultyAttributesMania(3980252, ["DT"])
-	expect(attributes.great_hit_window).to.equal(40)
+	const attributes = await api.getBeatmapDifficultyAttributesMania(473228, ["DT"])
+	expect(attributes.max_combo).to.equal(5614)
 	expect(validate(attributes, "Beatmap.DifficultyAttributes.Mania"))
 	return true
 }