appium 3.2.2 → 3.3.1

package/build/lib/extension/driver-config.js

@@ -6,44 +6,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DriverConfig = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const constants_1 = require("../constants");
-const logger_1 = __importDefault(require("../logger"));
+const logger_1 = require("../logger");
 const extension_config_1 = require("./extension-config");
-/**
- * @extends {ExtensionConfig<DriverType>}
- */
 class DriverConfig extends extension_config_1.ExtensionConfig {
-    /**
-     * A set of unique automation names used by drivers.
-     * @type {Set<string>}
-     */
-    knownAutomationNames;
-    /**
-     * A mapping of {@link Manifest} instances to {@link DriverConfig} instances.
-     *
-     * `Manifest` and `ExtensionConfig` have a one-to-many relationship; each `Manifest` should be associated with a `DriverConfig` and a `PluginConfig`; no more, no less.
-     *
-     * This variable tracks the `Manifest`-to-`DriverConfig` portion.
-     *
-     * @type {WeakMap<Manifest,DriverConfig>}
-     * @private
-     */
     static _instances = new WeakMap();
-    /**
-     * Call {@link DriverConfig.create} instead.
-     * @private
-     * @param {import('./manifest').Manifest} manifest - Manifest instance
-     */
+    knownAutomationNames = new Set();
     constructor(manifest) {
         super(constants_1.DRIVER_TYPE, manifest);
-        this.knownAutomationNames = new Set();
     }
-    /**
-     * Creates a new {@link DriverConfig} instance for a {@link Manifest} instance.
-     *
-     * @param {Manifest} manifest
-     * @throws If `manifest` already associated with a `DriverConfig`
-     * @returns {DriverConfig}
-     */
     static create(manifest) {
         const instance = new DriverConfig(manifest);
         if (DriverConfig.getInstance(manifest)) {
@@ -52,28 +22,48 @@ class DriverConfig extends extension_config_1.ExtensionConfig {
         DriverConfig._instances.set(manifest, instance);
         return instance;
     }
-    /**
-     * Returns a DriverConfig associated with a Manifest
-     * @param {Manifest} manifest
-     * @returns {DriverConfig|undefined}
-     */
     static getInstance(manifest) {
         return DriverConfig._instances.get(manifest);
     }
-    /**
-     * Checks extensions for problems
-     */
     async validate() {
         this.knownAutomationNames.clear();
         return await super._validate(this.manifest.getExtensionData(constants_1.DRIVER_TYPE));
     }
-    /**
-     * @param {ExtManifest<DriverType>} extData
-     * @returns {import('./extension-config').ExtManifestProblem[]}
-     */
-    getConfigProblems(extData) {
+    extensionDesc(driverName, { version, automationName }) {
+        return `${String(driverName)}@${version} (automationName '${automationName}')`;
+    }
+    async findMatchingDriver({ automationName, platformName, }) {
+        if (!lodash_1.default.isString(platformName)) {
+            throw new Error('You must include a platformName capability');
+        }
+        if (!lodash_1.default.isString(automationName)) {
+            throw new Error('You must include an automationName capability');
+        }
+        logger_1.log.info(`Attempting to find matching driver for automationName ` +
+            `'${automationName}' and platformName '${platformName}'`);
+        try {
+            const { driverName, mainClass, version } = this._getDriverBySupport(automationName, platformName);
+            logger_1.log.info(`The '${driverName}' driver was installed and matched caps.`);
+            logger_1.log.info(`Will require it at ${this.getInstallPath(driverName)}`);
+            const driver = await this.requireAsync(driverName);
+            if (!driver) {
+                throw new Error(`Driver '${driverName}' did not export a class with name '${mainClass}'. Contact the author of the driver!`);
+            }
+            return { driver, version, driverName };
+        }
+        catch (err) {
+            const msg = `Could not find a driver for automationName ` +
+                `'${automationName}' and platformName '${platformName}'. ` +
+                `Have you installed a driver that supports those ` +
+                `capabilities? Run 'appium driver list --installed' to see. ` +
+                `(Lower-level error: ${err.message})`;
+            throw new Error(msg);
+        }
+    }
+    getConfigProblems(extManifest, extName) {
+        void extName;
         const problems = [];
-        const { platformNames, automationName } = extData;
+        const { platformNames, automationName } = extManifest;
         if (!lodash_1.default.isArray(platformNames)) {
             problems.push({
                 err: 'Missing or incorrect supported platformNames list.',
@@ -108,64 +98,15 @@ class DriverConfig extends extension_config_1.ExtensionConfig {
                 val: automationName,
             });
         }
-        // should we retain the name at the end of this function, once we've checked there are no problems?
         this.knownAutomationNames.add(automationName);
         return problems;
     }
-    /**
-     * @param {ExtName<DriverType>} driverName
-     * @param {ExtManifest<DriverType>} extData
-     * @returns {string}
-     */
-    extensionDesc(driverName, { version, automationName }) {
-        return `${driverName}@${version} (automationName '${automationName}')`;
-    }
-    /**
-     * Given capabilities, find a matching driver within the config. Load its class and return it along with version and driver name.
-     * @template {import('@appium/types').StringRecord} C
-     * @param {C} caps
-     * @returns {Promise<MatchedDriver>}
-     */
-    async findMatchingDriver({ automationName, platformName }) {
-        if (!lodash_1.default.isString(platformName)) {
-            throw new Error('You must include a platformName capability');
-        }
-        if (!lodash_1.default.isString(automationName)) {
-            throw new Error('You must include an automationName capability');
-        }
-        logger_1.default.info(`Attempting to find matching driver for automationName ` +
-            `'${automationName}' and platformName '${platformName}'`);
-        try {
-            const { driverName, mainClass, version } = this._getDriverBySupport(automationName, platformName);
-            logger_1.default.info(`The '${driverName}' driver was installed and matched caps.`);
-            logger_1.default.info(`Will require it at ${this.getInstallPath(driverName)}`);
-            const driver = await this.requireAsync(driverName);
-            if (!driver) {
-                throw new Error(`Driver '${driverName}' did not export a class with name '${mainClass}'. Contact the author of the driver!`);
-            }
-            return { driver, version, driverName };
-        }
-        catch (err) {
-            const msg = `Could not find a driver for automationName ` +
-                `'${automationName}' and platformName '${platformName}'. ` +
-                `Have you installed a driver that supports those ` +
-                `capabilities? Run 'appium driver list --installed' to see. ` +
-                `(Lower-level error: ${err.message})`;
-            throw new Error(msg);
-        }
-    }
-    /**
-     * Given an automation name and platform name, find a suitable driver and return its extension data.
-     * @param {string} matchAutomationName
-     * @param {string} matchPlatformName
-     * @returns {ExtMetadata<DriverType> & import('appium/types').InternalMetadata & import('appium/types').CommonExtMetadata}
-     */
     _getDriverBySupport(matchAutomationName, matchPlatformName) {
         const drivers = this.installedExtensions;
         for (const [driverName, driverData] of lodash_1.default.toPairs(drivers)) {
             const { automationName, platformNames } = driverData;
             const aNameMatches = automationName.toLowerCase() === matchAutomationName.toLowerCase();
-            const pNameMatches = lodash_1.default.includes(platformNames.map(lodash_1.default.toLower), matchPlatformName.toLowerCase());
+            const pNameMatches = lodash_1.default.includes(platformNames.map((p) => lodash_1.default.toLower(p)), matchPlatformName.toLowerCase());
             if (aNameMatches && pNameMatches) {
                 return { driverName, ...driverData };
             }
@@ -181,33 +122,4 @@ class DriverConfig extends extension_config_1.ExtensionConfig {
     }
 }
 exports.DriverConfig = DriverConfig;
-/**
- * @template {ExtensionType} T
- * @typedef {import('appium/types').ExtMetadata<T>} ExtMetadata
- */
-/**
- * @template {ExtensionType} T
- * @typedef {import('appium/types').ExtManifest<T>} ExtManifest
- */
-/**
- * @typedef {import('@appium/types').ExtensionType} ExtensionType
- * @typedef {import('appium/types').ManifestData} ManifestData
- * @typedef {import('@appium/types').DriverType} DriverType
- * @typedef {import('./manifest').Manifest} Manifest
- */
-/**
- * @template {ExtensionType} T
- * @typedef {import('appium/types').ExtRecord<T>} ExtRecord
- */
-/**
- * @template {ExtensionType} T
- * @typedef {import('appium/types').ExtName<T>} ExtName
- */
-/**
- * Return value of {@linkcode DriverConfig.findMatchingDriver}
- * @typedef MatchedDriver
- * @property {import('@appium/types').DriverClass} driver
- * @property {string} version
- * @property {string} driverName
- */
 //# sourceMappingURL=driver-config.js.map

package/build/lib/extension/driver-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"driver-config.js","sourceRoot":"","sources":["../../../lib/extension/driver-config.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,4CAAyC;AACzC,uDAA4B;AAC5B,yDAAmD;AAEnD;;GAEG;AACH,MAAa,YAAa,SAAQ,kCAAe;IAC/C;;;OAGG;IACH,oBAAoB,CAAC;IAErB;;;;;;;;;OASG;IACH,MAAM,CAAC,UAAU,GAAG,IAAI,OAAO,EAAE,CAAC;IAElC;;;;OAIG;IACH,YAAY,QAAQ;QAClB,KAAK,CAAC,uBAAW,EAAE,QAAQ,CAAC,CAAC;QAE7B,IAAI,CAAC,oBAAoB,GAAG,IAAI,GAAG,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,QAAQ;QACpB,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,YAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CACb,6BAA6B,QAAQ,CAAC,UAAU,6EAA6E,CAC9H,CAAC;QACJ,CAAC;QACD,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,QAAQ;QACzB,OAAO,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ;QACZ,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;QAClC,OAAO,MAAM,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,uBAAW,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,OAAO;QACvB,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,EAAC,aAAa,EAAE,cAAc,EAAC,GAAG,OAAO,CAAC;QAEhD,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAC9B,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,oDAAoD;gBACzD,GAAG,EAAE,aAAa;aACnB,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,gBAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YACpC,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,2BAA2B;gBAChC,GAAG,EAAE,aAAa;aACnB,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;gBAClC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACvB,QAAQ,CAAC,IAAI,CAAC;wBACZ,GAAG,EAAE,qCAAqC;wBAC1C,GAAG,EAAE,KAAK;qBACX,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,qCAAqC;gBAC1C,GAAG,EAAE,cAAc;aACpB,CAAC,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;YAClD,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,4DAA4D;gBACjE,GAAG,EAAE,cAAc;aACpB,CAAC,CAAC;QACL,CAAC;QAED,mGAAmG;QACnG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAE9C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,EAAC,OAAO,EAAE,cAAc,EAAC;QACjD,OAAO,GAAG,UAAU,IAAI,OAAO,qBAAqB,cAAc,IAAI,CAAC;IACzE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CAAC,EAAC,cAAc,EAAE,YAAY,EAAC;QACrD,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QAED,gBAAG,CAAC,IAAI,CACN,wDAAwD;YACtD,IAAI,cAAc,uBAAuB,YAAY,GAAG,CAC3D,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,EAAC,UAAU,EAAE,SAAS,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC,mBAAmB,CAC/D,cAAc,EACd,YAAY,CACb,CAAC;YACF,gBAAG,CAAC,IAAI,CAAC,QAAQ,UAAU,0CAA0C,CAAC,CAAC;YACvE,gBAAG,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAClE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YACnD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CACb,WAAW,UAAU,uCAAuC,SAAS,sCAAsC,CAC5G,CAAC;YACJ,CAAC;YACD,OAAO,EAAC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAC,CAAC;QACvC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,GAAG,GACP,6CAA6C;gBAC7C,IAAI,cAAc,uBAAuB,YAAY,KAAK;gBAC1D,kDAAkD;gBAClD,6DAA6D;gBAC7D,uBAAuB,GAAG,CAAC,OAAO,GAAG,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,mBAAmB,EAAE,iBAAiB;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC;QACzC,KAAK,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1D,MAAM,EAAC,cAAc,EAAE,aAAa,EAAC,GAAG,UAAU,CAAC;YACnD,MAAM,YAAY,GAAG,cAAc,CAAC,WAAW,EAAE,KAAK,mBAAmB,CAAC,WAAW,EAAE,CAAC;YACxF,MAAM,YAAY,GAAG,gBAAC,CAAC,QAAQ,CAC7B,aAAa,CAAC,GAAG,CAAC,gBAAC,CAAC,OAAO,CAAC,EAC5B,iBAAiB,CAAC,WAAW,EAAE,CAChC,CAAC;YAEF,IAAI,YAAY,IAAI,YAAY,EAAE,CAAC;gBACjC,OAAO,EAAC,UAAU,EAAE,GAAG,UAAU,EAAC,CAAC;YACrC,CAAC;YAED,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CACb,WAAW,UAAU,4BAA4B;oBAC/C,IAAI,cAAc,+BAA+B;oBACjD,6BAA6B,iBAAiB,eAAe;oBAC7D,qBAAqB;oBACrB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAChC,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,CAAC;;AAxMH,oCAyMC;AAED;;;GAGG;AAEH;;;GAGG;AAEH;;;;;GAKG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;;;GAMG"}
+{"version":3,"file":"driver-config.js","sourceRoot":"","sources":["../../../lib/extension/driver-config.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAGvB,4CAAyC;AACzC,sCAA8B;AAE9B,yDAAmD;AASnD,MAAa,YAAa,SAAQ,kCAA2B;IACnD,MAAM,CAAU,UAAU,GAAG,IAAI,OAAO,EAA0B,CAAC;IACnE,oBAAoB,GAAG,IAAI,GAAG,EAAU,CAAC;IAEjD,YAAoB,QAAkB;QACpC,KAAK,CAAC,uBAAW,EAAE,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,QAAkB;QAC9B,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,YAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CACb,6BAA6B,QAAQ,CAAC,UAAU,6EAA6E,CAC9H,CAAC;QACJ,CAAC;QACD,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,QAAkB;QACnC,OAAO,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;QAClC,OAAO,MAAM,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,uBAAW,CAAC,CAAC,CAAC;IAC5E,CAAC;IAEe,aAAa,CAC3B,UAA+B,EAC/B,EAAC,OAAO,EAAE,cAAc,EAA0B;QAElD,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,OAAO,qBAAqB,cAAc,IAAI,CAAC;IACjF,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAyB,EAC/C,cAAc,EACd,YAAY,GACV;QACF,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,CAAC;QAED,YAAG,CAAC,IAAI,CACN,wDAAwD;YACtD,IAAI,cAAc,uBAAuB,YAAY,GAAG,CAC3D,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,EAAC,UAAU,EAAE,SAAS,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAChG,YAAG,CAAC,IAAI,CAAC,QAAQ,UAAU,0CAA0C,CAAC,CAAC;YACvE,YAAG,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAClE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,UAAiC,CAAC,CAAC;YAC1E,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CACb,WAAW,UAAU,uCAAuC,SAAS,sCAAsC,CAC5G,CAAC;YACJ,CAAC;YACD,OAAO,EAAC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAC,CAAC;QACvC,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,GAAG,GACP,6CAA6C;gBAC7C,IAAI,cAAc,uBAAuB,YAAY,KAAK;gBAC1D,kDAAkD;gBAClD,6DAA6D;gBAC7D,uBAAuB,GAAG,CAAC,OAAO,GAAG,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IAEkB,iBAAiB,CAClC,WAAoC,EACpC,OAAe;QAEf,KAAK,OAAO,CAAC;QACb,MAAM,QAAQ,GAAyB,EAAE,CAAC;QAC1C,MAAM,EAAC,aAAa,EAAE,cAAc,EAAC,GAAG,WAAW,CAAC;QAEpD,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAC9B,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,oDAAoD;gBACzD,GAAG,EAAE,aAAa;aACnB,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,gBAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YACpC,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,2BAA2B;gBAChC,GAAG,EAAE,aAAa;aACnB,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;gBAClC,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACvB,QAAQ,CAAC,IAAI,CAAC;wBACZ,GAAG,EAAE,qCAAqC;wBAC1C,GAAG,EAAE,KAAK;qBACX,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAChC,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,qCAAqC;gBAC1C,GAAG,EAAE,cAAc;aACpB,CAAC,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,cAAwB,CAAC,EAAE,CAAC;YAC5D,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,4DAA4D;gBACjE,GAAG,EAAE,cAAc;aACpB,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,cAAwB,CAAC,CAAC;QAExD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,mBAAmB,CACzB,mBAA2B,EAC3B,iBAAyB;QAEzB,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC;QACzC,KAAK,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,gBAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1D,MAAM,EAAC,cAAc,EAAE,aAAa,EAAC,GAAG,UAAU,CAAC;YACnD,MAAM,YAAY,GAAG,cAAc,CAAC,WAAW,EAAE,KAAK,mBAAmB,CAAC,WAAW,EAAE,CAAC;YACxF,MAAM,YAAY,GAAG,gBAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,WAAW,EAAE,CAAC,CAAC;YAEzG,IAAI,YAAY,IAAI,YAAY,EAAE,CAAC;gBACjC,OAAO,EAAC,UAAU,EAAE,GAAG,UAAU,EAAC,CAAC;YACrC,CAAC;YAED,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CACb,WAAW,UAAU,4BAA4B;oBAC/C,IAAI,cAAc,+BAA+B;oBACjD,6BAA6B,iBAAiB,eAAe;oBAC7D,qBAAqB;oBACrB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAChC,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,CAAC;;AApJH,oCAqJC"}

package/build/lib/extension/extension-config.d.ts

@@ -1,284 +1,177 @@
-/**
- * https://nodejs.org/api/packages.html#package-entry-points
- *
- * @param {any} exportsValue
- * @returns {string | undefined}
- */
-export function resolveEsmEntryPoint(exportsValue: any): string | undefined;
+import type { ExtensionType } from '@appium/types';
+import type { ExtClass, ExtManifest, ExtName, ExtRecord, InstallType } from 'appium/types';
+import type { SchemaObject } from 'ajv';
+import type { ExtensionList } from '../cli/extension-command';
+import type { Manifest } from './manifest';
 /**
  * "npm" install type
  * Used when extension was installed by npm package name
  * @remarks _All_ extensions are installed _by_ `npm`, but only this one means the package name was
  * used to specify it
  */
-export const INSTALL_TYPE_NPM: "npm";
+export declare const INSTALL_TYPE_NPM = "npm";
 /**
  * "local" install type
  * Used when extension was installed from a local path
  */
-export const INSTALL_TYPE_LOCAL: "local";
+export declare const INSTALL_TYPE_LOCAL = "local";
 /**
  * "github" install type
  * Used when extension was installed via GitHub URL
  */
-export const INSTALL_TYPE_GITHUB: "github";
+export declare const INSTALL_TYPE_GITHUB = "github";
 /**
  * "git" install type
  * Used when extensions was installed via Git URL
  */
-export const INSTALL_TYPE_GIT: "git";
+export declare const INSTALL_TYPE_GIT = "git";
 /**
  * "dev" install type
  * Used when automatically detected as a working copy
  */
-export const INSTALL_TYPE_DEV: "dev";
-/** @type {Set<InstallType>} */
-export const INSTALL_TYPES: Set<InstallType>;
+export declare const INSTALL_TYPE_DEV = "dev";
+export declare const INSTALL_TYPES: Set<InstallType>;
+export type ExtManifestProblem = {
+    err: string;
+    val: unknown;
+};
+export type ExtManifestWithSchema<E extends ExtensionType> = ExtManifest<E> & {
+    schema: NonNullable<ExtManifest<E>['schema']>;
+};
+export type ExtensionConfigMutationOpts = {
+    write?: boolean;
+};
 /**
- * This class is abstract. It should not be instantiated directly.
- *
- * Subclasses should provide the generic parameter to implement.
- * @template {ExtensionType} ExtType
+ * Shared configuration and validation for installed Appium extensions (drivers or plugins).
+ * Subclasses fix the extension kind; do not instantiate this class directly.
  */
-export class ExtensionConfig<ExtType extends ExtensionType> {
-    /**
-     * Intended to be called by corresponding instance methods of subclass.
-     * @private
-     * @template {ExtensionType} ExtType
-     * @param {string} appiumHome
-     * @param {ExtType} extType
-     * @param {ExtName<ExtType>} extName - Extension name (unique to its type)
-     * @param {ExtManifestWithSchema<ExtType>} extManifest - Extension config
-     * @returns {import('ajv').SchemaObject|undefined}
-     */
-    private static _readExtensionSchema;
-    /**
-     * Returns `true` if a specific {@link ExtManifest} object has a `schema` prop.
-     * The {@link ExtManifest} object becomes a {@link ExtManifestWithSchema} object.
-     * @template {ExtensionType} ExtType
-     * @param {ExtManifest<ExtType>} extManifest
-     * @returns {extManifest is ExtManifestWithSchema<ExtType>}
-     */
-    static extDataHasSchema<ExtType_1 extends ExtensionType>(extManifest: ExtManifest<ExtType_1>): extManifest is ExtManifestWithSchema<ExtType_1>;
-    /**
-     * @protected
-     * @param {ExtType} extensionType - Type of extension
-     * @param {Manifest} manifest - `Manifest` instance
-     */
-    protected constructor();
-    /**
-     * The type of extension this class is responsible for.
-     * @type {ExtType}
-     */
-    extensionType: ExtType;
-    /**
-     * Manifest data for the extensions of this type.
-     *
-     * This data should _not_ be written to by anything but {@linkcode Manifest}.
-     * @type {Readonly<ExtRecord<ExtType>>}
-     */
-    installedExtensions: Readonly<ExtRecord<ExtType>>;
-    /** @type {import('@appium/types').AppiumLogger} */
-    log: import("@appium/types").AppiumLogger;
-    /** @type {Manifest} */
-    manifest: Manifest;
-    get manifestPath(): string;
+export declare abstract class ExtensionConfig<ExtType extends ExtensionType> {
+    #private;
+    readonly extensionType: ExtType;
+    readonly manifest: Manifest;
+    installedExtensions: ExtRecord<ExtType>;
+    protected constructor(extensionType: ExtType, manifest: Manifest);
+    /** Path to `extensions.yaml` after the manifest has been read; otherwise undefined. */
+    get manifestPath(): string | undefined;
+    /** `APPIUM_HOME` directory this config is tied to. */
     get appiumHome(): string;
     /**
-     * Returns a list of errors for a given extension.
+     * Type guard: manifest entry includes a `schema` path or inline schema object.
      *
-     * @param {ExtName<ExtType>} extName
-     * @param {ExtManifest<ExtType>} extManifest
-     * @returns {ExtManifestProblem[]}
+     * @param extManifest - Parsed extension metadata
      */
-    getProblems(extName: ExtName<ExtType>, extManifest: ExtManifest<ExtType>): ExtManifestProblem[];
+    static extDataHasSchema<E extends ExtensionType>(extManifest: ExtManifest<E>): extManifest is ExtManifestWithSchema<E>;
+    private static _readExtensionSchema;
     /**
-     * Returns a list of warnings for a given extension.
+     * Collects blocking validation issues for one extension (generic fields, type-specific rules, and schema).
      *
-     * @param {ExtName<ExtType>} extName
-     * @param {ExtManifest<ExtType>} extManifest
-     * @returns {Promise<string[]>}
+     * @param extName - Extension key as stored in the manifest
+     * @param extManifest - Manifest entry for that extension
      */
-    getWarnings(extName: ExtName<ExtType>, extManifest: ExtManifest<ExtType>): Promise<string[]>;
+    getProblems(extName: string, extManifest: ExtManifest<ExtType>): Promise<ExtManifestProblem[]>;
     /**
-     * Returns a list of extension-type-specific issues. To be implemented by subclasses.
-     * @abstract
-     * @param {ExtManifest<ExtType>} extManifest
-     * @param {ExtName<ExtType>} extName
-     * @returns {Promise<string[]>}
+     * Collects non-fatal issues for one extension (e.g. manifest quirks, peer dependency mismatches).
+     * Warnings do not by themselves prevent loading.
+     *
+     * @param extName - Extension key as stored in the manifest
+     * @param extManifest - Manifest entry for that extension
      */
-    getConfigWarnings(extManifest: ExtManifest<ExtType>, extName: ExtName<ExtType>): Promise<string[]>;
+    getWarnings(extName: string, extManifest: ExtManifest<ExtType>): Promise<string[]>;
     /**
+     * Turns per-extension errors and warnings into human-readable log lines for console output.
      *
-     * @param {Map<ExtName<ExtType>,ExtManifestProblem[]>} [errorMap]
-     * @param {Map<ExtName<ExtType>,string[]>} [warningMap]
+     * @param errorMap - Extension name to list of blocking problems
+     * @param warningMap - Extension name to list of warning strings
      */
-    getValidationResultSummaries(errorMap?: Map<ExtName<ExtType>, ExtManifestProblem[]>, warningMap?: Map<ExtName<ExtType>, string[]>): {
+    getValidationResultSummaries(errorMap?: Map<string, ExtManifestProblem[]>, warningMap?: Map<string, string[]>): {
         errorSummaries: string[];
         warningSummaries: string[];
     };
     /**
-     * Checks extensions for problems.  To be called by subclasses' `validate` method.
+     * Records a new installed extension in the manifest and optionally persists immediately.
      *
-     * Errors and warnings will be displayed to the user.
+     * @param extName - Manifest key for the extension
+     * @param extManifest - Full manifest payload
      *
-     * This method mutates `exts`.
-     *
-     * @protected
-     * @param {ExtRecord<ExtType>} exts - Lookup of extension names to {@linkcode ExtManifest} objects
-     * @returns {Promise<ExtRecord<ExtType>>} The same lookup, but picking only error-free extensions
+     * Pass `{ write: false }` to defer flushing until a later manifest write.
      */
-    protected _validate(exts: ExtRecord<ExtType>): Promise<ExtRecord<ExtType>>;
-    /**
-     * Retrieves listing data for extensions via command class.
-     *
-     * This is an expensive operation, so the result is cached.  Currently, there is no
-     * use case for invalidating the cache.
-     * @protected
-     * @returns {Promise<import('../cli/extension-command').ExtensionList<ExtType>>}
-     */
-    protected getListData(): Promise<import("../cli/extension-command").ExtensionList<ExtType>>;
+    addExtension(extName: string, extManifest: ExtManifest<ExtType>, { write }?: ExtensionConfigMutationOpts): Promise<void>;
     /**
-     * Returns a list of warnings for a particular extension.
+     * Merges new metadata into an existing extension entry and optionally writes the manifest.
      *
-     * By definition, a non-empty list of warnings does _not_ imply the extension cannot be loaded,
-     * but it may not work as expected or otherwise throw an exception at runtime.
+     * @param extName - Installed extension to update
+     * @param extManifest - Fields to merge over the current entry
      *
-     * @param {ExtManifest<ExtType>} extManifest
-     * @param {ExtName<ExtType>} extName
-     * @returns {Promise<string[]>}
-     */
-    getGenericConfigWarnings(extManifest: ExtManifest<ExtType>, extName: ExtName<ExtType>): Promise<string[]>;
-    /**
-     * Returns list of unrecoverable errors (if any) for the given extension _if_ it has a `schema` property.
-     *
-     * @param {ExtManifest<ExtType>} extManifest - Extension data (from manifest)
-     * @param {ExtName<ExtType>} extName - Extension name (from manifest)
-     * @returns {ExtManifestProblem[]}
-     */
-    getSchemaProblems(extManifest: ExtManifest<ExtType>, extName: ExtName<ExtType>): ExtManifestProblem[];
-    /**
-     * Return a list of generic unrecoverable errors for the given extension
-     * @param {ExtManifest<ExtType>} extManifest - Extension data (from manifest)
-     * @param {ExtName<ExtType>} extName - Extension name (from manifest)
-     * @returns {ExtManifestProblem[]}
-     */
-    getGenericConfigProblems(extManifest: ExtManifest<ExtType>, extName: ExtName<ExtType>): ExtManifestProblem[];
-    /**
-     * @abstract
-     * @param {ExtManifest<ExtType>} extManifest
-     * @param {ExtName<ExtType>} extName
-     * @returns {ExtManifestProblem[]}
-     */
-    getConfigProblems(extManifest: ExtManifest<ExtType>, extName: ExtName<ExtType>): ExtManifestProblem[];
-    /**
-     * @param {string} extName
-     * @param {ExtManifest<ExtType>} extManifest
-     * @param {ExtensionConfigMutationOpts} opts
-     * @returns {Promise<void>}
-     */
-    addExtension(extName: string, extManifest: ExtManifest<ExtType>, { write }?: ExtensionConfigMutationOpts): Promise<void>;
-    /**
-     * @param {ExtName<ExtType>} extName
-     * @param {ExtManifest<ExtType>} extManifest
-     * @param {ExtensionConfigMutationOpts} opts
-     * @returns {Promise<void>}
+     * Pass `{ write: false }` to defer flushing until a later manifest write.
      */
     updateExtension(extName: ExtName<ExtType>, extManifest: ExtManifest<ExtType>, { write }?: ExtensionConfigMutationOpts): Promise<void>;
     /**
-     * Remove an extension from the list of installed extensions, and optionally avoid a write to the manifest file.
+     * Drops an extension from the manifest and optionally persists immediately.
+     *
+     * @param extName - Installed extension to remove
      *
-     * @param {ExtName<ExtType>} extName
-     * @param {ExtensionConfigMutationOpts} opts
-     * @returns {Promise<void>}
+     * Pass `{ write: false }` to defer flushing until a later manifest write.
      */
     removeExtension(extName: ExtName<ExtType>, { write }?: ExtensionConfigMutationOpts): Promise<void>;
     /**
-     * @param {ExtName<ExtType>[]} [activeNames]
-     * @returns {void}
+     * Logs installed extensions to the console. Subclasses may use `activeNames` to annotate active plugins.
      */
-    print(activeNames?: ExtName<ExtType>[]): void;
+    print(_activeNames?: ExtName<ExtType>[]): void;
     /**
-     * Returns a string describing the extension. Subclasses must implement.
-     * @param {ExtName<ExtType>} extName - Extension name
-     * @param {ExtManifest<ExtType>} extManifest - Extension data
-     * @returns {string}
-     * @abstract
-     */
-    extensionDesc(extName: ExtName<ExtType>, extManifest: ExtManifest<ExtType>): string;
-    /**
-     * Returns--with reasonable accuracy--the path on disk to the extension.
+     * Root directory of an installed extension, preferring `installPath` and falling back to `node_modules/<pkgName>`.
      *
-     * If `installPath` is present in the manifest, then it is used; otherwise we just guess.
-     * @param {keyof typeof this.installedExtensions} extName
-     * @returns {string}
+     * @param extName - Installed extension key
      */
-    getInstallPath(extName: keyof typeof this.installedExtensions): string;
+    getInstallPath(extName: keyof ExtRecord<ExtType> & string): string;
     /**
+     * Dynamically imports the extension entry point and returns the exported main class constructor.
      *
-     * @param {ExtName<ExtType>} extName
-     * @returns {Promise<[string, string]>}
+     * @param extName - Installed extension to load
      */
-    _resolveExtension(extName: ExtName<ExtType>): Promise<[string, string]>;
+    requireAsync(extName: ExtName<ExtType>): Promise<ExtClass<ExtType>>;
+    /** Whether the manifest lists an extension under the given name. */
+    isInstalled(extName: string): boolean;
     /**
-     * Loads extension asynchronously and returns its main class (constructor)
+     * Loads the extension’s config schema from disk or inline JSON and registers it for CLI/config validation.
      *
-     * @param {ExtName<ExtType>} extName
-     * @returns {Promise<ExtClass<ExtType>>}
+     * @param extName - Extension key
+     * @param extManifest - Manifest entry that includes `schema`
      */
-    requireAsync(extName: ExtName<ExtType>): Promise<ExtClass<ExtType>>;
+    readExtensionSchema(extName: string, extManifest: ExtManifestWithSchema<ExtType>): Promise<SchemaObject | undefined>;
+    /** Optional async warnings for this extension kind; override in subclasses when needed. */
+    protected getConfigWarnings(_extManifest: ExtManifest<ExtType>, _extName: string): Promise<string[]>;
     /**
-     * @param {string} extName
-     * @returns {boolean}
+     * Validates all entries in `exts`, logs summaries, and removes keys that have blocking errors.
+     * Intended for subclasses’ `validate` implementation.
      */
-    isInstalled(extName: string): boolean;
+    protected _validate(exts: ExtRecord<ExtType>): Promise<ExtRecord<ExtType>>;
     /**
-     * If an extension provides a schema, this will load the schema and attempt to
-     * register it with the schema registrar.
-     * @param {ExtName<ExtType>} extName - Name of extension
-     * @param {ExtManifestWithSchema<ExtType>} extManifest - Extension data
-     * @returns {import('ajv').SchemaObject|undefined}
+     * Fetches `appium driver|plugin list`-style data via the CLI command class; result is cached.
      */
-    readExtensionSchema(extName: ExtName<ExtType>, extManifest: ExtManifestWithSchema<ExtType>): import("ajv").SchemaObject | undefined;
-    #private;
-}
-/**
- * An issue with the {@linkcode ExtManifest} for a particular extension.
- *
- * The existance of such an object implies that the extension cannot be loaded.
- */
-export type ExtManifestProblem = {
+    protected getListData(): Promise<ExtensionList<ExtType>>;
     /**
-     * - Error message
+     * Warnings about manifest install fields and Appium peer dependency compatibility for one extension.
      */
-    err: string;
+    protected getGenericConfigWarnings(extManifest: ExtManifest<ExtType>, extName: string): Promise<string[]>;
+    /** Validates and registers extension CLI/config schema when the manifest defines a `schema` field. */
+    protected getSchemaProblems(extManifest: ExtManifest<ExtType>, extName: string): Promise<ExtManifestProblem[]>;
+    /** Blocking issues for required manifest fields shared by all extensions (version, package name, main class). */
+    protected getGenericConfigProblems(extManifest: ExtManifest<ExtType>, extName: string): ExtManifestProblem[];
+    /** Driver- or plugin-specific blocking validation; override in subclasses when needed. */
+    protected getConfigProblems(_extManifest: ExtManifest<ExtType>, _extName: string): ExtManifestProblem[];
+    private _resolveExtension;
     /**
-     * - Associated value
+     * One-line human description for list output; implemented per extension kind.
+     *
+     * @param extName - Manifest key
+     * @param extManifest - Entry used for version and kind-specific labels
      */
-    val: any;
-};
-/**
- * An optional logging function provided to an {@link ExtensionConfig} subclass.
- */
-export type ExtensionLogFn = (...args: any[]) => void;
-export type ExtensionType = import("@appium/types").ExtensionType;
-export type Manifest = import("./manifest").Manifest;
-export type InstallType = import("appium/types").InstallType;
-export type ExtManifest<ExtType extends ExtensionType> = import("appium/types").ExtManifest<ExtType>;
-export type ExtManifestWithSchema<ExtType extends ExtensionType> = ExtManifest<ExtType> & {
-    schema: NonNullable<ExtManifest<ExtType>["schema"]>;
-};
-export type ExtName<ExtType extends ExtensionType> = import("appium/types").ExtName<ExtType>;
-export type ExtClass<ExtType extends ExtensionType> = import("appium/types").ExtClass<ExtType>;
-export type ExtRecord<ExtType extends ExtensionType> = import("appium/types").ExtRecord<ExtType>;
-export type ExtCommand<ExtType extends ExtensionType> = import("../cli/extension").ExtCommand<ExtType>;
+    abstract extensionDesc(extName: ExtName<ExtType>, extManifest: ExtManifest<ExtType>): string;
+}
 /**
- * Options for various methods in {@link ExtensionConfig}
+ * Resolves a package `exports` field (string, `"."`, or `"import"`) to a relative entry path for ESM packages.
+ *
+ * @param exportsValue - `package.json` `exports` value or nested fragment
  */
-export type ExtensionConfigMutationOpts = {
-    /**
-     * Whether or not to write the manifest to disk after a mutation operation
-     */
-    write?: boolean | undefined;
-};
+export declare function resolveEsmEntryPoint(exportsValue: unknown): string | undefined;
 //# sourceMappingURL=extension-config.d.ts.map