@wdio/utils 6.5.0 → 6.7.3

package/build/test-framework/types.d.ts

@@ -0,0 +1,36 @@
+import type { executeHooksWithArgs, executeAsync, runSync } from '../shim';
+export declare type HookFnArgs<T> = (ctx: T) => [unknown, T];
+export interface WrapperMethods {
+    executeHooksWithArgs: typeof executeHooksWithArgs;
+    executeAsync: typeof executeAsync;
+    runSync: typeof runSync;
+}
+export interface SpecFunction {
+    specFn: Function;
+    specFnArgs: any[];
+}
+export interface BeforeHookParam<T> {
+    beforeFn: Function;
+    beforeFnArgs: HookFnArgs<T>;
+}
+export interface AfterHookParam<T> {
+    afterFn: Function;
+    afterFnArgs: HookFnArgs<T>;
+}
+export interface JasmineContext {
+    failedExpectations: Array<Record<string, unknown>>;
+}
+export declare type SpecArguments = ([
+    Function
+] | [
+    Function,
+    number
+] | [
+    string,
+    Function
+] | [
+    string,
+    Function,
+    number
+]);
+//# sourceMappingURL=types.d.ts.map

package/build/test-framework/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/test-framework/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAE1E,oBAAY,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;AAEpD,MAAM,WAAW,cAAc;IAC3B,oBAAoB,EAAE,OAAO,oBAAoB,CAAA;IACjD,YAAY,EAAE,OAAO,YAAY,CAAA;IACjC,OAAO,EAAE,OAAO,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,QAAQ,CAAA;IAChB,UAAU,EAAE,GAAG,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC;IAC9B,QAAQ,EAAE,QAAQ,CAAA;IAClB,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;CAC9B;AAED,MAAM,WAAW,cAAc,CAAC,CAAC;IAC7B,OAAO,EAAE,QAAQ,CAAA;IACjB,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;CAC7B;AAED,MAAM,WAAW,cAAc;IAC3B,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CACrD;AAED,oBAAY,aAAa,GAAG,CAIxB;IAAC,QAAQ;CAAC,GAIV;IAAC,QAAQ;IAAE,MAAM;CAAC,GAIlB;IAAC,MAAM;IAAE,QAAQ;CAAC,GAIlB;IAAC,MAAM;IAAE,QAAQ;IAAE,MAAM;CAAC,CAC7B,CAAA"}

package/build/test-framework/types.js

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

package/build/utils.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="webdriverio/webdriverio-core" />
+export declare function overwriteElementCommands(propertiesObject: {
+    '__elementOverrides__'?: {
+        value: any;
+    };
+    [key: string]: any;
+}): void;
+export declare function commandCallStructure(commandName: string, args: any[]): string;
+export declare function transformCommandLogResult(result: {
+    file?: string;
+}): "\"<Screenshot[base64]>\"" | {
+    file?: string | undefined;
+};
+export declare function isValidParameter(arg: any, expectedType: string): boolean;
+export declare function getArgumentType(arg: any): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "null";
+export declare function safeRequire(name: string): WebdriverIO.ServiceClass | null;
+export declare function isFunctionAsync(fn: Function): boolean;
+export declare function filterSpecArgs(args: any[]): any[];
+export declare function isBase64(str: string): boolean;
+export declare const canAccess: (file: string) => boolean;
+export declare const sleep: (ms?: number) => Promise<unknown>;
+//# sourceMappingURL=utils.d.ts.map

package/build/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AASA,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;AAMD,wBAAgB,oBAAoB,CAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,UA+BrE;AAOD,wBAAgB,yBAAyB,CAAE,MAAM,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE;;EAMnE;AASD,wBAAgB,gBAAgB,CAAE,GAAG,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,WA8B/D;AAKD,wBAAgB,eAAe,CAAE,GAAG,EAAE,GAAG,wGAExC;AAQD,wBAAgB,WAAW,CAAE,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC,YAAY,GAAG,IAAI,CAoC1E;AAOD,wBAAgB,eAAe,CAAE,EAAE,EAAE,QAAQ,WAE5C;AAMD,wBAAgB,cAAc,CAAE,IAAI,EAAE,GAAG,EAAE,SAE1C;AAOD,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,WAanC;AAOD,eAAO,MAAM,SAAS,SAAU,MAAM,YAWrC,CAAA;AAMD,eAAO,MAAM,KAAK,mCAAoD,CAAA"}

