0.3.2

Version 0.3.2 has arrived! This version comes with lots of bug fixes and refactorisation. Please refer below for full changelogs.

API

• Handle other API errors (#60 by @reinhello)

Code

• Defer interactions correctly (#55 by @reinhello)
  • This fix has been called out multiple times but this should allow interactions to respond correctly and prevent most Discord errors.
• Remove old components (#57 by @reinhello)
  • As for now, BookmarkPaginator doesn't need any page navigation buttons.
• Remove all interactions respond being ephemeral (#56 by @reinhello)
  • interaction.defer() comes with no flag at all thus, adding the EPHEMERAL flag will be no use (This flag only applies to specific interaction responses)
• Refactor search results text format (#59 by @reinhello)
• Use Discord timestamp format for date (#62, #63 by @reinhello)
• Remove main.search.titles on embed description (#64 by @reinhello)
  • I don't think this is necessary at all.
• Set bookmark limit to maximum of 25 (#66 by @reinhello)

Localisation

• Remove unused localisations (#65 by @reinhello)
• Add new localisations (#67 by @reinhello)

Full Changelog: 0.3.1...0.3.2

0.3.1

Version 0.3.1 has arrived! This version comes with bug fixes that unexpectedly occurred after the previous version was released. Hopefully, this fixes most issues! Please refer below for full changelogs

API

Code

• Defer interaction for /bookmark command (#44 by @reinhello)
  • interaction.defer() has been removed for most commands as it'll only break the bot (#47 by @reinhello)
• Update the READMEs content (#45 by @reinhello)

Database

• Refactor Schema type (#48 by @reinhello)
• Fix duplicate guilds are created in the database (#50 by @reinhello)
  • This was affected by automatic slash commands registration.

Discord

• Fix /bookmark command unable to fetch user passed parameter (#49 by @reinhello)
  • Interaction has been acknowledged error has also been fixed when the user's bookmark is empty

Localisation

• Add the Chinese localisations (#46 by @reinhello)

Web Dashboard

Full Changelog: 0.3.0...0.3.1

0.3.0

Major version 0.3.0 has arrived! This is not a real major change however, this includes a rename of Reader to NReader to reduce the confusion of the name.

What's Changed

• Update Metadata (#43 by @reinhello)

Full Changelog: 0.2.4...0.3.0

0.2.4

Version 0.2.4 has arrived! These changes include localisation additions (with fixes), API fixes, and one of the major updates which is tags restriction. Please refer below for full changelogs.

API

• Refactor API error handling (#37 by @reinhello)
  • Error embed message will the display by the bot when an error is encountered

Code

• Don't display restricted tags (#39 by @reinhello)
• Fix cannot read embeds of undefined error upon multiple searches and bookmark fetching (#40, #42 by @reinhello)

Database

• Add settings.blacklisted and settings.whitelisted field on Guild model (#39 by @reinhello)
  • Used for tags restriction

Discord

Localisation

• Add new localisation strings (#36, #41 by @reinhello)
• Fix Japanese localisation strings (#38 by @reinhello)

Web Dashboard

Full Changelog: 0.2.3...0.2.4

0.2.3

Version 0.2.3 has arrived! These small changes include minor fixes to the code. A new /stats slash command has also been added. Please refer below for full changelogs.

API

Code

• Add /stats slash command (#34 by @reinhello)
• Code cleanup (#35 by @reinhello)
  • Includes ESLint and Prettier fixes
  • Typing fixes on Util.bytesToSize

Database

Discord

• Add new /stats slash command (#34 by @reinhello)
  • Shows the bot's statistics. More stats will be displayed in future versions.

Localisation

• Add new localisation strings (#33 by @reinhello)
  • New localisation for /stats slash command

Web Dashboard

Full Changelog: 0.2.2...0.2.3

0.2.2

Version 0.2.2 has arrived! These changes include new commands added, several minor fixes and new system logic implementation. Please refer below for full changelogs.

API

• Remove public cf_clearance token (#29 by @reinhello)
  • Cookie is now placed inside the config.json file

Code

• Code cleanup (#28 by @reinhello)
• Add permission level checks on slash commands (#31 by @reinhello)
  • Permission levels are now correctly input to slash commands
• Fix code typo (#32 by @reinhello)

Database

• Fix Mongoose buffering timeout error (#25 by @reinhello)

Discord

• Add bookmark slash command (#27 by @reinhello)
• Add guildCreate event (#30 by @reinhello)

Localisation

• Add new localisations for bookmark command (#26 by @reinhello)
• Add new localisations for no permissions (#31 by @reinhello)

Web Dashboard

Full Changelog: 0.2.1...0.2.2

0.2.1

Version 0.2.1 has arrived! These changes include fixes and new features. Please refer to below for full changelogs.

API

• Update the local cf_clearance cookie (#20 by @reinhello)

Code

• Add running property on the paginator classes (#17 by @reinhello)
  • Used to prevent bookmark crash when both ReadSearchPaginator and SearchPaginator are active at the same time
• Fix ICommand.options wrong typing input (#19 by @reinhello)
• Add Util class (#22 by @reinhello)

Database

Discord

• Add config slash command (#23 by @reinhello)
  • More options will be delivered soon

Localisation

• Update Japanese localisations (#18 by @reinhello)
  • Fix parody original word not localised properly
• Add new localisation strings (#21 by @reinhello)

Web Dashboard

Full Changelog: 0.2.0...0.2.1

0.2.0

Major version 0.2.0 for Reader is here! These significant changes only include fixes from the previous version and improvements. As for new upcoming features that have been planned, I'll ensure they'll be added soon.

• All changes can be found in #16 (by @reinhello)

API

• Fix API Cloudflare ban
  • This is a temporary fix suggested by the library maintainer
• Uses cf_clearance cookie to bypass Cloudflare (see above)

Code

Refactor the entire project structure base.

Folders are now divided into their own category usage

• bot folder consists of the main bot to connect to Discord
• config folder consists of all secret configuration value
• framework folder consists of the bot's entire logic implementation that'll be called inside the bot folder
  • Changes are expected to be done in the framework
• localisation folder consists of all localisation sources

Refactor logging output

Logging output will return as fancy as possible and contains extra detail of the output

---

• Fix some ESLint rules
• Fix wrong typing
• Interfaces and types are now separated into their own directory and file for global usage

Database

• Migrate the database from SQLite3 to MongoDB
• Set the default user reading state to current instead of new
  • This might be removed due to a bug issue later

Discord

• Migrate all normal commands to slash commands

  • bookmark command hasn't been added yet
  • recent command has been fully removed. Use search instead

• Message Content gateway event will no longer be required in future versions

Localisation

• Refactor localisation source files
  • Now using ReaderClient#translate(key: string)
• Separate localisation keys based on the category

Web Dashboard

• Dashboard has been fully removed and planned for a proper rewrite

Full Changelog: 0.1.4...0.2.0

0.1.4

0.1.4 Update

Fixes various bugs and added new awesome additional features.

Changes

• Changelogs can be seen Here (#2)

Contributors

• @reinhello (Project Lead, Contributor)