@akylas/nativescript-cli 8.7.2

package/lib/definitions/android-bundle-tool-service.d.ts

@@ -0,0 +1,17 @@
+import { IAndroidSigningData } from "./build";
+
+interface IAndroidBundleToolService {
+	buildApks(options: IBuildApksOptions): Promise<void>;
+	installApks(options: IInstallApksOptions): Promise<void>;
+}
+
+interface IBuildApksOptions {
+	aabFilePath: string;
+	apksOutputPath: string;
+	signingData: IAndroidSigningData;
+}
+
+interface IInstallApksOptions {
+	apksFilePath: string;
+	deviceId: string;
+}

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

@@ -0,0 +1,52 @@
+import { IAndroidToolsInfoData } from "../declarations";
+import { IProjectDir } from "../common/declarations";
+
+interface IPluginBuildOptions extends IAndroidBuildOptions {
+	projectDir?: string;
+}
+
+interface IAndroidBuildOptions {
+	platformsAndroidDirPath: string;
+	pluginName: string;
+	aarOutputDir: string;
+	tempPluginDirPath: string;
+	gradleArgs?: string[];
+	gradlePath?: string;
+}
+
+interface IAndroidPluginBuildService {
+	buildAar(options: IPluginBuildOptions): Promise<boolean>;
+	migrateIncludeGradle(options: IPluginBuildOptions): boolean;
+}
+
+/**
+ * Describes data required for building plugin for Android.
+ * The data can be consumed in the buildAndroidPlugin hook.
+ */
+interface IBuildAndroidPluginData extends Partial<IProjectDir> {
+	/**
+	 * Directory where the plugin will be build.
+	 * Usually this is the `<project dir>/platforms/tempPlugin/<plugin name>` dir.
+	 */
+	pluginDir: string;
+
+	/**
+	 * The name of the plugin.
+	 */
+	pluginName: string;
+
+	/**
+	 * Information about tools that will be used to build the plugin, for example compile SDK version, build tools version, etc.
+	 */
+	androidToolsInfo?: IAndroidToolsInfoData;
+
+	/**
+	 * Optional custom Gradle path.
+	 */
+	gradlePath?: string;
+
+	/**
+	 * Optional custom Gradle arguments.
+	 */
+	gradleArgs?: string[];
+}

package/lib/definitions/build.d.ts

@@ -0,0 +1,92 @@
+import { IHasAndroidBundle, IApplicationPackage } from "../declarations";
+import { IProjectData } from "./project";
+import {
+	IValidBuildOutputData,
+	IPlatformData,
+	IBuildOutputOptions,
+	IBuildInfo,
+} from "./platform";
+
+interface IBuildData extends IPrepareData {
+	device?: string;
+	_device?: Mobile.IDevice;
+	emulator?: boolean;
+	clean: boolean;
+	buildForDevice?: boolean;
+	buildForAppStore?: boolean;
+	buildOutputStdio?: string;
+	outputPath?: string;
+	copyTo?: string;
+}
+
+interface IiOSBuildData extends IBuildData {
+	teamId: string;
+	provision: string;
+	mobileProvisionData: any;
+	buildForAppStore: boolean;
+	iCloudContainerEnvironment: string;
+}
+
+interface IAndroidBuildData
+	extends IBuildData,
+		IAndroidSigningData,
+		IHasAndroidBundle {
+	buildFilterDevicesArch?: boolean;
+	gradleArgs?: string[];
+	gradleFlavor?: string;
+	gradlePath?: string;
+}
+
+interface IAndroidSigningData {
+	keyStoreAlias: string;
+	keyStorePath: string;
+	keyStoreAliasPassword: string;
+	keyStorePassword: string;
+}
+
+interface IBuildController {
+	prepareAndBuild(buildData: IBuildData): Promise<string>;
+	build(buildData: IBuildData): Promise<string>;
+	buildIfNeeded(buildData: IBuildData): Promise<string>;
+	shouldBuild(buildData: IBuildData): Promise<boolean>;
+}
+
+interface IBuildDataService {
+	getBuildData(projectDir: string, platform: string, data: any): IBuildData;
+}
+
+interface IBuildArtifactsService {
+	getAllAppPackages(
+		buildOutputPath: string,
+		validBuildOutputData: IValidBuildOutputData
+	): IApplicationPackage[];
+	getLatestAppPackagePath(
+		platformData: IPlatformData,
+		buildOutputOptions: IBuildOutputOptions
+	): Promise<string>;
+	copyAppPackages(
+		targetPath: string,
+		platformData: IPlatformData,
+		buildOutputOptions: IBuildOutputOptions
+	): void;
+}
+
+interface IBuildInfoFileService {
+	getLocalBuildInfo(
+		platformData: IPlatformData,
+		buildData: IBuildData
+	): IBuildInfo;
+	getDeviceBuildInfo(
+		device: Mobile.IDevice,
+		projectData: IProjectData
+	): Promise<IBuildInfo>;
+	saveLocalBuildInfo(
+		platformData: IPlatformData,
+		buildInfoFileDirname: string
+	): void;
+	saveDeviceBuildInfo(
+		device: Mobile.IDevice,
+		projectData: IProjectData,
+		outputFilePath: string
+	): Promise<void>;
+}

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

