@kameleoon/javascript-sdk-core 0.0.3 → 1.0.0

package/README.md

@@ -1,8 +1,12 @@
-# Kameleoon JS SDK CORE
+# Kameleoon JavaScript SDK Core
 
-Our SDK gives you the possibility of running experiments and activating feature flags on your front-end JavaScript application. Integrating our SDK into your web-application is easy, and its footprint (in terms of memory and network usage) is low.
+This package is a core implementation shared between Kameleoon JavaScript Related SDKs.
+It's not meant for direct usage.
 
 ## Learn more
 
-You can refer to the [SDK reference](https://developers.kameleoon.com/javascript-sdk.html#reference) to check out all possible features of the SDK. Also make sure you check out our [Getting started tutorial](https://developers.kameleoon.com/javascript-sdk.html#getting-started) which we have prepared to walk you through the installation and implementation.
+- [JavaScript SDK](https://developers.kameleoon.com/javascript-sdk.html)
+- [NodeJS SDK](https://developers.kameleoon.com/nodejs-sdk.html)
+- [React/React Native SDK](https://developers.kameleoon.com/react-js-sdk.html)
+
 

package/dist/campaignConfiguration/campaignConfiguration.d.ts

@@ -0,0 +1,46 @@
+import { Result } from 'ts-res';
+import { KameleoonError } from '../kameleoonError/kameleoonError';
+import { CampaignConfigurationParametersType, ConfigurationType, ExperimentItemType, FeatureFlagType } from './types';
+import { KameleoonDataType } from '../kameleoonData';
+import { TargetingDataType } from '../targeting';
+import { IExternalEventSourceConstructor } from '../eventSource';
+interface ICampaignConfiguration {
+    initialize: (eventSource: IExternalEventSourceConstructor) => Promise<Result<void, KameleoonError>>;
+    addTargetingData: (visitorCode: string, ...data: KameleoonDataType[]) => Result<void, KameleoonError>;
+    getUnsentData: (visitorCode: string) => KameleoonDataType[];
+    clearUnsentData: (visitorCode: string) => void;
+    onConfigurationUpdate: (callback: () => void) => void;
+    readonly experiments: ExperimentItemType[];
+    readonly storedTargetingData: TargetingDataType;
+    readonly featureFlags: FeatureFlagType[];
+    readonly configuration: ConfigurationType;
+}
+export declare class CampaignConfiguration implements ICampaignConfiguration {
+    private configurationUpdateCallback?;
+    private updateConfigurationIntervalId;
+    private targetingDataIntervalId;
+    private unsentTargetingData;
+    private targetingData;
+    private configurationData;
+    private settings;
+    private lastUpdate;
+    private storage;
+    private requester;
+    private eventSource?;
+    constructor({ settings, storage, requester, }: CampaignConfigurationParametersType);
+    initialize(externalEventSource: IExternalEventSourceConstructor): Promise<Result<void, KameleoonError>>;
+    addTargetingData(visitorCode: string, ...data: KameleoonDataType[]): Result<void, KameleoonError>;
+    getUnsentData(visitorCode: string): KameleoonDataType[];
+    clearUnsentData(visitorCode: string): void;
+    onConfigurationUpdate(callback: () => void): void;
+    get storedTargetingData(): TargetingDataType;
+    get experiments(): ExperimentItemType[];
+    get featureFlags(): FeatureFlagType[];
+    get configuration(): ConfigurationType;
+    private checkShouldUpdate;
+    private cleanupOutdatedTargetingData;
+    private readStorageData;
+    private updateClientConfiguration;
+    private updateStorageData;
+}
+export {};

package/dist/campaignConfiguration/campaignConfiguration.js

@@ -0,0 +1,217 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignConfiguration = void 0;
+const ts_res_1 = require("ts-res");
+const constants_1 = require("./constants");
+const eventSource_1 = require("../eventSource");
+class CampaignConfiguration {
+    constructor({ settings, storage, requester, }) {
+        this.updateConfigurationIntervalId = null;
+        this.targetingDataIntervalId = null;
+        this.unsentTargetingData = {};
+        this.targetingData = constants_1.DEFAULT_CAMPAIGN_CONFIGURATION.targetingData;
+        this.configurationData = constants_1.DEFAULT_CAMPAIGN_CONFIGURATION.configurationData;
+        this.requester = requester;
+        this.settings = settings;
+        this.lastUpdate = new Date();
+        this.storage = storage;
+        this.readStorageData();
+        // --- Note ---
+        // We can not make delayed code execution recoverable, as it might lead
+        // to targeting data storage size overflow
+        try {
+            this.targetingDataIntervalId = setInterval(() => this.cleanupOutdatedTargetingData.call(this, this.targetingData), constants_1.CLEANUP_TARGETING_DATA_INTERVAL);
+        }
+        catch (err) {
+            if (this.targetingDataIntervalId) {
+                clearInterval(this.targetingDataIntervalId);
+            }
+            throw err;
+        }
+    }
+    initialize(externalEventSource) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const shouldUpdate = this.checkShouldUpdate();
+            // --- Initial data fetch ---
+            if (shouldUpdate) {
+                const updateResult = yield this.updateClientConfiguration();
+                if (!updateResult.ok) {
+                    return updateResult;
+                }
+            }
+            // --- Note ---
+            // Interval is cleaned up in case real time update
+            // was activated while initialized client already exists
+            if (this.configurationData.configuration.realTimeUpdate) {
+                if (this.updateConfigurationIntervalId) {
+                    clearInterval(this.updateConfigurationIntervalId);
+                }
+                this.eventSource = new eventSource_1.ExternalEventSource(this.settings.siteCode, externalEventSource);
+                const updateEventCallback = (_timeStamp) => {
+                    this.updateClientConfiguration();
+                    if (this.configurationUpdateCallback) {
+                        this.configurationUpdateCallback();
+                    }
+                };
+                this.eventSource.open(updateEventCallback);
+            }
+            else {
+                // --- Note ---
+                // Event Source is cleaned up in case real time update
+                // was disabled while initialized client already exists
+                if (this.eventSource) {
+                    this.eventSource.close();
+                }
+                if (this.updateConfigurationIntervalId) {
+                    clearInterval(this.updateConfigurationIntervalId);
+                }
+                // --- Note ---
+                // Same as targeting data interval we don't want to make failed configuration
+                // retrieval recoverable
+                try {
+                    this.updateConfigurationIntervalId = setInterval(this.updateClientConfiguration.bind(this), this.settings.updateInterval);
+                }
+                catch (err) {
+                    if (this.updateConfigurationIntervalId) {
+                        clearInterval(this.updateConfigurationIntervalId);
+                    }
+                    throw err;
+                }
+            }
+            return (0, ts_res_1.Ok)();
+        });
+    }
+    addTargetingData(visitorCode, ...data) {
+        if (!(visitorCode in this.targetingData)) {
+            this.targetingData[visitorCode] = [];
+        }
+        data.forEach((dataItem) => {
+            // --- Note ---
+            // Previous check excludes the failure possibility
+            this.targetingData[visitorCode].push({
+                data: dataItem.data,
+                lastActivityTime: Date.now(),
+            });
+        });
+        // --- Note ---
+        // `targetingData` should not refresh `lastUpdate` time
+        const result = this.updateStorageData(this.lastUpdate);
+        if (result.ok) {
+            data.forEach((dataItem) => {
+                if (!this.unsentTargetingData[visitorCode]) {
+                    this.unsentTargetingData[visitorCode] = [];
+                }
+                this.unsentTargetingData[visitorCode].push(dataItem);
+            });
+        }
+        return result;
+    }
+    getUnsentData(visitorCode) {
+        const unsentDataItem = this.unsentTargetingData[visitorCode];
+        if (!unsentDataItem) {
+            return [];
+        }
+        return unsentDataItem;
+    }
+    clearUnsentData(visitorCode) {
+        this.unsentTargetingData[visitorCode] = [];
+    }
+    onConfigurationUpdate(callback) {
+        this.configurationUpdateCallback = callback;
+    }
+    get storedTargetingData() {
+        return this.targetingData;
+    }
+    get experiments() {
+        return this.configurationData.experiments;
+    }
+    get featureFlags() {
+        return this.configurationData.featureFlags;
+    }
+    get configuration() {
+        return this.configurationData.configuration;
+    }
+    checkShouldUpdate() {
+        const { featureFlags, experiments, configuration } = this.configurationData;
+        const { updateInterval } = this.settings;
+        if (!featureFlags.length && !experiments.length) {
+            return true;
+        }
+        if (configuration.realTimeUpdate) {
+            return true;
+        }
+        const lastUpdateTime = this.lastUpdate.getTime();
+        const updateWindowEdge = Date.now() - updateInterval;
+        return lastUpdateTime < updateWindowEdge;
+    }
+    cleanupOutdatedTargetingData(data) {
+        const currentTime = Date.now();
+        const resultTargetingData = Object.assign({}, data);
+        for (const [key, value] of Object.entries(resultTargetingData)) {
+            if (value) {
+                const resultValue = value.filter((item) => {
+                    const isDataExpired = item.lastActivityTime + constants_1.SESSION_DURATION < currentTime;
+                    return isDataExpired;
+                });
+                resultTargetingData[key] = resultValue;
+            }
+            else {
+                resultTargetingData[key] = [];
+            }
+        }
+        this.targetingData = resultTargetingData;
+        // --- Note ---
+        // `targetingData` should not refresh `lastUpdate` time
+        this.updateStorageData(this.lastUpdate).throw();
+    }
+    readStorageData() {
+        const result = this.storage.read();
+        if (result.ok) {
+            const { kameleoonTargetingData, kameleoonConfiguration, lastUpdate } = result.data;
+            this.configurationData = kameleoonConfiguration;
+            this.targetingData = kameleoonTargetingData;
+            this.lastUpdate = new Date(Date.parse(lastUpdate));
+        }
+    }
+    updateClientConfiguration(timeStamp) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const clientConfigurationResult = yield this.requester.getClientConfiguration(timeStamp);
+            if (!clientConfigurationResult.ok) {
+                return clientConfigurationResult;
+            }
+            // --- Note ---
+            // `featureFlags` field is ommited (v1)
+            // instead `featureFlagConfigurations` is used (v2)
+            const { configuration, experiments, featureFlagConfigurations } = clientConfigurationResult.data;
+            this.configurationData = {
+                configuration,
+                experiments,
+                featureFlags: featureFlagConfigurations,
+            };
+            const result = this.updateStorageData(new Date());
+            if (!result.ok) {
+                return result;
+            }
+            return (0, ts_res_1.Ok)(true);
+        });
+    }
+    updateStorageData(lastUpdate) {
+        const data = {
+            kameleoonTargetingData: this.targetingData,
+            kameleoonConfiguration: this.configurationData,
+            lastUpdate: lastUpdate.toString(),
+        };
+        return this.storage.write(data);
+    }
+}
+exports.CampaignConfiguration = CampaignConfiguration;
+//# sourceMappingURL=campaignConfiguration.js.map

