Skip to content

Releases: TTTaevas/osu-api-v1-js

v2.1.0

27 Nov 23:19
Compare
Choose a tag to compare

Breaking change

api.getUserScores has been removed in favour of api.getUserBestScores() and api.getUserRecentScores(), please use those instead! They work pretty much the same way, with increased type safety!

Changes and fixes

  • Some of getURL()'s functions now support setting a custom server if you want, just in case
  • A Beatmap's source can no longer be 0, it'll now always be a string
  • A User's events could be 0 despite the interface saying otherwise, it'll now always be an array
  • A Match's game could have an end_time that is null despite the interface saying otherwise, the interface now specifies that
  • Some Scores (recent user scores)'s score_id could be null despite the interface saying otherwise, the interface now specifies that
  • More about Scores below

Scores have been split into multiple interfaces for the different functions that return them, all extending the Score interface
This means that Scores from recent user scores no longer have a replay_available or pp property
This means that Scores from beatmap scores must have a replay_available and a pp property, although pp may be null
This means that Scores from best user scores must have a replay_available and a pp property
Similarly, those last two types of Scores guarantee that its score_id will not be null

The documentation has been updated to reflect these changes
Have fun using osu-api-v1-js!

v2.0.0

19 May 12:18
b8026d1
Compare
Choose a tag to compare

There are breaking changes, and from this version onwards, you will be required to add "type": "module" to your package.json

Changes:

  • APIErrors are now thrown instead of being returned, meaning the API's functions will always return what's desired (if anything is returned)
  • APIErrors now also have the server, endpoint and parameters that were used in the request that triggered it
  • The API's verbose is now more customizable, it is set to none by default, and can be set to errors or all (used to be a boolean set to false by default)
  • All enums are now UPPERCASED for the sake of consistency
  • api.getReplay() has been changed, documentation about it has consequently been updated

Full Changelog: https://github.com/TTTaevas/osu-api-v1-js/pull/42/commits

v1.0.1

03 Mar 23:11
f2f2bf5
Compare
Choose a tag to compare

No breaking changes here, v1.0.0 code works well on v1.0.1

Additions in this version include:

  • Allow API to send requests to a server/URL of your choice (like the api of an osu private server)
  • Slightly more explicit APIError messages
  • Requests get retried automatically upon receiving a 429 (with a delay created on purpose)
  • Add a bunch of small practical functions thanks to the getURL Object

Fixes in this version include:

  • getBeatmap no longer specifies the gamemode to osu! if the gamemode has not been specified

Full Changelog: https://github.com/TTTaevas/osu-api-v1-js/pull/24/commits

v1.0.0

28 Feb 15:39
cf399ce
Compare
Choose a tag to compare

Fully implements the API
Nothing should be broken at this point and this software should be fully usable and functional

v0.4.2

26 Feb 17:36
5d394b4
Compare
Choose a tag to compare

Just some minor changes with added blocks of comments

v0.4.1

24 Feb 01:19
4aa773c
Compare
Choose a tag to compare

Changes were made to getBeatmap and getReplay
getBeatmaps is now a thing if you wanna get more specific stuff done
Beatmap now shows diff_aim and diff_speed as possibly null (due to taiko/ctb/mania)
Fixed bug where requesting a beatmap with both DT and NC would return pp/difficulty stuff as 0 (for example, through the enabled_mods of a Score)
Always some more comment blocks to help you out

v0.4.0

23 Feb 02:03
2857be7
Compare
Choose a tag to compare

Score and Beatmap are now more reliable than ever
Functions inside interfaces have essentially been removed, in favour of enums (except getLength which now exists on its own)
Speaking of enums, MultiplayerModes and WinConditions exist now, for all your multiplayer needs
Replay is now a thing, and so is getReplay
And a few comment blocks here and there so you have more of a clue how to do stuff

v0.3.3

20 Feb 21:09
7bc6929
Compare
Choose a tag to compare

v0.3.3 allows you to safely request beatmaps with any combination of mods and get the proper data