123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737
/// <reference types="./Input.d.ts" />/** * Copyright 2017 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 __classPrivateFieldSet = (this && this.__classPrivateFieldSet) ||  function (receiver, state, value, kind, f) {    if (kind === "m") throw new TypeError("Private method is not writable");    if (kind === "a" && !f) {      throw new TypeError("Private accessor was defined without a setter");    }    if (      typeof state === "function"        ? receiver !== state || !f        : !state.has(receiver)    ) {      throw new TypeError(        "Cannot write private member to an object whose class did not declare it",      );    }    return (kind === "a"      ? f.call(receiver, value)      : f      ? f.value = value      : state.set(receiver, value)),      value;  };var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) ||  function (receiver, state, kind, f) {    if (kind === "a" && !f) {      throw new TypeError("Private accessor was defined without a getter");    }    if (      typeof state === "function"        ? receiver !== state || !f        : !state.has(receiver)    ) {      throw new TypeError(        "Cannot read private member from an object whose class did not declare it",      );    }    return kind === "m"      ? f      : kind === "a"      ? f.call(receiver)      : f      ? f.value      : state.get(receiver);  };var _Keyboard_instances,  _Keyboard_client,  _Keyboard_pressedKeys,  _Keyboard_modifierBit,  _Keyboard_keyDescriptionForString,  _Mouse_client,  _Mouse_keyboard,  _Mouse_x,  _Mouse_y,  _Mouse_button,  _Touchscreen_client,  _Touchscreen_keyboard;import { assert } from "../util/assert.js";import { _keyDefinitions } from "./USKeyboardLayout.js";/** * Keyboard provides an api for managing a virtual keyboard. * The high level api is {@link Keyboard."type"}, * which takes raw characters and generates proper keydown, keypress/input, * and keyup events on your page. * * @remarks * For finer control, you can use {@link Keyboard.down}, * {@link Keyboard.up}, and {@link Keyboard.sendCharacter} * to manually fire events as if they were generated from a real keyboard. * * On MacOS, keyboard shortcuts like `⌘ A` -\> Select All do not work. * See {@link https://github.com/puppeteer/puppeteer/issues/1313 | #1313}. * * @example * An example of holding down `Shift` in order to select and delete some text: * * ```ts * await page.keyboard.type('Hello World!'); * await page.keyboard.press('ArrowLeft'); * * await page.keyboard.down('Shift'); * for (let i = 0; i < ' World'.length; i++) *   await page.keyboard.press('ArrowLeft'); * await page.keyboard.up('Shift'); * * await page.keyboard.press('Backspace'); * // Result text will end up saying 'Hello!' * ``` * * @example * An example of pressing `A` * * ```ts * await page.keyboard.down('Shift'); * await page.keyboard.press('KeyA'); * await page.keyboard.up('Shift'); * ``` * * @public */export class Keyboard {  /**   * @internal   */  constructor(client) {    _Keyboard_instances.add(this);    _Keyboard_client.set(this, void 0);    _Keyboard_pressedKeys.set(this, new Set());    /**     * @internal     */    this._modifiers = 0;    __classPrivateFieldSet(this, _Keyboard_client, client, "f");  }  /**   * Dispatches a `keydown` event.   *   * @remarks   * If `key` is a single character and no modifier keys besides `Shift`   * are being held down, a `keypress`/`input` event will also generated.   * The `text` option can be specified to force an input event to be generated.   * If `key` is a modifier key, `Shift`, `Meta`, `Control`, or `Alt`,   * subsequent key presses will be sent with that modifier active.   * To release the modifier key, use {@link Keyboard.up}.   *   * After the key is pressed once, subsequent calls to   * {@link Keyboard.down} will have   * {@link https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/repeat | repeat}   * set to true. To release the key, use {@link Keyboard.up}.   *   * Modifier keys DO influence {@link Keyboard.down}.   * 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.   *   * @param options - An object of options. Accepts text which, if specified,   * generates an input event with this text.   */  async down(key, options = { text: undefined }) {    const description = __classPrivateFieldGet(      this,      _Keyboard_instances,      "m",      _Keyboard_keyDescriptionForString,    ).call(this, key);    const autoRepeat = __classPrivateFieldGet(this, _Keyboard_pressedKeys, "f")      .has(description.code);    __classPrivateFieldGet(this, _Keyboard_pressedKeys, "f").add(      description.code,    );    this._modifiers |= __classPrivateFieldGet(      this,      _Keyboard_instances,      "m",      _Keyboard_modifierBit,    ).call(this, description.key);    const text = options.text === undefined ? description.text : options.text;    await __classPrivateFieldGet(this, _Keyboard_client, "f").send(      "Input.dispatchKeyEvent",      {        type: text ? "keyDown" : "rawKeyDown",        modifiers: this._modifiers,        windowsVirtualKeyCode: description.keyCode,        code: description.code,        key: description.key,        text: text,        unmodifiedText: text,        autoRepeat,        location: description.location,        isKeypad: description.location === 3,      },    );  }  /**   * Dispatches a `keyup` event.   *   * @param key - Name of key to release, such as `ArrowLeft`.   * See {@link KeyInput | KeyInput}   * for a list of all key names.   */  async up(key) {    const description = __classPrivateFieldGet(      this,      _Keyboard_instances,      "m",      _Keyboard_keyDescriptionForString,    ).call(this, key);    this._modifiers &= ~__classPrivateFieldGet(      this,      _Keyboard_instances,      "m",      _Keyboard_modifierBit,    ).call(this, description.key);    __classPrivateFieldGet(this, _Keyboard_pressedKeys, "f").delete(      description.code,    );    await __classPrivateFieldGet(this, _Keyboard_client, "f").send(      "Input.dispatchKeyEvent",      {        type: "keyUp",        modifiers: this._modifiers,        key: description.key,        windowsVirtualKeyCode: description.keyCode,        code: description.code,        location: description.location,      },    );  }  /**   * Dispatches a `keypress` and `input` event.   * This does not send a `keydown` or `keyup` event.   *   * @remarks   * Modifier keys DO NOT effect {@link Keyboard.sendCharacter | Keyboard.sendCharacter}.   * Holding down `Shift` will not type the text in upper case.   *   * @example   *   * ```ts   * page.keyboard.sendCharacter('嗨');   * ```   *   * @param char - Character to send into the page.   */  async sendCharacter(char) {    await __classPrivateFieldGet(this, _Keyboard_client, "f").send(      "Input.insertText",      { text: char },    );  }  charIsKey(char) {    return !!_keyDefinitions[char];  }  /**   * Sends a `keydown`, `keypress`/`input`,   * and `keyup` event for each character in the text.   *   * @remarks   * To press a special key, like `Control` or `ArrowDown`,   * use {@link Keyboard.press}.   *   * Modifier keys DO NOT effect `keyboard.type`.   * Holding down `Shift` will not type the text in upper case.   *   * @example   *   * ```ts   * await page.keyboard.type('Hello'); // Types instantly   * await page.keyboard.type('World', {delay: 100}); // Types slower, like a user   * ```   *   * @param text - A text to type into a focused element.   * @param options - An object of options. Accepts delay which,   * if specified, is the time to wait between `keydown` and `keyup` in milliseconds.   * Defaults to 0.   */  async type(text, options = {}) {    const delay = options.delay || undefined;    for (const char of text) {      if (this.charIsKey(char)) {        await this.press(char, { delay });      } else {        if (delay) {          await new Promise((f) => {            return setTimeout(f, delay);          });        }        await this.sendCharacter(char);      }    }  }  /**   * Shortcut for {@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 generated.   * The `text` option can be specified to force an input event to be generated.   *   * Modifier keys DO effect {@link Keyboard.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.   *   * @param options - An object of options. Accepts text which, if specified,   * generates an input event with this text. Accepts delay which,   * if specified, is the time to wait between `keydown` and `keyup` in milliseconds.   * Defaults to 0.   */  async press(key, options = {}) {    const { delay = null } = options;    await this.down(key, options);    if (delay) {      await new Promise((f) => {        return setTimeout(f, options.delay);      });    }    await this.up(key);  }}_Keyboard_client = new WeakMap(),  _Keyboard_pressedKeys = new WeakMap(),  _Keyboard_instances = new WeakSet(),  _Keyboard_modifierBit = function _Keyboard_modifierBit(key) {    if (key === "Alt") {      return 1;    }    if (key === "Control") {      return 2;    }    if (key === "Meta") {      return 4;    }    if (key === "Shift") {      return 8;    }    return 0;  },  _Keyboard_keyDescriptionForString =    function _Keyboard_keyDescriptionForString(keyString) {      const shift = this._modifiers & 8;      const description = {        key: "",        keyCode: 0,        code: "",        text: "",        location: 0,      };      const definition = _keyDefinitions[keyString];      assert(definition, `Unknown key: "${keyString}"`);      if (definition.key) {        description.key = definition.key;      }      if (shift && definition.shiftKey) {        description.key = definition.shiftKey;      }      if (definition.keyCode) {        description.keyCode = definition.keyCode;      }      if (shift && definition.shiftKeyCode) {        description.keyCode = definition.shiftKeyCode;      }      if (definition.code) {        description.code = definition.code;      }      if (definition.location) {        description.location = definition.location;      }      if (description.key.length === 1) {        description.text = description.key;      }      if (definition.text) {        description.text = definition.text;      }      if (shift && definition.shiftText) {        description.text = definition.shiftText;      }      // if any modifiers besides shift are pressed, no text should be sent      if (this._modifiers & ~8) {        description.text = "";      }      return description;    };/** * The Mouse class operates in main-frame CSS pixels * relative to the top-left corner of the viewport. * @remarks * Every `page` object has its own Mouse, accessible with [`page.mouse`](#pagemouse). * * @example * * ```ts * // Using ‘page.mouse’ to trace a 100x100 square. * await page.mouse.move(0, 0); * await page.mouse.down(); * await page.mouse.move(0, 100); * await page.mouse.move(100, 100); * await page.mouse.move(100, 0); * await page.mouse.move(0, 0); * await page.mouse.up(); * ``` * * **Note**: The mouse events trigger synthetic `MouseEvent`s. * This means that it does not fully replicate the functionality of what a normal user * would be able to do with their mouse. * * For example, dragging and selecting text is not possible using `page.mouse`. * Instead, you can use the {@link https://developer.mozilla.org/en-US/docs/Web/API/DocumentOrShadowRoot/getSelection | `DocumentOrShadowRoot.getSelection()`} functionality implemented in the platform. * * @example * For example, if you want to select all content between nodes: * * ```ts * await page.evaluate( *   (from, to) => { *     const selection = from.getRootNode().getSelection(); *     const range = document.createRange(); *     range.setStartBefore(from); *     range.setEndAfter(to); *     selection.removeAllRanges(); *     selection.addRange(range); *   }, *   fromJSHandle, *   toJSHandle * ); * ``` * * If you then would want to copy-paste your selection, you can use the clipboard api: * * ```ts * // The clipboard api does not allow you to copy, unless the tab is focused. * await page.bringToFront(); * await page.evaluate(() => { *   // Copy the selected content to the clipboard *   document.execCommand('copy'); *   // Obtain the content of the clipboard as a string *   return navigator.clipboard.readText(); * }); * ``` * * **Note**: If you want access to the clipboard API, * you have to give it permission to do so: * * ```ts * await browser *   .defaultBrowserContext() *   .overridePermissions('<your origin>', [ *     'clipboard-read', *     'clipboard-write', *   ]); * ``` * * @public */export class Mouse {  /**   * @internal   */  constructor(client, keyboard) {    _Mouse_client.set(this, void 0);    _Mouse_keyboard.set(this, void 0);    _Mouse_x.set(this, 0);    _Mouse_y.set(this, 0);    _Mouse_button.set(this, "none");    __classPrivateFieldSet(this, _Mouse_client, client, "f");    __classPrivateFieldSet(this, _Mouse_keyboard, keyboard, "f");  }  /**   * Dispatches a `mousemove` event.   * @param x - Horizontal position of the mouse.   * @param y - Vertical position of the mouse.   * @param options - Optional object. If specified, the `steps` property   * sends intermediate `mousemove` events when set to `1` (default).   */  async move(x, y, options = {}) {    const { steps = 1 } = options;    const fromX = __classPrivateFieldGet(this, _Mouse_x, "f"),      fromY = __classPrivateFieldGet(this, _Mouse_y, "f");    __classPrivateFieldSet(this, _Mouse_x, x, "f");    __classPrivateFieldSet(this, _Mouse_y, y, "f");    for (let i = 1; i <= steps; i++) {      await __classPrivateFieldGet(this, _Mouse_client, "f").send(        "Input.dispatchMouseEvent",        {          type: "mouseMoved",          button: __classPrivateFieldGet(this, _Mouse_button, "f"),          x: fromX +            (__classPrivateFieldGet(this, _Mouse_x, "f") - fromX) * (i / steps),          y: fromY +            (__classPrivateFieldGet(this, _Mouse_y, "f") - fromY) * (i / steps),          modifiers:            __classPrivateFieldGet(this, _Mouse_keyboard, "f")._modifiers,        },      );    }  }  /**   * Shortcut for `mouse.move`, `mouse.down` and `mouse.up`.   * @param x - Horizontal position of the mouse.   * @param y - Vertical position of the mouse.   * @param options - Optional `MouseOptions`.   */  async click(x, y, options = {}) {    const { delay = null } = options;    if (delay !== null) {      await this.move(x, y);      await this.down(options);      await new Promise((f) => {        return setTimeout(f, delay);      });      await this.up(options);    } else {      await this.move(x, y);      await this.down(options);      await this.up(options);    }  }  /**   * Dispatches a `mousedown` event.   * @param options - Optional `MouseOptions`.   */  async down(options = {}) {    const { button = "left", clickCount = 1 } = options;    __classPrivateFieldSet(this, _Mouse_button, button, "f");    await __classPrivateFieldGet(this, _Mouse_client, "f").send(      "Input.dispatchMouseEvent",      {        type: "mousePressed",        button,        x: __classPrivateFieldGet(this, _Mouse_x, "f"),        y: __classPrivateFieldGet(this, _Mouse_y, "f"),        modifiers:          __classPrivateFieldGet(this, _Mouse_keyboard, "f")._modifiers,        clickCount,      },    );  }  /**   * Dispatches a `mouseup` event.   * @param options - Optional `MouseOptions`.   */  async up(options = {}) {    const { button = "left", clickCount = 1 } = options;    __classPrivateFieldSet(this, _Mouse_button, "none", "f");    await __classPrivateFieldGet(this, _Mouse_client, "f").send(      "Input.dispatchMouseEvent",      {        type: "mouseReleased",        button,        x: __classPrivateFieldGet(this, _Mouse_x, "f"),        y: __classPrivateFieldGet(this, _Mouse_y, "f"),        modifiers:          __classPrivateFieldGet(this, _Mouse_keyboard, "f")._modifiers,        clickCount,      },    );  }  /**   * Dispatches a `mousewheel` event.   * @param options - Optional: `MouseWheelOptions`.   *   * @example   * An example of zooming into an element:   *   * ```ts   * await page.goto(   *   'https://mdn.mozillademos.org/en-US/docs/Web/API/Element/wheel_event$samples/Scaling_an_element_via_the_wheel?revision=1587366'   * );   *   * const elem = await page.$('div');   * const boundingBox = await elem.boundingBox();   * await page.mouse.move(   *   boundingBox.x + boundingBox.width / 2,   *   boundingBox.y + boundingBox.height / 2   * );   *   * await page.mouse.wheel({deltaY: -100});   * ```   */  async wheel(options = {}) {    const { deltaX = 0, deltaY = 0 } = options;    await __classPrivateFieldGet(this, _Mouse_client, "f").send(      "Input.dispatchMouseEvent",      {        type: "mouseWheel",        x: __classPrivateFieldGet(this, _Mouse_x, "f"),        y: __classPrivateFieldGet(this, _Mouse_y, "f"),        deltaX,        deltaY,        modifiers:          __classPrivateFieldGet(this, _Mouse_keyboard, "f")._modifiers,        pointerType: "mouse",      },    );  }  /**   * Dispatches a `drag` event.   * @param start - starting point for drag   * @param target - point to drag to   */  async drag(start, target) {    const promise = new Promise((resolve) => {      __classPrivateFieldGet(this, _Mouse_client, "f").once(        "Input.dragIntercepted",        (event) => {          return resolve(event.data);        },      );    });    await this.move(start.x, start.y);    await this.down();    await this.move(target.x, target.y);    return promise;  }  /**   * Dispatches a `dragenter` event.   * @param target - point for emitting `dragenter` event   * @param data - drag data containing items and operations mask   */  async dragEnter(target, data) {    await __classPrivateFieldGet(this, _Mouse_client, "f").send(      "Input.dispatchDragEvent",      {        type: "dragEnter",        x: target.x,        y: target.y,        modifiers:          __classPrivateFieldGet(this, _Mouse_keyboard, "f")._modifiers,        data,      },    );  }  /**   * Dispatches a `dragover` event.   * @param target - point for emitting `dragover` event   * @param data - drag data containing items and operations mask   */  async dragOver(target, data) {    await __classPrivateFieldGet(this, _Mouse_client, "f").send(      "Input.dispatchDragEvent",      {        type: "dragOver",        x: target.x,        y: target.y,        modifiers:          __classPrivateFieldGet(this, _Mouse_keyboard, "f")._modifiers,        data,      },    );  }  /**   * Performs a dragenter, dragover, and drop in sequence.   * @param target - point to drop on   * @param data - drag data containing items and operations mask   */  async drop(target, data) {    await __classPrivateFieldGet(this, _Mouse_client, "f").send(      "Input.dispatchDragEvent",      {        type: "drop",        x: target.x,        y: target.y,        modifiers:          __classPrivateFieldGet(this, _Mouse_keyboard, "f")._modifiers,        data,      },    );  }  /**   * Performs a drag, dragenter, dragover, and drop in sequence.   * @param target - point to drag from   * @param target - point to drop on   * @param options - An object of options. Accepts delay which,   * if specified, is the time to wait between `dragover` and `drop` in milliseconds.   * Defaults to 0.   */  async dragAndDrop(start, target, options = {}) {    const { delay = null } = options;    const data = await this.drag(start, target);    await this.dragEnter(target, data);    await this.dragOver(target, data);    if (delay) {      await new Promise((resolve) => {        return setTimeout(resolve, delay);      });    }    await this.drop(target, data);    await this.up();  }}_Mouse_client = new WeakMap(),  _Mouse_keyboard = new WeakMap(),  _Mouse_x = new WeakMap(),  _Mouse_y = new WeakMap(),  _Mouse_button = new WeakMap();/** * The Touchscreen class exposes touchscreen events. * @public */export class Touchscreen {  /**   * @internal   */  constructor(client, keyboard) {    _Touchscreen_client.set(this, void 0);    _Touchscreen_keyboard.set(this, void 0);    __classPrivateFieldSet(this, _Touchscreen_client, client, "f");    __classPrivateFieldSet(this, _Touchscreen_keyboard, keyboard, "f");  }  /**   * Dispatches a `touchstart` and `touchend` event.   * @param x - Horizontal position of the tap.   * @param y - Vertical position of the tap.   */  async tap(x, y) {    const touchPoints = [{ x: Math.round(x), y: Math.round(y) }];    await __classPrivateFieldGet(this, _Touchscreen_client, "f").send(      "Input.dispatchTouchEvent",      {        type: "touchStart",        touchPoints,        modifiers:          __classPrivateFieldGet(this, _Touchscreen_keyboard, "f")._modifiers,      },    );    await __classPrivateFieldGet(this, _Touchscreen_client, "f").send(      "Input.dispatchTouchEvent",      {        type: "touchEnd",        touchPoints: [],        modifiers:          __classPrivateFieldGet(this, _Touchscreen_keyboard, "f")._modifiers,      },    );  }}_Touchscreen_client = new WeakMap(), _Touchscreen_keyboard = new WeakMap();//# sourceMappingURL=Input.js.map