@cronn/element-snapshot 0.10.0 → 0.12.0

package/dist/index.d.ts

@@ -1,161 +0,0 @@
-import { Locator } from '@playwright/test';
-
-interface DisableableAttributes {
-    disabled?: boolean;
-}
-interface SelectableAttributes {
-    selected?: boolean;
-}
-interface InputStateAttributes extends DisableableAttributes {
-    readonly?: boolean;
-    required?: boolean;
-    invalid?: boolean;
-}
-
-interface ButtonSnapshot extends GenericElementSnapshot<"button", ButtonAttributes> {
-}
-interface ButtonAttributes extends DisableableAttributes {
-    expanded?: boolean;
-    pressed?: PressedValue;
-}
-type PressedValue = true | "mixed";
-
-interface DiscribableAttributes {
-    description?: string;
-}
-
-interface InputSnapshot extends GenericElementSnapshot<CommonInputRole, InputAttributes> {
-}
-type InputRole = "button" | "combobox" | CommonInputRole;
-type CommonInputRole = "checkbox" | "radio" | "searchbox" | "slider" | "spinbutton" | "textbox";
-interface InputAttributes extends CommonInputAttributes {
-    value?: string;
-    checked?: boolean;
-}
-interface CommonInputAttributes extends InputStateAttributes, DiscribableAttributes {
-    placeholder?: string;
-}
-
-interface ComboboxSnapshot extends GenericElementSnapshot<"combobox", ComboboxAttributes> {
-    options?: Array<OptionSnapshot>;
-}
-interface ComboboxAttributes extends CommonInputAttributes {
-    value?: string | Array<string>;
-}
-interface OptionSnapshot extends GenericElementSnapshot<"option", OptionAttributes> {
-}
-interface OptionAttributes {
-    selected?: boolean;
-}
-
-declare const CONTAINER_ROLES: Set<"paragraph" | "list" | "listitem" | "listbox" | "article" | "banner" | "complementary" | "contentinfo" | "form" | "main" | "navigation" | "region" | "search" | "term" | "definition" | "table" | "grid" | "rowgroup" | "row" | "rowheader" | "cell" | "gridcell" | "alert" | "menu" | "tablist" | "tabpanel" | "separator">;
-interface ContainerSnapshot extends GenericElementSnapshot<ContainerRole> {
-}
-type ContainerRole = SetValues<typeof CONTAINER_ROLES>;
-
-interface DialogSnapshot extends GenericElementSnapshot<DialogRole, DialogAttributes> {
-}
-type DialogRole = "dialog" | "alertdialog";
-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> {
-}
-interface HeadingAttributes {
-    level?: number;
-}
-
-interface ImageSnapshot extends GenericElementSnapshot<"img"> {
-}
-
-interface LinkSnapshot extends GenericElementSnapshot<"link", LinkAttributes> {
-}
-interface LinkAttributes {
-    url?: string;
-}
-
-interface MenuitemSnapshot extends GenericElementSnapshot<"menuitem", MenuitemAttributes> {
-}
-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 {
-}
-
-interface ColumnheaderSnapshot extends GenericElementSnapshot<"columnheader", ColumnheaderAttributes> {
-}
-interface ColumnheaderAttributes {
-    sort?: SortAttribute;
-}
-declare const SORT_ATTRIBUTES: Set<"ascending" | "descending" | "other">;
-type SortAttribute = SetValues<typeof SORT_ATTRIBUTES>;
-
-interface TextSnapshot {
-    role: "text";
-    name: string;
-}
-
-type NodeRole = ElementRole | "text";
-type ElementRole = "heading" | "link" | "button" | "option" | "tab" | "menuitem" | "columnheader" | "group" | "radiogroup" | "progressbar" | "img" | ContainerRole | InputRole | DialogRole;
-type NodeSnapshot = ElementSnapshot | TextSnapshot;
-type ElementSnapshot = ContainerSnapshot | HeadingSnapshot | LinkSnapshot | ButtonSnapshot | InputSnapshot | ComboboxSnapshot | OptionSnapshot | DialogSnapshot | TabSnapshot | MenuitemSnapshot | ColumnheaderSnapshot | GroupSnapshot | RadiogroupSnapshot | ProgressbarSnapshot | ImageSnapshot;
-interface GenericElementSnapshot<TRole extends NodeRole = NodeRole, TAttributes = unknown> {
-    role: TRole;
-    name?: string;
-    attributes?: TAttributes;
-    children?: Array<NodeSnapshot>;
-}
-type SetValues<TSet> = TSet extends Set<infer TValue> ? TValue : never;
-
-type SnapshotFilter = (node: NodeSnapshot) => boolean;
-
-interface ElementSnapshotOptions {
-    /**
-     * Include only elements in the snapshot for which the specified filter returns `true`
-     *
-     * @default () => true
-     */
-    filter?: SnapshotFilter;
-    /**
-     * Include combobox options in the snapshot
-     *
-     * @default false
-     */
-    includeComboboxOptions?: boolean;
-}
-/**
- * Creates an Element Snapshot of the specified element
- *
- * @example
- * ```ts
- * await expect(snapshotElement(page.getByRole("main"))).toMatchJsonSnapshot();
- * ```
- * @param locator Locator for the element to snapshot
- * @experimental
- */
-declare function snapshotElement(locator: Locator, options?: ElementSnapshotOptions): Promise<unknown>;
-/**
- * Creates an Element Snapshot of the specified element, returning the raw snapshot data for custom transformations
- *
- * @param locator Locator for the element to snapshot
- * @experimental
- */
-declare function snapshotElementRaw(locator: Locator): Promise<Array<NodeSnapshot>>;
-
-export { type ButtonSnapshot, type ColumnheaderSnapshot, type ComboboxSnapshot, type ContainerSnapshot, type DialogSnapshot, type ElementRole, type ElementSnapshot, type GroupSnapshot, type HeadingSnapshot, type InputSnapshot, type LinkSnapshot, type MenuitemSnapshot, type NodeRole, type NodeSnapshot, type OptionSnapshot, type ProgressbarSnapshot, type RadiogroupSnapshot, type TabSnapshot, type TextSnapshot, snapshotElement, snapshotElementRaw };

