@scaleway/use-growthbook 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scaleway/use-growthbook
 
+## 1.0.2
+
+### Patch Changes
+
+- [#1497](https://github.com/scaleway/scaleway-lib/pull/1497) [`252e3e1`](https://github.com/scaleway/scaleway-lib/commit/252e3e1f51f3f164ca2426e4888e6d4322b648a4) Thanks [@renovate](https://github.com/apps/renovate)! - Updated dependency `@growthbook/growthbook-react` to `0.18.0`.
+
+## 1.0.1
+
+### Patch Changes
+
+- [#1439](https://github.com/scaleway/scaleway-lib/pull/1439) [`eaad0f7`](https://github.com/scaleway/scaleway-lib/commit/eaad0f7195dac15e3b7b2b300b481e3fe7b543cf) Thanks [@philibea](https://github.com/philibea)! - add loadfeature configuration into the providers and moove return function from null to void
+
 ## 1.0.0
 
 ### Major Changes

package/dist/AbTestProvider.js

@@ -9,43 +9,40 @@ const getGrowthBookInstance = _ref => {
       clientKey,
       enableDevMode
     },
-    anonymousId,
+    attributes,
     trackingCallback
   } = _ref;
   return new GrowthBook({
     apiHost,
     clientKey,
     enableDevMode,
-    attributes: {
-      anonymousId,
-      userId: undefined,
-      organizationId: undefined,
-      organizationType: undefined
-    },
+    attributes,
     trackingCallback
   });
 };
+const defaultLoadConfig = {
+  autoRefresh: false,
+  timeout: 500
+};
 const AbTestProvider = _ref2 => {
   let {
     children,
     config,
-    anonymousId,
     trackingCallback,
-    errorCallback
+    errorCallback,
+    attributes,
+    loadConfig = defaultLoadConfig
   } = _ref2;
   const growthbook = useMemo(() => getGrowthBookInstance({
     config,
-    anonymousId,
+    attributes,
     trackingCallback
-  }), [trackingCallback, config, anonymousId]);
+  }), [trackingCallback, config, attributes]);
   const loadFeature = useCallback(async () => {
     if (config.clientKey) {
-      await growthbook.loadFeatures({
-        autoRefresh: false,
-        timeout: 500
-      });
+      await growthbook.loadFeatures(loadConfig);
     }
-  }, [growthbook, config]);
+  }, [growthbook, config, loadConfig]);
   useEffect(() => {
     loadFeature().catch(errorCallback);
   }, [loadFeature, errorCallback]);

package/dist/index.d.ts

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

package/dist/index.js

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

package/package.json

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