codeceptjs 4.0.0-beta.2 → 4.0.0-beta.21

package/lib/locator.js

@@ -1,13 +1,11 @@
-import { sprintf } from 'sprintf-js';
+import { sprintf } from 'sprintf-js'
+import { xpathLocator } from './utils.js'
+import { createRequire } from 'module'
 
-import csstoxpath from 'csstoxpath';
+const require = createRequire(import.meta.url)
+let cssToXPath
 
-import css_to_xpath from 'css-to-xpath';
-import { xpathLocator } from './utils.js';
-
-let cssToXPath;
-
-const locatorTypes = ['css', 'by', 'xpath', 'id', 'name', 'fuzzy', 'frame', 'shadow', 'pw'];
+const locatorTypes = ['css', 'by', 'xpath', 'id', 'name', 'fuzzy', 'frame', 'shadow', 'pw', 'role']
 /** @class */
 class Locator {
   /**
@@ -15,162 +13,171 @@ class Locator {
    * @param {string} [defaultType]
    */
   constructor(locator, defaultType = '') {
-    this.type = null;
-    if (!locator) return;
+    this.type = null
+    if (!locator) return
 
-    this.output = null;
+    this.output = null
 
     /**
      * @private
      * @type {boolean}
      */
-    this.strict = false;
+    this.strict = false
 
     if (typeof locator === 'object') {
       if (locator.constructor.name === 'Locator') {
-        Object.assign(this, locator);
-        return;
+        Object.assign(this, locator)
+        return
       }
 
-      this.locator = locator;
-      this.type = Object.keys(locator)[0];
-      this.value = locator[this.type];
-      this.strict = true;
+      this.locator = locator
+      this.type = Object.keys(locator)[0]
+      this.value = locator[this.type]
+      this.strict = true
 
-      Locator.filters.forEach(f => f(locator, this));
+      Locator.filters.forEach(f => f(locator, this))
 
-      return;
+      return
     }
 
-    this.type = defaultType || 'fuzzy';
-    this.output = locator;
-    this.value = locator;
+    this.type = defaultType || 'fuzzy'
+    this.output = locator
+    this.value = locator
 
     if (isCSS(locator)) {
-      this.type = 'css';
+      this.type = 'css'
     }
     if (isXPath(locator)) {
-      this.type = 'xpath';
+      this.type = 'xpath'
     }
     if (isShadow(locator)) {
-      this.type = 'shadow';
+      this.type = 'shadow'
     }
     if (isPlaywrightLocator(locator)) {
-      this.type = 'pw';
+      this.type = 'pw'
     }
 
-    Locator.filters.forEach(f => f(locator, this));
+    Locator.filters.forEach(f => f(locator, this))
   }
 
   simplify() {
-    if (this.isNull()) return null;
+    if (this.isNull()) return null
     switch (this.type) {
       case 'by':
       case 'xpath':
-        return this.value;
+        return this.value
       case 'css':
-        return this.value;
+        return this.value
       case 'id':
-        return `#${this.value}`;
+        return `#${this.value}`
       case 'name':
-        return `[name="${this.value}"]`;
+        return `[name="${this.value}"]`
       case 'fuzzy':
-        return this.value;
+        return this.value
       case 'shadow':
-        return { shadow: this.value };
+        return { shadow: this.value }
       case 'pw':
-        return { pw: this.value };
+        return { pw: this.value }
+      case 'role':
+        return `[role="${this.value}"]`
     }
-    return this.value;
+    return this.value
   }
 
   toStrict() {
-    if (!this.type) return null;
-    return { [this.type]: this.value };
+    if (!this.type) return null
+    return { [this.type]: this.value }
   }
 
   /**
    * @returns {string}
    */
   toString() {
-    return this.output || `{${this.type}: ${this.value}}`;
+    return this.output || `{${this.type}: ${this.value}}`
   }
 
   /**
    * @returns {boolean}
    */
   isFuzzy() {
-    return this.type === 'fuzzy';
+    return this.type === 'fuzzy'
   }
 
   /**
    * @returns {boolean}
    */
   isShadow() {
-    return this.type === 'shadow';
+    return this.type === 'shadow'
   }
 
   /**
    * @returns {boolean}
    */
   isFrame() {
-    return this.type === 'frame';
+    return this.type === 'frame'
   }
 
   /**
    * @returns {boolean}
    */
   isCSS() {
-    return this.type === 'css';
+    return this.type === 'css'
   }
 
   /**
    * @returns {boolean}
    */
   isPlaywrightLocator() {
-    return this.type === 'pw';
+    return this.type === 'pw'
+  }
+
+  /**
+   * @returns {boolean}
+   */
+  isRole() {
+    return this.type === 'role'
   }
 
   /**
    * @returns {boolean}
    */
   isNull() {
-    return this.type === null;
+    return this.type === null
   }
 
   /**
    * @returns {boolean}
    */
   isXPath() {
-    return this.type === 'xpath';
+    return this.type === 'xpath'
   }
 
   /**
    * @returns {boolean}
    */
   isCustom() {
-    return !!this.type && !locatorTypes.includes(this.type);
+    return !!this.type && !locatorTypes.includes(this.type)
   }
 
   /**
    * @returns {boolean}
    */
   isStrict() {
-    return this.strict;
+    return this.strict
   }
 
   /**
    * @returns {boolean}
    */
   isAccessibilityId() {
-    return this.isFuzzy() && this.value[0] === '~';
+    return this.isFuzzy() && this.value[0] === '~'
   }
 
   /**
    * @returns {boolean}
    */
   isBasic() {
-    return this.isCSS() || this.isXPath();
+    return this.isCSS() || this.isXPath()
   }
 
   /**
@@ -178,19 +185,19 @@ class Locator {
    * @returns {string}
    */
   toXPath(pseudoSelector = '') {
-    const locator = `${this.value}${pseudoSelector}`;
-    const limitation = [':nth-of-type', ':first-of-type', ':last-of-type', ':nth-last-child', ':nth-last-of-type', ':checked', ':disabled', ':enabled', ':required', ':lang', ':nth-child', ':has'];
+    const locator = `${this.value}${pseudoSelector}`
+    const limitation = [':nth-of-type', ':first-of-type', ':last-of-type', ':nth-last-child', ':nth-last-of-type', ':checked', ':disabled', ':enabled', ':required', ':lang', ':nth-child', ':has']
 
     if (limitation.some(item => locator.includes(item))) {
-      cssToXPath = css_to_xpath;
+      cssToXPath = require('css-to-xpath')
     } else {
-      cssToXPath = csstoxpath;
+      cssToXPath = require('csstoxpath')
     }
 
-    if (this.isXPath()) return this.value;
-    if (this.isCSS()) return cssToXPath(locator);
+    if (this.isXPath()) return this.value
+    if (this.isCSS()) return cssToXPath(locator)
 
-    throw new Error('Can\'t be converted to XPath');
+    throw new Error("Can't be converted to XPath")
   }
 
   // DSL
@@ -199,11 +206,8 @@ class Locator {
    * @returns {Locator}
    */
   or(locator) {
-    const xpath = xpathLocator.combine([
-      this.toXPath(),
-      (new Locator(locator, 'css')).toXPath(),
-    ]);
-    return new Locator({ xpath });
+    const xpath = xpathLocator.combine([this.toXPath(), new Locator(locator, 'css').toXPath()])
+    return new Locator({ xpath })
   }
 
   /**
@@ -211,8 +215,8 @@ class Locator {
    * @returns {Locator}
    */
   find(locator) {
-    const xpath = sprintf('%s//%s', this.toXPath(), convertToSubSelector(locator));
-    return new Locator({ xpath });
+    const xpath = sprintf('%s//%s', this.toXPath(), convertToSubSelector(locator))
+    return new Locator({ xpath })
   }
 
   /**
@@ -220,8 +224,8 @@ class Locator {
    * @returns {Locator}
    */
   withChild(locator) {
-    const xpath = sprintf('%s[./child::%s]', this.toXPath(), convertToSubSelector(locator));
-    return new Locator({ xpath });
+    const xpath = sprintf('%s[./child::%s]', this.toXPath(), convertToSubSelector(locator))
+    return new Locator({ xpath })
   }
 
   /**
@@ -229,8 +233,8 @@ class Locator {
    * @returns {Locator}
    */
   withDescendant(locator) {
-    const xpath = sprintf('%s[./descendant::%s]', this.toXPath(), convertToSubSelector(locator));
-    return new Locator({ xpath });
+    const xpath = sprintf('%s[./descendant::%s]', this.toXPath(), convertToSubSelector(locator))
+    return new Locator({ xpath })
   }
 
   /**
@@ -239,33 +243,33 @@ class Locator {
    */
   at(position) {
     if (position === 0) {
-      throw new Error('0 is not valid element position. XPath expects first element to have index 1');
+      throw new Error('0 is not valid element position. XPath expects first element to have index 1')
     }
 
-    let xpathPosition;
+    let xpathPosition
 
     if (position > 0) {
-      xpathPosition = position.toString();
+      xpathPosition = position.toString()
     } else {
       // -1 points to the last element
-      xpathPosition = `last()-${Math.abs(position + 1)}`;
+      xpathPosition = `last()-${Math.abs(position + 1)}`
     }
-    const xpath = sprintf('(%s)[position()=%s]', this.toXPath(), xpathPosition);
-    return new Locator({ xpath });
+    const xpath = sprintf('(%s)[position()=%s]', this.toXPath(), xpathPosition)
+    return new Locator({ xpath })
   }
 
   /**
    * @returns {Locator}
    */
   first() {
-    return this.at(1);
+    return this.at(1)
   }
 
   /**
    * @returns {Locator}
    */
   last() {
-    return this.at(-1);
+    return this.at(-1)
   }
 
   /**
@@ -274,9 +278,9 @@ class Locator {
    * @returns {Locator}
    */
   withText(text) {
-    text = xpathLocator.literal(text);
-    const xpath = sprintf('%s[%s]', this.toXPath(), `contains(., ${text})`);
-    return new Locator({ xpath });
+    text = xpathLocator.literal(text)
+    const xpath = sprintf('%s[%s]', this.toXPath(), `contains(., ${text})`)
+    return new Locator({ xpath })
   }
 
   /**
@@ -285,9 +289,9 @@ class Locator {
    * @returns {Locator}
    */
   withTextEquals(text) {
-    text = xpathLocator.literal(text);
-    const xpath = sprintf('%s[%s]', this.toXPath(), `.= ${text}`);
-    return new Locator({ xpath });
+    text = xpathLocator.literal(text)
+    const xpath = sprintf('%s[%s]', this.toXPath(), `.= ${text}`)
+    return new Locator({ xpath })
   }
 
   /**
@@ -295,55 +299,54 @@ class Locator {
    * @returns {Locator}
    */
   withAttr(attributes) {
-    const operands = [];
+    const operands = []
     for (const attr of Object.keys(attributes)) {
-      operands.push(`@${attr} = ${xpathLocator.literal(attributes[attr])}`);
+      operands.push(`@${attr} = ${xpathLocator.literal(attributes[attr])}`)
     }
-    const xpath = sprintf('%s[%s]', this.toXPath(), operands.join(' and '));
-    return new Locator({ xpath });
+    const xpath = sprintf('%s[%s]', this.toXPath(), operands.join(' and '))
+    return new Locator({ xpath })
   }
 
   /**
-     * Adds condition: attribute value starts with text
-     * (analog of XPATH: [starts-with(@attr,'startValue')] or CSS [attr^='startValue']
-     * Example: I.click(locate('a').withAttrStartsWith('href', 'https://')));
-     * Works with any attribute: class, href etc.
-     * @param {string} attrName
-     * @param {string} startsWith
-     * @returns {Locator}
-    */
+   * Adds condition: attribute value starts with text
+   * (analog of XPATH: [starts-with(@attr,'startValue')] or CSS [attr^='startValue']
+   * Example: I.click(locate('a').withAttrStartsWith('href', 'https://')));
+   * Works with any attribute: class, href etc.
+   * @param {string} attrName
+   * @param {string} startsWith
+   * @returns {Locator}
+   */
   withAttrStartsWith(attrName, startsWith) {
-    const xpath = sprintf('%s[%s]', this.toXPath(), `starts-with(@${attrName}, "${startsWith}")`);
-    return new Locator({ xpath });
+    const xpath = sprintf('%s[%s]', this.toXPath(), `starts-with(@${attrName}, "${startsWith}")`)
+    return new Locator({ xpath })
   }
 
   /**
-    * Adds condition: attribute value ends with text
-    * (analog of XPATH: [ends-with(@attr,'endValue')] or CSS [attr$='endValue']
-    * Example: I.click(locate('a').withAttrEndsWith('href', '.com')));
-    * Works with any attribute: class, href etc.
-    * @param {string} attrName
-    * @param {string} endsWith
-    * @returns {Locator}
-  */
+   * Adds condition: attribute value ends with text
+   * (analog of XPATH: [ends-with(@attr,'endValue')] or CSS [attr$='endValue']
+   * Example: I.click(locate('a').withAttrEndsWith('href', '.com')));
+   * Works with any attribute: class, href etc.
+   * @param {string} attrName
+   * @param {string} endsWith
+   * @returns {Locator}
+   */
   withAttrEndsWith(attrName, endsWith) {
-    const xpath = sprintf('%s[%s]', this.toXPath(), `substring(@${attrName}, string-length(@${attrName}) - string-length("${endsWith}") + 1) = "${endsWith}"`,
-    );
-    return new Locator({ xpath });
+    const xpath = sprintf('%s[%s]', this.toXPath(), `substring(@${attrName}, string-length(@${attrName}) - string-length("${endsWith}") + 1) = "${endsWith}"`)
+    return new Locator({ xpath })
   }
 
   /**
-     * Adds condition: attribute value contains text
-     * (analog of XPATH: [contains(@attr,'partOfAttribute')] or CSS [attr*='partOfAttribute']
-     * Example: I.click(locate('a').withAttrContains('href', 'google')));
-     * Works with any attribute: class, href etc.
-     * @param {string} attrName
-     * @param {string} partOfAttrValue
-     * @returns {Locator}
-     */
+   * Adds condition: attribute value contains text
+   * (analog of XPATH: [contains(@attr,'partOfAttribute')] or CSS [attr*='partOfAttribute']
+   * Example: I.click(locate('a').withAttrContains('href', 'google')));
+   * Works with any attribute: class, href etc.
+   * @param {string} attrName
+   * @param {string} partOfAttrValue
+   * @returns {Locator}
+   */
   withAttrContains(attrName, partOfAttrValue) {
-    const xpath = sprintf('%s[%s]', this.toXPath(), `contains(@${attrName}, "${partOfAttrValue}")`);
-    return new Locator({ xpath });
+    const xpath = sprintf('%s[%s]', this.toXPath(), `contains(@${attrName}, "${partOfAttrValue}")`)
+    return new Locator({ xpath })
   }
 
   /**
@@ -351,8 +354,8 @@ class Locator {
    * @returns {Locator}
    */
   withClassAttr(text) {
-    const xpath = sprintf('%s[%s]', this.toXPath(), `contains(@class, '${text}')`);
-    return new Locator({ xpath });
+    const xpath = sprintf('%s[%s]', this.toXPath(), `contains(@class, '${text}')`)
+    return new Locator({ xpath })
   }
 
   /**
@@ -360,8 +363,8 @@ class Locator {
    * @returns {Locator}
    */
   as(output) {
-    this.output = output;
-    return this;
+    this.output = output
+    return this
   }
 
   /**
@@ -369,8 +372,8 @@ class Locator {
    * @returns {Locator}
    */
   inside(locator) {
-    const xpath = sprintf('%s[ancestor::%s]', this.toXPath(), convertToSubSelector(locator));
-    return new Locator({ xpath });
+    const xpath = sprintf('%s[ancestor::%s]', this.toXPath(), convertToSubSelector(locator))
+    return new Locator({ xpath })
   }
 
   /**
@@ -378,8 +381,8 @@ class Locator {
    * @returns {Locator}
    */
   after(locator) {
-    const xpath = sprintf('%s[preceding-sibling::%s]', this.toXPath(), convertToSubSelector(locator));
-    return new Locator({ xpath });
+    const xpath = sprintf('%s[preceding-sibling::%s]', this.toXPath(), convertToSubSelector(locator))
+    return new Locator({ xpath })
   }
 
   /**
@@ -387,90 +390,95 @@ class Locator {
    * @returns {Locator}
    */
   before(locator) {
-    const xpath = sprintf('%s[following-sibling::%s]', this.toXPath(), convertToSubSelector(locator));
-    return new Locator({ xpath });
+    const xpath = sprintf('%s[following-sibling::%s]', this.toXPath(), convertToSubSelector(locator))
+    return new Locator({ xpath })
   }
 }
 
 /**
- * @param {CodeceptJS.LocatorOrString} locator
+ * @param {CodeceptJS.LocatorOrString} [locator]
  * @returns {Locator}
  */
-Locator.build = (locator) => {
-  if (!locator) return new Locator({ xpath: '//*' });
-  return new Locator(locator, 'css');
-};
+Locator.build = locator => {
+  if (!locator) return new Locator({ xpath: '//*' })
+  return new Locator(locator, 'css')
+}
 
 /**
  * Filters to modify locators
  * @type {Array<function(CodeceptJS.LocatorOrString, Locator): void>}
  */
-Locator.filters = [];
+Locator.filters = []
 
 /**
  * Appends new `Locator` filter to an `Locator.filters` array, and returns the new length of the array.
  * @param {function(CodeceptJS.LocatorOrString, Locator): void} fn
  * @returns {number}
  */
-Locator.addFilter = fn => Locator.filters.push(fn);
+Locator.addFilter = fn => Locator.filters.push(fn)
 
 Locator.clickable = {
   /**
    * @param {string} literal
    * @returns {string}
    */
-  narrow: literal => xpathLocator.combine([
-    `.//a[normalize-space(.)=${literal}]`,
-    `.//button[normalize-space(.)=${literal}]`,
-    `.//a/img[normalize-space(@alt)=${literal}]/ancestor::a`,
-    `.//input[./@type = 'submit' or ./@type = 'image' or ./@type = 'button'][normalize-space(@value)=${literal}]`,
-  ]),
+  narrow: literal =>
+    xpathLocator.combine([
+      `.//a[normalize-space(.)=${literal}]`,
+      `.//button[normalize-space(.)=${literal}]`,
+      `.//a/img[normalize-space(@alt)=${literal}]/ancestor::a`,
+      `.//input[./@type = 'submit' or ./@type = 'image' or ./@type = 'button'][normalize-space(@value)=${literal}]`,
+    ]),
 
   /**
    * @param {string} literal
    * @returns {string}
    */
-  wide: literal => xpathLocator.combine([
-    `.//a[./@href][((contains(normalize-space(string(.)), ${literal})) or .//img[contains(./@alt, ${literal})])]`,
-    `.//input[./@type = 'submit' or ./@type = 'image' or ./@type = 'button'][contains(./@value, ${literal})]`,
-    `.//input[./@type = 'image'][contains(./@alt, ${literal})]`,
-    `.//button[contains(normalize-space(string(.)), ${literal})]`,
-    `.//label[contains(normalize-space(string(.)), ${literal})]`,
-    `.//input[./@type = 'submit' or ./@type = 'image' or ./@type = 'button'][./@name = ${literal}]`,
-    `.//button[./@name = ${literal}]`,
-    `.//*[@aria-label = ${literal}]`,
-    `.//*[@title = ${literal}]`,
-    `.//*[@aria-labelledby = //*[@id][normalize-space(string(.)) = ${literal}]/@id ]`,
-  ]),
+  wide: literal =>
+    xpathLocator.combine([
+      `.//a[./@href][((contains(normalize-space(string(.)), ${literal})) or .//img[contains(./@alt, ${literal})])]`,
+      `.//input[./@type = 'submit' or ./@type = 'image' or ./@type = 'button'][contains(./@value, ${literal})]`,
+      `.//input[./@type = 'image'][contains(./@alt, ${literal})]`,
+      `.//button[contains(normalize-space(string(.)), ${literal})]`,
+      `.//label[contains(normalize-space(string(.)), ${literal})]`,
+      `.//input[./@type = 'submit' or ./@type = 'image' or ./@type = 'button'][./@name = ${literal}]`,
+      `.//button[./@name = ${literal}]`,
+      `.//*[@aria-label = ${literal}]`,
+      `.//*[@title = ${literal}]`,
+      `.//*[@aria-labelledby = //*[@id][normalize-space(string(.)) = ${literal}]/@id ]`,
+      `.//*[@role='button'][normalize-space(.)=${literal}]`,
+    ]),
 
   /**
    * @param {string} literal
    * @returns {string}
    */
   self: literal => `./self::*[contains(normalize-space(string(.)), ${literal}) or contains(normalize-space(@value), ${literal})]`,
-};
+}
 
 Locator.field = {
   /**
    * @param {string} literal
    * @returns {string}
    */
-  labelEquals: literal => xpathLocator.combine([
-    `.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')][((./@name = ${literal}) or ./@id = //label[@for][normalize-space(string(.)) = ${literal}]/@for or ./@placeholder = ${literal})]`,
-    `.//label[normalize-space(string(.)) = ${literal}]//.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')]`,
-  ]),
+  labelEquals: literal =>
+    xpathLocator.combine([
+      `.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')][((./@name = ${literal}) or ./@id = //label[@for][normalize-space(string(.)) = ${literal}]/@for or ./@placeholder = ${literal})]`,
+      `.//label[normalize-space(string(.)) = ${literal}]//.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')]`,
+    ]),
 
   /**
    * @param {string} literal
    * @returns {string}
    */
-  labelContains: literal => xpathLocator.combine([
-    `.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')][(((./@name = ${literal}) or ./@id = //label[@for][contains(normalize-space(string(.)), ${literal})]/@for) or ./@placeholder = ${literal})]`,
-    `.//label[contains(normalize-space(string(.)), ${literal})]//.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')]`,
-    `.//*[@aria-label = ${literal}]`,
-    `.//*[@title = ${literal}]`,
-    `.//*[@aria-labelledby = //*[@id][normalize-space(string(.)) = ${literal}]/@id ]`,
-  ]),
+  labelContains: literal =>
+    xpathLocator.combine([
+      `.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')][(((./@name = ${literal}) or ./@id = //label[@for][contains(normalize-space(string(.)), ${literal})]/@for) or ./@placeholder = ${literal})]`,
+      `.//label[contains(normalize-space(string(.)), ${literal})]//.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')]`,
+      `.//*[@aria-label = ${literal}]`,
+      `.//*[@title = ${literal}]`,
+      `.//*[@aria-labelledby = //*[@id][normalize-space(string(.)) = ${literal}]/@id ]`,
+    ]),
 
   /**
    * @param {string} literal
@@ -482,51 +490,52 @@ Locator.field = {
    * @param {string} literal
    * @returns {string}
    */
-  byText: literal => xpathLocator.combine([
-    `.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')][(((./@name = ${literal}) or ./@id = //label[@for][contains(normalize-space(string(.)), ${literal})]/@for) or ./@placeholder = ${literal})]`,
-    `.//label[contains(normalize-space(string(.)), ${literal})]//.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')]`,
-  ]),
-
-};
+  byText: literal =>
+    xpathLocator.combine([
+      `.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')][(((./@name = ${literal}) or ./@id = //label[@for][contains(normalize-space(string(.)), ${literal})]/@for) or ./@placeholder = ${literal})]`,
+      `.//label[contains(normalize-space(string(.)), ${literal})]//.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')]`,
+    ]),
+}
 
 Locator.checkable = {
   /**
    * @param {string} literal
    * @returns {string}
    */
-  byText: literal => xpathLocator.combine([
-    `.//input[@type = 'checkbox' or @type = 'radio'][(@id = //label[@for][contains(normalize-space(string(.)), ${literal})]/@for) or @placeholder = ${literal}]`,
-    `.//label[contains(normalize-space(string(.)), ${literal})]//input[@type = 'radio' or @type = 'checkbox']`,
-  ]),
+  byText: literal =>
+    xpathLocator.combine([
+      `.//input[@type = 'checkbox' or @type = 'radio'][(@id = //label[@for][contains(normalize-space(string(.)), ${literal})]/@for) or @placeholder = ${literal}]`,
+      `.//label[contains(normalize-space(string(.)), ${literal})]//input[@type = 'radio' or @type = 'checkbox']`,
+    ]),
 
   /**
    * @param {string} literal
    * @returns {string}
    */
   byName: literal => `.//input[@type = 'checkbox' or @type = 'radio'][@name = ${literal}]`,
-};
+}
 
 Locator.select = {
   /**
    * @param {string} opt
    * @returns {string}
    */
-  byVisibleText: (opt) => {
-    const normalized = `[normalize-space(.) = ${opt.trim()}]`;
-    return `./option${normalized}|./optgroup/option${normalized}`;
+  byVisibleText: opt => {
+    const normalized = `[normalize-space(.) = ${opt.trim()}]`
+    return `./option${normalized}|./optgroup/option${normalized}`
   },
 
   /**
    * @param {string} opt
    * @returns {string}
    */
-  byValue: (opt) => {
-    const normalized = `[normalize-space(@value) = ${opt.trim()}]`;
-    return `./option${normalized}|./optgroup/option${normalized}`;
+  byValue: opt => {
+    const normalized = `[normalize-space(@value) = ${opt.trim()}]`
+    return `./option${normalized}|./optgroup/option${normalized}`
   },
-};
+}
 
-export default Locator;
+export default Locator
 
 /**
  * @private
@@ -536,7 +545,7 @@ export default Locator;
  * @returns {boolean}
  */
 function isCSS(locator) {
-  return locator[0] === '#' || locator[0] === '.' || locator[0] === '[';
+  return locator[0] === '#' || locator[0] === '.' || locator[0] === '['
 }
 
 /**
@@ -547,8 +556,8 @@ function isCSS(locator) {
  * @returns {boolean}
  */
 function isXPath(locator) {
-  const trimmed = locator.replace(/^\(+/, '').substr(0, 2);
-  return trimmed === '//' || trimmed === './';
+  const trimmed = locator.replace(/^\(+/, '').substr(0, 2)
+  return trimmed === '//' || trimmed === './'
 }
 
 /**
@@ -565,8 +574,8 @@ function isXPath(locator) {
  * @returns {boolean}
  */
 function isShadow(locator) {
-  const hasShadowProperty = (locator.shadow !== undefined) && (Object.keys(locator).length === 1);
-  return hasShadowProperty;
+  const hasShadowProperty = locator.shadow !== undefined && Object.keys(locator).length === 1
+  return hasShadowProperty
 }
 
 /**
@@ -576,7 +585,7 @@ function isShadow(locator) {
  * @returns {boolean}
  */
 function isXPathStartingWithRoundBrackets(xpath) {
-  return isXPath(xpath) && xpath[0] === '(';
+  return isXPath(xpath) && xpath[0] === '('
 }
 
 /**
@@ -586,8 +595,7 @@ function isXPathStartingWithRoundBrackets(xpath) {
  * @returns {string}
  */
 function removePrefix(xpath) {
-  return xpath
-    .replace(/^(\.|\/)+/, '');
+  return xpath.replace(/^(\.|\/)+/, '')
 }
 
 /**
@@ -597,7 +605,17 @@ function removePrefix(xpath) {
  * @returns {boolean}
  */
 function isPlaywrightLocator(locator) {
-  return locator.includes('_react') || locator.includes('_vue');
+  return locator.includes('_react') || locator.includes('_vue')
+}
+
+/**
+ * @private
+ * check if the locator is a role locator
+ * @param {{role: string}} locator
+ * @returns {boolean}
+ */
+function isRoleLocator(locator) {
+  return locator.role !== undefined && typeof locator.role === 'string' && Object.keys(locator).length >= 1
 }
 
 /**
@@ -606,10 +624,9 @@ function isPlaywrightLocator(locator) {
  * @returns {string}
  */
 function convertToSubSelector(locator) {
-  const xpath = (new Locator(locator, 'css')).toXPath();
+  const xpath = new Locator(locator, 'css').toXPath()
   if (isXPathStartingWithRoundBrackets(xpath)) {
-    throw new Error('XPath with round brackets is not possible here! '
-      + 'May be a nested locator with at() last() or first() causes this error.');
+    throw new Error('XPath with round brackets is not possible here! ' + 'May be a nested locator with at() last() or first() causes this error.')
   }
-  return removePrefix(xpath);
+  return removePrefix(xpath)
 }