@oracle/oraclejet-webdriver 16.1.6 → 17.0.1

package/elements/oj-file-picker/OjFilePicker.ts

@@ -1,6 +1,8 @@
 import { OjFilePickerBase } from './OjFilePickerBase';
 import * as fs from 'fs';
 import * as path from 'path';
+import { whenBusyContextReady } from '../../lib/busy-context-utils';
+import { WebDriver } from 'selenium-webdriver';
 /**
  * The component WebElement for [oj-file-picker](../../jsdocs/oj.ojFilePicker.html).
  * Do not instantiate this class directly, instead, use
@@ -16,35 +18,107 @@ export class OjFilePicker extends OjFilePickerBase {
    * @param files An array of objects containing the path and type of selected files
    */
   async doSelect(files: Array<{ path: string; type: string }>) {
-    await this.whenReady();
-    let dataList: Array<any>;
-    dataList = [];
-    let file: any;
-    for (let i = 0; i < files.length; i++) {
-      const fileInfo = files[i];
-      const filePath = fileInfo.path;
-      const fileType = fileInfo.type;
-      const data = fs.readFileSync(filePath);
-      if (data) {
-        file = { bytes: Array.from(data), path: path.basename(filePath), type: fileType };
-        dataList.push(file);
+    await OjFilePicker.setupPickFiles(this.getDriver(), files);
+
+    await this.getDriver().executeScript(`arguments[0].firstChild.click();`, this);
+
+    await this.whenBusyContextReady();
+  }
+
+  /**
+   * This method should be called right before ojfilepickerutils.pickFiles
+   * Takes the webdriver and an Array of objects containing file paths + types.
+   * These files will be read from the local filesystem and then sent
+   * to the pickFiles method to simulate user file selection. Only the basename of
+   * the file will be sent, not the entire path to make it consistent with how
+   * the browser sets the value.
+   * @param driver the Webdriver of the test
+   * @param files An array of objects containing the path and type of selected files
+   */
+  static async setupPickFiles(driver: WebDriver, files: Array<{ path: string; type: string }>) {
+    await whenBusyContextReady(driver);
+    //create a buffer with the files
+    const dataList = files.map(({ path: filePath, type }) => {
+      const fileSizeInMB = fs.statSync(filePath).size / (1024 * 1024);
+      const numberChunks = Math.ceil(fileSizeInMB / 8);
+      const fileContent = Array.from(fs.readFileSync(filePath));
+      const chunkSize = Math.floor(fileContent.length / numberChunks);
+      const fileChunks = [];
+      for (let i = 0; i < numberChunks; i++) {
+        if (i + 1 == numberChunks) {
+          fileChunks.push(fileContent.slice(i * chunkSize));
+        } else {
+          fileChunks.push(fileContent.slice(i * chunkSize, (i + 1) * chunkSize));
+        }
+      }
+
+      return {
+        bytes: fileChunks, //split it into 8MB chunks
+        path: path.basename(filePath),
+        type,
+        numberChunks
+      };
+    });
+
+    for (let i = 0; i < dataList.length; i++) {
+      const { bytes, path, type, numberChunks } = dataList[i];
+      for (let j = 0; j < bytes.length; j++) {
+        const file = {
+          bytes: bytes[j],
+          path,
+          type,
+          numberChunks,
+          chunkNumber: j,
+          fileNumber: i
+        };
+        await driver.executeScript(
+          `const file = arguments[0];
+           const chunkNumber = file.chunkNumber;
+           var data = {
+            bytes: file.bytes,
+            path: file.path,
+            type: file.type
+           }
+           if (chunkNumber == 0) {
+            window['_file' + file.fileNumber] = [data];
+           } else {
+            window['_file' + file.fileNumber].push(data);
+           }`,
+          file
+        );
       }
     }
-    await this.getDriver().executeAsyncScript(
-      [
-        'var fileList = [];',
-        'var list = arguments[1];',
-        'for(var i = 0; i < list.length; i++) {',
-        'var data = list[i];',
-        'fileList.push(new File([Uint8Array.from(data.bytes)], data.path, {type: data.type}));',
-        '}',
-        'fileList.item = function(i){return fileList[i];}',
-        //arguments[2] is a callback automatically passed in to continue executing the code
-        'arguments[0]._doSelectHelper(fileList).then(arguments[2]);'
-      ].join('\n'),
-      this,
-      dataList
+
+    driver.executeScript(
+      `const numFiles = arguments[0];
+      const list = [];
+      for ( let i = 0; i < numFiles; i++) {
+        const file = window['_file' + i];
+        delete window['_file' + i];
+        list.push({
+          bytes: file.map(chunk => chunk.bytes).join(''),
+          path: file[0].path,
+          type: file[0].type
+        });
+      }
+      const fileList = list.map((data) => {
+        return new File([Uint8Array.from(data.bytes)], data.path, {type: data.type});
+       })
+       // Only if setupPickFiles has not been called yet
+       if (!HTMLInputElement.prototype._pickerTestData) {
+        //Save the native click method
+        const clickMethod = HTMLInputElement.prototype.click;
+        //Overwrite the click method
+        HTMLInputElement.prototype.click = function() {
+          const event = new CustomEvent("change");
+          this.dispatchEvent(event);
+          delete HTMLInputElement.prototype._pickerTestData;
+          HTMLInputElement.prototype.click = clickMethod;
+        }
+       }
+       HTMLInputElement.prototype._pickerTestData = fileList;
+       `,
+      dataList.length
     );
-    await this.whenBusyContextReady();
   }
 }

package/elements/oj-input-date/OjInputDateBase.js

@@ -22,7 +22,7 @@ class OjInputDateBase extends __1.OjWebElement {
      * Gets the value of <code>autocomplete</code> property.
      * Specifies a component's autocomplete state. See the Help documentation for more information.
      * @return The value of <code>autocomplete</code> property.
-     *
+     * @deprecated Since 17.0.0. The date field contains mask segments instead of a general input, so autocomplete is not supported.
      */
     getAutocomplete() {
         return this.getProperty('autocomplete');
@@ -31,7 +31,7 @@ class OjInputDateBase extends __1.OjWebElement {
      * Gets the value of <code>autofocus</code> property.
      * Specifies whether the component will get input focus when the page is loaded. See the Help documentation for more information.
      * @return The value of <code>autofocus</code> property.
-     *
+     * @deprecated Since 17.0.0. This is not recommended for accessibility reasons.
      */
     getAutofocus() {
         return this.getProperty('autofocus');
@@ -67,7 +67,7 @@ class OjInputDateBase extends __1.OjWebElement {
      * Gets the value of <code>dayMetaData</code> property.
      * Specifies additional information to be used when rendering the day. See the Help documentation for more information.
      * @return The value of <code>dayMetaData</code> property.
-     *
+     * @deprecated Since 17.0.0. Use dayFormatter instead, as it is more flexible.
      */
     getDayMetaData() {
         return this.getProperty('dayMetaData');
@@ -121,7 +121,7 @@ class OjInputDateBase extends __1.OjWebElement {
      * Gets the value of <code>keyboardEdit</code> property.
      * Determines if keyboard entry of the text is allowed. When disabled, the picker must be used to select the date. See the Help documentation for more information.
      * @return The value of <code>keyboardEdit</code> property.
-     *
+     * @deprecated Since 17.0.0. This is not supported in the Redwood UX specification.
      */
     getKeyboardEdit() {
         return this.getProperty('keyboardEdit');
@@ -148,7 +148,7 @@ class OjInputDateBase extends __1.OjWebElement {
      * Gets the value of <code>labelledBy</code> property.
      * The oj-label sets the labelledBy property programmatically on the form component. See the Help documentation for more information.
      * @return The value of <code>labelledBy</code> property.
-     *
+     * @deprecated Since 17.0.0. This is an internal API and is not supported in the Redwood UX specification.
      */
     getLabelledBy() {
         return this.getProperty('labelledBy');
@@ -202,7 +202,7 @@ class OjInputDateBase extends __1.OjWebElement {
      * Gets the value of <code>pickerAttributes</code> property.
      * Specifies attributes to be set on the picker DOM element when it is launched. See the Help documentation for more information.
      * @return The value of <code>pickerAttributes</code> property.
-     *
+     * @deprecated Since 17.0.0. Changing the Class or Style property is not recommended, as it leads to an inconsistent UI.
      */
     getPickerAttributes() {
         return this.getProperty('pickerAttributes');
@@ -211,7 +211,7 @@ class OjInputDateBase extends __1.OjWebElement {
      * Gets the value of <code>placeholder</code> property.
      * The placeholder text to set on the element.
      * @return The value of <code>placeholder</code> property.
-     *
+     * @deprecated Since 17.0.0. The date field contains mask segments instead of a general input, so placeholder is not supported.
      */
     getPlaceholder() {
         return this.getProperty('placeholder');

package/elements/oj-input-date/OjInputDateBase.ts

@@ -21,7 +21,7 @@ export class OjInputDateBase extends OjWebElement {
    * Gets the value of <code>autocomplete</code> property.
    * Specifies a component's autocomplete state. See the Help documentation for more information.
    * @return The value of <code>autocomplete</code> property.
-   *
+   * @deprecated Since 17.0.0. The date field contains mask segments instead of a general input, so autocomplete is not supported.
    */
   public getAutocomplete(): Promise<string> {
     return this.getProperty<string>('autocomplete');
@@ -31,7 +31,7 @@ export class OjInputDateBase extends OjWebElement {
    * Gets the value of <code>autofocus</code> property.
    * Specifies whether the component will get input focus when the page is loaded. See the Help documentation for more information.
    * @return The value of <code>autofocus</code> property.
-   *
+   * @deprecated Since 17.0.0. This is not recommended for accessibility reasons.
    */
   public getAutofocus(): Promise<boolean> {
     return this.getProperty<boolean>('autofocus');
@@ -71,7 +71,7 @@ export class OjInputDateBase extends OjWebElement {
    * Gets the value of <code>dayMetaData</code> property.
    * Specifies additional information to be used when rendering the day. See the Help documentation for more information.
    * @return The value of <code>dayMetaData</code> property.
-   *
+   * @deprecated Since 17.0.0. Use dayFormatter instead, as it is more flexible.
    */
   public getDayMetaData(): Promise<object> {
     return this.getProperty<object>('dayMetaData');
@@ -131,7 +131,7 @@ export class OjInputDateBase extends OjWebElement {
    * Gets the value of <code>keyboardEdit</code> property.
    * Determines if keyboard entry of the text is allowed. When disabled, the picker must be used to select the date. See the Help documentation for more information.
    * @return The value of <code>keyboardEdit</code> property.
-   *
+   * @deprecated Since 17.0.0. This is not supported in the Redwood UX specification.
    */
   public getKeyboardEdit(): Promise<string> {
     return this.getProperty<string>('keyboardEdit');
@@ -161,7 +161,7 @@ export class OjInputDateBase extends OjWebElement {
    * Gets the value of <code>labelledBy</code> property.
    * The oj-label sets the labelledBy property programmatically on the form component. See the Help documentation for more information.
    * @return The value of <code>labelledBy</code> property.
-   *
+   * @deprecated Since 17.0.0. This is an internal API and is not supported in the Redwood UX specification.
    */
   public getLabelledBy(): Promise<string | null> {
     return this.getProperty<string | null>('labelledBy');
@@ -221,7 +221,7 @@ export class OjInputDateBase extends OjWebElement {
    * Gets the value of <code>pickerAttributes</code> property.
    * Specifies attributes to be set on the picker DOM element when it is launched. See the Help documentation for more information.
    * @return The value of <code>pickerAttributes</code> property.
-   *
+   * @deprecated Since 17.0.0. Changing the Class or Style property is not recommended, as it leads to an inconsistent UI.
    */
   public getPickerAttributes(): Promise<PickerAttributes> {
     return this.getProperty<PickerAttributes>('pickerAttributes');
@@ -231,7 +231,7 @@ export class OjInputDateBase extends OjWebElement {
    * Gets the value of <code>placeholder</code> property.
    * The placeholder text to set on the element.
    * @return The value of <code>placeholder</code> property.
-   *
+   * @deprecated Since 17.0.0. The date field contains mask segments instead of a general input, so placeholder is not supported.
    */
   public getPlaceholder(): Promise<string> {
     return this.getProperty<string>('placeholder');
@@ -348,6 +348,7 @@ export interface DatePicker {
   changeYear: string;
   /**
    * Specifies the position in multiple months at which to show the current month (starting at 0).
+   * @deprecated Since 17.0.0. This is required when date-picker.number-of-months > 1, which is now deprecated, so this is no longer needed.
    */
   currentMonthPos: number;
   /**
@@ -361,18 +362,22 @@ export interface DatePicker {
   footerLayout: string;
   /**
    * Specifies the number of months to show at once. See the Help documentation for more information.
+   * @deprecated Since 17.0.0. This is not supported in the Redwood UX specification for Date Picker. See the Range Picker UX specification.
    */
   numberOfMonths: number;
   /**
    * Specifies when the date picker should be shown.
+   * @deprecated Since 17.0.0. This is not supported in the Redwood UX specification.
    */
   showOn: string;
   /**
    * Specifies the number of months to step backwards and forwards for the Ctrl+Alt+Page Up and Ctrl+Alt+Page Down keystrokes.
+   * @deprecated Since 17.0.0. This is not in the Redwood UX specification.
    */
   stepBigMonths: number;
   /**
    * Specifies how the prev and next keys will step backwards and forwards through the months. See the Help documentation for more information.
+   * @deprecated Since 17.0.0. This is not in the Redwood UX specification.
    */
   stepMonths: string | number;
   /**
@@ -381,6 +386,7 @@ export interface DatePicker {
   weekDisplay: string;
   /**
    * Specifies the range of years displayed in the year drop-down. See the Help documentation for more information.
+   * @deprecated Since 17.0.0. This is not in the Redwood UX specification. The 'min' and 'max' properties should be used instead.
    */
   yearRange: string;
 }
@@ -422,6 +428,7 @@ export interface HelpHints {
 export interface PickerAttributes {
   /**
    *
+   * @deprecated Since 17.0.0. We are recommending not to change the Class property of pickerAttribute as it leads to an inconsistent UI.
    */
   class: string;
   /**
@@ -433,14 +440,17 @@ export interface PickerAttributes {
 export interface Translations {
   /**
    * Message to announce to AT via aria-live when the length.max is exceeded.
+   * @deprecated Since 17.0.0. This is not supported by the component.
    */
   accessibleMaxLengthExceeded: string;
   /**
    * Message to annnouce to AT via aria-live for the remaining character count.
+   * @deprecated Since 17.0.0. This is not supported by the component.
    */
   accessibleMaxLengthRemaining: string;
   /**
    * The text to display for the current day link.
+   * @deprecated Since 17.0.0. The Redwood UX specification does not allow this to be configurable.
    */
   currentText: string;
   /**
@@ -453,14 +463,17 @@ export interface Translations {
   dateTimeRange: TranslationsDateTimeRange;
   /**
    * The text to display for the next month link.
+   * @deprecated Since 17.0.0. The Redwood UX specification does not allow this to be configurable.
    */
   nextText: string;
   /**
    * The text to display for the previous month link.
+   * @deprecated Since 17.0.0. The Redwood UX specification does not allow this to be configurable.
    */
   prevText: string;
   /**
    * Provides properties to customize the message text used by the implicit regexp validator associated to the InputText and TextArea components.
+   * @deprecated Since 17.0.0. This is not supported by the component.
    */
   regexp: TranslationsRegexp;
   /**
@@ -469,28 +482,34 @@ export interface Translations {
   required: TranslationsRequired;
   /**
    * Tooltip text for the calendar icon.
+   * @deprecated Since 17.0.0. This is not configurable per component instance in the Redwood UX specification.
    */
   tooltipCalendar: string;
   /**
    * Tooltip text for the calendar icon when the component is disabled.
+   * @deprecated Since 17.0.0. This is not configurable per component instance in the Redwood UX specification.
    */
   tooltipCalendarDisabled: string;
   /**
    * Tooltip text for the calendar + time icon.
+   * @deprecated Since 17.0.0. This is not configurable per component instance in the Redwood UX specification.
    */
   tooltipCalendarTime: string;
   /**
    * Tooltip text for the calendar + time icon when the component is disabled.
+   * @deprecated Since 17.0.0. This is not configurable per component instance in the Redwood UX specification.
    */
   tooltipCalendarTimeDisabled: string;
   /**
    * The text to display for the week of the year column heading.
+   * @deprecated Since 17.0.0. The Redwood UX specification does not allow this to be configurable.
    */
   weekHeader: string;
 }
 export interface TranslationsDateRestriction {
   /**
    * Hint text used by the implicit date restriction validator associated to the InputDateTime and InputDate components.
+   * @deprecated Since 17.0.0. Please use help-hints instead.
    */
   hint: string;
   /**
@@ -499,12 +518,14 @@ export interface TranslationsDateRestriction {
   messageDetail: string;
   /**
    * Message summary for the implicit date restriction validator associated to the InputDateTime and InputDate components.
+   * @deprecated Since 17.0.0. This is not supported in the Redwood UX specification.
    */
   messageSummary: string;
 }
 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 17.0.0. Please use help-hints instead.
    */
   hint: TranslationsDateTimeRangeHint;
   /**
@@ -513,20 +534,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 17.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 17.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 17.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 17.0.0. Please use help-hints instead.
    */
   min: string;
 }
@@ -543,26 +568,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 17.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 17.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 17.0.0. This 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 17.0.0. This is not supported by the component.
    */
   messageSummary: string;
 }
 export interface TranslationsRequired {
   /**
    * Hint text used by required validation error.
+   * @deprecated Since 17.0.0. Please use help-hints instead.
    */
   hint: string;
   /**

package/elements/oj-input-date-time/OjInputDateTimeBase.js

@@ -22,7 +22,7 @@ class OjInputDateTimeBase extends __1.OjWebElement {
      * Gets the value of <code>autocomplete</code> property.
      * Specifies a component's autocomplete state. See the Help documentation for more information.
      * @return The value of <code>autocomplete</code> property.
-     *
+     * @deprecated Since 17.0.0. The date field contains mask segments instead of a general input, so autocomplete is not supported.
      */
     getAutocomplete() {
         return this.getProperty('autocomplete');
@@ -31,7 +31,7 @@ class OjInputDateTimeBase extends __1.OjWebElement {
      * Gets the value of <code>autofocus</code> property.
      * Specifies whether the component will get input focus when the page is loaded. See the Help documentation for more information.
      * @return The value of <code>autofocus</code> property.
-     *
+     * @deprecated Since 17.0.0. This is not recommended for accessibility reasons.
      */
     getAutofocus() {
         return this.getProperty('autofocus');
@@ -67,7 +67,7 @@ class OjInputDateTimeBase extends __1.OjWebElement {
      * Gets the value of <code>dayMetaData</code> property.
      * Specifies additional information to be used when rendering the day. See the Help documentation for more information.
      * @return The value of <code>dayMetaData</code> property.
-     *
+     * @deprecated Since 17.0.0. Use dayFormatter instead, as it is more flexible.
      */
     getDayMetaData() {
         return this.getProperty('dayMetaData');
@@ -121,7 +121,7 @@ class OjInputDateTimeBase extends __1.OjWebElement {
      * Gets the value of <code>keyboardEdit</code> property.
      * Determines if keyboard entry of the text is allowed. When disabled, the picker must be used to select the date. See the Help documentation for more information.
      * @return The value of <code>keyboardEdit</code> property.
-     *
+     * @deprecated Since 17.0.0. This is not supported in the Redwood UX specification.
      */
     getKeyboardEdit() {
         return this.getProperty('keyboardEdit');
@@ -148,7 +148,7 @@ class OjInputDateTimeBase extends __1.OjWebElement {
      * Gets the value of <code>labelledBy</code> property.
      * The oj-label sets the labelledBy property programmatically on the form component. See the Help documentation for more information.
      * @return The value of <code>labelledBy</code> property.
-     *
+     * @deprecated Since 17.0.0. This is an internal API and is not supported in the Redwood UX specification.
      */
     getLabelledBy() {
         return this.getProperty('labelledBy');
@@ -202,7 +202,7 @@ class OjInputDateTimeBase extends __1.OjWebElement {
      * Gets the value of <code>pickerAttributes</code> property.
      * Specifies attributes to be set on the picker DOM element when it is launched. See the Help documentation for more information.
      * @return The value of <code>pickerAttributes</code> property.
-     *
+     * @deprecated Since 17.0.0. Changing the Class or Style property is not recommended, as it leads to an inconsistent UI.
      */
     getPickerAttributes() {
         return this.getProperty('pickerAttributes');
@@ -211,7 +211,7 @@ class OjInputDateTimeBase extends __1.OjWebElement {
      * Gets the value of <code>placeholder</code> property.
      * The placeholder text to set on the element.
      * @return The value of <code>placeholder</code> property.
-     *
+     * @deprecated Since 17.0.0. The date field contains mask segments instead of a general input, so placeholder is not supported.
      */
     getPlaceholder() {
         return this.getProperty('placeholder');