appium 2.0.0-beta.56 → 2.0.0-beta.58

package/build/lib/cli/driver-command.js.map

@@ -1 +1 @@
-{"version":3,"file":"driver-command.js","sourceRoot":"","sources":["../../../lib/cli/driver-command.js"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AACvB,4EAAmD;AACnD,4CAA2C;AAC3C,0BAAwB;AAExB,MAAM,iBAAiB,GAAG,CAAC,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,WAAW,CAAC,CAAC;AAEzF;;GAEG;AAEH,MAAqB,aAAc,SAAQ,2BAAgB;IACzD;;OAEG;IACH,YAAY,EAAC,MAAM,EAAE,IAAI,EAAC;QACxB,KAAK,CAAC,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,yBAAa,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,EAAC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAC;QAC9C,OAAO,MAAM,KAAK,CAAC,QAAQ,CAAC;YAC1B,WAAW,EAAE,MAAM;YACnB,WAAW;YACX,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,EAAC,MAAM,EAAC;QACtB,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,EAAC,WAAW,EAAE,MAAM,EAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,EAAC,MAAM,EAAE,MAAM,EAAC;QAC3B,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,EAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,EAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAC;QACvC,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,EAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,EAAC,OAAO,EAAE,OAAO,EAAC;QACnC,OAAO,CACL,UAAU,OAAO,IAAI,OAAO,CAAC,OAAO,2BAA2B,CAAC,KAAK;YACrE,qBAAqB,OAAO,CAAC,cAAc,CAAC,KAAK,IAAI;YACrD,oBAAoB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,CAClE,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,uBAAuB,CAAC,cAAc,EAAE,WAAW;QACjD,MAAM,aAAa,GAAG,iBAAiB,CAAC,MAAM,CAC5C,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC,EAC/D,EAAE,CACH,CAAC;QAEF,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CACb,WAAW,WAAW,kDAAkD;gBACtE,gCAAgC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAClE,CAAC;SACH;IACH,CAAC;CACF;AAvFD,gCAuFC;AAED;;;GAGG;AAEH;;;GAGG;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AAEH;;GAEG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG"}
+{"version":3,"file":"driver-command.js","sourceRoot":"","sources":["../../../lib/cli/driver-command.js"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AACvB,4EAAsD;AACtD,4CAA2C;AAC3C,0BAAwB;AAExB,MAAM,iBAAiB,GAAG,CAAC,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,WAAW,CAAC,CAAC;AAEzF;;GAEG;AAEH,MAAqB,gBAAiB,SAAQ,2BAAmB;IAC/D;;OAEG;IACH,YAAY,EAAC,MAAM,EAAE,IAAI,EAAC;QACxB,KAAK,CAAC,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,yBAAa,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,EAAC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAC;QAC9C,OAAO,MAAM,KAAK,CAAC,QAAQ,CAAC;YAC1B,WAAW,EAAE,MAAM;YACnB,WAAW;YACX,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,EAAC,MAAM,EAAC;QACtB,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,EAAC,WAAW,EAAE,MAAM,EAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,EAAC,MAAM,EAAE,MAAM,EAAC;QAC3B,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,EAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,EAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAC;QACvC,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC;YACtB,WAAW,EAAE,MAAM;YACnB,UAAU;YACV,SAAS;YACT,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,EAAC,OAAO,EAAE,OAAO,EAAC;QACnC,OAAO,CACL,UAAU,OAAO,IAAI,OAAO,CAAC,OAAO,2BAA2B,CAAC,KAAK;YACrE,qBAAqB,OAAO,CAAC,cAAc,CAAC,KAAK,IAAI;YACrD,oBAAoB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,CAClE,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,uBAAuB,CAAC,cAAc,EAAE,WAAW;QACjD,MAAM,aAAa,GAAG,iBAAiB,CAAC,MAAM,CAC5C,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC,EAC/D,EAAE,CACH,CAAC;QAEF,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CACb,WAAW,WAAW,kDAAkD;gBACtE,gCAAgC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAClE,CAAC;SACH;IACH,CAAC;CACF;AA5FD,mCA4FC;AAED;;;GAGG;AAEH;;;GAGG;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AAEH;;GAEG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG"}

package/build/lib/cli/extension-command.d.ts

@@ -1,6 +1,7 @@
-export default ExtensionCommand;
+export default ExtensionCliCommand;
+export { ExtensionCliCommand as ExtensionCommand };
 /**
- * Options for the {@linkcode ExtensionCommand } constructor
+ * Options for the {@linkcode ExtensionCliCommand } constructor
  */
 export type ExtensionCommandOptions<ExtType extends import("@appium/types").ExtensionType> = {
     /**
@@ -13,13 +14,17 @@ export type ExtensionCommandOptions<ExtType extends import("@appium/types").Exte
     json: boolean;
 };
 /**
- * Extra stuff about extensions; used indirectly by {@linkcode ExtensionCommand.list }.
+ * Extra stuff about extensions; used indirectly by {@linkcode ExtensionCliCommand.list }.
  */
-export type ExtensionMetadata = {
+export type ExtensionListMetadata = {
     /**
      * - If `true`, the extension is installed
      */
     installed: boolean;
+    /**
+     * - If the extension is installed and the latest
+     */
+    upToDate: boolean;
     /**
      * - If the extension is installed, the version it can be updated to
      */
@@ -29,13 +34,13 @@ export type ExtensionMetadata = {
      */
     unsafeUpdateVersion: string | null;
     /**
-     * - If the extension is installed and the latest
+     * - Update check error message (if present)
      */
-    upToDate: boolean;
+    updateError?: string | undefined;
     /**
-     * - Update check error message (if present)
+     * - If Appium is run from an extension's working copy
      */
-    updateError: string | null;
+    devMode?: boolean | undefined;
 };
 export type ExtensionType = import('@appium/types').ExtensionType;
 export type DriverType = import('@appium/types').DriverType;
@@ -47,22 +52,16 @@ export type ExtManifest<ExtType extends import("@appium/types").ExtensionType> =
 export type ExtPackageJson<ExtType extends import("@appium/types").ExtensionType> = import('appium/types').ExtPackageJson<ExtType>;
 export type ExtInstallReceipt<ExtType extends import("@appium/types").ExtensionType> = import('appium/types').ExtInstallReceipt<ExtType>;
 /**
- * Possible return value for {@linkcode ExtensionCommand.list }
- */
-export type UninstalledExtensionListData = Partial<InstalledExtensionListData> & {
-    pkgName: string;
-    installed: false;
-};
-/**
- * Possible return value for {@linkcode ExtensionCommand.list }
+ * Possible return value for {@linkcode ExtensionCliCommand.list }
  */
-export type InstalledExtensionListData = import('appium/types').InternalMetadata & ExtensionMetadata;
+export type ExtensionListData<ExtType extends import("@appium/types").ExtensionType> = Partial<ExtManifest<ExtType>> & Partial<ExtensionListMetadata>;
+export type InstalledExtensionListData<ExtType extends import("@appium/types").ExtensionType> = ExtManifest<ExtType> & ExtensionListMetadata;
 /**
- * Return value of {@linkcode ExtensionCommand.list }.
+ * Return value of {@linkcode ExtensionCliCommand.list }.
  */
-export type ExtensionListData = Record<string, InstalledExtensionListData | UninstalledExtensionListData>;
+export type ExtensionList<ExtType extends import("@appium/types").ExtensionType> = Record<string, ExtensionListData<ExtType>>;
 /**
- * Options for {@linkcode ExtensionCommand._run }.
+ * Options for {@linkcode ExtensionCliCommand._run }.
  */
 export type RunOptions = {
     /**
@@ -77,9 +76,13 @@ export type RunOptions = {
      * - arguments to pass to the script
      */
     extraArgs?: string[] | undefined;
+    /**
+     * - if true, will buffer the output of the script and return it
+     */
+    bufferOutput?: boolean | undefined;
 };
 /**
- * Return value of {@linkcode ExtensionCommand._run }
+ * Return value of {@linkcode ExtensionCliCommand._run }
  */
 export type RunOutput = {
     /**
@@ -87,12 +90,12 @@ export type RunOutput = {
      */
     error?: string | undefined;
     /**
-     * - script output
+     * - script output if `bufferOutput` was `true` in {@linkcode RunOptions }
      */
-    output: string[];
+    output?: string[] | undefined;
 };
 /**
- * Options for {@linkcode ExtensionCommand._update }.
+ * Options for {@linkcode ExtensionCliCommand._update }.
  */
 export type ExtensionUpdateOpts = {
     /**
@@ -105,7 +108,7 @@ export type ExtensionUpdateOpts = {
     unsafe: boolean;
 };
 /**
- * Return value of {@linkcode ExtensionCommand._update }.
+ * Return value of {@linkcode ExtensionCliCommand._update }.
  */
 export type ExtensionUpdateResult = {
     /**
@@ -118,7 +121,7 @@ export type ExtensionUpdateResult = {
     updates: Record<string, UpdateReport>;
 };
 /**
- * Part of result of {@linkcode ExtensionCommand._update }.
+ * Part of result of {@linkcode ExtensionCliCommand._update }.
  */
 export type UpdateReport = {
     /**
@@ -131,7 +134,7 @@ export type UpdateReport = {
     to: string;
 };
 /**
- * Options for {@linkcode ExtensionCommand._uninstall }.
+ * Options for {@linkcode ExtensionCliCommand._uninstall }.
  */
 export type UninstallOpts = {
     /**
@@ -140,7 +143,7 @@ export type UninstallOpts = {
     installSpec: string;
 };
 /**
- * Used by {@linkcode ExtensionCommand.getPostInstallText }
+ * Used by {@linkcode ExtensionCliCommand.getPostInstallText }
  */
 export type ExtensionArgs = {
     /**
@@ -153,7 +156,7 @@ export type ExtensionArgs = {
     extData: object;
 };
 /**
- * Options for {@linkcode ExtensionCommand.installViaNpm }
+ * Options for {@linkcode ExtensionCliCommand.installViaNpm }
  */
 export type InstallViaNpmArgs = {
     /**
@@ -174,7 +177,7 @@ export type InstallViaNpmArgs = {
     pkgVer?: string | undefined;
 };
 /**
- * Object returned by {@linkcode ExtensionCommand.checkForExtensionUpdate }
+ * Object returned by {@linkcode ExtensionCliCommand.checkForExtensionUpdate }
  */
 export type PossibleUpdates = {
     /**
@@ -191,7 +194,7 @@ export type PossibleUpdates = {
     unsafeUpdate: string | null;
 };
 /**
- * Options for {@linkcode ExtensionCommand._install }
+ * Options for {@linkcode ExtensionCliCommand._install }
  */
 export type InstallOpts = {
     /**
@@ -217,9 +220,13 @@ export type ListOptions = {
      * - whether should show available updates
      */
     showUpdates: boolean;
+    /**
+     * - whether to show additional data from the extension
+     */
+    verbose?: boolean | undefined;
 };
 /**
- * Opts for {@linkcode ExtensionCommand.getInstallationReceipt }
+ * Opts for {@linkcode ExtensionCliCommand.getInstallationReceipt }
  */
 export type GetInstallationReceiptOpts<ExtType extends import("@appium/types").ExtensionType> = {
     installPath: string;
@@ -231,7 +238,7 @@ export type InstallType = import('appium/types').InstallType;
 /**
  * @template {ExtensionType} ExtType
  */
-export class ExtensionCommand<ExtType extends import("@appium/types").ExtensionType> {
+declare class ExtensionCliCommand<ExtType extends import("@appium/types").ExtensionType> {
     /**
      * Build an ExtensionCommand
      * @param {ExtensionCommandOptions<ExtType>} opts
@@ -277,11 +284,11 @@ export class ExtensionCommand<ExtType extends import("@appium/types").ExtensionT
     execute(args: object): Promise<object>;
     /**
      * List extensions
-     *
+     * @template {ExtensionType} ExtType
      * @param {ListOptions} opts
-     * @return {Promise<ExtensionListData>} map of extension names to extension data
+     * @return {Promise<ExtensionList<ExtType>>} map of extension names to extension data
      */
-    list({ showInstalled, showUpdates }: ListOptions): Promise<ExtensionListData>;
+    list<ExtType_1 extends import("@appium/types").ExtensionType>({ showInstalled, showUpdates, verbose }: ListOptions): Promise<ExtensionList<ExtType_1>>;
     /**
      * Install an extension
      *
@@ -369,17 +376,27 @@ export class ExtensionCommand<ExtType extends import("@appium/types").ExtensionT
      */
     updateExtension(installSpec: string, version: string): Promise<void>;
     /**
-     * Runs a script cached inside the "scripts" field under "appium"
-     * inside of the driver/plugins "package.json" file. Will throw
-     * an error if the driver/plugin does not contain a "scripts" field
-     * underneath the "appium" field in its package.json, if the
-     * "scripts" field is not a plain object, or if the scriptName is
-     * not found within "scripts" object.
+     * Just wraps {@linkcode child_process.spawn} with some default options
+     *
+     * @param {string} cwd - CWD
+     * @param {string} script - Path to script
+     * @param {string[]} args - Extra args for script
+     * @param {import('child_process').SpawnOptions} opts - Options
+     * @returns {import('node:child_process').ChildProcess}
+     */
+    _runUnbuffered(cwd: string, script: string, args?: string[], opts?: import('child_process').SpawnOptions): import('node:child_process').ChildProcess;
+    /**
+     * Runs a script cached inside the `scripts` field under `appium`
+     * inside of the extension's `package.json` file. Will throw
+     * an error if the driver/plugin does not contain a `scripts` field
+     * underneath the `appium` field in its `package.json`, if the
+     * `scripts` field is not a plain object, or if the `scriptName` is
+     * not found within `scripts` object.
      *
      * @param {RunOptions} opts
      * @return {Promise<RunOutput>}
      */
-    _run({ installSpec, scriptName, extraArgs }: RunOptions): Promise<RunOutput>;
+    _run({ installSpec, scriptName, extraArgs, bufferOutput }: RunOptions): Promise<RunOutput>;
 }
 import { console } from "@appium/support";
 //# sourceMappingURL=extension-command.d.ts.map

package/build/lib/cli/extension-command.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"extension-command.d.ts","sourceRoot":"","sources":["../../../lib/cli/extension-command.js"],"names":[],"mappings":";;;;;;;;YA4tBc,gBAAgB,OAAO,CAAC;;;;UACxB,OAAO;;;;;;;;;eAOP,OAAO;;;;mBACP,MAAM;;;;yBACN,MAAM;;;;cACN,OAAO;;;;iBACP,MAAM;;4BAIP,OAAO,eAAe,EAAE,aAAa;yBACrC,OAAO,eAAe,EAAE,UAAU;yBAClC,OAAO,eAAe,EAAE,UAAU;+EAKlC,OAAO,cAAc,EAAE,SAAS,CAAC,OAAO,CAAC;qFAKzC,OAAO,+BAA+B,EAAE,eAAe,CAAC,OAAO,CAAC;iFAKhE,OAAO,cAAc,EAAE,WAAW,CAAC,OAAO,CAAC;iFAK3C,OAAO,cAAc,EAAE,WAAW,CAAC,OAAO,CAAC;oFAK3C,OAAO,cAAc,EAAE,cAAc,CAAC,OAAO,CAAC;uFAK9C,OAAO,cAAc,EAAE,iBAAiB,CAAC,OAAO,CAAC;;;;2CAKjD,QAAQ,0BAA0B,CAAC,GAAG;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,KAAK,CAAA;CAAC;;;;yCAKzE,OAAO,cAAc,EAAE,gBAAgB,GAAG,iBAAiB;;;;gCAK3D,OAAO,MAAM,EAAC,0BAA0B,GAAC,4BAA4B,CAAC;;;;;;;;iBAMrE,MAAM;;;;gBACN,MAAM;;;;;;;;;;;;;;;;;YASN,MAAM,EAAE;;;;;;;;;iBAMR,MAAM;;;;YACN,OAAO;;;;;;;;;YAMP,OAAO,MAAM,EAAC,KAAK,CAAC;;;;aACpB,OAAO,MAAM,EAAC,YAAY,CAAC;;;;;;;;;UAM3B,MAAM;;;;QACN,MAAM;;;;;;;;;iBAMN,MAAM;;;;;;;;;aAMN,MAAM;;;;aACN,MAAM;;;;;;;;;iBAMN,MAAM;;;;aACN,MAAM;;;;iBACN,OAAO,cAAc,EAAE,WAAW;;;;;;;;;;;;;aAOlC,MAAM;;;;gBACN,MAAM;;;;kBACN,MAAM;;;;;;;;;iBAMN,MAAM;;;;iBACN,WAAW;;;;;;qFAMZ,OAAO,SAAS,UAAU,GAAG,cAAc,cAAc,EAAE,aAAa,GAAG,OAAO,SAAS,UAAU,GAAG,cAAc,cAAc,EAAE,aAAa,GAAG,KAAK;;;;;mBAK1J,OAAO;;;;iBACP,OAAO;;;;;;iBAOP,MAAM;iBACN,MAAM;SACN,eAAe,OAAO,CAAC;iBACvB,WAAW;;0BAIZ,OAAO,cAAc,EAAE,WAAW;AAj2B/C;;GAEG;AACH;IAmBE;;;OAGG;IACH,8BAFW,wBAAwB,OAAO,CAAC,EAM1C;IA1BD;;;OAGG;IACH,QAFU,gBAAgB,OAAO,CAAC,CAE3B;IAEP;;;OAGG;IACH,iBAFU,gBAAgB,OAAO,CAAC,CAElB;IAEhB;;;OAGG;IACH,cAFU,OAAO,CAEJ;IAQX,wBAAmD;IAIrD;;OAEG;IACH,oBAEC;IAED;;;;;;;;;OASG;IACH,qCAJW,MAAM,SAMhB;IAED;;;;;OAKG;IACH,cAHW,MAAM,GACL,QAAQ,MAAM,CAAC,CAS1B;IAED;;;;;OAKG;IACH,qCAHW,WAAW,GACV,QAAQ,iBAAiB,CAAC,CA2GrC;IAED;;;;;OAKG;IACH,oDAHW,WAAW,GACV,QAAQ,UAAU,OAAO,CAAC,CAAC,CA6JtC;IAED;;;;;OAKG;IACH,6DAHW,iBAAiB,GACf,QAAQ,kBAAkB,OAAO,CAAC,CAAC,CAyB/C;IAED;;;;;;OAMG;IAEH,yBAJW,aAAa,GACX,MAAM,CAKlB;IAED;;;;;OAKG;IACH,uEAHW,2BAA2B,OAAO,CAAC,GACjC,kBAAkB,OAAO,CAAC,CAsBtC;IAED;;;;;;;;;;;OAWG;IACH,yBALW,OAAO,WAAW,EAAE,WAAW,eAC/B,MAAM,kCA8BhB;IAED;;;;;;;OAOG;IAEH,qCAJW,YAAY,OAAO,CAAC,eACpB,MAAM,QAKhB;IAED;;;;;;;;;OASG;IACH,4BAHW,aAAa,GACZ,QAAQ,UAAU,OAAO,CAAC,CAAC,CAatC;IAED;;;;;OAKG;IACH,iCAHW,mBAAmB,GAClB,QAAQ,qBAAqB,CAAC,CA+EzC;IAED;;;;;;OAMG;IACH,6BAHW,MAAM,GACL,QAAQ,eAAe,CAAC,CA4BnC;IAED;;;;;;;OAOG;IACH,6BAJW,MAAM,WACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;;;;OAUG;IACH,6CAHW,UAAU,GACT,QAAQ,SAAS,CAAC,CAoD7B;CACF"}
+{"version":3,"file":"extension-command.d.ts","sourceRoot":"","sources":["../../../lib/cli/extension-command.js"],"names":[],"mappings":";;;;;;;;;YA8xBc,gBAAgB,OAAO,CAAC;;;;UACxB,OAAO;;;;;;;;;eAOP,OAAO;;;;cACP,OAAO;;;;mBACP,MAAM,GAAC,IAAI;;;;yBACX,MAAM,GAAC,IAAI;;;;;;;;;;4BAMZ,OAAO,eAAe,EAAE,aAAa;yBACrC,OAAO,eAAe,EAAE,UAAU;yBAClC,OAAO,eAAe,EAAE,UAAU;+EAKlC,OAAO,cAAc,EAAE,SAAS,CAAC,OAAO,CAAC;qFAKzC,OAAO,+BAA+B,EAAE,eAAe,CAAC,OAAO,CAAC;iFAKhE,OAAO,cAAc,EAAE,WAAW,CAAC,OAAO,CAAC;iFAK3C,OAAO,cAAc,EAAE,WAAW,CAAC,OAAO,CAAC;oFAK3C,OAAO,cAAc,EAAE,cAAc,CAAC,OAAO,CAAC;uFAK9C,OAAO,cAAc,EAAE,iBAAiB,CAAC,OAAO,CAAC;;;;uFAMjD,QAAQ,YAAY,OAAO,CAAC,CAAC,GAAG,QAAQ,qBAAqB,CAAC;gGAK9D,YAAY,OAAO,CAAC,GAAG,qBAAqB;;;;mFAM5C,OAAO,MAAM,EAAC,kBAAkB,OAAO,CAAC,CAAC;;;;;;;;iBAMxC,MAAM;;;;gBACN,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgBN,MAAM;;;;YACN,OAAO;;;;;;;;;YAMP,OAAO,MAAM,EAAC,KAAK,CAAC;;;;aACpB,OAAO,MAAM,EAAC,YAAY,CAAC;;;;;;;;;UAM3B,MAAM;;;;QACN,MAAM;;;;;;;;;iBAMN,MAAM;;;;;;;;;aAMN,MAAM;;;;aACN,MAAM;;;;;;;;;iBAMN,MAAM;;;;aACN,MAAM;;;;iBACN,OAAO,cAAc,EAAE,WAAW;;;;;;;;;;;;;aAOlC,MAAM;;;;gBACN,MAAM;;;;kBACN,MAAM;;;;;;;;;iBAMN,MAAM;;;;iBACN,WAAW;;;;;;qFAMZ,OAAO,SAAS,UAAU,GAAG,cAAc,cAAc,EAAE,aAAa,GAAG,OAAO,SAAS,UAAU,GAAG,cAAc,cAAc,EAAE,aAAa,GAAG,KAAK;;;;;mBAK1J,OAAO;;;;iBACP,OAAO;;;;;;;;;;iBAQP,MAAM;iBACN,MAAM;SACN,eAAe,OAAO,CAAC;iBACvB,WAAW;;0BAIZ,OAAO,cAAc,EAAE,WAAW;AAr6B/C;;GAEG;AACH;IAmBE;;;OAGG;IACH,8BAFW,wBAAwB,OAAO,CAAC,EAM1C;IA1BD;;;OAGG;IACH,QAFU,gBAAgB,OAAO,CAAC,CAE3B;IAEP;;;OAGG;IACH,iBAFU,gBAAgB,OAAO,CAAC,CAElB;IAEhB;;;OAGG;IACH,cAFU,OAAO,CAEJ;IAQX,wBAAmD;IAIrD;;OAEG;IACH,oBAEC;IAED;;;;;;;;;OASG;IACH,qCAJW,MAAM,SAMhB;IAED;;;;;OAKG;IACH,cAHW,MAAM,GACL,QAAQ,MAAM,CAAC,CAS1B;IAED;;;;;OAKG;IACH,uGAHW,WAAW,qCAuHrB;IAED;;;;;OAKG;IACH,oDAHW,WAAW,GACV,QAAQ,UAAU,OAAO,CAAC,CAAC,CA6JtC;IAED;;;;;OAKG;IACH,6DAHW,iBAAiB,GACf,QAAQ,kBAAkB,OAAO,CAAC,CAAC,CAyB/C;IAED;;;;;;OAMG;IAEH,yBAJW,aAAa,GACX,MAAM,CAKlB;IAED;;;;;OAKG;IACH,uEAHW,2BAA2B,OAAO,CAAC,GACjC,kBAAkB,OAAO,CAAC,CAsBtC;IAED;;;;;;;;;;;OAWG;IACH,yBALW,OAAO,WAAW,EAAE,WAAW,eAC/B,MAAM,kCA8BhB;IAED;;;;;;;OAOG;IAEH,qCAJW,YAAY,OAAO,CAAC,eACpB,MAAM,QAKhB;IAED;;;;;;;;;OASG;IACH,4BAHW,aAAa,GACZ,QAAQ,UAAU,OAAO,CAAC,CAAC,CAkBtC;IAED;;;;;OAKG;IACH,iCAHW,mBAAmB,GAClB,QAAQ,qBAAqB,CAAC,CA+EzC;IAED;;;;;;OAMG;IACH,6BAHW,MAAM,GACL,QAAQ,eAAe,CAAC,CA4BnC;IAED;;;;;;;OAOG;IACH,6BAJW,MAAM,WACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAYzB;IAED;;;;;;;;OAQG;IACH,oBANW,MAAM,UACN,MAAM,SACN,MAAM,EAAE,SACR,OAAO,eAAe,EAAE,YAAY,GAClC,OAAO,oBAAoB,EAAE,YAAY,CAQrD;IAED;;;;;;;;;;OAUG;IACH,2DAHW,UAAU,GACT,QAAQ,SAAS,CAAC,CAkF7B;CACF"}

package/build/lib/cli/extension-command.js

@@ -10,9 +10,11 @@ const lodash_1 = __importDefault(require("lodash"));
 const path_1 = __importDefault(require("path"));
 const support_1 = require("@appium/support");
 const utils_1 = require("./utils");
-const teen_process_1 = require("teen_process");
 const extension_config_1 = require("../extension/extension-config");
+const teen_process_1 = require("teen_process");
 const package_changed_1 = require("../extension/package-changed");
+const child_process_1 = require("child_process");
+const node_util_1 = require("node:util");
 const UPDATE_ALL = 'installed';
 class NotUpdatableError extends Error {
 }
@@ -30,7 +32,7 @@ function receiptToManifest(receipt) {
 /**
  * @template {ExtensionType} ExtType
  */
-class ExtensionCommand {
+class ExtensionCliCommand {
     /**
      * Build an ExtensionCommand
      * @param {ExtensionCommandOptions<ExtType>} opts
@@ -75,39 +77,40 @@ class ExtensionCommand {
     }
     /**
      * List extensions
-     *
+     * @template {ExtensionType} ExtType
      * @param {ListOptions} opts
-     * @return {Promise<ExtensionListData>} map of extension names to extension data
+     * @return {Promise<ExtensionList<ExtType>>} map of extension names to extension data
      */
-    async list({ showInstalled, showUpdates }) {
-        const lsMsg = `Listing ${showInstalled ? 'installed' : 'available'} ${this.type}s`;
+    async list({ showInstalled, showUpdates, verbose = false }) {
+        let lsMsg = `Listing ${showInstalled ? 'installed' : 'available'} ${this.type}s`;
+        if (verbose) {
+            lsMsg += ' (verbose mode)';
+        }
         const installedNames = Object.keys(this.config.installedExtensions);
         const knownNames = Object.keys(this.knownExtensions);
-        const exts = [...installedNames, ...knownNames].reduce((acc, name) => {
+        const listData = [...installedNames, ...knownNames].reduce((acc, name) => {
             if (!acc[name]) {
                 if (installedNames.includes(name)) {
                     acc[name] = {
-                        ...this.config.installedExtensions[name],
+                        ... /** @type {Partial<ExtManifest<ExtType>>} */(this.config.installedExtensions[name]),
                         installed: true,
                     };
                 }
                 else if (!showInstalled) {
-                    acc[name] = { pkgName: this.knownExtensions[name], installed: false };
+                    acc[name] = /** @type {ExtensionListData<ExtType>} */ ({
+                        pkgName: this.knownExtensions[name],
+                        installed: false,
+                    });
                 }
             }
             return acc;
-        }, 
-        /**
-         * This accumulator contains either {@linkcode UninstalledExtensionLIstData} _or_
-         * {@linkcode InstalledExtensionListData} without upgrade information (which is added by the below code block)
-         * @type {Record<string,Partial<InstalledExtensionListData>|UninstalledExtensionListData>}
-         */ ({}));
+        }, /** @type {ExtensionList<ExtType>} */ ({}));
         // if we want to show whether updates are available, put that behind a spinner
         await (0, utils_1.spinWith)(this.isJsonOutput, lsMsg, async () => {
             if (!showUpdates) {
                 return;
             }
-            for (const [ext, data] of lodash_1.default.toPairs(exts)) {
+            for (const [ext, data] of lodash_1.default.toPairs(listData)) {
                 if (!data.installed || data.installType !== extension_config_1.INSTALL_TYPE_NPM) {
                     // don't need to check for updates on exts that aren't installed
                     // also don't need to check for updates on non-npm exts
@@ -124,18 +127,27 @@ class ExtensionCommand {
                 }
             }
         });
-        const listData = /** @type {ExtensionListData} */ (exts);
+        /**
+         * Type guard to narrow "installed" extensions, which have more data
+         * @param {any} data
+         * @returns {data is InstalledExtensionListData<ExtType>}
+         */
+        const extIsInstalled = (data) => Boolean(data.installed);
         // if we're just getting the data, short circuit return here since we don't need to do any
         // formatting logic
         if (this.isJsonOutput) {
             return listData;
         }
+        if (verbose) {
+            this.log.log((0, node_util_1.inspect)(listData, { colors: true, depth: null }));
+            return listData;
+        }
         for (const [name, data] of lodash_1.default.toPairs(listData)) {
             let installTxt = ' [not installed]'.grey;
             let updateTxt = '';
             let upToDateTxt = '';
             let unsafeUpdateTxt = '';
-            if (data.installed) {
+            if (extIsInstalled(data)) {
                 const { installType, installSpec, updateVersion, unsafeUpdateVersion, version, upToDate, updateError, } = data;
                 let typeTxt;
                 switch (installType) {
@@ -146,8 +158,11 @@ class ExtensionCommand {
                     case extension_config_1.INSTALL_TYPE_LOCAL:
                         typeTxt = `(linked from ${installSpec})`.magenta;
                         break;
+                    case extension_config_1.INSTALL_TYPE_DEV:
+                        typeTxt = '(dev mode)';
+                        break;
                     default:
-                        typeTxt = '(NPM)';
+                        typeTxt = '(npm)';
                 }
                 installTxt = `@${version.yellow} ${('[installed ' + typeTxt + ']').green}`;
                 if (showUpdates) {
@@ -433,7 +448,12 @@ class ExtensionCommand {
         if (!this.config.isInstalled(installSpec)) {
             throw this._createFatalError(`Can't uninstall ${this.type} '${installSpec}'; it is not installed`);
         }
-        const pkgName = this.config.installedExtensions[installSpec].pkgName;
+        const extRecord = this.config.installedExtensions[installSpec];
+        if (extRecord.installType === extension_config_1.INSTALL_TYPE_DEV) {
+            this.log.warn(`Cannot uninstall ${this.type} "${installSpec}" because it is in development!`);
+            return this.config.installedExtensions;
+        }
+        const pkgName = extRecord.pkgName;
         await support_1.npm.uninstallPackage(this.config.appiumHome, pkgName);
         await this.config.removeExtension(installSpec);
         this.log.ok(`Successfully uninstalled ${this.type} '${installSpec}'`.green);
@@ -556,17 +576,33 @@ class ExtensionCommand {
         await this.config.updateExtension(installSpec, extData);
     }
     /**
-     * Runs a script cached inside the "scripts" field under "appium"
-     * inside of the driver/plugins "package.json" file. Will throw
-     * an error if the driver/plugin does not contain a "scripts" field
-     * underneath the "appium" field in its package.json, if the
-     * "scripts" field is not a plain object, or if the scriptName is
-     * not found within "scripts" object.
+     * Just wraps {@linkcode child_process.spawn} with some default options
+     *
+     * @param {string} cwd - CWD
+     * @param {string} script - Path to script
+     * @param {string[]} args - Extra args for script
+     * @param {import('child_process').SpawnOptions} opts - Options
+     * @returns {import('node:child_process').ChildProcess}
+     */
+    _runUnbuffered(cwd, script, args = [], opts = {}) {
+        return (0, child_process_1.spawn)(process.execPath, [script, ...args], {
+            cwd,
+            stdio: 'inherit',
+            ...opts,
+        });
+    }
+    /**
+     * Runs a script cached inside the `scripts` field under `appium`
+     * inside of the extension's `package.json` file. Will throw
+     * an error if the driver/plugin does not contain a `scripts` field
+     * underneath the `appium` field in its `package.json`, if the
+     * `scripts` field is not a plain object, or if the `scriptName` is
+     * not found within `scripts` object.
      *
      * @param {RunOptions} opts
      * @return {Promise<RunOutput>}
      */
-    async _run({ installSpec, scriptName, extraArgs = [] }) {
+    async _run({ installSpec, scriptName, extraArgs = [], bufferOutput = false }) {
         if (!this.config.isInstalled(installSpec)) {
             throw this._createFatalError(`The ${this.type} "${installSpec}" is not installed`);
         }
@@ -583,44 +619,72 @@ class ExtensionCommand {
         if (!(scriptName in /** @type {Record<string,string>} */ (extScripts))) {
             throw this._createFatalError(`The ${this.type} named '${installSpec}' does not support the script: '${scriptName}'`);
         }
-        const runner = new teen_process_1.SubProcess(process.execPath, [extScripts[scriptName], ...extraArgs], {
-            cwd: this.config.getInstallPath(installSpec),
-        });
-        const output = new utils_1.RingBuffer(50);
-        runner.on('stream-line', (line) => {
-            output.enqueue(line);
-            this.log.log(line);
-        });
-        await runner.start(0);
+        if (bufferOutput) {
+            const runner = new teen_process_1.SubProcess(process.execPath, [extScripts[scriptName], ...extraArgs], {
+                cwd: this.config.getInstallPath(installSpec),
+            });
+            const output = new utils_1.RingBuffer(50);
+            runner.on('stream-line', (line) => {
+                output.enqueue(line);
+                this.log.log(line);
+            });
+            await runner.start(0);
+            try {
+                await runner.join();
+                this.log.ok(`${scriptName} successfully ran`.green);
+                return { output: output.getBuff() };
+            }
+            catch (err) {
+                this.log.error(`Encountered an error when running '${scriptName}': ${err.message}`.red);
+                return { error: err.message, output: output.getBuff() };
+            }
+        }
         try {
-            await runner.join();
+            await new bluebird_1.default((resolve, reject) => {
+                this._runUnbuffered(this.config.getInstallPath(installSpec), extScripts[scriptName], extraArgs)
+                    .on('error', (err) => {
+                    // generally this is of the "I can't find the script" variety.
+                    // this is a developer bug: the extension is pointing to a script that is not where the
+                    // developer said it would be (in `appium.scripts` of the extension's `package.json`)
+                    reject(err);
+                })
+                    .on('close', (code) => {
+                    if (code === 0) {
+                        resolve();
+                    }
+                    else {
+                        reject(new Error(`Script "${scriptName}" exited with code ${code}`));
+                    }
+                });
+            });
             this.log.ok(`${scriptName} successfully ran`.green);
-            return { output: output.getBuff() };
+            return {};
         }
         catch (err) {
             this.log.error(`Encountered an error when running '${scriptName}': ${err.message}`.red);
-            return { error: err.message, output: output.getBuff() };
+            return { error: err.message };
         }
     }
 }
-exports.ExtensionCommand = ExtensionCommand;
-exports.default = ExtensionCommand;
+exports.ExtensionCommand = ExtensionCliCommand;
+exports.default = ExtensionCliCommand;
 /**
- * Options for the {@linkcode ExtensionCommand} constructor
+ * Options for the {@linkcode ExtensionCliCommand} constructor
  * @template {ExtensionType} ExtType
  * @typedef ExtensionCommandOptions
  * @property {ExtensionConfig<ExtType>} config - the `DriverConfig` or `PluginConfig` instance used for this command
  * @property {boolean} json - whether the output of this command should be JSON or text
  */
 /**
- * Extra stuff about extensions; used indirectly by {@linkcode ExtensionCommand.list}.
+ * Extra stuff about extensions; used indirectly by {@linkcode ExtensionCliCommand.list}.
  *
- * @typedef ExtensionMetadata
+ * @typedef ExtensionListMetadata
  * @property {boolean} installed - If `true`, the extension is installed
- * @property {string?} updateVersion - If the extension is installed, the version it can be updated to
- * @property {string?} unsafeUpdateVersion - Same as above, but a major version bump
  * @property {boolean} upToDate - If the extension is installed and the latest
- * @property {string?} updateError - Update check error message (if present)
+ * @property {string|null} updateVersion - If the extension is installed, the version it can be updated to
+ * @property {string|null} unsafeUpdateVersion - Same as above, but a major version bump
+ * @property {string} [updateError] - Update check error message (if present)
+ * @property {boolean} [devMode] - If Appium is run from an extension's working copy
  */
 /**
  * @typedef {import('@appium/types').ExtensionType} ExtensionType
@@ -652,62 +716,65 @@ exports.default = ExtensionCommand;
  * @typedef {import('appium/types').ExtInstallReceipt<ExtType>} ExtInstallReceipt
  */
 /**
- * Possible return value for {@linkcode ExtensionCommand.list}
- * @typedef {Partial<InstalledExtensionListData> & {pkgName: string, installed: false}} UninstalledExtensionListData
+ * Possible return value for {@linkcode ExtensionCliCommand.list}
+ * @template {ExtensionType} ExtType
+ * @typedef {Partial<ExtManifest<ExtType>> & Partial<ExtensionListMetadata>} ExtensionListData
  */
 /**
- * Possible return value for {@linkcode ExtensionCommand.list}
- * @typedef {import('appium/types').InternalMetadata & ExtensionMetadata} InstalledExtensionListData
+ * @template {ExtensionType} ExtType
+ * @typedef {ExtManifest<ExtType> & ExtensionListMetadata} InstalledExtensionListData
  */
 /**
- * Return value of {@linkcode ExtensionCommand.list}.
- * @typedef {Record<string,InstalledExtensionListData|UninstalledExtensionListData>} ExtensionListData
+ * Return value of {@linkcode ExtensionCliCommand.list}.
+ * @template {ExtensionType} ExtType
+ * @typedef {Record<string,ExtensionListData<ExtType>>} ExtensionList
  */
 /**
- * Options for {@linkcode ExtensionCommand._run}.
+ * Options for {@linkcode ExtensionCliCommand._run}.
  * @typedef RunOptions
  * @property {string} installSpec - name of the extension to run a script from
  * @property {string} scriptName - name of the script to run
  * @property {string[]} [extraArgs] - arguments to pass to the script
+ * @property {boolean} [bufferOutput] - if true, will buffer the output of the script and return it
  */
 /**
- * Return value of {@linkcode ExtensionCommand._run}
+ * Return value of {@linkcode ExtensionCliCommand._run}
  *
  * @typedef RunOutput
  * @property {string} [error] - error message if script ran unsuccessfully, otherwise undefined
- * @property {string[]} output - script output
+ * @property {string[]} [output] - script output if `bufferOutput` was `true` in {@linkcode RunOptions}
  */
 /**
- * Options for {@linkcode ExtensionCommand._update}.
+ * Options for {@linkcode ExtensionCliCommand._update}.
  * @typedef ExtensionUpdateOpts
  * @property {string} installSpec - the name of the extension to update
  * @property {boolean} unsafe - if true, will perform unsafe updates past major revision boundaries
  */
 /**
- * Return value of {@linkcode ExtensionCommand._update}.
+ * Return value of {@linkcode ExtensionCliCommand._update}.
  * @typedef ExtensionUpdateResult
  * @property {Record<string,Error>} errors - map of ext names to error objects
  * @property {Record<string,UpdateReport>} updates - map of ext names to {@linkcode UpdateReport}s
  */
 /**
- * Part of result of {@linkcode ExtensionCommand._update}.
+ * Part of result of {@linkcode ExtensionCliCommand._update}.
  * @typedef UpdateReport
  * @property {string} from - version the extension was updated from
  * @property {string} to - version the extension was updated to
  */
 /**
- * Options for {@linkcode ExtensionCommand._uninstall}.
+ * Options for {@linkcode ExtensionCliCommand._uninstall}.
  * @typedef UninstallOpts
  * @property {string} installSpec - the name or spec of an extension to uninstall
  */
 /**
- * Used by {@linkcode ExtensionCommand.getPostInstallText}
+ * Used by {@linkcode ExtensionCliCommand.getPostInstallText}
  * @typedef ExtensionArgs
  * @property {string} extName - the name of an extension
  * @property {object} extData - the data for an installed extension
  */
 /**
- * Options for {@linkcode ExtensionCommand.installViaNpm}
+ * Options for {@linkcode ExtensionCliCommand.installViaNpm}
  * @typedef InstallViaNpmArgs
  * @property {string} installSpec - the name or spec of an extension to install
  * @property {string} pkgName - the NPM package name of the extension
@@ -715,14 +782,14 @@ exports.default = ExtensionCommand;
  * @property {string} [pkgVer] - the specific version of the NPM package
  */
 /**
- * Object returned by {@linkcode ExtensionCommand.checkForExtensionUpdate}
+ * Object returned by {@linkcode ExtensionCliCommand.checkForExtensionUpdate}
  * @typedef PossibleUpdates
  * @property {string} current - current version
  * @property {string?} safeUpdate - version we can safely update to if it exists, or null
  * @property {string?} unsafeUpdate - version we can unsafely update to if it exists, or null
  */
 /**
- * Options for {@linkcode ExtensionCommand._install}
+ * Options for {@linkcode ExtensionCliCommand._install}
  * @typedef InstallOpts
  * @property {string} installSpec - the name or spec of an extension to install
  * @property {InstallType} installType - how to install this extension. One of the INSTALL_TYPES
@@ -736,9 +803,10 @@ exports.default = ExtensionCommand;
  * @typedef ListOptions
  * @property {boolean} showInstalled - whether should show only installed extensions
  * @property {boolean} showUpdates - whether should show available updates
+ * @property {boolean} [verbose] - whether to show additional data from the extension
  */
 /**
- * Opts for {@linkcode ExtensionCommand.getInstallationReceipt}
+ * Opts for {@linkcode ExtensionCliCommand.getInstallationReceipt}
  * @template {ExtensionType} ExtType
  * @typedef GetInstallationReceiptOpts
  * @property {string} installPath