release: v0.4.0 with ListUsers support

.github/dependabot.yaml

@@ -8,8 +8,6 @@ updates:
      dependencies:
         patterns:
           - "*"
-        exclude-patterns:
-          - "eslint"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
@@ -18,3 +16,5 @@ updates:
      dependencies:
         patterns:
           - "*"
+        exclude-patterns:
+          - "eslint"

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v0.4.0
+
+### [0.4.0](https://github.com/openfga/js-sdk/compare/v0.3.5...v0.4.0) (2024-04-30)
+
+- feat: support the [ListUsers](https://github.com/openfga/rfcs/blob/main/20231214-listUsers-api.md) endpoint (#97)
+- feat!: support overriding storeId per request (#97)
+    `OpenFgaClient` now supports specifying the storeId in the options to override it per request
+
+    [BREAKING CHANGE] the underlying `OpenFgaApi` now expects `storeId` as the first param on relevant methods,
+    if you are still using this class, make sure you update your references when needed.
+
 ## v0.3.5
 
 ### [0.3.5](https://github.com/openfga/js-sdk/compare/v0.3.4...v0.3.5) (2024-03-19)

README.md

@@ -463,7 +463,7 @@ const { responses } = await fgaClient.batchCheck([{
   user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
   relation: "viewer",
   object: "document:roadmap",
-  contextualTuples: [{
+  contextual_tuples: [{
     user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     relation: "writer",
     object: "document:roadmap"
@@ -492,7 +492,7 @@ responses = [{
     user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     relation: "viewer",
     object: "document:roadmap",
-    contextualTuples: [{
+    contextual_tuples: [{
       user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
       relation: "writer",
       object: "document:roadmap"
@@ -538,7 +538,7 @@ const response = await fgaClient.listObjects({
   user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
   relation: "viewer",
   type: "document",
-  contextualTuples: [{
+  contextual_tuples: [{
     user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     relation: "writer",
     object: "document:budget"
@@ -564,7 +564,7 @@ const response = await fgaClient.listRelations({
   user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
   object: "document:roadmap",
   relations: ["can_view", "can_edit", "can_delete"],
-  contextualTuples: [{
+  contextual_tuples: [{
     user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     relation: "writer",
     object: "document:roadmap"

configuration.ts

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

example/README.md

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

example/example1/package.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfga/sdk",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "description": "JavaScript and Node.js SDK for OpenFGA",
   "author": "OpenFGA",
   "keywords": [