@statsig/js-client 3.8.2 → 3.9.0

package/src/StatsigClient.d.ts

@@ -1,4 +1,4 @@
-import { DataAdapterAsyncOptions, DataAdapterSyncOptions, DynamicConfig, DynamicConfigEvaluationOptions, EvaluationsDataAdapter, Experiment, ExperimentEvaluationOptions, FeatureGate, FeatureGateEvaluationOptions, Layer, LayerEvaluationOptions, ParameterStore, ParameterStoreEvaluationOptions, PrecomputedEvaluationsContext, PrecomputedEvaluationsInterface, StatsigClientBase, StatsigEvent, StatsigUser } from '@statsig/client-core';
+import { DataAdapterAsyncOptions, DataAdapterSyncOptions, EvaluationsDataAdapter, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, PrecomputedEvaluationsContext, PrecomputedEvaluationsInterface, StatsigClientBase, StatsigEvent, StatsigUser } from '@statsig/client-core';
 import type { StatsigOptions } from './StatsigOptions';
 type AsyncUpdateOptions = DataAdapterAsyncOptions;
 type SyncUpdateOptions = DataAdapterSyncOptions;
@@ -83,7 +83,13 @@ export default class StatsigClient extends StatsigClientBase<EvaluationsDataAdap
      * @param {FeatureGateEvaluationOptions} [options] - Optional. Additional options to customize the method call.
      * @returns {FeatureGate} - The {@link FeatureGate} object representing the gate's current evaluation results for the user.
      */
-    getFeatureGate(name: string, options?: FeatureGateEvaluationOptions): FeatureGate;
+    readonly getFeatureGate: (name: string, options?: import("@statsig/client-core").EvaluationOptionsCommon | undefined) => {
+        readonly name: string;
+        readonly ruleID: string;
+        readonly details: import("@statsig/client-core").EvaluationDetails;
+        readonly value: boolean;
+        readonly __evaluation: import("@statsig/client-core").GateEvaluation | null;
+    };
     /**
      * Retrieves the value of a dynamic config for the current user.
      *
@@ -91,7 +97,27 @@ export default class StatsigClient extends StatsigClientBase<EvaluationsDataAdap
      * @param {DynamicConfigEvaluationOptions} [options] - Optional. Additional options to customize the method call.
      * @returns {DynamicConfig} - The {@link DynamicConfig} object representing the dynamic configs's current evaluation results for the user.
      */
-    getDynamicConfig(name: string, options?: DynamicConfigEvaluationOptions): DynamicConfig;
+    readonly getDynamicConfig: (name: string, options?: import("@statsig/client-core").EvaluationOptionsCommon | undefined) => {
+        readonly name: string;
+        readonly value: Record<string, unknown>;
+        readonly ruleID: string;
+        readonly details: import("@statsig/client-core").EvaluationDetails;
+        readonly __evaluation: {
+            id_type: string;
+            name: string;
+            rule_id: string;
+            secondary_exposures: import("@statsig/client-core").SecondaryExposure[];
+            value: Record<string, unknown>;
+            version?: string | undefined;
+            group_name?: string | undefined;
+            group: string;
+            is_device_based: boolean;
+            is_experiment_active?: boolean | undefined;
+            is_user_in_experiment?: boolean | undefined;
+            passed?: boolean | undefined;
+        } | null;
+        readonly get: import("@statsig/client-core").TypedGet;
+    };
     /**
      * Retrieves the value of a experiment for the current user.
      *
@@ -99,7 +125,28 @@ export default class StatsigClient extends StatsigClientBase<EvaluationsDataAdap
      * @param {ExperimentEvaluationOptions} [options] - Optional. Additional options to customize the method call.
      * @returns {Experiment} - The {@link Experiment} object representing the experiments's current evaluation results for the user.
      */
