@wdio/protocols 8.0.0 → 8.1.0

package/build/protocols/webdriverBidi.d.ts

@@ -0,0 +1,35 @@
+declare const _default: {
+    sendCommand: {
+        socket: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+            returns: {
+                type: string;
+                name: string;
+                description: string;
+            };
+        };
+    };
+    sendAsyncCommand: {
+        socket: {
+            command: string;
+            description: string;
+            ref: string;
+            parameters: {
+                name: string;
+                type: string;
+                description: string;
+                required: boolean;
+            }[];
+        };
+    };
+};
+export default _default;
+//# sourceMappingURL=webdriverBidi.d.ts.map

package/build/protocols/webdriverBidi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webdriverBidi.d.ts","sourceRoot":"","sources":["../../src/protocols/webdriverBidi.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wBAoCC"}

package/build/protocols/webdriverBidi.js

@@ -0,0 +1,37 @@
+export default {
+    sendCommand: {
+        socket: {
+            command: 'send',
+            description: 'Send socket commands via WebDriver Bidi',
+            ref: 'https://github.com/w3c/webdriver-bidi',
+            parameters: [
+                {
+                    name: 'params',
+                    type: 'object',
+                    description: 'socket payload',
+                    required: true,
+                },
+            ],
+            returns: {
+                type: 'Object',
+                name: 'response',
+                description: 'WebDriver Bidi response',
+            },
+        },
+    },
+    sendAsyncCommand: {
+        socket: {
+            command: 'sendAsync',
+            description: 'Send asynchronous socket commands via WebDriver Bidi',
+            ref: 'https://github.com/w3c/webdriver-bidi',
+            parameters: [
+                {
+                    name: 'params',
+                    type: 'object',
+                    description: 'socket payload',
+                    required: true,
+                },
+            ],
+        },
+    },
+};

package/build/types.d.ts

@@ -1,7 +1,7 @@
 export interface ProtocolCommandResponse {
     [key: string]: any;
 }
