@kameleoon/react-sdk 5.0.0 → 6.1.0

package/dist/kameleoonUtils/browserUtils.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @class
+ * BrowserUtils - a class with containing a number of static helper methods
+ * */
+export declare class BrowserUtils {
+    /**
+     * @method getVisitorCode obtains visitor code from the browser cookie, if the visitor code doesn't yet exist generates a random visitor code (or uses a provided default) and sets a new visitor code to cookie
+     * @param {string} domain domain which cookie belongs to
+     * @param {string | undefined} defaultVisitorCode visitor code to be used in case there is no visitor code in cookies Note: if not passed visitor code will be randomly generated
+     * @returns {string} result visitor code
+     * */
+    static getVisitorCode(domain: string, defaultVisitorCode?: string): string;
+}

package/dist/kameleoonUtils/browserUtils.js

@@ -0,0 +1,72 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserUtils = void 0;
+var javascript_sdk_core_1 = require("@kameleoon/javascript-sdk-core");
+// --- Note ---
+// Extra class is created:
+// - To be able to enforce abstract `getVisitorCode` method
+// - To be able to use extended methods while `KameleoonUtils` iself only operates on static methods
+// - To keep similar parameters object on inner implementation and dispers it for proprietary implementations
+var KameleoonUtilsConstructor = /** @class */ (function (_super) {
+    __extends(KameleoonUtilsConstructor, _super);
+    function KameleoonUtilsConstructor() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    KameleoonUtilsConstructor.prototype.getVisitorCode = function (_a) {
+        var domain = _a.domain, defaultVisitorCode = _a.defaultVisitorCode;
+        var cookie = document.cookie;
+        var visitorCodeResult = this.getCookieVisitorCode(cookie);
+        if (visitorCodeResult.ok && visitorCodeResult.data) {
+            return visitorCodeResult.data;
+        }
+        var visitorCode = defaultVisitorCode || this.generateRandomString(javascript_sdk_core_1.VISITOR_CODE_LENGTH);
+        var resultCookie = this.getResultCookie({ domain: domain, visitorCode: visitorCode });
+        // --- Note ---
+        // - Browser automatically adds new cookie in the end (without overwrite)
+        // - Only one key-value pair can be added at a time
+        resultCookie.split(javascript_sdk_core_1.Cookie.PairsDelimiter).forEach(function (item) {
+            document.cookie = item;
+        });
+        return visitorCode;
+    };
+    return KameleoonUtilsConstructor;
+}(javascript_sdk_core_1.KameleoonCoreUtils));
+/**
+ * @class
+ * BrowserUtils - a class with containing a number of static helper methods
+ * */
+var BrowserUtils = /** @class */ (function () {
+    function BrowserUtils() {
+    }
+    /**
+     * @method getVisitorCode obtains visitor code from the browser cookie, if the visitor code doesn't yet exist generates a random visitor code (or uses a provided default) and sets a new visitor code to cookie
+     * @param {string} domain domain which cookie belongs to
+     * @param {string | undefined} defaultVisitorCode visitor code to be used in case there is no visitor code in cookies Note: if not passed visitor code will be randomly generated
+     * @returns {string} result visitor code
+     * */
+    BrowserUtils.getVisitorCode = function (domain, defaultVisitorCode) {
+        var kameleoonUtilsConstructor = new KameleoonUtilsConstructor();
+        return kameleoonUtilsConstructor.getVisitorCode({
+            domain: domain,
+            defaultVisitorCode: defaultVisitorCode,
+        });
+    };
+    return BrowserUtils;
+}());
+exports.BrowserUtils = BrowserUtils;
+//# sourceMappingURL=browserUtils.js.map

package/dist/kameleoonUtils/browserUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browserUtils.js","sourceRoot":"","sources":["../../src/kameleoonUtils/browserUtils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,sEAKwC;AAExC,eAAe;AACf,0BAA0B;AAC1B,2DAA2D;AAC3D,oGAAoG;AACpG,6GAA6G;AAC7G;IAAwC,6CAAkB;IAA1D;;IA2BA,CAAC;IA1BQ,kDAAc,GAArB,UAAsB,EAGe;YAFnC,MAAM,YAAA,EACN,kBAAkB,wBAAA;QAElB,IAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAE/B,IAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAE5D,IAAI,iBAAiB,CAAC,EAAE,IAAI,iBAAiB,CAAC,IAAI,EAAE;YAClD,OAAO,iBAAiB,CAAC,IAAI,CAAC;SAC/B;QAED,IAAM,WAAW,GACf,kBAAkB,IAAI,IAAI,CAAC,oBAAoB,CAAC,yCAAmB,CAAC,CAAC;QAEvE,IAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,EAAE,MAAM,QAAA,EAAE,WAAW,aAAA,EAAE,CAAC,CAAC;QAEnE,eAAe;QACf,yEAAyE;QACzE,mDAAmD;QACnD,YAAY,CAAC,KAAK,CAAC,4BAAM,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,UAAC,IAAI;YACrD,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IACH,gCAAC;AAAD,CAAC,AA3BD,CAAwC,wCAAkB,GA2BzD;AAED;;;KAGK;AACL;IAAA;IAeA,CAAC;IAdC;;;;;SAKK;IACE,2BAAc,GAArB,UAAsB,MAAc,EAAE,kBAA2B;QAC/D,IAAM,yBAAyB,GAAG,IAAI,yBAAyB,EAAE,CAAC;QAElE,OAAO,yBAAyB,CAAC,cAAc,CAAC;YAC9C,MAAM,QAAA;YACN,kBAAkB,oBAAA;SACnB,CAAC,CAAC;IACL,CAAC;IACH,mBAAC;AAAD,CAAC,AAfD,IAeC;AAfY,oCAAY"}

