@atomic-testing/component-driver-mui-x-v8 0.75.0 → 0.77.0

package/dist/index.d.mts

@@ -184,11 +184,29 @@ declare class DataGridProDriver extends ComponentDriver<typeof parts> {
    * @returns
    */
   getCellText(query: DataGridCellQuery): Promise<string>;
+  /**
+   * Determine if the pagination footer is currently visible.
+   */
   isFooterVisible(): Promise<boolean>;
+  /**
+   * Check whether the "previous page" control is enabled.
+   */
   isPreviousPageEnabled(): Promise<boolean>;
+  /**
+   * Navigate to the previous page using the grid footer control.
+   */
   gotoPreviousPage(): Promise<void>;
+  /**
+   * Check whether the "next page" control is enabled.
+   */
   isNextPageEnabled(): Promise<boolean>;
+  /**
+   * Navigate to the next page using the grid footer control.
+   */
   gotoNextPage(): Promise<void>;
+  /**
+   * Read the textual description of the current pagination state.
+   */
   getPaginationDescription(): Promise<Optional<string>>;
   get driverName(): string;
 }

package/dist/index.d.ts

@@ -184,11 +184,29 @@ declare class DataGridProDriver extends ComponentDriver<typeof parts> {
    * @returns
    */
   getCellText(query: DataGridCellQuery): Promise<string>;
+  /**
+   * Determine if the pagination footer is currently visible.
+   */
   isFooterVisible(): Promise<boolean>;
+  /**
+   * Check whether the "previous page" control is enabled.
+   */
   isPreviousPageEnabled(): Promise<boolean>;
+  /**
+   * Navigate to the previous page using the grid footer control.
+   */
   gotoPreviousPage(): Promise<void>;
+  /**
+   * Check whether the "next page" control is enabled.
+   */
   isNextPageEnabled(): Promise<boolean>;
+  /**
+   * Navigate to the next page using the grid footer control.
+   */
   gotoNextPage(): Promise<void>;
+  /**
+   * Read the textual description of the current pagination state.
+   */
   getPaginationDescription(): Promise<Optional<string>>;
   get driverName(): string;
 }

package/dist/index.js

@@ -328,25 +328,43 @@ var DataGridProDriver = class extends __atomic_testing_core.ComponentDriver {
 		}
 		throw new Error(`Cell at row:${query.rowIndex} column:${query.columnIndex ?? query.columnField} does not exist`);
 	}
+	/**
+	* Determine if the pagination footer is currently visible.
+	*/
 	isFooterVisible() {
 		return this.parts.footer.isVisible();
 	}
+	/**
+	* Check whether the "previous page" control is enabled.
+	*/
 	async isPreviousPageEnabled() {
 		await this.enforcePartExistence("footer");
 		return this.parts.footer.isPreviousPageEnabled();
 	}
+	/**
+	* Navigate to the previous page using the grid footer control.
+	*/
 	async gotoPreviousPage() {
 		await this.enforcePartExistence("footer");
 		await this.parts.footer.gotoPreviousPage();
 	}
+	/**
+	* Check whether the "next page" control is enabled.
+	*/
 	async isNextPageEnabled() {
 		await this.enforcePartExistence("footer");
 		return this.parts.footer.isNextPageEnabled();
 	}
+	/**
+	* Navigate to the next page using the grid footer control.
+	*/
 	async gotoNextPage() {
 		await this.enforcePartExistence("footer");
 		await this.parts.footer.gotoNextPage();
 	}
