@statsig/client-core 0.0.1-beta.22 → 0.0.1-beta.24

package/package.json

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

package/src/$_StatsigGlobal.d.ts

@@ -1,7 +1,8 @@
-import { StatsigClientInterface } from "./ClientInterfaces";
+import { StatsigClientInterface } from './ClientInterfaces';
 export type StatsigGlobal = {
     [key: string]: unknown;
     instances?: Record<string, StatsigClientInterface>;
+    lastInstance?: StatsigClientInterface;
 };
 declare global {
     let __STATSIG__: StatsigGlobal | undefined;

package/src/$_StatsigGlobal.js

@@ -1,6 +1,5 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
 var _a, _b, _c;
 Object.defineProperty(exports, "__esModule", { value: true });
 const _window = typeof window !== 'undefined' ? window : {};

package/src/ClientInterfaces.d.ts

@@ -1,14 +1,16 @@
 import { DynamicConfigEvaluationOptions, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, LayerEvaluationOptions } from './EvaluationOptions';
+import { InitializeResponseWithUpdates } from './InitializeResponse';
 import { StatsigClientEventEmitterInterface } from './StatsigClientEventEmitter';
 import { EvaluationsDataAdapter, SpecsDataAdapter } from './StatsigDataAdapter';
 import { StatsigEvent } from './StatsigEvent';
-import { StatsigRuntimeMutableOptions } from './StatsigOptionsCommon';
+import { StatsigOptionsCommon, StatsigRuntimeMutableOptions } from './StatsigOptionsCommon';
 import { DynamicConfig, Experiment, FeatureGate, Layer } from './StatsigTypes';
 import { StatsigUser } from './StatsigUser';
 export interface StatsigClientCommonInterface extends StatsigClientEventEmitterInterface {
     initializeSync(): void;
     initializeAsync(): Promise<void>;
     shutdown(): Promise<void>;
+    flush(): Promise<void>;
     updateRuntimeOptions(options: StatsigRuntimeMutableOptions): void;
 }
 export interface OnDeviceEvaluationsInterface extends StatsigClientCommonInterface {
@@ -20,9 +22,20 @@ export interface OnDeviceEvaluationsInterface extends StatsigClientCommonInterfa
     getLayer(name: string, user: StatsigUser, options?: LayerEvaluationOptions): Layer;
     logEvent(event: StatsigEvent, user: StatsigUser): void;
 }
+export type PrecomputedEvaluationsContext = {
+    sdkKey: string;
+    options: StatsigOptionsCommon;
+    values: InitializeResponseWithUpdates | null;
+    user: StatsigUser;
+};
+export type PrecomputedEvaluationsAsyncContext = {
+    sessionID: string;
+    stableID: string;
+} & PrecomputedEvaluationsContext;
 export interface PrecomputedEvaluationsInterface extends StatsigClientCommonInterface {
     readonly dataAdapter: EvaluationsDataAdapter;
-    getCurrentUser(): StatsigUser;
+    getAsyncContext(): Promise<PrecomputedEvaluationsAsyncContext>;
+    getContext(): PrecomputedEvaluationsContext;
     updateUserSync(user: StatsigUser): void;
     updateUserAsync(user: StatsigUser): Promise<void>;
     checkGate(name: string, options?: FeatureGateEvaluationOptions): boolean;

package/src/InitializeResponse.d.ts

@@ -0,0 +1,18 @@
+import { DynamicConfigEvaluation, GateEvaluation, LayerEvaluation } from './EvaluationTypes';
+type SessionReplayFields = {
+    can_record_session?: boolean;
+    session_recording_rate?: number;
+};
+export type InitializeResponseWithUpdates = SessionReplayFields & {
+    feature_gates: Record<string, GateEvaluation>;
+    dynamic_configs: Record<string, DynamicConfigEvaluation>;
+    layer_configs: Record<string, LayerEvaluation>;
+    time: number;
+    has_updates: true;
+    hash_used: 'none' | 'sha256' | 'djb2';
+    derived_fields?: Record<string, unknown>;
+};
+export type InitializeResponse = InitializeResponseWithUpdates | {
+    has_updates: false;
+};
+export {};

package/src/InitializeResponse.js

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

package/src/NetworkCore.js

@@ -40,7 +40,7 @@ class NetworkCore {
     }
     beacon(args) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = this._getPopulatedURL(args);
+            const url = yield this._getPopulatedURL(args);
             const body = yield this._getPopulatedBody(args);
             return navigator.sendBeacon(url, body);
         });
