@statsig/client-core 0.0.1-beta.3 → 0.0.1-beta.31

package/src/StatsigClientBase.js

@@ -8,265 +8,141 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __asyncValues = (this && this.__asyncValues) || function (o) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var m = o[Symbol.asyncIterator], i;
-    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
-    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
-    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StatsigClientBase = exports.DEFAULT_EVAL_OPTIONS = void 0;
+exports.StatsigClientBase = void 0;
 require("./$_StatsigGlobal");
-var ErrorBoundary_1 = require("./ErrorBoundary");
-var EventLogger_1 = require("./EventLogger");
-var Log_1 = require("./Log");
-var StableID_1 = require("./StableID");
-exports.DEFAULT_EVAL_OPTIONS = {
-    disableExposureLog: false,
-};
-var StatsigClientBase = /** @class */ (function () {
-    function StatsigClientBase(sdkKey, network, options, dataProviders) {
-        var _a, _b;
+const __StatsigGlobal_1 = require("./$_StatsigGlobal");
+const ErrorBoundary_1 = require("./ErrorBoundary");
+const EventLogger_1 = require("./EventLogger");
+const Log_1 = require("./Log");
+const SessionID_1 = require("./SessionID");
+const StableID_1 = require("./StableID");
+const StorageProvider_1 = require("./StorageProvider");
+class StatsigClientBase {
+    constructor(sdkKey, adapter, network, options) {
+        var _a, _b, _c;
         this.loadingStatus = 'Uninitialized';
         this._listeners = {};
-        this._logger = new EventLogger_1.EventLogger(sdkKey, this.emit.bind(this), network, options);
         this._sdkKey = sdkKey;
-        this._errorBoundary = new ErrorBoundary_1.ErrorBoundary(sdkKey);
-        if (options === null || options === void 0 ? void 0 : options.overrideStableID) {
+        this._options = options !== null && options !== void 0 ? options : {};
+        (options === null || options === void 0 ? void 0 : options.disableStorage) && StorageProvider_1.Storage._setDisabled(true);
+        (options === null || options === void 0 ? void 0 : options.overrideStableID) &&
             StableID_1.StableID.setOverride(options.overrideStableID, sdkKey);
+        Log_1.Log.level = (_a = options === null || options === void 0 ? void 0 : options.logLevel) !== null && _a !== void 0 ? _a : Log_1.LogLevel.Warn;
+        this._overrideAdapter = (_b = options === null || options === void 0 ? void 0 : options.overrideAdapter) !== null && _b !== void 0 ? _b : null;
+        this._logger = new EventLogger_1.EventLogger(sdkKey, this._emit.bind(this), network, options);
+        SessionID_1.SessionID._setEmitFunction(() => {
+            this._emit({ name: 'session_expired' });
+        }, sdkKey);
+        this._errorBoundary = new ErrorBoundary_1.ErrorBoundary(sdkKey);
+        const statsigGlobal = (0, __StatsigGlobal_1._getStatsigGlobal)();
+        const instances = (_c = statsigGlobal.instances) !== null && _c !== void 0 ? _c : {};
+        if (instances[sdkKey] != null) {
+            Log_1.Log.warn('Creating multiple Statsig clients with the same SDK key can lead to unexpected behavior. Multi-instance support requires different SDK keys.');
+        }
+        const inst = this;
+        instances[sdkKey] = inst;
+        statsigGlobal.lastInstance = inst;
+        statsigGlobal.instances = instances;
+        __STATSIG__ = statsigGlobal;
+        this.dataAdapter = adapter;
+        this.dataAdapter.attach(sdkKey, options);
+    }
+    /**
+     * Updates runtime configuration options for the SDK, allowing toggling of certain behaviors such as logging and storage to comply with user preferences or regulations such as GDPR.
+     *
+     * @param {StatsigRuntimeMutableOptions} options - The configuration options that dictate the runtime behavior of the SDK.
+     */
+    updateRuntimeOptions(options) {
+        if (options.disableLogging != null) {
+            this._options.disableLogging = options.disableLogging;
+            this._logger.setLoggingDisabled(options.disableLogging);
+        }
+        if (options.disableStorage != null) {
+            this._options.disableStorage = options.disableStorage;
+            StorageProvider_1.Storage._setDisabled(options.disableStorage);
         }
-        __STATSIG__ = __STATSIG__ !== null && __STATSIG__ !== void 0 ? __STATSIG__ : {};
-        var instances = (_a = __STATSIG__.instances) !== null && _a !== void 0 ? _a : new Set();
-        instances.add(this);
-        __STATSIG__.instances = instances;
-        Log_1.Log.level = (_b = options === null || options === void 0 ? void 0 : options.logLevel) !== null && _b !== void 0 ? _b : Log_1.LogLevel.Warn;
-        this._dataProviders = dataProviders;
     }
-    StatsigClientBase.prototype.on = function (event, listener) {
+    /**
+     * Flushes any currently queued events.
+     */
+    flush() {
+        return this._logger.flush();
+    }
+    /**
+     * Gracefully shuts down the SDK, ensuring that all pending events are send before the SDK stops.
+     * This function emits a 'pre_shutdown' event and then waits for the logger to complete its shutdown process.
+     *
+     * @returns {Promise<void>} A promise that resolves when all shutdown procedures, including logging shutdown, have been completed.
+     */
+    shutdown() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._emit({ name: 'pre_shutdown' });
+            yield this._logger.shutdown();
+        });
+    }
+    /**
+     * Subscribes a callback function to a specific {@link StatsigClientEvent} or all StatsigClientEvents if the wildcard '*' is used.
+     * Once subscribed, the listener callback will be invoked whenever the specified event is emitted.
+     *
+     * @param {StatsigClientEventName} event - The name of the event to subscribe to, or '*' to subscribe to all events.
+     * @param {StatsigClientEventCallback<T>} listener - The callback function to execute when the event occurs. The function receives event-specific data as its parameter.
+     * @see {@link off} for unsubscribing from events.
+     */
+    on(event, listener) {
         if (!this._listeners[event]) {
             this._listeners[event] = [];
         }
         this._listeners[event].push(listener);
-    };
-    StatsigClientBase.prototype.off = function (event, listener) {
+    }
+    /**
+     * Unsubscribes a previously registered callback function from a specific {@link StatsigClientEvent} or all StatsigClientEvents if the wildcard '*' is used.
+     *
+     * @param {StatsigClientEventName} event - The name of the event from which to unsubscribe, or '*' to unsubscribe from all events.
+     * @param {StatsigClientEventCallback<T>} listener - The callback function to remove from the event's notification list.
+     * @see {@link on} for subscribing to events.
+     */
+    off(event, listener) {
         if (this._listeners[event]) {
-            var index = this._listeners[event].indexOf(listener);
+            const index = this._listeners[event].indexOf(listener);
             if (index !== -1) {
                 this._listeners[event].splice(index, 1);
             }
         }
-    };
-    StatsigClientBase.prototype.emit = function (data) {
-        var _a;
-        if (this._listeners[data.event]) {
-            this._listeners[data.event].forEach(function (listener) { return listener(data); });
-        }
-        (_a = this._listeners['*']) === null || _a === void 0 ? void 0 : _a.forEach(function (listener) { return listener(data); });
-    };
-    StatsigClientBase.prototype._setStatus = function (newStatus) {
-        this.loadingStatus = newStatus;
-        this.emit({ event: 'status_change', loadingStatus: newStatus });
-    };
-    StatsigClientBase.prototype._getDataFromProviders = function (user) {
+    }
+    __on(event, listener) {
+        listener.__isInternal = true;
+        this.on(event, listener);
+    }
+    _emit(event) {
         var _a;
-        for (var _i = 0, _b = this._dataProviders; _i < _b.length; _i++) {
-            var provider = _b[_i];
-            var data = (_a = provider.getData) === null || _a === void 0 ? void 0 : _a.call(provider, this._sdkKey, user);
-            if (data) {
-                return { data: data, source: provider.source };
+        const barrier = (listener) => {
+            try {
+                listener(event);
             }
-        }
-        return { data: null, source: 'NoValues' };
-    };
-    StatsigClientBase.prototype._getDataFromProvidersAsync = function (user) {
-        var _a, e_1, _b, _c;
-        var _d;
-        return __awaiter(this, void 0, void 0, function () {
-            var _e, _f, _g, provider, data, e_1_1;
-            return __generator(this, function (_h) {
-                switch (_h.label) {
-                    case 0:
-                        _h.trys.push([0, 6, 7, 12]);
-                        _e = true, _f = __asyncValues(this._dataProviders);
-                        _h.label = 1;
-                    case 1: return [4 /*yield*/, _f.next()];
-                    case 2:
-                        if (!(_g = _h.sent(), _a = _g.done, !_a)) return [3 /*break*/, 5];
-                        _c = _g.value;
-                        _e = false;
-                        provider = _c;
-                        return [4 /*yield*/, ((_d = provider.getDataAsync) === null || _d === void 0 ? void 0 : _d.call(provider, this._sdkKey, user))];
-                    case 3:
-                        data = _h.sent();
-                        if (data) {
-                            return [2 /*return*/, { data: data, source: provider.source }];
-                        }
-                        _h.label = 4;
-                    case 4:
-                        _e = true;
-                        return [3 /*break*/, 1];
-                    case 5: return [3 /*break*/, 12];
-                    case 6:
-                        e_1_1 = _h.sent();
-                        e_1 = { error: e_1_1 };
-                        return [3 /*break*/, 12];
-                    case 7:
-                        _h.trys.push([7, , 10, 11]);
-                        if (!(!_e && !_a && (_b = _f.return))) return [3 /*break*/, 9];
-                        return [4 /*yield*/, _b.call(_f)];
-                    case 8:
-                        _h.sent();
-                        _h.label = 9;
-                    case 9: return [3 /*break*/, 11];
-                    case 10:
-                        if (e_1) throw e_1.error;
-                        return [7 /*endfinally*/];
-                    case 11: return [7 /*endfinally*/];
-                    case 12: return [2 /*return*/, { data: null, source: 'NoValues' }];
-                }
-            });
-        });
-    };
-    StatsigClientBase.prototype._getDataPostInitFromProviders = function (currentData, user) {
-        var _a, e_2, _b, _c;
-        var _d;
-        return __awaiter(this, void 0, void 0, function () {
-            var _e, _f, _g, provider, data, e_2_1;
-            return __generator(this, function (_h) {
-                switch (_h.label) {
-                    case 0:
-                        _h.trys.push([0, 6, 7, 12]);
-                        _e = true, _f = __asyncValues(this._dataProviders);
-                        _h.label = 1;
-                    case 1: return [4 /*yield*/, _f.next()];
-                    case 2:
-                        if (!(_g = _h.sent(), _a = _g.done, !_a)) return [3 /*break*/, 5];
-                        _c = _g.value;
-                        _e = false;
-                        provider = _c;
-                        return [4 /*yield*/, ((_d = provider.getDataPostInit) === null || _d === void 0 ? void 0 : _d.call(provider, this._sdkKey, currentData, user))];
-                    case 3:
-                        data = _h.sent();
-                        if (data) {
-                            return [2 /*return*/, { data: data, source: provider.source }];
-                        }
-                        _h.label = 4;
-                    case 4:
-                        _e = true;
-                        return [3 /*break*/, 1];
-                    case 5: return [3 /*break*/, 12];
-                    case 6:
-                        e_2_1 = _h.sent();
-                        e_2 = { error: e_2_1 };
-                        return [3 /*break*/, 12];
-                    case 7:
-                        _h.trys.push([7, , 10, 11]);
-                        if (!(!_e && !_a && (_b = _f.return))) return [3 /*break*/, 9];
-                        return [4 /*yield*/, _b.call(_f)];
-                    case 8:
-                        _h.sent();
-                        _h.label = 9;
-                    case 9: return [3 /*break*/, 11];
-                    case 10:
-                        if (e_2) throw e_2.error;
-                        return [7 /*endfinally*/];
-                    case 11: return [7 /*endfinally*/];
-                    case 12: return [2 /*return*/, { data: null, source: 'NoValues' }];
-                }
-            });
-        });
-    };
-    StatsigClientBase.prototype._saveToDataProviders = function (currentData, user) {
-        var _this = this;
-        (function () { return __awaiter(_this, void 0, void 0, function () {
-            var latest, data, _a, _b, _c, provider, e_3_1;
-            var _d, e_3, _e, _f;
-            var _g, _h;
-            return __generator(this, function (_j) {
-                switch (_j.label) {
-                    case 0: return [4 /*yield*/, this._getDataPostInitFromProviders(currentData, user)];
-                    case 1:
-                        latest = _j.sent();
-                        data = (_g = latest.data) !== null && _g !== void 0 ? _g : currentData;
-                        if (!data) {
-                            return [2 /*return*/];
-                        }
-                        _j.label = 2;
-                    case 2:
-                        _j.trys.push([2, 8, 9, 14]);
-                        _a = true, _b = __asyncValues(this._dataProviders);
-                        _j.label = 3;
-                    case 3: return [4 /*yield*/, _b.next()];
-                    case 4:
-                        if (!(_c = _j.sent(), _d = _c.done, !_d)) return [3 /*break*/, 7];
-                        _f = _c.value;
-                        _a = false;
-                        provider = _f;
-                        return [4 /*yield*/, ((_h = provider.setDataPostInit) === null || _h === void 0 ? void 0 : _h.call(provider, this._sdkKey, data, user))];
-                    case 5:
-                        _j.sent();
-                        _j.label = 6;
-                    case 6:
-                        _a = true;
-                        return [3 /*break*/, 3];
-                    case 7: return [3 /*break*/, 14];
-                    case 8:
-                        e_3_1 = _j.sent();
-                        e_3 = { error: e_3_1 };
-                        return [3 /*break*/, 14];
-                    case 9:
-                        _j.trys.push([9, , 12, 13]);
-                        if (!(!_a && !_d && (_e = _b.return))) return [3 /*break*/, 11];
-                        return [4 /*yield*/, _e.call(_b)];
-                    case 10:
-                        _j.sent();
-                        _j.label = 11;
-                    case 11: return [3 /*break*/, 13];
-                    case 12:
-                        if (e_3) throw e_3.error;
-                        return [7 /*endfinally*/];
-                    case 13: return [7 /*endfinally*/];
-                    case 14: return [2 /*return*/];
+            catch (error) {
+                if (listener.__isInternal === true) {
+                    this._errorBoundary.logError(`_emit:${event.name}`, error);
+                    return;
                 }
-            });
-        }); })().catch(function (error) {
-            _this.emit({ event: 'error', error: error });
-        });
-    };
-    StatsigClientBase.prototype._enqueueExposure = function (options, exposure) {
-        if (options.disableExposureLog === true) {
+                Log_1.Log.error(`An error occurred in a StatsigClientEvent listener. This is not an issue with Statsig.`, event);
+            }
+        };
+        if (this._listeners[event.name]) {
+            this._listeners[event.name].forEach((l) => barrier(l));
+        }
+        (_a = this._listeners['*']) === null || _a === void 0 ? void 0 : _a.forEach(barrier);
+    }
+    _setStatus(newStatus, values) {
+        this.loadingStatus = newStatus;
+        this._emit({ name: 'values_updated', status: newStatus, values });
+    }
+    _enqueueExposure(name, exposure, options) {
+        if ((options === null || options === void 0 ? void 0 : options.disableExposureLog) === true) {
+            this._logger.incrementNonExposureCount(name);
             return;
         }
         this._logger.enqueue(exposure);
-    };
-    return StatsigClientBase;
-}());
+    }
+}
 exports.StatsigClientBase = StatsigClientBase;

package/src/StatsigClientEventEmitter.d.ts

@@ -1,33 +1,70 @@
+import { DataAdapterResult } from './StatsigDataAdapter';
 import { DynamicConfig, Experiment, FeatureGate, Layer } from './StatsigTypes';
-export type StatsigLoadingStatus = 'Uninitialized' | 'Loading' | 'Ready' | 'Error';
-export type StatsigClientEvent = 'status_change' | 'error' | 'logs_flushed' | 'gate_evaluation' | 'dynamic_config_evaluation' | 'experiment_evaluation' | 'layer_evaluation';
-export type StatsigClientEventData = {
-    event: StatsigClientEvent;
-} | {
-    event: 'status_change';
-    loadingStatus: StatsigLoadingStatus;
-} | {
-    event: 'error';
-    error: unknown;
-} | {
-    event: 'logs_flushed';
-    events: Record<string, unknown>[];
-} | {
-    event: 'gate_evaluation';
-    gate: FeatureGate;
-} | {
-    event: 'dynamic_config_evaluation';
-    dynamicConfig: DynamicConfig;
-} | {
-    event: 'experiment_evaluation';
-    experiment: Experiment;
-} | {
-    event: 'layer_evaluation';
-    layer: Layer;
+import { Flatten } from './UtitlityTypes';
+export type StatsigLoadingStatus = 'Uninitialized' | 'Loading' | 'Ready';
+type EventNameToEventDataMap = {
+    values_updated: {
+        status: StatsigLoadingStatus;
+        values: DataAdapterResult | null;
+    };
+    session_expired: object;
+    error: {
+        error: unknown;
+    };
+    logs_flushed: {
+        events: Record<string, unknown>[];
+    };
+    pre_shutdown: object;
+    gate_evaluation: {
+        gate: FeatureGate;
+    };
+    dynamic_config_evaluation: {
+        dynamicConfig: DynamicConfig;
+    };
+    experiment_evaluation: {
+        experiment: Experiment;
+    };
+    layer_evaluation: {
+        layer: Layer;
+    };
 };
-export type StatsigClientEventCallback = (data: StatsigClientEventData) => void;
+/**
+ * Type representing various events emitted by a Statsig client.
+ *
+ * `values_updated` - When the Statsig clients internal values change as the result of an initialize/update operation.
+ *
+ * `error` - When an unexpected error occurs within the Statsig client.
+ *
+ * `logs_flushed` - When queued StatsigEvents are flushed to Statsig servers.
+ *
+ * `pre_shutdown` - Fired just before the SDK is shutdown
+ *
+ * `gate_evaluation` - Fired when any gate is checked from the Statsig client.
+ *
+ * `dynamic_config_evaluation` - Fired when any dyanamic config is checked from the Statsig client.
+ *
+ * `experiment_evaluation` - Fired when any experiment is checked from the Statsig client.
+ *
+ * `layer_evaluation` - Fired when any layer is checked from the Statsig client.
+ */
+export type AnyStatsigClientEvent = Flatten<{
+    [K in keyof EventNameToEventDataMap]: {
+        name: K;
+    } & EventNameToEventDataMap[K];
+}[keyof EventNameToEventDataMap]>;
+export type StatsigClientEvent<T> = Extract<AnyStatsigClientEvent, {
+    name: T;
+}>;
+export type AnyStatsigClientEventListener = StatsigClientEventCallback<StatsigClientEventName>;
+export type StatsigClientEventName = AnyStatsigClientEvent['name'] | '*';
+export type StatsigClientEventCallback<T extends StatsigClientEventName> = (event: T extends '*' ? AnyStatsigClientEvent : StatsigClientEvent<T>) => void;
 export interface StatsigClientEventEmitterInterface {
     readonly loadingStatus: StatsigLoadingStatus;
-    on(event: StatsigClientEvent, listener: StatsigClientEventCallback): void;
-    off(event: StatsigClientEvent, listener: StatsigClientEventCallback): void;
+    on<T extends StatsigClientEventName>(event: T, listener: StatsigClientEventCallback<T>): void;
+    off<T extends StatsigClientEventName>(event: T, listener: StatsigClientEventCallback<T>): void;
+    /**
+     * (Statsig Use Only) - Same as .on() but logs errors to sdk_exception
+     */
+    __on<T extends StatsigClientEventName>(event: T, listener: StatsigClientEventCallback<T>): void;
 }
+export {};

package/src/StatsigDataAdapter.d.ts

@@ -0,0 +1,89 @@
+import { AnyStatsigOptions } from './StatsigOptionsCommon';
+import { StatsigUser } from './StatsigUser';
+export type DataSource = 'Uninitialized' | 'Loading' | 'NoValues' | 'Cache' | 'Network' | 'NetworkNotModified' | 'Bootstrap' | 'Prefetch';
+export type DataAdapterResult = {
+    readonly source: DataSource;
+    readonly data: string;
+    readonly receivedAt: number;
+};
+export declare const DataAdapterCachePrefix = "statsig.cached";
+/**
+ * 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 StatsigOptionsCommon.dataAdapter}.
+ *
+ * Defaults:
+ *
+ * - {@link StatsigClient} uses {@link EvaluationsDataAdapter}
+ *
+ * - {@link StatsigOnDeviceEvalClient} uses {@link SpecsDataAdapter}
+ */
+type DataAdapterCommon = {
+    /**
+     * Called when the StatsigDataAdapter is attached to the Statsig client instance during construction.
+     * @param {string} sdkKey The SDK key being used by the Statsig client.
+     * @param {StatsigOptionsCommon | null} options The StatsigOptions being used by the Statsig client.
+     */
+    readonly attach: (sdkKey: string, options: AnyStatsigOptions | null) => void;
+    /**
+     * (Internal Use Only) - Used by \@statsig/react-native-bindings to prime the cache from AsyncStorage
+     *
+     * @param {Record<string, DataAdapterResult>} cache The values to merge into _inMemoryCache
+     */
+    readonly __primeInMemoryCache: (cache: Record<string, DataAdapterResult>) => void;
+};
+export type EvaluationsDataAdapter = DataAdapterCommon & {
+    /**
+     * Synchronously get evaluation data for the given user. Called during initializeSync and/or updateUserSync.
+     *
+     * It is also called during async update operations before StatsigDataAdapter.getDataAsync is called.
+     * @param {StatsigUser} user The StatsigUser to get data for.
+     * @returns {DataAdapterResult | null} The data that was found for the given StatsigUser.
+     */
+    readonly getDataSync: (user: StatsigUser) => DataAdapterResult | null;
+    /**
+     * Asynchronously get evaluation data for the given user. Called during initializeAsync and/or updateUserAsync.
+     *
+     * @param {DataAdapterResult | null} current The data that was found synchronously (Cache). Will be used as fallback if getDataAsync fails
+     * @param {StatsigUser} user The StatsigUser to get data for.
+     * @returns {DataAdapterResult | null} The data that was found for the given StatsigUser.
+     */
+    readonly getDataAsync: (current: DataAdapterResult | null, user: StatsigUser) => Promise<DataAdapterResult | null>;
+    /**
+     * Manually trigger a fetch for new evaluations data for the given user.
+     *
+     * @param {StatsigUser} user The StatsigUser to get data for.
+     */
+    readonly prefetchData: (user: StatsigUser) => Promise<void>;
+    /**
+     * Manually set evaluations data for the given user.
+     *
+     * @param {StatsigUser} user The StatsigUser this data is for.
+     */
+    readonly setData: (data: string, user: StatsigUser) => void;
+};
+export type SpecsDataAdapter = DataAdapterCommon & {
+    /**
+     * Synchronously get specs data. Called during initializeSync and/or updateUserSync.
+     * It is also called during async update operations before StatsigDataAdapter.getDataAsync is called.
+     * @returns {DataAdapterResult | null} The data that was found for the given StatsigUser.
+     */
+    readonly getDataSync: () => DataAdapterResult | null;
+    /**
+     * Asynchronously get specs data. Called during initializeAsync and/or updateUserAsync.
+     *
+     * @param {DataAdapterResult | null} current The data that was found synchronously (Cache). Will be used as fallback if getDataAsync fails
+     * @returns {DataAdapterResult | null} The data that was found for the given StatsigUser.
+     */
+    readonly getDataAsync: (current: DataAdapterResult | null) => Promise<DataAdapterResult | null>;
+    /**
+     * Manually trigger a fetch for new specs data.
+     */
+    readonly prefetchData: () => Promise<void>;
+    /**
+     * Manually set specs data (Bootstrap).
+     */
+    readonly setData: (data: string) => void;
+};
+export {};

package/src/StatsigDataAdapter.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataAdapterCachePrefix = void 0;
+exports.DataAdapterCachePrefix = 'statsig.cached';

package/src/StatsigEvent.d.ts

@@ -1,11 +1,6 @@
-import { DataSource } from './StatsigDataProvider';
-import { DynamicConfig, FeatureGate } from './StatsigTypes';
+import { SecondaryExposure } from './EvaluationTypes';
+import { DynamicConfig, FeatureGate, Layer } from './StatsigTypes';
 import { StatsigUser } from './StatsigUser';
-export type SecondaryExposure = {
-    gate: string;
-    gateValue: string;
-    ruleID: string;
-};
 export type StatsigEvent = {
     eventName: string;
     value?: string | number | null;
@@ -13,19 +8,15 @@ export type StatsigEvent = {
         [key: string]: string;
     } | null;
 };
-export type StatsigEventInternal = StatsigEvent & {
+export type StatsigEventInternal = Omit<StatsigEvent, 'metadata'> & {
     user: StatsigUser | null;
     time: number;
+    metadata?: {
+        [key: string]: unknown;
+    } | null;
     secondaryExposures?: SecondaryExposure[];
 };
-export declare function isExposureEvent({ eventName }: StatsigEventInternal): boolean;
-export declare function createGateExposure(user: StatsigUser, gate: FeatureGate, secondaryExposures: SecondaryExposure[] | undefined): StatsigEventInternal;
-export declare function createConfigExposure(user: StatsigUser, config: DynamicConfig, secondaryExposures: SecondaryExposure[] | undefined): StatsigEventInternal;
-export declare function createLayerParameterExposure(user: StatsigUser, layerName: string, parameterName: string, spec: {
-    rule_id: string;
-    explicit_parameters: string[];
-    undelegated_secondary_exposures?: SecondaryExposure[];
-    secondary_exposures: SecondaryExposure[];
-    allocated_experiment_name: string;
-    source: DataSource;
-}): StatsigEventInternal;
+export declare const _isExposureEvent: ({ eventName, }: StatsigEventInternal) => boolean;
+export declare const _createGateExposure: (user: StatsigUser, gate: FeatureGate) => StatsigEventInternal;
+export declare const _createConfigExposure: (user: StatsigUser, config: DynamicConfig) => StatsigEventInternal;
+export declare const _createLayerParameterExposure: (user: StatsigUser, layer: Layer, parameterName: string) => StatsigEventInternal;