Skip to content

Releases: noblox/noblox.js

v6.0.2: Update typings for getAuthenticatedUser

17 Aug 15:45
@Neztore Neztore
v6.0.2
1e0d1d3
Compare
Choose a tag to compare
v6.0.2: Update typings for getAuthenticatedUser Latest
Latest

We missed the TS Typing when this was originally added. This patch fixes it.

🚨ACTION REQUIRED - See the v6.0.1 release notes.

Assets 2
Loading

v6.0.1

16 Aug 22:53
@alanbixby alanbixby
v6.0.1
84d38b7
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v6.0.1

ACTION REQUIRED BY AUGUST 27, 2024 - UPDATE TO LATEST OR DISABLE COOKIE VALIDATION

🚨 BREAKING ROBLOX API CHANGE | MANDATORY UPDATE:

getCurrentUser() calls https://www.roblox.com/mobileapi/userinfo which is being deprecated August 27, 2024. This method is used by setCookie() to validate the cookie - following this change, getAuthenticatedUser() will be used instead which has a different return schema.

Failure to take action by August 27th, 2024 will cause a runtime error and your cookie fail report as invalid / return no user object.

See https://devforum.roblox.com/t/official-list-of-deprecated-web-endpoints/62889/66

⚠ Action Steps:

  1. Update noblox.js to v6.0.1 (recommended) or disable cookie validation from setCookie via setCookie(ROBLOX_COOKIE, false)
  2. Replace references to getCurrentUser() or objects saved from setCookie with getAuthenticatedUser(), getUserFunds(), getPlayerThumbnail() or getPremium()
Disabling Deprecation Warnings

As part of this release, deprecation messages have been added to notify users of changes to the getCurrentUser() method. These messages will appear both as console output and within the method's return value to indicate that the method is deprecated.

If you wish to suppress these warnings in your console, you can opt out by setting the following option:

noblox.setOptions({ show_deprecation_warnings: false });

See #824 for more information.

setCookie modified return value

BEFORE:

// @see https://noblox.js.org/global.html#LoggedInUserData
{
  "UserID": 2416399685, // use getAuthenticatedUser() instead
  "UserName": "nobIoxjs", // use getAuthenticatedUser() instead
  "RobuxBalance": 0, // use getUserFunds() instead
  "ThumbnailUrl": "https://tr.rbxcdn.com/30DAY-Avatar-ED50D6AA9232B1E4A3DEC2F4AACC8FA9-Png/352/352/Avatar/Webp/noFilter", // use getPlayerThumbnail() instead
  "IsAnyBuildersClubMember": false, // always returns false
  "IsPremium": false // use getPremium instead
}

AFTER:

// @see https://noblox.js.org/global.html#AuthenticatedUserData
{
   "id": 2416399685,
   "name": "nobIoxjs",
   "displayName": "nobIoxjs"
}

--

NOTE: getCurrentUser() is now deprecated and has been polyfilled to return the same response after August 27, 2024

Calls to getCurrentUser() will now consume 4 API calls which is inherently slower and has a greater performance impact - we strongly recommend migrating to the subcalls that are applicable to your usecase:

🥳 New Features

🏠 Unused dependencies have been removed from the package and replaced with modern equivalents.

  • Dependency Cleanup: Removed old signalr-client and progress dependencies in #823
  • Linting: The project now uses standard directly for linting in #823

Authors

Full Changelog: v5.0.0...v6.0.1

Contributors

alanbixby
Assets 2
Loading

v5.0.1: As v5

01 Aug 23:53
@Neztore Neztore
v5.0.1
5d44879
Compare
Choose a tag to compare
v5.0.1: As v5

This is a big release - we're back!
The package at version v5.0.0 is taken by a past error and cannot be unpublished from NPM. Use v5.0.1 onwards - v5 and v5.0.1 on github releases are identical, but different on NPM.
Welcome to our new contributors. It's great to have you on board.

💥 Breaking Change

  • We now require node v18.18. v18 is the oldest LTS, so you should be on it anyway - and v18.18 is required by our eslint dependency.
    • Dropping support for old node versions means we can use newer features, like native fetch, to make the library better.
  • Remove checkDeveloperProductName reference from addDeveloperPoduct (redundant and deprecated) #814 (@alanbixby)
  • Update dependencies and minimum node version requirements #817 (@Neztore)

🐛 Bug Fix

🏠 Internal

🔩 Dependency Updates

  • Removed token parameter which prevented the function from respecting custom parameter values #792 (@AEW745)

Authors: 9

New Contributors

Contributors

sqikerz, iamEvanYT, and 2 other contributors
Assets 2
Loading

v5.0.0: Switch to maintained request library and more

01 Aug 23:36
@Neztore Neztore
v5.0.0
5781d80
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v5.0.0: Switch to maintained request library and more

💥 Breaking Change

  • We now require node v18.18. v18 is the oldest LTS, so you should be on it anyway - and v18.18 is required by our eslint dependency.
    • Dropping support for old node versions means we can use newer features, like native fetch, to make the library better.
  • Remove checkDeveloperProductName reference from addDeveloperPoduct (redundant and deprecated) #814 (@alanbixby)
  • Update dependencies and minimum node version requirements #817 (@Neztore)

🐛 Bug Fix

🏠 Internal

🔩 Dependency Updates

  • Removed token parameter which prevented the function from respecting custom parameter values #792 (@AEW745)

Authors: 9

New Contributors

Contributors

sqikerz, iamEvanYT, and 2 other contributors
Assets 2
Loading

