@oracle/oraclejet-webdriver 11.0.9 → 12.0.0

package/elements/oj-legend/index.ts

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

package/elements/oj-list-view/OjListView.js

@@ -4,6 +4,24 @@ exports.OjListView = void 0;
 const OjListViewBase_1 = require("./OjListViewBase");
 const __1 = require("../../");
 class OjListView extends OjListViewBase_1.OjListViewBase {
+    async changeSelected(selected) {
+        await this.whenReady();
+        await this.getDriver().executeScript(`
+        const ele = arguments[0];
+        const selected = arguments[1];
+        const keySet = require('ojs/ojkeyset');
+        ele.selected = new keySet.KeySetImpl(selected);
+      `, this, selected);
+    }
+    async getSelected() {
+        await this.whenReady();
+        const selected = await this.getDriver().executeScript(`
+      const ele = arguments[0];
+      const selected = Array.from(ele.selected.values())
+      return selected;
+    `, this);
+        return selected;
+    }
     async findItem(itemLocator) {
         await this.setProperty('scrollToKey', 'always');
         await this.changeScrollPosition({
@@ -17,9 +35,9 @@ class OjListView extends OjListViewBase_1.OjListViewBase {
         });
         await this.whenBusyContextReady();
         const el = await this.getDriver().executeScript(`
-    return arguments[0].getNodeBySubId({ subId: 'oj-listview-item', key: ${JSON.stringify(itemLocator.key)} })
+    return arguments[0].getNodeBySubId({ subId: 'oj-listview-item', key: arguments[1] })
       .querySelector('[role=gridcell]')
-    `, this);
+    `, this, itemLocator.key);
         return __1.slotProxy(el, this);
     }
 }

package/elements/oj-list-view/OjListView.js.map

@@ -1 +1 @@
-{"version":3,"file":"OjListView.js","sourceRoot":"","sources":["OjListView.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAClD,8BAA8C;AAU9C,MAAa,UAAW,SAAQ,+BAAc;IAK5C,KAAK,CAAC,QAAQ,CAAI,WAAuB;QAGvC,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAGhD,MAAM,IAAI,CAAC,oBAAoB,CAAC;YAC9B,GAAG,EAAE,WAAW,CAAC,GAAG;YAEpB,KAAK,EAAE,SAAS;YAChB,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE,SAAS;YAClB,MAAM,EAAE,SAAS;YACjB,CAAC,EAAE,SAAS;YACZ,CAAC,EAAE,SAAS;SACb,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAClC,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,aAAa,CAAa;2EACW,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC;;KAErG,EAAE,IAAI,CAAC,CAAC;QACT,OAAO,aAAS,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF;AA5BD,gCA4BC"}
+{"version":3,"file":"OjListView.js","sourceRoot":"","sources":["OjListView.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAClD,8BAA8C;AAQ9C,MAAa,UAAW,SAAQ,+BAAc;IAQ5C,KAAK,CAAC,cAAc,CAAI,QAAkB;QACxC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC;;;;;OAKlC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACvB,CAAC;IASD,KAAK,CAAC,WAAW;QACf,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAa,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC;;;;KAI/D,EAAE,IAAI,CAAC,CAAC;QACT,OAAO,QAAQ,CAAC;IAClB,CAAC;IAMD,KAAK,CAAC,QAAQ,CAAI,WAAuB;QAGvC,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAGhD,MAAM,IAAI,CAAC,oBAAoB,CAAC;YAC9B,GAAG,EAAE,WAAW,CAAC,GAAG;YAEpB,KAAK,EAAE,SAAS;YAChB,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE,SAAS;YAClB,MAAM,EAAE,SAAS;YACjB,CAAC,EAAE,SAAS;YACZ,CAAC,EAAE,SAAS;SACb,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAClC,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,aAAa,CAAa;;;KAG3D,EAAE,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;QAC1B,OAAO,aAAS,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF;AA9DD,gCA8DC"}

package/elements/oj-list-view/OjListView.ts

@@ -3,13 +3,45 @@ import { slotProxy, SlotProxy } from "../../";
 import { WebElement } from "selenium-webdriver";
 
 /**
- * This is the component WebElement for oj-list-view. Retrieve an instance of the class
- * using its convenience function:
- * ```javascript
- * await ojListView(driver, By.css('oj-list-view'))
- * ```
+ * The component WebElement for [oj-list-view](../../jsdocs/oj.ojListView.html).
+ * Do not instantiate this class directly, instead, use
+ * [ojListView](../modules/elements.html#ojListView).
  */
 export class OjListView extends OjListViewBase {
+  /**
+   * Sets the value of "selected" property.
+   * Specifies the current selected items in the listview. See the Help documentation for more information.
+   * @param selected The value to set for "selected"
+   * @override
+   * @typeparam K Type of keys
+   */
+  async changeSelected<K>(selected: Array<K>) {
+    await this.whenReady();
+    await this.getDriver().executeScript(`
+        const ele = arguments[0];
+        const selected = arguments[1];
+        const keySet = require('ojs/ojkeyset');
+        ele.selected = new keySet.KeySetImpl(selected);
+      `, this, selected);
+  }
+
+  /**
+   * Gets the value of "selected" property.
+   * Retrieves the current selected items in the listview. See the Help documentation for more information.
+   * @override
+   * @typeparam K Type of keys
+   * @return The value of "selected" property.
+   */
+  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);
+    return selected;
+  }
+
   /**
    * Retrieve a SlotProxy which represents a single listview item.
    * @param key The key within the Collection's dataset associated with the item.
@@ -32,9 +64,9 @@ export class OjListView extends OjListViewBase {
     });
     await this.whenBusyContextReady();
     const el = await this.getDriver().executeScript<WebElement>(`
-    return arguments[0].getNodeBySubId({ subId: 'oj-listview-item', key: ${JSON.stringify(itemLocator.key)} })
+    return arguments[0].getNodeBySubId({ subId: 'oj-listview-item', key: arguments[1] })
       .querySelector('[role=gridcell]')
-    `, this);
+    `, this, itemLocator.key);
     return slotProxy(el, this);
   }
 }

