@oracle/oraclejet-webdriver 10.1.7

package/elements/oj-combobox-many/OjComboboxManyBase.ts

@@ -0,0 +1,428 @@
+import {OjWebElement} from "../";
+
+/**
+ * This is the base class for OjComboboxMany, and is generated from
+ * the component metadata.  Do not put overrides in here as the
+ * contents are meant to be replaced by the generated functions.
+ * Put overrides into the component's default class, found in
+ * index.ts.
+ */
+export class OjComboboxManyBase extends OjWebElement {
+  /**
+   * Gets the value of "asyncValidators" 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.
+   */
+  public getAsyncValidators(): Promise<Array<object>> {
+    return this.getProperty<Array<object>>("asyncValidators");
+  }
+
+  /**
+   * Gets the value of "converter" property.
+   * An object that converts the value. See the Help documentation for more information.
+   * @return The value of "converter" property.
+   */
+  public getConverter(): Promise<object|null> {
+    return this.getProperty<object|null>("converter");
+  }
+
+  /**
+   * Gets the value of "describedBy" 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.
+   */
+  public getDescribedBy(): Promise<string> {
+    return this.getProperty<string>("describedBy");
+  }
+
+  /**
+   * Gets the value of "disabled" property.
+   * Specifies whether the component is disabled. The default is false.
+   * @return The value of "disabled" property.
+   */
+  public getDisabled(): Promise<boolean> {
+    return this.getProperty<boolean>("disabled");
+  }
+
+  /**
+   * Gets the value of "displayOptions" property.
+   * Display options for auxiliary content that determines whether or not it should be displayed.
+   * @return The value of "displayOptions" property.
+   */
+  public getDisplayOptions(): Promise<OjComboboxManyBase.DisplayOptions> {
+    return this.getProperty<OjComboboxManyBase.DisplayOptions>("displayOptions");
+  }
+
+  /**
+   * Gets the value of "help" property.
+   * Form component help information.
+   * @return The value of "help" property.
+   */
+  public getHelp(): Promise<OjComboboxManyBase.Help> {
+    return this.getProperty<OjComboboxManyBase.Help>("help");
+  }
+
+  /**
+   * Gets the value of "helpHints" 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.
+   */
+  public getHelpHints(): Promise<OjComboboxManyBase.HelpHints> {
+    return this.getProperty<OjComboboxManyBase.HelpHints>("helpHints");
+  }
+
+  /**
+   * Gets the value of "labelEdge" property.
+   * Defines how the label of a component is created. See the Help documentation for more information.
+   * @return The value of "labelEdge" property.
+   */
+  public getLabelEdge(): Promise<string> {
+    return this.getProperty<string>("labelEdge");
+  }
+
+  /**
+   * Gets the value of "labelHint" property.
+   * Represents a hint for oj-form-layout element to render a label on the editable component.
+   * @return The value of "labelHint" property.
+   */
+  public getLabelHint(): Promise<string> {
+    return this.getProperty<string>("labelHint");
+  }
+
+  /**
+   * Gets the value of "labelledBy" property.
+   * The oj-label sets the labelledBy property programmatically on the form component.
+   * @return The value of "labelledBy" property.
+   */
+  public getLabelledBy(): Promise<string|null> {
+    return this.getProperty<string|null>("labelledBy");
+  }
+
+  /**
+   * Gets the value of "maximumResultCount" property.
+   * The maximum number of results displayed in the dropdown.
+   * @return The value of "maximumResultCount" property.
+   */
+  public getMaximumResultCount(): Promise<number> {
+    return this.getProperty<number>("maximumResultCount");
+  }
+
+  /**
+   * Sets the value of "messagesCustom" 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"
+   */
+  public changeMessagesCustom(messagesCustom: Array<object>): Promise<void> {
+    return this.setProperty<Array<object>>("messagesCustom", messagesCustom);
+  }
+
+  /**
+   * Gets the value of "messagesCustom" 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.
+   */
+  public getMessagesCustom(): Promise<Array<object>> {
+    return this.getProperty<Array<object>>("messagesCustom");
+  }
+
+  /**
+   * Gets the value of "minLength" property.
+   * The minimum number of characters a user must type before search filtering is performed.
+   * @return The value of "minLength" property.
+   */
+  public getMinLength(): Promise<number> {
+    return this.getProperty<number>("minLength");
+  }
+
+  /**
+   * Gets the value of "optionRenderer" property.
+   * The renderer function that renders the content of each option.
+   * @return The value of "optionRenderer" property.
+   */
+  public getOptionRenderer(): Promise<null|null> {
+    return this.getProperty<null|null>("optionRenderer");
+  }
+
+  /**
+   * Gets the value of "options" property.
+   * The option items for the Combobox.
+   * @return The value of "options" property.
+   */
+  public getOptions(): Promise<Array<object>|object|null> {
+    return this.getProperty<Array<object>|object|null>("options");
+  }
+
+  /**
+   * Gets the value of "optionsKeys" property.
+   * Specify the key names to use in the options array. Depending on options-keys means that the signature of the data does not match what is supported by the options attribute.
+   * @return The value of "optionsKeys" property.
+   */
+  public getOptionsKeys(): Promise<OjComboboxManyBase.OptionsKeys> {
+    return this.getProperty<OjComboboxManyBase.OptionsKeys>("optionsKeys");
+  }
+
+  /**
+   * Gets the value of "pickerAttributes" property.
+   * The style attributes for the drop down.
+   * @return The value of "pickerAttributes" property.
+   */
+  public getPickerAttributes(): Promise<OjComboboxManyBase.PickerAttributes> {
+    return this.getProperty<OjComboboxManyBase.PickerAttributes>("pickerAttributes");
+  }
+
+  /**
+   * Gets the value of "placeholder" property.
+   * A short hint that can be displayed before user selects or enters a value.
+   * @return The value of "placeholder" property.
+   */
+  public getPlaceholder(): Promise<string|null> {
+    return this.getProperty<string|null>("placeholder");
+  }
+
+  /**
+   * Gets the value of "rawValue" property.
+   * The currently displayed text retrieved from the input field.
+   * @return The value of "rawValue" property.
+   */
+  public getRawValue(): Promise<Array<string>> {
+    return this.getProperty<Array<string>>("rawValue");
+  }
+
+  /**
+   * Gets the value of "readonly" 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.
+   */
+  public getReadonly(): Promise<boolean> {
+    return this.getProperty<boolean>("readonly");
+  }
+
+  /**
+   * Gets the value of "required" property.
+   * Specifies whether a value is required.
+   * @return The value of "required" property.
+   */
+  public getRequired(): Promise<boolean> {
+    return this.getProperty<boolean>("required");
+  }
+
+  /**
+   * Gets the value of "translations" property.
+   * A collection of translated resources from the translation bundle, or null if this component has no resources.
+   * @return The value of "translations" property.
+   */
+  public getTranslations(): Promise<OjComboboxManyBase.Translations|null> {
+    return this.getProperty<OjComboboxManyBase.Translations|null>("translations");
+  }
+
+  /**
+   * Gets the value of "userAssistanceDensity" property.
+   * Specifies the density of the form component's user assistance presentation.
+   * @return The value of "userAssistanceDensity" property.
+   */
+  public getUserAssistanceDensity(): Promise<string> {
+    return this.getProperty<string>("userAssistanceDensity");
+  }
+
+  /**
+   * Gets the value of "valid" property.
+   * The validity state of the component
+   * @return The value of "valid" property.
+   */
+  public getValid(): Promise<string> {
+    return this.getProperty<string>("valid");
+  }
+
+  /**
+   * Gets the value of "validators" 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.
+   */
+  public getValidators(): Promise<Array<unknown>> {
+    return this.getProperty<Array<unknown>>("validators");
+  }
+
+  /**
+   * Sets the value of "value" property.
+   * The value of the element.
+   * @param value The value to set for "value"
+   */
+  public changeValue(value: Array<any>|null): Promise<void> {
+    return this.setProperty<Array<any>|null>("value", value);
+  }
+
+  /**
+   * Gets the value of "value" property.
+   * The value of the element.
+   * @return The value of "value" property.
+   */
+  public getValue(): Promise<Array<any>|null> {
+    return this.getProperty<Array<any>|null>("value");
+  }
+
+  /**
+   * Sets the value of "valueOptions" property.
+   * The current values of the element and their associated display labels.
+   * @param valueOptions The value to set for "valueOptions"
+   */
+  public changeValueOptions(valueOptions: null|Array<OjComboboxManyBase.ValueOptions>): Promise<void> {
+    return this.setProperty<null|Array<OjComboboxManyBase.ValueOptions>>("valueOptions", valueOptions);
+  }
+
+  /**
+   * Gets the value of "valueOptions" property.
+   * The current values of the element and their associated display labels.
+   * @return The value of "valueOptions" property.
+   */
+  public getValueOptions(): Promise<null|Array<OjComboboxManyBase.ValueOptions>> {
+    return this.getProperty<null|Array<OjComboboxManyBase.ValueOptions>>("valueOptions");
+  }
+
+}
+
+namespace OjComboboxManyBase {
+  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 OptionsKeys {
+    /**
+     * The object for the child keys. It is ignored when using a TreeDataProvider.
+     */
+    "childKeys": OjComboboxManyBase.OptionsKeysChildKeys;
+    /**
+     * The key name for the children. It is ignored when using a TreeDataProvider.
+     */
+    "children": string;
+    /**
+     * The key name for the label.
+     */
+    "label": string;
+    /**
+     * The key name for the value.
+     */
+    "value": string;
+  }
+  export interface OptionsKeysChildKeys {
+    /**
+     * The object for the child keys.
+     */
+    "childKeys": OjComboboxManyBase.OptionsKeysChildKeysChildKeys;
+    /**
+     * The key name for the children.
+     */
+    "children": string;
+    /**
+     * The key name for the label.
+     */
+    "label": string;
+    /**
+     * The key name for the value.
+     */
+    "value": string;
+  }
+  export interface OptionsKeysChildKeysChildKeys {
+    /**
+     * The object for the child keys.
+     */
+    "childKeys": object;
+    /**
+     * The key name for the children.
+     */
+    "children": string;
+    /**
+     * The key name for the label.
+     */
+    "label": string;
+    /**
+     * The key name for the value.
+     */
+    "value": string;
+  }
+  export interface PickerAttributes {
+    /**
+     * The css class to append to the picker.
+     */
+    "class": string;
+    /**
+     * The css style to append to the picker.
+     */
+    "style": string;
+  }
+  export interface Translations {
+    /**
+     * Text at the top of drop down when not all results are fetched and users need to filter further.
+     */
+    "filterFurther": string;
+    /**
+     * Text for the drop down when more than one options are found.
+     */
+    "moreMatchesFound": string;
+    /**
+     * No options found text for drop down.
+     */
+    "noMatchesFound": string;
+    /**
+     * Text for the drop down when one option is found.
+     */
+    "oneMatchesFound": string;
+    /**
+     * 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": OjComboboxManyBase.TranslationsRequired;
+  }
+  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 ValueOptions {
+    /**
+     * display label of value above. If missing, String(value) is used.
+     */
+    "label": string;
+    /**
+     * the current value of JET Combobox
+     */
+    "value": any;
+  }
+}

