@kameleoon/react-sdk 4.1.1 → 6.0.0

package/dist/useFeatureFlagVariationKey.d.ts

@@ -0,0 +1,19 @@
+import { KameleoonError } from './KameleoonError';
+export interface IFeatureFlagVariationKeyHookResult {
+    /**
+     * Returns variation key for the visitor under `visitorCode` in the found feature flag, 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 {string | undefined}  a string containing variable key for the allocated feature flag variation for the provided visitor.
+     */
+    getFeatureFlagVariationKey: (visitorCode: string, featureKey: string) => string | undefined;
+    /** An optional error object that may be returned if an error occurs while calling the `getFeatureFlagVariationKey` function. */
+    error: KameleoonError | null;
+}
+/**
+ * A React Hook that returns `getFeatureFlagVariationKey` function which returns variation key for the visitor under `visitorCode` in the found feature flag.
+ *
+ * @returns {IFeatureFlagVariationKeyHookResult} an object containing the `getFeatureFlagVariationKey` function and an optional error object.
+ */
+export declare function useFeatureFlagVariationKey(): IFeatureFlagVariationKeyHookResult;

package/dist/useFeatureFlagVariationKey.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFeatureFlagVariationKey = void 0;
+var react_1 = require("react");
+var useKameleoon_1 = require("./useKameleoon");
+var useError_1 = require("./useError");
+/**
+ * A React Hook that returns `getFeatureFlagVariationKey` function which returns variation key for the visitor under `visitorCode` in the found feature flag.
+ *
+ * @returns {IFeatureFlagVariationKeyHookResult} an object containing the `getFeatureFlagVariationKey` function and an optional error object.
+ */
+function useFeatureFlagVariationKey() {
+    var client = (0, useKameleoon_1.useKameleoon)().client;
+    var _a = (0, useError_1.useError)(), error = _a.error, setError = _a.setError;
+    var getFeatureFlagVariationKey = (0, react_1.useCallback)(function (visitorCode, featureKey) {
+        try {
+            return client.getFeatureFlagVariationKey(visitorCode, featureKey);
+        }
+        catch (unknownError) {
+            setError(unknownError);
+            return undefined;
+        }
+    }, [client]);
+    return {
+        getFeatureFlagVariationKey: getFeatureFlagVariationKey,
+        error: error,
+    };
+}
+exports.useFeatureFlagVariationKey = useFeatureFlagVariationKey;
+//# sourceMappingURL=useFeatureFlagVariationKey.js.map

package/dist/useFeatureFlagVariationKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFeatureFlagVariationKey.js","sourceRoot":"","sources":["../src/useFeatureFlagVariationKey.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AACpC,+CAA8C;AAC9C,uCAAsC;AAmBtC;;;;GAIG;AACH,SAAgB,0BAA0B;IAChC,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAC5B,IAAA,KAAsB,IAAA,mBAAQ,GAAE,EAA9B,KAAK,WAAA,EAAE,QAAQ,cAAe,CAAC;IAEvC,IAAM,0BAA0B,GAAG,IAAA,mBAAW,EAC5C,UAAC,WAAmB,EAAE,UAAkB;QACtC,IAAI;YACF,OAAO,MAAM,CAAC,0BAA0B,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;SACnE;QAAC,OAAO,YAAY,EAAE;YACrB,QAAQ,CAAC,YAAY,CAAC,CAAC;YAEvB,OAAO,SAAS,CAAC;SAClB;IACH,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,OAAO;QACL,0BAA0B,4BAAA;QAC1B,KAAK,OAAA;KACN,CAAC;AACJ,CAAC;AArBD,gEAqBC"}

package/dist/useFeatureFlags.d.ts

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

package/dist/useFeatureFlags.js

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

