@statsig/client-core 1.1.1 → 1.3.0

package/package.json

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

package/src/ClientInterfaces.d.ts

@@ -1,13 +1,13 @@
 import { DownloadConfigSpecsResponse } from './DownloadConfigSpecsResponse';
 import { ErrorBoundary } from './ErrorBoundary';
-import { DynamicConfigEvaluationOptions, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, LayerEvaluationOptions } from './EvaluationOptions';
+import { DynamicConfigEvaluationOptions, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, LayerEvaluationOptions, ParameterStoreEvaluationOptions } from './EvaluationOptions';
 import { InitializeResponseWithUpdates } from './InitializeResponse';
 import { StatsigSession } from './SessionID';
 import { StatsigClientEventEmitterInterface } from './StatsigClientEventEmitter';
 import { EvaluationsDataAdapter, SpecsDataAdapter } from './StatsigDataAdapter';
 import { StatsigEvent } from './StatsigEvent';
 import { AnyStatsigOptions, StatsigRuntimeMutableOptions } from './StatsigOptionsCommon';
-import { DynamicConfig, Experiment, FeatureGate, Layer } from './StatsigTypes';
+import { DynamicConfig, Experiment, FeatureGate, Layer, ParameterStore } from './StatsigTypes';
 import { StatsigUser } from './StatsigUser';
 import { Flatten } from './UtitlityTypes';
 export interface StatsigClientCommonInterface extends StatsigClientEventEmitterInterface {
@@ -58,6 +58,7 @@ export interface PrecomputedEvaluationsInterface extends StatsigClientCommonInte
     getDynamicConfig(name: string, options?: DynamicConfigEvaluationOptions): DynamicConfig;
     getExperiment(name: string, options?: ExperimentEvaluationOptions): Experiment;
     getLayer(name: string, options?: LayerEvaluationOptions): Layer;
+    getParameterStore(name: string, options?: ParameterStoreEvaluationOptions): ParameterStore;
     logEvent(event: StatsigEvent): void;
     logEvent(eventName: string, value?: string | number, metadata?: Record<string, string>): void;
 }

package/src/EvaluationOptions.d.ts

@@ -18,3 +18,4 @@ export type ExperimentEvaluationOptions = EvaluationOptionsCommon & {
     userPersistedValues?: unknown;
 };
 export type LayerEvaluationOptions = EvaluationOptionsCommon & {};
+export type ParameterStoreEvaluationOptions = EvaluationOptionsCommon & {};

package/src/EvaluationTypes.d.ts

