appium-webdriveragent 10.5.3 → 11.0.0

package/CHANGELOG.md

@@ -1,3 +1,26 @@
+## [11.0.0](https://github.com/appium/WebDriverAgent/compare/v10.5.4...v11.0.0) (2025-12-21)
+
+### ⚠ BREAKING CHANGES
+
+* Removed the deprecated xcodeVersion argument from WebDriverAgent constructor
+* Removed the deprecated xcodeVersion argument from XcodeBuild constructor
+* Removed the deprecated idb property from WebDriverAgent class
+* Removed the noop checkForDependencies export from index
+
+- All .js modules were migrated to TypeScript
+- Module scripts were migrated to ESM/.mjs
+- All private WebDriverAgent and XcodeBuild methods and properties were marked as such
+
+### Features
+
+* Migrate the module to typescript ([#1096](https://github.com/appium/WebDriverAgent/issues/1096)) ([7d0a022](https://github.com/appium/WebDriverAgent/commit/7d0a022585ef70205dafe22d20736978d9e1cba3))
+
+## [10.5.4](https://github.com/appium/WebDriverAgent/compare/v10.5.3...v10.5.4) (2025-12-19)
+
+### Miscellaneous Chores
+
+* Apply format to socket helpers ([#1092](https://github.com/appium/WebDriverAgent/issues/1092)) ([ddc6313](https://github.com/appium/WebDriverAgent/commit/ddc631371350ef04ab8f49a93f1f674cab9aefde))
+
 ## [10.5.3](https://github.com/appium/WebDriverAgent/compare/v10.5.2...v10.5.3) (2025-12-19)
 
 ### Miscellaneous Chores

package/Scripts/{build-webdriveragent.js → build-webdriveragent.mjs}

@@ -1,8 +1,13 @@
-const path = require('path');
-const { asyncify } = require('asyncbox');
-const { logger, fs } = require('@appium/support');
-const { exec } = require('teen_process');
-const xcode = require('appium-xcode');
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { asyncify } from 'asyncbox';
+import { logger, fs } from '@appium/support';
+import { exec } from 'teen_process';
+import * as xcode from 'appium-xcode';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const isMainModule = process.argv[1] && path.resolve(process.argv[1]) === __filename;
 
 const LOG = new logger.getLogger('WDABuild');
 const ROOT_DIR = path.resolve(__dirname, '..');
@@ -72,8 +77,9 @@ async function buildWebDriverAgent (xcodeVersion) {
   LOG.info(`Zip bundled at "${appBundleZipPath}"`);
 }
 
-if (require.main === module) {
+if (isMainModule) {
   asyncify(buildWebDriverAgent);
 }
 
-module.exports = buildWebDriverAgent;
+export default buildWebDriverAgent;
+

package/Scripts/{fetch-prebuilt-wda.js → fetch-prebuilt-wda.mjs}

@@ -1,14 +1,21 @@
-const path = require('path');
-const axios = require('axios');
-const { asyncify } = require('asyncbox');
-const { logger, fs, mkdirp, net } = require('@appium/support');
-const _ = require('lodash');
-const B = require('bluebird');
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { readFileSync } from 'node:fs';
+import axios from 'axios';
+import { asyncify } from 'asyncbox';
+import { logger, fs, mkdirp, net } from '@appium/support';
+import _ from 'lodash';
+import B from 'bluebird';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const isMainModule = process.argv[1] && path.resolve(process.argv[1]) === __filename;
 
 const log = logger.getLogger('WDA');
 
 async function fetchPrebuiltWebDriverAgentAssets () {
-  const tag = require('../package.json').version;
+  const packageJson = JSON.parse(readFileSync(path.resolve(__dirname, '..', 'package.json'), 'utf8'));
+  const tag = packageJson.version;
   log.info(`Getting links to webdriveragent release ${tag}`);
   const downloadUrl = `https://api.github.com/repos/appium/webdriveragent/releases/tags/v${tag}`;
   log.info(`Getting WDA release ${downloadUrl}`);
@@ -54,8 +61,9 @@ async function fetchPrebuiltWebDriverAgentAssets () {
   return await B.all(agentsDownloading);
 }
 
-if (require.main === module) {
+if (isMainModule) {
   asyncify(fetchPrebuiltWebDriverAgentAssets);
 }
 
-module.exports = fetchPrebuiltWebDriverAgentAssets;
+export default fetchPrebuiltWebDriverAgentAssets;
+

package/Scripts/update-wda-version.mjs

@@ -0,0 +1,42 @@
+import {plist, logger} from '@appium/support';
+import path from 'node:path';
+import semver from 'semver';
+
+const log = logger.getLogger('Versioner');
+
+/**
+ * @param {string} argName
+ * @returns {string|null}
+ */
+function parseArgValue (argName) {
+  const argNamePattern = new RegExp(`^--${argName}\\b`);
+  for (let i = 1; i < process.argv.length; ++i) {
+    const arg = process.argv[i];
+    if (argNamePattern.test(arg)) {
+      return arg.includes('=') ? arg.split('=')[1] : process.argv[i + 1];
+    }
+  }
+  return null;
+}
+
+async function updateWdaVersion() {
+  const newVersion = parseArgValue('package-version');
+  if (!newVersion) {
+    throw new Error('No package version argument (use `--package-version=xxx`)');
+  }
+  if (!semver.valid(newVersion)) {
+    throw new Error(
+      `Invalid version specified '${newVersion}'. Version should be in the form '1.2.3'`
+    );
+  }
+
+  const libManifest = path.resolve('WebDriverAgentLib', 'Info.plist');
+  log.info(`Updating the WebDriverAgent manifest at '${libManifest}' to version '${newVersion}'`);
+  await plist.updatePlistFile(libManifest, {
+    CFBundleShortVersionString: newVersion,
+    CFBundleVersion: newVersion,
+  }, false);
+}
+
+(async () => await updateWdaVersion())();
+

package/WebDriverAgentLib/Info.plist

@@ -15,11 +15,11 @@
     <key>CFBundlePackageType</key>
     <string>FMWK</string>
     <key>CFBundleShortVersionString</key>
-    <string>10.5.3</string>
+    <string>11.0.0</string>
     <key>CFBundleSignature</key>
     <string>????</string>
     <key>CFBundleVersion</key>
-    <string>10.5.3</string>
+    <string>11.0.0</string>
     <key>NSPrincipalClass</key>
     <string/>
   </dict>