@kameleoon/react-sdk 10.20.0 → 10.21.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## 10.21.0 (2026-03-04)
+
+### Features
+
+- Introduced a new [`flushInstant`][flush] method — an asynchronous version of `flush` that returns `Promise<void>` and can be awaited:
+  - Use `await flushInstant(visitorCode)` to send tracking requests immediately and wait for completion.
+  - Use `await flushInstant()` to send tracking requests immediately for all visitors.
+
+### Patch Changes
+
+- Updated dependencies
+  - @kameleoon/javascript-sdk@4.19.0
+
 ## 10.20.0 (2026-02-13)
 
 ### Features

package/dist/interfaces/useData.d.ts

@@ -27,6 +27,28 @@ export default interface IUseData {
      * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed it's `initialize` call.
      */
     flush: (visitorCode?: string, instant?: boolean) => void;
+    /**
+     * Sends visitor-associated Kameleoon tracking data immediately.
+     * The collected data is sent in a tracking request and then removed from the `KameleoonClient`
+     * instance, but it remains in storage for correct targeting checks.
+     *
+     * If no visitor code is provided, the data for all visitors is sent and removed from the
+     * `KameleoonClient` instance. Before sending the current data, the method first attempts
+     * to resend any previously failed tracking requests that were stored locally during offline mode.
+     *
+     * This method sends the data instantly and returns a Promise that resolves when the
+     * tracking requests have been processed, allowing the caller to wait for completion.
+     *
+     * @param {string | undefined} visitorCode - Unique visitor identification string.
+     * Cannot exceed 255 characters in length. If omitted, data for all visitors is sent.
+     * @returns {Promise<void>} A promise that resolves when the flush operation completes.
+     *
+     * @throws `KameleoonError` with one of the following `type`s:
+     * - `KameleoonException.VisitorCodeMaxLength` - The visitor code length was exceeded
+     * - `KameleoonException.VisitorCodeEmpty` - The visitor code is empty
+     * - `KameleoonException.Initialization` - Method was executed before the `kameleoonClient` completed its `initialize` call
+     */
+    flushInstant: (visitorCode?: string) => Promise<void>;
     /**
      * 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.
      *