@screeb/sdk-vue 0.2.1 → 0.3.0

package/dist/cjs/index.cjs

@@ -242,12 +242,12 @@ var ScreebPlugin = {
                 case 1: return [2 /*return*/, _a.sent()];
             }
         }); }); };
-        var init = function (websiteId, userId, userProperties, hooks, language) { return __awaiter(_this, void 0, void 0, function () {
+        var init = function (websiteId, userId, userProperties, hooks, language, spaNavigationHandler) { return __awaiter(_this, 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;
                             }
                         }, true)];
@@ -266,7 +266,7 @@ var ScreebPlugin = {
                         Screeb__namespace.load(__assign({ sdkName: "sdk-vue", sdkVersion: CONSTANTS.version }, options));
                         if (!((_a = reactiveConfig.autoInit) !== null && _a !== void 0 ? _a : false)) return [3 /*break*/, 3];
                         if (!reactiveConfig.websiteId) return [3 /*break*/, 2];
-                        return [4 /*yield*/, init(reactiveConfig.websiteId, reactiveConfig.userId, reactiveConfig.userProperties, reactiveConfig.hooks, reactiveConfig.language)];
+                        return [4 /*yield*/, init(reactiveConfig.websiteId, reactiveConfig.userId, reactiveConfig.userProperties, reactiveConfig.hooks, reactiveConfig.language, reactiveConfig.spaNavigationHandler)];
                     case 1:
                         _b.sent();
                         return [3 /*break*/, 3];
@@ -332,12 +332,6 @@ var ScreebPlugin = {
                 }
             });
         }); };
-        var targetingCheck = function () { return __awaiter(_this, 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 = function () { return __awaiter(_this, 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(); })];
@@ -374,7 +368,6 @@ var ScreebPlugin = {
             messageStart: messageStart,
             sessionReplayStop: sessionReplayStop,
             sessionReplayStart: sessionReplayStart,
-            targetingCheck: targetingCheck,
             targetingDebug: targetingDebug,
         };
         app.provide(SCREEB_PLUGIN_KEY, context);
@@ -396,4 +389,4 @@ function useScreeb() {
 exports.SCREEB_PLUGIN_KEY = SCREEB_PLUGIN_KEY;
 exports.ScreebPlugin = ScreebPlugin;
 exports.useScreeb = useScreeb;
-CONSTANTS.version = '0.2.1'
+CONSTANTS.version = '0.3.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";
 /** Configuration for the ScreebPlugin */
 export type ScreebConfig = {
     /** Your website/channel id. */
@@ -11,6 +11,8 @@ export type ScreebConfig = {
     hooks?: HooksInit;
     /** Force a specific language (e.g. 'en'). Default: browser language. */
     language?: string;
+    /** Optional handler for the `in-page-spa` "Navigate to URL" target (custom SPA routers). */
+    spaNavigationHandler?: SpaNavigationHandler;
     /**
      * Indicates if Screeb should be automatically loaded.
      * Set to false to prevent the SDK from loading (e.g. in CI).
@@ -35,7 +37,7 @@ export type IdentityGroupAssignFunction = (groupName: string, groupType?: string
 export type IdentityGroupUnassignFunction = (groupName: string, groupType?: string) => Promise<unknown>;
 export type IdentityPropertiesFunction = (userProperties: PropertyRecord) => Promise<unknown>;
 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>;
 export type LoadFunction = (options?: ScreebOptions) => Promise<void>;
 export type SurveyCloseFunction = () => Promise<unknown>;
 export type SurveyStartFunction = (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string, selectors?: string | string[]) => Promise<unknown>;
@@ -43,7 +45,6 @@ export type MessageCloseFunction = () => Promise<unknown>;
 export type MessageStartFunction = (messageId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksMessageStart, language?: string) => Promise<unknown>;
 export type SessionReplayStopFunction = () => Promise<unknown>;
 export type SessionReplayStartFunction = () => Promise<unknown>;
-export type TargetingCheckFunction = () => Promise<unknown>;
 export type TargetingDebugFunction = () => Promise<unknown>;
 /** All Screeb methods provided via `useScreeb()` */
 export type ScreebContextValues = {
@@ -64,6 +65,5 @@ export type ScreebContextValues = {
     messageStart: MessageStartFunction;
     sessionReplayStart: SessionReplayStartFunction;
     sessionReplayStop: SessionReplayStopFunction;
-    targetingCheck: TargetingCheckFunction;
     targetingDebug: TargetingDebugFunction;
 };

package/dist/es/index.mjs

@@ -221,12 +221,12 @@ var ScreebPlugin = {
                 case 1: return [2 /*return*/, _a.sent()];
             }
         }); }); };
-        var init = function (websiteId, userId, userProperties, hooks, language) { return __awaiter(_this, void 0, void 0, function () {
+        var init = function (websiteId, userId, userProperties, hooks, language, spaNavigationHandler) { return __awaiter(_this, 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;
                             }
                         }, true)];
@@ -245,7 +245,7 @@ var ScreebPlugin = {
                         Screeb.load(__assign({ sdkName: "sdk-vue", sdkVersion: CONSTANTS.version }, options));
                         if (!((_a = reactiveConfig.autoInit) !== null && _a !== void 0 ? _a : false)) return [3 /*break*/, 3];
                         if (!reactiveConfig.websiteId) return [3 /*break*/, 2];
-                        return [4 /*yield*/, init(reactiveConfig.websiteId, reactiveConfig.userId, reactiveConfig.userProperties, reactiveConfig.hooks, reactiveConfig.language)];
+                        return [4 /*yield*/, init(reactiveConfig.websiteId, reactiveConfig.userId, reactiveConfig.userProperties, reactiveConfig.hooks, reactiveConfig.language, reactiveConfig.spaNavigationHandler)];
                     case 1:
                         _b.sent();
                         return [3 /*break*/, 3];
@@ -311,12 +311,6 @@ var ScreebPlugin = {
                 }
             });
         }); };
