@oracle/oraclejet-testing 17.1.4 → 18.0.1

package/{types/UNSAFE_driver/index.d.ts → UNSAFE_driver/Driver.d.ts}

@@ -7,14 +7,14 @@ export interface TestDriver {
      * Click on the given TestElement
      * @param element The TestElement on which to click
      */
-    click(element: TestElement): Promise<void>;
+    click(element: TestElement, options?: ClickOptions): Promise<void>;
     /**
      * Execute a script in the browser environment.
      * @param script The script to execute
      * @param args Any arguments to pass to the script. Access each argument through
      * the <code>arguments</code> array.
      */
-    executeScript<T>(script: string, ...args: any): Promise<T>;
+    executeScript<T>(script: string | (() => T), ...args: any): Promise<T>;
     /**
      * Find an element in the browser environment that matches the given CSS query.
      * This method should throw an exception if no matching elements are found.
@@ -22,17 +22,18 @@ export interface TestDriver {
      */
     findElement(query: string): Promise<TestElement>;
     /**
-     * Find elements in the browser environment matching the gven CSS query. If no
+     * Find elements in the browser environment matching the given CSS query. If no
      * matching elements are found, return a blank array.
      * @param query The CSS query to use in locating the elements.
      */
     findElements(query: string): Promise<TestElement[]>;
     /**
-     *
+     * Send text as keystrokes to the browser. If modifier keys are used, all key parameters in the
+     * sequence will be combined into a single chord.
      * @param element The element to receive the keystrokes
-     * @param text
+     * @param text The text value to send, or an array of KeyMap strings to send as a chord of keys
      */
-    sendKeys(element: TestElement, text: string): Promise<void>;
+    sendKeys(element: TestElement, ...text: (string | KeyType)[]): Promise<void>;
 }
 /**
  * A TestElement represents the DOM element in the browser environment. This interface
@@ -42,7 +43,20 @@ export interface TestDriver {
 export interface TestElement {
     findElement(query: string): Promise<TestElement>;
     findElements(query: string): Promise<TestElement[]>;
+    getAttribute(attrName: string): Promise<string | null>;
 }
+export declare const ModifierKeys: {
+    [key: string]: KeyType;
+};
+export type ClickOptions = {
+    modifiers?: (typeof ModifierKeys)[keyof typeof ModifierKeys][];
+};
+export declare const Keys: {
+    [key: string]: {
+        key: string;
+    };
+};
+export type KeyType = (typeof Keys)[keyof typeof Keys];
 /**
  * Set the TestDriver instance to be used for testing. This method should be called by
  * tests during setup, before calling any test adapter methods.
@@ -54,6 +68,6 @@ export declare function setDriver(driver: TestDriver): void;
  * Get the configured TestDriver instance to be used for testing. This method should
  * only be called by test adapters to interact with the browser environment.
  *
- * @returns {TestDriver} The TestDriver instance
+ * @returns The TestDriver instance
  */
 export declare function getDriver(): TestDriver;

