@kameleoon/react-sdk 10.1.3 → 10.2.0

package/CHANGELOG.md

@@ -1,6 +1,23 @@
 # Change Log
 
-## 10.1.3
+## 10.2.0 (2024-12-09)
+
+### Features
+
+- Added support for **simulated** variations.
+- Added the [`setForcedVariation()`][setForcedVariation] method. This method allows explicitly setting a forced variation for a visitor, which will be applied during experiment evaluation.
+
+### Patch Changes
+
+- Resolved an issue where the validation of [cookie domains][cookieDomain] for `localhost` resulted in incorrect failures. The SDK now accepts the provided domain without modification if it is deemed invalid and logs an [error][logLevels] to notify you of any issues with the specified domain.
+- Updated dependencies
+  - @kameleoon/javascript-sdk@4.2.0
+
+[setForcedVariation]: https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#setforcedvariation
+[cookieDomain]: https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#configuration-parameters
+[logLevels]: https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#log-levels
+
+## 10.1.3 (2024-12-06)
 
 ### Patch Changes
 

package/dist/createClient.js

@@ -1 +1 @@
-"use strict";var _javascriptSdk=require("@kameleoon/javascript-sdk");Object.defineProperty(exports,"__esModule",{value:!0}),exports.createClient=createClient;function createClient(a){let{siteCode:b,configuration:c,externals:d}=a;const e=new _javascriptSdk.KameleoonClient({siteCode:b,configuration:c,externals:d,_internals:{packageInfo:{type:_javascriptSdk.SdkLanguageType.REACT,version:"10.1.3"},prng:null===d||void 0===d?void 0:d.prng}});return e}
+"use strict";var _javascriptSdk=require("@kameleoon/javascript-sdk");Object.defineProperty(exports,"__esModule",{value:!0}),exports.createClient=createClient;function createClient(a){let{siteCode:b,configuration:c,externals:d}=a;const e=new _javascriptSdk.KameleoonClient({siteCode:b,configuration:c,externals:d,_internals:{packageInfo:{type:_javascriptSdk.SdkLanguageType.REACT,version:"10.2.0"},prng:null===d||void 0===d?void 0:d.prng}});return e}

package/dist/interfaces/useFeatureFlag.d.ts

@@ -1,4 +1,4 @@
-import { FeatureFlagType, KameleoonVariationType, FeatureFlagVariableType, FeatureVariableResultType, GetFeatureFlagVariableParamsType, GetVariationsParamsType, VariationType, GetVariationParamsType, IsFeatureFlagActiveParamsType } from '@kameleoon/javascript-sdk';
+import { FeatureFlagType, KameleoonVariationType, FeatureFlagVariableType, FeatureVariableResultType, GetFeatureFlagVariableParamsType, GetVariationsParamsType, VariationType, GetVariationParamsType, IsFeatureFlagActiveParamsType, SetForcedVariationParametersType } from '@kameleoon/javascript-sdk';
 export default interface IUseFeatureFlag {
     /**
      * Returns a variation for the visitor under `visitorCode` for the specified `featureKye`, this method includes targeting check, finding the according variation exposed to the visitor and saving it to storage
@@ -198,4 +198,22 @@ export default interface IUseFeatureFlag {
      * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
      */
     getEngineTrackingCode: (visitorCode: string) => string;
+    /**
+     * @method setForcedVariation - Sets or resets a forced variation for a visitor in a specific experiment, so the experiment will
+     * be evaluated to the variation for the visitor.
+     * In order to reset the forced variation, set the `variationKey` parameter to `null`. If the forced
+     * variation you want to reset does not exist, the method will have no effect.
+     *
+     * @param {SetForcedVariationParametersType} parameters an object with parameters of a type `SetForcedVariationParametersType`, see the type for details.
+     * @returns {void}
+     * @throws `KameleoonError` with one of the following `type` s:
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded
+     * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call
+     * - `KameleoonException.FeatureFlagExperimentNotFound` - The experiment id does not exist in the feature flag.
+     * - `KameleoonException.FeatureFlagVariationNotFound` - The variation key does not belong to the experiment.
+     * - `KameleoonException.StorageRead` - Couldn't read storage data
+     * - `KameleoonException.StorageWrite` - Couldn't update storage data
+     */
+    setForcedVariation: ({ visitorCode, experimentId, variationKey, forceTargeting, }: SetForcedVariationParametersType) => void;
 }

package/dist/useFeatureFlag.d.ts

@@ -13,6 +13,7 @@ import IUseFeatureFlag from './interfaces/useFeatureFlag';
  * - `getActiveFeatureFlags`,
  * - `getFeatureFlags`,
  * - `getFeatureFlagVariables`,
- * - `getEngineTrackingCode`
+ * - `getEngineTrackingCode`,
+ * - `setForcedVariation`
  */
 export declare function useFeatureFlag(): IUseFeatureFlag;

