Merge pull request #4093 from NativeScript/fatme/preview-api-livesync

feat(preview-api): expose public api for starting the livesync operation to preview app

Author: Dimitar Tachev

lib/definitions/livesync.d.ts

@@ -166,7 +166,7 @@ interface ILiveSyncInfo extends IProjectDir, IEnvOptions, IBundle, IRelease, IOp
 	 * Defines the timeout in seconds {N} CLI will wait to find the inspector socket port from device's logs.
 	 * If not provided, defaults to 10seconds.
 	 */
-	timeout: string;
+	timeout?: string;
 }
 
 interface IHasSyncToPreviewAppOption {

lib/definitions/preview-app-livesync.d.ts

@@ -24,6 +24,7 @@ declare global {
 
 	interface IPreviewQrCodeService {
 		getPlaygroundAppQrCode(options?: IPlaygroundAppQrCodeOptions): Promise<IDictionary<IQrCodeImageData>>;
+		getLiveSyncQrCode(url: string): Promise<IQrCodeImageData>;
 		printLiveSyncQrCode(options: IPrintLiveSyncOptions): Promise<void>;
 	}
 

lib/services/livesync/livesync-service.ts

@@ -39,6 +39,8 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 		private $analyticsService: IAnalyticsService,
 		private $usbLiveSyncService: DeprecatedUsbLiveSyncService,
 		private $previewAppLiveSyncService: IPreviewAppLiveSyncService,
+		private $previewQrCodeService: IPreviewQrCodeService,
+		private $previewSdkService: IPreviewSdkService,
 		private $hmrStatusService: IHmrStatusService,
 		private $injector: IInjector) {
 		super();
@@ -51,6 +53,21 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 		await this.liveSyncOperation(deviceDescriptors, liveSyncData, projectData);
 	}
 
+	public async liveSyncToPreviewApp(data: IPreviewAppLiveSyncData): Promise<IQrCodeImageData> {
+		await this.liveSync([], {
+			syncToPreviewApp: true,
+			projectDir: data.projectDir,
+			bundle: data.appFilesUpdaterOptions.bundle,
+			useHotModuleReload: data.appFilesUpdaterOptions.useHotModuleReload,
+			release: false,
+			env: data.env,
+		});
+
+		const url = this.$previewSdkService.getQrCodeUrl({ useHotModuleReload: data.appFilesUpdaterOptions.useHotModuleReload });
+		const result = await this.$previewQrCodeService.getLiveSyncQrCode(url);
+		return result;
+	}
+
 	public async stopLiveSync(projectDir: string, deviceIdentifiers?: string[], stopOptions?: { shouldAwaitAllActions: boolean }): Promise<void> {
 		const liveSyncProcessInfo = this.liveSyncProcessesInfo[projectDir];
 

lib/services/livesync/playground/preview-qr-code-service.ts

@@ -19,16 +19,26 @@ export class PreviewQrCodeService implements IPreviewQrCodeService {
 		const result = Object.create(null);
 
 		if (!options || !options.platform || this.$mobileHelper.isAndroidPlatform(options.platform)) {
-			result.android = await this.getQrCodeImageData(PlaygroundStoreUrls.GOOGLE_PLAY_URL);
+			result.android = await this.getLiveSyncQrCode(PlaygroundStoreUrls.GOOGLE_PLAY_URL);
 		}
 
 		if (!options || !options.platform || this.$mobileHelper.isiOSPlatform(options.platform)) {
-			result.ios = await this.getQrCodeImageData(PlaygroundStoreUrls.APP_STORE_URL);
+			result.ios = await this.getLiveSyncQrCode(PlaygroundStoreUrls.APP_STORE_URL);
 		}
 
 		return result;
 	}
 
+	public async getLiveSyncQrCode(url: string): Promise<IQrCodeImageData> {
+		const shortenUrl = await this.getShortenUrl(url);
+		const imageData = await this.$qr.generateDataUri(shortenUrl);
+		return {
+			originalUrl: url,
+			shortenUrl,
+			imageData
+		};
+	}
+
 	public async printLiveSyncQrCode(options: IPrintLiveSyncOptions): Promise<void> {
 		const qrCodeUrl = this.$previewSdkService.getQrCodeUrl(options);
 		const url = await this.getShortenUrl(qrCodeUrl);
@@ -63,15 +73,5 @@ To scan the QR code and deploy your app on a device, you need to have the \`Nati
 
 		return url;
 	}
-
-	private async getQrCodeImageData(url: string): Promise<IQrCodeImageData> {
-		const shortenUrl = await this.getShortenUrl(url);
-		const imageData = await this.$qr.generateDataUri(shortenUrl);
-		return {
-			originalUrl: url,
-			shortenUrl,
-			imageData
-		};
-	}
 }
 $injector.register("previewQrCodeService", PreviewQrCodeService);

test/services/livesync-service.ts

@@ -38,6 +38,8 @@ const createTestInjector = (): IInjector => {
 		}
 	});
 	testInjector.register("previewAppLiveSyncService", {});
+	testInjector.register("previewQrCodeService", {});
+	testInjector.register("previewSdkService", {});
 
 	return testInjector;
 };
@@ -60,6 +62,8 @@ class LiveSyncServiceInheritor extends LiveSyncService {
 		$usbLiveSyncService: DeprecatedUsbLiveSyncService,
 		$injector: IInjector,
 		$previewAppLiveSyncService: IPreviewAppLiveSyncService,
+		$previewQrCodeService: IPreviewQrCodeService,
+		$previewSdkService: IPreviewSdkService,
 		$hmrStatusService: IHmrStatusService,
 		$platformsData: IPlatformsData) {
 
@@ -80,6 +84,8 @@ class LiveSyncServiceInheritor extends LiveSyncService {
 			$analyticsService,
 			$usbLiveSyncService,
 			$previewAppLiveSyncService,
+			$previewQrCodeService,
+			$previewSdkService,
 			$hmrStatusService,
 			$injector
 		);