@oracle/oraclejet-webdriver 17.1.4 → 18.0.1

package/{lib → src/lib}/oj-module-proxy.ts

@@ -15,21 +15,19 @@ let _BROWSER_NAME: string;
  * @param {WebDriver} driver
  * @param {string[]} moduleNames An array of strings of the modules to be made available
  * @param {any[]} scriptArgs An array of arguments to pass to the script. Pass blank array if no args
- * @param {string} script The script to be executed. The script should define a function that takes the
+ * @param {() => T} remoteFunction The remote function to be executed. The function should take the
  * arguments containg: each requested module as separate parameters, and each script argument as
  * separate parameters after the modules.
- * @return {Promise<T>} Anything returned from the script
+ * @return {Promise<T>} Anything returned from the remote function
  * @template T
  */
 export async function executeWithModules<T>(
   driver: WebDriver,
   moduleNames: string[],
   scriptArgs: any[] = [],
-  script: string
+  remoteFunction: (...args: any[]) => T
 ) {
-  const testProxyScript = getTestProxyScript();
-  const hasProxy = !(await driver.executeAsyncScript(testProxyScript));
-  if (!hasProxy) {
+  if (!(await hasProxy(driver))) {
     throw new Error('executeWithModules called on a non-JET page');
   }
   if (!_BROWSER_NAME) {
@@ -37,7 +35,7 @@ export async function executeWithModules<T>(
     _BROWSER_NAME = caps.get(Capability.BROWSER_NAME);
   }
   if (_BROWSER_NAME === Browser.FIREFOX) {
-    return _executeWithModulesFirefox<T>(driver, moduleNames, scriptArgs, script);
+    return _executeWithModulesFirefox<T>(driver, moduleNames, scriptArgs, remoteFunction);
   }
 
   const s = `
@@ -46,12 +44,22 @@ export async function executeWithModules<T>(
     console.log('${TEST_OBJ_NAME} importing modules ${moduleNames}');
     return ${TEST_OBJ_NAME}.getProxy(...${JSON.stringify(moduleNames)}).then((modules) => {
       console.log('${TEST_OBJ_NAME} running script');
-      return (${script})(...modules.concat(args));
+      return (${remoteFunction})(...modules.concat(args));
     })
-  `;
+    `;
   return driver.executeScript<T>(s, ...scriptArgs);
 }
 
+/**
+ * Test if the current page has oj-module-proxy loaded
+ * @param driver The WebDriver instance
+ * @returns A Promise resolving to true if the page has oj-module-proxy, false otherwse
+ */
+export function hasProxy(driver: WebDriver) {
+  const testProxyScript = getTestProxyScript();
+  return driver.executeAsyncScript<boolean>(testProxyScript, TEST_OBJ_NAME);
+}
+
 /**
  * Workaround https://github.com/mozilla/geckodriver/issues/1701 where properties defined via a getter are not returned
  * a) via executeAsyncScript
@@ -67,44 +75,44 @@ async function _executeWithModulesFirefox<T>(
   driver: WebDriver,
   moduleNames: string[],
   scriptArgs: any[] = [],
-  script: string
+  remoteFunction: (...args: any[]) => T
 ) {
-  const s1 = `
-    console.log('${TEST_OBJ_NAME} importing modules ${moduleNames}');
-    // We don't actually need the returned module values here, we just want to
-    // trigger the imports.  Throw away the return values so that we don't run
-    // into problems trying to encode them
-    return ${TEST_OBJ_NAME}.getProxy(...${JSON.stringify(moduleNames)}).then(() => {});
-  `;
-  await driver.executeScript<T>(s1);
+  await driver.executeScript<T>(
+    (testObjName: any, moduleNames: string[]) => {
+      console.log(`${testObjName} importing modules ${moduleNames}`);
+      // We don't actually need the returned module values here, we just want to
+      // trigger the imports.  Throw away the return values so that we don't run
+      // into problems trying to encode them
+      return (window[testObjName] as any).getProxy(...moduleNames).then(() => {});
+    },
+    TEST_OBJ_NAME,
+    moduleNames
+  );
   const s2 = `
     const args = Array.from(arguments);
     const modules = ${TEST_OBJ_NAME}.getCachedModules(...${JSON.stringify(moduleNames)});
     console.log('${TEST_OBJ_NAME} running script');
-    return (${script})(...modules.concat(args));
+    return (${remoteFunction})(...modules.concat(args));
   `;
   return driver.executeScript<T>(s2, ...scriptArgs);
 }
 
 function getTestProxyScript() {
+  let func: Function;
   if (isNoRequireJet()) {
-    return `
-      const done = arguments[0];
-      (function pollForProxy() {
-        if ('${TEST_OBJ_NAME}' in window) {
-          done();
-        }
-        setTimeout(pollForProxy, 100);
-      })();
-    `;
+    func = function pollForProxy(testObjectName: string, done: (hasProxy: boolean) => void) {
+      if (`${testObjectName}` in window) {
+        done(true);
+      }
+      setTimeout(() => pollForProxy(testObjectName, done), 100);
+    };
   } else {
-    return `
-      const done = arguments[0];
+    func = function (_testObjectName: string, done: (hasProxy: boolean) => void) {
       function success() {
-        done();
+        done(true);
       }
       function failure() {
-        done('Unable to load ojs/ojcore-base via RequireJS');
+        done(false);
       }
       if (typeof require === 'function') {
         // Try sync require first
@@ -112,12 +120,13 @@ function getTestProxyScript() {
           require('ojs/ojcore-base');
           success();
         } catch (ex) {
-          require(['ojs/ojcore-base'], success, failure);
+          (require as any)(['ojs/ojcore-base'], success, failure);
           return;
         }
       } else {
         failure();
       }
-    `;
+    };
   }
+  return func;
 }

package/{lib → src/lib}/slot-proxy.ts

@@ -140,13 +140,7 @@ class SlotProxyImpl implements SlotProxy {
    * Closes menu programmatically.
    */
   private async closeMenu(menu: OjMenu): Promise<void> {
-    return this.getDriver().executeScript<void>(
-      `
-     const menu = arguments[0];
-     menu.close();
-  `,
-      menu
-    );
+    return this.getDriver().executeScript<void>((menu: any) => menu.close(), menu);
   }
   /*
    * Finds out if a closed menu exists.
@@ -186,13 +180,11 @@ class SlotProxyImpl implements SlotProxy {
   private async openMenu(menu: WebElement): Promise<void> {
     await this.giveRootFocus();
     return this.getDriver().executeScript<void>(
-      `
-      const menu = arguments[0];
-      const launcher = arguments[1];
-      const clickEvent = new CustomEvent('click');
-      launcher.dispatchEvent(clickEvent);
-      menu.open(clickEvent, { launcher: launcher })
-    `,
+      (menu: any, launcher: any) => {
+        const clickEvent = new CustomEvent('click');
+        launcher.dispatchEvent(clickEvent);
+        menu.open(clickEvent, { launcher: launcher });
+      },
       menu,
       this._root
     );
@@ -201,13 +193,7 @@ class SlotProxyImpl implements SlotProxy {
    * Give the root node focus by clicking or tapping.
    */
   private async giveRootFocus() {
-    await this.getDriver().executeScript(
-      `
-    const root = arguments[0];
-    root.click();
-    `,
-      this._root
-    );
+    await this.getDriver().executeScript((root: HTMLElement) => root.click(), this._root);
   }
   /*
    * Finds a given menu option given its value.

package/src/lib/version-check.ts

@@ -0,0 +1,38 @@
+import { WebDriver } from 'selenium-webdriver';
+import { executeWithModules } from './oj-module-proxy';
+
+/**
+ * Check the running JET UI version against this oraclejet-webdriver package
+ * version. It's expected that the JET UI is already fully loaded so that
+ * "oj.version" and "oj.revision" will resolve.
+ * If a mismatch is found, a console warning will be logged with the mismatched
+ * values.
+ * @param driver WebDriver instance
+ * @private
+ */
+export async function checkVersions(driver: WebDriver) {
+  const pjson = require('../package.json');
+  const version = pjson.version;
+  const revision = pjson.config.revision;
+  const jet = await executeWithModules<{ version: string; revision: string }>(
+    driver,
+    ['Core'],
+    [],
+    (core) => ({ version: core.version, revision: core.revision })
+  );
+  if (
+    // Check if not local build (running from JET repo)
+    !revision.match(/^#@@oj\.revision@@#$|^local:/) &&
+    // or version mismatch
+    (version !== jet.version || revision !== jet.revision)
+  ) {
+    const mismatch = `version mismatch: oraclejet ${JSON.stringify(
+      jet
+    )}, oraclejet-webdriver ${JSON.stringify({ version, revision })}`;
+    console.warn(`
+  Your oraclejet UI version/revision does not match oraclejet-webdriver
+  ${mismatch}
+      `);
+    throw Error(mismatch);
+  }
+}

package/{lib → src/lib}/viewmodel-utils.ts

@@ -53,18 +53,17 @@ export async function assertViewModelValue(
     driver,
     ['Chai', 'Knockout', 'CspExpressionEvaluator'],
     [viewmodelEl, expectation.assertion],
-    `
-    ((chai, ko, ExpressionEval, viewmodelEl, assertion) => {
+    (chai, ko, ExpressionEval, viewmodelEl, assertion) => {
       try {
         var viewmodel = ko.dataFor(viewmodelEl);
         // Use ExpressionEval to get the value from the viewmodel
         var evaluator = new ExpressionEval();
         var value = evaluator.createEvaluator(assertion.expression).evaluate([viewmodel]);
-  
-        function compare(value) {
+
+        function compare(value: any) {
           var expect = chai.expect(value);
           // For each chained assertion, call the assertion method with the arguments
-          assertion.chain.forEach((desc) => {
+          assertion.chain.forEach((desc: any) => {
             if (typeof desc === 'string') {
               // Simple assertions, "is", "to", "be", etc
               expect = expect[desc];
@@ -73,32 +72,32 @@ export async function assertViewModelValue(
               const name = desc.name;
               const args = desc.args;
               let evaluatedArgs = [];
-  
+
               if (name === 'match') {
                 args[0] = new RegExp(args[0]);
               }
-  
+
               if (args) {
                 evaluatedArgs = args;
               }
-  
+
               expect = expect[name](...evaluatedArgs);
             }
           });
           return true;
         }
-  
+
         // If "value" is a Promise
         if (value && typeof value.then === 'function') {
-          value.then(compare).catch((ex) => ex.message);
+          return value.then(compare).catch((ex: Error) => ex.message);
         } else {
           return compare(value);
         }
-      } catch (ex) {
-        return ex.message;
+      } catch (ex: unknown) {
+        const err = ex as Error;
+        return err.message;
       }
-    })
-    `
+    }
   );
   if (result !== true) {
     throw Error(String(result));

package/src/package-overrides.json

@@ -0,0 +1,21 @@
+{
+  "exports": {
+    ".": "./index.js",
+    "./bin/generate": "./bin/generate",
+    "./elements": "./elements/index.js",
+    "./elements/index": "./elements/index.js",
+    "./elements/OjWebElement": "./elements/OjWebElement.js",
+    "./elements/*": "./elements/*/index.js",
+    "./lib/*": "./lib/*.js",
+    "./src/": "./src/",
+    "./tsconfig": "./tsconfig.json"
+  },
+  "typesVersions": {
+    "*": {
+      "elements": ["./elements/index.d.ts"],
+      "elements/*": ["./elements/*/index.d.ts", "./elements/*.d.ts"],
+      ".": ["./index.d.ts"],
+      "*": ["./*.d.ts"]
+    }
+  }
+}

package/tsconfig.json

@@ -1,10 +1,11 @@
 {
   "compilerOptions": {
-    "rootDir": ".",
+    "rootDir": "src",
     "strict": true,
     "strictNullChecks": true,
     "allowUnreachableCode": false,
     "allowUnusedLabels": false,
+    "declaration": true,
     "noImplicitAny": true,
     "noImplicitReturns": true,
     "noImplicitThis": true,
@@ -21,9 +22,6 @@
       "@oracle/oraclejet/*": ["./node_modules/@oracle/oraclejet/dist/types/*"]
     }
   },
-  "include": [
-    "index.ts",
-    "elements/**/*.ts",
-    "lib/**/*.ts"
-  ]
+  "include": ["src/**/*.ts"],
+  "exclude": []
 }

package/wdtsdoc/assets/navigation.js

@@ -1 +1 @@
-window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43aTW/bRhSF4f+itdsiaRoU3tnOB4rasVAFzSLIYkRdU1OTM8JwaEso+t8LfpPDO/fMsunrJ7ZIieSJv/+78XT2m+sNFVSS8dXmanNS/ri53pT2UBdU/TL8n5+Pviw2V5tnbQ6b67dXm+yoi4Mjs7n+PjKP/9xkmXUHbc0kZYWqqrk0q5bqm7e//3e1wLy25k65A9CGTOZua+/BN9YlKUxF/kGZS4LWl4noo6E089GQTN4dlfOi1RYIoex5b88VIWrsAGiLQp0qvS/kn3PWQdC6rSrIeyiOYQK5O1HmXV1icygRWu7t3p7hWTMP00h0zsw6BJoXulh3SwU43LNQJj8orz47Lb+DhwhStNXZMzmE9RnmvuoylZxSwGqVOyWfNn0DocLmyClsDhinXsndq4ut5WM6D1PIrT3VpwSx7WTwky5SDsOUQa7ceafl726sZOyzMl5+4dpCRv4wBzqDn65vEHSqfXM6AqqvErHm3E4DmzIB/VKXe/jjjl0CuFVV9WrBjcCiTEB3pFx2xGTXJYBfm/+CXFOlYEkHBR+Qe7WnQoTaAiB0+KzqXP6GhghRORn5QHYJYHTl/9b0KkN9JFMPqrLGXRI+IxclQMnUskWmxkTCTeuUIa6qFDiEfZME3SpjwJt8Ucrol1t7Fq0mAIR60blqHgaa4y5ji1RmtyrXJr+zxjsrv5EWJUB15i2+RZ8ywMGLccJleOts7qiqZKeP0ih4IOahTP6lDtqi55AhQpTXJscfaLMOgPTkqDqCd8NYAcy+fjyflDkgbupkcEcFZfhxdcpSOPTQMVYp2E6bHDwQzsMU0sov3hABqtDoKHQJYE7KPeM3+5QBzitfVw/kyeFzOIwR7UiV8F07ZYCrzb52COsjQL3qE3VTj/wBNQ8h6cH9X5fIzFe1v1XySdIlkAFvgbZASH5X2Fq+vRoiQNHZ3zhSMtVHgDpSqbzOHpR8jZp1ANQl3Zy1fCIMEaYKDT7MhghQTmn5Vq0tEEIE72uHCFMlesm7Roa+KU/uSRVFwi1y0AKY9h+7L5XNMZM4y63PT7XpPgomb9b99GYJvn8XeOsBOgIOIRDD23lW66IkaTVDC2DfprqLC7zMPhoCanDxY7m2gQ6zR0e0sUQmN0nz5lRik1mlY+iYpqjrYTrODi10uW06wk5poopPpFkJTW6hjqBTCtT1SM2KQ4a11ZoZ8/owQeSm6qg6xUgO12qe7CpsLQbrGFXYHEnsZs17szRJDZ6UBbQtgckt1yw5hVgMx+sY2HXAC/Zr1mob4KwmbFbqK2itVuyI1nep3nIzlc2mTXHDLTuudmWKuZ6z4+rQprjhoh1XuzLFXI7acbHpkrzEY5RwfIJpm7XaBjmrdZun+gxqy4E7YjURklYbN2/1GdAiMzdLLlrkLpZuniNTJyhJd8dTCMVg745wbZVmhZO3JHYtcJerN8s1CVIiwzfvLWIgR7ZvFl60yGXmbx4dQyQmXNdTrujrEZyn+ixRSzgu8xSo6ymcFYcMaswaHgHHEpnrQZwXhw553CbOi1MJTG4WZ8kpTBLx887YJXnhOC6QXZqkWvRCDhnSgomct9oIScxKzmtjiMToUM67QQ719VYecYcQiau5nPf6DGnsYs6LsxSrHt5idhGQwt2clboIS/AN0jbQCdfzCNVlSFsN6LzWZ0jjNnQenEpkrmZ0HuyzBG25pEe1JkPackznqaaBTrinR6guS9BKfAS6CljRVZ01gxrZzLDOs2PIiD9mpm6e7Cds+P3w9o+XXxj55fBd5ohMdbTNlVTl82vGEluFS/4dz2eOIoNCTO2+QngZc/4OK+bl4a8dLLDI7VoMW/0OQ3A4Pjj9Qm71Sg7/eNKxi0j6p5OP52Yobh8KYtYskaTur7zXz7NDoU176mbB99VEwZnz2/sZtSus3zp7vgjS2EjQgZ5UPd+LX5TTzeVgUPpgafz6dkY8kc+Of9Ll9vJJF56/3+mssBROCUe5rkRsKKTzav0qhcqYsG/xH/8DvkIaaAcyAAA="
+window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43aS2/bRhSG4f+itdsiaRoU3sXOBUXjWKiCZhFkMaKOqampGWE4tGUU/e8F77cz5zvLJK+fyCIlUp/9/d9NpEvcXG+ooBO5WG6uNmcTj5vrzckfqoLKX/p/+fkYT8XmavNo3WFz/fpqkx1tcQjkNtffB+b+n3dZ5sPBejdKWWHKcipNqrn66vXv/13NsGi9uzXhALQ+k7mbKkbwwNpEw5QU74x7UWhdqUTvHenMe0cyeXs0IYpWUyCEsse9v5SEqKEDoC8Kcy7tvpC/z0kHQR+2pqAYoTiECnJ3piyG6oTNvkToae/3/gLPmmmoI9E5M+kQ6J7oxYcbKsDhnoQy+d5E8ylY+RXcR5Circ0eKSCsyzD31Z605JgC1po8GPm06RoIFT5HTuFzwATzTOGzefGVfEynoYbc+nN1VohNJ4MfbaE5DGMGudMuBis/uqGSsU/GRfmJawoZ+cMd6AK+u65B0LmK9ekIqK5SYvW5rQPrUoF+qU57+O0OnQLcmrJ89uBGYFYq0B2ZkB0x2XYK8Gv9J8jVlQZTHRR8QD6bPRUi1BQAocMnU+XyA+ojROXk5APZJoCxZfzb0rMMdZFM3ZnSu/CieI+clQAlV8kWuQoTipvWMUNcWRpwCLtGBd0Y58CLfFbK6JcbfxGtOgCEebK5qT8M1MddxmapzG5Nbl1+610MXn4hzUqA2ix6fIs+ZoCDF2PFZXgbfB6oLGWni3QUPBDTUCb/Mgfr0eeQPkKUy2lX2AM4fScdAqN1OX6HnHQApIdA5RE9vr4CmH/+cDkbB7/dsZPBHRWU4c+/Y6bh0KeYodJgO+ty8AlzGmpILz95fQQofNJpzrfd2YRH/O4xZoCLJlblHUUK+BxexogOZE7wbWDMAFe5fRUQ1kWAerZnarcj+R1vGkIyghvKNpGZr2Z/Y+STpE0gA14CTYGQ/LbwlXy/1keAokt8F8jIVBcB6kgnE212Z+SL3qQDoD3Ru4uVT4Q+wlRhwZtZHwEqGCvf+zUFQojgjXIfYeqEnvK2kaFvJlJ4MEWhuOdetACm/Yf2S2VzyCTOc3P2Q+Xat4LRm3Q/vZqDb98svPWinQD7EIjLzwes1kYqabVrC2DXat3ZBV5m7x0BdXHxY7mmgQ4zcCe0oUQmt3Hz5lhik5m5U+iQatT10p1m+xa63NidYMdUqeITaVJCk5u8E+iYAnW9erNin2FtNY+mvC5UiNz2nVTHGMnL+Zsn2wpbswU8RRU+RxI7gvPeJFWpi4/eAtqUwOSmcJYcQywu1/AU2HbAWwzirNU0wFlt4qzUVdBazeIJreu03nyElc261bjLcTyttqXGXO/jabVvNe5yIk+rbakx5yt5Wqw7lac8Rorjs9jKWatpkLOay3mqy6A2X8wTVh0haTWa81aXAS2xm7PkrEXubDrnOXKVQlHdHY8hFBcDeoJrKp213NAlsW2BO5/RWa5OkJJY0nlvFgM5Maaz8KxFLrOn8+gQIlFxXddc0derOk91mVJTHJdpCtT1ts6KfQY1Zl5PgEMJTWZhT5hDicz1yM6LfYc8bmfnxbEEJje1s+QYqkT8GWroVN5ycBfINlWpHj2RfYY0zcmoOg+55Z3XhhCJyfGddxc51Nf7e8LtQySuJnje6zKksSs8L05SrEZ429pGQFpu8azURliCL5Cmgc5ykU9QbYa01SjPa12GNG6X58GxROZqmufBLlNo83U+qdUZ0uYDPU/VDXSWG32CajOFdsJHoK2AlVzqWXNRI5sZ63l2CBnxx8S09VowYv0vsTd/Pf/CxG+w77JA5Mqjr6+kJp9eM+bYKpzzb3g+C5QYKVJq+xXC05jzd20pL1/+bsQMS9wCprDVL1osDsf7YJ8orJ7J/gcyLTuLpB/HfLjU43PzQSNlTRJJav/Lz/Zxciisa07dbPG46mhx5vz2dkLtCh+3wV9eBGloJOhAD6aabtBPJtj6ctArXTA3fn09IR4oZsc/6eXm5aMtIn+/01rLUjglAuW2FLG+kM6r9bO0VIaEfYn/+B8WJvrvrDIAAA=="