saucelabs
Advanced tools
saucelabs - npm Package Compare versions
Comparing version 7.5.0 to 8.0.0
@@ -16,3 +16,3 @@ { | ||
| "description": "region of datacenter", | ||
| "enum": ["us-west-1", "us-east-1", "eu-central-1", "staging"] | ||
| "enum": ["us-west-1", "us-east-4", "eu-central-1", "staging"] | ||
| }, | ||
@@ -200,5 +200,5 @@ "tld": { | ||
| "buildStart": { | ||
| "description": "start", | ||
| "description": "start_time", | ||
| "in": "query", | ||
| "name": "name", | ||
| "name": "start_time", | ||
| "format": "date", | ||
@@ -209,5 +209,5 @@ "type": "string", | ||
| "buildEnd": { | ||
| "description": "end", | ||
| "description": "end_time", | ||
| "in": "query", | ||
| "name": "end", | ||
| "name": "end_time", | ||
| "format": "date", | ||
@@ -214,0 +214,0 @@ "type": "string", |
@@ -27,3 +27,3 @@ { | ||
| "description": "region of datacenter", | ||
| "enum": ["us-west-1", "us-east-1", "eu-central-1", "staging"] | ||
| "enum": ["us-west-1", "us-east-4", "eu-central-1", "staging"] | ||
| }, | ||
@@ -30,0 +30,0 @@ "tld": { |
@@ -16,3 +16,3 @@ { | ||
| "description": "region of datacenter", | ||
| "enum": ["us-west-1", "us-east-1", "eu-central-1", "staging"] | ||
| "enum": ["us-west-1", "us-east-4", "eu-central-1", "staging"] | ||
| }, | ||
@@ -19,0 +19,0 @@ "tld": { |
@@ -33,3 +33,2 @@ "use strict"; | ||
| key, | ||
| headless, | ||
| region, | ||
@@ -42,3 +41,2 @@ proxy, | ||
| key, | ||
| headless, | ||
| region, | ||
@@ -45,0 +43,0 @@ proxy, |
@@ -22,3 +22,2 @@ "use strict"; | ||
| key, | ||
| headless, | ||
| region, | ||
@@ -30,3 +29,2 @@ proxy | ||
| key, | ||
| headless, | ||
| region, | ||
@@ -33,0 +31,0 @@ proxy |
@@ -29,3 +29,3 @@ "use strict"; | ||
| const SAUCE_VERSION_NOTE = exports.SAUCE_VERSION_NOTE = `node-saucelabs v${_package.version}\nSauce Connect v${DEFAULT_SAUCE_CONNECT_VERSION}`; | ||
| const protocols = [require('../apis/sauce.json'), require('../apis/rdc.json'), require('../apis/performance.json'), require('../apis/testcomposer.json'), require('../apis/datastore.json'), require('../apis/autonomiq.json'), require('../apis/teamManagement.json'), require('../apis/builds.json'), require('../apis/testruns.json')]; | ||
| const protocols = [require('../apis/sauce.json'), require('../apis/performance.json'), require('../apis/testcomposer.json'), require('../apis/datastore.json'), require('../apis/autonomiq.json'), require('../apis/teamManagement.json'), require('../apis/builds.json'), require('../apis/testruns.json')]; | ||
| const protocolFlattened = new Map(); | ||
@@ -75,3 +75,2 @@ const parametersFlattened = new Map(); | ||
| key: process.env.SAUCE_ACCESS_KEY, | ||
| headless: false, | ||
| region: 'us', | ||
@@ -87,3 +86,3 @@ proxy: process.env.HTTPS_PROXY || process.env.HTTP_PROXY, | ||
| 'us-west-1': '', | ||
| 'us-east-1': 'us-east-1.', | ||
| 'us-east-4': 'us-east-4.', | ||
| 'eu-central-1': 'eu-central-1.', | ||
@@ -118,7 +117,2 @@ staging: 'staging.' | ||
| }, { | ||
| name: 'headless', | ||
| default: DEFAULT_OPTIONS.headless, | ||
| description: 'if set to true you are accessing the headless Sauce instances (this discards the `region` option)', | ||
| boolean: true | ||
| }, { | ||
| alias: 'p', | ||
@@ -125,0 +119,0 @@ name: 'proxy', |
@@ -49,3 +49,2 @@ "use strict"; | ||
| this.tld = this._options.tld; | ||
| this.headless = this._options.headless; | ||
| this.webdriverEndpoint = `https://ondemand.${(0, _utils.getRegionSubDomain)(options)}.saucelabs.com/`; | ||
@@ -56,3 +55,2 @@ return new Proxy({ | ||
| region: this._options.region, | ||
| headless: this._options.headless, | ||
| proxy: this._options.proxy, | ||
@@ -59,0 +57,0 @@ webdriverEndpoint: this.webdriverEndpoint, |
@@ -97,7 +97,6 @@ "use strict"; | ||
| const extractedDir = compressedFilePath.replace('.tar.gz', ''); | ||
| _promises.default.rename(extractedDir, this.destSC).then(() => { | ||
| return _promises.default.rename(extractedDir, this.destSC).then(() => { | ||
| // ensure the sc executable is actually executable | ||
| return _promises.default.chmod(this.path, 0o755); | ||
| }); | ||
| // renameSync(extractedDir, this.destSC); | ||
| }); | ||
@@ -104,0 +103,0 @@ } else { |
@@ -51,3 +51,2 @@ "use strict"; | ||
| if (options.region === 'eu') region = 'eu-central-1'; | ||
| if (options.headless) region = 'us-east-1'; | ||
| return region; | ||
@@ -61,3 +60,3 @@ } | ||
| * @param {object} options client options | ||
| * @return {string} endpoint base url (e.g. `https://us-east1.headless.saucelabs.com`) | ||
| * @return {string} endpoint base url (e.g. `https://api.us-west-1.saucelabs.com`) | ||
| */ | ||
@@ -95,9 +94,6 @@ function getAPIHost(servers, basePath, options) { | ||
| * https://assets.eu-central-1.saucelabs.com/jobs/<jobId>/log.json | ||
| * https://assets.us-east-1.saucelabs.com/jobs/<jobId>/log.json | ||
| * https://assets.us-east-4.saucelabs.com/jobs/<jobId>/log.json | ||
| * https://assets.staging.saucelabs.net/jobs/<jobId>/log.json | ||
| */ | ||
| function getAssetHost(options) { | ||
| if (options.headless) { | ||
| options.region = 'us-east-1'; | ||
| } | ||
| if (options.region === 'staging') { | ||
@@ -121,3 +117,2 @@ options.tld = options.tld || 'net'; | ||
| region: '${scope._options.region}', | ||
| headless: ${scope._options.headless}, | ||
| proxy: ${scope._options.proxy} | ||
@@ -124,0 +119,0 @@ }`; |
@@ -23,3 +23,2 @@ "use strict"; | ||
| key, | ||
| headless, | ||
| region, | ||
@@ -31,3 +30,2 @@ proxy | ||
| key, | ||
| headless, | ||
| region, | ||
@@ -39,2 +37,2 @@ proxy | ||
| exports.handler = handler; | ||
| //# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJfIiwiX2ludGVyb3BSZXF1aXJlRGVmYXVsdCIsInJlcXVpcmUiLCJfY29uc3RhbnRzIiwib2JqIiwiX19lc01vZHVsZSIsImRlZmF1bHQiLCJjb21tYW5kIiwiZXhwb3J0cyIsImRlc2NyaWJlIiwiYnVpbGRlciIsInlhcmdzIiwib3B0aW9uIiwiU0FVQ0VfQ09OTkVDVF9DTElfUEFSQU1TIiwibmFtZSIsImhhbmRsZXIiLCJhcmd2IiwidXNlciIsImtleSIsImhlYWRsZXNzIiwicmVnaW9uIiwicHJveHkiLCJPYmplY3QiLCJhc3NpZ24iLCJERUZBVUxUX09QVElPTlMiLCJhcGkiLCJTYXVjZUxhYnMiLCJzdGFydFNhdWNlQ29ubmVjdCJdLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb21tYW5kcy9zYy5qcyJdLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgU2F1Y2VMYWJzIGZyb20gJy4vLi4nO1xuaW1wb3J0IHtERUZBVUxUX09QVElPTlMsIFNBVUNFX0NPTk5FQ1RfQ0xJX1BBUkFNU30gZnJvbSAnLi4vY29uc3RhbnRzJztcblxuZXhwb3J0IGNvbnN0IGNvbW1hbmQgPSAnc2MgW2ZsYWdzXSc7XG5leHBvcnQgY29uc3QgZGVzY3JpYmUgPSAnU2F1Y2UgQ29ubmVjdCBpbnRlcmZhY2UnO1xuZXhwb3J0IGNvbnN0IGJ1aWxkZXIgPSAoeWFyZ3MpID0+IHtcbiAgZm9yIChjb25zdCBvcHRpb24gb2YgU0FVQ0VfQ09OTkVDVF9DTElfUEFSQU1TKSB7XG4gICAgeWFyZ3Mub3B0aW9uKG9wdGlvbi5uYW1lLCBvcHRpb24pO1xuICB9XG59O1xuZXhwb3J0IGNvbnN0IGhhbmRsZXIgPSBhc3luYyAoYXJndikgPT4ge1xuICBjb25zdCB7dXNlciwga2V5LCBoZWFkbGVzcywgcmVnaW9uLCBwcm94eX0gPSBPYmplY3QuYXNzaWduKFxuICAgIHt9LFxuICAgIERFRkFVTFRfT1BUSU9OUyxcbiAgICBhcmd2XG4gICk7XG4gIGNvbnN0IGFwaSA9IG5ldyBTYXVjZUxhYnMoe3VzZXIsIGtleSwgaGVhZGxlc3MsIHJlZ2lvbiwgcHJveHl9KTtcbiAgcmV0dXJuIGFwaS5zdGFydFNhdWNlQ29ubmVjdChhcmd2LCB0cnVlKTtcbn07XG4iXSwibWFwcGluZ3MiOiI7Ozs7Ozs7QUFBQSxJQUFBQSxDQUFBLEdBQUFDLHNCQUFBLENBQUFDLE9BQUE7QUFDQSxJQUFBQyxVQUFBLEdBQUFELE9BQUE7QUFBdUUsU0FBQUQsdUJBQUFHLEdBQUEsV0FBQUEsR0FBQSxJQUFBQSxHQUFBLENBQUFDLFVBQUEsR0FBQUQsR0FBQSxLQUFBRSxPQUFBLEVBQUFGLEdBQUE7QUFFaEUsTUFBTUcsT0FBTyxHQUFBQyxPQUFBLENBQUFELE9BQUEsR0FBRyxZQUFZO0FBQzVCLE1BQU1FLFFBQVEsR0FBQUQsT0FBQSxDQUFBQyxRQUFBLEdBQUcseUJBQXlCO0FBQzFDLE1BQU1DLE9BQU8sR0FBSUMsS0FBSyxJQUFLO0VBQ2hDLEtBQUssTUFBTUMsTUFBTSxJQUFJQyxtQ0FBd0IsRUFBRTtJQUM3Q0YsS0FBSyxDQUFDQyxNQUFNLENBQUNBLE1BQU0sQ0FBQ0UsSUFBSSxFQUFFRixNQUFNLENBQUM7RUFDbkM7QUFDRixDQUFDO0FBQUNKLE9BQUEsQ0FBQUUsT0FBQSxHQUFBQSxPQUFBO0FBQ0ssTUFBTUssT0FBTyxHQUFHLE1BQU9DLElBQUksSUFBSztFQUNyQyxNQUFNO0lBQUNDLElBQUk7SUFBRUMsR0FBRztJQUFFQyxRQUFRO0lBQUVDLE1BQU07SUFBRUM7RUFBSyxDQUFDLEdBQUdDLE1BQU0sQ0FBQ0MsTUFBTSxDQUN4RCxDQUFDLENBQUMsRUFDRkMsMEJBQWUsRUFDZlIsSUFDRixDQUFDO0VBQ0QsTUFBTVMsR0FBRyxHQUFHLElBQUlDLFNBQVMsQ0FBQztJQUFDVCxJQUFJO0lBQUVDLEdBQUc7SUFBRUMsUUFBUTtJQUFFQyxNQUFNO0lBQUVDO0VBQUssQ0FBQyxDQUFDO0VBQy9ELE9BQU9JLEdBQUcsQ0FBQ0UsaUJBQWlCLENBQUNYLElBQUksRUFBRSxJQUFJLENBQUM7QUFDMUMsQ0FBQztBQUFDUixPQUFBLENBQUFPLE9BQUEsR0FBQUEsT0FBQSJ9 | ||
| //# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJfIiwiX2ludGVyb3BSZXF1aXJlRGVmYXVsdCIsInJlcXVpcmUiLCJfY29uc3RhbnRzIiwib2JqIiwiX19lc01vZHVsZSIsImRlZmF1bHQiLCJjb21tYW5kIiwiZXhwb3J0cyIsImRlc2NyaWJlIiwiYnVpbGRlciIsInlhcmdzIiwib3B0aW9uIiwiU0FVQ0VfQ09OTkVDVF9DTElfUEFSQU1TIiwibmFtZSIsImhhbmRsZXIiLCJhcmd2IiwidXNlciIsImtleSIsInJlZ2lvbiIsInByb3h5IiwiT2JqZWN0IiwiYXNzaWduIiwiREVGQVVMVF9PUFRJT05TIiwiYXBpIiwiU2F1Y2VMYWJzIiwic3RhcnRTYXVjZUNvbm5lY3QiXSwic291cmNlcyI6WyIuLi8uLi9zcmMvY29tbWFuZHMvc2MuanMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IFNhdWNlTGFicyBmcm9tICcuLy4uJztcbmltcG9ydCB7REVGQVVMVF9PUFRJT05TLCBTQVVDRV9DT05ORUNUX0NMSV9QQVJBTVN9IGZyb20gJy4uL2NvbnN0YW50cyc7XG5cbmV4cG9ydCBjb25zdCBjb21tYW5kID0gJ3NjIFtmbGFnc10nO1xuZXhwb3J0IGNvbnN0IGRlc2NyaWJlID0gJ1NhdWNlIENvbm5lY3QgaW50ZXJmYWNlJztcbmV4cG9ydCBjb25zdCBidWlsZGVyID0gKHlhcmdzKSA9PiB7XG4gIGZvciAoY29uc3Qgb3B0aW9uIG9mIFNBVUNFX0NPTk5FQ1RfQ0xJX1BBUkFNUykge1xuICAgIHlhcmdzLm9wdGlvbihvcHRpb24ubmFtZSwgb3B0aW9uKTtcbiAgfVxufTtcbmV4cG9ydCBjb25zdCBoYW5kbGVyID0gYXN5bmMgKGFyZ3YpID0+IHtcbiAgY29uc3Qge3VzZXIsIGtleSwgcmVnaW9uLCBwcm94eX0gPSBPYmplY3QuYXNzaWduKHt9LCBERUZBVUxUX09QVElPTlMsIGFyZ3YpO1xuICBjb25zdCBhcGkgPSBuZXcgU2F1Y2VMYWJzKHt1c2VyLCBrZXksIHJlZ2lvbiwgcHJveHl9KTtcbiAgcmV0dXJuIGFwaS5zdGFydFNhdWNlQ29ubmVjdChhcmd2LCB0cnVlKTtcbn07XG4iXSwibWFwcGluZ3MiOiI7Ozs7Ozs7QUFBQSxJQUFBQSxDQUFBLEdBQUFDLHNCQUFBLENBQUFDLE9BQUE7QUFDQSxJQUFBQyxVQUFBLEdBQUFELE9BQUE7QUFBdUUsU0FBQUQsdUJBQUFHLEdBQUEsV0FBQUEsR0FBQSxJQUFBQSxHQUFBLENBQUFDLFVBQUEsR0FBQUQsR0FBQSxLQUFBRSxPQUFBLEVBQUFGLEdBQUE7QUFFaEUsTUFBTUcsT0FBTyxHQUFBQyxPQUFBLENBQUFELE9BQUEsR0FBRyxZQUFZO0FBQzVCLE1BQU1FLFFBQVEsR0FBQUQsT0FBQSxDQUFBQyxRQUFBLEdBQUcseUJBQXlCO0FBQzFDLE1BQU1DLE9BQU8sR0FBSUMsS0FBSyxJQUFLO0VBQ2hDLEtBQUssTUFBTUMsTUFBTSxJQUFJQyxtQ0FBd0IsRUFBRTtJQUM3Q0YsS0FBSyxDQUFDQyxNQUFNLENBQUNBLE1BQU0sQ0FBQ0UsSUFBSSxFQUFFRixNQUFNLENBQUM7RUFDbkM7QUFDRixDQUFDO0FBQUNKLE9BQUEsQ0FBQUUsT0FBQSxHQUFBQSxPQUFBO0FBQ0ssTUFBTUssT0FBTyxHQUFHLE1BQU9DLElBQUksSUFBSztFQUNyQyxNQUFNO0lBQUNDLElBQUk7SUFBRUMsR0FBRztJQUFFQyxNQUFNO0lBQUVDO0VBQUssQ0FBQyxHQUFHQyxNQUFNLENBQUNDLE1BQU0sQ0FBQyxDQUFDLENBQUMsRUFBRUMsMEJBQWUsRUFBRVAsSUFBSSxDQUFDO0VBQzNFLE1BQU1RLEdBQUcsR0FBRyxJQUFJQyxTQUFTLENBQUM7SUFBQ1IsSUFBSTtJQUFFQyxHQUFHO0lBQUVDLE1BQU07SUFBRUM7RUFBSyxDQUFDLENBQUM7RUFDckQsT0FBT0ksR0FBRyxDQUFDRSxpQkFBaUIsQ0FBQ1YsSUFBSSxFQUFFLElBQUksQ0FBQztBQUMxQyxDQUFDO0FBQUNSLE9BQUEsQ0FBQU8sT0FBQSxHQUFBQSxPQUFBIn0= |
@@ -270,299 +270,2 @@ # SauceLabs Interface | ||
| <td> | ||
| <b>PUT</b> <code>/v1/appium/session/{sessionId}/skiptest</code><br> | ||
| Report the result of a test as skipped. | ||
| <h3>Example:</h3> | ||
| <code>api.markTestAsSkippedDeprecated(sessionId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PUT</b> <code>/v1/appium/session/{sessionId}/test</code><br> | ||
| Report the result of a test. | ||
| <h3>Example:</h3> | ||
| <code>api.updateTestDeprecated(sessionId, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PUT</b> <code>/v1/appium/suites/{batchId}</code><br> | ||
| Updates the properties of a suite. | ||
| <h3>Example:</h3> | ||
| <code>api.updateSuiteDeprecated(suiteId, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v1/appium/suites/{batchId}/deviceIds</code><br> | ||
| Returns the IDs of the devices which you had selected for the specified suite. | ||
| <h3>Example:</h3> | ||
| <code>api.readDeviceIdsDeprecated(suiteId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>POST</b> <code>/v1/appium/suites/{batchId}/reports/start</code><br> | ||
| Start a new suite execution including its test executions. | ||
| <h3>Example:</h3> | ||
| <code>api.startSuiteDeprecated(suiteId, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>appId</b>: The ID of the app version you wish to test</li> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PUT</b> <code>/v1/appium/suites/{batchId}/reports/{batchReportId}/finish</code><br> | ||
| Marks all test executions contained in the specified suite execution as finished. | ||
| <h3>Example:</h3> | ||
| <code>api.finishSuiteDeprecated(suiteId, batchReportId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PUT</b> <code>/v1/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/finish</code><br> | ||
| Sets the status of the specific test execution and marks it as finished. | ||
| <h3>Example:</h3> | ||
| <code>api.finishTestReportDeprecated(suiteId, suiteReportId, testReportId, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PUT</b> <code>/v1/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/skip</code><br> | ||
| Mark test execution as skipped | ||
| <h3>Example:</h3> | ||
| <code>api.skipTestReportDeprecated(suiteId, suiteReportId, testReportId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v1/devices</code><br> | ||
| Returns a list containing all devices, including those not currently available for testing | ||
| <h3>Example:</h3> | ||
| <code>api.getDescriptorsDeprecated()</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v1/devices/all</code><br> | ||
| Returns a list containing all devices, including those not currently unavailable for testing. | ||
| This endpoint requires API Key authentication and will also return your private devices. | ||
| <h3>Example:</h3> | ||
| <code>api.getDescriptorsApiDeprecated()</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v1/devices/all/available</code><br> | ||
| Returns a list containing the IDs of all devices currently available for testing. | ||
| This endpoint requires API Key authentication and will also return your private devices. | ||
| <h3>Example:</h3> | ||
| <code>api.getAvailableDescriptorIdsApiDeprecated()</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v1/devices/available</code><br> | ||
| Returns a list containing the IDs of all devices currently available for testing | ||
| <h3>Example:</h3> | ||
| <code>api.getAvailableDescriptorIdsDeprecated()</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v1/devices/reports</code><br> | ||
| The session history reports provide information about user sessions. This includes device usage and test reports. By default reports of the last 30 days will be retrieved - limited to a maximum of 50 reports. | ||
| If the authenticated user is the owner of the account, session reports of the entire team will be retrieved. Team members can only retrieve their own session history. This endpoint requires Password authentication. | ||
| <h3>Example:</h3> | ||
| <code>api.getSessionReports({ ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>userId</b>: Your username.</li> <li><b>lastDays</b>: Number of days to report</li> <li><b>offset</b>: Offset for pagination</li> <li><b>limit</b>: Max number of results per page</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v1/devices/{deviceDescriptorId}</code><br> | ||
| Returns information for a particular device. | ||
| This endpoint requires API Key authentication. | ||
| <h3>Example:</h3> | ||
| <code>api.getDescriptorDeprecated(deviceId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v1/devices/{deviceDescriptorId}/status</code><br> | ||
| Returns a list containing device status infos for all device instances with the specified device ID on all pools. | ||
| This endpoint requires API Key authentication and will also return your private devices. | ||
| <h3>Example:</h3> | ||
| <code>api.getDeviceStatusInfosDeprecated(deviceId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PUT</b> <code>/v2/appium/session/{sessionId}/skiptest</code><br> | ||
| Report the result of a test as skipped. | ||
| <h3>Example:</h3> | ||
| <code>api.markTestAsSkipped(sessionId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PUT</b> <code>/v2/appium/session/{sessionId}/test</code><br> | ||
| Report the result of a test. | ||
| <h3>Example:</h3> | ||
| <code>api.updateTest(sessionId, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PUT</b> <code>/v2/appium/suites/{batchId}</code><br> | ||
| Updates the properties of a suite. | ||
| <h3>Example:</h3> | ||
| <code>api.updateSuite(suiteId, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/appium/suites/{batchId}/deviceIds</code><br> | ||
| Returns the IDs of the devices which you had selected for the specified suite. | ||
| <h3>Example:</h3> | ||
| <code>api.readDeviceIds(suiteId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>POST</b> <code>/v2/appium/suites/{batchId}/reports/start</code><br> | ||
| Start a new suite execution including its test executions. | ||
| <h3>Example:</h3> | ||
| <code>api.startSuite(suiteId, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>appId</b>: The ID of the app version you wish to test</li> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PUT</b> <code>/v2/appium/suites/{batchId}/reports/{batchReportId}/finish</code><br> | ||
| Marks all test executions contained in the specified suite execution as finished. | ||
| <h3>Example:</h3> | ||
| <code>api.finishSuite(suiteId, batchReportId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PUT</b> <code>/v2/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/finish</code><br> | ||
| Sets the status of the specific test execution and marks it as finished. | ||
| <h3>Example:</h3> | ||
| <code>api.finishTestReport(suiteId, suiteReportId, testReportId, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>PUT</b> <code>/v2/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/skip</code><br> | ||
| Mark test execution as skipped | ||
| <h3>Example:</h3> | ||
| <code>api.skipTestReport(suiteId, suiteReportId, testReportId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/batchReports/{batchReportId}</code><br> | ||
| Returns the test report of a suite | ||
| <h3>Example:</h3> | ||
| <code>api.readBatchReport({ ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>body</b>: No description available.</li> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/batchReports/{batchReportId}/xml</code><br> | ||
| Returns the test report of a suite as XML | ||
| <h3>Example:</h3> | ||
| <code>api.junitStyleXmlReport({ ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>body</b>: No description available.</li> <li><b>body</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/devices</code><br> | ||
| Returns a list per data center containing all devices, including private devices and those not currently available for testing. This endpoint requires API Key authentication. | ||
| <h3>Example:</h3> | ||
| <code>api.getDescriptors()</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/devices/available</code><br> | ||
| Returns a list per data center containing the IDs of all devices currently available for testing, including private devices. This endpoint requires API Key authentication. | ||
| <h3>Example:</h3> | ||
| <code>api.getAvailableDescriptorIds()</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/devices/{deviceDescriptorId}</code><br> | ||
| Returns information for a particular device per data center. This endpoint requires API Key authentication. | ||
| <h3>Example:</h3> | ||
| <code>api.getDescriptor(deviceId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/logs/{testReportId}/appium</code><br> | ||
| Returns Appium log for the specified test report | ||
| <h3>Example:</h3> | ||
| <code>api.readAppiumLog(testReportId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/logs/{testReportId}/device</code><br> | ||
| Returns device log for the specified test report | ||
| <h3>Example:</h3> | ||
| <code>api.readDeviceLog(testReportId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/logs/{testReportId}/vitals</code><br> | ||
| Returns device vitals of a test session after completion | ||
| <h3>Example:</h3> | ||
| <code>api.readVitalsLog(testReportId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/logs/{testReportId}/xcuitest</code><br> | ||
| Returns XCUITest log for the specified test report | ||
| <h3>Example:</h3> | ||
| <code>api.readXcuiTestLog(testReportId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/reports/{testReportId}</code><br> | ||
| Returns test report and artifacts for a test session after completion | ||
| <h3>Example:</h3> | ||
| <code>api.readReport(testReportId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/screenshots/{testReportId}/{screenshotId}.png</code><br> | ||
| Returns a PNG screenshot from a test | ||
| <h3>Example:</h3> | ||
| <code>api.getScreenshot(testReportId, screenshotId)</code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/v2/video/{videoId}.mp4</code><br> | ||
| Returns screen recording of a test session after completion | ||
| <h3>Example:</h3> | ||
| <code>api.getScreenRecording(videoId, { ...options })</code> | ||
| <br><h4>Options</h4> | ||
| <ul> <li><b>Range</b>: No description available.</li> </ul> </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <b>GET</b> <code>/metrics/</code><br> | ||
@@ -569,0 +272,0 @@ Provides a list of paginated raw performance metrics for the logged user |
| { | ||
| "name": "saucelabs", | ||
| "version": "7.5.0", | ||
| "version": "8.0.0", | ||
| "author": "Sauce Labs, Inc.", | ||
@@ -5,0 +5,0 @@ "description": "A wrapper around Sauce Labs REST API", |
@@ -36,2 +36,3 @@ # Node Sauce Labs [](https://github.com/saucelabs/node-saucelabs/actions/workflows/test.yml) | ||
| - `eu-central-1` (short `eu`) | ||
| - `us-east-4` (real mobile devices only) | ||
@@ -38,0 +39,0 @@ Type: `string` |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis 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
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of lines in readme file
- increased by0.43%
236
Worsened metrics
- Total package byte prevSize
- decreased by-0.3%
51340103
- Number of package files
- decreased by-2.44%
40
- Lines of code
- decreased by-31.02%
10951
No dependency changes