oxygen-cli 1.27.2 → 1.27.4

package/types/module-pdf.d.ts

@@ -0,0 +1,41 @@
+declare namespace Oxygen {
+    /**
+     * @name pdf
+     * @description Provides generic methods for working with PDF files.
+     */
+    interface ModulePdf {
+        
+        /**
+         * @summary Asserts that text is present in a PDF file
+         * @function assert
+         * @param {String} pdfFilePath - Relative or absolute path to the PDF file.
+         * @param {String} text - Text to assert.
+         * @param {Number=} pageNum - Page number.
+         * @param {String=} message - Message to throw if assertion fails.
+         * @param {Boolean=} reverse - Check also reverse variant of string.
+         */
+        assert(pdfFilePath: string, text: string, pageNum?: number, message?: string, reverse?: boolean): void;
+
+        /**
+         * @summary Asserts that text is not present in a PDF file
+         * @function assertNot
+         * @param {String} pdfFilePath - Relative or absolute path to the pdf file.
+         * @param {String} text - Text to assert.
+         * @param {Number=} pageNum - Page number.
+         * @param {String=} message - Message to throw if assertion fails.
+         * @param {Boolean=} reverse - Check also reverse variant of string.
+         */
+        assertNot(pdfFilePath: string, text: string, pageNum?: number, message: string, reverse?: boolean): void;
+
+        /**
+         * @summary Count the number of times specified text is present in a PDF file.
+         * @function count
+         * @param {String} pdfFilePath - Relative or absolute path to the pdf file.
+         * @param {String} text - Text to count.
+         * @param {Number=} pageNum - Page number.
+         * @param {Boolean=} reverse - Check also reverse variant of string.
+         * @return {Number} Number of times the specified text was found.
+         */
+        count(pdfFilePath: string, text: string, pageNum?: number, reverse?: boolean): void;
+    }
+}

package/types/module-proxy.d.ts

@@ -0,0 +1,100 @@
+declare namespace Oxygen {
+    /**
+     * @name proxy
+     * @description Provides methods for intercepting network traffic via mitmproxy.
+     */
+    interface ModuleProxy {
+        /**
+         * @function init
+         * @summary Initializes proxy.
+         * @param {Number} proxyPort - Proxy port.
+         * @param {Number=} proxyCommPort - Port for internal proxy communication. If specified, then mitmproxy should be launched manually.
+         * Otherwise mitmpoxy will be launched automatically.
+         * @param {Boolean=} saveRequestBody - Save request bodies.
+         * @param {Boolean=} saveResponseBody - Save response bodies.
+         * @example <caption>[shell] Launching mitmproxy manually</caption>
+         * mitmdump --anticache -s mitmproxy-node\scripts\proxy.py --ssl-insecure --set httpCommPort=8765
+         */
+        init(proxyPort: number, proxyCommPort?: number | undefined, saveRequestBody?: boolean | undefined, saveResponseBody?: boolean | undefined): boolean;
+
+        /**
+         * @function dispose
+         * @summary Disposes this module.
+         */
+        dispose(status: any): void;
+
+        /**
+         * @summary Begin collecting network requests.
+         * @description Any previously collected requests will be discarded.
+         * @function start
+         * @example <caption>[javascript] Usage example</caption>
+         * proxy.init(8080);
+         * proxy.start();
+         * // print the collected request so far:
+         * let requests = proxy.getRequests();
+         * for (let req of requests) {
+         *   log.info(req);
+         * }
+         * // wait for a request using a verbatim URL match:
+         * proxy.waitForUrl('https://www.yourwebsite.com/foo/bar');
+         * // wait for a request using a regular expression URL match:
+         * proxy.waitForUrl(/https:\/\/.*\/foo\/bar/);
+         * // wait for a request using a custom matcher:
+         * proxy.waitFor(function (request) {
+         *   return request.status === '200' && request.url === 'https://www.yourwebsite.com/foo/bar';
+         * });
+         */
+        start(): void;
+
+        /**
+         * @summary Stop collecting network requests.
+         * @function stop
+         */
+        stop(): void;
+
+        /**
+         * @summary Return all the collected network requests so far.
+         * @function getRequests
+         * @return {Object[]} Array containing network requests.
+         */
+        getRequests(): any[];
+
+        /**
+         * @summary Wait for a network request matching the specified URL.
+         * @function waitForUrl
+         * @param {String|RegExp} pattern - An URL to match verbatim or a RegExp.
+         * @param {Number=} timeout - Timeout. Default is 60 seconds.
+         * @return {Object} Network request details if the network request was found.
+         */
+        waitForUrl(pattern: string | RegExp, timeout?: number | undefined): any;
+
+        /**
+         * @summary Wait for a network request.
+         * @function waitFor
+         * @param {Function} matcher - Matching function. Should return true on match, or false otherwise.
+         * @param {Number=} timeout - Timeout. Default is 60 seconds.
+         * @return {Object} Network request details if the network request was found.
+         */
+        waitFor(matcher: Function, timeout?: number | undefined): any;
+
+        /**
+         * @summary Assert if network request matching the specified URL.
+         * @function assertUrl
+         * @param {String|RegExp} url - A request URL to match verbatim or a RegExp.
+         * @param {Number=} timeout - Timeout. Default is 60 seconds.
+         * @return {Object} Network request details if the network request was found.
+         */
+        assertUrl(url: string | RegExp, timeout?: number | undefined): any;
+
+        /**
+         * @summary Assert whether HTTP response status code matches the specified value.
+         * @function assertStatusCode
+         * @param {String|RegExp} url - A request URL to match verbatim or a RegExp.
+         * @param {Number} statusCode - A response status code to match verbatim or a RegExp.
+         * @param {String=} failureMessage - An optional failure message.
+         * @param {Number=} timeout - Timeout. Default is 60 seconds.
+         * @return {Object} Network request details if the network request was found.
+         */
+        assertStatusCode(url: string | RegExp, statusCode: number, failureMessage?: string | undefined, timeout?: number | undefined): any;
+    }
+}

