@kameleoon/javascript-sdk-core 5.16.0 → 5.17.0

package/dist/kameleoonClient.d.ts

@@ -54,6 +54,8 @@ export declare class KameleoonClient implements IKameleoonClient {
     getDataFile(): DataFile;
     protected setUserConsent({ visitorCode, consent, setData, }: SetUserConsentParametersType): void;
     private updateConsentData;
+    private getLegalConsent;
+    private extractLegalConsent;
     protected _isConsentProvided(visitorCode: string): boolean;
     private _getFeatureVariables;
     private _getActiveFeatureVariations;

package/dist/kameleoonData/conversion.d.ts

@@ -1,6 +1,7 @@
 import { VisitType } from '../requester';
 import { ConversionDataType, ConversionParametersType, IKameleoonData } from './types';
 import { TrackingStatus } from '../types';
+import { CustomData } from '../kameleoonData/customData';
 /**
  * @class
  * Conversion - a class for creating an instance for conversion tracking
@@ -20,6 +21,17 @@ export declare class Conversion implements IKameleoonData {
     set _id(id: number);
     set _nonce(nonce: string);
     get url(): string;
+    /**
+     * @private
+     * @method metadata - an internal getter for a metadata of conversion
+     * */
+    get _metadata(): CustomData[] | undefined;
+    /**
+     * @private
+     * @method metadata - an internal setter for setting metadata of conversion
+     * @param {number} value - an index value
+     * */
+    set _metadata(value: CustomData[] | undefined);
     get data(): ConversionDataType;
     private _encodeMetadata;
     /**

package/dist/kameleoonData/customData.d.ts

@@ -6,12 +6,13 @@ import { TrackingStatus } from '../types';
  * CustomData - a class for creating an instance for user's custom data
  * */
 export declare class CustomData implements IKameleoonData {
+    static readonly UNDEFINED_INDEX = -1;
     private _status;
-    private index;
+    private _index;
     private value;
     private isIdentifier;
     private overwrite;
-    private name?;
+    private _name?;
     /**
      * @param {number|string} indexOrName - either:
      *   - `number` — an index of custom data (configured in *Advanced Tools* section of Kameleoon Application)
@@ -68,8 +69,23 @@ export declare class CustomData implements IKameleoonData {
     static _updateFromVisit(visit: VisitType, dataMap: Map<number, CustomData>): void;
     /**
      * @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: number);
+    set index(value: number);
+    /**
+     * @private
+     * @method index - an internal getter for index of custom data
+     * */
+    get index(): number;
+    /**
+     * @private
+     * @method name - an internal getter for a name of custom data
+     * */
+    get name(): string | undefined;
+    /**
+     * @private
+     * @method name - an internal getter for a name of custom data
+     * */
+    get values(): string[];
 }

package/dist/kameleoonData/dataManager.d.ts

@@ -11,7 +11,7 @@ import { DataInfoType, MappingIdentifierType } from '../storage/types';
 import { ExternalPackageInfoType } from '../sdkInfoTypes';
 import { StaticData } from '../kameleoonData/staticData';
 export interface IDataManager {
-    storeData(data: VisitorsDataType): Result<void, KameleoonError>;
+    storeData(data: VisitorsDataType, extendTtl: boolean): Result<void, KameleoonError>;
     storeTrackedData(data: VisitorsDataType): void;
     getTree(segment: SegmentType): Tree;
     clearTrees(): void;
@@ -45,7 +45,7 @@ export declare class DataManager implements IDataManager {
     getPendingData(visitorCode: string): KameleoonDataType[];
     private getDataFromRaw;
     storeTrackedData(data: VisitorsDataType): void;
-    storeData(data: VisitorsDataType): Result<void, KameleoonError>;
+    storeData(data: VisitorsDataType, extendTtl: boolean): Result<void, KameleoonError>;
     storeData(visitorCode: string, ...data: KameleoonDataType[]): Result<void, KameleoonError>;
     getTree(segment: SegmentType): Tree;
     clearTrees(): void;
@@ -60,6 +60,7 @@ export declare class DataManager implements IDataManager {
     private mutUpdateTargetingData;
     private cleanupData;
     private processCustomData;
+    private trySetCustomDataIndexByName;
     get unsentDataVisitors(): string[];
     get identifierCustomDataIndex(): number | null;
     get trees(): Map<string, Tree>;

package/dist/kameleoonData/dataProcessor.d.ts

@@ -3,7 +3,7 @@ import { DereferenceTargetingDataResultType, MutAddUnsentDataType, MutUpdateData
 import { DataInfoType } from '../storage';
 import { ExternalPackageInfoType } from '../sdkInfoTypes';
 interface IDataProcessor {
-    mutUpdateData({ visitorCode, mutData, dataItem, }: MutUpdateDataParametersType): number;
+    mutUpdateData({ visitorCode, mutData, dataItem, extendTtl, }: MutUpdateDataParametersType): number | undefined;
     mutCleanupData(mutData: TargetingDataType, infoData: DataInfoType): number | null;
     createReference({ mutData, visitorCode, linkedVisitor, infoData, }: ReferenceParametersType): void;
     dereferenceData(data: TargetingDataType, visitorCode: string): DereferenceTargetingDataResultType;
@@ -13,7 +13,7 @@ export declare class DataProcessor implements IDataProcessor {
     private cleanupInterval;
     private packageInfo;
     constructor(cleanupInterval: number | null | undefined, packageInfo: ExternalPackageInfoType);
-    mutUpdateData({ infoData, visitorCode, mutData, dataItem, }: MutUpdateDataParametersType): number;
+    mutUpdateData({ infoData, visitorCode, mutData, dataItem, extendTtl, }: MutUpdateDataParametersType): number | undefined;
     mutCleanupData(mutData: TargetingDataType, infoData: DataInfoType): number | null;
     mutAddUnsentData({ mutData, visitorCode, dataType, }: MutAddUnsentDataType): void;
     createReference({ mutData, visitorCode, linkedVisitor, }: ReferenceParametersType): void;

package/dist/kameleoonData/types.d.ts

@@ -8,7 +8,7 @@ import { Personalization } from '../kameleoonData/personalization';
 import { CBScores } from '../kameleoonData/cbScores';
 import { TargetedSegment } from '../kameleoonData/targetedSegment';
 export type FieldParametersType = {
-    expirationTime: number;
+    expirationTime?: number;
     key: KameleoonData;
     value: BrowserDataType | CookieDataType | DeviceDataType | GeolocationDataType | OperatingSystemDataType | UserAgentDataType | VisitsDataType;
     visitorCode: string;
@@ -20,7 +20,7 @@ export type VisitorProcessorParametersType = {
     visitorCode: string;
 };
 export type NestedFieldParametersType = {
-    expirationTime: number;
+    expirationTime?: number;
     visitorCode: string;
     key: KameleoonData.CustomData | KameleoonData.PageView | KameleoonData.Conversion | KameleoonData.Personalization | KameleoonData.TargetedSegment;
     nestedKey: string;
@@ -135,7 +135,7 @@ export declare enum KameleoonData {
 type CommonUpdateParametersType = {
     mutData: DereferencedTargetingDataType;
     visitorCode: string;
-    expirationTime: number;
+    expirationTime?: number;
 };
 export type UpdateCustomDataParametersType = {
     customData: CustomData;
@@ -169,12 +169,14 @@ export type MutUpdateDataParametersType = {
     mutData: TargetingDataType;
     dataItem: KameleoonDataType;
     visitorCode: string;
+    extendTtl: boolean;
 };
 export type MutUpdateTargetingDataParametersType = {
     visitorCode: string;
     infoData: DataInfoType;
     kameleoonData: KameleoonDataType[];
     targetingData: TargetingDataType;
+    extendTtl: boolean;
 };
 export type ReferenceParametersType = {
     mutData: TargetingDataType;

package/dist/requester/constants.d.ts

@@ -1,5 +1,5 @@
 import { DomainsType, EventType, ParameterType, QueryType, StrictEventTypeRecord, StrictFirstParameterRecord, StrictParameterRecord, StrictQueryRecord, StrictTrackingRecord, TrackingType } from './types';
-export declare const NUMBER_OF_RETRIES = 2;
+export declare const NUMBER_OF_RETRIES = 1;
 export declare enum Header {
     UserAgent = "User-Agent",
     ContentType = "Content-Type",

package/dist/requester/urlProvider.d.ts

@@ -17,6 +17,7 @@ export declare class UrlProvider implements IUrlProvider {
     private packageInfo?;
     initialize({ domain, siteCode, packageInfo, environment, }: UrlProviderInitializeParamsType): void;
     set dataApiDomain(domain: string);
+    get dataApiDomain(): string;
     getClientConfigurationUrl(timeStamp?: number): string;
     getEventSourceUrl(): string;
     getRemoteDataUrl(key: string): string;

package/dist/storage/index.d.ts

@@ -2,4 +2,4 @@ export { KameleoonStorageKey, VISIT_DURATION } from './constants';
 export { DataStorage } from './storage';
 export { IntegrityChecker } from './integrityChecker';
 export { StorageCleanupManager } from './storageCleanupManager';
-export { ClientDataType, TrackingDataType, VariationDataType, ConsentDataType, DataInfoType, StorageDataType, FeatureFlagVariationsType, IStorage, IExternalStorage, } from './types';
+export { ClientDataType, TrackingDataType, VariationDataType, StorageConsentDataType, DataInfoType, StorageDataType, FeatureFlagVariationsType, IStorage, IExternalStorage, } from './types';

package/dist/storage/types.d.ts

@@ -76,10 +76,18 @@ export type ForcedVariationDataType = {
         [featureKey: string]: ForcedFeatureVariationType;
     };
 };
-export type ConsentDataType = {
-    [visitorCode: string]: boolean | {
-        consent: boolean;
-    };
+export declare enum LegalConsent {
+    Unknown = 0,
+    Given = 1,
+    NotGiven = 2
+}
+export type LegalConsentDataType = boolean | {
+    consent: LegalConsent;
+} | {
+    consent: boolean;
+};
+export type StorageConsentDataType = {
+    [visitorCode: string]: LegalConsentDataType;
 };
 export type ScheduledVisitorsType = {
     [visitorCode: string]: {
@@ -94,7 +102,7 @@ export type TrackingDataType = {
  *
  * `string` represents visitor code storage with only one string value
  * */
-export type StorageDataType = ClientDataType | TargetingDataType | TrackingDataType | VariationDataType | ConsentDataType | DataInfoType | string;
+export type StorageDataType = ClientDataType | TargetingDataType | TrackingDataType | VariationDataType | StorageConsentDataType | DataInfoType | string;
 /**
  * @interface an interface of External Storage which must be implemented to be used as external storage an SDK
  * */

package/dist/variationConfiguration/types.d.ts

@@ -3,6 +3,7 @@ import { DataManager } from '../kameleoonData';
 import { KameleoonVisitorDataType } from '../kameleoonData/types';
 import { TrackingStatus } from '../types';
 import { ExternalPackageInfoType } from '../sdkInfoTypes';
+import { LegalConsent } from '../storage/types';
 export type UpdateDataStatusParametersType = {
     visitorCode: string;
     experimentIdList: string[];
@@ -27,6 +28,7 @@ export type GetVariationParametersType = {
     packageInfo: ExternalPackageInfoType;
     clientConfiguration: ClientConfiguration;
     dataManager: DataManager;
+    legalConsent: LegalConsent;
 };
 export type BaseVariationDataType = {
     experimentId: number;

package/dist/variationConfiguration/variationConfiguration.d.ts

@@ -63,7 +63,7 @@ export declare class VariationConfiguration implements IVariationConfiguration {
     getVisitorsWithUnsentData(): string[];
     getPendingData(visitorCode: string): BaseVariationDataType[];
     getStoredVariations(visitorCode: string): Result<FeatureFlagVariationsType, KameleoonError>;
-    getVariation({ visitorCode, visitorIdentifier, featureFlag, targetingData, packageInfo, clientConfiguration, dataManager, track, withAssignment, }: GetVariationParametersType): Result<FeatureFlagVariationType, KameleoonError>;
+    getVariation({ visitorCode, visitorIdentifier, featureFlag, targetingData, packageInfo, clientConfiguration, dataManager, legalConsent, track, withAssignment, }: GetVariationParametersType): Result<FeatureFlagVariationType, KameleoonError>;
     private createAndSaveForcedTargetedVariation;
     updateStoredVariations(visitorCode: string, variationData: FeatureFlagVariationsType): Result<void, KameleoonError>;
     private getVariationData;

package/package.json

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