@argos-ci/puppeteer 0.0.2 → 0.0.4-alpha.182

package/LICENSE

@@ -4,4 +4,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 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.
+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

@@ -12,9 +12,9 @@ _Argos is a visual testing solution that fits in your workflow to avoid visual r
 [![npm dm](https://img.shields.io/npm/dm/@argos-ci/puppeteer.svg)](https://www.npmjs.com/package/@argos-ci/puppeteer)
 [![npm dt](https://img.shields.io/npm/dt/@argos-ci/puppeteer.svg)](https://www.npmjs.com/package/@argos-ci/puppeteer)
 
-Visit [docs.argos-ci.com/puppeteer](https://docs.argos-ci.com/puppeteer) for guides, API and more.
+Visit [argos-ci.com/docs/puppeteer](https://argos-ci.com/docs/puppeteer) for guides, API and more.
 
 ## Links
 
-- [Official SDK Docs](https://docs.argos-ci.com/)
-- [Discord](https://discord.gg/pK79sv85Vg)
+- [Official SDK Docs](https://argos-ci.com/docs/)
+- [Discord](https://argos-ci.com/discord)

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@argos-ci/puppeteer",
   "description": "Visual testing solution to avoid visual regression. Puppeteer commands and utilities for Argos visual testing.",
-  "version": "0.0.2",
+  "version": "0.0.4-alpha.182+8a2e9db",
   "author": "Smooth Code",
   "license": "MIT",
-  "repository": "github:argos-ci/argos-puppeteer",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/argos-ci/argos-javascript.git",
+    "directory": "packages/puppeteer"
+  },
   "keywords": [
     "puppeteer",
     "argos",
@@ -18,44 +22,45 @@
   "publishConfig": {
     "access": "public"
   },
-  "engines": {
-    "node": ">=16"
-  },
   "type": "module",
   "exports": {
     ".": {
-      "import": "./index.js",
-      "require": "./index.cjs",
-      "types": "./index.d.ts",
-      "default": "./index.js"
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "scripts": {
-    "jest": "NODE_OPTIONS=--experimental-vm-modules jest",
-    "test": "npm run jest --runInBand",
-    "format": "prettier --write .",
-    "check-format": "prettier --check .",
-    "lint": "eslint --ignore-path .gitignore .",
-    "release": "standard-version && conventional-github-releaser --preset angular"
+  "engines": {
+    "node": ">=16.0.0"
   },
   "peerDependencies": {
     "puppeteer": ">=1"
   },
+  "dependencies": {
+    "@argos-ci/browser": "0.0.1-alpha.182+8a2e9db",
+    "@argos-ci/util": "0.0.1-alpha.182+8a2e9db"
+  },
   "devDependencies": {
-    "@argos-ci/cli": "^0.1.2",
+    "@argos-ci/cli": "0.6.1-alpha.4+8a2e9db",
     "@types/jest": "^28.1.8",
-    "conventional-github-releaser": "^3.1.5",
+    "@types/node": "^16.0.0",
     "eslint": "^8.23.0",
     "eslint-plugin-html": "^7.1.0",
+    "expect-puppeteer": "^9.0.1",
     "jest": "^29.0.1",
     "jest-light-runner": "^0.4.0",
-    "jest-puppeteer": "^6.1.1",
-    "prettier": "^2.7.1",
-    "puppeteer": "^17.0.0",
-    "standard-version": "^9.5.0"
+    "jest-puppeteer": "^9.0.1",
+    "puppeteer": "^21.3.6"
   },
-  "dependencies": {
-    "mkdirp": "^1.0.4"
-  }
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "rollup -c",
+    "jest": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "test": "pnpm run jest --runInBand",
+    "argos-upload": "pnpm exec argos upload screenshots --build-name \"argos-puppeteer-e2e-node-$NODE_VERSION-$OS\"",
+    "e2e": "pnpm run test && pnpm run argos-upload"
+  },
+  "gitHead": "8a2e9db6427071708c3d701a3230f228b1216893"
 }

package/index.cjs

@@ -1,6 +0,0 @@
-const argosScreenshot = async (...args) => {
-  const { argosScreenshot } = await import("./index.js");
-  return argosScreenshot(...args);
-};
-
-exports.argosScreenshot = argosScreenshot;

package/index.d.ts

@@ -1,24 +0,0 @@
-import type { Page, ScreenshotOptions, ElementHandle } from "puppeteer";
-
-export interface ArgosScreenshotOptions
-  extends Omit<
-    ScreenshotOptions,
-    "encoding" | "type" | "omitBackground" | "path"
-  > {
-  /**
-   * ElementHandle or string selector of the element to take a screenshot of.
-   */
-  element?: string | ElementHandle;
-}
-
-/**
- * Stabilize the UI and takes a screenshot of the application under test.
- * @example
- *    await argosScreenshot(page, "my-screenshot")
- *    await argosScreenshot(page, "my-screenshot", { fullPage: true })
- */
-export function argosScreenshot(
-  page: Page,
-  name: string,
-  options?: ArgosScreenshotOptions
-): Promise<void>;

package/index.js

@@ -1,99 +0,0 @@
-import { resolve } from "node:path";
-import mkdirp from "mkdirp";
-
-const GLOBAL_STYLES = `
-  /* Hide carets */
-  * { caret-color: transparent !important; }
-
-  /* Hide scrollbars */
-  ::-webkit-scrollbar {
-    display: none !important;
-  }
-
-  /* Generic hide */
-  [data-visual-test="transparent"] {
-    color: transparent !important;
-    font-family: monospace !important;
-    opacity: 0 !important;
-  }
-
-  [data-visual-test="removed"] {
-    display: none !important;
-  }
-`;
-
-/**
- * Check if there is `[aria-busy="true"]` element on the page.
- */
-async function ensureNoBusy() {
-  const checkIsVisible = (element) =>
-    Boolean(
-      element.offsetWidth ||
-        element.offsetHeight ||
-        element.getClientRects().length
-    );
-
-  return [...document.querySelectorAll('[aria-busy="true"]')].every(
-    (element) => !checkIsVisible(element)
-  );
-}
-
-/**
- * Wait for all fonts to be loaded.
- */
-function waitForFonts() {
-  return document.fonts.status === "loaded";
-}
-
-/**
- * Wait for all images to be loaded.
- */
-async function waitForImages() {
-  return Promise.all(
-    Array.from(document.images)
-      .filter((img) => !img.complete)
-      .map(
-        (img) =>
-          new Promise((resolve) => {
-            img.onload = img.onerror = resolve;
-          })
-      )
-  );
-}
-
-export async function argosScreenshot(
-  page,
-  name,
-  { element = page, ...options } = {}
-) {
-  if (!page) throw new Error("A Puppeteer `page` object is required.");
-  if (!name) throw new Error("The `name` argument is required.");
-
-  if (typeof element === "string") {
-    await page.waitForSelector(element);
-    element = await page.$(element);
-  }
-
-  const directory = resolve(process.cwd(), "screenshots/argos");
-
-  const [resolvedElement] = await Promise.all([
-    (async () => {
-      if (typeof element === "string") {
-        await page.waitForSelector(element);
-        return page.$(element);
-      }
-      return element;
-    })(),
-    mkdirp(directory),
-    page.addStyleTag({ content: GLOBAL_STYLES }),
-    page.waitForFunction(ensureNoBusy),
-    page.waitForFunction(waitForFonts),
-    page.waitForFunction(waitForImages),
-  ]);
-
-  await resolvedElement.screenshot({
-    path: resolve(directory, `${name}.png`),
-    type: "png",
-    ...options,
-  });
-}