package/dist/kameleoonUtils/nativeUtils.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @class
+ * BrowserUtils - a class with containing a number of static helper methods
+ * */
+export declare class NativeUtils {
+    /**
+     * @method getVisitorCode obtains visitor code from the browser cookie, if the visitor code doesn't yet exist generates a random visitor code (or uses a provided default) and sets a new visitor code to cookie
+     * @param {string | undefined} defaultVisitorCode visitor code to be used in case there is no visitor code in cookies Note: if not passed visitor code will be randomly generated
+     * @returns {string} result visitor code
+     * */
+    static getVisitorCode(defaultVisitorCode?: string): string;
+}

package/dist/kameleoonUtils/nativeUtils.js

@@ -0,0 +1,68 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NativeUtils = void 0;
+var javascript_sdk_core_1 = require("@kameleoon/javascript-sdk-core");
+var storage_1 = require("../storage");
+var storage = new storage_1.NativeStorageConstructor().initialize(javascript_sdk_core_1.KameleoonStorageKey.VisitorCode);
+// --- Note ---
+// Extra class is created:
+// - To be able to enforce abstract `getVisitorCode` method
+// - To be able to use extended methods while `KameleoonUtils` iself only operates on static methods
+// - To keep similar parameters object on inner implementation and dispers it for proprietary implementations
+var KameleoonUtilsConstructor = /** @class */ (function (_super) {
+    __extends(KameleoonUtilsConstructor, _super);
+    function KameleoonUtilsConstructor() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    KameleoonUtilsConstructor.prototype.getVisitorCode = function (_a) {
+        var defaultVisitorCode = _a.defaultVisitorCode;
+        var readResult = storage.read();
+        if (readResult.ok) {
+            return readResult.data;
+        }
+        var visitorCode = defaultVisitorCode || this.generateRandomString(javascript_sdk_core_1.VISITOR_CODE_LENGTH);
+        // --- Note ---
+        // `write` result is ignored because there is no exceptions for `mmkv` write operation
+        storage.write(visitorCode);
+        return visitorCode;
+    };
+    return KameleoonUtilsConstructor;
+}(javascript_sdk_core_1.KameleoonCoreUtils));
+/**
+ * @class
+ * BrowserUtils - a class with containing a number of static helper methods
+ * */
+var NativeUtils = /** @class */ (function () {
+    function NativeUtils() {
+    }
+    // TODO: docs
+    /**
+     * @method getVisitorCode obtains visitor code from the browser cookie, if the visitor code doesn't yet exist generates a random visitor code (or uses a provided default) and sets a new visitor code to cookie
+     * @param {string | undefined} defaultVisitorCode visitor code to be used in case there is no visitor code in cookies Note: if not passed visitor code will be randomly generated
+     * @returns {string} result visitor code
+     * */
+    NativeUtils.getVisitorCode = function (defaultVisitorCode) {
+        var kameleoonUtilsConstructor = new KameleoonUtilsConstructor();
+        return kameleoonUtilsConstructor.getVisitorCode({
+            defaultVisitorCode: defaultVisitorCode,
+        });
+    };
+    return NativeUtils;
+}());
+exports.NativeUtils = NativeUtils;
+//# sourceMappingURL=nativeUtils.js.map

