@statsig/client-core 3.12.0 → 3.12.2

package/package.json

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

package/src/DataAdapterCore.d.ts

@@ -14,7 +14,7 @@ export declare abstract class DataAdapterCore {
     setData(data: string, user?: StatsigUser): void;
     protected _getDataAsyncImpl(current: DataAdapterResult | null, user?: StatsigUserInternal, options?: DataAdapterAsyncOptions): Promise<DataAdapterResult | null>;
     protected _prefetchDataImpl(user?: StatsigUser, options?: DataAdapterAsyncOptions): Promise<void>;
-    protected abstract _fetchFromNetwork(current: string | null, user?: StatsigUser, options?: DataAdapterAsyncOptions): Promise<string | null>;
+    protected abstract _fetchFromNetwork(current: string | null, user?: StatsigUser, options?: DataAdapterAsyncOptions, isCacheValidFor204?: boolean): Promise<string | null>;
     protected abstract _getCacheKey(user?: StatsigUserInternal): string;
     protected abstract _isCachedResultValidFor204(result: DataAdapterResult, user: StatsigUser | undefined): boolean;
     private _fetchAndPrepFromNetwork;

package/src/DataAdapterCore.js

@@ -75,12 +75,12 @@ class DataAdapterCore {
         });
     }
     _fetchAndPrepFromNetwork(cachedResult, user, options) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            let cachedData = null;
