@scaleway/use-growthbook 1.0.2 → 1.0.4

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @scaleway/use-growthbook
 
+## 1.0.4
+
+### Patch Changes
+
+- [#1572](https://github.com/scaleway/scaleway-lib/pull/1572) [`57ddd1a`](https://github.com/scaleway/scaleway-lib/commit/57ddd1a39c048675f343c0da8735714f1cb5678a) Thanks [@philibea](https://github.com/philibea)! - when attributes a of provider change there is new instance of growthbook created and can make a desync during render
+
+- [#1566](https://github.com/scaleway/scaleway-lib/pull/1566) [`2223dc1`](https://github.com/scaleway/scaleway-lib/commit/2223dc1ec4993b57e4dbeb41f65a8659c63d548c) Thanks [@renovate](https://github.com/apps/renovate)! - Updated dependency `@growthbook/growthbook-react` to `0.19.0`.
+
+## 1.0.3
+
+### Patch Changes
+
+- [#1518](https://github.com/scaleway/scaleway-lib/pull/1518) [`ca2aa68`](https://github.com/scaleway/scaleway-lib/commit/ca2aa68fcde0470dde378b4322ff55e9caec170f) Thanks [@Slashgear](https://github.com/Slashgear)! - Export directly some usable type on provider init attributes
+
 ## 1.0.2
 
 ### Patch Changes

package/dist/AbTestProvider.js

@@ -2,28 +2,31 @@ import { GrowthBookProvider, GrowthBook } from '@growthbook/growthbook-react';
 import { useMemo, useCallback, useEffect } from 'react';
 import { jsx } from 'react/jsx-runtime';
 
+const defaultLoadConfig = {
+  autoRefresh: false,
+  timeout: 500,
+  skipCache: false
+};
 const getGrowthBookInstance = _ref => {
   let {
     config: {
       apiHost,
       clientKey,
-      enableDevMode
+      enableDevMode,
+      backgroundSync,
+      subscribeToChanges
     },
-    attributes,
     trackingCallback
   } = _ref;
   return new GrowthBook({
     apiHost,
     clientKey,
     enableDevMode,
-    attributes,
-    trackingCallback
+    trackingCallback,
+    backgroundSync,
+    subscribeToChanges
   });
 };
-const defaultLoadConfig = {
-  autoRefresh: false,
-  timeout: 500
-};
 const AbTestProvider = _ref2 => {
   let {
     children,
@@ -31,21 +34,29 @@ const AbTestProvider = _ref2 => {
     trackingCallback,
     errorCallback,
     attributes,
-    loadConfig = defaultLoadConfig
+    loadConfig
   } = _ref2;
   const growthbook = useMemo(() => getGrowthBookInstance({
     config,
-    attributes,
     trackingCallback
-  }), [trackingCallback, config, attributes]);
+  }), [trackingCallback, config]);
   const loadFeature = useCallback(async () => {
     if (config.clientKey) {
-      await growthbook.loadFeatures(loadConfig);
+      await growthbook.loadFeatures(loadConfig ?? defaultLoadConfig);
     }
   }, [growthbook, config, loadConfig]);
   useEffect(() => {
     loadFeature().catch(errorCallback);
   }, [loadFeature, errorCallback]);
+  useEffect(() => {
+    const currentAttributes = growthbook.getAttributes();
+    if (currentAttributes !== attributes) {
+      growthbook.setAttributes({
+        ...currentAttributes,
+        ...attributes
+      });
+    }
+  }, [attributes, growthbook]);
   return jsx(GrowthBookProvider, {
     growthbook: growthbook,
     children: children

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Context } from '@growthbook/growthbook-react';
-export { Context, FeatureString, FeaturesReady, IfFeatureEnabled, useExperiment, useFeature, useFeatureIsOn, useFeatureValue, withRunExperiment } from '@growthbook/growthbook-react';
+export { FeatureString, FeaturesReady, IfFeatureEnabled, useExperiment, useFeature, useFeatureIsOn, useFeatureValue, useGrowthBook, useGrowthBookSSR, withRunExperiment } from '@growthbook/growthbook-react';
 import * as react from 'react';
 import { ReactNode } from 'react';
 
@@ -7,28 +7,27 @@ type Attributes = Record<string, string | number | undefined>;
 /**
  * @param {boolean} [autoRefresh] - false.
  * @param {number} [timeout] - 500.
+ * @param {boolean} [skipCache] - false.
  */
 type LoadConfig = {
     autoRefresh: boolean;
     timeout: number;
+    skipCache: boolean;
 };
+type ToolConfig = Pick<Context, 'apiHost' | 'clientKey' | 'enableDevMode' | 'backgroundSync' | 'subscribeToChanges'>;
+type TrackingCallback = NonNullable<Context['trackingCallback']>;
+type ErrorCallback = (error: Error | string) => void | null;
 
 declare const useAbTestAttributes: () => [Attributes, (attributes: Attributes) => void];
 
-type ToolConfig = {
-    apiHost: string;
-    clientKey: string;
-    enableDevMode: boolean;
-};
-type TrackingCallback = NonNullable<Context['trackingCallback']>;
 type AbTestProviderProps = {
     children: ReactNode;
     config: ToolConfig;
     trackingCallback: TrackingCallback;
-    errorCallback: (error: Error | string) => void;
+    errorCallback: ErrorCallback;
     attributes: Attributes;
     loadConfig?: LoadConfig;
 };
 declare const AbTestProvider: ({ children, config, trackingCallback, errorCallback, attributes, loadConfig, }: AbTestProviderProps) => react.JSX.Element;
 
-export { AbTestProvider, useAbTestAttributes };
+export { AbTestProvider, type ErrorCallback, type ToolConfig, type TrackingCallback, useAbTestAttributes };

package/dist/index.js

@@ -1,3 +1,3 @@
-export { useExperiment, useFeature, useFeatureIsOn, useFeatureValue, withRunExperiment } from '@growthbook/growthbook-react';
+export { FeatureString, FeaturesReady, IfFeatureEnabled, useExperiment, useFeature, useFeatureIsOn, useFeatureValue, useGrowthBook, useGrowthBookSSR, withRunExperiment } from '@growthbook/growthbook-react';
 export { useAbTestAttributes } from './useAbTestAttributes.js';
 export { AbTestProvider } from './AbTestProvider.js';

package/dist/useAbTestAttributes.js

@@ -1,14 +1,16 @@
 import { useGrowthBook } from '@growthbook/growthbook-react';
-import { useMemo, useCallback } from 'react';
 
 const useAbTestAttributes = () => {
   const growthBook = useGrowthBook();
-  const attributes = useMemo(() => growthBook?.getAttributes() ?? {}, [growthBook]);
-  const setAttributes = useCallback(newAttributes => growthBook?.setAttributes({
-    ...attributes,
-    ...newAttributes
-  }), [growthBook, attributes]);
-  return [attributes, setAttributes];
+  if (growthBook) {
+    const attributes = growthBook.getAttributes();
+    const setAttributes = newAttributes => growthBook.setAttributes({
+      ...attributes,
+      ...newAttributes
+    });
+    return [attributes, setAttributes];
+  }
+  return [{}, () => {}];
 };
 
 export { useAbTestAttributes };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/use-growthbook",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Utility package to expose AB test tool",
   "type": "module",
   "engines": {
@@ -25,7 +25,7 @@
     "feature flags"
   ],
   "dependencies": {
-    "@growthbook/growthbook-react": "0.18.0"
+    "@growthbook/growthbook-react": "0.19.0"
   },
   "devDependencies": {
     "react": "18.2.0"