@kameleoon/react-sdk 6.1.3 → 7.0.0

package/dist/useExperiments.js.map

@@ -1 +1 @@
-{"version":3,"file":"useExperiments.js","names":["_react","require","_useKameleoon","_useError","useExperiments","client","useKameleoon","error","setError","useError","getExperiments","useCallback","unknownError"],"sources":["../src/useExperiments.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { ExperimentType } from '@kameleoon/javascript-sdk-core';\nimport { useKameleoon } from './useKameleoon';\nimport { useError } from './useError';\nimport { KameleoonError } from './KameleoonError';\n\nexport interface IExperimentsHookResult {\n  /**\n   * Returns a list of experiments stored in the client configuration.\n   *\n   * @returns {ExperimentType[]} a list of all experiments items with `id` and `name` fields.\n   */\n  getExperiments: () => ExperimentType[];\n  /** An optional error object that may be returned if an error occurs while calling the `getExperiments` function. */\n  error: KameleoonError | null;\n}\n\n/**\n * A React Hook that returns `getExperiments` function which returns a list of experiments.\n *\n * @returns {IExperimentsHookResult} an object containing the `getExperiments` function and an optional error object.\n */\nexport function useExperiments(): IExperimentsHookResult {\n  const { client } = useKameleoon();\n  const { error, setError } = useError();\n\n  const getExperiments = useCallback((): ExperimentType[] => {\n    try {\n      return client.getExperiments();\n    } catch (unknownError) {\n      setError(unknownError);\n\n      return [];\n    }\n  }, [client]);\n\n  return {\n    getExperiments,\n    error,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,aAAA,GAAAD,OAAA;AACA,IAAAE,SAAA,GAAAF,OAAA;AAcA;AACA;AACA;AACA;AACA;AACO,SAASG,cAAcA,CAAA,EAA2B;EACvD,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EACjC,MAAM;IAAEC,KAAK;IAAEC;EAAS,CAAC,GAAG,IAAAC,kBAAQ,GAAE;EAEtC,MAAMC,cAAc,GAAG,IAAAC,kBAAW,EAAC,MAAwB;IACzD,IAAI;MACF,OAAON,MAAM,CAACK,cAAc,EAAE;IAChC,CAAC,CAAC,OAAOE,YAAY,EAAE;MACrBJ,QAAQ,CAACI,YAAY,CAAC;MAEtB,OAAO,EAAE;IACX;EACF,CAAC,EAAE,CAACP,MAAM,CAAC,CAAC;EAEZ,OAAO;IACLK,cAAc;IACdH;EACF,CAAC;AACH"}
+{"version":3,"file":"useExperiments.js","names":["_react","require","_useKameleoon","useExperiments","client","useKameleoon","getExperiments","useCallback"],"sources":["../src/useExperiments.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { ExperimentType } from '@kameleoon/javascript-sdk-core';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IExperimentsHookResult {\n  /**\n   * Returns a list of experiments stored in the client configuration.\n   *\n   * @returns {ExperimentType[]} a list of all experiments items with `id` and `name` fields.\n   * @throws `KameleoonError` with one of the following `type` s:\n   * \n   * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.\n   */\n  getExperiments: () => ExperimentType[];\n}\n\n/**\n * A React Hook that returns `getExperiments` function which returns a list of experiments.\n *\n * @returns {IExperimentsHookResult} an object containing the `getExperiments` function.\n */\nexport function useExperiments(): IExperimentsHookResult {\n  const { client } = useKameleoon();\n\n  const getExperiments = useCallback((): ExperimentType[] => {\n    return client.getExperiments();\n  }, [client]);\n\n  return {\n    getExperiments,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,aAAA,GAAAD,OAAA;AAcA;AACA;AACA;AACA;AACA;AACO,SAASE,cAAcA,CAAA,EAA2B;EACvD,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,cAAc,GAAG,IAAAC,kBAAW,EAAC,MAAwB;IACzD,OAAOH,MAAM,CAACE,cAAc,EAAE;EAChC,CAAC,EAAE,CAACF,MAAM,CAAC,CAAC;EAEZ,OAAO;IACLE;EACF,CAAC;AACH"}

package/dist/useFeatureFlagActive.d.ts

@@ -1,15 +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`.
+     * 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.
      *
      * @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`.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.
+     * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.
+     * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `visitorCode` and `featureKey`.
+     * - `KameleoonException.DataInconsistency` - Allocated variation was found but there is no feature flag with according `featureKey`.
+     * - `KameleoonException.NotTargeted` - Current visitor is not targeted.
      */
     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.

package/dist/useFeatureFlagActive.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.useFeatureFlagActive = useFeatureFlagActive;
 var _react = require("react");
 var _useKameleoon = require("./useKameleoon");
-var _useError = require("./useError");
 /**
  * A React Hook that returns `isFeatureFlagActive` function which indicates whether the visitor with `visitorCode` has `featureKey` active for him.
  *
@@ -16,21 +15,11 @@ function useFeatureFlagActive() {
   const {
     client
   } = (0, _useKameleoon.useKameleoon)();
-  const {
-    error,
-    setError
-  } = (0, _useError.useError)();
   const isFeatureFlagActive = (0, _react.useCallback)((visitorCode, featureKey) => {
-    try {
-      return client.isFeatureFlagActive(visitorCode, featureKey);
-    } catch (unknownError) {
-      setError(unknownError);
-      return false;
-    }
-  }, [client, setError]);
+    return client.isFeatureFlagActive(visitorCode, featureKey);
+  }, [client]);
   return {
-    isFeatureFlagActive,
-    error
+    isFeatureFlagActive
   };
 }
 //# sourceMappingURL=useFeatureFlagActive.js.map

package/dist/useFeatureFlagActive.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFeatureFlagActive.js","names":["_react","require","_useKameleoon","_useError","useFeatureFlagActive","client","useKameleoon","error","setError","useError","isFeatureFlagActive","useCallback","visitorCode","featureKey","unknownError"],"sources":["../src/useFeatureFlagActive.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\nimport { KameleoonError } from './KameleoonError';\nimport { useError } from './useError';\n\nexport interface IFeatureFlagActiveHookResult {\n  /**\n   * 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`.\n   *\n   * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @param {string} featureKey - a unique key for feature flag.\n   * @returns {boolean} a boolean indicator of whether the feature flag with `featureKey` is active for visitor with `visitorCode`.\n   */\n  isFeatureFlagActive: (visitorCode: string, featureKey: string) => boolean;\n  /** An optional error object that may be returned if an error occurs while calling the `isFeatureFlagActive` function. */\n  error: KameleoonError | null;\n}\n\n/**\n * A React Hook that returns `isFeatureFlagActive` function which indicates whether the visitor with `visitorCode` has `featureKey` active for him.\n *\n * @returns {IFeatureFlagActiveHookResult} an object containing the `isFeatureFlagActive` function.\n */\nexport function useFeatureFlagActive(): IFeatureFlagActiveHookResult {\n  const { client } = useKameleoon();\n  const { error, setError } = useError();\n\n  const isFeatureFlagActive = useCallback(\n    (visitorCode: string, featureKey: string): boolean => {\n      try {\n        return client.isFeatureFlagActive(visitorCode, featureKey);\n      } catch (unknownError) {\n        setError(unknownError);\n\n        return false;\n      }\n    },\n    [client, setError],\n  );\n\n  return {\n    isFeatureFlagActive,\n    error,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAEA,IAAAE,SAAA,GAAAF,OAAA;AAeA;AACA;AACA;AACA;AACA;AACO,SAASG,oBAAoBA,CAAA,EAAiC;EACnE,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EACjC,MAAM;IAAEC,KAAK;IAAEC;EAAS,CAAC,GAAG,IAAAC,kBAAQ,GAAE;EAEtC,MAAMC,mBAAmB,GAAG,IAAAC,kBAAW,EACrC,CAACC,WAAmB,EAAEC,UAAkB,KAAc;IACpD,IAAI;MACF,OAAOR,MAAM,CAACK,mBAAmB,CAACE,WAAW,EAAEC,UAAU,CAAC;IAC5D,CAAC,CAAC,OAAOC,YAAY,EAAE;MACrBN,QAAQ,CAACM,YAAY,CAAC;MAEtB,OAAO,KAAK;IACd;EACF,CAAC,EACD,CAACT,MAAM,EAAEG,QAAQ,CAAC,CACnB;EAED,OAAO;IACLE,mBAAmB;IACnBH;EACF,CAAC;AACH"}
+{"version":3,"file":"useFeatureFlagActive.js","names":["_react","require","_useKameleoon","useFeatureFlagActive","client","useKameleoon","isFeatureFlagActive","useCallback","visitorCode","featureKey"],"sources":["../src/useFeatureFlagActive.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IFeatureFlagActiveHookResult {\n  /**\n   * 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.\n   *\n   * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @param {string} featureKey - a unique key for feature flag.\n   * @returns {boolean} a boolean indicator of whether the feature flag with `featureKey` is active for visitor with `visitorCode`.\n   * @throws `KameleoonError` with one of the following `type` s:\n   * \n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.\n   * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.\n   * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `visitorCode` and `featureKey`.\n   * - `KameleoonException.DataInconsistency` - Allocated variation was found but there is no feature flag with according `featureKey`.\n   * - `KameleoonException.NotTargeted` - Current visitor is not targeted.\n   */\n  isFeatureFlagActive: (visitorCode: string, featureKey: string) => boolean;\n}\n\n/**\n * A React Hook that returns `isFeatureFlagActive` function which indicates whether the visitor with `visitorCode` has `featureKey` active for him.\n *\n * @returns {IFeatureFlagActiveHookResult} an object containing the `isFeatureFlagActive` function.\n */\nexport function useFeatureFlagActive(): IFeatureFlagActiveHookResult {\n  const { client } = useKameleoon();\n\n  const isFeatureFlagActive = useCallback(\n    (visitorCode: string, featureKey: string): boolean => {\n      return client.isFeatureFlagActive(visitorCode, featureKey);\n    },\n    [client],\n  );\n\n  return {\n    isFeatureFlagActive,\n  };\n}"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAoBA;AACA;AACA;AACA;AACA;AACO,SAASE,oBAAoBA,CAAA,EAAiC;EACnE,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,mBAAmB,GAAG,IAAAC,kBAAW,EACrC,CAACC,WAAmB,EAAEC,UAAkB,KAAc;IACpD,OAAOL,MAAM,CAACE,mBAAmB,CAACE,WAAW,EAAEC,UAAU,CAAC;EAC5D,CAAC,EACD,CAACL,MAAM,CAAC,CACT;EAED,OAAO;IACLE;EACF,CAAC;AACH"}

package/dist/useFeatureFlagVariationKey.d.ts

@@ -1,19 +1,22 @@
-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`.
+     * 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.
      *
      * @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.
+     * @returns {string}  a string containing variable key for the allocated feature flag variation for the provided visitor.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.
+     * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.
+     * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `visitorCode` and `featureKey`.
+     * - `KameleoonException.NotTargeted` - Current visitor is not targeted.
      */
-    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;
+    getFeatureFlagVariationKey: (visitorCode: string, featureKey: string) => string;
 }
 /**
  * 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.
+ * @returns {IFeatureFlagVariationKeyHookResult} an object containing the `getFeatureFlagVariationKey` function.
  */
 export declare function useFeatureFlagVariationKey(): IFeatureFlagVariationKeyHookResult;

package/dist/useFeatureFlagVariationKey.js

@@ -6,31 +6,20 @@ Object.defineProperty(exports, "__esModule", {
 exports.useFeatureFlagVariationKey = useFeatureFlagVariationKey;
 var _react = require("react");
 var _useKameleoon = require("./useKameleoon");
-var _useError = 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.
+ * @returns {IFeatureFlagVariationKeyHookResult} an object containing the `getFeatureFlagVariationKey` function.
  */
 function useFeatureFlagVariationKey() {
   const {
     client
   } = (0, _useKameleoon.useKameleoon)();
-  const {
-    error,
-    setError
-  } = (0, _useError.useError)();
   const getFeatureFlagVariationKey = (0, _react.useCallback)((visitorCode, featureKey) => {
-    try {
-      return client.getFeatureFlagVariationKey(visitorCode, featureKey);
-    } catch (unknownError) {
-      setError(unknownError);
-      return undefined;
-    }
+    return client.getFeatureFlagVariationKey(visitorCode, featureKey);
   }, [client]);
   return {
-    getFeatureFlagVariationKey,
-    error
+    getFeatureFlagVariationKey
   };
 }
 //# sourceMappingURL=useFeatureFlagVariationKey.js.map

package/dist/useFeatureFlagVariationKey.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFeatureFlagVariationKey.js","names":["_react","require","_useKameleoon","_useError","useFeatureFlagVariationKey","client","useKameleoon","error","setError","useError","getFeatureFlagVariationKey","useCallback","visitorCode","featureKey","unknownError","undefined"],"sources":["../src/useFeatureFlagVariationKey.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\nimport { useError } from './useError';\nimport { KameleoonError } from './KameleoonError';\n\nexport interface IFeatureFlagVariationKeyHookResult {\n  /**\n   * 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`.\n   *\n   * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @param {string} featureKey - a unique key for feature flag.\n   * @returns {string | undefined}  a string containing variable key for the allocated feature flag variation for the provided visitor.\n   */\n  getFeatureFlagVariationKey: (\n    visitorCode: string,\n    featureKey: string,\n  ) => string | undefined;\n  /** An optional error object that may be returned if an error occurs while calling the `getFeatureFlagVariationKey` function. */\n  error: KameleoonError | null;\n}\n\n/**\n * A React Hook that returns `getFeatureFlagVariationKey` function which returns variation key for the visitor under `visitorCode` in the found feature flag.\n *\n * @returns {IFeatureFlagVariationKeyHookResult} an object containing the `getFeatureFlagVariationKey` function and an optional error object.\n */\nexport function useFeatureFlagVariationKey(): IFeatureFlagVariationKeyHookResult {\n  const { client } = useKameleoon();\n  const { error, setError } = useError();\n\n  const getFeatureFlagVariationKey = useCallback(\n    (visitorCode: string, featureKey: string): string | undefined => {\n      try {\n        return client.getFeatureFlagVariationKey(visitorCode, featureKey);\n      } catch (unknownError) {\n        setError(unknownError);\n\n        return undefined;\n      }\n    },\n    [client],\n  );\n\n  return {\n    getFeatureFlagVariationKey,\n    error,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AACA,IAAAE,SAAA,GAAAF,OAAA;AAmBA;AACA;AACA;AACA;AACA;AACO,SAASG,0BAA0BA,CAAA,EAAuC;EAC/E,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EACjC,MAAM;IAAEC,KAAK;IAAEC;EAAS,CAAC,GAAG,IAAAC,kBAAQ,GAAE;EAEtC,MAAMC,0BAA0B,GAAG,IAAAC,kBAAW,EAC5C,CAACC,WAAmB,EAAEC,UAAkB,KAAyB;IAC/D,IAAI;MACF,OAAOR,MAAM,CAACK,0BAA0B,CAACE,WAAW,EAAEC,UAAU,CAAC;IACnE,CAAC,CAAC,OAAOC,YAAY,EAAE;MACrBN,QAAQ,CAACM,YAAY,CAAC;MAEtB,OAAOC,SAAS;IAClB;EACF,CAAC,EACD,CAACV,MAAM,CAAC,CACT;EAED,OAAO;IACLK,0BAA0B;IAC1BH;EACF,CAAC;AACH"}
+{"version":3,"file":"useFeatureFlagVariationKey.js","names":["_react","require","_useKameleoon","useFeatureFlagVariationKey","client","useKameleoon","getFeatureFlagVariationKey","useCallback","visitorCode","featureKey"],"sources":["../src/useFeatureFlagVariationKey.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IFeatureFlagVariationKeyHookResult {\n  /**\n   * 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.\n   *\n   * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @param {string} featureKey - a unique key for feature flag.\n   * @returns {string}  a string containing variable key for the allocated feature flag variation for the provided visitor.\n   * @throws `KameleoonError` with one of the following `type` s:\n   * \n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.\n   * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.\n   * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `visitorCode` and `featureKey`.\n   * - `KameleoonException.NotTargeted` - Current visitor is not targeted.\n   */\n  getFeatureFlagVariationKey: (\n    visitorCode: string,\n    featureKey: string,\n  ) => string;\n}\n\n/**\n * A React Hook that returns `getFeatureFlagVariationKey` function which returns variation key for the visitor under `visitorCode` in the found feature flag.\n *\n * @returns {IFeatureFlagVariationKeyHookResult} an object containing the `getFeatureFlagVariationKey` function.\n */\nexport function useFeatureFlagVariationKey(): IFeatureFlagVariationKeyHookResult {\n  const { client } = useKameleoon();\n\n  const getFeatureFlagVariationKey = useCallback(\n    (visitorCode: string, featureKey: string): string => {\n      return client.getFeatureFlagVariationKey(visitorCode, featureKey);\n    },\n    [client],\n  );\n\n  return {\n    getFeatureFlagVariationKey,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAsBA;AACA;AACA;AACA;AACA;AACO,SAASE,0BAA0BA,CAAA,EAAuC;EAC/E,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,0BAA0B,GAAG,IAAAC,kBAAW,EAC5C,CAACC,WAAmB,EAAEC,UAAkB,KAAa;IACnD,OAAOL,MAAM,CAACE,0BAA0B,CAACE,WAAW,EAAEC,UAAU,CAAC;EACnE,CAAC,EACD,CAACL,MAAM,CAAC,CACT;EAED,OAAO;IACLE;EACF,CAAC;AACH"}

package/dist/useFeatureFlags.d.ts

@@ -1,18 +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.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.
      */
     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.
+ * @returns {IFeatureFlagsHookResult} an object containing the `getFeatureFlags` function.
  */
 export declare function useFeatureFlags(): IFeatureFlagsHookResult;

package/dist/useFeatureFlags.js

@@ -6,31 +6,20 @@ Object.defineProperty(exports, "__esModule", {
 exports.useFeatureFlags = useFeatureFlags;
 var _react = require("react");
 var _useKameleoon = require("./useKameleoon");
-var _useError = 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.
+ * @returns {IFeatureFlagsHookResult} an object containing the `getFeatureFlags` function.
  */
 function useFeatureFlags() {
   const {
     client
   } = (0, _useKameleoon.useKameleoon)();
-  const {
-    error,
-    setError
-  } = (0, _useError.useError)();
   const getFeatureFlags = (0, _react.useCallback)(() => {
-    try {
-      return client.getFeatureFlags();
-    } catch (unknownError) {
-      setError(unknownError);
-      return [];
-    }
+    return client.getFeatureFlags();
   }, [client]);
   return {
-    getFeatureFlags,
-    error
+    getFeatureFlags
   };
 }
 //# sourceMappingURL=useFeatureFlags.js.map

package/dist/useFeatureFlags.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFeatureFlags.js","names":["_react","require","_useKameleoon","_useError","useFeatureFlags","client","useKameleoon","error","setError","useError","getFeatureFlags","useCallback","unknownError"],"sources":["../src/useFeatureFlags.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { FeatureFlagType } from '@kameleoon/javascript-sdk-core';\nimport { useKameleoon } from './useKameleoon';\nimport { useError } from './useError';\nimport { KameleoonError } from './KameleoonError';\n\nexport interface IFeatureFlagsHookResult {\n  /**\n   * Returns a list of feature flags stored in the client configuration.\n   *\n   * @returns {FeatureFlagType[]} a list of all feature flags items with `id` and `key` fields.\n   */\n  getFeatureFlags: () => FeatureFlagType[];\n  /** An optional error object that may be returned if an error occurs while calling the `getFeatureFlags` function. */\n  error: KameleoonError | null;\n}\n\n/**\n * A React Hook that returns `getFeatureFlags` function which returns a list of feature flags.\n *\n * @returns {IFeatureFlagsHookResult} an object containing the `getFeatureFlags` function and an optional error object.\n */\nexport function useFeatureFlags(): IFeatureFlagsHookResult {\n  const { client } = useKameleoon();\n  const { error, setError } = useError();\n\n  const getFeatureFlags = useCallback((): FeatureFlagType[] => {\n    try {\n      return client.getFeatureFlags();\n    } catch (unknownError) {\n      setError(unknownError);\n\n      return [];\n    }\n  }, [client]);\n\n  return {\n    getFeatureFlags,\n    error,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,aAAA,GAAAD,OAAA;AACA,IAAAE,SAAA,GAAAF,OAAA;AAcA;AACA;AACA;AACA;AACA;AACO,SAASG,eAAeA,CAAA,EAA4B;EACzD,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EACjC,MAAM;IAAEC,KAAK;IAAEC;EAAS,CAAC,GAAG,IAAAC,kBAAQ,GAAE;EAEtC,MAAMC,eAAe,GAAG,IAAAC,kBAAW,EAAC,MAAyB;IAC3D,IAAI;MACF,OAAON,MAAM,CAACK,eAAe,EAAE;IACjC,CAAC,CAAC,OAAOE,YAAY,EAAE;MACrBJ,QAAQ,CAACI,YAAY,CAAC;MAEtB,OAAO,EAAE;IACX;EACF,CAAC,EAAE,CAACP,MAAM,CAAC,CAAC;EAEZ,OAAO;IACLK,eAAe;IACfH;EACF,CAAC;AACH"}
+{"version":3,"file":"useFeatureFlags.js","names":["_react","require","_useKameleoon","useFeatureFlags","client","useKameleoon","getFeatureFlags","useCallback"],"sources":["../src/useFeatureFlags.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { FeatureFlagType } from '@kameleoon/javascript-sdk-core';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IFeatureFlagsHookResult {\n  /**\n   * Returns a list of feature flags stored in the client configuration.\n   *\n   * @returns {FeatureFlagType[]} a list of all feature flags items with `id` and `key` fields.\n   * @throws `KameleoonError` with one of the following `type` s:\n   * \n   * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.\n   */\n  getFeatureFlags: () => FeatureFlagType[];\n}\n\n/**\n * A React Hook that returns `getFeatureFlags` function which returns a list of feature flags.\n *\n * @returns {IFeatureFlagsHookResult} an object containing the `getFeatureFlags` function.\n */\nexport function useFeatureFlags(): IFeatureFlagsHookResult {\n  const { client } = useKameleoon();\n\n  const getFeatureFlags = useCallback((): FeatureFlagType[] => {\n    return client.getFeatureFlags();\n  }, [client]);\n\n  return {\n    getFeatureFlags,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,aAAA,GAAAD,OAAA;AAcA;AACA;AACA;AACA;AACA;AACO,SAASE,eAAeA,CAAA,EAA4B;EACzD,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,eAAe,GAAG,IAAAC,kBAAW,EAAC,MAAyB;IAC3D,OAAOH,MAAM,CAACE,eAAe,EAAE;EACjC,CAAC,EAAE,CAACF,MAAM,CAAC,CAAC;EAEZ,OAAO;IACLE;EACF,CAAC;AACH"}

package/dist/useFeatureVariable.d.ts

@@ -1,15 +1,20 @@
 import { GetFeatureFlagVariableParamsType, FeatureVariableResultType } from '@kameleoon/javascript-sdk-core';
-import { KameleoonError } from './KameleoonError';
 export interface IFeatureVariableHookResult {
     /**
-     * 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`.
+     * 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.
      *
      * @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.
+     * @return {FeatureVariableResultType} 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.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.
+     * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.
+     * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `visitorCode` and `featureKey`.
+     * - `KameleoonException.NotTargeted` - Current visitor is not targeted.
+     * - `KameleoonException.JSONParse` - Couldn't pass JSON value.
+     * - `KameleoonException.NumberParse` - Couldn't pass Number value.
      */
-    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;
+    getFeatureFlagVariable: (params: GetFeatureFlagVariableParamsType) => FeatureVariableResultType;
 }
 /**
  * A React Hook that returns `getFeatureFlagVariable` function which retrieves a feature variable.

package/dist/useFeatureVariable.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.useFeatureVariable = useFeatureVariable;
 var _react = require("react");
 var _useKameleoon = require("./useKameleoon");
-var _useError = require("./useError");
 /**
  * A React Hook that returns `getFeatureFlagVariable` function which retrieves a feature variable.
  *
@@ -16,21 +15,11 @@ function useFeatureVariable() {
   const {
     client
   } = (0, _useKameleoon.useKameleoon)();
-  const {
-    error,
-    setError
-  } = (0, _useError.useError)();
   const getFeatureFlagVariable = (0, _react.useCallback)(params => {
-    try {
-      return client.getFeatureFlagVariable(params);
-    } catch (unknownError) {
-      setError(unknownError);
-      return undefined;
-    }
-  }, [client, setError]);
+    return client.getFeatureFlagVariable(params);
+  }, [client]);
   return {
-    getFeatureFlagVariable,
-    error
+    getFeatureFlagVariable
   };
 }
 //# sourceMappingURL=useFeatureVariable.js.map

package/dist/useFeatureVariable.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFeatureVariable.js","names":["_react","require","_useKameleoon","_useError","useFeatureVariable","client","useKameleoon","error","setError","useError","getFeatureFlagVariable","useCallback","params","unknownError","undefined"],"sources":["../src/useFeatureVariable.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport {\n  GetFeatureFlagVariableParamsType,\n  FeatureVariableResultType,\n} from '@kameleoon/javascript-sdk-core';\nimport { useKameleoon } from './useKameleoon';\nimport { KameleoonError } from './KameleoonError';\nimport { useError } from './useError';\n\nexport interface IFeatureVariableHookResult {\n  /**\n   * 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`.\n   *\n   * @param {GetFeatureFlagVariableParamsType} params - `visitorCode`, `featureKey` and `variableKey` parameters to return variable.\n   * @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.\n   */\n  getFeatureFlagVariable: (\n    params: GetFeatureFlagVariableParamsType,\n  ) => FeatureVariableResultType | undefined;\n  /** An optional error object that may be returned if an error occurs while calling the `getFeatureFlagVariable` function. */\n  error: KameleoonError | null;\n}\n\n/**\n * A React Hook that returns `getFeatureFlagVariable` function which retrieves a feature variable.\n *\n * @returns {IPageViewHookResult} an object containing the `getFeatureFlagVariable` function.\n */\nexport function useFeatureVariable(): IFeatureVariableHookResult {\n  const { client } = useKameleoon();\n  const { error, setError } = useError();\n\n  const getFeatureFlagVariable = useCallback(\n    (\n      params: GetFeatureFlagVariableParamsType,\n    ): FeatureVariableResultType | undefined => {\n      try {\n        return client.getFeatureFlagVariable(params);\n      } catch (unknownError) {\n        setError(unknownError);\n\n        return undefined;\n      }\n    },\n    [client, setError],\n  );\n\n  return {\n    getFeatureFlagVariable,\n    error,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAKA,IAAAC,aAAA,GAAAD,OAAA;AAEA,IAAAE,SAAA,GAAAF,OAAA;AAgBA;AACA;AACA;AACA;AACA;AACO,SAASG,kBAAkBA,CAAA,EAA+B;EAC/D,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EACjC,MAAM;IAAEC,KAAK;IAAEC;EAAS,CAAC,GAAG,IAAAC,kBAAQ,GAAE;EAEtC,MAAMC,sBAAsB,GAAG,IAAAC,kBAAW,EAEtCC,MAAwC,IACE;IAC1C,IAAI;MACF,OAAOP,MAAM,CAACK,sBAAsB,CAACE,MAAM,CAAC;IAC9C,CAAC,CAAC,OAAOC,YAAY,EAAE;MACrBL,QAAQ,CAACK,YAAY,CAAC;MAEtB,OAAOC,SAAS;IAClB;EACF,CAAC,EACD,CAACT,MAAM,EAAEG,QAAQ,CAAC,CACnB;EAED,OAAO;IACLE,sBAAsB;IACtBH;EACF,CAAC;AACH"}
+{"version":3,"file":"useFeatureVariable.js","names":["_react","require","_useKameleoon","useFeatureVariable","client","useKameleoon","getFeatureFlagVariable","useCallback","params"],"sources":["../src/useFeatureVariable.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport {\n  GetFeatureFlagVariableParamsType,\n  FeatureVariableResultType,\n} from '@kameleoon/javascript-sdk-core';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IFeatureVariableHookResult {\n  /**\n   * 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.\n   *\n   * @param {GetFeatureFlagVariableParamsType} params - `visitorCode`, `featureKey` and `variableKey` parameters to return variable.\n   * @return {FeatureVariableResultType} 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.\n   * @throws `KameleoonError` with one of the following `type` s:\n   * \n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded.\n   * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.\n   * - `KameleoonException.FeatureFlagConfigurationNotFound` - No feature flag was found for provided `visitorCode` and `featureKey`.\n   * - `KameleoonException.NotTargeted` - Current visitor is not targeted.\n   * - `KameleoonException.JSONParse` - Couldn't pass JSON value.\n   * - `KameleoonException.NumberParse` - Couldn't pass Number value.\n   */\n  getFeatureFlagVariable: (\n    params: GetFeatureFlagVariableParamsType,\n  ) => FeatureVariableResultType;\n}\n\n/**\n * A React Hook that returns `getFeatureFlagVariable` function which retrieves a feature variable.\n *\n * @returns {IPageViewHookResult} an object containing the `getFeatureFlagVariable` function.\n */\nexport function useFeatureVariable(): IFeatureVariableHookResult {\n  const { client } = useKameleoon();\n\n  const getFeatureFlagVariable = useCallback(\n    (params: GetFeatureFlagVariableParamsType): FeatureVariableResultType => {\n      return client.getFeatureFlagVariable(params);\n    },\n    [client],\n  );\n\n  return {\n    getFeatureFlagVariable,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAKA,IAAAC,aAAA,GAAAD,OAAA;AAsBA;AACA;AACA;AACA;AACA;AACO,SAASE,kBAAkBA,CAAA,EAA+B;EAC/D,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,sBAAsB,GAAG,IAAAC,kBAAW,EACvCC,MAAwC,IAAgC;IACvE,OAAOJ,MAAM,CAACE,sBAAsB,CAACE,MAAM,CAAC;EAC9C,CAAC,EACD,CAACJ,MAAM,CAAC,CACT;EAED,OAAO;IACLE;EACF,CAAC;AACH"}

package/dist/useFlushData.d.ts

@@ -3,6 +3,9 @@ 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.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.
      */
     flushData: (visitorCode: string) => void;
 }

package/dist/useFlushData.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFlushData.js","names":["_react","require","_useKameleoon","useFlushData","client","useKameleoon","flushData","useCallback","visitorCode"],"sources":["../src/useFlushData.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IFlushDataHookResult {\n  /**\n   * 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.\n   *\n   * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   */\n  flushData: (visitorCode: string) => void;\n}\n\n/**\n * A React Hook that returns `flushData` function\n *\n * @returns {IFlushDataHookResult} an object containing the `flushData` function.\n */\nexport function useFlushData(): IFlushDataHookResult {\n  const { client } = useKameleoon();\n\n  const flushData = useCallback(\n    (visitorCode: string): void => {\n      client.flushData(visitorCode);\n    },\n    [client],\n  );\n\n  return {\n    flushData,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAWA;AACA;AACA;AACA;AACA;AACO,SAASE,YAAYA,CAAA,EAAyB;EACnD,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,SAAS,GAAG,IAAAC,kBAAW,EAC1BC,WAAmB,IAAW;IAC7BJ,MAAM,CAACE,SAAS,CAACE,WAAW,CAAC;EAC/B,CAAC,EACD,CAACJ,MAAM,CAAC,CACT;EAED,OAAO;IACLE;EACF,CAAC;AACH"}
+{"version":3,"file":"useFlushData.js","names":["_react","require","_useKameleoon","useFlushData","client","useKameleoon","flushData","useCallback","visitorCode"],"sources":["../src/useFlushData.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IFlushDataHookResult {\n  /**\n   * 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.\n   *\n   * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @throws `KameleoonError` with one of the following `type` s:\n   * \n   * - `KameleoonException.Initialization` - Method was executed before `initialize` was done for `kameleoonClient`.\n   */\n  flushData: (visitorCode: string) => void;\n}\n\n/**\n * A React Hook that returns `flushData` function\n *\n * @returns {IFlushDataHookResult} an object containing the `flushData` function.\n */\nexport function useFlushData(): IFlushDataHookResult {\n  const { client } = useKameleoon();\n\n  const flushData = useCallback(\n    (visitorCode: string): void => {\n      client.flushData(visitorCode);\n    },\n    [client],\n  );\n\n  return {\n    flushData,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAcA;AACA;AACA;AACA;AACA;AACO,SAASE,YAAYA,CAAA,EAAyB;EACnD,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,SAAS,GAAG,IAAAC,kBAAW,EAC1BC,WAAmB,IAAW;IAC7BJ,MAAM,CAACE,SAAS,CAACE,WAAW,CAAC;EAC/B,CAAC,EACD,CAACJ,MAAM,CAAC,CACT;EAED,OAAO;IACLE;EACF,CAAC;AACH"}

package/dist/useInitialize.d.ts

@@ -1,15 +1,16 @@
-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.
+     *  @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.StorageWrite` Couldn't update storage data.
+     * - `KameleoonException.ClientConfiguration` Couldn't retrieve client configuration from Kameleoon Api.
      */
     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.
+ * @returns {IInitializeHookResult} an object containing the asynchronous `initialize` function.
  */
 export declare function useInitialize(): IInitializeHookResult;

package/dist/useInitialize.js

@@ -6,31 +6,20 @@ Object.defineProperty(exports, "__esModule", {
 exports.useInitialize = useInitialize;
 var _react = require("react");
 var _useKameleoon = require("./useKameleoon");
-var _useError = require("./useError");
 /**
  * A React Hook that returns asynchronous `initialize` function.
  *
- * @returns {IInitializeHookResult} an object containing the asynchronous `initialize` function and an optional error object.
+ * @returns {IInitializeHookResult} an object containing the asynchronous `initialize` function.
  */
 function useInitialize() {
   const {
     client
   } = (0, _useKameleoon.useKameleoon)();
-  const {
-    error,
-    setError
-  } = (0, _useError.useError)();
   const initialize = (0, _react.useCallback)(async () => {
-    try {
-      return await client.initialize();
-    } catch (unknownError) {
-      setError(unknownError);
-      return false;
-    }
+    return await client.initialize();
   }, [client]);
   return {
-    initialize,
-    error
+    initialize
   };
 }
 //# sourceMappingURL=useInitialize.js.map

package/dist/useInitialize.js.map

@@ -1 +1 @@
-{"version":3,"file":"useInitialize.js","names":["_react","require","_useKameleoon","_useError","useInitialize","client","useKameleoon","error","setError","useError","initialize","useCallback","unknownError"],"sources":["../src/useInitialize.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\nimport { useError } from './useError';\nimport { KameleoonError } from './KameleoonError';\n\nexport interface IInitializeHookResult {\n  /**\n   *  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.\n   */\n  initialize: () => Promise<boolean>;\n  /** An optional error object that may be returned if an error occurs while calling the `initialize` function. */\n  error: KameleoonError | null;\n}\n\n/**\n * A React Hook that returns asynchronous `initialize` function.\n *\n * @returns {IInitializeHookResult} an object containing the asynchronous `initialize` function and an optional error object.\n */\nexport function useInitialize(): IInitializeHookResult {\n  const { client } = useKameleoon();\n  const { error, setError } = useError();\n\n  const initialize = useCallback(async (): Promise<boolean> => {\n    try {\n      return await client.initialize();\n    } catch (unknownError) {\n      setError(unknownError);\n\n      return false;\n    }\n  }, [client]);\n\n  return {\n    initialize,\n    error,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AACA,IAAAE,SAAA,GAAAF,OAAA;AAYA;AACA;AACA;AACA;AACA;AACO,SAASG,aAAaA,CAAA,EAA0B;EACrD,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EACjC,MAAM;IAAEC,KAAK;IAAEC;EAAS,CAAC,GAAG,IAAAC,kBAAQ,GAAE;EAEtC,MAAMC,UAAU,GAAG,IAAAC,kBAAW,EAAC,YAA8B;IAC3D,IAAI;MACF,OAAO,MAAMN,MAAM,CAACK,UAAU,EAAE;IAClC,CAAC,CAAC,OAAOE,YAAY,EAAE;MACrBJ,QAAQ,CAACI,YAAY,CAAC;MAEtB,OAAO,KAAK;IACd;EACF,CAAC,EAAE,CAACP,MAAM,CAAC,CAAC;EAEZ,OAAO;IACLK,UAAU;IACVH;EACF,CAAC;AACH"}
+{"version":3,"file":"useInitialize.js","names":["_react","require","_useKameleoon","useInitialize","client","useKameleoon","initialize","useCallback"],"sources":["../src/useInitialize.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IInitializeHookResult {\n  /**\n   *  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.\n   *  @throws `KameleoonError` with one of the following `type` s:\n   * \n   * - `KameleoonException.StorageWrite` Couldn't update storage data.\n   * - `KameleoonException.ClientConfiguration` Couldn't retrieve client configuration from Kameleoon Api.\n   */\n  initialize: () => Promise<boolean>;\n}\n\n/**\n * A React Hook that returns asynchronous `initialize` function.\n *\n * @returns {IInitializeHookResult} an object containing the asynchronous `initialize` function.\n */\nexport function useInitialize(): IInitializeHookResult {\n  const { client } = useKameleoon();\n\n  const initialize = useCallback(async (): Promise<boolean> => {\n    return await client.initialize();\n  }, [client]);\n\n  return {\n    initialize,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAaA;AACA;AACA;AACA;AACA;AACO,SAASE,aAAaA,CAAA,EAA0B;EACrD,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,UAAU,GAAG,IAAAC,kBAAW,EAAC,YAA8B;IAC3D,OAAO,MAAMH,MAAM,CAACE,UAAU,EAAE;EAClC,CAAC,EAAE,CAACF,MAAM,CAAC,CAAC;EAEZ,OAAO;IACLE;EACF,CAAC;AACH"}

package/dist/useKameleoon.d.ts

@@ -6,6 +6,7 @@ export interface IKameleoonHookResult {
 /**
  * A React Hook that validates if context is used within a KameleoonProvider and returns it.
  *
- * @returns {IKameleoonHookResult}
+ * @returns {IKameleoonHookResult} an object containing the `client` field.
+ * @throws useKameleoon must be used within a KameleoonProvider.
  */
 export declare function useKameleoon(): IKameleoonHookResult;

package/dist/useKameleoon.js

@@ -6,16 +6,16 @@ Object.defineProperty(exports, "__esModule", {
 exports.useKameleoon = useKameleoon;
 var _react = require("react");
 var _KameleoonContext = require("./KameleoonContext");
-var _ProviderError = require("./ProviderError");
 /**
  * A React Hook that validates if context is used within a KameleoonProvider and returns it.
  *
- * @returns {IKameleoonHookResult}
+ * @returns {IKameleoonHookResult} an object containing the `client` field.
+ * @throws useKameleoon must be used within a KameleoonProvider.
  */
 function useKameleoon() {
   const context = (0, _react.useContext)(_KameleoonContext.KameleoonContext);
   if (!context) {
-    throw new _ProviderError.ProviderError('useKameleoon');
+    throw new Error('useKameleoon must be used within a KameleoonProvider');
   }
   return {
     client: context

package/dist/useKameleoon.js.map

@@ -1 +1 @@
-{"version":3,"file":"useKameleoon.js","names":["_react","require","_KameleoonContext","_ProviderError","useKameleoon","context","useContext","KameleoonContext","ProviderError","client"],"sources":["../src/useKameleoon.ts"],"sourcesContent":["import { useContext } from 'react';\nimport { KameleoonCore } from '@kameleoon/javascript-sdk-core';\nimport { KameleoonContext } from './KameleoonContext';\nimport { ProviderError } from './ProviderError';\n\nexport interface IKameleoonHookResult {\n  /** An instance of KameleoonClient. */\n  client: KameleoonCore;\n}\n\n/**\n * A React Hook that validates if context is used within a KameleoonProvider and returns it.\n *\n * @returns {IKameleoonHookResult}\n */\nexport function useKameleoon(): IKameleoonHookResult {\n  const context = useContext(KameleoonContext);\n\n  if (!context) {\n    throw new ProviderError('useKameleoon');\n  }\n\n  return {\n    client: context,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,iBAAA,GAAAD,OAAA;AACA,IAAAE,cAAA,GAAAF,OAAA;AAOA;AACA;AACA;AACA;AACA;AACO,SAASG,YAAYA,CAAA,EAAyB;EACnD,MAAMC,OAAO,GAAG,IAAAC,iBAAU,EAACC,kCAAgB,CAAC;EAE5C,IAAI,CAACF,OAAO,EAAE;IACZ,MAAM,IAAIG,4BAAa,CAAC,cAAc,CAAC;EACzC;EAEA,OAAO;IACLC,MAAM,EAAEJ;EACV,CAAC;AACH"}
+{"version":3,"file":"useKameleoon.js","names":["_react","require","_KameleoonContext","useKameleoon","context","useContext","KameleoonContext","Error","client"],"sources":["../src/useKameleoon.ts"],"sourcesContent":["import { useContext } from 'react';\nimport { KameleoonCore } from '@kameleoon/javascript-sdk-core';\nimport { KameleoonContext } from './KameleoonContext';\n\nexport interface IKameleoonHookResult {\n  /** An instance of KameleoonClient. */\n  client: KameleoonCore;\n}\n\n/**\n * A React Hook that validates if context is used within a KameleoonProvider and returns it.\n *\n * @returns {IKameleoonHookResult} an object containing the `client` field.\n * @throws useKameleoon must be used within a KameleoonProvider.\n */\nexport function useKameleoon(): IKameleoonHookResult {\n  const context = useContext(KameleoonContext);\n\n  if (!context) {\n    throw new Error('useKameleoon must be used within a KameleoonProvider');\n  }\n\n  return {\n    client: context,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,iBAAA,GAAAD,OAAA;AAOA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,YAAYA,CAAA,EAAyB;EACnD,MAAMC,OAAO,GAAG,IAAAC,iBAAU,EAACC,kCAAgB,CAAC;EAE5C,IAAI,CAACF,OAAO,EAAE;IACZ,MAAM,IAAIG,KAAK,CAAC,sDAAsD,CAAC;EACzE;EAEA,OAAO;IACLC,MAAM,EAAEJ;EACV,CAAC;AACH"}

package/dist/useNativeVisitorCode.d.ts

@@ -1,8 +1,8 @@
-interface INativeVisitorCodeHookResult {
+export 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.
+     * @param {string | undefined} 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;
@@ -10,7 +10,6 @@ interface INativeVisitorCodeHookResult {
 /**
  * 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.
+ * @returns {INativeVisitorCodeHookResult} an object containing the `getNativeVisitorCode` function.
  */
 export declare function useNativeVisitorCode(): INativeVisitorCodeHookResult;
-export {};

package/dist/useNativeVisitorCode.js

@@ -9,7 +9,7 @@ var _nativeUtils = 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.
+ * @returns {INativeVisitorCodeHookResult} an object containing the `getNativeVisitorCode` function.
  */
 function useNativeVisitorCode() {
   const getNativeVisitorCode = (0, _react.useCallback)(defaultVisitorCode => {

package/dist/useNativeVisitorCode.js.map

@@ -1 +1 @@
-{"version":3,"file":"useNativeVisitorCode.js","names":["_react","require","_nativeUtils","useNativeVisitorCode","getNativeVisitorCode","useCallback","defaultVisitorCode","NativeUtils","getVisitorCode"],"sources":["../src/useNativeVisitorCode.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { NativeUtils } from './kameleoonUtils/nativeUtils';\n\ninterface INativeVisitorCodeHookResult {\n  /**\n   * Obtains visitor code from the storage, if no visitor code exists returns a new random visitor code (or the specified default value).\n   *\n   * @param defaultVisitorCode - visitor code to be used instead of randomly generated visitor code in case there is no visitor code saved in storage.\n   * @returns {string} result visitor code.\n   */\n  getNativeVisitorCode: (defaultVisitorCode?: string) => string;\n}\n\n/**\n * A React Hook that returns `getNativeVisitorCode function which obtains the Kameleoon visitorCode.\n *\n * @returns {INativeVisitorCodeHookResult} an object containing the `getNativeVisitorCode` function and an optional error object.\n */\nexport function useNativeVisitorCode(): INativeVisitorCodeHookResult {\n  const getNativeVisitorCode = useCallback(\n    (defaultVisitorCode?: string): string => {\n      return NativeUtils.getVisitorCode(defaultVisitorCode);\n    },\n    [],\n  );\n\n  return {\n    getNativeVisitorCode,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,YAAA,GAAAD,OAAA;AAYA;AACA;AACA;AACA;AACA;AACO,SAASE,oBAAoBA,CAAA,EAAiC;EACnE,MAAMC,oBAAoB,GAAG,IAAAC,kBAAW,EACrCC,kBAA2B,IAAa;IACvC,OAAOC,wBAAW,CAACC,cAAc,CAACF,kBAAkB,CAAC;EACvD,CAAC,EACD,EAAE,CACH;EAED,OAAO;IACLF;EACF,CAAC;AACH"}
+{"version":3,"file":"useNativeVisitorCode.js","names":["_react","require","_nativeUtils","useNativeVisitorCode","getNativeVisitorCode","useCallback","defaultVisitorCode","NativeUtils","getVisitorCode"],"sources":["../src/useNativeVisitorCode.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { NativeUtils } from './kameleoonUtils/nativeUtils';\n\nexport interface INativeVisitorCodeHookResult {\n  /**\n   * Obtains visitor code from the storage, if no visitor code exists returns a new random visitor code (or the specified default value).\n   *\n   * @param {string | undefined} defaultVisitorCode - visitor code to be used instead of randomly generated visitor code in case there is no visitor code saved in storage.\n   * @returns {string} result visitor code.\n   */\n  getNativeVisitorCode: (defaultVisitorCode?: string) => string;\n}\n\n/**\n * A React Hook that returns `getNativeVisitorCode function which obtains the Kameleoon visitorCode.\n *\n * @returns {INativeVisitorCodeHookResult} an object containing the `getNativeVisitorCode` function.\n */\nexport function useNativeVisitorCode(): INativeVisitorCodeHookResult {\n  const getNativeVisitorCode = useCallback(\n    (defaultVisitorCode?: string): string => {\n      return NativeUtils.getVisitorCode(defaultVisitorCode);\n    },\n    [],\n  );\n\n  return {\n    getNativeVisitorCode,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,YAAA,GAAAD,OAAA;AAYA;AACA;AACA;AACA;AACA;AACO,SAASE,oBAAoBA,CAAA,EAAiC;EACnE,MAAMC,oBAAoB,GAAG,IAAAC,kBAAW,EACrCC,kBAA2B,IAAa;IACvC,OAAOC,wBAAW,CAACC,cAAc,CAACF,kBAAkB,CAAC;EACvD,CAAC,EACD,EAAE,CACH;EAED,OAAO;IACLF;EACF,CAAC;AACH"}

package/dist/useRemoteData.d.ts

@@ -1,15 +1,15 @@
 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.
+     * @returns {Promise<JSONType>} promise with retrieving data for specific key.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server.
      */
-    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;
+    getRemoteData: (key: string) => Promise<JSONType>;
 }
 /**
  * A React Hook that returns asynchronous getRemoteData function which retrieves data from Kameleoon server.

package/dist/useRemoteData.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.useRemoteData = useRemoteData;
 var _react = require("react");
 var _useKameleoon = require("./useKameleoon");
-var _useError = require("./useError");
 /**
  * A React Hook that returns asynchronous getRemoteData function which retrieves data from Kameleoon server.
  *
@@ -16,22 +15,11 @@ function useRemoteData() {
   const {
     client
   } = (0, _useKameleoon.useKameleoon)();
-  const {
-    error,
-    setError
-  } = (0, _useError.useError)();
   const getRemoteData = (0, _react.useCallback)(async key => {
-    try {
-      const remoteData = await client.getRemoteData(key);
-      return remoteData;
-    } catch (unknownError) {
-      setError(unknownError);
-      return undefined;
-    }
+    return await client.getRemoteData(key);
   }, [client]);
   return {
-    getRemoteData,
-    error
+    getRemoteData
   };
 }
 //# sourceMappingURL=useRemoteData.js.map

package/dist/useRemoteData.js.map

@@ -1 +1 @@
-{"version":3,"file":"useRemoteData.js","names":["_react","require","_useKameleoon","_useError","useRemoteData","client","useKameleoon","error","setError","useError","getRemoteData","useCallback","key","remoteData","unknownError","undefined"],"sources":["../src/useRemoteData.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { JSONType } from '@kameleoon/javascript-sdk-core';\nimport { useKameleoon } from './useKameleoon';\nimport { KameleoonError } from './KameleoonError';\nimport { useError } from './useError';\n\nexport interface IRemoteDataHookResult {\n  /**\n   * Returns a data which is stored for specified siteCode on a remote Kameleoon server.\n   *\n   * @param {string} key - unique key that the data you try to get is associated with.\n   * @returns {Promise<JSONType | undefined>} promise with retrieving data for specific key.\n   */\n  getRemoteData: (key: string) => Promise<JSONType | undefined>;\n  /** An optional error object that may be returned if an error occurs while calling the `getRemoteData` function. */\n  error: KameleoonError | null;\n}\n\n/**\n * A React Hook that returns asynchronous getRemoteData function which retrieves data from Kameleoon server.\n *\n * @returns {IRemoteDataHookResult} an object containing the `getRemoteData` function.\n */\nexport function useRemoteData(): IRemoteDataHookResult {\n  const { client } = useKameleoon();\n  const { error, setError } = useError();\n\n  const getRemoteData = useCallback(\n    async (key: string): Promise<JSONType | undefined> => {\n      try {\n        const remoteData = await client.getRemoteData(key);\n\n        return remoteData;\n      } catch (unknownError) {\n        setError(unknownError);\n\n        return undefined;\n      }\n    },\n    [client],\n  );\n\n  return {\n    getRemoteData,\n    error,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,aAAA,GAAAD,OAAA;AAEA,IAAAE,SAAA,GAAAF,OAAA;AAcA;AACA;AACA;AACA;AACA;AACO,SAASG,aAAaA,CAAA,EAA0B;EACrD,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EACjC,MAAM;IAAEC,KAAK;IAAEC;EAAS,CAAC,GAAG,IAAAC,kBAAQ,GAAE;EAEtC,MAAMC,aAAa,GAAG,IAAAC,kBAAW,EAC/B,MAAOC,GAAW,IAAoC;IACpD,IAAI;MACF,MAAMC,UAAU,GAAG,MAAMR,MAAM,CAACK,aAAa,CAACE,GAAG,CAAC;MAElD,OAAOC,UAAU;IACnB,CAAC,CAAC,OAAOC,YAAY,EAAE;MACrBN,QAAQ,CAACM,YAAY,CAAC;MAEtB,OAAOC,SAAS;IAClB;EACF,CAAC,EACD,CAACV,MAAM,CAAC,CACT;EAED,OAAO;IACLK,aAAa;IACbH;EACF,CAAC;AACH"}
+{"version":3,"file":"useRemoteData.js","names":["_react","require","_useKameleoon","useRemoteData","client","useKameleoon","getRemoteData","useCallback","key"],"sources":["../src/useRemoteData.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { JSONType } from '@kameleoon/javascript-sdk-core';\nimport { useKameleoon } from './useKameleoon';\n\nexport interface IRemoteDataHookResult {\n  /**\n   * Returns a data which is stored for specified siteCode on a remote Kameleoon server.\n   *\n   * @param {string} key - unique key that the data you try to get is associated with.\n   * @returns {Promise<JSONType>} promise with retrieving data for specific key.\n   * @throws `KameleoonError` with one of the following `type` s:\n   * \n   * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server.\n   */\n  getRemoteData: (key: string) => Promise<JSONType>;\n}\n\n/**\n * A React Hook that returns asynchronous getRemoteData function which retrieves data from Kameleoon server.\n *\n * @returns {IRemoteDataHookResult} an object containing the `getRemoteData` function.\n */\nexport function useRemoteData(): IRemoteDataHookResult {\n  const { client } = useKameleoon();\n\n  const getRemoteData = useCallback(\n    async (key: string): Promise<JSONType> => {\n      return await client.getRemoteData(key);\n    },\n    [client],\n  );\n\n  return {\n    getRemoteData,\n  };\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AAEA,IAAAC,aAAA,GAAAD,OAAA;AAeA;AACA;AACA;AACA;AACA;AACO,SAASE,aAAaA,CAAA,EAA0B;EACrD,MAAM;IAAEC;EAAO,CAAC,GAAG,IAAAC,0BAAY,GAAE;EAEjC,MAAMC,aAAa,GAAG,IAAAC,kBAAW,EAC/B,MAAOC,GAAW,IAAwB;IACxC,OAAO,MAAMJ,MAAM,CAACE,aAAa,CAACE,GAAG,CAAC;EACxC,CAAC,EACD,CAACJ,MAAM,CAAC,CACT;EAED,OAAO;IACLE;EACF,CAAC;AACH"}

package/dist/useTrackConversion.d.ts

@@ -1,14 +1,15 @@
 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.
+     * @throws `KameleoonError` with one of the following `type` s:
+     *
+     * - `KameleoonException.VisitorCodeMaxLength` The visitor code length was exceeded.
+     * - `KameleoonException.StorageWrite` Couldn't update storage data.
      */
     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.