v4.15.1: Fix onAuditLog

06 Jan 22:33
@Neztore Neztore
v4.15.1
6475df2
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v4.15.1: Fix onAuditLog

What's Changed

New Contributors

Full Changelog: v4.15.0...v4.15.1

Contributors

dependabot and commonly-ts
Assets 2
Loading
0 Join discussion

v4.15.0: getGameRevenue, getGamePassProductInfo, and bugfixes

31 Oct 22:37
@Neztore Neztore
v4.15.0
94f6ce0
Compare
Choose a tag to compare
v4.15.0: getGameRevenue, getGamePassProductInfo, and bugfixes

Two new methods, lots of documentation fixes, and some bug fixes.

Happy Halloween! 🎃🦇

What's Changed

New Contributors

Full Changelog: v4.14.0...v4.15.0

Contributors

suufi, Neztore, and 8 other contributors
Assets 2
Loading

v4.14.0: Reorganization, new endpoints, Open Cloud, and unit tests

15 Mar 05:31
@suufi suufi
v4.14.0
99cdc50
Compare
Choose a tag to compare
v4.14.0: Reorganization, new endpoints, Open Cloud, and unit tests

A year later, an official version has been published with a number of changes. Happy 2023 (3 months late)!

Change Log

📝 Documentation

  • docs: Add tutorial for remote cookie retrieval to address IP locking by @alanbixby in #547
  • Add error handling to event docs by @Neztore in #583
  • Adding await to uploadItem to JSDoc function example by @athammer in #556
  • Fix getConversations docs. by @Sightem in #654

🏠 Internal

  • Internal reorganization of endpoints such that they are under their subdomain listing (if possible) #587
  • Fix FriendRequest type by @siim0n in #630
  • Improve unit test cases by adding more specificity and more functions by @suufi in #587
  • getBlurb returns results without HTML parsing by @suufi in #587
  • Update description for package and add @alanbixby as maintainer by @suufi in #587

🚀 Changes

New Functions

  • Add getThumbnails.js by @popeeyy in #566
  • Add deleteWallPostsByUser.js by @GestaIt in #608
  • Add Open Cloud functions by @suufi in #587
    • Add setAPIKey.js
    • Add deleteDatastoreEntry.js
    • Add getDatastoreEntry.js
    • Add getDatastoreEntryVersions.js
    • Add getDatastoreKeys.js
    • Add getDatastores.js
    • Add incrementDatstoreEntry.js
    • Add setDatastoreEntry.js

Enhancements

  • Fix getGameInstances by @popeeyy in #566
  • Draft fixes for #579 by @Chosey98 in #589
  • Uses Date objects for created and updated properties by @suufi in #587
  • getIdFromUsername can now return multiple IDs if provided multiple usernames (backward compatible) by @suufi in #587

🔩 Dependency Updates

Contributors

New Contributors

Authors

Full Changelog: v4.13.1...v4.14.0

Contributors

suufi, athammer, and 9 other contributors
Assets 2
Loading

v4.12.0: uploadAnimation, searchGroups & Bug fixes

23 Sep 22:32
@Neztore Neztore
v4.12.0
f45f10f
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v4.12.0: uploadAnimation, searchGroups & Bug fixes

🚀 Enhancement

🐛 Bug Fix

🏠 Internal

  • Try GITHUB_TOKEN (@Neztore)
  • Rename GitHub token env. variable (@suufi)
  • Use GH_TOKEN instead of GITHUB_TOKEN for auto #414 (@suufi)

🔩 Dependency Updates

Authors: 7

This should be the last of our manual releases. The versioning is due to our new auto-releaser getting a little confused.

Assets 2
Loading

v4.8.6: Method updates, documentation changes, and other fixes

19 Jun 00:58
@suufi suufi
v4.8.6
b9bc382
Compare
Choose a tag to compare
v4.8.6: Method updates, documentation changes, and other fixes

v4.8.6 involves a lot of documentation changes, dependency updates, and method updates.

Method updates:

  • Implement canManage (#350)
  • Implement getGroupGames (#345)
  • Implement getGroupRevenueSummary (#349)
  • Implement getJoinRequest
  • Implement setOptions (#361)
  • Implement social link methods (#366)
  • Improve error handling on unblock.js (#305)
  • Favor role.id over Role.ID with backwards compatibility (#311)
  • Set defaultDelay & onAuditLog delays at 10000ms (#355)

Documentation updates:

  • Transition to the noblox organization and adjust links accordingly (#339)
  • Update noblox.js-server link to use organization's
  • Add authenticationRequirements for methods (#343)
  • Update bracketed arrays for better documentation (#363)
  • Examples, documentation, and typings were updated in other PRs (#303, #309, #318)

+ dependency updates

Assets 2
Loading

v4.8.5: Method updates, dependency updates, and minor changes

26 Mar 13:11
@suufi suufi
v4.8.5
ec0b16e
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v4.8.5: Method updates, dependency updates, and minor changes

v4.8.5 corrects some broken things and introduces some new features as well as minor changes.

–––––––––––

  • Remove the cookie refresh warnings
  • Add YouTube series URL to the README.md

Method Updates:

  • Fix getGroups() TypeError (#299)
  • Alter promise.allSettled such that it supports more node versions (#254/#284)
  • Use v2 endpoint on getUserTransactions() (#296)
  • Implement getGroupFunds() (#301)
  • Add bust and headshot to getPlayerThumbnail() (#274)
Assets 2
Loading