expect-webdriverio 6.0.9 → 6.1.0-alpha.0

package/lib/constants.js

@@ -1,21 +1,31 @@
-export const DEFAULT_FEATURE_FLAGS = {
-    useToHaveTextStrictMultiElementsCompareStrategy: false
-};
-export const DEFAULT_OPTIONS = {
-    wait: 2000,
-    interval: 100,
-    beforeAssertion: async () => { },
-    afterAssertion: async () => { },
-    featureFlags: DEFAULT_FEATURE_FLAGS
-};
-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
-];
+import { getGlobalSingleton } from './util/globalSingleton.js';
+function createSharedConstants() {
+    const DEFAULT_FEATURE_FLAGS = {
+        useToHaveTextStrictMultiElementsCompareStrategy: false
+    };
+    const DEFAULT_OPTIONS = {
+        wait: 2000,
+        interval: 100,
+        beforeAssertion: async () => { },
+        afterAssertion: async () => { },
+        featureFlags: DEFAULT_FEATURE_FLAGS
+    };
+    const DEFAULT_OPTIONS_TO_BE_DISPLAYED = {
+        ...DEFAULT_OPTIONS,
+        withinViewport: false,
+        contentVisibilityAuto: true,
+        opacityProperty: true,
+        visibilityProperty: true
+    };
+    return {
+        DEFAULT_FEATURE_FLAGS,
+        DEFAULT_OPTIONS,
+        DEFAULT_OPTIONS_TO_BE_DISPLAYED,
+        defaultOptionsList: [DEFAULT_OPTIONS, DEFAULT_OPTIONS_TO_BE_DISPLAYED]
+    };
+}
+const shared = getGlobalSingleton('constants', createSharedConstants);
+export const DEFAULT_FEATURE_FLAGS = shared.DEFAULT_FEATURE_FLAGS;
+export const DEFAULT_OPTIONS = shared.DEFAULT_OPTIONS;
+export const DEFAULT_OPTIONS_TO_BE_DISPLAYED = shared.DEFAULT_OPTIONS_TO_BE_DISPLAYED;
+export const defaultOptionsList = shared.defaultOptionsList;

package/lib/index.js

@@ -4,41 +4,52 @@ import { DEFAULT_OPTIONS, defaultOptionsList } from './constants.js';
 import createSoftExpect from './softExpect.js';
 import { SoftAssertService } from './softAssert.js';
 import { oneOf } from './matchers/asymmetrics/oneOf.js';
