@scaleway/use-growthbook 2.1.16 → 3.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Scaleway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/AbTestProvider.d.ts

@@ -1,12 +1,15 @@
-import type { ComponentType, ReactNode } from 'react';
-import type { Attributes, ErrorCallback, LoadConfig, ToolConfig, TrackingCallback } from './types';
+import { Attributes, ErrorCallback, LoadConfig, ToolConfig, TrackingCallback } from "./types.js";
+import { ComponentType, ReactNode } from "react";
+
+//#region src/AbTestProvider.d.ts
 type AbTestProviderProps = {
-    children: ReactNode;
-    config: ToolConfig;
-    trackingCallback: TrackingCallback;
-    errorCallback: ErrorCallback;
-    attributes: Attributes;
-    loadConfig?: LoadConfig;
+  children: ReactNode;
+  config: ToolConfig;
+  trackingCallback: TrackingCallback;
+  errorCallback: ErrorCallback;
+  attributes: Attributes;
+  loadConfig?: LoadConfig;
 };
-export declare const AbTestProvider: ComponentType<AbTestProviderProps>;
-export {};
+declare const AbTestProvider: ComponentType<AbTestProviderProps>;
+//#endregion
+export { AbTestProvider };

package/dist/AbTestProvider.js

@@ -2,17 +2,17 @@ import { GrowthBook, GrowthBookProvider } from "@growthbook/growthbook-react";
 import { useCallback, useEffect, useMemo } from "react";
 import { jsx } from "react/jsx-runtime";
 //#region src/AbTestProvider.tsx