package/elements/oj-combobox-many/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ojComboboxMany = exports.OjComboboxMany = void 0;
+const __1 = require("../../");
+const OjComboboxMany_1 = require("./OjComboboxMany");
+Object.defineProperty(exports, "OjComboboxMany", { enumerable: true, get: function () { return OjComboboxMany_1.OjComboboxMany; } });
+async function ojComboboxMany(driver, by) {
+    const webEl = await __1.default.waitAndFindElement(driver, by);
+    if (!(webEl instanceof OjComboboxMany_1.OjComboboxMany)) {
+        const tagName = await webEl.getTagName();
+        throw Error(`Locator '${by}' located a <${tagName}>, but expected <oj-combobox-many>`);
+    }
+    return webEl;
+}
+exports.ojComboboxMany = ojComboboxMany;
+__1.register("oj-combobox-many", OjComboboxMany_1.OjComboboxMany);
+//# sourceMappingURL=index.js.map

package/elements/oj-combobox-many/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../rt/src/test/webdriverjs/oraclejet-webdriver/elements/oj-combobox-many/index.ts"],"names":[],"mappings":";;;AACA,8BAAkD;AAClD,qDAAgD;AACtB,+FADlB,+BAAc,OACkB;AAajC,KAAK,UAAU,cAAc,CAAC,MAAkB,EAAE,EAAM;IAC7D,MAAM,KAAK,GAAe,MAAM,WAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,EAAE,CAAmB,CAAC;IAEtF,IAAI,CAAC,CAAC,KAAK,YAAY,+BAAc,CAAC,EAAE;QACtC,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;QACzC,MAAM,KAAK,CAAC,YAAY,EAAE,gBAAgB,OAAO,oCAAoC,CAAC,CAAC;KACxF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AARD,wCAQC;AAED,YAAQ,CAAC,kBAAkB,EAAE,+BAAc,CAAC,CAAC"}

