feat(v3.0.0): add V3 REST APIs & WebSockets. add RSA support. Move to Web Crypto API for sign. Publish Hybrid CJS/ESM module.

[tiagosiebler]

Summary

• Add full support for all V3 / Unified Trading Account APIs:
  • REST APIs
  • WebSocket consumers
  • WebSocket APIs (via dedicated WebsocketAPIClient class)
• Upgrade underlying BaseWSClient architecture, to catch up with upgrades from other SDKs.
• Backwards compatible V1 & V2, REST APIs & WebSockets.
• Transition to Web Crypto API for sign. This has better compatibility across browsers than node's native crypto module. For latency sensitive users, you can inject a custom sign method to continue using Node's native crypto for request sign. See the examples/auth/fasterHmacSign.ts example for a demonstration.
• Add support for RSA keys, for REST & WebSockets.
• Add full support for demo trading APIs & WebSockets. Simply set demoTrading: true in the REST or WS Client.
• SDK will be published as hybrid ESM/CJS module. No breaking changes expected from this transition. See Upgrade SDK to hybrid esm/cjs module #81 for changelog.

Breaking Changes

• The original V1 WebsocketClient has been renamed to WebsocketClientLegacyV1.
  • If available, users should upgrade to using the UTA/V3 WebSockets.
  • V2 WebSockets (via WebsocketClientV2) can be used if you are not ready to upgrade your account to Bitget's Unified Trading Account.
• The WebsocketClient's requestOptions parameter now represents RestClientOptions, consistent with our other SDKs.
  • The "agent" parameter for WS Client is now available under separate wsOptions object in WSClientConfigurableOptions.
• The injectable custom logger has been simplified to 3 basic logging levels, consistent with our other SDKs.
• Not a breaking change but the underlying sign is now generated using Web Crypto API. More universal but slightly slower than node's native crypto module. Refer to fasterHmacSign above, if you're latency sensitive.

Additional Information

PR Checklist

As part of the PR, make sure you have:

• No breaking changes / documented all breaking changes clearly.
• Updated & checked that all tests pass.
• Updated the endpoint map (optional, if you know how).
• Increased the version number in the package.json
• Checked npm install runs without issue.
• Included the package-lock.json, if it changed after npm install
• Checked npm run build runs without issue.