expect-webdriverio 4.7.1 → 4.8.0

package/lib/index.js

@@ -1,8 +1,7 @@
-import { jestExpect as expectLib } from '@jest/expect';
+import { expect as expectLib } from 'expect';
 import wdioMatchers from './matchers.js';
 import * as expectUtils from './utils.js';
 import { DEFAULT_OPTIONS } from './constants.js';
-expectLib.setState({ suppressedErrors: [] });
 expectLib.extend({ ...wdioMatchers });
 export const expect = expectLib;
 export const matchers = wdioMatchers;

package/lib/matchers.js

@@ -16,7 +16,6 @@ import * as toHaveClass from './matchers/element/toHaveClass.js';
 import * as toHaveHref from './matchers/element/toHaveHref.js';
 import * as toHaveId from './matchers/element/toHaveId.js';
 import * as toHaveSize from './matchers/element/toHaveSize.js';
-import * as toMatchElementSnapshot from './matchers/element/toMatchElementSnapshot.js';
 import * as toHaveElementProperty from './matchers/element/toHaveElementProperty.js';
 import * as toHaveText from './matchers/element/toHaveText.js';
 import * as toHaveValue from './matchers/element/toHaveValue.js';
@@ -24,9 +23,7 @@ import * as toHaveStyle from './matchers/element/toHaveStyle.js';
 import * as toBeRequested from './matchers/mock/toBeRequested.js';
 import * as toBeRequestedTimes from './matchers/mock/toBeRequestedTimes.js';
 import * as toBeRequestedWith from './matchers/mock/toBeRequestedWith.js';