package/elements/oj-list-view/OjListViewBase.js

@@ -4,67 +4,67 @@ exports.OjListViewBase = void 0;
 const __1 = require("../");
 class OjListViewBase extends __1.OjWebElement {
     getAs() {
-        return this.getProperty("as");
+        return this.getProperty('as');
     }
     changeCurrentItem(currentItem) {
-        return this.setProperty("currentItem", currentItem);
+        return this.setProperty('currentItem', currentItem);
     }
     getCurrentItem() {
-        return this.getProperty("currentItem");
+        return this.getProperty('currentItem');
     }
     getData() {
-        return this.getProperty("data");
+        return this.getProperty('data');
     }
     getDisplay() {
-        return this.getProperty("display");
+        return this.getProperty('display');
     }
     getDnd() {
-        return this.getProperty("dnd");
+        return this.getProperty('dnd');
     }
     getDrillMode() {
-        return this.getProperty("drillMode");
+        return this.getProperty('drillMode');
     }
     getFirstSelectedItem() {
-        return this.getProperty("firstSelectedItem");
+        return this.getProperty('firstSelectedItem');
     }
     getGridlines() {
-        return this.getProperty("gridlines");
+        return this.getProperty('gridlines');
     }
     getGroupHeaderPosition() {
-        return this.getProperty("groupHeaderPosition");
+        return this.getProperty('groupHeaderPosition');
     }
     getItem() {
-        return this.getProperty("item");
+        return this.getProperty('item');
     }
     getScrollPolicy() {
-        return this.getProperty("scrollPolicy");
+        return this.getProperty('scrollPolicy');
     }
     getScrollPolicyOptions() {
-        return this.getProperty("scrollPolicyOptions");
+        return this.getProperty('scrollPolicyOptions');
     }
     changeScrollPosition(scrollPosition) {
-        return this.setProperty("scrollPosition", scrollPosition);
+        return this.setProperty('scrollPosition', scrollPosition);
     }
     getScrollPosition() {
-        return this.getProperty("scrollPosition");
+        return this.getProperty('scrollPosition');
     }
     getScrollToKey() {
-        return this.getProperty("scrollToKey");
+        return this.getProperty('scrollToKey');
     }
     changeSelection(selection) {
-        return this.setProperty("selection", selection);
+        return this.setProperty('selection', selection);
     }
     getSelection() {
-        return this.getProperty("selection");
+        return this.getProperty('selection');
     }
     getSelectionMode() {
-        return this.getProperty("selectionMode");
+        return this.getProperty('selectionMode');
     }
     getSelectionRequired() {
-        return this.getProperty("selectionRequired");
+        return this.getProperty('selectionRequired');
     }
     getTranslations() {
-        return this.getProperty("translations");
+        return this.getProperty('translations');
     }
 }
 exports.OjListViewBase = OjListViewBase;

