@screeb/sdk-react 0.6.0 → 0.8.0

package/README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://screeb.app" alt="Screeb">
-    <img src="https://raw.githubusercontent.com/ScreebApp/sdk-js/master/packages/screeb-sdk-react/readme/screeb-logo.svg?token=GHSAT0AAAAAAB2OOPMGT2QD5TL3IRJN3CKCZDEYHJA" alt="Logo" height="120px" style="margin-top: 20px;"/>
+    <img src="https://raw.githubusercontent.com/ScreebApp/sdk/master/packages/sdk-react/readme/screeb-logo.svg" alt="Logo" height="120px" style="margin-top: 20px;"/>
   </a>
 </p>
 <h1 align="center">@screeb/sdk-react</h1>
@@ -13,8 +13,8 @@
 </p>
 
 <p align="center">
-  <a href="https://github.com/ScreebApp/sdk-js/actions/workflows/node.js.yml" alt="ci">
-    <img alt="ci" src="https://github.com/ScreebApp/sdk-js/actions/workflows/node.js.yml/badge.svg">
+  <a href="https://github.com/ScreebApp/sdk/actions/workflows/ci.yml" alt="ci">
+    <img alt="ci" src="https://github.com/ScreebApp/sdk/actions/workflows/ci.yml/badge.svg">
   </a>
   <a href="https://www.npmjs.com/package/@screeb/sdk-react" alt="version">
     <img alt="version" src="https://img.shields.io/npm/v/@screeb/sdk-react.svg" />
