appium-android-driver 5.14.0-alpha.0 → 5.14.0-alpha2

package/lib/helpers/android.ts

@@ -21,6 +21,7 @@ import Unlocker, {
   PIN_UNLOCK,
   PIN_UNLOCK_KEY_EVENT,
 } from './unlock';
+import {AndroidDriverConstraints} from '../constraints';
 
 const MOCK_APP_IDS_STORE = '/data/local/tmp/mock_apps.json';
 const PACKAGE_INSTALL_TIMEOUT_MS = 90000;
@@ -131,24 +132,33 @@ interface AndroidHelpers {
    */
   ensureDeviceLocale(adb: ADB, language?: string, country?: string, script?: string): Promise<void>;
 
-  getDeviceInfoFromCaps(opts?: AndroidDriverOpts): Promise<ADBDeviceInfo>;
+  getDeviceInfoFromCaps<Opts extends AndroidDriverOpts>(opts?: Opts): Promise<ADBDeviceInfo>;
 
-  createADB(opts?: AndroidDriverOpts): Promise<ADB>;
+  createADB<Opts extends AndroidDriverOpts>(opts?: Opts): Promise<ADB>;
 
-  validatePackageActivityNames(opts: AndroidDriverOpts): void;
-  getLaunchInfo(adb: ADB, opts: AndroidDriverOpts): Promise<ADBLaunchInfo | undefined>;
-  resetApp(adb: ADB, opts: SetRequired<AndroidDriverOpts, 'appPackage'>): Promise<void>;
-  installApk(adb: ADB, opts: SetRequired<AndroidDriverOpts, 'appPackage' | 'app'>): Promise<void>;
+  validatePackageActivityNames<Opts extends AndroidDriverOpts>(opts: Opts): void;
+  getLaunchInfo<Opts extends AndroidDriverOpts>(
+    adb: ADB,
+    opts: Opts
+  ): Promise<ADBLaunchInfo | undefined>;
+  resetApp<Opts extends AndroidDriverOpts>(
+    adb: ADB,
+    opts: SetRequired<Opts, 'appPackage' | 'app'>
+  ): Promise<void>;
+  installApk<Opts extends AndroidDriverOpts>(
+    adb: ADB,
+    opts: SetRequired<Opts, 'appPackage' | 'app'>
+  ): Promise<void>;
 
   /**
    * Installs an array of apks
    * @param adb Instance of Appium ADB object
    * @param opts Opts defined in driver.js
    */
-  installOtherApks(
+  installOtherApks<Opts extends AndroidDriverOpts>(
     apks: string[],
     adb: ADB,
-    opts: SetRequired<AndroidDriverOpts, 'appPackage' | 'app'>
+    opts: SetRequired<Opts, 'appPackage' | 'app'>
   ): Promise<void>;
 
   /**
@@ -204,14 +214,21 @@ interface AndroidHelpers {
     adb: ADB,
     opts: AndroidDriverOpts
   ): Promise<StringRecord>;
-  unlock(driver: AndroidDriver, adb: ADB, capabilities: AndroidDriverCaps): Promise<void>;
+  unlock<D extends AndroidDriver, Caps extends AndroidDriverCaps>(
+    driver: D,
+    adb: ADB,
+    capabilities: Caps
+  ): Promise<void>;
   verifyUnlock(adb: ADB, timeoutMs?: number | null): Promise<void>;
-  initDevice(adb: ADB, opts: AndroidDriverOpts): Promise<void>;
+  initDevice(adb: ADB, opts: AndroidDriverOpts): Promise<string | void>;
   removeNullProperties(obj: any): void;
   truncateDecimals(number: number, digits: number): number;
   isChromeBrowser(browser?: string): boolean;
   getChromePkg(browser: string): ValueOf<typeof CHROME_BROWSER_PACKAGE_ACTIVITY>;
-  removeAllSessionWebSocketHandlers(server: AppiumServer, sessionId: string): Promise<void>;
+  removeAllSessionWebSocketHandlers(
+    server?: AppiumServer,
+    sessionId?: string | null
+  ): Promise<void>;
   parseArray(cap: string | string[]): string[];
 
   /**
@@ -233,7 +250,7 @@ interface AndroidHelpers {
    * appPackage/appActivity caps have already been provided.
    * @privateRemarks In practice, this fn is only ever provided a `AndroidDriverOpts` object
    */
-  adjustBrowserSessionCaps<T extends AndroidDriverCaps>(caps: T): T;
+  adjustBrowserSessionCaps(caps: AndroidDriverCaps): AndroidDriverCaps;
 
   /**
    * Checks whether the current device under test is an emulator
@@ -847,7 +864,7 @@ const AndroidHelpers: AndroidHelpers = {
     // clean up remote string.json if present
     await adb.rimraf(remoteFile);
 
-    let app;
+    let app: string;
     try {
       app = opts.app || (await adb.pullApk(opts.appPackage!, opts.tmpDir!));
     } catch (err) {
@@ -865,7 +882,7 @@ const AndroidHelpers: AndroidHelpers = {
 
     const stringsTmpDir = path.resolve(opts.tmpDir!, opts.appPackage!);
     try {
-      logger.debug('Extracting strings from apk', app, language, stringsTmpDir);
+      logger.debug('Extracting strings from apk', app!, language, stringsTmpDir);
       const {apkStrings, localPath} = await adb.extractStringsFromApk(
         app!,
         language,

package/lib/helpers/unlock.ts

@@ -7,7 +7,8 @@ import {util} from '@appium/support';
 import type {Capabilities, Position, StringRecord} from '@appium/types';
 import {sleep} from 'asyncbox';
 import _ from 'lodash';
-import type {AndroidDriver, AndroidDriverConstraints} from '../driver';
+import type {AndroidDriver} from '../driver';
+import type {AndroidDriverConstraints} from '../constraints';
 import logger from '../logger';
 import type {FastUnlockOptions} from './types';
 import ADB from 'appium-adb';

package/lib/index.ts

@@ -0,0 +1,18 @@
+import {install} from 'source-map-support';
+install();
+
+import {AndroidDriver} from './driver';
+export type * from './commands';
+export {ANDROID_DRIVER_CONSTRAINTS as commonCapConstraints} from './constraints';
+export * from './driver';
+export {SETTINGS_HELPER_PKG_ID, default as androidHelpers} from './helpers/android';
+export type * from './helpers/types';
+export {
+  CHROMIUM_WIN,
+  NATIVE_WIN,
+  WEBVIEW_BASE,
+  WEBVIEW_WIN,
+  default as webviewHelpers,
+} from './helpers/webview';
+
+export default AndroidDriver;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-android-driver",
-  "version": "5.14.0-alpha.0",
+  "version": "5.14.0-alpha2",
   "description": "Android UiAutomator and Chrome support for Appium",
   "keywords": [
     "appium",
@@ -19,18 +19,18 @@
   },
   "license": "Apache-2.0",
   "author": "Appium Contributors",
-  "main": "./build/index.js",
+  "main": "./build/lib/index.js",
   "bin": {},
   "directories": {
     "lib": "lib"
   },
   "files": [
-    "index.js",
     "lib",
-    "build/index.js",
-    "build/lib",
+    "build",
     "bootstrap/bin/AppiumBootstrap.jar",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "!build/test",
+    "!build/tsconfig.tsbuildinfo"
   ],
   "scripts": {
     "build": "tsc -b",
@@ -58,7 +58,7 @@
   },
   "dependencies": {
     "appium-adb": "^9.12.0",
-    "appium-chromedriver": "^5.2.0",
+    "appium-chromedriver": "^5.5.1",
     "asyncbox": "^2.8.0",
     "axios": "^1.x",
     "bluebird": "^3.4.7",
@@ -77,12 +77,12 @@
     "ws": "^8.0.0"
   },
   "devDependencies": {
-    "@appium/eslint-config-appium": "^8.0.3",
+    "@appium/eslint-config-appium": "^8.0.4",
     "@appium/eslint-config-appium-ts": "^0.3.1",
-    "@appium/support": "^4.0.1",
-    "@appium/test-support": "^3.0.0",
+    "@appium/support": "^4.1.2",
+    "@appium/test-support": "^3.0.20",
     "@appium/tsconfig": "^0.3.0",
-    "@appium/types": "^0.13.0",
+    "@appium/types": "^0.13.2",
     "@commitlint/cli": "^17.6.3",
     "@commitlint/config-conventional": "^17.6.3",
     "@semantic-release/changelog": "^6.0.1",
@@ -103,7 +103,7 @@
     "@typescript-eslint/parser": "^5.59.5",
     "@xmldom/xmldom": "^0.x",
     "android-apidemos": "^4.1.0",
-    "appium": "^2.0.0-rc.3",
+    "appium": "^2.0.0-rc.5",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
     "conventional-changelog-conventionalcommits": "^6.0.0",
@@ -121,7 +121,7 @@
     "semantic-release": "^20.0.2",
     "sinon": "^15.0.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.3",
+    "typescript": "~5.0.4",
     "xpath": "^0.x"
   },
   "peerDependencies": {
@@ -131,5 +131,5 @@
     "node": ">=14",
     "npm": ">=8"
   },
-  "types": "./build/index.d.ts"
+  "types": "./build/lib/index.d.ts"
 }

package/build/lib/commands/mixin.d.ts

@@ -1,3 +0,0 @@
-import { mixin } from './mixins';
-export { mixin };
-//# sourceMappingURL=mixin.d.ts.map

package/build/lib/commands/mixin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mixin.d.ts","sourceRoot":"","sources":["../../../lib/commands/mixin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAIjC,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/build/lib/commands/mixin.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mixin = void 0;
-const mixins_1 = require("./mixins");
-Object.defineProperty(exports, "mixin", { enumerable: true, get: function () { return mixins_1.mixin; } });
-//# sourceMappingURL=mixin.js.map

package/build/lib/commands/mixin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mixin.js","sourceRoot":"","sources":["../../../lib/commands/mixin.ts"],"names":[],"mappings":";;;AAAA,qCAAiC;AAIxB,sFAJA,cAAK,OAIA"}