@statsig/client-core 3.30.2 → 3.31.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/client-core",
-  "version": "3.30.2",
+  "version": "3.31.1",
   "license": "ISC",
   "homepage": "https://github.com/statsig-io/js-client-monorepo",
   "repository": {

package/src/ClientInterfaces.d.ts

@@ -2,7 +2,7 @@ import { DownloadConfigSpecsResponse } from './DownloadConfigSpecsResponse';
 import { ErrorBoundary } from './ErrorBoundary';
 import { DynamicConfigEvaluationOptions, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, LayerEvaluationOptions, ParameterStoreEvaluationOptions } from './EvaluationOptions';
 import { AnyInitializeResponse, ClientInitializeResponseOptions } from './InitializeResponse';
-import { StatsigSession } from './SessionID';
+import { StatsigSession, StatsigSession as StatsigSessionType } from './SessionID';
 import { StatsigClientEventEmitterInterface } from './StatsigClientEventEmitter';
 import { EvaluationsDataAdapter, SpecsDataAdapter } from './StatsigDataAdapter';
 import { StatsigEvent } from './StatsigEvent';
@@ -48,6 +48,7 @@ export type PrecomputedEvaluationsContext = Flatten<CommonContext & {
 export interface PrecomputedEvaluationsInterface extends StatsigClientCommonInterface {
     readonly dataAdapter: EvaluationsDataAdapter;
     getContext(): PrecomputedEvaluationsContext;
+    getContextHandle(): PrecomputedEvaluationsContextHandle;
     updateUserSync(user: StatsigUser): StatsigUpdateDetails;
     updateUserAsync(user: StatsigUser): Promise<StatsigUpdateDetails>;
     checkGate(name: string, options?: FeatureGateEvaluationOptions): boolean;
@@ -60,3 +61,35 @@ export interface PrecomputedEvaluationsInterface extends StatsigClientCommonInte
     logEvent(eventName: string, value?: string | number, metadata?: Record<string, string>): void;
 }
 export type StatsigClientInterface = OnDeviceEvaluationsInterface | PrecomputedEvaluationsInterface;
+/**
+ * A handle to the PrecomputedEvaluationsContext that computes fields lazily on access.
+ * This avoids unnecessary computation (e.g., cloning the user) when only certain fields are needed.
+ * The handle is created once and reused; individual getters fetch current values on each access.
+ */
+export declare class PrecomputedEvaluationsContextHandle {
+    private _sdkKey;
+    private _getOptions;
+    private _getErrorBoundary;
+    private _getValues;
+    private _getUser;
+    private _getSdkInstanceID;
+    constructor(sdkKey: string, getOptions: () => AnyStatsigOptions, getErrorBoundary: () => ErrorBoundary, getValues: () => AnyInitializeResponse | null, getUser: () => StatsigUser, getSdkInstanceID: () => string);
+    get sdkKey(): string;
+    get options(): AnyStatsigOptions;
+    get errorBoundary(): ErrorBoundary;
+    get values(): AnyInitializeResponse | null;
+    get user(): StatsigUser;
+    /**
+     * Gets the current session.
+     * @param {boolean} [bumpSession=true] - Whether to bump/update the session timing. Set to false to read without affecting session state.
+     */
+    getSession(bumpSession?: boolean): StatsigSessionType;
+    get stableID(): string | null;
+    get sdkInstanceID(): string;
+    /**
+     * Returns the full PrecomputedEvaluationsContext object.
+     * Use this when you need all fields at once.
+     * @param {boolean} [bumpSession=true] - Whether to bump the session when building the context.
+     */
+    toContext(bumpSession?: boolean): PrecomputedEvaluationsContext;
+}

package/src/ClientInterfaces.js

@@ -1,2 +1,73 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrecomputedEvaluationsContextHandle = void 0;
+const Log_1 = require("./Log");
+const SafeJs_1 = require("./SafeJs");
+const SessionID_1 = require("./SessionID");
+const StableID_1 = require("./StableID");
+/**
+ * A handle to the PrecomputedEvaluationsContext that computes fields lazily on access.
+ * This avoids unnecessary computation (e.g., cloning the user) when only certain fields are needed.
+ * The handle is created once and reused; individual getters fetch current values on each access.
+ */
+class PrecomputedEvaluationsContextHandle {
+    constructor(sdkKey, getOptions, getErrorBoundary, getValues, getUser, getSdkInstanceID) {
+        this._sdkKey = sdkKey;
+        this._getOptions = getOptions;
+        this._getErrorBoundary = getErrorBoundary;
+        this._getValues = getValues;
+        this._getUser = getUser;
+        this._getSdkInstanceID = getSdkInstanceID;
+    }
+    get sdkKey() {
+        return this._sdkKey;
+    }
+    get options() {
+        return this._getOptions();
+    }
+    get errorBoundary() {
+        return this._getErrorBoundary();
+    }
+    get values() {
+        return this._getValues();
+    }
+    get user() {
+        let user = (0, SafeJs_1._cloneObject)('StatsigUser', this._getUser());
+        if (user == null) {
+            Log_1.Log.error('Failed to clone user');
+            user = {};
+        }
+        return user;
+    }
+    /**
+     * Gets the current session.
+     * @param {boolean} [bumpSession=true] - Whether to bump/update the session timing. Set to false to read without affecting session state.
+     */
+    getSession(bumpSession = true) {
+        return SessionID_1.StatsigSession.get(this._sdkKey, bumpSession);
+    }
+    get stableID() {
+        return StableID_1.StableID.get(this._sdkKey);
+    }
+    get sdkInstanceID() {
+        return this._getSdkInstanceID();
+    }
+    /**
+     * Returns the full PrecomputedEvaluationsContext object.
+     * Use this when you need all fields at once.
+     * @param {boolean} [bumpSession=true] - Whether to bump the session when building the context.
+     */
+    toContext(bumpSession = true) {
+        return {
+            sdkKey: this.sdkKey,
+            options: this.options,
+            values: this.values,
+            user: this.user,
+            errorBoundary: this.errorBoundary,
+            session: this.getSession(bumpSession),
+            stableID: this.stableID,
+            sdkInstanceID: this.sdkInstanceID,
+        };
+    }
+}
+exports.PrecomputedEvaluationsContextHandle = PrecomputedEvaluationsContextHandle;

package/src/EventBatch.d.ts

@@ -0,0 +1,8 @@
+import { StatsigEventInternal } from './StatsigEvent';
+export declare class EventBatch {
+    attempts: number;
+    readonly events: StatsigEventInternal[];
+    readonly createdAt: number;
+    constructor(events: StatsigEventInternal[]);
+    incrementAttempts(): void;
+}

package/src/EventBatch.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventBatch = void 0;
+class EventBatch {
+    constructor(events) {
+        this.attempts = 0;
+        this.createdAt = Date.now();
+        this.events = events;
+    }
+    incrementAttempts() {
+        this.attempts++;
+    }
+}
+exports.EventBatch = EventBatch;

package/src/EventRetryConstants.d.ts

@@ -0,0 +1,7 @@
+export declare const EventRetryConstants: {
+    readonly MAX_RETRY_ATTEMPTS: 5;
+    readonly DEFAULT_BATCH_SIZE: 100;
+    readonly MAX_PENDING_BATCHES: 10;
+    readonly TICK_INTERVAL_MS: 1000;
+    readonly MAX_QUEUED_EVENTS: number;
+};

package/src/EventRetryConstants.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventRetryConstants = void 0;
+exports.EventRetryConstants = {
+    MAX_RETRY_ATTEMPTS: 5,
+    DEFAULT_BATCH_SIZE: 100,
+    MAX_PENDING_BATCHES: 10,
+    TICK_INTERVAL_MS: 1000,
+    get MAX_QUEUED_EVENTS() {
+        return this.DEFAULT_BATCH_SIZE * this.MAX_PENDING_BATCHES;
+    },
+};

package/src/InitializeResponse.d.ts

@@ -9,11 +9,18 @@ type SessionReplayFields = {
     passes_session_recording_targeting?: boolean;
     session_recording_event_triggers?: Record<string, SessionReplayTrigger>;
     session_recording_exposure_triggers?: Record<string, SessionReplayTrigger>;
+    session_recording_privacy_settings?: SessionReplayPrivacySettings;
 };
 type SessionReplayTrigger = {
     values?: string[];
     passes_sampling?: boolean;
 };
+export type SessionReplayPrivacySettings = {
+    privacy_mode?: 'min' | 'input' | 'max';
+    unmasked_elements?: string[];
+    masked_elements?: string[];
+    blocked_elements?: string[];
+};
 type AutoCaptureFields = {
     auto_capture_settings?: {
         disabled_events: Record<string, boolean>;

package/src/SafeJs.d.ts

@@ -5,3 +5,4 @@ export declare const _addWindowEventListenerSafe: (key: string, listener: () =>
 export declare const _addDocumentEventListenerSafe: (key: string, listener: () => void) => void;
 export declare const _getCurrentPageUrlSafe: () => string | undefined;
 export declare const _getUnloadEvent: () => string;
+export declare const _cloneObject: <T>(tag: string, obj: T) => T | null;

package/src/SafeJs.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._getUnloadEvent = exports._getCurrentPageUrlSafe = exports._addDocumentEventListenerSafe = exports._addWindowEventListenerSafe = exports._isServerEnv = exports._getDocumentSafe = exports._getWindowSafe = void 0;
+exports._cloneObject = exports._getUnloadEvent = exports._getCurrentPageUrlSafe = exports._addDocumentEventListenerSafe = exports._addWindowEventListenerSafe = exports._isServerEnv = exports._getDocumentSafe = exports._getWindowSafe = void 0;
+const Log_1 = require("./Log");
 const _getWindowSafe = () => {
     return typeof window !== 'undefined' ? window : null;
 };
@@ -55,3 +56,13 @@ const _getUnloadEvent = () => {
     return eventType;
 };
 exports._getUnloadEvent = _getUnloadEvent;
+const _cloneObject = (tag, obj) => {
+    try {
+        return JSON.parse(JSON.stringify(obj));
+    }
+    catch (error) {
+        Log_1.Log.error(`Failed to clone object ${tag}`);
+        return null;
+    }
+};
+exports._cloneObject = _cloneObject;

package/src/SessionID.d.ts

@@ -14,7 +14,7 @@ export declare const SessionID: {
     get: (sdkKey: string) => string;
 };
 export declare const StatsigSession: {
-    get: (sdkKey: string) => StatsigSession;
+    get: (sdkKey: string, bumpSession?: boolean) => StatsigSession;
     overrideInitialSessionID: (override: string, sdkKey: string) => void;
 };
 export {};

package/src/SessionID.js

@@ -15,12 +15,12 @@ exports.SessionID = {
     },
 };
 exports.StatsigSession = {
-    get: (sdkKey) => {
+    get: (sdkKey, bumpSession = true) => {
         if (PROMISE_MAP[sdkKey] == null) {
             PROMISE_MAP[sdkKey] = _loadSession(sdkKey);
         }
         const session = PROMISE_MAP[sdkKey];
-        return _bumpSession(session);
+        return bumpSession ? _bumpSession(session) : session;
     },
     overrideInitialSessionID: (override, sdkKey) => {
         PROMISE_MAP[sdkKey] = _overrideSessionId(override, sdkKey);
@@ -53,16 +53,14 @@ function _overrideSessionId(override, sdkKey) {
     };
 }
 function _bumpSession(session) {
+    var _a;
     const now = Date.now();
     const data = session.data;
     const sdkKey = session.sdkKey;
-    if (_isIdle(data) || _hasRunTooLong(data)) {
+    const sessionExpired = _isIdle(data) || _hasRunTooLong(data);
+    if (sessionExpired) {
         data.sessionID = (0, UUID_1.getUUID)();
         data.startTime = now;
-        const client = __STATSIG__ === null || __STATSIG__ === void 0 ? void 0 : __STATSIG__.instance(sdkKey);
-        if (client) {
-            client.$emt({ name: 'session_expired' });
-        }
     }
     data.lastUpdate = now;
     _persistToStorage(data, session.sdkKey);
@@ -71,6 +69,9 @@ function _bumpSession(session) {
     const lifetime = now - data.startTime;
     session.idleTimeoutID = _createSessionTimeout(sdkKey, MAX_SESSION_IDLE_TIME);
     session.ageTimeoutID = _createSessionTimeout(sdkKey, MAX_SESSION_AGE - lifetime);
+    if (sessionExpired) {
+        (_a = __STATSIG__ === null || __STATSIG__ === void 0 ? void 0 : __STATSIG__.instance(sdkKey)) === null || _a === void 0 ? void 0 : _a.$emt({ name: 'session_expired' });
+    }
     return session;
 }
 function _createSessionTimeout(sdkKey, duration) {

package/src/StatsigMetadata.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "3.30.2";
+export declare const SDK_VERSION = "3.31.1";
 export type StatsigMetadata = {
     readonly [key: string]: string | undefined | null;
     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.30.2';
+exports.SDK_VERSION = '3.31.1';
 let metadata = {
     sdkVersion: exports.SDK_VERSION,
     sdkType: 'js-mono', // js-mono is overwritten by Precomp and OnDevice clients

package/src/StatsigUser.d.ts

@@ -21,4 +21,5 @@ export type StatsigUserInternal = StatsigUser & {
 };
 export declare function _normalizeUser(original: StatsigUser, options?: AnyStatsigOptions | null, fallbackEnvironment?: string | null): StatsigUserInternal;
 export declare function _getFullUserHash(user: StatsigUser | undefined): string | null;
+export declare function _getUnitIDFromUser(user: StatsigUser, idType: string): string | undefined;
 export {};

package/src/StatsigUser.js

@@ -1,26 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._getFullUserHash = exports._normalizeUser = void 0;
+exports._getUnitIDFromUser = exports._getFullUserHash = exports._normalizeUser = void 0;
 const Hashing_1 = require("./Hashing");
 const Log_1 = require("./Log");
+const SafeJs_1 = require("./SafeJs");
 function _normalizeUser(original, options, fallbackEnvironment) {
-    try {
-        const copy = JSON.parse(JSON.stringify(original));
-        if (options != null && options.environment != null) {
-            copy.statsigEnvironment = options.environment;
-        }
-        else if (fallbackEnvironment != null) {
-            copy.statsigEnvironment = { tier: fallbackEnvironment };
-        }
-        return copy;
-    }
-    catch (error) {
-        Log_1.Log.error('Failed to JSON.stringify user');
+    const copy = (0, SafeJs_1._cloneObject)('StatsigUser', original);
+    if (copy == null) {
+        Log_1.Log.error('Failed to clone user');
         return { statsigEnvironment: undefined };
     }
+    if (options != null && options.environment != null) {
+        copy.statsigEnvironment = options.environment;
+    }
+    else if (fallbackEnvironment != null) {
+        copy.statsigEnvironment = { tier: fallbackEnvironment };
+    }
+    return copy;
 }
 exports._normalizeUser = _normalizeUser;
 function _getFullUserHash(user) {
     return user ? (0, Hashing_1._DJB2Object)(user) : null;
 }
 exports._getFullUserHash = _getFullUserHash;
+function _getUnitIDFromUser(user, idType) {
+    var _a, _b, _c;
+    if (typeof idType !== 'string') {
+        return user.userID;
+    }
+    const lowered = idType.toLowerCase();
+    if (lowered !== 'userid') {
+        return (_b = (_a = user.customIDs) === null || _a === void 0 ? void 0 : _a[idType]) !== null && _b !== void 0 ? _b : (_c = user.customIDs) === null || _c === void 0 ? void 0 : _c[lowered];
+    }
+    return user.userID;
+}
+exports._getUnitIDFromUser = _getUnitIDFromUser;