expect-webdriverio 4.0.0 → 4.1.0

package/package.json

@@ -1,68 +1,83 @@
 {
   "name": "expect-webdriverio",
-  "version": "4.0.0",
-  "description": "",
-  "main": "lib/index.js",
+  "version": "4.1.0",
+  "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
+  "description": "WebdriverIO Assertion Library",
+  "license": "MIT",
+  "homepage": "https://webdriver.io",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/webdriverio/expect-webdriverio.git"
+  },
+  "bugs": {
+    "url": "https://github.com/webdriverio/expect-webdriverio/issues"
+  },
+  "keywords": [
+    "expect-webdriverio",
+    "expect",
+    "webdriverio",
+    "wdio"
+  ],
+  "type": "module",
+  "module": "./lib/index.js",
+  "exports": {
+    ".": [
+      {
+        "types": "./types/jest-global.d.ts",
+        "import": "./lib/index.js"
+      },
+      "./lib/index.js"
+    ],
+    "./types": "./types/jest-global.d.ts"
+  },
+  "types": "./types/jest-global.d.ts",
+  "typeScriptVersion": "3.8.3",
+  "engines": {
+    "node": ">=16 || >=18 || >=20"
+  },
   "scripts": {
     "build": "run-s clean compile",
     "clean": "run-p clean:*",
     "clean:build": "rimraf ./lib",
     "clean:tests": "rimraf test-types/**/node_modules && rimraf test-types/**/dist",
     "compile": "tsc --build tsconfig.build.json",
-    "release": "release-it --github.release",
-    "release:ci": "npm run release -- --ci --npm.skipChecks --no-git.requireCleanWorkingDir",
-    "release:patch": "npm run release -- patch",
-    "release:minor": "npm run release -- minor",
-    "release:major": "npm run release -- major",
     "test": "run-s test:*",
     "test:lint": "eslint . --ext .js,.jsx,.ts,.tsx",
-    "test:unit": "jest",
-    "watch": "npm run compile -- --watch",
+    "test:unit": "vitest",
     "test:types": "node test-types/copy && npm run ts && npm run clean:tests",
     "ts": "run-p ts:*",
     "ts:default": "cd test-types/default && tsc --incremental",
     "ts:jest": "cd test-types/jest && tsc --incremental",
     "ts:jasmine": "cd test-types/jasmine && tsc --incremental",
+    "watch": "npm run compile -- --watch",
     "prepare": "husky install"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/webdriverio/expect-webdriverio.git"
-  },
-  "keywords": [
-    "expect-webdriverio",
-    "expect",
-    "webdriverio",
-    "wdio"
-  ],
-  "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/webdriverio/expect-webdriverio/issues"
-  },
-  "homepage": "https://github.com/webdriverio/expect-webdriverio#readme",
   "devDependencies": {
-    "@types/jasmine": "^3.6.6",
-    "@types/jest": "^27.0.1",
-    "@types/node": "^15.0.1",
-    "@typescript-eslint/eslint-plugin": "^4.17.0",
-    "@typescript-eslint/parser": "^4.17.0",
-    "eslint": "^7.21.0",
-    "husky": "^7.0.0",
-    "jest": "^26.6.3",
+    "@types/jest": "^29.2.4",
+    "@types/node": "^18.11.17",
+    "@typescript-eslint/eslint-plugin": "^5.47.0",
+    "@typescript-eslint/parser": "^5.47.0",
+    "@vitest/coverage-c8": "^0.26.0",
+    "@wdio/globals": "^8.0.13",
+    "c8": "^7.12.0",
+    "eslint": "^8.30.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-unicorn": "^45.0.2",
+    "husky": "^8.0.2",
     "npm-run-all": "^4.1.5",
-    "release-it": "^14.4.1",
+    "release-it": "^15.5.1",
     "rimraf": "^3.0.2",
-    "shelljs": "^0.8.4",
-    "ts-jest": "^26.5.3",
-    "ts-node": "^10.0.0",
-    "typescript": "^4.2.3",
-    "webdriverio": "^7.1.1"
+    "shelljs": "^0.8.5",
+    "typescript": "^4.9.4",
+    "vitest": "0.26.2",
+    "webdriverio": "^8.0.13"
+  },
+  "optionalDependencies": {
+    "@wdio/globals": "^8.0.13",
+    "webdriverio": "^8.0.13"
   },
-  "types": "types/jest-global.d.ts",
-  "typeScriptVersion": "3.8.3",
   "dependencies": {
-    "expect": "^27.0.2",
-    "jest-matcher-utils": "^27.0.2"
+    "expect": "^29.3.1",
+    "jest-matcher-utils": "^29.3.1"
   }
 }

