expect-webdriverio 5.6.4 → 5.6.6

package/jasmine-wdio-expect-async.d.ts

@@ -1,10 +1,37 @@
 /// <reference types="./types/expect-webdriverio.d.ts"/>
 
+declare namespace jasmine {
+
+    /**
+     * Async matchers for Jasmine to allow the typing of `expectAsync` with WebDriverIO matchers.
+     * T is the type of the actual value
+     * U is the type of the expected value
+     * Both T,U must stay named as they are to override the default `AsyncMatchers` type from Jasmine.
+     *
+     * We force Matchers to return a `Promise<void>` since Jasmine's `expectAsync` expects a promise in all cases (different from Jest)
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    interface AsyncMatchers<T, U> extends Omit<ExpectWebdriverIO.Matchers<Promise<void>, T>, 'toMatchSnapshot' | 'toMatchInlineSnapshot'> {
+        /**
+         * snapshot matcher
+         * @param label optional snapshot label
+         */
+        toMatchSnapshot(label?: string): Promise<void>;
+        /**
+         * inline snapshot matcher
+         * @param snapshot snapshot string (autogenerated if not specified)
+         * @param label optional snapshot label
+         */
+        toMatchInlineSnapshot(snapshot?: string, label?: string): Promise<void>;
+    }
+}
+
 /**
- * Overrides the default wdio `expect` for Jasmine case specifically since the `expect` is now completely asynchronous which is not the case under Jest or standalone.
+ * Overrides the default WDIO expect specifically for Jasmine, since `expectAsync` is forced into `expect`, making all matchers fully asynchronous. This is not the case under Jest or Mocha.
+ * Using `jasmine.AsyncMatchers` pull on WdioMatchers above but also allow to using Jasmine's built-in matchers and also `withContext` matcher.
  */
 declare namespace ExpectWebdriverIO {
-    interface Expect extends ExpectWebdriverIO.AsymmetricMatchers, ExpectLibInverse<ExpectWebdriverIO.InverseAsymmetricMatchers>, WdioExpect {
+    interface Expect {
         /**
          * The `expect` function is used every time you want to test a value.
          * You will rarely call `expect` by itself.
@@ -17,6 +44,6 @@ declare namespace ExpectWebdriverIO {
          *
          * @param actual The value to apply matchers against.
          */
-        <T = unknown>(actual: T): ExpectWebdriverIO.MatchersAndInverse<Promise<void>, T>
+        <T = unknown>(actual: T): jasmine.AsyncMatchers<T, void>
     }
-}
+}

package/lib/constants.js

@@ -4,3 +4,14 @@ export const DEFAULT_OPTIONS = {
     beforeAssertion: async () => { },
     afterAssertion: async () => { },
 };
+export const DEFAULT_OPTIONS_TO_BE_DISPLAYED = {
+    ...DEFAULT_OPTIONS,
+    withinViewport: false,
+    contentVisibilityAuto: true,
+    opacityProperty: true,
+    visibilityProperty: true
+};
+export const defaultOptionsList = [
+    DEFAULT_OPTIONS,
+    DEFAULT_OPTIONS_TO_BE_DISPLAYED
+];

package/lib/index.js

@@ -1,6 +1,6 @@
 import { expect as expectLib } from 'expect';
 import * as wdioMatchers from './matchers.js';
-import { DEFAULT_OPTIONS } from './constants.js';
+import { DEFAULT_OPTIONS, defaultOptionsList } from './constants.js';
 import createSoftExpect from './softExpect.js';
 import { SoftAssertService } from './softAssert.js';
 export const matchers = new Map();
@@ -34,11 +34,13 @@ Object.defineProperty(expectWithSoft, 'clearSoftFailures', {
 });
 export const expect = expectWithSoft;
 export const getConfig = () => DEFAULT_OPTIONS;
