@oracle/oraclejet-testing 17.0.0

package/UNSAFE_driver/index.js

@@ -0,0 +1,27 @@
+"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()');
+    }
+    return _driver;
+}
+exports.getDriver = getDriver;

package/UNSAFE_locators/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getElement = exports.getByTestId = void 0;
+const UNSAFE_driver_1 = require("../UNSAFE_driver");
+/**
+ * Create a locator that targets an element by its testId
+ * @param testId
+ * @returns The ElementLocator for the given testId
+ */
+function getByTestId(testId) {
+    return {
+        css: getTestIdQuery(testId)
+    };
+}
+exports.getByTestId = getByTestId;
+function getTestIdQuery(testId) {
+    return `[data-testid=${testId}]`;
+}
+/**
+ * Perform an element search on the driver using the given ElementLocator
+ * @param locator
+ * @returns
+ */
+async function getElement(locator) {
+    const matches = await (0, UNSAFE_driver_1.getDriver)().findElements(locator.css);
+    if (!matches.length) {
+        throw Error(`No matches found for "${locator.css}"`);
+    }
+    return matches[0];
+}
+exports.getElement = getElement;

package/package.json

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

package/types/UNSAFE_driver/index.d.ts

@@ -0,0 +1,59 @@
+/**
+ * A TestDriver implements the platform-specific commands needed for testing
+ * with adapters.
+ */
+export interface TestDriver {
+    /**
+     * Click on the given TestElement
+     * @param element The TestElement on which to click
+     */
+    click(element: TestElement): 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>;
+    /**
+     * 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.
+     * @param query The CSS query to use in locate the element
+     */
+    findElement(query: string): Promise<TestElement>;
+    /**
+     * Find elements in the browser environment matching the gven 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[]>;
+    /**
+     *
+     * @param element The element to receive the keystrokes
+     * @param text
+     */
+    sendKeys(element: TestElement, text: string): Promise<void>;
+}
+/**
+ * A TestElement represents the DOM element in the browser environment. This interface
+ * is used by test adapters to work with elements without being bound to a specific
+ * platform implementation.
+ */
+export interface TestElement {
+    findElement(query: string): Promise<TestElement>;
+    findElements(query: string): Promise<TestElement[]>;
+}
+/**
+ * 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
+ */
+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
+ */
+export declare function getDriver(): TestDriver;

package/types/UNSAFE_locators/index.d.ts

@@ -0,0 +1,19 @@
+import { type TestElement } from '../UNSAFE_driver';
+interface ElementLocator {
+    css: string;
+}
+export interface TestIdLocator extends ElementLocator {
+}
+/**
+ * Create a locator that targets an element by its testId
+ * @param testId
+ * @returns The ElementLocator for the given testId
+ */
+export declare function getByTestId(testId: string): TestIdLocator;
+/**
+ * Perform an element search on the driver using the given ElementLocator
+ * @param locator
+ * @returns
+ */
+export declare function getElement(locator: ElementLocator): Promise<TestElement>;
+export {};