package/dist/useFeatureFlags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFeatureFlags.js","sourceRoot":"","sources":["../src/useFeatureFlags.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AAEpC,+CAA8C;AAC9C,uCAAsC;AActC;;;;GAIG;AACH,SAAgB,eAAe;IACrB,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAC5B,IAAA,KAAsB,IAAA,mBAAQ,GAAE,EAA9B,KAAK,WAAA,EAAE,QAAQ,cAAe,CAAC;IAEvC,IAAM,eAAe,GAAG,IAAA,mBAAW,EAAC;QAClC,IAAI;YACF,OAAO,MAAM,CAAC,eAAe,EAAE,CAAC;SACjC;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,eAAe,iBAAA;QACf,KAAK,OAAA;KACN,CAAC;AACJ,CAAC;AAlBD,0CAkBC"}

package/dist/useFeatureVariable.d.ts

@@ -1,15 +1,19 @@
-import { FeatureFlagVariableType } from './types';
+import { GetFeatureFlagVariableParamsType, FeatureVariableResultType } from '@kameleoon/javascript-sdk-core';
 import { KameleoonError } from './KameleoonError';
-interface FeatureVariableHookResult {
+export interface IFeatureVariableHookResult {
     /**
-     * @param featureKey - unique identifier or key of the feature you want to obtain to a user
-     * @param variableKey - key of the variable
+     * Returns a variable for the visitor under `visitorCode` in the found feature flag, 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 {GetFeatureFlagVariableParamsType} params - `visitorCode`, `featureKey` and `variableKey` parameters to return variable.
+     * @return {FeatureVariableResultType | undefined} a variable object containing `type` and `value` fields, `type` can be checked against `FeatureVariableType` enum, if the `type` is `FeatureVariableType.BOOLEAN` then the `value` type will be `boolean` and so on.
      */
-    getFeatureVariable: (featureKey: string | number, variableKey: string) => FeatureFlagVariableType;
+    getFeatureFlagVariable: (params: GetFeatureFlagVariableParamsType) => FeatureVariableResultType | undefined;
+    /** An optional error object that may be returned if an error occurs while calling the `getFeatureFlagVariable` function. */
     error: KameleoonError | null;
 }
 /**
- * A React Hook that returns callback function which retrieves a feature variable
+ * A React Hook that returns `getFeatureFlagVariable` function which retrieves a feature variable.
+ *
+ * @returns {IPageViewHookResult} an object containing the `getFeatureFlagVariable` function.
  */
-export declare function useFeatureVariable(): FeatureVariableHookResult;
-export {};
+export declare function useFeatureVariable(): IFeatureVariableHookResult;

package/dist/useFeatureVariable.js

@@ -1,39 +1,28 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useFeatureVariable = void 0;
 var react_1 = require("react");
-var isJSON_1 = __importDefault(require("validator/lib/isJSON"));
 var useKameleoon_1 = require("./useKameleoon");
 var useError_1 = require("./useError");
 /**
- * A React Hook that returns callback function which retrieves a feature variable
+ * A React Hook that returns `getFeatureFlagVariable` function which retrieves a feature variable.
+ *
+ * @returns {IPageViewHookResult} an object containing the `getFeatureFlagVariable` function.
  */
 function useFeatureVariable() {
     var client = (0, useKameleoon_1.useKameleoon)().client;
     var _a = (0, useError_1.useError)(), error = _a.error, setError = _a.setError;
-    var getProcessedVariable = (0, react_1.useCallback)(function (value) {
-        if (typeof value === 'undefined') {
-            return undefined;
-        }
-        if (typeof value === 'string' && (0, isJSON_1.default)(value)) {
-            return JSON.parse(value);
-        }
-        return value;
-    }, []);
-    var getFeatureVariable = (0, react_1.useCallback)(function (featureKey, variableKey) {
+    var getFeatureFlagVariable = (0, react_1.useCallback)(function (params) {
         try {
-            return getProcessedVariable(client.obtainFeatureVariable(featureKey, variableKey));
+            return client.getFeatureFlagVariable(params);
         }
         catch (unknownError) {
             setError(unknownError);
             return undefined;
         }
-    }, [client, getProcessedVariable, setError]);
+    }, [client, setError]);
     return {
-        getFeatureVariable: getFeatureVariable,
+        getFeatureFlagVariable: getFeatureFlagVariable,
         error: error,
     };
 }

package/dist/useFeatureVariable.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFeatureVariable.js","sourceRoot":"","sources":["../src/useFeatureVariable.ts"],"names":[],"mappings":";;;;;;AAAA,+BAAoC;AACpC,gEAA0C;AAC1C,+CAA8C;AAG9C,uCAAsC;AActC;;GAEG;AACH,SAAgB,kBAAkB;IACxB,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAC5B,IAAA,KAAsB,IAAA,mBAAQ,GAAE,EAA9B,KAAK,WAAA,EAAE,QAAQ,cAAe,CAAC;IAEvC,IAAM,oBAAoB,GAAG,IAAA,mBAAW,EAAC,UAAC,KAAK;QAC7C,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;YAChC,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAA,gBAAM,EAAC,KAAK,CAAC,EAAE;YAC9C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;QAED,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,IAAM,kBAAkB,GAAG,IAAA,mBAAW,EACpC,UACE,UAA2B,EAC3B,WAAmB;QAEnB,IAAI;YACF,OAAO,oBAAoB,CACzB,MAAM,CAAC,qBAAqB,CAAC,UAAU,EAAE,WAAW,CAAC,CACtD,CAAC;SACH;QAAC,OAAO,YAAY,EAAE;YACrB,QAAQ,CAAC,YAAY,CAAC,CAAC;YAEvB,OAAO,SAAS,CAAC;SAClB;IACH,CAAC,EACD,CAAC,MAAM,EAAE,oBAAoB,EAAE,QAAQ,CAAC,CACzC,CAAC;IAEF,OAAO;QACL,kBAAkB,oBAAA;QAClB,KAAK,OAAA;KACN,CAAC;AACJ,CAAC;AAtCD,gDAsCC"}
+{"version":3,"file":"useFeatureVariable.js","sourceRoot":"","sources":["../src/useFeatureVariable.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AAKpC,+CAA8C;AAE9C,uCAAsC;AAgBtC;;;;GAIG;AACH,SAAgB,kBAAkB;IACxB,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAC5B,IAAA,KAAsB,IAAA,mBAAQ,GAAE,EAA9B,KAAK,WAAA,EAAE,QAAQ,cAAe,CAAC;IAEvC,IAAM,sBAAsB,GAAG,IAAA,mBAAW,EACxC,UACE,MAAwC;QAExC,IAAI;YACF,OAAO,MAAM,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;SAC9C;QAAC,OAAO,YAAY,EAAE;YACrB,QAAQ,CAAC,YAAY,CAAC,CAAC;YAEvB,OAAO,SAAS,CAAC;SAClB;IACH,CAAC,EACD,CAAC,MAAM,EAAE,QAAQ,CAAC,CACnB,CAAC;IAEF,OAAO;QACL,sBAAsB,wBAAA;QACtB,KAAK,OAAA;KACN,CAAC;AACJ,CAAC;AAvBD,gDAuBC"}

package/dist/useFlushData.d.ts

@@ -0,0 +1,14 @@
+export interface IFlushDataHookResult {
+    /**
+     * Takes visitor associated kameleoon data and sends the data tracking request with collected data sent data is removed from `KameleoonClient` instance but not from the storage for correct targeting checks.
+     *
+     * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.
+     */
+    flushData: (visitorCode: string) => void;
+}
+/**
+ * A React Hook that returns `flushData` function
+ *
+ * @returns {IFlushDataHookResult} an object containing the `flushData` function.
+ */
+export declare function useFlushData(): IFlushDataHookResult;

package/dist/useFlushData.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFlushData = void 0;
+var react_1 = require("react");
+var useKameleoon_1 = require("./useKameleoon");
+/**
+ * A React Hook that returns `flushData` function
+ *
+ * @returns {IFlushDataHookResult} an object containing the `flushData` function.
+ */
+function useFlushData() {
+    var client = (0, useKameleoon_1.useKameleoon)().client;
+    var flushData = (0, react_1.useCallback)(function (visitorCode) {
+        client.flushData(visitorCode);
+    }, [client]);
+    return {
+        flushData: flushData,
+    };
+}
+exports.useFlushData = useFlushData;
+//# sourceMappingURL=useFlushData.js.map

package/dist/useFlushData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFlushData.js","sourceRoot":"","sources":["../src/useFlushData.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AACpC,+CAA8C;AAW9C;;;;GAIG;AACH,SAAgB,YAAY;IAClB,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAElC,IAAM,SAAS,GAAG,IAAA,mBAAW,EAC3B,UAAC,WAAmB;QAClB,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAChC,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,OAAO;QACL,SAAS,WAAA;KACV,CAAC;AACJ,CAAC;AAbD,oCAaC"}

package/dist/useInitialize.d.ts

@@ -0,0 +1,15 @@
+import { KameleoonError } from './KameleoonError';
+export interface IInitializeHookResult {
+    /**
+     *  An asynchronous method for KameleoonClient initialization by fetching Kameleoon SDK related data from server or by retrieving data from local source if data is up-to-date or update interval has not been reached.
+     */
+    initialize: () => Promise<boolean>;
+    /** An optional error object that may be returned if an error occurs while calling the `initialize` function. */
+    error: KameleoonError | null;
+}
+/**
+ * A React Hook that returns asynchronous `initialize` function.
+ *
+ * @returns {IInitializeHookResult} an object containing the asynchronous `initialize` function and an optional error object.
+ */
+export declare function useInitialize(): IInitializeHookResult;

package/dist/{useAsyncVisitorCode.js → useInitialize.js}

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -36,21 +36,39 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useAsyncVisitorCode = void 0;
+exports.useInitialize = 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 obtains the Kameleoon visitorCode asynchronously for the current visitor
+ * A React Hook that returns asynchronous `initialize` function.
+ *
+ * @returns {IInitializeHookResult} an object containing the asynchronous `initialize` function and an optional error object.
  */
-function useAsyncVisitorCode() {
+function useInitialize() {
     var _this = this;
     var client = (0, useKameleoon_1.useKameleoon)().client;
-    var getAsyncVisitorCode = (0, react_1.useCallback)(function (topLevelDomain, defaultVisitorCode) { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
-        return [2 /*return*/, client.obtainAsyncVisitorCode(topLevelDomain, defaultVisitorCode)];
-    }); }); }, [client]);
+    var _a = (0, useError_1.useError)(), error = _a.error, setError = _a.setError;
+    var initialize = (0, react_1.useCallback)(function () { return __awaiter(_this, void 0, void 0, function () {
+        var unknownError_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    return [4 /*yield*/, client.initialize()];
+                case 1: return [2 /*return*/, _a.sent()];
+                case 2:
+                    unknownError_1 = _a.sent();
+                    setError(unknownError_1);
+                    return [2 /*return*/, false];
+                case 3: return [2 /*return*/];
+            }
+        });
+    }); }, [client]);
     return {
-        getAsyncVisitorCode: getAsyncVisitorCode,
+        initialize: initialize,
+        error: error,
     };
 }