@@ -86,11 +86,40 @@ const HomePage = () => {
 };
 ```
 
-For a working example, see our [Screeb React SDK example app](https://github.com/ScreebApp/sdk-js/tree/master/packages/screeb-sdk-react-example).
+### Custom domains (AdBlocker bypass)
+
+If you route Screeb traffic through your own domain (reverse proxy) to bypass AdBlockers, pass the
+`endpoints` (and optionally `screebEndpoint` for the loader URL) through the provider's `options`
+prop. Only the endpoints you provide are overridden; the rest fall back to Screeb's defaults.
+
+```tsx
+<ScreebProvider
+  autoInit
+  websiteId={SCREEB_APP_ID}
+  options={{
+    screebEndpoint: "https://analytics.acme.com/sdk/tag.js",
+    endpoints: {
+      rpc:        "https://analytics.acme.com/rpc",
+      static:     "https://analytics.acme.com/static",
+      report:     "https://analytics.acme.com/report",
+      hostedPage: "https://analytics.acme.com/hosted-page",
+      centipede:  "wss://analytics.acme.com/centipede",
+    },
+  }}
+>
+  <HomePage />
+</ScreebProvider>
+```
+
+All endpoints must use `https://` (or `wss://` for `centipede`) and the domains must be allow-listed
+in **Screeb Admin → Settings → Custom Domains**. See the
+[Custom Collector URL guide](https://developers.screeb.app/sdk-js/custom-collector-url).
+
+For a working example, see our [Screeb React SDK example app](https://github.com/ScreebApp/sdk/tree/master/examples/example-react).
 
-For a more advanced usage and a complete API documentation, see [documentation generated from source files](https://github.com/ScreebApp/sdk-js/tree/master/packages/screeb-sdk-react/docs).
+For a more advanced usage and a complete API documentation, see [documentation generated from source files](https://github.com/ScreebApp/sdk/tree/master/packages/sdk-react/docs).
 
-For further information, see [our developper documentation](https://github.com/ScreebApp/developers).
+For further information, see [our developer documentation](https://developers.screeb.app/sdk-js/install).
 
 ## Support
 For any issues, please contact our support team at support@screeb.com.
@@ -100,4 +129,4 @@ All third party contributors acknowledge that any contributions they provide wil
 
 ## License
 
-Released under [MIT License](https://github.com/ScreebApp/sdk-js/blob/master/LICENSE).
+Released under [MIT License](https://github.com/ScreebApp/sdk/blob/master/LICENSE).

package/dist/cjs/index.cjs

@@ -38,7 +38,7 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
 
 
 var __assign = function() {
@@ -75,8 +75,8 @@ function __awaiter(thisArg, _arguments, P, generator) {
 }
 
 function __generator(thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
@@ -102,6 +102,16 @@ function __generator(thisArg, body) {
     }
 }
 
+function __spreadArray(to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+}
+
 typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
     var e = new Error(message);
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
@@ -141,7 +151,7 @@ var isSSR = typeof window === "undefined";
 var CONSTANTS = { version: "0.0.0-dev" };
 var isInitialized = false;
 var ScreebProvider = function (_a) {
-    var websiteId = _a.websiteId, userId = _a.userId, userProperties = _a.userProperties, hooks = _a.hooks, language = _a.language, children = _a.children, _b = _a.shouldLoad, shouldLoad = _b === void 0 ? !isSSR : _b, _c = _a.autoInit, autoInit = _c === void 0 ? false : _c, options = _a.options, rest = __rest(_a, ["websiteId", "userId", "userProperties", "hooks", "language", "children", "shouldLoad", "autoInit", "options"]);
+    var websiteId = _a.websiteId, userId = _a.userId, userProperties = _a.userProperties, hooks = _a.hooks, language = _a.language, spaNavigationHandler = _a.spaNavigationHandler, children = _a.children, _b = _a.shouldLoad, shouldLoad = _b === void 0 ? !isSSR : _b, _c = _a.autoInit, autoInit = _c === void 0 ? false : _c, options = _a.options, rest = __rest(_a, ["websiteId", "userId", "userProperties", "hooks", "language", "spaNavigationHandler", "children", "shouldLoad", "autoInit", "options"]);
     var isLoaded = React__namespace.useRef(Screeb__namespace.isLoaded());
     var currentUserId = React__namespace.useRef(userId);
     // Allow data-x attributes, see https://github.com/devrnt/react-use-screeb/issues/478
@@ -154,10 +164,10 @@ var ScreebProvider = function (_a) {
     }
     var ensureScreeb = React__namespace.useCallback(
     // eslint-disable-next-line no-unused-vars
-    function (functionName, callback, onlyLoaded) {
-        if (onlyLoaded === void 0) { onlyLoaded = false; }
-        return __awaiter(this, void 0, void 0, function () {
+    function (functionName_1, callback_1) {
+        return __awaiter(this, arguments, void 0, function (functionName, callback, onlyLoaded) {
             var message, message;
+            if (onlyLoaded === void 0) { onlyLoaded = false; }
             return __generator(this, function (_a) {
                 if (!Screeb__namespace.isLoaded() && !shouldLoad) {
                     message = "Screeb instance is not loaded because `shouldLoad` is set to `false` in `ScreebProvider`";
@@ -260,12 +270,12 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var init = React__namespace.useCallback(function (websiteId, userId, userProperties, hooks, language) { return __awaiter(void 0, void 0, void 0, function () {
+    var init = React__namespace.useCallback(function (websiteId, userId, userProperties, hooks, language, spaNavigationHandler) { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, ensureScreeb("init", function () {
                         if (!isInitialized) {
-                            Screeb__namespace.init(websiteId, userId, userProperties, hooks, language);
+                            Screeb__namespace.init(websiteId, userId, userProperties, hooks, language, spaNavigationHandler);
                             isInitialized = true;
                             isLoaded.current = true;
                         }
@@ -285,7 +295,7 @@ var ScreebProvider = function (_a) {
                     isLoaded.current = true;
                     if (!autoInit) return [3 /*break*/, 3];
                     if (!websiteId) return [3 /*break*/, 2];
-                    return [4 /*yield*/, init(websiteId, userId, userProperties, hooks, language)];
+                    return [4 /*yield*/, init(websiteId, userId, userProperties, hooks, language, spaNavigationHandler)];
                 case 1:
                     _a.sent();
                     return [3 /*break*/, 3];
@@ -318,9 +328,13 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var messageStart = React__namespace.useCallback(function (messageId, allowMultipleResponses, hiddenFields, hooks, language) {
-        if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
-        return __awaiter(void 0, void 0, void 0, function () {
+    var messageStart = React__namespace.useCallback(function (messageId_1) {
+        var args_1 = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args_1[_i - 1] = arguments[_i];
+        }
+        return __awaiter(void 0, __spreadArray([messageId_1], args_1, true), void 0, function (messageId, allowMultipleResponses, hiddenFields, hooks, language) {
+            if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, ensureScreeb("messageStart", function () {
@@ -347,12 +361,6 @@ var ScreebProvider = function (_a) {
             }
         });
     }); }, []);
-    var targetingCheck = React__namespace.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, ensureScreeb("targetingCheck", function () { return Screeb__namespace.targetingCheck(); })];
-            case 1: return [2 /*return*/, _a.sent()];
-        }
-    }); }); }, []);
     var targetingDebug = React__namespace.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
         switch (_a.label) {
             case 0: return [4 /*yield*/, ensureScreeb("targetingDebug", function () { return Screeb__namespace.targetingDebug(); })];
@@ -392,7 +400,6 @@ var ScreebProvider = function (_a) {
         messageStart: messageStart,
         sessionReplayStop: sessionReplayStop,
         sessionReplayStart: sessionReplayStart,
-        targetingCheck: targetingCheck,
         targetingDebug: targetingDebug,
     }); }, [
         close,
@@ -412,7 +419,6 @@ var ScreebProvider = function (_a) {
         messageStart,
         sessionReplayStop,
         sessionReplayStart,
-        targetingCheck,
         targetingDebug,
     ]);
     if (!isSSR && shouldLoad) {
@@ -435,4 +441,4 @@ var useScreeb = function () {
 
 exports.ScreebProvider = ScreebProvider;
 exports.useScreeb = useScreeb;
-CONSTANTS.version = '0.6.0'
+CONSTANTS.version = '0.8.0'

package/dist/cjs/types.d.ts

@@ -1,4 +1,4 @@
-import { HooksInit, HooksMessageStart, HooksSurveyStart, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "@screeb/sdk-browser";
+import { HooksInit, HooksMessageStart, HooksSurveyStart, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions, SpaNavigationHandler } from "@screeb/sdk-browser";
 /** Properties of Screeb provider */
 export type ScreebProps = {
     /** Your website/channel id. */
@@ -11,6 +11,8 @@ export type ScreebProps = {
     hooks?: HooksInit;
     /** The language you want to force */
     language?: string;
+    /** Optional handler for the `in-page-spa` "Navigate to URL" target (custom SPA routers). */
+    spaNavigationHandler?: SpaNavigationHandler;
 };
 /**
  * Shutdowns current Screeb session.
@@ -256,7 +258,7 @@ export type IdentityResetFunction = () => Promise<unknown>;
  * );
  * ```
  */
-export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: HooksInit, language?: string) => Promise<void>;
+export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: HooksInit, language?: string, spaNavigationHandler?: SpaNavigationHandler) => Promise<void>;
 /**
  * Appends Screeb tag into your dom.
  *
@@ -359,17 +361,6 @@ export type SessionReplayStopFunction = () => Promise<unknown>;
  * ```
  */
 export type SessionReplayStartFunction = () => Promise<unknown>;
-/**
- * Forces a targeting check.
- *
- * @example
- * ```ts
- * const { targetingCheck } = useScreeb();
- *
- * targetingCheck();
- * ```
- */
-export type TargetingCheckFunction = () => Promise<unknown>;
 /**
  * Prints the current state of the targeting engine.
  *
@@ -414,7 +405,6 @@ export type ScreebContextValues = {
     messageStart: MessageStartFunction;
     sessionReplayStart: SessionReplayStartFunction;
     sessionReplayStop: SessionReplayStopFunction;
-    targetingCheck: TargetingCheckFunction;
     targetingDebug: TargetingDebugFunction;
 };
 /** Properties of Screeb provider */

package/dist/es/index.mjs

@@ -16,7 +16,7 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
 
 
 var __assign = function() {
@@ -53,8 +53,8 @@ function __awaiter(thisArg, _arguments, P, generator) {
 }
 
 function __generator(thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
@@ -80,6 +80,16 @@ function __generator(thisArg, body) {
     }
 }
 
+function __spreadArray(to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+}
+
 typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
     var e = new Error(message);
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
@@ -119,7 +129,7 @@ var isSSR = typeof window === "undefined";
 var CONSTANTS = { version: "0.0.0-dev" };
 var isInitialized = false;
 var ScreebProvider = function (_a) {
-    var websiteId = _a.websiteId, userId = _a.userId, userProperties = _a.userProperties, hooks = _a.hooks, language = _a.language, children = _a.children, _b = _a.shouldLoad, shouldLoad = _b === void 0 ? !isSSR : _b, _c = _a.autoInit, autoInit = _c === void 0 ? false : _c, options = _a.options, rest = __rest(_a, ["websiteId", "userId", "userProperties", "hooks", "language", "children", "shouldLoad", "autoInit", "options"]);
+    var websiteId = _a.websiteId, userId = _a.userId, userProperties = _a.userProperties, hooks = _a.hooks, language = _a.language, spaNavigationHandler = _a.spaNavigationHandler, children = _a.children, _b = _a.shouldLoad, shouldLoad = _b === void 0 ? !isSSR : _b, _c = _a.autoInit, autoInit = _c === void 0 ? false : _c, options = _a.options, rest = __rest(_a, ["websiteId", "userId", "userProperties", "hooks", "language", "spaNavigationHandler", "children", "shouldLoad", "autoInit", "options"]);
     var isLoaded = React.useRef(Screeb.isLoaded());
     var currentUserId = React.useRef(userId);
     // Allow data-x attributes, see https://github.com/devrnt/react-use-screeb/issues/478
@@ -132,10 +142,10 @@ var ScreebProvider = function (_a) {
     }
     var ensureScreeb = React.useCallback(
     // eslint-disable-next-line no-unused-vars
-    function (functionName, callback, onlyLoaded) {
-        if (onlyLoaded === void 0) { onlyLoaded = false; }
-        return __awaiter(this, void 0, void 0, function () {
+    function (functionName_1, callback_1) {
+        return __awaiter(this, arguments, void 0, function (functionName, callback, onlyLoaded) {
             var message, message;
+            if (onlyLoaded === void 0) { onlyLoaded = false; }
             return __generator(this, function (_a) {
                 if (!Screeb.isLoaded() && !shouldLoad) {
                     message = "Screeb instance is not loaded because `shouldLoad` is set to `false` in `ScreebProvider`";
@@ -238,12 +248,12 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var init = React.useCallback(function (websiteId, userId, userProperties, hooks, language) { return __awaiter(void 0, void 0, void 0, function () {
+    var init = React.useCallback(function (websiteId, userId, userProperties, hooks, language, spaNavigationHandler) { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, ensureScreeb("init", function () {
                         if (!isInitialized) {
-                            Screeb.init(websiteId, userId, userProperties, hooks, language);
+                            Screeb.init(websiteId, userId, userProperties, hooks, language, spaNavigationHandler);
                             isInitialized = true;
                             isLoaded.current = true;
                         }
@@ -263,7 +273,7 @@ var ScreebProvider = function (_a) {
                     isLoaded.current = true;
                     if (!autoInit) return [3 /*break*/, 3];
                     if (!websiteId) return [3 /*break*/, 2];
-                    return [4 /*yield*/, init(websiteId, userId, userProperties, hooks, language)];
+                    return [4 /*yield*/, init(websiteId, userId, userProperties, hooks, language, spaNavigationHandler)];
                 case 1:
                     _a.sent();
                     return [3 /*break*/, 3];
@@ -296,9 +306,13 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var messageStart = React.useCallback(function (messageId, allowMultipleResponses, hiddenFields, hooks, language) {
-        if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
-        return __awaiter(void 0, void 0, void 0, function () {
+    var messageStart = React.useCallback(function (messageId_1) {
+        var args_1 = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args_1[_i - 1] = arguments[_i];
+        }
+        return __awaiter(void 0, __spreadArray([messageId_1], args_1, true), void 0, function (messageId, allowMultipleResponses, hiddenFields, hooks, language) {
+            if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, ensureScreeb("messageStart", function () {
@@ -325,12 +339,6 @@ var ScreebProvider = function (_a) {
             }
         });
     }); }, []);
-    var targetingCheck = React.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, ensureScreeb("targetingCheck", function () { return Screeb.targetingCheck(); })];
-            case 1: return [2 /*return*/, _a.sent()];
-        }
-    }); }); }, []);
     var targetingDebug = React.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
         switch (_a.label) {
             case 0: return [4 /*yield*/, ensureScreeb("targetingDebug", function () { return Screeb.targetingDebug(); })];
@@ -370,7 +378,6 @@ var ScreebProvider = function (_a) {
         messageStart: messageStart,
         sessionReplayStop: sessionReplayStop,
         sessionReplayStart: sessionReplayStart,
-        targetingCheck: targetingCheck,
         targetingDebug: targetingDebug,
     }); }, [
         close,
@@ -390,7 +397,6 @@ var ScreebProvider = function (_a) {
         messageStart,
         sessionReplayStop,
         sessionReplayStart,
-        targetingCheck,
         targetingDebug,
     ]);
     if (!isSSR && shouldLoad) {
@@ -412,4 +418,4 @@ var useScreeb = function () {
 };
 
 export { ScreebProvider, useScreeb };
-CONSTANTS.version = '0.6.0'
+CONSTANTS.version = '0.8.0'

package/dist/es/types.d.ts

@@ -1,4 +1,4 @@
-import { HooksInit, HooksMessageStart, HooksSurveyStart, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "@screeb/sdk-browser";
+import { HooksInit, HooksMessageStart, HooksSurveyStart, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions, SpaNavigationHandler } from "@screeb/sdk-browser";
 /** Properties of Screeb provider */
 export type ScreebProps = {
     /** Your website/channel id. */
@@ -11,6 +11,8 @@ export type ScreebProps = {
     hooks?: HooksInit;
     /** The language you want to force */
     language?: string;
+    /** Optional handler for the `in-page-spa` "Navigate to URL" target (custom SPA routers). */
+    spaNavigationHandler?: SpaNavigationHandler;
 };
 /**
  * Shutdowns current Screeb session.
@@ -256,7 +258,7 @@ export type IdentityResetFunction = () => Promise<unknown>;
  * );
  * ```
  */
-export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: HooksInit, language?: string) => Promise<void>;
+export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: HooksInit, language?: string, spaNavigationHandler?: SpaNavigationHandler) => Promise<void>;
 /**
  * Appends Screeb tag into your dom.
  *
@@ -359,17 +361,6 @@ export type SessionReplayStopFunction = () => Promise<unknown>;
  * ```
  */
 export type SessionReplayStartFunction = () => Promise<unknown>;
-/**
- * Forces a targeting check.
- *
- * @example
- * ```ts
- * const { targetingCheck } = useScreeb();
- *
- * targetingCheck();
- * ```
- */
-export type TargetingCheckFunction = () => Promise<unknown>;
 /**
  * Prints the current state of the targeting engine.
  *
@@ -414,7 +405,6 @@ export type ScreebContextValues = {
     messageStart: MessageStartFunction;
     sessionReplayStart: SessionReplayStartFunction;
     sessionReplayStop: SessionReplayStopFunction;
-    targetingCheck: TargetingCheckFunction;
     targetingDebug: TargetingDebugFunction;
 };
 /** Properties of Screeb provider */

package/docs/README.md

@@ -26,7 +26,6 @@
 - [SessionReplayStopFunction](README.md#sessionreplaystopfunction)
 - [SurveyCloseFunction](README.md#surveyclosefunction)
 - [SurveyStartFunction](README.md#surveystartfunction)
-- [TargetingCheckFunction](README.md#targetingcheckfunction)
 - [TargetingDebugFunction](README.md#targetingdebugfunction)
 
 ### Functions
@@ -368,7 +367,7 @@ ___
 
 ### InitFunction
 
-Ƭ **InitFunction**: (`websiteId`: `string`, `userId?`: `string`, `userProperties?`: `PropertyRecord`, `hooks?`: `HooksInit`, `language?`: `string`) => `Promise`\<`void`\>
+Ƭ **InitFunction**: (`websiteId`: `string`, `userId?`: `string`, `userProperties?`: `PropertyRecord`, `hooks?`: `HooksInit`, `language?`: `string`, `spaNavigationHandler?`: `SpaNavigationHandler`) => `Promise`\<`void`\>
 
 Initializes Screeb tag.
 
@@ -393,7 +392,7 @@ init(
 
 #### Type declaration
 
-▸ (`websiteId`, `userId?`, `userProperties?`, `hooks?`, `language?`): `Promise`\<`void`\>
+▸ (`websiteId`, `userId?`, `userProperties?`, `hooks?`, `language?`, `spaNavigationHandler?`): `Promise`\<`void`\>
 
 ##### Parameters
 
@@ -404,6 +403,7 @@ init(
 | `userProperties?` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date ``` |
 | `hooks?` | `HooksInit` | - |
 | `language?` | `string` | Force a specific language for the tag. eg: 'en'. default: browser language. |
+| `spaNavigationHandler?` | `SpaNavigationHandler` | - |
 
 ##### Returns
 
@@ -533,7 +533,6 @@ Screeb context API
 | `sessionReplayStop` | [`SessionReplayStopFunction`](README.md#sessionreplaystopfunction) |
 | `surveyClose` | [`SurveyCloseFunction`](README.md#surveyclosefunction) |
 | `surveyStart` | [`SurveyStartFunction`](README.md#surveystartfunction) |
-| `targetingCheck` | [`TargetingCheckFunction`](README.md#targetingcheckfunction) |
 | `targetingDebug` | [`TargetingDebugFunction`](README.md#targetingdebugfunction) |
 
 ___
@@ -550,6 +549,7 @@ Properties of Screeb provider
 | :------ | :------ | :------ |
 | `hooks?` | `HooksInit` | Hooks to define callback for various event |
 | `language?` | `string` | The language you want to force |
+| `spaNavigationHandler?` | `SpaNavigationHandler` | Optional handler for the `in-page-spa` "Navigate to URL" target (custom SPA routers). |
 | `userId?` | `string` | The unique identifier of your user. |
 | `userProperties?` | `PropertyRecord` | The properties of your user. |
 | `websiteId` | `string` | Your website/channel id. |
@@ -686,30 +686,6 @@ surveyStart(
 
 ___
 
-### TargetingCheckFunction
-
-Ƭ **TargetingCheckFunction**: () => `Promise`\<`unknown`\>
-
-Forces a targeting check.
-
-**`Example`**
-
-```ts
-const { targetingCheck } = useScreeb();
-
-targetingCheck();
-```
-
-#### Type declaration
-
-▸ (): `Promise`\<`unknown`\>
-
-##### Returns
-
-`Promise`\<`unknown`\>
-
-___
-
 ### TargetingDebugFunction
 
 Ƭ **TargetingDebugFunction**: () => `Promise`\<`unknown`\>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-react",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Screeb's browser sdk, optimized for React.",
   "keywords": [
     "product discovery",
@@ -13,13 +13,13 @@
   ],
   "homepage": "https://screeb.app",
   "bugs": {
-    "url": "https://github.com/ScreebApp/sdk-js/issues",
+    "url": "https://github.com/ScreebApp/sdk/issues",
     "email": "support@screeb.app"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/ScreebApp/sdk-js.git",
-    "directory": "packages/screeb-sdk-react"
+    "url": "https://github.com/ScreebApp/sdk.git",
+    "directory": "packages/sdk-react"
   },
   "license": "MIT",
   "author": "Screeb's frontend team",
@@ -41,25 +41,25 @@
     "test": "echo '@TODO'"
   },
   "dependencies": {
-    "@screeb/sdk-browser": "^0.5.0"
+    "@screeb/sdk-browser": "^0.7.0"
   },
   "devDependencies": {
-    "@screeb/eslint-config": "^0.1.6",
-    "@screeb/typescript-config": "^0.1.10",
-    "@types/jest": "^29.5.5",
-    "@types/node": "^20.8.4",
-    "@types/react": "^18.2.28",
-    "@types/react-dom": "^18.2.13",
+    "@screeb/eslint-config": "^0.1.8",
+    "@screeb/typescript-config": "^0.1.13",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.8.10",
+    "@types/react": "^18.2.79",
+    "@types/react-dom": "^18.2.25",
     "@typescript-eslint/eslint-plugin": "^6.7.5",
     "eslint": "^8.51.0",
     "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jest": "^27.4.2",
+    "eslint-plugin-jest": "^27.4.3",
     "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-prettier": "^5.0.1",
     "jest": "^29.7.0",
     "prettier": "^3.0.3",
-    "react": ">=18.2.0",
-    "react-dom": ">=18.2.0",
+    "react": ">=16.8.6",
+    "react-dom": ">=16.8.6",
     "rollup": "^4.0.2",
     "typedoc": "^0.25.2",
     "typedoc-plugin-markdown": "^3.16.0"