@oracle/oraclejet-webdriver 11.1.6 → 12.0.2

package/elements/oj-paging-control/OjPagingControlBase.js

@@ -4,25 +4,25 @@ exports.OjPagingControlBase = void 0;
 const __1 = require("../");
 class OjPagingControlBase extends __1.OjWebElement {
     getData() {
-        return this.getProperty("data");
+        return this.getProperty('data');
     }
     getLoadMoreOptions() {
-        return this.getProperty("loadMoreOptions");
+        return this.getProperty('loadMoreOptions');
     }
     getMode() {
-        return this.getProperty("mode");
+        return this.getProperty('mode');
     }
     getOverflow() {
-        return this.getProperty("overflow");
+        return this.getProperty('overflow');
     }
     getPageOptions() {
-        return this.getProperty("pageOptions");
+        return this.getProperty('pageOptions');
     }
     getPageSize() {
-        return this.getProperty("pageSize");
+        return this.getProperty('pageSize');
     }
     getTranslations() {
-        return this.getProperty("translations");
+        return this.getProperty('translations');
     }
 }
 exports.OjPagingControlBase = OjPagingControlBase;

package/elements/oj-paging-control/OjPagingControlBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"OjPagingControlBase.js","sourceRoot":"","sources":["OjPagingControlBase.ts"],"names":[],"mappings":";;;AAAA,2BAAiC;AASjC,MAAa,mBAAoB,SAAQ,gBAAY;IAO5C,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,CAAS,MAAM,CAAC,CAAC;IAC1C,CAAC;IAQM,kBAAkB;QACvB,OAAO,IAAI,CAAC,WAAW,CAAsC,iBAAiB,CAAC,CAAC;IAClF,CAAC;IAQM,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,CAAS,MAAM,CAAC,CAAC;IAC1C,CAAC;IAQM,WAAW;QAChB,OAAO,IAAI,CAAC,WAAW,CAAS,UAAU,CAAC,CAAC;IAC9C,CAAC;IAQM,cAAc;QACnB,OAAO,IAAI,CAAC,WAAW,CAAkC,aAAa,CAAC,CAAC;IAC1E,CAAC;IAQM,WAAW;QAChB,OAAO,IAAI,CAAC,WAAW,CAAS,UAAU,CAAC,CAAC;IAC9C,CAAC;IAQM,eAAe;QACpB,OAAO,IAAI,CAAC,WAAW,CAAwC,cAAc,CAAC,CAAC;IACjF,CAAC;CAEF;AAvED,kDAuEC"}
+{"version":3,"file":"OjPagingControlBase.js","sourceRoot":"","sources":["OjPagingControlBase.ts"],"names":[],"mappings":";;;AAAA,2BAAmC;AASnC,MAAa,mBAAoB,SAAQ,gBAAY;IAO5C,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,CAAS,MAAM,CAAC,CAAC;IAC1C,CAAC;IAQM,kBAAkB;QACvB,OAAO,IAAI,CAAC,WAAW,CAAkB,iBAAiB,CAAC,CAAC;IAC9D,CAAC;IAQM,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,CAAS,MAAM,CAAC,CAAC;IAC1C,CAAC;IAQM,WAAW;QAChB,OAAO,IAAI,CAAC,WAAW,CAAS,UAAU,CAAC,CAAC;IAC9C,CAAC;IAQM,cAAc;QACnB,OAAO,IAAI,CAAC,WAAW,CAAc,aAAa,CAAC,CAAC;IACtD,CAAC;IAQM,WAAW;QAChB,OAAO,IAAI,CAAC,WAAW,CAAS,UAAU,CAAC,CAAC;IAC9C,CAAC;IAQM,eAAe;QACpB,OAAO,IAAI,CAAC,WAAW,CAAoB,cAAc,CAAC,CAAC;IAC7D,CAAC;CAEF;AAvED,kDAuEC"}

package/elements/oj-paging-control/OjPagingControlBase.ts

