@screeb/sdk-react 0.4.0 → 0.6.0

package/dist/cjs/index.cjs

@@ -302,11 +302,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()];
             }
@@ -331,6 +331,22 @@ var ScreebProvider = function (_a) {
             });
         });
     }, []);
+    var sessionReplayStop = React__namespace.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, ensureScreeb("sessionReplayStop", function () { return Screeb__namespace.sessionReplayStop(); })];
+            case 1: return [2 /*return*/, _a.sent()];
+        }
+    }); }); }, []);
+    var sessionReplayStart = React__namespace.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, ensureScreeb("sessionReplayStart", function () {
+                        return Screeb__namespace.sessionReplayStart();
+                    })];
+                case 1: return [2 /*return*/, _a.sent()];
+            }
+        });
+    }); }, []);
     var targetingCheck = React__namespace.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
         switch (_a.label) {
             case 0: return [4 /*yield*/, ensureScreeb("targetingCheck", function () { return Screeb__namespace.targetingCheck(); })];
@@ -374,6 +390,8 @@ var ScreebProvider = function (_a) {
         surveyStart: surveyStart,
         messageClose: messageClose,
         messageStart: messageStart,
+        sessionReplayStop: sessionReplayStop,
+        sessionReplayStart: sessionReplayStart,
         targetingCheck: targetingCheck,
         targetingDebug: targetingDebug,
     }); }, [
@@ -392,6 +410,8 @@ var ScreebProvider = function (_a) {
         surveyStart,
         messageClose,
         messageStart,
+        sessionReplayStop,
+        sessionReplayStart,
         targetingCheck,
         targetingDebug,
     ]);
