@akylas/nativescript-cli 8.7.2

package/lib/definitions/metadata-filtering-service.d.ts

@@ -0,0 +1,48 @@
+import { IProjectData } from "./project";
+
+/**
+ * Describes service used to generate necessary files to filter the native metadata generation.
+ */
+interface INativeApiUsageConfiguration {
+	/**
+	 * Defines if the content of plugins' native-api-usage files will be used and included in the whitelist content.
+	 */
+	["whitelist-plugins-usages"]: boolean;
+
+	/**
+	 * Defines APIs which will be inlcuded in the metadata.
+	 */
+	whitelist: string[];
+
+	/**
+	 * Defines APIs which will be excluded from the metadata.
+	 */
+	blacklist: string[];
+}
+
+/**
+ * Describes the content of plugin's native-api-usage.json file located in `<path to plugin>/platforms/<platform> directory.
+ */
+interface INativeApiUsagePluginConfiguration {
+	/**
+	 * Defines APIs which are used by the plugin and which should be whitelisted by the application using this plugin.
+	 */
+	uses: string[];
+	/**
+	 * Defines APIs which can be safely ignored by this plugin
+	 */
+	blacklist?: string[];
+}
+
+/**
+ * Describes service used to generate neccesary files to filter the metadata generation.
+ */
+interface IMetadataFilteringService {
+	/**
+	 * Cleans old metadata filters and creates new ones for the current project and platform.
+	 * @param {IProjectData} projectData Information about the current project.
+	 * @param {string} platform The platform for which metadata should be generated.
+	 * @returns {void}
+	 */
+	generateMetadataFilters(projectData: IProjectData, platform: string): void;
+}

package/lib/definitions/migrate.d.ts

@@ -0,0 +1,46 @@
+import { IProjectData } from "./project";
+import { IProjectDir } from "../common/declarations";
+import { ShouldMigrate } from "../constants";
+
+interface IMigrateController {
+	shouldMigrate(data: IMigrationData): Promise<boolean>;
+	validate(data: IMigrationData): Promise<void>;
+	migrate(data: IMigrationData): Promise<void>;
+}
+
+interface IMigrationData extends IProjectDir {
+	platforms: string[];
+	loose?: boolean;
+}
+
+interface IMigrationShouldMigrate {
+	shouldMigrate: ShouldMigrate;
+	reasons: string[];
+}
+
+interface IDependency {
+	packageName: string;
+	isDev?: boolean;
+}
+
+interface IDependencyVersion {
+	minVersion?: string;
+	desiredVersion?: string;
+}
+
+interface IMigrationDependency extends IDependency, IDependencyVersion {
+	shouldRemove?: boolean;
+	replaceWith?: string;
+	warning?: string;
+	shouldUseExactVersion?: boolean;
+	shouldAddIfMissing?: boolean;
+	shouldMigrateAction?: (
+		dependency: IMigrationDependency,
+		projectData: IProjectData,
+		loose: boolean
+	) => Promise<boolean>;
+	migrateAction?: (
+		projectData: IProjectData,
+		migrationBackupDirPath: string
+	) => Promise<IMigrationDependency[]>;
+}

package/lib/definitions/nativescript-dev-xcode.d.ts

@@ -0,0 +1,87 @@
+declare module "nativescript-dev-xcode" {
+	interface Options {
+		[key: string]: any;
+
+		customFramework?: boolean;
+		embed?: boolean;
+		relativePath?: string;
+	}
+
+	class project {
+		constructor(filename: string);
+
+		parse(callback: () => void): void;
+		parseSync(): void;
+
+		writeSync(options: any): string;
+
+		addFramework(filepath: string, options?: Options): void;
+		removeFramework(filePath: string, options?: Options): void;
+
+		addPbxGroup(
+			filePathsArray: any[],
+			name: string,
+			path: string,
+			sourceTree: string
+		): void;
+
+		removePbxGroup(groupName: string, path: string): void;
+
+		addToHeaderSearchPaths(options?: Options): void;
+		removeFromHeaderSearchPaths(options?: Options): void;
+		updateBuildProperty(key: string, value: any): void;
+
+		pbxXCBuildConfigurationSection(): any;
+
+		addTarget(
+			targetName: string,
+			targetType: string,
+			targetPath?: string,
+			parentTarget?: string
+		): target;
+		addBuildPhase(
+			filePathsArray: string[],
+			buildPhaseType: string,
+			comment: string,
+			target?: string,
+			optionsOrFolderType?: Object | string,
+			subfolderPath?: string
+		): any;
+		addToBuildSettings(
+			buildSetting: string,
+			value: any,
+			targetUuid?: string
+		): void;
+		addPbxGroup(
+			filePathsArray: string[],
+			name: string,
+			path: string,
+			sourceTree: string,
+			opt: {
+				filesRelativeToProject?: boolean;
+				target?: string;
+				uuid?: string;
+				isMain?: boolean;
+			}
+		): group;
+		addBuildProperty(
+			prop: string,
+			value: any,
+			build_name?: string,
+			productName?: string
+		): void;
+		addToHeaderSearchPaths(file: string | Object, productName?: string): void;
+		removeTargetsByProductType(targetType: string): void;
+		getFirstTarget(): { uuid: string };
+	}
+
+	class target {
+		uuid: string;
+		pbxNativeTarget: { productName: string };
+	}
+
+	class group {
+		uuid: string;
+		pbxGroup: Object;
+	}
+}

