@wdio/types - npm Package Compare versions

Comparing version 8.27.2 to 8.28.0

build/Capabilities.d.ts

@@ -509,2 +509,31 @@ import type { WebdriverIO as WebDriverIOOptions, Connection as ConnectionOptions } from './Options.js';
     'appium:autoWebviewName'?: string;
+    'appium:uiautomator2ServerReadTimeout'?: number;
+    'appium:appWaitForLaunch'?: boolean;
+    'appium:remoteAppsCacheLimit'?: number;
+    'appium:enforceAppInstall'?: boolean;
+    'appium:clearDeviceLogsOnStart'?: boolean;
+    'appium:buildToolsVersion'?: string;
+    'appium:suppressKillServer'?: boolean;
+    'appium:ignoreHiddenApiPolicyError'?: boolean;
+    'appium:mockLocationApp'?: string;
+    'appium:logcatFormat'?: string;
+    'appium:logcatFilterSpecs'?: string;
+    'appium:allowDelayAdb'?: boolean;
+    'appium:avdEnv'?: {
+        [key: string]: string;
+    };
+    'appium:unlockStrategy'?: string;
+    'appium:unlockSuccessTimeout'?: number;
+    'appium:webviewDevtoolsPort'?: number;
+    'appium:ensureWebviewsHavePages'?: boolean;
+    'appium:enableWebviewDetailsCollection'?: boolean;
+    'appium:extractChromeAndroidPackageFromContextName'?: boolean;
+    'appium:showChromedriverLog'?: boolean;
+    'appium:chromeOptions'?: {
+        [key: string]: any;
+    };
+    'appium:chromeLoggingPrefs'?: {
+        [key: string]: any;
+    };
+    'appium:userProfile'?: number;
 }
@@ -511,0 +540,0 @@ /**

build/index.d.ts

@@ -8,2 +8,6 @@ import type * as Capabilities from './Capabilities.js';
 import type * as Workers from './Workers.js';
+/**
+ * exported constant values
+ */
+export { MESSAGE_TYPES } from './Workers.js';
 export type { Capabilities, Clients, Options, Services, Frameworks, Reporters, Workers };
@@ -10,0 +14,0 @@ export type JsonPrimitive = string | number | boolean | null;

build/index.js

@@ -1,1 +0,4 @@
-export {};
+/**
+ * exported constant values
+ */
+export { MESSAGE_TYPES } from './Workers.js';

build/Workers.d.ts

@@ -23,2 +23,14 @@ /// <reference types="node" resolution-mode="require"/>
 }