-exports.useAsyncVisitorCode = useAsyncVisitorCode;
-//# sourceMappingURL=useAsyncVisitorCode.js.map
+exports.useInitialize = useInitialize;
+//# sourceMappingURL=useInitialize.js.map

package/dist/useInitialize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useInitialize.js","sourceRoot":"","sources":["../src/useInitialize.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAAoC;AACpC,+CAA8C;AAC9C,uCAAsC;AAYtC;;;;GAIG;AACH,SAAgB,aAAa;IAA7B,iBAkBC;IAjBS,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAC5B,IAAA,KAAsB,IAAA,mBAAQ,GAAE,EAA9B,KAAK,WAAA,EAAE,QAAQ,cAAe,CAAC;IAEvC,IAAM,UAAU,GAAG,IAAA,mBAAW,EAAC;;;;;;oBAEpB,qBAAM,MAAM,CAAC,UAAU,EAAE,EAAA;wBAAhC,sBAAO,SAAyB,EAAC;;;oBAEjC,QAAQ,CAAC,cAAY,CAAC,CAAC;oBAEvB,sBAAO,KAAK,EAAC;;;;SAEhB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEb,OAAO;QACL,UAAU,YAAA;QACV,KAAK,OAAA;KACN,CAAC;AACJ,CAAC;AAlBD,sCAkBC"}