package/types/module-shell.d.ts

@@ -0,0 +1,24 @@
+declare namespace Oxygen {
+    /**
+     * @name shell
+     * @description Provides methods for working with operating system shell.
+     */
+    interface ModuleShell {
+        get name(): string;
+        /**
+         * @summary Execute command
+         * @description Spawn child process
+         * @function exec
+         * @param {String} command - Shell command to be executed, including arguments, if applicable.
+         * @return {String} null | Error | stdout result
+         */
+        exec(command: string, options?: {}): string;
+
+        /**
+         * @summary Assert whether the shell command output (stdout) is matching the specified pattern.
+         * @function assertOutput
+         * @param {String} pattern - Pattern to assert.
+         */
+        assertOutput(pattern: string): boolean;
+    }
+}

package/types/module-utils.d.ts

@@ -0,0 +1,99 @@
+/// <reference types="@types/node" />
+declare namespace Oxygen {
+    interface ModuleUtils {
+        /**
+         * @summary Pause test execution for the given amount of milliseconds.
+         * @function pause
+         * @param {Number} ms - Milliseconds to pause the execution for.
+         */
+        pause(ms: number): void;
+
+        /**
+         * @summary Decrypt text
+         * @function decrypt
+         * @param {String} text - Text
+         * @return {Object} DecryptResult Object with getDecryptResult method
+         * @example <caption>[javascript] Usage example</caption>
+         * // to encrypt plaintext into ciphertext
+         * const encrypt = utils.encrypt('https://www.wikipedia.org');
+         * log.info(encrypt); // will print b757ba2c2fc50fbb511d596816ca06c4fa56f4e98ce222f30bc58d5251ed635e
+         *
+         * // to decrypt ciphertext and use it in script
+         * const decrypt = utils.decrypt(encrypt);
+         * log.info(decrypt); // will print ENCRYPTED
+         *
+         * web.init();
+         * web.open(decrypt); // will open https://www.wikipedia.org
+         *
+         * // to get original plaintext use getDecryptResult
+         * const value = decrypt.getDecryptResult();
+         * log.info(value); //will print https://www.wikipedia.org
+         */
+        decrypt(text: string): any;
+
+        /**
+         * @summary Encrypt text
+         * @function encrypt
+         * @param {String} text - Text
+         * @return {String} Encrypted text
+         * @example <caption>[javascript] Usage example</caption>
+         * // to encrypt plaintext into ciphertext
+         * const encrypt = utils.encrypt('https://www.wikipedia.org');
+         * log.info(encrypt); // will print b757ba2c2fc50fbb511d596816ca06c4fa56f4e98ce222f30bc58d5251ed635e
+         *
+         * // to decrypt ciphertext and use it in script
+         * const decrypt = utils.decrypt(encrypt);
+         * log.info(decrypt); // will print ENCRYPTED
+         *
+         * web.init();
+         * web.open(decrypt); // will open https://www.wikipedia.org
+         *
+         * // to get original plaintext use getDecryptResult
+         * const value = decrypt.getDecryptResult();
+         * log.info(value); //will print https://www.wikipedia.org
+         */
+        encrypt(text: string): string;
+
+        /**
+         * @summary Reads data from csv file
+         * @function readCsv
+         * @param {String} filePath - Absolute path to file
+         * @param {Object=} options - [Options](https://csv.js.org/parse/options/)
+         */
+        readCsv(filePath: string, options?: any | undefined): any;
+
+        /**
+         * @summary Writes data into csv file
+         * @function writeCsv
+         * @param {String} filePath - Absolute path to file
+         * @param {Array} data - CSV data in format [{column_name_1: 'foo', column_name_2: 'bar'}]
+         * @param {Object=} options - [Options](https://github.com/anton-bot/objects-to-csv#async-todiskfilename-options)
+         */
+        writeCsv(filePath: string, data: any[], options?: any | undefined): void;
+
+        /**
+         * @summary Reads data from Xlsx file
+         * @function readXlsx
+         * @param {String} filePath - Absolute path to file
+         * @return {Array} - Array of xlsx data
+         */
+        readXlsx(filePath: string): any[];
+
+        /**
+         * @summary Uses the DNS protocol to resolve a host name
+         * @function dnsResolve
+         * @param {String} hostname - Host name to resolve.
+         * @param {String=} rrType - Resource record type. Default: 'A'.
+         * @return {String[] | Object} - Array or Object of resource records. The type and structure of individual results vary based on rrtype
+         */
+        dnsResolve(hostname: string, rrType?: string | undefined): string[] | any;
+
+        /**
+         * @summary Parse XML data to JS object
+         * @function xmlToJson
+         * @param {string|Buffer} xmlDataStr - Like <root a="nice" b="very nice" ><a>wow</a></root>
+         * @param {boolean|Object} options - [Options](https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/docs/v4/2.XMLparseOptions.md)
+         */
+        xmlToJson(xmlDataStr: string | Buffer, options?: boolean | any): any;
+    }
+}