appium 2.0.0-beta.7 → 2.0.0-beta.71

package/build/lib/extension/index.js

@@ -0,0 +1,105 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getActiveDrivers = exports.getActivePlugins = exports.loadExtensions = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const constants_1 = require("../constants");
+const logger_1 = __importDefault(require("../logger"));
+const driver_config_1 = require("./driver-config");
+const manifest_1 = require("./manifest");
+const plugin_config_1 = require("./plugin-config");
+const bluebird_1 = __importDefault(require("bluebird"));
+/**
+ * Loads extensions and creates `ExtensionConfig` instances.
+ *
+ * - Reads the manifest file, creating if necessary
+ * - Using the parsed extension data, creates/gets the `ExtensionConfig` subclass instances
+ * - Returns these instances
+ *
+ * If `appiumHome` is needed, use `resolveAppiumHome` from the `env` module in `@appium/support`.
+ * @param {string} appiumHome
+ * @returns {Promise<ExtensionConfigs>}
+ */
+async function loadExtensions(appiumHome) {
+    const manifest = manifest_1.Manifest.getInstance(appiumHome);
+    await manifest.read();
+    const driverConfig = driver_config_1.DriverConfig.getInstance(manifest) ?? driver_config_1.DriverConfig.create(manifest);
+    const pluginConfig = plugin_config_1.PluginConfig.getInstance(manifest) ?? plugin_config_1.PluginConfig.create(manifest);
+    await bluebird_1.default.all([driverConfig.validate(), pluginConfig.validate()]);
+    return { driverConfig, pluginConfig };
+}
+exports.loadExtensions = loadExtensions;
+/**
+ * Find any plugin name which has been installed, and which has been requested for activation by
+ * using the --use-plugins flag, and turn each one into its class, so we can send them as objects
+ * to the server init. We also want to send/assign them to the umbrella driver so it can use them
+ * to wrap command execution
+ *
+ * @param {import('./plugin-config').PluginConfig} pluginConfig - a plugin extension config
+ * @param {string[]} usePlugins
+ * @returns {PluginNameMap} Mapping of PluginClass to name
+ */
+function getActivePlugins(pluginConfig, usePlugins = []) {
+    return new Map(lodash_1.default.compact(Object.keys(pluginConfig.installedExtensions)
+        .filter((pluginName) => lodash_1.default.includes(usePlugins, pluginName) ||
+        (usePlugins.length === 1 && usePlugins[0] === constants_1.USE_ALL_PLUGINS))
+        .map((pluginName) => {
+        try {
+            logger_1.default.info(`Attempting to load plugin ${pluginName}...`);
+            const PluginClass = pluginConfig.require(pluginName);
+            return [PluginClass, pluginName];
+        }
+        catch (err) {
+            logger_1.default.error(`Could not load plugin '${pluginName}', so it will not be available. Error ` +
+                `in loading the plugin was: ${err.message}`);
+            logger_1.default.debug(err.stack);
+        }
+    })));
+}
+exports.getActivePlugins = getActivePlugins;
+/**
+ * Find any driver name which has been installed, and turn each one into its class, so we can send
+ * them as objects to the server init in case they need to add methods/routes or update the server.
+ * If the --drivers flag was given, this method only loads the given drivers.
+ *
+ * @param {import('./driver-config').DriverConfig} driverConfig - a driver extension config
+ * @param {string[]} [useDrivers] - optional list of drivers to load
+ * @returns {DriverNameMap}
+ */
+function getActiveDrivers(driverConfig, useDrivers = []) {
+    return new Map(lodash_1.default.compact(Object.keys(driverConfig.installedExtensions)
+        .filter((driverName) => lodash_1.default.includes(useDrivers, driverName) || useDrivers.length === 0)
+        .map((driverName) => {
+        try {
+            logger_1.default.info(`Attempting to load driver ${driverName}...`);
+            const DriverClass = driverConfig.require(driverName);
+            return [DriverClass, driverName];
+        }
+        catch (err) {
+            logger_1.default.error(`Could not load driver '${driverName}', so it will not be available. Error ` +
+                `in loading the driver was: ${err.message}`);
+            logger_1.default.debug(err.stack);
+        }
+    })));
+}
+exports.getActiveDrivers = getActiveDrivers;
+/**
+ * A mapping of {@linkcode PluginClass} classes to their names.
+ * @typedef {Map<PluginClass,string>} PluginNameMap
+ */
+/**
+ * A mapping of {@linkcode DriverClass} classes to their names.
+ * @typedef {Map<DriverClass,string>} DriverNameMap
+ */
+/**
+ * @typedef {import('@appium/types').PluginClass} PluginClass
+ * @typedef {import('@appium/types').DriverClass} DriverClass
+ */
+/**
+ * @typedef ExtensionConfigs
+ * @property {import('./driver-config').DriverConfig} driverConfig
+ * @property {import('./plugin-config').PluginConfig} pluginConfig
+ */
+//# sourceMappingURL=index.js.map

