appium 3.2.2 → 3.3.1

package/build/lib/schema/cli-args.js

@@ -6,18 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.toParserArgs = toParserArgs;
 const argparse_1 = require("argparse");
 const lodash_1 = __importDefault(require("lodash"));
-const config_file_1 = require("../config-file");
+const format_errors_1 = require("./format-errors");
 const schema_1 = require("./schema");
 const cli_transformers_1 = require("./cli-transformers");
-/**
- * This module concerns functions which convert schema definitions to
- * `argparse`-compatible data structures, for deriving CLI arguments from a
- * schema.
- */
-/**
- * Lookup of possible values for the `type` field in a JSON schema.
- * @type {Readonly<Record<string, import('json-schema').JSONSchema7TypeName>>}
- */
 const TYPENAMES = Object.freeze({
     ARRAY: 'array',
     OBJECT: 'object',
@@ -27,15 +18,17 @@ const TYPENAMES = Object.freeze({
     NULL: 'null',
     STRING: 'string',
 });
+const SHORT_ARG_CUTOFF = 3;
 /**
- * Options with alias lengths less than this will be considered "short" flags.
+ * Converts the finalized, flattened schema representation into
+ * `ArgumentDefinitions` for handoff to `argparse`.
  */
-const SHORT_ARG_CUTOFF = 3;
+function toParserArgs() {
+    const flattened = (0, schema_1.flattenSchema)().filter(({ schema }) => !schema.appiumCliIgnored);
+    return new Map(lodash_1.default.map(flattened, ({ schema, argSpec }) => subSchemaToArgDef(schema, argSpec)));
+}
 /**
- * Convert an alias (`foo`) to a flag (`--foo`) or a short flag (`-f`).
- * @param {ArgSpec} argSpec - the argument specification
- * @param {string} [alias] - the alias to convert to a flag
- * @returns {string} the flag
+ * Convert an alias (`foo`) to a flag (`--foo`) or short flag (`-f`).
  */
 function aliasToFlag(argSpec, alias) {
     const { extType, extName, name } = argSpec;
@@ -48,37 +41,20 @@ function aliasToFlag(argSpec, alias) {
     }
     return isShort ? `-${arg}` : `--${lodash_1.default.kebabCase(arg)}`;
 }
-/**
- * Converts a string to SCREAMING_SNAKE_CASE
- */
 const screamingSnakeCase = lodash_1.default.flow(lodash_1.default.snakeCase, lodash_1.default.toUpper);
 /**
- * Given unique property name `name`, return a function which validates a value
- * against a property within the schema.
- * @template Coerced
- * @param {ArgSpec} argSpec - Argument name
- * @param {(value: string) => Coerced} [coerce] - Function to coerce to a different
- * primitive
- * @todo See if we can remove `coerce` by allowing Ajv to coerce in its
- * constructor options
- * @returns
+ * Given an argument spec, return a validator/coercer function backed by schema validation.
  */
 function getSchemaValidator({ ref: schemaId }, coerce = lodash_1.default.identity) {
-    /** @param {string} value */
     return (value) => {
         const coerced = coerce(value);
         const errors = (0, schema_1.validate)(coerced, schemaId);
         if (lodash_1.default.isEmpty(errors)) {
             return coerced;
         }
-        throw new argparse_1.ArgumentTypeError('\n\n' + (0, config_file_1.formatErrors)(errors, value, { schemaId }));
+        throw new argparse_1.ArgumentTypeError('\n\n' + (0, format_errors_1.formatErrors)(errors, value, { schemaId }));
     };
 }
-/**
- * Determine the description for display on the CLI, given the schema.
- * @param {AppiumJSONSchema} schema
- * @returns {string}
- */
 function makeDescription(schema) {
     const { appiumCliDescription, description = '', appiumDeprecated } = schema;
     let desc = appiumCliDescription ?? description;
@@ -87,46 +63,22 @@ function makeDescription(schema) {
     }
     return desc;
 }
-/**
- * Given arg `name`, a JSON schema `subSchema`, and options, return an argument definition
- * as understood by `argparse`.
- * @param {AppiumJSONSchema} subSchema - JSON schema for the option
- * @param {ArgSpec} argSpec - Argument spec tuple
- * @returns {[[string]|[string, string], import('argparse').ArgumentOptions]} Tuple of flag and options
- */
 function subSchemaToArgDef(subSchema, argSpec) {
-    let { type, appiumCliAliases, appiumCliTransformer, enum: enumValues } = subSchema;
+    const { type, appiumCliAliases, appiumCliTransformer, enum: enumValues } = subSchema;
     const { name, arg } = argSpec;
     const aliases = [
         aliasToFlag(argSpec),
-        ... /** @type {string[]} */(appiumCliAliases ?? []).map((alias) => aliasToFlag(argSpec, alias)),
+        ...(appiumCliAliases ?? []).map((alias) => aliasToFlag(argSpec, alias)),
     ];
-    /** @type {import('argparse').ArgumentOptions} */
-    let argOpts = {
+    const argOpts = {
         required: false,
         help: makeDescription(subSchema),
     };
-    // argparse infers dest from the option string (e.g. --log-level → log_level).
-    // We need schema dest (e.g. loglevel) so merged server args and logsink use the right key.
     if (!argSpec.extType) {
         argOpts.dest = argSpec.rawDest;
     }
-    /**
-     * Generally we will provide a `type` to `argparse` as a function which
-     * validates using ajv (which is much more full-featured than what `argparse`
-     * can offer). The exception is `boolean`-type options, which have no
-     * `argType`.
-     *
-     * Not sure if this type is correct, but it's not doing what I want.  I want
-     * to say "this is a function which returns something of type `T` where `T` is
-     * never a `Promise`".  This function must be sync.
-     * @type {((value: string) => unknown)|undefined}
-     */
     let argTypeFunction;
-    // handle special cases for various types
     switch (type) {
-        // booleans do not have a type per `ArgumentOptions`, just an "action"
-        // NOTE: due to limitations of `argparse`, we cannot provide fancy help text, and must rely on its internal error messaging.
         case TYPENAMES.BOOLEAN: {
             argOpts.action = 'store_const';
             argOpts.const = true;
@@ -134,54 +86,40 @@ function subSchemaToArgDef(subSchema, argSpec) {
         }
         case TYPENAMES.OBJECT: {
             argTypeFunction = lodash_1.default.flow(cli_transformers_1.transformers.json, (o) => {
-                // Arrays and plain strings are also valid JSON
                 if (!lodash_1.default.isPlainObject(o)) {
-                    throw new argparse_1.ArgumentTypeError(`'${lodash_1.default.truncate(o, { length: 100 })}' must be a plain object`);
-                    ;
+                    throw new argparse_1.ArgumentTypeError(`'${lodash_1.default.truncate(String(o), { length: 100 })}' must be a plain object`);
                 }
                 return o;
             });
             break;
         }
-        // arrays are treated as CSVs, because `argparse` doesn't handle array data.
         case TYPENAMES.ARRAY: {
             argTypeFunction = cli_transformers_1.parseCsvLine;
             break;
         }
-        // "number" type is coerced to float. `argparse` does this for us if we use `float` type, but
-        // we don't.
         case TYPENAMES.NUMBER: {
             argTypeFunction = getSchemaValidator(argSpec, parseFloat);
             break;
         }
-        // "integer" is coerced to an .. integer.  again, `argparse` would do this for us if we used `int`.
         case TYPENAMES.INTEGER: {
             argTypeFunction = getSchemaValidator(argSpec, lodash_1.default.parseInt);
             break;
         }
-        // strings (like number and integer) are subject to further validation
-        // (e.g., must satisfy a mask or regex or even some custom validation
-        // function)
         case TYPENAMES.STRING: {
             argTypeFunction = getSchemaValidator(argSpec);
             break;
         }
-        // TODO: there may be some way to restrict this at the Ajv level --
-        // that may involve patching the metaschema.
         case TYPENAMES.NULL:
-        // falls through
         default: {
             throw new TypeError(`Schema property "${arg}": \`${type}\` type unknown or disallowed`);
         }
     }
-    // metavar is used in help text. `boolean` cannot have a metavar--it is not
-    // displayed--and `argparse` throws if you give it one.
     if (type !== TYPENAMES.BOOLEAN) {
         argOpts.metavar = screamingSnakeCase(name);
     }
     if (appiumCliTransformer && cli_transformers_1.transformers[appiumCliTransformer]) {
         if (type === TYPENAMES.ARRAY) {
-            const csvTransformer = /** @type {(x: string) => string[]} */ (argTypeFunction);
+            const csvTransformer = argTypeFunction;
             argTypeFunction = (val) => lodash_1.default.flatMap(csvTransformer(val).map(cli_transformers_1.transformers[appiumCliTransformer]));
         }
         else {
@@ -191,9 +129,6 @@ function subSchemaToArgDef(subSchema, argSpec) {
     if (argTypeFunction) {
         argOpts.type = argTypeFunction;
     }
-    // convert JSON schema `enum` to `choices`. `enum` can contain any JSON type, but `argparse`
-    // is limited to a single type per arg (I think).  so let's make everything a string.
-    // and might as well _require_ the `type: string` while we're at it.
     if (enumValues && !lodash_1.default.isEmpty(enumValues)) {
         if (type === TYPENAMES.STRING) {
             argOpts.choices = enumValues.map(String);
@@ -202,32 +137,7 @@ function subSchemaToArgDef(subSchema, argSpec) {
             throw new TypeError(`Problem with schema for ${arg}; \`enum\` is only supported for \`type: 'string'\``);
         }
     }
-    // TODO: argparse only accepts the command name and a single alias; any extra aliases
-    // will be silently discarded.
-    const finalAliases = /** @type {[string]|[string, string]} */ (aliases);
+    const finalAliases = aliases;
     return [finalAliases, argOpts];
 }
-/**
- * Converts the finalized, flattened schema representation into
- * ArgumentDefinitions for handoff to `argparse`.
- *
- * @throws If schema has not been added to ajv (via `finalizeSchema()`)
- * @returns {import('../cli/args').ArgumentDefinitions} A map of arrays of
- * aliases to `argparse` arguments; empty if no schema found
- */
-function toParserArgs() {
-    const flattened = (0, schema_1.flattenSchema)().filter(({ schema }) => !schema.appiumCliIgnored);
-    return new Map(lodash_1.default.map(flattened, ({ schema, argSpec }) => subSchemaToArgDef(schema, argSpec)));
-}
-/**
- * @template {string|number} T
- * @typedef {import('ajv/dist/types').FormatValidator<T>} FormatValidator<T>
- */
-/**
- * A JSON 7 schema with our custom keywords.
- * @typedef {import('./keywords').AppiumJSONSchemaKeywords & import('json-schema').JSONSchema7} AppiumJSONSchema
- */
-/**
- * @typedef {import('./arg-spec').ArgSpec} ArgSpec
- */
 //# sourceMappingURL=cli-args.js.map

package/build/lib/schema/cli-args.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli-args.js","sourceRoot":"","sources":["../../../lib/schema/cli-args.js"],"names":[],"mappings":";;;;;AA4OA,oCAGC;AA/OD,uCAA2C;AAC3C,oDAAuB;AACvB,gDAA4C;AAC5C,qCAAiD;AACjD,yDAA8D;AAE9D;;;;GAIG;AAEH;;;GAGG;AACH,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9B,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;CACjB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B;;;;;GAKG;AACH,SAAS,WAAW,CAAC,OAAO,EAAE,KAAK;IACjC,MAAM,EAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAC,GAAG,OAAO,CAAC;IACzC,MAAM,GAAG,GAAG,KAAK,IAAI,IAAI,CAAC;IAC1B,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,GAAG,gBAAgB,CAAC;IAC9C,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;QACvB,OAAO,OAAO;YACZ,CAAC,CAAC,KAAK,OAAO,IAAI,gBAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,GAAG,EAAE;YAC/C,CAAC,CAAC,KAAK,OAAO,IAAI,gBAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,gBAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;IACjE,CAAC;IACD,OAAO,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,gBAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,MAAM,kBAAkB,GAAG,gBAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,SAAS,EAAE,gBAAC,CAAC,OAAO,CAAC,CAAC;AAE1D;;;;;;;;;;GAUG;AACH,SAAS,kBAAkB,CAAC,EAAC,GAAG,EAAE,QAAQ,EAAC,EAAE,MAAM,GAAG,gBAAC,CAAC,QAAQ;IAC9D,4BAA4B;IAC5B,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAA,iBAAQ,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC3C,IAAI,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACtB,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,MAAM,IAAI,4BAAiB,CAAC,MAAM,GAAG,IAAA,0BAAY,EAAC,MAAM,EAAE,KAAK,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC,CAAC;IAChF,CAAC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,MAAM;IAC7B,MAAM,EAAC,oBAAoB,EAAE,WAAW,GAAG,EAAE,EAAE,gBAAgB,EAAC,GAAG,MAAM,CAAC;IAC1E,IAAI,IAAI,GAAG,oBAAoB,IAAI,WAAW,CAAC;IAC/C,IAAI,gBAAgB,EAAE,CAAC;QACrB,IAAI,GAAG,gBAAgB,IAAI,EAAE,CAAC;IAChC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAS,iBAAiB,CAAC,SAAS,EAAE,OAAO;IAC3C,IAAI,EAAC,IAAI,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,IAAI,EAAE,UAAU,EAAC,GAAG,SAAS,CAAC;IAEjF,MAAM,EAAC,IAAI,EAAE,GAAG,EAAC,GAAG,OAAO,CAAC;IAE5B,MAAM,OAAO,GAAG;QACd,WAAW,CAAC,OAAO,CAAC;QACpB,IAAG,uBAAwB,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;KAChG,CAAC;IAEF,iDAAiD;IACjD,IAAI,OAAO,GAAG;QACZ,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC;KACjC,CAAC;IAEF,8EAA8E;IAC9E,2FAA2F;IAC3F,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACrB,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,eAAe,CAAC;IAEpB,yCAAyC;IACzC,QAAQ,IAAI,EAAE,CAAC;QACb,sEAAsE;QACtE,4HAA4H;QAC5H,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;YACvB,OAAO,CAAC,MAAM,GAAG,aAAa,CAAC;YAC/B,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;YACrB,MAAM;QACR,CAAC;QAED,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACtB,eAAe,GAAG,gBAAC,CAAC,IAAI,CAAC,+BAAY,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE;gBAChD,+CAA+C;gBAC/C,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;oBACxB,MAAM,IAAI,4BAAiB,CAAC,IAAI,gBAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAC,MAAM,EAAE,GAAG,EAAC,CAAC,0BAA0B,CAAC,CAAC;oBAAA,CAAC;gBAC3F,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC,CAAC,CAAC;YACH,MAAM;QACR,CAAC;QAED,4EAA4E;QAC5E,KAAK,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YACrB,eAAe,GAAG,+BAAY,CAAC;YAC/B,MAAM;QACR,CAAC;QAED,6FAA6F;QAC7F,YAAY;QACZ,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACtB,eAAe,GAAG,kBAAkB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAC1D,MAAM;QACR,CAAC;QAED,mGAAmG;QACnG,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;YACvB,eAAe,GAAG,kBAAkB,CAAC,OAAO,EAAE,gBAAC,CAAC,QAAQ,CAAC,CAAC;YAC1D,MAAM;QACR,CAAC;QAED,sEAAsE;QACtE,qEAAqE;QACrE,YAAY;QACZ,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACtB,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC9C,MAAM;QACR,CAAC;QAED,mEAAmE;QACnE,4CAA4C;QAC5C,KAAK,SAAS,CAAC,IAAI,CAAC;QACpB,gBAAgB;QAChB,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,SAAS,CAAC,oBAAoB,GAAG,QAAQ,IAAI,+BAA+B,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAED,2EAA2E;IAC3E,uDAAuD;IACvD,IAAI,IAAI,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;QAC/B,OAAO,CAAC,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,IAAI,oBAAoB,IAAI,+BAAY,CAAC,oBAAoB,CAAC,EAAE,CAAC;QAC/D,IAAI,IAAI,KAAK,SAAS,CAAC,KAAK,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,sCAAsC,CAAC,CAAC,eAAe,CAAC,CAAC;YAChF,eAAe,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,gBAAC,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,+BAAY,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;QACpG,CAAC;aAAM,CAAC;YACN,eAAe,GAAG,gBAAC,CAAC,IAAI,CAAC,eAAe,IAAI,gBAAC,CAAC,QAAQ,EAAE,+BAAY,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC9F,CAAC;IACH,CAAC;IAED,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,GAAG,eAAe,CAAC;IACjC,CAAC;IAED,4FAA4F;IAC5F,qFAAqF;IACrF,oEAAoE;IACpE,IAAI,UAAU,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACzC,IAAI,IAAI,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;YAC9B,OAAO,CAAC,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,SAAS,CACjB,2BAA2B,GAAG,qDAAqD,CACpF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,qFAAqF;IACrF,8BAA8B;IAC9B,MAAM,YAAY,GAAG,wCAAwC,CAAC,CAAC,OAAO,CAAC,CAAC;IACxE,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,YAAY;IAC1B,MAAM,SAAS,GAAG,IAAA,sBAAa,GAAE,CAAC,MAAM,CAAC,CAAC,EAAC,MAAM,EAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IACjF,OAAO,IAAI,GAAG,CAAC,gBAAC,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,EAAC,MAAM,EAAE,OAAO,EAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED;;;GAGG;AAEH;;;GAGG;AAEH;;GAEG"}
+{"version":3,"file":"cli-args.js","sourceRoot":"","sources":["../../../lib/schema/cli-args.ts"],"names":[],"mappings":";;;;;AA6BA,oCAKC;AAlCD,uCAAiE;AACjE,oDAAuB;AAEvB,mDAA6C;AAC7C,qCAAiD;AACjD,yDAA8D;AAQ9D,MAAM,SAAS,GAAkD,MAAM,CAAC,MAAM,CAAC;IAC7E,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;CACjB,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B;;;GAGG;AACH,SAAgB,YAAY;IAC1B,MAAM,SAAS,GAAG,IAAA,sBAAa,GAAE,CAAC,MAAM,CAAC,CAAC,EAAC,MAAM,EAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IACjF,OAAO,IAAI,GAAG,CACZ,gBAAC,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,EAAC,MAAM,EAAE,OAAO,EAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,MAA0B,EAAE,OAAO,CAAC,CAAC,CAChG,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,OAAgB,EAAE,KAAc;IACnD,MAAM,EAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAC,GAAG,OAAO,CAAC;IACzC,MAAM,GAAG,GAAG,KAAK,IAAI,IAAI,CAAC;IAC1B,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,GAAG,gBAAgB,CAAC;IAC9C,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;QACvB,OAAO,OAAO;YACZ,CAAC,CAAC,KAAK,OAAO,IAAI,gBAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,GAAG,EAAE;YAC/C,CAAC,CAAC,KAAK,OAAO,IAAI,gBAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,gBAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;IACjE,CAAC;IACD,OAAO,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,gBAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;AACvD,CAAC;AAED,MAAM,kBAAkB,GAAG,gBAAC,CAAC,IAAI,CAAC,gBAAC,CAAC,SAAS,EAAE,gBAAC,CAAC,OAAO,CAAC,CAAC;AAE1D;;GAEG;AACH,SAAS,kBAAkB,CACzB,EAAC,GAAG,EAAE,QAAQ,EAAU,EACxB,SAAqC,gBAAC,CAAC,QAAsC;IAE7E,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAA,iBAAQ,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC3C,IAAI,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACtB,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,MAAM,IAAI,4BAAiB,CAAC,MAAM,GAAG,IAAA,4BAAY,EAAC,MAAM,EAAE,KAAK,EAAE,EAAC,QAAQ,EAAC,CAAC,CAAC,CAAC;IAChF,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,MAAwB;IAC/C,MAAM,EAAC,oBAAoB,EAAE,WAAW,GAAG,EAAE,EAAE,gBAAgB,EAAC,GAAG,MAAM,CAAC;IAC1E,IAAI,IAAI,GAAG,oBAAoB,IAAI,WAAW,CAAC;IAC/C,IAAI,gBAAgB,EAAE,CAAC;QACrB,IAAI,GAAG,gBAAgB,IAAI,EAAE,CAAC;IAChC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,iBAAiB,CAAC,SAA2B,EAAE,OAAgB;IACtE,MAAM,EAAC,IAAI,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,IAAI,EAAE,UAAU,EAAC,GAAG,SAAS,CAAC;IACnF,MAAM,EAAC,IAAI,EAAE,GAAG,EAAC,GAAG,OAAO,CAAC;IAE5B,MAAM,OAAO,GAAG;QACd,WAAW,CAAC,OAAO,CAAC;QACpB,GAAI,CAAC,gBAAgB,IAAI,EAAE,CAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;KACtF,CAAC;IAEF,MAAM,OAAO,GAAoB;QAC/B,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC;KACjC,CAAC;IAEF,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACrB,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAED,IAAI,eAAyD,CAAC;IAE9D,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;YACvB,OAAO,CAAC,MAAM,GAAG,aAAa,CAAC;YAC/B,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;YACrB,MAAM;QACR,CAAC;QACD,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACtB,eAAe,GAAG,gBAAC,CAAC,IAAI,CAAC,+BAAY,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE;gBAChD,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;oBACxB,MAAM,IAAI,4BAAiB,CAAC,IAAI,gBAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAC,MAAM,EAAE,GAAG,EAAC,CAAC,0BAA0B,CAAC,CAAC;gBAClG,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC,CAAC,CAAC;YACH,MAAM;QACR,CAAC;QACD,KAAK,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YACrB,eAAe,GAAG,+BAAY,CAAC;YAC/B,MAAM;QACR,CAAC;QACD,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACtB,eAAe,GAAG,kBAAkB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAC1D,MAAM;QACR,CAAC;QACD,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;YACvB,eAAe,GAAG,kBAAkB,CAAC,OAAO,EAAE,gBAAC,CAAC,QAAQ,CAAC,CAAC;YAC1D,MAAM;QACR,CAAC;QACD,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACtB,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC9C,MAAM;QACR,CAAC;QACD,KAAK,SAAS,CAAC,IAAI,CAAC;QACpB,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,SAAS,CAAC,oBAAoB,GAAG,QAAQ,IAAI,+BAA+B,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAED,IAAI,IAAI,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;QAC/B,OAAO,CAAC,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,IAAI,oBAAoB,IAAI,+BAAY,CAAC,oBAAgD,CAAC,EAAE,CAAC;QAC3F,IAAI,IAAI,KAAK,SAAS,CAAC,KAAK,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,eAA0C,CAAC;YAClE,eAAe,GAAG,CAAC,GAAG,EAAE,EAAE,CACxB,gBAAC,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,+BAAY,CAAC,oBAAgD,CAAC,CAAC,CAAC,CAAC;QACvG,CAAC;aAAM,CAAC;YACN,eAAe,GAAG,gBAAC,CAAC,IAAI,CACtB,eAAe,IAAI,gBAAC,CAAC,QAAQ,EAC7B,+BAAY,CAAC,oBAAgD,CAAC,CACjC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,GAAG,eAAe,CAAC;IACjC,CAAC;IAED,IAAI,UAAU,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACzC,IAAI,IAAI,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;YAC9B,OAAO,CAAC,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,SAAS,CACjB,2BAA2B,GAAG,qDAAqD,CACpF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,YAAY,GAAG,OAAsC,CAAC;IAC5D,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AACjC,CAAC"}

package/build/lib/schema/cli-transformers.d.ts

@@ -1,19 +1,22 @@
 /**
- * This module provides custom keywords for Appium schemas, as well as
- * "transformers" (see `argTransformers` below).
+ * This module provides transformer functions for CLI arguments.
  *
- * Custom keywords are just properties that will appear in a schema (e.g.,
- * `appium-config-schema.js`) beyond what the JSON Schema spec offers.  These
- * are usable by extensions, as well.
+ * Use case: config schemas can accept richer types (arrays/objects), but CLI
+ * values are strings. Transformers convert string input into those richer types.
  */
 /**
  * Splits a CSV string into an array
- * @param {string} value
- * @returns {string[]}
  */
-export function parseCsvLine(value: string): string[];
-export namespace transformers {
-    function csv(csvOrPath: string): string[];
-    function json(jsonOrPath: string): object;
-}
+export declare function parseCsvLine(value: string): string[];
+export declare const transformers: {
+    /**
+     * Given a CSV-style string or pathname, parse it into an array.
+     * The file can also be split on newlines.
+     */
+    readonly csv: (csvOrPath: string) => string[];
+    /**
+     * Parse a string which could be a path to a JSON file or a JSON string.
+     */
+    readonly json: (jsonOrPath: string) => Record<string, any>;
+};
 //# sourceMappingURL=cli-transformers.d.ts.map

package/build/lib/schema/cli-transformers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli-transformers.d.ts","sourceRoot":"","sources":["../../../lib/schema/cli-transformers.js"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AAEH;;;;GAIG;AACH,oCAHW,MAAM,GACJ,MAAM,EAAE,CAOpB;;IAqCM,wBAHM,MAAM,GACJ,MAAM,EAAE,CAuBpB;IAOK,0BAHK,MAAM,GACJ,MAAM,CA0BlB"}
+{"version":3,"file":"cli-transformers.d.ts","sourceRoot":"","sources":["../../../lib/schema/cli-transformers.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAKpD;AAED,eAAO,MAAM,YAAY;IACvB;;;OAGG;8BACc,MAAM,KAAG,MAAM,EAAE;IAsBlC;;OAEG;gCACgB,MAAM,KAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAqBvC,CAAC"}

package/build/lib/schema/cli-transformers.js

@@ -5,17 +5,13 @@ exports.parseCsvLine = parseCsvLine;
 const argparse_1 = require("argparse");
 const node_fs_1 = require("node:fs");
 /**
- * This module provides custom keywords for Appium schemas, as well as
- * "transformers" (see `argTransformers` below).
+ * This module provides transformer functions for CLI arguments.
  *
- * Custom keywords are just properties that will appear in a schema (e.g.,
- * `appium-config-schema.js`) beyond what the JSON Schema spec offers.  These
- * are usable by extensions, as well.
+ * Use case: config schemas can accept richer types (arrays/objects), but CLI
+ * values are strings. Transformers convert string input into those richer types.
  */
 /**
  * Splits a CSV string into an array
- * @param {string} value
- * @returns {string[]}
  */
 function parseCsvLine(value) {
     return value
@@ -23,45 +19,15 @@ function parseCsvLine(value) {
         .map((v) => v.trim())
         .filter(Boolean);
 }
-/**
- * Split a file by newline then calls {@link parseCsvLine} on each line.
- * @param {string} value
- * @returns {string[]}
- */
-function parseCsvFile(value) {
-    return value
-        .split(/\r?\n/)
-        .map((v) => v.trim())
-        .filter(Boolean)
-        .flatMap(parseCsvLine);
-}
-/**
- * Namespace containing _transformers_ for CLI arguments.  "Validators" and
- * "formatters" do not actually modify the value, but these do.
- *
- * Use case is for when the config file can accept e.g., a `string[]`, but the
- * CLI can only take a `string` (as `argparse` seems to be limited in that
- * fashion; it also cannot understand an argument having multiple types).
- *
- * For example, the `csv` transform takes a `string` and returns a `string[]` by
- * splitting it by comma--_or_ if that `string` happens to be a
- * filepath--reading the file as a `.csv`.
- *
- * This contains some copy-pasted code from `lib/cli/parser-helpers.js`, which was
- * obliterated.
- */
 exports.transformers = {
     /**
      * Given a CSV-style string or pathname, parse it into an array.
      * The file can also be split on newlines.
-     * @param {string} csvOrPath
-     * @returns {string[]}
      */
     csv: (csvOrPath) => {
         let csv = csvOrPath;
         let loadedFromFile = false;
-        // since this value could be a single string (no commas) _or_ a pathname, we will need
-        // to attempt to parse it as a file _first_.
+        // Value could be a single CSV token or a filepath; attempt file first.
         if ((0, node_fs_1.existsSync)(csvOrPath)) {
             try {
                 csv = (0, node_fs_1.readFileSync)(csvOrPath, 'utf8');
@@ -83,19 +49,13 @@ exports.transformers = {
     },
     /**
      * Parse a string which could be a path to a JSON file or a JSON string.
-     * @param {string} jsonOrPath
-     * @returns {object}
      */
     json: (jsonOrPath) => {
         let json = jsonOrPath;
         let loadedFromFile = false;
         if ((0, node_fs_1.existsSync)(jsonOrPath)) {
             try {
-                // use synchronous file access, as `argparse` provides no way of either
-                // awaiting or using callbacks. This step happens in startup, in what is
-                // effectively command-line code, so nothing is blocked in terms of
-                // sessions, so holding up the event loop does not incur the usual
-                // drawbacks.
+                // Intentionally sync: argparse type hooks are synchronous.
                 json = (0, node_fs_1.readFileSync)(jsonOrPath, 'utf8');
             }
             catch (err) {
@@ -114,4 +74,14 @@ exports.transformers = {
         }
     },
 };
+/**
+ * Split a file by newline then calls {@link parseCsvLine} on each line.
+ */
+function parseCsvFile(value) {
+    return value
+        .split(/\r?\n/)
+        .map((v) => v.trim())
+        .filter(Boolean)
+        .flatMap(parseCsvLine);
+}
 //# sourceMappingURL=cli-transformers.js.map

package/build/lib/schema/cli-transformers.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli-transformers.js","sourceRoot":"","sources":["../../../lib/schema/cli-transformers.js"],"names":[],"mappings":";;;AAiBA,oCAKC;AAtBD,uCAA2C;AAC3C,qCAAiD;AAEjD;;;;;;;GAOG;AAEH;;;;GAIG;AACH,SAAgB,YAAY,CAAC,KAAK;IAChC,OAAO,KAAK;SACT,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,OAAO,CAAC,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,SAAS,YAAY,CAAC,KAAK;IACzB,OAAO,KAAK;SACT,KAAK,CAAC,OAAO,CAAC;SACd,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,OAAO,CAAC;SACf,OAAO,CAAC,YAAY,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACU,QAAA,YAAY,GAAG;IAC1B;;;;;OAKG;IACH,GAAG,EAAE,CAAC,SAAS,EAAE,EAAE;QACjB,IAAI,GAAG,GAAG,SAAS,CAAC;QACpB,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,sFAAsF;QACtF,4CAA4C;QAC5C,IAAI,IAAA,oBAAU,EAAC,SAAS,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC;gBACH,GAAG,GAAG,IAAA,sBAAY,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YACxC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,IAAI,4BAAiB,CAAC,wBAAwB,SAAS,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YACpF,CAAC;YACD,cAAc,GAAG,IAAI,CAAC;QACxB,CAAC;QACD,IAAI,CAAC;YACH,OAAO,cAAc,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,GAAG,GAAG,cAAc;gBACxB,CAAC,CAAC,0BAA0B,SAAS,uBAAuB;gBAC5D,CAAC,CAAC,uDAAuD,CAAC;YAC5D,MAAM,IAAI,SAAS,CAAC,GAAG,GAAG,qBAAqB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAI,EAAE,CAAC,UAAU,EAAE,EAAE;QACnB,IAAI,IAAI,GAAG,UAAU,CAAC;QACtB,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,IAAI,IAAA,oBAAU,EAAC,UAAU,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC;gBACH,uEAAuE;gBACvE,wEAAwE;gBACxE,mEAAmE;gBACnE,kEAAkE;gBAClE,aAAa;gBACb,IAAI,GAAG,IAAA,sBAAY,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC1C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,IAAI,4BAAiB,CAAC,wBAAwB,UAAU,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YACrF,CAAC;YACD,cAAc,GAAG,IAAI,CAAC;QACxB,CAAC;QACD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,GAAG,GAAG,cAAc;gBACxB,CAAC,CAAC,IAAI,UAAU,wBAAwB;gBACxC,CAAC,CAAC,yCAAyC,CAAC;YAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,GAAG,qBAAqB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;CACF,CAAC"}
+{"version":3,"file":"cli-transformers.js","sourceRoot":"","sources":["../../../lib/schema/cli-transformers.ts"],"names":[],"mappings":";;;AAaA,oCAKC;AAlBD,uCAA2C;AAC3C,qCAAiD;AAEjD;;;;;GAKG;AAEH;;GAEG;AACH,SAAgB,YAAY,CAAC,KAAa;IACxC,OAAO,KAAK;SACT,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,OAAO,CAAC,CAAC;AACrB,CAAC;AAEY,QAAA,YAAY,GAAG;IAC1B;;;OAGG;IACH,GAAG,EAAE,CAAC,SAAiB,EAAY,EAAE;QACnC,IAAI,GAAG,GAAG,SAAS,CAAC;QACpB,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,uEAAuE;QACvE,IAAI,IAAA,oBAAU,EAAC,SAAS,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC;gBACH,GAAG,GAAG,IAAA,sBAAY,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YACxC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,IAAI,4BAAiB,CAAC,wBAAwB,SAAS,MAAO,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;YAC/F,CAAC;YACD,cAAc,GAAG,IAAI,CAAC;QACxB,CAAC;QACD,IAAI,CAAC;YACH,OAAO,cAAc,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,GAAG,GAAG,cAAc;gBACxB,CAAC,CAAC,0BAA0B,SAAS,uBAAuB;gBAC5D,CAAC,CAAC,uDAAuD,CAAC;YAC5D,MAAM,IAAI,SAAS,CAAC,GAAG,GAAG,qBAAsB,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAI,EAAE,CAAC,UAAkB,EAAuB,EAAE;QAChD,IAAI,IAAI,GAAG,UAAU,CAAC;QACtB,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,IAAI,IAAA,oBAAU,EAAC,UAAU,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC;gBACH,2DAA2D;gBAC3D,IAAI,GAAG,IAAA,sBAAY,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC1C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,IAAI,4BAAiB,CAAC,wBAAwB,UAAU,MAAO,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;YAChG,CAAC;YACD,cAAc,GAAG,IAAI,CAAC;QACxB,CAAC;QACD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,GAAG,GAAG,cAAc;gBACxB,CAAC,CAAC,IAAI,UAAU,wBAAwB;gBACxC,CAAC,CAAC,yCAAyC,CAAC;YAC9C,MAAM,IAAI,SAAS,CAAC,GAAG,GAAG,qBAAsB,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;CACO,CAAC;AAEX;;GAEG;AACH,SAAS,YAAY,CAAC,KAAa;IACjC,OAAO,KAAK;SACT,KAAK,CAAC,OAAO,CAAC;SACd,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,OAAO,CAAC;SACf,OAAO,CAAC,YAAY,CAAC,CAAC;AAC3B,CAAC"}

package/build/lib/schema/format-errors.d.ts

@@ -0,0 +1,28 @@
+import { type IOutputError } from '@sidvind/better-ajv-errors';
+import type { ErrorObject } from 'ajv';
+import type { NormalizedAppiumConfig } from '@appium/types';
+/**
+ * The string should be a raw JSON string.
+ */
+export type RawJson = string;
+/**
+ * Options for {@link formatErrors}.
+ */
+export interface FormatConfigErrorsOptions {
+    json?: RawJson;
+    pretty?: boolean;
+    schemaId?: string;
+}
+/**
+ * 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.
+ *
+ * @throws {TypeError} If `errors` is empty
+ */
+export declare function formatErrors(errors?: ErrorObject[], config?: NormalizedAppiumConfig | Record<string, unknown> | string | undefined, opts?: FormatConfigErrorsOptions): string | IOutputError[];
+//# sourceMappingURL=format-errors.d.ts.map

package/build/lib/schema/format-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-errors.d.ts","sourceRoot":"","sources":["../../../lib/schema/format-errors.ts"],"names":[],"mappings":"AAAA,OAAwB,EAAC,KAAK,YAAY,EAAC,MAAM,4BAA4B,CAAC;AAC9E,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,KAAK,CAAC;AACrC,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,eAAe,CAAC;AAG1D;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAC1B,MAAM,GAAE,WAAW,EAAO,EAC1B,MAAM,GAAE,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,SAAc,EAClF,IAAI,GAAE,yBAA8B,GACnC,MAAM,GAAG,YAAY,EAAE,CAQzB"}

package/build/lib/schema/format-errors.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatErrors = formatErrors;
+const better_ajv_errors_1 = __importDefault(require("@sidvind/better-ajv-errors"));
+const schema_1 = require("./schema");
+/**
+ * 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.
+ *
+ * @throws {TypeError} If `errors` is empty
+ */
+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: opts.pretty === false ? 'js' : 'cli',
+    });
+}
+//# sourceMappingURL=format-errors.js.map

package/build/lib/schema/format-errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-errors.js","sourceRoot":"","sources":["../../../lib/schema/format-errors.ts"],"names":[],"mappings":";;;;;AA8BA,oCAYC;AA1CD,mFAA8E;AAG9E,qCAAmC;AAgBnC;;;;;;;;;;GAUG;AACH,SAAgB,YAAY,CAC1B,SAAwB,EAAE,EAC1B,SAAgF,EAAE,EAClF,OAAkC,EAAE;IAEpC,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAC7B,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAC;IAC3D,CAAC;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,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;KAC7C,CAAC,CAAC;AACL,CAAC"}

package/build/lib/schema/index.d.ts

@@ -1,3 +1,5 @@
-export * from "./schema";
-export * from "./cli-args";
+export * from './schema';
+export * from './format-errors';
+export * from './cli-args';
+export * from './cli-args-guards';
 //# sourceMappingURL=index.d.ts.map

package/build/lib/schema/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/schema/index.js"],"names":[],"mappings":""}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/schema/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC"}

package/build/lib/schema/index.js

@@ -15,5 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./schema"), exports);
+__exportStar(require("./format-errors"), exports);
 __exportStar(require("./cli-args"), exports);
+__exportStar(require("./cli-args-guards"), exports);
 //# sourceMappingURL=index.js.map

package/build/lib/schema/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/schema/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/schema/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,kDAAgC;AAChC,6CAA2B;AAC3B,oDAAkC"}

package/build/lib/schema/keywords.d.ts

@@ -1,24 +1,16 @@
+import type { KeywordDefinition } from 'ajv';
+import { transformers } from './cli-transformers';
+export type AppiumCliTransformerName = keyof typeof transformers;
+export interface AppiumJSONSchemaKeywords {
+    appiumCliDest?: string;
+    appiumCliDescription?: string;
+    appiumCliAliases?: string[];
+    appiumCliIgnored?: boolean;
+    appiumCliTransformer?: AppiumCliTransformerName;
+    appiumDeprecated?: boolean;
+}
 /**
  * Collection of keyword definitions to add to the singleton `Ajv` instance.
- * @type {Record<string,KeywordDefinition>}
  */
-export const keywords: Record<string, KeywordDefinition>;
-/**
- * These are the valid values for the `appiumCliTransformer` keyword.
- * Unfortunately, TS cannot infer this in a JS context.  In TS, we'd use
- * `as const` when defining `argTransformers`, then get `keyof typeof argTransformers`. alas.
- */
-export type AppiumCliTransformerName = "csv" | "json";
-/**
- * These are the custom keywords that Appium recognizes.
- */
-export type AppiumJSONSchemaKeywords = {
-    appiumCliDest?: string | undefined;
-    appiumCliDescription?: string | undefined;
-    appiumCliAliases?: string[] | undefined;
-    appiumCliIgnored?: boolean | undefined;
-    appiumCliTransformer?: AppiumCliTransformerName | undefined;
-    appiumDeprecated?: boolean | undefined;
-};
-export type KeywordDefinition = import("ajv").KeywordDefinition;
+export declare const keywords: Record<string, KeywordDefinition>;
 //# sourceMappingURL=keywords.d.ts.map

package/build/lib/schema/keywords.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"keywords.d.ts","sourceRoot":"","sources":["../../../lib/schema/keywords.js"],"names":[],"mappings":"AAEA;;;GAGG;AACH,uBAFU,MAAM,CAAC,MAAM,EAAC,iBAAiB,CAAC,CA4GxC;;;;;;uCAMW,KAAK,GAAC,MAAM;;;;;;;;;;;;gCAgBZ,OAAO,KAAK,EAAE,iBAAiB"}
+{"version":3,"file":"keywords.d.ts","sourceRoot":"","sources":["../../../lib/schema/keywords.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,KAAK,CAAC;AAC3C,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAEhD,MAAM,MAAM,wBAAwB,GAAG,MAAM,OAAO,YAAY,CAAC;AAEjE,MAAM,WAAW,wBAAwB;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;IAChD,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CA8EtD,CAAC"}