expect-webdriverio 4.6.1 → 4.7.0

package/lib/index.js

@@ -1,7 +1,8 @@
-import { expect as expectLib } from 'expect';
+import { jestExpect as expectLib } from '@jest/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/element/toMatchElementSnapshot.js

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,9 @@
+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);
+}

package/lib/matchers.js

@@ -16,6 +16,7 @@ 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';
@@ -23,7 +24,9 @@ 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,
@@ -46,6 +49,7 @@ const matchers = {
     ...toHaveText,
     ...toHaveValue,
     ...toHaveStyle,
+    ...toMatchElementSnapshot,
     ...toBeRequested,
     ...toBeRequestedTimes,
     ...toBeRequestedWith,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "4.6.1",
+  "version": "4.7.0",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
@@ -77,7 +77,7 @@
     "shelljs": "^0.8.5",
     "typescript": "^5.2.2",
     "vitest": "0.34.6",
-    "webdriverio": "8.23.1"
+    "webdriverio": "8.24.6"
   },
   "optionalDependencies": {
     "@wdio/globals": "^8.23.1",
@@ -85,7 +85,8 @@
     "webdriverio": "^8.23.1"
   },
   "dependencies": {
-    "expect": "^29.7.0",
+    "jest-snapshot": "^29.7.0",
+    "@jest/expect": "^29.7.0",
     "jest-matcher-utils": "^29.7.0",
     "lodash.isequal": "^4.5.0"
   }

package/types/expect-webdriverio.d.ts

@@ -1,7 +1,5 @@
 declare namespace ExpectWebdriverIO {
-    function expect<T = unknown, R extends void | Promise<void> = void | Promise<void>>(
-        actual: T
-    ): Matchers<R, T>
+    const expect: ExpectWebdriverIO.Expect
     function setOptions(options: DefaultOptions): void
     function getConfig(): any
 
@@ -145,6 +143,29 @@ 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`
          */
@@ -487,23 +508,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,7 +1,5 @@
 /// <reference types="./standalone.js"/>
 
-declare const expect: ExpectWebdriverIO.Expect
-
 declare namespace NodeJS {
     interface Global {
         expect: ExpectWebdriverIO.Expect;

package/types/standalone.d.ts

@@ -4,13 +4,13 @@ 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>> {
+    interface Matchers<R extends void | Promise<void>, T> extends Readonly<import('expect').Matchers<R, T>>, Readonly<import('jest-snapshot').SnapshotMatchers<R, T>> {
         not: Matchers<R, T>
         resolves: Matchers<R, T>
         rejects: Matchers<R, T>
     }
 
-    type Expect = {
+    type Expect = Readonly<import('@jest/expect').JestExpect> & {
         <T = unknown, R extends void | Promise<void> = void | Promise<void>>(actual: T): Matchers<R, T>
         extend(map: Record<string, Function>): void
     } & AsymmetricMatchers