appium 2.0.0-beta.7 → 2.0.0-beta.71

package/build/lib/config-file.js

@@ -0,0 +1,207 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeConfig = exports.readConfigFile = exports.formatErrors = void 0;
+const better_ajv_errors_1 = __importDefault(require("@sidvind/better-ajv-errors"));
+const lilconfig_1 = require("lilconfig");
+const lodash_1 = __importDefault(require("lodash"));
+const yaml_1 = __importDefault(require("yaml"));
+const schema_1 = require("./schema/schema");
+/**
+ * lilconfig loader to handle `.yaml` files
+ * @type {import('lilconfig').LoaderSync}
+ */
+function yamlLoader(filepath, content) {
+    return yaml_1.default.parse(content);
+}
+/**
+ * A cache of the raw config file (a JSON string) at a filepath.
+ * This is used for better error reporting.
+ * Note that config files needn't be JSON, but it helps if they are.
+ * @type {Map<string,RawJson>}
+ */
+const rawConfig = new Map();
+/**
+ * Custom JSON loader that caches the raw config file (for use with `better-ajv-errors`).
+ * If it weren't for this cache, this would be unnecessary.
+ * @type {import('lilconfig').LoaderSync}
+ */
+function jsonLoader(filepath, content) {
+    rawConfig.set(filepath, content);
+    return JSON.parse(content);
+}
+/**
+ * Loads a config file from an explicit path
+ * @param {LilconfigAsyncSearcher} lc - lilconfig instance
+ * @param {string} filepath - Path to config file
+ * @returns {Promise<import('lilconfig').LilconfigResult>}
+ */
+async function loadConfigFile(lc, filepath) {
+    try {
+        // removing "await" will cause any rejection to _not_ be caught in this block!
+        return await lc.load(filepath);
+    }
+    catch ( /** @type {unknown} */err) {
+        if ( /** @type {NodeJS.ErrnoException} */(err).code === 'ENOENT') {
+            /** @type {NodeJS.ErrnoException} */ (err).message = `Config file not found at user-provided path: ${filepath}`;
+            throw err;
+        }
+        else if (err instanceof SyntaxError) {
+            // generally invalid JSON
+            err.message = `Config file at user-provided path ${filepath} is invalid:\n${err.message}`;
+            throw err;
+        }
+        throw err;
+    }
+}
+/**
+ * Searches for a config file
+ * @param {LilconfigAsyncSearcher} lc - lilconfig instance
+ * @returns {Promise<import('lilconfig').LilconfigResult>}
+ */
+async function searchConfigFile(lc) {
+    return await lc.search();
+}
+/**
+ * Given an array of errors and the result of loading a config file, generate a
+ * helpful string for the user.
+ *
+ * - If `opts` contains a `json` property, this should be the original JSON
+ *   _string_ of the config file.  This is only applicable if the config file
+ *   was in JSON format. If present, it will associate line numbers with errors.
+ * - If `errors` happens to be empty, this will throw.
+ * @param {import('ajv').ErrorObject[]} errors - Non-empty array of errors. Required.
+ * @param {ReadConfigFileResult['config']|any} [config] -
+ * Configuration & metadata
+ * @param {FormatConfigErrorsOptions} [opts]
+ * @throws {TypeError} If `errors` is empty
+ * @returns {string}
+ */
+function formatErrors(errors = [], config = {}, opts = {}) {
+    if (errors && !errors.length) {
+        throw new TypeError('Array of errors must be non-empty');
+    }
+    return (0, better_ajv_errors_1.default)((0, schema_1.getSchema)(opts.schemaId), config, errors, {
+        json: opts.json,
+        format: 'cli',
+    });
+}
+exports.formatErrors = formatErrors;
+/**
+ * Given an optional path, read a config file. Validates the config file.
+ *
+ * Call {@link validate} if you already have a config object.
+ * @param {string} [filepath] - Path to config file, if we have one
+ * @param {ReadConfigFileOptions} [opts] - Options
+ * @public
+ * @returns {Promise<ReadConfigFileResult>} Contains config and filepath, if found, and any errors
+ */
+async function readConfigFile(filepath, opts = {}) {
+    const lc = (0, lilconfig_1.lilconfig)('appium', {
+        loaders: {
+            '.yaml': yamlLoader,
+            '.yml': yamlLoader,
+            '.json': jsonLoader,
+            noExt: jsonLoader,
+        },
+        packageProp: 'appiumConfig',
+    });
+    const result = filepath ? await loadConfigFile(lc, filepath) : await searchConfigFile(lc);
+    if (result?.filepath && !result?.isEmpty) {
+        const { pretty = true } = opts;
+        try {
+            let configResult;
+            const errors = (0, schema_1.validate)(result.config);
+            if (lodash_1.default.isEmpty(errors)) {
+                configResult = { ...result, errors };
+            }
+            else {
+                const reason = formatErrors(errors, result.config, {
+                    json: rawConfig.get(result.filepath),
+                    pretty,
+                });
+                configResult = reason ? { ...result, errors, reason } : { ...result, errors };
+            }
+            // normalize (to camel case) all top-level property names of the config file
+            configResult.config = normalizeConfig(/** @type {AppiumConfig} */ (configResult.config));
+            return configResult;
+        }
+        finally {
+            // clean up the raw config file cache, which is only kept to better report errors.
+            rawConfig.delete(result.filepath);
+        }
+    }
+    return result ?? {};
+}
+exports.readConfigFile = readConfigFile;
+/**
+ * Convert schema property names to either a) the value of the `appiumCliDest` property, if any; or b) camel-case
+ * @param {AppiumConfig} config - Configuration object
+ * @returns {NormalizedAppiumConfig} New object with camel-cased keys (or `dest` keys).
+ */
+function normalizeConfig(config) {
+    const schema = (0, schema_1.getSchema)();
+    /**
+     * @param {AppiumConfig} config
+     * @param {string} [section] - Keypath (lodash `_.get()` style) to section of config. If omitted, assume root Appium config schema
+     * @todo Rewrite as a loop
+     * @returns Normalized section of config
+     */
+    const normalize = (config, section) => {
+        const obj = lodash_1.default.isUndefined(section) ? config : lodash_1.default.get(config, section, config);
+        const mappedObj = lodash_1.default.mapKeys(obj, (__, prop) => lodash_1.default.get(schema, `properties.server.properties[${prop}].appiumCliDest`, lodash_1.default.camelCase(prop)));
+        return lodash_1.default.mapValues(mappedObj, (value, property) => {
+            const nextSection = section ? `${section}.${property}` : property;
+            return isSchemaTypeObject(schema.properties?.[property])
+                ? normalize(config, nextSection)
+                : value;
+        });
+    };
+    /**
+     * Returns `true` if the schema prop references an object, or if it's an object itself
+     * @param {import('ajv').SchemaObject|object} schema - Referencing schema object
+     */
+    const isSchemaTypeObject = (schema) => Boolean(schema?.properties || schema?.type === 'object');
+    return normalize(config);
+}
+exports.normalizeConfig = normalizeConfig;
+/**
+ * Result of calling {@link readConfigFile}.
+ * @typedef ReadConfigFileResult
+ * @property {import('ajv').ErrorObject[]} [errors] - Validation errors
+ * @property {string} [filepath] - The path to the config file, if found
+ * @property {boolean} [isEmpty] - If `true`, the config file exists but is empty
+ * @property {NormalizedAppiumConfig} [config] - The parsed configuration
+ * @property {string|import('@sidvind/better-ajv-errors').IOutputError[]} [reason] - Human-readable error messages and suggestions. If the `pretty` option is `true`, this will be a nice string to print.
+ */
+/**
+ * Options for {@link readConfigFile}.
+ * @typedef ReadConfigFileOptions
+ * @property {boolean} [pretty=true] If `false`, do not use color and fancy formatting in the `reason` property of the {@link ReadConfigFileResult}. The value of `reason` is then suitable for machine-reading.
+ */
+/**
+ * This is an `AsyncSearcher` which is inexplicably _not_ exported by the `lilconfig` type definition.
+ * @typedef {ReturnType<import('lilconfig')["lilconfig"]>} LilconfigAsyncSearcher
+ */
+/**
+ * The contents of an Appium config file. Generated from schema
+ * @typedef {import('@appium/types').AppiumConfig} AppiumConfig
+ */
+/**
+ * The contents of an Appium config file with camelcased property names (and using `appiumCliDest` value if present). Generated from {@link AppiumConfig}
+ * @typedef {import('@appium/types').NormalizedAppiumConfig} NormalizedAppiumConfig
+ */
+/**
+ * The string should be a raw JSON string.
+ * @typedef {string} RawJson
+ */
+/**
+ * Options for {@link formatErrors}.
+ * @typedef FormatConfigErrorsOptions
+ * @property {import('./config-file').RawJson} [json] - Raw JSON config (as string)
+ * @property {boolean} [pretty=true] - Whether to format errors as a CLI-friendly string
+ * @property {string}  [schemaId] - Specific ID of a prop; otherwise entire schema
+ */
+//# sourceMappingURL=config-file.js.map

