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

package/dist/cjs/index.cjs

@@ -38,7 +38,7 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
 
 
 var __assign = function() {
@@ -75,8 +75,8 @@ function __awaiter(thisArg, _arguments, P, generator) {
 }
 
 function __generator(thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
@@ -102,6 +102,16 @@ function __generator(thisArg, body) {
     }
 }
 
+function __spreadArray(to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+}
+
 typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
     var e = new Error(message);
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
@@ -154,10 +164,10 @@ var ScreebProvider = function (_a) {
     }
     var ensureScreeb = React__namespace.useCallback(
     // eslint-disable-next-line no-unused-vars
-    function (functionName, callback, onlyLoaded) {
-        if (onlyLoaded === void 0) { onlyLoaded = false; }
-        return __awaiter(this, void 0, void 0, function () {
+    function (functionName_1, callback_1) {
+        return __awaiter(this, arguments, void 0, function (functionName, callback, onlyLoaded) {
             var message, message;
+            if (onlyLoaded === void 0) { onlyLoaded = false; }
             return __generator(this, function (_a) {
                 if (!Screeb__namespace.isLoaded() && !shouldLoad) {
                     message = "Screeb instance is not loaded because `shouldLoad` is set to `false` in `ScreebProvider`";
@@ -302,11 +312,11 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var surveyStart = React__namespace.useCallback(function (surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language) { return __awaiter(void 0, void 0, void 0, function () {
+    var surveyStart = React__namespace.useCallback(function (surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language, selectors) { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, ensureScreeb("surveyStart", function () {
-                        return Screeb__namespace.surveyStart(surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language);
+                        return Screeb__namespace.surveyStart(surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language, selectors);
                     })];
                 case 1: return [2 /*return*/, _a.sent()];
             }
@@ -318,9 +328,13 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var messageStart = React__namespace.useCallback(function (messageId, allowMultipleResponses, hiddenFields, hooks, language) {
-        if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
-        return __awaiter(void 0, void 0, void 0, function () {
+    var messageStart = React__namespace.useCallback(function (messageId_1) {
+        var args_1 = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args_1[_i - 1] = arguments[_i];
+        }
+        return __awaiter(void 0, __spreadArray([messageId_1], args_1, true), void 0, function (messageId, allowMultipleResponses, hiddenFields, hooks, language) {
+            if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, ensureScreeb("messageStart", function () {
@@ -435,4 +449,4 @@ var useScreeb = function () {
 
 exports.ScreebProvider = ScreebProvider;
 exports.useScreeb = useScreeb;
-CONSTANTS.version = '0.5.0'
+CONSTANTS.version = '0.7.1'

package/dist/cjs/types.d.ts

@@ -294,14 +294,20 @@ export type SurveyCloseFunction = () => Promise<unknown>;
  *   '<UUID>',
  *   '<UUID>',
  *   false,
- *   {
+ *   { // optional
  *     color: "green",
  *     article_id: 42
- *   }
+ *   },
+ *   { // optional
+ *     version: "1.0.0",
+ *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
+ *   },
+ *   "en", // optional
+ *   "#screeb-survey-container" // optional
  * );
  * ```
  */
-export type SurveyStartFunction = (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string) => Promise<unknown>;
+export type SurveyStartFunction = (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string, selectors?: string | string[]) => Promise<unknown>;
 /**
  * Interrupts a running message.
  *

package/dist/es/index.mjs

@@ -16,7 +16,7 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
 
 
 var __assign = function() {
@@ -53,8 +53,8 @@ function __awaiter(thisArg, _arguments, P, generator) {
 }
 
 function __generator(thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
@@ -80,6 +80,16 @@ function __generator(thisArg, body) {
     }
 }
 
+function __spreadArray(to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+}
+
 typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
     var e = new Error(message);
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
@@ -132,10 +142,10 @@ var ScreebProvider = function (_a) {
     }
     var ensureScreeb = React.useCallback(
     // eslint-disable-next-line no-unused-vars
-    function (functionName, callback, onlyLoaded) {
-        if (onlyLoaded === void 0) { onlyLoaded = false; }
-        return __awaiter(this, void 0, void 0, function () {
+    function (functionName_1, callback_1) {
+        return __awaiter(this, arguments, void 0, function (functionName, callback, onlyLoaded) {
             var message, message;
+            if (onlyLoaded === void 0) { onlyLoaded = false; }
             return __generator(this, function (_a) {
                 if (!Screeb.isLoaded() && !shouldLoad) {
                     message = "Screeb instance is not loaded because `shouldLoad` is set to `false` in `ScreebProvider`";
@@ -280,11 +290,11 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var surveyStart = React.useCallback(function (surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language) { return __awaiter(void 0, void 0, void 0, function () {
+    var surveyStart = React.useCallback(function (surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language, selectors) { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, ensureScreeb("surveyStart", function () {
-                        return Screeb.surveyStart(surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language);
+                        return Screeb.surveyStart(surveyId, distributionId, allowMultipleResponses, hiddenFields, hooks, language, selectors);
                     })];
                 case 1: return [2 /*return*/, _a.sent()];
             }
@@ -296,9 +306,13 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var messageStart = React.useCallback(function (messageId, allowMultipleResponses, hiddenFields, hooks, language) {
-        if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
-        return __awaiter(void 0, void 0, void 0, function () {
+    var messageStart = React.useCallback(function (messageId_1) {
+        var args_1 = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args_1[_i - 1] = arguments[_i];
+        }
+        return __awaiter(void 0, __spreadArray([messageId_1], args_1, true), void 0, function (messageId, allowMultipleResponses, hiddenFields, hooks, language) {
+            if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, ensureScreeb("messageStart", function () {
@@ -412,4 +426,4 @@ var useScreeb = function () {
 };
 
 export { ScreebProvider, useScreeb };
-CONSTANTS.version = '0.5.0'
+CONSTANTS.version = '0.7.1'

package/dist/es/types.d.ts

@@ -294,14 +294,20 @@ export type SurveyCloseFunction = () => Promise<unknown>;
  *   '<UUID>',
  *   '<UUID>',
  *   false,
- *   {
+ *   { // optional
  *     color: "green",
  *     article_id: 42
- *   }
+ *   },
+ *   { // optional
+ *     version: "1.0.0",
+ *     onSurveyShowed: (payload) => console.log("Survey showed", payload),
+ *   },
+ *   "en", // optional
+ *   "#screeb-survey-container" // optional
  * );
  * ```
  */
-export type SurveyStartFunction = (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string) => Promise<unknown>;
+export type SurveyStartFunction = (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string, selectors?: string | string[]) => Promise<unknown>;
 /**
  * Interrupts a running message.
  *

package/docs/README.md

@@ -638,7 +638,7 @@ ___
 
 ### SurveyStartFunction
 
-Ƭ **SurveyStartFunction**: (`surveyId`: `string`, `distributionId?`: `string`, `allowMultipleResponses?`: `boolean`, `hiddenFields?`: `PropertyRecord`, `hooks?`: `HooksSurveyStart`, `language?`: `string`) => `Promise`\<`unknown`\>
+Ƭ **SurveyStartFunction**: (`surveyId`: `string`, `distributionId?`: `string`, `allowMultipleResponses?`: `boolean`, `hiddenFields?`: `PropertyRecord`, `hooks?`: `HooksSurveyStart`, `language?`: `string`, `selectors?`: `string` \| `string`[]) => `Promise`\<`unknown`\>
 
 Starts a survey by its ID.
 
@@ -651,16 +651,22 @@ surveyStart(
   '<UUID>',
   '<UUID>',
   false,
-  {
+  { // optional
     color: "green",
     article_id: 42
-  }
+  },
+  { // optional
+    version: "1.0.0",
+    onSurveyShowed: (payload) => console.log("Survey showed", payload),
+  },
+  "en", // optional
+  "#screeb-survey-container" // optional
 );
 ```
 
 #### Type declaration
 
-▸ (`surveyId`, `distributionId?`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `language?`): `Promise`\<`unknown`\>
+▸ (`surveyId`, `distributionId?`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `language?`, `selectors?`): `Promise`\<`unknown`\>
 
 ##### Parameters
 
@@ -672,6 +678,7 @@ surveyStart(
 | `hiddenFields?` | `PropertyRecord` |
 | `hooks?` | `HooksSurveyStart` |
 | `language?` | `string` |
+| `selectors?` | `string` \| `string`[] |
 
 ##### Returns
 

package/package.json

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