@@ -0,0 +1,79 @@
+import { IShouldDispose, IDisposable } from "../common/declarations";
+import {
+	ISpawnCommandInfo,
+	IJSCommand,
+} from "../detached-processes/cleanup-process-definitions";
+
+/**
+ * Descibes the cleanup service which allows scheduling cleanup actions
+ * The actions will be executed once CLI process exits.
+ */
+interface ICleanupService extends IShouldDispose, IDisposable {
+	/**
+	 * Add new action to be executed when CLI process exits.
+	 * @param {ISpawnCommandInfo} commandInfo The command that should be executed, including command and args.
+	 * @returns {Promise<void>}
+	 */
+	addCleanupCommand(commandInfo: ISpawnCommandInfo): Promise<void>;
+
+	/**
+	 * Remove action to be executed when CLI process exits.
+	 * NOTE: The action should be added in the action list by calling `addCleanupAction` first.
+	 * @param {ISpawnCommandInfo} commandInfo The command that should be removed from cleanup execution, including command and args.
+	 * @returns {Promise<void>}
+	 */
+	removeCleanupCommand(commandInfo: ISpawnCommandInfo): Promise<void>;
+
+	/**
+	 * Sets the file in which the cleanup process will write its logs.
+	 * This method must be called before starting the cleanup process, i.e. when CLI is initialized.
+	 * @param {string} filePath Path to file where the logs will be written. The logs are appended to the passed file.
+	 * @returns {void}
+	 */
+	setCleanupLogFile(filePath: string): void;
+
+	/**
+	 * Adds file/dir to be deleted once CLI process exits.
+	 * @param {string} filePath Path to file/directory to be deleted.
+	 * @returns {Promise<void>}
+	 */
+	addCleanupDeleteAction(filePath: string): Promise<void>;
+
+	/**
+	 * Removes file/dir from the list of files to be deleted once CLI process exits.
+	 * NOTE: The file should be first added with `addCleanupDeleteAction`
+	 * @param {string} filePath Path to file/directory to be removed from the list of files to be deleted.
+	 * @returns {Promise<void>}
+	 */
+	removeCleanupDeleteAction(filePath: string): Promise<void>;
+
+	/**
+	 * Adds JS file to be required and executed during cleanup.
+	 * NOTE: The JS file will be required in a new child process, so you can pass timeout for the execution.
+	 * In the child process you can use all injected dependencies of CLI.
+	 * @param {IJSCommand} jsCommand Information about the JS file to be required and the data that should be passed to it.
+	 * @returns {Promise<void>}
+	 */
+	addCleanupJS(jsCommand: IJSCommand): Promise<void>;
+
+	/**
+	 * Removes JS file to be required and executed during cleanup.
+	 * @param {IJSCommand} filePath jsCommand Information about the JS file to be required and the data that should not be passed to it.
+	 * @returns {Promise<void>}
+	 */
+	removeCleanupJS(jsCommand: IJSCommand): Promise<void>;
+
+	/**
+	 * Adds a kill action for the process
+	 * @param pid the pid of the process to be killed
+	 * @returns {Promise<void>}
+	 */
+	addKillProcess(pid: string): Promise<void>;
+
+	/**
+	 * Removes the kill action for the process
+	 * @param pid the pid of the process to be killed
+	 * @returns {Promise<void>}
+	 */
+	removeKillProcess(pid: string): Promise<void>;
+}

