@appium/base-plugin 2.2.52 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,7 +6,7 @@ export type Driver<C extends Constraints> = import("@appium/types").Driver<C>;
6
6
  /**
7
7
  * @implements {Plugin}
8
8
  */
9
- export class BasePlugin implements Plugin {
9
+ export class BasePlugin extends ExtensionCore implements Plugin {
10
10
  /**
11
11
  * Subclasses should use type `import('@appium/types').MethodMap<SubclassName>`.
12
12
  *
@@ -43,11 +43,16 @@ export class BasePlugin implements Plugin {
43
43
  /**
44
44
  * @param {string} name
45
45
  * @param {Record<string,unknown>} [cliArgs]
46
+ * @param {string|null} driverId
46
47
  */
47
- constructor(name: string, cliArgs?: Record<string, unknown>);
48
+ constructor(name: string, cliArgs?: Record<string, unknown>, driverId?: string | null);
49
+ /**
50
+ * @deprecated Use this.log instead of this.logger
51
+ * @type {import('@appium/types').AppiumLogger}
52
+ */
53
+ logger: import("@appium/types").AppiumLogger;
48
54
  name: string;
49
55
  cliArgs: Record<string, unknown>;
50
- logger: import("@appium/types").AppiumLogger;
51
56
  /**
52
57
  * A convenience method that can be called by plugins who implement their own `executeMethodMap`.
53
58
  * Only useful if your plugin has defined `executeMethodMap`. This helper requires passing in the
@@ -62,4 +67,5 @@ export class BasePlugin implements Plugin {
62
67
  */
63
68
  executeMethod<C extends Constraints>(next: NextPluginCallback, driver: Driver<C>, script: string, protoArgs: readonly [import("@appium/types").StringRecord<unknown>] | readonly any[]): Promise<unknown>;
64
69
  }
70
+ import { ExtensionCore } from '@appium/base-driver';
65
71
  //# sourceMappingURL=plugin.d.ts.map
@@ -1 +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;0BAC1C,OAAO,eAAe,EAAE,WAAW;mBAIrB,CAAC,SAAd,WAAY,IACb,OAAO,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;AA3F9C;;GAEG;AACH,mCAFgB,MAAM;IAGpB;;;;;;;;;;;;;;OAcG;IACH,wBAAyB;IAEzB;;;;;;;;;;;;;;;OAeG;IACH,4BAA6B;IAE7B;;;OAGG;IACH,kBAHW,MAAM,YACN,MAAM,CAAC,MAAM,EAAC,OAAO,CAAC,EAMhC;IAHC,aAAgB;IAChB,iCAAsB;IACtB,6CAAkD;IAGpD;;;;;;;;;;;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"}
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"}
@@ -1,20 +1,24 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.BasePlugin = void 0;
4
- const support_1 = require("@appium/support");
5
4
  const base_driver_1 = require("@appium/base-driver");
6
5
  /**
7
6
  * @implements {Plugin}
8
7
  */
9
- class BasePlugin {
8
+ class BasePlugin extends base_driver_1.ExtensionCore {
10
9
  /**
11
10
  * @param {string} name
12
11
  * @param {Record<string,unknown>} [cliArgs]
12
+ * @param {string|null} driverId
13
13
  */
14
- constructor(name, cliArgs = {}) {
14
+ constructor(name, cliArgs = {}, driverId = null) {
15
+ super();
16
+ if (driverId) {
17
+ this.updateLogPrefix(`${(0, base_driver_1.generateDriverLogPrefix)(this)} <${driverId}>`);
18
+ }
15
19
  this.name = name;
16
20
  this.cliArgs = cliArgs;
17
- this.logger = support_1.logger.getLogger(`Plugin [${name}]`);
21
+ this.logger = this.log;
18
22
  }
19
23
  /**
20
24
  * A convenience method that can be called by plugins who implement their own `executeMethodMap`.
@@ -1 +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;;;;;;;;;;;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,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"}
1
+ {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../lib/plugin.js"],"names":[],"mappings":";;;AAAA,qDAAwG;AAExG;;GAEG;AACH,MAAM,UAAW,SAAQ,2BAAa;IA2CpC;;;;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,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;AAlFhB;;;;;;;;;;;;;;GAcG;AACI,uBAAY,GAAG,EAAE,CAAC;AAEzB;;;;;;;;;;;;;;;GAeG;AACI,2BAAgB,GAAG,EAAE,CAAC;AAgD/B,kBAAe,UAAU,CAAC;AAG1B;;;;GAIG;AAEH;;;GAGG"}
package/lib/plugin.js CHANGED
@@ -1,10 +1,16 @@
1
- import {logger} from '@appium/support';
2
- import {validateExecuteMethodParams} from '@appium/base-driver';
1
+ import {ExtensionCore, generateDriverLogPrefix, validateExecuteMethodParams} from '@appium/base-driver';
3
2
 
4
3
  /**
5
4
  * @implements {Plugin}
6
5
  */
7
- class BasePlugin {
6
+ class BasePlugin extends ExtensionCore {
7
+
8
+ /**
9
+ * @deprecated Use this.log instead of this.logger
10
+ * @type {import('@appium/types').AppiumLogger}
11
+ */
12
+ logger;
13
+
8
14
  /**
9
15
  * Subclasses should use type `import('@appium/types').MethodMap<SubclassName>`.
10
16
  *
@@ -43,11 +49,16 @@ class BasePlugin {
43
49
  /**
44
50
  * @param {string} name
45
51
  * @param {Record<string,unknown>} [cliArgs]
52
+ * @param {string|null} driverId
46
53
  */
47
- constructor(name, cliArgs = {}) {
54
+ constructor(name, cliArgs = {}, driverId = null) {
55
+ super();
56
+ if (driverId) {
57
+ this.updateLogPrefix(`${generateDriverLogPrefix(this)} <${driverId}>`);
58
+ }
48
59
  this.name = name;
49
60
  this.cliArgs = cliArgs;
50
- this.logger = logger.getLogger(`Plugin [${name}]`);
61
+ this.logger = this.log;
51
62
  }
52
63
 
53
64
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appium/base-plugin",
3
- "version": "2.2.52",
3
+ "version": "2.3.0",
4
4
  "description": "The base plugin used to create Appium 2.0 plugins",
5
5
  "keywords": [
6
6
  "automation",
@@ -40,8 +40,8 @@
40
40
  "test:unit": "mocha \"./test/unit/**/*.spec.js\""
41
41
  },
42
42
  "dependencies": {
43
- "@appium/base-driver": "^9.14.1",
44
- "@appium/support": "^6.0.2"
43
+ "@appium/base-driver": "^9.15.0",
44
+ "@appium/support": "^6.0.3"
45
45
  },
46
46
  "engines": {
47
47
  "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -50,7 +50,7 @@
50
50
  "publishConfig": {
51
51
  "access": "public"
52
52
  },
53
- "gitHead": "3467f32c8e3618db05b6b210544cfdc6a57bb73c",
53
+ "gitHead": "a7ce83e169e101ae497bab11204a73703fd54e99",
54
54
  "tags": [
55
55
  "appium"
56
56
  ]