package/dist/kameleoonUtils/nativeUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nativeUtils.js","sourceRoot":"","sources":["../../src/kameleoonUtils/nativeUtils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,sEAKwC;AACxC,sCAAsD;AAEtD,IAAM,OAAO,GAAG,IAAI,kCAAwB,EAAE,CAAC,UAAU,CACvD,yCAAmB,CAAC,WAAW,CAChC,CAAC;AAEF,eAAe;AACf,0BAA0B;AAC1B,2DAA2D;AAC3D,oGAAoG;AACpG,6GAA6G;AAC7G;IAAwC,6CAAkB;IAA1D;;IAmBA,CAAC;IAlBQ,kDAAc,GAArB,UAAsB,EAEe;YADnC,kBAAkB,wBAAA;QAElB,IAAM,UAAU,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QAElC,IAAI,UAAU,CAAC,EAAE,EAAE;YACjB,OAAO,UAAU,CAAC,IAAI,CAAC;SACxB;QAED,IAAM,WAAW,GACf,kBAAkB,IAAI,IAAI,CAAC,oBAAoB,CAAC,yCAAmB,CAAC,CAAC;QAEvE,eAAe;QACf,sFAAsF;QACtF,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAE3B,OAAO,WAAW,CAAC;IACrB,CAAC;IACH,gCAAC;AAAD,CAAC,AAnBD,CAAwC,wCAAkB,GAmBzD;AAED;;;KAGK;AACL;IAAA;IAcA,CAAC;IAbC,aAAa;IACb;;;;SAIK;IACE,0BAAc,GAArB,UAAsB,kBAA2B;QAC/C,IAAM,yBAAyB,GAAG,IAAI,yBAAyB,EAAE,CAAC;QAElE,OAAO,yBAAyB,CAAC,cAAc,CAAC;YAC9C,kBAAkB,oBAAA;SACnB,CAAC,CAAC;IACL,CAAC;IACH,kBAAC;AAAD,CAAC,AAdD,IAcC;AAdY,kCAAW"}

package/dist/storage/index.d.ts

@@ -0,0 +1,2 @@
+export { LocalStorageConstructor } from './localStorage';
+export { NativeStorageConstructor } from './nativeStorage';

package/dist/storage/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NativeStorageConstructor = exports.LocalStorageConstructor = void 0;
+var localStorage_1 = require("./localStorage");
+Object.defineProperty(exports, "LocalStorageConstructor", { enumerable: true, get: function () { return localStorage_1.LocalStorageConstructor; } });
+var nativeStorage_1 = require("./nativeStorage");
+Object.defineProperty(exports, "NativeStorageConstructor", { enumerable: true, get: function () { return nativeStorage_1.NativeStorageConstructor; } });
+//# sourceMappingURL=index.js.map

package/dist/storage/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/storage/index.ts"],"names":[],"mappings":";;;AAAA,+CAAyD;AAAhD,uHAAA,uBAAuB,OAAA;AAChC,iDAA2D;AAAlD,yHAAA,wBAAwB,OAAA"}

package/dist/storage/localStorage.d.ts

@@ -0,0 +1,4 @@
+import { IExternalStorage, KameleoonStorageKey, IExternalStorageConstructor } from '@kameleoon/javascript-sdk-core';
+export declare class LocalStorageConstructor implements IExternalStorageConstructor {
+    initialize(key: KameleoonStorageKey): IExternalStorage;
+}

