@argos-ci/playwright 3.7.1 → 3.8.0

package/dist/index.cjs

@@ -4,5 +4,18 @@ const argosScreenshot = async (...args)=>{
     const { argosScreenshot } = await import('./index.mjs');
     return argosScreenshot(...args);
 };
-// @ts-ignore
 exports.argosScreenshot = argosScreenshot;
+// @ts-ignore
+const getCSPScriptHash = async (...args)=>{
+    // @ts-ignore
+    const { getCSPScriptHash } = await import('./index.mjs');
+    return getCSPScriptHash(...args);
+};
+exports.getCSPScriptHash = getCSPScriptHash;
+// @ts-ignore
+const DO_NOT_USE_setMetadataConfig = async (...args)=>{
+    // @ts-ignore
+    const { DO_NOT_USE_setMetadataConfig } = await import('./index.mjs');
+    return DO_NOT_USE_setMetadataConfig(...args);
+};
+exports.DO_NOT_USE_setMetadataConfig = DO_NOT_USE_setMetadataConfig;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { Page, PageScreenshotOptions, LocatorScreenshotOptions, ElementHandle, Locator } from "@playwright/test";
 import { ViewportOption } from "@argos-ci/browser";
+import { ScreenshotMetadata } from "@argos-ci/util";
 type LocatorOptions = Parameters<Page["locator"]>[1];
 type ScreenshotOptions<TBase extends PageScreenshotOptions | LocatorScreenshotOptions> = Omit<TBase, "encoding" | "type" | "omitBackground" | "path">;
 type ArgosScreenshotOptions = {
@@ -40,21 +41,27 @@ type ArgosScreenshotOptions = {
  *    argosScreenshot(page, "my-screenshot")
  * @see https://argos-ci.com/docs/playwright#api-overview
  */
-declare function argosScreenshot(
-/**
+declare function argosScreenshot(/**
  * Playwright `page` object.
  */
-page: Page, 
-/**
+page: Page, /**
  * Name of the screenshot. Must be unique.
  */
-name: string, 
-/**
+name: string, /**
  * Options for the screenshot.
  */
 options?: ArgosScreenshotOptions): Promise<void>;
 /**
  * Get the CSP script hash.
  */
-declare function getCSPScriptHash(): string;
-export { ArgosScreenshotOptions, argosScreenshot, getCSPScriptHash };
+declare function getCSPScriptHash(): Promise<string>;
+type PlaywrightLibrary = "@playwright/test" | "playwright" | "playwright-core";
+type MetadataConfig = {
+    sdk: ScreenshotMetadata["sdk"];
+    playwrightLibraries: PlaywrightLibrary[];
+};
+/**
+ * Set the metadata config.
+ */
+declare function setMetadataConfig(metadata: MetadataConfig): Promise<void>;
+export { ArgosScreenshotOptions, argosScreenshot, getCSPScriptHash, setMetadataConfig as DO_NOT_USE_setMetadataConfig };

package/dist/index.mjs

@@ -1,28 +1,44 @@
 import { mkdir } from 'node:fs/promises';
 import { relative, resolve, dirname } from 'node:path';
-import { createHash } from 'node:crypto';
 import { resolveViewport, getGlobalScript } from '@argos-ci/browser';
 import { getGitRepositoryPath, readVersionFromPackage, getScreenshotName, validateThreshold, writeMetadata, getMetadataPath } from '@argos-ci/util';
 import { createRequire } from 'node:module';
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { createHash } from 'node:crypto';
 
 function getAttachmentName(name, type) {
     return `argos/${type}___${name}`;
 }
 
 const require$1 = createRequire(import.meta.url);
-const tryResolve = (pkg)=>{
+/**
+ * Try to resolve a package.
+ */ function tryResolve(pkg) {
     try {
         return require$1.resolve(pkg);
     } catch  {
         return null;
     }
-};
-async function getAutomationLibrary() {
-    const libraries = [
-        "@playwright/test",
-        "playwright",
-        "playwright-core"
-    ];
+}
+/**
+ * Private metadata config storage.
+ * Used to inject the metadata from other SDKs like @argos-ci/storybook.
+ */ const metadataConfigStorage = new AsyncLocalStorage();
+/**
+ * Set the metadata config.
+ */ async function setMetadataConfig(metadata) {
+    metadataConfigStorage.enterWith(metadata);
+}
+const DEFAULT_PLAYWRIGHT_LIBRARIES = [
+    "@playwright/test",
+    "playwright",
+    "playwright-core"
+];
+/**
+ * Get the name and version of the automation library.
+ */ async function getAutomationLibraryMetadata() {
+    const metadataConfig = metadataConfigStorage.getStore();
+    const libraries = metadataConfig?.playwrightLibraries ?? DEFAULT_PLAYWRIGHT_LIBRARIES;
     for (const name of libraries){
         const pkgPath = tryResolve(`${name}/package.json`);
         if (pkgPath) {
@@ -35,25 +51,42 @@ async function getAutomationLibrary() {
     }
     throw new Error(`Unable to find any of the following packages: ${libraries.join(", ")}`);
 }
-async function getArgosPlaywrightVersion() {
+/**
+ * Get the version of the Argos Playwright SDK.
+ */ async function getArgosPlaywrightVersion() {
     const pkgPath = require$1.resolve("@argos-ci/playwright/package.json");
     return readVersionFromPackage(pkgPath);
 }
-async function getLibraryMetadata() {
-    const [automationLibrary, argosPlaywrightVersion] = await Promise.all([
-        getAutomationLibrary(),
-        getArgosPlaywrightVersion()
+/**
+ * Get the name and version of the SDK.
+ */ async function getSdkMetadata() {
+    // Get the SDK metadata from the async local storage.
+    const metadataConfig = metadataConfigStorage.getStore();
+    if (metadataConfig) {
+        return metadataConfig.sdk;
+    }
+    // Get the SDK metadata from the current SDK.
+    const argosPlaywrightVersion = await getArgosPlaywrightVersion();
+    return {
+        name: "@argos-ci/playwright",
+        version: argosPlaywrightVersion
+    };
+}
+/**
+ * Get the metadata of the automation library and the SDK.
+ */ async function getLibraryMetadata() {
+    const [automationLibrary, sdk] = await Promise.all([
+        getAutomationLibraryMetadata(),
+        getSdkMetadata()
     ]);
-    const metadata = {
+    return {
         automationLibrary,
-        sdk: {
-            name: "@argos-ci/playwright",
-            version: argosPlaywrightVersion
-        }
+        sdk
     };
-    return metadata;
 }
-async function getTestMetadataFromTestInfo(testInfo) {
+/**
+ * Get the metadata of the test.
+ */ async function getTestMetadataFromTestInfo(testInfo) {
     const repositoryPath = await getGitRepositoryPath();
     const testMetadata = {
         id: testInfo.testId,
@@ -88,7 +121,9 @@ const DEFAULT_SCREENSHOT_ROOT = "./screenshots";
         });
     }
 }
-async function getTestInfo() {
+/**
+ * Get test info from the Playwright test.
+ */ async function getTestInfo() {
     try {
         const { test } = await import('@playwright/test');
         return test.info();
@@ -96,7 +131,9 @@ async function getTestInfo() {
         return null;
     }
 }
-function getViewportSize(page) {
+/**
+ * Get the viewport size.
+ */ function getViewportSize(page) {
     const viewportSize = page.viewportSize();
     if (!viewportSize) {
         throw new Error("Can't take screenshots without a viewport.");
@@ -286,11 +323,12 @@ function getViewportSize(page) {
     }
     await teardown();
 }
+
 /**
  * Get the CSP script hash.
- */ function getCSPScriptHash() {
+ */ async function getCSPScriptHash() {
     const hash = createHash("sha256").update(getGlobalScript()).digest("base64");
     return `'sha256-${hash}'`;
 }
 
-export { argosScreenshot, getCSPScriptHash };
+export { setMetadataConfig as DO_NOT_USE_setMetadataConfig, argosScreenshot, getCSPScriptHash };

package/dist/reporter.mjs

@@ -6,6 +6,7 @@ import { tmpdir } from 'node:os';
 import { relative, dirname, join } from 'node:path';
 import { getGitRepositoryPath, readVersionFromPackage } from '@argos-ci/util';
 import { createRequire } from 'node:module';
+import { AsyncLocalStorage } from 'node:async_hooks';
 import createDebug from 'debug';
 
 function getOriginalAttachmentName(name) {
@@ -34,19 +35,29 @@ function checkIsAutomaticScreenshot(attachment) {
 }
 
 const require = createRequire(import.meta.url);
-const tryResolve = (pkg)=>{
+/**
+ * Try to resolve a package.
+ */ function tryResolve(pkg) {
     try {
         return require.resolve(pkg);
     } catch  {
         return null;
     }
-};
-async function getAutomationLibrary() {
-    const libraries = [
-        "@playwright/test",
-        "playwright",
-        "playwright-core"
-    ];
+}
+/**
+ * Private metadata config storage.
+ * Used to inject the metadata from other SDKs like @argos-ci/storybook.
+ */ const metadataConfigStorage = new AsyncLocalStorage();
+const DEFAULT_PLAYWRIGHT_LIBRARIES = [
+    "@playwright/test",
+    "playwright",
+    "playwright-core"
+];
+/**
+ * Get the name and version of the automation library.
+ */ async function getAutomationLibraryMetadata() {
+    const metadataConfig = metadataConfigStorage.getStore();
+    const libraries = metadataConfig?.playwrightLibraries ?? DEFAULT_PLAYWRIGHT_LIBRARIES;
     for (const name of libraries){
         const pkgPath = tryResolve(`${name}/package.json`);
         if (pkgPath) {
@@ -59,23 +70,38 @@ async function getAutomationLibrary() {
     }
     throw new Error(`Unable to find any of the following packages: ${libraries.join(", ")}`);
 }
-async function getArgosPlaywrightVersion() {
+/**
+ * Get the version of the Argos Playwright SDK.
+ */ async function getArgosPlaywrightVersion() {
     const pkgPath = require.resolve("@argos-ci/playwright/package.json");
     return readVersionFromPackage(pkgPath);
 }
-async function getLibraryMetadata() {
-    const [automationLibrary, argosPlaywrightVersion] = await Promise.all([
-        getAutomationLibrary(),
-        getArgosPlaywrightVersion()
+/**
+ * Get the name and version of the SDK.
+ */ async function getSdkMetadata() {
+    // Get the SDK metadata from the async local storage.
+    const metadataConfig = metadataConfigStorage.getStore();
+    if (metadataConfig) {
+        return metadataConfig.sdk;
+    }
+    // Get the SDK metadata from the current SDK.
+    const argosPlaywrightVersion = await getArgosPlaywrightVersion();
+    return {
+        name: "@argos-ci/playwright",
+        version: argosPlaywrightVersion
+    };
+}
+/**
+ * Get the metadata of the automation library and the SDK.
+ */ async function getLibraryMetadata() {
+    const [automationLibrary, sdk] = await Promise.all([
+        getAutomationLibraryMetadata(),
+        getSdkMetadata()
     ]);
-    const metadata = {
+    return {
         automationLibrary,
-        sdk: {
-            name: "@argos-ci/playwright",
-            version: argosPlaywrightVersion
-        }
+        sdk
     };
-    return metadata;
 }
 async function getTestMetadataFromTestCase(testCase, testResult) {
     const repositoryPath = await getGitRepositoryPath();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/playwright",
-  "description": "Visual testing solution to avoid visual regression. Playwright commands and utilities for Argos visual testing.",
-  "version": "3.7.1",
+  "description": "Playwright SDK for visual testing with Argos.",
+  "version": "3.8.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -9,11 +9,16 @@
     "url": "https://github.com/argos-ci/argos-javascript.git",
     "directory": "packages/playwright"
   },
+  "homepage": "https://argos-ci.com/docs/playwright",
+  "bugs": {
+    "url": "https://github.com/argos-ci/argos-javascript/issues"
+  },
   "keywords": [
     "playwright",
+    "playwright-reporter",
+    "reporter",
+    "playwright-plugin",
     "argos",
-    "automation",
-    "test automation",
     "testing",
     "visual testing",
     "regression",
@@ -39,19 +44,19 @@
     "./package.json": "./package.json"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=18.16.0"
   },
   "dependencies": {
-    "@argos-ci/browser": "2.1.5",
-    "@argos-ci/core": "2.9.0",
-    "@argos-ci/util": "2.1.1",
+    "@argos-ci/browser": "2.1.6",
+    "@argos-ci/core": "2.9.2",
+    "@argos-ci/util": "2.1.2",
     "chalk": "^5.3.0",
     "debug": "^4.3.6"
   },
   "devDependencies": {
-    "@argos-ci/cli": "2.4.5",
+    "@argos-ci/cli": "2.4.7",
     "@argos-ci/playwright": "workspace:.",
-    "@playwright/test": "^1.46.1",
+    "@playwright/test": "^1.48.1",
     "@types/debug": "^4.1.12",
     "@types/node": "^18.19.44"
   },
@@ -61,5 +66,5 @@
     "test": "pnpm exec -- playwright test",
     "e2e": "UPLOAD_TO_ARGOS=true pnpm run test"
   },
-  "gitHead": "7e27acc33b30dde8c36cb9ffb5356fa1c6b2be3e"
+  "gitHead": "d0fa8cd790ffd2343d1cd32706bcb757c4f3b26e"
 }