@statsig/client-core 3.0.0 → 3.2.0-beta.1

package/package.json

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

package/src/DownloadConfigSpecsResponse.d.ts

@@ -1,3 +1,4 @@
+import { StatsigUser } from './StatsigUser';
 export type SpecCondition = {
     type: string;
     targetValue: unknown;
@@ -38,4 +39,6 @@ export type DownloadConfigSpecsResponse = {
     layer_configs: Spec[];
     time: number;
     has_updates: boolean;
+    sdkInfo?: Record<string, string>;
+    user?: StatsigUser;
 };

package/src/EvaluationTypes.d.ts

@@ -1,4 +1,5 @@
 import { ParamStoreConfig } from './ParamStoreTypes';
+import { BootstrapMetadata } from './StatsigEvent';
 import { Flatten } from './TypingUtils';
 type EvaluationBase<T> = {
     id_type: string;
@@ -32,9 +33,12 @@ export type EvaluationDetails = {
     reason: string;
     lcut?: number;
     receivedAt?: number;
+    warnings?: EvaluationWarning[];
+    bootstrapMetadata?: BootstrapMetadata;
 };
 export type DetailedStoreResult<T extends AnyEvaluation | ParamStoreConfig> = {
     result: T | null;
     details: EvaluationDetails;
 };
+export type EvaluationWarning = 'PartialUserMatch' | 'StableIDMismatch';
 export {};

package/src/EventLogger.d.ts

@@ -16,6 +16,8 @@ export declare class EventLogger {
     private _creationTime;
     private _isLoggingDisabled;
     private _logEventUrl;
+    private static _safeFlushAndForget;
+    private static _safeRetryFailedLogs;
     constructor(_sdkKey: string, _emitter: StatsigClientEmitEventFunc, _network: NetworkCore, _options: StatsigOptionsCommon<NetworkConfigCommon> | null);
     setLoggingDisabled(isDisabled: boolean): void;
     enqueue(event: StatsigEventInternal): void;

package/src/EventLogger.js

@@ -26,13 +26,21 @@ const DEDUPER_WINDOW_DURATION_MS = 60000;
 const MAX_FAILED_LOGS = 500;
 const QUICK_FLUSH_WINDOW_MS = 200;
 const EVENT_LOGGER_MAP = {};
-const _safeFlushAndForget = (sdkKey) => {
-    var _a;
-    (_a = EVENT_LOGGER_MAP[sdkKey]) === null || _a === void 0 ? void 0 : _a.flush().catch(() => {
-        // noop
-    });
+const RetryFailedLogsTrigger = {
+    Startup: 'startup',
+    GainedFocus: 'gained_focus',
 };
 class EventLogger {
+    static _safeFlushAndForget(sdkKey) {
+        var _a;
+        (_a = EVENT_LOGGER_MAP[sdkKey]) === null || _a === void 0 ? void 0 : _a.flush().catch(() => {
+            // noop
+        });
+    }
+    static _safeRetryFailedLogs(sdkKey) {
+        var _a;
+        (_a = EVENT_LOGGER_MAP[sdkKey]) === null || _a === void 0 ? void 0 : _a._retryFailedLogs(RetryFailedLogsTrigger.GainedFocus);
+    }
     constructor(_sdkKey, _emitter, _network, _options) {
         var _a;
         this._sdkKey = _sdkKey;
@@ -59,7 +67,7 @@ class EventLogger {
         this._normalizeAndAppendEvent(event);
         this._quickFlushIfNeeded();
         if (this._queue.length > this._maxQueueSize) {
-            _safeFlushAndForget(this._sdkKey);
+            EventLogger._safeFlushAndForget(this._sdkKey);
         }
     }
     incrementNonExposureCount(name) {
@@ -77,10 +85,13 @@ class EventLogger {
         EVENT_LOGGER_MAP[this._sdkKey] = this;
         (0, VisibilityObserving_1._subscribeToVisiblityChanged)((visibility) => {
             if (visibility === 'background') {
-                _safeFlushAndForget(this._sdkKey);
+                EventLogger._safeFlushAndForget(this._sdkKey);
+            }
+            else if (visibility === 'foreground') {
+                EventLogger._safeRetryFailedLogs(this._sdkKey);
             }
         });
-        this._retryFailedLogs();
+        this._retryFailedLogs(RetryFailedLogsTrigger.Startup);
         this._startBackgroundFlushInterval();
     }
     stop() {
@@ -89,6 +100,7 @@ class EventLogger {
                 clearInterval(this._flushIntervalId);
                 this._flushIntervalId = null;
             }
+            delete EVENT_LOGGER_MAP[this._sdkKey];
             yield this.flush();
         });
     }
@@ -100,7 +112,7 @@ class EventLogger {
             }
             const events = this._queue;
             this._queue = [];
-            return this._sendEvents(events);
+            yield this._sendEvents(events);
         });
     }
     /**
@@ -115,7 +127,7 @@ class EventLogger {
         if (Date.now() - this._creationTime > QUICK_FLUSH_WINDOW_MS) {
             return;
         }
-        setTimeout(() => _safeFlushAndForget(this._sdkKey), QUICK_FLUSH_WINDOW_MS);
+        setTimeout(() => EventLogger._safeFlushAndForget(this._sdkKey), QUICK_FLUSH_WINDOW_MS);
     }
     _shouldLogEvent(event) {
         if ((0, SafeJs_1._isServerEnv)()) {
@@ -150,7 +162,7 @@ class EventLogger {
         return __awaiter(this, void 0, void 0, function* () {
             if (this._isLoggingDisabled) {
                 this._saveFailedLogsToStorage(events);
-                return;
+                return false;
             }
             try {
                 const isInBackground = !(0, VisibilityObserving_1._isCurrentlyVisible)();
@@ -165,13 +177,17 @@ class EventLogger {
                         name: 'logs_flushed',
                         events,
                     });
+                    return true;
                 }
                 else {
+                    Log_1.Log.warn('Failed to flush events.');
                     this._saveFailedLogsToStorage(events);
+                    return false;
                 }
             }
             catch (_c) {
                 Log_1.Log.warn('Failed to flush events.');
+                return false;
             }
         });
     }
@@ -216,7 +232,7 @@ class EventLogger {
             Log_1.Log.warn('Unable to save failed logs to storage');
         }
     }
-    _retryFailedLogs() {
+    _retryFailedLogs(trigger) {
         const storageKey = this._getStorageKey();
         (() => __awaiter(this, void 0, void 0, function* () {
             if (!StorageProvider_1.Storage.isReady()) {
@@ -226,8 +242,13 @@ class EventLogger {
             if (!events) {
                 return;
             }
-            StorageProvider_1.Storage.removeItem(storageKey);
-            yield this._sendEvents(events);
+            if (trigger === RetryFailedLogsTrigger.Startup) {
+                StorageProvider_1.Storage.removeItem(storageKey);
+            }
+            const isSuccess = yield this._sendEvents(events);
+            if (isSuccess && trigger === RetryFailedLogsTrigger.GainedFocus) {
+                StorageProvider_1.Storage.removeItem(storageKey);
+            }
         }))().catch(() => {
             Log_1.Log.warn('Failed to flush stored logs');
         });
@@ -279,7 +300,7 @@ class EventLogger {
                 clearInterval(intervalId);
             }
             else {
-                _safeFlushAndForget(this._sdkKey);
+                EventLogger._safeFlushAndForget(this._sdkKey);
             }
         }, flushInterval);
         this._flushIntervalId = intervalId;

package/src/InitializeResponse.d.ts

@@ -20,6 +20,7 @@ export type InitializeResponseWithUpdates = SessionReplayFields & AutoCaptureFie
     hash_used: 'none' | 'sha256' | 'djb2';
     derived_fields?: Record<string, unknown>;
     user?: StatsigUser;
+    sdkInfo?: Record<string, string>;
 };
 export type InitializeResponse = InitializeResponseWithUpdates | {
     has_updates: false;

package/src/Log.d.ts

@@ -1,10 +1,11 @@
-export declare enum LogLevel {
-    None = 0,
-    Error = 1,
-    Warn = 2,
-    Info = 3,
-    Debug = 4
-}
+export declare const LogLevel: {
+    readonly None: 0;
+    readonly Error: 1;
+    readonly Warn: 2;
+    readonly Info: 3;
+    readonly Debug: 4;
+};
+export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
 export declare abstract class Log {
     static level: LogLevel;
     static info(...args: unknown[]): void;

package/src/Log.js

@@ -11,35 +11,34 @@ function addTag(args) {
     args.unshift('[Statsig]');
     return args; // ['[Statsig]', ...args];
 }
-var LogLevel;
-(function (LogLevel) {
-    LogLevel[LogLevel["None"] = 0] = "None";
-    LogLevel[LogLevel["Error"] = 1] = "Error";
-    LogLevel[LogLevel["Warn"] = 2] = "Warn";
-    LogLevel[LogLevel["Info"] = 3] = "Info";
-    LogLevel[LogLevel["Debug"] = 4] = "Debug";
-})(LogLevel || (exports.LogLevel = LogLevel = {}));
+exports.LogLevel = {
+    None: 0,
+    Error: 1,
+    Warn: 2,
+    Info: 3,
+    Debug: 4,
+};
 class Log {
     static info(...args) {
-        if (this.level >= LogLevel.Info) {
-            console.info('\x1b[34m%s\x1b[0m', _INFO, ...addTag(args));
+        if (this.level >= exports.LogLevel.Info) {
+            console.info(_INFO, ...addTag(args));
         }
     }
     static debug(...args) {
-        if (this.level >= LogLevel.Debug) {
-            console.debug('\x1b[32m%s\x1b[0m', DEBUG, ...addTag(args));
+        if (this.level >= exports.LogLevel.Debug) {
+            console.debug(DEBUG, ...addTag(args));
         }
     }
     static warn(...args) {
-        if (this.level >= LogLevel.Warn) {
-            console.warn('\x1b[33m%s\x1b[0m', _WARN, ...addTag(args));
+        if (this.level >= exports.LogLevel.Warn) {
+            console.warn(_WARN, ...addTag(args));
         }
     }
     static error(...args) {
-        if (this.level >= LogLevel.Error) {
-            console.error('\x1b[31m%s\x1b[0m', ERROR, ...addTag(args));
+        if (this.level >= exports.LogLevel.Error) {
+            console.error(ERROR, ...addTag(args));
         }
     }
 }
 exports.Log = Log;
-Log.level = LogLevel.Warn;
+Log.level = exports.LogLevel.Warn;

package/src/NetworkConfig.d.ts

@@ -7,13 +7,14 @@ export type NetworkPriority = 'high' | 'low' | 'auto';
 export type NetworkArgs = RequestInit & {
     priority?: NetworkPriority;
 };
-export declare enum NetworkParam {
-    EventCount = "ec",
-    SdkKey = "k",
-    SdkType = "st",
-    SdkVersion = "sv",
-    Time = "t",
-    SessionID = "sid",
-    StatsigEncoded = "se",
-    IsGzipped = "gz"
-}
+export declare const NetworkParam: {
+    readonly EventCount: "ec";
+    readonly SdkKey: "k";
+    readonly SdkType: "st";
+    readonly SdkVersion: "sv";
+    readonly Time: "t";
+    readonly SessionID: "sid";
+    readonly StatsigEncoded: "se";
+    readonly IsGzipped: "gz";
+};
+export type NetworkParam = (typeof NetworkParam)[keyof typeof NetworkParam];

package/src/NetworkConfig.js

@@ -6,14 +6,13 @@ exports.NetworkDefault = {
     initializeApi: 'https://featureassets.org/v1',
     specsApi: 'https://assetsconfigcdn.org/v1',
 };
-var NetworkParam;
-(function (NetworkParam) {
-    NetworkParam["EventCount"] = "ec";
-    NetworkParam["SdkKey"] = "k";
-    NetworkParam["SdkType"] = "st";
-    NetworkParam["SdkVersion"] = "sv";
-    NetworkParam["Time"] = "t";
-    NetworkParam["SessionID"] = "sid";
-    NetworkParam["StatsigEncoded"] = "se";
-    NetworkParam["IsGzipped"] = "gz";
-})(NetworkParam || (exports.NetworkParam = NetworkParam = {}));
+exports.NetworkParam = {
+    EventCount: 'ec',
+    SdkKey: 'k',
+    SdkType: 'st',
+    SdkVersion: 'sv',
+    Time: 't',
+    SessionID: 'sid',
+    StatsigEncoded: 'se',
+    IsGzipped: 'gz',
+};

package/src/StatsigClientBase.d.ts

@@ -25,6 +25,7 @@ export declare abstract class StatsigClientBase<TAdapter extends EvaluationsData
     protected readonly _options: AnyStatsigOptions;
     protected readonly _errorBoundary: ErrorBoundary;
     protected readonly _logger: EventLogger;
+    protected _initializePromise: Promise<void> | null;
     private _listeners;
     constructor(sdkKey: string, adapter: TAdapter, network: NetworkCore, options: AnyStatsigOptions | null);
     /**

package/src/StatsigClientBase.js

@@ -20,8 +20,9 @@ const SessionID_1 = require("./SessionID");
 const StorageProvider_1 = require("./StorageProvider");
 class StatsigClientBase {
     constructor(sdkKey, adapter, network, options) {
-        var _a, _b;
+        var _a;
         this.loadingStatus = 'Uninitialized';
+        this._initializePromise = null;
         this._listeners = {};
         const emitter = this.$emt.bind(this);
         (options === null || options === void 0 ? void 0 : options.logLevel) != null && (Log_1.Log.level = options.logLevel);
@@ -38,22 +39,11 @@ class StatsigClientBase {
         this._errorBoundary.wrap(network);
         this._errorBoundary.wrap(adapter);
         this._errorBoundary.wrap(this._logger);
-        if (!(0, SafeJs_1._isServerEnv)()) {
-            const statsigGlobal = (0, __StatsigGlobal_1._getStatsigGlobal)();
-            const instances = (_b = statsigGlobal.instances) !== null && _b !== void 0 ? _b : {};
-            const inst = this;
-            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.');
-            }
-            instances[sdkKey] = inst;
-            statsigGlobal.lastInstance = inst;
-            statsigGlobal.instances = instances;
-            __STATSIG__ = statsigGlobal;
-        }
         this.dataAdapter = adapter;
         this.dataAdapter.attach(sdkKey, options);
         this.storageProvider = StorageProvider_1.Storage;
         this._primeReadyRipcord();
+        _assignGlobalInstance(sdkKey, this);
     }
     /**
      * 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.
@@ -85,6 +75,8 @@ class StatsigClientBase {
     shutdown() {
         return __awaiter(this, void 0, void 0, function* () {
             this.$emt({ name: 'pre_shutdown' });
+            this._setStatus('Uninitialized', null);
+            this._initializePromise = null;
             yield this._logger.stop();
         });
     }
@@ -153,3 +145,19 @@ class StatsigClientBase {
     }
 }
 exports.StatsigClientBase = StatsigClientBase;
+function _assignGlobalInstance(sdkKey, client) {
+    var _a;
+    if ((0, SafeJs_1._isServerEnv)()) {
+        return;
+    }
+    const statsigGlobal = (0, __StatsigGlobal_1._getStatsigGlobal)();
+    const instances = (_a = statsigGlobal.instances) !== null && _a !== void 0 ? _a : {};
+    const inst = client;
+    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.');
+    }
+    instances[sdkKey] = inst;
+    statsigGlobal.lastInstance = inst;
+    statsigGlobal.instances = instances;
+    __STATSIG__ = statsigGlobal;
+}

package/src/StatsigClientEventEmitter.d.ts

@@ -15,6 +15,7 @@ type EventNameToEventDataMap = {
         events: Record<string, unknown>[];
     };
     pre_shutdown: object;
+    initialization_failure: object;
     gate_evaluation: {
         gate: FeatureGate;
     };

package/src/StatsigDataAdapter.d.ts

@@ -29,9 +29,10 @@ export type DataAdapterAsyncOptions = {
 export type DataAdapterSyncOptions = {
     /**
      * The flag to disable background cache refresh.
-     * If set to true, the cache will not be updated in the background and will only use the data adatpter values.
+     * If set to true, a network request to update the cache for future sessions will not fired.
+     * if "explicitly" set to false, a network request to update the cache for future sessions will be fired, even in bootstrap cases.
      *
-     * default: false
+     * default: implicit false
      */
     readonly disableBackgroundCacheRefresh?: boolean;
 };

package/src/StatsigEvent.d.ts

@@ -8,6 +8,11 @@ export type StatsigEvent = {
         [key: string]: string | undefined;
     } | null;
 };
