vwo-fme-react-sdk 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,80 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2025-02-13
+
+### Added
+
+- The **VWO Feature Management and Experimentation SDK** (VWO FME React SDK) enables React.js developers to integrate feature flagging and experimentation into their applications. This SDK provides full control over feature rollout, A/B testing, and event tracking, allowing teams to manage features dynamically and gain insights into user behavior.
+
+  #### Basic Usage
+
+  ```javascript
+  import React from 'react';
+  import { VWOProvider } from 'vwo-fme-react-sdk';
+
+  const vwoConfig = {
+    sdkKey: '32-alpha-numeric-sdk-key', // Your VWO SDK Key
+    accountId: '123456', // Your VWO Account ID
+    logger: {
+      level: 'debug', // Optional log level for debugging
+    },
+  };
+
+  const userContext = {
+    id: 'unique_user_id', // Required: Unique identifier for the user
+    customVariables: { age: 25, location: 'US' }, // Optional
+    userAgent:
+      'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36', // Optional
+    ipAddress: '1.1.1.1', // Optional
+  };
+
+  const App = () => (
+    <VWOProvider config={vwoConfig} context={userContext}>
+      <YourComponent />
+    </VWOProvider>
+  );
+
+  export default App;
+  ```
+
+  ### Feature flag and variables Usage
+
+  ```javascript
+  import React from 'react';
+  import { useGetFlag, useGetFlagVariable } from 'vwo-fme-react-sdk'; // Import hooks
+
+  const YourComponent = () => {
+    // Retrieve the flag using the feature key
+    const flag = useGetFlag('feature_key');
+
+    // Check if the flag is enabled
+    const isEnabled = flag?.isEnabled();
+    if (isEnabled) {
+      // Use the flag object returned by useGetFlag to retrieve a specific variable
+      // Replace 'variableKey' with the actual key for the variable you want to retrieve
+      const variableKey = 'variable_name'; // Replace with actual variable key
+      const variableValue = useGetFlagVariable(flag, variableKey, 'default_value');
+
+      // Display the feature flag variable value
+      return (
+        <div>
+          <p>Feature Flag Variable Value: {variableValue}</p>
+        </div>
+      );
+    }
+
+    // Display a message if the feature is not enabled
+    return (
+      <div>
+        <p>Feature is not enabled!</p>
+      </div>
+    );
+  };
+
+  export default YourComponent;
+  ```

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Wingify Software Pvt. Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,18 @@
+Copyright 2025 Wingify Software Pvt. Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Wingify VWO FME React SDK
+
+This product includes software developed at
+Wingify Software Pvt. Ltd. (https://wingify.com/).

package/README.md

@@ -0,0 +1,352 @@
+# VWO Feature Management and Experimentation SDK for React SDK
+
+[![npm version](https://img.shields.io/npm/v/vwo-fme-react-sdk?style=for-the-badge&color=grey&logo=npm)](https://www.npmjs.com/package/vwo-fme-react-sdk)
+[![License](https://img.shields.io/github/license/wingify/vwo-fme-react-sdk?style=for-the-badge&color=blue)](http://www.apache.org/licenses/LICENSE-2.0)
+![](http://img.badgesize.io/wingify/vwo-fme-react-sdk/master/dist/vwo-fme-react-sdk.cjs.production.min.js?compression=gzip&color=blue)
+
+## Overview
+
+The **VWO Feature Management and Experimentation SDK** (VWO FME React SDK) enables React.js developers to integrate feature flagging and experimentation into their applications. This SDK provides full control over feature rollout, A/B testing, and event tracking, allowing teams to manage features dynamically and gain insights into user behavior.
+
+## Requirements
+
+- **React 16.8+**
+
+## Installation
+
+Install the SDK via [**npm**](https://npmjs.com/package/vwo-fme-react-sdk) or [**yarn**](https://classic.yarnpkg.com/en/package/vwo-fme-react-sdk):
+
+```bash
+# via npm
+npm install vwo-fme-react-sdk --save
+
+# via yarn
+yarn add vwo-fme-react-sdk
+```
+
+## Basic Usage Example
+
+```javascript
+import React from 'react';
+import { VWOProvider } from 'vwo-fme-react-sdk';
+
+const vwoConfig = {
+  sdkKey: '32-alpha-numeric-sdk-key', // Your VWO SDK Key
+  accountId: '123456', // Your VWO Account ID
+  logger: {
+    level: 'debug', // Optional log level for debugging
+  },
+};
+
+const userContext = {
+  id: 'unique_user_id', // Required: Unique identifier for the user
+  customVariables: { age: 25, location: 'US' }, // Optional
+  userAgent:
+    'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36', // Optional
+  ipAddress: '1.1.1.1', // Optional
+};
+
+const App = () => (
+  <VWOProvider config={vwoConfig} context={userContext}>
+    <YourComponent />
+  </VWOProvider>
+);
+
+export default App;
+```
+
+## Advanced Configuration Options
+
+To customize the SDK further, additional parameters can be passed to the `VWOProvider` component. Here’s a table describing each option:
+
+| **Parameter**  | **Description**                                                                                                                                             | **Required** | **Type** | **Example**                     |
+| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -------- | ------------------------------- |
+| `accountId`    | VWO Account ID for authentication.                                                                                                                          | Yes          | String   | `'123456'`                      |
+| `sdkKey`       | SDK key corresponding to the specific environment to initialize the VWO SDK Client. You can get this key from VWO Application.                              | Yes          | String   | `'32-alpha-numeric-sdk-key'`    |
+| `pollInterval` | Time interval for fetching updates from VWO servers (in milliseconds).                                                                                      | No           | Number   | `60000`                         |
+| `storage`      | Custom storage connector for persisting user decisions and campaign data.                                                                                   | No           | Object   | See [Storage](#storage) section |
+| `logger`       | Toggle log levels for more insights or for debugging purposes. You can also customize your own transport in order to have better control over log messages. | No           | Object   | See [Logger](#logger) section   |
+
+Refer to the [official VWO documentation](https://developers.vwo.com/v2/docs/fme-react-initialization) for additional parameter details.
+
+### User Context
+
+The `context` object uniquely identifies users and is crucial for consistent feature rollouts. A typical `context` includes an `id` for identifying the user. It can also include other attributes that can be used for targeting and segmentation, such as `customVariables`, `userAgent` and `ipAddress`.
+
+#### Parameters Table
+
+The following table explains all the parameters in the `context` object:
+
+| **Parameter**     | **Description**                                                            | **Required** | **Type** | **Example**                       |
+| ----------------- | -------------------------------------------------------------------------- | ------------ | -------- | --------------------------------- |
+| `id`              | Unique identifier for the user.                                            | Yes          | String   | `'unique_user_id'`                |
+| `customVariables` | Custom attributes for targeting.                                           | No           | Object   | `{ age: 25, location: 'US' }`     |
+| `userAgent`       | User agent string for identifying the user's browser and operating system. | No           | String   | `'Mozilla/5.0 ... Safari/537.36'` |
+| `ipAddress`       | IP address of the user.                                                    | No           | String   | `'1.1.1.1'`                       |
+
+#### Example
+
+```javascript
+const userContext = {
+  id: 'unique_user_id',
+  customVariables: { age: 25, location: 'US' },
+  userAgent:
+    'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36',
+  ipAddress: '1.1.1.1',
+};
+```
+
+### Basic Feature Flagging
+
+Feature Flags serve as the foundation for all testing, personalization, and rollout rules within FME.
+To implement a feature flag, first use the `useGetFlag` hook to retrieve the flag configuration.
+The `useGetFlag` hook provides a simple way to check if a feature is enabled for a specific user and access its variables. It returns a feature flag object that contains methods for checking the feature's status and retrieving any associated variables.
+
+| Parameter    | Description                           | Required | Type   | Example          |
+| ------------ | ------------------------------------- | -------- | ------ | ---------------- |
+| `featureKey` | Unique identifier of the feature flag | Yes      | String | `'new_checkout'` |
+
+Example usage:
+
+```javascript
+import React from 'react';
+import { useGetFlag, useGetFlagVariable } from 'vwo-fme-react-sdk'; // Import hooks
+
+const YourComponent = () => {
+  // Retrieve the flag using the feature key
+  const flag = useGetFlag('feature_key');
+
+  // Check if the flag is enabled
+  const isEnabled = flag?.isEnabled();
+  if (isEnabled) {
+    // Use the flag object returned by useGetFlag to retrieve a specific variable
+    // Replace 'variableKey' with the actual key for the variable you want to retrieve
+    const variableKey = 'variable_name'; // Replace with actual variable key
+    const variableValue = useGetFlagVariable(flag, variableKey, 'default_value');
+
+    // Display the feature flag variable value
+    return (
+      <div>
+        <p>Feature Flag Variable Value: {variableValue}</p>
+      </div>
+    );
+  }
+
+  // Display a message if the feature is not enabled
+  return (
+    <div>
+      <p>Feature is not enabled!</p>
+    </div>
+  );
+};
+
+export default YourComponent;
+```
+
+### Custom Event Tracking
+
+Feature flags can be enhanced with connected metrics to track key performance indicators (KPIs) for your features. These metrics help measure the effectiveness of your testing rules by comparing control versus variation performance, and evaluate the impact of personalization and rollout campaigns. Use the `useTrackEvent` hook to track custom events like conversions, user interactions, and other important metrics:
+
+| Parameter         | Description                                              | Required | Type   | Example                |
+| ----------------- | -------------------------------------------------------- | -------- | ------ | ---------------------- |
+| `eventName`       | Name of the event you want to track                      | Yes      | String | `'purchase_completed'` |
+| `eventProperties` | Additional properties/metadata associated with the event | No       | Object | `{ amount: 49.99 }`    |
+
+Example usage:
+
+```javascript
+import { useTrackEvent } from 'vwo-fme-react-sdk'; // Import the hook
+
+const YourComponent = () => {
+  // Track an event when a button is clicked, the second parameter for useTrackEvent is optional.
+  useTrackEvent('button_click', { userType: 'premium' });
+};
+
+export default YourComponent;
+```
+
+See [Tracking Conversions](https://developers.vwo.com/v2/docs/fme-react-metrics-tracking#usage) documentation for more information.
+
+### Pushing Attributes
+
+User attributes provide rich contextual information about users, enabling powerful personalization. The `useSetAttribute` hook provides a simple way to associate these attributes with users in VWO for advanced segmentation. Here's what you need to know about the method parameters:
+
+| Parameter      | Description                                                                                                                        | Required | Type   | Example                       |
+| -------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ | ----------------------------- |
+| `attributeMap` | A key-value map of attributes to set for the user. The keys are attribute names and values are the corresponding attribute values. | Yes      | Object | `{ age: 25, location: 'US' }` |
+
+Example usage:
+
+```javascript
+import { useSetAttribute } from 'vwo-fme-react-sdk'; // Import the hook
+
+const YourComponent = () => {
+  // Set attributes for the user
+  useSetAttribute({ age: 25, location: 'US' });
+};
+
+export default YourComponent;
+```
+
+See [Pushing Attributes](https://developers.vwo.com/v2/docs/fme-react-attributes#usage) documentation for additional information.
+
+### Polling Interval Adjustment
+
+The `pollInterval` is an optional parameter that allows the SDK to automatically fetch and update settings from the VWO server at specified intervals. Setting this parameter ensures your application always uses the latest configuration.
+
+```javascript
+const vwoConfig = {
+  sdkKey: '32-alpha-numeric-sdk-key', // Your VWO SDK Key
+  accountId: '123456', // Your VWO Account ID
+  pollInterval: 60000, // Time interval for fetching updates from VWO servers (in milliseconds)
+};
+
+const App = () => (
+  <VWOProvider config={vwoConfig} context={{ id: 'unique_user_id' }}>
+    <YourComponent />
+  </VWOProvider>
+);
+```
+
+### Storage
+
+The SDK operates in a stateless mode by default, meaning each `useGetFlag` hook triggers a fresh evaluation of the flag against the current user context.
+
+To optimize performance and maintain consistency, you can implement a custom storage mechanism by passing a `storage` parameter during initialization. This allows you to persist feature flag decisions in your preferred database system (like Redis, MongoDB, or any other data store).
+
+Key benefits of implementing storage:
+
+- Improved performance by caching decisions
+- Consistent user experience across sessions
+- Reduced load on your application
+
+The storage mechanism ensures that once a decision is made for a user, it remains consistent even if campaign settings are modified in the VWO Application. This is particularly useful for maintaining a stable user experience during A/B tests and feature rollouts.
+
+```javascript
+import { VWOProvider } from 'vwo-fme-react-sdk';
+
+class StorageConnector extends StorageConnector {
+  constructor() {
+    super();
+  }
+
+  /**
+   * Get data from storage
+   * @param {string} featureKey
+   * @param {string} userId
+   * @returns {Promise<any>}
+   */
+  async get(featureKey, userId) {
+    // return await data (based on featureKey and userId)
+  }
+
+  /**
+   * Set data in storage
+   * @param {object} data
+   */
+  async set(data) {
+    // Set data corresponding to a featureKey and user ID
+    // Use data.featureKey and data.userId to store the above data for a specific feature and a user
+  }
+}
+
+const vwoConfig = {
+  sdkKey: '32-alpha-numeric-sdk-key', // Your VWO SDK Key
+  accountId: '123456', // Your VWO Account ID
+  logger: {
+    level: 'debug', // Optional log level for debugging
+  },
+  storage: StorageConnector,
+};
+
+const App = () => (
+  <VWOProvider config={vwoConfig} context={{ id: 'unique_user_id' }}>
+    <YourComponent />
+  </VWOProvider>
+);
+
+export default App;
+```
+
+### Logger
+
+VWO by default logs all `ERROR` level messages to your server console.
+To gain more control over VWO's logging behaviour, you can use the `logger` parameter in the `init` configuration.
+
+| **Parameter** | **Description**                        | **Required** | **Type** | **Example**           |
+| ------------- | -------------------------------------- | ------------ | -------- | --------------------- |
+| `level`       | Log level to control verbosity of logs | Yes          | String   | `DEBUG`               |
+| `prefix`      | Custom prefix for log messages         | No           | String   | `'CUSTOM LOG PREFIX'` |
+
+#### Example 1: Set log level to control verbosity of logs
+
+```javascript
+const options = {
+  sdkKey: '32-alpha-numeric-sdk-key', // SDK Key
+  accountId: '123456', // VWO Account ID
+  logger: {
+    level: 'debug',
+  },
+};
+
+const App = () => (
+  <VWOProvider config={vwoConfig} context={{ id: 'unique_user_id' }}>
+    <YourComponent />
+  </VWOProvider>
+);
+
+export default App;
+```
+
+#### Example 2: Add custom prefix to log messages for easier identification
+
+```javascript
+const options = {
+  sdkKey: '32-alpha-numeric-sdk-key', // SDK Key
+  accountId: '123456', // VWO Account ID
+  logger: {
+    level: 'debug',
+    prefix: 'CUSTOM LOG PREFIX', // custom logger prefix
+  },
+};
+
+const App = () => (
+  <VWOProvider config={vwoConfig} context={{ id: 'unique_user_id' }}>
+    <YourComponent />
+  </VWOProvider>
+);
+
+export default App;
+```
+
+### Version History
+
+The version history tracks changes, improvements, and bug fixes in each version. For a full history, see the [CHANGELOG.md](https://github.com/wingify/vwo-fme-react-sdk/blob/master/CHANGELOG.md).
+
+## Development and Testing
+
+### Install Dependencies and Bootstrap Git Hooks
+
+```bash
+yarn install
+```
+
+### Compile TypeScript to JavaScript
+
+```bash
+yarn build
+```
+
+## Contributing
+
+We welcome contributions to improve this SDK! Please read our [contributing guidelines](https://github.com/wingify/vwo-fme-react-sdk/blob/master/CONTRIBUTING.md) before submitting a PR.
+
+## Code of Conduct
+
+Our [Code of Conduct](https://github.com/wingify/vwo-fme-react-sdk/blob/master/CODE_OF_CONDUCT.md) outlines expectations for all contributors and maintainers.
+
+## License
+
+[Apache License, Version 2.0](https://github.com/wingify/vwo-fme-react-sdk/blob/master/LICENSE)
+
+Copyright 2025 Wingify Software Pvt. Ltd.

package/dist/VWOContext.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright 2025 Wingify Software Pvt. Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Context for VWO SDK
+ */
+export declare const VWOContext: any;
+/**
+ * Hook to use the VWO context
+ * @returns VWO context
+ */
+export declare const useVWOContext: () => any;