@statsig/client-core 0.0.1-beta.25 → 0.0.1-beta.26

package/package.json

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

package/src/$_StatsigGlobal.d.ts

@@ -3,6 +3,8 @@ export type StatsigGlobal = {
     [key: string]: unknown;
     instances?: Record<string, StatsigClientInterface>;
     lastInstance?: StatsigClientInterface;
+    acInstances?: Record<string, unknown>;
+    srInstances?: Record<string, unknown>;
 };
 declare global {
     let __STATSIG__: StatsigGlobal | undefined;

package/src/ClientInterfaces.d.ts

@@ -21,6 +21,7 @@ export interface OnDeviceEvaluationsInterface extends StatsigClientCommonInterfa
     getExperiment(name: string, user: StatsigUser, options?: ExperimentEvaluationOptions): Experiment;
     getLayer(name: string, user: StatsigUser, options?: LayerEvaluationOptions): Layer;
     logEvent(event: StatsigEvent, user: StatsigUser): void;
+    logEvent(eventName: string, user: StatsigUser, value?: string | number, metadata?: Record<string, string>): void;
 }
 export type PrecomputedEvaluationsContext = {
     sdkKey: string;
@@ -44,5 +45,6 @@ export interface PrecomputedEvaluationsInterface extends StatsigClientCommonInte
     getExperiment(name: string, options?: ExperimentEvaluationOptions): Experiment;
     getLayer(name: string, options?: LayerEvaluationOptions): Layer;
     logEvent(event: StatsigEvent): void;
+    logEvent(eventName: string, value?: string | number, metadata?: Record<string, string>): void;
 }
 export type StatsigClientInterface = OnDeviceEvaluationsInterface | PrecomputedEvaluationsInterface;

package/src/EventLogger.d.ts

@@ -41,4 +41,5 @@ export declare class EventLogger {
     private _getStorageKey;
     private _normalizeAndAppendEvent;
     private _appendAndResetNonExposedChecks;
+    private _getCurrentPageUrl;
 }

package/src/EventLogger.js

@@ -13,7 +13,6 @@ exports.EventLogger = void 0;
 const Hashing_1 = require("./Hashing");
 const Log_1 = require("./Log");
 const StatsigEvent_1 = require("./StatsigEvent");
-const StatsigMetadata_1 = require("./StatsigMetadata");
 const StorageProvider_1 = require("./StorageProvider");
 const TypedJsonParse_1 = require("./TypedJsonParse");
 const UrlOverrides_1 = require("./UrlOverrides");
@@ -225,8 +224,12 @@ class EventLogger {
             event.user = Object.assign({}, event.user);
             delete event.user.privateAttributes;
         }
-        const { sdkType, sdkVersion } = StatsigMetadata_1.StatsigMetadataProvider.get();
-        this._queue.push(Object.assign(Object.assign({}, event), { statsigMetadata: { sdkType, sdkVersion } }));
+        const extras = {};
+        const currentPage = this._getCurrentPageUrl();
+        if (currentPage) {
+            extras.statsigMetadata = { currentPage };
+        }
+        this._queue.push(Object.assign(Object.assign({}, event), extras));
     }
     _appendAndResetNonExposedChecks() {
         if (Object.keys(this._nonExposedChecks).length === 0) {
@@ -242,5 +245,20 @@ class EventLogger {
         });
         this._nonExposedChecks = {};
     }