-            if (cachedResult && this._isCachedResultValidFor204(cachedResult, user)) {
-                cachedData = cachedResult.data;
-            }
-            const latest = yield this._fetchFromNetwork(cachedData, user, options);
+            const cachedData = (_a = cachedResult === null || cachedResult === void 0 ? void 0 : cachedResult.data) !== null && _a !== void 0 ? _a : null;
+            const isCacheValidFor204 = cachedResult != null &&
+                this._isCachedResultValidFor204(cachedResult, user);
+            const latest = yield this._fetchFromNetwork(cachedData, user, options, isCacheValidFor204);
             if (!latest) {
                 Log_1.Log.debug('No response returned for latest value');
                 return null;

package/src/DownloadConfigSpecsResponse.d.ts

@@ -1,3 +1,4 @@
+import { ParamStoreConfig } from './ParamStoreTypes';
 import { StatsigUser } from './StatsigUser';
 export type SpecCondition = {
     type: string;
@@ -34,10 +35,15 @@ export type Spec = {
     targetAppIDs?: string[];
     version?: number;
 };
+export type ParamStore = {
+    targetAppIDs?: string[];
+    parameters: ParamStoreConfig;
+};
 export type DownloadConfigSpecsResponse = {
     feature_gates: Spec[];
     dynamic_configs: Spec[];
     layer_configs: Spec[];
+    param_stores?: Record<string, ParamStore>;
     time: number;
     has_updates: boolean;
     sdkInfo?: Record<string, string>;

package/src/EvaluationTypes.d.ts

@@ -5,7 +5,7 @@ type EvaluationBase<T> = {
     id_type: string;
     name: string;
     rule_id: string;
-    secondary_exposures: SecondaryExposure[];
+    secondary_exposures: SecondaryExposure[] | string[];
     value: T;
     version?: string;
 };
@@ -28,7 +28,7 @@ export type DynamicConfigEvaluation = ExperimentEvaluation;
 export type LayerEvaluation = Flatten<Omit<ExperimentEvaluation, 'id_type'> & {
     allocated_experiment_name: string;
     explicit_parameters: string[];
-    undelegated_secondary_exposures?: SecondaryExposure[];
+    undelegated_secondary_exposures?: SecondaryExposure[] | string[];
 }>;
 export type AnyEvaluation = GateEvaluation | ExperimentEvaluation | DynamicConfigEvaluation | LayerEvaluation;
 export type EvaluationDetails = {

package/src/InitializeResponse.d.ts

@@ -1,4 +1,4 @@
-import { DynamicConfigEvaluation, GateEvaluation, LayerEvaluation } from './EvaluationTypes';
+import { DynamicConfigEvaluation, GateEvaluation, LayerEvaluation, SecondaryExposure } from './EvaluationTypes';
 import { ParamStoreConfig } from './ParamStoreTypes';
 import { StatsigUser } from './StatsigUser';
 type SessionReplayFields = {
@@ -23,6 +23,7 @@ export type InitializeResponseWithUpdates = SessionReplayFields & AutoCaptureFie
     sdkInfo?: Record<string, string>;
     sdk_flags?: Record<string, boolean>;
     full_checksum?: string;
+    exposures?: Record<string, SecondaryExposure>;
 };
 export type InitializeResponse = InitializeResponseWithUpdates | {
     has_updates: false;

package/src/NetworkCore.d.ts

@@ -14,11 +14,13 @@ type RequestArgs = {
     params?: Record<string, string>;
     headers?: Record<string, string>;
 };
-export type RequestArgsWithData = Flatten<RequestArgs & {
-    data: Record<string, unknown>;
+type DataFlags = {
     isStatsigEncodable?: boolean;
     isCompressable?: boolean;
-}>;
+};
+export type RequestArgsWithData = Flatten<RequestArgs & {
+    data: Record<string, unknown>;
+} & DataFlags>;
 type BeaconRequestArgs = Pick<RequestArgsWithData, 'data' | 'sdkKey' | 'urlConfig' | 'params' | 'isCompressable' | 'attempt'>;
 type NetworkResponse = {
     body: string | null;
@@ -43,8 +45,8 @@ export declare class NetworkCore {
     private _sendRequest;
     private _isRateLimited;
     private _getPopulatedURL;
-    private _getPopulatedBody;
-    private _attemptToEncodeString;
+    private _tryEncodeBody;
+    private _tryToCompressBody;
     private _getInternalRequestArgs;
 }
 export {};

package/src/NetworkCore.js

@@ -16,6 +16,7 @@ const Diagnostics_1 = require("./Diagnostics");
 const Log_1 = require("./Log");
 const NetworkConfig_1 = require("./NetworkConfig");
 const NetworkFallbackResolver_1 = require("./NetworkFallbackResolver");
+const SDKFlags_1 = require("./SDKFlags");
 const SDKType_1 = require("./SDKType");
 const SafeJs_1 = require("./SafeJs");
 const SessionID_1 = require("./SessionID");
@@ -71,19 +72,17 @@ class NetworkCore {
                 return false;
             }
             const argsInternal = this._getInternalRequestArgs('POST', args);
-            const body = yield this._getPopulatedBody(argsInternal, args.data);
+            yield this._tryToCompressBody(argsInternal);
             const url = yield this._getPopulatedURL(argsInternal);
             const nav = navigator;
-            return nav.sendBeacon.bind(nav)(url, body);
+            return nav.sendBeacon.bind(nav)(url, argsInternal.body);
         });
     }
     post(args) {
         return __awaiter(this, void 0, void 0, function* () {
             const argsInternal = this._getInternalRequestArgs('POST', args);
-            argsInternal.body = yield this._getPopulatedBody(argsInternal, args.data);
-            if (args.isStatsigEncodable) {
-                argsInternal.body = this._attemptToEncodeString(argsInternal, argsInternal.body);
-            }
+            this._tryEncodeBody(argsInternal);
+            yield this._tryToCompressBody(argsInternal);
             return this._sendRequest(argsInternal);
         });
     }
@@ -208,40 +207,74 @@ class NetworkCore {
             return `${url}${query ? `?${query}` : ''}`;
         });
     }
-    _getPopulatedBody(args, data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { sdkKey, fallbackUrl } = args;
-            const stableID = StableID_1.StableID.get(sdkKey);
-            const sessionID = SessionID_1.SessionID.get(sdkKey);
-            const sdkType = SDKType_1.SDKType._get(sdkKey);
-            return JSON.stringify(Object.assign(Object.assign({}, data), { statsigMetadata: Object.assign(Object.assign({}, StatsigMetadata_1.StatsigMetadataProvider.get()), { stableID,
-                    sessionID,
-                    sdkType,
-                    fallbackUrl }) }));
-        });
-    }
-    _attemptToEncodeString(args, input) {
-        var _a, _b;
+    _tryEncodeBody(args) {
+        var _a;
         const win = (0, SafeJs_1._getWindowSafe)();
-        if (this._options.disableStatsigEncoding ||
+        const body = args.body;
+        if (!args.isStatsigEncodable ||
+            this._options.disableStatsigEncoding ||
+            typeof body !== 'string' ||
             (0, __StatsigGlobal_1._getStatsigGlobalFlag)('no-encode') != null ||
             !(win === null || win === void 0 ? void 0 : win.btoa)) {
-            return input;
+            return;
         }
         try {
-            const result = (_a = win.btoa(input).split('').reverse().join('')) !== null && _a !== void 0 ? _a : input;
-            args.params = Object.assign(Object.assign({}, ((_b = args.params) !== null && _b !== void 0 ? _b : {})), { [NetworkConfig_1.NetworkParam.StatsigEncoded]: '1' });
-            return result;
+            args.body = win.btoa(body).split('').reverse().join('');
+            args.params = Object.assign(Object.assign({}, ((_a = args.params) !== null && _a !== void 0 ? _a : {})), { [NetworkConfig_1.NetworkParam.StatsigEncoded]: '1' });
         }
-        catch (_c) {
-            Log_1.Log.warn(`Request encoding failed for ${args.urlConfig.getUrl()}`);
-            return input;
+        catch (e) {
+            Log_1.Log.warn(`Request encoding failed for ${args.urlConfig.getUrl()}`, e);
         }
     }
+    _tryToCompressBody(args) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const body = args.body;
+            if (!args.isCompressable ||
+                this._options.disableCompression ||
+                typeof body !== 'string' ||
+                SDKFlags_1.SDKFlags.get(args.sdkKey, 'enable_log_event_compression') !== true ||
+                (0, __StatsigGlobal_1._getStatsigGlobalFlag)('no-compress') != null ||
+                typeof CompressionStream === 'undefined' ||
+                typeof TextEncoder === 'undefined') {
+                return;
+            }
+            try {
+                const bytes = new TextEncoder().encode(body);
+                const stream = new CompressionStream('gzip');
+                const writer = stream.writable.getWriter();
+                writer.write(bytes).catch(Log_1.Log.error);
+                writer.close().catch(Log_1.Log.error);
+                const reader = stream.readable.getReader();
+                const chunks = [];
+                let result;
+                // eslint-disable-next-line no-await-in-loop
+                while (!(result = yield reader.read()).done) {
+                    chunks.push(result.value);
+                }
+                const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0);
+                const combined = new Uint8Array(totalLength);
+                let offset = 0;
+                for (const chunk of chunks) {
+                    combined.set(chunk, offset);
+                    offset += chunk.length;
+                }
+                args.body = combined;
+                args.params = Object.assign(Object.assign({}, ((_a = args.params) !== null && _a !== void 0 ? _a : {})), { [NetworkConfig_1.NetworkParam.IsGzipped]: '1' });
+            }
+            catch (e) {
+                Log_1.Log.warn(`Request compression failed for ${args.urlConfig.getUrl()}`, e);
+            }
+        });
+    }
     _getInternalRequestArgs(method, args) {
         const fallbackUrl = this._fallbackResolver.getActiveFallbackUrl(args.sdkKey, args.urlConfig);
-        return Object.assign(Object.assign({}, args), { method,
+        const result = Object.assign(Object.assign({}, args), { method,
             fallbackUrl });
+        if ('data' in args) {
+            _populateRequestBody(result, args.data);
+        }
+        return result;
     }
 }
 exports.NetworkCore = NetworkCore;
@@ -252,6 +285,16 @@ const _ensureValidSdkKey = (args) => {
     }
     return true;
 };