package/dist/index.js

@@ -1,169 +0,0 @@
-// src/playwright/proxy.ts
-import path from "path";
-import { packageDirectory } from "package-directory";
-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.global.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;
-  }
-};
-
-// src/playwright/transformer.ts
-var ElementSnapshotTransformer = class {
-  filter;
-  includeComboboxOptions;
-  constructor(options = {}) {
-    this.filter = options.filter ?? (() => true);
-    this.includeComboboxOptions = options.includeComboboxOptions ?? false;
-  }
-  transform(snapshots) {
-    const transformedSnapshots = this.filterAndTransformSnapshots(snapshots);
-    if (transformedSnapshots.length === 1) {
-      return transformedSnapshots.at(0);
-    }
-    return transformedSnapshots;
-  }
-  filterAndTransformSnapshots(snapshots) {
-    return snapshots.flatMap((snapshot) => {
-      if (this.filter(snapshot)) {
-        return this.transformSnapshotRecursive(snapshot);
-      }
-      if ("children" in snapshot) {
-        return this.filterAndTransformSnapshots(snapshot.children ?? []);
-      }
-      return [];
-    });
-  }
-  transformSnapshotRecursive(snapshot) {
-    if (snapshot.role === "text") {
-      return this.simplifyTextSnapshot(snapshot);
-    }
-    return this.simplifyElementSnapshot(snapshot);
-  }
-  simplifyTextSnapshot(snapshot) {
-    return snapshot.name;
-  }
-  simplifyElementSnapshot(snapshot) {
-    const normalizedSnapshot = this.normalizeElementSnapshot(snapshot);
-    if (this.isEmpty(normalizedSnapshot)) {
-      const { role: role2 } = normalizedSnapshot;
-      return this.transformedSnapshot(role2, "");
-    }
-    if (this.hasOnlyName(normalizedSnapshot)) {
-      const { role: role2, name: name2 } = normalizedSnapshot;
-      return this.transformedSnapshot(role2, name2);
-    }
-    if (this.hasOnlyChildren(normalizedSnapshot)) {
-      const { role: role2, children: children2 } = normalizedSnapshot;
-      return this.transformedSnapshot(
-        role2,
-        children2.length === 1 ? children2.at(0) : children2
-      );
-    }
-    if (snapshot.role === "combobox") {
-      return this.simplifyComboboxSnapshot(snapshot);
-    }
-    const { role, name, attributes, children } = normalizedSnapshot;
-    return this.transformedSnapshot(role, {
-      name,
-      ...attributes,
-      children
-    });
-  }
-  normalizeElementSnapshot(snapshot) {
-    const sparseAttributes = this.removeUndefinedProperties(
-      snapshot.attributes ?? {}
-    );
-    const transformedChildren = this.filterAndTransformSnapshots(
-      snapshot?.children ?? []
-    );
-    const nameEqualsChildren = transformedChildren.length === 1 && snapshot.name === transformedChildren.at(0);
-    return {
-      role: snapshot.role,
-      name: snapshot.name,
-      attributes: sparseAttributes,
-      children: nameEqualsChildren ? void 0 : transformedChildren.length === 0 ? void 0 : transformedChildren
-    };
-  }
-  simplifyComboboxSnapshot(snapshot) {
-    const { role, name, attributes } = this.normalizeElementSnapshot(snapshot);
-    const options = snapshot.options ?? [];
-    const transformedOptions = options.map(
-      (optionSnapshot) => this.simplifyElementSnapshot(optionSnapshot)
-    );
-    return this.transformedSnapshot(role, {
-      name,
-      ...attributes,
-      options: this.includeComboboxOptions && transformedOptions.length > 0 ? transformedOptions : void 0
-    });
-  }
-  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);
-  }
-  hasOnlyName(snapshot) {
-    return snapshot.name !== void 0 && snapshot.attributes === void 0 && snapshot.children === void 0;
-  }
-  hasOnlyChildren(snapshot) {
-    return snapshot.name === void 0 && snapshot.attributes === void 0 && snapshot.children !== void 0;
-  }
-  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;
-  }
-  transformedSnapshot(role, content) {
-    return { [role]: content };
-  }
-};
-
-// src/playwright/snapshot.ts
-async function snapshotElement(locator, options) {
-  const snapshot = await snapshotElementRaw(locator);
-  return new ElementSnapshotTransformer(options).transform(snapshot);
-}
-async function snapshotElementRaw(locator) {
-  return await new ElementSnapshotProxy(locator.page()).snapshotElement(
-    locator
-  );
-}
-export {
-  snapshotElement,
-  snapshotElementRaw
-};