+    _getCurrentPageUrl() {
+        var _a;
+        if (((_a = this._options) === null || _a === void 0 ? void 0 : _a.includeCurrentPageUrlWithEvents) === false) {
+            return;
+        }
+        if (typeof window === 'undefined' || typeof window.location !== 'object') {
+            return;
+        }
+        try {
+            return window.location.href.split(/[?#]/)[0];
+        }
+        catch (_b) {
+            return;
+        }
+    }
 }
 exports.EventLogger = EventLogger;

package/src/StatsigClientBase.d.ts

@@ -25,10 +25,39 @@ export declare abstract class StatsigClientBase<TAdapter extends EvaluationsData
     protected readonly _overrideAdapter: OverrideAdapter | null;
     private _listeners;
     constructor(sdkKey: string, adapter: TAdapter, network: NetworkCore, options: StatsigOptionsCommon | null);
+    /**
+     * 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.
+     *
+     * @param {StatsigRuntimeMutableOptions} options - The configuration options that dictate the runtime behavior of the SDK.
+     */
     updateRuntimeOptions(options: StatsigRuntimeMutableOptions): void;
+    /**
+     * Flushes any currently queued events.
+     */
     flush(): Promise<void>;
+    /**
+     * Gracefully shuts down the SDK, ensuring that all pending events are send before the SDK stops.
+     * This function emits a 'pre_shutdown' event and then waits for the logger to complete its shutdown process.
+     *
+     * @returns {Promise<void>} A promise that resolves when all shutdown procedures, including logging shutdown, have been completed.
+     */
     shutdown(): Promise<void>;
+    /**
+     * Subscribes a callback function to a specific {@link StatsigClientEvent} or all StatsigClientEvents if the wildcard '*' is used.
+     * Once subscribed, the listener callback will be invoked whenever the specified event is emitted.
+     *
+     * @param {StatsigClientEventName} event - The name of the event to subscribe to, or '*' to subscribe to all events.
+     * @param {StatsigClientEventCallback<T>} listener - The callback function to execute when the event occurs. The function receives event-specific data as its parameter.
+     * @see {@link off} for unsubscribing from events.
+     */
     on<T extends StatsigClientEventName>(event: T, listener: StatsigClientEventCallback<T>): void;
+    /**
+     * Unsubscribes a previously registered callback function from a specific {@link StatsigClientEvent} or all StatsigClientEvents if the wildcard '*' is used.
+     *
+     * @param {StatsigClientEventName} event - The name of the event from which to unsubscribe, or '*' to unsubscribe from all events.
+     * @param {StatsigClientEventCallback<T>} listener - The callback function to remove from the event's notification list.
+     * @see {@link on} for subscribing to events.
+     */
     off<T extends StatsigClientEventName>(event: T, listener: StatsigClientEventCallback<T>): void;
     protected _emit(event: StatsigClientEvent): void;
     protected _setStatus(newStatus: StatsigLoadingStatus, values: DataAdapterResult | null): void;

package/src/StatsigClientBase.js

@@ -43,6 +43,11 @@ class StatsigClientBase {
         this.dataAdapter = adapter;
         this.dataAdapter.attach(sdkKey, options);
     }
+    /**
+     * 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.
+     *
+     * @param {StatsigRuntimeMutableOptions} options - The configuration options that dictate the runtime behavior of the SDK.
+     */
     updateRuntimeOptions(options) {
         if (options.disableLogging != null) {
             this._options.disableLogging = options.disableLogging;
@@ -53,21 +58,45 @@ class StatsigClientBase {
             StorageProvider_1.Storage.setDisabled(options.disableStorage);
         }
     }
+    /**
+     * Flushes any currently queued events.
+     */
     flush() {
         return this._logger.flush();
     }
+    /**
+     * Gracefully shuts down the SDK, ensuring that all pending events are send before the SDK stops.
+     * This function emits a 'pre_shutdown' event and then waits for the logger to complete its shutdown process.
+     *
+     * @returns {Promise<void>} A promise that resolves when all shutdown procedures, including logging shutdown, have been completed.
+     */
     shutdown() {
         return __awaiter(this, void 0, void 0, function* () {
             this._emit({ name: 'pre_shutdown' });
             yield this._logger.shutdown();
         });
     }
+    /**
+     * Subscribes a callback function to a specific {@link StatsigClientEvent} or all StatsigClientEvents if the wildcard '*' is used.
+     * Once subscribed, the listener callback will be invoked whenever the specified event is emitted.
+     *
+     * @param {StatsigClientEventName} event - The name of the event to subscribe to, or '*' to subscribe to all events.
+     * @param {StatsigClientEventCallback<T>} listener - The callback function to execute when the event occurs. The function receives event-specific data as its parameter.
+     * @see {@link off} for unsubscribing from events.
+     */
     on(event, listener) {
         if (!this._listeners[event]) {
             this._listeners[event] = [];
         }
         this._listeners[event].push(listener);
     }
+    /**
+     * Unsubscribes a previously registered callback function from a specific {@link StatsigClientEvent} or all StatsigClientEvents if the wildcard '*' is used.
+     *
+     * @param {StatsigClientEventName} event - The name of the event from which to unsubscribe, or '*' to unsubscribe from all events.
+     * @param {StatsigClientEventCallback<T>} listener - The callback function to remove from the event's notification list.
+     * @see {@link on} for subscribing to events.
+     */
     off(event, listener) {
         if (this._listeners[event]) {
             const index = this._listeners[event].indexOf(listener);

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

package/src/StatsigOptionsCommon.d.ts

@@ -71,6 +71,12 @@ export type StatsigOptionsCommon = StatsigRuntimeMutableOptions & {
      * returned to the caller of a check api (checkGate/getExperiment etc).
      */
     overrideAdapter?: OverrideAdapter;
+    /**
+     * (Web only) Should the 'current page' url be included with logged events.
+     *
+     * default: true
+     */
+    includeCurrentPageUrlWithEvents?: boolean;
 };
 export type StatsigEnvironment = {
     tier?: string;

package/src/StatsigTypeFactories.d.ts

@@ -0,0 +1,6 @@
+import { DynamicConfigEvaluation, EvaluationDetails, GateEvaluation, LayerEvaluation } from './EvaluationTypes';
+import { AnyConfigBasedStatsigType, DynamicConfig, FeatureGate, Layer } from './StatsigTypes';
+export declare function _makeFeatureGate(name: string, details: EvaluationDetails, evaluation: GateEvaluation | null): FeatureGate;
+export declare function _makeDynamicConfig(name: string, details: EvaluationDetails, evaluation: DynamicConfigEvaluation | null): DynamicConfig;
+export declare function _makeLayer(name: string, details: EvaluationDetails, evaluation: LayerEvaluation | null, exposeFunc?: (param: string) => void): Layer;
+export declare function _mergeOverride<T extends AnyConfigBasedStatsigType>(original: T, overridden: T | null | undefined, value: Record<string, unknown>, exposeFunc?: (param: string) => void): T;

package/src/StatsigTypeFactories.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._mergeOverride = exports._makeLayer = exports._makeDynamicConfig = exports._makeFeatureGate = void 0;
+const DEFAULT_RULE = 'default';
+function _makeFeatureGate(name, details, evaluation) {
+    var _a;
+    return {
+        name,
+        details,
+        ruleID: (_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.rule_id) !== null && _a !== void 0 ? _a : DEFAULT_RULE,
+        value: (evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) === true,
+        __evaluation: evaluation,
+    };
+}
+exports._makeFeatureGate = _makeFeatureGate;
+function _makeDynamicConfig(name, details, evaluation) {
+    var _a, _b;
+    return {
+        name,
+        details,
+        value: (_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) !== null && _a !== void 0 ? _a : {},
+        ruleID: (_b = evaluation === null || evaluation === void 0 ? void 0 : evaluation.rule_id) !== null && _b !== void 0 ? _b : DEFAULT_RULE,
+        groupName: null,
+        get: _makeTypedGet(evaluation === null || evaluation === void 0 ? void 0 : evaluation.value),
+        __evaluation: evaluation,
+    };
+}
+exports._makeDynamicConfig = _makeDynamicConfig;
+function _makeLayer(name, details, evaluation, exposeFunc) {
+    var _a, _b, _c;
+    return {
+        name,
+        details,
+        get: _makeTypedGet(evaluation === null || evaluation === void 0 ? void 0 : evaluation.value, exposeFunc),
+        ruleID: (_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.rule_id) !== null && _a !== void 0 ? _a : DEFAULT_RULE,
+        groupName: (_b = evaluation === null || evaluation === void 0 ? void 0 : evaluation.group_name) !== null && _b !== void 0 ? _b : null,
+        __value: (_c = evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) !== null && _c !== void 0 ? _c : {},
+        __evaluation: evaluation,
+    };
+}
+exports._makeLayer = _makeLayer;
+function _mergeOverride(original, overridden, value, exposeFunc) {
+    return Object.assign(Object.assign(Object.assign({}, original), overridden), { get: _makeTypedGet(value, exposeFunc) });
+}
+exports._mergeOverride = _mergeOverride;
+function _isTypeMatch(a, b) {
+    const typeOf = (x) => (Array.isArray(x) ? 'array' : typeof x);
+    return typeOf(a) === typeOf(b);
+}
+function _makeTypedGet(value, exposeFunc) {
+    return (param, fallback) => {
+        var _a;
+        const found = (_a = value === null || value === void 0 ? void 0 : value[param]) !== null && _a !== void 0 ? _a : null;
+        if (found == null) {
+            return (fallback !== null && fallback !== void 0 ? fallback : null);
+        }
+        if (fallback != null && !_isTypeMatch(found, fallback)) {
+            return (fallback !== null && fallback !== void 0 ? fallback : null);
+        }
+        exposeFunc === null || exposeFunc === void 0 ? void 0 : exposeFunc(param);
+        return found;
+    };
+}

package/src/StatsigTypes.d.ts

@@ -1,30 +1,33 @@
-import { DynamicConfigEvaluation, EvaluationDetails, ExperimentEvaluation, GateEvaluation, LayerEvaluation } from './EvaluationTypes';
+import { EvaluationDetails, ExperimentEvaluation, GateEvaluation, LayerEvaluation } from './EvaluationTypes';
 import { Flatten } from './UtitlityTypes';
-type CommonFields = {
+export type TypedGet = <T = unknown>(key: string, fallback?: T) => TypedReturn<T>;
+export type TypedReturn<T = unknown> = T extends string ? string : T extends number ? number : T extends boolean ? boolean : T extends Array<unknown> ? Array<unknown> : T extends object ? object : unknown;
+export type SpecType = 'gate' | 'dynamic_config' | 'experiment' | 'layer';
+export type FeatureGate = Flatten<{
     readonly name: string;
     readonly ruleID: string;
     readonly details: EvaluationDetails;
-};
-export type SpecType = 'gate' | 'dynamic_config' | 'experiment' | 'layer';
-export type FeatureGate = Flatten<CommonFields & {
     readonly value: boolean;
     readonly __evaluation: GateEvaluation | null;
 }>;
-export type DynamicConfig = Flatten<CommonFields & {
-    readonly value: Record<string, unknown>;
-    readonly __evaluation: DynamicConfigEvaluation | null;
-}>;
-export type Experiment = Flatten<CommonFields & {
+export type Experiment = Flatten<{
+    readonly name: string;
+    readonly ruleID: string;
+    readonly details: EvaluationDetails;
     readonly value: Record<string, unknown>;
+    readonly groupName: string | null;
     readonly __evaluation: ExperimentEvaluation | null;
+    readonly get: TypedGet;
 }>;
-export type Layer = Flatten<CommonFields & {
-    readonly getValue: (parameterName: string) => unknown;
-    readonly _value: Record<string, unknown>;
+export type DynamicConfig = Flatten<Experiment>;
+export type Layer = Flatten<{
+    readonly name: string;
+    readonly ruleID: string;
+    readonly details: EvaluationDetails;
+    readonly groupName: string | null;
+    readonly __value: Record<string, unknown>;
     readonly __evaluation: LayerEvaluation | null;
+    readonly get: TypedGet;
 }>;
-export type AnyConfig = FeatureGate | DynamicConfig | Experiment | Layer;
-export declare function makeFeatureGate(name: string, details: EvaluationDetails, evaluation: GateEvaluation | null): FeatureGate;
-export declare function makeDynamicConfig(name: string, details: EvaluationDetails, evaluation: DynamicConfigEvaluation | null): DynamicConfig;
-export declare function makeLayer(name: string, details: EvaluationDetails, evaluation: LayerEvaluation | null, getValue?: (param: string) => unknown): Layer;
-export {};
+export type AnyConfigBasedStatsigType = DynamicConfig | Experiment | Layer;
+export type AnyStatsigType = FeatureGate | AnyConfigBasedStatsigType;

package/src/StatsigTypes.js

@@ -1,38 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeLayer = exports.makeDynamicConfig = exports.makeFeatureGate = void 0;
-const DEFAULT_RULE = 'default';
-function makeFeatureGate(name, details, evaluation) {
-    var _a;
-    return {
-        name,
-        details,
-        ruleID: (_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.rule_id) !== null && _a !== void 0 ? _a : DEFAULT_RULE,
-        value: (evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) === true,
-        __evaluation: evaluation,
-    };
-}
-exports.makeFeatureGate = makeFeatureGate;
-function makeDynamicConfig(name, details, evaluation) {
-    var _a, _b;
-    return {
-        name,
-        details,
-        ruleID: (_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.rule_id) !== null && _a !== void 0 ? _a : DEFAULT_RULE,
-        value: (_b = evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) !== null && _b !== void 0 ? _b : {},
-        __evaluation: evaluation,
-    };
-}
-exports.makeDynamicConfig = makeDynamicConfig;
-function makeLayer(name, details, evaluation, getValue) {
-    var _a, _b;
-    return {
-        name,
-        details,
-        getValue: getValue !== null && getValue !== void 0 ? getValue : (() => undefined),
-        ruleID: (_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.rule_id) !== null && _a !== void 0 ? _a : DEFAULT_RULE,
-        _value: (_b = evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) !== null && _b !== void 0 ? _b : {},
-        __evaluation: evaluation,
-    };
-}
-exports.makeLayer = makeLayer;

package/src/index.d.ts

@@ -23,6 +23,7 @@ export * from './StatsigDataAdapter';
 export * from './StatsigEvent';
 export * from './StatsigMetadata';
 export * from './StatsigOptionsCommon';
+export * from './StatsigTypeFactories';
 export * from './StatsigTypes';
 export * from './StatsigUser';
 export * from './StorageProvider';

package/src/index.js

@@ -44,6 +44,7 @@ __exportStar(require("./StatsigDataAdapter"), exports);
 __exportStar(require("./StatsigEvent"), exports);
 __exportStar(require("./StatsigMetadata"), exports);
 __exportStar(require("./StatsigOptionsCommon"), exports);
+__exportStar(require("./StatsigTypeFactories"), exports);
 __exportStar(require("./StatsigTypes"), exports);
 __exportStar(require("./StatsigUser"), exports);
 __exportStar(require("./StorageProvider"), exports);

package/src/__tests__/MockLocalStorage.d.ts

@@ -1,9 +0,0 @@
-export declare class MockLocalStorage {
-    data: Record<string, string>;
-    static enabledMockStorage(): MockLocalStorage;
-    static disableMockStorage(): void;
-    clear(): void;
-    getItem(key: string): Promise<string | null>;
-    setItem(key: string, value: string): void;
-    removeItem(key: string): void;
-}

package/src/__tests__/MockLocalStorage.js

@@ -1,47 +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.MockLocalStorage = void 0;
-const actualLocalStorage = window.localStorage;
-// todo: move to test-helpers (break circular dep)
-class MockLocalStorage {
-    constructor() {
-        this.data = {};
-    }
-    static enabledMockStorage() {
-        const value = new MockLocalStorage();
-        Object.defineProperty(window, 'localStorage', {
-            value,
-        });
-        return value;
-    }
-    static disableMockStorage() {
-        Object.defineProperty(window, 'localStorage', {
-            value: actualLocalStorage,
-        });
-    }
-    // LocalStorage Functions
-    clear() {
-        this.data = {};
-    }
-    getItem(key) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return Promise.resolve(this.data[key] ? this.data[key] : null);
-        });
-    }
-    setItem(key, value) {
-        this.data[key] = String(value);
-    }
-    removeItem(key) {
-        delete this.data[key];
-    }
-}
-exports.MockLocalStorage = MockLocalStorage;