@screeb/sdk-browser 0.3.0 → 0.5.0

package/dist/cjs/index.cjs

@@ -414,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,
     });
 };
 /**
@@ -480,6 +482,30 @@ var messageStart = function (messageId, allowMultipleResponses, hiddenFields, ho
         hooks: hooks,
     });
 };
+/**
+ * Interrupts a running session replay.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.sessionReplayStop();
+ * ```
+ */
+var sessionReplayStop = function () { return callScreebCommand("session-replay.stop"); };
+/**
+ * Starts a session replay.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.sessionReplayStart();
+ * ```
+ */
+var sessionReplayStart = function () {
+    return callScreebCommand("session-replay.start");
+};
 /**
  * Forces a targeting check.
  *
@@ -531,8 +557,10 @@ exports.isLoaded = isLoaded;
 exports.load = load;
 exports.messageClose = messageClose;
 exports.messageStart = messageStart;
+exports.sessionReplayStart = sessionReplayStart;
+exports.sessionReplayStop = sessionReplayStop;
 exports.surveyClose = surveyClose;
 exports.surveyStart = surveyStart;
 exports.targetingCheck = targetingCheck;
 exports.targetingDebug = targetingDebug;
-CONSTANTS.version = '0.3.0'
+CONSTANTS.version = '0.5.0'

package/dist/cjs/index.d.ts

@@ -304,19 +304,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.
  *
@@ -351,6 +352,28 @@ export declare const messageClose: () => void | Promise<unknown>;
  * ```
  */
 export declare const messageStart: (messageId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksMessageStart, language?: string) => void | Promise<unknown>;
+/**
+ * Interrupts a running session replay.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.sessionReplayStop();
+ * ```
+ */
+export declare const sessionReplayStop: () => void | Promise<unknown>;
+/**
+ * Starts a session replay.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.sessionReplayStart();
+ * ```
+ */
+export declare const sessionReplayStart: () => void | Promise<unknown>;
 /**
  * Forces a targeting check.
  *

package/dist/es/index.d.ts

@@ -304,19 +304,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.
  *
@@ -351,6 +352,28 @@ export declare const messageClose: () => void | Promise<unknown>;
  * ```
  */
 export declare const messageStart: (messageId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksMessageStart, language?: string) => void | Promise<unknown>;
+/**
+ * Interrupts a running session replay.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.sessionReplayStop();
+ * ```
+ */
+export declare const sessionReplayStop: () => void | Promise<unknown>;
+/**
+ * Starts a session replay.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.sessionReplayStart();
+ * ```
+ */
+export declare const sessionReplayStart: () => void | Promise<unknown>;
 /**
  * Forces a targeting check.
  *

package/dist/es/index.mjs

@@ -412,27 +412,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,
     });
 };
 /**
@@ -478,6 +480,30 @@ var messageStart = function (messageId, allowMultipleResponses, hiddenFields, ho
         hooks: hooks,
     });
 };
+/**
+ * Interrupts a running session replay.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.sessionReplayStop();
+ * ```
+ */
+var sessionReplayStop = function () { return callScreebCommand("session-replay.stop"); };
+/**
+ * Starts a session replay.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.sessionReplayStart();
+ * ```
+ */
+var sessionReplayStart = function () {
+    return callScreebCommand("session-replay.start");
+};
 /**
  * Forces a targeting check.
  *
@@ -515,5 +541,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, surveyClose, surveyStart, targetingCheck, targetingDebug };
-CONSTANTS.version = '0.3.0'
+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'

package/docs/README.md

@@ -59,6 +59,8 @@
 - [load](README.md#load)
 - [messageClose](README.md#messageclose)
 - [messageStart](README.md#messagestart)
+- [sessionReplayStart](README.md#sessionreplaystart)
+- [sessionReplayStop](README.md#sessionreplaystop)
 - [surveyClose](README.md#surveyclose)
 - [surveyStart](README.md#surveystart)
 - [targetingCheck](README.md#targetingcheck)
@@ -1036,6 +1038,46 @@ Screeb.messageStart(
 
 ___
 
+### sessionReplayStart
+
+▸ **sessionReplayStart**(): `void` \| `Promise`\<`unknown`\>
+
+Starts a session replay.
+
+#### Returns
+
+`void` \| `Promise`\<`unknown`\>
+
+**`Example`**
+
+```ts
+import * as Screeb from "@screeb/sdk-browser";
+
+Screeb.sessionReplayStart();
+```
+
+___
+
+### sessionReplayStop
+
+▸ **sessionReplayStop**(): `void` \| `Promise`\<`unknown`\>
+
+Interrupts a running session replay.
+
+#### Returns
+
+`void` \| `Promise`\<`unknown`\>
+
+**`Example`**
+
+```ts
+import * as Screeb from "@screeb/sdk-browser";
+
+Screeb.sessionReplayStop();
+```
+
+___
+
 ### surveyClose
 
 ▸ **surveyClose**(): `void` \| `Promise`\<`unknown`\>
@@ -1058,7 +1100,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.
 
@@ -1072,6 +1114,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
 
@@ -1086,15 +1129,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.3.0",
+  "version": "0.5.0",
   "description": "Screeb's browser sdk.",
   "keywords": [
     "product discovery",