Skip to content

Releases: koreanbots/js-sdk

v3.2.1

25 Feb 14:04
c66a4c0
Compare
Choose a tag to compare

What's Changed

Full Changelog: 3.2.0...3.2.1

v3.2.0

19 Nov 15:43
c314ba9
Compare
Choose a tag to compare

What's Changed

  • Stable v3.2.0 SDK by @zero734kr in #124
    • Added support for KOREANSERVERS (Official english name TBD) list. It is accessible with koreanbots.servers.fetch()
  • feat: AVIF image widget support by @zero734kr in 5108cb7
  • feat: WidgetMakeOptions#convertOptions and HEIF image widget support by @zero734kr in #128

Full Changelog: 3.1.0...3.2.0

v3.1.0

26 Oct 21:12
0ecf8cb
Compare
Choose a tag to compare

Breaking Changes (Summary)

  • v3.1 only compatible with Node.js v16.6 or above.
  • v3.1 only compatible with discord.js v13 or above.
  • Performance improvements by using undici instead of node-fetch.
  • Cache policy changed.
  • Discord#inviteUrl has been renamed to Discord#url.
  • The invite url format of Discord#url has been changed from https://discord.gg/<code> to https://discord.com/invite/<code>.
  • Added support for servers list. It is accessible with koreanbots.servers.fetch(). (Canceled in this version)

Dependency Changes

  • Removed dependencies related with commitlint because it was the root of the vulnerability alert, as they never (or sometimes?) published new versions with the update of their vulnerable dependencies.
  • node-fetch has been removed in favor of undici.
  • The abort-controller package has been removed in favor of the native Node.js v16 AbortController API.
  • All dependencies have been updated to the latest version.

Why undici instead of node-fetch?

  • node-fetch is not compatible with CJS imports from v3.

node-fetch/node-fetch#1263
sindresorhus/meta#15 (comment)

  • undici is faster than node-fetch. see benchmark results
  • undici is maintained by contributors of nodejs.

Why Node.js v16.6 or above?

With undici being used, koreanbots JS/TS SDK v3.1 will only be compatible with nodejs v16.6 and above, because undici only supports above that. Therefore, the sdk will only be compatible with discord.js v13 above.

LimitedCollection of discord.js and changed cache policies

LifetimeCollection removed in favor of LimitedCollection from discord.js

  • BREAKING: Cache policies have been changed as LimitedCollection only supports sweeping at certain intervals, so instead of maxAge being applied to all values ​​each by themselves, they will all be deleted after a few intervals , regardless of just entered the cache store.
  • max has been renamed to maxSize with use of LimitedCollection
  • maxAge has been renamed to sweepInterval with use of LimitedCollection, changing the cache policy as mentioned above.

What's Changed

Full Changelog: 3.1.0-rc.1...3.1.0

Release 3.1.0-rc.1 SDK

08 Oct 01:10
73fc4ae
Compare
Choose a tag to compare
Pre-release

Release Highlights (Summary)

  • v3.1 only compatible with Node.js v16.6 or above.
  • v3.1 only compatible with discord.js v13 or above.
  • Performance improvements by using undici instead of node-fetch.
  • Cache policy changed.
  • Discord#inviteUrl has been renamed to Discord#url.
  • The invite url format of Discord#url has been changed from https://discord.gg/<code> to https://discord.com/invite/<code>.
  • Added support for servers list. It is accessible with koreanbots.servers.fetch(). (Canceled in this version)

What's Changed [auto generated]

  • Release v2 SDK (stable) by @zero734kr in #80
  • build(deps-dev): bump eslint from 7.23.0 to 7.32.0 by @dependabot in #88
  • build(deps-dev): bump @commitlint/config-conventional from 12.0.1 to 13.1.0 by @dependabot in #85
  • build(deps-dev): bump typedoc from 0.21.4 to 0.22.2 by @dependabot in #98
  • BREAKING: Koreanbots JS/TS SDK v3.1 by @zero734kr in #104

Full Changelog: 3.0.0-rc.16...3.1.0-rc.1

Dependency Changes

  • Removed dependencies related with commitlint because it was the root of the vulnerability alert, as they never (or sometimes?) published new versions with the update of their vulnerable dependencies.
  • node-fetch has been removed in favor of undici.
  • The abort-controller package has been removed in favor of the native Node.js v16 AbortController API.
  • All dependencies have been updated to the latest version.

Why undici instead of node-fetch?

  • node-fetch is not compatible with CJS imports from v3.

node-fetch/node-fetch#1263
sindresorhus/meta#15 (comment)

  • undici is faster than node-fetch. see benchmark results
  • undici is maintained by contributors of nodejs.

Why Node.js v16.6 or above?

With undici being used, koreanbots JS/TS SDK v3.1 will only be compatible with nodejs v16.6 and above, because undici only supports above that. Therefore, the sdk will only be compatible with discord.js v13 above.

LimitedCollection of discord.js and changed cache policies

LifetimeCollection removed in favor of LimitedCollection from discord.js

  • BREAKING: Cache policies have been changed as LimitedCollection only supports sweeping at certain intervals, so instead of maxAge being applied to all values ​​each by themselves, they will all be deleted after a few intervals , regardless of just entered the cache store.
  • max has been renamed to maxSize with use of LimitedCollection
  • maxAge has been renamed to sweepInterval with use of LimitedCollection, changing the cache policy as mentioned above.

v3.0.0

05 Sep 04:38
c2d1c94
Compare
Choose a tag to compare

Release Highlights

  • Added support for koreanbots API v2 (#18) (0600153)
  • Added support for discord.js v13 (#93) (d7d251a)
  • New documentation website! Click here
    • Reading the documentation with this guide is super important and super recommended to know how to use new methods introduced in this major version.
  • Added support for Apple Silicon ARM (only M1 at this point) (fbf5688)

Breaking Changes

  • The parameter name count in Mybot#update has been renamed to servers. (7e6b405)

Features

  • Added support for shards property in Mybot#update (7e6b405)

v3.0.0-rc.8

28 Aug 04:06
f376512
Compare
Choose a tag to compare
v3.0.0-rc.8 Pre-release
Pre-release

Dependency Change

  • Change version lock of discord.js

v3.0.0-rc.7

28 Aug 04:01
0cde235
Compare
Choose a tag to compare
v3.0.0-rc.7 Pre-release
Pre-release

Dependency Change

  • Move discord.js from peerDependencies to dependencies. (e2021cd)

v3.0.0-rc.6

28 Aug 03:35
3f78a19
Compare
Choose a tag to compare
v3.0.0-rc.6 Pre-release
Pre-release

Bug Fixes

v3.0.0-rc.5

28 Aug 03:09
67ec9ca
Compare
Choose a tag to compare
v3.0.0-rc.5 Pre-release
Pre-release

Miscellaneous Change

  • Fix typo in package.json (c9b0eb8)

Dependency Update

  • Fix security vulnerability introduced by path-parse (9950b8a)

v3.0.0-rc.16

28 Aug 18:02
e65b8e0
Compare
Choose a tag to compare
v3.0.0-rc.16 Pre-release
Pre-release

Miscellaneous Change