@@ -51,7 +51,7 @@ class NetworkCore {
             const { method, body, retries } = args;
             const controller = new AbortController();
             const handle = setTimeout(() => controller.abort(`Timeout of ${this._timeout}ms expired.`), this._timeout);
-            const url = this._getPopulatedURL(args);
+            const url = yield this._getPopulatedURL(args);
             let response = null;
             try {
                 response = yield fetch(url, {
@@ -94,20 +94,22 @@ class NetworkCore {
         });
     }
     _getPopulatedURL(args) {
-        const metadata = StatsigMetadata_1.StatsigMetadataProvider.get();
-        const params = Object.assign({ k: args.sdkKey, st: metadata.sdkType, sv: metadata.sdkVersion, t: String(Date.now()), sid: SessionID_1.SessionID.get(args.sdkKey) }, args.params);
-        const query = Object.entries(params)
-            .map(([key, value]) => {
-            return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        })
-            .join('&');
-        return `${args.url}${query ? `?${query}` : ''}`;
+        return __awaiter(this, void 0, void 0, function* () {
+            const metadata = StatsigMetadata_1.StatsigMetadataProvider.get();
+            const params = Object.assign({ k: args.sdkKey, st: metadata.sdkType, sv: metadata.sdkVersion, t: String(Date.now()), sid: yield SessionID_1.SessionID.get(args.sdkKey) }, args.params);
+            const query = Object.entries(params)
+                .map(([key, value]) => {
+                return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+            })
+                .join('&');
+            return `${args.url}${query ? `?${query}` : ''}`;
+        });
     }
     _getPopulatedBody(args) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = args;
             const stableID = yield StableID_1.StableID.get(args.sdkKey);
-            const sessionID = SessionID_1.SessionID.get(args.sdkKey);
+            const sessionID = yield SessionID_1.SessionID.get(args.sdkKey);
             return JSON.stringify(Object.assign(Object.assign({}, data), { statsigMetadata: Object.assign(Object.assign({}, StatsigMetadata_1.StatsigMetadataProvider.get()), { stableID,
                     sessionID }) }));
         });

package/src/SessionID.d.ts

@@ -1,3 +1,3 @@
 export declare const SessionID: {
-    get: (sdkKey: string) => string;
+    get: (sdkKey: string) => Promise<string>;
 };

package/src/SessionID.js

@@ -1,13 +1,55 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SessionID = void 0;
+const Hashing_1 = require("./Hashing");
+const Log_1 = require("./Log");
+const StorageProvider_1 = require("./StorageProvider");
 const UUID_1 = require("./UUID");
 const SESSION_ID_MAP = {};
+const MAX_SESSION_IDLE_TIME = 10 * 60 * 1000; // 10 minutes
+const MAX_SESSION_AGE = 4 * 60 * 60 * 1000; // 4 hours
 exports.SessionID = {
-    get: (sdkKey) => {
-        if (SESSION_ID_MAP[sdkKey] == null) {
-            SESSION_ID_MAP[sdkKey] = (0, UUID_1.getUUID)();
+    get: (sdkKey) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        let session = SESSION_ID_MAP[sdkKey];
+        if (session == null) {
+            session = (_a = (yield _loadFromStorage(sdkKey))) !== null && _a !== void 0 ? _a : {
+                sessionID: (0, UUID_1.getUUID)(),
+                startTime: Date.now(),
+                lastUpdate: Date.now(),
+            };
+            SESSION_ID_MAP[sdkKey] = session;
+        }
+        if (Date.now() - session.startTime > MAX_SESSION_AGE ||
+            Date.now() - session.lastUpdate > MAX_SESSION_IDLE_TIME) {
+            session.sessionID = (0, UUID_1.getUUID)();
+            session.startTime = Date.now();
         }
-        return SESSION_ID_MAP[sdkKey];
-    },
+        session.lastUpdate = Date.now();
+        _persistToStorage(session, sdkKey);
+        SESSION_ID_MAP[sdkKey] = session;
+        return session.sessionID;
+    }),
 };
+function _getSessionIDStorageKey(sdkKey) {
+    return `statsig.session_id.${(0, Hashing_1.DJB2)(sdkKey)}`;
+}
+function _persistToStorage(session, sdkKey) {
+    const storageKey = _getSessionIDStorageKey(sdkKey);
+    (0, StorageProvider_1.setObjectInStorage)(storageKey, session).catch(() => {
+        Log_1.Log.warn('Failed to save SessionID');
+    });
+}
+function _loadFromStorage(sdkKey) {
+    const storageKey = _getSessionIDStorageKey(sdkKey);
+    return (0, StorageProvider_1.getObjectFromStorage)(storageKey);
+}

package/src/StatsigClientBase.d.ts

@@ -9,17 +9,25 @@ import { DataAdapterResult, EvaluationsDataAdapter, SpecsDataAdapter } from './S
 import { StatsigEventInternal } from './StatsigEvent';
 import { StatsigOptionsCommon, StatsigRuntimeMutableOptions } from './StatsigOptionsCommon';
 export type StatsigClientEmitEventFunc = (event: StatsigClientEvent) => void;
