appium 3.5.1 → 3.6.0

package/lib/schema/schema.ts

@@ -1,11 +1,13 @@
-import Ajv, {type ErrorObject, type SchemaObject, type ValidateFunction} from 'ajv';
-import addFormats from 'ajv-formats';
-import {util} from '@appium/support';
 import path from 'node:path';
-import {bindAll, kebabCase, omitKeys, setPath} from '../utils';
+
 import {AppiumConfigJsonSchema} from '@appium/schema';
+import {util} from '@appium/support';
 import type {ExtensionType} from '@appium/types';
+import Ajv, {type ErrorObject, type SchemaObject, type ValidateFunction} from 'ajv';
+import addFormats from 'ajv-formats';
+
 import {DRIVER_TYPE, PLUGIN_TYPE} from '../constants';
+import {bindAll, kebabCase, omitKeys, setPath} from '../utils';
 import {APPIUM_CONFIG_SCHEMA_ID, ArgSpec, SERVER_PROP_NAME} from './arg-spec';
 import {keywords} from './keywords';
 
@@ -40,9 +42,7 @@ export class RoachHotelMap<K, V> extends Map<K, V> {
   }
 }
 
-export const ALLOWED_SCHEMA_EXTENSIONS = Object.freeze(
-  new Set<AllowedSchemaExtension>(['.json', '.js', '.cjs']),
-);
+export const ALLOWED_SCHEMA_EXTENSIONS = Object.freeze(new Set<AllowedSchemaExtension>(['.json', '.js', '.cjs']));
 
 const SCHEMA_KEY = '$schema';
 
