@sap_oss/wdio-qmate-service 2.17.0 → 2.18.0

package/lib/reuse/modules/ui5/table.d.ts

@@ -1,3 +1,4 @@
+import { Ui5Selector } from "./types/ui5.types";
 /**
  * @class table
  * @memberof ui5
@@ -5,12 +6,15 @@
 export declare class Table {
     private vlf;
     private ErrorHandler;
+    private static readonly SMART_TABLE_METADATA;
+    private static readonly TABLE_METADATA;
+    private static readonly COLUMN_LIST_ITEM_METADATA;
     /**
      * @function sortColumnAscending
      * @memberOf ui5.table
      * @description Sorts the given column "Ascending".
      * @param {String} columnName - The name of the column to sort.
-     * @param {Object} [tableSelector] - The selector describing the table element (in case there are more then one).
+     * @param {Ui5Selector} tableSelector - The selector describing the table element (in case there are more then one).
      * @example await ui5.table.sortColumnAscending("Supplier");
      * @example const glAccountItemsTable = {
      *  "elementProperties": {
@@ -21,13 +25,13 @@ export declare class Table {
      * };
      * await ui5.table.sortColumnAscending("Amount", glAccountItemsTable);
      */
-    sortColumnAscending(columnName: string, tableSelector: any): Promise<void>;
+    sortColumnAscending(columnName: string, tableSelector: Ui5Selector): Promise<void>;
     /**
      * @function sortColumnDescending
      * @memberOf ui5.table
      * @description Sorts the given column "Descending".
      * @param {String} columnName The name of the column to sort.
-     * @param {Object} [tableSelector] - The selector describing the table element (in case there are more then one).
+     * @param {Ui5Selector} tableSelector - The selector describing the table element (in case there are more then one).
      * @example await ui5.table.sortColumnDescending("Supplier");
      * @example const glAccountItemsTable = {
      *  "elementProperties": {
@@ -38,12 +42,12 @@ export declare class Table {
      * };
      * await ui5.table.sortColumnDescending("Amount", glAccountItemsTable);
      */
-    sortColumnDescending(columnName: string, tableSelector: any): Promise<void>;
+    sortColumnDescending(columnName: string, tableSelector: Ui5Selector): Promise<void>;
     /**
      * @function clickSettingsButton
      * @memberOf ui5.table
      * @description Opens the user Settings.
-     * @param {Object} [tableSelector] - The selector describing the table element (in case there are more then one).
+     * @param {Ui5Selector} tableSelector - The selector describing the table element (in case there are more then one).
      * @example await ui5.table.clickSettingsButton();
      * @example const glAccountItemsTable = {
      *  "elementProperties": {
@@ -54,12 +58,12 @@ export declare class Table {
      * };
      * await ui5.table.clickSettingsButton(glAccountItemsTable);
      */
-    clickSettingsButton(tableSelector: any): Promise<void>;
+    clickSettingsButton(tableSelector: Ui5Selector): Promise<void>;
     /**
      * @function getTotalNumberOfRows
      * @memberOf ui5.table
      * @description Returns the total number of rows in the table.
-     * @param {Object | String} [tableSelector] - The selector or ID describing the outer smart table element.
+     * @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
      * @returns {Number} The total number of rows in the table.
      * @example const selector = {
      *  elementProperties: {
@@ -70,11 +74,165 @@ export declare class Table {
      * };
      * const numberOfRows = await ui5.table.getTotalNumberOfRows(selector);
      */
