oxygen-cli 1.40.1 → 1.40.2-beta.1

package/transpiled/mongodb/lib/write_concern.js

@@ -0,0 +1,115 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.WriteConcern = exports.WRITE_CONCERN_KEYS = void 0;
+exports.throwIfWriteConcernError = throwIfWriteConcernError;
+
+const responses_1 = require("./cmap/wire_protocol/responses");
+
+const error_1 = require("./error");
+
+exports.WRITE_CONCERN_KEYS = ['w', 'wtimeout', 'j', 'journal', 'fsync'];
+/**
+ * A MongoDB WriteConcern, which describes the level of acknowledgement
+ * requested from MongoDB for write operations.
+ * @public
+ *
+ * @see https://www.mongodb.com/docs/manual/reference/write-concern/
+ */
+
+class WriteConcern {
+  /**
+   * Constructs a WriteConcern from the write concern properties.
+   * @param w - request acknowledgment that the write operation has propagated to a specified number of mongod instances or to mongod instances with specified tags.
+   * @param wtimeoutMS - specify a time limit to prevent write operations from blocking indefinitely
+   * @param journal - request acknowledgment that the write operation has been written to the on-disk journal
+   * @param fsync - equivalent to the j option. Is deprecated and will be removed in the next major version.
+   */
+  constructor(w, wtimeoutMS, journal, fsync) {
+    if (w != null) {
+      if (!Number.isNaN(Number(w))) {
+        this.w = Number(w);
+      } else {
+        this.w = w;
+      }
+    }
+
+    if (wtimeoutMS != null) {
+      this.wtimeoutMS = this.wtimeout = wtimeoutMS;
+    }
+
+    if (journal != null) {
+      this.journal = this.j = journal;
+    }
+
+    if (fsync != null) {
+      this.journal = this.j = fsync ? true : false;
+    }
+  }
+  /**
+   * Apply a write concern to a command document. Will modify and return the command.
+   */
+
+
+  static apply(command, writeConcern) {
+    const wc = {}; // The write concern document sent to the server has w/wtimeout/j fields.
+
+    if (writeConcern.w != null) wc.w = writeConcern.w;
+    if (writeConcern.wtimeoutMS != null) wc.wtimeout = writeConcern.wtimeoutMS;
+    if (writeConcern.journal != null) wc.j = writeConcern.j;
+    command.writeConcern = wc;
+    return command;
+  }
+  /** Construct a WriteConcern given an options object. */
+
+
+  static fromOptions(options, inherit) {
+    if (options == null) return undefined;
+    inherit = inherit ?? {};
+    let opts;
+
+    if (typeof options === 'string' || typeof options === 'number') {
+      opts = {
+        w: options
+      };
+    } else if (options instanceof WriteConcern) {
+      opts = options;
+    } else {
+      opts = options.writeConcern;
+    }
+
+    const parentOpts = inherit instanceof WriteConcern ? inherit : inherit.writeConcern;
+    const {
+      w = undefined,
+      wtimeout = undefined,
+      j = undefined,
+      fsync = undefined,
+      journal = undefined,
+      wtimeoutMS = undefined
+    } = { ...parentOpts,
+      ...opts
+    };
+
+    if (w != null || wtimeout != null || wtimeoutMS != null || j != null || journal != null || fsync != null) {
+      return new WriteConcern(w, wtimeout ?? wtimeoutMS, j ?? journal, fsync);
+    }
+
+    return undefined;
+  }
+
+}
+
+exports.WriteConcern = WriteConcern;
+/** Called with either a plain object or MongoDBResponse */
+
+function throwIfWriteConcernError(response) {
+  if (typeof response === 'object' && response != null) {
+    const writeConcernError = responses_1.MongoDBResponse.is(response) && response.has('writeConcernError') ? response.toObject() : !responses_1.MongoDBResponse.is(response) && 'writeConcernError' in response ? response : null;
+
+    if (writeConcernError != null) {
+      throw new error_1.MongoWriteConcernError(writeConcernError);
+    }
+  }
+}

package/types/index.d.ts

