thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix!: remove puppeteer.devices in favor of KnownDevices (#9075)

Browse Source 
This PR removes the deprecated `puppeteer.devices` in favor of a new
exported object `KnownDevices`. `devices` can also be exported, but has
been deprecated.
This commit is contained in:
jrandolf 2022-10-10 15:30:12 +02:00 committed by GitHub
parent 04270a39ea
commit 87c08fd86a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 378 additions and 244 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/api/index.md
View File

@ -120,19 +120,20 @@ sidebar_label: API
## Variables
| Variable | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [connect](./puppeteer.connect.md) | |
| [createBrowserFetcher](./puppeteer.createbrowserfetcher.md) | |
| [DEFAULT_INTERCEPT_RESOLUTION_PRIORITY](./puppeteer.default_intercept_resolution_priority.md) | The default cooperative request interception resolution priority |
| [defaultArgs](./puppeteer.defaultargs.md) | |
| [devices](./puppeteer.devices.md) | A list of devices to be used with <code>page.emulate(options)</code>. Actual list of devices can be found in [src/common/DeviceDescriptors.ts](https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts). |
| [errors](./puppeteer.errors.md) | |
| [EVALUATION_SCRIPT_URL](./puppeteer.evaluation_script_url.md) | |
| [executablePath](./puppeteer.executablepath.md) | |
| [launch](./puppeteer.launch.md) | |
| [networkConditions](./puppeteer.networkconditions.md) | |
| [PredefinedNetworkConditions](./puppeteer.predefinednetworkconditions.md) | A list of network conditions to be used with [Page.emulateNetworkConditions()](./puppeteer.page.emulatenetworkconditions.md). |
| Variable | Description |
| --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| [connect](./puppeteer.connect.md) | |
| [createBrowserFetcher](./puppeteer.createbrowserfetcher.md) | |
| [DEFAULT_INTERCEPT_RESOLUTION_PRIORITY](./puppeteer.default_intercept_resolution_priority.md) | The default cooperative request interception resolution priority |
| [defaultArgs](./puppeteer.defaultargs.md) | |
| [devices](./puppeteer.devices.md) | |
| [errors](./puppeteer.errors.md) | |
| [EVALUATION_SCRIPT_URL](./puppeteer.evaluation_script_url.md) | |
| [executablePath](./puppeteer.executablepath.md) | |
| [KnownDevices](./puppeteer.knowndevices.md) | A list of devices to be used with [Page.emulate()](./puppeteer.page.emulate.md). |
| [launch](./puppeteer.launch.md) | |
| [networkConditions](./puppeteer.networkconditions.md) | |
| [PredefinedNetworkConditions](./puppeteer.predefinednetworkconditions.md) | A list of network conditions to be used with [Page.emulateNetworkConditions()](./puppeteer.page.emulatenetworkconditions.md). |
## Type Aliases
@ -142,7 +143,6 @@ sidebar_label: API
| [Awaitable](./puppeteer.awaitable.md) | |
| [ChromeReleaseChannel](./puppeteer.chromereleasechannel.md) | |
| [ConsoleMessageType](./puppeteer.consolemessagetype.md) | The supported types for console messages. |
| [DevicesMap](./puppeteer.devicesmap.md) | |
| [ErrorCode](./puppeteer.errorcode.md) | |
| [EvaluateFunc](./puppeteer.evaluatefunc.md) | |
| [EventType](./puppeteer.eventtype.md) | |

9
docs/api/puppeteer.device.md
View File

@ -12,8 +12,7 @@ export interface Device
## Properties
| Property | Modifiers | Type | Description |
| -------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [name](./puppeteer.device.name.md) | | string | |
| [userAgent](./puppeteer.device.useragent.md) | | string | |
| [viewport](./puppeteer.device.viewport.md) | | { width: number; height: number; deviceScaleFactor: number; isMobile: boolean; hasTouch: boolean; isLandscape: boolean; } | |
| Property | Modifiers | Type | Description |
| -------------------------------------------- | --------- | ----------------------------------- | ----------- |
| [userAgent](./puppeteer.device.useragent.md) | | string | |
| [viewport](./puppeteer.device.viewport.md) | | [Viewport](./puppeteer.viewport.md) | |

13
docs/api/puppeteer.device.name.md
View File

@ -1,13 +0,0 @@
---
sidebar_label: Device.name
---
# Device.name property
**Signature:**
```typescript
interface Device {
name: string;
}
```

9
docs/api/puppeteer.device.viewport.md
View File

@ -8,13 +8,6 @@ sidebar_label: Device.viewport
```typescript
interface Device {
viewport: {
width: number;
height: number;
deviceScaleFactor: number;
isMobile: boolean;
hasTouch: boolean;
isLandscape: boolean;
};
viewport: Viewport;
}
```

141
docs/api/puppeteer.devices.md
View File

@ -4,26 +4,131 @@ sidebar_label: devices
# devices variable
A list of devices to be used with `page.emulate(options)`. Actual list of devices can be found in [src/common/DeviceDescriptors.ts](https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts).
> Warning: This API is now obsolete.
>
> Import [KnownDevices](./puppeteer.knowndevices.md)
**Signature:**
```typescript
devices: DevicesMap;
```
## Example
```ts
const puppeteer = require('puppeteer');
const iPhone = puppeteer.devices['iPhone 6'];
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.emulate(iPhone);
await page.goto('https://www.google.com');
// other actions...
await browser.close();
})();
devices: Readonly<
Record<
| 'Blackberry PlayBook'
| 'Blackberry PlayBook landscape'
| 'BlackBerry Z30'
| 'BlackBerry Z30 landscape'
| 'Galaxy Note 3'
| 'Galaxy Note 3 landscape'
| 'Galaxy Note II'
| 'Galaxy Note II landscape'
| 'Galaxy S III'
| 'Galaxy S III landscape'
| 'Galaxy S5'
| 'Galaxy S5 landscape'
| 'Galaxy S8'
| 'Galaxy S8 landscape'
| 'Galaxy S9+'
| 'Galaxy S9+ landscape'
| 'Galaxy Tab S4'
| 'Galaxy Tab S4 landscape'
| 'iPad'
| 'iPad landscape'
| 'iPad (gen 6)'
| 'iPad (gen 6) landscape'
| 'iPad (gen 7)'
| 'iPad (gen 7) landscape'
| 'iPad Mini'
| 'iPad Mini landscape'
| 'iPad Pro'
| 'iPad Pro landscape'
| 'iPad Pro 11'
| 'iPad Pro 11 landscape'
| 'iPhone 4'
| 'iPhone 4 landscape'
| 'iPhone 5'
| 'iPhone 5 landscape'
| 'iPhone 6'
| 'iPhone 6 landscape'
| 'iPhone 6 Plus'
| 'iPhone 6 Plus landscape'
| 'iPhone 7'
| 'iPhone 7 landscape'
| 'iPhone 7 Plus'
| 'iPhone 7 Plus landscape'
| 'iPhone 8'
| 'iPhone 8 landscape'
| 'iPhone 8 Plus'
| 'iPhone 8 Plus landscape'
| 'iPhone SE'
| 'iPhone SE landscape'
| 'iPhone X'
| 'iPhone X landscape'
| 'iPhone XR'
| 'iPhone XR landscape'
| 'iPhone 11'
| 'iPhone 11 landscape'
| 'iPhone 11 Pro'
| 'iPhone 11 Pro landscape'
| 'iPhone 11 Pro Max'
| 'iPhone 11 Pro Max landscape'
| 'iPhone 12'
| 'iPhone 12 landscape'
| 'iPhone 12 Pro'
| 'iPhone 12 Pro landscape'
| 'iPhone 12 Pro Max'
| 'iPhone 12 Pro Max landscape'
| 'iPhone 12 Mini'
| 'iPhone 12 Mini landscape'
| 'iPhone 13'
| 'iPhone 13 landscape'
| 'iPhone 13 Pro'
| 'iPhone 13 Pro landscape'
| 'iPhone 13 Pro Max'
| 'iPhone 13 Pro Max landscape'
| 'iPhone 13 Mini'
| 'iPhone 13 Mini landscape'
| 'JioPhone 2'
| 'JioPhone 2 landscape'
| 'Kindle Fire HDX'
| 'Kindle Fire HDX landscape'
| 'LG Optimus L70'
| 'LG Optimus L70 landscape'
| 'Microsoft Lumia 550'
| 'Microsoft Lumia 950'
| 'Microsoft Lumia 950 landscape'
| 'Nexus 10'
| 'Nexus 10 landscape'
| 'Nexus 4'
| 'Nexus 4 landscape'
| 'Nexus 5'
| 'Nexus 5 landscape'
| 'Nexus 5X'
| 'Nexus 5X landscape'
| 'Nexus 6'
| 'Nexus 6 landscape'
| 'Nexus 6P'
| 'Nexus 6P landscape'
| 'Nexus 7'
| 'Nexus 7 landscape'
| 'Nokia Lumia 520'
| 'Nokia Lumia 520 landscape'
| 'Nokia N9'
| 'Nokia N9 landscape'
| 'Pixel 2'
| 'Pixel 2 landscape'
| 'Pixel 2 XL'
| 'Pixel 2 XL landscape'
| 'Pixel 3'
| 'Pixel 3 landscape'
| 'Pixel 4'
| 'Pixel 4 landscape'
| 'Pixel 4a (5G)'
| 'Pixel 4a (5G) landscape'
| 'Pixel 5'
| 'Pixel 5 landscape'
| 'Moto G4'
| 'Moto G4 landscape',
Device
>
>;
```

15
docs/api/puppeteer.devicesmap.md
View File

@ -1,15 +0,0 @@
---
sidebar_label: DevicesMap
---
# DevicesMap type
**Signature:**
```typescript
export declare type DevicesMap = {
[name: string]: Device;
};
```
**References:** [Device](./puppeteer.device.md)

148
docs/api/puppeteer.knowndevices.md Normal file
View File

@ -0,0 +1,148 @@
---
sidebar_label: KnownDevices
---
# KnownDevices variable
A list of devices to be used with [Page.emulate()](./puppeteer.page.emulate.md).
**Signature:**
```typescript
KnownDevices: Readonly<
Record<
| 'Blackberry PlayBook'
| 'Blackberry PlayBook landscape'
| 'BlackBerry Z30'
| 'BlackBerry Z30 landscape'
| 'Galaxy Note 3'
| 'Galaxy Note 3 landscape'
| 'Galaxy Note II'
| 'Galaxy Note II landscape'
| 'Galaxy S III'
| 'Galaxy S III landscape'
| 'Galaxy S5'
| 'Galaxy S5 landscape'
| 'Galaxy S8'
| 'Galaxy S8 landscape'
| 'Galaxy S9+'
| 'Galaxy S9+ landscape'
| 'Galaxy Tab S4'
| 'Galaxy Tab S4 landscape'
| 'iPad'
| 'iPad landscape'
| 'iPad (gen 6)'
| 'iPad (gen 6) landscape'
| 'iPad (gen 7)'
| 'iPad (gen 7) landscape'
| 'iPad Mini'
| 'iPad Mini landscape'
| 'iPad Pro'
| 'iPad Pro landscape'
| 'iPad Pro 11'
| 'iPad Pro 11 landscape'
| 'iPhone 4'
| 'iPhone 4 landscape'
| 'iPhone 5'
| 'iPhone 5 landscape'
| 'iPhone 6'
| 'iPhone 6 landscape'
| 'iPhone 6 Plus'
| 'iPhone 6 Plus landscape'
| 'iPhone 7'
| 'iPhone 7 landscape'
| 'iPhone 7 Plus'
| 'iPhone 7 Plus landscape'
| 'iPhone 8'
| 'iPhone 8 landscape'
| 'iPhone 8 Plus'
| 'iPhone 8 Plus landscape'
| 'iPhone SE'
| 'iPhone SE landscape'
| 'iPhone X'
| 'iPhone X landscape'
| 'iPhone XR'
| 'iPhone XR landscape'
| 'iPhone 11'
| 'iPhone 11 landscape'
| 'iPhone 11 Pro'
| 'iPhone 11 Pro landscape'
| 'iPhone 11 Pro Max'
| 'iPhone 11 Pro Max landscape'
| 'iPhone 12'
| 'iPhone 12 landscape'
| 'iPhone 12 Pro'
| 'iPhone 12 Pro landscape'
| 'iPhone 12 Pro Max'
| 'iPhone 12 Pro Max landscape'
| 'iPhone 12 Mini'
| 'iPhone 12 Mini landscape'
| 'iPhone 13'
| 'iPhone 13 landscape'
| 'iPhone 13 Pro'
| 'iPhone 13 Pro landscape'
| 'iPhone 13 Pro Max'
| 'iPhone 13 Pro Max landscape'
| 'iPhone 13 Mini'
| 'iPhone 13 Mini landscape'
| 'JioPhone 2'
| 'JioPhone 2 landscape'
| 'Kindle Fire HDX'
| 'Kindle Fire HDX landscape'
| 'LG Optimus L70'
| 'LG Optimus L70 landscape'
| 'Microsoft Lumia 550'
| 'Microsoft Lumia 950'
| 'Microsoft Lumia 950 landscape'
| 'Nexus 10'
| 'Nexus 10 landscape'
| 'Nexus 4'
| 'Nexus 4 landscape'
| 'Nexus 5'
| 'Nexus 5 landscape'
| 'Nexus 5X'
| 'Nexus 5X landscape'
| 'Nexus 6'
| 'Nexus 6 landscape'
| 'Nexus 6P'
| 'Nexus 6P landscape'
| 'Nexus 7'
| 'Nexus 7 landscape'
| 'Nokia Lumia 520'
| 'Nokia Lumia 520 landscape'
| 'Nokia N9'
| 'Nokia N9 landscape'
| 'Pixel 2'
| 'Pixel 2 landscape'
| 'Pixel 2 XL'
| 'Pixel 2 XL landscape'
| 'Pixel 3'
| 'Pixel 3 landscape'
| 'Pixel 4'
| 'Pixel 4 landscape'
| 'Pixel 4a (5G)'
| 'Pixel 4a (5G) landscape'
| 'Pixel 5'
| 'Pixel 5 landscape'
| 'Moto G4'
| 'Moto G4 landscape',
Device
>
>;
```
## Example
```ts
import {KnownDevices} from 'puppeteer';
const iPhone = KnownDevices['iPhone 6'];
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.emulate(iPhone);
await page.goto('https://www.google.com');
// other actions...
await browser.close();
})();
```

19
docs/api/puppeteer.page.emulate.md
View File

@ -4,21 +4,23 @@ sidebar_label: Page.emulate
# Page.emulate() method
Emulates given device metrics and user agent.
Emulates a given device's metrics and user agent.
To aid emulation, Puppeteer provides a list of known devices that can be via [KnownDevices](./puppeteer.knowndevices.md).
**Signature:**
```typescript
class Page {
emulate(options: {viewport: Viewport; userAgent: string}): Promise<void>;
emulate(device: Device): Promise<void>;
}
```
## Parameters
| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------- | ----------- |
| options | { viewport: [Viewport](./puppeteer.viewport.md); userAgent: string; } | |
| Parameter | Type | Description |
| --------- | ------------------------------- | ----------- |
| device | [Device](./puppeteer.device.md) | |
**Returns:**
@ -26,13 +28,14 @@ Promise&lt;void&gt;
## Remarks
List of all available devices is available in the source code: [src/common/DeviceDescriptors.ts](https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts).
This method will resize the page. A lot of websites don't expect phones to change size, so you should emulate before navigating to the page.
## Example
```ts
const puppeteer = require('puppeteer');
const iPhone = puppeteer.devices['iPhone 6'];
import {KnownDevices} from 'puppeteer';
const iPhone = KnownDevices['iPhone 6'];
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();

2
docs/api/puppeteer.page.md
View File

@ -95,7 +95,7 @@ page.off('request', logRequest);
| [cookies(urls)](./puppeteer.page.cookies.md) | | If no URLs are specified, this method returns cookies for the current page URL. If URLs are specified, only cookies for those URLs are returned. |
| [createPDFStream(options)](./puppeteer.page.createpdfstream.md) | | Generates a PDF of the page with the <code>print</code> CSS media type. |
| [deleteCookie(cookies)](./puppeteer.page.deletecookie.md) | | |
| [emulate(options)](./puppeteer.page.emulate.md) | | Emulates given device metrics and user agent. |
| [emulate(device)](./puppeteer.page.emulate.md) | | <p>Emulates a given device's metrics and user agent.</p><p>To aid emulation, Puppeteer provides a list of known devices that can be via [KnownDevices](./puppeteer.knowndevices.md).</p> |
| [emulateCPUThrottling(factor)](./puppeteer.page.emulatecputhrottling.md) | | Enables CPU throttling to emulate slow CPUs. |
| [emulateIdleState(overrides)](./puppeteer.page.emulateidlestate.md) | | Emulates the idle state. If no arguments set, clears idle state emulation. |
| [emulateMediaFeatures(features)](./puppeteer.page.emulatemediafeatures.md) | | |

23
docs/api/puppeteer.puppeteer.devices.md
View File

@ -1,23 +0,0 @@
---
sidebar_label: Puppeteer.devices
---
# Puppeteer.devices property
> Warning: This API is now obsolete.
>
> Import directly puppeteer.
**Signature:**
```typescript
class Puppeteer {
get devices(): typeof devices;
}
```
## Example
```ts
import {devices} from 'puppeteer';
```

6
docs/api/puppeteer.puppeteer.md
View File

@ -18,12 +18,6 @@ export declare class Puppeteer
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Puppeteer` class.
## Properties
| Property | Modifiers | Type | Description |
| ------------------------------------------- | --------------------- | ---------------------------------------- | ----------- |
| [devices](./puppeteer.puppeteer.devices.md) | <code>readonly</code> | typeof [devices](./puppeteer.devices.md) | |
## Methods
| Method | Modifiers | Description |

39
packages/puppeteer-core/src/api/Page.ts
View File

@ -17,9 +17,9 @@
import {Protocol} from 'devtools-protocol';
import type {Readable} from 'stream';
import type {Accessibility} from '../common/Accessibility.js';
import type {Browser, BrowserContext} from './Browser.js';
import type {ConsoleMessage} from '../common/ConsoleMessage.js';
import type {Coverage} from '../common/Coverage.js';
import {Device} from '../common/Device.js';
import type {Dialog} from '../common/Dialog.js';
import type {ElementHandle} from '../common/ElementHandle.js';
import {EventEmitter, Handler} from '../common/EventEmitter.js';
@ -48,6 +48,7 @@ import type {Target} from '../common/Target.js';
import type {Tracing} from '../common/Tracing.js';
import type {EvaluateFunc, HandleFor, NodeFor} from '../common/types.js';
import type {WebWorker} from '../common/WebWorker.js';
import type {Browser, BrowserContext} from './Browser.js';
/**
* @public
@ -1656,20 +1657,25 @@ export class Page extends EventEmitter {
}
/**
* Emulates given device metrics and user agent.
* Emulates a given device's metrics and user agent.
*
* To aid emulation, Puppeteer provides a list of known devices that can be
* via {@link KnownDevices}.
*
* @remarks
* This method is a shortcut for calling two methods:
* {@link Page.setUserAgent} and {@link Page.setViewport} To aid emulation,
* Puppeteer provides a list of device descriptors that can be obtained via
* {@link devices}. `page.emulate` will resize the page. A lot of websites
* don't expect phones to change size, so you should emulate before navigating
* to the page.
* {@link Page.setUserAgent} and {@link Page.setViewport}.
*
* @remarks
* This method will resize the page. A lot of websites don't expect phones to
* change size, so you should emulate before navigating to the page.
*
* @example
*
* ```ts
* const puppeteer = require('puppeteer');
* const iPhone = puppeteer.devices['iPhone 6'];
* import {KnownDevices} from 'puppeteer';
* const iPhone = KnownDevices['iPhone 6'];
*
* (async () => {
* const browser = await puppeteer.launch();
* const page = await browser.newPage();
@ -1679,21 +1685,16 @@ export class Page extends EventEmitter {
* await browser.close();
* })();
* ```
*
* @remarks List of all available devices is available in the source code:
* {@link https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts | src/common/DeviceDescriptors.ts}.
*/
async emulate(options: {
viewport: Viewport;
userAgent: string;
}): Promise<void>;
async emulate(): Promise<void> {
throw new Error('Not implemented');
async emulate(device: Device): Promise<void> {
await Promise.all([
this.setUserAgent(device.userAgent),
this.setViewport(device.viewport),
]);
}
/**
* @param enabled - Whether or not to enable JavaScript on the page.
* @returns
* @remarks
* NOTE: changing this value won't affect scripts that have already been run.
* It will take full effect on the next navigation.

51
packages/puppeteer-core/src/common/DeviceDescriptors.ts → packages/puppeteer-core/src/common/Device.ts
View File

@ -14,23 +14,17 @@
* limitations under the License.
*/
import {Viewport} from './PuppeteerViewport.js';
/**
* @public
*/
export interface Device {
name: string;
userAgent: string;
viewport: {
width: number;
height: number;
deviceScaleFactor: number;
isMobile: boolean;
hasTouch: boolean;
isLandscape: boolean;
};
viewport: Viewport;
}
const deviceArray: Device[] = [
const knownDevices = [
{
name: 'Blackberry PlayBook',
userAgent:
@ -1526,23 +1520,25 @@ const deviceArray: Device[] = [
isLandscape: true,
},
},
];
] as const;
const knownDevicesByName = {} as Record<
typeof knownDevices[number]['name'],
Device
>;
for (const device of knownDevices) {
knownDevicesByName[device.name] = device;
}
/**
* @public
*/
export type DevicesMap = {
[name: string]: Device;
};
/**
* A list of devices to be used with `page.emulate(options)`. Actual list of devices can be found in {@link https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts | src/common/DeviceDescriptors.ts}.
* A list of devices to be used with {@link Page.emulate}.
*
* @example
*
* ```ts
* const puppeteer = require('puppeteer');
* const iPhone = puppeteer.devices['iPhone 6'];
* import {KnownDevices} from 'puppeteer';
* const iPhone = KnownDevices['iPhone 6'];
*
* (async () => {
* const browser = await puppeteer.launch();
@ -1556,10 +1552,11 @@ export type DevicesMap = {
*
* @public
*/
const devices: DevicesMap = {};
export const KnownDevices = Object.freeze(knownDevicesByName);
for (const device of deviceArray) {
devices[device.name] = device;
}
export {devices};
/**
* @deprecated Import {@link KnownDevices}
*
* @public
*/
export const devices = KnownDevices;

62
packages/puppeteer-core/src/common/Page.ts
View File

@ -16,6 +16,18 @@
import {Protocol} from 'devtools-protocol';
import type {Readable} from 'stream';
import type {Browser, BrowserContext} from '../api/Browser.js';
import {
GeolocationOptions,
MediaFeature,
Metrics,
Page,
PageEmittedEvents,
ScreenshotClip,
ScreenshotOptions,
WaitForOptions,
WaitTimeoutOptions,
} from '../api/Page.js';
import {assert} from '../util/assert.js';
import {
createDeferredPromise,
@ -23,7 +35,6 @@ import {
} from '../util/DeferredPromise.js';
import {isErrorLike} from '../util/ErrorLike.js';
import {Accessibility} from './Accessibility.js';
import type {Browser, BrowserContext} from '../api/Browser.js';
import {
CDPSession,
CDPSessionEmittedEvents,
@ -80,17 +91,6 @@ import {
waitWithTimeout,
} from './util.js';
import {WebWorker} from './WebWorker.js';
import {
Page,
PageEmittedEvents,
WaitForOptions,
Metrics,
ScreenshotClip,
ScreenshotOptions,
WaitTimeoutOptions,
GeolocationOptions,
MediaFeature,
} from '../api/Page.js';
/**
* @internal
@ -1932,44 +1932,6 @@ export class CDPPage extends Page {
await this.#client.send('Page.bringToFront');
}
/**
* Emulates given device metrics and user agent.
*
* @remarks
* This method is a shortcut for calling two methods:
* {@link Page.setUserAgent} and {@link Page.setViewport} To aid emulation,
* Puppeteer provides a list of device descriptors that can be obtained via
* {@link devices}. `page.emulate` will resize the page. A lot of websites
* don't expect phones to change size, so you should emulate before navigating
* to the page.
* @example
*
* ```ts
* const puppeteer = require('puppeteer');
* const iPhone = puppeteer.devices['iPhone 6'];
* (async () => {
* const browser = await puppeteer.launch();
* const page = await browser.newPage();
* await page.emulate(iPhone);
* await page.goto('https://www.google.com');
* // other actions...
* await browser.close();
* })();
* ```
*
* @remarks List of all available devices is available in the source code:
* {@link https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts | src/common/DeviceDescriptors.ts}.
*/
override async emulate(options: {
viewport: Viewport;
userAgent: string;
}): Promise<void> {
await Promise.all([
this.setViewport(options.viewport),
this.setUserAgent(options.userAgent),
]);
}
/**
* @param enabled - Whether or not to enable JavaScript on the page.
* @returns

13
packages/puppeteer-core/src/common/Puppeteer.ts
View File

@ -19,7 +19,6 @@ import {
_connectToCDPBrowser,
} from './BrowserConnector.js';
import {ConnectionTransport} from './ConnectionTransport.js';
import {devices} from './DeviceDescriptors.js';
import {
clearCustomQueryHandlers,
CustomQueryHandler,
@ -85,18 +84,6 @@ export class Puppeteer {
return _connectToCDPBrowser(options);
}
/**
* @deprecated Import directly puppeteer.
* @example
*
* ```ts
* import {devices} from 'puppeteer';
* ```
*/
get devices(): typeof devices {
return devices;
}
/**
* @deprecated Import directly puppeteer.
* @example

2
packages/puppeteer-core/src/puppeteer-core.ts
View File

@ -15,7 +15,7 @@
*/
export {Protocol} from 'devtools-protocol';
export * from './common/DeviceDescriptors.js';
export * from './common/Device.js';
export * from './common/Errors.js';
export * from './common/PredefinedNetworkConditions.js';
export * from './common/QueryHandler.js';

2
packages/puppeteer-core/src/types.ts
View File

@ -13,7 +13,7 @@ export * from './common/ConnectionTransport.js';
export * from './common/ConsoleMessage.js';
export * from './common/Coverage.js';
export * from './common/Debug.js';
export * from './common/DeviceDescriptors.js';
export * from './common/Device.js';
export * from './common/Dialog.js';
export * from './common/ElementHandle.js';
export * from './common/EmulationManager.js';

2
packages/puppeteer/src/puppeteer.ts
View File

@ -15,7 +15,7 @@
*/
export {Protocol} from 'devtools-protocol';
export * from 'puppeteer-core/internal/common/DeviceDescriptors.js';
export * from 'puppeteer-core/internal/common/Device.js';
export * from 'puppeteer-core/internal/common/Errors.js';
export * from 'puppeteer-core/internal/common/PredefinedNetworkConditions.js';
export * from 'puppeteer-core/internal/common/QueryHandler.js';

2
packages/puppeteer/src/types.ts
View File

@ -13,7 +13,7 @@ export * from 'puppeteer-core/internal/common/ConnectionTransport.js';
export * from 'puppeteer-core/internal/common/ConsoleMessage.js';
export * from 'puppeteer-core/internal/common/Coverage.js';
export * from 'puppeteer-core/internal/common/Debug.js';
export * from 'puppeteer-core/internal/common/DeviceDescriptors.js';
export * from 'puppeteer-core/internal/common/Device.js';
export * from 'puppeteer-core/internal/common/Dialog.js';
export * from 'puppeteer-core/internal/common/ElementHandle.js';
export * from 'puppeteer-core/internal/common/EmulationManager.js';

7
test/src/click.spec.ts
View File

@ -15,10 +15,11 @@
*/
import expect from 'expect';
import {KnownDevices} from 'puppeteer';
import {
getTestState,
setupTestPageAndContextHooks,
setupTestBrowserHooks,
setupTestPageAndContextHooks,
} from './mocha-utils.js';
import utils from './utils.js';
@ -278,9 +279,9 @@ describe('Page.click', function () {
});
// @see https://github.com/puppeteer/puppeteer/issues/161
it('should not hang with touch-enabled viewports', async () => {
const {page, puppeteer} = getTestState();
const {page} = getTestState();
await page.setViewport(puppeteer.devices['iPhone 6']!.viewport);
await page.setViewport(KnownDevices['iPhone 6'].viewport);
await page.mouse.down();
await page.mouse.move(100, 10);
await page.mouse.up();

14
test/src/emulation.spec.ts
View File

@ -15,25 +15,19 @@
*/
import expect from 'expect';
import {PredefinedNetworkConditions} from 'puppeteer';
import {Device} from 'puppeteer-core/internal/common/DeviceDescriptors.js';
import {KnownDevices, PredefinedNetworkConditions} from 'puppeteer';
import {
getTestState,
setupTestBrowserHooks,
setupTestPageAndContextHooks,
} from './mocha-utils.js';
const iPhone = KnownDevices['iPhone 6'];
const iPhoneLandscape = KnownDevices['iPhone 6 landscape'];
describe('Emulation', () => {
setupTestBrowserHooks();
setupTestPageAndContextHooks();
let iPhone!: Device;
let iPhoneLandscape!: Device;
before(() => {
const {puppeteer} = getTestState();
iPhone = puppeteer.devices['iPhone 6']!;
iPhoneLandscape = puppeteer.devices['iPhone 6 landscape']!;
});
describe('Page.viewport', function () {
it('should get the proper viewport size', async () => {

6
test/src/page.spec.ts
View File

@ -28,7 +28,7 @@ import {
} from './mocha-utils.js';
import utils, {attachFrame, waitEvent} from './utils.js';
import {CDPPage} from 'puppeteer-core/internal/common/Page.js';
import {TimeoutError} from 'puppeteer';
import {KnownDevices, TimeoutError} from 'puppeteer';
describe('Page', function () {
setupTestBrowserHooks();
@ -1357,7 +1357,7 @@ describe('Page', function () {
expect(request.headers['user-agent']).toBe('foobar');
});
it('should emulate device user-agent', async () => {
const {page, server, puppeteer} = getTestState();
const {page, server} = getTestState();
await page.goto(server.PREFIX + '/mobile.html');
expect(
@ -1365,7 +1365,7 @@ describe('Page', function () {
return navigator.userAgent;
})
).not.toContain('iPhone');
await page.setUserAgent(puppeteer.devices['iPhone 6']!.userAgent);
await page.setUserAgent(KnownDevices['iPhone 6'].userAgent);
expect(
await page.evaluate(() => {
return navigator.userAgent;

9
test/src/touchscreen.spec.ts
View File

@ -15,6 +15,7 @@
*/
import expect from 'expect';
import {KnownDevices} from 'puppeteer';
import {
getTestState,
setupTestBrowserHooks,
@ -26,8 +27,8 @@ describe('Touchscreen', function () {
setupTestPageAndContextHooks();
it('should tap the button', async () => {
const {puppeteer, page, server} = getTestState();
const iPhone = puppeteer.devices['iPhone 6']!;
const {page, server} = getTestState();
const iPhone = KnownDevices['iPhone 6']!;
await page.emulate(iPhone);
await page.goto(server.PREFIX + '/input/button.html');
await page.tap('button');
@ -38,8 +39,8 @@ describe('Touchscreen', function () {
).toBe('Clicked');
});
it('should report touches', async () => {
const {puppeteer, page, server} = getTestState();
const iPhone = puppeteer.devices['iPhone 6']!;
const {page, server} = getTestState();
const iPhone = KnownDevices['iPhone 6']!;
await page.emulate(iPhone);
await page.goto(server.PREFIX + '/input/touches.html');
const button = (await page.$('button'))!;