@appium/base-plugin 3.0.6 → 3.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright OpenJS Foundation and other contributors, https://openjsf.org/
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/build/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { BasePlugin, default } from './plugin';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,OAAO,EAAC,MAAM,UAAU,CAAC"}

package/build/lib/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = exports.BasePlugin = void 0;
+var plugin_1 = require("./plugin");
+Object.defineProperty(exports, "BasePlugin", { enumerable: true, get: function () { return plugin_1.BasePlugin; } });
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(plugin_1).default; } });
+// Handle smoke test flag
+if (require.main === module && process.argv[2] === '--smoke-test') {
+    process.exit(0);
+}
+//# sourceMappingURL=index.js.map

package/build/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";;;;;;AAAA,mCAA6C;AAArC,oGAAA,UAAU,OAAA;AAAE,kHAAA,OAAO,OAAA;AAE3B,yBAAyB;AACzB,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,cAAc,EAAE,CAAC;IAClE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC"}

package/build/lib/plugin.d.ts

@@ -1,71 +1,25 @@
-export default BasePlugin;
-export type Plugin = import("@appium/types").Plugin;
-export type NextPluginCallback = import("@appium/types").NextPluginCallback;
-export type Constraints = import("@appium/types").Constraints;
-export type Driver<C extends Constraints> = import("@appium/types").Driver<C>;
+import { ExtensionCore } from '@appium/base-driver';
+import type { AppiumLogger, Constraints, Driver, ExecuteMethodMap, MethodMap, NextPluginCallback, Plugin, StringRecord } from '@appium/types';
 /**
- * @implements {Plugin}
+ * Base plugin class for Appium plugins.
+ * Subclasses should use type `import('@appium/types').MethodMap<SubclassName>` for
+ * `newMethodMap` and `ExecuteMethodMap<SubclassName>` for `executeMethodMap`.
  */
