@kameleoon/javascript-sdk-core 5.15.0 → 5.16.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## 5.16.1 (2025-10-23)
+
+### Patch Changes
+
+- Fixed an issue where [`Conversion`](Conversion) metadata initialized with a name was not tracked.
+
+## 5.16.0 (2025-10-22)
+
+### Minor Changes
+
+- Introduced a new [`getDataFile`](getDataFile) method. This method returns the current SDK configuration (also known as the **data file**) used for evaluation and targeting. It is **not** intended for production use to fetch variations for every feature flag in the returned list, as it is not optimized for performance. For that purpose, use [`getVariations`](getVariations) instead. `getDataFile` is mainly useful for debugging or QA, for example to let internal users manually select a variant for a specific feature flag in production.
+
+### Patch Changes
+
+- Addressed an issue where tracking data was sent for visitors who had not provided [consent](setLegalConsent).
+
+[setLegalConsent]: https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/js-sdk#setLegalConsent
+[getDataFile]: https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/js-sdk#getdatafile
+
 ## 5.15.0 (2025-09-01)
 
 > [!WARNING]

package/dist/browser.d.ts

@@ -23,3 +23,4 @@ export { MappingIdentifierType } from './storage/types';
 export { CustomDataConfigurationType, CustomDataScope, } from './clientConfiguration';
 export { ListUtilities, Utilities } from './utilities';
 export { BrowserDataType, CustomDataType, DataFilterType, DataManagerParametersType, DeviceDataType, GeolocationDataType, KameleoonVisitorDataType, MutUpdateTargetingDataParametersType, OperatingSystemDataType, PageViewDataType, ProcessCustomDataManagerParametersType, VisitDataType, VisitorsDataType, } from './kameleoonData/types';
+export { FeatureFlag, Rule, DataFile, Variable, Variation } from './types';

package/dist/clientConfiguration/types.d.ts

@@ -70,6 +70,7 @@ export type ExperimentType = {
     variationByExposition: VariationByExpositionType[];
 };
 export type FeatureVariationType = {
+    name?: string;
     key: string;
     variables: FeatureVariableType[];
 };

package/dist/index.d.ts

@@ -23,3 +23,4 @@ export { MappingIdentifierType } from './storage/types';
 export { CustomDataConfigurationType, CustomDataScope, } from './clientConfiguration';
 export { ListUtilities, Utilities } from './utilities';
 export { BrowserDataType, CustomDataType, DataFilterType, DataManagerParametersType, DeviceDataType, GeolocationDataType, KameleoonVisitorDataType, MutUpdateTargetingDataParametersType, OperatingSystemDataType, PageViewDataType, ProcessCustomDataManagerParametersType, VisitDataType, VisitorsDataType, } from './kameleoonData/types';
+export { FeatureFlag, Rule, DataFile, Variable, Variation } from './types';

package/dist/javascript-sdk-core-browser.cjs.js

