appium 2.0.0-beta.9 → 2.0.0-rc.2

package/build/lib/utils.d.ts

@@ -0,0 +1,276 @@
+/**
+ * @template {CliCommand} [Cmd=ServerCommand]
+ * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @param {Args<Cmd, SubCmd>} args
+ * @returns {args is Args<ServerCommand>}
+ */
+export function isServerCommandArgs<Cmd extends import("appium/types").CliCommand = "server", SubCmd extends void | import("appium/types").CliExtensionSubcommand = void>(args: import("appium/types").Args<Cmd, SubCmd>): args is {
+    subcommand?: import("appium/types").CliCommand | undefined;
+    configFile?: string | undefined;
+    showConfig?: boolean | undefined;
+    shell?: boolean | undefined;
+    throwInsteadOfExit?: boolean | undefined;
+    logHandler?: ((...args: any[]) => void) | undefined;
+    appiumHome?: string | undefined;
+    showBuildInfo?: boolean | undefined;
+    driver?: import("@appium/types").DriverConfig | undefined;
+    plugin?: import("@appium/types").PluginConfig | undefined;
+    address?: string | undefined;
+    nodeconfig?: import("@appium/types").NodeconfigConfig | undefined;
+    port?: number | undefined;
+    webhook?: string | undefined;
+    allowCors?: NonNullable<boolean | undefined> | undefined;
+    allowInsecure?: import("@appium/types").AllowInsecureConfig | undefined;
+    basePath?: string | undefined;
+    callbackAddress?: string | undefined;
+    callbackPort?: number | undefined;
+    debugLogSpacing?: NonNullable<boolean | undefined> | undefined;
+    defaultCapabilities?: import("@appium/types").DefaultCapabilitiesConfig | undefined;
+    denyInsecure?: import("@appium/types").DenyInsecureConfig | undefined;
+    keepAliveTimeout?: number | undefined;
+    localTimezone?: NonNullable<boolean | undefined> | undefined;
+    logFilters?: import("@appium/types").LogFiltersConfig | undefined;
+    logNoColors?: NonNullable<boolean | undefined> | undefined;
+    logTimestamp?: NonNullable<boolean | undefined> | undefined;
+    longStacktrace?: NonNullable<boolean | undefined> | undefined;
+    noPermsCheck?: NonNullable<boolean | undefined> | undefined;
+    sessionOverride?: NonNullable<boolean | undefined> | undefined;
+    strictCaps?: NonNullable<boolean | undefined> | undefined;
+    traceDir?: string | undefined;
+    useDrivers?: import("@appium/types").UseDriversConfig | undefined;
+    usePlugins?: import("@appium/types").UsePluginsConfig | undefined;
+    logFile?: string | undefined;
+    loglevel?: NonNullable<import("@appium/types").LogLevelConfig | undefined> | undefined;
+    relaxedSecurityEnabled?: NonNullable<boolean | undefined> | undefined;
+    tmpDir?: string | undefined;
+};
+/**
+ * @template {CliCommand} [Cmd=ServerCommand]
+ * @template {CliExtensionSubcommand|void} [SubCmd=void]
+ * @param {Args<Cmd, SubCmd>} args
+ * @returns {args is Args<CliExtensionCommand, SubCmd>}
+ */
+export function isExtensionCommandArgs<Cmd extends import("appium/types").CliCommand = "server", SubCmd extends void | import("appium/types").CliExtensionSubcommand = void>(args: import("appium/types").Args<Cmd, SubCmd>): args is import("appium/types").ParsedArgs<"driver", SubCmd> | import("appium/types").ParsedArgs<"plugin", SubCmd>;
+/**
+ * @template {CliCommand} Cmd
+ * @template {CliExtensionSubcommand} SubCmd
+ * @param {Args<Cmd, SubCmd>} args
+ * @returns {args is Args<DriverCommand, SubCmd>}
+ */
+export function isDriverCommandArgs<Cmd extends import("appium/types").CliCommand, SubCmd extends import("appium/types").CliExtensionSubcommand>(args: import("appium/types").Args<Cmd, SubCmd>): args is import("appium/types").ParsedArgs<"driver", SubCmd>;
+/**
+ * @template {CliCommand} Cmd
+ * @template {CliExtensionSubcommand} SubCmd
+ * @param {Args<Cmd, SubCmd>} args
+ * @returns {args is Args<PluginCommand, SubCmd>}
+ */
+export function isPluginCommandArgs<Cmd extends import("appium/types").CliCommand, SubCmd extends import("appium/types").CliExtensionSubcommand>(args: import("appium/types").Args<Cmd, SubCmd>): args is import("appium/types").ParsedArgs<"plugin", SubCmd>;
+/**
+ * Fetches the list of IP addresses of the current host.
+ *
+ * @param {4|6|null} family Either 4 to include ipv4 addresses only,
+ * 6 to include ipv6 addresses only, or null to include all of them
+ * @returns {string[]} The list of matched IP addresses
+ */
+export function fetchIpAddresses(family?: 4 | 6 | null): string[];
+export const V4_BROADCAST_IP: "0.0.0.0";
+export const V6_BROADCAST_IP: "::";
+export type StringRecord = import('@appium/types').StringRecord;
+export type BaseDriverCapConstraints = import('@appium/types').BaseDriverCapConstraints;
+export type ParsedDriverCaps<C extends import("@appium/types").Constraints = {
+    readonly platformName: {
+        readonly presence: true;
+        readonly isString: true;
+    };
+    readonly app: {
+        readonly isString: true;
+    };
+    readonly deviceName: {
+        readonly isString: true;
+    };
+    readonly platformVersion: {
+        readonly isString: true;
+    };
+    readonly webSocketUrl: {
+        readonly isBoolean: true;
+    };
+    readonly newCommandTimeout: {
+        readonly isNumber: true;
+    };
+    readonly automationName: {
+        readonly isString: true;
+    };
+    readonly autoLaunch: {
+        readonly isBoolean: true;
+    };
+    readonly udid: {
+        readonly isString: true;
+    };
+    readonly orientation: {
+        readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"];
+    };
+    readonly autoWebview: {
+        readonly isBoolean: true;
+    };
+    readonly noReset: {
+        readonly isBoolean: true;
+    };
+    readonly fullReset: {
+        readonly isBoolean: true;
+    };
+    readonly language: {
+        readonly isString: true;
+    };
+    readonly locale: {
+        readonly isString: true;
+    };
+    readonly eventTimings: {
+        readonly isBoolean: true;
+    };
+    readonly printPageSourceOnFindFailure: {
+        readonly isBoolean: true;
+    };
+}, J = any> = {
+    desiredCaps: Capabilities<C>;
+    protocol: string;
+    processedJsonwpCapabilities?: J | undefined;
+    processedW3CCapabilities?: import("@appium/types").W3CCapabilities<C> | undefined;
+};
+export type InvalidCaps<C extends import("@appium/types").Constraints = {
+    readonly platformName: {
+        readonly presence: true;
+        readonly isString: true;
+    };
+    readonly app: {
+        readonly isString: true;
+    };
+    readonly deviceName: {
+        readonly isString: true;
+    };
+    readonly platformVersion: {
+        readonly isString: true;
+    };
+    readonly webSocketUrl: {
+        readonly isBoolean: true;
+    };
+    readonly newCommandTimeout: {
+        readonly isNumber: true;
+    };
+    readonly automationName: {
+        readonly isString: true;
+    };
+    readonly autoLaunch: {
+        readonly isBoolean: true;
+    };
+    readonly udid: {
+        readonly isString: true;
+    };
+    readonly orientation: {
+        readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"];
+    };
+    readonly autoWebview: {
+        readonly isBoolean: true;
+    };
+    readonly noReset: {
+        readonly isBoolean: true;
+    };
+    readonly fullReset: {
+        readonly isBoolean: true;
+    };
+    readonly language: {
+        readonly isString: true;
+    };
+    readonly locale: {
+        readonly isString: true;
+    };
+    readonly eventTimings: {
+        readonly isBoolean: true;
+    };
+    readonly printPageSourceOnFindFailure: {
+        readonly isBoolean: true;
+    };
+}, J = any> = {
+    error: Error;
+    protocol: string;
+    desiredCaps?: import("@appium/types").ConstraintsToCaps<C> | undefined;
+    processedJsonwpCapabilities?: J | undefined;
+    processedW3CCapabilities?: import("@appium/types").W3CCapabilities<C> | undefined;
+};
+export type Capabilities<C extends import("@appium/types").Constraints> = import('@appium/types').Capabilities<C>;
+export type W3CCapabilities<C extends import("@appium/types").Constraints> = import('@appium/types').W3CCapabilities<C>;
+export type NSCapabilities<C extends import("@appium/types").Constraints> = import('@appium/types').NSCapabilities<C>;
+export type ConstraintsToCaps<C extends import("@appium/types").Constraints> = import('@appium/types').ConstraintsToCaps<C>;
+export type StringKeyOf<T> = import('type-fest').StringKeyOf<T>;
+export type Constraints = import('@appium/types').Constraints;
+export type CliCommand = import('appium/types').CliCommand;
+export type CliExtensionSubcommand = import('appium/types').CliExtensionSubcommand;
+export type CliExtensionCommand = import('appium/types').CliExtensionCommand;
+export type ServerCommand = import('appium/types').CliCommandServer;
+export type DriverCommand = import('appium/types').CliCommandDriver;
+export type PluginCommand = import('appium/types').CliCommandPlugin;
+export type Args<Cmd extends import("appium/types").CliCommand = "server", SubCmd extends void | import("appium/types").CliExtensionSubcommand = void> = import('appium/types').Args<Cmd, SubCmd>;
+export type ParsedArgs<Cmd extends import("appium/types").CliCommand = "server", SubCmd extends void | import("appium/types").CliExtensionSubcommand = void> = import('appium/types').ParsedArgs<Cmd, SubCmd>;
+/**
+ * Dumps to value to the console using `info` logger.
+ *
+ * @todo May want to force color to be `false` if {@link isStdoutTTY} is `false`.
+ */
+export const inspect: (t1: any) => void;
+/**
+ * Takes the caps that were provided in the request and translates them
+ * into caps that can be used by the inner drivers.
+ *
+ * @template {Constraints} C
+ * @template [J=any]
+ * @param {J} jsonwpCapabilities
+ * @param {W3CCapabilities<C>} w3cCapabilities
+ * @param {C} constraints
+ * @param {NSCapabilities<C>} [defaultCapabilities]
+ * @returns {ParsedDriverCaps<C,J>|InvalidCaps<C,J>}
+ */
+export function parseCapsForInnerDriver<C extends import("@appium/types").Constraints, J = any>(jsonwpCapabilities: J, w3cCapabilities: import("@appium/types").W3CCapabilities<C>, constraints?: C, defaultCapabilities?: Partial<import("@appium/types").CapsToNSCaps<import("@appium/types").ConstraintsToCaps<C>, "appium">> | undefined): ParsedDriverCaps<C, J> | InvalidCaps<C, J>;
+/**
+ * Takes a capabilities objects and prefixes capabilities with `appium:`
+ * @template {Constraints} [C={}]
+ * @param {Capabilities<C>} caps - Desired capabilities object
+ * @returns {NSCapabilities<C>}
+ */
+export function insertAppiumPrefixes<C extends import("@appium/types").Constraints = {}>(caps: import("@appium/types").ConstraintsToCaps<C>): Partial<import("@appium/types").CapsToNSCaps<import("@appium/types").ConstraintsToCaps<C>, "appium">>;
+/**
+ *
+ * @param {string} pkgName
+ * @returns {string|undefined}
+ */
+export function getPackageVersion(pkgName: string): string | undefined;
+/**
+ * Pulls the initial values of Appium settings from the given capabilities argument.
+ * Each setting item must satisfy the following format:
+ * `setting[setting_name]: setting_value`
+ * The capabilities argument itself gets mutated, so it does not contain parsed
+ * settings anymore to avoid further parsing issues.
+ * Check
+ * https://github.com/appium/appium/blob/master/docs/en/advanced-concepts/settings.md
+ * for more details on the available settings.
+ *
+ * @param {?Object} caps - Capabilities dictionary. It is mutated if
+ * one or more settings have been pulled from it
+ * @return {Object} - An empty dictionary if the given caps contains no
+ * setting items or a dictionary containing parsed Appium setting names along with
+ * their values.
+ */
+export function pullSettings(caps: any | null): any;
+/**
+ * @template {Constraints} [C={}]
+ * @param {NSCapabilities<C>} caps
+ * @returns {Capabilities<C>}
+ */
+export function removeAppiumPrefixes<C extends import("@appium/types").Constraints = {}>(caps: Partial<import("@appium/types").CapsToNSCaps<import("@appium/types").ConstraintsToCaps<C>, "appium">>): import("@appium/types").ConstraintsToCaps<C>;
+/**
+ * Adjusts NODE_PATH environment variable,
+ * so drivers and plugins could load their peer dependencies.
+ * Read https://nodejs.org/api/modules.html#loading-from-the-global-folders
+ * for more details.
+ * @returns {void}
+ */
+export function adjustNodePath(): void;
+//# sourceMappingURL=utils.d.ts.map