@@ -1,71 +1,71 @@
-// Project: https://www.oxygenhq.org
-// GitHub:  https://github.com/cypress-io/cypress
-// TypeScript Version: 3.4
-
-/// <reference path="./oxygen.d.ts" />
-/// <reference path="./module-web.d.ts" />
-/// <reference path="./module-mob.d.ts" />
-/// <reference path="./module-win.d.ts" />
-/// <reference path="./module-http.d.ts" />
-/// <reference path="./module-log.d.ts" />
-/// <reference path="./module-utils.d.ts" />
-/// <reference path="./module-shell.d.ts" />
-/// <reference path="./module-proxy.d.ts" />
-/// <reference path="./module-eyes.d.ts" />
-/// <reference path="./module-pdf.d.ts" />
-export {};
-
-declare global {
-    /**
-     * Provides methods for browser automation.
-     */
-    var web: Oxygen.ModuleWeb;
-    /**
-     * Provides methods for mobile automation.
-     */
-    var mob: Oxygen.ModuleMob;
-    /**
-     * Provides methods for Microsoft Windows automation.
-     */
-    var win: Oxygen.ModuleWin;
-    /**
-     * Provides methods for printing user defined messages to test results.
-     */
-    var log: Oxygen.ModuleLog;
-    /**
-     * Provides miscellaneous utility methods.
-     */
-    var utils: Oxygen.ModuleUtils;
-    /**
-     * Provides methods for working with operating system shell.
-     */
-    var shell: Oxygen.ModuleShell;
-    /**
-     * Provides methods for intercepting network traffic via mitmproxy.
-     */
-    var proxy: Oxygen.ModuleProxy;
-    /**
-     * Provides methods to use Applitools Eyes visual testing solution.
-     */
-    var eyes: Oxygen.ModuleApplitools;
-    /**
-     * Provides generic methods for working with PDF files.
-     */
-    var pdf: Oxygen.ModulePdf;
-    /**
-     * Oxygen execution context global object.
-     */
-    var ox: Oxygen.OxGlobal;
-    /**
-     * Gets test parameters.
-     */
-    var params: { [key: string]: string };
-    /**
-     * Gets test environment variables.
-     */
-    var env: { [key: string]: string };
-    /**
-     * Runtime variables that can be added and shared between different iterations and cases execution.
-     */
-    var vars: { [key: string]: string };
+// Project: https://www.oxygenhq.org
+// GitHub:  https://github.com/cypress-io/cypress
+// TypeScript Version: 3.4
+
+/// <reference path="./oxygen.d.ts" />
+/// <reference path="./module-web.d.ts" />
+/// <reference path="./module-mob.d.ts" />
+/// <reference path="./module-win.d.ts" />
+/// <reference path="./module-http.d.ts" />
+/// <reference path="./module-log.d.ts" />
+/// <reference path="./module-utils.d.ts" />
+/// <reference path="./module-shell.d.ts" />
+/// <reference path="./module-proxy.d.ts" />
+/// <reference path="./module-eyes.d.ts" />
+/// <reference path="./module-pdf.d.ts" />
+export {};
+
+declare global {
+    /**
+     * Provides methods for browser automation.
+     */
+    var web: Oxygen.ModuleWeb;
+    /**
+     * Provides methods for mobile automation.
+     */
+    var mob: Oxygen.ModuleMob;
+    /**
+     * Provides methods for Microsoft Windows automation.
+     */
+    var win: Oxygen.ModuleWin;
+    /**
+     * Provides methods for printing user defined messages to test results.
+     */
+    var log: Oxygen.ModuleLog;
+    /**
+     * Provides miscellaneous utility methods.
+     */
+    var utils: Oxygen.ModuleUtils;
+    /**
+     * Provides methods for working with operating system shell.
+     */
+    var shell: Oxygen.ModuleShell;
+    /**
+     * Provides methods for intercepting network traffic via mitmproxy.
+     */
+    var proxy: Oxygen.ModuleProxy;
+    /**
+     * Provides methods to use Applitools Eyes visual testing solution.
+     */
+    var eyes: Oxygen.ModuleApplitools;
+    /**
+     * Provides generic methods for working with PDF files.
+     */
+    var pdf: Oxygen.ModulePdf;
+    /**
+     * Oxygen execution context global object.
+     */
+    var ox: Oxygen.OxGlobal;
+    /**
+     * Gets test parameters.
+     */
+    var params: { [key: string]: string };
+    /**
+     * Gets test environment variables.
+     */
+    var env: { [key: string]: string };
+    /**
+     * Runtime variables that can be added and shared between different iterations and cases execution.
+     */
+    var vars: { [key: string]: string };
 }

package/types/module-eyes.d.ts

@@ -1,39 +1,39 @@
-declare namespace Oxygen {
-    interface ModuleApplitools {
-        /**
-         * @summary Initializes Applitools Eyes session.
-         * @function init
-         * @param {string|object} module - A module name or a reference to the mododule to be associated with Eyes current session.
-         * @param {apiKey} [apiKey] - An optional Applitools API Key.
-         * If this parameter is not provided, API Key must be specified in the test configuration file.
-         */
-        init(module: string | object, apiKey?: any): void;
-
-        /**
-         * @summary Closes Applitools Eyes session, terminates the sequence of checkpoints, and then waits for and returns the test results.
-         * @function dispose
-         * @return {TestResult} Eyes test result.
-         */
-        dispose(): any;
-
-        /**
-         * @summary Preform visual validation for a certain target.
-         * @function check
-         * @param {string} name - A name to be associated with the match.
-         * @param {Target} [target] - An optional target instance which describes whether we want a window/region/frame.
-         * @return {boolean} A promise which is resolved when the validation is finished.
-         */
-        check(name: string, target?: any): boolean;
-
-        /**
-         * @summary Takes a snapshot of the application under test and matches it with
-         * the expected output.
-         * @function checkWindow
-         * @param {string} [name=] - An optional tag to be associated with the snapshot.
-         * @param {number} [matchTimeout=-1] - The amount of time to retry matching (Milliseconds).
-         * @return {boolean} A promise which is resolved when the validation is finished.
-         */
-        checkWindow(name?: string, matchTimeout?: number): boolean;
-
-    }
-}
+declare namespace Oxygen {
+    interface ModuleApplitools {
+        /**
+         * @summary Initializes Applitools Eyes session.
+         * @function init
+         * @param {string|object} module - A module name or a reference to the mododule to be associated with Eyes current session.
+         * @param {apiKey} [apiKey] - An optional Applitools API Key.
+         * If this parameter is not provided, API Key must be specified in the test configuration file.
+         */
+        init(module: string | object, apiKey?: any): void;
+
+        /**
+         * @summary Closes Applitools Eyes session, terminates the sequence of checkpoints, and then waits for and returns the test results.
+         * @function dispose
+         * @return {TestResult} Eyes test result.
+         */
+        dispose(): any;
+
+        /**
+         * @summary Preform visual validation for a certain target.
+         * @function check
+         * @param {string} name - A name to be associated with the match.
+         * @param {Target} [target] - An optional target instance which describes whether we want a window/region/frame.
+         * @return {boolean} A promise which is resolved when the validation is finished.
+         */
+        check(name: string, target?: any): boolean;
+
+        /**
+         * @summary Takes a snapshot of the application under test and matches it with
+         * the expected output.
+         * @function checkWindow
+         * @param {string} [name=] - An optional tag to be associated with the snapshot.
+         * @param {number} [matchTimeout=-1] - The amount of time to retry matching (Milliseconds).
+         * @return {boolean} A promise which is resolved when the validation is finished.
+         */
+        checkWindow(name?: string, matchTimeout?: number): boolean;
+
+    }
+}

package/types/module-http.d.ts

@@ -1,163 +1,163 @@
-declare namespace Oxygen {
-    interface ModuleHttp {
-        /**
-         * @summary Sets user defined HTTP options (such as proxy, decompress and etc.)
-         * @function setOptions
-         * @param {Object} opts - HTTP request options object, see [Request Options](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md).
-         * In addition to the options listed in the linked document, 'deflateRaw' option can be used when server returns Deflate-compressed stream without headers.
-         */
-        setOptions(opts: any): void;
-
-        /**
-         * @summary Sets proxy url to be used for connections with the service.
-         * @function setProxy
-         * @param {String} url - Proxy server URL. Not passing this argument will reset the proxy settings.
-         */
-        setProxy(url: string): void;
-
-        /**
-         * @summary Performs HTTP GET
-         * @function get
-         * @param {String} url - URL.
-         * @param {Object=} headers - HTTP headers.
-         * @return {Object} Response object.
-         * @example <caption>[javascript] Usage example</caption>
-         * // Basic usage example:
-         * var response = http.get(
-         * 'https://api.github.com/repos/oxygenhq/oxygen-ide/releases',
-         * {
-         *   'Accept-Encoding': 'gzip, deflate',
-         *   'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:86.0) Gecko/20100101 Firefox/86.0'
-         * });
-         * log.info(response.body);
-         *
-         * // If server returns Deflate-compressed stream without headers, `deflateRaw` can be used to decompress the content.
-         * http.setOptions({
-         *   deflateRaw: true
-         * });
-         * var response = http.get('https://FOO.BAR');
-         * log.info(response.body);
-         */
-        get(url: string, headers?: any | undefined): any;
-
-        /**
-         * @summary Performs HTTP POST
-         * @function post
-         * @param {String} url - URL.
-         * @param {Object} data - Data.
-         * @param {Object=} headers - HTTP headers.
-         * @return {Object} Response object.
-         */
-        post(url: string, data: any, headers?: any | undefined): any;
-
-        /**
-         * @summary Performs HTTP PUT
-         * @function put
-         * @param {String} url - URL.
-         * @param {Object} data - Data.
-         * @param {Object=} headers - HTTP headers.
-         * @return {Object} Response object.
-         */
-        put(url: string, data: any, headers?: any | undefined): any;
-
-        /**
-         * @summary Performs HTTP PATCH
-         * @function patch
-         * @param {String} url - URL.
-         * @param {Object} data - Data.
-         * @param {Object=} headers - HTTP headers.
-         * @return {Object} Response object.
-         */
-        patch(url: string, data: any, headers?: any | undefined): any;
-
-        /**
-         * @summary Performs HTTP DELETE
-         * @function delete
-         * @param {String} url - URL.
-         * @param {Object=} headers - HTTP headers.
-         * @param {Object=} data - Data.
-         * @return {Object} Response object.
-         */
-        delete(url: string, headers?: any | undefined, data?: any): any;
-
-        /**
-         * @summary Returns last response object
-         * @function getResponse
-         * @return {Object} Response object.
-         */
-        getResponse(): any;
-
-        /**
-         * @summary Returns last response body
-         * @function getResponseBody
-         * @return {String} Response body.
-         */
-        getResponseBody(): string;
-
-        /**
-         * @summary Returns response headers
-         * @function getResponseHeaders
-         * @return {Object} Response headers.
-         */
-        getResponseHeaders(): any;
-
-        /**
-         * @summary Returns response URL
-         * @function getResponseUrl
-         * @return {String} Response URL.
-         */
-        getResponseUrl(): string;
-
-        /**
-         * @summary Assert whether the specified pattern is present in the response body.
-         * @function assertText
-         * @param {String} pattern - Pattern to assert.
-         */
-        assertText(pattern: string): boolean;
-
-        /**
-         * @summary Assert response time
-         * @function assertResponseTime
-         * @param {Number} maxTime - Maximum response time in milliseconds.
-         */
-        assertResponseTime(maxTime: number): void;
-
-        /**
-         * @summary Assert if HTTP header is presented in the response
-         * @function assertHeader
-         * @param {String} headerName - A HTTP header name.
-         * @param {String=} headerValuePattern - An optional HTTP header value pattern.
-         */
-        assertHeader(headerName: string, headerValuePattern?: string | undefined): boolean;
-
-        /**
-         * @summary Assert if HTTP cookie is presented in the response
-         * @function assertCookie
-         * @param {String} cookieName - A HTTP cookie name.
-         * @param {String=} cookieValuePattern - An optional HTTP cookie value pattern.
-         */
-        assertCookie(cookieName: string, cookieValuePattern?: string | undefined): void;
-
-        /**
-         * @summary Assert the last HTTP response's status code
-         * @function assertStatus
-         * @param {Number|Array} codeList - A single status code or a list of codes.
-         */
-        assertStatus(codeList: number | any[]): boolean;
-
-        /**
-         * @summary Assert HTTP 200 OK status
-         * @function assertStatusOk
-         */
-        assertStatusOk(): boolean;
-
-        /**
-         * @summary Opens new transaction.
-         * @description The transaction will persist till a new one is opened. Transaction names must be
-         *              unique.
-         * @function transaction
-         * @param {String} name - The transaction name.
-         */
-        transaction(name: string): void;
-    }
-}
+declare namespace Oxygen {
+    interface ModuleHttp {
+        /**
+         * @summary Sets user defined HTTP options (such as proxy, decompress and etc.)
+         * @function setOptions
+         * @param {Object} opts - HTTP request options object, see [Request Options](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md).
+         * In addition to the options listed in the linked document, 'deflateRaw' option can be used when server returns Deflate-compressed stream without headers.
+         */
+        setOptions(opts: any): void;
+
+        /**
+         * @summary Sets proxy url to be used for connections with the service.
+         * @function setProxy
+         * @param {String} url - Proxy server URL. Not passing this argument will reset the proxy settings.
+         */
+        setProxy(url: string): void;
+
+        /**
+         * @summary Performs HTTP GET
+         * @function get
+         * @param {String} url - URL.
+         * @param {Object=} headers - HTTP headers.
+         * @return {Object} Response object.
+         * @example <caption>[javascript] Usage example</caption>
+         * // Basic usage example:
+         * var response = http.get(
+         * 'https://api.github.com/repos/oxygenhq/oxygen-ide/releases',
+         * {
+         *   'Accept-Encoding': 'gzip, deflate',
+         *   'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:86.0) Gecko/20100101 Firefox/86.0'
+         * });
+         * log.info(response.body);
+         *
+         * // If server returns Deflate-compressed stream without headers, `deflateRaw` can be used to decompress the content.
+         * http.setOptions({
+         *   deflateRaw: true
+         * });
+         * var response = http.get('https://FOO.BAR');
+         * log.info(response.body);
+         */
+        get(url: string, headers?: any | undefined): any;
+
+        /**
+         * @summary Performs HTTP POST
+         * @function post
+         * @param {String} url - URL.
+         * @param {Object} data - Data.
+         * @param {Object=} headers - HTTP headers.
+         * @return {Object} Response object.
+         */
+        post(url: string, data: any, headers?: any | undefined): any;
+
+        /**
+         * @summary Performs HTTP PUT
+         * @function put
+         * @param {String} url - URL.
+         * @param {Object} data - Data.
+         * @param {Object=} headers - HTTP headers.
+         * @return {Object} Response object.
+         */
+        put(url: string, data: any, headers?: any | undefined): any;
+
+        /**
+         * @summary Performs HTTP PATCH
+         * @function patch
+         * @param {String} url - URL.
+         * @param {Object} data - Data.
+         * @param {Object=} headers - HTTP headers.
+         * @return {Object} Response object.
+         */
+        patch(url: string, data: any, headers?: any | undefined): any;
+
+        /**
+         * @summary Performs HTTP DELETE
+         * @function delete
+         * @param {String} url - URL.
+         * @param {Object=} headers - HTTP headers.
+         * @param {Object=} data - Data.
+         * @return {Object} Response object.
+         */
+        delete(url: string, headers?: any | undefined, data?: any): any;
+
+        /**
+         * @summary Returns last response object
+         * @function getResponse
+         * @return {Object} Response object.
+         */
+        getResponse(): any;
+
+        /**
+         * @summary Returns last response body
+         * @function getResponseBody
+         * @return {String} Response body.
+         */
+        getResponseBody(): string;
+
+        /**
+         * @summary Returns response headers
+         * @function getResponseHeaders
+         * @return {Object} Response headers.
+         */
+        getResponseHeaders(): any;
+
+        /**
+         * @summary Returns response URL
+         * @function getResponseUrl
+         * @return {String} Response URL.
+         */
+        getResponseUrl(): string;
+
+        /**
+         * @summary Assert whether the specified pattern is present in the response body.
+         * @function assertText
+         * @param {String} pattern - Pattern to assert.
+         */
+        assertText(pattern: string): boolean;
+
+        /**
+         * @summary Assert response time
+         * @function assertResponseTime
+         * @param {Number} maxTime - Maximum response time in milliseconds.
+         */
+        assertResponseTime(maxTime: number): void;
+
+        /**
+         * @summary Assert if HTTP header is presented in the response
+         * @function assertHeader
+         * @param {String} headerName - A HTTP header name.
+         * @param {String=} headerValuePattern - An optional HTTP header value pattern.
+         */
+        assertHeader(headerName: string, headerValuePattern?: string | undefined): boolean;
+
+        /**
+         * @summary Assert if HTTP cookie is presented in the response
+         * @function assertCookie
+         * @param {String} cookieName - A HTTP cookie name.
+         * @param {String=} cookieValuePattern - An optional HTTP cookie value pattern.
+         */
+        assertCookie(cookieName: string, cookieValuePattern?: string | undefined): void;
+
+        /**
+         * @summary Assert the last HTTP response's status code
+         * @function assertStatus
+         * @param {Number|Array} codeList - A single status code or a list of codes.
+         */
+        assertStatus(codeList: number | any[]): boolean;
+
+        /**
+         * @summary Assert HTTP 200 OK status
+         * @function assertStatusOk
+         */
+        assertStatusOk(): boolean;
+
+        /**
+         * @summary Opens new transaction.
+         * @description The transaction will persist till a new one is opened. Transaction names must be
+         *              unique.
+         * @function transaction
+         * @param {String} name - The transaction name.
+         */
+        transaction(name: string): void;
+    }
+}