package/elements/oj-combobox-many/index.ts

@@ -0,0 +1,27 @@
+import {By, WebElement} from "selenium-webdriver";
+import ojwd, {DriverLike, register} from "../../";
+import {OjComboboxMany} from "./OjComboboxMany";
+export {OjComboboxMany as OjComboboxMany};
+
+/**
+ * Create an instance of [[OjComboboxMany]].  This function will first wait for
+ * the element to appear in the DOM before trying to locate it.
+ * @example
+ * <code>
+ * const el = await ojComboboxMany(driver, By.id('my-oj-combobox-many'))
+ * </code>
+ * @param driver A WebDriver/WebElement instance used to locate the component
+ * element.
+ * @param by The By locator with which to find the element
+ */
+export async function ojComboboxMany(driver: DriverLike, by: By): Promise<OjComboboxMany> {
+  const webEl: WebElement = await ojwd.waitAndFindElement(driver, by) as OjComboboxMany;
+  // Check that the element is of type OjComboboxMany
+  if (!(webEl instanceof OjComboboxMany)) {
+    const tagName = await webEl.getTagName();
+    throw Error(`Locator '${by}' located a <${tagName}>, but expected <oj-combobox-many>`);
+  }
+  return webEl;
+}
+
+register("oj-combobox-many", OjComboboxMany);

