@wdio/utils 7.20.3 → 7.20.8-alpha.504

package/build/test-framework/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/build/utils.d.ts

@@ -44,7 +44,7 @@ export declare function getArgumentType(arg: any): "string" | "number" | "bigint
  * @param  {string} name  of package
  * @return {object}       package content
  */
-export declare function safeRequire(name: string): Services.ServicePlugin | null;
+export declare function safeImport(name: string): Promise<Services.ServicePlugin | null>;
 /**
  * is function async
  * @param  {Function} fn  function to check
@@ -67,7 +67,7 @@ export declare function isBase64(str: string): boolean;
  * @param {String} file file to check access for
  * @return              true if file can be accessed
  */
-export declare const canAccess: (file: string) => boolean;
+export declare const canAccess: (file?: string) => boolean;
 /**
  * sleep
  * @param {number=0} ms number in ms to sleep

package/build/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAW,MAAM,aAAa,CAAA;AAMpD;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,gBAAgB,EAAE;IAAE,sBAAsB,CAAC,EAAE;QAAE,KAAK,EAAE,GAAG,CAAA;KAAE,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,QAsCzH;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,UA+BrE;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAE,MAAM,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;;EAWpF;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAE,GAAG,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,WA8B/D;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAE,GAAG,EAAE,GAAG,wGAExC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,aAAa,GAAG,IAAI,CAoCxE;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAE,EAAE,EAAE,QAAQ,WAE5C;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAE,IAAI,EAAE,GAAG,EAAE,SAE1C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,WAanC;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,SAAU,MAAM,YAWrC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,KAAK,mCAAoD,CAAA"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAW,MAAM,aAAa,CAAA;AAQpD;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,gBAAgB,EAAE;IAAE,sBAAsB,CAAC,EAAE;QAAE,KAAK,EAAE,GAAG,CAAA;KAAE,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,QAsCzH;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,UA+BrE;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAE,MAAM,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;;EAapF;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAE,GAAG,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,WA8B/D;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAE,GAAG,EAAE,GAAG,wGAExC;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,aAAa,GAAG,IAAI,CAAC,CA2BtF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAE,EAAE,EAAE,QAAQ,WAE5C;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAE,IAAI,EAAE,GAAG,EAAE,SAE1C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,WAanC;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,UAAW,MAAM,YAWtC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,KAAK,mCAAoD,CAAA"}

package/build/utils.js

@@ -1,11 +1,7 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sleep = exports.canAccess = exports.isBase64 = exports.filterSpecArgs = exports.isFunctionAsync = exports.safeRequire = exports.getArgumentType = exports.isValidParameter = exports.transformCommandLogResult = exports.commandCallStructure = exports.overwriteElementCommands = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
+import fs from 'node:fs';
+import { pathToFileURL } from 'node:url';
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
 const SCREENSHOT_REPLACEMENT = '"<Screenshot[base64]>"';
 const SCRIPT_PLACEHOLDER = '"<Script[base64]>"';
 const REGEX_SCRIPT_NAME = /return \(function (\w+)/;
@@ -13,7 +9,7 @@ const REGEX_SCRIPT_NAME = /return \(function (\w+)/;
  * overwrite native element commands with user defined
  * @param {object} propertiesObject propertiesObject
  */
