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

package/build/types/manifest/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../types/manifest/base.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,19 @@
+/**
+ * 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';
+export * from './v3';
+export { ManifestV2, ManifestV3 };
+export interface ManifestDataVersions {
+    2: ManifestV2.ManifestData;
+    3: ManifestV3.ManifestData;
+}
+/**
+ * One of the known versions of the `extensions.yaml` schema.
+ *
+ * @privateRemarks You probably don't need to edit this.
+ */
+export declare type AnyManifestDataVersion = ManifestDataVersions[keyof ManifestDataVersions];
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../types/manifest/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,UAAU,MAAM,QAAQ,CAAC;AACrC,OAAO,KAAK,UAAU,MAAM,MAAM,CAAC;AAInC,cAAc,MAAM,CAAC;AAGrB,OAAO,EAAC,UAAU,EAAE,UAAU,EAAC,CAAC;AAEhC,MAAM,WAAW,oBAAoB;IACnC,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;IAC3B,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;CAC5B;AAGD;;;;GAIG;AACH,oBAAY,sBAAsB,GAAG,oBAAoB,CAAC,MAAM,oBAAoB,CAAC,CAAC"}

package/build/types/manifest/index.js

@@ -0,0 +1,40 @@
+"use strict";
+/**
+ * See `README.md` for information on how to add a new version of the schema.
+ * @module
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestV3 = exports.ManifestV2 = void 0;
+const ManifestV2 = __importStar(require("./base"));
+exports.ManifestV2 = ManifestV2;
+const ManifestV3 = __importStar(require("./v3"));
+exports.ManifestV3 = ManifestV3;
+// add `import * as ManifestV<new-version> from './v<new-version>';` above
+__exportStar(require("./v3"), exports);
+//# sourceMappingURL=index.js.map

package/build/types/manifest/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../types/manifest/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,mDAAqC;AAQ7B,gCAAU;AAPlB,iDAAmC;AAOf,gCAAU;AAL9B,0EAA0E;AAE1E,uCAAqB"}

package/build/types/manifest/v3.d.ts

@@ -0,0 +1,139 @@
+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 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;
+    /**
+     * 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 declare 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 declare 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 declare type ExtManifest<ExtType extends ExtensionType> = Omit<ExtMetadata<ExtType>, 'driverName' | 'pluginName'> & InternalMetadata;
+/**
+ * Lookup of extension name to {@linkcode ExtManifest}.
+ * @see {ManifestData}
+ */
+export declare 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 declare 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 declare 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 declare type ExtInstallReceipt<ExtType extends ExtensionType> = ExtMetadata<ExtType> & InternalMetadata;
+//# sourceMappingURL=v3.d.ts.map

package/build/types/manifest/v3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v3.d.ts","sourceRoot":"","sources":["../../../types/manifest/v3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,aAAa,EAAE,UAAU,EAAC,MAAM,eAAe,CAAC;AACpE,OAAO,EAAC,YAAY,EAAC,MAAM,KAAK,CAAC;AACjC,OAAO,EAAC,WAAW,EAAE,WAAW,EAAC,MAAM,WAAW,CAAC;AAEnD;;GAEG;AACH,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;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;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;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;;OAIG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;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;;;GAGG;AACH,oBAAY,WAAW,CAAC,OAAO,SAAS,aAAa,IAAI,IAAI,CAC3D,WAAW,CAAC,OAAO,CAAC,EACpB,YAAY,GAAG,YAAY,CAC5B,GACC,gBAAgB,CAAC;AAEnB;;;GAGG;AACH,oBAAY,SAAS,CAAC,OAAO,SAAS,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;IAC/B,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,oBAAY,OAAO,CAAC,OAAO,SAAS,aAAa,IAAI,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;AAE9E;;;;;;;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;AAEF;;GAEG;AACH,oBAAY,iBAAiB,CAAC,OAAO,SAAS,aAAa,IAAI,WAAW,CAAC,OAAO,CAAC,GACjF,gBAAgB,CAAC"}

package/build/types/manifest/v3.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=v3.js.map

package/build/types/manifest/v3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v3.js","sourceRoot":"","sources":["../../../types/manifest/v3.ts"],"names":[],"mappings":""}

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');

package/index.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+
+const {asyncify} = require('asyncbox');
+
+const appium = require('./build/lib/main.js');
+
+if (require.main === module) {
+  asyncify(appium.main);
+}
+
+module.exports = appium;