@wdio/protocols 9.0.0-alpha.78 → 9.0.0

package/build/protocols/mjsonwp.js

@@ -1,91 +0,0 @@
-export default {
-    '/session/:sessionId/element/:elementId/pageIndex': {
-        GET: {
-            command: 'getPageIndex',
-            ref: 'https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#mobile-json-wire-protocol-endpoints',
-            deprecated: 'In Appium 2.0, this method is marked as deprecated and currently has no available alternatives.',
-            parameters: [],
-            returns: {
-                type: 'string',
-                name: 'pageIndex',
-            },
-        },
-    },
-    '/session/:sessionId/network_connection': {
-        GET: {
-            command: 'getNetworkConnection',
-            ref: 'https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes',
-            parameters: [],
-            returns: {
-                type: 'number',
-                name: 'connectionType',
-                description: 'see https://appium.github.io/appium.io/docs/en/writing-running-appium/other/network-connection/',
-            },
-        },
-        POST: {
-            command: 'setNetworkConnection',
-            ref: 'https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes',
-            parameters: [
-                {
-                    name: 'type',
-                    type: 'number',
-                    description: 'a bit mask that should be translated to an integer value when serialized',
-                    required: true,
-                },
-            ],
-        },
-    },
-    '/session/:sessionId/touch/perform': {
-        GET: {
-            command: 'touchPerform',
-            ref: 'https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#touch-gestures',
-            parameters: [
-                {
-                    name: 'actions',
-                    type: 'object[]',
-                    description: 'a list of objects, each of which represents an input source and its associated actions',
-                    required: true,
-                },
-            ],
-        },
-    },
-    '/session/:sessionId/touch/multi/perform': {
-        GET: {
-            command: 'multiTouchPerform',
-            ref: 'https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#touch-gestures',
-            parameters: [
-                {
-                    name: 'actions',
-                    type: 'object[]',
-                    description: 'a list of objects, each of which represents an input source and its associated actions',
-                    required: true,
-                },
-                {
-                    name: 'elementId',
-                    type: 'object[]',
-                    description: 'the id of an element returned in a previous call to Find Element(s)',
-                },
-            ],
-        },
-    },
-    '/session/:sessionId/receive_async_response': {
-        POST: {
-            command: 'receiveAsyncResponse',
-            ref: 'https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#mobile-json-wire-protocol-endpoints',
-            parameters: [
-                {
-                    name: 'status',
-                    type: 'string',
-                    description: 'the expected status of the response',
-                    required: true,
-                },
-                {
-                    name: 'value',
-                    type: 'string',
-                    description: 'the expected value of the response',
-                    required: true,
-                },
-            ],
-        },
-    },
-};

package/build/protocols/saucelabs.js