-export class BasePlugin extends ExtensionCore implements Plugin {
-    /**
-     * Subclasses should use type `import('@appium/types').MethodMap<SubclassName>`.
-     *
-     * This will verify that the commands in the `newMethodMap` property are
-     * valid.  It is impossible to use a generic type param here; the type of this should really
-     * be something like `MethodMap<T extends BasePlugin>` but that isn't a thing TS does.
-     *
-     * ```ts
-     * static newMethodMap = {
-     *   '/session/:sessionId/fake_data': {
-     *     GET: {command: 'getFakeSessionData', neverProxy: true},
-     *   }
-     * } as const;
-     * ```
-     */
-    static newMethodMap: {};
-    /**
-     * Subclasses should use type `import('@appium/types').ExecuteMethodMap<SubclassName>`.
-     *
-     * Building up this map allows the use of the convenience function `executeMethod`, which
-     * basically does verification of names and parameters for execute methods implemented by this
-     * plugin.
-     *
-     * ```ts
-     * static executeMethodMap = {
-     *   'foo: bar': {
-     *     command: 'commandName',
-     *     params: {required: ['thing1', 'thing2'], optional: ['thing3']},
-     *   },
-     * } as const;
-     * ```
-     */
-    static executeMethodMap: {};
-    /**
-     * @param {string} name
-     * @param {Record<string,unknown>} [cliArgs]
-     * @param {string|null} driverId
-     */
-    constructor(name: string, cliArgs?: Record<string, unknown>, driverId?: string | null);
+export declare class BasePlugin extends ExtensionCore implements Plugin {
+    name: string;
+    cliArgs: Record<string, unknown>;
     /**
      * @deprecated Use this.log instead of this.logger
-     * @type {import('@appium/types').AppiumLogger}
      */
-    logger: import("@appium/types").AppiumLogger;
-    name: string;
-    cliArgs: Record<string, unknown>;
+    logger: AppiumLogger;
+    static newMethodMap: MethodMap<BasePlugin>;
+    static executeMethodMap: ExecuteMethodMap<BasePlugin>;
+    constructor(name: string, cliArgs?: Record<string, unknown>, driverId?: string | null);
     /**
-     * A convenience method that can be called by plugins who implement their own `executeMethodMap`.
-     * Only useful if your plugin has defined `executeMethodMap`. This helper requires passing in the
-     * `next` and `driver` objects since naturally we'd want to make sure to trigger the driver's own
-     * `executeMethod` call if an execute method is not found on the plugin itself.
-     *
-     * @template {Constraints} C
-     * @param {NextPluginCallback} next
-     * @param {Driver<C>} driver
-     * @param {string} script
-     * @param {readonly [import('@appium/types').StringRecord<unknown>] | readonly any[]} protoArgs
+     * A convenience method for plugins that implement their own `executeMethodMap`.
+     * Pass through to the driver's execute method if the plugin does not handle the script.
      */
-    executeMethod<C extends Constraints>(next: NextPluginCallback, driver: Driver<C>, script: string, protoArgs: readonly [import("@appium/types").StringRecord<unknown>] | readonly any[]): Promise<unknown>;
+    executeMethod<C extends Constraints>(next: NextPluginCallback, driver: Driver<C>, script: string, protoArgs: readonly [StringRecord<unknown>] | readonly unknown[]): Promise<unknown>;
 }
-import { ExtensionCore } from '@appium/base-driver';
+export default BasePlugin;
 //# sourceMappingURL=plugin.d.ts.map

package/build/lib/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../lib/plugin.js"],"names":[],"mappings":";qBAkGa,OAAO,eAAe,EAAE,MAAM;iCAC9B,OAAO,eAAe,EAAE,kBAAkB;0BAC1C,OAAO,eAAe,EAAE,WAAW;mBAIrB,CAAC,SAAd,WAAY,IACb,OAAO,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;AAvG9C;;GAEG;AACH,yDAFgB,MAAM;IAUpB;;;;;;;;;;;;;;OAcG;IACH,wBAAyB;IAEzB;;;;;;;;;;;;;;;OAeG;IACH,4BAA6B;IAE7B;;;;OAIG;IACH,kBAJW,MAAM,YACN,MAAM,CAAC,MAAM,EAAC,OAAO,CAAC,aACtB,MAAM,GAAC,IAAI,EAUrB;IAtDD;;;OAGG;IACH,QAFU,OAAO,eAAe,EAAE,YAAY,CAEvC;IA+CL,aAAgB;IAChB,iCAAsB;IAIxB;;;;;;;;;;;OAWG;IACH,cAN2B,CAAC,SAAd,WAAY,QACf,kBAAkB,UAClB,MAAM,CAAC,CAAC,CAAC,UACT,MAAM,aACN,SAAS,CAAC,OAAO,eAAe,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,GAAG,EAAE,oBAkBnF;CACF;8BA5FiF,qBAAqB"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../lib/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAGd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,EACZ,WAAW,EACX,MAAM,EACN,gBAAgB,EAChB,SAAS,EACT,kBAAkB,EAClB,MAAM,EAEN,YAAY,EACb,MAAM,eAAe,CAAC;AAEvB;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,aAAc,YAAW,MAAM;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC;;OAEG;IACK,MAAM,EAAE,YAAY,CAAC;IAE7B,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC,UAAU,CAAC,CAAM;IAEhD,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAM;gBAGzD,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EACrC,QAAQ,GAAE,MAAM,GAAG,IAAW;IAWhC;;;OAGG;IACG,aAAa,CAAC,CAAC,SAAS,WAAW,EACvC,IAAI,EAAE,kBAAkB,EACxB,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EACjB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,OAAO,EAAE,GAC/D,OAAO,CAAC,OAAO,CAAC;CAoBpB;AAED,eAAe,UAAU,CAAC"}

package/build/lib/plugin.js

