@globisnv/cypress-core 0.0.1

package/dist/commands/GLO_commands.d.ts

@@ -0,0 +1,685 @@
+import { type CheckState, type disabledFlag, type exactMatchFlag, type OpenClose, type searchTypeFlag, type showInCommandLogFlag, type skipCheckFlag, type usernameFlag, type validityFlag } from '../tsHelper.js';
+type GetOptions = NonNullable<Parameters<typeof cy.get>[1]> & Partial<Cypress.TypeOptions> & {
+    selectAllDelete?: boolean;
+};
+declare global {
+    namespace Cypress {
+        interface Chainable {
+            /**
+             * Command to clear data by executing a formula.
+             * This formula needs to be added to the desired Globis environment.
+             *
+             * @param {deleteRecordsType} formulaName - The name of the formula should be 'DELETE_CYPRESS_RECORDS' or 'DELETE_LEAPWORK_RECORDS'
+             */
+            GLO_clearData(formulaName: deleteRecordsType): void;
+            /**
+             * @deprecated - use GLO_getElement instead. This command has been disabled.
+             */
+            GLO_getByCData(formName: string, elementName: string, disableFilterVisible?: string, timeOut?: number): Chainable<JQuery>;
+            /**
+             * @deprecated - use GLO_getElement instead. This command has been disabled.
+             */
+            GLO_getByName(elementName: string, disableFilterVisible?: string, timeOut?: number): Chainable<JQuery>;
+            /**
+             * Locate an element by selector array.
+             * Scoped to the active crumb; falls back to global if no match.
+             *
+             * @param {selectorType} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup. Optional trailing number selects the Nth matching element (row-index aware).
+             * @param {GetOptions} [options] - Optional Cypress get options (e.g. timeout).
+             */
+            GLO_getElement(selector: selectorType, options?: GetOptions): Chainable<JQuery>;
+            /**
+             * Command to locate an element by using get and adding a filter(':visible')
+             *
+             * @param {string} selector - The selector of the element.
+             * @param {number} timeOut - how long it should wait for the element to be found, default set in tsHelper.ts
+             * @returns {Chainable<JQuery<HTMLElement>>} Yields the element matching the specified name attribute, filtered for visibility.
+             */
+            GLO_getVisible(selector: string, timeOut?: number): Chainable<JQuery>;
+            /**
+             * Command to perform login based on the login type specified in environment variables.
+             *
+             * If provided, it will be used in specific login methods.
+             * @param {string} [company] - Optional parameter representing the company name.
+             * @param {urlTypeType} [urlType] - This optional parameter is used for change the url from online to something else ex. pos.
+             */
+            GLO_login(company?: string, urlType?: urlTypeType): void;
+            /**
+             * Command to perform a Globis default login, using a Globis username and password.
+             *
+             * @param {string} [company] - Optional parameter representing the company name.
+             * If provided, it selects the specified company after login.
+             * @param {string} [usernameENV] - Optional parameter to use a different env username
+             * @param {string} [passwordENV] - Optional parameter to use a different env password
+             * @param {urlTypeType} [urlType] - This optional parameter is used to change the url solution parameter from 'online' to something else, e.g. 'pos'.
+             */
+            GLO_defaultlogin(company?: string, usernameENV?: string, passwordENV?: string, urlType?: urlTypeType): void;
+            /**
+             * Command to perform default login. username and password with a second user.
+             * We assume that the login screen is already visible. This command can only be executed after a logout,
+             * as there is a difference in HTML code between the default landing page and the secondary (this) one.
+             *
+             * @param {string} usernameENV - Name of the env variable for the username ex. 'username2'.
+             * @param {string} passwordENV - Name of the env variable for the password ex. 'password2'.
+             * @param {string} [company] - Optional parameter representing a company name.
+             * If provided, the specified company will be selected during login.
+             */
+            GLO_defaultloginExtraUser(usernameENV: string, passwordENV: string, company?: string): void;
+            /**
+             * Command to perform a login using Okta authentication.
+             *
+             * @param {string} [company] - Optional parameter representing the company name.
+             * If provided, it selects the specified company after login.
+             * @param {urlTypeType} [urlType] - This optional parameter is used to change the url solution parameter from 'online' to something else, e.g. 'pos'.
+             * @param {skipCheckFlag} [skipNavCheck] - This optional parameter is used to skip the navbar validation. Only use this in rare cases
+             */
+            GLO_oktaLogin(company?: string, urlType?: urlTypeType, skipNavCheck?: skipCheckFlag): void;
+            /**
+             * Command to perform a logout.
+             */
+            GLO_logout(): void;
+            /**
+             * Command to check the user and end a test whenever the provided username is globisadmin.
+             */
+            GLO_checkUser(): void;
+            /**
+             * Command to perform a login using Servoy authentication.
+             *
+             * @param {string} [company] - Optional parameter representing the company name.
+             * If provided, the specified company will be selected during login.
+             */
+            GLO_servoyLogin(company?: string): void;
+            /**
+             * Click a button element located via selector. Always scrolls into view before clicking.
+             *
+             * @param {selectorType} selector - `[name]`, `[form, element]`, or with optional trailing index: `[name, idx]` / `[form, element, idx]`.
+             * @param {string} [buttonType] - Optional icon class within the element (e.g. 'fa-search', 'fa-plus').
+             */
+            GLO_clickButton(selector: selectorType, buttonType?: string): void;
+            /**
+             * Command to search for a program using the header.
+             *
+             * @param {string} solutionName - The name of the solution.
+             * @param {string} moduleName - The name of the module.
+             * @param {string} programName - The name of the program to search for.
+             *
+             * @example - cy.GLO_searchHeader('Relations', 'Relations', 'Suppliers')
+             */
+            GLO_searchHeader(solutionName: string, moduleName: string, programName: string): void;
+            /**
+             * Command to search for a specific value within a datacontrol section.
+             * This command will do a search inside data for a specific program, using the righternmost search box.
+             *
+             * @param {customValueTypeUndefined} elementName - The name of the element to search for within the data control.
+             *
+             * @example - Search for a Sales order number inside the Sales orders program
+             */
+            GLO_searchDataControl(elementName: customValueTypeUndefined): void;
+            /**
+             * Check the value of a field.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {customValueTypeUndefined} value - Expected value.
+             * @param {checkOperatorType} [operator='equal'] - Comparison operator.
+             * @param {number} [timeOut=10000] - How long it should wait for the field to update, default: 10s
+             */
+            GLO_checkField(selector: selectorType, value: customValueTypeUndefined, operator?: checkOperatorType, timeOut?: number): void;
+            /**
+             * Command to check the absence of the loading indicator.
+             * Waits for 1 second, and then waits for the loading indicator to disappear within 20 minutes.
+             */
+            GLO_checkLoadingIndicator(): void;
+            /**
+             * Command to click a button within the main program datacontrol bar, based on a provided button name.
+             *
+             * For the view buttons `btnList` and `btnDetail` the click is skipped (without failing) when the button is disabled or absent,
+             * because that means the requested view is already the active one, or the program has no list/detail toggle at all.
+             * This makes them safe to call unconditionally, e.g. right after `GLO_selectProgram` when you do not know in which view the program was left.
+             *
+             * @param {string} buttonName - The identifier of the button within the data control browser tab.
+             * @param {skipCheckFlag} [skipCheck = noSkipCheck] - This will disable the check after a button save.
+             */
+            GLO_clickDatacontrolBrowserButton(buttonName: datacontrolbuttonType, skipCheck?: skipCheckFlag): void;
+            /**
+             * Command to click a button within the datacontrol bar in the viewer section, based on the provided page name and button name.
+             *
+             * @param {string} pageName - The name of the page containing the datacontrol bar in the viewer section.
+             * @param {string} buttonName - The identifier of the button within the datacontrol bar in the viewer section.
+             * @param {skipCheckFlag} [skipCheck = noSkipCheck] - This will disable the check after a button save.
+             *
+             * @example - cy.GLO_clickDatacontrolViewerButton('salesorder', 'btnAdd');
+             */
+            GLO_clickDatacontrolViewerButton(pageName: string, buttonName: baseDatacontrolViewerButtonType, skipCheck?: skipCheckFlag): void;
+            /**
+             * Command to click a button based on its displayed text.
+             *
+             * @param {string} textButton - The text displayed on the button to be clicked.
+             */
+            GLO_clickButtonText(textButton: string): void;
+            /**
+             * Command to select a company on the login screen.
+             *
+             * @param {string} companyName - The name of the company to be selected.
+             */
+            GLO_selectCompany(companyName: string): void;
+            /**
+             * Check or uncheck a checkbox element.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {CheckState} bool - check to check, unCheck to uncheck.
+             */
+            GLO_checkbox(selector: string[], bool: CheckState): void;
+            /**
+             * Toggle a switch element on or off.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {CheckState} bool - check to enable, unCheck to disable.
+             */
+            GLO_switch(selector: string[], bool: CheckState): void;
+            /**
+             * Command to close all programs.
+             */
+            GLO_closeDashboard(): void;
+            /**
+             * Command to select a tab using its data-cy attribute, which is composed of formName.elementName
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {string} tabName - The name of the tab to be selected.
+             * @param {OpenClose} openOrClose - Indicates whether to open (true) or close (false) the tab.
+             */
+            GLO_selectTab(selector: string[], tabName: string, openOrClose: OpenClose): void;
+            /**
+             * Command to open the workflow menu and to click a desired workflow in the main program datacontrol section.
+             *
+             * @param {string} buttonName - The workflow entry to be selected.
+             * @param {exactMatchFlag} [exactMatch] - Indicates whether to search for an exact match (equalBool) or not. Default is disabled.
+             */
+            GLO_selectMenuButton(buttonName: string, exactMatch?: exactMatchFlag): void;
+            /**
+             * Command to open the workflow menu and to click a desired workflow in the datacontrol viewer section.
+             *
+             * @param {string} tabName - The name of the tab containing the datacontrol viewer section.
+             * @param {string} buttonName - The workflow entry to be selected.
+             * @param {exactMatchFlag} [exactMatch] - Indicates whether to search for an exact match (equalBool) or not). Default: is disabled.
+             *
+             * @example - cy.GLO_selectMenuButtonControlView('salesorder', 'Confirm');
+             */
+            GLO_selectMenuButtonControlView(tabName: string, buttonName: string, exactMatch?: exactMatchFlag): void;
+            /**
+             * Close a program based on its position.
+             *
+             * @param {topBottomType} topBottom - The position of the program ('top' or 'bottom') row.
+             * @param {string} programName - The name of the program to be closed.
+             * @param {number} [tabNumber] - Optional: If multiple programs with the same name are open, the tab number of the program to be closed should be defined.
+             * The tabNumber index starts at 0 for the leftmost program.
+             *
+             */
+            GLO_closeProgram(topBottom: topBottomType, programName: string, tabNumber?: number): void;
+            /**
+             * Command to make a choice in a popup dialog.
+             * Test will continue if no dialog pops up.
+             *
+             * @param {string} confirmation - The button, based on its text contents, to be clicked in the popup dialog.
+             */
+            GLO_dialogChoice(confirmation: string): void;
+            /**
+             * Command to add input to a dialog with an input field.
+             *
+             * @param {string} text - The option to be selected in the popup dialog.
+             */
+            GLO_addInputDialog(text: string): void;
+            /**
+             * Command to interact with an input field, dropdown, textarea or monaco editor.
+             * Element type is auto-detected from the DOM.
+             *
+             * @param {selectorType} selector - `[name]`, `[form, element]`, or with optional trailing index: `[name, idx]` / `[form, element, idx]`.
+             * @param {customValueTypeUndefined} value - The value to be entered/selected.
+             * @param {GetOptions} [options] - Optional Cypress get options (e.g. timeout).
+             */
+            GLO_addInput(selector: selectorType, value: customValueTypeUndefined, options?: GetOptions): void;
+            /**
+             * Command to interact with different types of date input fields based on the type specified.
+             *
+             * @param {addDateType} type - The type of date field to interact with (input, inputName, select, selectName).
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {string} value - The date value to be entered or selected in the date field.
+             */
+            GLO_addDate(type: addDateType, selector: string[], value: string | undefined): void;
+            /**
+             * Command to upload a file using its data-cy attribute, which is composed of formName.elementName
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {string} relativePath - The relative path of the file to be uploaded.
+             *
+             * @remark - Assuming that 'cypress' is the main folder, the path will usually be 'cypress/YYY/ZZZ/'.
+             */
+            GLO_uploadFile(selector: string[], relativePath: string | string[]): void;
+            /**
+             * Command to upload a file inside the file upload dialog
+             *
+             * @param {string} relativePath - The relative path of the file to be uploaded.
+             *
+             * @remark - Assuming that 'cypress' is the main folder, the path will usually be 'cypress/YYY/ZZZ/'.
+             */
+            GLO_uploadFileDialog(relativePath: string): void;
+            /**
+             * Command to filter a grid based on a specified column ID.
+             *
+             * @param {string} colId - The column ID (attribute col-id) of the element to be filtered.
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {customValueTypeUndefined} text - The text to filter in the grid.
+             * @param {exactMatchFlag} [exactMatch] - Select exact match (only for dropdown variant of filter) 'equalBool' to enable. Default: disabled.
+             * @param {filterGridTypes} [filterType] - The type of filter to be selected.
+             */
+            GLO_filterGrid(colId: string, selector: string[], text: customValueTypeUndefined, exactMatch?: exactMatchFlag, filterType?: filterGridTypes): void;
+            /**
+             * Command to switch the company from within the application.
+             *
+             * @param {string} companyName - The name of the company to switch to.
+             */
+            GLO_switchCompany(companyName: string): void;
+            /**
+             * Command to switch the role from within the application.
+             *
+             * @param {string} aliasName - The name of the alias to use to save to.
+             */
+            GLO_getRole(aliasName: string): void;
+            /**
+             * Command to validate a value in a grid, based on span values only.
+             *
+             * @param {checkValueInGridType} value - The value to be validated in the grid.
+             * @param {string | number} [rowFilter] - Optional: The row number or span value the row has to have that you want to check a value in.
+             * @param {string} [columnId] - Optional: The culumnId you want to check a value in.
+             * @param {number} [timeOut] - how long it should wait for the field to update, default: 10s
+             * @param {number} [interval] - use this TOGETHER with timeOut for slow-running updates (e.g. batch process) (default: 50ms)
+             * @param {checkOperatorType} [operator='contains'] - Operator used by the function to check the value.
+             */
+            GLO_checkValueGrid(value: checkValueInGridType, rowFilter?: string | number, columnId?: string, timeOut?: number, interval?: number, operator?: checkOperatorType): void;
+            /**
+             * Selects a program based on its name. If multiple programs share the same name,
+             * it selects the last occurrence.
+             *
+             * @param {topBottomType} topBottom - The position of the tab element ('top' for main programs, 'bottom' for subprograms underneath a main program).
+             * @param {String} programName - Name of the program to be selected.
+             * @param {number} [tabNumber] - Optional: if there are multiple visible programs with the same name, the desired tab occurrence can be decided with this parameter.
+             * Sidenote: the tabNumber index starts at zero (0) for the first one.
+             * the tab number of the program to be closed should be defined.
+             * @example - cy.GLO_selectProgram('top', 'ProgramName');
+             */
+            GLO_selectProgram(topBottom: topBottomType, programName: string, tabNumber?: number): void;
+            /**
+             * Get a specific row in a grid based on its row number or span value.
+             *
+             *  @param {string | number} rowFilter - The row number to retrieve.
+             * @returns {Chainable<Element>} Yields the Cypress chainable DOM element representing the row.
+             */
+            GLO_getRowInGrid(rowFilter: string | number): Chainable<JQuery>;
+            /**
+             * Selects a specific row in a grid based on its row number or span value(s).
+             * This command will look for its corresponding checkbox and select it.
+             *
+             * @param {string | string[] | number} rowFilter - The row number to be selected.
+             *
+             */
+            GLO_selectRowInGrid(rowFilter: string | string[] | number): void;
+            /**
+             * Double-clicks on a specific row or span value in a grid, based on the provided type and value.
+             *
+             * @param {clickRowType} type - The type of element to select ('row' for row, 'span' for a span value).
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {customValueTypeUndefined | Array<string>} value - The value or index of the row or the span content to be double-clicked.
+             * @remark In case span is used as a type, an array of spans to dblClick a row that has multiple specific spans in the row can be provided.
+             * @param {string} [columnId] - The columnId identifier to be double-clicked. Required when the middle point of the row is outside the screen. Optional when type is 'row'.
+             * @remark - In other words, if the actual width of a grid (row) is at least 2*visible + 1 pixel, the middle point will be out of bounds.
+             * @param {skipCheckFlag} [skipCheck=false] - Optional: Whether to check for a page change or not after clicking the row.
+             * @param {exactMatchFlag} [equals=false] - Optional: Whether the result needs to contain the search value (false) or be equal to the search value (true).
+             */
+            GLO_dblClickRowInGrid(type: clickRowType, selector: string[], value: customValueTypeUndefined | Array<string>, columnId?: string, skipCheck?: skipCheckFlag, equals?: exactMatchFlag): void;
+            /**
+             * Clicks on a specific row or span value in a grid, based on the provided value.
+             *
+             * @param {string | number} value - The value or index of the row or the span content to be clicked.
+             * @param {string} [columnId] - The columnId identifier to be double-clicked. Required when the middle point of the row is outside the screen.
+             * @remark - In other words, if the actual width of a grid (row) is at least 2*visible + 1 pixel, the middle point will be out of bounds.
+             */
+            GLO_clickRowInGrid(value?: string | number, columnId?: string): void;
+            /**
+             * Opens a popup window by clicking the search glass, performs a search based on provided criteria, and selects a value from the grid.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {customValueTypeUndefined} value - The value to search for within the popup window.
+             * @param {string} [columnId] - The column ID used to filter within the grid.
+             * @param {exactMatchFlag} [equals=false] - Whether the result needs to contain (false) or equal (true) the search value.
+             * @param {searchTypeFlag} [useMagnifierFlag =true] - Whether to type the search value in the input field (false) or use the magnifier (true).
+             */
+            GLO_popupWindow(selector: selectorType, value: customValueTypeUndefined, columnId?: string, equals?: exactMatchFlag, useMagnifierFlag?: searchTypeFlag): void;
+            /**
+             * Command to select a button in the lefternmost Globis navigation bar.
+             *
+             * @param {String} buttonName - Name of the button to click ('home', 'settings', 'excel', 'info', 'refresh', 'users').
+             */
+            GLO_selectMenuButtonLeft(buttonName: selectMenuButtonLeftType): void;
+            /**
+             * Changes the user which is currently logged in by opening the user change dialog,
+             * enters the specified username, and confirms the user change.
+             *
+             * @param {string} username - The username of the user to switch to.
+             */
+            GLO_changeUser(username: string): void;
+            /**
+             * Selects a custom view by clicking the 'Custom views' button in the main program datacontrol bar,
+             * then chooses the specified custom view from the dropdown menu.
+             *
+             * @param {string | string[]} customViewName - The name of the custom view to select.
+             * @param {string} [subMenuName] - Optional: name of the submenu to select.
+             */
+            GLO_selectCustomView(customViewName: string | string[], subMenuName?: string): void;
+            /**
+             * Double clicks a label to open a hyperlink.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {string} labelValue - The value displayed on the label.
+             */
+            GLO_dblClickLabel(selector: string[], labelValue: string): void;
+            /**
+             * Assert the aria-checked state of a checkbox element.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {CheckState} value - Expected state: check for checked, unCheck for unchecked.
+             */
+            GLO_validateCheckbox(selector: string[], value: CheckState): void;
+            /**
+             * Command to check the presence of the AG Grid loader and to wait for it to disappear, ensuring the AG Grid has finished loading.
+             *
+             */
+            GLO_checkAGLoader(): void;
+            /**
+             * Command to log a message into the VSCode terminal and also into the Cypress Test report (Jenkins).
+             *
+             * @param {string} logValue - The value to be logged and added to test context.
+             */
+            GLO_log(logValue: string): void;
+            /**
+             * Command to store the value of an input field.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {string} asValue - Value will be stored as name asValue.
+             * @param {showInCommandLogFlag} [log] - Optional: If true the value will be logged. Default the value will not be logged
+             */
+            GLO_storeValue(selector: string[], asValue: string, log?: showInCommandLogFlag): void;
+            /**
+             * Command to store the value of a grid field.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {number | string} rowFilter - Index or filterValue of the row (eg: if you know one of the cells in the row contains this value, and you want to store a different column value).
+             * @param {number} columnId - ColumnId of the row.
+             * @param {string} asValue - Value will be stored as name asValue.
+             * @param {showInCommandLogFlag} [log] - Optional: If true the value will be logged. Default the value will not be logged
+             */
+            GLO_storeValueGrid(selector: string[], rowFilter: number | string, columnId: string, asValue: string, log?: showInCommandLogFlag): void;
+            /**
+             * Command to validate the number of entries within a specific element.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {number} numberToValidate - The expected number of entries to validate.
+             * @param {string} [lengthCondition] - Optional: Sets whether there is a specific condition for a certain numberToValidate by assertion. Must use 'length' chai assertions.
+             * @param {number} [timeOut] - how long it should wait for the rowcount to update
+             *
+             * Available assertions for lengthCondition:
+             * 'have.length.of.at.most' - Maximum amount of rows for numberToValidate to be allowed
+             * 'have.length.greaterThan' - Amount of rows at minimum to be contained in a grid
+             */
+            GLO_checkNumberOfRowsInGrid(selector: string[], numberToValidate: number, lengthCondition?: string, timeOut?: number): void;
+            /**
+             * Returns the current number of rows in a grid.
+             *
+             * @param {string[]} selector - The selector array [formName, elementName] identifying the grid.
+             * @param {number} [timeOut] - Optional timeout override.
+             */
+            GLO_getNumberOfRowsInGrid(selector: string[], timeOut?: number): Cypress.Chainable<number>;
+            /**
+             * Command to filter a grid based on a specified header name.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {string} headerName - The column header of the element to be filtered.
+             * @param {customValueTypeUndefined} text - The text to filter in the grid.
+             */
+            GLO_filterGridCustomView(selector: string[], headerName: string, text: customValueTypeUndefined): void;
+            /**
+             * Clears the value of a field in a form.
+             *
+             * @param {selectorType} selector - `[name]`, `[form, element]`, or with optional trailing index: `[name, idx]` / `[form, element, idx]`. Trailing number selects the Nth matching element.
+             */
+            GLO_clearField(selector: selectorType): void;
+            /**
+             * Custom Cypress command to read the contents of a file located in the Cypress downloads folder.
+             * The command constructs the file path using the specified file type and file name, then uses the built-in
+             * Cypress `readFile` method to read the file contents.
+             *
+             * @param {FileType} fileType - The type of the file (extension) to read. This should match one of the predefined
+             *                               file types in the `FileType` enumerator, such as 'xlsx', 'pdf', or 'docx'.
+             * @param {string} fileName - The name of the file, without its extension, to read from the downloads folder.
+             *
+             */
+            GLO_readFile(fileName: string, fileType: fileType): void;
+            /**
+             * Command to choose a button in an info/warning/error popup dialog window.
+             * Test will fail when no dialog pops up.
+             *
+             * @param {string} confirmation - The button, based on its text contents, to be clicked in the popup dialog.
+             * @param {string} [title] - Title of the popup.
+             * @param {string} [content] - Content of the popup body to verify.
+             * @param {string} [contentMatchType] - Type of the content match (exact, partial), default: exact.
+             */
+            GLO_dialogRequiredCheck(confirmation: string, title?: string, content?: string, contentMatchType?: matchType): void;
+            /**
+             * Custom Cypress command to select a radio button within a form.
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {string | undefined} selectorName - The name of the radio button option to be selected.
+             *                                            If undefined, no action is taken.
+             */
+            GLO_radioButton(selector: string[], selectorName: string | undefined): void;
+            /**
+             * Command to interact with a checklist based on the provided form name, element name and the radiobutton name.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {string} radioButtonName - The name of the radiobutton.
+             */
+            GLO_radioListCData(selector: string[], radioButtonName: string | JQuery | undefined): void;
+            /**
+             * Command to validate if a radio button is selected or not based on the presence of the dx-radiobutton-icon-dot class.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {string} radioButtonName - The label text of the radio button to validate.
+             * @param {CheckState} expectedState - True if the radio button should be selected, false if not.
+             */
+            GLO_validateRadioListCData(selector: string[], radioButtonName: string, expectedState: CheckState): void;
+            /**
+             * This function will change the current user role to the disred one.
+             * @param {string} userRole - The name of the user role to be selected.
+             */
+            GLO_changeUserRole(userRole: string): void;
+            /**
+             * This command selects rows in a grid based on the provided form name, element name,
+             * and optionally a specific number of rows.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {number} [rowNumber] - Optional: The number of rows to select. If not provided, all rows will be selected.
+             */
+            GLO_selectRows(selector: string[], rowNumber?: number): void;
+            /**
+             * This command clicks on the header span to sort the rows.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {string} headerText - The text of the header span you want to click on.
+             */
+            GLO_sortGrid(selector: string[], headerText: string): void;
+            /**
+             * This command dblclicks on the correct column and row in the grid and fills in the field.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {number | string} rowFilter - Index or filterValue of the row to be filled in.
+             * @param {number} columnId - ColumnId of the row to be filled in.
+             * @param {customValueTypeUndefined} value - Value to be filled in the field
+             * @param {gridInputType} gridInputType - Type of the element that gets exposed, default: gridInput
+             */
+            GLO_fillInfieldInGrid(selector: string[], rowFilter: number | string, columnId: string, value: customValueTypeUndefined, gridInputType?: gridInputType): void;
+            /**
+             * Command to select the FIRST option from a dropdown using its data-cy attribute, which is composed of formName.elementName.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             */
+            GLO_dropdownSelectFirstvalue(selector: string[]): void;
+            /**
+             * Command to store the current record id.
+             *
+             * @param {string} storeValueName - The stored variable name you want to cy.get(@storeValueName) from
+             */
+            GLO_storeCurrentRecordId(storeValueName: string): void;
+            /**
+             * Command to check, in a Globis environment, which company is active, then switches to another requested company if different.
+             *
+             * @param {string} requestedCompanyCode - The company to switch to.
+             */
+            GLO_checkAndSelectCompany(requestedCompanyCode: string): void;
+            /**
+             * This command right clicks in the grid and clicks the 'Select all' option
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             */
+            GLO_selectAllGrid(selector: string[]): void;
+            /**
+             * Command to click a ::before icon button in a grid.
+             * Can be chained off a command that already contains the correct row,
+             * or can be used with the rowFilter parameter to find the correct row.
+             *
+             * @param {string} buttonColumn - The columnId of the button to click.
+             * @param {string | number} rowFilter - Index or span inside of the row.
+             * @param {string} [validationColumn] - Optional, the columnId where a value will change after the button is clicked.
+             * @param {number} [x] - Optional: The x-coordinate of the button to click in %. 0 = leftmost, 100 = rightmost. Default: 10%.
+             * @param {number} [y] - Optional: The y-coordinate of the button to click in %. 0 = topmost, 100 = bottommost. Default: 50%.
+             * @param {Cypress.Chainable<JQuery<HTMLElement>>} [subject] - Optional: When chained, this refers to the previously selected row.
+
+             */
+            GLO_clickButtonInGrid(buttonColumn: string, rowFilter?: string | number, validationColumn?: string, x?: number, y?: number): Chainable<JQuery>;
+            /**
+             * Command to login using Okta, like GLO_oktaLogin, but with the simple addition of a boolean parameter to switch between 2 different accounts.
+             *
+             * This landing page is not the same as the initial portal. It can only be used when switching users after logging out from a Globis environment.
+             *
+             * @param {usernameFlag} [altUser] - Switch to decide whether a secondary (alternateUsername) account has to be logged into or (defaultUsername) the primary account.
+             * @param {string} [company] - Name of a company to switch to after successfully logging in.
+             */
+            GLO_oktaAlternativeLogin(altUser: usernameFlag, company?: string): void;
+            /**
+             * Command to get all rows of a(ll) grids.
+             *
+             * @param {string[]} [selector] - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup. If omitted, returns all visible grid rows.
+             * @param {number} timeOut - how long it should wait for the element to be found, default set in tsHelper.ts
+             * @returns {Chainable<JQuery<HTMLElement>>} - Yields all rows (in a grid or from all grids on screen)
+             */
+            GLO_getAllRowsInGrid(selector?: string[], timeOut?: number): Chainable<JQuery>;
+            /**
+             * Get the current and total record counts from #txtCount.
+             *
+             * @returns {Chainable<{ currentRecord: number; totalRecords: number }>}
+             *
+             * @example
+             *  cy.GLO_getCurrentRecordCount().its('currentRecord').should('eq', 1)
+             *  cy.GLO_getCurrentRecordCount().should(({ currentRecord, totalRecords }) => { ... })
+             */
+            GLO_getCurrentRecordCount(timeOut?: number): Chainable<{
+                currentRecord: number;
+                totalRecords: number;
+            }>;
+            /**
+             * Command to validate a value in a grid, based on span values only.
+             *
+             * @param {string} waitValue - The value to be validated in the grid. Will wait for this value
+             * @param {string} failValue - The value that will stop the waiting and fail instantly.
+             * @param {number} [rowNumber] - Optional: The number of the row you want to check a value in.
+             * @param {string} [columnId] - Optional: The culumnId you want to check a value in.
+             * @param {number} [timeOut] - how long it should wait for the field to update, default: 10m
+             * @param {number} [interval] - use this TOGETHER with timeOut for slow-running updates (e.g. batch process) (default: 15s)
+             */
+            GLO_validateGridOrFail(waitValue: string, failValue: string, rowNumber?: number, columnId?: string, timeOut?: number, interval?: number): void;
+            /**
+             * Store the value(s) of one or more fields into the nested '@saveData' alias:
+             *   saveData[formName][elementName] = value
+             *
+             * In your test you must provide a generic type containing the keys
+             * (element names) you want to store. This enables IntelliSense/autocomplete.
+             *
+             * Usage:
+             *   cy.GLO_storeObject<MyType>('formName', 'myKey')
+             *   cy.GLO_storeObject<MyType>('formName', ['key1', 'key2'])
+             *
+             * @example
+             * type ConsignmentData = {
+             *   local_consignment_order_nr: string;
+             *   load_start_booked: string;
+             * };
+             *
+             * cy.GLO_storeObject<ConsignmentData>('ng$consignmentFormName','local_consignment_order_nr');
+             * cy.GLO_storeObject<ConsignmentData>('ng$consignmentFormName',['local_consignment_order_nr', 'load_start_booked']);
+             *
+             * and retrieve later with:
+             * cy.get<SaveData<ConsignmentData>>('@saveData').then((saveData) => {
+             *   const orderNr = saveData['ng$consignmentFormName'].local_consignment_order_nr;
+             *
+             * @param formName - formname
+             * @param elementNames - Key(s) of the provided generic type (for IntelliSense)
+             * @param {number} [index] - Optional index when saving the same field multiple times in a test
+             * @param {showInCommandLogFlag} [log] - Show value in cypress command log
+             */
+            GLO_storeObject<T extends Record<string, string>>(formName: string, elementName: keyof T | ReadonlyArray<keyof T>, index?: number, log?: showInCommandLogFlag): void;
+            /**
+             * Checks if a field is in an invalid state (has dx-invalid class).
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {validityFlag} [shouldBeInvalid=true] - Whether the field should be invalid (true) or valid (false).
+             */
+            GLO_checkFieldInvalid(selector: string[], shouldBeInvalid?: validityFlag): void;
+            /**
+             * Checks if a field is enabled or disabled.
+             *
+             * @param {string[]} selector - One element: `[name=]` lookup. Two elements: `[data-cy$="form.element"]` lookup.
+             * @param {disabledFlag} [shouldBeEnabled=true] - Whether the field should be enabled (true) or disabled (false).
+             */
+            GLO_checkFieldEnabled(selector: string[], shouldBeEnabled?: disabledFlag): void;
+            /**
+             * Checks if a field has the given background color class applied to its input element.
+             *
+             * @param {[string, string | string[]]} selector - `[formName, elementName]` or `[formName, [f1, f2, ...]]` to check multiple fields.
+             * @param {'red' | 'orange' | 'yellow' | 'green'} color - The background color class to check (default: 'red').
+             */
+            GLO_checkFieldBgColor(selector: [string, string | string[]], color?: 'red' | 'orange' | 'yellow' | 'green'): void;
+            /**
+             * Builds and executes an Extended Filter query through the Extended Filter Builder UI.
+             *             *
+             * Notes:
+             * - Filter structure is provided as a tree of nodes (`Leaf`, `Group`, `Nested group`) via `filterParams.filter`.
+             * - Fully typed so when building the filter object in the test, IntelliSense will guide you with accepted properties and value types.
+             *
+             * This command is expected to evolve: it should already cover most use cases for filter building,
+             * but in case you need a specific filter configuration that is not yet supported, feel free to contribute or reach out to the team to get it implemented.
+             *
+             * @param {extendedFilterType} filter - Settings describing the filter tree to apply.
+             * @param {Flag<'clearExistingFilters'>} [clearExistingFilters] - If provided, existing filter clauses are cleared before applying the new filter and running the query.
+             */
+            GLO_extendedFilter(filter: extendedFilterType, clearExistingFilters?: Flag<'clearExistingFilters'>): void;
+            /**
+             * Command to apply a named/saved search from the datacontrol extended-search dropdown.
+             * These are the saved filter definitions shown when clicking the extended search button in a program's list.
+             * (e.g. 'MUs available for load' on the consignment parts list). Not to be confused with dashboard filters.
+             *
+             * @param {string} searchName - The exact (case-sensitive) name of the named search to apply.
+             *
+             * @example - cy.GLO_selectNamedSearch('MUs available for load');
+             */
+            GLO_selectNamedSearch(searchName: string): void;
+        }
+    }
+}
+export declare const clickButtonTextHelper: (textButton: string, buttonContainer: string) => void;
+export {};