Tests and some more docs for Multiplayer stuff

TTTaevas · Nov 11, 2023 · 0a6baf9 · 0a6baf9
1 parent 998f8a8
commit 0a6baf9
Show file tree

Hide file tree

Showing 26 changed files with 173 additions and 96 deletions.
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -11,6 +11,10 @@
     --dark-hl-4: #B5CEA8;
     --light-hl-5: #A31515;
     --dark-hl-5: #CE9178;
+    --light-hl-6: #0000FF;
+    --dark-hl-6: #569CD6;
+    --light-hl-7: #0070C1;
+    --dark-hl-7: #4FC1FF;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -22,6 +26,8 @@
     --hl-3: var(--light-hl-3);
     --hl-4: var(--light-hl-4);
     --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
     --code-background: var(--light-code-background);
 } }
 
@@ -32,6 +38,8 @@
     --hl-3: var(--dark-hl-3);
     --hl-4: var(--dark-hl-4);
     --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
     --code-background: var(--dark-code-background);
 } }
 
@@ -42,6 +50,8 @@
     --hl-3: var(--light-hl-3);
     --hl-4: var(--light-hl-4);
     --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
     --code-background: var(--light-code-background);
 }
 
@@ -52,6 +62,8 @@
     --hl-3: var(--dark-hl-3);
     --hl-4: var(--dark-hl-4);
     --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
     --code-background: var(--dark-code-background);
 }
 