-export const setDefaultOptions = (options = {}) => {
+export const setDefaultOptions = (options) => {
     Object.entries(options).forEach(([key, value]) => {
-        if (key in DEFAULT_OPTIONS) {
-            DEFAULT_OPTIONS[key] = value;
-        }
+        defaultOptionsList.forEach((option) => {
+            if (key in option) {
+                option[key] = value;
+            }
+        });
     });
 };
 export const setOptions = setDefaultOptions;

package/lib/matchers/browser/toHaveClipboardText.js

@@ -3,6 +3,7 @@ import { waitUntil, enhanceError, compareText } from '../../utils.js';
 import { DEFAULT_OPTIONS } from '../../constants.js';
 const log = logger('expect-webdriverio');
 export async function toHaveClipboardText(browser, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'clipboard text', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveClipboardText',
@@ -15,7 +16,7 @@ export async function toHaveClipboardText(browser, expectedValue, options = DEFA
             .catch((err) => log.warn(`Couldn't set clipboard permissions: ${err}`));
         actual = await browser.execute(() => window.navigator.clipboard.readText());
         return compareText(actual, expectedValue, options).result;
-    }, options);
+    }, isNot, options);
     const message = enhanceError('browser', expectedValue, actual, this, verb, expectation, '', options);
     const result = {
         pass,

package/lib/matchers/browser/toHaveLocalStorageItem.js

@@ -0,0 +1,36 @@
+import { waitUntil, enhanceError, compareText } from '../../utils.js';
+import { DEFAULT_OPTIONS } from '../../constants.js';
+export async function toHaveLocalStorageItem(browser, key, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
+    const { expectation = 'localStorage item', verb = 'have' } = this;
+    await options.beforeAssertion?.({
+        matcherName: 'toHaveLocalStorageItem',
+        expectedValue: expectedValue ? [key, expectedValue] : key,
+        options,
+    });
+    let actual;
+    const pass = await waitUntil(async () => {
+        actual = await browser.execute((storageKey) => {
+            return localStorage.getItem(storageKey);
+        }, key);
+        if (expectedValue === undefined) {
+            return actual !== null;
+        }
+        if (actual === null) {
+            return false;
+        }
+        return compareText(actual, expectedValue, options).result;
+    }, isNot, options);
+    const message = enhanceError('browser', expectedValue !== undefined ? expectedValue : `localStorage item "${key}"`, actual, this, verb, expectation, key, options);
+    const result = {
+        pass,
+        message: () => message
+    };
+    await options.afterAssertion?.({
+        matcherName: 'toHaveLocalStorageItem',
+        expectedValue: expectedValue ? [key, expectedValue] : key,
+        options,
+        result
+    });
+    return result;
+}

package/lib/matchers/browser/toHaveTitle.js

@@ -1,6 +1,7 @@
 import { waitUntil, enhanceError, compareText } from '../../utils.js';
 import { DEFAULT_OPTIONS } from '../../constants.js';
 export async function toHaveTitle(browser, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'title', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveTitle',
@@ -11,7 +12,7 @@ export async function toHaveTitle(browser, expectedValue, options = DEFAULT_OPTI
     const pass = await waitUntil(async () => {
         actual = await browser.getTitle();
         return compareText(actual, expectedValue, options).result;
-    }, options);
+    }, isNot, options);
     const message = enhanceError('window', expectedValue, actual, this, verb, expectation, '', options);
     const result = {
         pass,

package/lib/matchers/browser/toHaveUrl.js

@@ -1,6 +1,7 @@
 import { waitUntil, enhanceError, compareText } from '../../utils.js';
 import { DEFAULT_OPTIONS } from '../../constants.js';
 export async function toHaveUrl(browser, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'url', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveUrl',
@@ -11,7 +12,7 @@ export async function toHaveUrl(browser, expectedValue, options = DEFAULT_OPTION
     const pass = await waitUntil(async () => {
         actual = await browser.getUrl();
         return compareText(actual, expectedValue, options).result;
-    }, options);
+    }, isNot, options);
     const message = enhanceError('window', expectedValue, actual, this, verb, expectation, '', options);
     const result = {
         pass,

package/lib/matchers/element/toBeDisplayed.js

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

package/lib/matchers/element/toHaveAttribute.js

@@ -15,6 +15,7 @@ async function conditionAttrAndValue(el, attribute, value, options) {
     return compareText(attr, value, options);
 }
 export async function toHaveAttributeAndValue(received, attribute, value, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'attribute', verb = 'have' } = this;
     let el = await received?.getElement();
     let attr;
@@ -23,7 +24,7 @@ export async function toHaveAttributeAndValue(received, attribute, value, option
         el = result.el;
         attr = result.values;
         return result.success;
-    }, options);
+    }, isNot, options);
     const expected = wrapExpectedWithArray(el, attr, value);
     const message = enhanceError(el, expected, attr, this, verb, expectation, attribute, options);
     return {
@@ -31,15 +32,16 @@ export async function toHaveAttributeAndValue(received, attribute, value, option
         message: () => message
     };
 }
