wolves-js-client 1.0.6 → 1.0.7

package/dist/EventLogger.d.ts

@@ -5,10 +5,29 @@ export declare class EventLogger {
     private flushIntervalId;
     private network;
     private maxQueueSize;
-    constructor(network: Network);
+    private sdkKey;
+    constructor(sdkKey: string, network: Network);
+    /**
+     * Safely flush events for a specific sdkKey without throwing.
+     * This is used internally and can be called even after client destruction.
+     */
+    private static safeFlushAndForget;
     enqueue(event: WolvesEvent): void;
     flush(): Promise<void>;
+    /**
+     * Start the event logger and register it in the global map.
+     * This should be called when the client is initialized.
+     * If an existing logger with the same sdkKey exists, it will be flushed first.
+     */
     start(): void;
+    /**
+     * Reset the event queue. Any pending events will be lost.
+     * Called when switching users to clear any user-specific events.
+     */
     reset(): void;
+    /**
+     * Stop the event logger, flush all pending events, and remove from global map.
+     * This ensures all events are sent before the client is destroyed.
+     */
     stop(): Promise<void>;
 }

package/dist/EventLogger.js

@@ -13,20 +13,34 @@ exports.EventLogger = void 0;
 const Log_1 = require("./Log");
 const DEFAULT_QUEUE_SIZE = 100;
 const DEFAULT_FLUSH_INTERVAL_MS = 10000;
+/**
+ * Global map of EventLoggers by sdkKey.
+ * This ensures events can still be sent even after a client is destroyed,
+ * as long as there are pending events in the queue.
+ */
+const EVENT_LOGGER_MAP = {};
 class EventLogger {
-    constructor(network) {
+    constructor(sdkKey, network) {
         this.queue = [];
         this.flushIntervalId = null;
         this.maxQueueSize = DEFAULT_QUEUE_SIZE;
+        this.sdkKey = sdkKey;
         this.network = network;
-        this.start();
+    }
+    /**
+     * Safely flush events for a specific sdkKey without throwing.
+     * This is used internally and can be called even after client destruction.
+     */
+    static safeFlushAndForget(sdkKey) {
+        var _a;
+        (_a = EVENT_LOGGER_MAP[sdkKey]) === null || _a === void 0 ? void 0 : _a.flush().catch(() => {
+            // noop - errors already logged in flush
+        });
     }
     enqueue(event) {
         this.queue.push(event);
         if (this.queue.length >= this.maxQueueSize) {
-            this.flush().catch((e) => {
-                Log_1.Log.error('Failed to flush events', e);
-            });
+            EventLogger.safeFlushAndForget(this.sdkKey);
         }
     }
     flush() {
@@ -50,24 +64,59 @@ class EventLogger {
             }
         });
     }
+    /**
+     * Start the event logger and register it in the global map.
+     * This should be called when the client is initialized.
+     * If an existing logger with the same sdkKey exists, it will be flushed first.
+     */
     start() {
         if (this.flushIntervalId) {
             return;
         }
+        // If there's an existing logger with the same sdkKey, flush it first
+        const existingLogger = EVENT_LOGGER_MAP[this.sdkKey];
+        if (existingLogger && existingLogger !== this) {
+            // Stop the old logger's interval to prevent it from continuing to flush
+            if (existingLogger.flushIntervalId) {
+                clearInterval(existingLogger.flushIntervalId);
+                existingLogger.flushIntervalId = null;
+            }
+            // Flush remaining events from the old logger
+            existingLogger.flush().catch(() => {
+                // noop - errors already logged in flush
+            });
+        }
+        // Register this logger in the global map (replaces any existing)
+        EVENT_LOGGER_MAP[this.sdkKey] = this;
         this.flushIntervalId = setInterval(() => {
-            this.flush();
+            EventLogger.safeFlushAndForget(this.sdkKey);
         }, DEFAULT_FLUSH_INTERVAL_MS);
     }
