expect-webdriverio 4.2.8 → 4.3.0

package/lib/utils.js

@@ -67,7 +67,7 @@ const compareNumbers = (actual, options = {}) => {
     }
     return false;
 };
-export const compareText = (actual, expected, { ignoreCase = false, trim = true, containing = false }) => {
+export const compareText = (actual, expected, { ignoreCase = false, trim = true, containing = false, atStart = false, atEnd = false, atIndex, replace }) => {
     if (typeof actual !== 'string') {
         return {
             value: actual,
@@ -77,6 +77,9 @@ export const compareText = (actual, expected, { ignoreCase = false, trim = true,
     if (trim) {
         actual = actual.trim();
     }
+    if (Array.isArray(replace)) {
+        actual = replaceActual(replace, actual);
+    }
     if (ignoreCase) {
         actual = actual.toLowerCase();
         if (!(expected instanceof RegExp)) {
@@ -95,12 +98,30 @@ export const compareText = (actual, expected, { ignoreCase = false, trim = true,
             result: actual.includes(expected)
         };
     }
+    if (atStart) {
+        return {
+            value: actual,
+            result: actual.startsWith(expected)
+        };
+    }
+    if (atEnd) {
+        return {
+            value: actual,
+            result: actual.endsWith(expected)
+        };
+    }
+    if (atIndex) {
+        return {
+            value: actual,
+            result: actual.substring(atIndex, actual.length).startsWith(expected)
+        };
+    }
     return {
         value: actual,
         result: actual === expected
     };
 };
-export const compareTextWithArray = (actual, expectedArray, { ignoreCase = false, trim = false, containing = false }) => {
+export const compareTextWithArray = (actual, expectedArray, { ignoreCase = false, trim = false, containing = false, atStart = false, atEnd = false, atIndex, replace }) => {
     if (typeof actual !== 'string') {
         return {
             value: actual,
@@ -110,12 +131,30 @@ export const compareTextWithArray = (actual, expectedArray, { ignoreCase = false
     if (trim) {
         actual = actual.trim();
     }
+    if (Array.isArray(replace)) {
+        actual = replaceActual(replace, actual);
+    }
     if (ignoreCase) {
         actual = actual.toLowerCase();
         expectedArray = expectedArray.map(item => (item instanceof RegExp) ? item : item.toLowerCase());
     }
     const textInArray = expectedArray.some((expected) => {
-        return expected instanceof RegExp ? !!actual.match(expected) : containing ? actual.includes(expected) : actual === expected;
+        if (expected instanceof RegExp) {
+            return !!actual.match(expected);
+        }
+        if (containing) {
+            return actual.includes(expected);
+        }
+        if (atStart) {
+            return actual.startsWith(expected);
+        }
+        if (atEnd) {
+            return actual.endsWith(expected);
+        }
+        if (atIndex) {
+            return actual.substring(atIndex, actual.length).startsWith(expected);
+        }
+        return actual === expected;
     });
     return {
         value: actual,
@@ -151,3 +190,17 @@ function aliasFn(fn, { verb, expectation } = {}, ...args) {
     return fn.apply(this, args);
 }
 export { updateElementsArray, wrapExpectedWithArray, enhanceError, numberError, executeCommand, executeCommandBe, waitUntil, compareNumbers, aliasFn };
+function replaceActual(replace, actual) {
+    const hasMultipleReplacers = replace.every(r => Array.isArray(r));
+    const replacers = hasMultipleReplacers
+        ? replace
+        : [replace];
+    if (replacers.some(r => Array.isArray(r) && r.length !== 2)) {
+        throw new Error('Replacers need to have a searchValue and a replaceValue');
+    }
+    for (const replacer of replacers) {
+        const [searchValue, replaceValue] = replacer;
+        actual = actual.replace(searchValue, replaceValue);
+    }
+    return actual;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expect-webdriverio",
-  "version": "4.2.8",
+  "version": "4.3.0",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "description": "WebdriverIO Assertion Library",
   "license": "MIT",
@@ -75,7 +75,7 @@
     "rimraf": "^5.0.1",
     "shelljs": "^0.8.5",
     "typescript": "^5.2.2",
-    "vitest": "0.34.4",
+    "vitest": "0.34.5",
     "webdriverio": "^8.16.7"
   },
   "optionalDependencies": {

package/types/expect-webdriverio.d.ts

@@ -1,11 +1,23 @@
+type searchValue = string | RegExp
+type replaceValue = string | ((substring: string, ...args: any[]) => string)
+type Replacer = [searchValue, replaceValue]
+
 declare namespace ExpectWebdriverIO {
-    function expect<T = unknown, R extends void | Promise<void> = void | Promise<void>>(actual: T): Matchers<R, T>
+    function expect<T = unknown, R extends void | Promise<void> = void | Promise<void>>(
+        actual: T
+    ): Matchers<R, T>
     function setOptions(options: DefaultOptions): void
     function getConfig(): any
-    const matchers: Record<string, ((actual: any, ...expected: any[]) => Promise<{
-        pass: boolean;
-        message(): string;
-    }>)>
+    const matchers: Record<
+        string,
+        (
+            actual: any,
+            ...expected: any[]
+        ) => Promise<{
+            pass: boolean
+            message(): string
+        }>
+    >
 
     interface DefaultOptions {
         /**
@@ -43,6 +55,30 @@ declare namespace ExpectWebdriverIO {
          */
         containing?: boolean
 
+        /**
+         * expect actual value to start with the expected value
+         * Otherwise strict equal
+         */
+        atStart?: boolean
+
+        /**
+         * expect actual value to end with the expected value
+         * Otherwise strict equal
+         */
+        atEnd?: boolean
+
+        /**
+         * expect actual value to have the expected value at the given index (index starts at 0 not 1)
+         * Otherwise strict equal
+         */
+        atIndex?: number
+
+        /**
+         * replace the actual value (example: strip newlines from the value) and expect it to match the expected value
+         * Otherwise strict equal
+         */
+        replace?: Replacer | Replacer[]
+
         /**
          * might be helpful to force converting property value to string
          */
@@ -89,7 +125,11 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getAttribute`
          */
-        toHaveAttribute(attribute: string, value?: string | RegExp, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveAttribute(
+            attribute: string,
+            value?: string | RegExp,
+            options?: ExpectWebdriverIO.StringOptions
+        ): R
         /**
          * `WebdriverIO.Element` -> `getAttribute`
          */
@@ -141,7 +181,11 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getProperty`
          */
-        toHaveElementProperty(property: string | RegExp, value?: any, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveElementProperty(
+            property: string | RegExp,
+            value?: any,
+            options?: ExpectWebdriverIO.StringOptions
+        ): R
 
         /**
          * `WebdriverIO.Element` -> `getProperty` value
@@ -225,17 +269,23 @@ declare namespace ExpectWebdriverIO {
         /**
          * `WebdriverIO.Element` -> `getText`
          */
-        toHaveText(text: string | RegExp | Array<string | RegExp>, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveText(
+            text: string | RegExp | Array<string | RegExp>,
+            options?: ExpectWebdriverIO.StringOptions
+        ): R
         /**
          * `WebdriverIO.Element` -> `getText`
          * Element's text includes the text provided
          */
-        toHaveTextContaining(text: string | RegExp | Array<string | RegExp>, options?: ExpectWebdriverIO.StringOptions): R
+        toHaveTextContaining(
+            text: string | RegExp | Array<string | RegExp>,
+            options?: ExpectWebdriverIO.StringOptions
+        ): R
 
         /**
-        * `WebdriverIO.Element` -> `getAttribute("style")`
-        */
-        toHaveStyle(style: { [key: string]: string; }, options?: ExpectWebdriverIO.StringOptions): R
+         * `WebdriverIO.Element` -> `getAttribute("style")`
+         */
+        toHaveStyle(style: { [key: string]: string }, options?: ExpectWebdriverIO.StringOptions): R
 
         // ===== browser only =====
         /**