package/lib/definitions/data.d.ts

@@ -0,0 +1,7 @@
+import { INativePrepare } from "./project";
+
+interface IControllerDataBase {
+	projectDir: string;
+	platform: string;
+	nativePrepare?: INativePrepare;
+}

package/lib/definitions/debug.d.ts

@@ -0,0 +1,166 @@
+import { IProjectData } from "./project";
+import { IDebugInformation } from "../declarations";
+import { IProjectDir, IPlatform } from "../common/declarations";
+
+interface IDebugData
+	extends IProjectDir,
+		Mobile.IDeviceIdentifier,
+		IOptionalDebuggingOptions {
+	applicationIdentifier: string;
+	projectName?: string;
+}
+
+/**
+ * Describes all options that define the behavior of debug.
+ */
+interface IDebugOptions {
+	/**
+	 * Defines if Chrome DevTools should be used for debugging.
+	 */
+	chrome?: boolean;
+
+	/**
+	 * Defines if thе application is already started on device.
+	 */
+	start?: boolean;
+
+	/**
+	 * Defines if we should stop the currently running debug process.
+	 */
+	stop?: boolean;
+
+	/**
+	 * Defines if the debug process should break on the first line.
+	 */
+	debugBrk?: boolean;
+
+	/**
+	 * Defines if the debug process will not have a client attached (i.e. the process will be started, but NativeScript Inspector will not be started and it will not attach to the running debug process).
+	 */
+	client?: boolean;
+
+	/**
+	 * Defines if the process will watch for further changes in the project and transferrs them to device immediately, resulting in restar of the debug process.
+	 */
+	justlaunch?: boolean;
+
+	/**
+	 * Defines if bundled Chrome DevTools should be used or specific commit.
+	 * Default value is true for Android and false for iOS.
+	 */
+	useBundledDevTools?: boolean;
+
+	/**
+	 * Defines if https://chrome-devtools-frontend.appspot.com should be used instead of chrome-devtools://devtools
+	 * In case it is passed, the value of `useBundledDevTools` is disregarded.
+	 * Default value is false.
+	 */
+	useHttpUrl?: boolean;
+
+	/**
+	 * Defines the commit that will be used in cases where remote protocol is required.
+	 * For Android this is the case when useHttpUrl is set to true or useBundledDevTools is set to false.
+	 * For iOS the value is used by default and when useHttpUrl is set to true.
+	 * Default value is 02e6bde1bbe34e43b309d4ef774b1168d25fd024 which corresponds to 55.0.2883 Chrome version
+	 */
+	devToolsCommit?: string;
+
+	/**
+	 * Defines if the iOS App Inspector should be used instead of providing URL to debug the application with Chrome DevTools
+	 */
+	inspector?: boolean;
+	/**
+	 * Defines if should print all availableDevices
+	 */
+	availableDevices?: boolean;
+	/**
+	 * Defines the timeout in seconds {N} CLI will wait to find the inspector socket port from device's logs.
+	 * If not provided, defaults to 10 seconds.
+	 */
+	timeout?: string;
+	/**
+	 * The sdk version of the emulator.
+	 */
+	sdk?: string;
+	/**
+	 * Forces the debugger attach event to be emitted.
+	 */
+	forceDebuggerAttachedEvent?: boolean;
+}
+
+/**
+ * Describes methods to create debug data object used by other methods.
+ */
+interface IDebugDataService {
+	/**
+	 * Creates the debug data based on specified options.
+	 * @param {string} deviceIdentifier The identifier of the device
+	 * @param {IProjectData} projectData The data describing project that will be debugged.
+	 * @param {IDebugOptions} debugOptions The debug options
+	 * @returns {IDebugData} Data describing the required information for starting debug process.
+	 */
+	getDebugData(
+		deviceIdentifier: string,
+		projectData: IProjectData,
+		debugOptions: IDebugOptions
+	): IDebugData;
+}
+
+/**
+ * Describes actions required for debugging on specific platform (Android or iOS).
+ */
+interface IDeviceDebugService extends IPlatform, NodeJS.EventEmitter {
+	/**
+	 * Stops debug operation.
+	 * @returns {Promise<void>}
+	 */
+	debugStop(): Promise<void>;
+
+	/**
+	 * Starts debug operation based on the specified debug data.
+	 * @param {IAppDebugData} debugData Describes information for application that will be debugged.
+	 * @param {IDebugOptions} debugOptions Describe possible options to modify the behaivor of the debug operation, for example stop on the first line.
+	 * @returns {Promise<string>} Full url where the frontend client may be connected.
+	 */
+	debug(
+		debugData: IAppDebugData,
+		debugOptions: IDebugOptions
+	): Promise<IDebugResultInfo>;
+}
+
+interface IDebugResultInfo {
+	debugUrl: string;
+}
+
+interface IAppDebugData extends IProjectDir {
+	/**
+	 * Application identifier of the app that it will be debugged.
+	 */
+	applicationIdentifier: string;
+
+	/**
+	 * The name of the application, for example `MyProject`.
+	 */
+	projectName?: string;
+}
+
+interface IDebugController {
+	startDebug(debugData: IDebugData): Promise<IDebugInformation>;
+	stopDebug(deviceIdentifier: string): Promise<void>;
+	printDebugInformation(
+		debugInformation: IDebugInformation,
+		fireDebuggerAttachedEvent?: boolean
+	): IDebugInformation;
+	enableDebuggingCoreWithoutWaitingCurrentAction(
+		projectDir: string,
+		deviceIdentifier: string,
+		debugOptions: IDebugOptions
+	): Promise<IDebugInformation>;
+	enableDebugging(
+		enableDebuggingData: IEnableDebuggingData
+	): Promise<IDebugInformation>[];
+	disableDebugging(disableDebuggingData: IDisableDebuggingData): Promise<void>;
+	attachDebugger(
+		attachDebuggerData: IAttachDebuggerData
+	): Promise<IDebugInformation>;
+}

