Add getScores()

Author: TTTaevas

.github/workflows/test.yml

@@ -7,7 +7,7 @@ on:
     branches:
       - "**"
   schedule:
-    - cron: "45 10 12,24 * *"
+    - cron: "45 10 * * 1"
 
 jobs:
   build:

README.md

@@ -152,6 +152,8 @@ async function getSelf() {
 getSelf()
 ```
 
+If you're looking for an example that involves WebSockets, you might wanna take a look at `lib/tests/websocket.ts` in the package's repository!
+
 ### Calling the functions, but literally
 
 This package's functions can be accessed both through the api object and through namespaces! It essentially means that for convenience's sake, there are two ways to do anything:
@@ -258,7 +260,7 @@ In the same order as on [the API's official documentation](https://osu.ppy.sh/do
 - `GET /spotlights` -> [getSpotlights()](https://osu-v2.taevas.xyz/classes/API.html#getspotlights)
 
 ### Scores
-- `GET /scores` -> TODO
+- `GET /scores` -> [getScores()](https://osu-v2.taevas.xyz/classes/API.html#getscores)
 
 ### Under "Undocumented" or missing from docs
 - `GET /seasonal-backgrounds` -> [getSeasonalBackgrounds()](https://osu-v2.taevas.xyz/classes/API.html#getseasonalbackgrounds)

lib/index.ts

@@ -742,6 +742,9 @@ export class API {
 
 	// SCORE STUFF
 
+	/** {@inheritDoc Score.getSome} @group Score Methods */
+	readonly getScores = Score.getSome
+
 	/** {@inheritDoc Score.getReplay} @group Score Methods */
 	readonly getReplay = Score.getReplay
 

lib/namespaces/Score.ts

@@ -1,4 +1,4 @@
-import { API, Beatmap, Beatmapset, Changelog, Mod, Ruleset, User } from "../index.js"
+import { API, Beatmap, Beatmapset, Changelog, Miscellaneous, Mod, Ruleset, User } from "../index.js"
 
 /** @obtainableFrom {@link API.getBeatmapUserScores} */
 export interface Score {
@@ -97,6 +97,17 @@ export namespace Score {
 		beatmap: Beatmap.Extended
 	}
 
+	/**
+	 * Get up to the 1000 (!!) most recent scores!
+	 * @param config Specify the ruleset as a filter, or use a cursor_string to get even more scores
+	 * @remarks You may get less than 1000 scores
+	 */
+	export async function getSome(this: API, config?: Pick<Miscellaneous.Config, "cursor_string"> & {
+		ruleset?: keyof typeof Ruleset
+	}): Promise<{scores: Score[], cursor_string: Miscellaneous.CursorString}> {
+		return await this.request("get", ["scores"], {...config})
+	}
+
 	/**
 	 * Get the replay for a score!
 	 * @scope {@link Scope"public"}

lib/tests/guest.ts

@@ -13,6 +13,7 @@ import * as Match from "./guest/match.test.js"
 import * as Miscellaneous from "./guest/miscellaneous.test.js"
 import * as Multiplayer from "./guest/multiplayer.test.js"
 import * as News from "./guest/news.test.js"
+import * as Score from "./guest/score.test.js"
 import * as Spotlight from "./guest/spotlight.test.js"
 import * as User from "./guest/user.test.js"
 import * as Wiki from "./guest/wiki.test.js"
@@ -30,6 +31,7 @@ const domains: Test[][] = [
 	Miscellaneous.tests,
 	Multiplayer.tests,
 	News.tests,
+	Score.tests,
 	Spotlight.tests,
 	User.tests,
 	Wiki.tests,

lib/tests/guest/score.test.ts

@@ -0,0 +1,29 @@
+import { expect } from "chai"
+import { validate, Test } from "../exports.js"
+import { Ruleset } from "../../index.js"
+
+const getScores: Test = async(api) => {
+	const scores = await api.getScores()
+	expect(scores.cursor_string).to.be.a("string")
+	expect(scores.scores.length).to.be.greaterThan(0)
+	expect(validate(scores.scores, "Score")).to.be.true
+
+	console.log("|", "With cursor_string")
+	const scores_cursor = await api.getScores({cursor_string: scores.cursor_string})
+	expect(scores_cursor.cursor_string).to.be.a("string")
+	expect(scores_cursor.scores.length).to.be.greaterThan(0)
+	expect(validate(scores_cursor.scores, "Score")).to.be.true
+
+	console.log("|", "With ruleset")
+	const scores_ruleset = await api.getScores({ruleset: "fruits"})
+	expect(scores_ruleset.cursor_string).to.be.a("string")
+	expect(scores_ruleset.scores.length).to.be.greaterThan(0)
+	scores_ruleset.scores.forEach((s) => expect(s.ruleset_id).to.equal(Ruleset.fruits))
+	expect(validate(scores_ruleset.scores, "Score")).to.be.true
+
+	return true
+}
+
+export const tests = [
+	getScores,
+]