appium 3.2.2 → 3.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (250) hide show
  1. package/build/lib/appium.d.ts +147 -205
  2. package/build/lib/appium.d.ts.map +1 -1
  3. package/build/lib/appium.js +169 -282
  4. package/build/lib/appium.js.map +1 -1
  5. package/build/lib/bidi-commands.d.ts.map +1 -1
  6. package/build/lib/bidi-commands.js +11 -11
  7. package/build/lib/bidi-commands.js.map +1 -1
  8. package/build/lib/bootstrap/appium-initializer.d.ts +21 -0
  9. package/build/lib/bootstrap/appium-initializer.d.ts.map +1 -0
  10. package/build/lib/bootstrap/appium-initializer.js +146 -0
  11. package/build/lib/bootstrap/appium-initializer.js.map +1 -0
  12. package/build/lib/bootstrap/appium-main-runner.d.ts +22 -0
  13. package/build/lib/bootstrap/appium-main-runner.d.ts.map +1 -0
  14. package/build/lib/bootstrap/appium-main-runner.js +109 -0
  15. package/build/lib/bootstrap/appium-main-runner.js.map +1 -0
  16. package/build/lib/bootstrap/config-file.d.ts +37 -0
  17. package/build/lib/bootstrap/config-file.d.ts.map +1 -0
  18. package/build/lib/{config-file.js → bootstrap/config-file.js} +62 -138
  19. package/build/lib/bootstrap/config-file.js.map +1 -0
  20. package/build/lib/bootstrap/grid-v3-register.d.ts +20 -0
  21. package/build/lib/bootstrap/grid-v3-register.d.ts.map +1 -0
  22. package/build/lib/bootstrap/grid-v3-register.js +185 -0
  23. package/build/lib/bootstrap/grid-v3-register.js.map +1 -0
  24. package/build/lib/bootstrap/init-types.d.ts +16 -0
  25. package/build/lib/bootstrap/init-types.d.ts.map +1 -0
  26. package/build/lib/bootstrap/init-types.js +3 -0
  27. package/build/lib/bootstrap/init-types.js.map +1 -0
  28. package/build/lib/bootstrap/main-helpers.d.ts +55 -0
  29. package/build/lib/bootstrap/main-helpers.d.ts.map +1 -0
  30. package/build/lib/bootstrap/main-helpers.js +187 -0
  31. package/build/lib/bootstrap/main-helpers.js.map +1 -0
  32. package/build/lib/bootstrap/node-helpers.d.ts +32 -0
  33. package/build/lib/bootstrap/node-helpers.d.ts.map +1 -0
  34. package/build/lib/bootstrap/node-helpers.js +201 -0
  35. package/build/lib/bootstrap/node-helpers.js.map +1 -0
  36. package/build/lib/bootstrap/startup-config.d.ts +22 -0
  37. package/build/lib/bootstrap/startup-config.d.ts.map +1 -0
  38. package/build/lib/bootstrap/startup-config.js +111 -0
  39. package/build/lib/bootstrap/startup-config.js.map +1 -0
  40. package/build/lib/cli/args.d.ts +16 -12
  41. package/build/lib/cli/args.d.ts.map +1 -1
  42. package/build/lib/cli/args.js +20 -40
  43. package/build/lib/cli/args.js.map +1 -1
  44. package/build/lib/cli/driver-command.d.ts +51 -93
  45. package/build/lib/cli/driver-command.d.ts.map +1 -1
  46. package/build/lib/cli/driver-command.js +11 -66
  47. package/build/lib/cli/driver-command.js.map +1 -1
  48. package/build/lib/cli/extension-command.d.ts +173 -377
  49. package/build/lib/cli/extension-command.d.ts.map +1 -1
  50. package/build/lib/cli/extension-command.js +387 -656
  51. package/build/lib/cli/extension-command.js.map +1 -1
  52. package/build/lib/cli/extension.d.ts +10 -15
  53. package/build/lib/cli/extension.d.ts.map +1 -1
  54. package/build/lib/cli/extension.js +15 -33
  55. package/build/lib/cli/extension.js.map +1 -1
  56. package/build/lib/cli/parser.d.ts +37 -66
  57. package/build/lib/cli/parser.d.ts.map +1 -1
  58. package/build/lib/cli/parser.js +69 -104
  59. package/build/lib/cli/parser.js.map +1 -1
  60. package/build/lib/cli/plugin-command.d.ts +50 -90
  61. package/build/lib/cli/plugin-command.d.ts.map +1 -1
  62. package/build/lib/cli/plugin-command.js +11 -63
  63. package/build/lib/cli/plugin-command.js.map +1 -1
  64. package/build/lib/cli/setup-command.d.ts +21 -26
  65. package/build/lib/cli/setup-command.d.ts.map +1 -1
  66. package/build/lib/cli/setup-command.js +19 -61
  67. package/build/lib/cli/setup-command.js.map +1 -1
  68. package/build/lib/cli/utils.d.ts +33 -35
  69. package/build/lib/cli/utils.d.ts.map +1 -1
  70. package/build/lib/cli/utils.js +48 -50
  71. package/build/lib/cli/utils.js.map +1 -1
  72. package/build/lib/constants.d.ts +23 -23
  73. package/build/lib/constants.d.ts.map +1 -1
  74. package/build/lib/constants.js +10 -15
  75. package/build/lib/constants.js.map +1 -1
  76. package/build/lib/doctor/doctor.d.ts +40 -57
  77. package/build/lib/doctor/doctor.d.ts.map +1 -1
  78. package/build/lib/doctor/doctor.js +31 -62
  79. package/build/lib/doctor/doctor.js.map +1 -1
  80. package/build/lib/extension/driver-config.d.ts +18 -77
  81. package/build/lib/extension/driver-config.d.ts.map +1 -1
  82. package/build/lib/extension/driver-config.js +37 -125
  83. package/build/lib/extension/driver-config.js.map +1 -1
  84. package/build/lib/extension/extension-config.d.ts +103 -210
  85. package/build/lib/extension/extension-config.d.ts.map +1 -1
  86. package/build/lib/extension/extension-config.js +180 -342
  87. package/build/lib/extension/extension-config.js.map +1 -1
  88. package/build/lib/extension/index.d.ts +12 -29
  89. package/build/lib/extension/index.d.ts.map +1 -1
  90. package/build/lib/extension/index.js +33 -75
  91. package/build/lib/extension/index.js.map +1 -1
  92. package/build/lib/extension/manifest-migrations.d.ts +3 -20
  93. package/build/lib/extension/manifest-migrations.d.ts.map +1 -1
  94. package/build/lib/extension/manifest-migrations.js +20 -101
  95. package/build/lib/extension/manifest-migrations.js.map +1 -1
  96. package/build/lib/extension/manifest.d.ts +61 -107
  97. package/build/lib/extension/manifest.d.ts.map +1 -1
  98. package/build/lib/extension/manifest.js +181 -356
  99. package/build/lib/extension/manifest.js.map +1 -1
  100. package/build/lib/extension/package-changed.d.ts +1 -3
  101. package/build/lib/extension/package-changed.d.ts.map +1 -1
  102. package/build/lib/extension/package-changed.js +8 -15
  103. package/build/lib/extension/package-changed.js.map +1 -1
  104. package/build/lib/extension/plugin-config.d.ts +10 -52
  105. package/build/lib/extension/plugin-config.d.ts.map +1 -1
  106. package/build/lib/extension/plugin-config.js +11 -63
  107. package/build/lib/extension/plugin-config.js.map +1 -1
  108. package/build/lib/helpers/build.d.ts +22 -0
  109. package/build/lib/helpers/build.d.ts.map +1 -0
  110. package/build/lib/helpers/build.js +109 -0
  111. package/build/lib/helpers/build.js.map +1 -0
  112. package/build/lib/helpers/capability.d.ts +38 -0
  113. package/build/lib/helpers/capability.d.ts.map +1 -0
  114. package/build/lib/helpers/capability.js +128 -0
  115. package/build/lib/helpers/capability.js.map +1 -0
  116. package/build/lib/helpers/network.d.ts +14 -0
  117. package/build/lib/helpers/network.d.ts.map +1 -0
  118. package/build/lib/helpers/network.js +35 -0
  119. package/build/lib/helpers/network.js.map +1 -0
  120. package/build/lib/insecure-features.js +6 -6
  121. package/build/lib/insecure-features.js.map +1 -1
  122. package/build/lib/inspector-commands.d.ts +6 -0
  123. package/build/lib/inspector-commands.d.ts.map +1 -1
  124. package/build/lib/inspector-commands.js +6 -0
  125. package/build/lib/inspector-commands.js.map +1 -1
  126. package/build/lib/logger.d.ts +2 -3
  127. package/build/lib/logger.d.ts.map +1 -1
  128. package/build/lib/logger.js +2 -3
  129. package/build/lib/logger.js.map +1 -1
  130. package/build/lib/logsink.d.ts +13 -22
  131. package/build/lib/logsink.d.ts.map +1 -1
  132. package/build/lib/logsink.js +48 -103
  133. package/build/lib/logsink.js.map +1 -1
  134. package/build/lib/main.d.ts +15 -58
  135. package/build/lib/main.d.ts.map +1 -1
  136. package/build/lib/main.js +25 -425
  137. package/build/lib/main.js.map +1 -1
  138. package/build/lib/schema/arg-spec.d.ts +32 -107
  139. package/build/lib/schema/arg-spec.d.ts.map +1 -1
  140. package/build/lib/schema/arg-spec.js +11 -107
  141. package/build/lib/schema/arg-spec.js.map +1 -1
  142. package/build/lib/schema/cli-args-guards.d.ts +34 -0
  143. package/build/lib/schema/cli-args-guards.d.ts.map +1 -0
  144. package/build/lib/schema/cli-args-guards.js +49 -0
  145. package/build/lib/schema/cli-args-guards.js.map +1 -0
  146. package/build/lib/schema/cli-args.d.ts +3 -15
  147. package/build/lib/schema/cli-args.d.ts.map +1 -1
  148. package/build/lib/schema/cli-args.js +17 -107
  149. package/build/lib/schema/cli-args.js.map +1 -1
  150. package/build/lib/schema/cli-transformers.d.ts +15 -12
  151. package/build/lib/schema/cli-transformers.d.ts.map +1 -1
  152. package/build/lib/schema/cli-transformers.js +15 -45
  153. package/build/lib/schema/cli-transformers.js.map +1 -1
  154. package/build/lib/schema/format-errors.d.ts +28 -0
  155. package/build/lib/schema/format-errors.d.ts.map +1 -0
  156. package/build/lib/schema/format-errors.js +29 -0
  157. package/build/lib/schema/format-errors.js.map +1 -0
  158. package/build/lib/schema/index.d.ts +4 -2
  159. package/build/lib/schema/index.d.ts.map +1 -1
  160. package/build/lib/schema/index.js +2 -0
  161. package/build/lib/schema/index.js.map +1 -1
  162. package/build/lib/schema/keywords.d.ts +12 -20
  163. package/build/lib/schema/keywords.d.ts.map +1 -1
  164. package/build/lib/schema/keywords.js +6 -51
  165. package/build/lib/schema/keywords.js.map +1 -1
  166. package/build/lib/schema/schema.d.ts +106 -231
  167. package/build/lib/schema/schema.d.ts.map +1 -1
  168. package/build/lib/schema/schema.js +88 -358
  169. package/build/lib/schema/schema.js.map +1 -1
  170. package/build/lib/utils.d.ts +7 -267
  171. package/build/lib/utils.d.ts.map +1 -1
  172. package/build/lib/utils.js +10 -409
  173. package/build/lib/utils.js.map +1 -1
  174. package/lib/{appium.js → appium.ts} +297 -341
  175. package/lib/bidi-commands.ts +10 -14
  176. package/lib/bootstrap/appium-initializer.ts +212 -0
  177. package/lib/bootstrap/appium-main-runner.ts +172 -0
  178. package/lib/bootstrap/config-file.ts +178 -0
  179. package/lib/bootstrap/grid-v3-register.ts +250 -0
  180. package/lib/bootstrap/init-types.ts +31 -0
  181. package/lib/bootstrap/main-helpers.ts +223 -0
  182. package/lib/bootstrap/node-helpers.ts +180 -0
  183. package/lib/bootstrap/startup-config.ts +143 -0
  184. package/lib/cli/{args.js → args.ts} +45 -56
  185. package/lib/cli/driver-command.ts +122 -0
  186. package/lib/cli/{extension-command.js → extension-command.ts} +827 -906
  187. package/lib/cli/extension.ts +65 -0
  188. package/lib/cli/{parser.js → parser.ts} +93 -116
  189. package/lib/cli/plugin-command.ts +117 -0
  190. package/lib/cli/{setup-command.js → setup-command.ts} +59 -74
  191. package/lib/cli/utils.ts +97 -0
  192. package/lib/{constants.js → constants.ts} +30 -41
  193. package/lib/doctor/{doctor.js → doctor.ts} +82 -92
  194. package/lib/extension/driver-config.ts +165 -0
  195. package/lib/extension/{extension-config.js → extension-config.ts} +291 -405
  196. package/lib/extension/index.ts +143 -0
  197. package/lib/extension/manifest-migrations.ts +57 -0
  198. package/lib/extension/manifest.ts +369 -0
  199. package/lib/extension/{package-changed.js → package-changed.ts} +9 -18
  200. package/lib/extension/plugin-config.ts +62 -0
  201. package/lib/helpers/build.ts +111 -0
  202. package/lib/helpers/capability.ts +171 -0
  203. package/lib/helpers/network.ts +30 -0
  204. package/lib/insecure-features.ts +1 -1
  205. package/lib/inspector-commands.ts +6 -1
  206. package/lib/{logger.js → logger.ts} +1 -2
  207. package/lib/{logsink.js → logsink.ts} +91 -137
  208. package/lib/main.ts +60 -0
  209. package/lib/schema/arg-spec.ts +131 -0
  210. package/lib/schema/cli-args-guards.ts +67 -0
  211. package/lib/schema/cli-args.ts +171 -0
  212. package/lib/schema/cli-transformers.ts +83 -0
  213. package/lib/schema/format-errors.ts +43 -0
  214. package/lib/schema/index.ts +4 -0
  215. package/lib/schema/keywords.ts +96 -0
  216. package/lib/schema/schema.ts +448 -0
  217. package/lib/utils.ts +73 -0
  218. package/package.json +17 -18
  219. package/scripts/autoinstall-extensions.js +3 -0
  220. package/build/lib/config-file.d.ts +0 -100
  221. package/build/lib/config-file.d.ts.map +0 -1
  222. package/build/lib/config-file.js.map +0 -1
  223. package/build/lib/config.d.ts +0 -70
  224. package/build/lib/config.d.ts.map +0 -1
  225. package/build/lib/config.js +0 -390
  226. package/build/lib/config.js.map +0 -1
  227. package/build/lib/grid-register.d.ts +0 -10
  228. package/build/lib/grid-register.d.ts.map +0 -1
  229. package/build/lib/grid-register.js +0 -134
  230. package/build/lib/grid-register.js.map +0 -1
  231. package/lib/cli/driver-command.js +0 -174
  232. package/lib/cli/extension.js +0 -74
  233. package/lib/cli/plugin-command.js +0 -164
  234. package/lib/cli/utils.js +0 -91
  235. package/lib/config-file.js +0 -228
  236. package/lib/config.js +0 -389
  237. package/lib/extension/driver-config.js +0 -245
  238. package/lib/extension/index.js +0 -169
  239. package/lib/extension/manifest-migrations.js +0 -136
  240. package/lib/extension/manifest.js +0 -550
  241. package/lib/extension/plugin-config.js +0 -112
  242. package/lib/grid-register.js +0 -146
  243. package/lib/main.js +0 -545
  244. package/lib/schema/arg-spec.js +0 -229
  245. package/lib/schema/cli-args.js +0 -254
  246. package/lib/schema/cli-transformers.js +0 -113
  247. package/lib/schema/index.js +0 -2
  248. package/lib/schema/keywords.js +0 -136
  249. package/lib/schema/schema.js +0 -725
  250. package/lib/utils.js +0 -512
