appium 2.0.0-beta.26 → 2.0.0-beta.29

package/lib/extension/driver-config.js

@@ -1,4 +1,3 @@
-// @ts-check
 
 import _ from 'lodash';
 import { DRIVER_TYPE } from '../constants';
@@ -80,7 +79,7 @@ export class DriverConfig extends ExtensionConfig {
    }
 
    /**
-   * @param {ManifestDriverData} extData
+   * @param {ExtManifest<DriverType>} extData
    * @returns {import('./extension-config').Problem[]}
    */
    getConfigProblems (extData) {
@@ -126,7 +125,7 @@ export class DriverConfig extends ExtensionConfig {
 
    /**
    * @param {ExtName<DriverType>} driverName
-   * @param {ManifestDriverData} extData
+   * @param {ExtManifest<DriverType>} extData
    * @returns {string}
    */
    extensionDesc (driverName, {version, automationName}) {
@@ -135,8 +134,8 @@ export class DriverConfig extends ExtensionConfig {
 
    /**
    * Given capabilities, find a matching driver within the config. Load its class and return it along with version and driver name.
-   * @param { { automationName: string, platformName: string } } caps
-   * @returns { { driver: import('./manifest').DriverClass, version: string, driverName: string } }
+   * @param {Capabilities} caps
+   * @returns {MatchedDriver}
    */
    findMatchingDriver ({automationName, platformName}) {
      if (!_.isString(platformName)) {
@@ -177,7 +176,7 @@ export class DriverConfig extends ExtensionConfig {
    * Given an automation name and platform name, find a suitable driver and return its extension data.
    * @param {string} matchAutomationName
    * @param {string} matchPlatformName
-   * @returns {ManifestDriverData & { driverName: string } }
+   * @returns {ExtMetadata<DriverType> & import('../../types/appium-manifest').InternalMetadata & import('../../types/external-manifest').CommonMetadata}
    */
    _getDriverBySupport (matchAutomationName, matchPlatformName) {
      const drivers = this.installedExtensions;
@@ -211,20 +210,40 @@ export class DriverConfig extends ExtensionConfig {
  */
 
 /**
- * @typedef {import('./manifest').ExternalData<DriverType>} ExternalDriverData
- * @typedef {import('./manifest').ManifestDriverData} ManifestDriverData
- * @typedef {import('./manifest').ManifestData} ManifestData
- * @typedef {import('./manifest').DriverType} DriverType
+ * @template T
+ * @typedef {import('../../types').ExtMetadata<T>} ExtMetadata
+ */
+
+/**
+ * @template T
+ * @typedef {import('../../types').ExtManifest<T>} ExtManifest
+ */
+
+/**
+ * @typedef {import('../../types').ManifestData} ManifestData
+ * @typedef {import('../../types').DriverType} DriverType
  * @typedef {import('./manifest').Manifest} Manifest
  */
 
 /**
  * @template T
- * @typedef {import('./extension-config').ExtRecord<T>} ExtRecord
+ * @typedef {import('../../types').ExtRecord<T>} ExtRecord
  */
 
 /**
  * @template T
- * @typedef {import('./extension-config').ExtName<T>} ExtName
+ * @typedef {import('../../types').ExtName<T>} ExtName
  */
 
+
+/**
+ * Return value of {@linkcode DriverConfig.findMatchingDriver}
+ * @typedef MatchedDriver
+ * @property {import('../../types/extension').DriverClass} driver
+ * @property {string} version
+ * @property {string} driverName
+ */
+
+/**
+ * @typedef {import('@appium/types').Capabilities} Capabilities
+ */

package/lib/extension/extension-config.js

@@ -1,4 +1,3 @@
-// @ts-check
 
 import _ from 'lodash';
 import path from 'path';
@@ -78,7 +77,7 @@ export class ExtensionConfig {
     for (const [
       extName,
       extData,
-    ] of /** @type {[ExtName<ExtType>, ExtData<ExtType>][]} */ (
+    ] of /** @type {[ExtName<ExtType>, ExtManifest<ExtType>][]} */ (
         _.toPairs(exts)
       )) {
       foundProblems[extName] = [
@@ -121,7 +120,7 @@ export class ExtensionConfig {
   }
 
   /**
-   * @param {ExtData<ExtType>} extData
+   * @param {ExtManifest<ExtType>} extData
    * @param {ExtName<ExtType>} extName
    * @returns {Problem[]}
    */
@@ -167,7 +166,7 @@ export class ExtensionConfig {
   }
 
   /**
-   * @param {ExtData<ExtType>} extData
+   * @param {ExtManifest<ExtType>} extData
    * @param {ExtName<ExtType>} extName
    * @returns {Problem[]}
    */
@@ -214,7 +213,7 @@ export class ExtensionConfig {
 
   /**
    * @abstract
-   * @param {ExtData<ExtType>} extData
+   * @param {ExtManifest<ExtType>} extData
    * @returns {Problem[]}
    */
   // eslint-disable-next-line no-unused-vars
@@ -225,12 +224,12 @@ export class ExtensionConfig {
 
   /**
    * @param {string} extName
-   * @param {ExtData<ExtType>} extData
+   * @param {ExtManifest<ExtType>} extData
    * @param {ExtensionConfigMutationOpts} [opts]
    * @returns {Promise<void>}
    */
   async addExtension (extName, extData, {write = true} = {}) {
-    await this.manifest.addExtension(this.extensionType, extName, extData);
+    this.manifest.addExtension(this.extensionType, extName, extData);
     if (write) {
       await this.manifest.write();
     }
@@ -238,7 +237,7 @@ export class ExtensionConfig {
 
   /**
    * @param {ExtName<ExtType>} extName
-   * @param {ExtData<ExtType>} extData
+   * @param {ExtManifest<ExtType>|import('../cli/extension-command').ExtensionFields<ExtType>} extData
    * @param {ExtensionConfigMutationOpts} [opts]
    * @returns {Promise<void>}
    */
@@ -282,7 +281,7 @@ export class ExtensionConfig {
     for (const [
       extName,
       extData,
-    ] of /** @type {[string, ExtData<ExtType>][]} */ (
+    ] of /** @type {[string, ExtManifest<ExtType>][]} */ (
         _.toPairs(this.installedExtensions)
       )) {
       log.info(`  - ${this.extensionDesc(extName, extData)}`);
@@ -292,7 +291,7 @@ export class ExtensionConfig {
   /**
    * Returns a string describing the extension. Subclasses must implement.
    * @param {ExtName<ExtType>} extName - Extension name
-   * @param {ExtData<ExtType>} extData - Extension data
+   * @param {ExtManifest<ExtType>} extData - Extension data
    * @returns {string}
    * @abstract
    */
@@ -342,7 +341,7 @@ export class ExtensionConfig {
    * @param {string} appiumHome
    * @param {ExtType} extType
    * @param {ExtName<ExtType>} extName - Extension name (unique to its type)
-   * @param {ExtDataWithSchema<ExtType>} extData - Extension config
+   * @param {ExtManifestWithSchema<ExtType>} extData - Extension config
    * @returns {import('ajv').SchemaObject|undefined}
    */
   static _readExtensionSchema (appiumHome, extType, extName, extData) {
@@ -368,11 +367,11 @@ export class ExtensionConfig {
   }
 
   /**
-   * Returns `true` if a specific {@link ExtData} object has a `schema` prop.
-   * The {@link ExtData} object becomes a {@link ExtDataWithSchema} object.
+   * Returns `true` if a specific {@link ExtManifest} object has a `schema` prop.
+   * The {@link ExtManifest} object becomes a {@link ExtManifestWithSchema} object.
    * @template {ExtensionType} ExtType
-   * @param {ExtData<ExtType>} extData
-   * @returns {extData is ExtDataWithSchema<ExtType>}
+   * @param {ExtManifest<ExtType>} extData
+   * @returns {extData is ExtManifestWithSchema<ExtType>}
    */
   static extDataHasSchema (extData) {
     return _.isString(extData?.schema) || _.isObject(extData?.schema);
@@ -382,7 +381,7 @@ export class ExtensionConfig {
    * If an extension provides a schema, this will load the schema and attempt to
    * register it with the schema registrar.
    * @param {ExtName<ExtType>} extName - Name of extension
-   * @param {ExtDataWithSchema<ExtType>} extData - Extension data
+   * @param {ExtManifestWithSchema<ExtType>} extData - Extension data
    * @returns {import('ajv').SchemaObject|undefined}
    */
   readExtensionSchema (extName, extData) {
@@ -418,33 +417,33 @@ export {
  */
 
 /**
- * @typedef {import('./manifest').ExtensionType} ExtensionType
+ * @typedef {import('../../types').ExtensionType} ExtensionType
  * @typedef {import('./manifest').Manifest} Manifest
  */
 
 /**
  * @template T
- * @typedef {import('./manifest').ExtData<T>} ExtData
+ * @typedef {import('../../types/appium-manifest').ExtManifest<T>} ExtManifest
  */
 
 /**
  * @template T
- * @typedef {import('./manifest').ExtDataWithSchema<T>} ExtDataWithSchema
+ * @typedef {import('../../types/appium-manifest').ExtManifestWithSchema<T>} ExtManifestWithSchema
  */
 
 /**
  * @template T
- * @typedef {import('./manifest').ExtName<T>} ExtName
+ * @typedef {import('../../types/appium-manifest').ExtName<T>} ExtName
  */
 
 /**
  * @template T
- * @typedef {import('./manifest').ExtClass<T>} ExtClass
+ * @typedef {import('../../types/extension').ExtClass<T>} ExtClass
  */
 
 /**
  * @template T
- * @typedef {import('./manifest').ExtRecord<T>} ExtRecord
+ * @typedef {import('../../types/appium-manifest').ExtRecord<T>} ExtRecord
  */
 
 /**

package/lib/extension/index.js

@@ -1,4 +1,3 @@
-// @ts-check
 
 import _ from 'lodash';
 import { USE_ALL_PLUGINS } from '../constants';
@@ -38,7 +37,7 @@ export async function loadExtensions (appiumHome) {
  *
  * @param {import('./plugin-config').PluginConfig} pluginConfig - a plugin extension config
  * @param {string[]} usePlugins
- * @returns {import('./manifest').PluginClass[]}
+ * @returns {import('../../types').PluginClass[]}
  */
 export function getActivePlugins (pluginConfig, usePlugins = []) {
   return _.compact(

package/lib/extension/manifest.js

@@ -1,4 +1,4 @@
-// @ts-check
+/// <reference path="../../types/appium-manifest.d.ts" />
 
 /**
  * Module containing {@link Manifest} which handles reading & writing of extension config files.
@@ -61,7 +61,7 @@ const INITIAL_MANIFEST_DATA = Object.freeze({
  *
  * The `package.json` must have an `appium` property which is an object.
  * @param {any} value
- * @returns {value is ExtensionPackageJson<ExtensionType>}
+ * @returns {value is ExtPackageJson<ExtensionType>}
  */
 function isExtension (value) {
   return (
@@ -77,7 +77,7 @@ function isExtension (value) {
  * To be considered a driver, a `package.json` must have a fields
  * `appium.driverName`, `appium.automationName` and `appium.platformNames`.
  * @param {any} value - Value to test
- * @returns {value is ExtensionPackageJson<DriverType>}
+ * @returns {value is ExtPackageJson<DriverType>}
  */
 function isDriver (value) {
   return (
@@ -93,7 +93,7 @@ function isDriver (value) {
  *
  * To be considered a plugin, a `package.json` must have an `appium.pluginName` field.
  * @param {any} value - Value to test
- * @returns {value is ExtensionPackageJson<PluginType>}
+ * @returns {value is ExtPackageJson<PluginType>}
  */
 function isPlugin (value) {
   return isExtension(value) && _.isString(_.get(value, 'appium.pluginName'));
@@ -231,13 +231,13 @@ export class Manifest {
    *
    * Will _not_ overwrite existing entries.
    * @template {ExtensionType} ExtType
-   * @param {ExtensionPackageJson<ExtType>} pkgJson
+   * @param {ExtPackageJson<ExtType>} pkgJson
    * @param {string} pkgPath
    * @returns {boolean} - `true` upon success, `false` if the extension is already registered.
    */
   addExtensionFromPackage (pkgJson, pkgPath) {
     /**
-     * @type {InternalData}
+     * @type {InternalMetadata}
      */
     const internal = {
       pkgName: pkgJson.name,
@@ -281,7 +281,7 @@ export class Manifest {
    * @template {ExtensionType} ExtType
    * @param {ExtType} extType - `driver` or `plugin`
    * @param {string} extName - Name of extension
-   * @param {ExtData<ExtType>} extData - Extension metadata
+   * @param {ExtManifest<ExtType>} extData - Extension metadata
    * @returns {void}
    */
   addExtension (extType, extName, extData) {
@@ -445,146 +445,42 @@ export class Manifest {
 }
 
 /**
- * Either `driver` or `plugin` rn
- * @typedef {typeof DRIVER_TYPE | typeof PLUGIN_TYPE} ExtensionType
- */
-
-/**
- * Represents an entire YAML manifest (`extensions.yaml`)
- * @typedef ManifestData
- * @property {ExtRecord<DriverType>} drivers - Record of drivers, keyed by name
- * @property {ExtRecord<PluginType>} plugins - Record of plugins, keyed by name
- * @property {number} [schemaRev] - The schema revision of the manifest
- */
-
-/**
- * Combination of external + internal extension data with `driverName`/`pluginName` removed (it becomes a key in an {@link ExtRecord} object).
- * @template {ExtensionType} ExtType
- * @typedef {(Omit<ExternalData<ExtType>, ExtType extends DriverType ? 'driverName' : 'pluginName'>) & InternalData & CommonData} ExtensionManifest
- */
-
-/**
- * Manifest extension data which is _not_ provided in `package.json`.  It may be derived
- * (e.g., `installSpec`) or copied from elsewhere in a `package.json` (e.g.,
- * `version`).
- * @typedef InternalData
- * @property {string} pkgName - Name of package (e.g., `appium-xcuitest-driver`)
- * @property {string} version - Version of package
- * @property {import('./extension-config').InstallType} installType - Install type
- * @property {string} installSpec - Whatever the user typed as the extension to install. May be derived from `package.json`
- */
-
-/**
- * Convert external (`package.json`) extension data into manifest data
- * @typedef {ExtensionManifest<DriverType>} ManifestDriverData
- */
-
-/**
- * Convert external (`package.json`) extension data into manifest data
- * @typedef {ExtensionManifest<PluginType>} ManifestPluginData
- */
-
-/**
- * Data points shared by all Appium extensions
- * @typedef CommonData
- * @property {string} mainClass - Name of main class in the extension
- * @property {Record<string,string>} [scripts] - Collection of scripts which an extension may run
- * @property {string | (import('ajv').SchemaObject & {[key: number]: never})} [schema] - Argument schema object
- */
-
-/**
- * Driver-specific manifest data.
- * @typedef DriverData
- * @property {string} automationName - Automation engine to use
- * @property {string[]} platformNames - Platforms to run on
- * @property {string} driverName - Name of driver (_not_ the same as the package name, probably)
- */
-
-/**
- * Plugin-specific manifest data.
- * @typedef PluginData
- * @property {string} pluginName - Name of plugin (_not_ the same as the package name, probably)
- */
-
-/**
- * Generic type to refer to either {@link DriverData} or {@link PluginData}
- * @template {ExtensionType} ExtType
- * @typedef {CommonData & (ExtType extends DriverType ? DriverData : PluginData)} ExternalData
- */
-
-/**
- * Main class/constructor of third-party plugin
- *
- * Referenced by {@link CommonData.mainClass}
- * @typedef { {pluginName: string} & import('type-fest').Class<unknown> & ExtClassStaticMembers} PluginClass
- */
-
-/**
- * Main class/constructor of third-party driver
- *
- * Referenced by {@link CommonData.mainClass}
- * @typedef { {driverName: string} & import('type-fest').Class<unknown> & ExtClassStaticMembers } DriverClass
- */
-
-/**
- * @typedef ExtClassStaticMembers
- * @property {UpdateServerFn} [updateServer]
- * @property {import('@appium/base-driver').MethodMap} [newMethodMap]
- */
-
-/**
- * @callback UpdateServerFn
- * @param {import('express').Express} app - Express app
- * @param {import('http').Server} httpServer - HTTP server
- * @returns {import('type-fest').Promisable<void>}
- */
-/**
- * Generic type for an object keyed by extension name, with values of type {@link ExtData}
- * @template {ExtensionType} ExtType
- * @typedef {Record<string,ExtData<ExtType>>} ExtRecord
+ * Type of the string referring to a driver (typically as a key or type string)
+ * @typedef {import('../../types').DriverType} DriverType
  */
 
 /**
- * Generic type to refer to the data in an {@link ExtRecord}; this is the data for each extension in `extensions.yaml`.
- * @template {ExtensionType} ExtType
- * @typedef {ExtensionManifest<ExtType>} ExtData
+ * Type of the string referring to a plugin (typically as a key or type string)
+ * @typedef {import('../../types').PluginType} PluginType
  */
 
 /**
- * Like {@link ExtData} except it _for sure_ has a `schema` property.
- * @template {ExtensionType} ExtType
- * @typedef {(ExtensionManifest<ExtType>) & {schema: import('ajv').SchemaObject|string} } ExtDataWithSchema
+ * @typedef SyncWithInstalledExtensionsOpts
+ * @property {number} [depthLimit] - Maximum depth to recurse into subdirectories
  */
 
 /**
- * Generic type to refer to the main class constructor of an extension
- * @template {ExtensionType} ExtType
- * @typedef {ExtType extends DriverType ? DriverClass : PluginClass} ExtClass
+ * @typedef {import('../../types/appium-manifest').ManifestData} ManifestData
+ * @typedef {import('../../types/appium-manifest').InternalMetadata} InternalMetadata
  */
 
 /**
- * Generic type for the key of an {@link ExtRecord} which corresponds to an extension name.
- * @template {ExtensionType} ExtType
- * @typedef {keyof ExtRecord<ExtType>} ExtName
+ * @template T
+ * @typedef {import('../../types/external-manifest').ExtPackageJson<T>} ExtPackageJson
  */
 
 /**
- * Type of the string referring to a driver (typically as a key or type string)
- * @typedef {typeof import('../constants').DRIVER_TYPE} DriverType
+ * @template T
+ * @typedef {import('../../types/appium-manifest').ExtManifest<T>} ExtManifest
  */
 
 /**
- * Type of the string referring to a plugin (typically as a key or type string)
- * @typedef {typeof import('../constants').PLUGIN_TYPE} PluginType
+ * @template T
+ * @typedef {import('../../types/appium-manifest').ExtRecord<T>} ExtRecord
  */
 
 /**
- * A `package.json` containing extension data.
- * @template {ExtensionType} ExtType
- * @typedef {import('type-fest').SetRequired<import('type-fest').PackageJson, 'name' | 'version'> & {appium: ExternalData<ExtType>} } ExtensionPackageJson
+ * Either `driver` or `plugin` rn
+ * @typedef {import('../../types').ExtensionType} ExtensionType
  */
 
-/**
- * @typedef SyncWithInstalledExtensionsOpts
- * @property {number} [depthLimit] - Maximum depth to recurse into subdirectories
- */

package/lib/extension/package-changed.js

@@ -1,4 +1,3 @@
-// @ts-check
 
 import { fs } from '@appium/support';
 import { isPackageChanged } from 'package-changed';

package/lib/extension/plugin-config.js

@@ -1,4 +1,3 @@
-// @ts-check
 
 import _ from 'lodash';
 import {ExtensionConfig} from './extension-config';
@@ -27,7 +26,7 @@ export class PluginConfig extends ExtensionConfig {
    *
    * Just calls the superclass' constructor with the correct extension type
    * @private
-   * @param {import('./manifest').Manifest} manifest - IO object
+   * @param {Manifest} manifest - IO object
    * @param {PluginConfigOptions} [opts]
    */
    constructor (manifest, {extData, logFn} = {}) {
@@ -63,9 +62,10 @@ export class PluginConfig extends ExtensionConfig {
    static getInstance (manifest) {
      return PluginConfig._instances.get(manifest);
    }
+
    /**
    * @param {string} pluginName
-   * @param {PluginData} pluginData
+   * @param {import('../../types/appium-manifest').ExtManifest<PluginType>} pluginData
    * @returns {string}
    */
    extensionDesc (pluginName, {version}) {
@@ -74,7 +74,7 @@ export class PluginConfig extends ExtensionConfig {
 
    /**
    *
-   * @param {(keyof import('./manifest').ExtRecord<PluginType>)[]} activeNames
+   * @param {(keyof PluginRecord)[]} activeNames
    * @returns {void}
    */
    print (activeNames) {
@@ -101,11 +101,13 @@ export class PluginConfig extends ExtensionConfig {
 /**
  * @typedef PluginConfigOptions
  * @property {import('./extension-config').ExtensionLogFn} [logFn] - Optional logging function
- * @property {import('./manifest').ExtRecord<PluginType>} [extData] - Extension data
+ * @property {import('../../types/appium-manifest').PluginRecord} [extData] - Extension data
  */
 
+
 /**
- * @typedef {import('./manifest').PluginType} PluginType
- * @typedef {import('./manifest').ExtData<PluginType>} PluginData
+ * @typedef {import('../../types/appium-manifest').PluginRecord} PluginRecord
+ * @typedef {import('../../types').PluginType} PluginType
+ * @typedef {import('../../types/external-manifest').ExtMetadata<PluginType>} PluginMetadata
  * @typedef {import('./manifest').Manifest} Manifest
  */

package/lib/logsink.js

@@ -66,6 +66,8 @@ const stripColorFormat = format(function stripColor (info) {
 
 function createConsoleTransport (args, logLvl) {
   return new (transports.Console)({
+    // `name` is unsupported per winston's type declarations
+    // @ts-expect-error
     name: 'console',
     handleExceptions: true,
     exitOnError: false,
@@ -92,6 +94,7 @@ function createConsoleTransport (args, logLvl) {
 
 function createFileTransport (args, logLvl) {
   return new (transports.File)({
+    // @ts-expect-error
     name: 'file',
     filename: args.logFile,
     maxFiles: 1,
@@ -120,6 +123,7 @@ function createHttpTransport (args, logLvl) {
   }
 
   return new (transports.Http)({
+    // @ts-expect-error
     name: 'http',
     host,
     port,

package/lib/main.js

@@ -1,7 +1,5 @@
 #!/usr/bin/env node
 
-// transpile:main
-// @ts-check
 
 import { init as logsinkInit } from './logsink'; // this import needs to come first since it sets up global npmlog
 import logger from './logger'; // logger needs to remain second
@@ -110,7 +108,7 @@ function logServerPort (address, port) {
  * Gets a list of `updateServer` functions from all extensions
  * @param {DriverClass[]} driverClasses
  * @param {PluginClass[]} pluginClasses
- * @returns {import('./extension/manifest').UpdateServerFn[]}
+ * @returns {import('@appium/base-driver/lib/basedriver/driver').UpdateServerCallback[]}
  */
 function getServerUpdaters (driverClasses, pluginClasses) {
   return _.compact(_.map([...driverClasses, ...pluginClasses], 'updateServer'));
@@ -120,7 +118,7 @@ function getServerUpdaters (driverClasses, pluginClasses) {
  * Makes a big `MethodMap` from all the little `MethodMap`s in the extensions
  * @param {DriverClass[]} driverClasses
  * @param {PluginClass[]} pluginClasses
- * @returns {import('@appium/base-driver').MethodMap}
+ * @returns {import('@appium/types').MethodMap}
  */
 function getExtraMethodMap (driverClasses, pluginClasses) {
   return [...driverClasses, ...pluginClasses].reduce(
@@ -341,18 +339,19 @@ export { finalizeSchema, getSchema, validate } from './schema/schema';
 export { main, init, resolveAppiumHome };
 
 /**
- * @typedef {import('../types/types').ParsedArgs} ParsedArgs
+ * @typedef {import('../types/cli').ParsedArgs} ParsedArgs
  */
 
 /**
- * @typedef {import('../types/types').PartialArgs} PartialArgs
- * @typedef {import('./extension/manifest').DriverType} DriverType
- * @typedef {import('./extension/manifest').PluginType} PluginType
- * @typedef {import('./extension/manifest').DriverClass} DriverClass
- * @typedef {import('./extension/manifest').PluginClass} PluginClass
+ * @typedef {import('../types/cli').PartialArgs} PartialArgs
+ * @typedef {import('../types').DriverType} DriverType
+ * @typedef {import('../types').PluginType} PluginType
+ * @typedef {import('../types/extension').DriverClass} DriverClass
+ * @typedef {import('../types/extension').PluginClass} PluginClass
  */
 
 /**
+ * Literally an empty object
  * @typedef { {} } ExtCommandInitResult
  */
 

package/lib/schema/arg-spec.js

@@ -28,6 +28,7 @@ const PROPERTIES = 'properties';
  * option) used for cross-referencing.
  *
  * This class has no instance methods, and is basically just a read-only "struct".
+ * @template D
  */
 export class ArgSpec {
   /**
@@ -81,7 +82,7 @@ export class ArgSpec {
   /**
    * Whatever the default value of this argument is, as specified by the
    * `default` property of the schema.
-   * @type {D}
+   * @type {D|undefined}
    */
   defaultValue;
 
@@ -92,7 +93,6 @@ export class ArgSpec {
    *
    * The _constructor_ is private. Use {@link ArgSpec.create} instead.
    * @private
-   * @template D
    * @param {string} name
    * @param {ArgSpecOptions<D>} [opts]
    */
@@ -176,12 +176,15 @@ export class ArgSpec {
   /**
    * 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|undefined, normalizedExtName: string|undefined} }
+   * @returns { {extType?: ExtensionType, normalizedExtName?: string} }
    */
   static extensionInfoFromRootSchemaId (schemaId) {
     const matches = schemaId.match(SCHEMA_ID_REGEXP);
     if (matches?.groups) {
-      const {extType, normalizedExtName} = matches.groups;
+      const {extType, normalizedExtName} =
+        /** @type { {extType: ExtensionType, normalizedExtName: string} } */ (
+          matches.groups
+        );
       return {extType, normalizedExtName};
     }
     return {};
@@ -192,7 +195,8 @@ export class ArgSpec {
    *
    * @param {string} name - The canonical name of the argument. Corresponds to a key in a schema's
    * `properties` property.
-   * @param {ArgSpecOptions} [opts] - Options
+   * @template D
+   * @param {ArgSpecOptions<D>} [opts] - Options
    * @returns {Readonly<ArgSpec>}
    */
   static create (name, opts) {
@@ -224,5 +228,5 @@ export class ArgSpec {
  */
 
 /**
- * @typedef {import('../manifest').ExtensionType} ExtensionType
+ * @typedef {import('../extension/manifest').ExtensionType} ExtensionType
  */

package/lib/schema/cli-args.js

@@ -1,4 +1,3 @@
-// @ts-check
 
 import {ArgumentTypeError} from 'argparse';
 import _ from 'lodash';