expect-webdriverio 5.6.8 → 5.6.9

package/jest.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="./types/expect-webdriverio.d.ts"/>
 
 /**
- * Augment the Jest namespace to include the matchers from expect-webdriverio.
- * When Jest Library is used, it specifies `expect-webdriverio/jest` for this file in the tsconfig.json's types.
+ * Augment the Jest namespace to include the WebDriverIO custom matchers only.
+ * When Jest Library is used, specify `expect-webdriverio/jest` for this file in the tsconfig.json's types.
  */
 
 declare namespace jest {
@@ -13,7 +13,7 @@ declare namespace jest {
          * Below are overloaded Jest's matchers not part of `expect` but of `jest-snapshot`.
          * @see https://github.com/jestjs/jest/blob/73dbef5d2d3195a1e55fb254c54cce70d3036252/packages/jest-snapshot/src/types.ts#L37
          *
-         *  Note: We need to define them below so that they are correctly typed overloaded.
+         *  Note: We need to define them below so that they are correctly overloaded.
          *  Else even when extending `WdioJestOverloadedMatchers` we have typing errors.
          */
 
@@ -21,17 +21,17 @@ declare namespace jest {
          * snapshot matcher
          * @param label optional snapshot label
          */
-        toMatchSnapshot(label?: string): T extends WdioPromiseLike ? Promise<void> : void;
+        toMatchSnapshot(label?: string): T extends WdioElementOrPromiseLike ? Promise<void> : R;
 
         /**
          * inline snapshot matcher
          * @param snapshot snapshot string (autogenerated if not specified)
          * @param label optional snapshot label
          */
-        toMatchInlineSnapshot(snapshot?: string, label?: string): T extends WdioPromiseLike ? Promise<void> : void;
+        toMatchInlineSnapshot(snapshot?: string, label?: string): T extends WdioElementOrPromiseLike ? Promise<void> : R;
     }
 
     interface Expect extends ExpectWebdriverIO.Expect {}
 
     interface InverseAsymmetricMatchers extends ExpectWebdriverIO.AsymmetricMatchers {}
-}
+}

package/lib/index.js

@@ -3,6 +3,7 @@ import * as wdioMatchers from './matchers.js';
 import { DEFAULT_OPTIONS, defaultOptionsList } from './constants.js';
 import createSoftExpect from './softExpect.js';
 import { SoftAssertService } from './softAssert.js';
+export const wdioCustomMatchers = {};
 export const matchers = new Map();
 const filteredMatchers = {};
 const extend = expectLib.extend;
@@ -15,7 +16,10 @@ expectLib.extend = (m) => {
     if (!m || typeof m !== 'object') {
         return;
     }
-    Object.entries(m).forEach(([name, matcher]) => matchers.set(name, matcher));
+    Object.entries(m).forEach(([name, matcher]) => {
+        wdioCustomMatchers[name] = matcher;
+        matchers.set(name, matcher);
+    });
     return extend(m);
 };
 expectLib.extend(filteredMatchers);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "5.6.8",
+  "version": "5.6.9",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
@@ -71,7 +71,7 @@
     "ts:mocha": "cd test-types/mocha && vitest --typecheck --typecheck.tsconfig ./tsconfig.json --run",
     "checks:all": "npm run build && npm run compile && npm run tsc:root-types && npm run test && npm run ts",
     "watch": "npm run compile -- --watch",
-    "prepare": "husky install",
+    "prepare": "husky",
     "playgrounds:setup": "cd playgrounds && npm run setup",
     "playgrounds:checks:all": "cd playgrounds && npm run checks:all",
     "playgrounds:snapshots:update": "cd playgrounds && npm run snapshots:update"
@@ -97,7 +97,6 @@
     "npm-run-all2": "^9.0.1",
     "release-it": "^20.2.0",
     "rimraf": "^6.1.3",
-    "shelljs": "^0.10.0",
     "typescript": "^5.9.3",
     "vitest": "^4.1.7",
     "webdriverio": "^9.27.2"

package/types/expect-global.d.ts

@@ -12,4 +12,4 @@ declare namespace NodeJS {
     interface Global {
         expect: ExpectWebdriverIO.Expect
     }
-}
+}

