expect-webdriverio 5.3.1 → 5.3.3

package/lib/test/utils.test.js

@@ -0,0 +1,117 @@
+import { describe, test, expect } from 'vitest';
+import { compareNumbers, compareText, compareTextWithArray } from '../src/utils.js';
+describe('utils', () => {
+    describe('compareText', () => {
+        test('should pass when strings match', () => {
+            expect(compareText('foo', 'foo', {}).result).toBe(true);
+        });
+        test('should fail when strings do not match', () => {
+            expect(compareText('foo', 'bar', {}).result).toBe(false);
+        });
+        test('should pass when trims away white space', () => {
+            expect(compareText(' foo ', 'foo', {}).result).toBe(true);
+        });
+        test('should fail without trimming away white space', () => {
+            expect(compareText(' foo ', 'foo ', { trim: false }).result).toBe(false);
+        });
+        test('should pass if same word but wrong case and using ignoreCase', () => {
+            expect(compareText(' FOO ', 'foo', { ignoreCase: true }).result).toBe(true);
+            expect(compareText(' foo ', 'FOO', { ignoreCase: true }).result).toBe(true);
+        });
+        test('should pass if string contains expected and using containing', () => {
+            expect(compareText('qwe_AsD_zxc', 'asd', { ignoreCase: true, containing: true }).result).toBe(true);
+        });
+        test('should support asymmetric matchers', () => {
+            expect(compareText('foo', expect.stringContaining('oo'), {}).result).toBe(true);
+            expect(compareText('foo', expect.not.stringContaining('oo'), {}).result).toBe(false);
+        });
+        test('should support asymmetric matchers and using ignoreCase', () => {
+            expect(compareText(' FOO ', expect.stringContaining('foo'), { ignoreCase: true }).result).toBe(true);
+            expect(compareText(' FOO ', expect.not.stringContaining('foo'), { ignoreCase: true }).result).toBe(false);
+            expect(compareText(' Foo ', expect.stringContaining('FOO'), { ignoreCase: true }).result).toBe(true);
+            expect(compareText(' Foo ', expect.not.stringContaining('FOO'), { ignoreCase: true }).result).toBe(false);
+            expect(compareText(' foo ', expect.stringContaining('foo'), { ignoreCase: true }).result).toBe(true);
+        });
+    });
+    describe('compareTextWithArray', () => {
+        test('should pass if strings match in array', () => {
+            expect(compareTextWithArray('foo', ['foo', 'bar'], {}).result).toBe(true);
+        });
+        test('should fail if string does not match in array', () => {
+            expect(compareTextWithArray('foo', ['foot', 'bar'], {}).result).toBe(false);
+        });
+        test('should pass if white space and using trim', () => {
+            expect(compareTextWithArray(' foo ', ['foo', 'bar'], { trim: true }).result).toBe(true);
+        });
+        test('should pass if wrong case and using ignoreCase', () => {
+            expect(compareTextWithArray(' FOO ', ['foO', 'bar'], { trim: true, ignoreCase: true }).result).toBe(true);
+            expect(compareTextWithArray(' foo ', ['foO', 'BAR'], { trim: true, ignoreCase: true }).result).toBe(true);
+            expect(compareTextWithArray(' foo ', ['foOo', 'BAR'], { trim: true, ignoreCase: true }).result).toBe(false);
+            expect(compareTextWithArray(' FOO ', ['foOO', 'bar'], { trim: true, ignoreCase: true }).result).toBe(false);
+        });
+        test('should pass if string contains and using containing', () => {
+            expect(compareTextWithArray('qwe_AsD_zxc', ['foo', 'ZXC'], { ignoreCase: true, containing: true }).result).toBe(true);
+            expect(compareTextWithArray('qwe_AsD_ZXC', ['foo', 'zxc'], { ignoreCase: true, containing: true }).result).toBe(true);
+            expect(compareTextWithArray('qwe_AsD_ZXC', ['foo', 'zxcc'], { ignoreCase: true, containing: true }).result).toBe(false);
+            expect(compareTextWithArray('qwe_AsD_ZXC', ['foo', 'zxcc'], { ignoreCase: true, containing: false }).result).toBe(false);
+        });
+        test('should support asymmetric matchers', () => {
+            expect(compareTextWithArray('foo', [expect.stringContaining('oo'), expect.stringContaining('oobb')], {}).result).toBe(true);
+            expect(compareTextWithArray('foo', [expect.stringContaining('oobb'), expect.stringContaining('oo')], {}).result).toBe(true);
+            expect(compareTextWithArray('foo', [expect.not.stringContaining('oo'), expect.stringContaining('oobb')], {}).result).toBe(false);
+            expect(compareTextWithArray('foo', [expect.stringContaining('oobb'), expect.not.stringContaining('oo')], {}).result).toBe(false);
+            expect(compareTextWithArray('foo', [expect.stringContaining('oo'), expect.not.stringContaining('oobb')], {}).result).toBe(true);
+            expect(compareTextWithArray('foo', [expect.not.stringContaining('oobb'), expect.not.stringContaining('oo')], {}).result).toBe(true);
+            expect(compareTextWithArray('foo', [expect.not.stringContaining('oof'), expect.not.stringContaining('oobb')], {}).result).toBe(true);
+            expect(compareTextWithArray('foo', [expect.not.stringContaining('oo'), expect.not.stringContaining('foo')], {}).result).toBe(false);
+        });
+        test('should support asymmetric matchers and using ignoreCase', () => {
+            expect(compareTextWithArray(' FOO ', [expect.stringContaining('foo'), expect.stringContaining('oobb')], { ignoreCase: true }).result).toBe(true);
+            expect(compareTextWithArray(' FOO ', [expect.not.stringContaining('foo'), expect.stringContaining('oobb')], { ignoreCase: true }).result).toBe(false);
+            expect(compareTextWithArray(' foo ', [expect.stringContaining('FOO'), expect.stringContaining('oobb')], { ignoreCase: true }).result).toBe(true);
+            expect(compareTextWithArray(' foo ', [expect.not.stringContaining('FOO'), expect.stringContaining('oobb')], { ignoreCase: true }).result).toBe(false);
+            expect(compareTextWithArray(' foo ', [expect.stringContaining('FOO'), 'oobb'], { ignoreCase: true }).result).toBe(true);
+            expect(compareTextWithArray(' foo ', [expect.not.stringContaining('FOO'), 'oobb'], { ignoreCase: true }).result).toBe(false);
+            expect(compareTextWithArray('foo', [expect.stringContaining('FOOO'), 'FOO'], { ignoreCase: true }).result).toBe(true);
+            expect(compareTextWithArray(' foo ', [expect.not.stringContaining('OO'), expect.not.stringContaining('FOOO')], { ignoreCase: true }).result).toBe(true);
+            expect(compareTextWithArray(' foo ', [expect.not.stringContaining('FOOO'), expect.not.stringContaining('OO')], { ignoreCase: true }).result).toBe(true);
+            expect(compareTextWithArray(' foo ', [expect.not.stringContaining('FOOO'), expect.not.stringContaining('OOO')], { ignoreCase: true }).result).toBe(true);
+            expect(compareTextWithArray(' foo ', [expect.not.stringContaining('FOO'), expect.not.stringContaining('OO')], { ignoreCase: true }).result).toBe(false);
+        });
+    });
+    describe('compareNumbers', () => {
+        test('should work when equal', () => {
+            const actual = 10;
+            const eq = 10;
+            expect(compareNumbers(actual, { eq })).toBe(true);
+        });
+        test('should pass when using gte and number is greater', () => {
+            const actual = 10;
+            const gte = 5;
+            expect(compareNumbers(actual, { gte })).toBe(true);
+        });
+        test('should pass when using lte and number is lower', () => {
+            const actual = 10;
+            const lte = 20;
+            expect(compareNumbers(actual, { lte })).toBe(true);
+        });
+        test('should pass when usin lte and gte and number is in between', () => {
+            const actual = 10;
+            const lte = 20;
+            const gte = 1;
+            expect(compareNumbers(actual, { lte, gte })).toBe(true);
+        });
+        test('should fail when using lte and gte and is lte but not gte', () => {
+            const actual = 10;
+            const lte = 20;
+            const gte = 15;
+            expect(compareNumbers(actual, { lte, gte })).toBe(false);
+        });
+        test('should fail when using lte and gte and is gte but not lte', () => {
+            const actual = 10;
+            const lte = 9;
+            const gte = 1;
+            expect(compareNumbers(actual, { lte, gte })).toBe(false);
+        });
+    });
+});

