chore: unify interfaces

Author: KristianDD

lib/commands/plugin/build-plugin.ts

@@ -32,7 +32,7 @@ export class BuildPluginCommand implements ICommand {
 		temp.track();
 		const tempAndroidProject = temp.mkdirSync("android-project");
 
-		const options: IBuildOptions = {
+		const options: IPluginBuildOptions = {
 			aarOutputDir: platformsAndroidPath,
 			platformsAndroidDirPath: platformsAndroidPath,
 			pluginName: pluginName,

lib/definitions/android-plugin-migrator.d.ts

@@ -1,5 +1,5 @@
 
-interface IBuildOptions extends IAndroidBuildOptions{
+interface IPluginBuildOptions extends IAndroidBuildOptions{
 	projectDir?: string
 }
 
@@ -11,8 +11,8 @@ interface IAndroidBuildOptions {
 }
 
 interface IAndroidPluginBuildService {
-	buildAar(options: IBuildOptions): Promise<boolean>;
-	migrateIncludeGradle(options: IBuildOptions): boolean;
+	buildAar(options: IPluginBuildOptions): Promise<boolean>;
+	migrateIncludeGradle(options: IPluginBuildOptions): boolean;
 }
 
 /**

lib/definitions/platform.d.ts

@@ -286,10 +286,7 @@ interface IValidBuildOutputData {
 	regexes?: RegExp[];
 }
 
-interface IBuildOutputOptions extends IAndroidBundle {
-	isReleaseBuild?: boolean;
-	isForDevice?: boolean;
-}
+interface IBuildOutputOptions extends Partial<IBuildForDevice>, IRelease, IAndroidBundle {}
 
 interface IPlatformsData {
 	availablePlatforms: any;

lib/definitions/project.d.ts

@@ -437,7 +437,7 @@ interface IPlatformProjectService extends NodeJS.EventEmitter, IPlatformProjectS
 	/**
 	 * Build native part of a nativescript plugins if necessary
 	 */
-	prebuildNativePlugin(buildOptions: IBuildOptions): Promise<void>;
+	prebuildNativePlugin(buildOptions: IPluginBuildOptions): Promise<void>;
 
 	/**
 	 * Traverse through the production dependencies and find plugins that need build/rebuild

lib/services/android-plugin-build-service.ts

@@ -169,7 +169,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 	 * @param {string} options.aarOutputDir - The path where the aar should be copied after a successful build.
 	 * @param {string} options.tempPluginDirPath - The path where the android plugin will be built.
 	 */
-	public async buildAar(options: IBuildOptions): Promise<boolean> {
+	public async buildAar(options: IPluginBuildOptions): Promise<boolean> {
 		this.validateOptions(options);
 		const manifestFilePath = this.getManifest(options.platformsAndroidDirPath);
 		const androidSourceDirectories = this.getAndroidSourceDirectories(options.platformsAndroidDirPath);
@@ -381,7 +381,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 	 * @param {Object} options
 	 * @param {string} options.platformsAndroidDirPath - The path to the 'plugin/src/platforms/android' directory.
 	 */
-	public migrateIncludeGradle(options: IBuildOptions): boolean {
+	public migrateIncludeGradle(options: IPluginBuildOptions): boolean {
 		this.validatePlatformsAndroidDirPathOption(options);
 
 		const includeGradleFilePath = path.join(options.platformsAndroidDirPath, INCLUDE_GRADLE_NAME);
@@ -435,7 +435,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		}
 	}
 
-	private validateOptions(options: IBuildOptions): void {
+	private validateOptions(options: IPluginBuildOptions): void {
 		if (!options) {
 			this.$errors.failWithoutHelp("Android plugin cannot be built without passing an 'options' object.");
 		}
@@ -455,7 +455,7 @@ export class AndroidPluginBuildService implements IAndroidPluginBuildService {
 		this.validatePlatformsAndroidDirPathOption(options);
 	}
 
-	private validatePlatformsAndroidDirPathOption(options: IBuildOptions): void {
+	private validatePlatformsAndroidDirPathOption(options: IPluginBuildOptions): void {
 		if (!options) {
 			this.$errors.failWithoutHelp("Android plugin cannot be built without passing an 'options' object.");
 		}

lib/services/android-project-service.ts

@@ -76,7 +76,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 				deviceBuildOutputPath: path.join(...deviceBuildOutputArr),
 				bundleBuildOutputPath: path.join(projectRoot, constants.APP_FOLDER_NAME, constants.BUILD_DIR, constants.OUTPUTS_DIR, constants.BUNDLE_DIR),
 				getValidBuildOutputData: (buildOptions: IBuildOutputOptions): IValidBuildOutputData => {
-					const buildMode = buildOptions.isReleaseBuild ? Configurations.Release.toLowerCase() : Configurations.Debug.toLowerCase();
+					const buildMode = buildOptions.release ? Configurations.Release.toLowerCase() : Configurations.Debug.toLowerCase();
 
 					if(buildOptions.androidBundle) {
 						return {
@@ -445,7 +445,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 			// 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: IBuildOptions = {
+				const options: IPluginBuildOptions = {
 					projectDir: projectData.projectDir,
 					pluginName: pluginData.name,
 					platformsAndroidDirPath: pluginPlatformsFolderPath,
@@ -514,7 +514,7 @@ export class AndroidProjectService extends projectServiceBaseLib.PlatformProject
 		return item.endsWith(constants.MANIFEST_FILE_NAME) || item.endsWith(constants.RESOURCES_DIR);
 	}
 
-	public async prebuildNativePlugin(options: IBuildOptions): Promise<void> {
+	public async prebuildNativePlugin(options: IPluginBuildOptions): Promise<void> {
 		if (await this.$androidPluginBuildService.buildAar(options)) {
 			this.$logger.info(`Built aar for ${options.pluginName}`);
 		}

lib/services/ios-project-service.ts

@@ -70,7 +70,8 @@ export class IOSProjectService extends projectServiceBaseLib.PlatformProjectServ
 				deviceBuildOutputPath: path.join(projectRoot, constants.BUILD_DIR, "device"),
 				emulatorBuildOutputPath: path.join(projectRoot, constants.BUILD_DIR, "emulator"),
 				getValidBuildOutputData: (buildOptions: IBuildOutputOptions): IValidBuildOutputData => {
-					if (buildOptions.isForDevice) {
+					const forDevice = !buildOptions || !!buildOptions.buildForDevice;
+					if (forDevice) {
 						return {
 							packageNames: [`${projectData.projectName}.ipa`]
 						};
@@ -1024,7 +1025,7 @@ We will now place an empty obsolete compatability white screen LauncScreen.xib f
 		}
 	}
 
-	public async prebuildNativePlugin(options: IBuildOptions): Promise<void> { /** */ }
+	public async prebuildNativePlugin(options: IPluginBuildOptions): Promise<void> { /** */ }
 
 	public async checkIfPluginsNeedBuild(projectData: IProjectData): Promise<Array<any>> {
 		return [];

lib/services/platform-service.ts

@@ -373,7 +373,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 			return true;
 		}
 
-		const validBuildOutputData = platformData.getValidBuildOutputData({ isForDevice: forDevice, isReleaseBuild: buildConfig.release });
+		const validBuildOutputData = platformData.getValidBuildOutputData(buildConfig);
 		const packages = this.getApplicationPackages(outputPath, validBuildOutputData);
 		if (packages.length === 0) {
 			return true;
@@ -449,7 +449,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 
 		await attachAwaitDetach(constants.BUILD_OUTPUT_EVENT_NAME, platformData.platformProjectService, handler, platformData.platformProjectService.buildProject(platformData.projectRoot, projectData, buildConfig));
 
-		const buildInfoFilePath = this.getBuildOutputPath(platform, platformData, { isForDevice: buildConfig.buildForDevice, isReleaseBuild: buildConfig.release, androidBundle: buildConfig.androidBundle });
+		const buildInfoFilePath = this.getBuildOutputPath(platform, platformData, buildConfig);
 		this.saveBuildInfoFile(platform, projectData.projectDir, buildInfoFilePath);
 
 		this.$logger.out("Project successfully built.");
@@ -476,7 +476,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 
 		const platformData = this.$platformsData.getPlatformData(platform, projectData);
 		const deviceBuildInfo: IBuildInfo = await this.getDeviceBuildInfo(device, projectData);
-		const localBuildInfo = this.getBuildInfo(platform, platformData, { isForDevice: !device.isEmulator, isReleaseBuild: release.release }, outputPath);
+		const localBuildInfo = this.getBuildInfo(platform, platformData, { buildForDevice: !device.isEmulator, release: release.release }, outputPath);
 		return !localBuildInfo || !deviceBuildInfo || deviceBuildInfo.buildTime !== localBuildInfo.buildTime;
 	}
 
@@ -514,7 +514,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 			const deviceFilePath = await this.getDeviceBuildInfoFilePath(device, projectData);
 			const options = buildConfig;
 			options.buildForDevice = !device.isEmulator;
-			const buildInfoFilePath = outputFilePath || this.getBuildOutputPath(device.deviceInfo.platform, platformData, { isForDevice: buildConfig.buildForDevice, isReleaseBuild: buildConfig.release, androidBundle: buildConfig.androidBundle });
+			const buildInfoFilePath = outputFilePath || this.getBuildOutputPath(device.deviceInfo.platform, platformData, buildConfig);
 			const appIdentifier = projectData.projectIdentifiers[platform];
 
 			await device.fileSystem.putFile(path.join(buildInfoFilePath, buildInfoFileName), deviceFilePath, appIdentifier);
@@ -617,7 +617,7 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 		}
 
 		if (platform.toLowerCase() === this.$devicePlatformsConstants.iOS.toLowerCase()) {
-			return options.isForDevice ? platformData.deviceBuildOutputPath : platformData.emulatorBuildOutputPath;
+			return options.buildForDevice ? platformData.deviceBuildOutputPath : platformData.emulatorBuildOutputPath;
 		}
 
 		return platformData.deviceBuildOutputPath;
@@ -903,11 +903,11 @@ export class PlatformService extends EventEmitter implements IPlatformService {
 	}
 
 	public getLatestApplicationPackageForDevice(platformData: IPlatformData, buildConfig: IBuildConfig, outputPath?: string): IApplicationPackage {
-		return this.getLatestApplicationPackage(outputPath || platformData.deviceBuildOutputPath, platformData.getValidBuildOutputData({ isForDevice: true, isReleaseBuild: buildConfig.release, androidBundle: buildConfig.androidBundle }));
+		return this.getLatestApplicationPackage(outputPath || platformData.deviceBuildOutputPath, platformData.getValidBuildOutputData({ buildForDevice: true, release: buildConfig.release, androidBundle: buildConfig.androidBundle }));
 	}
 
 	public getLatestApplicationPackageForEmulator(platformData: IPlatformData, buildConfig: IBuildConfig, outputPath?: string): IApplicationPackage {
-		const buildOutputOptions: IBuildOutputOptions = { isForDevice: false, isReleaseBuild: buildConfig.release, androidBundle: buildConfig.androidBundle };
+		const buildOutputOptions: IBuildOutputOptions = { buildForDevice: false, release: buildConfig.release, androidBundle: buildConfig.androidBundle };
 		outputPath = outputPath || this.getBuildOutputPath(platformData.normalizedPlatformName.toLowerCase(), platformData, buildOutputOptions);
 		return this.getLatestApplicationPackage(outputPath || platformData.emulatorBuildOutputPath || platformData.deviceBuildOutputPath, platformData.getValidBuildOutputData(buildOutputOptions));
 	}

test/services/android-plugin-build-service.ts

@@ -32,7 +32,7 @@ describe('androidPluginBuildService', () => {
 		projectRuntimeGradleAndroidVersion?: string,
 		addPreviousBuildInfo?: boolean,
 		hasChangesInShasums?: boolean,
-	}): IBuildOptions {
+	}): IPluginBuildOptions {
 		options = options || {};
 		spawnFromEventCalled = false;
 		tempFolder = temp.mkdirSync("androidPluginBuildService-temp");
@@ -182,7 +182,7 @@ dependencies {
 	describe('buildAar', () => {
 
 		it('builds aar when all supported files are in the plugin', async () => {
-			const config: IBuildOptions = setup({
+			const config: IPluginBuildOptions = setup({
 				addManifest: true,
 				addResFolder: true,
 				addAssetsFolder: true
@@ -194,15 +194,15 @@ dependencies {
 		});
 
 		it('does not build aar when there are no supported files in the plugin', async () => {
-			const config: IBuildOptions = setup();
+			const config: IPluginBuildOptions = setup();
 
 			await androidBuildPluginService.buildAar(config);
 
 			assert.isFalse(spawnFromEventCalled);
 		});
 
 		it('builds aar when there are res and assets folders', async () => {
-			const config: IBuildOptions = setup({
+			const config: IPluginBuildOptions = setup({
 				addResFolder: true,
 				addAssetsFolder: true
 			});
@@ -213,7 +213,7 @@ dependencies {
 		});
 
 		it('builds aar when there is an android manifest', async () => {
-			const config: IBuildOptions = setup({
+			const config: IPluginBuildOptions = setup({
 				addManifest: true
 			});
 
@@ -223,7 +223,7 @@ dependencies {
 		});
 
 		it('builds aar when plugin is already build and source files have changed since last buid', async () => {
-			const config: IBuildOptions = setup({
+			const config: IPluginBuildOptions = setup({
 				addManifest: true,
 				addPreviousBuildInfo: true,
 				hasChangesInShasums: true
@@ -235,7 +235,7 @@ dependencies {
 		});
 
 		it('does not build aar when plugin is already build and source files have not changed', async () => {
-			const config: IBuildOptions = setup({
+			const config: IPluginBuildOptions = setup({
 				addManifest: true,
 				addPreviousBuildInfo: true
 			});
@@ -248,7 +248,7 @@ dependencies {
 		it('builds aar with the latest runtime gradle versions when no project dir is specified', async () => {
 			const expectedGradleVersion = "1.2.3";
 			const expectedAndroidVersion = "4.5.6";
-			const config: IBuildOptions = setup({
+			const config: IPluginBuildOptions = setup({
 				addManifest: true,
 				latestRuntimeGradleVersion: expectedGradleVersion,
 				latestRuntimeGradleAndroidVersion: expectedAndroidVersion
@@ -266,7 +266,7 @@ dependencies {
 		it('builds aar with the latest runtime gradle versions when a project dir without runtime versions is specified', async () => {
 			const expectedGradleVersion = "4.4.4";
 			const expectedAndroidVersion = "5.5.5";
-			const config: IBuildOptions = setup({
+			const config: IPluginBuildOptions = setup({
 				addManifest: true,
 				addProjectDir: true,
 				latestRuntimeGradleVersion: expectedGradleVersion,
@@ -288,7 +288,7 @@ dependencies {
 		it('builds aar with the specified runtime gradle versions when the project runtime has gradle versions', async () => {
 			const expectedGradleVersion = "2.2.2";
 			const expectedAndroidVersion = "3.3";
-			const config: IBuildOptions = setup({
+			const config: IPluginBuildOptions = setup({
 				addManifest: true,
 				addProjectDir: true,
 				latestRuntimeGradleVersion: "4.4.4",
@@ -308,7 +308,7 @@ dependencies {
 		});
 
 		it('builds aar with the hardcoded gradle versions when the project runtime and the latest runtime do not have versions specified', async () => {
-			const config: IBuildOptions = setup({
+			const config: IPluginBuildOptions = setup({
 				addManifest: true,
 				addProjectDir: true,
 				latestRuntimeGradleVersion: null,
@@ -330,7 +330,7 @@ dependencies {
 
 	describe('migrateIncludeGradle', () => {
 		it('if there is a legacy include.gradle file', async () => {
-			const config: IBuildOptions = setup({
+			const config: IPluginBuildOptions = setup({
 				addLegacyIncludeGradle: true
 			});
 
@@ -343,7 +343,7 @@ dependencies {
 		});
 
 		it('if there is an already migrated include.gradle file', async () => {
-			const config: IBuildOptions = setup({
+			const config: IPluginBuildOptions = setup({
 				addIncludeGradle: true
 			});
 

test/stubs.ts

@@ -305,10 +305,10 @@ export class ProjectDataStub implements IProjectData {
 }
 
 export class AndroidPluginBuildServiceStub implements IAndroidPluginBuildService {
-	buildAar(options: IBuildOptions): Promise<boolean> {
+	buildAar(options: IPluginBuildOptions): Promise<boolean> {
 		return Promise.resolve(true);
 	}
-	migrateIncludeGradle(options: IBuildOptions): boolean {
+	migrateIncludeGradle(options: IPluginBuildOptions): boolean {
 		return true;
 	}
 }
@@ -328,7 +328,7 @@ export class PlatformProjectServiceStub extends EventEmitter implements IPlatfor
 			fastLivesyncFileExtensions: []
 		};
 	}
-	prebuildNativePlugin(options: IBuildOptions): Promise<void> {
+	prebuildNativePlugin(options: IPluginBuildOptions): Promise<void> {
 		return Promise.resolve();
 	}