chore: Bump js-client-sdk-common dep to pick up new getBooleanAssignment API (#77)

* chore: Bump js-client-sdk-common to pick up new `getBooleanAssignment` API

* version bump

* Call correct super method

Author: felipecsl

.gitignore

@@ -10,3 +10,6 @@ yarn-error.log
 test/data
 
 .eslintcache
+
+# IntelliJ generated files
+.idea/

README.md

@@ -17,7 +17,7 @@
 
 ## Installation
 
-```javascript
+```bash
 npm install @eppo/js-client-sdk
 ```
 
@@ -53,7 +53,7 @@ const variation = eppoClient.getBooleanAssignment('show-new-feature', user.id, {
 Every Eppo flag has a return type that is set once on creation in the dashboard. Once a flag is created, assignments in code should be made using the corresponding typed function: 
 
 ```javascript
-getBoolAssignment(...)
+getBooleanAssignment(...)
 getNumericAssignment(...)
 getIntegerAssignment(...)
 getStringAssignment(...)

docs/js-client-sdk.eppojsclient.getbooleanassignment.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [EppoJSClient](./js-client-sdk.eppojsclient.md) &gt; [getBooleanAssignment](./js-client-sdk.eppojsclient.getbooleanassignment.md)
+
+## EppoJSClient.getBooleanAssignment() method
+
+**Signature:**
+
+```typescript
+getBooleanAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, any>, defaultValue: boolean): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  flagKey | string |  |
+|  subjectKey | string |  |
+|  subjectAttributes | Record&lt;string, any&gt; |  |
+|  defaultValue | boolean |  |
+
+**Returns:**
+
+boolean
+

docs/js-client-sdk.eppojsclient.md

@@ -25,6 +25,7 @@ export declare class EppoJSClient extends EppoClient
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [getBoolAssignment(flagKey, subjectKey, subjectAttributes, defaultValue)](./js-client-sdk.eppojsclient.getboolassignment.md) |  |  |
+|  [getBooleanAssignment(flagKey, subjectKey, subjectAttributes, defaultValue)](./js-client-sdk.eppojsclient.getbooleanassignment.md) |  |  |
 |  [getIntegerAssignment(flagKey, subjectKey, subjectAttributes, defaultValue)](./js-client-sdk.eppojsclient.getintegerassignment.md) |  |  |
 |  [getJSONAssignment(flagKey, subjectKey, subjectAttributes, defaultValue)](./js-client-sdk.eppojsclient.getjsonassignment.md) |  |  |
 |  [getNumericAssignment(flagKey, subjectKey, subjectAttributes, defaultValue)](./js-client-sdk.eppojsclient.getnumericassignment.md) |  |  |

js-client-sdk.api.md

@@ -31,6 +31,8 @@ export class EppoJSClient extends EppoClient {
     // (undocumented)
     getBoolAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, any>, defaultValue: boolean): boolean;
     // (undocumented)
+    getBooleanAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, any>, defaultValue: boolean): boolean;
+    // (undocumented)
     getIntegerAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, any>, defaultValue: number): number;
     // (undocumented)
     getJSONAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, any>, defaultValue: object): object;
@@ -51,6 +53,8 @@ export { IAssignmentEvent }
 
 export { IAssignmentLogger }
 
+export { IAsyncStore }
+
 // @public
 export interface IClientConfig {
     apiKey: string;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eppo/js-client-sdk",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "Eppo SDK for client-side JavaScript applications",
   "main": "dist/index.js",
   "files": [
@@ -58,7 +58,7 @@
     "webpack-cli": "^4.10.0"
   },
   "dependencies": {
-    "@eppo/js-client-sdk-common": "3.0.8",
+    "@eppo/js-client-sdk-common": "3.1.0",
     "md5": "^2.3.0"
   }
-}
+}

src/index.ts

@@ -94,7 +94,9 @@ export {
 export { ChromeStorageAsyncStore } from './chrome.configuration-store';
 
 // Instantiate the configuration store with memory-only implementation.
-const configurationStore = configurationStorageFactory({ forceMemoryOnly: true });
+const configurationStore = configurationStorageFactory({
+  forceMemoryOnly: true,
+});
 
 /**
  * Client for assigning experiment variations.
@@ -117,14 +119,26 @@ export class EppoJSClient extends EppoClient {
     return super.getStringAssignment(flagKey, subjectKey, subjectAttributes, defaultValue);
   }
 
+  /**
+   * @deprecated Use getBooleanAssignment instead
+   */
   public getBoolAssignment(
     flagKey: string,
     subjectKey: string,
     subjectAttributes: Record<string, any>,
     defaultValue: boolean,
+  ): boolean {
+    return this.getBooleanAssignment(flagKey, subjectKey, subjectAttributes, defaultValue);
+  }
+
+  public getBooleanAssignment(
+    flagKey: string,
+    subjectKey: string,
+    subjectAttributes: Record<string, any>,
+    defaultValue: boolean,
   ): boolean {
     EppoJSClient.getAssignmentInitializationCheck();
-    return super.getBoolAssignment(flagKey, subjectKey, subjectAttributes, defaultValue);
+    return super.getBooleanAssignment(flagKey, subjectKey, subjectAttributes, defaultValue);
   }
 
   public getIntegerAssignment(
@@ -179,7 +193,7 @@ export async function init(config: IClientConfig): Promise<IEppoClient> {
     }
 
     // Set the configuration store to the desired persistent store, if provided.
-    // Otherwise the factory method will detect the current environment and instantiate the correct store.
+    // Otherwise, the factory method will detect the current environment and instantiate the correct store.
     const configurationStore = configurationStorageFactory(
       {
         persistentStore: config.persistentStore,

yarn.lock

@@ -380,10 +380,10 @@
   resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz#1d572bfbbe14b7704e0ba0f39b74815b84870d70"
   integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==
 
-"@eppo/js-client-sdk-common@3.0.8":
-  version "3.0.8"
-  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-3.0.8.tgz#738c67c2ae95d4c8b8b84cd8625ff010e11ac6cc"
-  integrity sha512-Qe7O78Pt2PYyTXMLYQMoGyv0aOu5NdXsO1VWBCjA6aUqkWKyy4etyMy1BXpwsbxH6kvKq1uwTJO19N7zoCVFlQ==
+"@eppo/js-client-sdk-common@3.1.0":
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-3.1.0.tgz#3958fa591d8e5b4026b1e58de86eb9865a2751e7"
+  integrity sha512-r/zHyE60QlIBEq91o/0PQud0fbLKqN1s8FDvN9OWjYEJx8XAUyYAx+rivAGycxwqU76TV1y8EUCOMFYvAVR1Jg==
   dependencies:
     md5 "^2.3.0"
     pino "^8.19.0"