expect-webdriverio 7.0.0 → 8.0.0-alpha.0

package/types/expect-webdriverio.d.ts

@@ -21,7 +21,7 @@ type ExpectLibAsyncExpectationResult = import('expect').AsyncExpectationResult
 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 ExpectLibAnything = ReturnType<typeof import('expect').expect.any> | ReturnType<typeof import('expect').expect.anything>
 type WdioGetHTMLOptions = NonNullable<Parameters<WebdriverIO.Element['getHTML']>[0]>
 
 // Extracted from the expect library, this is the type of the matcher function used in the expect library.
@@ -206,29 +206,32 @@ interface WdioBrowserMatchers<_R, ActualT>{
         */
         {
             /**
-            * @deprecated since v6.0.0, removed in v8.0.0. Use `expect.anything()` instead of `undefined` as expected value.
-            */
+             * Only check that the item exists.
+             * Use `toHaveLocalStorageItem(key, expect.anything(), options)` to check it with options.
+             */
+            (key: string): Promise<void>
             (
                 key: string,
-                expectedValue: undefined,
+                expectedValue: MaybeOneOf<string | RegExp | ExpectWebdriverIO.PartialMatcher<string> | ExpectWebdriverIO.PartialMatcherAnything>,
                 options?: ExpectWebdriverIO.StringOptions
-            ): Promise<void>,
-
-            (
-                key: string,
-                expectedValue?: MaybeOneOf<string | RegExp | ExpectWebdriverIO.PartialMatcher<string> | ExpectWebdriverIO.PartialMatcherAnything>,
-                options?: ExpectWebdriverIO.StringOptions
-            ) : Promise<void>
+            ): Promise<void>
         },
 
         /**
         * `WebdriverIO.MultiRemoteBrowser` -> `getLocalStorageItem`
         */
-        (
-            key: string,
-            expectedValue?: MultiRemoteValuesOrOneOf<string | RegExp | ExpectWebdriverIO.PartialMatcher<string> | ExpectWebdriverIO.PartialMatcherAnything>,
-            options?: ExpectWebdriverIO.StringOptions
-        ) => Promise<void>
+        {
+            /**
+             * Only check that the item exists.
+             * Use `toHaveLocalStorageItem(key, expect.anything(), options)` to check it with options.
+             */
+            (key: string): Promise<void>
+            (
+                key: string,
+                expectedValue: MultiRemoteValuesOrOneOf<string | RegExp | ExpectWebdriverIO.PartialMatcher<string> | ExpectWebdriverIO.PartialMatcherAnything>,
+                options?: ExpectWebdriverIO.StringOptions
+            ): Promise<void>
+        }
     >
 }
 
