@screeb/sdk-browser 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -480,6 +480,30 @@ var messageStart = function (messageId, allowMultipleResponses, hiddenFields, ho
480
480
  hooks: hooks,
481
481
  });
482
482
  };
483
+ /**
484
+ * Interrupts a running session replay.
485
+ *
486
+ * @example
487
+ * ```ts
488
+ * import * as Screeb from "@screeb/sdk-browser";
489
+ *
490
+ * Screeb.sessionReplayStop();
491
+ * ```
492
+ */
493
+ var sessionReplayStop = function () { return callScreebCommand("session-replay.stop"); };
494
+ /**
495
+ * Starts a session replay.
496
+ *
497
+ * @example
498
+ * ```ts
499
+ * import * as Screeb from "@screeb/sdk-browser";
500
+ *
501
+ * Screeb.sessionReplayStart();
502
+ * ```
503
+ */
504
+ var sessionReplayStart = function () {
505
+ return callScreebCommand("session-replay.start");
506
+ };
483
507
  /**
484
508
  * Forces a targeting check.
485
509
  *
@@ -531,8 +555,10 @@ exports.isLoaded = isLoaded;
531
555
  exports.load = load;
532
556
  exports.messageClose = messageClose;
533
557
  exports.messageStart = messageStart;
558
+ exports.sessionReplayStart = sessionReplayStart;
559
+ exports.sessionReplayStop = sessionReplayStop;
534
560
  exports.surveyClose = surveyClose;
535
561
  exports.surveyStart = surveyStart;
536
562
  exports.targetingCheck = targetingCheck;
537
563
  exports.targetingDebug = targetingDebug;
538
- CONSTANTS.version = '0.3.0'
564
+ CONSTANTS.version = '0.4.0'
@@ -351,6 +351,28 @@ export declare const messageClose: () => void | Promise<unknown>;
351
351
  * ```
352
352
  */
353
353
  export declare const messageStart: (messageId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksMessageStart, language?: string) => void | Promise<unknown>;
354
+ /**
355
+ * Interrupts a running session replay.
356
+ *
357
+ * @example
358
+ * ```ts
359
+ * import * as Screeb from "@screeb/sdk-browser";
360
+ *
361
+ * Screeb.sessionReplayStop();
362
+ * ```
363
+ */
364
+ export declare const sessionReplayStop: () => void | Promise<unknown>;
365
+ /**
366
+ * Starts a session replay.
367
+ *
368
+ * @example
369
+ * ```ts
370
+ * import * as Screeb from "@screeb/sdk-browser";
371
+ *
372
+ * Screeb.sessionReplayStart();
373
+ * ```
374
+ */
375
+ export declare const sessionReplayStart: () => void | Promise<unknown>;
354
376
  /**
355
377
  * Forces a targeting check.
356
378
  *
@@ -351,6 +351,28 @@ export declare const messageClose: () => void | Promise<unknown>;
351
351
  * ```
352
352
  */
353
353
  export declare const messageStart: (messageId: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksMessageStart, language?: string) => void | Promise<unknown>;
