@wdio/types - npm Package Compare versions

Comparing version 7.20.7 to 7.20.8-alpha.504

build/Capabilities.d.ts

@@ -1,2 +0,2 @@
-import { WebdriverIO as WebDriverIOOptions, Connection as ConnectionOptions } from './Options';
+import type { WebdriverIO as WebDriverIOOptions, Connection as ConnectionOptions } from './Options';
 export declare type PageLoadingStrategy = 'none' | 'eager' | 'normal';
@@ -118,2 +118,3 @@ export declare type LoggingPreferenceType = 'OFF' | 'SEVERE' | 'WARNING' | 'INFO' | 'CONFIG' | 'FINE' | 'FINER' | 'FINEST' | 'ALL';
     'sauce:visual'?: SauceLabsVisualCapabilities;
+    'experitest:accessKey'?: string;
     'bstack:options'?: BrowserStackCapabilities;
@@ -127,6 +128,8 @@ 'browserstack.local'?: boolean;
     'moz:firefoxOptions'?: FirefoxOptions;
-    'moz:debuggerAddress'?: boolean;
+    'moz:debuggerAddress'?: string;
     firefox_profile?: string;
     'ms:edgeOptions'?: MicrosoftEdgeOptions;
     'ms:edgeChromium'?: MicrosoftEdgeOptions;
+    'ms:experimental-webdriver'?: boolean;
+    'ms:waitForAppLaunch'?: string;
     'safari.options'?: {
@@ -221,3 +224,3 @@ [name: string]: any;
     prefs?: {
-        [name: string]: string | number | boolean;
+        [name: string]: string[] | string | number | boolean;
     };
@@ -256,3 +259,3 @@ /**
     prefs?: {
-        [name: string]: string | number | boolean;
+        [name: string]: string[] | string | number | boolean;
     };
@@ -407,2 +410,8 @@ }
     'appium:directConnectPath'?: string;
+    /**
+     * Windows-specific capability: Please see https://github.com/appium/appium-windows-driver#usage
+     * This is a hexadecimal handle of an existing application top level window to attach to. Either this
+     * capability or 'appium:app' must be provided on session startup.
+     */
+    'appium:appTopLevelWindow'?: string;
 }
@@ -482,2 +491,3 @@ /**
     espressoServerLaunchTimeout?: number;
+    disableSuppressAccessibilityService?: boolean;
 }
@@ -638,2 +648,6 @@ /**
     'appium:appInstallStrategy'?: string;
+    /**
+     * Windows Application Driver capabilities
+     */
+    'appium:appArguments'?: string;
 }
