nativescript 8.9.3 → 8.9.4-sap.0

package/lib/services/android-project-service.js

@@ -18,7 +18,40 @@ const constants_1 = require("../common/constants");
 const helpers_1 = require("../common/helpers");
 const decorators_1 = require(".././common/decorators");
 const yok_1 = require("../common/yok");
-function topologicalSortNativeDependencies(dependencies, start = [], depth = 0, total = 0) {
+//
+// we sort the native dependencies topologically to make sure they are processed in the right order
+// native dependenciess need to be sorted so the deepst dependencies are built before it's parents
+//
+// for example, given this dep structure (assuming these are all native dependencies that need to be built)
+// (note: we list all dependencies at the root level, so the leaf nodes are essentially references to the root nodes)
+//
+//   |- dep1
+//   |- dep2
+//   |- |- dep3
+//   |- |- dep4
+//   |- |- |- dep5
+//   |- dep3
+//   |- dep4
+//   |- |- dep5
+//   |- dep5
+//
+// It is sorted:
+//
+//   |- dep1
+//   |- dep3
+//   |- dep5
+//   |- dep4        # depends on dep5, so dep5 must be built first, ie above ^
+//   |- |- dep5
+//   |- dep2        # depends on dep3, dep4 (and dep5 through dep4) so all of them must be built first before dep2 is built
+//   |- |- dep3
+//   |- |- dep4
+//   |- |- |- dep5
+//
+// for more details see: https://wikiless.org/wiki/Topological_sorting?lang=en
+//
+function topologicalSortNativeDependencies(dependencies, start = [], depth = 0, total = 0 // do not pass in, we calculate it in the initial run!
+) {
+    // we set the total on the initial call - and never increment it, as it's used for esacaping the recursion
     if (total === 0) {
         total = dependencies.length;
     }
@@ -32,6 +65,8 @@ function topologicalSortNativeDependencies(dependencies, start = [], depth = 0,
         return sortedDeps;
     }, start);
     const remainingDeps = dependencies.filter((nativeDep) => !sortedDeps.includes(nativeDep));
+    // recurse if we still have remaining deps
+    // the second condition here prevents infinite recursion
     if (remainingDeps.length && sortedDeps.length < total) {
         return topologicalSortNativeDependencies(remainingDeps, sortedDeps, depth + 1, total);
     }
@@ -85,7 +120,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
                 constants.APK_DIR,
             ];
             const packageName = this.getProjectNameFromId(projectData);
-            const runtimePackage = this.$projectDataService.getRuntimePackage(projectData.projectDir, "android");
+            const runtimePackage = this.$projectDataService.getRuntimePackage(projectData.projectDir, "android" /* constants.PlatformTypes.android */);
             this._platformData = {
                 frameworkPackageName: runtimePackage.name,
                 normalizedPlatformName: "Android",
@@ -126,7 +161,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
                 configurationFileName: constants.MANIFEST_FILE_NAME,
                 configurationFilePath: path.join(...configurationsDirectoryArr),
                 relativeToFrameworkConfigurationFilePath: path.join(constants.SRC_DIR, constants.MAIN_DIR, constants.MANIFEST_FILE_NAME),
-                fastLivesyncFileExtensions: [".jpg", ".gif", ".png", ".bmp", ".webp"],
+                fastLivesyncFileExtensions: [".jpg", ".gif", ".png", ".bmp", ".webp"], // http://developer.android.com/guide/appendix/media-formats.html
             };
         }
         return this._platformData;
@@ -176,6 +211,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         const targetSdkVersion = androidToolsInfo && androidToolsInfo.targetSdkVersion;
         this.$logger.trace(`Using Android SDK '${targetSdkVersion}'.`);
         this.copy(this.getPlatformData(projectData).projectRoot, frameworkDir, "*", "-R");