package/build/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../lib/utils.js"],"names":[],"mappings":"AAySA;;;;;GAKG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEC;AAED;;;;;GAKG;AACH,gVAEC;AAED;;;;;GAKG;AACH,8PAEC;AAED;;;;;GAKG;AACH,8PAEC;AAED;;;;;;GAMG;AACH,0CAJW,CAAC,GAAC,CAAC,GAAC,IAAI,GAEN,MAAM,EAAE,CAepB;AA1VD,wCAAyC;AACzC,mCAAoC;2BAsWvB,OAAO,eAAe,EAAE,YAAY;uCACpC,OAAO,eAAe,EAAE,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAO/C,aAAa,CAAC,CAAC;cACf,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAUN,KAAK;cACL,MAAM;;;;;0EAQP,OAAO,eAAe,EAAE,YAAY,CAAC,CAAC,CAAC;6EAKvC,OAAO,eAAe,EAAE,eAAe,CAAC,CAAC,CAAC;4EAK1C,OAAO,eAAe,EAAE,cAAc,CAAC,CAAC,CAAC;+EAKzC,OAAO,eAAe,EAAE,iBAAiB,CAAC,CAAC,CAAC;6BAK5C,OAAO,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;0BAIlC,OAAO,eAAe,EAAE,WAAW;yBAInC,OAAO,cAAc,EAAE,UAAU;qCACjC,OAAO,cAAc,EAAE,sBAAsB;kCAC7C,OAAO,cAAc,EAAE,mBAAmB;4BAC1C,OAAO,cAAc,EAAE,gBAAgB;4BACvC,OAAO,cAAc,EAAE,gBAAgB;4BACvC,OAAO,cAAc,EAAE,gBAAgB;yJAMvC,OAAO,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC;+JAMxC,OAAO,cAAc,EAAE,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC;AAna3D;;;;GAIG;AACH,wCAQE;AAEF;;;;;;;;;;;GAWG;AACH,0XAgHC;AAED;;;;;GAKG;AACH,oPAQC;AAoBD;;;;GAIG;AACH,2CAHW,MAAM,GACJ,MAAM,GAAC,SAAS,CAK5B;AAwDD;;;;;;;;;;;;;;;GAeG;AACH,oDAgBC;AAlHD;;;;GAIG;AACH,oPAEC;AAqBD;;;;;;GAMG;AACH,kCAFa,IAAI,CA+ChB"}