package/lib/definitions/deploy.d.ts

@@ -0,0 +1,3 @@
+interface IDeployController {
+	deploy(data: IRunData): Promise<void>;
+}

package/lib/definitions/file-log-service.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Describes message that needs to be logged in the analytics logging file.
+ */
+interface IFileLogMessage {
+	message: string;
+	type?: FileLogMessageType;
+}
+
+/**
+ * Describes methods to get local logs from analytics tracking.
+ */
+interface IFileLogService {
+	/**
+	 * Logs specified message to the previously specified file.
+	 * @param {IFileLogMessage} fileLogMessage The message that has to be written to the logs file.
+	 * @returns {void}
+	 */
+	logData(fileLogMessage: IFileLogMessage): void;
+}

package/lib/definitions/files-hash-service.d.ts

@@ -0,0 +1,35 @@
+import { IPlatformData } from "./platform";
+import { IStringDictionary } from "../common/declarations";
+
+interface IFilesHashService {
+	generateHashes(files: string[]): Promise<IStringDictionary>;
+	/**
+	 * Generate hashes for all prepared files (all files from app folder under platforms folder).
+	 * @param platformData - Current platform's data
+	 * @returns {Promise<IStringDictionary>}
+	 * A map with key file's path and value - file's hash
+	 */
+	generateHashesForProject(
+		platformData: IPlatformData
+	): Promise<IStringDictionary>;
+	/**
+	 * Generates hashes for all prepared files (all files from app folder under platforms folder)
+	 * and saves them in .nshashes file under `hashFileDirectory` directory.
+	 * @param platformData - Current platform's data
+	 * @param hashesFileDirectory - Path to directory containing the hash file.
+	 * @returns {Promise<void>}
+	 */
+	saveHashesForProject(
+		platformData: IPlatformData,
+		hashesFileDirectory: string
+	): Promise<IStringDictionary>;
+	saveHashes(hashes: IStringDictionary, hashesFileDirectory: string): void;
+	getChanges(
+		files: string[],
+		oldHashes: IStringDictionary
+	): Promise<IStringDictionary>;
+	hasChangesInShasums(
+		oldHashes: IStringDictionary,
+		newHashes: IStringDictionary
+	): boolean;
+}