package/types/expect-webdriverio.d.ts

@@ -20,6 +20,7 @@ type ExpectLibSyncExpectationResult = import('expect').SyncExpectationResult
 type ExpectLibAsyncExpectationResult = import('expect').AsyncExpectationResult
 type ExpectLibExpectationResult = import('expect').ExpectationResult
 type ExpectLibMatcherContext = import('expect').MatcherContext
+type MatchersObject = Parameters<typeof import('expect').expect.extend>[0]
 
 // Extracted from the expect library, this is the type of the matcher function used in the expect library.
 type RawMatcherFn<Context extends ExpectLibMatcherContext = ExpectLibMatcherContext> = {
@@ -31,6 +32,7 @@ type RawMatcherFn<Context extends ExpectLibMatcherContext = ExpectLibMatcherCont
  * Real Promise and wdio chainable promise types.
  */
 type WdioPromiseLike<T = unknown> = PromiseLike<T> | ChainablePromiseElement | ChainablePromiseArray
+type WdioElementOrPromiseLike<T = unknown> = WdioPromiseLike<T> | WebdriverIO.Element
 type ElementPromise = Promise<WebdriverIO.Element>
 type ElementArrayPromise = Promise<WebdriverIO.ElementArray>
 
@@ -201,7 +203,7 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
         ActualT,
         (
             property: string,
-            value?: string | RegExp | WdioAsymmetricMatcher<string> | null,
+            value?: string | RegExp | ExpectWebdriverIO.PartialMatcher<string> | null,
             options?: ExpectWebdriverIO.StringOptions,
         ) => Promise<void>
     >
@@ -396,18 +398,18 @@ interface WdioElementArrayOnlyMatchers<_R, ActualT = unknown> {
  * Therefore, they also need to be redefined in the jest.d.ts file so correctly overload the matchers from the Jest namespace.
  * @see jest.d.ts
  */
-interface WdioJestOverloadedMatchers<_R, ActualT> {
+interface WdioJestOverloadedMatchers<R, ActualT> {
     /**
      * snapshot matcher
      * @param label optional snapshot label
      */
-    toMatchSnapshot(label?: string): ActualT extends WdioPromiseLike ? Promise<void> : void;
+    toMatchSnapshot(label?: string): ActualT extends WdioElementOrPromiseLike ? Promise<void> : R
     /**
      * inline snapshot matcher
      * @param snapshot snapshot string (autogenerated if not specified)
      * @param label optional snapshot label
      */
-    toMatchInlineSnapshot(snapshot?: string, label?: string): ActualT extends WdioPromiseLike ? Promise<void> : void;
+    toMatchInlineSnapshot(snapshot?: string, label?: string): ActualT extends WdioElementOrPromiseLike ? Promise<void> : R
 }
 
 /**
@@ -583,17 +585,25 @@ declare namespace ExpectWebdriverIO {
     type AsyncAssertionResult = ExpectLibAsyncExpectationResult
 
     /**
-     * Used by the wdio main project to configure the matchers in the runner when using Jasmine or Jest.
+     * Used to register wdio custom matcher like the Jest's `expect.extend`. Wdio main project configure the matchers in the runner when using Jasmine.
+     * Contains only the custom matchers from wdio, and not the ones from the expect library, to avoid any conflict with the matchers from the expect library when using Jasmine or Jest.
+     * Map to src/index.ts#wdioCustomMatchers
+     *
      * Equivalent as `MatchersObject` from the expect library.
      * @see https://github.com/jestjs/jest/blob/fd3d6cf9fe416b549a74b6577e5e1ea1130e3659/packages/expect/src/types.ts#L43C13-L43C27
      */
+    const wdioCustomMatchers: MatchersObject
+
+    /**
+     * @deprecated use `wdioCustomMatchers` instead
+     */
     const matchers: Map<string, RawMatcherFn>
 
     interface AssertionHookParams {
         /**
          * name of the matcher, e.g. `toHaveText` or `toBeClickable`
          */
-        matcherName: keyof Matchers<void, unknown>,
+        matcherName: keyof Matchers<void, unknown>
         /**
          * Value that the user has passed in
          *