@@ -3,52 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BasePlugin = void 0;
 const base_driver_1 = require("@appium/base-driver");
 /**
- * @implements {Plugin}
+ * Base plugin class for Appium plugins.
+ * Subclasses should use type `import('@appium/types').MethodMap<SubclassName>` for
+ * `newMethodMap` and `ExecuteMethodMap<SubclassName>` for `executeMethodMap`.
  */
 class BasePlugin extends base_driver_1.ExtensionCore {
-    /**
-     * @deprecated Use this.log instead of this.logger
-     * @type {import('@appium/types').AppiumLogger}
-     */
-    logger;
-    /**
-     * Subclasses should use type `import('@appium/types').MethodMap<SubclassName>`.
-     *
-     * This will verify that the commands in the `newMethodMap` property are
-     * valid.  It is impossible to use a generic type param here; the type of this should really
-     * be something like `MethodMap<T extends BasePlugin>` but that isn't a thing TS does.
-     *
-     * ```ts
-     * static newMethodMap = {
-     *   '/session/:sessionId/fake_data': {
-     *     GET: {command: 'getFakeSessionData', neverProxy: true},
-     *   }
-     * } as const;
-     * ```
-     */
+    name;
+    cliArgs;
     static newMethodMap = {};
-    /**
-     * Subclasses should use type `import('@appium/types').ExecuteMethodMap<SubclassName>`.
-     *
-     * Building up this map allows the use of the convenience function `executeMethod`, which
-     * basically does verification of names and parameters for execute methods implemented by this
-     * plugin.
-     *
-     * ```ts
-     * static executeMethodMap = {
-     *   'foo: bar': {
-     *     command: 'commandName',
-     *     params: {required: ['thing1', 'thing2'], optional: ['thing3']},
-     *   },
-     * } as const;
-     * ```
-     */
     static executeMethodMap = {};
-    /**
-     * @param {string} name
-     * @param {Record<string,unknown>} [cliArgs]
-     * @param {string|null} driverId
-     */
     constructor(name, cliArgs = {}, driverId = null) {
         super();
         if (driverId) {
@@ -59,38 +22,21 @@ class BasePlugin extends base_driver_1.ExtensionCore {
         this.logger = this.log;
     }
     /**
-     * A convenience method that can be called by plugins who implement their own `executeMethodMap`.
-     * Only useful if your plugin has defined `executeMethodMap`. This helper requires passing in the
-     * `next` and `driver` objects since naturally we'd want to make sure to trigger the driver's own
-     * `executeMethod` call if an execute method is not found on the plugin itself.
-     *
-     * @template {Constraints} C
-     * @param {NextPluginCallback} next
-     * @param {Driver<C>} driver
-     * @param {string} script
-     * @param {readonly [import('@appium/types').StringRecord<unknown>] | readonly any[]} protoArgs
+     * A convenience method for plugins that implement their own `executeMethodMap`.
+     * Pass through to the driver's execute method if the plugin does not handle the script.
      */
     async executeMethod(next, driver, script, protoArgs) {
-        const Plugin = /** @type {import('@appium/types').PluginClass<Plugin>} */ (this.constructor);
-        const commandMetadata = { ...Plugin.executeMethodMap?.[script] };
+        const PluginClass = this.constructor;
+        const commandMetadata = { ...PluginClass.executeMethodMap?.[script] };
         if (!commandMetadata.command || !(commandMetadata.command in this)) {
-            this.logger.info(`Plugin did not know how to handle method '${script}'. Passing control to next`);
+            this.log.info(`Plugin did not know how to handle method '${script}'. Passing control to next`);
             return await next();
         }
-        const command = /** @type {import('@appium/types').PluginCommand<Driver<C>>} */ (this[commandMetadata.command]);
-        const args = (0, base_driver_1.validateExecuteMethodParams)(/** @type {any[]} */ (protoArgs), commandMetadata.params);
+        const command = this[commandMetadata.command];
+        const args = (0, base_driver_1.validateExecuteMethodParams)(protoArgs, commandMetadata.params);
         return await command.call(this, next, driver, ...args);
     }
 }
 exports.BasePlugin = BasePlugin;
 exports.default = BasePlugin;
-/**
- * @typedef {import('@appium/types').Plugin} Plugin
- * @typedef {import('@appium/types').NextPluginCallback} NextPluginCallback
- * @typedef {import('@appium/types').Constraints} Constraints
- */
-/**
- * @template {Constraints} C
- * @typedef {import('@appium/types').Driver<C>} Driver
- */
 //# sourceMappingURL=plugin.js.map

package/build/lib/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../lib/plugin.js"],"names":[],"mappings":";;;AAAA,qDAAwG;AAExG;;GAEG;AACH,MAAM,UAAW,SAAQ,2BAAa;IAEpC;;;OAGG;IACH,MAAM,CAAC;IAEP;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,YAAY,GAAG,EAAE,CAAC;IAEzB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,gBAAgB,GAAG,EAAE,CAAC;IAE7B;;;;OAIG;IACH,YAAY,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,QAAQ,GAAG,IAAI;QAC7C,KAAK,EAAE,CAAC;QACR,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,CAAC,eAAe,CAAC,GAAG,IAAA,qCAAuB,EAAC,IAAI,CAAC,KAAK,QAAQ,GAAG,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS;QACjD,MAAM,MAAM,GAAG,0DAA0D,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7F,MAAM,eAAe,GAAG,EAAC,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAC,CAAC;QAE/D,IAAI,CAAC,eAAe,CAAC,OAAO,IAAI,CAAC,CAAC,eAAe,CAAC,OAAO,IAAI,IAAI,CAAC,EAAE,CAAC;YACnE,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,6CAA6C,MAAM,4BAA4B,CAChF,CAAC;YACF,OAAO,MAAM,IAAI,EAAE,CAAC;QACtB,CAAC;QAED,MAAM,OAAO,GAAG,+DAA+D,CAAC,CAC9E,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAC9B,CAAC;QACF,MAAM,IAAI,GAAG,IAAA,yCAA2B,EAAC,oBAAoB,CAAC,CAAC,SAAS,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;QACnG,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,CAAC;;AAIK,gCAAU;AADlB,kBAAe,UAAU,CAAC;AAG1B;;;;GAIG;AAEH;;;GAGG"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../lib/plugin.ts"],"names":[],"mappings":";;;AAAA,qDAI6B;AAa7B;;;;GAIG;AACH,MAAa,UAAW,SAAQ,2BAAa;IAC3C,IAAI,CAAS;IACb,OAAO,CAA0B;IAOjC,MAAM,CAAC,YAAY,GAA0B,EAAE,CAAC;IAEhD,MAAM,CAAC,gBAAgB,GAAiC,EAAE,CAAC;IAE3D,YACE,IAAY,EACZ,UAAmC,EAAE,EACrC,WAA0B,IAAI;QAE9B,KAAK,EAAE,CAAC;QACR,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,CAAC,eAAe,CAAC,GAAG,IAAA,qCAAuB,EAAC,IAAI,CAAC,KAAK,QAAQ,GAAG,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CACjB,IAAwB,EACxB,MAAiB,EACjB,MAAc,EACd,SAAgE;QAEhE,MAAM,WAAW,GAAG,IAAI,CAAC,WAAgC,CAAC;QAC1D,MAAM,eAAe,GAAG,EAAC,GAAG,WAAW,CAAC,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAC,CAAC;QAEpE,IAAI,CAAC,eAAe,CAAC,OAAO,IAAI,CAAC,CAAC,eAAe,CAAC,OAAO,IAAI,IAAI,CAAC,EAAE,CAAC;YACnE,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,6CAA6C,MAAM,4BAA4B,CAChF,CAAC;YACF,OAAO,MAAM,IAAI,EAAE,CAAC;QACtB,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAClB,eAAe,CAAC,OAAqB,CACV,CAAC;QAC9B,MAAM,IAAI,GAAG,IAAA,yCAA2B,EACtC,SAAsB,EACtB,eAAe,CAAC,MAAM,CACvB,CAAC;QACF,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,CAAC;;AAvDH,gCAwDC;AAED,kBAAe,UAAU,CAAC"}