-async function toHaveAttributeFn(received, attribute, options) {
-    const { expectation = 'attribute', verb = 'have', isNot } = this;
+async function toHaveAttributeFn(received, attribute) {
+    const isNot = this.isNot;
+    const { expectation = 'attribute', verb = 'have' } = this;
     let el = await received?.getElement();
     const pass = await waitUntil(async () => {
         const result = await executeCommand.call(this, el, conditionAttr, {}, [attribute]);
         el = result.el;
         return result.success;
-    }, options);
-    const message = enhanceError(el, !isNot, pass, this, verb, expectation, attribute, options);
+    }, isNot, {});
+    const message = enhanceError(el, !isNot, pass, this, verb, expectation, attribute, {});
     return {
         pass,
         message: () => message
@@ -53,7 +55,7 @@ export async function toHaveAttribute(received, attribute, value, options = DEFA
     });
     const result = value !== undefined
         ? await toHaveAttributeAndValue.call(this, received, attribute, value, options)
-        : await toHaveAttributeFn.call(this, received, attribute, options);
+        : await toHaveAttributeFn.call(this, received, attribute);
     await options.afterAssertion?.({
         matcherName: 'toHaveAttribute',
         expectedValue: [attribute, value],

package/lib/matchers/element/toHaveChildren.js

@@ -16,6 +16,7 @@ async function condition(el, options) {
     };
 }
 export async function toHaveChildren(received, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'children', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveChildren',
@@ -32,7 +33,7 @@ export async function toHaveChildren(received, expectedValue, options = DEFAULT_
         el = result.el;
         children = result.values;
         return result.success;
-    }, { ...numberOptions, ...options });
+    }, isNot, { ...numberOptions, ...options });
     const error = numberError(numberOptions);
     const expectedArray = wrapExpectedWithArray(el, children, error);
     const message = enhanceError(el, expectedArray, children, this, verb, expectation, '', numberOptions);

package/lib/matchers/element/toHaveClass.js

