@argos-ci/webdriverio 0.1.2 → 0.2.0

package/dist/index.d.ts

@@ -20,8 +20,15 @@ type ArgosScreenshotOptions = {
 /**
  * Take a screenshot of the current page, optionally masking certain areas.
  * @param browser A WebdriverIO `browser` object.
- * @param filepath The path to save the screenshot to.
- * @param options Options for the screenshot.
+ * @param name The name of the screenshot or the full path to the screenshot.
+ * @param options Options to customize the screenshot.
+ * @param options.mask
+ * Specify ares that should be masked when the screenshot is taken.
+ * Masked elements will be overlaid with a pink box #FF00FF (customized by maskColor)
+ * that completely covers its bounding box.
+ * @param options.maskColor
+ * Specify the color of the overlay box for masked elements, in CSS color format.
+ * Default color is pink #FF00FF.
  */
 declare function argosScreenshot(browser: WebdriverIO.Browser, name: string, { mask, maskColor }?: ArgosScreenshotOptions): Promise<Buffer>;
 export { ArgosScreenshotOptions, argosScreenshot };

package/dist/index.mjs

@@ -57,7 +57,7 @@ async function getImageDimensions(buffer) {
         });
     }
 }
-async function getFilePath(name) {
+async function getScreenshotPath(name) {
     if (name.endsWith(".png")) return name;
     const screenshotFolder = resolve(process.cwd(), "screenshots/argos");
     await mkdir(screenshotFolder, {
@@ -68,8 +68,15 @@ async function getFilePath(name) {
 /**
  * Take a screenshot of the current page, optionally masking certain areas.
  * @param browser A WebdriverIO `browser` object.
- * @param filepath The path to save the screenshot to.
- * @param options Options for the screenshot.
+ * @param name The name of the screenshot or the full path to the screenshot.
+ * @param options Options to customize the screenshot.
+ * @param options.mask
+ * Specify ares that should be masked when the screenshot is taken.
+ * Masked elements will be overlaid with a pink box #FF00FF (customized by maskColor)
+ * that completely covers its bounding box.
+ * @param options.maskColor
+ * Specify the color of the overlay box for masked elements, in CSS color format.
+ * Default color is pink #FF00FF.
  */ async function argosScreenshot(browser, name, { mask, maskColor = "#FF00FF" } = {}) {
     if (!browser) {
         throw new Error("A WebdriverIO `browser` object is required.");
@@ -77,15 +84,15 @@ async function getFilePath(name) {
     if (!name) {
         throw new Error("The `name` argument is required.");
     }
-    const filepath = await getFilePath(name);
-    const imageBuffer = await browser.saveScreenshot(filepath);
+    const screenshotPath = await getScreenshotPath(name);
+    const imageBuffer = await browser.saveScreenshot(screenshotPath);
     if (!mask) {
         return imageBuffer;
     }
     const dimensions = await getImageDimensions(imageBuffer);
     const maskBuffer = await createMask(dimensions, mask, maskColor);
     const maskedBuffer = await applyMask(imageBuffer, maskBuffer);
-    await sharp(maskedBuffer).toFile(filepath);
+    await sharp(maskedBuffer).toFile(screenshotPath);
     return maskedBuffer;
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/webdriverio",
   "description": "Visual testing solution to avoid visual regression. Webdriver SDK and utilities for Argos visual testing.",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -63,5 +63,5 @@
     "argos-upload": "pnpm exec argos upload screenshots --build-name \"argos-webdriverio-e2e-node-$NODE_VERSION-$OS\"",
     "e2e": "pnpm run test && pnpm run argos-upload"
   },
-  "gitHead": "b601673bab3248f9a615ded0cca76af78830eeec"
+  "gitHead": "0d2a6514fa5765f4ced8cdff38a6c530f44d2e01"
 }