@statsig/client-core 0.0.1-beta.6 → 0.0.1-beta.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/client-core",
-  "version": "0.0.1-beta.6",
+  "version": "0.0.1-beta.7",
   "dependencies": {},
   "type": "commonjs",
   "main": "./src/index.js",

package/src/ClientInterfaces.d.ts

@@ -4,7 +4,8 @@ import { StatsigEvent } from './StatsigEvent';
 import { DynamicConfig, Experiment, FeatureGate, Layer } from './StatsigTypes';
 import { StatsigUser } from './StatsigUser';
 export interface StatsigClientCommonInterface extends StatsigClientEventEmitterInterface {
-    initialize(): void;
+    initializeSync(): void;
+    initializeAsync(): Promise<void>;
     shutdown(): Promise<void>;
 }
 export interface OnDeviceEvaluationsInterface extends StatsigClientCommonInterface {
@@ -17,7 +18,8 @@ export interface OnDeviceEvaluationsInterface extends StatsigClientCommonInterfa
 }
 export interface PrecomputedEvaluationsInterface extends StatsigClientCommonInterface {
     getCurrentUser(): StatsigUser;
-    updateUser(user: StatsigUser): void;
+    updateUserSync(user: StatsigUser): void;
+    updateUserAsync(user: StatsigUser): Promise<void>;
     checkGate(name: string, options: EvaluationOptions): boolean;
     getFeatureGate(name: string, options: EvaluationOptions): FeatureGate;
     getDynamicConfig(name: string, options: EvaluationOptions): DynamicConfig;

package/src/StatsigClientBase.js

@@ -63,8 +63,7 @@ var StatsigClientBase = /** @class */ (function () {
         this._logger.enqueue(exposure);
     };
     StatsigClientBase.prototype._runPostUpdate = function (current, user) {
-        var _a, _b;
-        (_b = (_a = this._adapter).handlePostUpdate) === null || _b === void 0 ? void 0 : _b.call(_a, current, user).catch(function (err) {
+        this._adapter.getDataAsync(current, user).catch(function (err) {
             Log_1.Log.error('An error occurred after update.', err);
         });
     };

package/src/StatsigDataAdapter.d.ts

@@ -1,10 +1,22 @@
 import { StatsigOptionsCommon } from './StatsigOptionsCommon';
 import { StatsigUser } from './StatsigUser';
-export type DataSource = 'Uninitialized' | 'Loading' | 'NoValues' | 'Cache' | 'Network' | 'NetworkNotModified' | 'Bootstrap' | 'Prefetch';
+export type DataSource = 'Uninitialized' | 'Loading' | 'NoValues' | 'Cache' | 'Network' | 'NetworkNotModified' | 'Bootstrap';
 export type StatsigDataAdapterResult = {
     readonly source: DataSource;
     readonly data: string;
 };
+/**
+ * Describes a type that is used during intialize/update operations of a Statsig client.
+ *
+ * See below to find the default adapters, but know that it is possible to create your
+ * own StatsigDataAdapter and provide it via {@link StatsigOptions.dataAdapter}.
+ *
+ * Defaults:
+ *
+ * - {@link PrecomputedEvaluationsClient} uses {@link EvaluationsDataAdapter}
+ *
+ * - {@link OnDeviceEvaluationsClient} uses {@link SpecsDataAdapter}
+ */
 export type StatsigDataAdapter = {
     /**
      * Called when the StatsigDataAdapter is attached to the Statsig client instance during construction.
@@ -13,15 +25,16 @@ export type StatsigDataAdapter = {
      */
     readonly attach: (sdkKey: string, options: StatsigOptionsCommon | null) => void;
     /**
-     * Synchronously get data for the given user (if any). Called during initialization and updates.
+     * Synchronously get data for the given user (if any). Called during initializeSync and/or updateUserSync.
+     * It is also called during async update operations before StatsigDataAdapter.getDataAsync is called.
      * @param {StatsigUser | undefined} user The StatsigUser to get data for.
      * @returns {StatsigDataAdapterResult | null} The data that was found for the given StatsigUser.
      */
-    readonly getData: (user?: StatsigUser) => StatsigDataAdapterResult | null;
+    readonly getDataSync: (user?: StatsigUser) => StatsigDataAdapterResult | null;
     /**
-     *
-     * @param {StatsigDataAdapterResult | null} result The values that were found and applied during initialization or update.
-     * @param {StatsigUser | undefined} user The StatsigUser object that was used.
+     * Asynchronously get data for the given user (if any). Called during initializeAsync and/or updateUserAsync.
+     * @param {StatsigUser | undefined} user The StatsigUser to get data for.
+     * @returns {StatsigDataAdapterResult | null} The data that was found for the given StatsigUser.
      */
-    readonly handlePostUpdate: (result: StatsigDataAdapterResult | null, user?: StatsigUser) => Promise<void>;
+    readonly getDataAsync: (current: StatsigDataAdapterResult | null, user?: StatsigUser) => Promise<StatsigDataAdapterResult | null>;
 };

package/src/StatsigMetadata.js

@@ -12,7 +12,7 @@ var __assign = (this && this.__assign) || function () {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatsigMetadataProvider = void 0;
-var SDK_VERSION = '0.0.1-beta.6';
+var SDK_VERSION = '0.0.1-beta.7';
 var metadata = {
     sdkVersion: SDK_VERSION,
     sdkType: 'js-mono', // js-mono is overwritten by Precomp and OnDevice clients

package/src/StatsigOptionsCommon.d.ts

@@ -22,7 +22,7 @@ export type StatsigOptionsCommon = {
      */
     logLevel?: LogLevel;
     /**
-     * StatsigDataAdapter implementor used to customize the initialization flow.
+     * StatsigDataAdapter implementor used to customize the initialization/update flow.
      * Default: EvaluationsDataAdapter (Precomputed) or SpecsDataAdapter (OnDevice)
      */
     dataAdapter?: StatsigDataAdapter;