appium 2.0.0-beta.26 → 2.0.0-beta.29

package/types/types.d.ts

@@ -1,245 +0,0 @@
-import {
-  DRIVER_TYPE as DRIVER_SUBCOMMAND,
-  EXT_SUBCOMMAND_INSTALL,
-  EXT_SUBCOMMAND_UPDATE,
-  EXT_SUBCOMMAND_RUN,
-  EXT_SUBCOMMAND_LIST,
-  EXT_SUBCOMMAND_UNINSTALL,
-  PLUGIN_TYPE as PLUGIN_SUBCOMMAND,
-  SERVER_SUBCOMMAND,
-} from '../lib/constants';
-import appiumConfigSchema from '../lib/schema/appium-config-schema';
-import {transformers} from '../lib/schema/cli-transformers';
-import {AppiumConfiguration, ServerConfig} from './appium-config';
-
-/**
- * Converts a kebab-cased string into a camel-cased string.
- */
-export type KebabToCamel<S extends string> =
-  S extends `${infer P1}-${infer P2}${infer P3}`
-    ? `${Lowercase<P1>}${Uppercase<P2>}${KebabToCamel<P3>}`
-    : Lowercase<S>;
-
-/**
- * Converts an object with kebab-cased keys into camel-cased keys.
- */
-type ObjectToCamel<T> = {
-  [K in keyof T as KebabToCamel<string & K>]: T[K] extends Record<string, any>
-    ? KeysToCamelCase<T[K]>
-    : T[K];
-};
-
-/**
- * Converts an object or array to have camel-cased keys.
- */
-export type KeysToCamelCase<T> = {
-  [K in keyof T as KebabToCamel<string & K>]: T[K] extends Array<any>
-    ? KeysToCamelCase<T[K][number]>[]
-    : ObjectToCamel<T[K]>;
-};
-
-/**
- * The Appium configuration as it would be in a configuration file.
- */
-export type AppiumConfig = Partial<AppiumConfiguration>;
-
-/**
- * Certain properties have an `appiumCliDest` prop, which affects the shape of
- * {@link ParsedArgs}. This type helps recognize these properties.
- *
- * See `../lib/schema/keywords` for definition of `appiumCliDest`.
- */
-interface WithDest {
-  appiumCliDest: string;
-}
-
-/**
- * Some properties have a `default` prop, which means practically they will not
- * be `undefined` upon parsing.
- *
- * We use this to ensure that the {@link ParsedArgs} makes guarantees
- * about the presence of properties.
- */
-interface WithDefault {
-  default: any;
-}
-
-interface WithCliTransformer {
-  appiumCliTransformer: keyof typeof transformers;
-}
-
-interface WithTypeArray {
-  type: 'array';
-}
-interface WithTypeObject {
-  type: 'object';
-}
-type WithTransformer = WithCliTransformer | WithTypeArray | WithTypeObject;
-
-/**
- * Derive the "constant" type of the server properties from the schema.
- */
-type AppiumServerSchema =
-  typeof appiumConfigSchema['properties']['server']['properties'];
-
-/**
- * Properties of `T` with keys `appiumCliDest` prop _or_ just camel-cased.
- */
-type NormalizedServerConfig = {
-  [Prop in keyof ServerConfigMapping as AppiumServerSchema[Prop] extends WithDest
-    ? AppiumServerSchema[Prop]['appiumCliDest']
-    : KebabToCamel<Prop>]: ServerConfig[Prop];
-};
-
-/**
- * "Normalized" config, which is like the flattened config (camel-cased keys),
- * but not flattened.
- */
-export type NormalizedAppiumConfig = {
-  server: NormalizedServerConfig;
-};
-
-/**
- * Utility type to associate {@link AppiumServerSchema} with
- * {@link ServerConfig}.
- */
-type ServerConfigMapping = {
-  [Prop in keyof Required<ServerConfig>]: AppiumServerSchema[Prop];
-};
-
-/**
- * This type checks if `appiumCliDest` is present in the object via
- * {@link WithDest}, and uses the _value_ of that property for the key name;
- * otherwise uses the camel-cased value of the key name.
- */
-type SetKeyForProp<Prop extends keyof ServerConfigMapping> =
-  AppiumServerSchema[Prop] extends WithDest
-    ? AppiumServerSchema[Prop]['appiumCliDest']
-    : KebabToCamel<Prop>;
-
-/**
- * Checks for the existence of default values, and ensures those properties will
- * be defined (eliminate `| undefined` from the type).
- */
-type DefaultForProp<Prop extends keyof ServerConfigMapping> =
-  AppiumServerSchema[Prop] extends WithDefault
-    ? NonNullable<ServerConfig[Prop]>
-    : ServerConfig[Prop];
-
-/**
- * The final shape of the parsed CLI arguments.
- */
-type ArgsFromConfig = {
-  [Prop in keyof ServerConfigMapping as SetKeyForProp<Prop>]: DefaultForProp<Prop>;
-};
-
-/**
- * Possible subcommands for the `appium` CLI.
- */
-type CliSubcommand =
-  | typeof SERVER_SUBCOMMAND
-  | typeof DRIVER_SUBCOMMAND
-  | typeof PLUGIN_SUBCOMMAND;
-
-/**
- * Possible subcommands of {@link DRIVER_SUBCOMMAND} or
- * {@link PLUGIN_SUBCOMMAND}.
- */
-export type CliExtensionSubcommand =
-  | typeof EXT_SUBCOMMAND_INSTALL
-  | typeof EXT_SUBCOMMAND_LIST
-  | typeof EXT_SUBCOMMAND_RUN
-  | typeof EXT_SUBCOMMAND_UPDATE
-  | typeof EXT_SUBCOMMAND_UNINSTALL;
-
-/**
- * Random stuff that may appear in the parsed args which has no equivalent in a
- * config file.
- */
-interface MoreArgs {
-  /**
-   * Path to config file, if any. Does not make sense for this to be allowed in a config file!
-   */
-  configFile?: string;
-
-  /**
-   * If true, show the config and exit
-   */
-  showConfig?: boolean;
-
-  /**
-   * If true, open a REPL
-   */
-  shell?: boolean;
-}
-
-/**
- * These arguments are _not_ supported by the CLI, but only via programmatic usage / tests.
- */
-interface ProgrammaticArgs {
-  /**
-   * Subcommands of `driver` subcommand
-   */
-  driverCommand?: CliExtensionSubcommand;
-
-  /**
-   * Subcommands of `plugin` subcommand
-   */
-  pluginCommand?: CliExtensionSubcommand;
-
-  /**
-   * If true, throw on error instead of exit.
-   */
-  throwInsteadOfExit?: boolean;
-
-  /**
-   * Seems to only be used in tests or standalone driver calls
-   */
-  logHandler?: (...args: any[]) => void;
-
-  /**
-   * Alternate way to set `APPIUM_HOME` for tests. Since we don't want to muck about
-   * with the environment, we just set it here.
-   */
-  appiumHome?: string;
-
-  /**
-   * If true, show the build info and exit
-   */
-  showBuildInfo: boolean;
-
-  /**
-   * If true, show config and exit
-   */
-  showConfig: boolean;
-
-}
-
-interface SubcommandArgs {
-  /**
-   * Possible subcommands
-   */
-  subcommand:
-    | typeof DRIVER_SUBCOMMAND
-    | typeof PLUGIN_SUBCOMMAND
-    | typeof SERVER_SUBCOMMAND;
-}
-
-  /**
- * The same as {@link ParsedArgs} but with a nullable `subcommand`.
-   */
-export type PartialArgs = ArgsFromConfig &
-  MoreArgs &
-  ProgrammaticArgs &
-  Partial<SubcommandArgs>;
-
-/**
- * The Appium configuration as a flattened object, parsed via CLI args _and_ any
- * CLI args unsupported by the config file.
- * @todo Does not make any assumptions about property names derived from
- * extensions.
- */
-export type ParsedArgs = ArgsFromConfig &
-  MoreArgs &
-  ProgrammaticArgs &
-  SubcommandArgs;