expect-webdriverio 4.5.2 → 4.6.0

package/types/expect-webdriverio.d.ts

@@ -4,17 +4,45 @@ declare namespace ExpectWebdriverIO {
     ): Matchers<R, T>
     function setOptions(options: DefaultOptions): void
     function getConfig(): any
+
+    interface AssertionResult {
+        pass: boolean
+        message(): string
+    }
+
     const matchers: Record<
         string,
         (
             actual: any,
             ...expected: any[]
-        ) => Promise<{
-            pass: boolean
-            message(): string
-        }>
+        ) => Promise<AssertionResult>
     >
 
+    interface AssertionHookParams {
+        /**
+         * name of the matcher, e.g. `toHaveText` or `toBeClickable`
+         */
+        matcherName: keyof Matchers<unknown, unknown>,
+        /**
+         * Value that the user has passed in
+         *
+         * @example
+         * ```
+         * expect(el).toBeClickable() // expectedValue is undefined
+         * expect(el).toHaveText('foo') // expectedValue is `'foo'`
+         * expect(el).toHaveAttribute('attr', 'value', { ... }) // expectedValue is `['attr', 'value]`
+         * ```
+         */
+        expectedValue?: any,
+        /**
+         * Options that the user has passed in, e.g. `expect(el).toHaveText('foo', { ignoreCase: true })` -> `{ ignoreCase: true }`
+         */
+        options: CommandOptions | HTMLOptions | StringOptions | NumberOptions
+    }
+    interface AfterAssertionHookParams extends AssertionHookParams {
+        result: AssertionResult
+    }
+
     interface DefaultOptions {
         /**
          * time in ms to wait for expectation to succeed. Default: 3000
@@ -25,6 +53,16 @@ declare namespace ExpectWebdriverIO {
          * interval between attempts. Default: 100
          */
         interval?: number
+
+        /**
+         * hook that gets executed before each assertion
+         */
+        beforeAssertion?: (params: AssertionHookParams) => Promise<void>
+
+        /**
+         * hook that gets executed after each assertion, it contains the result of the assertion
+         */
+        afterAssertion?: (params: AfterAssertionHookParams) => Promise<void>
     }
 
     interface CommandOptions extends DefaultOptions {
@@ -141,6 +179,7 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getAttribute`
          * Element's attribute includes the value.
+         * @deprecated use `expect(el).toHaveAttribute('attribute', expect.stringContaining('...'))` instead
          */
         toHaveAttributeContaining(
             attribute: string,
@@ -150,6 +189,7 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getAttribute`
          * Element's attribute includes the value.
+         * @deprecated use `expect(el).toHaveAttr('attribute', expect.stringContaining('...'))` instead
          */
         toHaveAttrContaining(
             attribute: string,
@@ -170,14 +210,15 @@ declare namespace ExpectWebdriverIO {
 
         /**
          * `WebdriverIO.Element` -> `getAttribute` class
-         * @deprecated since v1.3.1 - use `toHaveElementClassContaining` instead.
          * Element's class includes the className.
+         * @deprecated since v1.3.1 - use `toHaveElementClassContaining` instead.
          */
         toHaveClassContaining(className: string | RegExp | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
 
         /**
          * `WebdriverIO.Element` -> `getAttribute` class
          * Element's class includes the className.
+         * @deprecated use `expect(el).toHaveElementClass(expect.stringContaining('...'))` instead
          */
         toHaveElementClassContaining(className: string | RegExp | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
 
@@ -197,6 +238,7 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getProperty` value
          * Element's value includes the value.
+         * @deprecated use `expect(el).toHaveValue(expect.stringContaining('...'))` instead
          */
         toHaveValueContaining(value: string | RegExp | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
 
@@ -256,11 +298,13 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getAttribute` href
          * Element's href includes the value provided
+         * @deprecated use `expect(el).toHaveHref(expect.stringContaining('...'))` instead
          */
         toHaveHrefContaining(href: string | RegExp | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
         /**
          * `WebdriverIO.Element` -> `getAttribute` href
          * Element's href includes the value provided
+         * @deprecated use `expect(el).toHaveLink(expect.stringContaining('...'))` instead
          */
         toHaveLinkContaining(href: string | RegExp | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
 
@@ -269,6 +313,11 @@ declare namespace ExpectWebdriverIO {
          */
         toHaveId(id: string | RegExp | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
 
+        /**
+         * `WebdriverIO.Element` -> `getSize` value
+         */
+        toHaveSize(id: string | RegExp | ExpectWebdriverIO.PartialMatcher, size: { height: number; width: number }, options?: ExpectWebdriverIO.StringOptions): R
+
         /**
          * `WebdriverIO.Element` -> `getText`
          * Element's text equals the text provided
@@ -280,6 +329,7 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getText`
          * Element's text includes the text provided
+         * @deprecated use `expect(el).toHaveText(expect.stringContaining('...'))` instead
          */
         toHaveTextContaining(
             text: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>,
@@ -294,6 +344,7 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getHTML`
          * Element's html includes the html provided
+         * @deprecated use `expect(el).toHaveHTML(expect.stringContaining('...'))` instead
          */
         toHaveHTMLContaining(
             html: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>,
@@ -311,6 +362,7 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getComputedLabel`
          * Element's computed label includes the computed label provided
+         * @deprecated use `expect(el).toHaveComputedLabel(expect.stringContaining('...'))` instead
          */
         toHaveComputedLabelContaining(
             computedLabel: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>,
@@ -328,6 +380,7 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getComputedRole`
          * Element's computed role includes the computed role provided
+         * @deprecated use `expect(el).toHaveComputedRole(expect.stringContaining('...'))` instead
          */
         toHaveComputedRoleContaining(
             computedRole: string | RegExp | ExpectWebdriverIO.PartialMatcher | Array<string | RegExp>,
@@ -367,6 +420,7 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Browser` -> `getUrl`
          * Browser's url includes the provided text
+         * @deprecated use `expect(el).toHaveUrl(expect.stringContaining('...'))` instead
          */
         toHaveUrlContaining(url: string | RegExp | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
 
@@ -379,9 +433,24 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Browser` -> `getTitle`
          * Browser's title includes the provided text
+         * @deprecated use `expect(el).toHaveTitle(expect.stringContaining('...'))` instead
          */
         toHaveTitleContaining(title: string | RegExp | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
 
+        /**
+         * `WebdriverIO.Browser` -> `execute`
+         */
+        toHaveClipboardText(clipboardText: string | RegExp | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
+
+        // ===== browser only =====
+        /**
+         * `WebdriverIO.Browser` -> `execute`
+         * Browser's clipboard includes the provided text
+         * @deprecated use `expect(el).toHaveClipboardText(expect.stringContaining('...'))` instead
+         */
+        toHaveClipboardTextContaining(clipboardText: string | RegExp | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
+
+
         // ===== $$ only =====
         /**
          * `WebdriverIO.ElementArray` -> `$$('...').length`

package/lib/matchers/browser/toHaveTitleContaining.js

@@ -1,7 +0,0 @@
-import { toHaveTitle } from './toHaveTitle.js';
-export function toHaveTitleContaining(browser, title, options = {}) {
-    return toHaveTitle.call(this, browser, title, {
-        ...options,
-        containing: true
-    });
-}

package/lib/matchers/browser/toHaveUrlContaining.js

@@ -1,7 +0,0 @@
-import { toHaveUrl } from './toHaveUrl.js';
-export function toHaveUrlContaining(browser, url, options = {}) {
-    return toHaveUrl.call(this, browser, url, {
-        ...options,
-        containing: true
-    });
-}

package/lib/matchers/element/toHaveAttributeContaining.js

@@ -1,8 +0,0 @@
-import { toHaveAttributeAndValueFn } from './toHaveAttribute.js';
-export function toHaveAttributeContaining(el, attribute, value, options = {}) {
-    return toHaveAttributeAndValueFn.call(this, el, attribute, value, {
-        ...options,
-        containing: true
-    });
-}
-export const toHaveAttrContaining = toHaveAttributeContaining;

package/lib/matchers/element/toHaveClassContaining.js

@@ -1,10 +0,0 @@
-import { toHaveAttributeAndValueFn } from './toHaveAttribute.js';
-export function toHaveElementClassContaining(...args) {
-    return toHaveClassContaining.call(this, ...args);
-}
-export function toHaveClassContaining(el, className, options = {}) {
-    return toHaveAttributeAndValueFn.call(this, el, 'class', className, {
-        ...options,
-        containing: true
-    });
-}

package/lib/matchers/element/toHaveComputedLabelContaining.js

@@ -1,7 +0,0 @@
-import { toHaveComputedLabel } from './toHaveComputedLabel.js';
-export function toHaveComputedLabelContaining(el, label, options = {}) {
-    return toHaveComputedLabel.call(this, el, label, {
-        ...options,
-        containing: true
-    });
-}

package/lib/matchers/element/toHaveComputedRoleContaining.js

@@ -1,7 +0,0 @@
-import { toHaveComputedRole } from './toHaveComputedRole.js';
-export function toHaveComputedRoleContaining(el, role, options = {}) {
-    return toHaveComputedRole.call(this, el, role, {
-        ...options,
-        containing: true
-    });
-}

package/lib/matchers/element/toHaveHTMLContaining.js

@@ -1,7 +0,0 @@
-import { toHaveHTML } from './toHaveHTML.js';
-export function toHaveHTMLContaining(el, html, options = {}) {
-    return toHaveHTML.call(this, el, html, {
-        ...options,
-        containing: true
-    });
-}

package/lib/matchers/element/toHaveHrefContaining.js

@@ -1,8 +0,0 @@
-import { toHaveHref } from './toHaveHref.js';
-export function toHaveHrefContaining(el, href, options = {}) {
-    return toHaveHref.call(this, el, href, {
-        ...options,
-        containing: true
-    });
-}
-export const toHaveLinkContaining = toHaveHrefContaining;

package/lib/matchers/element/toHaveTextContaining.js

@@ -1,7 +0,0 @@
-import { toHaveText } from './toHaveText.js';
-export function toHaveTextContaining(el, text, options = {}) {
-    return toHaveText.call(this, el, text, {
-        ...options,
-        containing: true
-    });
-}

package/lib/matchers/element/toHaveValueContaining.js

@@ -1,7 +0,0 @@
-import { toHaveValue } from './toHaveValue.js';
-export function toHaveValueContaining(el, value, options = {}) {
-    return toHaveValue.call(this, el, value, {
-        ...options,
-        containing: true
-    });
-}