feat: allow updating storeId after initialization

Author: rhamzeh

CHANGELOG.md

@@ -2,6 +2,6 @@
 
 ## v0.0.1
 
-### [0.0.1](https://github.com/openfga/js-sdk/releases/tag/v0.0.1) (2022-06-09)
+### [0.0.1](https://github.com/openfga/js-sdk/releases/tag/v0.0.1) (2022-06-15)
 
 Initial Release

README.md

@@ -116,7 +116,7 @@ You need your store id to call the OpenFGA API (unless it is to create a store o
 ```javascript
 const { stores } = await openFga.listStores();
 
-// stores = [{ "id": "1uHxCSuTP0VKPYSnkq1pbb1jeZw", "name": "OpenFGA Demo Store", "created_at": "2022-01-01T00:00:00.000Z", "updated_at": "2022-01-01T00:00:00.000Z" }]
+// stores = [{ "id": "01FQH7V8BEG3GPQW93KTRFR8JB", "name": "OpenFGA Demo Store", "created_at": "2022-01-01T00:00:00.000Z", "updated_at": "2022-01-01T00:00:00.000Z" }]
 ```
 
 #### Create Store
@@ -128,7 +128,7 @@ const { id: storeId } = await openFga.createStore({
   name: "OpenFGA Demo Store",
 });
 
-// storeId = "1uHxCSuTP0VKPYSnkq1pbb1jeZw"
+// storeId = "01FQH7V8BEG3GPQW93KTRFR8JB"
 ```
 
 #### Get Store
@@ -142,7 +142,7 @@ const store = await openFga.getStore({
   name: "OpenFGA Demo Store",
 });
 
-// stores = { "id": "1uHxCSuTP0VKPYSnkq1pbb1jeZw", "name": "OpenFGA Demo Store", "created_at": "2022-01-01T00:00:00.000Z", "updated_at": "2022-01-01T00:00:00.000Z" }
+// store = { "id": "01FQH7V8BEG3GPQW93KTRFR8JB", "name": "OpenFGA Demo Store", "created_at": "2022-01-01T00:00:00.000Z", "updated_at": "2022-01-01T00:00:00.000Z" }
 ```
 
 #### Delete Store

base.ts

@@ -46,4 +46,12 @@ export class BaseAPI {
 
     this.credentials = Credentials.init(this.configuration);
   }
+
+  public get storeId() {
+    return this.configuration.storeId;
+  }
+
+  public set storeId(storeId: string) {
+    this.configuration.storeId = storeId;
+  }
 }

configuration.ts

@@ -111,15 +111,15 @@ export class Configuration {
     this.apiHost = params.apiHost!;
     this.storeId = params.storeId!;
 
-    const credentialOpts = params.credentials;
+    const credentialParams = params.credentials;
 
-    if (credentialOpts) {
-      switch (credentialOpts?.method) {
+    if (credentialParams) {
+      switch (credentialParams?.method) {
       case CredentialsMethod.ApiToken:
         this.credentials = {
-          method: credentialOpts.method,
+          method: credentialParams.method,
           config: {
-            token: credentialOpts.config.token!,
+            token: credentialParams.config.token!,
             headerName: "Authorization",
             headerValuePrefix: "Bearer",
           }
@@ -129,11 +129,11 @@ export class Configuration {
         this.credentials = {
           method: CredentialsMethod.ClientCredentials,
           config: {
-            // We are enforcing that they exist here, but validating that they set later in isValid
-            clientId: credentialOpts.config.clientId,
-            clientSecret: credentialOpts.config.clientSecret,
-            apiAudience: credentialOpts.config.apiAudience,
-            apiTokenIssuer: credentialOpts.config.apiTokenIssuer,
+            // We are only copying them from the passed in params here. We will be validating that they are valid in the Credentials constructor
+            clientId: credentialParams.config.clientId,
+            clientSecret: credentialParams.config.clientSecret,
+            apiAudience: credentialParams.config.apiAudience,
+            apiTokenIssuer: credentialParams.config.apiTokenIssuer,
           }
         };
         break;
@@ -156,10 +156,11 @@ export class Configuration {
   }
 
   /**
-   * Ensures that the Configuration is valid
-   * @return boolean
+   *
+   * @return {boolean}
+   * @throws {FgaValidationError}
    */
-  public isValid() {
+  public isValid(): boolean {
     assertParamExists("Configuration", "apiScheme", this.apiScheme);
     assertParamExists("Configuration", "apiHost", this.apiHost);
 

credentials.ts

@@ -119,8 +119,11 @@ export class Credentials {
     }
   }
 
-
-  public isValid() {
+  /**
+   *
+   * @throws {FgaValidationError}
+   */
+  public isValid(): void {
     const { authConfig } = this;
     switch (authConfig?.method) {
     case CredentialsMethod.None:

tests/index.test.ts

@@ -219,7 +219,7 @@ describe("OpenFga SDK", function () {
       ).toThrowError();
     });
 
-    it("should not require clientId, clientSecret, apiTokenIssuer and apiAudience in configuration when not needed", () => {
+    it("should not require credentials in configuration when not needed", () => {
       expect(
         () =>
           new OpenFgaApi({
@@ -229,7 +229,20 @@ describe("OpenFga SDK", function () {
       ).not.toThrowError();
     });
 
-    it("should require clientId, clientSecret, apiTokenIssuer and apiAudience in configuration when needed", () => {
+    it("should require apiToken credentials in configuration in api_token flow", () => {
+      expect(
+        () =>
+          new OpenFgaApi({
+            storeId: baseConfig.storeId!,
+            apiHost: baseConfig.apiHost,
+            credentials: {
+              method: CredentialsMethod.ApiToken as any
+            }
+          })
+      ).toThrowError();
+    });
+
+    it("should require clientId, clientSecret, apiTokenIssuer and apiAudience credentials in configuration in client_credentials flow", () => {
       expect(
         () =>
           new OpenFgaApi({
@@ -332,6 +345,15 @@ describe("OpenFga SDK", function () {
       const configuration = new Configuration(baseConfig);
       expect(() => new OpenFgaApi(configuration)).not.toThrowError();
     });
+
+    it("should allow updating the storeId after initialization", async () => {
+      const openFgaApi = new OpenFgaApi({
+        apiHost: OPENFGA_API_HOST
+      });
+      expect(openFgaApi.storeId).toBe(undefined);
+      openFgaApi.storeId = OPENFGA_STORE_ID;
+      expect(openFgaApi.storeId).toBe(OPENFGA_STORE_ID);
+    });
   });
 
   describe("error handling", () => {