Files
MercuryCloud_Dashboard/node_modules/@devnote-dev/pterojs/TODO.md
SavaletDev 9dfd50b963 Init
2022-04-22 23:02:19 +02:00

2.4 KiB

PteroJS Todo

Want to contribute? Familiar with JS? You're already halfway there. Below are things that need to be done for various parts of the module. See the contributing section to find out how to take part. 👍

Application

  • Setup connect() function (PteroApp)
  • Implement 201 and 204 response handling (RequestManager)
  • Implement helper functions for all the managers
  • Create and implement NestEggsManager

Client

  • Use typed ClientOptions for startup (PteroClient)
  • Setup connect() function (PteroClient)
  • Create and implement WebsocketManager
  • Rename endpoints in endpoints structure
  • Rewrite ServerManager with the correct server class (ServerManager)
  • Implement 201 and 204 response handling (RequestManager)
  • Implement helper functions for all the managers
  • Implement ClientUser required fetch on startup
  • Document all functions

Global Managers

  • Implement helper functions for all the managers
  • Create and implement all necessary submanagers (Dashflo)
  • Document all functions
  • Switch AllocationManager#cache to maps

Global Structures

  • Implement helper functions for all the structures
  • Figure out and implement a consistent management system for Permissions (Permissions)

Misc.

  • Add proper notes and annotations to JSDocs
  • Overall testing of the package (priority)
  • TypeScript support (index.d.ts)
  • Investigate incorrectly documented endpoints
  • Implement tests in /tests (or move from /test)

Feature Plans

  • Optional webhook client
  • Node status client
  • Data formatter interface client (may be updated to logging client)