appium 2.0.0-beta.46 → 2.0.0-beta.47

package/types/manifest/index.ts

@@ -0,0 +1,27 @@
+/**
+ * See `README.md` for information on how to add a new version of the schema.
+ * @module
+ */
+
+import * as ManifestV2 from './base';
+import * as ManifestV3 from './v3';
+
+// add `import * as ManifestV<new-version> from './v<new-version>';` above
+
+export * from './v3';
+// replace above line with `export * from './v<new-version>';`
+
+export {ManifestV2, ManifestV3};
+
+export interface ManifestDataVersions {
+  2: ManifestV2.ManifestData;
+  3: ManifestV3.ManifestData;
+}
+// append to this interface your new version of `ManifestData`
+
+/**
+ * One of the known versions of the `extensions.yaml` schema.
+ *
+ * @privateRemarks You probably don't need to edit this.
+ */
+export type AnyManifestDataVersion = ManifestDataVersions[keyof ManifestDataVersions];

package/types/manifest/v3.ts

@@ -0,0 +1,161 @@
+import {DriverType, ExtensionType, PluginType} from '@appium/types';
+import {SchemaObject} from 'ajv';
+import {PackageJson, SetRequired} from 'type-fest';
+
+/**
+ * One of the possible extension installation stratgies
+ */
+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;
+  /**
+   * Path to the extension's root directory
+   */
+  installPath: string;
+}
+
+/**
+ * Shape of the `appium.schema` property in an extension's `package.json` (if it exists)
+ */
+export type ExtSchemaMetadata = string | (SchemaObject & {[key: number]: never});
+
+/**
+ * Manifest data shared by all extensions, as contained in `package.json`
+ */
+export interface CommonExtMetadata {
+  /**
+   * The main class of the extension.
+   *
+   * The extension must export this class by name.
+   */
+  mainClass: string;
+
+  /**
+   * Lookup table of scripts to run via `appium <driver|plugin> run <script>` keyed by name.
+   */
+  scripts?: Record<string, string>;
+
+  /**
+   * Schema describing configuration options (and CLI args) for the extension.
+   *
+   * Can also just be a path (relative to the extension root) to an external JSON schema file.
+   */
+  schema?: ExtSchemaMetadata;
+}
+
+/**
+ * Driver-specific manifest data as stored in a driver's `package.json`
+ */
+export interface DriverMetadata {
+  /**
+   * Automation name of the driver
+   */
+  automationName: string;
+  /**
+   * Platforms the driver supports
+   */
+  platformNames: string[];
+  /**
+   * Short name of the driver (displayed in `appium list`, etc.)
+   */
+  driverName: string;
+}
+
+/**
+ * Plugin-specific manifest data as stored in a plugin's `package.json`
+ */
+export interface PluginMetadata {
+  /**
+   * Short name of the plugin (displayed in `appium list`, etc.)
+   */
+  pluginName: string;
+}
+
+/**
+ * Generic extension metadata as stored in the `appium` prop of an extension's `package.json`.
+ */
+export type ExtMetadata<ExtType extends ExtensionType> = (ExtType extends DriverType
+  ? DriverMetadata
+  : ExtType extends PluginType
+  ? PluginMetadata
+  : never) &
+  CommonExtMetadata;
+
+/**
+ * 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>,
+  'driverName' | 'pluginName'
+> &
+  InternalMetadata;
+
+/**
+ * Lookup of extension name to {@linkcode ExtManifest}.
+ * @see {ManifestData}
+ */
+export type ExtRecord<ExtType extends ExtensionType> = Record<string, ExtManifest<ExtType>>;
+
+/**
+ * The shape of the `extensions.yaml` file
+ */
+export interface ManifestData {
+  drivers: ExtRecord<DriverType>;
+  plugins: ExtRecord<PluginType>;
+  schemaRev: number;
+}
+
+/**
+ * The name of an installed extension, as it appears in `extensions.yaml`
+ * (as a property name under `drivers` or `plugins`)
+ */
+export type ExtName<ExtType extends ExtensionType> = keyof ExtRecord<ExtType>;
+
+/**
+ * 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};
+};
+
+/**
+ * A transient format between installation and insertion of extension metadata into the manifest.
+ */
+export type ExtInstallReceipt<ExtType extends ExtensionType> = ExtMetadata<ExtType> &
+  InternalMetadata;

package/build/types/appium-manifest.d.ts

