@cronn/element-snapshot 0.12.0 → 0.13.0

package/dist/browser-lib.iife.js

@@ -26,8 +26,13 @@
 //#endregion
 //#region src/browser/children.ts
 	function snapshotChildren(node, excludedNodes = []) {
-		const children = Array.from(node.childNodes).map((node) => snapshotNodeRecursive(node, excludedNodes)).filter((childSnapshot) => childSnapshot !== null).flat();
-		return children.length > 0 ? children : void 0;
+		return Array.from(node.childNodes).map((childNode) => snapshotNodeRecursive(childNode, excludedNodes)).filter((childSnapshot) => childSnapshot !== null).flat();
+	}
+
+//#endregion
+//#region src/utils/guards.ts
+	function isTextSnapshot(snapshot) {
+		return snapshot.role === "text";
 	}
 
 //#endregion
@@ -46,12 +51,12 @@
 			if (!isFilteredIn) return filteredChildren;
 			return {
 				...snapshot,
-				children: filteredChildren.length > 0 ? filteredChildren : void 0
+				children: filteredChildren
 			};
 		});
 	}
 	function hasChildren(snapshot) {
-		return "children" in snapshot && snapshot.children !== void 0 && snapshot.children.length > 0;
+		return "children" in snapshot && snapshot.children.length > 0;
 	}
 
 //#endregion
@@ -67,7 +72,7 @@
 	}
 	function snapshotPresentationalChildren(node) {
 		const accessibleTextContent = resolveAccessibleTextContent(node);
-		if (accessibleTextContent === void 0 || accessibleTextContent.length === 0) return;
+		if (accessibleTextContent === void 0 || accessibleTextContent.length === 0) return [];
 		return [{
 			role: "text",
 			name: accessibleTextContent
@@ -78,7 +83,7 @@
 		if (children === void 0) return;
 		const normalizedText = normalizeText(filterSnapshots({
 			snapshots: children,
-			filter: (element) => element.role === "text"
+			filter: isTextSnapshot
 		}).map((textNode) => textNode.name).join(" "));
 		return normalizedText.length > 0 ? normalizedText : void 0;
 	}
@@ -190,6 +195,7 @@
 		return {
 			role,
 			name: resolveAccessibleName(element, false),
+			attributes: {},
 			children
 		};
 	}
@@ -396,7 +402,8 @@
 				value,
 				checked: resolveChecked(element),
 				...snapshotCommonInputAttributes(element, value === void 0)
-			}
+			},
+			children: []
 		};
 	}
 	function snapshotTextareaElement(element) {
@@ -407,7 +414,8 @@
 			attributes: {
 				value,
 				...snapshotCommonInputAttributes(element, value === void 0)
-			}
+			},
+			children: []
 		};
 	}
 	function snapshotCommonInputAttributes(element, isEmpty) {
@@ -454,6 +462,7 @@
 				value,
 				...snapshotCommonInputAttributes(element, value === void 0)
 			},
+			children: [],
 			options
 		};
 	}
@@ -512,6 +521,7 @@
 		return {
 			role: "group",
 			name: resolveGroupName(element),
+			attributes: {},
 			children: snapshotChildren(element)
 		};
 	}