-var defaultLoadConfig = {
+const defaultLoadConfig = {
 	skipCache: false,
 	timeout: 500
 };
-var getGrowthBookInstance = ({ config: { apiHost, clientKey, enableDevMode }, trackingCallback }) => new GrowthBook({
+const getGrowthBookInstance = ({ config: { apiHost, clientKey, enableDevMode }, trackingCallback }) => new GrowthBook({
 	apiHost,
 	clientKey,
 	enableDevMode,
 	trackingCallback
 });
-var AbTestProvider = ({ children, config, trackingCallback, errorCallback, attributes, loadConfig }) => {
+const AbTestProvider = ({ children, config, trackingCallback, errorCallback, attributes, loadConfig }) => {
 	const growthbook = useMemo(() => getGrowthBookInstance({
 		config,
 		trackingCallback

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export { FeatureString, FeaturesReady, IfFeatureEnabled, useExperiment, useFeature, useFeatureIsOn, useFeatureValue, useGrowthBook, withRunExperiment, } from '@growthbook/growthbook-react';
-export { AbTestProvider } from './AbTestProvider';
-export type { ErrorCallback, ToolConfig, TrackingCallback } from './types';
-export { useAbTestAttributes } from './useAbTestAttributes';
+import { ErrorCallback, ToolConfig, TrackingCallback } from "./types.js";
+import { AbTestProvider } from "./AbTestProvider.js";
+import { useAbTestAttributes } from "./useAbTestAttributes.js";
+import { FeatureString, FeaturesReady, IfFeatureEnabled, useExperiment, useFeature, useFeatureIsOn, useFeatureValue, useGrowthBook, withRunExperiment } from "@growthbook/growthbook-react";
+export { AbTestProvider, type ErrorCallback, FeatureString, FeaturesReady, IfFeatureEnabled, type ToolConfig, type TrackingCallback, useAbTestAttributes, useExperiment, useFeature, useFeatureIsOn, useFeatureValue, useGrowthBook, withRunExperiment };

package/dist/types.d.ts

@@ -1,11 +1,15 @@
-import type { Context, GrowthBook } from '@growthbook/growthbook-react';
-export type Attributes = Record<string, string | number | undefined>;
+import { Context, GrowthBook } from "@growthbook/growthbook-react";
+
+//#region src/types.d.ts
+type Attributes = Record<string, string | number | undefined>;
 /**
  * @param {boolean} [autoRefresh] - false.
  * @param {number} [timeout] - 500.
  * @param {boolean} [skipCache] - false.
  */
-export type LoadConfig = NonNullable<Parameters<GrowthBook['init']>[0]>;
-export type ToolConfig = Pick<Context, 'apiHost' | 'clientKey' | 'enableDevMode' | 'debug' | 'stickyBucketService'>;
-export type TrackingCallback = NonNullable<Context['trackingCallback']>;
-export type ErrorCallback = ((error: Error | string) => void) | null;
+type LoadConfig = NonNullable<Parameters<GrowthBook['init']>[0]>;
+type ToolConfig = Pick<Context, 'apiHost' | 'clientKey' | 'enableDevMode' | 'debug' | 'stickyBucketService'>;
+type TrackingCallback = NonNullable<Context['trackingCallback']>;
+type ErrorCallback = ((error: Error | string) => void) | null;
+//#endregion
+export { Attributes, ErrorCallback, LoadConfig, ToolConfig, TrackingCallback };

package/dist/useAbTestAttributes.d.ts

@@ -1,2 +1,6 @@
-import type { Attributes } from './types';
-export declare const useAbTestAttributes: () => [Attributes, (attributes: Attributes) => void];
+import { Attributes } from "./types.js";
+
+//#region src/useAbTestAttributes.d.ts
+declare const useAbTestAttributes: () => [Attributes, (attributes: Attributes) => void];
+//#endregion
+export { useAbTestAttributes };

package/dist/useAbTestAttributes.js

@@ -1,6 +1,6 @@
 import { useGrowthBook } from "@growthbook/growthbook-react";
 //#region src/useAbTestAttributes.ts
-var useAbTestAttributes = () => {
+const useAbTestAttributes = () => {
 	const growthBook = useGrowthBook();
 	const attributes = growthBook.getAttributes();
 	const setAttributes = async (newAttributes) => growthBook.setAttributes({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/use-growthbook",
-  "version": "2.1.16",
+  "version": "3.0.0",
   "description": "Utility package to expose AB test tool",
   "keywords": [
     "ab",
@@ -9,7 +9,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/scaleway/scaleway-lib",
+    "url": "git+https://github.com/scaleway/scaleway-lib.git",
     "directory": "packages/growthbook"
   },
   "files": [
@@ -17,15 +17,10 @@
   ],
   "type": "module",
   "sideEffects": false,
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.cjs",
-      "default": "./dist/index.js"
-    }
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
   },
   "publishConfig": {
     "access": "public"
@@ -43,12 +38,9 @@
     "node": ">=20.x"
   },
   "scripts": {
-    "prebuild": "shx rm -rf dist",
     "typecheck": "tsgo --noEmit",
-    "type:generate": "tsgo --declaration -p tsconfig.build.json",
-    "build": "vite build --config vite.config.ts && pnpm run type:generate",
-    "build:profile": "npx vite-bundle-visualizer -c vite.config.ts",
-    "test:unit": "vitest --run --config vite.config.ts",
+    "build": "tsdown",
+    "test:unit": "vitest --run",
     "test:unit:coverage": "pnpm test:unit --coverage"
   }
 }

package/dist/.vite/license.md

@@ -1,3 +0,0 @@
-# Licenses
-
-The app does not bundle any dependencies with licenses.

package/dist/AbTestProvider.cjs

@@ -1,59 +0,0 @@
-let _growthbook_growthbook_react = require("@growthbook/growthbook-react");
-let react = require("react");
-let react_jsx_runtime = require("react/jsx-runtime");
-//#region src/AbTestProvider.tsx
-var defaultLoadConfig = {
-	skipCache: false,
-	timeout: 500
-};
-var getGrowthBookInstance = ({ config: { apiHost, clientKey, enableDevMode }, trackingCallback }) => new _growthbook_growthbook_react.GrowthBook({
-	apiHost,
-	clientKey,
-	enableDevMode,
-	trackingCallback
-});
-var AbTestProvider = ({ children, config, trackingCallback, errorCallback, attributes, loadConfig }) => {
-	const growthbook = (0, react.useMemo)(() => getGrowthBookInstance({
-		config,
-		trackingCallback
-	}), [trackingCallback, config]);
-	const loadFeature = (0, react.useCallback)(async () => {
-		if (config.clientKey) {
-			const initConfig = {
-				...defaultLoadConfig,
-				...loadConfig
-			};
-			await growthbook.init(initConfig);
-		}
-	}, [
-		growthbook,
-		config,
-		loadConfig
-	]);
-	(0, react.useEffect)(() => {
-		loadFeature().catch((error) => {
-			if (errorCallback && error instanceof Error) errorCallback(error);
-			return null;
-		});
-	}, [loadFeature, errorCallback]);
-	(0, react.useEffect)(() => {
-		const currentAttributes = growthbook.getAttributes();
-		if (currentAttributes !== attributes) growthbook.setAttributes({
-			...currentAttributes,
-			...attributes
-		}).catch((error) => {
-			if (errorCallback && error instanceof Error) errorCallback(error);
-			return null;
-		});
-	}, [
-		attributes,
-		growthbook,
-		errorCallback
-	]);
-	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(_growthbook_growthbook_react.GrowthBookProvider, {
-		growthbook,
-		children
-	});
-};
-//#endregion
-exports.AbTestProvider = AbTestProvider;

package/dist/index.cjs

@@ -1,60 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_AbTestProvider = require("./AbTestProvider.cjs");
-const require_useAbTestAttributes = require("./useAbTestAttributes.cjs");
-let _growthbook_growthbook_react = require("@growthbook/growthbook-react");
-exports.AbTestProvider = require_AbTestProvider.AbTestProvider;
-Object.defineProperty(exports, "FeatureString", {
-	enumerable: true,
-	get: function() {
-		return _growthbook_growthbook_react.FeatureString;
-	}
-});
-Object.defineProperty(exports, "FeaturesReady", {
-	enumerable: true,
-	get: function() {
-		return _growthbook_growthbook_react.FeaturesReady;
-	}
-});
-Object.defineProperty(exports, "IfFeatureEnabled", {
-	enumerable: true,
-	get: function() {
-		return _growthbook_growthbook_react.IfFeatureEnabled;
-	}
-});
-exports.useAbTestAttributes = require_useAbTestAttributes.useAbTestAttributes;
-Object.defineProperty(exports, "useExperiment", {
-	enumerable: true,
-	get: function() {
-		return _growthbook_growthbook_react.useExperiment;
-	}
-});
-Object.defineProperty(exports, "useFeature", {
-	enumerable: true,
-	get: function() {
-		return _growthbook_growthbook_react.useFeature;
-	}
-});
-Object.defineProperty(exports, "useFeatureIsOn", {
-	enumerable: true,
-	get: function() {
-		return _growthbook_growthbook_react.useFeatureIsOn;
-	}
-});
-Object.defineProperty(exports, "useFeatureValue", {
-	enumerable: true,
-	get: function() {
-		return _growthbook_growthbook_react.useFeatureValue;
-	}
-});
-Object.defineProperty(exports, "useGrowthBook", {
-	enumerable: true,
-	get: function() {
-		return _growthbook_growthbook_react.useGrowthBook;
-	}
-});
-Object.defineProperty(exports, "withRunExperiment", {
-	enumerable: true,
-	get: function() {
-		return _growthbook_growthbook_react.withRunExperiment;
-	}
-});

package/dist/useAbTestAttributes.cjs

@@ -1,13 +0,0 @@
-let _growthbook_growthbook_react = require("@growthbook/growthbook-react");
-//#region src/useAbTestAttributes.ts
-var useAbTestAttributes = () => {
-	const growthBook = (0, _growthbook_growthbook_react.useGrowthBook)();
-	const attributes = growthBook.getAttributes();
-	const setAttributes = async (newAttributes) => growthBook.setAttributes({
-		...attributes,
-		...newAttributes
-	});
-	return [attributes, setAttributes];
-};
-//#endregion
-exports.useAbTestAttributes = useAbTestAttributes;