-export const wdioCustomMatchers = {};
-export const matchers = new Map();
-const extend = expectLib.extend;
-expectLib.extend = (extendedMatchers) => {
-    if (!extendedMatchers || typeof extendedMatchers !== 'object') {
-        return;
-    }
-    Object.entries(extendedMatchers).forEach(([name, matcher]) => {
-        wdioCustomMatchers[name] = matcher;
-        matchers.set(name, matcher);
+import { getGlobalSingleton } from './util/globalSingleton.js';
+function createSharedExpectSetup() {
+    const wdioCustomMatchers = {};
+    const matchers = new Map();
+    const extend = expectLib.extend;
+    expectLib.extend = (extendedMatchers) => {
+        if (!extendedMatchers || typeof extendedMatchers !== 'object') {
+            return;
+        }
+        Object.entries(extendedMatchers).forEach(([name, matcher]) => {
+            wdioCustomMatchers[name] = matcher;
+            matchers.set(name, matcher);
+        });
+        return extend(extendedMatchers);
+    };
+    const filteredWdioMatchers = {};
+    Object.entries(wdioMatchers).forEach(([matcher, value]) => {
+        if (typeof value === 'function') {
+            filteredWdioMatchers[matcher] = value;
+        }
     });
-    return extend(extendedMatchers);
-};
-const filteredWdioMatchers = {};
-Object.entries(wdioMatchers).forEach(([matcher, value]) => {
-    if (typeof value === 'function') {
-        filteredWdioMatchers[matcher] = value;
-    }
-});
-const wdioExpect = expectLib;
-wdioExpect.extend(filteredWdioMatchers);
-wdioExpect.oneOf = oneOf;
-Object.defineProperty(wdioExpect, 'soft', {
-    value: (actual) => createSoftExpect(actual)
-});
-Object.defineProperty(wdioExpect, 'getSoftFailures', {
-    value: (testId) => SoftAssertService.getInstance().getFailures(testId)
-});
-Object.defineProperty(wdioExpect, 'assertSoftFailures', {
-    value: (testId) => SoftAssertService.getInstance().assertNoFailures(testId)
-});
-Object.defineProperty(wdioExpect, 'clearSoftFailures', {
-    value: (testId) => SoftAssertService.getInstance().clearFailures(testId)
-});
-export const expect = wdioExpect;
+    const wdioExpect = expectLib;
+    wdioExpect.extend(filteredWdioMatchers);
+    wdioExpect.oneOf = oneOf;
+    Object.defineProperty(wdioExpect, 'soft', {
+        configurable: true,
+        value: (actual) => createSoftExpect(actual)
+    });
+    Object.defineProperty(wdioExpect, 'getSoftFailures', {
+        configurable: true,
+        value: (testId) => SoftAssertService.getInstance().getFailures(testId)
+    });
+    Object.defineProperty(wdioExpect, 'assertSoftFailures', {
+        configurable: true,
+        value: (testId) => SoftAssertService.getInstance().assertNoFailures(testId)
+    });
+    Object.defineProperty(wdioExpect, 'clearSoftFailures', {
+        configurable: true,
+        value: (testId) => SoftAssertService.getInstance().clearFailures(testId)
+    });
+    return { wdioExpect, wdioCustomMatchers, matchers };
+}
+const sharedExpectSetup = getGlobalSingleton('expect', createSharedExpectSetup);
+export const wdioCustomMatchers = sharedExpectSetup.wdioCustomMatchers;
+export const matchers = sharedExpectSetup.matchers;
+export const expect = sharedExpectSetup.wdioExpect;
 export const getDefaultOptions = () => DEFAULT_OPTIONS;
 export const setDefaultOptions = (options) => {
     Object.entries(options).forEach(([key, value]) => {

package/lib/matchers/browser/toHaveLocalStorageItem.js

@@ -1,6 +1,6 @@
 import { waitUntil, enhanceError, compareText } from '../../utils.js';
 import { DEFAULT_OPTIONS } from '../../constants.js';
-import { expect } from '../../index.js';
+import { expect } from 'expect';
 export async function toHaveLocalStorageItem(browser, key, expectedValue, options = DEFAULT_OPTIONS) {
     const { expectation = 'localStorage item', verb = 'have', isNot, matcherName = 'toHaveLocalStorageItem' } = this;
     await options.beforeAssertion?.({

package/lib/matchers/element/toHaveAttribute.js

@@ -1,7 +1,7 @@
 import { DEFAULT_OPTIONS } from '../../constants.js';
 import { executeCommandWithStrategy } from '../../util/executeCommand.js';
 import { compareText, enhanceError, isAsymmetricMatcher, waitUntil, wrapExpectedWithArray } from '../../utils.js';
-import { expect as wdioExpect } from '../../index.js';
+import { expect } from 'expect';
 import { buildWdioAsymmetricMatchersWithOptions } from '../asymmetrics/asymmetricsUtils.js';
 import { isOneOfMatcher } from '../asymmetrics/oneOf.js';
 async function conditionAttributeValueMatchWithExpected(el, attribute, expectedValue, options) {
@@ -51,7 +51,7 @@ export async function toHaveAttribute(received, attribute, value, options = DEFA
         if (paramsCount > 2) {
             console.warn('Using undefined or null as value for toHaveAttribute is deprecated and will be removed in v6.0.0. Please omit the third argument entirely or use toHaveAttribute(el, attribute, wdioExpect.anything(), options).');
         }
-        expectedValue = wdioExpect.anything();
+        expectedValue = expect.anything();
     }
     else {
         expectedValue = value;

package/lib/matchers/element/toHaveElementProperty.js

@@ -1,6 +1,6 @@
 import { DEFAULT_OPTIONS } from '../../constants.js';
 import { executeCommandWithStrategy } from '../../util/executeCommand.js';
-import { expect as wdioExpect } from '../../index.js';
+import { expect } from 'expect';
 import { compareText, enhanceError, isAsymmetricMatcher, waitUntil, wrapExpectedWithArray } from '../../utils.js';
 import { buildWdioAsymmetricMatchersWithOptions } from '../asymmetrics/asymmetricsUtils.js';
 import { isOneOfMatcher } from '../asymmetrics/oneOf.js';
@@ -25,7 +25,7 @@ export async function toHaveElementProperty(received, property, value, options =
         if (paramsCount > 2) {
             console.warn('Using undefined or null as value for toHaveElementProperty is deprecated and will be removed in v6.0.0. Please omit the third argument entirely or use toHaveElementProperty(el, property, object.anything(), options).');
         }
-        value = wdioExpect.anything();
+        value = expect.anything();
     }
     await options.beforeAssertion?.({
         matcherName,

package/lib/snapshot.js

@@ -1,7 +1,7 @@
 import { expect } from '@wdio/globals';
 import { SnapshotClient } from '@vitest/snapshot';
 import { NodeSnapshotEnvironment } from '@vitest/snapshot/environment';
-let service;
+import { getGlobalSingleton } from './util/globalSingleton.js';
 class WebdriverIOSnapshotEnvironment extends NodeSnapshotEnvironment {
     #resolveSnapshotPath;
     constructor(resolveSnapshotPath) {
@@ -84,9 +84,6 @@ export class SnapshotService {
         }
     }
     static initiate(options) {
-        if (!service) {
-            service = new SnapshotService(options);
-        }
-        return service;
+        return getGlobalSingleton('snapshotService', () => new SnapshotService(options));
     }
 }

package/lib/softAssert.js

@@ -1,14 +1,11 @@
+import { getGlobalSingleton } from './util/globalSingleton.js';
 export class SoftAssertService {
-    static instance;
     static GLOBAL_TEST_ID = '__global_soft_assert_context__';
     failureMap = new Map();
     currentTest = null;
     constructor() { }
     static getInstance() {
-        if (!SoftAssertService.instance) {
-            SoftAssertService.instance = new SoftAssertService();
-        }
-        return SoftAssertService.instance;
+        return getGlobalSingleton('softAssertService', () => new SoftAssertService());
     }
     setCurrentTest(testId, testName, testFile) {
         this.currentTest = { id: testId, name: testName, file: testFile };

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/api/index.ts","../src/matchers/snapshot.ts","../src/matchers/asymmetrics/asymmetricsUtils.ts","../src/matchers/asymmetrics/oneOf.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/toHaveComputedLabel.ts","../src/matchers/element/toHaveComputedRole.ts","../src/matchers/element/toHaveElementClass.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/matchers/modifiers/some.ts","../src/util/commandOptionsUtils.ts","../src/util/elementsUtil.ts","../src/util/executeCommand.ts","../src/util/formatMessage.ts","../src/util/numberOptionsUtil.ts","../src/util/refetchElements.ts","../src/util/stringUtil.ts","../src/util/waitUntil.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/api/index.ts","../src/matchers/snapshot.ts","../src/matchers/asymmetrics/asymmetricsUtils.ts","../src/matchers/asymmetrics/oneOf.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/toHaveComputedLabel.ts","../src/matchers/element/toHaveComputedRole.ts","../src/matchers/element/toHaveElementClass.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/matchers/modifiers/some.ts","../src/util/commandOptionsUtils.ts","../src/util/elementsUtil.ts","../src/util/executeCommand.ts","../src/util/formatMessage.ts","../src/util/globalSingleton.ts","../src/util/numberOptionsUtil.ts","../src/util/refetchElements.ts","../src/util/stringUtil.ts","../src/util/waitUntil.ts"],"version":"5.9.3"}

package/lib/util/globalSingleton.js

@@ -0,0 +1,8 @@
+import { createRequire } from 'node:module';
+const { version } = createRequire(import.meta.url)('../../package.json');
+const packageMajorVersion = version.split('.')[0];
+export function getGlobalSingleton(key, create) {
+    const globalKey = Symbol.for(`expect-webdriverio.${key}@${packageMajorVersion}`);
+    const globalScope = globalThis;
+    return (globalScope[globalKey] ??= create());
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "6.0.9",
+  "version": "6.1.0-alpha.0",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
@@ -86,7 +86,7 @@
     "playgrounds:snapshots:update": "cd playgrounds && npm run snapshots:update"
   },
   "dependencies": {
-    "@vitest/snapshot": "^4.1.10",
+    "@vitest/snapshot": "^4.1.11",
     "deep-eql": "^5.0.2",
     "expect": "^30.4.1",
     "jest-matcher-utils": "^30.4.1"
@@ -99,10 +99,10 @@
     "@types/jest": "^30.0.0",
     "@types/mocha": "^10.0.10",
     "@types/node": "^24.13.3",
-    "@vitest/coverage-v8": "^4.1.10",
+    "@vitest/coverage-v8": "^4.1.11",
     "@vitest/eslint-plugin": "^1.6.27",
     "@wdio/eslint": "^0.1.3",
-    "@wdio/types": "^9.31.1",
+    "@wdio/types": "^9.32.0",
     "eslint": "^9.39.5",
     "husky": "^9.1.7",
     "npm-run-all2": "^9.0.3",
@@ -110,8 +110,8 @@
     "rimraf": "^6.1.3",
     "strip-ansi": "^7.2.0",
     "typescript": "^5.9.3",
-    "vitest": "^4.1.10",
-    "webdriverio": "^9.30.1"
+    "vitest": "^4.1.11",
+    "webdriverio": "^9.32.0"
   },
   "peerDependencies": {
     "@wdio/globals": "^9.0.0",

package/types/expect-webdriverio.d.ts

@@ -22,6 +22,7 @@ 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 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.
 type RawMatcherFn<Context extends ExpectLibMatcherContext = ExpectLibMatcherContext> = {
@@ -1102,12 +1103,7 @@ declare namespace ExpectWebdriverIO {
         message?: string
     }
 
-    interface HTMLOptions extends StringOptions {
-        /**
-         * return the HTML with the selector tag included
-         */
-        includeSelectorTag?: boolean
-    }
+    interface HTMLOptions extends StringOptions, WdioGetHTMLOptions {}
 
     interface StringOptions extends CommandOptions {
         /**