package/types/expect-webdriverio.d.ts

@@ -1,4 +1,5 @@
 declare namespace ExpectWebdriverIO {
+    function expect<T = unknown>(actual: T): Matchers<T, T>
     function setOptions(options: DefaultOptions): void
 
     interface DefaultOptions {
@@ -83,11 +84,11 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getAttribute`
          */
-        toHaveAttribute(attribute: string, value?: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveAttribute(attribute: string, value?: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
         /**
          * `WebdriverIO.Element` -> `getAttribute`
          */
-        toHaveAttr(attribute: string, value?: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveAttr(attribute: string, value?: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Element` -> `getAttribute`
@@ -95,7 +96,7 @@ declare namespace ExpectWebdriverIO {
          */
         toHaveAttributeContaining(
             attribute: string,
-            contains: string,
+            contains: string | RegExp,
             options?: ExpectWebdriverIO.StringOptions
         ): R
         /**
@@ -104,7 +105,7 @@ declare namespace ExpectWebdriverIO {
          */
         toHaveAttrContaining(
             attribute: string,
-            contains: string,
+            contains: string | RegExp,
             options?: ExpectWebdriverIO.StringOptions
         ): R
 
@@ -112,40 +113,40 @@ declare namespace ExpectWebdriverIO {
          * `WebdriverIO.Element` -> `getAttribute` class
          * @deprecated since v1.3.1 - use `toHaveElementClass` instead.
          */
-        toHaveClass(className: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveClass(className: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Element` -> `getAttribute` class
          */
-        toHaveElementClass(className: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveElementClass(className: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Element` -> `getAttribute` class
          * @deprecated since v1.3.1 - use `toHaveElementClassContaining` instead.
          * Element's class includes the className.
          */
-        toHaveClassContaining(className: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveClassContaining(className: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Element` -> `getAttribute` class
          * Element's class includes the className.
          */
-        toHaveElementClassContaining(className: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveElementClassContaining(className: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Element` -> `getProperty`
          */
-        toHaveElementProperty(property: string, value?: any, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveElementProperty(property: string | RegExp, value?: any, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Element` -> `getProperty` value
          */
-        toHaveValue(value: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveValue(value: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
         /**
          * `WebdriverIO.Element` -> `getProperty` value
          * Element's value includes the value.
          */
-        toHaveValueContaining(value: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveValueContaining(value: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Element` -> `isClickable`
@@ -194,37 +195,37 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getAttribute` href
          */
-        toHaveHref(href: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveHref(href: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
         /**
          * `WebdriverIO.Element` -> `getAttribute` href
          */
-        toHaveLink(href: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveLink(href: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Element` -> `getAttribute` href
          * Element's href includes the value provided
          */
-        toHaveHrefContaining(href: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveHrefContaining(href: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
         /**
          * `WebdriverIO.Element` -> `getAttribute` href
          * Element's href includes the value provided
          */
-        toHaveLinkContaining(href: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveLinkContaining(href: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Element` -> `getProperty` value
          */
-        toHaveId(id: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveId(id: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Element` -> `getText`
          */
-        toHaveText(text: string | string[], options?: ExpectWebdriverIO.StringOptions): R
+        toHaveText(text: string | RegExp | Array<string | RegExp>, options?: ExpectWebdriverIO.StringOptions): R
         /**
          * `WebdriverIO.Element` -> `getText`
          * Element's text includes the text provided
          */
-        toHaveTextContaining(text: string | string[], options?: ExpectWebdriverIO.StringOptions): R
+        toHaveTextContaining(text: string | RegExp | Array<string | RegExp>, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
         * `WebdriverIO.Element` -> `getAttribute("style")`
@@ -235,26 +236,26 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Browser` -> `getUrl`
          */
-        toHaveUrl(url: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveUrl(url: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         // ===== browser only =====
         /**
          * `WebdriverIO.Browser` -> `getUrl`
          * Browser's url includes the provided text
          */
-        toHaveUrlContaining(url: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveUrlContaining(url: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Browser` -> `getTitle`
          */
-        toHaveTitle(title: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveTitle(title: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         // ===== browser only =====
         /**
          * `WebdriverIO.Browser` -> `getTitle`
          * Browser's title includes the provided text
          */
-        toHaveTitleContaining(title: string, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveTitleContaining(title: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
 
         // ===== $$ only =====
         /**

package/types/jest-global.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="expect-webdriverio/types/standalone"/>
+/// <reference types="./standalone.js"/>
 
 declare const expect: ExpectWebdriverIO.Expect
 

package/types/standalone.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="expect-webdriverio/types/expect-webdriverio"/>
+/// <reference types="./expect-webdriverio.js"/>
 
 declare namespace ExpectWebdriverIO {
-    interface Matchers<R, T> extends Readonly<import('expect/build/types').Matchers<R>> {
+    interface Matchers<R, T> extends Readonly<import('expect').Matchers<R>> {
         not: Matchers<R, T>
         resolves: Matchers<Promise<R>, T>
         rejects: Matchers<Promise<R>, T>

package/lib/addMatchers.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addMatchers = exports.loadExpect = exports.isJasmine = void 0;
-let expectLib;
-const isJasmine = () => {
-    return Boolean(global.jasmine && global.expect && global.expectAsync && global.jasmine.getEnv && global.jasmine.addMatchers && global.jasmine.addAsyncMatchers);
-};
-exports.isJasmine = isJasmine;
-const loadExpect = () => {
-    try {
-        return expectLib = require('expect');
-    }
-    catch (err) {
-        return console.error('Failed to load expect package. Make sure it has been installed: npm i expect');
-    }
-};
-exports.loadExpect = loadExpect;
-const addMatchers = () => {
-    if (global.expect === undefined) {
-        if (!exports.loadExpect()) {
-            return;
-        }
-        global.expect = expectLib;
-    }
-    else {
-        expectLib = global.expect;
-    }
-    if (!global.expect.extend && !exports.isJasmine()) {
-        if (!exports.loadExpect()) {
-            return;
-        }
-        global.expectWdio = expectLib;
-        console.warn('Warning! Unsupported expect lib is used.\n' +
-            "Only Jasmine >= 3.3.0 and Jest's expect are supported.\n" +
-            "expect-webdriverio is assigned to global.expectWdio");
-    }
-    require('./options').setDefaultOptions;
-    const matchers = require('./matchers').default;
-    if (expectLib.extend) {
-        return expectLib.extend({ ...matchers });
-    }
-    expectLib = global.jasmine;
-    return expectLib.getEnv().beforeAll(function addExpectWebdriverIOMatchers() {
-        expectLib.addAsyncMatchers({ ...matchers });
-        global.expect = global.expectAsync;
-    });
-};
-exports.addMatchers = addMatchers;

package/lib/matchers/element/toHaveElementClass.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toHaveClass = exports.toHaveElementClass = void 0;
-const utils_1 = require("../../utils");
-const expectAdapter_1 = require("../../util/expectAdapter");
-async function condition(el, attribute, value, options) {
-    const { ignoreCase = false, trim = false, containing = false } = options;
-    let attr = await el.getAttribute(attribute);
-    if (typeof attr !== 'string') {
-        return { result: false };
-    }
-    if (trim) {
-        attr = attr.trim();
-    }
-    if (ignoreCase) {
-        attr = attr.toLowerCase();
-        value = value.toLowerCase();
-    }
-    if (containing) {
-        return {
-            result: attr.includes(value),
-            value: attr
-        };
-    }
-    const classes = attr.split(' ');
-    return {
-        result: classes.includes(value),
-        value: attr
-    };
-}
-function toHaveElementClassFn(received, className, options = {}) {
-    const isNot = this.isNot;
-    const { expectation = 'class', verb = 'have' } = this;
-    const attribute = 'class';
-    return browser.call(async () => {
-        let el = await received;
-        let attr;
-        const pass = await utils_1.waitUntil(async () => {
-            const result = await utils_1.executeCommand.call(this, el, condition, options, [attribute, className, options]);
-            el = result.el;
-            attr = result.values;
-            return result.success;
-        }, isNot, options);
-        utils_1.updateElementsArray(pass, received, el);
-        const message = utils_1.enhanceError(el, utils_1.wrapExpectedWithArray(el, attr, className), attr, this, verb, expectation, '', options);
-        return {
-            pass,
-            message: () => message
-        };
-    });
-}
-function toHaveElementClass(...args) {
-    return expectAdapter_1.runExpect.call(this, toHaveElementClassFn, args);
-}
-exports.toHaveElementClass = toHaveElementClass;
-function toHaveClass(...args) {
-    console.warn('expect(...).toHaveClass is deprecated and will be removed in next release. Use toHaveElementClass instead.');
-    return expectAdapter_1.runExpect.call(this, toHaveElementClassFn, args);
-}
-exports.toHaveClass = toHaveClass;

package/lib/matchers/element/toHaveElementClassContaining.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toHaveClassContaining = exports.toHaveElementClassContaining = void 0;
-const expectAdapter_1 = require("../../util/expectAdapter");
-const toHaveAttribute_1 = require("./toHaveAttribute");
-function toHaveElementClassContainingFn(el, className, options = {}) {
-    return toHaveAttribute_1.toHaveAttributeAndValueFn.call(this, el, 'class', className, {
-        ...options,
-        containing: true
-    });
-}
-function toHaveElementClassContaining(...args) {
-    return expectAdapter_1.runExpect.call(this, toHaveElementClassContainingFn, args);
-}
-exports.toHaveElementClassContaining = toHaveElementClassContaining;
-function toHaveClassContaining(...args) {
-    console.warn('expect(...).toHaveClassContaining is deprecated and will be removed in next release. Use toHaveElementClassContaining instead.');
-    return expectAdapter_1.runExpect.call(this, toHaveElementClassContainingFn, args);
-}
-exports.toHaveClassContaining = toHaveClassContaining;

package/lib/matchers/mock/toBeRequestedWithResponse.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toBeRequestedWithResponse = void 0;
-const toBeRequestedWith_1 = require("./toBeRequestedWith");
-const expectAdapter_1 = require("../../util/expectAdapter");
-function toBeRequestedWithResponseFn(received, response, options = {}) {
-    return toBeRequestedWith_1.toBeRequestedWithFn.call(this, received, { response }, options);
-}
-function toBeRequestedWithResponse(...args) {
-    console.warn('expect(...).toBeRequestedWithResponse is deprecated and will be removed in next release. Use toBeRequestedWith instead.');
-    return expectAdapter_1.runExpect.call(this, toBeRequestedWithResponseFn, args);
-}
-exports.toBeRequestedWithResponse = toBeRequestedWithResponse;

package/lib/options.js

@@ -1,33 +0,0 @@
-"use strict";
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setDefaultOptions = exports.getConfig = void 0;
-const DEFAULT_OPTIONS = {
-    wait: 2000,
-    interval: 100,
-};
-let mode = 'jest';
-let expectLib;
-if (global.expectWdio) {
-    expectLib = global.expectWdio;
-}
-else if (global.jasmine && !((_a = global.expect) === null || _a === void 0 ? void 0 : _a.extend)) {
-    expectLib = global.jasmine;
-    mode = 'jasmine';
-}
-else {
-    expectLib = global.expect;
-}
-if (!expectLib._expectWebdriverio) {
-    expectLib._expectWebdriverio = { options: { ...DEFAULT_OPTIONS }, mode };
-}
-const getConfig = () => expectLib._expectWebdriverio;
-exports.getConfig = getConfig;
-const setDefaultOptions = (options = {}) => {
-    Object.entries(options).forEach(([key, value]) => {
-        if (key in DEFAULT_OPTIONS) {
-            expectLib._expectWebdriverio.options[key] = value;
-        }
-    });
-};
-exports.setDefaultOptions = setDefaultOptions;

package/lib/util/expectAdapter.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.runExpect = exports.runJasmineExpect = exports.jestResultToJasmine = exports.buildJasmineFromJestResult = exports.runJestExpect = exports.getContext = void 0;
-const options_1 = require("../options");
-const config = options_1.getConfig();
-const { mode: MODE } = config;
-const getContext = (context) => global === context ? {} : context || {};
-exports.getContext = getContext;
-function runJestExpect(fn, args) {
-    return fn.apply(this, args);
-}
-exports.runJestExpect = runJestExpect;
-const buildJasmineFromJestResult = (result, isNot) => {
-    return {
-        pass: result.pass !== isNot,
-        message: result.message()
-    };
-};
-exports.buildJasmineFromJestResult = buildJasmineFromJestResult;
-const jestResultToJasmine = (result, isNot) => {
-    if (result instanceof Promise) {
-        return result.then(jestStyleResult => exports.buildJasmineFromJestResult(jestStyleResult, isNot));
-    }
-    return exports.buildJasmineFromJestResult(result, isNot);
-};
-exports.jestResultToJasmine = jestResultToJasmine;
-function runJasmineExpect(fn) {
-    const context = exports.getContext(this);
-    return {
-        compare(...args) {
-            const result = fn.apply({ ...context, isNot: false }, args);
-            return exports.jestResultToJasmine(result, false);
-        },
-        negativeCompare(...args) {
-            const result = fn.apply({ ...context, isNot: true }, args);
-            return exports.jestResultToJasmine(result, true);
-        }
-    };
-}
-exports.runJasmineExpect = runJasmineExpect;
-exports.runExpect = MODE === 'jasmine' ? runJasmineExpect : runJestExpect;

package/types/standalone-global.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="expect-webdriverio/types/standalone"/>
-
-declare const expectWdio: ExpectWebdriverIO.Expect
-
-declare namespace NodeJS {
-    interface Global {
-        expectWdio: ExpectWebdriverIO.Expect;
-    }
-}