cloud-build-service.d.ts

/**
 * Describes the result of a cloud build operation.
 */
interface IBuildResultData extends IServerResultData {
	/**
	 * Path to the downloaded result of the build operation - .apk, .ipa...
	 */
	outputFilePath: string;

	/**
	 * Data required for generation of a QR code from the build result.
	 */
	qrData: IQrData;
}

/**
 * Describes build step.
 */
interface IBuildStep extends ICloudOperationId {
	/**
	 * The name of the step - prepare, upload, build or download.
	 */
	step: string;

	/**
	 * The progress of the step in percents. The value will be between 0 and 100.
	 */
	progress: number;
}

interface IBuildError extends Error, ICloudOperationId { }

interface ICloudOperationId {
	/**
	 * The ID of the cloud operation.
	 */
	cloudOperationId: string;
}

interface IBuildLog extends ICloudOperationId {
	data: string;
	pipe: string;
}

/**
 * Describes the data used for generating QR code from cloud build result.
 */
interface IQrData {
	/**
	 * The original URL (to S3), where built package is located.
	 */
	originalUrl: string;

	/**
	 * Base64 encoded data used for generating QR code image.
	 */
	imageData: string;
}

/**
 * Describes arguments that may be passed to the build action.
 */
interface ICloudBuildData {
	/**
	 * Describes the current project - project dir, application identifier, name and nativescript data.
	 */
	projectSettings: INSCloudProjectSettings;
	/**
	 * The mobile platform for which the application should be built: Android or iOS.
	 */
	platform: string;
	/**
	 * The build configuration - Debug or Release.
	 */
	buildConfiguration: string;
	/**
	 * Android specific information for the build.
	 */
	androidBuildData?: IAndroidBuildData;
	/**
	* iOSBuildData iOS specific information for the build.
	 */
	iOSBuildData?: IIOSBuildData;
}

/**
 * Describes options used for controlling cloud build infrastructure.
 */
interface ISharedCloud {
	/**
	 * If true will perform cloud operation on the shared cloud instead of the private one.
	 */
	sharedCloud: boolean;
}

/**
 * Defines operations for building a project in the cloud.
 */
interface ICloudBuildService extends ICloudService {
	/**
	 * Builds the specified application in the cloud and returns information about the whole build process.
	 * @param {INSCloudProjectSettings} projectSettings Describes the current project - project dir, application identifier, name and nativescript data.
	 * @param {string} platform The mobile platform for which the application should be built: Android or iOS.
	 * @param {string} buildConfiguration The build configuration - Debug or Release.
	 * @param {string} accountId the account which will be charged for the build.
	 * @param {IAndroidBuildData} androidBuildData Android specific information for the build.
	 * @param {IIOSBuildData} iOSBuildData iOS specific information for the build.
	 * @returns {Promise<IBuildResultData>} Information about the build process. It is returned only on successful build. In case the build fails, the Promise is rejected with the server information.
	 */
	build(projectSettings: INSCloudProjectSettings,
		platform: string,
		buildConfiguration: string,
		accountId: string,
		androidBuildData?: IAndroidBuildData,
		iOSBuildData?: IIOSBuildData,
		buildOptions?: IBuildOptions): Promise<IBuildResultData>;

	/**
	 * Validates the build properties for specified platform (Android or iOS).
	 * The result promise is rejected with the error found. In case everything is correct, the promise is resolved.
	 * @param {string} platform The mobile platform for which the application should be built: Android or iOS.
	 * @param {string} buildConfiguration The build configuration - Debug or Release.
	 * @param {string} projectId Application identifier of the project.
	 * @param {IAndroidBuildData} androidBuildData Android specific information for the build.
	 * @param {IIOSBuildData} iOSBuildData iOS specific information for the build.
	 * @returns {Promise<void>}
	 */
	validateBuildProperties(platform: string,
		buildConfiguration: string,
		projectId: string,
		androidBuildData?: IAndroidBuildData,
		iOSBuildData?: IIOSBuildData): Promise<void>;
}