-        var targetingCheck = function () { return __awaiter(_this, 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 = function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, ensureScreeb("targetingDebug", function () { return Screeb.targetingDebug(); })];
@@ -353,7 +347,6 @@ var ScreebPlugin = {
             messageStart: messageStart,
             sessionReplayStop: sessionReplayStop,
             sessionReplayStart: sessionReplayStart,
-            targetingCheck: targetingCheck,
             targetingDebug: targetingDebug,
         };
         app.provide(SCREEB_PLUGIN_KEY, context);
@@ -373,4 +366,4 @@ function useScreeb() {
 }
 
 export { SCREEB_PLUGIN_KEY, ScreebPlugin, useScreeb };
-CONSTANTS.version = '0.2.1'
+CONSTANTS.version = '0.3.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";
 /** Configuration for the ScreebPlugin */
 export type ScreebConfig = {
     /** Your website/channel id. */
@@ -11,6 +11,8 @@ export type ScreebConfig = {
     hooks?: HooksInit;
     /** Force a specific language (e.g. 'en'). Default: browser language. */
     language?: string;
+    /** Optional handler for the `in-page-spa` "Navigate to URL" target (custom SPA routers). */
+    spaNavigationHandler?: SpaNavigationHandler;
     /**
      * Indicates if Screeb should be automatically loaded.
      * Set to false to prevent the SDK from loading (e.g. in CI).
@@ -35,7 +37,7 @@ export type IdentityGroupAssignFunction = (groupName: string, groupType?: string
 export type IdentityGroupUnassignFunction = (groupName: string, groupType?: string) => Promise<unknown>;
 export type IdentityPropertiesFunction = (userProperties: PropertyRecord) => Promise<unknown>;
 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>;
 export type LoadFunction = (options?: ScreebOptions) => Promise<void>;
 export type SurveyCloseFunction = () => Promise<unknown>;
 export type SurveyStartFunction = (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string, selectors?: string | string[]) => Promise<unknown>;
@@ -43,7 +45,6 @@ export type MessageCloseFunction = () => Promise<unknown>;
 export type MessageStartFunction = (messageId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksMessageStart, language?: string) => Promise<unknown>;
 export type SessionReplayStopFunction = () => Promise<unknown>;
 export type SessionReplayStartFunction = () => Promise<unknown>;
-export type TargetingCheckFunction = () => Promise<unknown>;
 export type TargetingDebugFunction = () => Promise<unknown>;
 /** All Screeb methods provided via `useScreeb()` */
 export type ScreebContextValues = {
@@ -64,6 +65,5 @@ export type ScreebContextValues = {
     messageStart: MessageStartFunction;
     sessionReplayStart: SessionReplayStartFunction;
     sessionReplayStop: SessionReplayStopFunction;
-    targetingCheck: TargetingCheckFunction;
     targetingDebug: TargetingDebugFunction;
 };

package/docs/README.md

@@ -25,7 +25,6 @@
 - [SessionReplayStopFunction](README.md#sessionreplaystopfunction)
 - [SurveyCloseFunction](README.md#surveyclosefunction)
 - [SurveyStartFunction](README.md#surveystartfunction)
-- [TargetingCheckFunction](README.md#targetingcheckfunction)
 - [TargetingDebugFunction](README.md#targetingdebugfunction)
 
 ### Variables
@@ -202,11 +201,11 @@ ___
 
 ### 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`\>
 
 #### Type declaration
 
-▸ (`websiteId`, `userId?`, `userProperties?`, `hooks?`, `language?`): `Promise`\<`void`\>
+▸ (`websiteId`, `userId?`, `userProperties?`, `hooks?`, `language?`, `spaNavigationHandler?`): `Promise`\<`void`\>
 
 ##### Parameters
 
@@ -217,6 +216,7 @@ ___
 | `userProperties?` | `PropertyRecord` |
 | `hooks?` | `HooksInit` |
 | `language?` | `string` |
+| `spaNavigationHandler?` | `SpaNavigationHandler` |
 
 ##### Returns
 
@@ -297,6 +297,7 @@ Configuration for the ScreebPlugin
 | `language?` | `string` | Force a specific language (e.g. 'en'). Default: browser language. |
 | `options?` | `ScreebOptions` | Screeb tag initialization options — handle with care. |
 | `shouldLoad?` | `boolean` | Indicates if Screeb should be automatically loaded. Set to false to prevent the SDK from loading (e.g. in CI). **`Default`** ```ts true ``` |
+| `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. |
@@ -330,7 +331,6 @@ All Screeb methods provided via `useScreeb()`
 | `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) |
 
 ___
@@ -403,20 +403,6 @@ ___
 
 ___
 
-### TargetingCheckFunction
-
-Ƭ **TargetingCheckFunction**: () => `Promise`\<`unknown`\>
-
-#### Type declaration
-
-▸ (): `Promise`\<`unknown`\>
-
-##### Returns
-
-`Promise`\<`unknown`\>
-
-___
-
 ### TargetingDebugFunction
 
 Ƭ **TargetingDebugFunction**: () => `Promise`\<`unknown`\>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-vue",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Screeb's browser SDK, optimized for Vue 3.",
   "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",
     "@typescript-eslint/eslint-plugin": "^6.7.5",
     "eslint": "^8.51.0",
     "eslint-plugin-import": "^2.28.1",