package/build/lib/config-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-file.js","sourceRoot":"","sources":["../../lib/config-file.js"],"names":[],"mappings":";;;;;;AAAA,mFAAyD;AACzD,yCAAoC;AACpC,oDAAuB;AACvB,gDAAwB;AACxB,4CAAoD;AAEpD;;;GAGG;AACH,SAAS,UAAU,CAAC,QAAQ,EAAE,OAAO;IACnC,OAAO,cAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,MAAM,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;AAE5B;;;;GAIG;AACH,SAAS,UAAU,CAAC,QAAQ,EAAE,OAAO;IACnC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACjC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,cAAc,CAAC,EAAE,EAAE,QAAQ;IACxC,IAAI;QACF,8EAA8E;QAC9E,OAAO,MAAM,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;KAChC;IAAC,QAAO,sBAAuB,GAAG,EAAE;QACnC,KAAI,oCAAqC,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE;YAChE,oCAAoC,CAAC,CACnC,GAAG,CACJ,CAAC,OAAO,GAAG,gDAAgD,QAAQ,EAAE,CAAC;YACvE,MAAM,GAAG,CAAC;SACX;aAAM,IAAI,GAAG,YAAY,WAAW,EAAE;YACrC,yBAAyB;YACzB,GAAG,CAAC,OAAO,GAAG,qCAAqC,QAAQ,iBAAiB,GAAG,CAAC,OAAO,EAAE,CAAC;YAC1F,MAAM,GAAG,CAAC;SACX;QACD,MAAM,GAAG,CAAC;KACX;AACH,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,gBAAgB,CAAC,EAAE;IAChC,OAAO,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,YAAY,CAAC,MAAM,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,EAAE,IAAI,GAAG,EAAE;IAC9D,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;QAC5B,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAC;KAC1D;IACD,OAAO,IAAA,2BAAe,EAAC,IAAA,kBAAS,EAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE;QAC/D,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,MAAM,EAAE,KAAK;KACd,CAAC,CAAC;AACL,CAAC;AARD,oCAQC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,cAAc,CAAC,QAAQ,EAAE,IAAI,GAAG,EAAE;IACtD,MAAM,EAAE,GAAG,IAAA,qBAAS,EAAC,QAAQ,EAAE;QAC7B,OAAO,EAAE;YACP,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,UAAU;YAClB,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,UAAU;SAClB;QACD,WAAW,EAAE,cAAc;KAC5B,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,MAAM,cAAc,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAE1F,IAAI,MAAM,EAAE,QAAQ,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE;QACxC,MAAM,EAAC,MAAM,GAAG,IAAI,EAAC,GAAG,IAAI,CAAC;QAC7B,IAAI;YACF,IAAI,YAAY,CAAC;YACjB,MAAM,MAAM,GAAG,IAAA,iBAAQ,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,IAAI,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBACrB,YAAY,GAAG,EAAC,GAAG,MAAM,EAAE,MAAM,EAAC,CAAC;aACpC;iBAAM;gBACL,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;oBACjD,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;oBACpC,MAAM;iBACP,CAAC,CAAC;gBACH,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,EAAC,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC,CAAC,EAAC,GAAG,MAAM,EAAE,MAAM,EAAC,CAAC;aAC3E;YAED,4EAA4E;YAC5E,YAAY,CAAC,MAAM,GAAG,eAAe,CAAC,2BAA2B,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YAEzF,OAAO,YAAY,CAAC;SACrB;gBAAS;YACR,kFAAkF;YAClF,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;SACnC;KACF;IACD,OAAO,MAAM,IAAI,EAAE,CAAC;AACtB,CAAC;AAtCD,wCAsCC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAC,MAAM;IACpC,MAAM,MAAM,GAAG,IAAA,kBAAS,GAAE,CAAC;IAC3B;;;;;OAKG;IACH,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;QACpC,MAAM,GAAG,GAAG,gBAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAC,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAE7E,MAAM,SAAS,GAAG,gBAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,CAC5C,gBAAC,CAAC,GAAG,CAAC,MAAM,EAAE,gCAAgC,IAAI,iBAAiB,EAAE,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CACxF,CAAC;QAEF,OAAO,gBAAC,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YAChD,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;YAClE,OAAO,kBAAkB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC;gBACtD,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC;gBAChC,CAAC,CAAC,KAAK,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF;;;OAGG;IACH,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,IAAI,MAAM,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC;IAEhG,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;AAC3B,CAAC;AA9BD,0CA8BC;AAED;;;;;;;;GAQG;AAEH;;;;GAIG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;;;GAMG"}

