Document getBeatmapTopNonLegacyScores

docs/content/changelog.mdx

@@ -1,8 +1,9 @@
 # Changelog
 
-## Unreleased
+## 2.4.0
 
 - Add support for the `/beatmaps/{beatmap}/solo-scores` endpoint via `Client.beatmaps.getBeatmapTopNonLegacyScores`.
+- Add `GetBeatmapTopNonLegacyScoresOptions` interface.
 - Add `image@2x` property to `UserActiveTournamentBanner` interface.
 - Add `image@2x_url` property to `UserBadge` interface.
 - Add `count_100`, `count_300`, `count_50`, `count_miss`, `pp_exp` and `global_rank_exp` properties to `UserStatistics` interface.

docs/content/current/get-beatmap-top-non-legacy-scores.mdx

@@ -0,0 +1,60 @@
+---
+title: Get beatmap top scores (non-legacy)
+ref: beatmaps
+---
+
+# Get beatmap top scores (non-legacy)
+
+The `beatmaps.getBeatmapTopNonLegacyScores` method on a `Client` instance makes a `GET` request to the `beatmaps/{beatmap}/solo-scores` endpoint and returns an array of user scores on a beatmap.
+
+### Example
+
+```ts
+const scores = await api.beatmaps.getBeatmapTopNonLegacyScores(1816113, {
+  query: {
+    mode: 'osu'
+  }
+});
+```
+
+### Parameters
+
+| Parameter | Type                                                                                         | Optional | Description                              |
+| --------- | -------------------------------------------------------------------------------------------- | -------- | ---------------------------------------- |
+| beatmap   | number                                                                                       |          | ID of the beatmap to get top scores from |
+| options   | [GetBeatmapTopNonLegacyScoresOptions](/references/get-beatmap-top-non-legacy-scores-options) | ✓        |                                          |
+
+#### options.query
+
+| Parameter   | Type                              | Optional | Description                              |
+| ----------- | --------------------------------- | -------- | ---------------------------------------- |
+| legacy_only | boolean                           | ✓        | Set to true to only return legacy scores |
+| mode        | [GameMode](/references/game-mode) | ✓        | Gamemode of the scores to return         |
+
+### Returns
+
+```ts
+Promise<
+  (Score & {
+    user: UserCompact & {
+      country: Country;
+      cover: Cover;
+    };
+  })[]
+>;
+```
+
+#### Types
+
+- [Score](/references/score)
+- [UserCompact](/references/user-compact)
+- [Country](/references/country)
+- [Cover](/references/cover)
+
+### Possible Exceptions
+
+See the [error handling documentation](/extras/error-handling) for more information.
+
+- `invalid_json_syntax`
+- `network_error`
+- `unexpected_response`

docs/content/references/get-beatmap-top-non-legacy-scores-options.mdx

@@ -0,0 +1,19 @@
+---
+title: GetBeatmapTopNonLegacyScoresOptions
+ref: interface
+---
+
+# GetBeatmapTopNonLegacyScoresOptions
+
+```ts
+interface GetBeatmapTopNonLegacyScoresOptions {
+  query?: {
+    legacy_only?: boolean;
+    mode?: GameMode;
+  };
+}
+```
+
+## Types
+
+- [GameMode](/references/game-mode)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "osu-web.js",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "osu.js is an unofficial Javascript and Typescript SDK for the browser-facing portion of osu! with type safety in mind",
   "main": "lib/index.cjs",
   "module": "lib/index.js",

src/classes/Beatmaps.ts

@@ -17,7 +17,7 @@ import type {
 } from '../types';
 import type {
   GetBeatmapAttributesOptions,
-  GetBeatmapNonLegacyScoresOptions,
+  GetBeatmapTopNonLegacyScoresOptions,
   GetBeatmapScoresOptions,
   GetBeatmapsOptions,
   LookupBeatmapOptions
@@ -133,9 +133,9 @@ export default class Beatmaps<
    * @param beatmap ID of the beatmap to get top scores from
    * @returns An array of user scores on a beatmap
    */
-  private async getBeatmapTopNonLegacyScores(
+  public async getBeatmapTopNonLegacyScores(
     beatmap: number,
-    options?: GetBeatmapNonLegacyScoresOptions
+    options?: GetBeatmapTopNonLegacyScoresOptions
   ): Promise<
     (Score & {
       user: UserCompact & {

src/types/options.ts

@@ -31,7 +31,7 @@ export interface GetBeatmapScoresOptions {
   };
 }
 
-export interface GetBeatmapNonLegacyScoresOptions {
+export interface GetBeatmapTopNonLegacyScoresOptions {
   query?: {
     /** Set to true to only return legacy scores */
     legacy_only?: boolean;