@@ -24,6 +24,7 @@ export function toHaveClass(...args) {
     return toHaveElementClass.call(this || {}, ...args);
 }
 export async function toHaveElementClass(received, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'class', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveElementClass',
@@ -38,7 +39,7 @@ export async function toHaveElementClass(received, expectedValue, options = DEFA
         el = result.el;
         attr = result.values;
         return result.success;
-    }, options);
+    }, isNot, options);
     const message = enhanceError(el, wrapExpectedWithArray(el, attr, expectedValue), attr, this, verb, expectation, '', options);
     const result = {
         pass,

package/lib/matchers/element/toHaveComputedLabel.js

@@ -8,6 +8,7 @@ async function condition(el, label, options) {
     return compareText(actualLabel, label, options);
 }
 export async function toHaveComputedLabel(received, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'computed label', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveComputedLabel',
@@ -21,7 +22,7 @@ export async function toHaveComputedLabel(received, expectedValue, options = DEF
         el = result.el;
         actualLabel = result.values;
         return result.success;
-    }, options);
+    }, isNot, options);
     const message = enhanceError(el, wrapExpectedWithArray(el, actualLabel, expectedValue), actualLabel, this, verb, expectation, '', options);
     const result = {
         pass,

package/lib/matchers/element/toHaveComputedRole.js

@@ -8,6 +8,7 @@ async function condition(el, role, options) {
     return compareText(actualRole, role, options);
 }
 export async function toHaveComputedRole(received, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'computed role', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveComputedRole',
@@ -21,7 +22,7 @@ export async function toHaveComputedRole(received, expectedValue, options = DEFA
         el = result.el;
         actualRole = result.values;
         return result.success;
-    }, options);
+    }, isNot, options);
     const message = enhanceError(el, wrapExpectedWithArray(el, actualRole, expectedValue), actualRole, this, verb, expectation, '', options);
     const result = {
         pass,

package/lib/matchers/element/toHaveElementProperty.js

@@ -16,7 +16,8 @@ async function condition(el, property, value, options = DEFAULT_OPTIONS) {
     return compareText(prop, value, options);
 }
 export async function toHaveElementProperty(received, property, value, options = DEFAULT_OPTIONS) {
-    const { expectation = 'property', verb = 'have', isNot } = this;
+    const isNot = this.isNot;
+    const { expectation = 'property', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveElementProperty',
         expectedValue: [property, value],
@@ -29,7 +30,7 @@ export async function toHaveElementProperty(received, property, value, options =
         el = result.el;
         prop = result.values;
         return result.success;
-    }, options);
+    }, isNot, options);
     let message;
     if (value === undefined) {
         message = enhanceError(el, !isNot, pass, this, verb, expectation, property, options);

package/lib/matchers/element/toHaveHTML.js

@@ -8,6 +8,7 @@ async function condition(el, html, options) {
     return compareText(actualHTML, html, options);
 }
 export async function toHaveHTML(received, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'HTML', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveHTML',
@@ -25,7 +26,7 @@ export async function toHaveHTML(received, expectedValue, options = DEFAULT_OPTI
         el = result.el;
         actualHTML = result.values;
         return result.success;
-    }, options);
+    }, isNot, options);
     const message = enhanceError(el, wrapExpectedWithArray(el, actualHTML, expectedValue), actualHTML, this, verb, expectation, '', options);
     const result = {
         pass,

package/lib/matchers/element/toHaveHeight.js

@@ -8,6 +8,7 @@ async function condition(el, height, options) {
     };
 }
 export async function toHaveHeight(received, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'height', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveHeight',
@@ -31,7 +32,7 @@ export async function toHaveHeight(received, expectedValue, options = DEFAULT_OP
         el = result.el;
         actualHeight = result.values;
         return result.success;
-    }, { ...numberOptions, ...options });
+    }, isNot, { ...numberOptions, ...options });
     const error = numberError(numberOptions);
     const message = enhanceError(el, error, actualHeight, this, verb, expectation, '', options);
     const result = {

package/lib/matchers/element/toHaveSize.js

@@ -5,6 +5,7 @@ async function condition(el, size) {
     return compareObject(actualSize, size);
 }
 export async function toHaveSize(received, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'size', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveSize',
@@ -18,7 +19,7 @@ export async function toHaveSize(received, expectedValue, options = DEFAULT_OPTI
         el = result.el;
         actualSize = result.values;
         return result.success;
-    }, options);
+    }, isNot, options);
     const message = enhanceError(el, wrapExpectedWithArray(el, actualSize, expectedValue), actualSize, this, verb, expectation, '', options);
     const result = {
         pass,

package/lib/matchers/element/toHaveStyle.js

@@ -4,6 +4,7 @@ async function condition(el, style, options) {
     return compareStyle(el, style, options);
 }
 export async function toHaveStyle(received, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'style', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveStyle',
@@ -17,7 +18,7 @@ export async function toHaveStyle(received, expectedValue, options = DEFAULT_OPT
         el = result.el;
         actualStyle = result.values;
         return result.success;
-    }, options);
+    }, isNot, options);
     const message = enhanceError(el, wrapExpectedWithArray(el, actualStyle, expectedValue), actualStyle, this, verb, expectation, '', options);
     const result = {
         pass,

package/lib/matchers/element/toHaveText.js

@@ -28,6 +28,7 @@ async function condition(el, text, options) {
     };
 }
 export async function toHaveText(received, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'text', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveText',
@@ -45,7 +46,7 @@ export async function toHaveText(received, expectedValue, options = DEFAULT_OPTI
         el = result.el;
         actualText = result.values;
         return result.success;
-    }, options);
+    }, isNot, options);
     const message = enhanceError(el, wrapExpectedWithArray(el, actualText, expectedValue), actualText, this, verb, expectation, '', options);
     const result = {
         pass,

package/lib/matchers/element/toHaveWidth.js

@@ -8,6 +8,7 @@ async function condition(el, width, options) {
     };
 }
 export async function toHaveWidth(received, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'width', verb = 'have' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toHaveWidth',
@@ -31,7 +32,7 @@ export async function toHaveWidth(received, expectedValue, options = DEFAULT_OPT
         el = result.el;
         actualWidth = result.values;
         return result.success;
-    }, { ...numberOptions, ...options });
+    }, isNot, { ...numberOptions, ...options });
     const error = numberError(numberOptions);
     const message = enhanceError(el, error, actualWidth, this, verb, expectation, '', options);
     const result = {

package/lib/matchers/elements/toBeElementsArrayOfSize.js

@@ -2,6 +2,7 @@ import { waitUntil, enhanceError, compareNumbers, numberError } from '../../util
 import { refetchElements } from '../../util/refetchElements.js';
 import { DEFAULT_OPTIONS } from '../../constants.js';
 export async function toBeElementsArrayOfSize(received, expectedValue, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot;
     const { expectation = 'elements array of size', verb = 'be' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toBeElementsArrayOfSize',
@@ -27,7 +28,7 @@ export async function toBeElementsArrayOfSize(received, expectedValue, options =
         }
         elements = await refetchElements(elements, numberOptions.wait, true);
         return false;
-    }, { ...numberOptions, ...options });
+    }, isNot, { ...numberOptions, ...options });
     if (Array.isArray(received) && pass) {
         for (let index = originalLength; index < elements.length; index++) {
             received.push(elements[index]);

package/lib/matchers/mock/toBeRequestedTimes.js

@@ -2,6 +2,7 @@ import { waitUntil, enhanceError, compareNumbers } from '../../utils.js';
 import { numberError } from '../../util/formatMessage.js';
 import { DEFAULT_OPTIONS } from '../../constants.js';
 export async function toBeRequestedTimes(received, expectedValue = {}, options = DEFAULT_OPTIONS) {
+    const isNot = this.isNot || false;
     const { expectation = `called${typeof expectedValue === 'number' ? ' ' + expectedValue : ''} time${expectedValue !== 1 ? 's' : ''}`, verb = 'be' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toBeRequestedTimes',
@@ -15,7 +16,7 @@ export async function toBeRequestedTimes(received, expectedValue = {}, options =
     const pass = await waitUntil(async () => {
         actual = received.calls.length;
         return compareNumbers(actual, numberOptions);
-    }, { ...numberOptions, ...options });
+    }, isNot, { ...numberOptions, ...options });
     const error = numberError(numberOptions);
     const message = enhanceError('mock', error, actual, this, verb, expectation, '', numberOptions);
     const result = {

package/lib/matchers/mock/toBeRequestedWith.js

@@ -10,7 +10,8 @@ function reduceHeaders(headers) {
     }, {});
 }
 export async function toBeRequestedWith(received, expectedValue = {}, options = DEFAULT_OPTIONS) {
-    const { expectation = 'called with', verb = 'be', isNot } = this;
+    const isNot = this.isNot || false;
+    const { expectation = 'called with', verb = 'be' } = this;
     await options.beforeAssertion?.({
         matcherName: 'toBeRequestedWith',
         expectedValue,
@@ -29,7 +30,7 @@ export async function toBeRequestedWith(received, expectedValue = {}, options =
             }
         }
         return false;
-    }, { ...options, wait: isNot ? 0 : options.wait });
+    }, isNot, { ...options, wait: isNot ? 0 : options.wait });
     const message = enhanceError('mock', minifyRequestedWith(expectedValue), minifyRequestMock(actual, expectedValue) || 'was not called', this, verb, expectation, '', options);
     const result = {
         pass,

package/lib/matchers.js

@@ -1,4 +1,5 @@
 export * from './matchers/browser/toHaveClipboardText.js';
+export * from './matchers/browser/toHaveLocalStorageItem.js';
 export * from './matchers/browser/toHaveTitle.js';
 export * from './matchers/browser/toHaveUrl.js';
 export * from './matchers/element/toBeClickable.js';

package/lib/tsconfig.build.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.9.3"}
+{"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/toHaveLocalStorageItem.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.9.3"}

package/lib/utils.js

@@ -19,38 +19,50 @@ export function isAsymmetricMatcher(expected) {
 function isStringContainingMatcher(expected) {
     return isAsymmetricMatcher(expected) && ['StringContaining', 'StringNotContaining'].includes(expected.toString());
 }
-const waitUntil = async (condition, { wait = DEFAULT_OPTIONS.wait, interval = DEFAULT_OPTIONS.interval } = {}) => {
-    const start = Date.now();
+const waitUntil = async (condition, isNot = false, { wait = DEFAULT_OPTIONS.wait, interval = DEFAULT_OPTIONS.interval } = {}) => {
+    if (wait === 0) {
+        return await condition();
+    }
     let error;
-    let result = false;
-    do {
-        try {
-            result = await condition();
-            error = undefined;
-            if (result) {
-                break;
+    try {
+        const start = Date.now();
+        while (true) {
+            if (Date.now() - start > wait) {
+                throw new Error('timeout');
+            }
+            try {
+                const result = isNot !== (await condition());
+                error = undefined;
+                if (result) {
+                    break;
+                }
+                await sleep(interval);
+            }
+            catch (err) {
+                error = err;
+                await sleep(interval);
             }
         }
-        catch (err) {
-            error = err;
+        if (error) {
+            throw error;
         }
-        if (Date.now() - start < wait) {
-            await sleep(interval);
+        return !isNot;
+    }
+    catch {
+        if (error) {
+            throw error;
         }
-    } while (Date.now() - start < wait);
-    if (error) {
-        throw error;
+        return isNot;
     }
-    return result;
 };
 async function executeCommandBe(received, command, options) {
-    const { expectation, verb = 'be' } = this;
+    const { isNot, expectation, verb = 'be' } = this;
     let el = await received?.getElement();
     const pass = await waitUntil(async () => {
         const result = await executeCommand.call(this, el, async (element) => ({ result: await command(element) }), options);
         el = result.el;
         return result.success;
-    }, options);
+    }, isNot, options);
     const message = enhanceErrorBe(el, pass, this, verb, expectation, options);
     return {
         pass,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "5.6.4",
+  "version": "5.6.6",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
@@ -38,6 +38,11 @@
         "types": "./jasmine.d.ts"
       }
     ],
+    "./jasmine-wdio-expect-async": [
+      {
+        "types": "./jasmine-wdio-expect-async.d.ts"
+      }
+    ],
     "./types": "./types/expect-global.d.ts",
     "./expect-global": "./types/expect-global.d.ts"
   },
@@ -50,7 +55,9 @@
     "build": "run-s clean compile",
     "clean": "run-p clean:*",
     "clean:build": "rimraf ./lib",
-    "compile": "tsc --build tsconfig.build.json",
+    "compile": "run-s compile:*",
+    "compile:lib": "tsc --build tsconfig.build.json",
+    "compile:check": "if [ ! -f lib/index.js ] || [ $(find lib -type f | wc -l) -le 30 ]; then echo 'File structure under lib is broken'; exit 1; fi",
     "tsc:root-types": "node types-checks-filter-out-node_modules.js",
     "test": "run-s test:*",
     "test:tsc": "tsc --project tsconfig.json --noEmit --rootDir .",
@@ -65,7 +72,10 @@
     "ts:jasmine-async": "cd test-types/jasmine-async && tsc --project ./tsconfig.json",
     "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 install"
+    "prepare": "husky install",
+    "playgrounds:setup": "for dir in playgrounds/*/; do cd \"$dir\" && npm install && cd ../..; done",
+    "playgrounds:checks:all": "for dir in playgrounds/*/; do cd \"$dir\" && npm run checks:all && cd ../..; done",
+    "playgrounds:snapshots:update": "cd playgrounds/mocha && npm run snapshots:update && cd ../jest && npm run snapshots:update && cd ../.."
   },
   "dependencies": {
     "@vitest/snapshot": "^4.0.16",

package/types/expect-webdriverio.d.ts

@@ -89,6 +89,15 @@ interface WdioBrowserMatchers<_R, ActualT>{
      * `WebdriverIO.Browser` -> `execute`
      */
     toHaveClipboardText: FnWhenBrowser<ActualT, (clipboardText: string | RegExp | ExpectWebdriverIO.PartialMatcher<string>, options?: ExpectWebdriverIO.StringOptions) => Promise<void>>
+
+    /**
+     * `WebdriverIO.Browser` -> `execute`
+     */
+    toHaveLocalStorageItem: FnWhenBrowser<ActualT, (
+        key: string,
+        expectedValue?: string | RegExp | ExpectWebdriverIO.PartialMatcher<string>,
+        options?: ExpectWebdriverIO.StringOptions
+    ) => Promise<void>>
 }
 
 /**
@@ -311,7 +320,7 @@ interface WdioElementOrArrayMatchers<_R, ActualT = unknown> {
      */
     toHaveHTML: FnWhenElementOrArrayLike<ActualT, (
         html: string | RegExp | ExpectWebdriverIO.PartialMatcher<string> | Array<string | RegExp>,
-        options?: ExpectWebdriverIO.StringOptions
+        options?: ExpectWebdriverIO.HTMLOptions
     ) => Promise<void>>
 
     /**
@@ -728,6 +737,7 @@ declare namespace ExpectWebdriverIO {
          * `true` to check if the element is invisible due to the value of its visibility property. `true` by default.
          * @default true
          */
+
         visibilityProperty?: boolean
     }