release: v0.8.0

Author: rhamzeh

CHANGELOG.md

@@ -1,16 +1,25 @@
 # Changelog
 
 
-## [Unreleased](https://github.com/openfga/js-sdk/compare/v0.7.0...HEAD)
+## [Unreleased](https://github.com/openfga/js-sdk/compare/v0.8.0...HEAD)
 
-- fix: error correctly if apiUrl is not provided (#161)
-- feat: add support for `start_time` parameter in `ReadChanges` endpoint
-- BREAKING: As of this release, the min node version required by the SDK is now v16.15.0
-- feat!: add support for server-side `BatchCheck` method.
+## v0.8.0
 
-BREAKING CHNAGES:
+### [0.8.0](https://github.com/openfga/js-sdk/compare/v0.7.0...v0.8.0) (2025-01-14)
 
-- The minimum noce version required by this SDK is now v16.15.0
+- feat!: add support for server-side `BatchCheck` method. This is a more efficient way to check on multiple tuples than calling the existing client-side `BatchCheck`. Using this method requires an OpenFGA [v1.8.0+](https://github.com/openfga/openfga/releases/tag/v1.8.0) server.
+    - The existing `BatchCheck` method has been renamed to `clientBatchCheck` and it now bundles the results in a field called `result` instead of `responses`.
+    - The existing `BatchCheckResponse` has been renamed to `ClientBatchCheckResponse`.
+- feat: add support for  startTime` parameter in `ReadChanges` endpoint
+- feat: support contextual tuples and context in assertions
+- feat: support contextual tuples in Expand
+- fix: error correctly if apiUrl is not provided - thanks @Waheedsys (#161)
+- fix: use provided axios instance in credentials refresh - thanks @Siddhant-K-code (#193)
+- fix!: The minimum node version required by this SDK is now v16.15.0
+- chore(docs): various cleanup and improvements - thanks @tmsagarofficial (#164), @vil02 (https://github.com/openfga/sdk-generator/pull/424, https://github.com/openfga/sdk-generator/pull/422), @sccalabr (https://github.com/openfga/sdk-generator/pull/433)
+
+BREAKING CHANGES:
+- The minimum node version required by this SDK is now v16.15.0
 - Usage of the existing `batchCheck` method should now use the `clientBatchCheck` method. The existing `BatchCheckResponse` has been renamed to `ClientBatchCheckResponse` and it now bundles the results in a field called `result` instead of `responses`.
 
 ## v0.7.0

configuration.ts

@@ -22,7 +22,7 @@ const DEFAULT_MAX_RETRY = 3;
 // default minimum wait period in retry - but will backoff exponentially
 const DEFAULT_MIN_WAIT_MS = 100;
 
-const DEFAULT_USER_AGENT = "openfga-sdk js/0.7.0";
+const DEFAULT_USER_AGENT = "openfga-sdk js/0.8.0";
 
 export interface RetryParams {
   maxRetry?: number;
@@ -75,7 +75,7 @@ export class Configuration {
    * @type {string}
    * @memberof Configuration
    */
-  private static sdkVersion = "0.7.0";
+  private static sdkVersion = "0.8.0";
 
   /**
    * provide the full api URL (e.g. `https://api.fga.example`)

example/README.md

@@ -31,7 +31,7 @@ Steps
 2. In the Example `package.json` change the `@openfga/sdk` dependency from a semver range like below
 ```json
 "dependencies": {
-    "@openfga/sdk": "^0.7.0"
+    "@openfga/sdk": "^0.8.0"
   }
 ```
 to a `file:` reference like below

example/example1/package.json

@@ -9,7 +9,7 @@
     "start": "node example1.mjs"
   },
   "dependencies": {
-    "@openfga/sdk": "^0.7.0"
+    "@openfga/sdk": "^0.8.0"
   },
   "engines": {
     "node": ">=16.13.0"