@statsig/client-core 0.0.1-beta.12 → 0.0.1-beta.13

package/package.json

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

package/src/ClientInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { EvaluationOptions } from './StatsigClientBase';
+import { DynamicConfigEvaluationOptions, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, LayerEvaluationOptions } from './EvaluationOptions';
 import { StatsigClientEventEmitterInterface } from './StatsigClientEventEmitter';
 import { EvaluationsDataAdapter, SpecsDataAdapter } from './StatsigDataAdapter';
 import { StatsigEvent } from './StatsigEvent';
@@ -13,11 +13,11 @@ export interface StatsigClientCommonInterface extends StatsigClientEventEmitterI
 }
 export interface OnDeviceEvaluationsInterface extends StatsigClientCommonInterface {
     readonly dataAdapter: SpecsDataAdapter;
-    checkGate(name: string, user: StatsigUser, options: EvaluationOptions): boolean;
-    getFeatureGate(name: string, user: StatsigUser, options: EvaluationOptions): FeatureGate;
-    getDynamicConfig(name: string, user: StatsigUser, options: EvaluationOptions): DynamicConfig;
-    getExperiment(name: string, user: StatsigUser, options: EvaluationOptions): Experiment;
-    getLayer(name: string, user: StatsigUser, options: EvaluationOptions): Layer;
+    checkGate(name: string, user: StatsigUser, options?: FeatureGateEvaluationOptions): boolean;
+    getFeatureGate(name: string, user: StatsigUser, options?: FeatureGateEvaluationOptions): FeatureGate;
+    getDynamicConfig(name: string, user: StatsigUser, options?: DynamicConfigEvaluationOptions): DynamicConfig;
+    getExperiment(name: string, user: StatsigUser, options?: ExperimentEvaluationOptions): Experiment;
+    getLayer(name: string, user: StatsigUser, options?: LayerEvaluationOptions): Layer;
     logEvent(event: StatsigEvent, user: StatsigUser): void;
 }
 export interface PrecomputedEvaluationsInterface extends StatsigClientCommonInterface {
@@ -25,11 +25,11 @@ export interface PrecomputedEvaluationsInterface extends StatsigClientCommonInte
     getCurrentUser(): StatsigUser;
     updateUserSync(user: StatsigUser): void;
     updateUserAsync(user: StatsigUser): Promise<void>;
-    checkGate(name: string, options: EvaluationOptions): boolean;
-    getFeatureGate(name: string, options: EvaluationOptions): FeatureGate;
-    getDynamicConfig(name: string, options: EvaluationOptions): DynamicConfig;
-    getExperiment(name: string, options: EvaluationOptions): Experiment;
-    getLayer(name: string, options: EvaluationOptions): Layer;
+    checkGate(name: string, options?: FeatureGateEvaluationOptions): boolean;
+    getFeatureGate(name: string, options?: FeatureGateEvaluationOptions): FeatureGate;
+    getDynamicConfig(name: string, options?: DynamicConfigEvaluationOptions): DynamicConfig;
+    getExperiment(name: string, options?: ExperimentEvaluationOptions): Experiment;
+    getLayer(name: string, options?: LayerEvaluationOptions): Layer;
     logEvent(event: StatsigEvent): void;
 }
 export type StatsigClientInterface = OnDeviceEvaluationsInterface | PrecomputedEvaluationsInterface;

package/src/EvaluationOptions.d.ts

@@ -0,0 +1,20 @@
+export type EvaluationOptionsCommon = {
+    /**
+     * Prevents an exposure log being created for this check.
+     *
+     * default: `false`
+     */
+    disableExposureLog?: boolean;
+};
+export type FeatureGateEvaluationOptions = EvaluationOptionsCommon & {};
+export type DynamicConfigEvaluationOptions = EvaluationOptionsCommon & {};
+export type ExperimentEvaluationOptions = EvaluationOptionsCommon & {
+    /**
+     * Provide a map of values to be used across checks
+     *
+     * @requires {@link @statsig/js-user-persisted-storage}
+     * @see {@link https://docs.statsig.com/client/concepts/persistent_assignment#example-usage}
+     */
+    userPersistedValues?: unknown;
+};
+export type LayerEvaluationOptions = EvaluationOptionsCommon & {};

