@screeb/sdk-react 0.7.1 → 0.8.0

package/dist/cjs/index.cjs

@@ -151,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
@@ -270,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;
                         }
@@ -295,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];
@@ -361,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(); })];
@@ -406,7 +400,6 @@ var ScreebProvider = function (_a) {
         messageStart: messageStart,
         sessionReplayStop: sessionReplayStop,
         sessionReplayStart: sessionReplayStart,
-        targetingCheck: targetingCheck,
         targetingDebug: targetingDebug,
     }); }, [
         close,
@@ -426,7 +419,6 @@ var ScreebProvider = function (_a) {
         messageStart,
         sessionReplayStop,
         sessionReplayStart,
-        targetingCheck,
         targetingDebug,
     ]);
     if (!isSSR && shouldLoad) {
@@ -449,4 +441,4 @@ var useScreeb = function () {
 
 exports.ScreebProvider = ScreebProvider;
 exports.useScreeb = useScreeb;
-CONSTANTS.version = '0.7.1'
+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

@@ -129,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
@@ -248,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;
                         }
@@ -273,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];
@@ -339,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(); })];
@@ -384,7 +378,6 @@ var ScreebProvider = function (_a) {
         messageStart: messageStart,
         sessionReplayStop: sessionReplayStop,
         sessionReplayStart: sessionReplayStart,
-        targetingCheck: targetingCheck,
         targetingDebug: targetingDebug,
     }); }, [
         close,
@@ -404,7 +397,6 @@ var ScreebProvider = function (_a) {
         messageStart,
         sessionReplayStop,
         sessionReplayStart,
-        targetingCheck,
         targetingDebug,
     ]);
     if (!isSSR && shouldLoad) {
@@ -426,4 +418,4 @@ var useScreeb = function () {
 };
 
 export { ScreebProvider, useScreeb };
-CONSTANTS.version = '0.7.1'
+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.7.1",
+  "version": "0.8.0",
   "description": "Screeb's browser sdk, optimized for React.",
   "keywords": [
     "product discovery",
@@ -41,11 +41,11 @@
     "test": "echo '@TODO'"
   },
   "dependencies": {
-    "@screeb/sdk-browser": "^0.6.1"
+    "@screeb/sdk-browser": "^0.7.0"
   },
   "devDependencies": {
-    "@screeb/eslint-config": "^0.1.7",
-    "@screeb/typescript-config": "^0.1.12",
+    "@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",