package/dist/storage/localStorage.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalStorageConstructor = void 0;
+var javascript_sdk_core_1 = require("@kameleoon/javascript-sdk-core");
+var LocalStorageConstructor = /** @class */ (function () {
+    function LocalStorageConstructor() {
+    }
+    LocalStorageConstructor.prototype.initialize = function (key) {
+        var storage = new LocalStorage(key);
+        return storage;
+    };
+    return LocalStorageConstructor;
+}());
+exports.LocalStorageConstructor = LocalStorageConstructor;
+var LocalStorage = /** @class */ (function () {
+    function LocalStorage(key) {
+        this.storageKey = key;
+    }
+    Object.defineProperty(LocalStorage.prototype, "key", {
+        get: function () {
+            return this.storageKey;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    LocalStorage.prototype.read = function () {
+        var data = localStorage.getItem(this.storageKey);
+        if (!data) {
+            return (0, javascript_sdk_core_1.Err)(new javascript_sdk_core_1.KameleoonError(javascript_sdk_core_1.KameleoonException.StorageRead, this.storageKey));
+        }
+        return (0, javascript_sdk_core_1.Ok)(data);
+    };
+    LocalStorage.prototype.write = function (data) {
+        try {
+            localStorage.setItem(this.storageKey, data);
+            return (0, javascript_sdk_core_1.Ok)();
+        }
+        catch (err) {
+            return (0, javascript_sdk_core_1.Err)(new javascript_sdk_core_1.KameleoonError(javascript_sdk_core_1.KameleoonException.StorageWrite, err));
+        }
+    };
+    return LocalStorage;
+}());
+//# sourceMappingURL=localStorage.js.map

package/dist/storage/localStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localStorage.js","sourceRoot":"","sources":["../../src/storage/localStorage.ts"],"names":[],"mappings":";;;AAAA,sEASwC;AAExC;IAAA;IAMA,CAAC;IALQ,4CAAU,GAAjB,UAAkB,GAAwB;QACxC,IAAM,OAAO,GAAG,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC;QAEtC,OAAO,OAAO,CAAC;IACjB,CAAC;IACH,8BAAC;AAAD,CAAC,AAND,IAMC;AANY,0DAAuB;AAQpC;IAGE,sBAAY,GAAwB;QAClC,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IACxB,CAAC;IAED,sBAAI,6BAAG;aAAP;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;;;OAAA;IAEM,2BAAI,GAAX;QACE,IAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,IAAA,yBAAG,EACR,IAAI,oCAAc,CAAC,wCAAkB,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CACpE,CAAC;SACH;QAED,OAAO,IAAA,wBAAE,EAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAEM,4BAAK,GAAZ,UAAa,IAAY;QACvB,IAAI;YACF,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAE5C,OAAO,IAAA,wBAAE,GAAE,CAAC;SACb;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,IAAA,yBAAG,EAAC,IAAI,oCAAc,CAAC,wCAAkB,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC;SACtE;IACH,CAAC;IACH,mBAAC;AAAD,CAAC,AAhCD,IAgCC"}

package/dist/storage/nativeStorage.d.ts

@@ -0,0 +1,4 @@
+import { IExternalStorage, KameleoonStorageKey, IExternalStorageConstructor } from '@kameleoon/javascript-sdk-core';
+export declare class NativeStorageConstructor implements IExternalStorageConstructor {
+    initialize(key: KameleoonStorageKey): IExternalStorage;
+}

package/dist/storage/nativeStorage.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NativeStorageConstructor = void 0;
+var javascript_sdk_core_1 = require("@kameleoon/javascript-sdk-core");
+var react_native_mmkv_1 = require("react-native-mmkv");
+var NativeStorageConstructor = /** @class */ (function () {
+    function NativeStorageConstructor() {
+    }
+    NativeStorageConstructor.prototype.initialize = function (key) {
+        var storage = new NativeStorage(key);
+        return storage;
+    };
+    return NativeStorageConstructor;
+}());
+exports.NativeStorageConstructor = NativeStorageConstructor;
+var NativeStorage = /** @class */ (function () {
+    function NativeStorage(key) {
+        this.storage = new react_native_mmkv_1.MMKV();
+        this.storageKey = key;
+    }
+    Object.defineProperty(NativeStorage.prototype, "key", {
+        get: function () {
+            return this.storageKey;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    NativeStorage.prototype.read = function () {
+        var data = this.storage.getString(this.storageKey);
+        if (!data) {
+            return (0, javascript_sdk_core_1.Err)(new javascript_sdk_core_1.KameleoonError(javascript_sdk_core_1.KameleoonException.StorageRead, this.storageKey));
+        }
+        return (0, javascript_sdk_core_1.Ok)(data);
+    };
+    NativeStorage.prototype.write = function (data) {
+        this.storage.set(this.storageKey, data);
+        return (0, javascript_sdk_core_1.Ok)();
+    };
+    return NativeStorage;
+}());
+//# sourceMappingURL=nativeStorage.js.map

package/dist/storage/nativeStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nativeStorage.js","sourceRoot":"","sources":["../../src/storage/nativeStorage.ts"],"names":[],"mappings":";;;AAAA,sEASwC;AACxC,uDAAyC;AAEzC;IAAA;IAMA,CAAC;IALQ,6CAAU,GAAjB,UAAkB,GAAwB;QACxC,IAAM,OAAO,GAAG,IAAI,aAAa,CAAC,GAAG,CAAC,CAAC;QAEvC,OAAO,OAAO,CAAC;IACjB,CAAC;IACH,+BAAC;AAAD,CAAC,AAND,IAMC;AANY,4DAAwB;AAQrC;IAIE,uBAAY,GAAwB;QAClC,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAI,EAAE,CAAC;QAC1B,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IACxB,CAAC;IAED,sBAAI,8BAAG;aAAP;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;;;OAAA;IAEM,4BAAI,GAAX;QACE,IAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,IAAA,yBAAG,EACR,IAAI,oCAAc,CAAC,wCAAkB,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CACpE,CAAC;SACH;QAED,OAAO,IAAA,wBAAE,EAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAEM,6BAAK,GAAZ,UAAa,IAAY;QACvB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAExC,OAAO,IAAA,wBAAE,GAAE,CAAC;IACd,CAAC;IACH,oBAAC;AAAD,CAAC,AA9BD,IA8BC"}

package/dist/useAddData.d.ts

@@ -1,14 +1,19 @@
-import { DataInterface as IData } from '@kameleoon/javascript-sdk-core/dist/interfaces/interfaces';
-interface AddDataHookResult {
+import { KameleoonDataType } from '@kameleoon/javascript-sdk-core';
+import { KameleoonError } from './KameleoonError';
+export interface IAddDataHookResult {
     /**
-     * @param visitorCode - unique identifier of the user
-     * @param dataTypes - custom data types which may be passed separated by a comma
+     * Adds targeting data to the storage so that other methods could decide whether the current visitor is targeted or not. Note: userAgent data will not be stored in storage like other data, and it will be sent with every tracking request for bot filtration.
+     *
+     * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.
+     * @param {...KameleoonDataType} data - number of instances of any type of `KameleoonData`, can be added solely in array or as a sequential arguments.
      */
-    addData: (visitorCode: string, ...dataTypes: IData[]) => void;
+    addData: (visitorCode: string, ...data: KameleoonDataType[]) => void;
+    /** An optional error object that may be returned if an error occurs while calling the `addData` function. */
+    error: KameleoonError | null;
 }
 /**
- * A React Hook that returns callback function which adds various data
- * to associate this data with the current user
+ * A React Hook that returns `addData` function for adding targeting data to the Kameleoon storage.
+ *
+ * @returns {IAddDataHookResult} an object containing the `addData` function and an optional error object.
  */
-export declare function useAddData(): AddDataHookResult;
-export {};
+export declare function useAddData(): IAddDataHookResult;

package/dist/useAddData.js

@@ -28,21 +28,30 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useAddData = void 0;
 var react_1 = require("react");
 var useKameleoon_1 = require("./useKameleoon");
+var useError_1 = require("./useError");
 /**
- * A React Hook that returns callback function which adds various data
- * to associate this data with the current user
+ * A React Hook that returns `addData` function for adding targeting data to the Kameleoon storage.
+ *
+ * @returns {IAddDataHookResult} an object containing the `addData` function and an optional error object.
  */
 function useAddData() {
     var client = (0, useKameleoon_1.useKameleoon)().client;
+    var _a = (0, useError_1.useError)(), error = _a.error, setError = _a.setError;
     var addData = (0, react_1.useCallback)(function (visitorCode) {
-        var dataTypes = [];
+        var data = [];
         for (var _i = 1; _i < arguments.length; _i++) {
-            dataTypes[_i - 1] = arguments[_i];
+            data[_i - 1] = arguments[_i];
+        }
+        try {
+            client.addData.apply(client, __spreadArray([visitorCode], __read(data), false));
+        }
+        catch (unknownError) {
+            setError(unknownError);
         }
-        client.addData.apply(client, __spreadArray([visitorCode], __read(dataTypes), false));
     }, [client]);
     return {
         addData: addData,
+        error: error,
     };
 }
 exports.useAddData = useAddData;

package/dist/useAddData.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAddData.js","sourceRoot":"","sources":["../src/useAddData.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAAoC;AAEpC,+CAA8C;AAU9C;;;GAGG;AACH,SAAgB,UAAU;IAChB,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAElC,IAAM,OAAO,GAAG,IAAA,mBAAW,EACzB,UAAC,WAAmB;QAAE,mBAAqB;aAArB,UAAqB,EAArB,qBAAqB,EAArB,IAAqB;YAArB,kCAAqB;;QACzC,MAAM,CAAC,OAAO,OAAd,MAAM,iBAAS,WAAW,UAAK,SAAS,WAAE;IAC5C,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,OAAO;QACL,OAAO,SAAA;KACR,CAAC;AACJ,CAAC;AAbD,gCAaC"}
+{"version":3,"file":"useAddData.js","sourceRoot":"","sources":["../src/useAddData.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAAoC;AAEpC,+CAA8C;AAC9C,uCAAsC;AAetC;;;;GAIG;AACH,SAAgB,UAAU;IAChB,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAC5B,IAAA,KAAsB,IAAA,mBAAQ,GAAE,EAA9B,KAAK,WAAA,EAAE,QAAQ,cAAe,CAAC;IAEvC,IAAM,OAAO,GAAG,IAAA,mBAAW,EACzB,UAAC,WAAmB;QAAE,cAA4B;aAA5B,UAA4B,EAA5B,qBAA4B,EAA5B,IAA4B;YAA5B,6BAA4B;;QAChD,IAAI;YACF,MAAM,CAAC,OAAO,OAAd,MAAM,iBAAS,WAAW,UAAK,IAAI,WAAE;SACtC;QAAC,OAAO,YAAY,EAAE;YACrB,QAAQ,CAAC,YAAY,CAAC,CAAC;SACxB;IACH,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,OAAO;QACL,OAAO,SAAA;QACP,KAAK,OAAA;KACN,CAAC;AACJ,CAAC;AAnBD,gCAmBC"}

package/dist/useBrowserVisitorCode.d.ts

@@ -0,0 +1,17 @@
+interface IBrowserVisitorCodeHookResult {
+    /**
+     * Obtains visitor code from browser cookie, if no cookie exists returns new random visitor code (or the specified default value).
+     *
+     * @param domain - domain to be set to browser cookie along with visitor code.
+     * @param defaultVisitorCode - visitor code to be used instead of randomly generated visitor code in case there is no visitor code saved in browser cookie.
+     * @returns {string} result visitor code.
+     */
+    getBrowserVisitorCode: (domain: string, defaultVisitorCode?: string) => string;
+}
+/**
+ * A React Hook that returns `getBrowserVisitorCode` function which obtains the Kameleoon visitorCode.
+ *
+ * @returns {IBrowserVisitorCodeHookResult} an object containing the `getBrowserVisitorCode` function and an optional error object.
+ */
+export declare function useBrowserVisitorCode(): IBrowserVisitorCodeHookResult;
+export {};

package/dist/useBrowserVisitorCode.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useBrowserVisitorCode = void 0;
+var react_1 = require("react");
+var browserUtils_1 = require("./kameleoonUtils/browserUtils");
+/**
+ * A React Hook that returns `getBrowserVisitorCode` function which obtains the Kameleoon visitorCode.
+ *
+ * @returns {IBrowserVisitorCodeHookResult} an object containing the `getBrowserVisitorCode` function and an optional error object.
+ */
+function useBrowserVisitorCode() {
+    var getBrowserVisitorCode = (0, react_1.useCallback)(function (domain, defaultVisitorCode) {
+        return browserUtils_1.BrowserUtils.getVisitorCode(domain, defaultVisitorCode);
+    }, []);
+    return {
+        getBrowserVisitorCode: getBrowserVisitorCode,
+    };
+}
+exports.useBrowserVisitorCode = useBrowserVisitorCode;
+//# sourceMappingURL=useBrowserVisitorCode.js.map

package/dist/useBrowserVisitorCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useBrowserVisitorCode.js","sourceRoot":"","sources":["../src/useBrowserVisitorCode.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AACpC,8DAA6D;AAgB7D;;;;GAIG;AACH,SAAgB,qBAAqB;IACnC,IAAM,qBAAqB,GAAG,IAAA,mBAAW,EACvC,UAAC,MAAc,EAAE,kBAA2B;QAC1C,OAAO,2BAAY,CAAC,cAAc,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IACjE,CAAC,EACD,EAAE,CACH,CAAC;IAEF,OAAO;QACL,qBAAqB,uBAAA;KACtB,CAAC;AACJ,CAAC;AAXD,sDAWC"}

package/dist/useConfigurationUpdate.d.ts

@@ -0,0 +1,17 @@
+import { KameleoonError } from './KameleoonError';
+export interface IConfigurationUpdateHookResult {
+    /**
+     * Fires a callback on client configuration update. Note: this method only works for server sent events of real time update.
+     *
+     * @param {() => void} callback - callback function with no parameters that will be called upon configuration update.
+     */
+    onConfigurationUpdate: (callback: () => void) => void;
+    /** An optional error object that may be returned if an error occurs while calling the `onConfigurationUpdate` function. */
+    error: KameleoonError | null;
+}
+/**
+ * A React Hook that returns `onConfigurationUpdate` function which fires a callback on client configuration update.
+ *
+ * @returns {IConfigurationUpdateHookResult} an object containing the `onConfigurationUpdate` function and an optional error object.
+ */
+export declare function useConfigurationUpdate(): IConfigurationUpdateHookResult;

package/dist/useConfigurationUpdate.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useConfigurationUpdate = void 0;
+var react_1 = require("react");
+var useKameleoon_1 = require("./useKameleoon");
+var useError_1 = require("./useError");
+/**
+ * A React Hook that returns `onConfigurationUpdate` function which fires a callback on client configuration update.
+ *
+ * @returns {IConfigurationUpdateHookResult} an object containing the `onConfigurationUpdate` function and an optional error object.
+ */
+function useConfigurationUpdate() {
+    var client = (0, useKameleoon_1.useKameleoon)().client;
+    var _a = (0, useError_1.useError)(), error = _a.error, setError = _a.setError;
+    var onConfigurationUpdate = (0, react_1.useCallback)(function (callback) {
+        try {
+            client.onConfigurationUpdate(callback);
+        }
+        catch (unknownError) {
+            setError(unknownError);
+        }
+    }, [client]);
+    return {
+        onConfigurationUpdate: onConfigurationUpdate,
+        error: error,
+    };
+}
+exports.useConfigurationUpdate = useConfigurationUpdate;
+//# sourceMappingURL=useConfigurationUpdate.js.map

package/dist/useConfigurationUpdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useConfigurationUpdate.js","sourceRoot":"","sources":["../src/useConfigurationUpdate.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AACpC,+CAA8C;AAC9C,uCAAsC;AActC;;;;GAIG;AACH,SAAgB,sBAAsB;IAC5B,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAC5B,IAAA,KAAsB,IAAA,mBAAQ,GAAE,EAA9B,KAAK,WAAA,EAAE,QAAQ,cAAe,CAAC;IAEvC,IAAM,qBAAqB,GAAG,IAAA,mBAAW,EACvC,UAAC,QAAoB;QACnB,IAAI;YACF,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACxC;QAAC,OAAO,YAAY,EAAE;YACrB,QAAQ,CAAC,YAAY,CAAC,CAAC;SACxB;IACH,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,OAAO;QACL,qBAAqB,uBAAA;QACrB,KAAK,OAAA;KACN,CAAC;AACJ,CAAC;AAnBD,wDAmBC"}

package/dist/useError.d.ts

@@ -1,5 +1,5 @@
 import { KameleoonError } from './KameleoonError';
-declare type UseErrorHookResultType = {
+type UseErrorHookResultType = {
     error: KameleoonError | null;
     setError: (unknownError: unknown) => void;
 };

package/dist/useError.js

@@ -2,12 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useError = void 0;
 var react_1 = require("react");
-var getKameleoonException_1 = require("./getKameleoonException");
 function useError() {
     var errorRef = (0, react_1.useRef)(null);
     var setError = (0, react_1.useCallback)(function (unknownError) {
-        var exception = (0, getKameleoonException_1.getKameleoonException)(unknownError);
-        errorRef.current = exception;
+        errorRef.current = unknownError;
     }, [errorRef]);
     return {
         error: errorRef.current,

package/dist/useError.js.map

@@ -1 +1 @@
-{"version":3,"file":"useError.js","sourceRoot":"","sources":["../src/useError.ts"],"names":[],"mappings":";;;AAAA,+BAA4C;AAC5C,iEAAgE;AAQhE,SAAgB,QAAQ;IACtB,IAAM,QAAQ,GAAG,IAAA,cAAM,EAAwB,IAAI,CAAC,CAAC;IAErD,IAAM,QAAQ,GAAG,IAAA,mBAAW,EAC1B,UAAC,YAAqB;QACpB,IAAM,SAAS,GAAG,IAAA,6CAAqB,EAAC,YAAqB,CAAC,CAAC;QAC/D,QAAQ,CAAC,OAAO,GAAG,SAAS,CAAC;IAC/B,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,OAAO;QACL,KAAK,EAAE,QAAQ,CAAC,OAAO;QACvB,QAAQ,UAAA;KACT,CAAC;AACJ,CAAC;AAfD,4BAeC"}
+{"version":3,"file":"useError.js","sourceRoot":"","sources":["../src/useError.ts"],"names":[],"mappings":";;;AAAA,+BAA4C;AAQ5C,SAAgB,QAAQ;IACtB,IAAM,QAAQ,GAAG,IAAA,cAAM,EAAwB,IAAI,CAAC,CAAC;IAErD,IAAM,QAAQ,GAAG,IAAA,mBAAW,EAC1B,UAAC,YAAqB;QACpB,QAAQ,CAAC,OAAO,GAAG,YAA8B,CAAC;IACpD,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,OAAO;QACL,KAAK,EAAE,QAAQ,CAAC,OAAO;QACvB,QAAQ,UAAA;KACT,CAAC;AACJ,CAAC;AAdD,4BAcC"}

package/dist/useErrors.d.ts

@@ -1,5 +1,5 @@
-import { KameleoonException } from './constants';
-declare type UseErrorsHookResultType = {
+import { KameleoonException } from '@kameleoon/javascript-sdk-core';
+type UseErrorsHookResultType = {
     errors: KameleoonException[];
     setErrors: (newErrors: Array<KameleoonException | undefined>) => void;
 };

package/dist/useExperiments.d.ts

@@ -0,0 +1,18 @@
+import { ExperimentType } from '@kameleoon/javascript-sdk-core';
+import { KameleoonError } from './KameleoonError';
+export interface IExperimentsHookResult {
+    /**
+     * Returns a list of experiments stored in the client configuration.
+     *
+     * @returns {ExperimentType[]} a list of all experiments items with `id` and `name` fields.
+     */
+    getExperiments: () => ExperimentType[];
+    /** An optional error object that may be returned if an error occurs while calling the `getExperiments` function. */
+    error: KameleoonError | null;
+}
+/**
+ * A React Hook that returns `getExperiments` function which returns a list of experiments.
+ *
+ * @returns {IExperimentsHookResult} an object containing the `getExperiments` function and an optional error object.
+ */
+export declare function useExperiments(): IExperimentsHookResult;

package/dist/useExperiments.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useExperiments = void 0;
+var react_1 = require("react");
+var useKameleoon_1 = require("./useKameleoon");
+var useError_1 = require("./useError");
+/**
+ * A React Hook that returns `getExperiments` function which returns a list of experiments.
+ *
+ * @returns {IExperimentsHookResult} an object containing the `getExperiments` function and an optional error object.
+ */
+function useExperiments() {
+    var client = (0, useKameleoon_1.useKameleoon)().client;
+    var _a = (0, useError_1.useError)(), error = _a.error, setError = _a.setError;
+    var getExperiments = (0, react_1.useCallback)(function () {
+        try {
+            return client.getExperiments();
+        }
+        catch (unknownError) {
+            setError(unknownError);
+            return [];
+        }
+    }, [client]);
+    return {
+        getExperiments: getExperiments,
+        error: error,
+    };
+}
+exports.useExperiments = useExperiments;
+//# sourceMappingURL=useExperiments.js.map

package/dist/useExperiments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useExperiments.js","sourceRoot":"","sources":["../src/useExperiments.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AAEpC,+CAA8C;AAC9C,uCAAsC;AActC;;;;GAIG;AACH,SAAgB,cAAc;IACpB,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAC5B,IAAA,KAAsB,IAAA,mBAAQ,GAAE,EAA9B,KAAK,WAAA,EAAE,QAAQ,cAAe,CAAC;IAEvC,IAAM,cAAc,GAAG,IAAA,mBAAW,EAAC;QACjC,IAAI;YACF,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC;SAChC;QAAC,OAAO,YAAY,EAAE;YACrB,QAAQ,CAAC,YAAY,CAAC,CAAC;YAEvB,OAAO,EAAE,CAAC;SACX;IACH,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,OAAO;QACL,cAAc,gBAAA;QACd,KAAK,OAAA;KACN,CAAC;AACJ,CAAC;AAlBD,wCAkBC"}

package/dist/useFeatureFlagActive.d.ts

@@ -0,0 +1,19 @@
+import { KameleoonError } from './KameleoonError';
+export interface IFeatureFlagActiveHookResult {
+    /**
+     * Indicates whether the visitor with `visitorCode` has `featureKey` active for him, this method includes targeting check, finding the according variation exposed to the visitor and saving it to storage along with sending tracking request if the feature rollout rule was of type of `Experimentation`.
+     *
+     * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.
+     * @param {string} featureKey - a unique key for feature flag.
+     * @returns {boolean} a boolean indicator of whether the feature flag with `featureKey` is active for visitor with `visitorCode`.
+     */
+    isFeatureFlagActive: (visitorCode: string, featureKey: string) => boolean;
+    /** An optional error object that may be returned if an error occurs while calling the `isFeatureFlagActive` function. */
+    error: KameleoonError | null;
+}
+/**
+ * A React Hook that returns `isFeatureFlagActive` function which indicates whether the visitor with `visitorCode` has `featureKey` active for him.
+ *
+ * @returns {IFeatureFlagActiveHookResult} an object containing the `isFeatureFlagActive` function.
+ */
+export declare function useFeatureFlagActive(): IFeatureFlagActiveHookResult;

package/dist/useFeatureFlagActive.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFeatureFlagActive = void 0;
+var react_1 = require("react");
+var useKameleoon_1 = require("./useKameleoon");
+var useError_1 = require("./useError");
+/**
+ * A React Hook that returns `isFeatureFlagActive` function which indicates whether the visitor with `visitorCode` has `featureKey` active for him.
+ *
+ * @returns {IFeatureFlagActiveHookResult} an object containing the `isFeatureFlagActive` function.
+ */
+function useFeatureFlagActive() {
+    var client = (0, useKameleoon_1.useKameleoon)().client;
+    var _a = (0, useError_1.useError)(), error = _a.error, setError = _a.setError;
+    var isFeatureFlagActive = (0, react_1.useCallback)(function (visitorCode, featureKey) {
+        try {
+            return client.isFeatureFlagActive(visitorCode, featureKey);
+        }
+        catch (unknownError) {
+            setError(unknownError);
+            return false;
+        }
+    }, [client, setError]);
+    return {
+        isFeatureFlagActive: isFeatureFlagActive,
+        error: error,
+    };
+}
+exports.useFeatureFlagActive = useFeatureFlagActive;
+//# sourceMappingURL=useFeatureFlagActive.js.map

package/dist/useFeatureFlagActive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFeatureFlagActive.js","sourceRoot":"","sources":["../src/useFeatureFlagActive.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AACpC,+CAA8C;AAE9C,uCAAsC;AAetC;;;;GAIG;AACH,SAAgB,oBAAoB;IAC1B,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAC5B,IAAA,KAAsB,IAAA,mBAAQ,GAAE,EAA9B,KAAK,WAAA,EAAE,QAAQ,cAAe,CAAC;IAEvC,IAAM,mBAAmB,GAAG,IAAA,mBAAW,EACrC,UAAC,WAAmB,EAAE,UAAkB;QACtC,IAAI;YACF,OAAO,MAAM,CAAC,mBAAmB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;SAC5D;QAAC,OAAO,YAAY,EAAE;YACrB,QAAQ,CAAC,YAAY,CAAC,CAAC;YAEvB,OAAO,KAAK,CAAC;SACd;IACH,CAAC,EACD,CAAC,MAAM,EAAE,QAAQ,CAAC,CACnB,CAAC;IAEF,OAAO;QACL,mBAAmB,qBAAA;QACnB,KAAK,OAAA;KACN,CAAC;AACJ,CAAC;AArBD,oDAqBC"}