@argos-ci/puppeteer 1.3.1 → 1.4.0

package/dist/index.d.ts

@@ -14,5 +14,13 @@ type ArgosScreenshotOptions = Omit<ScreenshotOptions, "encoding" | "type" | "omi
      */
     argosCSS?: string;
 };
+/**
+ * @param page Puppeteer `page` object.
+ * @param name The name of the screenshot or the full path to the screenshot.
+ * @param options In addition to Puppeteer's `ScreenshotOptions`, you can pass:
+ * @param options.element ElementHandle or string selector of the element to take a screenshot of.
+ * @param options.viewports Viewports to take screenshots of.
+ * @param options.argosCSS Custom CSS evaluated during the screenshot process.
+ */
 declare function argosScreenshot(page: Page, name: string, { element, viewports, argosCSS, ...options }?: ArgosScreenshotOptions): Promise<void>;
 export { ArgosScreenshotOptions, argosScreenshot };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { resolve } from 'node:path';
-import { mkdir, readFile } from 'node:fs/promises';
+import { readFile, mkdir } from 'node:fs/promises';
 import { createRequire } from 'node:module';
 import { resolveViewport } from '@argos-ci/browser';
 import { getScreenshotName, writeMetadata, readVersionFromPackage } from '@argos-ci/util';
@@ -39,20 +39,30 @@ async function getBrowserInfo(page) {
         browserVersion
     };
 }
-async function argosScreenshot(page, name, { element, viewports, argosCSS, ...options } = {}) {
+async function getScreenshotPath(name) {
+    if (name.endsWith(".png")) return name;
+    const screenshotFolder = resolve(process.cwd(), "screenshots/argos");
+    await mkdir(screenshotFolder, {
+        recursive: true
+    });
+    return resolve(screenshotFolder, name + ".png");
+}
+/**
+ * @param page Puppeteer `page` object.
+ * @param name The name of the screenshot or the full path to the screenshot.
+ * @param options In addition to Puppeteer's `ScreenshotOptions`, you can pass:
+ * @param options.element ElementHandle or string selector of the element to take a screenshot of.
+ * @param options.viewports Viewports to take screenshots of.
+ * @param options.argosCSS Custom CSS evaluated during the screenshot process.
+ */ async function argosScreenshot(page, name, { element, viewports, argosCSS, ...options } = {}) {
     if (!page) {
         throw new Error("A Puppeteer `page` object is required.");
     }
     if (!name) {
         throw new Error("The `name` argument is required.");
     }
-    const screenshotFolder = resolve(process.cwd(), "screenshots/argos");
     const [originalViewport] = await Promise.all([
         getViewport(page),
-        // Create the screenshot folder if it doesn't exist
-        mkdir(screenshotFolder, {
-            recursive: true
-        }),
         // Inject Argos script into the page
         injectArgos(page)
     ]);
@@ -99,8 +109,10 @@ async function argosScreenshot(page, name, { element, viewports, argosCSS, ...op
     }
     async function stabilizeAndScreenshot(name) {
         await page.waitForFunction(()=>window.__ARGOS__.waitForStability());
-        const screenshotPath = resolve(screenshotFolder, `${name}.png`);
-        const metadata = await collectMetadata();
+        const [screenshotPath, metadata] = await Promise.all([
+            getScreenshotPath(name),
+            collectMetadata()
+        ]);
         await writeMetadata(screenshotPath, metadata);
         const screenshotOptions = {
             path: screenshotPath,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/puppeteer",
   "description": "Visual testing solution to avoid visual regression. Puppeteer commands and utilities for Argos visual testing.",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -44,7 +44,7 @@
     "@argos-ci/util": "1.2.0"
   },
   "devDependencies": {
-    "@argos-ci/cli": "1.0.5",
+    "@argos-ci/cli": "1.0.6",
     "@types/jest": "^28.1.8",
     "@types/node": "^16.0.0",
     "eslint": "^8.23.0",
@@ -63,5 +63,5 @@
     "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": "fb1a0ada54f5e544f220a5ad37c1845099c91fca"
+  "gitHead": "0d2a6514fa5765f4ced8cdff38a6c530f44d2e01"
 }