feat: getExperimentContainerEntry a helper function for CMS app integration (#97)

feat: getExperimentContainerEntry helper function for CMS app integration

Author: greghuels

docs/js-client-sdk.iclientconfig.forcereinitialize.md

@@ -0,0 +1,13 @@
+<!-- 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; [IClientConfig](./js-client-sdk.iclientconfig.md) &gt; [forceReinitialize](./js-client-sdk.iclientconfig.forcereinitialize.md)
+
+## IClientConfig.forceReinitialize property
+
+Force reinitialize the SDK if it is already initialized.
+
+**Signature:**
+
+```typescript
+forceReinitialize?: boolean;
+```

docs/js-client-sdk.iclientconfig.md

@@ -19,6 +19,7 @@ export interface IClientConfig
 |  [apiKey](./js-client-sdk.iclientconfig.apikey.md) |  | string | Eppo API key |
 |  [assignmentLogger](./js-client-sdk.iclientconfig.assignmentlogger.md) |  | IAssignmentLogger | Pass a logging implementation to send variation assignments to your data warehouse. |
 |  [baseUrl?](./js-client-sdk.iclientconfig.baseurl.md) |  | string | _(Optional)_ Base URL of the Eppo API. Clients should use the default setting in most cases. |
+|  [forceReinitialize?](./js-client-sdk.iclientconfig.forcereinitialize.md) |  | boolean | _(Optional)_ Force reinitialize the SDK if it is already initialized. |
 |  [maxCacheAgeSeconds?](./js-client-sdk.iclientconfig.maxcacheageseconds.md) |  | number | _(Optional)_ Maximum age, in seconds, previously cached values are considered valid until new values will be fetched (default: 0) |
 |  [numInitialRequestRetries?](./js-client-sdk.iclientconfig.numinitialrequestretries.md) |  | number | _(Optional)_ Number of additional times the initial configuration request will be attempted if it fails. This is the request typically synchronously waited (via await) for completion. A small wait will be done between requests. (Default: 1) |
 |  [numPollRequestRetries?](./js-client-sdk.iclientconfig.numpollrequestretries.md) |  | number | _(Optional)_ Number of additional times polling for updated configurations will be attempted before giving up. Polling is done after a successful initial request. Subsequent attempts are done using an exponential backoff. (Default: 7) |

js-client-sdk.api.md

@@ -92,6 +92,7 @@ export interface IClientConfig {
     apiKey: string;
     assignmentLogger: IAssignmentLogger;
     baseUrl?: string;
+    forceReinitialize?: boolean;
     maxCacheAgeSeconds?: number;
     numInitialRequestRetries?: number;
     numPollRequestRetries?: number;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eppo/js-client-sdk",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "description": "Eppo SDK for client-side JavaScript applications",
   "main": "dist/index.js",
   "files": [
@@ -59,6 +59,6 @@
     "webpack-cli": "^4.10.0"
   },
   "dependencies": {
-    "@eppo/js-client-sdk-common": "4.0.0"
+    "@eppo/js-client-sdk-common": "4.2.0"
   }
 }

src/index.ts

@@ -12,6 +12,7 @@ import {
   IAssignmentDetails,
   BanditActions,
   BanditSubjectAttributes,
+  IContainerExperiment,
 } from '@eppo/js-client-sdk-common';
 
 import { assignmentCacheFactory } from './cache/assignment-cache-factory';
@@ -303,6 +304,15 @@ export class EppoJSClient extends EppoClient {
     );
   }
 
+  public getExperimentContainerEntry<T>(
+    flagExperiment: IContainerExperiment<T>,
+    subjectKey: string,
+    subjectAttributes: Record<string, AttributeType>,
+  ): T {
+    EppoJSClient.getAssignmentInitializationCheck();
+    return super.getExperimentContainerEntry(flagExperiment, subjectKey, subjectAttributes);
+  }
+
   private static getAssignmentInitializationCheck() {
     if (!EppoJSClient.initialized) {
       applicationLogger.warn('Eppo SDK assignment requested before init() completed');

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@4.0.0":
-  version "4.0.0"
-  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-4.0.0.tgz#39dea02745b641915fa4e925d75a12ca5b1e9503"
-  integrity sha512-aMru8KESyNJDU/fm5jVENUhpa1jB88FUncT/xnjgiWPuTLLrpi10Qshoj7Lloi8IjlwFSFMjDjtpuQoLKPpQXA==
+"@eppo/js-client-sdk-common@4.2.0":
+  version "4.2.0"
+  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-4.2.0.tgz#713910bf7c5291300d48b408bced995ae00e2834"
+  integrity sha512-DzT3q1jwpb8yEgKLtPzCxaW6X+rUmYuX5jnGqPzLM2WDlfZ0rkUdDqBt9lzw76DkSZu+C7dpzHcH9EnWuDms8w==
   dependencies:
     js-base64 "^3.7.7"
     md5 "^2.3.0"