@dev-blinq/bvt-playwright-js 1.0.0-dev.4.latest.142.1 → 1.0.0-dev.4.latest.149.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">;
@@ -8817,6 +8823,9 @@ type PWSelectorDetails = {
 	score: number;
 	elements?: Element[];
 };
+type SelectorGenerationOptions = Partial<InternalOptions> & {
+	visibleOnly?: boolean;
+};
 declare class SelectorGenerator {
 	private injectedScript;
 	private _pw;
@@ -8829,7 +8838,7 @@ declare class SelectorGenerator {
 	private pushCandidate;
 	getMatchingElements(selector: string, options?: {
 		visibleOnly?: boolean;
-		root?: Element;
+		root?: Element | Document;
 		prefix?: string;
 	}): Element[];
 	private addNearestTextToSelectors;
@@ -8837,13 +8846,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 +8883,7 @@ type ElementActionEvent = {
 			bvtId: string;
 			details: ElementDetails;
 			uniqueSelectors: UniqueSelector[];
+			isElementHidden?: boolean;
 		};
 		statistics: {
 			handleEventDurationMs: string;
@@ -9123,6 +9134,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;
@@ -9373,7 +9387,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>;

package/index.mjs

@@ -6562,6 +6562,7 @@ const RichElementTargetDetailsSchema = object({
 }).passthrough();
 const elementTargetSchema = object({
 	name: string(),
+	isElementHidden: boolean().optional(),
 	uniqueSelectors: array(UniqueSelectorSchema),
 	frames: array(object({
 		name: string(),
@@ -27288,7 +27289,7 @@ var Tester = class {
 		if (!frameElementDescriptors || frameElementDescriptors.length === 0) return scope.mainFrame();
 		let currentFrame = scope.mainFrame();
 		for (const frameDescriptor of frameElementDescriptors) for (const selectorInfo of frameDescriptor.uniqueSelectors) {
-			const { target } = this.getLocator(currentFrame, selectorInfo);
+			const { target } = this.getLocator(currentFrame, selectorInfo, { isElementHidden: false });
 			try {
 				if (!await target.elementHandle()) throw new Error(`Could not find element for frame selector: ${JSON.stringify(selectorInfo)}`);
 				const selector = target._selector;
@@ -27300,9 +27301,14 @@ var Tester = class {
 		}
 		return currentFrame;
 	}
-	getLocator(scope, uniqueSelector) {
+	getLocator(scope, uniqueSelector, options) {
 		switch (uniqueSelector.type) {
-			case "pw.selectorString": return { target: scope.locator(uniqueSelector.selectorString + ` >> visible=true`) };
+			case "pw.selectorString": {
+				const visibleSuffix = options?.isElementHidden === true ? "" : ` >> visible=true`;
+				const finalSelector = uniqueSelector.selectorString + visibleSuffix;
+				this.obs.logger.info(`getLocator(pw.selectorString): isElementHidden=${options?.isElementHidden}, visibleAppended=${visibleSuffix !== ""}, finalSelector=${finalSelector}`);
+				return { target: scope.locator(finalSelector) };
+			}
 			case "bvt.selectorObject": throw new Error(`Selector type "bvt.selectorObject" is not yet supported in getLocator`);
 			default:
 				const _exhaustiveCheck = uniqueSelector;
@@ -27683,7 +27689,7 @@ var Tester = class {
 					const selectorInfo = target.uniqueSelectors[chosenSelectorIndex];
 					if (!selectorInfo) throw new Error(`No selector found for target "${target.name}" at chosenSelectorIndex ${chosenSelectorIndex}. Available selectors: ${JSON.stringify(target.uniqueSelectors)}`);
 					const frame = await this.getFrame(input.page, target.frames);
-					const locator = this.getLocator(frame, selectorInfo);
+					const locator = this.getLocator(frame, selectorInfo, target);
 					try {
 						const dataWithDefaultTimeout = {
 							...data,
@@ -27704,7 +27710,7 @@ var Tester = class {
 					for (let i = 0; i < target.uniqueSelectors.length; i++) {
 						if (i === chosenSelectorIndex) continue;
 						const selectorInfo = target.uniqueSelectors[i];
-						const locator = this.getLocator(frame, selectorInfo);
+						const locator = this.getLocator(frame, selectorInfo, target);
 						try {
 							this.obs.logger.info(`Retrying action "${data.type}" using next selector: ${JSON.stringify(selectorInfo)}`);
 							const dataWithModifiedTimeout = {
@@ -27735,7 +27741,7 @@ var Tester = class {
 					const chosenSelectorIndex = target.chosenSelectorIndex ?? 0;
 					const selectorInfo = target.uniqueSelectors[chosenSelectorIndex];
 					const frame = await this.getFrame(input.page, target.frames);
-					const locator = this.getLocator(frame, selectorInfo);
+					const locator = this.getLocator(frame, selectorInfo, target);
 					try {
 						this.obs.logger.info(`Executing assertion "${data.type}" using selector: ${JSON.stringify(selectorInfo)}`);
 						const dataWithDefaultTimeout = {
@@ -27755,7 +27761,7 @@ var Tester = class {
 					for (let i = 0; i < target.uniqueSelectors.length; i++) {
 						if (i === chosenSelectorIndex) continue;
 						const selectorInfo = target.uniqueSelectors[i];
-						const locator = this.getLocator(frame, selectorInfo);
+						const locator = this.getLocator(frame, selectorInfo, target);
 						const dataWithModifiedTimeout = {
 							...data,
 							options: {
@@ -27788,7 +27794,7 @@ var Tester = class {
 					const selectorInfo = target.uniqueSelectors[chosenSelectorIndex];
 					if (!selectorInfo) throw new Error(`No selector found for target "${target.name}" at chosenSelectorIndex ${chosenSelectorIndex}. Available selectors: ${JSON.stringify(target.uniqueSelectors)}`);
 					const frame = await this.getFrame(input.page, target.frames);
-					const locator = this.getLocator(frame, selectorInfo);
+					const locator = this.getLocator(frame, selectorInfo, target);
 					try {
 						this.obs.logger.info(`Executing extraction "${extract.type}" using selector: ${JSON.stringify(selectorInfo)}`);
 						await this.executeElementExtraction(locator.target, extract, storageDetails);
@@ -27801,7 +27807,7 @@ var Tester = class {
 					for (let i = 0; i < target.uniqueSelectors.length; i++) {
 						if (i === chosenSelectorIndex) continue;
 						const fallbackSelectorInfo = target.uniqueSelectors[i];
-						const fallbackLocator = this.getLocator(frame, fallbackSelectorInfo);
+						const fallbackLocator = this.getLocator(frame, fallbackSelectorInfo, target);
 						try {
 							this.obs.logger.info(`Retrying extraction "${extract.type}" using next selector: ${JSON.stringify(fallbackSelectorInfo)}`);
 							await this.executeElementExtraction(fallbackLocator.target, extract, storageDetails);