@kameleoon/react-sdk 9.3.0 → 9.4.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change Log
 
+## 9.4.0 (2024-06-21)
+
+### Features
+
+- Added new [`networkDomain`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#1-create-kameleoon-client) parameter in `SDKConfigurationType` for configuring custom network domain for all outgoing requests.
+- [`SDKConfigurationType`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#1-create-kameleoon-client) parameter `domain` was deprecated and will be removed in the next major version. Instead new `cookieDomain` is available.
+- Consent value can now be read automatically from the JS Script if the visitor code is set in cookie.
+- Add new optional [External Dependency](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#external-dependencies) - [Requester](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#requester) for implementing custom network request handler
+- Added new `KameleoonUtils` methods:
+  - [`getCookieValue`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#getcookievalue) for extracting cookie value from cookie string
+  - [`simulateSuccessRequest`](https://developers.kameleoon.com/feature-management-and-experimentation/web-sdks/react-js-sdk#simulatesuccessrequest) for mocking successful network requests when implementing custom `Requester`
+
+### Patch Changes
+
+- Updated dependencies
+  - @kameleoon/javascript-sdk@3.4.0
+
 ## 9.3.0 (2024-05-24)
 
 ### Features

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.3.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.4.0"}});return e}
 //# sourceMappingURL=createClient.js.map

package/dist/interfaces/useInitialize.d.ts

@@ -41,7 +41,7 @@ export default interface IUseInitialize {
      *
      * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call
      */
-    onEvent: (event: EventType, callback: EventCallbackType<EventType>) => void;
+    onEvent: <E extends EventType>(event: E, callback: EventCallbackType<E>) => void;
     /**
      * Checks if client is initialized.
      *

package/dist/interfaces/useInitialize.js.map

@@ -1 +1 @@
-{"version":3,"file":"useInitialize.js","names":[],"sources":["../../src/interfaces/useInitialize.ts"],"sourcesContent":["import { EventCallbackType, EventType } from '@kameleoon/javascript-sdk';\n\nexport 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   * @deprecated\n   * use `onEvent(EventType.ConfigurationUpdate, callback)` instead\n   * Will be removed in the next major release\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   * @method onEvent - fires a callback on a specified Kameleoon `EventType`. Each event can only have one according callback.\n   *\n   * Note: SDK methods are marked with the `EventType` they trigger if any.\n   *\n   * @param {EventCallbackType<EventType>} callback - callback function with parameters that will be called upon event\n   *\n   * Parameter type depends on the `EventType` passed:\n   * - `EventType.Evaluation` - `EvaluationEventDataType`\n   * - `EventType.ConfigurationUpdate` - `ConfigurationUpdateEventDataType`\n   *\n   * @returns {void}\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  onEvent: (event: EventType, callback: EventCallbackType<EventType>) => 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":""}
+{"version":3,"file":"useInitialize.js","names":[],"sources":["../../src/interfaces/useInitialize.ts"],"sourcesContent":["import { EventCallbackType, EventType } from '@kameleoon/javascript-sdk';\n\nexport 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   * @deprecated\n   * use `onEvent(EventType.ConfigurationUpdate, callback)` instead\n   * Will be removed in the next major release\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   * @method onEvent - fires a callback on a specified Kameleoon `EventType`. Each event can only have one according callback.\n   *\n   * Note: SDK methods are marked with the `EventType` they trigger if any.\n   *\n   * @param {EventCallbackType<EventType>} callback - callback function with parameters that will be called upon event\n   *\n   * Parameter type depends on the `EventType` passed:\n   * - `EventType.Evaluation` - `EvaluationEventDataType`\n   * - `EventType.ConfigurationUpdate` - `ConfigurationUpdateEventDataType`\n   *\n   * @returns {void}\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  onEvent: <E extends EventType>(\n    event: E,\n    callback: EventCallbackType<E>,\n  ) => 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kameleoon/react-sdk",
-  "version": "9.3.0",
+  "version": "9.4.0",
   "description": "Kameleoon React SDK",
   "files": [
     "dist"
@@ -9,7 +9,7 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "clean": "rimraf dist && rimraf tsconfig.tsbuildinfo",
-    "start": "npm run clean && tsc -w",
+    "dev": "npm run clean && tsc -w -p tsconfig.watch.json",
     "build": "npm run clean && npm run build:types && npm run build:js",
     "build:types": "tsc --emitDeclarationOnly",
     "build:js": "babel src --out-dir dist --extensions \".ts,.tsx\" --source-maps true",
@@ -36,7 +36,7 @@
   ],
   "license": "ISC",
   "dependencies": {
-    "@kameleoon/javascript-sdk": "3.3.0"
+    "@kameleoon/javascript-sdk": "3.4.0"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0"