package/dist/useKameleoon.d.ts

@@ -1,10 +1,11 @@
-import { KameleoonClient } from '@kameleoon/javascript-sdk-core';
-interface KameleoonHookResult {
-    /** An instance of KameleoonClient */
-    client: KameleoonClient;
+import { KameleoonCore } from '@kameleoon/javascript-sdk-core';
+export interface IKameleoonHookResult {
+    /** An instance of KameleoonClient. */
+    client: KameleoonCore;
 }
 /**
- * A React Hook that validates if context is used within a KameleoonProvider and returns it
+ * A React Hook that validates if context is used within a KameleoonProvider and returns it.
+ *
+ * @returns {IKameleoonHookResult}
  */
-export declare function useKameleoon(): KameleoonHookResult;
-export {};
+export declare function useKameleoon(): IKameleoonHookResult;

package/dist/useKameleoon.js

@@ -5,7 +5,9 @@ var react_1 = require("react");
 var KameleoonContext_1 = require("./KameleoonContext");
 var ProviderError_1 = require("./ProviderError");
 /**
- * A React Hook that validates if context is used within a KameleoonProvider and returns it
+ * A React Hook that validates if context is used within a KameleoonProvider and returns it.
+ *
+ * @returns {IKameleoonHookResult}
  */
 function useKameleoon() {
     var context = (0, react_1.useContext)(KameleoonContext_1.KameleoonContext);

package/dist/useKameleoon.js.map

@@ -1 +1 @@
-{"version":3,"file":"useKameleoon.js","sourceRoot":"","sources":["../src/useKameleoon.ts"],"names":[],"mappings":";;;AAAA,+BAAmC;AAEnC,uDAAsD;AACtD,iDAAgD;AAOhD;;GAEG;AACH,SAAgB,YAAY;IAC1B,IAAM,OAAO,GAAG,IAAA,kBAAU,EAAC,mCAAgB,CAAC,CAAC;IAE7C,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,6BAAa,CAAC,cAAc,CAAC,CAAC;KACzC;IAED,OAAO;QACL,MAAM,EAAE,OAAO;KAChB,CAAC;AACJ,CAAC;AAVD,oCAUC"}
+{"version":3,"file":"useKameleoon.js","sourceRoot":"","sources":["../src/useKameleoon.ts"],"names":[],"mappings":";;;AAAA,+BAAmC;AAEnC,uDAAsD;AACtD,iDAAgD;AAOhD;;;;GAIG;AACH,SAAgB,YAAY;IAC1B,IAAM,OAAO,GAAG,IAAA,kBAAU,EAAC,mCAAgB,CAAC,CAAC;IAE7C,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,6BAAa,CAAC,cAAc,CAAC,CAAC;KACzC;IAED,OAAO;QACL,MAAM,EAAE,OAAO;KAChB,CAAC;AACJ,CAAC;AAVD,oCAUC"}

package/dist/useNativeVisitorCode.d.ts

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

package/dist/useNativeVisitorCode.js

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

package/dist/useNativeVisitorCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useNativeVisitorCode.js","sourceRoot":"","sources":["../src/useNativeVisitorCode.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AACpC,4DAA2D;AAY3D;;;;GAIG;AACH,SAAgB,oBAAoB;IAClC,IAAM,oBAAoB,GAAG,IAAA,mBAAW,EACtC,UAAC,kBAA2B;QAC1B,OAAO,yBAAW,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IACxD,CAAC,EACD,EAAE,CACH,CAAC;IAEF,OAAO;QACL,oBAAoB,sBAAA;KACrB,CAAC;AACJ,CAAC;AAXD,oDAWC"}

package/dist/useRemoteData.d.ts

@@ -0,0 +1,19 @@
+import { JSONType } from '@kameleoon/javascript-sdk-core';
+import { KameleoonError } from './KameleoonError';
+export interface IRemoteDataHookResult {
+    /**
+     * Returns a data which is stored for specified siteCode on a remote Kameleoon server.
+     *
+     * @param {string} key - unique key that the data you try to get is associated with.
+     * @returns {Promise<JSONType | undefined>} promise with retrieving data for specific key.
+     */
+    getRemoteData: (key: string) => Promise<JSONType | undefined>;
+    /** An optional error object that may be returned if an error occurs while calling the `getRemoteData` function. */
+    error: KameleoonError | null;
+}
+/**
+ * A React Hook that returns asynchronous getRemoteData function which retrieves data from Kameleoon server.
+ *
+ * @returns {IRemoteDataHookResult} an object containing the `getRemoteData` function.
+ */
+export declare function useRemoteData(): IRemoteDataHookResult;

package/dist/{useRetrieveDataFromRemoteSource.js → useRemoteData.js}

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -36,44 +36,41 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useRetrieveDataFromRemoteSource = void 0;
+exports.useRemoteData = void 0;
 var react_1 = require("react");
 var useKameleoon_1 = require("./useKameleoon");
-var ProviderError_1 = require("./ProviderError");
-var KameleoonError_1 = require("./KameleoonError");
-var constants_1 = require("./constants");
+var useError_1 = require("./useError");
 /**
- * A React Hook that returns asynchronous callback function which retrieves data from Kameleoon Data API
+ * A React Hook that returns asynchronous getRemoteData function which retrieves data from Kameleoon server.
+ *
+ * @returns {IRemoteDataHookResult} an object containing the `getRemoteData` function.
  */
-function useRetrieveDataFromRemoteSource() {
+function useRemoteData() {
     var _this = this;
     var client = (0, useKameleoon_1.useKameleoon)().client;
-    var isObjectEmpty = (0, react_1.useCallback)(function (object) {
-        return (object &&
-            Object.keys(object).length === 0 &&
-            Object.getPrototypeOf(object) === Object.prototype);
-    }, []);
-    var retrieveDataFromRemoteSource = (0, react_1.useCallback)(function (key) { return __awaiter(_this, void 0, void 0, function () {
-        var resultData, error;
+    var _a = (0, useError_1.useError)(), error = _a.error, setError = _a.setError;
+    var getRemoteData = (0, react_1.useCallback)(function (key) { return __awaiter(_this, void 0, void 0, function () {
+        var remoteData, unknownError_1;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, client.retrieveDataFromRemoteSource(key)];
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    return [4 /*yield*/, client.getRemoteData(key)];
                 case 1:
-                    resultData = (_a.sent());
-                    if (isObjectEmpty(resultData)) {
-                        error = new KameleoonError_1.KameleoonError(constants_1.KameleoonException.NoDataWasRetrievedFromRemoteServer);
-                        return [2 /*return*/, { data: null, error: error }];
-                    }
-                    return [2 /*return*/, { data: resultData, error: null }];
+                    remoteData = _a.sent();
+                    return [2 /*return*/, remoteData];
+                case 2:
+                    unknownError_1 = _a.sent();
+                    setError(unknownError_1);
+                    return [2 /*return*/, undefined];
+                case 3: return [2 /*return*/];
             }
         });
-    }); }, [client, isObjectEmpty]);
-    if (!client) {
-        throw new ProviderError_1.ProviderError('useKameleoon');
-    }
+    }); }, [client]);
     return {
-        retrieveDataFromRemoteSource: retrieveDataFromRemoteSource,
+        getRemoteData: getRemoteData,
+        error: error,
     };
 }