package/build/lib/extension/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/extension/index.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,4CAA6C;AAC7C,uDAA4B;AAC5B,mDAA6C;AAC7C,yCAAoC;AACpC,mDAA6C;AAC7C,wDAAyB;AAEzB;;;;;;;;;;GAUG;AACI,KAAK,UAAU,cAAc,CAAC,UAAU;IAC7C,MAAM,QAAQ,GAAG,mBAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAClD,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACtB,MAAM,YAAY,GAAG,4BAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,4BAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACzF,MAAM,YAAY,GAAG,4BAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,4BAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAEzF,MAAM,kBAAC,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IAChE,OAAO,EAAC,YAAY,EAAE,YAAY,EAAC,CAAC;AACtC,CAAC;AARD,wCAQC;AAED;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAAC,YAAY,EAAE,UAAU,GAAG,EAAE;IAC5D,OAAO,IAAI,GAAG,CACZ,gBAAC,CAAC,OAAO,CACP,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC;SAC1C,MAAM,CACL,CAAC,UAAU,EAAE,EAAE,CACb,gBAAC,CAAC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;QAClC,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,2BAAe,CAAC,CACjE;SACA,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAClB,IAAI;YACF,gBAAG,CAAC,IAAI,CAAC,6BAA6B,UAAU,KAAK,CAAC,CAAC;YACvD,MAAM,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACrD,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;SAClC;QAAC,OAAO,GAAG,EAAE;YACZ,gBAAG,CAAC,KAAK,CACP,0BAA0B,UAAU,wCAAwC;gBAC1E,8BAA8B,GAAG,CAAC,OAAO,EAAE,CAC9C,CAAC;YACF,gBAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SACtB;IACH,CAAC,CAAC,CACL,CACF,CAAC;AACJ,CAAC;AAxBD,4CAwBC;AAED;;;;;;;;GAQG;AACH,SAAgB,gBAAgB,CAAC,YAAY,EAAE,UAAU,GAAG,EAAE;IAC5D,OAAO,IAAI,GAAG,CACZ,gBAAC,CAAC,OAAO,CACP,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC;SAC1C,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,gBAAC,CAAC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC;SACrF,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAClB,IAAI;YACF,gBAAG,CAAC,IAAI,CAAC,6BAA6B,UAAU,KAAK,CAAC,CAAC;YACvD,MAAM,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACrD,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;SAClC;QAAC,OAAO,GAAG,EAAE;YACZ,gBAAG,CAAC,KAAK,CACP,0BAA0B,UAAU,wCAAwC;gBAC1E,8BAA8B,GAAG,CAAC,OAAO,EAAE,CAC9C,CAAC;YACF,gBAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SACtB;IACH,CAAC,CAAC,CACL,CACF,CAAC;AACJ,CAAC;AApBD,4CAoBC;AAED;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;GAIG"}

package/build/lib/extension/manifest-migrations.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Applies a series of migration functions to a manifest to update its manifest schema version.
+ *
+ * `data` is modified in-place.
+ *
+ * @param {Readonly<Manifest>} manifest
+ * @returns {Promise<boolean>} If `true` existing packages should be synced from disk and the manifest should be persisted.
+ */
+export function migrate(manifest: Readonly<Manifest>): Promise<boolean>;
+/**
+ * A migration function. It will return `true` if a change _should be made_.
+ *
+ * A migration function should not modify `schemaRev`, as this is done automatically.
+ *
+ * Note that at the time of writing, we're not able to determine the version of the _current_ manifest file if there is no `schemaRev` prop present (and we may not want to trust it anyway).
+ */
+export type Migration = (manifest: Readonly<Manifest>) => boolean | Promise<boolean>;
+export type ManifestData = import('appium/types').ManifestData;
+export type DriverType = import('@appium/types').DriverType;
+export type PluginType = import('@appium/types').PluginType;
+export type AnyManifestDataVersion = import('appium/types').AnyManifestDataVersion;
+export type ManifestDataVersions = import('appium/types').ManifestDataVersions;
+export type ExtensionType = import('@appium/types').ExtensionType;
+export type ManifestDataV2 = import('appium/types').ManifestV2.ManifestData;
+export type Manifest = import('./manifest').Manifest;
+export type ExtManifest<ExtType extends import("@appium/types").ExtensionType> = import('appium/types').ExtManifest<ExtType>;
+//# sourceMappingURL=manifest-migrations.d.ts.map

