@kameleoon/react-sdk 8.5.2 → 9.0.0

package/CHANGELOG.md

@@ -0,0 +1,472 @@
+# Change Log
+
+## 9.0.0 (2024-02-16)
+
+### Breaking Changes
+
+- `getReactVisitorCode` method and according hook were removed, instead use [`getVisitorCode`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#getvisitorcode) method
+- `getReactNativeVisitorCode` method and according hook were removed, instead use [`getVisitorCode`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#getvisitorcode) method
+- Previously deprecated `getBrowserVisitorCode` method and according hook were removed
+- Most hooks were merged and methods were grouped by hooks:
+  - `useAddData`/`useTrackConversion`/`useFlush`/`useRemoteData`/`useRemoteVisitorData`/`useWarehouseAudience` -> `useData` ,containing all methods from the listed hooks
+  - `useFeatureFlagActive`/`useFeatureFlags`/`useFeatureVariable`/`useFeatureVariables`/`useFeatureFlagVariationKey`/`useVisitorFeatureFlags`/`useEngineTrackingCode` -> `useFeatureFlag`, containing all methods from the listed hooks
+  - `useConfigurationUpdate` -> `useInitialize`, containing `onConfigurationUpdate` and `initialize` methods
+  - `useSetLegalConsent` -> `useVisitorCode`, containing `getVisitorCode` and `setLegalConsent` methods
+- React SDK for React Native now requires [providing external dependencies](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#react-native-considerations)
+- React SDK no more has React Native related packages in it's dependencies
+
+### Features
+
+- Added [External Dependencies](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#external-dependencies) capabilities
+
+### Patch Changes
+
+- Updated dependencies
+  - @kameleoon/javascript-sdk@3.0.0
+
+## 8.5.2 (2024-02-07)
+
+### Bug fixes
+
+- Tracking wasn't sent if consent is required
+
+## 8.5.1 (2024-01-29)
+
+### Bug fixes
+
+- Context binding in [useSetLegalConsent](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk/#usesetlegalconsent) hook
+
+## 8.5.0 (2024-01-18)
+
+### Bug fixes
+
+- SDK threw an error reading storage when migrating from older SDK versions
+- React Native visitor code couldn't be read from storage in certain React Native versions
+- React SDK request headers caused CORS errors
+
+### Features
+
+- Added new SDK `configuration` parameter [`requestTimeout`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/js-sdk/#1-initializing-the-kameleoon-client), which defines maximum time in _milliseconds_ after which any SDK network request will fail
+
+## 8.4.1 (2023-12-15)
+
+### Bug fixes
+
+- Fix nonce for `Conversion` data
+
+## 8.4.0 (2023-12-12)
+
+### Features
+
+- Updated the `getFeatureFlagVariable` function of [useFeatureVariable](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usefeaturevariable) hook to return an object of type `FeatureFlagVariableType`
+- Enhanced the `getFeatureFlagVariables`function of [useFeatureVariables](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usefeaturevariables) hook to include the `key` field in its return value.
+
+### Bug fixes
+
+- Custom Data mapping identifier wasn't tracked correctly
+
+## 8.3.0 (2023-12-11)
+
+### Features
+
+- [flush](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#useflush) and [trackConversion](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usetrackconversion) methods now have a new optional parameter `isUniqueIdentifier` used for extra [Kameleoon Cross-device Experimentation](https://developers.kameleoon.com/core-concepts/cross-device-experimentation) capabilities
+
+### Bug fixes
+
+- Targeting data cleanup caused `TypeError`
+
+## 8.2.1 (2023-12-04)
+
+### Bug fixes
+
+- Client cookie is now set properly
+
+## 8.2.0 (2023-11-30)
+
+### Features
+
+- [CustomData session merging](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#using-custom-data-for-session-merging) abilities for [Kameleoon Cross-device Experimentation](https://developers.kameleoon.com/core-concepts/cross-device-experimentation)
+
+## 8.1.0 (2023-11-24)
+
+### Features
+
+- Added `useSetLegalConsent` hook to determine the types data Kameleoon includes in tracking requests. This helps you adhere to legal and regulatory requirements while responsibly managing visitor data. You can find more information in the [Consent management policy](https://help.kameleoon.com/consent-management-policy).
+
+## 8.0.0 (2023-11-16)
+
+### Breaking change
+
+- SDK stopped the support of the following methods were:
+  - `useExperiments`
+  - `useVisitorExperiments`
+  - `useTriggerExperiment`
+- Previously deprecated `useFlushData` hook was removed
+- [`createClient`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#createclient) method parameters are now an object with type [`SDKParameters`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#parameters)
+- [`useRemoteVisitorData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#useremotevisitordata) hook callback parameters was changed to an object with type [`RemoteVisitorDataParamsType`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/js-sdk#parameters-12) that has a new `filters` field
+
+### Features
+
+- New hook with a method for retrieving multiple feature flag variables - [`useFeatureFlagVariables`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usefeatureflagvariables)
+- [`useRemoteVisitorData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#useremotevisitordata) callback is now capable of retrieving information from up to 25 visits along with some additional visit information configured by new `filters` field
+- [`PageView`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#pageview) data items are now stored by unique URL with timestamps of visits - each visitor can have several `PageView` URLs stored
+- [`Conversion`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#conversion) data items are now stored as a list of conversion for each visitor
+- [Cross Device Synchronization](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#synchronizing-custom-data-across-devices) was improved - [`CustomData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#customdata) with `Visitor` scope is always re-sent with tracking calls allowing seamless synchronization using [`getRemoteVisitorData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#getremotevisitordata)
+- [New targeting conditions](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#list-of-supported-targeting-conditions) are now available (some of them may require [`getRemoteVisitorData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#getremotevisitordata) pre-loaded data)
+  - `Browser Cookie`
+  - `Application Version`
+  - `Operating System`
+  - `IP Geolocation`
+  - `Segment`
+  - `Target Feature Flag`
+  - `Previous Page`
+  - `Number of Page Views`
+  - `Time since First Visit`
+  - `Time since Last Visit`
+  - `Number of Visits Today`
+  - `Total Number of Visits`
+  - `New or Returning Visitor`
+- New Kameleoon Data types were introduced:
+  - [`ApplicationVersion`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#applicationversion)
+  - [`Cookie`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#cookie)
+  - [`OperatingSystem`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#operatingsystem)
+  - [`GeolocationData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#geolocationdata)
+
+### Bug fixes
+
+- `SDKParameters` type is now correctly exported from SDK
+- SDK Polling re-tries mechanism was optimized - SDK will now try to obtain configuration again during the next poll after 3 failed configuration loading attempts
+- [`onConfigurationUpdate`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#useconfigurationupdate) callback now fires on successful configuration update in storage (previously fired after network configuration retrieval)
+
+## 7.6.1 (2023-10-20)
+
+### Bug fixes
+
+- Fix previous version deploy issue
+
+## 7.6.0 (2023-10-20)
+
+### Features
+
+- Added new hook [`useVisitorWarehouseAudience`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usevisitorwarehousedata)
+
+## 7.5.4 (2023-10-11)
+
+### Bug fixes
+
+- Storage data parse overhead optimization
+
+## 7.5.3 (2023-09-05)
+
+### Bug fixes
+
+- `UserAgent` was not exported from SDK
+
+## 7.5.2 (2023-08-31)
+
+### Bug fixes
+
+- `Custom Data Condition` now handles index `0` properly
+
+## 7.5.1 (2023-08-25)
+
+### Bug fixes
+
+- Multiple `Real Time Update` connections are no longer created
+- `Custom Data Condition` now handles all exceptions properly
+
+## 7.5.0 (2023-08-11)
+
+### Bug fixes
+
+- Empty Custom Data is now sending activity tracking event
+
+### Features
+
+- Added [Cross Device Custom Data Synchronization](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#cross-device-custom-data-synchronization) capabilities
+
+## 7.4.1 (2023-07-26)
+
+### Bug fixes
+
+- The returned function of [`useFlush`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#useflush) now sends offline tracking requests even if there's no new data to track.
+- Timestamps for offline requests are set correctly.
+
+## 7.4.0 (2023-07-21)
+
+### Features
+
+- `useFlushData` has been deprecated in favor of [`useFlush`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#useflush).
+- The function returned from [`useFlush`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#useflush) sends failed tracking requests that were stored locally during the offline mode at first and then proceeds with the latest request.
+
+## 7.3.2 (2023-07-17)
+
+### Bug fixes
+
+- Typescript `.d.ts` files have proper relative path resolution.
+- Unused tracking parameters are no longer sent.
+- Real-time update events now get the latest configuration.
+- Added exports for following types:
+  - [`ExperimentType`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#useexperiments)
+  - [`FeatureFlagType`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usefeatureflags)
+  - [`FeatureVariableResultType`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usefeaturevariable)
+  - [`KameleoonDataType`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#useremotevisitordata)
+
+### Features
+
+- When the client is initialized in offline mode, in case of network issues failed tracking requests made by returned functions of [`useFlushData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#useflushdata), [`useTrackConversion`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usetrackconversion), [`useTriggerExperiment`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usetriggerexperiment), [`useFeatureFlagVariationKey`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usefeatureflagvariationkey) or [`useFeatureVariable`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usefeaturevariable) will be sent anew once the client is back online.
+- Minor optimization for checking [targeting conditions](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#list-of-supported-targeting-conditions) of a segment.
+
+## 7.3.1 (2023-06-30)
+
+### Bug fixes
+
+- Tracking data duplication
+
+## 7.3.0 (2023-06-28)
+
+### Bug fixes
+
+- Improve error handling for [`getRemoteVisitorData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#obtain-custom-data-from-kameleoon-data-api)
+- Visitor code is now validated correctly in every method that uses it.
+- Result bundle is now compatible with systems not using `ESM` and `CommonJS`. It's minimized and uses code splitting for `crypto-js` `sha256` function.
+- Parameter `revenue` for [`Conversion`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#conversion) is now optional.
+- Each visitor can now only have one type of associated [`Kameleoon Data Type`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#data-types), except for [`CustomData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#customdata), that a visitor can have one per `customDataIndex`.
+
+### Features
+
+- New conditions are now supported: `Device`, `Browser`, `SDKLanguage`, `Page Title`, `Page View`, `Visitor Code`, `Conversion`. See the [full list of supported conditions](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#list-of-supported-targeting-conditions).
+- [`Browser`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#browser) now has new optional parameter `version`.
+- [`flushData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#flush-tracking-data) `visitorCode` parameter is now optional.
+- Custom data that is marked as `local only` on Kameleoon Platform is now only used for targeting (not flushed with tracking requests).
+
+## 7.2.4 (2023-06-01)
+
+### Bug fixes
+
+- Empty visitor code is no more allowed
+- Incorrect tracking body upon triggering an experiment
+
+## 7.2.3 (2023-05-24)
+
+### Bug fixes
+
+- Fixed issue for sending unique `Nonce` parameter on tracking requests
+
+## 7.2.2 (2023-05-21)
+
+### Bug fixes
+
+- [`useRemoteVisitorData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#obtain-custom-data-from-kameleoon-data-api) current visits not being up-to-date
+
+## 7.2.1 (2023-05-20)
+
+### Bug fixes
+
+- [`useRemoteVisitorData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#obtain-custom-data-from-kameleoon-data-api) data parse error
+
+## 7.2.0 (2023-05-19)
+
+### Features
+
+- New hook [`useRemoteVisitorData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#obtain-custom-data-from-kameleoon-data-api)
+- New offline mode for [`useInitialize`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#initialize-kameleoon-client) method
+
+## 7.1.2 (2023-04-24)
+
+### Bug fixes
+
+- Tracking feature flag rule with variation `off` wasn't displayed on result page
+
+## 7.1.1 (2023-04-22)
+
+### Bug fixes
+
+- core dependency fix
+
+## 7.1.0 (2023-04-21)
+
+### Features
+
+- New hook [`useEngineTrackingCode`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#sending-exposure-events-to-external-tools)
+
+## 7.0.0 (2023-04-14)
+
+### Breaking change
+
+- Error handling has changed, hook do not return `error` object anymore. See [details](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#error-handling)
+
+### Features
+
+- Added hook [`useExperimentVariationData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#useexperimentvariationdata)
+- Targeting data cleanup interval is now [`optional`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#1-initializing-the-kameleoon-client) and not set by default
+- [`getFeatureFlagVariationKey`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#get-variation-key-for-a-certain-feature-flag), [`getFeatureFlagVariable`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#get-a-variable-of-a-certain-feature-flag), [`isFeatureFlagActive`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#check-if-the-feature-is-active-for-visitor) methods returned from according hooks do not check previously allocated variation, rather recalculate it each time. Same methods now send tracking request for any rule type (previously only for `Experementation` rule)
+
+### Bug fixes
+
+- `variationId` is undefined when using feature flag related methods
+
+## 6.1.3 (2023-04-05)
+
+### Bug fixes
+
+- export missing hooks
+
+## 6.1.2 (2023-04-05)
+
+### Bug fixes
+
+- react sdk tests
+
+## 6.1.1 (2023-03-24)
+
+### Bug fixes
+
+- change broken dependency
+
+## 6.1.0 (2023-03-22)
+
+### Features
+
+- License changed from `GPL3.0` to `ISC`
+
+## 6.0.0 (2023-03-21)
+
+### Features
+
+- Feature Flag v2 support
+- Improved stability
+
+### Breaking change
+
+- All `HOCs`,`Feature` render props, `compose` were removed
+- All data types hooks were removed: `useDevice`, `useConversion`, `useCustomData`, `usePageView`, `useBrowser`
+- Renamed hooks:
+  - `useFlush` -> `useFlushData`
+  - `useActivateFeature` -> `useFeatureActive`
+  - `useVisitorCode` -> `useBrowserVisitorCode`
+  - `useAsyncVisitorCode` -> `useNativeVisitorCode`
+  - `useRetrieveDataFromRemoteSource` -> `useRemoteData`
+- Removed hooks:
+  - `useVariationAssociatedData`
+  - `useRunWhenReady`
+  - `useFeature`
+- Added hooks:
+  - `useInitialize`
+  - `useConfigurationUpdate`
+  - `useFeatureFlags`
+  - `useVisitorFeatureFlags`
+  - `useExperiments`
+  - `useVisitorExperiments`
+  - `useFeatureFlagVariationKey`
+
+## 5.0.0 (2023-02-03)
+
+### Bug fixes
+
+- remove xhr
+
+### Breaking change
+
+- visitor code is now mandatory for hasFeature and useFeature
+
+## 4.1.1 (2022-11-01)
+
+### Bug fixes
+
+- update tests
+
+## 4.1.0 (2022-10-13)
+
+### Features
+
+- react native async storage
+
+## 4.0.3 (2022-09-05)
+
+### Bug fixes
+
+- rerender error
+
+## 4.0.2 (2022-09-02)
+
+### Bug fixes
+
+- max depth error
+
+## 4.0.1 (2022-08-23)
+
+### Bug fixes
+
+- useDevice hook description
+
+## 4.0.0 (2022-08-18)
+
+### Features
+
+- swap feature arguments
+- add device custom data
+
+## 3.0.0 (2022-07-01)
+
+### Features
+
+- error handling
+
+### Breaking change
+
+- `useFeature` hook and `withFeature` high-order component can no longer be used the same way
+
+## 2.1.0 (2022-04-18)
+
+### Features
+
+- retrieve data from remote source
+
+## 2.0.0 (2022-02-24)
+
+### Features
+
+- add multi environment support
+
+### Breaking change
+
+- variableKeys became an object and no longer can be used as an array or a string
+
+## 1.2.2 (2022-02-06)
+
+### Bug fixes
+
+- bundle source and internal changelog
+
+## 1.2.1 (2022-02-06)
+
+### Bug fixes
+
+- decrease bundle size
+
+## 1.2.0 (2022-01-27)
+
+### Bug Fixes
+
+- linting issues
+
+## 1.1.0 (2022-01-26)
+
+### Bug Fixes
+
+- package json
+
+## 1.0.0 (2022-01-20)
+
+### Bug Fixes
+
+- linting and addData
+
+### Features
+
+- add HOCs
+- add render props
+- test react sdk methods
+- complete the documentation
+- add createClient, provider and hooks

package/CHANGELOG_INTERNAL.md

@@ -0,0 +1,3 @@
+# Internal Change Log
+
+All significant internal changes to this project will be documented in this file.

package/README.md

@@ -1,9 +1,9 @@
-# Kameleoon React/React Native SDK
+# Kameleoon React SDK
 
 ## Introduction
 
-Kameleoon React/React Native SDK is used to work with Kameleoon Feature Flags and Experiments.
-Integration of this SDK on web/mobile is easy, and its footprint is low.
+Kameleoon React SDK is used to work with Kameleoon Feature Flags and Experiments using native JavaScript or specific React Native APIs.
+The package provides a number of hooks and wrappers that can grant React oriented support for Kameleoon SDK when using it in React or React Native applications.
 
 This page describes the most basic configuration, for more in-depth review of all the hooks and configuration options follow [Official Kameleoon Documentation](https://developers.kameleoon.com/react-js-sdk.html)
 
@@ -11,22 +11,22 @@ This page describes the most basic configuration, for more in-depth review of al
 
 - [Installation](#installation)
 - [Configuration](#configuration)
-- [Using useReactVisitorCode and useReactNativeVisitorCode (Recommended)](#using-usereactvisitorcode-recommended)
-- [Legacy useBrowserVisitorCode and useNativeVisitorCode (Deprecated)](#legacy-usebrowservisitorcode-deprecated)
+- [Usage Example](#usage-example)
 
 ## Installation
 
 - **npm** - `npm install @kameleoon/react-sdk`
 - **yarn** - `yarn add @kameleoon/react-sdk`
 - **pnpm** - `pnpm add @kameleoon/react-sdk`
+- **bun** - `bun install @kameleoon/react-sdk`
 
 ## Configuration
 
 1. Obtain your site code from [Kameleoon Platform](https://app.kameleoon.com/)
-2. Create client and pass it to `KameleoonProvider`
+2. Instantiate SDK client and pass it to `KameleoonProvider`
 
 ```tsx
-import { createClient, KameleoonProvider } from '@kameleoon/react-sdk';
+import { KameleoonProvider, createClient } from '@kameleoon/react-sdk';
 
 const client = createClient({ siteCode: 'my_site_code' });
 
@@ -39,148 +39,41 @@ function MyComponentWrapper(): JSX.Element {
 }
 ```
 
-## Using useReactVisitorCode (Recommended)
-
-1. Asynchronously initialize client to fetch the configuration from remote server and handle possible errors
+## Usage Example
 
 ```tsx
 import { useEffect } from 'react';
 import {
-  useInitialize,
-  useAddData,
-  useReactVisitorCode,
-  useFeatureFlagActive,
+  useData,
   CustomData,
+  useInitialize,
+  useVisitorCode,
+  useFeatureFlag,
 } from '@kameleoon/react-sdk';
 
 function MyComponent(): JSX.Element {
   const { initialize } = useInitialize();
-  const { addData } = useAddData();
-  // -- Hook to generate new visitorCode. For React Native use `useReactNativeVisitorCode` hook
-  const { getReactVisitorCode } = useReactVisitorCode();
-  const { isFeatureFlagActive } = useFeatureFlagActive();
-  const customDataIndex = 0;
-
-  async function waitForInitialize(): Promise<void> {
-    const isReady = await initialize();
-
-    if (isReady) {
-      const visitorCode = getReactVisitorCode();
-
-      // -- Add targeting data
-      addData(visitorCode, new CustomData(customDataIndex, 'my_data'));
-
-      // -- Check if the feature is active for visitor
-      const isMyFeatureActive = isFeatureFlagActive(
-        visitorCode,
-        'my_feature_key',
-      );
-    }
-  }
-
-  useEffect(() => {
-    waitForInitialize();
-  }, []);
-}
-```
-
-2. `hooks` are ready to use. Note: They can be used only inside `KameleoonProvider`
-
-```tsx
-import {
-  useAddData,
-  useReactVisitorCode,
-  useFeatureFlagActive,
-  CustomData,
-} from '@kameleoon/react-sdk';
-
-function MyComponent(): JSX.Element {
-  const { addData } = useAddData();
-  // -- Hook to generate new visitorCode. For React Native use `useReactNativeVisitorCode` hook
-  const { getReactVisitorCode } = useReactVisitorCode();
-  const { isFeatureFlagActive } = useFeatureFlagActive();
-
-  const visitorCode = getReactVisitorCode();
-  const customDataIndex = 0;
-
-  // -- Add targeting data
-  addData(visitorCode, new CustomData(customDataIndex, 'my_data'));
-
-  // -- Check if the feature is active for visitor
-  const isMyFeatureActive = isFeatureFlagActive(visitorCode, 'my_feature_key');
-}
-```
+  const { addData } = useData();
+  const { isFeatureFlagActive } = useFeatureFlag();
+  const { getVisitorCode } = useVisitorCode();
 
-## Legacy useBrowserVisitorCode (Deprecated)
+  async function init(): Promise<void> {
+    // -- Wait for the client initialization
+    await initialize();
 
-> **Note:** The `useBrowserVisitorCode` and `useNativeVisitorCode` hooks are deprecated and will be removed in a future release. Use [`useReactVisitorCode`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usereactvisitorcode) and [`useReactNativeVisitorCode`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#usereactnativevisitorcode) instead.
+    // -- Generate a visitor code
+    const visitorCode = getVisitorCode();
 
-1. Asynchronously initialize client to fetch the configuration from remote server and handle possible errors
+    // -- Add targeting data
+    const customDataIndex = 0;
+    addData(visitorCode, new CustomData(customDataIndex, 'my_data'));
 
-```tsx
-import { useEffect } from 'react';
-import {
-  useInitialize,
-  useAddData,
-  useBrowserVisitorCode,
-  useFeatureFlagActive,
-  CustomData,
-} from '@kameleoon/react-sdk';
-
-function MyComponent(): JSX.Element {
-  const { initialize } = useInitialize();
-  const { addData } = useAddData();
-  // -- Hook to generate new visitorCode. For React Native use `useNativeVisitorCode` hook
-  const { getBrowserVisitorCode } = useBrowserVisitorCode();
-  const { isFeatureFlagActive } = useFeatureFlagActive();
-
-  const visitorCode = getBrowserVisitorCode('www.example.com');
-  const customDataIndex = 0;
-
-  async function waitForInitialize(): Promise<void> {
-    const isReady = await initialize();
-
-    if (isReady) {
-      // -- Add targeting data
-      addData(visitorCode, new CustomData(customDataIndex, 'my_data'));
-
-      // -- Check if the feature is active for visitor
-      const isMyFeatureActive = isFeatureFlagActive(
-        visitorCode,
-        'my_feature_key',
-      );
-    }
+    // -- Check if the feature is active for visitor
+    const isActive = isFeatureFlagActive(visitorCode, 'my_feature_key');
   }
 
   useEffect(() => {
-    waitForInitialize();
+    init();
   }, []);
 }
 ```
-
-2. `hooks` are ready to use. Note: They can be used only inside `KameleoonProvider`
-
-```tsx
-import {
-  useAddData,
-  useBrowserVisitorCode,
-  useFeatureFlagActive,
-  CustomData,
-} from '@kameleoon/react-sdk';
-
-function MyComponent(): JSX.Element {
-  const { addData } = useAddData();
-  // -- Hook to generate new visitorCode. For React Native use `useNativeVisitorCode` hook
-  const { getBrowserVisitorCode } = useBrowserVisitorCode();
-  const { isFeatureFlagActive } = useFeatureFlagActive();
-
-  const visitorCode = getBrowserVisitorCode('www.example.com');
-  const customDataIndex = 0;
-
-  // -- Add targeting data
-  addData(visitorCode, new CustomData(customDataIndex, 'my_data'));
-
-  // -- Check if the feature is active for visitor
-  const isMyFeatureActive = isFeatureFlagActive(visitorCode, 'my_feature_key');
-}
-```

package/dist/KameleoonContext.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
-import { KameleoonContextType } from './types';
-export declare const KameleoonContext: import("react").Context<KameleoonContextType | null>;
+import { KameleoonClient } from '@kameleoon/javascript-sdk';
+export declare const KameleoonContext: import("react").Context<KameleoonClient | null>;