-exports.useRetrieveDataFromRemoteSource = useRetrieveDataFromRemoteSource;
-//# sourceMappingURL=useRetrieveDataFromRemoteSource.js.map
+exports.useRemoteData = useRemoteData;
+//# sourceMappingURL=useRemoteData.js.map

package/dist/useRemoteData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRemoteData.js","sourceRoot":"","sources":["../src/useRemoteData.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAAoC;AAEpC,+CAA8C;AAE9C,uCAAsC;AActC;;;;GAIG;AACH,SAAgB,aAAa;IAA7B,iBAuBC;IAtBS,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAC5B,IAAA,KAAsB,IAAA,mBAAQ,GAAE,EAA9B,KAAK,WAAA,EAAE,QAAQ,cAAe,CAAC;IAEvC,IAAM,aAAa,GAAG,IAAA,mBAAW,EAC/B,UAAO,GAAW;;;;;;oBAEK,qBAAM,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,EAAA;;oBAA5C,UAAU,GAAG,SAA+B;oBAElD,sBAAO,UAAU,EAAC;;;oBAElB,QAAQ,CAAC,cAAY,CAAC,CAAC;oBAEvB,sBAAO,SAAS,EAAC;;;;SAEpB,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,OAAO;QACL,aAAa,eAAA;QACb,KAAK,OAAA;KACN,CAAC;AACJ,CAAC;AAvBD,sCAuBC"}

