appium 2.0.0-beta.5 → 2.0.0-beta.52

package/build/lib/utils.d.ts

@@ -0,0 +1,121 @@
+/**
+ * @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 import("type-fest").Simplify<import("type-fest").Except<import("appium/types").CommonArgs<"server", void>, "driver" | "plugin" | "address" | "nodeconfig" | "port" | "webhook" | "allowCors" | "allowInsecure" | "basePath" | "callbackAddress" | "callbackPort" | "debugLogSpacing" | "defaultCapabilities" | "denyInsecure" | "keepAliveTimeout" | "localTimezone" | "logFile" | "logFilters" | "loglevel" | "logNoColors" | "logTimestamp" | "longStacktrace" | "noPermsCheck" | "relaxedSecurityEnabled" | "sessionOverride" | "strictCaps" | "tmpDir" | "traceDir" | "useDrivers" | "usePlugins"> & Partial<Pick<import("appium/types").CommonArgs<"server", void>, "driver" | "plugin" | "address" | "nodeconfig" | "port" | "webhook" | "allowCors" | "allowInsecure" | "basePath" | "callbackAddress" | "callbackPort" | "debugLogSpacing" | "defaultCapabilities" | "denyInsecure" | "keepAliveTimeout" | "localTimezone" | "logFile" | "logFilters" | "loglevel" | "logNoColors" | "logTimestamp" | "longStacktrace" | "noPermsCheck" | "relaxedSecurityEnabled" | "sessionOverride" | "strictCaps" | "tmpDir" | "traceDir" | "useDrivers" | "usePlugins">>>;
+/**
+ * @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>;
+export type StringRecord = import('@appium/types').StringRecord;
+export type BaseDriverCapConstraints = import('@appium/types').BaseDriverCapConstraints;
+export type ParsedDriverCaps<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof import("@appium/types").BASE_DESIRED_CAP_CONSTRAINTS, J = any> = {
+    desiredCaps: Capabilities<C>;
+    protocol: string;
+    processedJsonwpCapabilities?: J | undefined;
+    processedW3CCapabilities?: W3CCapabilities<C, void> | undefined;
+};
+export type InvalidCaps<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof import("@appium/types").BASE_DESIRED_CAP_CONSTRAINTS, J = any> = {
+    error: Error;
+    protocol: string;
+    desiredCaps?: Partial<import("@appium/types").ConstraintsToCaps<C> & void> | undefined;
+    processedJsonwpCapabilities?: J | undefined;
+    processedW3CCapabilities?: W3CCapabilities<C, void> | undefined;
+};
+export type Capabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof import("@appium/types").BASE_DESIRED_CAP_CONSTRAINTS, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').Capabilities<C, Extra>;
+export type W3CCapabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof import("@appium/types").BASE_DESIRED_CAP_CONSTRAINTS, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').W3CCapabilities<C, Extra>;
+export type NSCapabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof import("@appium/types").BASE_DESIRED_CAP_CONSTRAINTS, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').NSCapabilities<C, Extra>;
+export type ConstraintsToCaps<C extends Readonly<Record<string, import("@appium/types").Constraint>>> = 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').ServerCommand;
+export type DriverCommand = import('appium/types').DriverCommand;
+export type PluginCommand = import('appium/types').PluginCommand;
+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 Readonly<Record<string, import("@appium/types").Constraint>>, J = any>(jsonwpCapabilities: J, w3cCapabilities: W3CCapabilities<C, void>, constraints?: C, defaultCapabilities?: Partial<import("@appium/types").CapsToNSCaps<import("@appium/types").ConstraintsToCaps<C> & void, "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 Readonly<Record<string, import("@appium/types").Constraint>> = {}>(caps: Partial<import("@appium/types").ConstraintsToCaps<C> & void>): Partial<import("@appium/types").CapsToNSCaps<import("@appium/types").ConstraintsToCaps<C> & void, "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 Readonly<Record<string, import("@appium/types").Constraint>> = {}>(caps: Partial<import("@appium/types").CapsToNSCaps<import("@appium/types").ConstraintsToCaps<C> & void, "appium">>): Partial<import("@appium/types").ConstraintsToCaps<C> & void>;
+/**
+ * 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":"AAoSA;;;;;GAKG;AACH,00CAEC;AAED;;;;;GAKG;AACH,gVAEC;AAED;;;;;GAKG;AACH,8PAEC;AAED;;;;;GAKG;AACH,8PAEC;2BAaY,OAAO,eAAe,EAAE,YAAY;uCACpC,OAAO,eAAe,EAAE,wBAAwB;;iBAO/C,aAAa,CAAC,CAAC;cACf,MAAM;;;;;WAUN,KAAK;cACL,MAAM;;;;;mOASP,OAAO,eAAe,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC;sOAM9C,OAAO,eAAe,EAAE,eAAe,CAAC,CAAC,EAAE,KAAK,CAAC;qOAMjD,OAAO,eAAe,EAAE,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC;wGAKhD,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,aAAa;4BACpC,OAAO,cAAc,EAAE,aAAa;4BACpC,OAAO,cAAc,EAAE,aAAa;yJAMpC,OAAO,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC;+JAMxC,OAAO,cAAc,EAAE,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC;AA/Y3D;;;;GAIG;AACH,wCAQE;AAEF;;;;;;;;;;;GAWG;AACH,wYAgHC;AAED;;;;;GAKG;AACH,oSAQC;AAoBD;;;;GAIG;AACH,2CAHW,MAAM,GACJ,MAAM,GAAC,SAAS,CAK5B;AAuDD;;;;;;;;;;;;;;;GAeG;AACH,oDAgBC;AAjHD;;;;GAIG;AACH,oSAEC;AAqBD;;;;;;GAMG;AACH,kCAFa,IAAI,CA8ChB"}