expect-webdriverio 5.3.4 → 5.4.1

package/jasmine.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="expect-webdriverio/types/expect-webdriverio"/>
+/// <reference types="./types/expect-webdriverio.d.ts"/>
 
 declare namespace jasmine {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars

package/lib/matchers/element/toBeDisplayed.js

@@ -1,12 +1,12 @@
 import { executeCommandBe } from '../../utils.js';
 import { DEFAULT_OPTIONS } from '../../constants.js';
-export async function toBeDisplayed(received, options = DEFAULT_OPTIONS) {
+export async function toBeDisplayed(received, { withinViewport = false, contentVisibilityAuto = true, opacityProperty = true, visibilityProperty = true } = {}, options = DEFAULT_OPTIONS) {
     this.expectation = this.expectation || 'displayed';
     await options.beforeAssertion?.({
         matcherName: 'toBeDisplayed',
         options,
     });
-    const result = await executeCommandBe.call(this, received, el => el?.isDisplayed(), options);
+    const result = await executeCommandBe.call(this, received, el => el?.isDisplayed({ withinViewport, contentVisibilityAuto, opacityProperty, visibilityProperty }), options);
     await options.afterAssertion?.({
         matcherName: 'toBeDisplayed',
         options,

package/lib/matchers/element/toHaveAttribute.js

@@ -35,7 +35,7 @@ export async function toHaveAttributeAndValue(received, attribute, value, option
 async function toHaveAttributeFn(received, attribute) {
     const isNot = this.isNot;
     const { expectation = 'attribute', verb = 'have' } = this;
-    let el = await received;
+    let el = await received?.getElement();
     const pass = await waitUntil(async () => {
         const result = await executeCommand.call(this, el, conditionAttr, {}, [attribute]);
         el = result.el;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "5.3.4",
+  "version": "5.4.1",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
@@ -46,10 +46,12 @@
     "clean:build": "rimraf ./lib",
     "clean:tests": "rimraf test-types/**/node_modules && rimraf test-types/**/dist",
     "compile": "tsc --build tsconfig.build.json",
+    "tsc:root-types": "tsc jasmine.d.ts jest.d.ts",
     "test": "run-s test:*",
+    "test:tsc": "tsc --project tsconfig.json --noEmit",
     "test:lint": "eslint .",
     "test:unit": "vitest --run",
-    "test:types": "node test-types/copy && npm run ts && npm run clean:tests",
+    "test:types": "node test-types/copy && npm run ts && npm run clean:tests && npm run tsc:root-types",
     "ts": "run-s ts:*",
     "ts:default": "cd test-types/default && tsc -p ./tsconfig.json --incremental",
     "ts:jest": "cd test-types/jest && tsc -p ./tsconfig.json --incremental",

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
@@ -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,7 +1,8 @@
+/* eslint-disable @typescript-eslint/consistent-type-imports*/
 /// <reference types="./expect-webdriverio.js"/>
 
-type ChainablePromiseElement = import('webdriverio').ChainablePromiseElement<WebdriverIO.Element>
-type ChainablePromiseArray = import('webdriverio').ChainablePromiseArray<WebdriverIO.Element>
+type ChainablePromiseElement = import('webdriverio').ChainablePromiseElement
+type ChainablePromiseArray = import('webdriverio').ChainablePromiseArray
 
 declare namespace ExpectWebdriverIO {
     interface Matchers<R extends void | Promise<void>, T> extends Readonly<import('expect').Matchers<R>> {
@@ -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