@appium/base-plugin 2.2.1 → 2.2.3

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright JS Foundation and other contributors, https://js.foundation
+   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.

package/build/lib/plugin.d.ts

@@ -1,8 +1,8 @@
 export default BasePlugin;
 export type Plugin = import('@appium/types').Plugin;
 export type NextPluginCallback = import('@appium/types').NextPluginCallback;
-export type Driver = import('@appium/types').Driver;
-export type PluginClass = import('@appium/types').PluginClass;
+export type Constraints = import('@appium/types').Constraints;
+export type Driver<C extends Readonly<Record<string, import("@appium/types").Constraint>>> = import('@appium/types').Driver<C>;
 /**
  * @implements {Plugin}
  */
@@ -54,13 +54,12 @@ export class BasePlugin implements Plugin {
      * `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 {Driver} D
+     * @template {Constraints} C
      * @param {NextPluginCallback} next
-     * @param {D} driver
+     * @param {Driver<C>} driver
      * @param {string} script
      * @param {[Record<string, any>]|[]} protoArgs
-     * @this {Plugin}
      */
-    executeMethod<D extends import("@appium/types").Driver<typeof import("@appium/types").BASE_DESIRED_CAP_CONSTRAINTS, import("@appium/types").StringRecord, any>>(this: import("@appium/types").Plugin, next: NextPluginCallback, driver: D, script: string, protoArgs: [Record<string, any>] | []): Promise<any>;
+    executeMethod<C extends Readonly<Record<string, import("@appium/types").Constraint>>>(next: NextPluginCallback, driver: import("@appium/types").Driver<C, import("@appium/types").StringRecord>, script: string, protoArgs: [Record<string, any>] | []): Promise<any>;
 }
 //# 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":";qBAuFa,OAAO,eAAe,EAAE,MAAM;iCAC9B,OAAO,eAAe,EAAE,kBAAkB;qBAC1C,OAAO,eAAe,EAAE,MAAM;0BAC9B,OAAO,eAAe,EAAE,WAAW;AAvFhD;;GAEG;AACH;IACE;;;;;;;;;;;;;;OAcG;IACH,wBAAyB;IAEzB;;;;;;;;;;;;;;;OAeG;IACH,4BAA6B;IAE7B;;;OAGG;IACH,kBAHW,MAAM,iDAOhB;IAHC,aAAgB;IAChB,iCAAsB;IACtB,6CAAkD;IAGpD;;;;;;;;;;;;OAYG;IACH,4MANW,kBAAkB,qBAElB,MAAM,aACN,CAAC,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC,GAAC,EAAE,gBAkBlC;CACF"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../lib/plugin.js"],"names":[],"mappings":";qBAuFa,OAAO,eAAe,EAAE,MAAM;iCAC9B,OAAO,eAAe,EAAE,kBAAkB;0BAC1C,OAAO,eAAe,EAAE,WAAW;6FAKnC,OAAO,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;AA3F9C;;GAEG;AACH;IACE;;;;;;;;;;;;;;OAcG;IACH,wBAAyB;IAEzB;;;;;;;;;;;;;;;OAeG;IACH,4BAA6B;IAE7B;;;OAGG;IACH,kBAHW,MAAM,iDAOhB;IAHC,aAAgB;IAChB,iCAAsB;IACtB,6CAAkD;IAGpD;;;;;;;;;;;OAWG;IACH,4FALW,kBAAkB,2FAElB,MAAM,aACN,CAAC,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC,GAAC,EAAE,gBAkBlC;CACF"}

package/build/lib/plugin.js

@@ -22,22 +22,20 @@ class BasePlugin {
      * `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 {Driver} D
+     * @template {Constraints} C
      * @param {NextPluginCallback} next
-     * @param {D} driver
+     * @param {Driver<C>} driver
      * @param {string} script
      * @param {[Record<string, any>]|[]} protoArgs
-     * @this {Plugin}
      */
     async executeMethod(next, driver, script, protoArgs) {
-        const Plugin = /** @type {PluginClass} */ (this.constructor);
+        const Plugin = /** @type {import('@appium/types').PluginClass<Plugin>} */ (this.constructor);
         const commandMetadata = { ...Plugin.executeMethodMap?.[script] };
-        /** @type {import('@appium/types').PluginCommand<D>|undefined} */
-        let command;
-        if (!commandMetadata.command || !(command = this[commandMetadata.command])) {
+        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 = (0, base_driver_1.validateExecuteMethodParams)(protoArgs, commandMetadata.params);
         return await command.call(this, next, driver, ...args);
     }
@@ -80,7 +78,10 @@ exports.default = BasePlugin;
 /**
  * @typedef {import('@appium/types').Plugin} Plugin
  * @typedef {import('@appium/types').NextPluginCallback} NextPluginCallback
- * @typedef {import('@appium/types').Driver} Driver
- * @typedef {import('@appium/types').PluginClass} PluginClass
+ * @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,6CAAuC;AACvC,qDAAgE;AAEhE;;GAEG;AACH,MAAM,UAAU;IAoCd;;;OAGG;IACH,YAAY,IAAI,EAAE,OAAO,GAAG,EAAE;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,gBAAM,CAAC,SAAS,CAAC,WAAW,IAAI,GAAG,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS;QACjD,MAAM,MAAM,GAAG,0BAA0B,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7D,MAAM,eAAe,GAAG,EAAC,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAC,CAAC;QAE/D,iEAAiE;QACjE,IAAI,OAAO,CAAC;QAEZ,IAAI,CAAC,eAAe,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,EAAE;YAC1E,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,6CAA6C,MAAM,4BAA4B,CAChF,CAAC;YACF,OAAO,MAAM,IAAI,EAAE,CAAC;SACrB;QACD,MAAM,IAAI,GAAG,IAAA,yCAA2B,EAAC,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;QAC5E,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,CAAC;;AAIK,gCAAU;AA7EhB;;;;;;;;;;;;;;GAcG;AACI,uBAAY,GAAG,EAAE,CAAC;AAEzB;;;;;;;;;;;;;;;GAeG;AACI,2BAAgB,GAAG,EAAE,CAAC;AA2C/B,kBAAe,UAAU,CAAC;AAG1B;;;;;GAKG"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../lib/plugin.js"],"names":[],"mappings":";;;AAAA,6CAAuC;AACvC,qDAAgE;AAEhE;;GAEG;AACH,MAAM,UAAU;IAoCd;;;OAGG;IACH,YAAY,IAAI,EAAE,OAAO,GAAG,EAAE;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,gBAAM,CAAC,SAAS,CAAC,WAAW,IAAI,GAAG,CAAC,CAAC;IACrD,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;YAClE,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,6CAA6C,MAAM,4BAA4B,CAChF,CAAC;YACF,OAAO,MAAM,IAAI,EAAE,CAAC;SACrB;QAED,MAAM,OAAO,GAAG,+DAA+D,CAAC,CAC9E,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAC9B,CAAC;QACF,MAAM,IAAI,GAAG,IAAA,yCAA2B,EAAC,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;QAC5E,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,CAAC;;AAIK,gCAAU;AA7EhB;;;;;;;;;;;;;;GAcG;AACI,uBAAY,GAAG,EAAE,CAAC;AAEzB;;;;;;;;;;;;;;;GAeG;AACI,2BAAgB,GAAG,EAAE,CAAC;AA2C/B,kBAAe,UAAU,CAAC;AAG1B;;;;GAIG;AAEH;;;GAGG"}

package/lib/plugin.js

@@ -56,26 +56,26 @@ class BasePlugin {
    * `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 {Driver} D
+   * @template {Constraints} C
    * @param {NextPluginCallback} next
-   * @param {D} driver
+   * @param {Driver<C>} driver
    * @param {string} script
    * @param {[Record<string, any>]|[]} protoArgs
-   * @this {Plugin}
    */
   async executeMethod(next, driver, script, protoArgs) {
-    const Plugin = /** @type {PluginClass} */ (this.constructor);
+    const Plugin = /** @type {import('@appium/types').PluginClass<Plugin>} */ (this.constructor);
     const commandMetadata = {...Plugin.executeMethodMap?.[script]};
 
-    /** @type {import('@appium/types').PluginCommand<D>|undefined} */
-    let command;
-
-    if (!commandMetadata.command || !(command = this[commandMetadata.command])) {
+    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(protoArgs, commandMetadata.params);
     return await command.call(this, next, driver, ...args);
   }
@@ -87,6 +87,10 @@ export {BasePlugin};
 /**
  * @typedef {import('@appium/types').Plugin} Plugin
  * @typedef {import('@appium/types').NextPluginCallback} NextPluginCallback
- * @typedef {import('@appium/types').Driver} Driver
- * @typedef {import('@appium/types').PluginClass} PluginClass
+ * @typedef {import('@appium/types').Constraints} Constraints
+ */
+
+/**
+ * @template {Constraints} C
+ * @typedef {import('@appium/types').Driver<C>} Driver
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/base-plugin",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "description": "The base plugin used to create Appium 2.0 plugins",
   "keywords": [
     "automation",
@@ -40,8 +40,8 @@
     "test:unit": "mocha \"./test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "^9.3.1",
-    "@appium/support": "^3.1.5"
+    "@appium/base-driver": "^9.3.3",
+    "@appium/support": "^3.1.7"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -50,7 +50,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "322363b8876a7ea7b630d538e22965f7bab0ea06",
+  "gitHead": "872b924a97c13142bdb8bf4218a4db324f309ce4",
   "tags": [
     "appium"
   ],