package/src/EvaluationOptions.js

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

package/src/EvaluationTypes.d.ts

@@ -1,3 +1,4 @@
+import { Flatten } from './UtitlityTypes';
 type EvaluationBase<T> = {
     id_type: string;
     name: string;
@@ -11,20 +12,20 @@ export type SecondaryExposure = {
     ruleID: string;
 };
 export type GateEvaluation = EvaluationBase<boolean>;
-export type ExperimentEvaluation = EvaluationBase<Record<string, unknown>> & {
+export type ExperimentEvaluation = Flatten<EvaluationBase<Record<string, unknown>> & {
     group_name?: string;
     group: string;
     id_type: string;
     is_device_based: boolean;
     is_experiment_active?: boolean;
     is_user_in_experiment?: boolean;
-};
+}>;
 export type DynamicConfigEvaluation = ExperimentEvaluation;
-export type LayerEvaluation = Omit<ExperimentEvaluation, 'id_type'> & {
+export type LayerEvaluation = Flatten<Omit<ExperimentEvaluation, 'id_type'> & {
     allocated_experiment_name: string;
     explicit_parameters: string[];
     undelegated_secondary_exposures?: SecondaryExposure[];
-};
+}>;
 export type AnyEvaluation = GateEvaluation | ExperimentEvaluation | DynamicConfigEvaluation | LayerEvaluation;
 export type EvaluationDetails = {
     reason: string;

package/src/OverrideAdapter.d.ts

@@ -1,12 +1,13 @@
+import { DynamicConfigEvaluationOptions, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, LayerEvaluationOptions } from './EvaluationOptions';
 import { DynamicConfig, Experiment, FeatureGate, Layer } from './StatsigTypes';
 import { StatsigUser } from './StatsigUser';
 export type OverrideAdapter = {
-    getGateOverride?(current: FeatureGate, user: StatsigUser): FeatureGate | null;
-    getDynamicConfigOverride?(current: DynamicConfig, user: StatsigUser): DynamicConfig | null;
-    getExperimentOverride?(current: Experiment, user: StatsigUser): Experiment | null;
-    getLayerOverride?(current: Layer, user: StatsigUser): Layer | null;
+    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;
 };
-export declare class CombinationOverrideProvider implements OverrideAdapter {
+export declare class CombinationOverrideAdapter implements OverrideAdapter {
     readonly providers: OverrideAdapter[];
     constructor(providers: OverrideAdapter[]);
     getGateOverride(current: FeatureGate, user: StatsigUser): FeatureGate | null;

package/src/OverrideAdapter.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CombinationOverrideProvider = void 0;
-class CombinationOverrideProvider {
+exports.CombinationOverrideAdapter = void 0;
+class CombinationOverrideAdapter {
     constructor(providers) {
         this.providers = providers;
     }
@@ -21,4 +21,4 @@ class CombinationOverrideProvider {
         return null;
     }
 }
-exports.CombinationOverrideProvider = CombinationOverrideProvider;
+exports.CombinationOverrideAdapter = CombinationOverrideAdapter;

package/src/StatsigClientBase.d.ts

@@ -1,5 +1,6 @@
 import './$_StatsigGlobal';
 import { ErrorBoundary } from './ErrorBoundary';
+import { EvaluationOptionsCommon } from './EvaluationOptions';
 import { EventLogger } from './EventLogger';
 import { NetworkCore } from './NetworkCore';
 import { OverrideAdapter } from './OverrideAdapter';
@@ -7,10 +8,6 @@ import { StatsigClientEvent, StatsigClientEventCallback, StatsigClientEventData,
 import { DataAdapterResult, EvaluationsDataAdapter, SpecsDataAdapter } from './StatsigDataAdapter';
 import { StatsigEventInternal } from './StatsigEvent';
 import { StatsigOptionsCommon, StatsigRuntimeMutableOptions } from './StatsigOptionsCommon';
-export type EvaluationOptions = {
-    disableExposureLog?: boolean;
-};
-export declare const DEFAULT_EVAL_OPTIONS: EvaluationOptions;
 export type StatsigClientEmitEventFunc = (data: StatsigClientEventData) => void;
 export declare abstract class StatsigClientBase<TAdapter extends EvaluationsDataAdapter | SpecsDataAdapter> implements StatsigClientEventEmitterInterface {
     protected readonly _sdkKey: string;
@@ -27,5 +24,5 @@ export declare abstract class StatsigClientBase<TAdapter extends EvaluationsData
     off(event: StatsigClientEvent | '*', listener: StatsigClientEventCallback): void;
     protected _emit(data: StatsigClientEventData): void;
     protected _setStatus(newStatus: StatsigLoadingStatus, values: DataAdapterResult | null): void;
-    protected _enqueueExposure(name: string, options: EvaluationOptions, exposure: StatsigEventInternal): void;
+    protected _enqueueExposure(name: string, exposure: StatsigEventInternal, options?: EvaluationOptionsCommon): void;
 }

package/src/StatsigClientBase.js

@@ -1,15 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StatsigClientBase = exports.DEFAULT_EVAL_OPTIONS = void 0;
+exports.StatsigClientBase = void 0;
 require("./$_StatsigGlobal");
 const ErrorBoundary_1 = require("./ErrorBoundary");
 const EventLogger_1 = require("./EventLogger");
 const Log_1 = require("./Log");
 const StableID_1 = require("./StableID");
 const StorageProvider_1 = require("./StorageProvider");
-exports.DEFAULT_EVAL_OPTIONS = {
-    disableExposureLog: false,
-};
 class StatsigClientBase {
     constructor(_sdkKey, adapter, network, options) {
         var _a, _b, _c;
@@ -66,8 +63,8 @@ class StatsigClientBase {
         this.loadingStatus = newStatus;
         this._emit({ event: 'values_updated', status: newStatus, values });
     }
-    _enqueueExposure(name, options, exposure) {
-        if (options.disableExposureLog === true) {
+    _enqueueExposure(name, exposure, options) {
+        if ((options === null || options === void 0 ? void 0 : options.disableExposureLog) === true) {
             this._logger.incrementNonExposureCount(name);
             return;
         }

package/src/StatsigEvent.d.ts

@@ -16,14 +16,7 @@ export type StatsigEventInternal = Omit<StatsigEvent, 'metadata'> & {
     } | null;
     secondaryExposures?: SecondaryExposure[];
 };
-type LayerEvaluation = {
-    explicit_parameters: string[] | null;
-    undelegated_secondary_exposures?: SecondaryExposure[];
-    secondary_exposures: SecondaryExposure[];
-    allocated_experiment_name: string | null;
-};
 export declare function isExposureEvent({ eventName }: StatsigEventInternal): boolean;
-export declare function createGateExposure(user: StatsigUser, gate: FeatureGate, secondaryExposures: SecondaryExposure[] | undefined): StatsigEventInternal;
-export declare function createConfigExposure(user: StatsigUser, config: DynamicConfig, secondaryExposures: SecondaryExposure[] | undefined): StatsigEventInternal;
-export declare function createLayerParameterExposure(user: StatsigUser, layer: Layer, parameterName: string, evaluation: LayerEvaluation | null): StatsigEventInternal;
-export {};
+export declare function createGateExposure(user: StatsigUser, gate: FeatureGate): StatsigEventInternal;
+export declare function createConfigExposure(user: StatsigUser, config: DynamicConfig): StatsigEventInternal;
+export declare function createLayerParameterExposure(user: StatsigUser, layer: Layer, parameterName: string): StatsigEventInternal;

package/src/StatsigEvent.js

@@ -18,23 +18,26 @@ function isExposureEvent({ eventName }) {
     return eventName === GATE_EXPOSURE_NAME || eventName === CONFIG_EXPOSURE_NAME;
 }
 exports.isExposureEvent = isExposureEvent;
-function createGateExposure(user, gate, secondaryExposures) {
+function createGateExposure(user, gate) {
+    var _a, _b;
     return createExposure(GATE_EXPOSURE_NAME, user, gate.details, {
         gate: gate.name,
         gateValue: String(gate.value),
         ruleID: gate.ruleID,
-    }, secondaryExposures !== null && secondaryExposures !== void 0 ? secondaryExposures : []);
+    }, (_b = (_a = gate.__evaluation) === null || _a === void 0 ? void 0 : _a.secondary_exposures) !== null && _b !== void 0 ? _b : []);
 }
 exports.createGateExposure = createGateExposure;
-function createConfigExposure(user, config, secondaryExposures) {
+function createConfigExposure(user, config) {
+    var _a, _b;
     return createExposure(CONFIG_EXPOSURE_NAME, user, config.details, {
         config: config.name,
         ruleID: config.ruleID,
-    }, secondaryExposures !== null && secondaryExposures !== void 0 ? secondaryExposures : []);
+    }, (_b = (_a = config.__evaluation) === null || _a === void 0 ? void 0 : _a.secondary_exposures) !== null && _b !== void 0 ? _b : []);
 }
 exports.createConfigExposure = createConfigExposure;
-function createLayerParameterExposure(user, layer, parameterName, evaluation) {
+function createLayerParameterExposure(user, layer, parameterName) {
     var _a, _b, _c;
+    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;
     let allocatedExperiment = '';
     let secondaryExposures = (_b = evaluation === null || evaluation === void 0 ? void 0 : evaluation.undelegated_secondary_exposures) !== null && _b !== void 0 ? _b : [];

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

package/src/StatsigTypes.d.ts

@@ -1,7 +1,5 @@
 import { DynamicConfigEvaluation, EvaluationDetails, ExperimentEvaluation, GateEvaluation, LayerEvaluation } from './EvaluationTypes';
-export type Flatten<T> = {
-    [K in keyof T]: T[K];
-} & {};
+import { Flatten } from './UtitlityTypes';
 type CommonFields = {
     readonly name: string;
     readonly ruleID: string;

package/src/UtitlityTypes.d.ts

@@ -0,0 +1,3 @@
+export type Flatten<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/src/UtitlityTypes.js

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

package/src/index.d.ts

@@ -7,6 +7,7 @@ export * from './$_StatsigGlobal';
 export * from './ClientInterfaces';
 export * from './DataAdapterCore';
 export * from './ErrorBoundary';
+export * from './EvaluationOptions';
 export * from './EvaluationTypes';
 export * from './Hashing';
 export * from './Log';
@@ -25,6 +26,7 @@ export * from './StatsigUser';
 export * from './StorageProvider';
 export * from './TypedJsonParse';
 export * from './UrlOverrides';
+export * from './UtitlityTypes';
 export * from './UUID';
 export * from './VisibilityChangeObserver';
 export { EventLogger, Storage, Log };

package/src/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./$_StatsigGlobal"), exports);
 __exportStar(require("./ClientInterfaces"), exports);
 __exportStar(require("./DataAdapterCore"), exports);
 __exportStar(require("./ErrorBoundary"), exports);
+__exportStar(require("./EvaluationOptions"), exports);
 __exportStar(require("./EvaluationTypes"), exports);
 __exportStar(require("./Hashing"), exports);
 __exportStar(require("./Log"), exports);
@@ -45,6 +46,7 @@ __exportStar(require("./StatsigUser"), exports);
 __exportStar(require("./StorageProvider"), exports);
 __exportStar(require("./TypedJsonParse"), exports);
 __exportStar(require("./UrlOverrides"), exports);
+__exportStar(require("./UtitlityTypes"), exports);
 __exportStar(require("./UUID"), exports);
 __exportStar(require("./VisibilityChangeObserver"), exports);
 __STATSIG__ = Object.assign(Object.assign({}, (__STATSIG__ !== null && __STATSIG__ !== void 0 ? __STATSIG__ : {})), { EventLogger: EventLogger_1.EventLogger,