package/dist/campaignConfiguration/campaignConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaignConfiguration.js","sourceRoot":"","sources":["../../src/campaignConfiguration/campaignConfiguration.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAoC;AAGpC,2CAIqB;AAarB,gDAIwB;AAmBxB,MAAa,qBAAqB;IAehC,YAAY,EACV,QAAQ,EACR,OAAO,EACP,SAAS,GAC2B;QAjB9B,kCAA6B,GAAwB,IAAI,CAAC;QAC1D,4BAAuB,GAAwB,IAAI,CAAC;QACpD,wBAAmB,GAA4B,EAAE,CAAC;QAClD,kBAAa,GACnB,0CAA8B,CAAC,aAAa,CAAC;QACvC,sBAAiB,GACvB,0CAA8B,CAAC,iBAAiB,CAAC;QAYjD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvB,eAAe;QACf,uEAAuE;QACvE,0CAA0C;QAC1C,IAAI;YACF,IAAI,CAAC,uBAAuB,GAAG,WAAW,CACxC,GAAG,EAAE,CAAC,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,EACtE,2CAA+B,CAChC,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,IAAI,CAAC,uBAAuB,EAAE;gBAChC,aAAa,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;aAC7C;YAED,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAEY,UAAU,CACrB,mBAAoD;;YAEpD,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAE9C,6BAA6B;YAC7B,IAAI,YAAY,EAAE;gBAChB,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBAE5D,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE;oBACpB,OAAO,YAAY,CAAC;iBACrB;aACF;YAED,eAAe;YACf,kDAAkD;YAClD,wDAAwD;YACxD,IAAI,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,cAAc,EAAE;gBACvD,IAAI,IAAI,CAAC,6BAA6B,EAAE;oBACtC,aAAa,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;iBACnD;gBAED,IAAI,CAAC,WAAW,GAAG,IAAI,iCAAmB,CACxC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EACtB,mBAAmB,CACpB,CAAC;gBAEF,MAAM,mBAAmB,GAAG,CAAC,UAAkB,EAAE,EAAE;oBACjD,IAAI,CAAC,yBAAyB,EAAE,CAAC;oBAEjC,IAAI,IAAI,CAAC,2BAA2B,EAAE;wBACpC,IAAI,CAAC,2BAA2B,EAAE,CAAC;qBACpC;gBACH,CAAC,CAAC;gBAEF,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;aAC5C;iBAAM;gBACL,eAAe;gBACf,sDAAsD;gBACtD,uDAAuD;gBACvD,IAAI,IAAI,CAAC,WAAW,EAAE;oBACpB,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;iBAC1B;gBAED,IAAI,IAAI,CAAC,6BAA6B,EAAE;oBACtC,aAAa,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;iBACnD;gBAED,eAAe;gBACf,6EAA6E;gBAC7E,wBAAwB;gBACxB,IAAI;oBACF,IAAI,CAAC,6BAA6B,GAAG,WAAW,CAC9C,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,EACzC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAC7B,CAAC;iBACH;gBAAC,OAAO,GAAG,EAAE;oBACZ,IAAI,IAAI,CAAC,6BAA6B,EAAE;wBACtC,aAAa,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;qBACnD;oBAED,MAAM,GAAG,CAAC;iBACX;aACF;YAED,OAAO,IAAA,WAAE,GAAE,CAAC;QACd,CAAC;KAAA;IAEM,gBAAgB,CACrB,WAAmB,EACnB,GAAG,IAAyB;QAE5B,IAAI,CAAC,CAAC,WAAW,IAAI,IAAI,CAAC,aAAa,CAAC,EAAE;YACxC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;SACtC;QAED,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YACxB,eAAe;YACf,kDAAkD;YACjD,IAAI,CAAC,aAAa,CAAC,WAAW,CAA6B,CAAC,IAAI,CAAC;gBAChE,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,gBAAgB,EAAE,IAAI,CAAC,GAAG,EAAE;aAC7B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,eAAe;QACf,uDAAuD;QACvD,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEvD,IAAI,MAAM,CAAC,EAAE,EAAE;YACb,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACxB,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,EAAE;oBAC1C,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;iBAC5C;gBAED,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,aAAa,CAAC,WAAmB;QACtC,MAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAE7D,IAAI,CAAC,cAAc,EAAE;YACnB,OAAO,EAAE,CAAC;SACX;QAED,OAAO,cAAc,CAAC;IACxB,CAAC;IAEM,eAAe,CAAC,WAAmB;QACxC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;IAC7C,CAAC;IAEM,qBAAqB,CAAC,QAAoB;QAC/C,IAAI,CAAC,2BAA2B,GAAG,QAAQ,CAAC;IAC9C,CAAC;IAED,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC;IAC5C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC;IAC7C,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAC9C,CAAC;IAEO,iBAAiB;QACvB,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAC5E,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEzC,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YAC/C,OAAO,IAAI,CAAC;SACb;QAED,IAAI,aAAa,CAAC,cAAc,EAAE;YAChC,OAAO,IAAI,CAAC;SACb;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QACjD,MAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc,CAAC;QAErD,OAAO,cAAc,GAAG,gBAAgB,CAAC;IAC3C,CAAC;IAEO,4BAA4B,CAAC,IAAuB;QAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC/B,MAAM,mBAAmB,qBAA2B,IAAI,CAAE,CAAC;QAE3D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE;YAC9D,IAAI,KAAK,EAAE;gBACT,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;oBACxC,MAAM,aAAa,GACjB,IAAI,CAAC,gBAAgB,GAAG,4BAAgB,GAAG,WAAW,CAAC;oBAEzD,OAAO,aAAa,CAAC;gBACvB,CAAC,CAAC,CAAC;gBAEH,mBAAmB,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;aACxC;iBAAM;gBACL,mBAAmB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;aAC/B;SACF;QAED,IAAI,CAAC,aAAa,GAAG,mBAAmB,CAAC;QACzC,eAAe;QACf,uDAAuD;QACvD,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;IAClD,CAAC;IAEO,eAAe;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,MAAM,CAAC,EAAE,EAAE;YACb,MAAM,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,UAAU,EAAE,GAClE,MAAM,CAAC,IAAI,CAAC;YAEd,IAAI,CAAC,iBAAiB,GAAG,sBAAsB,CAAC;YAChD,IAAI,CAAC,aAAa,GAAG,sBAAsB,CAAC;YAC5C,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;SACpD;IACH,CAAC;IAEa,yBAAyB,CACrC,SAAkB;;YAElB,MAAM,yBAAyB,GAC7B,MAAM,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;YAEzD,IAAI,CAAC,yBAAyB,CAAC,EAAE,EAAE;gBACjC,OAAO,yBAAyB,CAAC;aAClC;YAED,eAAe;YACf,uCAAuC;YACvC,mDAAmD;YACnD,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,yBAAyB,EAAE,GAC7D,yBAAyB,CAAC,IAAI,CAAC;YAEjC,IAAI,CAAC,iBAAiB,GAAG;gBACvB,aAAa;gBACb,WAAW;gBACX,YAAY,EAAE,yBAAyB;aACxC,CAAC;YAEF,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;YAElD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE;gBACd,OAAO,MAAM,CAAC;aACf;YAED,OAAO,IAAA,WAAE,EAAC,IAAI,CAAC,CAAC;QAClB,CAAC;KAAA;IAEO,iBAAiB,CAAC,UAAgB;QACxC,MAAM,IAAI,GAAmB;YAC3B,sBAAsB,EAAE,IAAI,CAAC,aAAa;YAC1C,sBAAsB,EAAE,IAAI,CAAC,iBAAiB;YAC9C,UAAU,EAAE,UAAU,CAAC,QAAQ,EAAE;SAClC,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF;AAnRD,sDAmRC"}