package/lib/index.ts

@@ -0,0 +1,6 @@
+export {BasePlugin, default} from './plugin';
+
+// Handle smoke test flag
+if (require.main === module && process.argv[2] === '--smoke-test') {
+  process.exit(0);
+}

package/lib/plugin.ts

@@ -0,0 +1,81 @@
+import {
+  ExtensionCore,
+  generateDriverLogPrefix,
+  validateExecuteMethodParams,
+} from '@appium/base-driver';
+import type {
+  AppiumLogger,
+  Constraints,
+  Driver,
+  ExecuteMethodMap,
+  MethodMap,
+  NextPluginCallback,
+  Plugin,
+  PluginCommand,
+  StringRecord,
+} from '@appium/types';
+
+/**
+ * Base plugin class for Appium plugins.
+ * Subclasses should use type `import('@appium/types').MethodMap<SubclassName>` for
+ * `newMethodMap` and `ExecuteMethodMap<SubclassName>` for `executeMethodMap`.
+ */
+export class BasePlugin extends ExtensionCore implements Plugin {
+  name: string;
+  cliArgs: Record<string, unknown>;
+
+  /**
+   * @deprecated Use this.log instead of this.logger
+   */
+  declare logger: AppiumLogger;
+
+  static newMethodMap: MethodMap<BasePlugin> = {};
+
+  static executeMethodMap: ExecuteMethodMap<BasePlugin> = {};
+
+  constructor(
+    name: string,
+    cliArgs: Record<string, unknown> = {},
+    driverId: string | null = null
+  ) {
+    super();
+    if (driverId) {
+      this.updateLogPrefix(`${generateDriverLogPrefix(this)} <${driverId}>`);
+    }
+    this.name = name;
+    this.cliArgs = cliArgs;
+    this.logger = this.log;
+  }
+
+  /**
+   * A convenience method for plugins that implement their own `executeMethodMap`.
+   * Pass through to the driver's execute method if the plugin does not handle the script.
+   */
+  async executeMethod<C extends Constraints>(
+    next: NextPluginCallback,
+    driver: Driver<C>,
+    script: string,
+    protoArgs: readonly [StringRecord<unknown>] | readonly unknown[]
+  ): Promise<unknown> {
+    const PluginClass = this.constructor as typeof BasePlugin;
+    const commandMetadata = {...PluginClass.executeMethodMap?.[script]};
+
+    if (!commandMetadata.command || !(commandMetadata.command in this)) {
+      this.log.info(
+        `Plugin did not know how to handle method '${script}'. Passing control to next`
+      );
+      return await next();
+    }
+
+    const command = this[
+      commandMetadata.command as keyof this
+    ] as PluginCommand<Driver<C>>;
+    const args = validateExecuteMethodParams(
+      protoArgs as unknown[],
+      commandMetadata.params
+    );
+    return await command.call(this, next, driver, ...args);
+  }
+}
+
+export default BasePlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-plugin",
-  "version": "3.0.6",
+  "version": "3.1.0",
   "description": "The base plugin used to create Appium plugins",
   "keywords": [
     "automation",
@@ -23,26 +23,26 @@
   },
   "license": "Apache-2.0",
   "author": "https://github.com/appium",
