@oracle/oraclejet-webdriver 11.1.0 → 12.0.1

package/elements/oj-led-gauge/OjLedGaugeBase.ts

@@ -1,4 +1,4 @@
-import {OjWebElement} from "../";
+import { OjWebElement } from '../';
 
 /**
  * This is the base class for OjLedGauge, and is generated from
@@ -9,312 +9,319 @@ import {OjWebElement} from "../";
  */
 export class OjLedGaugeBase extends OjWebElement {
   /**
-   * Gets the value of borderColor property.
+   * Gets the value of <code>borderColor</code> property.
    * The border color of the gauge. Only applies when thresholds are not defined. The default value varies based on theme.
-   * @return The value of borderColor property.
+   * @return The value of <code>borderColor</code> property.
    * 
    */
   public getBorderColor(): Promise<string> {
-    return this.getProperty<string>("borderColor");
+    return this.getProperty<string>('borderColor');
   }
 
   /**
-   * Gets the value of color property.
+   * Gets the value of <code>color</code> property.
    * The color of the gauge. Only applies when thresholds are not defined. The default value varies based on theme.
-   * @return The value of color property.
+   * @return The value of <code>color</code> property.
    * 
    */
   public getColor(): Promise<string> {
-    return this.getProperty<string>("color");
+    return this.getProperty<string>('color');
   }
 
   /**
-   * Gets the value of label property.
+   * Gets the value of <code>label</code> property.
    * An object defining the label.
-   * @return The value of label property.
+   * @return The value of <code>label</code> property.
    * 
    */
-  public getLabel(): Promise<OjLedGaugeBase.Label> {
-    return this.getProperty<OjLedGaugeBase.Label>("label");
+  public getLabel(): Promise<Label> {
+    return this.getProperty<Label>('label');
   }
 
   /**
-   * Gets the value of max property.
+   * Gets the value of <code>markerSize</code> property.
+   * Specifies the led size.
+   * @return The value of <code>markerSize</code> property.
+   * 
+   */
+  public getMarkerSize(): Promise<string> {
+    return this.getProperty<string>('markerSize');
+  }
+
+  /**
+   * Gets the value of <code>max</code> property.
    * The maximum value of the gauge.
-   * @return The value of max property.
+   * @return The value of <code>max</code> property.
    * 
    */
   public getMax(): Promise<number> {
-    return this.getProperty<number>("max");
+    return this.getProperty<number>('max');
   }
 
   /**
-   * Gets the value of metricLabel property.
+   * Gets the value of <code>metricLabel</code> property.
    * An object defining the value label.
-   * @return The value of metricLabel property.
+   * @return The value of <code>metricLabel</code> property.
    * 
    */
-  public getMetricLabel(): Promise<OjLedGaugeBase.MetricLabel> {
-    return this.getProperty<OjLedGaugeBase.MetricLabel>("metricLabel");
+  public getMetricLabel(): Promise<MetricLabel> {
+    return this.getProperty<MetricLabel>('metricLabel');
   }
 
   /**
-   * Gets the value of min property.
+   * Gets the value of <code>min</code> property.
    * The minimum value of the gauge.
-   * @return The value of min property.
+   * @return The value of <code>min</code> property.
    * 
    */
   public getMin(): Promise<number> {
-    return this.getProperty<number>("min");
+    return this.getProperty<number>('min');
   }
 
   /**
-   * Gets the value of rotation property.
+   * Gets the value of <code>rotation</code> property.
    * The rotation angle for the gauge. Useful for changing the direction of triangle or arrow gauges.
-   * @return The value of rotation property.
+   * @return The value of <code>rotation</code> property.
    * 
    */
   public getRotation(): Promise<number> {
-    return this.getProperty<number>("rotation");
+    return this.getProperty<number>('rotation');
   }
 
   /**
-   * Gets the value of size property.
+   * Gets the value of <code>size</code> property.
    * Fraction of area to use. Values range from 0 to 1.
-   * @return The value of size property.
+   * @return The value of <code>size</code> property.
    * 
    */
   public getSizeProperty(): Promise<number> {
-    return this.getProperty<number>("size");
+    return this.getProperty<number>('size');
   }
 
   /**
-   * Gets the value of svgClassName property.
+   * Gets the value of <code>svgClassName</code> property.
    * The CSS style class to apply to the gauge. See the Help documentation for more information.
-   * @return The value of svgClassName property.
+   * @return The value of <code>svgClassName</code> property.
    * 
    */
   public getSvgClassName(): Promise<string> {
-    return this.getProperty<string>("svgClassName");
+    return this.getProperty<string>('svgClassName');
   }
 
   /**
-   * Gets the value of svgStyle property.
+   * Gets the value of <code>svgStyle</code> property.
    * The inline style to apply to the gauge. See the Help documentation for more information.
-   * @return The value of svgStyle property.
+   * @return The value of <code>svgStyle</code> property.
    * 
    */
   public getSvgStyle(): Promise<object> {
-    return this.getProperty<object>("svgStyle");
+    return this.getProperty<object>('svgStyle');
   }
 
   /**
-   * Gets the value of thresholds property.
+   * Gets the value of <code>thresholds</code> property.
    * An array of objects specifying the gauge thresholds.
-   * @return The value of thresholds property.
+   * @return The value of <code>thresholds</code> property.
    * 
    */
-  public getThresholds(): Promise<Array<OjLedGaugeBase.Thresholds>> {
-    return this.getProperty<Array<OjLedGaugeBase.Thresholds>>("thresholds");
+  public getThresholds(): Promise<Array<Thresholds>> {
+    return this.getProperty<Array<Thresholds>>('thresholds');
   }
 
   /**
-   * 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<OjLedGaugeBase.Tooltip> {
-    return this.getProperty<OjLedGaugeBase.Tooltip>("tooltip");
+  public getTooltip(): Promise<Tooltip> {
+    return this.getProperty<Tooltip>('tooltip');
   }
 
   /**
-   * 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<OjLedGaugeBase.Translations|null> {
-    return this.getProperty<OjLedGaugeBase.Translations|null>("translations");
+  public getTranslations(): Promise<Translations|null> {
+    return this.getProperty<Translations|null>('translations');
   }
 
   /**
-   * Gets the value of type property.
+   * Gets the value of <code>type</code> property.
    * The shape of the LED gauge. Can take the name of a built-in shape or the SVG path commands for a custom shape.
-   * @return The value of type property.
+   * @return The value of <code>type</code> property.
    * 
    */
   public getType(): Promise<string> {
-    return this.getProperty<string>("type");
+    return this.getProperty<string>('type');
   }
 
   /**
-   * Sets the value of "value" property.
+   * Sets the value of <code>value</code> property.
    * The metric value.
-   * @param value The value to set for "value"
+   * @param value The value to set for <code>value</code>
    * 
    */
   public changeValue(value: number|null): Promise<void> {
-    return this.setProperty<number|null>("value", value);
+    return this.setProperty<number|null>('value', value);
   }
 
   /**
-   * Gets the value of value property.
+   * Gets the value of <code>value</code> property.
    * The metric value.
-   * @return The value of value property.
+   * @return The value of <code>value</code> property.
    * 
    */
   public getValue(): Promise<number|null> {
-    return this.getProperty<number|null>("value");
+    return this.getProperty<number|null>('value');
   }
 
   /**
-   * Gets the value of visualEffects property.
-   * Defines whether visual effects such as overlays are applied to the gauge.
-   * @return The value of visualEffects property.
+   * Gets the value of <code>visualEffects</code> property.
+   * Defines whether the theme specific visual effects such as overlays and gradients are applied to the gauge.
+   * @return The value of <code>visualEffects</code> property.
    * 
    */
   public getVisualEffects(): Promise<string> {
-    return this.getProperty<string>("visualEffects");
+    return this.getProperty<string>('visualEffects');
   }
 
 }
-
-namespace OjLedGaugeBase {
-  export interface Label {
-    /**
-     * The CSS style object defining the style of the label.
-     */
-    "style": object;
-    /**
-     * The text for the label.
-     */
-    "text": string;
-  }
-  export interface MetricLabel {
-    /**
-     * The converter used to format the labels. See the Help documentation for more information.
-     */
-    "converter": object;
-    /**
-     * Defines if the label is rendered.
-     */
-    "rendered": string;
-    /**
-     * The scaling behavior of the labels. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
-     */
-    "scaling": string;
-    /**
-     * The CSS style object defining the style of the label.
-     */
-    "style": object;
-    /**
-     * The text for the label. If specified, text will overwrite the numeric value that is displayed by default. The converter, scaling, and textType attributes are ignored when text is specified.
-     */
-    "text": string;
-    /**
-     * Defines whether the label is a number or a percentage of the total value.
-     */
-    "textType": string;
-  }
-  export interface Thresholds {
-    /**
-     * The border color of the threshold.
-     */
-    "borderColor": string;
-    /**
-     * The color of the threshold.
-     */
-    "color": string;
-    /**
-     * The upper bound of the threshold. This value is ignored for the final threshold, which uses the maximum value of the gauge.
-     */
-    "max": number;
-    /**
-     * Specific description for the threshold and overwrites the shortDesc specified on gauge. This is used for accessibility and also for customizing the tooltip text.
-     */
-    "shortDesc": string;
-  }
-  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 Label {
+  /**
+   * The CSS style object defining the style of the label.
+   */
+  "style": object;
+  /**
+   * The text for the label.
+   */
+  "text": string;
+}
+export interface MetricLabel {
+  /**
+   * The converter used to format the labels. See the Help documentation for more information.
+   */
+  "converter": object;
+  /**
+   * Defines if the label is rendered.
+   */
+  "rendered": string;
+  /**
+   * The scaling behavior of the labels. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
+   */
+  "scaling": string;
+  /**
+   * The CSS style object defining the style of the label.
+   */
+  "style": object;
+  /**
+   * The text for the label. If specified, text will overwrite the numeric value that is displayed by default. The converter, scaling, and textType attributes are ignored when text is specified.
+   */
+  "text": string;
+  /**
+   * Defines whether the label is a number or a percentage of the total value.
+   */
+  "textType": string;
+}
+export interface Thresholds {
+  /**
+   * The border color of the threshold.
+   */
+  "borderColor": string;
+  /**
+   * The color of the threshold.
+   */
+  "color": string;
+  /**
+   * The upper bound of the threshold. This value is ignored for the final threshold, which uses the maximum value of the gauge.
+   */
+  "max": number;
+  /**
+   * Specific description for the threshold and overwrites the shortDesc specified on gauge. This is used for accessibility and also for customizing the tooltip text.
+   */
+  "shortDesc": string;
+}
+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-led-gauge/index.js

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

package/elements/oj-led-gauge/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-led-gauge/index.ts

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

package/elements/oj-legend/OjLegend.js.map

@@ -1 +1 @@
-{"version":3,"file":"OjLegend.js","sourceRoot":"","sources":["OjLegend.ts"],"names":[],"mappings":";;;AAAA,iDAA4C;AAS5C,MAAa,QAAS,SAAQ,2BAAY;CAEzC;AAFD,4BAEC"}
+{"version":3,"file":"OjLegend.js","sourceRoot":"","sources":["OjLegend.ts"],"names":[],"mappings":";;;AAAA,iDAA4C;AAO5C,MAAa,QAAS,SAAQ,2BAAY;CAEzC;AAFD,4BAEC"}

package/elements/oj-legend/OjLegend.ts

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