wdio-ag-grid 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# wdio-ag-grid
+
+## 2.0.0
+
+### Major Changes
+
+- 536d809: Added WDIO support
+
+## 1.0.0
+
+### Major Changes
+
+- 2a7e5d7: Move to monorepo structure to support more node-based testing tools for ag grid interactions and validations
+
+### Patch Changes
+
+- Updated dependencies [2a7e5d7]
+  - @kpmck/ag-grid-core@1.0.0

package/README.md

@@ -0,0 +1,84 @@
+# wdio-ag-grid
+
+![WebdriverIO](./docs/images/webdriverio-logo.png)
+
+WebdriverIO helpers for interacting with and validating AG Grid.
+
+This package uses the shared `@kpmck/ag-grid-core` logic and exposes a WebdriverIO-friendly wrapper for common AG Grid behaviors.
+
+## Installation
+
+```bash
+npm install wdio-ag-grid --save-dev
+```
+
+Then import the helper in your WebdriverIO tests:
+
+```javascript
+import { createAgGrid, filterOperator, sort } from "wdio-ag-grid";
+```
+
+## Usage
+
+Consider the AG Grid example below:
+![AG Grid](../cypress-ag-grid/ag-grid-example.png)
+
+With the following DOM structure:
+![AG Grid Dom](../cypress-ag-grid/ag-grid-example-dom.png)
+
+Create a helper instance from the top-level AG Grid element:
+
+```javascript
+const grid = createAgGrid(await $("#myGrid"));
+```
+
+Read the grid as structured row data:
+
+```javascript
+const grid = createAgGrid(await $("#myGrid"));
+const tableData = await grid.getData();
+```
+
+Filter, sort, and edit cells:
+
+```javascript
+const grid = createAgGrid(await $("#myGrid2"));
+
+await grid.filterTextFloating({
+  searchCriteria: {
+    columnName: "Make",
+    filterValue: "Porsche",
+    operator: filterOperator.equals,
+  },
+  hasApplyButton: true,
+});
+
+await grid.sortColumn("Model", sort.ascending);
+
+const priceCell = await grid.getCellLocator(
+  { Make: "Porsche", Price: "72000" },
+  "Price"
+);
+
+await priceCell.doubleClick();
+await (await priceCell.$("input")).setValue("66000");
+await browser.keys("Enter");
+```
+
+## Supported Capabilities
+
+- get AG Grid data as structured objects
+- return only selected columns
+- sort and pin columns
+- filter by text in menus and floating filters
+- filter by checkbox values
+- toggle columns from the sidebar
+- edit grid cells with returned WDIO elements
+- wait for AG Grid-owned animations to finish
+
+## Monorepo Docs
+
+- root landing page: [`README.md`](../../README.md)
+- Cypress package: [`packages/cypress-ag-grid/README.md`](../cypress-ag-grid/README.md)
+- Playwright package: [`packages/playwright-ag-grid/README.md`](../playwright-ag-grid/README.md)
+- shared core: [`packages/ag-grid-core/README.md`](../ag-grid-core/README.md)

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "wdio-ag-grid",
+  "version": "2.0.0",
+  "description": "WebdriverIO helpers for interacting with AG Grid",
+  "type": "module",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "scripts": {
+    "test": "npm run test:all",
+    "test:all": "npm run test:v33 && npm run test:v34 && npm run test:v35",
+    "test:v33": "node --test --test-concurrency=1 tests/ag-grid-data.v33.spec.js tests/ag-grid-elements.v33.spec.js",
+    "test:v34": "node --test --test-concurrency=1 tests/ag-grid-data.v34.spec.js tests/ag-grid-elements.v34.spec.js",
+    "test:v35": "node --test --test-concurrency=1 tests/ag-grid-data.v35.spec.js tests/ag-grid-elements.v35.spec.js tests/ag-grid-animation-wait.v35.spec.js",
+    "test:watch": "node --test --watch --test-concurrency=1 tests/ag-grid-data.v33.spec.js tests/ag-grid-data.v34.spec.js tests/ag-grid-data.v35.spec.js tests/ag-grid-elements.v33.spec.js tests/ag-grid-elements.v34.spec.js tests/ag-grid-elements.v35.spec.js tests/ag-grid-animation-wait.v35.spec.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kpmck/cypress-ag-grid.git"
+  },
+  "keywords": [
+    "ag-grid",
+    "aggrid",
+    "webdriverio",
+    "wdio",
+    "testing",
+    "e2e"
+  ],
+  "author": "Kerry McKeever <kerry@kerrymckeever.com>",
+  "license": "MIT",
+  "dependencies": {
+    "@kpmck/ag-grid-core": "1.0.0",
+    "chromedriver": "^146.0.6",
+    "webdriverio": "^9.27.0"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,33 @@
+export declare const filterOperator: Record<string, string>;
+export declare const sort: Record<string, string>;
+
+export interface SearchCriteria {
+  columnName: string;
+  filterValue: string;
+  operator?: string;
+  searchInputIndex?: number;
+  operatorIndex?: number;
+  isMultiFilter?: boolean;
+}
+
+export interface FilterOptions {
+  searchCriteria: SearchCriteria | SearchCriteria[];
+  hasApplyButton?: boolean;
+  noMenuTabs?: boolean;
+  selectAllLocaleText?: string;
+}
+
+export declare class WdioAgGrid {
+  constructor(rootElement: any);
+  waitForAnimation(options?: object): Promise<void>;
+  getData(options?: object): Promise<any>;
+  sortColumn(columnName: string, sortDirection: string): Promise<void>;
+  pinColumn(columnName: string, pin?: "left" | "right" | null): Promise<void>;
+  filterTextMenu(options: FilterOptions): Promise<void>;
+  filterTextFloating(options: FilterOptions): Promise<void>;
+  filterCheckboxMenu(options: FilterOptions): Promise<void>;
+  toggleColumnFromSideBar(columnName: string, doRemove: boolean): Promise<void>;
+  getCellLocator(rowMatcher: Record<string, string>, columnName: string): Promise<any>;
+}
+
+export declare function createAgGrid(rootElement: any): WdioAgGrid;