@statsig/client-core 0.0.1-beta.1 → 0.0.1-beta.10

package/src/StatsigEvent.js

@@ -4,12 +4,12 @@ exports.createLayerParameterExposure = exports.createConfigExposure = exports.cr
 var CONFIG_EXPOSURE_NAME = 'statsig::config_exposure';
 var GATE_EXPOSURE_NAME = 'statsig::gate_exposure';
 var LAYER_EXPOSURE_NAME = 'statsig::layer_exposure';
-function createExposure(eventName, user, metadata, secondaryExposures) {
+function createExposure(eventName, user, details, metadata, secondaryExposures) {
     return {
         eventName: eventName,
         user: user,
         value: null,
-        metadata: metadata,
+        metadata: _addEvaluationDetailsToMetadata(details, metadata),
         secondaryExposures: secondaryExposures,
         time: Date.now(),
     };
@@ -20,19 +20,17 @@ function isExposureEvent(_a) {
 }
 exports.isExposureEvent = isExposureEvent;
 function createGateExposure(user, gate, secondaryExposures) {
-    return createExposure(GATE_EXPOSURE_NAME, user, {
+    return createExposure(GATE_EXPOSURE_NAME, user, gate.details, {
         gate: gate.name,
         gateValue: String(gate.value),
         ruleID: gate.ruleID,
-        reason: gate.source,
     }, secondaryExposures !== null && secondaryExposures !== void 0 ? secondaryExposures : []);
 }
 exports.createGateExposure = createGateExposure;
 function createConfigExposure(user, config, secondaryExposures) {
-    return createExposure(CONFIG_EXPOSURE_NAME, user, {
+    return createExposure(CONFIG_EXPOSURE_NAME, user, config.details, {
         config: config.name,
         ruleID: config.ruleID,
-        reason: config.source,
     }, secondaryExposures !== null && secondaryExposures !== void 0 ? secondaryExposures : []);
 }
 exports.createConfigExposure = createConfigExposure;
@@ -45,13 +43,22 @@ function createLayerParameterExposure(user, layerName, parameterName, spec) {
         allocatedExperiment = spec.allocated_experiment_name;
         secondaryExposures = spec.secondary_exposures;
     }
-    return createExposure(LAYER_EXPOSURE_NAME, user, {
+    return createExposure(LAYER_EXPOSURE_NAME, user, spec.details, {
         config: layerName,
         parameterName: parameterName,
         ruleID: spec.rule_id,
         allocatedExperiment: allocatedExperiment,
         isExplicitParameter: String(isExplicit),
-        reason: spec.source,
     }, secondaryExposures);
 }
 exports.createLayerParameterExposure = createLayerParameterExposure;
+function _addEvaluationDetailsToMetadata(details, metadata) {
+    metadata['reason'] = details.reason;
+    if (details.lcut) {
+        metadata['lcut'] = String(details.lcut);
+    }
+    if (details.receivedAt) {
+        metadata['receivedAt'] = String(details.receivedAt);
+    }
+    return metadata;
+}

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.1';
+var SDK_VERSION = '0.0.1-beta.10';
 var metadata = {
     sdkVersion: SDK_VERSION,
     sdkType: 'js-mono', // js-mono is overwritten by Precomp and OnDevice clients

package/src/StatsigOptionsCommon.d.ts

@@ -1,5 +1,5 @@
 import { LogLevel } from './Log';
-import { StatsigDataProvider } from './StatsigDataProvider';
+import { StatsigDataAdapter } from './StatsigDataAdapter';
 /** Common options for configuring the Statsig SDK. */
 export type StatsigOptionsCommon = {
     /**
@@ -18,14 +18,14 @@ export type StatsigOptionsCommon = {
     overrideStableID?: string;
     /**
      * How much information is allowed to be printed to the console.
-     * Default: LogLevel.Error
+     * Default: LogLevel.Warn
      */
     logLevel?: LogLevel;
     /**
-     * StatsigDataProvider implementors used to customize the initialization flow.
-     * Default: LocalStorageCache then Network
+     * StatsigDataAdapter implementor used to customize the initialization/update flow.
+     * Default: EvaluationsDataAdapter (Precomputed) or SpecsDataAdapter (OnDevice)
      */
-    dataProviders?: StatsigDataProvider[];
+    dataAdapter?: StatsigDataAdapter;
     /**
      * The maximum amount of time (in milliseconds) that any network request can take
      * before timing out. Default: 10,000 (10 seconds)

package/src/StatsigTypes.d.ts

@@ -1,10 +1,15 @@
 export type Flatten<T> = {
     [K in keyof T]: T[K];
 } & {};
+export type EvaluationDetails = {
+    reason: string;
+    lcut?: number;
+    receivedAt?: number;
+};
 type EvaluatedSpec = {
     readonly name: string;
     readonly ruleID: string;
-    readonly source: string;
+    readonly details: EvaluationDetails;
 };
 export type FeatureGate = EvaluatedSpec & {
     readonly value: boolean;
@@ -16,7 +21,7 @@ export type Experiment = DynamicConfig;
 export type Layer = EvaluatedSpec & {
     readonly getValue: (parameterName: string) => unknown;
 };
-export declare function makeFeatureGate(name: string, source: string, ruleID?: string, value?: boolean): FeatureGate;
-export declare function makeDynamicConfig(name: string, source: string, ruleID?: string, value?: Record<string, unknown>): DynamicConfig;
-export declare function makeLayer(name: string, source: string, ruleID?: string, getValue?: (param: string) => unknown): Layer;
+export declare function makeFeatureGate(name: string, details: EvaluationDetails, ruleID?: string, value?: boolean): FeatureGate;
+export declare function makeDynamicConfig(name: string, details: EvaluationDetails, ruleID?: string, value?: Record<string, unknown>): DynamicConfig;
+export declare function makeLayer(name: string, details: EvaluationDetails, ruleID?: string, getValue?: (param: string) => unknown): Layer;
 export {};

package/src/StatsigTypes.js

@@ -2,28 +2,28 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeLayer = exports.makeDynamicConfig = exports.makeFeatureGate = void 0;
 var DEFAULT_RULE = 'default';
-function makeFeatureGate(name, source, ruleID, value) {
+function makeFeatureGate(name, details, ruleID, value) {
     return {
         name: name,
-        source: source,
+        details: details,
         ruleID: ruleID !== null && ruleID !== void 0 ? ruleID : DEFAULT_RULE,
         value: value === true,
     };
 }
 exports.makeFeatureGate = makeFeatureGate;
-function makeDynamicConfig(name, source, ruleID, value) {
+function makeDynamicConfig(name, details, ruleID, value) {
     return {
         name: name,
-        source: source,
+        details: details,
         ruleID: ruleID !== null && ruleID !== void 0 ? ruleID : DEFAULT_RULE,
         value: value !== null && value !== void 0 ? value : {},
     };
 }
 exports.makeDynamicConfig = makeDynamicConfig;
-function makeLayer(name, source, ruleID, getValue) {
+function makeLayer(name, details, ruleID, getValue) {
     return {
         name: name,
-        source: source,
+        details: details,
         getValue: getValue !== null && getValue !== void 0 ? getValue : (function () { return undefined; }),
         ruleID: ruleID !== null && ruleID !== void 0 ? ruleID : DEFAULT_RULE,
     };

package/src/StatsigUser.js

@@ -16,22 +16,21 @@ function normalizeUser(original, environment) {
 }
 exports.normalizeUser = normalizeUser;
 function getUserStorageKey(sdkKey, user) {
-    var _a, _b;
-    var parts = [
-        "uid:".concat((_a = user === null || user === void 0 ? void 0 : user.userID) !== null && _a !== void 0 ? _a : ''),
-        "cids:".concat(Object.entries((_b = user === null || user === void 0 ? void 0 : user.customIDs) !== null && _b !== void 0 ? _b : {})
-            .sort(function (_a, _b) {
-            var leftKey = _a[0];
-            var rightKey = _b[0];
-            return leftKey.localeCompare(rightKey);
-        })
-            .map(function (_a) {
-            var key = _a[0], value = _a[1];
-            return "".concat(key, "-").concat(value);
-        })
-            .join(',')),
-        "k:".concat(sdkKey),
-    ];
-    return (0, Hashing_1.DJB2)(parts.join('|'));
+    return (0, Hashing_1.DJB2)(JSON.stringify(_getSortedObject({ sdkKey: sdkKey, user: user })));
 }
 exports.getUserStorageKey = getUserStorageKey;
+function _getSortedObject(object) {
+    if (object == null) {
+        return null;
+    }
+    var keys = Object.keys(object).sort();
+    var sortedObject = {};
+    keys.forEach(function (key) {
+        var value = object[key];
+        if (value instanceof Object) {
+            value = _getSortedObject(value);
+        }
+        sortedObject[key] = value;
+    });
+    return sortedObject;
+}

package/src/StorageProvider.d.ts

@@ -1,7 +1,9 @@
 type StorageProvider = {
+    getProviderName: () => string;
     getItem: (key: string) => Promise<string | null>;
     setItem: (key: string, value: string) => Promise<void>;
     removeItem: (key: string) => Promise<void>;
+    getAllKeys: () => Promise<readonly string[]>;
 };
 export declare const Storage: StorageProvider & {
     setProvider: (n: StorageProvider) => void;

package/src/StorageProvider.js

@@ -40,6 +40,7 @@ exports.setObjectInStorage = exports.getObjectFromStorage = exports.Storage = vo
 var Log_1 = require("./Log");
 var inMemoryStore = {};
 var provider = {
+    getProviderName: function () { return 'InMemory'; },
     getItem: function (key) {
         var _a;
         return Promise.resolve((_a = inMemoryStore[key]) !== null && _a !== void 0 ? _a : null);
@@ -52,10 +53,14 @@ var provider = {
         delete inMemoryStore[key];
         return Promise.resolve();
     },
+    getAllKeys: function () {
+        return Promise.resolve(Object.keys(inMemoryStore));
+    },
 };
 try {
     if (typeof window !== 'undefined' && 'localStorage' in window) {
         provider = {
+            getProviderName: function () { return 'LocalStorage'; },
             getItem: function (key) {
                 return Promise.resolve(localStorage.getItem(key));
             },
@@ -67,6 +72,10 @@ try {
                 localStorage.removeItem(key);
                 return Promise.resolve();
             },
+            getAllKeys: function () {
+                var keys = Object.keys(localStorage);
+                return Promise.resolve(keys);
+            },
         };
     }
 }
@@ -74,9 +83,11 @@ catch (error) {
     Log_1.Log.warn('Failed to get storage provider. Failling back to in memory store.');
 }
 exports.Storage = {
+    getProviderName: function () { return provider.getProviderName(); },
     getItem: function (key) { return provider.getItem(key); },
     setItem: function (key, value) { return provider.setItem(key, value); },
     removeItem: function (key) { return provider.removeItem(key); },
+    getAllKeys: function () { return provider.getAllKeys(); },
     setProvider: function (newProvider) {
         provider = newProvider;
     },

package/src/VisibilityChangeObserver.js

@@ -24,12 +24,15 @@ var VisibilityChangeObserver = /** @class */ (function () {
         this._listeners.forEach(function (l) { return l.onVisibilityChanged(visibility); });
     };
     VisibilityChangeObserver._listeners = [];
-    VisibilityChangeObserver._current = null;
+    VisibilityChangeObserver._current = 'foreground';
     return VisibilityChangeObserver;
 }());
 exports.VisibilityChangeObserver = VisibilityChangeObserver;
 if (typeof window !== 'undefined' &&
     typeof window.addEventListener === 'function') {
+    window.addEventListener('focus', function () {
+        return VisibilityChangeObserver.notify('foreground');
+    });
     window.addEventListener('blur', function () {
         return VisibilityChangeObserver.notify('background');
     });

package/src/index.d.ts

@@ -1,23 +1,26 @@
 /** Statsig Global should go first */
 import './$_StatsigGlobal';
 import { EventLogger } from './EventLogger';
+import { Log } from './Log';
+import { Storage } from './StorageProvider';
 export * from './$_StatsigGlobal';
 export * from './ClientInterfaces';
+export * from './DataAdapterCore';
 export * from './ErrorBoundary';
 export * from './Hashing';
-export * from './StorageProvider';
 export * from './Log';
 export * from './Monitoring';
 export * from './NetworkCore';
 export * from './StableID';
 export * from './StatsigClientBase';
 export * from './StatsigClientEventEmitter';
-export * from './StatsigDataProvider';
+export * from './StatsigDataAdapter';
 export * from './StatsigEvent';
 export * from './StatsigMetadata';
 export * from './StatsigOptionsCommon';
 export * from './StatsigTypes';
 export * from './StatsigUser';
+export * from './StorageProvider';
 export * from './UUID';
 export * from './VisibilityChangeObserver';
-export { EventLogger };
+export { EventLogger, Storage, Log };

package/src/index.js

@@ -25,28 +25,33 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventLogger = void 0;
+exports.Log = exports.Storage = exports.EventLogger = void 0;
 /** Statsig Global should go first */
 require("./$_StatsigGlobal");
 var EventLogger_1 = require("./EventLogger");
 Object.defineProperty(exports, "EventLogger", { enumerable: true, get: function () { return EventLogger_1.EventLogger; } });
+var Log_1 = require("./Log");
+Object.defineProperty(exports, "Log", { enumerable: true, get: function () { return Log_1.Log; } });
+var StorageProvider_1 = require("./StorageProvider");
+Object.defineProperty(exports, "Storage", { enumerable: true, get: function () { return StorageProvider_1.Storage; } });
 __exportStar(require("./$_StatsigGlobal"), exports);
 __exportStar(require("./ClientInterfaces"), exports);
+__exportStar(require("./DataAdapterCore"), exports);
 __exportStar(require("./ErrorBoundary"), exports);
 __exportStar(require("./Hashing"), exports);
-__exportStar(require("./StorageProvider"), exports);
 __exportStar(require("./Log"), exports);
 __exportStar(require("./Monitoring"), exports);
 __exportStar(require("./NetworkCore"), exports);
 __exportStar(require("./StableID"), exports);
 __exportStar(require("./StatsigClientBase"), exports);
 __exportStar(require("./StatsigClientEventEmitter"), exports);
-__exportStar(require("./StatsigDataProvider"), exports);
+__exportStar(require("./StatsigDataAdapter"), exports);
 __exportStar(require("./StatsigEvent"), exports);
 __exportStar(require("./StatsigMetadata"), exports);
 __exportStar(require("./StatsigOptionsCommon"), exports);
 __exportStar(require("./StatsigTypes"), exports);
 __exportStar(require("./StatsigUser"), exports);
+__exportStar(require("./StorageProvider"), exports);
 __exportStar(require("./UUID"), exports);
 __exportStar(require("./VisibilityChangeObserver"), exports);
-__STATSIG__ = __assign(__assign({}, (__STATSIG__ !== null && __STATSIG__ !== void 0 ? __STATSIG__ : {})), { EventLogger: EventLogger_1.EventLogger });
+__STATSIG__ = __assign(__assign({}, (__STATSIG__ !== null && __STATSIG__ !== void 0 ? __STATSIG__ : {})), { EventLogger: EventLogger_1.EventLogger, Log: Log_1.Log, Storage: StorageProvider_1.Storage });

package/src/StatsigDataProvider.d.ts

@@ -1,9 +0,0 @@
-import { StatsigUser } from './StatsigUser';
-export type DataSource = 'Uninitialized' | 'Loading' | 'NoValues' | 'Cache' | 'Network' | 'Bootstrap' | 'Prefetch';
-export type StatsigDataProvider = {
-    readonly getData?: (sdkKey: string, user?: StatsigUser) => string | null;
-    readonly getDataAsync?: (sdkKey: string, user?: StatsigUser) => Promise<string | null>;
-    readonly getDataPostInit?: (sdkKey: string, user?: StatsigUser) => Promise<string | null>;
-    readonly setDataPostInit?: (sdkKey: string, data: string, user?: StatsigUser) => Promise<void>;
-    readonly source: DataSource;
-};

package/src/StatsigDataProvider.js

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