refactor(definitions): make the legacy service interfaces contract aliases

Each of the twelve interfaces becomes 'interface IFoo extends Foo {}',
so a service has one declaration instead of two that can drift, and the
existing 'implements IFoo' clause enforces the contract at the
implementation site.

Four methods on Mobile.IDevicesService and two on IProjectDataService
were public, exported through the require('nativescript') surface and
asserted by its test, yet declared nowhere; they are now on both the
interface and the contract.

These declarations were previously invisible to the compiler under
skipLibCheck. Moving them into .ts files puts them under type checking,
which is what surfaced the parameter initializers that are illegal in a
declaration file.

Author: edusperoni

lib/common/declarations.d.ts

@@ -2,6 +2,7 @@ import { Layout, LoggingEvent, Configuration, Level } from "log4js";
 import { EventEmitter } from "events";
 import { LoggerLevel } from "../../constants";
 import { IDictionary } from "../declarations";
+import type { Logger } from "../../contracts/logger";
 
 declare global {
 	interface IAppenderOptions extends IDictionary<any> {
@@ -14,28 +15,13 @@ declare global {
 		appenderOptions?: IAppenderOptions;
 	}
 
-	interface ILogger {
-		initialize(opts?: ILoggerOptions): void;
-		initializeCliLogger(opts?: ILoggerOptions): void;
-		getLevel(): string;
-		fatal(formatStr?: any, ...args: any[]): void;
-		error(formatStr?: any, ...args: any[]): void;
-		warn(formatStr?: any, ...args: any[]): void;
-		info(formatStr?: any, ...args: any[]): void;
-		debug(formatStr?: any, ...args: any[]): void;
-		trace(formatStr?: any, ...args: any[]): void;
-		printMarkdown(...args: any[]): void;
-		prepare(item: any): string;
-		isVerbose(): boolean;
-		clearScreen(): void;
-	}
+	interface ILogger extends Logger {}
 
 	interface Log4JSAppenderConfiguration extends Configuration {
 		layout: Layout;
 	}
 
-	interface Log4JSEmitAppenderConfiguration
-		extends Log4JSAppenderConfiguration {
+	interface Log4JSEmitAppenderConfiguration extends Log4JSAppenderConfiguration {
 		emitter: EventEmitter;
 	}
 }

lib/common/definitions/logger.d.ts

@@ -11,6 +11,7 @@ import {
 	IHasEmulatorOption,
 	IDisposable,
 } from "../declarations";
+import type { DevicesService } from "../../contracts/devices-service";
 
 declare global {
 	export module Mobile {
@@ -587,107 +588,7 @@ declare global {
 			[platform: string]: string;
 		}
 
-		interface IDevicesService extends NodeJS.EventEmitter, IPlatform {
-			hasDevices: boolean;
-			deviceCount: number;
-
-			execute<T>(
-				action: (device: Mobile.IDevice) => Promise<T>,
-				canExecute?: (dev: Mobile.IDevice) => boolean,
-				options?: { allowNoDevices?: boolean },
-			): Promise<IDeviceActionResult<T>[]>;
-
-			/**
-			 * Initializes DevicesService, so after that device operations could be executed.
-			 * @param {IDevicesServicesInitializationOptions} data Defines the options which will be used for whole devicesService.
-			 * @return {Promise<void>}
-			 */
-			initialize(data?: IDevicesServicesInitializationOptions): Promise<void>;
-
-			/**
-			 * Add an IDeviceDiscovery instance which will from now on report devices. The instance should implement IDeviceDiscovery and raise "deviceFound" and "deviceLost" events.
-			 * @param {IDeviceDiscovery} deviceDiscovery Instance, implementing IDeviceDiscovery and raising raise "deviceFound" and "deviceLost" events.
-			 * @return {void}
-			 */
-			addDeviceDiscovery(deviceDiscovery: IDeviceDiscovery): void;
-			getDevices(): Mobile.IDeviceInfo[];
-
-			/**
-			 * Gets device instance by specified identifier or number.
-			 * @param {string} deviceOption The specified device identifier or number.
-			 * @returns {Promise<Mobile.IDevice>} Instance of IDevice.
-			 */
-			getDevice(deviceOption: string): Promise<Mobile.IDevice>;
-			getDevicesForPlatform(platform: string): Mobile.IDevice[];
-			getDeviceInstances(): Mobile.IDevice[];
-			getDeviceByDeviceOption(): Mobile.IDevice;
-			isAndroidDevice(device: Mobile.IDevice): boolean;
-			isiOSDevice(device: Mobile.IDevice): boolean;
-			isiOSSimulator(device: Mobile.IDevice): boolean;
-			isOnlyiOSSimultorRunning(): boolean;
-			isAppInstalledOnDevices(
-				deviceIdentifiers: string[],
-				appIdentifier: string,
-				framework: string,
-				projectDir: string,
-			): Promise<IAppInstalledInfo>[];
-			setLogLevel(logLevel: string, deviceIdentifier?: string): void;
-			deployOnDevices(
-				deviceIdentifiers: string[],
-				packageFile: string,
-				packageName: string,
-				framework: string,
-				projectDir: string,
-			): Promise<void>[];
-			getDeviceByIdentifier(identifier: string): Mobile.IDevice;
-			mapAbstractToTcpPort(
-				deviceIdentifier: string,
-				appIdentifier: string,
-				framework: string,
-			): Promise<string>;
-			getDebuggableApps(
-				deviceIdentifiers: string[],
-			): Promise<Mobile.IDeviceApplicationInformation[]>[];
-			getDebuggableViews(
-				deviceIdentifier: string,
-				appIdentifier: string,
-			): Promise<Mobile.IDebugWebViewInfo[]>;
-
-			/**
-			 * Returns all applications installed on the specified device.
-			 * @param {string} deviceIdentifer The identifier of the device for which to get installed applications.
-			 * @returns {Promise<string[]>} Array of all application identifiers of the apps installed on device.
-			 */
-			getInstalledApplications(deviceIdentifier: string): Promise<string[]>;
-
-			/**
-			 * Returns all available iOS and/or Android emulators.
-			 * @param options The options that can be passed to filter the result.
-			 * @returns {Promise<Mobile.IListEmulatorsOutput>} Dictionary with the following format: { ios: { devices: Mobile.IDeviceInfo[], errors: string[] }, android: { devices: Mobile.IDeviceInfo[], errors: string[]}}.
-			 */
-			getEmulatorImages(
-				options?: Mobile.IListEmulatorsOptions,
-			): Promise<Mobile.IListEmulatorsOutput>;
-
-			/**
-			 * Starts an emulator by provided options.
-			 * @param options
-			 * @returns {Promise<string[]>} - Returns array of errors.
-			 */
-			startEmulator(options?: IStartEmulatorOptions): Promise<string[]>;
-
-			/**
-			 * Returns a single device based on the specified options. If more than one devices are matching,
-			 * prompts the user for a manual choice or returns the first one for non interactive terminals.
-			 */
-			pickSingleDevice(
-				options: IPickSingleDeviceOptions,
-			): Promise<Mobile.IDevice>;
-
-			getPlatformsFromDeviceDescriptors(
-				deviceDescriptors: ILiveSyncDeviceDescriptor[],
-			): string[];
-		}
+		interface IDevicesService extends DevicesService {}
 
 		interface IPickSingleDeviceOptions {
 			/**

lib/common/definitions/mobile.d.ts

@@ -19,6 +19,7 @@ import {
 } from "./common/declarations";
 import { IExtensionData } from "./common/definitions/extensibility";
 import { IApplePortalUserDetail } from "./services/apple-portal/definitions";
+import type { PackageManager } from "./contracts/package-manager";
 
 interface INodePackageManager {
 	/**
@@ -108,21 +109,7 @@ interface INodePackageManager {
 	getCachePath(): Promise<string>;
 }
 
-interface IPackageManager extends INodePackageManager {
-	/**
-	 * Gets the name of the package manager used for the current process.
-	 * It can be read from the user settings or by passing -- option.
-	 */
-	getPackageManagerName(): Promise<string>;
-
-	/**
-	 * Gets the version corresponding to the tag for the package
-	 * @param {string} packageName The name of the package.
-	 * @param {string} tag The tag which we need the version of.
-	 * @returns {string} The version corresponding to the tag
-	 */
-	getTagVersion(packageName: string, tag: string): Promise<string>;
-}
+interface IPackageManager extends PackageManager {}
 
 interface IPerformanceService {
 	// Will process the data based on the command options (--performance flag and user-reporting setting)

lib/declarations.d.ts

@@ -18,6 +18,8 @@ import {
 } from "../common/declarations";
 import { SupportedConfigValues } from "../tools/config-manipulation/config-transformer";
 import * as constants from "../constants";
+import type { ProjectData } from "../contracts/project-data";
+import type { ProjectDataService } from "../contracts/project-data-service";
 
 interface IProjectName {
 	/**
@@ -209,165 +211,9 @@ interface INsConfig {
 	buildPath?: string;
 }
 
-interface IProjectData extends ICreateProjectData {
-	platformsDir: string;
-	projectFilePath: string;
-	projectId: string;
-	projectIdentifiers?: Mobile.IProjectIdentifier;
-	dependencies: any;
-	ignoredDependencies?: string[];
-	devDependencies: IStringDictionary;
-	appDirectoryPath: string;
-	appResourcesDirectoryPath: string;
-	projectType: string;
-	packageJsonData: any;
-	nsConfig: INsConfig;
-	androidManifestPath: string;
-	appGradlePath: string;
-	gradleFilesDirectoryPath: string;
-	infoPlistPath: string;
-	buildXcconfigPath: string;
-	podfilePath: string;
-	initialized?: boolean;
-	/**
-	 * Defines if the project is a code sharing one.
-	 * Value is true when project has nativescript.config and it has `shared: true` in it.
-	 */
-	isShared: boolean;
-	/**
-	 * Specifies the bundler used to build the application.
-	 *
-	 * - `"webpack"`: Uses Webpack for traditional bundling.
-	 * - `"rspack"`: Uses Rspack for fast bundling.
-	 * - `"vite"`: Uses Vite for fast bundling.
-	 *
-	 * @default "webpack"
-	 */
-	bundler: BundlerType;
-	/**
-	 * @deprecated Use bundlerConfigPath
-	 * Defines the path to the configuration file passed to webpack process.
-	 * By default this is the webpack.config.js at the root of the application.
-	 * The value can be changed by setting `webpackConfigPath` in nativescript.config.
-	 */
-	webpackConfigPath: string;
-	/**
-	 * Defines the path to the bundler configuration file passed to the compiler.
-	 * The value can be changed by setting `bundlerConfigPath` in nativescript.config.
-	 */
-	bundlerConfigPath: string;
-	projectName: string;
-
-	/**
-	 * Initializes project data with the given project directory. If none supplied defaults to --path option or cwd.
-	 * @param {string} projectDir Project root directory.
-	 * @returns {void}
-	 */
-	initializeProjectData(projectDir?: string): void;
-	initializeProjectDataFromContent(
-		packageJsonContent: string,
-		projectDir?: string,
-	): void;
-	getAppDirectoryPath(projectDir?: string): string;
-	getAppDirectoryRelativePath(): string;
-	getAppResourcesDirectoryPath(projectDir?: string): string;
-	getAppResourcesRelativeDirectoryPath(): string;
-}
-
-interface IProjectDataService {
-	/**
-	 * Returns a value from `nativescript` key in project's package.json.
-	 * @param {string} projectDir The project directory - the place where the root package.json is located.
-	 * @param {string} propertyName The name of the property to be checked in `nativescript` key.
-	 * @returns {any} The value of the property.
-	 */
-	getNSValue(projectDir: string, propertyName: string): any;
-
-	/**
-	 * Sets a value in the `nativescript` key in a project's package.json.
-	 * @param {string} projectDir The project directory - the place where the root package.json is located.
-	 * @param {string} key Key to be added to `nativescript` key in project's package.json.
-	 * @param {any} value Value of the key to be added to `nativescript` key in project's package.json.
-	 * @returns {void}
-	 */
-	setNSValue(projectDir: string, key: string, value: any): void;
-
-	/**
-	 * Removes a property from `nativescript` key in project's package.json.
-	 * @param {string} projectDir The project directory - the place where the root package.json is located.
-	 * @param {string} propertyName The name of the property to be removed from `nativescript` key.
-	 * @returns {void}
-	 */
-	removeNSProperty(projectDir: string, propertyName: string): void;
-
-	/**
-	 * Removes a property from `nativescript.config`.
-	 * @param {string} projectDir The project directory - the place where the `nativescript.config` is located.
-	 * @param {string} propertyName The name of the property to be removed.
-	 * @returns {void}
-	 */
-	removeNSConfigProperty(projectDir: string, propertyName: string): void;
+interface IProjectData extends ProjectData {}
 
-	/**
-	 * Removes dependency from package.json
-	 * @param {string} projectDir The project directory - the place where the root package.json is located.
-	 * @param {string} dependencyName Name of the dependency that has to be removed.
-	 * @returns {void}
-	 */
-	removeDependency(projectDir: string, dependencyName: string): void;
-
-	getProjectData(projectDir?: string): IProjectData;
-
-	/**
-	 * Gives information about the whole assets structure for both iOS and Android.
-	 * For each of the platforms, the returned object will contain icons, splashBackgrounds, splashCenterImages and splashImages (only for iOS).
-	 * @param {IProjectDir} opts Object with a single property - projectDir. This is the root directory where NativeScript project is located.
-	 * @returns {Promise<IAssetsStructure>} An object describing the current asset structure.
-	 */
-	getAssetsStructure(opts: IProjectDir): Promise<IAssetsStructure>;
-
-	/**
-	 * Gives information about the whole assets structure for iOS.
-	 * The returned object will contain icons, splashBackgrounds, splashCenterImages and splashImages.
-	 * @param {IProjectDir} opts Object with a single property - projectDir. This is the root directory where NativeScript project is located.
-	 * @returns {Promise<IAssetGroup>} An object describing the current asset structure for iOS.
-	 */
-	getIOSAssetsStructure(opts: IProjectDir): Promise<IAssetGroup>;
-
-	/**
-	 * Gives information about the whole assets structure for Android.
-	 * The returned object will contain icons, splashBackgrounds and splashCenterImages.
-	 * @param {IProjectDir} opts Object with a single property - projectDir. This is the root directory where NativeScript project is located.
-	 * @returns {Promise<IAssetGroup>} An object describing the current asset structure for Android.
-	 */
-	getAndroidAssetsStructure(opts: IProjectDir): Promise<IAssetGroup>;
-
-	/**
-	 * Returns array with paths to all `.js` or `.ts` files in application's app directory.
-	 * @param {string} projectDir Path to application.
-	 * @returns {string[]} Array of paths to `.js` or `.ts` files.
-	 */
-	getAppExecutableFiles(projectDir: string): string[];
-
-	/**
-	 * Returns package details for runtime, respecting the nativescript key for legacy projects
-	 * @param {string} projectDir Path to application.
-	 * @param {string} platform Platform key
-	 */
-	getRuntimePackage(
-		projectDir: string,
-		platform: SupportedPlatform,
-	): IBasePluginData;
-
-	/**
-	 * Returns a value from `nativescript` key in project's package.json.
-	 * @param {string} jsonData The project directory - the place where the root package.json is located.
-	 * @param {string} propertyName The name of the property to be checked in `nativescript` key.
-	 * @returns {any} The value of the property.
-	 * @deprecated no longer used - will be removed in 8.0.
-	 */
-	getNSValueFromContent(jsonData: Object, propertyName: string): any;
-}
+interface IProjectDataService extends ProjectDataService {}
 
 interface IProjectCleanupService {
 	/**

lib/definitions/project.d.ts

@@ -1,27 +1,5 @@
-import {
-	IPrompterOptions,
-	IAllowEmpty,
-	IDisposable,
-	IPrompterQuestion,
-} from "../common/declarations";
+import type { Prompter } from "../contracts/prompter";
 
 declare global {
-	interface IPrompter extends IDisposable {
-		get(schemas: IPrompterQuestion[]): Promise<any>;
-		getPassword(prompt: string, options?: IAllowEmpty): Promise<string>;
-		getString(prompt: string, options?: IPrompterOptions): Promise<string>;
-		promptForChoice(
-			promptMessage: string,
-			choices:
-				| string[]
-				| { title: string; description?: string; value?: string }[],
-			multiple: boolean = false,
-			options: any = {}
-		): Promise<string>;
-		promptForDetailedChoice(
-			promptMessage: string,
-			choices: { key: string; description: string }[]
-		): Promise<string>;
-		confirm(prompt: string, defaultAction?: () => boolean): Promise<boolean>;
-	}
+	interface IPrompter extends Prompter {}
 }