@argos-ci/playwright 6.2.0 → 6.3.1

package/dist/chunk-2ESYSVXG.js

@@ -0,0 +1,48 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+var __esm = (fn, res) => function __init() {
+  return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+};
+var __commonJS = (cb, mod) => function __require2() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+export {
+  __require,
+  __esm,
+  __commonJS,
+  __export,
+  __toESM,
+  __toCommonJS
+};

package/dist/index.d.ts

@@ -1,7 +1,57 @@
-import { ElementHandle, Locator, Page, PageScreenshotOptions, LocatorScreenshotOptions, Frame } from '@playwright/test';
-import { ViewportOption, StabilizationPluginOptions } from '@argos-ci/browser';
+import { Locator, Page, Frame, ElementHandle, PageScreenshotOptions, LocatorScreenshotOptions } from '@playwright/test';
+import { StabilizationPluginOptions, ViewportOption } from '@argos-ci/browser';
 import { ScreenshotMetadata } from '@argos-ci/util';
 
+type ArgosAttachment = {
+    name: string;
+    contentType: string;
+    path: string;
+};
+
+type LocatorOptions$1 = Parameters<Page["locator"]>[1];
+type ArgosSnapshotOptions = {
+    /**
+     * `Locator` or string selector of the element to take a snapshot of.
+     */
+    element?: string | Locator;
+    /**
+     * Folder where the snapshots will be saved if not using the Argos reporter.
+     * @default "./screenshots"
+     */
+    root?: string;
+    /**
+     * Wait for the UI to stabilize before taking the snapshot.
+     * Set to `false` to disable stabilization.
+     * Pass an object to customize the stabilization.
+     * @default true
+     */
+    stabilize?: boolean | StabilizationPluginOptions;
+    /**
+     * Maximum time in milliseconds. Defaults to `0` - no timeout
+     */
+    timeout?: number;
+} & LocatorOptions$1;
+/**
+ * Stabilize the UI and takes a snapshot of the application under test.
+ *
+ * @example
+ *    argosAriaSnapshot(page, "my-screenshot")
+ * @see https://playwright.dev/docs/aria-snapshots
+ */
+declare function argosAriaSnapshot(
+/**
+ * Playwright `page` or `frame` object.
+ */
+handler: Page | Frame, 
+/**
+ * Name of the snapshot. Must be unique.
+ */
+name: string, 
+/**
+ * Options for the snapshot.
+ */
+options?: ArgosSnapshotOptions): Promise<ArgosAttachment[]>;
+
 type LocatorOptions = Parameters<Page["locator"]>[1];
 type ScreenshotOptions<TBase extends PageScreenshotOptions | LocatorScreenshotOptions> = Omit<TBase, "encoding" | "type" | "omitBackground" | "path">;
 type ArgosScreenshotOptions = {
@@ -14,6 +64,14 @@ type ArgosScreenshotOptions = {
      * Viewports to take screenshots of.
      */
     viewports?: ViewportOption[];
+    /**
+     * Capture an ARIA snapshot along with the screenshot.
+     * Each ARIA snapshot counts as an additional screenshot for billing.
+     * When using the viewports setting, one ARIA snapshot is taken per viewport.
+     * @see https://playwright.dev/docs/aria-snapshots#aria-snapshots
+     * @default false
+     */
+    ariaSnapshot?: boolean;
     /**
      * Custom CSS evaluated during the screenshot process.
      */
@@ -59,12 +117,6 @@ type ArgosScreenshotOptions = {
      */
     afterScreenshot?: () => Promise<void> | void;
 } & LocatorOptions & ScreenshotOptions<LocatorScreenshotOptions> & ScreenshotOptions<PageScreenshotOptions>;
-type Attachment = {
-    name: string;
-    contentType: string;
-    path: string;
-};
-type Handler = Page | Frame;
 /**
  * Stabilize the UI and takes a screenshot of the application under test.
  *
@@ -76,7 +128,7 @@ declare function argosScreenshot(
 /**
  * Playwright `page` or `frame` object.
  */
-handler: Handler, 
+handler: Page | Frame, 
 /**
  * Name of the screenshot. Must be unique.
  */
@@ -84,7 +136,7 @@ name: string,
 /**
  * Options for the screenshot.
  */
-options?: ArgosScreenshotOptions): Promise<Attachment[]>;
+options?: ArgosScreenshotOptions): Promise<ArgosAttachment[]>;
 
 /**
  * Get the CSP script hash.
@@ -103,4 +155,4 @@ type MetadataConfig = {
  */
 declare function setMetadataConfig(metadata: MetadataConfig): void;
 
-export { type ArgosScreenshotOptions, type Attachment, setMetadataConfig as DO_NOT_USE_setMetadataConfig, type MetadataConfig, argosScreenshot, getCSPScriptHash };
+export { type ArgosAttachment, type ArgosScreenshotOptions, type ArgosSnapshotOptions, setMetadataConfig as DO_NOT_USE_setMetadataConfig, type MetadataConfig, argosAriaSnapshot, argosScreenshot, getCSPScriptHash };