@wdio/types - npm Package Compare versions

Comparing version 8.0.0-alpha.412 to 8.0.0-alpha.504

build/Capabilities.d.ts

@@ -222,3 +222,3 @@ import type { WebdriverIO as WebDriverIOOptions, Connection as ConnectionOptions } from './Options';
     prefs?: {
-        [name: string]: string | number | boolean;
+        [name: string]: string[] | string | number | boolean;
     };
@@ -257,3 +257,3 @@ /**
     prefs?: {
-        [name: string]: string | number | boolean;
+        [name: string]: string[] | string | number | boolean;
     };
@@ -974,6 +974,25 @@ }
     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;
@@ -992,2 +1011,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';
@@ -999,11 +1025,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;
@@ -1030,2 +1124,7 @@ appiumVersion?: string;
     browserVersion?: string;
+    /**
+     * Ignore invalid certificate errors.
+     *
+     * @default false
+     */
     acceptSslCerts?: boolean;
@@ -1032,0 +1131,0 @@ /**

build/index.d.ts

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

build/Options.d.ts

@@ -334,5 +334,8 @@ /// <reference types="node" />
     /**
-     * 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];
     /**
@@ -339,0 +342,0 @@ * Define specs for test execution. You can either specify a glob

build/Services.d.ts

@@ -8,8 +8,10 @@ /// <reference types="node" />
     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;
 }
@@ -16,0 +18,0 @@ export interface RunnerPlugin extends RunnerClass {

package.json

 {
   "name": "@wdio/types",
-  "version": "8.0.0-alpha.412+a2bc7ec67",
+  "version": "8.0.0-alpha.504+428a9d729",
   "description": "Utility package providing type information for a variety of WebdriverIO interfaces",
@@ -43,3 +43,3 @@ "author": "Christian Bromann <[e-mail]>",
   },
-  "gitHead": "a2bc7ec67e2a5fe000e539f44b0ea97f6e08ccbd"
+  "gitHead": "428a9d729ae6231968a60908732fa3f607d195e9"
 }

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

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

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

Improved metrics

Total package byte prevSize

127545

increased by3.18%

Lines of code

2419

increased by4.58%

No dependency changes