package/dist/campaignConfiguration/constants.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @constant default cleanup interval in millisecons
+ * */
+export declare const CLEANUP_TARGETING_DATA_INTERVAL: number;
+/**
+ * @constant default session duration in millisecons
+ * */
+export declare const SESSION_DURATION: number;
+export declare const DEFAULT_CAMPAIGN_CONFIGURATION: {
+    targetingData: {};
+    configurationData: {
+        experiments: never[];
+        featureFlags: never[];
+        configuration: {
+            realTimeUpdate: boolean;
+        };
+    };
+};

package/dist/campaignConfiguration/constants.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_CAMPAIGN_CONFIGURATION = exports.SESSION_DURATION = exports.CLEANUP_TARGETING_DATA_INTERVAL = void 0;
+const types_1 = require("../types");
+/**
+ * @constant default cleanup interval in millisecons
+ * */
+exports.CLEANUP_TARGETING_DATA_INTERVAL = 30 * types_1.Milliseconds.Minute;
+/**
+ * @constant default session duration in millisecons
+ * */
+exports.SESSION_DURATION = 30 * types_1.Milliseconds.Minute;
+exports.DEFAULT_CAMPAIGN_CONFIGURATION = {
+    targetingData: {},
+    configurationData: {
+        experiments: [],
+        featureFlags: [],
+        configuration: {
+            realTimeUpdate: false,
+        },
+    },
+};
+//# sourceMappingURL=constants.js.map

