API v2

[lamadaemon]

Overall

A new API structure is here! This update will BREAK existing code!

The purpose of this update is to support editing save without any online features, and also decrease code coupling by moving online save management features into another class. The original PhigrosSave class will be preserved and will have breaking changes to online features. Another benefit is to be able to add tests without a valid token. In the current version, I didn't write too many tests because PhigrosSave requires a token and can't parse save files fully offline.

This update will be released after a full change log has published at here and all features has been tested out. However, as I mentioned in another issue, I don't have many different accounts and I am not a very active phigros player, so phigros-save-manager may not be very stable for a short period of time depending on feedbacks by users.

A CLI update is planned but has a low priority and will not be in this update.

Changes to the current API

Private members are not included in this change list

• PhigrosSaveManager.loadLocalSave no longer takes a token argument
• PhigrosSave no longer handles cloud save download / upload
  • all existing functions no longer to be async
  • init function removed
  • loadSave function removed
  • backup function removed
  • readRemoteSaves function removed
  • downloadSave function removed
  • uploadSave function removed
  • refreshToken function removed
• Introduce PhigrosCloudServiceAPI
• PhigrosBinaryFile now handles encryption and decryption
  • BinaryLoadConfig added as the third optional argument in constructor
• PhigrosSaveManager.encrypt is no longer async and supports custom version number
• PhigrosSaveManager.decrypt is no longer async

TODOs

• [ ] New user guide
• [ ] New developer's guide
• [x] Further tests
• [x] Make decryption part of PhigrosBinaryFile
• [x] Even more tests

[lamadaemon]

After this gets done and merged, I will rename the default branch from main to master. This is because I forgot to change the default branch to master when I created this account. I have been typing master so many times when I work on this project, and now, it is a great opportunity to fix this. Please be aware of this branch name change in the short future.