-import * as toMatchSnapshot from './matchers/general/toMatchSnapshot.js';
 const matchers = {
-    ...toMatchSnapshot,
     ...toHaveClipboardText,
     ...toHaveTitle,
     ...toHaveUrl,
@@ -49,7 +46,6 @@ const matchers = {
     ...toHaveText,
     ...toHaveValue,
     ...toHaveStyle,
-    ...toMatchElementSnapshot,
     ...toBeRequested,
     ...toBeRequestedTimes,
     ...toBeRequestedWith,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "4.7.1",
+  "version": "4.8.0",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
@@ -59,34 +59,32 @@
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",
-    "@types/jest": "^29.5.8",
+    "@types/jest": "^29.5.11",
     "@types/lodash.isequal": "^4.5.8",
-    "@types/node": "^20.9.2",
-    "@typescript-eslint/eslint-plugin": "^6.11.0",
-    "@typescript-eslint/parser": "^6.11.0",
-    "@vitest/coverage-v8": "^0.34.6",
-    "@wdio/globals": "^8.23.1",
-    "c8": "^8.0.1",
-    "eslint": "^8.54.0",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-unicorn": "^49.0.0",
+    "@types/node": "^20.10.6",
+    "@typescript-eslint/eslint-plugin": "^6.17.0",
+    "@typescript-eslint/parser": "^6.17.0",
+    "@vitest/coverage-v8": "^1.1.3",
+    "c8": "^9.0.0",
+    "eslint": "^8.56.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-unicorn": "^50.0.1",
     "husky": "^8.0.3",
     "npm-run-all": "^4.1.5",
-    "release-it": "^17.0.0",
+    "release-it": "^17.0.1",
     "rimraf": "^5.0.5",
     "shelljs": "^0.8.5",
-    "typescript": "^5.2.2",
-    "vitest": "0.34.6",
-    "webdriverio": "8.24.6"
+    "typescript": "^5.3.3",
+    "vitest": "1.1.3",
+    "webdriverio": "8.27.0"
   },
   "optionalDependencies": {
-    "@wdio/globals": "^8.23.1",
-    "@wdio/logger": "^8.16.17",
-    "webdriverio": "^8.23.1"
+    "@wdio/globals": "^8.27.0",
+    "@wdio/logger": "^8.24.12",
+    "webdriverio": "^8.27.0"
   },
   "dependencies": {
-    "jest-snapshot": "^29.7.0",
-    "@jest/expect": "^29.7.0",
+    "expect": "^29.7.0",
     "jest-matcher-utils": "^29.7.0",
     "lodash.isequal": "^4.5.0"
   }

package/types/expect-webdriverio.d.ts

@@ -1,5 +1,7 @@
 declare namespace ExpectWebdriverIO {
-    const expect: ExpectWebdriverIO.Expect
+    function expect<T = unknown, R extends void | Promise<void> = void | Promise<void>>(
+        actual: T
+    ): Matchers<R, T>
     function setOptions(options: DefaultOptions): void
     function getConfig(): any
 
@@ -20,7 +22,7 @@ declare namespace ExpectWebdriverIO {
         /**
          * name of the matcher, e.g. `toHaveText` or `toBeClickable`
          */
-        matcherName: keyof Matchers<unknown, unknown>,
+        matcherName: keyof Matchers<void, unknown>,
         /**
          * Value that the user has passed in
          *
@@ -143,29 +145,6 @@ declare namespace ExpectWebdriverIO {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<R, T> {
         // ===== $ or $$ =====
-        /**
-          * This ensures that element html value matches the most recent snapshot with property matchers.
-          */
-        toMatchElementSnapshot(hint?: string): R;
-        /**
-         * This ensures that element html matches the most recent snapshot.
-         */
-        toMatchElementSnapshot<U extends Record<keyof T, unknown>>(
-            propertyMatchers: Partial<U>,
-            hint?: string,
-        ): R;
-        /**
-         * This ensures that element html matches the most recent snapshot with property matchers.
-         */
-        toMatchElementInlineSnapshot(snapshot?: string): R;
-        /**
-         * This ensures that element html matches the most recent snapshot with property matchers.
-         */
-        toMatchElementInlineSnapshot<U extends Record<keyof T, unknown>>(
-            propertyMatchers: Partial<U>,
-            snapshot?: string,
-        ): R;
-
         /**
          * `WebdriverIO.Element` -> `isDisplayed`
          */
@@ -508,23 +487,23 @@ declare namespace ExpectWebdriverIO {
         method?: string | Array<string>
         statusCode?: number | Array<number>
         requestHeaders?:
-        | Record<string, string>
-        | ExpectWebdriverIO.PartialMatcher
-        | ((headers: Record<string, string>) => boolean)
+            | Record<string, string>
+            | ExpectWebdriverIO.PartialMatcher
+            | ((headers: Record<string, string>) => boolean)
         responseHeaders?:
-        | Record<string, string>
-        | ExpectWebdriverIO.PartialMatcher
-        | ((headers: Record<string, string>) => boolean)
+            | Record<string, string>
+            | ExpectWebdriverIO.PartialMatcher
+            | ((headers: Record<string, string>) => boolean)
         postData?:
-        | string
-        | ExpectWebdriverIO.JsonCompatible
-        | ExpectWebdriverIO.PartialMatcher
-        | ((r: string | undefined) => boolean)
+            | string
+            | ExpectWebdriverIO.JsonCompatible
+            | ExpectWebdriverIO.PartialMatcher
+            | ((r: string | undefined) => boolean)
         response?:
-        | string
-        | ExpectWebdriverIO.JsonCompatible
-        | ExpectWebdriverIO.PartialMatcher
-        | ((r: string) => boolean)
+            | string
+            | ExpectWebdriverIO.JsonCompatible
+            | ExpectWebdriverIO.PartialMatcher
+            | ((r: string) => boolean)
     }
 
     type jsonPrimitive = string | number | boolean | null

package/types/jest-global.d.ts

@@ -1,5 +1,8 @@
 /// <reference types="./standalone.js"/>
 
+// @ts-expect-error
+declare const expect: ExpectWebdriverIO.Expect
+
 declare namespace NodeJS {
     interface Global {
         expect: ExpectWebdriverIO.Expect;

package/types/standalone.d.ts

@@ -4,18 +4,18 @@ type ChainablePromiseElement = import('webdriverio').ChainablePromiseElement<Web
 type ChainablePromiseArray = import('webdriverio').ChainablePromiseArray<WebdriverIO.Element>
 
 declare namespace ExpectWebdriverIO {
-    interface Matchers<R extends void | Promise<void>, T> extends Readonly<import('expect').Matchers<R, T>>, Readonly<import('jest-snapshot').SnapshotMatchers<R, T>> {
+    interface Matchers<R extends void | Promise<void>, T> extends Readonly<import('expect').Matchers<R>> {
         not: Matchers<R, T>
         resolves: Matchers<R, T>
         rejects: Matchers<R, T>
     }
 
-    type Expect = Readonly<import('@jest/expect').JestExpect> & {
+    type Expect = {
         <T = unknown, R extends void | Promise<void> = void | Promise<void>>(actual: T): Matchers<R, T>
         extend(map: Record<string, Function>): void
     } & AsymmetricMatchers
 
-    type AsymmetricMatchers = {
+    interface AsymmetricMatchers {
         any(expectedObject: any): PartialMatcher
         anything(): PartialMatcher
         arrayContaining(sample: Array<unknown>): PartialMatcher

package/lib/matchers/element/toMatchElementSnapshot.js

@@ -1,9 +0,0 @@
-import { toMatchSnapshot as jestToMatchSnapshot, toMatchInlineSnapshot as jestToMatchInlineSnapshot } from 'jest-snapshot';
-export async function toMatchElementSnapshot(el, ...args) {
-    this.expectation = this.expectation || 'matchElementSnapshot';
-    return jestToMatchSnapshot.call(this, await el.getHTML(), ...args);
-}
-export async function toMatchElementInlineSnapshot(el, ...args) {
-    this.expectation = this.expectation || 'matchElementInlineSnapshot';
-    return jestToMatchInlineSnapshot.call(this, await el.getHTML(), ...args);
-}

package/lib/matchers/general/toMatchSnapshot.js

@@ -1,9 +0,0 @@
-import { toMatchSnapshot as jestToMatchSnapshot, toMatchInlineSnapshot as jestToMatchInlineSnapshot } from 'jest-snapshot';
-export async function toMatchSnapshot(received, ...args) {
-    this.expectation = this.expectation || 'matchSnapshot';
-    return jestToMatchSnapshot.call(this, await received, ...args);
-}
-export async function toMatchInlineSnapshot(received, ...args) {
-    this.expectation = this.expectation || 'matchInlineSnapshot';
-    return jestToMatchInlineSnapshot.call(this, await received, ...args);
-}