@@ -1,4 +1,4 @@
-import {OjWebElement} from "../";
+import { OjWebElement } from '../';
 
 /**
  * This is the base class for OjPagingControl, and is generated from
@@ -9,234 +9,231 @@ import {OjWebElement} from "../";
  */
 export class OjPagingControlBase extends OjWebElement {
   /**
-   * Gets the value of data property.
+   * Gets the value of <code>data</code> property.
    * Specifies the data bound to the Paging Control. See the Help documentation for more information.
-   * @return The value of data property.
+   * @return The value of <code>data</code> property.
    * 
    */
   public getData(): Promise<object> {
-    return this.getProperty<object>("data");
+    return this.getProperty<object>('data');
   }
 
   /**
-   * Gets the value of loadMoreOptions property.
+   * Gets the value of <code>loadMoreOptions</code> property.
    * Options for loadMore mode.
-   * @return The value of loadMoreOptions property.
+   * @return The value of <code>loadMoreOptions</code> property.
    * @deprecated Since 7.0.0. This option is deprecated and will not get feature updates or support going forward. Please use native component high-water mark scrolling API instead (see Table, ListView, DataGrid). In addition, "loadMore" is not compatible with Table, Listview, DataGrid default scroll-policy "loadMoreOnScroll".
    */
-  public getLoadMoreOptions(): Promise<OjPagingControlBase.LoadMoreOptions> {
-    return this.getProperty<OjPagingControlBase.LoadMoreOptions>("loadMoreOptions");
+  public getLoadMoreOptions(): Promise<LoadMoreOptions> {
+    return this.getProperty<LoadMoreOptions>('loadMoreOptions');
   }
 
   /**
-   * Gets the value of mode property.
+   * Gets the value of <code>mode</code> property.
    * Specifies the paging mode.
-   * @return The value of mode property.
+   * @return The value of <code>mode</code> property.
    * 
    */
   public getMode(): Promise<string> {
-    return this.getProperty<string>("mode");
+    return this.getProperty<string>('mode');
   }
 
   /**
-   * Gets the value of overflow property.
+   * Gets the value of <code>overflow</code> property.
    * Specifies the options for when the Paging Control width is too narrow.
-   * @return The value of overflow property.
+   * @return The value of <code>overflow</code> property.
    * 
    */
   public getOverflow(): Promise<string> {
-    return this.getProperty<string>("overflow");
+    return this.getProperty<string>('overflow');
   }
 
   /**
-   * Gets the value of pageOptions property.
+   * Gets the value of <code>pageOptions</code> property.
    * Options for page mode.
-   * @return The value of pageOptions property.
+   * @return The value of <code>pageOptions</code> property.
    * 
    */
-  public getPageOptions(): Promise<OjPagingControlBase.PageOptions> {
-    return this.getProperty<OjPagingControlBase.PageOptions>("pageOptions");
+  public getPageOptions(): Promise<PageOptions> {
+    return this.getProperty<PageOptions>('pageOptions');
   }
 
   /**
-   * Gets the value of pageSize property.
+   * Gets the value of <code>pageSize</code> property.
    * Page size.
-   * @return The value of pageSize property.
+   * @return The value of <code>pageSize</code> property.
    * 
    */
   public getPageSize(): Promise<number> {
-    return this.getProperty<number>("pageSize");
+    return this.getProperty<number>('pageSize');
   }
 
   /**
-   * Gets the value of translations property.
+   * Gets the value of <code>translations</code> property.
    * A collection of translated resources from the translation bundle, or null if this component has no resources.
-   * @return The value of translations property.
+   * @return The value of <code>translations</code> property.
    * 
    */
-  public getTranslations(): Promise<OjPagingControlBase.Translations|null> {
-    return this.getProperty<OjPagingControlBase.Translations|null>("translations");
+  public getTranslations(): Promise<Translations|null> {
+    return this.getProperty<Translations|null>('translations');
   }
 
 }
-
-namespace OjPagingControlBase {
-  export interface LoadMoreOptions {
-    /**
-     * The maximum number of items to display.
-     */
-    "maxCount": number;
-  }
-  export interface PageOptions {
-    /**
-     * An array of values specifying the navigation controls to display for numeric page links.
-     */
-    "layout": Array<string>;
-    /**
-     * Specifies the maximum number of numeric page links to display.
-     */
-    "maxPageLinks": number;
-    /**
-     * Specifies the orientation of the page links.
-     */
-    "orientation": string;
-    /**
-     * Specifies the type of page links.
-     */
-    "type": string;
-  }
-  export interface Translations {
-    /**
-     * Singe item page index text.
-     */
-    "fullMsgItem": string;
-    /**
-     * Single item page index text for approximate number of items.
-     */
-    "fullMsgItemApprox": string;
-    /**
-     * Single item page index text for minimum number of items.
-     */
-    "fullMsgItemAtLeast": string;
-    /**
-     * Item range page index text.
-     */
-    "fullMsgItemRange": string;
-    /**
-     * Item range page index text for approximate number of items.
-     */
-    "fullMsgItemRangeApprox": string;
-    /**
-     * Item range page index text for minimum number of items.
-     */
-    "fullMsgItemRangeAtLeast": string;
-    /**
-     * First page label for screen readers.
-     */
-    "labelAccNavFirstPage": string;
-    /**
-     * Last page label for screen readers.
-     */
-    "labelAccNavLastPage": string;
-    /**
-     * Next page label for screen readers.
-     */
-    "labelAccNavNextPage": string;
-    /**
-     * Current page label for screen readers.
-     */
-    "labelAccNavPage": string;
-    /**
-     * Previous page label for screen readers.
-     */
-    "labelAccNavPreviousPage": string;
-    /**
-     * Paging control page number label for screen readers.
-     */
-    "labelAccPageNumber": string;
-    /**
-     * Paging control label for screen readers.
-     */
-    "labelAccPaging": string;
-    /**
-     * Load more link text.
-     */
-    "labelLoadMore": string;
-    /**
-     * Label for when load more has reached the maximum limit of rows to fetch.
-     */
-    "labelLoadMoreMaxRows": string;
-    /**
-     * Current page label.
-     */
-    "labelNavInputPage": string;
-    /**
-     * Maximum page label.
-     */
-    "labelNavInputPageMax": string;
-    /**
-     * Invalid max page links value error.
-     */
-    "maxPageLinksInvalid": string;
-    /**
-     * Single item page index text when no total number of items is available.
-     */
-    "msgItemNoTotal": string;
-    /**
-     * Item range text for known row count.
-     */
-    "msgItemRangeCurrent": string;
-    /**
-     * Item range text for single page range.
-     */
-    "msgItemRangeCurrentSingle": string;
-    /**
-     * Item range "items" text.
-     */
-    "msgItemRangeItems": string;
-    /**
-     * Item range page index text when no total number of items is available.
-     */
-    "msgItemRangeNoTotal": string;
-    /**
-     * Item range "of" text.
-     */
-    "msgItemRangeOf": string;
-    /**
-     * Item range of "approx" text.
-     */
-    "msgItemRangeOfApprox": string;
-    /**
-     * Item range of "at least" text.
-     */
-    "msgItemRangeOfAtLeast": string;
-    /**
-     * Invalid page error.
-     */
-    "pageInvalid": string;
-    /**
-     * First page button tip.
-     */
-    "tipNavFirstPage": string;
-    /**
-     * Current page tip.
-     */
-    "tipNavInputPage": string;
-    /**
-     * Last page button tip.
-     */
-    "tipNavLastPage": string;
-    /**
-     * Next page button tip.
-     */
-    "tipNavNextPage": string;
-    /**
-     * Current page link tip.
-     */
-    "tipNavPageLink": string;
-    /**
-     * Previous page button tip.
-     */
-    "tipNavPreviousPage": string;
-  }
+export interface LoadMoreOptions {
+  /**
+   * The maximum number of items to display.
+   */
+  "maxCount": number;
+}
+export interface PageOptions {
+  /**
+   * An array of values specifying the navigation controls to display for numeric page links.
+   */
+  "layout": Array<string>;
+  /**
+   * Specifies the maximum number of numeric page links to display.
+   */
+  "maxPageLinks": number;
+  /**
+   * Specifies the orientation of the page links.
+   */
+  "orientation": string;
+  /**
+   * Specifies the type of page links.
+   */
+  "type": string;
+}
+export interface Translations {
+  /**
+   * Singe item page index text.
+   */
+  "fullMsgItem": string;
+  /**
+   * Single item page index text for approximate number of items.
+   */
+  "fullMsgItemApprox": string;
+  /**
+   * Single item page index text for minimum number of items.
+   */
+  "fullMsgItemAtLeast": string;
+  /**
+   * Item range page index text.
+   */
+  "fullMsgItemRange": string;
+  /**
+   * Item range page index text for approximate number of items.
+   */
+  "fullMsgItemRangeApprox": string;
+  /**
+   * Item range page index text for minimum number of items.
+   */
+  "fullMsgItemRangeAtLeast": string;
+  /**
+   * First page label for screen readers.
+   */
+  "labelAccNavFirstPage": string;
+  /**
+   * Last page label for screen readers.
+   */
+  "labelAccNavLastPage": string;
+  /**
+   * Next page label for screen readers.
+   */
+  "labelAccNavNextPage": string;
+  /**
+   * Current page label for screen readers.
+   */
+  "labelAccNavPage": string;
+  /**
+   * Previous page label for screen readers.
+   */
+  "labelAccNavPreviousPage": string;
+  /**
+   * Paging control page number label for screen readers.
+   */
+  "labelAccPageNumber": string;
+  /**
+   * Paging control label for screen readers.
+   */
+  "labelAccPaging": string;
+  /**
+   * Load more link text.
+   */
+  "labelLoadMore": string;
+  /**
+   * Label for when load more has reached the maximum limit of rows to fetch.
+   */
+  "labelLoadMoreMaxRows": string;
+  /**
+   * Current page label.
+   */
+  "labelNavInputPage": string;
+  /**
+   * Maximum page label.
+   */
+  "labelNavInputPageMax": string;
+  /**
+   * Invalid max page links value error.
+   */
+  "maxPageLinksInvalid": string;
+  /**
+   * Single item page index text when no total number of items is available.
+   */
+  "msgItemNoTotal": string;
+  /**
+   * Item range text for known row count.
+   */
+  "msgItemRangeCurrent": string;
+  /**
+   * Item range text for single page range.
+   */
+  "msgItemRangeCurrentSingle": string;
+  /**
+   * Item range "items" text.
+   */
+  "msgItemRangeItems": string;
+  /**
+   * Item range page index text when no total number of items is available.
+   */
+  "msgItemRangeNoTotal": string;
+  /**
+   * Item range "of" text.
+   */
+  "msgItemRangeOf": string;
+  /**
+   * Item range of "approx" text.
+   */
+  "msgItemRangeOfApprox": string;
+  /**
+   * Item range of "at least" text.
+   */
+  "msgItemRangeOfAtLeast": string;
+  /**
+   * Invalid page error.
+   */
+  "pageInvalid": string;
+  /**
+   * First page button tip.
+   */
+  "tipNavFirstPage": string;
+  /**
+   * Current page tip.
+   */
+  "tipNavInputPage": string;
+  /**
+   * Last page button tip.
+   */
+  "tipNavLastPage": string;
+  /**
+   * Next page button tip.
+   */
+  "tipNavNextPage": string;
+  /**
+   * Current page link tip.
+   */
+  "tipNavPageLink": string;
+  /**
+   * Previous page button tip.
+   */
+  "tipNavPreviousPage": string;
 }

package/elements/oj-paging-control/index.js

@@ -8,10 +8,10 @@ async function ojPagingControl(driver, by) {
     const webEl = await driver.findElement(by);
     if (!(webEl instanceof OjPagingControl_1.OjPagingControl)) {
         const tagName = await webEl.getTagName();
-        throw Error(`Locator '${by}' located a <${tagName}>, but expected <oj-paging-control>`);
+        throw Error(`ojPagingControl(${by}) create ${webEl.constructor.name} for <${tagName}>, but expected ${OjPagingControl_1.OjPagingControl.name}`);
     }
     return webEl;
 }
 exports.ojPagingControl = ojPagingControl;
-__1.register("oj-paging-control", OjPagingControl_1.OjPagingControl);
+__1.register('oj-paging-control', OjPagingControl_1.OjPagingControl);
 //# sourceMappingURL=index.js.map

package/elements/oj-paging-control/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AACA,8BAAoD;AACpD,uDAAoD;AAC3C,gGADA,iCAAe,OACA;AAajB,KAAK,UAAU,eAAe,CAAC,MAAkB,EAAE,EAAM;IAC9D,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAE3C,IAAI,CAAC,CAAC,KAAK,YAAY,iCAAe,CAAC,EAAE;QACvC,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;QACzC,MAAM,KAAK,CAAC,YAAY,EAAE,gBAAgB,OAAO,qCAAqC,CAAC,CAAC;KACzF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AARD,0CAQC;AAED,YAAQ,CAAC,mBAAmB,EAAE,iCAAe,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AACA,8BAA8C;AAC9C,uDAAoD;AAC3C,gGADA,iCAAe,OACA;AAcjB,KAAK,UAAU,eAAe,CAAC,MAAkB,EAAE,EAAM;IAC9D,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAE3C,IAAI,CAAC,CAAC,KAAK,YAAY,iCAAe,CAAC,EAAE;QACvC,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;QACzC,MAAM,KAAK,CAAC,mBAAmB,EAAE,YAAY,KAAK,CAAC,WAAW,CAAC,IAAI,SAAS,OAAO,mBAAmB,iCAAe,CAAC,IAAI,EAAE,CAAC,CAAC;KAC/H;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AARD,0CAQC;AAED,YAAQ,CAAC,mBAAmB,EAAE,iCAAe,CAAC,CAAC"}

package/elements/oj-paging-control/index.ts

@@ -1,27 +1,28 @@
-import { By } from "selenium-webdriver";
-import ojwd, { DriverLike, register } from "../../";
-import { OjPagingControl } from "./OjPagingControl";
+import { By } from 'selenium-webdriver';
+import { DriverLike, register } from '../../';
+import { OjPagingControl } from './OjPagingControl';
 export { OjPagingControl };
 
 /**
- * Create an instance of [[OjPagingControl]].  This function will first wait for
- * the element to appear in the DOM before trying to locate it.
+ * Retrieve an instance of [[OjPagingControl]].
  * @example
- * <code>
- * const el = await ojPagingControl(driver, By.id('my-oj-paging-control'))
- * </code>
- * @param driver A WebDriver/WebElement instance used to locate the component
- * element.
- * @param by The By locator with which to find the element
+ * ```javascript
+ * import { ojPagingControl } from '@oracle/oraclejet-webdriver/elements';
+ * const el = await ojPagingControl(driver, By.id('my-oj-paging-control'));
+ * ```
+ * @param driver A WebDriver/WebElement instance from where the element will be
+ * searched. If WebDriver is passed, the element will be searched globally in the
+ * document. If WebElement is passed, the search will be relative to this element.
+ * @param by The locator with which to find the element
  */
 export async function ojPagingControl(driver: DriverLike, by: By): Promise<OjPagingControl> {
   const webEl = await driver.findElement(by);
   // Check that the element is of type OjPagingControl
   if (!(webEl instanceof OjPagingControl)) {
     const tagName = await webEl.getTagName();
-    throw Error(`Locator '${by}' located a <${tagName}>, but expected <oj-paging-control>`);
+    throw Error(`ojPagingControl(${by}) create ${webEl.constructor.name} for <${tagName}>, but expected ${OjPagingControl.name}`);
   }
   return webEl;
 }
 
-register("oj-paging-control", OjPagingControl);
+register('oj-paging-control', OjPagingControl);

package/elements/oj-picto-chart/OjPictoChart.js.map

@@ -1 +1 @@
-{"version":3,"file":"OjPictoChart.js","sourceRoot":"","sources":["OjPictoChart.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AASpD,MAAa,YAAa,SAAQ,mCAAgB;CAEjD;AAFD,oCAEC"}
+{"version":3,"file":"OjPictoChart.js","sourceRoot":"","sources":["OjPictoChart.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAOpD,MAAa,YAAa,SAAQ,mCAAgB;CAEjD;AAFD,oCAEC"}

package/elements/oj-picto-chart/OjPictoChart.ts

@@ -1,11 +1,9 @@
 import {OjPictoChartBase} from "./OjPictoChartBase";
 
 /**
- * This is the component WebElement for oj-picto-chart. Retrieve an instance of the class
- * using its convenience function:
- * ```javascript
- * await ojPictoChart(driver, By.css('oj-picto-chart'))
- * ```
+ * The component WebElement for [oj-picto-chart](../../jsdocs/oj.ojPictoChart.html).
+ * Do not instantiate this class directly, instead, use
+ * [ojPictoChart](../modules/elements.html#ojPictoChart).
  */
 export class OjPictoChart extends OjPictoChartBase {
   // Put overrides here