+export type StatsigContext = {
+    sdkKey: string;
+    options: StatsigOptionsCommon;
+    sessionID: string;
+    values: unknown;
+};
 export declare abstract class StatsigClientBase<TAdapter extends EvaluationsDataAdapter | SpecsDataAdapter> implements StatsigClientEventEmitterInterface {
-    protected readonly _sdkKey: string;
     loadingStatus: StatsigLoadingStatus;
     readonly dataAdapter: TAdapter;
+    protected readonly _sdkKey: string;
+    protected readonly _options: StatsigOptionsCommon;
     protected readonly _errorBoundary: ErrorBoundary;
     protected readonly _logger: EventLogger;
     protected readonly _overrideAdapter: OverrideAdapter | null;
     private _listeners;
-    constructor(_sdkKey: string, adapter: TAdapter, network: NetworkCore, options: StatsigOptionsCommon | null);
+    constructor(sdkKey: string, adapter: TAdapter, network: NetworkCore, options: StatsigOptionsCommon | null);
     updateRuntimeOptions(options: StatsigRuntimeMutableOptions): void;
     flush(): Promise<void>;
+    shutdown(): Promise<void>;
     on<T extends StatsigClientEventName>(event: T, listener: StatsigClientEventCallback<T>): void;
     off<T extends StatsigClientEventName>(event: T, listener: StatsigClientEventCallback<T>): void;
     protected _emit(event: StatsigClientEvent): void;

package/src/StatsigClientBase.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatsigClientBase = void 0;
 require("./$_StatsigGlobal");
@@ -8,36 +17,47 @@ const Log_1 = require("./Log");
 const StableID_1 = require("./StableID");
 const StorageProvider_1 = require("./StorageProvider");
 class StatsigClientBase {
-    constructor(_sdkKey, adapter, network, options) {
+    constructor(sdkKey, adapter, network, options) {
         var _a, _b, _c;
-        this._sdkKey = _sdkKey;
         this.loadingStatus = 'Uninitialized';
         this._listeners = {};
+        this._sdkKey = sdkKey;
+        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);
+            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);
-        this._errorBoundary = new ErrorBoundary_1.ErrorBoundary(_sdkKey);
+        this._logger = new EventLogger_1.EventLogger(sdkKey, this._emit.bind(this), network, options);
+        this._errorBoundary = new ErrorBoundary_1.ErrorBoundary(sdkKey);
         __STATSIG__ = __STATSIG__ !== null && __STATSIG__ !== void 0 ? __STATSIG__ : {};
         const instances = (_c = __STATSIG__.instances) !== null && _c !== void 0 ? _c : {};
-        instances[_sdkKey] = this;
+        const inst = this;
+        instances[sdkKey] = inst;
         __STATSIG__.instances = instances;
+        __STATSIG__.lastInstance = inst;
         this.dataAdapter = adapter;
-        this.dataAdapter.attach(_sdkKey, options);
+        this.dataAdapter.attach(sdkKey, options);
     }
     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);
         }
     }
     flush() {
         return this._logger.flush();
     }
+    shutdown() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._emit({ name: 'pre_shutdown' });
+            yield this._logger.shutdown();
+        });
+    }
     on(event, listener) {
         if (!this._listeners[event]) {
             this._listeners[event] = [];

package/src/StatsigClientEventEmitter.d.ts

@@ -13,6 +13,7 @@ type EventNameToEventDataMap = {
     logs_flushed: {
         events: Record<string, unknown>[];
     };
+    pre_shutdown: object;
     gate_evaluation: {
         gate: FeatureGate;
     };
@@ -35,6 +36,8 @@ type EventNameToEventDataMap = {
  *
  * `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.

package/src/StatsigMetadata.js

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

package/src/index.d.ts

@@ -10,10 +10,12 @@ export * from './ErrorBoundary';
 export * from './EvaluationOptions';
 export * from './EvaluationTypes';
 export * from './Hashing';
+export * from './InitializeResponse';
 export * from './Log';
 export * from './Monitoring';
 export * from './NetworkCore';
 export * from './OverrideAdapter';
+export * from './SessionID';
 export * from './StableID';
 export * from './StatsigClientBase';
 export * from './StatsigClientEventEmitter';

package/src/index.js

@@ -30,10 +30,12 @@ __exportStar(require("./ErrorBoundary"), exports);
 __exportStar(require("./EvaluationOptions"), exports);
 __exportStar(require("./EvaluationTypes"), exports);
 __exportStar(require("./Hashing"), exports);
+__exportStar(require("./InitializeResponse"), exports);
 __exportStar(require("./Log"), exports);
 __exportStar(require("./Monitoring"), exports);
 __exportStar(require("./NetworkCore"), exports);
 __exportStar(require("./OverrideAdapter"), exports);
+__exportStar(require("./SessionID"), exports);
 __exportStar(require("./StableID"), exports);
 __exportStar(require("./StatsigClientBase"), exports);
 __exportStar(require("./StatsigClientEventEmitter"), exports);