expect-webdriverio 4.0.0

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "expect-webdriverio",
+  "version": "4.0.0",
+  "description": "",
+  "main": "lib/index.js",
+  "scripts": {
+    "build": "run-s clean compile",
+    "clean": "run-p clean:*",
+    "clean:build": "rimraf ./lib",
+    "clean:tests": "rimraf test-types/**/node_modules && rimraf test-types/**/dist",
+    "compile": "tsc --build tsconfig.build.json",
+    "release": "release-it --github.release",
+    "release:ci": "npm run release -- --ci --npm.skipChecks --no-git.requireCleanWorkingDir",
+    "release:patch": "npm run release -- patch",
+    "release:minor": "npm run release -- minor",
+    "release:major": "npm run release -- major",
+    "test": "run-s test:*",
+    "test:lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "test:unit": "jest",
+    "watch": "npm run compile -- --watch",
+    "test:types": "node test-types/copy && npm run ts && npm run clean:tests",
+    "ts": "run-p ts:*",
+    "ts:default": "cd test-types/default && tsc --incremental",
+    "ts:jest": "cd test-types/jest && tsc --incremental",
+    "ts:jasmine": "cd test-types/jasmine && tsc --incremental",
+    "prepare": "husky install"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/webdriverio/expect-webdriverio.git"
+  },
+  "keywords": [
+    "expect-webdriverio",
+    "expect",
+    "webdriverio",
+    "wdio"
+  ],
+  "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/webdriverio/expect-webdriverio/issues"
+  },
+  "homepage": "https://github.com/webdriverio/expect-webdriverio#readme",
+  "devDependencies": {
+    "@types/jasmine": "^3.6.6",
+    "@types/jest": "^27.0.1",
+    "@types/node": "^15.0.1",
+    "@typescript-eslint/eslint-plugin": "^4.17.0",
+    "@typescript-eslint/parser": "^4.17.0",
+    "eslint": "^7.21.0",
+    "husky": "^7.0.0",
+    "jest": "^26.6.3",
+    "npm-run-all": "^4.1.5",
+    "release-it": "^14.4.1",
+    "rimraf": "^3.0.2",
+    "shelljs": "^0.8.4",
+    "ts-jest": "^26.5.3",
+    "ts-node": "^10.0.0",
+    "typescript": "^4.2.3",
+    "webdriverio": "^7.1.1"
+  },
+  "types": "types/jest-global.d.ts",
+  "typeScriptVersion": "3.8.3",
+  "dependencies": {
+    "expect": "^27.0.2",
+    "jest-matcher-utils": "^27.0.2"
+  }
+}

package/types/expect-webdriverio.d.ts