-  "types": "./build/lib/plugin.d.ts",
+  "main": "./build/lib/index.js",
+  "types": "./build/lib/index.d.ts",
   "directories": {
     "lib": "./lib"
   },
   "files": [
+    "build/lib",
     "lib",
-    "build",
-    "index.js",
-    "tsconfig.json",
-    "!build/tsconfig.tsbuildinfo",
-    "!build/test"
+    "tsconfig.json"
   ],
   "scripts": {
+    "build": "tsc",
     "test": "npm run test:unit",
-    "test:smoke": "node ./index.js",
-    "test:unit": "mocha \"./test/unit/**/*.spec.js\""
+    "test:smoke": "node ./build/lib/index.js --smoke-test",
+    "test:unit": "mocha \"./test/unit/**/*.spec.*ts\""
   },
   "dependencies": {
-    "@appium/base-driver": "^10.2.0",
-    "@appium/support": "^7.0.5"
+    "@appium/base-driver": "^10.2.1",
+    "@appium/support": "^7.0.6",
+    "@appium/types": "^1.2.1"
   },
   "engines": {
     "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
@@ -51,7 +51,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f7b20335eab4022e5cbbb627ec86866a994444f8",
+  "gitHead": "980a121804ae006db879fb6860f627ac36174c15",
   "tags": [
     "appium"
   ]

package/tsconfig.json

@@ -1,14 +1,8 @@
 {
-  "extends": "@appium/tsconfig/tsconfig.json",
   "compilerOptions": {
     "outDir": "build",
-    "checkJs": true,
-    "strict": true,
-    "paths": {
-      "@appium/support": ["../support"],
-      "@appium/types": ["../types"]
-    }
+    "types": ["mocha", "chai"]
   },
-  "include": ["lib"],
-  "references": [{"path": "../support"}, {"path": "../types"}]
+  "extends": "@appium/tsconfig/tsconfig.plugin.json",
+  "include": ["lib", "test"]
 }

package/index.js

@@ -1 +0,0 @@
-module.exports = require('./build/lib/plugin');

package/lib/plugin.js

@@ -1,107 +0,0 @@
-import {ExtensionCore, generateDriverLogPrefix, validateExecuteMethodParams} from '@appium/base-driver';
-
-/**
- * @implements {Plugin}
- */
-class BasePlugin extends ExtensionCore {
-
-  /**
-   * @deprecated Use this.log instead of this.logger
-   * @type {import('@appium/types').AppiumLogger}
-   */
-  logger;
-
-  /**
-   * Subclasses should use type `import('@appium/types').MethodMap<SubclassName>`.
-   *
-   * This will verify that the commands in the `newMethodMap` property are
-   * valid.  It is impossible to use a generic type param here; the type of this should really
-   * be something like `MethodMap<T extends BasePlugin>` but that isn't a thing TS does.
-   *
-   * ```ts
-   * static newMethodMap = {
-   *   '/session/:sessionId/fake_data': {
-   *     GET: {command: 'getFakeSessionData', neverProxy: true},
-   *   }
-   * } as const;
-   * ```
-   */
-  static newMethodMap = {};
-
-  /**
-   * Subclasses should use type `import('@appium/types').ExecuteMethodMap<SubclassName>`.
-   *
-   * Building up this map allows the use of the convenience function `executeMethod`, which
-   * basically does verification of names and parameters for execute methods implemented by this
-   * plugin.
-   *
-   * ```ts
-   * static executeMethodMap = {
-   *   'foo: bar': {
-   *     command: 'commandName',
-   *     params: {required: ['thing1', 'thing2'], optional: ['thing3']},
-   *   },
-   * } as const;
-   * ```
-   */
-  static executeMethodMap = {};
-
-  /**
-   * @param {string} name
-   * @param {Record<string,unknown>} [cliArgs]
-   * @param {string|null} driverId
-   */
-  constructor(name, cliArgs = {}, driverId = null) {
-    super();
-    if (driverId) {
-      this.updateLogPrefix(`${generateDriverLogPrefix(this)} <${driverId}>`);
-    }
-    this.name = name;
-    this.cliArgs = cliArgs;
-    this.logger = this.log;
-  }
-
-  /**
-   * A convenience method that can be called by plugins who implement their own `executeMethodMap`.
-   * Only useful if your plugin has defined `executeMethodMap`. This helper requires passing in the
-   * `next` and `driver` objects since naturally we'd want to make sure to trigger the driver's own
-   * `executeMethod` call if an execute method is not found on the plugin itself.
-   *
-   * @template {Constraints} C
-   * @param {NextPluginCallback} next
-   * @param {Driver<C>} driver
-   * @param {string} script
-   * @param {readonly [import('@appium/types').StringRecord<unknown>] | readonly any[]} protoArgs
-   */
-  async executeMethod(next, driver, script, protoArgs) {
-    const Plugin = /** @type {import('@appium/types').PluginClass<Plugin>} */ (this.constructor);
-    const commandMetadata = {...Plugin.executeMethodMap?.[script]};
-
-    if (!commandMetadata.command || !(commandMetadata.command in this)) {
-      this.logger.info(
-        `Plugin did not know how to handle method '${script}'. Passing control to next`
-      );
-      return await next();
-    }
-
-    const command = /** @type {import('@appium/types').PluginCommand<Driver<C>>} */ (
-      this[commandMetadata.command]
-    );
-    const args = validateExecuteMethodParams(/** @type {any[]} */ (protoArgs), commandMetadata.params);
-    return await command.call(this, next, driver, ...args);
-  }
-}
-
-export default BasePlugin;
-export {BasePlugin};
-
-/**
- * @typedef {import('@appium/types').Plugin} Plugin
- * @typedef {import('@appium/types').NextPluginCallback} NextPluginCallback
- * @typedef {import('@appium/types').Constraints} Constraints
- */
-
-/**
- * @template {Constraints} C
- * @typedef {import('@appium/types').Driver<C>} Driver
- */