+	/**
+	* Read the textual description of the current pagination state.
+	*/
 	async getPaginationDescription() {
 		await this.enforcePartExistence("footer");
 		return this.parts.footer.getText();

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["ComponentDriver","HTMLElementDriver","textList: string[]","cellIndexOrField: number | string","driverClass: typeof ComponentDriver","cellLocator: PartLocator","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","parts","HTMLButtonDriver","ComponentDriver","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","parts","HTMLElementDriver","ComponentDriver","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","HTMLElementDriver","ComponentDriver","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","timeoutMs: number","rowIndex: number","query: DataGridCellQuery","driverClass: typeof ComponentDriver"],"sources":["../src/components/datagrid/DataGridRowDriverBase.ts","../src/components/datagrid/DataGridDataRowDriver.ts","../src/components/datagrid/DataGridHeaderRowDriver.ts","../src/components/datagrid/DataGridPaginationActionDriver.ts","../src/components/datagrid/DataGridFooterDriver.ts","../src/components/datagrid/DataGridProDriver.ts"],"sourcesContent":["import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport { byAttribute, ComponentDriver, listHelper, locatorUtil, PartLocator } from '@atomic-testing/core';\n\n// In MUI7, there is an extra div preceding the actual data cells. We need to skip it.\nconst columnStartingIndex = 1;\n\n/**\n * Base class for data grid row\n */\nexport abstract class DataGridRowDriverBase extends ComponentDriver {\n  protected async getCellCount(): Promise<number> {\n    let count = 0;\n    for await (const _ of listHelper.getListItemIterator(\n      this,\n      this.getCellLocator(),\n      HTMLElementDriver,\n      columnStartingIndex\n    )) {\n      count++;\n    }\n    return count;\n  }\n\n  /**\n   * Get the text of each visible cell in the row.\n   * Caveat: Because of virtualization, the text of the cell may not be available until the cell is visible.\n   * @returns A promise array of text of each visible cell in the row\n   */\n  async getRowText(): Promise<string[]> {\n    const textList: string[] = [];\n    for await (const cell of listHelper.getListItemIterator(\n      this,\n      this.getCellLocator(),\n      HTMLElementDriver,\n      columnStartingIndex\n    )) {\n      const text = await cell.getText();\n      textList.push(text!.trim());\n    }\n    return textList;\n  }\n\n  /**\n   * Get the cell driver at the specified index or data field.\n   * Caveat: Because of virtualization, the cell may not be available until the cell is visible.\n   * @param cellIndexOrField number: column index, string: column field\n   * @param driverClass The driver class of the cell. Default is HTMLElementDriver\n   * @returns A promise of the cell driver, or null if the cell is not found\n   */\n  async getCell<DriverT extends ComponentDriver>(\n    cellIndexOrField: number | string, // number: column index, string: column field\n    // @ts-ignore\n    driverClass: typeof ComponentDriver = HTMLElementDriver\n  ): Promise<DriverT | null> {\n    let cellLocator: PartLocator;\n    if (typeof cellIndexOrField === 'number') {\n      cellLocator = byAttribute('data-colindex', cellIndexOrField.toString());\n    } else {\n      cellLocator = byAttribute('data-field', cellIndexOrField);\n    }\n    const locator = locatorUtil.append(this.locator, cellLocator);\n    const cellExists = await this.interactor.exists(locator);\n    if (cellExists) {\n      // @ts-ignore\n      return new driverClass(locator, this.interactor, this.commutableOption);\n    }\n\n    return null;\n  }\n\n  protected abstract getCellLocator(): PartLocator;\n}\n","import { byRole, IComponentDriverOption, Interactor, locatorUtil, PartLocator } from '@atomic-testing/core';\n\nimport { DataGridRowDriverBase } from './DataGridRowDriverBase';\n\nexport class DataGridDataRowDriver extends DataGridRowDriverBase {\n  private readonly _dataCellLocator: PartLocator;\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts: {},\n    });\n\n    this._dataCellLocator = locatorUtil.append(locator, byRole('cell'));\n  }\n\n  protected override getCellLocator(): PartLocator {\n    return this._dataCellLocator;\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridDataRowDriver';\n  }\n}\n","import { byRole, IComponentDriverOption, Interactor, locatorUtil, PartLocator } from '@atomic-testing/core';\n\nimport { DataGridRowDriverBase } from './DataGridRowDriverBase';\n\nexport class DataGridHeaderRowDriver extends DataGridRowDriverBase {\n  private readonly _headerCellLocator: PartLocator;\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts: {},\n    });\n\n    this._headerCellLocator = locatorUtil.append(locator, byRole('columnheader'));\n  }\n\n  async getColumnCount(): Promise<number> {\n    return this.getCellCount();\n  }\n\n  protected override getCellLocator(): PartLocator {\n    return this._headerCellLocator;\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridHeaderRowDriver';\n  }\n}\n","import { HTMLButtonDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byAttribute,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nconst parts = {\n  previousButton: {\n    locator: byAttribute('aria-label', 'Go to previous page'),\n    driver: HTMLButtonDriver,\n  },\n  nextButton: {\n    locator: byAttribute('aria-label', 'Go to next page'),\n    driver: HTMLButtonDriver,\n  },\n} satisfies ScenePart;\n\n/**\n * Driver for Material UI v6 DataGridPro component.\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridPaginationActionDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('previousButton');\n    const isDisabled = await this.parts.previousButton.isDisabled();\n    return !isDisabled;\n  }\n\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('previousButton');\n    await this.parts.previousButton.click();\n  }\n\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('nextButton');\n    const isDisabled = await this.parts.nextButton.isDisabled();\n    return !isDisabled;\n  }\n\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('nextButton');\n    await this.parts.nextButton.click();\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridPaginationActionDriver';\n  }\n}\n","import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byCssClass,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  Optional,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nimport { DataGridPaginationActionDriver } from './DataGridPaginationActionDriver';\n\nconst parts = {\n  paginationAction: {\n    locator: byCssClass('MuiTablePagination-actions'),\n    driver: DataGridPaginationActionDriver,\n  },\n  paginationDescription: {\n    locator: byCssClass('MuiTablePagination-displayedRows'),\n    driver: HTMLElementDriver,\n  },\n} satisfies ScenePart;\n\n/**\n * Driver for Material UI v6 DataGridPro component.\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridFooterDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('paginationAction');\n    return this.parts.paginationAction.isPreviousPageEnabled();\n  }\n\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('paginationAction');\n    await this.parts.paginationAction.gotoPreviousPage();\n  }\n\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('paginationAction');\n    return this.parts.paginationAction.isNextPageEnabled();\n  }\n\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('paginationAction');\n    await this.parts.paginationAction.gotoNextPage();\n  }\n\n  async getPaginationDescription(): Promise<Optional<string>> {\n    await this.enforcePartExistence('paginationDescription');\n    return this.parts.paginationDescription.getText();\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridFooterDriver';\n  }\n}\n","import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byCssClass,\n  byCssSelector,\n  byRole,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  listHelper,\n  locatorUtil,\n  Optional,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nimport { DataGridCellQuery } from './DataGridCellQuery';\nimport { DataGridFooterDriver } from './DataGridFooterDriver';\nimport { DataGridHeaderRowDriver } from './DataGridHeaderRowDriver';\n\nconst parts = {\n  headerRow: {\n    locator: byCssClass('MuiDataGrid-columnHeaders').chain(byCssSelector('[role=row]:first-of-type')),\n    driver: DataGridHeaderRowDriver,\n  },\n  loading: {\n    locator: byRole('progressbar'),\n    driver: HTMLElementDriver,\n  },\n  skeletonOverlay: {\n    locator: byCssClass('MuiDataGrid-main--hasSkeletonLoadingOverlay'),\n    driver: HTMLElementDriver,\n  },\n  footer: {\n    locator: byCssClass('MuiDataGrid-footerContainer'),\n    driver: DataGridFooterDriver,\n  },\n} satisfies ScenePart;\n\nconst dataRowLocator = byCssSelector('[role=row][data-rowindex]');\n\n/**\n * Driver for Material UI v8  DataGridPro component.\n * V8 DataGridPro component does not support data-testid, to use data-testid\n * to locate the component, you need to put the data-testid on the parent element of the grid\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridProDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  /**\n   * Checks if the data grid is currently loading.\n   * @returns A promise that resolves to a boolean indicating if the data grid is loading.\n   */\n  async isLoading(): Promise<boolean> {\n    const result = await Promise.all([this.parts.skeletonOverlay.isVisible(), this.parts.loading.isVisible()]);\n    return result.some(v => v);\n  }\n\n  /**\n   * Waits for the data grid to exit the loading state.\n   * @param timeoutMs The maximum time to wait for the load to complete, in milliseconds.\n   */\n  async waitForLoad(timeoutMs: number = 10000): Promise<void> {\n    await this.parts.headerRow.waitUntilComponentState();\n    await this.waitUntil({ probeFn: () => this.isLoading(), terminateCondition: false, timeoutMs });\n  }\n\n  /**\n   * The number of columns currently displayed in the data grid, note that data grid pro\n   * uses virtualize rendering, therefore the column count heavily depends on the viewport size\n   * @returns The number of columns currently displayed in the data grid\n   */\n  async getColumnCount(): Promise<number> {\n    return this.parts.headerRow.getColumnCount();\n  }\n\n  /**\n   * The array text of the header row, note that columns not shown in the viewport may not be included because of virtualize rendering\n   * @returns The array of text of the header row\n   */\n  async getHeaderText(): Promise<string[]> {\n    return this.parts.headerRow.getRowText();\n  }\n\n  /**\n   * The number of rows currently displayed in the data grid, note that data grid pro\n   * uses virtualize rendering, therefore the row count heavily depends on the viewport size\n   * @returns The number of columns currently displayed in the data grid\n   */\n  async getRowCount(): Promise<number> {\n    const gridRowLocator = locatorUtil.append(this.locator, dataRowLocator);\n    let count = 0;\n    for await (const _ of listHelper.getListItemIterator(this, gridRowLocator, HTMLElementDriver)) {\n      count++;\n    }\n    return count;\n  }\n\n  /**\n   * Return the row driver for the row at the specified index, if the row does not exist, return null\n   * @param rowIndex\n   * @returns\n   */\n  async getRow(rowIndex: number): Promise<DataGridHeaderRowDriver | null> {\n    const rowLocator = locatorUtil.append(this.locator, byCssSelector(`[role=row][data-rowindex=\"${rowIndex}\"]`));\n    const rowExists = await this.interactor.exists(rowLocator);\n    if (rowExists) {\n      return new DataGridHeaderRowDriver(rowLocator, this.interactor, this.commutableOption);\n    }\n\n    return null;\n  }\n\n  /**\n   * The array text of the specified row, note that columns not shown in the viewport may not be included because of virtualize rendering\n   * @param rowIndex The index of the row\n   * @returns The array of text of the specified row\n   */\n  async getRowText(rowIndex: number): Promise<string[]> {\n    const row = await this.getRow(rowIndex);\n    if (row != null) {\n      return row.getRowText();\n    }\n    throw new Error(`Row ${rowIndex} does not exist`);\n  }\n\n  /**\n   * Get the cell driver for the cell, if the cell does not exist, return null\n   * The cell driver is default to HTMLElementDriver, you can specify a different driver class\n   * @param query The query to locate the cell\n   * @param driverClass Optional, the driver class to use for the cell, default to HTMLElementDriver\n   * @returns\n   */\n  async getCell<DriverT extends ComponentDriver>(\n    query: DataGridCellQuery,\n    // @ts-ignore\n    driverClass: typeof ComponentDriver = HTMLElementDriver\n  ): Promise<DriverT | null> {\n    const rowDriver = await this.getRow(query.rowIndex);\n\n    if (rowDriver === null) {\n      return null;\n    }\n\n    if ('columnIndex' in query) {\n      return rowDriver.getCell(query.columnIndex, driverClass);\n    }\n\n    return rowDriver.getCell(query.columnField, driverClass);\n  }\n\n  /**\n   * Get the text content of the cell, if the cell does not exist, throw an error\n   * @param query The query to locate the cell\n   * @returns\n   */\n  async getCellText(query: DataGridCellQuery): Promise<string> {\n    const cell = await this.getCell(query);\n    if (cell != null) {\n      const text = await cell.getText();\n      return text!;\n    }\n\n    //@ts-ignore\n    throw new Error(`Cell at row:${query.rowIndex} column:${query.columnIndex ?? query.columnField} does not exist`);\n  }\n\n  //#region Footer\n  isFooterVisible(): Promise<boolean> {\n    return this.parts.footer.isVisible();\n  }\n\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.isPreviousPageEnabled();\n  }\n\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('footer');\n    await this.parts.footer.gotoPreviousPage();\n  }\n\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.isNextPageEnabled();\n  }\n\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('footer');\n    await this.parts.footer.gotoNextPage();\n  }\n\n  async getPaginationDescription(): Promise<Optional<string>> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.getText();\n  }\n  //#endregion Footer\n\n  override get driverName(): string {\n    return 'MuiV8DataGridProDriver';\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,MAAM,sBAAsB;;;;AAK5B,IAAsB,wBAAtB,cAAoDA,sCAAgB;CAClE,MAAgB,eAAgC;EAC9C,IAAI,QAAQ;AACZ,aAAW,MAAM,KAAK,iCAAW,oBAC/B,MACA,KAAK,gBAAgB,EACrBC,0DACA,oBACD,CACC;AAEF,SAAO;CACR;;;;;;CAOD,MAAM,aAAgC;EACpC,MAAMC,WAAqB,CAAE;AAC7B,aAAW,MAAM,QAAQ,iCAAW,oBAClC,MACA,KAAK,gBAAgB,EACrBD,0DACA,oBACD,EAAE;GACD,MAAM,OAAO,MAAM,KAAK,SAAS;AACjC,YAAS,KAAK,KAAM,MAAM,CAAC;EAC5B;AACD,SAAO;CACR;;;;;;;;CASD,MAAM,QACJE,kBAEAC,cAAsCH,0DACb;EACzB,IAAII;AACJ,aAAW,qBAAqB,SAC9B,eAAc,uCAAY,iBAAiB,iBAAiB,UAAU,CAAC;MAEvE,eAAc,uCAAY,cAAc,iBAAiB;EAE3D,MAAM,UAAU,kCAAY,OAAO,KAAK,SAAS,YAAY;EAC7D,MAAM,aAAa,MAAM,KAAK,WAAW,OAAO,QAAQ;AACxD,MAAI,WAEF,QAAO,IAAI,YAAY,SAAS,KAAK,YAAY,KAAK;AAGxD,SAAO;CACR;AAGF;;;;ACnED,IAAa,wBAAb,cAA2C,sBAAsB;CAC/D,AAAiB;CACjB,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH,OAAO,CAAE;EACV,EAAC;AAEF,OAAK,mBAAmB,kCAAY,OAAO,SAAS,kCAAO,OAAO,CAAC;CACpE;CAED,AAAmB,iBAA8B;AAC/C,SAAO,KAAK;CACb;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AClBD,IAAa,0BAAb,cAA6C,sBAAsB;CACjE,AAAiB;CACjB,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH,OAAO,CAAE;EACV,EAAC;AAEF,OAAK,qBAAqB,kCAAY,OAAO,SAAS,kCAAO,eAAe,CAAC;CAC9E;CAED,MAAM,iBAAkC;AACtC,SAAO,KAAK,cAAc;CAC3B;CAED,AAAmB,iBAA8B;AAC/C,SAAO,KAAK;CACb;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AChBD,MAAMC,UAAQ;CACZ,gBAAgB;EACd,SAAS,uCAAY,cAAc,sBAAsB;EACzD,QAAQC;CACT;CACD,YAAY;EACV,SAAS,uCAAY,cAAc,kBAAkB;EACrD,QAAQA;CACT;AACF;;;;;AAMD,IAAa,iCAAb,cAAoDC,sCAA8B;CAChF,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;CAED,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,iBAAiB;EACjD,MAAM,aAAa,MAAM,KAAK,MAAM,eAAe,YAAY;AAC/D,UAAQ;CACT;CAED,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,iBAAiB;AACjD,QAAM,KAAK,MAAM,eAAe,OAAO;CACxC;CAED,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,aAAa;EAC7C,MAAM,aAAa,MAAM,KAAK,MAAM,WAAW,YAAY;AAC3D,UAAQ;CACT;CAED,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,aAAa;AAC7C,QAAM,KAAK,MAAM,WAAW,OAAO;CACpC;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AC7CD,MAAMC,UAAQ;CACZ,kBAAkB;EAChB,SAAS,sCAAW,6BAA6B;EACjD,QAAQ;CACT;CACD,uBAAuB;EACrB,SAAS,sCAAW,mCAAmC;EACvD,QAAQC;CACT;AACF;;;;;AAMD,IAAa,uBAAb,cAA0CC,sCAA8B;CACtE,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;CAED,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,SAAO,KAAK,MAAM,iBAAiB,uBAAuB;CAC3D;CAED,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,QAAM,KAAK,MAAM,iBAAiB,kBAAkB;CACrD;CAED,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,SAAO,KAAK,MAAM,iBAAiB,mBAAmB;CACvD;CAED,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,QAAM,KAAK,MAAM,iBAAiB,cAAc;CACjD;CAED,MAAM,2BAAsD;AAC1D,QAAM,KAAK,qBAAqB,wBAAwB;AACxD,SAAO,KAAK,MAAM,sBAAsB,SAAS;CAClD;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AC7CD,MAAM,QAAQ;CACZ,WAAW;EACT,SAAS,sCAAW,4BAA4B,CAAC,MAAM,yCAAc,2BAA2B,CAAC;EACjG,QAAQ;CACT;CACD,SAAS;EACP,SAAS,kCAAO,cAAc;EAC9B,QAAQC;CACT;CACD,iBAAiB;EACf,SAAS,sCAAW,8CAA8C;EAClE,QAAQA;CACT;CACD,QAAQ;EACN,SAAS,sCAAW,8BAA8B;EAClD,QAAQ;CACT;AACF;AAED,MAAM,iBAAiB,yCAAc,4BAA4B;;;;;;;AAQjE,IAAa,oBAAb,cAAuCC,sCAA8B;CACnE,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;;;;;CAMD,MAAM,YAA8B;EAClC,MAAM,SAAS,MAAM,QAAQ,IAAI,CAAC,KAAK,MAAM,gBAAgB,WAAW,EAAE,KAAK,MAAM,QAAQ,WAAW,AAAC,EAAC;AAC1G,SAAO,OAAO,KAAK,OAAK,EAAE;CAC3B;;;;;CAMD,MAAM,YAAYC,YAAoB,KAAsB;AAC1D,QAAM,KAAK,MAAM,UAAU,yBAAyB;AACpD,QAAM,KAAK,UAAU;GAAE,SAAS,MAAM,KAAK,WAAW;GAAE,oBAAoB;GAAO;EAAW,EAAC;CAChG;;;;;;CAOD,MAAM,iBAAkC;AACtC,SAAO,KAAK,MAAM,UAAU,gBAAgB;CAC7C;;;;;CAMD,MAAM,gBAAmC;AACvC,SAAO,KAAK,MAAM,UAAU,YAAY;CACzC;;;;;;CAOD,MAAM,cAA+B;EACnC,MAAM,iBAAiB,kCAAY,OAAO,KAAK,SAAS,eAAe;EACvE,IAAI,QAAQ;AACZ,aAAW,MAAM,KAAK,iCAAW,oBAAoB,MAAM,gBAAgBL,yDAAkB,CAC3F;AAEF,SAAO;CACR;;;;;;CAOD,MAAM,OAAOM,UAA2D;EACtE,MAAM,aAAa,kCAAY,OAAO,KAAK,SAAS,0CAAe,4BAA4B,SAAS,IAAI,CAAC;EAC7G,MAAM,YAAY,MAAM,KAAK,WAAW,OAAO,WAAW;AAC1D,MAAI,UACF,QAAO,IAAI,wBAAwB,YAAY,KAAK,YAAY,KAAK;AAGvE,SAAO;CACR;;;;;;CAOD,MAAM,WAAWA,UAAqC;EACpD,MAAM,MAAM,MAAM,KAAK,OAAO,SAAS;AACvC,MAAI,OAAO,KACT,QAAO,IAAI,YAAY;AAEzB,QAAM,IAAI,OAAO,MAAM,SAAS;CACjC;;;;;;;;CASD,MAAM,QACJC,OAEAC,cAAsCR,0DACb;EACzB,MAAM,YAAY,MAAM,KAAK,OAAO,MAAM,SAAS;AAEnD,MAAI,cAAc,KAChB,QAAO;AAGT,MAAI,iBAAiB,MACnB,QAAO,UAAU,QAAQ,MAAM,aAAa,YAAY;AAG1D,SAAO,UAAU,QAAQ,MAAM,aAAa,YAAY;CACzD;;;;;;CAOD,MAAM,YAAYO,OAA2C;EAC3D,MAAM,OAAO,MAAM,KAAK,QAAQ,MAAM;AACtC,MAAI,QAAQ,MAAM;GAChB,MAAM,OAAO,MAAM,KAAK,SAAS;AACjC,UAAO;EACR;AAGD,QAAM,IAAI,OAAO,cAAc,MAAM,SAAS,UAAU,MAAM,eAAe,MAAM,YAAY;CAChG;CAGD,kBAAoC;AAClC,SAAO,KAAK,MAAM,OAAO,WAAW;CACrC;CAED,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,uBAAuB;CACjD;CAED,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,SAAS;AACzC,QAAM,KAAK,MAAM,OAAO,kBAAkB;CAC3C;CAED,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,mBAAmB;CAC7C;CAED,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,SAAS;AACzC,QAAM,KAAK,MAAM,OAAO,cAAc;CACvC;CAED,MAAM,2BAAsD;AAC1D,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,SAAS;CACnC;CAGD,IAAa,aAAqB;AAChC,SAAO;CACR;AACF"}
+{"version":3,"file":"index.js","names":["ComponentDriver","HTMLElementDriver","textList: string[]","cellIndexOrField: number | string","driverClass: typeof ComponentDriver","cellLocator: PartLocator","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","parts","HTMLButtonDriver","ComponentDriver","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","parts","HTMLElementDriver","ComponentDriver","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","HTMLElementDriver","ComponentDriver","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","timeoutMs: number","rowIndex: number","query: DataGridCellQuery","driverClass: typeof ComponentDriver"],"sources":["../src/components/datagrid/DataGridRowDriverBase.ts","../src/components/datagrid/DataGridDataRowDriver.ts","../src/components/datagrid/DataGridHeaderRowDriver.ts","../src/components/datagrid/DataGridPaginationActionDriver.ts","../src/components/datagrid/DataGridFooterDriver.ts","../src/components/datagrid/DataGridProDriver.ts"],"sourcesContent":["import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport { byAttribute, ComponentDriver, listHelper, locatorUtil, PartLocator } from '@atomic-testing/core';\n\n// In MUI7, there is an extra div preceding the actual data cells. We need to skip it.\nconst columnStartingIndex = 1;\n\n/**\n * Base class for data grid row\n */\nexport abstract class DataGridRowDriverBase extends ComponentDriver {\n  protected async getCellCount(): Promise<number> {\n    let count = 0;\n    for await (const _ of listHelper.getListItemIterator(\n      this,\n      this.getCellLocator(),\n      HTMLElementDriver,\n      columnStartingIndex\n    )) {\n      count++;\n    }\n    return count;\n  }\n\n  /**\n   * Get the text of each visible cell in the row.\n   * Caveat: Because of virtualization, the text of the cell may not be available until the cell is visible.\n   * @returns A promise array of text of each visible cell in the row\n   */\n  async getRowText(): Promise<string[]> {\n    const textList: string[] = [];\n    for await (const cell of listHelper.getListItemIterator(\n      this,\n      this.getCellLocator(),\n      HTMLElementDriver,\n      columnStartingIndex\n    )) {\n      const text = await cell.getText();\n      textList.push(text!.trim());\n    }\n    return textList;\n  }\n\n  /**\n   * Get the cell driver at the specified index or data field.\n   * Caveat: Because of virtualization, the cell may not be available until the cell is visible.\n   * @param cellIndexOrField number: column index, string: column field\n   * @param driverClass The driver class of the cell. Default is HTMLElementDriver\n   * @returns A promise of the cell driver, or null if the cell is not found\n   */\n  async getCell<DriverT extends ComponentDriver>(\n    cellIndexOrField: number | string, // number: column index, string: column field\n    // @ts-ignore\n    driverClass: typeof ComponentDriver = HTMLElementDriver\n  ): Promise<DriverT | null> {\n    let cellLocator: PartLocator;\n    if (typeof cellIndexOrField === 'number') {\n      cellLocator = byAttribute('data-colindex', cellIndexOrField.toString());\n    } else {\n      cellLocator = byAttribute('data-field', cellIndexOrField);\n    }\n    const locator = locatorUtil.append(this.locator, cellLocator);\n    const cellExists = await this.interactor.exists(locator);\n    if (cellExists) {\n      // @ts-ignore\n      return new driverClass(locator, this.interactor, this.commutableOption);\n    }\n\n    return null;\n  }\n\n  protected abstract getCellLocator(): PartLocator;\n}\n","import { byRole, IComponentDriverOption, Interactor, locatorUtil, PartLocator } from '@atomic-testing/core';\n\nimport { DataGridRowDriverBase } from './DataGridRowDriverBase';\n\nexport class DataGridDataRowDriver extends DataGridRowDriverBase {\n  private readonly _dataCellLocator: PartLocator;\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts: {},\n    });\n\n    this._dataCellLocator = locatorUtil.append(locator, byRole('cell'));\n  }\n\n  protected override getCellLocator(): PartLocator {\n    return this._dataCellLocator;\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridDataRowDriver';\n  }\n}\n","import { byRole, IComponentDriverOption, Interactor, locatorUtil, PartLocator } from '@atomic-testing/core';\n\nimport { DataGridRowDriverBase } from './DataGridRowDriverBase';\n\nexport class DataGridHeaderRowDriver extends DataGridRowDriverBase {\n  private readonly _headerCellLocator: PartLocator;\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts: {},\n    });\n\n    this._headerCellLocator = locatorUtil.append(locator, byRole('columnheader'));\n  }\n\n  async getColumnCount(): Promise<number> {\n    return this.getCellCount();\n  }\n\n  protected override getCellLocator(): PartLocator {\n    return this._headerCellLocator;\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridHeaderRowDriver';\n  }\n}\n","import { HTMLButtonDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byAttribute,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nconst parts = {\n  previousButton: {\n    locator: byAttribute('aria-label', 'Go to previous page'),\n    driver: HTMLButtonDriver,\n  },\n  nextButton: {\n    locator: byAttribute('aria-label', 'Go to next page'),\n    driver: HTMLButtonDriver,\n  },\n} satisfies ScenePart;\n\n/**\n * Driver for Material UI v6 DataGridPro component.\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridPaginationActionDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('previousButton');\n    const isDisabled = await this.parts.previousButton.isDisabled();\n    return !isDisabled;\n  }\n\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('previousButton');\n    await this.parts.previousButton.click();\n  }\n\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('nextButton');\n    const isDisabled = await this.parts.nextButton.isDisabled();\n    return !isDisabled;\n  }\n\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('nextButton');\n    await this.parts.nextButton.click();\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridPaginationActionDriver';\n  }\n}\n","import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byCssClass,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  Optional,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nimport { DataGridPaginationActionDriver } from './DataGridPaginationActionDriver';\n\nconst parts = {\n  paginationAction: {\n    locator: byCssClass('MuiTablePagination-actions'),\n    driver: DataGridPaginationActionDriver,\n  },\n  paginationDescription: {\n    locator: byCssClass('MuiTablePagination-displayedRows'),\n    driver: HTMLElementDriver,\n  },\n} satisfies ScenePart;\n\n/**\n * Driver for Material UI v6 DataGridPro component.\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridFooterDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('paginationAction');\n    return this.parts.paginationAction.isPreviousPageEnabled();\n  }\n\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('paginationAction');\n    await this.parts.paginationAction.gotoPreviousPage();\n  }\n\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('paginationAction');\n    return this.parts.paginationAction.isNextPageEnabled();\n  }\n\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('paginationAction');\n    await this.parts.paginationAction.gotoNextPage();\n  }\n\n  async getPaginationDescription(): Promise<Optional<string>> {\n    await this.enforcePartExistence('paginationDescription');\n    return this.parts.paginationDescription.getText();\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridFooterDriver';\n  }\n}\n","import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byCssClass,\n  byCssSelector,\n  byRole,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  listHelper,\n  locatorUtil,\n  Optional,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nimport { DataGridCellQuery } from './DataGridCellQuery';\nimport { DataGridFooterDriver } from './DataGridFooterDriver';\nimport { DataGridHeaderRowDriver } from './DataGridHeaderRowDriver';\n\nconst parts = {\n  headerRow: {\n    locator: byCssClass('MuiDataGrid-columnHeaders').chain(byCssSelector('[role=row]:first-of-type')),\n    driver: DataGridHeaderRowDriver,\n  },\n  loading: {\n    locator: byRole('progressbar'),\n    driver: HTMLElementDriver,\n  },\n  skeletonOverlay: {\n    locator: byCssClass('MuiDataGrid-main--hasSkeletonLoadingOverlay'),\n    driver: HTMLElementDriver,\n  },\n  footer: {\n    locator: byCssClass('MuiDataGrid-footerContainer'),\n    driver: DataGridFooterDriver,\n  },\n} satisfies ScenePart;\n\nconst dataRowLocator = byCssSelector('[role=row][data-rowindex]');\n\n/**\n * Driver for Material UI v8  DataGridPro component.\n * V8 DataGridPro component does not support data-testid, to use data-testid\n * to locate the component, you need to put the data-testid on the parent element of the grid\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridProDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  /**\n   * Checks if the data grid is currently loading.\n   * @returns A promise that resolves to a boolean indicating if the data grid is loading.\n   */\n  async isLoading(): Promise<boolean> {\n    const result = await Promise.all([this.parts.skeletonOverlay.isVisible(), this.parts.loading.isVisible()]);\n    return result.some(v => v);\n  }\n\n  /**\n   * Waits for the data grid to exit the loading state.\n   * @param timeoutMs The maximum time to wait for the load to complete, in milliseconds.\n   */\n  async waitForLoad(timeoutMs: number = 10000): Promise<void> {\n    await this.parts.headerRow.waitUntilComponentState();\n    await this.waitUntil({ probeFn: () => this.isLoading(), terminateCondition: false, timeoutMs });\n  }\n\n  /**\n   * The number of columns currently displayed in the data grid, note that data grid pro\n   * uses virtualize rendering, therefore the column count heavily depends on the viewport size\n   * @returns The number of columns currently displayed in the data grid\n   */\n  async getColumnCount(): Promise<number> {\n    return this.parts.headerRow.getColumnCount();\n  }\n\n  /**\n   * The array text of the header row, note that columns not shown in the viewport may not be included because of virtualize rendering\n   * @returns The array of text of the header row\n   */\n  async getHeaderText(): Promise<string[]> {\n    return this.parts.headerRow.getRowText();\n  }\n\n  /**\n   * The number of rows currently displayed in the data grid, note that data grid pro\n   * uses virtualize rendering, therefore the row count heavily depends on the viewport size\n   * @returns The number of columns currently displayed in the data grid\n   */\n  async getRowCount(): Promise<number> {\n    const gridRowLocator = locatorUtil.append(this.locator, dataRowLocator);\n    let count = 0;\n    for await (const _ of listHelper.getListItemIterator(this, gridRowLocator, HTMLElementDriver)) {\n      count++;\n    }\n    return count;\n  }\n\n  /**\n   * Return the row driver for the row at the specified index, if the row does not exist, return null\n   * @param rowIndex\n   * @returns\n   */\n  async getRow(rowIndex: number): Promise<DataGridHeaderRowDriver | null> {\n    const rowLocator = locatorUtil.append(this.locator, byCssSelector(`[role=row][data-rowindex=\"${rowIndex}\"]`));\n    const rowExists = await this.interactor.exists(rowLocator);\n    if (rowExists) {\n      return new DataGridHeaderRowDriver(rowLocator, this.interactor, this.commutableOption);\n    }\n\n    return null;\n  }\n\n  /**\n   * The array text of the specified row, note that columns not shown in the viewport may not be included because of virtualize rendering\n   * @param rowIndex The index of the row\n   * @returns The array of text of the specified row\n   */\n  async getRowText(rowIndex: number): Promise<string[]> {\n    const row = await this.getRow(rowIndex);\n    if (row != null) {\n      return row.getRowText();\n    }\n    throw new Error(`Row ${rowIndex} does not exist`);\n  }\n\n  /**\n   * Get the cell driver for the cell, if the cell does not exist, return null\n   * The cell driver is default to HTMLElementDriver, you can specify a different driver class\n   * @param query The query to locate the cell\n   * @param driverClass Optional, the driver class to use for the cell, default to HTMLElementDriver\n   * @returns\n   */\n  async getCell<DriverT extends ComponentDriver>(\n    query: DataGridCellQuery,\n    // @ts-ignore\n    driverClass: typeof ComponentDriver = HTMLElementDriver\n  ): Promise<DriverT | null> {\n    const rowDriver = await this.getRow(query.rowIndex);\n\n    if (rowDriver === null) {\n      return null;\n    }\n\n    if ('columnIndex' in query) {\n      return rowDriver.getCell(query.columnIndex, driverClass);\n    }\n\n    return rowDriver.getCell(query.columnField, driverClass);\n  }\n\n  /**\n   * Get the text content of the cell, if the cell does not exist, throw an error\n   * @param query The query to locate the cell\n   * @returns\n   */\n  async getCellText(query: DataGridCellQuery): Promise<string> {\n    const cell = await this.getCell(query);\n    if (cell != null) {\n      const text = await cell.getText();\n      return text!;\n    }\n\n    //@ts-ignore\n    throw new Error(`Cell at row:${query.rowIndex} column:${query.columnIndex ?? query.columnField} does not exist`);\n  }\n\n  //#region Footer\n  /**\n   * Determine if the pagination footer is currently visible.\n   */\n  isFooterVisible(): Promise<boolean> {\n    return this.parts.footer.isVisible();\n  }\n\n  /**\n   * Check whether the \"previous page\" control is enabled.\n   */\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.isPreviousPageEnabled();\n  }\n\n  /**\n   * Navigate to the previous page using the grid footer control.\n   */\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('footer');\n    await this.parts.footer.gotoPreviousPage();\n  }\n\n  /**\n   * Check whether the \"next page\" control is enabled.\n   */\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.isNextPageEnabled();\n  }\n\n  /**\n   * Navigate to the next page using the grid footer control.\n   */\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('footer');\n    await this.parts.footer.gotoNextPage();\n  }\n\n  /**\n   * Read the textual description of the current pagination state.\n   */\n  async getPaginationDescription(): Promise<Optional<string>> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.getText();\n  }\n  //#endregion Footer\n\n  override get driverName(): string {\n    return 'MuiV8DataGridProDriver';\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,MAAM,sBAAsB;;;;AAK5B,IAAsB,wBAAtB,cAAoDA,sCAAgB;CAClE,MAAgB,eAAgC;EAC9C,IAAI,QAAQ;AACZ,aAAW,MAAM,KAAK,iCAAW,oBAC/B,MACA,KAAK,gBAAgB,EACrBC,0DACA,oBACD,CACC;AAEF,SAAO;CACR;;;;;;CAOD,MAAM,aAAgC;EACpC,MAAMC,WAAqB,CAAE;AAC7B,aAAW,MAAM,QAAQ,iCAAW,oBAClC,MACA,KAAK,gBAAgB,EACrBD,0DACA,oBACD,EAAE;GACD,MAAM,OAAO,MAAM,KAAK,SAAS;AACjC,YAAS,KAAK,KAAM,MAAM,CAAC;EAC5B;AACD,SAAO;CACR;;;;;;;;CASD,MAAM,QACJE,kBAEAC,cAAsCH,0DACb;EACzB,IAAII;AACJ,aAAW,qBAAqB,SAC9B,eAAc,uCAAY,iBAAiB,iBAAiB,UAAU,CAAC;MAEvE,eAAc,uCAAY,cAAc,iBAAiB;EAE3D,MAAM,UAAU,kCAAY,OAAO,KAAK,SAAS,YAAY;EAC7D,MAAM,aAAa,MAAM,KAAK,WAAW,OAAO,QAAQ;AACxD,MAAI,WAEF,QAAO,IAAI,YAAY,SAAS,KAAK,YAAY,KAAK;AAGxD,SAAO;CACR;AAGF;;;;ACnED,IAAa,wBAAb,cAA2C,sBAAsB;CAC/D,AAAiB;CACjB,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH,OAAO,CAAE;EACV,EAAC;AAEF,OAAK,mBAAmB,kCAAY,OAAO,SAAS,kCAAO,OAAO,CAAC;CACpE;CAED,AAAmB,iBAA8B;AAC/C,SAAO,KAAK;CACb;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AClBD,IAAa,0BAAb,cAA6C,sBAAsB;CACjE,AAAiB;CACjB,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH,OAAO,CAAE;EACV,EAAC;AAEF,OAAK,qBAAqB,kCAAY,OAAO,SAAS,kCAAO,eAAe,CAAC;CAC9E;CAED,MAAM,iBAAkC;AACtC,SAAO,KAAK,cAAc;CAC3B;CAED,AAAmB,iBAA8B;AAC/C,SAAO,KAAK;CACb;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AChBD,MAAMC,UAAQ;CACZ,gBAAgB;EACd,SAAS,uCAAY,cAAc,sBAAsB;EACzD,QAAQC;CACT;CACD,YAAY;EACV,SAAS,uCAAY,cAAc,kBAAkB;EACrD,QAAQA;CACT;AACF;;;;;AAMD,IAAa,iCAAb,cAAoDC,sCAA8B;CAChF,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;CAED,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,iBAAiB;EACjD,MAAM,aAAa,MAAM,KAAK,MAAM,eAAe,YAAY;AAC/D,UAAQ;CACT;CAED,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,iBAAiB;AACjD,QAAM,KAAK,MAAM,eAAe,OAAO;CACxC;CAED,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,aAAa;EAC7C,MAAM,aAAa,MAAM,KAAK,MAAM,WAAW,YAAY;AAC3D,UAAQ;CACT;CAED,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,aAAa;AAC7C,QAAM,KAAK,MAAM,WAAW,OAAO;CACpC;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AC7CD,MAAMC,UAAQ;CACZ,kBAAkB;EAChB,SAAS,sCAAW,6BAA6B;EACjD,QAAQ;CACT;CACD,uBAAuB;EACrB,SAAS,sCAAW,mCAAmC;EACvD,QAAQC;CACT;AACF;;;;;AAMD,IAAa,uBAAb,cAA0CC,sCAA8B;CACtE,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;CAED,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,SAAO,KAAK,MAAM,iBAAiB,uBAAuB;CAC3D;CAED,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,QAAM,KAAK,MAAM,iBAAiB,kBAAkB;CACrD;CAED,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,SAAO,KAAK,MAAM,iBAAiB,mBAAmB;CACvD;CAED,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,QAAM,KAAK,MAAM,iBAAiB,cAAc;CACjD;CAED,MAAM,2BAAsD;AAC1D,QAAM,KAAK,qBAAqB,wBAAwB;AACxD,SAAO,KAAK,MAAM,sBAAsB,SAAS;CAClD;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AC7CD,MAAM,QAAQ;CACZ,WAAW;EACT,SAAS,sCAAW,4BAA4B,CAAC,MAAM,yCAAc,2BAA2B,CAAC;EACjG,QAAQ;CACT;CACD,SAAS;EACP,SAAS,kCAAO,cAAc;EAC9B,QAAQC;CACT;CACD,iBAAiB;EACf,SAAS,sCAAW,8CAA8C;EAClE,QAAQA;CACT;CACD,QAAQ;EACN,SAAS,sCAAW,8BAA8B;EAClD,QAAQ;CACT;AACF;AAED,MAAM,iBAAiB,yCAAc,4BAA4B;;;;;;;AAQjE,IAAa,oBAAb,cAAuCC,sCAA8B;CACnE,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;;;;;CAMD,MAAM,YAA8B;EAClC,MAAM,SAAS,MAAM,QAAQ,IAAI,CAAC,KAAK,MAAM,gBAAgB,WAAW,EAAE,KAAK,MAAM,QAAQ,WAAW,AAAC,EAAC;AAC1G,SAAO,OAAO,KAAK,OAAK,EAAE;CAC3B;;;;;CAMD,MAAM,YAAYC,YAAoB,KAAsB;AAC1D,QAAM,KAAK,MAAM,UAAU,yBAAyB;AACpD,QAAM,KAAK,UAAU;GAAE,SAAS,MAAM,KAAK,WAAW;GAAE,oBAAoB;GAAO;EAAW,EAAC;CAChG;;;;;;CAOD,MAAM,iBAAkC;AACtC,SAAO,KAAK,MAAM,UAAU,gBAAgB;CAC7C;;;;;CAMD,MAAM,gBAAmC;AACvC,SAAO,KAAK,MAAM,UAAU,YAAY;CACzC;;;;;;CAOD,MAAM,cAA+B;EACnC,MAAM,iBAAiB,kCAAY,OAAO,KAAK,SAAS,eAAe;EACvE,IAAI,QAAQ;AACZ,aAAW,MAAM,KAAK,iCAAW,oBAAoB,MAAM,gBAAgBL,yDAAkB,CAC3F;AAEF,SAAO;CACR;;;;;;CAOD,MAAM,OAAOM,UAA2D;EACtE,MAAM,aAAa,kCAAY,OAAO,KAAK,SAAS,0CAAe,4BAA4B,SAAS,IAAI,CAAC;EAC7G,MAAM,YAAY,MAAM,KAAK,WAAW,OAAO,WAAW;AAC1D,MAAI,UACF,QAAO,IAAI,wBAAwB,YAAY,KAAK,YAAY,KAAK;AAGvE,SAAO;CACR;;;;;;CAOD,MAAM,WAAWA,UAAqC;EACpD,MAAM,MAAM,MAAM,KAAK,OAAO,SAAS;AACvC,MAAI,OAAO,KACT,QAAO,IAAI,YAAY;AAEzB,QAAM,IAAI,OAAO,MAAM,SAAS;CACjC;;;;;;;;CASD,MAAM,QACJC,OAEAC,cAAsCR,0DACb;EACzB,MAAM,YAAY,MAAM,KAAK,OAAO,MAAM,SAAS;AAEnD,MAAI,cAAc,KAChB,QAAO;AAGT,MAAI,iBAAiB,MACnB,QAAO,UAAU,QAAQ,MAAM,aAAa,YAAY;AAG1D,SAAO,UAAU,QAAQ,MAAM,aAAa,YAAY;CACzD;;;;;;CAOD,MAAM,YAAYO,OAA2C;EAC3D,MAAM,OAAO,MAAM,KAAK,QAAQ,MAAM;AACtC,MAAI,QAAQ,MAAM;GAChB,MAAM,OAAO,MAAM,KAAK,SAAS;AACjC,UAAO;EACR;AAGD,QAAM,IAAI,OAAO,cAAc,MAAM,SAAS,UAAU,MAAM,eAAe,MAAM,YAAY;CAChG;;;;CAMD,kBAAoC;AAClC,SAAO,KAAK,MAAM,OAAO,WAAW;CACrC;;;;CAKD,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,uBAAuB;CACjD;;;;CAKD,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,SAAS;AACzC,QAAM,KAAK,MAAM,OAAO,kBAAkB;CAC3C;;;;CAKD,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,mBAAmB;CAC7C;;;;CAKD,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,SAAS;AACzC,QAAM,KAAK,MAAM,OAAO,cAAc;CACvC;;;;CAKD,MAAM,2BAAsD;AAC1D,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,SAAS;CACnC;CAGD,IAAa,aAAqB;AAChC,SAAO;CACR;AACF"}

package/dist/index.mjs

@@ -305,25 +305,43 @@ var DataGridProDriver = class extends ComponentDriver {
 		}
 		throw new Error(`Cell at row:${query.rowIndex} column:${query.columnIndex ?? query.columnField} does not exist`);
 	}
+	/**
+	* Determine if the pagination footer is currently visible.
+	*/
 	isFooterVisible() {
 		return this.parts.footer.isVisible();
 	}
+	/**
+	* Check whether the "previous page" control is enabled.
+	*/
 	async isPreviousPageEnabled() {
 		await this.enforcePartExistence("footer");
 		return this.parts.footer.isPreviousPageEnabled();
 	}
+	/**
+	* Navigate to the previous page using the grid footer control.
+	*/
 	async gotoPreviousPage() {
 		await this.enforcePartExistence("footer");
 		await this.parts.footer.gotoPreviousPage();
 	}
+	/**
+	* Check whether the "next page" control is enabled.
+	*/
 	async isNextPageEnabled() {
 		await this.enforcePartExistence("footer");
 		return this.parts.footer.isNextPageEnabled();
 	}
+	/**
+	* Navigate to the next page using the grid footer control.
+	*/
 	async gotoNextPage() {
 		await this.enforcePartExistence("footer");
 		await this.parts.footer.gotoNextPage();
 	}
+	/**
+	* Read the textual description of the current pagination state.
+	*/
 	async getPaginationDescription() {
 		await this.enforcePartExistence("footer");
 		return this.parts.footer.getText();

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":["textList: string[]","cellIndexOrField: number | string","driverClass: typeof ComponentDriver","cellLocator: PartLocator","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","parts","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","parts","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","timeoutMs: number","rowIndex: number","query: DataGridCellQuery","driverClass: typeof ComponentDriver"],"sources":["../src/components/datagrid/DataGridRowDriverBase.ts","../src/components/datagrid/DataGridDataRowDriver.ts","../src/components/datagrid/DataGridHeaderRowDriver.ts","../src/components/datagrid/DataGridPaginationActionDriver.ts","../src/components/datagrid/DataGridFooterDriver.ts","../src/components/datagrid/DataGridProDriver.ts"],"sourcesContent":["import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport { byAttribute, ComponentDriver, listHelper, locatorUtil, PartLocator } from '@atomic-testing/core';\n\n// In MUI7, there is an extra div preceding the actual data cells. We need to skip it.\nconst columnStartingIndex = 1;\n\n/**\n * Base class for data grid row\n */\nexport abstract class DataGridRowDriverBase extends ComponentDriver {\n  protected async getCellCount(): Promise<number> {\n    let count = 0;\n    for await (const _ of listHelper.getListItemIterator(\n      this,\n      this.getCellLocator(),\n      HTMLElementDriver,\n      columnStartingIndex\n    )) {\n      count++;\n    }\n    return count;\n  }\n\n  /**\n   * Get the text of each visible cell in the row.\n   * Caveat: Because of virtualization, the text of the cell may not be available until the cell is visible.\n   * @returns A promise array of text of each visible cell in the row\n   */\n  async getRowText(): Promise<string[]> {\n    const textList: string[] = [];\n    for await (const cell of listHelper.getListItemIterator(\n      this,\n      this.getCellLocator(),\n      HTMLElementDriver,\n      columnStartingIndex\n    )) {\n      const text = await cell.getText();\n      textList.push(text!.trim());\n    }\n    return textList;\n  }\n\n  /**\n   * Get the cell driver at the specified index or data field.\n   * Caveat: Because of virtualization, the cell may not be available until the cell is visible.\n   * @param cellIndexOrField number: column index, string: column field\n   * @param driverClass The driver class of the cell. Default is HTMLElementDriver\n   * @returns A promise of the cell driver, or null if the cell is not found\n   */\n  async getCell<DriverT extends ComponentDriver>(\n    cellIndexOrField: number | string, // number: column index, string: column field\n    // @ts-ignore\n    driverClass: typeof ComponentDriver = HTMLElementDriver\n  ): Promise<DriverT | null> {\n    let cellLocator: PartLocator;\n    if (typeof cellIndexOrField === 'number') {\n      cellLocator = byAttribute('data-colindex', cellIndexOrField.toString());\n    } else {\n      cellLocator = byAttribute('data-field', cellIndexOrField);\n    }\n    const locator = locatorUtil.append(this.locator, cellLocator);\n    const cellExists = await this.interactor.exists(locator);\n    if (cellExists) {\n      // @ts-ignore\n      return new driverClass(locator, this.interactor, this.commutableOption);\n    }\n\n    return null;\n  }\n\n  protected abstract getCellLocator(): PartLocator;\n}\n","import { byRole, IComponentDriverOption, Interactor, locatorUtil, PartLocator } from '@atomic-testing/core';\n\nimport { DataGridRowDriverBase } from './DataGridRowDriverBase';\n\nexport class DataGridDataRowDriver extends DataGridRowDriverBase {\n  private readonly _dataCellLocator: PartLocator;\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts: {},\n    });\n\n    this._dataCellLocator = locatorUtil.append(locator, byRole('cell'));\n  }\n\n  protected override getCellLocator(): PartLocator {\n    return this._dataCellLocator;\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridDataRowDriver';\n  }\n}\n","import { byRole, IComponentDriverOption, Interactor, locatorUtil, PartLocator } from '@atomic-testing/core';\n\nimport { DataGridRowDriverBase } from './DataGridRowDriverBase';\n\nexport class DataGridHeaderRowDriver extends DataGridRowDriverBase {\n  private readonly _headerCellLocator: PartLocator;\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts: {},\n    });\n\n    this._headerCellLocator = locatorUtil.append(locator, byRole('columnheader'));\n  }\n\n  async getColumnCount(): Promise<number> {\n    return this.getCellCount();\n  }\n\n  protected override getCellLocator(): PartLocator {\n    return this._headerCellLocator;\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridHeaderRowDriver';\n  }\n}\n","import { HTMLButtonDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byAttribute,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nconst parts = {\n  previousButton: {\n    locator: byAttribute('aria-label', 'Go to previous page'),\n    driver: HTMLButtonDriver,\n  },\n  nextButton: {\n    locator: byAttribute('aria-label', 'Go to next page'),\n    driver: HTMLButtonDriver,\n  },\n} satisfies ScenePart;\n\n/**\n * Driver for Material UI v6 DataGridPro component.\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridPaginationActionDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('previousButton');\n    const isDisabled = await this.parts.previousButton.isDisabled();\n    return !isDisabled;\n  }\n\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('previousButton');\n    await this.parts.previousButton.click();\n  }\n\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('nextButton');\n    const isDisabled = await this.parts.nextButton.isDisabled();\n    return !isDisabled;\n  }\n\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('nextButton');\n    await this.parts.nextButton.click();\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridPaginationActionDriver';\n  }\n}\n","import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byCssClass,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  Optional,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nimport { DataGridPaginationActionDriver } from './DataGridPaginationActionDriver';\n\nconst parts = {\n  paginationAction: {\n    locator: byCssClass('MuiTablePagination-actions'),\n    driver: DataGridPaginationActionDriver,\n  },\n  paginationDescription: {\n    locator: byCssClass('MuiTablePagination-displayedRows'),\n    driver: HTMLElementDriver,\n  },\n} satisfies ScenePart;\n\n/**\n * Driver for Material UI v6 DataGridPro component.\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridFooterDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('paginationAction');\n    return this.parts.paginationAction.isPreviousPageEnabled();\n  }\n\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('paginationAction');\n    await this.parts.paginationAction.gotoPreviousPage();\n  }\n\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('paginationAction');\n    return this.parts.paginationAction.isNextPageEnabled();\n  }\n\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('paginationAction');\n    await this.parts.paginationAction.gotoNextPage();\n  }\n\n  async getPaginationDescription(): Promise<Optional<string>> {\n    await this.enforcePartExistence('paginationDescription');\n    return this.parts.paginationDescription.getText();\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridFooterDriver';\n  }\n}\n","import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byCssClass,\n  byCssSelector,\n  byRole,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  listHelper,\n  locatorUtil,\n  Optional,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nimport { DataGridCellQuery } from './DataGridCellQuery';\nimport { DataGridFooterDriver } from './DataGridFooterDriver';\nimport { DataGridHeaderRowDriver } from './DataGridHeaderRowDriver';\n\nconst parts = {\n  headerRow: {\n    locator: byCssClass('MuiDataGrid-columnHeaders').chain(byCssSelector('[role=row]:first-of-type')),\n    driver: DataGridHeaderRowDriver,\n  },\n  loading: {\n    locator: byRole('progressbar'),\n    driver: HTMLElementDriver,\n  },\n  skeletonOverlay: {\n    locator: byCssClass('MuiDataGrid-main--hasSkeletonLoadingOverlay'),\n    driver: HTMLElementDriver,\n  },\n  footer: {\n    locator: byCssClass('MuiDataGrid-footerContainer'),\n    driver: DataGridFooterDriver,\n  },\n} satisfies ScenePart;\n\nconst dataRowLocator = byCssSelector('[role=row][data-rowindex]');\n\n/**\n * Driver for Material UI v8  DataGridPro component.\n * V8 DataGridPro component does not support data-testid, to use data-testid\n * to locate the component, you need to put the data-testid on the parent element of the grid\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridProDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  /**\n   * Checks if the data grid is currently loading.\n   * @returns A promise that resolves to a boolean indicating if the data grid is loading.\n   */\n  async isLoading(): Promise<boolean> {\n    const result = await Promise.all([this.parts.skeletonOverlay.isVisible(), this.parts.loading.isVisible()]);\n    return result.some(v => v);\n  }\n\n  /**\n   * Waits for the data grid to exit the loading state.\n   * @param timeoutMs The maximum time to wait for the load to complete, in milliseconds.\n   */\n  async waitForLoad(timeoutMs: number = 10000): Promise<void> {\n    await this.parts.headerRow.waitUntilComponentState();\n    await this.waitUntil({ probeFn: () => this.isLoading(), terminateCondition: false, timeoutMs });\n  }\n\n  /**\n   * The number of columns currently displayed in the data grid, note that data grid pro\n   * uses virtualize rendering, therefore the column count heavily depends on the viewport size\n   * @returns The number of columns currently displayed in the data grid\n   */\n  async getColumnCount(): Promise<number> {\n    return this.parts.headerRow.getColumnCount();\n  }\n\n  /**\n   * The array text of the header row, note that columns not shown in the viewport may not be included because of virtualize rendering\n   * @returns The array of text of the header row\n   */\n  async getHeaderText(): Promise<string[]> {\n    return this.parts.headerRow.getRowText();\n  }\n\n  /**\n   * The number of rows currently displayed in the data grid, note that data grid pro\n   * uses virtualize rendering, therefore the row count heavily depends on the viewport size\n   * @returns The number of columns currently displayed in the data grid\n   */\n  async getRowCount(): Promise<number> {\n    const gridRowLocator = locatorUtil.append(this.locator, dataRowLocator);\n    let count = 0;\n    for await (const _ of listHelper.getListItemIterator(this, gridRowLocator, HTMLElementDriver)) {\n      count++;\n    }\n    return count;\n  }\n\n  /**\n   * Return the row driver for the row at the specified index, if the row does not exist, return null\n   * @param rowIndex\n   * @returns\n   */\n  async getRow(rowIndex: number): Promise<DataGridHeaderRowDriver | null> {\n    const rowLocator = locatorUtil.append(this.locator, byCssSelector(`[role=row][data-rowindex=\"${rowIndex}\"]`));\n    const rowExists = await this.interactor.exists(rowLocator);\n    if (rowExists) {\n      return new DataGridHeaderRowDriver(rowLocator, this.interactor, this.commutableOption);\n    }\n\n    return null;\n  }\n\n  /**\n   * The array text of the specified row, note that columns not shown in the viewport may not be included because of virtualize rendering\n   * @param rowIndex The index of the row\n   * @returns The array of text of the specified row\n   */\n  async getRowText(rowIndex: number): Promise<string[]> {\n    const row = await this.getRow(rowIndex);\n    if (row != null) {\n      return row.getRowText();\n    }\n    throw new Error(`Row ${rowIndex} does not exist`);\n  }\n\n  /**\n   * Get the cell driver for the cell, if the cell does not exist, return null\n   * The cell driver is default to HTMLElementDriver, you can specify a different driver class\n   * @param query The query to locate the cell\n   * @param driverClass Optional, the driver class to use for the cell, default to HTMLElementDriver\n   * @returns\n   */\n  async getCell<DriverT extends ComponentDriver>(\n    query: DataGridCellQuery,\n    // @ts-ignore\n    driverClass: typeof ComponentDriver = HTMLElementDriver\n  ): Promise<DriverT | null> {\n    const rowDriver = await this.getRow(query.rowIndex);\n\n    if (rowDriver === null) {\n      return null;\n    }\n\n    if ('columnIndex' in query) {\n      return rowDriver.getCell(query.columnIndex, driverClass);\n    }\n\n    return rowDriver.getCell(query.columnField, driverClass);\n  }\n\n  /**\n   * Get the text content of the cell, if the cell does not exist, throw an error\n   * @param query The query to locate the cell\n   * @returns\n   */\n  async getCellText(query: DataGridCellQuery): Promise<string> {\n    const cell = await this.getCell(query);\n    if (cell != null) {\n      const text = await cell.getText();\n      return text!;\n    }\n\n    //@ts-ignore\n    throw new Error(`Cell at row:${query.rowIndex} column:${query.columnIndex ?? query.columnField} does not exist`);\n  }\n\n  //#region Footer\n  isFooterVisible(): Promise<boolean> {\n    return this.parts.footer.isVisible();\n  }\n\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.isPreviousPageEnabled();\n  }\n\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('footer');\n    await this.parts.footer.gotoPreviousPage();\n  }\n\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.isNextPageEnabled();\n  }\n\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('footer');\n    await this.parts.footer.gotoNextPage();\n  }\n\n  async getPaginationDescription(): Promise<Optional<string>> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.getText();\n  }\n  //#endregion Footer\n\n  override get driverName(): string {\n    return 'MuiV8DataGridProDriver';\n  }\n}\n"],"mappings":";;;;AAIA,MAAM,sBAAsB;;;;AAK5B,IAAsB,wBAAtB,cAAoD,gBAAgB;CAClE,MAAgB,eAAgC;EAC9C,IAAI,QAAQ;AACZ,aAAW,MAAM,KAAK,WAAW,oBAC/B,MACA,KAAK,gBAAgB,EACrB,mBACA,oBACD,CACC;AAEF,SAAO;CACR;;;;;;CAOD,MAAM,aAAgC;EACpC,MAAMA,WAAqB,CAAE;AAC7B,aAAW,MAAM,QAAQ,WAAW,oBAClC,MACA,KAAK,gBAAgB,EACrB,mBACA,oBACD,EAAE;GACD,MAAM,OAAO,MAAM,KAAK,SAAS;AACjC,YAAS,KAAK,KAAM,MAAM,CAAC;EAC5B;AACD,SAAO;CACR;;;;;;;;CASD,MAAM,QACJC,kBAEAC,cAAsC,mBACb;EACzB,IAAIC;AACJ,aAAW,qBAAqB,SAC9B,eAAc,YAAY,iBAAiB,iBAAiB,UAAU,CAAC;MAEvE,eAAc,YAAY,cAAc,iBAAiB;EAE3D,MAAM,UAAU,YAAY,OAAO,KAAK,SAAS,YAAY;EAC7D,MAAM,aAAa,MAAM,KAAK,WAAW,OAAO,QAAQ;AACxD,MAAI,WAEF,QAAO,IAAI,YAAY,SAAS,KAAK,YAAY,KAAK;AAGxD,SAAO;CACR;AAGF;;;;ACnED,IAAa,wBAAb,cAA2C,sBAAsB;CAC/D,AAAiB;CACjB,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH,OAAO,CAAE;EACV,EAAC;AAEF,OAAK,mBAAmB,YAAY,OAAO,SAAS,OAAO,OAAO,CAAC;CACpE;CAED,AAAmB,iBAA8B;AAC/C,SAAO,KAAK;CACb;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AClBD,IAAa,0BAAb,cAA6C,sBAAsB;CACjE,AAAiB;CACjB,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH,OAAO,CAAE;EACV,EAAC;AAEF,OAAK,qBAAqB,YAAY,OAAO,SAAS,OAAO,eAAe,CAAC;CAC9E;CAED,MAAM,iBAAkC;AACtC,SAAO,KAAK,cAAc;CAC3B;CAED,AAAmB,iBAA8B;AAC/C,SAAO,KAAK;CACb;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AChBD,MAAMC,UAAQ;CACZ,gBAAgB;EACd,SAAS,YAAY,cAAc,sBAAsB;EACzD,QAAQ;CACT;CACD,YAAY;EACV,SAAS,YAAY,cAAc,kBAAkB;EACrD,QAAQ;CACT;AACF;;;;;AAMD,IAAa,iCAAb,cAAoD,gBAA8B;CAChF,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;CAED,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,iBAAiB;EACjD,MAAM,aAAa,MAAM,KAAK,MAAM,eAAe,YAAY;AAC/D,UAAQ;CACT;CAED,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,iBAAiB;AACjD,QAAM,KAAK,MAAM,eAAe,OAAO;CACxC;CAED,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,aAAa;EAC7C,MAAM,aAAa,MAAM,KAAK,MAAM,WAAW,YAAY;AAC3D,UAAQ;CACT;CAED,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,aAAa;AAC7C,QAAM,KAAK,MAAM,WAAW,OAAO;CACpC;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AC7CD,MAAMC,UAAQ;CACZ,kBAAkB;EAChB,SAAS,WAAW,6BAA6B;EACjD,QAAQ;CACT;CACD,uBAAuB;EACrB,SAAS,WAAW,mCAAmC;EACvD,QAAQ;CACT;AACF;;;;;AAMD,IAAa,uBAAb,cAA0C,gBAA8B;CACtE,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;CAED,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,SAAO,KAAK,MAAM,iBAAiB,uBAAuB;CAC3D;CAED,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,QAAM,KAAK,MAAM,iBAAiB,kBAAkB;CACrD;CAED,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,SAAO,KAAK,MAAM,iBAAiB,mBAAmB;CACvD;CAED,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,QAAM,KAAK,MAAM,iBAAiB,cAAc;CACjD;CAED,MAAM,2BAAsD;AAC1D,QAAM,KAAK,qBAAqB,wBAAwB;AACxD,SAAO,KAAK,MAAM,sBAAsB,SAAS;CAClD;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AC7CD,MAAM,QAAQ;CACZ,WAAW;EACT,SAAS,WAAW,4BAA4B,CAAC,MAAM,cAAc,2BAA2B,CAAC;EACjG,QAAQ;CACT;CACD,SAAS;EACP,SAAS,OAAO,cAAc;EAC9B,QAAQ;CACT;CACD,iBAAiB;EACf,SAAS,WAAW,8CAA8C;EAClE,QAAQ;CACT;CACD,QAAQ;EACN,SAAS,WAAW,8BAA8B;EAClD,QAAQ;CACT;AACF;AAED,MAAM,iBAAiB,cAAc,4BAA4B;;;;;;;AAQjE,IAAa,oBAAb,cAAuC,gBAA8B;CACnE,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;;;;;CAMD,MAAM,YAA8B;EAClC,MAAM,SAAS,MAAM,QAAQ,IAAI,CAAC,KAAK,MAAM,gBAAgB,WAAW,EAAE,KAAK,MAAM,QAAQ,WAAW,AAAC,EAAC;AAC1G,SAAO,OAAO,KAAK,OAAK,EAAE;CAC3B;;;;;CAMD,MAAM,YAAYC,YAAoB,KAAsB;AAC1D,QAAM,KAAK,MAAM,UAAU,yBAAyB;AACpD,QAAM,KAAK,UAAU;GAAE,SAAS,MAAM,KAAK,WAAW;GAAE,oBAAoB;GAAO;EAAW,EAAC;CAChG;;;;;;CAOD,MAAM,iBAAkC;AACtC,SAAO,KAAK,MAAM,UAAU,gBAAgB;CAC7C;;;;;CAMD,MAAM,gBAAmC;AACvC,SAAO,KAAK,MAAM,UAAU,YAAY;CACzC;;;;;;CAOD,MAAM,cAA+B;EACnC,MAAM,iBAAiB,YAAY,OAAO,KAAK,SAAS,eAAe;EACvE,IAAI,QAAQ;AACZ,aAAW,MAAM,KAAK,WAAW,oBAAoB,MAAM,gBAAgB,kBAAkB,CAC3F;AAEF,SAAO;CACR;;;;;;CAOD,MAAM,OAAOC,UAA2D;EACtE,MAAM,aAAa,YAAY,OAAO,KAAK,SAAS,eAAe,4BAA4B,SAAS,IAAI,CAAC;EAC7G,MAAM,YAAY,MAAM,KAAK,WAAW,OAAO,WAAW;AAC1D,MAAI,UACF,QAAO,IAAI,wBAAwB,YAAY,KAAK,YAAY,KAAK;AAGvE,SAAO;CACR;;;;;;CAOD,MAAM,WAAWA,UAAqC;EACpD,MAAM,MAAM,MAAM,KAAK,OAAO,SAAS;AACvC,MAAI,OAAO,KACT,QAAO,IAAI,YAAY;AAEzB,QAAM,IAAI,OAAO,MAAM,SAAS;CACjC;;;;;;;;CASD,MAAM,QACJC,OAEAC,cAAsC,mBACb;EACzB,MAAM,YAAY,MAAM,KAAK,OAAO,MAAM,SAAS;AAEnD,MAAI,cAAc,KAChB,QAAO;AAGT,MAAI,iBAAiB,MACnB,QAAO,UAAU,QAAQ,MAAM,aAAa,YAAY;AAG1D,SAAO,UAAU,QAAQ,MAAM,aAAa,YAAY;CACzD;;;;;;CAOD,MAAM,YAAYD,OAA2C;EAC3D,MAAM,OAAO,MAAM,KAAK,QAAQ,MAAM;AACtC,MAAI,QAAQ,MAAM;GAChB,MAAM,OAAO,MAAM,KAAK,SAAS;AACjC,UAAO;EACR;AAGD,QAAM,IAAI,OAAO,cAAc,MAAM,SAAS,UAAU,MAAM,eAAe,MAAM,YAAY;CAChG;CAGD,kBAAoC;AAClC,SAAO,KAAK,MAAM,OAAO,WAAW;CACrC;CAED,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,uBAAuB;CACjD;CAED,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,SAAS;AACzC,QAAM,KAAK,MAAM,OAAO,kBAAkB;CAC3C;CAED,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,mBAAmB;CAC7C;CAED,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,SAAS;AACzC,QAAM,KAAK,MAAM,OAAO,cAAc;CACvC;CAED,MAAM,2BAAsD;AAC1D,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,SAAS;CACnC;CAGD,IAAa,aAAqB;AAChC,SAAO;CACR;AACF"}
+{"version":3,"file":"index.mjs","names":["textList: string[]","cellIndexOrField: number | string","driverClass: typeof ComponentDriver","cellLocator: PartLocator","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","parts","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","parts","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","locator: PartLocator","interactor: Interactor","option?: Partial<IComponentDriverOption>","timeoutMs: number","rowIndex: number","query: DataGridCellQuery","driverClass: typeof ComponentDriver"],"sources":["../src/components/datagrid/DataGridRowDriverBase.ts","../src/components/datagrid/DataGridDataRowDriver.ts","../src/components/datagrid/DataGridHeaderRowDriver.ts","../src/components/datagrid/DataGridPaginationActionDriver.ts","../src/components/datagrid/DataGridFooterDriver.ts","../src/components/datagrid/DataGridProDriver.ts"],"sourcesContent":["import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport { byAttribute, ComponentDriver, listHelper, locatorUtil, PartLocator } from '@atomic-testing/core';\n\n// In MUI7, there is an extra div preceding the actual data cells. We need to skip it.\nconst columnStartingIndex = 1;\n\n/**\n * Base class for data grid row\n */\nexport abstract class DataGridRowDriverBase extends ComponentDriver {\n  protected async getCellCount(): Promise<number> {\n    let count = 0;\n    for await (const _ of listHelper.getListItemIterator(\n      this,\n      this.getCellLocator(),\n      HTMLElementDriver,\n      columnStartingIndex\n    )) {\n      count++;\n    }\n    return count;\n  }\n\n  /**\n   * Get the text of each visible cell in the row.\n   * Caveat: Because of virtualization, the text of the cell may not be available until the cell is visible.\n   * @returns A promise array of text of each visible cell in the row\n   */\n  async getRowText(): Promise<string[]> {\n    const textList: string[] = [];\n    for await (const cell of listHelper.getListItemIterator(\n      this,\n      this.getCellLocator(),\n      HTMLElementDriver,\n      columnStartingIndex\n    )) {\n      const text = await cell.getText();\n      textList.push(text!.trim());\n    }\n    return textList;\n  }\n\n  /**\n   * Get the cell driver at the specified index or data field.\n   * Caveat: Because of virtualization, the cell may not be available until the cell is visible.\n   * @param cellIndexOrField number: column index, string: column field\n   * @param driverClass The driver class of the cell. Default is HTMLElementDriver\n   * @returns A promise of the cell driver, or null if the cell is not found\n   */\n  async getCell<DriverT extends ComponentDriver>(\n    cellIndexOrField: number | string, // number: column index, string: column field\n    // @ts-ignore\n    driverClass: typeof ComponentDriver = HTMLElementDriver\n  ): Promise<DriverT | null> {\n    let cellLocator: PartLocator;\n    if (typeof cellIndexOrField === 'number') {\n      cellLocator = byAttribute('data-colindex', cellIndexOrField.toString());\n    } else {\n      cellLocator = byAttribute('data-field', cellIndexOrField);\n    }\n    const locator = locatorUtil.append(this.locator, cellLocator);\n    const cellExists = await this.interactor.exists(locator);\n    if (cellExists) {\n      // @ts-ignore\n      return new driverClass(locator, this.interactor, this.commutableOption);\n    }\n\n    return null;\n  }\n\n  protected abstract getCellLocator(): PartLocator;\n}\n","import { byRole, IComponentDriverOption, Interactor, locatorUtil, PartLocator } from '@atomic-testing/core';\n\nimport { DataGridRowDriverBase } from './DataGridRowDriverBase';\n\nexport class DataGridDataRowDriver extends DataGridRowDriverBase {\n  private readonly _dataCellLocator: PartLocator;\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts: {},\n    });\n\n    this._dataCellLocator = locatorUtil.append(locator, byRole('cell'));\n  }\n\n  protected override getCellLocator(): PartLocator {\n    return this._dataCellLocator;\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridDataRowDriver';\n  }\n}\n","import { byRole, IComponentDriverOption, Interactor, locatorUtil, PartLocator } from '@atomic-testing/core';\n\nimport { DataGridRowDriverBase } from './DataGridRowDriverBase';\n\nexport class DataGridHeaderRowDriver extends DataGridRowDriverBase {\n  private readonly _headerCellLocator: PartLocator;\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts: {},\n    });\n\n    this._headerCellLocator = locatorUtil.append(locator, byRole('columnheader'));\n  }\n\n  async getColumnCount(): Promise<number> {\n    return this.getCellCount();\n  }\n\n  protected override getCellLocator(): PartLocator {\n    return this._headerCellLocator;\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridHeaderRowDriver';\n  }\n}\n","import { HTMLButtonDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byAttribute,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nconst parts = {\n  previousButton: {\n    locator: byAttribute('aria-label', 'Go to previous page'),\n    driver: HTMLButtonDriver,\n  },\n  nextButton: {\n    locator: byAttribute('aria-label', 'Go to next page'),\n    driver: HTMLButtonDriver,\n  },\n} satisfies ScenePart;\n\n/**\n * Driver for Material UI v6 DataGridPro component.\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridPaginationActionDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('previousButton');\n    const isDisabled = await this.parts.previousButton.isDisabled();\n    return !isDisabled;\n  }\n\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('previousButton');\n    await this.parts.previousButton.click();\n  }\n\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('nextButton');\n    const isDisabled = await this.parts.nextButton.isDisabled();\n    return !isDisabled;\n  }\n\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('nextButton');\n    await this.parts.nextButton.click();\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridPaginationActionDriver';\n  }\n}\n","import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byCssClass,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  Optional,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nimport { DataGridPaginationActionDriver } from './DataGridPaginationActionDriver';\n\nconst parts = {\n  paginationAction: {\n    locator: byCssClass('MuiTablePagination-actions'),\n    driver: DataGridPaginationActionDriver,\n  },\n  paginationDescription: {\n    locator: byCssClass('MuiTablePagination-displayedRows'),\n    driver: HTMLElementDriver,\n  },\n} satisfies ScenePart;\n\n/**\n * Driver for Material UI v6 DataGridPro component.\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridFooterDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('paginationAction');\n    return this.parts.paginationAction.isPreviousPageEnabled();\n  }\n\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('paginationAction');\n    await this.parts.paginationAction.gotoPreviousPage();\n  }\n\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('paginationAction');\n    return this.parts.paginationAction.isNextPageEnabled();\n  }\n\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('paginationAction');\n    await this.parts.paginationAction.gotoNextPage();\n  }\n\n  async getPaginationDescription(): Promise<Optional<string>> {\n    await this.enforcePartExistence('paginationDescription');\n    return this.parts.paginationDescription.getText();\n  }\n\n  override get driverName(): string {\n    return 'MuiV8DataGridFooterDriver';\n  }\n}\n","import { HTMLElementDriver } from '@atomic-testing/component-driver-html';\nimport {\n  byCssClass,\n  byCssSelector,\n  byRole,\n  ComponentDriver,\n  IComponentDriverOption,\n  Interactor,\n  listHelper,\n  locatorUtil,\n  Optional,\n  PartLocator,\n  ScenePart,\n} from '@atomic-testing/core';\n\nimport { DataGridCellQuery } from './DataGridCellQuery';\nimport { DataGridFooterDriver } from './DataGridFooterDriver';\nimport { DataGridHeaderRowDriver } from './DataGridHeaderRowDriver';\n\nconst parts = {\n  headerRow: {\n    locator: byCssClass('MuiDataGrid-columnHeaders').chain(byCssSelector('[role=row]:first-of-type')),\n    driver: DataGridHeaderRowDriver,\n  },\n  loading: {\n    locator: byRole('progressbar'),\n    driver: HTMLElementDriver,\n  },\n  skeletonOverlay: {\n    locator: byCssClass('MuiDataGrid-main--hasSkeletonLoadingOverlay'),\n    driver: HTMLElementDriver,\n  },\n  footer: {\n    locator: byCssClass('MuiDataGrid-footerContainer'),\n    driver: DataGridFooterDriver,\n  },\n} satisfies ScenePart;\n\nconst dataRowLocator = byCssSelector('[role=row][data-rowindex]');\n\n/**\n * Driver for Material UI v8  DataGridPro component.\n * V8 DataGridPro component does not support data-testid, to use data-testid\n * to locate the component, you need to put the data-testid on the parent element of the grid\n * @see https://mui.com/x/react-data-grid/\n */\nexport class DataGridProDriver extends ComponentDriver<typeof parts> {\n  constructor(locator: PartLocator, interactor: Interactor, option?: Partial<IComponentDriverOption>) {\n    super(locator, interactor, {\n      ...option,\n      parts,\n    });\n  }\n\n  /**\n   * Checks if the data grid is currently loading.\n   * @returns A promise that resolves to a boolean indicating if the data grid is loading.\n   */\n  async isLoading(): Promise<boolean> {\n    const result = await Promise.all([this.parts.skeletonOverlay.isVisible(), this.parts.loading.isVisible()]);\n    return result.some(v => v);\n  }\n\n  /**\n   * Waits for the data grid to exit the loading state.\n   * @param timeoutMs The maximum time to wait for the load to complete, in milliseconds.\n   */\n  async waitForLoad(timeoutMs: number = 10000): Promise<void> {\n    await this.parts.headerRow.waitUntilComponentState();\n    await this.waitUntil({ probeFn: () => this.isLoading(), terminateCondition: false, timeoutMs });\n  }\n\n  /**\n   * The number of columns currently displayed in the data grid, note that data grid pro\n   * uses virtualize rendering, therefore the column count heavily depends on the viewport size\n   * @returns The number of columns currently displayed in the data grid\n   */\n  async getColumnCount(): Promise<number> {\n    return this.parts.headerRow.getColumnCount();\n  }\n\n  /**\n   * The array text of the header row, note that columns not shown in the viewport may not be included because of virtualize rendering\n   * @returns The array of text of the header row\n   */\n  async getHeaderText(): Promise<string[]> {\n    return this.parts.headerRow.getRowText();\n  }\n\n  /**\n   * The number of rows currently displayed in the data grid, note that data grid pro\n   * uses virtualize rendering, therefore the row count heavily depends on the viewport size\n   * @returns The number of columns currently displayed in the data grid\n   */\n  async getRowCount(): Promise<number> {\n    const gridRowLocator = locatorUtil.append(this.locator, dataRowLocator);\n    let count = 0;\n    for await (const _ of listHelper.getListItemIterator(this, gridRowLocator, HTMLElementDriver)) {\n      count++;\n    }\n    return count;\n  }\n\n  /**\n   * Return the row driver for the row at the specified index, if the row does not exist, return null\n   * @param rowIndex\n   * @returns\n   */\n  async getRow(rowIndex: number): Promise<DataGridHeaderRowDriver | null> {\n    const rowLocator = locatorUtil.append(this.locator, byCssSelector(`[role=row][data-rowindex=\"${rowIndex}\"]`));\n    const rowExists = await this.interactor.exists(rowLocator);\n    if (rowExists) {\n      return new DataGridHeaderRowDriver(rowLocator, this.interactor, this.commutableOption);\n    }\n\n    return null;\n  }\n\n  /**\n   * The array text of the specified row, note that columns not shown in the viewport may not be included because of virtualize rendering\n   * @param rowIndex The index of the row\n   * @returns The array of text of the specified row\n   */\n  async getRowText(rowIndex: number): Promise<string[]> {\n    const row = await this.getRow(rowIndex);\n    if (row != null) {\n      return row.getRowText();\n    }\n    throw new Error(`Row ${rowIndex} does not exist`);\n  }\n\n  /**\n   * Get the cell driver for the cell, if the cell does not exist, return null\n   * The cell driver is default to HTMLElementDriver, you can specify a different driver class\n   * @param query The query to locate the cell\n   * @param driverClass Optional, the driver class to use for the cell, default to HTMLElementDriver\n   * @returns\n   */\n  async getCell<DriverT extends ComponentDriver>(\n    query: DataGridCellQuery,\n    // @ts-ignore\n    driverClass: typeof ComponentDriver = HTMLElementDriver\n  ): Promise<DriverT | null> {\n    const rowDriver = await this.getRow(query.rowIndex);\n\n    if (rowDriver === null) {\n      return null;\n    }\n\n    if ('columnIndex' in query) {\n      return rowDriver.getCell(query.columnIndex, driverClass);\n    }\n\n    return rowDriver.getCell(query.columnField, driverClass);\n  }\n\n  /**\n   * Get the text content of the cell, if the cell does not exist, throw an error\n   * @param query The query to locate the cell\n   * @returns\n   */\n  async getCellText(query: DataGridCellQuery): Promise<string> {\n    const cell = await this.getCell(query);\n    if (cell != null) {\n      const text = await cell.getText();\n      return text!;\n    }\n\n    //@ts-ignore\n    throw new Error(`Cell at row:${query.rowIndex} column:${query.columnIndex ?? query.columnField} does not exist`);\n  }\n\n  //#region Footer\n  /**\n   * Determine if the pagination footer is currently visible.\n   */\n  isFooterVisible(): Promise<boolean> {\n    return this.parts.footer.isVisible();\n  }\n\n  /**\n   * Check whether the \"previous page\" control is enabled.\n   */\n  async isPreviousPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.isPreviousPageEnabled();\n  }\n\n  /**\n   * Navigate to the previous page using the grid footer control.\n   */\n  async gotoPreviousPage(): Promise<void> {\n    await this.enforcePartExistence('footer');\n    await this.parts.footer.gotoPreviousPage();\n  }\n\n  /**\n   * Check whether the \"next page\" control is enabled.\n   */\n  async isNextPageEnabled(): Promise<boolean> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.isNextPageEnabled();\n  }\n\n  /**\n   * Navigate to the next page using the grid footer control.\n   */\n  async gotoNextPage(): Promise<void> {\n    await this.enforcePartExistence('footer');\n    await this.parts.footer.gotoNextPage();\n  }\n\n  /**\n   * Read the textual description of the current pagination state.\n   */\n  async getPaginationDescription(): Promise<Optional<string>> {\n    await this.enforcePartExistence('footer');\n    return this.parts.footer.getText();\n  }\n  //#endregion Footer\n\n  override get driverName(): string {\n    return 'MuiV8DataGridProDriver';\n  }\n}\n"],"mappings":";;;;AAIA,MAAM,sBAAsB;;;;AAK5B,IAAsB,wBAAtB,cAAoD,gBAAgB;CAClE,MAAgB,eAAgC;EAC9C,IAAI,QAAQ;AACZ,aAAW,MAAM,KAAK,WAAW,oBAC/B,MACA,KAAK,gBAAgB,EACrB,mBACA,oBACD,CACC;AAEF,SAAO;CACR;;;;;;CAOD,MAAM,aAAgC;EACpC,MAAMA,WAAqB,CAAE;AAC7B,aAAW,MAAM,QAAQ,WAAW,oBAClC,MACA,KAAK,gBAAgB,EACrB,mBACA,oBACD,EAAE;GACD,MAAM,OAAO,MAAM,KAAK,SAAS;AACjC,YAAS,KAAK,KAAM,MAAM,CAAC;EAC5B;AACD,SAAO;CACR;;;;;;;;CASD,MAAM,QACJC,kBAEAC,cAAsC,mBACb;EACzB,IAAIC;AACJ,aAAW,qBAAqB,SAC9B,eAAc,YAAY,iBAAiB,iBAAiB,UAAU,CAAC;MAEvE,eAAc,YAAY,cAAc,iBAAiB;EAE3D,MAAM,UAAU,YAAY,OAAO,KAAK,SAAS,YAAY;EAC7D,MAAM,aAAa,MAAM,KAAK,WAAW,OAAO,QAAQ;AACxD,MAAI,WAEF,QAAO,IAAI,YAAY,SAAS,KAAK,YAAY,KAAK;AAGxD,SAAO;CACR;AAGF;;;;ACnED,IAAa,wBAAb,cAA2C,sBAAsB;CAC/D,AAAiB;CACjB,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH,OAAO,CAAE;EACV,EAAC;AAEF,OAAK,mBAAmB,YAAY,OAAO,SAAS,OAAO,OAAO,CAAC;CACpE;CAED,AAAmB,iBAA8B;AAC/C,SAAO,KAAK;CACb;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AClBD,IAAa,0BAAb,cAA6C,sBAAsB;CACjE,AAAiB;CACjB,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH,OAAO,CAAE;EACV,EAAC;AAEF,OAAK,qBAAqB,YAAY,OAAO,SAAS,OAAO,eAAe,CAAC;CAC9E;CAED,MAAM,iBAAkC;AACtC,SAAO,KAAK,cAAc;CAC3B;CAED,AAAmB,iBAA8B;AAC/C,SAAO,KAAK;CACb;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AChBD,MAAMC,UAAQ;CACZ,gBAAgB;EACd,SAAS,YAAY,cAAc,sBAAsB;EACzD,QAAQ;CACT;CACD,YAAY;EACV,SAAS,YAAY,cAAc,kBAAkB;EACrD,QAAQ;CACT;AACF;;;;;AAMD,IAAa,iCAAb,cAAoD,gBAA8B;CAChF,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;CAED,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,iBAAiB;EACjD,MAAM,aAAa,MAAM,KAAK,MAAM,eAAe,YAAY;AAC/D,UAAQ;CACT;CAED,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,iBAAiB;AACjD,QAAM,KAAK,MAAM,eAAe,OAAO;CACxC;CAED,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,aAAa;EAC7C,MAAM,aAAa,MAAM,KAAK,MAAM,WAAW,YAAY;AAC3D,UAAQ;CACT;CAED,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,aAAa;AAC7C,QAAM,KAAK,MAAM,WAAW,OAAO;CACpC;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AC7CD,MAAMC,UAAQ;CACZ,kBAAkB;EAChB,SAAS,WAAW,6BAA6B;EACjD,QAAQ;CACT;CACD,uBAAuB;EACrB,SAAS,WAAW,mCAAmC;EACvD,QAAQ;CACT;AACF;;;;;AAMD,IAAa,uBAAb,cAA0C,gBAA8B;CACtE,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;CAED,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,SAAO,KAAK,MAAM,iBAAiB,uBAAuB;CAC3D;CAED,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,QAAM,KAAK,MAAM,iBAAiB,kBAAkB;CACrD;CAED,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,SAAO,KAAK,MAAM,iBAAiB,mBAAmB;CACvD;CAED,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,mBAAmB;AACnD,QAAM,KAAK,MAAM,iBAAiB,cAAc;CACjD;CAED,MAAM,2BAAsD;AAC1D,QAAM,KAAK,qBAAqB,wBAAwB;AACxD,SAAO,KAAK,MAAM,sBAAsB,SAAS;CAClD;CAED,IAAa,aAAqB;AAChC,SAAO;CACR;AACF;;;;AC7CD,MAAM,QAAQ;CACZ,WAAW;EACT,SAAS,WAAW,4BAA4B,CAAC,MAAM,cAAc,2BAA2B,CAAC;EACjG,QAAQ;CACT;CACD,SAAS;EACP,SAAS,OAAO,cAAc;EAC9B,QAAQ;CACT;CACD,iBAAiB;EACf,SAAS,WAAW,8CAA8C;EAClE,QAAQ;CACT;CACD,QAAQ;EACN,SAAS,WAAW,8BAA8B;EAClD,QAAQ;CACT;AACF;AAED,MAAM,iBAAiB,cAAc,4BAA4B;;;;;;;AAQjE,IAAa,oBAAb,cAAuC,gBAA8B;CACnE,YAAYC,SAAsBC,YAAwBC,QAA0C;AAClG,QAAM,SAAS,YAAY;GACzB,GAAG;GACH;EACD,EAAC;CACH;;;;;CAMD,MAAM,YAA8B;EAClC,MAAM,SAAS,MAAM,QAAQ,IAAI,CAAC,KAAK,MAAM,gBAAgB,WAAW,EAAE,KAAK,MAAM,QAAQ,WAAW,AAAC,EAAC;AAC1G,SAAO,OAAO,KAAK,OAAK,EAAE;CAC3B;;;;;CAMD,MAAM,YAAYC,YAAoB,KAAsB;AAC1D,QAAM,KAAK,MAAM,UAAU,yBAAyB;AACpD,QAAM,KAAK,UAAU;GAAE,SAAS,MAAM,KAAK,WAAW;GAAE,oBAAoB;GAAO;EAAW,EAAC;CAChG;;;;;;CAOD,MAAM,iBAAkC;AACtC,SAAO,KAAK,MAAM,UAAU,gBAAgB;CAC7C;;;;;CAMD,MAAM,gBAAmC;AACvC,SAAO,KAAK,MAAM,UAAU,YAAY;CACzC;;;;;;CAOD,MAAM,cAA+B;EACnC,MAAM,iBAAiB,YAAY,OAAO,KAAK,SAAS,eAAe;EACvE,IAAI,QAAQ;AACZ,aAAW,MAAM,KAAK,WAAW,oBAAoB,MAAM,gBAAgB,kBAAkB,CAC3F;AAEF,SAAO;CACR;;;;;;CAOD,MAAM,OAAOC,UAA2D;EACtE,MAAM,aAAa,YAAY,OAAO,KAAK,SAAS,eAAe,4BAA4B,SAAS,IAAI,CAAC;EAC7G,MAAM,YAAY,MAAM,KAAK,WAAW,OAAO,WAAW;AAC1D,MAAI,UACF,QAAO,IAAI,wBAAwB,YAAY,KAAK,YAAY,KAAK;AAGvE,SAAO;CACR;;;;;;CAOD,MAAM,WAAWA,UAAqC;EACpD,MAAM,MAAM,MAAM,KAAK,OAAO,SAAS;AACvC,MAAI,OAAO,KACT,QAAO,IAAI,YAAY;AAEzB,QAAM,IAAI,OAAO,MAAM,SAAS;CACjC;;;;;;;;CASD,MAAM,QACJC,OAEAC,cAAsC,mBACb;EACzB,MAAM,YAAY,MAAM,KAAK,OAAO,MAAM,SAAS;AAEnD,MAAI,cAAc,KAChB,QAAO;AAGT,MAAI,iBAAiB,MACnB,QAAO,UAAU,QAAQ,MAAM,aAAa,YAAY;AAG1D,SAAO,UAAU,QAAQ,MAAM,aAAa,YAAY;CACzD;;;;;;CAOD,MAAM,YAAYD,OAA2C;EAC3D,MAAM,OAAO,MAAM,KAAK,QAAQ,MAAM;AACtC,MAAI,QAAQ,MAAM;GAChB,MAAM,OAAO,MAAM,KAAK,SAAS;AACjC,UAAO;EACR;AAGD,QAAM,IAAI,OAAO,cAAc,MAAM,SAAS,UAAU,MAAM,eAAe,MAAM,YAAY;CAChG;;;;CAMD,kBAAoC;AAClC,SAAO,KAAK,MAAM,OAAO,WAAW;CACrC;;;;CAKD,MAAM,wBAA0C;AAC9C,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,uBAAuB;CACjD;;;;CAKD,MAAM,mBAAkC;AACtC,QAAM,KAAK,qBAAqB,SAAS;AACzC,QAAM,KAAK,MAAM,OAAO,kBAAkB;CAC3C;;;;CAKD,MAAM,oBAAsC;AAC1C,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,mBAAmB;CAC7C;;;;CAKD,MAAM,eAA8B;AAClC,QAAM,KAAK,qBAAqB,SAAS;AACzC,QAAM,KAAK,MAAM,OAAO,cAAc;CACvC;;;;CAKD,MAAM,2BAAsD;AAC1D,QAAM,KAAK,qBAAqB,SAAS;AACzC,SAAO,KAAK,MAAM,OAAO,SAAS;CACnC;CAGD,IAAa,aAAqB;AAChC,SAAO;CACR;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomic-testing/component-driver-mui-x-v8",
-  "version": "0.75.0",
+  "version": "0.77.0",
   "description": "Atomic Testing Component driver to help drive Material UI X V8 components",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -27,9 +27,9 @@
     "directory": "packages/component-driver-mui-x-v8"
   },
   "dependencies": {
-    "@atomic-testing/core": "0.75.0",
-    "@atomic-testing/component-driver-html": "0.75.0",
-    "@atomic-testing/component-driver-mui-v6": "0.75.0"
+    "@atomic-testing/core": "0.77.0",
+    "@atomic-testing/component-driver-mui-v6": "0.77.0",
+    "@atomic-testing/component-driver-html": "0.77.0"
   },
   "scripts": {
     "build": "tsdown",

package/src/components/datagrid/DataGridProDriver.ts

@@ -171,30 +171,48 @@ export class DataGridProDriver extends ComponentDriver<typeof parts> {
   }
 
   //#region Footer
+  /**
+   * Determine if the pagination footer is currently visible.
+   */
   isFooterVisible(): Promise<boolean> {
     return this.parts.footer.isVisible();
   }
 
+  /**
+   * Check whether the "previous page" control is enabled.
+   */
   async isPreviousPageEnabled(): Promise<boolean> {
     await this.enforcePartExistence('footer');
     return this.parts.footer.isPreviousPageEnabled();
   }
 
+  /**
+   * Navigate to the previous page using the grid footer control.
+   */
   async gotoPreviousPage(): Promise<void> {
     await this.enforcePartExistence('footer');
     await this.parts.footer.gotoPreviousPage();
   }
 
+  /**
+   * Check whether the "next page" control is enabled.
+   */
   async isNextPageEnabled(): Promise<boolean> {
     await this.enforcePartExistence('footer');
     return this.parts.footer.isNextPageEnabled();
   }
 
+  /**
+   * Navigate to the next page using the grid footer control.
+   */
   async gotoNextPage(): Promise<void> {
     await this.enforcePartExistence('footer');
     await this.parts.footer.gotoNextPage();
   }
 
+  /**
+   * Read the textual description of the current pagination state.
+   */
   async getPaginationDescription(): Promise<Optional<string>> {
     await this.enforcePartExistence('footer');
     return this.parts.footer.getText();