@oracle/oraclejet-dom-driver 18.0.10

package/UNSAFE_DomDriver/DomDriver.d.ts

@@ -0,0 +1,9 @@
+import { type TestDriver } from '@oracle/oraclejet-testing/UNSAFE_driver';
+export declare const keyMap: {
+    [key: string]: string;
+};
+/**
+ * A DOM-based TestDriver. This works in environments where the DOM is directly
+ * available, such as Jest or Karma.
+ */
+export declare const DomDriver: TestDriver;

package/UNSAFE_DomDriver/DomDriver.js

@@ -0,0 +1,134 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DomDriver = exports.keyMap = void 0;
+const UNSAFE_driver_1 = require("@oracle/oraclejet-testing/UNSAFE_driver");
+const user_event_1 = __importDefault(require("@testing-library/user-event"));
+const userEvent = user_event_1.default.setup();
+exports.keyMap = {
+    SHIFT: '[Shift]',
+    CONTROL: '[Control]',
+    // jest always runs in linux-like environment, so CONTROL_COMMAND is always 'Control'
+    CONTROL_COMMAND: '[Control]',
+    ALT: '[Alt]',
+    BACKSPACE: '[Backspace]',
+    TAB: '[Tab]',
+    ENTER: '[Enter]',
+    ESCAPE: '[Escape]',
+    PAGE_UP: '[PageUp]',
+    PAGE_DOWN: '[PageDown]',
+    END: '[End]',
+    HOME: '[Home]',
+    ARROW_LEFT: '[ArrowLeft]',
+    ARROW_UP: '[ArrowUp]',
+    ARROW_RIGHT: '[ArrowRight]',
+    ARROW_DOWN: '[ArrowDown]',
+    DELETE: '[Delete]',
+    F1: '[F1]',
+    F2: '[F2]',
+    F3: '[F3]',
+    F4: '[F4]',
+    F5: '[F5]',
+    F6: '[F6]',
+    F7: '[F7]',
+    F8: '[F8]',
+    F9: '[F9]',
+    F10: '[F10]',
+    F11: '[F11]',
+    F12: '[F12]'
+};
+function getMappedKey(key) {
+    if (typeof key === 'object') {
+        return exports.keyMap[key.key];
+    }
+    return key;
+}
+/**
+ * Get an array of keys (chord) representing the given parameters, substituting modifier keys
+ * with their equivalent user-event values.
+ * Ex. "[CONTROL],a" -> "{CONTROL>}a{/CONTROL}"
+ * @param values The values from which to create a chord
+ * @returns The array of keys
+ */
+function getChord(values) {
+    const text = values.map(getMappedKey);
+    const modifierValues = Object.keys(UNSAFE_driver_1.ModifierKeys).map((m) => exports.keyMap[m]);
+    const modifierValueRegEx = new RegExp(`\\{(${modifierValues.map((m) => m.replace(/[\[\]]/g, '')).join('|')})>\\}`);
+    const chord = text.map((v) => 
+    // [ALT] => {ALT>}
+    modifierValues.includes(v) ? `${v.replace(/^\[/, '{').replace(/\]$/, '>}')}` : v);
+    // add modifier release values
+    return chord.reduceRight((accum, v) => {
+        const match = v.match(modifierValueRegEx);
+        if (match) {
+            accum.push(`{/${match[1]}}`);
+        }
+        return accum;
+    }, chord);
+}
+/**
+ * A DOM-based TestDriver. This works in environments where the DOM is directly
+ * available, such as Jest or Karma.
+ */
+exports.DomDriver = {
+    executeScript(script, ...args) {
+        if (typeof script === 'string') {
+            const remoteFunction = new Function(`
+        function execute() {
+          ${script}
+        }
+        return execute.call(undefined, ${args.map(JSON.stringify).join(', ')});
+      `)();
+            return Promise.resolve(remoteFunction);
+        }
+        return Promise.resolve(script.apply(null, args));
+    },
+    findElement(query) {
+        const el = document.querySelector(query);
+        if (el) {
+            return Promise.resolve(wrapElement(el));
+        }
+        throw Error(`No element matching query "${query}"`);
+    },
+    findElements(query) {
+        return Promise.resolve(Array.from(document.querySelectorAll(query)).map(wrapElement));
+    },
+    async click(element, options = {}) {
+        const chord = getChord(options.modifiers || []);
+        // send the first half of the chord (key-down values), then click()
+        chord.length && (await userEvent.keyboard(chord.slice(0, chord.length / 2).join('')));
+        await userEvent.click(element.el);
+        // send the second half of the chord (key-up values)
+        chord.length && (await userEvent.keyboard(chord.slice(chord.length / 2).join('')));
+    },
+    async sendKeys(element, ...text) {
+        // ensure focus if blurred (re-focusing will clear out selection)
+        if (document.activeElement !== element.el) {
+            element.el.focus();
+        }
+        await userEvent.keyboard(getChord(text).join(''));
+    }
+};
+function wrapElement(element) {
+    return new ElementWrapper(element);
+}
+class ElementWrapper {
+    constructor(element) {
+        this.el = element;
+    }
+    findElement(query) {
+        const el = this.el.querySelector(query);
+        if (el) {
+            return Promise.resolve(wrapElement(el));
+        }
+        throw Error(`No element matching query "${query}"`);
+    }
+    findElements(query) {
+        return Promise.resolve(Array.from(this.el.querySelectorAll(query)).map(wrapElement));
+    }
+    getAttribute(attrName) {
+        return Promise.resolve(this.el.getAttribute(attrName));
+    }
+}

package/UNSAFE_DomDriver/index.d.ts

@@ -0,0 +1 @@
+export { DomDriver } from './DomDriver';

package/UNSAFE_DomDriver/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DomDriver = void 0;
+var DomDriver_1 = require("./DomDriver");
+Object.defineProperty(exports, "DomDriver", { enumerable: true, get: function () { return DomDriver_1.DomDriver; } });

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@oracle/oraclejet-dom-driver",
+  "packageManager": "yarn@3.5.0",
+  "dependencies": {
+    "@oracle/oraclejet-testing": "18.0.10",
+    "@testing-library/user-event": "14.4.3"
+  },
+  "devDependencies": {
+    "@jest/globals": "29.6.2",
+    "@oracle/oraclejet-internal-test-utils": "workspace:*",
+    "@oracle/oraclejet-internal-ws-build": "workspace:^",
+    "@testing-library/preact": "3.2.3",
+    "copyfiles": "2.4.1",
+    "jest": "29.6.2",
+    "jest-environment-jsdom": "29.6.2",
+    "jsdom-global": "3.0.2",
+    "preact": "10.24.3",
+    "rimraf": "3.0.2",
+    "ts-jest": "29.1.0",
+    "typescript": "5.7.2"
+  },
+  "scripts": {
+    "build": "yarn clean; tsc --outDir dist/UNSAFE_DomDriver && yarn copy-files",
+    "clean": "rimraf dist",
+    "copy-files": "mergeJson package.json src/package-overrides.json dist/package.json",
+    "test": "jest -c test/jest.config.js",
+    "test-ci-headless": "yarn test"
+  },
+  "exports": {
+    "./*": "./*/index.js"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./*/index.d.ts"
+      ]
+    }
+  },
+  "version": "18.0.10"
+}