package/build/lib/config.d.ts

@@ -0,0 +1,49 @@
+export function checkNpmOk(): Promise<void>;
+export type ParsedArgs = import('appium/types').ParsedArgs;
+export type Args = import('appium/types').Args;
+export type ArgSpec = import("./schema/arg-spec").ArgSpec<any>;
+/**
+ * Mutable object containing Appium build information. By default it
+ * only contains the Appium version, but is updated with the build timestamp
+ * and git commit hash asynchronously as soon as `updateBuildInfo` is called
+ * and succeeds.
+ * @returns {import('appium/types').BuildInfo}
+ */
+export function getBuildInfo(): import('appium/types').BuildInfo;
+export function checkNodeOk(): void;
+export function showBuildInfo(): Promise<void>;
+export function warnNodeDeprecations(): void;
+/**
+ * @param {string} tmpDir
+ */
+export function validateTmpDir(tmpDir: string): Promise<void>;
+/**
+ * Returns k/v pairs of server arguments which are _not_ the defaults.
+ * @param {Args} parsedArgs
+ * @returns {Args}
+ */
+export function getNonDefaultServerArgs(parsedArgs: Args): Args;
+/**
+ * @param {boolean} [useGithubApiFallback]
+ * @returns {Promise<string?>}
+ */
+export function getGitRev(useGithubApiFallback?: boolean | undefined): Promise<string | null>;
+export const APPIUM_VER: string;
+/**
+ * @param {boolean} [useGithubApiFallback]
+ */
+export function updateBuildInfo(useGithubApiFallback?: boolean | undefined): Promise<void>;
+/**
+ * Shows a breakdown of the current config after CLI params, config file loaded & defaults applied.
+ *
+ * The actual shape of `preConfigParsedArgs` and `defaults` does not matter for the purposes of this function,
+ * but it's intended to be called with values of type {@link ParsedArgs} and `DefaultValues<true>`, respectively.
+ *
+ * @param {Partial<ParsedArgs>} nonDefaultPreConfigParsedArgs - Parsed CLI args (or param to `init()`) before config & defaults applied
+ * @param {import('./config-file').ReadConfigFileResult} configResult - Result of attempting to load a config file.  _Must_ be normalized
+ * @param {Partial<ParsedArgs>} defaults - Configuration defaults from schemas
+ * @param {ParsedArgs} parsedArgs - Entire parsed args object
+ */
+export function showConfig(nonDefaultPreConfigParsedArgs: Partial<ParsedArgs>, configResult: import('./config-file').ReadConfigFileResult, defaults: Partial<ParsedArgs>, parsedArgs: ParsedArgs): void;
+export const rootDir: string;
+//# sourceMappingURL=config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../lib/config.js"],"names":[],"mappings":"AAuJA,4CAOC;yBAyLY,OAAO,cAAc,EAAE,UAAU;mBACjC,OAAO,cAAc,EAAE,IAAI;;AArNxC;;;;;;GAMG;AACH,gCAFa,OAAO,cAAc,EAAE,SAAS,CAI5C;AAED,oCAOC;AAwBD,+CAGC;AAhBD,6CAWC;AA6ID;;GAEG;AACH,uCAFW,MAAM,iBAWhB;AAlJD;;;;GAIG;AACH,oDAHW,IAAI,GACF,IAAI,CAmFhB;AAtMD;;;GAGG;AACH,uEAFa,QAAQ,MAAM,QAAE,CA6B5B;AAtFD,gCAAsC;AA6BtC;;GAEG;AACH,2FAUC;AAmOD;;;;;;;;;;GAUG;AACH,0DALW,QAAQ,UAAU,CAAC,gBACnB,OAAO,eAAe,EAAE,oBAAoB,YAC5C,QAAQ,UAAU,CAAC,cACnB,UAAU,QAqBpB;AAgBD,6BAAuC"}