@screeb/sdk-browser 0.5.0 → 0.7.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-browser/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-browser/readme/screeb-logo.svg" alt="Logo" height="120px" style="margin-top: 20px;"/>
   </a>
 </p>
 <h1 align="center">@screeb/sdk-browser</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-browser" alt="version">
     <img alt="version" src="https://img.shields.io/npm/v/@screeb/sdk-browser.svg" />
@@ -50,11 +50,39 @@ Screeb.load();
 Screeb.init('<your-website-id>');
 ```
 
-For a working example, see our [Screeb Angular SDK example app](https://github.com/ScreebApp/sdk-js/tree/master/packages/screeb-sdk-browser-example).
+### Custom domains (AdBlocker bypass)
 
-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-browser/docs).
+If you route Screeb traffic through your own domain (reverse proxy) to bypass AdBlockers, pass an
+`endpoints` object to `load()`. Only the endpoints you provide are overridden; the rest fall back
+to Screeb's defaults. The tag loader URL itself is set separately via `screebEndpoint`.
 
-For further information, see [our developper documentation](https://github.com/ScreebApp/developers).
+```ts
+import * as Screeb from "@screeb/sdk-browser";
+
+Screeb.load({
+  // Load the SDK bundle from your domain
+  screebEndpoint: "https://analytics.acme.com/sdk/tag.js",
+  // Route collector traffic through your domain
+  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",
+  },
+});
+Screeb.init('<your-website-id>');
+```
+
+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 Browser SDK example app](https://github.com/ScreebApp/sdk/tree/master/examples/example-browser).
+
+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-browser/docs).
+
+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.
@@ -64,4 +92,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/hooks.types.d.ts

@@ -114,6 +114,24 @@ export type HookOnQuestionReplied = (data: HookCommonPropertiesSurvey & {
         items: ResponseItem[];
     };
 }) => void;
+export type HookOnButtonNavigateStarted = (data: HookCommonPropertiesSurvey & {
+    response: {
+        id: string;
+    };
+    button: {
+        url: string;
+        url_target?: string;
+    };
+}) => void;
+export type HookOnButtonNavigateCompleted = (data: HookCommonPropertiesSurvey & {
+    response: {
+        id: string;
+    };
+    button: {
+        url: string;
+        url_target?: string;
+    };
+}) => void;
 /** This is the Screeb tag hooks object available on `survey.start` command. */
 export type HooksSurveyStart = {
     /** This hook is triggered when a survey is displayed on screen (also triggered when page is reloaded) */
@@ -126,6 +144,10 @@ export type HooksSurveyStart = {
     onSurveyHidden?: HookOnSurveyHidden;
     /** This hook is triggered when a question is answered */
     onQuestionReplied?: HookOnQuestionReplied;
+    /** This hook is triggered before a message/tour button "Navigate to URL" action runs. */
+    onButtonNavigateStarted?: HookOnButtonNavigateStarted;
+    /** This hook is triggered after a message/tour button "Navigate to URL" action ran (only fires when the SDK survives the navigation, e.g. `new-tab` or `in-page-spa`). */
+    onButtonNavigateCompleted?: HookOnButtonNavigateCompleted;
 };
 /** This is the Screeb tag hooks object available on `message.start` command. */
 export type HooksMessageStart = {
@@ -139,6 +161,10 @@ export type HooksMessageStart = {
     onMessageHidden?: HookOnMessageHidden;
     /** This hook is triggered when a question is answered */
     onQuestionReplied?: HookOnQuestionReplied;
+    /** This hook is triggered before a message/tour button "Navigate to URL" action runs. */
+    onButtonNavigateStarted?: HookOnButtonNavigateStarted;
+    /** This hook is triggered after a message/tour button "Navigate to URL" action ran (only fires when the SDK survives the navigation, e.g. `new-tab` or `in-page-spa`). */
+    onButtonNavigateCompleted?: HookOnButtonNavigateCompleted;
 };
 /** This is the Screeb tag hooks object available on `init` command. */
 export type HooksInit = HooksSurveyStart & HooksMessageStart & {

package/dist/cjs/index.cjs

@@ -14,7 +14,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() {
@@ -52,6 +52,8 @@ var callScreebCommand = function () {
  * @param options Screeb module options.
  * @param options.window If you're running Screeb tag in an iframe, please set the inner window here.
  * @param options.screebEndpoint Please don't do this.
+ * @param options.endpoints Override Screeb's collector URLs to route traffic through your own
+ * domain (custom domains / AdBlocker bypass). Only the endpoints you provide are overridden.
  *
  * @example
  * ```ts