@@ -965,6 +979,25 @@ export interface AppiumXCUISafariGlobalPreferences {
     device?: string;
+    /**
+     * Specify a name for a logical group of builds.
+     */
     projectName?: string;
+    /**
+     * Specify a name for a logical group of tests.
+     */
     buildName?: string;
+    /**
+     * Specify an identifier for the test run.
+     */
     sessionName?: string;
+    /**
+     * Test locally hosted websites on BrowserStack.
+     * To enable access to the local machine you need to setup the
+     * [BrowserStack Local Binary](https://www.browserstack.com/local-testing/automate).
+     */
     local?: boolean;
+    /**
+     * Generate screenshots at various steps of the test.
+     *
+     * @default false
+     */
     debug?: boolean;
@@ -983,2 +1016,9 @@ networkLogs?: boolean;
     localIdentifier?: string;
+    /**
+     * Capture browser console logs at various steps in the test.
+     * Console Logs are available for Selenium tests on Desktop Chrome
+     * and Mobile Chrome (Android devices).
+     *
+     * @default 'errors'
+     */
     consoleLogs?: 'disable' | 'errors' | 'warnings' | 'info' | 'verbose';
@@ -990,11 +1030,79 @@ appiumLogs?: boolean;
     timezone?: string;
+    /**
+     * Set the resolution of the VM.
+     */
     resolution?: string;
+    /**
+     * Mask the data sent or retrieved by certain commands.
+     *
+     * Note: Multiple commands can be passed in a single array, separated by commas.
+     */
     'browserstack.maskCommands'?: string[];
+    /**
+     * BrowerStack triggers `BROWSERSTACK_IDLE_TIMEOUT` error when a session
+     * is left idle for more than `idleTimeout` seconds. This happens as BrowserStack by
+     * default waits for the timeout duration for additional steps or commands
+     * to run. If no command is received during that time, the session is stopped,
+     * changing the session status to `TIMEOUT` on the Automate dashboard.
+     *
+     * Valid range: 0-300 seconds.
+     *
+     * @default 90
+     */
     idleTimeout?: number;
+    /**
+     * Mask credentials from test logs if using basic authentication.
+     */
     maskBasicAuth?: boolean;
+    /**
+     * Specify a custom delay between the execution of Selenium commands.
+     *
+     * @default 20
+     */
     autoWait?: number;
+    /**
+     * Add a host entry (/etc/hosts) to the remote BrowserStack machine.
+     *
+     * Format: ip_address domain_name
+     * @example
+     * { "bstack:options": { hosts: "1.2.3.4 staging.website.com" } }
+     */
     hosts?: string;
+    /**
+     * IE 11 uses cached pages when navigating using the backward or forward buttons.
+     * To disable page caching, set this value to 1.
+     *
+     * @default 0
+     */
     bfcache?: 0 | 1;
+    /**
+     * Enable WSS (WebSocket Secure) connections to work with Network Logs
+     * on Chrome v71 and above.
+     *
+     * Note: if using `localhost` in your test, change it to `bs-local.com`.
+     *
+     * @default false
+     */
     wsLocalSupport?: boolean;
+    /**
+     * Use this capability to disable cross origin restrictions in Safari.
+     * Available for Monterey, Big Sur, Catalina and Mojave.
+     *
+     * @default false
+     */
+    disableCorsRestrictions?: boolean;
+    /**
+     * Use this capability to add a custom tag to the builds.
+     * These tags can be used to filter the builds on the Automate dashboard.
+     */
+    buildTag?: string;
+    /**
+     * Specify a particular mobile device for the test environment.
+     */
     deviceName?: string;
+    /**
+     * Use this flag to test on a physical mobile device.
+     *
+     * @default false
+     */
     realMobile?: boolean;
@@ -1021,2 +1129,7 @@ appiumVersion?: string;
     browserVersion?: string;
+    /**
+     * Ignore invalid certificate errors.
+     *
+     * @default false
+     */
     acceptSslCerts?: boolean;
@@ -1023,0 +1136,0 @@ /**

build/Capabilities.js

@@ -1,2 +0,1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

build/Clients.d.ts

@@ -1,2 +0,2 @@
-import { DesiredCapabilities } from './Capabilities';
+import type { DesiredCapabilities } from './Capabilities';
 export interface Multiremote {
@@ -3,0 +3,0 @@ sessionId?: string;

build/Clients.js

@@ -1,2 +0,1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

build/Compiler.js

@@ -1,5 +0,4 @@
-"use strict";
 // These types are extracted from `ts-node` (`dist/index.d.ts`) to avoid the dependendy on `ts-node`
 // Copyright (c) 2014 Blake Embrey ([e-mail])
 // Licsense: MIT
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

build/Frameworks.js

@@ -1,2 +0,1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

build/index.d.ts

@@ -43,2 +43,4 @@ import type * as Capabilities from './Capabilities';
         }
+        interface BrowserRunnerOptions {
+        }
     }
@@ -45,0 +47,0 @@ namespace WebDriver {

build/index.js

@@ -1,2 +0,1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

build/Options.d.ts

@@ -5,11 +5,11 @@ /// <reference types="node" />
 /// <reference types="node" />
-import * as http from 'http';
-import * as https from 'https';
+import * as http from 'node:http';
+import * as https from 'node:https';
 import type { RegisterOptions } from './Compiler';
-import type { URL } from 'url';
-import { W3CCapabilities, DesiredCapabilities, RemoteCapabilities, RemoteCapability, MultiRemoteCapabilities, Capabilities } from './Capabilities';
-import { Hooks, ServiceEntry } from './Services';
-import { ReporterEntry } from './Reporters';
+import type { URL } from 'node:url';
+import type { W3CCapabilities, DesiredCapabilities, RemoteCapabilities, RemoteCapability, MultiRemoteCapabilities, Capabilities } from './Capabilities';
+import type { Hooks, ServiceEntry } from './Services';
+import type { ReporterEntry } from './Reporters';
 export declare type WebDriverLogTypes = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent';
-export declare type SupportedProtocols = 'webdriver' | 'devtools' | './protocol-stub';
+export declare type SupportedProtocols = 'webdriver' | 'devtools' | './protocol-stub.js';
 export declare type Agents = {
@@ -27,6 +27,10 @@ http?: any;
     responseType?: string;
-    retry?: number;
+    retry?: {
+        limit: number;
+    };
     searchParams?: Record<string, unknown>;
     throwHttpErrors?: boolean;
-    timeout?: number;
+    timeout?: {
+        response: number;
+    };
     url?: URL;
@@ -332,5 +336,8 @@ path?: string;
     /**
-     * Type of runner (currently only "local" is supported)
+     * Type of runner
+     * - local: every spec file group is spawned in its own local process
+     *   running an independant browser session
+     * - browser: all spec files are run within the browser
      */
-    runner?: 'local';
+    runner?: 'local' | 'browser' | ['browser', WebdriverIO.BrowserRunnerOptions] | ['local', never];
     /**
@@ -360,2 +367,17 @@ * Define specs for test execution. You can either specify a glob
     /**
+     * Inserts WebdriverIO's globals (e.g. `browser`, `$` and `$$`) into the
+     * global environment. If you set to `false`, you should import from
+     * `@wdio/globals`, e.g.:
+     *
+     * ```ts
+     * import { browser, $, $$, expect } from '@wdio/globals'
+     * ```
+     *
+     * Note: WebdriverIO doesn't handle injection of test framework specific
+     * globals.
+     *
+     * @default true
+     */
+    injectGlobals?: boolean;
+    /**
      * If you want your test run to stop after a specific number of test failures, use bail.
@@ -362,0 +384,0 @@ * (It defaults to 0, which runs all tests no matter what.) Note: Please be aware that

build/Options.js

@@ -1,2 +0,1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

build/Reporters.d.ts

 /// <reference types="node" />
 /// <reference types="node" />
-import { WriteStream } from 'fs';
-import { EventEmitter } from 'events';
+import type { WriteStream } from 'node:fs';
+import type { EventEmitter } from 'node:events';
 export interface Options {
@@ -6,0 +6,0 @@ outputDir?: string;

build/Reporters.js

@@ -1,2 +0,1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

build/Services.d.ts

 /// <reference types="node" />
-import { DesiredCapabilities, RemoteCapability, RemoteCapabilities } from './Capabilities';
-import { Testrunner as TestrunnerOptions, WebdriverIO as WebdriverIOOptions } from './Options';
-import { Suite, Test, TestResult } from './Frameworks';
+import type { DesiredCapabilities, RemoteCapability, RemoteCapabilities } from './Capabilities';
+import type { Testrunner as TestrunnerOptions, WebdriverIO as WebdriverIOOptions } from './Options';
+import type { Suite, Test, TestResult } from './Frameworks';
 export interface RunnerInstance {
     initialise(): Promise<void>;
     shutdown(): Promise<void>;
+    closeSession?: (cid: number) => Promise<void>;
     getWorkerCount(): number;
     run(args: any): NodeJS.EventEmitter;
     workerPool: any;
+    browserPool: any;
 }
 export interface RunnerClass {
-    new (configFile: string, config: Omit<WebdriverIOOptions, 'capabilities' | keyof Hooks>): RunnerInstance;
+    new (options: WebdriverIO.BrowserRunnerOptions, config: Omit<WebdriverIOOptions, 'capabilities' | keyof Hooks>): RunnerInstance;
 }
@@ -15,0 +17,0 @@ export interface RunnerPlugin extends RunnerClass {

build/Services.js

@@ -1,2 +0,1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

build/Workers.d.ts

 /// <reference types="node" />
-import { EventEmitter } from 'events';
-import { Testrunner as TestrunnerOptions } from './Options';
-import { DesiredCapabilities, MultiRemoteCapabilities, RemoteCapability, W3CCapabilities } from './Capabilities';
+import type { EventEmitter } from 'node:events';
+import type { Testrunner as TestrunnerOptions } from './Options';
+import type { DesiredCapabilities, MultiRemoteCapabilities, RemoteCapability, W3CCapabilities } from './Capabilities';
 export interface Job {
@@ -6,0 +6,0 @@ caps: DesiredCapabilities | W3CCapabilities | MultiRemoteCapabilities;

build/Workers.js

@@ -1,2 +0,1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package.json

 {
   "name": "@wdio/types",
-  "version": "7.20.7",
+  "version": "7.20.8-alpha.504+428a9d729",
   "description": "Utility package providing type information for a variety of WebdriverIO interfaces",
@@ -8,3 +8,3 @@ "author": "Christian Bromann <[e-mail]>",
   "license": "MIT",
-  "main": "./build/index.js",
+  "type": "module",
   "types": "./build/index.d.ts",
@@ -16,7 +16,8 @@ "exports": {
   "engines": {
-    "node": ">=12.0.0"
+    "node": "^16.13 || >=18"
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/webdriverio/webdriverio.git"
+    "url": "git://github.com/webdriverio/webdriverio.git",
+    "directory": "packages/wdio-types"
   },
@@ -34,4 +35,3 @@ "keywords": [
   "dependencies": {
-    "@types/node": "^18.0.0",
-    "got": "^11.8.1"
+    "@types/node": "^18.0.0"
   },
@@ -41,3 +41,8 @@ "peerDependencies": {
   },
-  "gitHead": "21b8b61453f4749d87eca3e4d7d6e5e2cb60f043"
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "gitHead": "428a9d729ae6231968a60908732fa3f607d195e9"
 }

README.md

@@ -19,3 +19,3 @@ WebdriverIO Types
 ```js
-import { Capabilities } from '@wdio/types';
+import type { Capabilities } from '@wdio/types';
 
@@ -22,0 +22,0 @@ const w3cCaps: Capabilities.W3CCapabilities = {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

127546

increased by4.12%

Dependency count

2

decreased by-33.33%

Lines of code

2419

increased by5.68%

Is type module

Yes

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removedgot@^11.8.1

• - Removed@sindresorhus/is@4.6.0(transitive)

• - Removed@szmarczak/http-timer@4.0.6(transitive)

• - Removed@types/cacheable-request@6.0.3(transitive)

• - Removed@types/http-cache-semantics@4.0.4(transitive)

• - Removed@types/keyv@3.1.4(transitive)

• - Removed@types/responselike@1.0.3(transitive)

• - Removedcacheable-lookup@5.0.4(transitive)

• - Removedcacheable-request@7.0.4(transitive)

• - Removedclone-response@1.0.3(transitive)

• - Removeddecompress-response@6.0.0(transitive)

• - Removeddefer-to-connect@2.0.1(transitive)

• - Removedend-of-stream@1.4.4(transitive)

• - Removedget-stream@5.2.0(transitive)

• - Removedgot@11.8.6(transitive)

• - Removedhttp-cache-semantics@4.1.1(transitive)

• - Removedhttp2-wrapper@1.0.3(transitive)

• - Removedjson-buffer@3.0.1(transitive)

• - Removedkeyv@4.5.4(transitive)

• - Removedlowercase-keys@2.0.0(transitive)

• - Removedmimic-response@1.0.13.1.0(transitive)

• - Removednormalize-url@6.1.0(transitive)

• - Removedonce@1.4.0(transitive)

• - Removedp-cancelable@2.1.1(transitive)

• - Removedpump@3.0.2(transitive)

• - Removedquick-lru@5.1.1(transitive)

• - Removedresolve-alpn@1.2.1(transitive)

• - Removedresponselike@2.0.1(transitive)

• - Removedwrappy@1.0.2(transitive)