@oracle/oraclejet-webdriver 11.1.0 → 12.0.1

package/elements/oj-tag-cloud/OjTagCloudBase.ts

@@ -1,4 +1,4 @@
-import {OjWebElement} from "../";
+import { OjWebElement } from '../';
 
 /**
  * This is the base class for OjTagCloud, and is generated from
@@ -9,330 +9,327 @@ import {OjWebElement} from "../";
  */
 export class OjTagCloudBase extends OjWebElement {
   /**
-   * Gets the value of animationOnDataChange property.
+   * Gets the value of <code>animationOnDataChange</code> property.
    * Specifies the animation that is applied on data changes.
-   * @return The value of animationOnDataChange property.
+   * @return The value of <code>animationOnDataChange</code> property.
    * 
    */
   public getAnimationOnDataChange(): Promise<string> {
-    return this.getProperty<string>("animationOnDataChange");
+    return this.getProperty<string>('animationOnDataChange');
   }
 
   /**
-   * Gets the value of animationOnDisplay property.
+   * Gets the value of <code>animationOnDisplay</code> property.
    * Specifies the animation that is shown on initial display.
-   * @return The value of animationOnDisplay property.
+   * @return The value of <code>animationOnDisplay</code> property.
    * 
    */
   public getAnimationOnDisplay(): Promise<string> {
-    return this.getProperty<string>("animationOnDisplay");
+    return this.getProperty<string>('animationOnDisplay');
   }
 
   /**
-   * Gets the value of as property.
+   * Gets the value of <code>as</code> property.
    * An alias for the '$current' context variable passed to slot content for the itemTemplate slot.
-   * @return The value of as property.
+   * @return The value of <code>as</code> property.
    * @deprecated Since 6.2.0. Set the alias directly on the template element using the data-oj-as attribute instead.
    */
   public getAs(): Promise<string> {
-    return this.getProperty<string>("as");
+    return this.getProperty<string>('as');
   }
 
   /**
-   * Gets the value of data property.
+   * Gets the value of <code>data</code> property.
    * Specifies the DataProvider for the tag cloud. See the Help documentation for more information.
-   * @return The value of data property.
+   * @return The value of <code>data</code> property.
    * @deprecated Since 11.0.0. Data sets from a DataProvider cannot be sent to WebDriverJS; use ViewModels or page variables instead.
    */
   public getData(): Promise<object|null> {
-    return this.getProperty<object|null>("data");
+    return this.getProperty<object|null>('data');
   }
 
   /**
-   * Sets the value of "hiddenCategories" property.
+   * Sets the value of <code>hiddenCategories</code> property.
    * An array of category strings used for category filtering. Data items with a category in hiddenCategories will be filtered.
-   * @param hiddenCategories The value to set for "hiddenCategories"
+   * @param hiddenCategories The value to set for <code>hiddenCategories</code>
    * 
    */
   public changeHiddenCategories(hiddenCategories: Array<string>): Promise<void> {
-    return this.setProperty<Array<string>>("hiddenCategories", hiddenCategories);
+    return this.setProperty<Array<string>>('hiddenCategories', hiddenCategories);
   }
 
   /**
-   * Gets the value of hiddenCategories property.
+   * Gets the value of <code>hiddenCategories</code> property.
    * An array of category strings used for category filtering. Data items with a category in hiddenCategories will be filtered.
-   * @return The value of hiddenCategories property.
+   * @return The value of <code>hiddenCategories</code> property.
    * 
    */
   public getHiddenCategories(): Promise<Array<string>> {
-    return this.getProperty<Array<string>>("hiddenCategories");
+    return this.getProperty<Array<string>>('hiddenCategories');
   }
 
   /**
-   * Gets the value of highlightMatch property.
+   * Gets the value of <code>highlightMatch</code> property.
    * The matching condition for the highlightedCategories property. See the Help documentation for more information.
-   * @return The value of highlightMatch property.
+   * @return The value of <code>highlightMatch</code> property.
    * 
    */
   public getHighlightMatch(): Promise<string> {
-    return this.getProperty<string>("highlightMatch");
+    return this.getProperty<string>('highlightMatch');
   }
 
   /**
-   * Sets the value of "highlightedCategories" property.
+   * Sets the value of <code>highlightedCategories</code> property.
    * An array of category strings used for highlighting. Data items matching categories in this array will be highlighted.
-   * @param highlightedCategories The value to set for "highlightedCategories"
+   * @param highlightedCategories The value to set for <code>highlightedCategories</code>
    * 
    */
   public changeHighlightedCategories(highlightedCategories: Array<string>): Promise<void> {
-    return this.setProperty<Array<string>>("highlightedCategories", highlightedCategories);
+    return this.setProperty<Array<string>>('highlightedCategories', highlightedCategories);
   }
 
   /**
-   * Gets the value of highlightedCategories property.
+   * Gets the value of <code>highlightedCategories</code> property.
    * An array of category strings used for highlighting. Data items matching categories in this array will be highlighted.
-   * @return The value of highlightedCategories property.
+   * @return The value of <code>highlightedCategories</code> property.
    * 
    */
   public getHighlightedCategories(): Promise<Array<string>> {
-    return this.getProperty<Array<string>>("highlightedCategories");
+    return this.getProperty<Array<string>>('highlightedCategories');
   }
 
   /**
-   * Gets the value of hoverBehavior property.
+   * Gets the value of <code>hoverBehavior</code> property.
    * Defines the behavior applied when hovering over data items.
-   * @return The value of hoverBehavior property.
+   * @return The value of <code>hoverBehavior</code> property.
    * 
    */
   public getHoverBehavior(): Promise<string> {
-    return this.getProperty<string>("hoverBehavior");
+    return this.getProperty<string>('hoverBehavior');
   }
 
   /**
-   * Gets the value of items property.
+   * Gets the value of <code>items</code> property.
    * An array of objects defining the data items for the tag cloud items. Also accepts a Promise for deferred data rendering.
-   * @return The value of items property.
+   * @return The value of <code>items</code> property.
    * 
    */
-  public getItems(): Promise<Array<OjTagCloudBase.Items>|null|null> {
-    return this.getProperty<Array<OjTagCloudBase.Items>|null|null>("items");
+  public getItems(): Promise<Array<Items>|null|null> {
+    return this.getProperty<Array<Items>|null|null>('items');
   }
 
   /**
-   * Gets the value of layout property.
+   * Gets the value of <code>layout</code> property.
    * The layout to use for tag display.
-   * @return The value of layout property.
+   * @return The value of <code>layout</code> property.
    * 
    */
   public getLayout(): Promise<string> {
-    return this.getProperty<string>("layout");
+    return this.getProperty<string>('layout');
   }
 
   /**
-   * Sets the value of "selection" property.
+   * Sets the value of <code>selection</code> property.
    * An array containing the ids of the initially selected data items.
-   * @param selection The value to set for "selection"
+   * @param selection The value to set for <code>selection</code>
    * 
    */
   public changeSelection(selection: Array<any>): Promise<void> {
-    return this.setProperty<Array<any>>("selection", selection);
+    return this.setProperty<Array<any>>('selection', selection);
   }
 
   /**
-   * Gets the value of selection property.
+   * Gets the value of <code>selection</code> property.
    * An array containing the ids of the initially selected data items.
-   * @return The value of selection property.
+   * @return The value of <code>selection</code> property.
    * 
    */
   public getSelection(): Promise<Array<any>> {
-    return this.getProperty<Array<any>>("selection");
+    return this.getProperty<Array<any>>('selection');
   }
 
   /**
-   * Gets the value of selectionMode property.
+   * Gets the value of <code>selectionMode</code> property.
    * Specifies the selection mode.
-   * @return The value of selectionMode property.
+   * @return The value of <code>selectionMode</code> property.
    * 
    */
   public getSelectionMode(): Promise<string> {
-    return this.getProperty<string>("selectionMode");
+    return this.getProperty<string>('selectionMode');
   }
 
   /**
-   * Gets the value of styleDefaults property.
+   * Gets the value of <code>styleDefaults</code> property.
    * An object defining the style defaults for this tag cloud.
-   * @return The value of styleDefaults property.
+   * @return The value of <code>styleDefaults</code> property.
    * 
    */
-  public getStyleDefaults(): Promise<OjTagCloudBase.StyleDefaults> {
-    return this.getProperty<OjTagCloudBase.StyleDefaults>("styleDefaults");
+  public getStyleDefaults(): Promise<StyleDefaults> {
+    return this.getProperty<StyleDefaults>('styleDefaults');
   }
 
   /**
-   * Gets the value of tooltip property.
+   * Gets the value of <code>tooltip</code> property.
    * An object containing an optional callback function for tooltip customization.
-   * @return The value of tooltip property.
+   * @return The value of <code>tooltip</code> property.
    * 
    */
-  public getTooltip(): Promise<OjTagCloudBase.Tooltip> {
-    return this.getProperty<OjTagCloudBase.Tooltip>("tooltip");
+  public getTooltip(): Promise<Tooltip> {
+    return this.getProperty<Tooltip>('tooltip');
   }
 
   /**
-   * Gets the value of touchResponse property.
+   * Gets the value of <code>touchResponse</code> property.
    * Specifies configuration options for touch and hold delays on mobile devices. See the Help documentation for more information.
-   * @return The value of touchResponse property.
+   * @return The value of <code>touchResponse</code> property.
    * 
    */
   public getTouchResponse(): Promise<string> {
-    return this.getProperty<string>("touchResponse");
+    return this.getProperty<string>('touchResponse');
   }
 
   /**
-   * Gets the value of trackResize property.
+   * Gets the value of <code>trackResize</code> property.
    * Defines whether the element will automatically render in response to changes in size. See the Help documentation for more information.
-   * @return The value of trackResize property.
+   * @return The value of <code>trackResize</code> property.
    * 
    */
   public getTrackResize(): Promise<string> {
-    return this.getProperty<string>("trackResize");
+    return this.getProperty<string>('trackResize');
   }
 
   /**
-   * 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<OjTagCloudBase.Translations|null> {
-    return this.getProperty<OjTagCloudBase.Translations|null>("translations");
+  public getTranslations(): Promise<Translations|null> {
+    return this.getProperty<Translations|null>('translations');
   }
 
 }
-
-namespace OjTagCloudBase {
-  export interface Items {
-    /**
-     * An array of category strings corresponding to the tag cloud items. This allows highlighting and filtering of items.
-     */
-    "categories": Array<string>;
-    /**
-     * The color of the text. Will be overridden by any color defined in the style option. The default value comes from the CSS and varies based on theme.
-     */
-    "color": string;
-    /**
-     * The item id should be set by the application if the DataProvider is not being used. The row key will be used as id in the DataProvider case.
-     */
-    "id": any;
-    /**
-     * The text of the item.
-     */
-    "label": string;
-    /**
-     * The description of the item. This is used for customizing the tooltip text.
-     */
-    "shortDesc": string|null;
-    /**
-     * The CSS style class defining the style of the item text.
-     */
-    "svgClassName": string;
-    /**
-     * The CSS style object defining the style of the item text. Only SVG CSS style properties are supported. The default value comes from the CSS and varies based on theme.
-     */
-    "svgStyle": object;
-    /**
-     * The url this item references.
-     */
-    "url": string;
-    /**
-     * The value of this item which will be used to scale its font-size within the tag cloud.
-     */
-    "value": number;
-  }
-  export interface StyleDefaults {
-    /**
-     * The duration of the animations in milliseconds.
-     */
-    "animationDuration": number;
-    /**
-     * Specifies initial hover delay in milliseconds for highlighting data items.
-     */
-    "hoverBehaviorDelay": number;
-    /**
-     * The CSS style object defining the style of the items.
-     */
-    "svgStyle": object;
-  }
-  export interface Tooltip {
-  }
-  export interface Translations {
-    /**
-     * Used to describe the data visualization type for accessibility.
-     */
-    "componentName": string;
-    /**
-     * Used to display a label and its value.
-     */
-    "labelAndValue": string;
-    /**
-     * Text shown for clearing multiple selection on touch devices.
-     */
-    "labelClearSelection": string;
-    /**
-     * Used to display a count out of a total.
-     */
-    "labelCountWithTotal": string;
-    /**
-     * Label for data visualizations used for accessibility.
-     */
-    "labelDataVisualization": string;
-    /**
-     * Text shown when the component receives invalid data.
-     */
-    "labelInvalidData": string;
-    /**
-     * Text shown when the component receives no data.
-     */
-    "labelNoData": string;
-    /**
-     * Used to describe the collapsed state for accessibility.
-     */
-    "stateCollapsed": string;
-    /**
-     * Used to describe a drillable object for accessibility.
-     */
-    "stateDrillable": string;
-    /**
-     * Used to describe the expanded state for accessibility.
-     */
-    "stateExpanded": string;
-    /**
-     * Used to describe the hidden state for accessibility.
-     */
-    "stateHidden": string;
-    /**
-     * Used to describe the isolated state for accessibility.
-     */
-    "stateIsolated": string;
-    /**
-     * Used to describe the maximized state for accessibility.
-     */
-    "stateMaximized": string;
-    /**
-     * Used to describe the minimized state for accessibility.
-     */
-    "stateMinimized": string;
-    /**
-     * Used to describe the selected state for accessibility.
-     */
-    "stateSelected": string;
-    /**
-     * Used to describe the unselected state for accessibility.
-     */
-    "stateUnselected": string;
-    /**
-     * Used to describe the visible state for accessibility.
-     */
-    "stateVisible": string;
-  }
+export interface Items {
+  /**
+   * An array of category strings corresponding to the tag cloud items. This allows highlighting and filtering of items.
+   */
+  "categories": Array<string>;
+  /**
+   * The color of the text. Will be overridden by any color defined in the style option. The default value comes from the CSS and varies based on theme.
+   */
+  "color": string;
+  /**
+   * The item id should be set by the application if the DataProvider is not being used. The row key will be used as id in the DataProvider case.
+   */
+  "id": any;
+  /**
+   * The text of the item.
+   */
+  "label": string;
+  /**
+   * The description of the item. This is used for customizing the tooltip text.
+   */
+  "shortDesc": string|null;
+  /**
+   * The CSS style class defining the style of the item text.
+   */
+  "svgClassName": string;
+  /**
+   * The CSS style object defining the style of the item text. Only SVG CSS style properties are supported. The default value comes from the CSS and varies based on theme.
+   */
+  "svgStyle": object;
+  /**
+   * The url this item references.
+   */
+  "url": string;
+  /**
+   * The value of this item which will be used to scale its font-size within the tag cloud.
+   */
+  "value": number;
+}
+export interface StyleDefaults {
+  /**
+   * The duration of the animations in milliseconds.
+   */
+  "animationDuration": number;
+  /**
+   * Specifies initial hover delay in milliseconds for highlighting data items.
+   */
+  "hoverBehaviorDelay": number;
+  /**
+   * The CSS style object defining the style of the items.
+   */
+  "svgStyle": object;
+}
+export interface Tooltip {
+}
+export interface Translations {
+  /**
+   * Used to describe the data visualization type for accessibility.
+   */
+  "componentName": string;
+  /**
+   * Used to display a label and its value.
+   */
+  "labelAndValue": string;
+  /**
+   * Text shown for clearing multiple selection on touch devices.
+   */
+  "labelClearSelection": string;
+  /**
+   * Used to display a count out of a total.
+   */
+  "labelCountWithTotal": string;
+  /**
+   * Label for data visualizations used for accessibility.
+   */
+  "labelDataVisualization": string;
+  /**
+   * Text shown when the component receives invalid data.
+   */
+  "labelInvalidData": string;
+  /**
+   * Text shown when the component receives no data.
+   */
+  "labelNoData": string;
+  /**
+   * Used to describe the collapsed state for accessibility.
+   */
+  "stateCollapsed": string;
+  /**
+   * Used to describe a drillable object for accessibility.
+   */
+  "stateDrillable": string;
+  /**
+   * Used to describe the expanded state for accessibility.
+   */
+  "stateExpanded": string;
+  /**
+   * Used to describe the hidden state for accessibility.
+   */
+  "stateHidden": string;
+  /**
+   * Used to describe the isolated state for accessibility.
+   */
+  "stateIsolated": string;
+  /**
+   * Used to describe the maximized state for accessibility.
+   */
+  "stateMaximized": string;
+  /**
+   * Used to describe the minimized state for accessibility.
+   */
+  "stateMinimized": string;
+  /**
+   * Used to describe the selected state for accessibility.
+   */
+  "stateSelected": string;
+  /**
+   * Used to describe the unselected state for accessibility.
+   */
+  "stateUnselected": string;
+  /**
+   * Used to describe the visible state for accessibility.
+   */
+  "stateVisible": string;
 }

package/elements/oj-tag-cloud/index.js

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

package/elements/oj-tag-cloud/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AACA,8BAAoD;AACpD,6CAA0C;AACjC,2FADA,uBAAU,OACA;AAaZ,KAAK,UAAU,UAAU,CAAC,MAAkB,EAAE,EAAM;IACzD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAE3C,IAAI,CAAC,CAAC,KAAK,YAAY,uBAAU,CAAC,EAAE;QAClC,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;QACzC,MAAM,KAAK,CAAC,YAAY,EAAE,gBAAgB,OAAO,gCAAgC,CAAC,CAAC;KACpF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AARD,gCAQC;AAED,YAAQ,CAAC,cAAc,EAAE,uBAAU,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AACA,8BAA8C;AAC9C,6CAA0C;AACjC,2FADA,uBAAU,OACA;AAcZ,KAAK,UAAU,UAAU,CAAC,MAAkB,EAAE,EAAM;IACzD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAE3C,IAAI,CAAC,CAAC,KAAK,YAAY,uBAAU,CAAC,EAAE;QAClC,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;QACzC,MAAM,KAAK,CAAC,cAAc,EAAE,YAAY,KAAK,CAAC,WAAW,CAAC,IAAI,SAAS,OAAO,mBAAmB,uBAAU,CAAC,IAAI,EAAE,CAAC,CAAC;KACrH;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AARD,gCAQC;AAED,YAAQ,CAAC,cAAc,EAAE,uBAAU,CAAC,CAAC"}

package/elements/oj-tag-cloud/index.ts

@@ -1,27 +1,28 @@
-import { By } from "selenium-webdriver";
-import ojwd, { DriverLike, register } from "../../";
-import { OjTagCloud } from "./OjTagCloud";
+import { By } from 'selenium-webdriver';
+import { DriverLike, register } from '../../';
+import { OjTagCloud } from './OjTagCloud';
 export { OjTagCloud };
 
 /**
- * Create an instance of [[OjTagCloud]].  This function will first wait for
- * the element to appear in the DOM before trying to locate it.
+ * Retrieve an instance of [[OjTagCloud]].
  * @example
- * <code>
- * const el = await ojTagCloud(driver, By.id('my-oj-tag-cloud'))
- * </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 { ojTagCloud } from '@oracle/oraclejet-webdriver/elements';
+ * const el = await ojTagCloud(driver, By.id('my-oj-tag-cloud'));
+ * ```
+ * @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 ojTagCloud(driver: DriverLike, by: By): Promise<OjTagCloud> {
   const webEl = await driver.findElement(by);
   // Check that the element is of type OjTagCloud
   if (!(webEl instanceof OjTagCloud)) {
     const tagName = await webEl.getTagName();
-    throw Error(`Locator '${by}' located a <${tagName}>, but expected <oj-tag-cloud>`);
+    throw Error(`ojTagCloud(${by}) create ${webEl.constructor.name} for <${tagName}>, but expected ${OjTagCloud.name}`);
   }
   return webEl;
 }
 
-register("oj-tag-cloud", OjTagCloud);
+register('oj-tag-cloud', OjTagCloud);

package/elements/oj-text-area/OjTextArea.js.map

@@ -1 +1 @@
-{"version":3,"file":"OjTextArea.js","sourceRoot":"","sources":["OjTextArea.ts"],"names":[],"mappings":";;;AAAA,qDAAgD;AAEhD,uDAAyD;AASzD,MAAa,UAAW,SAAQ,+BAAc;CAC7C;AADD,gCACC;AACD,8BAAgB,CAAC,UAAU,CAAC,CAAC"}
+{"version":3,"file":"OjTextArea.js","sourceRoot":"","sources":["OjTextArea.ts"],"names":[],"mappings":";;;AAAA,qDAAgD;AAEhD,uDAAyD;AAOzD,MAAa,UAAW,SAAQ,+BAAc;CAC7C;AADD,gCACC;AACD,8BAAgB,CAAC,UAAU,CAAC,CAAC"}

package/elements/oj-text-area/OjTextArea.ts

@@ -3,11 +3,9 @@ import { By } from "selenium-webdriver";
 import { mixinChangeValue } from "../../lib/input-utils";
 
 /**
- * This is the component WebElement for oj-text-area. Retrieve an instance of the class
- * using its convenience function:
- * ```javascript
- * await ojTextArea(driver, By.css('oj-text-area'))
- * ```
+ * The component WebElement for [oj-text-area](../../jsdocs/oj.ojTextArea.html).
+ * Do not instantiate this class directly, instead, use
+ * [ojTextArea](../modules/elements.html#ojTextArea).
  */
 export class OjTextArea extends OjTextAreaBase {
 }