@oracle/oraclejet-webdriver 17.1.4 → 18.0.1

package/elements/oj-range-slider/OjRangeSliderBase.js

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OjRangeSliderBase = void 0;
+const __1 = require("../");
+/**
+ * This is the base class for oj-range-slider WebElement, and is generated from the
+ * component's metadata. Do not modify these contents since they'll be replaced
+ * during the next generation.
+ * Put overrides into the WebElements's subclass, OjRangeSlider.ts.
+ */
+class OjRangeSliderBase extends __1.OjWebElement {
+    /**
+     * 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 <code>describedBy</code> property.
+     *
+     */
+    getDescribedBy() {
+        return this.getProperty('describedBy');
+    }
+    /**
+     * Gets the value of <code>disabled</code> property.
+     * Specifies whether the component is disabled. The default is false.
+     * @return The value of <code>disabled</code> property.
+     *
+     */
+    getDisabled() {
+        return this.getProperty('disabled');
+    }
+    /**
+     * 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 <code>displayOptions</code> property.
+     *
+     */
+    getDisplayOptions() {
+        return this.getProperty('displayOptions');
+    }
+    /**
+     * Gets the value of <code>help</code> property.
+     * Form component help information.
+     * @return The value of <code>help</code> property.
+     *
+     */
+    getHelp() {
+        return this.getProperty('help');
+    }
+    /**
+     * 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 <code>helpHints</code> property.
+     *
+     */
+    getHelpHints() {
+        return this.getProperty('helpHints');
+    }
+    /**
+     * 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 <code>labelEdge</code> property.
+     *
+     */
+    getLabelEdge() {
+        return this.getProperty('labelEdge');
+    }
+    /**
+     * 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 <code>labelHint</code> property.
+     *
+     */
+    getLabelHint() {
+        return this.getProperty('labelHint');
+    }
+    /**
+     * Gets the value of <code>labelledBy</code> property.
+     * The oj-label sets the labelledBy property programmatically on the form component.
+     * @return The value of <code>labelledBy</code> property.
+     *
+     */
+    getLabelledBy() {
+        return this.getProperty('labelledBy');
+    }
+    /**
+     * Gets the value of <code>max</code> property.
+     * The maximum value of the range slider. See the Help documentation for more information.
+     * @return The value of <code>max</code> property.
+     *
+     */
+    getMax() {
+        return this.getProperty('max');
+    }
+    /**
+     * 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 <code>messagesCustom</code>
+     *
+     */
+    changeMessagesCustom(messagesCustom) {
+        return this.setProperty('messagesCustom', messagesCustom);
+    }
+    /**
+     * 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 <code>messagesCustom</code> property.
+     *
+     */
+    getMessagesCustom() {
+        return this.getProperty('messagesCustom');
+    }
+    /**
+     * Gets the value of <code>min</code> property.
+     * The minimum value of the range slider. See the Help documentation for more information.
+     * @return The value of <code>min</code> property.
+     *
+     */
+    getMin() {
+        return this.getProperty('min');
+    }
+    /**
+     * Gets the value of <code>orientation</code> property.
+     * Specifies the orientation of the range slider.
+     * @return The value of <code>orientation</code> property.
+     *
+     */
+    getOrientation() {
+        return this.getProperty('orientation');
+    }
+    /**
+     * Gets the value of <code>step</code> property.
+     * Specifies the amount to increase or decrease the value when moving in step increments. See the Help documentation for more information.
+     * @return The value of <code>step</code> property.
+     *
+     */
+    getStep() {
+        return this.getProperty('step');
+    }
+    /**
+     * Gets the value of <code>transientValue</code> property.
+     * Read-only property used for retrieving the transient value from the component. See the Help documentation for more information.
+     * @return The value of <code>transientValue</code> property.
+     *
+     */
+    getTransientValue() {
+        return this.getProperty('transientValue');
+    }
+    /**
+     * 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 <code>translations</code> property.
+     *
+     */
+    getTranslations() {
+        return this.getProperty('translations');
+    }
+    /**
+     * Gets the value of <code>userAssistanceDensity</code> property.
+     * Specifies the density of the form component's user assistance presentation.
+     * @return The value of <code>userAssistanceDensity</code> property.
+     *
+     */
+    getUserAssistanceDensity() {
+        return this.getProperty('userAssistanceDensity');
+    }
+    /**
+     * Gets the value of <code>valid</code> property.
+     * The validity state of the component
+     * @return The value of <code>valid</code> property.
+     *
+     */
+    getValid() {
+        return this.getProperty('valid');
+    }
+    /**
+     * Sets the value of <code>value</code> property.
+     * The numerical value of the range-slider.
+     * @param value The value to set for <code>value</code>
+     *
+     */
+    changeValue(value) {
+        return this.setProperty('value', value);
+    }
+    /**
+     * Gets the value of <code>value</code> property.
+     * The numerical value of the range-slider.
+     * @return The value of <code>value</code> property.
+     *
+     */
+    getValue() {
+        return this.getProperty('value');
+    }
+}
+exports.OjRangeSliderBase = OjRangeSliderBase;
+//# sourceMappingURL=OjRangeSliderBase.js.map

