nativescript 9.0.4-dev.1 → 9.0.4-dev.3

package/lib/services/extensibility-service.js

@@ -119,12 +119,17 @@ class ExtensibilityService {
         for (const extensionData of allExtensions) {
             const extensionName = extensionData.package.name;
             try {
+                // now get full package.json for the latest version of the package
                 const registryData = await this.$packageManager.getRegistryPackageData(extensionName);
                 const latestPackageData = registryData.versions[registryData["dist-tags"].latest];
                 const commands = latestPackageData &&
                     latestPackageData.nativescript &&
                     latestPackageData.nativescript.commands;
                 if (commands && commands.length) {
+                    // For each default command we need to add its short syntax in the array of commands.
+                    // For example in case there's a default command called devices list, the commands array will contain devices|*list.
+                    // However, in case the user executes just ns devices, CLI will still execute the ns devices list command.
+                    // So we need to add the devices command as well.
                     _.filter(commands, (command) => command.indexOf(inputOpts.defaultCommandDelimiter) !== -1).forEach((defaultCommand) => {
                         commands.push(defaultCommand.replace(defaultCommandRegExp, ""));
                     });
@@ -146,6 +151,7 @@ class ExtensibilityService {
                 }
             }
             catch (err) {
+                // We do not want to stop the whole process in case we are unable to find data for one of the extensions.
                 this.$logger.trace(`Unable to get data for ${extensionName}. Error is: ${err}`);
             }
         }
@@ -178,6 +184,7 @@ class ExtensibilityService {
         this.assertExtensionsDirExists();
         if (!this.$fs.exists(this.pathToPackageJson)) {
             this.$logger.trace(`Creating ${this.pathToPackageJson}.`);
+            // create default package.json
             this.$fs.writeJson(this.pathToPackageJson, {
                 name: "nativescript-extensibility",
                 version: "1.0.0",
@@ -199,3 +206,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], ExtensibilityService.prototype, "assertPackageJsonExists", null);
 yok_1.injector.register("extensibilityService", ExtensibilityService);
+//# sourceMappingURL=extensibility-service.js.map

package/lib/services/files-hash-service.js

@@ -61,3 +61,4 @@ class FilesHashService {
 }
 exports.FilesHashService = FilesHashService;
 yok_1.injector.register("filesHashService", FilesHashService);
+//# sourceMappingURL=files-hash-service.js.map

package/lib/services/hmr-status-service.js

@@ -56,6 +56,7 @@ class HmrStatusService {
             name: "failedLiveSync",
             platform: this.$devicePlatformsConstants.iOS.toLowerCase(),
         });
+        // webpack5
         const statusStringMap = {
             success: constants_1.HmrConstants.HMR_SUCCESS_STATUS,
             failure: constants_1.HmrConstants.HMR_ERROR_STATUS,
@@ -126,3 +127,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], HmrStatusService.prototype, "attachToHmrStatusEvent", null);
 yok_1.injector.register("hmrStatusService", HmrStatusService);
+//# sourceMappingURL=hmr-status-service.js.map

package/lib/services/info-service.js

@@ -12,3 +12,4 @@ class InfoService {
 }
 exports.InfoService = InfoService;
 yok_1.injector.register("infoService", InfoService);
+//# sourceMappingURL=info-service.js.map

package/lib/services/initialize-service.js

@@ -6,6 +6,8 @@ const _ = require("lodash");
 const constants_1 = require("../constants");
 const yok_1 = require("../common/yok");
 class InitializeService {
+    // NOTE: Do not inject anything here, use $injector.resolve in the code
+    // Injecting something may lead to logger initialization, but we want to initialize it from here.
     constructor($injector) {
         this.$injector = $injector;
     }
@@ -33,6 +35,7 @@ class InitializeService {
             }
         }
         if ($options.json) {
+            // speed up --json commands by not gathering system warnings...
             $logger.trace("Skipping system warnings for --json commands");
         }
         else {
@@ -44,7 +47,7 @@ class InitializeService {
         const systemWarnings = await $sysInfo.getSystemWarnings();
         _.each(systemWarnings, (systemWarning) => {
             const message = `${os_1.EOL}${systemWarning.message}${os_1.EOL}`;
-            if (systemWarning.severity === "high") {
+            if (systemWarning.severity === "high" /* SystemWarningsSeverity.high */) {
                 $logger.error(message);
             }
             else {
@@ -55,3 +58,4 @@ class InitializeService {
 }
 exports.InitializeService = InitializeService;
 yok_1.injector.register("initializeService", InitializeService);
+//# sourceMappingURL=initialize-service.js.map

package/lib/services/ios/export-options-plist-service.js

@@ -54,11 +54,13 @@ class ExportOptionsPlistService {
         plistTemplate += `
 </dict>
 </plist>`;
+        // Save the options...
         const exportOptionsPlistFilePath = await this.$tempService.path({
             prefix: "export-",
             suffix: ".plist",
         });
         this.$fs.writeFile(exportOptionsPlistFilePath, plistTemplate);
+        // The xcodebuild exportPath expects directory and writes the <project-name>.ipa at that directory.
         const exportFileDir = path.resolve(path.dirname(archivePath));
         const exportFilePath = path.join(exportFileDir, projectData.projectName + ".ipa");
         return { exportFileDir, exportFilePath, exportOptionsPlistFilePath };
@@ -96,6 +98,7 @@ class ExportOptionsPlistService {
     <false/>
 </dict>
 </plist>`;
+        // Save the options...
         const exportOptionsPlistFilePath = await this.$tempService.path({
             prefix: "export-",
             suffix: ".plist",
@@ -118,3 +121,4 @@ class ExportOptionsPlistService {
 }
 exports.ExportOptionsPlistService = ExportOptionsPlistService;
 yok_1.injector.register("exportOptionsPlistService", ExportOptionsPlistService);
+//# sourceMappingURL=export-options-plist-service.js.map

package/lib/services/ios/ios-signing-service.js

@@ -46,6 +46,7 @@ class IOSSigningService {
         let shouldUpdateXcode = false;
         if (signing && signing.style === "Automatic") {
             if (signing.team !== teamId) {
+                // Maybe the provided team is name such as "Telerik AD" and we need to convert it to CH******37
                 const teamIdsForName = await this.$iOSProvisionService.getTeamIdsWithName(teamId);
                 if (!teamIdsForName.some((id) => id === signing.team)) {
                     shouldUpdateXcode = true;
@@ -79,6 +80,7 @@ class IOSSigningService {
     }
     async setupSigningFromProvision(projectRoot, projectData, provision, mobileProvisionData) {
         if (!provision) {
+            // read uuid from Xcode an cache...
             return;
         }
         const xcode = this.$pbxprojDomXcode.Xcode.open(this.getPbxProjPath(projectData, projectRoot));
@@ -111,6 +113,7 @@ class IOSSigningService {
                 this.$logger.trace(`Set Manual signing style and provisioning profile: ${configuration.name} (${configuration.uuid})`);
             });
             xcode.save();
+            // this.cache(uuid);
         }
         else {
             this.$logger.trace(`The specified provisioning profile is already set in the Xcode: ${provision}`);
@@ -273,3 +276,4 @@ class IOSSigningService {
 }
 exports.IOSSigningService = IOSSigningService;
 yok_1.injector.register("iOSSigningService", IOSSigningService);
+//# sourceMappingURL=ios-signing-service.js.map

package/lib/services/ios/spm-service.js

@@ -15,7 +15,15 @@ class SPMService {
         const spmPackages = this.$projectConfigService.getValue(`${platform}.SPMPackages`, []);
         return spmPackages;
     }
+    /**
+     * Merges plugin SPM packages with app SPM packages.
+     * App packages take precedence over plugin packages with the same name.
+     * @param appPackages - Array of app SPM packages (modified in place)
+     * @param pluginPackages - Array of plugin SPM packages to merge
+     */
     mergePluginSPMPackages(appPackages, pluginPackages) {
+        // include swift packages from plugin configs
+        // but allow app packages to override plugin packages with the same name
         const appPackageNames = new Set(appPackages.map(pkg => pkg.name));
         for (const pluginPkg of pluginPackages) {
             if (appPackageNames.has(pluginPkg.name)) {
@@ -26,6 +34,10 @@ class SPMService {
             }
         }
     }
+    // note: this is not used anywhere at the moment.
+    // public hasSPMPackages(projectData: IProjectData): boolean {
+    // 	return this.getSPMPackages(projectData).length > 0;
+    // }
     async applySPMPackages(platformData, projectData, pluginSpmPackages) {
         var _a;
         try {
@@ -44,17 +56,21 @@ class SPMService {
                 enableAndroid: false,
             });
             await project.load();
+            // note: in trapeze both visionOS and iOS are handled by the ios project.
             if (!project.ios) {
                 this.$logger.trace("SPM: no iOS project found via trapeze.");
                 return;
             }
+            // todo: handle removing packages? Or just warn and require a clean?
             for (const pkg of spmPackages) {
                 if ("path" in pkg) {
+                    // resolve the path relative to the project root
                     this.$logger.trace("SPM: resolving path for package: ", pkg.path);
                     pkg.path = path.resolve(projectData.projectDir, pkg.path);
                 }
                 this.$logger.trace(`SPM: adding package ${pkg.name} to project.`, pkg);
                 await project.ios.addSPMPackage(projectData.projectName, pkg);
+                // Add to other Targets if specified (like widgets, etc.)
                 if ((_a = pkg.targets) === null || _a === void 0 ? void 0 : _a.length) {
                     for (const target of pkg.targets) {
                         await project.ios.addSPMPackage(target, pkg);
@@ -62,6 +78,7 @@ class SPMService {
                 }
             }
             await project.commit();
+            // finally resolve the dependencies
             await this.resolveSPMDependencies(platformData, projectData);
         }
         catch (err) {
@@ -83,3 +100,4 @@ class SPMService {
 }
 exports.SPMService = SPMService;
 yok_1.injector.register("spmService", SPMService);
+//# sourceMappingURL=spm-service.js.map

package/lib/services/ios/xcodebuild-args-service.js

@@ -72,11 +72,18 @@ class XcodebuildArgsService {
             .concat(architectures)
             .concat(this.getBuildCommonArgs(platformData, projectData, isvisionOS ? ios_project_service_1.VisionDevicePlatformSdkName : ios_project_service_1.DevicePlatformSdkName))
             .concat(this.getBuildLoggingArgs());
+        // pbxproj-dom sets CODE_SIGN_IDENTITY[sdk=iphoneos*] which doesn't match
+        // the xros SDK used by visionOS builds — pass it explicitly as an override
+        if (isvisionOS) {
+            args.push(`CODE_SIGN_IDENTITY=${buildConfig.release ? "Apple Distribution" : "Apple Development"}`);
+        }
         return args;
     }
     async getArchitecturesArgs(buildConfig) {
         const args = [];
         if (this.$devicePlatformsConstants.isvisionOS(buildConfig.platform)) {
+            // visionOS builds (device/simulator) are arm64-only; rely on destination for arch
+            // and explicitly exclude x86_64 to avoid accidental selection
             args.push("ONLY_ACTIVE_ARCH=YES", "EXCLUDED_ARCHS=x86_64");
             return args;
         }
@@ -90,6 +97,8 @@ class XcodebuildArgsService {
     }
     getXcodeProjectArgs(platformData, projectData) {
         const xcworkspacePath = path.join(platformData.projectRoot, `${projectData.projectName}.xcworkspace`);
+        // Introduced in Xcode 14+
+        // ref: https://forums.swift.org/t/telling-xcode-14-beta-4-to-trust-build-tool-plugins-programatically/59305/5
         const skipPackageValidation = "-skipPackagePluginValidation";
         const extraArgs = [
             "-scheme",
@@ -97,6 +106,12 @@ class XcodebuildArgsService {
             skipPackageValidation,
         ];
         const BUILD_SETTINGS_FILE_PATH = path.join(projectData.appResourcesDirectoryPath, platformData.normalizedPlatformName, constants.BUILD_XCCONFIG_FILE_NAME);
+        // Only include explicit properties from build.xcconfig
+        // Note: we could include entire file via -xcconfig flag
+        // however doing so introduces unwanted side effects
+        // like cocoapods issues related to ASSETCATALOG_COMPILER_APPICON_NAME
+        // references: https://medium.com/@iostechset/why-cocoapods-eats-app-icons-79fe729808d4
+        // https://github.com/CocoaPods/CocoaPods/issues/7003
         const deployTargetProperty = "IPHONEOS_DEPLOYMENT_TARGET";
         const deployTargetVersion = this.$xcconfigService.readPropertyValue(BUILD_SETTINGS_FILE_PATH, deployTargetProperty);
         if (deployTargetVersion) {
@@ -146,3 +161,4 @@ class XcodebuildArgsService {
 }
 exports.XcodebuildArgsService = XcodebuildArgsService;
 yok_1.injector.register("xcodebuildArgsService", XcodebuildArgsService);
+//# sourceMappingURL=xcodebuild-args-service.js.map

package/lib/services/ios/xcodebuild-command-service.js

@@ -27,3 +27,4 @@ class XcodebuildCommandService {
 }
 exports.XcodebuildCommandService = XcodebuildCommandService;
 yok_1.injector.register("xcodebuildCommandService", XcodebuildCommandService);
+//# sourceMappingURL=xcodebuild-command-service.js.map

package/lib/services/ios/xcodebuild-service.js

@@ -64,7 +64,7 @@ class XcodebuildService {
             output.exportFileDir,
             "-exportOptionsPlist",
             output.exportOptionsPlistFilePath,
-            provision ? "" : "-allowProvisioningUpdates",
+            provision ? "" : "-allowProvisioningUpdates", // no profiles specificed so let xcode decide.
         ];
         await this.$xcodebuildCommandService.executeCommand(args, {
             cwd: platformData.projectRoot,
@@ -74,3 +74,4 @@ class XcodebuildService {
 }
 exports.XcodebuildService = XcodebuildService;
 yok_1.injector.register("xcodebuildService", XcodebuildService);
+//# sourceMappingURL=xcodebuild-service.js.map

package/lib/services/ios-debugger-port-service.js

@@ -125,3 +125,4 @@ __decorate([
     (0, decorators_1.cache)()
 ], IOSDebuggerPortService.prototype, "attachToAttachRequestEvent", null);
 yok_1.injector.register("iOSDebuggerPortService", IOSDebuggerPortService);
+//# sourceMappingURL=ios-debugger-port-service.js.map

package/lib/services/ios-device-debug-service.js

@@ -138,3 +138,4 @@ __decorate([
     (0, decorators_1.performanceLog)()
 ], IOSDeviceDebugService.prototype, "openAppInspector", null);
 yok_1.injector.register("iOSDeviceDebugService", IOSDeviceDebugService, false);
+//# sourceMappingURL=ios-device-debug-service.js.map

package/lib/services/ios-entitlements-service.js

@@ -67,3 +67,4 @@ class IOSEntitlementsService {
 exports.IOSEntitlementsService = IOSEntitlementsService;
 IOSEntitlementsService.DefaultEntitlementsName = "app.entitlements";
 yok_1.injector.register("iOSEntitlementsService", IOSEntitlementsService);
+//# sourceMappingURL=ios-entitlements-service.js.map

package/lib/services/ios-extensions-service.js

@@ -50,3 +50,4 @@ class IOSExtensionsService {
 }
 exports.IOSExtensionsService = IOSExtensionsService;
 yok_1.injector.register("iOSExtensionsService", IOSExtensionsService);
+//# sourceMappingURL=ios-extensions-service.js.map

package/lib/services/ios-log-filter.js

@@ -5,8 +5,20 @@ const yok_1 = require("../common/yok");
 class IOSLogFilter {
     constructor($loggingLevels) {
         this.$loggingLevels = $loggingLevels;
+        // Used to recognize output related to the current project
+        // This looks for artifacts like: AppName[22432] or AppName(SomeTextHere)[23123]
         this.appOutputRegex = /([^\s\(\)]+)(?:\(([^\s]+)\))?\[[0-9]+\]/;
+        // Used to trim the passed messages to a simpler output
+        // Example:
+        // This: "May 24 15:54:52 Dragons-iPhone NativeScript250(NativeScript)[356] <Notice>: CONSOLE ERROR file:///app/tns_modules/@angular/core/bundles/core.umd.js:3477:36: ORIGINAL STACKTRACE:"
+        // Becomes: CONSOLE ERROR file:///app/tns_modules/@angular/core/bundles/core.umd.js:3477:36: ORIGINAL STACKTRACE:
         this.infoFilterRegex = new RegExp(`^.*(?:<Notice>:[ \t]?|<Error>:[ \t]?|<Warning>:[ \t]?|\\(NativeScript\\)[ \t]?|${this.appOutputRegex.source}:[ \t]?){1}`);
+        // Used to post filter messages that slip through but are not coming from NativeScript itself.
+        // Looks for text in parenthesis at the beginning
+        // Example:
+        // (RunningBoardServices) [com.apple.runningboard:connection] Identity resolved as application<...>
+        // ^(~~capture group~~~)^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+        // we then use this to filter out non-NativeScript lines
         this.postFilterRegex = /^\((.+)\) \[com\.apple.+\]/;
         this.filterActive = true;
         this.partialLine = null;
@@ -29,11 +41,15 @@ class IOSLogFilter {
                 this.partialLine = currentLine;
                 break;
             }
+            // Legacy filter moved to preFilter
             if (this.preFilter(data, currentLine)) {
                 continue;
             }
             const matchResult = this.appOutputRegex.exec(currentLine);
             if (matchResult && matchResult.length > 1) {
+                // Check if the name of the app equals the name of the CLI project and turn on the filter if not.
+                // We call initializeProjectData in order to obtain the current project name as the instance
+                // of this filter may be used accross multiple projects.
                 const projectName = loggingOptions && loggingOptions.projectName;
                 this.filterActive = matchResult[1] !== projectName;
                 if (matchResult === null || matchResult === void 0 ? void 0 : matchResult[2]) {
@@ -48,8 +64,11 @@ class IOSLogFilter {
                 currentLine = currentLine.replace(filteredLineInfo[0], "");
             }
             currentLine = currentLine
+                // remove lading space before CONSOLE
                 .replace(/^\s*CONSOLE/, "CONSOLE")
+                // trim trailing spaces only to preserve indentation
                 .trimEnd();
+            // post filtering: (<anything>) check if <anything> is not "NativeScript"
             const postFilterMatch = this.postFilterRegex.exec(currentLine);
             if (postFilterMatch && (postFilterMatch === null || postFilterMatch === void 0 ? void 0 : postFilterMatch[1]) !== "NativeScript") {
                 continue;
@@ -68,3 +87,4 @@ class IOSLogFilter {
 }
 exports.IOSLogFilter = IOSLogFilter;
 yok_1.injector.register("iOSLogFilter", IOSLogFilter);
+//# sourceMappingURL=ios-log-filter.js.map

package/lib/services/ios-native-target-service.js

@@ -58,8 +58,8 @@ class IOSNativeTargetService {
     setXcodeTargetBuildConfigurationProperties(properties, targetName, project) {
         properties.forEach((property) => {
             const buildNames = property.buildNames || [
-                "Debug",
-                "Release",
+                "Debug" /* BuildNames.debug */,
+                "Release" /* BuildNames.release */,
             ];
             buildNames.forEach((buildName) => {
                 project.addBuildProperty(property.name, property.value, buildName, targetName);
@@ -76,6 +76,7 @@ class IOSNativeTargetService {
                 project.addToBuildSettings("ASSETCATALOG_COMPILER_APPICON_NAME", configurationJson.assetcatalogCompilerAppiconName, targetUuid);
             }
             const properties = [];
+            // Set for both release and debug
             if (configurationJson.targetBuildConfigurationProperties) {
                 _.forEach(configurationJson.targetBuildConfigurationProperties, (value, name) => properties.push({ value, name }));
             }
@@ -84,11 +85,11 @@ class IOSNativeTargetService {
                     var buildName = null;
                     switch (name) {
                         case "debug": {
-                            buildName = "Debug";
+                            buildName = "Debug" /* BuildNames.debug */;
                             break;
                         }
                         case "release": {
-                            buildName = "Release";
+                            buildName = "Release" /* BuildNames.release */;
                             break;
                         }
                         default: {
@@ -106,3 +107,4 @@ class IOSNativeTargetService {
 }
 exports.IOSNativeTargetService = IOSNativeTargetService;
 yok_1.injector.register("iOSNativeTargetService", IOSNativeTargetService);
+//# sourceMappingURL=ios-native-target-service.js.map

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

@@ -74,7 +74,10 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
         this._platformsDirCache = null;
         this._platformOverrideCache = null;
         this._platformData = null;
+        // Track added frameworks by name to prevent duplicates in monorepo/workspace setups
+        // where the same plugin may exist in multiple node_modules paths
         this._addedFrameworks = new Set();
+        // Track added static libraries by name to prevent duplicates in monorepo/workspace setups
         this._addedStaticLibs = new Set();
     }
     getPlatformData(projectData) {
@@ -143,7 +146,7 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
                     ".ico",
                     ".cur",
                     ".xbm",
-                ],
+                ], // https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIImage_Class/
             };
             this._platformsDirCache = projectData.platformsDir;
             this._platformOverrideCache = currentOverride;
@@ -192,8 +195,11 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
         this.$fs.ensureDirectoryExists(path.join(this.getPlatformData(projectData).projectRoot, IOSProjectService.IOS_PROJECT_NAME_PLACEHOLDER));
         shell.cp("-R", path.join(frameworkDir, "*"), this.getPlatformData(projectData).projectRoot);
     }
+    //TODO: plamen5kov: revisit this method, might have unnecessary/obsolete logic
     async interpolateData(projectData) {
         const projectRootFilePath = path.join(this.getPlatformData(projectData).projectRoot, IOSProjectService.IOS_PROJECT_NAME_PLACEHOLDER);
+        // Starting with NativeScript for iOS 1.6.0, the project Info.plist file resides not in the platform project,
+        // but in the hello-world app template as a platform specific resource.
         if (this.$fs.exists(path.join(projectRootFilePath, IOSProjectService.IOS_PROJECT_NAME_PLACEHOLDER + "-Info.plist"))) {
             this.replaceFileName("-Info.plist", projectRootFilePath, projectData);
         }
@@ -283,6 +289,9 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
             return await isDynamicFrameworkBundle(frameworkPath, frameworkName);
         }
     }
+    /**
+     * Clears the framework and static library tracking sets. Should be called at the start of a new prepare cycle.
+     */
     clearFrameworksCache() {
         this._addedFrameworks.clear();
         this._addedStaticLibs.clear();
@@ -291,6 +300,7 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
         if (this.$hostInfo.isWindows) {
             return;
         }
+        // Check if framework with same name already added (prevents duplicate output errors in monorepos)
         const frameworkName = path.basename(frameworkPath);
         if (this._addedFrameworks.has(frameworkName)) {
             this.$logger.trace(`Framework ${frameworkName} already added, skipping duplicate from ${frameworkPath}`);
@@ -306,21 +316,38 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
             frameworkAddOptions["sign"] = true;
         }
         if (this.$options.hostProjectPath) {
+            // always mark xcframeworks for embedding
             frameworkAddOptions["embed"] = true;
             frameworkAddOptions["sign"] = false;
         }
+        // Note: we used to prepend "$(SRCROOT)/" to the framework path, but seems like it's not needed anymore
+        // "$(SRCROOT)/" +
         const frameworkRelativePath = this.getLibSubpathRelativeToProjectPath(frameworkPath, projectData);
         project.addFramework(frameworkRelativePath, frameworkAddOptions);
+        // filePathsArray, buildPhaseType, comment, target, optionsOrFolderType, subfolderPath
+        // project.addBuildPhase(
+        // 	[],
+        // 	"PBXShellScriptBuildPhase",
+        // 	"Debug SRCROOT",
+        // 	undefined,
+        // 	{
+        // 		shellPath: "/bin/sh",
+        // 		shellScript: `echo "SRCROOT: $SRCROOT"`,
+        // 	}
+        // );
         this.savePbxProj(project, projectData);
     }
     async addStaticLibrary(staticLibPath, projectData) {
+        // Check if static library with same name already added (prevents duplicate errors in monorepos)
         const libraryName = path.basename(staticLibPath, ".a");
         if (this._addedStaticLibs.has(libraryName)) {
             this.$logger.trace(`Static library ${libraryName} already added, skipping duplicate from ${staticLibPath}`);
             return;
         }
         this._addedStaticLibs.add(libraryName);
+        // Copy files to lib folder.
         const headersSubpath = path.join(path.dirname(staticLibPath), "include", libraryName);
+        // Add static library to project file and setup header search paths
         const project = this.createPbxProj(projectData);
         const relativeStaticLibPath = this.getLibSubpathRelativeToProjectPath(staticLibPath, projectData);
         project.addFramework(relativeStaticLibPath);
@@ -355,10 +382,58 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
                     filesRelativeToProject: true,
                     uuid: "NATIVESCRIPTNATIVESCRIPT",
                 });
+                /**
+                 * 1. Add platforms/ios/{projectname}/app build to the host app
+                 */
+                // Note: allow customization of this targetFolderName
+                // const targetFolderName = "app";
                 const buildFolderPath = path.join(this.$options.hostProjectPath, projectData.projectName);
                 project.addResourceFile(buildFolderPath, {}, "NATIVESCRIPTNATIVESCRIPT");
+                // filePathsArray, buildPhaseType, comment, target, optionsOrFolderType, subfolderPath
+                // project.addBuildPhase(
+                // 	[],
+                // 	"PBXShellScriptBuildPhase",
+                // 	"Copy Metadata (DEBUG)",
+                // 	undefined,
+                // 	{
+                // 		shellPath: "/bin/sh",
+                // 		shellScript: `cp ./platforms/ios/build/Debug-iphonesimulator/metadata-arm64.bin $CONFIGURATION_BUILD_DIR`,
+                // 		outputPaths: [
+                // 			JSON.stringify("$(CONFIGURATION_BUILD_DIR)/metadata-arm64.bin"),
+                // 			// JSON.stringify("$(CONFIGURATION_BUILD_DIR)/metadata-arm64e.bin"),
+                // 			// JSON.stringify("$(CONFIGURATION_BUILD_DIR)/metadata-i386.bin"),
+                // 			// JSON.stringify("$(CONFIGURATION_BUILD_DIR)/metadata-x86_64.bin"),
+                // 		],
+                // 	}
+                // );
                 const metadataPath = path.relative(this.$options.hostProjectPath, buildFolderPath);
                 project.addToOtherLinkerFlags(JSON.stringify(`-sectcreate __DATA __TNSMetadata "${metadataPath}/metadata-arm64.bin"`));
+                // // no shorthand way to get UUID of build phase that i can tell
+                // // methods return the phase as an object but ommitted the actual key (uuid we need)
+                // // this does it same way nativescript-dev-xcode does but gets the uuid we need
+                // const resourcesBuildPhaseKeys = Object.keys(
+                // 	project.hash.project.objects["PBXResourcesBuildPhase"]
+                // );
+                // // console.log('resourcesBuildPhaseKeys:', resourcesBuildPhaseKeys);
+                // const buildPhaseUUID = resourcesBuildPhaseKeys[0];
+                // const comment = `${targetFolderName} in Resources`;
+                // project.hash.project.objects["PBXResourcesBuildPhase"][
+                // 	buildPhaseUUID
+                // ].files.forEach((f: any) => {
+                // 	console.log(f);
+                // });
+                // if (
+                // 	!project.hash.project.objects["PBXResourcesBuildPhase"][
+                // 		buildPhaseUUID
+                // 	].files.find((f: any) => f.comment === comment)
+                // ) {
+                // 	project.addResourceFile(buildFolderPath, {}, buildPhaseUUID);
+                // }
+                /**
+                 * 2. Ensure metadata is copied as a file
+                 * 		The apps metadata-{arch}.bin should be added as a file reference.
+                 */
+                // TODO
                 this.savePbxProj(project, projectData);
             }
             catch (err) {
@@ -411,10 +486,12 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
         this.$fs.deleteDirectory(platformsAppResourcesPath);
         this.$fs.ensureDirectoryExists(platformsAppResourcesPath);
         const platformAppResourcesPath = path.join(projectAppResourcesPath, platformData.normalizedPlatformName);
+        // this allows App_Resources/visionOS
         if (this.$fs.exists(platformAppResourcesPath)) {
             this.$fs.copyFile(path.join(platformAppResourcesPath, "*"), platformsAppResourcesPath);
         }
         else {
+            // otherwise falls back to App_Resources/iOS
             this.$fs.copyFile(path.join(projectAppResourcesPath, this.$devicePlatformsConstants.iOS, "*"), platformsAppResourcesPath);
         }
         this.$fs.deleteFile(path.join(platformsAppResourcesPath, platformData.configurationFileName));
@@ -513,6 +590,12 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
     getLibSubpathRelativeToProjectPath(targetPath, projectData) {
         const projectRoot = this.getPlatformData(projectData).projectRoot;
         const frameworkPath = path.relative(projectRoot, targetPath);
+        // console.log({
+        // 	targetPath,
+        // 	projectRoot,
+        // 	frameworkPath,
+        // 	resolved: path.resolve(projectRoot, frameworkPath),
+        // });
         return frameworkPath;
     }
     getPbxProjPath(projectData) {
@@ -550,6 +633,7 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
         this.$cocoapodsService.removePodfileFromProject(pluginData.name, this.$cocoapodsService.getPluginPodfilePath(pluginData), projectData, projectRoot);
     }
     async handleNativeDependenciesChange(projectData, opts) {
+        // Clear framework tracking for fresh duplicate detection
         this.clearFrameworksCache();
         const platformData = this.getPlatformData(projectData);
         const pluginsData = this.getAllProductionPlugins(projectData);
@@ -561,6 +645,10 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
         const projectPodfilePath = this.$cocoapodsService.getProjectPodfilePath(platformData.projectRoot);
         if (this.$fs.exists(projectPodfilePath)) {
             await this.$cocoapodsService.executePodInstall(platformData.projectRoot, this.$xcprojService.getXcodeprojPath(projectData, platformData.projectRoot));
+            // The `pod install` command adds a new target to the .pbxproject. This target adds additional build phases to Xcode project.
+            // Some of these phases relies on env variables (like PODS_PODFILE_DIR_PATH or PODS_ROOT).
+            // These variables are produced from merge of pod's xcconfig file and project's xcconfig file.
+            // So the correct order is `pod install` to be executed before merging pod's xcconfig file.
             await this.$cocoapodsService.mergePodXcconfigFile(projectData, platformData, opts);
         }
         const pluginSpmPackages = [];
@@ -586,6 +674,7 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
         const hasProvision = provision !== undefined;
         const hasTeamId = teamId !== undefined;
         if (hasProvision || hasTeamId) {
+            // Check if the native project's signing is set to the provided provision...
             const pbxprojPath = this.getPbxProjPath(projectData);
             if (this.$fs.exists(pbxprojPath)) {
                 const xcode = this.$pbxprojDomXcode.Xcode.open(pbxprojPath);
@@ -601,6 +690,9 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
                         }
                     }
                     else {
+                        // Specifying provisioning profile requires "Manual" signing style.
+                        // If the current signing style was not "Manual" it was probably "Automatic" or,
+                        // it was not uniform for the debug and release build configurations.
                         changesInfo.signingChanged = true;
                     }
                 }
@@ -614,6 +706,8 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
                         }
                     }
                     else {
+                        // Specifying team id or name requires "Automatic" signing style.
+                        // If the current signing style was not "Automatic" it was probably "Manual".
                         changesInfo.signingChanged = true;
                     }
                 }
@@ -830,10 +924,14 @@ class IOSProjectService extends projectServiceBaseLib.PlatformProjectServiceBase
         }
         for (const pluginsXcconfigFilePath of pluginsXcconfigFilePaths) {
             if (!this.$fs.exists(pluginsXcconfigFilePath)) {
+                // We need the pluginsXcconfig file to exist in platforms dir as it is required in the native template:
+                // https://github.com/NativeScript/ios-runtime/blob/9c2b7b5f70b9bee8452b7a24aa6b646214c7d2be/build/project-template/__PROJECT_NAME__/build-debug.xcconfig#L3
+                // From Xcode 10 in case the file is missing, this include fails and the build itself fails (was a warning in previous Xcode versions).
                 this.$fs.writeFile(pluginsXcconfigFilePath, "");
             }
         }
         for (const pluginsXcconfigFilePath of pluginsXcconfigFilePaths) {
+            // Set Entitlements Property to point to default file if not set explicitly by the user.
             const entitlementsPropertyValue = this.$xcconfigService.readPropertyValue(pluginsXcconfigFilePath, constants.CODE_SIGN_ENTITLEMENTS);
             if (entitlementsPropertyValue === null &&
                 this.$fs.exists(this.$iOSEntitlementsService.getPlatformsEntitlementsPath(projectData))) {
@@ -878,3 +976,4 @@ __decorate([
     (0, helpers_2.hook)("buildIOS")
 ], IOSProjectService.prototype, "buildProject", null);
 yok_1.injector.register("iOSProjectService", IOSProjectService);
+//# sourceMappingURL=ios-project-service.js.map

package/lib/services/ios-provision-service.js

@@ -127,6 +127,8 @@ class IOSProvisionService {
     }
     async getDevelopmentTeams() {
         const teams = {};
+        // NOTE: We are reading all provisioning profiles and collect team information from them.
+        // It would be better if we can check the Apple ID registered in Xcode and read the teams associated with it.
         mobileprovision.provision.read().forEach((provision) => provision.TeamIdentifier &&
             provision.TeamIdentifier.forEach((id) => {
                 if (!teams[provision.TeamName]) {
@@ -150,3 +152,4 @@ class IOSProvisionService {
 }
 exports.IOSProvisionService = IOSProvisionService;
 yok_1.injector.register("iOSProvisionService", IOSProvisionService);
+//# sourceMappingURL=ios-provision-service.js.map