@appium/fake-plugin 4.0.6 → 4.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 { FakePlugin } 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,EAAC,MAAM,UAAU,CAAC"}

package/build/lib/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FakePlugin = void 0;
+var plugin_1 = require("./plugin");
+Object.defineProperty(exports, "FakePlugin", { enumerable: true, get: function () { return plugin_1.FakePlugin; } });
+// 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,mCAAoC;AAA5B,oGAAA,UAAU,OAAA;AAElB,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,103 +1,41 @@
-export default FakePlugin;
-export class FakePlugin extends BasePlugin {
-    static newMethodMap: {
-        readonly '/session/:sessionId/fake_data': {
-            readonly GET: {
-                readonly command: "getFakeSessionData";
-                readonly neverProxy: true;
-            };
-            readonly POST: {
-                readonly command: "setFakeSessionData";
-                readonly payloadParams: {
-                    readonly required: readonly ["data"];
-                };
-                readonly neverProxy: true;
-            };
-        };
-        readonly '/session/:sessionId/fakepluginargs': {
-            readonly GET: {
-                readonly command: "getFakePluginArgs";
-                readonly neverProxy: true;
-            };
-        };
-    };
-    static newBidiCommands: {
-        readonly 'appium:fake': {
-            readonly getPluginThing: {
-                readonly command: "getPluginThing";
-            };
-            readonly setPluginThing: {
-                readonly command: "setPluginThing";
-                readonly params: {
-                    readonly required: readonly ["thing"];
-                };
-            };
-            readonly doSomeMath: {
-                readonly command: "doSomeMath";
-                readonly params: {
-                    readonly required: readonly ["num1", "num2"];
-                };
-            };
-            readonly doSomeMath2: {
-                readonly command: "doSomeMath2";
-                readonly params: {
-                    readonly required: readonly ["num1", "num2"];
-                };
-            };
-        };
-    };
-    /** @type {string?} */
-    static _unexpectedData: string | null;
-    static executeMethodMap: {
-        readonly 'fake: getThing': {
-            readonly command: "getFakeThing";
-        };
-        readonly 'fake: plugMeIn': {
-            readonly command: "plugMeIn";
-            readonly params: {
-                readonly required: readonly ["socket"];
-            };
-        };
-    };
-    static fakeRoute(req: any, res: any): void;
-    static unexpectedData(req: any, res: any): void;
-    static updateServer(expressApp: any, httpServer: any, cliArgs: any): Promise<void>;
-    /**
-     * @param {string} name
-     * @param {Record<string,unknown>} cliArgs
-     */
-    constructor(name: string, cliArgs: Record<string, unknown>);
-    /**
-     * @type {string}
-     * @readonly
-     */
-    readonly fakeThing: string;
-    /**
-     * @type {any}
-     */
-    pluginThing: any;
-    _clockRunning: boolean;
+import { BasePlugin } from 'appium/plugin';
+import type { Request, Response, Application } from 'express';
+import type { AppiumServer, BidiModuleMap, ExecuteMethodMap, ExternalDriver, MethodMap } from '@appium/types';
+/** Driver as seen by this plugin; may include plugin-specific session data */
+export type DriverLike = ExternalDriver & {
+    fakeSessionData?: unknown;
+};
+export declare class FakePlugin extends BasePlugin {
+    private readonly fakeThing;
+    private pluginThing;
+    protected _clockRunning: boolean;
+    private static _unexpectedData;
+    static newMethodMap: MethodMap<FakePlugin>;
+    static newBidiCommands: BidiModuleMap;
+    static executeMethodMap: ExecuteMethodMap<FakePlugin>;
+    constructor(name: string, cliArgs?: Record<string, unknown>);
+    static fakeRoute(_req: Request, res: Response): void;
+    static unexpectedData(_req: Request, res: Response): void;
+    static updateServer(expressApp: Application, _httpServer: AppiumServer, cliArgs: Record<string, unknown>): Promise<void>;
     startClock(): Promise<void>;
-    doSomeMath(next: any, driver: any, num1: any, num2: any): Promise<any>;
-    doSomeMath2(next: any, driver: any, num1: any, num2: any): Promise<number>;
+    doSomeMath(next: () => Promise<number>, _driver: DriverLike, num1: number, num2: number): Promise<number>;
+    doSomeMath2(_next: () => Promise<unknown>, _driver: DriverLike, num1: number, num2: number): Promise<number>;
     getFakeThing(): Promise<string>;
-    getPluginThing(): Promise<any>;
-    /**
-     * @param {() => Promise<any>} next
-     * @param {import('@appium/types').Driver} driver
-     * @param {any} thing
-     */
-    setPluginThing(next: () => Promise<any>, driver: import("@appium/types").Driver, thing: any): Promise<void>;
-    plugMeIn(next: any, driver: any, socket: string): Promise<string>;
+    getPluginThing(): Promise<unknown>;
+    setPluginThing(_next: () => Promise<unknown>, _driver: DriverLike, thing: unknown): Promise<void>;
+    plugMeIn(_next: () => Promise<unknown>, _driver: DriverLike, socket: string): Promise<string>;
     getFakePluginArgs(): Promise<Record<string, unknown>>;
-    getPageSource(next: any, driver: any, ...args: any[]): Promise<string>;
-    findElement(next: any, driver: any, ...args: any[]): Promise<any>;
-    getFakeSessionData(next: any, driver: any): Promise<any>;
-    setFakeSessionData(next: any, driver: any, ...args: any[]): Promise<null>;
-    getWindowHandle(next: any): Promise<string>;
-    onUnexpectedShutdown(driver: any, cause: any): Promise<void>;
-    execute(next: any, driver: any, script: any, args: any): Promise<unknown>;
-    deleteSession(next: any): Promise<any>;
+    getPageSource(_next: () => Promise<string>, _driver: DriverLike, ...args: unknown[]): Promise<string>;
+    findElement(next: () => Promise<{
+        fake?: boolean;
+    } & Record<string, unknown>>, _driver: DriverLike, ...args: unknown[]): Promise<{
+        fake?: boolean;
+    } & Record<string, unknown>>;
+    getFakeSessionData(_next: () => Promise<unknown>, driver: DriverLike): Promise<unknown>;
+    setFakeSessionData(_next: () => Promise<unknown>, driver: DriverLike, ...args: unknown[]): Promise<null>;
+    getWindowHandle(next: () => Promise<string>): Promise<string>;
+    onUnexpectedShutdown(_driver: DriverLike, cause: Error | string): Promise<void>;
+    execute(next: () => Promise<unknown>, driver: DriverLike, script: string, args: unknown[]): Promise<unknown>;
+    deleteSession(next: () => Promise<unknown>): Promise<unknown>;
 }
-import { BasePlugin } from 'appium/plugin';
 //# 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":";AAMA;IAwBE;;;;;;;;;;;;;;;;;;;;MAYG;IAEH;;;;;;;;;;;;;;;;;;;;;;;;MAwBG;IAEH,sBAAsB;IACtB,wBADW,MAAM,OAAC,CACY;IAE9B;;;;;;;;;;MAWG;IAEH,2CAEC;IAED,gDAGC;IAGD,mFAMC;IAlFD;;;OAGG;IACH,kBAHW,MAAM,WACN,MAAM,CAAC,MAAM,EAAC,OAAO,CAAC,EAMhC;IArBD;;;OAGG;IACH,oBAHU,MAAM,CAGN;IAEV;;OAEG;IACH,aAFU,GAAG,CAEM;IAEnB,uBAAqB;IAsFrB,4BAQC;IAED,uEAGC;IAED,2EAIC;IAED,gCAGC;IAED,+BAMC;IAED;;;;OAIG;IACH,qBAJW,MAAM,OAAO,CAAC,GAAG,CAAC,UAClB,OAAO,eAAe,EAAE,MAAM,SAC9B,GAAG,iBAIb;IAED,yCAAwC,MAAM,mBAG7C;IAED,sDAGC;IAED,uEAGC;IAED,kEAMC;IAED,yDAGC;IAED,0EAIC;IAED,4CAGC;IAGD,6DAGC;IAED,0EAEC;IAED,uCAGC;CACF;2BArMwB,eAAe"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../lib/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAEzC,OAAO,KAAK,EAAC,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAC,MAAM,SAAS,CAAC;AAC5D,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,cAAc,EACd,SAAS,EACV,MAAM,eAAe,CAAC;AAEvB,8EAA8E;AAC9E,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG;IAAC,eAAe,CAAC,EAAE,OAAO,CAAA;CAAC,CAAC;AAEtE,qBAAa,UAAW,SAAQ,UAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,WAAW,CAAiB;IACpC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAQ;IACxC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAuB;IAErD,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC,UAAU,CAAC,CAYxC;IAEF,MAAM,CAAC,eAAe,EAAE,aAAa,CAwBnC;IAEF,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAQnD;gBAEU,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM;IAM/D,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,IAAI;IAIpD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,IAAI;WAK5C,YAAY,CACvB,UAAU,EAAE,WAAW,EACvB,WAAW,EAAE,YAAY,EACzB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAQV,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B,UAAU,CACd,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EAC3B,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,CAAC;IAKZ,WAAW,CACf,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EAC7B,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,CAAC;IAKZ,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;IAK/B,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAQlC,cAAc,CAClB,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EAC7B,OAAO,EAAE,UAAU,EACnB,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,IAAI,CAAC;IAIV,QAAQ,CACZ,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EAC7B,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,CAAC;IAKZ,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAKrD,aAAa,CACjB,KAAK,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EAC5B,OAAO,EAAE,UAAU,EACnB,GAAG,IAAI,EAAE,OAAO,EAAE,GACjB,OAAO,CAAC,MAAM,CAAC;IAKZ,WAAW,CACf,IAAI,EAAE,MAAM,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAC/D,OAAO,EAAE,UAAU,EACnB,GAAG,IAAI,EAAE,OAAO,EAAE,GACjB,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAQhD,kBAAkB,CAAC,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAKvF,kBAAkB,CACtB,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EAC7B,MAAM,EAAE,UAAU,EAClB,GAAG,IAAI,EAAE,OAAO,EAAE,GACjB,OAAO,CAAC,IAAI,CAAC;IAMV,eAAe,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAK7D,oBAAoB,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/E,OAAO,CACX,IAAI,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EAC5B,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,EAAE,GACd,OAAO,CAAC,OAAO,CAAC;IAIb,aAAa,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAIpE"}

package/build/lib/plugin.js

@@ -1,33 +1,14 @@
 "use strict";
-// @ts-check
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FakePlugin = void 0;
 const plugin_1 = require("appium/plugin");
-const bluebird_1 = __importDefault(require("bluebird"));
+const asyncbox_1 = require("asyncbox");
 class FakePlugin extends plugin_1.BasePlugin {
-    /**
-     * @type {string}
-     * @readonly
-     */
     fakeThing;
-    /**
-     * @type {any}
-     */
     pluginThing = null;
     _clockRunning = true;
-    /**
-     * @param {string} name
-     * @param {Record<string,unknown>} cliArgs
-     */
-    constructor(name, cliArgs) {
-        super(name, cliArgs);
-        this.fakeThing = 'PLUGIN_FAKE_THING';
-        this.startClock();
-    }
-    static newMethodMap = /** @type {const} */ ({
+    static _unexpectedData = null;
+    static newMethodMap = {
         '/session/:sessionId/fake_data': {
             GET: { command: 'getFakeSessionData', neverProxy: true },
             POST: {
@@ -39,8 +20,8 @@ class FakePlugin extends plugin_1.BasePlugin {
         '/session/:sessionId/fakepluginargs': {
             GET: { command: 'getFakePluginArgs', neverProxy: true },
         },
-    });
-    static newBidiCommands = /** @type {const} */ ({
+    };
+    static newBidiCommands = {
         'appium:fake': {
             getPluginThing: {
                 command: 'getPluginThing',
@@ -63,29 +44,30 @@ class FakePlugin extends plugin_1.BasePlugin {
                     required: ['num1', 'num2'],
                 },
             },
-        }
-    });
-    /** @type {string?} */
-    static _unexpectedData = null;
-    static executeMethodMap = /** @type {const} */ ({
-        // this execute method overrides fake-drivers fake: getThing, for testing
+        },
+    };
+    static executeMethodMap = {
         'fake: getThing': {
             command: 'getFakeThing',
         },
-        // this is a totally new execute method
         'fake: plugMeIn': {
             command: 'plugMeIn',
             params: { required: ['socket'] },
         },
-    });
-    static fakeRoute(req, res) {
+    };
+    constructor(name, cliArgs = {}) {
+        super(name, cliArgs);
+        this.fakeThing = 'PLUGIN_FAKE_THING';
+        this.startClock();
+    }
+    static fakeRoute(_req, res) {
         res.send(JSON.stringify({ fake: 'fakeResponse' }));
     }
-    static unexpectedData(req, res) {
+    static unexpectedData(_req, res) {
         res.send(JSON.stringify(FakePlugin._unexpectedData));
         FakePlugin._unexpectedData = null;
     }
-    static async updateServer(expressApp, httpServer, cliArgs) {
+    static async updateServer(expressApp, _httpServer, cliArgs) {
         expressApp.all('/fake', FakePlugin.fakeRoute);
         expressApp.all('/unexpected', FakePlugin.unexpectedData);
         expressApp.all('/cliArgs', (req, res) => {
@@ -94,24 +76,23 @@ class FakePlugin extends plugin_1.BasePlugin {
     }
     async startClock() {
         while (this._clockRunning) {
-            await bluebird_1.default.delay(250);
+            await (0, asyncbox_1.sleep)(250);
             this.eventEmitter.emit('bidiEvent', {
                 method: 'appium:clock.currentTime',
                 params: { time: Date.now() },
             });
         }
     }
-    async doSomeMath(next, driver, num1, num2) {
-        const sum = await next(); // call driver's 'doSomeMath' which sums num1 and num2
-        return (num1 * num2) + sum;
+    async doSomeMath(next, _driver, num1, num2) {
+        const sum = await next();
+        return num1 * num2 + sum;
     }
-    async doSomeMath2(next, driver, num1, num2) {
-        // ignore next & driver in this method
-        await bluebird_1.default.delay(1);
+    async doSomeMath2(_next, _driver, num1, num2) {
+        await (0, asyncbox_1.sleep)(1);
         return num1 * num2;
     }
     async getFakeThing() {
-        await bluebird_1.default.delay(1);
+        await (0, asyncbox_1.sleep)(1);
         return this.fakeThing;
     }
     async getPluginThing() {
@@ -121,39 +102,34 @@ class FakePlugin extends plugin_1.BasePlugin {
         });
         return this.pluginThing;
     }
-    /**
-     * @param {() => Promise<any>} next
-     * @param {import('@appium/types').Driver} driver
-     * @param {any} thing
-     */
-    async setPluginThing(next, driver, thing) {
+    async setPluginThing(_next, _driver, thing) {
         this.pluginThing = thing;
     }
-    async plugMeIn(next, driver, /** @type {string} */ socket) {
-        await bluebird_1.default.delay(1);
+    async plugMeIn(_next, _driver, socket) {
+        await (0, asyncbox_1.sleep)(1);
         return `Plugged in to ${socket}`;
     }
     async getFakePluginArgs() {
-        await bluebird_1.default.delay(1);
+        await (0, asyncbox_1.sleep)(1);
         return this.cliArgs;
     }
-    async getPageSource(next, driver, ...args) {
-        await bluebird_1.default.delay(10);
+    async getPageSource(_next, _driver, ...args) {
+        await (0, asyncbox_1.sleep)(10);
         return `<Fake>${JSON.stringify(args)}</Fake>`;
     }
-    async findElement(next, driver, ...args) {
+    async findElement(next, _driver, ...args) {
         this.log.info(`Before findElement is run with args ${JSON.stringify(args)}`);
         const originalRes = await next();
-        this.log.info(`After findElement is run`);
+        this.log.info('After findElement is run');
         originalRes.fake = true;
         return originalRes;
     }
-    async getFakeSessionData(next, driver) {
-        await bluebird_1.default.delay(1);
-        return driver.fakeSessionData || null;
+    async getFakeSessionData(_next, driver) {
+        await (0, asyncbox_1.sleep)(1);
+        return driver.fakeSessionData ?? null;
     }
-    async setFakeSessionData(next, driver, ...args) {
-        await bluebird_1.default.delay(1);
+    async setFakeSessionData(_next, driver, ...args) {
+        await (0, asyncbox_1.sleep)(1);
         driver.fakeSessionData = args[0];
         return null;
     }
@@ -161,7 +137,7 @@ class FakePlugin extends plugin_1.BasePlugin {
         const handle = await next();
         return `<<${handle}>>`;
     }
-    async onUnexpectedShutdown(driver, cause) {
+    async onUnexpectedShutdown(_driver, cause) {
         this._clockRunning = false;
         FakePlugin._unexpectedData = `Session ended because ${cause}`;
     }
@@ -174,5 +150,4 @@ class FakePlugin extends plugin_1.BasePlugin {
     }
 }
 exports.FakePlugin = FakePlugin;
-exports.default = FakePlugin;
 //# 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,YAAY;;;;;;AAGZ,0CAAyC;AACzC,wDAAyB;AAEzB,MAAM,UAAW,SAAQ,mBAAU;IACjC;;;OAGG;IACH,SAAS,CAAC;IAEV;;OAEG;IACH,WAAW,GAAG,IAAI,CAAC;IAEnB,aAAa,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,YAAY,IAAI,EAAE,OAAO;QACvB,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,mBAAmB,CAAC;QACrC,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED,MAAM,CAAC,YAAY,GAAG,oBAAoB,CAAC,CAAC;QAC1C,+BAA+B,EAAE;YAC/B,GAAG,EAAE,EAAC,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,IAAI,EAAC;YACtD,IAAI,EAAE;gBACJ,OAAO,EAAE,oBAAoB;gBAC7B,aAAa,EAAE,EAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAC;gBACnC,UAAU,EAAE,IAAI;aACjB;SACF;QACD,oCAAoC,EAAE;YACpC,GAAG,EAAE,EAAC,OAAO,EAAE,mBAAmB,EAAE,UAAU,EAAE,IAAI,EAAC;SACtD;KACF,CAAC,CAAC;IAEH,MAAM,CAAC,eAAe,GAAG,oBAAoB,CAAA,CAAC;QAC5C,aAAa,EAAE;YACb,cAAc,EAAE;gBACd,OAAO,EAAE,gBAAgB;aAC1B;YACD,cAAc,EAAE;gBACd,OAAO,EAAE,gBAAgB;gBACzB,MAAM,EAAE;oBACN,QAAQ,EAAE,CAAC,OAAO,CAAC;iBACpB;aACF;YACD,UAAU,EAAE;gBACV,OAAO,EAAE,YAAY;gBACrB,MAAM,EAAE;oBACN,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;iBAC3B;aACF;YACD,WAAW,EAAE;gBACX,OAAO,EAAE,aAAa;gBACtB,MAAM,EAAE;oBACN,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;iBAC3B;aACF;SACF;KACF,CAAC,CAAC;IAEH,sBAAsB;IACtB,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC;IAE9B,MAAM,CAAC,gBAAgB,GAAG,oBAAoB,CAAC,CAAC;QAC9C,yEAAyE;QACzE,gBAAgB,EAAE;YAChB,OAAO,EAAE,cAAc;SACxB;QAED,uCAAuC;QACvC,gBAAgB,EAAE;YAChB,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,EAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAC;SAC/B;KACF,CAAC,CAAC;IAEH,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG;QACvB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAC,IAAI,EAAE,cAAc,EAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG;QAC5B,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC;QACrD,UAAU,CAAC,eAAe,GAAG,IAAI,CAAC;IACpC,CAAC;IAGD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO;QACvD,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC;QAC9C,UAAU,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;QACzD,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACtC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU;QACd,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC;YAC1B,MAAM,kBAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE;gBAClC,MAAM,EAAE,0BAA0B;gBAClC,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,EAAC;aAC3B,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI;QACvC,MAAM,GAAG,GAAG,MAAM,IAAI,EAAE,CAAC,CAAC,sDAAsD;QAChF,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI;QACxC,sCAAsC;QACtC,MAAM,kBAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,OAAO,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,MAAM,kBAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE;YAClC,MAAM,EAAE,kCAAkC;YAC1C,MAAM,EAAE,EAAE;SACX,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK;QACtC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,qBAAqB,CAAC,MAAM;QACvD,MAAM,kBAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,OAAO,iBAAiB,MAAM,EAAE,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,iBAAiB;QACrB,MAAM,kBAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;QACvC,MAAM,kBAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClB,OAAO,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;QACrC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,uCAAuC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7E,MAAM,WAAW,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC1C,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC;QACxB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM;QACnC,MAAM,kBAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,OAAO,MAAM,CAAC,eAAe,IAAI,IAAI,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI;QAC5C,MAAM,kBAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,IAAI;QACxB,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QAC5B,OAAO,KAAK,MAAM,IAAI,CAAC;IACzB,CAAC;IAGD,KAAK,CAAC,oBAAoB,CAAC,MAAM,EAAE,KAAK;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,UAAU,CAAC,eAAe,GAAG,yBAAyB,KAAK,EAAE,CAAC;IAChE,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI;QACtC,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,IAAI;QACtB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,OAAO,MAAM,IAAI,EAAE,CAAC;IACtB,CAAC;;AAGK,gCAAU;AAClB,kBAAe,UAAU,CAAC"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../lib/plugin.ts"],"names":[],"mappings":";;;AAAA,0CAAyC;AACzC,uCAA+B;AAa/B,MAAa,UAAW,SAAQ,mBAAU;IACvB,SAAS,CAAS;IAC3B,WAAW,GAAY,IAAI,CAAC;IAC1B,aAAa,GAAY,IAAI,CAAC;IAChC,MAAM,CAAC,eAAe,GAAkB,IAAI,CAAC;IAErD,MAAM,CAAC,YAAY,GAA0B;QAC3C,+BAA+B,EAAE;YAC/B,GAAG,EAAE,EAAC,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,IAAI,EAAC;YACtD,IAAI,EAAE;gBACJ,OAAO,EAAE,oBAAoB;gBAC7B,aAAa,EAAE,EAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAC;gBACnC,UAAU,EAAE,IAAI;aACjB;SACF;QACD,oCAAoC,EAAE;YACpC,GAAG,EAAE,EAAC,OAAO,EAAE,mBAAmB,EAAE,UAAU,EAAE,IAAI,EAAC;SACtD;KACF,CAAC;IAEF,MAAM,CAAC,eAAe,GAAkB;QACtC,aAAa,EAAE;YACb,cAAc,EAAE;gBACd,OAAO,EAAE,gBAAgB;aAC1B;YACD,cAAc,EAAE;gBACd,OAAO,EAAE,gBAAgB;gBACzB,MAAM,EAAE;oBACN,QAAQ,EAAE,CAAC,OAAO,CAAC;iBACpB;aACF;YACD,UAAU,EAAE;gBACV,OAAO,EAAE,YAAY;gBACrB,MAAM,EAAE;oBACN,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;iBAC3B;aACF;YACD,WAAW,EAAE;gBACX,OAAO,EAAE,aAAa;gBACtB,MAAM,EAAE;oBACN,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;iBAC3B;aACF;SACF;KACF,CAAC;IAEF,MAAM,CAAC,gBAAgB,GAAiC;QACtD,gBAAgB,EAAE;YAChB,OAAO,EAAE,cAAc;SACxB;QACD,gBAAgB,EAAE;YAChB,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,EAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAC;SAC/B;KACF,CAAC;IAEF,YAAY,IAAY,EAAE,UAAmC,EAAE;QAC7D,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,mBAAmB,CAAC;QACrC,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,IAAa,EAAE,GAAa;QAC3C,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAC,IAAI,EAAE,cAAc,EAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,IAAa,EAAE,GAAa;QAChD,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC;QACrD,UAAU,CAAC,eAAe,GAAG,IAAI,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,YAAY,CACvB,UAAuB,EACvB,WAAyB,EACzB,OAAgC;QAEhC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC;QAC9C,UAAU,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,cAAc,CAAC,CAAC;QACzD,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACtC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU;QACd,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC;YAC1B,MAAM,IAAA,gBAAK,EAAC,GAAG,CAAC,CAAC;YACjB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE;gBAClC,MAAM,EAAE,0BAA0B;gBAClC,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,EAAC;aAC3B,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CACd,IAA2B,EAC3B,OAAmB,EACnB,IAAY,EACZ,IAAY;QAEZ,MAAM,GAAG,GAAG,MAAM,IAAI,EAAE,CAAC;QACzB,OAAO,IAAI,GAAG,IAAI,GAAG,GAAG,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,WAAW,CACf,KAA6B,EAC7B,OAAmB,EACnB,IAAY,EACZ,IAAY;QAEZ,MAAM,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC;QACf,OAAO,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,MAAM,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC;QACf,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE;YAClC,MAAM,EAAE,kCAAkC;YAC1C,MAAM,EAAE,EAAE;SACX,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,KAA6B,EAC7B,OAAmB,EACnB,KAAc;QAEd,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,KAA6B,EAC7B,OAAmB,EACnB,MAAc;QAEd,MAAM,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC;QACf,OAAO,iBAAiB,MAAM,EAAE,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,iBAAiB;QACrB,MAAM,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,KAA4B,EAC5B,OAAmB,EACnB,GAAG,IAAe;QAElB,MAAM,IAAA,gBAAK,EAAC,EAAE,CAAC,CAAC;QAChB,OAAO,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,WAAW,CACf,IAA+D,EAC/D,OAAmB,EACnB,GAAG,IAAe;QAElB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,uCAAuC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7E,MAAM,WAAW,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC1C,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC;QACxB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,KAA6B,EAAE,MAAkB;QACxE,MAAM,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC;QACf,OAAO,MAAM,CAAC,eAAe,IAAI,IAAI,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,KAA6B,EAC7B,MAAkB,EAClB,GAAG,IAAe;QAElB,MAAM,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC;QACf,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,IAA2B;QAC/C,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QAC5B,OAAO,KAAK,MAAM,IAAI,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,OAAmB,EAAE,KAAqB;QACnE,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,UAAU,CAAC,eAAe,GAAG,yBAAyB,KAAK,EAAE,CAAC;IAChE,CAAC;IAED,KAAK,CAAC,OAAO,CACX,IAA4B,EAC5B,MAAkB,EAClB,MAAc,EACd,IAAe;QAEf,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,MAAa,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,IAA4B;QAC9C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,OAAO,MAAM,IAAI,EAAE,CAAC;IACtB,CAAC;;AA9MH,gCA+MC"}

package/build/lib/scripts/fake-error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fake-error.d.ts","sourceRoot":"","sources":["../../../lib/scripts/fake-error.js"],"names":[],"mappings":""}
+{"version":3,"file":"fake-error.d.ts","sourceRoot":"","sources":["../../../lib/scripts/fake-error.ts"],"names":[],"mappings":""}

package/build/lib/scripts/fake-error.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-throw Error('Unsuccessfully ran the script');
+throw new Error('Unsuccessfully ran the script');
 //# sourceMappingURL=fake-error.js.map

package/build/lib/scripts/fake-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"fake-error.js","sourceRoot":"","sources":["../../../lib/scripts/fake-error.js"],"names":[],"mappings":";;AAAA,MAAM,KAAK,CAAC,+BAA+B,CAAC,CAAC"}
+{"version":3,"file":"fake-error.js","sourceRoot":"","sources":["../../../lib/scripts/fake-error.ts"],"names":[],"mappings":";;AAAA,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC"}

package/build/lib/scripts/fake-success.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fake-success.d.ts","sourceRoot":"","sources":["../../../lib/scripts/fake-success.js"],"names":[],"mappings":""}
+{"version":3,"file":"fake-success.d.ts","sourceRoot":"","sources":["../../../lib/scripts/fake-success.ts"],"names":[],"mappings":""}

package/build/lib/scripts/fake-success.js

@@ -1,8 +1,5 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const logger_1 = __importDefault(require("../logger"));
-logger_1.default.info('Successfully ran the script');
+// eslint-disable-next-line no-console -- script output
+console.info('Successfully ran the script');
 //# sourceMappingURL=fake-success.js.map

package/build/lib/scripts/fake-success.js.map

@@ -1 +1 @@
-{"version":3,"file":"fake-success.js","sourceRoot":"","sources":["../../../lib/scripts/fake-success.js"],"names":[],"mappings":";;;;;AAAA,uDAA4B;AAE5B,gBAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC"}
+{"version":3,"file":"fake-success.js","sourceRoot":"","sources":["../../../lib/scripts/fake-success.ts"],"names":[],"mappings":";;AAAA,uDAAuD;AACvD,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC"}

package/lib/index.ts

@@ -0,0 +1,6 @@
+export {FakePlugin} 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,222 @@
+import {BasePlugin} from 'appium/plugin';
+import {sleep} from 'asyncbox';
+import type {Request, Response, Application} from 'express';
+import type {
+  AppiumServer,
+  BidiModuleMap,
+  ExecuteMethodMap,
+  ExternalDriver,
+  MethodMap,
+} from '@appium/types';
+
+/** Driver as seen by this plugin; may include plugin-specific session data */
+export type DriverLike = ExternalDriver & {fakeSessionData?: unknown};
+
+export class FakePlugin extends BasePlugin {
+  private readonly fakeThing: string;
+  private pluginThing: unknown = null;
+  protected _clockRunning: boolean = true;
+  private static _unexpectedData: string | null = null;
+
+  static newMethodMap: MethodMap<FakePlugin> = {
+    '/session/:sessionId/fake_data': {
+      GET: {command: 'getFakeSessionData', neverProxy: true},
+      POST: {
+        command: 'setFakeSessionData',
+        payloadParams: {required: ['data']},
+        neverProxy: true,
+      },
+    },
+    '/session/:sessionId/fakepluginargs': {
+      GET: {command: 'getFakePluginArgs', neverProxy: true},
+    },
+  };
+
+  static newBidiCommands: BidiModuleMap = {
+    'appium:fake': {
+      getPluginThing: {
+        command: 'getPluginThing',
+      },
+      setPluginThing: {
+        command: 'setPluginThing',
+        params: {
+          required: ['thing'],
+        },
+      },
+      doSomeMath: {
+        command: 'doSomeMath',
+        params: {
+          required: ['num1', 'num2'],
+        },
+      },
+      doSomeMath2: {
+        command: 'doSomeMath2',
+        params: {
+          required: ['num1', 'num2'],
+        },
+      },
+    },
+  };
+
+  static executeMethodMap: ExecuteMethodMap<FakePlugin> = {
+    'fake: getThing': {
+      command: 'getFakeThing',
+    },
+    'fake: plugMeIn': {
+      command: 'plugMeIn',
+      params: {required: ['socket']},
+    },
+  };
+
+  constructor(name: string, cliArgs: Record<string, unknown> = {}) {
+    super(name, cliArgs);
+    this.fakeThing = 'PLUGIN_FAKE_THING';
+    this.startClock();
+  }
+
+  static fakeRoute(_req: Request, res: Response): void {
+    res.send(JSON.stringify({fake: 'fakeResponse'}));
+  }
+
+  static unexpectedData(_req: Request, res: Response): void {
+    res.send(JSON.stringify(FakePlugin._unexpectedData));
+    FakePlugin._unexpectedData = null;
+  }
+
+  static async updateServer(
+    expressApp: Application,
+    _httpServer: AppiumServer,
+    cliArgs: Record<string, unknown>
+  ): Promise<void> {
+    expressApp.all('/fake', FakePlugin.fakeRoute);
+    expressApp.all('/unexpected', FakePlugin.unexpectedData);
+    expressApp.all('/cliArgs', (req, res) => {
+      res.send(JSON.stringify(cliArgs));
+    });
+  }
+
+  async startClock(): Promise<void> {
+    while (this._clockRunning) {
+      await sleep(250);
+      this.eventEmitter.emit('bidiEvent', {
+        method: 'appium:clock.currentTime',
+        params: {time: Date.now()},
+      });
+    }
+  }
+
+  async doSomeMath(
+    next: () => Promise<number>,
+    _driver: DriverLike,
+    num1: number,
+    num2: number
+  ): Promise<number> {
+    const sum = await next();
+    return num1 * num2 + sum;
+  }
+
+  async doSomeMath2(
+    _next: () => Promise<unknown>,
+    _driver: DriverLike,
+    num1: number,
+    num2: number
+  ): Promise<number> {
+    await sleep(1);
+    return num1 * num2;
+  }
+
+  async getFakeThing(): Promise<string> {
+    await sleep(1);
+    return this.fakeThing;
+  }
+
+  async getPluginThing(): Promise<unknown> {
+    this.eventEmitter.emit('bidiEvent', {
+      method: 'appium:fake.pluginThingRetrieved',
+      params: {},
+    });
+    return this.pluginThing;
+  }
+
+  async setPluginThing(
+    _next: () => Promise<unknown>,
+    _driver: DriverLike,
+    thing: unknown
+  ): Promise<void> {
+    this.pluginThing = thing;
+  }
+
+  async plugMeIn(
+    _next: () => Promise<unknown>,
+    _driver: DriverLike,
+    socket: string
+  ): Promise<string> {
+    await sleep(1);
+    return `Plugged in to ${socket}`;
+  }
+
+  async getFakePluginArgs(): Promise<Record<string, unknown>> {
+    await sleep(1);
+    return this.cliArgs;
+  }
+
+  async getPageSource(
+    _next: () => Promise<string>,
+    _driver: DriverLike,
+    ...args: unknown[]
+  ): Promise<string> {
+    await sleep(10);
+    return `<Fake>${JSON.stringify(args)}</Fake>`;
+  }
+
+  async findElement(
+    next: () => Promise<{fake?: boolean} & Record<string, unknown>>,
+    _driver: DriverLike,
+    ...args: unknown[]
+  ): Promise<{fake?: boolean} & Record<string, unknown>> {
+    this.log.info(`Before findElement is run with args ${JSON.stringify(args)}`);
+    const originalRes = await next();
+    this.log.info('After findElement is run');
+    originalRes.fake = true;
+    return originalRes;
+  }
+
+  async getFakeSessionData(_next: () => Promise<unknown>, driver: DriverLike): Promise<unknown> {
+    await sleep(1);
+    return driver.fakeSessionData ?? null;
+  }
+
+  async setFakeSessionData(
+    _next: () => Promise<unknown>,
+    driver: DriverLike,
+    ...args: unknown[]
+  ): Promise<null> {
+    await sleep(1);
+    driver.fakeSessionData = args[0];
+    return null;
+  }
+
+  async getWindowHandle(next: () => Promise<string>): Promise<string> {
+    const handle = await next();
+    return `<<${handle}>>`;
+  }
+
+  async onUnexpectedShutdown(_driver: DriverLike, cause: Error | string): Promise<void> {
+    this._clockRunning = false;
+    FakePlugin._unexpectedData = `Session ended because ${cause}`;
+  }
+
+  async execute(
+    next: () => Promise<unknown>,
+    driver: DriverLike,
+    script: string,
+    args: unknown[]
+  ): Promise<unknown> {
+    return await this.executeMethod(next, driver as any, script, args);
+  }
+
+  async deleteSession(next: () => Promise<unknown>): Promise<unknown> {
+    this._clockRunning = false;
+    return await next();
+  }
+}

package/lib/scripts/fake-error.ts

@@ -0,0 +1 @@
+throw new Error('Unsuccessfully ran the script');

package/lib/scripts/fake-success.ts

@@ -0,0 +1,2 @@
+// eslint-disable-next-line no-console -- script output
+console.info('Successfully ran the script');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/fake-plugin",
-  "version": "4.0.6",
+  "version": "4.1.0",
   "description": "A fake Appium plugin",
   "keywords": [
     "automation",
@@ -23,28 +23,31 @@
   },
   "license": "Apache-2.0",
   "author": "https://github.com/appium",
+  "main": "./build/lib/index.js",
+  "types": "./build/lib/index.d.ts",
   "directories": {
     "lib": "./lib"
   },
   "files": [
-    "index.js",
+    "build/lib",
     "lib",
-    "build",
-    "tsconfig.json",
-    "!build/tsconfig.tsbuildinfo",
-    "!build/test"
+    "tsconfig.json"
   ],
   "scripts": {
     "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-plugin": "^3.0.6",
-    "@appium/support": "^7.0.5",
-    "bluebird": "3.7.2",
+    "@appium/base-plugin": "^3.1.0",
+    "@appium/support": "^7.0.6",
+    "asyncbox": "6.1.0",
     "lodash": "4.17.23"
   },
+  "devDependencies": {
+    "@appium/types": "^1.2.1",
+    "express": "5.2.1"
+  },
   "peerDependencies": {
     "appium": "^3.0.0-beta.0"
   },
@@ -63,7 +66,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f7b20335eab4022e5cbbb627ec86866a994444f8",
+  "gitHead": "980a121804ae006db879fb6860f627ac36174c15",
   "tags": [
     "appium"
   ]

package/tsconfig.json

@@ -1,13 +1,11 @@
 {
   "compilerOptions": {
     "outDir": "build",
-    "checkJs": true
+    "types": ["mocha", "chai", "chai-as-promised"]
   },
   "extends": "@appium/tsconfig/tsconfig.plugin.json",
-  "include": ["lib"],
+  "include": ["lib", "test"],
   "references": [
-    {
-      "path": "../base-plugin"
-    }
+    {"path": "../base-plugin"}
   ]
 }

package/build/lib/logger.d.ts

@@ -1,3 +0,0 @@
-export default log;
-declare const log: import("@appium/types").AppiumLogger;
-//# sourceMappingURL=logger.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../lib/logger.js"],"names":[],"mappings":";AAEA,wDAA2C"}

package/build/lib/logger.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const support_1 = require("appium/support");
-const log = support_1.logger.getLogger('FakePlugin');
-exports.default = log;
-//# sourceMappingURL=logger.js.map

package/build/lib/logger.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../lib/logger.js"],"names":[],"mappings":";;AAAA,4CAAsC;AAEtC,MAAM,GAAG,GAAG,gBAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;AAE3C,kBAAe,GAAG,CAAC"}

package/index.js

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

package/lib/logger.js

@@ -1,5 +0,0 @@
-import {logger} from 'appium/support';
-
-const log = logger.getLogger('FakePlugin');
-
-export default log;

package/lib/plugin.js

@@ -1,204 +0,0 @@
-// @ts-check
-
-
-import {BasePlugin} from 'appium/plugin';
-import B from 'bluebird';
-
-class FakePlugin extends BasePlugin {
-  /**
-   * @type {string}
-   * @readonly
-   */
-  fakeThing;
-
-  /**
-   * @type {any}
-   */
-  pluginThing = null;
-
-  _clockRunning = true;
-
-  /**
-   * @param {string} name
-   * @param {Record<string,unknown>} cliArgs
-   */
-  constructor(name, cliArgs) {
-    super(name, cliArgs);
-    this.fakeThing = 'PLUGIN_FAKE_THING';
-    this.startClock();
-  }
-
-  static newMethodMap = /** @type {const} */ ({
-    '/session/:sessionId/fake_data': {
-      GET: {command: 'getFakeSessionData', neverProxy: true},
-      POST: {
-        command: 'setFakeSessionData',
-        payloadParams: {required: ['data']},
-        neverProxy: true,
-      },
-    },
-    '/session/:sessionId/fakepluginargs': {
-      GET: {command: 'getFakePluginArgs', neverProxy: true},
-    },
-  });
-
-  static newBidiCommands = /** @type {const} */({
-    'appium:fake': {
-      getPluginThing: {
-        command: 'getPluginThing',
-      },
-      setPluginThing: {
-        command: 'setPluginThing',
-        params: {
-          required: ['thing'],
-        },
-      },
-      doSomeMath: {
-        command: 'doSomeMath',
-        params: {
-          required: ['num1', 'num2'],
-        },
-      },
-      doSomeMath2: {
-        command: 'doSomeMath2',
-        params: {
-          required: ['num1', 'num2'],
-        },
-      },
-    }
-  });
-
-  /** @type {string?} */
-  static _unexpectedData = null;
-
-  static executeMethodMap = /** @type {const} */ ({
-    // this execute method overrides fake-drivers fake: getThing, for testing
-    'fake: getThing': {
-      command: 'getFakeThing',
-    },
-
-    // this is a totally new execute method
-    'fake: plugMeIn': {
-      command: 'plugMeIn',
-      params: {required: ['socket']},
-    },
-  });
-
-  static fakeRoute(req, res) {
-    res.send(JSON.stringify({fake: 'fakeResponse'}));
-  }
-
-  static unexpectedData(req, res) {
-    res.send(JSON.stringify(FakePlugin._unexpectedData));
-    FakePlugin._unexpectedData = null;
-  }
-
-
-  static async updateServer(expressApp, httpServer, cliArgs) {
-    expressApp.all('/fake', FakePlugin.fakeRoute);
-    expressApp.all('/unexpected', FakePlugin.unexpectedData);
-    expressApp.all('/cliArgs', (req, res) => {
-      res.send(JSON.stringify(cliArgs));
-    });
-  }
-
-  async startClock() {
-    while (this._clockRunning) {
-      await B.delay(250);
-      this.eventEmitter.emit('bidiEvent', {
-        method: 'appium:clock.currentTime',
-        params: {time: Date.now()},
-      });
-    }
-  }
-
-  async doSomeMath(next, driver, num1, num2) {
-    const sum = await next(); // call driver's 'doSomeMath' which sums num1 and num2
-    return (num1 * num2) + sum;
-  }
-
-  async doSomeMath2(next, driver, num1, num2) {
-    // ignore next & driver in this method
-    await B.delay(1);
-    return num1 * num2;
-  }
-
-  async getFakeThing() {
-    await B.delay(1);
-    return this.fakeThing;
-  }
-
-  async getPluginThing() {
-    this.eventEmitter.emit('bidiEvent', {
-      method: 'appium:fake.pluginThingRetrieved',
-      params: {},
-    });
-    return this.pluginThing;
-  }
-
-  /**
-   * @param {() => Promise<any>} next
-   * @param {import('@appium/types').Driver} driver
-   * @param {any} thing
-   */
-  async setPluginThing(next, driver, thing) {
-    this.pluginThing = thing;
-  }
-
-  async plugMeIn(next, driver, /** @type {string} */ socket) {
-    await B.delay(1);
-    return `Plugged in to ${socket}`;
-  }
-
-  async getFakePluginArgs() {
-    await B.delay(1);
-    return this.cliArgs;
-  }
-
-  async getPageSource(next, driver, ...args) {
-    await B.delay(10);
-    return `<Fake>${JSON.stringify(args)}</Fake>`;
-  }
-
-  async findElement(next, driver, ...args) {
-    this.log.info(`Before findElement is run with args ${JSON.stringify(args)}`);
-    const originalRes = await next();
-    this.log.info(`After findElement is run`);
-    originalRes.fake = true;
-    return originalRes;
-  }
-
-  async getFakeSessionData(next, driver) {
-    await B.delay(1);
-    return driver.fakeSessionData || null;
-  }
-
-  async setFakeSessionData(next, driver, ...args) {
-    await B.delay(1);
-    driver.fakeSessionData = args[0];
-    return null;
-  }
-
-  async getWindowHandle(next) {
-    const handle = await next();
-    return `<<${handle}>>`;
-  }
-
-
-  async onUnexpectedShutdown(driver, cause) {
-    this._clockRunning = false;
-    FakePlugin._unexpectedData = `Session ended because ${cause}`;
-  }
-
-  async execute(next, driver, script, args) {
-    return await this.executeMethod(next, driver, script, args);
-  }
-
-  async deleteSession(next) {
-    this._clockRunning = false;
-    return await next();
-  }
-}
-
-export {FakePlugin};
-export default FakePlugin;

package/lib/scripts/fake-error.js

@@ -1 +0,0 @@
-throw Error('Unsuccessfully ran the script');

package/lib/scripts/fake-success.js

@@ -1,3 +0,0 @@
-import log from '../logger';
-
-log.info('Successfully ran the script');