package/dist/useTrackConversion.d.ts

@@ -0,0 +1,18 @@
+import { TrackConversionParamsType } from '@kameleoon/javascript-sdk-core';
+import { KameleoonError } from './KameleoonError';
+export interface ITrackConversionHookResult {
+    /**
+     * Creates and adds `Conversion` data to the visitor with specified parameters and executes `flushData`. Note: it's a helper method for the quick and convenient conversion tracking, however creating and adding `Conversion` manually allows more flexible `Conversion` with `negative` parameter.
+     *
+     * @param {TrackConversionParamsType} params - `visitorCode`, `goalId` and `revenue` parameters for data tracking.
+     */
+    trackConversion: (params: TrackConversionParamsType) => void;
+    /** An optional error object that may be returned if an error occurs while calling the `trackConversion` function. */
+    error: KameleoonError | null;
+}
+/**
+ * A React Hook that returns trackConversion function which tracks conversion.
+ *
+ * @returns {ITrackConversionHookResult} an object containing the `trackConversion` function.
+ */
+export declare function useTrackConversion(): ITrackConversionHookResult;

package/dist/useTrackConversion.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTrackConversion = void 0;
+var react_1 = require("react");
+var useKameleoon_1 = require("./useKameleoon");
+var useError_1 = require("./useError");
+/**
+ * A React Hook that returns trackConversion function which tracks conversion.
+ *
+ * @returns {ITrackConversionHookResult} an object containing the `trackConversion` function.
+ */
+function useTrackConversion() {
+    var client = (0, useKameleoon_1.useKameleoon)().client;
+    var _a = (0, useError_1.useError)(), error = _a.error, setError = _a.setError;
+    var trackConversion = (0, react_1.useCallback)(function (params) {
+        try {
+            client.trackConversion(params);
+        }
+        catch (unknownError) {
+            setError(unknownError);
+        }
+    }, [client]);
+    return {
+        trackConversion: trackConversion,
+        error: error,
+    };
+}
+exports.useTrackConversion = useTrackConversion;
+//# sourceMappingURL=useTrackConversion.js.map

