@cronn/element-snapshot 0.14.0 → 0.14.1

package/dist/index.d.mts

@@ -126,6 +126,20 @@ interface GenericElementSnapshot<TRole extends NodeRole = NodeRole, TAttributes
 }
 type SetValues<TSet> = TSet extends Set<infer TValue> ? TValue : never;
 //#endregion
+//#region src/playwright/markdown-table.d.ts
+interface TableSnapshotOptions {
+  /**
+   * Show sort indicator for column headers
+   *
+   * @default true
+   */
+  showSortIndicator?: boolean;
+}
+/**
+ * Creates a Markdown table snapshot from a table or grid element
+ */
+declare function markdownTableSnapshot(locator: Locator, options?: TableSnapshotOptions): Promise<string>;
+//#endregion
 //#region src/types/snapshot.d.ts
 type SnapshotByRole<TRole extends NodeRole> = NodeSnapshot & {
   role: TRole;
@@ -230,4 +244,4 @@ declare function excludeRole<TRole extends NodeRole>(role: TRole | Array<TRole>)
  */
 declare function getTextContent(snapshots: Array<NodeSnapshot>): string;
 //#endregion
-export { type ButtonSnapshot, type ColumnheaderSnapshot, type ComboboxSnapshot, type ContainerSnapshot, type DialogSnapshot, type ElementRole, type ElementSnapshot, type GroupSnapshot, type HeadingSnapshot, type ImageSnapshot, type InputSnapshot, type LinkSnapshot, type MenuitemSnapshot, type NodeRole, type NodeSnapshot, type OptionSnapshot, type ProgressbarSnapshot, type RadiogroupSnapshot, type SeparatorSnapshot, type TabSnapshot, type TextSnapshot, excludeRole, filter, filterByRole, getTextContent, includeRole, snapshotElement, snapshotElementRaw };
+export { type ButtonSnapshot, type ColumnheaderSnapshot, type ComboboxSnapshot, type ContainerSnapshot, type DialogSnapshot, type ElementRole, type ElementSnapshot, type GroupSnapshot, type HeadingSnapshot, type ImageSnapshot, type InputSnapshot, type LinkSnapshot, type MenuitemSnapshot, type NodeRole, type NodeSnapshot, type OptionSnapshot, type ProgressbarSnapshot, type RadiogroupSnapshot, type SeparatorSnapshot, type TabSnapshot, type TextSnapshot, excludeRole, filter, filterByRole, getTextContent, includeRole, markdownTableSnapshot, snapshotElement, snapshotElementRaw };

package/dist/index.mjs

@@ -1,34 +1,7 @@
+import { markdownTable } from "markdown-table";
 import path from "node:path";
 import { packageDirectory } from "package-directory";
 
-//#region src/playwright/proxy.ts
-var ElementSnapshotProxy = class {
-	page;
-	constructor(page) {
-		this.page = page;
-	}
-	async snapshotElement(locator) {
-		if (!await this.isLibraryLoaded()) await this.loadLibrary();
-		return await locator.evaluate((element) => {
-			return window.snapshotElement(element);
-		});
-	}
-	async isLibraryLoaded() {
-		return await this.page.evaluate(() => typeof window.snapshotElement === "function");
-	}
-	async loadLibrary() {
-		const packageRootDir = await this.resolvePackageRootDir();
-		const libPath = path.resolve(packageRootDir, "dist", "browser-lib.iife.js");
-		await this.page.addScriptTag({ path: libPath });
-	}
-	async resolvePackageRootDir() {
-		const packageDir = await packageDirectory({ cwd: import.meta.dirname });
-		if (packageDir === void 0) throw new Error("Unable to resolve root directory of package");
-		return packageDir;
-	}
-};
-
-//#endregion
 //#region src/utils/guards.ts
 function isTextSnapshot(snapshot) {
 	return hasRole("text", snapshot);
@@ -92,6 +65,49 @@ function hasChildren(snapshot) {
 	return "children" in snapshot && snapshot.children.length > 0;
 }
 
+//#endregion
+//#region src/utils/text.ts
+/**
+* Aggregates and normalizes the text content of all provided snapshots
+*/
+function getTextContent(snapshots) {
+	return normalizeText(filter({
+		snapshots,
+		predicate: isTextSnapshot
+	}).map((textNode) => textNode.name).join(" "));
+}
+function normalizeText(text) {
+	return text.replaceAll(/\s+/g, " ").trim();
+}
+
+//#endregion
+//#region src/playwright/proxy.ts
+var ElementSnapshotProxy = class {
+	page;
+	constructor(page) {
+		this.page = page;
+	}
+	async snapshotElement(locator) {
+		if (!await this.isLibraryLoaded()) await this.loadLibrary();
+		return await locator.evaluate((element) => {
+			return window.snapshotElement(element);
+		});
+	}
+	async isLibraryLoaded() {
+		return await this.page.evaluate(() => typeof window.snapshotElement === "function");
+	}
+	async loadLibrary() {
+		const packageRootDir = await this.resolvePackageRootDir();
+		const libPath = path.resolve(packageRootDir, "dist", "browser-lib.iife.js");
+		await this.page.addScriptTag({ path: libPath });
+	}
+	async resolvePackageRootDir() {
+		const packageDir = await packageDirectory({ cwd: import.meta.dirname });
+		if (packageDir === void 0) throw new Error("Unable to resolve root directory of package");
+		return packageDir;
+	}
+};
+
 //#endregion
 //#region src/playwright/transformer.ts
 var ElementSnapshotTransformer = class {
@@ -218,19 +234,55 @@ async function snapshotElementRaw(locator) {
 }
 
 //#endregion
-//#region src/utils/text.ts
+//#region src/playwright/markdown-table.ts
+const tableRoles = ["table", "grid"];
+const cellRoles = [
+	"rowheader",
+	"cell",
+	"gridcell"
+];
+const sortIndicators = {
+	ascending: "⯅",
+	descending: "⯆",
+	other: "⯁"
+};
 /**
-* Aggregates and normalizes the text content of all provided snapshots
+* Creates a Markdown table snapshot from a table or grid element
 */
-function getTextContent(snapshots) {
-	return normalizeText(filter({
-		snapshots,
-		predicate: isTextSnapshot
-	}).map((textNode) => textNode.name).join(" "));
+async function markdownTableSnapshot(locator, options = {}) {
+	const { columnHeaders, rows } = parseTable(await snapshotElementRaw(locator), options);
+	return markdownTable([columnHeaders, ...rows]);
 }
-function normalizeText(text) {
-	return text.replaceAll(/\s+/g, " ").trim();
+function parseTable(snapshot, options) {
+	const { showSortIndicator = true } = options;
+	const tableOrGridResult = filter({
+		predicate: includeRole(tableRoles),
+		snapshots: snapshot
+	});
+	if (tableOrGridResult.length > 1) throw new Error("Multiple tables or grids found");
+	const [tableOrGrid] = tableOrGridResult;
+	if (tableOrGrid === void 0) throw new Error("No table or grid found");
+	const [headerRow, ...bodyRows] = filterByRole("row", tableOrGrid.children);
+	if (headerRow === void 0) throw new Error("No header row found");
+	const columnHeaders = filterByRole("columnheader", headerRow.children);
+	if (columnHeaders.length === 0) throw new Error("No column headers found");
+	return {
+		columnHeaders: columnHeaders.map((columnHeader) => getColumnHeaderText(columnHeader, showSortIndicator)),
+		rows: bodyRows.map(getCellTexts)
+	};
+}
+function getColumnHeaderText(columnHeader, showSortIndicator) {
+	const headerText = getTextContent([columnHeader]);
+	const sortType = columnHeader.attributes.sort;
+	if (!showSortIndicator || sortType === void 0) return headerText;
+	return `${headerText} ${sortIndicators[sortType]}`;
+}
+function getCellTexts(row) {
+	return filter({
+		predicate: includeRole(cellRoles),
+		snapshots: row.children
+	}).map((cell) => getTextContent(cell.children));
 }
 
 //#endregion
-export { excludeRole, filter, filterByRole, getTextContent, includeRole, snapshotElement, snapshotElementRaw };
+export { excludeRole, filter, filterByRole, getTextContent, includeRole, markdownTableSnapshot, snapshotElement, snapshotElementRaw };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cronn/element-snapshot",
-  "version": "0.14.0",
+  "version": "0.14.1",
   "description": "Element snapshots for Playwright",
   "bugs": {
     "url": "https://github.com/cronn/file-snapshots/issues"
@@ -59,10 +59,10 @@
     "tsdown": "0.20.3",
     "typescript-eslint": "8.56.1",
     "vitest": "4.0.18",
-    "@cronn/shared-configs": "0.0.0",
     "@cronn/playwright-file-snapshots": "1.0.1",
     "@cronn/test-utils": "0.0.0",
-    "@cronn/vitest-file-snapshots": "1.0.1"
+    "@cronn/vitest-file-snapshots": "1.0.1",
+    "@cronn/shared-configs": "0.0.0"
   },
   "peerDependencies": {
     "@playwright/test": "^1.55"