package/dist/campaignConfiguration/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/campaignConfiguration/constants.ts"],"names":[],"mappings":";;;AAAA,oCAAwC;AAExC;;KAEK;AACQ,QAAA,+BAA+B,GAAG,EAAE,GAAG,oBAAY,CAAC,MAAM,CAAC;AACxE;;KAEK;AACQ,QAAA,gBAAgB,GAAG,EAAE,GAAG,oBAAY,CAAC,MAAM,CAAC;AAE5C,QAAA,8BAA8B,GAAG;IAC5C,aAAa,EAAE,EAAE;IACjB,iBAAiB,EAAE;QACjB,WAAW,EAAE,EAAE;QACf,YAAY,EAAE,EAAE;QAChB,aAAa,EAAE;YACb,cAAc,EAAE,KAAK;SACtB;KACF;CACF,CAAC"}

package/dist/campaignConfiguration/index.d.ts

@@ -0,0 +1,2 @@
+export { ConfigurationDataType, CampaignConfigurationType, VariationByExpositionType, FeatureVariableType, ExperimentItemType, RespoolTimeType, FeatureFlagType, RuleItemType, JSONValue, RuleType, JSONType, } from './types';
+export { CampaignConfiguration } from './campaignConfiguration';

package/dist/campaignConfiguration/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CampaignConfiguration = exports.RuleType = void 0;
+var types_1 = require("./types");
+Object.defineProperty(exports, "RuleType", { enumerable: true, get: function () { return types_1.RuleType; } });
+var campaignConfiguration_1 = require("./campaignConfiguration");
+Object.defineProperty(exports, "CampaignConfiguration", { enumerable: true, get: function () { return campaignConfiguration_1.CampaignConfiguration; } });
+//# sourceMappingURL=index.js.map