@@ -248,21 +251,10 @@ interface WdioNetworkMatchers<_R, ActualT> {
      * Check that `WebdriverIO.Mock` was called N times.
      * With multi-remote mocks (`multiRemoteBrowser.mock()`), every instance's mock must be called N times.
      */
-    toBeRequestedTimes: FnWhenMock<ActualT, {
-        (
-            times: number | ExpectWebdriverIO.NumberMatcher,
-            options?: ExpectWebdriverIO.CommandOptions
-        ): Promise<void>
-
-        /**
-        * @deprecated since v6.0.0, remove in v8.0.0. Use `NumberMatcher` & `CommandOptions` separately `toBeRequestedTimes(NumberMatcher, options)`.
-        */
-        (
-            times: ExpectWebdriverIO.NumberOptions,
-            options?: ExpectWebdriverIO.CommandOptions
-        ): Promise<void>;
-
-    }>
+    toBeRequestedTimes: FnWhenMock<ActualT, (
+        times: number | ExpectWebdriverIO.NumberMatcher,
+        options?: ExpectWebdriverIO.CommandOptions
+    ) => Promise<void>>
 
     /**
      * Check that `WebdriverIO.Mock` was called with the specific parameters.
@@ -336,16 +328,7 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
 
     toHaveAttribute: FnWhenElementOrArrayLike<ActualT, {
         /** Element $() API */
-        /**
-         * @deprecated since v6.0.0, remove in v8.0.0. Passing explicit `undefined` as a value is deprecated. Omit the second argument entirely or pass options instead: `toHaveAttribute(attribute, options)`.
-         */
-        (
-            attribute: string,
-            value: undefined,
-            options?: ExpectWebdriverIO.StringOptions
-        ): Promise<void>;
-
-        /** Check ONLY for the presence of the attribute (and optional configuration options) */
+        /** Check ONLY for the presence of the attribute. For options, use `toHaveAttribute(attribute, expect.anything(), options)` */
         (
             attribute: string,
         ): Promise<void>;
@@ -358,16 +341,7 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
         ): Promise<void>;
     }, {
         /** Elements $$() API */
-        /**
-         * @deprecated Not supported
-         */
-        (
-            attribute: string,
-            value: undefined,
-            options?: ExpectWebdriverIO.StringOptions
-        ): Promise<void>;
-
-        /** Check ONLY for the presence of the attribute (and optional configuration options) */
+        /** Check ONLY for the presence of the attribute. For options, use `toHaveAttribute(attribute, expect.anything(), options)` */
         (
             attribute: string,
         ): Promise<void>;
@@ -401,25 +375,6 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
     }
     >
 
-    /**
-     * @deprecated since v6.0.0, removed in v8.0.0. Use `toHaveAttribute` instead.
-     * `WebdriverIO.Element` -> `getAttribute`
-     */
-    toHaveAttr: FnWhenElementOrArrayLike<ActualT, (
-        attribute: string,
-        value?: string | RegExp | ExpectWebdriverIO.PartialMatcher<string>,
-        options?: ExpectWebdriverIO.StringOptions
-    ) => Promise<void>>
-
-    /**
-     * `WebdriverIO.Element` -> `getAttribute` class
-     * @deprecated since v1.3.1 - use `toHaveElementClass` instead.
-     */
-    toHaveClass: FnWhenElementOrArrayLike<ActualT, (
-        className: string | RegExp | ExpectWebdriverIO.PartialMatcher<string>,
-        options?: ExpectWebdriverIO.StringOptions
-    ) => Promise<void>>
-
     /**
      * `WebdriverIO.Element` -> `getAttribute` class
      *
@@ -442,7 +397,7 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
             className: string | RegExp | ExpectWebdriverIO.PartialMatcher<string>,
             options?: ExpectWebdriverIO.StringOptions
         ) :Promise<void>
-        /** @deprecated use `expect.oneOf()` instead of an array */
+        /** @deprecated an array means "has any of these classes", to review in https://github.com/webdriverio/expect-webdriverio/issues/2266 (`expect.oneOf()` compares the full class attribute) */
         (
             className: Array<string | RegExp | ExpectWebdriverIO.PartialMatcher<string>>,
             options?: ExpectWebdriverIO.StringOptions
@@ -477,16 +432,6 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
             property: string,
         ): Promise<void>;
 
-        /**
-         * @deprecated since v6.0.0, removed in v8.0.0. Passing explicit `undefined` or `null` as a value is deprecated.
-         * Omit the second argument entirely or use expect.anything() with options: `toHaveElementProperty(property, expect.anything(), options)`.
-         */
-        (
-            property: string,
-            value: undefined | null, // Use expect.any(type) or expect.anything() instead of undefined or null
-            options?: ExpectWebdriverIO.StringOptions
-        ): Promise<void>;
-
         /** Assert both property name AND a specific expected value */
         (
             property: string,
@@ -504,20 +449,10 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
             property: string,
         ): Promise<void>;
 