package/lib/{tsconfig.build.tsbuildinfo → tsconfig.tsbuildinfo}

@@ -1 +1 @@
-{"root":["../src/constants.ts","../src/index.ts","../src/jasmineUtils.ts","../src/matchers.ts","../src/snapshot.ts","../src/softAssert.ts","../src/softAssertService.ts","../src/softExpect.ts","../src/types.ts","../src/utils.ts","../src/matchers/snapshot.ts","../src/matchers/browser/toHaveClipboardText.ts","../src/matchers/browser/toHaveTitle.ts","../src/matchers/browser/toHaveUrl.ts","../src/matchers/element/toBeClickable.ts","../src/matchers/element/toBeDisabled.ts","../src/matchers/element/toBeDisplayed.ts","../src/matchers/element/toBeDisplayedInViewport.ts","../src/matchers/element/toBeEnabled.ts","../src/matchers/element/toBeExisting.ts","../src/matchers/element/toBeFocused.ts","../src/matchers/element/toBeSelected.ts","../src/matchers/element/toHaveAttribute.ts","../src/matchers/element/toHaveChildren.ts","../src/matchers/element/toHaveClass.ts","../src/matchers/element/toHaveComputedLabel.ts","../src/matchers/element/toHaveComputedRole.ts","../src/matchers/element/toHaveElementProperty.ts","../src/matchers/element/toHaveHTML.ts","../src/matchers/element/toHaveHeight.ts","../src/matchers/element/toHaveHref.ts","../src/matchers/element/toHaveId.ts","../src/matchers/element/toHaveSize.ts","../src/matchers/element/toHaveStyle.ts","../src/matchers/element/toHaveText.ts","../src/matchers/element/toHaveValue.ts","../src/matchers/element/toHaveWidth.ts","../src/matchers/elements/toBeElementsArrayOfSize.ts","../src/matchers/mock/toBeRequested.ts","../src/matchers/mock/toBeRequestedTimes.ts","../src/matchers/mock/toBeRequestedWith.ts","../src/util/elementsUtil.ts","../src/util/executeCommand.ts","../src/util/formatMessage.ts","../src/util/refetchElements.ts"],"version":"5.8.3"}
+{"root":["../test/index.test.ts","../test/matchers.test.ts","../test/snapshot.test.ts","../test/softAssertions.test.ts","../test/utils.test.ts","../test/__fixtures__/utils.ts","../test/matchers/beMatchers.test.ts","../test/matchers/browserMatchers.test.ts","../test/matchers/browser/toHaveClipboardText.test.ts","../test/matchers/element/toBeDisabled.test.ts","../test/matchers/element/toHaveAttribute.test.ts","../test/matchers/element/toHaveChildren.test.ts","../test/matchers/element/toHaveComputedLabel.test.ts","../test/matchers/element/toHaveComputedRole.test.ts","../test/matchers/element/toHaveElementClass.test.ts","../test/matchers/element/toHaveElementProperty.test.ts","../test/matchers/element/toHaveHTML.test.ts","../test/matchers/element/toHaveHeight.test.ts","../test/matchers/element/toHaveHref.test.ts","../test/matchers/element/toHaveId.test.ts","../test/matchers/element/toHaveSize.test.ts","../test/matchers/element/toHaveStyle.test.ts","../test/matchers/element/toHaveText.test.ts","../test/matchers/element/toHaveValue.test.ts","../test/matchers/element/toHaveWidth.test.ts","../test/matchers/elements/toBeElementsArrayOfSize.test.ts","../test/matchers/mock/toBeRequested.test.ts","../test/matchers/mock/toBeRequestedTimes.test.ts","../test/matchers/mock/toBeRequestedWith.test.ts","../test/util/elementsUtil.test.ts","../test/util/formatMessage.test.ts","../test/util/refetchElements.test.ts","../src/constants.ts","../src/index.ts","../src/jasmineUtils.ts","../src/matchers.ts","../src/snapshot.ts","../src/softAssert.ts","../src/softAssertService.ts","../src/softExpect.ts","../src/types.ts","../src/utils.ts","../src/matchers/snapshot.ts","../src/matchers/browser/toHaveClipboardText.ts","../src/matchers/browser/toHaveTitle.ts","../src/matchers/browser/toHaveUrl.ts","../src/matchers/element/toBeClickable.ts","../src/matchers/element/toBeDisabled.ts","../src/matchers/element/toBeDisplayed.ts","../src/matchers/element/toBeDisplayedInViewport.ts","../src/matchers/element/toBeEnabled.ts","../src/matchers/element/toBeExisting.ts","../src/matchers/element/toBeFocused.ts","../src/matchers/element/toBeSelected.ts","../src/matchers/element/toHaveAttribute.ts","../src/matchers/element/toHaveChildren.ts","../src/matchers/element/toHaveClass.ts","../src/matchers/element/toHaveComputedLabel.ts","../src/matchers/element/toHaveComputedRole.ts","../src/matchers/element/toHaveElementProperty.ts","../src/matchers/element/toHaveHTML.ts","../src/matchers/element/toHaveHeight.ts","../src/matchers/element/toHaveHref.ts","../src/matchers/element/toHaveId.ts","../src/matchers/element/toHaveSize.ts","../src/matchers/element/toHaveStyle.ts","../src/matchers/element/toHaveText.ts","../src/matchers/element/toHaveValue.ts","../src/matchers/element/toHaveWidth.ts","../src/matchers/elements/toBeElementsArrayOfSize.ts","../src/matchers/mock/toBeRequested.ts","../src/matchers/mock/toBeRequestedTimes.ts","../src/matchers/mock/toBeRequestedWith.ts","../src/util/elementsUtil.ts","../src/util/executeCommand.ts","../src/util/formatMessage.ts","../src/util/refetchElements.ts"],"version":"5.8.3"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "5.3.1",
+  "version": "5.3.3",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
@@ -45,7 +45,7 @@
     "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",
+    "compile": "tsc --build tsconfig.json",
     "test": "run-s test:*",
     "test:lint": "eslint .",
     "test:unit": "vitest --run",

package/types/expect-webdriverio.d.ts

@@ -1,14 +1,16 @@
-type ServiceInstance =  import('@wdio/types').Services.ServiceInstance;
-type Test = import('@wdio/types').Frameworks.Test;
-type TestResult = import('@wdio/types').Frameworks.TestResult;
-type PickleStep = import('@wdio/types').Frameworks.PickleStep;
-type Scenario = import('@wdio/types').Frameworks.Scenario;
-type SnapshotResult = import('@vitest/snapshot').SnapshotResult;
-type SnapshotUpdateState = import('@vitest/snapshot').SnapshotUpdateState;
+/* eslint-disable @typescript-eslint/consistent-type-imports*/
+type ServiceInstance =  import('@wdio/types').Services.ServiceInstance
+type Test = import('@wdio/types').Frameworks.Test
+type TestResult = import('@wdio/types').Frameworks.TestResult
+type PickleStep = import('@wdio/types').Frameworks.PickleStep
+type Scenario = import('@wdio/types').Frameworks.Scenario
+type SnapshotResult = import('@vitest/snapshot').SnapshotResult
+type SnapshotUpdateState = import('@vitest/snapshot').SnapshotUpdateState
 
 declare namespace ExpectWebdriverIO {
     const expect: ExpectWebdriverIO.Expect
     function setOptions(options: DefaultOptions): void
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     function getConfig(): any
 
     interface SnapshotServiceArgs {
@@ -23,32 +25,34 @@ declare namespace ExpectWebdriverIO {
     }
 
     interface SoftFailure {
-        error: Error;
-        matcherName: string;
-        location?: string;
+        error: Error
+        matcherName: string
+        location?: string
     }
 
     class SoftAssertService {
-        static getInstance(): SoftAssertService;
-        setCurrentTest(testId: string, testName?: string, testFile?: string): void;
-        clearCurrentTest(): void;
-        getCurrentTestId(): string | null;
-        addFailure(error: Error, matcherName: string): void;
-        getFailures(testId?: string): SoftFailure[];
-        clearFailures(testId?: string): void;
-        assertNoFailures(testId?: string): void;
+        static getInstance(): SoftAssertService
+        setCurrentTest(testId: string, testName?: string, testFile?: string): void
+        clearCurrentTest(): void
+        getCurrentTestId(): string | null
+        addFailure(error: Error, matcherName: string): void
+        getFailures(testId?: string): SoftFailure[]
+        clearFailures(testId?: string): void
+        assertNoFailures(testId?: string): void
     }
 
     interface SoftAssertionServiceOptions {
-        autoAssertOnTestEnd?: boolean;
+        autoAssertOnTestEnd?: boolean
     }
 
     class SoftAssertionService implements ServiceInstance {
-        constructor(serviceOptions?: SoftAssertionServiceOptions, capabilities?: any, config?: any);
-        beforeTest(test: Test): void;
-        beforeStep(step: PickleStep, scenario: Scenario): void;
-        afterTest(test: Test, context: any, result: TestResult): void;
-        afterStep(step: PickleStep, scenario: Scenario, result: { passed: boolean, error?: Error }): void;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        constructor(serviceOptions?: SoftAssertionServiceOptions, capabilities?: any, config?: any)
+        beforeTest(test: Test): void
+        beforeStep(step: PickleStep, scenario: Scenario): void
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        afterTest(test: Test, context: any, result: TestResult): void
+        afterStep(step: PickleStep, scenario: Scenario, result: { passed: boolean, error?: Error }): void
     }
 
     interface AssertionResult {
@@ -59,7 +63,9 @@ declare namespace ExpectWebdriverIO {
     const matchers: Map<
         string,
         (
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             actual: any,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             ...expected: any[]
         ) => Promise<AssertionResult>
     >
@@ -79,6 +85,7 @@ declare namespace ExpectWebdriverIO {
          * expect(el).toHaveAttribute('attr', 'value', { ... }) // expectedValue is `['attr', 'value]`
          * ```
          */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         expectedValue?: any,
         /**
          * Options that the user has passed in, e.g. `expect(el).toHaveText('foo', { ignoreCase: true })` -> `{ ignoreCase: true }`
@@ -238,10 +245,10 @@ declare namespace ExpectWebdriverIO {
          * **Usage**
          * ```js
          * // Check if an element has the class 'btn'
-         * await expect(element).toHaveElementClass('btn');
+         * await expect(element).toHaveElementClass('btn')
          *
          * // Check if an element has any of the specified classes
-         * await expect(element).toHaveElementClass(['btn', 'btn-large']);
+         * await expect(element).toHaveElementClass(['btn', 'btn-large'])
          * ```
          */
         toHaveElementClass(className: string | RegExp | Array<string | RegExp> | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
@@ -251,6 +258,7 @@ declare namespace ExpectWebdriverIO {
          */
         toHaveElementProperty(
             property: string | RegExp | ExpectWebdriverIO.PartialMatcher,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             value?: any,
             options?: ExpectWebdriverIO.StringOptions
         ): R
@@ -343,7 +351,7 @@ declare namespace ExpectWebdriverIO {
          * ```
          */
         toHaveText(
-            text: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>,
+            text: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp | ExpectWebdriverIO.PartialMatcher>,
             options?: ExpectWebdriverIO.StringOptions
         ): R
 
@@ -418,7 +426,7 @@ declare namespace ExpectWebdriverIO {
         toBeElementsArrayOfSize(
             size: number | ExpectWebdriverIO.NumberOptions,
             options?: ExpectWebdriverIO.NumberOptions
-        ): R & Promise<WebdriverIO.ElementArray>;
+        ): R & Promise<WebdriverIO.ElementArray>
 
         // ==== network mock ====
         /**
@@ -479,8 +487,10 @@ declare namespace ExpectWebdriverIO {
     type JsonCompatible = jsonObject | jsonArray
 
     interface PartialMatcher {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         sample?: any
         $$typeof: symbol
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         asymmetricMatch(...args: any[]): boolean
         toString(): string
     }
@@ -527,6 +537,7 @@ declare namespace ExpectWebdriverIO {
     }
 
     interface AsymmetricMatchers {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         any(expectedObject: any): PartialMatcher
         anything(): PartialMatcher
         arrayContaining(sample: Array<unknown>): PartialMatcher

package/types/standalone.d.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/consistent-type-imports*/
 /// <reference types="./expect-webdriverio.js"/>
 
 type ChainablePromiseElement = import('webdriverio').ChainablePromiseElement<WebdriverIO.Element>
@@ -21,6 +22,7 @@ declare namespace ExpectWebdriverIO {
     } & AsymmetricMatchers
 
     interface AsymmetricMatchers {
+        // eslint-disable-next-line  @typescript-eslint/no-explicit-any
         any(expectedObject: any): PartialMatcher
         anything(): PartialMatcher
         arrayContaining(sample: Array<unknown>): PartialMatcher