expect-webdriverio 6.0.5 → 6.0.7

package/README.md

@@ -1,17 +1,16 @@
 # expect-webdriverio [![Test](https://github.com/webdriverio/expect-webdriverio/actions/workflows/test.yml/badge.svg)](https://github.com/webdriverio/expect-webdriverio/actions/workflows/test.yml)
 
-
 ###### [API](docs/API.md) | [TypeScript / JS Autocomplete](docs/Types.md) | [Examples](docs/Examples.md) | [Extending Matchers](docs/CustomMatchers.md)
 
-> [WebdriverIO](https://webdriver.io/) Assertion library inspired by [expect](https://www.npmjs.com/package/expect)
+> [WebdriverIO](https://webdriver.io/) assertion library inspired by [expect](https://www.npmjs.com/package/expect)
 
 ## Key Features
 
-- [Waits](#default-options) for expectation to succeed
-- Support single element & multi-elements
+- [Waits](#default-options) for expectations to succeed
+- Supports single element `$()` & multiple elements `$$()`
 - Detailed [error messages](#error-messages)
-- Works in Mocha, Cucumber, Jest, Jasmine
-- Builtin [types](docs/Types.md) for TypeScript and JS autocompletion
+- Works in Mocha, Cucumber, Jest, and Jasmine
+- Built-in [types](docs/Types.md) for TypeScript and JS autocompletion
 
 ## Installation
 
@@ -22,24 +21,28 @@
    - **Cucumber**: `npm install @wdio/cucumber-framework`
    - **Jest**: No adapter needed — see [Jest Framework section](docs/Framework.md#jest)
 
-NOTE: [WebdriverIO](https://github.com/webdriverio/webdriverio) `v9.0.0` or higher is required!
+**Note:** [WebdriverIO](https://github.com/webdriverio/webdriverio) `v9.0.0` or higher is required!
 
 ## Usage
 
 ### Using WebdriverIO Testrunner
 
-If you run your tests through the [WDIO testrunner](https://webdriver.io/docs/clioptions) no additional setup is needed. WebdriverIO initialises `expect-webdriverio` and makes `expect` available in the global scope. So you can use it directly in your tests:
+If you run your tests through the [WDIO testrunner](https://webdriver.io/docs/clioptions), no additional setup is needed. WebdriverIO initializes `expect-webdriverio` and makes `expect` available in the global scope so you can use it directly in your tests:
 
 ```js
-const button = await $('button')
-await expect(button).toBeDisplayed()
+await expect($('button')).toBeDisplayed()
+await expect($$('buttons')).toBeDisplayed()
 ```
 
-See more [Examples](docs/Examples.md)
+See more [Examples](docs/Examples.md).
+
+#### Local & Browser Runners
+- **Local Runner**: Fully compatible. You can leverage your test framework adapter as mentioned above.
+- **Browser Runner**: Designed for component frameworks like React, Preact, Vue.js, Svelte, and SolidJS, with a few known limitations. For details, see the [Browser Runner Framework section](docs/Framework.md#browser-runner).
 
-### Using in a standalone script
+### Using in Standalone Mode
 
-If you embed WebdriverIO in a standalone (without `@wdio/globals`), make sure you import `expect-webdriverio` before you use it anywhere.
+If you use WebdriverIO in standalone mode (without `@wdio/globals`), make sure you import `expect-webdriverio` before using it anywhere.
 
 ```js
 import { remote } from 'webdriverio'
@@ -63,24 +66,24 @@ import { expect } from 'expect-webdriverio'
 
 ## API
 
-Please see [API doc](docs/API.md)
+Please see the [API documentation](docs/API.md).
 
-## Error messages
+## Error Messages
 
 Error messages are informative out of the box and contain:
 
-- full element selector, like `$('form').$('input')`
-- actual and expected values
-- highlight the difference (texts assertions)
+- Full element selector, like `$('form')`
+- Actual and expected values
+- Highlighted differences (text assertions)
 
 ![toHaveText](/docs/img/errors/text.png?raw=true "toHaveText")
 ![toHaveElementClass](/docs/img/errors/class.png?raw=true "toHaveElementClass")
 
-## What's next?
+## What's Next?
 
-First of all, **feel free to raise an issue with your suggestions or help with PR!**
+First of all, **feel free to raise an issue with your suggestions or help with PRs!**
 
 ### Planned
 
-- cookie
-- multiremote support (coming)
+- Cookie matchers
+- Multiremote support (in progress)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "6.0.5",
+  "version": "6.0.7",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
@@ -45,7 +45,10 @@
     ],
     "./types": "./types/expect-global.d.ts",
     "./expect-global": "./types/expect-global.d.ts",
-    "./api": "./lib/api/index.js"
+    "./api": {
+      "types": "./types/expect-webdriverio.d.ts",
+      "import": "./lib/api/index.js"
+    }
   },
   "types": "./types/expect-webdriverio.d.ts",
   "typeScriptVersion": "3.8.3",
@@ -70,6 +73,7 @@
     "ts:jasmine-global-expect-async": "cd test-types/jasmine-global-expect-async && vitest --typecheck --typecheck.tsconfig ./tsconfig.json --run",
     "ts:jest:@types-jest": "cd test-types/jest-@types_jest && vitest --typecheck --typecheck.tsconfig ./tsconfig.json --run",
     "ts:mocha": "cd test-types/mocha && vitest --typecheck --typecheck.tsconfig ./tsconfig.json --run",
+    "ts:arethetypeswrong": "npx @arethetypeswrong/cli --pack . --profile esm-only",
     "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",
@@ -85,6 +89,7 @@
     "jest-matcher-utils": "^30.4.1"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
     "@jest/globals": "^30.4.1",
     "@types/debug": "^4.1.13",
     "@types/jasmine": "^5.1.15",
@@ -92,9 +97,9 @@
     "@types/mocha": "^10.0.10",
     "@types/node": "^24.13.3",
     "@vitest/coverage-v8": "^4.1.10",
-    "@vitest/eslint-plugin": "^1.6.26",
+    "@vitest/eslint-plugin": "^1.6.27",
     "@wdio/eslint": "^0.1.3",
-    "@wdio/types": "^9.30.1",
+    "@wdio/types": "^9.31.1",
     "eslint": "^9.39.5",
     "husky": "^9.1.7",
     "npm-run-all2": "^9.0.3",

package/types/expect-webdriverio.d.ts

@@ -22,7 +22,6 @@ type ExpectLibExpectationResult = import('expect').ExpectationResult
 type ExpectLibMatcherContext = import('expect').MatcherContext
 type MatchersObject = Parameters<typeof import('expect').expect.extend>[0]
 type ExpectLibAnything = ReturnType<typeof expect.any> | ReturnType<typeof expect.anything>
-type WdioSome<T> = import('../src/matchers/modifiers/some.js').SomeElementsWrapper<T>
 
 // Extracted from the expect library, this is the type of the matcher function used in the expect library.
 type RawMatcherFn<Context extends ExpectLibMatcherContext = ExpectLibMatcherContext> = {
@@ -30,6 +29,10 @@ type RawMatcherFn<Context extends ExpectLibMatcherContext = ExpectLibMatcherCont
     (this: Context, actual: any, ...expected: Array<any>): ExpectLibExpectationResult;
 }
 
+interface WdioSome<T> {
+    readonly elements: T
+}
+
 /**
  * Indicates that a value can be either one T or an array of T.
  */