@@ -1,297 +0,0 @@
-export default {
-    '/session/:sessionId/sauce/ondemand/log': {
-        POST: {
-            command: 'getPageLogs',
-            description: 'Get webpage specific log information based on the last page load.',
-            ref: 'https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ExtendedDebuggingTools',
-            examples: [
-                [
-                    '// Get Network Logs',
-                    "console.log(browser.getPageLogs('sauce:network'));",
-                    '/**',
-                    ' * outputs:',
-                    ' * [{',
-                    ' *   "url": "https://app.saucelabs.com/dashboard",',
-                    ' *   "statusCode": 200,',
-                    ' *   "method": "GET",',
-                    ' *   "requestHeaders": {',
-                    ' *     ...',
-                    ' *   },',
-                    ' *   "responseHeaders": {',
-                    ' *     ...',
-                    ' *   },',
-                    ' *   "timing": {',
-                    ' *     ...',
-                    ' *   }',
-                    ' * }, {,',
-                    ' *   ...',
-                    ' * }]',
-                    ' */',
-                ],
-                [
-                    '// Get Performance Logs (needs capturePerformance capability see: https://wiki.saucelabs.com/display/DOCS/Measure+Page+Load+Performance+Using+Test+Automation#MeasurePageLoadPerformanceUsingTestAutomation-EnableYourScript)',
-                    "console.log(browser.getPageLogs('sauce:performance'));",
-                    '/**',
-                    ' * outputs:',
-                    ' * {',
-                    ' *   "speedIndex": 1472.023,',
-                    ' *   "timeToFirstInteractive": 1243.214,',
-                    ' *   "firstMeaningfulPaint": 892.643,',
-                    ' *   ...',
-                    ' * }',
-                    ' */',
-                ],
-            ],
-            parameters: [
-                {
-                    name: 'type',
-                    type: 'string',
-                    description: "log type (e.g. sauce:network', 'sauce:performance')",
-                    required: true,
-                },
-            ],
-            returns: {
-                type: 'object',
-                name: 'log',
-                description: 'log output of desired type (see example)',
-            },
-        },
-    },
-    '/session/:sessionId/sauce/ondemand/throttle/network': {
-        POST: {
-            command: 'sauceThrottleNetwork',
-            description: 'With network conditioning you can test your site on a variety of network connections, including Edge, 3G, and even offline. You can throttle the data throughput, including the maximum download and upload throughput, and use latency manipulation to enforce a minimum delay in connection round-trip time (RTT).',
-            ref: 'https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ThrottleNetworkCapabilities',
-            examples: [
-                [
-                    '// predefined network condition',
-                    "browser.sauceThrottleNetwork('offline')",
-                ],
-                [
-                    '// custom network condition',
-                    'browser.sauceThrottleNetwork({',
-                    '  download: 1000,',
-                    '  upload: 500,',
-                    "  latency: 40'",
-                    '})',
-                ],
-            ],
-            parameters: [
-                {
-                    name: 'condition',
-                    type: '(string|object)',
-                    description: "network condition to set (e.g. 'online', 'offline', 'GPRS', 'Regular 2G', 'Good 2G', 'Regular 3G', 'Good 3G', 'Regular 4G', 'DSL', 'Wifi')",
-                    required: true,
-                },
-            ],
-        },
-    },
-    '/session/:sessionId/sauce/ondemand/throttle/cpu': {
-        POST: {
-            command: 'throttleCPU',
-            description: 'You can throttle the CPU in DevTools to understand how your page performs under that constraint.',
-            ref: 'https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-ThrottleCPUCapabilities',
-            examples: [
-                [
-                    '// throttle CPU and make it run 4x slower',
-                    'browser.throttleCPU(4)',
-                ],
-                ['// reset CPU throttling', 'browser.throttleCPU(0)'],
-            ],
-            parameters: [
-                {
-                    name: 'rate',
-                    type: 'number',
-                    description: 'Rate on how much the CPU should get throttled.',
-                    required: true,
-                },
-            ],
-        },
-    },
-    '/session/:sessionId/sauce/ondemand/intercept': {
-        POST: {
-            command: 'interceptRequest',
-            description: 'Allows modifying any request made by the browser. You can blacklist, modify, or redirect these as required for your tests.',
-            ref: 'https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands#CustomSauceLabsWebDriverExtensionsforNetworkandLogCommands-InterceptNetworkRequests',
-            examples: [
-                [
-                    '// redirect a request',
-                    'browser.interceptRequest({',
-                    "  url: 'https://saucelabs.com',",
-                    "  redirect: 'https://google.com'",
-                    '})',
-                ],
-                [
-                    '// Blacklist requests to 3rd party vendors',
-                    'browser.interceptRequest({',
-                    "  url: 'https://api.segment.io/v1/p',",
-                    "  error: 'Failed'",
-                    '})',
-                ],
-                [
-                    '// Modify requests to REST API (Mock REST API response)',
-                    'browser.interceptRequest({',
-                    "  url: 'http://sampleapp.appspot.com/api/todos',",
-                    '  response: {',
-                    '    headers: {',
-                    "      'x-custom-headers': 'foobar'",
-                    '    },',
-                    '    body: [{',
-                    "      title: 'My custom todo',",
-                    '      order: 1,',
-                    '      completed: false,',
-                    "      url: 'http://todo-backend-express.herokuapp.com/15727'",
-                    '    }]',
-                    '  }',
-                    '})',
-                ],
-            ],
-            parameters: [
-                {
-                    name: 'rule',
-                    type: 'object',
-                    description: 'A rule describing the request interception.',
-                    required: true,
-                },
-            ],
-        },
-    },
-    '/session/:sessionId/sauce/ondemand/performance': {
-        POST: {
-            command: 'assertPerformance',
-            description: 'Assert against the performance baseline of your app.',
-            ref: 'https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands',
-            examples: [
-                [
-                    '// test performance for a page',
-                    "browser.url('https://webdriver.io')",
-                    'const hasRegression = browser.assertPerformance({',
-                    "  name: 'my performance test', // make sure that the name is also set in the sauce options in your capabilities",
-                    "  metrics: ['score', 'firstPaint']",
-                    '})',
-                ],
-            ],
-            parameters: [
-                {
-                    name: 'name',
-                    type: 'string',
-                    description: 'Name of the job you created your baseline with.',
-                    required: true,
-                },
-                {
-                    name: 'metrics',
-                    type: 'string[]',
-                    description: 'Name of metrics you want to assert agains the baseline.',
-                    required: false,
-                },
-            ],
-            returns: {
-                type: 'object',
-                name: 'hasRegression',
-                description: 'An object containing the result as well as metrics about the result.',
-            },
-        },
-    },
-    '/session/:sessionId/sauce/ondemand/performance/scroll': {
-        POST: {
-            command: 'jankinessCheck',
-            description: 'Perform a scroll test that evaluates the jankiness of the application.',
-            ref: 'https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands',
-            examples: [
-                [
-                    '// test performance for a page',
-                    "browser.url('https://webdriver.io')",
-                    'browser.jankinessCheck()',
-                ],
-            ],
-            parameters: [],
-            returns: {
-                type: 'object',
-                name: 'testResults',
-                description: 'An object containing the score as well as metrics around how smooth the UX of the page was during the test.',
-            },
-        },
-    },
-    '/session/:sessionId/sauce/ondemand/mock': {
-        POST: {
-            command: 'mockRequest',
-            description: 'Mocks a network resource.',
-            ref: 'https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands',
-            parameters: [
-                {
-                    name: 'url',
-                    type: 'string',
-                    description: 'URL glob to match url to mock.',
-                    required: true,
-                },
-                {
-                    name: 'filterOptions',
-                    description: 'Additional filter options for url to mock (e.g. headers, method).',
-                    type: 'object',
-                    required: false,
-                },
-            ],
-            returns: {
-                type: 'object',
-                name: 'mockId',
-                description: 'An object containing the id of a mock resource.',
-            },
-        },
-    },
-    '/session/:sessionId/sauce/ondemand/mock/:mockId': {
-        GET: {
-            command: 'getMockCalls',
-            description: 'Receive request information about requests that match the mocked resource.',
-            ref: 'https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands',
-            variables: [
-                {
-                    name: 'mockId',
-                    description: 'the id of a mock',
-                },
-            ],
-            parameters: [],
-            returns: {
-                type: 'object',
-                name: 'requests',
-                description: 'A list of request information.',
-            },
-        },
-        DELETE: {
-            command: 'clearMockCalls',
-            description: 'Clear list of mock calls.',
-            ref: 'https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands',
-            variables: [
-                {
-                    name: 'mockId',
-                    description: 'the id of a mock',
-                },
-            ],
-            parameters: [
-                {
-                    type: 'boolean',
-                    name: 'restore',
-                    description: 'Set to true if mock should be restored as well.',
-                    required: false,
-                },
-            ],
-        },
-        POST: {
-            command: 'respondMock',
-            description: 'Respond if mock matches a specific resource.',
-            ref: 'https://wiki.saucelabs.com/display/DOCS/Custom+Sauce+Labs+WebDriver+Extensions+for+Network+and+Log+Commands',
-            variables: [
-                {
-                    name: 'mockId',
-                    description: 'the id of a mock',
-                },
-            ],
-            parameters: [
-                {
-                    type: 'object',
-                    name: 'payload',
-                    description: 'Information on mock response.',
-                },
-            ],
-        },
-    },
-};

