@screeb/sdk-react - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0

dist/cjs/index.cjs

@@ -334,2 +334,18 @@ 'use strict';
     }, []);
+    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) {
@@ -378,2 +394,4 @@ switch (_a.label) {
         messageStart: messageStart,
+        sessionReplayStop: sessionReplayStop,
+        sessionReplayStart: sessionReplayStart,
         targetingCheck: targetingCheck,
@@ -397,2 +415,4 @@ targetingDebug: targetingDebug,
         messageStart,
+        sessionReplayStop,
+        sessionReplayStart,
         targetingCheck,
@@ -421,2 +441,2 @@ targetingDebug,
 exports.useScreeb = useScreeb;
-CONSTANTS.version = '0.4.0'
+CONSTANTS.version = '0.5.0'

dist/cjs/types.d.ts

@@ -335,2 +335,24 @@ import { HooksInit, HooksMessageStart, HooksSurveyStart, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "@screeb/sdk-browser";
 /**
+ * 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.
@@ -388,2 +410,4 @@ *
     messageStart: MessageStartFunction;
+    sessionReplayStart: SessionReplayStartFunction;
+    sessionReplayStop: SessionReplayStopFunction;
     targetingCheck: TargetingCheckFunction;
@@ -390,0 +414,0 @@ targetingDebug: TargetingDebugFunction;

dist/es/index.mjs

@@ -312,2 +312,18 @@ import { jsx } from 'react/jsx-runtime';
     }, []);
+    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) {
@@ -356,2 +372,4 @@ switch (_a.label) {
         messageStart: messageStart,
+        sessionReplayStop: sessionReplayStop,
+        sessionReplayStart: sessionReplayStart,
         targetingCheck: targetingCheck,
@@ -375,2 +393,4 @@ targetingDebug: targetingDebug,
         messageStart,
+        sessionReplayStop,
+        sessionReplayStart,
         targetingCheck,
@@ -398,2 +418,2 @@ targetingDebug,
 export { ScreebProvider, useScreeb };
-CONSTANTS.version = '0.4.0'
+CONSTANTS.version = '0.5.0'

dist/es/types.d.ts

@@ -335,2 +335,24 @@ import { HooksInit, HooksMessageStart, HooksSurveyStart, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "@screeb/sdk-browser";
 /**
+ * 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.
@@ -388,2 +410,4 @@ *
     messageStart: MessageStartFunction;
+    sessionReplayStart: SessionReplayStartFunction;
+    sessionReplayStop: SessionReplayStopFunction;
     targetingCheck: TargetingCheckFunction;
@@ -390,0 +414,0 @@ targetingDebug: TargetingDebugFunction;

docs/README.md

@@ -25,2 +25,4 @@ @screeb/sdk-react
 - [ScreebProviderProps](README.md#screebproviderprops)
+- [SessionReplayStartFunction](README.md#sessionreplaystartfunction)
+- [SessionReplayStopFunction](README.md#sessionreplaystopfunction)
 - [SurveyCloseFunction](README.md#surveyclosefunction)
@@ -531,2 +533,4 @@ - [SurveyStartFunction](README.md#surveystartfunction)
 | `messageStart` | [`MessageStartFunction`](README.md#messagestartfunction) |
+| `sessionReplayStart` | [`SessionReplayStartFunction`](README.md#sessionreplaystartfunction) |
+| `sessionReplayStop` | [`SessionReplayStopFunction`](README.md#sessionreplaystopfunction) |
 | `surveyClose` | [`SurveyCloseFunction`](README.md#surveyclosefunction) |
@@ -565,2 +569,50 @@ | `surveyStart` | [`SurveyStartFunction`](README.md#surveystartfunction) |
 
+### 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
@@ -567,0 +619,0 @@

package.json

 {
   "name": "@screeb/sdk-react",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Screeb's browser sdk, optimized for React.",
@@ -44,3 +44,3 @@ "keywords": [
   "dependencies": {
-    "@screeb/sdk-browser": "^0.3.0"
+    "@screeb/sdk-browser": "^0.4.0"
   },
@@ -47,0 +47,0 @@ "devDependencies": {

No alert changes

Improved metrics

Total package byte prevSize

89373

4.81%

Lines of code

1754

5.28%

Dependency changes

• + Added

  @screeb/sdk-browser@0.4.0
  (transitive)

• + Added

  react@19.2.6
  (transitive)

• - Removed

  @screeb/sdk-browser@0.3.0
  (transitive)

• - Removed

  react@19.2.7
  (transitive)

• Updated

  @screeb/sdk-browser@^0.4.0