package/elements/oj-range-slider/OjRangeSliderBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OjRangeSliderBase.js","sourceRoot":"","sources":["../../src/elements/oj-range-slider/OjRangeSliderBase.ts"],"names":[],"mappings":";;;AAAA,2BAAmC;AAEnC;;;;;GAKG;AACH,MAAa,iBAAkB,SAAQ,gBAAY;IACjD;;;;;OAKG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,WAAW,CAAS,aAAa,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,WAAW,CAAU,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAiB,gBAAgB,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,CAAO,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,WAAW,CAAY,WAAW,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,WAAW,CAAS,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,WAAW,CAAS,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,aAAa;QAClB,OAAO,IAAI,CAAC,WAAW,CAAgB,YAAY,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,WAAW,CAAS,KAAK,CAAC,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,oBAAoB,CAAC,cAA6B;QACvD,OAAO,IAAI,CAAC,WAAW,CAAgB,gBAAgB,EAAE,cAAc,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IACI,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAgB,gBAAgB,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,WAAW,CAAS,KAAK,CAAC,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,WAAW,CAAS,aAAa,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,CAAS,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAwB,gBAAgB,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACI,eAAe;QACpB,OAAO,IAAI,CAAC,WAAW,CAAsB,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACI,wBAAwB;QAC7B,OAAO,IAAI,CAAC,WAAW,CAAS,uBAAuB,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,WAAW,CAAS,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,KAAmB;QACpC,OAAO,IAAI,CAAC,WAAW,CAAe,OAAO,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,WAAW,CAAe,OAAO,CAAC,CAAC;IACjD,CAAC;CACF;AAxMD,8CAwMC"}

package/elements/oj-range-slider/index.d.ts

@@ -0,0 +1,17 @@
+import { By } from 'selenium-webdriver';
+import { DriverLike } from '../../';
+import { OjRangeSlider } from './OjRangeSlider';
+export { OjRangeSlider };
+/**
+ * Retrieve an instance of [OjRangeSlider](../classes/elements.OjRangeSlider.html).
+ * @example
+ * ```javascript
+ * import { ojRangeSlider } from '@oracle/oraclejet-webdriver/elements';
+ * const el = await ojRangeSlider(driver, By.id('my-oj-range-slider'));
+ * ```
+ * @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 declare function ojRangeSlider(driver: DriverLike, by: By): Promise<OjRangeSlider>;

package/elements/oj-range-slider/index.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OjRangeSlider = void 0;
+exports.ojRangeSlider = ojRangeSlider;
+const __1 = require("../../");
+const OjRangeSlider_1 = require("./OjRangeSlider");
+Object.defineProperty(exports, "OjRangeSlider", { enumerable: true, get: function () { return OjRangeSlider_1.OjRangeSlider; } });
+/**
+ * Retrieve an instance of [OjRangeSlider](../classes/elements.OjRangeSlider.html).
+ * @example
+ * ```javascript
+ * import { ojRangeSlider } from '@oracle/oraclejet-webdriver/elements';
+ * const el = await ojRangeSlider(driver, By.id('my-oj-range-slider'));
+ * ```
+ * @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
+ */
+async function ojRangeSlider(driver, by) {
+    const webEl = await driver.findElement(by);
+    // Check that the element is of type OjRangeSlider
+    if (!(webEl instanceof OjRangeSlider_1.OjRangeSlider)) {
+        const tagName = await webEl.getTagName();
+        let supplemental = '';
+        if (webEl.constructor.name === 'OjRangeSlider') {
+            supplemental = 'You likely have multiple installations of this package.';
+        }
+        throw Error(`ojRangeSlider(${by}) created ${webEl.constructor.name} for <${tagName}>, but expected ${OjRangeSlider_1.OjRangeSlider.name}. ${supplemental}`);
+    }
+    return webEl;
+}
+(0, __1.register)('oj-range-slider', OjRangeSlider_1.OjRangeSlider);
+//# sourceMappingURL=index.js.map