package/UNSAFE_driver/Driver.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Keys = exports.ModifierKeys = void 0;
+exports.setDriver = setDriver;
+exports.getDriver = getDriver;
+// export const ModifierKeys: { [k: string]: KeyType } = {
+exports.ModifierKeys = {
+    ALT: { key: 'ALT' },
+    CONTROL: { key: 'CONTROL' },
+    CONTROL_COMMAND: { key: 'CONTROL_COMMAND' },
+    SHIFT: { key: 'SHIFT' }
+};
+exports.Keys = {
+    ...exports.ModifierKeys,
+    BACKSPACE: { key: 'BACKSPACE' },
+    TAB: { key: 'TAB' },
+    ENTER: { key: 'ENTER' },
+    ESCAPE: { key: 'ESCAPE' },
+    PAGE_UP: { key: 'PAGE_UP' },
+    PAGE_DOWN: { key: 'PAGE_DOWN' },
+    END: { key: 'END' },
+    HOME: { key: 'HOME' },
+    ARROW_LEFT: { key: 'ARROW_LEFT' },
+    ARROW_UP: { key: 'ARROW_UP' },
+    ARROW_RIGHT: { key: 'ARROW_RIGHT' },
+    ARROW_DOWN: { key: 'ARROW_DOWN' },
+    DELETE: { key: 'DELETE' },
+    F1: { key: 'F1' },
+    F2: { key: 'F2' },
+    F3: { key: 'F3' },
+    F4: { key: 'F4' },
+    F5: { key: 'F5' },
+    F6: { key: 'F6' },
+    F7: { key: 'F7' },
+    F8: { key: 'F8' },
+    F9: { key: 'F9' },
+    F10: { key: 'F10' },
+    F11: { key: 'F11' },
+    F12: { key: 'F12' }
+};
+let _driver;
+/**
+ * Set the TestDriver instance to be used for testing. This method should be called by
+ * tests during setup, before calling any test adapter methods.
+ *
+ * @param driver The TestDriver instance
+ */
+function setDriver(driver) {
+    _driver = driver;
+}
+/**
+ * Get the configured TestDriver instance to be used for testing. This method should
+ * only be called by test adapters to interact with the browser environment.
+ *
+ * @returns The TestDriver instance
+ */
+function getDriver() {
+    if (!_driver) {
+        throw Error('Driver has not been set. Call setDriver()');
+    }
+    return _driver;
+}

package/UNSAFE_driver/index.d.ts

@@ -0,0 +1 @@
+export * from './Driver';

package/UNSAFE_driver/index.js

@@ -1,27 +1,17 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDriver = exports.setDriver = void 0;
-let _driver;
-/**
- * Set the TestDriver instance to be used for testing. This method should be called by
- * tests during setup, before calling any test adapter methods.
- *
- * @param driver The TestDriver instance
- */
-function setDriver(driver) {
-    _driver = driver;
-}
-exports.setDriver = setDriver;
-/**
- * Get the configured TestDriver instance to be used for testing. This method should
- * only be called by test adapters to interact with the browser environment.
- *
- * @returns {TestDriver} The TestDriver instance
- */
-function getDriver() {
-    if (!_driver) {
-        throw Error('Driver has not been set. Call setDriver()');
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-    return _driver;
-}
-exports.getDriver = getDriver;
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Driver"), exports);

package/UNSAFE_locators/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getElement = exports.getByTestId = void 0;
+exports.getByTestId = getByTestId;
+exports.getElement = getElement;
 const UNSAFE_driver_1 = require("../UNSAFE_driver");
 /**
  * Create a locator that targets an element by its testId
@@ -12,7 +13,6 @@ function getByTestId(testId) {
         css: getTestIdQuery(testId)
     };
 }
-exports.getByTestId = getByTestId;
 function getTestIdQuery(testId) {
     return `[data-testid=${testId}]`;
 }
@@ -28,4 +28,3 @@ async function getElement(locator) {
     }
     return matches[0];
 }
-exports.getElement = getElement;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oracle/oraclejet-testing",
   "scripts": {
-    "build": "yarn clean; tsc --outDir dist --declarationDir dist/types && yarn copy-files",
+    "build": "yarn clean; tsc --outDir dist && yarn copy-files",
     "clean": "rimraf dist",
     "copy-files": "mergeJson package.json src/package-overrides.json dist/package.json"
   },
@@ -9,7 +9,7 @@
     "@oracle/oraclejet-internal-ws-build": "workspace:^",
     "copyfiles": "2.4.1",
     "rimraf": "3.0.2",
-    "typescript": "5.4.5"
+    "typescript": "5.7.2"
   },
   "exports": {
     "./*": "./*/index.js"
@@ -17,10 +17,10 @@
   "typesVersions": {
     "*": {
       "*": [
-        "./types/*/index.d.ts"
+        "./*/index.d.ts"
       ]
     }
   },
   "dependencies": {},
-  "version": "17.1.4"
+  "version": "18.0.1"
 }