@statsig/client-core 0.0.1-beta.3 → 0.0.1-beta.31

package/src/StatsigEvent.js

@@ -1,57 +1,66 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createLayerParameterExposure = exports.createConfigExposure = exports.createGateExposure = exports.isExposureEvent = void 0;
-var CONFIG_EXPOSURE_NAME = 'statsig::config_exposure';
-var GATE_EXPOSURE_NAME = 'statsig::gate_exposure';
-var LAYER_EXPOSURE_NAME = 'statsig::layer_exposure';
-function createExposure(eventName, user, metadata, secondaryExposures) {
+exports._createLayerParameterExposure = exports._createConfigExposure = 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';
+const _createExposure = (eventName, user, details, metadata, secondaryExposures) => {
     return {
-        eventName: eventName,
-        user: user,
+        eventName,
+        user,
         value: null,
-        metadata: metadata,
-        secondaryExposures: secondaryExposures,
+        metadata: _addEvaluationDetailsToMetadata(details, metadata),
+        secondaryExposures,
         time: Date.now(),
     };
-}
-function isExposureEvent(_a) {
-    var eventName = _a.eventName;
+};
+const _isExposureEvent = ({ eventName, }) => {
     return eventName === GATE_EXPOSURE_NAME || eventName === CONFIG_EXPOSURE_NAME;
-}
-exports.isExposureEvent = isExposureEvent;
-function createGateExposure(user, gate, secondaryExposures) {
-    return createExposure(GATE_EXPOSURE_NAME, user, {
+};
+exports._isExposureEvent = _isExposureEvent;
+const _createGateExposure = (user, gate) => {
+    var _a, _b;
+    return _createExposure(GATE_EXPOSURE_NAME, user, gate.details, {
         gate: gate.name,
         gateValue: String(gate.value),
         ruleID: gate.ruleID,
-        reason: gate.source,
-    }, secondaryExposures !== null && secondaryExposures !== void 0 ? secondaryExposures : []);
-}
-exports.createGateExposure = createGateExposure;
-function createConfigExposure(user, config, secondaryExposures) {
-    return createExposure(CONFIG_EXPOSURE_NAME, user, {
+    }, (_b = (_a = gate.__evaluation) === null || _a === void 0 ? void 0 : _a.secondary_exposures) !== null && _b !== void 0 ? _b : []);
+};
+exports._createGateExposure = _createGateExposure;
+const _createConfigExposure = (user, config) => {
+    var _a, _b;
+    return _createExposure(CONFIG_EXPOSURE_NAME, user, config.details, {
         config: config.name,
         ruleID: config.ruleID,
-        reason: config.source,
-    }, secondaryExposures !== null && secondaryExposures !== void 0 ? secondaryExposures : []);
-}
-exports.createConfigExposure = createConfigExposure;
-function createLayerParameterExposure(user, layerName, parameterName, spec) {
-    var _a;
-    var isExplicit = spec.explicit_parameters.includes(parameterName);
-    var allocatedExperiment = '';
-    var secondaryExposures = (_a = spec.undelegated_secondary_exposures) !== null && _a !== void 0 ? _a : [];
+    }, (_b = (_a = config.__evaluation) === null || _a === void 0 ? void 0 : _a.secondary_exposures) !== null && _b !== void 0 ? _b : []);
+};
+exports._createConfigExposure = _createConfigExposure;
+const _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 : [];
     if (isExplicit) {
-        allocatedExperiment = spec.allocated_experiment_name;
-        secondaryExposures = spec.secondary_exposures;
+        allocatedExperiment = (_c = evaluation.allocated_experiment_name) !== null && _c !== void 0 ? _c : '';
+        secondaryExposures = evaluation.secondary_exposures;
     }
-    return createExposure(LAYER_EXPOSURE_NAME, user, {
-        config: layerName,
-        parameterName: parameterName,
-        ruleID: spec.rule_id,
-        allocatedExperiment: allocatedExperiment,
+    return _createExposure(LAYER_EXPOSURE_NAME, user, layer.details, {
+        config: layer.name,
+        parameterName,
+        ruleID: layer.ruleID,
+        allocatedExperiment,
         isExplicitParameter: String(isExplicit),
-        reason: spec.source,
     }, secondaryExposures);
-}
-exports.createLayerParameterExposure = createLayerParameterExposure;
+};
+exports._createLayerParameterExposure = _createLayerParameterExposure;
+const _addEvaluationDetailsToMetadata = (details, metadata) => {
+    metadata['reason'] = details.reason;
+    if (details.lcut) {
+        metadata['lcut'] = String(details.lcut);
+    }
+    if (details.receivedAt) {
+        metadata['receivedAt'] = String(details.receivedAt);
+    }
+    return metadata;
+};

package/src/StatsigMetadata.d.ts

@@ -1,10 +1,10 @@
+export declare const SDK_VERSION = "0.0.1-beta.31";
 export type StatsigMetadata = {
     readonly [key: string]: string | undefined;
     readonly appVersion?: string;
     readonly deviceModel?: string;
     readonly deviceModelName?: string;
     readonly locale?: string;
-    readonly sdkType: string;
     readonly sdkVersion: string;
     readonly stableID?: string;
     readonly systemName?: string;

package/src/StatsigMetadata.js

@@ -1,25 +1,14 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StatsigMetadataProvider = void 0;
-var SDK_VERSION = '0.0.1-beta.3';
-var metadata = {
-    sdkVersion: SDK_VERSION,
+exports.StatsigMetadataProvider = exports.SDK_VERSION = void 0;
+exports.SDK_VERSION = '0.0.1-beta.31';
+let metadata = {
+    sdkVersion: exports.SDK_VERSION,
     sdkType: 'js-mono', // js-mono is overwritten by Precomp and OnDevice clients
 };
 exports.StatsigMetadataProvider = {
-    get: function () { return metadata; },
-    add: function (additions) {
-        metadata = __assign(__assign({}, metadata), additions);
+    get: () => metadata,
+    add: (additions) => {
+        metadata = Object.assign(Object.assign({}, metadata), additions);
     },
 };

package/src/StatsigOptionsCommon.d.ts

@@ -1,12 +1,52 @@
 import { LogLevel } from './Log';
-import { StatsigDataProvider } from './StatsigDataProvider';
-/** Common options for configuring the Statsig SDK. */
-export type StatsigOptionsCommon = {
+import { OverrideAdapter } from './OverrideAdapter';
+/** Options that can be set at init and updated during runtime. */
+export type StatsigRuntimeMutableOptions = {
+    /**
+     * Prevents sending any events over the network.
+     */
+    disableLogging?: boolean;
+    /**
+     * Prevents writing anything to storage.
+     *
+     * Note: caching will not work if storage is disabled
+     */
+    disableStorage?: boolean;
+};
+export type NetworkConfigCommon = {
     /**
      * The API to use for all SDK network requests. You should not need to override this
-     * unless you have another API that implements the Statsig API endpoints.
+     * unless you have a custom API that implements the Statsig endpoints.
      */
     api?: string;
+    /**
+     * The URL used to flush queued events via a POST request. Takes precedence over {@link StatsigOptionsCommon.api}.
+     *
+     * default: `https://featuregates.org/v1/initialize`
+     */
+    logEventUrl?: string;
+    /**
+     * The URL used to flush queued events via {@link window.navigator.sendBeacon} (web only). Takes precedence over {@link StatsigOptionsCommon.api}.
+     *
+     * default: `https://featuregates.org/v1/initialize`
+     */
+    logEventBeaconUrl?: string;
+    /**
+     * The maximum amount of time (in milliseconds) that any network request can take
+     * before timing out.
+     *
+     * default: `10,000 ms` (10 seconds)
+     */
+    networkTimeoutMs?: number;
+};
+/** Options for configuring a Statsig client. */
+export type StatsigOptionsCommon<NetworkConfig extends NetworkConfigCommon> = StatsigRuntimeMutableOptions & {
+    /**
+     * Allows for fine grained control over which api or urls are hit for specific Statsig network requests.
+     *
+     * For defaults see {@link StatsigClientUrlOverrideOptions}
+     */
+    networkConfig?: NetworkConfig;
     /**
      * An object you can use to set environment variables that apply to all of your users
      * in the same session.
@@ -18,30 +58,41 @@ export type StatsigOptionsCommon = {
     overrideStableID?: string;
     /**
      * How much information is allowed to be printed to the console.
-     * Default: LogLevel.Warn
+     *
+     * default: {@link LogLevel.Warn}
      */
     logLevel?: LogLevel;
-    /**
-     * StatsigDataProvider implementors used to customize the initialization flow.
-     * Default: LocalStorageCache then Network
-     */
-    dataProviders?: StatsigDataProvider[];
-    /**
-     * The maximum amount of time (in milliseconds) that any network request can take
-     * before timing out. Default: 10,000 (10 seconds)
-     */
-    networkTimeoutMs?: number;
     /**
      * The maximum number of events to batch before flushing logs to Statsig.
-     * Default: 50
+     *
+     * default: `50`
      */
     loggingBufferMaxSize?: number;
     /**
      * How often (in milliseconds) to flush logs to Statsig.
-     * Default: 10,000 (10 seconds)
+     *
+     * default: `10,000 ms`  (10 seconds)
      */
     loggingIntervalMs?: number;
+    /**
+     * An implementor of {@link OverrideAdapter}, used to alter evaluations before its
+     * 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;
+    /**
+     * Whether or not Statsig should use raw JSON for network requests where possible.
+     *
+     * default: `false`
+     */
+    disableStatsigEncoding?: boolean;
 };
+export type AnyStatsigOptions = StatsigOptionsCommon<NetworkConfigCommon>;
 export type StatsigEnvironment = {
     tier?: string;
     [key: string]: string | undefined;

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,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._mergeOverride = exports._makeLayer = exports._makeDynamicConfig = exports._makeFeatureGate = void 0;
+const DEFAULT_RULE = 'default';
+function _makeEvaluation(name, details, evaluation, value) {
+    var _a;
+    return {
+        name,
+        details,
+        ruleID: (_a = evaluation === null || evaluation === void 0 ? void 0 : evaluation.rule_id) !== null && _a !== void 0 ? _a : DEFAULT_RULE,
+        __evaluation: evaluation,
+        value,
+    };
+}
+function _makeFeatureGate(name, details, evaluation) {
+    return _makeEvaluation(name, details, evaluation, (evaluation === null || evaluation === void 0 ? void 0 : evaluation.value) === true);
+}
+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) });
+}
+exports._makeDynamicConfig = _makeDynamicConfig;
+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 : {} });
+}
+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,22 +1,33 @@
-export type Flatten<T> = {
-    [K in keyof T]: T[K];
-} & {};
-type EvaluatedSpec = {
+import { EvaluationDetails, ExperimentEvaluation, GateEvaluation, LayerEvaluation } from './EvaluationTypes';
+import { Flatten } from './UtitlityTypes';
+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 source: string;
-};
-export type FeatureGate = EvaluatedSpec & {
+    readonly details: EvaluationDetails;
     readonly value: boolean;
-};
-export type DynamicConfig = EvaluatedSpec & {
+    readonly __evaluation: GateEvaluation | null;
+}>;
+export type Experiment = Flatten<{
+    readonly name: string;
+    readonly ruleID: string;
+    readonly details: EvaluationDetails;
     readonly value: Record<string, unknown>;
-};
-export type Experiment = DynamicConfig;
-export type Layer = EvaluatedSpec & {
-    readonly getValue: (parameterName: string) => unknown;
-};
-export declare function makeFeatureGate(name: string, source: string, ruleID?: string, value?: boolean): FeatureGate;
-export declare function makeDynamicConfig(name: string, source: string, ruleID?: string, value?: Record<string, unknown>): DynamicConfig;
-export declare function makeLayer(name: string, source: string, ruleID?: string, getValue?: (param: string) => unknown): Layer;
-export {};
+    readonly groupName: string | null;
+    readonly __evaluation: ExperimentEvaluation | null;
+    readonly get: TypedGet;
+}>;
+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 AnyConfigBasedStatsigType = DynamicConfig | Experiment | Layer;
+export type AnyStatsigType = FeatureGate | AnyConfigBasedStatsigType;

