kevva

sindresorhus

pageres

samverschueren

Object.defineProperty(exports, "__esModule", { value: true });

const url_1 = require("url"); // eslint-disable-line node/no-deprecated-api

const filenamify = require("filenamify");

const unused_filename_1 = require("unused-filename");

const arrayDiffer = require("array-differ");

const getResolutions = require("get-res");

const logSymbols = require("log-symbols");

const captureWebsite = require("capture-website");

const viewportList = require("viewport-list");

const template = require("lodash.template");

const filenamifyUrl = require("filenamify-url");

const writeFile = util_1.promisify(fs.writeFile);

const getResolutionsMemoized = pMemoize(getResolutions);

const viewportListMemoized = pMemoize(viewportList);

// TODO: Use private class fields when targeting Node.js 12.

class Pageres extends events_1.EventEmitter {

        // Prevent false-positive `MaxListenersExceededWarning` warnings

        this.setMaxListeners(Number.POSITIVE_INFINITY);

        this.options = Object.assign({}, options);

        this.options.filename = (_a = this.options.filename) !== null && _a !== void 0 ? _a : '<%= url %>-<%= size %><%= crop %>';

        this.options.format = (_b = this.options.format) !== null && _b !== void 0 ? _b : 'png';

        this.options.incrementalName = (_c = this.options.incrementalName) !== null && _c !== void 0 ? _c : false;

        this.options.launchOptions = (_d = this.options.launchOptions) !== null && _d !== void 0 ? _d : {};

        this.stats = {}; // eslint-disable-line @typescript-eslint/consistent-type-assertions