package/build/lib/extension/manifest-migrations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-migrations.d.ts","sourceRoot":"","sources":["../../../lib/extension/manifest-migrations.js"],"names":[],"mappings":"AAwFA;;;;;;;GAOG;AACH,kCAHW,SAAS,QAAQ,CAAC,GAChB,QAAQ,OAAO,CAAC,CAc5B;;;;;;;;mCASU,SAAS,QAAQ,CAAC,KAChB,OAAO,GAAC,QAAQ,OAAO,CAAC;2BAIxB,OAAO,cAAc,EAAE,YAAY;yBACnC,OAAO,eAAe,EAAE,UAAU;yBAClC,OAAO,eAAe,EAAE,UAAU;qCAClC,OAAO,cAAc,EAAE,sBAAsB;mCAC7C,OAAO,cAAc,EAAE,oBAAoB;4BAC3C,OAAO,eAAe,EAAE,aAAa;6BACrC,OAAO,cAAc,EAAE,UAAU,CAAC,YAAY;uBAC9C,OAAO,YAAY,EAAE,QAAQ;iFAK7B,OAAO,cAAc,EAAE,WAAW,CAAC,OAAO,CAAC"}

package/build/lib/extension/manifest-migrations.js

@@ -0,0 +1,134 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrate = void 0;
+const constants_1 = require("../constants");
+const logger_1 = __importDefault(require("../logger"));
+/**
+ * This contains logic to migrate old versions of `extensions.yaml` to new versions.
+ *
+ * @module
+ */
+/**
+ * Constant for v3 of the schema rev.
+ */
+const SCHEMA_REV_3 = 3;
+/**
+ * Constant for v4 of the schema rev.
+ */
+const SCHEMA_REV_4 = 4;
+/**
+ * Collection of functions to migrate from one version to another.
+ *
+ * These functions _should not actually perform the migration_; rather, they
+ * should return `true` if the migration should be performed.  The migration
+ * itself will happen within {@linkcode Manifest.syncWithInstalledExtensions}; the extensions
+ * will be checked and the manifest file updated per the state of the filesystem.
+ *
+ * @type { {[P in keyof ManifestDataVersions]?: Migration} }
+ */
+const Migrations = {
+    /**
+     * If `installPath` is missing from the `ExtManifest` for any extension, return `true`.
+     *
+     * We cannot easily determine the path of any given extension here, but returning `true`
+     * will cause the `Manifest` to sync with the filesystem, which will populate the missing field.
+     *
+     * @type {Migration}
+     */
+    [SCHEMA_REV_3]: (manifest) => {
+        /** @type {Array<ExtManifest<PluginType>|ExtManifest<DriverType>>} */
+        const allExtData = [
+            ...Object.values(manifest.getExtensionData(constants_1.DRIVER_TYPE)),
+            ...Object.values(manifest.getExtensionData(constants_1.PLUGIN_TYPE)),
+        ];
+        return allExtData.some((metadata) => !('installPath' in metadata));
+    },
+    /**
+     * Updates installed extensions to use `InstallType` of `dev` if appropriate.
+     *
+     * Previously, these types of extensions (automatically discovered) would use the default `InstallType` of `npm`, so we need
+     * to refresh any with this install type.
+     *
+     * This should only happen once; we do not want to re-check everything with `npm` install type
+     * every time.
+     * @type {Migration}
+     */
+    [SCHEMA_REV_4]: (manifest) => {
+        if (manifest.schemaRev < SCHEMA_REV_4) {
+            const allExtData = [
+                ...Object.values(manifest.getExtensionData(constants_1.DRIVER_TYPE)),
+                ...Object.values(manifest.getExtensionData(constants_1.PLUGIN_TYPE)),
+            ];
+            return allExtData.some((metadata) => metadata.installType === 'npm');
+        }
+        return false;
+    },
+};
+/**
+ * Set `schemaRev` to a specific version.
+ *
+ * This _does_ mutate `data` in-place, unlike functions in
+ * {@linkcode Migrations}.
+ *
+ * Again, returning `true` means that the manifest should be--at
+ * minimum--persisted to disk, since we changed it.
+ * @param {Readonly<Manifest>} manifest
+ * @param {keyof ManifestDataVersions} version
+ * @returns {boolean} Whether the data was modified
+ */
+function setSchemaRev(manifest, version) {
+    if ((manifest.schemaRev ?? 0) < version) {
+        manifest.setSchemaRev(version);
+        return true;
+    }
+    return false;
+}
+/**
+ * Applies a series of migration functions to a manifest to update its manifest schema version.
+ *
+ * `data` is modified in-place.
+ *
+ * @param {Readonly<Manifest>} manifest
+ * @returns {Promise<boolean>} If `true` existing packages should be synced from disk and the manifest should be persisted.
+ */
+async function migrate(manifest) {
+    let didChange = false;
+    for await (const migration of Object.values(Migrations)) {
+        didChange = (await migration(manifest)) || didChange;
+    }
+    didChange = setSchemaRev(manifest, constants_1.CURRENT_SCHEMA_REV) || didChange;
+    if (didChange) {
+        // this is not _technically_ true, since we don't actually write the file here.
+        logger_1.default.debug(`Upgraded extension manifest to schema v${manifest.schemaRev}`);
+    }
+    return didChange;
+}
+exports.migrate = migrate;
+/**
+ * A migration function. It will return `true` if a change _should be made_.
+ *
+ * A migration function should not modify `schemaRev`, as this is done automatically.
+ *
+ * Note that at the time of writing, we're not able to determine the version of the _current_ manifest file if there is no `schemaRev` prop present (and we may not want to trust it anyway).
+ * @callback Migration
+ * @param {Readonly<Manifest>} manifest - The `Manifest` instance
+ * @returns {boolean|Promise<boolean>} If `true`, then something changed
+ */
+/**
+ * @typedef {import('appium/types').ManifestData} ManifestData
+ * @typedef {import('@appium/types').DriverType} DriverType
+ * @typedef {import('@appium/types').PluginType} PluginType
+ * @typedef {import('appium/types').AnyManifestDataVersion} AnyManifestDataVersion
+ * @typedef {import('appium/types').ManifestDataVersions} ManifestDataVersions
+ * @typedef {import('@appium/types').ExtensionType} ExtensionType
+ * @typedef {import('appium/types').ManifestV2.ManifestData} ManifestDataV2
+ * @typedef {import('./manifest').Manifest} Manifest
+ */
+/**
+ * @template {ExtensionType} ExtType
+ * @typedef {import('appium/types').ExtManifest<ExtType>} ExtManifest
+ */
+//# sourceMappingURL=manifest-migrations.js.map