@@ -70,8 +72,8 @@ var load = function (options) {
         scriptElement.src = (_b = options.screebEndpoint) !== null && _b !== void 0 ? _b : SCREEB_TAG_ENDPOINT;
         scriptElement.addEventListener("load", function () { return resolve(undefined); });
         scriptElement.addEventListener("error", reject);
-        if (options.platform) {
-            _window["ScreebConfig"] = { platform: options.platform };
+        if (options.platform || options.endpoints) {
+            _window["ScreebConfig"] = __assign(__assign({}, (options.platform ? { platform: options.platform } : {})), (options.endpoints ? { endpoints: options.endpoints } : {}));
         }
         _window.$screeb =
             (_c = _window.$screeb) !== null && _c !== void 0 ? _c : function () {
@@ -116,6 +118,11 @@ var load = function (options) {
  *
  * @param language Force a specific language for the tag. eg: 'en'. default: browser language.
  *
+ * @param spaNavigationHandler Optional handler for the `in-page-spa` "Navigate to URL"
+ * target. Runs in your page so your SPA router can navigate without a full reload. Only
+ * needed for custom routers that don't resync on `popstate` (React Router / Vue Router /
+ * Angular Router work out of the box). May be async so `onButtonNavigateCompleted` awaits it.
+ *
  * @example
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
@@ -133,12 +140,14 @@ var load = function (options) {
  *   {
  *     version: "1.0.0",
  *     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
+ *     onButtonNavigateStarted: (payload) => console.log("Button navigate started", payload),
+ *     onButtonNavigateCompleted: (payload) => console.log("Button navigate completed", payload),
  *   },
  *   "en"
  * );
  * ```
  */
-var init = function (websiteId, userId, userProperties, hooks, language) {
+var init = function (websiteId, userId, userProperties, hooks, language, spaNavigationHandler) {
     var identityObject;
     if (userId || userProperties) {
         identityObject = {
@@ -152,6 +161,9 @@ var init = function (websiteId, userId, userProperties, hooks, language) {
     if (language) {
         identityObject = __assign(__assign({}, identityObject), { language: language });
     }
+    if (spaNavigationHandler) {
+        identityObject = __assign(__assign({}, identityObject), { spaNavigationHandler: spaNavigationHandler });
+    }
     return callScreebCommand("init", websiteId, identityObject);
 };
 /**
@@ -506,17 +518,6 @@ var sessionReplayStop = function () { return callScreebCommand("session-replay.s
 var sessionReplayStart = function () {
     return callScreebCommand("session-replay.start");
 };
-/**
- * Forces a targeting check.
- *
- * @example
- * ```ts
- * import * as Screeb from "@screeb/sdk-browser";
- *
- * Screeb.targetingCheck();
- * ```
- */
-var targetingCheck = function () { return callScreebCommand("targeting.check"); };
 /**
  * Prints the current state of the targeting engine.
  *
@@ -561,6 +562,5 @@ exports.sessionReplayStart = sessionReplayStart;
 exports.sessionReplayStop = sessionReplayStop;
 exports.surveyClose = surveyClose;
 exports.surveyStart = surveyStart;
-exports.targetingCheck = targetingCheck;
 exports.targetingDebug = targetingDebug;
-CONSTANTS.version = '0.5.0'
+CONSTANTS.version = '0.7.0'

package/dist/cjs/index.d.ts

@@ -1,5 +1,5 @@
 import { HooksInit, HooksMessageStart, HooksSurveyStart } from "./hooks.types";
-import { PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "./types";
+import { PropertyRecord, ScreebIdentityGetReturn, ScreebOptions, SpaNavigationHandler } from "./types";
 export * from "./types";
 export * from "./hooks.types";
 /**
@@ -8,6 +8,8 @@ export * from "./hooks.types";
  * @param options Screeb module options.
  * @param options.window If you're running Screeb tag in an iframe, please set the inner window here.
  * @param options.screebEndpoint Please don't do this.
+ * @param options.endpoints Override Screeb's collector URLs to route traffic through your own
+ * domain (custom domains / AdBlocker bypass). Only the endpoints you provide are overridden.
  *
  * @example
  * ```ts
@@ -33,6 +35,11 @@ export declare const load: (options?: ScreebOptions) => Promise<undefined>;
  *
  * @param language Force a specific language for the tag. eg: 'en'. default: browser language.
  *
+ * @param spaNavigationHandler Optional handler for the `in-page-spa` "Navigate to URL"
+ * target. Runs in your page so your SPA router can navigate without a full reload. Only
+ * needed for custom routers that don't resync on `popstate` (React Router / Vue Router /
+ * Angular Router work out of the box). May be async so `onButtonNavigateCompleted` awaits it.
+ *
  * @example
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
@@ -50,12 +57,14 @@ export declare const load: (options?: ScreebOptions) => Promise<undefined>;
  *   {
  *     version: "1.0.0",
  *     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
+ *     onButtonNavigateStarted: (payload) => console.log("Button navigate started", payload),
+ *     onButtonNavigateCompleted: (payload) => console.log("Button navigate completed", payload),
  *   },
  *   "en"
  * );
  * ```
  */
-export declare const init: (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: HooksInit, language?: string) => void | Promise<unknown>;
+export declare const init: (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: HooksInit, language?: string, spaNavigationHandler?: SpaNavigationHandler) => void | Promise<unknown>;
 /**
  * Checks if Screeb tag has been loaded.
  *
@@ -374,17 +383,6 @@ export declare const sessionReplayStop: () => void | Promise<unknown>;
  * ```
  */
 export declare const sessionReplayStart: () => void | Promise<unknown>;
-/**
- * Forces a targeting check.
- *
- * @example
- * ```ts
- * import * as Screeb from "@screeb/sdk-browser";
- *
- * Screeb.targetingCheck();
- * ```
- */
-export declare const targetingCheck: () => void | Promise<unknown>;
 /**
  * Prints the current state of the targeting engine.
  *

package/dist/cjs/types.d.ts

@@ -4,6 +4,28 @@ export type PropertyType = number | boolean | string | Date | PropertyRecord;
 export type PropertyRecord = {
     [key: string]: PropertyType | PropertyType[];
 };
+/**
+ * Custom collector URLs used to bypass AdBlockers by routing Screeb traffic
+ * through your own domain (reverse proxy).
+ *
+ * Every key is optional: any omitted endpoint falls back to Screeb's default
+ * URL. All endpoints must use `https://` (or `wss://` for the WebSocket one),
+ * and the domains must be allow-listed in Screeb Admin → Settings → Custom Domains.
+ *
+ * @see https://developers.screeb.app/sdk-js/custom-collector-url
+ */
+export type ScreebEndpoints = {
+    /** REST API (surveys, tracking). Default: `https://rpc.screeb.app/rpc`. */
+    rpc?: string;
+    /** Static assets (images, fonts). Default: `https://static.screeb.app`. */
+    static?: string;
+    /** Response reporting. Default: `https://r.screeb.app/rpc`. */
+    report?: string;
+    /** Hosted survey page. Default: `https://survey.screeb.app`. */
+    hostedPage?: string;
+    /** WebSocket (real-time targeting). Default: `wss://centipede.screeb.app`. */
+    centipede?: string;
+};
 /** This is the Screeb tag options object. */
 export type ScreebOptions = {
     /** If you're running Screeb tag in an iframe, please set the inner window here. */
@@ -14,9 +36,26 @@ export type ScreebOptions = {
     sdkVersion?: string;
     /** Please don't do this. */
     screebEndpoint?: string;
+    /**
+     * Override Screeb's collector URLs to route traffic through your own domain
+     * (custom domains / AdBlocker bypass). Only the endpoints you provide are
+     * overridden; the rest fall back to Screeb's defaults.
+     *
+     * @see https://developers.screeb.app/sdk-js/custom-collector-url
+     */
+    endpoints?: ScreebEndpoints;
     /** @hidden Use a specific platform */
     platform?: string;
 };
+/**
+ * Host-provided navigation handler for the `in-page-spa` "Navigate to URL"
+ * target. It runs in your page (where your SPA router lives) instead of the tag
+ * doing a `history.pushState` + `popstate` dispatch itself. Provide this when
+ * your router does not resync on `popstate` (most React Router / Vue Router /
+ * Angular Router setups do, so this is only needed for custom routers). May be
+ * async so `onButtonNavigateCompleted` can await the route change.
+ */
+export type SpaNavigationHandler = (url: string) => void | Promise<void>;
 export type ScreebFunction = (..._: unknown[]) => void | Promise<unknown>;
 /** This is the Screeb object publicly exposed in browser `window`. */
 export type ScreebObject = ScreebFunction & {

package/dist/es/hooks.types.d.ts

@@ -114,6 +114,24 @@ export type HookOnQuestionReplied = (data: HookCommonPropertiesSurvey & {
         items: ResponseItem[];
     };
 }) => void;
+export type HookOnButtonNavigateStarted = (data: HookCommonPropertiesSurvey & {
+    response: {
+        id: string;
+    };
+    button: {
+        url: string;
+        url_target?: string;
+    };
+}) => void;
+export type HookOnButtonNavigateCompleted = (data: HookCommonPropertiesSurvey & {
+    response: {
+        id: string;
+    };
+    button: {
+        url: string;
+        url_target?: string;
+    };
+}) => void;
 /** This is the Screeb tag hooks object available on `survey.start` command. */
 export type HooksSurveyStart = {
     /** This hook is triggered when a survey is displayed on screen (also triggered when page is reloaded) */
@@ -126,6 +144,10 @@ export type HooksSurveyStart = {
     onSurveyHidden?: HookOnSurveyHidden;
     /** This hook is triggered when a question is answered */
     onQuestionReplied?: HookOnQuestionReplied;
+    /** This hook is triggered before a message/tour button "Navigate to URL" action runs. */
+    onButtonNavigateStarted?: HookOnButtonNavigateStarted;
+    /** This hook is triggered after a message/tour button "Navigate to URL" action ran (only fires when the SDK survives the navigation, e.g. `new-tab` or `in-page-spa`). */
+    onButtonNavigateCompleted?: HookOnButtonNavigateCompleted;
 };
 /** This is the Screeb tag hooks object available on `message.start` command. */
 export type HooksMessageStart = {
@@ -139,6 +161,10 @@ export type HooksMessageStart = {
     onMessageHidden?: HookOnMessageHidden;
     /** This hook is triggered when a question is answered */
     onQuestionReplied?: HookOnQuestionReplied;
+    /** This hook is triggered before a message/tour button "Navigate to URL" action runs. */
+    onButtonNavigateStarted?: HookOnButtonNavigateStarted;
+    /** This hook is triggered after a message/tour button "Navigate to URL" action ran (only fires when the SDK survives the navigation, e.g. `new-tab` or `in-page-spa`). */
+    onButtonNavigateCompleted?: HookOnButtonNavigateCompleted;
 };
 /** This is the Screeb tag hooks object available on `init` command. */
 export type HooksInit = HooksSurveyStart & HooksMessageStart & {

package/dist/es/index.d.ts

@@ -1,5 +1,5 @@
 import { HooksInit, HooksMessageStart, HooksSurveyStart } from "./hooks.types";
-import { PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "./types";
+import { PropertyRecord, ScreebIdentityGetReturn, ScreebOptions, SpaNavigationHandler } from "./types";
 export * from "./types";
 export * from "./hooks.types";
 /**
@@ -8,6 +8,8 @@ export * from "./hooks.types";
  * @param options Screeb module options.
  * @param options.window If you're running Screeb tag in an iframe, please set the inner window here.
  * @param options.screebEndpoint Please don't do this.
+ * @param options.endpoints Override Screeb's collector URLs to route traffic through your own
+ * domain (custom domains / AdBlocker bypass). Only the endpoints you provide are overridden.
  *
  * @example
  * ```ts
@@ -33,6 +35,11 @@ export declare const load: (options?: ScreebOptions) => Promise<undefined>;
  *
  * @param language Force a specific language for the tag. eg: 'en'. default: browser language.
  *
+ * @param spaNavigationHandler Optional handler for the `in-page-spa` "Navigate to URL"
+ * target. Runs in your page so your SPA router can navigate without a full reload. Only
+ * needed for custom routers that don't resync on `popstate` (React Router / Vue Router /
+ * Angular Router work out of the box). May be async so `onButtonNavigateCompleted` awaits it.
+ *
  * @example
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
@@ -50,12 +57,14 @@ export declare const load: (options?: ScreebOptions) => Promise<undefined>;
  *   {
  *     version: "1.0.0",
  *     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
+ *     onButtonNavigateStarted: (payload) => console.log("Button navigate started", payload),
+ *     onButtonNavigateCompleted: (payload) => console.log("Button navigate completed", payload),
  *   },
  *   "en"
  * );
  * ```
  */
-export declare const init: (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: HooksInit, language?: string) => void | Promise<unknown>;
+export declare const init: (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: HooksInit, language?: string, spaNavigationHandler?: SpaNavigationHandler) => void | Promise<unknown>;
 /**
  * Checks if Screeb tag has been loaded.
  *
@@ -374,17 +383,6 @@ export declare const sessionReplayStop: () => void | Promise<unknown>;
  * ```
  */
 export declare const sessionReplayStart: () => void | Promise<unknown>;
-/**
- * Forces a targeting check.
- *
- * @example
- * ```ts
- * import * as Screeb from "@screeb/sdk-browser";
- *
- * Screeb.targetingCheck();
- * ```
- */
-export declare const targetingCheck: () => void | Promise<unknown>;
 /**
  * Prints the current state of the targeting engine.
  *

package/dist/es/index.mjs

@@ -12,7 +12,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() {
@@ -50,6 +50,8 @@ var callScreebCommand = function () {
  * @param options Screeb module options.
  * @param options.window If you're running Screeb tag in an iframe, please set the inner window here.
  * @param options.screebEndpoint Please don't do this.
+ * @param options.endpoints Override Screeb's collector URLs to route traffic through your own
+ * domain (custom domains / AdBlocker bypass). Only the endpoints you provide are overridden.
  *
  * @example
  * ```ts
@@ -68,8 +70,8 @@ var load = function (options) {
         scriptElement.src = (_b = options.screebEndpoint) !== null && _b !== void 0 ? _b : SCREEB_TAG_ENDPOINT;
         scriptElement.addEventListener("load", function () { return resolve(undefined); });
         scriptElement.addEventListener("error", reject);
-        if (options.platform) {
-            _window["ScreebConfig"] = { platform: options.platform };
+        if (options.platform || options.endpoints) {
+            _window["ScreebConfig"] = __assign(__assign({}, (options.platform ? { platform: options.platform } : {})), (options.endpoints ? { endpoints: options.endpoints } : {}));
         }
         _window.$screeb =
             (_c = _window.$screeb) !== null && _c !== void 0 ? _c : function () {
@@ -114,6 +116,11 @@ var load = function (options) {
  *
  * @param language Force a specific language for the tag. eg: 'en'. default: browser language.
  *
+ * @param spaNavigationHandler Optional handler for the `in-page-spa` "Navigate to URL"
+ * target. Runs in your page so your SPA router can navigate without a full reload. Only
+ * needed for custom routers that don't resync on `popstate` (React Router / Vue Router /
+ * Angular Router work out of the box). May be async so `onButtonNavigateCompleted` awaits it.
+ *
  * @example
  * ```ts
  * import * as Screeb from "@screeb/sdk-browser";
@@ -131,12 +138,14 @@ var load = function (options) {
  *   {
  *     version: "1.0.0",
  *     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
+ *     onButtonNavigateStarted: (payload) => console.log("Button navigate started", payload),
+ *     onButtonNavigateCompleted: (payload) => console.log("Button navigate completed", payload),
  *   },
  *   "en"
  * );
  * ```
  */
-var init = function (websiteId, userId, userProperties, hooks, language) {
+var init = function (websiteId, userId, userProperties, hooks, language, spaNavigationHandler) {
     var identityObject;
     if (userId || userProperties) {
         identityObject = {
@@ -150,6 +159,9 @@ var init = function (websiteId, userId, userProperties, hooks, language) {
     if (language) {
         identityObject = __assign(__assign({}, identityObject), { language: language });
     }
+    if (spaNavigationHandler) {
+        identityObject = __assign(__assign({}, identityObject), { spaNavigationHandler: spaNavigationHandler });
+    }
     return callScreebCommand("init", websiteId, identityObject);
 };
 /**
@@ -504,17 +516,6 @@ var sessionReplayStop = function () { return callScreebCommand("session-replay.s
 var sessionReplayStart = function () {
     return callScreebCommand("session-replay.start");
 };
-/**
- * Forces a targeting check.
- *
- * @example
- * ```ts
- * import * as Screeb from "@screeb/sdk-browser";
- *
- * Screeb.targetingCheck();
- * ```
- */
-var targetingCheck = function () { return callScreebCommand("targeting.check"); };
 /**
  * Prints the current state of the targeting engine.
  *
@@ -541,5 +542,5 @@ var targetingCheck = function () { return callScreebCommand("targeting.check");
  */
 var targetingDebug = function () { return callScreebCommand("targeting.debug"); };
 
-export { close, debug, eventTrack, identity, identityGet, identityGroupAssign, identityGroupUnassign, identityProperties, identityReset, init, isLoaded, load, messageClose, messageStart, sessionReplayStart, sessionReplayStop, surveyClose, surveyStart, targetingCheck, targetingDebug };
-CONSTANTS.version = '0.5.0'
+export { close, debug, eventTrack, identity, identityGet, identityGroupAssign, identityGroupUnassign, identityProperties, identityReset, init, isLoaded, load, messageClose, messageStart, sessionReplayStart, sessionReplayStop, surveyClose, surveyStart, targetingDebug };
+CONSTANTS.version = '0.7.0'

package/dist/es/types.d.ts

@@ -4,6 +4,28 @@ export type PropertyType = number | boolean | string | Date | PropertyRecord;
 export type PropertyRecord = {
     [key: string]: PropertyType | PropertyType[];
 };
+/**
+ * Custom collector URLs used to bypass AdBlockers by routing Screeb traffic
+ * through your own domain (reverse proxy).
+ *
+ * Every key is optional: any omitted endpoint falls back to Screeb's default
+ * URL. All endpoints must use `https://` (or `wss://` for the WebSocket one),
+ * and the domains must be allow-listed in Screeb Admin → Settings → Custom Domains.
+ *
+ * @see https://developers.screeb.app/sdk-js/custom-collector-url
+ */
+export type ScreebEndpoints = {
+    /** REST API (surveys, tracking). Default: `https://rpc.screeb.app/rpc`. */
+    rpc?: string;
+    /** Static assets (images, fonts). Default: `https://static.screeb.app`. */
+    static?: string;
+    /** Response reporting. Default: `https://r.screeb.app/rpc`. */
+    report?: string;
+    /** Hosted survey page. Default: `https://survey.screeb.app`. */
+    hostedPage?: string;
+    /** WebSocket (real-time targeting). Default: `wss://centipede.screeb.app`. */
+    centipede?: string;
+};
 /** This is the Screeb tag options object. */
 export type ScreebOptions = {
     /** If you're running Screeb tag in an iframe, please set the inner window here. */
@@ -14,9 +36,26 @@ export type ScreebOptions = {
     sdkVersion?: string;
     /** Please don't do this. */
     screebEndpoint?: string;
+    /**
+     * Override Screeb's collector URLs to route traffic through your own domain
+     * (custom domains / AdBlocker bypass). Only the endpoints you provide are
+     * overridden; the rest fall back to Screeb's defaults.
+     *
+     * @see https://developers.screeb.app/sdk-js/custom-collector-url
+     */
+    endpoints?: ScreebEndpoints;
     /** @hidden Use a specific platform */
     platform?: string;
 };
+/**
+ * Host-provided navigation handler for the `in-page-spa` "Navigate to URL"
+ * target. It runs in your page (where your SPA router lives) instead of the tag
+ * doing a `history.pushState` + `popstate` dispatch itself. Provide this when
+ * your router does not resync on `popstate` (most React Router / Vue Router /
+ * Angular Router setups do, so this is only needed for custom routers). May be
+ * async so `onButtonNavigateCompleted` can await the route change.
+ */
+export type SpaNavigationHandler = (url: string) => void | Promise<void>;
 export type ScreebFunction = (..._: unknown[]) => void | Promise<unknown>;
 /** This is the Screeb object publicly exposed in browser `window`. */
 export type ScreebObject = ScreebFunction & {

package/docs/README.md

@@ -11,6 +11,8 @@
 - [HookCommonProperties](README.md#hookcommonproperties)
 - [HookCommonPropertiesMessage](README.md#hookcommonpropertiesmessage)
 - [HookCommonPropertiesSurvey](README.md#hookcommonpropertiessurvey)
+- [HookOnButtonNavigateCompleted](README.md#hookonbuttonnavigatecompleted)
+- [HookOnButtonNavigateStarted](README.md#hookonbuttonnavigatestarted)
 - [HookOnMessageCompleted](README.md#hookonmessagecompleted)
 - [HookOnMessageDisplayAllowed](README.md#hookonmessagedisplayallowed)
 - [HookOnMessageHidden](README.md#hookonmessagehidden)
@@ -33,10 +35,12 @@
 - [ResponseItemAnswer](README.md#responseitemanswer)
 - [ResponseItemQuestion](README.md#responseitemquestion)
 - [ResponseStatus](README.md#responsestatus)
+- [ScreebEndpoints](README.md#screebendpoints)
 - [ScreebFunction](README.md#screebfunction)
 - [ScreebIdentityGetReturn](README.md#screebidentitygetreturn)
 - [ScreebObject](README.md#screebobject)
 - [ScreebOptions](README.md#screeboptions)
+- [SpaNavigationHandler](README.md#spanavigationhandler)
 - [Survey](README.md#survey)
 - [SurveyFormat](README.md#surveyformat)
 - [SurveyPosition](README.md#surveyposition)
@@ -63,7 +67,6 @@
 - [sessionReplayStop](README.md#sessionreplaystop)
 - [surveyClose](README.md#surveyclose)
 - [surveyStart](README.md#surveystart)
-- [targetingCheck](README.md#targetingcheck)
 - [targetingDebug](README.md#targetingdebug)
 
 ## Type Aliases
@@ -112,6 +115,46 @@ ___
 
 ___
 
+### HookOnButtonNavigateCompleted
+
+Ƭ **HookOnButtonNavigateCompleted**: (`data`: [`HookCommonPropertiesSurvey`](README.md#hookcommonpropertiessurvey) & \{ `button`: \{ `url`: `string` ; `url_target?`: `string`  } ; `response`: \{ `id`: `string`  }  }) => `void`
+
+#### Type declaration
+
+▸ (`data`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`HookCommonPropertiesSurvey`](README.md#hookcommonpropertiessurvey) & \{ `button`: \{ `url`: `string` ; `url_target?`: `string`  } ; `response`: \{ `id`: `string`  }  } |
+
+##### Returns
+
+`void`
+
+___
+
+### HookOnButtonNavigateStarted
+
+Ƭ **HookOnButtonNavigateStarted**: (`data`: [`HookCommonPropertiesSurvey`](README.md#hookcommonpropertiessurvey) & \{ `button`: \{ `url`: `string` ; `url_target?`: `string`  } ; `response`: \{ `id`: `string`  }  }) => `void`
+
+#### Type declaration
+
+▸ (`data`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`HookCommonPropertiesSurvey`](README.md#hookcommonpropertiessurvey) & \{ `button`: \{ `url`: `string` ; `url_target?`: `string`  } ; `response`: \{ `id`: `string`  }  } |
+
+##### Returns
+
+`void`
+
+___
+
 ### HookOnMessageCompleted
 
 Ƭ **HookOnMessageCompleted**: (`data`: [`HookCommonPropertiesMessage`](README.md#hookcommonpropertiesmessage) & \{ `response`: \{ `id`: `string` ; `items`: [`ResponseItem`](README.md#responseitem)[]  }  }) => `void`
@@ -372,6 +415,8 @@ This is the Screeb tag hooks object available on `message.start` command.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
+| `onButtonNavigateCompleted?` | [`HookOnButtonNavigateCompleted`](README.md#hookonbuttonnavigatecompleted) | This hook is triggered after a message/tour button "Navigate to URL" action ran (only fires when the SDK survives the navigation, e.g. `new-tab` or `in-page-spa`). |
+| `onButtonNavigateStarted?` | [`HookOnButtonNavigateStarted`](README.md#hookonbuttonnavigatestarted) | This hook is triggered before a message/tour button "Navigate to URL" action runs. |
 | `onMessageCompleted?` | [`HookOnMessageCompleted`](README.md#hookonmessagecompleted) | This hook is triggered when a message is completed |
 | `onMessageHidden?` | [`HookOnMessageHidden`](README.md#hookonmessagehidden) | This hook is triggered when a message is hidden |
 | `onMessageShowed?` | [`HookOnMessageShowed`](README.md#hookonmessageshowed) | This hook is triggered when a message is displayed on screen (also triggered when page is reloaded) |
@@ -390,6 +435,8 @@ This is the Screeb tag hooks object available on `survey.start` command.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
+| `onButtonNavigateCompleted?` | [`HookOnButtonNavigateCompleted`](README.md#hookonbuttonnavigatecompleted) | This hook is triggered after a message/tour button "Navigate to URL" action ran (only fires when the SDK survives the navigation, e.g. `new-tab` or `in-page-spa`). |
+| `onButtonNavigateStarted?` | [`HookOnButtonNavigateStarted`](README.md#hookonbuttonnavigatestarted) | This hook is triggered before a message/tour button "Navigate to URL" action runs. |
 | `onQuestionReplied?` | [`HookOnQuestionReplied`](README.md#hookonquestionreplied) | This hook is triggered when a question is answered |
 | `onSurveyCompleted?` | [`HookOnSurveyCompleted`](README.md#hookonsurveycompleted) | This hook is triggered when a survey is completed |
 | `onSurveyHidden?` | [`HookOnSurveyHidden`](README.md#hookonsurveyhidden) | This hook is triggered when a survey is hidden |
@@ -478,6 +525,33 @@ ___
 
 ___
 
+### ScreebEndpoints
+
+Ƭ **ScreebEndpoints**: `Object`
+
+Custom collector URLs used to bypass AdBlockers by routing Screeb traffic
+through your own domain (reverse proxy).
+
+Every key is optional: any omitted endpoint falls back to Screeb's default
+URL. All endpoints must use `https://` (or `wss://` for the WebSocket one),
+and the domains must be allow-listed in Screeb Admin → Settings → Custom Domains.
+
+**`See`**
+
+https://developers.screeb.app/sdk-js/custom-collector-url
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `centipede?` | `string` | WebSocket (real-time targeting). Default: `wss://centipede.screeb.app`. |
+| `hostedPage?` | `string` | Hosted survey page. Default: `https://survey.screeb.app`. |
+| `report?` | `string` | Response reporting. Default: `https://r.screeb.app/rpc`. |
+| `rpc?` | `string` | REST API (surveys, tracking). Default: `https://rpc.screeb.app/rpc`. |
+| `static?` | `string` | Static assets (images, fonts). Default: `https://static.screeb.app`. |
+
+___
+
 ### ScreebFunction
 
 Ƭ **ScreebFunction**: (...`_`: `unknown`[]) => `void` \| `Promise`\<`unknown`\>
@@ -536,6 +610,7 @@ This is the Screeb tag options object.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
+| `endpoints?` | [`ScreebEndpoints`](README.md#screebendpoints) | Override Screeb's collector URLs to route traffic through your own domain (custom domains / AdBlocker bypass). Only the endpoints you provide are overridden; the rest fall back to Screeb's defaults. **`See`** https://developers.screeb.app/sdk-js/custom-collector-url |
 | `screebEndpoint?` | `string` | Please don't do this. |
 | `sdkName?` | `string` | SDK name (eg: sdk-browser, sdk-react, sdk-angular, etc...) |
 | `sdkVersion?` | `string` | SDK version (eg: 1.2.3) |
@@ -543,6 +618,33 @@ This is the Screeb tag options object.
 
 ___
 
+### SpaNavigationHandler
+
+Ƭ **SpaNavigationHandler**: (`url`: `string`) => `void` \| `Promise`\<`void`\>
+
+Host-provided navigation handler for the `in-page-spa` "Navigate to URL"
+target. It runs in your page (where your SPA router lives) instead of the tag
+doing a `history.pushState` + `popstate` dispatch itself. Provide this when
+your router does not resync on `popstate` (most React Router / Vue Router /
+Angular Router setups do, so this is only needed for custom routers). May be
+async so `onButtonNavigateCompleted` can await the route change.
+
+#### Type declaration
+
+▸ (`url`): `void` \| `Promise`\<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+
+##### Returns
+
+`void` \| `Promise`\<`void`\>
+
+___
+
 ### Survey
 
 Ƭ **Survey**: `Object`
@@ -885,7 +987,7 @@ ___
 
 ### init
 
-▸ **init**(`websiteId`, `userId?`, `userProperties?`, `hooks?`, `language?`): `void` \| `Promise`\<`unknown`\>
+▸ **init**(`websiteId`, `userId?`, `userProperties?`, `hooks?`, `language?`, `spaNavigationHandler?`): `void` \| `Promise`\<`unknown`\>
 
 Initializes Screeb tag.
 
@@ -898,6 +1000,7 @@ Initializes Screeb tag.
 | `userProperties?` | [`PropertyRecord`](README.md#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`](README.md#hooksinit) | Hooks to be called when SDK is ready or a survey is showed, started, completed, hidden or when a question is replied. |
 | `language?` | `string` | Force a specific language for the tag. eg: 'en'. default: browser language. |
+| `spaNavigationHandler?` | [`SpaNavigationHandler`](README.md#spanavigationhandler) | Optional handler for the `in-page-spa` "Navigate to URL" target. Runs in your page so your SPA router can navigate without a full reload. Only needed for custom routers that don't resync on `popstate` (React Router / Vue Router / Angular Router work out of the box). May be async so `onButtonNavigateCompleted` awaits it. |
 
 #### Returns
 
@@ -921,6 +1024,8 @@ Screeb.init(
   {
     version: "1.0.0",
     onReady: (payload) =>  console.log("Screeb SDK is ready!", payload),
+    onButtonNavigateStarted: (payload) => console.log("Button navigate started", payload),
+    onButtonNavigateCompleted: (payload) => console.log("Button navigate completed", payload),
   },
   "en"
 );
@@ -1144,26 +1249,6 @@ Screeb.surveyStart(
 
 ___
 
-### targetingCheck
-
-▸ **targetingCheck**(): `void` \| `Promise`\<`unknown`\>
-
-Forces a targeting check.
-
-#### Returns
-
-`void` \| `Promise`\<`unknown`\>
-
-**`Example`**
-
-```ts
-import * as Screeb from "@screeb/sdk-browser";
-
-Screeb.targetingCheck();
-```
-
-___
-
 ### targetingDebug
 
 ▸ **targetingDebug**(): `void` \| `Promise`\<`unknown`\>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-browser",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Screeb's browser sdk.",
   "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-browser"
+    "url": "https://github.com/ScreebApp/sdk.git",
+    "directory": "packages/sdk-browser"
   },
   "license": "MIT",
   "author": "Screeb's frontend team",
@@ -41,21 +41,21 @@
     "test": "echo 'test disabled'"
   },
   "devDependencies": {
-    "@screeb/eslint-config": "^0.1.6",
-    "@screeb/typescript-config": "^0.1.10",
-    "@types/jest": "^29.5.5",
-    "@types/node": "^20.8.4",
+    "@screeb/eslint-config": "^0.1.8",
+    "@screeb/typescript-config": "^0.1.13",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.8.10",
     "@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",
     "jest-environment-jsdom": "^29.7.0",
     "prettier": "^3.0.3",
     "rollup": "^4.0.2",
-    "ts-jest": "^29.1.1",
+    "ts-jest": "^29.1.5",
     "typedoc": "^0.25.2",
     "typedoc-plugin-markdown": "^3.16.0"
   },