@statsig/react-bindings 0.0.1-beta.2 → 0.0.1-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/react-bindings",
-  "version": "0.0.1-beta.2",
+  "version": "0.0.1-beta.3",
   "dependencies": {
     "@statsig/client-core": "*"
   },

package/src/OnDeviceVsPrecomputedUtils.d.ts

@@ -1,3 +1,5 @@
 import { OnDeviceEvaluationsInterface, PrecomputedEvaluationsInterface } from '@statsig/client-core';
-export declare function isPrecomputedEvaluationsClient(client: OnDeviceEvaluationsInterface | PrecomputedEvaluationsInterface): client is PrecomputedEvaluationsInterface;
+export declare function isPrecomputedEvaluationsClient(client: OnDeviceEvaluationsInterface | PrecomputedEvaluationsInterface | {
+    isNoop: true;
+}): client is PrecomputedEvaluationsInterface;
 export declare function logMissingStatsigUserWarning(): void;

package/src/OnDeviceVsPrecomputedUtils.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.logMissingStatsigUserWarning = exports.isPrecomputedEvaluationsClient = void 0;
 var client_core_1 = require("@statsig/client-core");
 function isPrecomputedEvaluationsClient(client) {
+    if ('isNoop' in client) {
+        return false;
+    }
     return 'updateUser' in client;
 }
 exports.isPrecomputedEvaluationsClient = isPrecomputedEvaluationsClient;

package/src/StatsigContext.d.ts

@@ -1,8 +1,7 @@
-import { OnDeviceEvaluationsInterface, PrecomputedEvaluationsInterface } from '@statsig/client-core';
+import { StatsigClientInterface } from '@statsig/client-core';
 export interface StatsigContext {
     readonly renderVersion: number;
-    readonly precomputedClient: PrecomputedEvaluationsInterface;
-    readonly onDeviceClient: OnDeviceEvaluationsInterface;
+    readonly client: StatsigClientInterface;
 }
 declare const _default: import("react").Context<StatsigContext>;
 export default _default;

package/src/StatsigContext.js

@@ -3,6 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var react_1 = require("react");
 exports.default = (0, react_1.createContext)({
     renderVersion: 0,
-    precomputedClient: {},
-    onDeviceClient: {},
+    client: {},
 });

package/src/StatsigProvider.d.ts

@@ -1,12 +1,8 @@
 import { ReactNode } from 'react';
-import { OnDeviceEvaluationsInterface, PrecomputedEvaluationsInterface } from '@statsig/client-core';
+import { StatsigClientInterface } from '@statsig/client-core';
 type Props = {
     children: ReactNode | ReactNode[];
-} & ({
-    client: OnDeviceEvaluationsInterface | PrecomputedEvaluationsInterface;
-} | {
-    precomputedClient: PrecomputedEvaluationsInterface;
-    onDeviceClient: OnDeviceEvaluationsInterface;
-});
+    client: StatsigClientInterface;
+};
 export default function StatsigProvider(props: Props): JSX.Element;
 export {};

package/src/StatsigProvider.js

@@ -3,53 +3,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = require("react");
 var client_core_1 = require("@statsig/client-core");