package/elements/oj-list-view/OjListViewBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"OjListViewBase.js","sourceRoot":"","sources":["OjListViewBase.ts"],"names":[],"mappings":";;;AAAA,2BAAiC;AASjC,MAAa,cAAe,SAAQ,gBAAY;IAOvC,KAAK;QACV,OAAO,IAAI,CAAC,WAAW,CAAS,IAAI,CAAC,CAAC;IACxC,CAAC;IAQM,iBAAiB,CAAC,WAAgB;QACvC,OAAO,IAAI,CAAC,WAAW,CAAM,aAAa,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;IAQM,cAAc;QACnB,OAAO,IAAI,CAAC,WAAW,CAAM,aAAa,CAAC,CAAC;IAC9C,CAAC;IAQM,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,CAAS,MAAM,CAAC,CAAC;IAC1C,CAAC;IAQM,UAAU;QACf,OAAO,IAAI,CAAC,WAAW,CAAS,SAAS,CAAC,CAAC;IAC7C,CAAC;IAQM,MAAM;QACX,OAAO,IAAI,CAAC,WAAW,CAAqB,KAAK,CAAC,CAAC;IACrD,CAAC;IAQM,YAAY;QACjB,OAAO,IAAI,CAAC,WAAW,CAAS,WAAW,CAAC,CAAC;IAC/C,CAAC;IAQM,oBAAoB;QACzB,OAAO,IAAI,CAAC,WAAW,CAAS,mBAAmB,CAAC,CAAC;IACvD,CAAC;IAQM,YAAY;QACjB,OAAO,IAAI,CAAC,WAAW,CAA2B,WAAW,CAAC,CAAC;IACjE,CAAC;IAQM,sBAAsB;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAS,qBAAqB,CAAC,CAAC;IACzD,CAAC;IAQM,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,CAAsB,MAAM,CAAC,CAAC;IACvD,CAAC;IAQM,eAAe;QACpB,OAAO,IAAI,CAAC,WAAW,CAAc,cAAc,CAAC,CAAC;IACvD,CAAC;IAQM,sBAAsB;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAe,qBAAqB,CAAC,CAAC;IAC/D,CAAC;IAQM,oBAAoB,CAAC,cAA6C;QACvE,OAAO,IAAI,CAAC,WAAW,CAAgC,gBAAgB,EAAE,cAAc,CAAC,CAAC;IAC3F,CAAC;IAQM,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAgC,gBAAgB,CAAC,CAAC;IAC3E,CAAC;IAQM,cAAc;QACnB,OAAO,IAAI,CAAC,WAAW,CAAc,aAAa,CAAC,CAAC;IACtD,CAAC;IAQM,eAAe,CAAC,SAAqB;QAC1C,OAAO,IAAI,CAAC,WAAW,CAAa,WAAW,EAAE,SAAS,CAAC,CAAC;IAC9D,CAAC;IAQM,YAAY;QACjB,OAAO,IAAI,CAAC,WAAW,CAAa,WAAW,CAAC,CAAC;IACnD,CAAC;IAQM,gBAAgB;QACrB,OAAO,IAAI,CAAC,WAAW,CAAS,eAAe,CAAC,CAAC;IACnD,CAAC;IAQM,oBAAoB;QACzB,OAAO,IAAI,CAAC,WAAW,CAAU,mBAAmB,CAAC,CAAC;IACxD,CAAC;IAQM,eAAe;QACpB,OAAO,IAAI,CAAC,WAAW,CAAmC,cAAc,CAAC,CAAC;IAC5E,CAAC;CAEF;AAnND,wCAmNC"}
+{"version":3,"file":"OjListViewBase.js","sourceRoot":"","sources":["OjListViewBase.ts"],"names":[],"mappings":";;;AAAA,2BAAmC;AASnC,MAAa,cAAe,SAAQ,gBAAY;IAOvC,KAAK;QACV,OAAO,IAAI,CAAC,WAAW,CAAS,IAAI,CAAC,CAAC;IACxC,CAAC;IAQM,iBAAiB,CAAC,WAAgB;QACvC,OAAO,IAAI,CAAC,WAAW,CAAM,aAAa,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;IAQM,cAAc;QACnB,OAAO,IAAI,CAAC,WAAW,CAAM,aAAa,CAAC,CAAC;IAC9C,CAAC;IAQM,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,CAAS,MAAM,CAAC,CAAC;IAC1C,CAAC;IAQM,UAAU;QACf,OAAO,IAAI,CAAC,WAAW,CAAS,SAAS,CAAC,CAAC;IAC7C,CAAC;IAQM,MAAM;QACX,OAAO,IAAI,CAAC,WAAW,CAAM,KAAK,CAAC,CAAC;IACtC,CAAC;IAQM,YAAY;QACjB,OAAO,IAAI,CAAC,WAAW,CAAS,WAAW,CAAC,CAAC;IAC/C,CAAC;IAQM,oBAAoB;QACzB,OAAO,IAAI,CAAC,WAAW,CAAS,mBAAmB,CAAC,CAAC;IACvD,CAAC;IAQM,YAAY;QACjB,OAAO,IAAI,CAAC,WAAW,CAAY,WAAW,CAAC,CAAC;IAClD,CAAC;IAQM,sBAAsB;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAS,qBAAqB,CAAC,CAAC;IACzD,CAAC;IAQM,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,CAAO,MAAM,CAAC,CAAC;IACxC,CAAC;IAQM,eAAe;QACpB,OAAO,IAAI,CAAC,WAAW,CAAc,cAAc,CAAC,CAAC;IACvD,CAAC;IAQM,sBAAsB;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAe,qBAAqB,CAAC,CAAC;IAC/D,CAAC;IAQM,oBAAoB,CAAC,cAA8B;QACxD,OAAO,IAAI,CAAC,WAAW,CAAiB,gBAAgB,EAAE,cAAc,CAAC,CAAC;IAC5E,CAAC;IAQM,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAiB,gBAAgB,CAAC,CAAC;IAC5D,CAAC;IAQM,cAAc;QACnB,OAAO,IAAI,CAAC,WAAW,CAAc,aAAa,CAAC,CAAC;IACtD,CAAC;IAQM,eAAe,CAAC,SAAqB;QAC1C,OAAO,IAAI,CAAC,WAAW,CAAa,WAAW,EAAE,SAAS,CAAC,CAAC;IAC9D,CAAC;IAQM,YAAY;QACjB,OAAO,IAAI,CAAC,WAAW,CAAa,WAAW,CAAC,CAAC;IACnD,CAAC;IAQM,gBAAgB;QACrB,OAAO,IAAI,CAAC,WAAW,CAAS,eAAe,CAAC,CAAC;IACnD,CAAC;IAQM,oBAAoB;QACzB,OAAO,IAAI,CAAC,WAAW,CAAU,mBAAmB,CAAC,CAAC;IACxD,CAAC;IAQM,eAAe;QACpB,OAAO,IAAI,CAAC,WAAW,CAAoB,cAAc,CAAC,CAAC;IAC7D,CAAC;CAEF;AAnND,wCAmNC"}