@@ -1,3 +1,4 @@
+import { ParamStoreConfig } from './ParamStoreTypes';
 import { Flatten } from './UtitlityTypes';
 type EvaluationBase<T> = {
     id_type: string;
@@ -32,8 +33,8 @@ export type EvaluationDetails = {
     lcut?: number;
     receivedAt?: number;
 };
-export type DetailedEvaluation<T extends AnyEvaluation> = {
-    evaluation: T | null;
+export type DetailedStoreResult<T extends AnyEvaluation | ParamStoreConfig> = {
+    result: T | null;
     details: EvaluationDetails;
 };
 export {};

package/src/InitializeResponse.d.ts

@@ -1,4 +1,5 @@
 import { DynamicConfigEvaluation, GateEvaluation, LayerEvaluation } from './EvaluationTypes';
+import { ParamStoreConfig } from './ParamStoreTypes';
 import { StatsigUser } from './StatsigUser';
 type SessionReplayFields = {
     can_record_session?: boolean;
@@ -8,6 +9,7 @@ export type InitializeResponseWithUpdates = SessionReplayFields & {
     feature_gates: Record<string, GateEvaluation>;
     dynamic_configs: Record<string, DynamicConfigEvaluation>;
     layer_configs: Record<string, LayerEvaluation>;
+    param_stores?: Record<string, ParamStoreConfig>;
     time: number;
     has_updates: true;
     hash_used: 'none' | 'sha256' | 'djb2';

package/src/NetworkCore.d.ts

@@ -35,6 +35,5 @@ export declare class NetworkCore {
     private _getPopulatedURL;
     private _getPopulatedBody;
     private _attemptToEncodeString;
-    private _attemptToCompressBody;
 }
 export {};

package/src/NetworkCore.js

@@ -44,9 +44,6 @@ class NetworkCore {
             if (args.isStatsigEncodable) {
                 body = this._attemptToEncodeString(args, body);
             }
-            else if (args.isCompressable) {
-                body = yield this._attemptToCompressBody(args, body);
-            }
             return this._sendRequest(Object.assign({ method: 'POST', body }, args));
         });
     }
@@ -62,8 +59,7 @@ class NetworkCore {
             if (!_ensureValidSdkKey(args)) {
                 return false;
             }
-            let body = yield this._getPopulatedBody(args);
-            body = yield this._attemptToCompressBody(args, body);
+            const body = yield this._getPopulatedBody(args);
             const url = yield this._getPopulatedURL(args);
             const nav = navigator;
             return nav.sendBeacon.bind(nav)(url, body);
@@ -162,25 +158,6 @@ class NetworkCore {
             return input;
         }
     }
-    _attemptToCompressBody(args, body) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!args.isCompressable ||
-                this._options.disableCompression ||
-                (0, __StatsigGlobal_1._getStatsigGlobalFlag)('no-compress') != null ||
-                typeof CompressionStream === 'undefined' ||
-                typeof TextEncoder === 'undefined') {
-                return body;
-            }
-            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);
-            args.params = Object.assign(Object.assign({}, ((_a = args.params) !== null && _a !== void 0 ? _a : {})), { [NetworkConfig_1.NetworkParam.IsGzipped]: '1' });
-            return yield new Response(stream.readable).arrayBuffer();
-        });
-    }
 }
 exports.NetworkCore = NetworkCore;
 const _ensureValidSdkKey = (args) => {

package/src/ParamStoreTypes.d.ts

@@ -0,0 +1,65 @@
+type ParamType = 'string' | 'boolean' | 'number' | 'array' | 'object';
+type RefType = 'gate' | 'gated_value' | 'static' | 'layer' | 'dynamic_config' | 'experiment';
+export type StaticParam = {
+    ref_type: 'static';
+} & ({
+    param_type: 'boolean';
+    value: boolean;
+} | {
+    param_type: 'number';
+    value: number;
+} | {
+    param_type: 'string';
+    value: string;
+} | {
+    param_type: 'object';
+    value: object;
+} | {
+    param_type: 'array';
+    value: unknown[];
+});
+export type GateParam = {
+    ref_type: 'gate';
+    gate_name: string;
+} & ({
+    param_type: 'boolean';
+    pass_value: boolean;
+    fail_value: boolean;
+} | {
+    param_type: 'number';
+    pass_value: number;
+    fail_value: number;
+} | {
+    param_type: 'string';
+    pass_value: string;
+    fail_value: string;
+} | {
+    param_type: 'object';
+    pass_value: object;
+    fail_value: object;
+} | {
+    param_type: 'array';
+    pass_value: unknown[];
+    fail_value: unknown[];
+});
+type Param<R extends RefType, T extends ParamType> = {
+    ref_type: R;
+    param_type: T;
+};
+export type LayerParam = Param<'layer', ParamType> & {
+    layer_name: string;
+    param_name: string;
+};
+export type DynamicConfigParam = Param<'dynamic_config', ParamType> & {
+    config_name: string;
+    param_name: string;
+};
+export type ExperimentParam = Param<'experiment', ParamType> & {
+    experiment_name: string;
+    param_name: string;
+};
+type AnyParam = GateParam | StaticParam | LayerParam | DynamicConfigParam | ExperimentParam;
+export type ParamStoreConfig = {
+    [param_name: string]: AnyParam | undefined;
+};
+export {};

package/src/ParamStoreTypes.js

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

package/src/SessionID.d.ts

@@ -15,5 +15,6 @@ export declare const SessionID: {
 };
 export declare const StatsigSession: {
     get: (sdkKey: string) => Promise<StatsigSession>;
+    overrideInitialSessionID: (override: string, sdkKey: string) => void;
 };
 export {};

package/src/SessionID.js

@@ -30,6 +30,9 @@ exports.StatsigSession = {
         const session = yield PROMISE_MAP[sdkKey];
         return _bumpSession(session);
     }),
+    overrideInitialSessionID: (override, sdkKey) => {
+        PROMISE_MAP[sdkKey] = _overrideSessionId(override, sdkKey);
+    },
 };
 function _loadSession(sdkKey) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -48,6 +51,17 @@ function _loadSession(sdkKey) {
         };
     });
 }
