appium 2.0.0-beta.46 → 2.0.0-beta.48

package/types/appium-manifest.ts

@@ -1,73 +0,0 @@
-import {CommonExtMetadata, ExtMetadata, ExtSchemaMetadata} from './extension-manifest';
-import {ExtensionType, DriverType, PluginType} from '@appium/types';
-
-export type InstallType = 'npm' | 'git' | 'local' | 'github';
-
-export interface InternalMetadata {
-  /**
-   * Package name of extension
-   *
-   * `name` from its `package.json`
-   */
-  pkgName: string;
-  /**
-   * Version of extension
-   *
-   * `version` from its `package.json`
-   */
-  version: string;
-  /**
-   * The method in which the user installed the extension (the `source` CLI arg)
-   */
-  installType: InstallType;
-  /**
-   * Whatever the user typed as the extension to install. May be derived from `package.json`
-   */
-  installSpec: string;
-  /**
-   * Maximum version of Appium that this extension is compatible with.
-   *
-   * If `undefined`, we'll try anyway.
-   */
-  appiumVersion?: string;
-}
-
-/**
- * Combination of external + internal extension data with `driverName`/`pluginName` removed (it becomes a key in an {@linkcode ExtRecord} object).
- * Part of `extensions.yaml`.
- */
-export type ExtManifest<ExtType extends ExtensionType> = Omit<
-  ExtMetadata<ExtType>,
-  ExtType extends DriverType ? 'driverName' : ExtType extends PluginType ? 'pluginName' : never
-> &
-  InternalMetadata &
-  CommonExtMetadata; // XXX: ExtMetadata should be a union with CommonMetadata. why is this needed?
-
-export type WithSchemaManifest = {
-  schema: ExtSchemaMetadata;
-};
-
-/**
- * This is just a {@linkcode ExtManifest} except it _for sure_ has a `schema` prop.
- */
-export type ExtManifestWithSchema<ExtType extends ExtensionType> = ExtManifest<ExtType> &
-  WithSchemaManifest;
-
-/**
- * Generic type for an object keyed by extension name, with values of type {@linkcode ExtData}
- */
-export type ExtRecord<ExtType extends ExtensionType> = Record<string, ExtManifest<ExtType>>;
-
-export type DriverRecord = ExtRecord<DriverType>;
-export type PluginRecord = ExtRecord<PluginType>;
-
-export type ExtName<ExtType extends ExtensionType> = keyof ExtRecord<ExtType>;
-
-/**
- * Represents an entire YAML manifest (`extensions.yaml`)
- */
-export interface ManifestData {
-  drivers: DriverRecord;
-  plugins: PluginRecord;
-  schemaRev?: number;
-}

package/types/extension-manifest.ts

@@ -1,64 +0,0 @@
-/**
- * These types describe information about external extensions and the contents of their `package.json` files
- */
-
-import type {SchemaObject} from 'ajv';
-import type {PackageJson, SetRequired} from 'type-fest';
-import {DriverType, ExtensionType, PluginType} from '@appium/types';
-
-/**
- * This is what is allowed in the `appium.schema` prop of an extension's `package.json`.
- */
-export type ExtSchemaMetadata = string | (SchemaObject & {[key: number]: never});
-
-/**
- * Manifest data shared by all extensions, as contained in `package.json`
- */
-export interface CommonExtMetadata {
-  mainClass: string;
-  scripts?: Record<string, string>;
-  schema?: ExtSchemaMetadata;
-}
-
-/**
- * Driver-specific manifest data as contained in `package.json`
- */
-export interface DriverMetadata {
-  automationName: string;
-  platformNames: string[];
-  driverName: string;
-}
-
-/**
- * Plugin-specific manifest data as stored in `package.json`
- */
-export interface PluginMetadata {
-  pluginName: string;
-}
-
-/**
- * Generic type to refer to either {@linkcode DriverMetadata} or {@linkcode PluginMetadata}
- * Corresponds to the `appium` prop in an extension's `package.json`.
- */
-export type ExtMetadata<ExtType extends ExtensionType> = (ExtType extends DriverType
-  ? DriverMetadata
-  : ExtType extends PluginType
-  ? PluginMetadata
-  : never) &
-  CommonExtMetadata;
-
-/**
- * A `package.json` containing extension metadata.
- * Must have the following properties:
- * - `name`: the name of the extension
- * - `version`: the version of the extension
- * - `appium`: the metadata for the extension
- * - `peerDependencies.appium`: the maximum compatible version of Appium
- */
-export type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<
-  PackageJson,
-  'name' | 'version'
-> & {
-  appium: ExtMetadata<ExtType>;
-  peerDependencies: {appium: string; [key: string]: string};
-};