@@ -16,10 +16,8 @@ const PLUGIN_EXAMPLE = 'images';
16
16
  * Bad `argparse`! Bad!
17
17
  */
18
18
  const INSTALL_TYPES_ARRAY = [...extension_config_1.INSTALL_TYPES];
19
- /** @type {Set<ExtensionType>} */
20
19
  const EXTENSION_TYPES = new Set([constants_1.DRIVER_TYPE, constants_1.PLUGIN_TYPE]);
21
20
  // this set of args works for both drivers and plugins ('extensions')
22
- /** @type {ArgumentDefinitions} */
23
21
  const globalExtensionArgs = new Map([
24
22
  [
25
23
  ['--json'],
@@ -33,9 +31,11 @@ const globalExtensionArgs = new Map([
33
31
  ],
34
32
  ]);
35
33
  /**
36
- * Builds a Record of extension types to a Record of subcommands to their argument definitions
34
+ * Returns CLI argument definitions for extension commands by extension type.
35
+ *
36
+ * The result is memoized because parser setup is static across process lifetime.
37
37
  */
38
- const getExtensionArgs = lodash_1.default.memoize(function getExtensionArgs() {
38
+ exports.getExtensionArgs = lodash_1.default.memoize(function getExtensionArgs() {
39
39
  const extensionArgs = {};
40
40
  for (const type of EXTENSION_TYPES) {
41
41
  extensionArgs[type] = {
@@ -47,13 +47,19 @@ const getExtensionArgs = lodash_1.default.memoize(function getExtensionArgs() {
47
47
  [constants_1.EXT_SUBCOMMAND_DOCTOR]: makeDoctorArgs(type),
48
48
  };
49
49
  }
50
- return /** @type {Record<ExtensionType, Record<import('appium/types').CliExtensionSubcommand,ArgumentDefinitions>>} */ (extensionArgs);
50
+ return extensionArgs;
51
51
  });
52
- exports.getExtensionArgs = getExtensionArgs;
53
52
  /**
54
- * Makes the opts for the `list` subcommand for each extension type.
55
- * @param {ExtensionType} type
56
- * @returns {ArgumentDefinitions}
53
+ * Returns CLI argument definitions for the `server` command.
54
+ *
55
+ * This includes schema-derived options and additional CLI-only options which
56
+ * are intentionally disallowed in config files.
57
+ */
58
+ function getServerArgs() {
59
+ return new Map([...(0, cli_args_1.toParserArgs)(), ...serverArgsDisallowedInConfig]);
60
+ }
61
+ /**
62
+ * Builds options for the `list` subcommand for an extension type.
57
63
  */
58
64
  function makeListArgs(type) {
59
65
  return new Map([
@@ -91,9 +97,7 @@ function makeListArgs(type) {
91
97
  ]);
92
98
  }
93
99
  /**
94
- * Makes the opts for the `install` subcommand for each extension type
95
- * @param {ExtensionType} type
96
- * @returns {ArgumentDefinitions}
100
+ * Builds options for the `install` subcommand for an extension type.
97
101
  */
98
102
  function makeInstallArgs(type) {
99
103
  return new Map([
@@ -131,9 +135,7 @@ function makeInstallArgs(type) {
131
135
  ]);
132
136
  }
133
137
  /**
134
- * Makes the opts for the `uninstall` subcommand for each extension type
135
- * @param {ExtensionType} type
136
- * @returns {ArgumentDefinitions}
138
+ * Builds options for the `uninstall` subcommand for an extension type.
137
139
  */
138
140
  function makeUninstallArgs(type) {
139
141
  return new Map([
@@ -149,9 +151,7 @@ function makeUninstallArgs(type) {
149
151
  ]);
150
152
  }
151
153
  /**
152
- * Makes the opts for the `doctor` subcommand for each extension type
153
- * @param {ExtensionType} type
154
- * @returns {ArgumentDefinitions}
154
+ * Builds options for the `doctor` subcommand for an extension type.
155
155
  */
156
156
  function makeDoctorArgs(type) {
157
157
  return new Map([
@@ -167,9 +167,7 @@ function makeDoctorArgs(type) {
167
167
  ]);
168
168
  }
169
169
  /**
170
- * Makes the opts for the `update` subcommand for each extension type
171
- * @param {ExtensionType} type
172
- * @returns {ArgumentDefinitions}
170
+ * Builds options for the `update` subcommand for an extension type.
173
171
  */
174
172
  function makeUpdateArgs(type) {
175
173
  return new Map([
@@ -196,9 +194,7 @@ function makeUpdateArgs(type) {
196
194
  ]);
197
195
  }
198
196
  /**
199
- * Makes the opts for the `run` subcommand for each extension type
200
- * @param {ExtensionType} type
201
- * @returns {ArgumentDefinitions}
197
+ * Builds options for the `run` subcommand for an extension type.
202
198
  */
203
199
  function makeRunArgs(type) {
204
200
  return new Map([
@@ -223,17 +219,8 @@ function makeRunArgs(type) {
223
219
  ],
224
220
  ]);
225
221
  }
226
- /**
227
- * Derives the options for the `server` command from the schema, and adds the arguments
228
- * which are disallowed in the config file.
229
- * @returns {ArgumentDefinitions}
230
- */
231
- function getServerArgs() {
232
- return new Map([...(0, cli_args_1.toParserArgs)(), ...serverArgsDisallowedInConfig]);
233
- }
234
222
  /**
235
223
  * These don't make sense in the context of a config file for obvious reasons.
236
- * @type {ArgumentDefinitions}
237
224
  */
238
225
  const serverArgsDisallowedInConfig = new Map([
239
226
  [
@@ -286,11 +273,4 @@ const serverArgsDisallowedInConfig = new Map([
286
273
  },
287
274
  ],
288
275
  ]);
289
- /**
290
- * @typedef {import('@appium/types').ExtensionType} ExtensionType
291
- */
292
- /**
293
- * A tuple of argument aliases and argument options
294
- * @typedef {Map<[name: string]|[name: string, alias: string],import('argparse').ArgumentOptions>} ArgumentDefinitions
295
- */
296
276
  //# sourceMappingURL=args.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"args.js","sourceRoot":"","sources":["../../../lib/cli/args.js"],"names":[],"mappings":";;;;;;AAyTQ,sCAAa;AAzTrB,oDAAuB;AACvB,4CASsB;AACtB,oEAA4D;AAC5D,iDAAgD;AAChD,MAAM,cAAc,GAAG,UAAU,CAAC;AAClC,MAAM,cAAc,GAAG,QAAQ,CAAC;AAEhC;;;GAGG;AACH,MAAM,mBAAmB,GAAG,CAAC,GAAG,gCAAa,CAAC,CAAC;AAE/C,iCAAiC;AACjC,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,uBAAW,EAAE,uBAAW,CAAC,CAAC,CAAC;AAE5D,qEAAqE;AACrE,kCAAkC;AAClC,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC;IAClC;QACE,CAAC,QAAQ,CAAC;QACV;YACE,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,YAAY;YACpB,IAAI,EAAE,8BAA8B;YACpC,IAAI,EAAE,MAAM;SACb;KACF;CACF,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,gBAAgB,GAAG,gBAAC,CAAC,OAAO,CAAC,SAAS,gBAAgB;IAC1D,MAAM,aAAa,GAAG,EAAE,CAAC;IACzB,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;QACnC,aAAa,CAAC,IAAI,CAAC,GAAG;YACpB,CAAC,+BAAmB,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC;YACzC,CAAC,kCAAsB,CAAC,EAAE,eAAe,CAAC,IAAI,CAAC;YAC/C,CAAC,oCAAwB,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC;YACnD,CAAC,iCAAqB,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC;YAC7C,CAAC,8BAAkB,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC;YACvC,CAAC,iCAAqB,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC;SAC9C,CAAC;IACJ,CAAC;IACD,OAAO,+GAA+G,CAAC,CACrH,aAAa,CACd,CAAC;AACJ,CAAC,CAAC,CAAC;AA+PoB,4CAAgB;AA7PvC;;;;GAIG;AACH,SAAS,YAAY,CAAC,IAAI;IACxB,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,aAAa,CAAC;YACf;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,YAAY;gBACpB,IAAI,EAAE,uBAAuB,IAAI,GAAG;gBACpC,IAAI,EAAE,eAAe;aACtB;SACF;QACD;YACE,CAAC,WAAW,CAAC;YACb;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,YAAY;gBACpB,IAAI,EAAE,oCAAoC,IAAI,UAAU;gBACxD,IAAI,EAAE,aAAa;aACpB;SACF;QACD;YACE,CAAC,WAAW,CAAC;YACb;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,YAAY;gBACpB,IAAI,EAAE,oCAAoC,IAAI,EAAE;gBAChD,IAAI,EAAE,SAAS;aAChB;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,IAAI;IAC3B,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,IAAI,CAAC;YACN;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,4BAA4B;oBAC/C,CAAC,IAAI,KAAK,uBAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;aAC3D;SACF;QACD;YACE,CAAC,UAAU,CAAC;YACZ;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,mBAAmB;gBAC5B,IAAI,EACF,yBAAyB,IAAI,yCAAyC;oBACtE,GAAG,IAAI,uBAAuB,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAChE,IAAI,EAAE,aAAa;aACpB;SACF;QACD;YACE,CAAC,WAAW,CAAC;YACb;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,mCAAmC,IAAI,IAAI;oBAC3C,mDAAmD;gBACrD,IAAI,EAAE,aAAa;aACpB;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,IAAI;IAC7B,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,IAAI,CAAC;YACN;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,8BAA8B;oBACjD,CAAC,IAAI,KAAK,uBAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;aAC3D;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,IAAI;IAC1B,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,IAAI,CAAC;YACN;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,0CAA0C;oBAC7D,CAAC,IAAI,KAAK,uBAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;aAC3D;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,IAAI;IAC1B,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,IAAI,CAAC;YACN;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,sDAAsD,IAAI,KAAK;oBAClF,oBAAoB,IAAI,yBAAyB,IAAI,gCAAgC;oBACrF,eAAe;oBACf,CAAC,IAAI,KAAK,uBAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;aAC3D;SACF;QACD;YACE,CAAC,UAAU,CAAC;YACZ;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,YAAY;gBACpB,IAAI,EACF,+EAA+E;aAClF;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,IAAI;IACvB,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,IAAI,CAAC;YACN;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,sCAAsC;oBACzD,CAAC,IAAI,KAAK,uBAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;aAC3D;SACF;QACD;YACE,CAAC,YAAY,CAAC;YACd;gBACE,OAAO,EAAE,IAAI;gBACb,KAAK,EAAE,GAAG;gBACV,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,iDAAiD;oBACpE,iCAAiC,IAAI,GAAG;aAC3C;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa;IACpB,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,IAAA,uBAAY,GAAE,EAAE,GAAG,4BAA4B,CAAC,CAAC,CAAC;AACvE,CAAC;AAED;;;GAGG;AACH,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAAC;IAC3C;QACE,CAAC,SAAS,CAAC;QACX;YACE,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,iBAAiB;YACvB,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,IAAI;YACX,IAAI,EAAE,OAAO;SACd;KACF;IACD;QACE,CAAC,mBAAmB,CAAC;QACrB;YACE,IAAI,EAAE,eAAe;YACrB,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,IAAI;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,2CAA2C;SAClD;KACF;IACD;QACE,CAAC,mBAAmB,CAAC;QACrB;YACE,IAAI,EAAE,eAAe;YACrB,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,IAAI;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,8DAA8D;SACrE;KACF;IACD;QACE,CAAC,eAAe,CAAC;QACjB;YACE,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,IAAI;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,gDAAgD;SACvD;KACF;IACD;QACE,CAAC,UAAU,CAAC;QACZ;YACE,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,4CAA4C;SACnD;KACF;CACF,CAAC,CAAC;AAIH;;GAEG;AAEH;;;GAGG"}
1
+ {"version":3,"file":"args.js","sourceRoot":"","sources":["../../../lib/cli/args.ts"],"names":[],"mappings":";;;;;;AA8EA,sCAEC;AAhFD,oDAAuB;AAIvB,4CASsB;AACtB,oEAA4D;AAC5D,iDAAgD;AAChD,MAAM,cAAc,GAAG,UAAU,CAAC;AAClC,MAAM,cAAc,GAAG,QAAQ,CAAC;AAOhC;;;GAGG;AACH,MAAM,mBAAmB,GAAG,CAAC,GAAG,gCAAa,CAAC,CAAC;AAE/C,MAAM,eAAe,GAAG,IAAI,GAAG,CAAgB,CAAC,uBAAW,EAAE,uBAAW,CAAC,CAAC,CAAC;AAE3E,qEAAqE;AACrE,MAAM,mBAAmB,GAAwB,IAAI,GAAG,CAAC;IACvD;QACE,CAAC,QAAQ,CAAC;QACV;YACE,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,YAAY;YACpB,IAAI,EAAE,8BAA8B;YACpC,IAAI,EAAE,MAAM;SACb;KACF;CACF,CAAC,CAAC;AAEH;;;;GAIG;AACU,QAAA,gBAAgB,GAAG,gBAAC,CAAC,OAAO,CAAC,SAAS,gBAAgB;IAIjE,MAAM,aAAa,GAAG,EAGrB,CAAC;IACF,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;QACnC,aAAa,CAAC,IAAI,CAAC,GAAG;YACpB,CAAC,+BAAmB,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC;YACzC,CAAC,kCAAsB,CAAC,EAAE,eAAe,CAAC,IAAI,CAAC;YAC/C,CAAC,oCAAwB,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC;YACnD,CAAC,iCAAqB,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC;YAC7C,CAAC,8BAAkB,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC;YACvC,CAAC,iCAAqB,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC;SAC9C,CAAC;IACJ,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,SAAgB,aAAa;IAC3B,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,IAAA,uBAAY,GAAE,EAAE,GAAG,4BAA4B,CAAC,CAAC,CAAC;AACvE,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,IAAmB;IACvC,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,aAAa,CAAC;YACf;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,YAAY;gBACpB,IAAI,EAAE,uBAAuB,IAAI,GAAG;gBACpC,IAAI,EAAE,eAAe;aACtB;SACF;QACD;YACE,CAAC,WAAW,CAAC;YACb;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,YAAY;gBACpB,IAAI,EAAE,oCAAoC,IAAI,UAAU;gBACxD,IAAI,EAAE,aAAa;aACpB;SACF;QACD;YACE,CAAC,WAAW,CAAC;YACb;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,YAAY;gBACpB,IAAI,EAAE,oCAAoC,IAAI,EAAE;gBAChD,IAAI,EAAE,SAAS;aAChB;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CAAC,IAAmB;IAC1C,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,IAAI,CAAC;YACN;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,4BAA4B;oBAC/C,CAAC,IAAI,KAAK,uBAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;aAC3D;SACF;QACD;YACE,CAAC,UAAU,CAAC;YACZ;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,mBAAmB;gBAC5B,IAAI,EACF,yBAAyB,IAAI,yCAAyC;oBACtE,GAAG,IAAI,uBAAuB,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAChE,IAAI,EAAE,aAAa;aACpB;SACF;QACD;YACE,CAAC,WAAW,CAAC;YACb;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,mCAAmC,IAAI,IAAI;oBAC3C,mDAAmD;gBACrD,IAAI,EAAE,aAAa;aACpB;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,IAAmB;IAC5C,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,IAAI,CAAC;YACN;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,8BAA8B;oBACjD,CAAC,IAAI,KAAK,uBAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;aAC3D;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,cAAc,CAAC,IAAmB;IACzC,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,IAAI,CAAC;YACN;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,0CAA0C;oBAC7D,CAAC,IAAI,KAAK,uBAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;aAC3D;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,cAAc,CAAC,IAAmB;IACzC,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,IAAI,CAAC;YACN;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,sDAAsD,IAAI,KAAK;oBAClF,oBAAoB,IAAI,yBAAyB,IAAI,gCAAgC;oBACrF,eAAe;oBACf,CAAC,IAAI,KAAK,uBAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;aAC3D;SACF;QACD;YACE,CAAC,UAAU,CAAC;YACZ;gBACE,QAAQ,EAAE,KAAK;gBACf,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,YAAY;gBACpB,IAAI,EACF,+EAA+E;aAClF;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,IAAmB;IACtC,OAAO,IAAI,GAAG,CAAC;QACb,GAAG,mBAAmB;QACtB;YACE,CAAC,IAAI,CAAC;YACN;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,sCAAsC;oBACzD,CAAC,IAAI,KAAK,uBAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;aAC3D;SACF;QACD;YACE,CAAC,YAAY,CAAC;YACd;gBACE,OAAO,EAAE,IAAI;gBACb,KAAK,EAAE,GAAG;gBACV,IAAI,EAAE,KAAK;gBACX,IAAI,EACF,eAAe,IAAI,iDAAiD;oBACpE,iCAAiC,IAAI,GAAG;aAC3C;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,4BAA4B,GAAwB,IAAI,GAAG,CAAC;IAChE;QACE,CAAC,SAAS,CAAC;QACX;YACE,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,iBAAiB;YACvB,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,IAAI;YACX,IAAI,EAAE,OAAO;SACd;KACF;IACD;QACE,CAAC,mBAAmB,CAAC;QACrB;YACE,IAAI,EAAE,eAAe;YACrB,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,IAAI;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,2CAA2C;SAClD;KACF;IACD;QACE,CAAC,mBAAmB,CAAC;QACrB;YACE,IAAI,EAAE,eAAe;YACrB,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,IAAI;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,8DAA8D;SACrE;KACF;IACD;QACE,CAAC,eAAe,CAAC;QACjB;YACE,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,IAAI;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,gDAAgD;SACvD;KACF;IACD;QACE,CAAC,UAAU,CAAC;QACZ;YACE,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,4CAA4C;SACnD;KACF;CACF,CAAC,CAAC"}
@@ -1,121 +1,79 @@
1
- /**
2
- * @extends {ExtensionCliCommand<DriverType>}
3
- */
4
- export default class DriverCliCommand extends ExtensionCliCommand<"driver"> {
5
- /**
6
- * @param {import('./extension-command').ExtensionCommandOptions<DriverType>} opts
7
- */
8
- constructor({ config, json }: import("./extension-command").ExtensionCommandOptions<DriverType>);
1
+ import type { ExtMetadata, ExtRecord, InstallType } from 'appium/types';
2
+ import ExtensionCliCommand from './extension-command';
3
+ import type { ExtensionArgs, ExtensionCommandOptions, ExtensionUpdateResult, PostInstallText, RunOutput } from './extension-command';
4
+ import '@colors/colors';
5
+ type DriverInstallOpts = {
6
+ driver: string;
7
+ installType: InstallType;
8
+ packageName?: string;
9
+ };
10
+ type DriverUninstallOpts = {
11
+ driver: string;
12
+ };
13
+ type DriverUpdateOpts = {
14
+ driver: string;
15
+ unsafe: boolean;
16
+ };
17
+ type DriverRunOptions = {
18
+ driver: string;
19
+ scriptName: string;
20
+ extraArgs?: string[];
21
+ };
22
+ type DriverDoctorOptions = {
23
+ driver: string;
24
+ };
25
+ export default class DriverCliCommand extends ExtensionCliCommand<'driver'> {
26
+ constructor({ config, json }: ExtensionCommandOptions<'driver'>);
9
27
  /**
10
28
  * Install a driver
11
29
  *
12
- * @param {DriverInstallOpts} opts
13
- * @return {Promise<ExtRecord<DriverType>>}
30
+ * @param opts - install options
14
31
  */
15
- install({ driver, installType, packageName }: DriverInstallOpts): Promise<ExtRecord<DriverType>>;
32
+ install({ driver, installType, packageName }: DriverInstallOpts): Promise<ExtRecord<'driver'>>;
16
33
  /**
17
34
  * Uninstall a driver
18
35
  *
19
- * @param {DriverUninstallOpts} opts
20
- * @return {Promise<ExtRecord<DriverType>>}
36
+ * @param opts - uninstall options
21
37
  */
22
- uninstall({ driver }: DriverUninstallOpts): Promise<ExtRecord<DriverType>>;
38
+ uninstall({ driver }: DriverUninstallOpts): Promise<ExtRecord<'driver'>>;
23
39
  /**
24
40
  * Update a driver
25
41
  *
26
- * @param {DriverUpdateOpts} opts
27
- * @return {Promise<import('./extension-command').ExtensionUpdateResult>}
42
+ * @param opts - update options
28
43
  */
29
- update({ driver, unsafe }: DriverUpdateOpts): Promise<import("./extension-command").ExtensionUpdateResult>;
44
+ update({ driver, unsafe }: DriverUpdateOpts): Promise<ExtensionUpdateResult>;
30
45
  /**
31
46
  * Run a script from a driver
32
47
  *
33
- * @param {DriverRunOptions} opts
34
- * @return {Promise<import('./extension-command').RunOutput>}
48
+ * @param opts - script execution options
35
49
  * @throws {Error} if the script fails to run
36
50
  */
37
- run({ driver, scriptName, extraArgs }: DriverRunOptions): Promise<import("./extension-command").RunOutput>;
51
+ run({ driver, scriptName, extraArgs }: DriverRunOptions): Promise<RunOutput>;
38
52
  /**
39
53
  * Runs doctor checks for the given driver.
40
54
  *
41
- * @param {DriverDoctorOptions} opts
42
- * @returns {Promise<number>} The amount of executed doctor checks.
55
+ * @param opts - doctor command options
56
+ * @returns The amount of executed doctor checks.
43
57
  * @throws {Error} If any of the mandatory Doctor checks fails.
44
58
  */
45
59
  doctor({ driver }: DriverDoctorOptions): Promise<number>;
46
- }
47
- export type ExtensionType = import("@appium/types").ExtensionType;
48
- export type DriverType = import("@appium/types").DriverType;
49
- export type ExtRecord<ExtType extends ExtensionType> = import("appium/types").ExtRecord<ExtType>;
50
- export type DriverCommandOptions = {
51
- config: import("../extension/extension-config").ExtensionConfig<DriverType>;
52
- json: boolean;
53
- };
54
- /**
55
- * Options for {@linkcode DriverCliCommand.install}
56
- */
57
- export type DriverInstallOpts = {
58
60
  /**
59
- * - the name or spec of a driver to install
60
- */
61
- driver: string;
62
- /**
63
- * - how to install this driver. One of the INSTALL_TYPES
64
- */
65
- installType: InstallType;
66
- /**
67
- * - for git/github installs, the driver node package name
68
- */
69
- packageName?: string | undefined;
70
- };
71
- export type InstallType = import("appium/types").InstallType;
72
- /**
73
- * Options for {@linkcode DriverCliCommand.uninstall}
74
- */
75
- export type DriverUninstallOpts = {
76
- /**
77
- * - the name or spec of a driver to uninstall
78
- */
79
- driver: string;
80
- };
81
- /**
82
- * Options for {@linkcode DriverCliCommand.update}
83
- */
84
- export type DriverUpdateOpts = {
85
- /**
86
- * - the name of the driver to update
87
- */
88
- driver: string;
89
- /**
90
- * - if true, will perform unsafe updates past major revision boundaries
91
- */
92
- unsafe: boolean;
93
- };
94
- /**
95
- * Options for {@linkcode DriverCliCommand.run}.
96
- */
97
- export type DriverRunOptions = {
98
- /**
99
- * - name of the driver to run a script from
100
- */
101
- driver: string;
102
- /**
103
- * - name of the script to run
104
- */
105
- scriptName: string;
106
- /**
107
- * - arguments to pass to the script
61
+ * Builds the success message displayed after a driver installation.
62
+ *
63
+ * @param args - installed extension name and metadata
64
+ * @returns formatted success text
108
65
  */
109
- extraArgs?: string[] | undefined;
110
- };
111
- /**
112
- * Options for {@linkcode DriverCliCommand.doctor}.
113
- */
114
- export type DriverDoctorOptions = {
66
+ getPostInstallText({ extName, extData }: ExtensionArgs<'driver'>): PostInstallText;
115
67
  /**
116
- * - name of the driver to run doctor checks for
68
+ * Validates fields in `appium` field of `driverMetadata`
69
+ *
70
+ * For any `package.json` fields which a driver requires, validate the type of
71
+ * those fields on the `package.json` data, throwing an error if anything is
72
+ * amiss.
73
+ * @param driverMetadata - `appium` metadata from extension package
74
+ * @param installSpec - install spec from CLI
117
75
  */
118
- driver: string;
119
- };
120
- import ExtensionCliCommand from './extension-command';
76
+ validateExtensionFields(driverMetadata: ExtMetadata<'driver'>, installSpec: string): void;
77
+ }
78
+ export {};
121
79
  //# sourceMappingURL=driver-command.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"driver-command.d.ts","sourceRoot":"","sources":["../../../lib/cli/driver-command.js"],"names":[],"mappings":"AAOA;;GAEG;AAEH;IACE;;OAEG;IACH,8BAFW,OAAO,qBAAqB,EAAE,uBAAuB,CAAC,UAAU,CAAC,EAK3E;IAED;;;;;OAKG;IACH,8CAHW,iBAAiB,GAChB,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAQzC;IAED;;;;;OAKG;IACH,sBAHW,mBAAmB,GAClB,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAIzC;IAED;;;;;OAKG;IACH,2BAHW,gBAAgB,GACf,OAAO,CAAC,OAAO,qBAAqB,EAAE,qBAAqB,CAAC,CAIvE;IAED;;;;;;OAMG;IACH,uCAJW,gBAAgB,GACf,OAAO,CAAC,OAAO,qBAAqB,EAAE,SAAS,CAAC,CAU3D;IAED;;;;;;OAMG;IACH,mBAJW,mBAAmB,GACjB,OAAO,CAAC,MAAM,CAAC,CAO3B;CAqCF;4BAGY,OAAO,eAAe,EAAE,aAAa;yBACrC,OAAO,eAAe,EAAE,UAAU;sBAIlB,OAAO,SAAtB,aAAc,IACf,OAAO,cAAc,EAAE,SAAS,CAAC,OAAO,CAAC;;YAKxC,OAAO,+BAA+B,EAAE,eAAe,CAAC,UAAU,CAAC;UACnE,OAAO;;;;;;;;;YAMP,MAAM;;;;iBACN,WAAW;;;;;;0BAKZ,OAAO,cAAc,EAAE,WAAW;;;;;;;;YAMjC,MAAM;;;;;;;;;YAMN,MAAM;;;;YACN,OAAO;;;;;;;;;YAMP,MAAM;;;;gBACN,MAAM;;;;;;;;;;;;;YAON,MAAM;;gCA3KY,qBAAqB"}
1
+ {"version":3,"file":"driver-command.d.ts","sourceRoot":"","sources":["../../../lib/cli/driver-command.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,WAAW,EAAE,SAAS,EAAE,WAAW,EAAC,MAAM,cAAc,CAAC;AACtE,OAAO,mBAAmB,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EACV,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,eAAe,EACf,SAAS,EACV,MAAM,qBAAqB,CAAC;AAE7B,OAAO,gBAAgB,CAAC;AAGxB,KAAK,iBAAiB,GAAG;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,WAAW,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAC1F,KAAK,mBAAmB,GAAG;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAAC;AAC5C,KAAK,gBAAgB,GAAG;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAC,CAAC;AAC1D,KAAK,gBAAgB,GAAG;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,CAAC;AACnF,KAAK,mBAAmB,GAAG;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAAC;AAE5C,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,mBAAmB,CAAC,QAAQ,CAAC;gBAC7D,EAAC,MAAM,EAAE,IAAI,EAAC,EAAE,uBAAuB,CAAC,QAAQ,CAAC;IAK7D;;;;OAIG;IACG,OAAO,CAAC,EAAC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAQlG;;;;OAIG;IACG,SAAS,CAAC,EAAC,MAAM,EAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAI5E;;;;OAIG;IACG,MAAM,CAAC,EAAC,MAAM,EAAE,MAAM,EAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIhF;;;;;OAKG;IACG,GAAG,CAAC,EAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC;IAShF;;;;;;OAMG;IACG,MAAM,CAAC,EAAC,MAAM,EAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAM5D;;;;;OAKG;IACM,kBAAkB,CAAC,EAAC,OAAO,EAAE,OAAO,EAAC,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,eAAe;IAQzF;;;;;;;;OAQG;IACM,uBAAuB,CAAC,cAAc,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;CAanG"}
@@ -8,13 +8,7 @@ const extension_command_1 = __importDefault(require("./extension-command"));
8
8
  const constants_1 = require("../constants");
9
9
  require("@colors/colors");
10
10
  const REQ_DRIVER_FIELDS = ['driverName', 'automationName', 'platformNames', 'mainClass'];
11
- /**
12
- * @extends {ExtensionCliCommand<DriverType>}
13
- */
14
11
  class DriverCliCommand extends extension_command_1.default {
15
- /**
16
- * @param {import('./extension-command').ExtensionCommandOptions<DriverType>} opts
17
- */
18
12
  constructor({ config, json }) {
19
13
  super({ config, json });
20
14
  this.knownExtensions = constants_1.KNOWN_DRIVERS;
@@ -22,8 +16,7 @@ class DriverCliCommand extends extension_command_1.default {
22
16
  /**
23
17
  * Install a driver
24
18
  *
25
- * @param {DriverInstallOpts} opts
26
- * @return {Promise<ExtRecord<DriverType>>}
19
+ * @param opts - install options
27
20
  */
28
21
  async install({ driver, installType, packageName }) {
29
22
  return await super._install({
@@ -35,8 +28,7 @@ class DriverCliCommand extends extension_command_1.default {
35
28
  /**
36
29
  * Uninstall a driver
37
30
  *
38
- * @param {DriverUninstallOpts} opts
39
- * @return {Promise<ExtRecord<DriverType>>}
31
+ * @param opts - uninstall options
40
32
  */
41
33
  async uninstall({ driver }) {
42
34
  return await super._uninstall({ installSpec: driver });
@@ -44,8 +36,7 @@ class DriverCliCommand extends extension_command_1.default {
44
36
  /**
45
37
  * Update a driver
46
38
  *
47
- * @param {DriverUpdateOpts} opts
48
- * @return {Promise<import('./extension-command').ExtensionUpdateResult>}
39
+ * @param opts - update options
49
40
  */
50
41
  async update({ driver, unsafe }) {
51
42
  return await super._update({ installSpec: driver, unsafe });
@@ -53,8 +44,7 @@ class DriverCliCommand extends extension_command_1.default {
53
44
  /**
54
45
  * Run a script from a driver
55
46
  *
56
- * @param {DriverRunOptions} opts
57
- * @return {Promise<import('./extension-command').RunOutput>}
47
+ * @param opts - script execution options
58
48
  * @throws {Error} if the script fails to run
59
49
  */
60
50
  async run({ driver, scriptName, extraArgs }) {
@@ -68,8 +58,8 @@ class DriverCliCommand extends extension_command_1.default {
68
58
  /**
69
59
  * Runs doctor checks for the given driver.
70
60
  *
71
- * @param {DriverDoctorOptions} opts
72
- * @returns {Promise<number>} The amount of executed doctor checks.
61
+ * @param opts - doctor command options
62
+ * @returns The amount of executed doctor checks.
73
63
  * @throws {Error} If any of the mandatory Doctor checks fails.
74
64
  */
75
65
  async doctor({ driver }) {
@@ -78,9 +68,10 @@ class DriverCliCommand extends extension_command_1.default {
78
68
  });
79
69
  }
80
70
  /**
71
+ * Builds the success message displayed after a driver installation.
81
72
  *
82
- * @param {import('./extension-command').ExtensionArgs} opts
83
- * @returns {string}
73
+ * @param args - installed extension name and metadata
74
+ * @returns formatted success text
84
75
  */
85
76
  getPostInstallText({ extName, extData }) {
86
77
  return (`Driver ${extName}@${extData.version} successfully installed\n`.green +
@@ -93,8 +84,8 @@ class DriverCliCommand extends extension_command_1.default {
93
84
  * For any `package.json` fields which a driver requires, validate the type of
94
85
  * those fields on the `package.json` data, throwing an error if anything is
95
86
  * amiss.
96
- * @param {import('appium/types').ExtMetadata<DriverType>} driverMetadata
97
- * @param {string} installSpec
87
+ * @param driverMetadata - `appium` metadata from extension package
88
+ * @param installSpec - install spec from CLI
98
89
  */
99
90
  validateExtensionFields(driverMetadata, installSpec) {
100
91
  const missingFields = REQ_DRIVER_FIELDS.reduce((acc, field) => (driverMetadata[field] ? acc : [...acc, field]), []);
@@ -105,50 +96,4 @@ class DriverCliCommand extends extension_command_1.default {
105
96
  }
106
97
  }
107
98
  exports.default = DriverCliCommand;
108
- /**
109
- * @typedef {import('@appium/types').ExtensionType} ExtensionType
110
- * @typedef {import('@appium/types').DriverType} DriverType
111
- */
112
- /**
113
- * @template {ExtensionType} ExtType
114
- * @typedef {import('appium/types').ExtRecord<ExtType>} ExtRecord
115
- */
116
- /**
117
- * @typedef DriverCommandOptions
118
- * @property {import('../extension/extension-config').ExtensionConfig<DriverType>} config
119
- * @property {boolean} json
120
- */
121
- /**
122
- * Options for {@linkcode DriverCliCommand.install}
123
- * @typedef DriverInstallOpts
124
- * @property {string} driver - the name or spec of a driver to install
125
- * @property {InstallType} installType - how to install this driver. One of the INSTALL_TYPES
126
- * @property {string} [packageName] - for git/github installs, the driver node package name
127
- */
128
- /**
129
- * @typedef {import('appium/types').InstallType} InstallType
130
- */
131
- /**
132
- * Options for {@linkcode DriverCliCommand.uninstall}
133
- * @typedef DriverUninstallOpts
134
- * @property {string} driver - the name or spec of a driver to uninstall
135
- */
136
- /**
137
- * Options for {@linkcode DriverCliCommand.update}
138
- * @typedef DriverUpdateOpts
139
- * @property {string} driver - the name of the driver to update
140
- * @property {boolean} unsafe - if true, will perform unsafe updates past major revision boundaries
141
- */
142
- /**
143
- * Options for {@linkcode DriverCliCommand.run}.
144
- * @typedef DriverRunOptions
145
- * @property {string} driver - name of the driver to run a script from
146
- * @property {string} scriptName - name of the script to run
147
- * @property {string[]} [extraArgs] - arguments to pass to the script
148
- */
149
- /**
150
- * Options for {@linkcode DriverCliCommand.doctor}.
151
- * @typedef DriverDoctorOptions
152
- * @property {string} driver - name of the driver to run doctor checks for
153
- */
154
99
  //# sourceMappingURL=driver-command.js.map
@@ -1 +1 @@
1
- {"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;;;;;;OAMG;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;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,EAAC,MAAM,EAAC;QACnB,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC;YACzB,WAAW,EAAE,MAAM;SACpB,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,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,WAAW,WAAW,oDAAoD;gBACxE,gCAAgC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAClE,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AA3GD,mCA2GC;AAED;;;GAGG;AAEH;;;GAGG;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AAEH;;GAEG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;;;GAIG"}
1
+ {"version":3,"file":"driver-command.js","sourceRoot":"","sources":["../../../lib/cli/driver-command.ts"],"names":[],"mappings":";;;;;AAAA,oDAAuB;AAEvB,4EAAsD;AAQtD,4CAA2C;AAC3C,0BAAwB;AAExB,MAAM,iBAAiB,GAAG,CAAC,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,WAAW,CAAC,CAAC;AAOzF,MAAqB,gBAAiB,SAAQ,2BAA6B;IACzE,YAAY,EAAC,MAAM,EAAE,IAAI,EAAoC;QAC3D,KAAK,CAAC,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,yBAAa,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,EAAC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAoB;QACjE,OAAO,MAAM,KAAK,CAAC,QAAQ,CAAC;YAC1B,WAAW,EAAE,MAAM;YACnB,WAAW;YACX,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CAAC,EAAC,MAAM,EAAsB;QAC3C,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,EAAC,WAAW,EAAE,MAAM,EAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,EAAC,MAAM,EAAE,MAAM,EAAmB;QAC7C,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,EAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CAAC,EAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAmB;QACzD,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;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,EAAC,MAAM,EAAsB;QACxC,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC;YACzB,WAAW,EAAE,MAAM;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACM,kBAAkB,CAAC,EAAC,OAAO,EAAE,OAAO,EAA0B;QACrE,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;IACM,uBAAuB,CAAC,cAAqC,EAAE,WAAmB;QACzF,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,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,WAAW,WAAW,oDAAoD;gBACxE,gCAAgC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAClE,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AArGD,mCAqGC"}