package/lib/definitions/pacote-service.d.ts

@@ -0,0 +1,50 @@
+import * as tar from "tar";
+import { IProxySettingsBase } from "../common/declarations";
+import { Arborist } from "@npmcli/arborist";
+
+declare global {
+	interface IPacoteService {
+		/**
+		 * Returns the package's json file content
+		 * @param packageName The name of the package
+		 * @param options The provided options can control which properties from package.json file will be returned. In case when fullMetadata option is provided, all data from package.json file will be returned.
+		 */
+		manifest(
+			packageName: string,
+			options?: IPacoteManifestOptions
+		): Promise<any>;
+		/**
+		 * Downloads the specified package and extracts it in specified destination directory
+		 * @param packageName The name of the package
+		 * @param destinationDirectory The path to directory where the downloaded tarball will be extracted.
+		 */
+		extractPackage(
+			packageName: string,
+			destinationDirectory: string,
+			options?: IPacoteExtractOptions
+		): Promise<void>;
+	}
+
+	interface IPacoteBaseOptions extends IProxySettingsBase {
+		/**
+		 * The path to npm cache
+		 */
+		cache?: string;
+
+		/**
+		 * Arborist instance to use
+		 */
+		Arborist?: Arborist;
+	}
+
+	interface IPacoteManifestOptions extends IPacoteBaseOptions {
+		/**
+		 * If true, the whole package.json data will be returned
+		 */
+		fullMetadata?: boolean;
+	}
+
+	interface IPacoteExtractOptions {
+		filter?: (path: string, stat: tar.FileStat) => boolean;
+	}
+}

package/lib/definitions/platform.d.ts

