appium 2.0.0-beta.5 → 2.0.0-beta.53

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 (199) hide show
  1. package/README.md +156 -63
  2. package/build/lib/appium.d.ts +226 -0
  3. package/build/lib/appium.d.ts.map +1 -0
  4. package/build/lib/appium.js +694 -439
  5. package/build/lib/appium.js.map +1 -0
  6. package/build/lib/cli/args.d.ts +17 -0
  7. package/build/lib/cli/args.d.ts.map +1 -0
  8. package/build/lib/cli/args.js +253 -319
  9. package/build/lib/cli/args.js.map +1 -0
  10. package/build/lib/cli/driver-command.d.ts +102 -0
  11. package/build/lib/cli/driver-command.d.ts.map +1 -0
  12. package/build/lib/cli/driver-command.js +126 -81
  13. package/build/lib/cli/driver-command.js.map +1 -0
  14. package/build/lib/cli/extension-command.d.ts +385 -0
  15. package/build/lib/cli/extension-command.d.ts.map +1 -0
  16. package/build/lib/cli/extension-command.js +731 -383
  17. package/build/lib/cli/extension-command.js.map +1 -0
  18. package/build/lib/cli/extension.d.ts +23 -0
  19. package/build/lib/cli/extension.d.ts.map +1 -0
  20. package/build/lib/cli/extension.js +71 -54
  21. package/build/lib/cli/extension.js.map +1 -0
  22. package/build/lib/cli/parser.d.ts +84 -0
  23. package/build/lib/cli/parser.d.ts.map +1 -0
  24. package/build/lib/cli/parser.js +240 -128
  25. package/build/lib/cli/parser.js.map +1 -0
  26. package/build/lib/cli/plugin-command.d.ts +99 -0
  27. package/build/lib/cli/plugin-command.d.ts.map +1 -0
  28. package/build/lib/cli/plugin-command.js +120 -81
  29. package/build/lib/cli/plugin-command.js.map +1 -0
  30. package/build/lib/cli/utils.d.ts +29 -0
  31. package/build/lib/cli/utils.d.ts.map +1 -0
  32. package/build/lib/cli/utils.js +72 -51
  33. package/build/lib/cli/utils.js.map +1 -0
  34. package/build/lib/config-file.d.ts +100 -0
  35. package/build/lib/config-file.d.ts.map +1 -0
  36. package/build/lib/config-file.js +207 -0
  37. package/build/lib/config-file.js.map +1 -0
  38. package/build/lib/config.d.ts +49 -0
  39. package/build/lib/config.d.ts.map +1 -0
  40. package/build/lib/config.js +265 -201
  41. package/build/lib/config.js.map +1 -0
  42. package/build/lib/constants.d.ts +49 -0
  43. package/build/lib/constants.d.ts.map +1 -0
  44. package/build/lib/constants.js +66 -0
  45. package/build/lib/constants.js.map +1 -0
  46. package/build/lib/extension/driver-config.d.ts +82 -0
  47. package/build/lib/extension/driver-config.d.ts.map +1 -0
  48. package/build/lib/extension/driver-config.js +212 -0
  49. package/build/lib/extension/driver-config.js.map +1 -0
  50. package/build/lib/extension/extension-config.d.ts +249 -0
  51. package/build/lib/extension/extension-config.d.ts.map +1 -0
  52. package/build/lib/extension/extension-config.js +581 -0
  53. package/build/lib/extension/extension-config.js.map +1 -0
  54. package/build/lib/extension/index.d.ts +48 -0
  55. package/build/lib/extension/index.d.ts.map +1 -0
  56. package/build/lib/extension/index.js +105 -0
  57. package/build/lib/extension/index.js.map +1 -0
  58. package/build/lib/extension/manifest-migrations.d.ts +27 -0
  59. package/build/lib/extension/manifest-migrations.d.ts.map +1 -0
  60. package/build/lib/extension/manifest-migrations.js +118 -0
  61. package/build/lib/extension/manifest-migrations.js.map +1 -0
  62. package/build/lib/extension/manifest.d.ts +145 -0
  63. package/build/lib/extension/manifest.d.ts.map +1 -0
  64. package/build/lib/extension/manifest.js +521 -0
  65. package/build/lib/extension/manifest.js.map +1 -0
  66. package/build/lib/extension/package-changed.d.ts +11 -0
  67. package/build/lib/extension/package-changed.d.ts.map +1 -0
  68. package/build/lib/extension/package-changed.js +62 -0
  69. package/build/lib/extension/package-changed.js.map +1 -0
  70. package/build/lib/extension/plugin-config.d.ts +56 -0
  71. package/build/lib/extension/plugin-config.d.ts.map +1 -0
  72. package/build/lib/extension/plugin-config.js +102 -0
  73. package/build/lib/extension/plugin-config.js.map +1 -0
  74. package/build/lib/grid-register.d.ts +10 -0
  75. package/build/lib/grid-register.d.ts.map +1 -0
  76. package/build/lib/grid-register.js +122 -144
  77. package/build/lib/grid-register.js.map +1 -0
  78. package/build/lib/logger.d.ts +3 -0
  79. package/build/lib/logger.d.ts.map +1 -0
  80. package/build/lib/logger.js +5 -17
  81. package/build/lib/logger.js.map +1 -0
  82. package/build/lib/logsink.d.ts +4 -0
  83. package/build/lib/logsink.d.ts.map +1 -0
  84. package/build/lib/logsink.js +190 -187
  85. package/build/lib/logsink.js.map +1 -0
  86. package/build/lib/main.d.ts +62 -0
  87. package/build/lib/main.d.ts.map +1 -0
  88. package/build/lib/main.js +348 -228
  89. package/build/lib/main.js.map +1 -0
  90. package/build/lib/schema/arg-spec.d.ts +143 -0
  91. package/build/lib/schema/arg-spec.d.ts.map +1 -0
  92. package/build/lib/schema/arg-spec.js +164 -0
  93. package/build/lib/schema/arg-spec.js.map +1 -0
  94. package/build/lib/schema/cli-args.d.ts +19 -0
  95. package/build/lib/schema/cli-args.d.ts.map +1 -0
  96. package/build/lib/schema/cli-args.js +217 -0
  97. package/build/lib/schema/cli-args.js.map +1 -0
  98. package/build/lib/schema/cli-transformers.d.ts +5 -0
  99. package/build/lib/schema/cli-transformers.d.ts.map +1 -0
  100. package/build/lib/schema/cli-transformers.js +124 -0
  101. package/build/lib/schema/cli-transformers.js.map +1 -0
  102. package/build/lib/schema/index.d.ts +3 -0
  103. package/build/lib/schema/index.d.ts.map +1 -0
  104. package/build/lib/schema/index.js +19 -0
  105. package/build/lib/schema/index.js.map +1 -0
  106. package/build/lib/schema/keywords.d.ts +24 -0
  107. package/build/lib/schema/keywords.d.ts.map +1 -0
  108. package/build/lib/schema/keywords.js +128 -0
  109. package/build/lib/schema/keywords.js.map +1 -0
  110. package/build/lib/schema/schema.d.ts +259 -0
  111. package/build/lib/schema/schema.d.ts.map +1 -0
  112. package/build/lib/schema/schema.js +615 -0
  113. package/build/lib/schema/schema.js.map +1 -0
  114. package/build/lib/utils.d.ts +121 -0
  115. package/build/lib/utils.d.ts.map +1 -0
  116. package/build/lib/utils.js +351 -273
  117. package/build/lib/utils.js.map +1 -0
  118. package/build/tsconfig.tsbuildinfo +1 -0
  119. package/build/types/cli.d.ts +134 -0
  120. package/build/types/cli.d.ts.map +1 -0
  121. package/build/types/cli.js +3 -0
  122. package/build/types/cli.js.map +1 -0
  123. package/build/types/index.d.ts +15 -0
  124. package/build/types/index.d.ts.map +1 -0
  125. package/build/types/index.js +19 -0
  126. package/build/types/index.js.map +1 -0
  127. package/build/types/manifest/base.d.ts +135 -0
  128. package/build/types/manifest/base.d.ts.map +1 -0
  129. package/build/types/manifest/base.js +3 -0
  130. package/build/types/manifest/base.js.map +1 -0
  131. package/build/types/manifest/index.d.ts +19 -0
  132. package/build/types/manifest/index.d.ts.map +1 -0
  133. package/build/types/manifest/index.js +40 -0
  134. package/build/types/manifest/index.js.map +1 -0
  135. package/build/types/manifest/v3.d.ts +139 -0
  136. package/build/types/manifest/v3.d.ts.map +1 -0
  137. package/build/types/manifest/v3.js +3 -0
  138. package/build/types/manifest/v3.js.map +1 -0
  139. package/driver.d.ts +1 -0
  140. package/driver.js +14 -0
  141. package/index.js +11 -0
  142. package/lib/appium.js +535 -186
  143. package/lib/cli/args.js +267 -422
  144. package/lib/cli/driver-command.js +126 -23
  145. package/lib/cli/extension-command.js +679 -271
  146. package/lib/cli/extension.js +48 -17
  147. package/lib/cli/parser.js +263 -83
  148. package/lib/cli/plugin-command.js +115 -20
  149. package/lib/cli/utils.js +24 -10
  150. package/lib/config-file.js +220 -0
  151. package/lib/config.js +244 -110
  152. package/lib/constants.js +71 -0
  153. package/lib/extension/driver-config.js +250 -0
  154. package/lib/extension/extension-config.js +682 -0
  155. package/lib/extension/index.js +116 -0
  156. package/lib/extension/manifest-migrations.js +120 -0
  157. package/lib/extension/manifest.js +573 -0
  158. package/lib/extension/package-changed.js +64 -0
  159. package/lib/extension/plugin-config.js +112 -0
  160. package/lib/grid-register.js +49 -35
  161. package/lib/logger.js +1 -2
  162. package/lib/logsink.js +64 -38
  163. package/lib/main.js +321 -101
  164. package/lib/schema/arg-spec.js +229 -0
  165. package/lib/schema/cli-args.js +238 -0
  166. package/lib/schema/cli-transformers.js +119 -0
  167. package/lib/schema/index.js +2 -0
  168. package/lib/schema/keywords.js +136 -0
  169. package/lib/schema/schema.js +722 -0
  170. package/lib/utils.js +291 -167
  171. package/package.json +83 -84
  172. package/plugin.d.ts +1 -0
  173. package/plugin.js +13 -0
  174. package/scripts/autoinstall-extensions.js +237 -0
  175. package/support.d.ts +1 -0
  176. package/support.js +13 -0
  177. package/tsconfig.json +25 -0
  178. package/types/cli.ts +193 -0
  179. package/types/index.ts +20 -0
  180. package/types/manifest/README.md +30 -0
  181. package/types/manifest/base.ts +158 -0
  182. package/types/manifest/index.ts +27 -0
  183. package/types/manifest/v3.ts +161 -0
  184. package/CHANGELOG.md +0 -3515
  185. package/bin/ios-webkit-debug-proxy-launcher.js +0 -71
  186. package/build/lib/cli/npm.js +0 -208
  187. package/build/lib/cli/parser-helpers.js +0 -82
  188. package/build/lib/driver-config.js +0 -77
  189. package/build/lib/drivers.js +0 -96
  190. package/build/lib/extension-config.js +0 -253
  191. package/build/lib/plugin-config.js +0 -59
  192. package/build/lib/plugins.js +0 -14
  193. package/lib/cli/npm.js +0 -184
  194. package/lib/cli/parser-helpers.js +0 -79
  195. package/lib/driver-config.js +0 -46
  196. package/lib/drivers.js +0 -81
  197. package/lib/extension-config.js +0 -209
  198. package/lib/plugin-config.js +0 -34
  199. package/lib/plugins.js +0 -10
