@cronn/element-snapshot 0.26.0 → 0.28.0

package/dist/index.d.mts

@@ -1,5 +1,6 @@
-import { Expect, Locator, MatcherReturnType } from "@playwright/test";
+import { Expect, Locator, MatcherReturnType, Page } from "@playwright/test";
 import { PlaywrightMatchJsonFileOptions, PlaywrightMatchTextFileOptions, PlaywrightValidationFileMatcherConfig } from "@cronn/playwright-file-snapshots";
+import { MarkdownTableNormalizer } from "@cronn/lib-file-snapshots";
 //#region src/playwright/markdown-table.d.ts
 interface MarkdownTableSnapshotOptions {
   /**
@@ -8,6 +9,10 @@ interface MarkdownTableSnapshotOptions {
    * @default true
    */
   showSortIndicator?: boolean;
+  /**
+   * Custom normalizers to apply before serialization
+   */
+  normalizers?: Array<MarkdownTableNormalizer>;
 }
 /**
  * Creates a Markdown table snapshot from a table or grid element
@@ -46,6 +51,7 @@ type PressedValue = true | "mixed";
 //#endregion
 //#region src/types/utils.d.ts
 type SetValues<TSet> = TSet extends Set<infer TValue> ? TValue : never;
+type PlaywrightTarget = Page | Locator;
 //#endregion
 //#region src/types/elements/container.d.ts
 declare const CONTAINER_ROLES: Set<"alert" | "article" | "banner" | "blockquote" | "code" | "complementary" | "contentinfo" | "definition" | "deletion" | "descriptionlist" | "emphasis" | "form" | "grid" | "insertion" | "label" | "list" | "listbox" | "listitem" | "log" | "main" | "mark" | "menu" | "navigation" | "note" | "paragraph" | "row" | "rowgroup" | "search" | "status" | "strong" | "subscript" | "superscript" | "table" | "tablist" | "tabpanel" | "term" | "tree">;
@@ -230,29 +236,29 @@ interface SemanticSnapshotOptions {
  * This function creates a raw snapshot of the DOM element identified by the locator
  * and transforms it into a semantic representation using the provided options.
  *
- * @param locator - The Locator instance that identifies the DOM element to snapshot
+ * @param target - The Page or Locator instance that identifies the DOM element to snapshot
  * @param options - Optional configuration settings for controlling the snapshot behavior
  * @return A promise that resolves to the semantic snapshot
  */
-declare function semanticSnapshot(locator: Locator, options?: SemanticSnapshotOptions): Promise<unknown>;
+declare function semanticSnapshot(target: PlaywrightTarget, options?: SemanticSnapshotOptions): Promise<unknown>;
 /**
  * Captures a raw snapshot of the element matched by the provided locator.
  *
  * Returns an array of node snapshots representing the current state of the matched elements
  * in the DOM, including their properties, attributes, and structure.
  *
- * @param locator - The Locator instance used to identify the target element to snapshot
+ * @param target - The Page or Locator instance used to identify the target element to snapshot
  * @return A promise that resolves to an array of NodeSnapshot objects representing the captured element
  */
-declare function rawSnapshot(locator: Locator): Promise<Array<NodeSnapshot>>;
+declare function rawSnapshot(target: PlaywrightTarget): Promise<Array<NodeSnapshot>>;
 //#endregion
 //#region src/types/matchers.d.ts
 interface ElementSnapshotMatchers {
-  toMatchSemanticSnapshotFile: (actual: Locator, options?: MatchSemanticSnapshotFileOptions) => Promise<MatcherReturnType>;
+  toMatchSemanticSnapshotFile: (actual: PlaywrightTarget, options?: MatchSemanticSnapshotFileOptions) => Promise<MatcherReturnType>;
   toMatchMarkdownTableSnapshotFile: (actual: Locator, options?: MatchMarkdownTableSnapshotFileOptions) => Promise<MatcherReturnType>;
 }
 interface MatchSemanticSnapshotFileOptions extends PlaywrightMatchJsonFileOptions, SemanticSnapshotOptions {}
-interface MatchMarkdownTableSnapshotFileOptions extends Omit<PlaywrightMatchTextFileOptions, "fileExtension">, MarkdownTableSnapshotOptions {}
+interface MatchMarkdownTableSnapshotFileOptions extends Omit<PlaywrightMatchTextFileOptions, "fileExtension" | "normalizers">, MarkdownTableSnapshotOptions {}
 //#endregion
 //#region src/playwright/matchers.d.ts
 /**

package/dist/index.mjs

@@ -199,12 +199,12 @@ var SemanticSnapshotTransformer = class {
 * This function creates a raw snapshot of the DOM element identified by the locator
 * and transforms it into a semantic representation using the provided options.
 *
-* @param locator - The Locator instance that identifies the DOM element to snapshot
+* @param target - The Page or Locator instance that identifies the DOM element to snapshot
 * @param options - Optional configuration settings for controlling the snapshot behavior
 * @return A promise that resolves to the semantic snapshot
 */
