Skip to content

Latest commit

 

History

History
281 lines (159 loc) · 4.71 KB

CHANGELOG.md

File metadata and controls

281 lines (159 loc) · 4.71 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[4.0.0] - 2024-03-23

Added

  • Error codes 34, 35, 36, 37, 38, 39, 40 and 41
  • Support for temporary video download link
  • TypeScript

Changed

  • Methods naming scheme

Removed

  • CommonJS support

[3.13.0] - 2024-02-03

Changed

[3.12.0] - 2023-07-24

Added

  • New fields in newRender:
    • ignoreFail
    • showSliderBreaks
    • showStrainGraph

Changed

  • Dependencies update

[3.11.2] - 2023-02-02

Changed

[3.11.1] - 2023-01-28

Changed

  • Optional chaining for possibly undefined variables
  • Dependencies update

[3.11.0] - 2022-10-23

Added

  • replayFile support
  • pnpm-lock file ignore

Changed

  • Dependencies update

[3.10.1] - 2022-08-23

Added

  • customSkin field in newRender

[3.10.0] - 2022-08-23

Added

  • Added customSkinInfo method and its corresponding types
  • Added renders beatmapsetid query

Changed

  • Dependencies update

[3.9.0] - 2022-07-09

Added

  • Added error codes 32 & 33

Changed

  • Switched API URL from https://ordr-api.issou.best to https://apis.issou.best/ordr
  • Correct API documentation onlineCount function name
  • Correct TS types for error codes
  • Rewrote error codes

[3.8.1] - 2022-05-23

Changed

  • Removed require package.json at each request

[3.8.0] - 20212-04-21

Added

  • Added playNightcoreSamples param in newRender method and its according type in the render object
  • Added link param in renders method
  • Added error code 28, 29, 30, 31
  • Added client.API_CODES and client.WS_CODES

Removed

  • Skin mozaicPreview type in the skin object
  • render_error event

Changed

  • Dependencies update

[3.7.0] - 2021-12-28

Added

  • Added error code 27
  • /onlineCount endpoint: onlineCount()

Changed

  • TS types update
  • Lite mode for /renders: renders()

[3.6.0] - 2021-11-04

Added

  • Added showAimErrorMeter and showAvatarsOnScoreboard params in newRender method
  • Added error codes 25 & 26
  • TS types for new values returned by /skins endpoint

Changed

  • Dependencies updates
  • Switched WebSocket events to their JSON version

[3.5.0] - 2021-10-12

Changed

  • Major refactor thanks to flazepe #4
  • Dependencies updates

[3.4.0] - 2021-09-23

Added

  • /servers endpoint: servers()

[3.3.2] - 2021-08-19

Added

  • showKeyOverlay default value in newRender method

Removed

  • Motion blur 960 fps option

[3.3.1] - 2021-08-19

Changed

  • Fix on render_error deprecation warning

[3.3.0] - 2021-08-18

Added

  • Nobot param in renders method
  • API devmode
  • showHitCounter param in newRender method
  • Defaults in API Doc
  • Added error codes 22 & 23

Changed

  • TS types are now only in 1 file

Removed

  • index.js

[3.2.1] - 2021-08-17

Added

  • Deprecation warning for render_error
  • Prettier

[3.2.0] - 2021-07-29

Changed

  • Removed querystring for URLSearchParams

Added

  • Types for API responses #3

[3.1.3] - 2021-07-29

Changed

  • Fix on renders() and skins() types

[3.1.2] - 2021-07-29

Changed

  • Fix on Client constructor types (now optional)

[3.1.1] - 2021-07-27

Added

  • More TS types

[3.1.0] - 2021-07-26

Added

  • TS types

[3.0.0] - 2021-07-26

Added

  • This CHANGELOG file
  • Socket.io-client for WebSocket
  • Errors in the documentation
  • Added progression for "Uploading..." and "Finalizing..." status
  • "returns" property for websocket events in the documentation

Changed

  • Removed WS for WebSocket
  • WebSocket now returns Objects
  • Better "returns" property for the functions in the documentation
  • ParseError object contains more info

[2.0.0] - 2021-07-18

Added

  • ES modules compatibilty

[1.1.0] - 2021-07-13

Added

  • render_fail event (rev12)

Changed

  • Default replay params (rev12)
  • Better errors with error codes (rev12)
  • Better JSdoc

Deprecated

  • render_error event is deprecated since rev12

Removed

  • console.log #1

[1.0.0] - 2021-06-28

Added

  • First version