@@ -0,0 +1,327 @@
+declare namespace ExpectWebdriverIO {
+    function setOptions(options: DefaultOptions): void
+
+    interface DefaultOptions {
+        /**
+         * time in ms to wait for expectation to succeed. Default: 3000
+         */
+        wait?: number
+
+        /**
+         * interval between attempts. Default: 100
+         */
+        interval?: number
+    }
+
+    interface CommandOptions extends DefaultOptions {
+        /**
+         * user message to prepend before assertion error
+         */
+        message?: string
+    }
+
+    interface StringOptions extends CommandOptions {
+        /**
+         * apply `toLowerCase` to both actual and expected values
+         */
+        ignoreCase?: boolean
+
+        /**
+         * apply `trim` to actual value
+         */
+        trim?: boolean
+
+        /**
+         * expect actual value to contain expected value.
+         * Otherwise strict equal
+         */
+        containing?: boolean
+
+        /**
+         * might be helpful to force converting property value to string
+         */
+        asString?: boolean
+    }
+
+    interface NumberOptions extends CommandOptions {
+        /**
+         * equals
+         */
+        eq?: number
+        /**
+         * less than or equals
+         */
+        lte?: number
+
+        /**
+         * greater than or equals
+         */
+        gte?: number
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    interface Matchers<R, T> {
+        // ===== $ or $$ =====
+        /**
+         * `WebdriverIO.Element` -> `isDisplayed`
+         */
+        toBeDisplayed(options?: ExpectWebdriverIO.CommandOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `isExisting`
+         */
+        toExist(options?: ExpectWebdriverIO.CommandOptions): R
+        /**
+         * `WebdriverIO.Element` -> `isExisting`
+         */
+        toBePresent(options?: ExpectWebdriverIO.CommandOptions): R
+        /**
+         * `WebdriverIO.Element` -> `isExisting`
+         */
+        toBeExisting(options?: ExpectWebdriverIO.CommandOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `getAttribute`
+         */
+        toHaveAttribute(attribute: string, value?: string, options?: ExpectWebdriverIO.StringOptions): R
+        /**
+         * `WebdriverIO.Element` -> `getAttribute`
+         */
+        toHaveAttr(attribute: string, value?: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `getAttribute`
+         * Element's attribute includes the value.
+         */
+        toHaveAttributeContaining(
+            attribute: string,
+            contains: string,
+            options?: ExpectWebdriverIO.StringOptions
+        ): R
+        /**
+         * `WebdriverIO.Element` -> `getAttribute`
+         * Element's attribute includes the value.
+         */
+        toHaveAttrContaining(
+            attribute: string,
+            contains: string,
+            options?: ExpectWebdriverIO.StringOptions
+        ): R
+
+        /**
+         * `WebdriverIO.Element` -> `getAttribute` class
+         * @deprecated since v1.3.1 - use `toHaveElementClass` instead.
+         */
+        toHaveClass(className: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `getAttribute` class
+         */
+        toHaveElementClass(className: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `getAttribute` class
+         * @deprecated since v1.3.1 - use `toHaveElementClassContaining` instead.
+         * Element's class includes the className.
+         */
+        toHaveClassContaining(className: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `getAttribute` class
+         * Element's class includes the className.
+         */
+        toHaveElementClassContaining(className: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `getProperty`
+         */
+        toHaveElementProperty(property: string, value?: any, options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `getProperty` value
+         */
+        toHaveValue(value: string, options?: ExpectWebdriverIO.StringOptions): R
+        /**
+         * `WebdriverIO.Element` -> `getProperty` value
+         * Element's value includes the value.
+         */
+        toHaveValueContaining(value: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `isClickable`
+         */
+        toBeClickable(options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `!isEnabled`
+         */
+        toBeDisabled(options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `isDisplayedInViewport`
+         */
+        toBeDisplayedInViewport(options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `isEnabled`
+         */
+        toBeEnabled(options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `isFocused`
+         */
+        toBeFocused(options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `isSelected`
+         */
+        toBeSelected(options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `isSelected`
+         */
+        toBeChecked(options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `$$('./*').length`
+         * supports less / greater then or equals to be passed in options
+         */
+        toHaveChildren(
+            size?: number | ExpectWebdriverIO.NumberOptions,
+            options?: ExpectWebdriverIO.NumberOptions
+        ): R
+
+        /**
+         * `WebdriverIO.Element` -> `getAttribute` href
+         */
+        toHaveHref(href: string, options?: ExpectWebdriverIO.StringOptions): R
+        /**
+         * `WebdriverIO.Element` -> `getAttribute` href
+         */
+        toHaveLink(href: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `getAttribute` href
+         * Element's href includes the value provided
+         */
+        toHaveHrefContaining(href: string, options?: ExpectWebdriverIO.StringOptions): R
+        /**
+         * `WebdriverIO.Element` -> `getAttribute` href
+         * Element's href includes the value provided
+         */
+        toHaveLinkContaining(href: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `getProperty` value
+         */
+        toHaveId(id: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Element` -> `getText`
+         */
+        toHaveText(text: string | string[], options?: ExpectWebdriverIO.StringOptions): R
+        /**
+         * `WebdriverIO.Element` -> `getText`
+         * Element's text includes the text provided
+         */
+        toHaveTextContaining(text: string | string[], options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+        * `WebdriverIO.Element` -> `getAttribute("style")`
+        */
+        toHaveStyle(style: { [key: string]: string; }, options?: ExpectWebdriverIO.StringOptions): R
+
+        // ===== browser only =====
+        /**
+         * `WebdriverIO.Browser` -> `getUrl`
+         */
+        toHaveUrl(url: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        // ===== browser only =====
+        /**
+         * `WebdriverIO.Browser` -> `getUrl`
+         * Browser's url includes the provided text
+         */
+        toHaveUrlContaining(url: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        /**
+         * `WebdriverIO.Browser` -> `getTitle`
+         */
+        toHaveTitle(title: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        // ===== browser only =====
+        /**
+         * `WebdriverIO.Browser` -> `getTitle`
+         * Browser's title includes the provided text
+         */
+        toHaveTitleContaining(title: string, options?: ExpectWebdriverIO.StringOptions): R
+
+        // ===== $$ only =====
+        /**
+         * `WebdriverIO.ElementArray` -> `$$('...').length`
+         * supports less / greater then or equals to be passed in options
+         */
+        toBeElementsArrayOfSize(
+            size: number | ExpectWebdriverIO.NumberOptions,
+            options?: ExpectWebdriverIO.NumberOptions
+        ): R
+
+        // ==== network mock ====
+
+        /**
+         * Check that `WebdriverIO.Mock` was called
+         */
+        toBeRequested(options?: ExpectWebdriverIO.CommandOptions): R
+
+        /**
+         * Check that `WebdriverIO.Mock` was called N times
+         */
+        toBeRequestedTimes(
+            times: number | ExpectWebdriverIO.NumberOptions,
+            options?: ExpectWebdriverIO.NumberOptions
+        ): R
+
+        /**
+         * Check that `WebdriverIO.Mock` was called with the specific parameters
+         */
+        toBeRequestedWith(requestedWith: RequestedWith, options?: ExpectWebdriverIO.CommandOptions): R
+    }
+
+    type RequestedWith = {
+        url?: string | ExpectWebdriverIO.PartialMatcher | ((url: string) => boolean)
+        method?: string | Array<string>
+        statusCode?: number | Array<number>
+        requestHeaders?:
+            | Record<string, string>
+            | ExpectWebdriverIO.PartialMatcher
+            | ((headers: Record<string, string>) => boolean)
+        responseHeaders?:
+            | Record<string, string>
+            | ExpectWebdriverIO.PartialMatcher
+            | ((headers: Record<string, string>) => boolean)
+        postData?:
+            | string
+            | ExpectWebdriverIO.JsonCompatible
+            | ExpectWebdriverIO.PartialMatcher
+            | ((r: string | undefined) => boolean)
+        response?:
+            | string
+            | ExpectWebdriverIO.JsonCompatible
+            | ExpectWebdriverIO.PartialMatcher
+            | ((r: string) => boolean)
+    }
+
+    type jsonPrimitive = string | number | boolean | null
+    type jsonObject = { [x: string]: jsonPrimitive | jsonObject | jsonArray }
+    type jsonArray = Array<jsonPrimitive | jsonObject | jsonArray>
+    type JsonCompatible = jsonObject | jsonArray
+
+    interface PartialMatcher {
+        sample?: any
+        asymmetricMatch?(...args: any[]): boolean
+    }
+}
+
+declare module 'expect-webdriverio' {
+    export = ExpectWebdriverIO
+}

package/types/jest-global.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="expect-webdriverio/types/standalone"/>
+
+declare const expect: ExpectWebdriverIO.Expect
+
+declare namespace NodeJS {
+    interface Global {
+        expect: ExpectWebdriverIO.Expect;
+    }
+}

package/types/standalone-global.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="expect-webdriverio/types/standalone"/>
+
+declare const expectWdio: ExpectWebdriverIO.Expect
+
+declare namespace NodeJS {
+    interface Global {
+        expectWdio: ExpectWebdriverIO.Expect;
+    }
+}

package/types/standalone.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="expect-webdriverio/types/expect-webdriverio"/>
+
+declare namespace ExpectWebdriverIO {
+    interface Matchers<R, T> extends Readonly<import('expect/build/types').Matchers<R>> {
+        not: Matchers<R, T>
+        resolves: Matchers<Promise<R>, T>
+        rejects: Matchers<Promise<R>, T>
+    }
+
+    type Expect = {
+        <T = unknown>(actual: T): Matchers<T, T>
+        extend(map: Record<string, Function>): void
+    } & AsymmetricMatchers
+
+    type AsymmetricMatchers = {
+        any(expectedObject: any): PartialMatcher
+        anything(): PartialMatcher
+        arrayContaining(sample: Array<unknown>): PartialMatcher
+        objectContaining(sample: Record<string, unknown>): PartialMatcher
+        stringContaining(expected: string): PartialMatcher
+        stringMatching(expected: string | RegExp): PartialMatcher
+        not: AsymmetricMatchers
+    }
+}