+        // TODO: Check if we actually need this and if it should be targetSdk or compileSdk
         this.cleanResValues(targetSdkVersion, projectData);
     }
     getResDestinationDir(projectData) {
@@ -207,6 +243,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         _.map(directoriesToClean, (dir) => this.$fs.deleteDirectory(dir));
     }
     async interpolateData(projectData) {
+        // Interpolate the apilevel and package
         this.interpolateConfigurationFile(projectData);
         const appResourcesDirectoryPath = projectData.getAppResourcesDirectoryPath();
         let stringsFilePath;
@@ -222,8 +259,10 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         const gradleSettingsFilePath = path.join(this.getPlatformData(projectData).projectRoot, "settings.gradle");
         shell.sed("-i", /__PROJECT_NAME__/, this.getProjectNameFromId(projectData), gradleSettingsFilePath);
         try {
+            // will replace applicationId in app/App_Resources/Android/app.gradle if it has not been edited by the user
             const appGradleContent = this.$fs.readText(projectData.appGradlePath);
             if (appGradleContent.indexOf(constants.PACKAGE_PLACEHOLDER_NAME) !== -1) {
+                //TODO: For compatibility with old templates. Once all templates are updated should delete.
                 shell.sed("-i", new RegExp(constants.PACKAGE_PLACEHOLDER_NAME), projectData.projectIdentifiers.android, projectData.appGradlePath);
             }
         }
@@ -274,6 +313,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         return [".jar", ".dat"];
     }
     async prepareProject() {
+        // Intentionally left empty.
     }
     ensureConfigurationFileInAppResources(projectData) {
         const appResourcesDirectoryPath = projectData.appResourcesDirectoryPath;
@@ -290,6 +330,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
             this.$logger.warn("No manifest found in " + originalAndroidManifestFilePath);
             return;
         }
+        // Overwrite the AndroidManifest from runtime.
         if (!appResourcesDirStructureHasMigrated) {
             this.$fs.copyFile(originalAndroidManifestFilePath, this.getPlatformData(projectData).configurationFilePath);
         }