-export interface SessionReturn extends /* DesiredCapabilities, */ ProtocolCommandResponse {
+export interface SessionReturn extends ProtocolCommandResponse {
 }
 export interface StatusReturn extends ProtocolCommandResponse {
     ready?: boolean;
@@ -86,8 +86,8 @@ export interface Cookie {
     sameSite?: SameSiteOptions;
 }
 export type CommandPath = 'string';
-export type CommandMethod = 'POST' | 'GET' | 'DELETE';
-export type Protocol = Record<CommandPath, Record<CommandMethod, CommandEndpoint>>;
+export type CommandMethod = 'POST' | 'GET' | 'DELETE' | 'socket';
+export type Protocol = Record<string, Partial<Record<CommandMethod, CommandEndpoint>>>;
 /**
  * describes a command endpoint
  */
@@ -99,7 +99,7 @@ export interface CommandEndpoint {
     /**
      * command description
      */
-    description: string;
+    description?: string;
     /**
      * link to specification reference
      */
@@ -124,11 +124,12 @@ export interface CommandEndpoint {
      * information on return data
      */
     returns?: CommandReturnObject;
+    examples?: string[][];
 }
 export interface CommandReturnObject {
     type: string;
     name: string;
-    description: string;
+    description?: string;
 }
 export interface CommandPathVariables {
     name: string;
@@ -144,7 +145,7 @@ export interface CommandParameters {
     name: string;
     type: string;
     description: string;
-    required: boolean;
+    required?: boolean;
 }
 export type Platform = 'ios' | 'android';
 export type Environments = 'XCUITest' | 'UIAutomation' | 'UiAutomator';
@@ -156,7 +157,7 @@ export type Environments = 'XCUITest' | 'UIAutomation' | 'UiAutomator';
  * }
  * ```
  */
-export type SupportedEnvironments = Record<Platform, Record<Environments, string>>;
+export type SupportedEnvironments = Partial<Record<Platform, Partial<Record<Environments, string>>>>;
 export type SupportedMethods = ('session.status' | 'session.new' | 'session.subscribe' | 'session.unsubscribe' | 'browsingContext.captureScreenshot' | 'browsingContext.close' | 'browsingContext.create' | 'browsingContext.getTree' | 'browsingContext.handleUserPrompt' | 'browsingContext.navigate' | 'browsingContext.reload' | 'browsingContext.contextCreated' | 'browsingContext.contextDestroyed' | 'browsingContext.navigationStarted' | 'browsingContext.fragmentNavigated' | 'browsingContext.domContentLoaded' | 'browsingContext.load' | 'browsingContext.downloadWillBegin' | 'browsingContext.navigationAborted' | 'browsingContext.navigationFailed' | 'browsingContext.userPromptClosed' | 'browsingContext.userPromptOpened' | 'script.disown' | 'script.callFunction' | 'script.evaluate' | 'script.getRealms' | 'script.realmCreated' | 'script.realmDestoyed' | 'log.entryAdded');
 export interface BidiRequest {
     method: SupportedMethods;

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,uBAAuB;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAGD,MAAM,WAAW,aAAc,SAAQ,0BAA0B,CAAC,uBAAuB;CAAI;AAE7F,MAAM,WAAW,YAAa,SAAQ,uBAAuB;IACzD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,kBAAkB,GAAG,qCAAqC,CAAA;AACtE,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAA;AAEjE,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,UAAU;IACvB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAA;CACjB;AAGD,MAAM,WAAW,aAAa;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAC3D,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,QAAQ;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAA;AACvD,MAAM,WAAW,MAAM;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAA;CAC7B;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAA;AAClC,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAA;AACrD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC,CAAA;AAElF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,UAAU,EAAE,iBAAiB,EAAE,CAAA;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAA;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAChC;AAED,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,SAAS,CAAA;AACxC,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,cAAc,GAAG,aAAa,CAAA;AAEtE;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAA;AAElF,MAAM,MAAM,gBAAgB,GAAG,CAC3B,gBAAgB,GAChB,aAAa,GACb,mBAAmB,GACnB,qBAAqB,GACrB,mCAAmC,GACnC,uBAAuB,GACvB,wBAAwB,GACxB,yBAAyB,GACzB,kCAAkC,GAClC,0BAA0B,GAC1B,wBAAwB,GACxB,gCAAgC,GAChC,kCAAkC,GAClC,mCAAmC,GACnC,mCAAmC,GACnC,kCAAkC,GAClC,sBAAsB,GACtB,mCAAmC,GACnC,mCAAmC,GACnC,kCAAkC,GAClC,kCAAkC,GAClC,kCAAkC,GAClC,eAAe,GACf,qBAAqB,GACrB,iBAAiB,GACjB,kBAAkB,GAClB,qBAAqB,GACrB,sBAAsB,GACtB,gBAAgB,CACnB,CAAA;AAED,MAAM,WAAW,WAAW;IACxB,MAAM,EAAE,gBAAgB,CAAA;IACxB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,eAAe,CAAA;AAE9C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,uBAAuB;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAGD,MAAM,WAAW,aAAc,SAAQ,uBAAuB;CAAI;AAElE,MAAM,WAAW,YAAa,SAAQ,uBAAuB;IACzD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,kBAAkB,GAAG,qCAAqC,CAAA;AACtE,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAA;AAEjE,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,UAAU;IACvB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAA;CACjB;AAGD,MAAM,WAAW,aAAa;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAC3D,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,QAAQ;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAA;AACvD,MAAM,WAAW,MAAM;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAA;CAC7B;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAA;AAClC,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAChE,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;AAEtF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,UAAU,EAAE,iBAAiB,EAAE,CAAA;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAA;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,CAAA;CACxB;AAED,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,SAAS,CAAA;AACxC,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,cAAc,GAAG,aAAa,CAAA;AAEtE;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;AAEpG,MAAM,MAAM,gBAAgB,GAAG,CAC3B,gBAAgB,GAChB,aAAa,GACb,mBAAmB,GACnB,qBAAqB,GACrB,mCAAmC,GACnC,uBAAuB,GACvB,wBAAwB,GACxB,yBAAyB,GACzB,kCAAkC,GAClC,0BAA0B,GAC1B,wBAAwB,GACxB,gCAAgC,GAChC,kCAAkC,GAClC,mCAAmC,GACnC,mCAAmC,GACnC,kCAAkC,GAClC,sBAAsB,GACtB,mCAAmC,GACnC,mCAAmC,GACnC,kCAAkC,GAClC,kCAAkC,GAClC,kCAAkC,GAClC,eAAe,GACf,qBAAqB,GACrB,iBAAiB,GACjB,kBAAkB,GAClB,qBAAqB,GACrB,sBAAsB,GACtB,gBAAgB,CACnB,CAAA;AAED,MAAM,WAAW,WAAW;IACxB,MAAM,EAAE,gBAAgB,CAAA;IACxB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,eAAe,CAAA;AAE9C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/protocols",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "description": "Utility package providing information about automation protocols",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-protocols",
@@ -24,5 +24,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a9b5954c62b7dff2af701159ff7837eb98a9b258"
+  "gitHead": "f505134606f99129c816acb00f22e39032e60820"
 }