nativescript 9.1.0-alpha.15 → 9.1.0-alpha.17

package/lib/common/declarations.d.ts

@@ -35,10 +35,6 @@ interface IiTunesConnectApplicationType {
  * Their values are the names of the methods in universnal-analytics that have to be called to track this type of data.
  * Also known as Hit Type: https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#t
  */
-declare const enum GoogleAnalyticsDataType {
-	Page = "pageview",
-	Event = "event",
-}
 
 /**
  * Descibes iTunes Connect applications
@@ -170,7 +166,7 @@ declare module Server {
 		httpRequest(url: string): Promise<IResponse>;
 		httpRequest(
 			options: any,
-			proxySettings?: IProxySettings
+			proxySettings?: IProxySettings,
 		): Promise<IResponse>;
 	}
 
@@ -196,79 +192,14 @@ interface IShouldDispose {
 /**
  * Describes the type of data sent to analytics service.
  */
-declare const enum TrackingTypes {
-	/**
-	 * Defines that the data contains information for initialization of a new Analytics monitor.
-	 */
-	Initialization = "initialization",
-
-	/**
-	 * Defines that the data contains exception that should be tracked.
-	 */
-	Exception = "exception",
-
-	/**
-	 * Defines that the data contains the answer of the question if user allows to be tracked.
-	 */
-	AcceptTrackFeatureUsage = "acceptTrackFeatureUsage",
-
-	/**
-	 * Defines data that will be tracked to Google Analytics.
-	 */
-	GoogleAnalyticsData = "googleAnalyticsData",
-
-	/**
-	 * Defines that the broker process should send all the pending information to Analytics.
-	 * After that the process should send information it has finished tracking and die gracefully.
-	 */
-	FinishTracking = "FinishTracking",
-}
 
 /**
  * Describes the status of the current Analytics status, i.e. has the user allowed to be tracked.
  */
-declare const enum AnalyticsStatus {
-	/**
-	 * User has allowed to be tracked.
-	 */
-	enabled = "enabled",
-
-	/**
-	 * User has declined to be tracked.
-	 */
-	disabled = "disabled",
-
-	/**
-	 * User has not been asked to allow feature and error tracking.
-	 */
-	notConfirmed = "not confirmed",
-}
 
 /**
  * Describes types of options that manage -- flags.
  */
-declare const enum OptionType {
-	/**
-	 * String option
-	 */
-	String = "string",
-	/**
-	 * Boolean option
-	 */
-	Boolean = "boolean",
-	/**
-	 * Number option
-	 */
-	Number = "number",
-	/**
-	 * Array option
-	 */
-	Array = "array",
-	/**
-	 * Object option
-	 */
-	Object = "object",
-}
 
 /**
  * Describes options that can be passed to fs.readFile method.
@@ -289,13 +220,13 @@ interface IFileSystem {
 	zipFiles(
 		zipFile: string,
 		files: string[],
-		zipPathCallback: (path: string) => string
+		zipPathCallback: (path: string) => string,
 	): Promise<void>;
 	unzip(
 		zipFile: string,
 		destinationDir: string,
 		options?: { overwriteExisitingFiles?: boolean; caseSensitive?: boolean },
-		fileFilters?: string[]
+		fileFilters?: string[],
 	): Promise<void>;
 
 	/**
@@ -351,7 +282,7 @@ interface IFileSystem {
 
 	futureFromEvent(
 		eventEmitter: NodeJS.EventEmitter,
-		event: string
+		event: string,
 	): Promise<any>;
 
 	/**
@@ -424,7 +355,7 @@ interface IFileSystem {
 		filename: string,
 		data: any,
 		space?: string,
-		encoding?: string
+		encoding?: string,
 	): void;
 
 	/**
@@ -450,7 +381,7 @@ interface IFileSystem {
 	isEmptyDir(directoryPath: string): boolean;
 
 	isRelativePath(
-		path: string
+		path: string,
 	): boolean /* feels so lonely here, I don't have a Future */;
 
 	/**
@@ -523,7 +454,7 @@ interface IFileSystem {
 			start?: number;
 			end?: number;
 			highWaterMark?: number;
-		}
+		},
 	): NodeJS.ReadableStream;
 	createWriteStream(
 		path: string,
@@ -531,7 +462,7 @@ interface IFileSystem {
 			flags?: string;
 			encoding?: string;
 			string?: string;
-		}
+		},
 	): any;
 
 	/**
@@ -546,7 +477,10 @@ interface IFileSystem {
 	enumerateFilesInDirectorySync(
 		directoryPath: string,
 		filterCallback?: (file: string, stat: IFsStats) => boolean,
-		opts?: { enumerateDirectories?: boolean; includeEmptyDirectories?: boolean }
+		opts?: {
+			enumerateDirectories?: boolean;
+			includeEmptyDirectories?: boolean;
+		},
 	): string[];
 
 	/**
@@ -557,7 +491,7 @@ interface IFileSystem {
 	 */
 	getFileShasum(
 		fileName: string,
-		options?: { algorithm?: string; encoding?: "hex" | "base64" }
+		options?: { algorithm?: string; encoding?: "hex" | "base64" },
 	): Promise<string>;
 
 	// shell.js wrappers
@@ -626,7 +560,7 @@ interface IErrors {
 	failWithHelp(opts: IFailOptions, ...args: any[]): never;
 	beginCommand(
 		action: () => Promise<boolean>,
-		printCommandHelp: () => Promise<void>
+		printCommandHelp: () => Promise<void>,
 	): Promise<boolean>;
 	verifyHeap(message: string): void;
 	printCallStack: boolean;
@@ -656,18 +590,6 @@ interface ICommandOptions {
 	disableCommandHelpSuggestion?: boolean;
 }
 
-declare const enum ErrorCodes {
-	UNCAUGHT = 120,
-	UNKNOWN = 127,
-	INVALID_ARGUMENT = 128,
-	RESOURCE_PROBLEM = 129,
-	KARMA_FAIL = 130,
-	UNHANDLED_REJECTION_FAILURE = 131,
-	DELETED_KILL_FILE = 132,
-	TESTS_INIT_REQUIRED = 133,
-	ALL_DEVICES_DISCONNECTED = 134,
-}
-
 interface IFutureDispatcher {
 	run(): void;
 	dispatch(action: () => Promise<void>): void;
@@ -691,33 +613,33 @@ interface IChildProcess extends NodeJS.EventEmitter {
 	exec(
 		command: string,
 		options?: any,
-		execOptions?: IExecOptions
+		execOptions?: IExecOptions,
 	): Promise<any>;
 	execFile<T>(command: string, args: string[]): Promise<T>;
 	spawn(
 		command: string,
 		args?: string[],
-		options?: any
+		options?: any,
 	): child_process.ChildProcess; // it returns child_process.ChildProcess you can safely cast to it
 	spawnFromEvent(
 		command: string,
 		args: string[],
 		event: string,
 		options?: any,
-		spawnFromEventOptions?: ISpawnFromEventOptions
+		spawnFromEventOptions?: ISpawnFromEventOptions,
 	): Promise<ISpawnResult>;
 	trySpawnFromCloseEvent(
 		command: string,
 		args: string[],
 		options?: any,
-		spawnFromEventOptions?: ISpawnFromEventOptions
+		spawnFromEventOptions?: ISpawnFromEventOptions,
 	): Promise<ISpawnResult>;
 	tryExecuteApplication(
 		command: string,
 		args: string[],
 		event: string,
 		errorMessage: string,
-		condition?: (childProcess: any) => boolean
+		condition?: (childProcess: any) => boolean,
 	): Promise<any>;
 	/**
 	 * This is a special case of the child_process.spawn() functionality for spawning Node.js processes.
@@ -739,7 +661,7 @@ interface IChildProcess extends NodeJS.EventEmitter {
 			silent?: boolean;
 			uid?: number;
 			gid?: number;
-		}
+		},
 	): any;
 }
 
@@ -781,7 +703,7 @@ interface IAnalyticsService {
 	getStatusMessage(
 		settingName: string,
 		jsonFormat: boolean,
-		readableSettingName: string
+		readableSettingName: string,
 	): Promise<string>;
 	isEnabled(settingName: string): Promise<boolean>;
 	finishTracking(): Promise<void>;
@@ -828,7 +750,7 @@ interface IPrompterOptions extends IAllowEmpty {
 type IPrompterAnswers<T extends string = string> = { [id in T]: any };
 
 interface IPrompterQuestion<
-	T extends IPrompterAnswers<any> = IPrompterAnswers<any>
+	T extends IPrompterAnswers<any> = IPrompterAnswers<any>,
 > {
 	type?: string;
 	name?: string;
@@ -839,7 +761,7 @@ interface IPrompterQuestion<
 	filter?(input: any, answers: T): any;
 	validate?(
 		input: any,
-		answers?: T
+		answers?: T,
 	): boolean | string | Promise<boolean | string>;
 }
 
@@ -902,15 +824,26 @@ interface IAutoCompletionService {
 	isObsoleteAutoCompletionEnabled(): boolean;
 }
 
+interface IHookExecutionOptions {
+	/**
+	 * Set by call sites that fold the returned middlewares around a method (the
+	 * `@hook` decorator). Where nothing consumes them, `ctx.wrap()` rejects
+	 * instead of registering a middleware that would never run.
+	 */
+	consumesMiddlewares?: boolean;
+}
+
 interface IHooksService {
 	hookArgsName: string;
+	/** Resolves with the middlewares hooks registered through `ctx.wrap()`. */
 	executeBeforeHooks(
 		commandName: string,
-		hookArguments?: IDictionary<any>
-	): Promise<void>;
+		hookArguments?: IDictionary<any>,
+		options?: IHookExecutionOptions,
+	): Promise<import("./define-hook").HookMiddleware[]>;
 	executeAfterHooks(
 		commandName: string,
-		hookArguments?: IDictionary<any>
+		hookArguments?: IDictionary<any>,
 	): Promise<void>;
 }
 
@@ -938,9 +871,7 @@ interface IRejectUnauthorized {
  * Proxy settings required for http request.
  */
 interface IProxySettings
-	extends IRejectUnauthorized,
-		ICredentials,
-		IProxySettingsBase {
+	extends IRejectUnauthorized, ICredentials, IProxySettingsBase {
 	/**
 	 * Hostname of the machine used for proxy.
 	 */
@@ -1077,7 +1008,7 @@ interface ISystemWarning {
 
 interface ISysInfo {
 	getSysInfo(
-		config?: NativeScriptDoctor.ISysInfoConfig
+		config?: NativeScriptDoctor.ISysInfoConfig,
 	): Promise<NativeScriptDoctor.ISysInfoData>;
 	/**
 	 * Returns the currently installed version of Xcode.
@@ -1438,14 +1369,14 @@ interface IProjectFilesManager {
 		projectFilesPath: string,
 		excludedProjectDirsAndFiles?: string[],
 		filter?: (filePath: string, stat: IFsStats) => boolean,
-		opts?: any
+		opts?: any,
 	): string[];
 	/**
 	 * Checks if the file is excluded
 	 */
 	isFileExcluded(
 		filePath: string,
-		excludedProjectDirsAndFiles?: string[]
+		excludedProjectDirsAndFiles?: string[],
 	): boolean;
 	/**
 	 * Returns an object that maps every local file path to device file path
@@ -1456,7 +1387,7 @@ interface IProjectFilesManager {
 		projectFilesPath: string,
 		files: string[],
 		excludedProjectDirsAndFiles: string[],
-		projectFilesConfig?: IProjectFilesConfig
+		projectFilesConfig?: IProjectFilesConfig,
 	): Promise<Mobile.ILocalToDevicePathData[]>;
 
 	/**
@@ -1471,7 +1402,7 @@ interface IProjectFilesManager {
 		directoryPath: string,
 		platform: string,
 		projectFilesConfig?: IProjectFilesConfig,
-		excludedDirs?: string[]
+		excludedDirs?: string[],
 	): void;
 }
 
@@ -1487,7 +1418,7 @@ interface IProjectFilesProvider {
 		filePath: string,
 		platform: string,
 		projectData: any,
-		projectFilesConfig?: IProjectFilesConfig
+		projectFilesConfig?: IProjectFilesConfig,
 	): string;
 
 	/**
@@ -1500,7 +1431,7 @@ interface IProjectFilesProvider {
 	getProjectFileInfo(
 		filePath: string,
 		platform: string,
-		projectFilesConfig: IProjectFilesConfig
+		projectFilesConfig: IProjectFilesConfig,
 	): IProjectFileInfo;
 	/**
 	 * Parses file by removing platform or configuration from its name.
@@ -1510,7 +1441,7 @@ interface IProjectFilesProvider {
 	 */
 	getPreparedFilePath(
 		filePath: string,
-		projectFilesConfig: IProjectFilesConfig
+		projectFilesConfig: IProjectFilesConfig,
 	): string;
 }
 
@@ -1612,7 +1543,7 @@ interface INet {
 	 * @returns {boolean} true in case port is in LISTEN state, false otherwise.
 	 */
 	waitForPortToListen(
-		waitForPortListenData: IWaitForPortListenData
+		waitForPortListenData: IWaitForPortListenData,
 	): Promise<boolean>;
 }
 
@@ -1680,7 +1611,7 @@ interface IiOSNotificationService {
 	awaitNotification(
 		deviceIdentifier: string,
 		socket: number,
-		timeout: number
+		timeout: number,
 	): Promise<string>;
 
 	/**
@@ -1693,7 +1624,7 @@ interface IiOSNotificationService {
 	postNotification(
 		deviceIdentifier: string,
 		notification: string,
-		commandType?: string
+		commandType?: string,
 	): Promise<number>;
 }
 

package/lib/common/decorators.d.ts

@@ -0,0 +1,13 @@
+import { IInjector } from "./definitions/yok";
+export declare function cache(): any;
+interface MemoizeOptions {
+    hashFn?: (...args: any[]) => any;
+    shouldCache?: (result: any) => boolean;
+}
+export declare function memoize(options: MemoizeOptions): any;
+export declare function invokeBefore(methodName: string, methodArgs?: any[]): any;
+export declare function invokeInit(): any;
+export declare function exported(moduleName: string): any;
+export declare function performanceLog(localInjector?: IInjector): any;
+export declare function deprecated(additionalInfo?: string, localInjector?: IInjector): any;
+export {};

package/lib/common/decorators.js

@@ -9,32 +9,6 @@ exports.performanceLog = performanceLog;
 exports.deprecated = deprecated;
 const constants_1 = require("../constants");
 const yok_1 = require("./yok");
-/**
- * Caches the result of the first execution of the method and returns it whenever it is called instead of executing it again.
- * Works with methods and getters.
- * @example
- * ```
- * class CacheDecoratorsTest {
- *
- * 	@cache()
- * 	public method(num: number): number {
- * 		return num;
- * 	}
- *
- * 	@cache()
- * 	public get property(): any {
- * 		// execute some heavy operation.
- * 		return result;
- * 	}
- * }
- *
- * const instance = new CacheDecoratorsTest();
- * const result = instance.method(1); // returns 1;
- *
- * // all consecutive calls to instance.method will return 1.
- * const result2 = instance.method(2); // returns 1;
- * ```
- */
 function cache() {
     return (target, propertyKey, descriptor) => {
         let result;
@@ -54,7 +28,6 @@ function cache() {
 let memoizeIDCounter = 0;
 function memoize(options) {
     return (target, propertyKey, descriptor) => {
-        // todo: remove once surely working as intended.
         const DEBUG = false;
         const memoizeID = memoizeIDCounter++;
         const valueOrGet = descriptor.value ? "value" : "get";
@@ -75,7 +48,6 @@ function memoize(options) {
                     cacheMapName,
                     hashKey,
                 });
-            // initialize cache map if not exists
             if (!this.hasOwnProperty(cacheMapName)) {
                 DEBUG && console.log("NO CACHE MAP YET, CREATING ONE NOW");
                 Object.defineProperty(this, cacheMapName, {
@@ -90,16 +62,12 @@ function memoize(options) {
                 console.log({
                     cacheMap,
                 });
-            // check if has memoized value based on hashFn
             if (cacheMap.has(hashKey)) {
                 DEBUG && console.log("CACHE HIT");
-                // if yes, return cached value
                 return cacheMap.get(hashKey);
             }
             DEBUG && console.log("CACHE MISS");
-            // if not call original and get result
             const result = originalMethod.apply(this, args);
-            // call shouldCache (if passed) with the result or default to true
             let shouldCache = true;
             if (options.shouldCache) {
                 shouldCache = options.shouldCache.call(this, result);
@@ -109,21 +77,12 @@ function memoize(options) {
                 DEBUG && console.log("CACHING NOW");
                 cacheMap.set(hashKey, result);
             }
-            // if shouldCache: save result
             DEBUG && console.log("RETURNING", result);
             return result;
         };
         return descriptor;
     };
 }
-/**
- * Calls specific method of the instance before executing the decorated method.
- * This is usable when some of your methods depend on initialize async method, that cannot be invoked in constructor of the class.
- * IMPORTANT: The decorated method must be async.
- * @param {string} methodName The name of the method that will be invoked before calling the decorated method.
- * @param {any[]} methodArgs Args that will be passed to the method that will be invoked before calling the decorated one.
- * @return {any} Result of the decorated method.
- */
 function invokeBefore(methodName, methodArgs) {
     return (target, propertyKey, descriptor) => {
         const originalValue = descriptor.value;
@@ -155,7 +114,6 @@ function performanceLog(localInjector) {
         const className = target.constructor.name;
         const trackName = `${className}${constants_1.AnalyticsEventLabelDelimiter}${propertyKey}`;
         const performanceService = localInjector.resolve("performanceService");
-        //needed for the returned function to have the same name as the original - used in hooks decorator
         const functionWrapper = {
             [originalMethod.name]: function (...args) {
                 const start = performanceService.now();
@@ -181,14 +139,12 @@ function performanceLog(localInjector) {
             },
         };
         descriptor.value = functionWrapper[originalMethod.name];
-        // used to get parameter names in hooks decorator
         descriptor.value.toString = () => {
             return originalMethod.toString();
         };
         return descriptor;
     };
 }
-// inspired by https://github.com/NativeScript/NativeScript/blob/55dfe25938569edbec89255008e5ad9804901305/tns-core-modules/globals/globals.ts#L121-L137
 function deprecated(additionalInfo, localInjector) {
     const isDeprecatedMessage = " is deprecated.";
     return (target, key, descriptor) => {
@@ -197,7 +153,6 @@ function deprecated(additionalInfo, localInjector) {
         const $logger = localInjector.resolve("logger");
         if (descriptor) {
             if (descriptor.value) {
-                // method
                 const originalMethod = descriptor.value;
                 descriptor.value = function (...args) {
                     $logger.warn(`${key.toString()}${isDeprecatedMessage} ${additionalInfo}`);
@@ -206,7 +161,6 @@ function deprecated(additionalInfo, localInjector) {
                 return descriptor;
             }
             else {
-                // property
                 if (descriptor.set) {
                     const originalSetter = descriptor.set;
                     descriptor.set = function (...args) {
@@ -225,7 +179,6 @@ function deprecated(additionalInfo, localInjector) {
             }
         }
         else {
-            // class
             $logger.warn(`${(target &&
                 (target.name ||
                     (target.constructor && target.constructor.name))) ||
@@ -234,4 +187,3 @@ function deprecated(additionalInfo, localInjector) {
         }
     };
 }
-//# sourceMappingURL=decorators.js.map

package/lib/common/define-command.d.ts

@@ -0,0 +1,53 @@
+export declare const COMMAND_DEFINITION_MARKER: unique symbol;
+export type CommandOptionType = "boolean" | "string" | "number" | "array";
+export interface CommandOptionSpec<TValue = any> {
+    type: CommandOptionType;
+    default?: TValue;
+    alias?: string | string[];
+    hasSensitiveValue?: boolean;
+    description?: string;
+}
+export interface DefaultedCommandOptionSpec<TValue = any> extends CommandOptionSpec<TValue> {
+    default: TValue;
+}
+export type CommandOptionSpecInit<TValue = any> = Omit<CommandOptionSpec<TValue>, "type">;
+export interface CommandOptionsSchema {
+    [optionName: string]: CommandOptionSpec;
+}
+type CommandOptionValue<TSpec> = TSpec extends CommandOptionSpec<infer TValue> ? TSpec extends {
+    default: any;
+} ? TValue : TValue | undefined : any;
+export type CommandOptionValues<TSchema extends CommandOptionsSchema> = {
+    [K in keyof TSchema]: CommandOptionValue<TSchema[K]>;
+};
+export interface CommandContext<TSchema extends CommandOptionsSchema = {}> {
+    args: string[];
+    options: CommandOptionValues<TSchema>;
+    fail(message: string): never;
+}
+export interface CommandDefinition<TSchema extends CommandOptionsSchema = {}> {
+    name: string | string[];
+    description?: string;
+    options?: TSchema;
+    arguments?: "none" | "any";
+    canExecute?(context: CommandContext<TSchema>): Promise<boolean> | boolean;
+    disableAnalytics?: boolean;
+    enableHooks?: boolean;
+    run(context: CommandContext<TSchema>): Promise<void> | void;
+}
+export type DefinedCommand<TSchema extends CommandOptionsSchema = {}> = CommandDefinition<TSchema> & {
+    readonly [COMMAND_DEFINITION_MARKER]: true;
+};
+interface IOptionHelper<TValue> {
+    (init: CommandOptionSpecInit<TValue> & {
+        default: TValue;
+    }): DefaultedCommandOptionSpec<TValue>;
+    (init?: CommandOptionSpecInit<TValue>): CommandOptionSpec<TValue>;
+}
+export declare const booleanOption: IOptionHelper<boolean>;
+export declare const stringOption: IOptionHelper<string>;
+export declare const numberOption: IOptionHelper<number>;
+export declare const arrayOption: IOptionHelper<string[]>;
+export declare function defineCommand<TSchema extends CommandOptionsSchema = {}>(definition: CommandDefinition<TSchema>): DefinedCommand<TSchema>;
+export declare function isCommandDefinition(value: any): value is DefinedCommand;
+export {};