percy-client

library3.9.0jsnpmunverified

The `percy-client` package was the original JavaScript API client library for Percy, a visual testing and review platform. It provided low-level programmatic access to Percy's API for managing visual builds and snapshots, crucial for integrating automated visual regression testing into CI/CD pipelines. This library allowed developers to create builds, capture DOM snapshots, upload associated resources (like HTML, CSS, and images), and finalize builds directly through code. The package is currently at version 3.9.0, with its last significant update approximately three years ago. It has since entered a maintenance state, receiving only minor dependency updates before being officially deprecated. Its primary differentiation was offering direct API control, which is now handled by the newer `@percy/client` package and the `@percy/cli` ecosystem, which offer a more comprehensive and extensible toolchain for visual testing.

testing web-framework

npm install percy-client

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PERCY-CLIENT

percy-client

testingjavascriptv3.9.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

PercyClient

✓ import PercyClient from 'percy-client';

✗ const PercyClient = require('percy-client');

While CommonJS `require` was historically common for this package, modern Node.js projects should use ESM `import`. However, this package is deprecated; use `@percy/client` instead.

This quickstart demonstrates how to programmatically create a Percy build, create a snapshot, upload HTML content as a resource, and finalize the snapshot and build using the `percy-client` library. It illustrates the low-level API interaction for visual testing.

import PercyClient from 'percy-client'; // Ensure PERCY_TOKEN is set in your environment variables for authentication // For example: export PERCY_TOKEN='YOUR_PERCY_PROJECT_TOKEN' const percyToken = process.env.PERCY_TOKEN || ''; const client = new PercyClient({ token: percyToken, clientInfo: 'my-custom-integration', environmentInfo: 'my-node-environment' }); async function runPercyBuildAndSnapshot() { if (!percyToken) { console.warn('PERCY_TOKEN is not set. Snapshots will be skipped.'); return; } console.log('Creating a new Percy build...'); const build = await client.createBuild(); console.log(`Build created: ${build.attributes['web-url']}`); console.log('Creating a snapshot...'); const htmlContent = ` <!DOCTYPE html> <html> <head><title>My Test Page</title></head> <body> <h1>Hello from Percy!</h1> <p>This is a test snapshot.</p> </body> </html> `; const snapshot = await client.createSnapshot(build.id, { name: 'Homepage with H1', widths: [768, 1280] }); // Uploading the HTML content as a resource for the snapshot await client.uploadResource(build.id, snapshot.id, { resourceUrl: '/', // The URL this resource represents mimetype: 'text/html', content: Buffer.from(htmlContent) }); console.log('Finalizing snapshot...'); await client.finalizeSnapshot(snapshot.id); console.log('Finalizing build...'); await client.finalizeBuild(build.id); console.log('Percy build process completed!'); } runPercyBuildAndSnapshot().catch(error => { console.error('An error occurred during Percy process:', error); process.exit(1); });

Debug

Known issues

breakingThis package (`percy-client`) is officially deprecated and no longer actively maintained. Users are strongly advised to migrate to the `@percy/client` package and the `@percy/cli` toolchain for all new and existing Percy integrations. Continued use of `percy-client` may lead to compatibility issues with newer Percy platform features.

fix

Migrate your integration to use `@percy/cli` and `@percy/client`. Refer to the official Percy documentation for migration guides. Start by installing `@percy/cli`: `npm install --save-dev @percy/cli` and then upgrade any Percy SDKs you are using.

affects: >=3.0.0

gotchaOlder versions of `percy-client` might use deprecated `Buffer` constructor syntax, which can lead to runtime warnings or errors in newer Node.js environments. [cite: github releases]

fix

Upgrade to `percy-client` version 3.2.3 or higher, which updated Buffer usage to remove deprecated constructor syntax. However, the recommended fix is to migrate to the `@percy/client` package as `percy-client` itself is deprecated. [cite: github releases]

affects: <3.2.3

Errors

Common errors & fixes

This package has been deprecated in favor of @percy/client

Attempting to install or use the deprecated `percy-client` package, which is superseded by a newer, modular architecture.

fix

Instead of `percy-client`, install `@percy/cli` (`npm install --save-dev @percy/cli`) and `@percy/client` (`npm install @percy/client`). Update your codebase to use the new API, typically by importing `PercyClient` from `@percy/client` or using `percy exec` with a framework-specific SDK.

Error: A WebdriverIO instance is needed to initialise percy-webdriverio

This specific error indicates an attempt to use `percy-client` (or an SDK like `percy-webdriverio` which might have used it internally) without providing the required framework-specific instance (e.g., a WebDriverIO browser object) in its constructor.

fix

Ensure that the `percy-client` or associated SDK is correctly initialized with the necessary context or framework instance as per its specific API requirements. For `percy-webdriverio`, this means passing a WebdriverIO browser instance to its constructor.

Upgrade

Version history

3.9.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/percy/percy-js ↗

packagehttps://www.npmjs.com/package/percy-client ↗

homepagehttps://percy.io ↗