package/elements/oj-combobox-one/OjComboboxOne.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OjComboboxOne = void 0;
+const selenium_webdriver_1 = require("selenium-webdriver");
+const OjComboboxOneBase_1 = require("./OjComboboxOneBase");
+class OjComboboxOne extends OjComboboxOneBase_1.OjComboboxOneBase {
+    async changeValue(value) {
+        await this.getDriver().executeScript("arguments[0].focus()", this);
+        const readonly = await this.getReadonly();
+        const disabled = await this.getDisabled();
+        if (!(readonly || disabled)) {
+            await this.whenBusyContextReady();
+            const isValueSet = await this.getDriver().executeAsyncScript(`
+        var element = arguments[0];
+        var value = arguments[1];
+
+        // Last argument will the done function
+        var doneFunc = arguments[arguments.length - 1];
+        
+        var onSuccess = doneFunc.bind(null, true);
+        var onFailure = doneFunc.bind(null, false);
+        var onError = doneFunc.bind(null, false);
+        
+        require(['ojs/ojcustomelement-utils'], function (utils) {
+          // Retrieve the widget instance from the element
+          var bridge = utils.CustomElementUtils.getElementBridge(element);
+          var widget = bridge._WIDGET_INSTANCE.combobox;
+          widget._selectItemByValue(value)
+            .then(onSuccess, onFailure)
+            .catch(onFailure);
+        });
+      `, this, value);
+            if (isValueSet === false) {
+                console.warn("Failed to update value by interaction. Falling back to setProperty.");
+                await this._changeValueFallback(value);
+            }
+        }
+    }
+    async clear() {
+        const input = await this.findElement(selenium_webdriver_1.By.css(".oj-combobox-input"));
+        await input.clear();
+        await input.sendKeys(selenium_webdriver_1.Key.ENTER);
+    }
+    _changeValueFallback(value) {
+        return this.setProperty("value", value);
+    }
+}
+exports.OjComboboxOne = OjComboboxOne;
+//# sourceMappingURL=OjComboboxOne.js.map