@@ -306,6 +347,8 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         }
         else {
             this.$fs.copyFile(path.join(projectAppResourcesPath, platformData.normalizedPlatformName, "*"), platformsAppResourcesPath);
+            // https://github.com/NativeScript/android-runtime/issues/899
+            // App_Resources/Android/libs is reserved to user's aars and jars, but they should not be copied as resources
             this.$fs.deleteDirectory(path.join(platformsAppResourcesPath, "libs"));
         }
         const androidToolsInfo = this.$androidToolsInfo.getToolsInfo({
@@ -315,6 +358,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         this.cleanResValues(compileSdkVersion, projectData);
     }
     async preparePluginNativeCode(pluginData, projectData) {
+        // build Android plugins which contain AndroidManifest.xml and/or resources
         const pluginPlatformsFolderPath = this.getPluginPlatformsFolderPath(pluginData, AndroidProjectService.ANDROID_PLATFORM_NAME);
         if (this.$fs.exists(pluginPlatformsFolderPath)) {
             const options = {
@@ -336,6 +380,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         return;
     }
     async removePluginNativeCode(pluginData, projectData) {
+        // not implemented
     }
     async beforePrepareAllPlugins(projectData, dependencies) {
         if (dependencies) {
@@ -349,6 +394,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
     filterUniqueDependencies(dependencies) {
         const depsDictionary = dependencies.reduce((dict, dep) => {
             const collision = dict[dep.name];
+            // in case there are multiple dependencies to the same module, the one declared in the package.json takes precedence
             if (!collision || collision.depth > dep.depth) {
                 dict[dep.name] = dep;
             }
@@ -367,6 +413,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
                 name,
                 directory: path.relative(platformDir, directory),
                 dependencies: dependencies.filter((dep) => {
+                    // filter out transient dependencies that don't have native dependencies
                     return (nativeDependencyData.findIndex((nativeDep) => nativeDep.name === dep) !== -1);
                 }),
             };
@@ -374,6 +421,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         nativeDependencies = topologicalSortNativeDependencies(nativeDependencies);
         const jsonContent = JSON.stringify(nativeDependencies, null, 4);
         this.$fs.writeFile(dependenciesJsonPath, jsonContent);
+        // we sort all the dependencies to respect the topological sorting of the native dependencies
         return dependencies.sort(function (a, b) {
             return (nativeDependencies.findIndex((n) => n.name === a.name) -
                 nativeDependencies.findIndex((n) => n.name === b.name));
@@ -405,6 +453,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         await adb.executeShellCommand(["rm", "-rf", deviceRootPath]);
     }
     async checkForChanges() {
+        // Nothing android specific to check yet.
     }
     getDeploymentTarget(projectData) {
         return;
@@ -414,9 +463,12 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         shell.cp(cpArg, paths, projectRoot);
     }
     validatePackageName(packageName) {
+        //Make the package conform to Java package types
+        //Enforce underscore limitation
         if (!/^[a-zA-Z]+(\.[a-zA-Z0-9][a-zA-Z0-9_]*)+$/.test(packageName)) {
             this.$errors.fail(`Package name must look like: com.company.Name. Got: ${packageName}`);
         }
+        //Class is a reserved word
         if (/\b[Cc]lass\b/.test(packageName)) {
             this.$errors.fail("class is a reserved word");
         }
@@ -425,6 +477,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         if (projectName === "") {
             this.$errors.fail("Project name cannot be empty");
         }
+        //Classes in Java don't begin with numbers
         if (/^[0-9]/.test(projectName)) {
             this.$errors.fail("Project name must not begin with a number");
         }
@@ -445,6 +498,19 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
         ];
         return path.join(this.getPlatformData(projectData).projectRoot, ...resourcePath);
     }
+    /**
+     * The purpose of this method is to delete the previously prepared user resources.
+     * The content of the `<platforms>/android/.../res` directory is based on user's resources and gradle project template from android-runtime.
+     * During preparation of the `<path to user's App_Resources>/Android` we want to clean all the users files from previous preparation,
+     * but keep the ones that were introduced during `platform add` of the android-runtime.
+     * Currently the Gradle project template contains resources only in values and values-v21 directories.
+     * So the current logic of the method is cleaning al resources from `<platforms>/android/.../res` that are not in `values.*` directories
+     * and that exist in the `<path to user's App_Resources>/Android/.../res` directory
+     * This means that if user has a resource file in values-v29 for example, builds the project and then deletes this resource,
+     * it will be kept in platforms directory. Reference issue: `https://github.com/NativeScript/nativescript-cli/issues/5083`
+     * Same is valid for files in `drawable-<resolution>` directories - in case in user's resources there's drawable-hdpi directory,
+     * which is deleted after the first build of app, it will remain in platforms directory.
+     */
     cleanUpPreparedResources(projectData) {
         let resourcesDirPath = path.join(projectData.appResourcesDirectoryPath, this.getPlatformData(projectData).normalizedPlatformName);
         if (this.$androidResourcesMigrationService.hasMigrated(projectData.appResourcesDirectoryPath)) {
@@ -469,7 +535,7 @@ class AndroidProjectService extends projectServiceBaseLib.PlatformProjectService
                 const hasUseKotlinPropertyInAppData = `hasUseKotlinPropertyInApp${analyticsDelimiter}${buildStatistics.kotlinUsage.hasUseKotlinPropertyInApp}`;
                 const hasKotlinRuntimeClassesData = `hasKotlinRuntimeClasses${analyticsDelimiter}${buildStatistics.kotlinUsage.hasKotlinRuntimeClasses}`;
                 await this.$analyticsService.trackEventActionInGoogleAnalytics({
-                    action: "Using Kotlin",
+                    action: "Using Kotlin" /* constants.TrackActionNames.UsingKotlin */,
                     additionalData: `${hasUseKotlinPropertyInAppData}${analyticsDelimiter}${hasKotlinRuntimeClassesData}`,
                 });
             }
@@ -502,3 +568,4 @@ __decorate([
     (0, helpers_1.hook)("buildAndroid")
 ], AndroidProjectService.prototype, "buildProject", null);
 yok_1.injector.register("androidProjectService", AndroidProjectService);
+//# sourceMappingURL=android-project-service.js.map

package/lib/services/android-resources-migration-service.js

@@ -46,6 +46,7 @@ class AndroidResourcesMigrationService {
         const appResourcesMainSourceSetResourcesDestination = path.join(appMainSourceSet, constants.RESOURCES_DIR);
         this.$fs.ensureDirectoryExists(appResourcesDestination);
         this.$fs.ensureDirectoryExists(appMainSourceSet);
+        // create /java, /res and /assets in the App_Resources/Android/src/main directory
         this.$fs.ensureDirectoryExists(appResourcesMainSourceSetResourcesDestination);
         this.$fs.ensureDirectoryExists(path.join(appMainSourceSet, "java"));
         this.$fs.ensureDirectoryExists(path.join(appMainSourceSet, constants.ASSETS_DIR));
@@ -59,20 +60,25 @@ class AndroidResourcesMigrationService {
         const resourceFiles = getFiles(appResourcesFiles);
         resourceDirectories.forEach((dir) => {
             if (path.basename(dir) !== "libs") {
+                // don't copy /App_Resources/Android/libs into the src/main/res/libs directory
                 this.$fs.copyFile(dir, appResourcesMainSourceSetResourcesDestination);
             }
             else {
+                // copy App_Resources/Android/libs to App_ResourcesNew/Android/libs
                 this.$fs.copyFile(dir, path.join(appResourcesDestination));
             }
         });
         resourceFiles.forEach((file) => {
             const fileName = path.basename(file);
             if (fileName !== constants.MANIFEST_FILE_NAME) {
+                // don't copy AndroidManifest into /App_Resources/Android as it needs to be inside src/main/
                 this.$fs.copyFile(file, path.join(appResourcesDestination, fileName));
             }
         });
         this.$fs.copyFile(path.join(originalAppResources, constants.MANIFEST_FILE_NAME), path.join(appMainSourceSet, constants.MANIFEST_FILE_NAME));
+        // rename the legacy app_resources to ANDROID_DIR_OLD
         this.$fs.rename(originalAppResources, appResourcesBackup);
+        // move the new, updated app_resources to App_Resources/Android, as  the de facto resources
         this.$fs.rename(appResourcesDestination, originalAppResources);
     }
     recover(originalAppResources, appResourcesDestination, appResourcesBackup) {
@@ -89,3 +95,4 @@ AndroidResourcesMigrationService.ANDROID_DIR = "Android";
 AndroidResourcesMigrationService.ANDROID_DIR_TEMP = "Android-Updated";
 AndroidResourcesMigrationService.ANDROID_DIR_OLD = "Android-Pre-v4";
 yok_1.injector.register("androidResourcesMigrationService", AndroidResourcesMigrationService);
+//# sourceMappingURL=android-resources-migration-service.js.map

package/lib/services/apple-portal/apple-portal-application-service.js

@@ -63,3 +63,4 @@ class ApplePortalApplicationService {
 }
 exports.ApplePortalApplicationService = ApplePortalApplicationService;
 yok_1.injector.register("applePortalApplicationService", ApplePortalApplicationService);
+//# sourceMappingURL=apple-portal-application-service.js.map

package/lib/services/apple-portal/apple-portal-cookie-service.js

@@ -51,3 +51,4 @@ class ApplePortalCookieService {
 }
 exports.ApplePortalCookieService = ApplePortalCookieService;
 yok_1.injector.register("applePortalCookieService", ApplePortalCookieService);
+//# sourceMappingURL=apple-portal-cookie-service.js.map

package/lib/services/apple-portal/apple-portal-session-service.js

@@ -201,10 +201,10 @@ For more details how to set up your environment, please execute "ns publish ios
         const data = JSON.parse(authResponse.body);
         const isSMS = data.trustedPhoneNumbers &&
             data.trustedPhoneNumbers.length === 1 &&
-            data.noTrustedDevices;
+            data.noTrustedDevices; // 1 device and no trusted devices means sms was automatically sent.
         const multiSMS = data.trustedPhoneNumbers &&
             data.trustedPhoneNumbers.length !== 1 &&
-            data.noTrustedDevices;
+            data.noTrustedDevices; // Not handling more than 1 sms device and no trusted devices.
         let token;
         if (data.trustedPhoneNumbers &&
             data.trustedPhoneNumbers.length &&
@@ -218,6 +218,7 @@ For more details how to set up your environment, please execute "ns publish ios
             };
             let url = `https://idmsa.apple.com/appleauth/auth/verify/trusteddevice/securitycode`;
             if (isSMS) {
+                // No trusted devices means it must be sms.
                 body.mode = "sms";
                 body.phoneNumber = {
                     id: data.trustedPhoneNumbers[0].id,
@@ -280,8 +281,9 @@ function checkBits(bits, digest) {
     return result;
 }
 function checkBit(position, buffer) {
-    const bitOffset = position & 7;
-    const byteIndex = position >> 3;
+    const bitOffset = position & 7; // in byte
+    const byteIndex = position >> 3; // in buffer
     const bit = (buffer[byteIndex] >> bitOffset) & 1;
     return bit === 0;
 }
+//# sourceMappingURL=apple-portal-session-service.js.map

package/lib/services/apple-portal/srp/srp-wrapper.js

@@ -28,7 +28,9 @@ class GSASRPAuthenticator {
     async getInit() {
         if (this.srpClient)
             throw new Error("Already initialized");
-        this.srpClient = await srp.newClient(stringToU8Array(this.username), new Uint8Array());
+        this.srpClient = await srp.newClient(stringToU8Array(this.username), 
+        // provide fake passsword because we need to get data from server
+        new Uint8Array());
         let a = Buffer.from(js_srp_1.util.bytesFromBigint(this.srpClient.A)).toString("base64");
         return {
             a,
@@ -59,3 +61,4 @@ class GSASRPAuthenticator {
     }
 }
 exports.GSASRPAuthenticator = GSASRPAuthenticator;
+//# sourceMappingURL=srp-wrapper.js.map

package/lib/services/assets-generation/assets-generation-service.js

@@ -82,7 +82,7 @@ class AssetsGenerationService {
                 }
                 continue;
             }
-            const operation = assetItem.resizeOperation || "resize";
+            const operation = assetItem.resizeOperation || "resize" /* Operations.Resize */;
             let tempScale = null;
             if (assetItem.scale) {
                 if (_.isNumber(assetItem.scale)) {
@@ -107,27 +107,31 @@ class AssetsGenerationService {
             }
             let image;
             switch (operation) {
-                case "overlayWith":
+                case "overlayWith" /* Operations.OverlayWith */:
                     const overlayImageScale = assetItem.overlayImageScale ||
                         constants_1.AssetConstants.defaultOverlayImageScale;
                     const imageResize = Math.round(Math.min(width, height) * overlayImageScale);
                     image = await this.resize(generationData.imagePath, imageResize, imageResize);
                     image = this.generateImage(background, width, height, image);
                     break;
-                case "blank":
+                case "blank" /* Operations.Blank */:
                     image = this.generateImage(background, width, height);
                     break;
-                case "resize":
+                case "resize" /* Operations.Resize */:
                     image = await this.resize(generationData.imagePath, width, height);
                     break;
-                case "outerScale":
+                case "outerScale" /* Operations.OuterScale */:
+                    // Resize image without applying scale
                     image = await this.resize(generationData.imagePath, assetItem.width, assetItem.height);
+                    // The scale will apply to the underlying layer of the generated image
                     image = this.generateImage("#00000000", width, height, image);
                     break;
                 default:
                     throw new Error(`Invalid image generation operation: ${operation}`);
             }
+            // This code disables the alpha chanel, as some images for the Apple App Store must not have transparency.
             if (assetItem.rgba === false) {
+                // Add an underlying white layer
                 image = this.generateImage("#FFFFFF", image.width, image.height, image);
             }
             if (this.isAssetFilePath(outputPath)) {
@@ -181,3 +185,4 @@ __decorate([
     (0, decorators_1.exported)("assetsGenerationService")
 ], AssetsGenerationService.prototype, "generateSplashScreens", null);
 yok_1.injector.register("assetsGenerationService", AssetsGenerationService);
+//# sourceMappingURL=assets-generation-service.js.map

package/lib/services/build-artifacts-service.js

@@ -64,7 +64,7 @@ class BuildArtifactsService {
         if (packages.length > 1) {
             this.$logger.warn(`More than one ${packageExtName} found in ${buildOutputPath} directory. Using the last one produced from build.`);
         }
-        packages = _.sortBy(packages, (pkg) => pkg.time).reverse();
+        packages = _.sortBy(packages, (pkg) => pkg.time).reverse(); // We need to reverse because sortBy always sorts in ascending order
         return packages[0];
     }
     getApplicationPackagesCore(candidates, validPackageNames) {
@@ -85,3 +85,4 @@ class BuildArtifactsService {
 }
 exports.BuildArtifactsService = BuildArtifactsService;
 yok_1.injector.register("buildArtifactsService", BuildArtifactsService);
+//# sourceMappingURL=build-artifacts-service.js.map

package/lib/services/build-data-service.js

@@ -18,3 +18,4 @@ class BuildDataService {
 }
 exports.BuildDataService = BuildDataService;
 yok_1.injector.register("buildDataService", BuildDataService);
+//# sourceMappingURL=build-data-service.js.map

package/lib/services/build-info-file-service.js

@@ -62,3 +62,4 @@ class BuildInfoFileService {
 }
 exports.BuildInfoFileService = BuildInfoFileService;
 yok_1.injector.register("buildInfoFileService", BuildInfoFileService);
+//# sourceMappingURL=build-info-file-service.js.map

package/lib/services/cleanup-service.js

@@ -20,56 +20,56 @@ class CleanupService {
     async addCleanupCommand(commandInfo) {
         const cleanupProcess = await this.getCleanupProcess();
         cleanupProcess.send({
-            messageType: "AddCleanCommand",
+            messageType: "AddCleanCommand" /* CleanupProcessMessage.AddCleanCommand */,
             commandInfo,
         });
     }
     async removeCleanupCommand(commandInfo) {
         const cleanupProcess = await this.getCleanupProcess();
         cleanupProcess.send({
-            messageType: "RemoveCleanCommand",
+            messageType: "RemoveCleanCommand" /* CleanupProcessMessage.RemoveCleanCommand */,
             commandInfo,
         });
     }
     async addRequest(requestInfo) {
         const cleanupProcess = await this.getCleanupProcess();
         cleanupProcess.send({
-            messageType: "AddRequest",
+            messageType: "AddRequest" /* CleanupProcessMessage.AddRequest */,
             requestInfo,
         });
     }
     async removeRequest(requestInfo) {
         const cleanupProcess = await this.getCleanupProcess();
         cleanupProcess.send({
-            messageType: "RemoveRequest",
+            messageType: "RemoveRequest" /* CleanupProcessMessage.RemoveRequest */,
             requestInfo,
         });
     }
     async addCleanupDeleteAction(filePath) {
         const cleanupProcess = await this.getCleanupProcess();
         cleanupProcess.send({
-            messageType: "AddDeleteFileAction",
+            messageType: "AddDeleteFileAction" /* CleanupProcessMessage.AddDeleteFileAction */,
             filePath,
         });
     }
     async removeCleanupDeleteAction(filePath) {
         const cleanupProcess = await this.getCleanupProcess();
         cleanupProcess.send({
-            messageType: "RemoveDeleteFileAction",
+            messageType: "RemoveDeleteFileAction" /* CleanupProcessMessage.RemoveDeleteFileAction */,
             filePath,
         });
     }
     async addCleanupJS(jsCommand) {
         const cleanupProcess = await this.getCleanupProcess();
         cleanupProcess.send({
-            messageType: "AddJSFileToRequire",
+            messageType: "AddJSFileToRequire" /* CleanupProcessMessage.AddJSFileToRequire */,
             jsCommand,
         });
     }
     async removeCleanupJS(jsCommand) {
         const cleanupProcess = await this.getCleanupProcess();
         cleanupProcess.send({
-            messageType: "RemoveJSFileToRequire",
+            messageType: "RemoveJSFileToRequire" /* CleanupProcessMessage.RemoveJSFileToRequire */,
             jsCommand,
         });
     }
@@ -92,6 +92,8 @@ class CleanupService {
     setShouldDispose(shouldDispose) {
         this.shouldDispose = shouldDispose;
     }
+    // TODO: Consider extracting this method to a separate service
+    // as it has the same logic as the one used in analytics-service
     getCleanupProcess() {
         return new Promise((resolve, reject) => {
             const cleanupProcessArgs = this.getCleanupProcessArgs();
@@ -110,11 +112,12 @@ class CleanupService {
                 clearTimeout(timeoutId);
                 if (!isSettled) {
                     isSettled = true;
+                    // In case we throw error here, CLI will break its execution.
                     reject(err);
                 }
             });
             cleanupProcess.on("message", (data) => {
-                if (data === "ProcessReadyToReceive") {
+                if (data === "ProcessReadyToReceive" /* DetachedProcessMessages.ProcessReadyToReceive */) {
                     clearTimeout(timeoutId);
                     if (!isSettled) {
                         isSettled = true;
@@ -163,3 +166,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], CleanupService.prototype, "getCleanupProcess", null);
 yok_1.injector.register("cleanupService", CleanupService);
+//# sourceMappingURL=cleanup-service.js.map

package/lib/services/cocoapods-platform-manager.js

@@ -82,6 +82,7 @@ class CocoaPodsPlatformManager {
         _.each(allPodfiles, (podfileContent) => {
             const platformMatch = platformRowRegExp.exec(podfileContent);
             const podfilePathMatch = podfilePathRegExp.exec(podfileContent) || [];
+            // platform without version -> select it with highest priority
             if (platformMatch && platformMatch[0] && !platformMatch[2]) {
                 selectedPlatformData = {
                     version: null,
@@ -90,6 +91,7 @@ class CocoaPodsPlatformManager {
                 };
                 return false;
             }
+            // platform with version
             if (platformMatch && platformMatch[0] && platformMatch[2]) {
                 if (!selectedPlatformData ||
                     semver.gt(semver.coerce(platformMatch[2]), semver.coerce(selectedPlatformData.version))) {
@@ -104,6 +106,12 @@ class CocoaPodsPlatformManager {
         return selectedPlatformData;
     }
     shouldReplacePlatformSection(projectData, oldPodfilePlatformData, currentPodfilePlatformData) {
+        // The selected platform should be replaced in the following cases:
+        // 1. When the pod file is from App_Resources and the selected platform is not from App_Resources
+        // 2. When the pod file is from App_Resources, the selected platform is also from App_Resources
+        // and the pod's version is greater than the selected one
+        // 3. When the pod file doesn't have platform's version -> `platform :ios`
+        // 4. When the pod file has a version greater than the selected platform's version
         const appResourcesPodfilePath = path.join(projectData.getAppResourcesDirectoryPath(), "iOS", constants_1.PODFILE_NAME);
         const isFromAppResources = oldPodfilePlatformData.path !== appResourcesPodfilePath &&
             currentPodfilePlatformData.path === appResourcesPodfilePath;
@@ -135,3 +143,4 @@ class CocoaPodsPlatformManager {
 }
 exports.CocoaPodsPlatformManager = CocoaPodsPlatformManager;
 yok_1.injector.register("cocoaPodsPlatformManager", CocoaPodsPlatformManager);
+//# sourceMappingURL=cocoapods-platform-manager.js.map

package/lib/services/cocoapods-service.js

@@ -34,6 +34,12 @@ class CocoaPodsService {
         let podTool = this.$config.USE_POD_SANDBOX ? "sandbox-pod" : "pod";
         const args = ["install"];
         if (process.platform === "darwin" && process.arch === "arm64") {
+            // check if pod is installed as an x86_64 binary or a native arm64 one
+            // we run the following:
+            // arch -x86_64 pod --version
+            // if it's an arm64 binary, we'll get something like this as a result:
+            // arch: posix_spawnp: pod: Bad CPU type in executable
+            // in which case, we should run it natively.
             const res = await this.$childProcess
                 .exec("arch -x86_64 pod --version", null, {
                 showStderr: true,
@@ -47,8 +53,11 @@ class CocoaPodsService {
                 podTool = "arch";
             }
         }
+        // cocoapods print a lot of non-error information on stderr. Pipe the `stderr` to `stdout`, so we won't polute CLI's stderr output.
         const podInstallResult = await this.$childProcess.spawnFromEvent(podTool, args, "close", { cwd: projectRoot, stdio: ["pipe", process.stdout, process.stdout] }, { throwError: false });
         if (podInstallResult.exitCode !== 0) {
+            // https://github.com/CocoaPods/CocoaPods/blob/92aaf0f1120d32f3487960b485fb69fcaf61486c/lib/cocoapods/resolver.rb#L498
+            // TODO add article
             const versionResolutionHint = podInstallResult.exitCode === 31
                 ? `For more information on resolving CocoaPod issues in NativeScript read.`
                 : "";
@@ -80,6 +89,7 @@ ${versionResolutionHint}`);
     }
     async applyPodfileArchExclusions(projectData, platformData) {
         const xcodeVersionData = await this.$xcodeSelectService.getXcodeVersion();
+        // only apply EXCLUDED_ARCHS workaround on XCode 12
         if (+xcodeVersionData.major !== 12) {
             return;
         }
@@ -98,6 +108,7 @@ end`.trim();
             this.$fs.writeFile(exclusionsPodfile, exclusions);
         }
         await this.applyPodfileToProject("NativeScript-CLI-Architecture-Exclusions", exclusionsPodfile, projectData, platformData);
+        // clean up
         this.$fs.deleteFile(exclusionsPodfile);
     }
     async applyPodfileFromExtensions(projectData, platformData) {
@@ -120,6 +131,7 @@ end`.trim();
             podfilePath: path.join(extensionFolderPath, name, constants.PODFILE_NAME),
         }));
         extensionsPodfile.forEach(({ targetName, podfilePath }) => {
+            // Remove the data between #Begin Podfile and #EndPodfile
             const regExpToRemove = new RegExp(`${this.getExtensionPodfileHeader(podfilePath, targetName)}[\\s\\S]*?${this.getExtensionPodfileEnd()}`, "mg");
             projectPodFileContent = projectPodFileContent.replace(regExpToRemove, "");
             if (this.$fs.exists(podfilePath)) {
@@ -146,6 +158,7 @@ end`.trim();
             ? this.$fs.readText(pathToProjectPodfile).trim()
             : "";
         if (projectPodfileContent.indexOf(podfileContent) === -1) {
+            // Remove old occurences of the plugin from the project's Podfile.
             this.removePodfileFromProject(moduleName, podfilePath, projectData, nativeProjectPath);
             let finalPodfileContent = this.$fs.exists(pathToProjectPodfile)
                 ? this.getPodfileContentWithoutTarget(projectData, this.$fs.readText(pathToProjectPodfile))
@@ -163,6 +176,7 @@ end`.trim();
     removePodfileFromProject(moduleName, podfilePath, projectData, projectRoot) {
         if (this.$fs.exists(this.getProjectPodfilePath(projectRoot))) {
             let projectPodFileContent = this.$fs.readText(this.getProjectPodfilePath(projectRoot));
+            // Remove the data between #Begin Podfile and #EndPodfile
             const regExpToRemove = new RegExp(`${this.getPluginPodfileHeader(podfilePath)}[\\s\\S]*?${this.getPluginPodfileEnd()}`, "mg");
             projectPodFileContent = projectPodFileContent.replace(regExpToRemove, "");
             projectPodFileContent = this.removePostInstallHook(moduleName, projectPodFileContent);
@@ -183,7 +197,7 @@ end`.trim();
         }
     }
     getPluginPodfilePath(pluginData) {
-        const pluginPlatformsFolderPath = pluginData.pluginPlatformsFolderPath("ios");
+        const pluginPlatformsFolderPath = pluginData.pluginPlatformsFolderPath("ios" /* PlatformTypes.ios */);
         const pluginPodFilePath = path.join(pluginPlatformsFolderPath, constants_1.PODFILE_NAME);
         return pluginPodFilePath;
     }
@@ -219,6 +233,7 @@ end`.trim();
         if (_.startsWith(projectPodfileContent, podFileHeader)) {
             projectPodfileContent = projectPodfileContent.substr(podFileHeader.length);
             const podFileFooter = this.getPodfileFooter();
+            // Only remove the final end in case the file starts with the podFileHeader
             if (_.endsWith(projectPodfileContent, podFileFooter)) {
                 projectPodfileContent = projectPodfileContent.substr(0, projectPodfileContent.length - podFileFooter.length);
             }
@@ -239,6 +254,8 @@ end`.trim();
         return projectPodFileContent;
     }
     getHookBasicFuncNameForPlugin(hookName, pluginName) {
+        // nativescript-hook and nativescript_hook should have different names, so replace all _ with ___ first and then replace all special symbols with _
+        // This will lead to a clash in case plugins are called nativescript-hook and nativescript___hook
         const replacedPluginName = pluginName
             .replace(/_/g, "___")
             .replace(/[^A-Za-z0-9_]/g, "_");
@@ -252,6 +269,7 @@ end`.trim();
             const newFunctionName = `${this.getHookBasicFuncNameForPlugin(hookName, pluginName)}_${newFunctions.length}`;
             let newDefinition = `def ${newFunctionName}`;
             const rubyFunction = { functionName: newFunctionName };
+            // firstGroup is the block parameter, secondGroup is the block parameter name.
             if (firstGroup && secondGroup) {
                 newDefinition = `${newDefinition} (${secondGroup})`;
                 rubyFunction.functionParameters = secondGroup;
@@ -262,6 +280,7 @@ end`.trim();
         return { replacedContent, newFunctions };
     }
     getPluginPodfileHeader(pluginPodFilePath) {
+        // escape special + from the podfile path (pnpm)
         pluginPodFilePath = pluginPodFilePath.replace(/\+/g, "\\+");
         return `# Begin Podfile - ${pluginPodFilePath}`;
     }
@@ -331,3 +350,4 @@ exports.CocoaPodsService = CocoaPodsService;
 CocoaPodsService.PODFILE_POST_INSTALL_SECTION_NAME = "post_install";
 CocoaPodsService.INSTALLER_BLOCK_PARAMETER_NAME = "installer";
 yok_1.injector.register("cocoapodsService", CocoaPodsService);
+//# sourceMappingURL=cocoapods-service.js.map

package/lib/services/debug-data-service.js

@@ -19,3 +19,4 @@ class DebugDataService {
 }
 exports.DebugDataService = DebugDataService;
 yok_1.injector.register("debugDataService", DebugDataService);
+//# sourceMappingURL=debug-data-service.js.map