package/dist/campaignConfiguration/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/campaignConfiguration/index.ts"],"names":[],"mappings":";;;AAAA,iCAYiB;AAFf,iGAAA,QAAQ,OAAA;AAGV,iEAAgE;AAAvD,8HAAA,qBAAqB,OAAA"}

package/dist/campaignConfiguration/types.d.ts

@@ -0,0 +1,126 @@
+import { ClientSettingsType } from '../clientSettings';
+import { KameleoonDataType } from '../kameleoonData';
+import { Requester } from '../requester';
+import { ClientDataType, IStorage } from '../storage';
+import { SegmentType, TargetingDataType } from '../targeting';
+import { VariableType } from '../types';
+export type ScheduleType = {
+    dateStart: string;
+    dateEnd: string;
+};
+export type JSONValue = string | number | boolean | {
+    [x: string]: JSONValue;
+} | JSONValue[];
+export type JSONType = Record<string | number | symbol, JSONValue> | null;
+export declare enum ExperimentType {
+    CLASSIC = "CLASSIC",
+    SERVER_SIDE = "SERVER_SIDE",
+    DEVELOPER = "DEVELOPER",
+    MVT = "MVT",
+    HYBRID = "HYBRID"
+}
+export declare enum RuleType {
+    PROGRESSIVE_DELIVERY = "PROGRESSIVE_DELIVERY",
+    TARGETED_DELIVERY = "TARGETED_DELIVERY",
+    EXPERIMENTATION = "EXPERIMENTATION"
+}
+export declare enum FeatureFlagSdkLanguageType {
+    ANDROID = "ANDROID",
+    SWIFT = "SWIFT",
+    JAVA = "JAVA",
+    CSHARP = "CSHARP",
+    NODEJS = "NODEJS",
+    PHP = "PHP",
+    RUBY = "RUBY",
+    GO = "GO",
+    FLUTTER = "FLUTTER",
+    REACTJS = "REACTJS"
+}
+export declare enum FeatureStatus {
+    ACTIVATED = "ACTIVATED",
+    DEACTIVATED = "DEACTIVATED",
+    SCHEDULED = "SCHEDULED"
+}
+export type ExperimentItemType = {
+    id: string;
+    name: string;
+    type: ExperimentType;
+    siteId: string;
+    siteCode: string;
+    status: ExperimentStatus;
+    siteEnabled: boolean;
+    variations: ExperimentVariationType[];
+    deviations: DeviationType[];
+    respoolTime: RespoolTimeType[];
+    segment: SegmentType | null;
+};
+export type ExperimentVariationType = {
+    id: string;
+    customJson: JSONType;
+};
+export type DeviationType = {
+    variationId: string;
+    value: number;
+};
+export type RespoolTimeType = {
+    variationId: string;
+    value: number;
+};
+export declare enum ExperimentStatus {
+    DRAFT = "DRAFT",
+    ACTIVE = "ACTIVE",
+    PAUSED = "PAUSED",
+    SCHEDULED = "SCHEDULED",
+    STOPPED = "STOPPED",
+    USED_AS_PERSONALIZATION = "USED_AS_PERSONALIZATION",
+    DEVIATED = "DEVIATED"
+}
+export type FeatureFlagType = {
+    id: number;
+    featureKey: string;
+    variations: FeatureVariationType[];
+    defaultVariationKey: string;
+    rules: RuleItemType[];
+};
+export type FeatureVariationType = {
+    key: string;
+    variables: FeatureVariableType[];
+};
+export type FeatureVariableType = {
+    key: string;
+    type: VariableType;
+    value: string | number | boolean;
+};
+export type RuleItemType = {
+    type: RuleType;
+    order: number;
+    exposition: number;
+    experimentId: number | null;
+    variationByExposition: VariationByExpositionType[];
+    segment: SegmentType | null;
+};
+export type VariationByExpositionType = {
+    variationKey: string;
+    variationId: number | null;
+    exposition: number;
+};
+export type ConfigurationDataType = {
+    experiments: ExperimentItemType[];
+    featureFlags: FeatureFlagType[];
+    configuration: ConfigurationType;
+};
+export type ConfigurationType = {
+    realTimeUpdate: boolean;
+};
+export type CampaignConfigurationType = {
+    targetingData: TargetingDataType;
+    configurationData: ConfigurationDataType;
+};
+export type UnsentTargetingDataType = {
+    [visitorCode: string]: KameleoonDataType[];
+};
+export type CampaignConfigurationParametersType = {
+    settings: ClientSettingsType;
+    storage: IStorage<ClientDataType>;
+    requester: Requester;
+};

