appium 3.2.1 → 3.3.0

package/build/lib/schema/arg-spec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"arg-spec.d.ts","sourceRoot":"","sources":["../../../lib/schema/arg-spec.js"],"names":[],"mappings":"AAEA;;;GAGG;AACH,sCAAuC,aAAa,CAAC;AAErD;;;;GAIG;AACH,+BAAgC,QAAQ,CAAC;AAYzC;;;;;;GAMG;AACH,qBAFa,CAAC;IA2FZ;;;;;;;;OAQG;IACH,yBALW,MAAM,YACN,aAAa,YACb,MAAM,GACJ,MAAM,CAQlB;IAED;;;;OAIG;IACH,iCAHW,aAAa,YACb,MAAM,UAOhB;IAED;;;;;;OAMG;IACH,mBALW,MAAM,YACN,aAAa,YACb,MAAM,GACJ,MAAM,CAQlB;IAED;;;;OAIG;IACH,oCAHW,MAAM,GACJ,MAAM,CAIlB;IAED;;;;OAIG;IACH,+CAHW,MAAM,GACH;QAAC,OAAO,CAAC,EAAE,aAAa,CAAC;QAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAAC,CAUlE;IAED;;;;;;;;OAQG;IACH,yBANW,MAAM,SAGN,cAAc,CAAC,GAAC,CAAC,GACf,QAAQ,cAAS,CAI7B;IAhHD;;;;;;;;;OASG;IACH,sBAqBC;IAtFD;;;OAGG;IACH,MAFU,MAAM,CAEX;IAEL;;;;OAIG;IACH,SAFU,aAAa,GAAC,SAAS,CAEzB;IAER;;;;;OAKG;IACH,SAFU,MAAM,GAAC,SAAS,CAElB;IAER;;;;OAIG;IACH,KAFU,MAAM,CAEZ;IAEJ;;;OAGG;IACH,KAFU,MAAM,CAEZ;IAEJ;;;;;;OAMG;IACH,MAFU,MAAM,CAEX;IAEL;;OAEG;IACH,gBAAQ;IAER;;;;OAIG;IACH,cAFU,CAAC,GAAC,SAAS,CAER;IAoHb;;;OAGG;IAEH,YAHa,MAAM,CASlB;CACF;;;;2BAIY,CAAC;;;;;;4BASD,OAAO,eAAe,EAAE,aAAa"}
+{"version":3,"file":"arg-spec.d.ts","sourceRoot":"","sources":["../../../lib/schema/arg-spec.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,eAAe,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,uBAAuB,gBAAgB,CAAC;AACrD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,WAAW,CAAC;AAIzC,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,OAAO;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,CAAC,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,OAAO,CAAC,CAAC,GAAG,OAAO;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IAE1B;;;OAGG;gBACS,IAAI,EAAE,MAAM,EAAE,EAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAC,GAAE,cAAc,CAAC,CAAC,CAAM;IAgBxF;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM;IAQnF;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM;IAOzE;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM;IAQ7E;;OAEG;IACH,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAInD;;OAEG;IACH,MAAM,CAAC,6BAA6B,CAClC,QAAQ,EAAE,MAAM,GACf;QAAC,OAAO,CAAC,EAAE,aAAa,CAAC;QAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAAC;IAYxD;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAIxF,QAAQ,IAAI,MAAM;CAOnB"}

package/build/lib/schema/arg-spec.js

@@ -13,89 +13,33 @@ exports.APPIUM_CONFIG_SCHEMA_ID = 'appium.json';
 /**
  * The schema prop containing server-related options. Everything in here
  * is "native" to Appium.
- * Used by {@link flattenSchema} for transforming the schema into CLI args.
  */
 exports.SERVER_PROP_NAME = 'server';
-/**
- * Used to parse extension info from a schema ID.
- */
 const SCHEMA_ID_REGEXP = /^(?<extType>.+?)-(?<normalizedExtName>.+)\.json$/;
-/**
- * Avoid typos by using constants!
- */
 const PROPERTIES = 'properties';
 /**
  * An `ArgSpec` is a class representing metadata about an argument (or config
  * option) used for cross-referencing.
  *
- * This class has no instance methods, and is basically just a read-only "struct".
- * @template D
+ * This class has no instance methods beyond stringification and is effectively
+ * a read-only struct.
  */
 class ArgSpec {
-    /**
-     * The canonical name of the argument. Corresponds to key in schema's `properties` prop.
-     * @type {string}
-     */
     name;
-    /**
-     * The `ExtensionType` of the argument. This will be set if the arg came from an extension;
-     * otherwise it will be `undefined`.
-     * @type {ExtensionType|undefined}
-     */
     extType;
-    /**
-     * The name of the extension, if this argument came from an extension.
-     *
-     * Otherwise `undefined`.
-     * @type {string|undefined}
-     */
     extName;
-    /**
-     * The schema ID (`$id`) for the argument.  This is automatically determined, and any user-provided `$id`s will be overwritten.
-     *
-     * @type {string}
-     */
     ref;
-    /**
-     * The CLI argument, sans leading dashes.
-     * @type {string}
-     */
     arg;
-    /**
-     * The desired keypath for the argument after arguments have been parsed.
-     *
-     * Typically this is camelCased.  If the arg came from an extension, it will be prefixed with
-     * `<extType>.<extName>.`
-     * @type {string}
-     */
     dest;
-    /**
-     * The same as {@link ArgSpec.dest} but without the leading `<extType>.<extName>.` prefix.
-     */
     rawDest;
-    /**
-     * Whatever the default value of this argument is, as specified by the
-     * `default` property of the schema.
-     * @type {D|undefined}
-     */
     defaultValue;
     /**
-     * Builds some computed fields and assigns them to the instance.
-     *
-     * Undefined properties are not assigned.
-     *
-     * The _constructor_ is private. Use {@link ArgSpec.create} instead.
-     * @private
-     * @param {string} name
-     * @param {ArgSpecOptions<D>} opts
+     * Builds computed fields and assigns them to the instance.
+     * Use {@link ArgSpec.create} instead of `new ArgSpec()`.
      */
     constructor(name, { extType, extName, dest, defaultValue } = {}) {
-        // we must normalize the extension name to fit into our convention for CLI
-        // args.
         const arg = ArgSpec.toArg(name, extType, extName);
         const ref = ArgSpec.toSchemaRef(name, extType, extName);
-        // if no explicit `dest` provided, just camelCase the name to avoid needing
-        // to use bracket syntax when accessing props on the parsed args object.
         const rawDest = lodash_1.default.camelCase(dest ?? name);
         const destKeypath = extType && extName ? [extType, extName, rawDest].join('.') : rawDest;
         this.defaultValue = defaultValue;
@@ -108,13 +52,7 @@ class ArgSpec {
         this.rawDest = rawDest;
     }
     /**
-     * Return the schema ID (`$id`) for the **argument** given the parameters.
-     *
-     * If you need the "root" or "base" schema ID, use {@link ArgSpec.toSchemaBaseRef} instead.
-     * @param {string} name - Argument name
-     * @param {ExtensionType} [extType] - Extension type
-     * @param {string} [extName] - Extension name
-     * @returns {string} Schema ID
+     * Return the schema ID (`$id`) for the argument given the parameters.
      */
     static toSchemaRef(name, extType, extName) {
         const baseRef = ArgSpec.toSchemaBaseRef(extType, extName);
@@ -124,9 +62,7 @@ class ArgSpec {
         return [`${baseRef}#`, PROPERTIES, exports.SERVER_PROP_NAME, PROPERTIES, name].join('/');
     }
     /**
-     * Return the schema ID for an extension or the base schema ID.
-     * @param {ExtensionType} [extType] - Extension type
-     * @param {string} [extName] - Extension name
+     * Return the root schema ID for an extension or Appium base schema.
      */
     static toSchemaBaseRef(extType, extName) {
         if (extType && extName) {
@@ -135,11 +71,7 @@ class ArgSpec {
         return exports.APPIUM_CONFIG_SCHEMA_ID;
     }
     /**
-     * Return the unique ID for the argument given the parameters.
-     * @param {string} name - Argument name
-     * @param {ExtensionType} [extType] - Extension type
-     * @param {string} [extName] - Extension name
-     * @returns {string} Unique ID
+     * Return the unique CLI argument key for the argument.
      */
     static toArg(name, extType, extName) {
         const properName = lodash_1.default.kebabCase(name.replace(/^--?/, ''));
@@ -149,44 +81,28 @@ class ArgSpec {
         return properName;
     }
     /**
-     * Normalizes a raw extension name (not including the type).
-     * @param {string} extName - Extension name
-     * @returns {string} Normalized extension name
+     * Normalizes a raw extension name (not including type).
      */
     static toNormalizedExtName(extName) {
         return lodash_1.default.kebabCase(extName);
     }
     /**
-     * When given the root ID of a schema for an extension (`<extType>-<normalizedExtName>.json`) Returns an object containing the extension type and the _normalized_ extension name.
-     * @param {string} schemaId - Root schema ID
-     * @returns { {extType?: ExtensionType, normalizedExtName?: string} }
+     * Parse root schema ID (`<extType>-<normalizedExtName>.json`) to extension info.
      */
     static extensionInfoFromRootSchemaId(schemaId) {
         const matches = schemaId.match(SCHEMA_ID_REGEXP);
         if (matches?.groups) {
-            const { extType, normalizedExtName } = 
-            /** @type { {extType: ExtensionType, normalizedExtName: string} } */ (matches.groups);
+            const { extType, normalizedExtName } = matches.groups;
             return { extType, normalizedExtName };
         }
         return {};
     }
     /**
-     * Creates an `ArgSpec`
-     *
-     * @param {string} name - The canonical name of the argument. Corresponds to a key in a schema's
-     * `properties` property.
-     * @template D
-     * @param {ArgSpecOptions<D>} [opts] - Options
-     * @returns {Readonly<ArgSpec>}
+     * Creates a frozen `ArgSpec`.
      */
     static create(name, opts) {
         return Object.freeze(new ArgSpec(name, opts));
     }
-    /**
-     * String representation, useful for debugging
-     * @returns {string}
-     */
-    /* istanbul ignore next */
     toString() {
         let str = `[ArgSpec] ${this.name} (${this.ref})`;
         if (this.extType && this.extName) {
@@ -196,16 +112,4 @@ class ArgSpec {
     }
 }
 exports.ArgSpec = ArgSpec;
-/**
- * Options for {@link ArgSpec.create}
- * @template D
- * @typedef ArgSpecOptions
- * @property {string} [extName]
- * @property {ExtensionType} [extType]
- * @property {string} [dest]
- * @property {D} [defaultValue]
- */
-/**
- * @typedef {import('@appium/types').ExtensionType} ExtensionType
- */
 //# sourceMappingURL=arg-spec.js.map

package/build/lib/schema/arg-spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"arg-spec.js","sourceRoot":"","sources":["../../../lib/schema/arg-spec.js"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAEvB;;;GAGG;AACU,QAAA,uBAAuB,GAAG,aAAa,CAAC;AAErD;;;;GAIG;AACU,QAAA,gBAAgB,GAAG,QAAQ,CAAC;AAEzC;;GAEG;AACH,MAAM,gBAAgB,GAAG,kDAAkD,CAAC;AAE5E;;GAEG;AACH,MAAM,UAAU,GAAG,YAAY,CAAC;AAEhC;;;;;;GAMG;AACH,MAAa,OAAO;IAClB;;;OAGG;IACH,IAAI,CAAC;IAEL;;;;OAIG;IACH,OAAO,CAAC;IAER;;;;;OAKG;IACH,OAAO,CAAC;IAER;;;;OAIG;IACH,GAAG,CAAC;IAEJ;;;OAGG;IACH,GAAG,CAAC;IAEJ;;;;;;OAMG;IACH,IAAI,CAAC;IAEL;;OAEG;IACH,OAAO,CAAC;IAER;;;;OAIG;IACH,YAAY,CAAC;IAEb;;;;;;;;;OASG;IACH,YAAY,IAAI,EAAE,EAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAC,GAAG,EAAE;QAC3D,0EAA0E;QAC1E,QAAQ;QACR,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAElD,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAExD,2EAA2E;QAC3E,wEAAwE;QACxE,MAAM,OAAO,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;QAE1C,MAAM,WAAW,GAAG,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAEzF,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO;QACvC,MAAM,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC1D,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,OAAO,GAAG,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,CAAC,GAAG,OAAO,GAAG,EAAE,UAAU,EAAE,wBAAgB,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO;QACrC,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACvB,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC;QACnE,CAAC;QACD,OAAO,+BAAuB,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO;QACjC,MAAM,UAAU,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;QACzD,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACvB,OAAO,CAAC,OAAO,EAAE,gBAAC,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,OAAO;QAChC,OAAO,gBAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,6BAA6B,CAAC,QAAQ;QAC3C,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACjD,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,MAAM,EAAC,OAAO,EAAE,iBAAiB,EAAC;YAChC,oEAAoE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACxF,OAAO,EAAC,OAAO,EAAE,iBAAiB,EAAC,CAAC;QACtC,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI;QACtB,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACH,0BAA0B;IAC1B,QAAQ;QACN,IAAI,GAAG,GAAG,aAAa,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,GAAG,GAAG,CAAC;QACjD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,GAAG,IAAI,UAAU,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC;QACnD,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAtLD,0BAsLC;AAED;;;;;;;;GAQG;AAEH;;GAEG"}
+{"version":3,"file":"arg-spec.js","sourceRoot":"","sources":["../../../lib/schema/arg-spec.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAGvB;;;GAGG;AACU,QAAA,uBAAuB,GAAG,aAAa,CAAC;AACrD;;;GAGG;AACU,QAAA,gBAAgB,GAAG,QAAQ,CAAC;AACzC,MAAM,gBAAgB,GAAG,kDAAkD,CAAC;AAC5E,MAAM,UAAU,GAAG,YAAY,CAAC;AAShC;;;;;;GAMG;AACH,MAAa,OAAO;IACT,IAAI,CAAS;IACb,OAAO,CAAiB;IACxB,OAAO,CAAU;IACjB,GAAG,CAAS;IACZ,GAAG,CAAS;IACZ,IAAI,CAAS;IACb,OAAO,CAAS;IAChB,YAAY,CAAK;IAE1B;;;OAGG;IACH,YAAY,IAAY,EAAE,EAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,KAAuB,EAAE;QACtF,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACxD,MAAM,OAAO,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;QAC1C,MAAM,WAAW,GAAG,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAEzF,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,IAAY,EAAE,OAAuB,EAAE,OAAgB;QACxE,MAAM,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC1D,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,OAAO,GAAG,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,CAAC,GAAG,OAAO,GAAG,EAAE,UAAU,EAAE,wBAAgB,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,OAAuB,EAAE,OAAgB;QAC9D,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACvB,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC;QACnE,CAAC;QACD,OAAO,+BAAuB,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,IAAY,EAAE,OAAuB,EAAE,OAAgB;QAClE,MAAM,UAAU,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;QACzD,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;YACvB,OAAO,CAAC,OAAO,EAAE,gBAAC,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,mBAAmB,CAAC,OAAe;QACxC,OAAO,gBAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,6BAA6B,CAClC,QAAgB;QAEhB,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACjD,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,MAAM,EAAC,OAAO,EAAE,iBAAiB,EAAC,GAAG,OAAO,CAAC,MAG5C,CAAC;YACF,OAAO,EAAC,OAAO,EAAE,iBAAiB,EAAC,CAAC;QACtC,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAM,CAAc,IAAY,EAAE,IAAwB;QAC/D,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,QAAQ;QACN,IAAI,GAAG,GAAG,aAAa,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,GAAG,GAAG,CAAC;QACjD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,GAAG,IAAI,UAAU,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC;QACnD,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AApGD,0BAoGC"}

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

@@ -1,19 +1,7 @@
+import type { ArgumentDefinitions } from '../cli/args';
 /**
  * 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
+ * `ArgumentDefinitions` for handoff to `argparse`.
  */
-export function toParserArgs(): import("../cli/args").ArgumentDefinitions;
-/**
- * <T>
- */
-export type FormatValidator<T extends string | number> = import("ajv/dist/types").FormatValidator<T>;
-/**
- * A JSON 7 schema with our custom keywords.
- */
-export type AppiumJSONSchema = import("./keywords").AppiumJSONSchemaKeywords & import("json-schema").JSONSchema7;
-export type ArgSpec = import("./arg-spec").ArgSpec<any>;
+export declare function toParserArgs(): ArgumentDefinitions;
 //# sourceMappingURL=cli-args.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"cli-args.d.ts","sourceRoot":"","sources":["../../../lib/schema/cli-args.js"],"names":[],"mappings":"AAoOA;;;;;;;GAOG;AACH,gCAHa,OAAO,aAAa,EAAE,mBAAmB,CAMrD;;;;4BAG4B,CAAC,SAAhB,MAAM,GAAC,MAAO,IACf,OAAO,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC;;;;+BAK3C,OAAO,YAAY,EAAE,wBAAwB,GAAG,OAAO,aAAa,EAAE,WAAW"}
+{"version":3,"file":"cli-args.d.ts","sourceRoot":"","sources":["../../../lib/schema/cli-args.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAiBrD;;;GAGG;AACH,wBAAgB,YAAY,IAAI,mBAAmB,CAKlD"}

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

@@ -9,15 +9,6 @@ const lodash_1 = __importDefault(require("lodash"));
 const config_file_1 = require("../config-file");
 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,23 +41,11 @@ 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);
@@ -74,11 +55,6 @@ function getSchemaValidator({ ref: schemaId }, coerce = lodash_1.default.identit
         throw new argparse_1.ArgumentTypeError('\n\n' + (0, config_file_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,gDAA4C;AAC5C,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,0BAAY,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