feat: add ability to pass schema and keys to preview app from public api and nsconfig

Author: Fatme

lib/commands/preview.ts

@@ -29,7 +29,11 @@ export class PreviewCommand implements ICommand {
 			env: this.$options.env
 		});
 
-		await this.$previewQrCodeService.printLiveSyncQrCode({ useHotModuleReload: this.$options.hmr, link: this.$options.link });
+		await this.$previewQrCodeService.printLiveSyncQrCode({
+			nsConfigPreviewAppSchema: this.$projectData.previewAppSchema,
+			useHotModuleReload: this.$options.hmr,
+			link: this.$options.link
+		});
 	}
 
 	public async canExecute(args: string[]): Promise<boolean> {

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

@@ -18,15 +18,28 @@ declare global {
 		filesToRemove?: string[];
 	}
 
-	interface IPreviewAppLiveSyncData extends IProjectDir, IHasUseHotModuleReloadOption, IBundle, IEnvOptions { }
+	interface IPreviewAppLiveSyncData extends IProjectDir, IHasUseHotModuleReloadOption, IBundle, IEnvOptions {
+		qrCodeData?: IPreviewAppQrCodeData;
+	}
+
+	interface IPreviewAppQrCodeData {
+		publishKey?: string;
+		subscribeKey?: string;
+		schemaName?: string;
+	}
 
 	interface IPreviewSdkService extends EventEmitter {
-		getQrCodeUrl(options: IHasUseHotModuleReloadOption): string;
+		getQrCodeUrl(options: IGetQrCodeUrlOptions): string;
 		initialize(getInitialFiles: (device: Device) => Promise<FilesPayload>): void;
 		applyChanges(filesPayload: FilesPayload): Promise<void>;
 		stop(): void;
 	}
 
+	interface IGetQrCodeUrlOptions extends IHasUseHotModuleReloadOption {
+		nsConfigPreviewAppSchema?: string;
+		qrCodeData?: IPreviewAppQrCodeData;
+	}
+
 	interface IPreviewAppPluginsService {
 		getPluginsUsageWarnings(data: IPreviewAppLiveSyncData, device: Device): string[];
 		comparePluginsOnDevice(data: IPreviewAppLiveSyncData, device: Device): Promise<void>;
@@ -48,6 +61,7 @@ declare global {
 	}
 
 	interface IPrintLiveSyncOptions extends IHasUseHotModuleReloadOption {
+		nsConfigPreviewAppSchema?: string;
 		/**
 		 * If set to true, a link will be shown on console instead of QR code
 		 * Default value is false.

lib/definitions/project.d.ts

@@ -75,6 +75,7 @@ interface INsConfig {
 	appResourcesPath?: string;
 	shared?: boolean;
 	useLegacyWorkflow?: boolean;
+	previewAppSchema?: string;
 }
 
 interface IProjectData extends ICreateProjectData {
@@ -105,6 +106,11 @@ interface IProjectData extends ICreateProjectData {
 	 */
 	useLegacyWorkflow: boolean;
 
+	/**
+	 * Defines the schema for the preview app
+	 */
+	previewAppSchema: string;
+
 	/**
 	 * Initializes project data with the given project directory. If none supplied defaults to --path option or cwd.
 	 * @param {string} projectDir Project root directory.

lib/project-data.ts

@@ -62,6 +62,7 @@ export class ProjectData implements IProjectData {
 	public podfilePath: string;
 	public isShared: boolean;
 	public useLegacyWorkflow: boolean;
+	public previewAppSchema: string;
 
 	constructor(private $fs: IFileSystem,
 		private $errors: IErrors,
@@ -137,6 +138,7 @@ export class ProjectData implements IProjectData {
 			this.podfilePath = path.join(this.appResourcesDirectoryPath, this.$devicePlatformsConstants.iOS, constants.PODFILE_NAME);
 			this.isShared = !!(this.nsConfig && this.nsConfig.shared);
 			this.useLegacyWorkflow = this.nsConfig && this.nsConfig.useLegacyWorkflow;
+			this.previewAppSchema = this.nsConfig && this.nsConfig.previewAppSchema;
 			return;
 		}
 

lib/services/livesync/livesync-service.ts

@@ -66,7 +66,12 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
 			env: data.env,
 		});
 
-		const url = this.$previewSdkService.getQrCodeUrl({ useHotModuleReload: data.useHotModuleReload });
+		const projectData = this.$projectDataService.getProjectData(data.projectDir);
+		const url = this.$previewSdkService.getQrCodeUrl({
+			nsConfigPreviewAppSchema: projectData.previewAppSchema,
+			qrCodeData: data.qrCodeData,
+			useHotModuleReload: data.useHotModuleReload
+		});
 		const result = await this.$previewQrCodeService.getLiveSyncQrCode(url);
 		return result;
 	}

lib/services/livesync/playground/preview-sdk-service.ts

@@ -16,9 +16,13 @@ export class PreviewSdkService extends EventEmitter implements IPreviewSdkServic
 			super();
 	}
 
-	public getQrCodeUrl(options: IHasUseHotModuleReloadOption): string {
-		const hmrValue = options.useHotModuleReload ? "1" : "0";
-		return `nsplay://boot?instanceId=${this.instanceId}&pKey=${PubnubKeys.PUBLISH_KEY}&sKey=${PubnubKeys.SUBSCRIBE_KEY}&template=play-ng&hmr=${hmrValue}`;
+	public getQrCodeUrl(options: IGetQrCodeUrlOptions): string {
+		const { nsConfigPreviewAppSchema, qrCodeData = { }, useHotModuleReload } = options;
+		const schema = qrCodeData.schemaName || nsConfigPreviewAppSchema || "nsplay";
+		const publishKey = qrCodeData.publishKey || PubnubKeys.PUBLISH_KEY;
+		const subscribeKey = qrCodeData.subscribeKey || PubnubKeys.SUBSCRIBE_KEY;
+		const hmrValue = useHotModuleReload ? "1" : "0";
+		return `${schema}://boot?instanceId=${this.instanceId}&pKey=${publishKey}&sKey=${subscribeKey}&template=play-ng&hmr=${hmrValue}`;
 	}
 
 	public async initialize(getInitialFiles: (device: Device) => Promise<FilesPayload>): Promise<void> {