        if (!(typeof url === 'string' && url.length > 0)) {

            throw new TypeError('URL required');

        if (!(Array.isArray(sizes) && sizes.length > 0)) {

            throw new TypeError('Sizes required');

        this._source.push({ url, sizes, options });

        if (!(typeof directory === 'string' && directory.length > 0)) {

            throw new TypeError('Directory required');

        await Promise.all(this.src().map(async (source) => {

            const options = Object.assign(Object.assign({}, this.options), source.options);

            const sizes = arrayUniq(source.sizes.filter(size => /^\d{2,4}x\d{2,4}$/i.test(size)));

            const keywords = arrayDiffer(source.sizes, sizes);

            if (sizes.length === 0 && keywords.includes('w3counter')) {

                return this.resolution(source.url, options);

                return this.viewport({ url: source.url, sizes, keywords }, options);

            const screenshots = await pMap(sizes, async (size) => {

                // TODO: Make this concurrent

                this.items.push(await this.create(source.url, size, options));

                return this.create(source.url, size, options);

            }, { concurrency: cpuCount * 2 });

            this.items.push(...screenshots);

        this.stats.urls = arrayUniq(this.urls).length;

        this.stats.sizes = arrayUniq(this.sizes).length;

        this.stats.screenshots = this.items.length;

        const { screenshots, sizes, urls } = this.stats;

            screenshots: plur('screenshot', screenshots),

        console.log(`\n${logSymbols.success} Generated ${screenshots} ${words.screenshots} from ${urls} ${words.urls} and ${sizes} ${words.sizes}`);

        for (const item of await getResolutionsMemoized()) {

            this.items.push(await this.create(url, item.item, options));

        for (const item of await viewportListMemoized(viewport.keywords)) {

            viewport.sizes.push(item.size);

        for (const size of arrayUniq(viewport.sizes)) {

            this.items.push(await this.create(viewport.url, size, options));

        await Promise.all(screenshots.map(async (screenshot) => {

            const dest = path.join(this.dest(), screenshot.filename);

            await writeFile(dest, screenshot);

        const basename = path.isAbsolute(url) ? path.basename(url) : url;

        let hash = (_a = url_1.parse(url).hash) !== null && _a !== void 0 ? _a : '';

        // Strip empty hash fragments: `#` `#/` `#!/`

        const [width, height] = size.split('x');

        const filenameTemplate = template(`${options.filename}.${options.format}`);

        let filename = filenameTemplate({

            crop: options.crop ? '-cropped' : '',

            date: dateFns.format(now, 'yyyy-MM-dd'),

            time: dateFns.format(now, 'HH-mm-ss'),

            url: `${filenamifyUrl(basename)}${filenamify(hash)}`

            filename = unused_filename_1.default.sync(filename);

        // TODO: Type this using the `capture-website` types

            styles: options.css && [options.css],

            scripts: options.script && [options.script],

            scaleFactor: options.scale === undefined ? 1 : options.scale,

            type: options.format === 'jpg' ? 'jpeg' : 'png',

            userAgent: options.userAgent,

            launchOptions: options.launchOptions

        if (options.username && options.password) {

            finalOptions.authentication = {

                username: options.username,

                password: options.password

        const screenshot = await captureWebsite.buffer(url, finalOptions);

	"description": "Capture website screenshots",

	"funding": "https://github.com/sponsors/sindresorhus",

			"@typescript-eslint/no-unused-vars": "off"

[![Coverage Status](https://codecov.io/gh/sindresorhus/pageres/branch/master/graph/badge.svg)](https://codecov.io/gh/sindresorhus/pageres)

[![Coverage Status](https://codecov.io/gh/sindresorhus/pageres/branch/main/graph/badge.svg)](https://codecov.io/gh/sindresorhus/pageres)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)

Capture screenshots of websites in various resolutions. A good way to make sure your websites are responsive. It's speedy and generates 100 screenshots from 10 different websites in just over a minute. It can also be used to render SVG images.

*See [pageres-cli](https://github.com/sindresorhus/pageres-cli) for the command-line tool.*

Note to Linux users: If you get a "No usable sandbox!" error, you need to enable [system sandboxing](https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md#setting-up-chrome-linux-sandbox).

		.src('https://github.com/sindresorhus/pageres', ['480x320', '1024x768', 'iphone 5s'], {crop: true})

		.src('https://sindresorhus.com', ['1280x1024', '1920x1080'])

		.src('data:text/html,<h1>Awesome!</h1>', ['1024x768'])

	console.log('Finished generating screenshots!');

Useful when the site does things after load that you want to capture.

Number of seconds after which the request is aborted.

Apply custom CSS to the webpage. Specify some CSS or the path to a CSS file.

Apply custom JavaScript to the webpage. Specify some JavaScript or the path to a file.

A string with the same format as a [browser cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies) or [an object](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagesetcookiecookies).

Tip: Go to the website you want a cookie for and [copy-paste it from DevTools](https://stackoverflow.com/a/24961735/64949).

Define a customized filename using [Lo-Dash templates](https://lodash.com/docs#template).\

For example: `<%= date %> - <%= url %>-<%= size %><%= crop %>`.

- `url`: The URL in [slugified](https://github.com/sindresorhus/filenamify-url) form, eg. `http://yeoman.io/blog/` becomes `yeoman.io!blog`

- `size`: Specified size, eg. `1024x1000`

- `width`: Width of the specified size, eg. `1024`

- `height`: Height of the specified size, eg. `1000`

- `crop`: Outputs `-cropped` when the crop option is true

- `date`: The current date (YYYY-MM-DD), eg. 2015-05-18

- `time`: The current time (HH-mm-ss), eg. 21-15-11

		@@ -7,2 +7,3 @@ "use strict";
		const fs = require("fs");
		const os = require("os");
		const events_1 = require("events");
		@@ -23,3 +24,5 @@ const pMemoize = require("p-memoize");
		const filenamifyUrl = require("filenamify-url");
		const pMap = require("p-map");
		const writeFile = util_1.promisify(fs.writeFile);
		const cpuCount = os.cpus().length;
		const getResolutionsMemoized = pMemoize(getResolutions);
		@@ -34,3 +37,3 @@ // @ts-expect-error
		// Prevent false-positive `MaxListenersExceededWarning` warnings
		this.setMaxListeners(Infinity);
		this.setMaxListeners(Number.POSITIVE_INFINITY);
		this.options = Object.assign({}, options);
		@@ -84,7 +87,7 @@ this.options.filename = (_a = this.options.filename) !== null && _a !== void 0 ? _a : '<%= url %>-<%= size %><%= crop %>';
		}
		for (const size of sizes) {
		const screenshots = await pMap(sizes, async (size) => {
		this.sizes.push(size);
		// TODO: Make this concurrent
		this.items.push(await this.create(source.url, size, options));
		}
		return this.create(source.url, size, options);
		}, { concurrency: cpuCount * 2 });
		this.items.push(...screenshots);
		return undefined;
		@@ -91,0 +94,0 @@ }));

		{
		"name": "pageres",
		"version": "6.1.0",
		"version": "6.2.0",
		"description": "Capture website screenshots",
		@@ -79,3 +79,3 @@ "license": "MIT",
		"@types/node": "^14.14.13",
		"@types/pify": "^3.0.2",
		"@types/pify": "^5.0.0",
		"@types/png.js": "^0.2.0",
		@@ -97,3 +97,3 @@ "@types/sinon": "^9.0.9",
		"typescript": "^4.1.3",
		"xo": "^0.36.1"
		"xo": "^0.38.2"
		},
		@@ -119,2 +119,6 @@ "types": "dist/index.d.ts",
		"nyc": {
		"reporter": [
		"text",
		"lcov"
		],
		"extension": [
		@@ -121,0 +125,0 @@ ".ts"

		# ![pageres](media/promo.png)

		[![Coverage Status](https://codecov.io/gh/sindresorhus/pageres/branch/master/graph/badge.svg)](https://codecov.io/gh/sindresorhus/pageres)
		[![Coverage Status](https://codecov.io/gh/sindresorhus/pageres/branch/main/graph/badge.svg)](https://codecov.io/gh/sindresorhus/pageres)
		[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
		@@ -5,0 +5,0 @@

Improved metrics