-var NoopEvaluationsClient_1 = require("./NoopEvaluationsClient");
-var OnDeviceVsPrecomputedUtils_1 = require("./OnDeviceVsPrecomputedUtils");
 var StatsigContext_1 = require("./StatsigContext");
 function StatsigProvider(props) {
-    var precomputedClient;
-    var onDeviceClient;
-    if ('client' in props) {
-        precomputedClient = (0, OnDeviceVsPrecomputedUtils_1.isPrecomputedEvaluationsClient)(props.client)
-            ? props.client
-            : NoopEvaluationsClient_1.NoopEvaluationsClient;
-        onDeviceClient = !(0, OnDeviceVsPrecomputedUtils_1.isPrecomputedEvaluationsClient)(props.client)
-            ? props.client
-            : NoopEvaluationsClient_1.NoopEvaluationsClient;
-    }
-    else {
-        precomputedClient = props.precomputedClient;
-        onDeviceClient = props.onDeviceClient;
-    }
     var _a = (0, react_1.useState)(0), renderVersion = _a[0], setRenderVersion = _a[1];
-    var clients = [precomputedClient, onDeviceClient];
+    var client = props.client, children = props.children;
     (0, react_1.useEffect)(function () {
         var onStatusChange = function (data) {
             if (data.event === 'status_change') {
                 setRenderVersion(function (v) { return v + 1; });
             }
         };
-        clients.forEach(function (client) {
-            client.on('status_change', onStatusChange);
-            client.initialize().catch(function (error) {
-                client_core_1.Log.error('An error occurred during initialization', error);
-            });
+        client.on('status_change', onStatusChange);
+        client.initialize().catch(function (error) {
+            client_core_1.Log.error('An error occurred during initialization', error);
         });
         return function () {
-            clients.forEach(function (client) {
-                client.shutdown().catch(function (error) {
-                    client_core_1.Log.error('An error occured during shutdown', error);
-                });
-                client.off('status_change', onStatusChange);
+            client.shutdown().catch(function (error) {
+                client_core_1.Log.error('An error occured during shutdown', error);
             });
+            client.off('status_change', onStatusChange);
         };
-    }, clients);
-    return ((0, jsx_runtime_1.jsx)(StatsigContext_1.default.Provider, { value: { renderVersion: renderVersion, onDeviceClient: onDeviceClient, precomputedClient: precomputedClient }, children: shouldRender(precomputedClient) && shouldRender(onDeviceClient)
-            ? props.children
-            : null }));
+    }, [client]);
+    return ((0, jsx_runtime_1.jsx)(StatsigContext_1.default.Provider, { value: { renderVersion: renderVersion, client: client }, children: _shouldRender(client) ? children : null }));
 }
 exports.default = StatsigProvider;
-function shouldRender(client) {
+function _shouldRender(client) {
     if ('isNoop' in client) {
         return true;
     }

package/src/index.d.ts

@@ -4,4 +4,7 @@ import useDynamicConfig from './useDynamicConfig';
 import useExperiment from './useExperiment';
 import useGate from './useGate';
 import useLayer from './useLayer';
-export { StatsigContext, StatsigProvider, useGate, useDynamicConfig, useExperiment, useLayer, };
+import useStatsigOnDeviceEvaluationsClient from './useStatsigOnDeviceEvaluationsClient';
+import useStatsigPrecomputedEvaluationsClient from './useStatsigPrecomputedEvaluationsClient';
+import useStatsigUser from './useStatsigUser';
+export { StatsigContext, StatsigProvider, useGate, useDynamicConfig, useExperiment, useLayer, useStatsigUser, useStatsigOnDeviceEvaluationsClient, useStatsigPrecomputedEvaluationsClient, };

package/src/index.js

@@ -11,7 +11,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useLayer = exports.useExperiment = exports.useDynamicConfig = exports.useGate = exports.StatsigProvider = exports.StatsigContext = void 0;
+exports.useStatsigPrecomputedEvaluationsClient = exports.useStatsigOnDeviceEvaluationsClient = exports.useStatsigUser = exports.useLayer = exports.useExperiment = exports.useDynamicConfig = exports.useGate = exports.StatsigProvider = exports.StatsigContext = void 0;
 var StatsigContext_1 = require("./StatsigContext");
 exports.StatsigContext = StatsigContext_1.default;
 var StatsigProvider_1 = require("./StatsigProvider");
@@ -24,4 +24,10 @@ var useGate_1 = require("./useGate");
 exports.useGate = useGate_1.default;
 var useLayer_1 = require("./useLayer");
 exports.useLayer = useLayer_1.default;
-__STATSIG__ = __assign(__assign({}, __STATSIG__), { StatsigContext: StatsigContext_1.default, StatsigProvider: StatsigProvider_1.default, useGate: useGate_1.default, useDynamicConfig: useDynamicConfig_1.default, useExperiment: useExperiment_1.default, useLayer: useLayer_1.default });
+var useStatsigOnDeviceEvaluationsClient_1 = require("./useStatsigOnDeviceEvaluationsClient");
+exports.useStatsigOnDeviceEvaluationsClient = useStatsigOnDeviceEvaluationsClient_1.default;
+var useStatsigPrecomputedEvaluationsClient_1 = require("./useStatsigPrecomputedEvaluationsClient");
+exports.useStatsigPrecomputedEvaluationsClient = useStatsigPrecomputedEvaluationsClient_1.default;
+var useStatsigUser_1 = require("./useStatsigUser");
+exports.useStatsigUser = useStatsigUser_1.default;
+__STATSIG__ = __assign(__assign({}, __STATSIG__), { StatsigContext: StatsigContext_1.default, StatsigProvider: StatsigProvider_1.default, useGate: useGate_1.default, useDynamicConfig: useDynamicConfig_1.default, useExperiment: useExperiment_1.default, useLayer: useLayer_1.default, useStatsigOnDeviceEvaluationsClient: useStatsigOnDeviceEvaluationsClient_1.default, useStatsigPrecomputedEvaluationsClient: useStatsigPrecomputedEvaluationsClient_1.default });

package/src/useConfigImpl.d.ts

@@ -0,0 +1,5 @@
+import { DynamicConfig, EvaluationOptions, StatsigUser } from '@statsig/client-core';
+export type UseConfigOptions = EvaluationOptions & {
+    user: StatsigUser | null;
+};
+export declare function useConfigImpl(hook: 'useExperiment' | 'useDynamicConfig', configName: string, options?: UseConfigOptions): DynamicConfig;

package/src/useConfigImpl.js

@@ -0,0 +1,36 @@
+"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.useConfigImpl = void 0;
+var react_1 = require("react");
+var client_core_1 = require("@statsig/client-core");
+var NoopEvaluationsClient_1 = require("./NoopEvaluationsClient");
+var OnDeviceVsPrecomputedUtils_1 = require("./OnDeviceVsPrecomputedUtils");
+var StatsigContext_1 = require("./StatsigContext");
+function useConfigImpl(hook, configName, options) {
+    if (options === void 0) { options = __assign(__assign({}, client_core_1.DEFAULT_EVAL_OPTIONS), { user: null }); }
+    var client = (0, react_1.useContext)(StatsigContext_1.default).client;
+    var config = (0, react_1.useMemo)(function () {
+        if ((0, OnDeviceVsPrecomputedUtils_1.isPrecomputedEvaluationsClient)(client)) {
+            return client.getDynamicConfig(configName, options);
+        }
+        if (options.user != null) {
+            return client.getDynamicConfig(configName, options.user, options);
+        }
+        var type = hook === 'useDynamicConfig' ? 'dynamic config' : 'experiment';
+        client_core_1.Log.warn("".concat(hook, " hook failed to find a valid Statsig client for ").concat(type, " '").concat(configName, "'."));
+        return NoopEvaluationsClient_1.NoopEvaluationsClient.getDynamicConfig(configName, options);
+    }, [client.loadingStatus, options]);
+    return config;
+}
+exports.useConfigImpl = useConfigImpl;

package/src/useDynamicConfig.d.ts

@@ -1,5 +1,4 @@
-import { DynamicConfig, EvaluationOptions, StatsigUser } from '@statsig/client-core';
-export type UseDynamicConfigOptions = EvaluationOptions & {
-    user: StatsigUser | null;
-};
+import { DynamicConfig } from '@statsig/client-core';
+import { UseConfigOptions } from './useConfigImpl';
+export type UseDynamicConfigOptions = UseConfigOptions;
 export default function (configName: string, options?: UseDynamicConfigOptions): DynamicConfig;

package/src/useDynamicConfig.js

@@ -11,18 +11,10 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = require("react");
 var client_core_1 = require("@statsig/client-core");
-var StatsigContext_1 = require("./StatsigContext");
+var useConfigImpl_1 = require("./useConfigImpl");
 function default_1(configName, options) {
     if (options === void 0) { options = __assign(__assign({}, client_core_1.DEFAULT_EVAL_OPTIONS), { user: null }); }
-    var _a = (0, react_1.useContext)(StatsigContext_1.default), precomputedClient = _a.precomputedClient, onDeviceClient = _a.onDeviceClient;
-    var config = (0, react_1.useMemo)(function () {
-        if (options.user == null) {
-            return precomputedClient.getDynamicConfig(configName, options);
-        }
-        return onDeviceClient.getDynamicConfig(configName, options.user, options);
-    }, [precomputedClient.loadingStatus, onDeviceClient.loadingStatus, options]);
-    return config;
+    return (0, useConfigImpl_1.useConfigImpl)('useDynamicConfig', configName, options);
 }
 exports.default = default_1;

package/src/useExperiment.d.ts

@@ -1,4 +1,4 @@
 import { Experiment } from '@statsig/client-core';
-import { UseDynamicConfigOptions } from './useDynamicConfig';
-export type UseExperimentOptions = UseDynamicConfigOptions;
+import { UseConfigOptions } from './useConfigImpl';
+export type UseExperimentOptions = UseConfigOptions;
 export default function (experimentName: string, options?: UseExperimentOptions): Experiment;

package/src/useExperiment.js

@@ -12,10 +12,9 @@ var __assign = (this && this.__assign) || function () {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var client_core_1 = require("@statsig/client-core");
-var useDynamicConfig_1 = require("./useDynamicConfig");
+var useConfigImpl_1 = require("./useConfigImpl");
 function default_1(experimentName, options) {
     if (options === void 0) { options = __assign(__assign({}, client_core_1.DEFAULT_EVAL_OPTIONS), { user: null }); }
-    var config = (0, useDynamicConfig_1.default)(experimentName, options);
-    return config;
+    return (0, useConfigImpl_1.useConfigImpl)('useExperiment', experimentName, options);
 }
 exports.default = default_1;

package/src/useGate.js

@@ -13,16 +13,22 @@ var __assign = (this && this.__assign) || function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 var react_1 = require("react");
 var client_core_1 = require("@statsig/client-core");
+var NoopEvaluationsClient_1 = require("./NoopEvaluationsClient");
+var OnDeviceVsPrecomputedUtils_1 = require("./OnDeviceVsPrecomputedUtils");
 var StatsigContext_1 = require("./StatsigContext");
 function default_1(gateName, options) {
     if (options === void 0) { options = __assign(__assign({}, client_core_1.DEFAULT_EVAL_OPTIONS), { user: null }); }
-    var _a = (0, react_1.useContext)(StatsigContext_1.default), precomputedClient = _a.precomputedClient, onDeviceClient = _a.onDeviceClient;
+    var client = (0, react_1.useContext)(StatsigContext_1.default).client;
     var gate = (0, react_1.useMemo)(function () {
-        if (options.user == null) {
-            return precomputedClient.getFeatureGate(gateName, options);
+        if ((0, OnDeviceVsPrecomputedUtils_1.isPrecomputedEvaluationsClient)(client)) {
+            return client.getFeatureGate(gateName, options);
         }
-        return onDeviceClient.getFeatureGate(gateName, options.user, options);
-    }, [precomputedClient.loadingStatus, onDeviceClient.loadingStatus, options]);
+        if (options.user != null) {
+            return client.getFeatureGate(gateName, options.user, options);
+        }
+        client_core_1.Log.warn("useGate hook failed to find a valid Statsig client for gate '".concat(gateName, "'."));
+        return NoopEvaluationsClient_1.NoopEvaluationsClient.getFeatureGate(gateName, options);
+    }, [client.loadingStatus, options]);
     return gate;
 }
 exports.default = default_1;

package/src/useLayer.js

@@ -13,16 +13,22 @@ var __assign = (this && this.__assign) || function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 var react_1 = require("react");
 var client_core_1 = require("@statsig/client-core");
+var NoopEvaluationsClient_1 = require("./NoopEvaluationsClient");
+var OnDeviceVsPrecomputedUtils_1 = require("./OnDeviceVsPrecomputedUtils");
 var StatsigContext_1 = require("./StatsigContext");
 function default_1(layerName, options) {
     if (options === void 0) { options = __assign(__assign({}, client_core_1.DEFAULT_EVAL_OPTIONS), { user: null }); }
-    var _a = (0, react_1.useContext)(StatsigContext_1.default), precomputedClient = _a.precomputedClient, onDeviceClient = _a.onDeviceClient;
+    var client = (0, react_1.useContext)(StatsigContext_1.default).client;
     var layer = (0, react_1.useMemo)(function () {
-        if (options.user == null) {
-            return precomputedClient.getLayer(layerName, options);
+        if ((0, OnDeviceVsPrecomputedUtils_1.isPrecomputedEvaluationsClient)(client)) {
+            return client.getLayer(layerName, options);
         }
-        return onDeviceClient.getLayer(layerName, options.user, options);
-    }, [precomputedClient.loadingStatus, onDeviceClient.loadingStatus, options]);
+        if (options.user != null) {
+            return client.getLayer(layerName, options.user, options);
+        }
+        client_core_1.Log.warn("useLayer hook failed to find a valid Statsig client for layer '".concat(layerName, "'."));
+        return NoopEvaluationsClient_1.NoopEvaluationsClient.getLayer(layerName, options);
+    }, [client.loadingStatus, options]);
     return layer;
 }
 exports.default = default_1;

package/src/useStatsigOnDeviceEvaluationsClient.d.ts

@@ -0,0 +1,2 @@
+import { OnDeviceEvaluationsInterface } from '@statsig/client-core';
+export default function (): OnDeviceEvaluationsInterface;

package/src/useStatsigOnDeviceEvaluationsClient.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var react_1 = require("react");
+var client_core_1 = require("@statsig/client-core");
+var NoopEvaluationsClient_1 = require("./NoopEvaluationsClient");
+var OnDeviceVsPrecomputedUtils_1 = require("./OnDeviceVsPrecomputedUtils");
+var StatsigContext_1 = require("./StatsigContext");
+function default_1() {
+    var client = (0, react_1.useContext)(StatsigContext_1.default).client;
+    if (!(0, OnDeviceVsPrecomputedUtils_1.isPrecomputedEvaluationsClient)(client)) {
+        return client;
+    }
+    client_core_1.Log.warn('Attempting to retrive a Statsig OnDeviceEvaluationsClient but none was set.');
+    return NoopEvaluationsClient_1.NoopEvaluationsClient;
+}
+exports.default = default_1;

package/src/useStatsigPrecomputedEvaluationsClient.d.ts

@@ -0,0 +1,2 @@
+import { PrecomputedEvaluationsInterface } from '@statsig/client-core';
+export default function (): PrecomputedEvaluationsInterface;

package/src/useStatsigPrecomputedEvaluationsClient.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var react_1 = require("react");
+var client_core_1 = require("@statsig/client-core");
+var NoopEvaluationsClient_1 = require("./NoopEvaluationsClient");
+var OnDeviceVsPrecomputedUtils_1 = require("./OnDeviceVsPrecomputedUtils");
+var StatsigContext_1 = require("./StatsigContext");
+function default_1() {
+    var client = (0, react_1.useContext)(StatsigContext_1.default).client;
+    if ((0, OnDeviceVsPrecomputedUtils_1.isPrecomputedEvaluationsClient)(client)) {
+        return client;
+    }
+    client_core_1.Log.warn('Attempting to retrive a Statsig PrecomputedEvaluationsClient but none was set.');
+    return NoopEvaluationsClient_1.NoopEvaluationsClient;
+}
+exports.default = default_1;

package/src/useStatsigUser.d.ts

@@ -0,0 +1,6 @@
+import { StatsigUser } from '@statsig/client-core';
+export type UseStatsigUserResult = {
+    user: StatsigUser;
+    updateUser: (fn: (prevState: StatsigUser) => StatsigUser) => Promise<void>;
+};
+export default function (): UseStatsigUserResult;

package/src/useStatsigUser.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var useStatsigPrecomputedEvaluationsClient_1 = require("./useStatsigPrecomputedEvaluationsClient");
+function default_1() {
+    var client = (0, useStatsigPrecomputedEvaluationsClient_1.default)();
+    return {
+        user: client.getCurrentUser(),
+        updateUser: function (fn) {
+            var user = fn(client.getCurrentUser());
+            return client.updateUser(user);
+        },
+    };
+}
+exports.default = default_1;

package/src/useStatsigClient.d.ts

@@ -1,5 +0,0 @@
-import { OnDeviceEvaluationsInterface, PrecomputedEvaluationsInterface } from '@statsig/client-core';
-export default function (): {
-    precomputedClient: PrecomputedEvaluationsInterface;
-    onDeviceClient: OnDeviceEvaluationsInterface;
-};

package/src/useStatsigClient.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = require("react");
-var StatsigContext_1 = require("./StatsigContext");
-function default_1() {
-    return (0, react_1.useContext)(StatsigContext_1.default);
-}
-exports.default = default_1;