@percy/playwright 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Perceptual Inc.
+
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,61 @@
+# @percy/playwright
+[![Version](https://img.shields.io/npm/v/@percy/playwright.svg)](https://npmjs.org/package/@percy/playwright)
+![Test](https://github.com/percy/percy-playwright/workflows/Test/badge.svg)
+
+[Percy](https://percy.io) visual testing for Playwright.
+
+## Installation
+
+```sh-session
+$ npm install --save-dev @percy/cli @percy/playwright
+```
+
+## Usage
+
+This is an example using the `percySnapshot` function. For other examples of `playwright`
+usage, see the [Playwright docs](https://playwright.dev/docs/library).
+
+```javascript
+const { chromium } = require('playwright');
+const percySnapshot = require('@percy/playwright');
+
+(async () => {
+  const browser = await chromium.launch();
+  const page = await browser.newPage();
+  await page.goto('http://example.com/', { waitUntil: 'networkidle2' });
+  await percySnapshot(page, 'Example Site');
+
+  await browser.close();
+})();
+```
+
+Running the code above directly will result in the following logs:
+
+```sh-session
+$ node script.js
+[percy] Percy is not running, disabling snapshots
+```
+
+When running with [`percy
+exec`](https://github.com/percy/cli/tree/master/packages/cli-exec#percy-exec), and your project's
+`PERCY_TOKEN`, a new Percy build will be created and snapshots will be uploaded to your project.
+
+```sh-session
+$ export PERCY_TOKEN=[your-project-token]
+$ percy exec -- node script.js
+[percy] Percy has started!
+[percy] Created build #1: https://percy.io/[your-project]
+[percy] Running "node script.js"
+[percy] Snapshot taken "Example Site"
+[percy] Stopping percy...
+[percy] Finalized build #1: https://percy.io/[your-project]
+[percy] Done!
+```
+
+## Configuration
+
+`percySnapshot(page, name[, options])`
+
+- `page` (**required**) - A `playwright` page instance
+- `name` (**required**) - The snapshot name; must be unique to each snapshot
+- `options` - [See per-snapshot configuration options](https://docs.percy.io/docs/cli-configuration#per-snapshot-configuration)

package/index.js

@@ -0,0 +1,42 @@
+const utils = require('@percy/sdk-utils');
+
+// Collect client and environment information
+const sdkPkg = require('./package.json');
+const playwrightPkg = require('playwright/package.json');
+const CLIENT_INFO = `${sdkPkg.name}/${sdkPkg.version}`;
+const ENV_INFO = `${playwrightPkg.name}/${playwrightPkg.version}`;
+
+// Take a DOM snapshot and post it to the snapshot endpoint
+async function percySnapshot(page, name, options) {
+  if (!page) throw new Error('A Playwright `page` object is required.');
+  if (!name) throw new Error('The `name` argument is required.');
+  if (!(await utils.isPercyEnabled())) return;
+  let log = utils.logger('playwright');
+
+  try {
+    // Inject the DOM serialization script
+    await page.evaluate(await utils.fetchPercyDOM());
+
+    // Serialize and capture the DOM
+    /* istanbul ignore next: no instrumenting injected code */
+    let domSnapshot = await page.evaluate((options) => {
+      /* eslint-disable-next-line no-undef */
+      return PercyDOM.serialize(options);
+    }, options);
+
+    // Post the DOM to the snapshot endpoint with snapshot options and other info
+    await utils.postSnapshot({
+      ...options,
+      environmentInfo: ENV_INFO,
+      clientInfo: CLIENT_INFO,
+      url: page.url(),
+      domSnapshot,
+      name
+    });
+  } catch (err) {
+    log.error(`Could not take DOM snapshot "${name}"`);
+    log.error(err);
+  }
+}
+
+module.exports = percySnapshot;

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@percy/playwright",
+  "description": "Playwright client library for visual testing with Percy",
+  "version": "1.0.0",
+  "license": "MIT",
+  "author": "Perceptual Inc.",
+  "repository": "https://github.com/percy/percy-playwright",
+  "keywords": [
+    "playwright",
+    "percy",
+    "visual testing"
+  ],
+  "main": "index.js",
+  "types": "types/index.d.ts",
+  "files": [
+    "index.js",
+    "types/index.d.ts"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "scripts": {
+    "lint": "eslint --ignore-path .gitignore .",
+    "test": "cross-env NODE_ENV=test playwright test",
+    "test:coverage": "nyc yarn test",
+    "test:types": "tsd"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@percy/sdk-utils": "^1.0.0-beta.69"
+  },
+  "peerDependencies": {
+    "playwright": ">=1"
+  },
+  "devDependencies": {
+    "@percy/core": "^1.0.0-beta.69",
+    "@playwright/test": "^1.15.2",
+    "cross-env": "^7.0.2",
+    "eslint": "^7.18.0",
+    "eslint-config-standard": "^16.0.2",
+    "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-standard": "^5.0.0",
+    "nyc": "^15.1.0",
+    "playwright": "^1.15.0",
+    "tsd": "^0.17.0"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,8 @@
+import * as Playwright from 'playwright';
+import { SnapshotOptions } from '@percy/core';
+
+export default function percySnapshot(
+  page: Playwright.Page,
+  name: string,
+  options?: SnapshotOptions
+): Promise<void>;