@vuu-ui/vuu-playwright-helpers 3.5.20 → 3.5.21

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.5.20",
+  "version": "3.5.21",
   "author": "heswell",
   "license": "Apache-2.0",
   "main": "./src/index.js",
@@ -9,7 +9,7 @@
     "type-defs": "node ../../scripts/build-type-defs.mjs"
   },
   "dependencies": {
-    "@vuu-ui/vuu-protocol-types": "3.5.20"
+    "@vuu-ui/vuu-protocol-types": "3.5.21"
   },
   "peerDependencies": {
     "@playwright/test": "^1.62.1"

package/src/PwTable.js

@@ -39,6 +39,20 @@ class PwTable extends PwComponent {
         if (null === ariaRowCount) throw Error("PwTable, rowCount, table does not have an aria-rowcount");
         return parseInt(ariaRowCount, 10);
     }
+    get dataLoaded() {
+        return expect.poll(()=>this.rowCount()).toBeGreaterThan(0);
+    }
+    async columnValues(columnName) {
+        const headerCell = this.locator.locator(`xpath=.//*[@role='columnheader' and @data-column-name=${xpathStringLiteral(columnName)}]`).first();
+        const ariaColIndex = await headerCell.getAttribute("aria-colindex");
+        if (null === ariaColIndex) throw Error(`PwTable, columnValues, column "${columnName}" does not have an aria-colindex`);
+        const cells = this.locator.locator(`[role="row"] > [role="cell"][aria-colindex="${ariaColIndex}"]`);
+        const values = await cells.evaluateAll((elements)=>elements.map((cell)=>({
+                    rowIndex: Number(cell.parentElement?.getAttribute("aria-rowindex")),
+                    text: cell.textContent ?? ""
+                })));
+        return values.sort((v1, v2)=>v1.rowIndex - v2.rowIndex).map(({ text })=>text);
+    }
     async cellIcon(columnName, ariaRowIndex, iconName) {
         const cell = await this.cell(columnName, ariaRowIndex);
         return cell.locator(byDataIcon(iconName));

package/types/PwTable.d.ts

@@ -100,6 +100,32 @@ export declare class PwTable extends PwComponent {
      * });
      */
     rowCount(): Promise<number>;
+    /**
+     * Wait until the table has loaded data, i.e. rowCount is greater than zero.
+     *
+     * @example
+     * test("table loads", async ({ mount, page }) => {
+     *   await mount("Filters/FilterContainer/FilterContainerWithTable");
+     *   const table = new PwTable(page);
+     *   await table.dataLoaded;
+     * });
+     */
+    get dataLoaded(): Promise<void>;
+    /**
+     * The text content of the data cells in a column, exactly as formatted in
+     * the table, in row order. These are the cells in data rows with the same
+     * aria-colindex as the column header. The table is virtualised, so only
+     * rendered rows are included.
+     *
+     * @example
+     * test("filter on currency", async ({ page }) => {
+     *   const table = new PwTable(page);
+     *   await expect
+     *     .poll(async () => new Set(await table.columnValues("currency")))
+     *     .toEqual(new Set(["GBP"]));
+     * });
+     */
+    columnValues(columnName: string): Promise<string[]>;
     /**
      * Locate the icon with the given data-icon name within a cell.
      *