package/build/lib/extension/manifest-migrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-migrations.js","sourceRoot":"","sources":["../../../lib/extension/manifest-migrations.js"],"names":[],"mappings":";;;;;;AAAA,4CAA0E;AAC1E,uDAA4B;AAE5B;;;;GAIG;AAEH;;GAEG;AACH,MAAM,YAAY,GAAG,CAAC,CAAC;AAEvB;;GAEG;AACH,MAAM,YAAY,GAAG,CAAC,CAAC;AAEvB;;;;;;;;;GASG;AACH,MAAM,UAAU,GAAG;IACjB;;;;;;;OAOG;IACH,CAAC,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE;QAC3B,qEAAqE;QACrE,MAAM,UAAU,GAAG;YACjB,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,uBAAW,CAAC,CAAC;YACxD,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,uBAAW,CAAC,CAAC;SACzD,CAAC;QACF,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,IAAI,QAAQ,CAAC,CAAC,CAAC;IACrE,CAAC;IACD;;;;;;;;;OASG;IACH,CAAC,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE;QAC3B,IAAI,QAAQ,CAAC,SAAS,GAAG,YAAY,EAAE;YACrC,MAAM,UAAU,GAAG;gBACjB,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,uBAAW,CAAC,CAAC;gBACxD,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,uBAAW,CAAC,CAAC;aACzD,CAAC;YACF,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,WAAW,KAAK,KAAK,CAAC,CAAC;SACtE;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,YAAY,CAAC,QAAQ,EAAE,OAAO;IACrC,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE;QACvC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;KACb;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,OAAO,CAAC,QAAQ;IACpC,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,IAAI,KAAK,EAAE,MAAM,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;QACvD,SAAS,GAAG,CAAC,MAAM,SAAS,CAAC,QAAQ,CAAC,CAAC,IAAI,SAAS,CAAC;KACtD;IACD,SAAS,GAAG,YAAY,CAAC,QAAQ,EAAE,8BAAkB,CAAC,IAAI,SAAS,CAAC;IACpE,IAAI,SAAS,EAAE;QACb,+EAA+E;QAC/E,gBAAG,CAAC,KAAK,CAAC,0CAA0C,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC;KAC3E;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAZD,0BAYC;AAED;;;;;;;;;GASG;AAEH;;;;;;;;;GASG;AAEH;;;GAGG"}

