@dev-blinq/bvt-playwright-js 1.0.0-dev.4.latest.142.1 → 1.0.0-dev.4.latest.158.1

package/index.d.mts

@@ -1344,6 +1344,7 @@ declare const CommandSchema: z.ZodDiscriminatedUnion<[
 		], "type">;
 		target: z.ZodObject<{
 			name: z.ZodString;
+			isElementHidden: z.ZodOptional<z.ZodBoolean>;
 			uniqueSelectors: z.ZodArray<z.ZodDiscriminatedUnion<[
 				z.ZodObject<{
 					type: z.ZodLiteral<"pw.selectorString">;
@@ -2112,6 +2113,7 @@ declare const CommandSchema: z.ZodDiscriminatedUnion<[
 		], "type">;
 		target: z.ZodObject<{
 			name: z.ZodString;
+			isElementHidden: z.ZodOptional<z.ZodBoolean>;
 			uniqueSelectors: z.ZodArray<z.ZodDiscriminatedUnion<[
 				z.ZodObject<{
 					type: z.ZodLiteral<"pw.selectorString">;
@@ -2756,6 +2758,7 @@ declare const CommandSchema: z.ZodDiscriminatedUnion<[
 		], "type">;
 		target: z.ZodObject<{
 			name: z.ZodString;
+			isElementHidden: z.ZodOptional<z.ZodBoolean>;
 			uniqueSelectors: z.ZodArray<z.ZodDiscriminatedUnion<[
 				z.ZodObject<{
 					type: z.ZodLiteral<"pw.selectorString">;
@@ -4351,6 +4354,7 @@ declare const StepDefinitionSchema: z.ZodObject<{
 			], "type">;
 			target: z.ZodObject<{
 				name: z.ZodString;
+				isElementHidden: z.ZodOptional<z.ZodBoolean>;
 				uniqueSelectors: z.ZodArray<z.ZodDiscriminatedUnion<[
 					z.ZodObject<{
 						type: z.ZodLiteral<"pw.selectorString">;
@@ -5119,6 +5123,7 @@ declare const StepDefinitionSchema: z.ZodObject<{
 			], "type">;
 			target: z.ZodObject<{
 				name: z.ZodString;
+				isElementHidden: z.ZodOptional<z.ZodBoolean>;
 				uniqueSelectors: z.ZodArray<z.ZodDiscriminatedUnion<[
 					z.ZodObject<{
 						type: z.ZodLiteral<"pw.selectorString">;
@@ -5763,6 +5768,7 @@ declare const StepDefinitionSchema: z.ZodObject<{
 			], "type">;
 			target: z.ZodObject<{
 				name: z.ZodString;
+				isElementHidden: z.ZodOptional<z.ZodBoolean>;
 				uniqueSelectors: z.ZodArray<z.ZodDiscriminatedUnion<[
 					z.ZodObject<{
 						type: z.ZodLiteral<"pw.selectorString">;
@@ -7435,10 +7441,26 @@ type ExecutionStatusUpdateEventData = {
 	result: ExecResult;
 	resolvedChosenSelectorIndex?: number;
 	recovery?: RecoveryMetadata;
+	/**
+	 * Deterministic S3 keys for the before/after screenshots captured around
+	 * this command. Present only when screenshot capture is enabled for the
+	 * run; keys reflect the intended upload location (upload happens at the
+	 * end of the testcase).
+	 */
+	screenshots?: {
+		before?: string;
+		after?: string;
+	};
 } | RecoveryStatusEvent;
 type ExecutionCompletedEventData = {
 	type: "execution_completed";
 	result: ExecResult;
+	/**
+	 * True when before/after command screenshots were captured and at least one
+	 * was successfully uploaded to S3 for this run. Forwarded by the client into
+	 * `reports.onFinishTestCase` so it persists onto the testcase document.
+	 */
+	screenshotsAvailable?: boolean;
 };
 type ExecutionStartedEventData = {
 	type: "execution_started";
@@ -8817,6 +8839,9 @@ type PWSelectorDetails = {
 	score: number;
 	elements?: Element[];
 };
+type SelectorGenerationOptions = Partial<InternalOptions> & {
+	visibleOnly?: boolean;
+};
 declare class SelectorGenerator {
 	private injectedScript;
 	private _pw;
@@ -8829,7 +8854,7 @@ declare class SelectorGenerator {
 	private pushCandidate;
 	getMatchingElements(selector: string, options?: {
 		visibleOnly?: boolean;
-		root?: Element;
+		root?: Element | Document;
 		prefix?: string;
 	}): Element[];
 	private addNearestTextToSelectors;
@@ -8837,13 +8862,14 @@ declare class SelectorGenerator {
 	buildPWNoTextCandidates(element: Element, options?: InternalOptions): PWSelectorDetails[];
 	computeUnique(element: Element, locatorGenerator: (element: Element, options?: InternalOptions & {
 		isTargetNode: boolean;
-	}) => PWSelectorDetails[], strategy: "text" | "css", options?: InternalOptions): Generator<UniqueSelector>;
+	}) => PWSelectorDetails[], strategy: "text" | "css", options?: SelectorGenerationOptions): Generator<UniqueSelector>;
 	computeUnique2(element: Element, locatorGenerator: (element: Element, options?: InternalOptions & {
 		isTargetNode: boolean;
-	}) => PWSelectorDetails[], strategy: "text" | "css", options?: InternalOptions): Generator<UniqueSelector>;
-	getUniquePWSelectors(element: Element, options?: InternalOptions): Generator<UniqueSelector, undefined, unknown>;
+	}) => PWSelectorDetails[], strategy: "text" | "css", options?: SelectorGenerationOptions): Generator<UniqueSelector>;
+	getUniquePWSelectors(element: Element, options?: SelectorGenerationOptions): Generator<UniqueSelector, undefined, unknown>;
 	getCSSChainSelector(element: Element, options: {
 		root?: Element | Document;
+		visibleOnly?: boolean;
 	}): string;
 	getUniqueSelectors(element: Element, options?: InternalOptions & {
 		timeout?: number;
@@ -8873,6 +8899,7 @@ type ElementActionEvent = {
 			bvtId: string;
 			details: ElementDetails;
 			uniqueSelectors: UniqueSelector[];
+			isElementHidden?: boolean;
 		};
 		statistics: {
 			handleEventDurationMs: string;
@@ -9072,6 +9099,25 @@ type TraceUploadRequestInput = {
 	testCaseId: string;
 	projectId: string;
 };
+type ScreenshotUploadPhase = "before" | "after";
+type ScreenshotUploadFileDescriptor = {
+	stepId: string;
+	commandId: string;
+	phase: ScreenshotUploadPhase;
+};
+type ScreenshotUploadRequestInput = {
+	reportId: string;
+	testCaseId: string;
+	projectId: string;
+	files: ScreenshotUploadFileDescriptor[];
+};
+type ScreenshotUploadTarget = {
+	stepId: string;
+	commandId: string;
+	phase: ScreenshotUploadPhase; /** S3 object key the file will live at (deterministic convention). */
+	key: string; /** Presigned PUT URL for uploading the screenshot. */
+	url: string;
+};
 type ReplayOrchestratorResult = {
 	classification: {
 		label: string;
@@ -9087,6 +9133,9 @@ type TesterApiClient = {
 		getPresignedUrlForTraceUpload: {
 			query(input: TraceUploadRequestInput): Promise<string>;
 		};
+		getPresignedUrlsForScreenshotUpload: {
+			query(input: ScreenshotUploadRequestInput): Promise<ScreenshotUploadTarget[]>;
+		};
 	};
 	project: {
 		getProjectSettings: {
@@ -9123,6 +9172,9 @@ type UnboxedTuple<T extends unknown[]> = {
 	[K in keyof T]: Unboxed<T[K]>;
 };
 type LocatorScope = Frame | FrameLocator;
+type LocatorVisibilityOptions = {
+	isElementHidden?: boolean;
+};
 type GlobalThis = {
 	__bvt: {
 		BrowserObserver: typeof BrowserObserver;
@@ -9246,6 +9298,15 @@ type TesterSession = {
 	token?: string;
 	trace?: TesterTraceConfig;
 	runWithAiRecovery?: boolean;
+	/**
+	 * When enabled, a viewport JPEG is captured before and after every
+	 * command and the set is uploaded to S3 at the end of the testcase.
+	 * Off by default — capture adds latency to every command.
+	 */
+	screenshots?: {
+		enabled: boolean;
+	};
+	deterministicRecoveryMode?: "new-tour-maintenance";
 };
 type ExecuteStepsInput = {
 	recorderSteps: {
@@ -9285,6 +9346,19 @@ declare class Tester {
 	private sessionToken;
 	private activeBrowserContext;
 	private reportId;
+	private tempPathForAssets;
+	/**
+	 * Per-testcase log of before/after command screenshots captured on disk,
+	 * pending batch upload to S3 at the end of the run. Reset in onTestCaseStart.
+	 */
+	private capturedScreenshots;
+	/**
+	 * Per-testcase screenshot counters (reset in onTestCaseStart) used purely for
+	 * observability — how many commands were eligible for capture and how many
+	 * capture attempts failed. Upload counters are derived at upload time.
+	 */
+	private screenshotCommandsConsidered;
+	private screenshotCaptureFailures;
 	constructor(getAPIClient?: GetAPIClient, observabilityOrOptions?: AgentObservabilityInput | TesterOptions, optionsArg?: TesterOptions);
 	setContext(context: ResolutionContext): void;
 	setStepTraceChunkCallbacks(callbacks: StepTraceChunkCallbacks | undefined): void;
@@ -9295,6 +9369,22 @@ declare class Tester {
 	private summarizeErrorForExecutionLog;
 	private summarizeSessionForExecutionLog;
 	private getCommandText;
+	private screenshotsEnabled;
+	/**
+	 * Deterministic S3 key for a command screenshot. Must match the convention
+	 * used by the server's `getPresignedUrlsForScreenshotUpload` route so the
+	 * keys recorded on the command report point at the uploaded objects.
+	 */
+	private buildScreenshotKey;
+	private getScreenshotTempDir;
+	/**
+	 * Captures a viewport JPEG of the active page for the given command/phase,
+	 * writes it to the per-testcase temp dir, and records it for later upload.
+	 * Best-effort: any failure (no page, screenshot error) is logged and yields
+	 * `undefined` so command execution is never affected.
+	 */
+	private captureCommandScreenshot;
+	private toScreenshotRefs;
 	private onCommandStart;
 	private onCommandPass;
 	private onCommandFail;
@@ -9306,6 +9396,12 @@ declare class Tester {
 	private isRunSession;
 	private isRecordingReplaySession;
 	private shouldAttemptAiRecovery;
+	private isNewTourMaintenanceRecoverySession;
+	private shouldUseNewTourMaintenanceRecovery;
+	private inferNewTourGenderOption;
+	private buildNewTourGenderRadioCommand;
+	private buildNewTourGenderRepairPlan;
+	private recoverNewTourMaintenanceGenderCommand;
 	private isSupportedRepairContext;
 	private shouldUploadTrace;
 	private resolveTraceOutputPath;
@@ -9316,6 +9412,16 @@ declare class Tester {
 	private wait;
 	private uploadFile;
 	private uploadTraceFile;
+	private putFileWithRetries;
+	private cleanupScreenshotTempDir;
+	/**
+	 * Batch-uploads all command screenshots captured during the run to S3.
+	 * Fetches a presigned PUT URL per file in a single round-trip, then uploads
+	 * each with retries. Best-effort: returns true when at least one screenshot
+	 * was uploaded, false otherwise (or when there is nothing/no token). Always
+	 * cleans up the on-disk temp files. Never throws.
+	 */
+	private uploadScreenshots;
 	private onTestCaseFail;
 	private isBrowserDerivedCommand;
 	private buildFailureContext;
@@ -9373,7 +9479,7 @@ declare class Tester {
 	isFrameObject(frameScope: LocatorScope): frameScope is Frame;
 	getFrameObjectFromFrameScope(frameScope: FrameLocator | Frame): Promise<Frame>;
 	getFrame(scope: Page, frameElementDescriptors: ElementCommand["target"]["frames"]): Promise<LocatorScope>;
-	getLocator(scope: LocatorScope, uniqueSelector: UniqueSelector): {
+	getLocator(scope: LocatorScope, uniqueSelector: UniqueSelector, options?: LocatorVisibilityOptions): {
 		target: Locator;
 	};
 	executeElementAction(locator: Locator, action: ElementAction): Promise<void>;