@screeb/sdk-browser 0.4.0 → 0.6.1

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/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 () {
@@ -414,27 +416,29 @@ var surveyClose = function () { return callScreebCommand("survey.close"); };
  *   '<UUID>',
  *   '<UUID>',
  *   false,
- *   {
+ *   { // optional
  *     color: "green",
  *     article_id: 42
  *   },
- *   {
+ *   { // optional
  *     version: "1.0.0",
  *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
  *   },
- *   "en"
+ *   "en", // optional
+ *   "#screeb-survey-container" // optional
  * );
  * ```
  */
-var surveyStart = function (surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language) {
+var surveyStart = function (surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language, selectors) {
     if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
     if (hiddenFields === void 0) { hiddenFields = {}; }
     return callScreebCommand("survey.start", surveyId, {
-        distribution_id: distributionId,
         allow_multiple_responses: allowMultipleResponses,
-        language: language,
+        distribution_id: distributionId,
         hidden_fields: hiddenFields,
         hooks: hooks,
+        language: language,
+        selectors: selectors,
     });
 };
 /**
@@ -561,4 +565,4 @@ exports.surveyClose = surveyClose;
 exports.surveyStart = surveyStart;
 exports.targetingCheck = targetingCheck;
 exports.targetingDebug = targetingDebug;
-CONSTANTS.version = '0.4.0'
+CONSTANTS.version = '0.6.1'

package/dist/cjs/index.d.ts

@@ -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
@@ -304,19 +306,20 @@ export declare const surveyClose: () => void | Promise<unknown>;
  *   '<UUID>',
  *   '<UUID>',
  *   false,
- *   {
+ *   { // optional
  *     color: "green",
  *     article_id: 42
  *   },
- *   {
+ *   { // optional
  *     version: "1.0.0",
  *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
  *   },
- *   "en"
+ *   "en", // optional
+ *   "#screeb-survey-container" // optional
  * );
  * ```
  */
-export declare const surveyStart: (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string) => void | Promise<unknown>;
+export declare const surveyStart: (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string, selectors?: string | string[]) => void | Promise<unknown>;
 /**
  * Interrupts a running message.
  *

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,6 +36,14 @@ 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;
 };

package/dist/es/index.d.ts

@@ -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
@@ -304,19 +306,20 @@ export declare const surveyClose: () => void | Promise<unknown>;
  *   '<UUID>',
  *   '<UUID>',
  *   false,
- *   {
+ *   { // optional
  *     color: "green",
  *     article_id: 42
  *   },
- *   {
+ *   { // optional
  *     version: "1.0.0",
  *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
  *   },
- *   "en"
+ *   "en", // optional
+ *   "#screeb-survey-container" // optional
  * );
  * ```
  */
-export declare const surveyStart: (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string) => void | Promise<unknown>;
+export declare const surveyStart: (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string, selectors?: string | string[]) => void | Promise<unknown>;
 /**
  * Interrupts a running message.
  *

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 () {
@@ -412,27 +414,29 @@ var surveyClose = function () { return callScreebCommand("survey.close"); };
  *   '<UUID>',
  *   '<UUID>',
  *   false,
- *   {
+ *   { // optional
  *     color: "green",
  *     article_id: 42
  *   },
- *   {
+ *   { // optional
  *     version: "1.0.0",
  *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
  *   },
- *   "en"
+ *   "en", // optional
+ *   "#screeb-survey-container" // optional
  * );
  * ```
  */
-var surveyStart = function (surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language) {
+var surveyStart = function (surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language, selectors) {
     if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
     if (hiddenFields === void 0) { hiddenFields = {}; }
     return callScreebCommand("survey.start", surveyId, {
-        distribution_id: distributionId,
         allow_multiple_responses: allowMultipleResponses,
-        language: language,
+        distribution_id: distributionId,
         hidden_fields: hiddenFields,
         hooks: hooks,
+        language: language,
+        selectors: selectors,
     });
 };
 /**
@@ -540,4 +544,4 @@ 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.4.0'
+CONSTANTS.version = '0.6.1'

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,6 +36,14 @@ 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;
 };

package/docs/README.md

@@ -33,6 +33,7 @@
 - [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)
@@ -478,6 +479,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 +564,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) |
@@ -1100,7 +1129,7 @@ ___
 
 ### surveyStart
 
-▸ **surveyStart**(`surveyId`, `distributionId?`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `language?`): `void` \| `Promise`\<`unknown`\>
+▸ **surveyStart**(`surveyId`, `distributionId?`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `language?`, `selectors?`): `void` \| `Promise`\<`unknown`\>
 
 Starts a survey by its ID.
 
@@ -1114,6 +1143,7 @@ Starts a survey by its ID.
 | `hiddenFields` | [`PropertyRecord`](README.md#propertyrecord) | `{}` |
 | `hooks?` | [`HooksSurveyStart`](README.md#hookssurveystart) | `undefined` |
 | `language?` | `string` | `undefined` |
+| `selectors?` | `string` \| `string`[] | `undefined` |
 
 #### Returns
 
@@ -1128,15 +1158,16 @@ Screeb.surveyStart(
   '<UUID>',
   '<UUID>',
   false,
-  {
+  { // optional
     color: "green",
     article_id: 42
   },
-  {
+  { // optional
     version: "1.0.0",
     onSurveyShowed: (payload) => console.log("Survey showed", payload),
   },
-  "en"
+  "en", // optional
+  "#screeb-survey-container" // optional
 );
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-browser",
-  "version": "0.4.0",
+  "version": "0.6.1",
   "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.7",
+    "@screeb/typescript-config": "^0.1.12",
+    "@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"
   },