@@ -0,0 +1,146 @@
+import {
+	IBuildConfig,
+	IProjectData,
+	IBuildForDevice,
+	INativePrepare,
+} from "./project";
+import { IHasAndroidBundle, IDependencyData, IOptions } from "../declarations";
+import { IControllerDataBase } from "./data";
+import { IRelease } from "../common/declarations";
+import { INotConfiguredEnvOptions } from "../common/definitions/commands";
+
+/**
+ * Describes information about how to build the native project.
+ */
+interface IBuildPlatformAction {
+	/**
+	 * Builds the native project for the specified platform for device or emulator.
+	 * When finishes, build saves the .nsbuildinfo file in platform product folder.
+	 * This file points to the prepare that was used to build the project and allows skipping unnecessary builds and deploys.
+	 * @param {string} platform The platform to build.
+	 * @param {IBuildConfig} buildConfig Indicates whether the build is for device or emulator.
+	 * @param {IProjectData} projectData DTO with information about the project.
+	 * @returns {Promise<string>} The path to the built file.
+	 */
+	buildPlatform(
+		platform: string,
+		buildConfig: IBuildConfig,
+		projectData: IProjectData
+	): Promise<string>;
+}
+
+interface IPlatformData {
+	frameworkPackageName: string;
+	platformProjectService: IPlatformProjectService;
+	projectRoot: string;
+	normalizedPlatformName: string;
+	platformNameLowerCase: string;
+	appDestinationDirectoryPath: string;
+	getBuildOutputPath(options: IBuildOutputOptions): string;
+	getValidBuildOutputData(
+		buildOptions: IBuildOutputOptions
+	): IValidBuildOutputData;
+	frameworkDirectoriesExtensions?: string[];
+	frameworkDirectoriesNames?: string[];
+	targetedOS?: string[];
+	configurationFileName?: string;
+	configurationFilePath?: string;
+	relativeToFrameworkConfigurationFilePath: string;
+	fastLivesyncFileExtensions: string[];
+	getFrameworkVersion?(projectData: IProjectData): string;
+}
+
+interface IValidBuildOutputData {
+	packageNames: string[];
+	regexes?: RegExp[];
+}
+
+interface IBuildOutputOptions
+	extends Partial<IBuildForDevice>,
+		IRelease,
+		Partial<IHasAndroidBundle> {
+	outputPath?: string;
+}
+
+interface IPlatformsDataService {
+	getPlatformData(platform: string, projectData: IProjectData): IPlatformData;
+}
+
+interface INodeModulesBuilder {
+	prepareNodeModules(
+		prepareNodeModulesData: IPrepareNodeModulesData
+	): Promise<void>;
+}
+
+interface IPrepareNodeModulesData {
+	platformData: IPlatformData;
+	projectData: IProjectData;
+}
+
+interface INodeModulesDependenciesBuilder {
+	getProductionDependencies(
+		projectPath: string,
+		ignore?: string[]
+	): IDependencyData[];
+}
+
+interface IBuildInfo {
+	prepareTime: string;
+	buildTime: string;
+	/**
+	 * Currently it is used only for iOS.
+	 * As `xcrun` command does not throw an error when IPHONEOS_DEPLOYMENT_TARGET is provided in `xcconfig` file and
+	 * the simulator's version does not match IPHONEOS_DEPLOYMENT_TARGET's value, we need to save it to buildInfo file
+	 * in order check it on livesync and throw an error to the user.
+	 */
+	deploymentTarget?: string;
+}
+
+interface IPlatformEnvironmentRequirements {
+	checkEnvironmentRequirements(
+		input: ICheckEnvironmentRequirementsInput
+	): Promise<ICheckEnvironmentRequirementsOutput>;
+}
+
+interface ICheckEnvironmentRequirementsInput {
+	platform?: string;
+	projectDir?: string;
+	runtimeVersion?: string;
+	options?: IOptions;
+	notConfiguredEnvOptions?: INotConfiguredEnvOptions;
+	forceCheck?: boolean;
+}
+
+interface ICheckEnvironmentRequirementsOutput {
+	canExecute: boolean;
+	selectedOption: string;
+}
+
+interface IAddPlatformData extends IControllerDataBase {
+	frameworkPath?: string;
+}
+
+interface IPlatformController {
+	addPlatform(
+		addPlatformData: IAddPlatformData,
+		projectData?: IProjectData
+	): Promise<void>;
+	addPlatformIfNeeded(
+		addPlatformData: IAddPlatformData,
+		projectData?: IProjectData
+	): Promise<void>;
+}
+
+interface IAddPlatformService {
+	addPlatformSafe(
+		projectData: IProjectData,
+		platformData: IPlatformData,
+		packageToInstall: string,
+		addPlatformData: IAddPlatformData
+	): Promise<string>;
+	setPlatformVersion(
+		platformData: IPlatformData,
+		projectData: IProjectData,
+		frameworkVersion: string
+	): Promise<void>;
+}

package/lib/definitions/plugins.d.ts

