Fix jest global + review customs matchers

Author: dprevost-LMI

jest.d.ts

@@ -7,7 +7,7 @@
 
 declare namespace jest {
 
-    interface Matchers<R extends void | Promise<void>, T> extends ExpectWebdriverIO.CustomMatchers<R, T> {
+    interface Matchers<R extends void | Promise<void>, T> extends ExpectWebdriverIO.Matchers<R, T> {
 
         /**
          * Below are overloaded Jest's matchers not part of `expect` but of `jest-snapshot`.

…omMatchers/customMatchers-namespace.d.ts test-types/jasmine/customMatchers.d.tstest-types/jasmine/customMatchers/customMatchers-namespace.d.ts renamed to test-types/jasmine/customMatchers.d.ts test-types/jasmine/customMatchers/customMatchers-namespace.d.ts renamed to test-types/jasmine/customMatchers.d.ts

@@ -5,7 +5,7 @@
 declare namespace ExpectWebdriverIO {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     interface Matchers<R, T> {
-        toBeCustom(): Promise<void>;
+        toBeCustomWdio(): Promise<void>;
     }
 }
 

test-types/jasmine/jasmine.test-d.ts

@@ -232,8 +232,8 @@ describe('Jasmine type agumentations', () => {
         describe('Custom matchers', () => {
             describe('using `ExpectWebdriverIO` namespace augmentation', () => {
                 it('should return Promise<void> for a non-promise custom matcher', async () => {
-                    expectTypeOf(expectAsync('test').toBeCustom()).toEqualTypeOf<Promise<void>>()
-                    expectTypeOf(expectAsync('test').not.toBeCustom()).toEqualTypeOf<Promise<void>>()
+                    expectTypeOf(expectAsync('test').toBeCustomWdio()).toEqualTypeOf<Promise<void>>()
+                    expectTypeOf(expectAsync('test').not.toBeCustomWdio()).toEqualTypeOf<Promise<void>>()
 
                     expectTypeOf(expectAsync('test').toBeCustomJasmine()).toEqualTypeOf<Promise<void>>()
                     expectTypeOf(expectAsync('test').not.toBeCustomJasmine()).toEqualTypeOf<Promise<void>>()
@@ -352,7 +352,7 @@ describe('Jasmine type agumentations', () => {
         })
 
         it('should support custom matchers', async () => {
-            expectTypeOf(wdioExpect('test').toBeCustom()).toEqualTypeOf<Promise<void>>()
+            expectTypeOf(wdioExpect('test').toBeCustomWdio()).toEqualTypeOf<Promise<void>>()
         })
 
         describe('Support soft Assertions on wdioExpect only (not supported on expect global since its Jasmine)', async () => {

test-types/jest-@jest_global/types-jest.test.ts

@@ -2,19 +2,25 @@ import 'expect'
 
 /**
  * Custom matchers under the `expect` module.
+ *
+ * LIMITATION: This augmentation is specifically required for `expect.soft(...)` support.
+ * It does NOT affect the global `expect(...)` in Jest which uses `namespace jest`.
+ *
+ * For universal support, prefer augmenting `ExpectWebdriverIO` namespace.
+ *
  * @see {@link https://jestjs.io/docs/expect#expectextendmatchers}
  */
 declare module 'expect' {
     interface AsymmetricMatchers {
-        toBeWithinRange(floor: number, ceiling: number): void
-        toHaveSimpleCustomProperty(string: string): string
-        toHaveCustomProperty(element: ChainablePromiseElement | WebdriverIO.Element): Promise<ExpectWebdriverIO.PartialMatcher<string>>
+        toBeWithinRangeExpect(floor: number, ceiling: number): void
+        toHaveSimpleCustomPropertyExpect(string: string): string
+        toHaveCustomPropertyExpect(element: ChainablePromiseElement | WebdriverIO.Element): Promise<ExpectWebdriverIO.PartialMatcher<string>>
     }
 
     interface Matchers<R, T> {
-        toBeWithinRange(floor: number, ceiling: number): R
-        toHaveSimpleCustomProperty(string: string | ExpectWebdriverIO.PartialMatcher<string>): Promise<R>
-        toHaveCustomProperty:
+        toBeWithinRangeExpect(floor: number, ceiling: number): R
+        toHaveSimpleCustomPropertyExpect(string: string | ExpectWebdriverIO.PartialMatcher<string>): Promise<R>
+        toHaveCustomPropertyExpect:
         // Useful to typecheck the custom matcher so it is only used on elements
         T extends ChainablePromiseElement | WebdriverIO.Element ?
             (test: string | ExpectWebdriverIO.PartialMatcher<string> |
@@ -23,4 +29,4 @@ declare module 'expect' {
             // Using `never` blocks the call on non-element types
             => Promise<R> : never;
     }
-}
+}

test-types/jest-@types_jest/customMatchers/customMatchers-module-expect.d.ts

@@ -1,14 +1,18 @@
 /**
  * Custom matchers under the `ExpectWebdriverIO` namespace.
+ *
+ * RECOMMENDED: This augmentation works universally.
+ * It is supported by both the global `expect` in Jest/Jasmine AND `expect.soft`.
+ *
  * @see {@link https://webdriver.io/docs/custommatchers/#typescript-support}
  */
 declare namespace ExpectWebdriverIO {
     interface AsymmetricMatchers {
-        toBeCustom(): ExpectWebdriverIO.PartialMatcher<string>;
-        toBeCustomPromise(chainableElement: ChainablePromiseElement): Promise<ExpectWebdriverIO.PartialMatcher<string>>;
+        toBeCustomWdio(): ExpectWebdriverIO.PartialMatcher<string>;
+        toBeCustomPromiseWdio(chainableElement: ChainablePromiseElement): Promise<ExpectWebdriverIO.PartialMatcher<string>>;
     }
     interface Matchers<R, T> {
-        toBeCustom(): R;
-        toBeCustomPromise: T extends ChainablePromiseElement ? (expected?: string | ExpectWebdriverIO.PartialMatcher<string> | Promise<ExpectWebdriverIO.PartialMatcher<string>>) => Promise<R> : never;
+        toBeCustomWdio(): R;
+        toBeCustomPromiseWdio: T extends ChainablePromiseElement ? (expected?: string | ExpectWebdriverIO.PartialMatcher<string> | Promise<ExpectWebdriverIO.PartialMatcher<string>>) => Promise<R> : never;
     }
-}
+}

test-types/jest-@types_jest/customMatchers/customMatchers-namespace-expectwebdriverio.d.ts

@@ -0,0 +1,34 @@
+declare namespace jest {
+    /**
+     * Custom matchers under the `jest` namespace.
+     *
+     * LIMITATION: This augmentation only works for the global `expect(...)` in the Jest environment.
+     * It does NOT support `expect.soft(...)` which uses the standalone `expect` types.
+     *
+     * For universal support, prefer augmenting `ExpectWebdriverIO` namespace.
+     */
+    interface Expect {
+        toBeWithinRangeJest(floor: number, ceiling: number): void
+        toHaveSimpleCustomPropertyJest(string: string): string
+        toHaveCustomPropertyJest(element: ChainablePromiseElement | WebdriverIO.Element): Promise<ExpectWebdriverIO.PartialMatcher<string>>
+    }
+
+    interface InverseAsymmetricMatchers {
+        toBeWithinRangeJest(floor: number, ceiling: number): void
+        toHaveSimpleCustomPropertyJest(string: string): string
+        toHaveCustomPropertyJest(element: ChainablePromiseElement | WebdriverIO.Element): Promise<ExpectWebdriverIO.PartialMatcher<string>>
+    }
+
+    interface Matchers<R, T> {
+        toBeWithinRangeJest(floor: number, ceiling: number): R
+        toHaveSimpleCustomPropertyJest(string: string | ExpectWebdriverIO.PartialMatcher<string>): Promise<R>
+        toHaveCustomPropertyJest:
+        // Useful to typecheck the custom matcher so it is only used on elements
+        T extends ChainablePromiseElement | WebdriverIO.Element ?
+            (test: string | ExpectWebdriverIO.PartialMatcher<string> |
+                // Needed for the custom asymmetric matcher defined above to be typed correctly
+                Promise<ExpectWebdriverIO.PartialMatcher<string>>)
+            // Using `never` blocks the call on non-element types
+            => Promise<R> : never;
+    }
+}