package/dist/campaignConfiguration/types.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExperimentStatus = exports.FeatureStatus = exports.FeatureFlagSdkLanguageType = exports.RuleType = exports.ExperimentType = void 0;
+var ExperimentType;
+(function (ExperimentType) {
+    ExperimentType["CLASSIC"] = "CLASSIC";
+    ExperimentType["SERVER_SIDE"] = "SERVER_SIDE";
+    ExperimentType["DEVELOPER"] = "DEVELOPER";
+    ExperimentType["MVT"] = "MVT";
+    ExperimentType["HYBRID"] = "HYBRID";
+})(ExperimentType = exports.ExperimentType || (exports.ExperimentType = {}));
+var RuleType;
+(function (RuleType) {
+    RuleType["PROGRESSIVE_DELIVERY"] = "PROGRESSIVE_DELIVERY";
+    RuleType["TARGETED_DELIVERY"] = "TARGETED_DELIVERY";
+    RuleType["EXPERIMENTATION"] = "EXPERIMENTATION";
+})(RuleType = exports.RuleType || (exports.RuleType = {}));
+var FeatureFlagSdkLanguageType;
+(function (FeatureFlagSdkLanguageType) {
+    FeatureFlagSdkLanguageType["ANDROID"] = "ANDROID";
+    FeatureFlagSdkLanguageType["SWIFT"] = "SWIFT";
+    FeatureFlagSdkLanguageType["JAVA"] = "JAVA";
+    FeatureFlagSdkLanguageType["CSHARP"] = "CSHARP";
+    FeatureFlagSdkLanguageType["NODEJS"] = "NODEJS";
+    FeatureFlagSdkLanguageType["PHP"] = "PHP";
+    FeatureFlagSdkLanguageType["RUBY"] = "RUBY";
+    FeatureFlagSdkLanguageType["GO"] = "GO";
+    FeatureFlagSdkLanguageType["FLUTTER"] = "FLUTTER";
+    FeatureFlagSdkLanguageType["REACTJS"] = "REACTJS";
+})(FeatureFlagSdkLanguageType = exports.FeatureFlagSdkLanguageType || (exports.FeatureFlagSdkLanguageType = {}));
+var FeatureStatus;
+(function (FeatureStatus) {
+    FeatureStatus["ACTIVATED"] = "ACTIVATED";
+    FeatureStatus["DEACTIVATED"] = "DEACTIVATED";
+    FeatureStatus["SCHEDULED"] = "SCHEDULED";
+})(FeatureStatus = exports.FeatureStatus || (exports.FeatureStatus = {}));
+var ExperimentStatus;
+(function (ExperimentStatus) {
+    ExperimentStatus["DRAFT"] = "DRAFT";
+    ExperimentStatus["ACTIVE"] = "ACTIVE";
+    ExperimentStatus["PAUSED"] = "PAUSED";
+    ExperimentStatus["SCHEDULED"] = "SCHEDULED";
+    ExperimentStatus["STOPPED"] = "STOPPED";
+    ExperimentStatus["USED_AS_PERSONALIZATION"] = "USED_AS_PERSONALIZATION";
+    ExperimentStatus["DEVIATED"] = "DEVIATED";
+})(ExperimentStatus = exports.ExperimentStatus || (exports.ExperimentStatus = {}));
+//# sourceMappingURL=types.js.map

