vwo-fme-node-sdk 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -5,6 +5,36 @@ 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.4.0] - 2024-08-01
+
+### Changed
+
+- Modified code to support browser and Node.js environment
+- The same SDK can be used in the browser and Node.js environment without any changes in the code from the customer side
+- Refactored code to use interfaces and types wherever missing or required
+
+### Added
+
+Client-side Javascript SDK
+
+- Used webpack for bundling code
+- Separate builds for Node.js and browser using `webpack`
+- SDK is compatible to be run on browser(as a Script, client-side rendering with React ,Ionic framework, etc.)
+- Node.js environment can now use one single bundled file too, if required
+
+## [1.3.1] - 2024-07-225
+
+### Fixed
+
+- fix: add support for DSL where featureIdValue could be `off`
+- refactor: make eventProperties as third parameter
+
+## [1.3.0] - 2024-06-20
+
+### Fixed
+
+- Update dist folder
+
 ## [1.2.4] - 2024-06-14
 
 ### Fixed
@@ -51,11 +81,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     ```javascript
     {
       id: 'user-id',           // MANDATORY
-      ip: '1.2.3.4',           // OPTIONAL - required for user targeting
-      ua: '...',               // OPTIONAL - required for user targeting
-      other_attributes: '...', // OPTIONAL - required for user targeting
+      ipAddress: '1.2.3.4',    // OPTIONAL - required for user targeting
+      userAgent: '...',        // OPTIONAL - required for user targeting
       // For pre-segmentation in campaigns
       customVariables: {
+        price: 300
         // ...
       }
     }

package/README.md

@@ -1,4 +1,4 @@
-## VWO Feature Management and Experimentation SDK for Node.js
+## VWO Feature Management and Experimentation SDK for Node.js and JavaScript(browser)
 
 [![npm version](https://img.shields.io/npm/v/vwo-fme-node-sdk?style=for-the-badge&color=grey&logo=npm)](https://www.npmjs.com/package/vwo-fme-node-sdk)
 [![License](https://img.shields.io/github/license/wingify/vwo-fme-node-sdk?style=for-the-badge&color=blue)](http://www.apache.org/licenses/LICENSE-2.0)
@@ -6,6 +6,8 @@
 [![CI](https://img.shields.io/github/actions/workflow/status/wingify/vwo-fme-node-sdk/main.yml?style=for-the-badge&logo=github)](https://github.com/wingify/vwo-fme-node-sdk/actions?query=workflow%3ACI)
 [![codecov](https://img.shields.io/codecov/c/github/wingify/vwo-fme-node-sdk?token=813UYYMWGM&style=for-the-badge&logo=codecov)](https://codecov.io/gh/wingify/vwo-fme-node-sdk)
 
+![](http://img.badgesize.io/wingify/vwo-fme-node-sdk/master/dist/client/vwo-fme-javascript-sdk.min.js?compression=gzip&color=blue)
+
 ### Requirements
 
 - Node 12+
@@ -40,7 +42,7 @@ const isFlagEnabled = getFlag.isEnabled();
 const intVar = getFlag.getVariable('int_variable_key');
 
 // track event
-vwoClient.trackEvent('addToCart', userContext, eventProperties);
+vwoClient.trackEvent('add_to_cart', userContext, eventProperties);
 ```
 
 ### Development Scripts