package/build/lib/extension/manifest.d.ts

@@ -0,0 +1,145 @@
+/**
+ * Handles reading & writing of extension config files.
+ *
+ * Only one instance of this class exists per value of `APPIUM_HOME`.
+ */
+export class Manifest {
+    /**
+     * Returns a new or existing {@link Manifest} instance, based on the value of `appiumHome`.
+     *
+     * Maintains one instance per value of `appiumHome`.
+     */
+    static getInstance: ((appiumHome: string) => Manifest) & _.MemoizedFunction;
+    /**
+     * Sets internal data to a fresh clone of {@link INITIAL_MANIFEST_DATA}
+     *
+     * Use {@link Manifest.getInstance} instead.
+     * @param {string} appiumHome
+     * @private
+     */
+    private constructor();
+    /**
+     * Searches `APPIUM_HOME` for installed extensions and adds them to the manifest.
+     * @param {boolean} hasAppiumDependency - This affects whether or not the "dev" `InstallType` is used
+     * @returns {Promise<boolean>} `true` if any extensions were added, `false` otherwise.
+     */
+    syncWithInstalledExtensions(hasAppiumDependency?: boolean): Promise<boolean>;
+    /**
+     * Returns `true` if driver with name `name` is registered.
+     * @param {string} name - Driver name
+     * @returns {boolean}
+     */
+    hasDriver(name: string): boolean;
+    /**
+     * Returns `true` if plugin with name `name` is registered.
+     * @param {string} name - Plugin name
+     * @returns {boolean}
+     */
+    hasPlugin(name: string): boolean;
+    /**
+     * Given a path to a `package.json`, add it as either a driver or plugin to the manifest.
+     *
+     * @template {ExtensionType} ExtType
+     * @param {ExtPackageJson<ExtType>} pkgJson
+     * @param {string} pkgPath
+     * @param {typeof INSTALL_TYPE_NPM | typeof INSTALL_TYPE_DEV} [installType]
+     * @returns {boolean} - `true` if this method did anything.
+     */
+    addExtensionFromPackage<ExtType extends import("@appium/types").ExtensionType>(pkgJson: ExtPackageJson<ExtType>, pkgPath: string, installType?: "npm" | "dev" | undefined): boolean;
+    /**
+     * Adds an extension to the manifest as was installed by the `appium` CLI.  The
+     * `extData`, `extType`, and `extName` have already been determined.
+     *
+     * See {@link Manifest.addExtensionFromPackage} for adding an extension from an on-disk package.
+     * @template {ExtensionType} ExtType
+     * @param {ExtType} extType - `driver` or `plugin`
+     * @param {string} extName - Name of extension
+     * @param {ExtManifest<ExtType>} extData - Extension metadata
+     * @returns {ExtManifest<ExtType>} A clone of `extData`, potentially with a mutated `appiumVersion` field
+     */
+    setExtension<ExtType_1 extends import("@appium/types").ExtensionType>(extType: ExtType_1, extName: string, extData: ExtManifest<ExtType_1>): ExtManifest<ExtType_1>;
+    /**
+     * Sets the schema revision
+     * @param {keyof import('./manifest-migrations').ManifestDataVersions} rev
+     */
+    setSchemaRev(rev: keyof import('./manifest-migrations').ManifestDataVersions): void;
+    /**
+     * Remove an extension from the manifest.
+     * @param {ExtensionType} extType
+     * @param {string} extName
+     */
+    deleteExtension(extType: ExtensionType, extName: string): void;
+    /**
+     * Returns the `APPIUM_HOME` path
+     */
+    get appiumHome(): string;
+    /**
+     * Returns the path to the manifest file (`extensions.yaml`)
+     */
+    get manifestPath(): string;
+    /**
+     * Returns the schema rev of this manifest
+     */
+    get schemaRev(): number;
+    /**
+     * Returns extension data for a particular type.
+     *
+     * @template {ExtensionType} ExtType
+     * @param {ExtType} extType
+     * @returns {Readonly<ExtRecord<ExtType>>}
+     */
+    getExtensionData<ExtType_2 extends import("@appium/types").ExtensionType>(extType: ExtType_2): Readonly<ExtRecord<ExtType_2>>;
+    /**
+     * Reads manifest from disk and _overwrites_ the internal data.
+     *
+     * If the manifest does not exist on disk, an
+     * {@link INITIAL_MANIFEST_DATA "empty"} manifest file will be created, as
+     * well as its directory if needed.
+     *
+     * This will also, if necessary:
+     * 1. perform a migration of the manifest data
+     * 2. sync the manifest with extensions on-disk (kind of like "auto
+     *    discovery")
+     * 3. write the manifest to disk.
+     *
+     * Only one read operation can happen at a time.
+     *
+     * @returns {Promise<ManifestData>} The data
+     */
+    read(): Promise<ManifestData>;
+    /**
+     * Writes the data if it need s writing.
+     *
+     * If the `schemaRev` prop needs updating, the file will be written.
+     *
+     * @todo If this becomes too much of a bottleneck, throttle it.
+     * @returns {Promise<boolean>} Whether the data was written
+     */
+    write(): Promise<boolean>;
+    #private;
+}
+/**
+ * Type of the string referring to a driver (typically as a key or type string)
+ */
+export type DriverType = import('@appium/types').DriverType;
+/**
+ * Type of the string referring to a plugin (typically as a key or type string)
+ */
+export type PluginType = import('@appium/types').PluginType;
+export type SyncWithInstalledExtensionsOpts = {
+    /**
+     * - Maximum depth to recurse into subdirectories
+     */
+    depthLimit?: number | undefined;
+};
+export type ManifestData = import('appium/types').ManifestData;
+export type InternalMetadata = import('appium/types').InternalMetadata;
+export type ExtPackageJson<ExtType extends import("@appium/types").ExtensionType> = import('appium/types').ExtPackageJson<ExtType>;
+export type ExtManifest<ExtType extends import("@appium/types").ExtensionType> = import('appium/types').ExtManifest<ExtType>;
+export type ExtRecord<ExtType extends import("@appium/types").ExtensionType> = import('appium/types').ExtRecord<ExtType>;
+/**
+ * Either `driver` or `plugin` rn
+ */
+export type ExtensionType = import('@appium/types').ExtensionType;
+import _ from "lodash";
+//# sourceMappingURL=manifest.d.ts.map

