@alwaysmeticulous/sdk-bundles-api 2.142.0 → 2.143.0

package/dist/index.d.ts

@@ -5,5 +5,5 @@ export { ExecuteTestRunOptions } from "./replay-orchestrator/sdk-to-bundle/execu
 export { ExecuteScheduledTestRunOptions } from "./replay-orchestrator/sdk-to-bundle/execute-scheduled-test-run";
 export { ExecuteTestRunResult, TestRunExecution, RunningTestRunExecution, FinishedTestRunExecution, TestRunProgress, DetailedTestCaseResult, } from "./replay-orchestrator/bundle-to-sdk/execute-test-run";
 export { InProgressTestRun } from "./replay-orchestrator/bundle-to-sdk/execute-scheduled-test-run";
-export { ReplayAndStoreResultsResult, ReplayExecution, BeforeUserEventResult, } from "./replay-orchestrator/bundle-to-sdk/execute-replay";
+export { ReplayAndStoreResultsResult, ReplayExecution, BeforeUserEventResult, IndexedReplayableEvent, } from "./replay-orchestrator/bundle-to-sdk/execute-replay";
 export { ScreenshotDiffData } from "./replay-orchestrator/bundle-to-sdk/execute-replay";

package/dist/replay-orchestrator/bundle-to-sdk/execute-replay.d.ts

@@ -4,7 +4,13 @@ export interface ReplayExecution {
      * Promise resolves when the replay is complete.
      */
     finalResult: Promise<ReplayAndStoreResultsResult>;
-    eventsBeingReplayed: ReplayableEvent[];
+    /**
+     * The list of events that will actually be replayed. This list is the deduplicated events list,
+     * and so may have fewer events than the raw session data (sessionData.userEvents.event_log).
+     *
+     * These are used for the replay debugger UI.
+     */
+    eventsBeingReplayed: IndexedReplayableEvent[];
     /**
      * When called will log the target of the given event to the browser console.
      */
@@ -14,6 +20,13 @@ export interface ReplayExecution {
      */
     closePage: () => Promise<void>;
 }
+export interface IndexedReplayableEvent extends ReplayableEvent {
+    /**
+     * The index of the event in the raw session data, before any events were removed,
+     * deduplicated or merged.
+     */
+    originalEventIndex: number;
+}
 export interface ReplayAndStoreResultsResult {
     replay: Omit<Replay, "project">;
     /**

package/dist/replay-orchestrator/sdk-to-bundle/execute-replay.d.ts

@@ -54,7 +54,11 @@ export interface ReplayAndStoreResultsOptions {
 }
 export interface BeforeUserEventOptions {
     /**
-     * The index of the next event in sessionData.userEvents.event_log
+     * The index of the next event in the `eventsBeingReplayed` list returned on the ReplayExecution
+     * object returned by `replayAndStoreResults`.
+     *
+     * Note that this list is the deduplicated events list, and so may have fewer events than the
+     * raw session data (sessionData.userEvents.event_log).
      */
     userEventIndex: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwaysmeticulous/sdk-bundles-api",
-  "version": "2.142.0",
+  "version": "2.143.0",
   "description": "Meticulous common types",
   "license": "ISC",
   "main": "dist/index.js",
@@ -46,5 +46,5 @@
   "bugs": {
     "url": "https://github.com/alwaysmeticulous/meticulous-sdk/issues"
   },
-  "gitHead": "6298334f696d001060e9401a4fab6653ed6ef778"
+  "gitHead": "cbc37a5e356a01730d48a524757e141b408a0495"
 }