"use strict"; /** * Copyright 2023 Google Inc. All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) { var useValue = arguments.length > 2; for (var i = 0; i < initializers.length; i++) { value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg); } return useValue ? value : void 0; }; var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) { function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; } var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value"; var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null; var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {}); var _, done = false; for (var i = decorators.length - 1; i >= 0; i--) { var context = {}; for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p]; for (var p in contextIn.access) context.access[p] = contextIn.access[p]; context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); }; var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context); if (kind === "accessor") { if (result === void 0) continue; if (result === null || typeof result !== "object") throw new TypeError("Object expected"); if (_ = accept(result.get)) descriptor.get = _; if (_ = accept(result.set)) descriptor.set = _; if (_ = accept(result.init)) initializers.unshift(_); } else if (_ = accept(result)) { if (kind === "field") initializers.unshift(_); else descriptor[key] = _; } } if (target) Object.defineProperty(target, contextIn.name, descriptor); done = true; }; var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) { if (value !== null && value !== void 0) { if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected."); var dispose; if (async) { if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined."); dispose = value[Symbol.asyncDispose]; } if (dispose === void 0) { if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined."); dispose = value[Symbol.dispose]; } if (typeof dispose !== "function") throw new TypeError("Object not disposable."); env.stack.push({ value: value, dispose: dispose, async: async }); } else if (async) { env.stack.push({ async: true }); } return value; }; var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) { return function (env) { function fail(e) { env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e; env.hasError = true; } function next() { while (env.stack.length) { var rec = env.stack.pop(); try { var result = rec.dispose && rec.dispose.call(rec.value); if (rec.async) return Promise.resolve(result).then(next, function(e) { fail(e); return next(); }); } catch (e) { fail(e); } } if (env.hasError) throw env.error; } return next(); }; })(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) { var e = new Error(message); return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e; }); Object.defineProperty(exports, "__esModule", { value: true }); exports.ElementHandle = void 0; const GetQueryHandler_js_1 = require("../common/GetQueryHandler.js"); const LazyArg_js_1 = require("../common/LazyArg.js"); const util_js_1 = require("../common/util.js"); const assert_js_1 = require("../util/assert.js"); const AsyncIterableUtil_js_1 = require("../util/AsyncIterableUtil.js"); const decorators_js_1 = require("../util/decorators.js"); const JSHandle_js_1 = require("./JSHandle.js"); /** * ElementHandle represents an in-page DOM element. * * @remarks * ElementHandles can be created with the {@link Page.$} method. * * ```ts * import puppeteer from 'puppeteer'; * * (async () => { * const browser = await puppeteer.launch(); * const page = await browser.newPage(); * await page.goto('https://example.com'); * const hrefElement = await page.$('a'); * await hrefElement.click(); * // ... * })(); * ``` * * ElementHandle prevents the DOM element from being garbage-collected unless the * handle is {@link JSHandle.dispose | disposed}. ElementHandles are auto-disposed * when their origin frame gets navigated. * * ElementHandle instances can be used as arguments in {@link Page.$eval} and * {@link Page.evaluate} methods. * * If you're using TypeScript, ElementHandle takes a generic argument that * denotes the type of element the handle is holding within. For example, if you * have a handle to a `` element matching `selector`, the method * throws an error. * * @example * * ```ts * handle.select('blue'); // single selection * handle.select('red', 'green', 'blue'); // multiple selections * ``` * * @param values - Values of options to select. If the ` element.'); } const selectedValues = new Set(); if (!element.multiple) { for (const option of element.options) { option.selected = false; } for (const option of element.options) { if (values.has(option.value)) { option.selected = true; selectedValues.add(option.value); break; } } } else { for (const option of element.options) { option.selected = values.has(option.value); if (option.selected) { selectedValues.add(option.value); } } } element.dispatchEvent(new Event('input', { bubbles: true })); element.dispatchEvent(new Event('change', { bubbles: true })); return [...selectedValues.values()]; }, values); } async uploadFile() { throw new Error('Not implemented'); } /** * This method scrolls element into view if needed, and then uses * {@link Touchscreen.tap} to tap in the center of the element. * If the element is detached from DOM, the method throws an error. */ async tap() { await this.scrollIntoViewIfNeeded(); const { x, y } = await this.clickablePoint(); await this.frame.page().touchscreen.touchStart(x, y); await this.frame.page().touchscreen.touchEnd(); } async touchStart() { await this.scrollIntoViewIfNeeded(); const { x, y } = await this.clickablePoint(); await this.frame.page().touchscreen.touchStart(x, y); } async touchMove() { await this.scrollIntoViewIfNeeded(); const { x, y } = await this.clickablePoint(); await this.frame.page().touchscreen.touchMove(x, y); } async touchEnd() { await this.scrollIntoViewIfNeeded(); await this.frame.page().touchscreen.touchEnd(); } /** * Calls {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus | focus} on the element. */ async focus() { await this.evaluate(element => { if (!(element instanceof HTMLElement)) { throw new Error('Cannot focus non-HTMLElement'); } return element.focus(); }); } /** * Focuses the element, and then sends a `keydown`, `keypress`/`input`, and * `keyup` event for each character in the text. * * To press a special key, like `Control` or `ArrowDown`, * use {@link ElementHandle.press}. * * @example * * ```ts * await elementHandle.type('Hello'); // Types instantly * await elementHandle.type('World', {delay: 100}); // Types slower, like a user * ``` * * @example * An example of typing into a text field and then submitting the form: * * ```ts * const elementHandle = await page.$('input'); * await elementHandle.type('some text'); * await elementHandle.press('Enter'); * ``` * * @param options - Delay in milliseconds. Defaults to 0. */ async type(text, options) { await this.focus(); await this.frame.page().keyboard.type(text, options); } /** * Focuses the element, and then uses {@link Keyboard.down} and {@link Keyboard.up}. * * @remarks * If `key` is a single character and no modifier keys besides `Shift` * are being held down, a `keypress`/`input` event will also be generated. * The `text` option can be specified to force an input event to be generated. * * **NOTE** Modifier keys DO affect `elementHandle.press`. Holding down `Shift` * will type the text in upper case. * * @param key - Name of key to press, such as `ArrowLeft`. * See {@link KeyInput} for a list of all key names. */ async press(key, options) { await this.focus(); await this.frame.page().keyboard.press(key, options); } async #clickableBox() { const boxes = await this.evaluate(element => { if (!(element instanceof Element)) { return null; } return [...element.getClientRects()].map(rect => { return { x: rect.x, y: rect.y, width: rect.width, height: rect.height }; }); }); if (!boxes?.length) { return null; } await this.#intersectBoundingBoxesWithFrame(boxes); let frame = this.frame; let parentFrame; while ((parentFrame = frame?.parentFrame())) { const env_4 = { stack: [], error: void 0, hasError: false }; try { const handle = __addDisposableResource(env_4, await frame.frameElement(), false); if (!handle) { throw new Error('Unsupported frame type'); } const parentBox = await handle.evaluate(element => { // Element is not visible. if (element.getClientRects().length === 0) { return null; } const rect = element.getBoundingClientRect(); const style = window.getComputedStyle(element); return { left: rect.left + parseInt(style.paddingLeft, 10) + parseInt(style.borderLeftWidth, 10), top: rect.top + parseInt(style.paddingTop, 10) + parseInt(style.borderTopWidth, 10), }; }); if (!parentBox) { return null; } for (const box of boxes) { box.x += parentBox.left; box.y += parentBox.top; } await handle.#intersectBoundingBoxesWithFrame(boxes); frame = parentFrame; } catch (e_4) { env_4.error = e_4; env_4.hasError = true; } finally { __disposeResources(env_4); } } const box = boxes.find(box => { return box.width >= 1 && box.height >= 1; }); if (!box) { return null; } return { x: box.x, y: box.y, height: box.height, width: box.width, }; } async #intersectBoundingBoxesWithFrame(boxes) { const { documentWidth, documentHeight } = await this.frame .isolatedRealm() .evaluate(() => { return { documentWidth: document.documentElement.clientWidth, documentHeight: document.documentElement.clientHeight, }; }); for (const box of boxes) { intersectBoundingBox(box, documentWidth, documentHeight); } } /** * This method returns the bounding box of the element (relative to the main frame), * or `null` if the element is not visible. */ async boundingBox() { const box = await this.evaluate(element => { if (!(element instanceof Element)) { return null; } // Element is not visible. if (element.getClientRects().length === 0) { return null; } const rect = element.getBoundingClientRect(); return { x: rect.x, y: rect.y, width: rect.width, height: rect.height }; }); if (!box) { return null; } const offset = await this.#getTopLeftCornerOfFrame(); if (!offset) { return null; } return { x: box.x + offset.x, y: box.y + offset.y, height: box.height, width: box.width, }; } /** * This method returns boxes of the element, or `null` if the element is not visible. * * @remarks * * Boxes are represented as an array of points; * Each Point is an object `{x, y}`. Box points are sorted clock-wise. */ async boxModel() { const model = await this.evaluate(element => { if (!(element instanceof Element)) { return null; } // Element is not visible. if (element.getClientRects().length === 0) { return null; } const rect = element.getBoundingClientRect(); const style = window.getComputedStyle(element); const offsets = { padding: { left: parseInt(style.paddingLeft, 10), top: parseInt(style.paddingTop, 10), right: parseInt(style.paddingRight, 10), bottom: parseInt(style.paddingBottom, 10), }, margin: { left: -parseInt(style.marginLeft, 10), top: -parseInt(style.marginTop, 10), right: -parseInt(style.marginRight, 10), bottom: -parseInt(style.marginBottom, 10), }, border: { left: parseInt(style.borderLeft, 10), top: parseInt(style.borderTop, 10), right: parseInt(style.borderRight, 10), bottom: parseInt(style.borderBottom, 10), }, }; const border = [ { x: rect.left, y: rect.top }, { x: rect.left + rect.width, y: rect.top }, { x: rect.left + rect.width, y: rect.top + rect.bottom }, { x: rect.left, y: rect.top + rect.bottom }, ]; const padding = transformQuadWithOffsets(border, offsets.border); const content = transformQuadWithOffsets(padding, offsets.padding); const margin = transformQuadWithOffsets(border, offsets.margin); return { content, padding, border, margin, width: rect.width, height: rect.height, }; function transformQuadWithOffsets(quad, offsets) { return [ { x: quad[0].x + offsets.left, y: quad[0].y + offsets.top, }, { x: quad[1].x - offsets.right, y: quad[1].y + offsets.top, }, { x: quad[2].x - offsets.right, y: quad[2].y - offsets.bottom, }, { x: quad[3].x + offsets.left, y: quad[3].y - offsets.bottom, }, ]; } }); if (!model) { return null; } const offset = await this.#getTopLeftCornerOfFrame(); if (!offset) { return null; } for (const attribute of [ 'content', 'padding', 'border', 'margin', ]) { for (const point of model[attribute]) { point.x += offset.x; point.y += offset.y; } } return model; } async #getTopLeftCornerOfFrame() { const point = { x: 0, y: 0 }; let frame = this.frame; let parentFrame; while ((parentFrame = frame?.parentFrame())) { const env_5 = { stack: [], error: void 0, hasError: false }; try { const handle = __addDisposableResource(env_5, await frame.frameElement(), false); if (!handle) { throw new Error('Unsupported frame type'); } const parentBox = await handle.evaluate(element => { // Element is not visible. if (element.getClientRects().length === 0) { return null; } const rect = element.getBoundingClientRect(); const style = window.getComputedStyle(element); return { left: rect.left + parseInt(style.paddingLeft, 10) + parseInt(style.borderLeftWidth, 10), top: rect.top + parseInt(style.paddingTop, 10) + parseInt(style.borderTopWidth, 10), }; }); if (!parentBox) { return null; } point.x += parentBox.left; point.y += parentBox.top; frame = parentFrame; } catch (e_5) { env_5.error = e_5; env_5.hasError = true; } finally { __disposeResources(env_5); } } return point; } /** * This method scrolls element into view if needed, and then uses * {@link Page.(screenshot:3) } to take a screenshot of the element. * If the element is detached from DOM, the method throws an error. */ async screenshot(options = {}) { const env_6 = { stack: [], error: void 0, hasError: false }; try { const { scrollIntoView = true, captureBeyondViewport = true, allowViewportExpansion = captureBeyondViewport, } = options; let clip = await this.#nonEmptyVisibleBoundingBox(); const page = this.frame.page(); // eslint-disable-next-line @typescript-eslint/no-unused-vars const _ = __addDisposableResource(env_6, allowViewportExpansion && clip ? await page._createTemporaryViewportContainingBox(clip) : null, true); if (scrollIntoView) { await this.scrollIntoViewIfNeeded(); // We measure again just in case. clip = await this.#nonEmptyVisibleBoundingBox(); } const [pageLeft, pageTop] = await this.evaluate(() => { if (!window.visualViewport) { throw new Error('window.visualViewport is not supported.'); } return [ window.visualViewport.pageLeft, window.visualViewport.pageTop, ]; }); clip.x += pageLeft; clip.y += pageTop; return await page.screenshot({ ...options, captureBeyondViewport: false, clip, }); } catch (e_6) { env_6.error = e_6; env_6.hasError = true; } finally { const result_1 = __disposeResources(env_6); if (result_1) await result_1; } } async #nonEmptyVisibleBoundingBox() { const box = await this.boundingBox(); (0, assert_js_1.assert)(box, 'Node is either not visible or not an HTMLElement'); (0, assert_js_1.assert)(box.width !== 0, 'Node has 0 width.'); (0, assert_js_1.assert)(box.height !== 0, 'Node has 0 height.'); return box; } /** * @internal */ async assertConnectedElement() { const error = await this.evaluate(async (element) => { if (!element.isConnected) { return 'Node is detached from document'; } if (element.nodeType !== Node.ELEMENT_NODE) { return 'Node is not of type HTMLElement'; } return; }); if (error) { throw new Error(error); } } /** * @internal */ async scrollIntoViewIfNeeded() { if (await this.isIntersectingViewport({ threshold: 1, })) { return; } await this.scrollIntoView(); } /** * Resolves to true if the element is visible in the current viewport. If an * element is an SVG, we check if the svg owner element is in the viewport * instead. See https://crbug.com/963246. * * @param options - Threshold for the intersection between 0 (no intersection) and 1 * (full intersection). Defaults to 1. */ async isIntersectingViewport(options = {}) { const env_7 = { stack: [], error: void 0, hasError: false }; try { await this.assertConnectedElement(); // eslint-disable-next-line rulesdir/use-using -- Returns `this`. const handle = await this.#asSVGElementHandle(); const target = __addDisposableResource(env_7, handle && (await handle.#getOwnerSVGElement()), false); return await (target ?? this).evaluate(async (element, threshold) => { const visibleRatio = await new Promise(resolve => { const observer = new IntersectionObserver(entries => { resolve(entries[0].intersectionRatio); observer.disconnect(); }); observer.observe(element); }); return threshold === 1 ? visibleRatio === 1 : visibleRatio > threshold; }, options.threshold ?? 0); } catch (e_7) { env_7.error = e_7; env_7.hasError = true; } finally { __disposeResources(env_7); } } /** * Scrolls the element into view using either the automation protocol client * or by calling element.scrollIntoView. */ async scrollIntoView() { await this.assertConnectedElement(); await this.evaluate(async (element) => { element.scrollIntoView({ block: 'center', inline: 'center', behavior: 'instant', }); }); } /** * Returns true if an element is an SVGElement (included svg, path, rect * etc.). */ async #asSVGElementHandle() { if (await this.evaluate(element => { return element instanceof SVGElement; })) { return this; } else { return null; } } async #getOwnerSVGElement() { // SVGSVGElement.ownerSVGElement === null. return await this.evaluateHandle(element => { if (element instanceof SVGSVGElement) { return element; } return element.ownerSVGElement; }); } }; })(); exports.ElementHandle = ElementHandle; function intersectBoundingBox(box, width, height) { box.width = Math.max(box.x >= 0 ? Math.min(width - box.x, box.width) : Math.min(width, box.width + box.x), 0); box.height = Math.max(box.y >= 0 ? Math.min(height - box.y, box.height) : Math.min(height, box.height + box.y), 0); } //# sourceMappingURL=ElementHandle.js.map