+const _populateRequestBody = (args, data) => {
+    const { sdkKey, fallbackUrl } = args;
+    const stableID = StableID_1.StableID.get(sdkKey);
+    const sessionID = SessionID_1.SessionID.get(sdkKey);
+    const sdkType = SDKType_1.SDKType._get(sdkKey);
+    args.body = JSON.stringify(Object.assign(Object.assign({}, data), { statsigMetadata: Object.assign(Object.assign({}, StatsigMetadata_1.StatsigMetadataProvider.get()), { stableID,
+            sessionID,
+            sdkType,
+            fallbackUrl }) }));
+};
 function _getErrorMessage(controller, error) {
     if ((controller === null || controller === void 0 ? void 0 : controller.signal.aborted) &&
         typeof controller.signal.reason === 'string') {

package/src/OverrideAdapter.d.ts

@@ -1,9 +1,15 @@
-import { DynamicConfigEvaluationOptions, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, LayerEvaluationOptions } from './EvaluationOptions';
-import { DynamicConfig, Experiment, FeatureGate, Layer } from './StatsigTypes';
+import { DynamicConfigEvaluationOptions, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, LayerEvaluationOptions, ParameterStoreEvaluationOptions } from './EvaluationOptions';
+import { EvaluationDetails } from './EvaluationTypes';
+import { ParamStoreConfig } from './ParamStoreTypes';
+import { DynamicConfig, Experiment, FeatureGate, Layer, ParameterStore } from './StatsigTypes';
 import { StatsigUser } from './StatsigUser';
 export type OverrideAdapter = {
     getGateOverride?(current: FeatureGate, user: StatsigUser, options?: FeatureGateEvaluationOptions): FeatureGate | null;
     getDynamicConfigOverride?(current: DynamicConfig, user: StatsigUser, options?: DynamicConfigEvaluationOptions): DynamicConfig | null;
     getExperimentOverride?(current: Experiment, user: StatsigUser, options?: ExperimentEvaluationOptions): Experiment | null;
     getLayerOverride?(current: Layer, user: StatsigUser, options?: LayerEvaluationOptions): Layer | null;
+    getParamStoreOverride?(current: ParameterStore, options?: ParameterStoreEvaluationOptions): {
+        config: ParamStoreConfig;
+        details: EvaluationDetails;
+    } | null;
 };

package/src/ParamStoreTypes.d.ts

@@ -58,7 +58,7 @@ export type ExperimentParam = Param<'experiment', ParamType> & {
     experiment_name: string;
     param_name: string;
 };
-type AnyParam = GateParam | StaticParam | LayerParam | DynamicConfigParam | ExperimentParam;
+export type AnyParam = GateParam | StaticParam | LayerParam | DynamicConfigParam | ExperimentParam;
 export type ParamStoreConfig = {
     [param_name: string]: AnyParam | undefined;
 };

package/src/StatsigEvent.d.ts

@@ -22,6 +22,7 @@ export type StatsigEventInternal = Omit<StatsigEvent, 'metadata'> & {
     secondaryExposures?: SecondaryExposure[];
 };
 export declare const _isExposureEvent: ({ eventName, }: StatsigEventInternal) => boolean;
-export declare const _createGateExposure: (user: StatsigUserInternal, gate: FeatureGate) => StatsigEventInternal;
-export declare const _createConfigExposure: (user: StatsigUserInternal, config: DynamicConfig) => StatsigEventInternal;
-export declare const _createLayerParameterExposure: (user: StatsigUserInternal, layer: Layer, parameterName: string) => StatsigEventInternal;
+export declare const _createGateExposure: (user: StatsigUserInternal, gate: FeatureGate, exposureMapping?: Record<string, SecondaryExposure>) => StatsigEventInternal;
+export declare function _mapExposures(exposures: SecondaryExposure[] | string[], exposureMapping?: Record<string, SecondaryExposure>): SecondaryExposure[];
+export declare const _createConfigExposure: (user: StatsigUserInternal, config: DynamicConfig, exposureMapping?: Record<string, SecondaryExposure>) => StatsigEventInternal;
+export declare const _createLayerParameterExposure: (user: StatsigUserInternal, layer: Layer, parameterName: string, exposureMapping?: Record<string, SecondaryExposure>) => StatsigEventInternal;

package/src/StatsigEvent.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._createLayerParameterExposure = exports._createConfigExposure = exports._createGateExposure = exports._isExposureEvent = void 0;
+exports._createLayerParameterExposure = exports._createConfigExposure = exports._mapExposures = exports._createGateExposure = exports._isExposureEvent = void 0;
 const CONFIG_EXPOSURE_NAME = 'statsig::config_exposure';
 const GATE_EXPOSURE_NAME = 'statsig::gate_exposure';
 const LAYER_EXPOSURE_NAME = 'statsig::layer_exposure';
@@ -23,7 +23,7 @@ const _isExposureEvent = ({ eventName, }) => {
         eventName === LAYER_EXPOSURE_NAME);
 };
 exports._isExposureEvent = _isExposureEvent;
-const _createGateExposure = (user, gate) => {
+const _createGateExposure = (user, gate, exposureMapping) => {
     var _a, _b, _c;
     const metadata = {
         gate: gate.name,
@@ -33,10 +33,21 @@ const _createGateExposure = (user, gate) => {
     if (((_a = gate.__evaluation) === null || _a === void 0 ? void 0 : _a.version) != null) {
         metadata['configVersion'] = gate.__evaluation.version;
     }
-    return _createExposure(GATE_EXPOSURE_NAME, user, gate.details, metadata, (_c = (_b = gate.__evaluation) === null || _b === void 0 ? void 0 : _b.secondary_exposures) !== null && _c !== void 0 ? _c : []);
+    return _createExposure(GATE_EXPOSURE_NAME, user, gate.details, metadata, _mapExposures((_c = (_b = gate.__evaluation) === null || _b === void 0 ? void 0 : _b.secondary_exposures) !== null && _c !== void 0 ? _c : [], exposureMapping));
 };
 exports._createGateExposure = _createGateExposure;
-const _createConfigExposure = (user, config) => {
+function _mapExposures(exposures, exposureMapping) {
+    return exposures
+        .map((exposure) => {
+        if (typeof exposure === 'string') {
+            return (exposureMapping !== null && exposureMapping !== void 0 ? exposureMapping : {})[exposure];
+        }
+        return exposure;
+    })
+        .filter((exposure) => exposure != null);
+}
+exports._mapExposures = _mapExposures;
+const _createConfigExposure = (user, config, exposureMapping) => {
     var _a, _b, _c, _d;
     const metadata = {
         config: config.name,
@@ -48,10 +59,10 @@ const _createConfigExposure = (user, config) => {
     if (((_b = config.__evaluation) === null || _b === void 0 ? void 0 : _b.passed) != null) {
         metadata['rulePassed'] = String(config.__evaluation.passed);
     }
-    return _createExposure(CONFIG_EXPOSURE_NAME, user, config.details, metadata, (_d = (_c = config.__evaluation) === null || _c === void 0 ? void 0 : _c.secondary_exposures) !== null && _d !== void 0 ? _d : []);
+    return _createExposure(CONFIG_EXPOSURE_NAME, user, config.details, metadata, _mapExposures((_d = (_c = config.__evaluation) === null || _c === void 0 ? void 0 : _c.secondary_exposures) !== null && _d !== void 0 ? _d : [], exposureMapping));
 };
 exports._createConfigExposure = _createConfigExposure;
-const _createLayerParameterExposure = (user, layer, parameterName) => {
+const _createLayerParameterExposure = (user, layer, parameterName, exposureMapping) => {
     var _a, _b, _c, _d;
     const evaluation = layer.__evaluation;
     const isExplicit = ((_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.explicit_parameters) === null || _a === void 0 ? void 0 : _a.includes(parameterName)) === true;
@@ -71,7 +82,7 @@ const _createLayerParameterExposure = (user, layer, parameterName) => {
     if (((_d = layer.__evaluation) === null || _d === void 0 ? void 0 : _d.version) != null) {
         metadata['configVersion'] = layer.__evaluation.version;
     }
-    return _createExposure(LAYER_EXPOSURE_NAME, user, layer.details, metadata, secondaryExposures);
+    return _createExposure(LAYER_EXPOSURE_NAME, user, layer.details, metadata, _mapExposures(secondaryExposures, exposureMapping));
 };
 exports._createLayerParameterExposure = _createLayerParameterExposure;
 const _addEvaluationDetailsToMetadata = (details, metadata) => {

package/src/StatsigMetadata.d.ts

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

package/src/StatsigOptionsCommon.d.ts

@@ -14,6 +14,12 @@ export type StatsigRuntimeMutableOptions = {
      * Note: caching will not work if storage is disabled
      */
     disableStorage?: boolean;
+    /**
+     * Whether or not Statsig should compress JSON bodies for network requests where possible.
+     *
+     * default: `false`
+     */
+    disableCompression?: boolean;
 };
 export type NetworkConfigCommon = {
     /**