Announcing JS SDK v0.2.4 with a new OpenFgaClient

[rhamzeh]

Hey folks!

We've just released v0.2.4 of the JS SDK with one noteworthy enhancement: the OpenFgaClient.

Our aim is to be able to make OpenFgaApi no longer be the main way users interface with the SDK, allow it to more closely stick to the API interfaces, and use OpenFgaClient as a wrapper on top of that to provide additional functionality and giving us the freedom to drive more change on the SDK side.

You can read the full proposal here.

The JS SDK OpenFgaClient is a start, we're planning for this to go into the Go, .NET and Python SDKs.

Take a look at the following links for an overview of the changes:

• https://github.com/openfga/js-sdk#initializing-the-api-client
• https://github.com/openfga/js-sdk#calling-the-api

In particular you will notice:

• The addition of batchCheck - this is a utility method that wraps check and provides a client side way of calling check on multiple items at once.
• Write has been expanded client side to support non-transactional writes. Note that this is handled by issuing multiple writes in parallel.

The SDK has some sane defaults on chunking and sleep between requests to deter any issues with rate limits, you will be able to override them to values that work better for your use-cases.

Note that the interface for the OpenFgaClient might change over the next couple of weeks as we get your feedback, as always while under 1.0.0, breaking changes will see a bump in the minor version (0.x.0).

You can still use the OpenFgaApi class, and documentation for it can be found here.

Check it out and do let us know your feedback!

---

A summary of the changes introduced in v0.2.3 and v0.2.4:

• feat(client): client wrapper with a slightly changed interface
• feat(client): implement batchCheck to check multiple tuples in parallel
• feat(client): add support for a non-transactional Write
• feat(client): implement sleep in batch calls to lower the possibility of hitting rate limits
• fix(client): OpenFgaClient read was not passing in pagination options
• fix: retry on 5xx errors
• chore(config): bump default max retries to 5
• chore!: request Node >= 14.7.0