354
+ /**
355
+ * Interrupts a running session replay.
356
+ *
357
+ * @example
358
+ * ```ts
359
+ * import * as Screeb from "@screeb/sdk-browser";
360
+ *
361
+ * Screeb.sessionReplayStop();
362
+ * ```
363
+ */
364
+ export declare const sessionReplayStop: () => void | Promise<unknown>;
365
+ /**
366
+ * Starts a session replay.
367
+ *
368
+ * @example
369
+ * ```ts
370
+ * import * as Screeb from "@screeb/sdk-browser";
371
+ *
372
+ * Screeb.sessionReplayStart();
373
+ * ```
374
+ */
375
+ export declare const sessionReplayStart: () => void | Promise<unknown>;
354
376
  /**
355
377
  * Forces a targeting check.
356
378
  *
package/dist/es/index.mjs CHANGED
@@ -478,6 +478,30 @@ var messageStart = function (messageId, allowMultipleResponses, hiddenFields, ho
478
478
  hooks: hooks,
479
479
  });
480
480
  };
481
+ /**
482
+ * Interrupts a running session replay.
483
+ *
484
+ * @example
485
+ * ```ts
486
+ * import * as Screeb from "@screeb/sdk-browser";
487
+ *
488
+ * Screeb.sessionReplayStop();
489
+ * ```
490
+ */
491
+ var sessionReplayStop = function () { return callScreebCommand("session-replay.stop"); };
492
+ /**
493
+ * Starts a session replay.
494
+ *
495
+ * @example
496
+ * ```ts
497
+ * import * as Screeb from "@screeb/sdk-browser";
498
+ *
499
+ * Screeb.sessionReplayStart();
500
+ * ```
501
+ */
502
+ var sessionReplayStart = function () {
503
+ return callScreebCommand("session-replay.start");
504
+ };
481
505
  /**
482
506
  * Forces a targeting check.
483
507
  *
@@ -515,5 +539,5 @@ var targetingCheck = function () { return callScreebCommand("targeting.check");
515
539
  */
516
540
  var targetingDebug = function () { return callScreebCommand("targeting.debug"); };
517
541
 
518
- export { close, debug, eventTrack, identity, identityGet, identityGroupAssign, identityGroupUnassign, identityProperties, identityReset, init, isLoaded, load, messageClose, messageStart, surveyClose, surveyStart, targetingCheck, targetingDebug };
519
- CONSTANTS.version = '0.3.0'
542
+ export { close, debug, eventTrack, identity, identityGet, identityGroupAssign, identityGroupUnassign, identityProperties, identityReset, init, isLoaded, load, messageClose, messageStart, sessionReplayStart, sessionReplayStop, surveyClose, surveyStart, targetingCheck, targetingDebug };
543
+ CONSTANTS.version = '0.4.0'
package/docs/README.md CHANGED
@@ -59,6 +59,8 @@
59
59
  - [load](README.md#load)
60
60
  - [messageClose](README.md#messageclose)
61
61
  - [messageStart](README.md#messagestart)
62
+ - [sessionReplayStart](README.md#sessionreplaystart)
63
+ - [sessionReplayStop](README.md#sessionreplaystop)
62
64
  - [surveyClose](README.md#surveyclose)
63
65
  - [surveyStart](README.md#surveystart)
64
66
  - [targetingCheck](README.md#targetingcheck)
@@ -1036,6 +1038,46 @@ Screeb.messageStart(
1036
1038
 
1037
1039
  ___
1038
1040
 
1041
+ ### sessionReplayStart
1042
+
1043
+ ▸ **sessionReplayStart**(): `void` \| `Promise`\<`unknown`\>
1044
+
1045
+ Starts a session replay.
1046
+
1047
+ #### Returns
1048
+
1049
+ `void` \| `Promise`\<`unknown`\>
1050
+
1051
+ **`Example`**
1052
+
1053
+ ```ts
1054
+ import * as Screeb from "@screeb/sdk-browser";
1055
+
1056
+ Screeb.sessionReplayStart();
1057
+ ```
1058
+
1059
+ ___
1060
+
1061
+ ### sessionReplayStop
1062
+
1063
+ ▸ **sessionReplayStop**(): `void` \| `Promise`\<`unknown`\>
1064
+
1065
+ Interrupts a running session replay.
1066
+
1067
+ #### Returns
1068
+
1069
+ `void` \| `Promise`\<`unknown`\>
1070
+
1071
+ **`Example`**
1072
+
1073
+ ```ts
1074
+ import * as Screeb from "@screeb/sdk-browser";
1075
+
1076
+ Screeb.sessionReplayStop();
1077
+ ```
1078
+
1079
+ ___
1080
+
1039
1081
  ### surveyClose
1040
1082
 
1041
1083
  ▸ **surveyClose**(): `void` \| `Promise`\<`unknown`\>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@screeb/sdk-browser",
3
- "version": "0.3.0",
3
+ "version": "0.4.0",
4
4
  "description": "Screeb's browser sdk.",
5
5
  "keywords": [
6
6
  "product discovery",