appium 2.0.0-beta.34 → 2.0.0-beta.38

package/build/types/{external-manifest.d.ts → extension-manifest.d.ts}

@@ -3,20 +3,20 @@
  */
 import type { SchemaObject } from 'ajv';
 import type { PackageJson, SetRequired } from 'type-fest';
-import { DriverType, ExtensionType, PluginType } from './index';
+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 SchemaMetadata = string | (SchemaObject & {
+export declare type ExtSchemaMetadata = string | (SchemaObject & {
     [key: number]: never;
 });
 /**
  * Manifest data shared by all extensions, as contained in `package.json`
  */
-export interface CommonMetadata {
+export interface CommonExtMetadata {
     mainClass: string;
     scripts?: Record<string, string>;
-    schema?: SchemaMetadata;
+    schema?: ExtSchemaMetadata;
 }
 /**
  * Driver-specific manifest data as contained in `package.json`
@@ -36,12 +36,20 @@ export interface PluginMetadata {
  * 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) & CommonMetadata;
+export declare type ExtMetadata<ExtType extends ExtensionType> = (ExtType extends DriverType ? DriverMetadata : ExtType extends PluginType ? PluginMetadata : never) & CommonExtMetadata;
 /**
  * A `package.json` containing extension metadata.
- * Required fields are `name`, `version`, and `appium`.
+ * 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=external-manifest.d.ts.map
+//# sourceMappingURL=extension-manifest.d.ts.map

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

@@ -0,0 +1 @@
+{"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/build/types/index.d.ts

@@ -1,15 +1,16 @@
 /// <reference types="node" />
+import { ExtensionType, DriverType, DriverClass, PluginType, PluginClass } from '@appium/types';
 export * from './appium-manifest';
-export * from './external-manifest';
-export * from './extension';
+export * from './extension-manifest';
 export * from './cli';
-export declare type DriverType = 'driver';
-export declare type PluginType = 'plugin';
-export declare type ExtensionType = DriverType | PluginType;
 /**
  * Known environment variables concerning Appium
  */
 export interface AppiumEnv extends NodeJS.ProcessEnv {
     APPIUM_HOME?: string;
 }
+/**
+ * Generic to get at the class of an extension.
+ */
+export declare type ExtClass<ExtType extends ExtensionType> = ExtType extends DriverType ? DriverClass : ExtType extends PluginType ? PluginClass : never;
 //# sourceMappingURL=index.d.ts.map

package/build/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":";AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,OAAO,CAAC;AACtB,oBAAY,UAAU,GAAG,QAAQ,CAAC;AAClC,oBAAY,UAAU,GAAG,QAAQ,CAAC;AAClC,oBAAY,aAAa,GAAG,UAAU,GAAG,UAAU,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,UAAU;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAC,MAAM,eAAe,CAAC;AAE9F,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,OAAO,CAAC;AAEtB;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,UAAU;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,oBAAY,QAAQ,CAAC,OAAO,SAAS,aAAa,IAAI,OAAO,SAAS,UAAU,GAC5E,WAAW,GACX,OAAO,SAAS,UAAU,GAC1B,WAAW,GACX,KAAK,CAAC"}

package/driver.d.ts

@@ -0,0 +1 @@
+export * from '@appium/base-driver';

package/driver.js

@@ -0,0 +1,14 @@
+'use strict';
+
+// @ts-check
+
+/**
+ * This module is here to re-export `@appium/base-driver` for Appium extensions.
+ *
+ * @see https://npm.im/@appium/base-driver
+ * @example
+ * const { BaseDriver, errors } = require('appium/driver');
+ */
+
+/** @type {import('@appium/base-driver')} */
+module.exports = require('@appium/base-driver');