-        /**
-         * @deprecated Not supported
-         * Use `expect.anything()` or `[expect.anything()] as value` to check for the presence of the property with options.
-         */
-        (
-            property: string,
-            propertyValue: undefined | null, // Use expect.any(type) or expect.anything() instead of undefined or null
-            options?: ExpectWebdriverIO.StringOptions
-        ): Promise<never>;
-
         /** Assert both property name AND a specific expected value */
         (
             property: string,
-            value: MaybeArrayOrOneOf<string | number | RegExp | ExpectWebdriverIO.PartialMatcher<string> | ExpectWebdriverIO.PartialMatcherAnything | null>,
+            value: Exclude<MaybeArrayOrOneOf<string | number | RegExp | ExpectWebdriverIO.PartialMatcher<string> | ExpectWebdriverIO.PartialMatcherAnything | null>, null>,
             options?: ExpectWebdriverIO.StringOptions
         ): Promise<void>;
     }, {
@@ -537,7 +472,7 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
         ): Promise<void>
         (
             property: string,
-            value: MaybeArrayOrOneOf<string | number | RegExp | ExpectWebdriverIO.PartialMatcher<string> | ExpectWebdriverIO.PartialMatcherAnything | null> | ExpectWebdriverIO.MultiRemotePartialMatcher<MaybeArrayOrOneOf<string | number | RegExp | ExpectWebdriverIO.PartialMatcher<string> | ExpectWebdriverIO.PartialMatcherAnything | null>>,
+            value: Exclude<MaybeArrayOrOneOf<string | number | RegExp | ExpectWebdriverIO.PartialMatcher<string> | ExpectWebdriverIO.PartialMatcherAnything | null>, null> | ExpectWebdriverIO.MultiRemotePartialMatcher<MaybeArrayOrOneOf<string | number | RegExp | ExpectWebdriverIO.PartialMatcher<string> | ExpectWebdriverIO.PartialMatcherAnything | null>>,
             options?: ExpectWebdriverIO.StringOptions
         ): Promise<void>
     }>
@@ -590,15 +525,6 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
          * Same as `expect(el).toHaveChildren({ gte: 1 })` or `expect(el).toHaveChildren({ gte: 1 }, options)`.
          */
         (): Promise<void>;
-        /**
-         * @deprecated since 6.0.0, remove in v8.0.0.
-         * Passing explicit `undefined` or `{ wait : 1 }` (NumberOptions) as a value is deprecated.
-         * Use options with `toHaveChildren({ gte: 1 }, options)`.
-         */
-        (
-            expectedValue: undefined, // {} also deprecated but we cannot use it as a type because it would match any object
-            options?: ExpectWebdriverIO.CommandOptions
-        ): Promise<void>;
 
         /**
          * When called with an expected child count or number matcher.
@@ -607,16 +533,6 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
             expectedValue: number | ExpectWebdriverIO.NumberMatcher,
             options?: ExpectWebdriverIO.CommandOptions
         ): Promise<void>;
-
-        /**
-         * @deprecated since 6.0.0, remove in v8.0.0.
-         * NumberOptions is no longer supported. Use `expect(el).toHaveChildren(numberMatcher, options)` instead.
-         * Instead of `expect(el).toHaveChildren({ wait: 1 })` use `expect(el).toHaveChildren({ gte: 1 }, { wait: 1 })`.
-         */
-        (
-            expectedValue: ExpectWebdriverIO.NumberOptions,
-            options?: ExpectWebdriverIO.CommandOptions
-        ): Promise<void>;
     }, {
         /** Element $$() API */
         /**
@@ -625,16 +541,6 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
          */
         (): Promise<void>;
 
-        /**
-         * @deprecated Not supported
-         * NumberOptions is no longer supported. Use `expect(el).toHaveChildren(numberMatcher, options)` instead.
-         * Instead of `expect(el).toHaveChildren({ wait: 1 })` use `expect(el).toHaveChildren({ gte: 1 }, { wait: 1 })`.
-         */
-        (
-            expectedValue: undefined,
-            options?: ExpectWebdriverIO.CommandOptions
-        ): Promise<void>;
-
         /**
          * When called with an expected child count or number matcher.
          */
@@ -771,11 +677,6 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
             text: MaybeOneOf<string | RegExp | ExpectWebdriverIO.PartialMatcher<string>>,
             options?: ExpectWebdriverIO.StringOptions
         ) : Promise<void>