+    /**
+     * Reset the event queue. Any pending events will be lost.
+     * Called when switching users to clear any user-specific events.
+     */
     reset() {
+        // Attempt to flush any remaining events before resetting
+        this.flush().catch(() => {
+            // noop - we're resetting anyway
+        });
         this.queue = [];
     }
+    /**
+     * Stop the event logger, flush all pending events, and remove from global map.
+     * This ensures all events are sent before the client is destroyed.
+     */
     stop() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.flushIntervalId) {
                 clearInterval(this.flushIntervalId);
                 this.flushIntervalId = null;
             }
+            // Flush all pending events before stopping
             yield this.flush();
+            // Remove from global map after ensuring all events are sent
+            delete EVENT_LOGGER_MAP[this.sdkKey];
         });
     }
 }

package/dist/Store.d.ts

@@ -3,6 +3,9 @@ export type ExperimentConfig = {
     value: Record<string, any>;
     experiment_id?: string;
     group?: string;
+    group_name?: string;
+    is_user_in_experiment?: boolean;
+    is_experiment_active?: boolean;
 };
 export type InitializeResponse = {
     dynamic_configs: Record<string, ExperimentConfig>;

package/dist/Types.d.ts

@@ -17,5 +17,7 @@ export type Experiment = {
     value: Record<string, unknown>;
     experimentID: string;
     groupName: string | null;
+    isExperimentActive: boolean;
+    isUserInExperiment: boolean;
     get: <T>(key: string, defaultValue: T) => T;
 };

package/dist/WolvesClient.d.ts

@@ -105,6 +105,14 @@ export declare class WolvesClient {
      */
     getExperimentForTest(experimentName: string, groupName: string): Experiment;
     logEvent(eventName: string, value?: string | number, metadata?: Record<string, string>): void;
+    /**
+     * Manually flush all pending events to the server.
+     * This is useful when you want to ensure events are sent immediately,
+     * such as before navigating away from a page.
+     *
+     * @returns Promise that resolves when all events have been sent
+     */
+    flush(): Promise<void>;
     shutdown(): Promise<void>;
     private logExposure;
 }

package/dist/WolvesClient.js

@@ -29,7 +29,7 @@ class WolvesClient {
         this.user = user;
         this.network = new Network_1.Network(sdkKey, apiEnv);
         this.store = new Store_1.Store(sdkKey);
-        this.logger = new EventLogger_1.EventLogger(this.network);
+        this.logger = new EventLogger_1.EventLogger(sdkKey, this.network);
     }
     /**
      * Returns the current loading status of the client.
@@ -267,13 +267,23 @@ class WolvesClient {
         this.user = user;
     }
     getExperiment(experimentName) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e;
         const { config, details } = this.store.getExperiment(experimentName);
+        // Check if experiment is in prestart state (setup status on server)
+        const isExperimentActive = (_a = config === null || config === void 0 ? void 0 : config.is_experiment_active) !== null && _a !== void 0 ? _a : true;
+        const isUserInExperiment = (_b = config === null || config === void 0 ? void 0 : config.is_user_in_experiment) !== null && _b !== void 0 ? _b : true;
+        const isPrestart = !isExperimentActive && (config === null || config === void 0 ? void 0 : config.group) === 'prestart';
+        // For prestart experiments, log the prestart state
+        if (isPrestart) {
+            Log_1.Log.info(`Experiment "${experimentName}" is in prestart state`);
+        }
         const experiment = {
             name: experimentName,
-            value: (_a = config === null || config === void 0 ? void 0 : config.value) !== null && _a !== void 0 ? _a : {},
-            experimentID: (_b = config === null || config === void 0 ? void 0 : config.experiment_id) !== null && _b !== void 0 ? _b : '',
-            groupName: (_c = config === null || config === void 0 ? void 0 : config.group) !== null && _c !== void 0 ? _c : null,
+            value: (_c = config === null || config === void 0 ? void 0 : config.value) !== null && _c !== void 0 ? _c : {},
+            experimentID: (_d = config === null || config === void 0 ? void 0 : config.experiment_id) !== null && _d !== void 0 ? _d : '',
+            groupName: (_e = config === null || config === void 0 ? void 0 : config.group) !== null && _e !== void 0 ? _e : null,
+            isExperimentActive,
+            isUserInExperiment,
             get: (key, defaultValue) => {
                 var _a;
                 const val = (_a = config === null || config === void 0 ? void 0 : config.value) === null || _a === void 0 ? void 0 : _a[key];
@@ -293,20 +303,28 @@ class WolvesClient {
      * The experiment ID is retrieved from the store config.
      */
     getExperimentForTest(experimentName, groupName) {
-        var _a;
+        var _a, _b, _c;
         const { config, details } = this.store.getExperiment(experimentName);
         const experimentId = (_a = config === null || config === void 0 ? void 0 : config.experiment_id) !== null && _a !== void 0 ? _a : '';
+        const isExperimentActive = (_b = config === null || config === void 0 ? void 0 : config.is_experiment_active) !== null && _b !== void 0 ? _b : true;
+        const isUserInExperiment = (_c = config === null || config === void 0 ? void 0 : config.is_user_in_experiment) !== null && _c !== void 0 ? _c : true;
         const experiment = {
             name: experimentName,
             value: {},
             experimentID: experimentId,
             groupName: groupName,
+            isExperimentActive,
+            isUserInExperiment,
             get: (_key, defaultValue) => {
                 return defaultValue;
             }
         };
         // Log exposure with the specified group and experiment ID from store
-        this.logExposure(experimentName, { group: groupName, experiment_id: experimentId, value: {} }, details);
+        this.logExposure(experimentName, {
+            group: groupName,
+            experiment_id: experimentId,
+            value: {}
+        }, details);
         return experiment;
     }
     logEvent(eventName, value, metadata) {
@@ -319,6 +337,18 @@ class WolvesClient {
         };
         this.logger.enqueue(event);
     }
+    /**
+     * Manually flush all pending events to the server.
+     * This is useful when you want to ensure events are sent immediately,
+     * such as before navigating away from a page.
+     *
+     * @returns Promise that resolves when all events have been sent
+     */
+    flush() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.logger.flush();
+        });
+    }
     shutdown() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.logger.stop();