package/dist/useTrackConversion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTrackConversion.js","sourceRoot":"","sources":["../src/useTrackConversion.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AAGpC,+CAA8C;AAC9C,uCAAsC;AAatC;;;;GAIG;AACH,SAAgB,kBAAkB;IACxB,IAAA,MAAM,GAAK,IAAA,2BAAY,GAAE,OAAnB,CAAoB;IAC5B,IAAA,KAAsB,IAAA,mBAAQ,GAAE,EAA9B,KAAK,WAAA,EAAE,QAAQ,cAAe,CAAC;IAEvC,IAAM,eAAe,GAAG,IAAA,mBAAW,EACjC,UAAC,MAAiC;QAChC,IAAI;YACF,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;SAChC;QAAC,OAAO,YAAY,EAAE;YACrB,QAAQ,CAAC,YAAY,CAAC,CAAC;SACxB;IACH,CAAC,EACD,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,OAAO;QACL,eAAe,iBAAA;QACf,KAAK,OAAA;KACN,CAAC;AACJ,CAAC;AAnBD,gDAmBC"}

package/dist/useTriggerExperiment.d.ts

@@ -1,17 +1,19 @@
 import { KameleoonError } from './KameleoonError';
-interface IGetVariationIdHookResult {
+export interface ITriggerExperimentHookResult {
     /**
-     * @param visitorCode - unique identifier of the user
-     * @param experimentId - unique identifier of the experiment you want to expose to a user
+     * Triggers experiment by assigning the variation to the user with `visitorCode`, if the variation is already assigned just returns it's id. Note: returned id `0` indicates default variation. At the same time executes `flushData` without sending extra request.
+     *
+     * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.
+     * @param {number} experimentId - id of experiment running for the current visitor.
+     * @returns {number} associated variationId which is successfully searched/assigned.
      */
-    getVariationId: (visitorCode: string, experimentId: number) => number;
+    triggerExperiment: (visitorCode: string, experimentId: number) => number;
+    /** An optional error object that may be returned if an error occurs while calling the `triggerExperiment` function. */
     error: KameleoonError | null;
 }
 /**
- * A React Hook that returns callback function which triggers experiment.
- * If such a user has never been associated with any variation, the SDK returns a randomly selected variation.
- * If a user with a given visitorCode is already registered with a variation,
- * it will detect the previously registered variation and return the variationID
+ * A React Hook that returns `triggerExperiment` function which triggers experiment.
+ *
+ * @returns {ITriggerExperimentHookResult} an object containing the `triggerExperiment` function.
  */
-export declare function useTriggerExperiment(): IGetVariationIdHookResult;
-export {};
+export declare function useTriggerExperiment(): ITriggerExperimentHookResult;

package/dist/useTriggerExperiment.js

@@ -4,27 +4,26 @@ exports.useTriggerExperiment = void 0;
 var react_1 = require("react");
 var useKameleoon_1 = require("./useKameleoon");
 var useError_1 = require("./useError");
+var constants_1 = require("./constants");
 /**
- * A React Hook that returns callback function which triggers experiment.
- * If such a user has never been associated with any variation, the SDK returns a randomly selected variation.
- * If a user with a given visitorCode is already registered with a variation,
- * it will detect the previously registered variation and return the variationID
+ * A React Hook that returns `triggerExperiment` function which triggers experiment.
+ *
+ * @returns {ITriggerExperimentHookResult} an object containing the `triggerExperiment` function.
  */
 function useTriggerExperiment() {
-    var _a = (0, useError_1.useError)(), error = _a.error, setError = _a.setError;
     var client = (0, useKameleoon_1.useKameleoon)().client;
-    var DEFAULT_VARIATION_ID = 0;
-    var getVariationId = (0, react_1.useCallback)(function (visitorCode, experimentId) {
+    var _a = (0, useError_1.useError)(), error = _a.error, setError = _a.setError;
+    var triggerExperiment = (0, react_1.useCallback)(function (visitorCode, experimentId) {
         try {
             return client.triggerExperiment(visitorCode, experimentId);
         }
         catch (unknownError) {
             setError(unknownError);
-            return DEFAULT_VARIATION_ID;
+            return constants_1.DEFAULT_VARIATION_ID;
         }
     }, [client, setError]);
     return {
-        getVariationId: getVariationId,
+        triggerExperiment: triggerExperiment,
         error: error,
     };
 }