package/src/StatsigTypes.js

@@ -1,31 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeLayer = exports.makeDynamicConfig = exports.makeFeatureGate = void 0;
-var DEFAULT_RULE = 'default';
-function makeFeatureGate(name, source, ruleID, value) {
-    return {
-        name: name,
-        source: source,
-        ruleID: ruleID !== null && ruleID !== void 0 ? ruleID : DEFAULT_RULE,
-        value: value === true,
-    };
-}
-exports.makeFeatureGate = makeFeatureGate;
-function makeDynamicConfig(name, source, ruleID, value) {
-    return {
-        name: name,
-        source: source,
-        ruleID: ruleID !== null && ruleID !== void 0 ? ruleID : DEFAULT_RULE,
-        value: value !== null && value !== void 0 ? value : {},
-    };
-}
-exports.makeDynamicConfig = makeDynamicConfig;
-function makeLayer(name, source, ruleID, getValue) {
-    return {
-        name: name,
-        source: source,
-        getValue: getValue !== null && getValue !== void 0 ? getValue : (function () { return undefined; }),
-        ruleID: ruleID !== null && ruleID !== void 0 ? ruleID : DEFAULT_RULE,
-    };
-}
-exports.makeLayer = makeLayer;

package/src/StatsigUser.d.ts

@@ -1,10 +1,6 @@
 import type { StatsigEnvironment } from './StatsigOptionsCommon';
 type StatsigUserPrimitives = string | number | boolean | Array<string> | undefined;
