g.js-self icon indicating copy to clipboard operation
g.js-self copied to clipboard
verified publisher icon zaida04

The future of this project

Open zaida04 opened this issue 4 years ago • 1 comments

⚠️Read the most recent reply to this issue. The below plan is no longer in place.

As I'm sure you're aware, this repository and it's packages are currently for the Guilded *user API. I have been given Early Access to the bot API in order to adapt my library to the new bot API. Seeing that selfbots aren't necessarily outlawed on Guilded, support for the user API verison of this library will continue.

With this new API access, I will now be starting work on the next branch of this repo, which will include the following breaking changes:

  • current @guildedjs/guilded.js package will be renamed to @guildedjs/guilded.js-selfbot.
  • new package will be published under @guildedjs/guilded.js that covers the bot API. Will include the same caching, ws, events, and other mechanics that the old package had.
  • @guildedjs/rest will be adapted to work for both the bot API and the user API (atm it's literally just a fancy node-fetch wrapper with retry logic, which I'll have to rework for the bot API to take into account ratelimit headers).
  • user API typings in @guildedjs/guilded-api-typings will be moved to a user directory in that package, and the bot API typings will be in a bot dir with the API versions being separated by dirs with the appropriate version number (e.x. v1/, v2/).

This process will take weeks, maybe even months. There is no planned package release date. I have full permission from Guilded employees to publish my work on the bot API on GitHub.

zaida04 avatar Aug 06 '21 23:08 zaida04

After months of work on support for the bot API in a separate repo, I've come to the conclusion that we will no longer support the user API once the first release of the bot API comes out. The above plan is now defunct, with all the already published packages planned to be replaced with their bot API counterpart upon release. I will be archiving this repo when the time comes. I am currently working on bot API support available here https://github.com/guildedjs/guilded.js. This is only usable if you are in the early access for the API.

zaida04 avatar Feb 05 '22 19:02 zaida04