+export interface WorkerRequest {
+    command: 'workerRequest';
+    args: {
+        id: number;
+        message: SocketMessage;
+    };
+}
+export interface WorkerEvent {
+    name: 'workerEvent';
+    origin: string;
+    args: SocketMessage;
+}
 export interface WorkerMessage {
@@ -46,2 +58,94 @@ name: string;
 export type WorkerPool = Record<string, Worker>;
+/**
+ * The following defines a new worker messaging system
+ */
+export declare enum MESSAGE_TYPES {
+    /**
+     * @wdio/browser-runner messages
+     */
+    consoleMessage = 0,
+    commandRequestMessage = 1,
+    commandResponseMessage = 2,
+    hookTriggerMessage = 3,
+    hookResultMessage = 4,
+    expectRequestMessage = 5,
+    expectResponseMessage = 6,
+    switchDebugState = 7,
+    coverageMap = 8,
+    customCommand = 9,
+    initiateBrowserStateRequest = 10,
+    initiateBrowserStateResponse = 11
+}
+interface SocketMessagePayloadType<T extends MESSAGE_TYPES> {
+    type: T;
+    value: SocketMessageValue[T];
+}
+export type SocketMessageValue = {
+    [MESSAGE_TYPES.consoleMessage]: ConsoleEvent;
+    [MESSAGE_TYPES.commandRequestMessage]: CommandRequestEvent;
+    [MESSAGE_TYPES.commandResponseMessage]: CommandResponseEvent;
+    [MESSAGE_TYPES.hookTriggerMessage]: HookTriggerEvent;
+    [MESSAGE_TYPES.hookResultMessage]: HookResultEvent;
+    [MESSAGE_TYPES.expectRequestMessage]: ExpectRequestEvent;
+    [MESSAGE_TYPES.expectResponseMessage]: ExpectResponseEvent;
+    [MESSAGE_TYPES.switchDebugState]: boolean;
+    [MESSAGE_TYPES.coverageMap]: any;
+    [MESSAGE_TYPES.customCommand]: CustomCommandEvent;
+    [MESSAGE_TYPES.initiateBrowserStateRequest]: BrowserStateRequest;
+    [MESSAGE_TYPES.initiateBrowserStateResponse]: BrowserState;
+};
+export type SocketMessagePayload<T extends MESSAGE_TYPES> = T extends any ? SocketMessagePayloadType<T> : never;
+export type SocketMessage = SocketMessagePayload<MESSAGE_TYPES>;
+export interface ConsoleEvent {
+    name: 'consoleEvent';
+    type: 'log' | 'info' | 'warn' | 'debug' | 'error';
+    args: unknown[];
+    cid: string;
+}
+export interface CustomCommandEvent {
+    commandName: string;
+    cid: string;
+}
+export interface BrowserStateRequest {
+    cid: string;
+}
+export interface BrowserState {
+    customCommands: string[];
+}
+interface MessageWithPendingPromiseId {
+    id: number;
+}
+export interface HookTriggerEvent extends MessageWithPendingPromiseId {
+    cid: string;
+    name: string;
+    args: unknown[];
+}
+export interface HookResultEvent extends MessageWithPendingPromiseId {
+    error?: Error;
+}
+export interface CommandRequestEvent extends MessageWithPendingPromiseId {
+    cid: string;
+    commandName: string;
+    args: unknown[];
+}
+export interface CommandResponseEvent extends MessageWithPendingPromiseId {
+    result?: unknown;
+    error?: Error;
+}
+export interface ExpectRequestEvent extends MessageWithPendingPromiseId {
+    cid: string;
+    matcherName: string;
+    /**
+     * this should be `MatcherState` from `expect` but don't want to introduce
+     * this as a dependency to this package, therefor keep it as `any` for now
+     */
+    scope: any;
+    args: unknown[];
+    element?: any | any[];
+}
+export interface ExpectResponseEvent extends MessageWithPendingPromiseId {
+    pass: boolean;
+    message: string;
+}
+export {};
 //# sourceMappingURL=Workers.d.ts.map

build/Workers.js

@@ -1,1 +0,25 @@
-export {};
+/**
+ * The following defines a new worker messaging system
+ */
+export var MESSAGE_TYPES;
+(function (MESSAGE_TYPES) {
+    /**
+     * @wdio/browser-runner messages
+     */
+    MESSAGE_TYPES[MESSAGE_TYPES["consoleMessage"] = 0] = "consoleMessage";
+    MESSAGE_TYPES[MESSAGE_TYPES["commandRequestMessage"] = 1] = "commandRequestMessage";
+    MESSAGE_TYPES[MESSAGE_TYPES["commandResponseMessage"] = 2] = "commandResponseMessage";
+    MESSAGE_TYPES[MESSAGE_TYPES["hookTriggerMessage"] = 3] = "hookTriggerMessage";
+    MESSAGE_TYPES[MESSAGE_TYPES["hookResultMessage"] = 4] = "hookResultMessage";
+    MESSAGE_TYPES[MESSAGE_TYPES["expectRequestMessage"] = 5] = "expectRequestMessage";
+    MESSAGE_TYPES[MESSAGE_TYPES["expectResponseMessage"] = 6] = "expectResponseMessage";
+    MESSAGE_TYPES[MESSAGE_TYPES["switchDebugState"] = 7] = "switchDebugState";
+    MESSAGE_TYPES[MESSAGE_TYPES["coverageMap"] = 8] = "coverageMap";
+    MESSAGE_TYPES[MESSAGE_TYPES["customCommand"] = 9] = "customCommand";
+    MESSAGE_TYPES[MESSAGE_TYPES["initiateBrowserStateRequest"] = 10] = "initiateBrowserStateRequest";
+    MESSAGE_TYPES[MESSAGE_TYPES["initiateBrowserStateResponse"] = 11] = "initiateBrowserStateResponse";
+    /**
+     * @wdio/runner messages
+     * TODO: add runner messages
+     */
+})(MESSAGE_TYPES || (MESSAGE_TYPES = {}));

package.json

 {
   "name": "@wdio/types",
-  "version": "8.27.2",
+  "version": "8.28.0",
   "description": "Utility package providing type information for a variety of WebdriverIO interfaces",
@@ -35,3 +35,3 @@ "author": "Christian Bromann <[e-mail]>",
   },
-  "gitHead": "dab64ff6cbd378b295af3a65d6346692f0653d23"
+  "gitHead": "15f6ac509df48b23477cd4c793206a4f707e3df0"
 }

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

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

144569

increased by6.72%

Lines of code

2683

increased by6.51%

No dependency changes