@@ -552,7 +562,9 @@
 		if (imageName === void 0) return null;
 		return {
 			role: "img",
-			name: imageName
+			name: imageName,
+			attributes: {},
+			children: []
 		};
 	}
 	function resolveImageName(element) {
@@ -608,6 +620,7 @@
 	function snapshotSeparator(element) {
 		return {
 			role: "separator",
+			attributes: {},
 			children: snapshotPresentationalChildren(element)
 		};
 	}

package/dist/index.d.mts

@@ -40,7 +40,7 @@ interface CommonInputAttributes extends InputStateAttributes, DiscribableAttribu
 //#endregion
 //#region src/browser/combobox.d.ts
 interface ComboboxSnapshot extends GenericElementSnapshot<"combobox", ComboboxAttributes> {
-  options?: Array<OptionSnapshot>;
+  options: Array<OptionSnapshot>;
 }
 interface ComboboxAttributes extends CommonInputAttributes {
   value?: string | Array<string>;
@@ -118,20 +118,17 @@ type NodeRole = ElementRole | "text";
 type ElementRole = "heading" | "link" | "button" | "option" | "tab" | "menuitem" | "columnheader" | "group" | "radiogroup" | "progressbar" | "img" | "separator" | ContainerRole | InputRole | DialogRole;
 type NodeSnapshot = ElementSnapshot | TextSnapshot;
 type ElementSnapshot = ContainerSnapshot | HeadingSnapshot | LinkSnapshot | ButtonSnapshot | InputSnapshot | ComboboxSnapshot | OptionSnapshot | DialogSnapshot | TabSnapshot | MenuitemSnapshot | ColumnheaderSnapshot | GroupSnapshot | RadiogroupSnapshot | ProgressbarSnapshot | ImageSnapshot | SeparatorSnapshot;
-interface GenericElementSnapshot<TRole extends NodeRole = NodeRole, TAttributes = unknown> {
+interface GenericElementSnapshot<TRole extends NodeRole = NodeRole, TAttributes = Record<string, unknown>> {
   role: TRole;
   name?: string;
-  attributes?: TAttributes;
-  children?: Array<NodeSnapshot>;
+  attributes: TAttributes;
+  children: Array<NodeSnapshot>;
 }
 type SetValues<TSet> = TSet extends Set<infer TValue> ? TValue : never;
 //#endregion
 //#region src/utils/snapshot.d.ts
 type SnapshotFilter = (snapshot: NodeSnapshot) => boolean;
 type GuardedSnapshotFilter<TSnapshot extends NodeSnapshot> = (snapshot: NodeSnapshot) => snapshot is TSnapshot;
-type FilteredSnapshot<TSnapshot extends NodeSnapshot> = TSnapshot extends GenericElementSnapshot ? TSnapshot & {
-  children?: Array<TSnapshot>;
-} : TSnapshot;
 interface SnapshotFilterOptions {
   filter: SnapshotFilter;
   snapshots: Array<NodeSnapshot>;
@@ -142,7 +139,7 @@ interface GuardedSnapshotFilterOptions<TSnapshot extends NodeSnapshot> {
   snapshots: Array<NodeSnapshot>;
   recurse?: boolean;
 }
-declare function filterSnapshots<TSnapshot extends NodeSnapshot = NodeSnapshot>(options: GuardedSnapshotFilterOptions<TSnapshot>): Array<FilteredSnapshot<TSnapshot>>;
+declare function filterSnapshots<TSnapshot extends NodeSnapshot = NodeSnapshot>(options: GuardedSnapshotFilterOptions<TSnapshot>): Array<TSnapshot>;
 declare function filterSnapshots(options: SnapshotFilterOptions): Array<NodeSnapshot>;
 //#endregion
 //#region src/playwright/snapshot.d.ts

package/dist/index.mjs

@@ -28,6 +28,16 @@ var ElementSnapshotProxy = class {
 	}
 };
 
+//#endregion
+//#region src/utils/guards.ts
+function isTextSnapshot(snapshot) {
+	return snapshot.role === "text";
+}
+function isEmpty(value) {
+	if (typeof value === "string" || Array.isArray(value)) return value.length === 0;
+	return Object.keys(value).length === 0;
+}
+
 //#endregion
 //#region src/utils/snapshot.ts
 function filterSnapshots(options) {
@@ -44,12 +54,12 @@ function filterSnapshots(options) {
 		if (!isFilteredIn) return filteredChildren;
 		return {
 			...snapshot,
-			children: filteredChildren.length > 0 ? filteredChildren : void 0
+			children: filteredChildren
 		};
 	});
 }
 function hasChildren(snapshot) {
-	return "children" in snapshot && snapshot.children !== void 0 && snapshot.children.length > 0;
+	return "children" in snapshot && snapshot.children.length > 0;
 }
 
 //#endregion
@@ -81,7 +91,7 @@ var ElementSnapshotTransformer = class {
 		return snapshots.map((snapshot) => this.transformSnapshotRecursive(snapshot));
 	}
 	transformSnapshotRecursive(snapshot) {
-		if (snapshot.role === "text") return this.simplifyTextSnapshot(snapshot);
+		if (isTextSnapshot(snapshot)) return this.simplifyTextSnapshot(snapshot);
 		return this.simplifyElementSnapshot(snapshot);
 	}
 	simplifyTextSnapshot(snapshot) {
@@ -104,25 +114,26 @@ var ElementSnapshotTransformer = class {
 		if (snapshot.role === "combobox") return this.simplifyComboboxSnapshot(snapshot);
 		const { role, name, attributes, children } = normalizedSnapshot;
 		return this.transformedSnapshot(role, {
-			name,
+			name: name.length === 0 ? void 0 : name,
 			...attributes,
-			children
+			children: children.length === 0 ? void 0 : children
 		});
 	}
 	normalizeElementSnapshot(snapshot) {
-		const sparseAttributes = this.removeUndefinedProperties(snapshot.attributes ?? {});
-		const transformedChildren = this.transformSnapshots(snapshot?.children ?? []);
-		const nameEqualsChildren = transformedChildren.length === 1 && snapshot.name === transformedChildren.at(0);
+		const normalizedName = snapshot.name ?? "";
+		const sparseAttributes = this.removeUndefinedProperties(snapshot.attributes);
+		const transformedChildren = this.transformSnapshots(snapshot.children);
+		const nameEqualsChildren = transformedChildren.length === 1 && normalizedName === transformedChildren.at(0);
 		return {
 			role: snapshot.role,
-			name: snapshot.name,
+			name: normalizedName,
 			attributes: sparseAttributes,
-			children: nameEqualsChildren ? void 0 : transformedChildren.length === 0 ? void 0 : transformedChildren
+			children: nameEqualsChildren ? [] : transformedChildren
 		};
 	}
 	simplifyComboboxSnapshot(snapshot) {
 		const { role, name, attributes } = this.normalizeElementSnapshot(snapshot);
-		const transformedOptions = (snapshot.options ?? []).map((optionSnapshot) => this.simplifyElementSnapshot(optionSnapshot));
+		const transformedOptions = snapshot.options.map((optionSnapshot) => this.simplifyElementSnapshot(optionSnapshot));
 		return this.transformedSnapshot(role, {
 			name,
 			...attributes,
@@ -130,20 +141,20 @@ var ElementSnapshotTransformer = class {
 		});
 	}
 	isEmpty(snapshot) {
-		return snapshot.name === void 0 && (snapshot.attributes === void 0 || Object.keys(snapshot.attributes).length === 0) && (snapshot.children === void 0 || snapshot.children.length === 0);
+		return isEmpty(snapshot.name) && isEmpty(snapshot.attributes) && isEmpty(snapshot.children);
 	}
 	hasOnlyName(snapshot) {
-		return snapshot.name !== void 0 && snapshot.attributes === void 0 && snapshot.children === void 0;
+		return !isEmpty(snapshot.name) && isEmpty(snapshot.attributes) && isEmpty(snapshot.children);
 	}
 	hasOnlyChildren(snapshot) {
-		return snapshot.name === void 0 && snapshot.attributes === void 0 && snapshot.children !== void 0;
+		return isEmpty(snapshot.name) && isEmpty(snapshot.attributes) && !isEmpty(snapshot.children);
 	}
 	removeUndefinedProperties(attributes) {
 		const sparseAttributes = {};
 		Object.entries(attributes).forEach(([key, value]) => {
 			if (value !== void 0) sparseAttributes[key] = value;
 		});
-		return Object.keys(sparseAttributes).length > 0 ? sparseAttributes : void 0;
+		return sparseAttributes;
 	}
 	transformedSnapshot(role, content) {
 		return { [role]: content };

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@cronn/element-snapshot",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Element snapshots for Playwright",
+  "bugs": {
+    "url": "https://github.com/cronn/file-snapshots/issues"
+  },
   "author": "cronn",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/cronn/file-snapshots.git",
+    "url": "git+https://github.com/cronn/file-snapshots.git",
     "directory": "packages/element-snapshot"
   },
   "homepage": "https://github.com/cronn/file-snapshots",
@@ -40,19 +43,21 @@
     "package-directory": "8.2.0"
   },
   "devDependencies": {
+    "@arethetypeswrong/core": "0.18.2",
     "@playwright/test": "1.58.2",
     "@trivago/prettier-plugin-sort-imports": "6.0.2",
-    "@types/node": "24.10.12",
+    "@typescript/native-preview": "7.0.0-dev.20260218.1",
+    "@types/node": "24.10.13",
     "@vitest/coverage-v8": "4.0.18",
-    "eslint": "9.39.2",
+    "eslint": "10.0.1",
     "eslint-config-prettier": "10.1.8",
-    "eslint-plugin-unused-imports": "4.3.0",
+    "eslint-plugin-unused-imports": "4.4.1",
     "prettier": "3.8.1",
+    "publint": "0.3.17",
     "tsdown": "0.20.3",
-    "typescript": "5.9.3",
-    "typescript-eslint": "8.54.0",
+    "typescript-eslint": "8.56.0",
     "vitest": "4.0.18",
-    "@cronn/playwright-file-snapshots": "0.38.1",
+    "@cronn/playwright-file-snapshots": "1.0.0",
     "@cronn/shared-configs": "0.0.0",
     "@cronn/test-utils": "0.0.0"
   },
@@ -60,13 +65,13 @@
     "@playwright/test": "^1.55"
   },
   "scripts": {
-    "lint:check": "eslint src/ --max-warnings=0",
-    "lint:fix": "eslint src/ --max-warnings=0 --fix",
+    "lint:check": "eslint src/ tests/ --max-warnings=0",
+    "lint:fix": "eslint src/ tests/ --max-warnings=0 --fix",
     "test:unit": "vitest run",
     "test:unit:coverage": "vitest run --coverage",
     "test:integration": "playwright test",
     "playwright:install": "playwright install chromium",
-    "compile": "tsc",
+    "compile": "tsgo",
     "build": "tsdown"
   }
 }