Skip to content

v2.0.0
Compare
Choose a tag to compare
@TTTaevas TTTaevas released this 31 May 17:39
· 2 commits to master since this release
v2.0.0
5b4398b
This commit was signed with the committer’s verified signature.
TTTaevas Taevas
SSH Key Fingerprint: Y5Hv18xwPvUKSlgkx1sPnRO3L2mc03ehC7BzrnZVEyY
Verified
Learn about vigilant mode.

New major update for osu-api-v2-js! It has many breaking changes, so if you are updating from a previous version, please carefully review the changelog below for a good understanding of changes and additions

General and API object

  • Node 18 is no longer supported, Node 20 is now the oldest supported version
  • All deprecated methods and properties have been removed (getBeatmapSoloScores(), User's global_rank_exp & pp_exp)
  • The API's routes (route_api, route_token, request() and APIError's endpoint) are now Arrays instead of Strings
  • The headers are now exposed under the headers property
  • Some methods have been renamed, read below for more details

Beatmap namespace

  • current_user_playcount is now a thing for some Beatmaps
  • getBeatmapUserScore()'s config doesn't allow to specify unsupported properties anymore
  • Same for getBeatmapUserScores()'s config

Beatmapset namespace

  • All Beatmapsets should now have a genre_id and a language_id

Chat namespace

  • Websocket stuff is now under that namespace
  • generateWebSocket() has been renamed to generateChatWebsocket()
  • The generated Websocket by generateChatWebsocket() is no longer generated by the ws dependency
  • getChatWebsocketHeaders() has been added to help you generate Websockets your own way!

Event namespace

  • getEvents()'s arguments have merged (sort & cursor_string into config)

Forum namespace

  • Methods that asked you for a forum_id now also support getting Forum objects instead
  • getForumTopicAndPosts() has been renamed to getForumTopic()

Match namespace

  • This namespace has been made independent from the Multiplayer namespace
  • The scores of Match.Event.game have been completely changed by the API server, changes to interfaces have been made to reflect that

Miscellaneous namespace

  • This namespace is a new addition, holding shared concepts and methods that would feel out of place elsewhere
  • getSeasonalBackgrounds() is now accessible from there as well
  • getCountryRanking() has been moved there, away from the Ranking namespace

Multiplayer namespace

  • getRoomLeaderboard() is no longer locked behind any Scopes, documentation has been udpated to reflect that
  • getRoomEvents() has been added, although its response is currently subject to change by the API server
  • Add a freestyle property to Room.PlaylistItem

Score namespace

  • Added a Grade type
  • getScores() has been added

Spotlight namespace

  • getSpotlightRanking() has been moved there, away from the Ranking namespace

Ranking namespace

  • This namespace has been removed, its contents have been split between the following namespaces: Miscellaneous, Spotlight, User

User namespace

  • getUserKudosu() has been renamed to getUserKudosuHistory()
  • getUserRanking() has been moved there, away from the Ranking namespace
  • Same for getKudosuRanking()

There are a lot of changes, some of them are actually from a couple of months, this changelog doesn't even mention internal changes that shouldn't impact you, so it is definitely possible that I may have forgotten to mention something important. Regardless, I'm ready to help you upgrade from v1.1.3 if you ever find yourself struggling with that!

If you find something that doesn't work as expected, please open an issue!

Thank you very much for using osu-api-v2-js!!

Full Changelog: v1.1.3...v2.0.0

Assets 2
Loading
1 Join discussion