-async function semanticSnapshot(locator, options) {
-	const snapshot = await rawSnapshot(locator);
+async function semanticSnapshot(target, options) {
+	const snapshot = await rawSnapshot(target);
 	return new SemanticSnapshotTransformer(options).transform(snapshot);
 }
 /**
@@ -213,12 +213,16 @@ async function semanticSnapshot(locator, options) {
 * Returns an array of node snapshots representing the current state of the matched elements
 * in the DOM, including their properties, attributes, and structure.
 *
-* @param locator - The Locator instance used to identify the target element to snapshot
+* @param target - The Page or Locator instance used to identify the target element to snapshot
 * @return A promise that resolves to an array of NodeSnapshot objects representing the captured element
 */
-async function rawSnapshot(locator) {
+async function rawSnapshot(target) {
+	const locator = isPage(target) ? target.locator("body") : target;
 	return await new ElementSnapshotProxy(locator.page()).snapshotElement(locator);
 }
+function isPage(target) {
+	return "goto" in target && typeof target.goto === "function";
+}
 //#endregion
 //#region src/playwright/markdown-table.ts
 const tableRoles = ["table", "grid"];
@@ -236,8 +240,9 @@ const sortIndicators = {
 * Creates a Markdown table snapshot from a table or grid element
 */
 async function markdownTableSnapshot(locator, options = {}) {
-	const parsedTable = parseTable(await rawSnapshot(locator), options);
-	return new MarkdownTableSerializer().serialize(parsedTable);
+	const { showSortIndicator, normalizers } = options;
+	const parsedTable = parseTable(await rawSnapshot(locator), { showSortIndicator });
+	return new MarkdownTableSerializer({ normalizers }).serialize(parsedTable);
 }
 function parseTable(snapshot, options) {
 	const { showSortIndicator = true } = options;
@@ -285,8 +290,13 @@ function defineElementSnapshotMatchers(config = {}) {
 		return await defineJsonFileMatcher("toMatchSemanticSnapshotFile", config).bind(this)(() => semanticSnapshot(actual, options), options);
 	}
 	async function toMatchMarkdownTableSnapshotFile(actual, options = {}) {
-		return await defineTextFileMatcher("toMatchMarkdownTableSnapshotFile", config).bind(this)(() => markdownTableSnapshot(actual, options), {
-			...options,
+		const toMatchTextFile = defineTextFileMatcher("toMatchMarkdownTableSnapshotFile", config).bind(this);
+		const { showSortIndicator, normalizers, ...matchFileOptions } = options;
+		return await toMatchTextFile(() => markdownTableSnapshot(actual, {
+			showSortIndicator,
+			normalizers
+		}), {
+			...matchFileOptions,
 			fileExtension: "md"
 		});
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cronn/element-snapshot",
-  "version": "0.26.0",
+  "version": "0.28.0",
   "description": "Element snapshots for Playwright",
   "homepage": "https://cronn.github.io/file-snapshots/playwright/element-snapshots/",
   "bugs": {
@@ -35,20 +35,20 @@
     "@types/node": "24.13.3",
     "@typescript/native": "npm:typescript@^7.0.2",
     "@vitest/coverage-v8": "4.1.10",
-    "eslint": "10.8.0",
+    "eslint": "10.8.1",
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-check-file": "3.3.2",
     "eslint-plugin-unused-imports": "4.4.1",
-    "publint": "0.3.22",
+    "publint": "0.3.23",
     "rimraf": "6.1.3",
     "tsdown": "0.22.14",
     "typescript": "npm:@typescript/typescript6@^6.0.2",
-    "typescript-eslint": "8.65.0",
+    "typescript-eslint": "8.67.0",
     "vitest": "4.1.10",
-    "node": "runtime:24.18.1",
-    "@cronn/vitest-file-snapshots": "2.1.2",
+    "node": "runtime:24.19.0",
+    "@cronn/shared-configs": "0.0.0",
     "@cronn/test-utils": "0.0.0",
-    "@cronn/shared-configs": "0.0.0"
+    "@cronn/vitest-file-snapshots": "2.1.2"
   },
   "peerDependencies": {
     "@playwright/test": "^1.55"
@@ -56,12 +56,12 @@
   "devEngines": {
     "packageManager": {
       "name": "pnpm",
-      "version": "11.18.0",
+      "version": "11.22.0",
       "onFail": "download"
     },
     "runtime": {
       "name": "node",
-      "version": "24.18.1",
+      "version": "24.19.0",
       "onFail": "download"
     }
   },