package/build/protocols/selenium.js

@@ -1,132 +0,0 @@
-export default {
-    '/session/:sessionId/se/file': {
-        POST: {
-            command: 'file',
-            description: 'Upload a file to remote machine on which the browser is running.',
-            ref: 'https://www.seleniumhq.org/',
-            parameters: [
-                {
-                    name: 'file',
-                    type: 'string',
-                    description: 'Base64-encoded zip archive containing __single__ file which to upload. In case base64-encoded data does not represent a zip archive or archive contains more than one file it will throw an unknown error.',
-                    required: true,
-                },
-            ],
-            returns: {
-                type: 'String',
-                name: 'path',
-                description: 'Absolute path of uploaded file on remote machine.',
-            },
-        },
-    },
-    '/grid/api/hub/': {
-        GET: {
-            isHubCommand: true,
-            command: 'getHubConfig',
-            description: 'Receive hub config remotely.',
-            ref: 'https://github.com/nicegraham/selenium-grid2-api#gridapihub',
-            parameters: [],
-            returns: {
-                type: 'Object',
-                name: 'config',
-                description: 'Returns the hub config with slotCount, timeouts and other information.',
-            },
-        },
-    },
-    '/grid/api/testsession?session=:session': {
-        GET: {
-            isHubCommand: true,
-            command: 'gridTestSession',
-            description: 'Get the details of the Selenium Grid node running a session.',
-            ref: 'https://github.com/nicegraham/selenium-grid2-api#gridapitestsession',
-            parameters: [],
-            variables: [
-                {
-                    name: 'session',
-                    description: 'The id of the session to receive hub details for.',
-                },
-            ],
-            returns: {
-                type: 'Object',
-                name: 'details',
-                description: 'Object containing information about session details.',
-            },
-        },
-    },
-    '/grid/api/proxy': {
-        GET: {
-            isHubCommand: true,
-            command: 'gridProxyDetails',
-            description: 'Get proxy details.',
-            ref: 'https://github.com/nicegraham/selenium-grid2-api#gridapiproxy',
-            parameters: [
-                {
-                    name: 'id',
-                    type: 'string',
-                    description: 'the id of the proxy (can be received using gridTestSession command).',
-                    required: true,
-                },
-            ],
-            returns: {
-                type: 'Object',
-                name: 'details',
-                description: 'Object containing information about proxy.',
-            },
-        },
-    },
-    '/lifecycle-manager?action=:action': {
-        GET: {
-            isHubCommand: true,
-            command: 'manageSeleniumHubLifecycle',
-            description: 'Manage lifecycle of hub node.',
-            ref: 'https://github.com/nicegraham/selenium-grid2-api#lifecycle-manager',
-            parameters: [],
-            variables: [
-                {
-                    name: 'action',
-                    description: "Command to call on Selenium Hub. The only implemented action is to 'shutdown' the hub.",
-                },
-            ],
-        },
-    },
-    '/graphql': {
-        POST: {
-            isHubCommand: true,
-            command: 'queryGrid',
-            description: 'Send GraphQL queries to the Selenium (hub or node) server to fetch data. (Only supported with Selenium v4 Server)',
-            ref: 'https://www.selenium.dev/documentation/grid/advanced_features/graphql_support/',
-            parameters: [
-                {
-                    name: 'query',
-                    type: 'string',
-                    description: 'A GraphQL query to be send to the server.',
-                    required: true,
-                },
-            ],
-            examples: [
-                [
-                    "const result = await browser.queryGrid('{ nodesInfo { nodes { status, uri } } }');",
-                    'console.log(JSON.stringify(result, null, 4))',
-                    '/**',
-                    ' * outputs:',
-                    ' * {',
-                    ' *   "data": {',
-                    ' *     "nodesInfo": {',
-                    ' *       "nodes": [{',
-                    ' *         "status": "UP",',
-                    ' *         "uri": "http://192.168.0.39:4444"',
-                    ' *       }]',
-                    ' *     }',
-                    ' *   }',
-                    ' * }',
-                    ' */',
-                ],
-            ],
-            returns: {
-                type: 'Object',
-                name: 'data',
-                description: 'Result of the GraphQL query.',
-            },
-        },
-    },
-};