@percy/sdk-utils - npm Package Compare versions

Comparing version 1.0.0-beta.42 to 1.0.0-beta.43

package.json

 {
   "name": "@percy/sdk-utils",
-  "version": "1.0.0-beta.42",
+  "version": "1.0.0-beta.43",
   "license": "MIT",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "browser": "dist/bundle.js",
   "files": [
-    "index.js",
-    "test/helper.js"
+    "dist",
+    "test/helpers.js",
+    "test/server.js",
+    "test/client.js"
   ],
@@ -14,2 +17,3 @@ "engines": {
   "scripts": {
+    "build": "node ../../scripts/build",
     "lint": "eslint --ignore-path ../../.gitignore .",
@@ -22,6 +26,29 @@ "test": "node ../../scripts/test",
   },
+  "karma": {
+    "run_start": "node test/server start &",
+    "run_complete": "node test/server stop"
+  },
+  "rollup": {
+    "external": [
+      "ws"
+    ],
+    "output": {
+      "name": "PercySDKUtils"
+    },
+    "test": {
+      "external": [
+        "@percy/logger",
+        "test/server"
+      ],
+      "output": {
+        "globals": {
+          "@percy/logger": "PercySDKUtils.logger"
+        }
+      }
+    }
+  },
   "dependencies": {
-    "@percy/logger": "^1.0.0-beta.42"
+    "@percy/logger": "^1.0.0-beta.43"
   },
-  "gitHead": "1feffb5149eff71114ea583e10c098f75f497544"
+  "gitHead": "4eb85cf34665859cfd6dd2d3d09b1089e5f70144"
 }

README.md

 # @percy/sdk-utils
 
-Common Node SDK utils
+Common JavaScript SDK utils
 
 - [Usage](#usage)
   - [`logger()`](#loggerdebug)
-  - [`getInfo()`](#getinfo)
+  - [`percy`](#percy)
   - [`isPercyEnabled()`](#ispercyenabled)
   - [`postSnapshot()`](#postsnapshot)
+  - [`request`](#requesturl-options)
 
@@ -17,33 +18,35 @@ ## Usage
 
-### `getInfo()`
+### `percy`
 
-Returns information about any running Percy CLI server. Some information is only available after
-[`isPercyEnabled`](#ispercyenabled) has been called.
+This object contains information about the local Percy environment and is updated when
+[`isPercyEnabled`](#ispercyenabled) is called for the first time.
 
 ``` js
-const { getInfo } = require('@percy/sdk-utils');
+const { percy } = require('@percy/sdk-utils')
 
-const { cliApi, loglevel, version, config } = getInfo();
-```
+// reflects/updates process.env.PERCY_SERVER_ADDRESS
+percy.address === 'http://localhost:5338'
 
-#### Returned properties
+// updated after isPercyEnabled() is called
+percy.enabled === true|false
+percy.version.major === 1
+percy.version.minor === 2
+percy.version.patch === 3
+percy.version.toString() === '1.2.3'
+percy.config === {} // .percy.yml config
 
-- `cliApi` — CLI API address (`process.env.PERCY_CLI_API || 'http://localhost:5338'`)
-- `loglevel` — CLI log level  (`process.env.PERCY_LOGLEVEL || 'info'`)
+// updated after fetchPercyDOM() is called
+percy.domScript === fs.readFile(require.resolve('@percy/dom'))
+```
 
-The following properties are only populated after [`isPercyEnabled`](#ispercyenabled) has been
-called.
-
-- `version` — CLI version parts (e.g. `['1', '0', '0']`)
-- `config` — CLI config options
-
 ### `isPercyEnabled()`
 
 Returns `true` or `false` if the Percy CLI API server is running. Calls the server's `/healthcheck`
-endpoint and populates information for [`getInfo`](#getInfo). The result of this function is cached
-and subsequent calls will return the first cached result. If the healthcheck fails, will log a
-message unless the CLI loglevel is `quiet` or `silent`.
+endpoint and populates information for the [`percy`](#percy) property. The result of this function
+is cached and subsequent calls will return the first cached result. If the healthcheck fails, will
+log a message unless the CLI loglevel is `quiet` or `silent`. Upon a successful health check, a
+remote logging connection is also established.
 
 ``` js
-const { isPercyEnabled } = require('@percy/sdk-utils');
+const { isPercyEnabled } = require('@percy/sdk-utils')
 
@@ -60,3 +63,3 @@ // CLI API not running
 
-Fetches and returns the `@percy/dom` serialization script hosted by the CLI API server. The
+Fetches and returns the `@percy/dom` serialization script hosted by the local Percy API server. The
 resulting string can be evaulated within a browser context to add the `PercyDOM.serialize` function
@@ -66,14 +69,14 @@ to the global scope. Subsequent calls return the first cached result.
 ``` js
-const { fetchPercyDOM } = require('@percy/sdk-utils');
+const { fetchPercyDOM } = require('@percy/sdk-utils')
 
-let script = await fetchPercyDOM();
+let script = await fetchPercyDOM()
 
 // selenium-webdriver
-driver.executeScript(script);
+driver.executeScript(script)
 // webdriverio
-browser.execute(script);
+browser.execute(script)
 // puppeteer
-page.evaluate(script);
+page.evaluate(script)
 // protractor
-browser.executeScript(script);
+browser.executeScript(script)
 // etc...
@@ -84,6 +87,6 @@ ```
 
-Posts snapshot options to the CLI API server.
+Posts snapshot options to the local Percy API server.
 
 ``` js
-const { postSnapshot } = require('@percy/sdk-utils');
+const { postSnapshot } = require('@percy/sdk-utils')
 
@@ -102,3 +105,33 @@ await postSnapshot({
   requestHeaders: {}
-});
+})
 ```
+
+### `request(url[, options])`
+
+Sends a request to the local Percy API server. Used internally by the other SDK utils.
+
+``` js
+const { request } = require('@percy/sdk-utils')
+
+await request('/percy/idle')
+await request('/percy/stop')
+```
+
+#### `request.fetch(url, options)`
+
+The underlying implementation of the `request()` util. For Node environments, `http.request` is
+used; for browser environments, `window.fetch` is used. Can be overridden by the SDK's framework to
+work around CORS/CSP issues.
+
+The returned object must contain the following normalized properties from the request response:
+`status`, `statusText`, `headers`, `body`
+
+``` js
+const { request } = require('@percy/sdk-utils')
+
+// Cypress SDK example
+request.fetch = async function fetch(url, options) {
+  options = { url, retryOnNetworkFailure: false, ...options }
+  return Cypress.backend('http:request', options)
+}
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 3 instances in 1 package

Improved metrics

Total package byte prevSize

49577

increased by448.05%

Number of package files

13

increased by160%

Lines of code

1197

increased by719.86%

Number of lines in readme file

133

increased by33%

Worsened metrics

Number of medium supply chain risk alerts

3

increased by200%

Dependency changes

• Updated@percy/logger@^1.0.0-beta.43