@@ -2302,11 +2302,11 @@ let CustomData$1 = class CustomData {
         const isNumber = typeof first === 'number';
         const isBoolean = typeof second === 'boolean';
         if (isNumber) {
-            this.index = first;
+            this._index = first;
         }
         else {
-            this.name = first;
-            this.index = -1;
+            this._name = first;
+            this._index = CustomData.UNDEFINED_INDEX;
         }
         this.overwrite = isBoolean ? second : true;
         this.value = isBoolean
@@ -2317,7 +2317,7 @@ let CustomData$1 = class CustomData {
         // --- Note ---
         // If SDK is used in vanilla JS codebase, then you're also able to create an instance
         // with no required data, we don't want send anything to tracking in that case
-        if (typeof this.index !== 'number') {
+        if (typeof this._index !== 'number') {
             return '';
         }
         const uniqueValues = [...new Set(this.value)];
@@ -2334,7 +2334,7 @@ let CustomData$1 = class CustomData {
         }
         return (UrlEventType.CustomData +
             UrlParameter.Index +
-            this.index +
+            this._index +
             UrlParameter.ValuesCountMap +
             encodeURIComponent(JSON.stringify(resultValue)) +
             UrlParameter.Overwrite +
@@ -2342,7 +2342,7 @@ let CustomData$1 = class CustomData {
             identifierParameter);
     }
     get data() {
-        return Object.assign(Object.assign({ index: this.index }, (this.name !== undefined ? { name: this.name } : {})), { value: this.value, type: exports.KameleoonData.CustomData, isIdentifier: this.isIdentifier, status: this.status, overwrite: this.overwrite });
+        return Object.assign(Object.assign({ index: this._index }, (this._name !== undefined ? { name: this._name } : {})), { value: this.value, type: exports.KameleoonData.CustomData, isIdentifier: this.isIdentifier, status: this.status, overwrite: this.overwrite });
     }
     get status() {
         if (this._isMappingIdentifier) {
@@ -2361,7 +2361,7 @@ let CustomData$1 = class CustomData {
         let customData;
         if (name) {
             customData = new CustomData(name, overwrite !== null && overwrite !== void 0 ? overwrite : true, ...value);
-            customData._index = index;
+            customData.index = index;
         }
         else {
             customData = new CustomData(index, overwrite !== null && overwrite !== void 0 ? overwrite : true, ...value);
@@ -2398,13 +2398,28 @@ let CustomData$1 = class CustomData {
     }
     /**
      * @private
-     * @method _index - an internal setter for setting index of custom data
+     * @method index - an internal setter for setting index of custom data
      * @param {number} value - an index value
      * */
-    set _index(value) {
-        this.index = value;
+    set index(value) {
+        this._index = value;
+    }
+    /**
+     * @private
+     * @method index - an internal getter for index of custom data
+     * */
+    get index() {
+        return this._index;
+    }
+    /**
+     * @private
+     * @method name - an internal getter for a name of custom data
+     * */
+    get name() {
+        return this._name;
     }
 };
+CustomData$1.UNDEFINED_INDEX = -1;
 
 /**
  * @class
@@ -2441,6 +2456,9 @@ let Conversion$1 = class Conversion {
                 ? UrlParameter.Metadata + this._encodeMetadata()
                 : ''));
     }
+    get _metadata() {
+        return this.metadata;
+    }
     get data() {
         var _a;
         return {
@@ -5149,7 +5167,7 @@ class ConditionFactory {
             case TargetingType.HEAT_SLICE:
                 return buildExports.Ok(new ConversionLikelihood(data));
             default:
-                KameleoonLogger.error `Unsupported targeted condition type found: ${targetingType}`;
+                KameleoonLogger.info `Unsupported targeted condition type found: ${targetingType}`;
                 return buildExports.Err(new KameleoonError(exports.KameleoonException.TargetingCondition, targetingType));
         }
     }
@@ -5871,7 +5889,9 @@ class DataManager {
         return null;
     }
     mutUpdateTargetingData({ infoData, visitorCode, kameleoonData, targetingData, }) {
+        var _a;
         for (const dataItem of kameleoonData) {
+            // process custom data
             if (dataItem.data.type === exports.KameleoonData.CustomData) {
                 const customDataIsValid = this.processCustomData({
                     infoData,
@@ -5883,6 +5903,10 @@ class DataManager {
                     continue;
                 }
             }
+            //   process metadata of conversions
+            if (dataItem.data.type === exports.KameleoonData.Conversion) {
+                (_a = dataItem._metadata) === null || _a === void 0 ? void 0 : _a.forEach((item) => this.trySetCustomDataIndexByName(item));
+            }
             const expirationTime = this.dataProcessor.mutUpdateData({
                 infoData,
                 visitorCode,
@@ -5922,13 +5946,9 @@ class DataManager {
         var _a;
         const { data } = customData;
         const isDataValid = Boolean(data.value.length && data.value[0].length);
-        if (data.name) {
-            const cdIndex = this.customDataIndexByName.get(data.name);
-            if (cdIndex === undefined) {
-                return false;
-            }
-            data.index = cdIndex;
-            customData._index = cdIndex;
+        this.trySetCustomDataIndexByName(customData);
+        if (data.index == CustomData$1.UNDEFINED_INDEX) {
+            data.index = customData.index;
         }
         if (this.mappingIdentifierCustomDataIndex === data.index && isDataValid) {
             customData._isMappingIdentifier = true;
@@ -5955,6 +5975,15 @@ class DataManager {
         }
         return true;
     }
+    trySetCustomDataIndexByName(customData) {
+        if (customData.index == CustomData$1.UNDEFINED_INDEX && customData.name) {
+            const cdIndex = this.customDataIndexByName.get(customData.name);
+            if (cdIndex === undefined) {
+                return;
+            }
+            customData.index = cdIndex;
+        }
+    }
     get unsentDataVisitors() {
         const infoResult = this.infoStorage.read();
         if (!infoResult.ok) {
@@ -7807,7 +7836,7 @@ class BodyProvider {
         const identifier = isMappingIdentifier
             ? UrlParameter.MappingValue
             : UrlParameter.VisitorCode;
-        return identifier + visitorCode;
+        return identifier + encodeURIComponent(visitorCode);
     }
 }
 
@@ -8391,6 +8420,7 @@ class KameleoonClient {
             }
             const resultVariables = variables.map((variable) => Parser.parseFeatureVariable(variable).throw());
             resultFeatureList.set(variation.featureKey, {
+                name: '',
                 key: variationKey,
                 id: variationId,
                 experimentId,
@@ -8611,6 +8641,62 @@ class KameleoonClient {
         this.flush(visitorCode);
         KameleoonLogger.info `RETURN: KameleoonClient.evaluateAudiences(visitorCode: ${visitorCode})`;
     }
+    getDataFile() {
+        const dataFile = {
+            featureFlags: new Map(),
+        };
+        if (this.stubMode) {
+            return dataFile;
+        }
+        KameleoonLogger.debug `CALL: KameleoonClient.getDataFile()`;
+        this.clientConfiguration.featureFlags.forEach((featureFlag, key) => {
+            const variationsMap = new Map();
+            featureFlag.variations.forEach((sourceVariation) => {
+                var _a;
+                const variablesMap = new Map();
+                sourceVariation.variables.forEach((variable) => {
+                    try {
+                        const parsedVariable = Parser.parseFeatureVariable(variable).throw();
+                        variablesMap.set(variable.key, parsedVariable);
+                    }
+                    catch (err) {
+                        KameleoonLogger.error `Error parsing variable ${variable.key} of feature flag ${featureFlag.featureKey}: ${err}`;
+                    }
+                });
+                variationsMap.set(sourceVariation.key, {
+                    name: (_a = sourceVariation.name) !== null && _a !== void 0 ? _a : '',
+                    key: sourceVariation.key,
+                    id: null,
+                    experimentId: null,
+                    variables: variablesMap,
+                });
+            });
+            const rules = featureFlag.rules.map((rule) => {
+                const ruleVariations = new Map();
+                rule.variationByExposition.forEach((varByExp) => {
+                    const baseVariation = variationsMap.get(varByExp.variationKey);
+                    if (!baseVariation)
+                        return;
+                    ruleVariations.set(baseVariation.key, {
+                        name: baseVariation.name,
+                        key: baseVariation.key,
+                        id: varByExp.variationId,
+                        experimentId: rule.experimentId,
+                        variables: baseVariation.variables,
+                    });
+                });
+                return { variations: ruleVariations };
+            });
+            dataFile.featureFlags.set(key, {
+                variations: variationsMap,
+                environmentEnabled: featureFlag.environmentEnabled,
+                rules,
+                defaultVariationKey: featureFlag.defaultVariationKey,
+            });
+        });
+        KameleoonLogger.debug `RETURN: KameleoonClient.getDataFile() -> (dataFile: ${dataFile})`;
+        return dataFile;
+    }
     setUserConsent({ visitorCode, consent, setData, }) {
         if (this.stubMode) {
             return;
@@ -8797,6 +8883,7 @@ class KameleoonClient {
         return selected;
     }
     _getFeatureVariation({ visitorCode, featureKey, track, }) {
+        var _a, _b;
         KameleoonLogger.debug `CALL: KameleoonClient._getFeatureVariation(visitorCode: ${visitorCode}, featureKey: ${featureKey}, track: ${track})`;
         if (!this.initialized) {
             return buildExports.Err(new KameleoonError(exports.KameleoonException.Initialization));
@@ -8847,7 +8934,9 @@ class KameleoonClient {
         if (track && !isSimulated) {
             this.tracker.scheduleVisitor(visitorCode, this._isConsentProvided(visitorCode));
         }
+        const variationName = (_b = (_a = featureFlag.variations.find((item) => item.key === variationKey)) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : '';
         const resultData = {
+            name: variationName,
             key: variationKey,
             id: variationId,
             experimentId,