@oracle/oraclejet-webdriver 17.1.4 → 18.0.1

package/{elements → src/elements}/oj-input-search/OjInputSearch.ts

@@ -14,21 +14,12 @@ export class OjInputSearch extends OjInputSearchBase {
    * @override
    */
   async changeValue(value: string) {
-    // Call focus() on the root element
-    await this.getDriver().executeScript('arguments[0].focus()', this);
+    await this.getDriver().executeScript((element: HTMLElement) => element.focus(), this);
     await this.whenBusyContextReady();
-    await this.getDriver().executeAsyncScript(
-      `
-      var element = arguments[0];
-      var value = arguments[1];
-
-      // Last argument will the done function
-      var doneFunc = arguments[arguments.length - 1];
-
-      element._testChangeValue(value)
-        .then(doneFunc, doneFunc)
-        .catch(doneFunc);
-    `,
+    await this.getDriver().executeScript(
+      (element: any, value: any) => {
+        return element._testChangeValue(value);
+      },
       this,
       value
     );
@@ -40,21 +31,12 @@ export class OjInputSearch extends OjInputSearchBase {
    * @param key The data provider key for which to set the "value"
    */
   async changeValueByKey(key: any) {
-    // Call focus() on the root element
-    await this.getDriver().executeScript('arguments[0].focus()', this);
+    await this.getDriver().executeScript((element: HTMLElement) => element.focus(), this);
     await this.whenBusyContextReady();
-    await this.getDriver().executeAsyncScript(
-      `
-      var element = arguments[0];
-      var key = arguments[1];
-
-      // Last argument will the done function
-      var doneFunc = arguments[arguments.length - 1];
-
-      element._testChangeValueByKey(key)
-        .then(doneFunc, doneFunc)
-        .catch(doneFunc);
-    `,
+    await this.getDriver().executeScript(
+      (element: any, key: any) => {
+        return element._testChangeValueByKey(key);
+      },
       this,
       key
     );

package/{elements → src/elements}/oj-input-search/OjInputSearchBase.ts

@@ -56,4 +56,14 @@ export class OjInputSearchBase extends OjWebElement {
   public getValue(): Promise<string> {
     return this.getProperty<string>('value');
   }
+
+  /**
+   * Gets the value of <code>autocomplete</code> property.
+   * Specifies whether the component will enable the autocomplete type ahead feature.
+   * @return The value of <code>autocomplete</code> property.
+   *
+   */
+  public getAutocomplete(): Promise<string> {
+    return this.getProperty<string>('autocomplete');
+  }
 }

package/{elements → src/elements}/oj-input-text/OjInputTextBase.ts

@@ -355,18 +355,22 @@ export interface Length {
 export interface Translations {
   /**
    * Tooltip for the clear icon.
+   * @deprecated Since 18.0.0. This tooltip text should be consistent across the application, and not configured per component instance.
    */
   accessibleClearIcon: string;
   /**
    * Message to announce to AT via aria-live when the length.max is exceeded.
+   * @deprecated Since 18.0.0. This message text should be consistent across the application, and not configured per component instance.
    */
   accessibleMaxLengthExceeded: string;
   /**
-   * Message to annnouce to AT via aria-live for the remaining character count.
+   * Message to announce to AT via aria-live for the remaining character count.
+   * @deprecated Since 18.0.0. This message text should be consistent across the application, and not configured per component instance.
    */
   accessibleMaxLengthRemaining: string;
   /**
    * Provides properties to customize the message text used by the implicit regexp validator associated to the InputText and TextArea components.
+   * @deprecated Since 18.0.0. The implicit regexp validator is not supported by the component.
    */
   regexp: TranslationsRegexp;
   /**
@@ -377,16 +381,19 @@ export interface Translations {
 export interface TranslationsRegexp {
   /**
    * Provides properties to customize the error message detail used by the implicit regexp validator associated to the InputText and TextArea components.
+   * @deprecated Since 18.0.0. The implicit regexp validator is not supported by the component.
    */
   messageDetail: string;
   /**
    * Provides properties to customize the error message summary used by the implicit regexp validator associated to the InputText and TextArea components.
+   * @deprecated Since 18.0.0. The implicit regexp validator is not supported by the component.
    */
   messageSummary: string;
 }
 export interface TranslationsRequired {
   /**
    * Hint text used by required validation error.
+   * @deprecated Since 18.0.0. Setting a required validator hint is not recommended in the Redwood design system.
    */
   hint: string;
   /**
@@ -395,7 +402,7 @@ export interface TranslationsRequired {
   messageDetail: string;
   /**
    * Message text for summarizing a required validation error.
-   * @deprecated Since 14.0.0. This is deprecated because in the Redwood design system form components do not show validator summaries, so this is no longer needed.
+   * @deprecated Since 14.0.0. In the Redwood design system form components do not show validator summaries, so this is no longer needed.
    */
   messageSummary: string;
 }

package/{elements → src/elements}/oj-input-time/OjInputTimeBase.ts

@@ -241,7 +241,7 @@ export class OjInputTimeBase extends OjWebElement {
    * Gets the value of <code>renderMode</code> property.
    * Specifies whether to render the time picker in JET, or as a native picker control. See the Help documentation for more information.
    * @return The value of <code>renderMode</code> property.
-   * @deprecated Since 8.0.0. The "native" mode rendering is deprecated because JET is promoting a consistent Oracle UX over native look and feel in Redwood. Since this property takes only two values the property itself is deprecated. The theme variable "$inputDateTimeRenderModeOptionDefault" is also deprecated for the same reason.
+   * @deprecated Since 8.0.0. Support for "native" mode rendering is deprecated because JET promotes a consistent Oracle UX based upon the Redwood design system. As a result, the theme variable "$inputDateTimeRenderModeOptionDefault" is also deprecated.
    */
   public getRenderMode(): Promise<string> {
     return this.getProperty<string>('renderMode');
@@ -391,10 +391,12 @@ export interface TimePicker {
 export interface Translations {
   /**
    * Message to announce to AT via aria-live when the length.max is exceeded.
+   * @deprecated Since 18.0.0. This message text should be consistent across the application, and not configured per component instance.
    */
   accessibleMaxLengthExceeded: string;
   /**
-   * Message to annnouce to AT via aria-live for the remaining character count.
+   * Message to announce to AT via aria-live for the remaining character count.
+   * @deprecated Since 18.0.0. This message text should be consistent across the application, and not configured per component instance.
    */
   accessibleMaxLengthRemaining: string;
   /**
@@ -427,6 +429,7 @@ export interface Translations {
   okText: string;
   /**
    * Provides properties to customize the message text used by the implicit regexp validator associated to the InputText and TextArea components.
+   * @deprecated Since 18.0.0. The implicit regexp validator is not supported by the component.
    */
   regexp: TranslationsRegexp;
   /**
@@ -445,6 +448,7 @@ export interface Translations {
 export interface TranslationsDateTimeRange {
   /**
    * Provides properties to customize the hint text used by the implicit datetime range validator associated to the InputDateTime, InputDate, and InputTime components.
+   * @deprecated Since 18.0.0. Please use help-hints instead.
    */
   hint: TranslationsDateTimeRangeHint;
   /**
@@ -453,20 +457,24 @@ export interface TranslationsDateTimeRange {
   messageDetail: TranslationsDateTimeRangeMessageDetail;
   /**
    * Provides properties to customize the error message summary text used by the implicit datetime range validator associated to the InputDateTime, InputDate, and InputTime components.
+   * @deprecated Since 18.0.0. This is not supported in the Redwood UX specification.
    */
   messageSummary: TranslationsDateTimeRangeMessageSummary;
 }
 export interface TranslationsDateTimeRangeHint {
   /**
    * Hint text used by the implicit datetime range validator associated to the InputDateTime, InputDate, and InputTime components. hint.inRange is shown when both min and max are set, and is used to tell the user the allowed number range.
+   * @deprecated Since 18.0.0. Please use help-hints instead.
    */
   inRange: string;
   /**
    * Hint text used by the implicit datetime range validator associated to the InputDateTime, InputDate, and InputTime components. hint.max is shown when max is set and min is not set, and is used to tell the user the allowed maximum.
+   * @deprecated Since 18.0.0. Please use help-hints instead.
    */
   max: string;
   /**
    * Hint text used by the implicit datetime range validator associated to the InputDateTime, InputDate, and InputTime components. hint.min is shown when min is set and max is not set, and is used to tell the user the allowed minimum.
+   * @deprecated Since 18.0.0. Please use help-hints instead.
    */
   min: string;
 }
@@ -483,26 +491,31 @@ export interface TranslationsDateTimeRangeMessageDetail {
 export interface TranslationsDateTimeRangeMessageSummary {
   /**
    * Error message summary text used by the implicit datetime range validator associated to the InputDateTime, InputDate, and InputTime components. messageSummary.rangeOverflow is shown when max is set, and the value is greater than the maximum.
+   * @deprecated Since 18.0.0. This is not supported in the Redwood UX specification.
    */
   rangeOverflow: string;
   /**
    * Error message summary text used by the implicit datetime range validator associated to the InputDateTime, InputDate, and InputTime components. messageSummary.rangeUnderflow is shown when min is set, and the value is less than the minimum.
+   * @deprecated Since 18.0.0. This is not supported in the Redwood UX specification.
    */
   rangeUnderflow: string;
 }
 export interface TranslationsRegexp {
   /**
    * Provides properties to customize the error message detail used by the implicit regexp validator associated to the InputText and TextArea components.
+   * @deprecated Since 18.0.0. The implicit regexp validator is not supported by the component.
    */
   messageDetail: string;
   /**
    * Provides properties to customize the error message summary used by the implicit regexp validator associated to the InputText and TextArea components.
+   * @deprecated Since 18.0.0. The implicit regexp validator is not supported by the component.
    */
   messageSummary: string;
 }
 export interface TranslationsRequired {
   /**
    * Hint text used by required validation error.
+   * @deprecated Since 18.0.0. Setting a required validator hint is not recommended in the Redwood design system.
    */
   hint: string;
   /**
@@ -511,7 +524,7 @@ export interface TranslationsRequired {
   messageDetail: string;
   /**
    * Message text for summarizing a required validation error.
-   * @deprecated Since 14.0.0. This is deprecated because in the Redwood design system form components do not show validator summaries, so this is no longer needed.
+   * @deprecated Since 14.0.0. In the Redwood design system form components do not show validator summaries, so this is no longer needed.
    */
   messageSummary: string;
 }

package/{elements → src/elements}/oj-led-gauge/OjLedGaugeBase.ts

@@ -31,7 +31,7 @@ export class OjLedGaugeBase extends OjWebElement {
    * Gets the value of <code>label</code> property.
    * An object defining the label.
    * @return The value of <code>label</code> property.
-   * @deprecated Since 12.1.0. This attribute is deprecated. Use metric-label instead.
+   * @deprecated Since 12.1.0. Use metric-label instead.
    */
   public getLabel(): Promise<Label> {
     return this.getProperty<Label>('label');
@@ -191,7 +191,7 @@ export class OjLedGaugeBase extends OjWebElement {
    * 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.
-   * @deprecated Since 12.1.0. Overlays and gradients are not supported in Redwood theme and are not recommended. As such, this attribute is deprecated.
+   * @deprecated Since 12.1.0. Overlays and gradients are not supported in Redwood theme and are not recommended.
    */
   public getVisualEffects(): Promise<string> {
     return this.getProperty<string>('visualEffects');

package/src/elements/oj-legend/OjLegend.ts

@@ -0,0 +1,21 @@
+import { OjLegendBase } from './OjLegendBase';
+
+/**
+ * The component WebElement for [oj-legend](../../jsdocs/oj.ojLegend.html).
+ * Do not instantiate this class directly, instead, use
+ * [ojLegend](../functions/elements.ojLegend-1.html).
+ */
+
+/**
+ * The component WebElement for [oj-legend](../../jsdocs/oj.ojLegend.html).
+ * Do not instantiate this class directly, instead, use
+ * [ojLegend](../functions/elements.ojLegend-1.html).
+ *  <h4>Migration</h4>
+ *  When you migrate a page from using [oj-legend](../../jsdocs/oj.ojLegend.html) to [oj-c-legend](../../jsdocs/oj-c.Legend.html) you will also need to migrate your WebDriver tests from OjLegend to LegendWebElement. To do that you will need to revise type and locator instances as follows
+ *  </br><b>Type:</b> from OjLegend to [LegendWebElement](../../cpwdtsdoc/classes/LegendWebElement.html)
+ *  </br><b>Locator:</b> from [ojLegend](../functions/elements.ojLegend-1.html) to [findLegend](../../cpwdtsdoc/functions/findLegend.html)
+ *  </br>For more details on migrating from legacy to core pack please see component's [migration section](../../jsdocs/oj.ojLegend.html#migration-section)
+ */
+export class OjLegend extends OjLegendBase {
+  // Put overrides here
+}

package/{elements → src/elements}/oj-legend/OjLegendBase.ts

@@ -31,7 +31,7 @@ export class OjLegendBase extends OjWebElement {
    * Sets the value of <code>expanded</code> property.
    * Specifies the key set containing the ids of sections that should be expanded on initial render. See the Help documentation for more information.
    * @param expanded The value to set for <code>expanded</code>
-   * @deprecated Since 16.0.0. Use of legend collapsible section is not recommended in Redwood theme. As such, this attribute is deprecated.
+   * @deprecated Since 16.0.0. Collapsible legend sections are not recommended in the Redwood theme.
    */
   public changeExpanded(expanded: null): Promise<void> {
     return this.setProperty<null>('expanded', expanded);
@@ -41,7 +41,7 @@ export class OjLegendBase extends OjWebElement {
    * Gets the value of <code>expanded</code> property.
    * Specifies the key set containing the ids of sections that should be expanded on initial render. See the Help documentation for more information.
    * @return The value of <code>expanded</code> property.
-   * @deprecated Since 16.0.0. Use of legend collapsible section is not recommended in Redwood theme. As such, this attribute is deprecated.
+   * @deprecated Since 16.0.0. Collapsible legend sections are not recommended in the Redwood theme.
    */
   public getExpanded(): Promise<null> {
     return this.getProperty<null>('expanded');
@@ -141,7 +141,7 @@ export class OjLegendBase extends OjWebElement {
    * Gets the value of <code>scrolling</code> property.
    * Defines whether scrolling is enabled for the legend.
    * @return The value of <code>scrolling</code> property.
-   * @deprecated Since 12.1.0. Setting scrolling to off is not supported in Redwood theme and it is not recommended. As such, this attribute is deprecated.
+   * @deprecated Since 12.1.0. Setting scrolling to off is not supported in the Redwood theme and it is not recommended.
    */
   public getScrolling(): Promise<string> {
     return this.getProperty<string>('scrolling');
@@ -211,7 +211,7 @@ export class OjLegendBase extends OjWebElement {
    * 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 <code>trackResize</code> property.
-   * @deprecated Since 15.0.0. With the track resize optimized, this API is no longer required. track-resize on will be the default behavior.
+   * @deprecated Since 15.0.0. This is no longer needed due to performance enhancements. The default behavior will be used.
    */
   public getTrackResize(): Promise<string> {
     return this.getProperty<string>('trackResize');
@@ -240,12 +240,12 @@ export class OjLegendBase extends OjWebElement {
 export interface Sections {
   /**
    * Whether the section is collapsible. Only applies if the legend orientation is vertical.
-   * @deprecated Since 16.0.0. Use of legend collapsible section is not recommended in Redwood theme. As such, this attribute is deprecated.
+   * @deprecated Since 16.0.0. Collapsible legend sections are not recommended in the Redwood theme.
    */
   collapsible: string;
   /**
    * Whether the section is initially expanded. Only applies if the section is collapsible.
-   * @deprecated Since 14.1.0. This attribute is deprecated. Applications should use the expanded API on oj-legend instead.
+   * @deprecated Since 14.1.0. Applications should use the expanded API on oj-legend instead.
    */
   expanded: string;
   /**
@@ -258,6 +258,7 @@ export interface Sections {
   items: Array<object>;
   /**
    * An array of nested legend sections.
+   * @deprecated Since 18.0.0. Use of nested legend sections is not recommended in Redwood theme. As such, this attribute is deprecated.
    */
   sections: Array<object>;
   /**
@@ -278,7 +279,7 @@ export interface Sections {
 export interface Translations {
   /**
    * Used to describe a container that contains controls.
-   * @deprecated Since 15.0.0. This is deprecated because it is not used by the oj-legend
+   * @deprecated Since 15.0.0. This resource is not used by oj-legend.
    */
   accessibleContainsControls: string;
   /**
@@ -291,12 +292,12 @@ export interface Translations {
   labelAndValue: string;
   /**
    * Text shown for clearing multiple selection on touch devices.
-   * @deprecated Since 15.0.0. This is deprecated because it is not used by the oj-legend
+   * @deprecated Since 15.0.0. This resource is not used by oj-legend.
    */
   labelClearSelection: string;
   /**
    * Used to display a count out of a total.
-   * @deprecated Since 15.0.0. This is deprecated because it is not used by the oj-legend
+   * @deprecated Since 15.0.0. This resource is not used by oj-legend.
    */
   labelCountWithTotal: string;
   /**
@@ -305,12 +306,12 @@ export interface Translations {
   labelDataVisualization: string;
   /**
    * Text shown when the component receives invalid data.
-   * @deprecated Since 15.0.0. This is deprecated because it is not used by the oj-legend
+   * @deprecated Since 15.0.0. This resource is not used by oj-legend.
    */
   labelInvalidData: string;
   /**
    * Text shown when the component receives no data.
-   * @deprecated Since 15.0.0. This is deprecated because it is not used by the oj-legend
+   * @deprecated Since 15.0.0. This resource is not used by oj-legend.
    */
   labelNoData: string;
   /**
@@ -331,27 +332,27 @@ export interface Translations {
   stateHidden: string;
   /**
    * Used to describe the isolated state for accessibility.
-   * @deprecated Since 15.0.0. This is deprecated because it is not used by the oj-legend
+   * @deprecated Since 15.0.0. This resource is not used by oj-legend.
    */
   stateIsolated: string;
   /**
    * Used to describe the maximized state for accessibility.
-   * @deprecated Since 15.0.0. This is deprecated because it is not used by the oj-legend
+   * @deprecated Since 15.0.0. This resource is not used by oj-legend.
    */
   stateMaximized: string;
   /**
    * Used to describe the minimized state for accessibility.
-   * @deprecated Since 15.0.0. This is deprecated because it is not used by the oj-legend
+   * @deprecated Since 15.0.0. This resource is not used by oj-legend.
    */
   stateMinimized: string;
   /**
    * Used to describe the selected state for accessibility.
-   * @deprecated Since 15.0.0. This is deprecated because it is not used by the oj-legend
+   * @deprecated Since 15.0.0. This resource is not used by oj-legend.
    */
   stateSelected: string;
   /**
    * Used to describe the unselected state for accessibility.
-   * @deprecated Since 15.0.0. This is deprecated because it is not used by the oj-legend
+   * @deprecated Since 15.0.0. This resource is not used by oj-legend.
    */
   stateUnselected: string;
   /**

package/{elements → src/elements}/oj-list-view/OjListView.ts

@@ -22,11 +22,9 @@ export class OjListView extends OjListViewBase {
       this.getDriver(),
       ['KeySet'],
       [this, selected],
-      `
-      (({ KeySetImpl }, ele, selected) => {
+      ({ KeySetImpl }, ele, selected) => {
         ele.selected = new KeySetImpl(selected);
-      })
-      `
+      }
     );
   }
 
@@ -39,14 +37,9 @@ export class OjListView extends OjListViewBase {
    */
   async getSelected<K>(): Promise<Array<K>> {
     await this.whenReady();
-    const selected: Array<K> = await this.getDriver().executeScript(
-      `
-      const ele = arguments[0];
-      const selected = Array.from(ele.selected.values())
-      return selected;
-    `,
-      this
-    );
+    const selected: Array<K> = await this.getDriver().executeScript((ele: any) => {
+      return Array.from(ele.selected.values());
+    }, this);
     return selected;
   }
 
@@ -68,9 +61,7 @@ export class OjListView extends OjListViewBase {
     await this.whenBusyContextReady();
     const display = await this.getProperty('display');
     let el = await this.getDriver().executeScript<WebElement>(
-      `
-  return arguments[0].getNodeBySubId({ subId: 'oj-listview-item', key: arguments[1] })
-  `,
+      (ele: any, key: T) => ele.getNodeBySubId({ subId: 'oj-listview-item', key }),
       this,
       itemLocator.key
     );

package/{elements → src/elements}/oj-list-view/OjListViewBase.ts

@@ -123,8 +123,8 @@ export class OjListViewBase extends OjWebElement {
    * @return The value of <code>scrollPolicyOptions</code> property.
    *
    */
-  public getScrollPolicyOptions(): Promise<unknown | null> {
-    return this.getProperty<unknown | null>('scrollPolicyOptions');
+  public getScrollPolicyOptions(): Promise<ScrollPolicyOptions | null> {
+    return this.getProperty<ScrollPolicyOptions | null>('scrollPolicyOptions');
   }
 
   /**
@@ -272,6 +272,20 @@ export interface Item {
    */
   selectable: boolean | null;
 }
+export interface ScrollPolicyOptions {
+  /**
+   * The number of items to fetch in each block
+   */
+  fetchSize: number;
+  /**
+   * The maximum total number of items to fetch
+   */
+  maxCount: number;
+  /**
+   * The element used to determine the scroll position as well as the maximum scroll position. See the Help documentation for more information.
+   */
+  scroller: string;
+}
 export interface ScrollPosition {
   /**
    * The zero-based index of the item. If scrollPolicy is set to 'loadMoreOnScroll' and the index is greater than maxCount set in scrollPolicyOptions, then it will scroll and fetch until the end of the list is reached and there's no more items to fetch.

package/{elements → src/elements}/oj-menu/OjMenu.ts

@@ -48,16 +48,17 @@ export class OjMenu extends OjMenuBase {
   async doMenuAction(selectedValue: string) {
     await this.whenReady();
     return this.getDriver().executeScript<void>(
-      `
-    const evt = new CustomEvent('ojMenuAction', {
-      detail: {
-        selectedValue: "${selectedValue}"
-      }
-    });
-    arguments[0].dispatchEvent(evt);
-    arguments[0].close();
-    `,
-      this
+      (el: any, selectedValue: string) => {
+        const evt = new CustomEvent('ojMenuAction', {
+          detail: {
+            selectedValue
+          }
+        });
+        el.dispatchEvent(evt);
+        el.close();
+      },
+      this,
+      selectedValue
     );
   }
 }

package/{elements → src/elements}/oj-menu/OjMenuBase.ts

@@ -110,10 +110,12 @@ export interface OpenOptionsPositionOffset {
 export interface Translations {
   /**
    * Label assigned to a hidden anchor tag used for accessibility navigation on platforms supporting VoiceOver. The link is injected before the first menu item. It is used for establishing VO cursor focus. Activation of the link will move focus to the first menu item.
+   * @deprecated Since 18.0.0. This resource was introduced as a workaround for an issue that has since been fixed, and is no longer used by oj-menu.
    */
   ariaFocusSkipLink: string;
   /**
    * Label for the "Cancel" menu item.
+   * @deprecated Since 18.0.0. This is not in the Redwood UX specification.
    */
   labelCancel: string;
 }

package/{elements → src/elements}/oj-message/OjMessage.ts

@@ -11,7 +11,7 @@ export class OjMessage extends OjMessageBase {
    */
   async doClose() {
     await this.whenReady();
-    await this.getDriver().executeScript('arguments[0].close()', this);
+    await this.getDriver().executeScript((el: any) => el.close(), this);
     await this.whenBusyContextReady();
   }
 }

package/{elements → src/elements}/oj-n-box/OjNBoxBase.ts

@@ -351,7 +351,7 @@ export class OjNBoxBase extends OjWebElement {
    * 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 <code>touchResponse</code> property.
-   *
+   * @deprecated Since 18.0.0. This attribute is deprecated and no longer recommended in the Redwood Design system. The "auto" value behavior will be applied instead.
    */
   public getTouchResponse(): Promise<string> {
     return this.getProperty<string>('touchResponse');