@cronn/element-snapshot 0.6.0 → 0.8.0

package/dist/index.d.ts

@@ -18,6 +18,10 @@ interface ButtonAttributes extends DisableableAttributes {
 }
 type PressedValue = true | "mixed";
 
+interface DiscribableAttributes {
+    description?: string;
+}
+
 interface InputSnapshot extends GenericElementSnapshot<CommonInputRole, InputAttributes> {
 }
 type InputRole = "button" | "combobox" | CommonInputRole;
@@ -26,8 +30,7 @@ interface InputAttributes extends CommonInputAttributes {
     value?: string;
     checked?: boolean;
 }
-interface CommonInputAttributes extends InputStateAttributes {
-    description?: string;
+interface CommonInputAttributes extends InputStateAttributes, DiscribableAttributes {
     placeholder?: string;
 }
 
@@ -46,13 +49,16 @@ interface OptionAttributes {
 interface DialogSnapshot extends GenericElementSnapshot<DialogRole, DialogAttributes> {
 }
 type DialogRole = "dialog" | "alertdialog";
-interface DialogAttributes {
-    description?: string;
+interface DialogAttributes extends DiscribableAttributes {
     modal?: boolean;
 }
 
 interface GroupSnapshot extends GenericElementSnapshot<"group"> {
 }
+interface RadiogroupSnapshot extends GenericElementSnapshot<"radiogroup", RadiogroupAttributes> {
+}
+interface RadiogroupAttributes extends DiscribableAttributes {
+}
 
 interface HeadingSnapshot extends GenericElementSnapshot<"heading", HeadingAttributes> {
 }
@@ -71,6 +77,12 @@ interface MenuitemSnapshot extends GenericElementSnapshot<"menuitem", MenuitemAt
 interface MenuitemAttributes extends LinkAttributes, DisableableAttributes {
 }
 
+interface ProgressbarSnapshot extends GenericElementSnapshot<"progressbar", ProgressbarAttributes> {
+}
+interface ProgressbarAttributes {
+    value?: number;
+}
+
 interface TabSnapshot extends GenericElementSnapshot<"tab", TabAttributes> {
 }
 interface TabAttributes extends DisableableAttributes, SelectableAttributes {
@@ -91,9 +103,9 @@ interface TextSnapshot {
 
 type SnapshotTargetElement = HTMLElement | SVGElement;
 type NodeRole = ElementRole | "text";
-type ElementRole = "heading" | "link" | "button" | "option" | "tab" | "menuitem" | "columnheader" | "group" | ContainerRole | InputRole | DialogRole;
+type ElementRole = "heading" | "link" | "button" | "option" | "tab" | "menuitem" | "columnheader" | "group" | "radiogroup" | "progressbar" | ContainerRole | InputRole | DialogRole;
 type NodeSnapshot = ElementSnapshot | TextSnapshot;
-type ElementSnapshot = ContainerSnapshot | HeadingSnapshot | LinkSnapshot | ButtonSnapshot | InputSnapshot | ComboboxSnapshot | OptionSnapshot | DialogSnapshot | TabSnapshot | MenuitemSnapshot | ColumnheaderSnapshot | GroupSnapshot;
+type ElementSnapshot = ContainerSnapshot | HeadingSnapshot | LinkSnapshot | ButtonSnapshot | InputSnapshot | ComboboxSnapshot | OptionSnapshot | DialogSnapshot | TabSnapshot | MenuitemSnapshot | ColumnheaderSnapshot | GroupSnapshot | RadiogroupSnapshot | ProgressbarSnapshot;
 interface GenericElementSnapshot<TRole extends NodeRole = NodeRole, TAttributes = unknown> {
     role: TRole;
     name?: string;

package/dist/index.global.js

@@ -126,6 +126,11 @@
   }
 
   // src/snapshots/description.ts
+  function discribableAttributes(element) {
+    return {
+      description: resolveDescription(element)
+    };
+  }
   function resolveDescription(element) {
     const describedByElement = resolveElementReference(
       element,
@@ -236,7 +241,8 @@
     tr: "row",
     th: resolveTableHeaderCellRole,
     td: "cell",
-    fieldset: "group"
+    fieldset: "group",
+    progress: "progressbar"
   };
   var CONTEXT_DEPENDENT_ROLES = {
     banner: isTopLevelBanner,
@@ -427,13 +433,14 @@
   }
   function snapshotCommonInputAttributes(element, isEmpty) {
     return {
-      description: resolveDescription(element),
+      ...discribableAttributes(element),
       placeholder: isEmpty ? resolvePlaceholder(element) : void 0,
       ...inputStateAttributes(element)
     };
   }
+  var CHECKED_INPUT_TYPES = /* @__PURE__ */ new Set(["checkbox", "radio"]);
   function resolveInputValue(element) {
-    if (element instanceof HTMLInputElement && element.type === "checkbox") {
+    if (element instanceof HTMLInputElement && CHECKED_INPUT_TYPES.has(element.type)) {
       return void 0;
     }
     return stringAttribute(element.value);
@@ -476,7 +483,7 @@
       return null;
     }
     const options = snapshotOptions(element);
-    const value = resolveValue(element, options);
+    const value = resolveValue(element);
     return {
       role: "combobox",
       name: resolveInputLabel(element),
@@ -496,15 +503,23 @@
     }
     return false;
   }
-  function resolveValue(element, options) {
-    const selectedOptions = options.filter((option) => option.attributes?.selected === true).map((option) => option.name).filter((optionName) => optionName !== void 0);
-    if (selectedOptions.length === 0) {
-      return element instanceof HTMLInputElement ? resolveInputValue(element) : void 0;
+  function resolveValue(element) {
+    if (element instanceof HTMLButtonElement) {
+      return snapshotTextContent(element);
     }
-    if (selectedOptions.length === 1) {
-      return selectedOptions.at(0);
+    if (element instanceof HTMLInputElement) {
+      return resolveInputValue(element);
     }
-    return selectedOptions;
+    const selectedLabels = Array.from(element.selectedOptions).map(
+      (option) => option.label
+    );
+    if (selectedLabels.length === 0) {
+      return void 0;
+    }
+    if (selectedLabels.length === 1) {
+      return selectedLabels.at(0);
+    }
+    return selectedLabels;
   }
   function snapshotOptions(element) {
     return resolveOptions(element).map(snapshotOption).filter((childSnapshot) => childSnapshot !== null);
@@ -513,10 +528,6 @@
     if (element instanceof HTMLSelectElement) {
       return Array.from(element.options);
     }
-    const ariaExpanded = element.ariaExpanded === "true";
-    if (!ariaExpanded) {
-      return [];
-    }
     const controlledElement = resolveElementReference(element, "aria-controls");
     if (controlledElement === null) {
       return [];
@@ -544,7 +555,7 @@
       role,
       name: resolveAccessibleName(element, false),
       attributes: {
-        description: resolveDescription(element),
+        ...discribableAttributes(element),
         modal: booleanAttribute(element.ariaModal)
       },
       children: snapshotChildren(element)
@@ -566,6 +577,14 @@
     }
     return resolveAccessibleName(element, false);
   }
+  function snapshotRadiogroup(element) {
+    return {
+      role: "radiogroup",
+      name: resolveAccessibleName(element, false),
+      attributes: discribableAttributes(element),
+      children: snapshotChildren(element)
+    };
+  }
 
   // src/snapshots/heading.ts
   var LEVEL_REGEXP = /^H([1-6])$/;
@@ -613,6 +632,24 @@
     };
   }
 
+  // src/snapshots/progressbar.ts
+  function snapshotProgressbar(element) {
+    return {
+      role: "progressbar",
+      name: resolveAccessibleName(element, false),
+      attributes: {
+        value: resolveValue2(element)
+      },
+      children: snapshotChildren(element)
+    };
+  }
+  function resolveValue2(element) {
+    if (element instanceof HTMLProgressElement) {
+      return element.value;
+    }
+    return numericAttribute(element.ariaValueNow);
+  }
+
   // src/snapshots/tab.ts
   function snapshotTab(element) {
     return {
@@ -657,7 +694,9 @@
     tab: snapshotTab,
     menuitem: snapshotMenuitem,
     columnheader: snapshotColumnheader,
-    group: snapshotGroup
+    group: snapshotGroup,
+    radiogroup: snapshotRadiogroup,
+    progressbar: snapshotProgressbar
   };
   function snapshotElement(element) {
     return snapshotNodeRecursive(element);

package/dist/types.d.ts

@@ -18,6 +18,10 @@ interface ButtonAttributes extends DisableableAttributes {
 }
 type PressedValue = true | "mixed";
 
+interface DiscribableAttributes {
+    description?: string;
+}
+
 interface InputSnapshot extends GenericElementSnapshot<CommonInputRole, InputAttributes> {
 }
 type InputRole = "button" | "combobox" | CommonInputRole;
@@ -26,8 +30,7 @@ interface InputAttributes extends CommonInputAttributes {
     value?: string;
     checked?: boolean;
 }
-interface CommonInputAttributes extends InputStateAttributes {
-    description?: string;
+interface CommonInputAttributes extends InputStateAttributes, DiscribableAttributes {
     placeholder?: string;
 }
 
@@ -51,13 +54,16 @@ type ContainerRole = SetValues<typeof CONTAINER_ROLES>;
 interface DialogSnapshot extends GenericElementSnapshot<DialogRole, DialogAttributes> {
 }
 type DialogRole = "dialog" | "alertdialog";
-interface DialogAttributes {
-    description?: string;
+interface DialogAttributes extends DiscribableAttributes {
     modal?: boolean;
 }
 
 interface GroupSnapshot extends GenericElementSnapshot<"group"> {
 }
+interface RadiogroupSnapshot extends GenericElementSnapshot<"radiogroup", RadiogroupAttributes> {
+}
+interface RadiogroupAttributes extends DiscribableAttributes {
+}
 
 interface HeadingSnapshot extends GenericElementSnapshot<"heading", HeadingAttributes> {
 }
@@ -76,6 +82,12 @@ interface MenuitemSnapshot extends GenericElementSnapshot<"menuitem", MenuitemAt
 interface MenuitemAttributes extends LinkAttributes, DisableableAttributes {
 }
 
+interface ProgressbarSnapshot extends GenericElementSnapshot<"progressbar", ProgressbarAttributes> {
+}
+interface ProgressbarAttributes {
+    value?: number;
+}
+
 interface TabSnapshot extends GenericElementSnapshot<"tab", TabAttributes> {
 }
 interface TabAttributes extends DisableableAttributes, SelectableAttributes {
@@ -95,9 +107,9 @@ interface TextSnapshot {
 }
 
 type NodeRole = ElementRole | "text";
-type ElementRole = "heading" | "link" | "button" | "option" | "tab" | "menuitem" | "columnheader" | "group" | ContainerRole | InputRole | DialogRole;
+type ElementRole = "heading" | "link" | "button" | "option" | "tab" | "menuitem" | "columnheader" | "group" | "radiogroup" | "progressbar" | ContainerRole | InputRole | DialogRole;
 type NodeSnapshot = ElementSnapshot | TextSnapshot;
-type ElementSnapshot = ContainerSnapshot | HeadingSnapshot | LinkSnapshot | ButtonSnapshot | InputSnapshot | ComboboxSnapshot | OptionSnapshot | DialogSnapshot | TabSnapshot | MenuitemSnapshot | ColumnheaderSnapshot | GroupSnapshot;
+type ElementSnapshot = ContainerSnapshot | HeadingSnapshot | LinkSnapshot | ButtonSnapshot | InputSnapshot | ComboboxSnapshot | OptionSnapshot | DialogSnapshot | TabSnapshot | MenuitemSnapshot | ColumnheaderSnapshot | GroupSnapshot | RadiogroupSnapshot | ProgressbarSnapshot;
 interface GenericElementSnapshot<TRole extends NodeRole = NodeRole, TAttributes = unknown> {
     role: TRole;
     name?: string;
@@ -106,4 +118,4 @@ interface GenericElementSnapshot<TRole extends NodeRole = NodeRole, TAttributes
 }
 type SetValues<TSet> = TSet extends Set<infer TValue> ? TValue : never;
 
-export type { ButtonSnapshot, ColumnheaderSnapshot, ComboboxSnapshot, ContainerSnapshot, DialogSnapshot, ElementRole, ElementSnapshot, GroupSnapshot, HeadingSnapshot, InputSnapshot, LinkSnapshot, MenuitemSnapshot, NodeRole, NodeSnapshot, OptionSnapshot, TabSnapshot, TextSnapshot };
+export type { ButtonSnapshot, ColumnheaderSnapshot, ComboboxSnapshot, ContainerSnapshot, DialogSnapshot, ElementRole, ElementSnapshot, GroupSnapshot, HeadingSnapshot, InputSnapshot, LinkSnapshot, MenuitemSnapshot, NodeRole, NodeSnapshot, OptionSnapshot, ProgressbarSnapshot, TabSnapshot, TextSnapshot };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cronn/element-snapshot",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Element snapshots for Playwright",
   "author": "cronn",
   "license": "Apache-2.0",