package/build/utils.js

@@ -1,195 +1,169 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.overwriteElementCommands = overwriteElementCommands;
-exports.commandCallStructure = commandCallStructure;
-exports.transformCommandLogResult = transformCommandLogResult;
-exports.isValidParameter = isValidParameter;
-exports.getArgumentType = getArgumentType;
-exports.safeRequire = safeRequire;
-exports.isFunctionAsync = isFunctionAsync;
-exports.filterSpecArgs = filterSpecArgs;
-exports.isBase64 = isBase64;
-exports.sleep = exports.canAccess = void 0;
-
-var _fs = _interopRequireDefault(require("fs"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+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"));
 const SCREENSHOT_REPLACEMENT = '"<Screenshot[base64]>"';
-
 function overwriteElementCommands(propertiesObject) {
-  const elementOverrides = propertiesObject['__elementOverrides__'] ? propertiesObject['__elementOverrides__'].value : {};
-
-  for (const [commandName, userDefinedCommand] of Object.entries(elementOverrides)) {
-    if (typeof userDefinedCommand !== 'function') {
-      throw new Error('overwriteCommand: commands be overwritten only with functions, command: ' + commandName);
-    }
-
-    if (!propertiesObject[commandName]) {
-      throw new Error('overwriteCommand: no command to be overwritten: ' + commandName);
-    }
-
-    if (typeof propertiesObject[commandName].value !== 'function') {
-      throw new Error('overwriteCommand: only functions can be overwritten, command: ' + commandName);
+    const elementOverrides = propertiesObject['__elementOverrides__'] ? propertiesObject['__elementOverrides__'].value : {};
+    for (const [commandName, userDefinedCommand] of Object.entries(elementOverrides)) {
+        if (typeof userDefinedCommand !== 'function') {
+            throw new Error('overwriteCommand: commands be overwritten only with functions, command: ' + commandName);
+        }
+        if (!propertiesObject[commandName]) {
+            throw new Error('overwriteCommand: no command to be overwritten: ' + commandName);
+        }
+        if (typeof propertiesObject[commandName].value !== 'function') {
+            throw new Error('overwriteCommand: only functions can be overwritten, command: ' + commandName);
+        }
+        const origCommand = propertiesObject[commandName].value;
+        delete propertiesObject[commandName];
+        const newCommand = function (...args) {
+            const element = this;
+            return userDefinedCommand.apply(element, [
+                function origCommandFunction() {
+                    const context = this || element;
+                    return origCommand.apply(context, arguments);
+                },
+                ...args
+            ]);
+        };
+        propertiesObject[commandName] = {
+            value: newCommand,
+            configurable: true
+        };
     }
-
-    const origCommand = propertiesObject[commandName].value;
-    delete propertiesObject[commandName];
-
-    const newCommand = function (...args) {
-      const element = this;
-      return userDefinedCommand.apply(element, [function origCommandFunction() {
-        const context = this || element;
-        return origCommand.apply(context, arguments);
-      }, ...args]);
-    };
-
-    propertiesObject[commandName] = {
-      value: newCommand,
-      configurable: true
-    };
-  }
-
-  delete propertiesObject['__elementOverrides__'];
-  propertiesObject['__elementOverrides__'] = {
-    value: {}
-  };
+    delete propertiesObject['__elementOverrides__'];
+    propertiesObject['__elementOverrides__'] = { value: {} };
 }
-
+exports.overwriteElementCommands = overwriteElementCommands;
 function commandCallStructure(commandName, args) {
-  const callArgs = args.map(arg => {
-    if (typeof arg === 'string' && (arg.startsWith('!function(') || arg.startsWith('return (function'))) {
-      arg = '<fn>';
-    } else if (typeof arg === 'string' && !commandName.startsWith('findElement') && isBase64(arg)) {
-      arg = SCREENSHOT_REPLACEMENT;
-    } else if (typeof arg === 'string') {
-      arg = `"${arg}"`;
-    } else if (typeof arg === 'function') {
-      arg = '<fn>';
-    } else if (arg === null) {
-      arg = 'null';
-    } else if (typeof arg === 'object') {
-      arg = '<object>';
-    } else if (typeof arg === 'undefined') {
-      arg = typeof arg;
-    }
-
-    return arg;
-  }).join(', ');
-  return `${commandName}(${callArgs})`;
+    const callArgs = args.map((arg) => {
+        if (typeof arg === 'string' && (arg.startsWith('!function(') || arg.startsWith('return (function'))) {
+            arg = '<fn>';
+        }
+        else if (typeof arg === 'string' &&
+            !commandName.startsWith('findElement') &&
+            isBase64(arg)) {
+            arg = SCREENSHOT_REPLACEMENT;
+        }
+        else if (typeof arg === 'string') {
+            arg = `"${arg}"`;
+        }
+        else if (typeof arg === 'function') {
+            arg = '<fn>';
+        }
+        else if (arg === null) {
+            arg = 'null';
+        }
+        else if (typeof arg === 'object') {
+            arg = '<object>';
+        }
+        else if (typeof arg === 'undefined') {
+            arg = typeof arg;
+        }
+        return arg;
+    }).join(', ');
+    return `${commandName}(${callArgs})`;
 }
-
+exports.commandCallStructure = commandCallStructure;
 function transformCommandLogResult(result) {
-  if (typeof result.file === 'string' && isBase64(result.file)) {
-    return SCREENSHOT_REPLACEMENT;
-  }
-
-  return result;
+    if (typeof result.file === 'string' && isBase64(result.file)) {
+        return SCREENSHOT_REPLACEMENT;
+    }
+    return result;
 }
-
+exports.transformCommandLogResult = transformCommandLogResult;
 function isValidParameter(arg, expectedType) {
-  let shouldBeArray = false;
-
-  if (expectedType.slice(-2) === '[]') {
-    expectedType = expectedType.slice(0, -2);
-    shouldBeArray = true;
-  }
-
-  if (shouldBeArray) {
-    if (!Array.isArray(arg)) {
-      return false;
+    let shouldBeArray = false;
+    if (expectedType.slice(-2) === '[]') {
+        expectedType = expectedType.slice(0, -2);
+        shouldBeArray = true;
+    }
+    if (shouldBeArray) {
+        if (!Array.isArray(arg)) {
+            return false;
+        }
     }
-  } else {
-    arg = [arg];
-  }
-
-  for (const argEntity of arg) {
-    const argEntityType = getArgumentType(argEntity);
-
-    if (!argEntityType.match(expectedType)) {
-      return false;
+    else {
+        arg = [arg];
     }
-  }
-
-  return true;
+    for (const argEntity of arg) {
+        const argEntityType = getArgumentType(argEntity);
+        if (!argEntityType.match(expectedType)) {
+            return false;
+        }
+    }
+    return true;
 }
-
+exports.isValidParameter = isValidParameter;
 function getArgumentType(arg) {
-  return arg === null ? 'null' : typeof arg;
+    return arg === null ? 'null' : typeof arg;
 }
-
+exports.getArgumentType = getArgumentType;
 function safeRequire(name) {
-  let requirePath;
-
-  try {
-    const localNodeModules = `${process.cwd()}/node_modules`;
-
-    if (!require.main.paths.includes(localNodeModules)) {
-      require.main.paths.push(localNodeModules);
-
-      const requireOpts = process.env.JEST_WORKER_ID ? {} : {
-        paths: require.main.paths
-      };
-      requirePath = require.resolve(name, requireOpts);
-    } else {
-      requirePath = require.resolve(name);
+    var _a, _b, _c;
+    let requirePath;
+    try {
+        const localNodeModules = path_1.default.join(process.cwd(), '/node_modules');
+        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);
+            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);
+        }
+    }
+    catch (e) {
+        return null;
+    }
+    try {
+        return require(requirePath);
+    }
+    catch (e) {
+        throw new Error(`Couldn't initialise "${name}".\n${e.stack}`);
     }
-  } catch (e) {
-    return null;
-  }
-
-  try {
-    return require(requirePath);
-  } catch (e) {
-    throw new Error(`Couldn't initialise "${name}".\n${e.stack}`);
-  }
 }
-
+exports.safeRequire = safeRequire;
 function isFunctionAsync(fn) {
-  return fn.constructor && fn.constructor.name === 'AsyncFunction' || fn.name === 'async';
+    return (fn.constructor && fn.constructor.name === 'AsyncFunction') || fn.name === 'async';
 }
-
+exports.isFunctionAsync = isFunctionAsync;
 function filterSpecArgs(args) {
-  return args.filter(arg => typeof arg !== 'function');
+    return args.filter((arg) => typeof arg !== 'function');
 }
-
+exports.filterSpecArgs = filterSpecArgs;
 function isBase64(str) {
-  var notBase64 = new RegExp('[^A-Z0-9+\\/=]', 'i');
-  const isString = typeof str === 'string' || str instanceof String;
-
-  if (!isString) {
-    throw new Error('Expected string but received invalid type.');
-  }
-
-  const len = str.length;
-
-  if (!len || len % 4 !== 0 || notBase64.test(str)) {
-    return false;
-  }
-
-  const firstPaddingChar = str.indexOf('=');
-  return firstPaddingChar === -1 || firstPaddingChar === len - 1 || firstPaddingChar === len - 2 && str[len - 1] === '=';
+    var notBase64 = new RegExp('[^A-Z0-9+\\/=]', 'i');
+    if (typeof str !== 'string') {
+        throw new Error('Expected string but received invalid type.');
+    }
+    const len = str.length;
+    if (!len || len % 4 !== 0 || notBase64.test(str)) {
+        return false;
+    }
+    const firstPaddingChar = str.indexOf('=');
+    return firstPaddingChar === -1 ||
+        firstPaddingChar === len - 1 ||
+        (firstPaddingChar === len - 2 && str[len - 1] === '=');
 }
-
-const canAccess = file => {
-  if (!file) {
-    return false;
-  }
-
-  try {
-    _fs.default.accessSync(file);
-
-    return true;
-  } catch (e) {
-    return false;
-  }
+exports.isBase64 = isBase64;
+exports.canAccess = (file) => {
+    if (!file) {
+        return false;
+    }
+    try {
+        fs_1.default.accessSync(file);
+        return true;
+    }
+    catch (e) {
+        return false;
+    }
 };
-
-exports.canAccess = canAccess;
-
-const sleep = (ms = 0) => new Promise(r => setTimeout(r, ms));
-
-exports.sleep = sleep;
+exports.sleep = (ms = 0) => new Promise((r) => setTimeout(r, ms));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/utils",
-  "version": "6.5.0",
+  "version": "6.7.3",
   "description": "A WDIO helper utility to provide several utility functions used across the project.",
   "author": "Christian Bromann <christian@saucelabs.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-utils",
@@ -9,15 +9,6 @@
   "engines": {
     "node": ">=10.0.0"
   },
-  "scripts": {
-    "tsc": "tsc",
-    "build": "run-s clean compile",
-    "clean": "rimraf ./build",
-    "compile": "babel src/ -d build/ --config-file ../../babel.config.js",
-    "test": "run-s test:*",
-    "test:eslint": "eslint src test",
-    "test:unit": "jest"
-  },
   "repository": {
     "type": "git",
     "url": "git://github.com/webdriverio/webdriverio.git"
@@ -32,10 +23,11 @@
     "url": "https://github.com/webdriverio/webdriverio/issues"
   },
   "dependencies": {
-    "@wdio/logger": "6.4.7"
+    "@wdio/logger": "6.7.3"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "27e1326e46bf15ff4f6882a578aecd181e551656"
+  "types": "./build/index.d.ts",
+  "gitHead": "2d72a4f1be35727342bf31b750d76eab6c8b50e9"
 }

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "extends": "../../tsconfig",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "outDir": "./build",
-    "rootDir": "./src"
-  },
-  "include": [
-    "src/**/*"
-  ]
-}