package/elements/oj-combobox-one/OjComboboxOne.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OjComboboxOne.js","sourceRoot":"","sources":["../../../../rt/src/test/webdriverjs/oraclejet-webdriver/elements/oj-combobox-one/OjComboboxOne.ts"],"names":[],"mappings":";;;AAAA,2DAA6C;AAC7C,2DAAsD;AAStD,MAAa,aAAc,SAAQ,qCAAiB;IAOlD,KAAK,CAAC,WAAW,CAAC,KAAU;QAE1B,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;QAEnE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1C,IAAI,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,EAAE;YAC3B,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAClC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,kBAAkB,CAAC;;;;;;;;;;;;;;;;;;;OAmB5D,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAGhB,IAAI,UAAU,KAAK,KAAK,EAAE;gBACxB,OAAO,CAAC,IAAI,CAAC,qEAAqE,CAAC,CAAC;gBACpF,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;aACxC;SACF;IACH,CAAC;IAMD,KAAK,CAAC,KAAK;QACT,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,uBAAE,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACnE,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QACpB,MAAM,KAAK,CAAC,QAAQ,CAAC,wBAAG,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAQO,oBAAoB,CAAC,KAAU;QACrC,OAAO,IAAI,CAAC,WAAW,CAAM,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;CACF;AA/DD,sCA+DC"}

package/elements/oj-combobox-one/OjComboboxOne.ts

@@ -0,0 +1,74 @@
+import { By, Key } from "selenium-webdriver";
+import {OjComboboxOneBase} from "./OjComboboxOneBase";
+
+/**
+ * This is the component WebElement for oj-combobox-one. Retrieve an instance of the class
+ * using its convenience function:
+ * ```javascript
+ * await ojComboboxOne(driver, By.css('oj-combobox-one'))
+ * ```
+ */
+export class OjComboboxOne extends OjComboboxOneBase {
+  /**
+   * Sets the value of "value" property.
+   * The value of the element.
+   * @param value The value to set for "value"
+   * @override
+   */
+  async changeValue(value: any) {
+    // Call focus() on the root element
+    await this.getDriver().executeScript("arguments[0].focus()", this);
+    // Only mutate if not readonly/disabled
+    const readonly = await this.getReadonly();
+    const disabled = await this.getDisabled();
+    if (!(readonly || disabled)) {
+      await this.whenBusyContextReady();
+      const isValueSet = await this.getDriver().executeAsyncScript(`
+        var element = arguments[0];
+        var value = arguments[1];
+
+        // Last argument will the done function
+        var doneFunc = arguments[arguments.length - 1];
+        
+        var onSuccess = doneFunc.bind(null, true);
+        var onFailure = doneFunc.bind(null, false);
+        var onError = doneFunc.bind(null, false);
+        
+        require(['ojs/ojcustomelement-utils'], function (utils) {
+          // Retrieve the widget instance from the element
+          var bridge = utils.CustomElementUtils.getElementBridge(element);
+          var widget = bridge._WIDGET_INSTANCE.combobox;
+          widget._selectItemByValue(value)
+            .then(onSuccess, onFailure)
+            .catch(onFailure);
+        });
+      `, this, value);
+      
+      // If failed to set value, fallback to setProperty
+      if (isValueSet === false) {
+        console.warn("Failed to update value by interaction. Falling back to setProperty.");
+        await this._changeValueFallback(value);
+      }
+    }
+  }
+  
+  /**
+   * Clears the value
+   * @override
+   */
+  async clear(): Promise<void> {
+    const input = await this.findElement(By.css(".oj-combobox-input"));
+    await input.clear();
+    await input.sendKeys(Key.ENTER);
+  }
+  
+  /**
+   * This is a fallback mechanism for setting a value which
+   * uses the setProperty method to update the value.
+   *
+   * @param value The value to be set
+   */
+  private _changeValueFallback(value: any): Promise<void> {
+    return this.setProperty<any>("value", value);
+  }
+}