@kameleoon/react-sdk 9.0.0 → 9.1.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Change Log
 
+## 9.1.0 (2024-04-19)
+
+### Features
+
+- New [Likelihood to Convert](https://developers.kameleoon.com/feature-management-and-experimentation/using-visit-history-in-feature-flags-and-experiments/#predefined-targeting-conditions) targeting condition.
+- Added [`isInitialized`](#https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#isinitialized) method obtained from `useInitialize` hook for checking if the SDK is initialized
+- [`getRemoteVisitorData`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#getremotevisitordata) method now accepts new boolean parameter `isUniqueIdentifier` to obtain all linked visitors data when working with [Cross-device experimentation](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#cross-device-experimentation)
+- Miscellaneous [Cross-device experimentation](https://developers.kameleoon.com/core-concepts/cross-device-experimentation) improvements
+
+### Patch Changes
+
+- Improved visits data collection logic
+- Fixed the issue with when `_` variable was transformed to duplicate identifier `a` causing `TypeError`
+- Kameleoon network request headers are now properly used
+- `Browser` condition could throw an error when the browser version wasn't specified on Kameleoon Platform
+- `Geolocation` condition is now case insensitive
+- SDK Core version is no more sent with tracking
+- Updated dependencies
+  - @kameleoon/javascript-sdk@3.1.0
+
+## 9.0.1 (2024-02-21)
+
+### Patch Changes
+
+- `<KameleoonProvider />` React dependency is now properly used
+- Convert dependency on [JavaScript SDK](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/js-sdk/) from peer to concrete
+
 ## 9.0.0 (2024-02-16)
 
 ### Breaking Changes

package/dist/KameleoonContext.d.ts

@@ -1,3 +1,3 @@
-/// <reference types="react" />
+import React from 'react';
 import { KameleoonClient } from '@kameleoon/javascript-sdk';
-export declare const KameleoonContext: import("react").Context<KameleoonClient | null>;
+export declare const KameleoonContext: React.Context<KameleoonClient | null>;

package/dist/KameleoonContext.js

@@ -1,2 +1,2 @@
-"use strict";var _react=require("react");Object.defineProperty(exports,"__esModule",{value:!0}),exports.KameleoonContext=void 0;const KameleoonContext=exports.KameleoonContext=(0,_react.createContext)(null);
+"use strict";var _react=_interopRequireDefault(require("react"));Object.defineProperty(exports,"__esModule",{value:!0}),exports.KameleoonContext=void 0;function _interopRequireDefault(a){return a&&a.__esModule?a:{default:a}}const KameleoonContext=exports.KameleoonContext=_react.default.createContext(null);
 //# sourceMappingURL=KameleoonContext.js.map

package/dist/KameleoonContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"KameleoonContext.js","names":["_react","require","Object","defineProperty","exports","value","KameleoonContext","createContext"],"sources":["../src/KameleoonContext.ts"],"sourcesContent":["import { createContext } from 'react';\nimport { KameleoonClient } from '@kameleoon/javascript-sdk';\n\nexport const KameleoonContext = createContext<KameleoonClient | null>(null);\n"],"mappings":"aAAA,IAAAA,MAAA,CAAAC,OAAA,UAAsCC,MAAA,CAAAC,cAAA,CAAAC,OAAA,eAAAC,KAAA,MAAAD,OAAA,CAAAE,gBAAA,QAG/B,KAAM,CAAAA,gBAAgB,CAAAF,OAAA,CAAAE,gBAAA,CAAG,GAAAC,oBAAa,EAAyB,IAAI,CAAC"}
+{"version":3,"file":"KameleoonContext.js","names":["_react","_interopRequireDefault","require","Object","defineProperty","exports","value","KameleoonContext","a","__esModule","default","React","createContext"],"sources":["../src/KameleoonContext.ts"],"sourcesContent":["import React from 'react';\nimport { KameleoonClient } from '@kameleoon/javascript-sdk';\n\nexport const KameleoonContext = React.createContext<KameleoonClient | null>(\n  null,\n);\n"],"mappings":"aAAA,IAAAA,MAAA,CAAAC,sBAAA,CAAAC,OAAA,WAA0BC,MAAA,CAAAC,cAAA,CAAAC,OAAA,eAAAC,KAAA,MAAAD,OAAA,CAAAE,gBAAA,iBAAAN,uBAAAO,CAAA,SAAAA,CAAA,EAAAA,CAAA,CAAAC,UAAA,CAAAD,CAAA,EAAAE,OAAA,CAAAF,CAAA,EAGnB,KAAM,CAAAD,gBAAgB,CAAAF,OAAA,CAAAE,gBAAA,CAAGI,cAAK,CAACC,aAAa,CACjD,IACF,CAAC"}

package/dist/KameleoonProvider.d.ts

@@ -1,14 +1,14 @@
-import { ReactNode } from 'react';
+import React from 'react';
 import { KameleoonClient } from '@kameleoon/javascript-sdk';
 export interface IKameleoonProviderProps {
     /** Child elements of the provider. */
-    children: ReactNode;
+    children: React.ReactNode;
     /** An instance of Kameleoon SDK. */
     client: KameleoonClient;
 }
 /**
  * A Provider that wraps the project and provides an access to SDK APIs
  */
-declare function KameleoonProvider({ client, children, }: IKameleoonProviderProps): JSX.Element;
-declare const _default: import("react").MemoExoticComponent<typeof KameleoonProvider>;
+declare function KameleoonProvider({ client, children, }: IKameleoonProviderProps): React.JSX.Element;
+declare const _default: React.MemoExoticComponent<typeof KameleoonProvider>;
 export default _default;

package/dist/KameleoonProvider.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0;var _react=require("react"),_KameleoonContext=require("./KameleoonContext");function KameleoonProvider(a){let{client:b,children:c}=a;return React.createElement(_KameleoonContext.KameleoonContext.Provider,{value:b},c)}var _default=exports.default=(0,_react.memo)(KameleoonProvider);
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=void 0;var _react=_interopRequireDefault(require("react")),_KameleoonContext=require("./KameleoonContext");function _interopRequireDefault(a){return a&&a.__esModule?a:{default:a}}function KameleoonProvider(a){let{client:b,children:c}=a;return _react.default.createElement(_KameleoonContext.KameleoonContext.Provider,{value:b},c)}var _default=exports.default=_react.default.memo(KameleoonProvider);
 //# sourceMappingURL=KameleoonProvider.js.map

package/dist/KameleoonProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"KameleoonProvider.js","names":["KameleoonProvider","a","client","children","React","createElement","_KameleoonContext","KameleoonContext","Provider","value","_default","exports","default","memo"],"sources":["../src/KameleoonProvider.tsx"],"sourcesContent":["import { memo, ReactNode } from 'react';\nimport { KameleoonClient } from '@kameleoon/javascript-sdk';\nimport { KameleoonContext } from './KameleoonContext';\n\nexport interface IKameleoonProviderProps {\n  /** Child elements of the provider. */\n  children: ReactNode;\n  /** An instance of Kameleoon SDK. */\n  client: KameleoonClient;\n}\n\n/**\n * A Provider that wraps the project and provides an access to SDK APIs\n */\nfunction KameleoonProvider({\n  client,\n  children,\n}: IKameleoonProviderProps): JSX.Element {\n  return (\n    <KameleoonContext.Provider value={client}>\n      {children}\n    </KameleoonContext.Provider>\n  );\n}\n\nexport default memo(KameleoonProvider);\n"],"mappings":"uKAcA,QAAS,CAAAA,iBAAiBA,CAAAC,CAAA,CAGe,IAHd,CACzBC,MAAM,CAANA,CAAM,CACNC,QAAQ,CAARA,CACuB,CAAC,CAAAF,CAAA,CACxB,MACE,CAAAG,KAAA,CAAAC,aAAA,CAACC,iBAAA,CAAAC,gBAAgB,CAACC,QAAQ,EAACC,KAAK,CAAEP,CAAO,EACtCC,CACwB,CAE/B,CAAC,IAAAO,QAAA,CAAAC,OAAA,CAAAC,OAAA,CAEc,GAAAC,WAAI,EAACb,iBAAiB,CAAC"}
+{"version":3,"file":"KameleoonProvider.js","names":["KameleoonProvider","a","client","children","_react","default","createElement","_KameleoonContext","KameleoonContext","Provider","value","_default","exports","React","memo"],"sources":["../src/KameleoonProvider.tsx"],"sourcesContent":["import React from 'react';\nimport { KameleoonClient } from '@kameleoon/javascript-sdk';\nimport { KameleoonContext } from './KameleoonContext';\n\nexport interface IKameleoonProviderProps {\n  /** Child elements of the provider. */\n  children: React.ReactNode;\n  /** An instance of Kameleoon SDK. */\n  client: KameleoonClient;\n}\n\n/**\n * A Provider that wraps the project and provides an access to SDK APIs\n */\nfunction KameleoonProvider({\n  client,\n  children,\n}: IKameleoonProviderProps): React.JSX.Element {\n  return (\n    <KameleoonContext.Provider value={client}>\n      {children}\n    </KameleoonContext.Provider>\n  );\n}\n\nexport default React.memo(KameleoonProvider);\n"],"mappings":"uQAcA,QAAS,CAAAA,iBAAiBA,CAAAC,CAAA,CAGqB,IAHpB,CACzBC,MAAM,CAANA,CAAM,CACNC,QAAQ,CAARA,CACuB,CAAC,CAAAF,CAAA,CACxB,MACE,CAAAG,MAAA,CAAAC,OAAA,CAAAC,aAAA,CAACC,iBAAA,CAAAC,gBAAgB,CAACC,QAAQ,EAACC,KAAK,CAAER,CAAO,EACtCC,CACwB,CAE/B,CAAC,IAAAQ,QAAA,CAAAC,OAAA,CAAAP,OAAA,CAEcQ,cAAK,CAACC,IAAI,CAACd,iBAAiB,CAAC"}

package/dist/createClient.js

@@ -1,2 +1,2 @@
-"use strict";var _javascriptSdk=require("@kameleoon/javascript-sdk");Object.defineProperty(exports,"__esModule",{value:!0}),exports.createClient=createClient;function createClient(a){let{siteCode:b,configuration:c,externals:d}=a;const e=new _javascriptSdk.KameleoonClient({siteCode:b,configuration:c,externals:d,_internals:{type:_javascriptSdk.SdkLanguageType.REACT,version:"9.0.0"}});return e}
+"use strict";var _javascriptSdk=require("@kameleoon/javascript-sdk");Object.defineProperty(exports,"__esModule",{value:!0}),exports.createClient=createClient;function createClient(a){let{siteCode:b,configuration:c,externals:d}=a;const e=new _javascriptSdk.KameleoonClient({siteCode:b,configuration:c,externals:d,_internals:{type:_javascriptSdk.SdkLanguageType.REACT,version:"9.1.0"}});return e}
 //# sourceMappingURL=createClient.js.map

package/dist/interfaces/useData.d.ts

@@ -51,7 +51,7 @@ export default interface IUseData {
     /**
      * An asynchronous method for retrieving custom data for the latest visit of `visitorCode` from Kameleoon Data API and optionally adding it to the storage so that other methods could decide whether the current visitor is targeted or not.
      *
-     * @param {RemoteVisitorDataParamsType} remoteVisitorDataParameters - `visitorCode`, `shouldAddData` and `filters` parameters
+     * @param {RemoteVisitorDataParamsType} remoteVisitorDataParameters - `visitorCode`, `shouldAddData`, `filters` and `isUniqueIdentifier` parameters
      * @returns {KameleoonDataType[]} promise resolved to an array of `KameleoonData` instances
      * @throws `KameleoonError` with one of the following `type` s:
      *
@@ -61,7 +61,7 @@ export default interface IUseData {
      * - `KameleoonException.VisitAmount` - Visit amount must be a number between 1 and 25
      * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call
      */
-    getRemoteVisitorData: ({ visitorCode, shouldAddData, filters, }: RemoteVisitorDataParamsType) => Promise<KameleoonDataType[]>;
+    getRemoteVisitorData: ({ visitorCode, shouldAddData, filters, isUniqueIdentifier, }: RemoteVisitorDataParamsType) => Promise<KameleoonDataType[]>;
     /**
      * An asynchronous method that returns a `CustomData` instance, containing data associated with a visitor's warehouse audiences
      * which is stored for specified visitorCode on a remote Kameleoon server

package/dist/interfaces/useData.js.map

@@ -1 +1 @@
-{"version":3,"file":"useData.js","names":[],"sources":["../../src/interfaces/useData.ts"],"sourcesContent":["import {\n  CustomData,\n  GetVisitorWarehouseAudienceParamsType,\n  JSONType,\n  KameleoonDataType,\n  RemoteVisitorDataParamsType,\n  TrackConversionParamsType,\n} from '@kameleoon/javascript-sdk';\n\nexport default interface IUseData {\n  /**\n   * Adds targeting data to the storage so that other methods could decide whether the current visitor is targeted or not. Note: `UserAgent` data will not be stored in storage like other data, and it will be sent with every tracking request for bot filtration.\n   *\n   * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @param {KameleoonDataType[]} data - number of instances of any type of `KameleoonData`, can be added solely in array or as a sequential arguments.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` The visitor code length was exceeded.\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.StorageWrite` Couldn't update storage data.\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   */\n  addData: (visitorCode: string, ...data: KameleoonDataType[]) => void;\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   * If no visitor is passed, then data for all visitors is sent and removed from `KameleoonClient` instance. Moreover, regardless of visitor code input\n   * execution starts with sending all previously failed tracking requests which were stored locally during the offline mode and then proceeds further.\n   *\n   * @param {string | undefined} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @param {boolean | undefined} isUniqueIdentifier - an optional parameter for specifying if the visitorCode is a unique identifier, default value is `false`\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   */\n  flush: (visitorCode?: string, isUniqueIdentifier?: boolean) => void;\n  /**\n   * 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.\n   *\n   * @param {TrackConversionParamsType} params - `visitorCode`, `goalId`, `revenue` and `isUniqueIdentifier` parameters for data tracking.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` The visitor code length was exceeded.\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.StorageWrite` Couldn't update storage data.\n   */\n  trackConversion: (params: TrackConversionParamsType) => void;\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   * An asynchronous method for retrieving custom data for the latest visit of `visitorCode` from Kameleoon Data API and optionally adding it to the storage so that other methods could decide whether the current visitor is targeted or not.\n   *\n   * @param {RemoteVisitorDataParamsType} remoteVisitorDataParameters - `visitorCode`, `shouldAddData` and `filters` parameters\n   * @returns {KameleoonDataType[]} promise resolved to an array of `KameleoonData` instances\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server\n   * - `KameleoonException.VisitAmount` - Visit amount must be a number between 1 and 25\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call\n   */\n  getRemoteVisitorData: ({\n    visitorCode,\n    shouldAddData,\n    filters,\n  }: RemoteVisitorDataParamsType) => Promise<KameleoonDataType[]>;\n  /**\n   * An asynchronous method that returns a `CustomData` instance, containing data associated with a visitor's warehouse audiences\n   * which is stored for specified visitorCode on a remote Kameleoon server\n   * Retrieved data will be added to storage under the specified `customDataIndex`\n   *\n   * @param {GetVisitorWarehouseAudienceParamsType} parameters - an object with parameters of a type `GetVisitorWarehouseAudienceParamsType`, see the type for details\n   *\n   * @returns {Promise<CustomData | null>} `Promise` containing an instance of `CustomData` containing data associated with a visitor's warehouse audiences or `null` if the data was retrieved successfully but nothing was found under the specified `warehouseKey`\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` - The visitor code is empty\n   * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server\n   */\n  getVisitorWarehouseAudience: ({\n    visitorCode,\n    customDataIndex,\n    warehouseKey,\n  }: GetVisitorWarehouseAudienceParamsType) => Promise<CustomData | null>;\n}\n"],"mappings":""}
+{"version":3,"file":"useData.js","names":[],"sources":["../../src/interfaces/useData.ts"],"sourcesContent":["import {\n  CustomData,\n  GetVisitorWarehouseAudienceParamsType,\n  JSONType,\n  KameleoonDataType,\n  RemoteVisitorDataParamsType,\n  TrackConversionParamsType,\n} from '@kameleoon/javascript-sdk';\n\nexport default interface IUseData {\n  /**\n   * Adds targeting data to the storage so that other methods could decide whether the current visitor is targeted or not. Note: `UserAgent` data will not be stored in storage like other data, and it will be sent with every tracking request for bot filtration.\n   *\n   * @param {string} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @param {KameleoonDataType[]} data - number of instances of any type of `KameleoonData`, can be added solely in array or as a sequential arguments.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` The visitor code length was exceeded.\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.StorageWrite` Couldn't update storage data.\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   */\n  addData: (visitorCode: string, ...data: KameleoonDataType[]) => void;\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   * If no visitor is passed, then data for all visitors is sent and removed from `KameleoonClient` instance. Moreover, regardless of visitor code input\n   * execution starts with sending all previously failed tracking requests which were stored locally during the offline mode and then proceeds further.\n   *\n   * @param {string | undefined} visitorCode - unique visitor identification string, can't exceed 255 characters length.\n   * @param {boolean | undefined} isUniqueIdentifier - an optional parameter for specifying if the visitorCode is a unique identifier, default value is `false`\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   */\n  flush: (visitorCode?: string, isUniqueIdentifier?: boolean) => void;\n  /**\n   * 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.\n   *\n   * @param {TrackConversionParamsType} params - `visitorCode`, `goalId`, `revenue` and `isUniqueIdentifier` parameters for data tracking.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` The visitor code length was exceeded.\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.StorageWrite` Couldn't update storage data.\n   */\n  trackConversion: (params: TrackConversionParamsType) => void;\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   * An asynchronous method for retrieving custom data for the latest visit of `visitorCode` from Kameleoon Data API and optionally adding it to the storage so that other methods could decide whether the current visitor is targeted or not.\n   *\n   * @param {RemoteVisitorDataParamsType} remoteVisitorDataParameters - `visitorCode`, `shouldAddData`, `filters` and `isUniqueIdentifier` parameters\n   * @returns {KameleoonDataType[]} promise resolved to an array of `KameleoonData` instances\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` The visitor code is empty\n   * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server\n   * - `KameleoonException.VisitAmount` - Visit amount must be a number between 1 and 25\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call\n   */\n  getRemoteVisitorData: ({\n    visitorCode,\n    shouldAddData,\n    filters,\n    isUniqueIdentifier,\n  }: RemoteVisitorDataParamsType) => Promise<KameleoonDataType[]>;\n  /**\n   * An asynchronous method that returns a `CustomData` instance, containing data associated with a visitor's warehouse audiences\n   * which is stored for specified visitorCode on a remote Kameleoon server\n   * Retrieved data will be added to storage under the specified `customDataIndex`\n   *\n   * @param {GetVisitorWarehouseAudienceParamsType} parameters - an object with parameters of a type `GetVisitorWarehouseAudienceParamsType`, see the type for details\n   *\n   * @returns {Promise<CustomData | null>} `Promise` containing an instance of `CustomData` containing data associated with a visitor's warehouse audiences or `null` if the data was retrieved successfully but nothing was found under the specified `warehouseKey`\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded\n   * - `KameleoonException.VisitorCodeEmpty` - The visitor code is empty\n   * - `KameleoonException.RemoteData` - Couldn't retrieve data from Kameleoon server\n   */\n  getVisitorWarehouseAudience: ({\n    visitorCode,\n    customDataIndex,\n    warehouseKey,\n  }: GetVisitorWarehouseAudienceParamsType) => Promise<CustomData | null>;\n}\n"],"mappings":""}

package/dist/interfaces/useInitialize.d.ts

@@ -20,4 +20,10 @@ export default interface IUseInitialize {
      * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.
      */
     onConfigurationUpdate: (callback: () => void) => void;
+    /**
+     * Checks if client is initialized.
+     *
+     * @returns {boolean} - `true` if client is initialized, `false` otherwise.
+     */
+    isInitialized: () => boolean;
 }

package/dist/interfaces/useInitialize.js.map

@@ -1 +1 @@
-{"version":3,"file":"useInitialize.js","names":[],"sources":["../../src/interfaces/useInitialize.ts"],"sourcesContent":["export default interface IUseInitialize {\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   * @param {boolean | undefined} useCache - optional parameter for activating SDK offline mode, if `true` is passed failed polls will not return error and will use cached data if such data is available, default value is `false`. Note: if offline mode is on, SDK will still try to retrieve the latest data.\n   *  @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.StorageWrite` Couldn't update storage data.\n   * - `KameleoonException.StorageRead` - Couldn't read storage data.\n   * - `KameleoonException.ClientConfiguration` Couldn't retrieve client configuration from Kameleoon Api.\n   * - `KameleoonException.MaximumRetriesReached` Maximum retries reached, request failed\n   */\n  initialize: () => Promise<boolean>;\n  /**\n   * Fires a callback on client configuration update. Note: this method only works for server sent events of real time update.\n   *\n   * @param {() => void} callback - callback function with no parameters that will be called upon configuration update.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   */\n  onConfigurationUpdate: (callback: () => void) => void;\n}\n"],"mappings":""}
+{"version":3,"file":"useInitialize.js","names":[],"sources":["../../src/interfaces/useInitialize.ts"],"sourcesContent":["export default interface IUseInitialize {\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   * @param {boolean | undefined} useCache - optional parameter for activating SDK offline mode, if `true` is passed failed polls will not return error and will use cached data if such data is available, default value is `false`. Note: if offline mode is on, SDK will still try to retrieve the latest data.\n   *  @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.StorageWrite` Couldn't update storage data.\n   * - `KameleoonException.StorageRead` - Couldn't read storage data.\n   * - `KameleoonException.ClientConfiguration` Couldn't retrieve client configuration from Kameleoon Api.\n   * - `KameleoonException.MaximumRetriesReached` Maximum retries reached, request failed\n   */\n  initialize: () => Promise<boolean>;\n  /**\n   * Fires a callback on client configuration update. Note: this method only works for server sent events of real time update.\n   *\n   * @param {() => void} callback - callback function with no parameters that will be called upon configuration update.\n   * @throws `KameleoonError` with one of the following `type` s:\n   *\n   * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.\n   */\n  onConfigurationUpdate: (callback: () => void) => void;\n  /**\n   * Checks if client is initialized.\n   *\n   * @returns {boolean} - `true` if client is initialized, `false` otherwise.\n   */\n  isInitialized: () => boolean;\n}\n"],"mappings":""}

package/dist/useInitialize.d.ts

@@ -4,6 +4,7 @@ import IUseInitialize from './interfaces/useInitialize';
  *
  * @returns {IUseInitialize} an object containing the following methods:
  * - `initialize`
+ * - `isInitialized`
  * - `onConfigurationUpdate`
  */
 export declare function useInitialize(): IUseInitialize;

package/dist/useInitialize.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useInitialize=useInitialize;var _react=require("react"),_useKameleoon=require("./useKameleoon");function useInitialize(){const a=(0,_useKameleoon.useKameleoon)(),b=(0,_react.useCallback)(async b=>await a.initialize(b),[a]),c=(0,_react.useCallback)(b=>{a.onConfigurationUpdate(b)},[a]);return{initialize:b,onConfigurationUpdate:c}}
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.useInitialize=useInitialize;var _react=require("react"),_useKameleoon=require("./useKameleoon");function useInitialize(){const a=(0,_useKameleoon.useKameleoon)(),b=(0,_react.useCallback)(async b=>await a.initialize(b),[a]),c=(0,_react.useCallback)(b=>{a.onConfigurationUpdate(b)},[a]),d=(0,_react.useCallback)(()=>a.isInitialized(),[a]);return{initialize:b,isInitialized:d,onConfigurationUpdate:c}}
 //# sourceMappingURL=useInitialize.js.map

package/dist/useInitialize.js.map

@@ -1 +1 @@
-{"version":3,"file":"useInitialize.js","names":["useInitialize","client","useKameleoon","initialize","useCallback","useCache","onConfigurationUpdate","callback"],"sources":["../src/useInitialize.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\nimport IUseInitialize from './interfaces/useInitialize';\n\n/**\n * A React Hook that returns methods related to SDK setup and configuration\n *\n * @returns {IUseInitialize} an object containing the following methods:\n * - `initialize`\n * - `onConfigurationUpdate`\n */\nexport function useInitialize(): IUseInitialize {\n  const client = useKameleoon();\n\n  const initialize = useCallback(\n    async (useCache?: boolean): Promise<boolean> => {\n      return await client.initialize(useCache);\n    },\n    [client],\n  );\n\n  const onConfigurationUpdate = useCallback(\n    (callback: () => void): void => {\n      client.onConfigurationUpdate(callback);\n    },\n    [client],\n  );\n\n  return {\n    initialize,\n    onConfigurationUpdate,\n  };\n}\n"],"mappings":"4KAWO,QAAS,CAAAA,aAAaA,CAAA,CAAmB,MACxC,CAAAC,CAAM,CAAG,GAAAC,0BAAY,EAAC,CAAC,CAEvBC,CAAU,CAAG,GAAAC,kBAAW,EAC5B,KAAO,CAAAC,CAAkB,EAChB,KAAM,CAAAJ,CAAM,CAACE,UAAU,CAACE,CAAQ,CACxC,CACD,CAACJ,CAAM,CACT,CAAC,CAEKK,CAAqB,CAAG,GAAAF,kBAAW,EACtCG,CAAoB,EAAW,CAC9BN,CAAM,CAACK,qBAAqB,CAACC,CAAQ,CACvC,CAAC,CACD,CAACN,CAAM,CACT,CAAC,CAED,MAAO,CACLE,UAAU,CAAVA,CAAU,CACVG,qBAAqB,CAArBA,CACF,CACF"}
+{"version":3,"file":"useInitialize.js","names":["useInitialize","client","useKameleoon","initialize","useCallback","useCache","onConfigurationUpdate","callback","isInitialized"],"sources":["../src/useInitialize.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport { useKameleoon } from './useKameleoon';\nimport IUseInitialize from './interfaces/useInitialize';\n\n/**\n * A React Hook that returns methods related to SDK setup and configuration\n *\n * @returns {IUseInitialize} an object containing the following methods:\n * - `initialize`\n * - `isInitialized`\n * - `onConfigurationUpdate`\n */\nexport function useInitialize(): IUseInitialize {\n  const client = useKameleoon();\n\n  const initialize = useCallback(\n    async (useCache?: boolean): Promise<boolean> => {\n      return await client.initialize(useCache);\n    },\n    [client],\n  );\n\n  const onConfigurationUpdate = useCallback(\n    (callback: () => void): void => {\n      client.onConfigurationUpdate(callback);\n    },\n    [client],\n  );\n\n  const isInitialized = useCallback((): boolean => {\n    return client.isInitialized();\n  }, [client]);\n\n  return {\n    initialize,\n    isInitialized,\n    onConfigurationUpdate,\n  };\n}\n"],"mappings":"4KAYO,QAAS,CAAAA,aAAaA,CAAA,CAAmB,MACxC,CAAAC,CAAM,CAAG,GAAAC,0BAAY,EAAC,CAAC,CAEvBC,CAAU,CAAG,GAAAC,kBAAW,EAC5B,KAAO,CAAAC,CAAkB,EAChB,KAAM,CAAAJ,CAAM,CAACE,UAAU,CAACE,CAAQ,CACxC,CACD,CAACJ,CAAM,CACT,CAAC,CAEKK,CAAqB,CAAG,GAAAF,kBAAW,EACtCG,CAAoB,EAAW,CAC9BN,CAAM,CAACK,qBAAqB,CAACC,CAAQ,CACvC,CAAC,CACD,CAACN,CAAM,CACT,CAAC,CAEKO,CAAa,CAAG,GAAAJ,kBAAW,EAAC,IACzBH,CAAM,CAACO,aAAa,CAAC,CAC7B,CAAE,CAACP,CAAM,CAAC,CAAC,CAEZ,MAAO,CACLE,UAAU,CAAVA,CAAU,CACVK,aAAa,CAAbA,CAAa,CACbF,qBAAqB,CAArBA,CACF,CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kameleoon/react-sdk",
-  "version": "9.0.0",
+  "version": "9.1.0",
   "description": "Kameleoon React SDK",
   "files": [
     "dist"
@@ -18,7 +18,7 @@
     "update-documentation": "/bin/bash ../../scripts/update_documentation.sh react-sdk",
     "update-changelog": "/bin/bash ../../scripts/update_changelog.sh react-sdk",
     "symlink": "yarn link",
-    "test": "NODE_ENV=test && jest",
+    "test": "jest",
     "test:dev": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage"
@@ -35,9 +35,11 @@
     "react sdk"
   ],
   "license": "ISC",
+  "dependencies": {
+    "@kameleoon/javascript-sdk": "3.1.0"
+  },
   "peerDependencies": {
-    "react": ">=16.8.0",
-    "@kameleoon/javascript-sdk": "3.0.0"
+    "react": "^16.8.0 || ^17.0.0 || ^18.0.0"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^5.16.5",