@@ -0,0 +1,75 @@
+import { IProjectData } from "./project";
+import { IDependencyData } from "../declarations";
+import { IDictionary } from "../common/declarations";
+
+interface IPluginsService {
+	add(plugin: string, projectData: IProjectData): Promise<void>; // adds plugin by name, github url, local path and et.
+	remove(pluginName: string, projectData: IProjectData): Promise<void>; // removes plugin only by name
+	addToPackageJson(
+		plugin: string,
+		version: string,
+		isDev: boolean,
+		projectDir: string
+	): void;
+	removeFromPackageJson(plugin: string, projectDir: string): void;
+	getAllInstalledPlugins(projectData: IProjectData): Promise<IPluginData[]>;
+	getAllProductionPlugins(
+		projectData: IProjectData,
+		platform: string,
+		dependencies?: IDependencyData[]
+	): IPluginData[];
+	ensureAllDependenciesAreInstalled(projectData: IProjectData): Promise<void>;
+
+	/**
+	 * Returns all dependencies and devDependencies from pacakge.json file.
+	 * @param {string} projectData Root directory of the project.
+	 * @returns {IPackageJsonDepedenciesResult}
+	 */
+	getDependenciesFromPackageJson(
+		projectDir: string
+	): IPackageJsonDepedenciesResult;
+	preparePluginNativeCode(
+		preparePluginNativeCodeData: IPreparePluginNativeCodeData
+	): Promise<void>;
+	isNativeScriptPlugin(pluginPackageJsonPath: string): boolean;
+}
+
+interface IPreparePluginNativeCodeData {
+	pluginData: IPluginData;
+	platform: string;
+	projectData: IProjectData;
+}
+
+interface IPackageJsonDepedenciesResult {
+	dependencies: IBasePluginData[];
+	devDependencies?: IBasePluginData[];
+}
+
+interface IBasePluginData {
+	name: string;
+	version: string;
+}
+
+interface IPluginData extends INodeModuleData {
+	platformsData: IPluginPlatformsData;
+	/* Gets all plugin variables from plugin */
+	pluginVariables: IDictionary<IPluginVariableData>;
+	pluginPlatformsFolderPath(platform: string): string;
+}
+
+interface INodeModuleData extends IBasePluginData {
+	fullPath: string;
+	isPlugin: boolean;
+	nativescript: any;
+}
+
+interface IPluginPlatformsData {
+	ios: string;
+	android: string;
+}
+
+interface IPluginVariableData {
+	defaultValue?: string;
+	name?: string;
+	value?: string;
+}

package/lib/definitions/prepare.d.ts

@@ -0,0 +1,51 @@
+import { EventEmitter } from "events";
+import { IControllerDataBase } from "./data";
+import { IPlatformData } from "./platform";
+import { IProjectData } from "./project";
+
+declare global {
+	interface IPrepareData extends IControllerDataBase {
+		release: boolean;
+		hmr: boolean;
+		env: any;
+		watch?: boolean;
+		watchNative: boolean;
+		watchNodeModules?: boolean;
+	}
+
+	interface IiOSCodeSigningData {
+		teamId: string;
+		provision: string;
+		mobileProvisionData: any;
+	}
+
+	interface IiOSPrepareData extends IPrepareData, IiOSCodeSigningData {}
+
+	interface IPrepareDataService {
+		getPrepareData(
+			projectDir: string,
+			platform: string,
+			data: any
+		): IPrepareData;
+	}
+
+	interface IPrepareController extends EventEmitter {
+		prepare(prepareData: IPrepareData): Promise<IPrepareResultData>;
+		stopWatchers(projectDir: string, platform: string): Promise<void>;
+		toggleFileWatcher: () => Promise<boolean>;
+		// toggleWatchNodeModules: () => Promise<boolean>;
+	}
+
+	interface IPrepareResultData {
+		platform: string;
+		hasNativeChanges: boolean;
+	}
+
+	interface IPrepareNativePlatformService {
+		prepareNativePlatform(
+			platformData: IPlatformData,
+			projectData: IProjectData,
+			prepareData: IPrepareData
+		): Promise<boolean>;
+	}
+}

package/lib/definitions/project-changes.d.ts

@@ -0,0 +1,34 @@
+import { IStringDictionary } from "../common/declarations";
+
+interface IAppFilesHashes {
+	appFilesHashes?: IStringDictionary;
+}
+
+interface IPrepareInfo extends IAddedNativePlatform, IAppFilesHashes {
+	time?: string;
+	bundle?: boolean;
+	release?: boolean;
+	projectFileHash?: string;
+	changesRequireBuild?: boolean;
+	changesRequireBuildTime?: string;
+	iOSProvisioningProfileUUID?: string;
+}
+
+interface IProjectChangesInfo extends IAddedNativePlatform {
+	appResourcesChanged: boolean;
+	configChanged: boolean;
+	nativeChanged: boolean;
+	signingChanged: boolean;
+	nsConfigChanged: boolean;
+
+	readonly hasChanges: boolean;
+	readonly changesRequireBuild: boolean;
+	readonly changesRequirePrepare: boolean;
+}
+
+/**
+ * NativePlatformStatus.requiresPlatformAdd | NativePlatformStatus.requiresPrepare | NativePlatformStatus.alreadyPrepared
+ */
+interface IAddedNativePlatform {
+	nativePlatformStatus: "1" | "2" | "3";
+}