@alwaysmeticulous/sdk-bundles-api
Advanced tools
Comparing version 2.41.0 to 2.42.0
@@ -8,2 +8,2 @@ export { RecordConfig, RecordSettings, RecordState } from "./record"; | ||
export { ExecuteTestRunResult, TestRunExecution, RunningTestRunExecution, FinishedTestRunExecution, TestRunProgress, DetailedTestCaseResult, } from "./replay-orchestrator/bundle-to-sdk/execute-test-run"; | ||
export { ReplayAndStoreResultsResult } from "./replay-orchestrator/bundle-to-sdk/execute-replay"; | ||
export { ReplayAndStoreResultsResult, ReplayExecution, BeforeUserEventResult, } from "./replay-orchestrator/bundle-to-sdk/execute-replay"; |
@@ -1,2 +0,17 @@ | ||
import { Replay, ScreenshotDiffResult } from "@alwaysmeticulous/api"; | ||
import { Replay, ReplayableEvent, ScreenshotDiffResult } from "@alwaysmeticulous/api"; | ||
export interface ReplayExecution { | ||
/** | ||
* Promise resolves when the replay is complete. | ||
*/ | ||
finalResult: Promise<ReplayAndStoreResultsResult>; | ||
eventsBeingReplayed: ReplayableEvent[]; | ||
/** | ||
* When called will log the target of the given event to the browser console. | ||
*/ | ||
logEventTarget: (event: ReplayableEvent) => Promise<void>; | ||
/** | ||
* Closes the browser window and stops the replay short. | ||
*/ | ||
closePage: () => Promise<void>; | ||
} | ||
export interface ReplayAndStoreResultsResult { | ||
@@ -9,1 +24,10 @@ replay: Replay; | ||
} | ||
export interface BeforeUserEventResult { | ||
/** | ||
* If provided then execution will continue, without calling onBeforeUserEvent, until | ||
* the next event with this index is reached. | ||
* | ||
* If omitted then onBeforeUserEvent will be called again on the immediate next event. | ||
*/ | ||
nextEventIndexToPauseBefore?: number; | ||
} |
import { ScreenshotDiffOptions } from "@alwaysmeticulous/api"; | ||
import { BeforeUserEventOptions } from "../../replay/bundle-to-sdk"; | ||
import { BeforeUserEventResult } from "../bundle-to-sdk/execute-replay"; | ||
export interface ReplayAndStoreResultsOptions { | ||
@@ -13,3 +15,11 @@ replayTarget: ReplayTarget; | ||
cookiesFile: string | null | undefined; | ||
debugger: boolean; | ||
/** | ||
* Called when the user or runner closes the page or browser window | ||
*/ | ||
onClosePage?: () => void; | ||
/** | ||
* The replay runner will block on the promise returned before replaying the | ||
* next event. This allows the caller to pause the replay, or control the playback. | ||
*/ | ||
onBeforeUserEvent?: (opts: BeforeUserEventOptions) => Promise<BeforeUserEventResult>; | ||
} | ||
@@ -16,0 +26,0 @@ /** |
{ | ||
"name": "@alwaysmeticulous/sdk-bundles-api", | ||
"version": "2.41.0", | ||
"version": "2.42.0", | ||
"description": "Meticulous common types", | ||
@@ -22,3 +22,3 @@ "license": "ISC", | ||
"devDependencies": { | ||
"@alwaysmeticulous/api": "^2.41.0" | ||
"@alwaysmeticulous/api": "^2.42.0" | ||
}, | ||
@@ -54,3 +54,3 @@ "peerDependencies": { | ||
}, | ||
"gitHead": "778895a7cd6a010538e338f9b2da225e71c53f48" | ||
"gitHead": "65e2410a784642674ea6c8203d5b9f8a303c33ea" | ||
} |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
20384
448