package/lib/definitions/gradle.d.ts

@@ -0,0 +1,33 @@
+import { IAndroidBuildData } from "./build";
+import { ISpawnResult, ISpawnFromEventOptions } from "../common/declarations";
+
+interface IGradleCommandService {
+	executeCommand(
+		gradleArgs: string[],
+		options: IGradleCommandOptions
+	): Promise<ISpawnResult>;
+}
+
+interface IGradleCommandOptions {
+	cwd: string;
+	message?: string;
+	stdio?: string;
+	spawnOptions?: ISpawnFromEventOptions;
+	gradlePath?: string;
+}
+
+interface IGradleBuildService {
+	buildProject(
+		projectRoot: string,
+		buildData: IAndroidBuildData
+	): Promise<void>;
+	cleanProject(
+		projectRoot: string,
+		buildData: IAndroidBuildData
+	): Promise<void>;
+}
+
+interface IGradleBuildArgsService {
+	getBuildTaskArgs(buildData: IAndroidBuildData): Promise<string[]>;
+	getCleanTaskArgs(buildData: IAndroidBuildData): string[];
+}

package/lib/definitions/hmr-status-service.d.ts

@@ -0,0 +1,5 @@
+interface IHmrStatusService {
+	watchHmrStatus(deviceId: string, operationHash: string): void;
+	getHmrStatus(deviceId: string, operationHash: string): Promise<number>;
+	attachToHmrStatusEvent(): void;
+}

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

@@ -0,0 +1,11 @@
+import { IConfigurationSettings } from "../common/declarations";
+
+interface IInitializeOptions {
+	loggerOptions?: ILoggerOptions;
+	settingsServiceOptions?: IConfigurationSettings;
+	extensibilityOptions?: { pathToExtensions: string };
+}
+
+interface IInitializeService {
+	initialize(initOpts?: IInitializeOptions): Promise<void>;
+}

package/lib/definitions/ios-debugger-port-service.d.ts

@@ -0,0 +1,29 @@
+interface IIOSDebuggerPortInputData {
+	deviceId: string;
+	appId: string;
+}
+
+interface IIOSDebuggerPortData {
+	port: number;
+	deviceId: string;
+	appId: string;
+}
+
+interface IIOSDebuggerPortStoredData {
+	port: number;
+	timer?: NodeJS.Timer;
+	error?: Error;
+}
+
+interface IIOSDebuggerPortService {
+	/**
+	 * Gets iOS debugger port for specified deviceId and appId
+	 * @param {IIOSDebuggerPortInputData} data - Describes deviceId and appId
+	 */
+	getPort(data: IIOSDebuggerPortInputData): Promise<number>;
+	/**
+	 * Attaches on DEBUGGER_PORT_FOUND event and stores the port
+	 * @returns {Promise<void>}
+	 */
+	attachToDebuggerPortFoundEvent(appId: string): Promise<void>;
+}

