expect-webdriverio 6.0.3 → 6.0.5

package/lib/api/index.js

@@ -0,0 +1,2 @@
+import { some as wdioSome } from '../matchers/modifiers/some.js';
+export const some = wdioSome;

package/lib/index.js

@@ -4,18 +4,6 @@ import { DEFAULT_OPTIONS, defaultOptionsList } from './constants.js';
 import createSoftExpect from './softExpect.js';
 import { SoftAssertService } from './softAssert.js';
 import { oneOf } from './matchers/asymmetrics/oneOf.js';
-import { some as wdioSome } from './matchers/modifiers/some.js';
-const wdioExpect = expectLib;
-const MATCHERS_VERSION = '6.0.3';
-if ((wdioExpect.__wdio_version && wdioExpect.__wdio_version !== MATCHERS_VERSION) || (!wdioExpect.__wdio_version && wdioExpect.soft !== undefined)) {
-    if (wdioExpect.__wdio_version) {
-        console.warn(`[expect-webdriverio] Conflict: Initializing v${MATCHERS_VERSION}, but v${wdioExpect.__wdio_version} is already loaded.`);
-    }
-    else {
-        console.warn(`[expect-webdriverio] Conflict: Initializing v${MATCHERS_VERSION}, but an older version of expect-webdriverio is already loaded.`);
-    }
-}
-wdioExpect.__wdio_version = MATCHERS_VERSION;
 export const wdioCustomMatchers = {};
 export const matchers = new Map();
 const extend = expectLib.extend;
@@ -35,24 +23,22 @@ Object.entries(wdioMatchers).forEach(([matcher, value]) => {
         filteredWdioMatchers[matcher] = value;
     }
 });
+const wdioExpect = expectLib;
 wdioExpect.extend(filteredWdioMatchers);
 wdioExpect.oneOf = oneOf;