package/dist/campaignConfiguration/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/campaignConfiguration/types.ts"],"names":[],"mappings":";;;AAqBA,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,6CAA2B,CAAA;IAC3B,yCAAuB,CAAA;IACvB,6BAAW,CAAA;IACX,mCAAiB,CAAA;AACnB,CAAC,EANW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAMzB;AAED,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,yDAA6C,CAAA;IAC7C,mDAAuC,CAAA;IACvC,+CAAmC,CAAA;AACrC,CAAC,EAJW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAInB;AAED,IAAY,0BAWX;AAXD,WAAY,0BAA0B;IACpC,iDAAmB,CAAA;IACnB,6CAAe,CAAA;IACf,2CAAa,CAAA;IACb,+CAAiB,CAAA;IACjB,+CAAiB,CAAA;IACjB,yCAAW,CAAA;IACX,2CAAa,CAAA;IACb,uCAAS,CAAA;IACT,iDAAmB,CAAA;IACnB,iDAAmB,CAAA;AACrB,CAAC,EAXW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAWrC;AAED,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,4CAA2B,CAAA;IAC3B,wCAAuB,CAAA;AACzB,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AA+BD,IAAY,gBAQX;AARD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;IACjB,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,uEAAmD,CAAA;IACnD,yCAAqB,CAAA;AACvB,CAAC,EARW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAQ3B"}

package/dist/clientSettings/clientSettings.d.ts

@@ -0,0 +1,12 @@
+import { SDKConfigurationType } from '../types';
+import { ClientSettingsType } from './types';
+export interface IClientSettings {
+    readonly settings: ClientSettingsType;
+}
+export declare class ClientSettings implements IClientSettings {
+    private updateInterval;
+    private environment;
+    private siteCode;
+    constructor(siteCode: string, configuration?: Partial<SDKConfigurationType>);
+    get settings(): ClientSettingsType;
+}

