nativescript 8.8.0 → 8.8.1

package/lib/common/decorators.js

@@ -12,6 +12,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deprecated = exports.performanceLog = exports.exported = exports.invokeInit = exports.invokeBefore = exports.memoize = exports.cache = void 0;
 const constants_1 = require("../constants");
 const yok_1 = require("./yok");
+/**
+ * Caches the result of the first execution of the method and returns it whenever it is called instead of executing it again.
+ * Works with methods and getters.
+ * @example
+ * ```
+ * class CacheDecoratorsTest {
+ *
+ * 	@cache()
+ * 	public method(num: number): number {
+ * 		return num;
+ * 	}
+ *
+ * 	@cache()
+ * 	public get property(): any {
+ * 		// execute some heavy operation.
+ * 		return result;
+ * 	}
+ * }
+ *
+ * const instance = new CacheDecoratorsTest();
+ * const result = instance.method(1); // returns 1;
+ *
+ * // all consecutive calls to instance.method will return 1.
+ * const result2 = instance.method(2); // returns 1;
+ * ```
+ */
 function cache() {
     return (target, propertyKey, descriptor) => {
         let result;
@@ -32,6 +58,7 @@ exports.cache = cache;
 let memoizeIDCounter = 0;
 function memoize(options) {
     return (target, propertyKey, descriptor) => {
+        // todo: remove once surely working as intended.
         const DEBUG = false;
         const memoizeID = memoizeIDCounter++;
         const valueOrGet = descriptor.value ? "value" : "get";
@@ -52,6 +79,7 @@ function memoize(options) {
                     cacheMapName,
                     hashKey,
                 });
+            // initialize cache map if not exists
             if (!this.hasOwnProperty(cacheMapName)) {
                 DEBUG && console.log("NO CACHE MAP YET, CREATING ONE NOW");
                 Object.defineProperty(this, cacheMapName, {
@@ -66,12 +94,16 @@ function memoize(options) {
                 console.log({
                     cacheMap,
                 });
+            // check if has memoized value based on hashFn
             if (cacheMap.has(hashKey)) {
                 DEBUG && console.log("CACHE HIT");
+                // if yes, return cached value
                 return cacheMap.get(hashKey);
             }
             DEBUG && console.log("CACHE MISS");
+            // if not call original and get result
             const result = originalMethod.apply(this, args);
+            // call shouldCache (if passed) with the result or default to true
             let shouldCache = true;
             if (options.shouldCache) {
                 shouldCache = options.shouldCache.call(this, result);
@@ -81,6 +113,7 @@ function memoize(options) {
                 DEBUG && console.log("CACHING NOW");
                 cacheMap.set(hashKey, result);
             }
+            // if shouldCache: save result
             DEBUG && console.log("RETURNING", result);
             return result;
         };
@@ -88,6 +121,14 @@ function memoize(options) {
     };
 }
 exports.memoize = memoize;
+/**
+ * Calls specific method of the instance before executing the decorated method.
+ * This is usable when some of your methods depend on initialize async method, that cannot be invoked in constructor of the class.
+ * IMPORTANT: The decorated method must be async.
+ * @param {string} methodName The name of the method that will be invoked before calling the decorated method.
+ * @param {any[]} methodArgs Args that will be passed to the method that will be invoked before calling the decorated one.
+ * @return {any} Result of the decorated method.
+ */
 function invokeBefore(methodName, methodArgs) {
     return (target, propertyKey, descriptor) => {
         const originalValue = descriptor.value;
@@ -124,6 +165,7 @@ function performanceLog(localInjector) {
         const className = target.constructor.name;
         const trackName = `${className}${constants_1.AnalyticsEventLabelDelimiter}${propertyKey}`;
         const performanceService = localInjector.resolve("performanceService");
+        //needed for the returned function to have the same name as the original - used in hooks decorator
         const functionWrapper = {
             [originalMethod.name]: function (...args) {
                 const start = performanceService.now();
@@ -149,6 +191,7 @@ function performanceLog(localInjector) {
             },
         };
         descriptor.value = functionWrapper[originalMethod.name];
+        // used to get parameter names in hooks decorator
         descriptor.value.toString = () => {
             return originalMethod.toString();
         };
@@ -156,6 +199,7 @@ function performanceLog(localInjector) {
     };
 }
 exports.performanceLog = performanceLog;
+// inspired by https://github.com/NativeScript/NativeScript/blob/55dfe25938569edbec89255008e5ad9804901305/tns-core-modules/globals/globals.ts#L121-L137
 function deprecated(additionalInfo, localInjector) {
     const isDeprecatedMessage = " is deprecated.";
     return (target, key, descriptor) => {
@@ -164,6 +208,7 @@ function deprecated(additionalInfo, localInjector) {
         const $logger = localInjector.resolve("logger");
         if (descriptor) {
             if (descriptor.value) {
+                // method
                 const originalMethod = descriptor.value;
                 descriptor.value = function (...args) {
                     $logger.warn(`${key.toString()}${isDeprecatedMessage} ${additionalInfo}`);
@@ -172,6 +217,7 @@ function deprecated(additionalInfo, localInjector) {
                 return descriptor;
             }
             else {
+                // property
                 if (descriptor.set) {
                     const originalSetter = descriptor.set;
                     descriptor.set = function (...args) {
@@ -190,6 +236,7 @@ function deprecated(additionalInfo, localInjector) {
             }
         }
         else {
+            // class
             $logger.warn(`${(target &&
                 (target.name ||
                     (target.constructor && target.constructor.name))) ||
@@ -199,3 +246,4 @@ function deprecated(additionalInfo, localInjector) {
     };
 }
 exports.deprecated = deprecated;
+//# sourceMappingURL=decorators.js.map

package/lib/common/dispatchers.js

@@ -24,7 +24,9 @@ const yok_1 = require("./yok");
 const constants_1 = require("../constants");
 const semver = require("semver");
 class CommandDispatcher {
-    constructor($logger, $injector, $cancellation, $commandsService, $staticConfig, $sysInfo, $options, $versionsService, $packageManager, $terminalSpinnerService) {
+    constructor($logger, 
+    // required by the hooksService
+    $injector, $cancellation, $commandsService, $staticConfig, $sysInfo, $options, $versionsService, $packageManager, $terminalSpinnerService) {
         this.$logger = $logger;
         this.$injector = $injector;
         this.$cancellation = $cancellation;
@@ -42,6 +44,7 @@ class CommandDispatcher {
                 return this.printVersion();
             }
             if (this.$logger.getLevel() === "TRACE" && !this.$options.json) {
+                // CommandDispatcher is called from external CLI's only, so pass the path to their package.json
                 this.$logger.trace("Collecting system information...");
                 const sysInfo = yield this.$sysInfo.getSysInfo({
                     pathToNativeScriptCliPackageJson: path.join(__dirname, "..", "..", "package.json"),
@@ -73,6 +76,7 @@ class CommandDispatcher {
     }
     resolveCommand(commandName, commandArguments, argv) {
         return __awaiter(this, void 0, void 0, function* () {
+            // just a hook point
             return { commandName, commandArguments, argv };
         });
     }
@@ -81,6 +85,7 @@ class CommandDispatcher {
         if (remaining.length > 0) {
             return remaining[0].toString().toLowerCase();
         }
+        // if only <CLI_NAME> is specified on console, show console help
         this.$options.help = true;
         return "";
     }
@@ -88,6 +93,8 @@ class CommandDispatcher {
         return __awaiter(this, void 0, void 0, function* () {
             this.$logger.info(this.$staticConfig.version);
             if (this.$options.json) {
+                // we don't check for updates when --json is passed
+                // useful for tools that rely on the output of the command
                 return;
             }
             const spinner = this.$terminalSpinnerService.createSpinner();
@@ -115,6 +122,7 @@ class CommandDispatcher {
             if (semver.gte(nativescriptCliVersion.currentVersion, nativescriptCliVersion.latestVersion, {
                 loose: true,
             })) {
+                // up-to-date
                 spinner.succeed("Up to date.");
             }
             else {
@@ -149,3 +157,4 @@ class FutureDispatcher {
     }
 }
 yok_1.injector.register("dispatcher", FutureDispatcher, false);
+//# sourceMappingURL=dispatchers.js.map

package/lib/common/errors.js

@@ -23,7 +23,9 @@ const source_map_1 = require("source-map");
 const helpers_1 = require("./helpers");
 const decorators_1 = require("./decorators");
 const yok_1 = require("./yok");
+// we need this to overwrite .stack property (read-only in Error)
 function Exception() {
+    /* intentionally left blank */
 }
 Exception.prototype = new Error();
 function resolveCallStack(error) {
@@ -69,6 +71,7 @@ function resolveCallStack(error) {
         })));
         let outputMessage = remapped.join("\n");
         if (outputMessage.indexOf(error.message) === -1) {
+            // when fibers throw error in node 0.12.x, the stack does NOT contain the message
             outputMessage = outputMessage.replace(/Error/, "Error: " + error.message);
         }
         return outputMessage;
@@ -93,7 +96,9 @@ function installUncaughtExceptionListener(actionOnException) {
             }
         }
         catch (err) {
-            process.exit(131);
+            // In case the handler throws error and we do not catch it, we'll go in infinite loop of unhandled rejections.
+            // We cannot do anything here as even `console.error` may fail. So just exit the process.
+            process.exit(131 /* ErrorCodes.UNHANDLED_REJECTION_FAILURE */);
         }
     });
     process.on("uncaughtException", handler);
@@ -107,6 +112,7 @@ function tryTrackException(error, localInjector) {
             disableAnalytics = localInjector.resolve("staticConfig").disableAnalytics;
         }
         catch (err) {
+            // We should get here only in our unit tests.
             disableAnalytics = true;
         }
         if (!disableAnalytics) {
@@ -115,6 +121,7 @@ function tryTrackException(error, localInjector) {
                 yield analyticsService.trackException(error, error.message);
             }
             catch (e) {
+                // Do not replace with logger due to cyclic dependency
                 console.error("Error while reporting exception: " + e);
             }
         }
@@ -153,9 +160,10 @@ class Errors {
             exception.message = $messagesService.getMessage.apply($messagesService, [opts.formatStr].concat(argsArray));
         }
         catch (err) {
+            // Ignore
         }
         exception.stack = new Error(exception.message).stack;
-        exception.errorCode = opts.errorCode || 127;
+        exception.errorCode = opts.errorCode || 127 /* ErrorCodes.UNKNOWN */;
         exception.suggestCommandHelp = suggestCommandHelp;
         exception.proxyAuthenticationRequired = !!opts.proxyAuthenticationRequired;
         exception.printOnStdout = opts.printOnStdout;
@@ -188,10 +196,11 @@ class Errors {
                     yield printCommandHelpSuggestion();
                 }
                 yield tryTrackException(ex, this.$injector);
-                process.exit(_.isNumber(ex.errorCode) ? ex.errorCode : 127);
+                process.exit(_.isNumber(ex.errorCode) ? ex.errorCode : 127 /* ErrorCodes.UNKNOWN */);
             }
         });
     }
+    // If you want to activate this function, start Node with flags --nouse_idle_notification and --expose_gc
     verifyHeap(message) {
         if (global.gc) {
             console.log("verifyHeap: '%s'", message);
@@ -204,3 +213,4 @@ __decorate([
 ], Errors.prototype, "failWithoutHelp", null);
 exports.Errors = Errors;
 yok_1.injector.register("errors", Errors);
+//# sourceMappingURL=errors.js.map

package/lib/common/file-system.js

@@ -30,6 +30,7 @@ const os_1 = require("os");
 const detectNewline = require("detect-newline");
 const archiver_1 = require("archiver");
 const stringifyPackage = require("stringify-package");
+// TODO: Add .d.ts for mkdirp module (or use it from @types repo).
 const mkdirp = require("mkdirp");
 let FileSystem = FileSystem_1 = class FileSystem {
     constructor($injector) {
@@ -37,6 +38,7 @@ let FileSystem = FileSystem_1 = class FileSystem {
     }
     zipFiles(zipFile, files, zipPathCallback) {
         return __awaiter(this, void 0, void 0, function* () {
+            //we are resolving it here instead of in the constructor, because config has dependency on file system and config shouldn't require logger
             const $logger = this.$injector.resolve("logger");
             const zip = (0, archiver_1.create)("zip", {
                 zlib: {
@@ -75,10 +77,10 @@ let FileSystem = FileSystem_1 = class FileSystem {
                 proc = (0, path_1.join)(__dirname, "resources/platform-tools/unzip/win32/unzip");
             }
             else if ($hostInfo.isDarwin) {
-                proc = "unzip";
+                proc = "unzip"; // darwin unzip is info-zip
             }
             else if ($hostInfo.isLinux) {
-                proc = "unzip";
+                proc = "unzip"; // linux unzip is info-zip
             }
             if (!isCaseSensitive) {
                 zipFile = this.findFileCaseInsensitive(zipFile);
@@ -120,6 +122,7 @@ let FileSystem = FileSystem_1 = class FileSystem {
         }
         catch (err) {
             if (err && err.code !== "ENOENT") {
+                // ignore "file doesn't exist" error
                 throw err;
             }
         }
@@ -158,6 +161,7 @@ let FileSystem = FileSystem_1 = class FileSystem {
                 }
             });
             if (root) {
+                // console.log("root", paths);
                 return Array.from(paths.values()).reduce((sum, current) => sum + current, 0);
             }
         };
@@ -232,6 +236,8 @@ let FileSystem = FileSystem_1 = class FileSystem {
     writeFile(filename, data, encoding) {
         this.createDirectory((0, path_1.dirname)(filename));
         if (!data) {
+            // node 14 will no longer coerce unsupported input to strings anymore.
+            // clean any null or undefined data
             data = "";
         }
         fs.writeFileSync(filename, data, { encoding: encoding });
@@ -262,6 +268,8 @@ let FileSystem = FileSystem_1 = class FileSystem {
             return;
         }
         this.createDirectory((0, path_1.dirname)(destinationFileName));
+        // MobileApplication.app is resolved as a directory on Mac,
+        // therefore we need to copy it recursively as it's not a single file.
         shelljs.cp("-rf", sourceFileName, destinationFileName);
         const err = shelljs.error();
         if (err) {
@@ -338,8 +346,10 @@ let FileSystem = FileSystem_1 = class FileSystem {
                 });
                 yield this.futureFromEvent(chown, "close");
             }
+            // nothing to do on Windows, as chown does not work on this platform
         });
     }
+    // filterCallback: function(path: String, stat: fs.Stats): Boolean
     enumerateFilesInDirectorySync(directoryPath, filterCallback, opts, foundFiles) {
         foundFiles = foundFiles || [];
         if (!this.exists(directoryPath)) {
@@ -439,3 +449,4 @@ FileSystem = FileSystem_1 = __decorate([
     injector.register("fs")
 ], FileSystem);
 exports.FileSystem = FileSystem;
+//# sourceMappingURL=file-system.js.map

package/lib/common/header.js

@@ -13,11 +13,13 @@ function printHeader() {
         color_1.color.cyanBright.bold("{N} NativeScript "),
         color_1.color.whiteBright.bold("CLI"),
         color_1.color.dim(` [v${version}] `),
+        // color.dim("  │"),
     ].join("");
     const tagLine = [
         color_1.color.dim("│ "),
         color_1.color.dim(" → "),
         color_1.color.whiteBright.bold("Empower JavaScript with native APIs "),
+        // color.dim("  │"),
     ].join("");
     const headerLength = (0, color_1.stripColors)(header).length;
     const tagLineLength = (0, color_1.stripColors)(tagLine).length;
@@ -28,3 +30,4 @@ function printHeader() {
     console.info("  " + color_1.color.dim("└" + "─".repeat(width - 1) + "┘"));
 }
 exports.printHeader = printHeader;
+//# sourceMappingURL=header.js.map

package/lib/common/helpers.js

@@ -32,6 +32,13 @@ function doesCurrentNpmCommandMatch(patterns) {
     return result;
 }
 exports.doesCurrentNpmCommandMatch = doesCurrentNpmCommandMatch;
+/**
+ * Equivalent of lodash's some, but instead of lambda, just pass array of Regular Expressions.
+ * If any of them matches any of the given elements, true is returned.
+ * @param {string[]} array Elements to be checked.
+ * @param {RegExp[]} patterns Regular expressions to be tested
+ * @returns {boolean} True in case any element of the array matches any of the patterns. False otherwise.
+ */
 function someWithRegExps(array, patterns) {
     return _.some(array, (item) => _.some(patterns, (pattern) => !!item.match(pattern)));
 }
@@ -44,6 +51,7 @@ function getCurrentNpmCommandArgv() {
             result = npmConfigArgv.original || [];
         }
         catch (error) {
+            // ignore
         }
     }
     return result;
@@ -64,6 +72,7 @@ function isInstallingNativeScriptGloballyWithNpm() {
     return isInstallCommand && isGlobalCommand && hasNativeScriptPackage;
 }
 function isInstallingNativeScriptGloballyWithYarn() {
+    // yarn populates the same env used by npm - npm_config_argv, so check it for yarn specific command
     const isInstallCommand = doesCurrentNpmCommandMatch([/^add$/]);
     const isGlobalCommand = doesCurrentNpmCommandMatch([/^global$/]);
     const hasNativeScriptPackage = doesCurrentNpmCommandMatch([
@@ -72,6 +81,13 @@ function isInstallingNativeScriptGloballyWithYarn() {
     ]);
     return isInstallCommand && isGlobalCommand && hasNativeScriptPackage;
 }
+/**
+ * Creates regular expression from input string.
+ * The method replaces all occurences of RegExp special symbols in the input string with \<symbol>.
+ * @param {string} input The string from which a regular expression should be created.
+ * @param {string} opts RegExp options, for example "gm" - global and multiline.
+ * @returns {RegExp} The regular expression created from the input string.
+ */
 function createRegExp(input, opts) {
     if (!input || !_.isString(input)) {
         throw new Error("Input must be a string.");
@@ -80,7 +96,13 @@ function createRegExp(input, opts) {
     return new RegExp(escapedSource, opts);
 }
 exports.createRegExp = createRegExp;
+/**
+ * Escapes all special symbols used in regex.
+ * @param {string} input The string in which to replace the special regexp symbols.
+ * @returns {string} A string in which all regex symbols are escaped.
+ */
 function regExpEscape(input) {
+    // https://stackoverflow.com/questions/3446170/escape-string-for-use-in-javascript-regex
     return input.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
 exports.regExpEscape = regExpEscape;
@@ -89,6 +111,7 @@ function getShortPluginName(pluginName) {
 }
 exports.getShortPluginName = getShortPluginName;
 function sanitizePluginName(pluginName) {
+    // avoid long plugin names, exclude the npm module scope (@scope/nativescript-plugin) from the android plugin name
     return pluginName.split("/").pop();
 }
 function executeActionByChunks(initialData, chunkSize, elementAction) {
@@ -139,6 +162,13 @@ function deferPromise() {
     };
 }
 exports.deferPromise = deferPromise;
+/**
+ * Executes all promises and does not stop in case any of them throws.
+ * Returns the results of all promises in array when all are successfully resolved.
+ * In case any of the promises is rejected, rejects the resulted promise with all accumulated errors.
+ * @param {Promise<T>[]} promises Promises to be resolved.
+ * @returns {Promise<T[]>} New promise which will be resolved with the results of all promises.
+ */
 function settlePromises(promises) {
     return new Promise((resolve, reject) => {
         let settledPromisesCount = 0;
@@ -154,6 +184,7 @@ function settlePromises(promises) {
                 results[index] = result;
             })
                 .catch((err) => {
+                // Accumulate all errors.
                 errors.push(err);
             })
                 .then(() => {
@@ -187,12 +218,14 @@ function bashQuote(s) {
     if (s[0] === "'" && s[s.length - 1] === "'") {
         return s;
     }
+    // replace ' with '"'"' and wrap in ''
     return "'" + s.replace(/'/g, "'\"'\"'") + "'";
 }
 function cmdQuote(s) {
     if (s[0] === '"' && s[s.length - 1] === '"') {
         return s;
     }
+    // replace " with \" and wrap in ""
     return '"' + s.replace(/"/g, '\\"') + '"';
 }
 function quoteString(s) {
@@ -258,6 +291,9 @@ function isInteractive() {
     return result;
 }
 exports.isInteractive = isInteractive;
+/**
+ * Checks if current process is running in Text Terminal (TTY)
+ */
 function isRunningInTTY() {
     return (process.stdout &&
         process.stdout.isTTY &&
@@ -265,6 +301,10 @@ function isRunningInTTY() {
         process.stdin.isTTY);
 }
 function isCIEnvironment() {
+    // The following CI environments set their own environment variables that we respect:
+    //  travis: "CI",
+    //  circleCI: "CI",
+    //  jenkins: "JENKINS_HOME"
     return !!(process.env && (process.env.CI || process.env.JENKINS_HOME));
 }
 function toBoolean(str) {
@@ -329,11 +369,11 @@ function getMessageWithBorders(message, spanLength = 3) {
     const longestRowLength = message.split("\n").sort((a, b) => {
         return b.length - a.length;
     })[0].length;
-    let border = "*".repeat(longestRowLength + 2 * spanLength);
+    let border = "*".repeat(longestRowLength + 2 * spanLength); // * 2 for both sides
     if (border.length % 2 === 0) {
-        border += "*";
+        border += "*"; // the * should always be an odd number in order to get * in each edge (we will remove the even *s below)
     }
-    border = border.replace(/\*\*/g, "* ");
+    border = border.replace(/\*\*/g, "* "); // ***** => * * * in order to have similar padding to the side borders
     const formatRow = function (row) {
         return (_.padEnd("*", spanLength) +
             _.padEnd(row, border.length - 2 * spanLength) +
@@ -366,9 +406,11 @@ function trimSymbol(str, symbol) {
 }
 exports.trimSymbol = trimSymbol;
 function parseJson(data) {
+    // Replace BOM from the header of the file if it exists
     return JSON.parse(data.replace(/^\uFEFF/, ""));
 }
 exports.parseJson = parseJson;
+// TODO: Use generic for predicatе predicate: (element: T|T[]) when TypeScript support this.
 function getFuturesResults(promises, predicate) {
     return __awaiter(this, void 0, void 0, function* () {
         const results = yield Promise.all(promises);
@@ -376,6 +418,12 @@ function getFuturesResults(promises, predicate) {
     });
 }
 exports.getFuturesResults = getFuturesResults;
+/**
+ * Appends zeroes to a version string until it reaches a specified length.
+ * @param {string} version The version on which to append zeroes.
+ * @param requiredVersionLength The required length of the version string.
+ * @returns {string} Appended version string. In case input is null, undefined or empty string, it is returned immediately without appending anything.
+ */
 function appendZeroesToVersion(version, requiredVersionLength) {
     if (version) {
         const zeroesToAppend = requiredVersionLength - version.split(".").length;
@@ -541,6 +589,14 @@ function getProjectFilesConfig(opts) {
     return projectFilesConfig;
 }
 exports.getProjectFilesConfig = getProjectFilesConfig;
+/**
+ * Tries to find the process id (PID) of the specified application identifier.
+ * This is specific implementation for iOS Simulator, where the running applications are real processes.
+ * Their PIDs are printed in a specific format in the the logs, once the application is started.
+ * @param {string} applicationIdentifier Application Identifier of the app for which we try to get the PID.
+ * @param {string} logLine Line that may contain the PID of the process.
+ * @returns {string} The PID of the searched application identifier in case it's found in the current line, null otherwise.
+ */
 function getPidFromiOSSimulatorLogs(applicationIdentifier, logLine) {
     if (logLine) {
         const pidRegExp = new RegExp(`${applicationIdentifier}:\\s?(\\d+)`);
@@ -592,6 +648,7 @@ function stringify(value, replacer, space) {
     return JSON.stringify(value, replacer, space || 2);
 }
 exports.stringify = stringify;
+//2019-01-07 18:29:50.745
 function getFixedLengthDateString() {
     const currentDate = new Date();
     const year = currentDate.getFullYear();
@@ -617,6 +674,28 @@ function getFormattedMilliseconds(date) {
     return milliseconds;
 }
 exports.getFormattedMilliseconds = getFormattedMilliseconds;
+//--- begin part copied from AngularJS
+//The MIT License
+//
+//Copyright (c) 2010-2012 Google, Inc. http://angularjs.org
+//
+//Permission is hereby granted, free of charge, to any person obtaining a copy
+//of this software and associated documentation files (the "Software"), to deal
+//in the Software without restriction, including without limitation the rights
+//to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//copies of the Software, and to permit persons to whom the Software is
+//furnished to do so, subject to the following conditions:
+//
+//	The above copyright notice and this permission notice shall be included in
+//all copies or substantial portions of the Software.
+//
+//	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//THE SOFTWARE.
 const CLASS_NAME = /class\s+([A-Z].+?)(?:\s+.*?)?\{/;
 const CONSTRUCTOR_ARGS = /constructor\s*([^\(]*)\(\s*([^\)]*)\)/m;
 const FN_NAME_AND_ARGS = /^(?:function)?\s*([^\(]*)\(\s*([^\)]*)\)\s*(=>)?\s*[{_]/m;
@@ -647,6 +726,11 @@ function annotate(fn) {
     return $inject;
 }
 exports.annotate = annotate;
+/**
+ * Returns true if all Android signing options are provided, false otherwise.
+ * @param {IAndroidSigningData} signingData The signing data to be validated.
+ * @return {void}
+ */
 function hasValidAndroidSigning(signingData) {
     const isValid = signingData &&
         signingData.keyStorePath &&
@@ -656,3 +740,5 @@ function hasValidAndroidSigning(signingData) {
     return !!isValid;
 }
 exports.hasValidAndroidSigning = hasValidAndroidSigning;
+//--- end part copied from AngularJS
+//# sourceMappingURL=helpers.js.map

package/lib/common/host-info.js

@@ -75,6 +75,9 @@ class HostInfo {
             catch (err) {
                 this.$logger.trace(`Unable to get macOS version from ${systemProfileCommand}. Error is: ${err}`);
             }
+            // https://en.wikipedia.org/wiki/Darwin_(operating_system)#Release_history
+            // Each macOS version is labeled 10.<version>, where it looks like <versions> is taken from the major version returned by os.release() (16.x.x for example) and subtracting 4 from it.
+            // So the version becomes "10.12" in this case.
             const osRelease = this.$osInfo.release();
             const majorVersion = osRelease && _.first(osRelease.split("."));
             macOSVersion = majorVersion && `10.${+majorVersion - 4}`;
@@ -131,3 +134,4 @@ __decorate([
 ], HostInfo.prototype, "getMacOSVersion", null);
 exports.HostInfo = HostInfo;
 yok_1.injector.register("hostInfo", HostInfo);
+//# sourceMappingURL=host-info.js.map

package/lib/common/http-client.js

@@ -36,6 +36,9 @@ class HttpClient {
             catch (err) {
                 if (err.message === HttpClient.STUCK_REQUEST_ERROR_MESSAGE ||
                     err.message === HttpClient.STUCK_RESPONSE_ERROR_MESSAGE) {
+                    // Retry the request immediately because there are at least 10 seconds between the two requests.
+                    // We have to retry only once the sporadically stuck requests/responses.
+                    // We can add exponential backoff retry here if we decide that we need to workaround bigger network issues on the client side.
                     this.$logger.warn("%s Retrying request to %s...", err.message, options.url || options);
                     const retryResult = yield this.httpRequestCore(options, proxySettings);
                     return {
@@ -63,6 +66,7 @@ class HttpClient {
             yield this.useProxySettings(proxySettings, cliProxySettings, options, headers, requestProto);
             if (!headers["User-Agent"]) {
                 if (!this.defaultUserAgent) {
+                    //TODO: the user agent client name is also passed explicitly during login and should be kept in sync
                     this.defaultUserAgent = `${this.$staticConfig.USER_AGENT_NAME}/${this.$staticConfig.version} (Node.js ${process.versions.node}; ${process.platform}; ${process.arch})`;
                     this.$logger.trace("User-Agent: %s", this.defaultUserAgent);
                 }
@@ -91,14 +95,19 @@ class HttpClient {
             }).catch((err) => {
                 this.$logger.trace("An error occurred while sending the request:", err);
                 if (err.response) {
+                    // The request was made and the server responded with a status code
+                    // that falls out of the range of 2xx
                     const errorMessage = this.getErrorMessage(err.response.status, null);
                     err.proxyAuthenticationRequired =
                         err.response.status === constants_1.HttpStatusCodes.PROXY_AUTHENTICATION_REQUIRED;
                     err.message = errorMessage || err.message;
                 }
                 else if (err.request) {
+                    // The request was made but no response was received
+                    // `err.request` is an instance of XMLHttpRequest in the browser and an instance of
                 }
                 else {
+                    // Something happened in setting up the request that triggered an Error
                 }
                 throw err;
             });
@@ -145,9 +154,18 @@ class HttpClient {
             return body;
         }
     }
+    /**
+     * This method respects the proxySettings (or proxyCache) by modifying headers and options passed to http(s) module.
+     * @param {IProxySettings} proxySettings The settings passed for this specific call.
+     * @param {IProxySettings} cliProxySettings The globally set proxy for this CLI.
+     * @param {any}options The object that will be passed to http(s) module.
+     * @param {any} headers Headers of the current request.
+     * @param {string} requestProto The protocol used for the current request - http or https.
+     */
     useProxySettings(proxySettings, cliProxySettings, options, headers, requestProto) {
         return __awaiter(this, void 0, void 0, function* () {
             const isLocalRequest = options.host === "localhost" || options.host === "127.0.0.1";
+            // don't use the proxy for requests to localhost
             if (!isLocalRequest && (proxySettings || cliProxySettings)) {
                 const proto = (proxySettings && proxySettings.protocol) ||
                     cliProxySettings.protocol ||
@@ -158,6 +176,7 @@ class HttpClient {
                 if (cliProxySettings.username && cliProxySettings.password) {
                     credentialsPart = `${cliProxySettings.username}:${cliProxySettings.password}@`;
                 }
+                // Note that proto ends with :
                 options.proxy = `${proto}//${credentialsPart}${host}:${port}`;
                 options.rejectUnauthorized = proxySettings
                     ? proxySettings.rejectUnauthorized
@@ -171,3 +190,4 @@ HttpClient.STUCK_REQUEST_ERROR_MESSAGE = "The request can't receive any response
 HttpClient.STUCK_RESPONSE_ERROR_MESSAGE = "Can't receive all parts of the response.";
 exports.HttpClient = HttpClient;
 yok_1.injector.register("httpClient", HttpClient);
+//# sourceMappingURL=http-client.js.map