@oracle/oraclejet-webdriver 11.0.9 → 12.0.0

package/elements/oj-input-text/OjInputTextBase.ts

@@ -1,4 +1,4 @@
-import {OjWebElement} from "../";
+import { OjWebElement } from '../';
 
 /**
  * This is the base class for OjInputText, and is generated from
@@ -9,382 +9,379 @@ import {OjWebElement} from "../";
  */
 export class OjInputTextBase extends OjWebElement {
   /**
-   * Gets the value of asyncValidators property.
+   * Gets the value of <code>asyncValidators</code> property.
    * Specifies a list of asynchronous validators used by the component when performing validation. Use async-validators when you need to perform some validation work on the server. See the Help documentation for more information.
-   * @return The value of asyncValidators property.
+   * @return The value of <code>asyncValidators</code> property.
    * @deprecated Since 8.0.0. Use the validators property instead for either regular Validators or AsyncValidators.
    */
   public getAsyncValidators(): Promise<Array<object>> {
-    return this.getProperty<Array<object>>("asyncValidators");
+    return this.getProperty<Array<object>>('asyncValidators');
   }
 
   /**
-   * Gets the value of autocomplete property.
+   * 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 autocomplete property.
+   * @return The value of <code>autocomplete</code> property.
    * 
    */
   public getAutocomplete(): Promise<string> {
-    return this.getProperty<string>("autocomplete");
+    return this.getProperty<string>('autocomplete');
   }
 
   /**
-   * Gets the value of autofocus property.
+   * 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 autofocus property.
+   * @return The value of <code>autofocus</code> property.
    * 
    */
   public getAutofocus(): Promise<boolean> {
-    return this.getProperty<boolean>("autofocus");
+    return this.getProperty<boolean>('autofocus');
   }
 
   /**
-   * Gets the value of clearIcon property.
+   * Gets the value of <code>clearIcon</code> property.
    * Specifies if an icon to clear the input field should be visible.
-   * @return The value of clearIcon property.
+   * @return The value of <code>clearIcon</code> property.
    * 
    */
   public getClearIcon(): Promise<string> {
-    return this.getProperty<string>("clearIcon");
+    return this.getProperty<string>('clearIcon');
   }
 
   /**
-   * Gets the value of converter property.
+   * Gets the value of <code>converter</code> property.
    * An object that converts the value. See the Help documentation for more information.
-   * @return The value of converter property.
+   * @return The value of <code>converter</code> property.
    * 
    */
   public getConverter(): Promise<object|null> {
-    return this.getProperty<object|null>("converter");
+    return this.getProperty<object|null>('converter');
   }
 
   /**
-   * Gets the value of describedBy property.
+   * Gets the value of <code>describedBy</code> property.
    * The form component's oj-label automatically sets described-by to make it accessible. It is not meant to be set by application developer.
-   * @return The value of describedBy property.
+   * @return The value of <code>describedBy</code> property.
    * 
    */
   public getDescribedBy(): Promise<string> {
-    return this.getProperty<string>("describedBy");
+    return this.getProperty<string>('describedBy');
   }
 
   /**
-   * Gets the value of disabled property.
+   * Gets the value of <code>disabled</code> property.
    * Specifies whether the component is disabled. The default is false.
-   * @return The value of disabled property.
+   * @return The value of <code>disabled</code> property.
    * 
    */
   public getDisabled(): Promise<boolean> {
-    return this.getProperty<boolean>("disabled");
+    return this.getProperty<boolean>('disabled');
   }
 
   /**
-   * Gets the value of displayOptions property.
+   * Gets the value of <code>displayOptions</code> property.
    * Display options for auxiliary content that determines whether or not it should be displayed.
-   * @return The value of displayOptions property.
+   * @return The value of <code>displayOptions</code> property.
    * 
    */
-  public getDisplayOptions(): Promise<OjInputTextBase.DisplayOptions> {
-    return this.getProperty<OjInputTextBase.DisplayOptions>("displayOptions");
+  public getDisplayOptions(): Promise<DisplayOptions> {
+    return this.getProperty<DisplayOptions>('displayOptions');
   }
 
   /**
-   * Gets the value of help property.
+   * Gets the value of <code>help</code> property.
    * Form component help information.
-   * @return The value of help property.
+   * @return The value of <code>help</code> property.
    * 
    */
-  public getHelp(): Promise<OjInputTextBase.Help> {
-    return this.getProperty<OjInputTextBase.Help>("help");
+  public getHelp(): Promise<Help> {
+    return this.getProperty<Help>('help');
   }
 
   /**
-   * Gets the value of helpHints property.
+   * Gets the value of <code>helpHints</code> property.
    * Represents hints for an oj-form-layout element to render help information on the label of the editable component.
-   * @return The value of helpHints property.
+   * @return The value of <code>helpHints</code> property.
    * 
    */
-  public getHelpHints(): Promise<OjInputTextBase.HelpHints> {
-    return this.getProperty<OjInputTextBase.HelpHints>("helpHints");
+  public getHelpHints(): Promise<HelpHints> {
+    return this.getProperty<HelpHints>('helpHints');
   }
 
   /**
-   * Gets the value of labelEdge property.
+   * Gets the value of <code>labelEdge</code> property.
    * Defines how the label of a component is created. See the Help documentation for more information.
-   * @return The value of labelEdge property.
+   * @return The value of <code>labelEdge</code> property.
    * 
    */
   public getLabelEdge(): Promise<string> {
-    return this.getProperty<string>("labelEdge");
+    return this.getProperty<string>('labelEdge');
   }
 
   /**
-   * Gets the value of labelHint property.
+   * Gets the value of <code>labelHint</code> property.
    * Represents a hint for oj-form-layout element to render a label on the editable component.
-   * @return The value of labelHint property.
+   * @return The value of <code>labelHint</code> property.
    * 
    */
   public getLabelHint(): Promise<string> {
-    return this.getProperty<string>("labelHint");
+    return this.getProperty<string>('labelHint');
   }
 
   /**
-   * Gets the value of labelledBy property.
+   * 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 labelledBy property.
+   * @return The value of <code>labelledBy</code> property.
    * 
    */
   public getLabelledBy(): Promise<string|null> {
-    return this.getProperty<string|null>("labelledBy");
+    return this.getProperty<string|null>('labelledBy');
   }
 
   /**
-   * Gets the value of length property.
+   * Gets the value of <code>length</code> property.
    * An object whose properties describe the maximum length attributes. // * @ojtsignore tsdefonly
-   * @return The value of length property.
+   * @return The value of <code>length</code> property.
    * 
    */
-  public getLength(): Promise<OjInputTextBase.Length> {
-    return this.getProperty<OjInputTextBase.Length>("length");
+  public getLength(): Promise<Length> {
+    return this.getProperty<Length>('length');
   }
 
   /**
-   * Gets the value of list property.
+   * Gets the value of <code>list</code> property.
    * Specifies a list of pre-defined options to present to the user. See the Help documentation for more information.
-   * @return The value of list property.
+   * @return The value of <code>list</code> property.
    * 
    */
   public getList(): Promise<string> {
-    return this.getProperty<string>("list");
+    return this.getProperty<string>('list');
   }
 
   /**
-   * Sets the value of "messagesCustom" property.
+   * Sets the value of <code>messagesCustom</code> property.
    * A list of messages added by an application to the component. See the Help documentation for more information.
-   * @param messagesCustom The value to set for "messagesCustom"
+   * @param messagesCustom The value to set for <code>messagesCustom</code>
    * 
    */
   public changeMessagesCustom(messagesCustom: Array<object>): Promise<void> {
-    return this.setProperty<Array<object>>("messagesCustom", messagesCustom);
+    return this.setProperty<Array<object>>('messagesCustom', messagesCustom);
   }
 
   /**
-   * Gets the value of messagesCustom property.
+   * Gets the value of <code>messagesCustom</code> property.
    * A list of messages added by an application to the component. See the Help documentation for more information.
-   * @return The value of messagesCustom property.
+   * @return The value of <code>messagesCustom</code> property.
    * 
    */
   public getMessagesCustom(): Promise<Array<object>> {
-    return this.getProperty<Array<object>>("messagesCustom");
+    return this.getProperty<Array<object>>('messagesCustom');
   }
 
   /**
-   * Gets the value of name property.
+   * Gets the value of <code>name</code> property.
    * Specifies the name of the component.
-   * @return The value of name property.
+   * @return The value of <code>name</code> property.
    * @deprecated Since 6.0.0. JET does not use form submit, so this is not needed.
    */
   public getName(): Promise<string> {
-    return this.getProperty<string>("name");
+    return this.getProperty<string>('name');
   }
 
   /**
-   * Gets the value of placeholder property.
+   * Gets the value of <code>placeholder</code> property.
    * The placeholder text to set on the element.
-   * @return The value of placeholder property.
+   * @return The value of <code>placeholder</code> property.
    * 
    */
   public getPlaceholder(): Promise<string> {
-    return this.getProperty<string>("placeholder");
+    return this.getProperty<string>('placeholder');
   }
 
   /**
-   * Gets the value of rawValue property.
+   * Gets the value of <code>rawValue</code> property.
    * Read-only property used for retrieving the current value from the input field in string form. See the Help documentation for more information.
-   * @return The value of rawValue property.
+   * @return The value of <code>rawValue</code> property.
    * 
    */
   public getRawValue(): Promise<string> {
-    return this.getProperty<string>("rawValue");
+    return this.getProperty<string>('rawValue');
   }
 
   /**
-   * Gets the value of readonly property.
+   * Gets the value of <code>readonly</code> property.
    * Specifies whether the component is read-only. A read-only element cannot be modified, but user interaction is allowed. See the Help documentation for more information.
-   * @return The value of readonly property.
+   * @return The value of <code>readonly</code> property.
    * 
    */
   public getReadonly(): Promise<boolean> {
-    return this.getProperty<boolean>("readonly");
+    return this.getProperty<boolean>('readonly');
   }
 
   /**
-   * Gets the value of required property.
+   * Gets the value of <code>required</code> property.
    * Specifies whether the component is required or optional. See the Help documentation for more information.
-   * @return The value of required property.
+   * @return The value of <code>required</code> property.
    * 
    */
   public getRequired(): Promise<boolean> {
-    return this.getProperty<boolean>("required");
+    return this.getProperty<boolean>('required');
   }
 
   /**
-   * 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<OjInputTextBase.Translations|null> {
-    return this.getProperty<OjInputTextBase.Translations|null>("translations");
+  public getTranslations(): Promise<Translations|null> {
+    return this.getProperty<Translations|null>('translations');
   }
 
   /**
-   * Gets the value of userAssistanceDensity property.
+   * Gets the value of <code>userAssistanceDensity</code> property.
    * Specifies the density of the form component's user assistance presentation.
-   * @return The value of userAssistanceDensity property.
+   * @return The value of <code>userAssistanceDensity</code> property.
    * 
    */
   public getUserAssistanceDensity(): Promise<string> {
-    return this.getProperty<string>("userAssistanceDensity");
+    return this.getProperty<string>('userAssistanceDensity');
   }
 
   /**
-   * Gets the value of valid property.
+   * Gets the value of <code>valid</code> property.
    * The validity state of the component
-   * @return The value of valid property.
+   * @return The value of <code>valid</code> property.
    * 
    */
   public getValid(): Promise<string> {
-    return this.getProperty<string>("valid");
+    return this.getProperty<string>('valid');
   }
 
   /**
-   * Gets the value of validators property.
+   * Gets the value of <code>validators</code> property.
    * Specifies a list of synchronous validators for performing validation by the element. See the Help documentation for more information.
-   * @return The value of validators property.
+   * @return The value of <code>validators</code> property.
    * 
    */
   public getValidators(): Promise<Array<object>> {
-    return this.getProperty<Array<object>>("validators");
+    return this.getProperty<Array<object>>('validators');
   }
 
   /**
-   * Sets the value of "value" property.
+   * Sets the value of <code>value</code> property.
    * The value of the component.
-   * @param value The value to set for "value"
+   * @param value The value to set for <code>value</code>
    * 
    */
   public changeValue(value: any): Promise<void> {
-    return this.setProperty<any>("value", value);
+    return this.setProperty<any>('value', value);
   }
 
   /**
-   * Gets the value of value property.
+   * Gets the value of <code>value</code> property.
    * The value of the component.
-   * @return The value of value property.
+   * @return The value of <code>value</code> property.
    * 
    */
   public getValue(): Promise<any> {
-    return this.getProperty<any>("value");
+    return this.getProperty<any>('value');
   }
 
   /**
-   * Gets the value of virtualKeyboard property.
+   * Gets the value of <code>virtualKeyboard</code> property.
    * The type of virtual keyboard to display for entering a value on mobile browsers. See the Help documentation for more information.
-   * @return The value of virtualKeyboard property.
+   * @return The value of <code>virtualKeyboard</code> property.
    * 
    */
   public getVirtualKeyboard(): Promise<string> {
-    return this.getProperty<string>("virtualKeyboard");
+    return this.getProperty<string>('virtualKeyboard');
   }
 
 }
-
-namespace OjInputTextBase {
-  export interface DisplayOptions {
-    /**
-     * Display options for auxiliary converter hint text that determines whether it should be displayed.
-     */
-    "converterHint": Array<string>|string;
-    /**
-     * Display options for auxiliary help instruction text that determines whether it should be displayed.
-     */
-    "helpInstruction": Array<string>|string;
-    /**
-     * Display options for auxiliary message text that determines whether it should be displayed.
-     */
-    "messages": Array<string>|string;
-    /**
-     * Display options for auxiliary validator hint text that determines whether it should be displayed.
-     */
-    "validatorHint": Array<string>|string;
-  }
-  export interface Help {
-    /**
-     * Represents advisory information for the component, such as would be appropriate for a tooltip.
-     */
-    "instruction": string;
-  }
-  export interface HelpHints {
-    /**
-     * Hint for help definition text associated with the label.
-     */
-    "definition": string;
-    /**
-     * Help source URL associated with the component.
-     */
-    "source": string;
-  }
-  export interface Length {
-    /**
-     * Specifies the manner in which the input text characters has to be counted.
-     */
-    "countBy": string;
-    /**
-     * Specifies the maximum number of characters to be entered in the input text.
-     */
-    "max": number|null;
-  }
-  export interface Translations {
-    /**
-     * Message to announce to AT via aria-live when the length.max is exceeded.
-     */
-    "accessibleMaxLengthExceeded": string;
-    /**
-     * Message to annnouce to AT via aria-live for the remaining character count.
-     */
-    "accessibleMaxLengthRemaining": string;
-    /**
-     * Provides properties to customize the message text used by the implicit regexp validator associated to the InputText and TextArea components.
-     */
-    "regexp": OjInputTextBase.TranslationsRegexp;
-    /**
-     * Provides properties to customize the summary, detail and hint text used by the implicit required validator associated to any editable component that supports the required option.
-     */
-    "required": OjInputTextBase.TranslationsRequired;
-  }
-  export interface TranslationsRegexp {
-    /**
-     * Provides properties to customize the error message detail used by the implicit regexp validator associated to the InputText and TextArea components.
-     */
-    "messageDetail": string;
-    /**
-     * Provides properties to customize the error message summary used by the implicit regexp validator associated to the InputText and TextArea components.
-     */
-    "messageSummary": string;
-  }
-  export interface TranslationsRequired {
-    /**
-     * Hint text used by required validation error.
-     */
-    "hint": string;
-    /**
-     * Message text that describes the details of the required validation error.
-     */
-    "messageDetail": string;
-    /**
-     * Message text for summarizing a required validation error.
-     */
-    "messageSummary": string;
-  }
+export interface DisplayOptions {
+  /**
+   * Display options for auxiliary converter hint text that determines whether it should be displayed.
+   */
+  "converterHint": Array<string>|string;
+  /**
+   * Display options for auxiliary help instruction text that determines whether it should be displayed.
+   */
+  "helpInstruction": Array<string>|string;
+  /**
+   * Display options for auxiliary message text that determines whether it should be displayed.
+   */
+  "messages": Array<string>|string;
+  /**
+   * Display options for auxiliary validator hint text that determines whether it should be displayed.
+   */
+  "validatorHint": Array<string>|string;
+}
+export interface Help {
+  /**
+   * Represents advisory information for the component, such as would be appropriate for a tooltip.
+   */
+  "instruction": string;
+}
+export interface HelpHints {
+  /**
+   * Hint for help definition text associated with the label.
+   */
+  "definition": string;
+  /**
+   * Help source URL associated with the component.
+   */
+  "source": string;
+}
+export interface Length {
+  /**
+   * Specifies the manner in which the input text characters has to be counted.
+   */
+  "countBy": string;
+  /**
+   * Specifies the maximum number of characters to be entered in the input text.
+   */
+  "max": number|null;
+}
+export interface Translations {
+  /**
+   * Message to announce to AT via aria-live when the length.max is exceeded.
+   */
+  "accessibleMaxLengthExceeded": string;
+  /**
+   * Message to annnouce to AT via aria-live for the remaining character count.
+   */
+  "accessibleMaxLengthRemaining": string;
+  /**
+   * Provides properties to customize the message text used by the implicit regexp validator associated to the InputText and TextArea components.
+   */
+  "regexp": TranslationsRegexp;
+  /**
+   * Provides properties to customize the summary, detail and hint text used by the implicit required validator associated to any editable component that supports the required option.
+   */
+  "required": TranslationsRequired;
+}
+export interface TranslationsRegexp {
+  /**
+   * Provides properties to customize the error message detail used by the implicit regexp validator associated to the InputText and TextArea components.
+   */
+  "messageDetail": string;
+  /**
+   * Provides properties to customize the error message summary used by the implicit regexp validator associated to the InputText and TextArea components.
+   */
+  "messageSummary": string;
+}
+export interface TranslationsRequired {
+  /**
+   * Hint text used by required validation error.
+   */
+  "hint": string;
+  /**
+   * Message text that describes the details of the required validation error.
+   */
+  "messageDetail": string;
+  /**
+   * Message text for summarizing a required validation error.
+   */
+  "messageSummary": string;
 }

package/elements/oj-input-text/index.js

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

package/elements/oj-input-text/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AACA,8BAAoD;AACpD,+CAA4C;AACnC,4FADA,yBAAW,OACA;AAab,KAAK,UAAU,WAAW,CAAC,MAAkB,EAAE,EAAM;IAC1D,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAE3C,IAAI,CAAC,CAAC,KAAK,YAAY,yBAAW,CAAC,EAAE;QACnC,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;QACzC,MAAM,KAAK,CAAC,YAAY,EAAE,gBAAgB,OAAO,iCAAiC,CAAC,CAAC;KACrF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AARD,kCAQC;AAED,YAAQ,CAAC,eAAe,EAAE,yBAAW,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AACA,8BAA8C;AAC9C,+CAA4C;AACnC,4FADA,yBAAW,OACA;AAcb,KAAK,UAAU,WAAW,CAAC,MAAkB,EAAE,EAAM;IAC1D,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAE3C,IAAI,CAAC,CAAC,KAAK,YAAY,yBAAW,CAAC,EAAE;QACnC,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;QACzC,MAAM,KAAK,CAAC,eAAe,EAAE,YAAY,KAAK,CAAC,WAAW,CAAC,IAAI,SAAS,OAAO,mBAAmB,yBAAW,CAAC,IAAI,EAAE,CAAC,CAAC;KACvH;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AARD,kCAQC;AAED,YAAQ,CAAC,eAAe,EAAE,yBAAW,CAAC,CAAC"}

package/elements/oj-input-text/index.ts

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

package/elements/oj-input-time/OjInputTime.js.map

@@ -1 +1 @@
-{"version":3,"file":"OjInputTime.js","sourceRoot":"","sources":["OjInputTime.ts"],"names":[],"mappings":";;;AAAA,uDAAkD;AAClD,uDAAyD;AASzD,MAAa,WAAY,SAAQ,iCAAe;CAE/C;AAFD,kCAEC;AACD,8BAAgB,CAAC,WAAW,CAAC,CAAC"}
+{"version":3,"file":"OjInputTime.js","sourceRoot":"","sources":["OjInputTime.ts"],"names":[],"mappings":";;;AAAA,uDAAkD;AAClD,uDAAyD;AAOzD,MAAa,WAAY,SAAQ,iCAAe;CAE/C;AAFD,kCAEC;AACD,8BAAgB,CAAC,WAAW,CAAC,CAAC"}