/**
 * Defines properties passed to prepareBuildRequest method.
 */
interface IPrepareBuildRequestInfo extends ICloudOperationId, IAccountId {

	/**
	 * Settings used to control the build workflow.
	 */
	projectSettings: INSCloudProjectSettings;

	/**
	 * Platform for which to build.
	 */
	platform: string;

	/**
	 * Build configuration - debug or release.
	 */
	buildConfiguration: string;

	/**
	 * Credentials for building using git.
	 */
	buildCredentials: IBuildCredentialResponse;

	/**
	 * Files to upload prior to build.
	 */
	filesToUpload: IAmazonStorageEntryData[];

	/**
	 * Additional flags that can be passed to CLI in the cloud (e.g. `--env.uglify` or `--bundle`)
	 */
	additionalCliFlags: string[];
}

/**
 * Describes information about the project's name.
 */
interface IProjectNameComposition {

	/**
	 * The project's name
	 */
	projectName: string;
}

/**
 * Options that can be used to construct itms-services plist.
 */
interface IItmsPlistOptions extends IProjectNameComposition {
	/**
	 * The path to the mobileprovision file on the file system.
	 */
	pathToProvision?: string;

	/**
	 * The url pointing the .ipa file which is to be installed on the device by itms-services.
	 */
	url: string;

	/**
	 * The aforementioned .ipa file's application identifier
	 */
	projectId: string;
}

interface IBundle {
	bundle: boolean;
}

/**
 * Describes the project settings required for different operations.
 */
interface INSCloudProjectSettings extends IEnvOptions, IBundle, ISharedCloud, IProjectNameComposition, IWorkflowRequestData, IHasUseHotModuleReloadOption {
	/**
	 * The directory where the project is located. This should be the path to the directory where application's package.json is located.
	 */
	projectDir: string;

	/**
	 * Application identifier.
	 */
	projectId: string;

	/**
	 * The value of `nativescript` key from project's package.json.
	 */
	nativescriptData: any;

	/**
	 *  Whether to clean & build. By default incremental build without clean is performed.
	 */
	clean: boolean;

	/**
	 * The name of the template that is to be used when creating a new virtual machine in the private cloud.
	 */
	flavorId?: string;
}

/**
 * Describes specific data required for Android Builds.
 */
interface IAndroidBuildData {
	/**
	 * Path to certificate (.p12 or .keystore), used for code signing the application. Required and used only for release builds.
	 */
	pathToCertificate: string;

	/**
	 * Password of the specified certificate. Required and used only for release builds.
	 */
	certificatePassword: string;

	/**
	 * Android App Bundle (--aab) option.
	 */
	aab?: boolean;
}

/**
 * Describes specific data required for iOS Builds.
 */
interface IIOSBuildData extends IBuildForDevice {
	/**
	 * Path to mobile provision that will be used for current build operation.
	 */
	pathToProvision: string;

	/**
	 * Path to certificate (.p12), used for code signing the application.
	 */
	pathToCertificate: string;

	/**
	 * Password of the specified certificate.
	 */
	certificatePassword: string;

	/**
	 * @optional Device identifier that will be used for validation.
	 * In order to deploy the built application to this device, the identifier should be included in the mobile provision.
	 * In case you pass the deviceIdentifier and it is not included in the specified provision, the operation will fail.
	 */
	deviceIdentifier?: string;
}

/**
 * Here only for backwards compatibility. Deleting this will require a major version change as it is used in NativeScript Sidekick.
 */
interface ICloudBuildOutputDirectoryOptions extends IOutputDirectoryOptions {
}

interface ICloudOperationOutputOptions extends IOutputDirectoryOptions {
	extension?: string;
}

interface IBuildOptions {
	shouldPrepare: boolean;
}