package/lib/definitions/ios.d.ts

@@ -0,0 +1,97 @@
+import { IOSBuildData } from "../data/build-data";
+import { IProjectData, IBuildConfig } from "./project";
+import { IPlatformData } from "./platform";
+import { ISpawnResult } from "../common/declarations";
+
+declare global {
+	interface IiOSSigningService {
+		setupSigningForDevice(
+			projectRoot: string,
+			projectData: IProjectData,
+			buildConfig: IOSBuildData
+		): Promise<void>;
+		setupSigningFromTeam(
+			projectRoot: string,
+			projectData: IProjectData,
+			teamId: string
+		): Promise<void>;
+		setupSigningFromProvision(
+			projectRoot: string,
+			projectData: IProjectData,
+			provision?: string,
+			mobileProvisionData?: any
+		): Promise<void>;
+	}
+
+	interface IXcodebuildService {
+		buildForSimulator(
+			platformData: IPlatformData,
+			projectData: IProjectData,
+			buildConfig: IBuildConfig
+		): Promise<void>;
+		buildForDevice(
+			platformData: IPlatformData,
+			projectData: IProjectData,
+			buildConfig: IBuildConfig
+		): Promise<string>;
+		buildForAppStore(
+			platformData: IPlatformData,
+			projectData: IProjectData,
+			buildConfig: IBuildConfig
+		): Promise<string>;
+	}
+
+	interface ISPMService {
+		applySPMPackages(platformData: IPlatformData, projectData: IProjectData);
+	}
+
+	interface IXcodebuildArgsService {
+		getBuildForSimulatorArgs(
+			platformData: IPlatformData,
+			projectData: IProjectData,
+			buildConfig: IBuildConfig
+		): Promise<string[]>;
+		getBuildForDeviceArgs(
+			platformData: IPlatformData,
+			projectData: IProjectData,
+			buildConfig: IBuildConfig
+		): Promise<string[]>;
+		getXcodeProjectArgs(
+			platformData: IPlatformData,
+			projectData: IProjectData
+		): string[];
+	}
+
+	interface IXcodebuildCommandService {
+		executeCommand(
+			args: string[],
+			options: IXcodebuildCommandOptions
+		): Promise<ISpawnResult>;
+	}
+
+	interface IXcodebuildCommandOptions {
+		message?: string;
+		cwd: string;
+		stdio?: string;
+		spawnOptions?: any;
+	}
+
+	interface IExportOptionsPlistService {
+		createDevelopmentExportOptionsPlist(
+			archivePath: string,
+			projectData: IProjectData,
+			buildConfig: IBuildConfig
+		): Promise<IExportOptionsPlistOutput>;
+		createDistributionExportOptionsPlist(
+			projectRoot: string,
+			projectData: IProjectData,
+			buildConfig: IBuildConfig
+		): Promise<IExportOptionsPlistOutput>;
+	}
+
+	interface IExportOptionsPlistOutput {
+		exportFileDir: string;
+		exportFilePath: string;
+		exportOptionsPlistFilePath: string;
+	}
+}

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

@@ -0,0 +1,10 @@
+/**
+ * Describes the service used to get information for the current IP Address.
+ */
+interface IIPService {
+	/**
+	 * Gives information about the current public IPv4 address.
+	 * @returns {Promise<string>} The IP address or null in case unable to find the current IP.
+	 */
+	getCurrentIPv4Address(): Promise<string>;
+}

package/lib/definitions/livesync-global.d.ts

@@ -0,0 +1,7 @@
+import { Socket } from "net";
+
+declare global {
+	interface INetSocket extends Socket {
+		uid?: string;
+	}
+}