package/dist/clientSettings/clientSettings.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientSettings = void 0;
+const types_1 = require("../types");
+class ClientSettings {
+    constructor(siteCode, configuration) {
+        this.updateInterval = 30 * types_1.Milliseconds.Minute;
+        this.environment = null;
+        this.siteCode = siteCode;
+        if (configuration === null || configuration === void 0 ? void 0 : configuration.environment) {
+            this.environment = configuration.environment;
+        }
+        if (configuration === null || configuration === void 0 ? void 0 : configuration.updateInterval) {
+            if (configuration.updateInterval < 1) {
+                this.updateInterval = 1 * types_1.Milliseconds.Minute;
+            }
+            this.updateInterval = configuration.updateInterval * types_1.Milliseconds.Minute;
+        }
+    }
+    get settings() {
+        return {
+            updateInterval: this.updateInterval,
+            environment: this.environment,
+            siteCode: this.siteCode,
+        };
+    }
+}
+exports.ClientSettings = ClientSettings;
+//# sourceMappingURL=clientSettings.js.map

package/dist/clientSettings/clientSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientSettings.js","sourceRoot":"","sources":["../../src/clientSettings/clientSettings.ts"],"names":[],"mappings":";;;AAAA,oCAA2E;AAO3E,MAAa,cAAc;IAKzB,YAAY,QAAgB,EAAE,aAA6C;QAJnE,mBAAc,GAAW,EAAE,GAAG,oBAAY,CAAC,MAAM,CAAC;QAClD,gBAAW,GAAuB,IAAI,CAAC;QAI7C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,IAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,WAAW,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,aAAa,CAAC,WAAW,CAAC;SAC9C;QAED,IAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,cAAc,EAAE;YACjC,IAAI,aAAa,CAAC,cAAc,GAAG,CAAC,EAAE;gBACpC,IAAI,CAAC,cAAc,GAAG,CAAC,GAAG,oBAAY,CAAC,MAAM,CAAC;aAC/C;YAED,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC,cAAc,GAAG,oBAAY,CAAC,MAAM,CAAC;SAC1E;IACH,CAAC;IAED,IAAI,QAAQ;QACV,OAAO;YACL,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;IACJ,CAAC;CACF;AA5BD,wCA4BC"}

package/dist/clientSettings/index.d.ts

@@ -0,0 +1,2 @@
+export { ClientSettings } from './clientSettings';
+export { ClientSettingsType } from './types';

package/dist/clientSettings/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientSettings = void 0;
+var clientSettings_1 = require("./clientSettings");
+Object.defineProperty(exports, "ClientSettings", { enumerable: true, get: function () { return clientSettings_1.ClientSettings; } });
+//# sourceMappingURL=index.js.map

package/dist/clientSettings/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/clientSettings/index.ts"],"names":[],"mappings":";;;AAAA,mDAAkD;AAAzC,gHAAA,cAAc,OAAA"}

package/dist/clientSettings/types.d.ts

@@ -0,0 +1,6 @@
+import { Environment } from '../types';
+export type ClientSettingsType = {
+    updateInterval: number;
+    environment: Environment | null;
+    siteCode: string;
+};

package/dist/{interfaces/interfaces.js → clientSettings/types.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=interfaces.js.map
+//# sourceMappingURL=types.js.map

package/dist/clientSettings/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/clientSettings/types.ts"],"names":[],"mappings":""}

package/dist/constants.d.ts

@@ -1,17 +1,11 @@
-export declare enum Milliseconds {
-    Second = 1000,
-    Minute = 60000,
-    Hour = 3600000
-}
-export declare const DEFAULT_MILLISECONDS_BETWEEN_TARGETING_DATA_UPDATE: number;
-export declare const MINUTES_SESSION_DURATION: number;
-export declare const TARGETING_DATA_MAXIMUM_SIZE_BYTES = 500;
-export declare const EVENTS_URL = "https://events.kameleoon.com:8110/";
-export declare const API_SSX_URL = "https://api-ssx.kameleoon.com/";
-export declare const API_DATA_URL = "https://api-data.kameleoon.com/";
-export declare const CONFIGURATION_URL = "https://client-config.kameleoon.com/";
-export declare enum ConditionTypes {
-    CUSTOM_DATUM = "CUSTOM_DATUM",
-    EXCLUSIVE_EXPERIMENT = "EXCLUSIVE_EXPERIMENT",
-    TARGET_EXPERIMENT = "TARGET_EXPERIMENT"
+export declare const UNALLOCATED_VARIATION_ID = 0;
+export declare const OFF_VARIATION_KEY = "off";
+export declare const KAMELEOON_COOKIE_KEY = "kameleoonVisitorCode";
+export declare const VISITOR_CODE_LENGTH = 16;
+export declare enum Cookie {
+    PairsDelimiter = "; ",
+    KeyValueDelimiter = "=",
+    MaxAge = "MaxAge",
+    Path = "Path",
+    Domain = "Domain"
 }