@@ -1,59 +0,0 @@
-import { CommonExtMetadata, ExtMetadata, ExtSchemaMetadata } from './extension-manifest';
-import { ExtensionType, DriverType, PluginType } from '@appium/types';
-export declare 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 declare type ExtManifest<ExtType extends ExtensionType> = Omit<ExtMetadata<ExtType>, ExtType extends DriverType ? 'driverName' : ExtType extends PluginType ? 'pluginName' : never> & InternalMetadata & CommonExtMetadata;
-export declare type WithSchemaManifest = {
-    schema: ExtSchemaMetadata;
-};
-/**
- * This is just a {@linkcode ExtManifest} except it _for sure_ has a `schema` prop.
- */
-export declare type ExtManifestWithSchema<ExtType extends ExtensionType> = ExtManifest<ExtType> & WithSchemaManifest;
-/**
- * Generic type for an object keyed by extension name, with values of type {@linkcode ExtData}
- */
-export declare type ExtRecord<ExtType extends ExtensionType> = Record<string, ExtManifest<ExtType>>;
-export declare type DriverRecord = ExtRecord<DriverType>;
-export declare type PluginRecord = ExtRecord<PluginType>;
-export declare type ExtName<ExtType extends ExtensionType> = keyof ExtRecord<ExtType>;
-/**
- * Represents an entire YAML manifest (`extensions.yaml`)
- */
-export interface ManifestData {
-    drivers: DriverRecord;
-    plugins: PluginRecord;
-    schemaRev?: number;
-}
-//# sourceMappingURL=appium-manifest.d.ts.map

package/build/types/appium-manifest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"appium-manifest.d.ts","sourceRoot":"","sources":["../../types/appium-manifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAE,WAAW,EAAE,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAC,aAAa,EAAE,UAAU,EAAE,UAAU,EAAC,MAAM,eAAe,CAAC;AAEpE,oBAAY,WAAW,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE7D,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,oBAAY,WAAW,CAAC,OAAO,SAAS,aAAa,IAAI,IAAI,CAC3D,WAAW,CAAC,OAAO,CAAC,EACpB,OAAO,SAAS,UAAU,GAAG,YAAY,GAAG,OAAO,SAAS,UAAU,GAAG,YAAY,GAAG,KAAK,CAC9F,GACC,gBAAgB,GAChB,iBAAiB,CAAC;AAEpB,oBAAY,kBAAkB,GAAG;IAC/B,MAAM,EAAE,iBAAiB,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,CAAC,OAAO,SAAS,aAAa,IAAI,WAAW,CAAC,OAAO,CAAC,GACrF,kBAAkB,CAAC;AAErB;;GAEG;AACH,oBAAY,SAAS,CAAC,OAAO,SAAS,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAE5F,oBAAY,YAAY,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;AACjD,oBAAY,YAAY,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;AAEjD,oBAAY,OAAO,CAAC,OAAO,SAAS,aAAa,IAAI,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,YAAY,CAAC;IACtB,OAAO,EAAE,YAAY,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/build/types/extension-manifest.d.ts

@@ -1,55 +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 declare 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 declare 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 declare type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<PackageJson, 'name' | 'version'> & {
-    appium: ExtMetadata<ExtType>;
-    peerDependencies: {
-        appium: string;
-        [key: string]: string;
-    };
-};
-//# sourceMappingURL=extension-manifest.d.ts.map

package/build/types/extension-manifest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"extension-manifest.d.ts","sourceRoot":"","sources":["../../types/extension-manifest.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,KAAK,CAAC;AACtC,OAAO,KAAK,EAAC,WAAW,EAAE,WAAW,EAAC,MAAM,WAAW,CAAC;AACxD,OAAO,EAAC,UAAU,EAAE,aAAa,EAAE,UAAU,EAAC,MAAM,eAAe,CAAC;AAEpE;;GAEG;AACH,oBAAY,iBAAiB,GAAG,MAAM,GAAG,CAAC,YAAY,GAAG;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAA;CAAC,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,WAAW,CAAC,OAAO,SAAS,aAAa,IAAI,CAAC,OAAO,SAAS,UAAU,GAChF,cAAc,GACd,OAAO,SAAS,UAAU,GAC1B,cAAc,GACd,KAAK,CAAC,GACR,iBAAiB,CAAC;AAEpB;;;;;;;GAOG;AACH,oBAAY,cAAc,CAAC,OAAO,SAAS,aAAa,IAAI,WAAW,CACrE,WAAW,EACX,MAAM,GAAG,SAAS,CACnB,GAAG;IACF,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7B,gBAAgB,EAAE;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;CAC3D,CAAC"}

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};
-};