-        /** @deprecated Use `expect.oneOf()` instead. */
-        (
-            text: Array<string | RegExp | ExpectWebdriverIO.PartialMatcher<string>>,
-            options?: ExpectWebdriverIO.StringOptions
-        ) : Promise<void>
     }, {
         /** Elements browser.$$() API */
         (
@@ -807,11 +708,6 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
             text: MaybeOneOf<string | RegExp | ExpectWebdriverIO.PartialMatcher<string>>,
             options?: ExpectWebdriverIO.HTMLOptions
         ) : Promise<void>
-        /** @deprecated to replace by oneOf() or anyOf() when available */
-        (
-            text: Array<string | RegExp | ExpectWebdriverIO.PartialMatcher<string>>,
-            options?: ExpectWebdriverIO.HTMLOptions
-        ) : Promise<void>
     }, {
         /** Elements $$() API */
         (
@@ -842,12 +738,6 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
             computedLabel: MaybeOneOf<string | RegExp | ExpectWebdriverIO.PartialMatcher<string>>,
             options?: ExpectWebdriverIO.StringOptions
         ) : Promise<void>
-
-        /** @deprecated use `expect.oneOf()` instead of an array */
-        (
-            computedLabel: Array<string | RegExp | ExpectWebdriverIO.PartialMatcher<string>>,
-            options?: ExpectWebdriverIO.StringOptions
-        ) : Promise<void>
     }, {
         /** Elements $$() API */
         (
@@ -878,12 +768,6 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
             computedRole: MaybeOneOf<string | RegExp | ExpectWebdriverIO.PartialMatcher<string>>,
             options?: ExpectWebdriverIO.StringOptions
         ) : Promise<void>
-
-        /** @deprecated use `expect.oneOf()` instead of an array */
-        (
-            computedRole: Array<string | RegExp | ExpectWebdriverIO.PartialMatcher<string>>,
-            options?: ExpectWebdriverIO.StringOptions
-        ) : Promise<void>
     }, {
         /** Elements $$() API */
         (
@@ -913,15 +797,7 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
         (
             width: number | ExpectWebdriverIO.NumberMatcher,
             options?: ExpectWebdriverIO.CommandOptions
-        ) : Promise<void>,
-
-        /**
-         * @deprecated since v6.0.0, remove in v8.0.0. Use `toHaveWidth` with number | NumberMatcher instead. This matcher will be removed in version 8.0.0.
-         */
-        (
-            size: ExpectWebdriverIO.NumberOptions,
-            options?: ExpectWebdriverIO.CommandOptions
-        ): Promise<void>,
+        ) : Promise<void>
     }, {
         /** Elements $$() API */
         (
@@ -960,14 +836,6 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
             height: number | ExpectWebdriverIO.NumberMatcher,
             options?: ExpectWebdriverIO.CommandOptions
         ) : Promise<void>
-
-        /**
-         * @deprecated since v6.0.0, will be removed in version v8.0.0. Use `toHaveHeight` with number | NumberMatcher instead.
-         */
-        (
-            size: ExpectWebdriverIO.NumberOptions,
-            options?: ExpectWebdriverIO.CommandOptions
-        ): Promise<void>,
     }, {
         /** Elements $$() API */
         (
@@ -1066,14 +934,6 @@ interface WdioElementArrayOnlyMatchers<_R, ActualT = unknown> {
             size: number | ExpectWebdriverIO.NumberMatcher,
             options?: ExpectWebdriverIO.CommandOptions
         ): Promise<void>,
-
-        /**
-         * @deprecated since v6.0.0, remove in v8.0.0. Use `toBeElementsArrayOfSize` with number | NumberMatcher instead. This matcher will be removed in version 8.0.0.
-         */
-        (
-            size: ExpectWebdriverIO.NumberOptions,
-            options?: ExpectWebdriverIO.CommandOptions
-        ): Promise<void>,
     }, {
         /**
          * Elements MultiRemoteBrowser.$$() API: the size is checked per browser instance.
@@ -1220,21 +1080,11 @@ declare namespace ExpectWebdriverIO {
      * Used by the webdriverio main project to configure the matchers in the runner.
      */
     function setDefaultOptions(options: DefaultOptions): void
-    /** @deprecated since v6.0.0, use setDefaultOptions instead, will be removed in v8.0.0 */
-    function setOptions(options: DefaultOptions): void
-
-    /**
-     * Allow to enable some new features in the expect-webdriverio library.
-     * @param flags
-     */
-    function setFeatureFlags(flags: FeatureFlags): void
 
     /**
      * Get the default options set by the user.
      */
     function getDefaultOptions(): DefaultOptions
-    /** @deprecated since v6.0.0, use getDefaultOptions instead, will be removed in v8.0.0 */
-    function getConfig(): DefaultOptions
 
     /**
      * The this context available inside each matcher function.
@@ -1363,11 +1213,6 @@ declare namespace ExpectWebdriverIO {
      */
     const wdioCustomMatchers: MatchersObject
 
-    /**
-     * @deprecated since 5.6.9 use `wdioCustomMatchers` instead, will be removed in v8.0.0?
-     */
-    const matchers: Map<string, RawMatcherFn>
-
     interface AssertionHookParams {
         /**
          * name of the matcher, e.g. `toHaveText` or `toBeClickable`
@@ -1388,26 +1233,15 @@ declare namespace ExpectWebdriverIO {
         /**
          * Options that the user has passed in, e.g. `expect(el).toHaveText('foo', { ignoreCase: true })` -> `{ ignoreCase: true }`
          */
-        options: CommandOptions | HTMLOptions | StringOptions | NumberOptions
+        options: CommandOptions | HTMLOptions | StringOptions
     }
     interface AfterAssertionHookParams extends AssertionHookParams {
         result: AssertionResult
     }
 
-    interface FeatureFlags {
-        /**
-         * Feature flag to enable the new multi-elements comparison for `toHaveText` matcher, allowing to keep the current behavior without breaking changes.
-         * When enabled, the matcher will compare the text of multiple elements in an indexed exact match manner, rather than using the array as a possible match for any of the elements.
-         * Also required for `some()`, `expect.oneOf()` in an expected array, and multi-remote elements with `toHaveText`.
-         *
-         * The new behavior is planned to become the default in the next major version.
-         */
-        useToHaveTextStrictMultiElementsCompareStrategy?: boolean
-    }
-
     interface DefaultOptions {
         /**
-         * time in ms to wait for expectation to succeed. Default: 3000
+         * time in ms to wait for expectation to succeed. Default: 2000
          */
         wait?: number
 
@@ -1425,8 +1259,6 @@ declare namespace ExpectWebdriverIO {
          * hook that gets executed after each assertion, it contains the result of the assertion
          */
         afterAssertion?: (params: AfterAssertionHookParams) => Promise<void>
-
-        featureFlags?: FeatureFlags
     }
 
     interface CommandOptions extends DefaultOptions {
@@ -1485,29 +1317,6 @@ declare namespace ExpectWebdriverIO {
         asString?: boolean
     }
 
-    /**
-     * @deprecated since v6.0.0, remove in v8.0.0. Use `NumberMatcher` & `CommandOptions` as separate parameters instead.
-     * @see NumberMatcher
-     * @see CommandOptions
-     */
-    interface NumberOptions extends CommandOptions {
-
-        /**
-         * equals
-         */
-        eq?: number
-
-        /**
-         * less than or equals
-         */
-        lte?: number
-
-        /**
-         * greater than or equals
-         */
-        gte?: number
-    }
-
     interface ToBeDisplayedOptions extends CommandOptions {
         /**
          * `true` to check if the element is within the viewport. false by default.