-if (wdioExpect.soft === undefined) {
-    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)
-    });
-}
+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;
-export const some = wdioSome;
 export const getDefaultOptions = () => DEFAULT_OPTIONS;
 export const setDefaultOptions = (options) => {
     Object.entries(options).forEach(([key, value]) => {

package/lib/matchers/asymmetrics/oneOf.js

@@ -1,6 +1,9 @@
 import { compareTextWithArray } from '../../utils.js';
 import { WdioAsymmetricMatchers } from './asymmetricsUtils.js';
+const ONE_OF_TAG = 'expect-webdriverio.oneOf';
+const ONE_OF_SYMBOL = Symbol.for(ONE_OF_TAG);
 export class OneOfMatcher extends WdioAsymmetricMatchers {
+    [ONE_OF_SYMBOL] = true;
     options = {};
     constructor(...sample) {
         super(sample);
@@ -49,3 +52,6 @@ export class OneOfMatcher extends WdioAsymmetricMatchers {
 export function oneOf(...sample) {
     return new OneOfMatcher(...sample);
 }
+export function isOneOfMatcher(oneOfMatcher) {
+    return oneOfMatcher instanceof OneOfMatcher || oneOfMatcher?.[ONE_OF_SYMBOL] === true;
+}

package/lib/matchers/element/toHaveAttribute.js

@@ -3,7 +3,7 @@ import { executeCommandWithStrategy } from '../../util/executeCommand.js';
 import { compareText, enhanceError, isAsymmetricMatcher, waitUntil, wrapExpectedWithArray } from '../../utils.js';
 import { expect as wdioExpect } from '../../index.js';
 import { buildWdioAsymmetricMatchersWithOptions } from '../asymmetrics/asymmetricsUtils.js';
-import { OneOfMatcher } from '../asymmetrics/oneOf.js';
+import { isOneOfMatcher } from '../asymmetrics/oneOf.js';
 async function conditionAttributeValueMatchWithExpected(el, attribute, expectedValue, options) {
     const attributeValue = await el.getAttribute(attribute);
     if (typeof attributeValue !== 'string' || expectedValue === undefined || expectedValue === null) {
@@ -12,7 +12,7 @@ async function conditionAttributeValueMatchWithExpected(el, attribute, expectedV
         }
         return { success: attributeValue === expectedValue, actual: attributeValue };
     }
-    else if (expectedValue instanceof OneOfMatcher) {
+    else if (isOneOfMatcher(expectedValue)) {
         return { success: expectedValue.asymmetricMatch(attributeValue), actual: attributeValue };
     }
     return compareText(attributeValue, expectedValue, options);

package/lib/matchers/element/toHaveElementProperty.js

@@ -3,7 +3,7 @@ import { executeCommandWithStrategy } from '../../util/executeCommand.js';
 import { expect as wdioExpect } from '../../index.js';
 import { compareText, enhanceError, isAsymmetricMatcher, waitUntil, wrapExpectedWithArray } from '../../utils.js';
 import { buildWdioAsymmetricMatchersWithOptions } from '../asymmetrics/asymmetricsUtils.js';
-import { OneOfMatcher } from '../asymmetrics/oneOf.js';
+import { isOneOfMatcher } from '../asymmetrics/oneOf.js';
 async function condition(el, property, expectedValue, options = DEFAULT_OPTIONS) {
     const { asString = false } = options;
     const propertyValue = await el.getProperty(property);
@@ -13,7 +13,7 @@ async function condition(el, property, expectedValue, options = DEFAULT_OPTIONS)
         }
         return { success: propertyValue === expectedValue, actual: propertyValue };
     }
-    else if (expectedValue instanceof OneOfMatcher) {
+    else if (isOneOfMatcher(expectedValue)) {
         return { success: expectedValue.asymmetricMatch(propertyValue), actual: propertyValue };
     }
     return compareText(propertyValue.toString(), expectedValue, options);

package/lib/matchers/modifiers/some.js

@@ -11,5 +11,5 @@ export function some(elements) {
     return new SomeElementsWrapper(elements);
 }
 export function isSomeWrapper(value) {
-    return value instanceof SomeElementsWrapper;
+    return value instanceof SomeElementsWrapper || value?.[SOME_SYMBOL] === true;
 }

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/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/numberOptionsUtil.ts","../src/util/refetchElements.ts","../src/util/stringUtil.ts","../src/util/waitUntil.ts"],"version":"5.9.3"}

package/lib/utils.js

@@ -5,7 +5,7 @@ import { executeCommandWithStrategy } from './util/executeCommand.js';
 import { enhanceError, enhanceErrorBe } from './util/formatMessage.js';
 import { waitUntil } from './util/waitUntil.js';
 import { DEFAULT_FEATURE_FLAGS } from './constants.js';
-import { OneOfMatcher } from './matchers/asymmetrics/oneOf.js';
+import { isOneOfMatcher, OneOfMatcher } from './matchers/asymmetrics/oneOf.js';
 export function isJasmineStringAsymmetricMatcher(expected) {
     return isAsymmetricMatcher(expected) && !('toAsymmetricMatcher' in expected) && 'jasmineToString' in expected && typeof expected.jasmineToString === 'function';
 }
@@ -88,7 +88,7 @@ export const compareTextOrArray = (actualText, expectedTexts, options) => {
         return { actual: actualText, success: false };
     }
     if (Array.isArray(expectedTexts)) {
-        if (expectedTexts.some((expected) => expected instanceof OneOfMatcher)) {
+        if (expectedTexts.some((expected) => isOneOfMatcher(expected))) {
             throw new Error('OneOf is not supported in array under legacy behavior. Please enable `useToHaveTextStrictMultiElementsCompareStrategy` feature flag to use the new strict index based matching strategy with `expect.oneOf()`.');
         }
         else {
@@ -96,7 +96,7 @@ export const compareTextOrArray = (actualText, expectedTexts, options) => {
             expectedTexts = new OneOfMatcher(...expectedTexts).withOptions(options);
         }
     }
-    if (expectedTexts instanceof OneOfMatcher) {
+    if (isOneOfMatcher(expectedTexts)) {
         return { success: expectedTexts.asymmetricMatch(actualText), actual: actualText };
     }
     const compareResults = compareText(actualText, expectedTexts, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "6.0.3",
+  "version": "6.0.5",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
@@ -44,7 +44,8 @@
       }
     ],
     "./types": "./types/expect-global.d.ts",
-    "./expect-global": "./types/expect-global.d.ts"
+    "./expect-global": "./types/expect-global.d.ts",
+    "./api": "./lib/api/index.js"
   },
   "types": "./types/expect-webdriverio.d.ts",
   "typeScriptVersion": "3.8.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.
@@ -1264,7 +1263,17 @@ declare namespace ExpectWebdriverIO {
      * Allow to match one of the specified value.
      */
     type OneOfPartialMatcher<T> = ExpectWebdriverIO.PartialMatcher<T[]>
+}
+
+declare module 'expect-webdriverio' {
+    export = ExpectWebdriverIO
+}
 
+/**
+ * Expose the expect-wdio API without the burden of initialization.
+ * Required since importing from 'expect-webdriverio' can trigger double initialization.
+ */
+declare module 'expect-webdriverio/api' {
     /**
      * Quantifier modifier. Wraps a `$$()` result so that the matcher passes
      * when at least one element satisfies the condition (∃ semantics).
@@ -1274,11 +1283,7 @@ declare namespace ExpectWebdriverIO {
      * await expect(some($$('.items'))).not.toBeDisplayed() // at least one is NOT displayed
      * await expect(some($$('.items'))).toHaveText('foo')
      */
-    function some<T extends ElementArrayLike>(
+    export function some<T extends ElementArrayLike>(
         elements: T
     ): WdioSome<T>
 }
-
-declare module 'expect-webdriverio' {
-    export = ExpectWebdriverIO
-}