@kameleoon/javascript-sdk-core 5.14.4 → 5.15.0

package/dist/kameleoonData/customData.d.ts

@@ -10,21 +10,40 @@ export declare class CustomData implements IKameleoonData {
     private index;
     private value;
     private isIdentifier;
+    private overwrite;
+    private name?;
     /**
-     * @param {number} index - an index of custom data to be stored under in a state, an index of custom data can be specified in `Advanced Tools` section of Kameleoon Application
-     * @param {string[]} value - custom value to store under the specified id, value can be anything but has to be stringified to match the `string` type. *Note* value is variadic parameter and can be used as follows
+     * @param {number|string} indexOrName - either:
+     *   - `number` — an index of custom data (configured in *Advanced Tools* section of Kameleoon Application)
+     *   - `string` — a custom name for the data
+     * @param {boolean} [overwrite=true] - optional flag, whether to overwrite existing data
+     * @param {...string} value - one or more values to store. Values must be strings (or stringified).
+     *
      * @example
      * ```ts
-     * // - Single value
-     * const customData = new CustomData(0, 'value_1');
-     * // - Variadic number of values
-     * const customData = new CustomData(0, 'value_1', 'value_2', 'value_3');
-     * // - Array of values
-     * const values = ['value_1', 'value_2', 'value_3'];
-     * const customData = new CustomData(0, ...values);
+     * // - Using index with single value
+     * const cd1 = new CustomData(0, 'value_1');
+     *
+     * // - Using index with multiple values
+     * const cd2 = new CustomData(0, 'value_1', 'value_2');
+     *
+     * // - Using index with overwrite flag
+     * const cd3 = new CustomData(0, false, 'value_1', 'value_2');
+     *
+     * // - Using name with single value
+     * const cd4 = new CustomData('name', 'value_1');
+     *
+     * // - Using name with multiple values
+     * const cd5 = new CustomData('name', 'value_1', 'value_2');
+     *
+     * // - Using name with overwrite flag
+     * const cd6 = new CustomData('name', false, 'value_1', 'value_2');
      * ```
-     * */
+     */
     constructor(index: number, ...value: string[]);
+    constructor(index: number, overwrite: boolean, ...value: string[]);
+    constructor(name: string, ...value: string[]);
+    constructor(name: string, overwrite: boolean, ...value: string[]);
     get url(): string;
     get data(): CustomDataType;
     get status(): TrackingStatus;
@@ -47,4 +66,10 @@ export declare class CustomData implements IKameleoonData {
      * @param {VisitType} visit - a visit
      * */
     static _updateFromVisit(visit: VisitType, dataMap: Map<number, CustomData>): void;
+    /**
+     * @private
+     * @method _index - an internal setter for setting index of custom data
+     * @param {number} value - an index value
+     * */
+    set _index(value: number);
 }

package/dist/kameleoonData/dataManager.d.ts

@@ -27,6 +27,7 @@ export interface IDataManager {
     readonly storedCustomDataIndexes: Set<number>;
     readonly trees: Map<string, Tree>;
     readonly unsentDataVisitors: string[];
+    getCustomDataIndexByName(name: string): number | undefined;
 }
 export declare class DataManager implements IDataManager {
     protected dataStorage: IStorage<TargetingDataType>;
@@ -36,6 +37,7 @@ export declare class DataManager implements IDataManager {
     protected mappingIdentifierCustomDataIndex: number | null;
     protected persistentCustomDataIndexes: Set<number>;
     protected localCustomDataIndexes: Set<number>;
+    protected customDataIndexByName: Map<string, number>;
     protected cleanupIntervalId: NodeJS.Timeout | null;
     protected packageInfo: ExternalPackageInfoType;
     constructor({ dataStorage, infoStorage, cleanupInterval, packageInfo, }: DataManagerParametersType);
@@ -63,4 +65,5 @@ export declare class DataManager implements IDataManager {
     get trees(): Map<string, Tree>;
     get storedCustomDataIndexes(): Set<number>;
     set customDataIndexes(customData: CustomDataConfigurationType[]);
+    getCustomDataIndexByName(name: string): number | undefined;
 }

package/dist/kameleoonData/types.d.ts

@@ -206,8 +206,10 @@ export type ConversionDataType = {
 } & SharedDataPropertiesType;
 export type CustomDataType = {
     index: number;
+    name?: string;
     value: string[];
     isIdentifier: boolean;
+    overwrite?: boolean;
 } & SharedDataPropertiesType;
 export type DeviceDataType = {
     device: DeviceType;

package/dist/tracking/tracker.d.ts

@@ -9,7 +9,8 @@ export declare class Tracker implements ITracker {
     private bodyProvider;
     private intervalId;
     private trackingStorage;
-    constructor({ dataManager, trackingStorage, variationConfiguration, trackingInterval, requester, prng, }: TrackerParametersType);
+    private clientConfiguration;
+    constructor({ dataManager, trackingStorage, variationConfiguration, trackingInterval, requester, prng, clientConfiguration, }: TrackerParametersType);
     scheduleVisitor(visitorCode: string, isConsentProvided: boolean): void;
     private checkIsIdentifier;
     private getUserAgent;

package/dist/tracking/types.d.ts

@@ -5,6 +5,7 @@ import { IExternalPRNG } from '../utilities';
 import { VariationConfiguration } from '../variationConfiguration';
 import { BaseVariationDataType } from '../variationConfiguration/types';
 import { StaticData } from '../kameleoonData/staticData';
+import { ClientConfiguration } from '../clientConfiguration';
 export type PendingDataType = {
     [visitorCode: string]: {
         visitorData: (KameleoonDataType | StaticData)[];
@@ -24,6 +25,7 @@ export type TrackerParametersType = {
     variationConfiguration: VariationConfiguration;
     requester: Requester;
     prng: IExternalPRNG;
+    clientConfiguration: ClientConfiguration;
 };
 export type AddDataParametersType = {
     visitorCode: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kameleoon/javascript-sdk-core",
-  "version": "5.14.4",
+  "version": "5.15.0",
   "description": "Kameleoon JS SDK Core",
   "main": "dist/javascript-sdk-core.cjs.js",
   "module": "dist/javascript-sdk-core.es.js",