package/dist/WolvesMetadata.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "1.0.6";
+export declare const SDK_VERSION = "1.0.7";
 export declare const SDK_TYPE = "wolves-js-client";
 export type WolvesMetadata = {
     readonly [key: string]: string | undefined | null;

package/dist/WolvesMetadata.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WolvesMetadataProvider = exports.SDK_TYPE = exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = '1.0.6';
+exports.SDK_VERSION = '1.0.7';
 exports.SDK_TYPE = 'wolves-js-client';
 let metadata = {
     sdk_version: exports.SDK_VERSION,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wolves-js-client",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "A Wolves JavaScript Client SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/DeviceInfo.d.ts

@@ -1,22 +0,0 @@
-/**
- * DeviceInfo - Collects device and environment information for event metadata
- * Aligns with Statsig SDK's approach: sends raw user_agent for server-side parsing
- *
- * Note: Browser/OS parsing is done server-side from user_agent, not client-side
- */
-export type DeviceInfoData = {
-    user_agent: string;
-    locale: string;
-    screen_width: number | null;
-    screen_height: number | null;
-    viewport_width: number | null;
-    viewport_height: number | null;
-    timezone: string;
-    timezone_offset: number | null;
-};
-export declare function getDeviceInfo(): DeviceInfoData;
-/**
- * Get device info as a flat record suitable for event metadata
- * Only includes non-null values
- */
-export declare function getDeviceInfoForMetadata(): Record<string, string | number>;

package/dist/DeviceInfo.js

@@ -1,98 +0,0 @@
-"use strict";
-/**
- * DeviceInfo - Collects device and environment information for event metadata
- * Aligns with Statsig SDK's approach: sends raw user_agent for server-side parsing
- *
- * Note: Browser/OS parsing is done server-side from user_agent, not client-side
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDeviceInfo = getDeviceInfo;
-exports.getDeviceInfoForMetadata = getDeviceInfoForMetadata;
-function getWindowSafe() {
-    if (typeof window !== 'undefined') {
-        return window;
-    }
-    return null;
-}
-function getNavigatorSafe() {
-    var _a;
-    const win = getWindowSafe();
-    return (_a = win === null || win === void 0 ? void 0 : win.navigator) !== null && _a !== void 0 ? _a : null;
-}
-function getSafeTimezone() {
-    try {
-        return Intl.DateTimeFormat().resolvedOptions().timeZone || '';
-    }
-    catch (_a) {
-        return '';
-    }
-}
-function getSafeTimezoneOffset() {
-    try {
-        return new Date().getTimezoneOffset();
-    }
-    catch (_a) {
-        return null;
-    }
-}
-let cachedDeviceInfo = null;
-function getDeviceInfo() {
-    var _a, _b, _c, _d, _e, _f;
-    // Return cached info if available
-    if (cachedDeviceInfo) {
-        return cachedDeviceInfo;
-    }
-    const win = getWindowSafe();
-    const nav = getNavigatorSafe();
-    if (!win || !nav) {
-        // Return empty values for server-side or non-browser environments
-        return {
-            user_agent: '',
-            locale: '',
-            screen_width: null,
-            screen_height: null,
-            viewport_width: null,
-            viewport_height: null,
-            timezone: '',
-            timezone_offset: null,
-        };
-    }
-    const userAgent = nav.userAgent || '';
-    cachedDeviceInfo = {
-        // Send raw user_agent - server will parse browser/os info
-        user_agent: userAgent.length > 500 ? userAgent.substring(0, 500) : userAgent,
-        locale: nav.language || '',
-        screen_width: (_b = (_a = win.screen) === null || _a === void 0 ? void 0 : _a.width) !== null && _b !== void 0 ? _b : null,
-        screen_height: (_d = (_c = win.screen) === null || _c === void 0 ? void 0 : _c.height) !== null && _d !== void 0 ? _d : null,
-        viewport_width: (_e = win.innerWidth) !== null && _e !== void 0 ? _e : null,
-        viewport_height: (_f = win.innerHeight) !== null && _f !== void 0 ? _f : null,
-        timezone: getSafeTimezone(),
-        timezone_offset: getSafeTimezoneOffset(),
-    };
-    return cachedDeviceInfo;
-}
-/**
- * Get device info as a flat record suitable for event metadata
- * Only includes non-null values
- */
-function getDeviceInfoForMetadata() {
-    const info = getDeviceInfo();
-    const result = {};
-    if (info.user_agent)
-        result['user_agent'] = info.user_agent;
-    if (info.locale)
-        result['locale'] = info.locale;
-    if (info.screen_width !== null)
-        result['screen_width'] = info.screen_width;
-    if (info.screen_height !== null)
-        result['screen_height'] = info.screen_height;
-    if (info.viewport_width !== null)
-        result['viewport_width'] = info.viewport_width;
-    if (info.viewport_height !== null)
-        result['viewport_height'] = info.viewport_height;
-    if (info.timezone)
-        result['timezone'] = info.timezone;
-    if (info.timezone_offset !== null)
-        result['timezone_offset'] = info.timezone_offset;
-    return result;
-}

package/dist/StatsigClient.d.ts

@@ -1,15 +0,0 @@
-import { StatsigUser } from './StatsigUser';
-import { Experiment, StatsigUpdateDetails } from './Types';
-export declare class StatsigClient {
-    private sdkKey;
-    private user;
-    private network;
-    private store;
-    private initialized;
-    constructor(sdkKey: string, user: StatsigUser);
-    initializeAsync(): Promise<StatsigUpdateDetails>;
-    initializeSync(): StatsigUpdateDetails;
-    getExperiment(experimentName: string): Experiment;
-    logEvent(eventName: string, value?: string | number, metadata?: Record<string, string>): void;
-    private logExposure;
-}

package/dist/StatsigClient.js

@@ -1,92 +0,0 @@
-"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.StatsigClient = void 0;
-const Network_1 = require("./Network");
-const Store_1 = require("./Store");
-class StatsigClient {
-    constructor(sdkKey, user) {
-        this.initialized = false;
-        this.sdkKey = sdkKey;
-        this.user = user;
-        this.network = new Network_1.Network(sdkKey);
-        this.store = new Store_1.Store();
-    }
-    initializeAsync() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const config = yield this.network.fetchConfig(this.user);
-            if (config) {
-                this.store.setValues(config);
-                this.initialized = true;
-                return { success: true };
-            }
-            return { success: false, errorMessage: 'Failed to fetch config' };
-        });
-    }
-    initializeSync() {
-        // In a real implementation, this might load from local storage or cache.
-        // For this minimal implementation, we trigger a background fetch.
-        this.network.fetchConfig(this.user).then((config) => {
-            if (config) {
-                this.store.setValues(config);
-            }
-        });
-        this.initialized = true;
-        return { success: true };
-    }
-    getExperiment(experimentName) {
-        var _a, _b, _c;
-        const config = this.store.getExperiment(experimentName);
-        const experiment = {
-            name: experimentName,
-            value: (_a = config === null || config === void 0 ? void 0 : config.value) !== null && _a !== void 0 ? _a : {},
-            ruleID: (_b = config === null || config === void 0 ? void 0 : config.rule_id) !== null && _b !== void 0 ? _b : '',
-            groupName: (_c = config === null || config === void 0 ? void 0 : config.group) !== null && _c !== void 0 ? _c : null,
-            get: (key, defaultValue) => {
-                var _a;
-                const val = (_a = config === null || config === void 0 ? void 0 : config.value) === null || _a === void 0 ? void 0 : _a[key];
-                if (val === undefined || val === null) {
-                    return defaultValue;
-                }
-                return val;
-            }
-        };
-        // Log exposure
-        this.logExposure(experimentName, config);
-        return experiment;
-    }
-    logEvent(eventName, value, metadata) {
-        const event = {
-            eventName,
-            value,
-            metadata,
-            user: this.user,
-            time: Date.now(),
-        };
-        this.network.sendEvents([event]);
-    }
-    logExposure(experimentName, experiment) {
-        var _a, _b, _c;
-        const exposureEvent = {
-            eventName: 'statsig::exposure',
-            user: this.user,
-            time: Date.now(),
-            metadata: {
-                config: experimentName,
-                ruleID: (_a = experiment === null || experiment === void 0 ? void 0 : experiment.rule_id) !== null && _a !== void 0 ? _a : '',
-                group: (_b = experiment === null || experiment === void 0 ? void 0 : experiment.group) !== null && _b !== void 0 ? _b : '',
-                value: JSON.stringify((_c = experiment === null || experiment === void 0 ? void 0 : experiment.value) !== null && _c !== void 0 ? _c : {}),
-            },
-        };
-        this.network.sendEvents([exposureEvent]);
-    }
-}
-exports.StatsigClient = StatsigClient;

package/dist/StatsigUser.d.ts

@@ -1,6 +0,0 @@
-export type StatsigUser = {
-    userID?: string;
-    email?: string;
-    ip?: string;
-    custom?: Record<string, string | number | boolean | Array<string>>;
-};

package/dist/StatsigUser.js

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