-export type StatsigUser = ({
-    userID: string;
-} | {
-    customIDs: Record<string, string>;
-}) & {
+export type StatsigUser = {
     userID?: string;
     customIDs?: Record<string, string>;
     email?: string;
@@ -21,4 +17,5 @@ export type StatsigUserInternal = StatsigUser & {
 };
 export declare function normalizeUser(original: StatsigUser, environment?: StatsigEnvironment): StatsigUser;
 export declare function getUserStorageKey(sdkKey: string, user?: StatsigUser): string;
+export declare function getUnitIDFromUser(user: StatsigUser, idType: string): string | undefined;
 export {};

package/src/StatsigUser.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUserStorageKey = exports.normalizeUser = void 0;
-var Hashing_1 = require("./Hashing");
+exports.getUnitIDFromUser = exports.getUserStorageKey = exports.normalizeUser = void 0;
+const Hashing_1 = require("./Hashing");
 function normalizeUser(original, environment) {
     try {
-        var copy = JSON.parse(JSON.stringify(original));
+        const copy = JSON.parse(JSON.stringify(original));
         if (environment != null) {
             copy.statsigEnvironment = environment;
         }
@@ -16,22 +16,14 @@ function normalizeUser(original, environment) {
 }
 exports.normalizeUser = normalizeUser;
 function getUserStorageKey(sdkKey, user) {
-    var key = (0, Hashing_1.DJB2)(JSON.stringify(_getSortedObject({ sdkKey: sdkKey, user: user })));
-    return "statsig.user_cache.".concat(key);
+    return (0, Hashing_1.DJB2Object)({ sdkKey, user });
 }
 exports.getUserStorageKey = getUserStorageKey;
-function _getSortedObject(object) {
-    if (object == null) {
-        return null;
+function getUnitIDFromUser(user, idType) {
+    var _a, _b, _c;
+    if (typeof idType === 'string' && idType.toLowerCase() !== 'userid') {
+        return (_b = (_a = user.customIDs) === null || _a === void 0 ? void 0 : _a[idType]) !== null && _b !== void 0 ? _b : (_c = user === null || user === void 0 ? void 0 : user.customIDs) === null || _c === void 0 ? void 0 : _c[idType.toLowerCase()];
     }
-    var keys = Object.keys(object).sort();
-    var sortedObject = {};
-    keys.forEach(function (key) {
-        var value = object[key];
-        if (value instanceof Object) {
-            value = _getSortedObject(value);
-        }
-        sortedObject[key] = value;
-    });
-    return sortedObject;
+    return user.userID;
 }
+exports.getUnitIDFromUser = getUnitIDFromUser;

package/src/StorageProvider.d.ts

@@ -1,11 +1,16 @@
 type StorageProvider = {
-    getItem: (key: string) => Promise<string | null>;
-    setItem: (key: string, value: string) => Promise<void>;
-    removeItem: (key: string) => Promise<void>;
+    _getProviderName: () => string;
+    _getItem: (key: string) => Promise<string | null>;
+    _setItem: (key: string, value: string) => Promise<void>;
+    _removeItem: (key: string) => Promise<void>;
+    _getAllKeys: () => Promise<readonly string[]>;
+    _getItemSync?: (key: string) => string | null;
 };
-export declare const Storage: StorageProvider & {
-    setProvider: (n: StorageProvider) => void;
+type StorageProviderManagment = {
+    _setProvider: (newProvider: StorageProvider) => void;
+    _setDisabled: (isDisabled: boolean) => void;
 };
-export declare function getObjectFromStorage<T>(key: string): Promise<T | null>;
-export declare function setObjectInStorage(key: string, obj: unknown): Promise<void>;
+export declare const Storage: StorageProvider & StorageProviderManagment;
+export declare function _getObjectFromStorage<T>(key: string): Promise<T | null>;
+export declare function _setObjectInStorage(key: string, obj: unknown): Promise<void>;
 export {};