-function overwriteElementCommands(propertiesObject) {
+export function overwriteElementCommands(propertiesObject) {
     const elementOverrides = propertiesObject['__elementOverrides__'] ? propertiesObject['__elementOverrides__'].value : {};
     for (const [commandName, userDefinedCommand] of Object.entries(elementOverrides)) {
         if (typeof userDefinedCommand !== 'function') {
@@ -45,12 +41,11 @@ function overwriteElementCommands(propertiesObject) {
     delete propertiesObject['__elementOverrides__'];
     propertiesObject['__elementOverrides__'] = { value: {} };
 }
-exports.overwriteElementCommands = overwriteElementCommands;
 /**
  * get command call structure
  * (for logging purposes)
  */
-function commandCallStructure(commandName, args) {
+export function commandCallStructure(commandName, args) {
     const callArgs = args.map((arg) => {
         if (typeof arg === 'string' && (arg.startsWith('!function(') || arg.startsWith('return (function'))) {
             arg = '<fn>';
@@ -84,13 +79,12 @@ function commandCallStructure(commandName, args) {
     }).join(', ');
     return `${commandName}(${callArgs})`;
 }
-exports.commandCallStructure = commandCallStructure;
 /**
  * transforms WebDriver result for log stream to avoid unnecessary long
  * result strings e.g. if it contains a screenshot
  * @param {Object} result WebDriver response body
  */
-function transformCommandLogResult(result) {
+export function transformCommandLogResult(result) {
     if (typeof result.file === 'string' && isBase64(result.file)) {
         return SCREENSHOT_REPLACEMENT;
     }
@@ -101,9 +95,11 @@ function transformCommandLogResult(result) {
         const newScript = result.script.match(REGEX_SCRIPT_NAME)[1];
         return { ...result, script: `${newScript}(...) [${Buffer.byteLength(result.script, 'utf-8')} bytes]` };
     }
+    else if (typeof result.script === 'string' && result.script.startsWith('!function(')) {
+        return { ...result, script: `<minified function> [${Buffer.byteLength(result.script, 'utf-8')} bytes]` };
+    }
     return result;
 }
-exports.transformCommandLogResult = transformCommandLogResult;
 /**
  * checks if command argument is valid according to specificiation
  *
@@ -111,7 +107,7 @@ exports.transformCommandLogResult = transformCommandLogResult;
  * @param  {Object}  expectedType  parameter type (e.g. `number`, `string[]` or `(number|string)`)
  * @return {Boolean}               true if argument is valid
  */
-function isValidParameter(arg, expectedType) {
+export function isValidParameter(arg, expectedType) {
     let shouldBeArray = false;
     if (expectedType.slice(-2) === '[]') {
         expectedType = expectedType.slice(0, -2);
@@ -139,23 +135,20 @@ function isValidParameter(arg, expectedType) {
     }
     return true;
 }
-exports.isValidParameter = isValidParameter;
 /**
  * get type of command argument
  */
-function getArgumentType(arg) {
+export function getArgumentType(arg) {
     return arg === null ? 'null' : typeof arg;
 }
-exports.getArgumentType = getArgumentType;
 /**
  * Allows to safely require a package, it only throws if the package was found
  * but failed to load due to syntax errors
  * @param  {string} name  of package
  * @return {object}       package content
  */
-function safeRequire(name) {
-    var _a, _b, _c;
-    let requirePath;
+export async function safeImport(name) {
+    let requirePath = name;
     try {
         /**
          * Check if cli command was called from local directory, if not require
@@ -165,57 +158,45 @@ function safeRequire(name) {
          * also allows to link the package to a random place and have plugins
          * imported correctly (for dev purposes).
          */
-        const localNodeModules = path_1.default.join(process.cwd(), '/node_modules');
         /* istanbul ignore if */
-        if (!((_a = require === null || require === void 0 ? void 0 : require.main) === null || _a === void 0 ? void 0 : _a.paths.includes(localNodeModules))) {
-            (_b = require === null || require === void 0 ? void 0 : require.main) === null || _b === void 0 ? void 0 : _b.paths.push(localNodeModules);
-            /**
-             * don't set requireOpts when running unit tests as it
-             * confuses Jest require magic
-             */
-            const requireOpts = process.env.JEST_WORKER_ID
-                ? {}
-                : { paths: (_c = require === null || require === void 0 ? void 0 : require.main) === null || _c === void 0 ? void 0 : _c.paths };
-            requirePath = require.resolve(name, requireOpts);
-        }
-        else {
-            requirePath = require.resolve(name);
+        if (require.resolve) {
+            requirePath = await require.resolve(name);
+            if (!requirePath.startsWith('file://')) {
+                requirePath = pathToFileURL(requirePath).href;
+            }
         }
     }
     catch (err) {
         return null;
     }
     try {
-        return require(requirePath);
+        return await import(requirePath);
     }
     catch (e) {
         throw new Error(`Couldn't initialise "${name}".\n${e.stack}`);
     }
 }
-exports.safeRequire = safeRequire;
 /**
  * is function async
  * @param  {Function} fn  function to check
  * @return {Boolean}      true provided function is async
  */
-function isFunctionAsync(fn) {
+export function isFunctionAsync(fn) {
     return (fn.constructor && fn.constructor.name === 'AsyncFunction') || fn.name === 'async';
 }
-exports.isFunctionAsync = isFunctionAsync;
 /**
  * filter out arguments passed to specFn & hookFn, don't allow callbacks
  * as there is no need for user to call e.g. `done()`
  */
-function filterSpecArgs(args) {
+export function filterSpecArgs(args) {
     return args.filter((arg) => typeof arg !== 'function');
 }
-exports.filterSpecArgs = filterSpecArgs;
 /**
  * checks if provided string is Base64
  * @param  {String} str  string in base64 to check
  * @return {Boolean} true if the provided string is Base64
  */
-function isBase64(str) {
+export function isBase64(str) {
     var notBase64 = new RegExp('[^A-Z0-9+\\/=]', 'i');
     if (typeof str !== 'string') {
         throw new Error('Expected string but received invalid type.');
@@ -229,28 +210,25 @@ function isBase64(str) {
         firstPaddingChar === len - 1 ||
         (firstPaddingChar === len - 2 && str[len - 1] === '=');
 }
-exports.isBase64 = isBase64;
 /**
  * Helper utility to check file access
  * @param {String} file file to check access for
  * @return              true if file can be accessed
  */
-const canAccess = (file) => {
+export const canAccess = (file) => {
     if (!file) {
         return false;
     }
     try {
-        fs_1.default.accessSync(file);
+        fs.accessSync(file);
         return true;
     }
     catch (err) {
         return false;
     }
 };
-exports.canAccess = canAccess;
 /**
  * sleep
  * @param {number=0} ms number in ms to sleep
  */
-const sleep = (ms = 0) => new Promise((r) => setTimeout(r, ms));
-exports.sleep = sleep;
+export const sleep = (ms = 0) => new Promise((r) => setTimeout(r, ms));

package/package.json

@@ -1,17 +1,21 @@
 {
   "name": "@wdio/utils",
-  "version": "7.20.3",
+  "version": "7.20.8-alpha.504+428a9d729",
   "description": "A WDIO helper utility to provide several utility functions used across the project.",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-utils",
   "license": "MIT",
-  "main": "./build/index",
+  "type": "module",
+  "exports": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "typeScriptVersion": "3.8.3",
   "engines": {
-    "node": ">=12.0.0"
+    "node": "^16.13 || >=18"
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/webdriverio/webdriverio.git"
+    "url": "git://github.com/webdriverio/webdriverio.git",
+    "directory": "packages/wdio-utils"
   },
   "keywords": [
     "webdriverio",
@@ -23,13 +27,12 @@
     "url": "https://github.com/webdriverio/webdriverio/issues"
   },
   "dependencies": {
-    "@wdio/logger": "7.19.0",
-    "@wdio/types": "7.20.3",
+    "@wdio/logger": "7.20.8-alpha.504+428a9d729",
+    "@wdio/types": "7.20.8-alpha.504+428a9d729",
     "p-iteration": "^1.1.8"
   },
   "publishConfig": {
     "access": "public"
   },
-  "types": "./build/index.d.ts",
-  "gitHead": "df5cbf4f557ddc04f49ebc25b9a74231fdd44f2b"
+  "gitHead": "428a9d729ae6231968a60908732fa3f607d195e9"
 }