@@ -415,4 +435,4 @@ var useScreeb = function () {
 
 exports.ScreebProvider = ScreebProvider;
 exports.useScreeb = useScreeb;
-CONSTANTS.version = '0.4.0'
+CONSTANTS.version = '0.6.0'

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.
  *
@@ -331,6 +337,28 @@ export type MessageCloseFunction = () => Promise<unknown>;
  * ```
  */
 export type MessageStartFunction = (messageId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksMessageStart, language?: string) => Promise<unknown>;
+/**
+ * Interrupts a running session replay.
+ *
+ * @example
+ * ```ts
+ * const { sessionReplayStop } = useScreeb();
+ *
+ * sessionReplayStop();
+ * ```
+ */
+export type SessionReplayStopFunction = () => Promise<unknown>;
+/**
+ * Starts a session replay.
+ *
+ * @example
+ * ```ts
+ * const { sessionReplayStart } = useScreeb();
+ *
+ * sessionReplayStart();
+ * ```
+ */
+export type SessionReplayStartFunction = () => Promise<unknown>;
 /**
  * Forces a targeting check.
  *
@@ -384,6 +412,8 @@ export type ScreebContextValues = {
     surveyStart: SurveyStartFunction;
     messageClose: MessageCloseFunction;
     messageStart: MessageStartFunction;
+    sessionReplayStart: SessionReplayStartFunction;
+    sessionReplayStop: SessionReplayStopFunction;
     targetingCheck: TargetingCheckFunction;
     targetingDebug: TargetingDebugFunction;
 };

package/dist/es/index.mjs

@@ -280,11 +280,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()];
             }
@@ -309,6 +309,22 @@ var ScreebProvider = function (_a) {
             });
         });
     }, []);
+    var sessionReplayStop = React.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, ensureScreeb("sessionReplayStop", function () { return Screeb.sessionReplayStop(); })];
+            case 1: return [2 /*return*/, _a.sent()];
+        }
+    }); }); }, []);
+    var sessionReplayStart = React.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, ensureScreeb("sessionReplayStart", function () {
+                        return Screeb.sessionReplayStart();
+                    })];
+                case 1: return [2 /*return*/, _a.sent()];
+            }
+        });
+    }); }, []);
     var targetingCheck = React.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
         switch (_a.label) {
             case 0: return [4 /*yield*/, ensureScreeb("targetingCheck", function () { return Screeb.targetingCheck(); })];
@@ -352,6 +368,8 @@ var ScreebProvider = function (_a) {
         surveyStart: surveyStart,
         messageClose: messageClose,
         messageStart: messageStart,
+        sessionReplayStop: sessionReplayStop,
+        sessionReplayStart: sessionReplayStart,
         targetingCheck: targetingCheck,
         targetingDebug: targetingDebug,
     }); }, [
@@ -370,6 +388,8 @@ var ScreebProvider = function (_a) {
         surveyStart,
         messageClose,
         messageStart,
+        sessionReplayStop,
+        sessionReplayStart,
         targetingCheck,
         targetingDebug,
     ]);
@@ -392,4 +412,4 @@ var useScreeb = function () {
 };
 
 export { ScreebProvider, useScreeb };
-CONSTANTS.version = '0.4.0'
+CONSTANTS.version = '0.6.0'

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.
  *
@@ -331,6 +337,28 @@ export type MessageCloseFunction = () => Promise<unknown>;
  * ```
  */
 export type MessageStartFunction = (messageId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksMessageStart, language?: string) => Promise<unknown>;
+/**
+ * Interrupts a running session replay.
+ *
+ * @example
+ * ```ts
+ * const { sessionReplayStop } = useScreeb();
+ *
+ * sessionReplayStop();
+ * ```
+ */
+export type SessionReplayStopFunction = () => Promise<unknown>;
+/**
+ * Starts a session replay.
+ *
+ * @example
+ * ```ts
+ * const { sessionReplayStart } = useScreeb();
+ *
+ * sessionReplayStart();
+ * ```
+ */
+export type SessionReplayStartFunction = () => Promise<unknown>;
 /**
  * Forces a targeting check.
  *
@@ -384,6 +412,8 @@ export type ScreebContextValues = {
     surveyStart: SurveyStartFunction;
     messageClose: MessageCloseFunction;
     messageStart: MessageStartFunction;
+    sessionReplayStart: SessionReplayStartFunction;
+    sessionReplayStop: SessionReplayStopFunction;
     targetingCheck: TargetingCheckFunction;
     targetingDebug: TargetingDebugFunction;
 };

package/docs/README.md

@@ -22,6 +22,8 @@
 - [ScreebContextValues](README.md#screebcontextvalues)
 - [ScreebProps](README.md#screebprops)
 - [ScreebProviderProps](README.md#screebproviderprops)
+- [SessionReplayStartFunction](README.md#sessionreplaystartfunction)
+- [SessionReplayStopFunction](README.md#sessionreplaystopfunction)
 - [SurveyCloseFunction](README.md#surveyclosefunction)
 - [SurveyStartFunction](README.md#surveystartfunction)
 - [TargetingCheckFunction](README.md#targetingcheckfunction)
@@ -527,6 +529,8 @@ Screeb context API
 | `load` | [`LoadFunction`](README.md#loadfunction) |
 | `messageClose` | [`MessageCloseFunction`](README.md#messageclosefunction) |
 | `messageStart` | [`MessageStartFunction`](README.md#messagestartfunction) |
+| `sessionReplayStart` | [`SessionReplayStartFunction`](README.md#sessionreplaystartfunction) |
+| `sessionReplayStop` | [`SessionReplayStopFunction`](README.md#sessionreplaystopfunction) |
 | `surveyClose` | [`SurveyCloseFunction`](README.md#surveyclosefunction) |
 | `surveyStart` | [`SurveyStartFunction`](README.md#surveystartfunction) |
 | `targetingCheck` | [`TargetingCheckFunction`](README.md#targetingcheckfunction) |
@@ -560,6 +564,54 @@ Properties of Screeb provider
 
 ___
 
+### SessionReplayStartFunction
+
+Ƭ **SessionReplayStartFunction**: () => `Promise`\<`unknown`\>
+
+Starts a session replay.
+
+**`Example`**
+
+```ts
+const { sessionReplayStart } = useScreeb();
+
+sessionReplayStart();
+```
+
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### SessionReplayStopFunction
+
+Ƭ **SessionReplayStopFunction**: () => `Promise`\<`unknown`\>
+
+Interrupts a running session replay.
+
+**`Example`**
+
+```ts
+const { sessionReplayStop } = useScreeb();
+
+sessionReplayStop();
+```
+
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
 ### SurveyCloseFunction
 
 Ƭ **SurveyCloseFunction**: () => `Promise`\<`unknown`\>
@@ -586,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.
 
@@ -599,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
 
@@ -620,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.4.0",
+  "version": "0.6.0",
   "description": "Screeb's browser sdk, optimized for React.",
   "keywords": [
     "product discovery",
@@ -41,7 +41,7 @@
     "test": "echo '@TODO'"
   },
   "dependencies": {
-    "@screeb/sdk-browser": "^0.3.0"
+    "@screeb/sdk-browser": "^0.5.0"
   },
   "devDependencies": {
     "@screeb/eslint-config": "^0.1.6",