+export type BootstrapMetadata = {
+    generatorSDKInfo?: Record<string, string>;
+    lcut?: number;
+    user?: Record<string, unknown>;
+};
 export type StatsigEventInternal = Omit<StatsigEvent, 'metadata'> & {
     user: StatsigUserInternal | null;
     time: number;

package/src/StatsigEvent.js

@@ -5,6 +5,9 @@ const CONFIG_EXPOSURE_NAME = 'statsig::config_exposure';
 const GATE_EXPOSURE_NAME = 'statsig::gate_exposure';
 const LAYER_EXPOSURE_NAME = 'statsig::layer_exposure';
 const _createExposure = (eventName, user, details, metadata, secondaryExposures) => {
+    if (details.bootstrapMetadata) {
+        metadata['bootstrapMetadata'] = details.bootstrapMetadata;
+    }
     return {
         eventName,
         user,

package/src/StatsigMetadata.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "3.0.0";
+export declare const SDK_VERSION = "3.2.0-beta.1";
 export type StatsigMetadata = {
     readonly [key: string]: string | undefined;
     readonly appVersion?: string;

package/src/StatsigMetadata.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatsigMetadataProvider = exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = '3.0.0';
+exports.SDK_VERSION = '3.2.0-beta.1';
 let metadata = {
     sdkVersion: exports.SDK_VERSION,
     sdkType: 'js-mono', // js-mono is overwritten by Precomp and OnDevice clients

package/src/StatsigPlugin.d.ts

@@ -0,0 +1,5 @@
+import { StatsigClientInterface } from './ClientInterfaces';
+export type StatsigPlugin<T extends StatsigClientInterface> = {
+    readonly __plugin: 'session-replay' | 'auto-capture';
+    bind: (client: T) => void;
+};

package/src/StatsigPlugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/index.d.ts

@@ -33,6 +33,7 @@ export * from './StatsigOptionsCommon';
 export * from './StatsigTypeFactories';
 export * from './StatsigTypes';
 export * from './StatsigUser';
+export * from './StatsigPlugin';
 export * from './StorageProvider';
 export * from './TypedJsonParse';
 export * from './TypingUtils';

package/src/index.js

@@ -55,6 +55,7 @@ __exportStar(require("./StatsigOptionsCommon"), exports);
 __exportStar(require("./StatsigTypeFactories"), exports);
 __exportStar(require("./StatsigTypes"), exports);
 __exportStar(require("./StatsigUser"), exports);
+__exportStar(require("./StatsigPlugin"), exports);
 __exportStar(require("./StorageProvider"), exports);
 __exportStar(require("./TypedJsonParse"), exports);
 __exportStar(require("./TypingUtils"), exports);