package/elements/oj-range-slider/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/elements/oj-range-slider/index.ts"],"names":[],"mappings":";;;AAiBA,sCAcC;AA9BD,8BAA8C;AAC9C,mDAAgD;AACvC,8FADA,6BAAa,OACA;AAEtB;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,aAAa,CAAC,MAAkB,EAAE,EAAM;IAC5D,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC3C,kDAAkD;IAClD,IAAI,CAAC,CAAC,KAAK,YAAY,6BAAa,CAAC,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;QACzC,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;YAC/C,YAAY,GAAG,yDAAyD,CAAC;QAC3E,CAAC;QACD,MAAM,KAAK,CACT,iBAAiB,EAAE,aAAa,KAAK,CAAC,WAAW,CAAC,IAAI,SAAS,OAAO,mBAAmB,6BAAa,CAAC,IAAI,KAAK,YAAY,EAAE,CAC/H,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,IAAA,YAAQ,EAAC,iBAAiB,EAAE,6BAAa,CAAC,CAAC"}

package/elements/oj-rating-gauge/OjRatingGauge.d.ts

@@ -0,0 +1,18 @@
+import { OjRatingGaugeBase } from './OjRatingGaugeBase';
+/**
+ * The component WebElement for [oj-rating-gauge](../../jsdocs/oj.ojRatingGauge.html).
+ * Do not instantiate this class directly, instead, use
+ * [ojRatingGauge](../functions/elements.ojRatingGauge-1.html).
+ */
+/**
+ * The component WebElement for [oj-rating-gauge](../../jsdocs/oj.ojRatingGauge.html).
+ * Do not instantiate this class directly, instead, use
+ * [ojRatingGauge](../functions/elements.ojRatingGauge-1.html).
+ *  <h4>Migration</h4>
+ *  When you migrate a page from using [oj-rating-guage](../../jsdocs/oj.ojRatingGauge.html) to [oj-c-rating-gauge](../../jsdocs/oj-c.RatingGauge.html) you will also need to migrate your WebDriver tests from OjRatingGauge to RatingGaugeWebElement. To do that you will need to revise type and locator instances as follows
+ *  </br><b>Type:</b> from OjRatingGauge to [RatingGaugeWebElement](../../cpwdtsdoc/classes/RatingGaugeWebElement.html)
+ *  </br><b>Locator:</b> from [ojRatingGauge](../functions/elements.ojRatingGauge-1.html) to [findRatingGauge](../../cpwdtsdoc/functions/findRatingGauge.html)
+ *  </br>For more details on migrating from legacy to core pack please see component's [migration section](../../jsdocs/oj.ojRatingGauge.html#migration-section)
+ */
+export declare class OjRatingGauge extends OjRatingGaugeBase {
+}

package/elements/oj-rating-gauge/OjRatingGauge.js

@@ -7,6 +7,16 @@ const OjRatingGaugeBase_1 = require("./OjRatingGaugeBase");
  * Do not instantiate this class directly, instead, use
  * [ojRatingGauge](../functions/elements.ojRatingGauge-1.html).
  */
+/**
+ * The component WebElement for [oj-rating-gauge](../../jsdocs/oj.ojRatingGauge.html).
+ * Do not instantiate this class directly, instead, use
+ * [ojRatingGauge](../functions/elements.ojRatingGauge-1.html).
+ *  <h4>Migration</h4>
+ *  When you migrate a page from using [oj-rating-guage](../../jsdocs/oj.ojRatingGauge.html) to [oj-c-rating-gauge](../../jsdocs/oj-c.RatingGauge.html) you will also need to migrate your WebDriver tests from OjRatingGauge to RatingGaugeWebElement. To do that you will need to revise type and locator instances as follows
+ *  </br><b>Type:</b> from OjRatingGauge to [RatingGaugeWebElement](../../cpwdtsdoc/classes/RatingGaugeWebElement.html)
+ *  </br><b>Locator:</b> from [ojRatingGauge](../functions/elements.ojRatingGauge-1.html) to [findRatingGauge](../../cpwdtsdoc/functions/findRatingGauge.html)
+ *  </br>For more details on migrating from legacy to core pack please see component's [migration section](../../jsdocs/oj.ojRatingGauge.html#migration-section)
+ */
 class OjRatingGauge extends OjRatingGaugeBase_1.OjRatingGaugeBase {
 }
 exports.OjRatingGauge = OjRatingGauge;

package/elements/oj-rating-gauge/OjRatingGauge.js.map

@@ -1 +1 @@
-{"version":3,"file":"OjRatingGauge.js","sourceRoot":"","sources":["../../../elements/oj-rating-gauge/OjRatingGauge.ts"],"names":[],"mappings":";;;AAAA,2DAAwD;AAExD;;;;GAIG;AACH,MAAa,aAAc,SAAQ,qCAAiB;CAEnD;AAFD,sCAEC"}
+{"version":3,"file":"OjRatingGauge.js","sourceRoot":"","sources":["../../src/elements/oj-rating-gauge/OjRatingGauge.ts"],"names":[],"mappings":";;;AAAA,2DAAwD;AAExD;;;;GAIG;AAEH;;;;;;;;;GASG;AACH,MAAa,aAAc,SAAQ,qCAAiB;CAEnD;AAFD,sCAEC"}