@@ -61,4 +73,6 @@
 .hl-3 { color: var(--hl-3); }
 .hl-4 { color: var(--hl-4); }
 .hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
 pre, code { background: var(--code-background); }
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/API.html b/docs/classes/API.html
diff --git a/docs/classes/APIError.html b/docs/classes/APIError.html
diff --git a/docs/enums/Rulesets.html b/docs/enums/Rulesets.html
diff --git a/docs/functions/generateAuthorizationURL.html b/docs/functions/generateAuthorizationURL.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/Beatmap.html b/docs/interfaces/Beatmap.html
diff --git a/docs/interfaces/BeatmapExtended.html b/docs/interfaces/BeatmapExtended.html
diff --git a/docs/interfaces/BeatmapUserScore.html b/docs/interfaces/BeatmapUserScore.html
diff --git a/docs/interfaces/Beatmapset.html b/docs/interfaces/Beatmapset.html
diff --git a/docs/interfaces/BeatmapsetExtended.html b/docs/interfaces/BeatmapsetExtended.html
diff --git a/docs/interfaces/ChangelogBuild.html b/docs/interfaces/ChangelogBuild.html
diff --git a/docs/interfaces/KudosuHistory.html b/docs/interfaces/KudosuHistory.html
diff --git a/docs/interfaces/Leader.html b/docs/interfaces/Leader.html
diff --git a/docs/interfaces/MultiplayerScore.html b/docs/interfaces/MultiplayerScore.html
diff --git a/docs/interfaces/PlaylistItem.html b/docs/interfaces/PlaylistItem.html
diff --git a/docs/interfaces/Room.html b/docs/interfaces/Room.html
diff --git a/docs/interfaces/Score.html b/docs/interfaces/Score.html
diff --git a/docs/interfaces/UpdateStream.html b/docs/interfaces/UpdateStream.html
diff --git a/docs/interfaces/User.html b/docs/interfaces/User.html
diff --git a/docs/interfaces/UserExtended.html b/docs/interfaces/UserExtended.html
diff --git a/lib/index.ts b/lib/index.ts
@@ -418,7 +418,7 @@ export class API {
 
 	/**
 	 * Get extensive beatmapset data about whichever beatmapset you want!
-	 * @param beatmap An object with the id of the beatmapset you're trying to get
+	 * @param beatmapset An object with the id of the beatmapset you're trying to get
 	 */
 	async getBeatmapset(beatmapset: {id: number} | Beatmapset): Promise<BeatmapsetExtended> {
 		const response = await this.request("get", `beatmapsets/${beatmapset.id}`)
@@ -485,13 +485,18 @@ export class API {
 
 	// MULTIPLAYER STUFF
 
+	/**
+	 * Get data about a lazer multiplayer room (realtime or playlists)!
+	 * @param room An object with the id of the room, is at the end of its URL (after `/multiplayer/rooms/`)
+	 */
 	async getRoom(room: {id: number} | Room): Promise<Room> {
 		const response = await this.request("get", `rooms/${room.id}`)
 		return correctType(response) as Room
 	}
 
 	/**
-	 * Get room data for each room fitting the given criterias
+	 * Get rooms that are active, that have ended, that the user participated in, that the user made, or just simply any room!
+	 * @param mode Self-explanatory enough, defaults to `active`
 	 * @scope public
 	 */
 	async getRooms(mode: "active" | "all" | "ended" | "participated" | "owned" = "active"): Promise<Room[]> {
@@ -500,7 +505,8 @@ export class API {
 	}
 
 	/**
-	 * Get the room stats of a user from the room, for each user of that room
+	 * Get the room stats of all the users of that room!
+	 * @param room An object with the id of the room in question
 	 * @scope public
 	 */
 	async getRoomLeaderboard(room: {id: number} | Room): Promise<Leader[]> {
@@ -509,8 +515,7 @@ export class API {
 	}
 
 	/**
-	 * Get the scores on a specific item of a room
-	 * @scope public
+	 * Get the scores on a specific item of a room, for a maximum of 50!
 	 * @remarks (2023-11-10) Items are broken for multiplayer (real-time) rooms, not for playlists (like spotlights), that's an osu! bug
 	 * https://github.com/ppy/osu-web/issues/10725
 	 */
@@ -520,7 +525,7 @@ export class API {
 	}
 
 	/**
-	 * @remarks For multiplayer lobbies from the stable (non-lazer) client, with URLs having `community/matches` or `mp`
+	 * Get data of a multiplayer lobby from the stable (non-lazer) client that have URLs with `community/matches` or `mp`
 	 * @param id Can be found at the end of the URL of said match
 	 */
 	async getMatch(id: number): Promise<Match> {
@@ -529,8 +534,7 @@ export class API {
 	}
 
 	/**
-	 * Gets the info of the 50 most recently created matches, descending order (most recent is at index 0)
-	 * @remarks For multiplayer lobbies from the stable (non-lazer) client, with URLs having `community/matches` or `mp`
+	 * Gets the info of the 50 most recently created stable (non-lazer) matches, descending order (most recent is at index 0)
 	 */
 	async getMatches(): Promise<MatchInfo[]> {
 		const response = await this.request("get", "matches")

diff --git a/lib/tests/test.ts b/lib/tests/test.ts
@@ -109,6 +109,25 @@ const testChangelogStuff = async (): Promise<boolean> => {
 const testMultiplayerStuff = async (): Promise<boolean> => {
 	let okay = true
 
+	let d1 = await <Promise<ReturnType<typeof api.getRoom> | false>>attempt("\ngetRoom (realtime): ", api.getRoom({id: 231069}))
+	if (!isOk(d1, !d1 || (d1.recent_participants.length === 4))) okay = false
+	let d2 = await <Promise<ReturnType<typeof api.getRoom> | false>>attempt("getRoom (playlist): ", api.getRoom({id: 51693}))
+	if (!isOk(d2, !d2 || (d2.participant_count === 159))) okay = false
+	if (d1) { // can't bother getting and writing down the id of a playlist item
+		let d3 = await <Promise<ReturnType<typeof api.getPlaylistItemScores> | false>>attempt(
+			"getPlaylistItemScores (realtime): ", api.getPlaylistItemScores({id: d1.playlist[0].id, room_id: d1.id}))
+		!isOk(d3, !d3 || (d3.length > 0)) ? console.log("Bug not fixed yet...") : console.log("Bug fixed!!! :partying_face:")
+	}
+	if (d2) { // still can't bother getting and writing down the id of a playlist item
+		let d4 = await <Promise<ReturnType<typeof api.getPlaylistItemScores> | false>>attempt(
+			"getPlaylistItemScores (playlist): ", api.getPlaylistItemScores({id: d2.playlist[0].id, room_id: d2.id}))
+		if (!isOk(d4, !d4 || (d4.length >= 50))) okay = false
+	}
+	let d5 = await <Promise<ReturnType<typeof api.getMatch> | false>>attempt("getMatch: ", api.getMatch(62006076))
+	if (!isOk(d5, !d5 || (d5.match.name === "CWC2020: (Italy) vs (Indonesia)"))) okay = false
+	let d6 = await <Promise<ReturnType<typeof api.getMatches> | false>>attempt("getMatches: ", api.getMatches())
+	if (!isOk(d6, !d6 || (d6[0].id > 111250329))) okay = false
+
 	return okay
 }
 

diff --git a/lib/tests/test_authorized.ts b/lib/tests/test_authorized.ts
@@ -22,10 +22,10 @@ async function test(id: string | undefined, secret: string | undefined, redirect
 
 	let api = await osu.API.createAsync({id: Number(id), secret}, {code, redirect_uri}, "all")
 	if (api) {
-		let d1 = await api.getRanking(osu.Rulesets.osu, "performance", 1, "friends")
+		let d1 = await api.getRoom({id: 231069})
 		if (d1) {
-			d1.ranking = [d1.ranking[0]]
-			console.log(d1)
+			let d2 = await api.getPlaylistItemScores({id: d1.playlist[0].id, room_id: 231069})
+			console.log(d2)
 		}
 	}
 }

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "osu-api-v2-js",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Package to easily access osu!api version 2.0",
   "type": "module",
   "main": "dist/index.js",