package/dist/useFeatureFlag.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useFeatureFlag=useFeatureFlag;var _react=require("react"),_useKameleoon=require("./useKameleoon");function useFeatureFlag(){const a=(0,_useKameleoon.useKameleoon)(),b=(0,_react.useCallback)((b,c)=>{if("string"==typeof b){if(!c)throw new Error("[Kameleoon React SDK Error]: Overload is not used correctly. The second parameter must be provided when the first parameter is a string");return a.isFeatureFlagActive(b,c)}return a.isFeatureFlagActive(b)},[a]),c=(0,_react.useCallback)(b=>{let{visitorCode:c,featureKey:d,track:e}=b;return a.getVariation({visitorCode:c,featureKey:d,track:e})},[a]),d=(0,_react.useCallback)(b=>{let{visitorCode:c,onlyActive:d,track:e}=b;return a.getVariations({visitorCode:c,onlyActive:d,track:e})},[a]),e=(0,_react.useCallback)((b,c)=>a.getFeatureFlagVariationKey(b,c),[a]),f=(0,_react.useCallback)(b=>{let{visitorCode:c,featureKey:d,variableKey:e}=b;return a.getFeatureFlagVariable({visitorCode:c,featureKey:d,variableKey:e})},[a]),g=(0,_react.useCallback)(b=>a.getVisitorFeatureFlags(b),[a]),h=(0,_react.useCallback)(b=>a.getActiveFeatureFlags(b),[a]),i=(0,_react.useCallback)(()=>a.getFeatureFlags(),[a]),j=(0,_react.useCallback)((b,c)=>a.getFeatureFlagVariables(b,c),[a]),k=(0,_react.useCallback)(b=>a.getEngineTrackingCode(b),[a]);return{getActiveFeatureFlags:h,getVariation:c,getVariations:d,getFeatureFlags:i,isFeatureFlagActive:b,getEngineTrackingCode:k,getVisitorFeatureFlags:g,getFeatureFlagVariable:f,getFeatureFlagVariables:j,getFeatureFlagVariationKey:e}}
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useFeatureFlag=useFeatureFlag;var _react=require("react"),_useKameleoon=require("./useKameleoon");function useFeatureFlag(){const a=(0,_useKameleoon.useKameleoon)(),b=(0,_react.useCallback)((b,c)=>{if("string"==typeof b){if(!c)throw new Error("[Kameleoon React SDK Error]: Overload is not used correctly. The second parameter must be provided when the first parameter is a string");return a.isFeatureFlagActive(b,c)}return a.isFeatureFlagActive(b)},[a]),c=(0,_react.useCallback)(b=>{let{visitorCode:c,featureKey:d,track:e}=b;return a.getVariation({visitorCode:c,featureKey:d,track:e})},[a]),d=(0,_react.useCallback)(b=>{let{visitorCode:c,onlyActive:d,track:e}=b;return a.getVariations({visitorCode:c,onlyActive:d,track:e})},[a]),e=(0,_react.useCallback)((b,c)=>a.getFeatureFlagVariationKey(b,c),[a]),f=(0,_react.useCallback)(b=>{let{visitorCode:c,featureKey:d,variableKey:e}=b;return a.getFeatureFlagVariable({visitorCode:c,featureKey:d,variableKey:e})},[a]),g=(0,_react.useCallback)(b=>a.getVisitorFeatureFlags(b),[a]),h=(0,_react.useCallback)(b=>a.getActiveFeatureFlags(b),[a]),i=(0,_react.useCallback)(()=>a.getFeatureFlags(),[a]),j=(0,_react.useCallback)((b,c)=>a.getFeatureFlagVariables(b,c),[a]),k=(0,_react.useCallback)(b=>a.getEngineTrackingCode(b),[a]),l=(0,_react.useCallback)(b=>{let{visitorCode:c,experimentId:d,variationKey:e,forceTargeting:f}=b;return a.setForcedVariation({visitorCode:c,experimentId:d,variationKey:e,forceTargeting:f})},[a]);return{getActiveFeatureFlags:h,getVariation:c,getVariations:d,getFeatureFlags:i,isFeatureFlagActive:b,getEngineTrackingCode:k,getVisitorFeatureFlags:g,getFeatureFlagVariable:f,getFeatureFlagVariables:j,getFeatureFlagVariationKey:e,setForcedVariation:l}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kameleoon/react-sdk",
-  "version": "10.1.3",
+  "version": "10.2.0",
   "description": "Kameleoon React SDK",
   "files": [
     "dist"
@@ -38,7 +38,7 @@
   ],
   "license": "ISC",
   "dependencies": {
-    "@kameleoon/javascript-sdk": "4.1.3"
+    "@kameleoon/javascript-sdk": "4.2.0"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0"