appium-webdriveragent 8.4.0 → 8.5.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [8.5.0](https://github.com/appium/WebDriverAgent/compare/v8.4.0...v8.5.0) (2024-04-07)
+
+
+### Features
+
+* Add types for WDA caps and settings ([#885](https://github.com/appium/WebDriverAgent/issues/885)) ([4b3c220](https://github.com/appium/WebDriverAgent/commit/4b3c220c0c609802924b7b6ff9a4dfa7a98eb5f4))
+
 ## [8.4.0](https://github.com/appium/WebDriverAgent/compare/v8.3.1...v8.4.0) (2024-04-01)
 
 

package/WebDriverAgentLib/Info.plist

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

package/build/index.d.ts

@@ -0,0 +1,7 @@
+export { checkForDependencies, bundleWDASim } from './lib/check-dependencies';
+export { NoSessionProxy } from './lib/no-session-proxy';
+export { WebDriverAgent } from './lib/webdriveragent';
+export { WDA_BASE_URL, WDA_RUNNER_BUNDLE_ID, PROJECT_FILE } from './lib/constants';
+export { resetTestProcesses, BOOTSTRAP_PATH } from './lib/utils';
+export * from './lib/types';
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACnF,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAEjE,cAAc,aAAa,CAAC"}

package/build/index.js

@@ -10,37 +10,24 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WDA_BASE_URL = exports.PROJECT_FILE = exports.WDA_RUNNER_BUNDLE_ID = exports.BOOTSTRAP_PATH = exports.resetTestProcesses = exports.bundleWDASim = exports.checkForDependencies = exports.NoSessionProxy = exports.WebDriverAgent = void 0;
-const dependencies = __importStar(require("./lib/check-dependencies"));
-const proxies = __importStar(require("./lib/no-session-proxy"));
-const driver = __importStar(require("./lib/webdriveragent"));
-const constants = __importStar(require("./lib/constants"));
-const utils = __importStar(require("./lib/utils"));
-const { checkForDependencies, bundleWDASim } = dependencies;
-exports.checkForDependencies = checkForDependencies;
-exports.bundleWDASim = bundleWDASim;
-const { NoSessionProxy } = proxies;
-exports.NoSessionProxy = NoSessionProxy;
-const { WebDriverAgent } = driver;
-exports.WebDriverAgent = WebDriverAgent;
-const { WDA_BASE_URL, WDA_RUNNER_BUNDLE_ID, PROJECT_FILE } = constants;
-exports.WDA_BASE_URL = WDA_BASE_URL;
-exports.WDA_RUNNER_BUNDLE_ID = WDA_RUNNER_BUNDLE_ID;
-exports.PROJECT_FILE = PROJECT_FILE;
-const { resetTestProcesses, BOOTSTRAP_PATH } = utils;
-exports.resetTestProcesses = resetTestProcesses;
-exports.BOOTSTRAP_PATH = BOOTSTRAP_PATH;
+exports.BOOTSTRAP_PATH = exports.resetTestProcesses = exports.PROJECT_FILE = exports.WDA_RUNNER_BUNDLE_ID = exports.WDA_BASE_URL = exports.WebDriverAgent = exports.NoSessionProxy = exports.bundleWDASim = exports.checkForDependencies = void 0;
+var check_dependencies_1 = require("./lib/check-dependencies");
+Object.defineProperty(exports, "checkForDependencies", { enumerable: true, get: function () { return check_dependencies_1.checkForDependencies; } });
+Object.defineProperty(exports, "bundleWDASim", { enumerable: true, get: function () { return check_dependencies_1.bundleWDASim; } });
+var no_session_proxy_1 = require("./lib/no-session-proxy");
+Object.defineProperty(exports, "NoSessionProxy", { enumerable: true, get: function () { return no_session_proxy_1.NoSessionProxy; } });
+var webdriveragent_1 = require("./lib/webdriveragent");
+Object.defineProperty(exports, "WebDriverAgent", { enumerable: true, get: function () { return webdriveragent_1.WebDriverAgent; } });
+var constants_1 = require("./lib/constants");
+Object.defineProperty(exports, "WDA_BASE_URL", { enumerable: true, get: function () { return constants_1.WDA_BASE_URL; } });
+Object.defineProperty(exports, "WDA_RUNNER_BUNDLE_ID", { enumerable: true, get: function () { return constants_1.WDA_RUNNER_BUNDLE_ID; } });
+Object.defineProperty(exports, "PROJECT_FILE", { enumerable: true, get: function () { return constants_1.PROJECT_FILE; } });
+var utils_1 = require("./lib/utils");
+Object.defineProperty(exports, "resetTestProcesses", { enumerable: true, get: function () { return utils_1.resetTestProcesses; } });
+Object.defineProperty(exports, "BOOTSTRAP_PATH", { enumerable: true, get: function () { return utils_1.BOOTSTRAP_PATH; } });
+__exportStar(require("./lib/types"), exports);
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+DAA8E;AAArE,0HAAA,oBAAoB,OAAA;AAAE,kHAAA,YAAY,OAAA;AAC3C,2DAAwD;AAA/C,kHAAA,cAAc,OAAA;AACvB,uDAAsD;AAA7C,gHAAA,cAAc,OAAA;AACvB,6CAAmF;AAA1E,yGAAA,YAAY,OAAA;AAAE,iHAAA,oBAAoB,OAAA;AAAE,yGAAA,YAAY,OAAA;AACzD,qCAAiE;AAAxD,2GAAA,kBAAkB,OAAA;AAAE,uGAAA,cAAc,OAAA;AAE3C,8CAA4B"}

package/build/lib/types.d.ts

@@ -0,0 +1,48 @@
+export interface WDASettings {
+    elementResponseAttribute?: string;
+    shouldUseCompactResponses?: boolean;
+    mjpegServerScreenshotQuality?: number;
+    mjpegServerFramerate?: number;
+    screenshotQuality?: number;
+    elementResponseAttributes?: string;
+    mjpegScalingFactor?: number;
+    mjpegFixOrientation?: boolean;
+    keyboardAutocorrection?: boolean;
+    keyboardPrediction?: boolean;
+    customSnapshotTimeout?: number;
+    snapshotMaxDepth?: number;
+    useFirstMatch?: boolean;
+    boundElementsByIndex?: boolean;
+    reduceMotion?: boolean;
+    defaultActiveApplication?: string;
+    activeAppDetectionPoint?: string;
+    includeNonModalElements?: boolean;
+    defaultAlertAction?: 'accept' | 'dismiss';
+    acceptAlertButtonSelector?: string;
+    dismissAlertButtonSelector?: string;
+    screenshotOrientation?: 'auto' | 'portrait' | 'portraitUpsideDown' | 'landscapeRight' | 'landscapeLeft';
+    waitForIdleTimeout?: number;
+    animationCoolOffTimeout?: number;
+}
+export interface WDACapabilities {
+    bundleId?: string;
+    initialUrl?: string;
+    arguments?: string[];
+    environment?: Record<string, string>;
+    eventloopIdleDelaySec?: number;
+    shouldWaitForQuiescence?: boolean;
+    shouldUseTestManagerForVisibilityDetection?: boolean;
+    maxTypingFrequency?: number;
+    shouldUseSingletonTestManager?: boolean;
+    waitForIdleTimeout?: number;
+    shouldUseCompactResponses?: number;
+    elementResponseFields?: unknown;
+    disableAutomaticScreenshots?: boolean;
+    shouldTerminateApp?: boolean;
+    forceAppLaunch?: boolean;
+    useNativeCachingStrategy?: boolean;
+    forceSimulatorSoftwareKeyboardPresence?: boolean;
+    defaultAlertAction?: 'accept' | 'dismiss';
+    appLaunchStateTimeoutSec?: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,WAAW;IAC1B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,kBAAkB,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC1C,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,qBAAqB,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,oBAAoB,GAAG,gBAAgB,GAAG,eAAe,CAAA;IACvG,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAGD,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,0CAA0C,CAAC,EAAE,OAAO,CAAC;IACrD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,sCAAsC,CAAC,EAAE,OAAO,CAAC;IACjD,kBAAkB,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC1C,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC"}

package/build/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../lib/types.ts"],"names":[],"mappings":""}

package/index.ts

@@ -0,0 +1,7 @@
+export { checkForDependencies, bundleWDASim } from './lib/check-dependencies';
+export { NoSessionProxy } from './lib/no-session-proxy';
+export { WebDriverAgent } from './lib/webdriveragent';
+export { WDA_BASE_URL, WDA_RUNNER_BUNDLE_ID, PROJECT_FILE } from './lib/constants';
+export { resetTestProcesses, BOOTSTRAP_PATH } from './lib/utils';
+
+export * from './lib/types';

package/lib/types.ts

@@ -0,0 +1,50 @@
+// WebDriverAgentLib/Utilities/FBSettings.h
+export interface WDASettings {
+  elementResponseAttribute?: string;
+  shouldUseCompactResponses?: boolean;
+  mjpegServerScreenshotQuality?: number;
+  mjpegServerFramerate?: number;
+  screenshotQuality?: number;
+  elementResponseAttributes?: string;
+  mjpegScalingFactor?: number;
+  mjpegFixOrientation?: boolean;
+  keyboardAutocorrection?: boolean;
+  keyboardPrediction?: boolean;
+  customSnapshotTimeout?: number;
+  snapshotMaxDepth?: number;
+  useFirstMatch?: boolean;
+  boundElementsByIndex?: boolean;
+  reduceMotion?: boolean;
+  defaultActiveApplication?: string;
+  activeAppDetectionPoint?: string;
+  includeNonModalElements?: boolean;
+  defaultAlertAction?: 'accept' | 'dismiss';
+  acceptAlertButtonSelector?: string;
+  dismissAlertButtonSelector?: string;
+  screenshotOrientation?: 'auto' | 'portrait' | 'portraitUpsideDown' | 'landscapeRight' | 'landscapeLeft'
+  waitForIdleTimeout?: number;
+  animationCoolOffTimeout?: number;
+}
+
+// WebDriverAgentLib/Utilities/FBCapabilities.h
+export interface WDACapabilities {
+  bundleId?: string;
+  initialUrl?: string;
+  arguments?: string[];
+  environment?: Record<string, string>;
+  eventloopIdleDelaySec?: number;
+  shouldWaitForQuiescence?: boolean;
+  shouldUseTestManagerForVisibilityDetection?: boolean;
+  maxTypingFrequency?: number;
+  shouldUseSingletonTestManager?: boolean;
+  waitForIdleTimeout?: number;
+  shouldUseCompactResponses?: number;
+  elementResponseFields?: unknown;
+  disableAutomaticScreenshots?: boolean;
+  shouldTerminateApp?: boolean;
+  forceAppLaunch?: boolean;
+  useNativeCachingStrategy?: boolean;
+  forceSimulatorSoftwareKeyboardPresence?: boolean;
+  defaultAlertAction?: 'accept' | 'dismiss';
+  appLaunchStateTimeoutSec?: number;
+}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "appium-webdriveragent",
-  "version": "8.4.0",
+  "version": "8.5.0",
   "description": "Package bundling WebDriverAgent",
   "main": "./build/index.js",
+  "types": "./build/index.d.ts",
   "scripts": {
     "build": "tsc -b",
     "dev": "npm run build -- --watch",
@@ -100,9 +101,9 @@
     "teen_process": "^2.0.0"
   },
   "files": [
-    "index.js",
+    "index.ts",
     "lib",
-    "build/index.js",
+    "build/index.*",
     "build/lib",
     "Scripts/build.sh",
     "Scripts/fetch-prebuilt-wda.js",

package/index.js

@@ -1,22 +0,0 @@
-import * as dependencies from './lib/check-dependencies';
-import * as proxies from './lib/no-session-proxy';
-import * as driver from './lib/webdriveragent';
-import * as constants from './lib/constants';
-import * as utils from './lib/utils';
-
-
-const { checkForDependencies, bundleWDASim } = dependencies;
-const { NoSessionProxy } = proxies;
-const { WebDriverAgent } = driver;
-const { WDA_BASE_URL, WDA_RUNNER_BUNDLE_ID, PROJECT_FILE } = constants;
-const { resetTestProcesses, BOOTSTRAP_PATH } = utils;
-
-export {
-  WebDriverAgent,
-  NoSessionProxy,
-  checkForDependencies, bundleWDASim,
-  resetTestProcesses,
-  BOOTSTRAP_PATH,
-  WDA_RUNNER_BUNDLE_ID, PROJECT_FILE,
-  WDA_BASE_URL,
-};