-    getExperiment(name: string, options?: ExperimentEvaluationOptions): Experiment;
+    readonly getExperiment: (name: string, options?: ExperimentEvaluationOptions | undefined) => {
+        readonly name: string;
+        readonly ruleID: string;
+        readonly details: import("@statsig/client-core").EvaluationDetails;
+        readonly value: Record<string, unknown>;
+        readonly groupName: string | null;
+        readonly __evaluation: {
+            id_type: string;
+            name: string;
+            rule_id: string;
+            secondary_exposures: import("@statsig/client-core").SecondaryExposure[];
+            value: Record<string, unknown>;
+            version?: string | undefined;
+            group_name?: string | undefined;
+            group: string;
+            is_device_based: boolean;
+            is_experiment_active?: boolean | undefined;
+            is_user_in_experiment?: boolean | undefined;
+            passed?: boolean | undefined;
+        } | null;
+        readonly get: import("@statsig/client-core").TypedGet;
+    };
     /**
      * Retrieves the value of a layer for the current user.
      *
@@ -107,8 +154,43 @@ export default class StatsigClient extends StatsigClientBase<EvaluationsDataAdap
      * @param {LayerEvaluationOptions} [options] - Optional. Additional options to customize the method call.
      * @returns {Layer} - The {@link Layer} object representing the layers's current evaluation results for the user.
      */
-    getLayer(name: string, options?: LayerEvaluationOptions): Layer;
-    getParameterStore(name: string, options?: ParameterStoreEvaluationOptions): ParameterStore;
+    readonly getLayer: (name: string, options?: import("@statsig/client-core").EvaluationOptionsCommon | undefined) => {
+        readonly name: string;
+        readonly ruleID: string;
+        readonly details: import("@statsig/client-core").EvaluationDetails;
+        readonly groupName: string | null;
+        readonly __value: Record<string, unknown>;
+        readonly __evaluation: {
+            name: string;
+            rule_id: string;
+            secondary_exposures: import("@statsig/client-core").SecondaryExposure[];
+            value: Record<string, unknown>;
+            version?: string | undefined;
+            group_name?: string | undefined;
+            group: string;
+            is_device_based: boolean;
+            is_experiment_active?: boolean | undefined;
+            is_user_in_experiment?: boolean | undefined;
+            passed?: boolean | undefined;
+            allocated_experiment_name: string;
+            explicit_parameters: string[];
+            undelegated_secondary_exposures?: import("@statsig/client-core").SecondaryExposure[] | undefined;
+        } | null;
+        readonly get: import("@statsig/client-core").TypedGet;
+    };
+    /**
+     * Retrieves the value of a parameter store for the current user.
+     *
+     * @param {string} name The name of the parameter store to get.
+     * @param {ParameterStoreEvaluationOptions} [options] - Optional. Additional options to customize the method call.
+     * @returns {ParameterStore} - The {@link ParameterStore} object representing the parameter store's current mappings for the user.
+     */
+    readonly getParameterStore: (name: string, options?: import("@statsig/client-core").EvaluationOptionsCommon | undefined) => {
+        readonly name: string;
+        readonly details: import("@statsig/client-core").EvaluationDetails;
+        readonly get: import("@statsig/client-core").TypedGet;
+        readonly __configuration: import("@statsig/client-core").ParamStoreConfig | null;
+    };
     /**
      * Logs an event to the internal logging system. This function allows logging by either passing a fully formed event object or by specifying the event name with optional value and metadata.
      *
@@ -122,5 +204,10 @@ export default class StatsigClient extends StatsigClientBase<EvaluationsDataAdap
     private _finalizeUpdate;
     private _runPostUpdate;
     private _resetForUser;
+    private _getFeatureGateImpl;
+    private _getDynamicConfigImpl;
+    private _getExperimentImpl;
+    private _getLayerImpl;
+    private _getParameterStoreImpl;
 }
 export {};

package/src/StatsigClient.js

@@ -47,6 +47,46 @@ class StatsigClient extends client_core_1.StatsigClientBase {
             this.$emt(e);
         });
         super(sdkKey, (_a = options === null || options === void 0 ? void 0 : options.dataAdapter) !== null && _a !== void 0 ? _a : new StatsigEvaluationsDataAdapter_1.StatsigEvaluationsDataAdapter(), network, options);
+        /**
+         * Retrieves the value of a feature gate for the current user, represented as a {@link FeatureGate} object.
+         *
+         * @param {string} name - The name of the feature gate to retrieve.
+         * @param {FeatureGateEvaluationOptions} [options] - Optional. Additional options to customize the method call.
+         * @returns {FeatureGate} - The {@link FeatureGate} object representing the gate's current evaluation results for the user.
+         */
+        this.getFeatureGate = this._memoize(this._getFeatureGateImpl.bind(this));
+        /**
+         * Retrieves the value of a dynamic config for the current user.
+         *
+         * @param {string} name The name of the dynamic config to get.
+         * @param {DynamicConfigEvaluationOptions} [options] - Optional. Additional options to customize the method call.
+         * @returns {DynamicConfig} - The {@link DynamicConfig} object representing the dynamic configs's current evaluation results for the user.
+         */
+        this.getDynamicConfig = this._memoize(this._getDynamicConfigImpl.bind(this));
+        /**
+         * Retrieves the value of a experiment for the current user.
+         *
+         * @param {string} name The name of the experiment to get.
+         * @param {ExperimentEvaluationOptions} [options] - Optional. Additional options to customize the method call.
+         * @returns {Experiment} - The {@link Experiment} object representing the experiments's current evaluation results for the user.
+         */
+        this.getExperiment = this._memoize(this._getExperimentImpl.bind(this));
+        /**
+         * Retrieves the value of a layer for the current user.
+         *
+         * @param {string} name The name of the layer to get.
+         * @param {LayerEvaluationOptions} [options] - Optional. Additional options to customize the method call.
+         * @returns {Layer} - The {@link Layer} object representing the layers's current evaluation results for the user.
+         */
+        this.getLayer = this._memoize(this._getLayerImpl.bind(this));
+        /**
+         * Retrieves the value of a parameter store for the current user.
+         *
+         * @param {string} name The name of the parameter store to get.
+         * @param {ParameterStoreEvaluationOptions} [options] - Optional. Additional options to customize the method call.
+         * @returns {ParameterStore} - The {@link ParameterStore} object representing the parameter store's current mappings for the user.
+         */
+        this.getParameterStore = this._memoize(this._getParameterStoreImpl.bind(this));
         this._store = new EvaluationStore_1.default(sdkKey);
         this._user = (0, client_core_1._normalizeUser)(user, options);
         const plugins = (_b = options === null || options === void 0 ? void 0 : options.plugins) !== null && _b !== void 0 ? _b : [];