@@ -148,11 +148,7 @@ class AppiumSchema {
     const ajv = this.#ajv;
     const baseSchema = structuredClone(AppiumConfigJsonSchema) as any;
 
-    const addArgSpecs = (
-      schema: Record<string, any>,
-      extType?: ExtensionType,
-      extName?: string,
-    ): void => {
+    const addArgSpecs = (schema: Record<string, any>, extType?: ExtensionType, extName?: string): void => {
       for (const [propName, propSchema] of Object.entries(schema)) {
         const argSpec = ArgSpec.create(propName, {
           dest: (propSchema as any).appiumCliDest,
@@ -211,11 +207,7 @@ class AppiumSchema {
   /**
    * Registers an extension schema.
    */
-  async registerSchema(
-    extType: ExtensionType,
-    extName: string,
-    schema: SchemaObject,
-  ): Promise<void> {
+  async registerSchema(extType: ExtensionType, extName: string, schema: SchemaObject): Promise<void> {
     if (!(extType && extName) || schema === undefined) {
       throw new TypeError('Expected extension type, extension name, and a defined schema');
     }
@@ -250,9 +242,7 @@ class AppiumSchema {
   /**
    * Returns default values for all args, flattened or nested.
    */
-  getDefaults<Flattened extends boolean | undefined = true>(
-    flatten = true as Flattened,
-  ): DefaultValues<Flattened> {
+  getDefaults<Flattened extends boolean | undefined = true>(flatten = true as Flattened): DefaultValues<Flattened> {
     if (!this.isFinalized()) {
       throw new SchemaFinalizationError();
     }
@@ -278,16 +268,11 @@ class AppiumSchema {
   /**
    * Returns flattened defaults for a specific extension.
    */
-  getDefaultsForExtension(
-    extType: ExtensionType,
-    extName: string,
-  ): Record<string, ArgSpecDefaultValue> {
+  getDefaultsForExtension(extType: ExtensionType, extName: string): Record<string, ArgSpecDefaultValue> {
     if (!this.isFinalized()) {
       throw new SchemaFinalizationError();
     }
-    const specs = [...this.#argSpecs.values()].filter(
-      (spec) => spec.extType === extType && spec.extName === extName,
-    );
+    const specs = [...this.#argSpecs.values()].filter((spec) => spec.extType === extType && spec.extName === extName);
     return specs.reduce(
       (defaults, {defaultValue, rawDest}) => {
         if (defaultValue !== undefined) {
@@ -304,9 +289,7 @@ class AppiumSchema {
    */
   flatten(): FlattenedSchema {
     const schema = this.getSchema() as any;
-    const stack: {properties: Record<string, any>; prefix: string[]}[] = [
-      {properties: schema.properties, prefix: []},
-    ];
+    const stack: {properties: Record<string, any>; prefix: string[]}[] = [{properties: schema.properties, prefix: []}];
     const flattened: FlattenedSchema = [];
 
     for (const {properties, prefix} of stack) {
@@ -327,9 +310,7 @@ class AppiumSchema {
           }
           const {normalizedExtName} = ArgSpec.extensionInfoFromRootSchemaId($ref);
           if (!normalizedExtName) {
-            throw new ReferenceError(
-              `Could not determine extension name from schema ID ${$ref}. This is a bug.`,
-            );
+            throw new ReferenceError(`Could not determine extension name from schema ID ${$ref}. This is a bug.`);
           }
           stack.push({
             properties: refSchema.properties,

package/lib/utils/index.ts

@@ -1,9 +1,6 @@
 export {adler32} from './hash';
 export {isPackageChanged} from './is-package-changed';
 export type {IsPackageChangedOptions, IsPackageChangedResult} from './is-package-changed';
-export {appiumPackageRoot, npmPackage} from './package-json';
-export {packageDidChange} from './package-changed';
-export {resolveFrom} from './resolve-from';
 export {
   bindAll,
   camelCase,
@@ -21,3 +18,6 @@ export {
   setPath,
   zip,
 } from './object';
+export {packageDidChange} from './package-changed';
+export {appiumPackageRoot, npmPackage} from './package-json';
+export {resolveFrom} from './resolve-from';

package/lib/utils/is-package-changed.ts

@@ -1,7 +1,8 @@
-import {fs} from '@appium/support';
 import crypto from 'node:crypto';
 import path from 'node:path';
 
+import {fs} from '@appium/support';
+
 export interface IsPackageChangedOptions {
   cwd?: string;
   hashFilename?: string;
@@ -18,9 +19,7 @@ export interface IsPackageChangedResult {
  * Detects whether `package.json` dependencies changed since the last hash write.
  * Inlined from the `package-changed` package (lockfile support omitted; unused by Appium).
  */
-export async function isPackageChanged(
-  options: IsPackageChangedOptions = {},
-): Promise<IsPackageChangedResult> {
+export async function isPackageChanged(options: IsPackageChangedOptions = {}): Promise<IsPackageChangedResult> {
   const {hashFilename = '.packagehash', cwd = process.cwd()} = options;
   const packagePath = await findPackageJson(cwd);
   if (!packagePath) {
@@ -30,9 +29,7 @@ export async function isPackageChanged(
   const packageHashPath = path.join(cwd, hashFilename);
   const packageHashPathExists = await fs.exists(packageHashPath);
   const recentDigest = await getPackageHash(packagePath);
-  const previousDigest = packageHashPathExists
-    ? await fs.readFile(packageHashPath, 'utf-8')
-    : undefined;
+  const previousDigest = packageHashPathExists ? await fs.readFile(packageHashPath, 'utf-8') : undefined;
   const isChanged = !packageHashPathExists || previousDigest !== recentDigest;
 
   const writeHash = async () => {

package/lib/utils/object.ts

@@ -84,9 +84,7 @@ export function mapValues<T extends Record<string, unknown>, R>(
   obj: T,
   fn: (value: T[keyof T], key: keyof T) => R,
 ): Record<string, R> {
-  return Object.fromEntries(
-    Object.entries(obj).map(([key, value]) => [key, fn(value as T[keyof T], key as keyof T)]),
-  );
+  return Object.fromEntries(Object.entries(obj).map(([key, value]) => [key, fn(value as T[keyof T], key as keyof T)]));
 }
 
 /**
@@ -225,9 +223,7 @@ export function difference<T>(a: readonly T[], b: readonly T[]): T[] {
  * @param sources - Objects merged in order; null/undefined sources are skipped
  * @returns Merged object
  */
-export function defaultsDeep<T extends Record<string, unknown>>(
-  ...sources: Array<Partial<T> | undefined>
-): T {
+export function defaultsDeep<T extends Record<string, unknown>>(...sources: Array<Partial<T> | undefined>): T {
   let result: Record<string, unknown> = {};
   for (const source of sources) {
     if (source == null) {
@@ -283,14 +279,9 @@ function copyForDefaultsDeep(value: unknown): unknown {
  * @param source - Default values
  * @returns Merged clone
  */
-function fillUndefinedDeep(
-  target: Record<string, unknown>,
-  source: Record<string, unknown>,
-): Record<string, unknown> {
+function fillUndefinedDeep(target: Record<string, unknown>, source: Record<string, unknown>): Record<string, unknown> {
   const out = copyForDefaultsDeep(target) as Record<string, unknown>;
-  const stack: Array<{dest: Record<string, unknown>; src: Record<string, unknown>}> = [
-    {dest: out, src: source},
-  ];
+  const stack: Array<{dest: Record<string, unknown>; src: Record<string, unknown>}> = [{dest: out, src: source}];
   while (stack.length) {
     const next = stack.pop();
     if (!next) {

package/lib/utils/package-changed.ts

@@ -1,5 +1,7 @@
-import {fs} from '@appium/support';
 import path from 'node:path';
+
+import {fs} from '@appium/support';
+
 import {PKG_HASHFILE_RELATIVE_PATH} from '../constants';
 import {log} from '../logger';
 import {isPackageChanged} from './is-package-changed';
@@ -8,7 +10,6 @@ import {isPackageChanged} from './is-package-changed';
  * Determines if extensions have changed, and updates a hash the `package.json` in `appiumHome` if so.
  *
  * If they have, we need to sync them with the `extensions.yaml` manifest.
- *
  */
 export async function packageDidChange(appiumHome: string): Promise<boolean> {
   const hashFilename = path.join(appiumHome, PKG_HASHFILE_RELATIVE_PATH);
@@ -41,14 +42,11 @@ export async function packageDidChange(appiumHome: string): Promise<boolean> {
   if (isChanged) {
     try {
       await writeHash();
-      log.debug(
-        `Updated hash of ${appiumHome}/package.json from: ${oldHash ?? '(none)'} to: ${hash}`,
-      );
+      log.debug(`Updated hash of ${appiumHome}/package.json from: ${oldHash ?? '(none)'} to: ${hash}`);
     } catch (err: any) {
-      throw new Error(
-        `Appium could not write hash file: ${hashFilenameDir}. Original error: ${err.message}`,
-        {cause: err},
-      );
+      throw new Error(`Appium could not write hash file: ${hashFilenameDir}. Original error: ${err.message}`, {
+        cause: err,
+      });
     }
   }
 

package/lib/utils/package-json.ts

@@ -1,5 +1,6 @@
 import nodeFs from 'node:fs';
 import path from 'node:path';
+
 import type {PackageJson} from 'type-fest';
 
 type AppiumPackageJson = PackageJson & {
@@ -21,9 +22,7 @@ function readPackageJsonSync(): {pkgRoot: string; pkg: AppiumPackageJson} {
     }
     current = path.dirname(current);
   }
-  const pkg = JSON.parse(
-    nodeFs.readFileSync(path.join(pkgRoot, 'package.json'), 'utf8'),
-  ) as PackageJson;
+  const pkg = JSON.parse(nodeFs.readFileSync(path.join(pkgRoot, 'package.json'), 'utf8')) as PackageJson;
   if (typeof pkg.name !== 'string' || typeof pkg.version !== 'string') {
     throw new Error(`Invalid \`package.json\` near ${__dirname}`);
   }

package/lib/utils/resolve-from.ts

@@ -26,10 +26,7 @@ export async function resolveFrom(fromDirectory: string, moduleId: string): Prom
 
   const fromFile = path.join(resolvedFromDirectory, 'noop.js');
   const nodeModule = Module as typeof Module & {
-    _resolveFilename: (
-      id: string,
-      parent: {id: string; filename: string; paths: string[]},
-    ) => string;
+    _resolveFilename: (id: string, parent: {id: string; filename: string; paths: string[]}) => string;
     _nodeModulePaths: (from: string) => string[];
   };
   return nodeModule._resolveFilename(moduleId, {

package/package.json

@@ -1,29 +1,29 @@
 {
   "name": "appium",
-  "version": "3.5.1",
+  "version": "3.6.0",
+  "gitHead": "f7b20335eab4022e5cbbb627ec86866a994444f8",
   "description": "Automation for Apps.",
   "keywords": [
+    "android",
     "automation",
+    "firefoxos",
+    "ios",
     "javascript",
     "selenium",
-    "webdriver",
-    "ios",
-    "android",
-    "firefoxos",
-    "testing"
+    "testing",
+    "webdriver"
   ],
   "homepage": "https://appium.io",
   "bugs": {
     "url": "https://github.com/appium/appium/issues"
   },
+  "license": "Apache-2.0",
+  "author": "https://github.com/appium",
   "repository": {
     "type": "git",
     "url": "https://github.com/appium/appium.git",
     "directory": "packages/appium"
   },
-  "license": "Apache-2.0",
-  "author": "https://github.com/appium",
-  "types": "./build/lib/main.d.ts",
   "bin": {
     "appium": "index.js"
   },
@@ -42,6 +42,11 @@
     "types",
     "tsconfig.json"
   ],
+  "main": "./build/lib/main.js",
+  "types": "./build/lib/main.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build:docs": "node docs/scripts/build-docs.js",
     "build:docs:preview": "cross-env APPIUM_DOCS_PREVIEW=1 npm run build:docs",
@@ -55,40 +60,36 @@
     "postinstall": "node ./scripts/autoinstall-extensions.js",
     "publish:docs": "cross-env APPIUM_DOCS_PUBLISH=1 npm run build:docs",
     "test": "npm run test:unit",
-    "test:e2e": "mocha --exit --timeout 1m --slow 30s \"./test/e2e/**/*.spec.ts\"",
+    "test:e2e": "node --test --enable-source-maps --test-force-exit --test-concurrency=1 --test-timeout=200000 \"./build/test/e2e/**/*.spec.js\"",
     "test:smoke": "cross-env APPIUM_HOME=./local_appium_home node ./index.js driver install uiautomator2 && cross-env APPIUM_HOME=./local_appium_home node ./index.js driver list",
-    "test:unit": "mocha \"./test/unit/**/*.spec.ts\""
+    "test:unit": "node --test --enable-source-maps --test-timeout=5000 \"./build/test/unit/**/*.spec.js\""
   },
   "dependencies": {
-    "@appium/base-driver": "10.7.0",
-    "@appium/base-plugin": "3.3.1",
-    "@appium/docutils": "2.5.0",
-    "@appium/logger": "2.0.9",
-    "@appium/schema": "1.2.1",
-    "@appium/support": "7.2.4",
-    "@appium/types": "1.5.1",
+    "@appium/base-driver": "10.7.2",
+    "@appium/base-plugin": "3.3.3",
+    "@appium/docutils": "2.5.2",
+    "@appium/logger": "2.0.10",
+    "@appium/schema": "1.3.0",
+    "@appium/support": "7.2.6",
+    "@appium/types": "1.6.0",
     "@sidvind/better-ajv-errors": "5.0.0",
     "ajv": "8.20.0",
     "ajv-formats": "3.0.1",
-    "argparse": "2.0.1",
-    "asyncbox": "6.3.0",
-    "axios": "1.17.0",
+    "argparse": "3.0.0",
+    "asyncbox": "6.3.5",
+    "axios": "1.18.1",
     "lilconfig": "3.1.3",
-    "lru-cache": "11.5.1",
+    "lru-cache": "11.5.2",
     "ora": "5.4.1",
-    "semver": "7.8.4",
-    "teen_process": "4.1.3",
-    "type-fest": "5.7.0",
+    "semver": "7.8.5",
+    "teen_process": "4.1.9",
+    "type-fest": "5.8.0",
     "winston": "3.19.0",
-    "ws": "8.21.0",
+    "ws": "8.21.1",
     "yaml": "2.9.0"
   },
   "engines": {
     "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
     "npm": ">=10"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "gitHead": "213efd0fa400bdd0156b00ad2c45f8ef005a01ca"
+  }
 }

package/scripts/autoinstall-extensions.js

@@ -166,10 +166,7 @@ async function main() {
     `Done. ${installedStats[DRIVER_TYPE]} ${util.pluralize(
       'driver',
       installedStats[DRIVER_TYPE],
-    )} and ${installedStats[PLUGIN_TYPE]} ${util.pluralize(
-      'plugin',
-      installedStats[PLUGIN_TYPE],
-    )} are installed.`,
+    )} and ${installedStats[PLUGIN_TYPE]} ${util.pluralize('plugin', installedStats[PLUGIN_TYPE])} are installed.`,
   );
 }
 

package/tsconfig.json

@@ -1,11 +1,5 @@
 {
   "extends": "@appium/tsconfig/tsconfig.json",
-  "ts-node": {
-    "transpileOnly": true,
-    "compilerOptions": {
-      "rootDir": "."
-    }
-  },
   "compilerOptions": {
     "rootDir": ".",
     "outDir": "build",
@@ -15,20 +9,22 @@
       "@appium/base-driver": ["../base-driver"],
       "@appium/base-plugin": ["../base-plugin"],
       "@appium/fake-driver": ["../fake-driver"],
+      "@appium/logger": ["../logger"],
       "@appium/types": ["../types"],
       "@appium/schema": ["../schema"],
       "appium": ["."]
     },
     "checkJs": true,
-    "types": ["mocha", "chai", "chai-as-promised", "node"]
+    "types": ["node"]
   },
   "include": ["lib", "types", "test"],
   "references": [
-    {"path": "../schema"},
-    {"path": "../types"},
-    {"path": "../support"},
     {"path": "../base-driver"},
     {"path": "../base-plugin"},
-    {"path": "../fake-driver"}
+    {"path": "../fake-driver"},
+    {"path": "../logger"},
+    {"path": "../types"},
+    {"path": "../schema"},
+    {"path": "../support"}
   ]
 }

package/types/cli.ts

@@ -1,5 +1,6 @@
 import type {DriverType, PluginType, ServerArgs} from '@appium/types';
 import type {SetOptional} from 'type-fest';
+
 import type {InstallType} from './manifest';
 export type CliCommandServer = 'server';
 export type CliCommandSetup = 'setup';
@@ -204,9 +205,7 @@ export type ParsedArgs<
 export type Args<
   Cmd extends CliCommand = CliCommandServer,
   SubCmd extends CliExtensionSubcommand | CliCommandSetupSubcommand | void = void,
-> = Cmd extends CliCommandServer
-  ? SetOptional<CommonArgs<Cmd>, keyof ServerArgs>
-  : ParsedArgs<Cmd, SubCmd>;
+> = Cmd extends CliCommandServer ? SetOptional<CommonArgs<Cmd>, keyof ServerArgs> : ParsedArgs<Cmd, SubCmd>;
 
 /**
  * Shown by `appium --build-info`

package/types/index.ts

@@ -1,7 +1,7 @@
-import type {ExtensionType, DriverType, DriverClass, PluginType, PluginClass} from '@appium/types';
+import type {DriverClass, DriverType, ExtensionType, PluginClass, PluginType} from '@appium/types';
 
-export * from './manifest';
 export * from './cli';
+export * from './manifest';
 
 /**
  * Known environment variables concerning Appium

package/types/manifest/base.ts

@@ -108,10 +108,7 @@ export type ExtMetadata<ExtType extends ExtensionType> = (ExtType extends Driver
  * Combination of external + internal extension data with `driverName`/`pluginName` removed (it becomes a key in an {@linkcode ExtRecord} object).
  * Part of `extensions.yaml`.
  */
-export type ExtManifest<ExtType extends ExtensionType> = Omit<
-  ExtMetadata<ExtType>,
-  'driverName' | 'pluginName'
-> &
+export type ExtManifest<ExtType extends ExtensionType> = Omit<ExtMetadata<ExtType>, 'driverName' | 'pluginName'> &
   InternalMetadata;
 
 /**
@@ -143,10 +140,7 @@ export type ExtName<ExtType extends ExtensionType> = keyof ExtRecord<ExtType>;
  * - `appium`: the metadata for the extension
  * - `peerDependencies.appium`: the maximum compatible version of Appium
  */
-export type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<
-  PackageJson,
-  'name' | 'version'
-> & {
+export type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<PackageJson, 'name' | 'version'> & {
   appium: ExtMetadata<ExtType>;
   peerDependencies: {appium: string; [key: string]: string};
 };
@@ -154,5 +148,4 @@ export type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<
 /**
  * A transient format between installation and insertion of extension metadata into the manifest.
  */
-export type ExtInstallReceipt<ExtType extends ExtensionType> = ExtMetadata<ExtType> &
-  InternalMetadata;
+export type ExtInstallReceipt<ExtType extends ExtensionType> = ExtMetadata<ExtType> & InternalMetadata;

package/types/manifest/v3.ts

@@ -111,10 +111,7 @@ export type ExtMetadata<ExtType extends ExtensionType> = (ExtType extends Driver
  * Combination of external + internal extension data with `driverName`/`pluginName` removed (it becomes a key in an {@linkcode ExtRecord} object).
  * Part of `extensions.yaml`.
  */
-export type ExtManifest<ExtType extends ExtensionType> = Omit<
-  ExtMetadata<ExtType>,
-  'driverName' | 'pluginName'
-> &
+export type ExtManifest<ExtType extends ExtensionType> = Omit<ExtMetadata<ExtType>, 'driverName' | 'pluginName'> &
   InternalMetadata;
 
 /**
@@ -146,10 +143,7 @@ export type ExtName<ExtType extends ExtensionType> = keyof ExtRecord<ExtType>;
  * - `appium`: the metadata for the extension
  * - `peerDependencies.appium`: the maximum compatible version of Appium
  */
-export type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<
-  PackageJson,
-  'name' | 'version'
-> & {
+export type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<PackageJson, 'name' | 'version'> & {
   appium: ExtMetadata<ExtType>;
   peerDependencies: {appium: string; [key: string]: string};
 };
@@ -157,5 +151,4 @@ export type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<
 /**
  * A transient format between installation and insertion of extension metadata into the manifest.
  */
-export type ExtInstallReceipt<ExtType extends ExtensionType> = ExtMetadata<ExtType> &
-  InternalMetadata;
+export type ExtInstallReceipt<ExtType extends ExtensionType> = ExtMetadata<ExtType> & InternalMetadata;

package/types/manifest/v4.ts

@@ -111,10 +111,7 @@ export type ExtMetadata<ExtType extends ExtensionType> = (ExtType extends Driver
  * Combination of external + internal extension data with `driverName`/`pluginName` removed (it becomes a key in an {@linkcode ExtRecord} object).
  * Part of `extensions.yaml`.
  */
-export type ExtManifest<ExtType extends ExtensionType> = Omit<
-  ExtMetadata<ExtType>,
-  'driverName' | 'pluginName'
-> &
+export type ExtManifest<ExtType extends ExtensionType> = Omit<ExtMetadata<ExtType>, 'driverName' | 'pluginName'> &
   InternalMetadata;
 
 /**
@@ -146,10 +143,7 @@ export type ExtName<ExtType extends ExtensionType> = keyof ExtRecord<ExtType>;
  * - `appium`: the metadata for the extension
  * - `peerDependencies.appium`: the maximum compatible version of Appium
  */
-export type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<
-  PackageJson,
-  'name' | 'version'
-> & {
+export type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<PackageJson, 'name' | 'version'> & {
   appium: ExtMetadata<ExtType>;
   peerDependencies: {appium: string; [key: string]: string};
 };
@@ -157,5 +151,4 @@ export type ExtPackageJson<ExtType extends ExtensionType> = SetRequired<
 /**
  * A transient format between installation and insertion of extension metadata into the manifest.
  */
-export type ExtInstallReceipt<ExtType extends ExtensionType> = ExtMetadata<ExtType> &
-  InternalMetadata;
+export type ExtInstallReceipt<ExtType extends ExtensionType> = ExtMetadata<ExtType> & InternalMetadata;