json-rpc-engine/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Added

• isJsonRpcSuccess and isJsonRpcFailure type guard utilities (#91)
• JSON-RPC ID validation utility and type guard, via getJsonRpcIdValidator (#91)

Changed

• (BREAKING) Return a null instead of undefined response id for malformed request objects (#91)
  • This is very unlikely to be breaking in practice, but the behavior could have been relied on.

6.1.0 - 2020-11-20

Added

• Add PendingJsonRpcResponse interface for use in middleware (#75)

Changed

• Use async/await and try/catch instead of Promise methods everywhere (#74)
  • Consumers may notice improved stack traces on certain platforms.

6.0.0 - 2020-11-19

Added

• Add docstrings for public JsonRpcEngine methods (#70)

Changed

• (BREAKING) Refactor exports (#69)
  • All exports are now named, and available via the package entry point.
  • All default exports have been removed.
• (BREAKING) Convert asMiddleware to instance method (#69)
  • The asMiddleware export has been removed.
• (BREAKING) Add runtime typechecks to JsonRpcEngine.handle(), and error responses if they fail (#70)
  • Requests will now error if:
    • The request is not a plain object, or if the method property is not a string. Empty strings are allowed.
    • A next middleware callback is called with a truthy, non-function parameter.
• Migrate to TypeScript (#69)
• Hopefully improve stack traces by removing uses of Promise.then and .catch internally (#70)
• Make some internal JsonRpcEngine methods static (#71)

5.4.0 - 2020-11-07

Changed

• Make the TypeScript types not terrible (#66, #67)

5.3.0 - 2020-07-30

Changed

• Response object errors no longer include a stack property

5.2.0 - 2020-07-24

Added

• Promise signatures for engine.handle (#55)
  • So, in addition to engine.handle(request, callback), you can do e.g. await engine.handle(request).

Changed

• Remove async and promise-to-callback dependencies
  • These dependencies were used internally for middleware flow control. They have been replaced with Promises and native async/await, which means that some operations are no longer eagerly executed. This change may affect consumers that depend on the eager execution of middleware during request processing, outside of middleware functions and request handlers.
    • In general, it is a bad practice to work with state that depends on middleware execution, while the middleware are executing.