+function _overrideSessionId(override, sdkKey) {
+    const now = Date.now();
+    return Promise.resolve({
+        data: {
+            sessionID: override,
+            startTime: now,
+            lastUpdate: now,
+        },
+        sdkKey,
+    });
+}
 function _bumpSession(session) {
     const now = Date.now();
     const data = session.data;

package/src/StatsigClientBase.js

@@ -16,6 +16,7 @@ const ErrorBoundary_1 = require("./ErrorBoundary");
 const EventLogger_1 = require("./EventLogger");
 const Log_1 = require("./Log");
 const SafeJs_1 = require("./SafeJs");
+const SessionID_1 = require("./SessionID");
 const StorageProvider_1 = require("./StorageProvider");
 class StatsigClientBase {
     constructor(sdkKey, adapter, network, options) {
@@ -25,6 +26,8 @@ class StatsigClientBase {
         const emitter = this.$emt.bind(this);
         (options === null || options === void 0 ? void 0 : options.logLevel) != null && (Log_1.Log.level = options.logLevel);
         (options === null || options === void 0 ? void 0 : options.disableStorage) && StorageProvider_1.Storage._setDisabled(true);
+        (options === null || options === void 0 ? void 0 : options.initialSessionID) &&
+            SessionID_1.StatsigSession.overrideInitialSessionID(options.initialSessionID, sdkKey);
         this._sdkKey = sdkKey;
         this._options = options !== null && options !== void 0 ? options : {};
         this._overrideAdapter = (_a = options === null || options === void 0 ? void 0 : options.overrideAdapter) !== null && _a !== void 0 ? _a : null;

package/src/StatsigEvent.d.ts

@@ -5,7 +5,7 @@ export type StatsigEvent = {
     eventName: string;
     value?: string | number | null;
     metadata?: {
-        [key: string]: string;
+        [key: string]: string | undefined;
     } | null;
 };
 export type StatsigEventInternal = Omit<StatsigEvent, 'metadata'> & {

package/src/StatsigMetadata.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "1.1.1";
+export declare const SDK_VERSION = "1.3.0";
 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 = '1.1.1';
+exports.SDK_VERSION = '1.3.0';
 let metadata = {
     sdkVersion: exports.SDK_VERSION,
     sdkType: 'js-mono', // js-mono is overwritten by Precomp and OnDevice clients

package/src/StatsigOptionsCommon.d.ts

@@ -104,6 +104,12 @@ export type StatsigOptionsCommon<NetworkConfig extends NetworkConfigCommon> = St
      * returned to the caller of a check api (checkGate/getExperiment etc).
      */
     overrideAdapter?: OverrideAdapter;
+    /**
+     * Overrides the auto-generated SessionID with the provided string.
+     *
+     * Note: Sessions still expire and will be replaced with an auto-generated SessionID.
+     */
+    initialSessionID?: string;
 };
 export type AnyStatsigOptions = StatsigOptionsCommon<NetworkConfigCommon>;
 export type StatsigEnvironment = {

package/src/StatsigTypeFactories.d.ts

@@ -1,6 +1,12 @@
 import { DynamicConfigEvaluation, EvaluationDetails, GateEvaluation, LayerEvaluation } from './EvaluationTypes';
-import { AnyConfigBasedStatsigType, DynamicConfig, FeatureGate, Layer } from './StatsigTypes';
+import { AnyConfigBasedStatsigType, DynamicConfig, Experiment, FeatureGate, Layer, TypedGet } from './StatsigTypes';
+type Primitive = 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
 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 _makeExperiment(name: string, details: EvaluationDetails, evaluation: DynamicConfigEvaluation | null): Experiment;
 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;
+export declare function _typeOf(input: unknown): Primitive | 'array';
+export declare function _isTypeMatch<T>(a: unknown, b: unknown): a is T;
+export declare function _makeTypedGet(value: Record<string, unknown> | undefined, exposeFunc?: (param: string) => void): TypedGet;
+export {};

package/src/StatsigTypeFactories.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._mergeOverride = exports._makeLayer = exports._makeDynamicConfig = exports._makeFeatureGate = void 0;
+exports._makeTypedGet = exports._isTypeMatch = exports._typeOf = exports._mergeOverride = exports._makeLayer = exports._makeExperiment = exports._makeDynamicConfig = exports._makeFeatureGate = void 0;
 const DEFAULT_RULE = 'default';
 function _makeEvaluation(name, details, evaluation, value) {
     var _a;
@@ -18,9 +18,16 @@ function _makeFeatureGate(name, details, evaluation) {
 exports._makeFeatureGate = _makeFeatureGate;
 function _makeDynamicConfig(name, details, evaluation) {
     var _a;
-    return Object.assign(Object.assign({}, _makeEvaluation(name, details, evaluation, (_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) !== null && _a !== void 0 ? _a : {})), { groupName: null, get: _makeTypedGet(evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) });
+    const value = (_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) !== null && _a !== void 0 ? _a : {};
+    return Object.assign(Object.assign({}, _makeEvaluation(name, details, evaluation, value)), { get: _makeTypedGet(evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) });
 }
 exports._makeDynamicConfig = _makeDynamicConfig;
+function _makeExperiment(name, details, evaluation) {
+    var _a;
+    const result = _makeDynamicConfig(name, details, evaluation);
+    return Object.assign(Object.assign({}, result), { groupName: (_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.group_name) !== null && _a !== void 0 ? _a : null });
+}
+exports._makeExperiment = _makeExperiment;
 function _makeLayer(name, details, evaluation, exposeFunc) {
     var _a, _b;
     return Object.assign(Object.assign({}, _makeEvaluation(name, details, evaluation, undefined)), { get: _makeTypedGet(evaluation === null || evaluation === void 0 ? void 0 : evaluation.value, exposeFunc), groupName: (_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.group_name) !== null && _a !== void 0 ? _a : null, __value: (_b = evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) !== null && _b !== void 0 ? _b : {} });
@@ -30,10 +37,15 @@ function _mergeOverride(original, overridden, value, exposeFunc) {
     return Object.assign(Object.assign(Object.assign({}, original), overridden), { get: _makeTypedGet(value, exposeFunc) });
 }
 exports._mergeOverride = _mergeOverride;
+function _typeOf(input) {
+    return Array.isArray(input) ? 'array' : typeof input;
+}
+exports._typeOf = _typeOf;
 function _isTypeMatch(a, b) {
     const typeOf = (x) => (Array.isArray(x) ? 'array' : typeof x);
     return typeOf(a) === typeOf(b);
 }
+exports._isTypeMatch = _isTypeMatch;
 function _makeTypedGet(value, exposeFunc) {
     return (param, fallback) => {
         var _a;
@@ -48,3 +60,4 @@ function _makeTypedGet(value, exposeFunc) {
         return found;
     };
 }
+exports._makeTypedGet = _makeTypedGet;

package/src/StatsigTypes.d.ts

@@ -1,6 +1,8 @@
 import { EvaluationDetails, ExperimentEvaluation, GateEvaluation, LayerEvaluation } from './EvaluationTypes';
+import { ParamStoreConfig } from './ParamStoreTypes';
 import { Flatten } from './UtitlityTypes';
 export type TypedGet = <T = unknown>(key: string, fallback?: T) => TypedReturn<T>;
+export type ParamStoreTypedGet = <T = unknown>(key: string, fallback: T) => 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<{
@@ -19,7 +21,7 @@ export type Experiment = Flatten<{
     readonly __evaluation: ExperimentEvaluation | null;
     readonly get: TypedGet;
 }>;
-export type DynamicConfig = Flatten<Experiment>;
+export type DynamicConfig = Flatten<Omit<Experiment, 'groupName'>>;
 export type Layer = Flatten<{
     readonly name: string;
     readonly ruleID: string;
@@ -29,5 +31,11 @@ export type Layer = Flatten<{
     readonly __evaluation: LayerEvaluation | null;
     readonly get: TypedGet;
 }>;
+export type ParameterStore = Flatten<{
+    readonly name: string;
+    readonly details: EvaluationDetails;
+    readonly get: TypedGet;
+    readonly __configuration: ParamStoreConfig | null;
+}>;
 export type AnyConfigBasedStatsigType = DynamicConfig | Experiment | Layer;
 export type AnyStatsigType = FeatureGate | AnyConfigBasedStatsigType;

package/src/index.d.ts

@@ -17,6 +17,7 @@ export * from './Log';
 export * from './NetworkCore';
 export * from './NetworkConfig';
 export * from './OverrideAdapter';
+export * from './ParamStoreTypes';
 export * from './SafeJs';
 export * from './SDKType';
 export * from './SessionID';

package/src/index.js

@@ -38,6 +38,7 @@ __exportStar(require("./Log"), exports);
 __exportStar(require("./NetworkCore"), exports);
 __exportStar(require("./NetworkConfig"), exports);
 __exportStar(require("./OverrideAdapter"), exports);
+__exportStar(require("./ParamStoreTypes"), exports);
 __exportStar(require("./SafeJs"), exports);
 __exportStar(require("./SDKType"), exports);
 __exportStar(require("./SessionID"), exports);