@@ -173,85 +213,6 @@ class StatsigClient extends client_core_1.StatsigClientBase {
     checkGate(name, options) {
         return this.getFeatureGate(name, options).value;
     }
-    /**
-     * Retrieves the value of a feature gate for the current user, represented as a {@link FeatureGate} object.
-     *
-     * @param {string} name - The name of the feature gate to retrieve.
-     * @param {FeatureGateEvaluationOptions} [options] - Optional. Additional options to customize the method call.
-     * @returns {FeatureGate} - The {@link FeatureGate} object representing the gate's current evaluation results for the user.
-     */
-    getFeatureGate(name, options) {
-        var _a, _b;
-        const { result: evaluation, details } = this._store.getGate(name);
-        const gate = (0, client_core_1._makeFeatureGate)(name, details, evaluation);
-        const overridden = (_b = (_a = this.overrideAdapter) === null || _a === void 0 ? void 0 : _a.getGateOverride) === null || _b === void 0 ? void 0 : _b.call(_a, gate, this._user, options);
-        const result = overridden !== null && overridden !== void 0 ? overridden : gate;
-        this._enqueueExposure(name, (0, client_core_1._createGateExposure)(this._user, result), options);
-        this.$emt({ name: 'gate_evaluation', gate: result });
-        return result;
-    }
-    /**
-     * Retrieves the value of a dynamic config for the current user.
-     *
-     * @param {string} name The name of the dynamic config to get.
-     * @param {DynamicConfigEvaluationOptions} [options] - Optional. Additional options to customize the method call.
-     * @returns {DynamicConfig} - The {@link DynamicConfig} object representing the dynamic configs's current evaluation results for the user.
-     */
-    getDynamicConfig(name, options) {
-        var _a, _b;
-        const { result: evaluation, details } = this._store.getConfig(name);
-        const config = (0, client_core_1._makeDynamicConfig)(name, details, evaluation);
-        const overridden = (_b = (_a = this.overrideAdapter) === null || _a === void 0 ? void 0 : _a.getDynamicConfigOverride) === null || _b === void 0 ? void 0 : _b.call(_a, config, this._user, options);
-        const result = overridden !== null && overridden !== void 0 ? overridden : config;
-        this._enqueueExposure(name, (0, client_core_1._createConfigExposure)(this._user, result), options);
-        this.$emt({ name: 'dynamic_config_evaluation', dynamicConfig: result });
-        return result;
-    }
-    /**
-     * Retrieves the value of a experiment for the current user.
-     *
-     * @param {string} name The name of the experiment to get.
-     * @param {ExperimentEvaluationOptions} [options] - Optional. Additional options to customize the method call.
-     * @returns {Experiment} - The {@link Experiment} object representing the experiments's current evaluation results for the user.
-     */
-    getExperiment(name, options) {
-        var _a, _b;
-        const { result: evaluation, details } = this._store.getConfig(name);
-        const experiment = (0, client_core_1._makeExperiment)(name, details, evaluation);
-        const overridden = (_b = (_a = this.overrideAdapter) === null || _a === void 0 ? void 0 : _a.getExperimentOverride) === null || _b === void 0 ? void 0 : _b.call(_a, experiment, this._user, options);
-        const result = overridden !== null && overridden !== void 0 ? overridden : experiment;
-        this._enqueueExposure(name, (0, client_core_1._createConfigExposure)(this._user, result), options);
-        this.$emt({ name: 'experiment_evaluation', experiment: result });
-        return result;
-    }
-    /**
-     * Retrieves the value of a layer for the current user.
-     *
-     * @param {string} name The name of the layer to get.
-     * @param {LayerEvaluationOptions} [options] - Optional. Additional options to customize the method call.
-     * @returns {Layer} - The {@link Layer} object representing the layers's current evaluation results for the user.
-     */
-    getLayer(name, options) {
-        var _a, _b, _c;
-        const { result: evaluation, details } = this._store.getLayer(name);
-        const layer = (0, client_core_1._makeLayer)(name, details, evaluation);
-        const overridden = (_b = (_a = this.overrideAdapter) === null || _a === void 0 ? void 0 : _a.getLayerOverride) === null || _b === void 0 ? void 0 : _b.call(_a, layer, this._user, options);
-        const result = (0, client_core_1._mergeOverride)(layer, overridden, (_c = overridden === null || overridden === void 0 ? void 0 : overridden.__value) !== null && _c !== void 0 ? _c : layer.__value, (param) => {
-            this._enqueueExposure(name, (0, client_core_1._createLayerParameterExposure)(this._user, result, param), options);
-        });
-        this.$emt({ name: 'layer_evaluation', layer: result });
-        return result;
-    }
-    getParameterStore(name, options) {
-        const { result: configuration, details } = this._store.getParamStore(name);
-        this._logger.incrementNonExposureCount(name);
-        return {
-            name,
-            details,
-            __configuration: configuration,
-            get: (0, ParamStoreGetterFactory_1._makeParamStoreGetter)(this, configuration, options),
-        };
-    }
     /**
      * Logs an event to the internal logging system. This function allows logging by either passing a fully formed event object or by specifying the event name with optional value and metadata.
      *
@@ -304,5 +265,62 @@ class StatsigClient extends client_core_1.StatsigClientBase {
             client_core_1.StableID.setOverride(stableIdOverride, this._sdkKey);
         }
     }
+    _getFeatureGateImpl(name, options) {
+        var _a, _b;
+        const { result: evaluation, details } = this._store.getGate(name);
+        const gate = (0, client_core_1._makeFeatureGate)(name, details, evaluation);
+        const overridden = (_b = (_a = this.overrideAdapter) === null || _a === void 0 ? void 0 : _a.getGateOverride) === null || _b === void 0 ? void 0 : _b.call(_a, gate, this._user, options);
+        const result = overridden !== null && overridden !== void 0 ? overridden : gate;
+        this._enqueueExposure(name, (0, client_core_1._createGateExposure)(this._user, result), options);
+        this.$emt({ name: 'gate_evaluation', gate: result });
+        return result;
+    }
+    _getDynamicConfigImpl(name, options) {
+        var _a, _b;
+        const { result: evaluation, details } = this._store.getConfig(name);
+        const config = (0, client_core_1._makeDynamicConfig)(name, details, evaluation);
+        const overridden = (_b = (_a = this.overrideAdapter) === null || _a === void 0 ? void 0 : _a.getDynamicConfigOverride) === null || _b === void 0 ? void 0 : _b.call(_a, config, this._user, options);
+        const result = overridden !== null && overridden !== void 0 ? overridden : config;
+        this._enqueueExposure(name, (0, client_core_1._createConfigExposure)(this._user, result), options);
+        this.$emt({ name: 'dynamic_config_evaluation', dynamicConfig: result });
+        return result;
+    }
+    _getExperimentImpl(name, options) {
+        var _a, _b;
+        const { result: evaluation, details } = this._store.getConfig(name);
+        const experiment = (0, client_core_1._makeExperiment)(name, details, evaluation);
+        const overridden = (_b = (_a = this.overrideAdapter) === null || _a === void 0 ? void 0 : _a.getExperimentOverride) === null || _b === void 0 ? void 0 : _b.call(_a, experiment, this._user, options);
+        const result = overridden !== null && overridden !== void 0 ? overridden : experiment;
+        this._enqueueExposure(name, (0, client_core_1._createConfigExposure)(this._user, result), options);
+        this.$emt({ name: 'experiment_evaluation', experiment: result });
+        return result;
+    }
+    _getLayerImpl(name, options) {
+        var _a, _b, _c;
+        const { result: evaluation, details } = this._store.getLayer(name);
+        const layer = (0, client_core_1._makeLayer)(name, details, evaluation);
+        const overridden = (_b = (_a = this.overrideAdapter) === null || _a === void 0 ? void 0 : _a.getLayerOverride) === null || _b === void 0 ? void 0 : _b.call(_a, layer, this._user, options);
+        if (options === null || options === void 0 ? void 0 : options.disableExposureLog) {
+            this._logger.incrementNonExposureCount(name);
+        }
+        const result = (0, client_core_1._mergeOverride)(layer, overridden, (_c = overridden === null || overridden === void 0 ? void 0 : overridden.__value) !== null && _c !== void 0 ? _c : layer.__value, (param) => {
+            if (options === null || options === void 0 ? void 0 : options.disableExposureLog) {
+                return;
+            }
+            this._enqueueExposure(name, (0, client_core_1._createLayerParameterExposure)(this._user, result, param), options);
+        });
+        this.$emt({ name: 'layer_evaluation', layer: result });
+        return result;
+    }
+    _getParameterStoreImpl(name, options) {
+        const { result: configuration, details } = this._store.getParamStore(name);
+        this._logger.incrementNonExposureCount(name);
+        return {
+            name,
+            details,
+            __configuration: configuration,
+            get: (0, ParamStoreGetterFactory_1._makeParamStoreGetter)(this, configuration, options),
+        };
+    }
 }
 exports.default = StatsigClient;