package/build/lib/extension/manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../../lib/extension/manifest.js"],"names":[],"mappings":"AAqFA;;;;GAIG;AACH;IAwDE;;;;OAIG;IACH,kCAEa,MAAM,KACJ,QAAQ,uBAKrB;IAzBF;;;;;;OAMG;IACH,sBAGC;IAiBD;;;;OAIG;IACH,kDAHW,OAAO,GACL,QAAQ,OAAO,CAAC,CAwE5B;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;;;;;OAQG;IACH,0HAJW,MAAM,4CAEJ,OAAO,CA0CnB;IAED;;;;;;;;;;OAUG;IACH,mGAJW,MAAM,2DAQhB;IAED;;;OAGG;IACH,kBAFW,MAAM,OAAO,uBAAuB,EAAE,oBAAoB,QAIpE;IAED;;;;OAIG;IACH,yBAHW,aAAa,WACb,MAAM,QAIhB;IAED;;OAEG;IACH,yBAEC;IAED;;OAEG;IACH,2BAEC;IAED;;OAEG;IACH,wBAEC;IAED;;;;;;OAMG;IACH,8HAEC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,QAFa,QAAQ,YAAY,CAAC,CAsFjC;IAyBD;;;;;;;OAOG;IACH,SAFa,QAAQ,OAAO,CAAC,CAiC5B;;CACF;;;;yBAIY,OAAO,eAAe,EAAE,UAAU;;;;yBAKlC,OAAO,eAAe,EAAE,UAAU;;;;;;;2BASlC,OAAO,cAAc,EAAE,YAAY;+BACnC,OAAO,cAAc,EAAE,gBAAgB;oFAKvC,OAAO,cAAc,EAAE,cAAc,CAAC,OAAO,CAAC;iFAK9C,OAAO,cAAc,EAAE,WAAW,CAAC,OAAO,CAAC;+EAK3C,OAAO,cAAc,EAAE,SAAS,CAAC,OAAO,CAAC;;;;4BAKzC,OAAO,eAAe,EAAE,aAAa"}