-    getTotalNumberOfRows(tableSelector: object | string): Promise<number>;
-    private _resolveTableSelector;
+    getTotalNumberOfRows(tableSelectorOrId: Ui5Selector | string): Promise<number>;
+    /**
+     * @function getTotalNumberOfRowsByValues
+     * @memberOf ui5.table
+     * @description Returns the total number of rows in the table that match the given values.
+     * @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
+     * @param {String | Array<String>} values - The value(s) to match in the table rows.
+     * @param {Number} [index=0] - The index of the matching row to consider.
+     * @returns {Number} The total number of matching rows in the table.
+     * @example const selector = {
+     *  elementProperties: {
+     *    viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
+     *    metadata: "sap.ui.comp.smarttable.SmartTable",
+     *    id: "application-ReportingTask-run-component---ReportList--ReportingTable"
+     *  }
+     * };
+     * const numberOfRows = await ui5.table.getTotalNumberOfRowsByValues(selector, ["value1", "value2"]);
+     * const numberOfRows = await ui5.table.getTotalNumberOfRowsByValues(selector, "value");
+     **/
+    getTotalNumberOfRowsByValues(tableSelectorOrId: Ui5Selector | string, values: string | Array<string>): Promise<number>;
+    /**
+     * @function selectRowByIndex
+     * @memberOf ui5.table
+     * @description Selects a row in the table by its index.
+     * @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
+     * @param {Number} index - The index of the row to select.
+     * @example await ui5.table.selectRowByIndex("application-ReportingTask-run-component---ReportList--ReportingTable", 0);
+     * @example const selector = {
+     *  elementProperties: {
+     *    viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
+     *    metadata: "sap.ui.comp.smarttable.SmartTable",
+     *    id: "application-ReportingTask-run-component---ReportList--ReportingTable"
+     *  }
+     * };
+     * await ui5.table.selectRowByIndex(selector, 0);
+     */
+    selectRowByIndex(tableSelectorOrId: Ui5Selector | string, index: number): Promise<void>;
+    /**
+     * @function openItemByIndex
+     * @memberOf ui5.table
+     * @description Opens the item in the table by its index.
+     * @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
+     * @param {Number} index - The index of the item to open.
+     * @example const selector = {
+     *  elementProperties: {
+     *   viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
+     *   metadata: "sap.ui.comp.smarttable.SmartTable",
+     *   id: "application-ReportingTask-run-component---ReportList--ReportingTable"
+     *  }
+     * };
+     * await ui5.table.openItemByIndex(selector, 0);
+     * @example const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
+     * await ui5.table.openItemByIndex(id, 0);
+     */
+    openItemByIndex(tableSelectorOrId: Ui5Selector | string, index: number): Promise<void>;
+    /**
+     * @function openItemByValues
+     * @memberOf ui5.table
+     * @description Opens the item in the table containing the given values. If multiple items match, it opens the index-th item.
+     * @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
+     * @param {String | Array<String>} values - The value(s) to match in the table rows.
+     * @param {Number} [index=0] - The index of the matching row to consider.
+     * @example const selector = {
+     *  elementProperties: {
+     *    viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
+     *    metadata: "sap.ui.comp.smarttable.SmartTable",
+     *    id: "application-ReportingTask-run-component---ReportList--ReportingTable"
+     *  }
+     * };
+     * await ui5.table.openItemByValues(selector, ["value1", "value2"]);
+     * @example const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
+     * await ui5.table.openItemByValues(id, "value");
+     */
+    openItemByValues(tableSelectorOrId: Ui5Selector | string, values: string | Array<string>, index?: number): Promise<undefined>;
+    /**
+     * @function getSelectorsForRowsByValues
+     * @memberOf ui5.table
+     * @description Gets the selectors of rows in the table that contain the given values. If multiple values are provided, it only returns the selectors of rows that contain all of them.
+     * @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
+     * @param {string} values - The value(s) to match in the table rows.
+     * @example const id = "application-ReportingTask-run-component---ReportList--ReportingTable"
+     * await ui5.table.getSelectorsForRowsByValues(id, "February");
+     * @example const selector = {
+     *  elementProperties: {
+     *    viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
+     *    metadata: "sap.ui.comp.smarttable.SmartTable",
+     *    id: "application-ReportingTask-run-component---ReportList--ReportingTable"
+     *  }
+     * };
+     * await ui5.table.getSelectorsForRowsByValues(selector, ["January", "2022"]);
+     */
+    getSelectorsForRowsByValues(tableSelector: Ui5Selector | string, values: string | Array<string>): Promise<Array<Ui5Selector>>;
+    /**
+     * @function getSelectorForRowByIndex
+     * @memberOf ui5.table
+     * @description Gets the selector of a row in the table by its index.
+     * @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
+     * @param {Number} index - The index of the item to open.
+     * @example const selector = {
+     *  elementProperties: {
+     *    viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
+     *    metadata: "sap.ui.comp.smarttable.SmartTable",
+     *    id: "application-ReportingTask-run-component---ReportList--ReportingTable"
+     *  }
+     * };
+     * const rowSelector = await ui5.table.getSelectorForRowByIndex(selector, 0);
+     * @example id = "application-ReportingTask-run-component---ReportList--ReportingTable"
+     * const rowSelector = await ui5.table.getSelectorForRowByIndex(id, 0);
+     */
+    getSelectorForRowByIndex(tableSelector: any, index: number): Promise<Ui5Selector>;
+    /**
+     * @function selectAllRows
+     * @memberOf ui5.table
+     * @description Selects all rows in the table.
+     * @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
+     * @example await ui5.table.selectAllRows("application-ReportingTask-run-component---ReportList--ReportingTable");
+     * await ui5.table.selectAllRows(selector);
+     */
+    selectAllRows(tableSelectorOrId: Ui5Selector | string): Promise<void>;
+    /**
+     * @function deselectRowByIndex
+     * @memberOf ui5.table
+     * @description Deselects a row in the table by its index.
+     * @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
+     * @example const selector = {
+     *  elementProperties: {
+     *    viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
+     *    metadata: "sap.ui.comp.smarttable.SmartTable",
+     *   id: "application-ReportingTask-run-component---ReportList--ReportingTable"
+     *  }
+     * };
+     * await ui5.table.deselectRowByIndex(selector, 0);
+     * @example const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
+     * await ui5.table.deselectRowByIndex(id, 0);
+     */
+    deselectRowByIndex(tableSelectorOrId: Ui5Selector | string, index: number): Promise<void>;
+    /**
+     * @function deselectAllRows
+     * @memberOf ui5.table
+     * @description Deselects all rows in the table.
+     * @param {Ui5Selector | String} tableSelectorOrId - The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable).
+     * @example await ui5.table.deselectAllRows("application-ReportingTask-run-component---ReportList--ReportingTable");
+     * @example const selector = {
+     *  elementProperties: {
+     *    viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
+     *    metadata: "sap.ui.comp.smarttable.SmartTable",
+     *    id: "application-ReportingTask-run-component---ReportList--ReportingTable"
+     *  }
+     * };
+     * await ui5.table.deselectAllRows(selector);
+     */
+    deselectAllRows(tableSelectorOrId: Ui5Selector | string): Promise<void>;
+    private _resolveTableSelectorOrId;
+    private _getId;
+    private _getTableMetadata;
+    private _constructTableSelector;
     private _extractRowCountFromTitle;
     private _clickColumn;
-    private _getSortValudGridTable;
+    private _getSortValueGridTable;
     private _getSortIndicatorValue;
     private _prepareAncestorSelector;
 }