@@ -0,0 +1,581 @@
1
+ "use strict";
2
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
3
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
4
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
5
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
6
+ };
7
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
8
+ if (kind === "m") throw new TypeError("Private method is not writable");
9
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
10
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
11
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
12
+ };
13
+ var __importDefault = (this && this.__importDefault) || function (mod) {
14
+ return (mod && mod.__esModule) ? mod : { "default": mod };
15
+ };
16
+ var _ExtensionConfig_listDataCache;
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ exports.INSTALL_TYPES = exports.INSTALL_TYPE_GITHUB = exports.INSTALL_TYPE_LOCAL = exports.INSTALL_TYPE_GIT = exports.INSTALL_TYPE_NPM = exports.ExtensionConfig = void 0;
19
+ const lodash_1 = __importDefault(require("lodash"));
20
+ const bluebird_1 = __importDefault(require("bluebird"));
21
+ const path_1 = __importDefault(require("path"));
22
+ const resolve_from_1 = __importDefault(require("resolve-from"));
23
+ const semver_1 = require("semver");
24
+ const support_1 = require("@appium/support");
25
+ const extension_1 = require("../cli/extension");
26
+ const config_1 = require("../config");
27
+ const logger_1 = __importDefault(require("../logger"));
28
+ const schema_1 = require("../schema/schema");
29
+ const INSTALL_TYPE_NPM = 'npm';
30
+ exports.INSTALL_TYPE_NPM = INSTALL_TYPE_NPM;
31
+ const INSTALL_TYPE_LOCAL = 'local';
32
+ exports.INSTALL_TYPE_LOCAL = INSTALL_TYPE_LOCAL;
33
+ const INSTALL_TYPE_GITHUB = 'github';
34
+ exports.INSTALL_TYPE_GITHUB = INSTALL_TYPE_GITHUB;
35
+ const INSTALL_TYPE_GIT = 'git';
36
+ exports.INSTALL_TYPE_GIT = INSTALL_TYPE_GIT;
37
+ /** @type {Set<InstallType>} */
38
+ const INSTALL_TYPES = new Set([
39
+ INSTALL_TYPE_GIT,
40
+ INSTALL_TYPE_GITHUB,
41
+ INSTALL_TYPE_LOCAL,
42
+ INSTALL_TYPE_NPM,
43
+ ]);
44
+ exports.INSTALL_TYPES = INSTALL_TYPES;
45
+ /**
46
+ * This class is abstract. It should not be instantiated directly.
47
+ *
48
+ * Subclasses should provide the generic parameter to implement.
49
+ * @template {ExtensionType} ExtType
50
+ */
51
+ class ExtensionConfig {
52
+ /**
53
+ * @protected
54
+ * @param {ExtType} extensionType - Type of extension
55
+ * @param {Manifest} manifest - `Manifest` instance
56
+ */
57
+ constructor(extensionType, manifest) {
58
+ /**
59
+ * @type {ExtensionListData|undefined}
60
+ */
61
+ _ExtensionConfig_listDataCache.set(this, void 0);
62
+ this.extensionType = extensionType;
63
+ this.installedExtensions = manifest.getExtensionData(extensionType);
64
+ this.manifest = manifest;
65
+ }
66
+ get manifestPath() {
67
+ return this.manifest.manifestPath;
68
+ }
69
+ get appiumHome() {
70
+ return this.manifest.appiumHome;
71
+ }
72
+ /**
73
+ * Returns a list of errors for a given extension.
74
+ *
75
+ * @param {ExtName<ExtType>} extName
76
+ * @param {ExtManifest<ExtType>} extManifest
77
+ * @returns {ExtManifestProblem[]}
78
+ */
79
+ getProblems(extName, extManifest) {
80
+ return [
81
+ ...this.getGenericConfigProblems(extManifest, extName),
82
+ ...this.getConfigProblems(extManifest, extName),
83
+ ...this.getSchemaProblems(extManifest, extName),
84
+ ];
85
+ }
86
+ /**
87
+ * Returns a list of warnings for a given extension.
88
+ *
89
+ * @param {ExtName<ExtType>} extName
90
+ * @param {ExtManifest<ExtType>} extManifest
91
+ * @returns {Promise<string[]>}
92
+ */
93
+ async getWarnings(extName, extManifest) {
94
+ const [genericConfigWarnings, configWarnings] = await bluebird_1.default.all([
95
+ this.getGenericConfigWarnings(extManifest, extName),
96
+ this.getConfigWarnings(extManifest, extName),
97
+ ]);
98
+ return [...genericConfigWarnings, ...configWarnings];
99
+ }
100
+ /**
101
+ * Returns a list of extension-type-specific issues. To be implemented by subclasses.
102
+ * @abstract
103
+ * @param {ExtManifest<ExtType>} extManifest
104
+ * @param {ExtName<ExtType>} extName
105
+ * @returns {Promise<string[]>}
106
+ */
107
+ // eslint-disable-next-line no-unused-vars,require-await
108
+ async getConfigWarnings(extManifest, extName) {
109
+ return [];
110
+ }
111
+ /**
112
+ *
113
+ * @param {Map<ExtName<ExtType>,ExtManifestProblem[]>} [errorMap]
114
+ * @param {Map<ExtName<ExtType>,string[]>} [warningMap]
115
+ */
116
+ getValidationResultSummaries(errorMap = new Map(), warningMap = new Map()) {
117
+ /**
118
+ * Array of computed strings
119
+ * @type {string[]}
120
+ */
121
+ const errorSummaries = [];
122
+ for (const [extName, problems] of errorMap.entries()) {
123
+ if (lodash_1.default.isEmpty(problems)) {
124
+ continue;
125
+ }
126
+ // remove this extension from the list since it's not valid
127
+ errorSummaries.push(`${this.extensionType} "${extName}" had ${support_1.util.pluralize('error', problems.length)} and will not be available:`);
128
+ for (const problem of problems) {
129
+ errorSummaries.push(` - ${problem.err} (Actual value: ` + `${JSON.stringify(problem.val)})`);
130
+ }
131
+ }
132
+ /** @type {string[]} */
133
+ const warningSummaries = [];
134
+ for (const [extName, warnings] of warningMap.entries()) {
135
+ if (lodash_1.default.isEmpty(warnings)) {
136
+ continue;
137
+ }
138
+ const extTypeText = lodash_1.default.capitalize(this.extensionType);
139
+ const problemEnumerationText = support_1.util.pluralize('potential problem', warnings.length, true);
140
+ warningSummaries.push(`${extTypeText} "${extName}" has ${problemEnumerationText}: `);
141
+ for (const warning of warnings) {
142
+ warningSummaries.push(` - ${warning}`);
143
+ }
144
+ }
145
+ return { errorSummaries, warningSummaries };
146
+ }
147
+ /**
148
+ * Checks extensions for problems. To be called by subclasses' `validate` method.
149
+ *
150
+ * Errors and warnings will be displayed to the user.
151
+ *
152
+ * This method mutates `exts`.
153
+ *
154
+ * @protected
155
+ * @param {ExtRecord<ExtType>} exts - Lookup of extension names to {@linkcode ExtManifest} objects
156
+ * @returns {Promise<ExtRecord<ExtType>>} The same lookup, but picking only error-free extensions
157
+ */
158
+ async _validate(exts) {
159
+ /**
160
+ * Lookup of extension names to {@linkcode ExtManifestProblem ExtManifestProblems}
161
+ * @type {Map<ExtName<ExtType>,ExtManifestProblem[]>}
162
+ */
163
+ const errorMap = new Map();
164
+ /**
165
+ * Lookup of extension names to warnings.
166
+ * @type {Map<ExtName<ExtType>,string[]>}
167
+ */
168
+ const warningMap = new Map();
169
+ for (const [extName, extManifest] of lodash_1.default.toPairs(exts)) {
170
+ const [errors, warnings] = await bluebird_1.default.all([
171
+ this.getProblems(extName, extManifest),
172
+ this.getWarnings(extName, extManifest),
173
+ ]);
174
+ if (errors.length) {
175
+ delete exts[extName];
176
+ }
177
+ errorMap.set(extName, errors);
178
+ warningMap.set(extName, warnings);
179
+ }
180
+ const { errorSummaries, warningSummaries } = this.getValidationResultSummaries(errorMap, warningMap);
181
+ if (!lodash_1.default.isEmpty(errorSummaries)) {
182
+ logger_1.default.error(`Appium encountered ${support_1.util.pluralize('error', errorMap.size, true)} while validating ${this.extensionType}s found in manifest ${this.manifestPath}`);
183
+ for (const summary of errorSummaries) {
184
+ logger_1.default.error(summary);
185
+ }
186
+ }
187
+ else {
188
+ // only display warnings if there are no errors!
189
+ if (!lodash_1.default.isEmpty(warningSummaries)) {
190
+ logger_1.default.warn(`Appium encountered ${support_1.util.pluralize('warning', warningMap.size, true)} while validating ${this.extensionType}s found in manifest ${this.manifestPath}`);
191
+ for (const summary of warningSummaries) {
192
+ logger_1.default.warn(summary);
193
+ }
194
+ }
195
+ }
196
+ return exts;
197
+ }
198
+ /**
199
+ * Retrieves listing data for extensions via command class.
200
+ *
201
+ * This is an expensive operation, so the result is cached. Currently, there is no
202
+ * use case for invalidating the cache.
203
+ * @protected
204
+ * @returns {Promise<ExtensionListData>}
205
+ */
206
+ async getListData() {
207
+ if (__classPrivateFieldGet(this, _ExtensionConfig_listDataCache, "f")) {
208
+ return __classPrivateFieldGet(this, _ExtensionConfig_listDataCache, "f");
209
+ }
210
+ const CommandClass = /** @type {ExtCommand<ExtType>} */ (extension_1.commandClasses[this.extensionType]);
211
+ const cmd = new CommandClass({ config: this, json: true });
212
+ const listData = await cmd.list({ showInstalled: true, showUpdates: true });
213
+ __classPrivateFieldSet(this, _ExtensionConfig_listDataCache, listData, "f");
214
+ return listData;
215
+ }
216
+ /**
217
+ * Returns a list of warnings for a particular extension.
218
+ *
219
+ * By definition, a non-empty list of warnings does _not_ imply the extension cannot be loaded,
220
+ * but it may not work as expected or otherwise throw an exception at runtime.
221
+ *
222
+ * @param {ExtManifest<ExtType>} extManifest
223
+ * @param {ExtName<ExtType>} extName
224
+ * @returns {Promise<string[]>}
225
+ */
226
+ async getGenericConfigWarnings(extManifest, extName) {
227
+ const { appiumVersion, installSpec, installType, pkgName } = extManifest;
228
+ const warnings = [];
229
+ const invalidFields = [];
230
+ if (!lodash_1.default.isString(installSpec)) {
231
+ invalidFields.push('installSpec');
232
+ }
233
+ if (!INSTALL_TYPES.has(installType)) {
234
+ invalidFields.push('installType');
235
+ }
236
+ const extTypeText = lodash_1.default.capitalize(this.extensionType);
237
+ if (invalidFields.length) {
238
+ const invalidFieldsEnumerationText = support_1.util.pluralize('invalid or missing field', invalidFields.length, true);
239
+ const invalidFieldsText = invalidFields.map((field) => `"${field}"`).join(', ');
240
+ warnings.push(`${extTypeText} "${extName}" (package \`${pkgName}\`) has ${invalidFieldsEnumerationText} (${invalidFieldsText}) in \`extensions.yaml\`; this may cause upgrades done via the \`appium\` CLI tool to fail. Please reinstall with \`appium ${this.extensionType} uninstall ${extName}\` and \`appium ${this.extensionType} install ${extName}\` to attempt a fix.`);
241
+ }
242
+ /**
243
+ * Helps concatenate warning messages related to peer dependencies
244
+ * @param {string} reason
245
+ * @returns string
246
+ */
247
+ const createPeerWarning = (reason) => `${extTypeText} "${extName}" (package \`${pkgName}\`) may be incompatible with the current version of Appium (v${config_1.APPIUM_VER}) due to ${reason}`;
248
+ if (lodash_1.default.isString(appiumVersion) && !(0, semver_1.satisfies)(config_1.APPIUM_VER, appiumVersion)) {
249
+ const listData = await this.getListData();
250
+ const extListData = /** @type {InstalledExtensionListData} */ (listData[extName]);
251
+ if (extListData?.installed) {
252
+ const { updateVersion, upToDate } = extListData;
253
+ if (!upToDate) {
254
+ warnings.push(createPeerWarning(`its peer dependency on older Appium v${appiumVersion}. Please upgrade \`${pkgName}\` to v${updateVersion} or newer.`));
255
+ }
256
+ else {
257
+ warnings.push(createPeerWarning(`its peer dependency on older Appium v${appiumVersion}. Please ask the developer of \`${pkgName}\` to update the peer dependency on Appium to v${config_1.APPIUM_VER}.`));
258
+ }
259
+ }
260
+ }
261
+ else if (!lodash_1.default.isString(appiumVersion)) {
262
+ const listData = await this.getListData();
263
+ const extListData = /** @type {InstalledExtensionListData} */ (listData[extName]);
264
+ if (!extListData?.upToDate && extListData?.updateVersion) {
265
+ warnings.push(createPeerWarning(`an invalid or missing peer dependency on Appium. A newer version of \`${pkgName}\` is available; please attempt to upgrade "${extName}" to v${extListData.updateVersion} or newer.`));
266
+ }
267
+ else {
268
+ warnings.push(createPeerWarning(`an invalid or missing peer dependency on Appium. Please ask the developer of \`${pkgName}\` to add a peer dependency on \`^appium@${config_1.APPIUM_VER}\`.`));
269
+ }
270
+ }
271
+ return warnings;
272
+ }
273
+ /**
274
+ * Returns list of unrecoverable errors (if any) for the given extension _if_ it has a `schema` property.
275
+ *
276
+ * @param {ExtManifest<ExtType>} extManifest - Extension data (from manifest)
277
+ * @param {ExtName<ExtType>} extName - Extension name (from manifest)
278
+ * @returns {ExtManifestProblem[]}
279
+ */
280
+ getSchemaProblems(extManifest, extName) {
281
+ /** @type {ExtManifestProblem[]} */
282
+ const problems = [];
283
+ const { schema: argSchemaPath } = extManifest;
284
+ if (ExtensionConfig.extDataHasSchema(extManifest)) {
285
+ if (lodash_1.default.isString(argSchemaPath)) {
286
+ if ((0, schema_1.isAllowedSchemaFileExtension)(argSchemaPath)) {
287
+ try {
288
+ this.readExtensionSchema(extName, extManifest);
289
+ }
290
+ catch (err) {
291
+ problems.push({
292
+ err: `Unable to register schema at path ${argSchemaPath}; ${err.message}`,
293
+ val: argSchemaPath,
294
+ });
295
+ }
296
+ }
297
+ else {
298
+ problems.push({
299
+ err: `Schema file has unsupported extension. Allowed: ${[
300
+ ...schema_1.ALLOWED_SCHEMA_EXTENSIONS,
301
+ ].join(', ')}`,
302
+ val: argSchemaPath,
303
+ });
304
+ }
305
+ }
306
+ else if (lodash_1.default.isPlainObject(argSchemaPath)) {
307
+ try {
308
+ this.readExtensionSchema(extName, extManifest);
309
+ }
310
+ catch (err) {
311
+ problems.push({
312
+ err: `Unable to register embedded schema; ${err.message}`,
313
+ val: argSchemaPath,
314
+ });
315
+ }
316
+ }
317
+ else {
318
+ problems.push({
319
+ err: 'Incorrectly formatted schema field; must be a path to a schema file or a schema object.',
320
+ val: argSchemaPath,
321
+ });
322
+ }
323
+ }
324
+ return problems;
325
+ }
326
+ /**
327
+ * Return a list of generic unrecoverable errors for the given extension
328
+ * @param {ExtManifest<ExtType>} extManifest - Extension data (from manifest)
329
+ * @param {ExtName<ExtType>} extName - Extension name (from manifest)
330
+ * @returns {ExtManifestProblem[]}
331
+ */
332
+ // eslint-disable-next-line no-unused-vars
333
+ getGenericConfigProblems(extManifest, extName) {
334
+ const { version, pkgName, mainClass } = extManifest;
335
+ const problems = [];
336
+ if (!lodash_1.default.isString(version)) {
337
+ problems.push({
338
+ err: `Invalid or missing \`version\` field in my \`package.json\` and/or \`extensions.yaml\` (must be a string)`,
339
+ val: version,
340
+ });
341
+ }
342
+ if (!lodash_1.default.isString(pkgName)) {
343
+ problems.push({
344
+ err: `Invalid or missing \`name\` field in my \`package.json\` and/or \`extensions.yaml\` (must be a string)`,
345
+ val: pkgName,
346
+ });
347
+ }
348
+ if (!lodash_1.default.isString(mainClass)) {
349
+ problems.push({
350
+ err: `Invalid or missing \`appium.mainClass\` field in my \`package.json\` and/or \`mainClass\` field in \`extensions.yaml\` (must be a string)`,
351
+ val: mainClass,
352
+ });
353
+ }
354
+ return problems;
355
+ }
356
+ /**
357
+ * @abstract
358
+ * @param {ExtManifest<ExtType>} extManifest
359
+ * @param {ExtName<ExtType>} extName
360
+ * @returns {ExtManifestProblem[]}
361
+ */
362
+ // eslint-disable-next-line no-unused-vars
363
+ getConfigProblems(extManifest, extName) {
364
+ // shoud override this method if special validation is necessary for this extension type
365
+ return [];
366
+ }
367
+ /**
368
+ * @param {string} extName
369
+ * @param {ExtManifest<ExtType>} extManifest
370
+ * @param {ExtensionConfigMutationOpts} [opts]
371
+ * @returns {Promise<void>}
372
+ */
373
+ async addExtension(extName, extManifest, { write = true } = {}) {
374
+ this.manifest.setExtension(this.extensionType, extName, extManifest);
375
+ if (write) {
376
+ await this.manifest.write();
377
+ }
378
+ }
379
+ /**
380
+ * @param {ExtName<ExtType>} extName
381
+ * @param {ExtManifest<ExtType>} extManifest
382
+ * @param {ExtensionConfigMutationOpts} [opts]
383
+ * @returns {Promise<void>}
384
+ */
385
+ async updateExtension(extName, extManifest, { write = true } = {}) {
386
+ this.manifest.setExtension(this.extensionType, extName, {
387
+ ...this.installedExtensions[extName],
388
+ ...extManifest,
389
+ });
390
+ if (write) {
391
+ await this.manifest.write();
392
+ }
393
+ }
394
+ /**
395
+ * Remove an extension from the list of installed extensions, and optionally avoid a write to the manifest file.
396
+ *
397
+ * @param {ExtName<ExtType>} extName
398
+ * @param {ExtensionConfigMutationOpts} [opts]
399
+ * @returns {Promise<void>}
400
+ */
401
+ async removeExtension(extName, { write = true } = {}) {
402
+ this.manifest.deleteExtension(this.extensionType, extName);
403
+ if (write) {
404
+ await this.manifest.write();
405
+ }
406
+ }
407
+ /**
408
+ * @param {ExtName<ExtType>[]} [activeNames]
409
+ * @returns {void}
410
+ */
411
+ // eslint-disable-next-line no-unused-vars
412
+ print(activeNames) {
413
+ if (lodash_1.default.isEmpty(this.installedExtensions)) {
414
+ logger_1.default.info(`No ${this.extensionType}s have been installed in ${this.appiumHome}. Use the "appium ${this.extensionType}" ` +
415
+ 'command to install the one(s) you want to use.');
416
+ return;
417
+ }
418
+ logger_1.default.info(`Available ${this.extensionType}s:`);
419
+ for (const [extName, extManifest] of /** @type {[string, ExtManifest<ExtType>][]} */ (lodash_1.default.toPairs(this.installedExtensions))) {
420
+ logger_1.default.info(` - ${this.extensionDesc(extName, extManifest)}`);
421
+ }
422
+ }
423
+ /**
424
+ * Returns a string describing the extension. Subclasses must implement.
425
+ * @param {ExtName<ExtType>} extName - Extension name
426
+ * @param {ExtManifest<ExtType>} extManifest - Extension data
427
+ * @returns {string}
428
+ * @abstract
429
+ */
430
+ // eslint-disable-next-line no-unused-vars
431
+ extensionDesc(extName, extManifest) {
432
+ throw new Error('This must be implemented in a subclass');
433
+ }
434
+ /**
435
+ * Returns--with reasonable accuracy--the path on disk to the extension.
436
+ *
437
+ * If `installPath` is present in the manifest, then it is used; otherwise we just guess.
438
+ * @param {keyof typeof this.installedExtensions} extName
439
+ * @returns {string}
440
+ */
441
+ getInstallPath(extName) {
442
+ return (this.installedExtensions[extName]?.installPath ??
443
+ path_1.default.join(this.appiumHome, 'node_modules', this.installedExtensions[extName].pkgName));
444
+ }
445
+ /**
446
+ * Loads extension and returns its main class (constructor)
447
+ * @param {ExtName<ExtType>} extName
448
+ * @returns {ExtClass<ExtType>}
449
+ */
450
+ require(extName) {
451
+ const { mainClass } = this.installedExtensions[extName];
452
+ const reqPath = this.getInstallPath(extName);
453
+ /** @type {string} */
454
+ let reqResolved;
455
+ try {
456
+ reqResolved = require.resolve(reqPath);
457
+ }
458
+ catch (err) {
459
+ throw new ReferenceError(`Could not find a ${this.extensionType} installed at ${reqPath}`);
460
+ }
461
+ // note: this will only reload the entry point
462
+ if (process.env.APPIUM_RELOAD_EXTENSIONS && require.cache[reqResolved]) {
463
+ logger_1.default.debug(`Removing ${reqResolved} from require cache`);
464
+ delete require.cache[reqResolved];
465
+ }
466
+ logger_1.default.debug(`Requiring ${this.extensionType} at ${reqPath}`);
467
+ const MainClass = require(reqPath)[mainClass];
468
+ if (!MainClass) {
469
+ throw new ReferenceError(`Could not find a class named "${mainClass}" exported by ${this.extensionType} "${extName}"`);
470
+ }
471
+ return MainClass;
472
+ }
473
+ /**
474
+ * @param {string} extName
475
+ * @returns {boolean}
476
+ */
477
+ isInstalled(extName) {
478
+ return extName in this.installedExtensions;
479
+ }
480
+ /**
481
+ * Intended to be called by corresponding instance methods of subclass.
482
+ * @private
483
+ * @template {ExtensionType} ExtType
484
+ * @param {string} appiumHome
485
+ * @param {ExtType} extType
486
+ * @param {ExtName<ExtType>} extName - Extension name (unique to its type)
487
+ * @param {ExtManifestWithSchema<ExtType>} extManifest - Extension config
488
+ * @returns {import('ajv').SchemaObject|undefined}
489
+ */
490
+ static _readExtensionSchema(appiumHome, extType, extName, extManifest) {
491
+ const { pkgName, schema: argSchemaPath } = extManifest;
492
+ if (!argSchemaPath) {
493
+ throw new TypeError(`No \`schema\` property found in config for ${extType} ${pkgName} -- why is this function being called?`);
494
+ }
495
+ let moduleObject;
496
+ if (lodash_1.default.isString(argSchemaPath)) {
497
+ const schemaPath = (0, resolve_from_1.default)(appiumHome, path_1.default.join(pkgName, argSchemaPath));
498
+ moduleObject = require(schemaPath);
499
+ }
500
+ else {
501
+ moduleObject = argSchemaPath;
502
+ }
503
+ // this sucks. default exports should be destroyed
504
+ const schema = moduleObject.__esModule ? moduleObject.default : moduleObject;
505
+ (0, schema_1.registerSchema)(extType, extName, schema);
506
+ return schema;
507
+ }
508
+ /**
509
+ * Returns `true` if a specific {@link ExtManifest} object has a `schema` prop.
510
+ * The {@link ExtManifest} object becomes a {@link ExtManifestWithSchema} object.
511
+ * @template {ExtensionType} ExtType
512
+ * @param {ExtManifest<ExtType>} extManifest
513
+ * @returns {extManifest is ExtManifestWithSchema<ExtType>}
514
+ */
515
+ static extDataHasSchema(extManifest) {
516
+ return lodash_1.default.isString(extManifest?.schema) || lodash_1.default.isObject(extManifest?.schema);
517
+ }
518
+ /**
519
+ * If an extension provides a schema, this will load the schema and attempt to
520
+ * register it with the schema registrar.
521
+ * @param {ExtName<ExtType>} extName - Name of extension
522
+ * @param {ExtManifestWithSchema<ExtType>} extManifest - Extension data
523
+ * @returns {import('ajv').SchemaObject|undefined}
524
+ */
525
+ readExtensionSchema(extName, extManifest) {
526
+ return ExtensionConfig._readExtensionSchema(this.appiumHome, this.extensionType, extName, extManifest);
527
+ }
528
+ }
529
+ exports.ExtensionConfig = ExtensionConfig;
530
+ _ExtensionConfig_listDataCache = new WeakMap();
531
+ /**
532
+ * An issue with the {@linkcode ExtManifest} for a particular extension.
533
+ *
534
+ * The existance of such an object implies that the extension cannot be loaded.
535
+ * @typedef ExtManifestProblem
536
+ * @property {string} err - Error message
537
+ * @property {any} val - Associated value
538
+ */
539
+ /**
540
+ * An optional logging function provided to an {@link ExtensionConfig} subclass.
541
+ * @callback ExtensionLogFn
542
+ * @param {...any} args
543
+ * @returns {void}
544
+ */
545
+ /**
546
+ * @typedef {import('@appium/types').ExtensionType} ExtensionType
547
+ * @typedef {import('./manifest').Manifest} Manifest
548
+ * @typedef {import('../cli/extension-command').ExtensionListData} ExtensionListData
549
+ * @typedef {import('../cli/extension-command').InstalledExtensionListData} InstalledExtensionListData
550
+ * @typedef {import('appium/types').InstallType} InstallType
551
+ */
552
+ /**
553
+ * @template {ExtensionType} ExtType
554
+ * @typedef {import('appium/types').ExtManifest<ExtType>} ExtManifest
555
+ */
556
+ /**
557
+ * @template {ExtensionType} ExtType
558
+ * @typedef {ExtManifest<ExtType> & {schema: NonNullable<ExtManifest<ExtType>['schema']>}} ExtManifestWithSchema
559
+ */
560
+ /**
561
+ * @template {ExtensionType} ExtType
562
+ * @typedef {import('appium/types').ExtName<ExtType>} ExtName
563
+ */
564
+ /**
565
+ * @template {ExtensionType} ExtType
566
+ * @typedef {import('appium/types').ExtClass<ExtType>} ExtClass
567
+ */
568
+ /**
569
+ * @template {ExtensionType} ExtType
570
+ * @typedef {import('appium/types').ExtRecord<ExtType>} ExtRecord
571
+ */
572
+ /**
573
+ * @template {ExtensionType} ExtType
574
+ * @typedef {import('../cli/extension').ExtCommand<ExtType>} ExtCommand
575
+ */
576
+ /**
577
+ * Options for various methods in {@link ExtensionConfig}
578
+ * @typedef ExtensionConfigMutationOpts
579
+ * @property {boolean} [write=true] Whether or not to write the manifest to disk after a mutation operation
580
+ */
581
+ //# sourceMappingURL=extension-config.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extension-config.js","sourceRoot":"","sources":["../../../lib/extension/extension-config.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,oDAAuB;AACvB,wDAAyB;AACzB,gDAAwB;AACxB,gEAAuC;AACvC,mCAAiC;AACjC,6CAAqC;AACrC,gDAAgD;AAChD,sCAAqC;AACrC,uDAA4B;AAC5B,6CAI0B;AAE1B,MAAM,gBAAgB,GAAG,KAAK,CAAC;AA8lBvB,4CAAgB;AA7lBxB,MAAM,kBAAkB,GAAG,OAAO,CAAC;AA6lBS,gDAAkB;AA5lB9D,MAAM,mBAAmB,GAAG,QAAQ,CAAC;AA4lB2B,kDAAmB;AA3lBnF,MAAM,gBAAgB,GAAG,KAAK,CAAC;AA2lBL,4CAAgB;AAzlB1C,+BAA+B;AAC/B,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC;IAC5B,gBAAgB;IAChB,mBAAmB;IACnB,kBAAkB;IAClB,gBAAgB;CACjB,CAAC,CAAC;AAmlBkF,sCAAa;AAjlBlG;;;;;GAKG;AACH,MAAa,eAAe;IA0B1B;;;;OAIG;IACH,YAAY,aAAa,EAAE,QAAQ;QAVnC;;WAEG;QACH,iDAAe;QAQb,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,mBAAmB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACpE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,OAAO,EAAE,WAAW;QAC9B,OAAO;YACL,GAAG,IAAI,CAAC,wBAAwB,CAAC,WAAW,EAAE,OAAO,CAAC;YACtD,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,OAAO,CAAC;YAC/C,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,OAAO,CAAC;SAChD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW;QACpC,MAAM,CAAC,qBAAqB,EAAE,cAAc,CAAC,GAAG,MAAM,kBAAC,CAAC,GAAG,CAAC;YAC1D,IAAI,CAAC,wBAAwB,CAAC,WAAW,EAAE,OAAO,CAAC;YACnD,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,OAAO,CAAC;SAC7C,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,qBAAqB,EAAE,GAAG,cAAc,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACH,wDAAwD;IACxD,KAAK,CAAC,iBAAiB,CAAC,WAAW,EAAE,OAAO;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACH,4BAA4B,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,EAAE,UAAU,GAAG,IAAI,GAAG,EAAE;QACvE;;;WAGG;QACH,MAAM,cAAc,GAAG,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE;YACpD,IAAI,gBAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBACvB,SAAS;aACV;YACD,2DAA2D;YAC3D,cAAc,CAAC,IAAI,CACjB,GAAG,IAAI,CAAC,aAAa,KAAK,OAAO,SAAS,cAAI,CAAC,SAAS,CACtD,OAAO,EACP,QAAQ,CAAC,MAAM,CAChB,6BAA6B,CAC/B,CAAC;YACF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC9B,cAAc,CAAC,IAAI,CACjB,OAAO,OAAO,CAAC,GAAG,kBAAkB,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CACzE,CAAC;aACH;SACF;QACD,uBAAuB;QACvB,MAAM,gBAAgB,GAAG,EAAE,CAAC;QAC5B,KAAK,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE;YACtD,IAAI,gBAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBACvB,SAAS;aACV;YACD,MAAM,WAAW,GAAG,gBAAC,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACrD,MAAM,sBAAsB,GAAG,cAAI,CAAC,SAAS,CAAC,mBAAmB,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC1F,gBAAgB,CAAC,IAAI,CAAC,GAAG,WAAW,KAAK,OAAO,SAAS,sBAAsB,IAAI,CAAC,CAAC;YACrF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC9B,gBAAgB,CAAC,IAAI,CAAC,OAAO,OAAO,EAAE,CAAC,CAAC;aACzC;SACF;QAED,OAAO,EAAC,cAAc,EAAE,gBAAgB,EAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,SAAS,CAAC,IAAI;QAClB;;;WAGG;QACH,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAC3B;;;WAGG;QACH,MAAM,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;QAE7B,KAAK,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACpD,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,MAAM,kBAAC,CAAC,GAAG,CAAC;gBACrC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC;gBACtC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC;aACvC,CAAC,CAAC;YACH,IAAI,MAAM,CAAC,MAAM,EAAE;gBACjB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;aACtB;YACD,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC9B,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;SACnC;QAED,MAAM,EAAC,cAAc,EAAE,gBAAgB,EAAC,GAAG,IAAI,CAAC,4BAA4B,CAC1E,QAAQ,EACR,UAAU,CACX,CAAC;QAEF,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;YAC9B,gBAAG,CAAC,KAAK,CACP,sBAAsB,cAAI,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,qBAChE,IAAI,CAAC,aACP,uBAAuB,IAAI,CAAC,YAAY,EAAE,CAC3C,CAAC;YACF,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE;gBACpC,gBAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aACpB;SACF;aAAM;YACL,gDAAgD;YAEhD,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;gBAChC,gBAAG,CAAC,IAAI,CACN,sBAAsB,cAAI,CAAC,SAAS,CAClC,SAAS,EACT,UAAU,CAAC,IAAI,EACf,IAAI,CACL,qBAAqB,IAAI,CAAC,aAAa,uBAAuB,IAAI,CAAC,YAAY,EAAE,CACnF,CAAC;gBACF,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE;oBACtC,gBAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;iBACnB;aACF;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,uBAAA,IAAI,sCAAe,EAAE;YACvB,OAAO,uBAAA,IAAI,sCAAe,CAAC;SAC5B;QACD,MAAM,YAAY,GAAG,kCAAkC,CAAC,CAAC,0BAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QAC7F,MAAM,GAAG,GAAG,IAAI,YAAY,CAAC,EAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,EAAC,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAC,CAAC,CAAC;QAC1E,uBAAA,IAAI,kCAAkB,QAAQ,MAAA,CAAC;QAC/B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,wBAAwB,CAAC,WAAW,EAAE,OAAO;QACjD,MAAM,EAAC,aAAa,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAC,GAAG,WAAW,CAAC;QACvE,MAAM,QAAQ,GAAG,EAAE,CAAC;QAEpB,MAAM,aAAa,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;YAC5B,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACnC;QAED,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;YACnC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACnC;QAED,MAAM,WAAW,GAAG,gBAAC,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAErD,IAAI,aAAa,CAAC,MAAM,EAAE;YACxB,MAAM,4BAA4B,GAAG,cAAI,CAAC,SAAS,CACjD,0BAA0B,EAC1B,aAAa,CAAC,MAAM,EACpB,IAAI,CACL,CAAC;YACF,MAAM,iBAAiB,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEhF,QAAQ,CAAC,IAAI,CACX,GAAG,WAAW,KAAK,OAAO,gBAAgB,OAAO,WAAW,4BAA4B,KAAK,iBAAiB,8HAA8H,IAAI,CAAC,aAAa,cAAc,OAAO,mBAAmB,IAAI,CAAC,aAAa,YAAY,OAAO,sBAAsB,CAClW,CAAC;SACH;QAED;;;;WAIG;QACH,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,EAAE,CACnC,GAAG,WAAW,KAAK,OAAO,gBAAgB,OAAO,gEAAgE,mBAAU,YAAY,MAAM,EAAE,CAAC;QAElJ,IAAI,gBAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,IAAA,kBAAS,EAAC,mBAAU,EAAE,aAAa,CAAC,EAAE;YACtE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,WAAW,GAAG,yCAAyC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAClF,IAAI,WAAW,EAAE,SAAS,EAAE;gBAC1B,MAAM,EAAC,aAAa,EAAE,QAAQ,EAAC,GAAG,WAAW,CAAC;gBAC9C,IAAI,CAAC,QAAQ,EAAE;oBACb,QAAQ,CAAC,IAAI,CACX,iBAAiB,CACf,wCAAwC,aAAa,sBAAsB,OAAO,UAAU,aAAa,YAAY,CACtH,CACF,CAAC;iBACH;qBAAM;oBACL,QAAQ,CAAC,IAAI,CACX,iBAAiB,CACf,wCAAwC,aAAa,mCAAmC,OAAO,kDAAkD,mBAAU,GAAG,CAC/J,CACF,CAAC;iBACH;aACF;SACF;aAAM,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;YACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,WAAW,GAAG,yCAAyC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAClF,IAAI,CAAC,WAAW,EAAE,QAAQ,IAAI,WAAW,EAAE,aAAa,EAAE;gBACxD,QAAQ,CAAC,IAAI,CACX,iBAAiB,CACf,yEAAyE,OAAO,+CAA+C,OAAO,SAAS,WAAW,CAAC,aAAa,YAAY,CACrL,CACF,CAAC;aACH;iBAAM;gBACL,QAAQ,CAAC,IAAI,CACX,iBAAiB,CACf,kFAAkF,OAAO,4CAA4C,mBAAU,KAAK,CACrJ,CACF,CAAC;aACH;SACF;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD;;;;;;OAMG;IACH,iBAAiB,CAAC,WAAW,EAAE,OAAO;QACpC,mCAAmC;QACnC,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,EAAC,MAAM,EAAE,aAAa,EAAC,GAAG,WAAW,CAAC;QAC5C,IAAI,eAAe,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE;YACjD,IAAI,gBAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;gBAC7B,IAAI,IAAA,qCAA4B,EAAC,aAAa,CAAC,EAAE;oBAC/C,IAAI;wBACF,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;qBAChD;oBAAC,OAAO,GAAG,EAAE;wBACZ,QAAQ,CAAC,IAAI,CAAC;4BACZ,GAAG,EAAE,qCAAqC,aAAa,KAAK,GAAG,CAAC,OAAO,EAAE;4BACzE,GAAG,EAAE,aAAa;yBACnB,CAAC,CAAC;qBACJ;iBACF;qBAAM;oBACL,QAAQ,CAAC,IAAI,CAAC;wBACZ,GAAG,EAAE,mDAAmD;4BACtD,GAAG,kCAAyB;yBAC7B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;wBACd,GAAG,EAAE,aAAa;qBACnB,CAAC,CAAC;iBACJ;aACF;iBAAM,IAAI,gBAAC,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE;gBACzC,IAAI;oBACF,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;iBAChD;gBAAC,OAAO,GAAG,EAAE;oBACZ,QAAQ,CAAC,IAAI,CAAC;wBACZ,GAAG,EAAE,uCAAuC,GAAG,CAAC,OAAO,EAAE;wBACzD,GAAG,EAAE,aAAa;qBACnB,CAAC,CAAC;iBACJ;aACF;iBAAM;gBACL,QAAQ,CAAC,IAAI,CAAC;oBACZ,GAAG,EAAE,yFAAyF;oBAC9F,GAAG,EAAE,aAAa;iBACnB,CAAC,CAAC;aACJ;SACF;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,0CAA0C;IAC1C,wBAAwB,CAAC,WAAW,EAAE,OAAO;QAC3C,MAAM,EAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAC,GAAG,WAAW,CAAC;QAClD,MAAM,QAAQ,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YACxB,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,2GAA2G;gBAChH,GAAG,EAAE,OAAO;aACb,CAAC,CAAC;SACJ;QAED,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YACxB,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,wGAAwG;gBAC7G,GAAG,EAAE,OAAO;aACb,CAAC,CAAC;SACJ;QAED,IAAI,CAAC,gBAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;YAC1B,QAAQ,CAAC,IAAI,CAAC;gBACZ,GAAG,EAAE,2IAA2I;gBAChJ,GAAG,EAAE,SAAS;aACf,CAAC,CAAC;SACJ;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,0CAA0C;IAC1C,iBAAiB,CAAC,WAAW,EAAE,OAAO;QACpC,wFAAwF;QACxF,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,WAAW,EAAE,EAAC,KAAK,GAAG,IAAI,EAAC,GAAG,EAAE;QAC1D,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACrE,IAAI,KAAK,EAAE;YACT,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;SAC7B;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,EAAC,KAAK,GAAG,IAAI,EAAC,GAAG,EAAE;QAC7D,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE;YACtD,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC;YACpC,GAAG,WAAW;SACf,CAAC,CAAC;QACH,IAAI,KAAK,EAAE;YACT,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;SAC7B;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CAAC,OAAO,EAAE,EAAC,KAAK,GAAG,IAAI,EAAC,GAAG,EAAE;QAChD,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC3D,IAAI,KAAK,EAAE;YACT,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;SAC7B;IACH,CAAC;IAED;;;OAGG;IACH,0CAA0C;IAC1C,KAAK,CAAC,WAAW;QACf,IAAI,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;YACvC,gBAAG,CAAC,IAAI,CACN,MAAM,IAAI,CAAC,aAAa,4BAA4B,IAAI,CAAC,UAAU,qBAAqB,IAAI,CAAC,aAAa,IAAI;gBAC5G,gDAAgD,CACnD,CAAC;YACF,OAAO;SACR;QAED,gBAAG,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,aAAa,IAAI,CAAC,CAAC;QAC9C,KAAK,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,+CAA+C,CAAC,CACnF,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CACpC,EAAE;YACD,gBAAG,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;SAC7D;IACH,CAAC;IAED;;;;;;OAMG;IACH,0CAA0C;IAC1C,aAAa,CAAC,OAAO,EAAE,WAAW;QAChC,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CAAC,OAAO;QACpB,OAAO,CACL,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,WAAW;YAC9C,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,EAAE,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CACtF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,OAAO;QACb,MAAM,EAAC,SAAS,EAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC7C,qBAAqB;QACrB,IAAI,WAAW,CAAC;QAChB,IAAI;YACF,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACxC;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,cAAc,CAAC,oBAAoB,IAAI,CAAC,aAAa,iBAAiB,OAAO,EAAE,CAAC,CAAC;SAC5F;QACD,8CAA8C;QAC9C,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,IAAI,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;YACtE,gBAAG,CAAC,KAAK,CAAC,YAAY,WAAW,qBAAqB,CAAC,CAAC;YACxD,OAAO,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;SACnC;QACD,gBAAG,CAAC,KAAK,CAAC,aAAa,IAAI,CAAC,aAAa,OAAO,OAAO,EAAE,CAAC,CAAC;QAC3D,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,IAAI,cAAc,CACtB,iCAAiC,SAAS,iBAAiB,IAAI,CAAC,aAAa,KAAK,OAAO,GAAG,CAC7F,CAAC;SACH;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,OAAO;QACjB,OAAO,OAAO,IAAI,IAAI,CAAC,mBAAmB,CAAC;IAC7C,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW;QACnE,MAAM,EAAC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAC,GAAG,WAAW,CAAC;QACrD,IAAI,CAAC,aAAa,EAAE;YAClB,MAAM,IAAI,SAAS,CACjB,8CAA8C,OAAO,IAAI,OAAO,wCAAwC,CACzG,CAAC;SACH;QACD,IAAI,YAAY,CAAC;QACjB,IAAI,gBAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;YAC7B,MAAM,UAAU,GAAG,IAAA,sBAAW,EAAC,UAAU,EAAE,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;YAC9E,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;SACpC;aAAM;YACL,YAAY,GAAG,aAAa,CAAC;SAC9B;QACD,kDAAkD;QAClD,MAAM,MAAM,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC;QAC7E,IAAA,uBAAc,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACzC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,gBAAgB,CAAC,WAAW;QACjC,OAAO,gBAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,gBAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,OAAO,EAAE,WAAW;QACtC,OAAO,eAAe,CAAC,oBAAoB,CACzC,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,aAAa,EAClB,OAAO,EACP,WAAW,CACZ,CAAC;IACJ,CAAC;CACF;AAzkBD,0CAykBC;;AAID;;;;;;;GAOG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;GAIG"}
@@ -0,0 +1,48 @@
1
+ /**
2
+ * Loads extensions and creates `ExtensionConfig` instances.
3
+ *
4
+ * - Reads the manifest file, creating if necessary
5
+ * - Using the parsed extension data, creates/gets the `ExtensionConfig` subclass instances
6
+ * - Returns these instances
7
+ *
8
+ * If `appiumHome` is needed, use `resolveAppiumHome` from the `env` module in `@appium/support`.
9
+ * @param {string} appiumHome
10
+ * @returns {Promise<ExtensionConfigs>}
11
+ */
12
+ export function loadExtensions(appiumHome: string): Promise<ExtensionConfigs>;
13
+ /**
14
+ * Find any plugin name which has been installed, and which has been requested for activation by
15
+ * using the --use-plugins flag, and turn each one into its class, so we can send them as objects
16
+ * to the server init. We also want to send/assign them to the umbrella driver so it can use them
17
+ * to wrap command execution
18
+ *
19
+ * @param {import('./plugin-config').PluginConfig} pluginConfig - a plugin extension config
20
+ * @param {string[]} usePlugins
21
+ * @returns {PluginNameMap} Mapping of PluginClass to name
22
+ */
23
+ export function getActivePlugins(pluginConfig: import('./plugin-config').PluginConfig, usePlugins?: string[]): PluginNameMap;
24
+ /**
25
+ * Find any driver name which has been installed, and turn each one into its class, so we can send
26
+ * them as objects to the server init in case they need to add methods/routes or update the server.
27
+ * If the --drivers flag was given, this method only loads the given drivers.
28
+ *
29
+ * @param {import('./driver-config').DriverConfig} driverConfig - a driver extension config
30
+ * @param {string[]} [useDrivers] - optional list of drivers to load
31
+ * @returns {DriverNameMap}
32
+ */
33
+ export function getActiveDrivers(driverConfig: import('./driver-config').DriverConfig, useDrivers?: string[] | undefined): DriverNameMap;
34
+ /**
35
+ * A mapping of {@linkcode PluginClass } classes to their names.
36
+ */
37
+ export type PluginNameMap = Map<PluginClass, string>;
38
+ /**
39
+ * A mapping of {@linkcode DriverClass } classes to their names.
40
+ */
41
+ export type DriverNameMap = Map<DriverClass, string>;
42
+ export type PluginClass = import('@appium/types').PluginClass;
43
+ export type DriverClass = import('@appium/types').DriverClass;
44
+ export type ExtensionConfigs = {
45
+ driverConfig: import('./driver-config').DriverConfig;
46
+ pluginConfig: import('./plugin-config').PluginConfig;
47
+ };
48
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/extension/index.js"],"names":[],"mappings":"AAQA;;;;;;;;;;GAUG;AACH,2CAHW,MAAM,GACJ,QAAQ,gBAAgB,CAAC,CAUrC;AAED;;;;;;;;;GASG;AACH,+CAJW,OAAO,iBAAiB,EAAE,YAAY,eACtC,MAAM,EAAE,iBA2BlB;AAED;;;;;;;;GAQG;AACH,+CAJW,OAAO,iBAAiB,EAAE,YAAY,oDAwBhD;;;;4BAIY,IAAI,WAAW,EAAC,MAAM,CAAC;;;;4BAKvB,IAAI,WAAW,EAAC,MAAM,CAAC;0BAIvB,OAAO,eAAe,EAAE,WAAW;0BACnC,OAAO,eAAe,EAAE,WAAW;;kBAKlC,OAAO,iBAAiB,EAAE,YAAY;kBACtC,OAAO,iBAAiB,EAAE,YAAY"}