@scaleway/use-growthbook 2.0.2 → 2.0.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scaleway/use-growthbook
 
+## 2.0.4
+
+### Patch Changes
+
+- [#1953](https://github.com/scaleway/scaleway-lib/pull/1953) [`1fddf05`](https://github.com/scaleway/scaleway-lib/commit/1fddf0515851908b094f983b05b3d87af8eef433) Thanks [@philibea](https://github.com/philibea)! - add cjs build
+
+## 2.0.3
+
+### Patch Changes
+
+- [#1943](https://github.com/scaleway/scaleway-lib/pull/1943) [`e726def`](https://github.com/scaleway/scaleway-lib/commit/e726def8e0cb4593f800f9acecca51b173ae907a) Thanks [@philibea](https://github.com/philibea)! - Migration from rollup to vite
+
 ## 2.0.2
 
 ### Patch Changes

package/__mocks__/@growthbook/growthbook-react.tsx

@@ -0,0 +1,21 @@
+import type { GrowthBook as GBType } from '@growthbook/growthbook-react'
+import type { ReactNode } from 'react'
+import { vi } from 'vitest'
+
+export const getAttributes = vi.fn<[], ReturnType<GBType['getAttributes']>>()
+export const setAttributes = vi.fn<[], ReturnType<GBType['setAttributes']>>(
+  () => Promise.resolve(),
+)
+
+export const GrowthBook = vi.fn(() => ({
+  loadFeatures: vi.fn<[], ReturnType<GBType['loadFeatures']>>(),
+  getAttributes,
+  setAttributes,
+}))
+export const GrowthBookProvider = ({ children }: { children: ReactNode }) =>
+  children
+
+export const useGrowthBook = vi.fn()
+
+console.debug('GrowthBook Mock', GrowthBookProvider)
+// export { GrowthBook, GrowthBookProvider, useGrowthBook }

package/dist/AbTestProvider.cjs

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const jsxRuntime = require("react/jsx-runtime");
+const growthbookReact = require("@growthbook/growthbook-react");
+const react = require("react");
+const defaultLoadConfig = {
+  autoRefresh: false,
+  timeout: 500,
+  skipCache: false
+};
+const getGrowthBookInstance = ({
+  config: {
+    apiHost,
+    clientKey,
+    enableDevMode,
+    backgroundSync,
+    subscribeToChanges
+  },
+  trackingCallback
+}) => new growthbookReact.GrowthBook({
+  apiHost,
+  clientKey,
+  enableDevMode,
+  trackingCallback,
+  backgroundSync,
+  subscribeToChanges
+});
+const AbTestProvider = ({
+  children,
+  config,
+  trackingCallback,
+  errorCallback,
+  attributes,
+  loadConfig
+}) => {
+  const growthbook = react.useMemo(
+    () => getGrowthBookInstance({ config, trackingCallback }),
+    [trackingCallback, config]
+  );
+  const loadFeature = react.useCallback(async () => {
+    if (config.clientKey) {
+      await growthbook.loadFeatures(loadConfig ?? defaultLoadConfig);
+    }
+  }, [growthbook, config, loadConfig]);
+  react.useEffect(() => {
+    loadFeature().catch(errorCallback);
+  }, [loadFeature, errorCallback]);
+  react.useEffect(() => {
+    const currentAttributes = growthbook.getAttributes();
+    if (currentAttributes !== attributes) {
+      growthbook.setAttributes({
+        ...currentAttributes,
+        ...attributes
+      }).catch(errorCallback);
+    }
+  }, [attributes, growthbook, errorCallback]);
+  return /* @__PURE__ */ jsxRuntime.jsx(growthbookReact.GrowthBookProvider, { growthbook, children });
+};
+exports.AbTestProvider = AbTestProvider;

package/dist/AbTestProvider.d.ts

@@ -0,0 +1,12 @@
+import { type ReactNode } from 'react';
+import type { Attributes, ErrorCallback, LoadConfig, ToolConfig, TrackingCallback } from './types';
+type AbTestProviderProps = {
+    children: ReactNode;
+    config: ToolConfig;
+    trackingCallback: TrackingCallback;
+    errorCallback: ErrorCallback;
+    attributes: Attributes;
+    loadConfig?: LoadConfig;
+};
+export declare const AbTestProvider: ({ children, config, trackingCallback, errorCallback, attributes, loadConfig, }: AbTestProviderProps) => import("react").JSX.Element;
+export {};

package/dist/AbTestProvider.js

@@ -1,7 +1,6 @@
-import { GrowthBookProvider, GrowthBook } from '@growthbook/growthbook-react';
-import { useMemo, useCallback, useEffect } from 'react';
-import { jsx } from 'react/jsx-runtime';
-
+import { jsx } from "react/jsx-runtime";
+import { GrowthBookProvider, GrowthBook } from "@growthbook/growthbook-react";
+import { useMemo, useCallback, useEffect } from "react";
 const defaultLoadConfig = {
   autoRefresh: false,
   timeout: 500,
@@ -32,10 +31,10 @@ const AbTestProvider = ({
   attributes,
   loadConfig
 }) => {
-  const growthbook = useMemo(() => getGrowthBookInstance({
-    config,
-    trackingCallback
-  }), [trackingCallback, config]);
+  const growthbook = useMemo(
+    () => getGrowthBookInstance({ config, trackingCallback }),
+    [trackingCallback, config]
+  );
   const loadFeature = useCallback(async () => {
     if (config.clientKey) {
       await growthbook.loadFeatures(loadConfig ?? defaultLoadConfig);
@@ -53,10 +52,8 @@ const AbTestProvider = ({
       }).catch(errorCallback);
     }
   }, [attributes, growthbook, errorCallback]);
-  return jsx(GrowthBookProvider, {
-    growthbook: growthbook,
-    children: children
-  });
+  return /* @__PURE__ */ jsx(GrowthBookProvider, { growthbook, children });
+};
+export {
+  AbTestProvider
 };
-
-export { AbTestProvider };

package/dist/index.cjs

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const growthbookReact = require("@growthbook/growthbook-react");
+const useAbTestAttributes = require("./useAbTestAttributes.cjs");
+const AbTestProvider = require("./AbTestProvider.cjs");
+Object.defineProperty(exports, "FeatureString", {
+  enumerable: true,
+  get: () => growthbookReact.FeatureString
+});
+Object.defineProperty(exports, "FeaturesReady", {
+  enumerable: true,
+  get: () => growthbookReact.FeaturesReady
+});
+Object.defineProperty(exports, "IfFeatureEnabled", {
+  enumerable: true,
+  get: () => growthbookReact.IfFeatureEnabled
+});
+Object.defineProperty(exports, "useExperiment", {
+  enumerable: true,
+  get: () => growthbookReact.useExperiment
+});
+Object.defineProperty(exports, "useFeature", {
+  enumerable: true,
+  get: () => growthbookReact.useFeature
+});
+Object.defineProperty(exports, "useFeatureIsOn", {
+  enumerable: true,
+  get: () => growthbookReact.useFeatureIsOn
+});
+Object.defineProperty(exports, "useFeatureValue", {
+  enumerable: true,
+  get: () => growthbookReact.useFeatureValue
+});
+Object.defineProperty(exports, "useGrowthBook", {
+  enumerable: true,
+  get: () => growthbookReact.useGrowthBook
+});
+Object.defineProperty(exports, "useGrowthBookSSR", {
+  enumerable: true,
+  get: () => growthbookReact.useGrowthBookSSR
+});
+Object.defineProperty(exports, "withRunExperiment", {
+  enumerable: true,
+  get: () => growthbookReact.withRunExperiment
+});
+exports.useAbTestAttributes = useAbTestAttributes.useAbTestAttributes;
+exports.AbTestProvider = AbTestProvider.AbTestProvider;

package/dist/index.d.ts

@@ -1,29 +1,5 @@
-import { Context, GrowthBook } 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';
-
-type Attributes = Record<string, string | number | undefined>;
-/**
- * @param {boolean} [autoRefresh] - false.
- * @param {number} [timeout] - 500.
- * @param {boolean} [skipCache] - false.
- */
-type LoadConfig = NonNullable<Parameters<GrowthBook['loadFeatures']>[0]>;
-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 AbTestProviderProps = {
-    children: ReactNode;
-    config: ToolConfig;
-    trackingCallback: TrackingCallback;
-    errorCallback: ErrorCallback;
-    attributes: Attributes;
-    loadConfig?: LoadConfig;
-};
-declare const AbTestProvider: ({ children, config, trackingCallback, errorCallback, attributes, loadConfig, }: AbTestProviderProps) => react.JSX.Element;
-
-export { AbTestProvider, type ErrorCallback, type ToolConfig, type TrackingCallback, useAbTestAttributes };
+export { useExperiment, useFeature, withRunExperiment, useFeatureIsOn, useFeatureValue, useGrowthBook, useGrowthBookSSR, } from '@growthbook/growthbook-react';
+export { FeatureString, FeaturesReady, IfFeatureEnabled, } from '@growthbook/growthbook-react';
+export { useAbTestAttributes } from './useAbTestAttributes';
+export { AbTestProvider } from './AbTestProvider';
+export type { TrackingCallback, ErrorCallback, ToolConfig } from './types';

package/dist/index.js

@@ -1,3 +1,17 @@
-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';
+import { FeatureString, FeaturesReady, IfFeatureEnabled, useExperiment, useFeature, useFeatureIsOn, useFeatureValue, useGrowthBook, useGrowthBookSSR, withRunExperiment } from "@growthbook/growthbook-react";
+import { useAbTestAttributes } from "./useAbTestAttributes.js";
+import { AbTestProvider } from "./AbTestProvider.js";
+export {
+  AbTestProvider,
+  FeatureString,
+  FeaturesReady,
+  IfFeatureEnabled,
+  useAbTestAttributes,
+  useExperiment,
+  useFeature,
+  useFeatureIsOn,
+  useFeatureValue,
+  useGrowthBook,
+  useGrowthBookSSR,
+  withRunExperiment
+};

package/dist/types.d.ts

@@ -0,0 +1,11 @@
+import type { Context, GrowthBook } from '@growthbook/growthbook-react';
+export 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['loadFeatures']>[0]>;
+export type ToolConfig = Pick<Context, 'apiHost' | 'clientKey' | 'enableDevMode' | 'backgroundSync' | 'subscribeToChanges'>;
+export type TrackingCallback = NonNullable<Context['trackingCallback']>;
+export type ErrorCallback = (error: Error | string) => void | null;

package/dist/useAbTestAttributes.cjs

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const growthbookReact = require("@growthbook/growthbook-react");
+const useAbTestAttributes = () => {
+  const growthBook = growthbookReact.useGrowthBook();
+  if (growthBook) {
+    const attributes = growthBook.getAttributes();
+    const setAttributes = (newAttributes) => growthBook.setAttributes({
+      ...attributes,
+      ...newAttributes
+    });
+    return [attributes, setAttributes];
+  }
+  return [{}, () => {
+  }];
+};
+exports.useAbTestAttributes = useAbTestAttributes;

package/dist/useAbTestAttributes.d.ts

@@ -0,0 +1,5 @@
+import type { Attributes } from './types';
+export declare const useAbTestAttributes: () => [
+    Attributes,
+    (attributes: Attributes) => void
+];

package/dist/useAbTestAttributes.js

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

package/package.json

@@ -1,16 +1,21 @@
 {
   "name": "@scaleway/use-growthbook",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "Utility package to expose AB test tool",
-  "type": "module",
   "engines": {
     "node": ">=20.x"
   },
+  "sideEffects": false,
+  "type": "module",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    "types": "./dist/index.d.ts",
-    "default": "./dist/index.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    }
   },
-  "sideEffects": false,
   "publishConfig": {
     "access": "public"
   },
@@ -32,5 +37,14 @@
   },
   "peerDependencies": {
     "react": "18.x"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "type:generate": "tsc --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",
+    "lint": "eslint --report-unused-disable-directives --cache --cache-strategy content --ext ts,tsx .",
+    "test:unit": "vitest --run --config vite.config.ts",
+    "test:unit:coverage": "pnpm test:unit --coverage"
   }
 }

package/tsconfig.build.json

@@ -0,0 +1,16 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": false,
+    "emitDeclarationOnly": true,
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "exclude": [
+    "*.config.ts",
+    "*.setup.ts",
+    "**/__tests__",
+    "**/__mocks__",
+    "src/**/*.test.tsx"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*.ts", "src/**/*.tsx", "*.config.ts"]
+}

package/vite.config.ts

@@ -0,0 +1,14 @@
+import { defineConfig, mergeConfig } from 'vite'
+import { defaultConfig } from '../../vite.config'
+
+export default mergeConfig(defineConfig(defaultConfig), {
+  build: {
+    lib: {
+      formats: ['es', 'cjs'],
+    },
+  },
+  test: {
+    environment: 'jsdom',
+    setupFiles: ['./vitest.setup.ts'],
+  },
+})

package/vitest.setup.ts

@@ -0,0 +1,12 @@
+import * as matchers from '@testing-library/jest-dom/matchers'
+import '@testing-library/jest-dom/vitest'
+import { cleanup } from '@testing-library/react'
+import { afterEach, expect, vi } from 'vitest'
+
+expect.extend(matchers)
+
+afterEach(() => {
+  cleanup()
+})
+
+vi.mock('@growthbook/growthbook-react')